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)))))
186 (deferr invalid-arg-count-error (nargs)
187 (error 'simple-program-error
188 :format-control "invalid number of arguments: ~S"
189 :format-arguments (list nargs)))
191 (deferr bogus-arg-to-values-list-error (list)
192 (error 'simple-type-error
196 "~@<attempt to use VALUES-LIST on a dotted list: ~2I~_~S~:>"
197 :format-arguments (list list)))
199 (deferr unbound-symbol-error (symbol)
200 (error 'unbound-variable :name symbol))
202 (deferr object-not-character-error (object)
205 :expected-type 'character))
207 (deferr object-not-sap-error (object)
210 :expected-type 'system-area-pointer))
212 (deferr invalid-unwind-error ()
213 (error 'simple-control-error
215 "attempt to RETURN-FROM a block or GO to a tag that no longer exists"
218 (deferr unseen-throw-tag-error (tag)
219 (error 'simple-control-error
220 :format-control "attempt to THROW to a tag that does not exist: ~S"
221 :format-arguments (list tag)))
223 (deferr nil-fun-returned-error (function)
224 (error 'simple-control-error
226 "A function with declared result type NIL returned:~% ~S"
227 :format-arguments (list function)))
229 (deferr nil-array-accessed-error (array)
230 (error 'nil-array-accessed-error
231 :datum array :expected-type '(not (array nil))))
233 (deferr division-by-zero-error (this that)
234 (error 'division-by-zero
236 :operands (list this that)))
238 (deferr object-not-type-error (object type)
239 (error (if (and (%instancep object)
240 (layout-invalid (%instance-layout object)))
244 :expected-type type))
246 (deferr layout-invalid-error (object layout)
247 (error 'layout-invalid
249 :expected-type (layout-classoid layout)))
251 (deferr odd-key-args-error ()
252 (error 'simple-program-error
253 :format-control "odd number of &KEY arguments"))
255 (deferr unknown-key-arg-error (key-name)
256 (error 'simple-program-error
257 :format-control "unknown &KEY argument: ~S"
258 :format-arguments (list key-name)))
260 (deferr invalid-array-index-error (array bound index)
261 (invalid-array-index-error array index bound))
263 (deferr object-not-simple-array-error (object)
266 :expected-type 'simple-array))
268 (deferr object-not-signed-byte-32-error (object)
271 :expected-type '(signed-byte 32)))
273 (deferr object-not-unsigned-byte-32-error (object)
276 :expected-type '(unsigned-byte 32)))
278 (deferr tls-exhausted-error ()
279 ;; There is nothing we can do about it. A number of entries in the
280 ;; tls could be reserved and made available for recovery but since
281 ;; tls indices are never reused it would be kind of silly and
282 ;; without it signalling an error is more than likely to end in a
284 (%primitive print "Thread local storage exhausted.")
288 ((define-simple-array-internal-errors ()
292 `(deferr ,(symbolicate
294 (sb!vm:saetp-primitive-type-name saetp)
299 :expected-type '(simple-array
300 ,(sb!vm:saetp-specifier saetp)
302 sb!vm:*specialized-array-element-type-properties*))))
303 (define-simple-array-internal-errors))
305 (deferr object-not-complex-error (object)
308 :expected-type 'complex))
310 (deferr object-not-complex-rational-error (object)
313 :expected-type '(complex rational)))
315 (deferr object-not-complex-single-float-error (object)
318 :expected-type '(complex single-float)))
320 (deferr object-not-complex-double-float-error (object)
323 :expected-type '(complex double-float)))
326 (deferr object-not-complex-long-float-error (object)
329 :expected-type '(complex long-float)))
331 (deferr object-not-weak-pointer-error (object)
334 :expected-type 'weak-pointer))
336 (deferr object-not-instance-error (object)
339 :expected-type 'instance))
341 (deferr object-not-complex-vector-error (object)
344 :expected-type '(and vector (not simple-array))))
346 ;;;; fetching errorful function name
348 ;;; This flag is used to prevent infinite recursive lossage when
349 ;;; we can't find the caller for some reason.
350 (defvar *finding-name* nil)
352 (defun find-caller-name-and-frame ()
354 (values "<error finding caller name -- already finding name>" nil)
356 (let* ((*finding-name* t)
357 (frame (sb!di:frame-down (sb!di:frame-down (sb!di:top-frame))))
358 (name (sb!di:debug-fun-name
359 (sb!di:frame-debug-fun frame))))
360 (sb!di:flush-frames-above frame)
363 (values "<error finding caller name -- trapped error>" nil))
364 (sb!di:debug-condition ()
365 (values "<error finding caller name -- trapped debug-condition>"
368 (defun find-interrupted-name-and-frame ()
369 (/show0 "entering FIND-INTERRUPTED-NAME-AND-FRAME")
371 (values "<error finding interrupted name -- already finding name>" nil)
373 (let ((*finding-name* t))
374 (/show0 "in ordinary case")
375 (do ((frame (sb!di:top-frame) (sb!di:frame-down frame)))
377 (/show0 "null frame")
378 (values "<error finding interrupted name -- null frame>" nil))
379 (/show0 "at head of DO loop")
380 (when (and (sb!di::compiled-frame-p frame)
381 (sb!di::compiled-frame-escaped frame))
382 (sb!di:flush-frames-above frame)
383 (/show0 "returning from within DO loop")
384 (return (values (sb!di:debug-fun-name
385 (sb!di:frame-debug-fun frame))
388 (/show0 "trapped ERROR")
389 (values "<error finding interrupted name -- trapped error>" nil))
390 (sb!di:debug-condition ()
391 (/show0 "trapped DEBUG-CONDITION")
392 (values "<error finding interrupted name -- trapped debug-condition>"
396 ;;;; INTERNAL-ERROR signal handler
398 (defun internal-error (context continuable)
399 (declare (type system-area-pointer context))
400 (declare (ignore continuable))
401 (/show0 "entering INTERNAL-ERROR, CONTEXT=..")
403 (infinite-error-protect
404 (/show0 "about to bind ALIEN-CONTEXT")
405 (let ((alien-context (locally
406 (declare (optimize (inhibit-warnings 3)))
407 (sb!alien:sap-alien context (* os-context-t)))))
408 (/show0 "about to bind ERROR-NUMBER and ARGUMENTS")
409 (multiple-value-bind (error-number arguments)
410 (sb!vm:internal-error-args alien-context)
412 ;; There's a limit to how much error reporting we can usefully
413 ;; do before initialization is complete, but try to be a little
414 ;; bit helpful before we die.
415 (/show0 "back from INTERNAL-ERROR-ARGS, ERROR-NUMBER=..")
416 (/hexstr error-number)
417 (/show0 "cold/low ARGUMENTS=..")
419 (unless *cold-init-complete-p*
420 (%primitive print "can't recover from error in cold init, halting")
421 (%primitive sb!c:halt))
423 (with-interrupt-bindings
424 (multiple-value-bind (name sb!debug:*stack-top-hint*)
425 (find-interrupted-name-and-frame)
426 (/show0 "back from FIND-INTERRUPTED-NAME")
427 (let ((fp (int-sap (sb!vm:context-register alien-context
429 (handler (and (< -1 error-number (length *internal-errors*))
430 (svref *internal-errors* error-number))))
431 (cond ((null handler)
434 "unknown internal error, ~D, args=~S"
437 (mapcar (lambda (sc-offset)
438 (sb!di::sub-access-debug-var-slot
439 fp sc-offset alien-context))
441 ((not (functionp handler))
443 :format-control "internal error ~D: ~A; args=~S"
447 (mapcar (lambda (sc-offset)
448 (sb!di::sub-access-debug-var-slot
449 fp sc-offset alien-context))
452 (funcall handler name fp alien-context arguments))))))))))
454 (defun control-stack-exhausted-error ()
455 (let ((sb!debug:*stack-top-hint* nil))
456 (infinite-error-protect
457 (format *error-output*
458 "Control stack guard page temporarily disabled: proceed with caution~%")
459 (error 'control-stack-exhausted))))
461 (defun binding-stack-exhausted-error ()
462 (let ((sb!debug:*stack-top-hint* nil))
463 (infinite-error-protect
464 (format *error-output*
465 "Binding stack guard page temporarily disabled: proceed with caution~%")
466 (error 'binding-stack-exhausted))))
468 (defun alien-stack-exhausted-error ()
469 (let ((sb!debug:*stack-top-hint* nil))
470 (infinite-error-protect
471 (format *error-output*
472 "Alien stack guard page temporarily disabled: proceed with caution~%")
473 (error 'alien-stack-exhausted))))
475 ;;; KLUDGE: we keep a single HEAP-EXHAUSTED-ERROR object around, so
476 ;;; that we don't need to allocate it when running out of
477 ;;; memory. Similarly we pass the amounts in special variables as
478 ;;; there may be multiple threads running into trouble at the same
479 ;;; time. The condition is created by GC-REINIT.
480 (defvar *heap-exhausted-error-condition*)
481 (defvar *heap-exhausted-error-available-bytes*)
482 (defvar *heap-exhausted-error-requested-bytes*)
484 (defun heap-exhausted-error (available requested)
485 (infinite-error-protect
486 (let ((*heap-exhausted-error-available-bytes* available)
487 (*heap-exhausted-error-requested-bytes* requested))
488 (error *heap-exhausted-error-condition*))))
490 (defun undefined-alien-variable-error ()
491 (error 'undefined-alien-variable-error))
493 (defun undefined-alien-function-error ()
494 (error 'undefined-alien-function-error))
497 (define-alien-variable current-memory-fault-address unsigned-long)
500 (defun memory-fault-error ()
501 (error 'memory-fault-error
502 :address current-memory-fault-address))
504 ;;; This is SIGTRAP / EXCEPTION_BREAKPOINT that runtime could not deal
505 ;;; with. Prior to Windows we just had a Lisp side handler for
506 ;;; SIGTRAP, but now we need to deal with this portably.
507 (defun unhandled-trap-error (context-sap)
508 (declare (type system-area-pointer context-sap))
509 (infinite-error-protect
510 (let ((context (sap-alien context-sap (* os-context-t))))
511 (error 'breakpoint-error
513 :address (sap-int (sb!vm:context-pc context))))))