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)))))
545 (sb!alien:define-alien-routine component-ptr-from-pc (system-area-pointer)
546 (pc system-area-pointer))
548 (defun component-from-component-ptr (component-ptr)
549 (declare (type system-area-pointer component-ptr))
550 (make-lisp-obj (logior (sap-int component-ptr)
551 sb!vm:other-pointer-lowtag)))
558 (defun compute-lra-data-from-pc (pc)
559 (declare (type system-area-pointer pc))
560 (let ((component-ptr (component-ptr-from-pc pc)))
561 (unless (sap= component-ptr (int-sap #x0))
562 (let* ((code (component-from-component-ptr component-ptr))
563 (code-header-len (* (get-header-data code) sb!vm:n-word-bytes))
564 (pc-offset (- (sap-int pc)
565 (- (get-lisp-obj-address code)
566 sb!vm:other-pointer-lowtag)
568 ; (format t "c-lra-fpc ~A ~A ~A~%" pc code pc-offset)
569 (values pc-offset code)))))
571 (defconstant sb!vm::nargs-offset #.sb!vm::ecx-offset)
573 ;;; Check for a valid return address - it could be any valid C/Lisp
576 ;;; XXX Could be a little smarter.
577 #!-sb-fluid (declaim (inline ra-pointer-valid-p))
578 (defun ra-pointer-valid-p (ra)
579 (declare (type system-area-pointer ra))
581 ;; not the first page (which is unmapped)
583 ;; FIXME: Where is this documented? Is it really true of every CPU
584 ;; architecture? Is it even necessarily true in current SBCL?
585 (>= (sap-int ra) 4096)
586 ;; not a Lisp stack pointer
587 (not (control-stack-pointer-valid-p ra))))
589 ;;; Try to find a valid previous stack. This is complex on the x86 as
590 ;;; it can jump between C and Lisp frames. To help find a valid frame
591 ;;; it searches backwards.
593 ;;; XXX Should probably check whether it has reached the bottom of the
596 ;;; XXX Should handle interrupted frames, both Lisp and C. At present
597 ;;; it manages to find a fp trail, see linux hack below.
598 (defun x86-call-context (fp &key (depth 0))
599 (declare (type system-area-pointer fp)
601 ;;(format t "*CC ~S ~S~%" fp depth)
603 ((not (control-stack-pointer-valid-p fp))
604 #+nil (format t "debug invalid fp ~S~%" fp)
607 ;; Check the two possible frame pointers.
608 (let ((lisp-ocfp (sap-ref-sap fp (- (* (1+ ocfp-save-offset) 4))))
609 (lisp-ra (sap-ref-sap fp (- (* (1+ return-pc-save-offset)
611 (c-ocfp (sap-ref-sap fp (* 0 sb!vm:n-word-bytes)))
612 (c-ra (sap-ref-sap fp (* 1 sb!vm:n-word-bytes))))
613 (cond ((and (sap> lisp-ocfp fp) (control-stack-pointer-valid-p lisp-ocfp)
614 (ra-pointer-valid-p lisp-ra)
615 (sap> c-ocfp fp) (control-stack-pointer-valid-p c-ocfp)
616 (ra-pointer-valid-p c-ra))
618 "*C Both valid ~S ~S ~S ~S~%"
619 lisp-ocfp lisp-ra c-ocfp c-ra)
620 ;; Look forward another step to check their validity.
621 (let ((lisp-path-fp (x86-call-context lisp-ocfp
623 (c-path-fp (x86-call-context c-ocfp :depth (1+ depth))))
624 (cond ((and lisp-path-fp c-path-fp)
625 ;; Both still seem valid - choose the lisp frame.
626 #+nil (when (zerop depth)
628 "debug: both still valid ~S ~S ~S ~S~%"
629 lisp-ocfp lisp-ra c-ocfp c-ra))
631 (if (sap> lisp-ocfp c-ocfp)
632 (values lisp-ra lisp-ocfp)
633 (values c-ra c-ocfp))
635 (values lisp-ra lisp-ocfp))
637 ;; The lisp convention is looking good.
638 #+nil (format t "*C lisp-ocfp ~S ~S~%" lisp-ocfp lisp-ra)
639 (values lisp-ra lisp-ocfp))
641 ;; The C convention is looking good.
642 #+nil (format t "*C c-ocfp ~S ~S~%" c-ocfp c-ra)
643 (values c-ra c-ocfp))
645 ;; Neither seems right?
646 #+nil (format t "debug: no valid2 fp found ~S ~S~%"
649 ((and (sap> lisp-ocfp fp) (control-stack-pointer-valid-p lisp-ocfp)
650 (ra-pointer-valid-p lisp-ra))
651 ;; The lisp convention is looking good.
652 #+nil (format t "*C lisp-ocfp ~S ~S~%" lisp-ocfp lisp-ra)
653 (values lisp-ra lisp-ocfp))
654 ((and (sap> c-ocfp fp) (control-stack-pointer-valid-p c-ocfp)
655 #!-linux (ra-pointer-valid-p c-ra))
656 ;; The C convention is looking good.
657 #+nil (format t "*C c-ocfp ~S ~S~%" c-ocfp c-ra)
658 (values c-ra c-ocfp))
660 #+nil (format t "debug: no valid fp found ~S ~S~%"
666 ;;; Convert the descriptor into a SAP. The bits all stay the same, we just
667 ;;; change our notion of what we think they are.
668 #!-sb-fluid (declaim (inline descriptor-sap))
669 (defun descriptor-sap (x)
670 (int-sap (get-lisp-obj-address x)))
672 ;;; Return the top frame of the control stack as it was before calling
675 (/noshow0 "entering TOP-FRAME")
676 (multiple-value-bind (fp pc) (%caller-frame-and-pc)
677 (compute-calling-frame (descriptor-sap fp) pc nil)))
679 ;;; Flush all of the frames above FRAME, and renumber all the frames
681 (defun flush-frames-above (frame)
682 (setf (frame-up frame) nil)
683 (do ((number 0 (1+ number))
684 (frame frame (frame-%down frame)))
685 ((not (frame-p frame)))
686 (setf (frame-number frame) number)))
688 ;;; Return the frame immediately below FRAME on the stack; or when
689 ;;; FRAME is the bottom of the stack, return NIL.
690 (defun frame-down (frame)
691 (/noshow0 "entering FRAME-DOWN")
692 ;; We have to access the old-fp and return-pc out of frame and pass
693 ;; them to COMPUTE-CALLING-FRAME.
694 (let ((down (frame-%down frame)))
695 (if (eq down :unparsed)
696 (let ((debug-fun (frame-debug-fun frame)))
697 (/noshow0 "in DOWN :UNPARSED case")
698 (setf (frame-%down frame)
701 (let ((c-d-f (compiled-debug-fun-compiler-debug-fun
703 (compute-calling-frame
706 frame ocfp-save-offset
707 (sb!c::compiled-debug-fun-old-fp c-d-f)))
709 frame lra-save-offset
710 (sb!c::compiled-debug-fun-return-pc c-d-f))
713 (let ((fp (frame-pointer frame)))
714 (when (control-stack-pointer-valid-p fp)
716 (multiple-value-bind (ra ofp) (x86-call-context fp)
717 (and ra (compute-calling-frame ofp ra frame)))
719 (compute-calling-frame
721 (sap-ref-sap fp (* ocfp-save-offset
725 (sap-ref-32 fp (* ocfp-save-offset
726 sb!vm:n-word-bytes)))
728 (stack-ref fp lra-save-offset)
733 ;;; Get the old FP or return PC out of FRAME. STACK-SLOT is the
734 ;;; standard save location offset on the stack. LOC is the saved
735 ;;; SC-OFFSET describing the main location.
737 (defun get-context-value (frame stack-slot loc)
738 (declare (type compiled-frame frame) (type unsigned-byte stack-slot)
739 (type sb!c:sc-offset loc))
740 (let ((pointer (frame-pointer frame))
741 (escaped (compiled-frame-escaped frame)))
743 (sub-access-debug-var-slot pointer loc escaped)
744 (stack-ref pointer stack-slot))))
746 (defun get-context-value (frame stack-slot loc)
747 (declare (type compiled-frame frame) (type unsigned-byte stack-slot)
748 (type sb!c:sc-offset loc))
749 (let ((pointer (frame-pointer frame))
750 (escaped (compiled-frame-escaped frame)))
752 (sub-access-debug-var-slot pointer loc escaped)
755 (stack-ref pointer stack-slot))
757 (sap-ref-sap pointer (- (* (1+ stack-slot) 4))))))))
760 (defun (setf get-context-value) (value frame stack-slot loc)
761 (declare (type compiled-frame frame) (type unsigned-byte stack-slot)
762 (type sb!c:sc-offset loc))
763 (let ((pointer (frame-pointer frame))
764 (escaped (compiled-frame-escaped frame)))
766 (sub-set-debug-var-slot pointer loc value escaped)
767 (setf (stack-ref pointer stack-slot) value))))
770 (defun (setf get-context-value) (value frame stack-slot loc)
771 (declare (type compiled-frame frame) (type unsigned-byte stack-slot)
772 (type sb!c:sc-offset loc))
773 (let ((pointer (frame-pointer frame))
774 (escaped (compiled-frame-escaped frame)))
776 (sub-set-debug-var-slot pointer loc value escaped)
779 (setf (stack-ref pointer stack-slot) value))
781 (setf (sap-ref-sap pointer (- (* (1+ stack-slot) 4))) value))))))
783 (defun foreign-function-debug-name (sap)
784 (multiple-value-bind (name file base offset) (foreign-symbol-in-address sap)
786 (format nil "foreign function: ~A [~A: #x~X + #x~X]" name file base offset)
787 (format nil "foreign function: #x~X" (sap-int sap)))))
789 ;;; This returns a frame for the one existing in time immediately
790 ;;; prior to the frame referenced by current-fp. This is current-fp's
791 ;;; caller or the next frame down the control stack. If there is no
792 ;;; down frame, this returns NIL for the bottom of the stack. UP-FRAME
793 ;;; is the up link for the resulting frame object, and it is null when
794 ;;; we call this to get the top of the stack.
796 ;;; The current frame contains the pointer to the temporally previous
797 ;;; frame we want, and the current frame contains the pc at which we
798 ;;; will continue executing upon returning to that previous frame.
800 ;;; Note: Sometimes LRA is actually a fixnum. This happens when lisp
801 ;;; calls into C. In this case, the code object is stored on the stack
802 ;;; after the LRA, and the LRA is the word offset.
804 (defun compute-calling-frame (caller lra up-frame)
805 (declare (type system-area-pointer caller))
806 (when (control-stack-pointer-valid-p caller)
807 (multiple-value-bind (code pc-offset escaped)
809 (multiple-value-bind (word-offset code)
811 (let ((fp (frame-pointer up-frame)))
813 (stack-ref fp (1+ lra-save-offset))))
814 (values (get-header-data lra)
815 (lra-code-header lra)))
818 (* (1+ (- word-offset (get-header-data code)))
821 (values :foreign-function
824 (find-escaped-frame caller))
825 (if (and (code-component-p code)
826 (eq (%code-debug-info code) :bogus-lra))
827 (let ((real-lra (code-header-ref code real-lra-slot)))
828 (compute-calling-frame caller real-lra up-frame))
829 (let ((d-fun (case code
831 (make-bogus-debug-fun
832 "undefined function"))
834 (make-bogus-debug-fun
835 (foreign-function-debug-name (int-sap (get-lisp-obj-address lra)))))
837 (make-bogus-debug-fun
838 "bogus stack frame"))
840 (debug-fun-from-pc code pc-offset)))))
841 (make-compiled-frame caller up-frame d-fun
842 (code-location-from-pc d-fun pc-offset
844 (if up-frame (1+ (frame-number up-frame)) 0)
847 (defun compute-calling-frame (caller ra up-frame)
848 (declare (type system-area-pointer caller ra))
849 (/noshow0 "entering COMPUTE-CALLING-FRAME")
850 (when (control-stack-pointer-valid-p caller)
852 ;; First check for an escaped frame.
853 (multiple-value-bind (code pc-offset escaped) (find-escaped-frame caller)
856 (/noshow0 "in CODE clause")
857 ;; If it's escaped it may be a function end breakpoint trap.
858 (when (and (code-component-p code)
859 (eq (%code-debug-info code) :bogus-lra))
860 ;; If :bogus-lra grab the real lra.
861 (setq pc-offset (code-header-ref
862 code (1+ real-lra-slot)))
863 (setq code (code-header-ref code real-lra-slot))
866 (/noshow0 "in T clause")
868 (multiple-value-setq (pc-offset code)
869 (compute-lra-data-from-pc ra))
871 (setf code :foreign-function
875 (let ((d-fun (case code
877 (make-bogus-debug-fun
878 "undefined function"))
880 (make-bogus-debug-fun (foreign-function-debug-name ra)))
882 (make-bogus-debug-fun
883 "bogus stack frame"))
885 (debug-fun-from-pc code pc-offset)))))
886 (/noshow0 "returning MAKE-COMPILED-FRAME from COMPUTE-CALLING-FRAME")
887 (make-compiled-frame caller up-frame d-fun
888 (code-location-from-pc d-fun pc-offset
890 (if up-frame (1+ (frame-number up-frame)) 0)
893 (defun nth-interrupt-context (n)
894 (declare (type (unsigned-byte 32) n)
895 (optimize (speed 3) (safety 0)))
896 (sb!alien:sap-alien (sb!vm::current-thread-offset-sap
897 (+ sb!vm::thread-interrupt-contexts-offset n))
901 (defun find-escaped-frame (frame-pointer)
902 (declare (type system-area-pointer frame-pointer))
903 (/noshow0 "entering FIND-ESCAPED-FRAME")
904 (dotimes (index *free-interrupt-context-index* (values nil 0 nil))
905 (/noshow0 "at head of WITH-ALIEN")
906 (let ((context (nth-interrupt-context index)))
907 (/noshow0 "got CONTEXT")
908 (when (= (sap-int frame-pointer)
909 (sb!vm:context-register context sb!vm::cfp-offset))
911 (/noshow0 "in WITHOUT-GCING")
912 (let* ((component-ptr (component-ptr-from-pc
913 (sb!vm:context-pc context)))
914 (code (unless (sap= component-ptr (int-sap #x0))
915 (component-from-component-ptr component-ptr))))
916 (/noshow0 "got CODE")
918 (return (values code 0 context)))
919 (let* ((code-header-len (* (get-header-data code)
922 (- (sap-int (sb!vm:context-pc context))
923 (- (get-lisp-obj-address code)
924 sb!vm:other-pointer-lowtag)
926 (/noshow "got PC-OFFSET")
927 (unless (<= 0 pc-offset
928 (* (code-header-ref code sb!vm:code-code-size-slot)
930 ;; We were in an assembly routine. Therefore, use the
933 ;; FIXME: Should this be WARN or ERROR or what?
934 (format t "** pc-offset ~S not in code obj ~S?~%"
936 (/noshow0 "returning from FIND-ESCAPED-FRAME")
938 (values code pc-offset context)))))))))
941 (defun find-escaped-frame (frame-pointer)
942 (declare (type system-area-pointer frame-pointer))
943 (dotimes (index *free-interrupt-context-index* (values nil 0 nil))
944 (let ((scp (nth-interrupt-context index)))
945 (when (= (sap-int frame-pointer)
946 (sb!vm:context-register scp sb!vm::cfp-offset))
948 (let ((code (code-object-from-bits
949 (sb!vm:context-register scp sb!vm::code-offset))))
951 (return (values code 0 scp)))
952 (let* ((code-header-len (* (get-header-data code)
955 (- (sap-int (sb!vm:context-pc scp))
956 (- (get-lisp-obj-address code)
957 sb!vm:other-pointer-lowtag)
959 ;; Check to see whether we were executing in a branch
961 #!+(or pmax sgi) ; pmax only (and broken anyway)
962 (when (logbitp 31 (sb!alien:slot scp '%mips::sc-cause))
963 (incf pc-offset sb!vm:n-word-bytes))
964 (let ((code-size (* (code-header-ref code
965 sb!vm:code-code-size-slot)
966 sb!vm:n-word-bytes)))
967 (unless (<= 0 pc-offset code-size)
968 ;; We were in an assembly routine.
969 (multiple-value-bind (new-pc-offset computed-return)
970 (find-pc-from-assembly-fun code scp)
971 (setf pc-offset new-pc-offset)
972 (unless (<= 0 pc-offset code-size)
974 "Set PC-OFFSET to zero and continue backtrace."
977 "~@<PC-OFFSET (~D) not in code object. Frame details:~
978 ~2I~:@_PC: #X~X~:@_CODE: ~S~:@_CODE FUN: ~S~:@_LRA: ~
979 #X~X~:@_COMPUTED RETURN: #X~X.~:>"
982 (sap-int (sb!vm:context-pc scp))
984 (%code-entry-points code)
985 (sb!vm:context-register scp sb!vm::lra-offset)
987 ;; We failed to pinpoint where PC is, but set
988 ;; pc-offset to 0 to keep the backtrace from
990 (setf pc-offset 0)))))
992 (if (eq (%code-debug-info code) :bogus-lra)
993 (let ((real-lra (code-header-ref code
995 (values (lra-code-header real-lra)
996 (get-header-data real-lra)
998 (values code pc-offset scp))))))))))
1001 (defun find-pc-from-assembly-fun (code scp)
1002 "Finds the PC for the return from an assembly routine properly.
1003 For some architectures (such as PPC) this will not be the $LRA
1005 (let ((return-machine-address
1006 ;; This conditional logic should probably go into
1007 ;; architecture specific files somehow.
1008 #!+ppc (sap-int (sb!vm::context-lr scp))
1009 #!+sparc (+ (sb!vm:context-register scp sb!vm::lip-offset) 8)
1010 #!-(or ppc sparc) (- (sb!vm:context-register scp sb!vm::lra-offset)
1011 sb!vm:other-pointer-lowtag))
1012 (code-header-len (* (get-header-data code)
1013 sb!vm:n-word-bytes)))
1014 (values (- return-machine-address
1015 (- (get-lisp-obj-address code)
1016 sb!vm:other-pointer-lowtag)
1018 return-machine-address)))
1020 ;;; Find the code object corresponding to the object represented by
1021 ;;; bits and return it. We assume bogus functions correspond to the
1022 ;;; undefined-function.
1023 (defun code-object-from-bits (bits)
1024 (declare (type (unsigned-byte 32) bits))
1025 (let ((object (make-lisp-obj bits)))
1026 (if (functionp object)
1027 (or (fun-code-header object)
1028 :undefined-function)
1029 (let ((lowtag (lowtag-of object)))
1030 (if (= lowtag sb!vm:other-pointer-lowtag)
1031 (let ((widetag (widetag-of object)))
1032 (cond ((= widetag sb!vm:code-header-widetag)
1034 ((= widetag sb!vm:return-pc-header-widetag)
1035 (lra-code-header object))
1039 ;;;; frame utilities
1041 ;;; This returns a COMPILED-DEBUG-FUN for COMPONENT and PC. We fetch the
1042 ;;; SB!C::DEBUG-INFO and run down its FUN-MAP to get a
1043 ;;; SB!C::COMPILED-DEBUG-FUN from the PC. The result only needs to
1044 ;;; reference the COMPONENT, for function constants, and the
1045 ;;; SB!C::COMPILED-DEBUG-FUN.
1046 (defun debug-fun-from-pc (component pc)
1047 (let ((info (%code-debug-info component)))
1050 (debug-signal 'no-debug-info :code-component component))
1051 ((eq info :bogus-lra)
1052 (make-bogus-debug-fun "function end breakpoint"))
1054 (let* ((fun-map (sb!c::compiled-debug-info-fun-map info))
1055 (len (length fun-map)))
1056 (declare (type simple-vector fun-map))
1058 (make-compiled-debug-fun (svref fun-map 0) component)
1061 (>= pc (sb!c::compiled-debug-fun-elsewhere-pc
1062 (svref fun-map 0)))))
1063 (declare (type sb!int:index i))
1066 (< pc (if elsewhere-p
1067 (sb!c::compiled-debug-fun-elsewhere-pc
1068 (svref fun-map (1+ i)))
1069 (svref fun-map i))))
1070 (return (make-compiled-debug-fun
1071 (svref fun-map (1- i))
1075 ;;; This returns a code-location for the COMPILED-DEBUG-FUN,
1076 ;;; DEBUG-FUN, and the pc into its code vector. If we stopped at a
1077 ;;; breakpoint, find the CODE-LOCATION for that breakpoint. Otherwise,
1078 ;;; make an :UNSURE code location, so it can be filled in when we
1079 ;;; figure out what is going on.
1080 (defun code-location-from-pc (debug-fun pc escaped)
1081 (or (and (compiled-debug-fun-p debug-fun)
1083 (let ((data (breakpoint-data
1084 (compiled-debug-fun-component debug-fun)
1086 (when (and data (breakpoint-data-breakpoints data))
1087 (let ((what (breakpoint-what
1088 (first (breakpoint-data-breakpoints data)))))
1089 (when (compiled-code-location-p what)
1091 (make-compiled-code-location pc debug-fun)))
1093 ;;; Return an alist mapping catch tags to CODE-LOCATIONs. These are
1094 ;;; CODE-LOCATIONs at which execution would continue with frame as the
1095 ;;; top frame if someone threw to the corresponding tag.
1096 (defun frame-catches (frame)
1097 (let ((catch (descriptor-sap sb!vm:*current-catch-block*))
1098 (reversed-result nil)
1099 (fp (frame-pointer frame)))
1100 (loop until (zerop (sap-int catch))
1101 finally (return (nreverse reversed-result))
1106 (* sb!vm:catch-block-current-cont-slot
1107 sb!vm:n-word-bytes))
1111 (* sb!vm:catch-block-current-cont-slot
1112 sb!vm:n-word-bytes))))
1114 (lra (stack-ref catch sb!vm:catch-block-entry-pc-slot))
1117 catch (* sb!vm:catch-block-entry-pc-slot
1118 sb!vm:n-word-bytes)))
1121 (stack-ref catch sb!vm:catch-block-current-code-slot))
1123 (component (component-from-component-ptr
1124 (component-ptr-from-pc ra)))
1127 (* (- (1+ (get-header-data lra))
1128 (get-header-data component))
1132 (- (get-lisp-obj-address component)
1133 sb!vm:other-pointer-lowtag)
1134 (* (get-header-data component) sb!vm:n-word-bytes))))
1136 (stack-ref catch sb!vm:catch-block-tag-slot)
1139 (sap-ref-32 catch (* sb!vm:catch-block-tag-slot
1140 sb!vm:n-word-bytes)))
1141 (make-compiled-code-location
1142 offset (frame-debug-fun frame)))
1147 (* sb!vm:catch-block-previous-catch-slot
1148 sb!vm:n-word-bytes))
1152 (* sb!vm:catch-block-previous-catch-slot
1153 sb!vm:n-word-bytes)))))))
1155 ;;;; operations on DEBUG-FUNs
1157 ;;; Execute the forms in a context with BLOCK-VAR bound to each
1158 ;;; DEBUG-BLOCK in DEBUG-FUN successively. Result is an optional
1159 ;;; form to execute for return values, and DO-DEBUG-FUN-BLOCKS
1160 ;;; returns nil if there is no result form. This signals a
1161 ;;; NO-DEBUG-BLOCKS condition when the DEBUG-FUN lacks
1162 ;;; DEBUG-BLOCK information.
1163 (defmacro do-debug-fun-blocks ((block-var debug-fun &optional result)
1165 (let ((blocks (gensym))
1167 `(let ((,blocks (debug-fun-debug-blocks ,debug-fun)))
1168 (declare (simple-vector ,blocks))
1169 (dotimes (,i (length ,blocks) ,result)
1170 (let ((,block-var (svref ,blocks ,i)))
1173 ;;; Execute body in a context with VAR bound to each DEBUG-VAR in
1174 ;;; DEBUG-FUN. This returns the value of executing result (defaults to
1175 ;;; nil). This may iterate over only some of DEBUG-FUN's variables or
1176 ;;; none depending on debug policy; for example, possibly the
1177 ;;; compilation only preserved argument information.
1178 (defmacro do-debug-fun-vars ((var debug-fun &optional result) &body body)
1179 (let ((vars (gensym))
1181 `(let ((,vars (debug-fun-debug-vars ,debug-fun)))
1182 (declare (type (or null simple-vector) ,vars))
1184 (dotimes (,i (length ,vars) ,result)
1185 (let ((,var (svref ,vars ,i)))
1189 ;;; Return the object of type FUNCTION associated with the DEBUG-FUN,
1190 ;;; or NIL if the function is unavailable or is non-existent as a user
1191 ;;; callable function object.
1192 (defun debug-fun-fun (debug-fun)
1193 (let ((cached-value (debug-fun-%function debug-fun)))
1194 (if (eq cached-value :unparsed)
1195 (setf (debug-fun-%function debug-fun)
1196 (etypecase debug-fun
1199 (compiled-debug-fun-component debug-fun))
1201 (sb!c::compiled-debug-fun-start-pc
1202 (compiled-debug-fun-compiler-debug-fun debug-fun))))
1203 (do ((entry (%code-entry-points component)
1204 (%simple-fun-next entry)))
1207 (sb!c::compiled-debug-fun-start-pc
1208 (compiled-debug-fun-compiler-debug-fun
1209 (fun-debug-fun entry))))
1211 (bogus-debug-fun nil)))
1214 ;;; Return the name of the function represented by DEBUG-FUN. This may
1215 ;;; be a string or a cons; do not assume it is a symbol.
1216 (defun debug-fun-name (debug-fun)
1217 (declare (type debug-fun debug-fun))
1218 (etypecase debug-fun
1220 (sb!c::compiled-debug-fun-name
1221 (compiled-debug-fun-compiler-debug-fun debug-fun)))
1223 (bogus-debug-fun-%name debug-fun))))
1225 ;;; Return a DEBUG-FUN that represents debug information for FUN.
1226 (defun fun-debug-fun (fun)
1227 (declare (type function fun))
1228 (ecase (widetag-of fun)
1229 (#.sb!vm:closure-header-widetag
1230 (fun-debug-fun (%closure-fun fun)))
1231 (#.sb!vm:funcallable-instance-header-widetag
1232 (fun-debug-fun (funcallable-instance-fun fun)))
1233 (#.sb!vm:simple-fun-header-widetag
1234 (let* ((name (%simple-fun-name fun))
1235 (component (fun-code-header fun))
1238 (and (sb!c::compiled-debug-fun-p x)
1239 (eq (sb!c::compiled-debug-fun-name x) name)
1240 (eq (sb!c::compiled-debug-fun-kind x) nil)))
1241 (sb!c::compiled-debug-info-fun-map
1242 (%code-debug-info component)))))
1244 (make-compiled-debug-fun res component)
1245 ;; KLUDGE: comment from CMU CL:
1246 ;; This used to be the non-interpreted branch, but
1247 ;; William wrote it to return the debug-fun of fun's XEP
1248 ;; instead of fun's debug-fun. The above code does this
1249 ;; more correctly, but it doesn't get or eliminate all
1250 ;; appropriate cases. It mostly works, and probably
1251 ;; works for all named functions anyway.
1253 (debug-fun-from-pc component
1254 (* (- (fun-word-offset fun)
1255 (get-header-data component))
1256 sb!vm:n-word-bytes)))))))
1258 ;;; Return the kind of the function, which is one of :OPTIONAL,
1259 ;;; :EXTERNAL, :TOPLEVEL, :CLEANUP, or NIL.
1260 (defun debug-fun-kind (debug-fun)
1261 ;; FIXME: This "is one of" information should become part of the function
1262 ;; declamation, not just a doc string
1263 (etypecase debug-fun
1265 (sb!c::compiled-debug-fun-kind
1266 (compiled-debug-fun-compiler-debug-fun debug-fun)))
1270 ;;; Is there any variable information for DEBUG-FUN?
1271 (defun debug-var-info-available (debug-fun)
1272 (not (not (debug-fun-debug-vars debug-fun))))
1274 ;;; Return a list of DEBUG-VARs in DEBUG-FUN having the same name
1275 ;;; and package as SYMBOL. If SYMBOL is uninterned, then this returns
1276 ;;; a list of DEBUG-VARs without package names and with the same name
1277 ;;; as symbol. The result of this function is limited to the
1278 ;;; availability of variable information in DEBUG-FUN; for
1279 ;;; example, possibly DEBUG-FUN only knows about its arguments.
1280 (defun debug-fun-symbol-vars (debug-fun symbol)
1281 (let ((vars (ambiguous-debug-vars debug-fun (symbol-name symbol)))
1282 (package (and (symbol-package symbol)
1283 (package-name (symbol-package symbol)))))
1284 (delete-if (if (stringp package)
1286 (let ((p (debug-var-package-name var)))
1287 (or (not (stringp p))
1288 (string/= p package))))
1290 (stringp (debug-var-package-name var))))
1293 ;;; Return a list of DEBUG-VARs in DEBUG-FUN whose names contain
1294 ;;; NAME-PREFIX-STRING as an initial substring. The result of this
1295 ;;; function is limited to the availability of variable information in
1296 ;;; debug-fun; for example, possibly debug-fun only knows
1297 ;;; about its arguments.
1298 (defun ambiguous-debug-vars (debug-fun name-prefix-string)
1299 (declare (simple-string name-prefix-string))
1300 (let ((variables (debug-fun-debug-vars debug-fun)))
1301 (declare (type (or null simple-vector) variables))
1303 (let* ((len (length variables))
1304 (prefix-len (length name-prefix-string))
1305 (pos (find-var name-prefix-string variables len))
1308 ;; Find names from pos to variable's len that contain prefix.
1309 (do ((i pos (1+ i)))
1311 (let* ((var (svref variables i))
1312 (name (debug-var-symbol-name var))
1313 (name-len (length name)))
1314 (declare (simple-string name))
1315 (when (/= (or (string/= name-prefix-string name
1316 :end1 prefix-len :end2 name-len)
1321 (setq res (nreverse res)))
1324 ;;; This returns a position in VARIABLES for one containing NAME as an
1325 ;;; initial substring. END is the length of VARIABLES if supplied.
1326 (defun find-var (name variables &optional end)
1327 (declare (simple-vector variables)
1328 (simple-string name))
1329 (let ((name-len (length name)))
1330 (position name variables
1332 (let* ((y (debug-var-symbol-name y))
1334 (declare (simple-string y))
1335 (and (>= y-len name-len)
1336 (string= x y :end1 name-len :end2 name-len))))
1337 :end (or end (length variables)))))
1339 ;;; Return a list representing the lambda-list for DEBUG-FUN. The
1340 ;;; list has the following structure:
1341 ;;; (required-var1 required-var2
1343 ;;; (:optional var3 suppliedp-var4)
1344 ;;; (:optional var5)
1346 ;;; (:rest var6) (:rest var7)
1348 ;;; (:keyword keyword-symbol var8 suppliedp-var9)
1349 ;;; (:keyword keyword-symbol var10)
1352 ;;; Each VARi is a DEBUG-VAR; however it may be the symbol :DELETED if
1353 ;;; it is unreferenced in DEBUG-FUN. This signals a
1354 ;;; LAMBDA-LIST-UNAVAILABLE condition when there is no argument list
1356 (defun debug-fun-lambda-list (debug-fun)
1357 (etypecase debug-fun
1358 (compiled-debug-fun (compiled-debug-fun-lambda-list debug-fun))
1359 (bogus-debug-fun nil)))
1361 ;;; Note: If this has to compute the lambda list, it caches it in DEBUG-FUN.
1362 (defun compiled-debug-fun-lambda-list (debug-fun)
1363 (let ((lambda-list (debug-fun-%lambda-list debug-fun)))
1364 (cond ((eq lambda-list :unparsed)
1365 (multiple-value-bind (args argsp)
1366 (parse-compiled-debug-fun-lambda-list debug-fun)
1367 (setf (debug-fun-%lambda-list debug-fun) args)
1370 (debug-signal 'lambda-list-unavailable
1371 :debug-fun debug-fun))))
1373 ((bogus-debug-fun-p debug-fun)
1375 ((sb!c::compiled-debug-fun-arguments
1376 (compiled-debug-fun-compiler-debug-fun debug-fun))
1377 ;; If the packed information is there (whether empty or not) as
1378 ;; opposed to being nil, then returned our cached value (nil).
1381 ;; Our cached value is nil, and the packed lambda-list information
1382 ;; is nil, so we don't have anything available.
1383 (debug-signal 'lambda-list-unavailable
1384 :debug-fun debug-fun)))))
1386 ;;; COMPILED-DEBUG-FUN-LAMBDA-LIST calls this when a
1387 ;;; COMPILED-DEBUG-FUN has no lambda list information cached. It
1388 ;;; returns the lambda list as the first value and whether there was
1389 ;;; any argument information as the second value. Therefore,
1390 ;;; (VALUES NIL T) means there were no arguments, but (VALUES NIL NIL)
1391 ;;; means there was no argument information.
1392 (defun parse-compiled-debug-fun-lambda-list (debug-fun)
1393 (let ((args (sb!c::compiled-debug-fun-arguments
1394 (compiled-debug-fun-compiler-debug-fun debug-fun))))
1399 (values (coerce (debug-fun-debug-vars debug-fun) 'list)
1402 (let ((vars (debug-fun-debug-vars debug-fun))
1407 (declare (type (or null simple-vector) vars))
1409 (when (>= i len) (return))
1410 (let ((ele (aref args i)))
1415 ;; Deleted required arg at beginning of args array.
1416 (push :deleted res))
1417 (sb!c::optional-args
1420 ;; SUPPLIED-P var immediately following keyword or
1421 ;; optional. Stick the extra var in the result
1422 ;; element representing the keyword or optional,
1423 ;; which is the previous one.
1425 (list (compiled-debug-fun-lambda-list-var
1426 args (incf i) vars))))
1429 (compiled-debug-fun-lambda-list-var
1430 args (incf i) vars))
1433 ;; Just ignore the fact that the next two args are
1434 ;; the &MORE arg context and count, and act like they
1435 ;; are regular arguments.
1439 (push (list :keyword
1441 (compiled-debug-fun-lambda-list-var
1442 args (incf i) vars))
1445 ;; We saw an optional marker, so the following
1446 ;; non-symbols are indexes indicating optional
1448 (push (list :optional (svref vars ele)) res))
1450 ;; Required arg at beginning of args array.
1451 (push (svref vars ele) res))))
1453 (values (nreverse res) t))))))
1455 ;;; This is used in COMPILED-DEBUG-FUN-LAMBDA-LIST.
1456 (defun compiled-debug-fun-lambda-list-var (args i vars)
1457 (declare (type (simple-array * (*)) args)
1458 (simple-vector vars))
1459 (let ((ele (aref args i)))
1460 (cond ((not (symbolp ele)) (svref vars ele))
1461 ((eq ele 'sb!c::deleted) :deleted)
1462 (t (error "malformed arguments description")))))
1464 (defun compiled-debug-fun-debug-info (debug-fun)
1465 (%code-debug-info (compiled-debug-fun-component debug-fun)))
1467 ;;;; unpacking variable and basic block data
1469 (defvar *parsing-buffer*
1470 (make-array 20 :adjustable t :fill-pointer t))
1471 (defvar *other-parsing-buffer*
1472 (make-array 20 :adjustable t :fill-pointer t))
1473 ;;; PARSE-DEBUG-BLOCKS and PARSE-DEBUG-VARS
1474 ;;; use this to unpack binary encoded information. It returns the
1475 ;;; values returned by the last form in body.
1477 ;;; This binds buffer-var to *parsing-buffer*, makes sure it starts at
1478 ;;; element zero, and makes sure if we unwind, we nil out any set
1479 ;;; elements for GC purposes.
1481 ;;; This also binds other-var to *other-parsing-buffer* when it is
1482 ;;; supplied, making sure it starts at element zero and that we nil
1483 ;;; out any elements if we unwind.
1485 ;;; This defines the local macro RESULT that takes a buffer, copies
1486 ;;; its elements to a resulting simple-vector, nil's out elements, and
1487 ;;; restarts the buffer at element zero. RESULT returns the
1489 (eval-when (:compile-toplevel :execute)
1490 (sb!xc:defmacro with-parsing-buffer ((buffer-var &optional other-var)
1492 (let ((len (gensym))
1495 (let ((,buffer-var *parsing-buffer*)
1496 ,@(if other-var `((,other-var *other-parsing-buffer*))))
1497 (setf (fill-pointer ,buffer-var) 0)
1498 ,@(if other-var `((setf (fill-pointer ,other-var) 0)))
1499 (macrolet ((result (buf)
1500 `(let* ((,',len (length ,buf))
1501 (,',res (make-array ,',len)))
1502 (replace ,',res ,buf :end1 ,',len :end2 ,',len)
1503 (fill ,buf nil :end ,',len)
1504 (setf (fill-pointer ,buf) 0)
1507 (fill *parsing-buffer* nil)
1508 ,@(if other-var `((fill *other-parsing-buffer* nil))))))
1511 ;;; The argument is a debug internals structure. This returns the
1512 ;;; DEBUG-BLOCKs for DEBUG-FUN, regardless of whether we have unpacked
1513 ;;; them yet. It signals a NO-DEBUG-BLOCKS condition if it can't
1514 ;;; return the blocks.
1515 (defun debug-fun-debug-blocks (debug-fun)
1516 (let ((blocks (debug-fun-blocks debug-fun)))
1517 (cond ((eq blocks :unparsed)
1518 (setf (debug-fun-blocks debug-fun)
1519 (parse-debug-blocks debug-fun))
1520 (unless (debug-fun-blocks debug-fun)
1521 (debug-signal 'no-debug-blocks
1522 :debug-fun debug-fun))
1523 (debug-fun-blocks debug-fun))
1526 (debug-signal 'no-debug-blocks
1527 :debug-fun debug-fun)))))
1529 ;;; Return a SIMPLE-VECTOR of DEBUG-BLOCKs or NIL. NIL indicates there
1530 ;;; was no basic block information.
1531 (defun parse-debug-blocks (debug-fun)
1532 (etypecase debug-fun
1534 (parse-compiled-debug-blocks debug-fun))
1536 (debug-signal 'no-debug-blocks :debug-fun debug-fun))))
1538 ;;; This does some of the work of PARSE-DEBUG-BLOCKS.
1539 (defun parse-compiled-debug-blocks (debug-fun)
1540 (let* ((var-count (length (debug-fun-debug-vars debug-fun)))
1541 (compiler-debug-fun (compiled-debug-fun-compiler-debug-fun
1543 (blocks (sb!c::compiled-debug-fun-blocks compiler-debug-fun))
1544 ;; KLUDGE: 8 is a hard-wired constant in the compiler for the
1545 ;; element size of the packed binary representation of the
1547 (live-set-len (ceiling var-count 8))
1548 (tlf-number (sb!c::compiled-debug-fun-tlf-number compiler-debug-fun)))
1550 (return-from parse-compiled-debug-blocks nil))
1551 (macrolet ((aref+ (a i) `(prog1 (aref ,a ,i) (incf ,i))))
1552 (with-parsing-buffer (blocks-buffer locations-buffer)
1554 (len (length blocks))
1557 (when (>= i len) (return))
1558 (let ((succ-and-flags (aref+ blocks i))
1560 (declare (type (unsigned-byte 8) succ-and-flags)
1562 (dotimes (k (ldb sb!c::compiled-debug-block-nsucc-byte
1564 (push (sb!c:read-var-integer blocks i) successors))
1566 (dotimes (k (sb!c:read-var-integer blocks i)
1567 (result locations-buffer))
1568 (let ((kind (svref sb!c::*compiled-code-location-kinds*
1571 (sb!c:read-var-integer blocks i)))
1572 (tlf-offset (or tlf-number
1573 (sb!c:read-var-integer blocks i)))
1574 (form-number (sb!c:read-var-integer blocks i))
1575 (live-set (sb!c:read-packed-bit-vector
1576 live-set-len blocks i)))
1577 (vector-push-extend (make-known-code-location
1578 pc debug-fun tlf-offset
1579 form-number live-set kind)
1581 (setf last-pc pc))))
1582 (block (make-compiled-debug-block
1583 locations successors
1585 sb!c::compiled-debug-block-elsewhere-p
1586 succ-and-flags))))))
1587 (vector-push-extend block blocks-buffer)
1588 (dotimes (k (length locations))
1589 (setf (code-location-%debug-block (svref locations k))
1591 (let ((res (result blocks-buffer)))
1592 (declare (simple-vector res))
1593 (dotimes (i (length res))
1594 (let* ((block (svref res i))
1596 (dolist (ele (debug-block-successors block))
1597 (push (svref res ele) succs))
1598 (setf (debug-block-successors block) succs)))
1601 ;;; The argument is a debug internals structure. This returns NIL if
1602 ;;; there is no variable information. It returns an empty
1603 ;;; simple-vector if there were no locals in the function. Otherwise
1604 ;;; it returns a SIMPLE-VECTOR of DEBUG-VARs.
1605 (defun debug-fun-debug-vars (debug-fun)
1606 (let ((vars (debug-fun-%debug-vars debug-fun)))
1607 (if (eq vars :unparsed)
1608 (setf (debug-fun-%debug-vars debug-fun)
1609 (etypecase debug-fun
1611 (parse-compiled-debug-vars debug-fun))
1612 (bogus-debug-fun nil)))
1615 ;;; VARS is the parsed variables for a minimal debug function. We need
1616 ;;; to assign names of the form ARG-NNN. We must pad with leading
1617 ;;; zeros, since the arguments must be in alphabetical order.
1618 (defun assign-minimal-var-names (vars)
1619 (declare (simple-vector vars))
1620 (let* ((len (length vars))
1621 (width (length (format nil "~W" (1- len)))))
1623 (without-package-locks
1624 (setf (compiled-debug-var-symbol (svref vars i))
1625 (intern (format nil "ARG-~V,'0D" width i)
1626 ;; KLUDGE: It's somewhat nasty to have a bare
1627 ;; package name string here. It would be
1628 ;; nicer to have #.(FIND-PACKAGE "SB!DEBUG")
1629 ;; instead, since then at least it would transform
1630 ;; correctly under package renaming and stuff.
1631 ;; However, genesis can't handle dumped packages..
1634 ;; FIXME: Maybe this could be fixed by moving the
1635 ;; whole debug-int.lisp file to warm init? (after
1636 ;; which dumping a #.(FIND-PACKAGE ..) expression
1637 ;; would work fine) If this is possible, it would
1638 ;; probably be a good thing, since minimizing the
1639 ;; amount of stuff in cold init is basically good.
1640 (or (find-package "SB-DEBUG")
1641 (find-package "SB!DEBUG"))))))))
1643 ;;; Parse the packed representation of DEBUG-VARs from
1644 ;;; DEBUG-FUN's SB!C::COMPILED-DEBUG-FUN, returning a vector
1645 ;;; of DEBUG-VARs, or NIL if there was no information to parse.
1646 (defun parse-compiled-debug-vars (debug-fun)
1647 (let* ((cdebug-fun (compiled-debug-fun-compiler-debug-fun
1649 (packed-vars (sb!c::compiled-debug-fun-vars cdebug-fun))
1650 (args-minimal (eq (sb!c::compiled-debug-fun-arguments cdebug-fun)
1654 (buffer (make-array 0 :fill-pointer 0 :adjustable t)))
1655 ((>= i (length packed-vars))
1656 (let ((result (coerce buffer 'simple-vector)))
1658 (assign-minimal-var-names result))
1660 (flet ((geti () (prog1 (aref packed-vars i) (incf i))))
1661 (let* ((flags (geti))
1662 (minimal (logtest sb!c::compiled-debug-var-minimal-p flags))
1663 (deleted (logtest sb!c::compiled-debug-var-deleted-p flags))
1664 (live (logtest sb!c::compiled-debug-var-environment-live
1666 (save (logtest sb!c::compiled-debug-var-save-loc-p flags))
1667 (symbol (if minimal nil (geti)))
1668 (id (if (logtest sb!c::compiled-debug-var-id-p flags)
1671 (sc-offset (if deleted 0 (geti)))
1672 (save-sc-offset (if save (geti) nil)))
1673 (aver (not (and args-minimal (not minimal))))
1674 (vector-push-extend (make-compiled-debug-var symbol
1683 ;;; If we're sure of whether code-location is known, return T or NIL.
1684 ;;; If we're :UNSURE, then try to fill in the code-location's slots.
1685 ;;; This determines whether there is any debug-block information, and
1686 ;;; if code-location is known.
1688 ;;; ??? IF this conses closures every time it's called, then break off the
1689 ;;; :UNSURE part to get the HANDLER-CASE into another function.
1690 (defun code-location-unknown-p (basic-code-location)
1691 (ecase (code-location-%unknown-p basic-code-location)
1695 (setf (code-location-%unknown-p basic-code-location)
1696 (handler-case (not (fill-in-code-location basic-code-location))
1697 (no-debug-blocks () t))))))
1699 ;;; Return the DEBUG-BLOCK containing code-location if it is available.
1700 ;;; Some debug policies inhibit debug-block information, and if none
1701 ;;; is available, then this signals a NO-DEBUG-BLOCKS condition.
1702 (defun code-location-debug-block (basic-code-location)
1703 (let ((block (code-location-%debug-block basic-code-location)))
1704 (if (eq block :unparsed)
1705 (etypecase basic-code-location
1706 (compiled-code-location
1707 (compute-compiled-code-location-debug-block basic-code-location))
1708 ;; (There used to be more cases back before sbcl-0.7.0, when
1709 ;; we did special tricks to debug the IR1 interpreter.)
1713 ;;; Store and return BASIC-CODE-LOCATION's debug-block. We determines
1714 ;;; the correct one using the code-location's pc. We use
1715 ;;; DEBUG-FUN-DEBUG-BLOCKS to return the cached block information
1716 ;;; or signal a NO-DEBUG-BLOCKS condition. The blocks are sorted by
1717 ;;; their first code-location's pc, in ascending order. Therefore, as
1718 ;;; soon as we find a block that starts with a pc greater than
1719 ;;; basic-code-location's pc, we know the previous block contains the
1720 ;;; pc. If we get to the last block, then the code-location is either
1721 ;;; in the second to last block or the last block, and we have to be
1722 ;;; careful in determining this since the last block could be code at
1723 ;;; the end of the function. We have to check for the last block being
1724 ;;; code first in order to see how to compare the code-location's pc.
1725 (defun compute-compiled-code-location-debug-block (basic-code-location)
1726 (let* ((pc (compiled-code-location-pc basic-code-location))
1727 (debug-fun (code-location-debug-fun
1728 basic-code-location))
1729 (blocks (debug-fun-debug-blocks debug-fun))
1730 (len (length blocks)))
1731 (declare (simple-vector blocks))
1732 (setf (code-location-%debug-block basic-code-location)
1738 (let ((last (svref blocks end)))
1740 ((debug-block-elsewhere-p last)
1742 (sb!c::compiled-debug-fun-elsewhere-pc
1743 (compiled-debug-fun-compiler-debug-fun
1745 (svref blocks (1- end))
1748 (compiled-code-location-pc
1749 (svref (compiled-debug-block-code-locations last)
1751 (svref blocks (1- end)))
1753 (declare (type index i end))
1755 (compiled-code-location-pc
1756 (svref (compiled-debug-block-code-locations
1759 (return (svref blocks (1- i)))))))))
1761 ;;; Return the CODE-LOCATION's DEBUG-SOURCE.
1762 (defun code-location-debug-source (code-location)
1763 (etypecase code-location
1764 (compiled-code-location
1765 (let* ((info (compiled-debug-fun-debug-info
1766 (code-location-debug-fun code-location)))
1767 (sources (sb!c::compiled-debug-info-source info))
1768 (len (length sources)))
1769 (declare (list sources))
1771 (debug-signal 'no-debug-blocks :debug-fun
1772 (code-location-debug-fun code-location)))
1775 (do ((prev sources src)
1776 (src (cdr sources) (cdr src))
1777 (offset (code-location-toplevel-form-offset code-location)))
1778 ((null src) (car prev))
1779 (when (< offset (sb!c::debug-source-source-root (car src)))
1780 (return (car prev)))))))
1781 ;; (There used to be more cases back before sbcl-0.7.0, when we
1782 ;; did special tricks to debug the IR1 interpreter.)
1785 ;;; Returns the number of top level forms before the one containing
1786 ;;; CODE-LOCATION as seen by the compiler in some compilation unit. (A
1787 ;;; compilation unit is not necessarily a single file, see the section
1788 ;;; on debug-sources.)
1789 (defun code-location-toplevel-form-offset (code-location)
1790 (when (code-location-unknown-p code-location)
1791 (error 'unknown-code-location :code-location code-location))
1792 (let ((tlf-offset (code-location-%tlf-offset code-location)))
1793 (cond ((eq tlf-offset :unparsed)
1794 (etypecase code-location
1795 (compiled-code-location
1796 (unless (fill-in-code-location code-location)
1797 ;; This check should be unnecessary. We're missing
1798 ;; debug info the compiler should have dumped.
1799 (bug "unknown code location"))
1800 (code-location-%tlf-offset code-location))
1801 ;; (There used to be more cases back before sbcl-0.7.0,,
1802 ;; when we did special tricks to debug the IR1
1807 ;;; Return the number of the form corresponding to CODE-LOCATION. The
1808 ;;; form number is derived by a walking the subforms of a top level
1809 ;;; form in depth-first order.
1810 (defun code-location-form-number (code-location)
1811 (when (code-location-unknown-p code-location)
1812 (error 'unknown-code-location :code-location code-location))
1813 (let ((form-num (code-location-%form-number code-location)))
1814 (cond ((eq form-num :unparsed)
1815 (etypecase code-location
1816 (compiled-code-location
1817 (unless (fill-in-code-location code-location)
1818 ;; This check should be unnecessary. We're missing
1819 ;; debug info the compiler should have dumped.
1820 (bug "unknown code location"))
1821 (code-location-%form-number code-location))
1822 ;; (There used to be more cases back before sbcl-0.7.0,,
1823 ;; when we did special tricks to debug the IR1
1828 ;;; Return the kind of CODE-LOCATION, one of:
1829 ;;; :INTERPRETED, :UNKNOWN-RETURN, :KNOWN-RETURN, :INTERNAL-ERROR,
1830 ;;; :NON-LOCAL-EXIT, :BLOCK-START, :CALL-SITE, :SINGLE-VALUE-RETURN,
1831 ;;; :NON-LOCAL-ENTRY
1832 (defun code-location-kind (code-location)
1833 (when (code-location-unknown-p code-location)
1834 (error 'unknown-code-location :code-location code-location))
1835 (etypecase code-location
1836 (compiled-code-location
1837 (let ((kind (compiled-code-location-kind code-location)))
1838 (cond ((not (eq kind :unparsed)) kind)
1839 ((not (fill-in-code-location code-location))
1840 ;; This check should be unnecessary. We're missing
1841 ;; debug info the compiler should have dumped.
1842 (bug "unknown code location"))
1844 (compiled-code-location-kind code-location)))))
1845 ;; (There used to be more cases back before sbcl-0.7.0,,
1846 ;; when we did special tricks to debug the IR1
1850 ;;; This returns CODE-LOCATION's live-set if it is available. If
1851 ;;; there is no debug-block information, this returns NIL.
1852 (defun compiled-code-location-live-set (code-location)
1853 (if (code-location-unknown-p code-location)
1855 (let ((live-set (compiled-code-location-%live-set code-location)))
1856 (cond ((eq live-set :unparsed)
1857 (unless (fill-in-code-location code-location)
1858 ;; This check should be unnecessary. We're missing
1859 ;; debug info the compiler should have dumped.
1861 ;; FIXME: This error and comment happen over and over again.
1862 ;; Make them a shared function.
1863 (bug "unknown code location"))
1864 (compiled-code-location-%live-set code-location))
1867 ;;; true if OBJ1 and OBJ2 are the same place in the code
1868 (defun code-location= (obj1 obj2)
1870 (compiled-code-location
1872 (compiled-code-location
1873 (and (eq (code-location-debug-fun obj1)
1874 (code-location-debug-fun obj2))
1875 (sub-compiled-code-location= obj1 obj2)))
1876 ;; (There used to be more cases back before sbcl-0.7.0,,
1877 ;; when we did special tricks to debug the IR1
1880 ;; (There used to be more cases back before sbcl-0.7.0,,
1881 ;; when we did special tricks to debug IR1-interpreted code.)
1883 (defun sub-compiled-code-location= (obj1 obj2)
1884 (= (compiled-code-location-pc obj1)
1885 (compiled-code-location-pc obj2)))
1887 ;;; Fill in CODE-LOCATION's :UNPARSED slots, returning T or NIL
1888 ;;; depending on whether the code-location was known in its
1889 ;;; DEBUG-FUN's debug-block information. This may signal a
1890 ;;; NO-DEBUG-BLOCKS condition due to DEBUG-FUN-DEBUG-BLOCKS, and
1891 ;;; it assumes the %UNKNOWN-P slot is already set or going to be set.
1892 (defun fill-in-code-location (code-location)
1893 (declare (type compiled-code-location code-location))
1894 (let* ((debug-fun (code-location-debug-fun code-location))
1895 (blocks (debug-fun-debug-blocks debug-fun)))
1896 (declare (simple-vector blocks))
1897 (dotimes (i (length blocks) nil)
1898 (let* ((block (svref blocks i))
1899 (locations (compiled-debug-block-code-locations block)))
1900 (declare (simple-vector locations))
1901 (dotimes (j (length locations))
1902 (let ((loc (svref locations j)))
1903 (when (sub-compiled-code-location= code-location loc)
1904 (setf (code-location-%debug-block code-location) block)
1905 (setf (code-location-%tlf-offset code-location)
1906 (code-location-%tlf-offset loc))
1907 (setf (code-location-%form-number code-location)
1908 (code-location-%form-number loc))
1909 (setf (compiled-code-location-%live-set code-location)
1910 (compiled-code-location-%live-set loc))
1911 (setf (compiled-code-location-kind code-location)
1912 (compiled-code-location-kind loc))
1913 (return-from fill-in-code-location t))))))))
1915 ;;;; operations on DEBUG-BLOCKs
1917 ;;; Execute FORMS in a context with CODE-VAR bound to each
1918 ;;; CODE-LOCATION in DEBUG-BLOCK, and return the value of RESULT.
1919 (defmacro do-debug-block-locations ((code-var debug-block &optional result)
1921 (let ((code-locations (gensym))
1923 `(let ((,code-locations (debug-block-code-locations ,debug-block)))
1924 (declare (simple-vector ,code-locations))
1925 (dotimes (,i (length ,code-locations) ,result)
1926 (let ((,code-var (svref ,code-locations ,i)))
1929 ;;; Return the name of the function represented by DEBUG-FUN.
1930 ;;; This may be a string or a cons; do not assume it is a symbol.
1931 (defun debug-block-fun-name (debug-block)
1932 (etypecase debug-block
1933 (compiled-debug-block
1934 (let ((code-locs (compiled-debug-block-code-locations debug-block)))
1935 (declare (simple-vector code-locs))
1936 (if (zerop (length code-locs))
1937 "??? Can't get name of debug-block's function."
1939 (code-location-debug-fun (svref code-locs 0))))))
1940 ;; (There used to be more cases back before sbcl-0.7.0, when we
1941 ;; did special tricks to debug the IR1 interpreter.)
1944 (defun debug-block-code-locations (debug-block)
1945 (etypecase debug-block
1946 (compiled-debug-block
1947 (compiled-debug-block-code-locations debug-block))
1948 ;; (There used to be more cases back before sbcl-0.7.0, when we
1949 ;; did special tricks to debug the IR1 interpreter.)
1952 ;;;; operations on debug variables
1954 (defun debug-var-symbol-name (debug-var)
1955 (symbol-name (debug-var-symbol debug-var)))
1957 ;;; FIXME: Make sure that this isn't called anywhere that it wouldn't
1958 ;;; be acceptable to have NIL returned, or that it's only called on
1959 ;;; DEBUG-VARs whose symbols have non-NIL packages.
1960 (defun debug-var-package-name (debug-var)
1961 (package-name (symbol-package (debug-var-symbol debug-var))))
1963 ;;; Return the value stored for DEBUG-VAR in frame, or if the value is
1964 ;;; not :VALID, then signal an INVALID-VALUE error.
1965 (defun debug-var-valid-value (debug-var frame)
1966 (unless (eq (debug-var-validity debug-var (frame-code-location frame))
1968 (error 'invalid-value :debug-var debug-var :frame frame))
1969 (debug-var-value debug-var frame))
1971 ;;; Returns the value stored for DEBUG-VAR in frame. The value may be
1972 ;;; invalid. This is SETFable.
1973 (defun debug-var-value (debug-var frame)
1974 (aver (typep frame 'compiled-frame))
1975 (let ((res (access-compiled-debug-var-slot debug-var frame)))
1976 (if (indirect-value-cell-p res)
1977 (value-cell-ref res)
1980 ;;; This returns what is stored for the variable represented by
1981 ;;; DEBUG-VAR relative to the FRAME. This may be an indirect value
1982 ;;; cell if the variable is both closed over and set.
1983 (defun access-compiled-debug-var-slot (debug-var frame)
1984 (declare (optimize (speed 1)))
1985 (let ((escaped (compiled-frame-escaped frame)))
1987 (sub-access-debug-var-slot
1988 (frame-pointer frame)
1989 (compiled-debug-var-sc-offset debug-var)
1991 (sub-access-debug-var-slot
1992 (frame-pointer frame)
1993 (or (compiled-debug-var-save-sc-offset debug-var)
1994 (compiled-debug-var-sc-offset debug-var))))))
1996 ;;; a helper function for working with possibly-invalid values:
1997 ;;; Do (MAKE-LISP-OBJ VAL) only if the value looks valid.
1999 ;;; (Such values can arise in registers on machines with conservative
2000 ;;; GC, and might also arise in debug variable locations when
2001 ;;; those variables are invalid.)
2002 (defun make-valid-lisp-obj (val)
2005 (zerop (logand val 3))
2007 (and (zerop (logand val #xffff0000)) ; Top bits zero
2008 (= (logand val #xff) sb!vm:base-char-widetag)) ; char tag
2010 (= val sb!vm:unbound-marker-widetag)
2013 ;; Check that the pointer is valid. XXX Could do a better
2014 ;; job. FIXME: e.g. by calling out to an is_valid_pointer
2015 ;; routine in the C runtime support code
2016 (or (< sb!vm:read-only-space-start val
2017 (* sb!vm:*read-only-space-free-pointer*
2018 sb!vm:n-word-bytes))
2019 (< sb!vm:static-space-start val
2020 (* sb!vm:*static-space-free-pointer*
2021 sb!vm:n-word-bytes))
2022 (< sb!vm:dynamic-space-start val
2023 (sap-int (dynamic-space-free-pointer))))))
2028 (defun sub-access-debug-var-slot (fp sc-offset &optional escaped)
2029 (macrolet ((with-escaped-value ((var) &body forms)
2031 (let ((,var (sb!vm:context-register
2033 (sb!c:sc-offset-offset sc-offset))))
2035 :invalid-value-for-unescaped-register-storage))
2036 (escaped-float-value (format)
2038 (sb!vm:context-float-register
2040 (sb!c:sc-offset-offset sc-offset)
2042 :invalid-value-for-unescaped-register-storage))
2043 (with-nfp ((var) &body body)
2044 `(let ((,var (if escaped
2046 (sb!vm:context-register escaped
2049 (sb!sys:sap-ref-sap fp (* nfp-save-offset
2050 sb!vm:n-word-bytes))
2052 (sb!vm::make-number-stack-pointer
2053 (sb!sys:sap-ref-32 fp (* nfp-save-offset
2054 sb!vm:n-word-bytes))))))
2056 (ecase (sb!c:sc-offset-scn sc-offset)
2057 ((#.sb!vm:any-reg-sc-number
2058 #.sb!vm:descriptor-reg-sc-number
2059 #!+rt #.sb!vm:word-pointer-reg-sc-number)
2060 (sb!sys:without-gcing
2061 (with-escaped-value (val) (sb!kernel:make-lisp-obj val))))
2063 (#.sb!vm:base-char-reg-sc-number
2064 (with-escaped-value (val)
2066 (#.sb!vm:sap-reg-sc-number
2067 (with-escaped-value (val)
2068 (sb!sys:int-sap val)))
2069 (#.sb!vm:signed-reg-sc-number
2070 (with-escaped-value (val)
2071 (if (logbitp (1- sb!vm:n-word-bits) val)
2072 (logior val (ash -1 sb!vm:n-word-bits))
2074 (#.sb!vm:unsigned-reg-sc-number
2075 (with-escaped-value (val)
2077 (#.sb!vm:non-descriptor-reg-sc-number
2078 (error "Local non-descriptor register access?"))
2079 (#.sb!vm:interior-reg-sc-number
2080 (error "Local interior register access?"))
2081 (#.sb!vm:single-reg-sc-number
2082 (escaped-float-value single-float))
2083 (#.sb!vm:double-reg-sc-number
2084 (escaped-float-value double-float))
2086 (#.sb!vm:long-reg-sc-number
2087 (escaped-float-value long-float))
2088 (#.sb!vm:complex-single-reg-sc-number
2091 (sb!vm:context-float-register
2092 escaped (sb!c:sc-offset-offset sc-offset) 'single-float)
2093 (sb!vm:context-float-register
2094 escaped (1+ (sb!c:sc-offset-offset sc-offset)) 'single-float))
2095 :invalid-value-for-unescaped-register-storage))
2096 (#.sb!vm:complex-double-reg-sc-number
2099 (sb!vm:context-float-register
2100 escaped (sb!c:sc-offset-offset sc-offset) 'double-float)
2101 (sb!vm:context-float-register
2102 escaped (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 2 #!-sparc 1)
2104 :invalid-value-for-unescaped-register-storage))
2106 (#.sb!vm:complex-long-reg-sc-number
2109 (sb!vm:context-float-register
2110 escaped (sb!c:sc-offset-offset sc-offset) 'long-float)
2111 (sb!vm:context-float-register
2112 escaped (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 4)
2114 :invalid-value-for-unescaped-register-storage))
2115 (#.sb!vm:single-stack-sc-number
2117 (sb!sys:sap-ref-single nfp (* (sb!c:sc-offset-offset sc-offset)
2118 sb!vm:n-word-bytes))))
2119 (#.sb!vm:double-stack-sc-number
2121 (sb!sys:sap-ref-double nfp (* (sb!c:sc-offset-offset sc-offset)
2122 sb!vm:n-word-bytes))))
2124 (#.sb!vm:long-stack-sc-number
2126 (sb!sys:sap-ref-long nfp (* (sb!c:sc-offset-offset sc-offset)
2127 sb!vm:n-word-bytes))))
2128 (#.sb!vm:complex-single-stack-sc-number
2131 (sb!sys:sap-ref-single nfp (* (sb!c:sc-offset-offset sc-offset)
2132 sb!vm:n-word-bytes))
2133 (sb!sys:sap-ref-single nfp (* (1+ (sb!c:sc-offset-offset sc-offset))
2134 sb!vm:n-word-bytes)))))
2135 (#.sb!vm:complex-double-stack-sc-number
2138 (sb!sys:sap-ref-double nfp (* (sb!c:sc-offset-offset sc-offset)
2139 sb!vm:n-word-bytes))
2140 (sb!sys:sap-ref-double nfp (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2141 sb!vm:n-word-bytes)))))
2143 (#.sb!vm:complex-long-stack-sc-number
2146 (sb!sys:sap-ref-long nfp (* (sb!c:sc-offset-offset sc-offset)
2147 sb!vm:n-word-bytes))
2148 (sb!sys:sap-ref-long nfp (* (+ (sb!c:sc-offset-offset sc-offset)
2150 sb!vm:n-word-bytes)))))
2151 (#.sb!vm:control-stack-sc-number
2152 (sb!kernel:stack-ref fp (sb!c:sc-offset-offset sc-offset)))
2153 (#.sb!vm:base-char-stack-sc-number
2155 (code-char (sb!sys:sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2156 sb!vm:n-word-bytes)))))
2157 (#.sb!vm:unsigned-stack-sc-number
2159 (sb!sys:sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2160 sb!vm:n-word-bytes))))
2161 (#.sb!vm:signed-stack-sc-number
2163 (sb!sys:signed-sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2164 sb!vm:n-word-bytes))))
2165 (#.sb!vm:sap-stack-sc-number
2167 (sb!sys:sap-ref-sap nfp (* (sb!c:sc-offset-offset sc-offset)
2168 sb!vm:n-word-bytes)))))))
2171 (defun sub-access-debug-var-slot (fp sc-offset &optional escaped)
2172 (declare (type system-area-pointer fp))
2173 (macrolet ((with-escaped-value ((var) &body forms)
2175 (let ((,var (sb!vm:context-register
2177 (sb!c:sc-offset-offset sc-offset))))
2179 :invalid-value-for-unescaped-register-storage))
2180 (escaped-float-value (format)
2182 (sb!vm:context-float-register
2183 escaped (sb!c:sc-offset-offset sc-offset) ',format)
2184 :invalid-value-for-unescaped-register-storage))
2185 (escaped-complex-float-value (format)
2188 (sb!vm:context-float-register
2189 escaped (sb!c:sc-offset-offset sc-offset) ',format)
2190 (sb!vm:context-float-register
2191 escaped (1+ (sb!c:sc-offset-offset sc-offset)) ',format))
2192 :invalid-value-for-unescaped-register-storage)))
2193 (ecase (sb!c:sc-offset-scn sc-offset)
2194 ((#.sb!vm:any-reg-sc-number #.sb!vm:descriptor-reg-sc-number)
2196 (with-escaped-value (val)
2197 (make-valid-lisp-obj val))))
2198 (#.sb!vm:base-char-reg-sc-number
2199 (with-escaped-value (val)
2201 (#.sb!vm:sap-reg-sc-number
2202 (with-escaped-value (val)
2204 (#.sb!vm:signed-reg-sc-number
2205 (with-escaped-value (val)
2206 (if (logbitp (1- sb!vm:n-word-bits) val)
2207 (logior val (ash -1 sb!vm:n-word-bits))
2209 (#.sb!vm:unsigned-reg-sc-number
2210 (with-escaped-value (val)
2212 (#.sb!vm:single-reg-sc-number
2213 (escaped-float-value single-float))
2214 (#.sb!vm:double-reg-sc-number
2215 (escaped-float-value double-float))
2217 (#.sb!vm:long-reg-sc-number
2218 (escaped-float-value long-float))
2219 (#.sb!vm:complex-single-reg-sc-number
2220 (escaped-complex-float-value single-float))
2221 (#.sb!vm:complex-double-reg-sc-number
2222 (escaped-complex-float-value double-float))
2224 (#.sb!vm:complex-long-reg-sc-number
2225 (escaped-complex-float-value long-float))
2226 (#.sb!vm:single-stack-sc-number
2227 (sap-ref-single fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2228 sb!vm:n-word-bytes))))
2229 (#.sb!vm:double-stack-sc-number
2230 (sap-ref-double fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2231 sb!vm:n-word-bytes))))
2233 (#.sb!vm:long-stack-sc-number
2234 (sap-ref-long fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2235 sb!vm:n-word-bytes))))
2236 (#.sb!vm:complex-single-stack-sc-number
2238 (sap-ref-single fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2239 sb!vm:n-word-bytes)))
2240 (sap-ref-single fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2241 sb!vm:n-word-bytes)))))
2242 (#.sb!vm:complex-double-stack-sc-number
2244 (sap-ref-double fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2245 sb!vm:n-word-bytes)))
2246 (sap-ref-double fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 4)
2247 sb!vm:n-word-bytes)))))
2249 (#.sb!vm:complex-long-stack-sc-number
2251 (sap-ref-long fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2252 sb!vm:n-word-bytes)))
2253 (sap-ref-long fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 6)
2254 sb!vm:n-word-bytes)))))
2255 (#.sb!vm:control-stack-sc-number
2256 (stack-ref fp (sb!c:sc-offset-offset sc-offset)))
2257 (#.sb!vm:base-char-stack-sc-number
2259 (sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2260 sb!vm:n-word-bytes)))))
2261 (#.sb!vm:unsigned-stack-sc-number
2262 (sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2263 sb!vm:n-word-bytes))))
2264 (#.sb!vm:signed-stack-sc-number
2265 (signed-sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2266 sb!vm:n-word-bytes))))
2267 (#.sb!vm:sap-stack-sc-number
2268 (sap-ref-sap fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2269 sb!vm:n-word-bytes)))))))
2271 ;;; This stores value as the value of DEBUG-VAR in FRAME. In the
2272 ;;; COMPILED-DEBUG-VAR case, access the current value to determine if
2273 ;;; it is an indirect value cell. This occurs when the variable is
2274 ;;; both closed over and set.
2275 (defun %set-debug-var-value (debug-var frame new-value)
2276 (aver (typep frame 'compiled-frame))
2277 (let ((old-value (access-compiled-debug-var-slot debug-var frame)))
2278 (if (indirect-value-cell-p old-value)
2279 (value-cell-set old-value new-value)
2280 (set-compiled-debug-var-slot debug-var frame new-value)))
2283 ;;; This stores VALUE for the variable represented by debug-var
2284 ;;; relative to the frame. This assumes the location directly contains
2285 ;;; the variable's value; that is, there is no indirect value cell
2286 ;;; currently there in case the variable is both closed over and set.
2287 (defun set-compiled-debug-var-slot (debug-var frame value)
2288 (let ((escaped (compiled-frame-escaped frame)))
2290 (sub-set-debug-var-slot (frame-pointer frame)
2291 (compiled-debug-var-sc-offset debug-var)
2293 (sub-set-debug-var-slot
2294 (frame-pointer frame)
2295 (or (compiled-debug-var-save-sc-offset debug-var)
2296 (compiled-debug-var-sc-offset debug-var))
2300 (defun sub-set-debug-var-slot (fp sc-offset value &optional escaped)
2301 (macrolet ((set-escaped-value (val)
2303 (setf (sb!vm:context-register
2305 (sb!c:sc-offset-offset sc-offset))
2308 (set-escaped-float-value (format val)
2310 (setf (sb!vm:context-float-register
2312 (sb!c:sc-offset-offset sc-offset)
2316 (with-nfp ((var) &body body)
2317 `(let ((,var (if escaped
2319 (sb!vm:context-register escaped
2324 sb!vm:n-word-bytes))
2326 (sb!vm::make-number-stack-pointer
2329 sb!vm:n-word-bytes))))))
2331 (ecase (sb!c:sc-offset-scn sc-offset)
2332 ((#.sb!vm:any-reg-sc-number
2333 #.sb!vm:descriptor-reg-sc-number
2334 #!+rt #.sb!vm:word-pointer-reg-sc-number)
2337 (get-lisp-obj-address value))))
2338 (#.sb!vm:base-char-reg-sc-number
2339 (set-escaped-value (char-code value)))
2340 (#.sb!vm:sap-reg-sc-number
2341 (set-escaped-value (sap-int value)))
2342 (#.sb!vm:signed-reg-sc-number
2343 (set-escaped-value (logand value (1- (ash 1 sb!vm:n-word-bits)))))
2344 (#.sb!vm:unsigned-reg-sc-number
2345 (set-escaped-value value))
2346 (#.sb!vm:non-descriptor-reg-sc-number
2347 (error "Local non-descriptor register access?"))
2348 (#.sb!vm:interior-reg-sc-number
2349 (error "Local interior register access?"))
2350 (#.sb!vm:single-reg-sc-number
2351 (set-escaped-float-value single-float value))
2352 (#.sb!vm:double-reg-sc-number
2353 (set-escaped-float-value double-float value))
2355 (#.sb!vm:long-reg-sc-number
2356 (set-escaped-float-value long-float value))
2357 (#.sb!vm:complex-single-reg-sc-number
2359 (setf (sb!vm:context-float-register escaped
2360 (sb!c:sc-offset-offset sc-offset)
2363 (setf (sb!vm:context-float-register
2364 escaped (1+ (sb!c:sc-offset-offset sc-offset))
2368 (#.sb!vm:complex-double-reg-sc-number
2370 (setf (sb!vm:context-float-register
2371 escaped (sb!c:sc-offset-offset sc-offset) 'double-float)
2373 (setf (sb!vm:context-float-register
2375 (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 2 #!-sparc 1)
2380 (#.sb!vm:complex-long-reg-sc-number
2382 (setf (sb!vm:context-float-register
2383 escaped (sb!c:sc-offset-offset sc-offset) 'long-float)
2385 (setf (sb!vm:context-float-register
2387 (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 4)
2391 (#.sb!vm:single-stack-sc-number
2393 (setf (sap-ref-single nfp (* (sb!c:sc-offset-offset sc-offset)
2394 sb!vm:n-word-bytes))
2395 (the single-float value))))
2396 (#.sb!vm:double-stack-sc-number
2398 (setf (sap-ref-double nfp (* (sb!c:sc-offset-offset sc-offset)
2399 sb!vm:n-word-bytes))
2400 (the double-float value))))
2402 (#.sb!vm:long-stack-sc-number
2404 (setf (sap-ref-long nfp (* (sb!c:sc-offset-offset sc-offset)
2405 sb!vm:n-word-bytes))
2406 (the long-float value))))
2407 (#.sb!vm:complex-single-stack-sc-number
2409 (setf (sap-ref-single
2410 nfp (* (sb!c:sc-offset-offset sc-offset) sb!vm:n-word-bytes))
2411 (the single-float (realpart value)))
2412 (setf (sap-ref-single
2413 nfp (* (1+ (sb!c:sc-offset-offset sc-offset))
2414 sb!vm:n-word-bytes))
2415 (the single-float (realpart value)))))
2416 (#.sb!vm:complex-double-stack-sc-number
2418 (setf (sap-ref-double
2419 nfp (* (sb!c:sc-offset-offset sc-offset) sb!vm:n-word-bytes))
2420 (the double-float (realpart value)))
2421 (setf (sap-ref-double
2422 nfp (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2423 sb!vm:n-word-bytes))
2424 (the double-float (realpart value)))))
2426 (#.sb!vm:complex-long-stack-sc-number
2429 nfp (* (sb!c:sc-offset-offset sc-offset) sb!vm:n-word-bytes))
2430 (the long-float (realpart value)))
2432 nfp (* (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 4)
2433 sb!vm:n-word-bytes))
2434 (the long-float (realpart value)))))
2435 (#.sb!vm:control-stack-sc-number
2436 (setf (stack-ref fp (sb!c:sc-offset-offset sc-offset)) value))
2437 (#.sb!vm:base-char-stack-sc-number
2439 (setf (sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2440 sb!vm:n-word-bytes))
2441 (char-code (the character value)))))
2442 (#.sb!vm:unsigned-stack-sc-number
2444 (setf (sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2445 sb!vm:n-word-bytes))
2446 (the (unsigned-byte 32) value))))
2447 (#.sb!vm:signed-stack-sc-number
2449 (setf (signed-sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2450 sb!vm:n-word-bytes))
2451 (the (signed-byte 32) value))))
2452 (#.sb!vm:sap-stack-sc-number
2454 (setf (sap-ref-sap nfp (* (sb!c:sc-offset-offset sc-offset)
2455 sb!vm:n-word-bytes))
2456 (the system-area-pointer value)))))))
2459 (defun sub-set-debug-var-slot (fp sc-offset value &optional escaped)
2460 (macrolet ((set-escaped-value (val)
2462 (setf (sb!vm:context-register
2464 (sb!c:sc-offset-offset sc-offset))
2467 (ecase (sb!c:sc-offset-scn sc-offset)
2468 ((#.sb!vm:any-reg-sc-number #.sb!vm:descriptor-reg-sc-number)
2471 (get-lisp-obj-address value))))
2472 (#.sb!vm:base-char-reg-sc-number
2473 (set-escaped-value (char-code value)))
2474 (#.sb!vm:sap-reg-sc-number
2475 (set-escaped-value (sap-int value)))
2476 (#.sb!vm:signed-reg-sc-number
2477 (set-escaped-value (logand value (1- (ash 1 sb!vm:n-word-bits)))))
2478 (#.sb!vm:unsigned-reg-sc-number
2479 (set-escaped-value value))
2480 (#.sb!vm:single-reg-sc-number
2481 #+nil ;; don't have escaped floats.
2482 (set-escaped-float-value single-float value))
2483 (#.sb!vm:double-reg-sc-number
2484 #+nil ;; don't have escaped floats -- still in npx?
2485 (set-escaped-float-value double-float value))
2487 (#.sb!vm:long-reg-sc-number
2488 #+nil ;; don't have escaped floats -- still in npx?
2489 (set-escaped-float-value long-float value))
2490 (#.sb!vm:single-stack-sc-number
2491 (setf (sap-ref-single
2492 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2493 sb!vm:n-word-bytes)))
2494 (the single-float value)))
2495 (#.sb!vm:double-stack-sc-number
2496 (setf (sap-ref-double
2497 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2498 sb!vm:n-word-bytes)))
2499 (the double-float value)))
2501 (#.sb!vm:long-stack-sc-number
2503 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2504 sb!vm:n-word-bytes)))
2505 (the long-float value)))
2506 (#.sb!vm:complex-single-stack-sc-number
2507 (setf (sap-ref-single
2508 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2509 sb!vm:n-word-bytes)))
2510 (realpart (the (complex single-float) value)))
2511 (setf (sap-ref-single
2512 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2513 sb!vm:n-word-bytes)))
2514 (imagpart (the (complex single-float) value))))
2515 (#.sb!vm:complex-double-stack-sc-number
2516 (setf (sap-ref-double
2517 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2518 sb!vm:n-word-bytes)))
2519 (realpart (the (complex double-float) value)))
2520 (setf (sap-ref-double
2521 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 4)
2522 sb!vm:n-word-bytes)))
2523 (imagpart (the (complex double-float) value))))
2525 (#.sb!vm:complex-long-stack-sc-number
2527 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2528 sb!vm:n-word-bytes)))
2529 (realpart (the (complex long-float) value)))
2531 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 6)
2532 sb!vm:n-word-bytes)))
2533 (imagpart (the (complex long-float) value))))
2534 (#.sb!vm:control-stack-sc-number
2535 (setf (stack-ref fp (sb!c:sc-offset-offset sc-offset)) value))
2536 (#.sb!vm:base-char-stack-sc-number
2537 (setf (sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2538 sb!vm:n-word-bytes)))
2539 (char-code (the character value))))
2540 (#.sb!vm:unsigned-stack-sc-number
2541 (setf (sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2542 sb!vm:n-word-bytes)))
2543 (the (unsigned-byte 32) value)))
2544 (#.sb!vm:signed-stack-sc-number
2545 (setf (signed-sap-ref-32
2546 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2547 sb!vm:n-word-bytes)))
2548 (the (signed-byte 32) value)))
2549 (#.sb!vm:sap-stack-sc-number
2550 (setf (sap-ref-sap fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2551 sb!vm:n-word-bytes)))
2552 (the system-area-pointer value))))))
2554 ;;; The method for setting and accessing COMPILED-DEBUG-VAR values use
2555 ;;; this to determine if the value stored is the actual value or an
2556 ;;; indirection cell.
2557 (defun indirect-value-cell-p (x)
2558 (and (= (lowtag-of x) sb!vm:other-pointer-lowtag)
2559 (= (widetag-of x) sb!vm:value-cell-header-widetag)))
2561 ;;; Return three values reflecting the validity of DEBUG-VAR's value
2562 ;;; at BASIC-CODE-LOCATION:
2563 ;;; :VALID The value is known to be available.
2564 ;;; :INVALID The value is known to be unavailable.
2565 ;;; :UNKNOWN The value's availability is unknown.
2567 ;;; If the variable is always alive, then it is valid. If the
2568 ;;; code-location is unknown, then the variable's validity is
2569 ;;; :unknown. Once we've called CODE-LOCATION-UNKNOWN-P, we know the
2570 ;;; live-set information has been cached in the code-location.
2571 (defun debug-var-validity (debug-var basic-code-location)
2572 (etypecase debug-var
2574 (compiled-debug-var-validity debug-var basic-code-location))
2575 ;; (There used to be more cases back before sbcl-0.7.0, when
2576 ;; we did special tricks to debug the IR1 interpreter.)
2579 ;;; This is the method for DEBUG-VAR-VALIDITY for COMPILED-DEBUG-VARs.
2580 ;;; For safety, make sure basic-code-location is what we think.
2581 (defun compiled-debug-var-validity (debug-var basic-code-location)
2582 (declare (type compiled-code-location basic-code-location))
2583 (cond ((debug-var-alive-p debug-var)
2584 (let ((debug-fun (code-location-debug-fun basic-code-location)))
2585 (if (>= (compiled-code-location-pc basic-code-location)
2586 (sb!c::compiled-debug-fun-start-pc
2587 (compiled-debug-fun-compiler-debug-fun debug-fun)))
2590 ((code-location-unknown-p basic-code-location) :unknown)
2592 (let ((pos (position debug-var
2593 (debug-fun-debug-vars
2594 (code-location-debug-fun
2595 basic-code-location)))))
2597 (error 'unknown-debug-var
2598 :debug-var debug-var
2600 (code-location-debug-fun basic-code-location)))
2601 ;; There must be live-set info since basic-code-location is known.
2602 (if (zerop (sbit (compiled-code-location-live-set
2603 basic-code-location)
2610 ;;; This code produces and uses what we call source-paths. A
2611 ;;; source-path is a list whose first element is a form number as
2612 ;;; returned by CODE-LOCATION-FORM-NUMBER and whose last element is a
2613 ;;; top level form number as returned by
2614 ;;; CODE-LOCATION-TOPLEVEL-FORM-NUMBER. The elements from the last to
2615 ;;; the first, exclusively, are the numbered subforms into which to
2616 ;;; descend. For example:
2618 ;;; (let ((a (aref x 3)))
2620 ;;; The call to AREF in this example is form number 5. Assuming this
2621 ;;; DEFUN is the 11'th top level form, the source-path for the AREF
2622 ;;; call is as follows:
2624 ;;; Given the DEFUN, 3 gets you the LET, 1 gets you the bindings, 0
2625 ;;; gets the first binding, and 1 gets the AREF form.
2627 ;;; temporary buffer used to build form-number => source-path translation in
2628 ;;; FORM-NUMBER-TRANSLATIONS
2629 (defvar *form-number-temp* (make-array 10 :fill-pointer 0 :adjustable t))
2631 ;;; table used to detect CAR circularities in FORM-NUMBER-TRANSLATIONS
2632 (defvar *form-number-circularity-table* (make-hash-table :test 'eq))
2634 ;;; This returns a table mapping form numbers to source-paths. A
2635 ;;; source-path indicates a descent into the TOPLEVEL-FORM form,
2636 ;;; going directly to the subform corressponding to the form number.
2638 ;;; The vector elements are in the same format as the compiler's
2639 ;;; NODE-SOURCE-PATH; that is, the first element is the form number and
2640 ;;; the last is the TOPLEVEL-FORM number.
2641 (defun form-number-translations (form tlf-number)
2642 (clrhash *form-number-circularity-table*)
2643 (setf (fill-pointer *form-number-temp*) 0)
2644 (sub-translate-form-numbers form (list tlf-number))
2645 (coerce *form-number-temp* 'simple-vector))
2646 (defun sub-translate-form-numbers (form path)
2647 (unless (gethash form *form-number-circularity-table*)
2648 (setf (gethash form *form-number-circularity-table*) t)
2649 (vector-push-extend (cons (fill-pointer *form-number-temp*) path)
2654 (declare (fixnum pos))
2657 (when (atom subform) (return))
2658 (let ((fm (car subform)))
2660 (sub-translate-form-numbers fm (cons pos path)))
2662 (setq subform (cdr subform))
2663 (when (eq subform trail) (return)))))
2667 (setq trail (cdr trail)))))))
2669 ;;; FORM is a top level form, and path is a source-path into it. This
2670 ;;; returns the form indicated by the source-path. Context is the
2671 ;;; number of enclosing forms to return instead of directly returning
2672 ;;; the source-path form. When context is non-zero, the form returned
2673 ;;; contains a marker, #:****HERE****, immediately before the form
2674 ;;; indicated by path.
2675 (defun source-path-context (form path context)
2676 (declare (type unsigned-byte context))
2677 ;; Get to the form indicated by path or the enclosing form indicated
2678 ;; by context and path.
2679 (let ((path (reverse (butlast (cdr path)))))
2680 (dotimes (i (- (length path) context))
2681 (let ((index (first path)))
2682 (unless (and (listp form) (< index (length form)))
2683 (error "Source path no longer exists."))
2684 (setq form (elt form index))
2685 (setq path (rest path))))
2686 ;; Recursively rebuild the source form resulting from the above
2687 ;; descent, copying the beginning of each subform up to the next
2688 ;; subform we descend into according to path. At the bottom of the
2689 ;; recursion, we return the form indicated by path preceded by our
2690 ;; marker, and this gets spliced into the resulting list structure
2691 ;; on the way back up.
2692 (labels ((frob (form path level)
2693 (if (or (zerop level) (null path))
2696 `(#:***here*** ,form))
2697 (let ((n (first path)))
2698 (unless (and (listp form) (< n (length form)))
2699 (error "Source path no longer exists."))
2700 (let ((res (frob (elt form n) (rest path) (1- level))))
2701 (nconc (subseq form 0 n)
2702 (cons res (nthcdr (1+ n) form))))))))
2703 (frob form path context))))
2705 ;;;; PREPROCESS-FOR-EVAL
2707 ;;; Return a function of one argument that evaluates form in the
2708 ;;; lexical context of the BASIC-CODE-LOCATION LOC, or signal a
2709 ;;; NO-DEBUG-VARS condition when the LOC's DEBUG-FUN has no
2710 ;;; DEBUG-VAR information available.
2712 ;;; The returned function takes the frame to get values from as its
2713 ;;; argument, and it returns the values of FORM. The returned function
2714 ;;; can signal the following conditions: INVALID-VALUE,
2715 ;;; AMBIGUOUS-VAR-NAME, and FRAME-FUN-MISMATCH.
2716 (defun preprocess-for-eval (form loc)
2717 (declare (type code-location loc))
2718 (let ((n-frame (gensym))
2719 (fun (code-location-debug-fun loc)))
2720 (unless (debug-var-info-available fun)
2721 (debug-signal 'no-debug-vars :debug-fun fun))
2722 (sb!int:collect ((binds)
2724 (do-debug-fun-vars (var fun)
2725 (let ((validity (debug-var-validity var loc)))
2726 (unless (eq validity :invalid)
2727 (let* ((sym (debug-var-symbol var))
2728 (found (assoc sym (binds))))
2730 (setf (second found) :ambiguous)
2731 (binds (list sym validity var)))))))
2732 (dolist (bind (binds))
2733 (let ((name (first bind))
2735 (ecase (second bind)
2737 (specs `(,name (debug-var-value ',var ,n-frame))))
2739 (specs `(,name (debug-signal 'invalid-value
2743 (specs `(,name (debug-signal 'ambiguous-var-name
2745 :frame ,n-frame)))))))
2746 (let ((res (coerce `(lambda (,n-frame)
2747 (declare (ignorable ,n-frame))
2748 (symbol-macrolet ,(specs) ,form))
2751 ;; This prevents these functions from being used in any
2752 ;; location other than a function return location, so maybe
2753 ;; this should only check whether FRAME's DEBUG-FUN is the
2755 (unless (code-location= (frame-code-location frame) loc)
2756 (debug-signal 'frame-fun-mismatch
2757 :code-location loc :form form :frame frame))
2758 (funcall res frame))))))
2762 ;;;; user-visible interface
2764 ;;; Create and return a breakpoint. When program execution encounters
2765 ;;; the breakpoint, the system calls HOOK-FUN. HOOK-FUN takes the
2766 ;;; current frame for the function in which the program is running and
2767 ;;; the breakpoint object.
2769 ;;; WHAT and KIND determine where in a function the system invokes
2770 ;;; HOOK-FUN. WHAT is either a code-location or a DEBUG-FUN. KIND is
2771 ;;; one of :CODE-LOCATION, :FUN-START, or :FUN-END. Since the starts
2772 ;;; and ends of functions may not have code-locations representing
2773 ;;; them, designate these places by supplying WHAT as a DEBUG-FUN and
2774 ;;; KIND indicating the :FUN-START or :FUN-END. When WHAT is a
2775 ;;; DEBUG-FUN and kind is :FUN-END, then HOOK-FUN must take two
2776 ;;; additional arguments, a list of values returned by the function
2777 ;;; and a FUN-END-COOKIE.
2779 ;;; INFO is information supplied by and used by the user.
2781 ;;; FUN-END-COOKIE is a function. To implement :FUN-END
2782 ;;; breakpoints, the system uses starter breakpoints to establish the
2783 ;;; :FUN-END breakpoint for each invocation of the function. Upon
2784 ;;; each entry, the system creates a unique cookie to identify the
2785 ;;; invocation, and when the user supplies a function for this
2786 ;;; argument, the system invokes it on the frame and the cookie. The
2787 ;;; system later invokes the :FUN-END breakpoint hook on the same
2788 ;;; cookie. The user may save the cookie for comparison in the hook
2791 ;;; Signal an error if WHAT is an unknown code-location.
2792 (defun make-breakpoint (hook-fun what
2793 &key (kind :code-location) info fun-end-cookie)
2796 (when (code-location-unknown-p what)
2797 (error "cannot make a breakpoint at an unknown code location: ~S"
2799 (aver (eq kind :code-location))
2800 (let ((bpt (%make-breakpoint hook-fun what kind info)))
2802 (compiled-code-location
2803 ;; This slot is filled in due to calling CODE-LOCATION-UNKNOWN-P.
2804 (when (eq (compiled-code-location-kind what) :unknown-return)
2805 (let ((other-bpt (%make-breakpoint hook-fun what
2806 :unknown-return-partner
2808 (setf (breakpoint-unknown-return-partner bpt) other-bpt)
2809 (setf (breakpoint-unknown-return-partner other-bpt) bpt))))
2810 ;; (There used to be more cases back before sbcl-0.7.0,,
2811 ;; when we did special tricks to debug the IR1
2818 (%make-breakpoint hook-fun what kind info))
2820 (unless (eq (sb!c::compiled-debug-fun-returns
2821 (compiled-debug-fun-compiler-debug-fun what))
2823 (error ":FUN-END breakpoints are currently unsupported ~
2824 for the known return convention."))
2826 (let* ((bpt (%make-breakpoint hook-fun what kind info))
2827 (starter (compiled-debug-fun-end-starter what)))
2829 (setf starter (%make-breakpoint #'list what :fun-start nil))
2830 (setf (breakpoint-hook-fun starter)
2831 (fun-end-starter-hook starter what))
2832 (setf (compiled-debug-fun-end-starter what) starter))
2833 (setf (breakpoint-start-helper bpt) starter)
2834 (push bpt (breakpoint-%info starter))
2835 (setf (breakpoint-cookie-fun bpt) fun-end-cookie)
2838 ;;; These are unique objects created upon entry into a function by a
2839 ;;; :FUN-END breakpoint's starter hook. These are only created
2840 ;;; when users supply :FUN-END-COOKIE to MAKE-BREAKPOINT. Also,
2841 ;;; the :FUN-END breakpoint's hook is called on the same cookie
2842 ;;; when it is created.
2843 (defstruct (fun-end-cookie
2844 (:print-object (lambda (obj str)
2845 (print-unreadable-object (obj str :type t))))
2846 (:constructor make-fun-end-cookie (bogus-lra debug-fun))
2848 ;; a pointer to the bogus-lra created for :FUN-END breakpoints
2850 ;; the DEBUG-FUN associated with this cookie
2853 ;;; This maps bogus-lra-components to cookies, so that
2854 ;;; HANDLE-FUN-END-BREAKPOINT can find the appropriate cookie for the
2855 ;;; breakpoint hook.
2856 (defvar *fun-end-cookies* (make-hash-table :test 'eq))
2858 ;;; This returns a hook function for the start helper breakpoint
2859 ;;; associated with a :FUN-END breakpoint. The returned function
2860 ;;; makes a fake LRA that all returns go through, and this piece of
2861 ;;; fake code actually breaks. Upon return from the break, the code
2862 ;;; provides the returnee with any values. Since the returned function
2863 ;;; effectively activates FUN-END-BPT on each entry to DEBUG-FUN's
2864 ;;; function, we must establish breakpoint-data about FUN-END-BPT.
2865 (defun fun-end-starter-hook (starter-bpt debug-fun)
2866 (declare (type breakpoint starter-bpt)
2867 (type compiled-debug-fun debug-fun))
2868 (lambda (frame breakpoint)
2869 (declare (ignore breakpoint)
2871 (let ((lra-sc-offset
2872 (sb!c::compiled-debug-fun-return-pc
2873 (compiled-debug-fun-compiler-debug-fun debug-fun))))
2874 (multiple-value-bind (lra component offset)
2876 (get-context-value frame
2879 (setf (get-context-value frame
2883 (let ((end-bpts (breakpoint-%info starter-bpt)))
2884 (let ((data (breakpoint-data component offset)))
2885 (setf (breakpoint-data-breakpoints data) end-bpts)
2886 (dolist (bpt end-bpts)
2887 (setf (breakpoint-internal-data bpt) data)))
2888 (let ((cookie (make-fun-end-cookie lra debug-fun)))
2889 (setf (gethash component *fun-end-cookies*) cookie)
2890 (dolist (bpt end-bpts)
2891 (let ((fun (breakpoint-cookie-fun bpt)))
2892 (when fun (funcall fun frame cookie))))))))))
2894 ;;; This takes a FUN-END-COOKIE and a frame, and it returns
2895 ;;; whether the cookie is still valid. A cookie becomes invalid when
2896 ;;; the frame that established the cookie has exited. Sometimes cookie
2897 ;;; holders are unaware of cookie invalidation because their
2898 ;;; :FUN-END breakpoint hooks didn't run due to THROW'ing.
2900 ;;; This takes a frame as an efficiency hack since the user probably
2901 ;;; has a frame object in hand when using this routine, and it saves
2902 ;;; repeated parsing of the stack and consing when asking whether a
2903 ;;; series of cookies is valid.
2904 (defun fun-end-cookie-valid-p (frame cookie)
2905 (let ((lra (fun-end-cookie-bogus-lra cookie))
2906 (lra-sc-offset (sb!c::compiled-debug-fun-return-pc
2907 (compiled-debug-fun-compiler-debug-fun
2908 (fun-end-cookie-debug-fun cookie)))))
2909 (do ((frame frame (frame-down frame)))
2911 (when (and (compiled-frame-p frame)
2912 (#!-x86 eq #!+x86 sap=
2914 (get-context-value frame lra-save-offset lra-sc-offset)))
2917 ;;;; ACTIVATE-BREAKPOINT
2919 ;;; Cause the system to invoke the breakpoint's hook function until
2920 ;;; the next call to DEACTIVATE-BREAKPOINT or DELETE-BREAKPOINT. The
2921 ;;; system invokes breakpoint hook functions in the opposite order
2922 ;;; that you activate them.
2923 (defun activate-breakpoint (breakpoint)
2924 (when (eq (breakpoint-status breakpoint) :deleted)
2925 (error "cannot activate a deleted breakpoint: ~S" breakpoint))
2926 (unless (eq (breakpoint-status breakpoint) :active)
2927 (ecase (breakpoint-kind breakpoint)
2929 (let ((loc (breakpoint-what breakpoint)))
2931 (compiled-code-location
2932 (activate-compiled-code-location-breakpoint breakpoint)
2933 (let ((other (breakpoint-unknown-return-partner breakpoint)))
2935 (activate-compiled-code-location-breakpoint other))))
2936 ;; (There used to be more cases back before sbcl-0.7.0, when
2937 ;; we did special tricks to debug the IR1 interpreter.)
2940 (etypecase (breakpoint-what breakpoint)
2942 (activate-compiled-fun-start-breakpoint breakpoint))
2943 ;; (There used to be more cases back before sbcl-0.7.0, when
2944 ;; we did special tricks to debug the IR1 interpreter.)
2947 (etypecase (breakpoint-what breakpoint)
2949 (let ((starter (breakpoint-start-helper breakpoint)))
2950 (unless (eq (breakpoint-status starter) :active)
2951 ;; may already be active by some other :FUN-END breakpoint
2952 (activate-compiled-fun-start-breakpoint starter)))
2953 (setf (breakpoint-status breakpoint) :active))
2954 ;; (There used to be more cases back before sbcl-0.7.0, when
2955 ;; we did special tricks to debug the IR1 interpreter.)
2959 (defun activate-compiled-code-location-breakpoint (breakpoint)
2960 (declare (type breakpoint breakpoint))
2961 (let ((loc (breakpoint-what breakpoint)))
2962 (declare (type compiled-code-location loc))
2963 (sub-activate-breakpoint
2965 (breakpoint-data (compiled-debug-fun-component
2966 (code-location-debug-fun loc))
2967 (+ (compiled-code-location-pc loc)
2968 (if (or (eq (breakpoint-kind breakpoint)
2969 :unknown-return-partner)
2970 (eq (compiled-code-location-kind loc)
2971 :single-value-return))
2972 sb!vm:single-value-return-byte-offset
2975 (defun activate-compiled-fun-start-breakpoint (breakpoint)
2976 (declare (type breakpoint breakpoint))
2977 (let ((debug-fun (breakpoint-what breakpoint)))
2978 (sub-activate-breakpoint
2980 (breakpoint-data (compiled-debug-fun-component debug-fun)
2981 (sb!c::compiled-debug-fun-start-pc
2982 (compiled-debug-fun-compiler-debug-fun
2985 (defun sub-activate-breakpoint (breakpoint data)
2986 (declare (type breakpoint breakpoint)
2987 (type breakpoint-data data))
2988 (setf (breakpoint-status breakpoint) :active)
2990 (unless (breakpoint-data-breakpoints data)
2991 (setf (breakpoint-data-instruction data)
2993 (breakpoint-install (get-lisp-obj-address
2994 (breakpoint-data-component data))
2995 (breakpoint-data-offset data)))))
2996 (setf (breakpoint-data-breakpoints data)
2997 (append (breakpoint-data-breakpoints data) (list breakpoint)))
2998 (setf (breakpoint-internal-data breakpoint) data)))
3000 ;;;; DEACTIVATE-BREAKPOINT
3002 ;;; Stop the system from invoking the breakpoint's hook function.
3003 (defun deactivate-breakpoint (breakpoint)
3004 (when (eq (breakpoint-status breakpoint) :active)
3006 (let ((loc (breakpoint-what breakpoint)))
3008 ((or compiled-code-location compiled-debug-fun)
3009 (deactivate-compiled-breakpoint breakpoint)
3010 (let ((other (breakpoint-unknown-return-partner breakpoint)))
3012 (deactivate-compiled-breakpoint other))))
3013 ;; (There used to be more cases back before sbcl-0.7.0, when
3014 ;; we did special tricks to debug the IR1 interpreter.)
3018 (defun deactivate-compiled-breakpoint (breakpoint)
3019 (if (eq (breakpoint-kind breakpoint) :fun-end)
3020 (let ((starter (breakpoint-start-helper breakpoint)))
3021 (unless (find-if (lambda (bpt)
3022 (and (not (eq bpt breakpoint))
3023 (eq (breakpoint-status bpt) :active)))
3024 (breakpoint-%info starter))
3025 (deactivate-compiled-breakpoint starter)))
3026 (let* ((data (breakpoint-internal-data breakpoint))
3027 (bpts (delete breakpoint (breakpoint-data-breakpoints data))))
3028 (setf (breakpoint-internal-data breakpoint) nil)
3029 (setf (breakpoint-data-breakpoints data) bpts)
3032 (breakpoint-remove (get-lisp-obj-address
3033 (breakpoint-data-component data))
3034 (breakpoint-data-offset data)
3035 (breakpoint-data-instruction data)))
3036 (delete-breakpoint-data data))))
3037 (setf (breakpoint-status breakpoint) :inactive)
3040 ;;;; BREAKPOINT-INFO
3042 ;;; Return the user-maintained info associated with breakpoint. This
3044 (defun breakpoint-info (breakpoint)
3045 (breakpoint-%info breakpoint))
3046 (defun %set-breakpoint-info (breakpoint value)
3047 (setf (breakpoint-%info breakpoint) value)
3048 (let ((other (breakpoint-unknown-return-partner breakpoint)))
3050 (setf (breakpoint-%info other) value))))
3052 ;;;; BREAKPOINT-ACTIVE-P and DELETE-BREAKPOINT
3054 (defun breakpoint-active-p (breakpoint)
3055 (ecase (breakpoint-status breakpoint)
3057 ((:inactive :deleted) nil)))
3059 ;;; Free system storage and remove computational overhead associated
3060 ;;; with breakpoint. After calling this, breakpoint is completely
3061 ;;; impotent and can never become active again.
3062 (defun delete-breakpoint (breakpoint)
3063 (let ((status (breakpoint-status breakpoint)))
3064 (unless (eq status :deleted)
3065 (when (eq status :active)
3066 (deactivate-breakpoint breakpoint))
3067 (setf (breakpoint-status breakpoint) :deleted)
3068 (let ((other (breakpoint-unknown-return-partner breakpoint)))
3070 (setf (breakpoint-status other) :deleted)))
3071 (when (eq (breakpoint-kind breakpoint) :fun-end)
3072 (let* ((starter (breakpoint-start-helper breakpoint))
3073 (breakpoints (delete breakpoint
3074 (the list (breakpoint-info starter)))))
3075 (setf (breakpoint-info starter) breakpoints)
3077 (delete-breakpoint starter)
3078 (setf (compiled-debug-fun-end-starter
3079 (breakpoint-what breakpoint))
3083 ;;;; C call out stubs
3085 ;;; This actually installs the break instruction in the component. It
3086 ;;; returns the overwritten bits. You must call this in a context in
3087 ;;; which GC is disabled, so that Lisp doesn't move objects around
3088 ;;; that C is pointing to.
3089 (sb!alien:define-alien-routine "breakpoint_install" sb!alien:unsigned-long
3090 (code-obj sb!alien:unsigned-long)
3091 (pc-offset sb!alien:int))
3093 ;;; This removes the break instruction and replaces the original
3094 ;;; instruction. You must call this in a context in which GC is disabled
3095 ;;; so Lisp doesn't move objects around that C is pointing to.
3096 (sb!alien:define-alien-routine "breakpoint_remove" sb!alien:void
3097 (code-obj sb!alien:unsigned-long)
3098 (pc-offset sb!alien:int)
3099 (old-inst sb!alien:unsigned-long))
3101 (sb!alien:define-alien-routine "breakpoint_do_displaced_inst" sb!alien:void
3102 (scp (* os-context-t))
3103 (orig-inst sb!alien:unsigned-long))
3105 ;;;; breakpoint handlers (layer between C and exported interface)
3107 ;;; This maps components to a mapping of offsets to BREAKPOINT-DATAs.
3108 (defvar *component-breakpoint-offsets* (make-hash-table :test 'eq))
3110 ;;; This returns the BREAKPOINT-DATA object associated with component cross
3111 ;;; offset. If none exists, this makes one, installs it, and returns it.
3112 (defun breakpoint-data (component offset &optional (create t))
3113 (flet ((install-breakpoint-data ()
3115 (let ((data (make-breakpoint-data component offset)))
3116 (push (cons offset data)
3117 (gethash component *component-breakpoint-offsets*))
3119 (let ((offsets (gethash component *component-breakpoint-offsets*)))
3121 (let ((data (assoc offset offsets)))
3124 (install-breakpoint-data)))
3125 (install-breakpoint-data)))))
3127 ;;; We use this when there are no longer any active breakpoints
3128 ;;; corresponding to DATA.
3129 (defun delete-breakpoint-data (data)
3130 (let* ((component (breakpoint-data-component data))
3131 (offsets (delete (breakpoint-data-offset data)
3132 (gethash component *component-breakpoint-offsets*)
3135 (setf (gethash component *component-breakpoint-offsets*) offsets)
3136 (remhash component *component-breakpoint-offsets*)))
3139 ;;; The C handler for interrupts calls this when it has a
3140 ;;; debugging-tool break instruction. This does *not* handle all
3141 ;;; breaks; for example, it does not handle breaks for internal
3143 (defun handle-breakpoint (offset component signal-context)
3144 (let ((data (breakpoint-data component offset nil)))
3146 (error "unknown breakpoint in ~S at offset ~S"
3147 (debug-fun-name (debug-fun-from-pc component offset))
3149 (let ((breakpoints (breakpoint-data-breakpoints data)))
3150 (if (or (null breakpoints)
3151 (eq (breakpoint-kind (car breakpoints)) :fun-end))
3152 (handle-fun-end-breakpoint-aux breakpoints data signal-context)
3153 (handle-breakpoint-aux breakpoints data
3154 offset component signal-context)))))
3156 ;;; This holds breakpoint-datas while invoking the breakpoint hooks
3157 ;;; associated with that particular component and location. While they
3158 ;;; are executing, if we hit the location again, we ignore the
3159 ;;; breakpoint to avoid infinite recursion. fun-end breakpoints
3160 ;;; must work differently since the breakpoint-data is unique for each
3162 (defvar *executing-breakpoint-hooks* nil)
3164 ;;; This handles code-location and DEBUG-FUN :FUN-START
3166 (defun handle-breakpoint-aux (breakpoints data offset component signal-context)
3168 (bug "breakpoint that nobody wants"))
3169 (unless (member data *executing-breakpoint-hooks*)
3170 (let ((*executing-breakpoint-hooks* (cons data
3171 *executing-breakpoint-hooks*)))
3172 (invoke-breakpoint-hooks breakpoints component offset)))
3173 ;; At this point breakpoints may not hold the same list as
3174 ;; BREAKPOINT-DATA-BREAKPOINTS since invoking hooks may have allowed
3175 ;; a breakpoint deactivation. In fact, if all breakpoints were
3176 ;; deactivated then data is invalid since it was deleted and so the
3177 ;; correct one must be looked up if it is to be used. If there are
3178 ;; no more breakpoints active at this location, then the normal
3179 ;; instruction has been put back, and we do not need to
3180 ;; DO-DISPLACED-INST.
3181 (let ((data (breakpoint-data component offset nil)))
3182 (when (and data (breakpoint-data-breakpoints data))
3183 ;; The breakpoint is still active, so we need to execute the
3184 ;; displaced instruction and leave the breakpoint instruction
3185 ;; behind. The best way to do this is different on each machine,
3186 ;; so we just leave it up to the C code.
3187 (breakpoint-do-displaced-inst signal-context
3188 (breakpoint-data-instruction data))
3189 ;; Some platforms have no usable sigreturn() call. If your
3190 ;; implementation of arch_do_displaced_inst() _does_ sigreturn(),
3191 ;; it's polite to warn here
3192 #!+(and sparc solaris)
3193 (error "BREAKPOINT-DO-DISPLACED-INST returned?"))))
3195 (defun invoke-breakpoint-hooks (breakpoints component offset)
3196 (let* ((debug-fun (debug-fun-from-pc component offset))
3197 (frame (do ((f (top-frame) (frame-down f)))
3198 ((eq debug-fun (frame-debug-fun f)) f))))
3199 (dolist (bpt breakpoints)
3200 (funcall (breakpoint-hook-fun bpt)
3202 ;; If this is an :UNKNOWN-RETURN-PARTNER, then pass the
3203 ;; hook function the original breakpoint, so that users
3204 ;; aren't forced to confront the fact that some
3205 ;; breakpoints really are two.
3206 (if (eq (breakpoint-kind bpt) :unknown-return-partner)
3207 (breakpoint-unknown-return-partner bpt)
3210 (defun handle-fun-end-breakpoint (offset component context)
3211 (let ((data (breakpoint-data component offset nil)))
3213 (error "unknown breakpoint in ~S at offset ~S"
3214 (debug-fun-name (debug-fun-from-pc component offset))
3216 (let ((breakpoints (breakpoint-data-breakpoints data)))
3218 (aver (eq (breakpoint-kind (car breakpoints)) :fun-end))
3219 (handle-fun-end-breakpoint-aux breakpoints data context)))))
3221 ;;; Either HANDLE-BREAKPOINT calls this for :FUN-END breakpoints
3222 ;;; [old C code] or HANDLE-FUN-END-BREAKPOINT calls this directly
3224 (defun handle-fun-end-breakpoint-aux (breakpoints data signal-context)
3225 (delete-breakpoint-data data)
3228 (declare (optimize (inhibit-warnings 3)))
3229 (sb!alien:sap-alien signal-context (* os-context-t))))
3230 (frame (do ((cfp (sb!vm:context-register scp sb!vm::cfp-offset))
3231 (f (top-frame) (frame-down f)))
3232 ((= cfp (sap-int (frame-pointer f))) f)
3233 (declare (type (unsigned-byte #.sb!vm:n-word-bits) cfp))))
3234 (component (breakpoint-data-component data))
3235 (cookie (gethash component *fun-end-cookies*)))
3236 (remhash component *fun-end-cookies*)
3237 (dolist (bpt breakpoints)
3238 (funcall (breakpoint-hook-fun bpt)
3240 (get-fun-end-breakpoint-values scp)
3243 (defun get-fun-end-breakpoint-values (scp)
3244 (let ((ocfp (int-sap (sb!vm:context-register
3246 #!-x86 sb!vm::ocfp-offset
3247 #!+x86 sb!vm::ebx-offset)))
3248 (nargs (make-lisp-obj
3249 (sb!vm:context-register scp sb!vm::nargs-offset)))
3250 (reg-arg-offsets '#.sb!vm::*register-arg-offsets*)
3253 (dotimes (arg-num nargs)
3254 (push (if reg-arg-offsets
3256 (sb!vm:context-register scp (pop reg-arg-offsets)))
3257 (stack-ref ocfp arg-num))
3259 (nreverse results)))
3261 ;;;; MAKE-BOGUS-LRA (used for :FUN-END breakpoints)
3263 (defconstant bogus-lra-constants
3265 (defconstant known-return-p-slot
3266 (+ sb!vm:code-constants-offset #!-x86 1 #!+x86 2))
3268 ;;; Make a bogus LRA object that signals a breakpoint trap when
3269 ;;; returned to. If the breakpoint trap handler returns, REAL-LRA is
3270 ;;; returned to. Three values are returned: the bogus LRA object, the
3271 ;;; code component it is part of, and the PC offset for the trap
3273 (defun make-bogus-lra (real-lra &optional known-return-p)
3275 (let* ((src-start (foreign-symbol-address "fun_end_breakpoint_guts"))
3276 (src-end (foreign-symbol-address "fun_end_breakpoint_end"))
3277 (trap-loc (foreign-symbol-address "fun_end_breakpoint_trap"))
3278 (length (sap- src-end src-start))
3280 (%primitive sb!c:allocate-code-object (1+ bogus-lra-constants)
3282 (dst-start (code-instructions code-object)))
3283 (declare (type system-area-pointer
3284 src-start src-end dst-start trap-loc)
3285 (type index length))
3286 (setf (%code-debug-info code-object) :bogus-lra)
3287 (setf (code-header-ref code-object sb!vm:code-trace-table-offset-slot)
3290 (setf (code-header-ref code-object real-lra-slot) real-lra)
3292 (multiple-value-bind (offset code) (compute-lra-data-from-pc real-lra)
3293 (setf (code-header-ref code-object real-lra-slot) code)
3294 (setf (code-header-ref code-object (1+ real-lra-slot)) offset))
3295 (setf (code-header-ref code-object known-return-p-slot)
3297 (system-area-copy src-start 0 dst-start 0 (* length sb!vm:n-byte-bits))
3298 (sb!vm:sanctify-for-execution code-object)
3300 (values dst-start code-object (sap- trap-loc src-start))
3302 (let ((new-lra (make-lisp-obj (+ (sap-int dst-start)
3303 sb!vm:other-pointer-lowtag))))
3306 (logandc2 (+ sb!vm:code-constants-offset bogus-lra-constants 1)
3308 (sb!vm:sanctify-for-execution code-object)
3309 (values new-lra code-object (sap- trap-loc src-start))))))
3313 ;;; This appears here because it cannot go with the DEBUG-FUN
3314 ;;; interface since DO-DEBUG-BLOCK-LOCATIONS isn't defined until after
3315 ;;; the DEBUG-FUN routines.
3317 ;;; Return a code-location before the body of a function and after all
3318 ;;; the arguments are in place; or if that location can't be
3319 ;;; determined due to a lack of debug information, return NIL.
3320 (defun debug-fun-start-location (debug-fun)
3321 (etypecase debug-fun
3323 (code-location-from-pc debug-fun
3324 (sb!c::compiled-debug-fun-start-pc
3325 (compiled-debug-fun-compiler-debug-fun
3328 ;; (There used to be more cases back before sbcl-0.7.0, when
3329 ;; we did special tricks to debug the IR1 interpreter.)