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:exit
:code
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
37 (get-arglist (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 (with-test (:name
:predefined-functions-1
)
65 (destructuring-bind (object-sym &optional-sym stream-sym
) (get-arglist #'print
)
66 (assert (symbolp object-sym
))
67 (assert (eql &optional-sym
'&optional
))
68 (assert (symbolp stream-sym
))))
70 (with-test (:name
:predefined-functions-2
)
71 (destructuring-bind (dest-sym control-sym
&rest-sym format-args-sym
)
72 (get-arglist #'format
)
73 (assert (symbolp dest-sym
))
74 (assert (symbolp control-sym
))
75 (assert (eql &rest-sym
'&rest
))
76 (assert (symbolp format-args-sym
))))
80 (defmacro with-traced-function
((name &rest options
) &body body
)
81 `(with-output-to-string (*trace-output
*)
84 (trace ,name
,@options
)
86 (ignore-errors (untrace ,name
)))))
94 (* n
(trace-fact (1- n
)))))
96 (with-test (:name
(trace :simple
))
97 (let ((output (with-traced-function (trace-this)
98 (assert (eq 'ok
(trace-this))))))
99 (assert (search "TRACE-THIS" output
))
100 (assert (search "returned OK" output
))))
103 ;;; This is not a WITH-TEST :FAILS-ON PPC DARWIN since there are
104 ;;; suspicions that the breakpoint trace might corrupt the whole image
105 ;;; on that platform.
106 (with-test (:name
(trace :encapsulate nil
)
107 :fails-on
'(or (and :ppc
(not :linux
)) :sparc
:arm64
)
108 :broken-on
'(or :darwin
:sunos
:hppa
))
109 (let ((output (with-traced-function (trace-this :encapsulate nil
)
110 (assert (eq 'ok
(trace-this))))))
111 (assert (search "TRACE-THIS" output
))
112 (assert (search "returned OK" output
))))
114 (with-test (:name
(:trace
:encapsulate nil
:recursive
)
115 :fails-on
'(or (and :ppc
(not :linux
)) :sparc
:sunos
:arm64
)
116 :broken-on
'(or :darwin
(and :x86
:sunos
) :hppa
))
117 (let ((output (with-traced-function (trace-fact :encapsulate nil
)
118 (assert (= 120 (trace-fact 5))))))
119 (assert (search "TRACE-FACT" output
))
120 (assert (search "returned 1" output
))
121 (assert (search "returned 120" output
))))
123 (defun trace-and-fmakunbound-this (x)
126 (with-test (:name
(trace fmakunbound
:bug-667657
))
127 (trace trace-and-fmakunbound-this
)
128 (fmakunbound 'trace-and-fmakunbound-this
)
130 (assert (not (trace))))
132 (with-test (:name
(trace :report nil
:smoke
))
133 (let ((output (with-traced-function (trace-this :report nil
)
134 (assert (eq 'ok
(trace-this))))))
135 (assert (sequence:emptyp output
))))
137 (with-test (:name
(trace :report nil
:print
))
138 (let ((output (with-traced-function
139 (trace-fact :report nil
:print
(sb-debug:arg
0))
140 (assert (eq '2 (trace-fact 2))))))
141 (assert (string= output
(format nil
"2~@
145 (with-test (:name
:bug-414
)
146 (handler-bind ((warning #'error
))
147 (load (compile-file "bug-414.lisp"))
148 (disassemble 'bug-414
)))
150 ;; A known function can be stored as a code constant in lieu of the
151 ;; usual mode of storing an #<fdefn> and looking up the function from it.
152 ;; One such usage occurs with TAIL-CALL-VARIABLE (e.g. via APPLY).
153 ;; Show that declaring the function locally notinline uses the #<fdefn>
154 ;; by first compiling a call that would have elided the #<fdefn>
156 (defun test-compile-then-load (filename junk
)
157 (declare (notinline compile-file load
))
158 (apply 'load
(apply 'compile-file filename junk
) junk
))
159 (compile 'test-compile-then-load
)
160 (with-test (:name
:traceable-known-fun
)
161 (let ((s (make-string-output-stream)))
162 (trace compile-file load
)
163 (let ((*trace-output
* s
))
164 (test-compile-then-load "bug-414.lisp" nil
))
166 (assert (>= (count #\Newline
(get-output-stream-string s
)) 4))))
168 (with-test (:name
:bug-310175
:fails-on
'(not :stack-allocatable-lists
))
169 ;; KLUDGE: Not all DX-enabled platforms DX CONS, and the compiler
170 ;; transforms two-arg-LIST* (and one-arg-LIST) to CONS. Therefore,
171 ;; use two-arg-LIST, which should get through to VOP LIST, and thus
172 ;; stack-allocate on a predictable set of machines.
173 (let ((dx-arg (list t t
)))
174 (declare (dynamic-extent dx-arg
))
175 (flet ((dx-arg-backtrace (x)
176 (declare (optimize (debug 2)))
177 (prog1 (sb-debug:list-backtrace
:count
10)
178 (assert (sb-debug::stack-allocated-p x
)))))
179 (declare (notinline dx-arg-backtrace
))
180 (assert (member-if (lambda (frame)
183 (equal '(flet dx-arg-backtrace
:in
) (butlast (car frame
)))
184 (notany #'sb-debug
::stack-allocated-p
(cdr frame
))))
185 (dx-arg-backtrace dx-arg
))))))
187 (with-test (:name
:bug-795245
)
195 (sb-debug:print-backtrace
:count
100
196 :stream
(make-broadcast-stream))
198 (throw 'done
:error
))
200 (throw 'done
:ok
))))))
201 (apply '/= nil
1 2 nil
))))))
203 ;;;; test infinite error protection
205 (defmacro nest-errors
(n-levels error-form
)
207 `(handler-bind ((error (lambda (condition)
208 (declare (ignore condition
))
210 (nest-errors ,(1- n-levels
) ,error-form
))
213 (defun erroring-debugger-hook (condition old-debugger-hook
)
214 (let ((*debugger-hook
* old-debugger-hook
))
215 (format t
"recursive condition: ~A~%" condition
) (force-output)
216 (error "recursive condition: ~A" condition
)))
218 (defun test-infinite-error-protection ()
219 ;; after 50 successful throws to SB-IMPL::TOPLEVEL-CATCHER sbcl used
220 ;; to halt, it produces so much garbage that's hard to suppress that
221 ;; it is tested only once
222 (write-line "--HARMLESS BUT ALARMING BACKTRACE COMING UP--")
223 (let ((*debugger-hook
* #'erroring-debugger-hook
))
225 (let ((error-counter 0)
226 (*terminal-io
* (make-broadcast-stream)))
230 (catch 'sb-impl
::toplevel-catcher
231 (nest-errors 20 (error "infinite error ~s"
232 (incf error-counter
)))
234 (write-line "--END OF H-B-A-B--"))
236 (with-test (:name
:infinite-error-protection
)
238 (test-infinite-error-protection))
240 (with-test (:name
(:infinite-error-protection
:thread
)
241 :skipped-on
'(not :sb-thread
))
243 (let ((thread (sb-thread:make-thread
#'test-infinite-error-protection
)))
244 (loop while
(sb-thread:thread-alive-p thread
))))
246 ;; unconditional, in case either previous left it enabled
249 ;;;; test some limitations of MAKE-LISP-OBJ
251 ;;; Older GENCGC systems had a bug in the pointer validation used by
252 ;;; MAKE-LISP-OBJ that made SIMPLE-FUN objects always fail to
254 (with-test (:name
(:make-lisp-obj
:simple-funs
))
255 (sb-sys:without-gcing
256 (assert (eq #'identity
257 (sb-kernel:make-lisp-obj
258 (sb-kernel:get-lisp-obj-address
261 ;;; Older CHENEYGC systems didn't perform any real pointer validity
262 ;;; checks beyond "is this pointer to somewhere in heap space".
263 (with-test (:name
(:make-lisp-obj
:pointer-validation
))
264 ;; Fun and games: We need to test MAKE-LISP-OBJ with a known-bogus
265 ;; address, but we also need the GC to not pitch a fit if it sees an
266 ;; object with said bogus address. Thus, construct our known-bogus
267 ;; object within an area of unboxed storage (a vector) in static
268 ;; space. We'll make it a simple object, (CONS 0 0), which has an
269 ;; in-memory representation of two consecutive zero words. We
270 ;; allocate a three-word vector so that we can guarantee a
271 ;; double-word aligned double-word of zeros no matter what happens
272 ;; with the vector-data-offset (currently double-word aligned).
273 (let* ((memory (sb-int:make-static-vector
3 :element-type
`(unsigned-byte ,sb-vm
:n-word-bits
)
275 (vector-data-address (sb-sys:sap-int
(sb-kernel::vector-sap memory
)))
276 (object-base-address (logandc2 (+ vector-data-address sb-vm
:lowtag-mask
) sb-vm
:lowtag-mask
))
277 (object-tagged-address (+ object-base-address sb-vm
:list-pointer-lowtag
)))
278 (multiple-value-bind (object valid-p
)
279 (sb-kernel:make-lisp-obj object-tagged-address nil
)
280 (declare (ignore object
))
281 (assert (not valid-p
)))))
283 (defun test-debugger (control form
&rest targets
)
284 (let ((out (make-string-output-stream))
288 (with-simple-restart (debugger-test-done! "Debugger Test Done!")
289 (let* ((*debug-io
* (make-two-way-stream
290 (make-string-input-stream control
)
291 (make-broadcast-stream out
#+nil
*standard-output
*)))
292 ;; Initial announcement goes to *ERROR-OUTPUT*
293 (*error-output
* *debug-io
*)
294 (*invoke-debugger-hook
* nil
))
295 (handler-bind ((error #'invoke-debugger
))
299 (error "Uncontrolled unwind from debugger test.")))
300 ;; For sanity's sake this is outside the *debug-io* rebinding -- otherwise
301 ;; it could swallow our asserts!
302 (with-input-from-string (s (get-output-stream-string out
))
303 (loop for line
= (read-line s nil
)
307 (format *error-output
* "Got: ~A~%" line
)
308 (let ((match (pop targets
)))
310 ;; Whatever, till the next line matches.
311 (let ((text (pop targets
)))
313 (format *error-output
* "Looking for: ~A~%" text
)
314 (unless (search text line
)
316 (push match targets
)))
317 (unless (search match line
)
318 (format *error-output
* "~&Wanted: ~S~% Got: ~S~%" match line
)
320 ;; Check that we saw everything we wanted
322 (error "Missed: ~S" targets
))
323 (assert (not oops
))))
325 (with-test (:name
(:debugger
:source
1))
331 (defun this-will-break (x)
332 (declare (optimize debug
))
345 "(THIS-WILL-BREAK 1)"
350 (with-test (:name
(:debugger
:source
2))
355 `(locally (declare (optimize (speed 0) (safety 3) (debug 3)))
356 (let ((f #'(lambda (x cont
)
357 (print x
(make-broadcast-stream))
360 (funcall cont
(1- x
) cont
)))))
367 "source: (ERROR \"~%foo\")"
371 "(FUNCALL CONT (1- X) CONT)"
374 (with-test (:name
(disassemble :high-debug-eval
))
375 (eval `(defun this-will-be-disassembled (x)
376 (declare (optimize debug
))
378 (let* ((oopses (make-string-output-stream))
380 (let ((*error-output
* oopses
))
381 (with-output-to-string (*standard-output
*)
382 (disassemble 'this-will-be-disassembled
)))))
383 (with-input-from-string (s disassembly
)
384 (assert (search "; disassembly for THIS-WILL-BE-DISASSEMBLED"
386 (let ((problems (get-output-stream-string oopses
)))
387 (unless (zerop (length problems
))
390 (defun this-too-will-be-disasssembled (x)
391 (declare (optimize debug
))
394 (with-test (:name
(disassemble :high-debug-load
))
395 (let* ((oopses (make-string-output-stream))
397 (let ((*error-output
* oopses
))
398 (with-output-to-string (*standard-output
*)
399 (disassemble 'this-too-will-be-disasssembled
)))))
400 (with-input-from-string (s disassembly
)
401 (assert (equal "; disassembly for THIS-TOO-WILL-BE-DISASSSEMBLED"
403 (let ((problems (get-output-stream-string oopses
)))
404 (unless (zerop (length problems
))
407 ;; The test named :GF-dispatch-backtrace depends on the fact that renaming
408 ;; a closure works, and that the debugger can extract a closure name.
409 ;; First things first: verify that a closure can be named.
410 (defun make-adder (x)
411 (sb-impl::set-closure-name
(lambda (y) (+ x y
)) `(adder ,x
)))
412 (with-test (:name
:closure-renaming-really-works
)
413 (let ((f1 (make-adder 5))
414 (expect "#<CLOSURE (ADDER 5)"))
415 (assert (= (mismatch (write-to-string (make-adder 5)) expect
)
417 (assert (and (eq (sb-impl::set-closure-name f1
"ADD5") f1
)
418 (string= (sb-impl::%fun-name f1
) "ADD5")))))
420 (with-test (:name
(:xep-arglist-clean-up
:bug-1192929
))
423 (handler-bind ((error (lambda (e)
425 (return (< (length (car (sb-debug:list-backtrace
:count
1)))
427 (funcall (compile nil
`(lambda (i) (declare ((mod 65536) i
)) i
)) nil
)))))
431 (defun print-backtrace-to-string/debug-print-variable-alist
(x)
433 (with-output-to-string (stream)
434 (let ((*debug-print-variable-alist
* '((*print-length
* .
5)
435 (*print-level
* .
3))))
436 (sb-debug:print-backtrace
:stream stream
:count
5)))
437 x
)) ; Force use of X to prevent flushing
439 (with-test (:name
(:print-frame-call
:respect
*debug-print-variable-alist
*
440 *print-length
* :bug-1261646
))
441 (let* ((printed (print-backtrace-to-string/debug-print-variable-alist
(make-array 200)))
442 (call "(PRINT-BACKTRACE-TO-STRING/DEBUG-PRINT-VARIABLE-ALIST ")
443 (position (+ (search call printed
) (length call
))))
444 (assert (eql position
(search "#(0 0 0 0 0 ...)" printed
:start2 position
)))))
446 (with-test (:name
(:print-frame-call
:respect
*debug-print-variable-alist
*
447 *print-level
* :bug-1261646
))
448 (let* ((printed (print-backtrace-to-string/debug-print-variable-alist
450 (call "(PRINT-BACKTRACE-TO-STRING/DEBUG-PRINT-VARIABLE-ALIST ")
451 (position (+ (search call printed
) (length call
))))
452 (assert (eql position
(search "((#))" printed
:start2 position
)))))
458 (with-test (:name
:trace-debug-arg
)
459 (trace foo
:print-after
(setf *x
* (sb-debug:arg
0)))
463 (trace foo
:print
(setf *x
* (sb-debug:arg
0)))
467 (trace foo
:condition
(eql (setf *x
* (sb-debug:arg
0)) 0))
471 (trace foo
:condition-after
(setf *x
* (sb-debug:arg
0)))
475 (trace foo
:break
(and (setf *x
* (sb-debug:arg
0)) nil
))
479 (trace foo
:break-all
(and (setf *x
* (sb-debug:arg
0)) nil
))
482 (trace foo
:break-after
(and (setf *x
* (sb-debug:arg
0)) nil
))
485 (defun frobbleize (arg) (declare (ignore arg
)) (sb-debug:print-backtrace
) 'win
)
486 (defmethod low-debug-method ((self t
))
487 (declare (optimize (debug 0)))
488 (frobbleize 'me
) ; make this not a tail call, so it remains on stack
490 (with-test (:name
:clean-fast-method-frame-lossage
)
491 (low-debug-method 42)) ; no need to assert. it either crashes or doesn't
493 (defun return-65535 ()
496 (with-test (:name
:indirect-closure-values
)
499 (handler-bind ((error (lambda (c)
501 (sb-debug::map-backtrace
503 (let ((sb-debug::*current-frame
* frame
)
504 (name (sb-debug::frame-call frame
)))
505 (when (or (eq name
'test
)
507 (or (eql (search '(labels f1
) name
) 0)
508 (eql (search '(labels f2
) name
) 0))))
510 (assert (eql (var 'a
) 2))))))
514 `(sb-int:named-lambda test
()
515 (declare (optimize debug
))
524 (assert (= count
3))))
526 (with-test (:name
:indirect-closure-values
.2)
529 (handler-bind ((error (lambda (c)
531 (sb-debug::map-backtrace
533 (let ((sb-debug::*current-frame
* frame
)
534 (name (sb-debug::frame-call frame
)))
535 (when (or (eq name
'test
)
537 (or (eql (search '(labels f1
) name
) 0)
538 (eql (search '(labels f2
) name
) 0))))
540 (assert (eql (var 'a
) 65535))))))
544 `(sb-int:named-lambda test
()
545 (declare (optimize debug
))
546 (let ((a (return-65535)))
547 (declare ((unsigned-byte 16) a
))
555 (assert (= count
3))))
557 (with-test (:name
:non-tail-self-call-bad-variables
)
560 (handler-bind ((error (lambda (c)
562 (sb-debug::map-backtrace
564 (let ((sb-debug::*current-frame
* frame
))
565 (multiple-value-bind (name args
)
566 (sb-debug::frame-call frame
)
567 (when (eq name
'test
)
568 (assert (or (null args
)
569 (equal args
'(nil))))
573 (compile nil
`(sb-int:named-lambda test
(&optional x
)
574 (declare (optimize sb-c
::recognize-self-calls
))
575 (signal 'error
:format-control
"~a" :format-arguments
(list x
))
578 (assert (= count
1))))
580 (with-test (:name
:local-tail-call-variables
)
583 (handler-bind ((error (lambda (c)
585 (sb-debug::map-backtrace
587 (let ((sb-debug::*current-frame
* frame
))
588 (multiple-value-bind (name args
)
589 (sb-debug::frame-call frame
)
590 (when (eq name
'test
)
591 (assert (equal args
'(error)))
595 (compile nil
`(sb-int:named-lambda test
(x)
597 ;; If :local-tail-call fails, this will fail
598 ;; too, because there's no jump between
599 ;; SIGNAL and the call to TAIL and it will
600 ;; show (flet tail) in the backtrace.
602 (declare (notinline tail
))
605 (assert (= count
1))))
607 (with-test (:name
:variables-surrounding-inlined-code
)
610 (handler-bind ((error (lambda (c)
612 (sb-debug::map-backtrace
614 (let ((sb-debug::*current-frame
* frame
))
615 (multiple-value-bind (name)
616 (sb-debug::frame-call frame
)
617 (when (eq name
'test
)
618 (assert (equal (sb-debug:var
'l
) '(1 2 3)))
622 (compile nil
`(sb-int:named-lambda test
(a i
)
623 (declare (optimize (debug 3)))
624 (let ((l (list 1 2 3)))
628 (assert (= count
1))))
630 (with-test (:name
:variables-surrounding-inlined-code
.2)
633 (handler-bind ((error (lambda (c)
635 (sb-debug::map-backtrace
637 (let ((sb-debug::*current-frame
* frame
))
638 (multiple-value-bind (name)
639 (sb-debug::frame-call frame
)
640 (when (eq name
'test
)
641 (assert (equal (sb-debug:var
'l
) '(1 2 3)))
645 (compile nil
`(sb-int:named-lambda test
(c)
646 (declare (optimize (debug 3)))
647 (let ((l (list 1 2 3)))
648 (map 'list
#'signal c
)
651 (assert (= count
1))))