0.7.13.21:
[sbcl.git] / src / code / interr.lisp
1 ;;;; functions and macros to define and deal with internal errors
2 ;;;; (i.e. problems that can be signaled from assembler code)
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!KERNEL")
14 \f
15 ;;;; internal errors
16
17 (defvar *internal-errors*
18   #.(map 'vector #'cdr sb!c:*backend-internal-errors*))
19
20 (eval-when (:compile-toplevel :execute)
21
22 (sb!xc:defmacro deferr (name args &rest body)
23   (let* ((rest-pos (position '&rest args))
24          (required (if rest-pos (subseq args 0 rest-pos) args))
25          (fp (gensym))
26          (context (gensym))
27          (sc-offsets (gensym))
28          (fn-name (symbolicate name "-HANDLER")))
29     `(progn
30        ;; FIXME: Having a separate full DEFUN for each error doesn't
31        ;; seem to add much value, and it takes a lot of space. Perhaps
32        ;; we could do this dispatch with a big CASE statement instead?
33        (defun ,fn-name (name ,fp ,context ,sc-offsets)
34          ;; FIXME: It would probably be good to do *STACK-TOP-HINT*
35          ;; tricks to hide this internal error-handling logic from the
36          ;; poor high level user, so his debugger tells him about
37          ;; where his error was detected instead of telling him where
38          ;; he ended up inside the system error-handling logic.
39          (declare (ignorable name ,fp ,context ,sc-offsets))
40          (let (,@(let ((offset -1))
41                    (mapcar (lambda (var)
42                              `(,var (sb!di::sub-access-debug-var-slot
43                                      ,fp
44                                      (nth ,(incf offset)
45                                           ,sc-offsets)
46                                      ,context)))
47                            required))
48                ,@(when rest-pos
49                    `((,(nth (1+ rest-pos) args)
50                       (mapcar (lambda (sc-offset)
51                                 (sb!di::sub-access-debug-var-slot
52                                  ,fp
53                                  sc-offset
54                                  ,context))
55                               (nthcdr ,rest-pos ,sc-offsets))))))
56            ,@body))
57        (setf (svref *internal-errors* ,(error-number-or-lose name))
58              #',fn-name))))
59
60 ) ; EVAL-WHEN
61
62 (deferr unknown-error (&rest args)
63   (error "unknown error:~{ ~S~})" args))
64
65 (deferr object-not-fun-error (object)
66   (error 'type-error
67          :datum object
68          :expected-type 'function))
69
70 (deferr object-not-list-error (object)
71   (error 'type-error
72          :datum object
73          :expected-type 'list))
74
75 (deferr object-not-bignum-error (object)
76   (error 'type-error
77          :datum object
78          :expected-type 'bignum))
79
80 (deferr object-not-ratio-error (object)
81   (error 'type-error
82          :datum object
83          :expected-type 'ratio))
84
85 (deferr object-not-single-float-error (object)
86   (error 'type-error
87          :datum object
88          :expected-type 'single-float))
89
90 (deferr object-not-double-float-error (object)
91   (error 'type-error
92          :datum object
93          :expected-type 'double-float))
94
95 #!+long-float
96 (deferr object-not-long-float-error (object)
97   (error 'type-error
98          :datum object
99          :expected-type 'long-float))
100
101 (deferr object-not-simple-string-error (object)
102   (error 'type-error
103          :datum object
104          :expected-type 'simple-string))
105
106 (deferr object-not-simple-bit-vector-error (object)
107   (error 'type-error
108          :datum object
109          :expected-type 'simple-bit-vector))
110
111 (deferr object-not-simple-vector-error (object)
112   (error 'type-error
113          :datum object
114          :expected-type 'simple-vector))
115
116 (deferr object-not-fixnum-error (object)
117   (error 'type-error
118          :datum object
119          :expected-type 'fixnum))
120
121 (deferr object-not-vector-error (object)
122   (error 'type-error
123          :datum object
124          :expected-type 'vector))
125
126 (deferr object-not-string-error (object)
127   (error 'type-error
128          :datum object
129          :expected-type 'string))
130
131 (deferr object-not-bit-vector-error (object)
132   (error 'type-error
133          :datum object
134          :expected-type 'bit-vector))
135
136 (deferr object-not-array-error (object)
137   (error 'type-error
138          :datum object
139          :expected-type 'array))
140
141 (deferr object-not-number-error (object)
142   (error 'type-error
143          :datum object
144          :expected-type 'number))
145
146 (deferr object-not-rational-error (object)
147   (error 'type-error
148          :datum object
149          :expected-type 'rational))
150
151 (deferr object-not-float-error (object)
152   (error 'type-error
153          :datum object
154          :expected-type 'float))
155
156 (deferr object-not-real-error (object)
157   (error 'type-error
158          :datum object
159          :expected-type 'real))
160
161 (deferr object-not-integer-error (object)
162   (error 'type-error
163          :datum object
164          :expected-type 'integer))
165
166 (deferr object-not-cons-error (object)
167   (error 'type-error
168          :datum object
169          :expected-type 'cons))
170
171 (deferr object-not-symbol-error (object)
172   (error 'type-error
173          :datum object
174          :expected-type 'symbol))
175
176 (deferr undefined-fun-error (fdefn-or-symbol)
177   (error 'undefined-function
178          :name (etypecase fdefn-or-symbol
179                  (symbol fdefn-or-symbol)
180                  (fdefn (fdefn-name fdefn-or-symbol)))))
181
182 (deferr invalid-arg-count-error (nargs)
183   (error 'simple-program-error
184          :format-control "invalid number of arguments: ~S"
185          :format-arguments (list nargs)))
186
187 (deferr bogus-arg-to-values-list-error (list)
188   (error 'simple-type-error
189          :datum list
190          :expected-type 'list
191          :format-control
192          "~@<attempt to use VALUES-LIST on a dotted list: ~2I~_~S~:>"
193          :format-arguments (list list)))
194
195 (deferr unbound-symbol-error (symbol)
196   (error 'unbound-variable :name symbol))
197
198 (deferr object-not-base-char-error (object)
199   (error 'type-error
200          :datum object
201          :expected-type 'base-char))
202
203 (deferr object-not-sap-error (object)
204   (error 'type-error
205          :datum object
206          :expected-type 'system-area-pointer))
207
208 (deferr invalid-unwind-error ()
209   (error 'simple-control-error
210          :format-control
211          "attempt to RETURN-FROM a block or GO to a tag that no longer exists"
212          ))
213
214 (deferr unseen-throw-tag-error (tag)
215   (error 'simple-control-error
216          :format-control "attempt to THROW to a tag that does not exist: ~S"
217          :format-arguments (list tag)))
218
219 (deferr nil-fun-returned-error (function)
220   (error 'simple-control-error
221          :format-control
222          "A function with declared result type NIL returned:~%  ~S"
223          :format-arguments (list function)))
224
225 (deferr nil-array-accessed-error (array)
226   (error 'nil-array-accessed-error
227          :datum array :expected-type '(not (array nil))))
228
229 (deferr division-by-zero-error (this that)
230   (error 'division-by-zero
231          :operation 'division
232          :operands (list this that)))
233
234 (deferr object-not-type-error (object type)
235   (error (if (and (typep object 'instance)
236                   (layout-invalid (%instance-layout object)))
237              'layout-invalid
238              'type-error)
239          :datum object
240          :expected-type type))
241
242 (deferr layout-invalid-error (object layout)
243   (error 'layout-invalid
244          :datum object
245          :expected-type (layout-class layout)))
246
247 (deferr odd-key-args-error ()
248   (error 'simple-program-error
249          :format-control "odd number of &KEY arguments"))
250
251 (deferr unknown-key-arg-error (key-name)
252   (error 'simple-program-error
253          :format-control "unknown &KEY argument: ~S"
254          :format-arguments (list key-name)))
255
256 (deferr invalid-array-index-error (array bound index)
257   (error 'simple-type-error
258          :format-control
259          "invalid array index ~W for ~S (should be nonnegative and <~W)"
260          :format-arguments (list index array bound)
261          :datum index
262          :expected-type `(integer 0 (,bound))))
263
264 (deferr object-not-simple-array-error (object)
265   (error 'type-error
266          :datum object
267          :expected-type 'simple-array))
268
269 (deferr object-not-signed-byte-32-error (object)
270   (error 'type-error
271          :datum object
272          :expected-type '(signed-byte 32)))
273
274 (deferr object-not-unsigned-byte-32-error (object)
275   (error 'type-error
276          :datum object
277          :expected-type '(unsigned-byte 32)))
278
279 (deferr object-not-simple-array-nil-error (object)
280   (error 'type-error
281          :datum object
282          :expected-type '(simple-array nil (*))))
283
284 (deferr object-not-simple-array-unsigned-byte-2-error (object)
285   (error 'type-error
286          :datum object
287          :expected-type '(simple-array (unsigned-byte 2) (*))))
288
289 (deferr object-not-simple-array-unsigned-byte-4-error (object)
290   (error 'type-error
291          :datum object
292          :expected-type '(simple-array (unsigned-byte 4) (*))))
293
294 (deferr object-not-simple-array-unsigned-byte-8-error (object)
295   (error 'type-error
296          :datum object
297          :expected-type '(simple-array (unsigned-byte 8) (*))))
298
299 (deferr object-not-simple-array-unsigned-byte-16-error (object)
300   (error 'type-error
301          :datum object
302          :expected-type '(simple-array (unsigned-byte 16) (*))))
303
304 (deferr object-not-simple-array-unsigned-byte-32-error (object)
305   (error 'type-error
306          :datum object
307          :expected-type '(simple-array (unsigned-byte 32) (*))))
308
309 (deferr object-not-simple-array-signed-byte-8-error (object)
310   (error 'type-error
311          :datum object
312          :expected-type '(simple-array (signed-byte 8) (*))))
313
314 (deferr object-not-simple-array-signed-byte-16-error (object)
315   (error 'type-error
316          :datum object
317          :expected-type '(simple-array (signed-byte 16) (*))))
318
319 (deferr object-not-simple-array-signed-byte-30-error (object)
320   (error 'type-error
321          :datum object
322          :expected-type '(simple-array (signed-byte 30) (*))))
323
324 (deferr object-not-simple-array-signed-byte-32-error (object)
325   (error 'type-error
326          :datum object
327          :expected-type '(simple-array (signed-byte 32) (*))))
328
329 (deferr object-not-simple-array-single-float-error (object)
330   (error 'type-error
331          :datum object
332          :expected-type '(simple-array single-float (*))))
333
334 (deferr object-not-simple-array-double-float-error (object)
335   (error 'type-error
336          :datum object
337          :expected-type '(simple-array double-float (*))))
338
339 (deferr object-not-simple-array-complex-single-float-error (object)
340   (error 'type-error
341          :datum object
342          :expected-type '(simple-array (complex single-float) (*))))
343
344 (deferr object-not-simple-array-complex-double-float-error (object)
345   (error 'type-error
346          :datum object
347          :expected-type '(simple-array (complex double-float) (*))))
348
349 #!+long-float
350 (deferr object-not-simple-array-complex-long-float-error (object)
351   (error 'type-error
352          :datum object
353          :expected-type '(simple-array (complex long-float) (*))))
354
355 (deferr object-not-complex-error (object)
356   (error 'type-error
357          :datum object
358          :expected-type 'complex))
359
360 (deferr object-not-complex-rational-error (object)
361   (error 'type-error
362          :datum object
363          :expected-type '(complex rational)))
364
365 (deferr object-not-complex-single-float-error (object)
366   (error 'type-error
367          :datum object
368          :expected-type '(complex single-float)))
369
370 (deferr object-not-complex-double-float-error (object)
371   (error 'type-error
372          :datum object
373          :expected-type '(complex double-float)))
374
375 #!+long-float
376 (deferr object-not-complex-long-float-error (object)
377   (error 'type-error
378          :datum object
379          :expected-type '(complex long-float)))
380
381 (deferr object-not-weak-pointer-error (object)
382   (error 'type-error
383          :datum object
384          :expected-type 'weak-pointer))
385
386 (deferr object-not-instance-error (object)
387   (error 'type-error
388          :datum object
389          :expected-type 'instance))
390
391 (deferr object-not-complex-vector-error (object)
392   (error 'type-error
393          :datum object
394          :expected-type '(and vector (not simple-array))))
395 \f
396 ;;;; fetching errorful function name
397
398 ;;; This flag is used to prevent infinite recursive lossage when
399 ;;; we can't find the caller for some reason.
400 (defvar *finding-name* nil)
401
402 (defun find-caller-name-and-frame ()
403   (if *finding-name*
404       (values "<error finding caller name -- already finding name>" nil)
405       (handler-case
406           (let* ((*finding-name* t)
407                  (frame (sb!di:frame-down (sb!di:frame-down (sb!di:top-frame))))
408                  (name (sb!di:debug-fun-name
409                         (sb!di:frame-debug-fun frame))))
410             (sb!di:flush-frames-above frame)
411             (values name frame))
412         (error ()
413           (values "<error finding caller name -- trapped error>" nil))
414         (sb!di:debug-condition ()
415           (values "<error finding caller name -- trapped debug-condition>"
416                   nil)))))
417
418 (defun find-interrupted-name ()
419   (/show0 "entering FIND-INTERRUPTED-NAME")
420   (if *finding-name*
421       (values "<error finding interrupted name -- already finding name>" nil)
422       (handler-case
423           (let ((*finding-name* t))
424             (/show0 "in ordinary case")
425             (do ((frame (sb!di:top-frame) (sb!di:frame-down frame)))
426                 ((null frame)
427                  (/show0 "null frame")
428                  (values "<error finding interrupted name -- null frame>" nil))
429               (/show0 "at head of DO loop")
430               (when (and (sb!di::compiled-frame-p frame)
431                          (sb!di::compiled-frame-escaped frame))
432                 (sb!di:flush-frames-above frame)
433                 (/show0 "returning from within DO loop")
434                 (return (values (sb!di:debug-fun-name
435                                  (sb!di:frame-debug-fun frame))
436                                 frame)))))
437         (error ()
438           (/show0 "trapped ERROR")
439           (values "<error finding interrupted name -- trapped error>" nil))
440         (sb!di:debug-condition ()
441           (/show0 "trapped DEBUG-CONDITION")
442           (values "<error finding interrupted name -- trapped debug-condition>"
443                   nil)))))
444 \f
445 ;;;; INTERNAL-ERROR signal handler
446
447 (defvar *internal-error-args*)
448
449 (defun internal-error (context continuable)
450   (declare (type system-area-pointer context))
451   (declare (ignore continuable))
452   (/show0 "entering INTERNAL-ERROR, CONTEXT=..")
453   (/hexstr context)
454   (infinite-error-protect
455    (/show0 "about to bind ALIEN-CONTEXT")
456    (let ((alien-context (locally
457                           (declare (optimize (inhibit-warnings 3)))
458                           (sb!alien:sap-alien context (* os-context-t)))))
459      (/show0 "about to bind ERROR-NUMBER and ARGUMENTS")
460      (multiple-value-bind (error-number arguments)
461          (sb!vm:internal-error-args alien-context)
462
463        ;; There's a limit to how much error reporting we can usefully
464        ;; do before initialization is complete, but try to be a little
465        ;; bit helpful before we die.
466        (/show0 "back from INTERNAL-ERROR-ARGS, ERROR-NUMBER=..")
467        (/hexstr error-number)
468        (/show0 "cold/low ARGUMENTS=..")
469        (/hexstr arguments)
470        (unless *cold-init-complete-p*
471          (%primitive print "can't recover from error in cold init, halting")
472          (%primitive sb!c:halt))
473
474        (multiple-value-bind (name sb!debug:*stack-top-hint*)
475            (find-interrupted-name)
476          (/show0 "back from FIND-INTERRUPTED-NAME")
477          (let ((fp (int-sap (sb!vm:context-register alien-context
478                                                     sb!vm::cfp-offset)))
479                (handler (and (< -1 error-number (length *internal-errors*))
480                              (svref *internal-errors* error-number))))
481            (cond ((null handler)
482                   (error 'simple-error
483                          :format-control
484                          "unknown internal error, ~D, args=~S"
485                          :format-arguments
486                          (list error-number
487                                (mapcar (lambda (sc-offset)
488                                          (sb!di::sub-access-debug-var-slot
489                                           fp sc-offset alien-context))
490                                        arguments))))
491                  ((not (functionp handler))
492                   (error 'simple-error
493                          :format-control "internal error ~D: ~A; args=~S"
494                          :format-arguments
495                          (list error-number
496                                handler
497                                (mapcar (lambda (sc-offset)
498                                          (sb!di::sub-access-debug-var-slot
499                                           fp sc-offset alien-context))
500                                        arguments))))
501                  (t
502                   (funcall handler name fp alien-context arguments)))))))))
503
504 (defun control-stack-exhausted-error ()
505   (let ((sb!debug:*stack-top-hint* nil))
506     (infinite-error-protect
507      (format *error-output*
508              "Control stack guard page temporarily disabled: proceed with caution~%")
509      (error 'control-stack-exhausted))))
510
511
512