1 ;;;; the implementation of the programmer's interface to writing
4 ;;;; This software is part of the SBCL system. See the README file for
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.
18 ;;; FIXME: There are an awful lot of package prefixes in this code.
19 ;;; Couldn't we have SB-DI use the SB-C and SB-VM packages?
23 ;;;; The interface to building debugging tools signals conditions that
24 ;;;; prevent it from adhering to its contract. These are
25 ;;;; serious-conditions because the program using the interface must
26 ;;;; handle them before it can correctly continue execution. These
27 ;;;; debugging conditions are not errors since it is no fault of the
28 ;;;; programmers that the conditions occur. The interface does not
29 ;;;; provide for programs to detect these situations other than
30 ;;;; calling a routine that detects them and signals a condition. For
31 ;;;; example, programmers call A which may fail to return successfully
32 ;;;; due to a lack of debug information, and there is no B the they
33 ;;;; could have called to realize A would fail. It is not an error to
34 ;;;; have called A, but it is an error for the program to then ignore
35 ;;;; the signal generated by A since it cannot continue without A's
36 ;;;; correctly returning a value or performing some operation.
38 ;;;; Use DEBUG-SIGNAL to signal these conditions.
40 (define-condition debug-condition (serious-condition)
44 "All debug-conditions inherit from this type. These are serious conditions
45 that must be handled, but they are not programmer errors."))
47 (define-condition no-debug-info (debug-condition)
50 (:documentation "There is absolutely no debugging information available.")
51 (:report (lambda (condition stream)
52 (declare (ignore condition))
54 (write-line "No debugging information available." stream))))
56 (define-condition no-debug-function-returns (debug-condition)
57 ((debug-function :reader no-debug-function-returns-debug-function
58 :initarg :debug-function))
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))))
67 "~&Cannot return values from ~:[frame~;~:*~S~] since ~
68 the debug information lacks details about returning ~
72 (define-condition no-debug-blocks (debug-condition)
73 ((debug-function :reader no-debug-blocks-debug-function
74 :initarg :debug-function))
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)))))
81 (define-condition no-debug-vars (debug-condition)
82 ((debug-function :reader no-debug-vars-debug-function
83 :initarg :debug-function))
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)))))
90 (define-condition lambda-list-unavailable (debug-condition)
91 ((debug-function :reader lambda-list-unavailable-debug-function
92 :initarg :debug-function))
95 "The debug-function has no lambda-list since argument DEBUG-VARs are
97 (:report (lambda (condition stream)
98 (format stream "~&~S has no lambda-list information available."
99 (lambda-list-unavailable-debug-function condition)))))
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)))))
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)))))
117 ;;;; errors and DEBUG-SIGNAL
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
124 ;;; While under development, this code also signals errors in code
125 ;;; branches that remain unimplemented.
127 (define-condition debug-error (error) ()
130 "All programmer errors from using the interface for building debugging
131 tools inherit from this type."))
133 (define-condition unhandled-condition (debug-error)
134 ((condition :reader unhandled-condition-condition :initarg :condition))
135 (:report (lambda (condition stream)
136 (format stream "~&unhandled DEBUG-CONDITION:~%~A"
137 (unhandled-condition-condition condition)))))
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)))))
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)))))
155 (define-condition invalid-control-stack-pointer (debug-error)
157 (:report (lambda (condition stream)
158 (declare (ignore condition))
160 (write-string "invalid control stack pointer" stream))))
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)
169 "~&Form was preprocessed for ~S,~% but called on ~S:~% ~S"
170 (frame-function-mismatch-code-location condition)
171 (frame-function-mismatch-frame condition)
172 (frame-function-mismatch-form condition)))))
174 ;;; This signals debug-conditions. If they go unhandled, then signal an
175 ;;; unhandled-condition error.
177 ;;; ??? Get SIGNAL in the right package!
178 (defmacro debug-signal (datum &rest arguments)
179 `(let ((condition (make-condition ,datum ,@arguments)))
181 (error 'unhandled-condition :condition condition)))
185 ;;;; Most of these structures model information stored in internal
186 ;;;; data structures created by the compiler. Whenever comments
187 ;;;; preface an object or type with "compiler", they refer to the
188 ;;;; internal compiler thing, not to the object or type with the same
189 ;;;; name in the "DI" package.
193 ;;; These exist for caching data stored in packed binary form in
194 ;;; compiler debug-functions. Debug-functions store these.
195 (defstruct (debug-var (:constructor nil))
196 ;; the name of the variable
197 (symbol (required-argument) :type symbol)
198 ;; a unique integer identification relative to other variables with the same
200 (id 0 :type sb!c::index)
201 ;; Does the variable always have a valid value?
202 (alive-p nil :type boolean))
203 (def!method print-object ((debug-var debug-var) stream)
204 (print-unreadable-object (debug-var stream :type t :identity t)
207 (debug-var-symbol debug-var)
208 (debug-var-id debug-var))))
211 (setf (fdocumentation 'debug-var-id 'function)
212 "Returns the integer that makes DEBUG-VAR's name and package unique
213 with respect to other DEBUG-VARs in the same function.")
215 (defstruct (compiled-debug-var
217 (:constructor make-compiled-debug-var
218 (symbol id alive-p sc-offset save-sc-offset)))
219 ;; Storage class and offset. (unexported).
220 (sc-offset nil :type sb!c::sc-offset)
221 ;; Storage class and offset when saved somewhere.
222 (save-sc-offset nil :type (or sb!c::sc-offset null)))
224 (defstruct (interpreted-debug-var
225 (:include debug-var (alive-p t))
226 (:constructor make-interpreted-debug-var (symbol ir1-var)))
227 ;; This is the IR1 structure that holds information about interpreted vars.
228 (ir1-var nil :type sb!c::lambda-var))
232 ;;; These represent call-frames on the stack.
233 (defstruct (frame (:constructor nil))
234 ;; the next frame up, or NIL when top frame
235 (up nil :type (or frame null))
236 ;; the previous frame down, or NIL when the bottom frame. Before
237 ;; computing the next frame down, this slot holds the frame pointer
238 ;; to the control stack for the given frame. This lets us get the
239 ;; next frame down and the return-pc for that frame.
240 (%down :unparsed :type (or frame (member nil :unparsed)))
241 ;; the debug-function for the function whose call this frame
243 (debug-function nil :type debug-function)
244 ;; the code-location to continue upon return to frame
245 (code-location nil :type code-location)
246 ;; an a-list of catch-tags to code-locations
247 (%catches :unparsed :type (or list (member :unparsed)))
248 ;; pointer to frame on control stack. (unexported) When this frame
249 ;; is an interpreted-frame, this pointer is an index into the
250 ;; interpreter's stack.
252 ;; This is the frame's number for prompt printing. Top is zero.
253 (number 0 :type index))
256 (setf (fdocumentation 'frame-up 'function)
257 "Returns the frame immediately above frame on the stack. When frame is
258 the top of the stack, this returns nil.")
261 (setf (fdocumentation 'frame-debug-function 'function)
262 "Returns the debug-function for the function whose call frame represents.")
265 (setf (fdocumentation 'frame-code-location 'function)
266 "Returns the code-location where the frame's debug-function will continue
267 running when program execution returns to this frame. If someone
268 interrupted this frame, the result could be an unknown code-location.")
270 (defstruct (compiled-frame
272 (:constructor make-compiled-frame
273 (pointer up debug-function code-location number
274 #!+gengc saved-state-chain
276 ;; This indicates whether someone interrupted the frame.
277 ;; (unexported). If escaped, this is a pointer to the state that was
278 ;; saved when we were interrupted. On the non-gengc system, this is
279 ;; a pointer to an os_context_t, i.e. the third argument to an
280 ;; SA_SIGACTION-style signal handler. On the gengc system, this is a
281 ;; state pointer from SAVED-STATE-CHAIN.
283 ;; a list of SAPs to saved states. Each time we unwind past an
284 ;; exception, we pop the next entry off this list. When we get to
285 ;; the end of the list, there is nothing else on the stack.
286 #!+gengc (saved-state-chain nil :type list))
287 (def!method print-object ((obj compiled-frame) str)
288 (print-unreadable-object (obj str :type t)
290 "~S~:[~;, interrupted~]"
291 (debug-function-name (frame-debug-function obj))
292 (compiled-frame-escaped obj))))
294 (defstruct (interpreted-frame
296 (:constructor make-interpreted-frame
297 (pointer up debug-function code-location number
298 real-frame closure)))
299 ;; This points to the compiled-frame for SB!EVAL:INTERNAL-APPLY-LOOP.
300 (real-frame nil :type compiled-frame)
301 ;; This is the closed over data used by the interpreter.
302 (closure nil :type simple-vector))
303 (def!method print-object ((obj interpreted-frame) str)
304 (print-unreadable-object (obj str :type t)
305 (prin1 (debug-function-name (frame-debug-function obj)) str)))
309 ;;; These exist for caching data stored in packed binary form in
310 ;;; compiler debug-functions. *COMPILED-DEBUG-FUNCTIONS* maps a
311 ;;; SB!C::DEBUG-FUNCTION to a DEBUG-FUNCTION. There should only be one
312 ;;; DEBUG-FUNCTION in existence for any function; that is, all
313 ;;; code-locations and other objects that reference DEBUG-FUNCTIONs
314 ;;; point to unique objects. This is due to the overhead in cached
316 (defstruct debug-function
317 ;; Some representation of the function arguments. See
318 ;; DEBUG-FUNCTION-LAMBDA-LIST.
319 ;; NOTE: must parse vars before parsing arg list stuff.
320 (%lambda-list :unparsed)
321 ;; Cached DEBUG-VARS information. (unexported).
322 ;; These are sorted by their name.
323 (%debug-vars :unparsed :type (or simple-vector null (member :unparsed)))
324 ;; Cached debug-block information. This is NIL when we have tried to
325 ;; parse the packed binary info, but none is available.
326 (blocks :unparsed :type (or simple-vector null (member :unparsed)))
327 ;; The actual function if available.
328 (%function :unparsed :type (or null function (member :unparsed))))
329 (def!method print-object ((obj debug-function) stream)
330 (print-unreadable-object (obj stream :type t)
331 (prin1 (debug-function-name obj) stream)))
333 (defstruct (compiled-debug-function
334 (:include debug-function)
335 (:constructor %make-compiled-debug-function
336 (compiler-debug-fun component)))
337 ;; Compiler's dumped debug-function information. (unexported).
338 (compiler-debug-fun nil :type sb!c::compiled-debug-function)
339 ;; Code object. (unexported).
341 ;; The :FUNCTION-START breakpoint (if any) used to facilitate
342 ;; function end breakpoints.
343 (end-starter nil :type (or null breakpoint)))
345 ;;; This maps SB!C::COMPILED-DEBUG-FUNCTIONs to
346 ;;; COMPILED-DEBUG-FUNCTIONs, so we can get at cached stuff and not
347 ;;; duplicate COMPILED-DEBUG-FUNCTION structures.
348 (defvar *compiled-debug-functions* (make-hash-table :test 'eq))
350 ;;; Make a COMPILED-DEBUG-FUNCTION for a SB!C::COMPILER-DEBUG-FUNCTION
351 ;;; and its component. This maps the latter to the former in
352 ;;; *COMPILED-DEBUG-FUNCTIONS*. If there already is a
353 ;;; COMPILED-DEBUG-FUNCTION, then this returns it from
354 ;;; *COMPILED-DEBUG-FUNCTIONS*.
355 (defun make-compiled-debug-function (compiler-debug-fun component)
356 (or (gethash compiler-debug-fun *compiled-debug-functions*)
357 (setf (gethash compiler-debug-fun *compiled-debug-functions*)
358 (%make-compiled-debug-function compiler-debug-fun component))))
360 (defstruct (interpreted-debug-function
361 (:include debug-function)
362 (:constructor %make-interpreted-debug-function (ir1-lambda)))
363 ;; This is the IR1 lambda that this debug-function represents.
364 (ir1-lambda nil :type sb!c::clambda))
366 (defstruct (bogus-debug-function
367 (:include debug-function)
368 (:constructor make-bogus-debug-function
369 (%name &aux (%lambda-list nil) (%debug-vars nil)
370 (blocks nil) (%function nil))))
373 (defvar *ir1-lambda-debug-function* (make-hash-table :test 'eq))
375 (defun make-interpreted-debug-function (ir1-lambda)
376 (let ((home-lambda (sb!c::lambda-home ir1-lambda)))
377 (or (gethash home-lambda *ir1-lambda-debug-function*)
378 (setf (gethash home-lambda *ir1-lambda-debug-function*)
379 (%make-interpreted-debug-function home-lambda)))))
383 ;;; These exist for caching data stored in packed binary form in compiler
385 (defstruct (debug-block (:constructor nil))
386 ;; Code-locations where execution continues after this block.
387 (successors nil :type list)
388 ;; This indicates whether the block is a special glob of code shared by
389 ;; various functions and tucked away elsewhere in a component. This kind of
390 ;; block has no start code-location. In an interpreted-debug-block, this is
391 ;; always nil. This slot is in all debug-blocks since it is an exported
393 (elsewhere-p nil :type boolean))
394 (def!method print-object ((obj debug-block) str)
395 (print-unreadable-object (obj str :type t)
396 (prin1 (debug-block-function-name obj) str)))
399 (setf (fdocumentation 'debug-block-successors 'function)
400 "Returns the list of possible code-locations where execution may continue
401 when the basic-block represented by debug-block completes its execution.")
404 (setf (fdocumentation 'debug-block-elsewhere-p 'function)
405 "Returns whether debug-block represents elsewhere code.")
407 (defstruct (compiled-debug-block (:include debug-block)
409 make-compiled-debug-block
410 (code-locations successors elsewhere-p)))
411 ;; Code-location information for the block.
412 (code-locations nil :type simple-vector))
414 (defstruct (interpreted-debug-block (:include debug-block
416 (:constructor %make-interpreted-debug-block
418 ;; This is the IR1 block this debug-block represents.
419 (ir1-block nil :type sb!c::cblock)
420 ;; Code-location information for the block.
421 (locations :unparsed :type (or (member :unparsed) simple-vector)))
423 (defvar *ir1-block-debug-block* (make-hash-table :test 'eq))
425 ;;; Make a DEBUG-BLOCK for the interpreter's IR1-BLOCK. If we have it
426 ;;; in the cache, return it. If we need to make it, then first make
427 ;;; DEBUG-BLOCKs for all the IR1-BLOCKs in IR1-BLOCK's home lambda;
428 ;;; this makes sure all the successors of IR1-BLOCK have DEBUG-BLOCKs.
429 ;;; We need this to fill in the resulting DEBUG-BLOCK's successors
430 ;;; list with DEBUG-BLOCKs, not IR1-BLOCKs. After making all the
431 ;;; possible DEBUG-BLOCKs we'll need to reference, go back over the
432 ;;; list of new DEBUG-BLOCKs and fill in their successor slots with
433 ;;; lists of DEBUG-BLOCKs. Then look up our argument IR1-BLOCK to find
434 ;;; its DEBUG-BLOCK since we know we have it now.
435 (defun make-interpreted-debug-block (ir1-block)
436 (check-type ir1-block sb!c::cblock)
437 (let ((res (gethash ir1-block *ir1-block-debug-block*)))
439 (let ((lambda (sb!c::block-home-lambda ir1-block)))
440 (sb!c::do-blocks (block (sb!c::block-component ir1-block))
441 (when (eq lambda (sb!c::block-home-lambda block))
442 (push (setf (gethash block *ir1-block-debug-block*)
443 (%make-interpreted-debug-block block))
446 (let* ((successors nil)
447 (cblock (interpreted-debug-block-ir1-block block))
448 (succ (sb!c::block-succ cblock))
452 (sb!c::component-tail
453 (sb!c::block-component cblock))))
456 (dolist (sblock valid-succ)
457 (let ((dblock (gethash sblock *ir1-block-debug-block*)))
459 (push dblock successors))))
460 (setf (debug-block-successors block) (nreverse successors))))
461 (gethash ir1-block *ir1-block-debug-block*)))))
465 ;;; This is an internal structure that manages information about a
466 ;;; breakpoint locations. See *COMPONENT-BREAKPOINT-OFFSETS*.
467 (defstruct (breakpoint-data (:constructor make-breakpoint-data
469 ;; This is the component in which the breakpoint lies.
471 ;; This is the byte offset into the component.
472 (offset nil :type sb!c::index)
473 ;; The original instruction replaced by the breakpoint.
474 (instruction nil :type (or null (unsigned-byte 32)))
475 ;; A list of user breakpoints at this location.
476 (breakpoints nil :type list))
477 (def!method print-object ((obj breakpoint-data) str)
478 (print-unreadable-object (obj str :type t)
479 (format str "~S at ~S"
481 (debug-function-from-pc (breakpoint-data-component obj)
482 (breakpoint-data-offset obj)))
483 (breakpoint-data-offset obj))))
485 (defstruct (breakpoint (:constructor %make-breakpoint
486 (hook-function what kind %info)))
487 ;; This is the function invoked when execution encounters the
488 ;; breakpoint. It takes a frame, the breakpoint, and optionally a
489 ;; list of values. Values are supplied for :FUNCTION-END breakpoints
490 ;; as values to return for the function containing the breakpoint.
491 ;; :FUNCTION-END breakpoint hook-functions also take a cookie
492 ;; argument. See COOKIE-FUN slot.
493 (hook-function nil :type function)
494 ;; CODE-LOCATION or DEBUG-FUNCTION
495 (what nil :type (or code-location debug-function))
496 ;; :CODE-LOCATION, :FUNCTION-START, or :FUNCTION-END for that kind
497 ;; of breakpoint. :UNKNOWN-RETURN-PARTNER if this is the partner of
498 ;; a :code-location breakpoint at an :UNKNOWN-RETURN code-location.
499 (kind nil :type (member :code-location :function-start :function-end
500 :unknown-return-partner))
501 ;; Status helps the user and the implementation.
502 (status :inactive :type (member :active :inactive :deleted))
503 ;; This is a backpointer to a breakpoint-data.
504 (internal-data nil :type (or null breakpoint-data))
505 ;; With code-locations whose type is :UNKNOWN-RETURN, there are
506 ;; really two breakpoints: one at the multiple-value entry point,
507 ;; and one at the single-value entry point. This slot holds the
508 ;; breakpoint for the other one, or NIL if this isn't at an
509 ;; :UNKNOWN-RETURN code location.
510 (unknown-return-partner nil :type (or null breakpoint))
511 ;; :FUNCTION-END breakpoints use a breakpoint at the :FUNCTION-START
512 ;; to establish the end breakpoint upon function entry. We do this
513 ;; by frobbing the LRA to jump to a special piece of code that
514 ;; breaks and provides the return values for the returnee. This slot
515 ;; points to the start breakpoint, so we can activate, deactivate,
517 (start-helper nil :type (or null breakpoint))
518 ;; This is a hook users supply to get a dynamically unique cookie
519 ;; for identifying :FUNCTION-END breakpoint executions. That is, if
520 ;; there is one :FUNCTION-END breakpoint, but there may be multiple
521 ;; pending calls of its function on the stack. This function takes
522 ;; the cookie, and the hook-function takes the cookie too.
523 (cookie-fun nil :type (or null function))
524 ;; This slot users can set with whatever information they find useful.
526 (def!method print-object ((obj breakpoint) str)
527 (let ((what (breakpoint-what obj)))
528 (print-unreadable-object (obj str :type t)
533 (debug-function (debug-function-name what)))
536 (debug-function (breakpoint-kind obj)))))))
539 (setf (fdocumentation 'breakpoint-hook-function 'function)
540 "Returns the breakpoint's function the system calls when execution encounters
541 the breakpoint, and it is active. This is SETF'able.")
544 (setf (fdocumentation 'breakpoint-what 'function)
545 "Returns the breakpoint's what specification.")
548 (setf (fdocumentation 'breakpoint-kind 'function)
549 "Returns the breakpoint's kind specification.")
553 (defstruct (code-location (:constructor nil))
554 ;; This is the debug-function containing code-location.
555 (debug-function nil :type debug-function)
556 ;; This is initially :UNSURE. Upon first trying to access an
557 ;; :unparsed slot, if the data is unavailable, then this becomes t,
558 ;; and the code-location is unknown. If the data is available, this
559 ;; becomes nil, a known location. We can't use a separate type
560 ;; code-location for this since we must return code-locations before
561 ;; we can tell whether they're known or unknown. For example, when
562 ;; parsing the stack, we don't want to unpack all the variables and
563 ;; blocks just to make frames.
564 (%unknown-p :unsure :type (member t nil :unsure))
565 ;; This is the debug-block containing code-location. Possibly toss
566 ;; this out and just find it in the blocks cache in debug-function.
567 (%debug-block :unparsed :type (or debug-block (member :unparsed)))
568 ;; This is the number of forms processed by the compiler or loader
569 ;; before the top-level form containing this code-location.
570 (%tlf-offset :unparsed :type (or sb!c::index (member :unparsed)))
571 ;; This is the depth-first number of the node that begins
572 ;; code-location within its top-level form.
573 (%form-number :unparsed :type (or sb!c::index (member :unparsed))))
574 (def!method print-object ((obj code-location) str)
575 (print-unreadable-object (obj str :type t)
576 (prin1 (debug-function-name (code-location-debug-function obj))
580 (setf (fdocumentation 'code-location-debug-function 'function)
581 "Returns the debug-function representing information about the function
582 corresponding to the code-location.")
584 (defstruct (compiled-code-location
585 (:include code-location)
586 (:constructor make-known-code-location
587 (pc debug-function %tlf-offset %form-number
588 %live-set kind &aux (%unknown-p nil)))
589 (:constructor make-compiled-code-location (pc debug-function)))
590 ;; This is an index into debug-function's component slot.
591 (pc nil :type sb!c::index)
592 ;; This is a bit-vector indexed by a variable's position in
593 ;; DEBUG-FUNCTION-DEBUG-VARS indicating whether the variable has a
594 ;; valid value at this code-location. (unexported).
595 (%live-set :unparsed :type (or simple-bit-vector (member :unparsed)))
596 ;; (unexported) To see SB!C::LOCATION-KIND, do
597 ;; (SB!KERNEL:TYPE-EXPAND 'SB!C::LOCATION-KIND).
598 (kind :unparsed :type (or (member :unparsed) sb!c::location-kind)))
600 (defstruct (interpreted-code-location
601 (:include code-location
603 (:constructor make-interpreted-code-location
604 (ir1-node debug-function)))
605 ;; This is an index into debug-function's component slot.
606 (ir1-node nil :type sb!c::node))
610 #!-sb-fluid (declaim (inline debug-source-root-number))
611 (defun debug-source-root-number (debug-source)
613 "Returns the number of top-level forms processed by the compiler before
614 compiling this source. If this source is uncompiled, this is zero. This
615 may be zero even if the source is compiled since the first form in the first
616 file compiled in one compilation, for example, must have a root number of
617 zero -- the compiler saw no other top-level forms before it."
618 (sb!c::debug-source-source-root debug-source))
621 (setf (fdocumentation 'sb!c::debug-source-from 'function)
622 "Returns an indication of the type of source. The following are the possible
624 :file from a file (obtained by COMPILE-FILE if compiled).
625 :lisp from Lisp (obtained by COMPILE if compiled).")
628 (setf (fdocumentation 'sb!c::debug-source-name 'function)
629 "Returns the actual source in some sense represented by debug-source, which
630 is related to DEBUG-SOURCE-FROM:
631 :file the pathname of the file.
632 :lisp a lambda-expression.")
635 (setf (fdocumentation 'sb!c::debug-source-created 'function)
636 "Returns the universal time someone created the source. This may be nil if
640 (setf (fdocumentation 'sb!c::debug-source-compiled 'function)
641 "Returns the time someone compiled the source. This is nil if the source
645 (setf (fdocumentation 'sb!c::debug-source-start-positions 'function)
646 "This function returns the file position of each top-level form as an array
647 if debug-source is from a :file. If DEBUG-SOURCE-FROM is :lisp,
651 (setf (fdocumentation 'sb!c::debug-source-p 'function)
652 "Returns whether object is a debug-source.")
656 ;;; This is used in FIND-ESCAPE-FRAME and with the bogus components
657 ;;; and LRAs used for :function-end breakpoints. When a components
658 ;;; debug-info slot is :bogus-lra, then the real-lra-slot contains the
659 ;;; real component to continue executing, as opposed to the bogus
660 ;;; component which appeared in some frame's LRA location.
661 (defconstant real-lra-slot sb!vm:code-constants-offset)
663 ;;; These are magically converted by the compiler.
664 (defun current-sp () (current-sp))
665 (defun current-fp () (current-fp))
666 (defun stack-ref (s n) (stack-ref s n))
667 (defun %set-stack-ref (s n value) (%set-stack-ref s n value))
668 (defun function-code-header (fun) (function-code-header fun))
669 #!-gengc (defun lra-code-header (lra) (lra-code-header lra))
670 (defun make-lisp-obj (value) (make-lisp-obj value))
671 (defun get-lisp-obj-address (thing) (get-lisp-obj-address thing))
672 (defun function-word-offset (fun) (function-word-offset fun))
674 #!-sb-fluid (declaim (inline cstack-pointer-valid-p))
675 (defun cstack-pointer-valid-p (x)
676 (declare (type system-area-pointer x))
678 (and (sap< x (current-sp))
679 (sap<= #!-gengc (sb!alien:alien-sap
680 (sb!alien:extern-alien "control_stack" (* t)))
681 #!+gengc (mutator-control-stack-base)
683 (zerop (logand (sap-int x) #b11)))
684 #!+x86 ;; stack grows to low address values
685 (and (sap>= x (current-sp))
686 (sap> (sb!alien:alien-sap (sb!alien:extern-alien "control_stack_end"
689 (zerop (logand (sap-int x) #b11))))
692 (sb!alien:def-alien-routine component-ptr-from-pc (system-area-pointer)
693 (pc system-area-pointer))
696 (defun component-from-component-ptr (component-ptr)
697 (declare (type system-area-pointer component-ptr))
698 (make-lisp-obj (logior (sap-int component-ptr)
699 sb!vm:other-pointer-type)))
706 (defun compute-lra-data-from-pc (pc)
707 (declare (type system-area-pointer pc))
708 (let ((component-ptr (component-ptr-from-pc pc)))
709 (unless (sap= component-ptr (int-sap #x0))
710 (let* ((code (component-from-component-ptr component-ptr))
711 (code-header-len (* (get-header-data code) sb!vm:word-bytes))
712 (pc-offset (- (sap-int pc)
713 (- (get-lisp-obj-address code)
714 sb!vm:other-pointer-type)
716 ; (format t "c-lra-fpc ~A ~A ~A~%" pc code pc-offset)
717 (values pc-offset code)))))
719 (defconstant sb!vm::nargs-offset #.sb!vm::ecx-offset)
721 ;;; Check for a valid return address - it could be any valid C/Lisp
724 ;;; XXX Could be a little smarter.
725 #!-sb-fluid (declaim (inline ra-pointer-valid-p))
726 (defun ra-pointer-valid-p (ra)
727 (declare (type system-area-pointer ra))
729 ;; Not the first page which is unmapped.
730 (>= (sap-int ra) 4096)
731 ;; Not a Lisp stack pointer.
732 (or (sap< ra (current-sp))
733 (sap>= ra (sb!alien:alien-sap
734 (sb!alien:extern-alien "control_stack_end" (* t)))))))
736 ;;; Try to find a valid previous stack. This is complex on the x86 as
737 ;;; it can jump between C and Lisp frames. To help find a valid frame
738 ;;; it searches backwards.
740 ;;; XXX Should probably check whether it has reached the bottom of the
743 ;;; XXX Should handle interrupted frames, both Lisp and C. At present it
744 ;;; manages to find a fp trail, see linux hack below.
745 (defun x86-call-context (fp &key (depth 8))
746 (declare (type system-area-pointer fp)
748 ;;(format t "*CC ~S ~S~%" fp depth)
750 ((not (cstack-pointer-valid-p fp))
751 #+nil (format t "debug invalid fp ~S~%" fp)
754 ;; Check the two possible frame pointers.
755 (let ((lisp-ocfp (sap-ref-sap fp (- (* (1+ sb!vm::ocfp-save-offset) 4))))
756 (lisp-ra (sap-ref-sap fp (- (* (1+ sb!vm::return-pc-save-offset)
758 (c-ocfp (sap-ref-sap fp (* 0 sb!vm:word-bytes)))
759 (c-ra (sap-ref-sap fp (* 1 sb!vm:word-bytes))))
760 (cond ((and (sap> lisp-ocfp fp) (cstack-pointer-valid-p lisp-ocfp)
761 (ra-pointer-valid-p lisp-ra)
762 (sap> c-ocfp fp) (cstack-pointer-valid-p c-ocfp)
763 (ra-pointer-valid-p c-ra))
765 "*C Both valid ~S ~S ~S ~S~%"
766 lisp-ocfp lisp-ra c-ocfp c-ra)
767 ;; Look forward another step to check their validity.
768 (let ((lisp-path-fp (x86-call-context lisp-ocfp
770 (c-path-fp (x86-call-context c-ocfp :depth (- depth 1))))
771 (cond ((and lisp-path-fp c-path-fp)
772 ;; Both still seem valid - choose the smallest.
773 #+nil (format t "debug: both still valid ~S ~S ~S ~S~%"
774 lisp-ocfp lisp-ra c-ocfp c-ra)
775 (if (sap< lisp-ocfp c-ocfp)
776 (values lisp-ra lisp-ocfp)
777 (values c-ra c-ocfp)))
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))
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))
787 ;; Neither seems right?
788 #+nil (format t "debug: no valid2 fp found ~S ~S~%"
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))
802 #+nil (format t "debug: no valid fp found ~S ~S~%"
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)))
816 "Returns the top frame of the control stack as it was before calling this
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)
825 (defun flush-frames-above (frame)
827 "Flush all of the frames above FRAME, and renumber all the frames below
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)))
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)
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)
847 (compiled-debug-function
848 (let ((c-d-f (compiled-debug-function-compiler-debug-fun
850 (possibly-an-interpreted-frame
851 (compute-calling-frame
854 real sb!vm::ocfp-save-offset
855 (sb!c::compiled-debug-function-old-fp c-d-f)))
858 real sb!vm::lra-save-offset
859 (sb!c::compiled-debug-function-return-pc c-d-f))
863 real sb!vm::ra-save-offset
864 (sb!c::compiled-debug-function-return-pc c-d-f)))
867 (bogus-debug-function
868 (let ((fp (frame-pointer real)))
869 (when (cstack-pointer-valid-p fp)
871 (multiple-value-bind (ra ofp) (x86-call-context fp)
872 (compute-calling-frame ofp ra frame))
874 (compute-calling-frame
876 (sap-ref-sap fp (* sb!vm::ocfp-save-offset
880 (sap-ref-32 fp (* sb!vm::ocfp-save-offset
884 (stack-ref fp sb!vm::lra-save-offset)
886 (sap-ref-sap fp (* sb!vm::ra-save-offset
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.
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)))
901 (sub-access-debug-var-slot pointer loc escaped)
902 (stack-ref pointer stack-slot))))
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)))
910 (sub-access-debug-var-slot pointer loc escaped)
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))))))))
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)))
924 (sub-set-debug-var-slot pointer loc value escaped)
925 (setf (stack-ref pointer stack-slot) value))))
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)))
934 (sub-set-debug-var-slot pointer loc value escaped)
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))))))
941 (defvar *debugging-interpreter* nil
943 "When set, the debugger foregoes making interpreted-frames, so you can
944 debug the functions that manifest the interpreter.")
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)
953 (not (eq (debug-function-name (frame-debug-function frame))
954 'sb!eval::internal-apply-loop))
955 *debugging-interpreter*
956 (compiled-frame-escaped 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)
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
977 (make-interpreted-frame
978 (debug-var-value ptr-var frame)
981 (make-interpreted-code-location node d-fun)
984 (debug-var-value closure-var frame)))
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.
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.
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.
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)
1007 (multiple-value-bind (word-offset code)
1009 (let ((fp (frame-pointer up-frame)))
1011 (stack-ref fp (1+ sb!vm::lra-save-offset))))
1012 (values (get-header-data lra)
1013 (lra-code-header lra)))
1016 (* (1+ (- word-offset (get-header-data code)))
1019 (values :foreign-function
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"))
1032 (make-bogus-debug-function
1033 "foreign function call land"))
1035 (make-bogus-debug-function
1036 "bogus stack frame"))
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
1042 (if up-frame (1+ (frame-number up-frame)) 0)
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)
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)
1066 (multiple-value-setq (pc-offset code)
1067 (compute-lra-data-from-pc ra))
1068 ; (format t "ccf4 ~S ~S~%" code pc-offset)
1070 (setf code :foreign-function
1074 (let ((d-fun (case code
1075 (:undefined-function
1076 (make-bogus-debug-function
1077 "undefined function"))
1079 (make-bogus-debug-function
1080 "foreign function call land"))
1082 (make-bogus-debug-function
1083 "bogus stack frame"))
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
1089 (if up-frame (1+ (frame-number up-frame)) 0)
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).
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"))
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)
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))
1117 (let* ((component-ptr (component-ptr-from-pc
1118 (sb!vm:context-pc context)))
1119 (code (if (sap= component-ptr (int-sap #x0))
1120 nil ; FIXME: UNLESS might be clearer than IF.
1121 (component-from-component-ptr component-ptr))))
1123 (return (values code 0 context)))
1124 (let* ((code-header-len (* (get-header-data code)
1127 (- (sap-int (sb!vm:context-pc context))
1128 (- (get-lisp-obj-address code)
1129 sb!vm:other-pointer-type)
1131 (unless (<= 0 pc-offset
1132 (* (code-header-ref code sb!vm:code-code-size-slot)
1134 ;; We were in an assembly routine. Therefore, use the LRA as
1136 (format t "** pc-offset ~S not in code obj ~S?~%"
1139 (values code pc-offset context))))))))))
1141 ;;; Find the code object corresponding to the object represented by
1142 ;;; bits and return it. We assume bogus functions correspond to the
1143 ;;; undefined-function.
1145 (defun code-object-from-bits (bits)
1146 (declare (type (unsigned-byte 32) bits))
1147 (let ((object (make-lisp-obj bits)))
1148 (if (functionp object)
1149 (or (function-code-header object)
1150 :undefined-function)
1151 (let ((lowtag (get-lowtag object)))
1152 (if (= lowtag sb!vm:other-pointer-type)
1153 (let ((type (get-type object)))
1154 (cond ((= type sb!vm:code-header-type)
1156 ((= type sb!vm:return-pc-header-type)
1157 (lra-code-header object))
1161 ;;; SB!KERNEL:*SAVED-STATE-CHAIN* -- maintained by the C code as a
1162 ;;; list of SAPs, each SAP pointing to a saved exception state.
1164 (declaim (special *saved-state-chain*))
1167 ;;; (DEFUN LOOKUP-TRACE-TABLE-ENTRY (COMPONENT PC) ..)
1168 ;;; for this case, but it hasn't been maintained in SBCL.
1170 (eval-when (:compile-toplevel :load-toplevel :execute)
1171 (error "hopelessly stale"))
1174 ;;; (DEFUN EXTRACT-INFO-FROM-STATE (STATE) ..)
1175 ;;; for this case, but it hasn't been maintained in SBCL.
1177 (eval-when (:compile-toplevel :load-toplevel :execute)
1178 (error "hopelessly stale"))
1181 ;;; (DEFUN COMPUTE-CALLING-FRAME (OCFP RA UP-FRAME) ..)
1182 ;;; for this case, but it hasn't been maintained in SBCL.
1184 (eval-when (:compile-toplevel :load-toplevel :execute)
1185 (error "hopelessly stale"))
1187 ;;;; frame utilities
1189 ;;; This returns a COMPILED-DEBUG-FUNCTION for code and pc. We fetch
1190 ;;; the SB!C::DEBUG-INFO and run down its function-map to get a
1191 ;;; SB!C::COMPILED-DEBUG-FUNCTION from the pc. The result only needs
1192 ;;; to reference the component, for function constants, and the
1193 ;;; SB!C::COMPILED-DEBUG-FUNCTION.
1194 (defun debug-function-from-pc (component pc)
1195 (let ((info (%code-debug-info component)))
1198 (debug-signal 'no-debug-info))
1199 ((eq info :bogus-lra)
1200 (make-bogus-debug-function "function end breakpoint"))
1202 (let* ((function-map (get-debug-info-function-map info))
1203 (len (length function-map)))
1204 (declare (simple-vector function-map))
1206 (make-compiled-debug-function (svref function-map 0) component)
1209 (>= pc (sb!c::compiled-debug-function-elsewhere-pc
1210 (svref function-map 0)))))
1211 ;; FIXME: I don't think SB!C is the home package of INDEX.
1212 (declare (type sb!c::index i))
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))
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)
1232 (let ((data (breakpoint-data
1233 (compiled-debug-function-component debug-fun)
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)
1240 (make-compiled-code-location pc debug-fun)))
1242 (defun frame-catches (frame)
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."
1248 #!-gengc (descriptor-sap sb!impl::*current-catch-block*)
1249 #!+gengc (mutator-current-catch-block))
1251 (fp (frame-pointer (frame-real-frame frame))))
1253 (when (zerop (sap-int catch)) (return (nreverse res)))
1257 (* sb!vm:catch-block-current-cont-slot
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))
1268 catch (* sb!vm:catch-block-entry-pc-slot
1272 (stack-ref catch sb!vm:catch-block-current-code-slot))
1274 (component (component-from-component-ptr
1275 (component-ptr-from-pc ra)))
1278 (* (- (1+ (get-header-data lra))
1279 (get-header-data component))
1283 (get-lisp-obj-address component)
1284 (get-header-data component))
1285 sb!vm:other-pointer-type)
1288 (- (get-lisp-obj-address component)
1289 sb!vm:other-pointer-type)
1290 (* (get-header-data component) sb!vm:word-bytes))))
1292 (stack-ref catch sb!vm:catch-block-tag-slot)
1295 (sap-ref-32 catch (* sb!vm:catch-block-tag-slot
1297 (make-compiled-code-location
1298 offset (frame-debug-function frame)))
1303 (* sb!vm:catch-block-previous-catch-slot
1308 (* sb!vm:catch-block-previous-catch-slot
1309 sb!vm:word-bytes)))))))
1311 ;;; If an interpreted frame, return the real frame, otherwise frame.
1312 (defun frame-real-frame (frame)
1314 (compiled-frame frame)
1315 (interpreted-frame (interpreted-frame-real-frame frame))))
1317 ;;;; operations on DEBUG-FUNCTIONs
1319 (defmacro do-debug-function-blocks ((block-var debug-function &optional result)
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))
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)))
1335 (defmacro do-debug-function-variables ((var debug-function &optional result)
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))
1345 `(let ((,vars (debug-function-debug-vars ,debug-function)))
1346 (declare (type (or null simple-vector) ,vars))
1348 (dotimes (,i (length ,vars) ,result)
1349 (let ((,var (svref ,vars ,i)))
1353 (defun debug-function-function (debug-function)
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
1364 (compiled-debug-function-component debug-function))
1366 (sb!c::compiled-debug-function-start-pc
1367 (compiled-debug-function-compiler-debug-fun
1369 (do ((entry (%code-entry-points component)
1370 (%function-next entry)))
1373 (sb!c::compiled-debug-function-start-pc
1374 (compiled-debug-function-compiler-debug-fun
1375 (function-debug-function entry))))
1377 (interpreted-debug-function
1378 (sb!c::lambda-eval-info-function
1380 (interpreted-debug-function-ir1-lambda debug-function))))
1381 (bogus-debug-function nil)))
1384 (defun debug-function-name (debug-function)
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
1395 (bogus-debug-function
1396 (bogus-debug-function-%name debug-function))))
1398 (defun function-debug-function (fun)
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))))
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))
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)))))
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.
1431 (debug-function-from-pc component
1432 (* (- (function-word-offset fun)
1433 (get-header-data component))
1434 sb!vm:word-bytes)))))))
1436 (defun debug-function-kind (debug-function)
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
1449 (bogus-debug-function
1452 (defun debug-var-info-available (debug-function)
1454 "Is there any variable information for DEBUG-FUNCTION?"
1455 (not (not (debug-function-debug-vars debug-function))))
1457 (defun debug-function-symbol-variables (debug-function symbol)
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)
1470 (let ((p (debug-var-package-name var)))
1471 (or (not (stringp p))
1472 (string/= p package))))
1474 (stringp (debug-var-package-name var))))
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))
1486 (let* ((len (length variables))
1487 (prefix-len (length name-prefix-string))
1488 (pos (find-variable name-prefix-string variables len))
1491 ;; Find names from pos to variable's len that contain prefix.
1492 (do ((i pos (1+ i)))
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)
1504 (setq res (nreverse res)))
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))
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)))))
1522 (defun debug-function-lambda-list (debug-function)
1524 "Returns a list representing the lambda-list for debug-function. The list
1525 has the following structure:
1526 (required-var1 required-var2
1528 (:optional var3 suppliedp-var4)
1531 (:rest var6) (:rest var7)
1533 (:keyword keyword-symbol var8 suppliedp-var9)
1534 (:keyword keyword-symbol var10)
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
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
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))
1563 (if (eq lambda-list :unparsed)
1564 (flet ((frob (v debug-vars)
1565 (if (sb!c::lambda-var-refs v)
1567 :key #'interpreted-debug-var-ir1-var)
1569 (let ((xep-args (sb!c::lambda-optional-dispatch ir1-lambda)))
1571 (eq (sb!c::optional-dispatch-main-entry xep-args)
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)))
1579 (case (sb!c::arg-info-kind info)
1581 (push (frob final-arg debug-vars) res))
1583 (push (list :keyword
1584 (sb!c::arg-info-keyword info)
1585 (frob final-arg debug-vars))
1588 (push (list :rest (frob final-arg debug-vars))
1591 (push (list :optional
1592 (frob final-arg debug-vars))
1594 (when (sb!c::arg-info-supplied-p info)
1597 (list (frob (pop final-args) debug-vars)))))
1599 (push (frob final-arg debug-vars) res)))))
1600 (setf (debug-function-%lambda-list debug-function)
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)
1606 (push (frob v debug-vars) res)))))
1607 ;; Everything's unparsed and cached, so return it.
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)
1619 (debug-signal 'lambda-list-unavailable
1620 :debug-function debug-function))))
1622 ((bogus-debug-function-p debug-function)
1624 ((sb!c::compiled-debug-function-arguments
1625 (compiled-debug-function-compiler-debug-fun
1627 ;; If the packed information is there (whether empty or not) as
1628 ;; opposed to being nil, then returned our cached value (nil).
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)))))
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
1650 (values (coerce (debug-function-debug-vars debug-function) 'list)
1653 (let ((vars (debug-function-debug-vars debug-function))
1658 (declare (type (or null simple-vector) vars))
1660 (when (>= i len) (return))
1661 (let ((ele (aref args i)))
1666 ;; Deleted required arg at beginning of args array.
1667 (push :deleted res))
1668 (sb!c::optional-args
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.
1676 (list (compiled-debug-function-lambda-list-var
1677 args (incf i) vars))))
1680 (compiled-debug-function-lambda-list-var
1681 args (incf i) vars))
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.
1690 (push (list :keyword
1692 (compiled-debug-function-lambda-list-var
1693 args (incf i) vars))
1696 ;; We saw an optional marker, so the following
1697 ;; non-symbols are indexes indicating optional
1699 (push (list :optional (svref vars ele)) res))
1701 ;; Required arg at beginning of args array.
1702 (push (svref vars ele) res))))
1704 (values (nreverse res) t))))))
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")))))
1715 (defun compiled-debug-function-debug-info (debug-fun)
1716 (%code-debug-info (compiled-debug-function-component debug-fun)))
1718 ;;;; unpacking variable and basic block data
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.
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.
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.
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
1740 (eval-when (:compile-toplevel :execute)
1741 (sb!xc:defmacro with-parsing-buffer ((buffer-var &optional other-var)
1743 (let ((len (gensym))
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)
1758 (fill *parsing-buffer* nil)
1759 ,@(if other-var `((fill *other-parsing-buffer* nil))))))
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))
1777 (debug-signal 'no-debug-blocks
1778 :debug-function debug-function)))))
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))))
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
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
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)
1806 (len (length blocks))
1809 (when (>= i len) (return))
1810 (let ((succ-and-flags (aref+ blocks i))
1812 (declare (type (unsigned-byte 8) succ-and-flags)
1814 (dotimes (k (ldb sb!c::compiled-debug-block-nsucc-byte
1816 (push (sb!c::read-var-integer blocks i) successors))
1818 (dotimes (k (sb!c::read-var-integer blocks i)
1819 (result locations-buffer))
1820 (let ((kind (svref sb!c::compiled-code-location-kinds
1823 (sb!c::read-var-integer blocks i)))
1824 (tlf-offset (or tlf-number
1825 (sb!c::read-var-integer blocks
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)
1834 (setf last-pc pc))))
1835 (block (make-compiled-debug-block
1836 locations successors
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))
1844 (let ((res (result blocks-buffer)))
1845 (declare (simple-vector res))
1846 (dotimes (i (length res))
1847 (let* ((block (svref res i))
1849 (dolist (ele (debug-block-successors block))
1850 (push (svref res ele) succs))
1851 (setf (debug-block-successors block) succs)))
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
1861 (when (eq ir1-lambda (sb!c::block-home-lambda block))
1862 (vector-push-extend (make-interpreted-debug-block block) buffer)))
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))))
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))
1892 (let* ((id (sb!c::leaf-name v)))
1893 (make-interpreted-debug-var id v))
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))
1900 (declare (simple-vector vars))
1901 (sort vars #'string< :key #'debug-var-symbol-name)
1902 (let ((len (length vars)))
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))
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))
1922 (when (= j len) (return))))))))
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)))))
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..
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.
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)
1961 (buffer (make-array 0 :fill-pointer 0 :adjustable t)))
1962 ((>= i (length packed-vars))
1963 (let ((result (coerce buffer 'simple-vector)))
1965 (assign-minimal-var-names 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)
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
1987 ;;;; unpacking minimal debug functions
1989 (eval-when (:compile-toplevel :execute)
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
1995 (let ((base (ecase (ldb sb!c::minimal-debug-function-name-style-byte
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)
2010 :kind (svref sb!c::minimal-debug-function-kinds
2011 (ldb sb!c::minimal-debug-function-kind-byte options))
2014 (let ((len (sb!c::read-var-integer map i)))
2015 (prog1 (subseq map i (+ i len))
2017 :arguments (when vars-p :minimal)
2019 (ecase (ldb sb!c::minimal-debug-function-returns-byte options)
2020 (#.sb!c::minimal-debug-function-returns-standard
2022 (#.sb!c::minimal-debug-function-returns-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))
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))
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)))
2038 (setq elsewhere-pc (+ elsewhere-pc (sb!c::read-var-integer map i)))))
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.
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))
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)")
2055 (let* ((map (sb!c::compiled-debug-info-function-map info))
2060 (declare (type (simple-array (unsigned-byte 8) (*)) map))
2061 (sb!int:collect ((res))
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)))
2072 (coerce (cdr (res)) 'simple-vector))))
2074 ;;; This variable maps minimal debug-info function maps to an unpacked
2075 ;;; version thereof.
2076 (defvar *uncompacted-function-maps* (make-hash-table :test 'eq))
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.
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
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)
2091 (or (gethash map *uncompacted-function-maps*)
2092 (setf (gethash map *uncompacted-function-maps*)
2093 (uncompact-function-map info))))))
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.
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)
2106 "Returns whether basic-code-location is unknown. It returns nil when the
2107 code-location is known."
2108 (ecase (code-location-%unknown-p basic-code-location)
2112 (setf (code-location-%unknown-p basic-code-location)
2113 (handler-case (not (fill-in-code-location basic-code-location))
2114 (no-debug-blocks () t))))))
2116 (defun code-location-debug-block (basic-code-location)
2118 "Returns the debug-block containing code-location if it is available. Some
2119 debug policies inhibit debug-block information, and if none is available,
2120 then this signals a no-debug-blocks condition."
2121 (let ((block (code-location-%debug-block basic-code-location)))
2122 (if (eq block :unparsed)
2123 (etypecase basic-code-location
2124 (compiled-code-location
2125 (compute-compiled-code-location-debug-block basic-code-location))
2126 (interpreted-code-location
2127 (setf (code-location-%debug-block basic-code-location)
2128 (make-interpreted-debug-block
2130 (interpreted-code-location-ir1-node basic-code-location))))))
2133 ;;; This stores and returns BASIC-CODE-LOCATION's debug-block. It
2134 ;;; determines the correct one using the code-location's pc. This uses
2135 ;;; DEBUG-FUNCTION-DEBUG-BLOCKS to return the cached block information
2136 ;;; or signal a 'no-debug-blocks condition. The blocks are sorted by
2137 ;;; their first code-location's pc, in ascending order. Therefore, as
2138 ;;; soon as we find a block that starts with a pc greater than
2139 ;;; basic-code-location's pc, we know the previous block contains the
2140 ;;; pc. If we get to the last block, then the code-location is either
2141 ;;; in the second to last block or the last block, and we have to be
2142 ;;; careful in determining this since the last block could be code at
2143 ;;; the end of the function. We have to check for the last block being
2144 ;;; code first in order to see how to compare the code-location's pc.
2145 (defun compute-compiled-code-location-debug-block (basic-code-location)
2146 (let* ((pc (compiled-code-location-pc basic-code-location))
2147 (debug-function (code-location-debug-function
2148 basic-code-location))
2149 (blocks (debug-function-debug-blocks debug-function))
2150 (len (length blocks)))
2151 (declare (simple-vector blocks))
2152 (setf (code-location-%debug-block basic-code-location)
2158 (let ((last (svref blocks end)))
2160 ((debug-block-elsewhere-p last)
2162 (sb!c::compiled-debug-function-elsewhere-pc
2163 (compiled-debug-function-compiler-debug-fun
2165 (svref blocks (1- end))
2168 (compiled-code-location-pc
2169 (svref (compiled-debug-block-code-locations last)
2171 (svref blocks (1- end)))
2173 (declare (type sb!c::index i end))
2175 (compiled-code-location-pc
2176 (svref (compiled-debug-block-code-locations
2179 (return (svref blocks (1- i)))))))))
2181 (defun code-location-debug-source (code-location)
2183 "Returns the code-location's debug-source."
2184 (etypecase code-location
2185 (compiled-code-location
2186 (let* ((info (compiled-debug-function-debug-info
2187 (code-location-debug-function code-location)))
2188 (sources (sb!c::compiled-debug-info-source info))
2189 (len (length sources)))
2190 (declare (list sources))
2192 (debug-signal 'no-debug-blocks :debug-function
2193 (code-location-debug-function code-location)))
2196 (do ((prev sources src)
2197 (src (cdr sources) (cdr src))
2198 (offset (code-location-top-level-form-offset code-location)))
2199 ((null src) (car prev))
2200 (when (< offset (sb!c::debug-source-source-root (car src)))
2201 (return (car prev)))))))
2202 (interpreted-code-location
2204 (let ((sb!c::*lexenv* (make-null-lexenv)))
2205 (sb!c::debug-source-for-info
2206 (sb!c::component-source-info
2207 (sb!c::block-component
2209 (interpreted-code-location-ir1-node code-location))))))))))
2211 (defun code-location-top-level-form-offset (code-location)
2213 "Returns the number of top-level forms before the one containing
2214 code-location as seen by the compiler in some compilation unit. A
2215 compilation unit is not necessarily a single file, see the section on
2217 (when (code-location-unknown-p code-location)
2218 (error 'unknown-code-location :code-location code-location))
2219 (let ((tlf-offset (code-location-%tlf-offset code-location)))
2220 (cond ((eq tlf-offset :unparsed)
2221 (etypecase code-location
2222 (compiled-code-location
2223 (unless (fill-in-code-location code-location)
2224 ;; This check should be unnecessary. We're missing
2225 ;; debug info the compiler should have dumped.
2226 (error "internal error: unknown code location"))
2227 (code-location-%tlf-offset code-location))
2228 (interpreted-code-location
2229 (setf (code-location-%tlf-offset code-location)
2230 (sb!c::source-path-tlf-number
2231 (sb!c::node-source-path
2232 (interpreted-code-location-ir1-node code-location)))))))
2235 (defun code-location-form-number (code-location)
2237 "Returns the number of the form corresponding to code-location. The form
2238 number is derived by a walking the subforms of a top-level form in
2240 (when (code-location-unknown-p code-location)
2241 (error 'unknown-code-location :code-location code-location))
2242 (let ((form-num (code-location-%form-number code-location)))
2243 (cond ((eq form-num :unparsed)
2244 (etypecase code-location
2245 (compiled-code-location
2246 (unless (fill-in-code-location code-location)
2247 ;; This check should be unnecessary. We're missing
2248 ;; debug info the compiler should have dumped.
2249 (error "internal error: unknown code location"))
2250 (code-location-%form-number code-location))
2251 (interpreted-code-location
2252 (setf (code-location-%form-number code-location)
2253 (sb!c::source-path-form-number
2254 (sb!c::node-source-path
2255 (interpreted-code-location-ir1-node code-location)))))))
2258 (defun code-location-kind (code-location)
2260 "Return the kind of CODE-LOCATION, one of:
2261 :interpreted, :unknown-return, :known-return, :internal-error,
2262 :non-local-exit, :block-start, :call-site, :single-value-return,
2264 (when (code-location-unknown-p code-location)
2265 (error 'unknown-code-location :code-location code-location))
2266 (etypecase code-location
2267 (compiled-code-location
2268 (let ((kind (compiled-code-location-kind code-location)))
2269 (cond ((not (eq kind :unparsed)) kind)
2270 ((not (fill-in-code-location code-location))
2271 ;; This check should be unnecessary. We're missing
2272 ;; debug info the compiler should have dumped.
2273 (error "internal error: unknown code location"))
2275 (compiled-code-location-kind code-location)))))
2276 (interpreted-code-location
2279 ;;; This returns CODE-LOCATION's live-set if it is available. If
2280 ;;; there is no debug-block information, this returns NIL.
2281 (defun compiled-code-location-live-set (code-location)
2282 (if (code-location-unknown-p code-location)
2284 (let ((live-set (compiled-code-location-%live-set code-location)))
2285 (cond ((eq live-set :unparsed)
2286 (unless (fill-in-code-location code-location)
2287 ;; This check should be unnecessary. We're missing debug info
2288 ;; the compiler should have dumped.
2290 ;; FIXME: This error and comment happen over and over again.
2291 ;; Make them a shared function.
2292 (error "internal error: unknown code location"))
2293 (compiled-code-location-%live-set code-location))
2296 (defun code-location= (obj1 obj2)
2298 "Returns whether obj1 and obj2 are the same place in the code."
2300 (compiled-code-location
2302 (compiled-code-location
2303 (and (eq (code-location-debug-function obj1)
2304 (code-location-debug-function obj2))
2305 (sub-compiled-code-location= obj1 obj2)))
2306 (interpreted-code-location
2308 (interpreted-code-location
2310 (compiled-code-location
2312 (interpreted-code-location
2313 (eq (interpreted-code-location-ir1-node obj1)
2314 (interpreted-code-location-ir1-node obj2)))))))
2315 (defun sub-compiled-code-location= (obj1 obj2)
2316 (= (compiled-code-location-pc obj1)
2317 (compiled-code-location-pc obj2)))
2319 ;;; This fills in CODE-LOCATION's :unparsed slots. It returns t or nil
2320 ;;; depending on whether the code-location was known in its
2321 ;;; debug-function's debug-block information. This may signal a
2322 ;;; NO-DEBUG-BLOCKS condition due to DEBUG-FUNCTION-DEBUG-BLOCKS, and
2323 ;;; it assumes the %UNKNOWN-P slot is already set or going to be set.
2324 (defun fill-in-code-location (code-location)
2325 (declare (type compiled-code-location code-location))
2326 (let* ((debug-function (code-location-debug-function code-location))
2327 (blocks (debug-function-debug-blocks debug-function)))
2328 (declare (simple-vector blocks))
2329 (dotimes (i (length blocks) nil)
2330 (let* ((block (svref blocks i))
2331 (locations (compiled-debug-block-code-locations block)))
2332 (declare (simple-vector locations))
2333 (dotimes (j (length locations))
2334 (let ((loc (svref locations j)))
2335 (when (sub-compiled-code-location= code-location loc)
2336 (setf (code-location-%debug-block code-location) block)
2337 (setf (code-location-%tlf-offset code-location)
2338 (code-location-%tlf-offset loc))
2339 (setf (code-location-%form-number code-location)
2340 (code-location-%form-number loc))
2341 (setf (compiled-code-location-%live-set code-location)
2342 (compiled-code-location-%live-set loc))
2343 (setf (compiled-code-location-kind code-location)
2344 (compiled-code-location-kind loc))
2345 (return-from fill-in-code-location t))))))))
2347 ;;;; operations on DEBUG-BLOCKs
2349 (defmacro do-debug-block-locations ((code-var debug-block &optional return)
2352 "Executes forms in a context with code-var bound to each code-location in
2353 debug-block. This returns the value of executing result (defaults to nil)."
2354 (let ((code-locations (gensym))
2356 `(let ((,code-locations (debug-block-code-locations ,debug-block)))
2357 (declare (simple-vector ,code-locations))
2358 (dotimes (,i (length ,code-locations) ,return)
2359 (let ((,code-var (svref ,code-locations ,i)))
2362 (defun debug-block-function-name (debug-block)
2364 "Returns the name of the function represented by debug-function. This may
2365 be a string or a cons; do not assume it is a symbol."
2366 (etypecase debug-block
2367 (compiled-debug-block
2368 (let ((code-locs (compiled-debug-block-code-locations debug-block)))
2369 (declare (simple-vector code-locs))
2370 (if (zerop (length code-locs))
2371 "??? Can't get name of debug-block's function."
2372 (debug-function-name
2373 (code-location-debug-function (svref code-locs 0))))))
2374 (interpreted-debug-block
2375 (sb!c::lambda-name (sb!c::block-home-lambda
2376 (interpreted-debug-block-ir1-block debug-block))))))
2378 (defun debug-block-code-locations (debug-block)
2379 (etypecase debug-block
2380 (compiled-debug-block
2381 (compiled-debug-block-code-locations debug-block))
2382 (interpreted-debug-block
2383 (interpreted-debug-block-code-locations debug-block))))
2385 (defun interpreted-debug-block-code-locations (debug-block)
2386 (let ((code-locs (interpreted-debug-block-locations debug-block)))
2387 (if (eq code-locs :unparsed)
2388 (with-parsing-buffer (buf)
2389 (sb!c::do-nodes (node cont (interpreted-debug-block-ir1-block
2391 (vector-push-extend (make-interpreted-code-location
2393 (make-interpreted-debug-function
2394 (sb!c::block-home-lambda (sb!c::node-block
2397 (setf (interpreted-debug-block-locations debug-block)
2401 ;;;; operations on debug variables
2403 (defun debug-var-symbol-name (debug-var)
2404 (symbol-name (debug-var-symbol debug-var)))
2406 ;;; FIXME: Make sure that this isn't called anywhere that it wouldn't
2407 ;;; be acceptable to have NIL returned, or that it's only called on
2408 ;;; DEBUG-VARs whose symbols have non-NIL packages.
2409 (defun debug-var-package-name (debug-var)
2410 (package-name (symbol-package (debug-var-symbol debug-var))))
2412 (defun debug-var-valid-value (debug-var frame)
2414 "Returns the value stored for DEBUG-VAR in frame. If the value is not
2415 :valid, then this signals an invalid-value error."
2416 (unless (eq (debug-var-validity debug-var (frame-code-location frame))
2418 (error 'invalid-value :debug-var debug-var :frame frame))
2419 (debug-var-value debug-var frame))
2421 (defun debug-var-value (debug-var frame)
2423 "Returns the value stored for DEBUG-VAR in frame. The value may be
2424 invalid. This is SETF'able."
2425 (etypecase debug-var
2427 (check-type frame compiled-frame)
2428 (let ((res (access-compiled-debug-var-slot debug-var frame)))
2429 (if (indirect-value-cell-p res)
2430 (sb!c:value-cell-ref res)
2432 (interpreted-debug-var
2433 (check-type frame interpreted-frame)
2434 (sb!eval::leaf-value-lambda-var
2435 (interpreted-code-location-ir1-node (frame-code-location frame))
2436 (interpreted-debug-var-ir1-var debug-var)
2437 (frame-pointer frame)
2438 (interpreted-frame-closure frame)))))
2440 ;;; This returns what is stored for the variable represented by
2441 ;;; DEBUG-VAR relative to the FRAME. This may be an indirect value
2442 ;;; cell if the variable is both closed over and set.
2443 (defun access-compiled-debug-var-slot (debug-var frame)
2444 (let ((escaped (compiled-frame-escaped frame)))
2446 (sub-access-debug-var-slot
2447 (frame-pointer frame)
2448 (compiled-debug-var-sc-offset debug-var)
2450 (sub-access-debug-var-slot
2451 (frame-pointer frame)
2452 (or (compiled-debug-var-save-sc-offset debug-var)
2453 (compiled-debug-var-sc-offset debug-var))))))
2456 ;;; (DEFUN SUB-ACCESS-DEBUG-VAR-SLOT (FP SC-OFFSET &OPTIONAL ESCAPED) ..)
2457 ;;; code for this case.
2459 (eval-when (:compile-toplevel :load-toplevel :execute)
2460 (error "hopelessly stale"))
2463 (defun sub-access-debug-var-slot (fp sc-offset &optional escaped)
2464 (declare (type system-area-pointer fp))
2465 (macrolet ((with-escaped-value ((var) &body forms)
2467 (let ((,var (sb!vm:context-register
2468 escaped (sb!c:sc-offset-offset sc-offset))))
2470 :invalid-value-for-unescaped-register-storage))
2471 (escaped-float-value (format)
2473 (sb!vm:context-float-register
2474 escaped (sb!c:sc-offset-offset sc-offset) ',format)
2475 :invalid-value-for-unescaped-register-storage))
2476 (escaped-complex-float-value (format)
2479 (sb!vm:context-float-register
2480 escaped (sb!c:sc-offset-offset sc-offset) ',format)
2481 (sb!vm:context-float-register
2482 escaped (1+ (sb!c:sc-offset-offset sc-offset)) ',format))
2483 :invalid-value-for-unescaped-register-storage))
2484 ;; The debug variable locations are not always valid, and
2485 ;; on the x86 locations can contain raw values. To
2486 ;; prevent later problems from invalid objects, they are
2488 (make-valid-lisp-obj (val)
2491 (zerop (logand ,val 3))
2493 (and (zerop (logand ,val #xffff0000)) ; Top bits zero
2494 (= (logand ,val #xff) sb!vm:base-char-type)) ; Char tag
2496 (= ,val sb!vm:unbound-marker-type)
2498 (and (logand ,val 1)
2499 ;; Check that the pointer is valid. XXX Could do a
2501 (or (< (sb!impl::read-only-space-start) ,val
2502 (* sb!impl::*read-only-space-free-pointer*
2504 (< (sb!impl::static-space-start) ,val
2505 (* sb!impl::*static-space-free-pointer*
2507 (< (sb!impl::current-dynamic-space-start) ,val
2508 (sap-int (dynamic-space-free-pointer))))))
2509 (make-lisp-obj ,val)
2511 (ecase (sb!c:sc-offset-scn sc-offset)
2512 ((#.sb!vm:any-reg-sc-number #.sb!vm:descriptor-reg-sc-number)
2514 (with-escaped-value (val)
2515 (make-valid-lisp-obj val))))
2516 (#.sb!vm:base-char-reg-sc-number
2517 (with-escaped-value (val)
2519 (#.sb!vm:sap-reg-sc-number
2520 (with-escaped-value (val)
2522 (#.sb!vm:signed-reg-sc-number
2523 (with-escaped-value (val)
2524 (if (logbitp (1- sb!vm:word-bits) val)
2525 (logior val (ash -1 sb!vm:word-bits))
2527 (#.sb!vm:unsigned-reg-sc-number
2528 (with-escaped-value (val)
2530 (#.sb!vm:single-reg-sc-number
2531 (escaped-float-value single-float))
2532 (#.sb!vm:double-reg-sc-number
2533 (escaped-float-value double-float))
2535 (#.sb!vm:long-reg-sc-number
2536 (escaped-float-value long-float))
2537 (#.sb!vm:complex-single-reg-sc-number
2538 (escaped-complex-float-value single-float))
2539 (#.sb!vm:complex-double-reg-sc-number
2540 (escaped-complex-float-value double-float))
2542 (#.sb!vm:complex-long-reg-sc-number
2543 (escaped-complex-float-value long-float))
2544 (#.sb!vm:single-stack-sc-number
2545 (sap-ref-single fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2546 sb!vm:word-bytes))))
2547 (#.sb!vm:double-stack-sc-number
2548 (sap-ref-double fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2549 sb!vm:word-bytes))))
2551 (#.sb!vm:long-stack-sc-number
2552 (sap-ref-long fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2553 sb!vm:word-bytes))))
2554 (#.sb!vm:complex-single-stack-sc-number
2556 (sap-ref-single fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2558 (sap-ref-single fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2559 sb!vm:word-bytes)))))
2560 (#.sb!vm:complex-double-stack-sc-number
2562 (sap-ref-double fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2564 (sap-ref-double fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 4)
2565 sb!vm:word-bytes)))))
2567 (#.sb!vm:complex-long-stack-sc-number
2569 (sap-ref-long fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2571 (sap-ref-long fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 6)
2572 sb!vm:word-bytes)))))
2573 (#.sb!vm:control-stack-sc-number
2574 (stack-ref fp (sb!c:sc-offset-offset sc-offset)))
2575 (#.sb!vm:base-char-stack-sc-number
2577 (sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2578 sb!vm:word-bytes)))))
2579 (#.sb!vm:unsigned-stack-sc-number
2580 (sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2581 sb!vm:word-bytes))))
2582 (#.sb!vm:signed-stack-sc-number
2583 (signed-sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2584 sb!vm:word-bytes))))
2585 (#.sb!vm:sap-stack-sc-number
2586 (sap-ref-sap fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2587 sb!vm:word-bytes)))))))
2589 ;;; This stores value as the value of DEBUG-VAR in FRAME. In the
2590 ;;; COMPILED-DEBUG-VAR case, access the current value to determine if
2591 ;;; it is an indirect value cell. This occurs when the variable is
2592 ;;; both closed over and set. For INTERPRETED-DEBUG-VARs just call
2593 ;;; SB!EVAL::SET-LEAF-VALUE-LAMBDA-VAR with the right interpreter
2595 (defun %set-debug-var-value (debug-var frame value)
2596 (etypecase debug-var
2598 (check-type frame compiled-frame)
2599 (let ((current-value (access-compiled-debug-var-slot debug-var frame)))
2600 (if (indirect-value-cell-p current-value)
2601 (sb!c:value-cell-set current-value value)
2602 (set-compiled-debug-var-slot debug-var frame value))))
2603 (interpreted-debug-var
2604 (check-type frame interpreted-frame)
2605 (sb!eval::set-leaf-value-lambda-var
2606 (interpreted-code-location-ir1-node (frame-code-location frame))
2607 (interpreted-debug-var-ir1-var debug-var)
2608 (frame-pointer frame)
2609 (interpreted-frame-closure frame)
2613 ;;; This stores value for the variable represented by debug-var
2614 ;;; relative to the frame. This assumes the location directly contains
2615 ;;; the variable's value; that is, there is no indirect value cell
2616 ;;; currently there in case the variable is both closed over and set.
2617 (defun set-compiled-debug-var-slot (debug-var frame value)
2618 (let ((escaped (compiled-frame-escaped frame)))
2620 (sub-set-debug-var-slot (frame-pointer frame)
2621 (compiled-debug-var-sc-offset debug-var)
2623 (sub-set-debug-var-slot
2624 (frame-pointer frame)
2625 (or (compiled-debug-var-save-sc-offset debug-var)
2626 (compiled-debug-var-sc-offset debug-var))
2630 (defun sub-set-debug-var-slot (fp sc-offset value &optional escaped)
2631 (macrolet ((set-escaped-value (val)
2633 (setf (sb!vm:context-register
2635 (sb!c:sc-offset-offset sc-offset))
2638 (set-escaped-float-value (format val)
2640 (setf (sb!vm:context-float-register
2642 (sb!c:sc-offset-offset sc-offset)
2646 (with-nfp ((var) &body body)
2647 `(let ((,var (if escaped
2649 (sb!vm:context-register escaped
2653 (* sb!vm::nfp-save-offset
2656 (%alpha::make-number-stack-pointer
2658 (* sb!vm::nfp-save-offset
2659 sb!vm:word-bytes))))))
2661 (ecase (sb!c:sc-offset-scn sc-offset)
2662 ((#.sb!vm:any-reg-sc-number
2663 #.sb!vm:descriptor-reg-sc-number
2664 #!+rt #.sb!vm:word-pointer-reg-sc-number)
2667 (get-lisp-obj-address value))))
2668 (#.sb!vm:base-char-reg-sc-number
2669 (set-escaped-value (char-code value)))
2670 (#.sb!vm:sap-reg-sc-number
2671 (set-escaped-value (sap-int value)))
2672 (#.sb!vm:signed-reg-sc-number
2673 (set-escaped-value (logand value (1- (ash 1 sb!vm:word-bits)))))
2674 (#.sb!vm:unsigned-reg-sc-number
2675 (set-escaped-value value))
2676 (#.sb!vm:non-descriptor-reg-sc-number
2677 (error "Local non-descriptor register access?"))
2678 (#.sb!vm:interior-reg-sc-number
2679 (error "Local interior register access?"))
2680 (#.sb!vm:single-reg-sc-number
2681 (set-escaped-float-value single-float value))
2682 (#.sb!vm:double-reg-sc-number
2683 (set-escaped-float-value double-float value))
2685 (#.sb!vm:long-reg-sc-number
2686 (set-escaped-float-value long-float value))
2687 (#.sb!vm:complex-single-reg-sc-number
2689 (setf (sb!vm:context-float-register escaped
2690 (sb!c:sc-offset-offset sc-offset)
2693 (setf (sb!vm:context-float-register
2694 escaped (1+ (sb!c:sc-offset-offset sc-offset))
2698 (#.sb!vm:complex-double-reg-sc-number
2700 (setf (sb!vm:context-float-register
2701 escaped (sb!c:sc-offset-offset sc-offset) 'double-float)
2703 (setf (sb!vm:context-float-register
2705 (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 2 #!-sparc 1)
2710 (#.sb!vm:complex-long-reg-sc-number
2712 (setf (sb!vm:context-float-register
2713 escaped (sb!c:sc-offset-offset sc-offset) 'long-float)
2715 (setf (sb!vm:context-float-register
2717 (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 4)
2721 (#.sb!vm:single-stack-sc-number
2723 (setf (sap-ref-single nfp (* (sb!c:sc-offset-offset sc-offset)
2725 (the single-float value))))
2726 (#.sb!vm:double-stack-sc-number
2728 (setf (sap-ref-double nfp (* (sb!c:sc-offset-offset sc-offset)
2730 (the double-float value))))
2732 (#.sb!vm:long-stack-sc-number
2734 (setf (sap-ref-long nfp (* (sb!c:sc-offset-offset sc-offset)
2736 (the long-float value))))
2737 (#.sb!vm:complex-single-stack-sc-number
2739 (setf (sap-ref-single
2740 nfp (* (sb!c:sc-offset-offset sc-offset) sb!vm:word-bytes))
2741 (the single-float (realpart value)))
2742 (setf (sap-ref-single
2743 nfp (* (1+ (sb!c:sc-offset-offset sc-offset))
2745 (the single-float (realpart value)))))
2746 (#.sb!vm:complex-double-stack-sc-number
2748 (setf (sap-ref-double
2749 nfp (* (sb!c:sc-offset-offset sc-offset) sb!vm:word-bytes))
2750 (the double-float (realpart value)))
2751 (setf (sap-ref-double
2752 nfp (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2754 (the double-float (realpart value)))))
2756 (#.sb!vm:complex-long-stack-sc-number
2759 nfp (* (sb!c:sc-offset-offset sc-offset) sb!vm:word-bytes))
2760 (the long-float (realpart value)))
2762 nfp (* (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 4)
2764 (the long-float (realpart value)))))
2765 (#.sb!vm:control-stack-sc-number
2766 (setf (stack-ref fp (sb!c:sc-offset-offset sc-offset)) value))
2767 (#.sb!vm:base-char-stack-sc-number
2769 (setf (sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2771 (char-code (the character value)))))
2772 (#.sb!vm:unsigned-stack-sc-number
2774 (setf (sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2776 (the (unsigned-byte 32) value))))
2777 (#.sb!vm:signed-stack-sc-number
2779 (setf (signed-sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2781 (the (signed-byte 32) value))))
2782 (#.sb!vm:sap-stack-sc-number
2784 (setf (sap-ref-sap nfp (* (sb!c:sc-offset-offset sc-offset)
2786 (the system-area-pointer value)))))))
2789 (defun sub-set-debug-var-slot (fp sc-offset value &optional escaped)
2790 (macrolet ((set-escaped-value (val)
2792 (setf (sb!vm:context-register
2794 (sb!c:sc-offset-offset sc-offset))
2797 (ecase (sb!c:sc-offset-scn sc-offset)
2798 ((#.sb!vm:any-reg-sc-number #.sb!vm:descriptor-reg-sc-number)
2801 (get-lisp-obj-address value))))
2802 (#.sb!vm:base-char-reg-sc-number
2803 (set-escaped-value (char-code value)))
2804 (#.sb!vm:sap-reg-sc-number
2805 (set-escaped-value (sap-int value)))
2806 (#.sb!vm:signed-reg-sc-number
2807 (set-escaped-value (logand value (1- (ash 1 sb!vm:word-bits)))))
2808 (#.sb!vm:unsigned-reg-sc-number
2809 (set-escaped-value value))
2810 (#.sb!vm:single-reg-sc-number
2811 #+nil ;; don't have escaped floats.
2812 (set-escaped-float-value single-float value))
2813 (#.sb!vm:double-reg-sc-number
2814 #+nil ;; don't have escaped floats -- still in npx?
2815 (set-escaped-float-value double-float value))
2817 (#.sb!vm:long-reg-sc-number
2818 #+nil ;; don't have escaped floats -- still in npx?
2819 (set-escaped-float-value long-float value))
2820 (#.sb!vm:single-stack-sc-number
2821 (setf (sap-ref-single
2822 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2824 (the single-float value)))
2825 (#.sb!vm:double-stack-sc-number
2826 (setf (sap-ref-double
2827 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2829 (the double-float value)))
2831 (#.sb!vm:long-stack-sc-number
2833 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2835 (the long-float value)))
2836 (#.sb!vm:complex-single-stack-sc-number
2837 (setf (sap-ref-single
2838 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2840 (realpart (the (complex single-float) value)))
2841 (setf (sap-ref-single
2842 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2844 (imagpart (the (complex single-float) value))))
2845 (#.sb!vm:complex-double-stack-sc-number
2846 (setf (sap-ref-double
2847 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2849 (realpart (the (complex double-float) value)))
2850 (setf (sap-ref-double
2851 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 4)
2853 (imagpart (the (complex double-float) value))))
2855 (#.sb!vm:complex-long-stack-sc-number
2857 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2859 (realpart (the (complex long-float) value)))
2861 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 6)
2863 (imagpart (the (complex long-float) value))))
2864 (#.sb!vm:control-stack-sc-number
2865 (setf (stack-ref fp (sb!c:sc-offset-offset sc-offset)) value))
2866 (#.sb!vm:base-char-stack-sc-number
2867 (setf (sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2869 (char-code (the character value))))
2870 (#.sb!vm:unsigned-stack-sc-number
2871 (setf (sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2873 (the (unsigned-byte 32) value)))
2874 (#.sb!vm:signed-stack-sc-number
2875 (setf (signed-sap-ref-32
2876 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset)) sb!vm:word-bytes)))
2877 (the (signed-byte 32) value)))
2878 (#.sb!vm:sap-stack-sc-number
2879 (setf (sap-ref-sap fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2881 (the system-area-pointer value))))))
2883 ;;; The method for setting and accessing COMPILED-DEBUG-VAR values use
2884 ;;; this to determine if the value stored is the actual value or an
2885 ;;; indirection cell.
2886 (defun indirect-value-cell-p (x)
2887 (and (= (get-lowtag x) sb!vm:other-pointer-type)
2888 (= (get-type x) sb!vm:value-cell-header-type)))
2890 ;;; If the variable is always alive, then it is valid. If the
2891 ;;; code-location is unknown, then the variable's validity is
2892 ;;; :unknown. Once we've called CODE-LOCATION-UNKNOWN-P, we know the
2893 ;;; live-set information has been cached in the code-location.
2894 (defun debug-var-validity (debug-var basic-code-location)
2896 "Returns three values reflecting the validity of DEBUG-VAR's value
2897 at BASIC-CODE-LOCATION:
2898 :VALID The value is known to be available.
2899 :INVALID The value is known to be unavailable.
2900 :UNKNOWN The value's availability is unknown."
2901 (etypecase debug-var
2903 (compiled-debug-var-validity debug-var basic-code-location))
2904 (interpreted-debug-var
2905 (check-type basic-code-location interpreted-code-location)
2906 (let ((validp (rassoc (interpreted-debug-var-ir1-var debug-var)
2907 (sb!c::lexenv-variables
2909 (interpreted-code-location-ir1-node
2910 basic-code-location))))))
2911 (if validp :valid :invalid)))))
2913 ;;; This is the method for DEBUG-VAR-VALIDITY for COMPILED-DEBUG-VARs.
2914 ;;; For safety, make sure basic-code-location is what we think.
2915 (defun compiled-debug-var-validity (debug-var basic-code-location)
2916 (check-type basic-code-location compiled-code-location)
2917 (cond ((debug-var-alive-p debug-var)
2918 (let ((debug-fun (code-location-debug-function basic-code-location)))
2919 (if (>= (compiled-code-location-pc basic-code-location)
2920 (sb!c::compiled-debug-function-start-pc
2921 (compiled-debug-function-compiler-debug-fun debug-fun)))
2924 ((code-location-unknown-p basic-code-location) :unknown)
2926 (let ((pos (position debug-var
2927 (debug-function-debug-vars
2928 (code-location-debug-function basic-code-location)))))
2930 (error 'unknown-debug-var
2931 :debug-var debug-var
2933 (code-location-debug-function basic-code-location)))
2934 ;; There must be live-set info since basic-code-location is known.
2935 (if (zerop (sbit (compiled-code-location-live-set basic-code-location)
2942 ;;; This code produces and uses what we call source-paths. A
2943 ;;; source-path is a list whose first element is a form number as
2944 ;;; returned by CODE-LOCATION-FORM-NUMBER and whose last element is a
2945 ;;; top-level-form number as returned by
2946 ;;; CODE-LOCATION-TOP-LEVEL-FORM-NUMBER. The elements from the last to
2947 ;;; the first, exclusively, are the numbered subforms into which to
2948 ;;; descend. For example:
2950 ;;; (let ((a (aref x 3)))
2952 ;;; The call to AREF in this example is form number 5. Assuming this
2953 ;;; DEFUN is the 11'th top-level-form, the source-path for the AREF
2954 ;;; call is as follows:
2956 ;;; Given the DEFUN, 3 gets you the LET, 1 gets you the bindings, 0
2957 ;;; gets the first binding, and 1 gets the AREF form.
2959 ;;; Temporary buffer used to build form-number => source-path translation in
2960 ;;; FORM-NUMBER-TRANSLATIONS.
2961 (defvar *form-number-temp* (make-array 10 :fill-pointer 0 :adjustable t))
2963 ;;; Table used to detect CAR circularities in FORM-NUMBER-TRANSLATIONS.
2964 (defvar *form-number-circularity-table* (make-hash-table :test 'eq))
2966 ;;; The vector elements are in the same format as the compiler's
2967 ;;; NODE-SOUCE-PATH; that is, the first element is the form number and the last
2968 ;;; is the top-level-form number.
2969 (defun form-number-translations (form tlf-number)
2971 "This returns a table mapping form numbers to source-paths. A source-path
2972 indicates a descent into the top-level-form form, going directly to the
2973 subform corressponding to the form number."
2974 (clrhash *form-number-circularity-table*)
2975 (setf (fill-pointer *form-number-temp*) 0)
2976 (sub-translate-form-numbers form (list tlf-number))
2977 (coerce *form-number-temp* 'simple-vector))
2978 (defun sub-translate-form-numbers (form path)
2979 (unless (gethash form *form-number-circularity-table*)
2980 (setf (gethash form *form-number-circularity-table*) t)
2981 (vector-push-extend (cons (fill-pointer *form-number-temp*) path)
2986 (declare (fixnum pos))
2989 (when (atom subform) (return))
2990 (let ((fm (car subform)))
2992 (sub-translate-form-numbers fm (cons pos path)))
2994 (setq subform (cdr subform))
2995 (when (eq subform trail) (return)))))
2999 (setq trail (cdr trail)))))))
3001 (defun source-path-context (form path context)
3003 "Form is a top-level form, and path is a source-path into it. This returns
3004 the form indicated by the source-path. Context is the number of enclosing
3005 forms to return instead of directly returning the source-path form. When
3006 context is non-zero, the form returned contains a marker, #:****HERE****,
3007 immediately before the form indicated by path."
3008 (declare (type unsigned-byte context))
3009 ;; Get to the form indicated by path or the enclosing form indicated
3010 ;; by context and path.
3011 (let ((path (reverse (butlast (cdr path)))))
3012 (dotimes (i (- (length path) context))
3013 (let ((index (first path)))
3014 (unless (and (listp form) (< index (length form)))
3015 (error "Source path no longer exists."))
3016 (setq form (elt form index))
3017 (setq path (rest path))))
3018 ;; Recursively rebuild the source form resulting from the above
3019 ;; descent, copying the beginning of each subform up to the next
3020 ;; subform we descend into according to path. At the bottom of the
3021 ;; recursion, we return the form indicated by path preceded by our
3022 ;; marker, and this gets spliced into the resulting list structure
3023 ;; on the way back up.
3024 (labels ((frob (form path level)
3025 (if (or (zerop level) (null path))
3028 `(#:***here*** ,form))
3029 (let ((n (first path)))
3030 (unless (and (listp form) (< n (length form)))
3031 (error "Source path no longer exists."))
3032 (let ((res (frob (elt form n) (rest path) (1- level))))
3033 (nconc (subseq form 0 n)
3034 (cons res (nthcdr (1+ n) form))))))))
3035 (frob form path context))))
3037 ;;;; PREPROCESS-FOR-EVAL and EVAL-IN-FRAME
3039 ;;; Create a SYMBOL-MACROLET for each variable valid at the location which
3040 ;;; accesses that variable from the frame argument.
3041 (defun preprocess-for-eval (form loc)
3043 "Return a function of one argument that evaluates form in the lexical
3044 context of the basic-code-location loc. PREPROCESS-FOR-EVAL signals a
3045 no-debug-vars condition when the loc's debug-function has no
3046 debug-var information available. The returned function takes the frame
3047 to get values from as its argument, and it returns the values of form.
3048 The returned function signals the following conditions: invalid-value,
3049 ambiguous-variable-name, and frame-function-mismatch"
3050 (declare (type code-location loc))
3051 (let ((n-frame (gensym))
3052 (fun (code-location-debug-function loc)))
3053 (unless (debug-var-info-available fun)
3054 (debug-signal 'no-debug-vars :debug-function fun))
3055 (sb!int:collect ((binds)
3057 (do-debug-function-variables (var fun)
3058 (let ((validity (debug-var-validity var loc)))
3059 (unless (eq validity :invalid)
3060 (let* ((sym (debug-var-symbol var))
3061 (found (assoc sym (binds))))
3063 (setf (second found) :ambiguous)
3064 (binds (list sym validity var)))))))
3065 (dolist (bind (binds))
3066 (let ((name (first bind))
3068 (ecase (second bind)
3070 (specs `(,name (debug-var-value ',var ,n-frame))))
3072 (specs `(,name (debug-signal 'invalid-value :debug-var ',var
3075 (specs `(,name (debug-signal 'ambiguous-variable-name :name ',name
3076 :frame ,n-frame)))))))
3077 (let ((res (coerce `(lambda (,n-frame)
3078 (declare (ignorable ,n-frame))
3079 (symbol-macrolet ,(specs) ,form))
3082 ;; This prevents these functions from being used in any
3083 ;; location other than a function return location, so
3084 ;; maybe this should only check whether frame's
3085 ;; debug-function is the same as loc's.
3086 (unless (code-location= (frame-code-location frame) loc)
3087 (debug-signal 'frame-function-mismatch
3088 :code-location loc :form form :frame frame))
3089 (funcall res frame))))))
3091 (defun eval-in-frame (frame form)
3092 (declare (type frame frame))
3094 "Evaluate Form in the lexical context of Frame's current code location,
3095 returning the results of the evaluation."
3096 (funcall (preprocess-for-eval form (frame-code-location frame)) frame))
3100 ;;;; user-visible interface
3102 (defun make-breakpoint (hook-function what
3103 &key (kind :code-location) info function-end-cookie)
3105 "This creates and returns a breakpoint. When program execution encounters
3106 the breakpoint, the system calls hook-function. Hook-function takes the
3107 current frame for the function in which the program is running and the
3109 What and kind determine where in a function the system invokes
3110 hook-function. What is either a code-location or a debug-function. Kind is
3111 one of :code-location, :function-start, or :function-end. Since the starts
3112 and ends of functions may not have code-locations representing them,
3113 designate these places by supplying what as a debug-function and kind
3114 indicating the :function-start or :function-end. When what is a
3115 debug-function and kind is :function-end, then hook-function must take two
3116 additional arguments, a list of values returned by the function and a
3117 function-end-cookie.
3118 Info is information supplied by and used by the user.
3119 Function-end-cookie is a function. To implement :function-end breakpoints,
3120 the system uses starter breakpoints to establish the :function-end breakpoint
3121 for each invocation of the function. Upon each entry, the system creates a
3122 unique cookie to identify the invocation, and when the user supplies a
3123 function for this argument, the system invokes it on the frame and the
3124 cookie. The system later invokes the :function-end breakpoint hook on the
3125 same cookie. The user may save the cookie for comparison in the hook
3127 This signals an error if what is an unknown code-location."
3130 (when (code-location-unknown-p what)
3131 (error "cannot make a breakpoint at an unknown code location: ~S"
3133 (assert (eq kind :code-location))
3134 (let ((bpt (%make-breakpoint hook-function what kind info)))
3136 (interpreted-code-location
3137 (error "Breakpoints in interpreted code are currently unsupported."))
3138 (compiled-code-location
3139 ;; This slot is filled in due to calling CODE-LOCATION-UNKNOWN-P.
3140 (when (eq (compiled-code-location-kind what) :unknown-return)
3141 (let ((other-bpt (%make-breakpoint hook-function what
3142 :unknown-return-partner
3144 (setf (breakpoint-unknown-return-partner bpt) other-bpt)
3145 (setf (breakpoint-unknown-return-partner other-bpt) bpt)))))
3147 (compiled-debug-function
3150 (%make-breakpoint hook-function what kind info))
3152 (unless (eq (sb!c::compiled-debug-function-returns
3153 (compiled-debug-function-compiler-debug-fun what))
3155 (error ":FUNCTION-END breakpoints are currently unsupported ~
3156 for the known return convention."))
3158 (let* ((bpt (%make-breakpoint hook-function what kind info))
3159 (starter (compiled-debug-function-end-starter what)))
3161 (setf starter (%make-breakpoint #'list what :function-start nil))
3162 (setf (breakpoint-hook-function starter)
3163 (function-end-starter-hook starter what))
3164 (setf (compiled-debug-function-end-starter what) starter))
3165 (setf (breakpoint-start-helper bpt) starter)
3166 (push bpt (breakpoint-%info starter))
3167 (setf (breakpoint-cookie-fun bpt) function-end-cookie)
3169 (interpreted-debug-function
3170 (error ":function-end breakpoints are currently unsupported ~
3171 for interpreted-debug-functions."))))
3173 ;;; These are unique objects created upon entry into a function by a
3174 ;;; :FUNCTION-END breakpoint's starter hook. These are only created
3175 ;;; when users supply :FUNCTION-END-COOKIE to MAKE-BREAKPOINT. Also,
3176 ;;; the :FUNCTION-END breakpoint's hook is called on the same cookie
3177 ;;; when it is created.
3178 (defstruct (function-end-cookie
3179 (:print-object (lambda (obj str)
3180 (print-unreadable-object (obj str :type t))))
3181 (:constructor make-function-end-cookie (bogus-lra debug-fun)))
3182 ;; This is a pointer to the bogus-lra created for :function-end bpts.
3184 ;; This is the debug-function associated with the cookie.
3187 ;;; This maps bogus-lra-components to cookies, so
3188 ;;; HANDLE-FUNCTION-END-BREAKPOINT can find the appropriate cookie for the
3189 ;;; breakpoint hook.
3190 (defvar *function-end-cookies* (make-hash-table :test 'eq))
3192 ;;; This returns a hook function for the start helper breakpoint
3193 ;;; associated with a :FUNCTION-END breakpoint. The returned function
3194 ;;; makes a fake LRA that all returns go through, and this piece of
3195 ;;; fake code actually breaks. Upon return from the break, the code
3196 ;;; provides the returnee with any values. Since the returned function
3197 ;;; effectively activates FUN-END-BPT on each entry to DEBUG-FUN's
3198 ;;; function, we must establish breakpoint-data about FUN-END-BPT.
3199 (defun function-end-starter-hook (starter-bpt debug-fun)
3200 (declare (type breakpoint starter-bpt)
3201 (type compiled-debug-function debug-fun))
3202 #'(lambda (frame breakpoint)
3203 (declare (ignore breakpoint)
3205 (let ((lra-sc-offset
3206 (sb!c::compiled-debug-function-return-pc
3207 (compiled-debug-function-compiler-debug-fun debug-fun))))
3208 (multiple-value-bind (lra component offset)
3210 (get-context-value frame
3211 #!-gengc sb!vm::lra-save-offset
3212 #!+gengc sb!vm::ra-save-offset
3214 (setf (get-context-value frame
3215 #!-gengc sb!vm::lra-save-offset
3216 #!+gengc sb!vm::ra-save-offset
3219 (let ((end-bpts (breakpoint-%info starter-bpt)))
3220 (let ((data (breakpoint-data component offset)))
3221 (setf (breakpoint-data-breakpoints data) end-bpts)
3222 (dolist (bpt end-bpts)
3223 (setf (breakpoint-internal-data bpt) data)))
3224 (let ((cookie (make-function-end-cookie lra debug-fun)))
3225 (setf (gethash component *function-end-cookies*) cookie)
3226 (dolist (bpt end-bpts)
3227 (let ((fun (breakpoint-cookie-fun bpt)))
3228 (when fun (funcall fun frame cookie))))))))))
3230 (defun function-end-cookie-valid-p (frame cookie)
3232 "This takes a function-end-cookie and a frame, and it returns whether the
3233 cookie is still valid. A cookie becomes invalid when the frame that
3234 established the cookie has exited. Sometimes cookie holders are unaware
3235 of cookie invalidation because their :function-end breakpoint hooks didn't
3236 run due to THROW'ing. This takes a frame as an efficiency hack since the
3237 user probably has a frame object in hand when using this routine, and it
3238 saves repeated parsing of the stack and consing when asking whether a
3239 series of cookies is valid."
3240 (let ((lra (function-end-cookie-bogus-lra cookie))
3241 (lra-sc-offset (sb!c::compiled-debug-function-return-pc
3242 (compiled-debug-function-compiler-debug-fun
3243 (function-end-cookie-debug-fun cookie)))))
3244 (do ((frame frame (frame-down frame)))
3246 (when (and (compiled-frame-p frame)
3248 (get-context-value frame
3249 #!-gengc sb!vm::lra-save-offset
3250 #!+gengc sb!vm::ra-save-offset
3254 ;;;; ACTIVATE-BREAKPOINT
3256 (defun activate-breakpoint (breakpoint)
3258 "This causes the system to invoke the breakpoint's hook-function until the
3259 next call to DEACTIVATE-BREAKPOINT or DELETE-BREAKPOINT. The system invokes
3260 breakpoint hook functions in the opposite order that you activate them."
3261 (when (eq (breakpoint-status breakpoint) :deleted)
3262 (error "cannot activate a deleted breakpoint: ~S" breakpoint))
3263 (unless (eq (breakpoint-status breakpoint) :active)
3264 (ecase (breakpoint-kind breakpoint)
3266 (let ((loc (breakpoint-what breakpoint)))
3268 (interpreted-code-location
3269 (error "Breakpoints in interpreted code are currently unsupported."))
3270 (compiled-code-location
3271 (activate-compiled-code-location-breakpoint breakpoint)
3272 (let ((other (breakpoint-unknown-return-partner breakpoint)))
3274 (activate-compiled-code-location-breakpoint other)))))))
3276 (etypecase (breakpoint-what breakpoint)
3277 (compiled-debug-function
3278 (activate-compiled-function-start-breakpoint breakpoint))
3279 (interpreted-debug-function
3280 (error "I don't know how you made this, but they're unsupported: ~S"
3281 (breakpoint-what breakpoint)))))
3283 (etypecase (breakpoint-what breakpoint)
3284 (compiled-debug-function
3285 (let ((starter (breakpoint-start-helper breakpoint)))
3286 (unless (eq (breakpoint-status starter) :active)
3287 ;; May already be active by some other :function-end breakpoint.
3288 (activate-compiled-function-start-breakpoint starter)))
3289 (setf (breakpoint-status breakpoint) :active))
3290 (interpreted-debug-function
3291 (error "I don't know how you made this, but they're unsupported: ~S"
3292 (breakpoint-what breakpoint)))))))
3295 (defun activate-compiled-code-location-breakpoint (breakpoint)
3296 (declare (type breakpoint breakpoint))
3297 (let ((loc (breakpoint-what breakpoint)))
3298 (declare (type compiled-code-location loc))
3299 (sub-activate-breakpoint
3301 (breakpoint-data (compiled-debug-function-component
3302 (code-location-debug-function loc))
3303 (+ (compiled-code-location-pc loc)
3304 (if (or (eq (breakpoint-kind breakpoint)
3305 :unknown-return-partner)
3306 (eq (compiled-code-location-kind loc)
3307 :single-value-return))
3308 sb!vm:single-value-return-byte-offset
3311 (defun activate-compiled-function-start-breakpoint (breakpoint)
3312 (declare (type breakpoint breakpoint))
3313 (let ((debug-fun (breakpoint-what breakpoint)))
3314 (sub-activate-breakpoint
3316 (breakpoint-data (compiled-debug-function-component debug-fun)
3317 (sb!c::compiled-debug-function-start-pc
3318 (compiled-debug-function-compiler-debug-fun
3321 (defun sub-activate-breakpoint (breakpoint data)
3322 (declare (type breakpoint breakpoint)
3323 (type breakpoint-data data))
3324 (setf (breakpoint-status breakpoint) :active)
3326 (unless (breakpoint-data-breakpoints data)
3327 (setf (breakpoint-data-instruction data)
3329 (breakpoint-install (get-lisp-obj-address
3330 (breakpoint-data-component data))
3331 (breakpoint-data-offset data)))))
3332 (setf (breakpoint-data-breakpoints data)
3333 (append (breakpoint-data-breakpoints data) (list breakpoint)))
3334 (setf (breakpoint-internal-data breakpoint) data)))
3336 ;;;; DEACTIVATE-BREAKPOINT
3338 (defun deactivate-breakpoint (breakpoint)
3340 "This stops the system from invoking the breakpoint's hook-function."
3341 (when (eq (breakpoint-status breakpoint) :active)
3343 (let ((loc (breakpoint-what breakpoint)))
3345 ((or interpreted-code-location interpreted-debug-function)
3347 "Breakpoints in interpreted code are currently unsupported."))
3348 ((or compiled-code-location compiled-debug-function)
3349 (deactivate-compiled-breakpoint breakpoint)
3350 (let ((other (breakpoint-unknown-return-partner breakpoint)))
3352 (deactivate-compiled-breakpoint other))))))))
3355 (defun deactivate-compiled-breakpoint (breakpoint)
3356 (if (eq (breakpoint-kind breakpoint) :function-end)
3357 (let ((starter (breakpoint-start-helper breakpoint)))
3358 (unless (find-if #'(lambda (bpt)
3359 (and (not (eq bpt breakpoint))
3360 (eq (breakpoint-status bpt) :active)))
3361 (breakpoint-%info starter))
3362 (deactivate-compiled-breakpoint starter)))
3363 (let* ((data (breakpoint-internal-data breakpoint))
3364 (bpts (delete breakpoint (breakpoint-data-breakpoints data))))
3365 (setf (breakpoint-internal-data breakpoint) nil)
3366 (setf (breakpoint-data-breakpoints data) bpts)
3369 (breakpoint-remove (get-lisp-obj-address
3370 (breakpoint-data-component data))
3371 (breakpoint-data-offset data)
3372 (breakpoint-data-instruction data)))
3373 (delete-breakpoint-data data))))
3374 (setf (breakpoint-status breakpoint) :inactive)
3377 ;;;; BREAKPOINT-INFO
3379 (defun breakpoint-info (breakpoint)
3381 "This returns the user-maintained info associated with breakpoint. This
3383 (breakpoint-%info breakpoint))
3384 (defun %set-breakpoint-info (breakpoint value)
3385 (setf (breakpoint-%info breakpoint) value)
3386 (let ((other (breakpoint-unknown-return-partner breakpoint)))
3388 (setf (breakpoint-%info other) value))))
3390 ;;;; BREAKPOINT-ACTIVE-P and DELETE-BREAKPOINT
3392 (defun breakpoint-active-p (breakpoint)
3394 "This returns whether breakpoint is currently active."
3395 (ecase (breakpoint-status breakpoint)
3397 ((:inactive :deleted) nil)))
3399 (defun delete-breakpoint (breakpoint)
3401 "This frees system storage and removes computational overhead associated with
3402 breakpoint. After calling this, breakpoint is completely impotent and can
3403 never become active again."
3404 (let ((status (breakpoint-status breakpoint)))
3405 (unless (eq status :deleted)
3406 (when (eq status :active)
3407 (deactivate-breakpoint breakpoint))
3408 (setf (breakpoint-status breakpoint) :deleted)
3409 (let ((other (breakpoint-unknown-return-partner breakpoint)))
3411 (setf (breakpoint-status other) :deleted)))
3412 (when (eq (breakpoint-kind breakpoint) :function-end)
3413 (let* ((starter (breakpoint-start-helper breakpoint))
3414 (breakpoints (delete breakpoint
3415 (the list (breakpoint-info starter)))))
3416 (setf (breakpoint-info starter) breakpoints)
3418 (delete-breakpoint starter)
3419 (setf (compiled-debug-function-end-starter
3420 (breakpoint-what breakpoint))
3424 ;;;; C call out stubs
3426 ;;; This actually installs the break instruction in the component. It
3427 ;;; returns the overwritten bits. You must call this in a context in
3428 ;;; which GC is disabled, so that Lisp doesn't move objects around
3429 ;;; that C is pointing to.
3430 (sb!alien:def-alien-routine "breakpoint_install" sb!c-call:unsigned-long
3431 (code-obj sb!c-call:unsigned-long)
3432 (pc-offset sb!c-call:int))
3434 ;;; This removes the break instruction and replaces the original
3435 ;;; instruction. You must call this in a context in which GC is disabled
3436 ;;; so Lisp doesn't move objects around that C is pointing to.
3437 (sb!alien:def-alien-routine "breakpoint_remove" sb!c-call:void
3438 (code-obj sb!c-call:unsigned-long)
3439 (pc-offset sb!c-call:int)
3440 (old-inst sb!c-call:unsigned-long))
3442 (sb!alien:def-alien-routine "breakpoint_do_displaced_inst" sb!c-call:void
3443 (scp (* os-context-t))
3444 (orig-inst sb!c-call:unsigned-long))
3446 ;;;; breakpoint handlers (layer between C and exported interface)
3448 ;;; This maps components to a mapping of offsets to breakpoint-datas.
3449 (defvar *component-breakpoint-offsets* (make-hash-table :test 'eq))
3451 ;;; This returns the breakpoint-data associated with component cross
3452 ;;; offset. If none exists, this makes one, installs it, and returns it.
3453 (defun breakpoint-data (component offset &optional (create t))
3454 (flet ((install-breakpoint-data ()
3456 (let ((data (make-breakpoint-data component offset)))
3457 (push (cons offset data)
3458 (gethash component *component-breakpoint-offsets*))
3460 (let ((offsets (gethash component *component-breakpoint-offsets*)))
3462 (let ((data (assoc offset offsets)))
3465 (install-breakpoint-data)))
3466 (install-breakpoint-data)))))
3468 ;;; We use this when there are no longer any active breakpoints
3469 ;;; corresponding to data.
3470 (defun delete-breakpoint-data (data)
3471 (let* ((component (breakpoint-data-component data))
3472 (offsets (delete (breakpoint-data-offset data)
3473 (gethash component *component-breakpoint-offsets*)
3476 (setf (gethash component *component-breakpoint-offsets*) offsets)
3477 (remhash component *component-breakpoint-offsets*)))
3480 ;;; The C handler for interrupts calls this when it has a
3481 ;;; debugging-tool break instruction. This does NOT handle all breaks;
3482 ;;; for example, it does not handle breaks for internal errors.
3483 (defun handle-breakpoint (offset component signal-context)
3484 (let ((data (breakpoint-data component offset nil)))
3486 (error "unknown breakpoint in ~S at offset ~S"
3487 (debug-function-name (debug-function-from-pc component offset))
3489 (let ((breakpoints (breakpoint-data-breakpoints data)))
3490 (if (or (null breakpoints)
3491 (eq (breakpoint-kind (car breakpoints)) :function-end))
3492 (handle-function-end-breakpoint-aux breakpoints data signal-context)
3493 (handle-breakpoint-aux breakpoints data
3494 offset component signal-context)))))
3496 ;;; This holds breakpoint-datas while invoking the breakpoint hooks
3497 ;;; associated with that particular component and location. While they
3498 ;;; are executing, if we hit the location again, we ignore the
3499 ;;; breakpoint to avoid infinite recursion. Function-end breakpoints
3500 ;;; must work differently since the breakpoint-data is unique for each
3502 (defvar *executing-breakpoint-hooks* nil)
3504 ;;; This handles code-location and debug-function :FUNCTION-START
3506 (defun handle-breakpoint-aux (breakpoints data offset component signal-context)
3508 (error "internal error: breakpoint that nobody wants"))
3509 (unless (member data *executing-breakpoint-hooks*)
3510 (let ((*executing-breakpoint-hooks* (cons data
3511 *executing-breakpoint-hooks*)))
3512 (invoke-breakpoint-hooks breakpoints component offset)))
3513 ;; At this point breakpoints may not hold the same list as
3514 ;; BREAKPOINT-DATA-BREAKPOINTS since invoking hooks may have allowed
3515 ;; a breakpoint deactivation. In fact, if all breakpoints were
3516 ;; deactivated then data is invalid since it was deleted and so the
3517 ;; correct one must be looked up if it is to be used. If there are
3518 ;; no more breakpoints active at this location, then the normal
3519 ;; instruction has been put back, and we do not need to
3520 ;; DO-DISPLACED-INST.
3521 (let ((data (breakpoint-data component offset nil)))
3522 (when (and data (breakpoint-data-breakpoints data))
3523 ;; The breakpoint is still active, so we need to execute the
3524 ;; displaced instruction and leave the breakpoint instruction
3525 ;; behind. The best way to do this is different on each machine,
3526 ;; so we just leave it up to the C code.
3527 (breakpoint-do-displaced-inst signal-context
3528 (breakpoint-data-instruction data))
3529 ; Under HPUX we can't sigreturn so bp-do-disp-i has to return.
3530 #!-(or hpux irix x86)
3531 (error "BREAKPOINT-DO-DISPLACED-INST returned?"))))
3533 (defun invoke-breakpoint-hooks (breakpoints component offset)
3534 (let* ((debug-fun (debug-function-from-pc component offset))
3535 (frame (do ((f (top-frame) (frame-down f)))
3536 ((eq debug-fun (frame-debug-function f)) f))))
3537 (dolist (bpt breakpoints)
3538 (funcall (breakpoint-hook-function bpt)
3540 ;; If this is an :UNKNOWN-RETURN-PARTNER, then pass the
3541 ;; hook function the original breakpoint, so that users
3542 ;; aren't forced to confront the fact that some
3543 ;; breakpoints really are two.
3544 (if (eq (breakpoint-kind bpt) :unknown-return-partner)
3545 (breakpoint-unknown-return-partner bpt)
3548 (defun handle-function-end-breakpoint (offset component context)
3549 (let ((data (breakpoint-data component offset nil)))
3551 (error "unknown breakpoint in ~S at offset ~S"
3552 (debug-function-name (debug-function-from-pc component offset))
3554 (let ((breakpoints (breakpoint-data-breakpoints data)))
3556 (assert (eq (breakpoint-kind (car breakpoints)) :function-end))
3557 (handle-function-end-breakpoint-aux breakpoints data context)))))
3559 ;;; Either HANDLE-BREAKPOINT calls this for :FUNCTION-END breakpoints
3560 ;;; [old C code] or HANDLE-FUNCTION-END-BREAKPOINT calls this directly
3562 (defun handle-function-end-breakpoint-aux (breakpoints data signal-context)
3563 (delete-breakpoint-data data)
3566 (declare (optimize (inhibit-warnings 3)))
3567 (sb!alien:sap-alien signal-context (* os-context-t))))
3568 (frame (do ((cfp (sb!vm:context-register scp sb!vm::cfp-offset))
3569 (f (top-frame) (frame-down f)))
3570 ((= cfp (sap-int (frame-pointer f))) f)
3571 (declare (type (unsigned-byte #.sb!vm:word-bits) cfp))))
3572 (component (breakpoint-data-component data))
3573 (cookie (gethash component *function-end-cookies*)))
3574 (remhash component *function-end-cookies*)
3575 (dolist (bpt breakpoints)
3576 (funcall (breakpoint-hook-function bpt)
3578 (get-function-end-breakpoint-values scp)
3581 (defun get-function-end-breakpoint-values (scp)
3582 (let ((ocfp (int-sap (sb!vm:context-register
3584 #!-x86 sb!vm::ocfp-offset
3585 #!+x86 sb!vm::ebx-offset)))
3586 (nargs (make-lisp-obj
3587 (sb!vm:context-register scp sb!vm::nargs-offset)))
3588 (reg-arg-offsets '#.sb!vm::register-arg-offsets)
3591 (dotimes (arg-num nargs)
3592 (push (if reg-arg-offsets
3594 (sb!vm:context-register scp (pop reg-arg-offsets)))
3595 (stack-ref ocfp arg-num))
3597 (nreverse results)))
3599 ;;;; MAKE-BOGUS-LRA (used for :function-end breakpoints)
3606 (+ sb!vm:code-constants-offset #!-x86 1 #!+x86 2))
3608 ;;; FIXME: This is also defined in debug-vm.lisp. Which definition
3609 ;;; takes precedence? (One definition uses ALLOCATE-CODE-OBJECT, and
3610 ;;; the other has been hacked for X86 GENCGC to use
3611 ;;; ALLOCATE-DYNAMIC-CODE-OBJECT..)
3612 (defun make-bogus-lra (real-lra &optional known-return-p)
3614 "Make a bogus LRA object that signals a breakpoint trap when returned to. If
3615 the breakpoint trap handler returns, REAL-LRA is returned to. Three values
3616 are returned: the bogus LRA object, the code component it is part of, and
3617 the PC offset for the trap instruction."
3619 (let* ((src-start (foreign-symbol-address "function_end_breakpoint_guts"))
3620 (src-end (foreign-symbol-address "function_end_breakpoint_end"))
3621 (trap-loc (foreign-symbol-address "function_end_breakpoint_trap"))
3622 (length (sap- src-end src-start))
3625 #!-(and x86 gencgc) sb!c:allocate-code-object
3626 #!+(and x86 gencgc) sb!c::allocate-dynamic-code-object
3627 (1+ bogus-lra-constants)
3629 (dst-start (code-instructions code-object)))
3630 (declare (type system-area-pointer
3631 src-start src-end dst-start trap-loc)
3632 (type index length))
3633 (setf (%code-debug-info code-object) :bogus-lra)
3634 (setf (code-header-ref code-object sb!vm:code-trace-table-offset-slot)
3637 (setf (code-header-ref code-object real-lra-slot) real-lra)
3639 (multiple-value-bind (offset code) (compute-lra-data-from-pc real-lra)
3640 (setf (code-header-ref code-object real-lra-slot) code)
3641 (setf (code-header-ref code-object (1+ real-lra-slot)) offset))
3642 (setf (code-header-ref code-object known-return-p-slot)
3644 (system-area-copy src-start 0 dst-start 0 (* length sb!vm:byte-bits))
3645 (sb!vm:sanctify-for-execution code-object)
3647 (values dst-start code-object (sap- trap-loc src-start))
3649 (let ((new-lra (make-lisp-obj (+ (sap-int dst-start)
3650 sb!vm:other-pointer-type))))
3653 (logandc2 (+ sb!vm:code-constants-offset bogus-lra-constants 1)
3655 (sb!vm:sanctify-for-execution code-object)
3656 (values new-lra code-object (sap- trap-loc src-start))))))
3660 ;;; This appears here because it cannot go with the debug-function
3661 ;;; interface since DO-DEBUG-BLOCK-LOCATIONS isn't defined until after
3662 ;;; the debug-function routines.
3664 (defun debug-function-start-location (debug-fun)
3666 "This returns a code-location before the body of a function and after all
3667 the arguments are in place. If this cannot determine that location due to
3668 a lack of debug information, it returns nil."
3669 (etypecase debug-fun
3670 (compiled-debug-function
3671 (code-location-from-pc debug-fun
3672 (sb!c::compiled-debug-function-start-pc
3673 (compiled-debug-function-compiler-debug-fun
3676 (interpreted-debug-function
3677 ;; Return the first location if there are any, otherwise NIL.
3678 (handler-case (do-debug-function-blocks (block debug-fun nil)
3679 (do-debug-block-locations (loc block nil)
3680 (return-from debug-function-start-location loc)))
3681 (no-debug-blocks (condx)
3682 (declare (ignore condx))
3685 (defun print-code-locations (function)
3686 (let ((debug-fun (function-debug-function function)))
3687 (do-debug-function-blocks (block debug-fun)
3688 (do-debug-block-locations (loc block)
3689 (fill-in-code-location loc)
3690 (format t "~S code location at ~D"
3691 (compiled-code-location-kind loc)
3692 (compiled-code-location-pc loc))
3693 (sb!debug::print-code-location-source-form loc 0)