1 ;;;; This file is for testing debugging functionality, using
2 ;;;; test machinery which might have side effects (e.g.
5 ;;;; This software is part of the SBCL system. See the README file for
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
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.
16 (cl:in-package :cl-user)
18 ;;; The debugger doesn't have any native knowledge of the interpreter
19 (when (eq sb-ext:*evaluator-mode* :interpret)
20 (sb-ext:quit :unix-status 104))
23 ;;;; Check that we get debug arglists right.
25 ;;; FIXME: This should use some get-argslist like functionality that
26 ;;; we actually export.
28 ;;; Return the debug arglist of the function object FUN as a list, or
29 ;;; punt with :UNKNOWN.
30 (defun get-arglist (fun)
31 (declare (type function fun))
32 ;; The Lisp-level type FUNCTION can conceal a multitude of sins..
33 (case (sb-kernel:widetag-of fun)
34 (#.sb-vm:simple-fun-header-widetag
35 (sb-kernel:%simple-fun-arglist fun))
36 (#.sb-vm:closure-header-widetag (get-arglist
37 (sb-kernel:%closure-fun fun)))
38 ;; In code/describe.lisp, ll. 227 (%describe-fun), we use a scheme
39 ;; like above, and it seems to work. -- MNA 2001-06-12
41 ;; (There might be other cases with arglist info also.
42 ;; SIMPLE-FUN-HEADER-WIDETAG and CLOSURE-HEADER-WIDETAG just
43 ;; happen to be the two case that I had my nose rubbed in when
44 ;; debugging a GC problem caused by applying %SIMPLE-FUN-ARGLIST to
45 ;; a closure. -- WHN 2001-06-05)
48 (if (typep fun 'sb-eval::interpreted-function)
49 (sb-eval::interpreted-function-lambda-list fun)
54 (defun zoop (zeep &key beep)
56 (assert (equal (get-arglist #'zoop) '(zeep &key beep)))
58 ;;; Check some predefined functions too.
60 ;;; (We don't know exactly what the arguments are, e.g. the first
61 ;;; argument of PRINT might be SB-IMPL::OBJECT or SB-KERNEL::OBJ or
62 ;;; whatever. But we do know the general structure that a correct
63 ;;; answer should have, so we can safely do a lot of checks.)
64 (destructuring-bind (object-sym &optional-sym stream-sym) (get-arglist #'print)
65 (assert (symbolp object-sym))
66 (assert (eql &optional-sym '&optional))
67 (assert (symbolp stream-sym)))
68 (destructuring-bind (dest-sym control-sym &rest-sym format-args-sym)
69 (get-arglist #'format)
70 (assert (symbolp dest-sym))
71 (assert (symbolp control-sym))
72 (assert (eql &rest-sym '&rest))
73 (assert (symbolp format-args-sym)))
75 ;;; Check for backtraces generally being correct. Ensure that the
76 ;;; actual backtrace finishes (doesn't signal any errors on its own),
77 ;;; and that it contains the frames we expect, doesn't contain any
78 ;;; "bogus stack frame"s, and contains the appropriate toplevel call
79 ;;; and hasn't been cut off anywhere.
80 (defun verify-backtrace (test-function frame-specs &key (allow-stunted nil))
81 (labels ((args-equal (want real)
82 (cond ((eq '&rest (car want))
86 ((or (eq '? (car want)) (equal (car want) (car real)))
87 (args-equal (cdr want) (cdr real)))
93 ((error (lambda (condition)
94 ;; find the part of the backtrace we're interested in
95 (let ((backtrace (progn
97 (member (caar frame-specs)
98 (sb-debug:backtrace-as-list)
102 (setf result condition)
105 (print :missing-backtrace)
108 ;; check that we have all the frames we wanted
111 (unless (or (not spec)
112 (and (equal (car spec) (car frame))
113 (args-equal (cdr spec)
115 (print (list :mismatch spec frame))
120 ;; Make sure the backtrace isn't stunted in
121 ;; any way. (Depends on running in the main
122 ;; thread.) FIXME: On Windows we get two
123 ;; extra foreign frames below regular frames.
124 (let ((end (last backtrace #-win32 2 #+win32 4)))
125 (unless (equal (caar end)
126 'sb-impl::toplevel-init)
127 (print (list :backtrace-stunted (caar end)))
129 (return-from outer-handler)))))
130 (funcall test-function)))
133 (defvar *undefined-function-frame*
135 '(#+(or x86 x86-64) "bogus stack frame"
136 #-(or x86 x86-64) "undefined function"))
138 ;;; Test for "undefined function" (undefined_tramp) working properly.
139 ;;; Try it with and without tail call elimination, since they can have
140 ;;; different effects. (Specifically, if undefined_tramp is incorrect
141 ;;; a stunted stack can result from the tail call variant.)
143 (declare (optimize (speed 2) (debug 1))) ; tail call elimination
144 (#:undefined-function 42))
146 (declare (optimize (speed 1) (debug 2))) ; no tail call elimination
147 (#:undefined-function 42))
149 (declare (optimize (speed 1) (debug 2))) ; no tail call elimination
152 (with-test (:name (:undefined-function :bug-346)
153 :fails-on '(or :alpha)) ; bug 346
154 (assert (verify-backtrace
155 (lambda () (test #'optimized))
156 (list *undefined-function-frame*
157 (list '(flet test) #'optimized)))))
159 ;; bug 353: This test fails at least most of the time for x86/linux
160 ;; ca. 0.8.20.16. -- WHN
161 (with-test (:name (:undefined-function :bug-353)
162 ;; This used to have fewer :fails-on features pre-0.9.16.38,
163 ;; but it turns out that the bug was just being masked by
164 ;; the presence of the IR1 stepper instrumentation (and
165 ;; is thus again failing now that the instrumentation is
167 :fails-on '(or :x86 :x86-64 :alpha))
168 (assert (verify-backtrace
169 (lambda () (test #'not-optimized))
170 (list *undefined-function-frame*
171 (list '(flet not-optimized))
172 (list '(flet test) #'not-optimized))))))
174 ;;; Division by zero was a common error on PPC. It depended on the
175 ;;; return function either being before INTEGER-/-INTEGER in memory,
176 ;;; or more than MOST-POSITIVE-FIXNUM bytes ahead. It also depends on
177 ;;; INTEGER-/-INTEGER calling SIGNED-TRUNCATE. I believe Raymond Toy
178 ;;; says that the Sparc backend (at least for CMUCL) inlines this, so
179 ;;; if SBCL does the same this test is probably not good for the
182 ;;; Disabling tail call elimination on this will probably ensure that
183 ;;; the return value (to the flet or the enclosing top level form) is
184 ;;; more than MOST-POSITIVE-FIXNUM with the current spaces on OS X.
185 ;;; Enabling it might catch other problems, so do it anyway.
187 (declare (optimize (speed 2) (debug 1))) ; tail call elimination
190 (declare (optimize (speed 1) (debug 2))) ; no tail call elimination
193 (declare (optimize (speed 1) (debug 2))) ; no tail call elimination
195 (with-test (:name (:divide-by-zero :bug-346)
196 :fails-on '(or :alpha)) ; bug 346
197 (assert (verify-backtrace (lambda () (test #'optimized))
199 (list '(flet test) #'optimized)))))
200 (with-test (:name (:divide-by-zero :bug-356)
201 :fails-on '(or :alpha)) ; bug 356
202 (assert (verify-backtrace (lambda () (test #'not-optimized))
204 '((flet not-optimized))
205 (list '(flet test) #'not-optimized))))))
207 (with-test (:name (:throw :no-such-tag)
209 (and :x86 (or :linux :freebsd sunos))
214 (throw 'no-such-tag t))
215 (assert (verify-backtrace #'throw-test '((throw-test))))))
217 ;;; test entry point handling in backtraces
222 (defmacro defbt (n ll &body body)
225 (defun ,(intern (format nil "BT.~A.1" n)) ,ll
227 ;; no arguments saved
228 (defun ,(intern (format nil "BT.~A.2" n)) ,ll
229 (declare (optimize (debug 1) (speed 3)))
231 ;; no lambda-list saved
232 (defun ,(intern (format nil "BT.~A.3" n)) ,ll
233 (declare (optimize (debug 0)))
242 (defbt 3 (&key (key (oops)))
245 ;;; ERROR instead of OOPS so that tail call elimination doesn't happen
246 (defbt 4 (&optional opt)
247 (list (error "error")))
249 (defbt 5 (&optional (opt (oops)))
252 ;;; FIXME: This test really should be broken into smaller pieces
253 (with-test (:name (:backtrace :misc)
254 :fails-on '(and :x86 (or :linux :sunos)))
255 (macrolet ((with-details (bool &body body)
256 `(let ((sb-debug:*show-entry-point-details* ,bool))
262 (assert (verify-backtrace #'namestring
263 '(((sb-c::tl-xep namestring) 0 ?)))))
265 (assert (verify-backtrace #'namestring
271 (assert (verify-backtrace (lambda () (bt.1.1 :key))
272 '(((sb-c::&more-processor bt.1.1) &rest))))
273 (assert (verify-backtrace (lambda () (bt.1.2 :key))
274 '(((sb-c::&more-processor bt.1.2) &rest))))
275 (assert (verify-backtrace (lambda () (bt.1.3 :key))
276 '(((sb-c::&more-processor bt.1.3) &rest)))))
278 (assert (verify-backtrace (lambda () (bt.1.1 :key))
280 (assert (verify-backtrace (lambda () (bt.1.2 :key))
282 (assert (verify-backtrace (lambda () (bt.1.3 :key))
288 (assert (verify-backtrace #'bt.2.1
289 '(((sb-c::xep bt.2.1) 0 ?))))
290 (assert (verify-backtrace #'bt.2.2
291 '(((sb-c::xep bt.2.2) &rest))))
292 (assert (verify-backtrace #'bt.2.3
293 '(((sb-c::xep bt.2.3) &rest)))))
295 (assert (verify-backtrace #'bt.2.1
297 (assert (verify-backtrace #'bt.2.2
299 (assert (verify-backtrace #'bt.2.3
303 (print :varargs-entry)
305 (assert (verify-backtrace #'bt.3.1
306 '(((sb-c::varargs-entry bt.3.1) :key nil))))
307 (assert (verify-backtrace #'bt.3.2
308 '(((sb-c::varargs-entry bt.3.2) :key ?))))
309 (assert (verify-backtrace #'bt.3.3
310 '(((sb-c::varargs-entry bt.3.3) &rest)))))
312 (assert (verify-backtrace #'bt.3.1
313 '((bt.3.1 :key nil))))
314 (assert (verify-backtrace #'bt.3.2
316 (assert (verify-backtrace #'bt.3.3
319 ;; HAIRY-ARG-PROCESSOR
320 (print :hairy-args-processor)
322 (assert (verify-backtrace #'bt.4.1
323 '(((sb-c::hairy-arg-processor bt.4.1) ?))))
324 (assert (verify-backtrace #'bt.4.2
325 '(((sb-c::hairy-arg-processor bt.4.2) ?))))
326 (assert (verify-backtrace #'bt.4.3
327 '(((sb-c::hairy-arg-processor bt.4.3) &rest)))))
329 (assert (verify-backtrace #'bt.4.1
331 (assert (verify-backtrace #'bt.4.2
333 (assert (verify-backtrace #'bt.4.3
336 ;; &OPTIONAL-PROCESSOR
337 (print :optional-processor)
339 (assert (verify-backtrace #'bt.5.1
340 '(((sb-c::&optional-processor bt.5.1)))))
341 (assert (verify-backtrace #'bt.5.2
342 '(((sb-c::&optional-processor bt.5.2) &rest))))
343 (assert (verify-backtrace #'bt.5.3
344 '(((sb-c::&optional-processor bt.5.3) &rest)))))
346 (assert (verify-backtrace #'bt.5.1
348 (assert (verify-backtrace #'bt.5.2
350 (assert (verify-backtrace #'bt.5.3
351 '((bt.5.3 &rest)))))))
358 (defun trace-fact (n)
361 (* n (trace-fact (1- n)))))
363 (let ((out (with-output-to-string (*trace-output*)
365 (assert (eq 'ok (trace-this)))
367 (assert (search "TRACE-THIS" out))
368 (assert (search "returned OK" out)))
371 ;;; This is not a WITH-TEST :FAILS-ON PPC DARWIN since there are
372 ;;; suspicions that the breakpoint trace might corrupt the whole image
373 ;;; on that platform.
374 #-(and (or ppc x86) darwin)
375 (with-test (:name (trace :encapsulate nil)
376 :fails-on '(or :ppc :sparc :mips))
377 (let ((out (with-output-to-string (*trace-output*)
378 (trace trace-this :encapsulate nil)
379 (assert (eq 'ok (trace-this)))
381 (assert (search "TRACE-THIS" out))
382 (assert (search "returned OK" out))))
384 #-(and (or ppc x86) darwin)
385 (with-test (:name (trace-recursive :encapsulate nil)
386 :fails-on '(or :ppc :sparc :mips))
387 (let ((out (with-output-to-string (*trace-output*)
388 (trace trace-fact :encapsulate nil)
389 (assert (= 120 (trace-fact 5)))
391 (assert (search "TRACE-FACT" out))
392 (assert (search "returned 1" out))
393 (assert (search "returned 120" out))))
395 ;;;; test infinite error protection
397 (defmacro nest-errors (n-levels error-form)
399 `(handler-bind ((error (lambda (condition)
400 (declare (ignore condition))
402 (nest-errors ,(1- n-levels) ,error-form))
405 (defun erroring-debugger-hook (condition old-debugger-hook)
406 (let ((*debugger-hook* old-debugger-hook))
407 (format t "recursive condition: ~A~%" condition) (force-output)
408 (error "recursive condition: ~A" condition)))
410 (defun test-inifinite-error-protection ()
411 ;; after 50 successful throws to SB-IMPL::TOPLEVEL-CATCHER sbcl used
412 ;; to halt, it produces so much garbage that's hard to suppress that
413 ;; it is tested only once
414 (let ((*debugger-hook* #'erroring-debugger-hook))
416 (let ((error-counter 0)
417 (*terminal-io* (make-broadcast-stream)))
421 (catch 'sb-impl::toplevel-catcher
422 (nest-errors 20 (error "infinite error ~s"
423 (incf error-counter)))
428 (test-inifinite-error-protection)
431 (let ((thread (sb-thread:make-thread #'test-inifinite-error-protection)))
432 (loop while (sb-thread:thread-alive-p thread)))
436 (write-line "/debug.impure.lisp done")