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-fun-returns (debug-condition)
45 ((debug-fun :reader no-debug-fun-returns-debug-fun
49 "The system could not return values from a frame with DEBUG-FUN since
50 it lacked information about returning values.")
51 (:report (lambda (condition stream)
52 (let ((fun (debug-fun-fun
53 (no-debug-fun-returns-debug-fun condition))))
55 "~&Cannot return values from ~:[frame~;~:*~S~] since ~
56 the debug information lacks details about returning ~
60 (define-condition no-debug-blocks (debug-condition)
61 ((debug-fun :reader no-debug-blocks-debug-fun
64 (:documentation "The debug-fun has no debug-block information.")
65 (:report (lambda (condition stream)
66 (format stream "~&~S has no debug-block information."
67 (no-debug-blocks-debug-fun condition)))))
69 (define-condition no-debug-vars (debug-condition)
70 ((debug-fun :reader no-debug-vars-debug-fun
73 (:documentation "The DEBUG-FUN has no DEBUG-VAR information.")
74 (:report (lambda (condition stream)
75 (format stream "~&~S has no debug variable information."
76 (no-debug-vars-debug-fun condition)))))
78 (define-condition lambda-list-unavailable (debug-condition)
79 ((debug-fun :reader lambda-list-unavailable-debug-fun
83 "The DEBUG-FUN has no lambda list since argument DEBUG-VARs are
85 (:report (lambda (condition stream)
86 (format stream "~&~S has no lambda-list information available."
87 (lambda-list-unavailable-debug-fun condition)))))
89 (define-condition invalid-value (debug-condition)
90 ((debug-var :reader invalid-value-debug-var :initarg :debug-var)
91 (frame :reader invalid-value-frame :initarg :frame))
92 (:report (lambda (condition stream)
93 (format stream "~&~S has :invalid or :unknown value in ~S."
94 (invalid-value-debug-var condition)
95 (invalid-value-frame condition)))))
97 (define-condition ambiguous-var-name (debug-condition)
98 ((name :reader ambiguous-var-name-name :initarg :name)
99 (frame :reader ambiguous-var-name-frame :initarg :frame))
100 (:report (lambda (condition stream)
101 (format stream "~&~S names more than one valid variable in ~S."
102 (ambiguous-var-name-name condition)
103 (ambiguous-var-name-frame condition)))))
105 ;;;; errors and DEBUG-SIGNAL
107 ;;; The debug-internals code tries to signal all programmer errors as
108 ;;; subtypes of DEBUG-ERROR. There are calls to ERROR signalling
109 ;;; SIMPLE-ERRORs, but these dummy checks in the code and shouldn't
112 ;;; While under development, this code also signals errors in code
113 ;;; branches that remain unimplemented.
115 (define-condition debug-error (error) ()
118 "All programmer errors from using the interface for building debugging
119 tools inherit from this type."))
121 (define-condition unhandled-debug-condition (debug-error)
122 ((condition :reader unhandled-debug-condition-condition :initarg :condition))
123 (:report (lambda (condition stream)
124 (format stream "~&unhandled DEBUG-CONDITION:~%~A"
125 (unhandled-debug-condition-condition condition)))))
127 (define-condition unknown-code-location (debug-error)
128 ((code-location :reader unknown-code-location-code-location
129 :initarg :code-location))
130 (:report (lambda (condition stream)
131 (format stream "~&invalid use of an unknown code-location: ~S"
132 (unknown-code-location-code-location condition)))))
134 (define-condition unknown-debug-var (debug-error)
135 ((debug-var :reader unknown-debug-var-debug-var :initarg :debug-var)
136 (debug-fun :reader unknown-debug-var-debug-fun
137 :initarg :debug-fun))
138 (:report (lambda (condition stream)
139 (format stream "~&~S is not in ~S."
140 (unknown-debug-var-debug-var condition)
141 (unknown-debug-var-debug-fun condition)))))
143 (define-condition invalid-control-stack-pointer (debug-error)
145 (:report (lambda (condition stream)
146 (declare (ignore condition))
148 (write-string "invalid control stack pointer" stream))))
150 (define-condition frame-fun-mismatch (debug-error)
151 ((code-location :reader frame-fun-mismatch-code-location
152 :initarg :code-location)
153 (frame :reader frame-fun-mismatch-frame :initarg :frame)
154 (form :reader frame-fun-mismatch-form :initarg :form))
155 (:report (lambda (condition stream)
158 "~&Form was preprocessed for ~S,~% but called on ~S:~% ~S"
159 (frame-fun-mismatch-code-location condition)
160 (frame-fun-mismatch-frame condition)
161 (frame-fun-mismatch-form condition)))))
163 ;;; This signals debug-conditions. If they go unhandled, then signal
164 ;;; an UNHANDLED-DEBUG-CONDITION error.
166 ;;; ??? Get SIGNAL in the right package!
167 (defmacro debug-signal (datum &rest arguments)
168 `(let ((condition (make-condition ,datum ,@arguments)))
170 (error 'unhandled-debug-condition :condition condition)))
174 ;;;; Most of these structures model information stored in internal
175 ;;;; data structures created by the compiler. Whenever comments
176 ;;;; preface an object or type with "compiler", they refer to the
177 ;;;; internal compiler thing, not to the object or type with the same
178 ;;;; name in the "SB-DI" package.
182 ;;; These exist for caching data stored in packed binary form in
183 ;;; compiler DEBUG-FUNs.
184 (defstruct (debug-var (:constructor nil)
186 ;; the name of the variable
187 (symbol (missing-arg) :type symbol)
188 ;; a unique integer identification relative to other variables with the same
191 ;; Does the variable always have a valid value?
192 (alive-p nil :type boolean))
193 (def!method print-object ((debug-var debug-var) stream)
194 (print-unreadable-object (debug-var stream :type t :identity t)
197 (debug-var-symbol debug-var)
198 (debug-var-id debug-var))))
201 (setf (fdocumentation 'debug-var-id 'function)
202 "Return the integer that makes DEBUG-VAR's name and package unique
203 with respect to other DEBUG-VARs in the same function.")
205 (defstruct (compiled-debug-var
207 (:constructor make-compiled-debug-var
208 (symbol id alive-p sc-offset save-sc-offset info))
210 ;; storage class and offset (unexported)
211 (sc-offset nil :type sb!c:sc-offset)
212 ;; storage class and offset when saved somewhere
213 (save-sc-offset nil :type (or sb!c:sc-offset null))
218 ;;; These represent call frames on the stack.
219 (defstruct (frame (:constructor nil)
221 ;; the next frame up, or NIL when top frame
222 (up nil :type (or frame null))
223 ;; the previous frame down, or NIL when the bottom frame. Before
224 ;; computing the next frame down, this slot holds the frame pointer
225 ;; to the control stack for the given frame. This lets us get the
226 ;; next frame down and the return-pc for that frame.
227 (%down :unparsed :type (or frame (member nil :unparsed)))
228 ;; the DEBUG-FUN for the function whose call this frame represents
229 (debug-fun nil :type debug-fun)
230 ;; the CODE-LOCATION where the frame's DEBUG-FUN will continue
231 ;; running when program execution returns to this frame. If someone
232 ;; interrupted this frame, the result could be an unknown
234 (code-location nil :type code-location)
235 ;; an a-list of catch-tags to code-locations
236 (%catches :unparsed :type (or list (member :unparsed)))
237 ;; pointer to frame on control stack (unexported)
239 ;; This is the frame's number for prompt printing. Top is zero.
240 (number 0 :type index))
242 (defstruct (compiled-frame
244 (:constructor make-compiled-frame
245 (pointer up debug-fun code-location number
248 ;; This indicates whether someone interrupted the frame.
249 ;; (unexported). If escaped, this is a pointer to the state that was
250 ;; saved when we were interrupted, an os_context_t, i.e. the third
251 ;; argument to an SA_SIGACTION-style signal handler.
253 (def!method print-object ((obj compiled-frame) str)
254 (print-unreadable-object (obj str :type t)
256 "~S~:[~;, interrupted~]"
257 (debug-fun-name (frame-debug-fun obj))
258 (compiled-frame-escaped obj))))
262 ;;; These exist for caching data stored in packed binary form in
263 ;;; compiler DEBUG-FUNs. *COMPILED-DEBUG-FUNS* maps a SB!C::DEBUG-FUN
264 ;;; to a DEBUG-FUN. There should only be one DEBUG-FUN in existence
265 ;;; for any function; that is, all CODE-LOCATIONs and other objects
266 ;;; that reference DEBUG-FUNs point to unique objects. This is
267 ;;; due to the overhead in cached information.
268 (defstruct (debug-fun (:constructor nil)
270 ;; some representation of the function arguments. See
271 ;; DEBUG-FUN-LAMBDA-LIST.
272 ;; NOTE: must parse vars before parsing arg list stuff.
273 (%lambda-list :unparsed)
274 ;; cached DEBUG-VARS information (unexported).
275 ;; These are sorted by their name.
276 (%debug-vars :unparsed :type (or simple-vector null (member :unparsed)))
277 ;; cached debug-block information. This is NIL when we have tried to
278 ;; parse the packed binary info, but none is available.
279 (blocks :unparsed :type (or simple-vector null (member :unparsed)))
280 ;; the actual function if available
281 (%function :unparsed :type (or null function (member :unparsed))))
282 (def!method print-object ((obj debug-fun) stream)
283 (print-unreadable-object (obj stream :type t)
284 (prin1 (debug-fun-name obj) stream)))
286 (defstruct (compiled-debug-fun
288 (:constructor %make-compiled-debug-fun
289 (compiler-debug-fun component))
291 ;; compiler's dumped DEBUG-FUN information (unexported)
292 (compiler-debug-fun nil :type sb!c::compiled-debug-fun)
293 ;; code object (unexported).
295 ;; the :FUN-START breakpoint (if any) used to facilitate
296 ;; function end breakpoints
297 (end-starter nil :type (or null breakpoint)))
299 ;;; This maps SB!C::COMPILED-DEBUG-FUNs to
300 ;;; COMPILED-DEBUG-FUNs, so we can get at cached stuff and not
301 ;;; duplicate COMPILED-DEBUG-FUN structures.
302 (defvar *compiled-debug-funs* (make-hash-table :test 'eq :weakness :key))
304 ;;; Make a COMPILED-DEBUG-FUN for a SB!C::COMPILER-DEBUG-FUN and its
305 ;;; component. This maps the latter to the former in
306 ;;; *COMPILED-DEBUG-FUNS*. If there already is a COMPILED-DEBUG-FUN,
307 ;;; then this returns it from *COMPILED-DEBUG-FUNS*.
309 ;;; FIXME: It seems this table can potentially grow without bounds,
310 ;;; and retains roots to functions that might otherwise be collected.
311 (defun make-compiled-debug-fun (compiler-debug-fun component)
312 (let ((table *compiled-debug-funs*))
313 (with-locked-system-table (table)
314 (or (gethash compiler-debug-fun table)
315 (setf (gethash compiler-debug-fun table)
316 (%make-compiled-debug-fun compiler-debug-fun component))))))
318 (defstruct (bogus-debug-fun
320 (:constructor make-bogus-debug-fun
331 ;;; These exist for caching data stored in packed binary form in compiler
333 (defstruct (debug-block (:constructor nil)
335 ;; Code-locations where execution continues after this block.
336 (successors nil :type list)
337 ;; This indicates whether the block is a special glob of code shared
338 ;; by various functions and tucked away elsewhere in a component.
339 ;; This kind of block has no start code-location. This slot is in
340 ;; all debug-blocks since it is an exported interface.
341 (elsewhere-p nil :type boolean))
342 (def!method print-object ((obj debug-block) str)
343 (print-unreadable-object (obj str :type t)
344 (prin1 (debug-block-fun-name obj) str)))
347 (setf (fdocumentation 'debug-block-successors 'function)
348 "Return the list of possible code-locations where execution may continue
349 when the basic-block represented by debug-block completes its execution.")
352 (setf (fdocumentation 'debug-block-elsewhere-p 'function)
353 "Return whether debug-block represents elsewhere code.")
355 (defstruct (compiled-debug-block (:include debug-block)
357 make-compiled-debug-block
358 (code-locations successors elsewhere-p))
360 ;; code-location information for the block
361 (code-locations nil :type simple-vector))
365 ;;; This is an internal structure that manages information about a
366 ;;; breakpoint locations. See *COMPONENT-BREAKPOINT-OFFSETS*.
367 (defstruct (breakpoint-data (:constructor make-breakpoint-data
370 ;; This is the component in which the breakpoint lies.
372 ;; This is the byte offset into the component.
373 (offset nil :type index)
374 ;; The original instruction replaced by the breakpoint.
375 (instruction nil :type (or null sb!vm::word))
376 ;; A list of user breakpoints at this location.
377 (breakpoints nil :type list))
378 (def!method print-object ((obj breakpoint-data) str)
379 (print-unreadable-object (obj str :type t)
380 (format str "~S at ~S"
382 (debug-fun-from-pc (breakpoint-data-component obj)
383 (breakpoint-data-offset obj)))
384 (breakpoint-data-offset obj))))
386 (defstruct (breakpoint (:constructor %make-breakpoint
387 (hook-fun what kind %info))
389 ;; This is the function invoked when execution encounters the
390 ;; breakpoint. It takes a frame, the breakpoint, and optionally a
391 ;; list of values. Values are supplied for :FUN-END breakpoints as
392 ;; values to return for the function containing the breakpoint.
393 ;; :FUN-END breakpoint hook functions also take a cookie argument.
394 ;; See the COOKIE-FUN slot.
395 (hook-fun (required-arg) :type function)
396 ;; CODE-LOCATION or DEBUG-FUN
397 (what nil :type (or code-location debug-fun))
398 ;; :CODE-LOCATION, :FUN-START, or :FUN-END for that kind
399 ;; of breakpoint. :UNKNOWN-RETURN-PARTNER if this is the partner of
400 ;; a :code-location breakpoint at an :UNKNOWN-RETURN code-location.
401 (kind nil :type (member :code-location :fun-start :fun-end
402 :unknown-return-partner))
403 ;; Status helps the user and the implementation.
404 (status :inactive :type (member :active :inactive :deleted))
405 ;; This is a backpointer to a breakpoint-data.
406 (internal-data nil :type (or null breakpoint-data))
407 ;; With code-locations whose type is :UNKNOWN-RETURN, there are
408 ;; really two breakpoints: one at the multiple-value entry point,
409 ;; and one at the single-value entry point. This slot holds the
410 ;; breakpoint for the other one, or NIL if this isn't at an
411 ;; :UNKNOWN-RETURN code location.
412 (unknown-return-partner nil :type (or null breakpoint))
413 ;; :FUN-END breakpoints use a breakpoint at the :FUN-START
414 ;; to establish the end breakpoint upon function entry. We do this
415 ;; by frobbing the LRA to jump to a special piece of code that
416 ;; breaks and provides the return values for the returnee. This slot
417 ;; points to the start breakpoint, so we can activate, deactivate,
419 (start-helper nil :type (or null breakpoint))
420 ;; This is a hook users supply to get a dynamically unique cookie
421 ;; for identifying :FUN-END breakpoint executions. That is, if
422 ;; there is one :FUN-END breakpoint, but there may be multiple
423 ;; pending calls of its function on the stack. This function takes
424 ;; the cookie, and the hook function takes the cookie too.
425 (cookie-fun nil :type (or null function))
426 ;; This slot users can set with whatever information they find useful.
428 (def!method print-object ((obj breakpoint) str)
429 (let ((what (breakpoint-what obj)))
430 (print-unreadable-object (obj str :type t)
435 (debug-fun (debug-fun-name what)))
438 (debug-fun (breakpoint-kind obj)))))))
442 (defstruct (code-location (:constructor nil)
444 ;; the DEBUG-FUN containing this CODE-LOCATION
445 (debug-fun nil :type debug-fun)
446 ;; This is initially :UNSURE. Upon first trying to access an
447 ;; :UNPARSED slot, if the data is unavailable, then this becomes T,
448 ;; and the code-location is unknown. If the data is available, this
449 ;; becomes NIL, a known location. We can't use a separate type
450 ;; code-location for this since we must return code-locations before
451 ;; we can tell whether they're known or unknown. For example, when
452 ;; parsing the stack, we don't want to unpack all the variables and
453 ;; blocks just to make frames.
454 (%unknown-p :unsure :type (member t nil :unsure))
455 ;; the DEBUG-BLOCK containing CODE-LOCATION. XXX Possibly toss this
456 ;; out and just find it in the blocks cache in DEBUG-FUN.
457 (%debug-block :unparsed :type (or debug-block (member :unparsed)))
458 ;; This is the number of forms processed by the compiler or loader
459 ;; before the top level form containing this code-location.
460 (%tlf-offset :unparsed :type (or index (member :unparsed)))
461 ;; This is the depth-first number of the node that begins
462 ;; code-location within its top level form.
463 (%form-number :unparsed :type (or index (member :unparsed))))
464 (def!method print-object ((obj code-location) str)
465 (print-unreadable-object (obj str :type t)
466 (prin1 (debug-fun-name (code-location-debug-fun obj))
469 (defstruct (compiled-code-location
470 (:include code-location)
471 (:constructor make-known-code-location
472 (pc debug-fun %tlf-offset %form-number
473 %live-set kind step-info &aux (%unknown-p nil)))
474 (:constructor make-compiled-code-location (pc debug-fun))
476 ;; an index into DEBUG-FUN's component slot
478 ;; a bit-vector indexed by a variable's position in
479 ;; DEBUG-FUN-DEBUG-VARS indicating whether the variable has a
480 ;; valid value at this code-location. (unexported).
481 (%live-set :unparsed :type (or simple-bit-vector (member :unparsed)))
482 ;; (unexported) To see SB!C::LOCATION-KIND, do
483 ;; (SB!KERNEL:TYPEXPAND 'SB!C::LOCATION-KIND).
484 (kind :unparsed :type (or (member :unparsed) sb!c::location-kind))
485 (step-info :unparsed :type (or (member :unparsed :foo) simple-string)))
489 ;;; Return the number of top level forms processed by the compiler
490 ;;; before compiling this source. If this source is uncompiled, this
491 ;;; is zero. This may be zero even if the source is compiled since the
492 ;;; first form in the first file compiled in one compilation, for
493 ;;; example, must have a root number of zero -- the compiler saw no
494 ;;; other top level forms before it.
495 (defun debug-source-root-number (debug-source)
496 (sb!c::debug-source-source-root debug-source))
500 ;;; This is used in FIND-ESCAPED-FRAME and with the bogus components
501 ;;; and LRAs used for :FUN-END breakpoints. When a component's
502 ;;; debug-info slot is :BOGUS-LRA, then the REAL-LRA-SLOT contains the
503 ;;; real component to continue executing, as opposed to the bogus
504 ;;; component which appeared in some frame's LRA location.
505 (defconstant real-lra-slot sb!vm:code-constants-offset)
507 ;;; These are magically converted by the compiler.
508 (defun current-sp () (current-sp))
509 (defun current-fp () (current-fp))
510 (defun stack-ref (s n) (stack-ref s n))
511 (defun %set-stack-ref (s n value) (%set-stack-ref s n value))
512 (defun fun-code-header (fun) (fun-code-header fun))
513 (defun lra-code-header (lra) (lra-code-header lra))
514 (defun %make-lisp-obj (value) (%make-lisp-obj value))
515 (defun get-lisp-obj-address (thing) (get-lisp-obj-address thing))
516 (defun fun-word-offset (fun) (fun-word-offset fun))
518 #!-sb-fluid (declaim (inline control-stack-pointer-valid-p))
519 (defun control-stack-pointer-valid-p (x &optional (aligned t))
520 (declare (type system-area-pointer x))
521 (let* (#!-stack-grows-downward-not-upward
523 (descriptor-sap *control-stack-start*))
524 #!+stack-grows-downward-not-upward
526 (descriptor-sap *control-stack-end*)))
527 #!-stack-grows-downward-not-upward
528 (and (sap< x (current-sp))
529 (sap<= control-stack-start x)
530 (or (not aligned) (zerop (logand (sap-int x)
531 (1- (ash 1 sb!vm:word-shift))))))
532 #!+stack-grows-downward-not-upward
533 (and (sap>= x (current-sp))
534 (sap> control-stack-end x)
535 (or (not aligned) (zerop (logand (sap-int x)
536 (1- (ash 1 sb!vm:word-shift))))))))
538 (declaim (inline component-ptr-from-pc))
539 (sb!alien:define-alien-routine component-ptr-from-pc (system-area-pointer)
540 (pc system-area-pointer))
542 (declaim (inline valid-lisp-pointer-p))
543 (sb!alien:define-alien-routine valid-lisp-pointer-p sb!alien:int
544 (pointer system-area-pointer))
546 (declaim (inline component-from-component-ptr))
547 (defun component-from-component-ptr (component-ptr)
548 (declare (type system-area-pointer component-ptr))
549 (make-lisp-obj (logior (sap-int component-ptr)
550 sb!vm:other-pointer-lowtag)))
552 ;;;; (OR X86 X86-64) support
554 (defun compute-lra-data-from-pc (pc)
555 (declare (type system-area-pointer pc))
556 (let ((component-ptr (component-ptr-from-pc pc)))
557 (unless (sap= component-ptr (int-sap #x0))
558 (let* ((code (component-from-component-ptr component-ptr))
559 (code-header-len (* (get-header-data code) sb!vm:n-word-bytes))
560 (pc-offset (- (sap-int pc)
561 (- (get-lisp-obj-address code)
562 sb!vm:other-pointer-lowtag)
564 ;;(format t "c-lra-fpc ~A ~A ~A~%" pc code pc-offset)
565 (values pc-offset code)))))
570 (defconstant sb!vm::nargs-offset #.sb!vm::ecx-offset)
572 ;;; Check for a valid return address - it could be any valid C/Lisp
575 ;;; XXX Could be a little smarter.
576 #!-sb-fluid (declaim (inline ra-pointer-valid-p))
577 (defun ra-pointer-valid-p (ra)
578 (declare (type system-area-pointer ra))
580 ;; not the first page (which is unmapped)
582 ;; FIXME: Where is this documented? Is it really true of every CPU
583 ;; architecture? Is it even necessarily true in current SBCL?
584 (>= (sap-int ra) 4096)
585 ;; not a Lisp stack pointer
586 (not (control-stack-pointer-valid-p ra))))
588 ;;; Try to find a valid previous stack. This is complex on the x86 as
589 ;;; it can jump between C and Lisp frames. To help find a valid frame
590 ;;; it searches backwards.
592 ;;; XXX Should probably check whether it has reached the bottom of the
595 ;;; XXX Should handle interrupted frames, both Lisp and C. At present
596 ;;; it manages to find a fp trail, see linux hack below.
597 (declaim (maybe-inline x86-call-context))
598 (defun x86-call-context (fp)
599 (declare (type system-area-pointer fp))
600 (let ((ocfp (sap-ref-sap fp (sb!vm::frame-byte-offset ocfp-save-offset)))
601 (ra (sap-ref-sap fp (sb!vm::frame-byte-offset return-pc-save-offset))))
602 (if (and (control-stack-pointer-valid-p fp)
604 (control-stack-pointer-valid-p ocfp)
605 (ra-pointer-valid-p ra))
607 (values nil (int-sap 0) (int-sap 0)))))
611 ;;; Convert the descriptor into a SAP. The bits all stay the same, we just
612 ;;; change our notion of what we think they are.
613 #!-sb-fluid (declaim (inline descriptor-sap))
614 (defun descriptor-sap (x)
615 (int-sap (get-lisp-obj-address x)))
617 ;;; Return the top frame of the control stack as it was before calling
620 (/noshow0 "entering TOP-FRAME")
621 (compute-calling-frame (descriptor-sap (%caller-frame))
625 ;;; Flush all of the frames above FRAME, and renumber all the frames
627 (defun flush-frames-above (frame)
628 (setf (frame-up frame) nil)
629 (do ((number 0 (1+ number))
630 (frame frame (frame-%down frame)))
631 ((not (frame-p frame)))
632 (setf (frame-number frame) number)))
634 (defun find-saved-frame-down (fp up-frame)
635 (multiple-value-bind (saved-fp saved-pc) (sb!c:find-saved-fp-and-pc fp)
637 (compute-calling-frame (descriptor-sap saved-fp)
638 (descriptor-sap saved-pc)
642 ;;; Return the frame immediately below FRAME on the stack; or when
643 ;;; FRAME is the bottom of the stack, return NIL.
644 (defun frame-down (frame)
645 (/noshow0 "entering FRAME-DOWN")
646 ;; We have to access the old-fp and return-pc out of frame and pass
647 ;; them to COMPUTE-CALLING-FRAME.
648 (let ((down (frame-%down frame)))
649 (if (eq down :unparsed)
650 (let ((debug-fun (frame-debug-fun frame)))
651 (/noshow0 "in DOWN :UNPARSED case")
652 (setf (frame-%down frame)
655 (let ((c-d-f (compiled-debug-fun-compiler-debug-fun
657 (compute-calling-frame
660 frame ocfp-save-offset
661 (sb!c::compiled-debug-fun-old-fp c-d-f)))
663 frame lra-save-offset
664 (sb!c::compiled-debug-fun-return-pc c-d-f))
667 (let ((fp (frame-pointer frame)))
668 (when (control-stack-pointer-valid-p fp)
670 (multiple-value-bind (ok ra ofp) (x86-call-context fp)
672 (compute-calling-frame ofp ra frame)
673 (find-saved-frame-down fp frame)))
675 (compute-calling-frame
677 (sap-ref-sap fp (* ocfp-save-offset
681 (sap-ref-32 fp (* ocfp-save-offset
682 sb!vm:n-word-bytes)))
684 (stack-ref fp lra-save-offset)
689 ;;; Get the old FP or return PC out of FRAME. STACK-SLOT is the
690 ;;; standard save location offset on the stack. LOC is the saved
691 ;;; SC-OFFSET describing the main location.
692 (defun get-context-value (frame stack-slot loc)
693 (declare (type compiled-frame frame) (type unsigned-byte stack-slot)
694 (type sb!c:sc-offset loc))
695 (let ((pointer (frame-pointer frame))
696 (escaped (compiled-frame-escaped frame)))
698 (sub-access-debug-var-slot pointer loc escaped)
700 (stack-ref pointer stack-slot)
704 (stack-ref pointer stack-slot))
706 (sap-ref-sap pointer (sb!vm::frame-byte-offset stack-slot)))))))
708 (defun (setf get-context-value) (value frame stack-slot loc)
709 (declare (type compiled-frame frame) (type unsigned-byte stack-slot)
710 (type sb!c:sc-offset loc))
711 (let ((pointer (frame-pointer frame))
712 (escaped (compiled-frame-escaped frame)))
714 (sub-set-debug-var-slot pointer loc value escaped)
716 (setf (stack-ref pointer stack-slot) value)
720 (setf (stack-ref pointer stack-slot) value))
722 (setf (sap-ref-sap pointer (sb!vm::frame-byte-offset stack-slot))
725 (defun foreign-function-backtrace-name (sap)
726 (let ((name (sap-foreign-symbol sap)))
728 (format nil "foreign function: ~A" name)
729 (format nil "foreign function: #x~X" (sap-int sap)))))
731 ;;; This returns a frame for the one existing in time immediately
732 ;;; prior to the frame referenced by current-fp. This is current-fp's
733 ;;; caller or the next frame down the control stack. If there is no
734 ;;; down frame, this returns NIL for the bottom of the stack. UP-FRAME
735 ;;; is the up link for the resulting frame object, and it is null when
736 ;;; we call this to get the top of the stack.
738 ;;; The current frame contains the pointer to the temporally previous
739 ;;; frame we want, and the current frame contains the pc at which we
740 ;;; will continue executing upon returning to that previous frame.
742 ;;; Note: Sometimes LRA is actually a fixnum. This happens when lisp
743 ;;; calls into C. In this case, the code object is stored on the stack
744 ;;; after the LRA, and the LRA is the word offset.
746 (defun compute-calling-frame (caller lra up-frame)
747 (declare (type system-area-pointer caller))
748 (/noshow0 "entering COMPUTE-CALLING-FRAME")
749 (when (control-stack-pointer-valid-p caller)
751 (multiple-value-bind (code pc-offset escaped)
753 (multiple-value-bind (word-offset code)
755 (let ((fp (frame-pointer up-frame)))
757 (stack-ref fp (1+ lra-save-offset))))
758 (values (get-header-data lra)
759 (lra-code-header lra)))
762 (* (1+ (- word-offset (get-header-data code)))
765 (values :foreign-function
768 (find-escaped-frame caller))
769 (if (and (code-component-p code)
770 (eq (%code-debug-info code) :bogus-lra))
771 (let ((real-lra (code-header-ref code real-lra-slot)))
772 (compute-calling-frame caller real-lra up-frame))
773 (let ((d-fun (case code
775 (make-bogus-debug-fun
776 "undefined function"))
778 (make-bogus-debug-fun
779 (foreign-function-backtrace-name
780 (int-sap (get-lisp-obj-address lra)))))
782 (make-bogus-debug-fun
783 "bogus stack frame"))
785 (debug-fun-from-pc code pc-offset)))))
786 (/noshow0 "returning MAKE-COMPILED-FRAME from COMPUTE-CALLING-FRAME")
787 (make-compiled-frame caller up-frame d-fun
788 (code-location-from-pc d-fun pc-offset
790 (if up-frame (1+ (frame-number up-frame)) 0)
794 (defun compute-calling-frame (caller ra up-frame &optional savedp)
795 (declare (type system-area-pointer caller ra))
796 (/noshow0 "entering COMPUTE-CALLING-FRAME")
797 (when (control-stack-pointer-valid-p caller)
799 ;; First check for an escaped frame.
800 (multiple-value-bind (code pc-offset escaped off-stack)
801 (find-escaped-frame caller)
804 ;; If it's escaped it may be a function end breakpoint trap.
805 (when (and (code-component-p code)
806 (eq (%code-debug-info code) :bogus-lra))
807 ;; If :bogus-lra grab the real lra.
808 (setq pc-offset (code-header-ref
809 code (1+ real-lra-slot)))
810 (setq code (code-header-ref code real-lra-slot))
813 (multiple-value-setq (pc-offset code)
814 (compute-lra-data-from-pc ra))
816 (setf code :foreign-function
818 (let ((d-fun (case code
820 (make-bogus-debug-fun
821 "undefined function"))
823 (make-bogus-debug-fun
824 (foreign-function-backtrace-name ra)))
826 (make-bogus-debug-fun
827 "bogus stack frame"))
829 (debug-fun-from-pc code pc-offset)))))
830 (/noshow0 "returning MAKE-COMPILED-FRAME from COMPUTE-CALLING-FRAME")
831 (make-compiled-frame caller up-frame d-fun
832 (code-location-from-pc d-fun pc-offset
834 (if up-frame (1+ (frame-number up-frame)) 0)
835 ;; If we have an interrupt-context that's not on
836 ;; our stack at all, and we're computing the
837 ;; from from a saved FP, we're probably looking
838 ;; at an interrupted syscall.
839 (or escaped (and savedp off-stack)))))))
841 (defun nth-interrupt-context (n)
842 (declare (type (unsigned-byte 32) n)
843 (optimize (speed 3) (safety 0)))
844 (sb!alien:sap-alien (sb!vm::current-thread-offset-sap
845 (+ sb!vm::thread-interrupt-contexts-offset
851 (defun find-escaped-frame (frame-pointer)
852 (declare (type system-area-pointer frame-pointer))
853 (/noshow0 "entering FIND-ESCAPED-FRAME")
854 (dotimes (index *free-interrupt-context-index* (values nil 0 nil))
855 (let* ((context (nth-interrupt-context index))
856 (cfp (int-sap (sb!vm:context-register context sb!vm::cfp-offset))))
857 (/noshow0 "got CONTEXT")
858 (unless (control-stack-pointer-valid-p cfp)
859 (return (values nil nil nil t)))
860 (when (sap= frame-pointer cfp)
862 (/noshow0 "in WITHOUT-GCING")
863 (let* ((component-ptr (component-ptr-from-pc
864 (sb!vm:context-pc context)))
865 (code (unless (sap= component-ptr (int-sap #x0))
866 (component-from-component-ptr component-ptr))))
867 (/noshow0 "got CODE")
869 ;; KLUDGE: Detect undefined functions by a range-check
870 ;; against the trampoline address and the following
871 ;; function in the runtime.
872 (if (< (foreign-symbol-address "undefined_tramp")
873 (sap-int (sb!vm:context-pc context))
874 (foreign-symbol-address #!+x86 "closure_tramp"
875 #!+x86-64 "alloc_tramp"))
876 (return (values :undefined-function 0 context))
877 (return (values code 0 context))))
878 (let* ((code-header-len (* (get-header-data code)
881 (- (sap-int (sb!vm:context-pc context))
882 (- (get-lisp-obj-address code)
883 sb!vm:other-pointer-lowtag)
885 (/noshow "got PC-OFFSET")
886 (unless (<= 0 pc-offset
887 (* (code-header-ref code sb!vm:code-code-size-slot)
889 ;; We were in an assembly routine. Therefore, use the
892 ;; FIXME: Should this be WARN or ERROR or what?
893 (format t "** pc-offset ~S not in code obj ~S?~%"
895 (/noshow0 "returning from FIND-ESCAPED-FRAME")
897 (values code pc-offset context)))))))))
900 (defun find-escaped-frame (frame-pointer)
901 (declare (type system-area-pointer frame-pointer))
902 (/noshow0 "entering FIND-ESCAPED-FRAME")
903 (dotimes (index *free-interrupt-context-index* (values nil 0 nil))
904 (let ((scp (nth-interrupt-context index)))
906 (when (= (sap-int frame-pointer)
907 (sb!vm:context-register scp sb!vm::cfp-offset))
909 (/noshow0 "in WITHOUT-GCING")
910 (let ((code (code-object-from-bits
911 (sb!vm:context-register scp sb!vm::code-offset))))
912 (/noshow0 "got CODE")
914 (return (values code 0 scp)))
915 (let* ((code-header-len (* (get-header-data code)
918 (- (sap-int (sb!vm:context-pc scp))
919 (- (get-lisp-obj-address code)
920 sb!vm:other-pointer-lowtag)
922 (let ((code-size (* (code-header-ref code
923 sb!vm:code-code-size-slot)
924 sb!vm:n-word-bytes)))
925 (unless (<= 0 pc-offset code-size)
926 ;; We were in an assembly routine.
927 (multiple-value-bind (new-pc-offset computed-return)
928 (find-pc-from-assembly-fun code scp)
929 (setf pc-offset new-pc-offset)
930 (unless (<= 0 pc-offset code-size)
932 "Set PC-OFFSET to zero and continue backtrace."
935 "~@<PC-OFFSET (~D) not in code object. Frame details:~
936 ~2I~:@_PC: #X~X~:@_CODE: ~S~:@_CODE FUN: ~S~:@_LRA: ~
937 #X~X~:@_COMPUTED RETURN: #X~X.~:>"
940 (sap-int (sb!vm:context-pc scp))
942 (%code-entry-points code)
943 (sb!vm:context-register scp sb!vm::lra-offset)
945 ;; We failed to pinpoint where PC is, but set
946 ;; pc-offset to 0 to keep the backtrace from
948 (setf pc-offset 0)))))
949 (/noshow0 "returning from FIND-ESCAPED-FRAME")
951 (if (eq (%code-debug-info code) :bogus-lra)
952 (let ((real-lra (code-header-ref code
954 (values (lra-code-header real-lra)
955 (get-header-data real-lra)
957 (values code pc-offset scp))))))))))
960 (defun find-pc-from-assembly-fun (code scp)
961 "Finds the PC for the return from an assembly routine properly.
962 For some architectures (such as PPC) this will not be the $LRA
964 (let ((return-machine-address (sb!vm::return-machine-address scp))
965 (code-header-len (* (get-header-data code) sb!vm:n-word-bytes)))
966 (values (- return-machine-address
967 (- (get-lisp-obj-address code)
968 sb!vm:other-pointer-lowtag)
970 return-machine-address)))
972 ;;; Find the code object corresponding to the object represented by
973 ;;; bits and return it. We assume bogus functions correspond to the
974 ;;; undefined-function.
976 (defun code-object-from-bits (bits)
977 (declare (type (unsigned-byte 32) bits))
978 (let ((object (make-lisp-obj bits nil)))
979 (if (functionp object)
980 (or (fun-code-header object)
982 (let ((lowtag (lowtag-of object)))
983 (when (= lowtag sb!vm:other-pointer-lowtag)
984 (let ((widetag (widetag-of object)))
985 (cond ((= widetag sb!vm:code-header-widetag)
987 ((= widetag sb!vm:return-pc-header-widetag)
988 (lra-code-header object))
994 ;;; This returns a COMPILED-DEBUG-FUN for COMPONENT and PC. We fetch the
995 ;;; SB!C::DEBUG-INFO and run down its FUN-MAP to get a
996 ;;; SB!C::COMPILED-DEBUG-FUN from the PC. The result only needs to
997 ;;; reference the COMPONENT, for function constants, and the
998 ;;; SB!C::COMPILED-DEBUG-FUN.
999 (defun debug-fun-from-pc (component pc)
1000 (let ((info (%code-debug-info component)))
1003 ;; FIXME: It seems that most of these (at least on x86) are
1004 ;; actually assembler routines, and could be named by looking
1005 ;; at the sb-fasl:*assembler-routines*.
1006 (make-bogus-debug-fun "no debug information for frame"))
1007 ((eq info :bogus-lra)
1008 (make-bogus-debug-fun "function end breakpoint"))
1010 (let* ((fun-map (sb!c::compiled-debug-info-fun-map info))
1011 (len (length fun-map)))
1012 (declare (type simple-vector fun-map))
1014 (make-compiled-debug-fun (svref fun-map 0) component)
1017 (>= pc (sb!c::compiled-debug-fun-elsewhere-pc
1018 (svref fun-map 0)))))
1019 (declare (type sb!int:index i))
1022 (< pc (if elsewhere-p
1023 (sb!c::compiled-debug-fun-elsewhere-pc
1024 (svref fun-map (1+ i)))
1025 (svref fun-map i))))
1026 (return (make-compiled-debug-fun
1027 (svref fun-map (1- i))
1031 ;;; This returns a code-location for the COMPILED-DEBUG-FUN,
1032 ;;; DEBUG-FUN, and the pc into its code vector. If we stopped at a
1033 ;;; breakpoint, find the CODE-LOCATION for that breakpoint. Otherwise,
1034 ;;; make an :UNSURE code location, so it can be filled in when we
1035 ;;; figure out what is going on.
1036 (defun code-location-from-pc (debug-fun pc escaped)
1037 (or (and (compiled-debug-fun-p debug-fun)
1039 (let ((data (breakpoint-data
1040 (compiled-debug-fun-component debug-fun)
1042 (when (and data (breakpoint-data-breakpoints data))
1043 (let ((what (breakpoint-what
1044 (first (breakpoint-data-breakpoints data)))))
1045 (when (compiled-code-location-p what)
1047 (make-compiled-code-location pc debug-fun)))
1049 ;;; Return an alist mapping catch tags to CODE-LOCATIONs. These are
1050 ;;; CODE-LOCATIONs at which execution would continue with frame as the
1051 ;;; top frame if someone threw to the corresponding tag.
1052 (defun frame-catches (frame)
1053 (let ((catch (descriptor-sap sb!vm:*current-catch-block*))
1054 (reversed-result nil)
1055 (fp (frame-pointer frame)))
1056 (loop until (zerop (sap-int catch))
1057 finally (return (nreverse reversed-result))
1062 (* sb!vm:catch-block-current-cont-slot
1063 sb!vm:n-word-bytes))
1067 (* sb!vm:catch-block-current-cont-slot
1068 sb!vm:n-word-bytes))))
1069 (let* (#!-(or x86 x86-64)
1070 (lra (stack-ref catch sb!vm:catch-block-entry-pc-slot))
1073 catch (* sb!vm:catch-block-entry-pc-slot
1074 sb!vm:n-word-bytes)))
1077 (stack-ref catch sb!vm:catch-block-current-code-slot))
1079 (component (component-from-component-ptr
1080 (component-ptr-from-pc ra)))
1083 (* (- (1+ (get-header-data lra))
1084 (get-header-data component))
1088 (- (get-lisp-obj-address component)
1089 sb!vm:other-pointer-lowtag)
1090 (* (get-header-data component) sb!vm:n-word-bytes))))
1091 (push (cons #!-(or x86 x86-64)
1092 (stack-ref catch sb!vm:catch-block-tag-slot)
1095 (sap-ref-word catch (* sb!vm:catch-block-tag-slot
1096 sb!vm:n-word-bytes)))
1097 (make-compiled-code-location
1098 offset (frame-debug-fun frame)))
1103 (* sb!vm:catch-block-previous-catch-slot
1104 sb!vm:n-word-bytes))
1108 (* sb!vm:catch-block-previous-catch-slot
1109 sb!vm:n-word-bytes)))))))
1111 ;;; Modify the value of the OLD-TAG catches in FRAME to NEW-TAG
1112 (defun replace-frame-catch-tag (frame old-tag new-tag)
1113 (let ((catch (descriptor-sap sb!vm:*current-catch-block*))
1114 (fp (frame-pointer frame)))
1115 (loop until (zerop (sap-int catch))
1119 (* sb!vm:catch-block-current-cont-slot
1120 sb!vm:n-word-bytes))
1124 (* sb!vm:catch-block-current-cont-slot
1125 sb!vm:n-word-bytes))))
1128 (stack-ref catch sb!vm:catch-block-tag-slot)
1131 (sap-ref-word catch (* sb!vm:catch-block-tag-slot
1132 sb!vm:n-word-bytes)))))
1133 (when (eq current-tag old-tag)
1135 (setf (stack-ref catch sb!vm:catch-block-tag-slot) new-tag)
1137 (setf (sap-ref-word catch (* sb!vm:catch-block-tag-slot
1138 sb!vm:n-word-bytes))
1139 (get-lisp-obj-address new-tag)))))
1143 (* sb!vm:catch-block-previous-catch-slot
1144 sb!vm:n-word-bytes))
1148 (* sb!vm:catch-block-previous-catch-slot
1149 sb!vm:n-word-bytes)))))))
1153 ;;;; operations on DEBUG-FUNs
1155 ;;; Execute the forms in a context with BLOCK-VAR bound to each
1156 ;;; DEBUG-BLOCK in DEBUG-FUN successively. Result is an optional
1157 ;;; form to execute for return values, and DO-DEBUG-FUN-BLOCKS
1158 ;;; returns nil if there is no result form. This signals a
1159 ;;; NO-DEBUG-BLOCKS condition when the DEBUG-FUN lacks
1160 ;;; DEBUG-BLOCK information.
1161 (defmacro do-debug-fun-blocks ((block-var debug-fun &optional result)
1163 (let ((blocks (gensym))
1165 `(let ((,blocks (debug-fun-debug-blocks ,debug-fun)))
1166 (declare (simple-vector ,blocks))
1167 (dotimes (,i (length ,blocks) ,result)
1168 (let ((,block-var (svref ,blocks ,i)))
1171 ;;; Execute body in a context with VAR bound to each DEBUG-VAR in
1172 ;;; DEBUG-FUN. This returns the value of executing result (defaults to
1173 ;;; nil). This may iterate over only some of DEBUG-FUN's variables or
1174 ;;; none depending on debug policy; for example, possibly the
1175 ;;; compilation only preserved argument information.
1176 (defmacro do-debug-fun-vars ((var debug-fun &optional result) &body body)
1177 (let ((vars (gensym))
1179 `(let ((,vars (debug-fun-debug-vars ,debug-fun)))
1180 (declare (type (or null simple-vector) ,vars))
1182 (dotimes (,i (length ,vars) ,result)
1183 (let ((,var (svref ,vars ,i)))
1187 ;;; Return the object of type FUNCTION associated with the DEBUG-FUN,
1188 ;;; or NIL if the function is unavailable or is non-existent as a user
1189 ;;; callable function object.
1190 (defun debug-fun-fun (debug-fun)
1191 (let ((cached-value (debug-fun-%function debug-fun)))
1192 (if (eq cached-value :unparsed)
1193 (setf (debug-fun-%function debug-fun)
1194 (etypecase debug-fun
1197 (compiled-debug-fun-component debug-fun))
1199 (sb!c::compiled-debug-fun-start-pc
1200 (compiled-debug-fun-compiler-debug-fun debug-fun))))
1201 (do ((entry (%code-entry-points component)
1202 (%simple-fun-next entry)))
1205 (sb!c::compiled-debug-fun-start-pc
1206 (compiled-debug-fun-compiler-debug-fun
1207 (fun-debug-fun entry))))
1209 (bogus-debug-fun nil)))
1212 ;;; Return the name of the function represented by DEBUG-FUN. This may
1213 ;;; be a string or a cons; do not assume it is a symbol.
1214 (defun debug-fun-name (debug-fun)
1215 (declare (type debug-fun debug-fun))
1216 (etypecase debug-fun
1218 (sb!c::compiled-debug-fun-name
1219 (compiled-debug-fun-compiler-debug-fun debug-fun)))
1221 (bogus-debug-fun-%name debug-fun))))
1223 ;;; Return a DEBUG-FUN that represents debug information for FUN.
1224 (defun fun-debug-fun (fun)
1225 (declare (type function fun))
1226 (let ((simple-fun (%fun-fun fun)))
1227 (let* ((name (%simple-fun-name simple-fun))
1228 (component (fun-code-header simple-fun))
1231 (and (sb!c::compiled-debug-fun-p x)
1232 (eq (sb!c::compiled-debug-fun-name x) name)
1233 (eq (sb!c::compiled-debug-fun-kind x) nil)))
1234 (sb!c::compiled-debug-info-fun-map
1235 (%code-debug-info component)))))
1237 (make-compiled-debug-fun res component)
1238 ;; KLUDGE: comment from CMU CL:
1239 ;; This used to be the non-interpreted branch, but
1240 ;; William wrote it to return the debug-fun of fun's XEP
1241 ;; instead of fun's debug-fun. The above code does this
1242 ;; more correctly, but it doesn't get or eliminate all
1243 ;; appropriate cases. It mostly works, and probably
1244 ;; works for all named functions anyway.
1246 (debug-fun-from-pc component
1247 (* (- (fun-word-offset simple-fun)
1248 (get-header-data component))
1249 sb!vm:n-word-bytes))))))
1251 ;;; Return the kind of the function, which is one of :OPTIONAL,
1252 ;;; :EXTERNAL, :TOPLEVEL, :CLEANUP, or NIL.
1253 (defun debug-fun-kind (debug-fun)
1254 ;; FIXME: This "is one of" information should become part of the function
1255 ;; declamation, not just a doc string
1256 (etypecase debug-fun
1258 (sb!c::compiled-debug-fun-kind
1259 (compiled-debug-fun-compiler-debug-fun debug-fun)))
1263 ;;; Is there any variable information for DEBUG-FUN?
1264 (defun debug-var-info-available (debug-fun)
1265 (not (not (debug-fun-debug-vars debug-fun))))
1267 ;;; Return a list of DEBUG-VARs in DEBUG-FUN having the same name
1268 ;;; and package as SYMBOL. If SYMBOL is uninterned, then this returns
1269 ;;; a list of DEBUG-VARs without package names and with the same name
1270 ;;; as symbol. The result of this function is limited to the
1271 ;;; availability of variable information in DEBUG-FUN; for
1272 ;;; example, possibly DEBUG-FUN only knows about its arguments.
1273 (defun debug-fun-symbol-vars (debug-fun symbol)
1274 (let ((vars (ambiguous-debug-vars debug-fun (symbol-name symbol)))
1275 (package (and (symbol-package symbol)
1276 (package-name (symbol-package symbol)))))
1277 (delete-if (if (stringp package)
1279 (let ((p (debug-var-package-name var)))
1280 (or (not (stringp p))
1281 (string/= p package))))
1283 (stringp (debug-var-package-name var))))
1286 ;;; Return a list of DEBUG-VARs in DEBUG-FUN whose names contain
1287 ;;; NAME-PREFIX-STRING as an initial substring. The result of this
1288 ;;; function is limited to the availability of variable information in
1289 ;;; debug-fun; for example, possibly debug-fun only knows
1290 ;;; about its arguments.
1291 (defun ambiguous-debug-vars (debug-fun name-prefix-string)
1292 (declare (simple-string name-prefix-string))
1293 (let ((variables (debug-fun-debug-vars debug-fun)))
1294 (declare (type (or null simple-vector) variables))
1296 (let* ((len (length variables))
1297 (prefix-len (length name-prefix-string))
1298 (pos (find-var name-prefix-string variables len))
1301 ;; Find names from pos to variable's len that contain prefix.
1302 (do ((i pos (1+ i)))
1304 (let* ((var (svref variables i))
1305 (name (debug-var-symbol-name var))
1306 (name-len (length name)))
1307 (declare (simple-string name))
1308 (when (/= (or (string/= name-prefix-string name
1309 :end1 prefix-len :end2 name-len)
1314 (setq res (nreverse res)))
1317 ;;; This returns a position in VARIABLES for one containing NAME as an
1318 ;;; initial substring. END is the length of VARIABLES if supplied.
1319 (defun find-var (name variables &optional end)
1320 (declare (simple-vector variables)
1321 (simple-string name))
1322 (let ((name-len (length name)))
1323 (position name variables
1325 (let* ((y (debug-var-symbol-name y))
1327 (declare (simple-string y))
1328 (and (>= y-len name-len)
1329 (string= x y :end1 name-len :end2 name-len))))
1330 :end (or end (length variables)))))
1332 ;;; Return a list representing the lambda-list for DEBUG-FUN. The
1333 ;;; list has the following structure:
1334 ;;; (required-var1 required-var2
1336 ;;; (:optional var3 suppliedp-var4)
1337 ;;; (:optional var5)
1339 ;;; (:rest var6) (:rest var7)
1341 ;;; (:keyword keyword-symbol var8 suppliedp-var9)
1342 ;;; (:keyword keyword-symbol var10)
1345 ;;; Each VARi is a DEBUG-VAR; however it may be the symbol :DELETED if
1346 ;;; it is unreferenced in DEBUG-FUN. This signals a
1347 ;;; LAMBDA-LIST-UNAVAILABLE condition when there is no argument list
1349 (defun debug-fun-lambda-list (debug-fun)
1350 (etypecase debug-fun
1351 (compiled-debug-fun (compiled-debug-fun-lambda-list debug-fun))
1352 (bogus-debug-fun nil)))
1354 ;;; Note: If this has to compute the lambda list, it caches it in DEBUG-FUN.
1355 (defun compiled-debug-fun-lambda-list (debug-fun)
1356 (let ((lambda-list (debug-fun-%lambda-list debug-fun)))
1357 (cond ((eq lambda-list :unparsed)
1358 (multiple-value-bind (args argsp)
1359 (parse-compiled-debug-fun-lambda-list debug-fun)
1360 (setf (debug-fun-%lambda-list debug-fun) args)
1363 (debug-signal 'lambda-list-unavailable
1364 :debug-fun debug-fun))))
1366 ((bogus-debug-fun-p debug-fun)
1368 ((sb!c::compiled-debug-fun-arguments
1369 (compiled-debug-fun-compiler-debug-fun debug-fun))
1370 ;; If the packed information is there (whether empty or not) as
1371 ;; opposed to being nil, then returned our cached value (nil).
1374 ;; Our cached value is nil, and the packed lambda-list information
1375 ;; is nil, so we don't have anything available.
1376 (debug-signal 'lambda-list-unavailable
1377 :debug-fun debug-fun)))))
1379 ;;; COMPILED-DEBUG-FUN-LAMBDA-LIST calls this when a
1380 ;;; COMPILED-DEBUG-FUN has no lambda list information cached. It
1381 ;;; returns the lambda list as the first value and whether there was
1382 ;;; any argument information as the second value. Therefore,
1383 ;;; (VALUES NIL T) means there were no arguments, but (VALUES NIL NIL)
1384 ;;; means there was no argument information.
1385 (defun parse-compiled-debug-fun-lambda-list (debug-fun)
1386 (let ((args (sb!c::compiled-debug-fun-arguments
1387 (compiled-debug-fun-compiler-debug-fun debug-fun))))
1392 (values (coerce (debug-fun-debug-vars debug-fun) 'list)
1395 (let ((vars (debug-fun-debug-vars debug-fun))
1400 (declare (type (or null simple-vector) vars))
1402 (when (>= i len) (return))
1403 (let ((ele (aref args i)))
1408 ;; Deleted required arg at beginning of args array.
1409 (push :deleted res))
1410 (sb!c::optional-args
1413 ;; SUPPLIED-P var immediately following keyword or
1414 ;; optional. Stick the extra var in the result
1415 ;; element representing the keyword or optional,
1416 ;; which is the previous one.
1418 ;; FIXME: NCONC used for side-effect: the effect is defined,
1419 ;; but this is bad style no matter what.
1421 (list (compiled-debug-fun-lambda-list-var
1422 args (incf i) vars))))
1425 (compiled-debug-fun-lambda-list-var
1426 args (incf i) vars))
1429 ;; The next two args are the &MORE arg context and count.
1431 (compiled-debug-fun-lambda-list-var
1433 (compiled-debug-fun-lambda-list-var
1434 args (incf i) vars))
1438 (push (list :keyword
1440 (compiled-debug-fun-lambda-list-var
1441 args (incf i) vars))
1444 ;; We saw an optional marker, so the following
1445 ;; non-symbols are indexes indicating optional
1447 (push (list :optional (svref vars ele)) res))
1449 ;; Required arg at beginning of args array.
1450 (push (svref vars ele) res))))
1452 (values (nreverse res) t))))))
1454 ;;; This is used in COMPILED-DEBUG-FUN-LAMBDA-LIST.
1455 (defun compiled-debug-fun-lambda-list-var (args i vars)
1456 (declare (type (simple-array * (*)) args)
1457 (simple-vector vars))
1458 (let ((ele (aref args i)))
1459 (cond ((not (symbolp ele)) (svref vars ele))
1460 ((eq ele 'sb!c::deleted) :deleted)
1461 (t (error "malformed arguments description")))))
1463 (defun compiled-debug-fun-debug-info (debug-fun)
1464 (%code-debug-info (compiled-debug-fun-component debug-fun)))
1466 ;;;; unpacking variable and basic block data
1468 (defvar *parsing-buffer*
1469 (make-array 20 :adjustable t :fill-pointer t))
1470 (defvar *other-parsing-buffer*
1471 (make-array 20 :adjustable t :fill-pointer t))
1472 ;;; PARSE-DEBUG-BLOCKS and PARSE-DEBUG-VARS
1473 ;;; use this to unpack binary encoded information. It returns the
1474 ;;; values returned by the last form in body.
1476 ;;; This binds buffer-var to *parsing-buffer*, makes sure it starts at
1477 ;;; element zero, and makes sure if we unwind, we nil out any set
1478 ;;; elements for GC purposes.
1480 ;;; This also binds other-var to *other-parsing-buffer* when it is
1481 ;;; supplied, making sure it starts at element zero and that we nil
1482 ;;; out any elements if we unwind.
1484 ;;; This defines the local macro RESULT that takes a buffer, copies
1485 ;;; its elements to a resulting simple-vector, nil's out elements, and
1486 ;;; restarts the buffer at element zero. RESULT returns the
1488 (eval-when (:compile-toplevel :execute)
1489 (sb!xc:defmacro with-parsing-buffer ((buffer-var &optional other-var)
1491 (let ((len (gensym))
1494 (let ((,buffer-var *parsing-buffer*)
1495 ,@(if other-var `((,other-var *other-parsing-buffer*))))
1496 (setf (fill-pointer ,buffer-var) 0)
1497 ,@(if other-var `((setf (fill-pointer ,other-var) 0)))
1498 (macrolet ((result (buf)
1499 `(let* ((,',len (length ,buf))
1500 (,',res (make-array ,',len)))
1501 (replace ,',res ,buf :end1 ,',len :end2 ,',len)
1502 (fill ,buf nil :end ,',len)
1503 (setf (fill-pointer ,buf) 0)
1506 (fill *parsing-buffer* nil)
1507 ,@(if other-var `((fill *other-parsing-buffer* nil))))))
1510 ;;; The argument is a debug internals structure. This returns the
1511 ;;; DEBUG-BLOCKs for DEBUG-FUN, regardless of whether we have unpacked
1512 ;;; them yet. It signals a NO-DEBUG-BLOCKS condition if it can't
1513 ;;; return the blocks.
1514 (defun debug-fun-debug-blocks (debug-fun)
1515 (let ((blocks (debug-fun-blocks debug-fun)))
1516 (cond ((eq blocks :unparsed)
1517 (setf (debug-fun-blocks debug-fun)
1518 (parse-debug-blocks debug-fun))
1519 (unless (debug-fun-blocks debug-fun)
1520 (debug-signal 'no-debug-blocks
1521 :debug-fun debug-fun))
1522 (debug-fun-blocks debug-fun))
1525 (debug-signal 'no-debug-blocks
1526 :debug-fun debug-fun)))))
1528 ;;; Return a SIMPLE-VECTOR of DEBUG-BLOCKs or NIL. NIL indicates there
1529 ;;; was no basic block information.
1530 (defun parse-debug-blocks (debug-fun)
1531 (etypecase debug-fun
1533 (parse-compiled-debug-blocks debug-fun))
1535 (debug-signal 'no-debug-blocks :debug-fun debug-fun))))
1537 ;;; This does some of the work of PARSE-DEBUG-BLOCKS.
1538 (defun parse-compiled-debug-blocks (debug-fun)
1539 (let* ((var-count (length (debug-fun-debug-vars debug-fun)))
1540 (compiler-debug-fun (compiled-debug-fun-compiler-debug-fun
1542 (blocks (sb!c::compiled-debug-fun-blocks compiler-debug-fun))
1543 ;; KLUDGE: 8 is a hard-wired constant in the compiler for the
1544 ;; element size of the packed binary representation of the
1546 (live-set-len (ceiling var-count 8))
1547 (tlf-number (sb!c::compiled-debug-fun-tlf-number compiler-debug-fun)))
1549 (return-from parse-compiled-debug-blocks nil))
1550 (macrolet ((aref+ (a i) `(prog1 (aref ,a ,i) (incf ,i))))
1551 (with-parsing-buffer (blocks-buffer locations-buffer)
1553 (len (length blocks))
1556 (when (>= i len) (return))
1557 (let ((succ-and-flags (aref+ blocks i))
1559 (declare (type (unsigned-byte 8) succ-and-flags)
1561 (dotimes (k (ldb sb!c::compiled-debug-block-nsucc-byte
1563 (push (sb!c:read-var-integer blocks i) successors))
1565 (dotimes (k (sb!c:read-var-integer blocks i)
1566 (result locations-buffer))
1567 (let ((kind (svref sb!c::*compiled-code-location-kinds*
1570 (sb!c:read-var-integer blocks i)))
1571 (tlf-offset (or tlf-number
1572 (sb!c:read-var-integer blocks i)))
1573 (form-number (sb!c:read-var-integer blocks i))
1574 (live-set (sb!c:read-packed-bit-vector
1575 live-set-len blocks i))
1576 (step-info (sb!c:read-var-string blocks i)))
1577 (vector-push-extend (make-known-code-location
1578 pc debug-fun tlf-offset
1579 form-number live-set kind
1582 (setf last-pc pc))))
1583 (block (make-compiled-debug-block
1584 locations successors
1586 sb!c::compiled-debug-block-elsewhere-p
1587 succ-and-flags))))))
1588 (vector-push-extend block blocks-buffer)
1589 (dotimes (k (length locations))
1590 (setf (code-location-%debug-block (svref locations k))
1592 (let ((res (result blocks-buffer)))
1593 (declare (simple-vector res))
1594 (dotimes (i (length res))
1595 (let* ((block (svref res i))
1597 (dolist (ele (debug-block-successors block))
1598 (push (svref res ele) succs))
1599 (setf (debug-block-successors block) succs)))
1602 ;;; The argument is a debug internals structure. This returns NIL if
1603 ;;; there is no variable information. It returns an empty
1604 ;;; simple-vector if there were no locals in the function. Otherwise
1605 ;;; it returns a SIMPLE-VECTOR of DEBUG-VARs.
1606 (defun debug-fun-debug-vars (debug-fun)
1607 (let ((vars (debug-fun-%debug-vars debug-fun)))
1608 (if (eq vars :unparsed)
1609 (setf (debug-fun-%debug-vars debug-fun)
1610 (etypecase debug-fun
1612 (parse-compiled-debug-vars debug-fun))
1613 (bogus-debug-fun nil)))
1616 ;;; VARS is the parsed variables for a minimal debug function. We need
1617 ;;; to assign names of the form ARG-NNN. We must pad with leading
1618 ;;; zeros, since the arguments must be in alphabetical order.
1619 (defun assign-minimal-var-names (vars)
1620 (declare (simple-vector vars))
1621 (let* ((len (length vars))
1622 (width (length (format nil "~W" (1- len)))))
1624 (without-package-locks
1625 (setf (compiled-debug-var-symbol (svref vars i))
1626 (intern (format nil "ARG-~V,'0D" width i)
1627 ;; The cross-compiler won't dump literal package
1628 ;; references because the target package objects
1629 ;; aren't created until partway through
1630 ;; cold-init. In lieu of adding smarts to the
1631 ;; build framework to handle this, we use an
1632 ;; explicit load-time-value form.
1633 (load-time-value (find-package "SB!DEBUG"))))))))
1635 ;;; Parse the packed representation of DEBUG-VARs from
1636 ;;; DEBUG-FUN's SB!C::COMPILED-DEBUG-FUN, returning a vector
1637 ;;; of DEBUG-VARs, or NIL if there was no information to parse.
1638 (defun parse-compiled-debug-vars (debug-fun)
1639 (let* ((cdebug-fun (compiled-debug-fun-compiler-debug-fun
1641 (packed-vars (sb!c::compiled-debug-fun-vars cdebug-fun))
1642 (args-minimal (eq (sb!c::compiled-debug-fun-arguments cdebug-fun)
1646 (buffer (make-array 0 :fill-pointer 0 :adjustable t)))
1647 ((>= i (length packed-vars))
1648 (let ((result (coerce buffer 'simple-vector)))
1650 (assign-minimal-var-names result))
1652 (flet ((geti () (prog1 (aref packed-vars i) (incf i))))
1653 (let* ((flags (geti))
1654 (minimal (logtest sb!c::compiled-debug-var-minimal-p flags))
1655 (deleted (logtest sb!c::compiled-debug-var-deleted-p flags))
1656 (more-context-p (logtest sb!c::compiled-debug-var-more-context-p flags))
1657 (more-count-p (logtest sb!c::compiled-debug-var-more-count-p flags))
1658 (live (logtest sb!c::compiled-debug-var-environment-live
1660 (save (logtest sb!c::compiled-debug-var-save-loc-p flags))
1661 (symbol (if minimal nil (geti)))
1662 (id (if (logtest sb!c::compiled-debug-var-id-p flags)
1665 (sc-offset (if deleted 0 (geti)))
1666 (save-sc-offset (if save (geti) nil)))
1667 (aver (not (and args-minimal (not minimal))))
1668 (vector-push-extend (make-compiled-debug-var symbol
1673 (cond (more-context-p :more-context)
1674 (more-count-p :more-count)))
1679 ;;; If we're sure of whether code-location is known, return T or NIL.
1680 ;;; If we're :UNSURE, then try to fill in the code-location's slots.
1681 ;;; This determines whether there is any debug-block information, and
1682 ;;; if code-location is known.
1684 ;;; ??? IF this conses closures every time it's called, then break off the
1685 ;;; :UNSURE part to get the HANDLER-CASE into another function.
1686 (defun code-location-unknown-p (basic-code-location)
1687 (ecase (code-location-%unknown-p basic-code-location)
1691 (setf (code-location-%unknown-p basic-code-location)
1692 (handler-case (not (fill-in-code-location basic-code-location))
1693 (no-debug-blocks () t))))))
1695 ;;; Return the DEBUG-BLOCK containing code-location if it is available.
1696 ;;; Some debug policies inhibit debug-block information, and if none
1697 ;;; is available, then this signals a NO-DEBUG-BLOCKS condition.
1698 (defun code-location-debug-block (basic-code-location)
1699 (let ((block (code-location-%debug-block basic-code-location)))
1700 (if (eq block :unparsed)
1701 (etypecase basic-code-location
1702 (compiled-code-location
1703 (compute-compiled-code-location-debug-block basic-code-location))
1704 ;; (There used to be more cases back before sbcl-0.7.0, when
1705 ;; we did special tricks to debug the IR1 interpreter.)
1709 ;;; Store and return BASIC-CODE-LOCATION's debug-block. We determines
1710 ;;; the correct one using the code-location's pc. We use
1711 ;;; DEBUG-FUN-DEBUG-BLOCKS to return the cached block information
1712 ;;; or signal a NO-DEBUG-BLOCKS condition. The blocks are sorted by
1713 ;;; their first code-location's pc, in ascending order. Therefore, as
1714 ;;; soon as we find a block that starts with a pc greater than
1715 ;;; basic-code-location's pc, we know the previous block contains the
1716 ;;; pc. If we get to the last block, then the code-location is either
1717 ;;; in the second to last block or the last block, and we have to be
1718 ;;; careful in determining this since the last block could be code at
1719 ;;; the end of the function. We have to check for the last block being
1720 ;;; code first in order to see how to compare the code-location's pc.
1721 (defun compute-compiled-code-location-debug-block (basic-code-location)
1722 (let* ((pc (compiled-code-location-pc basic-code-location))
1723 (debug-fun (code-location-debug-fun
1724 basic-code-location))
1725 (blocks (debug-fun-debug-blocks debug-fun))
1726 (len (length blocks)))
1727 (declare (simple-vector blocks))
1728 (setf (code-location-%debug-block basic-code-location)
1734 (let ((last (svref blocks end)))
1736 ((debug-block-elsewhere-p last)
1738 (sb!c::compiled-debug-fun-elsewhere-pc
1739 (compiled-debug-fun-compiler-debug-fun
1741 (svref blocks (1- end))
1744 (compiled-code-location-pc
1745 (svref (compiled-debug-block-code-locations last)
1747 (svref blocks (1- end)))
1749 (declare (type index i end))
1751 (compiled-code-location-pc
1752 (svref (compiled-debug-block-code-locations
1755 (return (svref blocks (1- i)))))))))
1757 ;;; Return the CODE-LOCATION's DEBUG-SOURCE.
1758 (defun code-location-debug-source (code-location)
1759 (let ((info (compiled-debug-fun-debug-info
1760 (code-location-debug-fun code-location))))
1761 (or (sb!c::debug-info-source info)
1762 (debug-signal 'no-debug-blocks :debug-fun
1763 (code-location-debug-fun code-location)))))
1765 ;;; Returns the number of top level forms before the one containing
1766 ;;; CODE-LOCATION as seen by the compiler in some compilation unit. (A
1767 ;;; compilation unit is not necessarily a single file, see the section
1768 ;;; on debug-sources.)
1769 (defun code-location-toplevel-form-offset (code-location)
1770 (when (code-location-unknown-p code-location)
1771 (error 'unknown-code-location :code-location code-location))
1772 (let ((tlf-offset (code-location-%tlf-offset code-location)))
1773 (cond ((eq tlf-offset :unparsed)
1774 (etypecase code-location
1775 (compiled-code-location
1776 (unless (fill-in-code-location code-location)
1777 ;; This check should be unnecessary. We're missing
1778 ;; debug info the compiler should have dumped.
1779 (bug "unknown code location"))
1780 (code-location-%tlf-offset code-location))
1781 ;; (There used to be more cases back before sbcl-0.7.0,,
1782 ;; when we did special tricks to debug the IR1
1787 ;;; Return the number of the form corresponding to CODE-LOCATION. The
1788 ;;; form number is derived by a walking the subforms of a top level
1789 ;;; form in depth-first order.
1790 (defun code-location-form-number (code-location)
1791 (when (code-location-unknown-p code-location)
1792 (error 'unknown-code-location :code-location code-location))
1793 (let ((form-num (code-location-%form-number code-location)))
1794 (cond ((eq form-num :unparsed)
1795 (etypecase code-location
1796 (compiled-code-location
1797 (unless (fill-in-code-location code-location)
1798 ;; This check should be unnecessary. We're missing
1799 ;; debug info the compiler should have dumped.
1800 (bug "unknown code location"))
1801 (code-location-%form-number code-location))
1802 ;; (There used to be more cases back before sbcl-0.7.0,,
1803 ;; when we did special tricks to debug the IR1
1808 ;;; Return the kind of CODE-LOCATION, one of:
1809 ;;; :INTERPRETED, :UNKNOWN-RETURN, :KNOWN-RETURN, :INTERNAL-ERROR,
1810 ;;; :NON-LOCAL-EXIT, :BLOCK-START, :CALL-SITE, :SINGLE-VALUE-RETURN,
1811 ;;; :NON-LOCAL-ENTRY
1812 (defun code-location-kind (code-location)
1813 (when (code-location-unknown-p code-location)
1814 (error 'unknown-code-location :code-location code-location))
1815 (etypecase code-location
1816 (compiled-code-location
1817 (let ((kind (compiled-code-location-kind code-location)))
1818 (cond ((not (eq kind :unparsed)) kind)
1819 ((not (fill-in-code-location code-location))
1820 ;; This check should be unnecessary. We're missing
1821 ;; debug info the compiler should have dumped.
1822 (bug "unknown code location"))
1824 (compiled-code-location-kind code-location)))))
1825 ;; (There used to be more cases back before sbcl-0.7.0,,
1826 ;; when we did special tricks to debug the IR1
1830 ;;; This returns CODE-LOCATION's live-set if it is available. If
1831 ;;; there is no debug-block information, this returns NIL.
1832 (defun compiled-code-location-live-set (code-location)
1833 (if (code-location-unknown-p code-location)
1835 (let ((live-set (compiled-code-location-%live-set code-location)))
1836 (cond ((eq live-set :unparsed)
1837 (unless (fill-in-code-location code-location)
1838 ;; This check should be unnecessary. We're missing
1839 ;; debug info the compiler should have dumped.
1841 ;; FIXME: This error and comment happen over and over again.
1842 ;; Make them a shared function.
1843 (bug "unknown code location"))
1844 (compiled-code-location-%live-set code-location))
1847 ;;; true if OBJ1 and OBJ2 are the same place in the code
1848 (defun code-location= (obj1 obj2)
1850 (compiled-code-location
1852 (compiled-code-location
1853 (and (eq (code-location-debug-fun obj1)
1854 (code-location-debug-fun obj2))
1855 (sub-compiled-code-location= obj1 obj2)))
1856 ;; (There used to be more cases back before sbcl-0.7.0,,
1857 ;; when we did special tricks to debug the IR1
1860 ;; (There used to be more cases back before sbcl-0.7.0,,
1861 ;; when we did special tricks to debug IR1-interpreted code.)
1863 (defun sub-compiled-code-location= (obj1 obj2)
1864 (= (compiled-code-location-pc obj1)
1865 (compiled-code-location-pc obj2)))
1867 ;;; Fill in CODE-LOCATION's :UNPARSED slots, returning T or NIL
1868 ;;; depending on whether the code-location was known in its
1869 ;;; DEBUG-FUN's debug-block information. This may signal a
1870 ;;; NO-DEBUG-BLOCKS condition due to DEBUG-FUN-DEBUG-BLOCKS, and
1871 ;;; it assumes the %UNKNOWN-P slot is already set or going to be set.
1872 (defun fill-in-code-location (code-location)
1873 (declare (type compiled-code-location code-location))
1874 (let* ((debug-fun (code-location-debug-fun code-location))
1875 (blocks (debug-fun-debug-blocks debug-fun)))
1876 (declare (simple-vector blocks))
1877 (dotimes (i (length blocks) nil)
1878 (let* ((block (svref blocks i))
1879 (locations (compiled-debug-block-code-locations block)))
1880 (declare (simple-vector locations))
1881 (dotimes (j (length locations))
1882 (let ((loc (svref locations j)))
1883 (when (sub-compiled-code-location= code-location loc)
1884 (setf (code-location-%debug-block code-location) block)
1885 (setf (code-location-%tlf-offset code-location)
1886 (code-location-%tlf-offset loc))
1887 (setf (code-location-%form-number code-location)
1888 (code-location-%form-number loc))
1889 (setf (compiled-code-location-%live-set code-location)
1890 (compiled-code-location-%live-set loc))
1891 (setf (compiled-code-location-kind code-location)
1892 (compiled-code-location-kind loc))
1893 (setf (compiled-code-location-step-info code-location)
1894 (compiled-code-location-step-info loc))
1895 (return-from fill-in-code-location t))))))))
1897 ;;;; operations on DEBUG-BLOCKs
1899 ;;; Execute FORMS in a context with CODE-VAR bound to each
1900 ;;; CODE-LOCATION in DEBUG-BLOCK, and return the value of RESULT.
1901 (defmacro do-debug-block-locations ((code-var debug-block &optional result)
1903 (let ((code-locations (gensym))
1905 `(let ((,code-locations (debug-block-code-locations ,debug-block)))
1906 (declare (simple-vector ,code-locations))
1907 (dotimes (,i (length ,code-locations) ,result)
1908 (let ((,code-var (svref ,code-locations ,i)))
1911 ;;; Return the name of the function represented by DEBUG-FUN.
1912 ;;; This may be a string or a cons; do not assume it is a symbol.
1913 (defun debug-block-fun-name (debug-block)
1914 (etypecase debug-block
1915 (compiled-debug-block
1916 (let ((code-locs (compiled-debug-block-code-locations debug-block)))
1917 (declare (simple-vector code-locs))
1918 (if (zerop (length code-locs))
1919 "??? Can't get name of debug-block's function."
1921 (code-location-debug-fun (svref code-locs 0))))))
1922 ;; (There used to be more cases back before sbcl-0.7.0, when we
1923 ;; did special tricks to debug the IR1 interpreter.)
1926 (defun debug-block-code-locations (debug-block)
1927 (etypecase debug-block
1928 (compiled-debug-block
1929 (compiled-debug-block-code-locations debug-block))
1930 ;; (There used to be more cases back before sbcl-0.7.0, when we
1931 ;; did special tricks to debug the IR1 interpreter.)
1934 ;;;; operations on debug variables
1936 (defun debug-var-symbol-name (debug-var)
1937 (symbol-name (debug-var-symbol debug-var)))
1939 ;;; FIXME: Make sure that this isn't called anywhere that it wouldn't
1940 ;;; be acceptable to have NIL returned, or that it's only called on
1941 ;;; DEBUG-VARs whose symbols have non-NIL packages.
1942 (defun debug-var-package-name (debug-var)
1943 (package-name (symbol-package (debug-var-symbol debug-var))))
1945 ;;; Return the value stored for DEBUG-VAR in frame, or if the value is
1946 ;;; not :VALID, then signal an INVALID-VALUE error.
1947 (defun debug-var-valid-value (debug-var frame)
1948 (unless (eq (debug-var-validity debug-var (frame-code-location frame))
1950 (error 'invalid-value :debug-var debug-var :frame frame))
1951 (debug-var-value debug-var frame))
1953 ;;; Returns the value stored for DEBUG-VAR in frame. The value may be
1954 ;;; invalid. This is SETFable.
1955 (defun debug-var-value (debug-var frame)
1956 (aver (typep frame 'compiled-frame))
1957 (let ((res (access-compiled-debug-var-slot debug-var frame)))
1958 (if (indirect-value-cell-p res)
1959 (value-cell-ref res)
1962 ;;; This returns what is stored for the variable represented by
1963 ;;; DEBUG-VAR relative to the FRAME. This may be an indirect value
1964 ;;; cell if the variable is both closed over and set.
1965 (defun access-compiled-debug-var-slot (debug-var frame)
1966 (declare (optimize (speed 1)))
1967 (let ((escaped (compiled-frame-escaped frame)))
1969 (sub-access-debug-var-slot
1970 (frame-pointer frame)
1971 (compiled-debug-var-sc-offset debug-var)
1973 (sub-access-debug-var-slot
1974 (frame-pointer frame)
1975 (or (compiled-debug-var-save-sc-offset debug-var)
1976 (compiled-debug-var-sc-offset debug-var))))))
1978 ;;; a helper function for working with possibly-invalid values:
1979 ;;; Do (%MAKE-LISP-OBJ VAL) only if the value looks valid.
1981 ;;; (Such values can arise in registers on machines with conservative
1982 ;;; GC, and might also arise in debug variable locations when
1983 ;;; those variables are invalid.)
1985 ;;; NOTE: this function is not GC-safe in the slightest when creating
1986 ;;; a pointer to an object in dynamic space. If a GC occurs between
1987 ;;; the start of the call to VALID-LISP-POINTER-P and the end of
1988 ;;; %MAKE-LISP-OBJ then the object could move before the boxed pointer
1989 ;;; is constructed. This can happen on CHENEYGC if an asynchronous
1990 ;;; interrupt occurs within the window. This can happen on GENCGC
1991 ;;; under the same circumstances, but is more likely due to all GENCGC
1992 ;;; platforms supporting threaded operation. This is somewhat
1993 ;;; mitigated on x86oids due to the conservative stack and interrupt
1994 ;;; context "scavenging" on such platforms, but there still may be a
1995 ;;; vulnerable window.
1996 (defun make-lisp-obj (val &optional (errorp t))
1999 (zerop (logand val sb!vm:fixnum-tag-mask))
2000 ;; immediate single float, 64-bit only
2001 #!+#.(cl:if (cl:= sb!vm::n-machine-word-bits 64) '(and) '(or))
2002 (= (logand val #xff) sb!vm:single-float-widetag)
2004 (and (zerop (logandc2 val #x1fffffff)) ; Top bits zero
2005 (= (logand val #xff) sb!vm:character-widetag)) ; char tag
2007 (= val sb!vm:unbound-marker-widetag)
2008 ;; undefined_tramp doesn't validate properly as a pointer, and
2009 ;; the actual value can vary by backend (x86oids need not
2011 #!+(or alpha hppa mips ppc)
2012 (= val (+ (- (foreign-symbol-address "undefined_tramp")
2013 (* sb!vm:n-word-bytes sb!vm:simple-fun-code-offset))
2014 sb!vm:fun-pointer-lowtag))
2016 (= val (foreign-symbol-address "undefined_tramp"))
2018 (not (zerop (valid-lisp-pointer-p (int-sap val)))))
2019 (values (%make-lisp-obj val) t)
2021 (error "~S is not a valid argument to ~S"
2023 (values (make-unprintable-object (format nil "invalid object #x~X" val))
2026 (defun sub-access-debug-var-slot (fp sc-offset &optional escaped)
2027 ;; NOTE: The long-float support in here is obviously decayed. When
2028 ;; the x86oid and non-x86oid versions of this function were unified,
2029 ;; the behavior of long-floats was preserved, which only served to
2030 ;; highlight its brokenness.
2031 (macrolet ((with-escaped-value ((var) &body forms)
2033 (let ((,var (sb!vm:context-register
2035 (sb!c:sc-offset-offset sc-offset))))
2037 :invalid-value-for-unescaped-register-storage))
2038 (escaped-float-value (format)
2040 (sb!vm:context-float-register
2042 (sb!c:sc-offset-offset sc-offset)
2044 :invalid-value-for-unescaped-register-storage))
2045 (escaped-complex-float-value (format offset)
2048 (sb!vm:context-float-register
2049 escaped (sb!c:sc-offset-offset sc-offset) ',format)
2050 (sb!vm:context-float-register
2051 escaped (+ (sb!c:sc-offset-offset sc-offset) ,offset) ',format))
2052 :invalid-value-for-unescaped-register-storage))
2053 (with-nfp ((var) &body body)
2054 ;; x86oids have no separate number stack, so dummy it
2060 `(let ((,var (if escaped
2062 (sb!vm:context-register escaped
2065 (sb!sys:sap-ref-sap fp (* nfp-save-offset
2066 sb!vm:n-word-bytes))
2068 (sb!vm::make-number-stack-pointer
2069 (sb!sys:sap-ref-32 fp (* nfp-save-offset
2070 sb!vm:n-word-bytes))))))
2072 (stack-frame-offset (data-width offset)
2074 `(sb!vm::frame-byte-offset (+ (sb!c:sc-offset-offset sc-offset)
2078 (declare (ignore data-width))
2080 `(* (+ (sb!c:sc-offset-offset sc-offset) ,offset)
2081 sb!vm:n-word-bytes)))
2082 (ecase (sb!c:sc-offset-scn sc-offset)
2083 ((#.sb!vm:any-reg-sc-number
2084 #.sb!vm:descriptor-reg-sc-number
2085 #!+rt #.sb!vm:word-pointer-reg-sc-number)
2087 (with-escaped-value (val)
2088 (make-lisp-obj val nil))))
2089 (#.sb!vm:character-reg-sc-number
2090 (with-escaped-value (val)
2092 (#.sb!vm:sap-reg-sc-number
2093 (with-escaped-value (val)
2094 (sb!sys:int-sap val)))
2095 (#.sb!vm:signed-reg-sc-number
2096 (with-escaped-value (val)
2097 (if (logbitp (1- sb!vm:n-word-bits) val)
2098 (logior val (ash -1 sb!vm:n-word-bits))
2100 (#.sb!vm:unsigned-reg-sc-number
2101 (with-escaped-value (val)
2104 (#.sb!vm:non-descriptor-reg-sc-number
2105 (error "Local non-descriptor register access?"))
2107 (#.sb!vm:interior-reg-sc-number
2108 (error "Local interior register access?"))
2109 (#.sb!vm:single-reg-sc-number
2110 (escaped-float-value single-float))
2111 (#.sb!vm:double-reg-sc-number
2112 (escaped-float-value double-float))
2114 (#.sb!vm:long-reg-sc-number
2115 (escaped-float-value long-float))
2116 (#.sb!vm:complex-single-reg-sc-number
2117 (escaped-complex-float-value single-float 1))
2118 (#.sb!vm:complex-double-reg-sc-number
2119 (escaped-complex-float-value double-float #!+sparc 2 #!-sparc 1))
2121 (#.sb!vm:complex-long-reg-sc-number
2122 (escaped-complex-float-value long-float
2123 #!+sparc 4 #!+(or x86 x86-64) 1
2124 #!-(or sparc x86 x86-64) 0))
2125 (#.sb!vm:single-stack-sc-number
2127 (sb!sys:sap-ref-single nfp (stack-frame-offset 1 0))))
2128 (#.sb!vm:double-stack-sc-number
2130 (sb!sys:sap-ref-double nfp (stack-frame-offset 2 0))))
2132 (#.sb!vm:long-stack-sc-number
2134 (sb!sys:sap-ref-long nfp (stack-frame-offset 3 0))))
2135 (#.sb!vm:complex-single-stack-sc-number
2138 (sb!sys:sap-ref-single nfp (stack-frame-offset 1 0))
2139 (sb!sys:sap-ref-single nfp (stack-frame-offset 1 1)))))
2140 (#.sb!vm:complex-double-stack-sc-number
2143 (sb!sys:sap-ref-double nfp (stack-frame-offset 2 0))
2144 (sb!sys:sap-ref-double nfp (stack-frame-offset 2 2)))))
2146 (#.sb!vm:complex-long-stack-sc-number
2149 (sb!sys:sap-ref-long nfp (stack-frame-offset 3 0))
2150 (sb!sys:sap-ref-long nfp
2151 (stack-frame-offset 3 #!+sparc 4
2152 #!+(or x86 x86-64) 3
2153 #!-(or sparc x86 x86-64) 0)))))
2154 (#.sb!vm:control-stack-sc-number
2155 (stack-ref fp (sb!c:sc-offset-offset sc-offset)))
2156 (#.sb!vm:character-stack-sc-number
2158 (code-char (sb!sys:sap-ref-word nfp (stack-frame-offset 1 0)))))
2159 (#.sb!vm:unsigned-stack-sc-number
2161 (sb!sys:sap-ref-word nfp (stack-frame-offset 1 0))))
2162 (#.sb!vm:signed-stack-sc-number
2164 (sb!sys:signed-sap-ref-word nfp (stack-frame-offset 1 0))))
2165 (#.sb!vm:sap-stack-sc-number
2167 (sb!sys:sap-ref-sap nfp (stack-frame-offset 1 0)))))))
2169 ;;; This stores value as the value of DEBUG-VAR in FRAME. In the
2170 ;;; COMPILED-DEBUG-VAR case, access the current value to determine if
2171 ;;; it is an indirect value cell. This occurs when the variable is
2172 ;;; both closed over and set.
2173 (defun %set-debug-var-value (debug-var frame new-value)
2174 (aver (typep frame 'compiled-frame))
2175 (let ((old-value (access-compiled-debug-var-slot debug-var frame)))
2176 (if (indirect-value-cell-p old-value)
2177 (value-cell-set old-value new-value)
2178 (set-compiled-debug-var-slot debug-var frame new-value)))
2181 ;;; This stores VALUE for the variable represented by debug-var
2182 ;;; relative to the frame. This assumes the location directly contains
2183 ;;; the variable's value; that is, there is no indirect value cell
2184 ;;; currently there in case the variable is both closed over and set.
2185 (defun set-compiled-debug-var-slot (debug-var frame value)
2186 (let ((escaped (compiled-frame-escaped frame)))
2188 (sub-set-debug-var-slot (frame-pointer frame)
2189 (compiled-debug-var-sc-offset debug-var)
2191 (sub-set-debug-var-slot
2192 (frame-pointer frame)
2193 (or (compiled-debug-var-save-sc-offset debug-var)
2194 (compiled-debug-var-sc-offset debug-var))
2197 (defun sub-set-debug-var-slot (fp sc-offset value &optional escaped)
2198 ;; Like sub-access-debug-var-slot, this is the unification of two
2199 ;; divergent copy-pasted functions. The astute reviewer will notice
2200 ;; that long-floats are messed up here as well, that x86oids
2201 ;; apparently don't support accessing float values that are in
2202 ;; registers, and that non-x86oids store the real part of a float
2203 ;; for both the real and imaginary parts of a complex on the stack
2204 ;; (but not in registers, oddly enough). Some research has
2205 ;; indicated that the different forms of THE used for validating the
2206 ;; type of complex float components between x86oid and non-x86oid
2207 ;; systems are only significant in the case of using a non-complex
2208 ;; number as input (as the non-x86oid case effectively converts
2209 ;; non-complex numbers to complex ones and the x86oid case will
2210 ;; error out). That said, the error message from entering a value
2211 ;; of the wrong type will be slightly easier to understand on x86oid
2213 (macrolet ((set-escaped-value (val)
2215 (setf (sb!vm:context-register
2217 (sb!c:sc-offset-offset sc-offset))
2220 (set-escaped-float-value (format val)
2222 (setf (sb!vm:context-float-register
2224 (sb!c:sc-offset-offset sc-offset)
2228 (set-escaped-complex-float-value (format offset val)
2231 (setf (sb!vm:context-float-register
2232 escaped (sb!c:sc-offset-offset sc-offset) ',format)
2234 (setf (sb!vm:context-float-register
2235 escaped (+ (sb!c:sc-offset-offset sc-offset) ,offset)
2239 (with-nfp ((var) &body body)
2240 ;; x86oids have no separate number stack, so dummy it
2246 `(let ((,var (if escaped
2248 (sb!vm:context-register escaped
2253 sb!vm:n-word-bytes))
2255 (sb!vm::make-number-stack-pointer
2258 sb!vm:n-word-bytes))))))
2260 (stack-frame-offset (data-width offset)
2262 `(sb!vm::frame-byte-offset (+ (sb!c:sc-offset-offset sc-offset)
2266 (declare (ignore data-width))
2268 `(* (+ (sb!c:sc-offset-offset sc-offset) ,offset)
2269 sb!vm:n-word-bytes)))
2270 (ecase (sb!c:sc-offset-scn sc-offset)
2271 ((#.sb!vm:any-reg-sc-number
2272 #.sb!vm:descriptor-reg-sc-number
2273 #!+rt #.sb!vm:word-pointer-reg-sc-number)
2276 (get-lisp-obj-address value))))
2277 (#.sb!vm:character-reg-sc-number
2278 (set-escaped-value (char-code value)))
2279 (#.sb!vm:sap-reg-sc-number
2280 (set-escaped-value (sap-int value)))
2281 (#.sb!vm:signed-reg-sc-number
2282 (set-escaped-value (logand value (1- (ash 1 sb!vm:n-word-bits)))))
2283 (#.sb!vm:unsigned-reg-sc-number
2284 (set-escaped-value value))
2286 (#.sb!vm:non-descriptor-reg-sc-number
2287 (error "Local non-descriptor register access?"))
2289 (#.sb!vm:interior-reg-sc-number
2290 (error "Local interior register access?"))
2291 (#.sb!vm:single-reg-sc-number
2292 #!-(or x86 x86-64) ;; don't have escaped floats.
2293 (set-escaped-float-value single-float value))
2294 (#.sb!vm:double-reg-sc-number
2295 #!-(or x86 x86-64) ;; don't have escaped floats -- still in npx?
2296 (set-escaped-float-value double-float value))
2298 (#.sb!vm:long-reg-sc-number
2299 #!-(or x86 x86-64) ;; don't have escaped floats -- still in npx?
2300 (set-escaped-float-value long-float value))
2302 (#.sb!vm:complex-single-reg-sc-number
2303 (set-escaped-complex-float-value single-float 1 value))
2305 (#.sb!vm:complex-double-reg-sc-number
2306 (set-escaped-complex-float-value double-float #!+sparc 2 #!-sparc 1 value))
2307 #!+(and long-float (not (or x86 x86-64)))
2308 (#.sb!vm:complex-long-reg-sc-number
2309 (set-escaped-complex-float-value long-float #!+sparc 4 #!-sparc 0 value))
2310 (#.sb!vm:single-stack-sc-number
2312 (setf (sap-ref-single nfp (stack-frame-offset 1 0))
2313 (the single-float value))))
2314 (#.sb!vm:double-stack-sc-number
2316 (setf (sap-ref-double nfp (stack-frame-offset 2 0))
2317 (the double-float value))))
2319 (#.sb!vm:long-stack-sc-number
2321 (setf (sap-ref-long nfp (stack-frame-offset 3 0))
2322 (the long-float value))))
2323 (#.sb!vm:complex-single-stack-sc-number
2325 (setf (sap-ref-single
2326 nfp (stack-frame-offset 1 0))
2328 (realpart (the (complex single-float) value))
2330 (the single-float (realpart value)))
2331 (setf (sap-ref-single
2332 nfp (stack-frame-offset 1 1))
2334 (imagpart (the (complex single-float) value))
2336 (the single-float (realpart value)))))
2337 (#.sb!vm:complex-double-stack-sc-number
2339 (setf (sap-ref-double
2340 nfp (stack-frame-offset 2 0))
2342 (realpart (the (complex double-float) value))
2344 (the double-float (realpart value)))
2345 (setf (sap-ref-double
2346 nfp (stack-frame-offset 2 2))
2348 (imagpart (the (complex double-float) value))
2350 (the double-float (realpart value)))))
2352 (#.sb!vm:complex-long-stack-sc-number
2355 nfp (stack-frame-offset 3 0))
2357 (realpart (the (complex long-float) value))
2359 (the long-float (realpart value)))
2361 nfp (stack-frame-offset 3 #!+sparc 4
2362 #!+(or x86 x86-64) 3
2363 #!-(or sparc x86 x86-64) 0))
2365 (imagpart (the (complex long-float) value))
2367 (the long-float (realpart value)))))
2368 (#.sb!vm:control-stack-sc-number
2369 (setf (stack-ref fp (sb!c:sc-offset-offset sc-offset)) value))
2370 (#.sb!vm:character-stack-sc-number
2372 (setf (sap-ref-word nfp (stack-frame-offset 1 0))
2373 (char-code (the character value)))))
2374 (#.sb!vm:unsigned-stack-sc-number
2376 (setf (sap-ref-word nfp (stack-frame-offset 1 0))
2377 (the (unsigned-byte 32) value))))
2378 (#.sb!vm:signed-stack-sc-number
2380 (setf (signed-sap-ref-word nfp (stack-frame-offset 1 0))
2381 (the (signed-byte 32) value))))
2382 (#.sb!vm:sap-stack-sc-number
2384 (setf (sap-ref-sap nfp (stack-frame-offset 1 0))
2385 (the system-area-pointer value)))))))
2387 ;;; The method for setting and accessing COMPILED-DEBUG-VAR values use
2388 ;;; this to determine if the value stored is the actual value or an
2389 ;;; indirection cell.
2390 (defun indirect-value-cell-p (x)
2391 (and (= (lowtag-of x) sb!vm:other-pointer-lowtag)
2392 (= (widetag-of x) sb!vm:value-cell-header-widetag)))
2394 ;;; Return three values reflecting the validity of DEBUG-VAR's value
2395 ;;; at BASIC-CODE-LOCATION:
2396 ;;; :VALID The value is known to be available.
2397 ;;; :INVALID The value is known to be unavailable.
2398 ;;; :UNKNOWN The value's availability is unknown.
2400 ;;; If the variable is always alive, then it is valid. If the
2401 ;;; code-location is unknown, then the variable's validity is
2402 ;;; :unknown. Once we've called CODE-LOCATION-UNKNOWN-P, we know the
2403 ;;; live-set information has been cached in the code-location.
2404 (defun debug-var-validity (debug-var basic-code-location)
2405 (compiled-debug-var-validity debug-var basic-code-location))
2407 (defun debug-var-info (debug-var)
2408 (compiled-debug-var-info debug-var))
2410 ;;; This is the method for DEBUG-VAR-VALIDITY for COMPILED-DEBUG-VARs.
2411 ;;; For safety, make sure basic-code-location is what we think.
2412 (defun compiled-debug-var-validity (debug-var basic-code-location)
2413 (declare (type compiled-code-location basic-code-location))
2414 (cond ((debug-var-alive-p debug-var)
2415 (let ((debug-fun (code-location-debug-fun basic-code-location)))
2416 (if (>= (compiled-code-location-pc basic-code-location)
2417 (sb!c::compiled-debug-fun-start-pc
2418 (compiled-debug-fun-compiler-debug-fun debug-fun)))
2421 ((code-location-unknown-p basic-code-location) :unknown)
2423 (let ((pos (position debug-var
2424 (debug-fun-debug-vars
2425 (code-location-debug-fun
2426 basic-code-location)))))
2428 (error 'unknown-debug-var
2429 :debug-var debug-var
2431 (code-location-debug-fun basic-code-location)))
2432 ;; There must be live-set info since basic-code-location is known.
2433 (if (zerop (sbit (compiled-code-location-live-set
2434 basic-code-location)
2441 ;;; This code produces and uses what we call source-paths. A
2442 ;;; source-path is a list whose first element is a form number as
2443 ;;; returned by CODE-LOCATION-FORM-NUMBER and whose last element is a
2444 ;;; top level form number as returned by
2445 ;;; CODE-LOCATION-TOPLEVEL-FORM-NUMBER. The elements from the last to
2446 ;;; the first, exclusively, are the numbered subforms into which to
2447 ;;; descend. For example:
2449 ;;; (let ((a (aref x 3)))
2451 ;;; The call to AREF in this example is form number 5. Assuming this
2452 ;;; DEFUN is the 11'th top level form, the source-path for the AREF
2453 ;;; call is as follows:
2455 ;;; Given the DEFUN, 3 gets you the LET, 1 gets you the bindings, 0
2456 ;;; gets the first binding, and 1 gets the AREF form.
2458 ;;; This returns a table mapping form numbers to source-paths. A
2459 ;;; source-path indicates a descent into the TOPLEVEL-FORM form,
2460 ;;; going directly to the subform corressponding to the form number.
2462 ;;; The vector elements are in the same format as the compiler's
2463 ;;; NODE-SOURCE-PATH; that is, the first element is the form number and
2464 ;;; the last is the TOPLEVEL-FORM number.
2465 (defun form-number-translations (form tlf-number)
2467 (translations (make-array 12 :fill-pointer 0 :adjustable t)))
2468 (labels ((translate1 (form path)
2469 (unless (member form seen)
2471 (vector-push-extend (cons (fill-pointer translations) path)
2476 (declare (fixnum pos))
2479 (when (atom subform) (return))
2480 (let ((fm (car subform)))
2482 (translate1 fm (cons pos path)))
2484 (setq subform (cdr subform))
2485 (when (eq subform trail) (return)))))
2489 (setq trail (cdr trail))))))))
2490 (translate1 form (list tlf-number)))
2491 (coerce translations 'simple-vector)))
2493 ;;; FORM is a top level form, and path is a source-path into it. This
2494 ;;; returns the form indicated by the source-path. Context is the
2495 ;;; number of enclosing forms to return instead of directly returning
2496 ;;; the source-path form. When context is non-zero, the form returned
2497 ;;; contains a marker, #:****HERE****, immediately before the form
2498 ;;; indicated by path.
2499 (defun source-path-context (form path context)
2500 (declare (type unsigned-byte context))
2501 ;; Get to the form indicated by path or the enclosing form indicated
2502 ;; by context and path.
2503 (let ((path (reverse (butlast (cdr path)))))
2504 (dotimes (i (- (length path) context))
2505 (let ((index (first path)))
2506 (unless (and (listp form) (< index (length form)))
2507 (error "Source path no longer exists."))
2508 (setq form (elt form index))
2509 (setq path (rest path))))
2510 ;; Recursively rebuild the source form resulting from the above
2511 ;; descent, copying the beginning of each subform up to the next
2512 ;; subform we descend into according to path. At the bottom of the
2513 ;; recursion, we return the form indicated by path preceded by our
2514 ;; marker, and this gets spliced into the resulting list structure
2515 ;; on the way back up.
2516 (labels ((frob (form path level)
2517 (if (or (zerop level) (null path))
2520 `(#:***here*** ,form))
2521 (let ((n (first path)))
2522 (unless (and (listp form) (< n (length form)))
2523 (error "Source path no longer exists."))
2524 (let ((res (frob (elt form n) (rest path) (1- level))))
2525 (nconc (subseq form 0 n)
2526 (cons res (nthcdr (1+ n) form))))))))
2527 (frob form path context))))
2529 ;;; Given a code location, return the associated form-number
2530 ;;; translations and the actual top level form.
2531 (defun get-toplevel-form (location)
2532 (let ((d-source (code-location-debug-source location)))
2533 (let* ((offset (code-location-toplevel-form-offset location))
2535 (cond ((debug-source-form d-source)
2536 (debug-source-form d-source))
2537 ((debug-source-namestring d-source)
2538 (get-file-toplevel-form location))
2539 (t (bug "Don't know how to use a DEBUG-SOURCE without ~
2540 a namestring or a form.")))))
2541 (values (form-number-translations res offset) res))))
2543 ;;; To suppress the read-time evaluation #. macro during source read,
2544 ;;; *READTABLE* is modified.
2546 ;;; FIXME: This breaks #+#.(cl:if ...) Maybe we need a SAFE-READ-EVAL, which
2547 ;;; this code can use for side- effect free #. calls?
2549 ;;; FIXME: This also knows nothing of custom readtables. The assumption
2550 ;;; is that the current readtable is a decent approximation for what
2551 ;;; we want, but that's lossy.
2552 (defun safe-readtable ()
2553 (let ((rt (copy-readtable)))
2554 (set-dispatch-macro-character
2555 #\# #\. (lambda (stream sub-char &rest rest)
2556 (declare (ignore rest sub-char))
2557 (let ((token (read stream t nil t)))
2558 (format nil "#.~S" token)))
2562 ;;; Locate the source file (if it still exists) and grab the top level
2563 ;;; form. If the file is modified, we use the top level form offset
2564 ;;; instead of the recorded character offset.
2565 (defun get-file-toplevel-form (location)
2566 (let* ((d-source (code-location-debug-source location))
2567 (tlf-offset (code-location-toplevel-form-offset location))
2568 (local-tlf-offset (- tlf-offset
2569 (debug-source-root-number d-source)))
2571 (aref (or (sb!di:debug-source-start-positions d-source)
2572 (error "no start positions map"))
2574 (namestring (debug-source-namestring d-source)))
2575 ;; FIXME: External format?
2576 (with-open-file (f namestring :if-does-not-exist nil)
2578 (error "The source file no longer exists:~% ~A" namestring))
2579 (format *debug-io* "~%; file: ~A~%" namestring)
2580 (let ((*readtable* (safe-readtable)))
2581 (cond ((eql (debug-source-created d-source) (file-write-date f))
2582 (file-position f char-offset))
2585 "~%; File has been modified since compilation:~%; ~A~@
2586 ; Using form offset instead of character position.~%"
2588 (let ((*read-suppress* t))
2589 (loop repeat local-tlf-offset
2593 ;;;; PREPROCESS-FOR-EVAL
2595 ;;; Return a function of one argument that evaluates form in the
2596 ;;; lexical context of the BASIC-CODE-LOCATION LOC, or signal a
2597 ;;; NO-DEBUG-VARS condition when the LOC's DEBUG-FUN has no
2598 ;;; DEBUG-VAR information available.
2600 ;;; The returned function takes the frame to get values from as its
2601 ;;; argument, and it returns the values of FORM. The returned function
2602 ;;; can signal the following conditions: INVALID-VALUE,
2603 ;;; AMBIGUOUS-VAR-NAME, and FRAME-FUN-MISMATCH.
2604 (defun preprocess-for-eval (form loc)
2605 (declare (type code-location loc))
2606 (let ((n-frame (gensym))
2607 (fun (code-location-debug-fun loc))
2610 (unless (debug-var-info-available fun)
2611 (debug-signal 'no-debug-vars :debug-fun fun))
2612 (sb!int:collect ((binds)
2614 (do-debug-fun-vars (var fun)
2615 (let ((validity (debug-var-validity var loc)))
2616 (unless (eq validity :invalid)
2617 (case (debug-var-info var)
2619 (setf more-context var))
2621 (setf more-count var)))
2622 (let* ((sym (debug-var-symbol var))
2623 (found (assoc sym (binds))))
2625 (setf (second found) :ambiguous)
2626 (binds (list sym validity var)))))))
2627 (when (and more-context more-count)
2628 (let ((more (assoc 'sb!debug::more (binds))))
2630 (setf (second more) :ambiguous)
2631 (binds (list 'sb!debug::more :more more-context more-count)))))
2632 (dolist (bind (binds))
2633 (let ((name (first bind))
2635 (ecase (second bind)
2637 (specs `(,name (debug-var-value ',var ,n-frame))))
2639 (let ((count-var (fourth bind)))
2640 (specs `(,name (multiple-value-list
2641 (sb!c:%more-arg-values (debug-var-value ',var ,n-frame)
2643 (debug-var-value ',count-var ,n-frame)))))))
2645 (specs `(,name (debug-signal 'invalid-value
2649 (specs `(,name (debug-signal 'ambiguous-var-name
2651 :frame ,n-frame)))))))
2652 (let ((res (coerce `(lambda (,n-frame)
2653 (declare (ignorable ,n-frame))
2654 (symbol-macrolet ,(specs) ,form))
2657 ;; This prevents these functions from being used in any
2658 ;; location other than a function return location, so maybe
2659 ;; this should only check whether FRAME's DEBUG-FUN is the
2661 (unless (code-location= (frame-code-location frame) loc)
2662 (debug-signal 'frame-fun-mismatch
2663 :code-location loc :form form :frame frame))
2664 (funcall res frame))))))
2668 (defun eval-in-frame (frame form)
2669 (declare (type frame frame))
2671 "Evaluate FORM in the lexical context of FRAME's current code location,
2672 returning the results of the evaluation."
2673 (funcall (preprocess-for-eval form (frame-code-location frame)) frame))
2677 ;;;; user-visible interface
2679 ;;; Create and return a breakpoint. When program execution encounters
2680 ;;; the breakpoint, the system calls HOOK-FUN. HOOK-FUN takes the
2681 ;;; current frame for the function in which the program is running and
2682 ;;; the breakpoint object.
2684 ;;; WHAT and KIND determine where in a function the system invokes
2685 ;;; HOOK-FUN. WHAT is either a code-location or a DEBUG-FUN. KIND is
2686 ;;; one of :CODE-LOCATION, :FUN-START, or :FUN-END. Since the starts
2687 ;;; and ends of functions may not have code-locations representing
2688 ;;; them, designate these places by supplying WHAT as a DEBUG-FUN and
2689 ;;; KIND indicating the :FUN-START or :FUN-END. When WHAT is a
2690 ;;; DEBUG-FUN and kind is :FUN-END, then HOOK-FUN must take two
2691 ;;; additional arguments, a list of values returned by the function
2692 ;;; and a FUN-END-COOKIE.
2694 ;;; INFO is information supplied by and used by the user.
2696 ;;; FUN-END-COOKIE is a function. To implement :FUN-END
2697 ;;; breakpoints, the system uses starter breakpoints to establish the
2698 ;;; :FUN-END breakpoint for each invocation of the function. Upon
2699 ;;; each entry, the system creates a unique cookie to identify the
2700 ;;; invocation, and when the user supplies a function for this
2701 ;;; argument, the system invokes it on the frame and the cookie. The
2702 ;;; system later invokes the :FUN-END breakpoint hook on the same
2703 ;;; cookie. The user may save the cookie for comparison in the hook
2706 ;;; Signal an error if WHAT is an unknown code-location.
2707 (defun make-breakpoint (hook-fun what
2708 &key (kind :code-location) info fun-end-cookie)
2711 (when (code-location-unknown-p what)
2712 (error "cannot make a breakpoint at an unknown code location: ~S"
2714 (aver (eq kind :code-location))
2715 (let ((bpt (%make-breakpoint hook-fun what kind info)))
2717 (compiled-code-location
2718 ;; This slot is filled in due to calling CODE-LOCATION-UNKNOWN-P.
2719 (when (eq (compiled-code-location-kind what) :unknown-return)
2720 (let ((other-bpt (%make-breakpoint hook-fun what
2721 :unknown-return-partner
2723 (setf (breakpoint-unknown-return-partner bpt) other-bpt)
2724 (setf (breakpoint-unknown-return-partner other-bpt) bpt))))
2725 ;; (There used to be more cases back before sbcl-0.7.0,,
2726 ;; when we did special tricks to debug the IR1
2733 (%make-breakpoint hook-fun what kind info))
2735 (unless (eq (sb!c::compiled-debug-fun-returns
2736 (compiled-debug-fun-compiler-debug-fun what))
2738 (error ":FUN-END breakpoints are currently unsupported ~
2739 for the known return convention."))
2741 (let* ((bpt (%make-breakpoint hook-fun what kind info))
2742 (starter (compiled-debug-fun-end-starter what)))
2744 (setf starter (%make-breakpoint #'list what :fun-start nil))
2745 (setf (breakpoint-hook-fun starter)
2746 (fun-end-starter-hook starter what))
2747 (setf (compiled-debug-fun-end-starter what) starter))
2748 (setf (breakpoint-start-helper bpt) starter)
2749 (push bpt (breakpoint-%info starter))
2750 (setf (breakpoint-cookie-fun bpt) fun-end-cookie)
2753 ;;; These are unique objects created upon entry into a function by a
2754 ;;; :FUN-END breakpoint's starter hook. These are only created
2755 ;;; when users supply :FUN-END-COOKIE to MAKE-BREAKPOINT. Also,
2756 ;;; the :FUN-END breakpoint's hook is called on the same cookie
2757 ;;; when it is created.
2758 (defstruct (fun-end-cookie
2759 (:print-object (lambda (obj str)
2760 (print-unreadable-object (obj str :type t))))
2761 (:constructor make-fun-end-cookie (bogus-lra debug-fun))
2763 ;; a pointer to the bogus-lra created for :FUN-END breakpoints
2765 ;; the DEBUG-FUN associated with this cookie
2768 ;;; This maps bogus-lra-components to cookies, so that
2769 ;;; HANDLE-FUN-END-BREAKPOINT can find the appropriate cookie for the
2770 ;;; breakpoint hook.
2771 (defvar *fun-end-cookies* (make-hash-table :test 'eq :synchronized t))
2773 ;;; This returns a hook function for the start helper breakpoint
2774 ;;; associated with a :FUN-END breakpoint. The returned function
2775 ;;; makes a fake LRA that all returns go through, and this piece of
2776 ;;; fake code actually breaks. Upon return from the break, the code
2777 ;;; provides the returnee with any values. Since the returned function
2778 ;;; effectively activates FUN-END-BPT on each entry to DEBUG-FUN's
2779 ;;; function, we must establish breakpoint-data about FUN-END-BPT.
2780 (defun fun-end-starter-hook (starter-bpt debug-fun)
2781 (declare (type breakpoint starter-bpt)
2782 (type compiled-debug-fun debug-fun))
2783 (lambda (frame breakpoint)
2784 (declare (ignore breakpoint)
2786 (let ((lra-sc-offset
2787 (sb!c::compiled-debug-fun-return-pc
2788 (compiled-debug-fun-compiler-debug-fun debug-fun))))
2789 (multiple-value-bind (lra component offset)
2791 (get-context-value frame
2794 (setf (get-context-value frame
2798 (let ((end-bpts (breakpoint-%info starter-bpt)))
2799 (let ((data (breakpoint-data component offset)))
2800 (setf (breakpoint-data-breakpoints data) end-bpts)
2801 (dolist (bpt end-bpts)
2802 (setf (breakpoint-internal-data bpt) data)))
2803 (let ((cookie (make-fun-end-cookie lra debug-fun)))
2804 (setf (gethash component *fun-end-cookies*) cookie)
2805 (dolist (bpt end-bpts)
2806 (let ((fun (breakpoint-cookie-fun bpt)))
2807 (when fun (funcall fun frame cookie))))))))))
2809 ;;; This takes a FUN-END-COOKIE and a frame, and it returns
2810 ;;; whether the cookie is still valid. A cookie becomes invalid when
2811 ;;; the frame that established the cookie has exited. Sometimes cookie
2812 ;;; holders are unaware of cookie invalidation because their
2813 ;;; :FUN-END breakpoint hooks didn't run due to THROW'ing.
2815 ;;; This takes a frame as an efficiency hack since the user probably
2816 ;;; has a frame object in hand when using this routine, and it saves
2817 ;;; repeated parsing of the stack and consing when asking whether a
2818 ;;; series of cookies is valid.
2819 (defun fun-end-cookie-valid-p (frame cookie)
2820 (let ((lra (fun-end-cookie-bogus-lra cookie))
2821 (lra-sc-offset (sb!c::compiled-debug-fun-return-pc
2822 (compiled-debug-fun-compiler-debug-fun
2823 (fun-end-cookie-debug-fun cookie)))))
2824 (do ((frame frame (frame-down frame)))
2826 (when (and (compiled-frame-p frame)
2827 (#!-(or x86 x86-64) eq #!+(or x86 x86-64) sap=
2829 (get-context-value frame lra-save-offset lra-sc-offset)))
2832 ;;;; ACTIVATE-BREAKPOINT
2834 ;;; Cause the system to invoke the breakpoint's hook function until
2835 ;;; the next call to DEACTIVATE-BREAKPOINT or DELETE-BREAKPOINT. The
2836 ;;; system invokes breakpoint hook functions in the opposite order
2837 ;;; that you activate them.
2838 (defun activate-breakpoint (breakpoint)
2839 (when (eq (breakpoint-status breakpoint) :deleted)
2840 (error "cannot activate a deleted breakpoint: ~S" breakpoint))
2841 (unless (eq (breakpoint-status breakpoint) :active)
2842 (ecase (breakpoint-kind breakpoint)
2844 (let ((loc (breakpoint-what breakpoint)))
2846 (compiled-code-location
2847 (activate-compiled-code-location-breakpoint breakpoint)
2848 (let ((other (breakpoint-unknown-return-partner breakpoint)))
2850 (activate-compiled-code-location-breakpoint other))))
2851 ;; (There used to be more cases back before sbcl-0.7.0, when
2852 ;; we did special tricks to debug the IR1 interpreter.)
2855 (etypecase (breakpoint-what breakpoint)
2857 (activate-compiled-fun-start-breakpoint breakpoint))
2858 ;; (There used to be more cases back before sbcl-0.7.0, when
2859 ;; we did special tricks to debug the IR1 interpreter.)
2862 (etypecase (breakpoint-what breakpoint)
2864 (let ((starter (breakpoint-start-helper breakpoint)))
2865 (unless (eq (breakpoint-status starter) :active)
2866 ;; may already be active by some other :FUN-END breakpoint
2867 (activate-compiled-fun-start-breakpoint starter)))
2868 (setf (breakpoint-status breakpoint) :active))
2869 ;; (There used to be more cases back before sbcl-0.7.0, when
2870 ;; we did special tricks to debug the IR1 interpreter.)
2874 (defun activate-compiled-code-location-breakpoint (breakpoint)
2875 (declare (type breakpoint breakpoint))
2876 (let ((loc (breakpoint-what breakpoint)))
2877 (declare (type compiled-code-location loc))
2878 (sub-activate-breakpoint
2880 (breakpoint-data (compiled-debug-fun-component
2881 (code-location-debug-fun loc))
2882 (+ (compiled-code-location-pc loc)
2883 (if (or (eq (breakpoint-kind breakpoint)
2884 :unknown-return-partner)
2885 (eq (compiled-code-location-kind loc)
2886 :single-value-return))
2887 sb!vm:single-value-return-byte-offset
2890 (defun activate-compiled-fun-start-breakpoint (breakpoint)
2891 (declare (type breakpoint breakpoint))
2892 (let ((debug-fun (breakpoint-what breakpoint)))
2893 (sub-activate-breakpoint
2895 (breakpoint-data (compiled-debug-fun-component debug-fun)
2896 (sb!c::compiled-debug-fun-start-pc
2897 (compiled-debug-fun-compiler-debug-fun
2900 (defun sub-activate-breakpoint (breakpoint data)
2901 (declare (type breakpoint breakpoint)
2902 (type breakpoint-data data))
2903 (setf (breakpoint-status breakpoint) :active)
2905 (unless (breakpoint-data-breakpoints data)
2906 (setf (breakpoint-data-instruction data)
2908 (breakpoint-install (get-lisp-obj-address
2909 (breakpoint-data-component data))
2910 (breakpoint-data-offset data)))))
2911 (setf (breakpoint-data-breakpoints data)
2912 (append (breakpoint-data-breakpoints data) (list breakpoint)))
2913 (setf (breakpoint-internal-data breakpoint) data)))
2915 ;;;; DEACTIVATE-BREAKPOINT
2917 ;;; Stop the system from invoking the breakpoint's hook function.
2918 (defun deactivate-breakpoint (breakpoint)
2919 (when (eq (breakpoint-status breakpoint) :active)
2921 (let ((loc (breakpoint-what breakpoint)))
2923 ((or compiled-code-location compiled-debug-fun)
2924 (deactivate-compiled-breakpoint breakpoint)
2925 (let ((other (breakpoint-unknown-return-partner breakpoint)))
2927 (deactivate-compiled-breakpoint other))))
2928 ;; (There used to be more cases back before sbcl-0.7.0, when
2929 ;; we did special tricks to debug the IR1 interpreter.)
2933 (defun deactivate-compiled-breakpoint (breakpoint)
2934 (if (eq (breakpoint-kind breakpoint) :fun-end)
2935 (let ((starter (breakpoint-start-helper breakpoint)))
2936 (unless (find-if (lambda (bpt)
2937 (and (not (eq bpt breakpoint))
2938 (eq (breakpoint-status bpt) :active)))
2939 (breakpoint-%info starter))
2940 (deactivate-compiled-breakpoint starter)))
2941 (let* ((data (breakpoint-internal-data breakpoint))
2942 (bpts (delete breakpoint (breakpoint-data-breakpoints data))))
2943 (setf (breakpoint-internal-data breakpoint) nil)
2944 (setf (breakpoint-data-breakpoints data) bpts)
2947 (breakpoint-remove (get-lisp-obj-address
2948 (breakpoint-data-component data))
2949 (breakpoint-data-offset data)
2950 (breakpoint-data-instruction data)))
2951 (delete-breakpoint-data data))))
2952 (setf (breakpoint-status breakpoint) :inactive)
2955 ;;;; BREAKPOINT-INFO
2957 ;;; Return the user-maintained info associated with breakpoint. This
2959 (defun breakpoint-info (breakpoint)
2960 (breakpoint-%info breakpoint))
2961 (defun %set-breakpoint-info (breakpoint value)
2962 (setf (breakpoint-%info breakpoint) value)
2963 (let ((other (breakpoint-unknown-return-partner breakpoint)))
2965 (setf (breakpoint-%info other) value))))
2967 ;;;; BREAKPOINT-ACTIVE-P and DELETE-BREAKPOINT
2969 (defun breakpoint-active-p (breakpoint)
2970 (ecase (breakpoint-status breakpoint)
2972 ((:inactive :deleted) nil)))
2974 ;;; Free system storage and remove computational overhead associated
2975 ;;; with breakpoint. After calling this, breakpoint is completely
2976 ;;; impotent and can never become active again.
2977 (defun delete-breakpoint (breakpoint)
2978 (let ((status (breakpoint-status breakpoint)))
2979 (unless (eq status :deleted)
2980 (when (eq status :active)
2981 (deactivate-breakpoint breakpoint))
2982 (setf (breakpoint-status breakpoint) :deleted)
2983 (let ((other (breakpoint-unknown-return-partner breakpoint)))
2985 (setf (breakpoint-status other) :deleted)))
2986 (when (eq (breakpoint-kind breakpoint) :fun-end)
2987 (let* ((starter (breakpoint-start-helper breakpoint))
2988 (breakpoints (delete breakpoint
2989 (the list (breakpoint-info starter)))))
2990 (setf (breakpoint-info starter) breakpoints)
2992 (delete-breakpoint starter)
2993 (setf (compiled-debug-fun-end-starter
2994 (breakpoint-what breakpoint))
2998 ;;;; C call out stubs
3000 ;;; This actually installs the break instruction in the component. It
3001 ;;; returns the overwritten bits. You must call this in a context in
3002 ;;; which GC is disabled, so that Lisp doesn't move objects around
3003 ;;; that C is pointing to.
3004 (sb!alien:define-alien-routine "breakpoint_install" sb!alien:unsigned-int
3005 (code-obj sb!alien:unsigned-long)
3006 (pc-offset sb!alien:int))
3008 ;;; This removes the break instruction and replaces the original
3009 ;;; instruction. You must call this in a context in which GC is disabled
3010 ;;; so Lisp doesn't move objects around that C is pointing to.
3011 (sb!alien:define-alien-routine "breakpoint_remove" sb!alien:void
3012 (code-obj sb!alien:unsigned-long)
3013 (pc-offset sb!alien:int)
3014 (old-inst sb!alien:unsigned-int))
3016 (sb!alien:define-alien-routine "breakpoint_do_displaced_inst" sb!alien:void
3017 (scp (* os-context-t))
3018 (orig-inst sb!alien:unsigned-int))
3020 ;;;; breakpoint handlers (layer between C and exported interface)
3022 ;;; This maps components to a mapping of offsets to BREAKPOINT-DATAs.
3023 (defvar *component-breakpoint-offsets* (make-hash-table :test 'eq :synchronized t))
3025 ;;; This returns the BREAKPOINT-DATA object associated with component cross
3026 ;;; offset. If none exists, this makes one, installs it, and returns it.
3027 (defun breakpoint-data (component offset &optional (create t))
3028 (flet ((install-breakpoint-data ()
3030 (let ((data (make-breakpoint-data component offset)))
3031 (push (cons offset data)
3032 (gethash component *component-breakpoint-offsets*))
3034 (let ((offsets (gethash component *component-breakpoint-offsets*)))
3036 (let ((data (assoc offset offsets)))
3039 (install-breakpoint-data)))
3040 (install-breakpoint-data)))))
3042 ;;; We use this when there are no longer any active breakpoints
3043 ;;; corresponding to DATA.
3044 (defun delete-breakpoint-data (data)
3045 ;; Again, this looks brittle. Is there no danger of being interrupted
3047 (let* ((component (breakpoint-data-component data))
3048 (offsets (delete (breakpoint-data-offset data)
3049 (gethash component *component-breakpoint-offsets*)
3052 (setf (gethash component *component-breakpoint-offsets*) offsets)
3053 (remhash component *component-breakpoint-offsets*)))
3056 ;;; The C handler for interrupts calls this when it has a
3057 ;;; debugging-tool break instruction. This does *not* handle all
3058 ;;; breaks; for example, it does not handle breaks for internal
3060 (defun handle-breakpoint (offset component signal-context)
3061 (let ((data (breakpoint-data component offset nil)))
3063 (error "unknown breakpoint in ~S at offset ~S"
3064 (debug-fun-name (debug-fun-from-pc component offset))
3066 (let ((breakpoints (breakpoint-data-breakpoints data)))
3067 (if (or (null breakpoints)
3068 (eq (breakpoint-kind (car breakpoints)) :fun-end))
3069 (handle-fun-end-breakpoint-aux breakpoints data signal-context)
3070 (handle-breakpoint-aux breakpoints data
3071 offset component signal-context)))))
3073 ;;; This holds breakpoint-datas while invoking the breakpoint hooks
3074 ;;; associated with that particular component and location. While they
3075 ;;; are executing, if we hit the location again, we ignore the
3076 ;;; breakpoint to avoid infinite recursion. fun-end breakpoints
3077 ;;; must work differently since the breakpoint-data is unique for each
3079 (defvar *executing-breakpoint-hooks* nil)
3081 ;;; This handles code-location and DEBUG-FUN :FUN-START
3083 (defun handle-breakpoint-aux (breakpoints data offset component signal-context)
3085 (bug "breakpoint that nobody wants"))
3086 (unless (member data *executing-breakpoint-hooks*)
3087 (let ((*executing-breakpoint-hooks* (cons data
3088 *executing-breakpoint-hooks*)))
3089 (invoke-breakpoint-hooks breakpoints signal-context)))
3090 ;; At this point breakpoints may not hold the same list as
3091 ;; BREAKPOINT-DATA-BREAKPOINTS since invoking hooks may have allowed
3092 ;; a breakpoint deactivation. In fact, if all breakpoints were
3093 ;; deactivated then data is invalid since it was deleted and so the
3094 ;; correct one must be looked up if it is to be used. If there are
3095 ;; no more breakpoints active at this location, then the normal
3096 ;; instruction has been put back, and we do not need to
3097 ;; DO-DISPLACED-INST.
3098 (setf data (breakpoint-data component offset nil))
3099 (when (and data (breakpoint-data-breakpoints data))
3100 ;; The breakpoint is still active, so we need to execute the
3101 ;; displaced instruction and leave the breakpoint instruction
3102 ;; behind. The best way to do this is different on each machine,
3103 ;; so we just leave it up to the C code.
3104 (breakpoint-do-displaced-inst signal-context
3105 (breakpoint-data-instruction data))
3106 ;; Some platforms have no usable sigreturn() call. If your
3107 ;; implementation of arch_do_displaced_inst() _does_ sigreturn(),
3108 ;; it's polite to warn here
3109 #!+(and sparc solaris)
3110 (error "BREAKPOINT-DO-DISPLACED-INST returned?")))
3112 (defun invoke-breakpoint-hooks (breakpoints signal-context)
3113 (let* ((frame (signal-context-frame signal-context)))
3114 (dolist (bpt breakpoints)
3115 (funcall (breakpoint-hook-fun bpt)
3117 ;; If this is an :UNKNOWN-RETURN-PARTNER, then pass the
3118 ;; hook function the original breakpoint, so that users
3119 ;; aren't forced to confront the fact that some
3120 ;; breakpoints really are two.
3121 (if (eq (breakpoint-kind bpt) :unknown-return-partner)
3122 (breakpoint-unknown-return-partner bpt)
3125 (defun signal-context-frame (signal-context)
3128 (declare (optimize (inhibit-warnings 3)))
3129 (sb!alien:sap-alien signal-context (* os-context-t))))
3130 (cfp (int-sap (sb!vm:context-register scp sb!vm::cfp-offset))))
3131 (compute-calling-frame cfp
3132 ;; KLUDGE: This argument is ignored on
3133 ;; x86oids in this scenario, but is
3134 ;; declared to be a SAP.
3135 #!+(or x86 x86-64) (sb!vm:context-pc scp)
3136 #!-(or x86 x86-64) nil
3139 (defun handle-fun-end-breakpoint (offset component context)
3140 (let ((data (breakpoint-data component offset nil)))
3142 (error "unknown breakpoint in ~S at offset ~S"
3143 (debug-fun-name (debug-fun-from-pc component offset))
3145 (let ((breakpoints (breakpoint-data-breakpoints data)))
3147 (aver (eq (breakpoint-kind (car breakpoints)) :fun-end))
3148 (handle-fun-end-breakpoint-aux breakpoints data context)))))
3150 ;;; Either HANDLE-BREAKPOINT calls this for :FUN-END breakpoints
3151 ;;; [old C code] or HANDLE-FUN-END-BREAKPOINT calls this directly
3153 (defun handle-fun-end-breakpoint-aux (breakpoints data signal-context)
3154 ;; FIXME: This looks brittle: what if we are interrupted somewhere
3155 ;; here? ...or do we have interrupts disabled here?
3156 (delete-breakpoint-data data)
3159 (declare (optimize (inhibit-warnings 3)))
3160 (sb!alien:sap-alien signal-context (* os-context-t))))
3161 (frame (signal-context-frame signal-context))
3162 (component (breakpoint-data-component data))
3163 (cookie (gethash component *fun-end-cookies*)))
3164 (remhash component *fun-end-cookies*)
3165 (dolist (bpt breakpoints)
3166 (funcall (breakpoint-hook-fun bpt)
3168 (get-fun-end-breakpoint-values scp)
3171 (defun get-fun-end-breakpoint-values (scp)
3172 (let ((ocfp (int-sap (sb!vm:context-register
3174 #!-(or x86 x86-64) sb!vm::ocfp-offset
3175 #!+(or x86 x86-64) sb!vm::ebx-offset)))
3176 (nargs (make-lisp-obj
3177 (sb!vm:context-register scp sb!vm::nargs-offset)))
3178 (reg-arg-offsets '#.sb!vm::*register-arg-offsets*)
3181 (dotimes (arg-num nargs)
3182 (push (if reg-arg-offsets
3184 (sb!vm:context-register scp (pop reg-arg-offsets)))
3185 (stack-ref ocfp arg-num))
3187 (nreverse results)))
3189 ;;;; MAKE-BOGUS-LRA (used for :FUN-END breakpoints)
3191 (defconstant bogus-lra-constants
3192 #!-(or x86 x86-64) 2 #!+(or x86 x86-64) 3)
3193 (defconstant known-return-p-slot
3194 (+ sb!vm:code-constants-offset #!-(or x86 x86-64) 1 #!+(or x86 x86-64) 2))
3196 ;;; Make a bogus LRA object that signals a breakpoint trap when
3197 ;;; returned to. If the breakpoint trap handler returns, REAL-LRA is
3198 ;;; returned to. Three values are returned: the bogus LRA object, the
3199 ;;; code component it is part of, and the PC offset for the trap
3201 (defun make-bogus-lra (real-lra &optional known-return-p)
3203 ;; These are really code labels, not variables: but this way we get
3205 (let* ((src-start (foreign-symbol-sap "fun_end_breakpoint_guts"))
3206 (src-end (foreign-symbol-sap "fun_end_breakpoint_end"))
3207 (trap-loc (foreign-symbol-sap "fun_end_breakpoint_trap"))
3208 (length (sap- src-end src-start))
3210 (sb!c:allocate-code-object (1+ bogus-lra-constants) length))
3211 (dst-start (code-instructions code-object)))
3212 (declare (type system-area-pointer
3213 src-start src-end dst-start trap-loc)
3214 (type index length))
3215 (setf (%code-debug-info code-object) :bogus-lra)
3216 (setf (code-header-ref code-object sb!vm:code-trace-table-offset-slot)
3219 (setf (code-header-ref code-object real-lra-slot) real-lra)
3221 (multiple-value-bind (offset code) (compute-lra-data-from-pc real-lra)
3222 (setf (code-header-ref code-object real-lra-slot) code)
3223 (setf (code-header-ref code-object (1+ real-lra-slot)) offset))
3224 (setf (code-header-ref code-object known-return-p-slot)
3226 (system-area-ub8-copy src-start 0 dst-start 0 length)
3227 (sb!vm:sanctify-for-execution code-object)
3229 (values dst-start code-object (sap- trap-loc src-start))
3231 (let ((new-lra (make-lisp-obj (+ (sap-int dst-start)
3232 sb!vm:other-pointer-lowtag))))
3233 ;; We used to set the header value of the LRA here to the
3234 ;; offset from the enclosing component to the LRA header, but
3235 ;; MAKE-LISP-OBJ actually checks the value before we get a
3236 ;; chance to set it, so it's now done in arch-assem.S.
3237 (values new-lra code-object (sap- trap-loc src-start))))))
3241 ;;; This appears here because it cannot go with the DEBUG-FUN
3242 ;;; interface since DO-DEBUG-BLOCK-LOCATIONS isn't defined until after
3243 ;;; the DEBUG-FUN routines.
3245 ;;; Return a code-location before the body of a function and after all
3246 ;;; the arguments are in place; or if that location can't be
3247 ;;; determined due to a lack of debug information, return NIL.
3248 (defun debug-fun-start-location (debug-fun)
3249 (etypecase debug-fun
3251 (code-location-from-pc debug-fun
3252 (sb!c::compiled-debug-fun-start-pc
3253 (compiled-debug-fun-compiler-debug-fun
3256 ;; (There used to be more cases back before sbcl-0.7.0, when
3257 ;; we did special tricks to debug the IR1 interpreter.)
3261 ;;;; Single-stepping
3263 ;;; The single-stepper works by inserting conditional trap instructions
3264 ;;; into the generated code (see src/compiler/*/call.lisp), currently:
3266 ;;; 1) Before the code generated for a function call that was
3267 ;;; translated to a VOP
3268 ;;; 2) Just before the call instruction for a full call
3270 ;;; In both cases, the trap will only be executed if stepping has been
3271 ;;; enabled, in which case it'll ultimately be handled by
3272 ;;; HANDLE-SINGLE-STEP-TRAP, which will either signal a stepping condition,
3273 ;;; or replace the function that's about to be called with a wrapper
3274 ;;; which will signal the condition.
3276 (defun handle-single-step-trap (kind callee-register-offset)
3277 (let ((context (nth-interrupt-context (1- *free-interrupt-context-index*))))
3278 ;; The following calls must get tail-call eliminated for
3279 ;; *STEP-FRAME* to get set correctly on non-x86.
3280 (if (= kind single-step-before-trap)
3281 (handle-single-step-before-trap context)
3282 (handle-single-step-around-trap context callee-register-offset))))
3284 (defvar *step-frame* nil)
3286 (defun handle-single-step-before-trap (context)
3287 (let ((step-info (single-step-info-from-context context)))
3288 ;; If there was not enough debug information available, there's no
3289 ;; sense in signaling the condition.
3293 (signal-context-frame (sb!alien::alien-sap context))
3295 ;; KLUDGE: Use the first non-foreign frame as the
3296 ;; *STACK-TOP-HINT*. Getting the frame from the signal
3297 ;; context as on x86 would be cleaner, but
3298 ;; SIGNAL-CONTEXT-FRAME doesn't seem seem to work at all
3300 (loop with frame = (frame-down (top-frame))
3302 for dfun = (frame-debug-fun frame)
3303 do (when (typep dfun 'compiled-debug-fun)
3305 do (setf frame (frame-down frame)))))
3306 (sb!impl::step-form step-info
3307 ;; We could theoretically store information in
3308 ;; the debug-info about to determine the
3309 ;; arguments here, but for now let's just pass
3313 ;;; This function will replace the fdefn / function that was in the
3314 ;;; register at CALLEE-REGISTER-OFFSET with a wrapper function. To
3315 ;;; ensure that the full call will use the wrapper instead of the
3316 ;;; original, conditional trap must be emitted before the fdefn /
3317 ;;; function is converted into a raw address.
3318 (defun handle-single-step-around-trap (context callee-register-offset)
3319 ;; Fetch the function / fdefn we're about to call from the
3320 ;; appropriate register.
3321 (let* ((callee (make-lisp-obj
3322 (context-register context callee-register-offset)))
3323 (step-info (single-step-info-from-context context)))
3324 ;; If there was not enough debug information available, there's no
3325 ;; sense in signaling the condition.
3327 (return-from handle-single-step-around-trap))
3328 (let* ((fun (lambda (&rest args)
3330 (apply (typecase callee
3331 (fdefn (fdefn-fun callee))
3334 ;; Signal a step condition
3336 (let ((*step-frame* (frame-down (top-frame))))
3337 (sb!impl::step-form step-info args))))
3338 ;; And proceed based on its return value.
3340 ;; STEP-INTO was selected. Use *STEP-OUT* to
3341 ;; let the stepper know that selecting the
3342 ;; STEP-OUT restart is valid inside this
3343 (let ((sb!impl::*step-out* :maybe))
3344 ;; Pass the return values of the call to
3345 ;; STEP-VALUES, which will signal a
3346 ;; condition with them in the VALUES slot.
3348 (multiple-value-call #'sb!impl::step-values
3351 ;; If the user selected the STEP-OUT
3352 ;; restart during the call, resume
3354 (when (eq sb!impl::*step-out* t)
3355 (sb!impl::enable-stepping))))
3356 ;; STEP-NEXT / CONTINUE / OUT selected:
3357 ;; Disable the stepper for the duration of
3359 (sb!impl::with-stepping-disabled
3361 (new-callee (etypecase callee
3363 (let ((fdefn (make-fdefn (gensym))))
3364 (setf (fdefn-fun fdefn) fun)
3367 ;; And then store the wrapper in the same place.
3368 (setf (context-register context callee-register-offset)
3369 (get-lisp-obj-address new-callee)))))
3371 ;;; Given a signal context, fetch the step-info that's been stored in
3372 ;;; the debug info at the trap point.
3373 (defun single-step-info-from-context (context)
3374 (multiple-value-bind (pc-offset code)
3375 (compute-lra-data-from-pc (context-pc context))
3376 (let* ((debug-fun (debug-fun-from-pc code pc-offset))
3377 (location (code-location-from-pc debug-fun
3382 (fill-in-code-location location)
3383 (code-location-debug-source location)
3384 (compiled-code-location-step-info location))
3388 ;;; Return the frame that triggered a single-step condition. Used to
3389 ;;; provide a *STACK-TOP-HINT*.
3390 (defun find-stepped-frame ()