Better error when calling an undefined alien function on x86-64.
[sbcl.git] / 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          (fn-name (symbolicate name "-HANDLER")))
26     (with-unique-names (fp context sc-offsets)
27       `(progn
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))
39                         (mapcar (lambda (var)
40                                   `(,var (sb!di::sub-access-debug-var-slot
41                                           ,fp
42                                           (nth ,(incf offset)
43                                            ,sc-offsets)
44                                           ,context)))
45                                 required))
46                  ,@(when rest-pos
47                      `((,(nth (1+ rest-pos) args)
48                         (mapcar (lambda (sc-offset)
49                                   (sb!di::sub-access-debug-var-slot
50                                    ,fp
51                                    sc-offset
52                                    ,context))
53                          (nthcdr ,rest-pos ,sc-offsets))))))
54              ,@body))
55         (setf (svref *internal-errors* ,(error-number-or-lose name))
56               #',fn-name)))))
57
58 ) ; EVAL-WHEN
59
60 (deferr unknown-error (&rest args)
61   (error "unknown error:~{ ~S~})" args))
62
63 (deferr object-not-fun-error (object)
64   (error 'type-error
65          :datum object
66          :expected-type 'function))
67
68 (deferr object-not-list-error (object)
69   (error 'type-error
70          :datum object
71          :expected-type 'list))
72
73 (deferr object-not-bignum-error (object)
74   (error 'type-error
75          :datum object
76          :expected-type 'bignum))
77
78 (deferr object-not-ratio-error (object)
79   (error 'type-error
80          :datum object
81          :expected-type 'ratio))
82
83 (deferr object-not-single-float-error (object)
84   (error 'type-error
85          :datum object
86          :expected-type 'single-float))
87
88 (deferr object-not-double-float-error (object)
89   (error 'type-error
90          :datum object
91          :expected-type 'double-float))
92
93 #!+long-float
94 (deferr object-not-long-float-error (object)
95   (error 'type-error
96          :datum object
97          :expected-type 'long-float))
98
99 (deferr object-not-simple-string-error (object)
100   (error 'type-error
101          :datum object
102          :expected-type 'simple-string))
103
104 (deferr object-not-fixnum-error (object)
105   (error 'type-error
106          :datum object
107          :expected-type 'fixnum))
108
109 (deferr object-not-vector-error (object)
110   (error 'type-error
111          :datum object
112          :expected-type 'vector))
113
114 (deferr object-not-string-error (object)
115   (error 'type-error
116          :datum object
117          :expected-type 'string))
118
119 (deferr object-not-base-string-error (object)
120   (error 'type-error
121          :datum object
122          :expected-type 'base-string))
123
124 (deferr object-not-vector-nil-error (object)
125   (error 'type-error
126          :datum object
127          :expected-type '(vector nil)))
128
129 #!+sb-unicode
130 (deferr object-not-character-string-error (object)
131   (error 'type-error
132          :datum object
133          :expected-type '(vector character)))
134
135 (deferr object-not-bit-vector-error (object)
136   (error 'type-error
137          :datum object
138          :expected-type 'bit-vector))
139
140 (deferr object-not-array-error (object)
141   (error 'type-error
142          :datum object
143          :expected-type 'array))
144
145 (deferr object-not-number-error (object)
146   (error 'type-error
147          :datum object
148          :expected-type 'number))
149
150 (deferr object-not-rational-error (object)
151   (error 'type-error
152          :datum object
153          :expected-type 'rational))
154
155 (deferr object-not-float-error (object)
156   (error 'type-error
157          :datum object
158          :expected-type 'float))
159
160 (deferr object-not-real-error (object)
161   (error 'type-error
162          :datum object
163          :expected-type 'real))
164
165 (deferr object-not-integer-error (object)
166   (error 'type-error
167          :datum object
168          :expected-type 'integer))
169
170 (deferr object-not-cons-error (object)
171   (error 'type-error
172          :datum object
173          :expected-type 'cons))
174
175 (deferr object-not-symbol-error (object)
176   (error 'type-error
177          :datum object
178          :expected-type 'symbol))
179
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)))))
185
186 #!+x86-64
187 (deferr undefined-alien-fun-error (address)
188   (error 'undefined-alien-function-error
189          :name
190          (and (integerp address)
191               (sap-foreign-symbol (int-sap address)))))
192
193 #!-x86-64
194 (defun undefined-alien-fun-error ()
195   (error 'undefined-alien-function-error))
196
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)))
201
202 (deferr bogus-arg-to-values-list-error (list)
203   (error 'simple-type-error
204          :datum list
205          :expected-type 'list
206          :format-control
207          "~@<attempt to use VALUES-LIST on a dotted list: ~2I~_~S~:>"
208          :format-arguments (list list)))
209
210 (deferr unbound-symbol-error (symbol)
211   (error 'unbound-variable :name symbol))
212
213 (deferr object-not-character-error (object)
214   (error 'type-error
215          :datum object
216          :expected-type 'character))
217
218 (deferr object-not-sap-error (object)
219   (error 'type-error
220          :datum object
221          :expected-type 'system-area-pointer))
222
223 (deferr invalid-unwind-error ()
224   (error 'simple-control-error
225          :format-control
226          "attempt to RETURN-FROM a block or GO to a tag that no longer exists"
227          ))
228
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)))
233
234 (deferr nil-fun-returned-error (function)
235   (error 'simple-control-error
236          :format-control
237          "A function with declared result type NIL returned:~%  ~S"
238          :format-arguments (list function)))
239
240 (deferr nil-array-accessed-error (array)
241   (error 'nil-array-accessed-error
242          :datum array :expected-type '(not (array nil))))
243
244 (deferr division-by-zero-error (this that)
245   (error 'division-by-zero
246          :operation 'division
247          :operands (list this that)))
248
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)))
254                  'layout-invalid
255                  'type-error)
256              :datum object
257              :expected-type type)))
258
259 (deferr layout-invalid-error (object layout)
260   (error 'layout-invalid
261          :datum object
262          :expected-type (layout-classoid layout)))
263
264 (deferr odd-key-args-error ()
265   (error 'simple-program-error
266          :format-control "odd number of &KEY arguments"))
267
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)))
272
273 (deferr invalid-array-index-error (array bound index)
274   (invalid-array-index-error array index bound))
275
276 (deferr object-not-simple-array-error (object)
277   (error 'type-error
278          :datum object
279          :expected-type 'simple-array))
280
281 (deferr object-not-signed-byte-32-error (object)
282   (error 'type-error
283          :datum object
284          :expected-type '(signed-byte 32)))
285
286 (deferr object-not-unsigned-byte-32-error (object)
287   (error 'type-error
288          :datum object
289          :expected-type '(unsigned-byte 32)))
290
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
296   ;; recursive error.
297   (%primitive print "Thread local storage exhausted.")
298   (sb!impl::%halt))
299
300 (macrolet
301     ((define-simple-array-internal-errors ()
302          `(progn
303            ,@(map 'list
304                   (lambda (saetp)
305                     `(deferr ,(symbolicate
306                                "OBJECT-NOT-"
307                                (sb!vm:saetp-primitive-type-name saetp)
308                                "-ERROR")
309                               (object)
310                       (error 'type-error
311                              :datum object
312                              :expected-type '(simple-array
313                                               ,(sb!vm:saetp-specifier saetp)
314                                               (*)))))
315                   sb!vm:*specialized-array-element-type-properties*))))
316   (define-simple-array-internal-errors))
317
318 (deferr object-not-complex-error (object)
319   (error 'type-error
320          :datum object
321          :expected-type 'complex))
322
323 (deferr object-not-complex-rational-error (object)
324   (error 'type-error
325          :datum object
326          :expected-type '(complex rational)))
327
328 (deferr object-not-complex-single-float-error (object)
329   (error 'type-error
330          :datum object
331          :expected-type '(complex single-float)))
332
333 (deferr object-not-complex-double-float-error (object)
334   (error 'type-error
335          :datum object
336          :expected-type '(complex double-float)))
337
338 #!+long-float
339 (deferr object-not-complex-long-float-error (object)
340   (error 'type-error
341          :datum object
342          :expected-type '(complex long-float)))
343
344 #!+sb-simd-pack
345 (deferr object-not-simd-pack-error (object)
346   (error 'type-error
347          :datum object
348          :expected-type 'simd-pack))
349
350 (deferr object-not-weak-pointer-error (object)
351   (error 'type-error
352          :datum object
353          :expected-type 'weak-pointer))
354
355 (deferr object-not-instance-error (object)
356   (error 'type-error
357          :datum object
358          :expected-type 'instance))
359
360 (deferr object-not-complex-vector-error (object)
361   (error 'type-error
362          :datum object
363          :expected-type '(and vector (not simple-array))))
364 \f
365 ;;;; fetching errorful function name
366
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)
370
371 (defun find-caller-name-and-frame ()
372   (if *finding-name*
373       (values "<error finding caller name -- already finding name>" nil)
374       (handler-case
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)
380             (values name frame))
381         (error ()
382           (values "<error finding caller name -- trapped error>" nil))
383         (sb!di:debug-condition ()
384           (values "<error finding caller name -- trapped debug-condition>"
385                   nil)))))
386
387 (defun find-interrupted-name-and-frame ()
388   (/show0 "entering FIND-INTERRUPTED-NAME-AND-FRAME")
389   (if *finding-name*
390       (values "<error finding interrupted name -- already finding name>" nil)
391       (handler-case
392           (let ((*finding-name* t))
393             (/show0 "in ordinary case")
394             (do ((frame (sb!di:top-frame) (sb!di:frame-down frame)))
395                 ((null 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))
405                                 frame)))))
406         (error ()
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>"
412                   nil)))))
413
414 (defun find-caller-of-named-frame (name)
415   (unless *finding-name*
416     (handler-case
417         (let ((*finding-name* t))
418           (do ((frame (sb!di:top-frame) (sb!di:frame-down frame)))
419               ((null 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)
425                 (return caller)))))
426       ((or error sb!di:debug-condition) ()
427         nil)
428       (sb!di:debug-condition ()
429         nil))))
430 \f
431
432 ;;;; INTERNAL-ERROR signal handler
433
434 (defun internal-error (context continuable)
435   (declare (type system-area-pointer context))
436   (declare (ignore continuable))
437   (/show0 "entering INTERNAL-ERROR, CONTEXT=..")
438   (/hexstr 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
445           (*saved-fp-and-pcs*
446            (cons (cons (%make-lisp-obj (sb!vm:context-register
447                                         alien-context
448                                         sb!vm::cfp-offset))
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)
456
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=..")
463        (/hexstr arguments)
464        (unless *cold-init-complete-p*
465          (%primitive print "can't recover from error in cold init, halting")
466          (%primitive sb!c:halt))
467
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
473                                                       sb!vm::cfp-offset)))
474                  (handler (and (< -1 error-number (length *internal-errors*))
475                                (svref *internal-errors* error-number))))
476              (cond ((null handler)
477                     (error 'simple-error
478                            :format-control
479                            "unknown internal error, ~D, args=~S"
480                            :format-arguments
481                            (list error-number
482                                  (mapcar (lambda (sc-offset)
483                                            (sb!di::sub-access-debug-var-slot
484                                             fp sc-offset alien-context))
485                                          arguments))))
486                    ((not (functionp handler))
487                     (error 'simple-error
488                            :format-control "internal error ~D: ~A; args=~S"
489                            :format-arguments
490                            (list error-number
491                                  handler
492                                  (mapcar (lambda (sc-offset)
493                                            (sb!di::sub-access-debug-var-slot
494                                             fp sc-offset alien-context))
495                                          arguments))))
496                    (t
497                     (funcall handler name fp alien-context arguments))))))))))
498
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))))
505
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))))
512
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))))
519
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*)
528
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*))))
534
535 (defun undefined-alien-variable-error ()
536   (error 'undefined-alien-variable-error))
537
538 #!-win32
539 (define-alien-variable current-memory-fault-address unsigned)
540
541 #!-win32
542 (defun memory-fault-error ()
543   (error 'memory-fault-error
544          :address current-memory-fault-address))
545
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
554             :context context
555             :address (sap-int (sb!vm:context-pc context))))))