;;;; This file is for testing debugging functionality, using
-;;;; test machinery which might have side effects (e.g.
+;;;; test machinery which might have side effects (e.g.
;;;; executing DEFUN).
;;;; This software is part of the SBCL system. See the README file for
;;;; While most of SBCL is derived from the CMU CL system, the test
;;;; files (like this one) were written from scratch after the fork
;;;; from CMU CL.
-;;;;
+;;;;
;;;; This software is in the public domain and is provided with
;;;; absolutely no warranty. See the COPYING and CREDITS files for
;;;; more information.
(cl:in-package :cl-user)
+
+;;; The debugger doesn't have any native knowledge of the interpreter
+(when (eq sb-ext:*evaluator-mode* :interpret)
+ (sb-ext:quit :unix-status 104))
+
\f
;;;; Check that we get debug arglists right.
+;;; FIXME: This should use some get-argslist like functionality that
+;;; we actually export.
+;;;
;;; Return the debug arglist of the function object FUN as a list, or
;;; punt with :UNKNOWN.
(defun get-arglist (fun)
(#.sb-vm:simple-fun-header-widetag
(sb-kernel:%simple-fun-arglist fun))
(#.sb-vm:closure-header-widetag (get-arglist
- (sb-kernel:%closure-fun fun)))
+ (sb-kernel:%closure-fun fun)))
;; In code/describe.lisp, ll. 227 (%describe-fun), we use a scheme
;; like above, and it seems to work. -- MNA 2001-06-12
;;
;; happen to be the two case that I had my nose rubbed in when
;; debugging a GC problem caused by applying %SIMPLE-FUN-ARGLIST to
;; a closure. -- WHN 2001-06-05)
- (t :unknown)))
+ (t
+ #+sb-eval
+ (if (typep fun 'sb-eval::interpreted-function)
+ (sb-eval::interpreted-function-lambda-list fun)
+ :unknown)
+ #-sb-eval
+ :unknown)))
(defun zoop (zeep &key beep)
blurp)
;;; and that it contains the frames we expect, doesn't contain any
;;; "bogus stack frame"s, and contains the appropriate toplevel call
;;; and hasn't been cut off anywhere.
-(defun verify-backtrace (test-function frame-name
- &key (key #'first) (test #'eql)
- (allow-bogus-frames nil))
- (let ((result nil)
- (return-value nil))
- (block outer-handler
- (handler-bind
- ((error #'(lambda (condition)
- (let ((backtrace (ignore-errors
- (sb-debug:backtrace-as-list))))
- ;; Make sure we find what we're looking for.
- (when (member frame-name backtrace
- :key key :test test)
- (setf result (list :error condition)))
- ;; Make sure there's no bogus stack frames
- ;; unless they're explicitly allowed.
- (when (and (not allow-bogus-frames)
- (member "bogus stack frame" backtrace
- :key #'first :test #'equal))
+(defun verify-backtrace (test-function frame-specs &key (allow-stunted nil))
+ (labels ((args-equal (want real)
+ (cond ((eq '&rest (car want))
+ t)
+ ((endp want)
+ (endp real))
+ ((or (eq '? (car want)) (equal (car want) (car real)))
+ (args-equal (cdr want) (cdr real)))
+ (t
+ nil))))
+ (let ((result nil))
+ (block outer-handler
+ (handler-bind
+ ((error (lambda (condition)
+ ;; find the part of the backtrace we're interested in
+ (let ((backtrace (progn
+ ;; (backtrace 13)
+ (member (caar frame-specs)
+ (sb-debug:backtrace-as-list)
+ :key #'car
+ :test #'equal))))
+
+ (setf result condition)
+
+ (unless backtrace
+ (print :missing-backtrace)
(setf result nil))
+
+ ;; check that we have all the frames we wanted
+ (mapcar
+ (lambda (spec frame)
+ (unless (or (not spec)
+ (and (equal (car spec) (car frame))
+ (args-equal (cdr spec)
+ (cdr frame))))
+ (print (list :mismatch spec frame))
+ (setf result nil)))
+ frame-specs
+ backtrace)
+
;; Make sure the backtrace isn't stunted in
;; any way. (Depends on running in the main
;; thread.)
- (unless (member 'sb-impl::toplevel-init backtrace
- :key #'first :test #'equal)
- (setf result nil)))
- (return-from outer-handler))))
- (funcall test-function)))
- (values result return-value)))
+ (let ((end (last backtrace 2)))
+ (unless (equal (caar end)
+ (if *show-entry-point-details*
+ '(sb-c::tl-xep sb-impl::toplevel-init)
+ 'sb-impl::toplevel-init))
+ (print (list :backtrace-stunted (caar end)))
+ (setf result nil)))
+ (return-from outer-handler)))))
+ (funcall test-function)))
+ result)))
+
+(defvar *undefined-function-frame*
+ ;; bug 353
+ '(#+(or x86 x86-64) "bogus stack frame"
+ #-(or x86 x86-64) "undefined function"))
;;; Test for "undefined function" (undefined_tramp) working properly.
;;; Try it with and without tail call elimination, since they can have
;;; different effects. (Specifically, if undefined_tramp is incorrect
;;; a stunted stack can result from the tail call variant.)
-#-(or alpha x86) ; bug 345
-(progn
- (flet ((test-function ()
- (declare (optimize (speed 2) (debug 1))) ; tail call elimination
- (#:undefined-function 42)))
- (assert (verify-backtrace #'test-function "undefined function"
- :test #'equal)))
-
- (flet ((test-function ()
- (declare (optimize (speed 1) (debug 2))) ; no tail call elimination
- (#:undefined-function 42)))
- (assert (verify-backtrace #'test-function "undefined function"
- :test #'equal))))
+(flet ((optimized ()
+ (declare (optimize (speed 2) (debug 1))) ; tail call elimination
+ (#:undefined-function 42))
+ (not-optimized ()
+ (declare (optimize (speed 1) (debug 2))) ; no tail call elimination
+ (#:undefined-function 42))
+ (test (fun)
+ (declare (optimize (speed 1) (debug 2))) ; no tail call elimination
+ (funcall fun)))
+
+ (with-test (:name (:undefined-function :bug-346)
+ :fails-on '(or :alpha)) ; bug 346
+ (assert (verify-backtrace
+ (lambda () (test #'optimized))
+ (list *undefined-function-frame*
+ (list '(flet test) #'optimized)))))
+
+ ;; bug 353: This test fails at least most of the time for x86/linux
+ ;; ca. 0.8.20.16. -- WHN
+ (with-test (:name (:undefined-function :bug-353)
+ ;; This used to have fewer :fails-on features pre-0.9.16.38,
+ ;; but it turns out that the bug was just being masked by
+ ;; the presence of the IR1 stepper instrumentation (and
+ ;; is thus again failing now that the instrumentation is
+ ;; no more).
+ :fails-on '(or :x86 :x86-64 :alpha))
+ (assert (verify-backtrace
+ (lambda () (test #'not-optimized))
+ (list *undefined-function-frame*
+ (list '(flet not-optimized))
+ (list '(flet test) #'not-optimized))))))
;;; Division by zero was a common error on PPC. It depended on the
;;; return function either being before INTEGER-/-INTEGER in memory,
;;; the return value (to the flet or the enclosing top level form) is
;;; more than MOST-POSITIVE-FIXNUM with the current spaces on OS X.
;;; Enabling it might catch other problems, so do it anyway.
-#-alpha ; bug 346
-(progn
- (flet ((test-function ()
- (declare (optimize (speed 2) (debug 1))) ; tail call elimination
- (/ 42 0)))
- (assert (verify-backtrace #'test-function '/)))
-
- (flet ((test-function ()
- (declare (optimize (speed 1) (debug 2))) ; no tail call elimination
- (/ 42 0)))
- (assert (verify-backtrace #'test-function '/))))
-
-#-(or x86 alpha) ; bug 61
-(progn
- (defun throw-test ()
- (throw 'no-such-tag t))
- (assert (verify-backtrace #'throw-test 'throw-test)))
-
-;;; success
-(quit :unix-status 104)
+(flet ((optimized ()
+ (declare (optimize (speed 2) (debug 1))) ; tail call elimination
+ (/ 42 0))
+ (not-optimized ()
+ (declare (optimize (speed 1) (debug 2))) ; no tail call elimination
+ (/ 42 0))
+ (test (fun)
+ (declare (optimize (speed 1) (debug 2))) ; no tail call elimination
+ (funcall fun)))
+ (with-test (:name (:divide-by-zero :bug-346)
+ :fails-on '(or :alpha)) ; bug 346
+ (assert (verify-backtrace (lambda () (test #'optimized))
+ (list '(/ 42 &rest)
+ (list '(flet test) #'optimized)))))
+ (with-test (:name (:divide-by-zero :bug-356)
+ :fails-on '(or :alpha)) ; bug 356
+ (assert (verify-backtrace (lambda () (test #'not-optimized))
+ (list '(/ 42 &rest)
+ '((flet not-optimized))
+ (list '(flet test) #'not-optimized))))))
+
+(with-test (:name (:throw :no-such-tag)
+ :fails-on '(or
+ (and :x86 (or :linux :freebsd sunos))
+ :alpha
+ :mips))
+ (progn
+ (defun throw-test ()
+ (throw 'no-such-tag t))
+ (assert (verify-backtrace #'throw-test '((throw-test))))))
+
+;;; test entry point handling in backtraces
+
+(defun oops ()
+ (error "oops"))
+
+(defmacro defbt (n ll &body body)
+ `(progn
+ ;; normal debug info
+ (defun ,(intern (format nil "BT.~A.1" n)) ,ll
+ ,@body)
+ ;; no arguments saved
+ (defun ,(intern (format nil "BT.~A.2" n)) ,ll
+ (declare (optimize (debug 1) (speed 3)))
+ ,@body)
+ ;; no lambda-list saved
+ (defun ,(intern (format nil "BT.~A.3" n)) ,ll
+ (declare (optimize (debug 0)))
+ ,@body)))
+
+(defbt 1 (&key key)
+ (list key))
+
+(defbt 2 (x)
+ (list x))
+
+(defbt 3 (&key (key (oops)))
+ (list key))
+
+;;; ERROR instead of OOPS so that tail call elimination doesn't happen
+(defbt 4 (&optional opt)
+ (list (error "error")))
+
+(defbt 5 (&optional (opt (oops)))
+ (list opt))
+
+;;; FIXME: This test really should be broken into smaller pieces
+(with-test (:name (:backtrace :misc)
+ :fails-on '(and :x86 (or :linux :sunos)))
+ (macrolet ((with-details (bool &body body)
+ `(let ((sb-debug:*show-entry-point-details* ,bool))
+ ,@body)))
+
+ ;; TL-XEP
+ (print :tl-xep)
+ (with-details t
+ (assert (verify-backtrace #'namestring
+ '(((sb-c::tl-xep namestring) 0 ?)))))
+ (with-details nil
+ (assert (verify-backtrace #'namestring
+ '((namestring)))))
+
+
+ ;; &MORE-PROCESSOR
+ (with-details t
+ (assert (verify-backtrace (lambda () (bt.1.1 :key))
+ '(((sb-c::&more-processor bt.1.1) &rest))))
+ (assert (verify-backtrace (lambda () (bt.1.2 :key))
+ '(((sb-c::&more-processor bt.1.2) &rest))))
+ (assert (verify-backtrace (lambda () (bt.1.3 :key))
+ '(((sb-c::&more-processor bt.1.3) &rest)))))
+ (with-details nil
+ (assert (verify-backtrace (lambda () (bt.1.1 :key))
+ '((bt.1.1 :key))))
+ (assert (verify-backtrace (lambda () (bt.1.2 :key))
+ '((bt.1.2 &rest))))
+ (assert (verify-backtrace (lambda () (bt.1.3 :key))
+ '((bt.1.3 &rest)))))
+
+ ;; XEP
+ (print :xep)
+ (with-details t
+ (assert (verify-backtrace #'bt.2.1
+ '(((sb-c::xep bt.2.1) 0 ?))))
+ (assert (verify-backtrace #'bt.2.2
+ '(((sb-c::xep bt.2.2) &rest))))
+ (assert (verify-backtrace #'bt.2.3
+ '(((sb-c::xep bt.2.3) &rest)))))
+ (with-details nil
+ (assert (verify-backtrace #'bt.2.1
+ '((bt.2.1))))
+ (assert (verify-backtrace #'bt.2.2
+ '((bt.2.2 &rest))))
+ (assert (verify-backtrace #'bt.2.3
+ '((bt.2.3 &rest)))))
+
+ ;; VARARGS-ENTRY
+ (print :varargs-entry)
+ (with-details t
+ (assert (verify-backtrace #'bt.3.1
+ '(((sb-c::varargs-entry bt.3.1) :key nil))))
+ (assert (verify-backtrace #'bt.3.2
+ '(((sb-c::varargs-entry bt.3.2) :key ?))))
+ (assert (verify-backtrace #'bt.3.3
+ '(((sb-c::varargs-entry bt.3.3) &rest)))))
+ (with-details nil
+ (assert (verify-backtrace #'bt.3.1
+ '((bt.3.1 :key nil))))
+ (assert (verify-backtrace #'bt.3.2
+ '((bt.3.2 :key ?))))
+ (assert (verify-backtrace #'bt.3.3
+ '((bt.3.3 &rest)))))
+
+ ;; HAIRY-ARG-PROCESSOR
+ (print :hairy-args-processor)
+ (with-details t
+ (assert (verify-backtrace #'bt.4.1
+ '(((sb-c::hairy-arg-processor bt.4.1) ?))))
+ (assert (verify-backtrace #'bt.4.2
+ '(((sb-c::hairy-arg-processor bt.4.2) ?))))
+ (assert (verify-backtrace #'bt.4.3
+ '(((sb-c::hairy-arg-processor bt.4.3) &rest)))))
+ (with-details nil
+ (assert (verify-backtrace #'bt.4.1
+ '((bt.4.1 ?))))
+ (assert (verify-backtrace #'bt.4.2
+ '((bt.4.2 ?))))
+ (assert (verify-backtrace #'bt.4.3
+ '((bt.4.3 &rest)))))
+
+ ;; &OPTIONAL-PROCESSOR
+ (print :optional-processor)
+ (with-details t
+ (assert (verify-backtrace #'bt.5.1
+ '(((sb-c::&optional-processor bt.5.1)))))
+ (assert (verify-backtrace #'bt.5.2
+ '(((sb-c::&optional-processor bt.5.2) &rest))))
+ (assert (verify-backtrace #'bt.5.3
+ '(((sb-c::&optional-processor bt.5.3) &rest)))))
+ (with-details nil
+ (assert (verify-backtrace #'bt.5.1
+ '((bt.5.1))))
+ (assert (verify-backtrace #'bt.5.2
+ '((bt.5.2 &rest))))
+ (assert (verify-backtrace #'bt.5.3
+ '((bt.5.3 &rest)))))))
+
+;;;; test TRACE
+
+(defun trace-this ()
+ 'ok)
+
+(defun trace-fact (n)
+ (if (zerop n)
+ 1
+ (* n (trace-fact (1- n)))))
+
+(let ((out (with-output-to-string (*trace-output*)
+ (trace trace-this)
+ (assert (eq 'ok (trace-this)))
+ (untrace))))
+ (assert (search "TRACE-THIS" out))
+ (assert (search "returned OK" out)))
+
+;;; bug 379
+;;; This is not a WITH-TEST :FAILS-ON PPC DARWIN since there are
+;;; suspicions that the breakpoint trace might corrupt the whole image
+;;; on that platform.
+#-(and (or ppc x86) darwin)
+(with-test (:name (trace :encapsulate nil)
+ :fails-on '(or :ppc :sparc :mips))
+ (let ((out (with-output-to-string (*trace-output*)
+ (trace trace-this :encapsulate nil)
+ (assert (eq 'ok (trace-this)))
+ (untrace))))
+ (assert (search "TRACE-THIS" out))
+ (assert (search "returned OK" out))))
+
+#-(and (or ppc x86) darwin)
+(with-test (:name (trace-recursive :encapsulate nil)
+ :fails-on '(or :ppc :sparc :mips))
+ (let ((out (with-output-to-string (*trace-output*)
+ (trace trace-fact :encapsulate nil)
+ (assert (= 120 (trace-fact 5)))
+ (untrace))))
+ (assert (search "TRACE-FACT" out))
+ (assert (search "returned 1" out))
+ (assert (search "returned 120" out))))
+
+;;;; test infinite error protection
+
+(defmacro nest-errors (n-levels error-form)
+ (if (< 0 n-levels)
+ `(handler-bind ((error (lambda (condition)
+ (declare (ignore condition))
+ ,error-form)))
+ (nest-errors ,(1- n-levels) ,error-form))
+ error-form))
+
+(defun erroring-debugger-hook (condition old-debugger-hook)
+ (let ((*debugger-hook* old-debugger-hook))
+ (format t "recursive condition: ~A~%" condition) (force-output)
+ (error "recursive condition: ~A" condition)))
+
+(defun test-inifinite-error-protection ()
+ ;; after 50 successful throws to SB-IMPL::TOPLEVEL-CATCHER sbcl used
+ ;; to halt, it produces so much garbage that's hard to suppress that
+ ;; it is tested only once
+ (let ((*debugger-hook* #'erroring-debugger-hook))
+ (loop repeat 1 do
+ (let ((error-counter 0)
+ (*terminal-io* (make-broadcast-stream)))
+ (assert
+ (not (eq
+ :normal-exit
+ (catch 'sb-impl::toplevel-catcher
+ (nest-errors 20 (error "infinite error ~s"
+ (incf error-counter)))
+ :normal-exit))))))))
+
+(enable-debugger)
+
+(test-inifinite-error-protection)
+
+#+sb-thread
+(let ((thread (sb-thread:make-thread #'test-inifinite-error-protection)))
+ (loop while (sb-thread:thread-alive-p thread)))
+
+(disable-debugger)
projects / sbcl.git / blobdiff