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 (defvar *debug-print-level* 3
18 "*PRINT-LEVEL* for the debugger")
20 (defvar *debug-print-length* 5
22 "*PRINT-LENGTH* for the debugger")
24 (defvar *debug-readtable*
25 ;; KLUDGE: This can't be initialized in a cold toplevel form,
26 ;; because the *STANDARD-READTABLE* isn't initialized until after
27 ;; cold toplevel forms have run. So instead we initialize it
28 ;; immediately after *STANDARD-READTABLE*. -- WHN 20000205
31 "*READTABLE* for the debugger")
33 (defvar *in-the-debugger* nil
35 "This is T while in the debugger.")
37 ;;; nestedness inside debugger command loops
38 (defvar *debug-command-level* 0)
40 ;;; If this is bound before the debugger is invoked, it is used as the
41 ;;; stack top by the debugger.
42 (defvar *stack-top-hint* nil)
44 (defvar *stack-top* nil)
45 (defvar *real-stack-top* nil)
47 (defvar *current-frame* nil)
49 ;;; Beginner-oriented help messages are important because you end up
50 ;;; in the debugger whenever something bad happens, or if you try to
51 ;;; get out of the system with Ctrl-C or (EXIT) or EXIT or whatever.
52 ;;; But after memorizing them the wasted screen space gets annoying..
53 (defvar *debug-beginner-help-p* t
54 "Should the debugger display beginner-oriented help messages?")
56 (defun debug-prompt (stream)
58 ;; old behavior, will probably go away in sbcl-0.7.x
59 (format stream "~%~D" (sb!di:frame-number *current-frame*))
60 (dotimes (i *debug-command-level*)
61 (write-char #\] stream))
62 (write-char #\space stream)
64 ;; planned new behavior, delayed since it will break ILISP
68 (sb!di:frame-number *current-frame*)
69 (> *debug-command-level* 1)
70 *debug-command-level*))
72 (defparameter *debug-help-string*
73 "The prompt is right square brackets, the number indicating how many
74 recursive command loops you are in.
75 Any command may be uniquely abbreviated.
76 The debugger rebinds various special variables for controlling i/o, sometimes
77 to defaults (much like WITH-STANDARD-IO-SYNTAX does) and sometimes to
78 its own special values, e.g. SB-DEBUG:*DEBUG-PRINT-LEVEL*.
79 Debug commands do not affect * and friends, but evaluation in the debug loop
80 does affect these variables.
81 SB-DEBUG:*FLUSH-DEBUG-ERRORS* controls whether errors at the debug prompt
82 drop you into deeper into the debugger.
84 Getting in and out of the debugger:
85 RESTART invokes restart numbered as shown (prompt if not given).
86 ERROR prints the error condition and restart cases.
87 The name of any restart, or its number, is a valid command, and is the same
88 as using RESTART to invoke that restart.
91 U up frame D down frame
92 B bottom frame F n frame n (n=0 for top frame)
95 BACKTRACE [n] shows n frames going down the stack.
96 LIST-LOCALS, L lists locals in current function.
97 PRINT, P displays current function call.
98 SOURCE [n] displays frame's source form with n levels of enclosing forms.
100 Breakpoints and steps:
101 LIST-LOCATIONS [{function | :C}] List the locations for breakpoints.
102 Specify :C for the current frame.
104 LIST-BREAKPOINTS List the active breakpoints.
105 Abbreviations: LB, LBP
106 DELETE-BREAKPOINT [n] Remove breakpoint n or all breakpoints.
107 Abbreviations: DEL, DBP
108 BREAKPOINT {n | :end | :start} [:break form] [:function function]
109 [{:print form}*] [:condition form]
111 Abbreviations: BR, BP
112 STEP [n] Step to the next location or step n times.
114 Function and macro commands:
115 (SB-DEBUG:DEBUG-RETURN expression)
116 Exit the debugger, returning expression's values from the current frame.
118 Return the n'th argument in the current frame.
119 (SB-DEBUG:VAR string-or-symbol [id])
120 Returns the value of the specified variable in the current frame.")
122 ;;; This is used to communicate to DEBUG-LOOP that we are at a step breakpoint.
123 (define-condition step-condition (simple-condition) ())
125 ;;;; breakpoint state
127 (defvar *only-block-start-locations* nil
129 "When true, the LIST-LOCATIONS command only displays block start locations.
130 Otherwise, all locations are displayed.")
132 (defvar *print-location-kind* nil
134 "When true, list the code location type in the LIST-LOCATIONS command.")
136 ;;; a list of the types of code-locations that should not be stepped
137 ;;; to and should not be listed when listing breakpoints
138 (defvar *bad-code-location-types* '(:call-site :internal-error))
139 (declaim (type list *bad-code-location-types*))
141 ;;; code locations of the possible breakpoints
142 (defvar *possible-breakpoints*)
143 (declaim (type list *possible-breakpoints*))
145 ;;; a list of the made and active breakpoints, each is a
146 ;;; BREAKPOINT-INFO structure
147 (defvar *breakpoints* nil)
148 (declaim (type list *breakpoints*))
150 ;;; a list of BREAKPOINT-INFO structures of the made and active step
152 (defvar *step-breakpoints* nil)
153 (declaim (type list *step-breakpoints*))
155 ;;; the number of times left to step
156 (defvar *number-of-steps* 1)
157 (declaim (type integer *number-of-steps*))
159 ;;; This is used when listing and setting breakpoints.
160 (defvar *default-breakpoint-debug-function* nil)
161 (declaim (type (or list sb!di:debug-function) *default-breakpoint-debug-function*))
163 ;;;; code location utilities
165 ;;; Return the first code-location in the passed debug block.
166 (defun first-code-location (debug-block)
168 (first-code-location nil))
169 (sb!di:do-debug-block-locations (code-location debug-block)
171 (setf first-code-location code-location)
173 first-code-location))
175 ;;; Return a list of the next code-locations following the one passed.
176 ;;; One of the *BAD-CODE-LOCATION-TYPES* will not be returned.
177 (defun next-code-locations (code-location)
178 (let ((debug-block (sb!di:code-location-debug-block code-location))
179 (block-code-locations nil))
180 (sb!di:do-debug-block-locations (block-code-location debug-block)
181 (unless (member (sb!di:code-location-kind block-code-location)
182 *bad-code-location-types*)
183 (push block-code-location block-code-locations)))
184 (setf block-code-locations (nreverse block-code-locations))
185 (let* ((code-loc-list (rest (member code-location block-code-locations
186 :test #'sb!di:code-location=)))
187 (next-list (cond (code-loc-list
188 (list (first code-loc-list)))
189 ((map 'list #'first-code-location
190 (sb!di:debug-block-successors debug-block)))
192 (when (and (= (length next-list) 1)
193 (sb!di:code-location= (first next-list) code-location))
194 (setf next-list (next-code-locations (first next-list))))
197 ;;; Returns a list of code-locations of the possible breakpoints of the
198 ;;; debug-function passed.
199 (defun possible-breakpoints (debug-function)
200 (let ((possible-breakpoints nil))
201 (sb!di:do-debug-function-blocks (debug-block debug-function)
202 (unless (sb!di:debug-block-elsewhere-p debug-block)
203 (if *only-block-start-locations*
204 (push (first-code-location debug-block) possible-breakpoints)
205 (sb!di:do-debug-block-locations (code-location debug-block)
206 (when (not (member (sb!di:code-location-kind code-location)
207 *bad-code-location-types*))
208 (push code-location possible-breakpoints))))))
209 (nreverse possible-breakpoints)))
211 ;;; Searches the info-list for the item passed (code-location,
212 ;;; debug-function, or breakpoint-info). If the item passed is a debug
213 ;;; function then kind will be compared if it was specified. The kind
214 ;;; if also compared if a breakpoint-info is passed since it's in the
215 ;;; breakpoint. The info structure is returned if found.
216 (defun location-in-list (place info-list &optional (kind nil))
217 (when (breakpoint-info-p place)
218 (setf kind (sb!di:breakpoint-kind (breakpoint-info-breakpoint place)))
219 (setf place (breakpoint-info-place place)))
220 (cond ((sb!di:code-location-p place)
221 (find place info-list
222 :key #'breakpoint-info-place
223 :test #'(lambda (x y) (and (sb!di:code-location-p y)
224 (sb!di:code-location= x y)))))
226 (find place info-list
227 :test #'(lambda (x-debug-function y-info)
228 (let ((y-place (breakpoint-info-place y-info))
229 (y-breakpoint (breakpoint-info-breakpoint
231 (and (sb!di:debug-function-p y-place)
232 (eq x-debug-function y-place)
234 (eq kind (sb!di:breakpoint-kind
235 y-breakpoint))))))))))
237 ;;; If LOC is an unknown location, then try to find the block start
238 ;;; location. Used by source printing to some information instead of
239 ;;; none for the user.
240 (defun maybe-block-start-location (loc)
241 (if (sb!di:code-location-unknown-p loc)
242 (let* ((block (sb!di:code-location-debug-block loc))
243 (start (sb!di:do-debug-block-locations (loc block)
245 (cond ((and (not (sb!di:debug-block-elsewhere-p block))
247 ;; FIXME: Why output on T instead of *DEBUG-FOO* or something?
248 (format t "~%unknown location: using block start~%")
254 ;;;; the BREAKPOINT-INFO structure
256 ;;; info about a made breakpoint
257 (defstruct (breakpoint-info (:copier nil))
258 ;; where we are going to stop
259 (place (required-argument)
260 :type (or sb!di:code-location sb!di:debug-function))
261 ;; the breakpoint returned by sb!di:make-breakpoint
262 (breakpoint (required-argument) :type sb!di:breakpoint)
263 ;; the function returned from SB!DI:PREPROCESS-FOR-EVAL. If result is
264 ;; non-NIL, drop into the debugger.
265 (break #'identity :type function)
266 ;; the function returned from sb!di:preprocess-for-eval. If result is
267 ;; non-NIL, eval (each) print and print results.
268 (condition #'identity :type function)
269 ;; the list of functions from sb!di:preprocess-for-eval to evaluate.
270 ;; Results are conditionally printed. Car of each element is the
271 ;; function, cdr is the form it goes with.
272 (print nil :type list)
273 ;; the number used when listing the possible breakpoints within a
274 ;; function. Could also be a symbol such as start or end.
275 (code-location-number (required-argument) :type (or symbol integer))
276 ;; the number used when listing the breakpoints active and to delete
278 (breakpoint-number (required-argument) :type integer))
280 ;;; Return a new BREAKPOINT-INFO structure with the info passed.
281 (defun create-breakpoint-info (place breakpoint code-location-number
282 &key (break #'identity)
283 (condition #'identity) (print nil))
285 (sort *breakpoints* #'< :key #'breakpoint-info-breakpoint-number))
286 (let ((breakpoint-number
287 (do ((i 1 (incf i)) (breakpoints *breakpoints* (rest breakpoints)))
288 ((or (> i (length *breakpoints*))
289 (not (= i (breakpoint-info-breakpoint-number
290 (first breakpoints)))))
293 (make-breakpoint-info :place place :breakpoint breakpoint
294 :code-location-number code-location-number
295 :breakpoint-number breakpoint-number
296 :break break :condition condition :print print)))
298 ;;; Print the breakpoint info for the breakpoint-info structure passed.
299 (defun print-breakpoint-info (breakpoint-info)
300 (let ((place (breakpoint-info-place breakpoint-info))
301 (bp-number (breakpoint-info-breakpoint-number breakpoint-info))
302 (loc-number (breakpoint-info-code-location-number breakpoint-info)))
303 (case (sb!di:breakpoint-kind (breakpoint-info-breakpoint breakpoint-info))
305 (print-code-location-source-form place 0)
310 (sb!di:debug-function-name (sb!di:code-location-debug-function
313 (format t "~&~S: FUNCTION-START in ~S" bp-number
314 (sb!di:debug-function-name place)))
316 (format t "~&~S: FUNCTION-END in ~S" bp-number
317 (sb!di:debug-function-name place))))))
319 ;;;; MAIN-HOOK-FUNCTION for steps and breakpoints
321 ;;; This must be passed as the hook function. It keeps track of where
322 ;;; STEP breakpoints are.
323 (defun main-hook-function (current-frame breakpoint &optional return-vals
325 (setf *default-breakpoint-debug-function*
326 (sb!di:frame-debug-function current-frame))
327 (dolist (step-info *step-breakpoints*)
328 (sb!di:delete-breakpoint (breakpoint-info-breakpoint step-info))
329 (let ((bp-info (location-in-list step-info *breakpoints*)))
331 (sb!di:activate-breakpoint (breakpoint-info-breakpoint bp-info)))))
332 (let ((*stack-top-hint* current-frame)
334 (location-in-list (sb!di:breakpoint-what breakpoint)
336 (sb!di:breakpoint-kind breakpoint)))
338 (location-in-list (sb!di:breakpoint-what breakpoint)
340 (sb!di:breakpoint-kind breakpoint)))
344 (setf *step-breakpoints* nil)
345 (labels ((build-string (str)
346 (setf string (concatenate 'string string str)))
347 (print-common-info ()
349 (with-output-to-string (*standard-output*)
350 (when function-end-cookie
351 (format t "~%Return values: ~S" return-vals))
353 (when (breakpoint-info-print bp-hit-info)
355 (print-frame-call current-frame))
356 (dolist (print (breakpoint-info-print bp-hit-info))
357 (format t "~& ~S = ~S" (rest print)
358 (funcall (first print) current-frame))))))))
360 (setf break (funcall (breakpoint-info-break bp-hit-info)
362 (setf condition (funcall (breakpoint-info-condition bp-hit-info)
364 (cond ((and bp-hit-info step-hit-info (= 1 *number-of-steps*))
365 (build-string (format nil "~&*Step (to a breakpoint)*"))
368 ((and bp-hit-info step-hit-info break)
369 (build-string (format nil "~&*Step (to a breakpoint)*"))
372 ((and bp-hit-info step-hit-info)
374 (format t "~A" string)
375 (decf *number-of-steps*)
376 (set-step-breakpoint current-frame))
377 ((and step-hit-info (= 1 *number-of-steps*))
378 (build-string "*Step*")
379 (break (make-condition 'step-condition :format-control string)))
381 (decf *number-of-steps*)
382 (set-step-breakpoint current-frame))
385 (build-string (format nil "~&*Breakpoint hit*")))
389 (format t "~A" string)))
391 (break "error in main-hook-function: unknown breakpoint"))))))
393 ;;; Set breakpoints at the next possible code-locations. After calling
394 ;;; this, either (CONTINUE) if in the debugger or just let program flow
395 ;;; return if in a hook function.
396 (defun set-step-breakpoint (frame)
398 ((sb!di:debug-block-elsewhere-p (sb!di:code-location-debug-block
399 (sb!di:frame-code-location frame)))
400 ;; FIXME: FORMAT T is used for error output here and elsewhere in
402 (format t "cannot step, in elsewhere code~%"))
404 (let* ((code-location (sb!di:frame-code-location frame))
405 (next-code-locations (next-code-locations code-location)))
408 (dolist (code-location next-code-locations)
409 (let ((bp-info (location-in-list code-location *breakpoints*)))
411 (sb!di:deactivate-breakpoint (breakpoint-info-breakpoint
413 (let ((bp (sb!di:make-breakpoint #'main-hook-function code-location
414 :kind :code-location)))
415 (sb!di:activate-breakpoint bp)
416 (push (create-breakpoint-info code-location bp 0)
417 *step-breakpoints*))))
419 (let* ((debug-function (sb!di:frame-debug-function *current-frame*))
420 (bp (sb!di:make-breakpoint #'main-hook-function debug-function
421 :kind :function-end)))
422 (sb!di:activate-breakpoint bp)
423 (push (create-breakpoint-info debug-function bp 0)
424 *step-breakpoints*))))))))
428 ;;; ANSI specifies that this macro shall exist, even if only as a
429 ;;; trivial placeholder like this.
430 (defmacro step (form)
431 "a trivial placeholder implementation of the CL:STEP macro required by
438 (defun backtrace (&optional (count most-positive-fixnum)
439 (*standard-output* *debug-io*))
441 "Show a listing of the call stack going down from the current frame. In the
442 debugger, the current frame is indicated by the prompt. COUNT is how many
444 (fresh-line *standard-output*)
445 (do ((frame (if *in-the-debugger* *current-frame* (sb!di:top-frame))
446 (sb!di:frame-down frame))
447 (count count (1- count)))
448 ((or (null frame) (zerop count)))
449 (print-frame-call frame :number t))
450 (fresh-line *standard-output*)
455 (eval-when (:compile-toplevel :execute)
457 ;;; This is a convenient way to express what to do for each type of
458 ;;; lambda-list element.
459 (sb!xc:defmacro lambda-list-element-dispatch (element
470 (ecase (car ,element)
471 (:optional ,@optional)
473 (:keyword ,@keyword)))
475 (aver (eq ,element :deleted))
478 (sb!xc:defmacro lambda-var-dispatch (variable location deleted valid other)
479 (let ((var (gensym)))
480 `(let ((,var ,variable))
481 (cond ((eq ,var :deleted) ,deleted)
482 ((eq (sb!di:debug-var-validity ,var ,location) :valid)
488 ;;; This is used in constructing arg lists for debugger printing when
489 ;;; the arg list is unavailable, some arg is unavailable or unused,
491 (defstruct (unprintable-object
492 (:constructor make-unprintable-object (string))
493 (:print-object (lambda (x s)
494 (print-unreadable-object (x s :type t)
495 (write-string (unprintable-object-string x)
500 ;;; Print FRAME with verbosity level 1. If we hit a &REST arg, then
501 ;;; print as many of the values as possible, punting the loop over
502 ;;; lambda-list variables since any other arguments will be in the
503 ;;; &REST arg's list of values.
504 (defun print-frame-call-1 (frame)
505 (let* ((d-fun (sb!di:frame-debug-function frame))
506 (loc (sb!di:frame-code-location frame))
507 (results (list (sb!di:debug-function-name d-fun))))
509 (dolist (ele (sb!di:debug-function-lambda-list d-fun))
510 (lambda-list-element-dispatch ele
511 :required ((push (frame-call-arg ele loc frame) results))
512 :optional ((push (frame-call-arg (second ele) loc frame) results))
513 :keyword ((push (second ele) results)
514 (push (frame-call-arg (third ele) loc frame) results))
515 :deleted ((push (frame-call-arg ele loc frame) results))
516 :rest ((lambda-var-dispatch (second ele) loc
520 (append (reverse (sb!di:debug-var-value
524 (push (make-unprintable-object
525 "unavailable &REST argument")
527 (sb!di:lambda-list-unavailable
529 (push (make-unprintable-object "lambda list unavailable") results)))
530 (pprint-logical-block (*standard-output* nil)
531 (let ((x (nreverse (mapcar #'ensure-printable-object results))))
532 (format t "(~@<~S~{ ~_~S~}~:>)" (first x) (rest x))))
533 (when (sb!di:debug-function-kind d-fun)
535 (prin1 (sb!di:debug-function-kind d-fun))
538 (defun ensure-printable-object (object)
540 (with-open-stream (out (make-broadcast-stream))
544 (declare (ignore cond))
545 (make-unprintable-object "error printing object"))))
547 (defun frame-call-arg (var location frame)
548 (lambda-var-dispatch var location
549 (make-unprintable-object "unused argument")
550 (sb!di:debug-var-value var frame)
551 (make-unprintable-object "unavailable argument")))
553 ;;; Prints a representation of the function call causing FRAME to
554 ;;; exist. VERBOSITY indicates the level of information to output;
555 ;;; zero indicates just printing the debug-function's name, and one
556 ;;; indicates displaying call-like, one-liner format with argument
558 (defun print-frame-call (frame &key (verbosity 1) (number nil))
562 (format t "~&~S: " (sb!di:frame-number frame)))
563 (format t "~S" frame))
566 (format t "~&~S: " (sb!di:frame-number frame)))
567 (print-frame-call-1 frame)))
568 (when (>= verbosity 2)
569 (let ((loc (sb!di:frame-code-location frame)))
572 (sb!di:code-location-debug-block loc)
573 (format t "~%source: ")
574 (print-code-location-source-form loc 0))
575 (sb!di:debug-condition (ignore) ignore)
576 (error (c) (format t "error finding source: ~A" c))))))
580 (defvar *debugger-hook* nil
582 "This is either NIL or a function of two arguments, a condition and the value
583 of *DEBUGGER-HOOK*. This function can either handle the condition or return
584 which causes the standard debugger to execute. The system passes the value
585 of this variable to the function because it binds *DEBUGGER-HOOK* to NIL
586 around the invocation.")
588 ;;; These are bound on each invocation of INVOKE-DEBUGGER.
589 (defvar *debug-restarts*)
590 (defvar *debug-condition*)
592 (defun invoke-debugger (condition)
594 "Enter the debugger."
595 (let ((old-hook *debugger-hook*))
597 (let ((*debugger-hook* nil))
598 (funcall old-hook condition old-hook))))
599 (sb!unix:unix-sigsetmask 0)
601 ;; Elsewhere in the system, we use the SANE-PACKAGE function for
602 ;; this, but here causing an exception just as we're trying to handle
603 ;; an exception would be confusing, so instead we use a special hack.
604 (unless (and (packagep *package*)
605 (package-name *package*))
606 (setf *package* (find-package :cl-user))
607 (format *error-output*
608 "The value of ~S was not an undeleted PACKAGE. It has been
610 '*package* *package*))
611 (let (;; Save *PACKAGE* to protect it from WITH-STANDARD-IO-SYNTAX.
612 (original-package *package*))
613 (with-standard-io-syntax
614 (let* ((*debug-condition* condition)
615 (*debug-restarts* (compute-restarts condition))
616 ;; We want the i/o subsystem to be in a known, useful
617 ;; state, regardless of where the debugger was invoked in
618 ;; the program. WITH-STANDARD-IO-SYNTAX does some of that,
620 ;; 1. It doesn't affect our internal special variables
621 ;; like *CURRENT-LEVEL*.
622 ;; 2. It isn't customizable.
623 ;; 3. It doesn't set *PRINT-READABLY* or *PRINT-PRETTY*
624 ;; to the same value as the toplevel default.
625 ;; 4. It sets *PACKAGE* to COMMON-LISP-USER, which is not
626 ;; helpful behavior for a debugger.
627 ;; We try to remedy all these problems with explicit
629 (sb!kernel:*current-level* 0)
630 (*print-length* *debug-print-length*)
631 (*print-level* *debug-print-level*)
632 (*readtable* *debug-readtable*)
633 (*print-readably* nil)
635 (*package* original-package))
637 ;; Before we start our own output, finish any pending output.
638 ;; Otherwise, if the user tried to track the progress of
639 ;; his program using PRINT statements, he'd tend to lose
640 ;; the last line of output or so, and get confused.
641 (flush-standard-output-streams)
643 ;; (The initial output here goes to *ERROR-OUTPUT*, because the
644 ;; initial output is not interactive, just an error message,
645 ;; and when people redirect *ERROR-OUTPUT*, they could
646 ;; reasonably expect to see error messages logged there,
647 ;; regardless of what the debugger does afterwards.)
649 (format *error-output*
650 "~2&~@<debugger invoked on condition of type ~S: ~
652 (type-of *debug-condition*)
655 (format *error-output*
656 "~&(caught ~S trying to print ~S when entering debugger)~%"
658 '*debug-condition*)))
660 ;; After the initial error/condition/whatever announcement to
661 ;; *ERROR-OUTPUT*, we become interactive, and should talk on
662 ;; *DEBUG-IO* from now on. (KLUDGE: This is a normative
663 ;; statement, not a description of reality.:-| There's a lot of
664 ;; older debugger code which was written to do i/o on whatever
665 ;; stream was in fashion at the time, and not all of it has
666 ;; been converted to behave this way. -- WHN 2000-11-16)
667 (let (;; FIXME: The first two bindings here seem wrong,
668 ;; violating the principle of least surprise, and making
669 ;; it impossible for the user to do reasonable things
670 ;; like using PRINT at the debugger prompt to send output
671 ;; to the program's ordinary (possibly
672 ;; redirected-to-a-file) *STANDARD-OUTPUT*, or using
673 ;; PEEK-CHAR or some such thing on the program's ordinary
674 ;; (possibly also redirected) *STANDARD-INPUT*.
675 (*standard-input* *debug-io*)
676 (*standard-output* *debug-io*)
677 ;; This seems reasonable: e.g. if the user has redirected
678 ;; *ERROR-OUTPUT* to some log file, it's probably wrong
679 ;; to send errors which occur in interactive debugging to
680 ;; that file, and right to send them to *DEBUG-IO*.
681 (*error-output* *debug-io*))
682 (unless (typep condition 'step-condition)
683 (when *debug-beginner-help-p*
685 "~%~@<Within the debugger, you can type HELP for help. ~
686 At any command prompt (within the debugger or not) you ~
687 can type (SB-EXT:QUIT) to terminate the SBCL ~
688 executable. The condition which caused the debugger to ~
689 be entered is bound to ~S. You can suppress this ~
690 message by clearing ~S.~:@>~2%"
692 '*debug-beginner-help-p*))
693 (show-restarts *debug-restarts* *debug-io*))
694 (internal-debug))))))
696 (defun show-restarts (restarts s)
698 (format s "~&restarts:~%")
702 (dolist (restart restarts)
703 (let ((name (restart-name restart)))
705 (let ((len (length (princ-to-string name))))
706 (when (> len max-name-len)
707 (setf max-name-len len))))))
708 (unless (zerop max-name-len)
709 (incf max-name-len 3))
710 (dolist (restart restarts)
711 (let ((name (restart-name restart)))
712 (cond ((member name names-used)
713 (format s "~& ~2D: ~@VT~A~%" count max-name-len restart))
715 (format s "~& ~2D: [~VA] ~A~%"
716 count (- max-name-len 3) name restart)
717 (push name names-used))))
720 ;;; This calls DEBUG-LOOP, performing some simple initializations
721 ;;; before doing so. INVOKE-DEBUGGER calls this to actually get into
722 ;;; the debugger. SB!KERNEL::ERROR-ERROR calls this in emergencies
723 ;;; to get into a debug prompt as quickly as possible with as little
724 ;;; risk as possible for stepping on whatever is causing recursive
726 (defun internal-debug ()
727 (let ((*in-the-debugger* t)
728 (*read-suppress* nil))
729 (unless (typep *debug-condition* 'step-condition)
730 (clear-input *debug-io*))
732 #!+mp (sb!mp:without-scheduling (debug-loop))))
736 ;;; Note: This defaulted to T in CMU CL. The changed default in SBCL
737 ;;; was motivated by desire to play nicely with ILISP.
738 (defvar *flush-debug-errors* nil
740 "When set, avoid calling INVOKE-DEBUGGER recursively when errors occur while
741 executing in the debugger.")
744 (let* ((*debug-command-level* (1+ *debug-command-level*))
745 (*real-stack-top* (sb!di:top-frame))
746 (*stack-top* (or *stack-top-hint* *real-stack-top*))
747 (*stack-top-hint* nil)
748 (*current-frame* *stack-top*))
749 (handler-bind ((sb!di:debug-condition (lambda (condition)
750 (princ condition *debug-io*)
751 (throw 'debug-loop-catcher nil))))
753 (print-frame-call *current-frame* :verbosity 2)
755 (catch 'debug-loop-catcher
756 (handler-bind ((error #'(lambda (condition)
757 (when *flush-debug-errors*
758 (clear-input *debug-io*)
760 ;; FIXME: Doing input on *DEBUG-IO*
761 ;; and output on T seems broken.
763 "~&error flushed (because ~
765 '*flush-debug-errors*)
766 (throw 'debug-loop-catcher nil)))))
767 ;; We have to bind level for the restart function created by
768 ;; WITH-SIMPLE-RESTART.
769 (let ((level *debug-command-level*)
770 (restart-commands (make-restart-commands)))
771 (with-simple-restart (abort
772 "Reduce debugger level (to debug level ~D)."
774 (debug-prompt *debug-io*)
775 (force-output *debug-io*)
776 (let ((input (sb!int:get-stream-command *debug-io*)))
778 (let ((cmd-fun (debug-command-p
779 (sb!int:stream-command-name input)
783 (error "unknown stream-command: ~S" input))
785 (error "ambiguous debugger command: ~S" cmd-fun))
788 (sb!int:stream-command-args input))))))
791 (cmd-fun (debug-command-p exp
794 (debug-eval-print exp))
797 "~&Your command, ~S, is ambiguous:~%"
799 (dolist (ele cmd-fun)
800 (format t " ~A~%" ele)))
802 (funcall cmd-fun)))))))))))))))
804 ;;; FIXME: As far as I know, the CMU CL X86 codebase has never
805 ;;; supported access to the environment of the debugged function. It
806 ;;; would be really, really nice to make that work! (Until then,
807 ;;; non-NIL *AUTO-EVAL-IN-FRAME* seems to be useless, and as of
808 ;;; sbcl-0.6.10 it even seemed to be actively harmful, since the
809 ;;; debugger gets confused when trying to unwind the frames which
810 ;;; arise in SIGINT interrupts. So it's set to NIL.)
811 (defvar *auto-eval-in-frame* nil
813 "When set, evaluations in the debugger's command loop occur relative
814 to the current frame's environment without the need of debugger
815 forms that explicitly control this kind of evaluation. In an ideal
816 world, the default would be T, but since unfortunately the X86
817 debugger support isn't good enough to make this useful, the
818 default is NIL instead.")
820 ;;; FIXME: We could probably use INTERACTIVE-EVAL for much of this logic.
821 (defun debug-eval-print (expr)
822 (/noshow "entering DEBUG-EVAL-PRINT" expr)
823 (/noshow (fboundp 'compile))
824 (/noshow (and (fboundp 'compile) *auto-eval-in-frame*))
825 (setq +++ ++ ++ + + - - expr)
826 (let* ((values (multiple-value-list
827 (if (and (fboundp 'compile) *auto-eval-in-frame*)
828 (sb!di:eval-in-frame *current-frame* -)
830 (*standard-output* *debug-io*))
831 (/noshow "done with EVAL in DEBUG-EVAL-PRINT")
833 (if values (prin1 (car values)))
834 (dolist (x (cdr values))
837 (setq /// // // / / values)
838 (setq *** ** ** * * (car values))
839 ;; Make sure that nobody passes back an unbound marker.
843 ;; FIXME: The way INTERACTIVE-EVAL does this seems better.
844 (princ "Setting * to NIL (was unbound marker)."))))
846 ;;;; debug loop functions
848 ;;; These commands are functions, not really commands, so that users
849 ;;; can get their hands on the values returned.
851 (eval-when (:execute :compile-toplevel)
853 (sb!xc:defmacro define-var-operation (ref-or-set &optional value-var)
854 `(let* ((temp (etypecase name
855 (symbol (sb!di:debug-function-symbol-variables
856 (sb!di:frame-debug-function *current-frame*)
858 (simple-string (sb!di:ambiguous-debug-vars
859 (sb!di:frame-debug-function *current-frame*)
861 (location (sb!di:frame-code-location *current-frame*))
862 ;; Let's only deal with valid variables.
863 (vars (remove-if-not #'(lambda (v)
864 (eq (sb!di:debug-var-validity v location)
867 (declare (list vars))
869 (error "No known valid variables match ~S." name))
873 '(sb!di:debug-var-value (car vars) *current-frame*))
875 `(setf (sb!di:debug-var-value (car vars) *current-frame*)
878 ;; Since we have more than one, first see whether we have
879 ;; any variables that exactly match the specification.
880 (let* ((name (etypecase name
881 (symbol (symbol-name name))
882 (simple-string name)))
883 ;; FIXME: REMOVE-IF-NOT is deprecated, use STRING/=
885 (exact (remove-if-not (lambda (v)
886 (string= (sb!di:debug-var-symbol-name v)
889 (vars (or exact vars)))
890 (declare (simple-string name)
893 ;; Check now for only having one variable.
897 '(sb!di:debug-var-value (car vars) *current-frame*))
899 `(setf (sb!di:debug-var-value (car vars) *current-frame*)
901 ;; If there weren't any exact matches, flame about
902 ;; ambiguity unless all the variables have the same
907 (string= (sb!di:debug-var-symbol-name v)
908 (sb!di:debug-var-symbol-name (car vars))))
910 (error "specification ambiguous:~%~{ ~A~%~}"
911 (mapcar #'sb!di:debug-var-symbol-name
914 :key #'sb!di:debug-var-symbol-name))))
915 ;; All names are the same, so see whether the user
916 ;; ID'ed one of them.
918 (let ((v (find id vars :key #'sb!di:debug-var-id)))
921 "invalid variable ID, ~D: should have been one of ~S"
923 (mapcar #'sb!di:debug-var-id vars)))
926 '(sb!di:debug-var-value v *current-frame*))
928 `(setf (sb!di:debug-var-value v *current-frame*)
931 (error "Specify variable ID to disambiguate ~S. Use one of ~S."
933 (mapcar #'sb!di:debug-var-id vars)))))))))
937 ;;; FIXME: This doesn't work. It would be real nice we could make it
938 ;;; work! Alas, it doesn't seem to work in CMU CL X86 either..
939 (defun var (name &optional (id 0 id-supplied))
941 "Return a variable's value if possible. NAME is a simple-string or symbol.
942 If it is a simple-string, it is an initial substring of the variable's name.
943 If name is a symbol, it has the same name and package as the variable whose
944 value this function returns. If the symbol is uninterned, then the variable
945 has the same name as the symbol, but it has no package.
947 If name is the initial substring of variables with different names, then
948 this return no values after displaying the ambiguous names. If name
949 determines multiple variables with the same name, then you must use the
950 optional id argument to specify which one you want. If you left id
951 unspecified, then this returns no values after displaying the distinguishing
954 The result of this function is limited to the availability of variable
955 information. This is SETF'able."
956 (define-var-operation :ref))
957 (defun (setf var) (value name &optional (id 0 id-supplied))
958 (define-var-operation :set value))
960 ;;; This returns the COUNT'th arg as the user sees it from args, the
961 ;;; result of SB!DI:DEBUG-FUNCTION-LAMBDA-LIST. If this returns a
962 ;;; potential DEBUG-VAR from the lambda-list, then the second value is
963 ;;; T. If this returns a keyword symbol or a value from a rest arg,
964 ;;; then the second value is NIL.
965 (declaim (ftype (function (index list)) nth-arg))
966 (defun nth-arg (count args)
968 (dolist (ele args (error "The argument specification ~S is out of range."
970 (lambda-list-element-dispatch ele
971 :required ((if (zerop n) (return (values ele t))))
972 :optional ((if (zerop n) (return (values (second ele) t))))
973 :keyword ((cond ((zerop n)
974 (return (values (second ele) nil)))
976 (return (values (third ele) t)))))
977 :deleted ((if (zerop n) (return (values ele t))))
978 :rest ((let ((var (second ele)))
979 (lambda-var-dispatch var (sb!di:frame-code-location
981 (error "unused &REST argument before n'th
984 (sb!di:debug-var-value var *current-frame*)
986 "The argument specification ~S is out of range."
989 (return-from nth-arg (values value nil))
991 (error "invalid &REST argument before n'th argument")))))
996 "Returns the N'th argument's value if possible. Argument zero is the first
997 argument in a frame's default printed representation. Count keyword/value
998 pairs as separate arguments."
999 (multiple-value-bind (var lambda-var-p)
1000 (nth-arg n (handler-case (sb!di:debug-function-lambda-list
1001 (sb!di:frame-debug-function *current-frame*))
1002 (sb!di:lambda-list-unavailable ()
1003 (error "No argument values are available."))))
1005 (lambda-var-dispatch var (sb!di:frame-code-location *current-frame*)
1006 (error "Unused arguments have no values.")
1007 (sb!di:debug-var-value var *current-frame*)
1008 (error "invalid argument value"))
1011 ;;;; machinery for definition of debug loop commands
1013 (defvar *debug-commands* nil)
1015 ;;; Interface to *DEBUG-COMMANDS*. No required arguments in args are
1017 (defmacro !def-debug-command (name args &rest body)
1018 (let ((fun-name (symbolicate name "-DEBUG-COMMAND")))
1020 (setf *debug-commands*
1021 (remove ,name *debug-commands* :key #'car :test #'string=))
1022 (defun ,fun-name ,args
1023 (unless *in-the-debugger*
1024 (error "invoking debugger command while outside the debugger"))
1026 (push (cons ,name #',fun-name) *debug-commands*)
1029 (defun !def-debug-command-alias (new-name existing-name)
1030 (let ((pair (assoc existing-name *debug-commands* :test #'string=)))
1031 (unless pair (error "unknown debug command name: ~S" existing-name))
1032 (push (cons new-name (cdr pair)) *debug-commands*))
1035 ;;; This takes a symbol and uses its name to find a debugger command,
1036 ;;; using initial substring matching. It returns the command function
1037 ;;; if form identifies only one command, but if form is ambiguous,
1038 ;;; this returns a list of the command names. If there are no matches,
1039 ;;; this returns nil. Whenever the loop that looks for a set of
1040 ;;; possibilities encounters an exact name match, we return that
1041 ;;; command function immediately.
1042 (defun debug-command-p (form &optional other-commands)
1043 (if (or (symbolp form) (integerp form))
1047 (format nil "~D" form)))
1050 (declare (simple-string name)
1054 ;; Find matching commands, punting if exact match.
1055 (flet ((match-command (ele)
1056 (let* ((str (car ele))
1057 (str-len (length str)))
1058 (declare (simple-string str)
1060 (cond ((< str-len len))
1062 (when (string= name str :end1 len :end2 len)
1063 (return-from debug-command-p (cdr ele))))
1064 ((string= name str :end1 len :end2 len)
1066 (mapc #'match-command *debug-commands*)
1067 (mapc #'match-command other-commands))
1069 ;; Return the right value.
1070 (cond ((not res) nil)
1073 (t ; Just return the names.
1074 (do ((cmds res (cdr cmds)))
1076 (setf (car cmds) (caar cmds))))))))
1078 ;;; Return a list of debug commands (in the same format as
1079 ;;; *debug-commands*) that invoke each active restart.
1081 ;;; Two commands are made for each restart: one for the number, and
1082 ;;; one for the restart name (unless it's been shadowed by an earlier
1083 ;;; restart of the same name, or it is NIL).
1084 (defun make-restart-commands (&optional (restarts *debug-restarts*))
1086 (num 0)) ; better be the same as show-restarts!
1087 (dolist (restart restarts)
1088 (let ((name (string (restart-name restart))))
1090 #'(lambda () (invoke-restart-interactively restart))))
1091 (push (cons (format nil "~d" num) restart-fun) commands)
1092 (unless (or (null (restart-name restart))
1093 (find name commands :key #'car :test #'string=))
1094 (push (cons name restart-fun) commands))))
1098 ;;;; frame-changing commands
1100 (!def-debug-command "UP" ()
1101 (let ((next (sb!di:frame-up *current-frame*)))
1103 (setf *current-frame* next)
1104 (print-frame-call next))
1106 (format t "~&Top of stack.")))))
1108 (!def-debug-command "DOWN" ()
1109 (let ((next (sb!di:frame-down *current-frame*)))
1111 (setf *current-frame* next)
1112 (print-frame-call next))
1114 (format t "~&Bottom of stack.")))))
1116 (!def-debug-command-alias "D" "DOWN")
1118 ;;; CMU CL had this command, but SBCL doesn't, since it's redundant
1119 ;;; with "FRAME 0", and it interferes with abbreviations for the
1120 ;;; TOPLEVEL restart.
1121 ;;;(!def-debug-command "TOP" ()
1122 ;;; (do ((prev *current-frame* lead)
1123 ;;; (lead (sb!di:frame-up *current-frame*) (sb!di:frame-up lead)))
1125 ;;; (setf *current-frame* prev)
1126 ;;; (print-frame-call prev))))
1128 (!def-debug-command "BOTTOM" ()
1129 (do ((prev *current-frame* lead)
1130 (lead (sb!di:frame-down *current-frame*) (sb!di:frame-down lead)))
1132 (setf *current-frame* prev)
1133 (print-frame-call prev))))
1135 (!def-debug-command-alias "B" "BOTTOM")
1137 (!def-debug-command "FRAME" (&optional
1138 (n (read-prompting-maybe "frame number: ")))
1139 (setf *current-frame*
1140 (multiple-value-bind (next-frame-fun limit-string)
1141 (if (< n (sb!di:frame-number *current-frame*))
1142 (values #'sb!di:frame-up "top")
1143 (values #'sb!di:frame-down "bottom"))
1144 (do ((frame *current-frame*))
1145 ((= n (sb!di:frame-number frame))
1147 (let ((next-frame (funcall next-frame-fun frame)))
1149 (setf frame next-frame))
1152 "The ~A of the stack was encountered.~%"
1154 (return frame)))))))
1155 (print-frame-call *current-frame*))
1157 (!def-debug-command-alias "F" "FRAME")
1159 ;;;; commands for entering and leaving the debugger
1161 ;;; CMU CL supported this QUIT debug command, but SBCL provides this
1162 ;;; functionality with a restart instead. (The QUIT debug command was
1163 ;;; removed because it's confusing to have "quit" mean two different
1164 ;;; things in the system, "restart the top level REPL" in the debugger
1165 ;;; and "terminate the Lisp system" as the SB-EXT:QUIT function.)
1167 ;;;(!def-debug-command "QUIT" ()
1168 ;;; (throw 'sb!impl::top-level-catcher nil))
1170 ;;; CMU CL supported this GO debug command, but SBCL doesn't -- in
1171 ;;; SBCL you just type the CONTINUE restart name instead (or "RESTART
1172 ;;; CONTINUE", that's OK too).
1174 ;;;(!def-debug-command "GO" ()
1175 ;;; (continue *debug-condition*)
1176 ;;; (error "There is no restart named CONTINUE."))
1178 (!def-debug-command "RESTART" ()
1179 (let ((num (read-if-available :prompt)))
1180 (when (eq num :prompt)
1181 (show-restarts *debug-restarts* *debug-io*)
1182 (write-string "restart: ")
1184 (setf num (read *standard-input*)))
1185 (let ((restart (typecase num
1187 (nth num *debug-restarts*))
1189 (find num *debug-restarts* :key #'restart-name
1190 :test #'(lambda (sym1 sym2)
1191 (string= (symbol-name sym1)
1192 (symbol-name sym2)))))
1194 (format t "~S is invalid as a restart name.~%" num)
1195 (return-from restart-debug-command nil)))))
1197 (invoke-restart-interactively restart)
1198 ;; FIXME: Even if this isn't handled by WARN, it probably
1199 ;; shouldn't go to *STANDARD-OUTPUT*, but *ERROR-OUTPUT* or
1200 ;; *QUERY-IO* or something. Look through this file to
1201 ;; straighten out stream usage.
1202 (princ "There is no such restart.")))))
1204 ;;;; information commands
1206 (!def-debug-command "HELP" ()
1207 ;; CMU CL had a little toy pager here, but "if you aren't running
1208 ;; ILISP (or a smart windowing system, or something) you deserve to
1209 ;; lose", so we've dropped it in SBCL. However, in case some
1210 ;; desperate holdout is running this on a dumb terminal somewhere,
1211 ;; we tell him where to find the message stored as a string.
1213 "~&~A~2%(The HELP string is stored in ~S.)~%"
1215 '*debug-help-string*))
1217 (!def-debug-command-alias "?" "HELP")
1219 (!def-debug-command "ERROR" ()
1220 (format *debug-io* "~A~%" *debug-condition*)
1221 (show-restarts *debug-restarts* *debug-io*))
1223 (!def-debug-command "BACKTRACE" ()
1224 (backtrace (read-if-available most-positive-fixnum)))
1226 (!def-debug-command "PRINT" ()
1227 (print-frame-call *current-frame*))
1229 (!def-debug-command-alias "P" "PRINT")
1231 (!def-debug-command "LIST-LOCALS" ()
1232 (let ((d-fun (sb!di:frame-debug-function *current-frame*)))
1233 (if (sb!di:debug-var-info-available d-fun)
1234 (let ((*standard-output* *debug-io*)
1235 (location (sb!di:frame-code-location *current-frame*))
1236 (prefix (read-if-available nil))
1239 (dolist (v (sb!di:ambiguous-debug-vars
1241 (if prefix (string prefix) "")))
1243 (when (eq (sb!di:debug-var-validity v location) :valid)
1244 (setf any-valid-p t)
1245 (format t "~S~:[#~D~;~*~] = ~S~%"
1246 (sb!di:debug-var-symbol v)
1247 (zerop (sb!di:debug-var-id v))
1248 (sb!di:debug-var-id v)
1249 (sb!di:debug-var-value v *current-frame*))))
1253 (format t "There are no local variables ~@[starting with ~A ~]~
1257 (format t "All variables ~@[starting with ~A ~]currently ~
1258 have invalid values."
1260 (write-line "There is no variable information available."))))
1262 (!def-debug-command-alias "L" "LIST-LOCALS")
1264 (!def-debug-command "SOURCE" ()
1266 (print-code-location-source-form (sb!di:frame-code-location *current-frame*)
1267 (read-if-available 0)))
1269 ;;;; source location printing
1271 ;;; We cache a stream to the last valid file debug source so that we
1272 ;;; won't have to repeatedly open the file.
1274 ;;; KLUDGE: This sounds like a bug, not a feature. Opening files is fast
1275 ;;; in the 1990s, so the benefit is negligible, less important than the
1276 ;;; potential of extra confusion if someone changes the source during
1277 ;;; a debug session and the change doesn't show up. And removing this
1278 ;;; would simplify the system, which I like. -- WHN 19990903
1279 (defvar *cached-debug-source* nil)
1280 (declaim (type (or sb!di:debug-source null) *cached-debug-source*))
1281 (defvar *cached-source-stream* nil)
1282 (declaim (type (or stream null) *cached-source-stream*))
1284 ;;; To suppress the read-time evaluation #. macro during source read,
1285 ;;; *READTABLE* is modified. *READTABLE* is cached to avoid
1286 ;;; copying it each time, and invalidated when the
1287 ;;; *CACHED-DEBUG-SOURCE* has changed.
1288 (defvar *cached-readtable* nil)
1289 (declaim (type (or readtable null) *cached-readtable*))
1292 (setq *cached-debug-source* nil *cached-source-stream* nil
1293 *cached-readtable* nil))
1294 *before-save-initializations*)
1296 ;;; We also cache the last top-level form that we printed a source for
1297 ;;; so that we don't have to do repeated reads and calls to
1298 ;;; FORM-NUMBER-TRANSLATIONS.
1299 (defvar *cached-top-level-form-offset* nil)
1300 (declaim (type (or index null) *cached-top-level-form-offset*))
1301 (defvar *cached-top-level-form*)
1302 (defvar *cached-form-number-translations*)
1304 ;;; Given a code location, return the associated form-number
1305 ;;; translations and the actual top-level form. We check our cache ---
1306 ;;; if there is a miss, we dispatch on the kind of the debug source.
1307 (defun get-top-level-form (location)
1308 (let ((d-source (sb!di:code-location-debug-source location)))
1309 (if (and (eq d-source *cached-debug-source*)
1310 (eql (sb!di:code-location-top-level-form-offset location)
1311 *cached-top-level-form-offset*))
1312 (values *cached-form-number-translations* *cached-top-level-form*)
1313 (let* ((offset (sb!di:code-location-top-level-form-offset location))
1315 (ecase (sb!di:debug-source-from d-source)
1316 (:file (get-file-top-level-form location))
1317 (:lisp (svref (sb!di:debug-source-name d-source) offset)))))
1318 (setq *cached-top-level-form-offset* offset)
1319 (values (setq *cached-form-number-translations*
1320 (sb!di:form-number-translations res offset))
1321 (setq *cached-top-level-form* res))))))
1323 ;;; Locate the source file (if it still exists) and grab the top-level
1324 ;;; form. If the file is modified, we use the top-level-form offset
1325 ;;; instead of the recorded character offset.
1326 (defun get-file-top-level-form (location)
1327 (let* ((d-source (sb!di:code-location-debug-source location))
1328 (tlf-offset (sb!di:code-location-top-level-form-offset location))
1329 (local-tlf-offset (- tlf-offset
1330 (sb!di:debug-source-root-number d-source)))
1332 (aref (or (sb!di:debug-source-start-positions d-source)
1333 (error "no start positions map"))
1335 (name (sb!di:debug-source-name d-source)))
1336 (unless (eq d-source *cached-debug-source*)
1337 (unless (and *cached-source-stream*
1338 (equal (pathname *cached-source-stream*)
1340 (setq *cached-readtable* nil)
1341 (when *cached-source-stream* (close *cached-source-stream*))
1342 (setq *cached-source-stream* (open name :if-does-not-exist nil))
1343 (unless *cached-source-stream*
1344 (error "The source file no longer exists:~% ~A" (namestring name)))
1345 (format t "~%; file: ~A~%" (namestring name)))
1347 (setq *cached-debug-source*
1348 (if (= (sb!di:debug-source-created d-source)
1349 (file-write-date name))
1353 ((eq *cached-debug-source* d-source)
1354 (file-position *cached-source-stream* char-offset))
1356 (format t "~%; File has been modified since compilation:~%; ~A~@
1357 ; Using form offset instead of character position.~%"
1359 (file-position *cached-source-stream* 0)
1360 (let ((*read-suppress* t))
1361 (dotimes (i local-tlf-offset)
1362 (read *cached-source-stream*)))))
1363 (unless *cached-readtable*
1364 (setq *cached-readtable* (copy-readtable))
1365 (set-dispatch-macro-character
1367 #'(lambda (stream sub-char &rest rest)
1368 (declare (ignore rest sub-char))
1369 (let ((token (read stream t nil t)))
1370 (format nil "#.~S" token)))
1371 *cached-readtable*))
1372 (let ((*readtable* *cached-readtable*))
1373 (read *cached-source-stream*))))
1375 (defun print-code-location-source-form (location context)
1376 (let* ((location (maybe-block-start-location location))
1377 (form-num (sb!di:code-location-form-number location)))
1378 (multiple-value-bind (translations form) (get-top-level-form location)
1379 (unless (< form-num (length translations))
1380 (error "The source path no longer exists."))
1381 (prin1 (sb!di:source-path-context form
1382 (svref translations form-num)
1385 ;;; breakpoint and step commands
1387 ;;; Step to the next code-location.
1388 (!def-debug-command "STEP" ()
1389 (setf *number-of-steps* (read-if-available 1))
1390 (set-step-breakpoint *current-frame*)
1391 (continue *debug-condition*)
1392 (error "couldn't continue"))
1394 ;;; List possible breakpoint locations, which ones are active, and
1395 ;;; where the CONTINUE restart will transfer control. Set
1396 ;;; *POSSIBLE-BREAKPOINTS* to the code-locations which can then be
1397 ;;; used by sbreakpoint.
1398 (!def-debug-command "LIST-LOCATIONS" ()
1399 (let ((df (read-if-available *default-breakpoint-debug-function*)))
1401 (setf df (sb!di:function-debug-function (eval df)))
1402 (setf *default-breakpoint-debug-function* df))
1404 (not *default-breakpoint-debug-function*))
1405 (setf df (sb!di:frame-debug-function *current-frame*))
1406 (setf *default-breakpoint-debug-function* df)))
1407 (setf *possible-breakpoints* (possible-breakpoints df)))
1408 (let ((continue-at (sb!di:frame-code-location *current-frame*)))
1409 (let ((active (location-in-list *default-breakpoint-debug-function*
1410 *breakpoints* :function-start))
1411 (here (sb!di:code-location=
1412 (sb!di:debug-function-start-location
1413 *default-breakpoint-debug-function*) continue-at)))
1414 (when (or active here)
1415 (format t "::FUNCTION-START ")
1416 (when active (format t " *Active*"))
1417 (when here (format t " *Continue here*"))))
1419 (let ((prev-location nil)
1424 (let ((this-num (1- this-num)))
1425 (if (= prev-num this-num)
1426 (format t "~&~D: " prev-num)
1427 (format t "~&~D-~D: " prev-num this-num)))
1428 (print-code-location-source-form prev-location 0)
1429 (when *print-location-kind*
1430 (format t "~S " (sb!di:code-location-kind prev-location)))
1431 (when (location-in-list prev-location *breakpoints*)
1432 (format t " *Active*"))
1433 (when (sb!di:code-location= prev-location continue-at)
1434 (format t " *Continue here*")))))
1436 (dolist (code-location *possible-breakpoints*)
1437 (when (or *print-location-kind*
1438 (location-in-list code-location *breakpoints*)
1439 (sb!di:code-location= code-location continue-at)
1441 (not (eq (sb!di:code-location-debug-source code-location)
1442 (sb!di:code-location-debug-source prev-location)))
1443 (not (eq (sb!di:code-location-top-level-form-offset
1445 (sb!di:code-location-top-level-form-offset
1447 (not (eq (sb!di:code-location-form-number code-location)
1448 (sb!di:code-location-form-number prev-location))))
1450 (setq prev-location code-location prev-num this-num))
1454 (when (location-in-list *default-breakpoint-debug-function*
1457 (format t "~&::FUNCTION-END *Active* "))))
1459 (!def-debug-command-alias "LL" "LIST-LOCATIONS")
1461 ;;; Set breakpoint at the given number.
1462 (!def-debug-command "BREAKPOINT" ()
1463 (let ((index (read-prompting-maybe "location number, :START, or :END: "))
1467 (print-functions nil)
1470 (place *default-breakpoint-debug-function*))
1471 (flet ((get-command-line ()
1472 (let ((command-line nil)
1475 (let ((next-input (read-if-available unique)))
1476 (when (eq next-input unique) (return))
1477 (push next-input command-line)))
1478 (nreverse command-line)))
1479 (set-vars-from-command-line (command-line)
1480 (do ((arg (pop command-line) (pop command-line)))
1483 (:condition (setf condition (pop command-line)))
1484 (:print (push (pop command-line) print))
1485 (:break (setf break (pop command-line)))
1487 (setf function (eval (pop command-line)))
1488 (setf *default-breakpoint-debug-function*
1489 (sb!di:function-debug-function function))
1490 (setf place *default-breakpoint-debug-function*)
1491 (setf *possible-breakpoints*
1492 (possible-breakpoints
1493 *default-breakpoint-debug-function*))))))
1494 (setup-function-start ()
1495 (let ((code-loc (sb!di:debug-function-start-location place)))
1496 (setf bp (sb!di:make-breakpoint #'main-hook-function
1498 :kind :function-start))
1499 (setf break (sb!di:preprocess-for-eval break code-loc))
1500 (setf condition (sb!di:preprocess-for-eval condition code-loc))
1501 (dolist (form print)
1502 (push (cons (sb!di:preprocess-for-eval form code-loc) form)
1504 (setup-function-end ()
1506 (sb!di:make-breakpoint #'main-hook-function
1508 :kind :function-end))
1510 ;; FIXME: These and any other old (COERCE `(LAMBDA ..) ..)
1511 ;; forms should be converted to shiny new (LAMBDA ..) forms.
1512 ;; (Search the sources for "coerce.*\(lambda".)
1513 (coerce `(lambda (dummy)
1514 (declare (ignore dummy)) ,break)
1516 (setf condition (coerce `(lambda (dummy)
1517 (declare (ignore dummy)) ,condition)
1519 (dolist (form print)
1521 (coerce `(lambda (dummy)
1522 (declare (ignore dummy)) ,form) 'function)
1525 (setup-code-location ()
1526 (setf place (nth index *possible-breakpoints*))
1527 (setf bp (sb!di:make-breakpoint #'main-hook-function
1529 :kind :code-location))
1530 (dolist (form print)
1532 (sb!di:preprocess-for-eval form place)
1535 (setf break (sb!di:preprocess-for-eval break place))
1536 (setf condition (sb!di:preprocess-for-eval condition place))))
1537 (set-vars-from-command-line (get-command-line))
1539 ((or (eq index :start) (eq index :s))
1540 (setup-function-start))
1541 ((or (eq index :end) (eq index :e))
1542 (setup-function-end))
1544 (setup-code-location)))
1545 (sb!di:activate-breakpoint bp)
1546 (let* ((new-bp-info (create-breakpoint-info place bp index
1548 :print print-functions
1549 :condition condition))
1550 (old-bp-info (location-in-list new-bp-info *breakpoints*)))
1552 (sb!di:deactivate-breakpoint (breakpoint-info-breakpoint
1554 (setf *breakpoints* (remove old-bp-info *breakpoints*))
1555 (format t "previous breakpoint removed~%"))
1556 (push new-bp-info *breakpoints*))
1557 (print-breakpoint-info (first *breakpoints*))
1558 (format t "~&added"))))
1560 (!def-debug-command-alias "BP" "BREAKPOINT")
1562 ;;; List all breakpoints which are set.
1563 (!def-debug-command "LIST-BREAKPOINTS" ()
1565 (sort *breakpoints* #'< :key #'breakpoint-info-breakpoint-number))
1566 (dolist (info *breakpoints*)
1567 (print-breakpoint-info info)))
1569 (!def-debug-command-alias "LB" "LIST-BREAKPOINTS")
1570 (!def-debug-command-alias "LBP" "LIST-BREAKPOINTS")
1572 ;;; Remove breakpoint N, or remove all breakpoints if no N given.
1573 (!def-debug-command "DELETE-BREAKPOINT" ()
1574 (let* ((index (read-if-available nil))
1576 (find index *breakpoints* :key #'breakpoint-info-breakpoint-number)))
1578 (sb!di:delete-breakpoint (breakpoint-info-breakpoint bp-info))
1579 (setf *breakpoints* (remove bp-info *breakpoints*))
1580 (format t "breakpoint ~S removed~%" index))
1581 (index (format t "The breakpoint doesn't exist."))
1583 (dolist (ele *breakpoints*)
1584 (sb!di:delete-breakpoint (breakpoint-info-breakpoint ele)))
1585 (setf *breakpoints* nil)
1586 (format t "all breakpoints deleted~%")))))
1588 (!def-debug-command-alias "DBP" "DELETE-BREAKPOINT")
1590 ;;; miscellaneous commands
1592 (!def-debug-command "DESCRIBE" ()
1593 (let* ((curloc (sb!di:frame-code-location *current-frame*))
1594 (debug-fun (sb!di:code-location-debug-function curloc))
1595 (function (sb!di:debug-function-function debug-fun)))
1598 (format t "can't figure out the function for this frame"))))
1600 ;;;; debug loop command utilities
1602 (defun read-prompting-maybe (prompt &optional (in *standard-input*)
1603 (out *standard-output*))
1604 (unless (sb!int:listen-skip-whitespace in)
1609 (defun read-if-available (default &optional (stream *standard-input*))
1610 (if (sb!int:listen-skip-whitespace stream)