1 ;;;; functions and macros to define and deal with internal errors
2 ;;;; (i.e. problems that can be signaled from assembler code)
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.
13 (in-package "SB!KERNEL")
17 (defvar *internal-errors*
18 #.(map 'vector #'cdr sb!c:*backend-internal-errors*))
20 (eval-when (:compile-toplevel :execute)
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))
28 (fn-name (symbolicate name "-HANDLER")))
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))
42 `(,var (sb!di::sub-access-debug-var-slot
49 `((,(nth (1+ rest-pos) args)
50 (mapcar (lambda (sc-offset)
51 (sb!di::sub-access-debug-var-slot
55 (nthcdr ,rest-pos ,sc-offsets))))))
57 (setf (svref *internal-errors* ,(error-number-or-lose name))
62 (deferr unknown-error (&rest args)
63 (error "unknown error:~{ ~S~})" args))
65 (deferr object-not-fun-error (object)
68 :expected-type 'function))
70 (deferr object-not-list-error (object)
73 :expected-type 'list))
75 (deferr object-not-bignum-error (object)
78 :expected-type 'bignum))
80 (deferr object-not-ratio-error (object)
83 :expected-type 'ratio))
85 (deferr object-not-single-float-error (object)
88 :expected-type 'single-float))
90 (deferr object-not-double-float-error (object)
93 :expected-type 'double-float))
96 (deferr object-not-long-float-error (object)
99 :expected-type 'long-float))
101 (deferr object-not-simple-string-error (object)
104 :expected-type 'simple-string))
106 (deferr object-not-simple-base-string-error (object)
109 :expected-type 'simple-base-string))
111 (deferr object-not-simple-bit-vector-error (object)
114 :expected-type 'simple-bit-vector))
116 (deferr object-not-simple-vector-error (object)
119 :expected-type 'simple-vector))
121 (deferr object-not-fixnum-error (object)
124 :expected-type 'fixnum))
126 (deferr object-not-vector-error (object)
129 :expected-type 'vector))
131 (deferr object-not-string-error (object)
134 :expected-type 'string))
136 (deferr object-not-base-string-error (object)
139 :expected-type 'base-string))
141 (deferr object-not-bit-vector-error (object)
144 :expected-type 'bit-vector))
146 (deferr object-not-array-error (object)
149 :expected-type 'array))
151 (deferr object-not-number-error (object)
154 :expected-type 'number))
156 (deferr object-not-rational-error (object)
159 :expected-type 'rational))
161 (deferr object-not-float-error (object)
164 :expected-type 'float))
166 (deferr object-not-real-error (object)
169 :expected-type 'real))
171 (deferr object-not-integer-error (object)
174 :expected-type 'integer))
176 (deferr object-not-cons-error (object)
179 :expected-type 'cons))
181 (deferr object-not-symbol-error (object)
184 :expected-type 'symbol))
186 (deferr undefined-fun-error (fdefn-or-symbol)
187 (error 'undefined-function
188 :name (etypecase fdefn-or-symbol
189 (symbol fdefn-or-symbol)
190 (fdefn (fdefn-name fdefn-or-symbol)))))
192 (deferr invalid-arg-count-error (nargs)
193 (error 'simple-program-error
194 :format-control "invalid number of arguments: ~S"
195 :format-arguments (list nargs)))
197 (deferr bogus-arg-to-values-list-error (list)
198 (error 'simple-type-error
202 "~@<attempt to use VALUES-LIST on a dotted list: ~2I~_~S~:>"
203 :format-arguments (list list)))
205 (deferr unbound-symbol-error (symbol)
206 (error 'unbound-variable :name symbol))
208 (deferr object-not-base-char-error (object)
211 :expected-type 'base-char))
213 (deferr object-not-sap-error (object)
216 :expected-type 'system-area-pointer))
218 (deferr invalid-unwind-error ()
219 (error 'simple-control-error
221 "attempt to RETURN-FROM a block or GO to a tag that no longer exists"
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)))
229 (deferr nil-fun-returned-error (function)
230 (error 'simple-control-error
232 "A function with declared result type NIL returned:~% ~S"
233 :format-arguments (list function)))
235 (deferr nil-array-accessed-error (array)
236 (error 'nil-array-accessed-error
237 :datum array :expected-type '(not (array nil))))
239 (deferr division-by-zero-error (this that)
240 (error 'division-by-zero
242 :operands (list this that)))
244 (deferr object-not-type-error (object type)
245 (error (if (and (typep object 'instance)
246 (layout-invalid (%instance-layout object)))
250 :expected-type type))
252 (deferr layout-invalid-error (object layout)
253 (error 'layout-invalid
255 :expected-type (layout-classoid layout)))
257 (deferr odd-key-args-error ()
258 (error 'simple-program-error
259 :format-control "odd number of &KEY arguments"))
261 (deferr unknown-key-arg-error (key-name)
262 (error 'simple-program-error
263 :format-control "unknown &KEY argument: ~S"
264 :format-arguments (list key-name)))
266 (deferr invalid-array-index-error (array bound index)
267 (error 'simple-type-error
269 "invalid array index ~W for ~S (should be nonnegative and <~W)"
270 :format-arguments (list index array bound)
272 :expected-type `(integer 0 (,bound))))
274 (deferr object-not-simple-array-error (object)
277 :expected-type 'simple-array))
279 (deferr object-not-signed-byte-32-error (object)
282 :expected-type '(signed-byte 32)))
284 (deferr object-not-unsigned-byte-32-error (object)
287 :expected-type '(unsigned-byte 32)))
289 (deferr object-not-simple-array-nil-error (object)
292 :expected-type '(simple-array nil (*))))
294 (deferr object-not-simple-array-unsigned-byte-2-error (object)
297 :expected-type '(simple-array (unsigned-byte 2) (*))))
299 (deferr object-not-simple-array-unsigned-byte-4-error (object)
302 :expected-type '(simple-array (unsigned-byte 4) (*))))
304 (deferr object-not-simple-array-unsigned-byte-8-error (object)
307 :expected-type '(simple-array (unsigned-byte 8) (*))))
309 (deferr object-not-simple-array-unsigned-byte-16-error (object)
312 :expected-type '(simple-array (unsigned-byte 16) (*))))
314 (deferr object-not-simple-array-unsigned-byte-32-error (object)
317 :expected-type '(simple-array (unsigned-byte 32) (*))))
319 (deferr object-not-simple-array-signed-byte-8-error (object)
322 :expected-type '(simple-array (signed-byte 8) (*))))
324 (deferr object-not-simple-array-signed-byte-16-error (object)
327 :expected-type '(simple-array (signed-byte 16) (*))))
329 (deferr object-not-simple-array-signed-byte-30-error (object)
332 :expected-type '(simple-array (signed-byte 30) (*))))
334 (deferr object-not-simple-array-signed-byte-32-error (object)
337 :expected-type '(simple-array (signed-byte 32) (*))))
339 (deferr object-not-simple-array-single-float-error (object)
342 :expected-type '(simple-array single-float (*))))
344 (deferr object-not-simple-array-double-float-error (object)
347 :expected-type '(simple-array double-float (*))))
349 (deferr object-not-simple-array-complex-single-float-error (object)
352 :expected-type '(simple-array (complex single-float) (*))))
354 (deferr object-not-simple-array-complex-double-float-error (object)
357 :expected-type '(simple-array (complex double-float) (*))))
360 (deferr object-not-simple-array-complex-long-float-error (object)
363 :expected-type '(simple-array (complex long-float) (*))))
365 (deferr object-not-complex-error (object)
368 :expected-type 'complex))
370 (deferr object-not-complex-rational-error (object)
373 :expected-type '(complex rational)))
375 (deferr object-not-complex-single-float-error (object)
378 :expected-type '(complex single-float)))
380 (deferr object-not-complex-double-float-error (object)
383 :expected-type '(complex double-float)))
386 (deferr object-not-complex-long-float-error (object)
389 :expected-type '(complex long-float)))
391 (deferr object-not-weak-pointer-error (object)
394 :expected-type 'weak-pointer))
396 (deferr object-not-instance-error (object)
399 :expected-type 'instance))
401 (deferr object-not-complex-vector-error (object)
404 :expected-type '(and vector (not simple-array))))
406 ;;;; fetching errorful function name
408 ;;; This flag is used to prevent infinite recursive lossage when
409 ;;; we can't find the caller for some reason.
410 (defvar *finding-name* nil)
412 (defun find-caller-name-and-frame ()
414 (values "<error finding caller name -- already finding name>" nil)
416 (let* ((*finding-name* t)
417 (frame (sb!di:frame-down (sb!di:frame-down (sb!di:top-frame))))
418 (name (sb!di:debug-fun-name
419 (sb!di:frame-debug-fun frame))))
420 (sb!di:flush-frames-above frame)
423 (values "<error finding caller name -- trapped error>" nil))
424 (sb!di:debug-condition ()
425 (values "<error finding caller name -- trapped debug-condition>"
428 (defun find-interrupted-name ()
429 (/show0 "entering FIND-INTERRUPTED-NAME")
431 (values "<error finding interrupted name -- already finding name>" nil)
433 (let ((*finding-name* t))
434 (/show0 "in ordinary case")
435 (do ((frame (sb!di:top-frame) (sb!di:frame-down frame)))
437 (/show0 "null frame")
438 (values "<error finding interrupted name -- null frame>" nil))
439 (/show0 "at head of DO loop")
440 (when (and (sb!di::compiled-frame-p frame)
441 (sb!di::compiled-frame-escaped frame))
442 (sb!di:flush-frames-above frame)
443 (/show0 "returning from within DO loop")
444 (return (values (sb!di:debug-fun-name
445 (sb!di:frame-debug-fun frame))
448 (/show0 "trapped ERROR")
449 (values "<error finding interrupted name -- trapped error>" nil))
450 (sb!di:debug-condition ()
451 (/show0 "trapped DEBUG-CONDITION")
452 (values "<error finding interrupted name -- trapped debug-condition>"
455 ;;;; INTERNAL-ERROR signal handler
457 (defvar *internal-error-args*)
459 (defun internal-error (context continuable)
460 (declare (type system-area-pointer context))
461 (declare (ignore continuable))
462 (/show0 "entering INTERNAL-ERROR, CONTEXT=..")
464 (infinite-error-protect
465 (/show0 "about to bind ALIEN-CONTEXT")
466 (let ((alien-context (locally
467 (declare (optimize (inhibit-warnings 3)))
468 (sb!alien:sap-alien context (* os-context-t)))))
469 (/show0 "about to bind ERROR-NUMBER and ARGUMENTS")
470 (multiple-value-bind (error-number arguments)
471 (sb!vm:internal-error-args alien-context)
473 ;; There's a limit to how much error reporting we can usefully
474 ;; do before initialization is complete, but try to be a little
475 ;; bit helpful before we die.
476 (/show0 "back from INTERNAL-ERROR-ARGS, ERROR-NUMBER=..")
477 (/hexstr error-number)
478 (/show0 "cold/low ARGUMENTS=..")
480 (unless *cold-init-complete-p*
481 (%primitive print "can't recover from error in cold init, halting")
482 (%primitive sb!c:halt))
484 (multiple-value-bind (name sb!debug:*stack-top-hint*)
485 (find-interrupted-name)
486 (/show0 "back from FIND-INTERRUPTED-NAME")
487 (let ((fp (int-sap (sb!vm:context-register alien-context
489 (handler (and (< -1 error-number (length *internal-errors*))
490 (svref *internal-errors* error-number))))
491 (cond ((null handler)
494 "unknown internal error, ~D, args=~S"
497 (mapcar (lambda (sc-offset)
498 (sb!di::sub-access-debug-var-slot
499 fp sc-offset alien-context))
501 ((not (functionp handler))
503 :format-control "internal error ~D: ~A; args=~S"
507 (mapcar (lambda (sc-offset)
508 (sb!di::sub-access-debug-var-slot
509 fp sc-offset alien-context))
512 (funcall handler name fp alien-context arguments)))))))))
514 (defun control-stack-exhausted-error ()
515 (let ((sb!debug:*stack-top-hint* nil))
516 (infinite-error-protect
517 (format *error-output*
518 "Control stack guard page temporarily disabled: proceed with caution~%")
519 (error 'control-stack-exhausted))))