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