71e178300010e81b865a7c4af33b1adb352f160d
[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-function-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-function-or-symbol-error (object)
122   (error 'type-error
123          :datum object
124          :expected-type '(or function symbol)))
125
126 (deferr object-not-vector-error (object)
127   (error 'type-error
128          :datum object
129          :expected-type 'vector))
130
131 (deferr object-not-string-error (object)
132   (error 'type-error
133          :datum object
134          :expected-type 'string))
135
136 (deferr object-not-bit-vector-error (object)
137   (error 'type-error
138          :datum object
139          :expected-type 'bit-vector))
140
141 (deferr object-not-array-error (object)
142   (error 'type-error
143          :datum object
144          :expected-type 'array))
145
146 (deferr object-not-number-error (object)
147   (error 'type-error
148          :datum object
149          :expected-type 'number))
150
151 (deferr object-not-rational-error (object)
152   (error 'type-error
153          :datum object
154          :expected-type 'rational))
155
156 (deferr object-not-float-error (object)
157   (error 'type-error
158          :datum object
159          :expected-type 'float))
160
161 (deferr object-not-real-error (object)
162   (error 'type-error
163          :datum object
164          :expected-type 'real))
165
166 (deferr object-not-integer-error (object)
167   (error 'type-error
168          :datum object
169          :expected-type 'integer))
170
171 (deferr object-not-cons-error (object)
172   (error 'type-error
173          :datum object
174          :expected-type 'cons))
175
176 (deferr object-not-symbol-error (object)
177   (error 'type-error
178          :datum object
179          :expected-type 'symbol))
180
181 (deferr undefined-symbol-error (fdefn-or-symbol)
182   (error 'undefined-function
183          :name (etypecase fdefn-or-symbol
184                  (symbol fdefn-or-symbol)
185                  (fdefn (fdefn-name fdefn-or-symbol)))))
186
187 (deferr object-not-coerceable-to-function-error (object)
188   (error 'type-error
189          :datum object
190          :expected-type 'coerceable-to-function))
191
192 (deferr invalid-argument-count-error (nargs)
193   (error 'simple-program-error
194          :format-control "invalid number of arguments: ~S"
195          :format-arguments (list nargs)))
196
197 (deferr bogus-argument-to-values-list-error (list)
198   (error 'simple-type-error
199          :datum list
200          :expected-type 'list
201          :format-control
202          "~@<attempt to use VALUES-LIST on a dotted list: ~2I~_~S~:>"
203          :format-arguments (list list)))
204
205 (deferr unbound-symbol-error (symbol)
206   (error 'unbound-variable :name symbol))
207
208 (deferr object-not-base-char-error (object)
209   (error 'type-error
210          :datum object
211          :expected-type 'base-char))
212
213 (deferr object-not-sap-error (object)
214   (error 'type-error
215          :datum object
216          :expected-type 'system-area-pointer))
217
218 (deferr invalid-unwind-error ()
219   (error 'simple-control-error
220          :format-control
221          "attempt to RETURN-FROM a block or GO to a tag that no longer exists"
222          ))
223
224 (deferr unseen-throw-tag-error (tag)
225   (error 'simple-control-error
226          :format-control "attempt to THROW to a tag that does not exist: ~S"
227          :format-arguments (list tag)))
228
229 (deferr nil-function-returned-error (function)
230   (error 'simple-control-error
231          :format-control
232          "A function with declared result type NIL returned:~%  ~S"
233          :format-arguments (list function)))
234
235 (deferr division-by-zero-error (this that)
236   (error 'division-by-zero
237          :operation 'division
238          :operands (list this that)))
239
240 (deferr object-not-type-error (object type)
241   (error (if (and (typep object 'instance)
242                   (layout-invalid (%instance-layout object)))
243              'layout-invalid
244              'type-error)
245          :datum object
246          :expected-type type))
247
248 (deferr layout-invalid-error (object layout)
249   (error 'layout-invalid
250          :datum object
251          :expected-type (layout-class layout)))
252
253 (deferr odd-key-arguments-error ()
254   (error 'simple-program-error
255          :format-control "odd number of &KEY arguments"))
256
257 (deferr unknown-key-argument-error (key-name)
258   (error 'simple-program-error
259          :format-control "unknown &KEY argument: ~S"
260          :format-arguments (list key-name)))
261
262 (deferr invalid-array-index-error (array bound index)
263   (error 'simple-error
264          :format-control
265          "invalid array index ~D for ~S (should be nonnegative and <~D)"
266          :format-arguments (list index array bound)))
267
268 (deferr object-not-simple-array-error (object)
269   (error 'type-error
270          :datum object
271          :expected-type 'simple-array))
272
273 (deferr object-not-signed-byte-32-error (object)
274   (error 'type-error
275          :datum object
276          :expected-type '(signed-byte 32)))
277
278 (deferr object-not-unsigned-byte-32-error (object)
279   (error 'type-error
280          :datum object
281          :expected-type '(unsigned-byte 32)))
282
283 (deferr object-not-simple-array-unsigned-byte-2-error (object)
284   (error 'type-error
285          :datum object
286          :expected-type '(simple-array (unsigned-byte 2) (*))))
287
288 (deferr object-not-simple-array-unsigned-byte-4-error (object)
289   (error 'type-error
290          :datum object
291          :expected-type '(simple-array (unsigned-byte 4) (*))))
292
293 (deferr object-not-simple-array-unsigned-byte-8-error (object)
294   (error 'type-error
295          :datum object
296          :expected-type '(simple-array (unsigned-byte 8) (*))))
297
298 (deferr object-not-simple-array-unsigned-byte-16-error (object)
299   (error 'type-error
300          :datum object
301          :expected-type '(simple-array (unsigned-byte 16) (*))))
302
303 (deferr object-not-simple-array-unsigned-byte-32-error (object)
304   (error 'type-error
305          :datum object
306          :expected-type '(simple-array (unsigned-byte 32) (*))))
307
308 (deferr object-not-simple-array-signed-byte-8-error (object)
309   (error 'type-error
310          :datum object
311          :expected-type '(simple-array (signed-byte 8) (*))))
312
313 (deferr object-not-simple-array-signed-byte-16-error (object)
314   (error 'type-error
315          :datum object
316          :expected-type '(simple-array (signed-byte 16) (*))))
317
318 (deferr object-not-simple-array-signed-byte-30-error (object)
319   (error 'type-error
320          :datum object
321          :expected-type '(simple-array (signed-byte 30) (*))))
322
323 (deferr object-not-simple-array-signed-byte-32-error (object)
324   (error 'type-error
325          :datum object
326          :expected-type '(simple-array (signed-byte 32) (*))))
327
328 (deferr object-not-simple-array-single-float-error (object)
329   (error 'type-error
330          :datum object
331          :expected-type '(simple-array single-float (*))))
332
333 (deferr object-not-simple-array-double-float-error (object)
334   (error 'type-error
335          :datum object
336          :expected-type '(simple-array double-float (*))))
337
338 (deferr object-not-simple-array-complex-single-float-error (object)
339   (error 'type-error
340          :datum object
341          :expected-type '(simple-array (complex single-float) (*))))
342
343 (deferr object-not-simple-array-complex-double-float-error (object)
344   (error 'type-error
345          :datum object
346          :expected-type '(simple-array (complex double-float) (*))))
347
348 #!+long-float
349 (deferr object-not-simple-array-complex-long-float-error (object)
350   (error 'type-error
351          :datum object
352          :expected-type '(simple-array (complex long-float) (*))))
353
354 (deferr object-not-complex-error (object)
355   (error 'type-error
356          :datum object
357          :expected-type 'complex))
358
359 (deferr object-not-complex-rational-error (object)
360   (error 'type-error
361          :datum object
362          :expected-type '(complex rational)))
363
364 (deferr object-not-complex-single-float-error (object)
365   (error 'type-error
366          :datum object
367          :expected-type '(complex single-float)))
368
369 (deferr object-not-complex-double-float-error (object)
370   (error 'type-error
371          :datum object
372          :expected-type '(complex double-float)))
373
374 #!+long-float
375 (deferr object-not-complex-long-float-error (object)
376   (error 'type-error
377          :datum object
378          :expected-type '(complex long-float)))
379
380 (deferr object-not-weak-pointer-error (object)
381   (error 'type-error
382          :datum object
383          :expected-type 'weak-pointer))
384
385 (deferr object-not-instance-error (object)
386   (error 'type-error
387          :datum object
388          :expected-type 'instance))
389
390 (deferr object-not-complex-vector-error (object)
391   (error 'type-error
392          :datum object
393          :expected-type '(and vector (not simple-array))))
394 \f
395 ;;;; fetching errorful function name
396
397 ;;; This flag is used to prevent infinite recursive lossage when
398 ;;; we can't find the caller for some reason.
399 (defvar *finding-name* nil)
400
401 (defun find-caller-name-and-frame ()
402   (if *finding-name*
403       (values "<error finding caller name -- already finding name>" nil)
404       (handler-case
405           (let* ((*finding-name* t)
406                  (frame (sb!di:frame-down (sb!di:frame-down (sb!di:top-frame))))
407                  (name (sb!di:debug-fun-name
408                         (sb!di:frame-debug-fun frame))))
409             (sb!di:flush-frames-above frame)
410             (values name frame))
411         (error ()
412           (values "<error finding caller name -- trapped error>" nil))
413         (sb!di:debug-condition ()
414           (values "<error finding caller name -- trapped debug-condition>"
415                   nil)))))
416
417 (defun find-interrupted-name ()
418   (/show0 "entering FIND-INTERRUPTED-NAME")
419   (if *finding-name*
420       (values "<error finding interrupted name -- already finding name>" nil)
421       (handler-case
422           (let ((*finding-name* t))
423             (/show0 "in ordinary case")
424             (do ((frame (sb!di:top-frame) (sb!di:frame-down frame)))
425                 ((null frame)
426                  (/show0 "null frame")
427                  (values "<error finding interrupted name -- null frame>" nil))
428               (/show0 "at head of DO loop")
429               (when (and (sb!di::compiled-frame-p frame)
430                          (sb!di::compiled-frame-escaped frame))
431                 (sb!di:flush-frames-above frame)
432                 (/show0 "returning from within DO loop")
433                 (return (values (sb!di:debug-fun-name
434                                  (sb!di:frame-debug-fun frame))
435                                 frame)))))
436         (error ()
437           (/show0 "trapped ERROR")
438           (values "<error finding interrupted name -- trapped error>" nil))
439         (sb!di:debug-condition ()
440           (/show0 "trapped DEBUG-CONDITION")
441           (values "<error finding interrupted name -- trapped debug-condition>"
442                   nil)))))
443 \f
444 ;;;; INTERNAL-ERROR signal handler
445
446 (defun internal-error (context continuable)
447   (declare (type system-area-pointer context))
448   (declare (ignore continuable))
449   (/show0 "entering INTERNAL-ERROR, CONTEXT=..")
450   (/hexstr context)
451   (infinite-error-protect
452    (/show0 "about to bind ALIEN-CONTEXT")
453    (let ((alien-context (locally
454                           (declare (optimize (inhibit-warnings 3)))
455                           (sb!alien:sap-alien context (* os-context-t)))))
456      (/show0 "about to bind ERROR-NUMBER and ARGUMENTS")
457      (multiple-value-bind (error-number arguments)
458          (sb!vm:internal-error-arguments alien-context)
459        (/show0 "back from INTERNAL-ERROR-ARGUMENTS, ERROR-NUMBER=..")
460        (/hexstr error-number)
461        (/show0 "ARGUMENTS=..")
462        (/hexstr arguments)
463        (multiple-value-bind (name sb!debug:*stack-top-hint*)
464            (find-interrupted-name)
465          (/show0 "back from FIND-INTERRUPTED-NAME")
466          (let ((fp (int-sap (sb!vm:context-register alien-context
467                                                     sb!vm::cfp-offset)))
468                (handler (and (< -1 error-number (length *internal-errors*))
469                              (svref *internal-errors* error-number))))
470            (cond ((null handler)
471                   (error 'simple-error
472                          :format-control
473                          "unknown internal error, ~D? args=~S"
474                          :format-arguments
475                          (list error-number
476                                (mapcar #'(lambda (sc-offset)
477                                            (sb!di::sub-access-debug-var-slot
478                                             fp sc-offset alien-context))
479                                        arguments))))
480                  ((not (functionp handler))
481                   (error 'simple-error
482                          :format-control "internal error ~D: ~A; args=~S"
483                          :format-arguments
484                          (list error-number
485                                handler
486                                (mapcar #'(lambda (sc-offset)
487                                            (sb!di::sub-access-debug-var-slot
488                                             fp sc-offset alien-context))
489                                        arguments))))
490                  (t
491                   (funcall handler name fp alien-context arguments)))))))))