src/code/debug.lisp

   1 ;;;; the debugger
   2
   3 ;;;; This software is part of the SBCL system. See the README file for
   4 ;;;; more information.
   5 ;;;;
   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.
  11
  12 (in-package "SB!DEBUG")
  13 \f
  14 ;;;; variables and constants
  15
  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
  30 ;;;           #
  31 ;;;         to satisfy lambda list
  32 ;;;           #:
  33 ;;;         exactly 2 expected, but 5 found
  34 (defvar *debug-print-variable-alist* nil
  35   #!+sb-doc
  36   "an association list describing new bindings for special variables
  37 to be used within the debugger. Eg.
  38
  39  ((*PRINT-LENGTH* . 10) (*PRINT-LEVEL* . 6) (*PRINT-PRETTY* . NIL))
  40
  41 The variables in the CAR positions are bound to the values in the CDR
  42 during the execution of some debug commands. When evaluating arbitrary
  43 expressions in the debugger, the normal values of the printer control
  44 variables are in effect.
  45
  46 Initially empty, *DEBUG-PRINT-VARIABLE-ALIST* is typically used to
  47 provide bindings for printer control variables.")
  48
  49 (defvar *debug-readtable*
  50   ;; KLUDGE: This can't be initialized in a cold toplevel form,
  51   ;; because the *STANDARD-READTABLE* isn't initialized until after
  52   ;; cold toplevel forms have run. So instead we initialize it
  53   ;; immediately after *STANDARD-READTABLE*. -- WHN 20000205
  54   nil
  55   #!+sb-doc
  56   "*READTABLE* for the debugger")
  57
  58 (defvar *in-the-debugger* nil
  59   #!+sb-doc
  60   "This is T while in the debugger.")
  61
  62 ;;; nestedness inside debugger command loops
  63 (defvar *debug-command-level* 0)
  64
  65 ;;; If this is bound before the debugger is invoked, it is used as the
  66 ;;; stack top by the debugger.
  67 (defvar *stack-top-hint* nil)
  68
  69 (defvar *stack-top* nil)
  70 (defvar *real-stack-top* nil)
  71
  72 (defvar *current-frame* nil)
  73
  74 ;;; Beginner-oriented help messages are important because you end up
  75 ;;; in the debugger whenever something bad happens, or if you try to
  76 ;;; get out of the system with Ctrl-C or (EXIT) or EXIT or whatever.
  77 ;;; But after memorizing them the wasted screen space gets annoying..
  78 (defvar *debug-beginner-help-p* t
  79   "Should the debugger display beginner-oriented help messages?")
  80
  81 (defun debug-prompt (stream)
  82   (sb!thread::get-foreground)
  83   (format stream
  84           "~%~W~:[~;[~W~]] "
  85           (sb!di:frame-number *current-frame*)
  86           (> *debug-command-level* 1)
  87           *debug-command-level*))
  88
  89 (defparameter *debug-help-string*
  90 "The debug prompt is square brackets, with number(s) indicating the current
  91   control stack level and, if you've entered the debugger recursively, how
  92   deeply recursed you are.
  93 Any command -- including the name of a restart -- may be uniquely abbreviated.
  94 The debugger rebinds various special variables for controlling i/o, sometimes
  95   to defaults (much like WITH-STANDARD-IO-SYNTAX does) and sometimes to
  96   its own special values, based on SB-EXT:*DEBUG-PRINT-VARIABLE-ALIST*.
  97 Debug commands do not affect *, //, and similar variables, but evaluation in
  98   the debug loop does affect these variables.
  99 SB-DEBUG:*FLUSH-DEBUG-ERRORS* controls whether errors at the debug prompt
 100   drop you deeper into the debugger. The default NIL allows recursive entry
 101   to debugger.
 102
 103 Getting in and out of the debugger:
 104   TOPLEVEL, TOP  exits debugger and returns to top level REPL
 105   RESTART        invokes restart numbered as shown (prompt if not given).
 106   ERROR          prints the error condition and restart cases.
 107
 108   The number of any restart, or its name, or a unique abbreviation for its
 109    name, is a valid command, and is the same as using RESTART to invoke
 110    that restart.
 111
 112 Changing frames:
 113   UP     up frame         DOWN     down frame
 114   BOTTOM bottom frame     FRAME n  frame n (n=0 for top frame)
 115
 116 Inspecting frames:
 117   BACKTRACE [n]  shows n frames going down the stack.
 118   LIST-LOCALS, L lists locals in current frame.
 119   PRINT, P       displays function call for current frame.
 120   SOURCE [n]     displays frame's source form with n levels of enclosing forms.
 121
 122 Stepping:
 123   START Selects the CONTINUE restart if one exists and starts
 124         single-stepping. Single stepping affects only code compiled with
 125         under high DEBUG optimization quality. See User Manual for details.
 126   STEP  Steps into the current form.
 127   NEXT  Steps over the current form.
 128   OUT   Stops stepping temporarily, but resumes it when the topmost frame that
 129         was stepped into returns.
 130   STOP  Stops single-stepping.
 131
 132 Function and macro commands:
 133  (SB-DEBUG:ARG n)
 134     Return the n'th argument in the current frame.
 135  (SB-DEBUG:VAR string-or-symbol [id])
 136     Returns the value of the specified variable in the current frame.
 137
 138 Other commands:
 139   RETURN expr
 140     Return the values resulting from evaluation of expr from the
 141     current frame, if this frame was compiled with a sufficiently high
 142     DEBUG optimization quality.
 143
 144   RESTART-FRAME
 145     Restart execution of the current frame, if this frame is for a
 146     global function which was compiled with a sufficiently high
 147     DEBUG optimization quality.
 148
 149   SLURP
 150     Discard all pending input on *STANDARD-INPUT*. (This can be
 151     useful when the debugger was invoked to handle an error in
 152     deeply nested input syntax, and now the reader is confused.)")
 153 \f
 154
 155 ;;; If LOC is an unknown location, then try to find the block start
 156 ;;; location. Used by source printing to some information instead of
 157 ;;; none for the user.
 158 (defun maybe-block-start-location (loc)
 159   (if (sb!di:code-location-unknown-p loc)
 160       (let* ((block (sb!di:code-location-debug-block loc))
 161              (start (sb!di:do-debug-block-locations (loc block)
 162                       (return loc))))
 163         (cond ((and (not (sb!di:debug-block-elsewhere-p block))
 164                     start)
 165                (format *debug-io* "~%unknown location: using block start~%")
 166                start)
 167               (t
 168                loc)))
 169       loc))
 170 \f
 171 ;;;; BACKTRACE
 172
 173 (defun map-backtrace (thunk &key (start 0) (count most-positive-fixnum))
 174   (loop
 175      with result = nil
 176      for index upfrom 0
 177      for frame = (if *in-the-debugger*
 178                      *current-frame*
 179                      (sb!di:top-frame))
 180                then (sb!di:frame-down frame)
 181      until (null frame)
 182      when (<= start index) do
 183        (if (minusp (decf count))
 184            (return result)
 185            (setf result (funcall thunk frame)))
 186      finally (return result)))
 187
 188 (defun backtrace (&optional (count most-positive-fixnum) (stream *debug-io*))
 189   #!+sb-doc
 190   "Show a listing of the call stack going down from the current frame.
 191 In the debugger, the current frame is indicated by the prompt. COUNT
 192 is how many frames to show."
 193   (fresh-line stream)
 194   (map-backtrace (lambda (frame)
 195                    (print-frame-call frame stream :number t))
 196                  :count count)
 197   (fresh-line stream)
 198   (values))
 199
 200 (defun backtrace-as-list (&optional (count most-positive-fixnum))
 201   #!+sb-doc "Return a list representing the current BACKTRACE."
 202   (let ((reversed-result (list)))
 203     (map-backtrace (lambda (frame)
 204                      (push (frame-call-as-list frame) reversed-result))
 205                    :count count)
 206     (nreverse reversed-result)))
 207
 208 (defun frame-call-as-list (frame)
 209   (multiple-value-bind (name args) (frame-call frame)
 210     (cons name args)))
 211 \f
 212 ;;;; frame printing
 213
 214 (eval-when (:compile-toplevel :execute)
 215
 216 ;;; This is a convenient way to express what to do for each type of
 217 ;;; lambda-list element.
 218 (sb!xc:defmacro lambda-list-element-dispatch (element
 219                                               &key
 220                                               required
 221                                               optional
 222                                               rest
 223                                               keyword
 224                                               deleted)
 225   `(etypecase ,element
 226      (sb!di:debug-var
 227       ,@required)
 228      (cons
 229       (ecase (car ,element)
 230         (:optional ,@optional)
 231         (:rest ,@rest)
 232         (:keyword ,@keyword)))
 233      (symbol
 234       (aver (eq ,element :deleted))
 235       ,@deleted)))
 236
 237 (sb!xc:defmacro lambda-var-dispatch (variable location deleted valid other)
 238   (let ((var (gensym)))
 239     `(let ((,var ,variable))
 240        (cond ((eq ,var :deleted) ,deleted)
 241              ((eq (sb!di:debug-var-validity ,var ,location) :valid)
 242               ,valid)
 243              (t ,other)))))
 244
 245 ) ; EVAL-WHEN
 246
 247 ;;; Extract the function argument values for a debug frame.
 248 (defun map-frame-args (thunk frame)
 249   (let ((debug-fun (sb!di:frame-debug-fun frame)))
 250     (dolist (element (sb!di:debug-fun-lambda-list debug-fun))
 251       (funcall thunk element))))
 252
 253 (defun frame-args-as-list (frame)
 254   (handler-case
 255       (let ((location (sb!di:frame-code-location frame))
 256             (reversed-result nil))
 257         (block enumerating
 258           (map-frame-args
 259            (lambda (element)
 260              (lambda-list-element-dispatch element
 261                :required ((push (frame-call-arg element location frame) reversed-result))
 262                :optional ((push (frame-call-arg (second element) location frame)
 263                                 reversed-result))
 264                :keyword ((push (second element) reversed-result)
 265                          (push (frame-call-arg (third element) location frame)
 266                                reversed-result))
 267                :deleted ((push (frame-call-arg element location frame) reversed-result))
 268                :rest ((lambda-var-dispatch (second element) location
 269                         nil
 270                         (progn
 271                           (setf reversed-result
 272                                 (append (reverse (sb!di:debug-var-value
 273                                                   (second element) frame))
 274                                         reversed-result))
 275                           (return-from enumerating))
 276                         (push (make-unprintable-object
 277                                "unavailable &REST argument")
 278                               reversed-result)))))
 279            frame))
 280         (nreverse reversed-result))
 281     (sb!di:lambda-list-unavailable ()
 282       (make-unprintable-object "unavailable lambda list"))))
 283
 284 (defvar *show-entry-point-details* nil)
 285
 286 (defun clean-xep (name args)
 287   (values (second name)
 288           (if (consp args)
 289               (let ((count (first args))
 290                     (real-args (rest args)))
 291                 (if (fixnump count)
 292                     (subseq real-args 0
 293                             (min count (length real-args)))
 294                     real-args))
 295               args)))
 296
 297 (defun clean-&more-processor (name args)
 298   (values (second name)
 299           (if (consp args)
 300               (let* ((more (last args 2))
 301                      (context (first more))
 302                      (count (second more)))
 303                 (append
 304                  (butlast args 2)
 305                  (if (fixnump count)
 306                      (multiple-value-list
 307                       (sb!c:%more-arg-values context 0 count))
 308                      (list
 309                       (make-unprintable-object "more unavailable arguments")))))
 310               args)))
 311
 312 (defun frame-call (frame)
 313   (labels ((clean-name-and-args (name args)
 314              (if (and (consp name) (not *show-entry-point-details*))
 315                  ;; FIXME: do we need to deal with
 316                  ;; HAIRY-FUNCTION-ENTRY here? I can't make it or
 317                  ;; &AUX-BINDINGS appear in backtraces, so they are
 318                  ;; left alone for now. --NS 2005-02-28
 319                  (case (first name)
 320                    ((sb!c::xep sb!c::tl-xep)
 321                     (clean-xep name args))
 322                    ((sb!c::&more-processor)
 323                     (clean-&more-processor name args))
 324                    ((sb!c::hairy-arg-processor
 325                      sb!c::varargs-entry sb!c::&optional-processor)
 326                     (clean-name-and-args (second name) args))
 327                    (t
 328                     (values name args)))
 329                  (values name args))))
 330     (let ((debug-fun (sb!di:frame-debug-fun frame)))
 331       (multiple-value-bind (name args)
 332           (clean-name-and-args (sb!di:debug-fun-name debug-fun)
 333                                 (frame-args-as-list frame))
 334         (values name args (sb!di:debug-fun-kind debug-fun))))))
 335
 336 (defun ensure-printable-object (object)
 337   (handler-case
 338       (with-open-stream (out (make-broadcast-stream))
 339         (prin1 object out)
 340         object)
 341     (error (cond)
 342       (declare (ignore cond))
 343       (make-unprintable-object "error printing object"))))
 344
 345 (defun frame-call-arg (var location frame)
 346   (lambda-var-dispatch var location
 347     (make-unprintable-object "unused argument")
 348     (sb!di:debug-var-value var frame)
 349     (make-unprintable-object "unavailable argument")))
 350
 351 ;;; Prints a representation of the function call causing FRAME to
 352 ;;; exist. VERBOSITY indicates the level of information to output;
 353 ;;; zero indicates just printing the DEBUG-FUN's name, and one
 354 ;;; indicates displaying call-like, one-liner format with argument
 355 ;;; values.
 356 (defun print-frame-call (frame stream &key (verbosity 1) (number nil))
 357   (when number
 358     (format stream "~&~S: " (sb!di:frame-number frame)))
 359   (if (zerop verbosity)
 360       (let ((*print-readably* nil))
 361         (prin1 frame stream))
 362       (multiple-value-bind (name args kind) (frame-call frame)
 363         (pprint-logical-block (stream nil :prefix "(" :suffix ")")
 364           ;; Since we go to some trouble to make nice informative function
 365           ;; names like (PRINT-OBJECT :AROUND (CLOWN T)), let's make sure
 366           ;; that they aren't truncated by *PRINT-LENGTH* and *PRINT-LEVEL*.
 367           ;; For the function arguments, we can just print normally.
 368           (let ((*print-length* nil)
 369                 (*print-level* nil))
 370             (prin1 (ensure-printable-object name) stream))
 371           ;; If we hit a &REST arg, then print as many of the values as
 372           ;; possible, punting the loop over lambda-list variables since any
 373           ;; other arguments will be in the &REST arg's list of values.
 374           (let ((args (ensure-printable-object args)))
 375             (if (listp args)
 376                 (format stream "~{ ~_~S~}" args)
 377                 (format stream " ~S" args))))
 378         (when kind
 379           (format stream "[~S]" kind))))
 380   (when (>= verbosity 2)
 381     (let ((loc (sb!di:frame-code-location frame)))
 382       (handler-case
 383           (progn
 384             ;; FIXME: Is this call really necessary here? If it is,
 385             ;; then the reason for it should be unobscured.
 386             (sb!di:code-location-debug-block loc)
 387             (format stream "~%source: ")
 388             (prin1 (code-location-source-form loc 0) stream))
 389         (sb!di:debug-condition (ignore)
 390           ignore)
 391         (error (c)
 392           (format stream "~&error finding source: ~A" c))))))
 393 \f
 394 ;;;; INVOKE-DEBUGGER
 395
 396 (defvar *debugger-hook* nil
 397   #!+sb-doc
 398   "This is either NIL or a function of two arguments, a condition and the value
 399    of *DEBUGGER-HOOK*. This function can either handle the condition or return
 400    which causes the standard debugger to execute. The system passes the value
 401    of this variable to the function because it binds *DEBUGGER-HOOK* to NIL
 402    around the invocation.")
 403
 404 (defvar *invoke-debugger-hook* nil
 405   #!+sb-doc
 406   "This is either NIL or a designator for a function of two arguments,
 407    to be run when the debugger is about to be entered.  The function is
 408    run with *INVOKE-DEBUGGER-HOOK* bound to NIL to minimize recursive
 409    errors, and receives as arguments the condition that triggered
 410    debugger entry and the previous value of *INVOKE-DEBUGGER-HOOK*
 411
 412    This mechanism is an SBCL extension similar to the standard *DEBUGGER-HOOK*.
 413    In contrast to *DEBUGGER-HOOK*, it is observed by INVOKE-DEBUGGER even when
 414    called by BREAK.")
 415
 416 ;;; These are bound on each invocation of INVOKE-DEBUGGER.
 417 (defvar *debug-restarts*)
 418 (defvar *debug-condition*)
 419 (defvar *nested-debug-condition*)
 420
 421 ;;; Oh, what a tangled web we weave when we preserve backwards
 422 ;;; compatibility with 1968-style use of global variables to control
 423 ;;; per-stream i/o properties; there's really no way to get this
 424 ;;; quite right, but we do what we can.
 425 (defun funcall-with-debug-io-syntax (fun &rest rest)
 426   (declare (type function fun))
 427   ;; Try to force the other special variables into a useful state.
 428   (let (;; Protect from WITH-STANDARD-IO-SYNTAX some variables where
 429         ;; any default we might use is less useful than just reusing
 430         ;; the global values.
 431         (original-package *package*)
 432         (original-print-pretty *print-pretty*))
 433     (with-standard-io-syntax
 434       (with-sane-io-syntax
 435           (let (;; We want the printer and reader to be in a useful
 436                 ;; state, regardless of where the debugger was invoked
 437                 ;; in the program. WITH-STANDARD-IO-SYNTAX and
 438                 ;; WITH-SANE-IO-SYNTAX do much of what we want, but
 439                 ;;   * It doesn't affect our internal special variables
 440                 ;;     like *CURRENT-LEVEL-IN-PRINT*.
 441                 ;;   * It isn't customizable.
 442                 ;;   * It sets *PACKAGE* to COMMON-LISP-USER, which is not
 443                 ;;     helpful behavior for a debugger.
 444                 ;;   * There's no particularly good debugger default for
 445                 ;;     *PRINT-PRETTY*, since T is usually what you want
 446                 ;;     -- except absolutely not what you want when you're
 447                 ;;     debugging failures in PRINT-OBJECT logic.
 448                 ;; We try to address all these issues with explicit
 449                 ;; rebindings here.
 450                 (sb!kernel:*current-level-in-print* 0)
 451                 (*package* original-package)
 452                 (*print-pretty* original-print-pretty)
 453                 ;; Clear the circularity machinery to try to to reduce the
 454                 ;; pain from sharing the circularity table across all
 455                 ;; streams; if these are not rebound here, then setting
 456                 ;; *PRINT-CIRCLE* within the debugger when debugging in a
 457                 ;; state where something circular was being printed (e.g.,
 458                 ;; because the debugger was entered on an error in a
 459                 ;; PRINT-OBJECT method) makes a hopeless mess. Binding them
 460                 ;; here does seem somewhat ugly because it makes it more
 461                 ;; difficult to debug the printing-of-circularities code
 462                 ;; itself; however, as far as I (WHN, 2004-05-29) can see,
 463                 ;; that's almost entirely academic as long as there's one
 464                 ;; shared *C-H-T* for all streams (i.e., it's already
 465                 ;; unreasonably difficult to debug print-circle machinery
 466                 ;; given the buggy crosstalk between the debugger streams
 467                 ;; and the stream you're trying to watch), and any fix for
 468                 ;; that buggy arrangement will likely let this hack go away
 469                 ;; naturally.
 470                 (sb!impl::*circularity-hash-table* . nil)
 471                 (sb!impl::*circularity-counter* . nil)
 472                 (*readtable* *debug-readtable*))
 473             (progv
 474                 ;; (Why NREVERSE? PROGV makes the later entries have
 475                 ;; precedence over the earlier entries.
 476                 ;; *DEBUG-PRINT-VARIABLE-ALIST* is called an alist, so it's
 477                 ;; expected that its earlier entries have precedence. And
 478                 ;; the earlier-has-precedence behavior is mostly more
 479                 ;; convenient, so that programmers can use PUSH or LIST* to
 480                 ;; customize *DEBUG-PRINT-VARIABLE-ALIST*.)
 481                 (nreverse (mapcar #'car *debug-print-variable-alist*))
 482                 (nreverse (mapcar #'cdr *debug-print-variable-alist*))
 483               (apply fun rest)))))))
 484
 485 ;;; This function is not inlined so it shows up in the backtrace; that
 486 ;;; can be rather handy when one has to debug the interplay between
 487 ;;; *INVOKE-DEBUGGER-HOOK* and *DEBUGGER-HOOK*.
 488 (declaim (notinline run-hook))
 489 (defun run-hook (variable condition)
 490   (let ((old-hook (symbol-value variable)))
 491     (when old-hook
 492       (progv (list variable) (list nil)
 493         (funcall old-hook condition old-hook)))))
 494
 495 (defun invoke-debugger (condition)
 496   #!+sb-doc
 497   "Enter the debugger."
 498
 499   ;; call *INVOKE-DEBUGGER-HOOK* first, so that *DEBUGGER-HOOK* is not
 500   ;; called when the debugger is disabled
 501   (run-hook '*invoke-debugger-hook* condition)
 502   (run-hook '*debugger-hook* condition)
 503
 504   ;; We definitely want *PACKAGE* to be of valid type.
 505   ;;
 506   ;; Elsewhere in the system, we use the SANE-PACKAGE function for
 507   ;; this, but here causing an exception just as we're trying to handle
 508   ;; an exception would be confusing, so instead we use a special hack.
 509   (unless (and (packagep *package*)
 510                (package-name *package*))
 511     (setf *package* (find-package :cl-user))
 512     (format *error-output*
 513             "The value of ~S was not an undeleted PACKAGE. It has been
 514 reset to ~S."
 515             '*package* *package*))
 516
 517   ;; Before we start our own output, finish any pending output.
 518   ;; Otherwise, if the user tried to track the progress of his program
 519   ;; using PRINT statements, he'd tend to lose the last line of output
 520   ;; or so, which'd be confusing.
 521   (flush-standard-output-streams)
 522
 523   (funcall-with-debug-io-syntax #'%invoke-debugger condition))
 524
 525 (defun %print-debugger-invocation-reason (condition stream)
 526   (format stream "~2&")
 527   ;; Note: Ordinarily it's only a matter of taste whether to use
 528   ;; FORMAT "~<...~:>" or to use PPRINT-LOGICAL-BLOCK directly, but
 529   ;; until bug 403 is fixed, PPRINT-LOGICAL-BLOCK (STREAM NIL) is
 530   ;; definitely preferred, because the FORMAT alternative was acting odd.
 531   (pprint-logical-block (stream nil)
 532     (format stream
 533             "debugger invoked on a ~S~@[ in thread ~A~]: ~2I~_~A"
 534             (type-of condition)
 535             #!+sb-thread sb!thread:*current-thread*
 536             #!-sb-thread nil
 537             condition))
 538   (terpri stream))
 539
 540 (defun %invoke-debugger (condition)
 541   (let ((*debug-condition* condition)
 542         (*debug-restarts* (compute-restarts condition))
 543         (*nested-debug-condition* nil))
 544     (handler-case
 545         ;; (The initial output here goes to *ERROR-OUTPUT*, because the
 546         ;; initial output is not interactive, just an error message, and
 547         ;; when people redirect *ERROR-OUTPUT*, they could reasonably
 548         ;; expect to see error messages logged there, regardless of what
 549         ;; the debugger does afterwards.)
 550         (unless (typep condition 'step-condition)
 551           (%print-debugger-invocation-reason condition *error-output*))
 552       (error (condition)
 553         (setf *nested-debug-condition* condition)
 554         (let ((ndc-type (type-of *nested-debug-condition*)))
 555           (format *error-output*
 556                   "~&~@<(A ~S was caught when trying to print ~S when ~
 557                       entering the debugger. Printing was aborted and the ~
 558                       ~S was stored in ~S.)~@:>~%"
 559                   ndc-type
 560                   '*debug-condition*
 561                   ndc-type
 562                   '*nested-debug-condition*))
 563         (when (typep *nested-debug-condition* 'cell-error)
 564           ;; what we really want to know when it's e.g. an UNBOUND-VARIABLE:
 565           (format *error-output*
 566                   "~&(CELL-ERROR-NAME ~S) = ~S~%"
 567                   '*nested-debug-condition*
 568                   (cell-error-name *nested-debug-condition*)))))
 569
 570     (let ((background-p (sb!thread::debugger-wait-until-foreground-thread
 571                          *debug-io*)))
 572
 573       ;; After the initial error/condition/whatever announcement to
 574       ;; *ERROR-OUTPUT*, we become interactive, and should talk on
 575       ;; *DEBUG-IO* from now on. (KLUDGE: This is a normative
 576       ;; statement, not a description of reality.:-| There's a lot of
 577       ;; older debugger code which was written to do i/o on whatever
 578       ;; stream was in fashion at the time, and not all of it has
 579       ;; been converted to behave this way. -- WHN 2000-11-16)
 580
 581       (unwind-protect
 582            (let (;; We used to bind *STANDARD-OUTPUT* to *DEBUG-IO*
 583                  ;; here as well, but that is probably bogus since it
 584                  ;; removes the users ability to do output to a redirected
 585                  ;; *S-O*. Now we just rebind it so that users can temporarily
 586                  ;; frob it. FIXME: This and other "what gets bound when"
 587                  ;; behaviour should be documented in the manual.
 588                  (*standard-output* *standard-output*)
 589                  ;; This seems reasonable: e.g. if the user has redirected
 590                  ;; *ERROR-OUTPUT* to some log file, it's probably wrong
 591                  ;; to send errors which occur in interactive debugging to
 592                  ;; that file, and right to send them to *DEBUG-IO*.
 593                  (*error-output* *debug-io*))
 594              (unless (typep condition 'step-condition)
 595                (when *debug-beginner-help-p*
 596                  (format *debug-io*
 597                          "~%~@<Type HELP for debugger help, or ~
 598                                (SB-EXT:QUIT) to exit from SBCL.~:@>~2%"))
 599                (show-restarts *debug-restarts* *debug-io*))
 600              (internal-debug))
 601         (when background-p
 602           (sb!thread::release-foreground))))))
 603
 604 ;;; this function is for use in *INVOKE-DEBUGGER-HOOK* when ordinary
 605 ;;; ANSI behavior has been suppressed by the "--disable-debugger"
 606 ;;; command-line option
 607 (defun debugger-disabled-hook (condition me)
 608   (declare (ignore me))
 609   ;; There is no one there to interact with, so report the
 610   ;; condition and terminate the program.
 611   (flet ((failure-quit (&key recklessly-p)
 612            (/show0 "in FAILURE-QUIT (in --disable-debugger debugger hook)")
 613            (quit :unix-status 1 :recklessly-p recklessly-p)))
 614     ;; This HANDLER-CASE is here mostly to stop output immediately
 615     ;; (and fall through to QUIT) when there's an I/O error. Thus,
 616     ;; when we're run under a shell script or something, we can die
 617     ;; cleanly when the script dies (and our pipes are cut), instead
 618     ;; of falling into ldb or something messy like that. Similarly, we
 619     ;; can terminate cleanly even if BACKTRACE dies because of bugs in
 620     ;; user PRINT-OBJECT methods.
 621     (handler-case
 622         (progn
 623           (format *error-output*
 624                   "~&~@<unhandled ~S~@[ in thread ~S~]: ~2I~_~A~:>~2%"
 625                   (type-of condition)
 626                   #!+sb-thread sb!thread:*current-thread*
 627                   #!-sb-thread nil
 628                   condition)
 629           ;; Flush *ERROR-OUTPUT* even before the BACKTRACE, so that
 630           ;; even if we hit an error within BACKTRACE (e.g. a bug in
 631           ;; the debugger's own frame-walking code, or a bug in a user
 632           ;; PRINT-OBJECT method) we'll at least have the CONDITION
 633           ;; printed out before we die.
 634           (finish-output *error-output*)
 635           ;; (Where to truncate the BACKTRACE is of course arbitrary, but
 636           ;; it seems as though we should at least truncate it somewhere.)
 637           (sb!debug:backtrace 128 *error-output*)
 638           (format
 639            *error-output*
 640            "~%unhandled condition in --disable-debugger mode, quitting~%")
 641           (finish-output *error-output*)
 642           (failure-quit))
 643       (condition ()
 644         ;; We IGNORE-ERRORS here because even %PRIMITIVE PRINT can
 645         ;; fail when our output streams are blown away, as e.g. when
 646         ;; we're running under a Unix shell script and it dies somehow
 647         ;; (e.g. because of a SIGINT). In that case, we might as well
 648         ;; just give it up for a bad job, and stop trying to notify
 649         ;; the user of anything.
 650         ;;
 651         ;; Actually, the only way I've run across to exercise the
 652         ;; problem is to have more than one layer of shell script.
 653         ;; I have a shell script which does
 654         ;;   time nice -10 sh make.sh "$1" 2>&1 | tee make.tmp
 655         ;; and the problem occurs when I interrupt this with Ctrl-C
 656         ;; under Linux 2.2.14-5.0 and GNU bash, version 1.14.7(1).
 657         ;; I haven't figured out whether it's bash, time, tee, Linux, or
 658         ;; what that is responsible, but that it's possible at all
 659         ;; means that we should IGNORE-ERRORS here. -- WHN 2001-04-24
 660         (ignore-errors
 661          (%primitive print
 662                      "Argh! error within --disable-debugger error handling"))
 663         (failure-quit :recklessly-p t)))))
 664
 665 (defvar *old-debugger-hook* nil)
 666
 667 ;;; halt-on-failures and prompt-on-failures modes, suitable for
 668 ;;; noninteractive and interactive use respectively
 669 (defun disable-debugger ()
 670   "When invoked, this function will turn off both the SBCL debugger
 671 and LDB (the low-level debugger).  See also ENABLE-DEBUGGER."
 672   ;; *DEBUG-IO* used to be set here to *ERROR-OUTPUT* which is sort
 673   ;; of unexpected but mostly harmless, but then ENABLE-DEBUGGER had
 674   ;; to set it to a suitable value again and be very careful,
 675   ;; especially if the user has also set it. -- MG 2005-07-15
 676   (unless (eq *invoke-debugger-hook* 'debugger-disabled-hook)
 677     (setf *old-debugger-hook* *invoke-debugger-hook*
 678           *invoke-debugger-hook* 'debugger-disabled-hook))
 679   ;; This is not inside the UNLESS to ensure that LDB is disabled
 680   ;; regardless of what the old value of *INVOKE-DEBUGGER-HOOK* was.
 681   ;; This might matter for example when restoring a core.
 682   (sb!alien:alien-funcall (sb!alien:extern-alien "disable_lossage_handler"
 683                                                  (function sb!alien:void))))
 684
 685 (defun enable-debugger ()
 686   "Restore the debugger if it has been turned off by DISABLE-DEBUGGER."
 687   (when (eql *invoke-debugger-hook* 'debugger-disabled-hook)
 688     (setf *invoke-debugger-hook* *old-debugger-hook*
 689           *old-debugger-hook* nil))
 690   (sb!alien:alien-funcall (sb!alien:extern-alien "enable_lossage_handler"
 691                                                  (function sb!alien:void))))
 692
 693 (defun show-restarts (restarts s)
 694   (cond ((null restarts)
 695          (format s
 696                  "~&(no restarts: If you didn't do this on purpose, ~
 697                   please report it as a bug.)~%"))
 698         (t
 699          (format s "~&restarts (invokable by number or by ~
 700                     possibly-abbreviated name):~%")
 701          (let ((count 0)
 702                (names-used '(nil))
 703                (max-name-len 0))
 704            (dolist (restart restarts)
 705              (let ((name (restart-name restart)))
 706                (when name
 707                  (let ((len (length (princ-to-string name))))
 708                    (when (> len max-name-len)
 709                      (setf max-name-len len))))))
 710            (unless (zerop max-name-len)
 711              (incf max-name-len 3))
 712            (dolist (restart restarts)
 713              (let ((name (restart-name restart)))
 714                ;; FIXME: maybe it would be better to display later names
 715                ;; in parens instead of brakets, not just omit them fully.
 716                ;; Call BREAK, call BREAK in the debugger, and tell me
 717                ;; it's not confusing looking. --NS 20050310
 718                (cond ((member name names-used)
 719                       (format s "~& ~2D: ~V@T~A~%" count max-name-len restart))
 720                      (t
 721                       (format s "~& ~2D: [~VA] ~A~%"
 722                               count (- max-name-len 3) name restart)
 723                       (push name names-used))))
 724              (incf count))))))
 725
 726 (defvar *debug-loop-fun* #'debug-loop-fun
 727   "a function taking no parameters that starts the low-level debug loop")
 728
 729 ;;; When the debugger is invoked due to a stepper condition, we don't
 730 ;;; want to print the current frame before the first prompt for aesthetic
 731 ;;; reasons.
 732 (defvar *suppress-frame-print* nil)
 733
 734 ;;; This calls DEBUG-LOOP, performing some simple initializations
 735 ;;; before doing so. INVOKE-DEBUGGER calls this to actually get into
 736 ;;; the debugger. SB!KERNEL::ERROR-ERROR calls this in emergencies
 737 ;;; to get into a debug prompt as quickly as possible with as little
 738 ;;; risk as possible for stepping on whatever is causing recursive
 739 ;;; errors.
 740 (defun internal-debug ()
 741   (let ((*in-the-debugger* t)
 742         (*read-suppress* nil))
 743     (unless (typep *debug-condition* 'step-condition)
 744       (clear-input *debug-io*))
 745     (let ((*suppress-frame-print* (typep *debug-condition* 'step-condition)))
 746       (funcall *debug-loop-fun*))))
 747 \f
 748 ;;;; DEBUG-LOOP
 749
 750 ;;; Note: This defaulted to T in CMU CL. The changed default in SBCL
 751 ;;; was motivated by desire to play nicely with ILISP.
 752 (defvar *flush-debug-errors* nil
 753   #!+sb-doc
 754   "When set, avoid calling INVOKE-DEBUGGER recursively when errors occur while
 755    executing in the debugger.")
 756
 757 (defun debug-read (stream)
 758   (declare (type stream stream))
 759   (let* ((eof-marker (cons nil nil))
 760          (form (read stream nil eof-marker)))
 761     (if (eq form eof-marker)
 762         (abort)
 763         form)))
 764
 765 (defun debug-loop-fun ()
 766   (let* ((*debug-command-level* (1+ *debug-command-level*))
 767          (*real-stack-top* (sb!di:top-frame))
 768          (*stack-top* (or *stack-top-hint* *real-stack-top*))
 769          (*stack-top-hint* nil)
 770          (*current-frame* *stack-top*))
 771     (handler-bind ((sb!di:debug-condition
 772                     (lambda (condition)
 773                       (princ condition *debug-io*)
 774                       (/show0 "handling d-c by THROWing DEBUG-LOOP-CATCHER")
 775                       (throw 'debug-loop-catcher nil))))
 776       (cond (*suppress-frame-print*
 777              (setf *suppress-frame-print* nil))
 778             (t
 779              (terpri *debug-io*)
 780              (print-frame-call *current-frame* *debug-io* :verbosity 2)))
 781       (loop
 782        (catch 'debug-loop-catcher
 783          (handler-bind ((error (lambda (condition)
 784                                  (when *flush-debug-errors*
 785                                    (clear-input *debug-io*)
 786                                    (princ condition *debug-io*)
 787                                    (format *debug-io*
 788                                            "~&error flushed (because ~
 789                                              ~S is set)"
 790                                            '*flush-debug-errors*)
 791                                    (/show0 "throwing DEBUG-LOOP-CATCHER")
 792                                    (throw 'debug-loop-catcher nil)))))
 793            ;; We have to bind LEVEL for the restart function created by
 794            ;; WITH-SIMPLE-RESTART.
 795            (let ((level *debug-command-level*)
 796                  (restart-commands (make-restart-commands)))
 797              (flush-standard-output-streams)
 798              (debug-prompt *debug-io*)
 799              (force-output *debug-io*)
 800              (let* ((exp (debug-read *debug-io*))
 801                     (cmd-fun (debug-command-p exp restart-commands)))
 802                (with-simple-restart (abort
 803                                      "~@<Reduce debugger level (to debug level ~W).~@:>"
 804                                      level)
 805                  (cond ((not cmd-fun)
 806                         (debug-eval-print exp))
 807                        ((consp cmd-fun)
 808                         (format *debug-io*
 809                                 "~&Your command, ~S, is ambiguous:~%"
 810                                 exp)
 811                         (dolist (ele cmd-fun)
 812                           (format *debug-io* "   ~A~%" ele)))
 813                        (t
 814                         (funcall cmd-fun))))))))))))
 815
 816 (defvar *auto-eval-in-frame* t
 817   #!+sb-doc
 818   "When set (the default), evaluations in the debugger's command loop occur
 819    relative to the current frame's environment without the need of debugger
 820    forms that explicitly control this kind of evaluation.")
 821
 822 (defun debug-eval (expr)
 823   (cond ((not (and (fboundp 'compile) *auto-eval-in-frame*))
 824          (eval expr))
 825         ((frame-has-debug-vars-p *current-frame*)
 826          (sb!di:eval-in-frame *current-frame* expr))
 827         (t
 828          (format *debug-io* "; No debug variables for current frame: ~
 829                                using EVAL instead of EVAL-IN-FRAME.~%")
 830          (eval expr))))
 831
 832 (defun debug-eval-print (expr)
 833   (/noshow "entering DEBUG-EVAL-PRINT" expr)
 834   (let ((values (multiple-value-list
 835                  (interactive-eval expr :eval #'debug-eval))))
 836     (/noshow "done with EVAL in DEBUG-EVAL-PRINT")
 837     (dolist (value values)
 838       (fresh-line *debug-io*)
 839       (prin1 value *debug-io*)))
 840   (force-output *debug-io*))
 841 \f
 842 ;;;; debug loop functions
 843
 844 ;;; These commands are functions, not really commands, so that users
 845 ;;; can get their hands on the values returned.
 846
 847 (eval-when (:execute :compile-toplevel)
 848
 849 (sb!xc:defmacro define-var-operation (ref-or-set &optional value-var)
 850   `(let* ((temp (etypecase name
 851                   (symbol (sb!di:debug-fun-symbol-vars
 852                            (sb!di:frame-debug-fun *current-frame*)
 853                            name))
 854                   (simple-string (sb!di:ambiguous-debug-vars
 855                                   (sb!di:frame-debug-fun *current-frame*)
 856                                   name))))
 857           (location (sb!di:frame-code-location *current-frame*))
 858           ;; Let's only deal with valid variables.
 859           (vars (remove-if-not (lambda (v)
 860                                  (eq (sb!di:debug-var-validity v location)
 861                                      :valid))
 862                                temp)))
 863      (declare (list vars))
 864      (cond ((null vars)
 865             (error "No known valid variables match ~S." name))
 866            ((= (length vars) 1)
 867             ,(ecase ref-or-set
 868                (:ref
 869                 '(sb!di:debug-var-value (car vars) *current-frame*))
 870                (:set
 871                 `(setf (sb!di:debug-var-value (car vars) *current-frame*)
 872                        ,value-var))))
 873            (t
 874             ;; Since we have more than one, first see whether we have
 875             ;; any variables that exactly match the specification.
 876             (let* ((name (etypecase name
 877                            (symbol (symbol-name name))
 878                            (simple-string name)))
 879                    ;; FIXME: REMOVE-IF-NOT is deprecated, use STRING/=
 880                    ;; instead.
 881                    (exact (remove-if-not (lambda (v)
 882                                            (string= (sb!di:debug-var-symbol-name v)
 883                                                     name))
 884                                          vars))
 885                    (vars (or exact vars)))
 886               (declare (simple-string name)
 887                        (list exact vars))
 888               (cond
 889                ;; Check now for only having one variable.
 890                ((= (length vars) 1)
 891                 ,(ecase ref-or-set
 892                    (:ref
 893                     '(sb!di:debug-var-value (car vars) *current-frame*))
 894                    (:set
 895                     `(setf (sb!di:debug-var-value (car vars) *current-frame*)
 896                            ,value-var))))
 897                ;; If there weren't any exact matches, flame about
 898                ;; ambiguity unless all the variables have the same
 899                ;; name.
 900                ((and (not exact)
 901                      (find-if-not
 902                       (lambda (v)
 903                         (string= (sb!di:debug-var-symbol-name v)
 904                                  (sb!di:debug-var-symbol-name (car vars))))
 905                       (cdr vars)))
 906                 (error "specification ambiguous:~%~{   ~A~%~}"
 907                        (mapcar #'sb!di:debug-var-symbol-name
 908                                (delete-duplicates
 909                                 vars :test #'string=
 910                                 :key #'sb!di:debug-var-symbol-name))))
 911                ;; All names are the same, so see whether the user
 912                ;; ID'ed one of them.
 913                (id-supplied
 914                 (let ((v (find id vars :key #'sb!di:debug-var-id)))
 915                   (unless v
 916                     (error
 917                      "invalid variable ID, ~W: should have been one of ~S"
 918                      id
 919                      (mapcar #'sb!di:debug-var-id vars)))
 920                   ,(ecase ref-or-set
 921                      (:ref
 922                       '(sb!di:debug-var-value v *current-frame*))
 923                      (:set
 924                       `(setf (sb!di:debug-var-value v *current-frame*)
 925                              ,value-var)))))
 926                (t
 927                 (error "Specify variable ID to disambiguate ~S. Use one of ~S."
 928                        name
 929                        (mapcar #'sb!di:debug-var-id vars)))))))))
 930
 931 ) ; EVAL-WHEN
 932
 933 ;;; FIXME: This doesn't work. It would be real nice we could make it
 934 ;;; work! Alas, it doesn't seem to work in CMU CL X86 either..
 935 (defun var (name &optional (id 0 id-supplied))
 936   #!+sb-doc
 937   "Return a variable's value if possible. NAME is a simple-string or symbol.
 938    If it is a simple-string, it is an initial substring of the variable's name.
 939    If name is a symbol, it has the same name and package as the variable whose
 940    value this function returns. If the symbol is uninterned, then the variable
 941    has the same name as the symbol, but it has no package.
 942
 943    If name is the initial substring of variables with different names, then
 944    this return no values after displaying the ambiguous names. If name
 945    determines multiple variables with the same name, then you must use the
 946    optional id argument to specify which one you want. If you left id
 947    unspecified, then this returns no values after displaying the distinguishing
 948    id values.
 949
 950    The result of this function is limited to the availability of variable
 951    information. This is SETF'able."
 952   (define-var-operation :ref))
 953 (defun (setf var) (value name &optional (id 0 id-supplied))
 954   (define-var-operation :set value))
 955
 956 ;;; This returns the COUNT'th arg as the user sees it from args, the
 957 ;;; result of SB!DI:DEBUG-FUN-LAMBDA-LIST. If this returns a
 958 ;;; potential DEBUG-VAR from the lambda-list, then the second value is
 959 ;;; T. If this returns a keyword symbol or a value from a rest arg,
 960 ;;; then the second value is NIL.
 961 ;;;
 962 ;;; FIXME: There's probably some way to merge the code here with
 963 ;;; FRAME-ARGS-AS-LIST. (A fair amount of logic is already shared
 964 ;;; through LAMBDA-LIST-ELEMENT-DISPATCH, but I suspect more could be.)
 965 (declaim (ftype (function (index list)) nth-arg))
 966 (defun nth-arg (count args)
 967   (let ((n count))
 968     (dolist (ele args (error "The argument specification ~S is out of range."
 969                              n))
 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)))
 975                         ((zerop (decf n))
 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
 980                                            *current-frame*)
 981                    (error "unused &REST argument before n'th argument")
 982                    (dolist (value
 983                             (sb!di:debug-var-value var *current-frame*)
 984                             (error
 985                              "The argument specification ~S is out of range."
 986                              n))
 987                      (if (zerop n)
 988                          (return-from nth-arg (values value nil))
 989                          (decf n)))
 990                    (error "invalid &REST argument before n'th argument")))))
 991       (decf n))))
 992
 993 (defun arg (n)
 994   #!+sb-doc
 995   "Return the N'th argument's value if possible. Argument zero is the first
 996    argument in a frame's default printed representation. Count keyword/value
 997    pairs as separate arguments."
 998   (multiple-value-bind (var lambda-var-p)
 999       (nth-arg n (handler-case (sb!di:debug-fun-lambda-list
1000                                 (sb!di:frame-debug-fun *current-frame*))
1001                    (sb!di:lambda-list-unavailable ()
1002                      (error "No argument values are available."))))
1003     (if lambda-var-p
1004         (lambda-var-dispatch var (sb!di:frame-code-location *current-frame*)
1005           (error "Unused arguments have no values.")
1006           (sb!di:debug-var-value var *current-frame*)
1007           (error "invalid argument value"))
1008         var)))
1009 \f
1010 ;;;; machinery for definition of debug loop commands
1011
1012 (defvar *debug-commands* nil)
1013
1014 ;;; Interface to *DEBUG-COMMANDS*. No required arguments in args are
1015 ;;; permitted.
1016 (defmacro !def-debug-command (name args &rest body)
1017   (let ((fun-name (symbolicate name "-DEBUG-COMMAND")))
1018     `(progn
1019        (setf *debug-commands*
1020              (remove ,name *debug-commands* :key #'car :test #'string=))
1021        (defun ,fun-name ,args
1022          (unless *in-the-debugger*
1023            (error "invoking debugger command while outside the debugger"))
1024          ,@body)
1025        (push (cons ,name #',fun-name) *debug-commands*)
1026        ',fun-name)))
1027
1028 (defun !def-debug-command-alias (new-name existing-name)
1029   (let ((pair (assoc existing-name *debug-commands* :test #'string=)))
1030     (unless pair (error "unknown debug command name: ~S" existing-name))
1031     (push (cons new-name (cdr pair)) *debug-commands*))
1032   new-name)
1033
1034 ;;; This takes a symbol and uses its name to find a debugger command,
1035 ;;; using initial substring matching. It returns the command function
1036 ;;; if form identifies only one command, but if form is ambiguous,
1037 ;;; this returns a list of the command names. If there are no matches,
1038 ;;; this returns nil. Whenever the loop that looks for a set of
1039 ;;; possibilities encounters an exact name match, we return that
1040 ;;; command function immediately.
1041 (defun debug-command-p (form &optional other-commands)
1042   (if (or (symbolp form) (integerp form))
1043       (let* ((name
1044               (if (symbolp form)
1045                   (symbol-name form)
1046                   (format nil "~W" form)))
1047              (len (length name))
1048              (res nil))
1049         (declare (simple-string name)
1050                  (fixnum len)
1051                  (list res))
1052
1053         ;; Find matching commands, punting if exact match.
1054         (flet ((match-command (ele)
1055                  (let* ((str (car ele))
1056                         (str-len (length str)))
1057                    (declare (simple-string str)
1058                             (fixnum str-len))
1059                    (cond ((< str-len len))
1060                          ((= str-len len)
1061                           (when (string= name str :end1 len :end2 len)
1062                             (return-from debug-command-p (cdr ele))))
1063                          ((string= name str :end1 len :end2 len)
1064                           (push ele res))))))
1065           (mapc #'match-command *debug-commands*)
1066           (mapc #'match-command other-commands))
1067
1068         ;; Return the right value.
1069         (cond ((not res) nil)
1070               ((= (length res) 1)
1071                (cdar res))
1072               (t ; Just return the names.
1073                (do ((cmds res (cdr cmds)))
1074                    ((not cmds) res)
1075                  (setf (car cmds) (caar cmds))))))))
1076
1077 ;;; Return a list of debug commands (in the same format as
1078 ;;; *DEBUG-COMMANDS*) that invoke each active restart.
1079 ;;;
1080 ;;; Two commands are made for each restart: one for the number, and
1081 ;;; one for the restart name (unless it's been shadowed by an earlier
1082 ;;; restart of the same name, or it is NIL).
1083 (defun make-restart-commands (&optional (restarts *debug-restarts*))
1084   (let ((commands)
1085         (num 0))                        ; better be the same as show-restarts!
1086     (dolist (restart restarts)
1087       (let ((name (string (restart-name restart))))
1088         (let ((restart-fun
1089                 (lambda ()
1090                   (/show0 "in restart-command closure, about to i-r-i")
1091                   (invoke-restart-interactively restart))))
1092           (push (cons (prin1-to-string num) restart-fun) commands)
1093           (unless (or (null (restart-name restart))
1094                       (find name commands :key #'car :test #'string=))
1095             (push (cons name restart-fun) commands))))
1096     (incf num))
1097   commands))
1098 \f
1099 ;;;; frame-changing commands
1100
1101 (!def-debug-command "UP" ()
1102   (let ((next (sb!di:frame-up *current-frame*)))
1103     (cond (next
1104            (setf *current-frame* next)
1105            (print-frame-call next *debug-io*))
1106           (t
1107            (format *debug-io* "~&Top of stack.")))))
1108
1109 (!def-debug-command "DOWN" ()
1110   (let ((next (sb!di:frame-down *current-frame*)))
1111     (cond (next
1112            (setf *current-frame* next)
1113            (print-frame-call next *debug-io*))
1114           (t
1115            (format *debug-io* "~&Bottom of stack.")))))
1116
1117 (!def-debug-command-alias "D" "DOWN")
1118
1119 (!def-debug-command "BOTTOM" ()
1120   (do ((prev *current-frame* lead)
1121        (lead (sb!di:frame-down *current-frame*) (sb!di:frame-down lead)))
1122       ((null lead)
1123        (setf *current-frame* prev)
1124        (print-frame-call prev *debug-io*))))
1125
1126 (!def-debug-command-alias "B" "BOTTOM")
1127
1128 (!def-debug-command "FRAME" (&optional
1129                              (n (read-prompting-maybe "frame number: ")))
1130   (setf *current-frame*
1131         (multiple-value-bind (next-frame-fun limit-string)
1132             (if (< n (sb!di:frame-number *current-frame*))
1133                 (values #'sb!di:frame-up "top")
1134               (values #'sb!di:frame-down "bottom"))
1135           (do ((frame *current-frame*))
1136               ((= n (sb!di:frame-number frame))
1137                frame)
1138             (let ((next-frame (funcall next-frame-fun frame)))
1139               (cond (next-frame
1140                      (setf frame next-frame))
1141                     (t
1142                      (format *debug-io*
1143                              "The ~A of the stack was encountered.~%"
1144                              limit-string)
1145                      (return frame)))))))
1146   (print-frame-call *current-frame* *debug-io*))
1147
1148 (!def-debug-command-alias "F" "FRAME")
1149 \f
1150 ;;;; commands for entering and leaving the debugger
1151
1152 (!def-debug-command "TOPLEVEL" ()
1153   (throw 'toplevel-catcher nil))
1154
1155 ;;; make T safe
1156 (!def-debug-command-alias "TOP" "TOPLEVEL")
1157
1158 (!def-debug-command "RESTART" ()
1159   (/show0 "doing RESTART debug-command")
1160   (let ((num (read-if-available :prompt)))
1161     (when (eq num :prompt)
1162       (show-restarts *debug-restarts* *debug-io*)
1163       (write-string "restart: " *debug-io*)
1164       (force-output *debug-io*)
1165       (setf num (read *debug-io*)))
1166     (let ((restart (typecase num
1167                      (unsigned-byte
1168                       (nth num *debug-restarts*))
1169                      (symbol
1170                       (find num *debug-restarts* :key #'restart-name
1171                             :test (lambda (sym1 sym2)
1172                                     (string= (symbol-name sym1)
1173                                              (symbol-name sym2)))))
1174                      (t
1175                       (format *debug-io* "~S is invalid as a restart name.~%"
1176                               num)
1177                       (return-from restart-debug-command nil)))))
1178       (/show0 "got RESTART")
1179       (if restart
1180           (invoke-restart-interactively restart)
1181           (princ "There is no such restart." *debug-io*)))))
1182 \f
1183 ;;;; information commands
1184
1185 (!def-debug-command "HELP" ()
1186   ;; CMU CL had a little toy pager here, but "if you aren't running
1187   ;; ILISP (or a smart windowing system, or something) you deserve to
1188   ;; lose", so we've dropped it in SBCL. However, in case some
1189   ;; desperate holdout is running this on a dumb terminal somewhere,
1190   ;; we tell him where to find the message stored as a string.
1191   (format *debug-io*
1192           "~&~A~2%(The HELP string is stored in ~S.)~%"
1193           *debug-help-string*
1194           '*debug-help-string*))
1195
1196 (!def-debug-command-alias "?" "HELP")
1197
1198 (!def-debug-command "ERROR" ()
1199   (format *debug-io* "~A~%" *debug-condition*)
1200   (show-restarts *debug-restarts* *debug-io*))
1201
1202 (!def-debug-command "BACKTRACE" ()
1203   (backtrace (read-if-available most-positive-fixnum)))
1204
1205 (!def-debug-command "PRINT" ()
1206   (print-frame-call *current-frame* *debug-io*))
1207
1208 (!def-debug-command-alias "P" "PRINT")
1209
1210 (!def-debug-command "LIST-LOCALS" ()
1211   (let ((d-fun (sb!di:frame-debug-fun *current-frame*)))
1212     (if (sb!di:debug-var-info-available d-fun)
1213         (let ((*standard-output* *debug-io*)
1214               (location (sb!di:frame-code-location *current-frame*))
1215               (prefix (read-if-available nil))
1216               (any-p nil)
1217               (any-valid-p nil))
1218           (dolist (v (sb!di:ambiguous-debug-vars
1219                         d-fun
1220                         (if prefix (string prefix) "")))
1221             (setf any-p t)
1222             (when (eq (sb!di:debug-var-validity v location) :valid)
1223               (setf any-valid-p t)
1224               (format *debug-io* "~S~:[#~W~;~*~]  =  ~S~%"
1225                       (sb!di:debug-var-symbol v)
1226                       (zerop (sb!di:debug-var-id v))
1227                       (sb!di:debug-var-id v)
1228                       (sb!di:debug-var-value v *current-frame*))))
1229
1230           (cond
1231            ((not any-p)
1232             (format *debug-io*
1233                     "There are no local variables ~@[starting with ~A ~]~
1234                     in the function."
1235                     prefix))
1236            ((not any-valid-p)
1237             (format *debug-io*
1238                     "All variables ~@[starting with ~A ~]currently ~
1239                     have invalid values."
1240                     prefix))))
1241         (write-line "There is no variable information available."
1242                     *debug-io*))))
1243
1244 (!def-debug-command-alias "L" "LIST-LOCALS")
1245
1246 (!def-debug-command "SOURCE" ()
1247   (print (code-location-source-form (sb!di:frame-code-location *current-frame*)
1248                                     (read-if-available 0))
1249          *debug-io*))
1250 \f
1251 ;;;; source location printing
1252
1253 ;;; We cache a stream to the last valid file debug source so that we
1254 ;;; won't have to repeatedly open the file.
1255 ;;;
1256 ;;; KLUDGE: This sounds like a bug, not a feature. Opening files is fast
1257 ;;; in the 1990s, so the benefit is negligible, less important than the
1258 ;;; potential of extra confusion if someone changes the source during
1259 ;;; a debug session and the change doesn't show up. And removing this
1260 ;;; would simplify the system, which I like. -- WHN 19990903
1261 (defvar *cached-debug-source* nil)
1262 (declaim (type (or sb!di:debug-source null) *cached-debug-source*))
1263 (defvar *cached-source-stream* nil)
1264 (declaim (type (or stream null) *cached-source-stream*))
1265
1266 ;;; To suppress the read-time evaluation #. macro during source read,
1267 ;;; *READTABLE* is modified. *READTABLE* is cached to avoid
1268 ;;; copying it each time, and invalidated when the
1269 ;;; *CACHED-DEBUG-SOURCE* has changed.
1270 (defvar *cached-readtable* nil)
1271 (declaim (type (or readtable null) *cached-readtable*))
1272
1273 ;;; Stuff to clean up before saving a core
1274 (defun debug-deinit ()
1275   (setf *cached-debug-source* nil
1276         *cached-source-stream* nil
1277         *cached-readtable* nil))
1278
1279 ;;; We also cache the last toplevel form that we printed a source for
1280 ;;; so that we don't have to do repeated reads and calls to
1281 ;;; FORM-NUMBER-TRANSLATIONS.
1282 (defvar *cached-toplevel-form-offset* nil)
1283 (declaim (type (or index null) *cached-toplevel-form-offset*))
1284 (defvar *cached-toplevel-form*)
1285 (defvar *cached-form-number-translations*)
1286
1287 ;;; Given a code location, return the associated form-number
1288 ;;; translations and the actual top level form. We check our cache ---
1289 ;;; if there is a miss, we dispatch on the kind of the debug source.
1290 (defun get-toplevel-form (location)
1291   (let ((d-source (sb!di:code-location-debug-source location)))
1292     (if (and (eq d-source *cached-debug-source*)
1293              (eql (sb!di:code-location-toplevel-form-offset location)
1294                   *cached-toplevel-form-offset*))
1295         (values *cached-form-number-translations* *cached-toplevel-form*)
1296         (let* ((offset (sb!di:code-location-toplevel-form-offset location))
1297                (res
1298                 (cond ((sb!di:debug-source-namestring d-source)
1299                        (get-file-toplevel-form location))
1300                       ((sb!di:debug-source-form d-source)
1301                        (sb!di:debug-source-form d-source))
1302                       (t (bug "Don't know how to use a DEBUG-SOURCE without ~
1303                                a namestring or a form.")))))
1304           (setq *cached-toplevel-form-offset* offset)
1305           (values (setq *cached-form-number-translations*
1306                         (sb!di:form-number-translations res offset))
1307                   (setq *cached-toplevel-form* res))))))
1308
1309 ;;; Locate the source file (if it still exists) and grab the top level
1310 ;;; form. If the file is modified, we use the top level form offset
1311 ;;; instead of the recorded character offset.
1312 (defun get-file-toplevel-form (location)
1313   (let* ((d-source (sb!di:code-location-debug-source location))
1314          (tlf-offset (sb!di:code-location-toplevel-form-offset location))
1315          (local-tlf-offset (- tlf-offset
1316                               (sb!di:debug-source-root-number d-source)))
1317          (char-offset
1318           (aref (or (sb!di:debug-source-start-positions d-source)
1319                     (error "no start positions map"))
1320                 local-tlf-offset))
1321          (name (sb!di:debug-source-namestring d-source)))
1322     (unless (eq d-source *cached-debug-source*)
1323       (unless (and *cached-source-stream*
1324                    (equal (pathname *cached-source-stream*)
1325                           (pathname name)))
1326         (setq *cached-readtable* nil)
1327         (when *cached-source-stream* (close *cached-source-stream*))
1328         (setq *cached-source-stream* (open name :if-does-not-exist nil))
1329         (unless *cached-source-stream*
1330           (error "The source file no longer exists:~%  ~A" (namestring name)))
1331         (format *debug-io* "~%; file: ~A~%" (namestring name)))
1332
1333         (setq *cached-debug-source*
1334               (if (= (sb!di:debug-source-created d-source)
1335                      (file-write-date name))
1336                   d-source nil)))
1337
1338     (cond
1339      ((eq *cached-debug-source* d-source)
1340       (file-position *cached-source-stream* char-offset))
1341      (t
1342       (format *debug-io*
1343               "~%; File has been modified since compilation:~%;   ~A~@
1344                  ; Using form offset instead of character position.~%"
1345               (namestring name))
1346       (file-position *cached-source-stream* 0)
1347       (let ((*read-suppress* t))
1348         (dotimes (i local-tlf-offset)
1349           (read *cached-source-stream*)))))
1350     (unless *cached-readtable*
1351       (setq *cached-readtable* (copy-readtable))
1352       (set-dispatch-macro-character
1353        #\# #\.
1354        (lambda (stream sub-char &rest rest)
1355          (declare (ignore rest sub-char))
1356          (let ((token (read stream t nil t)))
1357            (format nil "#.~S" token)))
1358        *cached-readtable*))
1359     (let ((*readtable* *cached-readtable*))
1360       (read *cached-source-stream*))))
1361
1362 (defun code-location-source-form (location context)
1363   (let* ((location (maybe-block-start-location location))
1364          (form-num (sb!di:code-location-form-number location)))
1365     (multiple-value-bind (translations form) (get-toplevel-form location)
1366       (unless (< form-num (length translations))
1367         (error "The source path no longer exists."))
1368       (sb!di:source-path-context form
1369                                  (svref translations form-num)
1370                                  context))))
1371 \f
1372
1373 ;;; start single-stepping
1374 (!def-debug-command "START" ()
1375   (if (typep *debug-condition* 'step-condition)
1376       (format *debug-io* "~&Already single-stepping.~%")
1377       (let ((restart (find-restart 'continue *debug-condition*)))
1378         (cond (restart
1379                (sb!impl::enable-stepping)
1380                (invoke-restart restart))
1381               (t
1382                (format *debug-io* "~&Non-continuable error, cannot start stepping.~%"))))))
1383
1384 (defmacro def-step-command (command-name restart-name)
1385   `(!def-debug-command ,command-name ()
1386      (if (typep *debug-condition* 'step-condition)
1387          (let ((restart (find-restart ',restart-name *debug-condition*)))
1388            (aver restart)
1389            (invoke-restart restart))
1390          (format *debug-io* "~&Not currently single-stepping. (Use START to activate the single-stepper)~%"))))
1391
1392 (def-step-command "STEP" step-into)
1393 (def-step-command "NEXT" step-next)
1394 (def-step-command "STOP" step-continue)
1395
1396 (!def-debug-command-alias "S" "STEP")
1397 (!def-debug-command-alias "N" "NEXT")
1398
1399 (!def-debug-command "OUT" ()
1400   (if (typep *debug-condition* 'step-condition)
1401       (if sb!impl::*step-out*
1402           (let ((restart (find-restart 'step-out *debug-condition*)))
1403             (aver restart)
1404             (invoke-restart restart))
1405           (format *debug-io* "~&OUT can only be used step out of frames that were originally stepped into with STEP.~%"))
1406       (format *debug-io* "~&Not currently single-stepping. (Use START to activate the single-stepper)~%")))
1407
1408 ;;; miscellaneous commands
1409
1410 (!def-debug-command "DESCRIBE" ()
1411   (let* ((curloc (sb!di:frame-code-location *current-frame*))
1412          (debug-fun (sb!di:code-location-debug-fun curloc))
1413          (function (sb!di:debug-fun-fun debug-fun)))
1414     (if function
1415         (describe function)
1416         (format *debug-io* "can't figure out the function for this frame"))))
1417
1418 (!def-debug-command "SLURP" ()
1419   (loop while (read-char-no-hang *standard-input*)))
1420
1421 ;;; RETURN-FROM-FRAME and RESTART-FRAME
1422
1423 (defun unwind-to-frame-and-call (frame thunk)
1424   #!+unwind-to-frame-and-call-vop
1425   (flet ((sap-int/fixnum (sap)
1426            ;; On unithreaded X86 *BINDING-STACK-POINTER* and
1427            ;; *CURRENT-CATCH-BLOCK* are negative, so we need to jump through
1428            ;; some hoops to make these calculated values negative too.
1429            (ash (truly-the (signed-byte #.sb!vm:n-word-bits)
1430                            (sap-int sap))
1431                 (- sb!vm::n-fixnum-tag-bits))))
1432     ;; To properly unwind the stack, we need three pieces of information:
1433     ;;   * The unwind block that should be active after the unwind
1434     ;;   * The catch block that should be active after the unwind
1435     ;;   * The values that the binding stack pointer should have after the
1436     ;;     unwind.
1437     (let* ((block (sap-int/fixnum (find-enclosing-catch-block frame)))
1438            (unbind-to (sap-int/fixnum (find-binding-stack-pointer frame))))
1439       ;; This VOP will run the neccessary cleanup forms, reset the fp, and
1440       ;; then call the supplied function.
1441       (sb!vm::%primitive sb!vm::unwind-to-frame-and-call
1442                          (sb!di::frame-pointer frame)
1443                          (find-enclosing-uwp frame)
1444                          (lambda ()
1445                            ;; Before calling the user-specified
1446                            ;; function, we need to restore the binding
1447                            ;; stack and the catch block. The unwind block
1448                            ;; is taken care of by the VOP.
1449                            (sb!vm::%primitive sb!vm::unbind-to-here
1450                                               unbind-to)
1451                            (setf sb!vm::*current-catch-block* block)
1452                            (funcall thunk)))))
1453   #!-unwind-to-frame-and-call-vop
1454   (let ((tag (gensym)))
1455     (sb!di:replace-frame-catch-tag frame
1456                                    'sb!c:debug-catch-tag
1457                                    tag)
1458     (throw tag thunk)))
1459
1460 (defun find-binding-stack-pointer (frame)
1461   #!-stack-grows-downward-not-upward
1462   (declare (ignore frame))
1463   #!-stack-grows-downward-not-upward
1464   (error "Not implemented on this architecture")
1465   #!+stack-grows-downward-not-upward
1466   (let ((bsp (sb!vm::binding-stack-pointer-sap))
1467         (unbind-to nil)
1468         (fp (sb!di::frame-pointer frame))
1469         (start (int-sap (ldb (byte #.sb!vm:n-word-bits 0)
1470                              (ash sb!vm:*binding-stack-start*
1471                                   sb!vm:n-fixnum-tag-bits)))))
1472     ;; Walk the binding stack looking for an entry where the symbol is
1473     ;; an unbound-symbol marker and the value is equal to the frame
1474     ;; pointer.  These entries are inserted into the stack by the
1475     ;; BIND-SENTINEL VOP and removed by UNBIND-SENTINEL (inserted into
1476     ;; the function during IR2). If an entry wasn't found, the
1477     ;; function that the frame corresponds to wasn't compiled with a
1478     ;; high enough debug setting, and can't be restarted / returned
1479     ;; from.
1480     (loop until (sap= bsp start)
1481           do (progn
1482                (setf bsp (sap+ bsp
1483                                (- (* sb!vm:binding-size sb!vm:n-word-bytes))))
1484                (let ((symbol (sap-ref-word bsp (* sb!vm:binding-symbol-slot
1485                                                   sb!vm:n-word-bytes)))
1486                      (value (sap-ref-sap bsp (* sb!vm:binding-value-slot
1487                                                 sb!vm:n-word-bytes))))
1488                  (when (eql symbol sb!vm:unbound-marker-widetag)
1489                    (when (sap= value fp)
1490                      (setf unbind-to bsp))))))
1491     unbind-to))
1492
1493 (defun find-enclosing-catch-block (frame)
1494   ;; Walk the catch block chain looking for the first entry with an address
1495   ;; higher than the pointer for FRAME or a null pointer.
1496   (let* ((frame-pointer (sb!di::frame-pointer frame))
1497          (current-block (int-sap (ldb (byte #.sb!vm:n-word-bits 0)
1498                                       (ash sb!vm::*current-catch-block*
1499                                            sb!vm:n-fixnum-tag-bits))))
1500          (enclosing-block (loop for block = current-block
1501                                 then (sap-ref-sap block
1502                                                   (* sb!vm:catch-block-previous-catch-slot
1503                                                      sb!vm::n-word-bytes))
1504                                 when (or (zerop (sap-int block))
1505                                          (sap> block frame-pointer))
1506                                 return block)))
1507     enclosing-block))
1508
1509 (defun find-enclosing-uwp (frame)
1510   ;; Walk the UWP chain looking for the first entry with an address
1511   ;; higher than the pointer for FRAME or a null pointer.
1512   (let* ((frame-pointer (sb!di::frame-pointer frame))
1513          (current-uwp (int-sap (ldb (byte #.sb!vm:n-word-bits 0)
1514                                     (ash sb!vm::*current-unwind-protect-block*
1515                                          sb!vm:n-fixnum-tag-bits))))
1516          (enclosing-uwp (loop for uwp-block = current-uwp
1517                               then (sap-ref-sap uwp-block
1518                                                 sb!vm:unwind-block-current-uwp-slot)
1519                               when (or (zerop (sap-int uwp-block))
1520                                        (sap> uwp-block frame-pointer))
1521                               return uwp-block)))
1522     enclosing-uwp))
1523
1524 (!def-debug-command "RETURN" (&optional
1525                               (return (read-prompting-maybe
1526                                        "return: ")))
1527    (if (frame-has-debug-tag-p *current-frame*)
1528        (let* ((code-location (sb!di:frame-code-location *current-frame*))
1529               (values (multiple-value-list
1530                        (funcall (sb!di:preprocess-for-eval return code-location)
1531                                 *current-frame*))))
1532          (unwind-to-frame-and-call *current-frame* (lambda ()
1533                                                      (values-list values))))
1534        (format *debug-io*
1535                "~@<can't find a tag for this frame ~
1536                  ~2I~_(hint: try increasing the DEBUG optimization quality ~
1537                  and recompiling)~:@>")))
1538
1539 (!def-debug-command "RESTART-FRAME" ()
1540   (if (frame-has-debug-tag-p *current-frame*)
1541       (let* ((call-list (frame-call-as-list *current-frame*))
1542              (fun (fdefinition (car call-list))))
1543         (unwind-to-frame-and-call *current-frame*
1544                                   (lambda ()
1545                                     (apply fun (cdr call-list)))))
1546       (format *debug-io*
1547               "~@<can't find a tag for this frame ~
1548                  ~2I~_(hint: try increasing the DEBUG optimization quality ~
1549                  and recompiling)~:@>")))
1550
1551 (defun frame-has-debug-tag-p (frame)
1552   #!+unwind-to-frame-and-call-vop
1553   (not (null (find-binding-stack-pointer frame)))
1554   #!-unwind-to-frame-and-call-vop
1555   (find 'sb!c:debug-catch-tag (sb!di::frame-catches frame) :key #'car))
1556
1557 (defun frame-has-debug-vars-p (frame)
1558   (sb!di:debug-var-info-available
1559    (sb!di:code-location-debug-fun
1560     (sb!di:frame-code-location frame))))
1561
1562 ;; Hack: ensure that *U-T-F-F* has a tls index.
1563 #!+unwind-to-frame-and-call-vop
1564 (let ((sb!vm::*unwind-to-frame-function* (lambda ()))))
1565
1566 \f
1567 ;;;; debug loop command utilities
1568
1569 (defun read-prompting-maybe (prompt)
1570   (unless (sb!int:listen-skip-whitespace *debug-io*)
1571     (princ prompt *debug-io*)
1572     (force-output *debug-io*))
1573   (read *debug-io*))
1574
1575 (defun read-if-available (default)
1576   (if (sb!int:listen-skip-whitespace *debug-io*)
1577       (read *debug-io*)
1578       default))