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))
25 (fn-name (symbolicate name "-HANDLER")))
26 (with-unique-names (fp context sc-offsets)
28 ;; FIXME: Having a separate full DEFUN for each error doesn't
29 ;; seem to add much value, and it takes a lot of space. Perhaps
30 ;; we could do this dispatch with a big CASE statement instead?
31 (defun ,fn-name (name ,fp ,context ,sc-offsets)
32 ;; FIXME: It would probably be good to do *STACK-TOP-HINT*
33 ;; tricks to hide this internal error-handling logic from the
34 ;; poor high level user, so his debugger tells him about
35 ;; where his error was detected instead of telling him where
36 ;; he ended up inside the system error-handling logic.
37 (declare (ignorable name ,fp ,context ,sc-offsets))
38 (let (,@(let ((offset -1))
40 `(,var (sb!di::sub-access-debug-var-slot
47 `((,(nth (1+ rest-pos) args)
48 (mapcar (lambda (sc-offset)
49 (sb!di::sub-access-debug-var-slot
53 (nthcdr ,rest-pos ,sc-offsets))))))
55 (setf (svref *internal-errors* ,(error-number-or-lose name))
60 (deferr unknown-error (&rest args)
61 (error "unknown error:~{ ~S~})" args))
63 (deferr object-not-fun-error (object)
66 :expected-type 'function))
68 (deferr object-not-list-error (object)
71 :expected-type 'list))
73 (deferr object-not-bignum-error (object)
76 :expected-type 'bignum))
78 (deferr object-not-ratio-error (object)
81 :expected-type 'ratio))
83 (deferr object-not-single-float-error (object)
86 :expected-type 'single-float))
88 (deferr object-not-double-float-error (object)
91 :expected-type 'double-float))
94 (deferr object-not-long-float-error (object)
97 :expected-type 'long-float))
99 (deferr object-not-simple-string-error (object)
102 :expected-type 'simple-string))
104 (deferr object-not-fixnum-error (object)
107 :expected-type 'fixnum))
109 (deferr object-not-vector-error (object)
112 :expected-type 'vector))
114 (deferr object-not-string-error (object)
117 :expected-type 'string))
119 (deferr object-not-base-string-error (object)
122 :expected-type 'base-string))
124 (deferr object-not-vector-nil-error (object)
127 :expected-type '(vector nil)))
130 (deferr object-not-character-string-error (object)
133 :expected-type '(vector character)))
135 (deferr object-not-bit-vector-error (object)
138 :expected-type 'bit-vector))
140 (deferr object-not-array-error (object)
143 :expected-type 'array))
145 (deferr object-not-number-error (object)
148 :expected-type 'number))
150 (deferr object-not-rational-error (object)
153 :expected-type 'rational))
155 (deferr object-not-float-error (object)
158 :expected-type 'float))
160 (deferr object-not-real-error (object)
163 :expected-type 'real))
165 (deferr object-not-integer-error (object)
168 :expected-type 'integer))
170 (deferr object-not-cons-error (object)
173 :expected-type 'cons))
175 (deferr object-not-symbol-error (object)
178 :expected-type 'symbol))
180 (deferr undefined-fun-error (fdefn-or-symbol)
181 (error 'undefined-function
182 :name (etypecase fdefn-or-symbol
183 (symbol fdefn-or-symbol)
184 (fdefn (fdefn-name fdefn-or-symbol)))))
187 (deferr undefined-alien-fun-error (address)
188 (error 'undefined-alien-function-error
190 (and (integerp address)
191 (sap-foreign-symbol (int-sap address)))))
194 (defun undefined-alien-fun-error ()
195 (error 'undefined-alien-function-error))
197 (deferr invalid-arg-count-error (nargs)
198 (error 'simple-program-error
199 :format-control "invalid number of arguments: ~S"
200 :format-arguments (list nargs)))
202 (deferr bogus-arg-to-values-list-error (list)
203 (error 'simple-type-error
207 "~@<attempt to use VALUES-LIST on a dotted list: ~2I~_~S~:>"
208 :format-arguments (list list)))
210 (deferr unbound-symbol-error (symbol)
211 (error 'unbound-variable :name symbol))
213 (deferr object-not-character-error (object)
216 :expected-type 'character))
218 (deferr object-not-sap-error (object)
221 :expected-type 'system-area-pointer))
223 (deferr invalid-unwind-error ()
224 (error 'simple-control-error
226 "attempt to RETURN-FROM a block or GO to a tag that no longer exists"
229 (deferr unseen-throw-tag-error (tag)
230 (error 'simple-control-error
231 :format-control "attempt to THROW to a tag that does not exist: ~S"
232 :format-arguments (list tag)))
234 (deferr nil-fun-returned-error (function)
235 (error 'simple-control-error
237 "A function with declared result type NIL returned:~% ~S"
238 :format-arguments (list function)))
240 (deferr nil-array-accessed-error (array)
241 (error 'nil-array-accessed-error
242 :datum array :expected-type '(not (array nil))))
244 (deferr division-by-zero-error (this that)
245 (error 'division-by-zero
247 :operands (list this that)))
249 (deferr object-not-type-error (object type)
250 (if (invalid-array-p object)
251 (invalid-array-error object)
252 (error (if (and (%instancep object)
253 (layout-invalid (%instance-layout object)))
257 :expected-type type)))
259 (deferr layout-invalid-error (object layout)
260 (error 'layout-invalid
262 :expected-type (layout-classoid layout)))
264 (deferr odd-key-args-error ()
265 (error 'simple-program-error
266 :format-control "odd number of &KEY arguments"))
268 (deferr unknown-key-arg-error (key-name)
269 (error 'simple-program-error
270 :format-control "unknown &KEY argument: ~S"
271 :format-arguments (list key-name)))
273 (deferr invalid-array-index-error (array bound index)
274 (invalid-array-index-error array index bound))
276 (deferr object-not-simple-array-error (object)
279 :expected-type 'simple-array))
281 (deferr object-not-signed-byte-32-error (object)
284 :expected-type '(signed-byte 32)))
286 (deferr object-not-unsigned-byte-32-error (object)
289 :expected-type '(unsigned-byte 32)))
291 (deferr tls-exhausted-error ()
292 ;; There is nothing we can do about it. A number of entries in the
293 ;; tls could be reserved and made available for recovery but since
294 ;; tls indices are never reused it would be kind of silly and
295 ;; without it signalling an error is more than likely to end in a
297 (%primitive print "Thread local storage exhausted.")
301 ((define-simple-array-internal-errors ()
305 `(deferr ,(symbolicate
307 (sb!vm:saetp-primitive-type-name saetp)
312 :expected-type '(simple-array
313 ,(sb!vm:saetp-specifier saetp)
315 sb!vm:*specialized-array-element-type-properties*))))
316 (define-simple-array-internal-errors))
318 (deferr object-not-complex-error (object)
321 :expected-type 'complex))
323 (deferr object-not-complex-rational-error (object)
326 :expected-type '(complex rational)))
328 (deferr object-not-complex-single-float-error (object)
331 :expected-type '(complex single-float)))
333 (deferr object-not-complex-double-float-error (object)
336 :expected-type '(complex double-float)))
339 (deferr object-not-complex-long-float-error (object)
342 :expected-type '(complex long-float)))
345 (deferr object-not-simd-pack-error (object)
348 :expected-type 'simd-pack))
350 (deferr object-not-weak-pointer-error (object)
353 :expected-type 'weak-pointer))
355 (deferr object-not-instance-error (object)
358 :expected-type 'instance))
360 (deferr object-not-complex-vector-error (object)
363 :expected-type '(and vector (not simple-array))))
365 ;;;; fetching errorful function name
367 ;;; This flag is used to prevent infinite recursive lossage when
368 ;;; we can't find the caller for some reason.
369 (defvar *finding-name* nil)
371 (defun find-caller-name-and-frame ()
373 (values "<error finding caller name -- already finding name>" nil)
375 (let* ((*finding-name* t)
376 (frame (sb!di:frame-down (sb!di:frame-down (sb!di:top-frame))))
377 (name (sb!di:debug-fun-name
378 (sb!di:frame-debug-fun frame))))
379 (sb!di:flush-frames-above frame)
382 (values "<error finding caller name -- trapped error>" nil))
383 (sb!di:debug-condition ()
384 (values "<error finding caller name -- trapped debug-condition>"
387 (defun find-interrupted-name-and-frame ()
388 (/show0 "entering FIND-INTERRUPTED-NAME-AND-FRAME")
390 (values "<error finding interrupted name -- already finding name>" nil)
392 (let ((*finding-name* t))
393 (/show0 "in ordinary case")
394 (do ((frame (sb!di:top-frame) (sb!di:frame-down frame)))
396 (/show0 "null frame")
397 (values "<error finding interrupted name -- null frame>" nil))
398 (/show0 "at head of DO loop")
399 (when (and (sb!di::compiled-frame-p frame)
400 (sb!di::compiled-frame-escaped frame))
401 (sb!di:flush-frames-above frame)
402 (/show0 "returning from within DO loop")
403 (return (values (sb!di:debug-fun-name
404 (sb!di:frame-debug-fun frame))
407 (/show0 "trapped ERROR")
408 (values "<error finding interrupted name -- trapped error>" nil))
409 (sb!di:debug-condition ()
410 (/show0 "trapped DEBUG-CONDITION")
411 (values "<error finding interrupted name -- trapped debug-condition>"
414 (defun find-caller-of-named-frame (name)
415 (unless *finding-name*
417 (let ((*finding-name* t))
418 (do ((frame (sb!di:top-frame) (sb!di:frame-down frame)))
420 (when (and (sb!di::compiled-frame-p frame)
421 (eq name (sb!di:debug-fun-name
422 (sb!di:frame-debug-fun frame))))
423 (let ((caller (sb!di:frame-down frame)))
424 (sb!di:flush-frames-above caller)
426 ((or error sb!di:debug-condition) ()
428 (sb!di:debug-condition ()
432 ;;;; INTERNAL-ERROR signal handler
434 (defun internal-error (context continuable)
435 (declare (type system-area-pointer context))
436 (declare (ignore continuable))
437 (/show0 "entering INTERNAL-ERROR, CONTEXT=..")
439 (infinite-error-protect
440 (/show0 "about to bind ALIEN-CONTEXT")
441 (let* ((alien-context (locally
442 (declare (optimize (inhibit-warnings 3)))
443 (sb!alien:sap-alien context (* os-context-t))))
444 #!+c-stack-is-control-stack
446 (cons (cons (%make-lisp-obj (sb!vm:context-register
449 (sb!vm:context-pc alien-context))
450 (when (boundp '*saved-fp-and-pcs*)
451 *saved-fp-and-pcs*))))
452 (declare (truly-dynamic-extent *saved-fp-and-pcs*))
453 (/show0 "about to bind ERROR-NUMBER and ARGUMENTS")
454 (multiple-value-bind (error-number arguments)
455 (sb!vm:internal-error-args alien-context)
457 ;; There's a limit to how much error reporting we can usefully
458 ;; do before initialization is complete, but try to be a little
459 ;; bit helpful before we die.
460 (/show0 "back from INTERNAL-ERROR-ARGS, ERROR-NUMBER=..")
461 (/hexstr error-number)
462 (/show0 "cold/low ARGUMENTS=..")
464 (unless *cold-init-complete-p*
465 (%primitive print "can't recover from error in cold init, halting")
466 (%primitive sb!c:halt))
468 (with-interrupt-bindings
469 (multiple-value-bind (name sb!debug:*stack-top-hint*)
470 (find-interrupted-name-and-frame)
471 (/show0 "back from FIND-INTERRUPTED-NAME")
472 (let ((fp (int-sap (sb!vm:context-register alien-context
474 (handler (and (< -1 error-number (length *internal-errors*))
475 (svref *internal-errors* error-number))))
476 (cond ((null handler)
479 "unknown internal error, ~D, args=~S"
482 (mapcar (lambda (sc-offset)
483 (sb!di::sub-access-debug-var-slot
484 fp sc-offset alien-context))
486 ((not (functionp handler))
488 :format-control "internal error ~D: ~A; args=~S"
492 (mapcar (lambda (sc-offset)
493 (sb!di::sub-access-debug-var-slot
494 fp sc-offset alien-context))
497 (funcall handler name fp alien-context arguments))))))))))
499 (defun control-stack-exhausted-error ()
500 (let ((sb!debug:*stack-top-hint* nil))
501 (infinite-error-protect
502 (format *error-output*
503 "Control stack guard page temporarily disabled: proceed with caution~%")
504 (error 'control-stack-exhausted))))
506 (defun binding-stack-exhausted-error ()
507 (let ((sb!debug:*stack-top-hint* nil))
508 (infinite-error-protect
509 (format *error-output*
510 "Binding stack guard page temporarily disabled: proceed with caution~%")
511 (error 'binding-stack-exhausted))))
513 (defun alien-stack-exhausted-error ()
514 (let ((sb!debug:*stack-top-hint* nil))
515 (infinite-error-protect
516 (format *error-output*
517 "Alien stack guard page temporarily disabled: proceed with caution~%")
518 (error 'alien-stack-exhausted))))
520 ;;; KLUDGE: we keep a single HEAP-EXHAUSTED-ERROR object around, so
521 ;;; that we don't need to allocate it when running out of
522 ;;; memory. Similarly we pass the amounts in special variables as
523 ;;; there may be multiple threads running into trouble at the same
524 ;;; time. The condition is created by GC-REINIT.
525 (defvar *heap-exhausted-error-condition*)
526 (defvar *heap-exhausted-error-available-bytes*)
527 (defvar *heap-exhausted-error-requested-bytes*)
529 (defun heap-exhausted-error (available requested)
530 (infinite-error-protect
531 (let ((*heap-exhausted-error-available-bytes* available)
532 (*heap-exhausted-error-requested-bytes* requested))
533 (error *heap-exhausted-error-condition*))))
535 (defun undefined-alien-variable-error ()
536 (error 'undefined-alien-variable-error))
539 (define-alien-variable current-memory-fault-address unsigned)
542 (defun memory-fault-error ()
543 (error 'memory-fault-error
544 :address current-memory-fault-address))
546 ;;; This is SIGTRAP / EXCEPTION_BREAKPOINT that runtime could not deal
547 ;;; with. Prior to Windows we just had a Lisp side handler for
548 ;;; SIGTRAP, but now we need to deal with this portably.
549 (defun unhandled-trap-error (context-sap)
550 (declare (type system-area-pointer context-sap))
551 (infinite-error-protect
552 (let ((context (sap-alien context-sap (* os-context-t))))
553 (error 'breakpoint-error
555 :address (sap-int (sb!vm:context-pc context))))))