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.
15 ;;; FIXME: There are an awful lot of package prefixes in this code.
16 ;;; Couldn't we have SB-DI use the SB-C and SB-VM packages?
20 ;;;; The interface to building debugging tools signals conditions that
21 ;;;; prevent it from adhering to its contract. These are
22 ;;;; serious-conditions because the program using the interface must
23 ;;;; handle them before it can correctly continue execution. These
24 ;;;; debugging conditions are not errors since it is no fault of the
25 ;;;; programmers that the conditions occur. The interface does not
26 ;;;; provide for programs to detect these situations other than
27 ;;;; calling a routine that detects them and signals a condition. For
28 ;;;; example, programmers call A which may fail to return successfully
29 ;;;; due to a lack of debug information, and there is no B the they
30 ;;;; could have called to realize A would fail. It is not an error to
31 ;;;; have called A, but it is an error for the program to then ignore
32 ;;;; the signal generated by A since it cannot continue without A's
33 ;;;; correctly returning a value or performing some operation.
35 ;;;; Use DEBUG-SIGNAL to signal these conditions.
37 (define-condition debug-condition (serious-condition)
41 "All DEBUG-CONDITIONs inherit from this type. These are serious conditions
42 that must be handled, but they are not programmer errors."))
44 (define-condition no-debug-info (debug-condition)
45 ((code-component :reader no-debug-info-code-component
46 :initarg :code-component))
48 (:documentation "There is no usable debugging information available.")
49 (:report (lambda (condition stream)
52 "no debug information available for ~S~%"
53 (no-debug-info-code-component condition)))))
55 (define-condition no-debug-function-returns (debug-condition)
56 ((debug-function :reader no-debug-function-returns-debug-function
57 :initarg :debug-function))
60 "The system could not return values from a frame with DEBUG-FUNCTION since
61 it lacked information about returning values.")
62 (:report (lambda (condition stream)
63 (let ((fun (debug-function-function
64 (no-debug-function-returns-debug-function condition))))
66 "~&Cannot return values from ~:[frame~;~:*~S~] since ~
67 the debug information lacks details about returning ~
71 (define-condition no-debug-blocks (debug-condition)
72 ((debug-function :reader no-debug-blocks-debug-function
73 :initarg :debug-function))
75 (:documentation "The debug-function has no debug-block information.")
76 (:report (lambda (condition stream)
77 (format stream "~&~S has no debug-block information."
78 (no-debug-blocks-debug-function condition)))))
80 (define-condition no-debug-vars (debug-condition)
81 ((debug-function :reader no-debug-vars-debug-function
82 :initarg :debug-function))
84 (:documentation "The debug-function has no DEBUG-VAR information.")
85 (:report (lambda (condition stream)
86 (format stream "~&~S has no debug variable information."
87 (no-debug-vars-debug-function condition)))))
89 (define-condition lambda-list-unavailable (debug-condition)
90 ((debug-function :reader lambda-list-unavailable-debug-function
91 :initarg :debug-function))
94 "The debug-function has no lambda-list since argument DEBUG-VARs are
96 (:report (lambda (condition stream)
97 (format stream "~&~S has no lambda-list information available."
98 (lambda-list-unavailable-debug-function condition)))))
100 (define-condition invalid-value (debug-condition)
101 ((debug-var :reader invalid-value-debug-var :initarg :debug-var)
102 (frame :reader invalid-value-frame :initarg :frame))
103 (:report (lambda (condition stream)
104 (format stream "~&~S has :invalid or :unknown value in ~S."
105 (invalid-value-debug-var condition)
106 (invalid-value-frame condition)))))
108 (define-condition ambiguous-variable-name (debug-condition)
109 ((name :reader ambiguous-variable-name-name :initarg :name)
110 (frame :reader ambiguous-variable-name-frame :initarg :frame))
111 (:report (lambda (condition stream)
112 (format stream "~&~S names more than one valid variable in ~S."
113 (ambiguous-variable-name-name condition)
114 (ambiguous-variable-name-frame condition)))))
116 ;;;; errors and DEBUG-SIGNAL
118 ;;; The debug-internals code tries to signal all programmer errors as
119 ;;; subtypes of DEBUG-ERROR. There are calls to ERROR signalling
120 ;;; SIMPLE-ERRORs, but these dummy checks in the code and shouldn't
123 ;;; While under development, this code also signals errors in code
124 ;;; branches that remain unimplemented.
126 (define-condition debug-error (error) ()
129 "All programmer errors from using the interface for building debugging
130 tools inherit from this type."))
132 (define-condition unhandled-debug-condition (debug-error)
133 ((condition :reader unhandled-debug-condition-condition :initarg :condition))
134 (:report (lambda (condition stream)
135 (format stream "~&unhandled DEBUG-CONDITION:~%~A"
136 (unhandled-debug-condition-condition condition)))))
138 (define-condition unknown-code-location (debug-error)
139 ((code-location :reader unknown-code-location-code-location
140 :initarg :code-location))
141 (:report (lambda (condition stream)
142 (format stream "~&invalid use of an unknown code-location: ~S"
143 (unknown-code-location-code-location condition)))))
145 (define-condition unknown-debug-var (debug-error)
146 ((debug-var :reader unknown-debug-var-debug-var :initarg :debug-var)
147 (debug-function :reader unknown-debug-var-debug-function
148 :initarg :debug-function))
149 (:report (lambda (condition stream)
150 (format stream "~&~S is not in ~S."
151 (unknown-debug-var-debug-var condition)
152 (unknown-debug-var-debug-function condition)))))
154 (define-condition invalid-control-stack-pointer (debug-error)
156 (:report (lambda (condition stream)
157 (declare (ignore condition))
159 (write-string "invalid control stack pointer" stream))))
161 (define-condition frame-function-mismatch (debug-error)
162 ((code-location :reader frame-function-mismatch-code-location
163 :initarg :code-location)
164 (frame :reader frame-function-mismatch-frame :initarg :frame)
165 (form :reader frame-function-mismatch-form :initarg :form))
166 (: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
175 ;;; an UNHANDLED-DEBUG-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-debug-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 "SB-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)
197 ;; the name of the variable
198 (symbol (required-argument) :type symbol)
199 ;; a unique integer identification relative to other variables with the same
201 (id 0 :type sb!c::index)
202 ;; Does the variable always have a valid value?
203 (alive-p nil :type boolean))
204 (def!method print-object ((debug-var debug-var) stream)
205 (print-unreadable-object (debug-var stream :type t :identity t)
208 (debug-var-symbol debug-var)
209 (debug-var-id debug-var))))
212 (setf (fdocumentation 'debug-var-id 'function)
213 "Returns the integer that makes DEBUG-VAR's name and package unique
214 with respect to other DEBUG-VARs in the same function.")
216 (defstruct (compiled-debug-var
218 (:constructor make-compiled-debug-var
219 (symbol id alive-p sc-offset save-sc-offset))
221 ;; Storage class and offset. (unexported).
222 (sc-offset nil :type sb!c::sc-offset)
223 ;; Storage class and offset when saved somewhere.
224 (save-sc-offset nil :type (or sb!c::sc-offset null)))
226 (defstruct (interpreted-debug-var
227 (:include debug-var (alive-p t))
228 (:constructor make-interpreted-debug-var (symbol ir1-var))
230 ;; This is the IR1 structure that holds information about interpreted vars.
231 (ir1-var nil :type sb!c::lambda-var))
235 ;;; These represent call-frames on the stack.
236 (defstruct (frame (:constructor nil)
238 ;; the next frame up, or NIL when top frame
239 (up nil :type (or frame null))
240 ;; the previous frame down, or NIL when the bottom frame. Before
241 ;; computing the next frame down, this slot holds the frame pointer
242 ;; to the control stack for the given frame. This lets us get the
243 ;; next frame down and the return-pc for that frame.
244 (%down :unparsed :type (or frame (member nil :unparsed)))
245 ;; the debug-function for the function whose call this frame
247 (debug-function nil :type debug-function)
248 ;; the code-location to continue upon return to frame
249 (code-location nil :type code-location)
250 ;; an a-list of catch-tags to code-locations
251 (%catches :unparsed :type (or list (member :unparsed)))
252 ;; pointer to frame on control stack. (unexported) When this frame
253 ;; is an interpreted-frame, this pointer is an index into the
254 ;; interpreter's stack.
256 ;; This is the frame's number for prompt printing. Top is zero.
257 (number 0 :type index))
260 (setf (fdocumentation 'frame-up 'function)
261 "Returns the frame immediately above frame on the stack. When frame is
262 the top of the stack, this returns nil.")
265 (setf (fdocumentation 'frame-debug-function 'function)
266 "Returns the debug-function for the function whose call frame represents.")
269 (setf (fdocumentation 'frame-code-location 'function)
270 "Returns the code-location where the frame's debug-function will continue
271 running when program execution returns to this frame. If someone
272 interrupted this frame, the result could be an unknown code-location.")
274 (defstruct (compiled-frame
276 (:constructor make-compiled-frame
277 (pointer up debug-function code-location number
278 #!+gengc saved-state-chain
281 ;; This indicates whether someone interrupted the frame.
282 ;; (unexported). If escaped, this is a pointer to the state that was
283 ;; saved when we were interrupted. On the non-gengc system, this is
284 ;; a pointer to an os_context_t, i.e. the third argument to an
285 ;; SA_SIGACTION-style signal handler. On the gengc system, this is a
286 ;; state pointer from SAVED-STATE-CHAIN.
288 ;; a list of SAPs to saved states. Each time we unwind past an
289 ;; exception, we pop the next entry off this list. When we get to
290 ;; the end of the list, there is nothing else on the stack.
291 #!+gengc (saved-state-chain nil :type list))
292 (def!method print-object ((obj compiled-frame) str)
293 (print-unreadable-object (obj str :type t)
295 "~S~:[~;, interrupted~]"
296 (debug-function-name (frame-debug-function obj))
297 (compiled-frame-escaped obj))))
299 (defstruct (interpreted-frame
301 (:constructor make-interpreted-frame
302 (pointer up debug-function code-location number
305 ;; This points to the compiled-frame for SB!BYTECODE:INTERNAL-APPLY-LOOP.
306 (real-frame nil :type compiled-frame)
307 ;; This is the closed over data used by the interpreter.
308 (closure nil :type simple-vector))
309 (def!method print-object ((obj interpreted-frame) str)
310 (print-unreadable-object (obj str :type t)
311 (prin1 (debug-function-name (frame-debug-function obj)) str)))
315 ;;; These exist for caching data stored in packed binary form in
316 ;;; compiler debug-functions. *COMPILED-DEBUG-FUNCTIONS* maps a
317 ;;; SB!C::DEBUG-FUNCTION to a DEBUG-FUNCTION. There should only be one
318 ;;; DEBUG-FUNCTION in existence for any function; that is, all
319 ;;; code-locations and other objects that reference DEBUG-FUNCTIONs
320 ;;; point to unique objects. This is due to the overhead in cached
322 (defstruct (debug-function (:copier nil))
323 ;; Some representation of the function arguments. See
324 ;; DEBUG-FUNCTION-LAMBDA-LIST.
325 ;; NOTE: must parse vars before parsing arg list stuff.
326 (%lambda-list :unparsed)
327 ;; Cached DEBUG-VARS information. (unexported).
328 ;; These are sorted by their name.
329 (%debug-vars :unparsed :type (or simple-vector null (member :unparsed)))
330 ;; Cached debug-block information. This is NIL when we have tried to
331 ;; parse the packed binary info, but none is available.
332 (blocks :unparsed :type (or simple-vector null (member :unparsed)))
333 ;; The actual function if available.
334 (%function :unparsed :type (or null function (member :unparsed))))
335 (def!method print-object ((obj debug-function) stream)
336 (print-unreadable-object (obj stream :type t)
337 (prin1 (debug-function-name obj) stream)))
339 (defstruct (compiled-debug-function
340 (:include debug-function)
341 (:constructor %make-compiled-debug-function
342 (compiler-debug-fun component))
344 ;; Compiler's dumped debug-function information. (unexported).
345 (compiler-debug-fun nil :type sb!c::compiled-debug-function)
346 ;; Code object. (unexported).
348 ;; The :FUNCTION-START breakpoint (if any) used to facilitate
349 ;; function end breakpoints.
350 (end-starter nil :type (or null breakpoint)))
352 ;;; This maps SB!C::COMPILED-DEBUG-FUNCTIONs to
353 ;;; COMPILED-DEBUG-FUNCTIONs, so we can get at cached stuff and not
354 ;;; duplicate COMPILED-DEBUG-FUNCTION structures.
355 (defvar *compiled-debug-functions* (make-hash-table :test 'eq))
357 ;;; Make a COMPILED-DEBUG-FUNCTION for a SB!C::COMPILER-DEBUG-FUNCTION
358 ;;; and its component. This maps the latter to the former in
359 ;;; *COMPILED-DEBUG-FUNCTIONS*. If there already is a
360 ;;; COMPILED-DEBUG-FUNCTION, then this returns it from
361 ;;; *COMPILED-DEBUG-FUNCTIONS*.
362 (defun make-compiled-debug-function (compiler-debug-fun component)
363 (or (gethash compiler-debug-fun *compiled-debug-functions*)
364 (setf (gethash compiler-debug-fun *compiled-debug-functions*)
365 (%make-compiled-debug-function compiler-debug-fun component))))
367 (defstruct (interpreted-debug-function
368 (:include debug-function)
369 (:constructor %make-interpreted-debug-function (ir1-lambda))
371 ;; This is the IR1 lambda that this debug-function represents.
372 (ir1-lambda nil :type sb!c::clambda))
374 (defstruct (bogus-debug-function
375 (:include debug-function)
376 (:constructor make-bogus-debug-function
377 (%name &aux (%lambda-list nil) (%debug-vars nil)
378 (blocks nil) (%function nil)))
382 (defvar *ir1-lambda-debug-function* (make-hash-table :test 'eq))
384 (defun make-interpreted-debug-function (ir1-lambda)
385 (let ((home-lambda (sb!c::lambda-home ir1-lambda)))
386 (or (gethash home-lambda *ir1-lambda-debug-function*)
387 (setf (gethash home-lambda *ir1-lambda-debug-function*)
388 (%make-interpreted-debug-function home-lambda)))))
392 ;;; These exist for caching data stored in packed binary form in compiler
394 (defstruct (debug-block (:constructor nil)
396 ;; Code-locations where execution continues after this block.
397 (successors nil :type list)
398 ;; This indicates whether the block is a special glob of code shared by
399 ;; various functions and tucked away elsewhere in a component. This kind of
400 ;; block has no start code-location. In an interpreted-debug-block, this is
401 ;; always nil. This slot is in all debug-blocks since it is an exported
403 (elsewhere-p nil :type boolean))
404 (def!method print-object ((obj debug-block) str)
405 (print-unreadable-object (obj str :type t)
406 (prin1 (debug-block-function-name obj) str)))
409 (setf (fdocumentation 'debug-block-successors 'function)
410 "Returns the list of possible code-locations where execution may continue
411 when the basic-block represented by debug-block completes its execution.")
414 (setf (fdocumentation 'debug-block-elsewhere-p 'function)
415 "Returns whether debug-block represents elsewhere code.")
417 (defstruct (compiled-debug-block (:include debug-block)
419 make-compiled-debug-block
420 (code-locations successors elsewhere-p))
422 ;; code-location information for the block
423 (code-locations nil :type simple-vector))
425 (defstruct (interpreted-debug-block (:include debug-block
427 (:constructor %make-interpreted-debug-block
430 ;; This is the IR1 block this debug-block represents.
431 (ir1-block nil :type sb!c::cblock)
432 ;; Code-location information for the block.
433 (locations :unparsed :type (or (member :unparsed) simple-vector)))
435 (defvar *ir1-block-debug-block* (make-hash-table :test 'eq))
437 ;;; Make a DEBUG-BLOCK for the interpreter's IR1-BLOCK. If we have it
438 ;;; in the cache, return it. If we need to make it, then first make
439 ;;; DEBUG-BLOCKs for all the IR1-BLOCKs in IR1-BLOCK's home lambda;
440 ;;; this makes sure all the successors of IR1-BLOCK have DEBUG-BLOCKs.
441 ;;; We need this to fill in the resulting DEBUG-BLOCK's successors
442 ;;; list with DEBUG-BLOCKs, not IR1-BLOCKs. After making all the
443 ;;; possible DEBUG-BLOCKs we'll need to reference, go back over the
444 ;;; list of new DEBUG-BLOCKs and fill in their successor slots with
445 ;;; lists of DEBUG-BLOCKs. Then look up our argument IR1-BLOCK to find
446 ;;; its DEBUG-BLOCK since we know we have it now.
447 (defun make-interpreted-debug-block (ir1-block)
448 (declare (type sb!c::cblock ir1-block))
449 (let ((res (gethash ir1-block *ir1-block-debug-block*)))
451 (let ((lambda (sb!c::block-home-lambda ir1-block)))
452 (sb!c::do-blocks (block (sb!c::block-component ir1-block))
453 (when (eq lambda (sb!c::block-home-lambda block))
454 (push (setf (gethash block *ir1-block-debug-block*)
455 (%make-interpreted-debug-block block))
458 (let* ((successors nil)
459 (cblock (interpreted-debug-block-ir1-block block))
460 (succ (sb!c::block-succ cblock))
464 (sb!c::component-tail
465 (sb!c::block-component cblock))))
468 (dolist (sblock valid-succ)
469 (let ((dblock (gethash sblock *ir1-block-debug-block*)))
471 (push dblock successors))))
472 (setf (debug-block-successors block) (nreverse successors))))
473 (gethash ir1-block *ir1-block-debug-block*)))))
477 ;;; This is an internal structure that manages information about a
478 ;;; breakpoint locations. See *COMPONENT-BREAKPOINT-OFFSETS*.
479 (defstruct (breakpoint-data (:constructor make-breakpoint-data
482 ;; This is the component in which the breakpoint lies.
484 ;; This is the byte offset into the component.
485 (offset nil :type sb!c::index)
486 ;; The original instruction replaced by the breakpoint.
487 (instruction nil :type (or null (unsigned-byte 32)))
488 ;; A list of user breakpoints at this location.
489 (breakpoints nil :type list))
490 (def!method print-object ((obj breakpoint-data) str)
491 (print-unreadable-object (obj str :type t)
492 (format str "~S at ~S"
494 (debug-function-from-pc (breakpoint-data-component obj)
495 (breakpoint-data-offset obj)))
496 (breakpoint-data-offset obj))))
498 (defstruct (breakpoint (:constructor %make-breakpoint
499 (hook-function what kind %info))
501 ;; This is the function invoked when execution encounters the
502 ;; breakpoint. It takes a frame, the breakpoint, and optionally a
503 ;; list of values. Values are supplied for :FUNCTION-END breakpoints
504 ;; as values to return for the function containing the breakpoint.
505 ;; :FUNCTION-END breakpoint hook-functions also take a cookie
506 ;; argument. See COOKIE-FUN slot.
507 (hook-function nil :type function)
508 ;; CODE-LOCATION or DEBUG-FUNCTION
509 (what nil :type (or code-location debug-function))
510 ;; :CODE-LOCATION, :FUNCTION-START, or :FUNCTION-END for that kind
511 ;; of breakpoint. :UNKNOWN-RETURN-PARTNER if this is the partner of
512 ;; a :code-location breakpoint at an :UNKNOWN-RETURN code-location.
513 (kind nil :type (member :code-location :function-start :function-end
514 :unknown-return-partner))
515 ;; Status helps the user and the implementation.
516 (status :inactive :type (member :active :inactive :deleted))
517 ;; This is a backpointer to a breakpoint-data.
518 (internal-data nil :type (or null breakpoint-data))
519 ;; With code-locations whose type is :UNKNOWN-RETURN, there are
520 ;; really two breakpoints: one at the multiple-value entry point,
521 ;; and one at the single-value entry point. This slot holds the
522 ;; breakpoint for the other one, or NIL if this isn't at an
523 ;; :UNKNOWN-RETURN code location.
524 (unknown-return-partner nil :type (or null breakpoint))
525 ;; :FUNCTION-END breakpoints use a breakpoint at the :FUNCTION-START
526 ;; to establish the end breakpoint upon function entry. We do this
527 ;; by frobbing the LRA to jump to a special piece of code that
528 ;; breaks and provides the return values for the returnee. This slot
529 ;; points to the start breakpoint, so we can activate, deactivate,
531 (start-helper nil :type (or null breakpoint))
532 ;; This is a hook users supply to get a dynamically unique cookie
533 ;; for identifying :FUNCTION-END breakpoint executions. That is, if
534 ;; there is one :FUNCTION-END breakpoint, but there may be multiple
535 ;; pending calls of its function on the stack. This function takes
536 ;; the cookie, and the hook-function takes the cookie too.
537 (cookie-fun nil :type (or null function))
538 ;; This slot users can set with whatever information they find useful.
540 (def!method print-object ((obj breakpoint) str)
541 (let ((what (breakpoint-what obj)))
542 (print-unreadable-object (obj str :type t)
547 (debug-function (debug-function-name what)))
550 (debug-function (breakpoint-kind obj)))))))
553 (setf (fdocumentation 'breakpoint-hook-function 'function)
554 "Returns the breakpoint's function the system calls when execution encounters
555 the breakpoint, and it is active. This is SETF'able.")
558 (setf (fdocumentation 'breakpoint-what 'function)
559 "Returns the breakpoint's what specification.")
562 (setf (fdocumentation 'breakpoint-kind 'function)
563 "Returns the breakpoint's kind specification.")
567 (defstruct (code-location (:constructor nil)
569 ;; This is the debug-function containing code-location.
570 (debug-function nil :type debug-function)
571 ;; This is initially :UNSURE. Upon first trying to access an
572 ;; :unparsed slot, if the data is unavailable, then this becomes t,
573 ;; and the code-location is unknown. If the data is available, this
574 ;; becomes nil, a known location. We can't use a separate type
575 ;; code-location for this since we must return code-locations before
576 ;; we can tell whether they're known or unknown. For example, when
577 ;; parsing the stack, we don't want to unpack all the variables and
578 ;; blocks just to make frames.
579 (%unknown-p :unsure :type (member t nil :unsure))
580 ;; This is the debug-block containing code-location. Possibly toss
581 ;; this out and just find it in the blocks cache in debug-function.
582 (%debug-block :unparsed :type (or debug-block (member :unparsed)))
583 ;; This is the number of forms processed by the compiler or loader
584 ;; before the top-level form containing this code-location.
585 (%tlf-offset :unparsed :type (or sb!c::index (member :unparsed)))
586 ;; This is the depth-first number of the node that begins
587 ;; code-location within its top-level form.
588 (%form-number :unparsed :type (or sb!c::index (member :unparsed))))
589 (def!method print-object ((obj code-location) str)
590 (print-unreadable-object (obj str :type t)
591 (prin1 (debug-function-name (code-location-debug-function obj))
595 (setf (fdocumentation 'code-location-debug-function 'function)
596 "Returns the debug-function representing information about the function
597 corresponding to the code-location.")
599 (defstruct (compiled-code-location
600 (:include code-location)
601 (:constructor make-known-code-location
602 (pc debug-function %tlf-offset %form-number
603 %live-set kind &aux (%unknown-p nil)))
604 (:constructor make-compiled-code-location (pc debug-function))
606 ;; This is an index into debug-function's component slot.
607 (pc nil :type sb!c::index)
608 ;; This is a bit-vector indexed by a variable's position in
609 ;; DEBUG-FUNCTION-DEBUG-VARS indicating whether the variable has a
610 ;; valid value at this code-location. (unexported).
611 (%live-set :unparsed :type (or simple-bit-vector (member :unparsed)))
612 ;; (unexported) To see SB!C::LOCATION-KIND, do
613 ;; (SB!KERNEL:TYPE-EXPAND 'SB!C::LOCATION-KIND).
614 (kind :unparsed :type (or (member :unparsed) sb!c::location-kind)))
616 (defstruct (interpreted-code-location
617 (:include code-location
619 (:constructor make-interpreted-code-location
620 (ir1-node debug-function))
622 ;; This is an index into debug-function's component slot.
623 (ir1-node nil :type sb!c::node))
627 #!-sb-fluid (declaim (inline debug-source-root-number))
628 (defun debug-source-root-number (debug-source)
630 "Returns the number of top-level forms processed by the compiler before
631 compiling this source. If this source is uncompiled, this is zero. This
632 may be zero even if the source is compiled since the first form in the first
633 file compiled in one compilation, for example, must have a root number of
634 zero -- the compiler saw no other top-level forms before it."
635 (sb!c::debug-source-source-root debug-source))
638 (setf (fdocumentation 'sb!c::debug-source-from 'function)
639 "Returns an indication of the type of source. The following are the possible
641 :file from a file (obtained by COMPILE-FILE if compiled).
642 :lisp from Lisp (obtained by COMPILE if compiled).")
645 (setf (fdocumentation 'sb!c::debug-source-name 'function)
646 "Returns the actual source in some sense represented by debug-source, which
647 is related to DEBUG-SOURCE-FROM:
648 :file the pathname of the file.
649 :lisp a lambda-expression.")
652 (setf (fdocumentation 'sb!c::debug-source-created 'function)
653 "Returns the universal time someone created the source. This may be nil if
657 (setf (fdocumentation 'sb!c::debug-source-compiled 'function)
658 "Returns the time someone compiled the source. This is nil if the source
662 (setf (fdocumentation 'sb!c::debug-source-start-positions 'function)
663 "This function returns the file position of each top-level form as an array
664 if debug-source is from a :file. If DEBUG-SOURCE-FROM is :lisp,
668 (setf (fdocumentation 'sb!c::debug-source-p 'function)
669 "Returns whether object is a debug-source.")
673 ;;; This is used in FIND-ESCAPED-FRAME and with the bogus components
674 ;;; and LRAs used for :function-end breakpoints. When a components
675 ;;; debug-info slot is :bogus-lra, then the real-lra-slot contains the
676 ;;; real component to continue executing, as opposed to the bogus
677 ;;; component which appeared in some frame's LRA location.
678 (defconstant real-lra-slot sb!vm:code-constants-offset)
680 ;;; These are magically converted by the compiler.
681 (defun current-sp () (current-sp))
682 (defun current-fp () (current-fp))
683 (defun stack-ref (s n) (stack-ref s n))
684 (defun %set-stack-ref (s n value) (%set-stack-ref s n value))
685 (defun function-code-header (fun) (function-code-header fun))
686 #!-gengc (defun lra-code-header (lra) (lra-code-header lra))
687 (defun make-lisp-obj (value) (make-lisp-obj value))
688 (defun get-lisp-obj-address (thing) (get-lisp-obj-address thing))
689 (defun function-word-offset (fun) (function-word-offset fun))
691 #!-sb-fluid (declaim (inline cstack-pointer-valid-p))
692 (defun cstack-pointer-valid-p (x)
693 (declare (type system-area-pointer x))
694 #!-x86 ; stack grows toward high address values
695 (and (sap< x (current-sp))
696 (sap<= #!-gengc (int-sap control-stack-start)
697 #!+gengc (mutator-control-stack-base)
699 (zerop (logand (sap-int x) #b11)))
700 #!+x86 ; stack grows toward low address values
701 (and (sap>= x (current-sp))
702 (sap> (int-sap control-stack-end) x)
703 (zerop (logand (sap-int x) #b11))))
706 (sb!alien:def-alien-routine component-ptr-from-pc (system-area-pointer)
707 (pc system-area-pointer))
710 (defun component-from-component-ptr (component-ptr)
711 (declare (type system-area-pointer component-ptr))
712 (make-lisp-obj (logior (sap-int component-ptr)
713 sb!vm:other-pointer-type)))
720 (defun compute-lra-data-from-pc (pc)
721 (declare (type system-area-pointer pc))
722 (let ((component-ptr (component-ptr-from-pc pc)))
723 (unless (sap= component-ptr (int-sap #x0))
724 (let* ((code (component-from-component-ptr component-ptr))
725 (code-header-len (* (get-header-data code) sb!vm:word-bytes))
726 (pc-offset (- (sap-int pc)
727 (- (get-lisp-obj-address code)
728 sb!vm:other-pointer-type)
730 ; (format t "c-lra-fpc ~A ~A ~A~%" pc code pc-offset)
731 (values pc-offset code)))))
733 (defconstant sb!vm::nargs-offset #.sb!vm::ecx-offset)
735 ;;; Check for a valid return address - it could be any valid C/Lisp
738 ;;; XXX Could be a little smarter.
739 #!-sb-fluid (declaim (inline ra-pointer-valid-p))
740 (defun ra-pointer-valid-p (ra)
741 (declare (type system-area-pointer ra))
743 ;; Not the first page which is unmapped.
744 (>= (sap-int ra) 4096)
745 ;; Not a Lisp stack pointer.
746 (not (cstack-pointer-valid-p ra))))
748 ;;; Try to find a valid previous stack. This is complex on the x86 as
749 ;;; it can jump between C and Lisp frames. To help find a valid frame
750 ;;; it searches backwards.
752 ;;; XXX Should probably check whether it has reached the bottom of the
755 ;;; XXX Should handle interrupted frames, both Lisp and C. At present
756 ;;; it manages to find a fp trail, see linux hack below.
757 (defun x86-call-context (fp &key (depth 0))
758 (declare (type system-area-pointer fp)
760 ;;(format t "*CC ~S ~S~%" fp depth)
762 ((not (cstack-pointer-valid-p fp))
763 #+nil (format t "debug invalid fp ~S~%" fp)
766 ;; Check the two possible frame pointers.
767 (let ((lisp-ocfp (sap-ref-sap fp (- (* (1+ sb!vm::ocfp-save-offset) 4))))
768 (lisp-ra (sap-ref-sap fp (- (* (1+ sb!vm::return-pc-save-offset)
770 (c-ocfp (sap-ref-sap fp (* 0 sb!vm:word-bytes)))
771 (c-ra (sap-ref-sap fp (* 1 sb!vm:word-bytes))))
772 (cond ((and (sap> lisp-ocfp fp) (cstack-pointer-valid-p lisp-ocfp)
773 (ra-pointer-valid-p lisp-ra)
774 (sap> c-ocfp fp) (cstack-pointer-valid-p c-ocfp)
775 (ra-pointer-valid-p c-ra))
777 "*C Both valid ~S ~S ~S ~S~%"
778 lisp-ocfp lisp-ra c-ocfp c-ra)
779 ;; Look forward another step to check their validity.
780 (let ((lisp-path-fp (x86-call-context lisp-ocfp
782 (c-path-fp (x86-call-context c-ocfp :depth (1+ depth))))
783 (cond ((and lisp-path-fp c-path-fp)
784 ;; Both still seem valid - choose the lisp frame.
785 #+nil (when (zerop depth)
787 "debug: both still valid ~S ~S ~S ~S~%"
788 lisp-ocfp lisp-ra c-ocfp c-ra))
790 (if (sap> lisp-ocfp c-ocfp)
791 (values lisp-ra lisp-ocfp)
792 (values c-ra c-ocfp))
794 (values lisp-ra lisp-ocfp))
796 ;; The lisp convention is looking good.
797 #+nil (format t "*C lisp-ocfp ~S ~S~%" lisp-ocfp lisp-ra)
798 (values lisp-ra lisp-ocfp))
800 ;; The C convention is looking good.
801 #+nil (format t "*C c-ocfp ~S ~S~%" c-ocfp c-ra)
802 (values c-ra c-ocfp))
804 ;; Neither seems right?
805 #+nil (format t "debug: no valid2 fp found ~S ~S~%"
808 ((and (sap> lisp-ocfp fp) (cstack-pointer-valid-p lisp-ocfp)
809 (ra-pointer-valid-p lisp-ra))
810 ;; The lisp convention is looking good.
811 #+nil (format t "*C lisp-ocfp ~S ~S~%" lisp-ocfp lisp-ra)
812 (values lisp-ra lisp-ocfp))
813 ((and (sap> c-ocfp fp) (cstack-pointer-valid-p c-ocfp)
814 #!-linux (ra-pointer-valid-p c-ra))
815 ;; The C convention is looking good.
816 #+nil (format t "*C c-ocfp ~S ~S~%" c-ocfp c-ra)
817 (values c-ra c-ocfp))
819 #+nil (format t "debug: no valid fp found ~S ~S~%"
825 ;;; Convert the descriptor into a SAP. The bits all stay the same, we just
826 ;;; change our notion of what we think they are.
827 #!-sb-fluid (declaim (inline descriptor-sap))
828 (defun descriptor-sap (x)
829 (int-sap (get-lisp-obj-address x)))
833 "Returns the top frame of the control stack as it was before calling this
835 (multiple-value-bind (fp pc) (%caller-frame-and-pc)
836 (possibly-an-interpreted-frame
837 (compute-calling-frame (descriptor-sap fp)
838 #!-gengc pc #!+gengc (descriptor-sap pc)
842 (defun flush-frames-above (frame)
844 "Flush all of the frames above FRAME, and renumber all the frames below
846 (setf (frame-up frame) nil)
847 (do ((number 0 (1+ number))
848 (frame frame (frame-%down frame)))
849 ((not (frame-p frame)))
850 (setf (frame-number frame) number)))
852 ;;; We have to access the old-fp and return-pc out of frame and pass them to
853 ;;; COMPUTE-CALLING-FRAME.
854 (defun frame-down (frame)
856 "Returns the frame immediately below frame on the stack. When frame is
857 the bottom of the stack, this returns nil."
858 (let ((down (frame-%down frame)))
859 (if (eq down :unparsed)
860 (let* ((real (frame-real-frame frame))
861 (debug-fun (frame-debug-function real)))
862 (setf (frame-%down frame)
864 (compiled-debug-function
865 (let ((c-d-f (compiled-debug-function-compiler-debug-fun
867 (possibly-an-interpreted-frame
868 (compute-calling-frame
871 real sb!vm::ocfp-save-offset
872 (sb!c::compiled-debug-function-old-fp c-d-f)))
875 real sb!vm::lra-save-offset
876 (sb!c::compiled-debug-function-return-pc c-d-f))
880 real sb!vm::ra-save-offset
881 (sb!c::compiled-debug-function-return-pc c-d-f)))
884 (bogus-debug-function
885 (let ((fp (frame-pointer real)))
886 (when (cstack-pointer-valid-p fp)
888 (multiple-value-bind (ra ofp) (x86-call-context fp)
889 (compute-calling-frame ofp ra frame))
891 (compute-calling-frame
893 (sap-ref-sap fp (* sb!vm::ocfp-save-offset
897 (sap-ref-32 fp (* sb!vm::ocfp-save-offset
901 (stack-ref fp sb!vm::lra-save-offset)
903 (sap-ref-sap fp (* sb!vm::ra-save-offset
908 ;;; Get the old FP or return PC out of FRAME. STACK-SLOT is the
909 ;;; standard save location offset on the stack. LOC is the saved
910 ;;; SC-OFFSET describing the main location.
912 (defun get-context-value (frame stack-slot loc)
913 (declare (type compiled-frame frame) (type unsigned-byte stack-slot)
914 (type sb!c::sc-offset loc))
915 (let ((pointer (frame-pointer frame))
916 (escaped (compiled-frame-escaped frame)))
918 (sub-access-debug-var-slot pointer loc escaped)
919 (stack-ref pointer stack-slot))))
921 (defun get-context-value (frame stack-slot loc)
922 (declare (type compiled-frame frame) (type unsigned-byte stack-slot)
923 (type sb!c::sc-offset loc))
924 (let ((pointer (frame-pointer frame))
925 (escaped (compiled-frame-escaped frame)))
927 (sub-access-debug-var-slot pointer loc escaped)
929 (#.sb!vm::ocfp-save-offset
930 (stack-ref pointer stack-slot))
931 (#.sb!vm::lra-save-offset
932 (sap-ref-sap pointer (- (* (1+ stack-slot) 4))))))))
935 (defun (setf get-context-value) (value frame stack-slot loc)
936 (declare (type compiled-frame frame) (type unsigned-byte stack-slot)
937 (type sb!c::sc-offset loc))
938 (let ((pointer (frame-pointer frame))
939 (escaped (compiled-frame-escaped frame)))
941 (sub-set-debug-var-slot pointer loc value escaped)
942 (setf (stack-ref pointer stack-slot) value))))
945 (defun (setf get-context-value) (value frame stack-slot loc)
946 (declare (type compiled-frame frame) (type unsigned-byte stack-slot)
947 (type sb!c::sc-offset loc))
948 (let ((pointer (frame-pointer frame))
949 (escaped (compiled-frame-escaped frame)))
951 (sub-set-debug-var-slot pointer loc value escaped)
953 (#.sb!vm::ocfp-save-offset
954 (setf (stack-ref pointer stack-slot) value))
955 (#.sb!vm::lra-save-offset
956 (setf (sap-ref-sap pointer (- (* (1+ stack-slot) 4))) value))))))
958 ;;; This doesn't do anything in sbcl-0.7.0, since the functionality
959 ;;; was lost in the switch from IR1 interpreter to bytecode interpreter.
960 ;;; However, it might be revived someday. (See the FIXME for
961 ;;; POSSIBLY-AN-INTERPRETED-FRAME.)
963 ;;; (defvar *debugging-interpreter* nil
965 ;;; "When set, the debugger foregoes making interpreted frames, so you can
966 ;;; debug the functions that manifest the interpreter.")
968 ;;; FIXME: In CMU CL with the IR1 interpreter, this did
969 ;;; This takes a newly computed frame, FRAME, and the frame above it
970 ;;; on the stack, UP-FRAME, which is possibly NIL. FRAME is NIL when
971 ;;; we hit the bottom of the control stack. When FRAME represents a
972 ;;; call to SB!BYTECODE::INTERNAL-APPLY-LOOP, we make an interpreted frame
973 ;;; to replace FRAME. The interpreted frame points to FRAME.
974 ;;; When SBCL switch to a byte interpreter, this functionality wasn't
975 ;;; updated, so now when you try to "debug byte code", you actually
976 ;;; end up debugging the byte interpreter instead. It might be good
977 ;;; to update the old CMU CL functionality so that you can really
978 ;;; debug byte code instead of seeing a bunch of confusing byte
979 ;;; interpreter implementation stuff.
980 (defun possibly-an-interpreted-frame (frame up-frame)
982 ;; new SBCL code, not whizzy enough to do anything tricky like
983 ;; hiding the byte interpreter when debugging
984 (declare (ignore up-frame))
987 ;; old CMU CL code to hide IR1 interpreter when debugging
989 ;;(if (or (not frame)
990 ;; (not (eq (debug-function-name (frame-debug-function
992 ;; 'sb!bytecode::internal-apply-loop))
993 ;; *debugging-interpreter*
994 ;; (compiled-frame-escaped frame))
996 ;; (flet ((get-var (name location)
997 ;; (let ((vars (sb!di:ambiguous-debug-vars
998 ;; (sb!di:frame-debug-function frame) name)))
999 ;; (when (or (null vars) (> (length vars) 1))
1000 ;; (error "zero or more than one ~A variable in ~
1001 ;; SB!BYTECODE::INTERNAL-APPLY-LOOP"
1002 ;; (string-downcase name)))
1003 ;; (if (eq (debug-var-validity (car vars) location)
1006 ;; (let* ((code-loc (frame-code-location frame))
1007 ;; (ptr-var (get-var "FRAME-PTR" code-loc))
1008 ;; (node-var (get-var "NODE" code-loc))
1009 ;; (closure-var (get-var "CLOSURE" code-loc)))
1010 ;; (if (and ptr-var node-var closure-var)
1011 ;; (let* ((node (debug-var-value node-var frame))
1012 ;; (d-fun (make-interpreted-debug-function
1013 ;; (sb!c::block-home-lambda (sb!c::node-block
1015 ;; (make-interpreted-frame
1016 ;; (debug-var-value ptr-var frame)
1019 ;; (make-interpreted-code-location node d-fun)
1020 ;; (frame-number frame)
1022 ;; (debug-var-value closure-var frame)))
1026 ;;; This returns a frame for the one existing in time immediately
1027 ;;; prior to the frame referenced by current-fp. This is current-fp's
1028 ;;; caller or the next frame down the control stack. If there is no
1029 ;;; down frame, this returns nil for the bottom of the stack. Up-frame
1030 ;;; is the up link for the resulting frame object, and it is nil when
1031 ;;; we call this to get the top of the stack.
1033 ;;; The current frame contains the pointer to the temporally previous
1034 ;;; frame we want, and the current frame contains the pc at which we
1035 ;;; will continue executing upon returning to that previous frame.
1037 ;;; Note: Sometimes LRA is actually a fixnum. This happens when lisp
1038 ;;; calls into C. In this case, the code object is stored on the stack
1039 ;;; after the LRA, and the LRA is the word offset.
1041 (defun compute-calling-frame (caller lra up-frame)
1042 (declare (type system-area-pointer caller))
1043 (when (cstack-pointer-valid-p caller)
1044 (multiple-value-bind (code pc-offset escaped)
1046 (multiple-value-bind (word-offset code)
1048 (let ((fp (frame-pointer up-frame)))
1050 (stack-ref fp (1+ sb!vm::lra-save-offset))))
1051 (values (get-header-data lra)
1052 (lra-code-header lra)))
1055 (* (1+ (- word-offset (get-header-data code)))
1058 (values :foreign-function
1061 (find-escaped-frame caller))
1062 (if (and (code-component-p code)
1063 (eq (%code-debug-info code) :bogus-lra))
1064 (let ((real-lra (code-header-ref code real-lra-slot)))
1065 (compute-calling-frame caller real-lra up-frame))
1066 (let ((d-fun (case code
1067 (:undefined-function
1068 (make-bogus-debug-function
1069 "undefined function"))
1071 (make-bogus-debug-function
1072 "foreign function call land"))
1074 (make-bogus-debug-function
1075 "bogus stack frame"))
1077 (debug-function-from-pc code pc-offset)))))
1078 (make-compiled-frame caller up-frame d-fun
1079 (code-location-from-pc d-fun pc-offset
1081 (if up-frame (1+ (frame-number up-frame)) 0)
1085 (defun compute-calling-frame (caller ra up-frame)
1086 (declare (type system-area-pointer caller ra))
1087 (when (cstack-pointer-valid-p caller)
1088 ;; First check for an escaped frame.
1089 (multiple-value-bind (code pc-offset escaped) (find-escaped-frame caller)
1091 ;; If it's escaped it may be a function end breakpoint trap.
1092 (when (and (code-component-p code)
1093 (eq (%code-debug-info code) :bogus-lra))
1094 ;; If :bogus-lra grab the real lra.
1095 (setq pc-offset (code-header-ref
1096 code (1+ real-lra-slot)))
1097 (setq code (code-header-ref code real-lra-slot))
1101 (multiple-value-setq (pc-offset code)
1102 (compute-lra-data-from-pc ra))
1104 (setf code :foreign-function
1108 (let ((d-fun (case code
1109 (:undefined-function
1110 (make-bogus-debug-function
1111 "undefined function"))
1113 (make-bogus-debug-function
1114 "foreign function call land"))
1116 (make-bogus-debug-function
1117 "bogus stack frame"))
1119 (debug-function-from-pc code pc-offset)))))
1120 (make-compiled-frame caller up-frame d-fun
1121 (code-location-from-pc d-fun pc-offset
1123 (if up-frame (1+ (frame-number up-frame)) 0)
1127 (defun find-escaped-frame (frame-pointer)
1128 (declare (type system-area-pointer frame-pointer))
1129 (dotimes (index *free-interrupt-context-index* (values nil 0 nil))
1130 (sb!alien:with-alien
1131 ((lisp-interrupt-contexts (array (* os-context-t) nil)
1133 (let ((context (sb!alien:deref lisp-interrupt-contexts index)))
1134 (when (= (sap-int frame-pointer)
1135 (sb!vm:context-register context sb!vm::cfp-offset))
1137 (let* ((component-ptr (component-ptr-from-pc
1138 (sb!vm:context-pc context)))
1139 (code (unless (sap= component-ptr (int-sap #x0))
1140 (component-from-component-ptr component-ptr))))
1142 (return (values code 0 context)))
1143 (let* ((code-header-len (* (get-header-data code)
1146 (- (sap-int (sb!vm:context-pc context))
1147 (- (get-lisp-obj-address code)
1148 sb!vm:other-pointer-type)
1150 (unless (<= 0 pc-offset
1151 (* (code-header-ref code sb!vm:code-code-size-slot)
1153 ;; We were in an assembly routine. Therefore, use the
1156 ;; FIXME: Should this be WARN or ERROR or what?
1157 (format t "** pc-offset ~S not in code obj ~S?~%"
1160 (values code pc-offset context))))))))))
1163 (defun find-escaped-frame (frame-pointer)
1164 (declare (type system-area-pointer frame-pointer))
1165 (dotimes (index *free-interrupt-context-index* (values nil 0 nil))
1166 (sb!alien:with-alien
1167 ((lisp-interrupt-contexts (array (* os-context-t) nil) :extern))
1168 (let ((scp (sb!alien:deref lisp-interrupt-contexts index)))
1169 (when (= (sap-int frame-pointer)
1170 (sb!vm:context-register scp sb!vm::cfp-offset))
1172 (let ((code (code-object-from-bits
1173 (sb!vm:context-register scp sb!vm::code-offset))))
1174 (when (symbolp code)
1175 (return (values code 0 scp)))
1176 (let* ((code-header-len (* (get-header-data code)
1179 (- (sap-int (sb!vm:context-pc scp))
1180 (- (get-lisp-obj-address code)
1181 sb!vm:other-pointer-type)
1183 ;; Check to see whether we were executing in a branch
1185 #!+(or pmax sgi) ; pmax only (and broken anyway)
1186 (when (logbitp 31 (sb!alien:slot scp '%mips::sc-cause))
1187 (incf pc-offset sb!vm:word-bytes))
1188 (unless (<= 0 pc-offset
1189 (* (code-header-ref code sb!vm:code-code-size-slot)
1191 ;; We were in an assembly routine. Therefore, use the
1194 (- (sb!vm:context-register scp sb!vm::lra-offset)
1195 (get-lisp-obj-address code)
1198 (if (eq (%code-debug-info code) :bogus-lra)
1199 (let ((real-lra (code-header-ref code
1201 (values (lra-code-header real-lra)
1202 (get-header-data real-lra)
1204 (values code pc-offset scp)))))))))))
1206 ;;; Find the code object corresponding to the object represented by
1207 ;;; bits and return it. We assume bogus functions correspond to the
1208 ;;; undefined-function.
1210 (defun code-object-from-bits (bits)
1211 (declare (type (unsigned-byte 32) bits))
1212 (let ((object (make-lisp-obj bits)))
1213 (if (functionp object)
1214 (or (function-code-header object)
1215 :undefined-function)
1216 (let ((lowtag (get-lowtag object)))
1217 (if (= lowtag sb!vm:other-pointer-type)
1218 (let ((type (get-type object)))
1219 (cond ((= type sb!vm:code-header-type)
1221 ((= type sb!vm:return-pc-header-type)
1222 (lra-code-header object))
1226 ;;; SB!KERNEL:*SAVED-STATE-CHAIN* -- maintained by the C code as a
1227 ;;; list of SAPs, each SAP pointing to a saved exception state.
1229 (declaim (special *saved-state-chain*))
1232 ;;; (DEFUN LOOKUP-TRACE-TABLE-ENTRY (COMPONENT PC) ..)
1233 ;;; for this case, but it hasn't been maintained in SBCL.
1235 (eval-when (:compile-toplevel :load-toplevel :execute)
1236 (error "hopelessly stale"))
1239 ;;; (DEFUN EXTRACT-INFO-FROM-STATE (STATE) ..)
1240 ;;; for this case, but it hasn't been maintained in SBCL.
1242 (eval-when (:compile-toplevel :load-toplevel :execute)
1243 (error "hopelessly stale"))
1246 ;;; (DEFUN COMPUTE-CALLING-FRAME (OCFP RA UP-FRAME) ..)
1247 ;;; for this case, but it hasn't been maintained in SBCL.
1249 (eval-when (:compile-toplevel :load-toplevel :execute)
1250 (error "hopelessly stale"))
1252 ;;;; frame utilities
1254 ;;; This returns a COMPILED-DEBUG-FUNCTION for code and pc. We fetch
1255 ;;; the SB!C::DEBUG-INFO and run down its function-map to get a
1256 ;;; SB!C::COMPILED-DEBUG-FUNCTION from the pc. The result only needs
1257 ;;; to reference the component, for function constants, and the
1258 ;;; SB!C::COMPILED-DEBUG-FUNCTION.
1259 (defun debug-function-from-pc (component pc)
1260 (let ((info (%code-debug-info component)))
1263 (debug-signal 'no-debug-info :code-component component))
1264 ((eq info :bogus-lra)
1265 (make-bogus-debug-function "function end breakpoint"))
1267 (let* ((function-map (get-debug-info-function-map info))
1268 (len (length function-map)))
1269 (declare (simple-vector function-map))
1271 (make-compiled-debug-function (svref function-map 0) component)
1274 (>= pc (sb!c::compiled-debug-function-elsewhere-pc
1275 (svref function-map 0)))))
1276 (declare (type sb!int:index i))
1279 (< pc (if elsewhere-p
1280 (sb!c::compiled-debug-function-elsewhere-pc
1281 (svref function-map (1+ i)))
1282 (svref function-map i))))
1283 (return (make-compiled-debug-function
1284 (svref function-map (1- i))
1288 ;;; This returns a code-location for the COMPILED-DEBUG-FUNCTION,
1289 ;;; DEBUG-FUN, and the pc into its code vector. If we stopped at a
1290 ;;; breakpoint, find the CODE-LOCATION for that breakpoint. Otherwise,
1291 ;;; make an :UNSURE code location, so it can be filled in when we
1292 ;;; figure out what is going on.
1293 (defun code-location-from-pc (debug-fun pc escaped)
1294 (or (and (compiled-debug-function-p debug-fun)
1296 (let ((data (breakpoint-data
1297 (compiled-debug-function-component debug-fun)
1299 (when (and data (breakpoint-data-breakpoints data))
1300 (let ((what (breakpoint-what
1301 (first (breakpoint-data-breakpoints data)))))
1302 (when (compiled-code-location-p what)
1304 (make-compiled-code-location pc debug-fun)))
1306 (defun frame-catches (frame)
1308 "Returns an a-list mapping catch tags to code-locations. These are
1309 code-locations at which execution would continue with frame as the top
1310 frame if someone threw to the corresponding tag."
1312 #!-gengc (descriptor-sap *current-catch-block*)
1313 #!+gengc (mutator-current-catch-block))
1315 (fp (frame-pointer (frame-real-frame frame))))
1317 (when (zerop (sap-int catch)) (return (nreverse res)))
1321 (* sb!vm:catch-block-current-cont-slot
1326 (* sb!vm:catch-block-current-cont-slot
1327 sb!vm:word-bytes))))
1328 (let* (#!-(or gengc x86)
1329 (lra (stack-ref catch sb!vm:catch-block-entry-pc-slot))
1332 catch (* sb!vm:catch-block-entry-pc-slot
1336 (stack-ref catch sb!vm:catch-block-current-code-slot))
1338 (component (component-from-component-ptr
1339 (component-ptr-from-pc ra)))
1342 (* (- (1+ (get-header-data lra))
1343 (get-header-data component))
1347 (get-lisp-obj-address component)
1348 (get-header-data component))
1349 sb!vm:other-pointer-type)
1352 (- (get-lisp-obj-address component)
1353 sb!vm:other-pointer-type)
1354 (* (get-header-data component) sb!vm:word-bytes))))
1356 (stack-ref catch sb!vm:catch-block-tag-slot)
1359 (sap-ref-32 catch (* sb!vm:catch-block-tag-slot
1361 (make-compiled-code-location
1362 offset (frame-debug-function frame)))
1367 (* sb!vm:catch-block-previous-catch-slot
1372 (* sb!vm:catch-block-previous-catch-slot
1373 sb!vm:word-bytes)))))))
1375 ;;; If an interpreted frame, return the real frame, otherwise frame.
1376 (defun frame-real-frame (frame)
1378 (compiled-frame frame)
1379 (interpreted-frame (interpreted-frame-real-frame frame))))
1381 ;;;; operations on DEBUG-FUNCTIONs
1383 ;;; Execute the forms in a context with block-var bound to each
1384 ;;; debug-block in debug-function successively. Result is an optional
1385 ;;; form to execute for return values, and DO-DEBUG-FUNCTION-BLOCKS
1386 ;;; returns nil if there is no result form. This signals a
1387 ;;; no-debug-blocks condition when the debug-function lacks
1388 ;;; debug-block information.
1389 (defmacro do-debug-function-blocks ((block-var debug-function &optional result)
1391 (let ((blocks (gensym))
1393 `(let ((,blocks (debug-function-debug-blocks ,debug-function)))
1394 (declare (simple-vector ,blocks))
1395 (dotimes (,i (length ,blocks) ,result)
1396 (let ((,block-var (svref ,blocks ,i)))
1399 ;;; Execute body in a context with var bound to each debug-var in
1400 ;;; debug-function. This returns the value of executing result (defaults to
1401 ;;; nil). This may iterate over only some of debug-function's variables or none
1402 ;;; depending on debug policy; for example, possibly the compilation only
1403 ;;; preserved argument information.
1404 (defmacro do-debug-function-variables ((var debug-function &optional result)
1406 (let ((vars (gensym))
1408 `(let ((,vars (debug-function-debug-vars ,debug-function)))
1409 (declare (type (or null simple-vector) ,vars))
1411 (dotimes (,i (length ,vars) ,result)
1412 (let ((,var (svref ,vars ,i)))
1416 ;;; Return the Common Lisp function associated with the debug-function. This
1417 ;;; returns nil if the function is unavailable or is non-existent as a user
1418 ;;; callable function object.
1419 (defun debug-function-function (debug-function)
1420 (let ((cached-value (debug-function-%function debug-function)))
1421 (if (eq cached-value :unparsed)
1422 (setf (debug-function-%function debug-function)
1423 (etypecase debug-function
1424 (compiled-debug-function
1426 (compiled-debug-function-component debug-function))
1428 (sb!c::compiled-debug-function-start-pc
1429 (compiled-debug-function-compiler-debug-fun
1431 (do ((entry (%code-entry-points component)
1432 (%function-next entry)))
1435 (sb!c::compiled-debug-function-start-pc
1436 (compiled-debug-function-compiler-debug-fun
1437 (function-debug-function entry))))
1439 (interpreted-debug-function
1440 (sb!c::lambda-eval-info-function
1442 (interpreted-debug-function-ir1-lambda debug-function))))
1443 (bogus-debug-function nil)))
1446 ;;; Return the name of the function represented by debug-function. This may
1447 ;;; be a string or a cons; do not assume it is a symbol.
1448 (defun debug-function-name (debug-function)
1449 (etypecase debug-function
1450 (compiled-debug-function
1451 (sb!c::compiled-debug-function-name
1452 (compiled-debug-function-compiler-debug-fun debug-function)))
1453 (interpreted-debug-function
1454 (sb!c::lambda-name (interpreted-debug-function-ir1-lambda
1456 (bogus-debug-function
1457 (bogus-debug-function-%name debug-function))))
1459 ;;; Return a debug-function that represents debug information for function.
1460 (defun function-debug-function (fun)
1461 (ecase (get-type fun)
1462 (#.sb!vm:closure-header-type
1463 (function-debug-function (%closure-function fun)))
1464 (#.sb!vm:funcallable-instance-header-type
1465 (function-debug-function (funcallable-instance-function fun)))
1466 ((#.sb!vm:function-header-type #.sb!vm:closure-function-header-type)
1467 (let* ((name (%function-name fun))
1468 (component (function-code-header fun))
1471 (and (sb!c::compiled-debug-function-p x)
1472 (eq (sb!c::compiled-debug-function-name x) name)
1473 (eq (sb!c::compiled-debug-function-kind x) nil)))
1474 (get-debug-info-function-map
1475 (%code-debug-info component)))))
1477 (make-compiled-debug-function res component)
1478 ;; KLUDGE: comment from CMU CL:
1479 ;; This used to be the non-interpreted branch, but
1480 ;; William wrote it to return the debug-fun of fun's XEP
1481 ;; instead of fun's debug-fun. The above code does this
1482 ;; more correctly, but it doesn't get or eliminate all
1483 ;; appropriate cases. It mostly works, and probably
1484 ;; works for all named functions anyway.
1486 (debug-function-from-pc component
1487 (* (- (function-word-offset fun)
1488 (get-header-data component))
1489 sb!vm:word-bytes)))))))
1491 ;;; Return the kind of the function, which is one of :OPTIONAL,
1492 ;;; :EXTERNAL, TOP-level, :CLEANUP, or NIL.
1493 (defun debug-function-kind (debug-function)
1494 ;; FIXME: This "is one of" information should become part of the function
1495 ;; declamation, not just a doc string
1496 (etypecase debug-function
1497 (compiled-debug-function
1498 (sb!c::compiled-debug-function-kind
1499 (compiled-debug-function-compiler-debug-fun debug-function)))
1500 (interpreted-debug-function
1501 (sb!c::lambda-kind (interpreted-debug-function-ir1-lambda
1503 (bogus-debug-function
1506 ;;; Is there any variable information for DEBUG-FUNCTION?
1507 (defun debug-var-info-available (debug-function)
1508 (not (not (debug-function-debug-vars debug-function))))
1510 ;;; Return a list of debug-vars in debug-function having the same name
1511 ;;; and package as symbol. If symbol is uninterned, then this returns
1512 ;;; a list of debug-vars without package names and with the same name
1513 ;;; as symbol. The result of this function is limited to the
1514 ;;; availability of variable information in debug-function; for
1515 ;;; example, possibly DEBUG-FUNCTION only knows about its arguments.
1516 (defun debug-function-symbol-variables (debug-function symbol)
1517 (let ((vars (ambiguous-debug-vars debug-function (symbol-name symbol)))
1518 (package (and (symbol-package symbol)
1519 (package-name (symbol-package symbol)))))
1520 (delete-if (if (stringp package)
1522 (let ((p (debug-var-package-name var)))
1523 (or (not (stringp p))
1524 (string/= p package))))
1526 (stringp (debug-var-package-name var))))
1529 ;;; Return a list of debug-vars in debug-function whose names contain
1530 ;;; name-prefix-string as an intial substring. The result of this
1531 ;;; function is limited to the availability of variable information in
1532 ;;; debug-function; for example, possibly debug-function only knows
1533 ;;; about its arguments.
1534 (defun ambiguous-debug-vars (debug-function name-prefix-string)
1535 (declare (simple-string name-prefix-string))
1536 (let ((variables (debug-function-debug-vars debug-function)))
1537 (declare (type (or null simple-vector) variables))
1539 (let* ((len (length variables))
1540 (prefix-len (length name-prefix-string))
1541 (pos (find-variable name-prefix-string variables len))
1544 ;; Find names from pos to variable's len that contain prefix.
1545 (do ((i pos (1+ i)))
1547 (let* ((var (svref variables i))
1548 (name (debug-var-symbol-name var))
1549 (name-len (length name)))
1550 (declare (simple-string name))
1551 (when (/= (or (string/= name-prefix-string name
1552 :end1 prefix-len :end2 name-len)
1557 (setq res (nreverse res)))
1560 ;;; This returns a position in variables for one containing name as an
1561 ;;; initial substring. End is the length of variables if supplied.
1562 (defun find-variable (name variables &optional end)
1563 (declare (simple-vector variables)
1564 (simple-string name))
1565 (let ((name-len (length name)))
1566 (position name variables
1567 :test #'(lambda (x y)
1568 (let* ((y (debug-var-symbol-name y))
1570 (declare (simple-string y))
1571 (and (>= y-len name-len)
1572 (string= x y :end1 name-len :end2 name-len))))
1573 :end (or end (length variables)))))
1575 ;;; Return a list representing the lambda-list for DEBUG-FUNCTION. The
1576 ;;; list has the following structure:
1577 ;;; (required-var1 required-var2
1579 ;;; (:optional var3 suppliedp-var4)
1580 ;;; (:optional var5)
1582 ;;; (:rest var6) (:rest var7)
1584 ;;; (:keyword keyword-symbol var8 suppliedp-var9)
1585 ;;; (:keyword keyword-symbol var10)
1588 ;;; Each VARi is a DEBUG-VAR; however it may be the symbol :DELETED if
1589 ;;; it is unreferenced in DEBUG-FUNCTION. This signals a
1590 ;;; LAMBDA-LIST-UNAVAILABLE condition when there is no argument list
1592 (defun debug-function-lambda-list (debug-function)
1594 (etypecase debug-function
1595 (compiled-debug-function
1596 (compiled-debug-function-lambda-list debug-function))
1597 (interpreted-debug-function
1598 (interpreted-debug-function-lambda-list debug-function))
1599 (bogus-debug-function
1602 ;;; The hard part is when the lambda-list is unparsed. If it is
1603 ;;; unparsed, and all the arguments are required, this is still pretty
1604 ;;; easy; just whip the appropriate DEBUG-VARs into a list. Otherwise,
1605 ;;; we have to pick out the funny arguments including any suppliedp
1606 ;;; variables. In this situation, the ir1-lambda is an external entry
1607 ;;; point that takes arguments users really pass in. It looks at those
1608 ;;; and computes defaults and suppliedp variables, ultimately passing
1609 ;;; everything defined as a a parameter to the real function as final
1610 ;;; arguments. If this has to compute the lambda list, it caches it in
1612 (defun interpreted-debug-function-lambda-list (debug-function)
1613 (let ((lambda-list (debug-function-%lambda-list debug-function))
1614 (debug-vars (debug-function-debug-vars debug-function))
1615 (ir1-lambda (interpreted-debug-function-ir1-lambda debug-function))
1617 (if (eq lambda-list :unparsed)
1618 (flet ((frob (v debug-vars)
1619 (if (sb!c::lambda-var-refs v)
1621 :key #'interpreted-debug-var-ir1-var)
1623 (let ((xep-args (sb!c::lambda-optional-dispatch ir1-lambda)))
1625 (eq (sb!c::optional-dispatch-main-entry xep-args)
1627 ;; There are rest, optional, keyword, and suppliedp vars.
1628 (let ((final-args (sb!c::lambda-vars ir1-lambda)))
1629 (dolist (xep-arg (sb!c::optional-dispatch-arglist xep-args))
1630 (let ((info (sb!c::lambda-var-arg-info xep-arg))
1631 (final-arg (pop final-args)))
1633 (case (sb!c::arg-info-kind info)
1635 (push (frob final-arg debug-vars) res))
1637 (push (list :keyword
1638 (sb!c::arg-info-key info)
1639 (frob final-arg debug-vars))
1642 (push (list :rest (frob final-arg debug-vars))
1645 (push (list :optional
1646 (frob final-arg debug-vars))
1648 (when (sb!c::arg-info-supplied-p info)
1651 (list (frob (pop final-args) debug-vars)))))
1653 (push (frob final-arg debug-vars) res)))))
1654 (setf (debug-function-%lambda-list debug-function)
1656 ;; All required args, so return them in a list.
1657 (dolist (v (sb!c::lambda-vars ir1-lambda)
1658 (setf (debug-function-%lambda-list debug-function)
1660 (push (frob v debug-vars) res)))))
1661 ;; Everything's unparsed and cached, so return it.
1664 ;;; If this has to compute the lambda list, it caches it in debug-function.
1665 (defun compiled-debug-function-lambda-list (debug-function)
1666 (let ((lambda-list (debug-function-%lambda-list debug-function)))
1667 (cond ((eq lambda-list :unparsed)
1668 (multiple-value-bind (args argsp)
1669 (parse-compiled-debug-function-lambda-list debug-function)
1670 (setf (debug-function-%lambda-list debug-function) args)
1673 (debug-signal 'lambda-list-unavailable
1674 :debug-function debug-function))))
1676 ((bogus-debug-function-p debug-function)
1678 ((sb!c::compiled-debug-function-arguments
1679 (compiled-debug-function-compiler-debug-fun
1681 ;; If the packed information is there (whether empty or not) as
1682 ;; opposed to being nil, then returned our cached value (nil).
1685 ;; Our cached value is nil, and the packed lambda-list information
1686 ;; is nil, so we don't have anything available.
1687 (debug-signal 'lambda-list-unavailable
1688 :debug-function debug-function)))))
1690 ;;; COMPILED-DEBUG-FUNCTION-LAMBDA-LIST calls this when a
1691 ;;; compiled-debug-function has no lambda-list information cached. It
1692 ;;; returns the lambda-list as the first value and whether there was
1693 ;;; any argument information as the second value. Therefore, nil and t
1694 ;;; means there were no arguments, but nil and nil means there was no
1695 ;;; argument information.
1696 (defun parse-compiled-debug-function-lambda-list (debug-function)
1697 (let ((args (sb!c::compiled-debug-function-arguments
1698 (compiled-debug-function-compiler-debug-fun
1704 (values (coerce (debug-function-debug-vars debug-function) 'list)
1707 (let ((vars (debug-function-debug-vars debug-function))
1712 (declare (type (or null simple-vector) vars))
1714 (when (>= i len) (return))
1715 (let ((ele (aref args i)))
1720 ;; Deleted required arg at beginning of args array.
1721 (push :deleted res))
1722 (sb!c::optional-args
1725 ;; SUPPLIED-P var immediately following keyword or
1726 ;; optional. Stick the extra var in the result
1727 ;; element representing the keyword or optional,
1728 ;; which is the previous one.
1730 (list (compiled-debug-function-lambda-list-var
1731 args (incf i) vars))))
1734 (compiled-debug-function-lambda-list-var
1735 args (incf i) vars))
1738 ;; Just ignore the fact that the next two args are
1739 ;; the &MORE arg context and count, and act like they
1740 ;; are regular arguments.
1744 (push (list :keyword
1746 (compiled-debug-function-lambda-list-var
1747 args (incf i) vars))
1750 ;; We saw an optional marker, so the following
1751 ;; non-symbols are indexes indicating optional
1753 (push (list :optional (svref vars ele)) res))
1755 ;; Required arg at beginning of args array.
1756 (push (svref vars ele) res))))
1758 (values (nreverse res) t))))))
1760 ;;; This is used in COMPILED-DEBUG-FUNCTION-LAMBDA-LIST.
1761 (defun compiled-debug-function-lambda-list-var (args i vars)
1762 (declare (type (simple-array * (*)) args)
1763 (simple-vector vars))
1764 (let ((ele (aref args i)))
1765 (cond ((not (symbolp ele)) (svref vars ele))
1766 ((eq ele 'sb!c::deleted) :deleted)
1767 (t (error "malformed arguments description")))))
1769 (defun compiled-debug-function-debug-info (debug-fun)
1770 (%code-debug-info (compiled-debug-function-component debug-fun)))
1772 ;;;; unpacking variable and basic block data
1774 (defvar *parsing-buffer*
1775 (make-array 20 :adjustable t :fill-pointer t))
1776 (defvar *other-parsing-buffer*
1777 (make-array 20 :adjustable t :fill-pointer t))
1778 ;;; PARSE-DEBUG-BLOCKS, PARSE-DEBUG-VARS and UNCOMPACT-FUNCTION-MAP
1779 ;;; use this to unpack binary encoded information. It returns the
1780 ;;; values returned by the last form in body.
1782 ;;; This binds buffer-var to *parsing-buffer*, makes sure it starts at
1783 ;;; element zero, and makes sure if we unwind, we nil out any set
1784 ;;; elements for GC purposes.
1786 ;;; This also binds other-var to *other-parsing-buffer* when it is
1787 ;;; supplied, making sure it starts at element zero and that we nil
1788 ;;; out any elements if we unwind.
1790 ;;; This defines the local macro RESULT that takes a buffer, copies
1791 ;;; its elements to a resulting simple-vector, nil's out elements, and
1792 ;;; restarts the buffer at element zero. RESULT returns the
1794 (eval-when (:compile-toplevel :execute)
1795 (sb!xc:defmacro with-parsing-buffer ((buffer-var &optional other-var)
1797 (let ((len (gensym))
1800 (let ((,buffer-var *parsing-buffer*)
1801 ,@(if other-var `((,other-var *other-parsing-buffer*))))
1802 (setf (fill-pointer ,buffer-var) 0)
1803 ,@(if other-var `((setf (fill-pointer ,other-var) 0)))
1804 (macrolet ((result (buf)
1805 `(let* ((,',len (length ,buf))
1806 (,',res (make-array ,',len)))
1807 (replace ,',res ,buf :end1 ,',len :end2 ,',len)
1808 (fill ,buf nil :end ,',len)
1809 (setf (fill-pointer ,buf) 0)
1812 (fill *parsing-buffer* nil)
1813 ,@(if other-var `((fill *other-parsing-buffer* nil))))))
1816 ;;; The argument is a debug internals structure. This returns the
1817 ;;; debug-blocks for debug-function, regardless of whether we have
1818 ;;; unpacked them yet. It signals a no-debug-blocks condition if it
1819 ;;; can't return the blocks.
1820 (defun debug-function-debug-blocks (debug-function)
1821 (let ((blocks (debug-function-blocks debug-function)))
1822 (cond ((eq blocks :unparsed)
1823 (setf (debug-function-blocks debug-function)
1824 (parse-debug-blocks debug-function))
1825 (unless (debug-function-blocks debug-function)
1826 (debug-signal 'no-debug-blocks
1827 :debug-function debug-function))
1828 (debug-function-blocks debug-function))
1831 (debug-signal 'no-debug-blocks
1832 :debug-function debug-function)))))
1834 ;;; This returns a simple-vector of debug-blocks or nil. NIL indicates
1835 ;;; there was no basic block information.
1836 (defun parse-debug-blocks (debug-function)
1837 (etypecase debug-function
1838 (compiled-debug-function
1839 (parse-compiled-debug-blocks debug-function))
1840 (bogus-debug-function
1841 (debug-signal 'no-debug-blocks :debug-function debug-function))
1842 (interpreted-debug-function
1843 (parse-interpreted-debug-blocks debug-function))))
1845 ;;; This does some of the work of PARSE-DEBUG-BLOCKS.
1846 (defun parse-compiled-debug-blocks (debug-function)
1847 (let* ((debug-fun (compiled-debug-function-compiler-debug-fun
1849 (var-count (length (debug-function-debug-vars debug-function)))
1850 (blocks (sb!c::compiled-debug-function-blocks debug-fun))
1851 ;; KLUDGE: 8 is a hard-wired constant in the compiler for the
1852 ;; element size of the packed binary representation of the
1854 (live-set-len (ceiling var-count 8))
1855 (tlf-number (sb!c::compiled-debug-function-tlf-number debug-fun)))
1856 (unless blocks (return-from parse-compiled-debug-blocks nil))
1857 (macrolet ((aref+ (a i) `(prog1 (aref ,a ,i) (incf ,i))))
1858 (with-parsing-buffer (blocks-buffer locations-buffer)
1860 (len (length blocks))
1863 (when (>= i len) (return))
1864 (let ((succ-and-flags (aref+ blocks i))
1866 (declare (type (unsigned-byte 8) succ-and-flags)
1868 (dotimes (k (ldb sb!c::compiled-debug-block-nsucc-byte
1870 (push (sb!c::read-var-integer blocks i) successors))
1872 (dotimes (k (sb!c::read-var-integer blocks i)
1873 (result locations-buffer))
1874 (let ((kind (svref sb!c::*compiled-code-location-kinds*
1877 (sb!c::read-var-integer blocks i)))
1878 (tlf-offset (or tlf-number
1879 (sb!c::read-var-integer blocks
1881 (form-number (sb!c::read-var-integer blocks i))
1882 (live-set (sb!c::read-packed-bit-vector
1883 live-set-len blocks i)))
1884 (vector-push-extend (make-known-code-location
1885 pc debug-function tlf-offset
1886 form-number live-set kind)
1888 (setf last-pc pc))))
1889 (block (make-compiled-debug-block
1890 locations successors
1892 sb!c::compiled-debug-block-elsewhere-p
1893 succ-and-flags))))))
1894 (vector-push-extend block blocks-buffer)
1895 (dotimes (k (length locations))
1896 (setf (code-location-%debug-block (svref locations k))
1898 (let ((res (result blocks-buffer)))
1899 (declare (simple-vector res))
1900 (dotimes (i (length res))
1901 (let* ((block (svref res i))
1903 (dolist (ele (debug-block-successors block))
1904 (push (svref res ele) succs))
1905 (setf (debug-block-successors block) succs)))
1908 ;;; This does some of the work of PARSE-DEBUG-BLOCKS.
1909 (defun parse-interpreted-debug-blocks (debug-function)
1910 (let ((ir1-lambda (interpreted-debug-function-ir1-lambda debug-function)))
1911 (with-parsing-buffer (buffer)
1912 (sb!c::do-blocks (block (sb!c::block-component
1913 (sb!c::node-block (sb!c::lambda-bind
1915 (when (eq ir1-lambda (sb!c::block-home-lambda block))
1916 (vector-push-extend (make-interpreted-debug-block block) buffer)))
1919 ;;; The argument is a debug internals structure. This returns nil if
1920 ;;; there is no variable information. It returns an empty
1921 ;;; simple-vector if there were no locals in the function. Otherwise
1922 ;;; it returns a simple-vector of DEBUG-VARs.
1923 (defun debug-function-debug-vars (debug-function)
1924 (let ((vars (debug-function-%debug-vars debug-function)))
1925 (if (eq vars :unparsed)
1926 (setf (debug-function-%debug-vars debug-function)
1927 (etypecase debug-function
1928 (compiled-debug-function
1929 (parse-compiled-debug-vars debug-function))
1930 (bogus-debug-function nil)
1931 (interpreted-debug-function
1932 (parse-interpreted-debug-vars debug-function))))
1935 ;;; This grabs all the variables from DEBUG-FUN's ir1-lambda, from the
1936 ;;; IR1 lambda vars, and all of its LET's. Each LET is an IR1 lambda.
1937 ;;; For each variable, we make an INTERPRETED-DEBUG-VAR. We then SORT
1938 ;;; all the variables by name. Then we go through, and for any
1939 ;;; duplicated names we distinguish the INTERPRETED-DEBUG-VARs by
1940 ;;; setting their id slots to a distinct number.
1941 (defun parse-interpreted-debug-vars (debug-fun)
1942 (let* ((ir1-lambda (interpreted-debug-function-ir1-lambda debug-fun))
1943 (vars (flet ((frob (ir1-lambda buf)
1944 (dolist (v (sb!c::lambda-vars ir1-lambda))
1946 (let* ((id (sb!c::leaf-name v)))
1947 (make-interpreted-debug-var id v))
1949 (with-parsing-buffer (buf)
1950 (frob ir1-lambda buf)
1951 (dolist (let-lambda (sb!c::lambda-lets ir1-lambda))
1952 (frob let-lambda buf))
1954 (declare (simple-vector vars))
1955 (sort vars #'string< :key #'debug-var-symbol-name)
1956 (let ((len (length vars)))
1962 (let* ((var-i (svref vars i))
1963 (var-j (svref vars j))
1964 (name (debug-var-symbol-name var-i)))
1965 (when (string= name (debug-var-symbol-name var-j))
1968 (setf (debug-var-id var-j) count)
1969 (when (= (incf j) len) (return-from PUNT))
1970 (setf var-j (svref vars j))
1971 (when (string/= name (debug-var-symbol-name var-j))
1976 (when (= j len) (return))))))))
1979 ;;; Vars is the parsed variables for a minimal debug function. We need to
1980 ;;; assign names of the form ARG-NNN. We must pad with leading zeros, since
1981 ;;; the arguments must be in alphabetical order.
1982 (defun assign-minimal-var-names (vars)
1983 (declare (simple-vector vars))
1984 (let* ((len (length vars))
1985 (width (length (format nil "~D" (1- len)))))
1987 (setf (compiled-debug-var-symbol (svref vars i))
1988 (intern (format nil "ARG-~V,'0D" width i)
1989 ;; KLUDGE: It's somewhat nasty to have a bare
1990 ;; package name string here. It would probably be
1991 ;; better to have #.(FIND-PACKAGE "SB!DEBUG")
1992 ;; instead, since then at least it would transform
1993 ;; correctly under package renaming and stuff.
1994 ;; However, genesis can't handle dumped packages..
1997 ;; FIXME: Maybe this could be fixed by moving the
1998 ;; whole debug-int.lisp file to warm init? (after
1999 ;; which dumping a #.(FIND-PACKAGE ..) expression
2000 ;; would work fine) If this is possible, it would
2001 ;; probably be a good thing, since minimizing the
2002 ;; amount of stuff in cold init is basically good.
2005 ;;; Parse the packed representation of DEBUG-VARs from
2006 ;;; DEBUG-FUNCTION's SB!C::COMPILED-DEBUG-FUNCTION, returning a vector
2007 ;;; of DEBUG-VARs, or NIL if there was no information to parse.
2008 (defun parse-compiled-debug-vars (debug-function)
2009 (let* ((cdebug-fun (compiled-debug-function-compiler-debug-fun debug-function))
2010 (packed-vars (sb!c::compiled-debug-function-variables cdebug-fun))
2011 (args-minimal (eq (sb!c::compiled-debug-function-arguments cdebug-fun)
2015 (buffer (make-array 0 :fill-pointer 0 :adjustable t)))
2016 ((>= i (length packed-vars))
2017 (let ((result (coerce buffer 'simple-vector)))
2019 (assign-minimal-var-names result))
2021 (flet ((geti () (prog1 (aref packed-vars i) (incf i))))
2022 (let* ((flags (geti))
2023 (minimal (logtest sb!c::compiled-debug-var-minimal-p flags))
2024 (deleted (logtest sb!c::compiled-debug-var-deleted-p flags))
2025 (live (logtest sb!c::compiled-debug-var-environment-live flags))
2026 (save (logtest sb!c::compiled-debug-var-save-loc-p flags))
2027 (symbol (if minimal nil (geti)))
2028 (id (if (logtest sb!c::compiled-debug-var-id-p flags)
2031 (sc-offset (if deleted 0 (geti)))
2032 (save-sc-offset (if save (geti) nil)))
2033 (aver (not (and args-minimal (not minimal))))
2034 (vector-push-extend (make-compiled-debug-var symbol
2041 ;;;; unpacking minimal debug functions
2043 (eval-when (:compile-toplevel :execute)
2045 ;;; sleazoid "macro" to keep our indentation sane in UNCOMPACT-FUNCTION-MAP
2046 (sb!xc:defmacro make-uncompacted-debug-fun ()
2047 '(sb!c::make-compiled-debug-function
2049 (let ((base (ecase (ldb sb!c::minimal-debug-function-name-style-byte
2051 (#.sb!c::minimal-debug-function-name-symbol
2052 (intern (sb!c::read-var-string map i)
2053 (sb!c::compiled-debug-info-package info)))
2054 (#.sb!c::minimal-debug-function-name-packaged
2055 (let ((pkg (sb!c::read-var-string map i)))
2056 (intern (sb!c::read-var-string map i) pkg)))
2057 (#.sb!c::minimal-debug-function-name-uninterned
2058 (make-symbol (sb!c::read-var-string map i)))
2059 (#.sb!c::minimal-debug-function-name-component
2060 (sb!c::compiled-debug-info-name info)))))
2061 (if (logtest flags sb!c::minimal-debug-function-setf-bit)
2064 :kind (svref sb!c::*minimal-debug-function-kinds*
2065 (ldb sb!c::minimal-debug-function-kind-byte options))
2068 (let ((len (sb!c::read-var-integer map i)))
2069 (prog1 (subseq map i (+ i len))
2071 :arguments (when vars-p :minimal)
2073 (ecase (ldb sb!c::minimal-debug-function-returns-byte options)
2074 (#.sb!c::minimal-debug-function-returns-standard
2076 (#.sb!c::minimal-debug-function-returns-fixed
2078 (#.sb!c::minimal-debug-function-returns-specified
2079 (with-parsing-buffer (buf)
2080 (dotimes (idx (sb!c::read-var-integer map i))
2081 (vector-push-extend (sb!c::read-var-integer map i) buf))
2083 :return-pc (sb!c::read-var-integer map i)
2084 :old-fp (sb!c::read-var-integer map i)
2085 :nfp (when (logtest flags sb!c::minimal-debug-function-nfp-bit)
2086 (sb!c::read-var-integer map i))
2089 (setq code-start-pc (+ code-start-pc (sb!c::read-var-integer map i)))
2090 (+ code-start-pc (sb!c::read-var-integer map i)))
2092 (setq elsewhere-pc (+ elsewhere-pc (sb!c::read-var-integer map i)))))
2096 ;;; Return a normal function map derived from a minimal debug info
2097 ;;; function map. This involves looping parsing
2098 ;;; minimal-debug-functions and then building a vector out of them.
2100 ;;; FIXME: This and its helper macro just above become dead code now
2101 ;;; that we no longer use compacted function maps.
2102 (defun uncompact-function-map (info)
2103 (declare (type sb!c::compiled-debug-info info))
2105 ;; (This is stubified until we solve the problem of representing
2106 ;; debug information in a way which plays nicely with package renaming.)
2107 (error "FIXME: dead code UNCOMPACT-FUNCTION-MAP (was stub)")
2109 (let* ((map (sb!c::compiled-debug-info-function-map info))
2114 (declare (type (simple-array (unsigned-byte 8) (*)) map))
2115 (sb!int:collect ((res))
2117 (when (= i len) (return))
2118 (let* ((options (prog1 (aref map i) (incf i)))
2119 (flags (prog1 (aref map i) (incf i)))
2120 (vars-p (logtest flags
2121 sb!c::minimal-debug-function-variables-bit))
2122 (dfun (make-uncompacted-debug-fun)))
2126 (coerce (cdr (res)) 'simple-vector))))
2128 ;;; a map from minimal DEBUG-INFO function maps to unpacked
2129 ;;; versions thereof
2130 (defvar *uncompacted-function-maps* (make-hash-table :test 'eq))
2132 ;;; Return a FUNCTION-MAP for a given COMPILED-DEBUG-info object. If
2133 ;;; the info is minimal, and has not been parsed, then parse it.
2135 ;;; FIXME: Now that we no longer use the MINIMAL-DEBUG-FUNCTION
2136 ;;; representation, calls to this function can be replaced by calls to
2137 ;;; the bare COMPILED-DEBUG-INFO-FUNCTION-MAP slot accessor function,
2138 ;;; and this function and everything it calls become dead code which
2140 (defun get-debug-info-function-map (info)
2141 (declare (type sb!c::compiled-debug-info info))
2142 (let ((map (sb!c::compiled-debug-info-function-map info)))
2143 (if (simple-vector-p map)
2145 (or (gethash map *uncompacted-function-maps*)
2146 (setf (gethash map *uncompacted-function-maps*)
2147 (uncompact-function-map info))))))
2151 ;;; If we're sure of whether code-location is known, return T or NIL.
2152 ;;; If we're :UNSURE, then try to fill in the code-location's slots.
2153 ;;; This determines whether there is any debug-block information, and
2154 ;;; if code-location is known.
2156 ;;; ??? IF this conses closures every time it's called, then break off the
2157 ;;; :UNSURE part to get the HANDLER-CASE into another function.
2158 (defun code-location-unknown-p (basic-code-location)
2159 (ecase (code-location-%unknown-p basic-code-location)
2163 (setf (code-location-%unknown-p basic-code-location)
2164 (handler-case (not (fill-in-code-location basic-code-location))
2165 (no-debug-blocks () t))))))
2167 ;;; Return the DEBUG-BLOCK containing code-location if it is available.
2168 ;;; Some debug policies inhibit debug-block information, and if none
2169 ;;; is available, then this signals a NO-DEBUG-BLOCKS condition.
2170 (defun code-location-debug-block (basic-code-location)
2171 (let ((block (code-location-%debug-block basic-code-location)))
2172 (if (eq block :unparsed)
2173 (etypecase basic-code-location
2174 (compiled-code-location
2175 (compute-compiled-code-location-debug-block basic-code-location))
2176 (interpreted-code-location
2177 (setf (code-location-%debug-block basic-code-location)
2178 (make-interpreted-debug-block
2180 (interpreted-code-location-ir1-node basic-code-location))))))
2183 ;;; Store and return BASIC-CODE-LOCATION's debug-block. We determines
2184 ;;; the correct one using the code-location's pc. We use
2185 ;;; DEBUG-FUNCTION-DEBUG-BLOCKS to return the cached block information
2186 ;;; or signal a NO-DEBUG-BLOCKS condition. The blocks are sorted by
2187 ;;; their first code-location's pc, in ascending order. Therefore, as
2188 ;;; soon as we find a block that starts with a pc greater than
2189 ;;; basic-code-location's pc, we know the previous block contains the
2190 ;;; pc. If we get to the last block, then the code-location is either
2191 ;;; in the second to last block or the last block, and we have to be
2192 ;;; careful in determining this since the last block could be code at
2193 ;;; the end of the function. We have to check for the last block being
2194 ;;; code first in order to see how to compare the code-location's pc.
2195 (defun compute-compiled-code-location-debug-block (basic-code-location)
2196 (let* ((pc (compiled-code-location-pc basic-code-location))
2197 (debug-function (code-location-debug-function
2198 basic-code-location))
2199 (blocks (debug-function-debug-blocks debug-function))
2200 (len (length blocks)))
2201 (declare (simple-vector blocks))
2202 (setf (code-location-%debug-block basic-code-location)
2208 (let ((last (svref blocks end)))
2210 ((debug-block-elsewhere-p last)
2212 (sb!c::compiled-debug-function-elsewhere-pc
2213 (compiled-debug-function-compiler-debug-fun
2215 (svref blocks (1- end))
2218 (compiled-code-location-pc
2219 (svref (compiled-debug-block-code-locations last)
2221 (svref blocks (1- end)))
2223 (declare (type sb!c::index i end))
2225 (compiled-code-location-pc
2226 (svref (compiled-debug-block-code-locations
2229 (return (svref blocks (1- i)))))))))
2231 (defun code-location-debug-source (code-location)
2233 "Returns the code-location's debug-source."
2234 (etypecase code-location
2235 (compiled-code-location
2236 (let* ((info (compiled-debug-function-debug-info
2237 (code-location-debug-function code-location)))
2238 (sources (sb!c::compiled-debug-info-source info))
2239 (len (length sources)))
2240 (declare (list sources))
2242 (debug-signal 'no-debug-blocks :debug-function
2243 (code-location-debug-function code-location)))
2246 (do ((prev sources src)
2247 (src (cdr sources) (cdr src))
2248 (offset (code-location-top-level-form-offset code-location)))
2249 ((null src) (car prev))
2250 (when (< offset (sb!c::debug-source-source-root (car src)))
2251 (return (car prev)))))))
2252 (interpreted-code-location
2254 (let ((sb!c::*lexenv* (make-null-lexenv)))
2255 (sb!c::debug-source-for-info
2256 (sb!c::component-source-info
2257 (sb!c::block-component
2259 (interpreted-code-location-ir1-node code-location))))))))))
2261 (defun code-location-top-level-form-offset (code-location)
2263 "Returns the number of top-level forms before the one containing
2264 code-location as seen by the compiler in some compilation unit. A
2265 compilation unit is not necessarily a single file, see the section on
2267 (when (code-location-unknown-p code-location)
2268 (error 'unknown-code-location :code-location code-location))
2269 (let ((tlf-offset (code-location-%tlf-offset code-location)))
2270 (cond ((eq tlf-offset :unparsed)
2271 (etypecase code-location
2272 (compiled-code-location
2273 (unless (fill-in-code-location code-location)
2274 ;; This check should be unnecessary. We're missing
2275 ;; debug info the compiler should have dumped.
2276 (error "internal error: unknown code location"))
2277 (code-location-%tlf-offset code-location))
2278 (interpreted-code-location
2279 (setf (code-location-%tlf-offset code-location)
2280 (sb!c::source-path-tlf-number
2281 (sb!c::node-source-path
2282 (interpreted-code-location-ir1-node code-location)))))))
2285 (defun code-location-form-number (code-location)
2287 "Returns the number of the form corresponding to code-location. The form
2288 number is derived by a walking the subforms of a top-level form in
2290 (when (code-location-unknown-p code-location)
2291 (error 'unknown-code-location :code-location code-location))
2292 (let ((form-num (code-location-%form-number code-location)))
2293 (cond ((eq form-num :unparsed)
2294 (etypecase code-location
2295 (compiled-code-location
2296 (unless (fill-in-code-location code-location)
2297 ;; This check should be unnecessary. We're missing
2298 ;; debug info the compiler should have dumped.
2299 (error "internal error: unknown code location"))
2300 (code-location-%form-number code-location))
2301 (interpreted-code-location
2302 (setf (code-location-%form-number code-location)
2303 (sb!c::source-path-form-number
2304 (sb!c::node-source-path
2305 (interpreted-code-location-ir1-node code-location)))))))
2308 (defun code-location-kind (code-location)
2310 "Return the kind of CODE-LOCATION, one of:
2311 :interpreted, :unknown-return, :known-return, :internal-error,
2312 :non-local-exit, :block-start, :call-site, :single-value-return,
2314 (when (code-location-unknown-p code-location)
2315 (error 'unknown-code-location :code-location code-location))
2316 (etypecase code-location
2317 (compiled-code-location
2318 (let ((kind (compiled-code-location-kind code-location)))
2319 (cond ((not (eq kind :unparsed)) kind)
2320 ((not (fill-in-code-location code-location))
2321 ;; This check should be unnecessary. We're missing
2322 ;; debug info the compiler should have dumped.
2323 (error "internal error: unknown code location"))
2325 (compiled-code-location-kind code-location)))))
2326 (interpreted-code-location
2329 ;;; This returns CODE-LOCATION's live-set if it is available. If
2330 ;;; there is no debug-block information, this returns NIL.
2331 (defun compiled-code-location-live-set (code-location)
2332 (if (code-location-unknown-p code-location)
2334 (let ((live-set (compiled-code-location-%live-set code-location)))
2335 (cond ((eq live-set :unparsed)
2336 (unless (fill-in-code-location code-location)
2337 ;; This check should be unnecessary. We're missing
2338 ;; debug info the compiler should have dumped.
2340 ;; FIXME: This error and comment happen over and over again.
2341 ;; Make them a shared function.
2342 (error "internal error: unknown code location"))
2343 (compiled-code-location-%live-set code-location))
2346 ;;; true if OBJ1 and OBJ2 are the same place in the code
2347 (defun code-location= (obj1 obj2)
2349 (compiled-code-location
2351 (compiled-code-location
2352 (and (eq (code-location-debug-function obj1)
2353 (code-location-debug-function obj2))
2354 (sub-compiled-code-location= obj1 obj2)))
2355 (interpreted-code-location
2357 (interpreted-code-location
2359 (compiled-code-location
2361 (interpreted-code-location
2362 (eq (interpreted-code-location-ir1-node obj1)
2363 (interpreted-code-location-ir1-node obj2)))))))
2364 (defun sub-compiled-code-location= (obj1 obj2)
2365 (= (compiled-code-location-pc obj1)
2366 (compiled-code-location-pc obj2)))
2368 ;;; Fill in CODE-LOCATION's :UNPARSED slots, returning T or NIL
2369 ;;; depending on whether the code-location was known in its
2370 ;;; debug-function's debug-block information. This may signal a
2371 ;;; NO-DEBUG-BLOCKS condition due to DEBUG-FUNCTION-DEBUG-BLOCKS, and
2372 ;;; it assumes the %UNKNOWN-P slot is already set or going to be set.
2373 (defun fill-in-code-location (code-location)
2374 (declare (type compiled-code-location code-location))
2375 (let* ((debug-function (code-location-debug-function code-location))
2376 (blocks (debug-function-debug-blocks debug-function)))
2377 (declare (simple-vector blocks))
2378 (dotimes (i (length blocks) nil)
2379 (let* ((block (svref blocks i))
2380 (locations (compiled-debug-block-code-locations block)))
2381 (declare (simple-vector locations))
2382 (dotimes (j (length locations))
2383 (let ((loc (svref locations j)))
2384 (when (sub-compiled-code-location= code-location loc)
2385 (setf (code-location-%debug-block code-location) block)
2386 (setf (code-location-%tlf-offset code-location)
2387 (code-location-%tlf-offset loc))
2388 (setf (code-location-%form-number code-location)
2389 (code-location-%form-number loc))
2390 (setf (compiled-code-location-%live-set code-location)
2391 (compiled-code-location-%live-set loc))
2392 (setf (compiled-code-location-kind code-location)
2393 (compiled-code-location-kind loc))
2394 (return-from fill-in-code-location t))))))))
2396 ;;;; operations on DEBUG-BLOCKs
2398 (defmacro do-debug-block-locations ((code-var debug-block &optional return)
2401 "Executes forms in a context with code-var bound to each code-location in
2402 debug-block. This returns the value of executing result (defaults to nil)."
2403 (let ((code-locations (gensym))
2405 `(let ((,code-locations (debug-block-code-locations ,debug-block)))
2406 (declare (simple-vector ,code-locations))
2407 (dotimes (,i (length ,code-locations) ,return)
2408 (let ((,code-var (svref ,code-locations ,i)))
2411 (defun debug-block-function-name (debug-block)
2413 "Returns the name of the function represented by debug-function. This may
2414 be a string or a cons; do not assume it is a symbol."
2415 (etypecase debug-block
2416 (compiled-debug-block
2417 (let ((code-locs (compiled-debug-block-code-locations debug-block)))
2418 (declare (simple-vector code-locs))
2419 (if (zerop (length code-locs))
2420 "??? Can't get name of debug-block's function."
2421 (debug-function-name
2422 (code-location-debug-function (svref code-locs 0))))))
2423 (interpreted-debug-block
2424 (sb!c::lambda-name (sb!c::block-home-lambda
2425 (interpreted-debug-block-ir1-block debug-block))))))
2427 (defun debug-block-code-locations (debug-block)
2428 (etypecase debug-block
2429 (compiled-debug-block
2430 (compiled-debug-block-code-locations debug-block))
2431 (interpreted-debug-block
2432 (interpreted-debug-block-code-locations debug-block))))
2434 (defun interpreted-debug-block-code-locations (debug-block)
2435 (let ((code-locs (interpreted-debug-block-locations debug-block)))
2436 (if (eq code-locs :unparsed)
2437 (with-parsing-buffer (buf)
2438 (sb!c::do-nodes (node cont (interpreted-debug-block-ir1-block
2440 (vector-push-extend (make-interpreted-code-location
2442 (make-interpreted-debug-function
2443 (sb!c::block-home-lambda (sb!c::node-block
2446 (setf (interpreted-debug-block-locations debug-block)
2450 ;;;; operations on debug variables
2452 (defun debug-var-symbol-name (debug-var)
2453 (symbol-name (debug-var-symbol debug-var)))
2455 ;;; FIXME: Make sure that this isn't called anywhere that it wouldn't
2456 ;;; be acceptable to have NIL returned, or that it's only called on
2457 ;;; DEBUG-VARs whose symbols have non-NIL packages.
2458 (defun debug-var-package-name (debug-var)
2459 (package-name (symbol-package (debug-var-symbol debug-var))))
2461 (defun debug-var-valid-value (debug-var frame)
2463 "Returns the value stored for DEBUG-VAR in frame. If the value is not
2464 :valid, then this signals an invalid-value error."
2465 (unless (eq (debug-var-validity debug-var (frame-code-location frame))
2467 (error 'invalid-value :debug-var debug-var :frame frame))
2468 (debug-var-value debug-var frame))
2470 ;;; Returns the value stored for DEBUG-VAR in frame. The value may be
2471 ;;; invalid. This is SETFable.
2472 (defun debug-var-value (debug-var frame)
2473 (etypecase debug-var
2475 (aver (typep frame 'compiled-frame))
2476 (let ((res (access-compiled-debug-var-slot debug-var frame)))
2477 (if (indirect-value-cell-p res)
2478 (sb!c:value-cell-ref res)
2480 ;; (This function used to be more interesting, with more type
2481 ;; cases here, before the IR1 interpreter went away. It might
2482 ;; become more interesting again if we ever try to generalize the
2483 ;; CMU CL POSSIBLY-AN-INTERPRETED-FRAME thing to elide
2484 ;; internal-to-the-byte-interpreter debug frames the way that CMU
2485 ;; CL elided internal-to-the-IR1-interpreter debug frames.)
2488 ;;; This returns what is stored for the variable represented by
2489 ;;; DEBUG-VAR relative to the FRAME. This may be an indirect value
2490 ;;; cell if the variable is both closed over and set.
2491 (defun access-compiled-debug-var-slot (debug-var frame)
2492 (declare (optimize (speed 1)))
2493 (let ((escaped (compiled-frame-escaped frame)))
2495 (sub-access-debug-var-slot
2496 (frame-pointer frame)
2497 (compiled-debug-var-sc-offset debug-var)
2499 (sub-access-debug-var-slot
2500 (frame-pointer frame)
2501 (or (compiled-debug-var-save-sc-offset debug-var)
2502 (compiled-debug-var-sc-offset debug-var))))))
2504 ;;; a helper function for working with possibly-invalid values:
2505 ;;; Do (MAKE-LISP-OBJ VAL) only if the value looks valid.
2507 ;;; (Such values can arise in registers on machines with conservative
2508 ;;; GC, and might also arise in debug variable locations when
2509 ;;; those variables are invalid.)
2510 (defun make-valid-lisp-obj (val)
2511 (/show0 "entering MAKE-VALID-LISP-OBJ, VAL=..")
2512 #!+sb-show (/hexstr val)
2515 (zerop (logand val 3))
2517 (and (zerop (logand val #xffff0000)) ; Top bits zero
2518 (= (logand val #xff) sb!vm:base-char-type)) ; Char tag
2520 (= val sb!vm:unbound-marker-type)
2523 ;; Check that the pointer is valid. XXX Could do a better
2524 ;; job. FIXME: e.g. by calling out to an is_valid_pointer
2525 ;; routine in the C runtime support code
2526 (or (< sb!vm:read-only-space-start val
2527 (* sb!vm:*read-only-space-free-pointer*
2529 (< sb!vm:static-space-start val
2530 (* sb!vm:*static-space-free-pointer*
2532 (< sb!vm:dynamic-space-start val
2533 (sap-int (dynamic-space-free-pointer))))))
2538 (defun sub-access-debug-var-slot (fp sc-offset &optional escaped)
2539 (macrolet ((with-escaped-value ((var) &body forms)
2541 (let ((,var (sb!vm:context-register
2543 (sb!c:sc-offset-offset sc-offset))))
2545 :invalid-value-for-unescaped-register-storage))
2546 (escaped-float-value (format)
2548 (sb!vm:context-float-register
2550 (sb!c:sc-offset-offset sc-offset)
2552 :invalid-value-for-unescaped-register-storage))
2553 (with-nfp ((var) &body body)
2554 `(let ((,var (if escaped
2556 (sb!vm:context-register escaped
2559 (sb!sys:sap-ref-sap fp (* sb!vm::nfp-save-offset
2562 (sb!vm::make-number-stack-pointer
2563 (sb!sys:sap-ref-32 fp (* sb!vm::nfp-save-offset
2564 sb!vm:word-bytes))))))
2566 (ecase (sb!c:sc-offset-scn sc-offset)
2567 ((#.sb!vm:any-reg-sc-number
2568 #.sb!vm:descriptor-reg-sc-number
2569 #!+rt #.sb!vm:word-pointer-reg-sc-number)
2570 (sb!sys:without-gcing
2571 (with-escaped-value (val) (sb!kernel:make-lisp-obj val))))
2573 (#.sb!vm:base-char-reg-sc-number
2574 (with-escaped-value (val)
2576 (#.sb!vm:sap-reg-sc-number
2577 (with-escaped-value (val)
2578 (sb!sys:int-sap val)))
2579 (#.sb!vm:signed-reg-sc-number
2580 (with-escaped-value (val)
2581 (if (logbitp (1- sb!vm:word-bits) val)
2582 (logior val (ash -1 sb!vm:word-bits))
2584 (#.sb!vm:unsigned-reg-sc-number
2585 (with-escaped-value (val)
2587 (#.sb!vm:non-descriptor-reg-sc-number
2588 (error "Local non-descriptor register access?"))
2589 (#.sb!vm:interior-reg-sc-number
2590 (error "Local interior register access?"))
2591 (#.sb!vm:single-reg-sc-number
2592 (escaped-float-value single-float))
2593 (#.sb!vm:double-reg-sc-number
2594 (escaped-float-value double-float))
2596 (#.sb!vm:long-reg-sc-number
2597 (escaped-float-value long-float))
2598 (#.sb!vm:complex-single-reg-sc-number
2601 (sb!vm:context-float-register
2602 escaped (sb!c:sc-offset-offset sc-offset) 'single-float)
2603 (sb!vm:context-float-register
2604 escaped (1+ (sb!c:sc-offset-offset sc-offset)) 'single-float))
2605 :invalid-value-for-unescaped-register-storage))
2606 (#.sb!vm:complex-double-reg-sc-number
2609 (sb!vm:context-float-register
2610 escaped (sb!c:sc-offset-offset sc-offset) 'double-float)
2611 (sb!vm:context-float-register
2612 escaped (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 2 #-sparc 1)
2614 :invalid-value-for-unescaped-register-storage))
2616 (#.sb!vm:complex-long-reg-sc-number
2619 (sb!vm:context-float-register
2620 escaped (sb!c:sc-offset-offset sc-offset) 'long-float)
2621 (sb!vm:context-float-register
2622 escaped (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 4)
2624 :invalid-value-for-unescaped-register-storage))
2625 (#.sb!vm:single-stack-sc-number
2627 (sb!sys:sap-ref-single nfp (* (sb!c:sc-offset-offset sc-offset)
2628 sb!vm:word-bytes))))
2629 (#.sb!vm:double-stack-sc-number
2631 (sb!sys:sap-ref-double nfp (* (sb!c:sc-offset-offset sc-offset)
2632 sb!vm:word-bytes))))
2634 (#.sb!vm:long-stack-sc-number
2636 (sb!sys:sap-ref-long nfp (* (sb!c:sc-offset-offset sc-offset)
2637 sb!vm:word-bytes))))
2638 (#.sb!vm:complex-single-stack-sc-number
2641 (sb!sys:sap-ref-single nfp (* (sb!c:sc-offset-offset sc-offset)
2643 (sb!sys:sap-ref-single nfp (* (1+ (sb!c:sc-offset-offset sc-offset))
2644 sb!vm:word-bytes)))))
2645 (#.sb!vm:complex-double-stack-sc-number
2648 (sb!sys:sap-ref-double nfp (* (sb!c:sc-offset-offset sc-offset)
2650 (sb!sys:sap-ref-double nfp (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2651 sb!vm:word-bytes)))))
2653 (#.sb!vm:complex-long-stack-sc-number
2656 (sb!sys:sap-ref-long nfp (* (sb!c:sc-offset-offset sc-offset)
2658 (sb!sys:sap-ref-long nfp (* (+ (sb!c:sc-offset-offset sc-offset)
2660 sb!vm:word-bytes)))))
2661 (#.sb!vm:control-stack-sc-number
2662 (sb!kernel:stack-ref fp (sb!c:sc-offset-offset sc-offset)))
2663 (#.sb!vm:base-char-stack-sc-number
2665 (code-char (sb!sys:sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2666 sb!vm:word-bytes)))))
2667 (#.sb!vm:unsigned-stack-sc-number
2669 (sb!sys:sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2670 sb!vm:word-bytes))))
2671 (#.sb!vm:signed-stack-sc-number
2673 (sb!sys:signed-sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2674 sb!vm:word-bytes))))
2675 (#.sb!vm:sap-stack-sc-number
2677 (sb!sys:sap-ref-sap nfp (* (sb!c:sc-offset-offset sc-offset)
2678 sb!vm:word-bytes)))))))
2681 (defun sub-access-debug-var-slot (fp sc-offset &optional escaped)
2682 (declare (type system-area-pointer fp))
2683 (/show0 "entering SUB-ACCESS-DEBUG-VAR-SLOT, FP,SC-OFFSET,ESCAPED=..")
2684 (/hexstr fp) (/hexstr sc-offset) (/hexstr escaped)
2685 (macrolet ((with-escaped-value ((var) &body forms)
2687 (let ((,var (sb!vm:context-register
2689 (sb!c:sc-offset-offset sc-offset))))
2690 (/show0 "in escaped case, ,VAR value=..")
2693 :invalid-value-for-unescaped-register-storage))
2694 (escaped-float-value (format)
2696 (sb!vm:context-float-register
2697 escaped (sb!c:sc-offset-offset sc-offset) ',format)
2698 :invalid-value-for-unescaped-register-storage))
2699 (escaped-complex-float-value (format)
2702 (sb!vm:context-float-register
2703 escaped (sb!c:sc-offset-offset sc-offset) ',format)
2704 (sb!vm:context-float-register
2705 escaped (1+ (sb!c:sc-offset-offset sc-offset)) ',format))
2706 :invalid-value-for-unescaped-register-storage)))
2707 (ecase (sb!c:sc-offset-scn sc-offset)
2708 ((#.sb!vm:any-reg-sc-number #.sb!vm:descriptor-reg-sc-number)
2709 (/show0 "case of ANY-REG-SC-NUMBER or DESCRIPTOR-REG-SC-NUMBER")
2711 (with-escaped-value (val)
2714 (make-valid-lisp-obj val))))
2715 (#.sb!vm:base-char-reg-sc-number
2716 (/show0 "case of BASE-CHAR-REG-SC-NUMBER")
2717 (with-escaped-value (val)
2719 (#.sb!vm:sap-reg-sc-number
2720 (/show0 "case of SAP-REG-SC-NUMBER")
2721 (with-escaped-value (val)
2723 (#.sb!vm:signed-reg-sc-number
2724 (/show0 "case of SIGNED-REG-SC-NUMBER")
2725 (with-escaped-value (val)
2726 (if (logbitp (1- sb!vm:word-bits) val)
2727 (logior val (ash -1 sb!vm:word-bits))
2729 (#.sb!vm:unsigned-reg-sc-number
2730 (/show0 "case of UNSIGNED-REG-SC-NUMBER")
2731 (with-escaped-value (val)
2733 (#.sb!vm:single-reg-sc-number
2734 (/show0 "case of SINGLE-REG-SC-NUMBER")
2735 (escaped-float-value single-float))
2736 (#.sb!vm:double-reg-sc-number
2737 (/show0 "case of DOUBLE-REG-SC-NUMBER")
2738 (escaped-float-value double-float))
2740 (#.sb!vm:long-reg-sc-number
2741 (/show0 "case of LONG-REG-SC-NUMBER")
2742 (escaped-float-value long-float))
2743 (#.sb!vm:complex-single-reg-sc-number
2744 (/show0 "case of COMPLEX-SINGLE-REG-SC-NUMBER")
2745 (escaped-complex-float-value single-float))
2746 (#.sb!vm:complex-double-reg-sc-number
2747 (/show0 "case of COMPLEX-DOUBLE-REG-SC-NUMBER")
2748 (escaped-complex-float-value double-float))
2750 (#.sb!vm:complex-long-reg-sc-number
2751 (/show0 "case of COMPLEX-LONG-REG-SC-NUMBER")
2752 (escaped-complex-float-value long-float))
2753 (#.sb!vm:single-stack-sc-number
2754 (/show0 "case of SINGLE-STACK-SC-NUMBER")
2755 (sap-ref-single fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2756 sb!vm:word-bytes))))
2757 (#.sb!vm:double-stack-sc-number
2758 (/show0 "case of DOUBLE-STACK-SC-NUMBER")
2759 (sap-ref-double fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2760 sb!vm:word-bytes))))
2762 (#.sb!vm:long-stack-sc-number
2763 (/show0 "case of LONG-STACK-SC-NUMBER")
2764 (sap-ref-long fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2765 sb!vm:word-bytes))))
2766 (#.sb!vm:complex-single-stack-sc-number
2767 (/show0 "case of COMPLEX-STACK-SC-NUMBER")
2769 (sap-ref-single fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2771 (sap-ref-single fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2772 sb!vm:word-bytes)))))
2773 (#.sb!vm:complex-double-stack-sc-number
2774 (/show0 "case of COMPLEX-DOUBLE-STACK-SC-NUMBER")
2776 (sap-ref-double fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2778 (sap-ref-double fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 4)
2779 sb!vm:word-bytes)))))
2781 (#.sb!vm:complex-long-stack-sc-number
2782 (/show0 "case of COMPLEX-LONG-STACK-SC-NUMBER")
2784 (sap-ref-long fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2786 (sap-ref-long fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 6)
2787 sb!vm:word-bytes)))))
2788 (#.sb!vm:control-stack-sc-number
2789 (/show0 "case of CONTROL-STACK-SC-NUMBER")
2790 (stack-ref fp (sb!c:sc-offset-offset sc-offset)))
2791 (#.sb!vm:base-char-stack-sc-number
2792 (/show0 "case of BASE-CHAR-STACK-SC-NUMBER")
2794 (sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2795 sb!vm:word-bytes)))))
2796 (#.sb!vm:unsigned-stack-sc-number
2797 (/show0 "case of UNSIGNED-STACK-SC-NUMBER")
2798 (sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2799 sb!vm:word-bytes))))
2800 (#.sb!vm:signed-stack-sc-number
2801 (/show0 "case of SIGNED-STACK-SC-NUMBER")
2802 (signed-sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2803 sb!vm:word-bytes))))
2804 (#.sb!vm:sap-stack-sc-number
2805 (/show0 "case of SAP-STACK-SC-NUMBER")
2806 (sap-ref-sap fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2807 sb!vm:word-bytes)))))))
2809 ;;; This stores value as the value of DEBUG-VAR in FRAME. In the
2810 ;;; COMPILED-DEBUG-VAR case, access the current value to determine if
2811 ;;; it is an indirect value cell. This occurs when the variable is
2812 ;;; both closed over and set.
2813 (defun %set-debug-var-value (debug-var frame value)
2814 (etypecase debug-var
2816 (aver (typep frame 'compiled-frame))
2817 (let ((current-value (access-compiled-debug-var-slot debug-var frame)))
2818 (if (indirect-value-cell-p current-value)
2819 (sb!c:value-cell-set current-value value)
2820 (set-compiled-debug-var-slot debug-var frame value))))
2821 ;; (This function used to be more interesting, with more type
2822 ;; cases here, before the IR1 interpreter went away. It might
2823 ;; become more interesting again if we ever try to generalize the
2824 ;; CMU CL POSSIBLY-AN-INTERPRETED-FRAME thing to elide
2825 ;; internal-to-the-byte-interpreter debug frames the way that CMU
2826 ;; CL elided internal-to-the-IR1-interpreter debug frames.)
2830 ;;; This stores value for the variable represented by debug-var
2831 ;;; relative to the frame. This assumes the location directly contains
2832 ;;; the variable's value; that is, there is no indirect value cell
2833 ;;; currently there in case the variable is both closed over and set.
2834 (defun set-compiled-debug-var-slot (debug-var frame value)
2835 (let ((escaped (compiled-frame-escaped frame)))
2837 (sub-set-debug-var-slot (frame-pointer frame)
2838 (compiled-debug-var-sc-offset debug-var)
2840 (sub-set-debug-var-slot
2841 (frame-pointer frame)
2842 (or (compiled-debug-var-save-sc-offset debug-var)
2843 (compiled-debug-var-sc-offset debug-var))
2847 (defun sub-set-debug-var-slot (fp sc-offset value &optional escaped)
2848 (macrolet ((set-escaped-value (val)
2850 (setf (sb!vm:context-register
2852 (sb!c:sc-offset-offset sc-offset))
2855 (set-escaped-float-value (format val)
2857 (setf (sb!vm:context-float-register
2859 (sb!c:sc-offset-offset sc-offset)
2863 (with-nfp ((var) &body body)
2864 `(let ((,var (if escaped
2866 (sb!vm:context-register escaped
2870 (* sb!vm::nfp-save-offset
2873 (sb!vm::make-number-stack-pointer
2875 (* sb!vm::nfp-save-offset
2876 sb!vm:word-bytes))))))
2878 (ecase (sb!c:sc-offset-scn sc-offset)
2879 ((#.sb!vm:any-reg-sc-number
2880 #.sb!vm:descriptor-reg-sc-number
2881 #!+rt #.sb!vm:word-pointer-reg-sc-number)
2884 (get-lisp-obj-address value))))
2885 (#.sb!vm:base-char-reg-sc-number
2886 (set-escaped-value (char-code value)))
2887 (#.sb!vm:sap-reg-sc-number
2888 (set-escaped-value (sap-int value)))
2889 (#.sb!vm:signed-reg-sc-number
2890 (set-escaped-value (logand value (1- (ash 1 sb!vm:word-bits)))))
2891 (#.sb!vm:unsigned-reg-sc-number
2892 (set-escaped-value value))
2893 (#.sb!vm:non-descriptor-reg-sc-number
2894 (error "Local non-descriptor register access?"))
2895 (#.sb!vm:interior-reg-sc-number
2896 (error "Local interior register access?"))
2897 (#.sb!vm:single-reg-sc-number
2898 (set-escaped-float-value single-float value))
2899 (#.sb!vm:double-reg-sc-number
2900 (set-escaped-float-value double-float value))
2902 (#.sb!vm:long-reg-sc-number
2903 (set-escaped-float-value long-float value))
2904 (#.sb!vm:complex-single-reg-sc-number
2906 (setf (sb!vm:context-float-register escaped
2907 (sb!c:sc-offset-offset sc-offset)
2910 (setf (sb!vm:context-float-register
2911 escaped (1+ (sb!c:sc-offset-offset sc-offset))
2915 (#.sb!vm:complex-double-reg-sc-number
2917 (setf (sb!vm:context-float-register
2918 escaped (sb!c:sc-offset-offset sc-offset) 'double-float)
2920 (setf (sb!vm:context-float-register
2922 (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 2 #!-sparc 1)
2927 (#.sb!vm:complex-long-reg-sc-number
2929 (setf (sb!vm:context-float-register
2930 escaped (sb!c:sc-offset-offset sc-offset) 'long-float)
2932 (setf (sb!vm:context-float-register
2934 (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 4)
2938 (#.sb!vm:single-stack-sc-number
2940 (setf (sap-ref-single nfp (* (sb!c:sc-offset-offset sc-offset)
2942 (the single-float value))))
2943 (#.sb!vm:double-stack-sc-number
2945 (setf (sap-ref-double nfp (* (sb!c:sc-offset-offset sc-offset)
2947 (the double-float value))))
2949 (#.sb!vm:long-stack-sc-number
2951 (setf (sap-ref-long nfp (* (sb!c:sc-offset-offset sc-offset)
2953 (the long-float value))))
2954 (#.sb!vm:complex-single-stack-sc-number
2956 (setf (sap-ref-single
2957 nfp (* (sb!c:sc-offset-offset sc-offset) sb!vm:word-bytes))
2958 (the single-float (realpart value)))
2959 (setf (sap-ref-single
2960 nfp (* (1+ (sb!c:sc-offset-offset sc-offset))
2962 (the single-float (realpart value)))))
2963 (#.sb!vm:complex-double-stack-sc-number
2965 (setf (sap-ref-double
2966 nfp (* (sb!c:sc-offset-offset sc-offset) sb!vm:word-bytes))
2967 (the double-float (realpart value)))
2968 (setf (sap-ref-double
2969 nfp (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2971 (the double-float (realpart value)))))
2973 (#.sb!vm:complex-long-stack-sc-number
2976 nfp (* (sb!c:sc-offset-offset sc-offset) sb!vm:word-bytes))
2977 (the long-float (realpart value)))
2979 nfp (* (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 4)
2981 (the long-float (realpart value)))))
2982 (#.sb!vm:control-stack-sc-number
2983 (setf (stack-ref fp (sb!c:sc-offset-offset sc-offset)) value))
2984 (#.sb!vm:base-char-stack-sc-number
2986 (setf (sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2988 (char-code (the character value)))))
2989 (#.sb!vm:unsigned-stack-sc-number
2991 (setf (sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2993 (the (unsigned-byte 32) value))))
2994 (#.sb!vm:signed-stack-sc-number
2996 (setf (signed-sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2998 (the (signed-byte 32) value))))
2999 (#.sb!vm:sap-stack-sc-number
3001 (setf (sap-ref-sap nfp (* (sb!c:sc-offset-offset sc-offset)
3003 (the system-area-pointer value)))))))
3006 (defun sub-set-debug-var-slot (fp sc-offset value &optional escaped)
3007 (macrolet ((set-escaped-value (val)
3009 (setf (sb!vm:context-register
3011 (sb!c:sc-offset-offset sc-offset))
3014 (ecase (sb!c:sc-offset-scn sc-offset)
3015 ((#.sb!vm:any-reg-sc-number #.sb!vm:descriptor-reg-sc-number)
3018 (get-lisp-obj-address value))))
3019 (#.sb!vm:base-char-reg-sc-number
3020 (set-escaped-value (char-code value)))
3021 (#.sb!vm:sap-reg-sc-number
3022 (set-escaped-value (sap-int value)))
3023 (#.sb!vm:signed-reg-sc-number
3024 (set-escaped-value (logand value (1- (ash 1 sb!vm:word-bits)))))
3025 (#.sb!vm:unsigned-reg-sc-number
3026 (set-escaped-value value))
3027 (#.sb!vm:single-reg-sc-number
3028 #+nil ;; don't have escaped floats.
3029 (set-escaped-float-value single-float value))
3030 (#.sb!vm:double-reg-sc-number
3031 #+nil ;; don't have escaped floats -- still in npx?
3032 (set-escaped-float-value double-float value))
3034 (#.sb!vm:long-reg-sc-number
3035 #+nil ;; don't have escaped floats -- still in npx?
3036 (set-escaped-float-value long-float value))
3037 (#.sb!vm:single-stack-sc-number
3038 (setf (sap-ref-single
3039 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
3041 (the single-float value)))
3042 (#.sb!vm:double-stack-sc-number
3043 (setf (sap-ref-double
3044 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
3046 (the double-float value)))
3048 (#.sb!vm:long-stack-sc-number
3050 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
3052 (the long-float value)))
3053 (#.sb!vm:complex-single-stack-sc-number
3054 (setf (sap-ref-single
3055 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
3057 (realpart (the (complex single-float) value)))
3058 (setf (sap-ref-single
3059 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
3061 (imagpart (the (complex single-float) value))))
3062 (#.sb!vm:complex-double-stack-sc-number
3063 (setf (sap-ref-double
3064 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
3066 (realpart (the (complex double-float) value)))
3067 (setf (sap-ref-double
3068 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 4)
3070 (imagpart (the (complex double-float) value))))
3072 (#.sb!vm:complex-long-stack-sc-number
3074 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
3076 (realpart (the (complex long-float) value)))
3078 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 6)
3080 (imagpart (the (complex long-float) value))))
3081 (#.sb!vm:control-stack-sc-number
3082 (setf (stack-ref fp (sb!c:sc-offset-offset sc-offset)) value))
3083 (#.sb!vm:base-char-stack-sc-number
3084 (setf (sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
3086 (char-code (the character value))))
3087 (#.sb!vm:unsigned-stack-sc-number
3088 (setf (sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
3090 (the (unsigned-byte 32) value)))
3091 (#.sb!vm:signed-stack-sc-number
3092 (setf (signed-sap-ref-32
3093 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset)) sb!vm:word-bytes)))
3094 (the (signed-byte 32) value)))
3095 (#.sb!vm:sap-stack-sc-number
3096 (setf (sap-ref-sap fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
3098 (the system-area-pointer value))))))
3100 ;;; The method for setting and accessing COMPILED-DEBUG-VAR values use
3101 ;;; this to determine if the value stored is the actual value or an
3102 ;;; indirection cell.
3103 (defun indirect-value-cell-p (x)
3104 (and (= (get-lowtag x) sb!vm:other-pointer-type)
3105 (= (get-type x) sb!vm:value-cell-header-type)))
3107 ;;; If the variable is always alive, then it is valid. If the
3108 ;;; code-location is unknown, then the variable's validity is
3109 ;;; :unknown. Once we've called CODE-LOCATION-UNKNOWN-P, we know the
3110 ;;; live-set information has been cached in the code-location.
3111 (defun debug-var-validity (debug-var basic-code-location)
3113 "Returns three values reflecting the validity of DEBUG-VAR's value
3114 at BASIC-CODE-LOCATION:
3115 :VALID The value is known to be available.
3116 :INVALID The value is known to be unavailable.
3117 :UNKNOWN The value's availability is unknown."
3118 (etypecase debug-var
3120 (compiled-debug-var-validity debug-var basic-code-location))
3121 (interpreted-debug-var
3122 (aver (typep basic-code-location 'interpreted-code-location))
3123 (let ((validp (rassoc (interpreted-debug-var-ir1-var debug-var)
3124 (sb!c::lexenv-variables
3126 (interpreted-code-location-ir1-node
3127 basic-code-location))))))
3128 (if validp :valid :invalid)))))
3130 ;;; This is the method for DEBUG-VAR-VALIDITY for COMPILED-DEBUG-VARs.
3131 ;;; For safety, make sure basic-code-location is what we think.
3132 (defun compiled-debug-var-validity (debug-var basic-code-location)
3133 (declare (type compiled-code-location basic-code-location))
3134 (cond ((debug-var-alive-p debug-var)
3135 (let ((debug-fun (code-location-debug-function basic-code-location)))
3136 (if (>= (compiled-code-location-pc basic-code-location)
3137 (sb!c::compiled-debug-function-start-pc
3138 (compiled-debug-function-compiler-debug-fun debug-fun)))
3141 ((code-location-unknown-p basic-code-location) :unknown)
3143 (let ((pos (position debug-var
3144 (debug-function-debug-vars
3145 (code-location-debug-function
3146 basic-code-location)))))
3148 (error 'unknown-debug-var
3149 :debug-var debug-var
3151 (code-location-debug-function basic-code-location)))
3152 ;; There must be live-set info since basic-code-location is known.
3153 (if (zerop (sbit (compiled-code-location-live-set
3154 basic-code-location)
3161 ;;; This code produces and uses what we call source-paths. A
3162 ;;; source-path is a list whose first element is a form number as
3163 ;;; returned by CODE-LOCATION-FORM-NUMBER and whose last element is a
3164 ;;; top-level-form number as returned by
3165 ;;; CODE-LOCATION-TOP-LEVEL-FORM-NUMBER. The elements from the last to
3166 ;;; the first, exclusively, are the numbered subforms into which to
3167 ;;; descend. For example:
3169 ;;; (let ((a (aref x 3)))
3171 ;;; The call to AREF in this example is form number 5. Assuming this
3172 ;;; DEFUN is the 11'th top-level-form, the source-path for the AREF
3173 ;;; call is as follows:
3175 ;;; Given the DEFUN, 3 gets you the LET, 1 gets you the bindings, 0
3176 ;;; gets the first binding, and 1 gets the AREF form.
3178 ;;; temporary buffer used to build form-number => source-path translation in
3179 ;;; FORM-NUMBER-TRANSLATIONS
3180 (defvar *form-number-temp* (make-array 10 :fill-pointer 0 :adjustable t))
3182 ;;; table used to detect CAR circularities in FORM-NUMBER-TRANSLATIONS
3183 (defvar *form-number-circularity-table* (make-hash-table :test 'eq))
3185 ;;; This returns a table mapping form numbers to source-paths. A source-path
3186 ;;; indicates a descent into the top-level-form form, going directly to the
3187 ;;; subform corressponding to the form number.
3189 ;;; The vector elements are in the same format as the compiler's
3190 ;;; NODE-SOURCE-PATH; that is, the first element is the form number and
3191 ;;; the last is the top-level-form number.
3192 (defun form-number-translations (form tlf-number)
3193 (clrhash *form-number-circularity-table*)
3194 (setf (fill-pointer *form-number-temp*) 0)
3195 (sub-translate-form-numbers form (list tlf-number))
3196 (coerce *form-number-temp* 'simple-vector))
3197 (defun sub-translate-form-numbers (form path)
3198 (unless (gethash form *form-number-circularity-table*)
3199 (setf (gethash form *form-number-circularity-table*) t)
3200 (vector-push-extend (cons (fill-pointer *form-number-temp*) path)
3205 (declare (fixnum pos))
3208 (when (atom subform) (return))
3209 (let ((fm (car subform)))
3211 (sub-translate-form-numbers fm (cons pos path)))
3213 (setq subform (cdr subform))
3214 (when (eq subform trail) (return)))))
3218 (setq trail (cdr trail)))))))
3220 ;;; FORM is a top-level form, and path is a source-path into it. This
3221 ;;; returns the form indicated by the source-path. Context is the
3222 ;;; number of enclosing forms to return instead of directly returning
3223 ;;; the source-path form. When context is non-zero, the form returned
3224 ;;; contains a marker, #:****HERE****, immediately before the form
3225 ;;; indicated by path.
3226 (defun source-path-context (form path context)
3227 (declare (type unsigned-byte context))
3228 ;; Get to the form indicated by path or the enclosing form indicated
3229 ;; by context and path.
3230 (let ((path (reverse (butlast (cdr path)))))
3231 (dotimes (i (- (length path) context))
3232 (let ((index (first path)))
3233 (unless (and (listp form) (< index (length form)))
3234 (error "Source path no longer exists."))
3235 (setq form (elt form index))
3236 (setq path (rest path))))
3237 ;; Recursively rebuild the source form resulting from the above
3238 ;; descent, copying the beginning of each subform up to the next
3239 ;; subform we descend into according to path. At the bottom of the
3240 ;; recursion, we return the form indicated by path preceded by our
3241 ;; marker, and this gets spliced into the resulting list structure
3242 ;; on the way back up.
3243 (labels ((frob (form path level)
3244 (if (or (zerop level) (null path))
3247 `(#:***here*** ,form))
3248 (let ((n (first path)))
3249 (unless (and (listp form) (< n (length form)))
3250 (error "Source path no longer exists."))
3251 (let ((res (frob (elt form n) (rest path) (1- level))))
3252 (nconc (subseq form 0 n)
3253 (cons res (nthcdr (1+ n) form))))))))
3254 (frob form path context))))
3256 ;;;; PREPROCESS-FOR-EVAL and EVAL-IN-FRAME
3258 ;;; Return a function of one argument that evaluates form in the
3259 ;;; lexical context of the basic-code-location loc.
3260 ;;; PREPROCESS-FOR-EVAL signals a no-debug-vars condition when the
3261 ;;; loc's debug-function has no debug-var information available. The
3262 ;;; returned function takes the frame to get values from as its
3263 ;;; argument, and it returns the values of form. The returned function
3264 ;;; signals the following conditions: invalid-value,
3265 ;;; ambiguous-variable-name, and frame-function-mismatch.
3266 (defun preprocess-for-eval (form loc)
3267 (declare (type code-location loc))
3268 (let ((n-frame (gensym))
3269 (fun (code-location-debug-function loc)))
3270 (unless (debug-var-info-available fun)
3271 (debug-signal 'no-debug-vars :debug-function fun))
3272 (sb!int:collect ((binds)
3274 (do-debug-function-variables (var fun)
3275 (let ((validity (debug-var-validity var loc)))
3276 (unless (eq validity :invalid)
3277 (let* ((sym (debug-var-symbol var))
3278 (found (assoc sym (binds))))
3280 (setf (second found) :ambiguous)
3281 (binds (list sym validity var)))))))
3282 (dolist (bind (binds))
3283 (let ((name (first bind))
3285 (ecase (second bind)
3287 (specs `(,name (debug-var-value ',var ,n-frame))))
3289 (specs `(,name (debug-signal 'invalid-value :debug-var ',var
3292 (specs `(,name (debug-signal 'ambiguous-variable-name :name ',name
3293 :frame ,n-frame)))))))
3294 (let ((res (coerce `(lambda (,n-frame)
3295 (declare (ignorable ,n-frame))
3296 (symbol-macrolet ,(specs) ,form))
3299 ;; This prevents these functions from being used in any
3300 ;; location other than a function return location, so
3301 ;; maybe this should only check whether frame's
3302 ;; debug-function is the same as loc's.
3303 (unless (code-location= (frame-code-location frame) loc)
3304 (debug-signal 'frame-function-mismatch
3305 :code-location loc :form form :frame frame))
3306 (funcall res frame))))))
3308 ;;; Evaluate FORM in the lexical context of FRAME's current code
3309 ;;; location, returning the results of the evaluation.
3310 (defun eval-in-frame (frame form)
3311 (declare (type frame frame))
3312 (funcall (preprocess-for-eval form (frame-code-location frame)) frame))
3316 ;;;; user-visible interface
3318 ;;; Create and return a breakpoint. When program execution encounters
3319 ;;; the breakpoint, the system calls HOOK-FUNCTION. HOOK-FUNCTION takes the
3320 ;;; current frame for the function in which the program is running and the
3321 ;;; breakpoint object.
3323 ;;; WHAT and KIND determine where in a function the system invokes
3324 ;;; HOOK-FUNCTION. WHAT is either a code-location or a debug-function.
3325 ;;; KIND is one of :CODE-LOCATION, :FUNCTION-START, or :FUNCTION-END.
3326 ;;; Since the starts and ends of functions may not have code-locations
3327 ;;; representing them, designate these places by supplying WHAT as a
3328 ;;; debug-function and KIND indicating the :FUNCTION-START or
3329 ;;; :FUNCTION-END. When WHAT is a debug-function and kind is
3330 ;;; :FUNCTION-END, then hook-function must take two additional
3331 ;;; arguments, a list of values returned by the function and a
3332 ;;; FUNCTION-END-COOKIE.
3334 ;;; INFO is information supplied by and used by the user.
3336 ;;; FUNCTION-END-COOKIE is a function. To implement :FUNCTION-END
3337 ;;; breakpoints, the system uses starter breakpoints to establish the
3338 ;;; :FUNCTION-END breakpoint for each invocation of the function. Upon
3339 ;;; each entry, the system creates a unique cookie to identify the
3340 ;;; invocation, and when the user supplies a function for this
3341 ;;; argument, the system invokes it on the frame and the cookie. The
3342 ;;; system later invokes the :FUNCTION-END breakpoint hook on the same
3343 ;;; cookie. The user may save the cookie for comparison in the hook
3346 ;;; Signal an error if WHAT is an unknown code-location.
3347 (defun make-breakpoint (hook-function what
3348 &key (kind :code-location) info function-end-cookie)
3351 (when (code-location-unknown-p what)
3352 (error "cannot make a breakpoint at an unknown code location: ~S"
3354 (aver (eq kind :code-location))
3355 (let ((bpt (%make-breakpoint hook-function what kind info)))
3357 (interpreted-code-location
3358 (error "Breakpoints in interpreted code are currently unsupported."))
3359 (compiled-code-location
3360 ;; This slot is filled in due to calling CODE-LOCATION-UNKNOWN-P.
3361 (when (eq (compiled-code-location-kind what) :unknown-return)
3362 (let ((other-bpt (%make-breakpoint hook-function what
3363 :unknown-return-partner
3365 (setf (breakpoint-unknown-return-partner bpt) other-bpt)
3366 (setf (breakpoint-unknown-return-partner other-bpt) bpt)))))
3368 (compiled-debug-function
3371 (%make-breakpoint hook-function what kind info))
3373 (unless (eq (sb!c::compiled-debug-function-returns
3374 (compiled-debug-function-compiler-debug-fun what))
3376 (error ":FUNCTION-END breakpoints are currently unsupported ~
3377 for the known return convention."))
3379 (let* ((bpt (%make-breakpoint hook-function what kind info))
3380 (starter (compiled-debug-function-end-starter what)))
3382 (setf starter (%make-breakpoint #'list what :function-start nil))
3383 (setf (breakpoint-hook-function starter)
3384 (function-end-starter-hook starter what))
3385 (setf (compiled-debug-function-end-starter what) starter))
3386 (setf (breakpoint-start-helper bpt) starter)
3387 (push bpt (breakpoint-%info starter))
3388 (setf (breakpoint-cookie-fun bpt) function-end-cookie)
3390 (interpreted-debug-function
3391 (error ":function-end breakpoints are currently unsupported ~
3392 for interpreted-debug-functions."))))
3394 ;;; These are unique objects created upon entry into a function by a
3395 ;;; :FUNCTION-END breakpoint's starter hook. These are only created
3396 ;;; when users supply :FUNCTION-END-COOKIE to MAKE-BREAKPOINT. Also,
3397 ;;; the :FUNCTION-END breakpoint's hook is called on the same cookie
3398 ;;; when it is created.
3399 (defstruct (function-end-cookie
3400 (:print-object (lambda (obj str)
3401 (print-unreadable-object (obj str :type t))))
3402 (:constructor make-function-end-cookie (bogus-lra debug-fun))
3404 ;; a pointer to the bogus-lra created for :FUNCTION-END breakpoints
3406 ;; the debug-function associated with the cookie
3409 ;;; This maps bogus-lra-components to cookies, so that
3410 ;;; HANDLE-FUNCTION-END-BREAKPOINT can find the appropriate cookie for the
3411 ;;; breakpoint hook.
3412 (defvar *function-end-cookies* (make-hash-table :test 'eq))
3414 ;;; This returns a hook function for the start helper breakpoint
3415 ;;; associated with a :FUNCTION-END breakpoint. The returned function
3416 ;;; makes a fake LRA that all returns go through, and this piece of
3417 ;;; fake code actually breaks. Upon return from the break, the code
3418 ;;; provides the returnee with any values. Since the returned function
3419 ;;; effectively activates FUN-END-BPT on each entry to DEBUG-FUN's
3420 ;;; function, we must establish breakpoint-data about FUN-END-BPT.
3421 (defun function-end-starter-hook (starter-bpt debug-fun)
3422 (declare (type breakpoint starter-bpt)
3423 (type compiled-debug-function debug-fun))
3424 #'(lambda (frame breakpoint)
3425 (declare (ignore breakpoint)
3427 (let ((lra-sc-offset
3428 (sb!c::compiled-debug-function-return-pc
3429 (compiled-debug-function-compiler-debug-fun debug-fun))))
3430 (multiple-value-bind (lra component offset)
3432 (get-context-value frame
3433 #!-gengc sb!vm::lra-save-offset
3434 #!+gengc sb!vm::ra-save-offset
3436 (setf (get-context-value frame
3437 #!-gengc sb!vm::lra-save-offset
3438 #!+gengc sb!vm::ra-save-offset
3441 (let ((end-bpts (breakpoint-%info starter-bpt)))
3442 (let ((data (breakpoint-data component offset)))
3443 (setf (breakpoint-data-breakpoints data) end-bpts)
3444 (dolist (bpt end-bpts)
3445 (setf (breakpoint-internal-data bpt) data)))
3446 (let ((cookie (make-function-end-cookie lra debug-fun)))
3447 (setf (gethash component *function-end-cookies*) cookie)
3448 (dolist (bpt end-bpts)
3449 (let ((fun (breakpoint-cookie-fun bpt)))
3450 (when fun (funcall fun frame cookie))))))))))
3452 ;;; This takes a FUNCTION-END-COOKIE and a frame, and it returns
3453 ;;; whether the cookie is still valid. A cookie becomes invalid when
3454 ;;; the frame that established the cookie has exited. Sometimes cookie
3455 ;;; holders are unaware of cookie invalidation because their
3456 ;;; :FUNCTION-END breakpoint hooks didn't run due to THROW'ing.
3458 ;;; This takes a frame as an efficiency hack since the user probably
3459 ;;; has a frame object in hand when using this routine, and it saves
3460 ;;; repeated parsing of the stack and consing when asking whether a
3461 ;;; series of cookies is valid.
3462 (defun function-end-cookie-valid-p (frame cookie)
3463 (let ((lra (function-end-cookie-bogus-lra cookie))
3464 (lra-sc-offset (sb!c::compiled-debug-function-return-pc
3465 (compiled-debug-function-compiler-debug-fun
3466 (function-end-cookie-debug-fun cookie)))))
3467 (do ((frame frame (frame-down frame)))
3469 (when (and (compiled-frame-p frame)
3471 (get-context-value frame
3472 #!-gengc sb!vm::lra-save-offset
3473 #!+gengc sb!vm::ra-save-offset
3477 ;;;; ACTIVATE-BREAKPOINT
3479 ;;; Cause the system to invoke the breakpoint's hook-function until
3480 ;;; the next call to DEACTIVATE-BREAKPOINT or DELETE-BREAKPOINT. The
3481 ;;; system invokes breakpoint hook functions in the opposite order
3482 ;;; that you activate them.
3483 (defun activate-breakpoint (breakpoint)
3484 (when (eq (breakpoint-status breakpoint) :deleted)
3485 (error "cannot activate a deleted breakpoint: ~S" breakpoint))
3486 (unless (eq (breakpoint-status breakpoint) :active)
3487 (ecase (breakpoint-kind breakpoint)
3489 (let ((loc (breakpoint-what breakpoint)))
3491 (interpreted-code-location
3492 (error "Breakpoints in interpreted code are currently unsupported."))
3493 (compiled-code-location
3494 (activate-compiled-code-location-breakpoint breakpoint)
3495 (let ((other (breakpoint-unknown-return-partner breakpoint)))
3497 (activate-compiled-code-location-breakpoint other)))))))
3499 (etypecase (breakpoint-what breakpoint)
3500 (compiled-debug-function
3501 (activate-compiled-function-start-breakpoint breakpoint))
3502 (interpreted-debug-function
3503 (error "I don't know how you made this, but they're unsupported: ~S"
3504 (breakpoint-what breakpoint)))))
3506 (etypecase (breakpoint-what breakpoint)
3507 (compiled-debug-function
3508 (let ((starter (breakpoint-start-helper breakpoint)))
3509 (unless (eq (breakpoint-status starter) :active)
3510 ;; may already be active by some other :FUNCTION-END breakpoint
3511 (activate-compiled-function-start-breakpoint starter)))
3512 (setf (breakpoint-status breakpoint) :active))
3513 (interpreted-debug-function
3514 (error "I don't know how you made this, but they're unsupported: ~S"
3515 (breakpoint-what breakpoint)))))))
3518 (defun activate-compiled-code-location-breakpoint (breakpoint)
3519 (declare (type breakpoint breakpoint))
3520 (let ((loc (breakpoint-what breakpoint)))
3521 (declare (type compiled-code-location loc))
3522 (sub-activate-breakpoint
3524 (breakpoint-data (compiled-debug-function-component
3525 (code-location-debug-function loc))
3526 (+ (compiled-code-location-pc loc)
3527 (if (or (eq (breakpoint-kind breakpoint)
3528 :unknown-return-partner)
3529 (eq (compiled-code-location-kind loc)
3530 :single-value-return))
3531 sb!vm:single-value-return-byte-offset
3534 (defun activate-compiled-function-start-breakpoint (breakpoint)
3535 (declare (type breakpoint breakpoint))
3536 (let ((debug-fun (breakpoint-what breakpoint)))
3537 (sub-activate-breakpoint
3539 (breakpoint-data (compiled-debug-function-component debug-fun)
3540 (sb!c::compiled-debug-function-start-pc
3541 (compiled-debug-function-compiler-debug-fun
3544 (defun sub-activate-breakpoint (breakpoint data)
3545 (declare (type breakpoint breakpoint)
3546 (type breakpoint-data data))
3547 (setf (breakpoint-status breakpoint) :active)
3549 (unless (breakpoint-data-breakpoints data)
3550 (setf (breakpoint-data-instruction data)
3552 (breakpoint-install (get-lisp-obj-address
3553 (breakpoint-data-component data))
3554 (breakpoint-data-offset data)))))
3555 (setf (breakpoint-data-breakpoints data)
3556 (append (breakpoint-data-breakpoints data) (list breakpoint)))
3557 (setf (breakpoint-internal-data breakpoint) data)))
3559 ;;;; DEACTIVATE-BREAKPOINT
3561 (defun deactivate-breakpoint (breakpoint)
3563 "This stops the system from invoking the breakpoint's hook-function."
3564 (when (eq (breakpoint-status breakpoint) :active)
3566 (let ((loc (breakpoint-what breakpoint)))
3568 ((or interpreted-code-location interpreted-debug-function)
3570 "Breakpoints in interpreted code are currently unsupported."))
3571 ((or compiled-code-location compiled-debug-function)
3572 (deactivate-compiled-breakpoint breakpoint)
3573 (let ((other (breakpoint-unknown-return-partner breakpoint)))
3575 (deactivate-compiled-breakpoint other))))))))
3578 (defun deactivate-compiled-breakpoint (breakpoint)
3579 (if (eq (breakpoint-kind breakpoint) :function-end)
3580 (let ((starter (breakpoint-start-helper breakpoint)))
3581 (unless (find-if #'(lambda (bpt)
3582 (and (not (eq bpt breakpoint))
3583 (eq (breakpoint-status bpt) :active)))
3584 (breakpoint-%info starter))
3585 (deactivate-compiled-breakpoint starter)))
3586 (let* ((data (breakpoint-internal-data breakpoint))
3587 (bpts (delete breakpoint (breakpoint-data-breakpoints data))))
3588 (setf (breakpoint-internal-data breakpoint) nil)
3589 (setf (breakpoint-data-breakpoints data) bpts)
3592 (breakpoint-remove (get-lisp-obj-address
3593 (breakpoint-data-component data))
3594 (breakpoint-data-offset data)
3595 (breakpoint-data-instruction data)))
3596 (delete-breakpoint-data data))))
3597 (setf (breakpoint-status breakpoint) :inactive)
3600 ;;;; BREAKPOINT-INFO
3602 (defun breakpoint-info (breakpoint)
3604 "This returns the user-maintained info associated with breakpoint. This
3606 (breakpoint-%info breakpoint))
3607 (defun %set-breakpoint-info (breakpoint value)
3608 (setf (breakpoint-%info breakpoint) value)
3609 (let ((other (breakpoint-unknown-return-partner breakpoint)))
3611 (setf (breakpoint-%info other) value))))
3613 ;;;; BREAKPOINT-ACTIVE-P and DELETE-BREAKPOINT
3615 (defun breakpoint-active-p (breakpoint)
3617 "This returns whether breakpoint is currently active."
3618 (ecase (breakpoint-status breakpoint)
3620 ((:inactive :deleted) nil)))
3622 (defun delete-breakpoint (breakpoint)
3624 "This frees system storage and removes computational overhead associated with
3625 breakpoint. After calling this, breakpoint is completely impotent and can
3626 never become active again."
3627 (let ((status (breakpoint-status breakpoint)))
3628 (unless (eq status :deleted)
3629 (when (eq status :active)
3630 (deactivate-breakpoint breakpoint))
3631 (setf (breakpoint-status breakpoint) :deleted)
3632 (let ((other (breakpoint-unknown-return-partner breakpoint)))
3634 (setf (breakpoint-status other) :deleted)))
3635 (when (eq (breakpoint-kind breakpoint) :function-end)
3636 (let* ((starter (breakpoint-start-helper breakpoint))
3637 (breakpoints (delete breakpoint
3638 (the list (breakpoint-info starter)))))
3639 (setf (breakpoint-info starter) breakpoints)
3641 (delete-breakpoint starter)
3642 (setf (compiled-debug-function-end-starter
3643 (breakpoint-what breakpoint))
3647 ;;;; C call out stubs
3649 ;;; This actually installs the break instruction in the component. It
3650 ;;; returns the overwritten bits. You must call this in a context in
3651 ;;; which GC is disabled, so that Lisp doesn't move objects around
3652 ;;; that C is pointing to.
3653 (sb!alien:def-alien-routine "breakpoint_install" sb!c-call:unsigned-long
3654 (code-obj sb!c-call:unsigned-long)
3655 (pc-offset sb!c-call:int))
3657 ;;; This removes the break instruction and replaces the original
3658 ;;; instruction. You must call this in a context in which GC is disabled
3659 ;;; so Lisp doesn't move objects around that C is pointing to.
3660 (sb!alien:def-alien-routine "breakpoint_remove" sb!c-call:void
3661 (code-obj sb!c-call:unsigned-long)
3662 (pc-offset sb!c-call:int)
3663 (old-inst sb!c-call:unsigned-long))
3665 (sb!alien:def-alien-routine "breakpoint_do_displaced_inst" sb!c-call:void
3666 (scp (* os-context-t))
3667 (orig-inst sb!c-call:unsigned-long))
3669 ;;;; breakpoint handlers (layer between C and exported interface)
3671 ;;; This maps components to a mapping of offsets to breakpoint-datas.
3672 (defvar *component-breakpoint-offsets* (make-hash-table :test 'eq))
3674 ;;; This returns the breakpoint-data associated with component cross
3675 ;;; offset. If none exists, this makes one, installs it, and returns it.
3676 (defun breakpoint-data (component offset &optional (create t))
3677 (flet ((install-breakpoint-data ()
3679 (let ((data (make-breakpoint-data component offset)))
3680 (push (cons offset data)
3681 (gethash component *component-breakpoint-offsets*))
3683 (let ((offsets (gethash component *component-breakpoint-offsets*)))
3685 (let ((data (assoc offset offsets)))
3688 (install-breakpoint-data)))
3689 (install-breakpoint-data)))))
3691 ;;; We use this when there are no longer any active breakpoints
3692 ;;; corresponding to data.
3693 (defun delete-breakpoint-data (data)
3694 (let* ((component (breakpoint-data-component data))
3695 (offsets (delete (breakpoint-data-offset data)
3696 (gethash component *component-breakpoint-offsets*)
3699 (setf (gethash component *component-breakpoint-offsets*) offsets)
3700 (remhash component *component-breakpoint-offsets*)))
3703 ;;; The C handler for interrupts calls this when it has a
3704 ;;; debugging-tool break instruction. This does NOT handle all breaks;
3705 ;;; for example, it does not handle breaks for internal errors.
3706 (defun handle-breakpoint (offset component signal-context)
3707 (/show0 "entering HANDLE-BREAKPOINT")
3708 (let ((data (breakpoint-data component offset nil)))
3710 (error "unknown breakpoint in ~S at offset ~S"
3711 (debug-function-name (debug-function-from-pc component offset))
3713 (let ((breakpoints (breakpoint-data-breakpoints data)))
3714 (if (or (null breakpoints)
3715 (eq (breakpoint-kind (car breakpoints)) :function-end))
3716 (handle-function-end-breakpoint-aux breakpoints data signal-context)
3717 (handle-breakpoint-aux breakpoints data
3718 offset component signal-context)))))
3720 ;;; This holds breakpoint-datas while invoking the breakpoint hooks
3721 ;;; associated with that particular component and location. While they
3722 ;;; are executing, if we hit the location again, we ignore the
3723 ;;; breakpoint to avoid infinite recursion. Function-end breakpoints
3724 ;;; must work differently since the breakpoint-data is unique for each
3726 (defvar *executing-breakpoint-hooks* nil)
3728 ;;; This handles code-location and debug-function :FUNCTION-START
3730 (defun handle-breakpoint-aux (breakpoints data offset component signal-context)
3731 (/show0 "entering HANDLE-BREAKPOINT-AUX")
3733 (error "internal error: breakpoint that nobody wants"))
3734 (unless (member data *executing-breakpoint-hooks*)
3735 (let ((*executing-breakpoint-hooks* (cons data
3736 *executing-breakpoint-hooks*)))
3737 (invoke-breakpoint-hooks breakpoints component offset)))
3738 ;; At this point breakpoints may not hold the same list as
3739 ;; BREAKPOINT-DATA-BREAKPOINTS since invoking hooks may have allowed
3740 ;; a breakpoint deactivation. In fact, if all breakpoints were
3741 ;; deactivated then data is invalid since it was deleted and so the
3742 ;; correct one must be looked up if it is to be used. If there are
3743 ;; no more breakpoints active at this location, then the normal
3744 ;; instruction has been put back, and we do not need to
3745 ;; DO-DISPLACED-INST.
3746 (let ((data (breakpoint-data component offset nil)))
3747 (when (and data (breakpoint-data-breakpoints data))
3748 ;; The breakpoint is still active, so we need to execute the
3749 ;; displaced instruction and leave the breakpoint instruction
3750 ;; behind. The best way to do this is different on each machine,
3751 ;; so we just leave it up to the C code.
3752 (breakpoint-do-displaced-inst signal-context
3753 (breakpoint-data-instruction data))
3754 ;; Some platforms have no usable sigreturn() call. If your
3755 ;; implementation of arch_do_displaced_inst() doesn't sigreturn(),
3756 ;; add it to this list.
3757 #!-(or hpux irix x86 alpha)
3758 (error "BREAKPOINT-DO-DISPLACED-INST returned?"))))
3760 (defun invoke-breakpoint-hooks (breakpoints component offset)
3761 (let* ((debug-fun (debug-function-from-pc component offset))
3762 (frame (do ((f (top-frame) (frame-down f)))
3763 ((eq debug-fun (frame-debug-function f)) f))))
3764 (dolist (bpt breakpoints)
3765 (funcall (breakpoint-hook-function bpt)
3767 ;; If this is an :UNKNOWN-RETURN-PARTNER, then pass the
3768 ;; hook function the original breakpoint, so that users
3769 ;; aren't forced to confront the fact that some
3770 ;; breakpoints really are two.
3771 (if (eq (breakpoint-kind bpt) :unknown-return-partner)
3772 (breakpoint-unknown-return-partner bpt)
3775 (defun handle-function-end-breakpoint (offset component context)
3776 (/show0 "entering HANDLE-FUNCTION-END-BREAKPOINT")
3777 (let ((data (breakpoint-data component offset nil)))
3779 (error "unknown breakpoint in ~S at offset ~S"
3780 (debug-function-name (debug-function-from-pc component offset))
3782 (let ((breakpoints (breakpoint-data-breakpoints data)))
3784 (aver (eq (breakpoint-kind (car breakpoints)) :function-end))
3785 (handle-function-end-breakpoint-aux breakpoints data context)))))
3787 ;;; Either HANDLE-BREAKPOINT calls this for :FUNCTION-END breakpoints
3788 ;;; [old C code] or HANDLE-FUNCTION-END-BREAKPOINT calls this directly
3790 (defun handle-function-end-breakpoint-aux (breakpoints data signal-context)
3791 (/show0 "entering HANDLE-FUNCTION-END-BREAKPOINT-AUX")
3792 (delete-breakpoint-data data)
3795 (declare (optimize (inhibit-warnings 3)))
3796 (sb!alien:sap-alien signal-context (* os-context-t))))
3797 (frame (do ((cfp (sb!vm:context-register scp sb!vm::cfp-offset))
3798 (f (top-frame) (frame-down f)))
3799 ((= cfp (sap-int (frame-pointer f))) f)
3800 (declare (type (unsigned-byte #.sb!vm:word-bits) cfp))))
3801 (component (breakpoint-data-component data))
3802 (cookie (gethash component *function-end-cookies*)))
3803 (remhash component *function-end-cookies*)
3804 (dolist (bpt breakpoints)
3805 (funcall (breakpoint-hook-function bpt)
3807 (get-function-end-breakpoint-values scp)
3810 (defun get-function-end-breakpoint-values (scp)
3811 (let ((ocfp (int-sap (sb!vm:context-register
3813 #!-x86 sb!vm::ocfp-offset
3814 #!+x86 sb!vm::ebx-offset)))
3815 (nargs (make-lisp-obj
3816 (sb!vm:context-register scp sb!vm::nargs-offset)))
3817 (reg-arg-offsets '#.sb!vm::*register-arg-offsets*)
3820 (dotimes (arg-num nargs)
3821 (push (if reg-arg-offsets
3823 (sb!vm:context-register scp (pop reg-arg-offsets)))
3824 (stack-ref ocfp arg-num))
3826 (nreverse results)))
3828 ;;;; MAKE-BOGUS-LRA (used for :FUNCTION-END breakpoints)
3835 (+ sb!vm:code-constants-offset #!-x86 1 #!+x86 2))
3837 ;;; FIXME: This is also defined in debug-vm.lisp. Which definition
3838 ;;; takes precedence? (One definition uses ALLOCATE-CODE-OBJECT, and
3839 ;;; the other has been hacked for X86 GENCGC to use
3840 ;;; ALLOCATE-DYNAMIC-CODE-OBJECT..)
3841 (defun make-bogus-lra (real-lra &optional known-return-p)
3843 "Make a bogus LRA object that signals a breakpoint trap when returned to. If
3844 the breakpoint trap handler returns, REAL-LRA is returned to. Three values
3845 are returned: the bogus LRA object, the code component it is part of, and
3846 the PC offset for the trap instruction."
3848 (let* ((src-start (foreign-symbol-address "function_end_breakpoint_guts"))
3849 (src-end (foreign-symbol-address "function_end_breakpoint_end"))
3850 (trap-loc (foreign-symbol-address "function_end_breakpoint_trap"))
3851 (length (sap- src-end src-start))
3854 #!-(and x86 gencgc) sb!c:allocate-code-object
3855 #!+(and x86 gencgc) sb!c::allocate-dynamic-code-object
3856 (1+ bogus-lra-constants)
3858 (dst-start (code-instructions code-object)))
3859 (declare (type system-area-pointer
3860 src-start src-end dst-start trap-loc)
3861 (type index length))
3862 (setf (%code-debug-info code-object) :bogus-lra)
3863 (setf (code-header-ref code-object sb!vm:code-trace-table-offset-slot)
3866 (setf (code-header-ref code-object real-lra-slot) real-lra)
3868 (multiple-value-bind (offset code) (compute-lra-data-from-pc real-lra)
3869 (setf (code-header-ref code-object real-lra-slot) code)
3870 (setf (code-header-ref code-object (1+ real-lra-slot)) offset))
3871 (setf (code-header-ref code-object known-return-p-slot)
3873 (system-area-copy src-start 0 dst-start 0 (* length sb!vm:byte-bits))
3874 (sb!vm:sanctify-for-execution code-object)
3876 (values dst-start code-object (sap- trap-loc src-start))
3878 (let ((new-lra (make-lisp-obj (+ (sap-int dst-start)
3879 sb!vm:other-pointer-type))))
3882 (logandc2 (+ sb!vm:code-constants-offset bogus-lra-constants 1)
3884 (sb!vm:sanctify-for-execution code-object)
3885 (values new-lra code-object (sap- trap-loc src-start))))))
3889 ;;; This appears here because it cannot go with the debug-function
3890 ;;; interface since DO-DEBUG-BLOCK-LOCATIONS isn't defined until after
3891 ;;; the debug-function routines.
3893 (defun debug-function-start-location (debug-fun)
3895 "This returns a code-location before the body of a function and after all
3896 the arguments are in place. If this cannot determine that location due to
3897 a lack of debug information, it returns nil."
3898 (etypecase debug-fun
3899 (compiled-debug-function
3900 (code-location-from-pc debug-fun
3901 (sb!c::compiled-debug-function-start-pc
3902 (compiled-debug-function-compiler-debug-fun
3905 (interpreted-debug-function
3906 ;; Return the first location if there are any, otherwise NIL.
3907 (handler-case (do-debug-function-blocks (block debug-fun nil)
3908 (do-debug-block-locations (loc block nil)
3909 (return-from debug-function-start-location loc)))
3910 (no-debug-blocks (condx)
3911 (declare (ignore condx))
3914 (defun print-code-locations (function)
3915 (let ((debug-fun (function-debug-function function)))
3916 (do-debug-function-blocks (block debug-fun)
3917 (do-debug-block-locations (loc block)
3918 (fill-in-code-location loc)
3919 (format t "~S code location at ~D"
3920 (compiled-code-location-kind loc)
3921 (compiled-code-location-pc loc))
3922 (sb!debug::print-code-location-source-form loc 0)