tests/debug.impure.lisp

   1 ;;;; This file is for testing debugging functionality, using
   2 ;;;; test machinery which might have side effects (e.g.
   3 ;;;; executing DEFUN).
   4
   5 ;;;; This software is part of the SBCL system. See the README file for
   6 ;;;; more information.
   7 ;;;;
   8 ;;;; While most of SBCL is derived from the CMU CL system, the test
   9 ;;;; files (like this one) were written from scratch after the fork
  10 ;;;; from CMU CL.
  11 ;;;;
  12 ;;;; This software is in the public domain and is provided with
  13 ;;;; absolutely no warranty. See the COPYING and CREDITS files for
  14 ;;;; more information.
  15
  16 (cl:in-package :cl-user)
  17 \f
  18 ;;;; Check that we get debug arglists right.
  19
  20 ;;; FIXME: This should use some get-argslist like functionality that
  21 ;;; we actually export.
  22 ;;;
  23 ;;; Return the debug arglist of the function object FUN as a list, or
  24 ;;; punt with :UNKNOWN.
  25 (defun get-arglist (fun)
  26   (declare (type function fun))
  27   ;; The Lisp-level type FUNCTION can conceal a multitude of sins..
  28   (case (sb-kernel:widetag-of fun)
  29     (#.sb-vm:simple-fun-header-widetag
  30       (sb-kernel:%simple-fun-arglist fun))
  31     (#.sb-vm:closure-header-widetag (get-arglist
  32                                      (sb-kernel:%closure-fun fun)))
  33     ;; In code/describe.lisp, ll. 227 (%describe-fun), we use a scheme
  34     ;; like above, and it seems to work. -- MNA 2001-06-12
  35     ;;
  36     ;; (There might be other cases with arglist info also.
  37     ;; SIMPLE-FUN-HEADER-WIDETAG and CLOSURE-HEADER-WIDETAG just
  38     ;; happen to be the two case that I had my nose rubbed in when
  39     ;; debugging a GC problem caused by applying %SIMPLE-FUN-ARGLIST to
  40     ;; a closure. -- WHN 2001-06-05)
  41     (t :unknown)))
  42
  43 (defun zoop (zeep &key beep)
  44   blurp)
  45 (assert (equal (get-arglist #'zoop) '(zeep &key beep)))
  46
  47 ;;; Check some predefined functions too.
  48 ;;;
  49 ;;; (We don't know exactly what the arguments are, e.g. the first
  50 ;;; argument of PRINT might be SB-IMPL::OBJECT or SB-KERNEL::OBJ or
  51 ;;; whatever. But we do know the general structure that a correct
  52 ;;; answer should have, so we can safely do a lot of checks.)
  53 (destructuring-bind (object-sym &optional-sym stream-sym) (get-arglist #'print)
  54   (assert (symbolp object-sym))
  55   (assert (eql &optional-sym '&optional))
  56   (assert (symbolp stream-sym)))
  57 (destructuring-bind (dest-sym control-sym &rest-sym format-args-sym)
  58     (get-arglist #'format)
  59   (assert (symbolp dest-sym))
  60   (assert (symbolp control-sym))
  61   (assert (eql &rest-sym '&rest))
  62   (assert (symbolp format-args-sym)))
  63
  64 ;;; Check for backtraces generally being correct.  Ensure that the
  65 ;;; actual backtrace finishes (doesn't signal any errors on its own),
  66 ;;; and that it contains the frames we expect, doesn't contain any
  67 ;;; "bogus stack frame"s, and contains the appropriate toplevel call
  68 ;;; and hasn't been cut off anywhere.
  69 (defun verify-backtrace (test-function frame-specs &key (allow-stunted nil))
  70   (labels ((args-equal (want real)
  71              (cond ((endp want)
  72                     (endp real))
  73                    ((eq '&rest (car want))
  74                     t)
  75                    ((or (eq '? (car want)) (equal (car want) (car real)))
  76                     (args-equal (cdr want) (cdr real)))
  77                    (t
  78                     nil))))
  79     (let ((result nil))
  80       (block outer-handler
  81         (handler-bind
  82             ((error (lambda (condition)
  83                       ;; find the part of the backtrace we're interested in
  84                       (let ((backtrace (progn
  85                                          ;; (backtrace 13)
  86                                          (member (caar frame-specs)
  87                                                  (sb-debug:backtrace-as-list)
  88                                                  :key #'car
  89                                                  :test #'equal))))
  90
  91                         (setf result condition)
  92
  93                         (unless backtrace
  94                           (print :missing-backtrace)
  95                           (setf result nil))
  96
  97                         ;; check that we have all the frames we wanted
  98                         (mapcar
  99                          (lambda (spec frame)
 100                            (unless (or (not spec)
 101                                        (and (equal (car spec) (car frame))
 102                                             (args-equal (cdr spec)
 103                                                         (cdr frame))))
 104                              (print (list :mismatch spec frame))
 105                              (setf result nil)))
 106                          frame-specs
 107                          backtrace)
 108
 109                         ;; Make sure the backtrace isn't stunted in
 110                         ;; any way.  (Depends on running in the main
 111                         ;; thread.)
 112                         (let ((end (last backtrace 2)))
 113                           (unless (equal (caar end)
 114                                          (if *show-entry-point-details*
 115                                              '(sb-c::tl-xep sb-impl::toplevel-init)
 116                                              'sb-impl::toplevel-init))
 117                             (print (list :backtrace-stunted (caar end)))
 118                             (setf result nil)))
 119                         (return-from outer-handler)))))
 120           (funcall test-function)))
 121       result)))
 122
 123 (defvar *undefined-function-frame*
 124   ;; bug 353
 125   '(#+(or x86 x86-64) "bogus stack frame"
 126     #-(or x86 x86-64) "undefined function"))
 127
 128 #-(or alpha) ; bug 346
 129 ;;; Test for "undefined function" (undefined_tramp) working properly.
 130 ;;; Try it with and without tail call elimination, since they can have
 131 ;;; different effects.  (Specifically, if undefined_tramp is incorrect
 132 ;;; a stunted stack can result from the tail call variant.)
 133 (flet ((optimized ()
 134          (declare (optimize (speed 2) (debug 1))) ; tail call elimination
 135          (#:undefined-function 42))
 136        (not-optimized ()
 137          (declare (optimize (speed 1) (debug 2))) ; no tail call elimination
 138          (#:undefined-function 42))
 139        (test (fun)
 140          (declare (optimize (speed 1) (debug 2))) ; no tail call elimination
 141          (funcall fun)))
 142
 143   (assert (verify-backtrace
 144            (lambda () (test #'optimized))
 145            (list *undefined-function-frame*
 146                  (list '(flet test) #'optimized))))
 147
 148   (assert (verify-backtrace
 149            (lambda () (test #'not-optimized))
 150            (list *undefined-function-frame*
 151                  (list '(flet not-optimized))
 152                  (list '(flet test) #'not-optimized)))))
 153
 154 #-alpha ; bug 346
 155 ;;; Division by zero was a common error on PPC.  It depended on the
 156 ;;; return function either being before INTEGER-/-INTEGER in memory,
 157 ;;; or more than MOST-POSITIVE-FIXNUM bytes ahead.  It also depends on
 158 ;;; INTEGER-/-INTEGER calling SIGNED-TRUNCATE.  I believe Raymond Toy
 159 ;;; says that the Sparc backend (at least for CMUCL) inlines this, so
 160 ;;; if SBCL does the same this test is probably not good for the
 161 ;;; Sparc.
 162 ;;;
 163 ;;; Disabling tail call elimination on this will probably ensure that
 164 ;;; the return value (to the flet or the enclosing top level form) is
 165 ;;; more than MOST-POSITIVE-FIXNUM with the current spaces on OS X.
 166 ;;; Enabling it might catch other problems, so do it anyway.
 167 (flet ((optimized ()
 168          (declare (optimize (speed 2) (debug 1))) ; tail call elimination
 169          (/ 42 0))
 170        (not-optimized ()
 171          (declare (optimize (speed 1) (debug 2))) ; no tail call elimination
 172          (/ 42 0))
 173        (test (fun)
 174          (declare (optimize (speed 1) (debug 2))) ; no tail call elimination
 175          (funcall fun)))
 176   (assert (verify-backtrace (lambda () (test #'optimized))
 177                             (list '(/ 42 &rest)
 178                                   (list '(flet test) #'optimized))))
 179   (assert (verify-backtrace (lambda () (test #'not-optimized))
 180                             (list '(/ 42 &rest)
 181                                   '((flet not-optimized))
 182                                   (list '(flet test) #'not-optimized)))))
 183
 184 #-(or alpha) ; bug 61
 185 (progn
 186   (defun throw-test ()
 187     (throw 'no-such-tag t))
 188   (assert (verify-backtrace #'throw-test '((throw-test)))))
 189
 190 ;;; test entry point handling in backtraces
 191
 192 (defun oops ()
 193   (error "oops"))
 194
 195 (defun bt.1 (&key key)
 196   (list key))
 197
 198 (defun bt.2 (x)
 199   (list x))
 200
 201 (defun bt.3 (&key (key (oops)))
 202   (list key))
 203
 204 ;;; ERROR instead of OOPS so that tail call elimination doesn't happen
 205 (defun bt.4 (&optional opt)
 206   (list (error "error")))
 207
 208 (defun bt.5 (&optional (opt (oops)))
 209   (list opt))
 210
 211 (macrolet ((with-details (bool &body body)
 212              `(let ((sb-debug:*show-entry-point-details* ,bool))
 213                 ,@body)))
 214
 215   ;; &MORE-PROCESSOR
 216   (with-details t
 217     (assert (verify-backtrace (lambda () (bt.1 :key))
 218                               '(((sb-c::&more-processor bt.1) &rest)))))
 219   (with-details nil
 220     (assert (verify-backtrace (lambda () (bt.1 :key))
 221                               '((bt.1 :key)))))
 222
 223   ;; XEP
 224   (with-details t
 225     (assert (verify-backtrace #'bt.2
 226                               '(((sb-c::xep bt.2) 0 ?)))))
 227   (with-details nil
 228     (assert (verify-backtrace #'bt.2
 229                               '((bt.2)))))
 230
 231   ;; TL-XEP
 232   (with-details t
 233     (assert (verify-backtrace #'namestring
 234                               '(((sb-c::tl-xep namestring) 0 ?)))))
 235   (with-details nil
 236     (assert (verify-backtrace #'namestring
 237                               '((namestring)))))
 238
 239   ;; VARARGS-ENTRY
 240   (with-details t
 241     (assert (verify-backtrace #'bt.3
 242                              '(((sb-c::varargs-entry bt.3) :key nil)))))
 243   (with-details nil
 244     (assert (verify-backtrace #'bt.3
 245                               '((bt.3 :key nil)))))
 246
 247   ;; HAIRY-ARG-PROCESSOR
 248   (with-details t
 249     (assert (verify-backtrace #'bt.4
 250                               '(((sb-c::hairy-arg-processor bt.4) ?)))))
 251   (with-details nil
 252     (assert (verify-backtrace #'bt.4
 253                               '((bt.4 ?)))))
 254
 255   ;; &OPTIONAL-PROCESSOR
 256   (with-details t
 257     (assert (verify-backtrace #'bt.5
 258                               '(((sb-c::&optional-processor bt.5))))))
 259   (with-details nil
 260     (assert (verify-backtrace #'bt.5
 261                               '((bt.5))))))
 262
 263 ;;; success
 264 (quit :unix-status 104)