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