1 ;;;; machinery for reporting errors/warnings/notes/whatnot from
4 ;;;; This software is part of the SBCL system. See the README file for
7 ;;;; This software is derived from the CMU CL system, which was
8 ;;;; written at Carnegie Mellon University and released into the
9 ;;;; public domain. The software is in the public domain and is
10 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
11 ;;;; files for more information.
15 ;;;; compiler error context determination
17 (declaim (special *current-path*))
19 ;;; We bind print level and length when printing out messages so that
20 ;;; we don't dump huge amounts of garbage.
22 ;;; FIXME: It's not possible to get the defaults right for everyone.
23 ;;; So: Should these variables be in the SB-EXT package? Or should we
24 ;;; just get rid of them completely and just use the bare
25 ;;; CL:*PRINT-FOO* variables instead?
26 (declaim (type (or unsigned-byte null)
27 *compiler-error-print-level*
28 *compiler-error-print-length*
29 *compiler-error-print-lines*))
30 (defvar *compiler-error-print-level* 5
32 "the value for *PRINT-LEVEL* when printing compiler error messages")
33 (defvar *compiler-error-print-length* 10
35 "the value for *PRINT-LENGTH* when printing compiler error messages")
36 (defvar *compiler-error-print-lines* 12
38 "the value for *PRINT-LINES* when printing compiler error messages")
40 (defvar *enclosing-source-cutoff* 1
42 "The maximum number of enclosing non-original source forms (i.e. from
43 macroexpansion) that we print in full. For additional enclosing forms, we
45 (declaim (type unsigned-byte *enclosing-source-cutoff*))
47 ;;; We separate the determination of compiler error contexts from the
48 ;;; actual signalling of those errors by objectifying the error
49 ;;; context. This allows postponement of the determination of how (and
50 ;;; if) to signal the error.
52 ;;; We take care not to reference any of the IR1 so that pending
53 ;;; potential error messages won't prevent the IR1 from being GC'd. To
54 ;;; this end, we convert source forms to strings so that source forms
55 ;;; that contain IR1 references (e.g. %DEFUN) don't hold onto the IR.
56 (defstruct (compiler-error-context
57 #-no-ansi-print-object
58 (:print-object (lambda (x stream)
59 (print-unreadable-object (x stream :type t))))
61 ;; a list of the stringified CARs of the enclosing non-original source forms
62 ;; exceeding the *enclosing-source-cutoff*
63 (enclosing-source nil :type list)
64 ;; a list of stringified enclosing non-original source forms
65 (source nil :type list)
66 ;; the stringified form in the original source that expanded into SOURCE
67 (original-source (missing-arg) :type simple-string)
68 ;; a list of prefixes of "interesting" forms that enclose original-source
69 (context nil :type list)
70 ;; the FILE-INFO-NAME for the relevant FILE-INFO
71 (file-name (missing-arg) :type (or pathname (member :lisp :stream)))
72 ;; the file position at which the top level form starts, if applicable
73 (file-position nil :type (or index null))
74 ;; the original source part of the source path
75 (original-source-path nil :type list)
76 ;; the lexenv active at the time
77 (lexenv nil :type (or null lexenv)))
79 ;;; If true, this is the node which is used as context in compiler warning
81 (declaim (type (or null compiler-error-context node) *compiler-error-context*))
82 (defvar *compiler-error-context* nil)
84 ;;; a hashtable mapping macro names to source context parsers. Each parser
85 ;;; function returns the source-context list for that form.
86 (defvar *source-context-methods* (make-hash-table))
88 ;;; documentation originally from cmu-user.tex:
89 ;;; This macro defines how to extract an abbreviated source context from
90 ;;; the \var{name}d form when it appears in the compiler input.
91 ;;; \var{lambda-list} is a \code{defmacro} style lambda-list used to
92 ;;; parse the arguments. The \var{body} should return a list of
93 ;;; subforms that can be printed on about one line. There are
94 ;;; predefined methods for \code{defstruct}, \code{defmethod}, etc. If
95 ;;; no method is defined, then the first two subforms are returned.
96 ;;; Note that this facility implicitly determines the string name
97 ;;; associated with anonymous functions.
98 ;;; So even though SBCL itself only uses this macro within this file,
99 ;;; it's a reasonable thing to put in SB-EXT in case some dedicated
100 ;;; user wants to do some heavy tweaking to make SBCL give more
101 ;;; informative output about his code.
102 (defmacro define-source-context (name lambda-list &body body)
104 "DEFINE-SOURCE-CONTEXT Name Lambda-List Form*
105 This macro defines how to extract an abbreviated source context from the
106 Named form when it appears in the compiler input. Lambda-List is a DEFMACRO
107 style lambda-list used to parse the arguments. The Body should return a
108 list of subforms suitable for a \"~{~S ~}\" format string."
109 (let ((n-whole (gensym)))
110 `(setf (gethash ',name *source-context-methods*)
112 (destructuring-bind ,lambda-list ,n-whole ,@body)))))
114 (defmacro def-source-context (&rest rest)
115 (deprecation-warning 'def-source-context 'define-source-context)
116 `(define-source-context ,@rest))
118 (define-source-context defstruct (name-or-options &rest slots)
119 (declare (ignore slots))
120 `(defstruct ,(if (consp name-or-options)
121 (car name-or-options)
124 (define-source-context function (thing)
125 (if (and (consp thing) (eq (first thing) 'lambda) (consp (rest thing)))
126 `(lambda ,(second thing))
129 ;;; Return the first two elements of FORM if FORM is a list. Take the
130 ;;; CAR of the second form if appropriate.
131 (defun source-form-context (form)
132 (cond ((atom form) nil)
133 ((>= (length form) 2)
134 (let* ((context-fun-default (lambda (x)
136 (list (first form) (second form))))
137 (context-fun (gethash (first form)
138 *source-context-methods*
139 context-fun-default)))
140 (declare (type function context-fun))
141 (funcall context-fun (rest form))))
145 ;;; Given a source path, return the original source form and a
146 ;;; description of the interesting aspects of the context in which it
147 ;;; appeared. The context is a list of lists, one sublist per context
148 ;;; form. The sublist is a list of some of the initial subforms of the
151 ;;; For now, we use the first two subforms of each interesting form. A
152 ;;; form is interesting if the first element is a symbol beginning
153 ;;; with "DEF" and it is not the source form. If there is no
154 ;;; DEF-mumble, then we use the outermost containing form. If the
155 ;;; second subform is a list, then in some cases we return the CAR of
156 ;;; that form rather than the whole form (i.e. don't show DEFSTRUCT
158 (defun find-original-source (path)
159 (declare (list path))
160 (let* ((rpath (reverse (source-path-original-source path)))
162 (root (find-source-root tlf *source-info*)))
165 (current (rest rpath)))
168 (aver (null current))
170 (let ((head (first form)))
172 (let ((name (symbol-name head)))
173 (when (and (>= (length name) 3) (string= name "DEF" :end1 3))
174 (context (source-form-context form))))))
175 (when (null current) (return))
176 (setq form (nth (pop current) form)))
179 (values form (context)))
181 (let ((c (source-form-context root)))
182 (values form (if c (list c) nil))))
184 (values '(unable to locate source)
185 '((some strange place)))))))))
187 ;;; Convert a source form to a string, suitably formatted for use in
188 ;;; compiler warnings.
189 (defun stringify-form (form &optional (pretty t))
190 (with-standard-io-syntax
191 (let ((*print-readably* nil)
192 (*print-pretty* pretty)
193 (*print-level* *compiler-error-print-level*)
194 (*print-length* *compiler-error-print-length*)
195 (*print-lines* *compiler-error-print-lines*))
197 (format nil "~<~@; ~S~:>" (list form))
198 (prin1-to-string form)))))
200 ;;; Return a COMPILER-ERROR-CONTEXT structure describing the current
201 ;;; error context, or NIL if we can't figure anything out. ARGS is a
202 ;;; list of things that are going to be printed out in the error
203 ;;; message, and can thus be blown off when they appear in the source
205 (defun find-error-context (args)
206 (let ((context *compiler-error-context*))
207 (if (compiler-error-context-p context)
209 (let ((path (or (and (boundp '*current-path*) *current-path*)
211 (node-source-path context)
213 (when (and *source-info* path)
214 (multiple-value-bind (form src-context) (find-original-source path)
215 (collect ((full nil cons)
217 (let ((forms (source-path-forms path))
219 (dolist (src (if (member (first forms) args)
222 (if (>= n *enclosing-source-cutoff*)
223 (short (stringify-form (if (consp src)
227 (full (stringify-form src)))
230 (let* ((tlf (source-path-tlf-number path))
231 (file-info (source-info-file-info *source-info*)))
232 (make-compiler-error-context
233 :enclosing-source (short)
235 :original-source (stringify-form form)
237 :file-name (file-info-name file-info)
239 (multiple-value-bind (ignore pos)
240 (find-source-root tlf *source-info*)
241 (declare (ignore ignore))
243 :original-source-path
244 (source-path-original-source path)
246 (node-lexenv context)
247 (if (boundp '*lexenv*) *lexenv* nil)))))))))))
249 ;;;; printing error messages
251 ;;; We save the context information that we printed out most recently
252 ;;; so that we don't print it out redundantly.
254 ;;; The last COMPILER-ERROR-CONTEXT that we printed.
255 (defvar *last-error-context* nil)
256 (declaim (type (or compiler-error-context null) *last-error-context*))
258 ;;; The format string and args for the last error we printed.
259 (defvar *last-format-string* nil)
260 (defvar *last-format-args* nil)
261 (declaim (type (or string null) *last-format-string*))
262 (declaim (type list *last-format-args*))
264 ;;; The number of times that the last error message has been emitted,
265 ;;; so that we can compress duplicate error messages.
266 (defvar *last-message-count* 0)
267 (declaim (type index *last-message-count*))
269 ;;; If the last message was given more than once, then print out an
270 ;;; indication of how many times it was repeated. We reset the message
271 ;;; count when we are done.
272 (defun note-message-repeats (&optional (terpri t))
273 (cond ((= *last-message-count* 1)
274 (when terpri (terpri *error-output*)))
275 ((> *last-message-count* 1)
276 (format *error-output* "~&; [Last message occurs ~W times.]~2%"
277 *last-message-count*)))
278 (setq *last-message-count* 0))
280 ;;; Print out the message, with appropriate context if we can find it.
281 ;;; If the context is different from the context of the last message
282 ;;; we printed, then we print the context. If the original source is
283 ;;; different from the source we are working on, then we print the
284 ;;; current source in addition to the original source.
286 ;;; We suppress printing of messages identical to the previous, but
287 ;;; record the number of times that the message is repeated.
288 (defun print-compiler-message (format-string format-args)
290 (declare (type simple-string format-string))
291 (declare (type list format-args))
293 (let ((stream *error-output*)
294 (context (find-error-context format-args)))
297 (let ((file (compiler-error-context-file-name context))
298 (in (compiler-error-context-context context))
299 (form (compiler-error-context-original-source context))
300 (enclosing (compiler-error-context-enclosing-source context))
301 (source (compiler-error-context-source context))
302 (last *last-error-context*))
305 (equal file (compiler-error-context-file-name last)))
306 (when (pathnamep file)
307 (note-message-repeats)
309 (format stream "~2&; file: ~A~%" (namestring file))))
312 (equal in (compiler-error-context-context last)))
313 (note-message-repeats)
316 (pprint-logical-block (stream nil :per-line-prefix "; ")
317 (format stream "in:~{~<~% ~4:;~{ ~S~}~>~^ =>~}" in))
318 (format stream "~%"))
323 (compiler-error-context-original-source last)))
324 (note-message-repeats)
327 (pprint-logical-block (stream nil :per-line-prefix "; ")
328 (format stream " ~A" form))
329 (format stream "~&"))
333 (compiler-error-context-enclosing-source last)))
335 (note-message-repeats)
337 (format stream "~&; --> ~{~<~%; --> ~1:;~A~> ~}~%" enclosing)))
340 (equal source (compiler-error-context-source last)))
341 (setq *last-format-string* nil)
343 (note-message-repeats)
346 (write-string "; ==>" stream)
348 (pprint-logical-block (stream nil :per-line-prefix "; ")
349 (write-string src stream)))))))
352 (note-message-repeats)
353 (setq *last-format-string* nil)
354 (format stream "~&")))
356 (setq *last-error-context* context)
358 ;; FIXME: this testing for effective equality of compiler messages
359 ;; is ugly, and really ought to be done at a higher level.
360 (unless (and (equal format-string *last-format-string*)
361 (tree-equal format-args *last-format-args*))
362 (note-message-repeats nil)
363 (setq *last-format-string* format-string)
364 (setq *last-format-args* format-args)
365 (let ((*print-level* *compiler-error-print-level*)
366 (*print-length* *compiler-error-print-length*)
367 (*print-lines* *compiler-error-print-lines*))
369 (pprint-logical-block (stream nil :per-line-prefix "; ")
370 (format stream "~&~?" format-string format-args))
371 (format stream "~&"))))
373 (incf *last-message-count*)
376 (defun print-compiler-condition (condition)
377 (declare (type condition condition))
378 (let (;; These different classes of conditions have different
379 ;; effects on the return codes of COMPILE-FILE, so it's nice
380 ;; for users to be able to pick them out by lexical search
381 ;; through the output.
382 (what (etypecase condition
383 (style-warning 'style-warning)
385 ((or error compiler-error) 'error))))
386 (print-compiler-message
387 (format nil "caught ~S:~%~~@< ~~@;~~A~~:>" what)
388 (list (with-output-to-string (s) (princ condition s)))))
391 ;;; The act of signalling one of these beasts must not cause WARNINGSP
392 ;;; (or FAILUREP) to be set from COMPILE or COMPILE-FILE, so we can't
393 ;;; inherit from WARNING or STYLE-WARNING.
395 ;;; FIXME: the handling of compiler-notes could be unified with
396 ;;; warnings and style-warnings (see the various handler functions
398 (define-condition compiler-note (condition) ()
400 "Root of the hierarchy of conditions representing information discovered
401 by the compiler that the user might wish to know, but which does not merit
402 a STYLE-WARNING (or any more serious condition)."))
403 (define-condition simple-compiler-note (simple-condition compiler-note) ())
404 (define-condition code-deletion-note (simple-compiler-note) ()
406 "A condition type signalled when the compiler deletes code that the user
407 has written, having proved that it is unreachable."))
409 (defun compiler-notify (datum &rest args)
410 (unless (if *compiler-error-context*
411 (policy *compiler-error-context* (= inhibit-warnings 3))
412 (policy *lexenv* (= inhibit-warnings 3)))
414 (coerce-to-condition datum args
415 'simple-compiler-note 'compiler-notify)))
419 (return-from compiler-notify (values))))
420 (incf *compiler-note-count*)
421 (print-compiler-message
422 (format nil "note: ~~A")
423 (list (with-output-to-string (s) (princ condition s))))))
426 ;;; Issue a note when we might or might not be in the compiler.
427 (defun maybe-compiler-notify (&rest rest)
428 (if (boundp '*lexenv*) ; if we're in the compiler
429 (apply #'compiler-notify rest)
432 (coerce-to-condition (car rest) (cdr rest)
433 'simple-compiler-note
434 'maybe-compiler-notify)))
438 (return-from maybe-compiler-notify (values))))
439 (let ((stream *error-output*))
440 (pprint-logical-block (stream nil :per-line-prefix ";")
441 (format stream " note: ~3I~_")
442 (pprint-logical-block (stream nil)
443 (format stream "~A" condition)))
444 ;; (outside logical block, no per-line-prefix)
445 (fresh-line stream)))
448 ;;; The politically correct way to print out progress messages and
449 ;;; such like. We clear the current error context so that we know that
450 ;;; it needs to be reprinted, and we also FORCE-OUTPUT so that the
451 ;;; message gets seen right away.
452 (declaim (ftype (function (string &rest t) (values)) compiler-mumble))
453 (defun compiler-mumble (format-string &rest format-args)
454 (note-message-repeats)
455 (setq *last-error-context* nil)
456 (apply #'format *error-output* format-string format-args)
457 (force-output *error-output*)
460 ;;; Return a string that somehow names the code in COMPONENT. We use
461 ;;; the source path for the bind node for an arbitrary entry point to
462 ;;; find the source context, then return that as a string.
463 (declaim (ftype (function (component) simple-string) find-component-name))
464 (defun find-component-name (component)
465 (let ((ep (first (block-succ (component-head component)))))
466 (aver ep) ; else no entry points??
467 (multiple-value-bind (form context)
468 (find-original-source
469 (node-source-path (block-start-node ep)))
470 (declare (ignore form))
471 (let ((*print-level* 2)
472 (*print-pretty* nil))
473 (format nil "~{~{~S~^ ~}~^ => ~}" context)))))
475 ;;;; condition system interface
477 ;;; Keep track of how many times each kind of condition happens.
478 (defvar *compiler-error-count*)
479 (defvar *compiler-warning-count*)
480 (defvar *compiler-style-warning-count*)
481 (defvar *compiler-note-count*)
483 ;;; Keep track of whether any surrounding COMPILE or COMPILE-FILE call
484 ;;; should return WARNINGS-P or FAILURE-P.
486 (defvar *warnings-p*)
488 ;;; condition handlers established by the compiler. We re-signal the
489 ;;; condition, then if it isn't handled, we increment our warning
490 ;;; counter and print the error message.
491 (defun compiler-error-handler (condition)
493 (incf *compiler-error-count*)
496 (print-compiler-condition condition)
497 (continue condition))
498 (defun compiler-warning-handler (condition)
500 (incf *compiler-warning-count*)
503 (print-compiler-condition condition)
504 (muffle-warning condition))
505 (defun compiler-style-warning-handler (condition)
507 (incf *compiler-style-warning-count*)
508 (setf *warnings-p* t)
509 (print-compiler-condition condition)
510 (muffle-warning condition))
512 ;;;; undefined warnings
514 (defvar *undefined-warning-limit* 3
516 "If non-null, then an upper limit on the number of unknown function or type
517 warnings that the compiler will print for any given name in a single
518 compilation. This prevents excessive amounts of output when the real
519 problem is a missing definition (as opposed to a typo in the use.)")
521 ;;; Make an entry in the *UNDEFINED-WARNINGS* describing a reference
522 ;;; to NAME of the specified KIND. If we have exceeded the warning
523 ;;; limit, then just increment the count, otherwise note the current
526 ;;; Undefined types are noted by a condition handler in
527 ;;; WITH-COMPILATION-UNIT, which can potentially be invoked outside
528 ;;; the compiler, hence the BOUNDP check.
529 (defun note-undefined-reference (name kind)
531 ;; Check for boundness so we don't blow up if we're called
532 ;; when IR1 conversion isn't going on.
535 ;; FIXME: I'm pretty sure the INHIBIT-WARNINGS test below
536 ;; isn't a good idea; we should have INHIBIT-WARNINGS
537 ;; affect compiler notes, not STYLE-WARNINGs. And I'm not
538 ;; sure what the BOUNDP '*LEXENV* test above is for; it's
539 ;; likely a good idea, but it probably deserves an
540 ;; explanatory comment.
541 (policy *lexenv* (= inhibit-warnings 3))
542 ;; KLUDGE: weird decoupling between here and where we're
543 ;; going to signal the condition. I don't think we can
544 ;; rewrite this using SIGNAL and RESTART-CASE (to take
545 ;; advantage of the (SATISFIES HANDLE-CONDITION-P)
546 ;; handler, because if that doesn't handle it the ordinary
547 ;; compiler handlers will trigger.
550 (:variable (make-condition 'warning))
551 ((:function :type) (make-condition 'style-warning)))
553 (rassoc 'muffle-warning
554 (lexenv-handled-conditions *lexenv*))))))
555 (let* ((found (dolist (warning *undefined-warnings* nil)
556 (when (and (equal (undefined-warning-name warning) name)
557 (eq (undefined-warning-kind warning) kind))
560 (make-undefined-warning :name name :kind kind))))
561 (unless found (push res *undefined-warnings*))
562 (when (or (not *undefined-warning-limit*)
563 (< (undefined-warning-count res) *undefined-warning-limit*))
564 (push (find-error-context (list name))
565 (undefined-warning-warnings res)))
566 (incf (undefined-warning-count res))))