3 ;;;; This software is part of the SBCL system. See the README file for
6 ;;;; This software is derived from the CMU CL system, which was
7 ;;;; written at Carnegie Mellon University and released into the
8 ;;;; public domain. The software is in the public domain and is
9 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
10 ;;;; files for more information.
12 (in-package "SB!DEBUG")
14 ;;;; variables and constants
16 ;;; things to consider when tweaking these values:
17 ;;; * We're afraid to just default them to NIL and NIL, in case the
18 ;;; user inadvertently causes a hairy data structure to be printed
19 ;;; when he inadvertently enters the debugger.
20 ;;; * We don't want to truncate output too much. These days anyone
21 ;;; can easily run their Lisp in a windowing system or under Emacs,
22 ;;; so it's not the end of the world even if the worst case is a
23 ;;; few thousand lines of output.
24 ;;; * As condition :REPORT methods are converted to use the pretty
25 ;;; printer, they acquire *PRINT-LEVEL* constraints, so e.g. under
26 ;;; sbcl-0.7.1.28's old value of *DEBUG-PRINT-LEVEL*=3, an
27 ;;; ARG-COUNT-ERROR printed as
28 ;;; error while parsing arguments to DESTRUCTURING-BIND:
29 ;;; invalid number of elements in
31 ;;; to satisfy lambda list
33 ;;; exactly 2 expected, but 5 found
34 (defvar *debug-print-level* 5
36 "*PRINT-LEVEL* for the debugger")
37 (defvar *debug-print-length* 7
39 "*PRINT-LENGTH* for the debugger")
41 (defvar *debug-readtable*
42 ;; KLUDGE: This can't be initialized in a cold toplevel form,
43 ;; because the *STANDARD-READTABLE* isn't initialized until after
44 ;; cold toplevel forms have run. So instead we initialize it
45 ;; immediately after *STANDARD-READTABLE*. -- WHN 20000205
48 "*READTABLE* for the debugger")
50 (defvar *in-the-debugger* nil
52 "This is T while in the debugger.")
54 ;;; nestedness inside debugger command loops
55 (defvar *debug-command-level* 0)
57 ;;; If this is bound before the debugger is invoked, it is used as the
58 ;;; stack top by the debugger.
59 (defvar *stack-top-hint* nil)
61 (defvar *stack-top* nil)
62 (defvar *real-stack-top* nil)
64 (defvar *current-frame* nil)
66 ;;; Beginner-oriented help messages are important because you end up
67 ;;; in the debugger whenever something bad happens, or if you try to
68 ;;; get out of the system with Ctrl-C or (EXIT) or EXIT or whatever.
69 ;;; But after memorizing them the wasted screen space gets annoying..
70 (defvar *debug-beginner-help-p* t
71 "Should the debugger display beginner-oriented help messages?")
73 (defun debug-prompt (stream)
74 (sb!thread::get-foreground)
77 (sb!di:frame-number *current-frame*)
78 (> *debug-command-level* 1)
79 *debug-command-level*))
81 (defparameter *debug-help-string*
82 "The debug prompt is square brackets, with number(s) indicating the current
83 control stack level and, if you've entered the debugger recursively, how
84 deeply recursed you are.
85 Any command -- including the name of a restart -- may be uniquely abbreviated.
86 The debugger rebinds various special variables for controlling i/o, sometimes
87 to defaults (much like WITH-STANDARD-IO-SYNTAX does) and sometimes to
88 its own special values, e.g. SB-DEBUG:*DEBUG-PRINT-LEVEL*.
89 Debug commands do not affect *, //, and similar variables, but evaluation in
90 the debug loop does affect these variables.
91 SB-DEBUG:*FLUSH-DEBUG-ERRORS* controls whether errors at the debug prompt
92 drop you deeper into the debugger.
94 Getting in and out of the debugger:
95 RESTART invokes restart numbered as shown (prompt if not given).
96 ERROR prints the error condition and restart cases.
97 The number of any restart, or its name, or a unique abbreviation for its
98 name, is a valid command, and is the same as using RESTART to invoke
102 U up frame D down frame
103 B bottom frame F n frame n (n=0 for top frame)
106 BACKTRACE [n] shows n frames going down the stack.
107 LIST-LOCALS, L lists locals in current function.
108 PRINT, P displays current function call.
109 SOURCE [n] displays frame's source form with n levels of enclosing forms.
111 Breakpoints and steps:
112 LIST-LOCATIONS [{function | :C}] List the locations for breakpoints.
113 Specify :C for the current frame.
115 LIST-BREAKPOINTS List the active breakpoints.
116 Abbreviations: LB, LBP
117 DELETE-BREAKPOINT [n] Remove breakpoint n or all breakpoints.
118 Abbreviations: DEL, DBP
119 BREAKPOINT {n | :end | :start} [:break form] [:function function]
120 [{:print form}*] [:condition form]
122 Abbreviations: BR, BP
123 STEP [n] Step to the next location or step n times.
125 Function and macro commands:
127 Return the n'th argument in the current frame.
128 (SB-DEBUG:VAR string-or-symbol [id])
129 Returns the value of the specified variable in the current frame.
133 [EXPERIMENTAL] Return the values resulting from evaluation of expr
134 from the current frame, if this frame was compiled with a sufficiently
135 high DEBUG optimization quality.
137 Discard all pending input on *STANDARD-INPUT*. (This can be
138 useful when the debugger was invoked to handle an error in
139 deeply nested input syntax, and now the reader is confused.)")
141 ;;; This is used to communicate to DEBUG-LOOP that we are at a step breakpoint.
142 (define-condition step-condition (simple-condition) ())
144 ;;;; breakpoint state
146 (defvar *only-block-start-locations* nil
148 "When true, the LIST-LOCATIONS command only displays block start locations.
149 Otherwise, all locations are displayed.")
151 (defvar *print-location-kind* nil
153 "When true, list the code location type in the LIST-LOCATIONS command.")
155 ;;; a list of the types of code-locations that should not be stepped
156 ;;; to and should not be listed when listing breakpoints
157 (defvar *bad-code-location-types* '(:call-site :internal-error))
158 (declaim (type list *bad-code-location-types*))
160 ;;; code locations of the possible breakpoints
161 (defvar *possible-breakpoints*)
162 (declaim (type list *possible-breakpoints*))
164 ;;; a list of the made and active breakpoints, each is a
165 ;;; BREAKPOINT-INFO structure
166 (defvar *breakpoints* nil)
167 (declaim (type list *breakpoints*))
169 ;;; a list of BREAKPOINT-INFO structures of the made and active step
171 (defvar *step-breakpoints* nil)
172 (declaim (type list *step-breakpoints*))
174 ;;; the number of times left to step
175 (defvar *number-of-steps* 1)
176 (declaim (type integer *number-of-steps*))
178 ;;; This is used when listing and setting breakpoints.
179 (defvar *default-breakpoint-debug-fun* nil)
180 (declaim (type (or list sb!di:debug-fun) *default-breakpoint-debug-fun*))
182 ;;;; code location utilities
184 ;;; Return the first code-location in the passed debug block.
185 (defun first-code-location (debug-block)
187 (first-code-location nil))
188 (sb!di:do-debug-block-locations (code-location debug-block)
190 (setf first-code-location code-location)
192 first-code-location))
194 ;;; Return a list of the next code-locations following the one passed.
195 ;;; One of the *BAD-CODE-LOCATION-TYPES* will not be returned.
196 (defun next-code-locations (code-location)
197 (let ((debug-block (sb!di:code-location-debug-block code-location))
198 (block-code-locations nil))
199 (sb!di:do-debug-block-locations (block-code-location debug-block)
200 (unless (member (sb!di:code-location-kind block-code-location)
201 *bad-code-location-types*)
202 (push block-code-location block-code-locations)))
203 (setf block-code-locations (nreverse block-code-locations))
204 (let* ((code-loc-list (rest (member code-location block-code-locations
205 :test #'sb!di:code-location=)))
206 (next-list (cond (code-loc-list
207 (list (first code-loc-list)))
208 ((map 'list #'first-code-location
209 (sb!di:debug-block-successors debug-block)))
211 (when (and (= (length next-list) 1)
212 (sb!di:code-location= (first next-list) code-location))
213 (setf next-list (next-code-locations (first next-list))))
216 ;;; Return a list of code-locations of the possible breakpoints of DEBUG-FUN.
217 (defun possible-breakpoints (debug-fun)
218 (let ((possible-breakpoints nil))
219 (sb!di:do-debug-fun-blocks (debug-block debug-fun)
220 (unless (sb!di:debug-block-elsewhere-p debug-block)
221 (if *only-block-start-locations*
222 (push (first-code-location debug-block) possible-breakpoints)
223 (sb!di:do-debug-block-locations (code-location debug-block)
224 (when (not (member (sb!di:code-location-kind code-location)
225 *bad-code-location-types*))
226 (push code-location possible-breakpoints))))))
227 (nreverse possible-breakpoints)))
229 ;;; Search the info-list for the item passed (CODE-LOCATION,
230 ;;; DEBUG-FUN, or BREAKPOINT-INFO). If the item passed is a debug
231 ;;; function then kind will be compared if it was specified. The kind
232 ;;; if also compared if a breakpoint-info is passed since it's in the
233 ;;; breakpoint. The info structure is returned if found.
234 (defun location-in-list (place info-list &optional (kind nil))
235 (when (breakpoint-info-p place)
236 (setf kind (sb!di:breakpoint-kind (breakpoint-info-breakpoint place)))
237 (setf place (breakpoint-info-place place)))
238 (cond ((sb!di:code-location-p place)
239 (find place info-list
240 :key #'breakpoint-info-place
241 :test (lambda (x y) (and (sb!di:code-location-p y)
242 (sb!di:code-location= x y)))))
244 (find place info-list
245 :test (lambda (x-debug-fun y-info)
246 (let ((y-place (breakpoint-info-place y-info))
247 (y-breakpoint (breakpoint-info-breakpoint
249 (and (sb!di:debug-fun-p y-place)
250 (eq x-debug-fun y-place)
252 (eq kind (sb!di:breakpoint-kind
253 y-breakpoint))))))))))
255 ;;; If LOC is an unknown location, then try to find the block start
256 ;;; location. Used by source printing to some information instead of
257 ;;; none for the user.
258 (defun maybe-block-start-location (loc)
259 (if (sb!di:code-location-unknown-p loc)
260 (let* ((block (sb!di:code-location-debug-block loc))
261 (start (sb!di:do-debug-block-locations (loc block)
263 (cond ((and (not (sb!di:debug-block-elsewhere-p block))
265 ;; FIXME: Why output on T instead of *DEBUG-FOO* or something?
266 (format t "~%unknown location: using block start~%")
272 ;;;; the BREAKPOINT-INFO structure
274 ;;; info about a made breakpoint
275 (defstruct (breakpoint-info (:copier nil)
276 (:constructor %make-breakpoint-info))
277 ;; where we are going to stop
279 :type (or sb!di:code-location sb!di:debug-fun)
281 ;; the breakpoint returned by SB!DI:MAKE-BREAKPOINT
282 (breakpoint (missing-arg) :type sb!di:breakpoint :read-only t)
283 ;; the function returned from SB!DI:PREPROCESS-FOR-EVAL. If result is
284 ;; non-NIL, drop into the debugger.
285 (break #'identity :type function :read-only t)
286 ;; the function returned from SB!DI:PREPROCESS-FOR-EVAL. If result is
287 ;; non-NIL, eval (each) print and print results.
288 (condition #'identity :type function :read-only t)
289 ;; the list of functions from SB!DI:PREPROCESS-FOR-EVAL to evaluate.
290 ;; Results are conditionally printed. CAR of each element is the
291 ;; function, CDR is the form it goes with.
292 (print nil :type list :read-only t)
293 ;; the number used when listing the possible breakpoints within a
294 ;; function; or could also be a symbol such as START or END
295 (code-location-selector (missing-arg) :type (or symbol integer) :read-only t)
296 ;; the number used when listing the active breakpoints, and when
297 ;; deleting breakpoints
298 (breakpoint-number (missing-arg) :type integer :read-only t))
300 (defun create-breakpoint-info (place breakpoint code-location-selector
301 &key (break #'identity)
302 (condition #'identity) (print nil))
304 (sort *breakpoints* #'< :key #'breakpoint-info-breakpoint-number))
305 (let ((breakpoint-number
306 (do ((i 1 (incf i)) (breakpoints *breakpoints* (rest breakpoints)))
307 ((or (> i (length *breakpoints*))
308 (not (= i (breakpoint-info-breakpoint-number
309 (first breakpoints)))))
312 (%make-breakpoint-info :place place
313 :breakpoint breakpoint
314 :code-location-selector code-location-selector
315 :breakpoint-number breakpoint-number
320 (defun print-breakpoint-info (breakpoint-info)
321 (let ((place (breakpoint-info-place breakpoint-info))
322 (bp-number (breakpoint-info-breakpoint-number breakpoint-info)))
323 (case (sb!di:breakpoint-kind (breakpoint-info-breakpoint breakpoint-info))
325 (print-code-location-source-form place 0)
329 (breakpoint-info-code-location-selector breakpoint-info)
330 (sb!di:debug-fun-name (sb!di:code-location-debug-fun place))))
332 (format t "~&~S: FUN-START in ~S" bp-number
333 (sb!di:debug-fun-name place)))
335 (format t "~&~S: FUN-END in ~S" bp-number
336 (sb!di:debug-fun-name place))))))
338 ;;;; MAIN-HOOK-FUN for steps and breakpoints
340 ;;; This must be passed as the hook function. It keeps track of where
341 ;;; STEP breakpoints are.
342 (defun main-hook-fun (current-frame breakpoint &optional return-vals
344 (setf *default-breakpoint-debug-fun*
345 (sb!di:frame-debug-fun current-frame))
346 (dolist (step-info *step-breakpoints*)
347 (sb!di:delete-breakpoint (breakpoint-info-breakpoint step-info))
348 (let ((bp-info (location-in-list step-info *breakpoints*)))
350 (sb!di:activate-breakpoint (breakpoint-info-breakpoint bp-info)))))
351 (let ((*stack-top-hint* current-frame)
353 (location-in-list (sb!di:breakpoint-what breakpoint)
355 (sb!di:breakpoint-kind breakpoint)))
357 (location-in-list (sb!di:breakpoint-what breakpoint)
359 (sb!di:breakpoint-kind breakpoint)))
363 (setf *step-breakpoints* nil)
364 (labels ((build-string (str)
365 (setf string (concatenate 'string string str)))
366 (print-common-info ()
368 (with-output-to-string (*standard-output*)
370 (format t "~%Return values: ~S" return-vals))
372 (when (breakpoint-info-print bp-hit-info)
374 (print-frame-call current-frame))
375 (dolist (print (breakpoint-info-print bp-hit-info))
376 (format t "~& ~S = ~S" (rest print)
377 (funcall (first print) current-frame))))))))
379 (setf break (funcall (breakpoint-info-break bp-hit-info)
381 (setf condition (funcall (breakpoint-info-condition bp-hit-info)
383 (cond ((and bp-hit-info step-hit-info (= 1 *number-of-steps*))
384 (build-string (format nil "~&*Step (to a breakpoint)*"))
387 ((and bp-hit-info step-hit-info break)
388 (build-string (format nil "~&*Step (to a breakpoint)*"))
391 ((and bp-hit-info step-hit-info)
393 (format t "~A" string)
394 (decf *number-of-steps*)
395 (set-step-breakpoint current-frame))
396 ((and step-hit-info (= 1 *number-of-steps*))
397 (build-string "*Step*")
398 (break (make-condition 'step-condition :format-control string)))
400 (decf *number-of-steps*)
401 (set-step-breakpoint current-frame))
404 (build-string (format nil "~&*Breakpoint hit*")))
408 (format t "~A" string)))
410 (break "unknown breakpoint"))))))
412 ;;; Set breakpoints at the next possible code-locations. After calling
413 ;;; this, either (CONTINUE) if in the debugger or just let program flow
414 ;;; return if in a hook function.
415 (defun set-step-breakpoint (frame)
417 ((sb!di:debug-block-elsewhere-p (sb!di:code-location-debug-block
418 (sb!di:frame-code-location frame)))
419 ;; FIXME: FORMAT T is used for error output here and elsewhere in
421 (format t "cannot step, in elsewhere code~%"))
423 (let* ((code-location (sb!di:frame-code-location frame))
424 (next-code-locations (next-code-locations code-location)))
427 (dolist (code-location next-code-locations)
428 (let ((bp-info (location-in-list code-location *breakpoints*)))
430 (sb!di:deactivate-breakpoint (breakpoint-info-breakpoint
432 (let ((bp (sb!di:make-breakpoint #'main-hook-fun code-location
433 :kind :code-location)))
434 (sb!di:activate-breakpoint bp)
435 (push (create-breakpoint-info code-location bp 0)
436 *step-breakpoints*))))
438 (let* ((debug-fun (sb!di:frame-debug-fun *current-frame*))
439 (bp (sb!di:make-breakpoint #'main-hook-fun debug-fun
441 (sb!di:activate-breakpoint bp)
442 (push (create-breakpoint-info debug-fun bp 0)
443 *step-breakpoints*))))))))
447 ;;; ANSI specifies that this macro shall exist, even if only as a
448 ;;; trivial placeholder like this.
449 (defmacro step (form)
450 "This is a trivial placeholder implementation of the CL:STEP macro required
451 by the ANSI spec, simply expanding to `(LET () ,FORM). A more featureful
452 version would be welcome, we just haven't written it."
458 (defun backtrace (&optional (count most-positive-fixnum)
459 (*standard-output* *debug-io*))
461 "Show a listing of the call stack going down from the current frame. In the
462 debugger, the current frame is indicated by the prompt. COUNT is how many
464 (fresh-line *standard-output*)
465 (do ((frame (if *in-the-debugger* *current-frame* (sb!di:top-frame))
466 (sb!di:frame-down frame))
467 (count count (1- count)))
468 ((or (null frame) (zerop count)))
469 (print-frame-call frame :number t))
470 (fresh-line *standard-output*)
473 (defun backtrace-as-list (&optional (count most-positive-fixnum))
474 #!+sb-doc "Return a list representing the current BACKTRACE."
475 (do ((reversed-result nil)
476 (frame (if *in-the-debugger* *current-frame* (sb!di:top-frame))
477 (sb!di:frame-down frame))
478 (count count (1- count)))
479 ((or (null frame) (zerop count))
480 (nreverse reversed-result))
481 (push (frame-call-as-list frame) reversed-result)))
483 (defun frame-call-as-list (frame)
484 (cons (sb!di:debug-fun-name (sb!di:frame-debug-fun frame))
485 (frame-args-as-list frame)))
489 (eval-when (:compile-toplevel :execute)
491 ;;; This is a convenient way to express what to do for each type of
492 ;;; lambda-list element.
493 (sb!xc:defmacro lambda-list-element-dispatch (element
504 (ecase (car ,element)
505 (:optional ,@optional)
507 (:keyword ,@keyword)))
509 (aver (eq ,element :deleted))
512 (sb!xc:defmacro lambda-var-dispatch (variable location deleted valid other)
513 (let ((var (gensym)))
514 `(let ((,var ,variable))
515 (cond ((eq ,var :deleted) ,deleted)
516 ((eq (sb!di:debug-var-validity ,var ,location) :valid)
522 ;;; This is used in constructing arg lists for debugger printing when
523 ;;; the arg list is unavailable, some arg is unavailable or unused, etc.
524 (defstruct (unprintable-object
525 (:constructor make-unprintable-object (string))
526 (:print-object (lambda (x s)
527 (print-unreadable-object (x s)
528 (write-string (unprintable-object-string x)
533 ;;; Extract the function argument values for a debug frame.
534 (defun frame-args-as-list (frame)
535 (let ((debug-fun (sb!di:frame-debug-fun frame))
536 (loc (sb!di:frame-code-location frame))
537 (reversed-result nil))
540 (dolist (ele (sb!di:debug-fun-lambda-list debug-fun))
541 (lambda-list-element-dispatch ele
542 :required ((push (frame-call-arg ele loc frame) reversed-result))
543 :optional ((push (frame-call-arg (second ele) loc frame)
545 :keyword ((push (second ele) reversed-result)
546 (push (frame-call-arg (third ele) loc frame)
548 :deleted ((push (frame-call-arg ele loc frame) reversed-result))
549 :rest ((lambda-var-dispatch (second ele) loc
552 (setf reversed-result
553 (append (reverse (sb!di:debug-var-value
557 (push (make-unprintable-object
558 "unavailable &REST argument")
560 ;; As long as we do an ordinary return (as opposed to SIGNALing
561 ;; a CONDITION) from the DOLIST above:
562 (nreverse reversed-result))
563 (sb!di:lambda-list-unavailable
565 (make-unprintable-object "unavailable lambda list")))))
567 ;;; Print FRAME with verbosity level 1. If we hit a &REST arg, then
568 ;;; print as many of the values as possible, punting the loop over
569 ;;; lambda-list variables since any other arguments will be in the
570 ;;; &REST arg's list of values.
571 (defun print-frame-call-1 (frame)
572 (let ((debug-fun (sb!di:frame-debug-fun frame)))
574 (pprint-logical-block (*standard-output* nil :prefix "(" :suffix ")")
575 (let ((args (ensure-printable-object (frame-args-as-list frame))))
576 ;; Since we go to some trouble to make nice informative function
577 ;; names like (PRINT-OBJECT :AROUND (CLOWN T)), let's make sure
578 ;; that they aren't truncated by *PRINT-LENGTH* and *PRINT-LEVEL*.
579 (let ((*print-length* nil)
581 (prin1 (ensure-printable-object (sb!di:debug-fun-name debug-fun))))
582 ;; For the function arguments, we can just print normally.
584 (format t "~{ ~_~S~}" args)
585 (format t " ~S" args))))
587 (when (sb!di:debug-fun-kind debug-fun)
589 (prin1 (sb!di:debug-fun-kind debug-fun))
592 (defun ensure-printable-object (object)
594 (with-open-stream (out (make-broadcast-stream))
598 (declare (ignore cond))
599 (make-unprintable-object "error printing object"))))
601 (defun frame-call-arg (var location frame)
602 (lambda-var-dispatch var location
603 (make-unprintable-object "unused argument")
604 (sb!di:debug-var-value var frame)
605 (make-unprintable-object "unavailable argument")))
607 ;;; Prints a representation of the function call causing FRAME to
608 ;;; exist. VERBOSITY indicates the level of information to output;
609 ;;; zero indicates just printing the DEBUG-FUN's name, and one
610 ;;; indicates displaying call-like, one-liner format with argument
612 (defun print-frame-call (frame &key (verbosity 1) (number nil))
616 (format t "~&~S: " (sb!di:frame-number frame)))
617 (format t "~S" frame))
620 (format t "~&~S: " (sb!di:frame-number frame)))
621 (print-frame-call-1 frame)))
622 (when (>= verbosity 2)
623 (let ((loc (sb!di:frame-code-location frame)))
626 (sb!di:code-location-debug-block loc)
627 (format t "~%source: ")
628 (print-code-location-source-form loc 0))
629 (sb!di:debug-condition (ignore) ignore)
630 (error (c) (format t "error finding source: ~A" c))))))
634 (defvar *debugger-hook* nil
636 "This is either NIL or a function of two arguments, a condition and the value
637 of *DEBUGGER-HOOK*. This function can either handle the condition or return
638 which causes the standard debugger to execute. The system passes the value
639 of this variable to the function because it binds *DEBUGGER-HOOK* to NIL
640 around the invocation.")
642 ;;; These are bound on each invocation of INVOKE-DEBUGGER.
643 (defvar *debug-restarts*)
644 (defvar *debug-condition*)
645 (defvar *nested-debug-condition*)
647 (defun invoke-debugger (condition)
649 "Enter the debugger."
650 (let ((old-hook *debugger-hook*))
652 (let ((*debugger-hook* nil))
653 (funcall old-hook condition old-hook))))
655 ;; If we're a background thread and *background-threads-wait-for-debugger*
656 ;; is NIL, this will invoke a restart
658 ;; Note: CMU CL had (SB-UNIX:UNIX-SIGSETMASK 0) here. I deleted it
659 ;; around sbcl-0.7.8.5 (by which time it had mutated to have a
660 ;; #!-SUNOS prefix and a FIXME note observing that it wasn't needed
661 ;; on SunOS and no one knew why it was needed anywhere else either).
662 ;; So if something mysteriously breaks that has worked since the CMU
663 ;; CL days, that might be why. -- WHN 2002-09-28
665 ;; We definitely want *PACKAGE* to be of valid type.
667 ;; Elsewhere in the system, we use the SANE-PACKAGE function for
668 ;; this, but here causing an exception just as we're trying to handle
669 ;; an exception would be confusing, so instead we use a special hack.
670 (unless (and (packagep *package*)
671 (package-name *package*))
672 (setf *package* (find-package :cl-user))
673 (format *error-output*
674 "The value of ~S was not an undeleted PACKAGE. It has been
676 '*package* *package*))
678 ;; Try to force the other special variables into a useful state.
679 (let (;; Protect from WITH-STANDARD-IO-SYNTAX some variables where
680 ;; any default we might use is less useful than just reusing
681 ;; the global values.
682 (original-package *package*)
683 (original-print-pretty *print-pretty*))
684 (with-standard-io-syntax
685 (let ((*debug-condition* condition)
686 (*debug-restarts* (compute-restarts condition))
687 (*nested-debug-condition* nil)
688 ;; We want the printer and reader to be in a useful state,
689 ;; regardless of where the debugger was invoked in the
690 ;; program. WITH-STANDARD-IO-SYNTAX did much of what we
692 ;; * It doesn't affect our internal special variables
693 ;; like *CURRENT-LEVEL-IN-PRINT*.
694 ;; * It isn't customizable.
695 ;; * It doesn't set *PRINT-READABLY* to the same value
696 ;; as the toplevel default.
697 ;; * It sets *PACKAGE* to COMMON-LISP-USER, which is not
698 ;; helpful behavior for a debugger.
699 ;; * There's no particularly good debugger default for
700 ;; *PRINT-PRETTY*, since T is usually what you want
701 ;; -- except absolutely not what you want when you're
702 ;; debugging failures in PRINT-OBJECT logic.
703 ;; We try to address all these issues with explicit
705 (sb!kernel:*current-level-in-print* 0)
706 (*print-length* *debug-print-length*)
707 (*print-level* *debug-print-level*)
708 (*readtable* *debug-readtable*)
709 (*print-readably* nil)
710 (*package* original-package)
712 (*print-pretty* original-print-pretty))
714 ;; Before we start our own output, finish any pending output.
715 ;; Otherwise, if the user tried to track the progress of his
716 ;; program using PRINT statements, he'd tend to lose the last
717 ;; line of output or so, which'd be confusing.
718 (flush-standard-output-streams)
720 ;; (The initial output here goes to *ERROR-OUTPUT*, because the
721 ;; initial output is not interactive, just an error message,
722 ;; and when people redirect *ERROR-OUTPUT*, they could
723 ;; reasonably expect to see error messages logged there,
724 ;; regardless of what the debugger does afterwards.)
726 (format *error-output*
727 "~2&~@<debugger invoked on condition of type ~S: ~
729 (type-of *debug-condition*)
732 (setf *nested-debug-condition* condition)
733 (let ((ndc-type (type-of *nested-debug-condition*)))
734 (format *error-output*
735 "~&~@<(A ~S was caught when trying to print ~S when ~
736 entering the debugger. Printing was aborted and the ~
737 ~S was stored in ~S.)~@:>~%"
741 '*nested-debug-condition*))
742 (when (typep condition 'cell-error)
743 ;; what we really want to know when it's e.g. an UNBOUND-VARIABLE:
744 (format *error-output*
745 "~&(CELL-ERROR-NAME ~S) = ~S~%"
747 (cell-error-name *debug-condition*)))))
749 ;; After the initial error/condition/whatever announcement to
750 ;; *ERROR-OUTPUT*, we become interactive, and should talk on
751 ;; *DEBUG-IO* from now on. (KLUDGE: This is a normative
752 ;; statement, not a description of reality.:-| There's a lot of
753 ;; older debugger code which was written to do i/o on whatever
754 ;; stream was in fashion at the time, and not all of it has
755 ;; been converted to behave this way. -- WHN 2000-11-16)
758 (sb!thread::debugger-wait-until-foreground-thread *debug-io*))
760 (let (;; FIXME: Rebinding *STANDARD-OUTPUT* here seems wrong,
761 ;; violating the principle of least surprise, and making
762 ;; it impossible for the user to do reasonable things
763 ;; like using PRINT at the debugger prompt to send output
764 ;; to the program's ordinary (possibly
765 ;; redirected-to-a-file) *STANDARD-OUTPUT*. (CMU CL
766 ;; used to rebind *STANDARD-INPUT* here too, but that's
767 ;; been fixed already.)
768 (*standard-output* *debug-io*)
769 ;; This seems reasonable: e.g. if the user has redirected
770 ;; *ERROR-OUTPUT* to some log file, it's probably wrong
771 ;; to send errors which occur in interactive debugging to
772 ;; that file, and right to send them to *DEBUG-IO*.
773 (*error-output* *debug-io*))
774 (unless (typep condition 'step-condition)
775 (when *debug-beginner-help-p*
777 "~%~@<Within the debugger, you can type HELP for help. ~
778 At any command prompt (within the debugger or not) you ~
779 can type (SB-EXT:QUIT) to terminate the SBCL ~
780 executable. The condition which caused the debugger to ~
781 be entered is bound to ~S. You can suppress this ~
782 message by clearing ~S.~:@>~2%"
784 '*debug-beginner-help-p*))
785 (show-restarts *debug-restarts* *debug-io*))
787 (when background-p (sb!thread::release-foreground)))))))
789 (defun show-restarts (restarts s)
790 (cond ((null restarts)
792 "~&(no restarts: If you didn't do this on purpose, ~
793 please report it as a bug.)~%"))
795 (format s "~&restarts (invokable by number or by ~
796 possibly-abbreviated name):~%")
800 (dolist (restart restarts)
801 (let ((name (restart-name restart)))
803 (let ((len (length (princ-to-string name))))
804 (when (> len max-name-len)
805 (setf max-name-len len))))))
806 (unless (zerop max-name-len)
807 (incf max-name-len 3))
808 (dolist (restart restarts)
809 (let ((name (restart-name restart)))
810 (cond ((member name names-used)
811 (format s "~& ~2D: ~V@T~A~%" count max-name-len restart))
813 (format s "~& ~2D: [~VA] ~A~%"
814 count (- max-name-len 3) name restart)
815 (push name names-used))))
818 ;;; This calls DEBUG-LOOP, performing some simple initializations
819 ;;; before doing so. INVOKE-DEBUGGER calls this to actually get into
820 ;;; the debugger. SB!KERNEL::ERROR-ERROR calls this in emergencies
821 ;;; to get into a debug prompt as quickly as possible with as little
822 ;;; risk as possible for stepping on whatever is causing recursive
824 (defun internal-debug ()
825 (let ((*in-the-debugger* t)
826 (*read-suppress* nil))
827 (unless (typep *debug-condition* 'step-condition)
828 (clear-input *debug-io*))
829 (funcall *debug-loop-fun*)))
833 ;;; Note: This defaulted to T in CMU CL. The changed default in SBCL
834 ;;; was motivated by desire to play nicely with ILISP.
835 (defvar *flush-debug-errors* nil
837 "When set, avoid calling INVOKE-DEBUGGER recursively when errors occur while
838 executing in the debugger.")
840 (defun debug-loop-fun ()
841 (let* ((*debug-command-level* (1+ *debug-command-level*))
842 (*real-stack-top* (sb!di:top-frame))
843 (*stack-top* (or *stack-top-hint* *real-stack-top*))
844 (*stack-top-hint* nil)
845 (*current-frame* *stack-top*))
846 (handler-bind ((sb!di:debug-condition
848 (princ condition *debug-io*)
849 (/show0 "handling d-c by THROWing DEBUG-LOOP-CATCHER")
850 (throw 'debug-loop-catcher nil))))
852 (print-frame-call *current-frame* :verbosity 2)
854 (catch 'debug-loop-catcher
855 (handler-bind ((error (lambda (condition)
856 (when *flush-debug-errors*
857 (clear-input *debug-io*)
859 ;; FIXME: Doing input on *DEBUG-IO*
860 ;; and output on T seems broken.
862 "~&error flushed (because ~
864 '*flush-debug-errors*)
865 (/show0 "throwing DEBUG-LOOP-CATCHER")
866 (throw 'debug-loop-catcher nil)))))
867 ;; We have to bind LEVEL for the restart function created by
868 ;; WITH-SIMPLE-RESTART.
869 (let ((level *debug-command-level*)
870 (restart-commands (make-restart-commands)))
871 (with-simple-restart (abort
872 "~@<Reduce debugger level (to debug level ~W).~@:>"
874 (debug-prompt *debug-io*)
875 (force-output *debug-io*)
876 (let* ((exp (read *debug-io*))
877 (cmd-fun (debug-command-p exp restart-commands)))
879 (debug-eval-print exp))
881 (format t "~&Your command, ~S, is ambiguous:~%"
883 (dolist (ele cmd-fun)
884 (format t " ~A~%" ele)))
886 (funcall cmd-fun))))))))))))
888 (defvar *debug-loop-fun* #'debug-loop-fun
889 "a function taking no parameters that starts the low-level debug loop")
891 ;;; FIXME: We could probably use INTERACTIVE-EVAL for much of this logic.
892 (defun debug-eval-print (expr)
893 (/noshow "entering DEBUG-EVAL-PRINT" expr)
894 (/noshow (fboundp 'compile))
895 (setq +++ ++ ++ + + - - expr)
896 (let* ((values (multiple-value-list (eval -)))
897 (*standard-output* *debug-io*))
898 (/noshow "done with EVAL in DEBUG-EVAL-PRINT")
900 (if values (prin1 (car values)))
901 (dolist (x (cdr values))
904 (setq /// // // / / values)
905 (setq *** ** ** * * (car values))
906 ;; Make sure that nobody passes back an unbound marker.
910 ;; FIXME: The way INTERACTIVE-EVAL does this seems better.
911 (princ "Setting * to NIL (was unbound marker)."))))
913 ;;;; debug loop functions
915 ;;; These commands are functions, not really commands, so that users
916 ;;; can get their hands on the values returned.
918 (eval-when (:execute :compile-toplevel)
920 (sb!xc:defmacro define-var-operation (ref-or-set &optional value-var)
921 `(let* ((temp (etypecase name
922 (symbol (sb!di:debug-fun-symbol-vars
923 (sb!di:frame-debug-fun *current-frame*)
925 (simple-string (sb!di:ambiguous-debug-vars
926 (sb!di:frame-debug-fun *current-frame*)
928 (location (sb!di:frame-code-location *current-frame*))
929 ;; Let's only deal with valid variables.
930 (vars (remove-if-not (lambda (v)
931 (eq (sb!di:debug-var-validity v location)
934 (declare (list vars))
936 (error "No known valid variables match ~S." name))
940 '(sb!di:debug-var-value (car vars) *current-frame*))
942 `(setf (sb!di:debug-var-value (car vars) *current-frame*)
945 ;; Since we have more than one, first see whether we have
946 ;; any variables that exactly match the specification.
947 (let* ((name (etypecase name
948 (symbol (symbol-name name))
949 (simple-string name)))
950 ;; FIXME: REMOVE-IF-NOT is deprecated, use STRING/=
952 (exact (remove-if-not (lambda (v)
953 (string= (sb!di:debug-var-symbol-name v)
956 (vars (or exact vars)))
957 (declare (simple-string name)
960 ;; Check now for only having one variable.
964 '(sb!di:debug-var-value (car vars) *current-frame*))
966 `(setf (sb!di:debug-var-value (car vars) *current-frame*)
968 ;; If there weren't any exact matches, flame about
969 ;; ambiguity unless all the variables have the same
974 (string= (sb!di:debug-var-symbol-name v)
975 (sb!di:debug-var-symbol-name (car vars))))
977 (error "specification ambiguous:~%~{ ~A~%~}"
978 (mapcar #'sb!di:debug-var-symbol-name
981 :key #'sb!di:debug-var-symbol-name))))
982 ;; All names are the same, so see whether the user
983 ;; ID'ed one of them.
985 (let ((v (find id vars :key #'sb!di:debug-var-id)))
988 "invalid variable ID, ~W: should have been one of ~S"
990 (mapcar #'sb!di:debug-var-id vars)))
993 '(sb!di:debug-var-value v *current-frame*))
995 `(setf (sb!di:debug-var-value v *current-frame*)
998 (error "Specify variable ID to disambiguate ~S. Use one of ~S."
1000 (mapcar #'sb!di:debug-var-id vars)))))))))
1004 ;;; FIXME: This doesn't work. It would be real nice we could make it
1005 ;;; work! Alas, it doesn't seem to work in CMU CL X86 either..
1006 (defun var (name &optional (id 0 id-supplied))
1008 "Return a variable's value if possible. NAME is a simple-string or symbol.
1009 If it is a simple-string, it is an initial substring of the variable's name.
1010 If name is a symbol, it has the same name and package as the variable whose
1011 value this function returns. If the symbol is uninterned, then the variable
1012 has the same name as the symbol, but it has no package.
1014 If name is the initial substring of variables with different names, then
1015 this return no values after displaying the ambiguous names. If name
1016 determines multiple variables with the same name, then you must use the
1017 optional id argument to specify which one you want. If you left id
1018 unspecified, then this returns no values after displaying the distinguishing
1021 The result of this function is limited to the availability of variable
1022 information. This is SETF'able."
1023 (define-var-operation :ref))
1024 (defun (setf var) (value name &optional (id 0 id-supplied))
1025 (define-var-operation :set value))
1027 ;;; This returns the COUNT'th arg as the user sees it from args, the
1028 ;;; result of SB!DI:DEBUG-FUN-LAMBDA-LIST. If this returns a
1029 ;;; potential DEBUG-VAR from the lambda-list, then the second value is
1030 ;;; T. If this returns a keyword symbol or a value from a rest arg,
1031 ;;; then the second value is NIL.
1033 ;;; FIXME: There's probably some way to merge the code here with
1034 ;;; FRAME-ARGS-AS-LIST. (A fair amount of logic is already shared
1035 ;;; through LAMBDA-LIST-ELEMENT-DISPATCH, but I suspect more could be.)
1036 (declaim (ftype (function (index list)) nth-arg))
1037 (defun nth-arg (count args)
1039 (dolist (ele args (error "The argument specification ~S is out of range."
1041 (lambda-list-element-dispatch ele
1042 :required ((if (zerop n) (return (values ele t))))
1043 :optional ((if (zerop n) (return (values (second ele) t))))
1044 :keyword ((cond ((zerop n)
1045 (return (values (second ele) nil)))
1047 (return (values (third ele) t)))))
1048 :deleted ((if (zerop n) (return (values ele t))))
1049 :rest ((let ((var (second ele)))
1050 (lambda-var-dispatch var (sb!di:frame-code-location
1052 (error "unused &REST argument before n'th argument")
1054 (sb!di:debug-var-value var *current-frame*)
1056 "The argument specification ~S is out of range."
1059 (return-from nth-arg (values value nil))
1061 (error "invalid &REST argument before n'th argument")))))
1066 "Return the N'th argument's value if possible. Argument zero is the first
1067 argument in a frame's default printed representation. Count keyword/value
1068 pairs as separate arguments."
1069 (multiple-value-bind (var lambda-var-p)
1070 (nth-arg n (handler-case (sb!di:debug-fun-lambda-list
1071 (sb!di:frame-debug-fun *current-frame*))
1072 (sb!di:lambda-list-unavailable ()
1073 (error "No argument values are available."))))
1075 (lambda-var-dispatch var (sb!di:frame-code-location *current-frame*)
1076 (error "Unused arguments have no values.")
1077 (sb!di:debug-var-value var *current-frame*)
1078 (error "invalid argument value"))
1081 ;;;; machinery for definition of debug loop commands
1083 (defvar *debug-commands* nil)
1085 ;;; Interface to *DEBUG-COMMANDS*. No required arguments in args are
1087 (defmacro !def-debug-command (name args &rest body)
1088 (let ((fun-name (symbolicate name "-DEBUG-COMMAND")))
1090 (setf *debug-commands*
1091 (remove ,name *debug-commands* :key #'car :test #'string=))
1092 (defun ,fun-name ,args
1093 (unless *in-the-debugger*
1094 (error "invoking debugger command while outside the debugger"))
1096 (push (cons ,name #',fun-name) *debug-commands*)
1099 (defun !def-debug-command-alias (new-name existing-name)
1100 (let ((pair (assoc existing-name *debug-commands* :test #'string=)))
1101 (unless pair (error "unknown debug command name: ~S" existing-name))
1102 (push (cons new-name (cdr pair)) *debug-commands*))
1105 ;;; This takes a symbol and uses its name to find a debugger command,
1106 ;;; using initial substring matching. It returns the command function
1107 ;;; if form identifies only one command, but if form is ambiguous,
1108 ;;; this returns a list of the command names. If there are no matches,
1109 ;;; this returns nil. Whenever the loop that looks for a set of
1110 ;;; possibilities encounters an exact name match, we return that
1111 ;;; command function immediately.
1112 (defun debug-command-p (form &optional other-commands)
1113 (if (or (symbolp form) (integerp form))
1117 (format nil "~W" form)))
1120 (declare (simple-string name)
1124 ;; Find matching commands, punting if exact match.
1125 (flet ((match-command (ele)
1126 (let* ((str (car ele))
1127 (str-len (length str)))
1128 (declare (simple-string str)
1130 (cond ((< str-len len))
1132 (when (string= name str :end1 len :end2 len)
1133 (return-from debug-command-p (cdr ele))))
1134 ((string= name str :end1 len :end2 len)
1136 (mapc #'match-command *debug-commands*)
1137 (mapc #'match-command other-commands))
1139 ;; Return the right value.
1140 (cond ((not res) nil)
1143 (t ; Just return the names.
1144 (do ((cmds res (cdr cmds)))
1146 (setf (car cmds) (caar cmds))))))))
1148 ;;; Return a list of debug commands (in the same format as
1149 ;;; *DEBUG-COMMANDS*) that invoke each active restart.
1151 ;;; Two commands are made for each restart: one for the number, and
1152 ;;; one for the restart name (unless it's been shadowed by an earlier
1153 ;;; restart of the same name, or it is NIL).
1154 (defun make-restart-commands (&optional (restarts *debug-restarts*))
1156 (num 0)) ; better be the same as show-restarts!
1157 (dolist (restart restarts)
1158 (let ((name (string (restart-name restart))))
1161 (/show0 "in restart-command closure, about to i-r-i")
1162 (invoke-restart-interactively restart))))
1163 (push (cons (prin1-to-string num) restart-fun) commands)
1164 (unless (or (null (restart-name restart))
1165 (find name commands :key #'car :test #'string=))
1166 (push (cons name restart-fun) commands))))
1170 ;;;; frame-changing commands
1172 (!def-debug-command "UP" ()
1173 (let ((next (sb!di:frame-up *current-frame*)))
1175 (setf *current-frame* next)
1176 (print-frame-call next))
1178 (format t "~&Top of stack.")))))
1180 (!def-debug-command "DOWN" ()
1181 (let ((next (sb!di:frame-down *current-frame*)))
1183 (setf *current-frame* next)
1184 (print-frame-call next))
1186 (format t "~&Bottom of stack.")))))
1188 (!def-debug-command-alias "D" "DOWN")
1190 ;;; CMU CL had this command, but SBCL doesn't, since it's redundant
1191 ;;; with "FRAME 0", and it interferes with abbreviations for the
1192 ;;; TOPLEVEL restart.
1193 ;;;(!def-debug-command "TOP" ()
1194 ;;; (do ((prev *current-frame* lead)
1195 ;;; (lead (sb!di:frame-up *current-frame*) (sb!di:frame-up lead)))
1197 ;;; (setf *current-frame* prev)
1198 ;;; (print-frame-call prev))))
1200 (!def-debug-command "BOTTOM" ()
1201 (do ((prev *current-frame* lead)
1202 (lead (sb!di:frame-down *current-frame*) (sb!di:frame-down lead)))
1204 (setf *current-frame* prev)
1205 (print-frame-call prev))))
1207 (!def-debug-command-alias "B" "BOTTOM")
1209 (!def-debug-command "FRAME" (&optional
1210 (n (read-prompting-maybe "frame number: ")))
1211 (setf *current-frame*
1212 (multiple-value-bind (next-frame-fun limit-string)
1213 (if (< n (sb!di:frame-number *current-frame*))
1214 (values #'sb!di:frame-up "top")
1215 (values #'sb!di:frame-down "bottom"))
1216 (do ((frame *current-frame*))
1217 ((= n (sb!di:frame-number frame))
1219 (let ((next-frame (funcall next-frame-fun frame)))
1221 (setf frame next-frame))
1224 "The ~A of the stack was encountered.~%"
1226 (return frame)))))))
1227 (print-frame-call *current-frame*))
1229 (!def-debug-command-alias "F" "FRAME")
1231 ;;;; commands for entering and leaving the debugger
1233 ;;; CMU CL supported this QUIT debug command, but SBCL provides this
1234 ;;; functionality with a restart instead. (The QUIT debug command was
1235 ;;; removed because it's confusing to have "quit" mean two different
1236 ;;; things in the system, "restart the top level REPL" in the debugger
1237 ;;; and "terminate the Lisp system" as the SB-EXT:QUIT function.)
1239 ;;;(!def-debug-command "QUIT" ()
1240 ;;; (throw 'sb!impl::toplevel-catcher nil))
1242 ;;; CMU CL supported this GO debug command, but SBCL doesn't -- in
1243 ;;; SBCL you just type the CONTINUE restart name instead (or "C" or
1244 ;;; "RESTART CONTINUE", that's OK too).
1245 ;;;(!def-debug-command "GO" ()
1246 ;;; (continue *debug-condition*)
1247 ;;; (error "There is no restart named CONTINUE."))
1249 (!def-debug-command "RESTART" ()
1250 (/show0 "doing RESTART debug-command")
1251 (let ((num (read-if-available :prompt)))
1252 (when (eq num :prompt)
1253 (show-restarts *debug-restarts* *debug-io*)
1254 (write-string "restart: ")
1256 (setf num (read *debug-io*)))
1257 (let ((restart (typecase num
1259 (nth num *debug-restarts*))
1261 (find num *debug-restarts* :key #'restart-name
1262 :test (lambda (sym1 sym2)
1263 (string= (symbol-name sym1)
1264 (symbol-name sym2)))))
1266 (format t "~S is invalid as a restart name.~%" num)
1267 (return-from restart-debug-command nil)))))
1268 (/show0 "got RESTART")
1270 (invoke-restart-interactively restart)
1271 ;; FIXME: Even if this isn't handled by WARN, it probably
1272 ;; shouldn't go to *STANDARD-OUTPUT*, but *ERROR-OUTPUT* or
1273 ;; *QUERY-IO* or something. Look through this file to
1274 ;; straighten out stream usage.
1275 (princ "There is no such restart.")))))
1277 ;;;; information commands
1279 (!def-debug-command "HELP" ()
1280 ;; CMU CL had a little toy pager here, but "if you aren't running
1281 ;; ILISP (or a smart windowing system, or something) you deserve to
1282 ;; lose", so we've dropped it in SBCL. However, in case some
1283 ;; desperate holdout is running this on a dumb terminal somewhere,
1284 ;; we tell him where to find the message stored as a string.
1286 "~&~A~2%(The HELP string is stored in ~S.)~%"
1288 '*debug-help-string*))
1290 (!def-debug-command-alias "?" "HELP")
1292 (!def-debug-command "ERROR" ()
1293 (format *debug-io* "~A~%" *debug-condition*)
1294 (show-restarts *debug-restarts* *debug-io*))
1296 (!def-debug-command "BACKTRACE" ()
1297 (backtrace (read-if-available most-positive-fixnum)))
1299 (!def-debug-command "PRINT" ()
1300 (print-frame-call *current-frame*))
1302 (!def-debug-command-alias "P" "PRINT")
1304 (!def-debug-command "LIST-LOCALS" ()
1305 (let ((d-fun (sb!di:frame-debug-fun *current-frame*)))
1306 (if (sb!di:debug-var-info-available d-fun)
1307 (let ((*standard-output* *debug-io*)
1308 (location (sb!di:frame-code-location *current-frame*))
1309 (prefix (read-if-available nil))
1312 (dolist (v (sb!di:ambiguous-debug-vars
1314 (if prefix (string prefix) "")))
1316 (when (eq (sb!di:debug-var-validity v location) :valid)
1317 (setf any-valid-p t)
1318 (format t "~S~:[#~W~;~*~] = ~S~%"
1319 (sb!di:debug-var-symbol v)
1320 (zerop (sb!di:debug-var-id v))
1321 (sb!di:debug-var-id v)
1322 (sb!di:debug-var-value v *current-frame*))))
1326 (format t "There are no local variables ~@[starting with ~A ~]~
1330 (format t "All variables ~@[starting with ~A ~]currently ~
1331 have invalid values."
1333 (write-line "There is no variable information available."))))
1335 (!def-debug-command-alias "L" "LIST-LOCALS")
1337 (!def-debug-command "SOURCE" ()
1339 (print-code-location-source-form (sb!di:frame-code-location *current-frame*)
1340 (read-if-available 0)))
1342 ;;;; source location printing
1344 ;;; We cache a stream to the last valid file debug source so that we
1345 ;;; won't have to repeatedly open the file.
1347 ;;; KLUDGE: This sounds like a bug, not a feature. Opening files is fast
1348 ;;; in the 1990s, so the benefit is negligible, less important than the
1349 ;;; potential of extra confusion if someone changes the source during
1350 ;;; a debug session and the change doesn't show up. And removing this
1351 ;;; would simplify the system, which I like. -- WHN 19990903
1352 (defvar *cached-debug-source* nil)
1353 (declaim (type (or sb!di:debug-source null) *cached-debug-source*))
1354 (defvar *cached-source-stream* nil)
1355 (declaim (type (or stream null) *cached-source-stream*))
1357 ;;; To suppress the read-time evaluation #. macro during source read,
1358 ;;; *READTABLE* is modified. *READTABLE* is cached to avoid
1359 ;;; copying it each time, and invalidated when the
1360 ;;; *CACHED-DEBUG-SOURCE* has changed.
1361 (defvar *cached-readtable* nil)
1362 (declaim (type (or readtable null) *cached-readtable*))
1365 (setq *cached-debug-source* nil *cached-source-stream* nil
1366 *cached-readtable* nil))
1367 *before-save-initializations*)
1369 ;;; We also cache the last toplevel form that we printed a source for
1370 ;;; so that we don't have to do repeated reads and calls to
1371 ;;; FORM-NUMBER-TRANSLATIONS.
1372 (defvar *cached-toplevel-form-offset* nil)
1373 (declaim (type (or index null) *cached-toplevel-form-offset*))
1374 (defvar *cached-toplevel-form*)
1375 (defvar *cached-form-number-translations*)
1377 ;;; Given a code location, return the associated form-number
1378 ;;; translations and the actual top level form. We check our cache ---
1379 ;;; if there is a miss, we dispatch on the kind of the debug source.
1380 (defun get-toplevel-form (location)
1381 (let ((d-source (sb!di:code-location-debug-source location)))
1382 (if (and (eq d-source *cached-debug-source*)
1383 (eql (sb!di:code-location-toplevel-form-offset location)
1384 *cached-toplevel-form-offset*))
1385 (values *cached-form-number-translations* *cached-toplevel-form*)
1386 (let* ((offset (sb!di:code-location-toplevel-form-offset location))
1388 (ecase (sb!di:debug-source-from d-source)
1389 (:file (get-file-toplevel-form location))
1390 (:lisp (svref (sb!di:debug-source-name d-source) offset)))))
1391 (setq *cached-toplevel-form-offset* offset)
1392 (values (setq *cached-form-number-translations*
1393 (sb!di:form-number-translations res offset))
1394 (setq *cached-toplevel-form* res))))))
1396 ;;; Locate the source file (if it still exists) and grab the top level
1397 ;;; form. If the file is modified, we use the top level form offset
1398 ;;; instead of the recorded character offset.
1399 (defun get-file-toplevel-form (location)
1400 (let* ((d-source (sb!di:code-location-debug-source location))
1401 (tlf-offset (sb!di:code-location-toplevel-form-offset location))
1402 (local-tlf-offset (- tlf-offset
1403 (sb!di:debug-source-root-number d-source)))
1405 (aref (or (sb!di:debug-source-start-positions d-source)
1406 (error "no start positions map"))
1408 (name (sb!di:debug-source-name d-source)))
1409 (unless (eq d-source *cached-debug-source*)
1410 (unless (and *cached-source-stream*
1411 (equal (pathname *cached-source-stream*)
1413 (setq *cached-readtable* nil)
1414 (when *cached-source-stream* (close *cached-source-stream*))
1415 (setq *cached-source-stream* (open name :if-does-not-exist nil))
1416 (unless *cached-source-stream*
1417 (error "The source file no longer exists:~% ~A" (namestring name)))
1418 (format t "~%; file: ~A~%" (namestring name)))
1420 (setq *cached-debug-source*
1421 (if (= (sb!di:debug-source-created d-source)
1422 (file-write-date name))
1426 ((eq *cached-debug-source* d-source)
1427 (file-position *cached-source-stream* char-offset))
1429 (format t "~%; File has been modified since compilation:~%; ~A~@
1430 ; Using form offset instead of character position.~%"
1432 (file-position *cached-source-stream* 0)
1433 (let ((*read-suppress* t))
1434 (dotimes (i local-tlf-offset)
1435 (read *cached-source-stream*)))))
1436 (unless *cached-readtable*
1437 (setq *cached-readtable* (copy-readtable))
1438 (set-dispatch-macro-character
1440 (lambda (stream sub-char &rest rest)
1441 (declare (ignore rest sub-char))
1442 (let ((token (read stream t nil t)))
1443 (format nil "#.~S" token)))
1444 *cached-readtable*))
1445 (let ((*readtable* *cached-readtable*))
1446 (read *cached-source-stream*))))
1448 (defun print-code-location-source-form (location context)
1449 (let* ((location (maybe-block-start-location location))
1450 (form-num (sb!di:code-location-form-number location)))
1451 (multiple-value-bind (translations form) (get-toplevel-form location)
1452 (unless (< form-num (length translations))
1453 (error "The source path no longer exists."))
1454 (prin1 (sb!di:source-path-context form
1455 (svref translations form-num)
1458 ;;; breakpoint and step commands
1460 ;;; Step to the next code-location.
1461 (!def-debug-command "STEP" ()
1462 (setf *number-of-steps* (read-if-available 1))
1463 (set-step-breakpoint *current-frame*)
1464 (continue *debug-condition*)
1465 (error "couldn't continue"))
1467 ;;; List possible breakpoint locations, which ones are active, and
1468 ;;; where the CONTINUE restart will transfer control. Set
1469 ;;; *POSSIBLE-BREAKPOINTS* to the code-locations which can then be
1470 ;;; used by sbreakpoint.
1471 (!def-debug-command "LIST-LOCATIONS" ()
1472 (let ((df (read-if-available *default-breakpoint-debug-fun*)))
1474 (setf df (sb!di:fun-debug-fun (eval df)))
1475 (setf *default-breakpoint-debug-fun* df))
1477 (not *default-breakpoint-debug-fun*))
1478 (setf df (sb!di:frame-debug-fun *current-frame*))
1479 (setf *default-breakpoint-debug-fun* df)))
1480 (setf *possible-breakpoints* (possible-breakpoints df)))
1481 (let ((continue-at (sb!di:frame-code-location *current-frame*)))
1482 (let ((active (location-in-list *default-breakpoint-debug-fun*
1483 *breakpoints* :fun-start))
1484 (here (sb!di:code-location=
1485 (sb!di:debug-fun-start-location
1486 *default-breakpoint-debug-fun*) continue-at)))
1487 (when (or active here)
1488 (format t "::FUN-START ")
1489 (when active (format t " *Active*"))
1490 (when here (format t " *Continue here*"))))
1492 (let ((prev-location nil)
1497 (let ((this-num (1- this-num)))
1498 (if (= prev-num this-num)
1499 (format t "~&~W: " prev-num)
1500 (format t "~&~W-~W: " prev-num this-num)))
1501 (print-code-location-source-form prev-location 0)
1502 (when *print-location-kind*
1503 (format t "~S " (sb!di:code-location-kind prev-location)))
1504 (when (location-in-list prev-location *breakpoints*)
1505 (format t " *Active*"))
1506 (when (sb!di:code-location= prev-location continue-at)
1507 (format t " *Continue here*")))))
1509 (dolist (code-location *possible-breakpoints*)
1510 (when (or *print-location-kind*
1511 (location-in-list code-location *breakpoints*)
1512 (sb!di:code-location= code-location continue-at)
1514 (not (eq (sb!di:code-location-debug-source code-location)
1515 (sb!di:code-location-debug-source prev-location)))
1516 (not (eq (sb!di:code-location-toplevel-form-offset
1518 (sb!di:code-location-toplevel-form-offset
1520 (not (eq (sb!di:code-location-form-number code-location)
1521 (sb!di:code-location-form-number prev-location))))
1523 (setq prev-location code-location prev-num this-num))
1527 (when (location-in-list *default-breakpoint-debug-fun*
1530 (format t "~&::FUN-END *Active* "))))
1532 (!def-debug-command-alias "LL" "LIST-LOCATIONS")
1534 ;;; Set breakpoint at the given number.
1535 (!def-debug-command "BREAKPOINT" ()
1536 (let ((index (read-prompting-maybe "location number, :START, or :END: "))
1540 (print-functions nil)
1543 (place *default-breakpoint-debug-fun*))
1544 (flet ((get-command-line ()
1545 (let ((command-line nil)
1548 (let ((next-input (read-if-available unique)))
1549 (when (eq next-input unique) (return))
1550 (push next-input command-line)))
1551 (nreverse command-line)))
1552 (set-vars-from-command-line (command-line)
1553 (do ((arg (pop command-line) (pop command-line)))
1556 (:condition (setf condition (pop command-line)))
1557 (:print (push (pop command-line) print))
1558 (:break (setf break (pop command-line)))
1560 (setf function (eval (pop command-line)))
1561 (setf *default-breakpoint-debug-fun*
1562 (sb!di:fun-debug-fun function))
1563 (setf place *default-breakpoint-debug-fun*)
1564 (setf *possible-breakpoints*
1565 (possible-breakpoints
1566 *default-breakpoint-debug-fun*))))))
1568 (let ((code-loc (sb!di:debug-fun-start-location place)))
1569 (setf bp (sb!di:make-breakpoint #'main-hook-fun
1572 (setf break (sb!di:preprocess-for-eval break code-loc))
1573 (setf condition (sb!di:preprocess-for-eval condition code-loc))
1574 (dolist (form print)
1575 (push (cons (sb!di:preprocess-for-eval form code-loc) form)
1579 (sb!di:make-breakpoint #'main-hook-fun
1583 ;; FIXME: These and any other old (COERCE `(LAMBDA ..) ..)
1584 ;; forms should be converted to shiny new (LAMBDA ..) forms.
1585 ;; (Search the sources for "coerce.*\(lambda".)
1586 (coerce `(lambda (dummy)
1587 (declare (ignore dummy)) ,break)
1589 (setf condition (coerce `(lambda (dummy)
1590 (declare (ignore dummy)) ,condition)
1592 (dolist (form print)
1594 (coerce `(lambda (dummy)
1595 (declare (ignore dummy)) ,form) 'function)
1598 (setup-code-location ()
1599 (setf place (nth index *possible-breakpoints*))
1600 (setf bp (sb!di:make-breakpoint #'main-hook-fun place
1601 :kind :code-location))
1602 (dolist (form print)
1604 (sb!di:preprocess-for-eval form place)
1607 (setf break (sb!di:preprocess-for-eval break place))
1608 (setf condition (sb!di:preprocess-for-eval condition place))))
1609 (set-vars-from-command-line (get-command-line))
1611 ((or (eq index :start) (eq index :s))
1613 ((or (eq index :end) (eq index :e))
1616 (setup-code-location)))
1617 (sb!di:activate-breakpoint bp)
1618 (let* ((new-bp-info (create-breakpoint-info place bp index
1620 :print print-functions
1621 :condition condition))
1622 (old-bp-info (location-in-list new-bp-info *breakpoints*)))
1624 (sb!di:deactivate-breakpoint (breakpoint-info-breakpoint
1626 (setf *breakpoints* (remove old-bp-info *breakpoints*))
1627 (format t "previous breakpoint removed~%"))
1628 (push new-bp-info *breakpoints*))
1629 (print-breakpoint-info (first *breakpoints*))
1630 (format t "~&added"))))
1632 (!def-debug-command-alias "BP" "BREAKPOINT")
1634 ;;; List all breakpoints which are set.
1635 (!def-debug-command "LIST-BREAKPOINTS" ()
1637 (sort *breakpoints* #'< :key #'breakpoint-info-breakpoint-number))
1638 (dolist (info *breakpoints*)
1639 (print-breakpoint-info info)))
1641 (!def-debug-command-alias "LB" "LIST-BREAKPOINTS")
1642 (!def-debug-command-alias "LBP" "LIST-BREAKPOINTS")
1644 ;;; Remove breakpoint N, or remove all breakpoints if no N given.
1645 (!def-debug-command "DELETE-BREAKPOINT" ()
1646 (let* ((index (read-if-available nil))
1648 (find index *breakpoints* :key #'breakpoint-info-breakpoint-number)))
1650 (sb!di:delete-breakpoint (breakpoint-info-breakpoint bp-info))
1651 (setf *breakpoints* (remove bp-info *breakpoints*))
1652 (format t "breakpoint ~S removed~%" index))
1653 (index (format t "The breakpoint doesn't exist."))
1655 (dolist (ele *breakpoints*)
1656 (sb!di:delete-breakpoint (breakpoint-info-breakpoint ele)))
1657 (setf *breakpoints* nil)
1658 (format t "all breakpoints deleted~%")))))
1660 (!def-debug-command-alias "DBP" "DELETE-BREAKPOINT")
1662 ;;; miscellaneous commands
1664 (!def-debug-command "DESCRIBE" ()
1665 (let* ((curloc (sb!di:frame-code-location *current-frame*))
1666 (debug-fun (sb!di:code-location-debug-fun curloc))
1667 (function (sb!di:debug-fun-fun debug-fun)))
1670 (format t "can't figure out the function for this frame"))))
1672 (!def-debug-command "SLURP" ()
1673 (loop while (read-char-no-hang *standard-input*)))
1675 (!def-debug-command "RETURN" (&optional
1676 (return (read-prompting-maybe
1678 (let ((tag (find-if (lambda (x)
1679 (and (typep (car x) 'symbol)
1680 (not (symbol-package (car x)))
1681 (string= (car x) "SB-DEBUG-CATCH-TAG")))
1682 (sb!di::frame-catches *current-frame*))))
1685 (funcall (sb!di:preprocess-for-eval
1687 (sb!di:frame-code-location *current-frame*))
1689 (format t "~@<can't find a tag for this frame ~
1690 ~2I~_(hint: try increasing the DEBUG optimization quality ~
1691 and recompiling)~:@>"))))
1693 ;;;; debug loop command utilities
1695 (defun read-prompting-maybe (prompt)
1696 (unless (sb!int:listen-skip-whitespace *debug-io*)
1701 (defun read-if-available (default)
1702 (if (sb!int:listen-skip-whitespace *debug-io*)