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-fixnum-error (object)
 107   (error 'type-error
 108          :datum object
 109          :expected-type 'fixnum))
 110
 111 (deferr object-not-vector-error (object)
 112   (error 'type-error
 113          :datum object
 114          :expected-type 'vector))
 115
 116 (deferr object-not-string-error (object)
 117   (error 'type-error
 118          :datum object
 119          :expected-type 'string))
 120
 121 (deferr object-not-base-string-error (object)
 122   (error 'type-error
 123          :datum object
 124          :expected-type 'base-string))
 125
 126 (deferr object-not-vector-nil-error (object)
 127   (error 'type-error
 128          :datum object
 129          :expected-type '(vector nil)))
 130
 131 #!+sb-unicode
 132 (deferr object-not-character-string-error (object)
 133   (error 'type-error
 134          :datum object
 135          :expected-type '(vector character)))
 136
 137 (deferr object-not-bit-vector-error (object)
 138   (error 'type-error
 139          :datum object
 140          :expected-type 'bit-vector))
 141
 142 (deferr object-not-array-error (object)
 143   (error 'type-error
 144          :datum object
 145          :expected-type 'array))
 146
 147 (deferr object-not-number-error (object)
 148   (error 'type-error
 149          :datum object
 150          :expected-type 'number))
 151
 152 (deferr object-not-rational-error (object)
 153   (error 'type-error
 154          :datum object
 155          :expected-type 'rational))
 156
 157 (deferr object-not-float-error (object)
 158   (error 'type-error
 159          :datum object
 160          :expected-type 'float))
 161
 162 (deferr object-not-real-error (object)
 163   (error 'type-error
 164          :datum object
 165          :expected-type 'real))
 166
 167 (deferr object-not-integer-error (object)
 168   (error 'type-error
 169          :datum object
 170          :expected-type 'integer))
 171
 172 (deferr object-not-cons-error (object)
 173   (error 'type-error
 174          :datum object
 175          :expected-type 'cons))
 176
 177 (deferr object-not-symbol-error (object)
 178   (error 'type-error
 179          :datum object
 180          :expected-type 'symbol))
 181
 182 (deferr undefined-fun-error (fdefn-or-symbol)
 183   (error 'undefined-function
 184          :name (etypecase fdefn-or-symbol
 185                  (symbol fdefn-or-symbol)
 186                  (fdefn (fdefn-name fdefn-or-symbol)))))
 187
 188 (deferr invalid-arg-count-error (nargs)
 189   (error 'simple-program-error
 190          :format-control "invalid number of arguments: ~S"
 191          :format-arguments (list nargs)))
 192
 193 (deferr bogus-arg-to-values-list-error (list)
 194   (error 'simple-type-error
 195          :datum list
 196          :expected-type 'list
 197          :format-control
 198          "~@<attempt to use VALUES-LIST on a dotted list: ~2I~_~S~:>"
 199          :format-arguments (list list)))
 200
 201 (deferr unbound-symbol-error (symbol)
 202   (error 'unbound-variable :name symbol))
 203
 204 (deferr object-not-character-error (object)
 205   (error 'type-error
 206          :datum object
 207          :expected-type 'character))
 208
 209 (deferr object-not-sap-error (object)
 210   (error 'type-error
 211          :datum object
 212          :expected-type 'system-area-pointer))
 213
 214 (deferr invalid-unwind-error ()
 215   (error 'simple-control-error
 216          :format-control
 217          "attempt to RETURN-FROM a block or GO to a tag that no longer exists"
 218          ))
 219
 220 (deferr unseen-throw-tag-error (tag)
 221   (error 'simple-control-error
 222          :format-control "attempt to THROW to a tag that does not exist: ~S"
 223          :format-arguments (list tag)))
 224
 225 (deferr nil-fun-returned-error (function)
 226   (error 'simple-control-error
 227          :format-control
 228          "A function with declared result type NIL returned:~%  ~S"
 229          :format-arguments (list function)))
 230
 231 (deferr nil-array-accessed-error (array)
 232   (error 'nil-array-accessed-error
 233          :datum array :expected-type '(not (array nil))))
 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 (%instancep object)
 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-classoid layout)))
 252
 253 (deferr odd-key-args-error ()
 254   (error 'simple-program-error
 255          :format-control "odd number of &KEY arguments"))
 256
 257 (deferr unknown-key-arg-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-type-error
 264          :format-control
 265          "invalid array index ~W for ~S (should be nonnegative and <~W)"
 266          :format-arguments (list index array bound)
 267          :datum index
 268          :expected-type `(integer 0 (,bound))))
 269
 270 (deferr object-not-simple-array-error (object)
 271   (error 'type-error
 272          :datum object
 273          :expected-type 'simple-array))
 274
 275 (deferr object-not-signed-byte-32-error (object)
 276   (error 'type-error
 277          :datum object
 278          :expected-type '(signed-byte 32)))
 279
 280 (deferr object-not-unsigned-byte-32-error (object)
 281   (error 'type-error
 282          :datum object
 283          :expected-type '(unsigned-byte 32)))
 284
 285 (deferr tls-exhausted-error ()
 286   ;; There is nothing we can do about it. A number of entries in the
 287   ;; tls could be reserved and made available for recovery but since
 288   ;; tls indices are never reused it would be kind of silly and
 289   ;; without it signalling an error is more than likely to end in a
 290   ;; recursive error.
 291   (%primitive print "Thread local storage exhausted.")
 292   (sb!impl::%halt))
 293
 294 (macrolet
 295     ((define-simple-array-internal-errors ()
 296          `(progn
 297            ,@(map 'list
 298                   (lambda (saetp)
 299                     `(deferr ,(symbolicate
 300                                "OBJECT-NOT-"
 301                                (sb!vm:saetp-primitive-type-name saetp)
 302                                "-ERROR")
 303                               (object)
 304                       (error 'type-error
 305                              :datum object
 306                              :expected-type '(simple-array
 307                                               ,(sb!vm:saetp-specifier saetp)
 308                                               (*)))))
 309                   sb!vm:*specialized-array-element-type-properties*))))
 310   (define-simple-array-internal-errors))
 311
 312 (deferr object-not-complex-error (object)
 313   (error 'type-error
 314          :datum object
 315          :expected-type 'complex))
 316
 317 (deferr object-not-complex-rational-error (object)
 318   (error 'type-error
 319          :datum object
 320          :expected-type '(complex rational)))
 321
 322 (deferr object-not-complex-single-float-error (object)
 323   (error 'type-error
 324          :datum object
 325          :expected-type '(complex single-float)))
 326
 327 (deferr object-not-complex-double-float-error (object)
 328   (error 'type-error
 329          :datum object
 330          :expected-type '(complex double-float)))
 331
 332 #!+long-float
 333 (deferr object-not-complex-long-float-error (object)
 334   (error 'type-error
 335          :datum object
 336          :expected-type '(complex long-float)))
 337
 338 (deferr object-not-weak-pointer-error (object)
 339   (error 'type-error
 340          :datum object
 341          :expected-type 'weak-pointer))
 342
 343 (deferr object-not-instance-error (object)
 344   (error 'type-error
 345          :datum object
 346          :expected-type 'instance))
 347
 348 (deferr object-not-complex-vector-error (object)
 349   (error 'type-error
 350          :datum object
 351          :expected-type '(and vector (not simple-array))))
 352 \f
 353 ;;;; fetching errorful function name
 354
 355 ;;; This flag is used to prevent infinite recursive lossage when
 356 ;;; we can't find the caller for some reason.
 357 (defvar *finding-name* nil)
 358
 359 (defun find-caller-name-and-frame ()
 360   (if *finding-name*
 361       (values "<error finding caller name -- already finding name>" nil)
 362       (handler-case
 363           (let* ((*finding-name* t)
 364                  (frame (sb!di:frame-down (sb!di:frame-down (sb!di:top-frame))))
 365                  (name (sb!di:debug-fun-name
 366                         (sb!di:frame-debug-fun frame))))
 367             (sb!di:flush-frames-above frame)
 368             (values name frame))
 369         (error ()
 370           (values "<error finding caller name -- trapped error>" nil))
 371         (sb!di:debug-condition ()
 372           (values "<error finding caller name -- trapped debug-condition>"
 373                   nil)))))
 374
 375 (defun find-interrupted-name-and-frame ()
 376   (/show0 "entering FIND-INTERRUPTED-NAME-AND-FRAME")
 377   (if *finding-name*
 378       (values "<error finding interrupted name -- already finding name>" nil)
 379       (handler-case
 380           (let ((*finding-name* t))
 381             (/show0 "in ordinary case")
 382             (do ((frame (sb!di:top-frame) (sb!di:frame-down frame)))
 383                 ((null frame)
 384                  (/show0 "null frame")
 385                  (values "<error finding interrupted name -- null frame>" nil))
 386               (/show0 "at head of DO loop")
 387               (when (and (sb!di::compiled-frame-p frame)
 388                          (sb!di::compiled-frame-escaped frame))
 389                 (sb!di:flush-frames-above frame)
 390                 (/show0 "returning from within DO loop")
 391                 (return (values (sb!di:debug-fun-name
 392                                  (sb!di:frame-debug-fun frame))
 393                                 frame)))))
 394         (error ()
 395           (/show0 "trapped ERROR")
 396           (values "<error finding interrupted name -- trapped error>" nil))
 397         (sb!di:debug-condition ()
 398           (/show0 "trapped DEBUG-CONDITION")
 399           (values "<error finding interrupted name -- trapped debug-condition>"
 400                   nil)))))
 401 \f
 402
 403 ;;;; INTERNAL-ERROR signal handler
 404
 405 (defun internal-error (context continuable)
 406   (declare (type system-area-pointer context))
 407   (declare (ignore continuable))
 408   (/show0 "entering INTERNAL-ERROR, CONTEXT=..")
 409   (/hexstr context)
 410   (infinite-error-protect
 411    (/show0 "about to bind ALIEN-CONTEXT")
 412    (let ((alien-context (locally
 413                             (declare (optimize (inhibit-warnings 3)))
 414                           (sb!alien:sap-alien context (* os-context-t)))))
 415      (/show0 "about to bind ERROR-NUMBER and ARGUMENTS")
 416      (multiple-value-bind (error-number arguments)
 417          (sb!vm:internal-error-args alien-context)
 418
 419        ;; There's a limit to how much error reporting we can usefully
 420        ;; do before initialization is complete, but try to be a little
 421        ;; bit helpful before we die.
 422        (/show0 "back from INTERNAL-ERROR-ARGS, ERROR-NUMBER=..")
 423        (/hexstr error-number)
 424        (/show0 "cold/low ARGUMENTS=..")
 425        (/hexstr arguments)
 426        (unless *cold-init-complete-p*
 427          (%primitive print "can't recover from error in cold init, halting")
 428          (%primitive sb!c:halt))
 429
 430        (with-interrupt-bindings
 431          (multiple-value-bind (name sb!debug:*stack-top-hint*)
 432              (find-interrupted-name-and-frame)
 433            (/show0 "back from FIND-INTERRUPTED-NAME")
 434            ;; Unblock trap signal here, we unwound the stack and can't return.
 435            ;; FIXME: Should we not reset the _entire_ mask, but just
 436            ;; restore it to the state before we got the condition?
 437            ;; FIXME 2: Signals are currently unblocked in
 438            ;; interrupt.c:internal_error before we do stack unwinding, can this
 439            ;; introduce a race condition?
 440            #!+(and linux mips)
 441            (sb!unix::reset-signal-mask)
 442            (let ((fp (int-sap (sb!vm:context-register alien-context
 443                                                       sb!vm::cfp-offset)))
 444                  (handler (and (< -1 error-number (length *internal-errors*))
 445                                (svref *internal-errors* error-number))))
 446              (cond ((null handler)
 447                     (error 'simple-error
 448                            :format-control
 449                            "unknown internal error, ~D, args=~S"
 450                            :format-arguments
 451                            (list error-number
 452                                  (mapcar (lambda (sc-offset)
 453                                            (sb!di::sub-access-debug-var-slot
 454                                             fp sc-offset alien-context))
 455                                          arguments))))
 456                    ((not (functionp handler))
 457                     (error 'simple-error
 458                            :format-control "internal error ~D: ~A; args=~S"
 459                            :format-arguments
 460                            (list error-number
 461                                  handler
 462                                  (mapcar (lambda (sc-offset)
 463                                            (sb!di::sub-access-debug-var-slot
 464                                             fp sc-offset alien-context))
 465                                          arguments))))
 466                    (t
 467                     (funcall handler name fp alien-context arguments))))))))))
 468
 469 (defun control-stack-exhausted-error ()
 470   (let ((sb!debug:*stack-top-hint* nil))
 471     (infinite-error-protect
 472      (format *error-output*
 473              "Control stack guard page temporarily disabled: proceed with caution~%")
 474      (error 'control-stack-exhausted))))
 475
 476 ;;; KLUDGE: we keep a single HEAP-EXHAUSTED-ERROR object around, so
 477 ;;; that we don't need to allocate it when running out of
 478 ;;; memory. Similarly we pass the amounts in special variables as
 479 ;;; there may be multiple threads running into trouble at the same
 480 ;;; time. The condition is created by GC-REINIT.
 481 (defvar *heap-exhausted-error-condition*)
 482 (defvar *heap-exhausted-error-available-bytes*)
 483 (defvar *heap-exhausted-error-requested-bytes*)
 484
 485 (defun heap-exhausted-error (available requested)
 486   (infinite-error-protect
 487    (let ((*heap-exhausted-error-available-bytes* available)
 488          (*heap-exhausted-error-requested-bytes* requested))
 489      (error *heap-exhausted-error-condition*))))
 490
 491 (defun undefined-alien-variable-error ()
 492   (error 'undefined-alien-variable-error))
 493
 494 (defun undefined-alien-function-error ()
 495   (error 'undefined-alien-function-error))
 496
 497 #!-win32
 498 (define-alien-variable current-memory-fault-address unsigned-long)
 499
 500 #!-win32
 501 (defun memory-fault-error ()
 502   (error 'memory-fault-error
 503          :address current-memory-fault-address))
 504
 505 ;;; This is SIGTRAP / EXCEPTION_BREAKPOINT that runtime could not deal
 506 ;;; with. Prior to Windows we just had a Lisp side handler for
 507 ;;; SIGTRAP, but now we need to deal with this portably.
 508 (defun unhandled-trap-error (context-sap)
 509   (declare (type system-area-pointer context-sap))
 510   (infinite-error-protect
 511    (let ((context (sap-alien context-sap (* os-context-t))))
 512      (error 'breakpoint-error
 513             :context context
 514             :address (sap-int (sb!vm:context-pc context))))))