0.7.11.5:
[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 division-by-zero-error (this that)
226   (error 'division-by-zero
227          :operation 'division
228          :operands (list this that)))
229
230 (deferr object-not-type-error (object type)
231   (error (if (and (typep object 'instance)
232                   (layout-invalid (%instance-layout object)))
233              'layout-invalid
234              'type-error)
235          :datum object
236          :expected-type type))
237
238 (deferr layout-invalid-error (object layout)
239   (error 'layout-invalid
240          :datum object
241          :expected-type (layout-class layout)))
242
243 (deferr odd-key-args-error ()
244   (error 'simple-program-error
245          :format-control "odd number of &KEY arguments"))
246
247 (deferr unknown-key-arg-error (key-name)
248   (error 'simple-program-error
249          :format-control "unknown &KEY argument: ~S"
250          :format-arguments (list key-name)))
251
252 (deferr invalid-array-index-error (array bound index)
253   (error 'simple-type-error
254          :format-control
255          "invalid array index ~W for ~S (should be nonnegative and <~W)"
256          :format-arguments (list index array bound)
257          :datum index
258          :expected-type `(integer 0 (,bound))))
259
260 (deferr object-not-simple-array-error (object)
261   (error 'type-error
262          :datum object
263          :expected-type 'simple-array))
264
265 (deferr object-not-signed-byte-32-error (object)
266   (error 'type-error
267          :datum object
268          :expected-type '(signed-byte 32)))
269
270 (deferr object-not-unsigned-byte-32-error (object)
271   (error 'type-error
272          :datum object
273          :expected-type '(unsigned-byte 32)))
274
275 (deferr object-not-simple-array-unsigned-byte-2-error (object)
276   (error 'type-error
277          :datum object
278          :expected-type '(simple-array (unsigned-byte 2) (*))))
279
280 (deferr object-not-simple-array-unsigned-byte-4-error (object)
281   (error 'type-error
282          :datum object
283          :expected-type '(simple-array (unsigned-byte 4) (*))))
284
285 (deferr object-not-simple-array-unsigned-byte-8-error (object)
286   (error 'type-error
287          :datum object
288          :expected-type '(simple-array (unsigned-byte 8) (*))))
289
290 (deferr object-not-simple-array-unsigned-byte-16-error (object)
291   (error 'type-error
292          :datum object
293          :expected-type '(simple-array (unsigned-byte 16) (*))))
294
295 (deferr object-not-simple-array-unsigned-byte-32-error (object)
296   (error 'type-error
297          :datum object
298          :expected-type '(simple-array (unsigned-byte 32) (*))))
299
300 (deferr object-not-simple-array-signed-byte-8-error (object)
301   (error 'type-error
302          :datum object
303          :expected-type '(simple-array (signed-byte 8) (*))))
304
305 (deferr object-not-simple-array-signed-byte-16-error (object)
306   (error 'type-error
307          :datum object
308          :expected-type '(simple-array (signed-byte 16) (*))))
309
310 (deferr object-not-simple-array-signed-byte-30-error (object)
311   (error 'type-error
312          :datum object
313          :expected-type '(simple-array (signed-byte 30) (*))))
314
315 (deferr object-not-simple-array-signed-byte-32-error (object)
316   (error 'type-error
317          :datum object
318          :expected-type '(simple-array (signed-byte 32) (*))))
319
320 (deferr object-not-simple-array-single-float-error (object)
321   (error 'type-error
322          :datum object
323          :expected-type '(simple-array single-float (*))))
324
325 (deferr object-not-simple-array-double-float-error (object)
326   (error 'type-error
327          :datum object
328          :expected-type '(simple-array double-float (*))))
329
330 (deferr object-not-simple-array-complex-single-float-error (object)
331   (error 'type-error
332          :datum object
333          :expected-type '(simple-array (complex single-float) (*))))
334
335 (deferr object-not-simple-array-complex-double-float-error (object)
336   (error 'type-error
337          :datum object
338          :expected-type '(simple-array (complex double-float) (*))))
339
340 #!+long-float
341 (deferr object-not-simple-array-complex-long-float-error (object)
342   (error 'type-error
343          :datum object
344          :expected-type '(simple-array (complex long-float) (*))))
345
346 (deferr object-not-complex-error (object)
347   (error 'type-error
348          :datum object
349          :expected-type 'complex))
350
351 (deferr object-not-complex-rational-error (object)
352   (error 'type-error
353          :datum object
354          :expected-type '(complex rational)))
355
356 (deferr object-not-complex-single-float-error (object)
357   (error 'type-error
358          :datum object
359          :expected-type '(complex single-float)))
360
361 (deferr object-not-complex-double-float-error (object)
362   (error 'type-error
363          :datum object
364          :expected-type '(complex double-float)))
365
366 #!+long-float
367 (deferr object-not-complex-long-float-error (object)
368   (error 'type-error
369          :datum object
370          :expected-type '(complex long-float)))
371
372 (deferr object-not-weak-pointer-error (object)
373   (error 'type-error
374          :datum object
375          :expected-type 'weak-pointer))
376
377 (deferr object-not-instance-error (object)
378   (error 'type-error
379          :datum object
380          :expected-type 'instance))
381
382 (deferr object-not-complex-vector-error (object)
383   (error 'type-error
384          :datum object
385          :expected-type '(and vector (not simple-array))))
386 \f
387 ;;;; fetching errorful function name
388
389 ;;; This flag is used to prevent infinite recursive lossage when
390 ;;; we can't find the caller for some reason.
391 (defvar *finding-name* nil)
392
393 (defun find-caller-name-and-frame ()
394   (if *finding-name*
395       (values "<error finding caller name -- already finding name>" nil)
396       (handler-case
397           (let* ((*finding-name* t)
398                  (frame (sb!di:frame-down (sb!di:frame-down (sb!di:top-frame))))
399                  (name (sb!di:debug-fun-name
400                         (sb!di:frame-debug-fun frame))))
401             (sb!di:flush-frames-above frame)
402             (values name frame))
403         (error ()
404           (values "<error finding caller name -- trapped error>" nil))
405         (sb!di:debug-condition ()
406           (values "<error finding caller name -- trapped debug-condition>"
407                   nil)))))
408
409 (defun find-interrupted-name ()
410   (/show0 "entering FIND-INTERRUPTED-NAME")
411   (if *finding-name*
412       (values "<error finding interrupted name -- already finding name>" nil)
413       (handler-case
414           (let ((*finding-name* t))
415             (/show0 "in ordinary case")
416             (do ((frame (sb!di:top-frame) (sb!di:frame-down frame)))
417                 ((null frame)
418                  (/show0 "null frame")
419                  (values "<error finding interrupted name -- null frame>" nil))
420               (/show0 "at head of DO loop")
421               (when (and (sb!di::compiled-frame-p frame)
422                          (sb!di::compiled-frame-escaped frame))
423                 (sb!di:flush-frames-above frame)
424                 (/show0 "returning from within DO loop")
425                 (return (values (sb!di:debug-fun-name
426                                  (sb!di:frame-debug-fun frame))
427                                 frame)))))
428         (error ()
429           (/show0 "trapped ERROR")
430           (values "<error finding interrupted name -- trapped error>" nil))
431         (sb!di:debug-condition ()
432           (/show0 "trapped DEBUG-CONDITION")
433           (values "<error finding interrupted name -- trapped debug-condition>"
434                   nil)))))
435 \f
436 ;;;; INTERNAL-ERROR signal handler
437
438 (defvar *internal-error-args*)
439
440 (defun internal-error (context continuable)
441   (declare (type system-area-pointer context))
442   (declare (ignore continuable))
443   (/show0 "entering INTERNAL-ERROR, CONTEXT=..")
444   (/hexstr context)
445   (infinite-error-protect
446    (/show0 "about to bind ALIEN-CONTEXT")
447    (let ((alien-context (locally
448                           (declare (optimize (inhibit-warnings 3)))
449                           (sb!alien:sap-alien context (* os-context-t)))))
450      (/show0 "about to bind ERROR-NUMBER and ARGUMENTS")
451      (multiple-value-bind (error-number arguments)
452          (sb!vm:internal-error-args alien-context)
453
454        ;; There's a limit to how much error reporting we can usefully
455        ;; do before initialization is complete, but try to be a little
456        ;; bit helpful before we die.
457        (/show0 "back from INTERNAL-ERROR-ARGS, ERROR-NUMBER=..")
458        (/hexstr error-number)
459        (/show0 "cold/low ARGUMENTS=..")
460        (/hexstr arguments)
461        (unless *cold-init-complete-p*
462          (%primitive print "can't recover from error in cold init, halting")
463          (%primitive sb!c:halt))
464
465        (multiple-value-bind (name sb!debug:*stack-top-hint*)
466            (find-interrupted-name)
467          (/show0 "back from FIND-INTERRUPTED-NAME")
468          (let ((fp (int-sap (sb!vm:context-register alien-context
469                                                     sb!vm::cfp-offset)))
470                (handler (and (< -1 error-number (length *internal-errors*))
471                              (svref *internal-errors* error-number))))
472            (cond ((null handler)
473                   (error 'simple-error
474                          :format-control
475                          "unknown internal error, ~D, args=~S"
476                          :format-arguments
477                          (list error-number
478                                (mapcar (lambda (sc-offset)
479                                          (sb!di::sub-access-debug-var-slot
480                                           fp sc-offset alien-context))
481                                        arguments))))
482                  ((not (functionp handler))
483                   (error 'simple-error
484                          :format-control "internal error ~D: ~A; args=~S"
485                          :format-arguments
486                          (list error-number
487                                handler
488                                (mapcar (lambda (sc-offset)
489                                          (sb!di::sub-access-debug-var-slot
490                                           fp sc-offset alien-context))
491                                        arguments))))
492                  (t
493                   (funcall handler name fp alien-context arguments)))))))))
494
495 (defun control-stack-exhausted-error ()
496   (let ((sb!debug:*stack-top-hint* nil))
497     (infinite-error-protect
498      (format *error-output*
499              "Control stack guard page temporarily disabled: proceed with caution~%")
500      (error 'control-stack-exhausted))))
501
502
503