src/code/debug-int.lisp

   1 ;;;; the implementation of the programmer's interface to writing
   2 ;;;; debugging tools
   3
   4 ;;;; This software is part of the SBCL system. See the README file for
   5 ;;;; more information.
   6 ;;;;
   7 ;;;; This software is derived from the CMU CL system, which was
   8 ;;;; written at Carnegie Mellon University and released into the
   9 ;;;; public domain. The software is in the public domain and is
  10 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
  11 ;;;; files for more information.
  12
  13 (in-package "SB!DI")
  14
  15 ;;; FIXME: There are an awful lot of package prefixes in this code.
  16 ;;; Couldn't we have SB-DI use the SB-C and SB-VM packages?
  17 \f
  18 ;;;; conditions
  19
  20 ;;;; The interface to building debugging tools signals conditions that
  21 ;;;; prevent it from adhering to its contract. These are
  22 ;;;; serious-conditions because the program using the interface must
  23 ;;;; handle them before it can correctly continue execution. These
  24 ;;;; debugging conditions are not errors since it is no fault of the
  25 ;;;; programmers that the conditions occur. The interface does not
  26 ;;;; provide for programs to detect these situations other than
  27 ;;;; calling a routine that detects them and signals a condition. For
  28 ;;;; example, programmers call A which may fail to return successfully
  29 ;;;; due to a lack of debug information, and there is no B the they
  30 ;;;; could have called to realize A would fail. It is not an error to
  31 ;;;; have called A, but it is an error for the program to then ignore
  32 ;;;; the signal generated by A since it cannot continue without A's
  33 ;;;; correctly returning a value or performing some operation.
  34 ;;;;
  35 ;;;; Use DEBUG-SIGNAL to signal these conditions.
  36
  37 (define-condition debug-condition (serious-condition)
  38   ()
  39   #!+sb-doc
  40   (:documentation
  41    "All DEBUG-CONDITIONs inherit from this type. These are serious conditions
  42     that must be handled, but they are not programmer errors."))
  43
  44 (define-condition no-debug-info (debug-condition)
  45   ((code-component :reader no-debug-info-code-component
  46                    :initarg :code-component))
  47   #!+sb-doc
  48   (:documentation "There is no usable debugging information available.")
  49   (:report (lambda (condition stream)
  50              (declare (ignore condition))
  51              (fresh-line stream)
  52              (format stream
  53                      "no debug information available for ~S~%"
  54                      (no-debug-info-code-component condition)))))
  55
  56 (define-condition no-debug-function-returns (debug-condition)
  57   ((debug-function :reader no-debug-function-returns-debug-function
  58                    :initarg :debug-function))
  59   #!+sb-doc
  60   (:documentation
  61    "The system could not return values from a frame with DEBUG-FUNCTION since
  62     it lacked information about returning values.")
  63   (:report (lambda (condition stream)
  64              (let ((fun (debug-function-function
  65                          (no-debug-function-returns-debug-function condition))))
  66                (format stream
  67                        "~&Cannot return values from ~:[frame~;~:*~S~] since ~
  68                         the debug information lacks details about returning ~
  69                         values here."
  70                        fun)))))
  71
  72 (define-condition no-debug-blocks (debug-condition)
  73   ((debug-function :reader no-debug-blocks-debug-function
  74                    :initarg :debug-function))
  75   #!+sb-doc
  76   (:documentation "The debug-function has no debug-block information.")
  77   (:report (lambda (condition stream)
  78              (format stream "~&~S has no debug-block information."
  79                      (no-debug-blocks-debug-function condition)))))
  80
  81 (define-condition no-debug-vars (debug-condition)
  82   ((debug-function :reader no-debug-vars-debug-function
  83                    :initarg :debug-function))
  84   #!+sb-doc
  85   (:documentation "The debug-function has no DEBUG-VAR information.")
  86   (:report (lambda (condition stream)
  87              (format stream "~&~S has no debug variable information."
  88                      (no-debug-vars-debug-function condition)))))
  89
  90 (define-condition lambda-list-unavailable (debug-condition)
  91   ((debug-function :reader lambda-list-unavailable-debug-function
  92                    :initarg :debug-function))
  93   #!+sb-doc
  94   (:documentation
  95    "The debug-function has no lambda-list since argument DEBUG-VARs are
  96     unavailable.")
  97   (:report (lambda (condition stream)
  98              (format stream "~&~S has no lambda-list information available."
  99                      (lambda-list-unavailable-debug-function condition)))))
 100
 101 (define-condition invalid-value (debug-condition)
 102   ((debug-var :reader invalid-value-debug-var :initarg :debug-var)
 103    (frame :reader invalid-value-frame :initarg :frame))
 104   (:report (lambda (condition stream)
 105              (format stream "~&~S has :invalid or :unknown value in ~S."
 106                      (invalid-value-debug-var condition)
 107                      (invalid-value-frame condition)))))
 108
 109 (define-condition ambiguous-variable-name (debug-condition)
 110   ((name :reader ambiguous-variable-name-name :initarg :name)
 111    (frame :reader ambiguous-variable-name-frame :initarg :frame))
 112   (:report (lambda (condition stream)
 113              (format stream "~&~S names more than one valid variable in ~S."
 114                      (ambiguous-variable-name-name condition)
 115                      (ambiguous-variable-name-frame condition)))))
 116 \f
 117 ;;;; errors and DEBUG-SIGNAL
 118
 119 ;;; The debug-internals code tries to signal all programmer errors as
 120 ;;; subtypes of DEBUG-ERROR. There are calls to ERROR signalling
 121 ;;; SIMPLE-ERRORs, but these dummy checks in the code and shouldn't
 122 ;;; come up.
 123 ;;;
 124 ;;; While under development, this code also signals errors in code
 125 ;;; branches that remain unimplemented.
 126
 127 (define-condition debug-error (error) ()
 128   #!+sb-doc
 129   (:documentation
 130    "All programmer errors from using the interface for building debugging
 131     tools inherit from this type."))
 132
 133 (define-condition unhandled-debug-condition (debug-error)
 134   ((condition :reader unhandled-debug-condition-condition :initarg :condition))
 135   (:report (lambda (condition stream)
 136              (format stream "~&unhandled DEBUG-CONDITION:~%~A"
 137                      (unhandled-debug-condition-condition condition)))))
 138
 139 (define-condition unknown-code-location (debug-error)
 140   ((code-location :reader unknown-code-location-code-location
 141                   :initarg :code-location))
 142   (:report (lambda (condition stream)
 143              (format stream "~&invalid use of an unknown code-location: ~S"
 144                      (unknown-code-location-code-location condition)))))
 145
 146 (define-condition unknown-debug-var (debug-error)
 147   ((debug-var :reader unknown-debug-var-debug-var :initarg :debug-var)
 148    (debug-function :reader unknown-debug-var-debug-function
 149                    :initarg :debug-function))
 150   (:report (lambda (condition stream)
 151              (format stream "~&~S is not in ~S."
 152                      (unknown-debug-var-debug-var condition)
 153                      (unknown-debug-var-debug-function condition)))))
 154
 155 (define-condition invalid-control-stack-pointer (debug-error)
 156   ()
 157   (:report (lambda (condition stream)
 158              (declare (ignore condition))
 159              (fresh-line stream)
 160              (write-string "invalid control stack pointer" stream))))
 161
 162 (define-condition frame-function-mismatch (debug-error)
 163   ((code-location :reader frame-function-mismatch-code-location
 164                   :initarg :code-location)
 165    (frame :reader frame-function-mismatch-frame :initarg :frame)
 166    (form :reader frame-function-mismatch-form :initarg :form))
 167   (:report (lambda (condition stream)
 168              (format
 169               stream
 170               "~&Form was preprocessed for ~S,~% but called on ~S:~%  ~S"
 171               (frame-function-mismatch-code-location condition)
 172               (frame-function-mismatch-frame condition)
 173               (frame-function-mismatch-form condition)))))
 174
 175 ;;; This signals debug-conditions. If they go unhandled, then signal
 176 ;;; an UNHANDLED-DEBUG-CONDITION error.
 177 ;;;
 178 ;;; ??? Get SIGNAL in the right package!
 179 (defmacro debug-signal (datum &rest arguments)
 180   `(let ((condition (make-condition ,datum ,@arguments)))
 181      (signal condition)
 182      (error 'unhandled-debug-condition :condition condition)))
 183 \f
 184 ;;;; structures
 185 ;;;;
 186 ;;;; Most of these structures model information stored in internal
 187 ;;;; data structures created by the compiler. Whenever comments
 188 ;;;; preface an object or type with "compiler", they refer to the
 189 ;;;; internal compiler thing, not to the object or type with the same
 190 ;;;; name in the "DI" package.
 191
 192 ;;;; DEBUG-VARs
 193
 194 ;;; These exist for caching data stored in packed binary form in
 195 ;;; compiler debug-functions. Debug-functions store these.
 196 (defstruct (debug-var (:constructor nil))
 197   ;; the name of the variable
 198   (symbol (required-argument) :type symbol)
 199   ;; a unique integer identification relative to other variables with the same
 200   ;; symbol
 201   (id 0 :type sb!c::index)
 202   ;; Does the variable always have a valid value?
 203   (alive-p nil :type boolean))
 204 (def!method print-object ((debug-var debug-var) stream)
 205   (print-unreadable-object (debug-var stream :type t :identity t)
 206     (format stream
 207             "~S ~D"
 208             (debug-var-symbol debug-var)
 209             (debug-var-id debug-var))))
 210
 211 #!+sb-doc
 212 (setf (fdocumentation 'debug-var-id 'function)
 213   "Returns the integer that makes DEBUG-VAR's name and package unique
 214    with respect to other DEBUG-VARs in the same function.")
 215
 216 (defstruct (compiled-debug-var
 217             (:include debug-var)
 218             (:constructor make-compiled-debug-var
 219                           (symbol id alive-p sc-offset save-sc-offset)))
 220   ;; Storage class and offset. (unexported).
 221   (sc-offset nil :type sb!c::sc-offset)
 222   ;; Storage class and offset when saved somewhere.
 223   (save-sc-offset nil :type (or sb!c::sc-offset null)))
 224
 225 (defstruct (interpreted-debug-var
 226             (:include debug-var (alive-p t))
 227             (:constructor make-interpreted-debug-var (symbol ir1-var)))
 228   ;; This is the IR1 structure that holds information about interpreted vars.
 229   (ir1-var nil :type sb!c::lambda-var))
 230
 231 ;;;; frames
 232
 233 ;;; These represent call-frames on the stack.
 234 (defstruct (frame (:constructor nil))
 235   ;; the next frame up, or NIL when top frame
 236   (up nil :type (or frame null))
 237   ;; the previous frame down, or NIL when the bottom frame. Before
 238   ;; computing the next frame down, this slot holds the frame pointer
 239   ;; to the control stack for the given frame. This lets us get the
 240   ;; next frame down and the return-pc for that frame.
 241   (%down :unparsed :type (or frame (member nil :unparsed)))
 242   ;; the debug-function for the function whose call this frame
 243   ;; represents
 244   (debug-function nil :type debug-function)
 245   ;; the code-location to continue upon return to frame
 246   (code-location nil :type code-location)
 247   ;; an a-list of catch-tags to code-locations
 248   (%catches :unparsed :type (or list (member :unparsed)))
 249   ;; pointer to frame on control stack. (unexported) When this frame
 250   ;; is an interpreted-frame, this pointer is an index into the
 251   ;; interpreter's stack.
 252   pointer
 253   ;; This is the frame's number for prompt printing. Top is zero.
 254   (number 0 :type index))
 255
 256 #!+sb-doc
 257 (setf (fdocumentation 'frame-up 'function)
 258   "Returns the frame immediately above frame on the stack. When frame is
 259    the top of the stack, this returns nil.")
 260
 261 #!+sb-doc
 262 (setf (fdocumentation 'frame-debug-function 'function)
 263   "Returns the debug-function for the function whose call frame represents.")
 264
 265 #!+sb-doc
 266 (setf (fdocumentation 'frame-code-location 'function)
 267   "Returns the code-location where the frame's debug-function will continue
 268    running when program execution returns to this frame. If someone
 269    interrupted this frame, the result could be an unknown code-location.")
 270
 271 (defstruct (compiled-frame
 272             (:include frame)
 273             (:constructor make-compiled-frame
 274                           (pointer up debug-function code-location number
 275                                    #!+gengc saved-state-chain
 276                                    &optional escaped)))
 277   ;; This indicates whether someone interrupted the frame.
 278   ;; (unexported). If escaped, this is a pointer to the state that was
 279   ;; saved when we were interrupted. On the non-gengc system, this is
 280   ;; a pointer to an os_context_t, i.e. the third argument to an
 281   ;; SA_SIGACTION-style signal handler. On the gengc system, this is a
 282   ;; state pointer from SAVED-STATE-CHAIN.
 283   escaped
 284   ;; a list of SAPs to saved states. Each time we unwind past an
 285   ;; exception, we pop the next entry off this list. When we get to
 286   ;; the end of the list, there is nothing else on the stack.
 287   #!+gengc (saved-state-chain nil :type list))
 288 (def!method print-object ((obj compiled-frame) str)
 289   (print-unreadable-object (obj str :type t)
 290     (format str
 291             "~S~:[~;, interrupted~]"
 292             (debug-function-name (frame-debug-function obj))
 293             (compiled-frame-escaped obj))))
 294
 295 (defstruct (interpreted-frame
 296             (:include frame)
 297             (:constructor make-interpreted-frame
 298                           (pointer up debug-function code-location number
 299                            real-frame closure)))
 300   ;; This points to the compiled-frame for SB!EVAL:INTERNAL-APPLY-LOOP.
 301   (real-frame nil :type compiled-frame)
 302   ;; This is the closed over data used by the interpreter.
 303   (closure nil :type simple-vector))
 304 (def!method print-object ((obj interpreted-frame) str)
 305   (print-unreadable-object (obj str :type t)
 306     (prin1 (debug-function-name (frame-debug-function obj)) str)))
 307
 308 ;;;; DEBUG-FUNCTIONs
 309
 310 ;;; These exist for caching data stored in packed binary form in
 311 ;;; compiler debug-functions. *COMPILED-DEBUG-FUNCTIONS* maps a
 312 ;;; SB!C::DEBUG-FUNCTION to a DEBUG-FUNCTION. There should only be one
 313 ;;; DEBUG-FUNCTION in existence for any function; that is, all
 314 ;;; code-locations and other objects that reference DEBUG-FUNCTIONs
 315 ;;; point to unique objects. This is due to the overhead in cached
 316 ;;; information.
 317 (defstruct debug-function
 318   ;; Some representation of the function arguments. See
 319   ;; DEBUG-FUNCTION-LAMBDA-LIST.
 320   ;; NOTE: must parse vars before parsing arg list stuff.
 321   (%lambda-list :unparsed)
 322   ;; Cached DEBUG-VARS information. (unexported).
 323   ;; These are sorted by their name.
 324   (%debug-vars :unparsed :type (or simple-vector null (member :unparsed)))
 325   ;; Cached debug-block information. This is NIL when we have tried to
 326   ;; parse the packed binary info, but none is available.
 327   (blocks :unparsed :type (or simple-vector null (member :unparsed)))
 328   ;; The actual function if available.
 329   (%function :unparsed :type (or null function (member :unparsed))))
 330 (def!method print-object ((obj debug-function) stream)
 331   (print-unreadable-object (obj stream :type t)
 332     (prin1 (debug-function-name obj) stream)))
 333
 334 (defstruct (compiled-debug-function
 335             (:include debug-function)
 336             (:constructor %make-compiled-debug-function
 337                           (compiler-debug-fun component)))
 338   ;; Compiler's dumped debug-function information. (unexported).
 339   (compiler-debug-fun nil :type sb!c::compiled-debug-function)
 340   ;; Code object. (unexported).
 341   component
 342   ;; The :FUNCTION-START breakpoint (if any) used to facilitate
 343   ;; function end breakpoints.
 344   (end-starter nil :type (or null breakpoint)))
 345
 346 ;;; This maps SB!C::COMPILED-DEBUG-FUNCTIONs to
 347 ;;; COMPILED-DEBUG-FUNCTIONs, so we can get at cached stuff and not
 348 ;;; duplicate COMPILED-DEBUG-FUNCTION structures.
 349 (defvar *compiled-debug-functions* (make-hash-table :test 'eq))
 350
 351 ;;; Make a COMPILED-DEBUG-FUNCTION for a SB!C::COMPILER-DEBUG-FUNCTION
 352 ;;; and its component. This maps the latter to the former in
 353 ;;; *COMPILED-DEBUG-FUNCTIONS*. If there already is a
 354 ;;; COMPILED-DEBUG-FUNCTION, then this returns it from
 355 ;;; *COMPILED-DEBUG-FUNCTIONS*.
 356 (defun make-compiled-debug-function (compiler-debug-fun component)
 357   (or (gethash compiler-debug-fun *compiled-debug-functions*)
 358       (setf (gethash compiler-debug-fun *compiled-debug-functions*)
 359             (%make-compiled-debug-function compiler-debug-fun component))))
 360
 361 (defstruct (interpreted-debug-function
 362             (:include debug-function)
 363             (:constructor %make-interpreted-debug-function (ir1-lambda)))
 364   ;; This is the IR1 lambda that this debug-function represents.
 365   (ir1-lambda nil :type sb!c::clambda))
 366
 367 (defstruct (bogus-debug-function
 368             (:include debug-function)
 369             (:constructor make-bogus-debug-function
 370                           (%name &aux (%lambda-list nil) (%debug-vars nil)
 371                                  (blocks nil) (%function nil))))
 372   %name)
 373
 374 (defvar *ir1-lambda-debug-function* (make-hash-table :test 'eq))
 375
 376 (defun make-interpreted-debug-function (ir1-lambda)
 377   (let ((home-lambda (sb!c::lambda-home ir1-lambda)))
 378     (or (gethash home-lambda *ir1-lambda-debug-function*)
 379         (setf (gethash home-lambda *ir1-lambda-debug-function*)
 380               (%make-interpreted-debug-function home-lambda)))))
 381
 382 ;;;; DEBUG-BLOCKs
 383
 384 ;;; These exist for caching data stored in packed binary form in compiler
 385 ;;; debug-blocks.
 386 (defstruct (debug-block (:constructor nil))
 387   ;; Code-locations where execution continues after this block.
 388   (successors nil :type list)
 389   ;; This indicates whether the block is a special glob of code shared by
 390   ;; various functions and tucked away elsewhere in a component. This kind of
 391   ;; block has no start code-location. In an interpreted-debug-block, this is
 392   ;; always nil. This slot is in all debug-blocks since it is an exported
 393   ;; interface.
 394   (elsewhere-p nil :type boolean))
 395 (def!method print-object ((obj debug-block) str)
 396   (print-unreadable-object (obj str :type t)
 397     (prin1 (debug-block-function-name obj) str)))
 398
 399 #!+sb-doc
 400 (setf (fdocumentation 'debug-block-successors 'function)
 401   "Returns the list of possible code-locations where execution may continue
 402    when the basic-block represented by debug-block completes its execution.")
 403
 404 #!+sb-doc
 405 (setf (fdocumentation 'debug-block-elsewhere-p 'function)
 406   "Returns whether debug-block represents elsewhere code.")
 407
 408 (defstruct (compiled-debug-block (:include debug-block)
 409                                  (:constructor
 410                                   make-compiled-debug-block
 411                                   (code-locations successors elsewhere-p)))
 412   ;; Code-location information for the block.
 413   (code-locations nil :type simple-vector))
 414
 415 (defstruct (interpreted-debug-block (:include debug-block
 416                                               (elsewhere-p nil))
 417                                     (:constructor %make-interpreted-debug-block
 418                                                   (ir1-block)))
 419   ;; This is the IR1 block this debug-block represents.
 420   (ir1-block nil :type sb!c::cblock)
 421   ;; Code-location information for the block.
 422   (locations :unparsed :type (or (member :unparsed) simple-vector)))
 423
 424 (defvar *ir1-block-debug-block* (make-hash-table :test 'eq))
 425
 426 ;;; Make a DEBUG-BLOCK for the interpreter's IR1-BLOCK. If we have it
 427 ;;; in the cache, return it. If we need to make it, then first make
 428 ;;; DEBUG-BLOCKs for all the IR1-BLOCKs in IR1-BLOCK's home lambda;
 429 ;;; this makes sure all the successors of IR1-BLOCK have DEBUG-BLOCKs.
 430 ;;; We need this to fill in the resulting DEBUG-BLOCK's successors
 431 ;;; list with DEBUG-BLOCKs, not IR1-BLOCKs. After making all the
 432 ;;; possible DEBUG-BLOCKs we'll need to reference, go back over the
 433 ;;; list of new DEBUG-BLOCKs and fill in their successor slots with
 434 ;;; lists of DEBUG-BLOCKs. Then look up our argument IR1-BLOCK to find
 435 ;;; its DEBUG-BLOCK since we know we have it now.
 436 (defun make-interpreted-debug-block (ir1-block)
 437   (check-type ir1-block sb!c::cblock)
 438   (let ((res (gethash ir1-block *ir1-block-debug-block*)))
 439     (or res
 440         (let ((lambda (sb!c::block-home-lambda ir1-block)))
 441           (sb!c::do-blocks (block (sb!c::block-component ir1-block))
 442             (when (eq lambda (sb!c::block-home-lambda block))
 443               (push (setf (gethash block *ir1-block-debug-block*)
 444                           (%make-interpreted-debug-block block))
 445                     res)))
 446           (dolist (block res)
 447             (let* ((successors nil)
 448                    (cblock (interpreted-debug-block-ir1-block block))
 449                    (succ (sb!c::block-succ cblock))
 450                    (valid-succ
 451                     (if (and succ
 452                              (eq (car succ)
 453                                  (sb!c::component-tail
 454                                   (sb!c::block-component cblock))))
 455                         ()
 456                         succ)))
 457               (dolist (sblock valid-succ)
 458                 (let ((dblock (gethash sblock *ir1-block-debug-block*)))
 459                   (when dblock
 460                     (push dblock successors))))
 461               (setf (debug-block-successors block) (nreverse successors))))
 462           (gethash ir1-block *ir1-block-debug-block*)))))
 463
 464 ;;;; breakpoints
 465
 466 ;;; This is an internal structure that manages information about a
 467 ;;; breakpoint locations. See *COMPONENT-BREAKPOINT-OFFSETS*.
 468 (defstruct (breakpoint-data (:constructor make-breakpoint-data
 469                                           (component offset)))
 470   ;; This is the component in which the breakpoint lies.
 471   component
 472   ;; This is the byte offset into the component.
 473   (offset nil :type sb!c::index)
 474   ;; The original instruction replaced by the breakpoint.
 475   (instruction nil :type (or null (unsigned-byte 32)))
 476   ;; A list of user breakpoints at this location.
 477   (breakpoints nil :type list))
 478 (def!method print-object ((obj breakpoint-data) str)
 479   (print-unreadable-object (obj str :type t)
 480     (format str "~S at ~S"
 481             (debug-function-name
 482              (debug-function-from-pc (breakpoint-data-component obj)
 483                                      (breakpoint-data-offset obj)))
 484             (breakpoint-data-offset obj))))
 485
 486 (defstruct (breakpoint (:constructor %make-breakpoint
 487                                      (hook-function what kind %info)))
 488   ;; This is the function invoked when execution encounters the
 489   ;; breakpoint. It takes a frame, the breakpoint, and optionally a
 490   ;; list of values. Values are supplied for :FUNCTION-END breakpoints
 491   ;; as values to return for the function containing the breakpoint.
 492   ;; :FUNCTION-END breakpoint hook-functions also take a cookie
 493   ;; argument. See COOKIE-FUN slot.
 494   (hook-function nil :type function)
 495   ;; CODE-LOCATION or DEBUG-FUNCTION
 496   (what nil :type (or code-location debug-function))
 497   ;; :CODE-LOCATION, :FUNCTION-START, or :FUNCTION-END for that kind
 498   ;; of breakpoint. :UNKNOWN-RETURN-PARTNER if this is the partner of
 499   ;; a :code-location breakpoint at an :UNKNOWN-RETURN code-location.
 500   (kind nil :type (member :code-location :function-start :function-end
 501                           :unknown-return-partner))
 502   ;; Status helps the user and the implementation.
 503   (status :inactive :type (member :active :inactive :deleted))
 504   ;; This is a backpointer to a breakpoint-data.
 505   (internal-data nil :type (or null breakpoint-data))
 506   ;; With code-locations whose type is :UNKNOWN-RETURN, there are
 507   ;; really two breakpoints: one at the multiple-value entry point,
 508   ;; and one at the single-value entry point. This slot holds the
 509   ;; breakpoint for the other one, or NIL if this isn't at an
 510   ;; :UNKNOWN-RETURN code location.
 511   (unknown-return-partner nil :type (or null breakpoint))
 512   ;; :FUNCTION-END breakpoints use a breakpoint at the :FUNCTION-START
 513   ;; to establish the end breakpoint upon function entry. We do this
 514   ;; by frobbing the LRA to jump to a special piece of code that
 515   ;; breaks and provides the return values for the returnee. This slot
 516   ;; points to the start breakpoint, so we can activate, deactivate,
 517   ;; and delete it.
 518   (start-helper nil :type (or null breakpoint))
 519   ;; This is a hook users supply to get a dynamically unique cookie
 520   ;; for identifying :FUNCTION-END breakpoint executions. That is, if
 521   ;; there is one :FUNCTION-END breakpoint, but there may be multiple
 522   ;; pending calls of its function on the stack. This function takes
 523   ;; the cookie, and the hook-function takes the cookie too.
 524   (cookie-fun nil :type (or null function))
 525   ;; This slot users can set with whatever information they find useful.
 526   %info)
 527 (def!method print-object ((obj breakpoint) str)
 528   (let ((what (breakpoint-what obj)))
 529     (print-unreadable-object (obj str :type t)
 530       (format str
 531               "~S~:[~;~:*~S~]"
 532               (etypecase what
 533                 (code-location what)
 534                 (debug-function (debug-function-name what)))
 535               (etypecase what
 536                 (code-location nil)
 537                 (debug-function (breakpoint-kind obj)))))))
 538
 539 #!+sb-doc
 540 (setf (fdocumentation 'breakpoint-hook-function 'function)
 541   "Returns the breakpoint's function the system calls when execution encounters
 542    the breakpoint, and it is active. This is SETF'able.")
 543
 544 #!+sb-doc
 545 (setf (fdocumentation 'breakpoint-what 'function)
 546   "Returns the breakpoint's what specification.")
 547
 548 #!+sb-doc
 549 (setf (fdocumentation 'breakpoint-kind 'function)
 550   "Returns the breakpoint's kind specification.")
 551
 552 ;;;; CODE-LOCATIONs
 553
 554 (defstruct (code-location (:constructor nil))
 555   ;; This is the debug-function containing code-location.
 556   (debug-function nil :type debug-function)
 557   ;; This is initially :UNSURE. Upon first trying to access an
 558   ;; :unparsed slot, if the data is unavailable, then this becomes t,
 559   ;; and the code-location is unknown. If the data is available, this
 560   ;; becomes nil, a known location. We can't use a separate type
 561   ;; code-location for this since we must return code-locations before
 562   ;; we can tell whether they're known or unknown. For example, when
 563   ;; parsing the stack, we don't want to unpack all the variables and
 564   ;; blocks just to make frames.
 565   (%unknown-p :unsure :type (member t nil :unsure))
 566   ;; This is the debug-block containing code-location. Possibly toss
 567   ;; this out and just find it in the blocks cache in debug-function.
 568   (%debug-block :unparsed :type (or debug-block (member :unparsed)))
 569   ;; This is the number of forms processed by the compiler or loader
 570   ;; before the top-level form containing this code-location.
 571   (%tlf-offset :unparsed :type (or sb!c::index (member :unparsed)))
 572   ;; This is the depth-first number of the node that begins
 573   ;; code-location within its top-level form.
 574   (%form-number :unparsed :type (or sb!c::index (member :unparsed))))
 575 (def!method print-object ((obj code-location) str)
 576   (print-unreadable-object (obj str :type t)
 577     (prin1 (debug-function-name (code-location-debug-function obj))
 578            str)))
 579
 580 #!+sb-doc
 581 (setf (fdocumentation 'code-location-debug-function 'function)
 582   "Returns the debug-function representing information about the function
 583    corresponding to the code-location.")
 584
 585 (defstruct (compiled-code-location
 586             (:include code-location)
 587             (:constructor make-known-code-location
 588                           (pc debug-function %tlf-offset %form-number
 589                               %live-set kind &aux (%unknown-p nil)))
 590             (:constructor make-compiled-code-location (pc debug-function)))
 591   ;; This is an index into debug-function's component slot.
 592   (pc nil :type sb!c::index)
 593   ;; This is a bit-vector indexed by a variable's position in
 594   ;; DEBUG-FUNCTION-DEBUG-VARS indicating whether the variable has a
 595   ;; valid value at this code-location. (unexported).
 596   (%live-set :unparsed :type (or simple-bit-vector (member :unparsed)))
 597   ;; (unexported) To see SB!C::LOCATION-KIND, do
 598   ;; (SB!KERNEL:TYPE-EXPAND 'SB!C::LOCATION-KIND).
 599   (kind :unparsed :type (or (member :unparsed) sb!c::location-kind)))
 600
 601 (defstruct (interpreted-code-location
 602             (:include code-location
 603                       (%unknown-p nil))
 604             (:constructor make-interpreted-code-location
 605                           (ir1-node debug-function)))
 606   ;; This is an index into debug-function's component slot.
 607   (ir1-node nil :type sb!c::node))
 608
 609 ;;; DEBUG-SOURCEs
 610
 611 #!-sb-fluid (declaim (inline debug-source-root-number))
 612 (defun debug-source-root-number (debug-source)
 613   #!+sb-doc
 614   "Returns the number of top-level forms processed by the compiler before
 615    compiling this source. If this source is uncompiled, this is zero. This
 616    may be zero even if the source is compiled since the first form in the first
 617    file compiled in one compilation, for example, must have a root number of
 618    zero -- the compiler saw no other top-level forms before it."
 619   (sb!c::debug-source-source-root debug-source))
 620
 621 #!+sb-doc
 622 (setf (fdocumentation 'sb!c::debug-source-from 'function)
 623   "Returns an indication of the type of source. The following are the possible
 624    values:
 625       :file    from a file (obtained by COMPILE-FILE if compiled).
 626       :lisp    from Lisp (obtained by COMPILE if compiled).")
 627
 628 #!+sb-doc
 629 (setf (fdocumentation 'sb!c::debug-source-name 'function)
 630   "Returns the actual source in some sense represented by debug-source, which
 631    is related to DEBUG-SOURCE-FROM:
 632       :file    the pathname of the file.
 633       :lisp    a lambda-expression.")
 634
 635 #!+sb-doc
 636 (setf (fdocumentation 'sb!c::debug-source-created 'function)
 637   "Returns the universal time someone created the source. This may be nil if
 638    it is unavailable.")
 639
 640 #!+sb-doc
 641 (setf (fdocumentation 'sb!c::debug-source-compiled 'function)
 642   "Returns the time someone compiled the source. This is nil if the source
 643    is uncompiled.")
 644
 645 #!+sb-doc
 646 (setf (fdocumentation 'sb!c::debug-source-start-positions 'function)
 647   "This function returns the file position of each top-level form as an array
 648    if debug-source is from a :file. If DEBUG-SOURCE-FROM is :lisp,
 649    this returns nil.")
 650
 651 #!+sb-doc
 652 (setf (fdocumentation 'sb!c::debug-source-p 'function)
 653   "Returns whether object is a debug-source.")
 654 \f
 655 ;;;; frames
 656
 657 ;;; This is used in FIND-ESCAPE-FRAME and with the bogus components
 658 ;;; and LRAs used for :function-end breakpoints. When a components
 659 ;;; debug-info slot is :bogus-lra, then the real-lra-slot contains the
 660 ;;; real component to continue executing, as opposed to the bogus
 661 ;;; component which appeared in some frame's LRA location.
 662 (defconstant real-lra-slot sb!vm:code-constants-offset)
 663
 664 ;;; These are magically converted by the compiler.
 665 (defun current-sp () (current-sp))
 666 (defun current-fp () (current-fp))
 667 (defun stack-ref (s n) (stack-ref s n))
 668 (defun %set-stack-ref (s n value) (%set-stack-ref s n value))
 669 (defun function-code-header (fun) (function-code-header fun))
 670 #!-gengc (defun lra-code-header (lra) (lra-code-header lra))
 671 (defun make-lisp-obj (value) (make-lisp-obj value))
 672 (defun get-lisp-obj-address (thing) (get-lisp-obj-address thing))
 673 (defun function-word-offset (fun) (function-word-offset fun))
 674
 675 #!-sb-fluid (declaim (inline cstack-pointer-valid-p))
 676 (defun cstack-pointer-valid-p (x)
 677   (declare (type system-area-pointer x))
 678   #!-x86 ; stack grows toward high address values
 679   (and (sap< x (current-sp))
 680        (sap<= #!-gengc (int-sap control-stack-start)
 681               #!+gengc (mutator-control-stack-base)
 682               x)
 683        (zerop (logand (sap-int x) #b11)))
 684   #!+x86 ; stack grows toward low address values
 685   (and (sap>= x (current-sp))
 686        (sap> (int-sap control-stack-end) x)
 687        (zerop (logand (sap-int x) #b11))))
 688
 689 #!+(or gengc x86)
 690 (sb!alien:def-alien-routine component-ptr-from-pc (system-area-pointer)
 691   (pc system-area-pointer))
 692
 693 #!+(or gengc x86)
 694 (defun component-from-component-ptr (component-ptr)
 695   (declare (type system-area-pointer component-ptr))
 696   (make-lisp-obj (logior (sap-int component-ptr)
 697                          sb!vm:other-pointer-type)))
 698
 699 ;;;; X86 support
 700
 701 #!+x86
 702 (progn
 703
 704 (defun compute-lra-data-from-pc (pc)
 705   (declare (type system-area-pointer pc))
 706   (let ((component-ptr (component-ptr-from-pc pc)))
 707     (unless (sap= component-ptr (int-sap #x0))
 708        (let* ((code (component-from-component-ptr component-ptr))
 709               (code-header-len (* (get-header-data code) sb!vm:word-bytes))
 710               (pc-offset (- (sap-int pc)
 711                             (- (get-lisp-obj-address code)
 712                                sb!vm:other-pointer-type)
 713                             code-header-len)))
 714 ;        (format t "c-lra-fpc ~A ~A ~A~%" pc code pc-offset)
 715          (values pc-offset code)))))
 716
 717 (defconstant sb!vm::nargs-offset #.sb!vm::ecx-offset)
 718
 719 ;;; Check for a valid return address - it could be any valid C/Lisp
 720 ;;; address.
 721 ;;;
 722 ;;; XXX Could be a little smarter.
 723 #!-sb-fluid (declaim (inline ra-pointer-valid-p))
 724 (defun ra-pointer-valid-p (ra)
 725   (declare (type system-area-pointer ra))
 726   (and
 727    ;; Not the first page which is unmapped.
 728    (>= (sap-int ra) 4096)
 729    ;; Not a Lisp stack pointer.
 730    (not (cstack-pointer-valid-p ra))))
 731
 732 ;;; Try to find a valid previous stack. This is complex on the x86 as
 733 ;;; it can jump between C and Lisp frames. To help find a valid frame
 734 ;;; it searches backwards.
 735 ;;;
 736 ;;; XXX Should probably check whether it has reached the bottom of the
 737 ;;; stack.
 738 ;;;
 739 ;;; XXX Should handle interrupted frames, both Lisp and C. At present
 740 ;;; it manages to find a fp trail, see linux hack below.
 741 (defun x86-call-context (fp &key (depth 0))
 742   (declare (type system-area-pointer fp)
 743            (fixnum depth))
 744   ;;(format t "*CC ~S ~S~%" fp depth)
 745   (cond
 746    ((not (cstack-pointer-valid-p fp))
 747     #+nil (format t "debug invalid fp ~S~%" fp)
 748     nil)
 749    (t
 750     ;; Check the two possible frame pointers.
 751     (let ((lisp-ocfp (sap-ref-sap fp (- (* (1+ sb!vm::ocfp-save-offset) 4))))
 752           (lisp-ra (sap-ref-sap fp (- (* (1+ sb!vm::return-pc-save-offset)
 753                                          4))))
 754           (c-ocfp (sap-ref-sap fp (* 0 sb!vm:word-bytes)))
 755           (c-ra (sap-ref-sap fp (* 1 sb!vm:word-bytes))))
 756       (cond ((and (sap> lisp-ocfp fp) (cstack-pointer-valid-p lisp-ocfp)
 757                   (ra-pointer-valid-p lisp-ra)
 758                   (sap> c-ocfp fp) (cstack-pointer-valid-p c-ocfp)
 759                   (ra-pointer-valid-p c-ra))
 760              #+nil (format t
 761                            "*C Both valid ~S ~S ~S ~S~%"
 762                            lisp-ocfp lisp-ra c-ocfp c-ra)
 763              ;; Look forward another step to check their validity.
 764              (let ((lisp-path-fp (x86-call-context lisp-ocfp
 765                                                    :depth (1+ depth)))
 766                    (c-path-fp (x86-call-context c-ocfp :depth (1+ depth))))
 767                (cond ((and lisp-path-fp c-path-fp)
 768                        ;; Both still seem valid - choose the lisp frame.
 769                        #+nil (when (zerop depth)
 770                                (format t "debug: both still valid ~S ~S ~S ~S~%"
 771                                        lisp-ocfp lisp-ra c-ocfp c-ra))
 772                       #+freebsd
 773                       (if (sap> lisp-ocfp c-ocfp)
 774                         (values lisp-ra lisp-ocfp)
 775                         (values c-ra c-ocfp))
 776                        #-freebsd
 777                        (values lisp-ra lisp-ocfp))
 778                      (lisp-path-fp
 779                       ;; The lisp convention is looking good.
 780                       #+nil (format t "*C lisp-ocfp ~S ~S~%" lisp-ocfp lisp-ra)
 781                       (values lisp-ra lisp-ocfp))
 782                      (c-path-fp
 783                       ;; The C convention is looking good.
 784                       #+nil (format t "*C c-ocfp ~S ~S~%" c-ocfp c-ra)
 785                       (values c-ra c-ocfp))
 786                      (t
 787                       ;; Neither seems right?
 788                       #+nil (format t "debug: no valid2 fp found ~S ~S~%"
 789                                     lisp-ocfp c-ocfp)
 790                       nil))))
 791             ((and (sap> lisp-ocfp fp) (cstack-pointer-valid-p lisp-ocfp)
 792                   (ra-pointer-valid-p lisp-ra))
 793              ;; The lisp convention is looking good.
 794              #+nil (format t "*C lisp-ocfp ~S ~S~%" lisp-ocfp lisp-ra)
 795              (values lisp-ra lisp-ocfp))
 796             ((and (sap> c-ocfp fp) (cstack-pointer-valid-p c-ocfp)
 797                   #!-linux (ra-pointer-valid-p c-ra))
 798              ;; The C convention is looking good.
 799              #+nil (format t "*C c-ocfp ~S ~S~%" c-ocfp c-ra)
 800              (values c-ra c-ocfp))
 801             (t
 802              #+nil (format t "debug: no valid fp found ~S ~S~%"
 803                            lisp-ocfp c-ocfp)
 804              nil))))))
 805
 806 ) ; #+x86 PROGN
 807 \f
 808 ;;; Convert the descriptor into a SAP. The bits all stay the same, we just
 809 ;;; change our notion of what we think they are.
 810 #!-sb-fluid (declaim (inline descriptor-sap))
 811 (defun descriptor-sap (x)
 812   (int-sap (get-lisp-obj-address x)))
 813
 814 (defun top-frame ()
 815   #!+sb-doc
 816   "Returns the top frame of the control stack as it was before calling this
 817    function."
 818   (multiple-value-bind (fp pc) (%caller-frame-and-pc)
 819     (possibly-an-interpreted-frame
 820      (compute-calling-frame (descriptor-sap fp)
 821                             #!-gengc pc #!+gengc (descriptor-sap pc)
 822                             nil)
 823      nil)))
 824
 825 (defun flush-frames-above (frame)
 826   #!+sb-doc
 827   "Flush all of the frames above FRAME, and renumber all the frames below
 828    FRAME."
 829   (setf (frame-up frame) nil)
 830   (do ((number 0 (1+ number))
 831        (frame frame (frame-%down frame)))
 832       ((not (frame-p frame)))
 833     (setf (frame-number frame) number)))
 834
 835 ;;; We have to access the old-fp and return-pc out of frame and pass them to
 836 ;;; COMPUTE-CALLING-FRAME.
 837 (defun frame-down (frame)
 838   #!+sb-doc
 839   "Returns the frame immediately below frame on the stack. When frame is
 840    the bottom of the stack, this returns nil."
 841   (let ((down (frame-%down frame)))
 842     (if (eq down :unparsed)
 843         (let* ((real (frame-real-frame frame))
 844                (debug-fun (frame-debug-function real)))
 845           (setf (frame-%down frame)
 846                 (etypecase debug-fun
 847                   (compiled-debug-function
 848                    (let ((c-d-f (compiled-debug-function-compiler-debug-fun
 849                                  debug-fun)))
 850                      (possibly-an-interpreted-frame
 851                       (compute-calling-frame
 852                        (descriptor-sap
 853                         (get-context-value
 854                          real sb!vm::ocfp-save-offset
 855                          (sb!c::compiled-debug-function-old-fp c-d-f)))
 856                        #!-gengc
 857                        (get-context-value
 858                         real sb!vm::lra-save-offset
 859                         (sb!c::compiled-debug-function-return-pc c-d-f))
 860                        #!+gengc
 861                        (descriptor-sap
 862                         (get-context-value
 863                          real sb!vm::ra-save-offset
 864                          (sb!c::compiled-debug-function-return-pc c-d-f)))
 865                        frame)
 866                       frame)))
 867                   (bogus-debug-function
 868                    (let ((fp (frame-pointer real)))
 869                      (when (cstack-pointer-valid-p fp)
 870                        #!+x86
 871                         (multiple-value-bind (ra ofp) (x86-call-context fp)
 872                           (compute-calling-frame ofp ra frame))
 873                         #!-x86
 874                        (compute-calling-frame
 875                         #!-alpha
 876                         (sap-ref-sap fp (* sb!vm::ocfp-save-offset
 877                                            sb!vm:word-bytes))
 878                         #!+alpha
 879                         (int-sap
 880                          (sap-ref-32 fp (* sb!vm::ocfp-save-offset
 881                                            sb!vm:word-bytes)))
 882
 883                         #!-gengc
 884                         (stack-ref fp sb!vm::lra-save-offset)
 885                         #!+gengc
 886                         (sap-ref-sap fp (* sb!vm::ra-save-offset
 887                                            sb!vm:word-bytes))
 888                         frame)))))))
 889         down)))
 890
 891 ;;; Get the old FP or return PC out of FRAME. STACK-SLOT is the
 892 ;;; standard save location offset on the stack. LOC is the saved
 893 ;;; SC-OFFSET describing the main location.
 894 #!-x86
 895 (defun get-context-value (frame stack-slot loc)
 896   (declare (type compiled-frame frame) (type unsigned-byte stack-slot)
 897            (type sb!c::sc-offset loc))
 898   (let ((pointer (frame-pointer frame))
 899         (escaped (compiled-frame-escaped frame)))
 900     (if escaped
 901         (sub-access-debug-var-slot pointer loc escaped)
 902         (stack-ref pointer stack-slot))))
 903 #!+x86
 904 (defun get-context-value (frame stack-slot loc)
 905   (declare (type compiled-frame frame) (type unsigned-byte stack-slot)
 906            (type sb!c::sc-offset loc))
 907   (let ((pointer (frame-pointer frame))
 908         (escaped (compiled-frame-escaped frame)))
 909     (if escaped
 910         (sub-access-debug-var-slot pointer loc escaped)
 911         (ecase stack-slot
 912           (#.sb!vm::ocfp-save-offset
 913            (stack-ref pointer stack-slot))
 914           (#.sb!vm::lra-save-offset
 915            (sap-ref-sap pointer (- (* (1+ stack-slot) 4))))))))
 916
 917 #!-x86
 918 (defun (setf get-context-value) (value frame stack-slot loc)
 919   (declare (type compiled-frame frame) (type unsigned-byte stack-slot)
 920            (type sb!c::sc-offset loc))
 921   (let ((pointer (frame-pointer frame))
 922         (escaped (compiled-frame-escaped frame)))
 923     (if escaped
 924         (sub-set-debug-var-slot pointer loc value escaped)
 925         (setf (stack-ref pointer stack-slot) value))))
 926
 927 #!+x86
 928 (defun (setf get-context-value) (value frame stack-slot loc)
 929   (declare (type compiled-frame frame) (type unsigned-byte stack-slot)
 930            (type sb!c::sc-offset loc))
 931   (let ((pointer (frame-pointer frame))
 932         (escaped (compiled-frame-escaped frame)))
 933     (if escaped
 934         (sub-set-debug-var-slot pointer loc value escaped)
 935         (ecase stack-slot
 936           (#.sb!vm::ocfp-save-offset
 937            (setf (stack-ref pointer stack-slot) value))
 938           (#.sb!vm::lra-save-offset
 939            (setf (sap-ref-sap pointer (- (* (1+ stack-slot) 4))) value))))))
 940
 941 (defvar *debugging-interpreter* nil
 942   #!+sb-doc
 943   "When set, the debugger foregoes making interpreted-frames, so you can
 944    debug the functions that manifest the interpreter.")
 945
 946 ;;; This takes a newly computed frame, FRAME, and the frame above it
 947 ;;; on the stack, UP-FRAME, which is possibly NIL. FRAME is NIL when
 948 ;;; we hit the bottom of the control stack. When FRAME represents a
 949 ;;; call to SB!EVAL::INTERNAL-APPLY-LOOP, we make an interpreted frame
 950 ;;; to replace FRAME. The interpreted frame points to FRAME.
 951 (defun possibly-an-interpreted-frame (frame up-frame)
 952   (if (or (not frame)
 953           (not (eq (debug-function-name (frame-debug-function frame))
 954                    'sb!eval::internal-apply-loop))
 955           *debugging-interpreter*
 956           (compiled-frame-escaped frame))
 957       frame
 958       (flet ((get-var (name location)
 959                (let ((vars (sb!di:ambiguous-debug-vars
 960                             (sb!di:frame-debug-function frame) name)))
 961                  (when (or (null vars) (> (length vars) 1))
 962                    (error "zero or more than one ~A variable in ~
 963                            SB!EVAL::INTERNAL-APPLY-LOOP"
 964                           (string-downcase name)))
 965                  (if (eq (debug-var-validity (car vars) location)
 966                          :valid)
 967                      (car vars)))))
 968         (let* ((code-loc (frame-code-location frame))
 969                (ptr-var (get-var "FRAME-PTR" code-loc))
 970                (node-var (get-var "NODE" code-loc))
 971                (closure-var (get-var "CLOSURE" code-loc)))
 972           (if (and ptr-var node-var closure-var)
 973               (let* ((node (debug-var-value node-var frame))
 974                      (d-fun (make-interpreted-debug-function
 975                              (sb!c::block-home-lambda (sb!c::node-block
 976                                                        node)))))
 977                 (make-interpreted-frame
 978                  (debug-var-value ptr-var frame)
 979                  up-frame
 980                  d-fun
 981                  (make-interpreted-code-location node d-fun)
 982                  (frame-number frame)
 983                  frame
 984                  (debug-var-value closure-var frame)))
 985               frame)))))
 986
 987 ;;; This returns a frame for the one existing in time immediately
 988 ;;; prior to the frame referenced by current-fp. This is current-fp's
 989 ;;; caller or the next frame down the control stack. If there is no
 990 ;;; down frame, this returns nil for the bottom of the stack. Up-frame
 991 ;;; is the up link for the resulting frame object, and it is nil when
 992 ;;; we call this to get the top of the stack.
 993 ;;;
 994 ;;; The current frame contains the pointer to the temporally previous
 995 ;;; frame we want, and the current frame contains the pc at which we
 996 ;;; will continue executing upon returning to that previous frame.
 997 ;;;
 998 ;;; Note: Sometimes LRA is actually a fixnum. This happens when lisp
 999 ;;; calls into C. In this case, the code object is stored on the stack
1000 ;;; after the LRA, and the LRA is the word offset.
1001 #!-(or gengc x86)
1002 (defun compute-calling-frame (caller lra up-frame)
1003   (declare (type system-area-pointer caller))
1004   (when (cstack-pointer-valid-p caller)
1005     (multiple-value-bind (code pc-offset escaped)
1006         (if lra
1007             (multiple-value-bind (word-offset code)
1008                 (if (fixnump lra)
1009                     (let ((fp (frame-pointer up-frame)))
1010                       (values lra
1011                               (stack-ref fp (1+ sb!vm::lra-save-offset))))
1012                     (values (get-header-data lra)
1013                             (lra-code-header lra)))
1014               (if code
1015                   (values code
1016                           (* (1+ (- word-offset (get-header-data code)))
1017                              sb!vm:word-bytes)
1018                           nil)
1019                   (values :foreign-function
1020                           0
1021                           nil)))
1022             (find-escaped-frame caller))
1023       (if (and (code-component-p code)
1024                (eq (%code-debug-info code) :bogus-lra))
1025           (let ((real-lra (code-header-ref code real-lra-slot)))
1026             (compute-calling-frame caller real-lra up-frame))
1027           (let ((d-fun (case code
1028                          (:undefined-function
1029                           (make-bogus-debug-function
1030                            "undefined function"))
1031                          (:foreign-function
1032                           (make-bogus-debug-function
1033                            "foreign function call land"))
1034                          ((nil)
1035                           (make-bogus-debug-function
1036                            "bogus stack frame"))
1037                          (t
1038                           (debug-function-from-pc code pc-offset)))))
1039             (make-compiled-frame caller up-frame d-fun
1040                                  (code-location-from-pc d-fun pc-offset
1041                                                         escaped)
1042                                  (if up-frame (1+ (frame-number up-frame)) 0)
1043                                  escaped))))))
1044
1045 #!+x86
1046 (defun compute-calling-frame (caller ra up-frame)
1047   (declare (type system-area-pointer caller ra))
1048 ;  (format t "ccf: ~A ~A ~A~%" caller ra up-frame)
1049   (when (cstack-pointer-valid-p caller)
1050 ;    (format t "ccf2~%")
1051     ;; First check for an escaped frame.
1052     (multiple-value-bind (code pc-offset escaped) (find-escaped-frame caller)
1053         (cond (code
1054                ;; If it's escaped it may be a function end breakpoint trap.
1055 ;              (format t "ccf2: escaped ~S ~S~%" code pc-offset)
1056                (when (and (code-component-p code)
1057                           (eq (%code-debug-info code) :bogus-lra))
1058                  ;; If :bogus-lra grab the real lra.
1059                  (setq pc-offset (code-header-ref
1060                                   code (1+ real-lra-slot)))
1061                  (setq code (code-header-ref code real-lra-slot))
1062 ;                (format t "ccf3 :bogus-lra ~S ~S~%" code pc-offset)
1063                  (assert code)))
1064               (t
1065                ;; Not escaped
1066                (multiple-value-setq (pc-offset code)
1067                  (compute-lra-data-from-pc ra))
1068 ;              (format t "ccf4 ~S ~S~%" code pc-offset)
1069                (unless code
1070                  (setf code :foreign-function
1071                        pc-offset 0
1072                        escaped nil))))
1073
1074         (let ((d-fun (case code
1075                            (:undefined-function
1076                             (make-bogus-debug-function
1077                              "undefined function"))
1078                            (:foreign-function
1079                             (make-bogus-debug-function
1080                              "foreign function call land"))
1081                            ((nil)
1082                             (make-bogus-debug-function
1083                              "bogus stack frame"))
1084                            (t
1085                             (debug-function-from-pc code pc-offset)))))
1086           (make-compiled-frame caller up-frame d-fun
1087                                (code-location-from-pc d-fun pc-offset
1088                                                       escaped)
1089                                (if up-frame (1+ (frame-number up-frame)) 0)
1090                                escaped)))))
1091
1092 #!-(or gengc x86)
1093 ;;; FIXME: The original CMU CL code had support for this case, but it
1094 ;;; must have been fairly stale even in CMU CL, since it had
1095 ;;; references to the MIPS package, and there have been enough
1096 ;;; relevant changes in SBCL (particularly using
1097 ;;; POSIX/SIGACTION0-style signal context instead of BSD-style
1098 ;;; sigcontext) that this code is unmaintainable (since as of
1099 ;;; sbcl-0.6.7, and for the foreseeable future, we can't test it,
1100 ;;; since we only support X86 and its gencgc).
1101 ;;;
1102 ;;; If we restore this case, the best approach would be to go back to
1103 ;;; the original CMU CL code and start from there.
1104 (eval-when (:compile-toplevel :load-toplevel :execute)
1105   (error "hopelessly stale"))
1106 #!+x86
1107 (defun find-escaped-frame (frame-pointer)
1108   (declare (type system-area-pointer frame-pointer))
1109   (dotimes (index sb!impl::*free-interrupt-context-index* (values nil 0 nil))
1110     (sb!alien:with-alien
1111         ((lisp-interrupt-contexts (array (* os-context-t) nil)
1112                                   :extern))
1113       (let ((context (sb!alien:deref lisp-interrupt-contexts index)))
1114         (when (= (sap-int frame-pointer)
1115                  (sb!vm:context-register context sb!vm::cfp-offset))
1116           (without-gcing
1117            (let* ((component-ptr (component-ptr-from-pc
1118                                   (sb!vm:context-pc context)))
1119                   (code (unless (sap= component-ptr (int-sap #x0))
1120                           (component-from-component-ptr component-ptr))))
1121              (when (null code)
1122                (return (values code 0 context)))
1123              (let* ((code-header-len (* (get-header-data code)
1124                                         sb!vm:word-bytes))
1125                     (pc-offset
1126                      (- (sap-int (sb!vm:context-pc context))
1127                         (- (get-lisp-obj-address code)
1128                            sb!vm:other-pointer-type)
1129                         code-header-len)))
1130                (unless (<= 0 pc-offset
1131                            (* (code-header-ref code sb!vm:code-code-size-slot)
1132                               sb!vm:word-bytes))
1133                  ;; We were in an assembly routine. Therefore, use the
1134                  ;; LRA as the pc.
1135                  ;;
1136                  ;; FIXME: Should this be WARN or ERROR or what?
1137                  (format t "** pc-offset ~S not in code obj ~S?~%"
1138                          pc-offset code))
1139                (return
1140                 (values code pc-offset context))))))))))
1141
1142 ;;; Find the code object corresponding to the object represented by
1143 ;;; bits and return it. We assume bogus functions correspond to the
1144 ;;; undefined-function.
1145 #!-gengc
1146 (defun code-object-from-bits (bits)
1147   (declare (type (unsigned-byte 32) bits))
1148   (let ((object (make-lisp-obj bits)))
1149     (if (functionp object)
1150         (or (function-code-header object)
1151             :undefined-function)
1152         (let ((lowtag (get-lowtag object)))
1153           (if (= lowtag sb!vm:other-pointer-type)
1154               (let ((type (get-type object)))
1155                 (cond ((= type sb!vm:code-header-type)
1156                        object)
1157                       ((= type sb!vm:return-pc-header-type)
1158                        (lra-code-header object))
1159                       (t
1160                        nil))))))))
1161
1162 ;;; SB!KERNEL:*SAVED-STATE-CHAIN* -- maintained by the C code as a
1163 ;;; list of SAPs, each SAP pointing to a saved exception state.
1164 #!+gengc
1165 (declaim (special *saved-state-chain*))
1166
1167 ;;; CMU CL had
1168 ;;;   (DEFUN LOOKUP-TRACE-TABLE-ENTRY (COMPONENT PC) ..)
1169 ;;; for this case, but it hasn't been maintained in SBCL.
1170 #!+gengc
1171 (eval-when (:compile-toplevel :load-toplevel :execute)
1172   (error "hopelessly stale"))
1173
1174 ;;; CMU CL had
1175 ;;;   (DEFUN EXTRACT-INFO-FROM-STATE (STATE) ..)
1176 ;;; for this case, but it hasn't been maintained in SBCL.
1177 #!+gengc
1178 (eval-when (:compile-toplevel :load-toplevel :execute)
1179   (error "hopelessly stale"))
1180
1181 ;;; CMU CL had
1182 ;;;   (DEFUN COMPUTE-CALLING-FRAME (OCFP RA UP-FRAME) ..)
1183 ;;; for this case, but it hasn't been maintained in SBCL.
1184 #!+gengc
1185 (eval-when (:compile-toplevel :load-toplevel :execute)
1186   (error "hopelessly stale"))
1187 \f
1188 ;;;; frame utilities
1189
1190 ;;; This returns a COMPILED-DEBUG-FUNCTION for code and pc. We fetch
1191 ;;; the SB!C::DEBUG-INFO and run down its function-map to get a
1192 ;;; SB!C::COMPILED-DEBUG-FUNCTION from the pc. The result only needs
1193 ;;; to reference the component, for function constants, and the
1194 ;;; SB!C::COMPILED-DEBUG-FUNCTION.
1195 (defun debug-function-from-pc (component pc)
1196   (let ((info (%code-debug-info component)))
1197     (cond
1198      ((not info)
1199       (debug-signal 'no-debug-info :code-component component))
1200      ((eq info :bogus-lra)
1201       (make-bogus-debug-function "function end breakpoint"))
1202      (t
1203       (let* ((function-map (get-debug-info-function-map info))
1204              (len (length function-map)))
1205         (declare (simple-vector function-map))
1206         (if (= len 1)
1207             (make-compiled-debug-function (svref function-map 0) component)
1208             (let ((i 1)
1209                   (elsewhere-p
1210                    (>= pc (sb!c::compiled-debug-function-elsewhere-pc
1211                            (svref function-map 0)))))
1212               (declare (type sb!int:index i))
1213               (loop
1214                 (when (or (= i len)
1215                           (< pc (if elsewhere-p
1216                                     (sb!c::compiled-debug-function-elsewhere-pc
1217                                      (svref function-map (1+ i)))
1218                                     (svref function-map i))))
1219                   (return (make-compiled-debug-function
1220                            (svref function-map (1- i))
1221                            component)))
1222                 (incf i 2)))))))))
1223
1224 ;;; This returns a code-location for the COMPILED-DEBUG-FUNCTION,
1225 ;;; DEBUG-FUN, and the pc into its code vector. If we stopped at a
1226 ;;; breakpoint, find the CODE-LOCATION for that breakpoint. Otherwise,
1227 ;;; make an :UNSURE code location, so it can be filled in when we
1228 ;;; figure out what is going on.
1229 (defun code-location-from-pc (debug-fun pc escaped)
1230   (or (and (compiled-debug-function-p debug-fun)
1231            escaped
1232            (let ((data (breakpoint-data
1233                         (compiled-debug-function-component debug-fun)
1234                         pc nil)))
1235              (when (and data (breakpoint-data-breakpoints data))
1236                (let ((what (breakpoint-what
1237                             (first (breakpoint-data-breakpoints data)))))
1238                  (when (compiled-code-location-p what)
1239                    what)))))
1240       (make-compiled-code-location pc debug-fun)))
1241
1242 (defun frame-catches (frame)
1243   #!+sb-doc
1244   "Returns an a-list mapping catch tags to code-locations. These are
1245    code-locations at which execution would continue with frame as the top
1246    frame if someone threw to the corresponding tag."
1247   (let ((catch
1248          #!-gengc (descriptor-sap sb!impl::*current-catch-block*)
1249          #!+gengc (mutator-current-catch-block))
1250         (res nil)
1251         (fp (frame-pointer (frame-real-frame frame))))
1252     (loop
1253       (when (zerop (sap-int catch)) (return (nreverse res)))
1254       (when (sap= fp
1255                   #!-alpha
1256                   (sap-ref-sap catch
1257                                       (* sb!vm:catch-block-current-cont-slot
1258                                          sb!vm:word-bytes))
1259                   #!+alpha
1260                   (:int-sap
1261                    (sap-ref-32 catch
1262                                       (* sb!vm:catch-block-current-cont-slot
1263                                          sb!vm:word-bytes))))
1264         (let* (#!-(or gengc x86)
1265                (lra (stack-ref catch sb!vm:catch-block-entry-pc-slot))
1266                #!+(or gengc x86)
1267                (ra (sap-ref-sap
1268                     catch (* sb!vm:catch-block-entry-pc-slot
1269                              sb!vm:word-bytes)))
1270                #!-x86
1271                (component
1272                 (stack-ref catch sb!vm:catch-block-current-code-slot))
1273                #!+x86
1274                (component (component-from-component-ptr
1275                            (component-ptr-from-pc ra)))
1276                (offset
1277                 #!-(or gengc x86)
1278                 (* (- (1+ (get-header-data lra))
1279                       (get-header-data component))
1280                    sb!vm:word-bytes)
1281                 #!+gengc
1282                 (+ (- (sap-int ra)
1283                       (get-lisp-obj-address component)
1284                       (get-header-data component))
1285                    sb!vm:other-pointer-type)
1286                 #!+x86
1287                 (- (sap-int ra)
1288                    (- (get-lisp-obj-address component)
1289                       sb!vm:other-pointer-type)
1290                    (* (get-header-data component) sb!vm:word-bytes))))
1291           (push (cons #!-x86
1292                       (stack-ref catch sb!vm:catch-block-tag-slot)
1293                       #!+x86
1294                       (make-lisp-obj
1295                        (sap-ref-32 catch (* sb!vm:catch-block-tag-slot
1296                                                    sb!vm:word-bytes)))
1297                       (make-compiled-code-location
1298                        offset (frame-debug-function frame)))
1299                 res)))
1300       (setf catch
1301             #!-alpha
1302             (sap-ref-sap catch
1303                                 (* sb!vm:catch-block-previous-catch-slot
1304                                    sb!vm:word-bytes))
1305             #!+alpha
1306             (:int-sap
1307              (sap-ref-32 catch
1308                                 (* sb!vm:catch-block-previous-catch-slot
1309                                    sb!vm:word-bytes)))))))
1310
1311 ;;; If an interpreted frame, return the real frame, otherwise frame.
1312 (defun frame-real-frame (frame)
1313   (etypecase frame
1314     (compiled-frame frame)
1315     (interpreted-frame (interpreted-frame-real-frame frame))))
1316 \f
1317 ;;;; operations on DEBUG-FUNCTIONs
1318
1319 (defmacro do-debug-function-blocks ((block-var debug-function &optional result)
1320                                     &body body)
1321   #!+sb-doc
1322   "Executes the forms in a context with block-var bound to each debug-block in
1323    debug-function successively. Result is an optional form to execute for
1324    return values, and DO-DEBUG-FUNCTION-BLOCKS returns nil if there is no
1325    result form. This signals a no-debug-blocks condition when the
1326    debug-function lacks debug-block information."
1327   (let ((blocks (gensym))
1328         (i (gensym)))
1329     `(let ((,blocks (debug-function-debug-blocks ,debug-function)))
1330        (declare (simple-vector ,blocks))
1331        (dotimes (,i (length ,blocks) ,result)
1332          (let ((,block-var (svref ,blocks ,i)))
1333            ,@body)))))
1334
1335 (defmacro do-debug-function-variables ((var debug-function &optional result)
1336                                        &body body)
1337   #!+sb-doc
1338   "Executes body in a context with var bound to each debug-var in
1339    debug-function. This returns the value of executing result (defaults to
1340    nil). This may iterate over only some of debug-function's variables or none
1341    depending on debug policy; for example, possibly the compilation only
1342    preserved argument information."
1343   (let ((vars (gensym))
1344         (i (gensym)))
1345     `(let ((,vars (debug-function-debug-vars ,debug-function)))
1346        (declare (type (or null simple-vector) ,vars))
1347        (if ,vars
1348            (dotimes (,i (length ,vars) ,result)
1349              (let ((,var (svref ,vars ,i)))
1350                ,@body))
1351            ,result))))
1352
1353 (defun debug-function-function (debug-function)
1354   #!+sb-doc
1355   "Returns the Common Lisp function associated with the debug-function. This
1356    returns nil if the function is unavailable or is non-existent as a user
1357    callable function object."
1358   (let ((cached-value (debug-function-%function debug-function)))
1359     (if (eq cached-value :unparsed)
1360         (setf (debug-function-%function debug-function)
1361               (etypecase debug-function
1362                 (compiled-debug-function
1363                  (let ((component
1364                         (compiled-debug-function-component debug-function))
1365                        (start-pc
1366                         (sb!c::compiled-debug-function-start-pc
1367                          (compiled-debug-function-compiler-debug-fun
1368                           debug-function))))
1369                    (do ((entry (%code-entry-points component)
1370                                (%function-next entry)))
1371                        ((null entry) nil)
1372                      (when (= start-pc
1373                               (sb!c::compiled-debug-function-start-pc
1374                                (compiled-debug-function-compiler-debug-fun
1375                                 (function-debug-function entry))))
1376                        (return entry)))))
1377                 (interpreted-debug-function
1378                  (sb!c::lambda-eval-info-function
1379                   (sb!c::leaf-info
1380                    (interpreted-debug-function-ir1-lambda debug-function))))
1381                 (bogus-debug-function nil)))
1382         cached-value)))
1383
1384 (defun debug-function-name (debug-function)
1385   #!+sb-doc
1386   "Returns the name of the function represented by debug-function. This may
1387    be a string or a cons; do not assume it is a symbol."
1388   (etypecase debug-function
1389     (compiled-debug-function
1390      (sb!c::compiled-debug-function-name
1391       (compiled-debug-function-compiler-debug-fun debug-function)))
1392     (interpreted-debug-function
1393      (sb!c::lambda-name (interpreted-debug-function-ir1-lambda
1394                          debug-function)))
1395     (bogus-debug-function
1396      (bogus-debug-function-%name debug-function))))
1397
1398 (defun function-debug-function (fun)
1399   #!+sb-doc
1400   "Returns a debug-function that represents debug information for function."
1401   (case (get-type fun)
1402     (#.sb!vm:closure-header-type
1403      (function-debug-function (%closure-function fun)))
1404     (#.sb!vm:funcallable-instance-header-type
1405      (cond ((sb!eval:interpreted-function-p fun)
1406             (make-interpreted-debug-function
1407              (or (sb!eval::interpreted-function-definition fun)
1408                  (sb!eval::convert-interpreted-fun fun))))
1409            (t
1410             (function-debug-function (funcallable-instance-function fun)))))
1411     ((#.sb!vm:function-header-type #.sb!vm:closure-function-header-type)
1412       (let* ((name (%function-name fun))
1413              (component (function-code-header fun))
1414              (res (find-if
1415                    #'(lambda (x)
1416                        (and (sb!c::compiled-debug-function-p x)
1417                             (eq (sb!c::compiled-debug-function-name x) name)
1418                             (eq (sb!c::compiled-debug-function-kind x) nil)))
1419                    (get-debug-info-function-map
1420                     (%code-debug-info component)))))
1421         (if res
1422             (make-compiled-debug-function res component)
1423             ;; KLUDGE: comment from CMU CL:
1424             ;;   This used to be the non-interpreted branch, but
1425             ;;   William wrote it to return the debug-fun of fun's XEP
1426             ;;   instead of fun's debug-fun. The above code does this
1427             ;;   more correctly, but it doesn't get or eliminate all
1428             ;;   appropriate cases. It mostly works, and probably
1429             ;;   works for all named functions anyway.
1430             ;; -- WHN 20000120
1431             (debug-function-from-pc component
1432                                     (* (- (function-word-offset fun)
1433                                           (get-header-data component))
1434                                        sb!vm:word-bytes)))))))
1435
1436 (defun debug-function-kind (debug-function)
1437   #!+sb-doc
1438   "Returns the kind of the function which is one of :OPTIONAL, :EXTERNAL,
1439    :TOP-level, :CLEANUP, or NIL."
1440   ;; FIXME: This "is one of" information should become part of the function
1441   ;; declamation, not just a doc string
1442   (etypecase debug-function
1443     (compiled-debug-function
1444      (sb!c::compiled-debug-function-kind
1445       (compiled-debug-function-compiler-debug-fun debug-function)))
1446     (interpreted-debug-function
1447      (sb!c::lambda-kind (interpreted-debug-function-ir1-lambda
1448                          debug-function)))
1449     (bogus-debug-function
1450      nil)))
1451
1452 (defun debug-var-info-available (debug-function)
1453   #!+sb-doc
1454   "Is there any variable information for DEBUG-FUNCTION?"
1455   (not (not (debug-function-debug-vars debug-function))))
1456
1457 (defun debug-function-symbol-variables (debug-function symbol)
1458   #!+sb-doc
1459   "Returns a list of debug-vars in debug-function having the same name
1460    and package as symbol. If symbol is uninterned, then this returns a list of
1461    debug-vars without package names and with the same name as symbol. The
1462    result of this function is limited to the availability of variable
1463    information in debug-function; for example, possibly debug-function only
1464    knows about its arguments."
1465   (let ((vars (ambiguous-debug-vars debug-function (symbol-name symbol)))
1466         (package (and (symbol-package symbol)
1467                       (package-name (symbol-package symbol)))))
1468     (delete-if (if (stringp package)
1469                    (lambda (var)
1470                      (let ((p (debug-var-package-name var)))
1471                        (or (not (stringp p))
1472                            (string/= p package))))
1473                    (lambda (var)
1474                      (stringp (debug-var-package-name var))))
1475                vars)))
1476
1477 (defun ambiguous-debug-vars (debug-function name-prefix-string)
1478    "Returns a list of debug-vars in debug-function whose names contain
1479     name-prefix-string as an intial substring. The result of this function is
1480     limited to the availability of variable information in debug-function; for
1481     example, possibly debug-function only knows about its arguments."
1482   (declare (simple-string name-prefix-string))
1483   (let ((variables (debug-function-debug-vars debug-function)))
1484     (declare (type (or null simple-vector) variables))
1485     (if variables
1486         (let* ((len (length variables))
1487                (prefix-len (length name-prefix-string))
1488                (pos (find-variable name-prefix-string variables len))
1489                (res nil))
1490           (when pos
1491             ;; Find names from pos to variable's len that contain prefix.
1492             (do ((i pos (1+ i)))
1493                 ((= i len))
1494               (let* ((var (svref variables i))
1495                      (name (debug-var-symbol-name var))
1496                      (name-len (length name)))
1497                 (declare (simple-string name))
1498                 (when (/= (or (string/= name-prefix-string name
1499                                         :end1 prefix-len :end2 name-len)
1500                               prefix-len)
1501                           prefix-len)
1502                   (return))
1503                 (push var res)))
1504             (setq res (nreverse res)))
1505           res))))
1506
1507 ;;; This returns a position in variables for one containing name as an
1508 ;;; initial substring. End is the length of variables if supplied.
1509 (defun find-variable (name variables &optional end)
1510   (declare (simple-vector variables)
1511            (simple-string name))
1512   (let ((name-len (length name)))
1513     (position name variables
1514               :test #'(lambda (x y)
1515                         (let* ((y (debug-var-symbol-name y))
1516                                (y-len (length y)))
1517                           (declare (simple-string y))
1518                           (and (>= y-len name-len)
1519                                (string= x y :end1 name-len :end2 name-len))))
1520               :end (or end (length variables)))))
1521
1522 (defun debug-function-lambda-list (debug-function)
1523   #!+sb-doc
1524   "Returns a list representing the lambda-list for debug-function. The list
1525    has the following structure:
1526       (required-var1 required-var2
1527        ...
1528        (:optional var3 suppliedp-var4)
1529        (:optional var5)
1530        ...
1531        (:rest var6) (:rest var7)
1532        ...
1533        (:keyword keyword-symbol var8 suppliedp-var9)
1534        (:keyword keyword-symbol var10)
1535        ...
1536       )
1537    Each VARi is a DEBUG-VAR; however it may be the symbol :deleted it
1538    is unreferenced in debug-function. This signals a lambda-list-unavailable
1539    condition when there is no argument list information."
1540   (etypecase debug-function
1541     (compiled-debug-function
1542      (compiled-debug-function-lambda-list debug-function))
1543     (interpreted-debug-function
1544      (interpreted-debug-function-lambda-list debug-function))
1545     (bogus-debug-function
1546      nil)))
1547
1548 ;;; The hard part is when the lambda-list is unparsed. If it is
1549 ;;; unparsed, and all the arguments are required, this is still pretty
1550 ;;; easy; just whip the appropriate DEBUG-VARs into a list. Otherwise,
1551 ;;; we have to pick out the funny arguments including any suppliedp
1552 ;;; variables. In this situation, the ir1-lambda is an external entry
1553 ;;; point that takes arguments users really pass in. It looks at those
1554 ;;; and computes defaults and suppliedp variables, ultimately passing
1555 ;;; everything defined as a a parameter to the real function as final
1556 ;;; arguments. If this has to compute the lambda list, it caches it in
1557 ;;; debug-function.
1558 (defun interpreted-debug-function-lambda-list (debug-function)
1559   (let ((lambda-list (debug-function-%lambda-list debug-function))
1560         (debug-vars (debug-function-debug-vars debug-function))
1561         (ir1-lambda (interpreted-debug-function-ir1-lambda debug-function))
1562         (res nil))
1563     (if (eq lambda-list :unparsed)
1564         (flet ((frob (v debug-vars)
1565                  (if (sb!c::lambda-var-refs v)
1566                      (find v debug-vars
1567                            :key #'interpreted-debug-var-ir1-var)
1568                      :deleted)))
1569           (let ((xep-args (sb!c::lambda-optional-dispatch ir1-lambda)))
1570             (if (and xep-args
1571                      (eq (sb!c::optional-dispatch-main-entry xep-args)
1572                          ir1-lambda))
1573                 ;; There are rest, optional, keyword, and suppliedp vars.
1574                 (let ((final-args (sb!c::lambda-vars ir1-lambda)))
1575                   (dolist (xep-arg (sb!c::optional-dispatch-arglist xep-args))
1576                     (let ((info (sb!c::lambda-var-arg-info xep-arg))
1577                           (final-arg (pop final-args)))
1578                       (cond (info
1579                              (case (sb!c::arg-info-kind info)
1580                                (:required
1581                                 (push (frob final-arg debug-vars) res))
1582                                (:keyword
1583                                 (push (list :keyword
1584                                             (sb!c::arg-info-keyword info)
1585                                             (frob final-arg debug-vars))
1586                                       res))
1587                                (:rest
1588                                 (push (list :rest (frob final-arg debug-vars))
1589                                       res))
1590                                (:optional
1591                                 (push (list :optional
1592                                             (frob final-arg debug-vars))
1593                                       res)))
1594                              (when (sb!c::arg-info-supplied-p info)
1595                                (nconc
1596                                 (car res)
1597                                 (list (frob (pop final-args) debug-vars)))))
1598                             (t
1599                              (push (frob final-arg debug-vars) res)))))
1600                   (setf (debug-function-%lambda-list debug-function)
1601                         (nreverse res)))
1602                 ;; All required args, so return them in a list.
1603                 (dolist (v (sb!c::lambda-vars ir1-lambda)
1604                            (setf (debug-function-%lambda-list debug-function)
1605                                  (nreverse res)))
1606                   (push (frob v debug-vars) res)))))
1607         ;; Everything's unparsed and cached, so return it.
1608         lambda-list)))
1609
1610 ;;; If this has to compute the lambda list, it caches it in debug-function.
1611 (defun compiled-debug-function-lambda-list (debug-function)
1612   (let ((lambda-list (debug-function-%lambda-list debug-function)))
1613     (cond ((eq lambda-list :unparsed)
1614            (multiple-value-bind (args argsp)
1615                (parse-compiled-debug-function-lambda-list debug-function)
1616              (setf (debug-function-%lambda-list debug-function) args)
1617              (if argsp
1618                  args
1619                  (debug-signal 'lambda-list-unavailable
1620                                :debug-function debug-function))))
1621           (lambda-list)
1622           ((bogus-debug-function-p debug-function)
1623            nil)
1624           ((sb!c::compiled-debug-function-arguments
1625             (compiled-debug-function-compiler-debug-fun
1626              debug-function))
1627            ;; If the packed information is there (whether empty or not) as
1628            ;; opposed to being nil, then returned our cached value (nil).
1629            nil)
1630           (t
1631            ;; Our cached value is nil, and the packed lambda-list information
1632            ;; is nil, so we don't have anything available.
1633            (debug-signal 'lambda-list-unavailable
1634                          :debug-function debug-function)))))
1635
1636 ;;; COMPILED-DEBUG-FUNCTION-LAMBDA-LIST calls this when a
1637 ;;; compiled-debug-function has no lambda-list information cached. It
1638 ;;; returns the lambda-list as the first value and whether there was
1639 ;;; any argument information as the second value. Therefore, nil and t
1640 ;;; means there were no arguments, but nil and nil means there was no
1641 ;;; argument information.
1642 (defun parse-compiled-debug-function-lambda-list (debug-function)
1643   (let ((args (sb!c::compiled-debug-function-arguments
1644                (compiled-debug-function-compiler-debug-fun
1645                 debug-function))))
1646     (cond
1647      ((not args)
1648       (values nil nil))
1649      ((eq args :minimal)
1650       (values (coerce (debug-function-debug-vars debug-function) 'list)
1651               t))
1652      (t
1653       (let ((vars (debug-function-debug-vars debug-function))
1654             (i 0)
1655             (len (length args))
1656             (res nil)
1657             (optionalp nil))
1658         (declare (type (or null simple-vector) vars))
1659         (loop
1660           (when (>= i len) (return))
1661           (let ((ele (aref args i)))
1662             (cond
1663              ((symbolp ele)
1664               (case ele
1665                 (sb!c::deleted
1666                  ;; Deleted required arg at beginning of args array.
1667                  (push :deleted res))
1668                 (sb!c::optional-args
1669                  (setf optionalp t))
1670                 (sb!c::supplied-p
1671                  ;; SUPPLIED-P var immediately following keyword or
1672                  ;; optional. Stick the extra var in the result
1673                  ;; element representing the keyword or optional,
1674                  ;; which is the previous one.
1675                  (nconc (car res)
1676                         (list (compiled-debug-function-lambda-list-var
1677                                args (incf i) vars))))
1678                 (sb!c::rest-arg
1679                  (push (list :rest
1680                              (compiled-debug-function-lambda-list-var
1681                               args (incf i) vars))
1682                        res))
1683                 (sb!c::more-arg
1684                  ;; Just ignore the fact that the next two args are
1685                  ;; the more arg context and count, and act like they
1686                  ;; are regular arguments.
1687                  nil)
1688                 (t
1689                  ;; keyword arg
1690                  (push (list :keyword
1691                              ele
1692                              (compiled-debug-function-lambda-list-var
1693                               args (incf i) vars))
1694                        res))))
1695              (optionalp
1696               ;; We saw an optional marker, so the following
1697               ;; non-symbols are indexes indicating optional
1698               ;; variables.
1699               (push (list :optional (svref vars ele)) res))
1700              (t
1701               ;; Required arg at beginning of args array.
1702               (push (svref vars ele) res))))
1703           (incf i))
1704         (values (nreverse res) t))))))
1705
1706 ;;; This is used in COMPILED-DEBUG-FUNCTION-LAMBDA-LIST.
1707 (defun compiled-debug-function-lambda-list-var (args i vars)
1708   (declare (type (simple-array * (*)) args)
1709            (simple-vector vars))
1710   (let ((ele (aref args i)))
1711     (cond ((not (symbolp ele)) (svref vars ele))
1712           ((eq ele 'sb!c::deleted) :deleted)
1713           (t (error "malformed arguments description")))))
1714
1715 (defun compiled-debug-function-debug-info (debug-fun)
1716   (%code-debug-info (compiled-debug-function-component debug-fun)))
1717 \f
1718 ;;;; unpacking variable and basic block data
1719
1720 (defvar *parsing-buffer*
1721   (make-array 20 :adjustable t :fill-pointer t))
1722 (defvar *other-parsing-buffer*
1723   (make-array 20 :adjustable t :fill-pointer t))
1724 ;;; PARSE-DEBUG-BLOCKS, PARSE-DEBUG-VARS and UNCOMPACT-FUNCTION-MAP
1725 ;;; use this to unpack binary encoded information. It returns the
1726 ;;; values returned by the last form in body.
1727 ;;;
1728 ;;; This binds buffer-var to *parsing-buffer*, makes sure it starts at
1729 ;;; element zero, and makes sure if we unwind, we nil out any set
1730 ;;; elements for GC purposes.
1731 ;;;
1732 ;;; This also binds other-var to *other-parsing-buffer* when it is
1733 ;;; supplied, making sure it starts at element zero and that we nil
1734 ;;; out any elements if we unwind.
1735 ;;;
1736 ;;; This defines the local macro RESULT that takes a buffer, copies
1737 ;;; its elements to a resulting simple-vector, nil's out elements, and
1738 ;;; restarts the buffer at element zero. RESULT returns the
1739 ;;; simple-vector.
1740 (eval-when (:compile-toplevel :execute)
1741 (sb!xc:defmacro with-parsing-buffer ((buffer-var &optional other-var)
1742                                      &body body)
1743   (let ((len (gensym))
1744         (res (gensym)))
1745     `(unwind-protect
1746          (let ((,buffer-var *parsing-buffer*)
1747                ,@(if other-var `((,other-var *other-parsing-buffer*))))
1748            (setf (fill-pointer ,buffer-var) 0)
1749            ,@(if other-var `((setf (fill-pointer ,other-var) 0)))
1750            (macrolet ((result (buf)
1751                         `(let* ((,',len (length ,buf))
1752                                 (,',res (make-array ,',len)))
1753                            (replace ,',res ,buf :end1 ,',len :end2 ,',len)
1754                            (fill ,buf nil :end ,',len)
1755                            (setf (fill-pointer ,buf) 0)
1756                            ,',res)))
1757              ,@body))
1758      (fill *parsing-buffer* nil)
1759      ,@(if other-var `((fill *other-parsing-buffer* nil))))))
1760 ) ; EVAL-WHEN
1761
1762 ;;; The argument is a debug internals structure. This returns the
1763 ;;; debug-blocks for debug-function, regardless of whether we have
1764 ;;; unpacked them yet. It signals a no-debug-blocks condition if it
1765 ;;; can't return the blocks.
1766 (defun debug-function-debug-blocks (debug-function)
1767   (let ((blocks (debug-function-blocks debug-function)))
1768     (cond ((eq blocks :unparsed)
1769            (setf (debug-function-blocks debug-function)
1770                  (parse-debug-blocks debug-function))
1771            (unless (debug-function-blocks debug-function)
1772              (debug-signal 'no-debug-blocks
1773                            :debug-function debug-function))
1774            (debug-function-blocks debug-function))
1775           (blocks)
1776           (t
1777            (debug-signal 'no-debug-blocks
1778                          :debug-function debug-function)))))
1779
1780 ;;; This returns a simple-vector of debug-blocks or nil. NIL indicates
1781 ;;; there was no basic block information.
1782 (defun parse-debug-blocks (debug-function)
1783   (etypecase debug-function
1784     (compiled-debug-function
1785      (parse-compiled-debug-blocks debug-function))
1786     (bogus-debug-function
1787      (debug-signal 'no-debug-blocks :debug-function debug-function))
1788     (interpreted-debug-function
1789      (parse-interpreted-debug-blocks debug-function))))
1790
1791 ;;; This does some of the work of PARSE-DEBUG-BLOCKS.
1792 (defun parse-compiled-debug-blocks (debug-function)
1793   (let* ((debug-fun (compiled-debug-function-compiler-debug-fun
1794                      debug-function))
1795          (var-count (length (debug-function-debug-vars debug-function)))
1796          (blocks (sb!c::compiled-debug-function-blocks debug-fun))
1797          ;; KLUDGE: 8 is a hard-wired constant in the compiler for the
1798          ;; element size of the packed binary representation of the
1799          ;; blocks data.
1800          (live-set-len (ceiling var-count 8))
1801          (tlf-number (sb!c::compiled-debug-function-tlf-number debug-fun)))
1802     (unless blocks (return-from parse-compiled-debug-blocks nil))
1803     (macrolet ((aref+ (a i) `(prog1 (aref ,a ,i) (incf ,i))))
1804       (with-parsing-buffer (blocks-buffer locations-buffer)
1805         (let ((i 0)
1806               (len (length blocks))
1807               (last-pc 0))
1808           (loop
1809             (when (>= i len) (return))
1810             (let ((succ-and-flags (aref+ blocks i))
1811                   (successors nil))
1812               (declare (type (unsigned-byte 8) succ-and-flags)
1813                        (list successors))
1814               (dotimes (k (ldb sb!c::compiled-debug-block-nsucc-byte
1815                                succ-and-flags))
1816                 (push (sb!c::read-var-integer blocks i) successors))
1817               (let* ((locations
1818                       (dotimes (k (sb!c::read-var-integer blocks i)
1819                                   (result locations-buffer))
1820                         (let ((kind (svref sb!c::*compiled-code-location-kinds*
1821                                            (aref+ blocks i)))
1822                               (pc (+ last-pc
1823                                      (sb!c::read-var-integer blocks i)))
1824                               (tlf-offset (or tlf-number
1825                                               (sb!c::read-var-integer blocks
1826                                                                       i)))
1827                               (form-number (sb!c::read-var-integer blocks i))
1828                               (live-set (sb!c::read-packed-bit-vector
1829                                          live-set-len blocks i)))
1830                           (vector-push-extend (make-known-code-location
1831                                                pc debug-function tlf-offset
1832                                                form-number live-set kind)
1833                                               locations-buffer)
1834                           (setf last-pc pc))))
1835                      (block (make-compiled-debug-block
1836                              locations successors
1837                              (not (zerop (logand
1838                                           sb!c::compiled-debug-block-elsewhere-p
1839                                           succ-and-flags))))))
1840                 (vector-push-extend block blocks-buffer)
1841                 (dotimes (k (length locations))
1842                   (setf (code-location-%debug-block (svref locations k))
1843                         block))))))
1844         (let ((res (result blocks-buffer)))
1845           (declare (simple-vector res))
1846           (dotimes (i (length res))
1847             (let* ((block (svref res i))
1848                    (succs nil))
1849               (dolist (ele (debug-block-successors block))
1850                 (push (svref res ele) succs))
1851               (setf (debug-block-successors block) succs)))
1852           res)))))
1853
1854 ;;; This does some of the work of PARSE-DEBUG-BLOCKS.
1855 (defun parse-interpreted-debug-blocks (debug-function)
1856   (let ((ir1-lambda (interpreted-debug-function-ir1-lambda debug-function)))
1857     (with-parsing-buffer (buffer)
1858       (sb!c::do-blocks (block (sb!c::block-component
1859                                (sb!c::node-block (sb!c::lambda-bind
1860                                                   ir1-lambda))))
1861         (when (eq ir1-lambda (sb!c::block-home-lambda block))
1862           (vector-push-extend (make-interpreted-debug-block block) buffer)))
1863       (result buffer))))
1864
1865 ;;; The argument is a debug internals structure. This returns nil if
1866 ;;; there is no variable information. It returns an empty
1867 ;;; simple-vector if there were no locals in the function. Otherwise
1868 ;;; it returns a simple-vector of DEBUG-VARs.
1869 (defun debug-function-debug-vars (debug-function)
1870   (let ((vars (debug-function-%debug-vars debug-function)))
1871     (if (eq vars :unparsed)
1872         (setf (debug-function-%debug-vars debug-function)
1873               (etypecase debug-function
1874                 (compiled-debug-function
1875                  (parse-compiled-debug-vars debug-function))
1876                 (bogus-debug-function nil)
1877                 (interpreted-debug-function
1878                  (parse-interpreted-debug-vars debug-function))))
1879         vars)))
1880
1881 ;;; This grabs all the variables from DEBUG-FUN's ir1-lambda, from the
1882 ;;; IR1 lambda vars, and all of its LET's. Each LET is an IR1 lambda.
1883 ;;; For each variable, we make an INTERPRETED-DEBUG-VAR. We then SORT
1884 ;;; all the variables by name. Then we go through, and for any
1885 ;;; duplicated names we distinguish the INTERPRETED-DEBUG-VARs by
1886 ;;; setting their id slots to a distinct number.
1887 (defun parse-interpreted-debug-vars (debug-fun)
1888   (let* ((ir1-lambda (interpreted-debug-function-ir1-lambda debug-fun))
1889          (vars (flet ((frob (ir1-lambda buf)
1890                         (dolist (v (sb!c::lambda-vars ir1-lambda))
1891                           (vector-push-extend
1892                            (let* ((id (sb!c::leaf-name v)))
1893                              (make-interpreted-debug-var id v))
1894                            buf))))
1895                  (with-parsing-buffer (buf)
1896                    (frob ir1-lambda buf)
1897                    (dolist (let-lambda (sb!c::lambda-lets ir1-lambda))
1898                      (frob let-lambda buf))
1899                    (result buf)))))
1900     (declare (simple-vector vars))
1901     (sort vars #'string< :key #'debug-var-symbol-name)
1902     (let ((len (length vars)))
1903       (when (> len 1)
1904         (let ((i 0)
1905               (j 1))
1906           (block PUNT
1907             (loop
1908               (let* ((var-i (svref vars i))
1909                      (var-j (svref vars j))
1910                      (name (debug-var-symbol-name var-i)))
1911                 (when (string= name (debug-var-symbol-name var-j))
1912                   (let ((count 1))
1913                     (loop
1914                       (setf (debug-var-id var-j) count)
1915                       (when (= (incf j) len) (return-from PUNT))
1916                       (setf var-j (svref vars j))
1917                       (when (string/= name (debug-var-symbol-name var-j))
1918                         (return))
1919                       (incf count))))
1920                 (setf i j)
1921                 (incf j)
1922                 (when (= j len) (return))))))))
1923     vars))
1924
1925 ;;; Vars is the parsed variables for a minimal debug function. We need to
1926 ;;; assign names of the form ARG-NNN. We must pad with leading zeros, since
1927 ;;; the arguments must be in alphabetical order.
1928 (defun assign-minimal-var-names (vars)
1929   (declare (simple-vector vars))
1930   (let* ((len (length vars))
1931          (width (length (format nil "~D" (1- len)))))
1932     (dotimes (i len)
1933       (setf (compiled-debug-var-symbol (svref vars i))
1934             (intern (format nil "ARG-~V,'0D" width i)
1935                     ;; KLUDGE: It's somewhat nasty to have a bare
1936                     ;; package name string here. It would probably be
1937                     ;; better to have #.(FIND-PACKAGE "SB!DEBUG")
1938                     ;; instead, since then at least it would transform
1939                     ;; correctly under package renaming and stuff.
1940                     ;; However, genesis can't handle dumped packages..
1941                     ;; -- WHN 20000129
1942                     ;;
1943                     ;; FIXME: Maybe this could be fixed by moving the
1944                     ;; whole debug-int.lisp file to warm init? (after
1945                     ;; which dumping a #.(FIND-PACKAGE ..) expression
1946                     ;; would work fine) If this is possible, it would
1947                     ;; probably be a good thing, since minimizing the
1948                     ;; amount of stuff in cold init is basically good.
1949                     "SB-DEBUG")))))
1950
1951 ;;; Parse the packed representation of DEBUG-VARs from
1952 ;;; DEBUG-FUNCTION's SB!C::COMPILED-DEBUG-FUNCTION, returning a vector
1953 ;;; of DEBUG-VARs, or NIL if there was no information to parse.
1954 (defun parse-compiled-debug-vars (debug-function)
1955   (let* ((cdebug-fun (compiled-debug-function-compiler-debug-fun debug-function))
1956          (packed-vars (sb!c::compiled-debug-function-variables cdebug-fun))
1957          (args-minimal (eq (sb!c::compiled-debug-function-arguments cdebug-fun)
1958                            :minimal)))
1959     (when packed-vars
1960       (do ((i 0)
1961            (buffer (make-array 0 :fill-pointer 0 :adjustable t)))
1962           ((>= i (length packed-vars))
1963            (let ((result (coerce buffer 'simple-vector)))
1964              (when args-minimal
1965                (assign-minimal-var-names result))
1966              result))
1967         (flet ((geti () (prog1 (aref packed-vars i) (incf i))))
1968           (let* ((flags (geti))
1969                  (minimal (logtest sb!c::compiled-debug-var-minimal-p flags))
1970                  (deleted (logtest sb!c::compiled-debug-var-deleted-p flags))
1971                  (live (logtest sb!c::compiled-debug-var-environment-live flags))
1972                  (save (logtest sb!c::compiled-debug-var-save-loc-p flags))
1973                  (symbol (if minimal nil (geti)))
1974                  (id (if (logtest sb!c::compiled-debug-var-id-p flags)
1975                          (geti)
1976                          0))
1977                  (sc-offset (if deleted 0 (geti)))
1978                  (save-sc-offset (if save (geti) nil)))
1979             (assert (not (and args-minimal (not minimal))))
1980             (vector-push-extend (make-compiled-debug-var symbol
1981                                                          id
1982                                                          live
1983                                                          sc-offset
1984                                                          save-sc-offset)
1985                                 buffer)))))))
1986 \f
1987 ;;;; unpacking minimal debug functions
1988
1989 (eval-when (:compile-toplevel :execute)
1990
1991 ;;; sleazoid "macro" to keep our indentation sane in UNCOMPACT-FUNCTION-MAP
1992 (sb!xc:defmacro make-uncompacted-debug-fun ()
1993   '(sb!c::make-compiled-debug-function
1994     :name
1995     (let ((base (ecase (ldb sb!c::minimal-debug-function-name-style-byte
1996                             options)
1997                   (#.sb!c::minimal-debug-function-name-symbol
1998                    (intern (sb!c::read-var-string map i)
1999                            (sb!c::compiled-debug-info-package info)))
2000                   (#.sb!c::minimal-debug-function-name-packaged
2001                    (let ((pkg (sb!c::read-var-string map i)))
2002                      (intern (sb!c::read-var-string map i) pkg)))
2003                   (#.sb!c::minimal-debug-function-name-uninterned
2004                    (make-symbol (sb!c::read-var-string map i)))
2005                   (#.sb!c::minimal-debug-function-name-component
2006                    (sb!c::compiled-debug-info-name info)))))
2007       (if (logtest flags sb!c::minimal-debug-function-setf-bit)
2008           `(setf ,base)
2009           base))
2010     :kind (svref sb!c::*minimal-debug-function-kinds*
2011                  (ldb sb!c::minimal-debug-function-kind-byte options))
2012     :variables
2013     (when vars-p
2014       (let ((len (sb!c::read-var-integer map i)))
2015         (prog1 (subseq map i (+ i len))
2016           (incf i len))))
2017     :arguments (when vars-p :minimal)
2018     :returns
2019     (ecase (ldb sb!c::minimal-debug-function-returns-byte options)
2020       (#.sb!c::minimal-debug-function-returns-standard
2021        :standard)
2022       (#.sb!c::minimal-debug-function-returns-fixed
2023        :fixed)
2024       (#.sb!c::minimal-debug-function-returns-specified
2025        (with-parsing-buffer (buf)
2026          (dotimes (idx (sb!c::read-var-integer map i))
2027            (vector-push-extend (sb!c::read-var-integer map i) buf))
2028          (result buf))))
2029     :return-pc (sb!c::read-var-integer map i)
2030     :old-fp (sb!c::read-var-integer map i)
2031     :nfp (when (logtest flags sb!c::minimal-debug-function-nfp-bit)
2032            (sb!c::read-var-integer map i))
2033     :start-pc
2034     (progn
2035       (setq code-start-pc (+ code-start-pc (sb!c::read-var-integer map i)))
2036       (+ code-start-pc (sb!c::read-var-integer map i)))
2037     :elsewhere-pc
2038     (setq elsewhere-pc (+ elsewhere-pc (sb!c::read-var-integer map i)))))
2039
2040 ) ; EVAL-WHEN
2041
2042 ;;; Return a normal function map derived from a minimal debug info
2043 ;;; function map. This involves looping parsing
2044 ;;; minimal-debug-functions and then building a vector out of them.
2045 ;;;
2046 ;;; FIXME: This and its helper macro just above become dead code now
2047 ;;; that we no longer use compacted function maps.
2048 (defun uncompact-function-map (info)
2049   (declare (type sb!c::compiled-debug-info info))
2050
2051   ;; (This is stubified until we solve the problem of representing
2052   ;; debug information in a way which plays nicely with package renaming.)
2053   (error "FIXME: dead code UNCOMPACT-FUNCTION-MAP (was stub)")
2054
2055   (let* ((map (sb!c::compiled-debug-info-function-map info))
2056          (i 0)
2057          (len (length map))
2058          (code-start-pc 0)
2059          (elsewhere-pc 0))
2060     (declare (type (simple-array (unsigned-byte 8) (*)) map))
2061     (sb!int:collect ((res))
2062       (loop
2063         (when (= i len) (return))
2064         (let* ((options (prog1 (aref map i) (incf i)))
2065                (flags (prog1 (aref map i) (incf i)))
2066                (vars-p (logtest flags
2067                                 sb!c::minimal-debug-function-variables-bit))
2068                (dfun (make-uncompacted-debug-fun)))
2069           (res code-start-pc)
2070           (res dfun)))
2071
2072       (coerce (cdr (res)) 'simple-vector))))
2073
2074 ;;; a map from minimal DEBUG-INFO function maps to unpacked
2075 ;;; versions thereof
2076 (defvar *uncompacted-function-maps* (make-hash-table :test 'eq))
2077
2078 ;;; Return a FUNCTION-MAP for a given COMPILED-DEBUG-info object. If
2079 ;;; the info is minimal, and has not been parsed, then parse it.
2080 ;;;
2081 ;;; FIXME: Now that we no longer use the MINIMAL-DEBUG-FUNCTION
2082 ;;; representation, calls to this function can be replaced by calls to
2083 ;;; the bare COMPILED-DEBUG-INFO-FUNCTION-MAP slot accessor function,
2084 ;;; and this function and everything it calls become dead code which
2085 ;;; can be deleted.
2086 (defun get-debug-info-function-map (info)
2087   (declare (type sb!c::compiled-debug-info info))
2088   (let ((map (sb!c::compiled-debug-info-function-map info)))
2089     (if (simple-vector-p map)
2090         map
2091         (or (gethash map *uncompacted-function-maps*)
2092             (setf (gethash map *uncompacted-function-maps*)
2093                   (uncompact-function-map info))))))
2094 \f
2095 ;;;; CODE-LOCATIONs
2096
2097 ;;; If we're sure of whether code-location is known, return T or NIL.
2098 ;;; If we're :UNSURE, then try to fill in the code-location's slots.
2099 ;;; This determines whether there is any debug-block information, and
2100 ;;; if code-location is known.
2101 ;;;
2102 ;;; ??? IF this conses closures every time it's called, then break off the
2103 ;;; :UNSURE part to get the HANDLER-CASE into another function.
2104 (defun code-location-unknown-p (basic-code-location)
2105   (ecase (code-location-%unknown-p basic-code-location)
2106     ((t) t)
2107     ((nil) nil)
2108     (:unsure
2109      (setf (code-location-%unknown-p basic-code-location)
2110            (handler-case (not (fill-in-code-location basic-code-location))
2111              (no-debug-blocks () t))))))
2112
2113 ;;; Return the DEBUG-BLOCK containing code-location if it is available.
2114 ;;; Some debug policies inhibit debug-block information, and if none
2115 ;;; is available, then this signals a NO-DEBUG-BLOCKS condition.
2116 (defun code-location-debug-block (basic-code-location)
2117   (let ((block (code-location-%debug-block basic-code-location)))
2118     (if (eq block :unparsed)
2119         (etypecase basic-code-location
2120           (compiled-code-location
2121            (compute-compiled-code-location-debug-block basic-code-location))
2122           (interpreted-code-location
2123            (setf (code-location-%debug-block basic-code-location)
2124                  (make-interpreted-debug-block
2125                   (sb!c::node-block
2126                    (interpreted-code-location-ir1-node basic-code-location))))))
2127         block)))
2128
2129 ;;; Store and return BASIC-CODE-LOCATION's debug-block. We determines
2130 ;;; the correct one using the code-location's pc. We use
2131 ;;; DEBUG-FUNCTION-DEBUG-BLOCKS to return the cached block information
2132 ;;; or signal a NO-DEBUG-BLOCKS condition. The blocks are sorted by
2133 ;;; their first code-location's pc, in ascending order. Therefore, as
2134 ;;; soon as we find a block that starts with a pc greater than
2135 ;;; basic-code-location's pc, we know the previous block contains the
2136 ;;; pc. If we get to the last block, then the code-location is either
2137 ;;; in the second to last block or the last block, and we have to be
2138 ;;; careful in determining this since the last block could be code at
2139 ;;; the end of the function. We have to check for the last block being
2140 ;;; code first in order to see how to compare the code-location's pc.
2141 (defun compute-compiled-code-location-debug-block (basic-code-location)
2142   (let* ((pc (compiled-code-location-pc basic-code-location))
2143          (debug-function (code-location-debug-function
2144                           basic-code-location))
2145          (blocks (debug-function-debug-blocks debug-function))
2146          (len (length blocks)))
2147     (declare (simple-vector blocks))
2148     (setf (code-location-%debug-block basic-code-location)
2149           (if (= len 1)
2150               (svref blocks 0)
2151               (do ((i 1 (1+ i))
2152                    (end (1- len)))
2153                   ((= i end)
2154                    (let ((last (svref blocks end)))
2155                      (cond
2156                       ((debug-block-elsewhere-p last)
2157                        (if (< pc
2158                               (sb!c::compiled-debug-function-elsewhere-pc
2159                                (compiled-debug-function-compiler-debug-fun
2160                                 debug-function)))
2161                            (svref blocks (1- end))
2162                            last))
2163                       ((< pc
2164                           (compiled-code-location-pc
2165                            (svref (compiled-debug-block-code-locations last)
2166                                   0)))
2167                        (svref blocks (1- end)))
2168                       (t last))))
2169                 (declare (type sb!c::index i end))
2170                 (when (< pc
2171                          (compiled-code-location-pc
2172                           (svref (compiled-debug-block-code-locations
2173                                   (svref blocks i))
2174                                  0)))
2175                   (return (svref blocks (1- i)))))))))
2176
2177 (defun code-location-debug-source (code-location)
2178   #!+sb-doc
2179   "Returns the code-location's debug-source."
2180   (etypecase code-location
2181     (compiled-code-location
2182      (let* ((info (compiled-debug-function-debug-info
2183                    (code-location-debug-function code-location)))
2184             (sources (sb!c::compiled-debug-info-source info))
2185             (len (length sources)))
2186        (declare (list sources))
2187        (when (zerop len)
2188          (debug-signal 'no-debug-blocks :debug-function
2189                        (code-location-debug-function code-location)))
2190        (if (= len 1)
2191            (car sources)
2192            (do ((prev sources src)
2193                 (src (cdr sources) (cdr src))
2194                 (offset (code-location-top-level-form-offset code-location)))
2195                ((null src) (car prev))
2196              (when (< offset (sb!c::debug-source-source-root (car src)))
2197                (return (car prev)))))))
2198     (interpreted-code-location
2199      (first
2200       (let ((sb!c::*lexenv* (make-null-lexenv)))
2201         (sb!c::debug-source-for-info
2202          (sb!c::component-source-info
2203           (sb!c::block-component
2204            (sb!c::node-block
2205             (interpreted-code-location-ir1-node code-location))))))))))
2206
2207 (defun code-location-top-level-form-offset (code-location)
2208   #!+sb-doc
2209   "Returns the number of top-level forms before the one containing
2210    code-location as seen by the compiler in some compilation unit. A
2211    compilation unit is not necessarily a single file, see the section on
2212    debug-sources."
2213   (when (code-location-unknown-p code-location)
2214     (error 'unknown-code-location :code-location code-location))
2215   (let ((tlf-offset (code-location-%tlf-offset code-location)))
2216     (cond ((eq tlf-offset :unparsed)
2217            (etypecase code-location
2218              (compiled-code-location
2219               (unless (fill-in-code-location code-location)
2220                 ;; This check should be unnecessary. We're missing
2221                 ;; debug info the compiler should have dumped.
2222                 (error "internal error: unknown code location"))
2223               (code-location-%tlf-offset code-location))
2224              (interpreted-code-location
2225               (setf (code-location-%tlf-offset code-location)
2226                     (sb!c::source-path-tlf-number
2227                      (sb!c::node-source-path
2228                       (interpreted-code-location-ir1-node code-location)))))))
2229           (t tlf-offset))))
2230
2231 (defun code-location-form-number (code-location)
2232   #!+sb-doc
2233   "Returns the number of the form corresponding to code-location. The form
2234    number is derived by a walking the subforms of a top-level form in
2235    depth-first order."
2236   (when (code-location-unknown-p code-location)
2237     (error 'unknown-code-location :code-location code-location))
2238   (let ((form-num (code-location-%form-number code-location)))
2239     (cond ((eq form-num :unparsed)
2240            (etypecase code-location
2241              (compiled-code-location
2242               (unless (fill-in-code-location code-location)
2243                 ;; This check should be unnecessary. We're missing
2244                 ;; debug info the compiler should have dumped.
2245                 (error "internal error: unknown code location"))
2246               (code-location-%form-number code-location))
2247              (interpreted-code-location
2248               (setf (code-location-%form-number code-location)
2249                     (sb!c::source-path-form-number
2250                      (sb!c::node-source-path
2251                       (interpreted-code-location-ir1-node code-location)))))))
2252           (t form-num))))
2253
2254 (defun code-location-kind (code-location)
2255   #!+sb-doc
2256   "Return the kind of CODE-LOCATION, one of:
2257      :interpreted, :unknown-return, :known-return, :internal-error,
2258      :non-local-exit, :block-start, :call-site, :single-value-return,
2259      :non-local-entry"
2260   (when (code-location-unknown-p code-location)
2261     (error 'unknown-code-location :code-location code-location))
2262   (etypecase code-location
2263     (compiled-code-location
2264      (let ((kind (compiled-code-location-kind code-location)))
2265        (cond ((not (eq kind :unparsed)) kind)
2266              ((not (fill-in-code-location code-location))
2267               ;; This check should be unnecessary. We're missing
2268               ;; debug info the compiler should have dumped.
2269               (error "internal error: unknown code location"))
2270              (t
2271               (compiled-code-location-kind code-location)))))
2272     (interpreted-code-location
2273      :interpreted)))
2274
2275 ;;; This returns CODE-LOCATION's live-set if it is available. If
2276 ;;; there is no debug-block information, this returns NIL.
2277 (defun compiled-code-location-live-set (code-location)
2278   (if (code-location-unknown-p code-location)
2279       nil
2280       (let ((live-set (compiled-code-location-%live-set code-location)))
2281         (cond ((eq live-set :unparsed)
2282                (unless (fill-in-code-location code-location)
2283                  ;; This check should be unnecessary. We're missing
2284                  ;; debug info the compiler should have dumped.
2285                  ;;
2286                  ;; FIXME: This error and comment happen over and over again.
2287                  ;; Make them a shared function.
2288                  (error "internal error: unknown code location"))
2289                (compiled-code-location-%live-set code-location))
2290               (t live-set)))))
2291
2292 ;;; true if OBJ1 and OBJ2 are the same place in the code
2293 (defun code-location= (obj1 obj2)
2294   (etypecase obj1
2295     (compiled-code-location
2296      (etypecase obj2
2297        (compiled-code-location
2298         (and (eq (code-location-debug-function obj1)
2299                  (code-location-debug-function obj2))
2300              (sub-compiled-code-location= obj1 obj2)))
2301        (interpreted-code-location
2302         nil)))
2303     (interpreted-code-location
2304      (etypecase obj2
2305        (compiled-code-location
2306         nil)
2307        (interpreted-code-location
2308         (eq (interpreted-code-location-ir1-node obj1)
2309             (interpreted-code-location-ir1-node obj2)))))))
2310 (defun sub-compiled-code-location= (obj1 obj2)
2311   (= (compiled-code-location-pc obj1)
2312      (compiled-code-location-pc obj2)))
2313
2314 ;;; Fill in CODE-LOCATION's :UNPARSED slots, returning T or NIL
2315 ;;; depending on whether the code-location was known in its
2316 ;;; debug-function's debug-block information. This may signal a
2317 ;;; NO-DEBUG-BLOCKS condition due to DEBUG-FUNCTION-DEBUG-BLOCKS, and
2318 ;;; it assumes the %UNKNOWN-P slot is already set or going to be set.
2319 (defun fill-in-code-location (code-location)
2320   (declare (type compiled-code-location code-location))
2321   (let* ((debug-function (code-location-debug-function code-location))
2322          (blocks (debug-function-debug-blocks debug-function)))
2323     (declare (simple-vector blocks))
2324     (dotimes (i (length blocks) nil)
2325       (let* ((block (svref blocks i))
2326              (locations (compiled-debug-block-code-locations block)))
2327         (declare (simple-vector locations))
2328         (dotimes (j (length locations))
2329           (let ((loc (svref locations j)))
2330             (when (sub-compiled-code-location= code-location loc)
2331               (setf (code-location-%debug-block code-location) block)
2332               (setf (code-location-%tlf-offset code-location)
2333                     (code-location-%tlf-offset loc))
2334               (setf (code-location-%form-number code-location)
2335                     (code-location-%form-number loc))
2336               (setf (compiled-code-location-%live-set code-location)
2337                     (compiled-code-location-%live-set loc))
2338               (setf (compiled-code-location-kind code-location)
2339                     (compiled-code-location-kind loc))
2340               (return-from fill-in-code-location t))))))))
2341 \f
2342 ;;;; operations on DEBUG-BLOCKs
2343
2344 (defmacro do-debug-block-locations ((code-var debug-block &optional return)
2345                                     &body body)
2346   #!+sb-doc
2347   "Executes forms in a context with code-var bound to each code-location in
2348    debug-block. This returns the value of executing result (defaults to nil)."
2349   (let ((code-locations (gensym))
2350         (i (gensym)))
2351     `(let ((,code-locations (debug-block-code-locations ,debug-block)))
2352        (declare (simple-vector ,code-locations))
2353        (dotimes (,i (length ,code-locations) ,return)
2354          (let ((,code-var (svref ,code-locations ,i)))
2355            ,@body)))))
2356
2357 (defun debug-block-function-name (debug-block)
2358   #!+sb-doc
2359   "Returns the name of the function represented by debug-function. This may
2360    be a string or a cons; do not assume it is a symbol."
2361   (etypecase debug-block
2362     (compiled-debug-block
2363      (let ((code-locs (compiled-debug-block-code-locations debug-block)))
2364        (declare (simple-vector code-locs))
2365        (if (zerop (length code-locs))
2366            "??? Can't get name of debug-block's function."
2367            (debug-function-name
2368             (code-location-debug-function (svref code-locs 0))))))
2369     (interpreted-debug-block
2370      (sb!c::lambda-name (sb!c::block-home-lambda
2371                          (interpreted-debug-block-ir1-block debug-block))))))
2372
2373 (defun debug-block-code-locations (debug-block)
2374   (etypecase debug-block
2375     (compiled-debug-block
2376      (compiled-debug-block-code-locations debug-block))
2377     (interpreted-debug-block
2378      (interpreted-debug-block-code-locations debug-block))))
2379
2380 (defun interpreted-debug-block-code-locations (debug-block)
2381   (let ((code-locs (interpreted-debug-block-locations debug-block)))
2382     (if (eq code-locs :unparsed)
2383         (with-parsing-buffer (buf)
2384           (sb!c::do-nodes (node cont (interpreted-debug-block-ir1-block
2385                                    debug-block))
2386             (vector-push-extend (make-interpreted-code-location
2387                                  node
2388                                  (make-interpreted-debug-function
2389                                   (sb!c::block-home-lambda (sb!c::node-block
2390                                                             node))))
2391                                 buf))
2392           (setf (interpreted-debug-block-locations debug-block)
2393                 (result buf)))
2394         code-locs)))
2395 \f
2396 ;;;; operations on debug variables
2397
2398 (defun debug-var-symbol-name (debug-var)
2399   (symbol-name (debug-var-symbol debug-var)))
2400
2401 ;;; FIXME: Make sure that this isn't called anywhere that it wouldn't
2402 ;;; be acceptable to have NIL returned, or that it's only called on
2403 ;;; DEBUG-VARs whose symbols have non-NIL packages.
2404 (defun debug-var-package-name (debug-var)
2405   (package-name (symbol-package (debug-var-symbol debug-var))))
2406
2407 (defun debug-var-valid-value (debug-var frame)
2408   #!+sb-doc
2409   "Returns the value stored for DEBUG-VAR in frame. If the value is not
2410    :valid, then this signals an invalid-value error."
2411   (unless (eq (debug-var-validity debug-var (frame-code-location frame))
2412               :valid)
2413     (error 'invalid-value :debug-var debug-var :frame frame))
2414   (debug-var-value debug-var frame))
2415
2416 (defun debug-var-value (debug-var frame)
2417   #!+sb-doc
2418   "Returns the value stored for DEBUG-VAR in frame. The value may be
2419    invalid. This is SETF'able."
2420   (etypecase debug-var
2421     (compiled-debug-var
2422      (check-type frame compiled-frame)
2423      (let ((res (access-compiled-debug-var-slot debug-var frame)))
2424        (if (indirect-value-cell-p res)
2425            (sb!c:value-cell-ref res)
2426            res)))
2427     (interpreted-debug-var
2428      (check-type frame interpreted-frame)
2429      (sb!eval::leaf-value-lambda-var
2430       (interpreted-code-location-ir1-node (frame-code-location frame))
2431       (interpreted-debug-var-ir1-var debug-var)
2432       (frame-pointer frame)
2433       (interpreted-frame-closure frame)))))
2434
2435 ;;; This returns what is stored for the variable represented by
2436 ;;; DEBUG-VAR relative to the FRAME. This may be an indirect value
2437 ;;; cell if the variable is both closed over and set.
2438 (defun access-compiled-debug-var-slot (debug-var frame)
2439   (let ((escaped (compiled-frame-escaped frame)))
2440     (if escaped
2441         (sub-access-debug-var-slot
2442          (frame-pointer frame)
2443          (compiled-debug-var-sc-offset debug-var)
2444          escaped)
2445         (sub-access-debug-var-slot
2446          (frame-pointer frame)
2447          (or (compiled-debug-var-save-sc-offset debug-var)
2448              (compiled-debug-var-sc-offset debug-var))))))
2449
2450 ;;; a helper function for working with possibly-invalid values:
2451 ;;; Do (MAKE-LISP-OBJ VAL) only if the value looks valid.
2452 ;;;
2453 ;;; (Such values can arise in registers on machines with conservative
2454 ;;; GC, and might also arise in debug variable locations when
2455 ;;; those variables are invalid.)
2456 (defun make-valid-lisp-obj (val)
2457   (/show0 "entering MAKE-VALID-LISP-OBJ, VAL=..")
2458   #!+sb-show (%primitive print (sb!impl::hexstr val))
2459   (if (or
2460        ;; fixnum
2461        (zerop (logand val 3))
2462        ;; character
2463        (and (zerop (logand val #xffff0000)) ; Top bits zero
2464             (= (logand val #xff) sb!vm:base-char-type)) ; Char tag
2465        ;; unbound marker
2466        (= val sb!vm:unbound-marker-type)
2467        ;; pointer
2468        (and (logand val 1)
2469             ;; Check that the pointer is valid. XXX Could do a better
2470             ;; job. FIXME: e.g. by calling out to an is_valid_pointer
2471             ;; routine in the C runtime support code
2472             (or (< sb!vm:read-only-space-start val
2473                    (* sb!vm:*read-only-space-free-pointer*
2474                       sb!vm:word-bytes))
2475                 (< sb!vm:static-space-start val
2476                    (* sb!vm:*static-space-free-pointer*
2477                       sb!vm:word-bytes))
2478                 (< sb!vm:dynamic-space-start val
2479                    (sap-int (dynamic-space-free-pointer))))))
2480       (make-lisp-obj val)
2481       :invalid-object))
2482
2483 ;;; CMU CL had
2484 ;;;   (DEFUN SUB-ACCESS-DEBUG-VAR-SLOT (FP SC-OFFSET &OPTIONAL ESCAPED) ..)
2485 ;;; code for this case.
2486 #!-x86
2487 (eval-when (:compile-toplevel :load-toplevel :execute)
2488   (error "hopelessly stale"))
2489
2490 #!+x86
2491 (defun sub-access-debug-var-slot (fp sc-offset &optional escaped)
2492   (declare (type system-area-pointer fp))
2493   (/show0 "entering SUB-ACCESS-DEBUG-VAR-SLOT, FP,SC-OFFSET,ESCAPED=..")
2494   #!+sb-show (%primitive print (sb!impl::hexstr fp))
2495   #!+sb-show (%primitive print (sb!impl::hexstr sc-offset))
2496   #!+sb-show (%primitive print (sb!impl::hexstr escaped))
2497   (macrolet ((with-escaped-value ((var) &body forms)
2498                `(if escaped
2499                     (let ((,var (sb!vm:context-register
2500                                  escaped
2501                                  (sb!c:sc-offset-offset sc-offset))))
2502                       (/show0 "in escaped case, ,VAR value=..")
2503                       #!+sb-show (%primitive print (sb!impl::hexstr ,var))
2504                       ,@forms)
2505                     :invalid-value-for-unescaped-register-storage))
2506              (escaped-float-value (format)
2507                `(if escaped
2508                     (sb!vm:context-float-register
2509                      escaped (sb!c:sc-offset-offset sc-offset) ',format)
2510                     :invalid-value-for-unescaped-register-storage))
2511              (escaped-complex-float-value (format)
2512                `(if escaped
2513                     (complex
2514                      (sb!vm:context-float-register
2515                       escaped (sb!c:sc-offset-offset sc-offset) ',format)
2516                      (sb!vm:context-float-register
2517                       escaped (1+ (sb!c:sc-offset-offset sc-offset)) ',format))
2518                     :invalid-value-for-unescaped-register-storage)))
2519     (ecase (sb!c:sc-offset-scn sc-offset)
2520       ((#.sb!vm:any-reg-sc-number #.sb!vm:descriptor-reg-sc-number)
2521        (/show0 "case of ANY-REG-SC-NUMBER or DESCRIPTOR-REG-SC-NUMBER")
2522        (without-gcing
2523         (with-escaped-value (val)
2524           (/show0 "VAL=..")
2525           #!+sb-show (%primitive print (sb!impl::hexstr val))
2526           (make-valid-lisp-obj val))))
2527       (#.sb!vm:base-char-reg-sc-number
2528        (/show0 "case of BASE-CHAR-REG-SC-NUMBER")
2529        (with-escaped-value (val)
2530          (code-char val)))
2531       (#.sb!vm:sap-reg-sc-number
2532        (/show0 "case of SAP-REG-SC-NUMBER")
2533        (with-escaped-value (val)
2534          (int-sap val)))
2535       (#.sb!vm:signed-reg-sc-number
2536        (/show0 "case of SIGNED-REG-SC-NUMBER")
2537        (with-escaped-value (val)
2538          (if (logbitp (1- sb!vm:word-bits) val)
2539              (logior val (ash -1 sb!vm:word-bits))
2540              val)))
2541       (#.sb!vm:unsigned-reg-sc-number
2542        (/show0 "case of UNSIGNED-REG-SC-NUMBER")
2543        (with-escaped-value (val)
2544          val))
2545       (#.sb!vm:single-reg-sc-number
2546        (/show0 "case of SINGLE-REG-SC-NUMBER")
2547        (escaped-float-value single-float))
2548       (#.sb!vm:double-reg-sc-number
2549        (/show0 "case of DOUBLE-REG-SC-NUMBER")
2550        (escaped-float-value double-float))
2551       #!+long-float
2552       (#.sb!vm:long-reg-sc-number
2553        (/show0 "case of LONG-REG-SC-NUMBER")
2554        (escaped-float-value long-float))
2555       (#.sb!vm:complex-single-reg-sc-number
2556        (/show0 "case of COMPLEX-SINGLE-REG-SC-NUMBER")
2557        (escaped-complex-float-value single-float))
2558       (#.sb!vm:complex-double-reg-sc-number
2559        (/show0 "case of COMPLEX-DOUBLE-REG-SC-NUMBER")
2560        (escaped-complex-float-value double-float))
2561       #!+long-float
2562       (#.sb!vm:complex-long-reg-sc-number
2563        (/show0 "case of COMPLEX-LONG-REG-SC-NUMBER")
2564        (escaped-complex-float-value long-float))
2565       (#.sb!vm:single-stack-sc-number
2566        (/show0 "case of SINGLE-STACK-SC-NUMBER")
2567        (sap-ref-single fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2568                                 sb!vm:word-bytes))))
2569       (#.sb!vm:double-stack-sc-number
2570        (/show0 "case of DOUBLE-STACK-SC-NUMBER")
2571        (sap-ref-double fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2572                                 sb!vm:word-bytes))))
2573       #!+long-float
2574       (#.sb!vm:long-stack-sc-number
2575        (/show0 "case of LONG-STACK-SC-NUMBER")
2576        (sap-ref-long fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2577                               sb!vm:word-bytes))))
2578       (#.sb!vm:complex-single-stack-sc-number
2579        (/show0 "case of COMPLEX-STACK-SC-NUMBER")
2580        (complex
2581         (sap-ref-single fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2582                                  sb!vm:word-bytes)))
2583         (sap-ref-single fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2584                                  sb!vm:word-bytes)))))
2585       (#.sb!vm:complex-double-stack-sc-number
2586        (/show0 "case of COMPLEX-DOUBLE-STACK-SC-NUMBER")
2587        (complex
2588         (sap-ref-double fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2589                                  sb!vm:word-bytes)))
2590         (sap-ref-double fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 4)
2591                                  sb!vm:word-bytes)))))
2592       #!+long-float
2593       (#.sb!vm:complex-long-stack-sc-number
2594        (/show0 "case of COMPLEX-LONG-STACK-SC-NUMBER")
2595        (complex
2596         (sap-ref-long fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2597                                sb!vm:word-bytes)))
2598         (sap-ref-long fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 6)
2599                                sb!vm:word-bytes)))))
2600       (#.sb!vm:control-stack-sc-number
2601        (/show0 "case of CONTROL-STACK-SC-NUMBER")
2602        (stack-ref fp (sb!c:sc-offset-offset sc-offset)))
2603       (#.sb!vm:base-char-stack-sc-number
2604        (/show0 "case of BASE-CHAR-STACK-SC-NUMBER")
2605        (code-char
2606         (sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2607                              sb!vm:word-bytes)))))
2608       (#.sb!vm:unsigned-stack-sc-number
2609        (/show0 "case of UNSIGNED-STACK-SC-NUMBER")
2610        (sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2611                             sb!vm:word-bytes))))
2612       (#.sb!vm:signed-stack-sc-number
2613        (/show0 "case of SIGNED-STACK-SC-NUMBER")
2614        (signed-sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2615                                    sb!vm:word-bytes))))
2616       (#.sb!vm:sap-stack-sc-number
2617        (/show0 "case of SAP-STACK-SC-NUMBER")
2618        (sap-ref-sap fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2619                              sb!vm:word-bytes)))))))
2620
2621 ;;; This stores value as the value of DEBUG-VAR in FRAME. In the
2622 ;;; COMPILED-DEBUG-VAR case, access the current value to determine if
2623 ;;; it is an indirect value cell. This occurs when the variable is
2624 ;;; both closed over and set. For INTERPRETED-DEBUG-VARs just call
2625 ;;; SB!EVAL::SET-LEAF-VALUE-LAMBDA-VAR with the right interpreter
2626 ;;; objects.
2627 (defun %set-debug-var-value (debug-var frame value)
2628   (etypecase debug-var
2629     (compiled-debug-var
2630      (check-type frame compiled-frame)
2631      (let ((current-value (access-compiled-debug-var-slot debug-var frame)))
2632        (if (indirect-value-cell-p current-value)
2633            (sb!c:value-cell-set current-value value)
2634            (set-compiled-debug-var-slot debug-var frame value))))
2635     (interpreted-debug-var
2636      (check-type frame interpreted-frame)
2637      (sb!eval::set-leaf-value-lambda-var
2638       (interpreted-code-location-ir1-node (frame-code-location frame))
2639       (interpreted-debug-var-ir1-var debug-var)
2640       (frame-pointer frame)
2641       (interpreted-frame-closure frame)
2642       value)))
2643   value)
2644
2645 ;;; This stores value for the variable represented by debug-var
2646 ;;; relative to the frame. This assumes the location directly contains
2647 ;;; the variable's value; that is, there is no indirect value cell
2648 ;;; currently there in case the variable is both closed over and set.
2649 (defun set-compiled-debug-var-slot (debug-var frame value)
2650   (let ((escaped (compiled-frame-escaped frame)))
2651     (if escaped
2652         (sub-set-debug-var-slot (frame-pointer frame)
2653                                 (compiled-debug-var-sc-offset debug-var)
2654                                 value escaped)
2655         (sub-set-debug-var-slot
2656          (frame-pointer frame)
2657          (or (compiled-debug-var-save-sc-offset debug-var)
2658              (compiled-debug-var-sc-offset debug-var))
2659          value))))
2660
2661 #!-x86
2662 (defun sub-set-debug-var-slot (fp sc-offset value &optional escaped)
2663   (macrolet ((set-escaped-value (val)
2664                `(if escaped
2665                     (setf (sb!vm:context-register
2666                            escaped
2667                            (sb!c:sc-offset-offset sc-offset))
2668                           ,val)
2669                     value))
2670              (set-escaped-float-value (format val)
2671                `(if escaped
2672                     (setf (sb!vm:context-float-register
2673                            escaped
2674                            (sb!c:sc-offset-offset sc-offset)
2675                            ',format)
2676                           ,val)
2677                     value))
2678              (with-nfp ((var) &body body)
2679                `(let ((,var (if escaped
2680                                 (int-sap
2681                                  (sb!vm:context-register escaped
2682                                                          sb!vm::nfp-offset))
2683                                 #!-alpha
2684                                 (sap-ref-sap fp
2685                                                     (* sb!vm::nfp-save-offset
2686                                                        sb!vm:word-bytes))
2687                                 #!+alpha
2688                                 (%alpha::make-number-stack-pointer
2689                                  (sap-ref-32 fp
2690                                                     (* sb!vm::nfp-save-offset
2691                                                        sb!vm:word-bytes))))))
2692                   ,@body)))
2693     (ecase (sb!c:sc-offset-scn sc-offset)
2694       ((#.sb!vm:any-reg-sc-number
2695         #.sb!vm:descriptor-reg-sc-number
2696         #!+rt #.sb!vm:word-pointer-reg-sc-number)
2697        (without-gcing
2698         (set-escaped-value
2699           (get-lisp-obj-address value))))
2700       (#.sb!vm:base-char-reg-sc-number
2701        (set-escaped-value (char-code value)))
2702       (#.sb!vm:sap-reg-sc-number
2703        (set-escaped-value (sap-int value)))
2704       (#.sb!vm:signed-reg-sc-number
2705        (set-escaped-value (logand value (1- (ash 1 sb!vm:word-bits)))))
2706       (#.sb!vm:unsigned-reg-sc-number
2707        (set-escaped-value value))
2708       (#.sb!vm:non-descriptor-reg-sc-number
2709        (error "Local non-descriptor register access?"))
2710       (#.sb!vm:interior-reg-sc-number
2711        (error "Local interior register access?"))
2712       (#.sb!vm:single-reg-sc-number
2713        (set-escaped-float-value single-float value))
2714       (#.sb!vm:double-reg-sc-number
2715        (set-escaped-float-value double-float value))
2716       #!+long-float
2717       (#.sb!vm:long-reg-sc-number
2718        (set-escaped-float-value long-float value))
2719       (#.sb!vm:complex-single-reg-sc-number
2720        (when escaped
2721          (setf (sb!vm:context-float-register escaped
2722                                              (sb!c:sc-offset-offset sc-offset)
2723                                              'single-float)
2724                (realpart value))
2725          (setf (sb!vm:context-float-register
2726                 escaped (1+ (sb!c:sc-offset-offset sc-offset))
2727                 'single-float)
2728                (imagpart value)))
2729        value)
2730       (#.sb!vm:complex-double-reg-sc-number
2731        (when escaped
2732          (setf (sb!vm:context-float-register
2733                 escaped (sb!c:sc-offset-offset sc-offset) 'double-float)
2734                (realpart value))
2735          (setf (sb!vm:context-float-register
2736                 escaped
2737                 (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 2 #!-sparc 1)
2738                 'double-float)
2739                (imagpart value)))
2740        value)
2741       #!+long-float
2742       (#.sb!vm:complex-long-reg-sc-number
2743        (when escaped
2744          (setf (sb!vm:context-float-register
2745                 escaped (sb!c:sc-offset-offset sc-offset) 'long-float)
2746                (realpart value))
2747          (setf (sb!vm:context-float-register
2748                 escaped
2749                 (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 4)
2750                 'long-float)
2751                (imagpart value)))
2752        value)
2753       (#.sb!vm:single-stack-sc-number
2754        (with-nfp (nfp)
2755          (setf (sap-ref-single nfp (* (sb!c:sc-offset-offset sc-offset)
2756                                       sb!vm:word-bytes))
2757                (the single-float value))))
2758       (#.sb!vm:double-stack-sc-number
2759        (with-nfp (nfp)
2760          (setf (sap-ref-double nfp (* (sb!c:sc-offset-offset sc-offset)
2761                                       sb!vm:word-bytes))
2762                (the double-float value))))
2763       #!+long-float
2764       (#.sb!vm:long-stack-sc-number
2765        (with-nfp (nfp)
2766          (setf (sap-ref-long nfp (* (sb!c:sc-offset-offset sc-offset)
2767                                     sb!vm:word-bytes))
2768                (the long-float value))))
2769       (#.sb!vm:complex-single-stack-sc-number
2770        (with-nfp (nfp)
2771          (setf (sap-ref-single
2772                 nfp (* (sb!c:sc-offset-offset sc-offset) sb!vm:word-bytes))
2773                (the single-float (realpart value)))
2774          (setf (sap-ref-single
2775                 nfp (* (1+ (sb!c:sc-offset-offset sc-offset))
2776                        sb!vm:word-bytes))
2777                (the single-float (realpart value)))))
2778       (#.sb!vm:complex-double-stack-sc-number
2779        (with-nfp (nfp)
2780          (setf (sap-ref-double
2781                 nfp (* (sb!c:sc-offset-offset sc-offset) sb!vm:word-bytes))
2782                (the double-float (realpart value)))
2783          (setf (sap-ref-double
2784                 nfp (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2785                        sb!vm:word-bytes))
2786                (the double-float (realpart value)))))
2787       #!+long-float
2788       (#.sb!vm:complex-long-stack-sc-number
2789        (with-nfp (nfp)
2790          (setf (sap-ref-long
2791                 nfp (* (sb!c:sc-offset-offset sc-offset) sb!vm:word-bytes))
2792                (the long-float (realpart value)))
2793          (setf (sap-ref-long
2794                 nfp (* (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 4)
2795                        sb!vm:word-bytes))
2796                (the long-float (realpart value)))))
2797       (#.sb!vm:control-stack-sc-number
2798        (setf (stack-ref fp (sb!c:sc-offset-offset sc-offset)) value))
2799       (#.sb!vm:base-char-stack-sc-number
2800        (with-nfp (nfp)
2801          (setf (sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2802                                          sb!vm:word-bytes))
2803                (char-code (the character value)))))
2804       (#.sb!vm:unsigned-stack-sc-number
2805        (with-nfp (nfp)
2806          (setf (sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2807                                   sb!vm:word-bytes))
2808                (the (unsigned-byte 32) value))))
2809       (#.sb!vm:signed-stack-sc-number
2810        (with-nfp (nfp)
2811          (setf (signed-sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2812                                          sb!vm:word-bytes))
2813                (the (signed-byte 32) value))))
2814       (#.sb!vm:sap-stack-sc-number
2815        (with-nfp (nfp)
2816          (setf (sap-ref-sap nfp (* (sb!c:sc-offset-offset sc-offset)
2817                                    sb!vm:word-bytes))
2818                (the system-area-pointer value)))))))
2819
2820 #!+x86
2821 (defun sub-set-debug-var-slot (fp sc-offset value &optional escaped)
2822   (macrolet ((set-escaped-value (val)
2823                `(if escaped
2824                     (setf (sb!vm:context-register
2825                            escaped
2826                            (sb!c:sc-offset-offset sc-offset))
2827                           ,val)
2828                     value)))
2829     (ecase (sb!c:sc-offset-scn sc-offset)
2830       ((#.sb!vm:any-reg-sc-number #.sb!vm:descriptor-reg-sc-number)
2831        (without-gcing
2832         (set-escaped-value
2833           (get-lisp-obj-address value))))
2834       (#.sb!vm:base-char-reg-sc-number
2835        (set-escaped-value (char-code value)))
2836       (#.sb!vm:sap-reg-sc-number
2837        (set-escaped-value (sap-int value)))
2838       (#.sb!vm:signed-reg-sc-number
2839        (set-escaped-value (logand value (1- (ash 1 sb!vm:word-bits)))))
2840       (#.sb!vm:unsigned-reg-sc-number
2841        (set-escaped-value value))
2842       (#.sb!vm:single-reg-sc-number
2843         #+nil ;; don't have escaped floats.
2844        (set-escaped-float-value single-float value))
2845       (#.sb!vm:double-reg-sc-number
2846         #+nil ;;  don't have escaped floats -- still in npx?
2847        (set-escaped-float-value double-float value))
2848       #!+long-float
2849       (#.sb!vm:long-reg-sc-number
2850         #+nil ;;  don't have escaped floats -- still in npx?
2851        (set-escaped-float-value long-float value))
2852       (#.sb!vm:single-stack-sc-number
2853        (setf (sap-ref-single
2854               fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2855                        sb!vm:word-bytes)))
2856              (the single-float value)))
2857       (#.sb!vm:double-stack-sc-number
2858        (setf (sap-ref-double
2859               fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2860                        sb!vm:word-bytes)))
2861              (the double-float value)))
2862       #!+long-float
2863       (#.sb!vm:long-stack-sc-number
2864        (setf (sap-ref-long
2865               fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2866                        sb!vm:word-bytes)))
2867              (the long-float value)))
2868       (#.sb!vm:complex-single-stack-sc-number
2869        (setf (sap-ref-single
2870               fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2871                        sb!vm:word-bytes)))
2872              (realpart (the (complex single-float) value)))
2873        (setf (sap-ref-single
2874               fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2875                        sb!vm:word-bytes)))
2876              (imagpart (the (complex single-float) value))))
2877       (#.sb!vm:complex-double-stack-sc-number
2878        (setf (sap-ref-double
2879               fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2880                        sb!vm:word-bytes)))
2881              (realpart (the (complex double-float) value)))
2882        (setf (sap-ref-double
2883               fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 4)
2884                        sb!vm:word-bytes)))
2885              (imagpart (the (complex double-float) value))))
2886       #!+long-float
2887       (#.sb!vm:complex-long-stack-sc-number
2888        (setf (sap-ref-long
2889               fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2890                        sb!vm:word-bytes)))
2891              (realpart (the (complex long-float) value)))
2892        (setf (sap-ref-long
2893               fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 6)
2894                        sb!vm:word-bytes)))
2895              (imagpart (the (complex long-float) value))))
2896       (#.sb!vm:control-stack-sc-number
2897        (setf (stack-ref fp (sb!c:sc-offset-offset sc-offset)) value))
2898       (#.sb!vm:base-char-stack-sc-number
2899        (setf (sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2900                                          sb!vm:word-bytes)))
2901              (char-code (the character value))))
2902       (#.sb!vm:unsigned-stack-sc-number
2903        (setf (sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2904                                          sb!vm:word-bytes)))
2905              (the (unsigned-byte 32) value)))
2906       (#.sb!vm:signed-stack-sc-number
2907        (setf (signed-sap-ref-32
2908               fp (- (* (1+ (sb!c:sc-offset-offset sc-offset)) sb!vm:word-bytes)))
2909              (the (signed-byte 32) value)))
2910       (#.sb!vm:sap-stack-sc-number
2911        (setf (sap-ref-sap fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2912                                           sb!vm:word-bytes)))
2913              (the system-area-pointer value))))))
2914
2915 ;;; The method for setting and accessing COMPILED-DEBUG-VAR values use
2916 ;;; this to determine if the value stored is the actual value or an
2917 ;;; indirection cell.
2918 (defun indirect-value-cell-p (x)
2919   (and (= (get-lowtag x) sb!vm:other-pointer-type)
2920        (= (get-type x) sb!vm:value-cell-header-type)))
2921
2922 ;;; If the variable is always alive, then it is valid. If the
2923 ;;; code-location is unknown, then the variable's validity is
2924 ;;; :unknown. Once we've called CODE-LOCATION-UNKNOWN-P, we know the
2925 ;;; live-set information has been cached in the code-location.
2926 (defun debug-var-validity (debug-var basic-code-location)
2927   #!+sb-doc
2928   "Returns three values reflecting the validity of DEBUG-VAR's value
2929    at BASIC-CODE-LOCATION:
2930       :VALID    The value is known to be available.
2931       :INVALID  The value is known to be unavailable.
2932       :UNKNOWN  The value's availability is unknown."
2933   (etypecase debug-var
2934     (compiled-debug-var
2935      (compiled-debug-var-validity debug-var basic-code-location))
2936     (interpreted-debug-var
2937      (check-type basic-code-location interpreted-code-location)
2938      (let ((validp (rassoc (interpreted-debug-var-ir1-var debug-var)
2939                            (sb!c::lexenv-variables
2940                             (sb!c::node-lexenv
2941                              (interpreted-code-location-ir1-node
2942                               basic-code-location))))))
2943        (if validp :valid :invalid)))))
2944
2945 ;;; This is the method for DEBUG-VAR-VALIDITY for COMPILED-DEBUG-VARs.
2946 ;;; For safety, make sure basic-code-location is what we think.
2947 (defun compiled-debug-var-validity (debug-var basic-code-location)
2948   (check-type basic-code-location compiled-code-location)
2949   (cond ((debug-var-alive-p debug-var)
2950          (let ((debug-fun (code-location-debug-function basic-code-location)))
2951            (if (>= (compiled-code-location-pc basic-code-location)
2952                    (sb!c::compiled-debug-function-start-pc
2953                     (compiled-debug-function-compiler-debug-fun debug-fun)))
2954                :valid
2955                :invalid)))
2956         ((code-location-unknown-p basic-code-location) :unknown)
2957         (t
2958          (let ((pos (position debug-var
2959                               (debug-function-debug-vars
2960                                (code-location-debug-function basic-code-location)))))
2961            (unless pos
2962              (error 'unknown-debug-var
2963                     :debug-var debug-var
2964                     :debug-function
2965                     (code-location-debug-function basic-code-location)))
2966            ;; There must be live-set info since basic-code-location is known.
2967            (if (zerop (sbit (compiled-code-location-live-set basic-code-location)
2968                             pos))
2969                :invalid
2970                :valid)))))
2971 \f
2972 ;;;; sources
2973
2974 ;;; This code produces and uses what we call source-paths. A
2975 ;;; source-path is a list whose first element is a form number as
2976 ;;; returned by CODE-LOCATION-FORM-NUMBER and whose last element is a
2977 ;;; top-level-form number as returned by
2978 ;;; CODE-LOCATION-TOP-LEVEL-FORM-NUMBER. The elements from the last to
2979 ;;; the first, exclusively, are the numbered subforms into which to
2980 ;;; descend. For example:
2981 ;;;    (defun foo (x)
2982 ;;;      (let ((a (aref x 3)))
2983 ;;;     (cons a 3)))
2984 ;;; The call to AREF in this example is form number 5. Assuming this
2985 ;;; DEFUN is the 11'th top-level-form, the source-path for the AREF
2986 ;;; call is as follows:
2987 ;;;    (5 1 0 1 3 11)
2988 ;;; Given the DEFUN, 3 gets you the LET, 1 gets you the bindings, 0
2989 ;;; gets the first binding, and 1 gets the AREF form.
2990
2991 ;;; Temporary buffer used to build form-number => source-path translation in
2992 ;;; FORM-NUMBER-TRANSLATIONS.
2993 (defvar *form-number-temp* (make-array 10 :fill-pointer 0 :adjustable t))
2994
2995 ;;; Table used to detect CAR circularities in FORM-NUMBER-TRANSLATIONS.
2996 (defvar *form-number-circularity-table* (make-hash-table :test 'eq))
2997
2998 ;;; The vector elements are in the same format as the compiler's
2999 ;;; NODE-SOUCE-PATH; that is, the first element is the form number and the last
3000 ;;; is the top-level-form number.
3001 (defun form-number-translations (form tlf-number)
3002   #!+sb-doc
3003   "This returns a table mapping form numbers to source-paths. A source-path
3004    indicates a descent into the top-level-form form, going directly to the
3005    subform corressponding to the form number."
3006   (clrhash *form-number-circularity-table*)
3007   (setf (fill-pointer *form-number-temp*) 0)
3008   (sub-translate-form-numbers form (list tlf-number))
3009   (coerce *form-number-temp* 'simple-vector))
3010 (defun sub-translate-form-numbers (form path)
3011   (unless (gethash form *form-number-circularity-table*)
3012     (setf (gethash form *form-number-circularity-table*) t)
3013     (vector-push-extend (cons (fill-pointer *form-number-temp*) path)
3014                         *form-number-temp*)
3015     (let ((pos 0)
3016           (subform form)
3017           (trail form))
3018       (declare (fixnum pos))
3019       (macrolet ((frob ()
3020                    '(progn
3021                       (when (atom subform) (return))
3022                       (let ((fm (car subform)))
3023                         (when (consp fm)
3024                           (sub-translate-form-numbers fm (cons pos path)))
3025                         (incf pos))
3026                       (setq subform (cdr subform))
3027                       (when (eq subform trail) (return)))))
3028         (loop
3029           (frob)
3030           (frob)
3031           (setq trail (cdr trail)))))))
3032
3033 (defun source-path-context (form path context)
3034   #!+sb-doc
3035   "Form is a top-level form, and path is a source-path into it. This returns
3036    the form indicated by the source-path. Context is the number of enclosing
3037    forms to return instead of directly returning the source-path form. When
3038    context is non-zero, the form returned contains a marker, #:****HERE****,
3039    immediately before the form indicated by path."
3040   (declare (type unsigned-byte context))
3041   ;; Get to the form indicated by path or the enclosing form indicated
3042   ;; by context and path.
3043   (let ((path (reverse (butlast (cdr path)))))
3044     (dotimes (i (- (length path) context))
3045       (let ((index (first path)))
3046         (unless (and (listp form) (< index (length form)))
3047           (error "Source path no longer exists."))
3048         (setq form (elt form index))
3049         (setq path (rest path))))
3050     ;; Recursively rebuild the source form resulting from the above
3051     ;; descent, copying the beginning of each subform up to the next
3052     ;; subform we descend into according to path. At the bottom of the
3053     ;; recursion, we return the form indicated by path preceded by our
3054     ;; marker, and this gets spliced into the resulting list structure
3055     ;; on the way back up.
3056     (labels ((frob (form path level)
3057                (if (or (zerop level) (null path))
3058                    (if (zerop context)
3059                        form
3060                        `(#:***here*** ,form))
3061                    (let ((n (first path)))
3062                      (unless (and (listp form) (< n (length form)))
3063                        (error "Source path no longer exists."))
3064                      (let ((res (frob (elt form n) (rest path) (1- level))))
3065                        (nconc (subseq form 0 n)
3066                               (cons res (nthcdr (1+ n) form))))))))
3067       (frob form path context))))
3068 \f
3069 ;;;; PREPROCESS-FOR-EVAL and EVAL-IN-FRAME
3070
3071 ;;; Create a SYMBOL-MACROLET for each variable valid at the location which
3072 ;;; accesses that variable from the frame argument.
3073 (defun preprocess-for-eval (form loc)
3074   #!+sb-doc
3075   "Return a function of one argument that evaluates form in the lexical
3076    context of the basic-code-location loc. PREPROCESS-FOR-EVAL signals a
3077    no-debug-vars condition when the loc's debug-function has no
3078    debug-var information available. The returned function takes the frame
3079    to get values from as its argument, and it returns the values of form.
3080    The returned function signals the following conditions: invalid-value,
3081    ambiguous-variable-name, and frame-function-mismatch"
3082   (declare (type code-location loc))
3083   (let ((n-frame (gensym))
3084         (fun (code-location-debug-function loc)))
3085     (unless (debug-var-info-available fun)
3086       (debug-signal 'no-debug-vars :debug-function fun))
3087     (sb!int:collect ((binds)
3088                      (specs))
3089       (do-debug-function-variables (var fun)
3090         (let ((validity (debug-var-validity var loc)))
3091           (unless (eq validity :invalid)
3092             (let* ((sym (debug-var-symbol var))
3093                    (found (assoc sym (binds))))
3094               (if found
3095                   (setf (second found) :ambiguous)
3096                   (binds (list sym validity var)))))))
3097       (dolist (bind (binds))
3098         (let ((name (first bind))
3099               (var (third bind)))
3100           (ecase (second bind)
3101             (:valid
3102              (specs `(,name (debug-var-value ',var ,n-frame))))
3103             (:unknown
3104              (specs `(,name (debug-signal 'invalid-value :debug-var ',var
3105                                           :frame ,n-frame))))
3106             (:ambiguous
3107              (specs `(,name (debug-signal 'ambiguous-variable-name :name ',name
3108                                           :frame ,n-frame)))))))
3109       (let ((res (coerce `(lambda (,n-frame)
3110                             (declare (ignorable ,n-frame))
3111                             (symbol-macrolet ,(specs) ,form))
3112                          'function)))
3113         #'(lambda (frame)
3114             ;; This prevents these functions from being used in any
3115             ;; location other than a function return location, so
3116             ;; maybe this should only check whether frame's
3117             ;; debug-function is the same as loc's.
3118             (unless (code-location= (frame-code-location frame) loc)
3119               (debug-signal 'frame-function-mismatch
3120                             :code-location loc :form form :frame frame))
3121             (funcall res frame))))))
3122
3123 ;;; Evaluate FORM in the lexical context of FRAME's current code
3124 ;;; location, returning the results of the evaluation.
3125 (defun eval-in-frame (frame form)
3126   (declare (type frame frame))
3127   (funcall (preprocess-for-eval form (frame-code-location frame)) frame))
3128 \f
3129 ;;;; breakpoints
3130
3131 ;;;; user-visible interface
3132
3133 ;;; Create and return a breakpoint. When program execution encounters
3134 ;;; the breakpoint, the system calls HOOK-FUNCTION. HOOK-FUNCTION takes the
3135 ;;; current frame for the function in which the program is running and the
3136 ;;; breakpoint object.
3137 ;;;
3138 ;;; WHAT and KIND determine where in a function the system invokes
3139 ;;; HOOK-FUNCTION. WHAT is either a code-location or a debug-function.
3140 ;;; KIND is one of :CODE-LOCATION, :FUNCTION-START, or :FUNCTION-END.
3141 ;;; Since the starts and ends of functions may not have code-locations
3142 ;;; representing them, designate these places by supplying WHAT as a
3143 ;;; debug-function and KIND indicating the :FUNCTION-START or
3144 ;;; :FUNCTION-END. When WHAT is a debug-function and kind is
3145 ;;; :FUNCTION-END, then hook-function must take two additional
3146 ;;; arguments, a list of values returned by the function and a
3147 ;;; FUNCTION-END-COOKIE.
3148 ;;;
3149 ;;; INFO is information supplied by and used by the user.
3150 ;;;
3151 ;;; FUNCTION-END-COOKIE is a function. To implement :FUNCTION-END
3152 ;;; breakpoints, the system uses starter breakpoints to establish the
3153 ;;; :FUNCTION-END breakpoint for each invocation of the function. Upon
3154 ;;; each entry, the system creates a unique cookie to identify the
3155 ;;; invocation, and when the user supplies a function for this
3156 ;;; argument, the system invokes it on the frame and the cookie. The
3157 ;;; system later invokes the :FUNCTION-END breakpoint hook on the same
3158 ;;; cookie. The user may save the cookie for comparison in the hook
3159 ;;; function.
3160 ;;;
3161 ;;; Signal an error if WHAT is an unknown code-location.
3162 (defun make-breakpoint (hook-function what
3163                         &key (kind :code-location) info function-end-cookie)
3164   (etypecase what
3165     (code-location
3166      (when (code-location-unknown-p what)
3167        (error "cannot make a breakpoint at an unknown code location: ~S"
3168               what))
3169      (assert (eq kind :code-location))
3170      (let ((bpt (%make-breakpoint hook-function what kind info)))
3171        (etypecase what
3172          (interpreted-code-location
3173           (error "Breakpoints in interpreted code are currently unsupported."))
3174          (compiled-code-location
3175           ;; This slot is filled in due to calling CODE-LOCATION-UNKNOWN-P.
3176           (when (eq (compiled-code-location-kind what) :unknown-return)
3177             (let ((other-bpt (%make-breakpoint hook-function what
3178                                                :unknown-return-partner
3179                                                info)))
3180               (setf (breakpoint-unknown-return-partner bpt) other-bpt)
3181               (setf (breakpoint-unknown-return-partner other-bpt) bpt)))))
3182        bpt))
3183     (compiled-debug-function
3184      (ecase kind
3185        (:function-start
3186         (%make-breakpoint hook-function what kind info))
3187        (:function-end
3188         (unless (eq (sb!c::compiled-debug-function-returns
3189                      (compiled-debug-function-compiler-debug-fun what))
3190                     :standard)
3191           (error ":FUNCTION-END breakpoints are currently unsupported ~
3192                   for the known return convention."))
3193
3194         (let* ((bpt (%make-breakpoint hook-function what kind info))
3195                (starter (compiled-debug-function-end-starter what)))
3196           (unless starter
3197             (setf starter (%make-breakpoint #'list what :function-start nil))
3198             (setf (breakpoint-hook-function starter)
3199                   (function-end-starter-hook starter what))
3200             (setf (compiled-debug-function-end-starter what) starter))
3201           (setf (breakpoint-start-helper bpt) starter)
3202           (push bpt (breakpoint-%info starter))
3203           (setf (breakpoint-cookie-fun bpt) function-end-cookie)
3204           bpt))))
3205     (interpreted-debug-function
3206      (error ":function-end breakpoints are currently unsupported ~
3207              for interpreted-debug-functions."))))
3208
3209 ;;; These are unique objects created upon entry into a function by a
3210 ;;; :FUNCTION-END breakpoint's starter hook. These are only created
3211 ;;; when users supply :FUNCTION-END-COOKIE to MAKE-BREAKPOINT. Also,
3212 ;;; the :FUNCTION-END breakpoint's hook is called on the same cookie
3213 ;;; when it is created.
3214 (defstruct (function-end-cookie
3215             (:print-object (lambda (obj str)
3216                              (print-unreadable-object (obj str :type t))))
3217             (:constructor make-function-end-cookie (bogus-lra debug-fun)))
3218   ;; This is a pointer to the bogus-lra created for :function-end bpts.
3219   bogus-lra
3220   ;; This is the debug-function associated with the cookie.
3221   debug-fun)
3222
3223 ;;; This maps bogus-lra-components to cookies, so that
3224 ;;; HANDLE-FUNCTION-END-BREAKPOINT can find the appropriate cookie for the
3225 ;;; breakpoint hook.
3226 (defvar *function-end-cookies* (make-hash-table :test 'eq))
3227
3228 ;;; This returns a hook function for the start helper breakpoint
3229 ;;; associated with a :FUNCTION-END breakpoint. The returned function
3230 ;;; makes a fake LRA that all returns go through, and this piece of
3231 ;;; fake code actually breaks. Upon return from the break, the code
3232 ;;; provides the returnee with any values. Since the returned function
3233 ;;; effectively activates FUN-END-BPT on each entry to DEBUG-FUN's
3234 ;;; function, we must establish breakpoint-data about FUN-END-BPT.
3235 (defun function-end-starter-hook (starter-bpt debug-fun)
3236   (declare (type breakpoint starter-bpt)
3237            (type compiled-debug-function debug-fun))
3238   #'(lambda (frame breakpoint)
3239       (declare (ignore breakpoint)
3240                (type frame frame))
3241       (let ((lra-sc-offset
3242              (sb!c::compiled-debug-function-return-pc
3243               (compiled-debug-function-compiler-debug-fun debug-fun))))
3244         (multiple-value-bind (lra component offset)
3245             (make-bogus-lra
3246              (get-context-value frame
3247                                 #!-gengc sb!vm::lra-save-offset
3248                                 #!+gengc sb!vm::ra-save-offset
3249                                 lra-sc-offset))
3250           (setf (get-context-value frame
3251                                    #!-gengc sb!vm::lra-save-offset
3252                                    #!+gengc sb!vm::ra-save-offset
3253                                    lra-sc-offset)
3254                 lra)
3255           (let ((end-bpts (breakpoint-%info starter-bpt)))
3256             (let ((data (breakpoint-data component offset)))
3257               (setf (breakpoint-data-breakpoints data) end-bpts)
3258               (dolist (bpt end-bpts)
3259                 (setf (breakpoint-internal-data bpt) data)))
3260             (let ((cookie (make-function-end-cookie lra debug-fun)))
3261               (setf (gethash component *function-end-cookies*) cookie)
3262               (dolist (bpt end-bpts)
3263                 (let ((fun (breakpoint-cookie-fun bpt)))
3264                   (when fun (funcall fun frame cookie))))))))))
3265
3266 ;;; This takes a FUNCTION-END-COOKIE and a frame, and it returns
3267 ;;; whether the cookie is still valid. A cookie becomes invalid when
3268 ;;; the frame that established the cookie has exited. Sometimes cookie
3269 ;;; holders are unaware of cookie invalidation because their
3270 ;;; :FUNCTION-END breakpoint hooks didn't run due to THROW'ing.
3271 ;;;
3272 ;;; This takes a frame as an efficiency hack since the user probably
3273 ;;; has a frame object in hand when using this routine, and it saves
3274 ;;; repeated parsing of the stack and consing when asking whether a
3275 ;;; series of cookies is valid.
3276 (defun function-end-cookie-valid-p (frame cookie)
3277   (let ((lra (function-end-cookie-bogus-lra cookie))
3278         (lra-sc-offset (sb!c::compiled-debug-function-return-pc
3279                         (compiled-debug-function-compiler-debug-fun
3280                          (function-end-cookie-debug-fun cookie)))))
3281     (do ((frame frame (frame-down frame)))
3282         ((not frame) nil)
3283       (when (and (compiled-frame-p frame)
3284                  (eq lra
3285                      (get-context-value frame
3286                                         #!-gengc sb!vm::lra-save-offset
3287                                         #!+gengc sb!vm::ra-save-offset
3288                                         lra-sc-offset)))
3289         (return t)))))
3290 \f
3291 ;;;; ACTIVATE-BREAKPOINT
3292
3293 ;;; Cause the system to invoke the breakpoint's hook-function until
3294 ;;; the next call to DEACTIVATE-BREAKPOINT or DELETE-BREAKPOINT. The
3295 ;;; system invokes breakpoint hook functions in the opposite order
3296 ;;; that you activate them.
3297 (defun activate-breakpoint (breakpoint)
3298   (when (eq (breakpoint-status breakpoint) :deleted)
3299     (error "cannot activate a deleted breakpoint: ~S" breakpoint))
3300   (unless (eq (breakpoint-status breakpoint) :active)
3301     (ecase (breakpoint-kind breakpoint)
3302       (:code-location
3303        (let ((loc (breakpoint-what breakpoint)))
3304          (etypecase loc
3305            (interpreted-code-location
3306             (error "Breakpoints in interpreted code are currently unsupported."))
3307            (compiled-code-location
3308             (activate-compiled-code-location-breakpoint breakpoint)
3309             (let ((other (breakpoint-unknown-return-partner breakpoint)))
3310               (when other
3311                 (activate-compiled-code-location-breakpoint other)))))))
3312       (:function-start
3313        (etypecase (breakpoint-what breakpoint)
3314          (compiled-debug-function
3315           (activate-compiled-function-start-breakpoint breakpoint))
3316          (interpreted-debug-function
3317           (error "I don't know how you made this, but they're unsupported: ~S"
3318                  (breakpoint-what breakpoint)))))
3319       (:function-end
3320        (etypecase (breakpoint-what breakpoint)
3321          (compiled-debug-function
3322           (let ((starter (breakpoint-start-helper breakpoint)))
3323             (unless (eq (breakpoint-status starter) :active)
3324               ;; may already be active by some other :FUNCTION-END breakpoint
3325               (activate-compiled-function-start-breakpoint starter)))
3326           (setf (breakpoint-status breakpoint) :active))
3327          (interpreted-debug-function
3328           (error "I don't know how you made this, but they're unsupported: ~S"
3329                  (breakpoint-what breakpoint)))))))
3330   breakpoint)
3331
3332 (defun activate-compiled-code-location-breakpoint (breakpoint)
3333   (declare (type breakpoint breakpoint))
3334   (let ((loc (breakpoint-what breakpoint)))
3335     (declare (type compiled-code-location loc))
3336     (sub-activate-breakpoint
3337      breakpoint
3338      (breakpoint-data (compiled-debug-function-component
3339                        (code-location-debug-function loc))
3340                       (+ (compiled-code-location-pc loc)
3341                          (if (or (eq (breakpoint-kind breakpoint)
3342                                      :unknown-return-partner)
3343                                  (eq (compiled-code-location-kind loc)
3344                                      :single-value-return))
3345                              sb!vm:single-value-return-byte-offset
3346                              0))))))
3347
3348 (defun activate-compiled-function-start-breakpoint (breakpoint)
3349   (declare (type breakpoint breakpoint))
3350   (let ((debug-fun (breakpoint-what breakpoint)))
3351     (sub-activate-breakpoint
3352      breakpoint
3353      (breakpoint-data (compiled-debug-function-component debug-fun)
3354                       (sb!c::compiled-debug-function-start-pc
3355                        (compiled-debug-function-compiler-debug-fun
3356                         debug-fun))))))
3357
3358 (defun sub-activate-breakpoint (breakpoint data)
3359   (declare (type breakpoint breakpoint)
3360            (type breakpoint-data data))
3361   (setf (breakpoint-status breakpoint) :active)
3362   (without-interrupts
3363    (unless (breakpoint-data-breakpoints data)
3364      (setf (breakpoint-data-instruction data)
3365            (without-gcing
3366             (breakpoint-install (get-lisp-obj-address
3367                                  (breakpoint-data-component data))
3368                                 (breakpoint-data-offset data)))))
3369    (setf (breakpoint-data-breakpoints data)
3370          (append (breakpoint-data-breakpoints data) (list breakpoint)))
3371    (setf (breakpoint-internal-data breakpoint) data)))
3372 \f
3373 ;;;; DEACTIVATE-BREAKPOINT
3374
3375 (defun deactivate-breakpoint (breakpoint)
3376   #!+sb-doc
3377   "This stops the system from invoking the breakpoint's hook-function."
3378   (when (eq (breakpoint-status breakpoint) :active)
3379     (without-interrupts
3380      (let ((loc (breakpoint-what breakpoint)))
3381        (etypecase loc
3382          ((or interpreted-code-location interpreted-debug-function)
3383           (error
3384            "Breakpoints in interpreted code are currently unsupported."))
3385          ((or compiled-code-location compiled-debug-function)
3386           (deactivate-compiled-breakpoint breakpoint)
3387           (let ((other (breakpoint-unknown-return-partner breakpoint)))
3388             (when other
3389               (deactivate-compiled-breakpoint other))))))))
3390   breakpoint)
3391
3392 (defun deactivate-compiled-breakpoint (breakpoint)
3393   (if (eq (breakpoint-kind breakpoint) :function-end)
3394       (let ((starter (breakpoint-start-helper breakpoint)))
3395         (unless (find-if #'(lambda (bpt)
3396                              (and (not (eq bpt breakpoint))
3397                                   (eq (breakpoint-status bpt) :active)))
3398                          (breakpoint-%info starter))
3399           (deactivate-compiled-breakpoint starter)))
3400       (let* ((data (breakpoint-internal-data breakpoint))
3401              (bpts (delete breakpoint (breakpoint-data-breakpoints data))))
3402         (setf (breakpoint-internal-data breakpoint) nil)
3403         (setf (breakpoint-data-breakpoints data) bpts)
3404         (unless bpts
3405           (without-gcing
3406            (breakpoint-remove (get-lisp-obj-address
3407                                (breakpoint-data-component data))
3408                               (breakpoint-data-offset data)
3409                               (breakpoint-data-instruction data)))
3410           (delete-breakpoint-data data))))
3411   (setf (breakpoint-status breakpoint) :inactive)
3412   breakpoint)
3413 \f
3414 ;;;; BREAKPOINT-INFO
3415
3416 (defun breakpoint-info (breakpoint)
3417   #!+sb-doc
3418   "This returns the user-maintained info associated with breakpoint. This
3419    is SETF'able."
3420   (breakpoint-%info breakpoint))
3421 (defun %set-breakpoint-info (breakpoint value)
3422   (setf (breakpoint-%info breakpoint) value)
3423   (let ((other (breakpoint-unknown-return-partner breakpoint)))
3424     (when other
3425       (setf (breakpoint-%info other) value))))
3426 \f
3427 ;;;; BREAKPOINT-ACTIVE-P and DELETE-BREAKPOINT
3428
3429 (defun breakpoint-active-p (breakpoint)
3430   #!+sb-doc
3431   "This returns whether breakpoint is currently active."
3432   (ecase (breakpoint-status breakpoint)
3433     (:active t)
3434     ((:inactive :deleted) nil)))
3435
3436 (defun delete-breakpoint (breakpoint)
3437   #!+sb-doc
3438   "This frees system storage and removes computational overhead associated with
3439    breakpoint. After calling this, breakpoint is completely impotent and can
3440    never become active again."
3441   (let ((status (breakpoint-status breakpoint)))
3442     (unless (eq status :deleted)
3443       (when (eq status :active)
3444         (deactivate-breakpoint breakpoint))
3445       (setf (breakpoint-status breakpoint) :deleted)
3446       (let ((other (breakpoint-unknown-return-partner breakpoint)))
3447         (when other
3448           (setf (breakpoint-status other) :deleted)))
3449       (when (eq (breakpoint-kind breakpoint) :function-end)
3450         (let* ((starter (breakpoint-start-helper breakpoint))
3451                (breakpoints (delete breakpoint
3452                                     (the list (breakpoint-info starter)))))
3453           (setf (breakpoint-info starter) breakpoints)
3454           (unless breakpoints
3455             (delete-breakpoint starter)
3456             (setf (compiled-debug-function-end-starter
3457                    (breakpoint-what breakpoint))
3458                   nil))))))
3459   breakpoint)
3460 \f
3461 ;;;; C call out stubs
3462
3463 ;;; This actually installs the break instruction in the component. It
3464 ;;; returns the overwritten bits. You must call this in a context in
3465 ;;; which GC is disabled, so that Lisp doesn't move objects around
3466 ;;; that C is pointing to.
3467 (sb!alien:def-alien-routine "breakpoint_install" sb!c-call:unsigned-long
3468   (code-obj sb!c-call:unsigned-long)
3469   (pc-offset sb!c-call:int))
3470
3471 ;;; This removes the break instruction and replaces the original
3472 ;;; instruction. You must call this in a context in which GC is disabled
3473 ;;; so Lisp doesn't move objects around that C is pointing to.
3474 (sb!alien:def-alien-routine "breakpoint_remove" sb!c-call:void
3475   (code-obj sb!c-call:unsigned-long)
3476   (pc-offset sb!c-call:int)
3477   (old-inst sb!c-call:unsigned-long))
3478
3479 (sb!alien:def-alien-routine "breakpoint_do_displaced_inst" sb!c-call:void
3480   (scp (* os-context-t))
3481   (orig-inst sb!c-call:unsigned-long))
3482
3483 ;;;; breakpoint handlers (layer between C and exported interface)
3484
3485 ;;; This maps components to a mapping of offsets to breakpoint-datas.
3486 (defvar *component-breakpoint-offsets* (make-hash-table :test 'eq))
3487
3488 ;;; This returns the breakpoint-data associated with component cross
3489 ;;; offset. If none exists, this makes one, installs it, and returns it.
3490 (defun breakpoint-data (component offset &optional (create t))
3491   (flet ((install-breakpoint-data ()
3492            (when create
3493              (let ((data (make-breakpoint-data component offset)))
3494                (push (cons offset data)
3495                      (gethash component *component-breakpoint-offsets*))
3496                data))))
3497     (let ((offsets (gethash component *component-breakpoint-offsets*)))
3498       (if offsets
3499           (let ((data (assoc offset offsets)))
3500             (if data
3501                 (cdr data)
3502                 (install-breakpoint-data)))
3503           (install-breakpoint-data)))))
3504
3505 ;;; We use this when there are no longer any active breakpoints
3506 ;;; corresponding to data.
3507 (defun delete-breakpoint-data (data)
3508   (let* ((component (breakpoint-data-component data))
3509          (offsets (delete (breakpoint-data-offset data)
3510                           (gethash component *component-breakpoint-offsets*)
3511                           :key #'car)))
3512     (if offsets
3513         (setf (gethash component *component-breakpoint-offsets*) offsets)
3514         (remhash component *component-breakpoint-offsets*)))
3515   (values))
3516
3517 ;;; The C handler for interrupts calls this when it has a
3518 ;;; debugging-tool break instruction. This does NOT handle all breaks;
3519 ;;; for example, it does not handle breaks for internal errors.
3520 (defun handle-breakpoint (offset component signal-context)
3521   (/show0 "entering HANDLE-BREAKPOINT")
3522   (let ((data (breakpoint-data component offset nil)))
3523     (unless data
3524       (error "unknown breakpoint in ~S at offset ~S"
3525               (debug-function-name (debug-function-from-pc component offset))
3526               offset))
3527     (let ((breakpoints (breakpoint-data-breakpoints data)))
3528       (if (or (null breakpoints)
3529               (eq (breakpoint-kind (car breakpoints)) :function-end))
3530           (handle-function-end-breakpoint-aux breakpoints data signal-context)
3531           (handle-breakpoint-aux breakpoints data
3532                                  offset component signal-context)))))
3533
3534 ;;; This holds breakpoint-datas while invoking the breakpoint hooks
3535 ;;; associated with that particular component and location. While they
3536 ;;; are executing, if we hit the location again, we ignore the
3537 ;;; breakpoint to avoid infinite recursion. Function-end breakpoints
3538 ;;; must work differently since the breakpoint-data is unique for each
3539 ;;; invocation.
3540 (defvar *executing-breakpoint-hooks* nil)
3541
3542 ;;; This handles code-location and debug-function :FUNCTION-START
3543 ;;; breakpoints.
3544 (defun handle-breakpoint-aux (breakpoints data offset component signal-context)
3545   (/show0 "entering HANDLE-BREAKPOINT-AUX")
3546   (unless breakpoints
3547     (error "internal error: breakpoint that nobody wants"))
3548   (unless (member data *executing-breakpoint-hooks*)
3549     (let ((*executing-breakpoint-hooks* (cons data
3550                                               *executing-breakpoint-hooks*)))
3551       (invoke-breakpoint-hooks breakpoints component offset)))
3552   ;; At this point breakpoints may not hold the same list as
3553   ;; BREAKPOINT-DATA-BREAKPOINTS since invoking hooks may have allowed
3554   ;; a breakpoint deactivation. In fact, if all breakpoints were
3555   ;; deactivated then data is invalid since it was deleted and so the
3556   ;; correct one must be looked up if it is to be used. If there are
3557   ;; no more breakpoints active at this location, then the normal
3558   ;; instruction has been put back, and we do not need to
3559   ;; DO-DISPLACED-INST.
3560   (let ((data (breakpoint-data component offset nil)))
3561     (when (and data (breakpoint-data-breakpoints data))
3562       ;; The breakpoint is still active, so we need to execute the
3563       ;; displaced instruction and leave the breakpoint instruction
3564       ;; behind. The best way to do this is different on each machine,
3565       ;; so we just leave it up to the C code.
3566       (breakpoint-do-displaced-inst signal-context
3567                                     (breakpoint-data-instruction data))
3568       ; Under HPUX we can't sigreturn so bp-do-disp-i has to return.
3569       #!-(or hpux irix x86)
3570       (error "BREAKPOINT-DO-DISPLACED-INST returned?"))))
3571
3572 (defun invoke-breakpoint-hooks (breakpoints component offset)
3573   (let* ((debug-fun (debug-function-from-pc component offset))
3574          (frame (do ((f (top-frame) (frame-down f)))
3575                     ((eq debug-fun (frame-debug-function f)) f))))
3576     (dolist (bpt breakpoints)
3577       (funcall (breakpoint-hook-function bpt)
3578                frame
3579                ;; If this is an :UNKNOWN-RETURN-PARTNER, then pass the
3580                ;; hook function the original breakpoint, so that users
3581                ;; aren't forced to confront the fact that some
3582                ;; breakpoints really are two.
3583                (if (eq (breakpoint-kind bpt) :unknown-return-partner)
3584                    (breakpoint-unknown-return-partner bpt)
3585                    bpt)))))
3586
3587 (defun handle-function-end-breakpoint (offset component context)
3588   (/show0 "entering HANDLE-FUNCTION-END-BREAKPOINT")
3589   (let ((data (breakpoint-data component offset nil)))
3590     (unless data
3591       (error "unknown breakpoint in ~S at offset ~S"
3592               (debug-function-name (debug-function-from-pc component offset))
3593               offset))
3594     (let ((breakpoints (breakpoint-data-breakpoints data)))
3595       (when breakpoints
3596         (assert (eq (breakpoint-kind (car breakpoints)) :function-end))
3597         (handle-function-end-breakpoint-aux breakpoints data context)))))
3598
3599 ;;; Either HANDLE-BREAKPOINT calls this for :FUNCTION-END breakpoints
3600 ;;; [old C code] or HANDLE-FUNCTION-END-BREAKPOINT calls this directly
3601 ;;; [new C code].
3602 (defun handle-function-end-breakpoint-aux (breakpoints data signal-context)
3603   (/show0 "entering HANDLE-FUNCTION-END-BREAKPOINT-AUX")
3604   (delete-breakpoint-data data)
3605   (let* ((scp
3606           (locally
3607             (declare (optimize (inhibit-warnings 3)))
3608             (sb!alien:sap-alien signal-context (* os-context-t))))
3609          (frame (do ((cfp (sb!vm:context-register scp sb!vm::cfp-offset))
3610                      (f (top-frame) (frame-down f)))
3611                     ((= cfp (sap-int (frame-pointer f))) f)
3612                   (declare (type (unsigned-byte #.sb!vm:word-bits) cfp))))
3613          (component (breakpoint-data-component data))
3614          (cookie (gethash component *function-end-cookies*)))
3615     (remhash component *function-end-cookies*)
3616     (dolist (bpt breakpoints)
3617       (funcall (breakpoint-hook-function bpt)
3618                frame bpt
3619                (get-function-end-breakpoint-values scp)
3620                cookie))))
3621
3622 (defun get-function-end-breakpoint-values (scp)
3623   (let ((ocfp (int-sap (sb!vm:context-register
3624                         scp
3625                         #!-x86 sb!vm::ocfp-offset
3626                         #!+x86 sb!vm::ebx-offset)))
3627         (nargs (make-lisp-obj
3628                 (sb!vm:context-register scp sb!vm::nargs-offset)))
3629         (reg-arg-offsets '#.sb!vm::*register-arg-offsets*)
3630         (results nil))
3631     (without-gcing
3632      (dotimes (arg-num nargs)
3633        (push (if reg-arg-offsets
3634                  (make-lisp-obj
3635                   (sb!vm:context-register scp (pop reg-arg-offsets)))
3636                (stack-ref ocfp arg-num))
3637              results)))
3638     (nreverse results)))
3639 \f
3640 ;;;; MAKE-BOGUS-LRA (used for :FUNCTION-END breakpoints)
3641
3642 (defconstant
3643   bogus-lra-constants
3644   #!-x86 2 #!+x86 3)
3645 (defconstant
3646   known-return-p-slot
3647   (+ sb!vm:code-constants-offset #!-x86 1 #!+x86 2))
3648
3649 ;;; FIXME: This is also defined in debug-vm.lisp. Which definition
3650 ;;; takes precedence? (One definition uses ALLOCATE-CODE-OBJECT, and
3651 ;;; the other has been hacked for X86 GENCGC to use
3652 ;;; ALLOCATE-DYNAMIC-CODE-OBJECT..)
3653 (defun make-bogus-lra (real-lra &optional known-return-p)
3654   #!+sb-doc
3655   "Make a bogus LRA object that signals a breakpoint trap when returned to. If
3656    the breakpoint trap handler returns, REAL-LRA is returned to. Three values
3657    are returned: the bogus LRA object, the code component it is part of, and
3658    the PC offset for the trap instruction."
3659   (without-gcing
3660    (let* ((src-start (foreign-symbol-address "function_end_breakpoint_guts"))
3661           (src-end (foreign-symbol-address "function_end_breakpoint_end"))
3662           (trap-loc (foreign-symbol-address "function_end_breakpoint_trap"))
3663           (length (sap- src-end src-start))
3664           (code-object
3665            (%primitive
3666             #!-(and x86 gencgc) sb!c:allocate-code-object
3667             #!+(and x86 gencgc) sb!c::allocate-dynamic-code-object
3668             (1+ bogus-lra-constants)
3669             length))
3670           (dst-start (code-instructions code-object)))
3671      (declare (type system-area-pointer
3672                     src-start src-end dst-start trap-loc)
3673               (type index length))
3674      (setf (%code-debug-info code-object) :bogus-lra)
3675      (setf (code-header-ref code-object sb!vm:code-trace-table-offset-slot)
3676            length)
3677      #!-x86
3678      (setf (code-header-ref code-object real-lra-slot) real-lra)
3679      #!+x86
3680      (multiple-value-bind (offset code) (compute-lra-data-from-pc real-lra)
3681        (setf (code-header-ref code-object real-lra-slot) code)
3682        (setf (code-header-ref code-object (1+ real-lra-slot)) offset))
3683      (setf (code-header-ref code-object known-return-p-slot)
3684            known-return-p)
3685      (system-area-copy src-start 0 dst-start 0 (* length sb!vm:byte-bits))
3686      (sb!vm:sanctify-for-execution code-object)
3687      #!+x86
3688      (values dst-start code-object (sap- trap-loc src-start))
3689      #!-x86
3690      (let ((new-lra (make-lisp-obj (+ (sap-int dst-start)
3691                                       sb!vm:other-pointer-type))))
3692        (set-header-data
3693         new-lra
3694         (logandc2 (+ sb!vm:code-constants-offset bogus-lra-constants 1)
3695                   1))
3696        (sb!vm:sanctify-for-execution code-object)
3697        (values new-lra code-object (sap- trap-loc src-start))))))
3698 \f
3699 ;;;; miscellaneous
3700
3701 ;;; This appears here because it cannot go with the debug-function
3702 ;;; interface since DO-DEBUG-BLOCK-LOCATIONS isn't defined until after
3703 ;;; the debug-function routines.
3704
3705 (defun debug-function-start-location (debug-fun)
3706   #!+sb-doc
3707   "This returns a code-location before the body of a function and after all
3708    the arguments are in place. If this cannot determine that location due to
3709    a lack of debug information, it returns nil."
3710   (etypecase debug-fun
3711     (compiled-debug-function
3712      (code-location-from-pc debug-fun
3713                             (sb!c::compiled-debug-function-start-pc
3714                              (compiled-debug-function-compiler-debug-fun
3715                               debug-fun))
3716                             nil))
3717     (interpreted-debug-function
3718      ;; Return the first location if there are any, otherwise NIL.
3719      (handler-case (do-debug-function-blocks (block debug-fun nil)
3720                      (do-debug-block-locations (loc block nil)
3721                        (return-from debug-function-start-location loc)))
3722        (no-debug-blocks (condx)
3723          (declare (ignore condx))
3724          nil)))))
3725
3726 (defun print-code-locations (function)
3727   (let ((debug-fun (function-debug-function function)))
3728     (do-debug-function-blocks (block debug-fun)
3729       (do-debug-block-locations (loc block)
3730         (fill-in-code-location loc)
3731         (format t "~S code location at ~D"
3732                 (compiled-code-location-kind loc)
3733                 (compiled-code-location-pc loc))
3734         (sb!debug::print-code-location-source-form loc 0)
3735         (terpri)))))