1 ;;;; the implementation of the programmer's interface to writing
4 ;;;; This software is part of the SBCL system. See the README file for
7 ;;;; This software is derived from the CMU CL system, which was
8 ;;;; written at Carnegie Mellon University and released into the
9 ;;;; public domain. The software is in the public domain and is
10 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
11 ;;;; files for more information.
15 ;;; FIXME: There are an awful lot of package prefixes in this code.
16 ;;; Couldn't we have SB-DI use the SB-C and SB-VM packages?
20 ;;;; The interface to building debugging tools signals conditions that
21 ;;;; prevent it from adhering to its contract. These are
22 ;;;; serious-conditions because the program using the interface must
23 ;;;; handle them before it can correctly continue execution. These
24 ;;;; debugging conditions are not errors since it is no fault of the
25 ;;;; programmers that the conditions occur. The interface does not
26 ;;;; provide for programs to detect these situations other than
27 ;;;; calling a routine that detects them and signals a condition. For
28 ;;;; example, programmers call A which may fail to return successfully
29 ;;;; due to a lack of debug information, and there is no B the they
30 ;;;; could have called to realize A would fail. It is not an error to
31 ;;;; have called A, but it is an error for the program to then ignore
32 ;;;; the signal generated by A since it cannot continue without A's
33 ;;;; correctly returning a value or performing some operation.
35 ;;;; Use DEBUG-SIGNAL to signal these conditions.
37 (define-condition debug-condition (serious-condition)
41 "All DEBUG-CONDITIONs inherit from this type. These are serious conditions
42 that must be handled, but they are not programmer errors."))
44 (define-condition no-debug-info (debug-condition)
45 ((code-component :reader no-debug-info-code-component
46 :initarg :code-component))
48 (:documentation "There is no usable debugging information available.")
49 (:report (lambda (condition stream)
52 "no debug information available for ~S~%"
53 (no-debug-info-code-component condition)))))
55 (define-condition no-debug-fun-returns (debug-condition)
56 ((debug-fun :reader no-debug-fun-returns-debug-fun
60 "The system could not return values from a frame with DEBUG-FUN since
61 it lacked information about returning values.")
62 (:report (lambda (condition stream)
63 (let ((fun (debug-fun-fun
64 (no-debug-fun-returns-debug-fun condition))))
66 "~&Cannot return values from ~:[frame~;~:*~S~] since ~
67 the debug information lacks details about returning ~
71 (define-condition no-debug-blocks (debug-condition)
72 ((debug-fun :reader no-debug-blocks-debug-fun
75 (:documentation "The debug-fun has no debug-block information.")
76 (:report (lambda (condition stream)
77 (format stream "~&~S has no debug-block information."
78 (no-debug-blocks-debug-fun condition)))))
80 (define-condition no-debug-vars (debug-condition)
81 ((debug-fun :reader no-debug-vars-debug-fun
84 (:documentation "The DEBUG-FUN has no DEBUG-VAR information.")
85 (:report (lambda (condition stream)
86 (format stream "~&~S has no debug variable information."
87 (no-debug-vars-debug-fun condition)))))
89 (define-condition lambda-list-unavailable (debug-condition)
90 ((debug-fun :reader lambda-list-unavailable-debug-fun
94 "The DEBUG-FUN has no lambda list since argument DEBUG-VARs are
96 (:report (lambda (condition stream)
97 (format stream "~&~S has no lambda-list information available."
98 (lambda-list-unavailable-debug-fun condition)))))
100 (define-condition invalid-value (debug-condition)
101 ((debug-var :reader invalid-value-debug-var :initarg :debug-var)
102 (frame :reader invalid-value-frame :initarg :frame))
103 (:report (lambda (condition stream)
104 (format stream "~&~S has :invalid or :unknown value in ~S."
105 (invalid-value-debug-var condition)
106 (invalid-value-frame condition)))))
108 (define-condition ambiguous-var-name (debug-condition)
109 ((name :reader ambiguous-var-name-name :initarg :name)
110 (frame :reader ambiguous-var-name-frame :initarg :frame))
111 (:report (lambda (condition stream)
112 (format stream "~&~S names more than one valid variable in ~S."
113 (ambiguous-var-name-name condition)
114 (ambiguous-var-name-frame condition)))))
116 ;;;; errors and DEBUG-SIGNAL
118 ;;; The debug-internals code tries to signal all programmer errors as
119 ;;; subtypes of DEBUG-ERROR. There are calls to ERROR signalling
120 ;;; SIMPLE-ERRORs, but these dummy checks in the code and shouldn't
123 ;;; While under development, this code also signals errors in code
124 ;;; branches that remain unimplemented.
126 (define-condition debug-error (error) ()
129 "All programmer errors from using the interface for building debugging
130 tools inherit from this type."))
132 (define-condition unhandled-debug-condition (debug-error)
133 ((condition :reader unhandled-debug-condition-condition :initarg :condition))
134 (:report (lambda (condition stream)
135 (format stream "~&unhandled DEBUG-CONDITION:~%~A"
136 (unhandled-debug-condition-condition condition)))))
138 (define-condition unknown-code-location (debug-error)
139 ((code-location :reader unknown-code-location-code-location
140 :initarg :code-location))
141 (:report (lambda (condition stream)
142 (format stream "~&invalid use of an unknown code-location: ~S"
143 (unknown-code-location-code-location condition)))))
145 (define-condition unknown-debug-var (debug-error)
146 ((debug-var :reader unknown-debug-var-debug-var :initarg :debug-var)
147 (debug-fun :reader unknown-debug-var-debug-fun
148 :initarg :debug-fun))
149 (:report (lambda (condition stream)
150 (format stream "~&~S is not in ~S."
151 (unknown-debug-var-debug-var condition)
152 (unknown-debug-var-debug-fun condition)))))
154 (define-condition invalid-control-stack-pointer (debug-error)
156 (:report (lambda (condition stream)
157 (declare (ignore condition))
159 (write-string "invalid control stack pointer" stream))))
161 (define-condition frame-fun-mismatch (debug-error)
162 ((code-location :reader frame-fun-mismatch-code-location
163 :initarg :code-location)
164 (frame :reader frame-fun-mismatch-frame :initarg :frame)
165 (form :reader frame-fun-mismatch-form :initarg :form))
166 (:report (lambda (condition stream)
169 "~&Form was preprocessed for ~S,~% but called on ~S:~% ~S"
170 (frame-fun-mismatch-code-location condition)
171 (frame-fun-mismatch-frame condition)
172 (frame-fun-mismatch-form condition)))))
174 ;;; This signals debug-conditions. If they go unhandled, then signal
175 ;;; an UNHANDLED-DEBUG-CONDITION error.
177 ;;; ??? Get SIGNAL in the right package!
178 (defmacro debug-signal (datum &rest arguments)
179 `(let ((condition (make-condition ,datum ,@arguments)))
181 (error 'unhandled-debug-condition :condition condition)))
185 ;;;; Most of these structures model information stored in internal
186 ;;;; data structures created by the compiler. Whenever comments
187 ;;;; preface an object or type with "compiler", they refer to the
188 ;;;; internal compiler thing, not to the object or type with the same
189 ;;;; name in the "SB-DI" package.
193 ;;; These exist for caching data stored in packed binary form in
194 ;;; compiler DEBUG-FUNs.
195 (defstruct (debug-var (:constructor nil)
197 ;; the name of the variable
198 (symbol (missing-arg) :type symbol)
199 ;; a unique integer identification relative to other variables with the same
202 ;; Does the variable always have a valid value?
203 (alive-p nil :type boolean))
204 (def!method print-object ((debug-var debug-var) stream)
205 (print-unreadable-object (debug-var stream :type t :identity t)
208 (debug-var-symbol debug-var)
209 (debug-var-id debug-var))))
212 (setf (fdocumentation 'debug-var-id 'function)
213 "Return the integer that makes DEBUG-VAR's name and package unique
214 with respect to other DEBUG-VARs in the same function.")
216 (defstruct (compiled-debug-var
218 (:constructor make-compiled-debug-var
219 (symbol id alive-p sc-offset save-sc-offset))
221 ;; storage class and offset (unexported)
222 (sc-offset nil :type sb!c:sc-offset)
223 ;; storage class and offset when saved somewhere
224 (save-sc-offset nil :type (or sb!c:sc-offset null)))
228 ;;; These represent call frames on the stack.
229 (defstruct (frame (:constructor nil)
231 ;; the next frame up, or NIL when top frame
232 (up nil :type (or frame null))
233 ;; the previous frame down, or NIL when the bottom frame. Before
234 ;; computing the next frame down, this slot holds the frame pointer
235 ;; to the control stack for the given frame. This lets us get the
236 ;; next frame down and the return-pc for that frame.
237 (%down :unparsed :type (or frame (member nil :unparsed)))
238 ;; the DEBUG-FUN for the function whose call this frame represents
239 (debug-fun nil :type debug-fun)
240 ;; the CODE-LOCATION where the frame's DEBUG-FUN will continue
241 ;; running when program execution returns to this frame. If someone
242 ;; interrupted this frame, the result could be an unknown
244 (code-location nil :type code-location)
245 ;; an a-list of catch-tags to code-locations
246 (%catches :unparsed :type (or list (member :unparsed)))
247 ;; pointer to frame on control stack (unexported)
249 ;; This is the frame's number for prompt printing. Top is zero.
250 (number 0 :type index))
252 (defstruct (compiled-frame
254 (:constructor make-compiled-frame
255 (pointer up debug-fun code-location number
258 ;; This indicates whether someone interrupted the frame.
259 ;; (unexported). If escaped, this is a pointer to the state that was
260 ;; saved when we were interrupted, an os_context_t, i.e. the third
261 ;; argument to an SA_SIGACTION-style signal handler.
263 (def!method print-object ((obj compiled-frame) str)
264 (print-unreadable-object (obj str :type t)
266 "~S~:[~;, interrupted~]"
267 (debug-fun-name (frame-debug-fun obj))
268 (compiled-frame-escaped obj))))
272 ;;; These exist for caching data stored in packed binary form in
273 ;;; compiler DEBUG-FUNs. *COMPILED-DEBUG-FUNS* maps a SB!C::DEBUG-FUN
274 ;;; to a DEBUG-FUN. There should only be one DEBUG-FUN in existence
275 ;;; for any function; that is, all CODE-LOCATIONs and other objects
276 ;;; that reference DEBUG-FUNs point to unique objects. This is
277 ;;; due to the overhead in cached information.
278 (defstruct (debug-fun (:constructor nil)
280 ;; some representation of the function arguments. See
281 ;; DEBUG-FUN-LAMBDA-LIST.
282 ;; NOTE: must parse vars before parsing arg list stuff.
283 (%lambda-list :unparsed)
284 ;; cached DEBUG-VARS information (unexported).
285 ;; These are sorted by their name.
286 (%debug-vars :unparsed :type (or simple-vector null (member :unparsed)))
287 ;; cached debug-block information. This is NIL when we have tried to
288 ;; parse the packed binary info, but none is available.
289 (blocks :unparsed :type (or simple-vector null (member :unparsed)))
290 ;; the actual function if available
291 (%function :unparsed :type (or null function (member :unparsed))))
292 (def!method print-object ((obj debug-fun) stream)
293 (print-unreadable-object (obj stream :type t)
294 (prin1 (debug-fun-name obj) stream)))
296 (defstruct (compiled-debug-fun
298 (:constructor %make-compiled-debug-fun
299 (compiler-debug-fun component))
301 ;; compiler's dumped DEBUG-FUN information (unexported)
302 (compiler-debug-fun nil :type sb!c::compiled-debug-fun)
303 ;; code object (unexported).
305 ;; the :FUN-START breakpoint (if any) used to facilitate
306 ;; function end breakpoints
307 (end-starter nil :type (or null breakpoint)))
309 ;;; This maps SB!C::COMPILED-DEBUG-FUNs to
310 ;;; COMPILED-DEBUG-FUNs, so we can get at cached stuff and not
311 ;;; duplicate COMPILED-DEBUG-FUN structures.
312 (defvar *compiled-debug-funs* (make-hash-table :test 'eq))
314 ;;; Make a COMPILED-DEBUG-FUN for a SB!C::COMPILER-DEBUG-FUN
315 ;;; and its component. This maps the latter to the former in
316 ;;; *COMPILED-DEBUG-FUNS*. If there already is a
317 ;;; COMPILED-DEBUG-FUN, then this returns it from
318 ;;; *COMPILED-DEBUG-FUNS*.
319 (defun make-compiled-debug-fun (compiler-debug-fun component)
320 (or (gethash compiler-debug-fun *compiled-debug-funs*)
321 (setf (gethash compiler-debug-fun *compiled-debug-funs*)
322 (%make-compiled-debug-fun compiler-debug-fun component))))
324 (defstruct (bogus-debug-fun
326 (:constructor make-bogus-debug-fun
335 (defvar *ir1-lambda-debug-fun* (make-hash-table :test 'eq))
339 ;;; These exist for caching data stored in packed binary form in compiler
341 (defstruct (debug-block (:constructor nil)
343 ;; Code-locations where execution continues after this block.
344 (successors nil :type list)
345 ;; This indicates whether the block is a special glob of code shared
346 ;; by various functions and tucked away elsewhere in a component.
347 ;; This kind of block has no start code-location. This slot is in
348 ;; all debug-blocks since it is an exported interface.
349 (elsewhere-p nil :type boolean))
350 (def!method print-object ((obj debug-block) str)
351 (print-unreadable-object (obj str :type t)
352 (prin1 (debug-block-fun-name obj) str)))
355 (setf (fdocumentation 'debug-block-successors 'function)
356 "Return the list of possible code-locations where execution may continue
357 when the basic-block represented by debug-block completes its execution.")
360 (setf (fdocumentation 'debug-block-elsewhere-p 'function)
361 "Return whether debug-block represents elsewhere code.")
363 (defstruct (compiled-debug-block (:include debug-block)
365 make-compiled-debug-block
366 (code-locations successors elsewhere-p))
368 ;; code-location information for the block
369 (code-locations nil :type simple-vector))
371 (defvar *ir1-block-debug-block* (make-hash-table :test 'eq))
375 ;;; This is an internal structure that manages information about a
376 ;;; breakpoint locations. See *COMPONENT-BREAKPOINT-OFFSETS*.
377 (defstruct (breakpoint-data (:constructor make-breakpoint-data
380 ;; This is the component in which the breakpoint lies.
382 ;; This is the byte offset into the component.
383 (offset nil :type index)
384 ;; The original instruction replaced by the breakpoint.
385 (instruction nil :type (or null (unsigned-byte 32)))
386 ;; A list of user breakpoints at this location.
387 (breakpoints nil :type list))
388 (def!method print-object ((obj breakpoint-data) str)
389 (print-unreadable-object (obj str :type t)
390 (format str "~S at ~S"
392 (debug-fun-from-pc (breakpoint-data-component obj)
393 (breakpoint-data-offset obj)))
394 (breakpoint-data-offset obj))))
396 (defstruct (breakpoint (:constructor %make-breakpoint
397 (hook-fun what kind %info))
399 ;; This is the function invoked when execution encounters the
400 ;; breakpoint. It takes a frame, the breakpoint, and optionally a
401 ;; list of values. Values are supplied for :FUN-END breakpoints as
402 ;; values to return for the function containing the breakpoint.
403 ;; :FUN-END breakpoint hook functions also take a cookie argument.
404 ;; See the COOKIE-FUN slot.
405 (hook-fun (required-arg) :type function)
406 ;; CODE-LOCATION or DEBUG-FUN
407 (what nil :type (or code-location debug-fun))
408 ;; :CODE-LOCATION, :FUN-START, or :FUN-END for that kind
409 ;; of breakpoint. :UNKNOWN-RETURN-PARTNER if this is the partner of
410 ;; a :code-location breakpoint at an :UNKNOWN-RETURN code-location.
411 (kind nil :type (member :code-location :fun-start :fun-end
412 :unknown-return-partner))
413 ;; Status helps the user and the implementation.
414 (status :inactive :type (member :active :inactive :deleted))
415 ;; This is a backpointer to a breakpoint-data.
416 (internal-data nil :type (or null breakpoint-data))
417 ;; With code-locations whose type is :UNKNOWN-RETURN, there are
418 ;; really two breakpoints: one at the multiple-value entry point,
419 ;; and one at the single-value entry point. This slot holds the
420 ;; breakpoint for the other one, or NIL if this isn't at an
421 ;; :UNKNOWN-RETURN code location.
422 (unknown-return-partner nil :type (or null breakpoint))
423 ;; :FUN-END breakpoints use a breakpoint at the :FUN-START
424 ;; to establish the end breakpoint upon function entry. We do this
425 ;; by frobbing the LRA to jump to a special piece of code that
426 ;; breaks and provides the return values for the returnee. This slot
427 ;; points to the start breakpoint, so we can activate, deactivate,
429 (start-helper nil :type (or null breakpoint))
430 ;; This is a hook users supply to get a dynamically unique cookie
431 ;; for identifying :FUN-END breakpoint executions. That is, if
432 ;; there is one :FUN-END breakpoint, but there may be multiple
433 ;; pending calls of its function on the stack. This function takes
434 ;; the cookie, and the hook function takes the cookie too.
435 (cookie-fun nil :type (or null function))
436 ;; This slot users can set with whatever information they find useful.
438 (def!method print-object ((obj breakpoint) str)
439 (let ((what (breakpoint-what obj)))
440 (print-unreadable-object (obj str :type t)
445 (debug-fun (debug-fun-name what)))
448 (debug-fun (breakpoint-kind obj)))))))
452 (defstruct (code-location (:constructor nil)
454 ;; the DEBUG-FUN containing this CODE-LOCATION
455 (debug-fun nil :type debug-fun)
456 ;; This is initially :UNSURE. Upon first trying to access an
457 ;; :UNPARSED slot, if the data is unavailable, then this becomes T,
458 ;; and the code-location is unknown. If the data is available, this
459 ;; becomes NIL, a known location. We can't use a separate type
460 ;; code-location for this since we must return code-locations before
461 ;; we can tell whether they're known or unknown. For example, when
462 ;; parsing the stack, we don't want to unpack all the variables and
463 ;; blocks just to make frames.
464 (%unknown-p :unsure :type (member t nil :unsure))
465 ;; the DEBUG-BLOCK containing CODE-LOCATION. XXX Possibly toss this
466 ;; out and just find it in the blocks cache in DEBUG-FUN.
467 (%debug-block :unparsed :type (or debug-block (member :unparsed)))
468 ;; This is the number of forms processed by the compiler or loader
469 ;; before the top level form containing this code-location.
470 (%tlf-offset :unparsed :type (or index (member :unparsed)))
471 ;; This is the depth-first number of the node that begins
472 ;; code-location within its top level form.
473 (%form-number :unparsed :type (or index (member :unparsed))))
474 (def!method print-object ((obj code-location) str)
475 (print-unreadable-object (obj str :type t)
476 (prin1 (debug-fun-name (code-location-debug-fun obj))
479 (defstruct (compiled-code-location
480 (:include code-location)
481 (:constructor make-known-code-location
482 (pc debug-fun %tlf-offset %form-number
483 %live-set kind &aux (%unknown-p nil)))
484 (:constructor make-compiled-code-location (pc debug-fun))
486 ;; an index into DEBUG-FUN's component slot
488 ;; a bit-vector indexed by a variable's position in
489 ;; DEBUG-FUN-DEBUG-VARS indicating whether the variable has a
490 ;; valid value at this code-location. (unexported).
491 (%live-set :unparsed :type (or simple-bit-vector (member :unparsed)))
492 ;; (unexported) To see SB!C::LOCATION-KIND, do
493 ;; (SB!KERNEL:TYPE-EXPAND 'SB!C::LOCATION-KIND).
494 (kind :unparsed :type (or (member :unparsed) sb!c::location-kind)))
498 ;;; Return the number of top level forms processed by the compiler
499 ;;; before compiling this source. If this source is uncompiled, this
500 ;;; is zero. This may be zero even if the source is compiled since the
501 ;;; first form in the first file compiled in one compilation, for
502 ;;; example, must have a root number of zero -- the compiler saw no
503 ;;; other top level forms before it.
504 (defun debug-source-root-number (debug-source)
505 (sb!c::debug-source-source-root debug-source))
509 ;;; This is used in FIND-ESCAPED-FRAME and with the bogus components
510 ;;; and LRAs used for :FUN-END breakpoints. When a component's
511 ;;; debug-info slot is :BOGUS-LRA, then the REAL-LRA-SLOT contains the
512 ;;; real component to continue executing, as opposed to the bogus
513 ;;; component which appeared in some frame's LRA location.
514 (defconstant real-lra-slot sb!vm:code-constants-offset)
516 ;;; These are magically converted by the compiler.
517 (defun current-sp () (current-sp))
518 (defun current-fp () (current-fp))
519 (defun stack-ref (s n) (stack-ref s n))
520 (defun %set-stack-ref (s n value) (%set-stack-ref s n value))
521 (defun fun-code-header (fun) (fun-code-header fun))
522 (defun lra-code-header (lra) (lra-code-header lra))
523 (defun make-lisp-obj (value) (make-lisp-obj value))
524 (defun get-lisp-obj-address (thing) (get-lisp-obj-address thing))
525 (defun fun-word-offset (fun) (fun-word-offset fun))
527 #!-sb-fluid (declaim (inline control-stack-pointer-valid-p))
528 (defun control-stack-pointer-valid-p (x)
529 (declare (type system-area-pointer x))
530 (let* (#!-stack-grows-downward-not-upward
532 (descriptor-sap *control-stack-start*))
533 #!+stack-grows-downward-not-upward
535 (descriptor-sap *control-stack-end*)))
536 #!-stack-grows-downward-not-upward
537 (and (sap< x (current-sp))
538 (sap<= control-stack-start x)
539 (zerop (logand (sap-int x) #b11)))
540 #!+stack-grows-downward-not-upward
541 (and (sap>= x (current-sp))
542 (sap> control-stack-end x)
543 (zerop (logand (sap-int x) #b11)))))
546 (sb!alien:define-alien-routine component-ptr-from-pc (system-area-pointer)
547 (pc system-area-pointer))
550 (defun component-from-component-ptr (component-ptr)
551 (declare (type system-area-pointer component-ptr))
552 (make-lisp-obj (logior (sap-int component-ptr)
553 sb!vm:other-pointer-lowtag)))
560 (defun compute-lra-data-from-pc (pc)
561 (declare (type system-area-pointer pc))
562 (let ((component-ptr (component-ptr-from-pc pc)))
563 (unless (sap= component-ptr (int-sap #x0))
564 (let* ((code (component-from-component-ptr component-ptr))
565 (code-header-len (* (get-header-data code) sb!vm:n-word-bytes))
566 (pc-offset (- (sap-int pc)
567 (- (get-lisp-obj-address code)
568 sb!vm:other-pointer-lowtag)
570 ; (format t "c-lra-fpc ~A ~A ~A~%" pc code pc-offset)
571 (values pc-offset code)))))
573 (defconstant sb!vm::nargs-offset #.sb!vm::ecx-offset)
575 ;;; Check for a valid return address - it could be any valid C/Lisp
578 ;;; XXX Could be a little smarter.
579 #!-sb-fluid (declaim (inline ra-pointer-valid-p))
580 (defun ra-pointer-valid-p (ra)
581 (declare (type system-area-pointer ra))
583 ;; not the first page (which is unmapped)
585 ;; FIXME: Where is this documented? Is it really true of every CPU
586 ;; architecture? Is it even necessarily true in current SBCL?
587 (>= (sap-int ra) 4096)
588 ;; not a Lisp stack pointer
589 (not (control-stack-pointer-valid-p ra))))
591 ;;; Try to find a valid previous stack. This is complex on the x86 as
592 ;;; it can jump between C and Lisp frames. To help find a valid frame
593 ;;; it searches backwards.
595 ;;; XXX Should probably check whether it has reached the bottom of the
598 ;;; XXX Should handle interrupted frames, both Lisp and C. At present
599 ;;; it manages to find a fp trail, see linux hack below.
600 (defun x86-call-context (fp &key (depth 0))
601 (declare (type system-area-pointer fp)
603 ;;(format t "*CC ~S ~S~%" fp depth)
605 ((not (control-stack-pointer-valid-p fp))
606 #+nil (format t "debug invalid fp ~S~%" fp)
609 ;; Check the two possible frame pointers.
610 (let ((lisp-ocfp (sap-ref-sap fp (- (* (1+ ocfp-save-offset) 4))))
611 (lisp-ra (sap-ref-sap fp (- (* (1+ return-pc-save-offset)
613 (c-ocfp (sap-ref-sap fp (* 0 sb!vm:n-word-bytes)))
614 (c-ra (sap-ref-sap fp (* 1 sb!vm:n-word-bytes))))
615 (cond ((and (sap> lisp-ocfp fp) (control-stack-pointer-valid-p lisp-ocfp)
616 (ra-pointer-valid-p lisp-ra)
617 (sap> c-ocfp fp) (control-stack-pointer-valid-p c-ocfp)
618 (ra-pointer-valid-p c-ra))
620 "*C Both valid ~S ~S ~S ~S~%"
621 lisp-ocfp lisp-ra c-ocfp c-ra)
622 ;; Look forward another step to check their validity.
623 (let ((lisp-path-fp (x86-call-context lisp-ocfp
625 (c-path-fp (x86-call-context c-ocfp :depth (1+ depth))))
626 (cond ((and lisp-path-fp c-path-fp)
627 ;; Both still seem valid - choose the lisp frame.
628 #+nil (when (zerop depth)
630 "debug: both still valid ~S ~S ~S ~S~%"
631 lisp-ocfp lisp-ra c-ocfp c-ra))
633 (if (sap> lisp-ocfp c-ocfp)
634 (values lisp-ra lisp-ocfp)
635 (values c-ra c-ocfp))
637 (values lisp-ra lisp-ocfp))
639 ;; The lisp convention is looking good.
640 #+nil (format t "*C lisp-ocfp ~S ~S~%" lisp-ocfp lisp-ra)
641 (values lisp-ra lisp-ocfp))
643 ;; The C convention is looking good.
644 #+nil (format t "*C c-ocfp ~S ~S~%" c-ocfp c-ra)
645 (values c-ra c-ocfp))
647 ;; Neither seems right?
648 #+nil (format t "debug: no valid2 fp found ~S ~S~%"
651 ((and (sap> lisp-ocfp fp) (control-stack-pointer-valid-p lisp-ocfp)
652 (ra-pointer-valid-p lisp-ra))
653 ;; The lisp convention is looking good.
654 #+nil (format t "*C lisp-ocfp ~S ~S~%" lisp-ocfp lisp-ra)
655 (values lisp-ra lisp-ocfp))
656 ((and (sap> c-ocfp fp) (control-stack-pointer-valid-p c-ocfp)
657 #!-linux (ra-pointer-valid-p c-ra))
658 ;; The C convention is looking good.
659 #+nil (format t "*C c-ocfp ~S ~S~%" c-ocfp c-ra)
660 (values c-ra c-ocfp))
662 #+nil (format t "debug: no valid fp found ~S ~S~%"
668 ;;; Convert the descriptor into a SAP. The bits all stay the same, we just
669 ;;; change our notion of what we think they are.
670 #!-sb-fluid (declaim (inline descriptor-sap))
671 (defun descriptor-sap (x)
672 (int-sap (get-lisp-obj-address x)))
674 ;;; Return the top frame of the control stack as it was before calling
677 (/noshow0 "entering TOP-FRAME")
678 (multiple-value-bind (fp pc) (%caller-frame-and-pc)
679 (compute-calling-frame (descriptor-sap fp) pc nil)))
681 ;;; Flush all of the frames above FRAME, and renumber all the frames
683 (defun flush-frames-above (frame)
684 (setf (frame-up frame) nil)
685 (do ((number 0 (1+ number))
686 (frame frame (frame-%down frame)))
687 ((not (frame-p frame)))
688 (setf (frame-number frame) number)))
690 ;;; Return the frame immediately below FRAME on the stack; or when
691 ;;; FRAME is the bottom of the stack, return NIL.
692 (defun frame-down (frame)
693 (/noshow0 "entering FRAME-DOWN")
694 ;; We have to access the old-fp and return-pc out of frame and pass
695 ;; them to COMPUTE-CALLING-FRAME.
696 (let ((down (frame-%down frame)))
697 (if (eq down :unparsed)
698 (let ((debug-fun (frame-debug-fun frame)))
699 (/noshow0 "in DOWN :UNPARSED case")
700 (setf (frame-%down frame)
703 (let ((c-d-f (compiled-debug-fun-compiler-debug-fun
705 (compute-calling-frame
708 frame ocfp-save-offset
709 (sb!c::compiled-debug-fun-old-fp c-d-f)))
711 frame lra-save-offset
712 (sb!c::compiled-debug-fun-return-pc c-d-f))
715 (let ((fp (frame-pointer frame)))
716 (when (control-stack-pointer-valid-p fp)
718 (multiple-value-bind (ra ofp) (x86-call-context fp)
719 (and ra (compute-calling-frame ofp ra frame)))
721 (compute-calling-frame
723 (sap-ref-sap fp (* ocfp-save-offset
727 (sap-ref-32 fp (* ocfp-save-offset
728 sb!vm:n-word-bytes)))
730 (stack-ref fp lra-save-offset)
735 ;;; Get the old FP or return PC out of FRAME. STACK-SLOT is the
736 ;;; standard save location offset on the stack. LOC is the saved
737 ;;; SC-OFFSET describing the main location.
739 (defun get-context-value (frame stack-slot loc)
740 (declare (type compiled-frame frame) (type unsigned-byte stack-slot)
741 (type sb!c:sc-offset loc))
742 (let ((pointer (frame-pointer frame))
743 (escaped (compiled-frame-escaped frame)))
745 (sub-access-debug-var-slot pointer loc escaped)
746 (stack-ref pointer stack-slot))))
748 (defun get-context-value (frame stack-slot loc)
749 (declare (type compiled-frame frame) (type unsigned-byte stack-slot)
750 (type sb!c:sc-offset loc))
751 (let ((pointer (frame-pointer frame))
752 (escaped (compiled-frame-escaped frame)))
754 (sub-access-debug-var-slot pointer loc escaped)
757 (stack-ref pointer stack-slot))
759 (sap-ref-sap pointer (- (* (1+ stack-slot) 4))))))))
762 (defun (setf get-context-value) (value frame stack-slot loc)
763 (declare (type compiled-frame frame) (type unsigned-byte stack-slot)
764 (type sb!c:sc-offset loc))
765 (let ((pointer (frame-pointer frame))
766 (escaped (compiled-frame-escaped frame)))
768 (sub-set-debug-var-slot pointer loc value escaped)
769 (setf (stack-ref pointer stack-slot) value))))
772 (defun (setf get-context-value) (value frame stack-slot loc)
773 (declare (type compiled-frame frame) (type unsigned-byte stack-slot)
774 (type sb!c:sc-offset loc))
775 (let ((pointer (frame-pointer frame))
776 (escaped (compiled-frame-escaped frame)))
778 (sub-set-debug-var-slot pointer loc value escaped)
781 (setf (stack-ref pointer stack-slot) value))
783 (setf (sap-ref-sap pointer (- (* (1+ stack-slot) 4))) value))))))
785 ;;; This returns a frame for the one existing in time immediately
786 ;;; prior to the frame referenced by current-fp. This is current-fp's
787 ;;; caller or the next frame down the control stack. If there is no
788 ;;; down frame, this returns NIL for the bottom of the stack. UP-FRAME
789 ;;; is the up link for the resulting frame object, and it is null when
790 ;;; we call this to get the top of the stack.
792 ;;; The current frame contains the pointer to the temporally previous
793 ;;; frame we want, and the current frame contains the pc at which we
794 ;;; will continue executing upon returning to that previous frame.
796 ;;; Note: Sometimes LRA is actually a fixnum. This happens when lisp
797 ;;; calls into C. In this case, the code object is stored on the stack
798 ;;; after the LRA, and the LRA is the word offset.
800 (defun compute-calling-frame (caller lra up-frame)
801 (declare (type system-area-pointer caller))
802 (when (control-stack-pointer-valid-p caller)
803 (multiple-value-bind (code pc-offset escaped)
805 (multiple-value-bind (word-offset code)
807 (let ((fp (frame-pointer up-frame)))
809 (stack-ref fp (1+ lra-save-offset))))
810 (values (get-header-data lra)
811 (lra-code-header lra)))
814 (* (1+ (- word-offset (get-header-data code)))
817 (values :foreign-function
820 (find-escaped-frame caller))
821 (if (and (code-component-p code)
822 (eq (%code-debug-info code) :bogus-lra))
823 (let ((real-lra (code-header-ref code real-lra-slot)))
824 (compute-calling-frame caller real-lra up-frame))
825 (let ((d-fun (case code
827 (make-bogus-debug-fun
828 "undefined function"))
830 (make-bogus-debug-fun
831 (format nil "foreign function call land: ra=#x~X"
834 (make-bogus-debug-fun
835 "bogus stack frame"))
837 (debug-fun-from-pc code pc-offset)))))
838 (make-compiled-frame caller up-frame d-fun
839 (code-location-from-pc d-fun pc-offset
841 (if up-frame (1+ (frame-number up-frame)) 0)
844 (defun compute-calling-frame (caller ra up-frame)
845 (declare (type system-area-pointer caller ra))
846 (/noshow0 "entering COMPUTE-CALLING-FRAME")
847 (when (control-stack-pointer-valid-p caller)
849 ;; First check for an escaped frame.
850 (multiple-value-bind (code pc-offset escaped) (find-escaped-frame caller)
853 (/noshow0 "in CODE clause")
854 ;; If it's escaped it may be a function end breakpoint trap.
855 (when (and (code-component-p code)
856 (eq (%code-debug-info code) :bogus-lra))
857 ;; If :bogus-lra grab the real lra.
858 (setq pc-offset (code-header-ref
859 code (1+ real-lra-slot)))
860 (setq code (code-header-ref code real-lra-slot))
863 (/noshow0 "in T clause")
865 (multiple-value-setq (pc-offset code)
866 (compute-lra-data-from-pc ra))
868 (setf code :foreign-function
872 (let ((d-fun (case code
874 (make-bogus-debug-fun
875 "undefined function"))
877 (make-bogus-debug-fun
878 (format nil "foreign function call land: ra=#x~X"
881 (make-bogus-debug-fun
882 "bogus stack frame"))
884 (debug-fun-from-pc code pc-offset)))))
885 (/noshow0 "returning MAKE-COMPILED-FRAME from COMPUTE-CALLING-FRAME")
886 (make-compiled-frame caller up-frame d-fun
887 (code-location-from-pc d-fun pc-offset
889 (if up-frame (1+ (frame-number up-frame)) 0)
892 (defun nth-interrupt-context (n)
893 (declare (type (unsigned-byte 32) n)
894 (optimize (speed 3) (safety 0)))
895 (sb!alien:sap-alien (sb!vm::current-thread-offset-sap
896 (+ sb!vm::thread-interrupt-contexts-offset n))
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 (/noshow0 "at head of WITH-ALIEN")
905 (let ((context (nth-interrupt-context index)))
906 (/noshow0 "got CONTEXT")
907 (when (= (sap-int frame-pointer)
908 (sb!vm:context-register context sb!vm::cfp-offset))
910 (/noshow0 "in WITHOUT-GCING")
911 (let* ((component-ptr (component-ptr-from-pc
912 (sb!vm:context-pc context)))
913 (code (unless (sap= component-ptr (int-sap #x0))
914 (component-from-component-ptr component-ptr))))
915 (/noshow0 "got CODE")
917 (return (values code 0 context)))
918 (let* ((code-header-len (* (get-header-data code)
921 (- (sap-int (sb!vm:context-pc context))
922 (- (get-lisp-obj-address code)
923 sb!vm:other-pointer-lowtag)
925 (/noshow "got PC-OFFSET")
926 (unless (<= 0 pc-offset
927 (* (code-header-ref code sb!vm:code-code-size-slot)
929 ;; We were in an assembly routine. Therefore, use the
932 ;; FIXME: Should this be WARN or ERROR or what?
933 (format t "** pc-offset ~S not in code obj ~S?~%"
935 (/noshow0 "returning from FIND-ESCAPED-FRAME")
937 (values code pc-offset context)))))))))
940 (defun find-escaped-frame (frame-pointer)
941 (declare (type system-area-pointer frame-pointer))
942 (dotimes (index *free-interrupt-context-index* (values nil 0 nil))
943 (let ((scp (nth-interrupt-context index)))
944 (when (= (sap-int frame-pointer)
945 (sb!vm:context-register scp sb!vm::cfp-offset))
947 (let ((code (code-object-from-bits
948 (sb!vm:context-register scp sb!vm::code-offset))))
950 (return (values code 0 scp)))
951 (let* ((code-header-len (* (get-header-data code)
954 (- (sap-int (sb!vm:context-pc scp))
955 (- (get-lisp-obj-address code)
956 sb!vm:other-pointer-lowtag)
958 ;; Check to see whether we were executing in a branch
960 #!+(or pmax sgi) ; pmax only (and broken anyway)
961 (when (logbitp 31 (sb!alien:slot scp '%mips::sc-cause))
962 (incf pc-offset sb!vm:n-word-bytes))
963 (unless (<= 0 pc-offset
964 (* (code-header-ref code sb!vm:code-code-size-slot)
966 ;; We were in an assembly routine. Therefore, use the
969 (- (sb!vm:context-register scp sb!vm::lra-offset)
970 (get-lisp-obj-address code)
973 (if (eq (%code-debug-info code) :bogus-lra)
974 (let ((real-lra (code-header-ref code
976 (values (lra-code-header real-lra)
977 (get-header-data real-lra)
979 (values code pc-offset scp))))))))))
981 ;;; Find the code object corresponding to the object represented by
982 ;;; bits and return it. We assume bogus functions correspond to the
983 ;;; undefined-function.
984 (defun code-object-from-bits (bits)
985 (declare (type (unsigned-byte 32) bits))
986 (let ((object (make-lisp-obj bits)))
987 (if (functionp object)
988 (or (fun-code-header object)
990 (let ((lowtag (lowtag-of object)))
991 (if (= lowtag sb!vm:other-pointer-lowtag)
992 (let ((widetag (widetag-of object)))
993 (cond ((= widetag sb!vm:code-header-widetag)
995 ((= widetag sb!vm:return-pc-header-widetag)
996 (lra-code-header object))
1000 ;;;; frame utilities
1002 ;;; This returns a COMPILED-DEBUG-FUN for COMPONENT and PC. We fetch the
1003 ;;; SB!C::DEBUG-INFO and run down its FUN-MAP to get a
1004 ;;; SB!C::COMPILED-DEBUG-FUN from the PC. The result only needs to
1005 ;;; reference the COMPONENT, for function constants, and the
1006 ;;; SB!C::COMPILED-DEBUG-FUN.
1007 (defun debug-fun-from-pc (component pc)
1008 (let ((info (%code-debug-info component)))
1011 (debug-signal 'no-debug-info :code-component component))
1012 ((eq info :bogus-lra)
1013 (make-bogus-debug-fun "function end breakpoint"))
1015 (let* ((fun-map (sb!c::compiled-debug-info-fun-map info))
1016 (len (length fun-map)))
1017 (declare (type simple-vector fun-map))
1019 (make-compiled-debug-fun (svref fun-map 0) component)
1022 (>= pc (sb!c::compiled-debug-fun-elsewhere-pc
1023 (svref fun-map 0)))))
1024 (declare (type sb!int:index i))
1027 (< pc (if elsewhere-p
1028 (sb!c::compiled-debug-fun-elsewhere-pc
1029 (svref fun-map (1+ i)))
1030 (svref fun-map i))))
1031 (return (make-compiled-debug-fun
1032 (svref fun-map (1- i))
1036 ;;; This returns a code-location for the COMPILED-DEBUG-FUN,
1037 ;;; DEBUG-FUN, and the pc into its code vector. If we stopped at a
1038 ;;; breakpoint, find the CODE-LOCATION for that breakpoint. Otherwise,
1039 ;;; make an :UNSURE code location, so it can be filled in when we
1040 ;;; figure out what is going on.
1041 (defun code-location-from-pc (debug-fun pc escaped)
1042 (or (and (compiled-debug-fun-p debug-fun)
1044 (let ((data (breakpoint-data
1045 (compiled-debug-fun-component debug-fun)
1047 (when (and data (breakpoint-data-breakpoints data))
1048 (let ((what (breakpoint-what
1049 (first (breakpoint-data-breakpoints data)))))
1050 (when (compiled-code-location-p what)
1052 (make-compiled-code-location pc debug-fun)))
1054 ;;; Return an alist mapping catch tags to CODE-LOCATIONs. These are
1055 ;;; CODE-LOCATIONs at which execution would continue with frame as the
1056 ;;; top frame if someone threw to the corresponding tag.
1057 (defun frame-catches (frame)
1058 (let ((catch (descriptor-sap sb!vm:*current-catch-block*))
1059 (reversed-result nil)
1060 (fp (frame-pointer frame)))
1061 (loop until (zerop (sap-int catch))
1062 finally (return (nreverse reversed-result))
1067 (* sb!vm:catch-block-current-cont-slot
1068 sb!vm:n-word-bytes))
1072 (* sb!vm:catch-block-current-cont-slot
1073 sb!vm:n-word-bytes))))
1075 (lra (stack-ref catch sb!vm:catch-block-entry-pc-slot))
1078 catch (* sb!vm:catch-block-entry-pc-slot
1079 sb!vm:n-word-bytes)))
1082 (stack-ref catch sb!vm:catch-block-current-code-slot))
1084 (component (component-from-component-ptr
1085 (component-ptr-from-pc ra)))
1088 (* (- (1+ (get-header-data lra))
1089 (get-header-data component))
1093 (- (get-lisp-obj-address component)
1094 sb!vm:other-pointer-lowtag)
1095 (* (get-header-data component) sb!vm:n-word-bytes))))
1097 (stack-ref catch sb!vm:catch-block-tag-slot)
1100 (sap-ref-32 catch (* sb!vm:catch-block-tag-slot
1101 sb!vm:n-word-bytes)))
1102 (make-compiled-code-location
1103 offset (frame-debug-fun frame)))
1108 (* sb!vm:catch-block-previous-catch-slot
1109 sb!vm:n-word-bytes))
1113 (* sb!vm:catch-block-previous-catch-slot
1114 sb!vm:n-word-bytes)))))))
1116 ;;;; operations on DEBUG-FUNs
1118 ;;; Execute the forms in a context with BLOCK-VAR bound to each
1119 ;;; DEBUG-BLOCK in DEBUG-FUN successively. Result is an optional
1120 ;;; form to execute for return values, and DO-DEBUG-FUN-BLOCKS
1121 ;;; returns nil if there is no result form. This signals a
1122 ;;; NO-DEBUG-BLOCKS condition when the DEBUG-FUN lacks
1123 ;;; DEBUG-BLOCK information.
1124 (defmacro do-debug-fun-blocks ((block-var debug-fun &optional result)
1126 (let ((blocks (gensym))
1128 `(let ((,blocks (debug-fun-debug-blocks ,debug-fun)))
1129 (declare (simple-vector ,blocks))
1130 (dotimes (,i (length ,blocks) ,result)
1131 (let ((,block-var (svref ,blocks ,i)))
1134 ;;; Execute body in a context with VAR bound to each DEBUG-VAR in
1135 ;;; DEBUG-FUN. This returns the value of executing result (defaults to
1136 ;;; nil). This may iterate over only some of DEBUG-FUN's variables or
1137 ;;; none depending on debug policy; for example, possibly the
1138 ;;; compilation only preserved argument information.
1139 (defmacro do-debug-fun-vars ((var debug-fun &optional result) &body body)
1140 (let ((vars (gensym))
1142 `(let ((,vars (debug-fun-debug-vars ,debug-fun)))
1143 (declare (type (or null simple-vector) ,vars))
1145 (dotimes (,i (length ,vars) ,result)
1146 (let ((,var (svref ,vars ,i)))
1150 ;;; Return the object of type FUNCTION associated with the DEBUG-FUN,
1151 ;;; or NIL if the function is unavailable or is non-existent as a user
1152 ;;; callable function object.
1153 (defun debug-fun-fun (debug-fun)
1154 (let ((cached-value (debug-fun-%function debug-fun)))
1155 (if (eq cached-value :unparsed)
1156 (setf (debug-fun-%function debug-fun)
1157 (etypecase debug-fun
1160 (compiled-debug-fun-component debug-fun))
1162 (sb!c::compiled-debug-fun-start-pc
1163 (compiled-debug-fun-compiler-debug-fun debug-fun))))
1164 (do ((entry (%code-entry-points component)
1165 (%simple-fun-next entry)))
1168 (sb!c::compiled-debug-fun-start-pc
1169 (compiled-debug-fun-compiler-debug-fun
1170 (fun-debug-fun entry))))
1172 (bogus-debug-fun nil)))
1175 ;;; Return the name of the function represented by DEBUG-FUN. This may
1176 ;;; be a string or a cons; do not assume it is a symbol.
1177 (defun debug-fun-name (debug-fun)
1178 (declare (type debug-fun debug-fun))
1179 (etypecase debug-fun
1181 (sb!c::compiled-debug-fun-name
1182 (compiled-debug-fun-compiler-debug-fun debug-fun)))
1184 (bogus-debug-fun-%name debug-fun))))
1186 ;;; Return a DEBUG-FUN that represents debug information for FUN.
1187 (defun fun-debug-fun (fun)
1188 (declare (type function fun))
1189 (ecase (widetag-of fun)
1190 (#.sb!vm:closure-header-widetag
1191 (fun-debug-fun (%closure-fun fun)))
1192 (#.sb!vm:funcallable-instance-header-widetag
1193 (fun-debug-fun (funcallable-instance-fun fun)))
1194 ((#.sb!vm:simple-fun-header-widetag
1195 #.sb!vm:closure-fun-header-widetag)
1196 (let* ((name (%simple-fun-name fun))
1197 (component (fun-code-header fun))
1200 (and (sb!c::compiled-debug-fun-p x)
1201 (eq (sb!c::compiled-debug-fun-name x) name)
1202 (eq (sb!c::compiled-debug-fun-kind x) nil)))
1203 (sb!c::compiled-debug-info-fun-map
1204 (%code-debug-info component)))))
1206 (make-compiled-debug-fun res component)
1207 ;; KLUDGE: comment from CMU CL:
1208 ;; This used to be the non-interpreted branch, but
1209 ;; William wrote it to return the debug-fun of fun's XEP
1210 ;; instead of fun's debug-fun. The above code does this
1211 ;; more correctly, but it doesn't get or eliminate all
1212 ;; appropriate cases. It mostly works, and probably
1213 ;; works for all named functions anyway.
1215 (debug-fun-from-pc component
1216 (* (- (fun-word-offset fun)
1217 (get-header-data component))
1218 sb!vm:n-word-bytes)))))))
1220 ;;; Return the kind of the function, which is one of :OPTIONAL,
1221 ;;; :EXTERNAL, :TOPLEVEL, :CLEANUP, or NIL.
1222 (defun debug-fun-kind (debug-fun)
1223 ;; FIXME: This "is one of" information should become part of the function
1224 ;; declamation, not just a doc string
1225 (etypecase debug-fun
1227 (sb!c::compiled-debug-fun-kind
1228 (compiled-debug-fun-compiler-debug-fun debug-fun)))
1232 ;;; Is there any variable information for DEBUG-FUN?
1233 (defun debug-var-info-available (debug-fun)
1234 (not (not (debug-fun-debug-vars debug-fun))))
1236 ;;; Return a list of DEBUG-VARs in DEBUG-FUN having the same name
1237 ;;; and package as SYMBOL. If SYMBOL is uninterned, then this returns
1238 ;;; a list of DEBUG-VARs without package names and with the same name
1239 ;;; as symbol. The result of this function is limited to the
1240 ;;; availability of variable information in DEBUG-FUN; for
1241 ;;; example, possibly DEBUG-FUN only knows about its arguments.
1242 (defun debug-fun-symbol-vars (debug-fun symbol)
1243 (let ((vars (ambiguous-debug-vars debug-fun (symbol-name symbol)))
1244 (package (and (symbol-package symbol)
1245 (package-name (symbol-package symbol)))))
1246 (delete-if (if (stringp package)
1248 (let ((p (debug-var-package-name var)))
1249 (or (not (stringp p))
1250 (string/= p package))))
1252 (stringp (debug-var-package-name var))))
1255 ;;; Return a list of DEBUG-VARs in DEBUG-FUN whose names contain
1256 ;;; NAME-PREFIX-STRING as an initial substring. The result of this
1257 ;;; function is limited to the availability of variable information in
1258 ;;; debug-fun; for example, possibly debug-fun only knows
1259 ;;; about its arguments.
1260 (defun ambiguous-debug-vars (debug-fun name-prefix-string)
1261 (declare (simple-string name-prefix-string))
1262 (let ((variables (debug-fun-debug-vars debug-fun)))
1263 (declare (type (or null simple-vector) variables))
1265 (let* ((len (length variables))
1266 (prefix-len (length name-prefix-string))
1267 (pos (find-var name-prefix-string variables len))
1270 ;; Find names from pos to variable's len that contain prefix.
1271 (do ((i pos (1+ i)))
1273 (let* ((var (svref variables i))
1274 (name (debug-var-symbol-name var))
1275 (name-len (length name)))
1276 (declare (simple-string name))
1277 (when (/= (or (string/= name-prefix-string name
1278 :end1 prefix-len :end2 name-len)
1283 (setq res (nreverse res)))
1286 ;;; This returns a position in VARIABLES for one containing NAME as an
1287 ;;; initial substring. END is the length of VARIABLES if supplied.
1288 (defun find-var (name variables &optional end)
1289 (declare (simple-vector variables)
1290 (simple-string name))
1291 (let ((name-len (length name)))
1292 (position name variables
1294 (let* ((y (debug-var-symbol-name y))
1296 (declare (simple-string y))
1297 (and (>= y-len name-len)
1298 (string= x y :end1 name-len :end2 name-len))))
1299 :end (or end (length variables)))))
1301 ;;; Return a list representing the lambda-list for DEBUG-FUN. The
1302 ;;; list has the following structure:
1303 ;;; (required-var1 required-var2
1305 ;;; (:optional var3 suppliedp-var4)
1306 ;;; (:optional var5)
1308 ;;; (:rest var6) (:rest var7)
1310 ;;; (:keyword keyword-symbol var8 suppliedp-var9)
1311 ;;; (:keyword keyword-symbol var10)
1314 ;;; Each VARi is a DEBUG-VAR; however it may be the symbol :DELETED if
1315 ;;; it is unreferenced in DEBUG-FUN. This signals a
1316 ;;; LAMBDA-LIST-UNAVAILABLE condition when there is no argument list
1318 (defun debug-fun-lambda-list (debug-fun)
1319 (etypecase debug-fun
1320 (compiled-debug-fun (compiled-debug-fun-lambda-list debug-fun))
1321 (bogus-debug-fun nil)))
1323 ;;; Note: If this has to compute the lambda list, it caches it in DEBUG-FUN.
1324 (defun compiled-debug-fun-lambda-list (debug-fun)
1325 (let ((lambda-list (debug-fun-%lambda-list debug-fun)))
1326 (cond ((eq lambda-list :unparsed)
1327 (multiple-value-bind (args argsp)
1328 (parse-compiled-debug-fun-lambda-list debug-fun)
1329 (setf (debug-fun-%lambda-list debug-fun) args)
1332 (debug-signal 'lambda-list-unavailable
1333 :debug-fun debug-fun))))
1335 ((bogus-debug-fun-p debug-fun)
1337 ((sb!c::compiled-debug-fun-arguments
1338 (compiled-debug-fun-compiler-debug-fun debug-fun))
1339 ;; If the packed information is there (whether empty or not) as
1340 ;; opposed to being nil, then returned our cached value (nil).
1343 ;; Our cached value is nil, and the packed lambda-list information
1344 ;; is nil, so we don't have anything available.
1345 (debug-signal 'lambda-list-unavailable
1346 :debug-fun debug-fun)))))
1348 ;;; COMPILED-DEBUG-FUN-LAMBDA-LIST calls this when a
1349 ;;; COMPILED-DEBUG-FUN has no lambda list information cached. It
1350 ;;; returns the lambda list as the first value and whether there was
1351 ;;; any argument information as the second value. Therefore,
1352 ;;; (VALUES NIL T) means there were no arguments, but (VALUES NIL NIL)
1353 ;;; means there was no argument information.
1354 (defun parse-compiled-debug-fun-lambda-list (debug-fun)
1355 (let ((args (sb!c::compiled-debug-fun-arguments
1356 (compiled-debug-fun-compiler-debug-fun debug-fun))))
1361 (values (coerce (debug-fun-debug-vars debug-fun) 'list)
1364 (let ((vars (debug-fun-debug-vars debug-fun))
1369 (declare (type (or null simple-vector) vars))
1371 (when (>= i len) (return))
1372 (let ((ele (aref args i)))
1377 ;; Deleted required arg at beginning of args array.
1378 (push :deleted res))
1379 (sb!c::optional-args
1382 ;; SUPPLIED-P var immediately following keyword or
1383 ;; optional. Stick the extra var in the result
1384 ;; element representing the keyword or optional,
1385 ;; which is the previous one.
1387 (list (compiled-debug-fun-lambda-list-var
1388 args (incf i) vars))))
1391 (compiled-debug-fun-lambda-list-var
1392 args (incf i) vars))
1395 ;; Just ignore the fact that the next two args are
1396 ;; the &MORE arg context and count, and act like they
1397 ;; are regular arguments.
1401 (push (list :keyword
1403 (compiled-debug-fun-lambda-list-var
1404 args (incf i) vars))
1407 ;; We saw an optional marker, so the following
1408 ;; non-symbols are indexes indicating optional
1410 (push (list :optional (svref vars ele)) res))
1412 ;; Required arg at beginning of args array.
1413 (push (svref vars ele) res))))
1415 (values (nreverse res) t))))))
1417 ;;; This is used in COMPILED-DEBUG-FUN-LAMBDA-LIST.
1418 (defun compiled-debug-fun-lambda-list-var (args i vars)
1419 (declare (type (simple-array * (*)) args)
1420 (simple-vector vars))
1421 (let ((ele (aref args i)))
1422 (cond ((not (symbolp ele)) (svref vars ele))
1423 ((eq ele 'sb!c::deleted) :deleted)
1424 (t (error "malformed arguments description")))))
1426 (defun compiled-debug-fun-debug-info (debug-fun)
1427 (%code-debug-info (compiled-debug-fun-component debug-fun)))
1429 ;;;; unpacking variable and basic block data
1431 (defvar *parsing-buffer*
1432 (make-array 20 :adjustable t :fill-pointer t))
1433 (defvar *other-parsing-buffer*
1434 (make-array 20 :adjustable t :fill-pointer t))
1435 ;;; PARSE-DEBUG-BLOCKS and PARSE-DEBUG-VARS
1436 ;;; use this to unpack binary encoded information. It returns the
1437 ;;; values returned by the last form in body.
1439 ;;; This binds buffer-var to *parsing-buffer*, makes sure it starts at
1440 ;;; element zero, and makes sure if we unwind, we nil out any set
1441 ;;; elements for GC purposes.
1443 ;;; This also binds other-var to *other-parsing-buffer* when it is
1444 ;;; supplied, making sure it starts at element zero and that we nil
1445 ;;; out any elements if we unwind.
1447 ;;; This defines the local macro RESULT that takes a buffer, copies
1448 ;;; its elements to a resulting simple-vector, nil's out elements, and
1449 ;;; restarts the buffer at element zero. RESULT returns the
1451 (eval-when (:compile-toplevel :execute)
1452 (sb!xc:defmacro with-parsing-buffer ((buffer-var &optional other-var)
1454 (let ((len (gensym))
1457 (let ((,buffer-var *parsing-buffer*)
1458 ,@(if other-var `((,other-var *other-parsing-buffer*))))
1459 (setf (fill-pointer ,buffer-var) 0)
1460 ,@(if other-var `((setf (fill-pointer ,other-var) 0)))
1461 (macrolet ((result (buf)
1462 `(let* ((,',len (length ,buf))
1463 (,',res (make-array ,',len)))
1464 (replace ,',res ,buf :end1 ,',len :end2 ,',len)
1465 (fill ,buf nil :end ,',len)
1466 (setf (fill-pointer ,buf) 0)
1469 (fill *parsing-buffer* nil)
1470 ,@(if other-var `((fill *other-parsing-buffer* nil))))))
1473 ;;; The argument is a debug internals structure. This returns the
1474 ;;; DEBUG-BLOCKs for DEBUG-FUN, regardless of whether we have unpacked
1475 ;;; them yet. It signals a NO-DEBUG-BLOCKS condition if it can't
1476 ;;; return the blocks.
1477 (defun debug-fun-debug-blocks (debug-fun)
1478 (let ((blocks (debug-fun-blocks debug-fun)))
1479 (cond ((eq blocks :unparsed)
1480 (setf (debug-fun-blocks debug-fun)
1481 (parse-debug-blocks debug-fun))
1482 (unless (debug-fun-blocks debug-fun)
1483 (debug-signal 'no-debug-blocks
1484 :debug-fun debug-fun))
1485 (debug-fun-blocks debug-fun))
1488 (debug-signal 'no-debug-blocks
1489 :debug-fun debug-fun)))))
1491 ;;; Return a SIMPLE-VECTOR of DEBUG-BLOCKs or NIL. NIL indicates there
1492 ;;; was no basic block information.
1493 (defun parse-debug-blocks (debug-fun)
1494 (etypecase debug-fun
1496 (parse-compiled-debug-blocks debug-fun))
1498 (debug-signal 'no-debug-blocks :debug-fun debug-fun))))
1500 ;;; This does some of the work of PARSE-DEBUG-BLOCKS.
1501 (defun parse-compiled-debug-blocks (debug-fun)
1502 (let* ((var-count (length (debug-fun-debug-vars debug-fun)))
1503 (compiler-debug-fun (compiled-debug-fun-compiler-debug-fun
1505 (blocks (sb!c::compiled-debug-fun-blocks compiler-debug-fun))
1506 ;; KLUDGE: 8 is a hard-wired constant in the compiler for the
1507 ;; element size of the packed binary representation of the
1509 (live-set-len (ceiling var-count 8))
1510 (tlf-number (sb!c::compiled-debug-fun-tlf-number compiler-debug-fun)))
1512 (return-from parse-compiled-debug-blocks nil))
1513 (macrolet ((aref+ (a i) `(prog1 (aref ,a ,i) (incf ,i))))
1514 (with-parsing-buffer (blocks-buffer locations-buffer)
1516 (len (length blocks))
1519 (when (>= i len) (return))
1520 (let ((succ-and-flags (aref+ blocks i))
1522 (declare (type (unsigned-byte 8) succ-and-flags)
1524 (dotimes (k (ldb sb!c::compiled-debug-block-nsucc-byte
1526 (push (sb!c:read-var-integer blocks i) successors))
1528 (dotimes (k (sb!c:read-var-integer blocks i)
1529 (result locations-buffer))
1530 (let ((kind (svref sb!c::*compiled-code-location-kinds*
1533 (sb!c:read-var-integer blocks i)))
1534 (tlf-offset (or tlf-number
1535 (sb!c:read-var-integer blocks i)))
1536 (form-number (sb!c:read-var-integer blocks i))
1537 (live-set (sb!c:read-packed-bit-vector
1538 live-set-len blocks i)))
1539 (vector-push-extend (make-known-code-location
1540 pc debug-fun tlf-offset
1541 form-number live-set kind)
1543 (setf last-pc pc))))
1544 (block (make-compiled-debug-block
1545 locations successors
1547 sb!c::compiled-debug-block-elsewhere-p
1548 succ-and-flags))))))
1549 (vector-push-extend block blocks-buffer)
1550 (dotimes (k (length locations))
1551 (setf (code-location-%debug-block (svref locations k))
1553 (let ((res (result blocks-buffer)))
1554 (declare (simple-vector res))
1555 (dotimes (i (length res))
1556 (let* ((block (svref res i))
1558 (dolist (ele (debug-block-successors block))
1559 (push (svref res ele) succs))
1560 (setf (debug-block-successors block) succs)))
1563 ;;; The argument is a debug internals structure. This returns NIL if
1564 ;;; there is no variable information. It returns an empty
1565 ;;; simple-vector if there were no locals in the function. Otherwise
1566 ;;; it returns a SIMPLE-VECTOR of DEBUG-VARs.
1567 (defun debug-fun-debug-vars (debug-fun)
1568 (let ((vars (debug-fun-%debug-vars debug-fun)))
1569 (if (eq vars :unparsed)
1570 (setf (debug-fun-%debug-vars debug-fun)
1571 (etypecase debug-fun
1573 (parse-compiled-debug-vars debug-fun))
1574 (bogus-debug-fun nil)))
1577 ;;; VARS is the parsed variables for a minimal debug function. We need
1578 ;;; to assign names of the form ARG-NNN. We must pad with leading
1579 ;;; zeros, since the arguments must be in alphabetical order.
1580 (defun assign-minimal-var-names (vars)
1581 (declare (simple-vector vars))
1582 (let* ((len (length vars))
1583 (width (length (format nil "~W" (1- len)))))
1585 (setf (compiled-debug-var-symbol (svref vars i))
1586 (intern (format nil "ARG-~V,'0D" width i)
1587 ;; KLUDGE: It's somewhat nasty to have a bare
1588 ;; package name string here. It would be
1589 ;; nicer to have #.(FIND-PACKAGE "SB!DEBUG")
1590 ;; instead, since then at least it would transform
1591 ;; correctly under package renaming and stuff.
1592 ;; However, genesis can't handle dumped packages..
1595 ;; FIXME: Maybe this could be fixed by moving the
1596 ;; whole debug-int.lisp file to warm init? (after
1597 ;; which dumping a #.(FIND-PACKAGE ..) expression
1598 ;; would work fine) If this is possible, it would
1599 ;; probably be a good thing, since minimizing the
1600 ;; amount of stuff in cold init is basically good.
1601 (or (find-package "SB-DEBUG")
1602 (find-package "SB!DEBUG")))))))
1604 ;;; Parse the packed representation of DEBUG-VARs from
1605 ;;; DEBUG-FUN's SB!C::COMPILED-DEBUG-FUN, returning a vector
1606 ;;; of DEBUG-VARs, or NIL if there was no information to parse.
1607 (defun parse-compiled-debug-vars (debug-fun)
1608 (let* ((cdebug-fun (compiled-debug-fun-compiler-debug-fun
1610 (packed-vars (sb!c::compiled-debug-fun-vars cdebug-fun))
1611 (args-minimal (eq (sb!c::compiled-debug-fun-arguments cdebug-fun)
1615 (buffer (make-array 0 :fill-pointer 0 :adjustable t)))
1616 ((>= i (length packed-vars))
1617 (let ((result (coerce buffer 'simple-vector)))
1619 (assign-minimal-var-names result))
1621 (flet ((geti () (prog1 (aref packed-vars i) (incf i))))
1622 (let* ((flags (geti))
1623 (minimal (logtest sb!c::compiled-debug-var-minimal-p flags))
1624 (deleted (logtest sb!c::compiled-debug-var-deleted-p flags))
1625 (live (logtest sb!c::compiled-debug-var-environment-live
1627 (save (logtest sb!c::compiled-debug-var-save-loc-p flags))
1628 (symbol (if minimal nil (geti)))
1629 (id (if (logtest sb!c::compiled-debug-var-id-p flags)
1632 (sc-offset (if deleted 0 (geti)))
1633 (save-sc-offset (if save (geti) nil)))
1634 (aver (not (and args-minimal (not minimal))))
1635 (vector-push-extend (make-compiled-debug-var symbol
1644 ;;; If we're sure of whether code-location is known, return T or NIL.
1645 ;;; If we're :UNSURE, then try to fill in the code-location's slots.
1646 ;;; This determines whether there is any debug-block information, and
1647 ;;; if code-location is known.
1649 ;;; ??? IF this conses closures every time it's called, then break off the
1650 ;;; :UNSURE part to get the HANDLER-CASE into another function.
1651 (defun code-location-unknown-p (basic-code-location)
1652 (ecase (code-location-%unknown-p basic-code-location)
1656 (setf (code-location-%unknown-p basic-code-location)
1657 (handler-case (not (fill-in-code-location basic-code-location))
1658 (no-debug-blocks () t))))))
1660 ;;; Return the DEBUG-BLOCK containing code-location if it is available.
1661 ;;; Some debug policies inhibit debug-block information, and if none
1662 ;;; is available, then this signals a NO-DEBUG-BLOCKS condition.
1663 (defun code-location-debug-block (basic-code-location)
1664 (let ((block (code-location-%debug-block basic-code-location)))
1665 (if (eq block :unparsed)
1666 (etypecase basic-code-location
1667 (compiled-code-location
1668 (compute-compiled-code-location-debug-block basic-code-location))
1669 ;; (There used to be more cases back before sbcl-0.7.0, when
1670 ;; we did special tricks to debug the IR1 interpreter.)
1674 ;;; Store and return BASIC-CODE-LOCATION's debug-block. We determines
1675 ;;; the correct one using the code-location's pc. We use
1676 ;;; DEBUG-FUN-DEBUG-BLOCKS to return the cached block information
1677 ;;; or signal a NO-DEBUG-BLOCKS condition. The blocks are sorted by
1678 ;;; their first code-location's pc, in ascending order. Therefore, as
1679 ;;; soon as we find a block that starts with a pc greater than
1680 ;;; basic-code-location's pc, we know the previous block contains the
1681 ;;; pc. If we get to the last block, then the code-location is either
1682 ;;; in the second to last block or the last block, and we have to be
1683 ;;; careful in determining this since the last block could be code at
1684 ;;; the end of the function. We have to check for the last block being
1685 ;;; code first in order to see how to compare the code-location's pc.
1686 (defun compute-compiled-code-location-debug-block (basic-code-location)
1687 (let* ((pc (compiled-code-location-pc basic-code-location))
1688 (debug-fun (code-location-debug-fun
1689 basic-code-location))
1690 (blocks (debug-fun-debug-blocks debug-fun))
1691 (len (length blocks)))
1692 (declare (simple-vector blocks))
1693 (setf (code-location-%debug-block basic-code-location)
1699 (let ((last (svref blocks end)))
1701 ((debug-block-elsewhere-p last)
1703 (sb!c::compiled-debug-fun-elsewhere-pc
1704 (compiled-debug-fun-compiler-debug-fun
1706 (svref blocks (1- end))
1709 (compiled-code-location-pc
1710 (svref (compiled-debug-block-code-locations last)
1712 (svref blocks (1- end)))
1714 (declare (type index i end))
1716 (compiled-code-location-pc
1717 (svref (compiled-debug-block-code-locations
1720 (return (svref blocks (1- i)))))))))
1722 ;;; Return the CODE-LOCATION's DEBUG-SOURCE.
1723 (defun code-location-debug-source (code-location)
1724 (etypecase code-location
1725 (compiled-code-location
1726 (let* ((info (compiled-debug-fun-debug-info
1727 (code-location-debug-fun code-location)))
1728 (sources (sb!c::compiled-debug-info-source info))
1729 (len (length sources)))
1730 (declare (list sources))
1732 (debug-signal 'no-debug-blocks :debug-fun
1733 (code-location-debug-fun code-location)))
1736 (do ((prev sources src)
1737 (src (cdr sources) (cdr src))
1738 (offset (code-location-toplevel-form-offset code-location)))
1739 ((null src) (car prev))
1740 (when (< offset (sb!c::debug-source-source-root (car src)))
1741 (return (car prev)))))))
1742 ;; (There used to be more cases back before sbcl-0.7.0, when we
1743 ;; did special tricks to debug the IR1 interpreter.)
1746 ;;; Returns the number of top level forms before the one containing
1747 ;;; CODE-LOCATION as seen by the compiler in some compilation unit. (A
1748 ;;; compilation unit is not necessarily a single file, see the section
1749 ;;; on debug-sources.)
1750 (defun code-location-toplevel-form-offset (code-location)
1751 (when (code-location-unknown-p code-location)
1752 (error 'unknown-code-location :code-location code-location))
1753 (let ((tlf-offset (code-location-%tlf-offset code-location)))
1754 (cond ((eq tlf-offset :unparsed)
1755 (etypecase code-location
1756 (compiled-code-location
1757 (unless (fill-in-code-location code-location)
1758 ;; This check should be unnecessary. We're missing
1759 ;; debug info the compiler should have dumped.
1760 (bug "unknown code location"))
1761 (code-location-%tlf-offset code-location))
1762 ;; (There used to be more cases back before sbcl-0.7.0,,
1763 ;; when we did special tricks to debug the IR1
1768 ;;; Return the number of the form corresponding to CODE-LOCATION. The
1769 ;;; form number is derived by a walking the subforms of a top level
1770 ;;; form in depth-first order.
1771 (defun code-location-form-number (code-location)
1772 (when (code-location-unknown-p code-location)
1773 (error 'unknown-code-location :code-location code-location))
1774 (let ((form-num (code-location-%form-number code-location)))
1775 (cond ((eq form-num :unparsed)
1776 (etypecase code-location
1777 (compiled-code-location
1778 (unless (fill-in-code-location code-location)
1779 ;; This check should be unnecessary. We're missing
1780 ;; debug info the compiler should have dumped.
1781 (bug "unknown code location"))
1782 (code-location-%form-number code-location))
1783 ;; (There used to be more cases back before sbcl-0.7.0,,
1784 ;; when we did special tricks to debug the IR1
1789 ;;; Return the kind of CODE-LOCATION, one of:
1790 ;;; :INTERPRETED, :UNKNOWN-RETURN, :KNOWN-RETURN, :INTERNAL-ERROR,
1791 ;;; :NON-LOCAL-EXIT, :BLOCK-START, :CALL-SITE, :SINGLE-VALUE-RETURN,
1792 ;;; :NON-LOCAL-ENTRY
1793 (defun code-location-kind (code-location)
1794 (when (code-location-unknown-p code-location)
1795 (error 'unknown-code-location :code-location code-location))
1796 (etypecase code-location
1797 (compiled-code-location
1798 (let ((kind (compiled-code-location-kind code-location)))
1799 (cond ((not (eq kind :unparsed)) kind)
1800 ((not (fill-in-code-location code-location))
1801 ;; This check should be unnecessary. We're missing
1802 ;; debug info the compiler should have dumped.
1803 (bug "unknown code location"))
1805 (compiled-code-location-kind code-location)))))
1806 ;; (There used to be more cases back before sbcl-0.7.0,,
1807 ;; when we did special tricks to debug the IR1
1811 ;;; This returns CODE-LOCATION's live-set if it is available. If
1812 ;;; there is no debug-block information, this returns NIL.
1813 (defun compiled-code-location-live-set (code-location)
1814 (if (code-location-unknown-p code-location)
1816 (let ((live-set (compiled-code-location-%live-set code-location)))
1817 (cond ((eq live-set :unparsed)
1818 (unless (fill-in-code-location code-location)
1819 ;; This check should be unnecessary. We're missing
1820 ;; debug info the compiler should have dumped.
1822 ;; FIXME: This error and comment happen over and over again.
1823 ;; Make them a shared function.
1824 (bug "unknown code location"))
1825 (compiled-code-location-%live-set code-location))
1828 ;;; true if OBJ1 and OBJ2 are the same place in the code
1829 (defun code-location= (obj1 obj2)
1831 (compiled-code-location
1833 (compiled-code-location
1834 (and (eq (code-location-debug-fun obj1)
1835 (code-location-debug-fun obj2))
1836 (sub-compiled-code-location= obj1 obj2)))
1837 ;; (There used to be more cases back before sbcl-0.7.0,,
1838 ;; when we did special tricks to debug the IR1
1841 ;; (There used to be more cases back before sbcl-0.7.0,,
1842 ;; when we did special tricks to debug IR1-interpreted code.)
1844 (defun sub-compiled-code-location= (obj1 obj2)
1845 (= (compiled-code-location-pc obj1)
1846 (compiled-code-location-pc obj2)))
1848 ;;; Fill in CODE-LOCATION's :UNPARSED slots, returning T or NIL
1849 ;;; depending on whether the code-location was known in its
1850 ;;; DEBUG-FUN's debug-block information. This may signal a
1851 ;;; NO-DEBUG-BLOCKS condition due to DEBUG-FUN-DEBUG-BLOCKS, and
1852 ;;; it assumes the %UNKNOWN-P slot is already set or going to be set.
1853 (defun fill-in-code-location (code-location)
1854 (declare (type compiled-code-location code-location))
1855 (let* ((debug-fun (code-location-debug-fun code-location))
1856 (blocks (debug-fun-debug-blocks debug-fun)))
1857 (declare (simple-vector blocks))
1858 (dotimes (i (length blocks) nil)
1859 (let* ((block (svref blocks i))
1860 (locations (compiled-debug-block-code-locations block)))
1861 (declare (simple-vector locations))
1862 (dotimes (j (length locations))
1863 (let ((loc (svref locations j)))
1864 (when (sub-compiled-code-location= code-location loc)
1865 (setf (code-location-%debug-block code-location) block)
1866 (setf (code-location-%tlf-offset code-location)
1867 (code-location-%tlf-offset loc))
1868 (setf (code-location-%form-number code-location)
1869 (code-location-%form-number loc))
1870 (setf (compiled-code-location-%live-set code-location)
1871 (compiled-code-location-%live-set loc))
1872 (setf (compiled-code-location-kind code-location)
1873 (compiled-code-location-kind loc))
1874 (return-from fill-in-code-location t))))))))
1876 ;;;; operations on DEBUG-BLOCKs
1878 ;;; Execute FORMS in a context with CODE-VAR bound to each
1879 ;;; CODE-LOCATION in DEBUG-BLOCK, and return the value of RESULT.
1880 (defmacro do-debug-block-locations ((code-var debug-block &optional result)
1882 (let ((code-locations (gensym))
1884 `(let ((,code-locations (debug-block-code-locations ,debug-block)))
1885 (declare (simple-vector ,code-locations))
1886 (dotimes (,i (length ,code-locations) ,result)
1887 (let ((,code-var (svref ,code-locations ,i)))
1890 ;;; Return the name of the function represented by DEBUG-FUN.
1891 ;;; This may be a string or a cons; do not assume it is a symbol.
1892 (defun debug-block-fun-name (debug-block)
1893 (etypecase debug-block
1894 (compiled-debug-block
1895 (let ((code-locs (compiled-debug-block-code-locations debug-block)))
1896 (declare (simple-vector code-locs))
1897 (if (zerop (length code-locs))
1898 "??? Can't get name of debug-block's function."
1900 (code-location-debug-fun (svref code-locs 0))))))
1901 ;; (There used to be more cases back before sbcl-0.7.0, when we
1902 ;; did special tricks to debug the IR1 interpreter.)
1905 (defun debug-block-code-locations (debug-block)
1906 (etypecase debug-block
1907 (compiled-debug-block
1908 (compiled-debug-block-code-locations debug-block))
1909 ;; (There used to be more cases back before sbcl-0.7.0, when we
1910 ;; did special tricks to debug the IR1 interpreter.)
1913 ;;;; operations on debug variables
1915 (defun debug-var-symbol-name (debug-var)
1916 (symbol-name (debug-var-symbol debug-var)))
1918 ;;; FIXME: Make sure that this isn't called anywhere that it wouldn't
1919 ;;; be acceptable to have NIL returned, or that it's only called on
1920 ;;; DEBUG-VARs whose symbols have non-NIL packages.
1921 (defun debug-var-package-name (debug-var)
1922 (package-name (symbol-package (debug-var-symbol debug-var))))
1924 ;;; Return the value stored for DEBUG-VAR in frame, or if the value is
1925 ;;; not :VALID, then signal an INVALID-VALUE error.
1926 (defun debug-var-valid-value (debug-var frame)
1927 (unless (eq (debug-var-validity debug-var (frame-code-location frame))
1929 (error 'invalid-value :debug-var debug-var :frame frame))
1930 (debug-var-value debug-var frame))
1932 ;;; Returns the value stored for DEBUG-VAR in frame. The value may be
1933 ;;; invalid. This is SETFable.
1934 (defun debug-var-value (debug-var frame)
1935 (aver (typep frame 'compiled-frame))
1936 (let ((res (access-compiled-debug-var-slot debug-var frame)))
1937 (if (indirect-value-cell-p res)
1938 (value-cell-ref res)
1941 ;;; This returns what is stored for the variable represented by
1942 ;;; DEBUG-VAR relative to the FRAME. This may be an indirect value
1943 ;;; cell if the variable is both closed over and set.
1944 (defun access-compiled-debug-var-slot (debug-var frame)
1945 (declare (optimize (speed 1)))
1946 (let ((escaped (compiled-frame-escaped frame)))
1948 (sub-access-debug-var-slot
1949 (frame-pointer frame)
1950 (compiled-debug-var-sc-offset debug-var)
1952 (sub-access-debug-var-slot
1953 (frame-pointer frame)
1954 (or (compiled-debug-var-save-sc-offset debug-var)
1955 (compiled-debug-var-sc-offset debug-var))))))
1957 ;;; a helper function for working with possibly-invalid values:
1958 ;;; Do (MAKE-LISP-OBJ VAL) only if the value looks valid.
1960 ;;; (Such values can arise in registers on machines with conservative
1961 ;;; GC, and might also arise in debug variable locations when
1962 ;;; those variables are invalid.)
1963 (defun make-valid-lisp-obj (val)
1966 (zerop (logand val 3))
1968 (and (zerop (logand val #xffff0000)) ; Top bits zero
1969 (= (logand val #xff) sb!vm:base-char-widetag)) ; char tag
1971 (= val sb!vm:unbound-marker-widetag)
1974 ;; Check that the pointer is valid. XXX Could do a better
1975 ;; job. FIXME: e.g. by calling out to an is_valid_pointer
1976 ;; routine in the C runtime support code
1977 (or (< sb!vm:read-only-space-start val
1978 (* sb!vm:*read-only-space-free-pointer*
1979 sb!vm:n-word-bytes))
1980 (< sb!vm:static-space-start val
1981 (* sb!vm:*static-space-free-pointer*
1982 sb!vm:n-word-bytes))
1983 (< sb!vm:dynamic-space-start val
1984 (sap-int (dynamic-space-free-pointer))))))
1989 (defun sub-access-debug-var-slot (fp sc-offset &optional escaped)
1990 (macrolet ((with-escaped-value ((var) &body forms)
1992 (let ((,var (sb!vm:context-register
1994 (sb!c:sc-offset-offset sc-offset))))
1996 :invalid-value-for-unescaped-register-storage))
1997 (escaped-float-value (format)
1999 (sb!vm:context-float-register
2001 (sb!c:sc-offset-offset sc-offset)
2003 :invalid-value-for-unescaped-register-storage))
2004 (with-nfp ((var) &body body)
2005 `(let ((,var (if escaped
2007 (sb!vm:context-register escaped
2010 (sb!sys:sap-ref-sap fp (* nfp-save-offset
2011 sb!vm:n-word-bytes))
2013 (sb!vm::make-number-stack-pointer
2014 (sb!sys:sap-ref-32 fp (* nfp-save-offset
2015 sb!vm:n-word-bytes))))))
2017 (ecase (sb!c:sc-offset-scn sc-offset)
2018 ((#.sb!vm:any-reg-sc-number
2019 #.sb!vm:descriptor-reg-sc-number
2020 #!+rt #.sb!vm:word-pointer-reg-sc-number)
2021 (sb!sys:without-gcing
2022 (with-escaped-value (val) (sb!kernel:make-lisp-obj val))))
2024 (#.sb!vm:base-char-reg-sc-number
2025 (with-escaped-value (val)
2027 (#.sb!vm:sap-reg-sc-number
2028 (with-escaped-value (val)
2029 (sb!sys:int-sap val)))
2030 (#.sb!vm:signed-reg-sc-number
2031 (with-escaped-value (val)
2032 (if (logbitp (1- sb!vm:n-word-bits) val)
2033 (logior val (ash -1 sb!vm:n-word-bits))
2035 (#.sb!vm:unsigned-reg-sc-number
2036 (with-escaped-value (val)
2038 (#.sb!vm:non-descriptor-reg-sc-number
2039 (error "Local non-descriptor register access?"))
2040 (#.sb!vm:interior-reg-sc-number
2041 (error "Local interior register access?"))
2042 (#.sb!vm:single-reg-sc-number
2043 (escaped-float-value single-float))
2044 (#.sb!vm:double-reg-sc-number
2045 (escaped-float-value double-float))
2047 (#.sb!vm:long-reg-sc-number
2048 (escaped-float-value long-float))
2049 (#.sb!vm:complex-single-reg-sc-number
2052 (sb!vm:context-float-register
2053 escaped (sb!c:sc-offset-offset sc-offset) 'single-float)
2054 (sb!vm:context-float-register
2055 escaped (1+ (sb!c:sc-offset-offset sc-offset)) 'single-float))
2056 :invalid-value-for-unescaped-register-storage))
2057 (#.sb!vm:complex-double-reg-sc-number
2060 (sb!vm:context-float-register
2061 escaped (sb!c:sc-offset-offset sc-offset) 'double-float)
2062 (sb!vm:context-float-register
2063 escaped (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 2 #!-sparc 1)
2065 :invalid-value-for-unescaped-register-storage))
2067 (#.sb!vm:complex-long-reg-sc-number
2070 (sb!vm:context-float-register
2071 escaped (sb!c:sc-offset-offset sc-offset) 'long-float)
2072 (sb!vm:context-float-register
2073 escaped (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 4)
2075 :invalid-value-for-unescaped-register-storage))
2076 (#.sb!vm:single-stack-sc-number
2078 (sb!sys:sap-ref-single nfp (* (sb!c:sc-offset-offset sc-offset)
2079 sb!vm:n-word-bytes))))
2080 (#.sb!vm:double-stack-sc-number
2082 (sb!sys:sap-ref-double nfp (* (sb!c:sc-offset-offset sc-offset)
2083 sb!vm:n-word-bytes))))
2085 (#.sb!vm:long-stack-sc-number
2087 (sb!sys:sap-ref-long nfp (* (sb!c:sc-offset-offset sc-offset)
2088 sb!vm:n-word-bytes))))
2089 (#.sb!vm:complex-single-stack-sc-number
2092 (sb!sys:sap-ref-single nfp (* (sb!c:sc-offset-offset sc-offset)
2093 sb!vm:n-word-bytes))
2094 (sb!sys:sap-ref-single nfp (* (1+ (sb!c:sc-offset-offset sc-offset))
2095 sb!vm:n-word-bytes)))))
2096 (#.sb!vm:complex-double-stack-sc-number
2099 (sb!sys:sap-ref-double nfp (* (sb!c:sc-offset-offset sc-offset)
2100 sb!vm:n-word-bytes))
2101 (sb!sys:sap-ref-double nfp (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2102 sb!vm:n-word-bytes)))))
2104 (#.sb!vm:complex-long-stack-sc-number
2107 (sb!sys:sap-ref-long nfp (* (sb!c:sc-offset-offset sc-offset)
2108 sb!vm:n-word-bytes))
2109 (sb!sys:sap-ref-long nfp (* (+ (sb!c:sc-offset-offset sc-offset)
2111 sb!vm:n-word-bytes)))))
2112 (#.sb!vm:control-stack-sc-number
2113 (sb!kernel:stack-ref fp (sb!c:sc-offset-offset sc-offset)))
2114 (#.sb!vm:base-char-stack-sc-number
2116 (code-char (sb!sys:sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2117 sb!vm:n-word-bytes)))))
2118 (#.sb!vm:unsigned-stack-sc-number
2120 (sb!sys:sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2121 sb!vm:n-word-bytes))))
2122 (#.sb!vm:signed-stack-sc-number
2124 (sb!sys:signed-sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2125 sb!vm:n-word-bytes))))
2126 (#.sb!vm:sap-stack-sc-number
2128 (sb!sys:sap-ref-sap nfp (* (sb!c:sc-offset-offset sc-offset)
2129 sb!vm:n-word-bytes)))))))
2132 (defun sub-access-debug-var-slot (fp sc-offset &optional escaped)
2133 (declare (type system-area-pointer fp))
2134 (macrolet ((with-escaped-value ((var) &body forms)
2136 (let ((,var (sb!vm:context-register
2138 (sb!c:sc-offset-offset sc-offset))))
2140 :invalid-value-for-unescaped-register-storage))
2141 (escaped-float-value (format)
2143 (sb!vm:context-float-register
2144 escaped (sb!c:sc-offset-offset sc-offset) ',format)
2145 :invalid-value-for-unescaped-register-storage))
2146 (escaped-complex-float-value (format)
2149 (sb!vm:context-float-register
2150 escaped (sb!c:sc-offset-offset sc-offset) ',format)
2151 (sb!vm:context-float-register
2152 escaped (1+ (sb!c:sc-offset-offset sc-offset)) ',format))
2153 :invalid-value-for-unescaped-register-storage)))
2154 (ecase (sb!c:sc-offset-scn sc-offset)
2155 ((#.sb!vm:any-reg-sc-number #.sb!vm:descriptor-reg-sc-number)
2157 (with-escaped-value (val)
2158 (make-valid-lisp-obj val))))
2159 (#.sb!vm:base-char-reg-sc-number
2160 (with-escaped-value (val)
2162 (#.sb!vm:sap-reg-sc-number
2163 (with-escaped-value (val)
2165 (#.sb!vm:signed-reg-sc-number
2166 (with-escaped-value (val)
2167 (if (logbitp (1- sb!vm:n-word-bits) val)
2168 (logior val (ash -1 sb!vm:n-word-bits))
2170 (#.sb!vm:unsigned-reg-sc-number
2171 (with-escaped-value (val)
2173 (#.sb!vm:single-reg-sc-number
2174 (escaped-float-value single-float))
2175 (#.sb!vm:double-reg-sc-number
2176 (escaped-float-value double-float))
2178 (#.sb!vm:long-reg-sc-number
2179 (escaped-float-value long-float))
2180 (#.sb!vm:complex-single-reg-sc-number
2181 (escaped-complex-float-value single-float))
2182 (#.sb!vm:complex-double-reg-sc-number
2183 (escaped-complex-float-value double-float))
2185 (#.sb!vm:complex-long-reg-sc-number
2186 (escaped-complex-float-value long-float))
2187 (#.sb!vm:single-stack-sc-number
2188 (sap-ref-single fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2189 sb!vm:n-word-bytes))))
2190 (#.sb!vm:double-stack-sc-number
2191 (sap-ref-double fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2192 sb!vm:n-word-bytes))))
2194 (#.sb!vm:long-stack-sc-number
2195 (sap-ref-long fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2196 sb!vm:n-word-bytes))))
2197 (#.sb!vm:complex-single-stack-sc-number
2199 (sap-ref-single fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2200 sb!vm:n-word-bytes)))
2201 (sap-ref-single fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2202 sb!vm:n-word-bytes)))))
2203 (#.sb!vm:complex-double-stack-sc-number
2205 (sap-ref-double fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2206 sb!vm:n-word-bytes)))
2207 (sap-ref-double fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 4)
2208 sb!vm:n-word-bytes)))))
2210 (#.sb!vm:complex-long-stack-sc-number
2212 (sap-ref-long fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2213 sb!vm:n-word-bytes)))
2214 (sap-ref-long fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 6)
2215 sb!vm:n-word-bytes)))))
2216 (#.sb!vm:control-stack-sc-number
2217 (stack-ref fp (sb!c:sc-offset-offset sc-offset)))
2218 (#.sb!vm:base-char-stack-sc-number
2220 (sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2221 sb!vm:n-word-bytes)))))
2222 (#.sb!vm:unsigned-stack-sc-number
2223 (sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2224 sb!vm:n-word-bytes))))
2225 (#.sb!vm:signed-stack-sc-number
2226 (signed-sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2227 sb!vm:n-word-bytes))))
2228 (#.sb!vm:sap-stack-sc-number
2229 (sap-ref-sap fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2230 sb!vm:n-word-bytes)))))))
2232 ;;; This stores value as the value of DEBUG-VAR in FRAME. In the
2233 ;;; COMPILED-DEBUG-VAR case, access the current value to determine if
2234 ;;; it is an indirect value cell. This occurs when the variable is
2235 ;;; both closed over and set.
2236 (defun %set-debug-var-value (debug-var frame new-value)
2237 (aver (typep frame 'compiled-frame))
2238 (let ((old-value (access-compiled-debug-var-slot debug-var frame)))
2239 (if (indirect-value-cell-p old-value)
2240 (value-cell-set old-value new-value)
2241 (set-compiled-debug-var-slot debug-var frame new-value)))
2244 ;;; This stores VALUE for the variable represented by debug-var
2245 ;;; relative to the frame. This assumes the location directly contains
2246 ;;; the variable's value; that is, there is no indirect value cell
2247 ;;; currently there in case the variable is both closed over and set.
2248 (defun set-compiled-debug-var-slot (debug-var frame value)
2249 (let ((escaped (compiled-frame-escaped frame)))
2251 (sub-set-debug-var-slot (frame-pointer frame)
2252 (compiled-debug-var-sc-offset debug-var)
2254 (sub-set-debug-var-slot
2255 (frame-pointer frame)
2256 (or (compiled-debug-var-save-sc-offset debug-var)
2257 (compiled-debug-var-sc-offset debug-var))
2261 (defun sub-set-debug-var-slot (fp sc-offset value &optional escaped)
2262 (macrolet ((set-escaped-value (val)
2264 (setf (sb!vm:context-register
2266 (sb!c:sc-offset-offset sc-offset))
2269 (set-escaped-float-value (format val)
2271 (setf (sb!vm:context-float-register
2273 (sb!c:sc-offset-offset sc-offset)
2277 (with-nfp ((var) &body body)
2278 `(let ((,var (if escaped
2280 (sb!vm:context-register escaped
2285 sb!vm:n-word-bytes))
2287 (sb!vm::make-number-stack-pointer
2290 sb!vm:n-word-bytes))))))
2292 (ecase (sb!c:sc-offset-scn sc-offset)
2293 ((#.sb!vm:any-reg-sc-number
2294 #.sb!vm:descriptor-reg-sc-number
2295 #!+rt #.sb!vm:word-pointer-reg-sc-number)
2298 (get-lisp-obj-address value))))
2299 (#.sb!vm:base-char-reg-sc-number
2300 (set-escaped-value (char-code value)))
2301 (#.sb!vm:sap-reg-sc-number
2302 (set-escaped-value (sap-int value)))
2303 (#.sb!vm:signed-reg-sc-number
2304 (set-escaped-value (logand value (1- (ash 1 sb!vm:n-word-bits)))))
2305 (#.sb!vm:unsigned-reg-sc-number
2306 (set-escaped-value value))
2307 (#.sb!vm:non-descriptor-reg-sc-number
2308 (error "Local non-descriptor register access?"))
2309 (#.sb!vm:interior-reg-sc-number
2310 (error "Local interior register access?"))
2311 (#.sb!vm:single-reg-sc-number
2312 (set-escaped-float-value single-float value))
2313 (#.sb!vm:double-reg-sc-number
2314 (set-escaped-float-value double-float value))
2316 (#.sb!vm:long-reg-sc-number
2317 (set-escaped-float-value long-float value))
2318 (#.sb!vm:complex-single-reg-sc-number
2320 (setf (sb!vm:context-float-register escaped
2321 (sb!c:sc-offset-offset sc-offset)
2324 (setf (sb!vm:context-float-register
2325 escaped (1+ (sb!c:sc-offset-offset sc-offset))
2329 (#.sb!vm:complex-double-reg-sc-number
2331 (setf (sb!vm:context-float-register
2332 escaped (sb!c:sc-offset-offset sc-offset) 'double-float)
2334 (setf (sb!vm:context-float-register
2336 (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 2 #!-sparc 1)
2341 (#.sb!vm:complex-long-reg-sc-number
2343 (setf (sb!vm:context-float-register
2344 escaped (sb!c:sc-offset-offset sc-offset) 'long-float)
2346 (setf (sb!vm:context-float-register
2348 (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 4)
2352 (#.sb!vm:single-stack-sc-number
2354 (setf (sap-ref-single nfp (* (sb!c:sc-offset-offset sc-offset)
2355 sb!vm:n-word-bytes))
2356 (the single-float value))))
2357 (#.sb!vm:double-stack-sc-number
2359 (setf (sap-ref-double nfp (* (sb!c:sc-offset-offset sc-offset)
2360 sb!vm:n-word-bytes))
2361 (the double-float value))))
2363 (#.sb!vm:long-stack-sc-number
2365 (setf (sap-ref-long nfp (* (sb!c:sc-offset-offset sc-offset)
2366 sb!vm:n-word-bytes))
2367 (the long-float value))))
2368 (#.sb!vm:complex-single-stack-sc-number
2370 (setf (sap-ref-single
2371 nfp (* (sb!c:sc-offset-offset sc-offset) sb!vm:n-word-bytes))
2372 (the single-float (realpart value)))
2373 (setf (sap-ref-single
2374 nfp (* (1+ (sb!c:sc-offset-offset sc-offset))
2375 sb!vm:n-word-bytes))
2376 (the single-float (realpart value)))))
2377 (#.sb!vm:complex-double-stack-sc-number
2379 (setf (sap-ref-double
2380 nfp (* (sb!c:sc-offset-offset sc-offset) sb!vm:n-word-bytes))
2381 (the double-float (realpart value)))
2382 (setf (sap-ref-double
2383 nfp (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2384 sb!vm:n-word-bytes))
2385 (the double-float (realpart value)))))
2387 (#.sb!vm:complex-long-stack-sc-number
2390 nfp (* (sb!c:sc-offset-offset sc-offset) sb!vm:n-word-bytes))
2391 (the long-float (realpart value)))
2393 nfp (* (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 4)
2394 sb!vm:n-word-bytes))
2395 (the long-float (realpart value)))))
2396 (#.sb!vm:control-stack-sc-number
2397 (setf (stack-ref fp (sb!c:sc-offset-offset sc-offset)) value))
2398 (#.sb!vm:base-char-stack-sc-number
2400 (setf (sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2401 sb!vm:n-word-bytes))
2402 (char-code (the character value)))))
2403 (#.sb!vm:unsigned-stack-sc-number
2405 (setf (sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2406 sb!vm:n-word-bytes))
2407 (the (unsigned-byte 32) value))))
2408 (#.sb!vm:signed-stack-sc-number
2410 (setf (signed-sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2411 sb!vm:n-word-bytes))
2412 (the (signed-byte 32) value))))
2413 (#.sb!vm:sap-stack-sc-number
2415 (setf (sap-ref-sap nfp (* (sb!c:sc-offset-offset sc-offset)
2416 sb!vm:n-word-bytes))
2417 (the system-area-pointer value)))))))
2420 (defun sub-set-debug-var-slot (fp sc-offset value &optional escaped)
2421 (macrolet ((set-escaped-value (val)
2423 (setf (sb!vm:context-register
2425 (sb!c:sc-offset-offset sc-offset))
2428 (ecase (sb!c:sc-offset-scn sc-offset)
2429 ((#.sb!vm:any-reg-sc-number #.sb!vm:descriptor-reg-sc-number)
2432 (get-lisp-obj-address value))))
2433 (#.sb!vm:base-char-reg-sc-number
2434 (set-escaped-value (char-code value)))
2435 (#.sb!vm:sap-reg-sc-number
2436 (set-escaped-value (sap-int value)))
2437 (#.sb!vm:signed-reg-sc-number
2438 (set-escaped-value (logand value (1- (ash 1 sb!vm:n-word-bits)))))
2439 (#.sb!vm:unsigned-reg-sc-number
2440 (set-escaped-value value))
2441 (#.sb!vm:single-reg-sc-number
2442 #+nil ;; don't have escaped floats.
2443 (set-escaped-float-value single-float value))
2444 (#.sb!vm:double-reg-sc-number
2445 #+nil ;; don't have escaped floats -- still in npx?
2446 (set-escaped-float-value double-float value))
2448 (#.sb!vm:long-reg-sc-number
2449 #+nil ;; don't have escaped floats -- still in npx?
2450 (set-escaped-float-value long-float value))
2451 (#.sb!vm:single-stack-sc-number
2452 (setf (sap-ref-single
2453 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2454 sb!vm:n-word-bytes)))
2455 (the single-float value)))
2456 (#.sb!vm:double-stack-sc-number
2457 (setf (sap-ref-double
2458 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2459 sb!vm:n-word-bytes)))
2460 (the double-float value)))
2462 (#.sb!vm:long-stack-sc-number
2464 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2465 sb!vm:n-word-bytes)))
2466 (the long-float value)))
2467 (#.sb!vm:complex-single-stack-sc-number
2468 (setf (sap-ref-single
2469 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2470 sb!vm:n-word-bytes)))
2471 (realpart (the (complex single-float) value)))
2472 (setf (sap-ref-single
2473 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2474 sb!vm:n-word-bytes)))
2475 (imagpart (the (complex single-float) value))))
2476 (#.sb!vm:complex-double-stack-sc-number
2477 (setf (sap-ref-double
2478 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2479 sb!vm:n-word-bytes)))
2480 (realpart (the (complex double-float) value)))
2481 (setf (sap-ref-double
2482 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 4)
2483 sb!vm:n-word-bytes)))
2484 (imagpart (the (complex double-float) value))))
2486 (#.sb!vm:complex-long-stack-sc-number
2488 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2489 sb!vm:n-word-bytes)))
2490 (realpart (the (complex long-float) value)))
2492 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 6)
2493 sb!vm:n-word-bytes)))
2494 (imagpart (the (complex long-float) value))))
2495 (#.sb!vm:control-stack-sc-number
2496 (setf (stack-ref fp (sb!c:sc-offset-offset sc-offset)) value))
2497 (#.sb!vm:base-char-stack-sc-number
2498 (setf (sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2499 sb!vm:n-word-bytes)))
2500 (char-code (the character value))))
2501 (#.sb!vm:unsigned-stack-sc-number
2502 (setf (sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2503 sb!vm:n-word-bytes)))
2504 (the (unsigned-byte 32) value)))
2505 (#.sb!vm:signed-stack-sc-number
2506 (setf (signed-sap-ref-32
2507 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2508 sb!vm:n-word-bytes)))
2509 (the (signed-byte 32) value)))
2510 (#.sb!vm:sap-stack-sc-number
2511 (setf (sap-ref-sap fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2512 sb!vm:n-word-bytes)))
2513 (the system-area-pointer value))))))
2515 ;;; The method for setting and accessing COMPILED-DEBUG-VAR values use
2516 ;;; this to determine if the value stored is the actual value or an
2517 ;;; indirection cell.
2518 (defun indirect-value-cell-p (x)
2519 (and (= (lowtag-of x) sb!vm:other-pointer-lowtag)
2520 (= (widetag-of x) sb!vm:value-cell-header-widetag)))
2522 ;;; Return three values reflecting the validity of DEBUG-VAR's value
2523 ;;; at BASIC-CODE-LOCATION:
2524 ;;; :VALID The value is known to be available.
2525 ;;; :INVALID The value is known to be unavailable.
2526 ;;; :UNKNOWN The value's availability is unknown.
2528 ;;; If the variable is always alive, then it is valid. If the
2529 ;;; code-location is unknown, then the variable's validity is
2530 ;;; :unknown. Once we've called CODE-LOCATION-UNKNOWN-P, we know the
2531 ;;; live-set information has been cached in the code-location.
2532 (defun debug-var-validity (debug-var basic-code-location)
2533 (etypecase debug-var
2535 (compiled-debug-var-validity debug-var basic-code-location))
2536 ;; (There used to be more cases back before sbcl-0.7.0, when
2537 ;; we did special tricks to debug the IR1 interpreter.)
2540 ;;; This is the method for DEBUG-VAR-VALIDITY for COMPILED-DEBUG-VARs.
2541 ;;; For safety, make sure basic-code-location is what we think.
2542 (defun compiled-debug-var-validity (debug-var basic-code-location)
2543 (declare (type compiled-code-location basic-code-location))
2544 (cond ((debug-var-alive-p debug-var)
2545 (let ((debug-fun (code-location-debug-fun basic-code-location)))
2546 (if (>= (compiled-code-location-pc basic-code-location)
2547 (sb!c::compiled-debug-fun-start-pc
2548 (compiled-debug-fun-compiler-debug-fun debug-fun)))
2551 ((code-location-unknown-p basic-code-location) :unknown)
2553 (let ((pos (position debug-var
2554 (debug-fun-debug-vars
2555 (code-location-debug-fun
2556 basic-code-location)))))
2558 (error 'unknown-debug-var
2559 :debug-var debug-var
2561 (code-location-debug-fun basic-code-location)))
2562 ;; There must be live-set info since basic-code-location is known.
2563 (if (zerop (sbit (compiled-code-location-live-set
2564 basic-code-location)
2571 ;;; This code produces and uses what we call source-paths. A
2572 ;;; source-path is a list whose first element is a form number as
2573 ;;; returned by CODE-LOCATION-FORM-NUMBER and whose last element is a
2574 ;;; top level form number as returned by
2575 ;;; CODE-LOCATION-TOPLEVEL-FORM-NUMBER. The elements from the last to
2576 ;;; the first, exclusively, are the numbered subforms into which to
2577 ;;; descend. For example:
2579 ;;; (let ((a (aref x 3)))
2581 ;;; The call to AREF in this example is form number 5. Assuming this
2582 ;;; DEFUN is the 11'th top level form, the source-path for the AREF
2583 ;;; call is as follows:
2585 ;;; Given the DEFUN, 3 gets you the LET, 1 gets you the bindings, 0
2586 ;;; gets the first binding, and 1 gets the AREF form.
2588 ;;; temporary buffer used to build form-number => source-path translation in
2589 ;;; FORM-NUMBER-TRANSLATIONS
2590 (defvar *form-number-temp* (make-array 10 :fill-pointer 0 :adjustable t))
2592 ;;; table used to detect CAR circularities in FORM-NUMBER-TRANSLATIONS
2593 (defvar *form-number-circularity-table* (make-hash-table :test 'eq))
2595 ;;; This returns a table mapping form numbers to source-paths. A
2596 ;;; source-path indicates a descent into the TOPLEVEL-FORM form,
2597 ;;; going directly to the subform corressponding to the form number.
2599 ;;; The vector elements are in the same format as the compiler's
2600 ;;; NODE-SOURCE-PATH; that is, the first element is the form number and
2601 ;;; the last is the TOPLEVEL-FORM number.
2602 (defun form-number-translations (form tlf-number)
2603 (clrhash *form-number-circularity-table*)
2604 (setf (fill-pointer *form-number-temp*) 0)
2605 (sub-translate-form-numbers form (list tlf-number))
2606 (coerce *form-number-temp* 'simple-vector))
2607 (defun sub-translate-form-numbers (form path)
2608 (unless (gethash form *form-number-circularity-table*)
2609 (setf (gethash form *form-number-circularity-table*) t)
2610 (vector-push-extend (cons (fill-pointer *form-number-temp*) path)
2615 (declare (fixnum pos))
2618 (when (atom subform) (return))
2619 (let ((fm (car subform)))
2621 (sub-translate-form-numbers fm (cons pos path)))
2623 (setq subform (cdr subform))
2624 (when (eq subform trail) (return)))))
2628 (setq trail (cdr trail)))))))
2630 ;;; FORM is a top level form, and path is a source-path into it. This
2631 ;;; returns the form indicated by the source-path. Context is the
2632 ;;; number of enclosing forms to return instead of directly returning
2633 ;;; the source-path form. When context is non-zero, the form returned
2634 ;;; contains a marker, #:****HERE****, immediately before the form
2635 ;;; indicated by path.
2636 (defun source-path-context (form path context)
2637 (declare (type unsigned-byte context))
2638 ;; Get to the form indicated by path or the enclosing form indicated
2639 ;; by context and path.
2640 (let ((path (reverse (butlast (cdr path)))))
2641 (dotimes (i (- (length path) context))
2642 (let ((index (first path)))
2643 (unless (and (listp form) (< index (length form)))
2644 (error "Source path no longer exists."))
2645 (setq form (elt form index))
2646 (setq path (rest path))))
2647 ;; Recursively rebuild the source form resulting from the above
2648 ;; descent, copying the beginning of each subform up to the next
2649 ;; subform we descend into according to path. At the bottom of the
2650 ;; recursion, we return the form indicated by path preceded by our
2651 ;; marker, and this gets spliced into the resulting list structure
2652 ;; on the way back up.
2653 (labels ((frob (form path level)
2654 (if (or (zerop level) (null path))
2657 `(#:***here*** ,form))
2658 (let ((n (first path)))
2659 (unless (and (listp form) (< n (length form)))
2660 (error "Source path no longer exists."))
2661 (let ((res (frob (elt form n) (rest path) (1- level))))
2662 (nconc (subseq form 0 n)
2663 (cons res (nthcdr (1+ n) form))))))))
2664 (frob form path context))))
2666 ;;;; PREPROCESS-FOR-EVAL
2668 ;;; Return a function of one argument that evaluates form in the
2669 ;;; lexical context of the BASIC-CODE-LOCATION LOC, or signal a
2670 ;;; NO-DEBUG-VARS condition when the LOC's DEBUG-FUN has no
2671 ;;; DEBUG-VAR information available.
2673 ;;; The returned function takes the frame to get values from as its
2674 ;;; argument, and it returns the values of FORM. The returned function
2675 ;;; can signal the following conditions: INVALID-VALUE,
2676 ;;; AMBIGUOUS-VAR-NAME, and FRAME-FUN-MISMATCH.
2677 (defun preprocess-for-eval (form loc)
2678 (declare (type code-location loc))
2679 (let ((n-frame (gensym))
2680 (fun (code-location-debug-fun loc)))
2681 (unless (debug-var-info-available fun)
2682 (debug-signal 'no-debug-vars :debug-fun fun))
2683 (sb!int:collect ((binds)
2685 (do-debug-fun-vars (var fun)
2686 (let ((validity (debug-var-validity var loc)))
2687 (unless (eq validity :invalid)
2688 (let* ((sym (debug-var-symbol var))
2689 (found (assoc sym (binds))))
2691 (setf (second found) :ambiguous)
2692 (binds (list sym validity var)))))))
2693 (dolist (bind (binds))
2694 (let ((name (first bind))
2696 (ecase (second bind)
2698 (specs `(,name (debug-var-value ',var ,n-frame))))
2700 (specs `(,name (debug-signal 'invalid-value
2704 (specs `(,name (debug-signal 'ambiguous-var-name
2706 :frame ,n-frame)))))))
2707 (let ((res (coerce `(lambda (,n-frame)
2708 (declare (ignorable ,n-frame))
2709 (symbol-macrolet ,(specs) ,form))
2712 ;; This prevents these functions from being used in any
2713 ;; location other than a function return location, so maybe
2714 ;; this should only check whether FRAME's DEBUG-FUN is the
2716 (unless (code-location= (frame-code-location frame) loc)
2717 (debug-signal 'frame-fun-mismatch
2718 :code-location loc :form form :frame frame))
2719 (funcall res frame))))))
2723 ;;;; user-visible interface
2725 ;;; Create and return a breakpoint. When program execution encounters
2726 ;;; the breakpoint, the system calls HOOK-FUN. HOOK-FUN takes the
2727 ;;; current frame for the function in which the program is running and
2728 ;;; the breakpoint object.
2730 ;;; WHAT and KIND determine where in a function the system invokes
2731 ;;; HOOK-FUN. WHAT is either a code-location or a DEBUG-FUN. KIND is
2732 ;;; one of :CODE-LOCATION, :FUN-START, or :FUN-END. Since the starts
2733 ;;; and ends of functions may not have code-locations representing
2734 ;;; them, designate these places by supplying WHAT as a DEBUG-FUN and
2735 ;;; KIND indicating the :FUN-START or :FUN-END. When WHAT is a
2736 ;;; DEBUG-FUN and kind is :FUN-END, then HOOK-FUN must take two
2737 ;;; additional arguments, a list of values returned by the function
2738 ;;; and a FUN-END-COOKIE.
2740 ;;; INFO is information supplied by and used by the user.
2742 ;;; FUN-END-COOKIE is a function. To implement :FUN-END
2743 ;;; breakpoints, the system uses starter breakpoints to establish the
2744 ;;; :FUN-END breakpoint for each invocation of the function. Upon
2745 ;;; each entry, the system creates a unique cookie to identify the
2746 ;;; invocation, and when the user supplies a function for this
2747 ;;; argument, the system invokes it on the frame and the cookie. The
2748 ;;; system later invokes the :FUN-END breakpoint hook on the same
2749 ;;; cookie. The user may save the cookie for comparison in the hook
2752 ;;; Signal an error if WHAT is an unknown code-location.
2753 (defun make-breakpoint (hook-fun what
2754 &key (kind :code-location) info fun-end-cookie)
2757 (when (code-location-unknown-p what)
2758 (error "cannot make a breakpoint at an unknown code location: ~S"
2760 (aver (eq kind :code-location))
2761 (let ((bpt (%make-breakpoint hook-fun what kind info)))
2763 (compiled-code-location
2764 ;; This slot is filled in due to calling CODE-LOCATION-UNKNOWN-P.
2765 (when (eq (compiled-code-location-kind what) :unknown-return)
2766 (let ((other-bpt (%make-breakpoint hook-fun what
2767 :unknown-return-partner
2769 (setf (breakpoint-unknown-return-partner bpt) other-bpt)
2770 (setf (breakpoint-unknown-return-partner other-bpt) bpt))))
2771 ;; (There used to be more cases back before sbcl-0.7.0,,
2772 ;; when we did special tricks to debug the IR1
2779 (%make-breakpoint hook-fun what kind info))
2781 (unless (eq (sb!c::compiled-debug-fun-returns
2782 (compiled-debug-fun-compiler-debug-fun what))
2784 (error ":FUN-END breakpoints are currently unsupported ~
2785 for the known return convention."))
2787 (let* ((bpt (%make-breakpoint hook-fun what kind info))
2788 (starter (compiled-debug-fun-end-starter what)))
2790 (setf starter (%make-breakpoint #'list what :fun-start nil))
2791 (setf (breakpoint-hook-fun starter)
2792 (fun-end-starter-hook starter what))
2793 (setf (compiled-debug-fun-end-starter what) starter))
2794 (setf (breakpoint-start-helper bpt) starter)
2795 (push bpt (breakpoint-%info starter))
2796 (setf (breakpoint-cookie-fun bpt) fun-end-cookie)
2799 ;;; These are unique objects created upon entry into a function by a
2800 ;;; :FUN-END breakpoint's starter hook. These are only created
2801 ;;; when users supply :FUN-END-COOKIE to MAKE-BREAKPOINT. Also,
2802 ;;; the :FUN-END breakpoint's hook is called on the same cookie
2803 ;;; when it is created.
2804 (defstruct (fun-end-cookie
2805 (:print-object (lambda (obj str)
2806 (print-unreadable-object (obj str :type t))))
2807 (:constructor make-fun-end-cookie (bogus-lra debug-fun))
2809 ;; a pointer to the bogus-lra created for :FUN-END breakpoints
2811 ;; the DEBUG-FUN associated with this cookie
2814 ;;; This maps bogus-lra-components to cookies, so that
2815 ;;; HANDLE-FUN-END-BREAKPOINT can find the appropriate cookie for the
2816 ;;; breakpoint hook.
2817 (defvar *fun-end-cookies* (make-hash-table :test 'eq))
2819 ;;; This returns a hook function for the start helper breakpoint
2820 ;;; associated with a :FUN-END breakpoint. The returned function
2821 ;;; makes a fake LRA that all returns go through, and this piece of
2822 ;;; fake code actually breaks. Upon return from the break, the code
2823 ;;; provides the returnee with any values. Since the returned function
2824 ;;; effectively activates FUN-END-BPT on each entry to DEBUG-FUN's
2825 ;;; function, we must establish breakpoint-data about FUN-END-BPT.
2826 (defun fun-end-starter-hook (starter-bpt debug-fun)
2827 (declare (type breakpoint starter-bpt)
2828 (type compiled-debug-fun debug-fun))
2829 (lambda (frame breakpoint)
2830 (declare (ignore breakpoint)
2832 (let ((lra-sc-offset
2833 (sb!c::compiled-debug-fun-return-pc
2834 (compiled-debug-fun-compiler-debug-fun debug-fun))))
2835 (multiple-value-bind (lra component offset)
2837 (get-context-value frame
2840 (setf (get-context-value frame
2844 (let ((end-bpts (breakpoint-%info starter-bpt)))
2845 (let ((data (breakpoint-data component offset)))
2846 (setf (breakpoint-data-breakpoints data) end-bpts)
2847 (dolist (bpt end-bpts)
2848 (setf (breakpoint-internal-data bpt) data)))
2849 (let ((cookie (make-fun-end-cookie lra debug-fun)))
2850 (setf (gethash component *fun-end-cookies*) cookie)
2851 (dolist (bpt end-bpts)
2852 (let ((fun (breakpoint-cookie-fun bpt)))
2853 (when fun (funcall fun frame cookie))))))))))
2855 ;;; This takes a FUN-END-COOKIE and a frame, and it returns
2856 ;;; whether the cookie is still valid. A cookie becomes invalid when
2857 ;;; the frame that established the cookie has exited. Sometimes cookie
2858 ;;; holders are unaware of cookie invalidation because their
2859 ;;; :FUN-END breakpoint hooks didn't run due to THROW'ing.
2861 ;;; This takes a frame as an efficiency hack since the user probably
2862 ;;; has a frame object in hand when using this routine, and it saves
2863 ;;; repeated parsing of the stack and consing when asking whether a
2864 ;;; series of cookies is valid.
2865 (defun fun-end-cookie-valid-p (frame cookie)
2866 (let ((lra (fun-end-cookie-bogus-lra cookie))
2867 (lra-sc-offset (sb!c::compiled-debug-fun-return-pc
2868 (compiled-debug-fun-compiler-debug-fun
2869 (fun-end-cookie-debug-fun cookie)))))
2870 (do ((frame frame (frame-down frame)))
2872 (when (and (compiled-frame-p frame)
2873 (#!-x86 eq #!+x86 sap=
2875 (get-context-value frame lra-save-offset lra-sc-offset)))
2878 ;;;; ACTIVATE-BREAKPOINT
2880 ;;; Cause the system to invoke the breakpoint's hook function until
2881 ;;; the next call to DEACTIVATE-BREAKPOINT or DELETE-BREAKPOINT. The
2882 ;;; system invokes breakpoint hook functions in the opposite order
2883 ;;; that you activate them.
2884 (defun activate-breakpoint (breakpoint)
2885 (when (eq (breakpoint-status breakpoint) :deleted)
2886 (error "cannot activate a deleted breakpoint: ~S" breakpoint))
2887 (unless (eq (breakpoint-status breakpoint) :active)
2888 (ecase (breakpoint-kind breakpoint)
2890 (let ((loc (breakpoint-what breakpoint)))
2892 (compiled-code-location
2893 (activate-compiled-code-location-breakpoint breakpoint)
2894 (let ((other (breakpoint-unknown-return-partner breakpoint)))
2896 (activate-compiled-code-location-breakpoint other))))
2897 ;; (There used to be more cases back before sbcl-0.7.0, when
2898 ;; we did special tricks to debug the IR1 interpreter.)
2901 (etypecase (breakpoint-what breakpoint)
2903 (activate-compiled-fun-start-breakpoint breakpoint))
2904 ;; (There used to be more cases back before sbcl-0.7.0, when
2905 ;; we did special tricks to debug the IR1 interpreter.)
2908 (etypecase (breakpoint-what breakpoint)
2910 (let ((starter (breakpoint-start-helper breakpoint)))
2911 (unless (eq (breakpoint-status starter) :active)
2912 ;; may already be active by some other :FUN-END breakpoint
2913 (activate-compiled-fun-start-breakpoint starter)))
2914 (setf (breakpoint-status breakpoint) :active))
2915 ;; (There used to be more cases back before sbcl-0.7.0, when
2916 ;; we did special tricks to debug the IR1 interpreter.)
2920 (defun activate-compiled-code-location-breakpoint (breakpoint)
2921 (declare (type breakpoint breakpoint))
2922 (let ((loc (breakpoint-what breakpoint)))
2923 (declare (type compiled-code-location loc))
2924 (sub-activate-breakpoint
2926 (breakpoint-data (compiled-debug-fun-component
2927 (code-location-debug-fun loc))
2928 (+ (compiled-code-location-pc loc)
2929 (if (or (eq (breakpoint-kind breakpoint)
2930 :unknown-return-partner)
2931 (eq (compiled-code-location-kind loc)
2932 :single-value-return))
2933 sb!vm:single-value-return-byte-offset
2936 (defun activate-compiled-fun-start-breakpoint (breakpoint)
2937 (declare (type breakpoint breakpoint))
2938 (let ((debug-fun (breakpoint-what breakpoint)))
2939 (sub-activate-breakpoint
2941 (breakpoint-data (compiled-debug-fun-component debug-fun)
2942 (sb!c::compiled-debug-fun-start-pc
2943 (compiled-debug-fun-compiler-debug-fun
2946 (defun sub-activate-breakpoint (breakpoint data)
2947 (declare (type breakpoint breakpoint)
2948 (type breakpoint-data data))
2949 (setf (breakpoint-status breakpoint) :active)
2951 (unless (breakpoint-data-breakpoints data)
2952 (setf (breakpoint-data-instruction data)
2954 (breakpoint-install (get-lisp-obj-address
2955 (breakpoint-data-component data))
2956 (breakpoint-data-offset data)))))
2957 (setf (breakpoint-data-breakpoints data)
2958 (append (breakpoint-data-breakpoints data) (list breakpoint)))
2959 (setf (breakpoint-internal-data breakpoint) data)))
2961 ;;;; DEACTIVATE-BREAKPOINT
2963 ;;; Stop the system from invoking the breakpoint's hook function.
2964 (defun deactivate-breakpoint (breakpoint)
2965 (when (eq (breakpoint-status breakpoint) :active)
2967 (let ((loc (breakpoint-what breakpoint)))
2969 ((or compiled-code-location compiled-debug-fun)
2970 (deactivate-compiled-breakpoint breakpoint)
2971 (let ((other (breakpoint-unknown-return-partner breakpoint)))
2973 (deactivate-compiled-breakpoint other))))
2974 ;; (There used to be more cases back before sbcl-0.7.0, when
2975 ;; we did special tricks to debug the IR1 interpreter.)
2979 (defun deactivate-compiled-breakpoint (breakpoint)
2980 (if (eq (breakpoint-kind breakpoint) :fun-end)
2981 (let ((starter (breakpoint-start-helper breakpoint)))
2982 (unless (find-if (lambda (bpt)
2983 (and (not (eq bpt breakpoint))
2984 (eq (breakpoint-status bpt) :active)))
2985 (breakpoint-%info starter))
2986 (deactivate-compiled-breakpoint starter)))
2987 (let* ((data (breakpoint-internal-data breakpoint))
2988 (bpts (delete breakpoint (breakpoint-data-breakpoints data))))
2989 (setf (breakpoint-internal-data breakpoint) nil)
2990 (setf (breakpoint-data-breakpoints data) bpts)
2993 (breakpoint-remove (get-lisp-obj-address
2994 (breakpoint-data-component data))
2995 (breakpoint-data-offset data)
2996 (breakpoint-data-instruction data)))
2997 (delete-breakpoint-data data))))
2998 (setf (breakpoint-status breakpoint) :inactive)
3001 ;;;; BREAKPOINT-INFO
3003 ;;; Return the user-maintained info associated with breakpoint. This
3005 (defun breakpoint-info (breakpoint)
3006 (breakpoint-%info breakpoint))
3007 (defun %set-breakpoint-info (breakpoint value)
3008 (setf (breakpoint-%info breakpoint) value)
3009 (let ((other (breakpoint-unknown-return-partner breakpoint)))
3011 (setf (breakpoint-%info other) value))))
3013 ;;;; BREAKPOINT-ACTIVE-P and DELETE-BREAKPOINT
3015 (defun breakpoint-active-p (breakpoint)
3016 (ecase (breakpoint-status breakpoint)
3018 ((:inactive :deleted) nil)))
3020 ;;; Free system storage and remove computational overhead associated
3021 ;;; with breakpoint. After calling this, breakpoint is completely
3022 ;;; impotent and can never become active again.
3023 (defun delete-breakpoint (breakpoint)
3024 (let ((status (breakpoint-status breakpoint)))
3025 (unless (eq status :deleted)
3026 (when (eq status :active)
3027 (deactivate-breakpoint breakpoint))
3028 (setf (breakpoint-status breakpoint) :deleted)
3029 (let ((other (breakpoint-unknown-return-partner breakpoint)))
3031 (setf (breakpoint-status other) :deleted)))
3032 (when (eq (breakpoint-kind breakpoint) :fun-end)
3033 (let* ((starter (breakpoint-start-helper breakpoint))
3034 (breakpoints (delete breakpoint
3035 (the list (breakpoint-info starter)))))
3036 (setf (breakpoint-info starter) breakpoints)
3038 (delete-breakpoint starter)
3039 (setf (compiled-debug-fun-end-starter
3040 (breakpoint-what breakpoint))
3044 ;;;; C call out stubs
3046 ;;; This actually installs the break instruction in the component. It
3047 ;;; returns the overwritten bits. You must call this in a context in
3048 ;;; which GC is disabled, so that Lisp doesn't move objects around
3049 ;;; that C is pointing to.
3050 (sb!alien:define-alien-routine "breakpoint_install" sb!alien:unsigned-long
3051 (code-obj sb!alien:unsigned-long)
3052 (pc-offset sb!alien:int))
3054 ;;; This removes the break instruction and replaces the original
3055 ;;; instruction. You must call this in a context in which GC is disabled
3056 ;;; so Lisp doesn't move objects around that C is pointing to.
3057 (sb!alien:define-alien-routine "breakpoint_remove" sb!alien:void
3058 (code-obj sb!alien:unsigned-long)
3059 (pc-offset sb!alien:int)
3060 (old-inst sb!alien:unsigned-long))
3062 (sb!alien:define-alien-routine "breakpoint_do_displaced_inst" sb!alien:void
3063 (scp (* os-context-t))
3064 (orig-inst sb!alien:unsigned-long))
3066 ;;;; breakpoint handlers (layer between C and exported interface)
3068 ;;; This maps components to a mapping of offsets to BREAKPOINT-DATAs.
3069 (defvar *component-breakpoint-offsets* (make-hash-table :test 'eq))
3071 ;;; This returns the BREAKPOINT-DATA object associated with component cross
3072 ;;; offset. If none exists, this makes one, installs it, and returns it.
3073 (defun breakpoint-data (component offset &optional (create t))
3074 (flet ((install-breakpoint-data ()
3076 (let ((data (make-breakpoint-data component offset)))
3077 (push (cons offset data)
3078 (gethash component *component-breakpoint-offsets*))
3080 (let ((offsets (gethash component *component-breakpoint-offsets*)))
3082 (let ((data (assoc offset offsets)))
3085 (install-breakpoint-data)))
3086 (install-breakpoint-data)))))
3088 ;;; We use this when there are no longer any active breakpoints
3089 ;;; corresponding to DATA.
3090 (defun delete-breakpoint-data (data)
3091 (let* ((component (breakpoint-data-component data))
3092 (offsets (delete (breakpoint-data-offset data)
3093 (gethash component *component-breakpoint-offsets*)
3096 (setf (gethash component *component-breakpoint-offsets*) offsets)
3097 (remhash component *component-breakpoint-offsets*)))
3100 ;;; The C handler for interrupts calls this when it has a
3101 ;;; debugging-tool break instruction. This does *not* handle all
3102 ;;; breaks; for example, it does not handle breaks for internal
3104 (defun handle-breakpoint (offset component signal-context)
3105 (let ((data (breakpoint-data component offset nil)))
3107 (error "unknown breakpoint in ~S at offset ~S"
3108 (debug-fun-name (debug-fun-from-pc component offset))
3110 (let ((breakpoints (breakpoint-data-breakpoints data)))
3111 (if (or (null breakpoints)
3112 (eq (breakpoint-kind (car breakpoints)) :fun-end))
3113 (handle-fun-end-breakpoint-aux breakpoints data signal-context)
3114 (handle-breakpoint-aux breakpoints data
3115 offset component signal-context)))))
3117 ;;; This holds breakpoint-datas while invoking the breakpoint hooks
3118 ;;; associated with that particular component and location. While they
3119 ;;; are executing, if we hit the location again, we ignore the
3120 ;;; breakpoint to avoid infinite recursion. fun-end breakpoints
3121 ;;; must work differently since the breakpoint-data is unique for each
3123 (defvar *executing-breakpoint-hooks* nil)
3125 ;;; This handles code-location and DEBUG-FUN :FUN-START
3127 (defun handle-breakpoint-aux (breakpoints data offset component signal-context)
3129 (bug "breakpoint that nobody wants"))
3130 (unless (member data *executing-breakpoint-hooks*)
3131 (let ((*executing-breakpoint-hooks* (cons data
3132 *executing-breakpoint-hooks*)))
3133 (invoke-breakpoint-hooks breakpoints component offset)))
3134 ;; At this point breakpoints may not hold the same list as
3135 ;; BREAKPOINT-DATA-BREAKPOINTS since invoking hooks may have allowed
3136 ;; a breakpoint deactivation. In fact, if all breakpoints were
3137 ;; deactivated then data is invalid since it was deleted and so the
3138 ;; correct one must be looked up if it is to be used. If there are
3139 ;; no more breakpoints active at this location, then the normal
3140 ;; instruction has been put back, and we do not need to
3141 ;; DO-DISPLACED-INST.
3142 (let ((data (breakpoint-data component offset nil)))
3143 (when (and data (breakpoint-data-breakpoints data))
3144 ;; The breakpoint is still active, so we need to execute the
3145 ;; displaced instruction and leave the breakpoint instruction
3146 ;; behind. The best way to do this is different on each machine,
3147 ;; so we just leave it up to the C code.
3148 (breakpoint-do-displaced-inst signal-context
3149 (breakpoint-data-instruction data))
3150 ;; Some platforms have no usable sigreturn() call. If your
3151 ;; implementation of arch_do_displaced_inst() _does_ sigreturn(),
3152 ;; it's polite to warn here
3153 #!+(and sparc solaris)
3154 (error "BREAKPOINT-DO-DISPLACED-INST returned?"))))
3156 (defun invoke-breakpoint-hooks (breakpoints component offset)
3157 (let* ((debug-fun (debug-fun-from-pc component offset))
3158 (frame (do ((f (top-frame) (frame-down f)))
3159 ((eq debug-fun (frame-debug-fun f)) f))))
3160 (dolist (bpt breakpoints)
3161 (funcall (breakpoint-hook-fun bpt)
3163 ;; If this is an :UNKNOWN-RETURN-PARTNER, then pass the
3164 ;; hook function the original breakpoint, so that users
3165 ;; aren't forced to confront the fact that some
3166 ;; breakpoints really are two.
3167 (if (eq (breakpoint-kind bpt) :unknown-return-partner)
3168 (breakpoint-unknown-return-partner bpt)
3171 (defun handle-fun-end-breakpoint (offset component context)
3172 (let ((data (breakpoint-data component offset nil)))
3174 (error "unknown breakpoint in ~S at offset ~S"
3175 (debug-fun-name (debug-fun-from-pc component offset))
3177 (let ((breakpoints (breakpoint-data-breakpoints data)))
3179 (aver (eq (breakpoint-kind (car breakpoints)) :fun-end))
3180 (handle-fun-end-breakpoint-aux breakpoints data context)))))
3182 ;;; Either HANDLE-BREAKPOINT calls this for :FUN-END breakpoints
3183 ;;; [old C code] or HANDLE-FUN-END-BREAKPOINT calls this directly
3185 (defun handle-fun-end-breakpoint-aux (breakpoints data signal-context)
3186 (delete-breakpoint-data data)
3189 (declare (optimize (inhibit-warnings 3)))
3190 (sb!alien:sap-alien signal-context (* os-context-t))))
3191 (frame (do ((cfp (sb!vm:context-register scp sb!vm::cfp-offset))
3192 (f (top-frame) (frame-down f)))
3193 ((= cfp (sap-int (frame-pointer f))) f)
3194 (declare (type (unsigned-byte #.sb!vm:n-word-bits) cfp))))
3195 (component (breakpoint-data-component data))
3196 (cookie (gethash component *fun-end-cookies*)))
3197 (remhash component *fun-end-cookies*)
3198 (dolist (bpt breakpoints)
3199 (funcall (breakpoint-hook-fun bpt)
3201 (get-fun-end-breakpoint-values scp)
3204 (defun get-fun-end-breakpoint-values (scp)
3205 (let ((ocfp (int-sap (sb!vm:context-register
3207 #!-x86 sb!vm::ocfp-offset
3208 #!+x86 sb!vm::ebx-offset)))
3209 (nargs (make-lisp-obj
3210 (sb!vm:context-register scp sb!vm::nargs-offset)))
3211 (reg-arg-offsets '#.sb!vm::*register-arg-offsets*)
3214 (dotimes (arg-num nargs)
3215 (push (if reg-arg-offsets
3217 (sb!vm:context-register scp (pop reg-arg-offsets)))
3218 (stack-ref ocfp arg-num))
3220 (nreverse results)))
3222 ;;;; MAKE-BOGUS-LRA (used for :FUN-END breakpoints)
3224 (defconstant bogus-lra-constants
3226 (defconstant known-return-p-slot
3227 (+ sb!vm:code-constants-offset #!-x86 1 #!+x86 2))
3229 ;;; Make a bogus LRA object that signals a breakpoint trap when
3230 ;;; returned to. If the breakpoint trap handler returns, REAL-LRA is
3231 ;;; returned to. Three values are returned: the bogus LRA object, the
3232 ;;; code component it is part of, and the PC offset for the trap
3234 (defun make-bogus-lra (real-lra &optional known-return-p)
3236 (let* ((src-start (foreign-symbol-address "fun_end_breakpoint_guts"))
3237 (src-end (foreign-symbol-address "fun_end_breakpoint_end"))
3238 (trap-loc (foreign-symbol-address "fun_end_breakpoint_trap"))
3239 (length (sap- src-end src-start))
3242 #!-(and x86 gencgc) sb!c:allocate-code-object
3243 #!+(and x86 gencgc) sb!c::allocate-dynamic-code-object
3244 (1+ bogus-lra-constants)
3246 (dst-start (code-instructions code-object)))
3247 (declare (type system-area-pointer
3248 src-start src-end dst-start trap-loc)
3249 (type index length))
3250 (setf (%code-debug-info code-object) :bogus-lra)
3251 (setf (code-header-ref code-object sb!vm:code-trace-table-offset-slot)
3254 (setf (code-header-ref code-object real-lra-slot) real-lra)
3256 (multiple-value-bind (offset code) (compute-lra-data-from-pc real-lra)
3257 (setf (code-header-ref code-object real-lra-slot) code)
3258 (setf (code-header-ref code-object (1+ real-lra-slot)) offset))
3259 (setf (code-header-ref code-object known-return-p-slot)
3261 (system-area-copy src-start 0 dst-start 0 (* length sb!vm:n-byte-bits))
3262 (sb!vm:sanctify-for-execution code-object)
3264 (values dst-start code-object (sap- trap-loc src-start))
3266 (let ((new-lra (make-lisp-obj (+ (sap-int dst-start)
3267 sb!vm:other-pointer-lowtag))))
3270 (logandc2 (+ sb!vm:code-constants-offset bogus-lra-constants 1)
3272 (sb!vm:sanctify-for-execution code-object)
3273 (values new-lra code-object (sap- trap-loc src-start))))))
3277 ;;; This appears here because it cannot go with the DEBUG-FUN
3278 ;;; interface since DO-DEBUG-BLOCK-LOCATIONS isn't defined until after
3279 ;;; the DEBUG-FUN routines.
3281 ;;; Return a code-location before the body of a function and after all
3282 ;;; the arguments are in place; or if that location can't be
3283 ;;; determined due to a lack of debug information, return NIL.
3284 (defun debug-fun-start-location (debug-fun)
3285 (etypecase debug-fun
3287 (code-location-from-pc debug-fun
3288 (sb!c::compiled-debug-fun-start-pc
3289 (compiled-debug-fun-compiler-debug-fun
3292 ;; (There used to be more cases back before sbcl-0.7.0, when
3293 ;; we did special tricks to debug the IR1 interpreter.)
3296 (defun print-code-locations (function)
3297 (let ((debug-fun (fun-debug-fun function)))
3298 (do-debug-fun-blocks (block debug-fun)
3299 (do-debug-block-locations (loc block)
3300 (fill-in-code-location loc)
3301 (format t "~S code location at ~W"
3302 (compiled-code-location-kind loc)
3303 (compiled-code-location-pc loc))
3304 (sb!debug::print-code-location-source-form loc 0)