0.9.16.38:
[sbcl.git] / tests / debug.impure.lisp
index 96bd754..ea5d8b7 100644 (file)
@@ -1,5 +1,5 @@
 ;;;; 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
@@ -8,12 +8,17 @@
 ;;;; 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.
 
@@ -29,7 +34,7 @@
     (#.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)
                                                  (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 
+                        (mapcar
                          (lambda (spec frame)
                            (unless (or (not spec)
                                        (and (equal (car spec) (car frame))
-                                            (args-equal (cdr spec) 
+                                            (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.)
                         (let ((end (last backtrace 2)))
-                          (unless (equal (caar end) 
+                          (unless (equal (caar end)
                                          (if *show-entry-point-details*
                                              '(sb-c::tl-xep sb-impl::toplevel-init)
                                              'sb-impl::toplevel-init))
   '(#+(or x86 x86-64) "bogus stack frame"
     #-(or x86 x86-64) "undefined function"))
 
-#-(or alpha) ; bug 346
 ;;; 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
          (declare (optimize (speed 1) (debug 2))) ; no tail call elimination
          (funcall fun)))
 
-  (assert (verify-backtrace
-           (lambda () (test #'optimized))
-           (list *undefined-function-frame*
-                 (list '(flet test) #'optimized))))
-  
+  (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
-  #-(and x86 linux)
-  (assert (verify-backtrace 
-           (lambda () (test #'not-optimized))
-           (list *undefined-function-frame*
-                 (list '(flet not-optimized))
-                 (list '(flet test) #'not-optimized)))))
-
-#-alpha ; bug 346
+  (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,
 ;;; or more than MOST-POSITIVE-FIXNUM bytes ahead.  It also depends on
        (test (fun)
          (declare (optimize (speed 1) (debug 2))) ; no tail call elimination
          (funcall fun)))
-  (assert (verify-backtrace (lambda () (test #'optimized))
-                            (list '(/ 42 &rest) 
-                                  (list '(flet test) #'optimized))))
-  (assert (verify-backtrace (lambda () (test #'not-optimized))
-                            (list '(/ 42 &rest)
-                                  '((flet not-optimized))
-                                  (list '(flet test) #'not-optimized)))))
-
-#-(or alpha (and x86 linux)) ; bug 61
-(progn
-  (defun throw-test ()
-    (throw 'no-such-tag t))
-  (assert (verify-backtrace #'throw-test '((throw-test)))))
+  (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
 
 (defmacro defbt (n ll &body body)
   `(progn
      ;; normal debug info
-     (defun ,(intern (format nil "BT.~A.1" n)) ,ll 
+     (defun ,(intern (format nil "BT.~A.1" n)) ,ll
        ,@body)
      ;; no arguments saved
-     (defun ,(intern (format nil "BT.~A.2" n)) ,ll 
+     (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 
+     (defun ,(intern (format nil "BT.~A.3" n)) ,ll
        (declare (optimize (debug 0)))
        ,@body)))
 
 (defbt 5 (&optional (opt (oops)))
   (list opt))
 
-#-(and x86 linux)
-(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))))))
-
-;;; success
-(quit :unix-status 104)
+;;; 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)