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 (sb!vm::return-machine-address scp))
1006 (code-header-len (* (get-header-data code) sb!vm:n-word-bytes)))
1007 (values (- return-machine-address
1008 (- (get-lisp-obj-address code)
1009 sb!vm:other-pointer-lowtag)
1011 return-machine-address)))
1013 ;;; Find the code object corresponding to the object represented by
1014 ;;; bits and return it. We assume bogus functions correspond to the
1015 ;;; undefined-function.
1016 (defun code-object-from-bits (bits)
1017 (declare (type (unsigned-byte 32) bits))
1018 (let ((object (make-lisp-obj bits)))
1019 (if (functionp object)
1020 (or (fun-code-header object)
1021 :undefined-function)
1022 (let ((lowtag (lowtag-of object)))
1023 (if (= lowtag sb!vm:other-pointer-lowtag)
1024 (let ((widetag (widetag-of object)))
1025 (cond ((= widetag sb!vm:code-header-widetag)
1027 ((= widetag sb!vm:return-pc-header-widetag)
1028 (lra-code-header object))
1032 ;;;; frame utilities
1034 ;;; This returns a COMPILED-DEBUG-FUN for COMPONENT and PC. We fetch the
1035 ;;; SB!C::DEBUG-INFO and run down its FUN-MAP to get a
1036 ;;; SB!C::COMPILED-DEBUG-FUN from the PC. The result only needs to
1037 ;;; reference the COMPONENT, for function constants, and the
1038 ;;; SB!C::COMPILED-DEBUG-FUN.
1039 (defun debug-fun-from-pc (component pc)
1040 (let ((info (%code-debug-info component)))
1043 (debug-signal 'no-debug-info :code-component component))
1044 ((eq info :bogus-lra)
1045 (make-bogus-debug-fun "function end breakpoint"))
1047 (let* ((fun-map (sb!c::compiled-debug-info-fun-map info))
1048 (len (length fun-map)))
1049 (declare (type simple-vector fun-map))
1051 (make-compiled-debug-fun (svref fun-map 0) component)
1054 (>= pc (sb!c::compiled-debug-fun-elsewhere-pc
1055 (svref fun-map 0)))))
1056 (declare (type sb!int:index i))
1059 (< pc (if elsewhere-p
1060 (sb!c::compiled-debug-fun-elsewhere-pc
1061 (svref fun-map (1+ i)))
1062 (svref fun-map i))))
1063 (return (make-compiled-debug-fun
1064 (svref fun-map (1- i))
1068 ;;; This returns a code-location for the COMPILED-DEBUG-FUN,
1069 ;;; DEBUG-FUN, and the pc into its code vector. If we stopped at a
1070 ;;; breakpoint, find the CODE-LOCATION for that breakpoint. Otherwise,
1071 ;;; make an :UNSURE code location, so it can be filled in when we
1072 ;;; figure out what is going on.
1073 (defun code-location-from-pc (debug-fun pc escaped)
1074 (or (and (compiled-debug-fun-p debug-fun)
1076 (let ((data (breakpoint-data
1077 (compiled-debug-fun-component debug-fun)
1079 (when (and data (breakpoint-data-breakpoints data))
1080 (let ((what (breakpoint-what
1081 (first (breakpoint-data-breakpoints data)))))
1082 (when (compiled-code-location-p what)
1084 (make-compiled-code-location pc debug-fun)))
1086 ;;; Return an alist mapping catch tags to CODE-LOCATIONs. These are
1087 ;;; CODE-LOCATIONs at which execution would continue with frame as the
1088 ;;; top frame if someone threw to the corresponding tag.
1089 (defun frame-catches (frame)
1090 (let ((catch (descriptor-sap sb!vm:*current-catch-block*))
1091 (reversed-result nil)
1092 (fp (frame-pointer frame)))
1093 (loop until (zerop (sap-int catch))
1094 finally (return (nreverse reversed-result))
1099 (* sb!vm:catch-block-current-cont-slot
1100 sb!vm:n-word-bytes))
1104 (* sb!vm:catch-block-current-cont-slot
1105 sb!vm:n-word-bytes))))
1107 (lra (stack-ref catch sb!vm:catch-block-entry-pc-slot))
1110 catch (* sb!vm:catch-block-entry-pc-slot
1111 sb!vm:n-word-bytes)))
1114 (stack-ref catch sb!vm:catch-block-current-code-slot))
1116 (component (component-from-component-ptr
1117 (component-ptr-from-pc ra)))
1120 (* (- (1+ (get-header-data lra))
1121 (get-header-data component))
1125 (- (get-lisp-obj-address component)
1126 sb!vm:other-pointer-lowtag)
1127 (* (get-header-data component) sb!vm:n-word-bytes))))
1129 (stack-ref catch sb!vm:catch-block-tag-slot)
1132 (sap-ref-32 catch (* sb!vm:catch-block-tag-slot
1133 sb!vm:n-word-bytes)))
1134 (make-compiled-code-location
1135 offset (frame-debug-fun frame)))
1140 (* sb!vm:catch-block-previous-catch-slot
1141 sb!vm:n-word-bytes))
1145 (* sb!vm:catch-block-previous-catch-slot
1146 sb!vm:n-word-bytes)))))))
1148 ;;;; operations on DEBUG-FUNs
1150 ;;; Execute the forms in a context with BLOCK-VAR bound to each
1151 ;;; DEBUG-BLOCK in DEBUG-FUN successively. Result is an optional
1152 ;;; form to execute for return values, and DO-DEBUG-FUN-BLOCKS
1153 ;;; returns nil if there is no result form. This signals a
1154 ;;; NO-DEBUG-BLOCKS condition when the DEBUG-FUN lacks
1155 ;;; DEBUG-BLOCK information.
1156 (defmacro do-debug-fun-blocks ((block-var debug-fun &optional result)
1158 (let ((blocks (gensym))
1160 `(let ((,blocks (debug-fun-debug-blocks ,debug-fun)))
1161 (declare (simple-vector ,blocks))
1162 (dotimes (,i (length ,blocks) ,result)
1163 (let ((,block-var (svref ,blocks ,i)))
1166 ;;; Execute body in a context with VAR bound to each DEBUG-VAR in
1167 ;;; DEBUG-FUN. This returns the value of executing result (defaults to
1168 ;;; nil). This may iterate over only some of DEBUG-FUN's variables or
1169 ;;; none depending on debug policy; for example, possibly the
1170 ;;; compilation only preserved argument information.
1171 (defmacro do-debug-fun-vars ((var debug-fun &optional result) &body body)
1172 (let ((vars (gensym))
1174 `(let ((,vars (debug-fun-debug-vars ,debug-fun)))
1175 (declare (type (or null simple-vector) ,vars))
1177 (dotimes (,i (length ,vars) ,result)
1178 (let ((,var (svref ,vars ,i)))
1182 ;;; Return the object of type FUNCTION associated with the DEBUG-FUN,
1183 ;;; or NIL if the function is unavailable or is non-existent as a user
1184 ;;; callable function object.
1185 (defun debug-fun-fun (debug-fun)
1186 (let ((cached-value (debug-fun-%function debug-fun)))
1187 (if (eq cached-value :unparsed)
1188 (setf (debug-fun-%function debug-fun)
1189 (etypecase debug-fun
1192 (compiled-debug-fun-component debug-fun))
1194 (sb!c::compiled-debug-fun-start-pc
1195 (compiled-debug-fun-compiler-debug-fun debug-fun))))
1196 (do ((entry (%code-entry-points component)
1197 (%simple-fun-next entry)))
1200 (sb!c::compiled-debug-fun-start-pc
1201 (compiled-debug-fun-compiler-debug-fun
1202 (fun-debug-fun entry))))
1204 (bogus-debug-fun nil)))
1207 ;;; Return the name of the function represented by DEBUG-FUN. This may
1208 ;;; be a string or a cons; do not assume it is a symbol.
1209 (defun debug-fun-name (debug-fun)
1210 (declare (type debug-fun debug-fun))
1211 (etypecase debug-fun
1213 (sb!c::compiled-debug-fun-name
1214 (compiled-debug-fun-compiler-debug-fun debug-fun)))
1216 (bogus-debug-fun-%name debug-fun))))
1218 ;;; Return a DEBUG-FUN that represents debug information for FUN.
1219 (defun fun-debug-fun (fun)
1220 (declare (type function fun))
1221 (ecase (widetag-of fun)
1222 (#.sb!vm:closure-header-widetag
1223 (fun-debug-fun (%closure-fun fun)))
1224 (#.sb!vm:funcallable-instance-header-widetag
1225 (fun-debug-fun (funcallable-instance-fun fun)))
1226 (#.sb!vm:simple-fun-header-widetag
1227 (let* ((name (%simple-fun-name fun))
1228 (component (fun-code-header fun))
1231 (and (sb!c::compiled-debug-fun-p x)
1232 (eq (sb!c::compiled-debug-fun-name x) name)
1233 (eq (sb!c::compiled-debug-fun-kind x) nil)))
1234 (sb!c::compiled-debug-info-fun-map
1235 (%code-debug-info component)))))
1237 (make-compiled-debug-fun res component)
1238 ;; KLUDGE: comment from CMU CL:
1239 ;; This used to be the non-interpreted branch, but
1240 ;; William wrote it to return the debug-fun of fun's XEP
1241 ;; instead of fun's debug-fun. The above code does this
1242 ;; more correctly, but it doesn't get or eliminate all
1243 ;; appropriate cases. It mostly works, and probably
1244 ;; works for all named functions anyway.
1246 (debug-fun-from-pc component
1247 (* (- (fun-word-offset fun)
1248 (get-header-data component))
1249 sb!vm:n-word-bytes)))))))
1251 ;;; Return the kind of the function, which is one of :OPTIONAL,
1252 ;;; :EXTERNAL, :TOPLEVEL, :CLEANUP, or NIL.
1253 (defun debug-fun-kind (debug-fun)
1254 ;; FIXME: This "is one of" information should become part of the function
1255 ;; declamation, not just a doc string
1256 (etypecase debug-fun
1258 (sb!c::compiled-debug-fun-kind
1259 (compiled-debug-fun-compiler-debug-fun debug-fun)))
1263 ;;; Is there any variable information for DEBUG-FUN?
1264 (defun debug-var-info-available (debug-fun)
1265 (not (not (debug-fun-debug-vars debug-fun))))
1267 ;;; Return a list of DEBUG-VARs in DEBUG-FUN having the same name
1268 ;;; and package as SYMBOL. If SYMBOL is uninterned, then this returns
1269 ;;; a list of DEBUG-VARs without package names and with the same name
1270 ;;; as symbol. The result of this function is limited to the
1271 ;;; availability of variable information in DEBUG-FUN; for
1272 ;;; example, possibly DEBUG-FUN only knows about its arguments.
1273 (defun debug-fun-symbol-vars (debug-fun symbol)
1274 (let ((vars (ambiguous-debug-vars debug-fun (symbol-name symbol)))
1275 (package (and (symbol-package symbol)
1276 (package-name (symbol-package symbol)))))
1277 (delete-if (if (stringp package)
1279 (let ((p (debug-var-package-name var)))
1280 (or (not (stringp p))
1281 (string/= p package))))
1283 (stringp (debug-var-package-name var))))
1286 ;;; Return a list of DEBUG-VARs in DEBUG-FUN whose names contain
1287 ;;; NAME-PREFIX-STRING as an initial substring. The result of this
1288 ;;; function is limited to the availability of variable information in
1289 ;;; debug-fun; for example, possibly debug-fun only knows
1290 ;;; about its arguments.
1291 (defun ambiguous-debug-vars (debug-fun name-prefix-string)
1292 (declare (simple-string name-prefix-string))
1293 (let ((variables (debug-fun-debug-vars debug-fun)))
1294 (declare (type (or null simple-vector) variables))
1296 (let* ((len (length variables))
1297 (prefix-len (length name-prefix-string))
1298 (pos (find-var name-prefix-string variables len))
1301 ;; Find names from pos to variable's len that contain prefix.
1302 (do ((i pos (1+ i)))
1304 (let* ((var (svref variables i))
1305 (name (debug-var-symbol-name var))
1306 (name-len (length name)))
1307 (declare (simple-string name))
1308 (when (/= (or (string/= name-prefix-string name
1309 :end1 prefix-len :end2 name-len)
1314 (setq res (nreverse res)))
1317 ;;; This returns a position in VARIABLES for one containing NAME as an
1318 ;;; initial substring. END is the length of VARIABLES if supplied.
1319 (defun find-var (name variables &optional end)
1320 (declare (simple-vector variables)
1321 (simple-string name))
1322 (let ((name-len (length name)))
1323 (position name variables
1325 (let* ((y (debug-var-symbol-name y))
1327 (declare (simple-string y))
1328 (and (>= y-len name-len)
1329 (string= x y :end1 name-len :end2 name-len))))
1330 :end (or end (length variables)))))
1332 ;;; Return a list representing the lambda-list for DEBUG-FUN. The
1333 ;;; list has the following structure:
1334 ;;; (required-var1 required-var2
1336 ;;; (:optional var3 suppliedp-var4)
1337 ;;; (:optional var5)
1339 ;;; (:rest var6) (:rest var7)
1341 ;;; (:keyword keyword-symbol var8 suppliedp-var9)
1342 ;;; (:keyword keyword-symbol var10)
1345 ;;; Each VARi is a DEBUG-VAR; however it may be the symbol :DELETED if
1346 ;;; it is unreferenced in DEBUG-FUN. This signals a
1347 ;;; LAMBDA-LIST-UNAVAILABLE condition when there is no argument list
1349 (defun debug-fun-lambda-list (debug-fun)
1350 (etypecase debug-fun
1351 (compiled-debug-fun (compiled-debug-fun-lambda-list debug-fun))
1352 (bogus-debug-fun nil)))
1354 ;;; Note: If this has to compute the lambda list, it caches it in DEBUG-FUN.
1355 (defun compiled-debug-fun-lambda-list (debug-fun)
1356 (let ((lambda-list (debug-fun-%lambda-list debug-fun)))
1357 (cond ((eq lambda-list :unparsed)
1358 (multiple-value-bind (args argsp)
1359 (parse-compiled-debug-fun-lambda-list debug-fun)
1360 (setf (debug-fun-%lambda-list debug-fun) args)
1363 (debug-signal 'lambda-list-unavailable
1364 :debug-fun debug-fun))))
1366 ((bogus-debug-fun-p debug-fun)
1368 ((sb!c::compiled-debug-fun-arguments
1369 (compiled-debug-fun-compiler-debug-fun debug-fun))
1370 ;; If the packed information is there (whether empty or not) as
1371 ;; opposed to being nil, then returned our cached value (nil).
1374 ;; Our cached value is nil, and the packed lambda-list information
1375 ;; is nil, so we don't have anything available.
1376 (debug-signal 'lambda-list-unavailable
1377 :debug-fun debug-fun)))))
1379 ;;; COMPILED-DEBUG-FUN-LAMBDA-LIST calls this when a
1380 ;;; COMPILED-DEBUG-FUN has no lambda list information cached. It
1381 ;;; returns the lambda list as the first value and whether there was
1382 ;;; any argument information as the second value. Therefore,
1383 ;;; (VALUES NIL T) means there were no arguments, but (VALUES NIL NIL)
1384 ;;; means there was no argument information.
1385 (defun parse-compiled-debug-fun-lambda-list (debug-fun)
1386 (let ((args (sb!c::compiled-debug-fun-arguments
1387 (compiled-debug-fun-compiler-debug-fun debug-fun))))
1392 (values (coerce (debug-fun-debug-vars debug-fun) 'list)
1395 (let ((vars (debug-fun-debug-vars debug-fun))
1400 (declare (type (or null simple-vector) vars))
1402 (when (>= i len) (return))
1403 (let ((ele (aref args i)))
1408 ;; Deleted required arg at beginning of args array.
1409 (push :deleted res))
1410 (sb!c::optional-args
1413 ;; SUPPLIED-P var immediately following keyword or
1414 ;; optional. Stick the extra var in the result
1415 ;; element representing the keyword or optional,
1416 ;; which is the previous one.
1418 (list (compiled-debug-fun-lambda-list-var
1419 args (incf i) vars))))
1422 (compiled-debug-fun-lambda-list-var
1423 args (incf i) vars))
1426 ;; Just ignore the fact that the next two args are
1427 ;; the &MORE arg context and count, and act like they
1428 ;; are regular arguments.
1432 (push (list :keyword
1434 (compiled-debug-fun-lambda-list-var
1435 args (incf i) vars))
1438 ;; We saw an optional marker, so the following
1439 ;; non-symbols are indexes indicating optional
1441 (push (list :optional (svref vars ele)) res))
1443 ;; Required arg at beginning of args array.
1444 (push (svref vars ele) res))))
1446 (values (nreverse res) t))))))
1448 ;;; This is used in COMPILED-DEBUG-FUN-LAMBDA-LIST.
1449 (defun compiled-debug-fun-lambda-list-var (args i vars)
1450 (declare (type (simple-array * (*)) args)
1451 (simple-vector vars))
1452 (let ((ele (aref args i)))
1453 (cond ((not (symbolp ele)) (svref vars ele))
1454 ((eq ele 'sb!c::deleted) :deleted)
1455 (t (error "malformed arguments description")))))
1457 (defun compiled-debug-fun-debug-info (debug-fun)
1458 (%code-debug-info (compiled-debug-fun-component debug-fun)))
1460 ;;;; unpacking variable and basic block data
1462 (defvar *parsing-buffer*
1463 (make-array 20 :adjustable t :fill-pointer t))
1464 (defvar *other-parsing-buffer*
1465 (make-array 20 :adjustable t :fill-pointer t))
1466 ;;; PARSE-DEBUG-BLOCKS and PARSE-DEBUG-VARS
1467 ;;; use this to unpack binary encoded information. It returns the
1468 ;;; values returned by the last form in body.
1470 ;;; This binds buffer-var to *parsing-buffer*, makes sure it starts at
1471 ;;; element zero, and makes sure if we unwind, we nil out any set
1472 ;;; elements for GC purposes.
1474 ;;; This also binds other-var to *other-parsing-buffer* when it is
1475 ;;; supplied, making sure it starts at element zero and that we nil
1476 ;;; out any elements if we unwind.
1478 ;;; This defines the local macro RESULT that takes a buffer, copies
1479 ;;; its elements to a resulting simple-vector, nil's out elements, and
1480 ;;; restarts the buffer at element zero. RESULT returns the
1482 (eval-when (:compile-toplevel :execute)
1483 (sb!xc:defmacro with-parsing-buffer ((buffer-var &optional other-var)
1485 (let ((len (gensym))
1488 (let ((,buffer-var *parsing-buffer*)
1489 ,@(if other-var `((,other-var *other-parsing-buffer*))))
1490 (setf (fill-pointer ,buffer-var) 0)
1491 ,@(if other-var `((setf (fill-pointer ,other-var) 0)))
1492 (macrolet ((result (buf)
1493 `(let* ((,',len (length ,buf))
1494 (,',res (make-array ,',len)))
1495 (replace ,',res ,buf :end1 ,',len :end2 ,',len)
1496 (fill ,buf nil :end ,',len)
1497 (setf (fill-pointer ,buf) 0)
1500 (fill *parsing-buffer* nil)
1501 ,@(if other-var `((fill *other-parsing-buffer* nil))))))
1504 ;;; The argument is a debug internals structure. This returns the
1505 ;;; DEBUG-BLOCKs for DEBUG-FUN, regardless of whether we have unpacked
1506 ;;; them yet. It signals a NO-DEBUG-BLOCKS condition if it can't
1507 ;;; return the blocks.
1508 (defun debug-fun-debug-blocks (debug-fun)
1509 (let ((blocks (debug-fun-blocks debug-fun)))
1510 (cond ((eq blocks :unparsed)
1511 (setf (debug-fun-blocks debug-fun)
1512 (parse-debug-blocks debug-fun))
1513 (unless (debug-fun-blocks debug-fun)
1514 (debug-signal 'no-debug-blocks
1515 :debug-fun debug-fun))
1516 (debug-fun-blocks debug-fun))
1519 (debug-signal 'no-debug-blocks
1520 :debug-fun debug-fun)))))
1522 ;;; Return a SIMPLE-VECTOR of DEBUG-BLOCKs or NIL. NIL indicates there
1523 ;;; was no basic block information.
1524 (defun parse-debug-blocks (debug-fun)
1525 (etypecase debug-fun
1527 (parse-compiled-debug-blocks debug-fun))
1529 (debug-signal 'no-debug-blocks :debug-fun debug-fun))))
1531 ;;; This does some of the work of PARSE-DEBUG-BLOCKS.
1532 (defun parse-compiled-debug-blocks (debug-fun)
1533 (let* ((var-count (length (debug-fun-debug-vars debug-fun)))
1534 (compiler-debug-fun (compiled-debug-fun-compiler-debug-fun
1536 (blocks (sb!c::compiled-debug-fun-blocks compiler-debug-fun))
1537 ;; KLUDGE: 8 is a hard-wired constant in the compiler for the
1538 ;; element size of the packed binary representation of the
1540 (live-set-len (ceiling var-count 8))
1541 (tlf-number (sb!c::compiled-debug-fun-tlf-number compiler-debug-fun)))
1543 (return-from parse-compiled-debug-blocks nil))
1544 (macrolet ((aref+ (a i) `(prog1 (aref ,a ,i) (incf ,i))))
1545 (with-parsing-buffer (blocks-buffer locations-buffer)
1547 (len (length blocks))
1550 (when (>= i len) (return))
1551 (let ((succ-and-flags (aref+ blocks i))
1553 (declare (type (unsigned-byte 8) succ-and-flags)
1555 (dotimes (k (ldb sb!c::compiled-debug-block-nsucc-byte
1557 (push (sb!c:read-var-integer blocks i) successors))
1559 (dotimes (k (sb!c:read-var-integer blocks i)
1560 (result locations-buffer))
1561 (let ((kind (svref sb!c::*compiled-code-location-kinds*
1564 (sb!c:read-var-integer blocks i)))
1565 (tlf-offset (or tlf-number
1566 (sb!c:read-var-integer blocks i)))
1567 (form-number (sb!c:read-var-integer blocks i))
1568 (live-set (sb!c:read-packed-bit-vector
1569 live-set-len blocks i)))
1570 (vector-push-extend (make-known-code-location
1571 pc debug-fun tlf-offset
1572 form-number live-set kind)
1574 (setf last-pc pc))))
1575 (block (make-compiled-debug-block
1576 locations successors
1578 sb!c::compiled-debug-block-elsewhere-p
1579 succ-and-flags))))))
1580 (vector-push-extend block blocks-buffer)
1581 (dotimes (k (length locations))
1582 (setf (code-location-%debug-block (svref locations k))
1584 (let ((res (result blocks-buffer)))
1585 (declare (simple-vector res))
1586 (dotimes (i (length res))
1587 (let* ((block (svref res i))
1589 (dolist (ele (debug-block-successors block))
1590 (push (svref res ele) succs))
1591 (setf (debug-block-successors block) succs)))
1594 ;;; The argument is a debug internals structure. This returns NIL if
1595 ;;; there is no variable information. It returns an empty
1596 ;;; simple-vector if there were no locals in the function. Otherwise
1597 ;;; it returns a SIMPLE-VECTOR of DEBUG-VARs.
1598 (defun debug-fun-debug-vars (debug-fun)
1599 (let ((vars (debug-fun-%debug-vars debug-fun)))
1600 (if (eq vars :unparsed)
1601 (setf (debug-fun-%debug-vars debug-fun)
1602 (etypecase debug-fun
1604 (parse-compiled-debug-vars debug-fun))
1605 (bogus-debug-fun nil)))
1608 ;;; VARS is the parsed variables for a minimal debug function. We need
1609 ;;; to assign names of the form ARG-NNN. We must pad with leading
1610 ;;; zeros, since the arguments must be in alphabetical order.
1611 (defun assign-minimal-var-names (vars)
1612 (declare (simple-vector vars))
1613 (let* ((len (length vars))
1614 (width (length (format nil "~W" (1- len)))))
1616 (without-package-locks
1617 (setf (compiled-debug-var-symbol (svref vars i))
1618 (intern (format nil "ARG-~V,'0D" width i)
1619 ;; KLUDGE: It's somewhat nasty to have a bare
1620 ;; package name string here. It would be
1621 ;; nicer to have #.(FIND-PACKAGE "SB!DEBUG")
1622 ;; instead, since then at least it would transform
1623 ;; correctly under package renaming and stuff.
1624 ;; However, genesis can't handle dumped packages..
1627 ;; FIXME: Maybe this could be fixed by moving the
1628 ;; whole debug-int.lisp file to warm init? (after
1629 ;; which dumping a #.(FIND-PACKAGE ..) expression
1630 ;; would work fine) If this is possible, it would
1631 ;; probably be a good thing, since minimizing the
1632 ;; amount of stuff in cold init is basically good.
1633 (or (find-package "SB-DEBUG")
1634 (find-package "SB!DEBUG"))))))))
1636 ;;; Parse the packed representation of DEBUG-VARs from
1637 ;;; DEBUG-FUN's SB!C::COMPILED-DEBUG-FUN, returning a vector
1638 ;;; of DEBUG-VARs, or NIL if there was no information to parse.
1639 (defun parse-compiled-debug-vars (debug-fun)
1640 (let* ((cdebug-fun (compiled-debug-fun-compiler-debug-fun
1642 (packed-vars (sb!c::compiled-debug-fun-vars cdebug-fun))
1643 (args-minimal (eq (sb!c::compiled-debug-fun-arguments cdebug-fun)
1647 (buffer (make-array 0 :fill-pointer 0 :adjustable t)))
1648 ((>= i (length packed-vars))
1649 (let ((result (coerce buffer 'simple-vector)))
1651 (assign-minimal-var-names result))
1653 (flet ((geti () (prog1 (aref packed-vars i) (incf i))))
1654 (let* ((flags (geti))
1655 (minimal (logtest sb!c::compiled-debug-var-minimal-p flags))
1656 (deleted (logtest sb!c::compiled-debug-var-deleted-p flags))
1657 (live (logtest sb!c::compiled-debug-var-environment-live
1659 (save (logtest sb!c::compiled-debug-var-save-loc-p flags))
1660 (symbol (if minimal nil (geti)))
1661 (id (if (logtest sb!c::compiled-debug-var-id-p flags)
1664 (sc-offset (if deleted 0 (geti)))
1665 (save-sc-offset (if save (geti) nil)))
1666 (aver (not (and args-minimal (not minimal))))
1667 (vector-push-extend (make-compiled-debug-var symbol
1676 ;;; If we're sure of whether code-location is known, return T or NIL.
1677 ;;; If we're :UNSURE, then try to fill in the code-location's slots.
1678 ;;; This determines whether there is any debug-block information, and
1679 ;;; if code-location is known.
1681 ;;; ??? IF this conses closures every time it's called, then break off the
1682 ;;; :UNSURE part to get the HANDLER-CASE into another function.
1683 (defun code-location-unknown-p (basic-code-location)
1684 (ecase (code-location-%unknown-p basic-code-location)
1688 (setf (code-location-%unknown-p basic-code-location)
1689 (handler-case (not (fill-in-code-location basic-code-location))
1690 (no-debug-blocks () t))))))
1692 ;;; Return the DEBUG-BLOCK containing code-location if it is available.
1693 ;;; Some debug policies inhibit debug-block information, and if none
1694 ;;; is available, then this signals a NO-DEBUG-BLOCKS condition.
1695 (defun code-location-debug-block (basic-code-location)
1696 (let ((block (code-location-%debug-block basic-code-location)))
1697 (if (eq block :unparsed)
1698 (etypecase basic-code-location
1699 (compiled-code-location
1700 (compute-compiled-code-location-debug-block basic-code-location))
1701 ;; (There used to be more cases back before sbcl-0.7.0, when
1702 ;; we did special tricks to debug the IR1 interpreter.)
1706 ;;; Store and return BASIC-CODE-LOCATION's debug-block. We determines
1707 ;;; the correct one using the code-location's pc. We use
1708 ;;; DEBUG-FUN-DEBUG-BLOCKS to return the cached block information
1709 ;;; or signal a NO-DEBUG-BLOCKS condition. The blocks are sorted by
1710 ;;; their first code-location's pc, in ascending order. Therefore, as
1711 ;;; soon as we find a block that starts with a pc greater than
1712 ;;; basic-code-location's pc, we know the previous block contains the
1713 ;;; pc. If we get to the last block, then the code-location is either
1714 ;;; in the second to last block or the last block, and we have to be
1715 ;;; careful in determining this since the last block could be code at
1716 ;;; the end of the function. We have to check for the last block being
1717 ;;; code first in order to see how to compare the code-location's pc.
1718 (defun compute-compiled-code-location-debug-block (basic-code-location)
1719 (let* ((pc (compiled-code-location-pc basic-code-location))
1720 (debug-fun (code-location-debug-fun
1721 basic-code-location))
1722 (blocks (debug-fun-debug-blocks debug-fun))
1723 (len (length blocks)))
1724 (declare (simple-vector blocks))
1725 (setf (code-location-%debug-block basic-code-location)
1731 (let ((last (svref blocks end)))
1733 ((debug-block-elsewhere-p last)
1735 (sb!c::compiled-debug-fun-elsewhere-pc
1736 (compiled-debug-fun-compiler-debug-fun
1738 (svref blocks (1- end))
1741 (compiled-code-location-pc
1742 (svref (compiled-debug-block-code-locations last)
1744 (svref blocks (1- end)))
1746 (declare (type index i end))
1748 (compiled-code-location-pc
1749 (svref (compiled-debug-block-code-locations
1752 (return (svref blocks (1- i)))))))))
1754 ;;; Return the CODE-LOCATION's DEBUG-SOURCE.
1755 (defun code-location-debug-source (code-location)
1756 (etypecase code-location
1757 (compiled-code-location
1758 (let* ((info (compiled-debug-fun-debug-info
1759 (code-location-debug-fun code-location)))
1760 (sources (sb!c::compiled-debug-info-source info))
1761 (len (length sources)))
1762 (declare (list sources))
1764 (debug-signal 'no-debug-blocks :debug-fun
1765 (code-location-debug-fun code-location)))
1768 (do ((prev sources src)
1769 (src (cdr sources) (cdr src))
1770 (offset (code-location-toplevel-form-offset code-location)))
1771 ((null src) (car prev))
1772 (when (< offset (sb!c::debug-source-source-root (car src)))
1773 (return (car prev)))))))
1774 ;; (There used to be more cases back before sbcl-0.7.0, when we
1775 ;; did special tricks to debug the IR1 interpreter.)
1778 ;;; Returns the number of top level forms before the one containing
1779 ;;; CODE-LOCATION as seen by the compiler in some compilation unit. (A
1780 ;;; compilation unit is not necessarily a single file, see the section
1781 ;;; on debug-sources.)
1782 (defun code-location-toplevel-form-offset (code-location)
1783 (when (code-location-unknown-p code-location)
1784 (error 'unknown-code-location :code-location code-location))
1785 (let ((tlf-offset (code-location-%tlf-offset code-location)))
1786 (cond ((eq tlf-offset :unparsed)
1787 (etypecase code-location
1788 (compiled-code-location
1789 (unless (fill-in-code-location code-location)
1790 ;; This check should be unnecessary. We're missing
1791 ;; debug info the compiler should have dumped.
1792 (bug "unknown code location"))
1793 (code-location-%tlf-offset code-location))
1794 ;; (There used to be more cases back before sbcl-0.7.0,,
1795 ;; when we did special tricks to debug the IR1
1800 ;;; Return the number of the form corresponding to CODE-LOCATION. The
1801 ;;; form number is derived by a walking the subforms of a top level
1802 ;;; form in depth-first order.
1803 (defun code-location-form-number (code-location)
1804 (when (code-location-unknown-p code-location)
1805 (error 'unknown-code-location :code-location code-location))
1806 (let ((form-num (code-location-%form-number code-location)))
1807 (cond ((eq form-num :unparsed)
1808 (etypecase code-location
1809 (compiled-code-location
1810 (unless (fill-in-code-location code-location)
1811 ;; This check should be unnecessary. We're missing
1812 ;; debug info the compiler should have dumped.
1813 (bug "unknown code location"))
1814 (code-location-%form-number code-location))
1815 ;; (There used to be more cases back before sbcl-0.7.0,,
1816 ;; when we did special tricks to debug the IR1
1821 ;;; Return the kind of CODE-LOCATION, one of:
1822 ;;; :INTERPRETED, :UNKNOWN-RETURN, :KNOWN-RETURN, :INTERNAL-ERROR,
1823 ;;; :NON-LOCAL-EXIT, :BLOCK-START, :CALL-SITE, :SINGLE-VALUE-RETURN,
1824 ;;; :NON-LOCAL-ENTRY
1825 (defun code-location-kind (code-location)
1826 (when (code-location-unknown-p code-location)
1827 (error 'unknown-code-location :code-location code-location))
1828 (etypecase code-location
1829 (compiled-code-location
1830 (let ((kind (compiled-code-location-kind code-location)))
1831 (cond ((not (eq kind :unparsed)) kind)
1832 ((not (fill-in-code-location code-location))
1833 ;; This check should be unnecessary. We're missing
1834 ;; debug info the compiler should have dumped.
1835 (bug "unknown code location"))
1837 (compiled-code-location-kind code-location)))))
1838 ;; (There used to be more cases back before sbcl-0.7.0,,
1839 ;; when we did special tricks to debug the IR1
1843 ;;; This returns CODE-LOCATION's live-set if it is available. If
1844 ;;; there is no debug-block information, this returns NIL.
1845 (defun compiled-code-location-live-set (code-location)
1846 (if (code-location-unknown-p code-location)
1848 (let ((live-set (compiled-code-location-%live-set code-location)))
1849 (cond ((eq live-set :unparsed)
1850 (unless (fill-in-code-location code-location)
1851 ;; This check should be unnecessary. We're missing
1852 ;; debug info the compiler should have dumped.
1854 ;; FIXME: This error and comment happen over and over again.
1855 ;; Make them a shared function.
1856 (bug "unknown code location"))
1857 (compiled-code-location-%live-set code-location))
1860 ;;; true if OBJ1 and OBJ2 are the same place in the code
1861 (defun code-location= (obj1 obj2)
1863 (compiled-code-location
1865 (compiled-code-location
1866 (and (eq (code-location-debug-fun obj1)
1867 (code-location-debug-fun obj2))
1868 (sub-compiled-code-location= obj1 obj2)))
1869 ;; (There used to be more cases back before sbcl-0.7.0,,
1870 ;; when we did special tricks to debug the IR1
1873 ;; (There used to be more cases back before sbcl-0.7.0,,
1874 ;; when we did special tricks to debug IR1-interpreted code.)
1876 (defun sub-compiled-code-location= (obj1 obj2)
1877 (= (compiled-code-location-pc obj1)
1878 (compiled-code-location-pc obj2)))
1880 ;;; Fill in CODE-LOCATION's :UNPARSED slots, returning T or NIL
1881 ;;; depending on whether the code-location was known in its
1882 ;;; DEBUG-FUN's debug-block information. This may signal a
1883 ;;; NO-DEBUG-BLOCKS condition due to DEBUG-FUN-DEBUG-BLOCKS, and
1884 ;;; it assumes the %UNKNOWN-P slot is already set or going to be set.
1885 (defun fill-in-code-location (code-location)
1886 (declare (type compiled-code-location code-location))
1887 (let* ((debug-fun (code-location-debug-fun code-location))
1888 (blocks (debug-fun-debug-blocks debug-fun)))
1889 (declare (simple-vector blocks))
1890 (dotimes (i (length blocks) nil)
1891 (let* ((block (svref blocks i))
1892 (locations (compiled-debug-block-code-locations block)))
1893 (declare (simple-vector locations))
1894 (dotimes (j (length locations))
1895 (let ((loc (svref locations j)))
1896 (when (sub-compiled-code-location= code-location loc)
1897 (setf (code-location-%debug-block code-location) block)
1898 (setf (code-location-%tlf-offset code-location)
1899 (code-location-%tlf-offset loc))
1900 (setf (code-location-%form-number code-location)
1901 (code-location-%form-number loc))
1902 (setf (compiled-code-location-%live-set code-location)
1903 (compiled-code-location-%live-set loc))
1904 (setf (compiled-code-location-kind code-location)
1905 (compiled-code-location-kind loc))
1906 (return-from fill-in-code-location t))))))))
1908 ;;;; operations on DEBUG-BLOCKs
1910 ;;; Execute FORMS in a context with CODE-VAR bound to each
1911 ;;; CODE-LOCATION in DEBUG-BLOCK, and return the value of RESULT.
1912 (defmacro do-debug-block-locations ((code-var debug-block &optional result)
1914 (let ((code-locations (gensym))
1916 `(let ((,code-locations (debug-block-code-locations ,debug-block)))
1917 (declare (simple-vector ,code-locations))
1918 (dotimes (,i (length ,code-locations) ,result)
1919 (let ((,code-var (svref ,code-locations ,i)))
1922 ;;; Return the name of the function represented by DEBUG-FUN.
1923 ;;; This may be a string or a cons; do not assume it is a symbol.
1924 (defun debug-block-fun-name (debug-block)
1925 (etypecase debug-block
1926 (compiled-debug-block
1927 (let ((code-locs (compiled-debug-block-code-locations debug-block)))
1928 (declare (simple-vector code-locs))
1929 (if (zerop (length code-locs))
1930 "??? Can't get name of debug-block's function."
1932 (code-location-debug-fun (svref code-locs 0))))))
1933 ;; (There used to be more cases back before sbcl-0.7.0, when we
1934 ;; did special tricks to debug the IR1 interpreter.)
1937 (defun debug-block-code-locations (debug-block)
1938 (etypecase debug-block
1939 (compiled-debug-block
1940 (compiled-debug-block-code-locations debug-block))
1941 ;; (There used to be more cases back before sbcl-0.7.0, when we
1942 ;; did special tricks to debug the IR1 interpreter.)
1945 ;;;; operations on debug variables
1947 (defun debug-var-symbol-name (debug-var)
1948 (symbol-name (debug-var-symbol debug-var)))
1950 ;;; FIXME: Make sure that this isn't called anywhere that it wouldn't
1951 ;;; be acceptable to have NIL returned, or that it's only called on
1952 ;;; DEBUG-VARs whose symbols have non-NIL packages.
1953 (defun debug-var-package-name (debug-var)
1954 (package-name (symbol-package (debug-var-symbol debug-var))))
1956 ;;; Return the value stored for DEBUG-VAR in frame, or if the value is
1957 ;;; not :VALID, then signal an INVALID-VALUE error.
1958 (defun debug-var-valid-value (debug-var frame)
1959 (unless (eq (debug-var-validity debug-var (frame-code-location frame))
1961 (error 'invalid-value :debug-var debug-var :frame frame))
1962 (debug-var-value debug-var frame))
1964 ;;; Returns the value stored for DEBUG-VAR in frame. The value may be
1965 ;;; invalid. This is SETFable.
1966 (defun debug-var-value (debug-var frame)
1967 (aver (typep frame 'compiled-frame))
1968 (let ((res (access-compiled-debug-var-slot debug-var frame)))
1969 (if (indirect-value-cell-p res)
1970 (value-cell-ref res)
1973 ;;; This returns what is stored for the variable represented by
1974 ;;; DEBUG-VAR relative to the FRAME. This may be an indirect value
1975 ;;; cell if the variable is both closed over and set.
1976 (defun access-compiled-debug-var-slot (debug-var frame)
1977 (declare (optimize (speed 1)))
1978 (let ((escaped (compiled-frame-escaped frame)))
1980 (sub-access-debug-var-slot
1981 (frame-pointer frame)
1982 (compiled-debug-var-sc-offset debug-var)
1984 (sub-access-debug-var-slot
1985 (frame-pointer frame)
1986 (or (compiled-debug-var-save-sc-offset debug-var)
1987 (compiled-debug-var-sc-offset debug-var))))))
1989 ;;; a helper function for working with possibly-invalid values:
1990 ;;; Do (MAKE-LISP-OBJ VAL) only if the value looks valid.
1992 ;;; (Such values can arise in registers on machines with conservative
1993 ;;; GC, and might also arise in debug variable locations when
1994 ;;; those variables are invalid.)
1995 (defun make-valid-lisp-obj (val)
1998 (zerop (logand val 3))
2000 (and (zerop (logand val #xffff0000)) ; Top bits zero
2001 (= (logand val #xff) sb!vm:base-char-widetag)) ; char tag
2003 (= val sb!vm:unbound-marker-widetag)
2006 ;; Check that the pointer is valid. XXX Could do a better
2007 ;; job. FIXME: e.g. by calling out to an is_valid_pointer
2008 ;; routine in the C runtime support code
2009 (or (< sb!vm:read-only-space-start val
2010 (* sb!vm:*read-only-space-free-pointer*
2011 sb!vm:n-word-bytes))
2012 (< sb!vm:static-space-start val
2013 (* sb!vm:*static-space-free-pointer*
2014 sb!vm:n-word-bytes))
2015 (< sb!vm:dynamic-space-start val
2016 (sap-int (dynamic-space-free-pointer))))))
2021 (defun sub-access-debug-var-slot (fp sc-offset &optional escaped)
2022 (macrolet ((with-escaped-value ((var) &body forms)
2024 (let ((,var (sb!vm:context-register
2026 (sb!c:sc-offset-offset sc-offset))))
2028 :invalid-value-for-unescaped-register-storage))
2029 (escaped-float-value (format)
2031 (sb!vm:context-float-register
2033 (sb!c:sc-offset-offset sc-offset)
2035 :invalid-value-for-unescaped-register-storage))
2036 (with-nfp ((var) &body body)
2037 `(let ((,var (if escaped
2039 (sb!vm:context-register escaped
2042 (sb!sys:sap-ref-sap fp (* nfp-save-offset
2043 sb!vm:n-word-bytes))
2045 (sb!vm::make-number-stack-pointer
2046 (sb!sys:sap-ref-32 fp (* nfp-save-offset
2047 sb!vm:n-word-bytes))))))
2049 (ecase (sb!c:sc-offset-scn sc-offset)
2050 ((#.sb!vm:any-reg-sc-number
2051 #.sb!vm:descriptor-reg-sc-number
2052 #!+rt #.sb!vm:word-pointer-reg-sc-number)
2053 (sb!sys:without-gcing
2054 (with-escaped-value (val) (sb!kernel:make-lisp-obj val))))
2056 (#.sb!vm:base-char-reg-sc-number
2057 (with-escaped-value (val)
2059 (#.sb!vm:sap-reg-sc-number
2060 (with-escaped-value (val)
2061 (sb!sys:int-sap val)))
2062 (#.sb!vm:signed-reg-sc-number
2063 (with-escaped-value (val)
2064 (if (logbitp (1- sb!vm:n-word-bits) val)
2065 (logior val (ash -1 sb!vm:n-word-bits))
2067 (#.sb!vm:unsigned-reg-sc-number
2068 (with-escaped-value (val)
2070 (#.sb!vm:non-descriptor-reg-sc-number
2071 (error "Local non-descriptor register access?"))
2072 (#.sb!vm:interior-reg-sc-number
2073 (error "Local interior register access?"))
2074 (#.sb!vm:single-reg-sc-number
2075 (escaped-float-value single-float))
2076 (#.sb!vm:double-reg-sc-number
2077 (escaped-float-value double-float))
2079 (#.sb!vm:long-reg-sc-number
2080 (escaped-float-value long-float))
2081 (#.sb!vm:complex-single-reg-sc-number
2084 (sb!vm:context-float-register
2085 escaped (sb!c:sc-offset-offset sc-offset) 'single-float)
2086 (sb!vm:context-float-register
2087 escaped (1+ (sb!c:sc-offset-offset sc-offset)) 'single-float))
2088 :invalid-value-for-unescaped-register-storage))
2089 (#.sb!vm:complex-double-reg-sc-number
2092 (sb!vm:context-float-register
2093 escaped (sb!c:sc-offset-offset sc-offset) 'double-float)
2094 (sb!vm:context-float-register
2095 escaped (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 2 #!-sparc 1)
2097 :invalid-value-for-unescaped-register-storage))
2099 (#.sb!vm:complex-long-reg-sc-number
2102 (sb!vm:context-float-register
2103 escaped (sb!c:sc-offset-offset sc-offset) 'long-float)
2104 (sb!vm:context-float-register
2105 escaped (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 4)
2107 :invalid-value-for-unescaped-register-storage))
2108 (#.sb!vm:single-stack-sc-number
2110 (sb!sys:sap-ref-single nfp (* (sb!c:sc-offset-offset sc-offset)
2111 sb!vm:n-word-bytes))))
2112 (#.sb!vm:double-stack-sc-number
2114 (sb!sys:sap-ref-double nfp (* (sb!c:sc-offset-offset sc-offset)
2115 sb!vm:n-word-bytes))))
2117 (#.sb!vm:long-stack-sc-number
2119 (sb!sys:sap-ref-long nfp (* (sb!c:sc-offset-offset sc-offset)
2120 sb!vm:n-word-bytes))))
2121 (#.sb!vm:complex-single-stack-sc-number
2124 (sb!sys:sap-ref-single nfp (* (sb!c:sc-offset-offset sc-offset)
2125 sb!vm:n-word-bytes))
2126 (sb!sys:sap-ref-single nfp (* (1+ (sb!c:sc-offset-offset sc-offset))
2127 sb!vm:n-word-bytes)))))
2128 (#.sb!vm:complex-double-stack-sc-number
2131 (sb!sys:sap-ref-double nfp (* (sb!c:sc-offset-offset sc-offset)
2132 sb!vm:n-word-bytes))
2133 (sb!sys:sap-ref-double nfp (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2134 sb!vm:n-word-bytes)))))
2136 (#.sb!vm:complex-long-stack-sc-number
2139 (sb!sys:sap-ref-long nfp (* (sb!c:sc-offset-offset sc-offset)
2140 sb!vm:n-word-bytes))
2141 (sb!sys:sap-ref-long nfp (* (+ (sb!c:sc-offset-offset sc-offset)
2143 sb!vm:n-word-bytes)))))
2144 (#.sb!vm:control-stack-sc-number
2145 (sb!kernel:stack-ref fp (sb!c:sc-offset-offset sc-offset)))
2146 (#.sb!vm:base-char-stack-sc-number
2148 (code-char (sb!sys:sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2149 sb!vm:n-word-bytes)))))
2150 (#.sb!vm:unsigned-stack-sc-number
2152 (sb!sys:sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2153 sb!vm:n-word-bytes))))
2154 (#.sb!vm:signed-stack-sc-number
2156 (sb!sys:signed-sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2157 sb!vm:n-word-bytes))))
2158 (#.sb!vm:sap-stack-sc-number
2160 (sb!sys:sap-ref-sap nfp (* (sb!c:sc-offset-offset sc-offset)
2161 sb!vm:n-word-bytes)))))))
2164 (defun sub-access-debug-var-slot (fp sc-offset &optional escaped)
2165 (declare (type system-area-pointer fp))
2166 (macrolet ((with-escaped-value ((var) &body forms)
2168 (let ((,var (sb!vm:context-register
2170 (sb!c:sc-offset-offset sc-offset))))
2172 :invalid-value-for-unescaped-register-storage))
2173 (escaped-float-value (format)
2175 (sb!vm:context-float-register
2176 escaped (sb!c:sc-offset-offset sc-offset) ',format)
2177 :invalid-value-for-unescaped-register-storage))
2178 (escaped-complex-float-value (format)
2181 (sb!vm:context-float-register
2182 escaped (sb!c:sc-offset-offset sc-offset) ',format)
2183 (sb!vm:context-float-register
2184 escaped (1+ (sb!c:sc-offset-offset sc-offset)) ',format))
2185 :invalid-value-for-unescaped-register-storage)))
2186 (ecase (sb!c:sc-offset-scn sc-offset)
2187 ((#.sb!vm:any-reg-sc-number #.sb!vm:descriptor-reg-sc-number)
2189 (with-escaped-value (val)
2190 (make-valid-lisp-obj val))))
2191 (#.sb!vm:base-char-reg-sc-number
2192 (with-escaped-value (val)
2194 (#.sb!vm:sap-reg-sc-number
2195 (with-escaped-value (val)
2197 (#.sb!vm:signed-reg-sc-number
2198 (with-escaped-value (val)
2199 (if (logbitp (1- sb!vm:n-word-bits) val)
2200 (logior val (ash -1 sb!vm:n-word-bits))
2202 (#.sb!vm:unsigned-reg-sc-number
2203 (with-escaped-value (val)
2205 (#.sb!vm:single-reg-sc-number
2206 (escaped-float-value single-float))
2207 (#.sb!vm:double-reg-sc-number
2208 (escaped-float-value double-float))
2210 (#.sb!vm:long-reg-sc-number
2211 (escaped-float-value long-float))
2212 (#.sb!vm:complex-single-reg-sc-number
2213 (escaped-complex-float-value single-float))
2214 (#.sb!vm:complex-double-reg-sc-number
2215 (escaped-complex-float-value double-float))
2217 (#.sb!vm:complex-long-reg-sc-number
2218 (escaped-complex-float-value long-float))
2219 (#.sb!vm:single-stack-sc-number
2220 (sap-ref-single fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2221 sb!vm:n-word-bytes))))
2222 (#.sb!vm:double-stack-sc-number
2223 (sap-ref-double fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2224 sb!vm:n-word-bytes))))
2226 (#.sb!vm:long-stack-sc-number
2227 (sap-ref-long fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2228 sb!vm:n-word-bytes))))
2229 (#.sb!vm:complex-single-stack-sc-number
2231 (sap-ref-single fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2232 sb!vm:n-word-bytes)))
2233 (sap-ref-single fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2234 sb!vm:n-word-bytes)))))
2235 (#.sb!vm:complex-double-stack-sc-number
2237 (sap-ref-double fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2238 sb!vm:n-word-bytes)))
2239 (sap-ref-double fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 4)
2240 sb!vm:n-word-bytes)))))
2242 (#.sb!vm:complex-long-stack-sc-number
2244 (sap-ref-long fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2245 sb!vm:n-word-bytes)))
2246 (sap-ref-long fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 6)
2247 sb!vm:n-word-bytes)))))
2248 (#.sb!vm:control-stack-sc-number
2249 (stack-ref fp (sb!c:sc-offset-offset sc-offset)))
2250 (#.sb!vm:base-char-stack-sc-number
2252 (sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2253 sb!vm:n-word-bytes)))))
2254 (#.sb!vm:unsigned-stack-sc-number
2255 (sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2256 sb!vm:n-word-bytes))))
2257 (#.sb!vm:signed-stack-sc-number
2258 (signed-sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2259 sb!vm:n-word-bytes))))
2260 (#.sb!vm:sap-stack-sc-number
2261 (sap-ref-sap fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2262 sb!vm:n-word-bytes)))))))
2264 ;;; This stores value as the value of DEBUG-VAR in FRAME. In the
2265 ;;; COMPILED-DEBUG-VAR case, access the current value to determine if
2266 ;;; it is an indirect value cell. This occurs when the variable is
2267 ;;; both closed over and set.
2268 (defun %set-debug-var-value (debug-var frame new-value)
2269 (aver (typep frame 'compiled-frame))
2270 (let ((old-value (access-compiled-debug-var-slot debug-var frame)))
2271 (if (indirect-value-cell-p old-value)
2272 (value-cell-set old-value new-value)
2273 (set-compiled-debug-var-slot debug-var frame new-value)))
2276 ;;; This stores VALUE for the variable represented by debug-var
2277 ;;; relative to the frame. This assumes the location directly contains
2278 ;;; the variable's value; that is, there is no indirect value cell
2279 ;;; currently there in case the variable is both closed over and set.
2280 (defun set-compiled-debug-var-slot (debug-var frame value)
2281 (let ((escaped (compiled-frame-escaped frame)))
2283 (sub-set-debug-var-slot (frame-pointer frame)
2284 (compiled-debug-var-sc-offset debug-var)
2286 (sub-set-debug-var-slot
2287 (frame-pointer frame)
2288 (or (compiled-debug-var-save-sc-offset debug-var)
2289 (compiled-debug-var-sc-offset debug-var))
2293 (defun sub-set-debug-var-slot (fp sc-offset value &optional escaped)
2294 (macrolet ((set-escaped-value (val)
2296 (setf (sb!vm:context-register
2298 (sb!c:sc-offset-offset sc-offset))
2301 (set-escaped-float-value (format val)
2303 (setf (sb!vm:context-float-register
2305 (sb!c:sc-offset-offset sc-offset)
2309 (with-nfp ((var) &body body)
2310 `(let ((,var (if escaped
2312 (sb!vm:context-register escaped
2317 sb!vm:n-word-bytes))
2319 (sb!vm::make-number-stack-pointer
2322 sb!vm:n-word-bytes))))))
2324 (ecase (sb!c:sc-offset-scn sc-offset)
2325 ((#.sb!vm:any-reg-sc-number
2326 #.sb!vm:descriptor-reg-sc-number
2327 #!+rt #.sb!vm:word-pointer-reg-sc-number)
2330 (get-lisp-obj-address value))))
2331 (#.sb!vm:base-char-reg-sc-number
2332 (set-escaped-value (char-code value)))
2333 (#.sb!vm:sap-reg-sc-number
2334 (set-escaped-value (sap-int value)))
2335 (#.sb!vm:signed-reg-sc-number
2336 (set-escaped-value (logand value (1- (ash 1 sb!vm:n-word-bits)))))
2337 (#.sb!vm:unsigned-reg-sc-number
2338 (set-escaped-value value))
2339 (#.sb!vm:non-descriptor-reg-sc-number
2340 (error "Local non-descriptor register access?"))
2341 (#.sb!vm:interior-reg-sc-number
2342 (error "Local interior register access?"))
2343 (#.sb!vm:single-reg-sc-number
2344 (set-escaped-float-value single-float value))
2345 (#.sb!vm:double-reg-sc-number
2346 (set-escaped-float-value double-float value))
2348 (#.sb!vm:long-reg-sc-number
2349 (set-escaped-float-value long-float value))
2350 (#.sb!vm:complex-single-reg-sc-number
2352 (setf (sb!vm:context-float-register escaped
2353 (sb!c:sc-offset-offset sc-offset)
2356 (setf (sb!vm:context-float-register
2357 escaped (1+ (sb!c:sc-offset-offset sc-offset))
2361 (#.sb!vm:complex-double-reg-sc-number
2363 (setf (sb!vm:context-float-register
2364 escaped (sb!c:sc-offset-offset sc-offset) 'double-float)
2366 (setf (sb!vm:context-float-register
2368 (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 2 #!-sparc 1)
2373 (#.sb!vm:complex-long-reg-sc-number
2375 (setf (sb!vm:context-float-register
2376 escaped (sb!c:sc-offset-offset sc-offset) 'long-float)
2378 (setf (sb!vm:context-float-register
2380 (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 4)
2384 (#.sb!vm:single-stack-sc-number
2386 (setf (sap-ref-single nfp (* (sb!c:sc-offset-offset sc-offset)
2387 sb!vm:n-word-bytes))
2388 (the single-float value))))
2389 (#.sb!vm:double-stack-sc-number
2391 (setf (sap-ref-double nfp (* (sb!c:sc-offset-offset sc-offset)
2392 sb!vm:n-word-bytes))
2393 (the double-float value))))
2395 (#.sb!vm:long-stack-sc-number
2397 (setf (sap-ref-long nfp (* (sb!c:sc-offset-offset sc-offset)
2398 sb!vm:n-word-bytes))
2399 (the long-float value))))
2400 (#.sb!vm:complex-single-stack-sc-number
2402 (setf (sap-ref-single
2403 nfp (* (sb!c:sc-offset-offset sc-offset) sb!vm:n-word-bytes))
2404 (the single-float (realpart value)))
2405 (setf (sap-ref-single
2406 nfp (* (1+ (sb!c:sc-offset-offset sc-offset))
2407 sb!vm:n-word-bytes))
2408 (the single-float (realpart value)))))
2409 (#.sb!vm:complex-double-stack-sc-number
2411 (setf (sap-ref-double
2412 nfp (* (sb!c:sc-offset-offset sc-offset) sb!vm:n-word-bytes))
2413 (the double-float (realpart value)))
2414 (setf (sap-ref-double
2415 nfp (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2416 sb!vm:n-word-bytes))
2417 (the double-float (realpart value)))))
2419 (#.sb!vm:complex-long-stack-sc-number
2422 nfp (* (sb!c:sc-offset-offset sc-offset) sb!vm:n-word-bytes))
2423 (the long-float (realpart value)))
2425 nfp (* (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 4)
2426 sb!vm:n-word-bytes))
2427 (the long-float (realpart value)))))
2428 (#.sb!vm:control-stack-sc-number
2429 (setf (stack-ref fp (sb!c:sc-offset-offset sc-offset)) value))
2430 (#.sb!vm:base-char-stack-sc-number
2432 (setf (sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2433 sb!vm:n-word-bytes))
2434 (char-code (the character value)))))
2435 (#.sb!vm:unsigned-stack-sc-number
2437 (setf (sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2438 sb!vm:n-word-bytes))
2439 (the (unsigned-byte 32) value))))
2440 (#.sb!vm:signed-stack-sc-number
2442 (setf (signed-sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2443 sb!vm:n-word-bytes))
2444 (the (signed-byte 32) value))))
2445 (#.sb!vm:sap-stack-sc-number
2447 (setf (sap-ref-sap nfp (* (sb!c:sc-offset-offset sc-offset)
2448 sb!vm:n-word-bytes))
2449 (the system-area-pointer value)))))))
2452 (defun sub-set-debug-var-slot (fp sc-offset value &optional escaped)
2453 (macrolet ((set-escaped-value (val)
2455 (setf (sb!vm:context-register
2457 (sb!c:sc-offset-offset sc-offset))
2460 (ecase (sb!c:sc-offset-scn sc-offset)
2461 ((#.sb!vm:any-reg-sc-number #.sb!vm:descriptor-reg-sc-number)
2464 (get-lisp-obj-address value))))
2465 (#.sb!vm:base-char-reg-sc-number
2466 (set-escaped-value (char-code value)))
2467 (#.sb!vm:sap-reg-sc-number
2468 (set-escaped-value (sap-int value)))
2469 (#.sb!vm:signed-reg-sc-number
2470 (set-escaped-value (logand value (1- (ash 1 sb!vm:n-word-bits)))))
2471 (#.sb!vm:unsigned-reg-sc-number
2472 (set-escaped-value value))
2473 (#.sb!vm:single-reg-sc-number
2474 #+nil ;; don't have escaped floats.
2475 (set-escaped-float-value single-float value))
2476 (#.sb!vm:double-reg-sc-number
2477 #+nil ;; don't have escaped floats -- still in npx?
2478 (set-escaped-float-value double-float value))
2480 (#.sb!vm:long-reg-sc-number
2481 #+nil ;; don't have escaped floats -- still in npx?
2482 (set-escaped-float-value long-float value))
2483 (#.sb!vm:single-stack-sc-number
2484 (setf (sap-ref-single
2485 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2486 sb!vm:n-word-bytes)))
2487 (the single-float value)))
2488 (#.sb!vm:double-stack-sc-number
2489 (setf (sap-ref-double
2490 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2491 sb!vm:n-word-bytes)))
2492 (the double-float value)))
2494 (#.sb!vm:long-stack-sc-number
2496 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2497 sb!vm:n-word-bytes)))
2498 (the long-float value)))
2499 (#.sb!vm:complex-single-stack-sc-number
2500 (setf (sap-ref-single
2501 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2502 sb!vm:n-word-bytes)))
2503 (realpart (the (complex single-float) value)))
2504 (setf (sap-ref-single
2505 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2506 sb!vm:n-word-bytes)))
2507 (imagpart (the (complex single-float) value))))
2508 (#.sb!vm:complex-double-stack-sc-number
2509 (setf (sap-ref-double
2510 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2511 sb!vm:n-word-bytes)))
2512 (realpart (the (complex double-float) value)))
2513 (setf (sap-ref-double
2514 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 4)
2515 sb!vm:n-word-bytes)))
2516 (imagpart (the (complex double-float) value))))
2518 (#.sb!vm:complex-long-stack-sc-number
2520 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2521 sb!vm:n-word-bytes)))
2522 (realpart (the (complex long-float) value)))
2524 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 6)
2525 sb!vm:n-word-bytes)))
2526 (imagpart (the (complex long-float) value))))
2527 (#.sb!vm:control-stack-sc-number
2528 (setf (stack-ref fp (sb!c:sc-offset-offset sc-offset)) value))
2529 (#.sb!vm:base-char-stack-sc-number
2530 (setf (sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2531 sb!vm:n-word-bytes)))
2532 (char-code (the character value))))
2533 (#.sb!vm:unsigned-stack-sc-number
2534 (setf (sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2535 sb!vm:n-word-bytes)))
2536 (the (unsigned-byte 32) value)))
2537 (#.sb!vm:signed-stack-sc-number
2538 (setf (signed-sap-ref-32
2539 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2540 sb!vm:n-word-bytes)))
2541 (the (signed-byte 32) value)))
2542 (#.sb!vm:sap-stack-sc-number
2543 (setf (sap-ref-sap fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2544 sb!vm:n-word-bytes)))
2545 (the system-area-pointer value))))))
2547 ;;; The method for setting and accessing COMPILED-DEBUG-VAR values use
2548 ;;; this to determine if the value stored is the actual value or an
2549 ;;; indirection cell.
2550 (defun indirect-value-cell-p (x)
2551 (and (= (lowtag-of x) sb!vm:other-pointer-lowtag)
2552 (= (widetag-of x) sb!vm:value-cell-header-widetag)))
2554 ;;; Return three values reflecting the validity of DEBUG-VAR's value
2555 ;;; at BASIC-CODE-LOCATION:
2556 ;;; :VALID The value is known to be available.
2557 ;;; :INVALID The value is known to be unavailable.
2558 ;;; :UNKNOWN The value's availability is unknown.
2560 ;;; If the variable is always alive, then it is valid. If the
2561 ;;; code-location is unknown, then the variable's validity is
2562 ;;; :unknown. Once we've called CODE-LOCATION-UNKNOWN-P, we know the
2563 ;;; live-set information has been cached in the code-location.
2564 (defun debug-var-validity (debug-var basic-code-location)
2565 (etypecase debug-var
2567 (compiled-debug-var-validity debug-var basic-code-location))
2568 ;; (There used to be more cases back before sbcl-0.7.0, when
2569 ;; we did special tricks to debug the IR1 interpreter.)
2572 ;;; This is the method for DEBUG-VAR-VALIDITY for COMPILED-DEBUG-VARs.
2573 ;;; For safety, make sure basic-code-location is what we think.
2574 (defun compiled-debug-var-validity (debug-var basic-code-location)
2575 (declare (type compiled-code-location basic-code-location))
2576 (cond ((debug-var-alive-p debug-var)
2577 (let ((debug-fun (code-location-debug-fun basic-code-location)))
2578 (if (>= (compiled-code-location-pc basic-code-location)
2579 (sb!c::compiled-debug-fun-start-pc
2580 (compiled-debug-fun-compiler-debug-fun debug-fun)))
2583 ((code-location-unknown-p basic-code-location) :unknown)
2585 (let ((pos (position debug-var
2586 (debug-fun-debug-vars
2587 (code-location-debug-fun
2588 basic-code-location)))))
2590 (error 'unknown-debug-var
2591 :debug-var debug-var
2593 (code-location-debug-fun basic-code-location)))
2594 ;; There must be live-set info since basic-code-location is known.
2595 (if (zerop (sbit (compiled-code-location-live-set
2596 basic-code-location)
2603 ;;; This code produces and uses what we call source-paths. A
2604 ;;; source-path is a list whose first element is a form number as
2605 ;;; returned by CODE-LOCATION-FORM-NUMBER and whose last element is a
2606 ;;; top level form number as returned by
2607 ;;; CODE-LOCATION-TOPLEVEL-FORM-NUMBER. The elements from the last to
2608 ;;; the first, exclusively, are the numbered subforms into which to
2609 ;;; descend. For example:
2611 ;;; (let ((a (aref x 3)))
2613 ;;; The call to AREF in this example is form number 5. Assuming this
2614 ;;; DEFUN is the 11'th top level form, the source-path for the AREF
2615 ;;; call is as follows:
2617 ;;; Given the DEFUN, 3 gets you the LET, 1 gets you the bindings, 0
2618 ;;; gets the first binding, and 1 gets the AREF form.
2620 ;;; temporary buffer used to build form-number => source-path translation in
2621 ;;; FORM-NUMBER-TRANSLATIONS
2622 (defvar *form-number-temp* (make-array 10 :fill-pointer 0 :adjustable t))
2624 ;;; table used to detect CAR circularities in FORM-NUMBER-TRANSLATIONS
2625 (defvar *form-number-circularity-table* (make-hash-table :test 'eq))
2627 ;;; This returns a table mapping form numbers to source-paths. A
2628 ;;; source-path indicates a descent into the TOPLEVEL-FORM form,
2629 ;;; going directly to the subform corressponding to the form number.
2631 ;;; The vector elements are in the same format as the compiler's
2632 ;;; NODE-SOURCE-PATH; that is, the first element is the form number and
2633 ;;; the last is the TOPLEVEL-FORM number.
2634 (defun form-number-translations (form tlf-number)
2635 (clrhash *form-number-circularity-table*)
2636 (setf (fill-pointer *form-number-temp*) 0)
2637 (sub-translate-form-numbers form (list tlf-number))
2638 (coerce *form-number-temp* 'simple-vector))
2639 (defun sub-translate-form-numbers (form path)
2640 (unless (gethash form *form-number-circularity-table*)
2641 (setf (gethash form *form-number-circularity-table*) t)
2642 (vector-push-extend (cons (fill-pointer *form-number-temp*) path)
2647 (declare (fixnum pos))
2650 (when (atom subform) (return))
2651 (let ((fm (car subform)))
2653 (sub-translate-form-numbers fm (cons pos path)))
2655 (setq subform (cdr subform))
2656 (when (eq subform trail) (return)))))
2660 (setq trail (cdr trail)))))))
2662 ;;; FORM is a top level form, and path is a source-path into it. This
2663 ;;; returns the form indicated by the source-path. Context is the
2664 ;;; number of enclosing forms to return instead of directly returning
2665 ;;; the source-path form. When context is non-zero, the form returned
2666 ;;; contains a marker, #:****HERE****, immediately before the form
2667 ;;; indicated by path.
2668 (defun source-path-context (form path context)
2669 (declare (type unsigned-byte context))
2670 ;; Get to the form indicated by path or the enclosing form indicated
2671 ;; by context and path.
2672 (let ((path (reverse (butlast (cdr path)))))
2673 (dotimes (i (- (length path) context))
2674 (let ((index (first path)))
2675 (unless (and (listp form) (< index (length form)))
2676 (error "Source path no longer exists."))
2677 (setq form (elt form index))
2678 (setq path (rest path))))
2679 ;; Recursively rebuild the source form resulting from the above
2680 ;; descent, copying the beginning of each subform up to the next
2681 ;; subform we descend into according to path. At the bottom of the
2682 ;; recursion, we return the form indicated by path preceded by our
2683 ;; marker, and this gets spliced into the resulting list structure
2684 ;; on the way back up.
2685 (labels ((frob (form path level)
2686 (if (or (zerop level) (null path))
2689 `(#:***here*** ,form))
2690 (let ((n (first path)))
2691 (unless (and (listp form) (< n (length form)))
2692 (error "Source path no longer exists."))
2693 (let ((res (frob (elt form n) (rest path) (1- level))))
2694 (nconc (subseq form 0 n)
2695 (cons res (nthcdr (1+ n) form))))))))
2696 (frob form path context))))
2698 ;;;; PREPROCESS-FOR-EVAL
2700 ;;; Return a function of one argument that evaluates form in the
2701 ;;; lexical context of the BASIC-CODE-LOCATION LOC, or signal a
2702 ;;; NO-DEBUG-VARS condition when the LOC's DEBUG-FUN has no
2703 ;;; DEBUG-VAR information available.
2705 ;;; The returned function takes the frame to get values from as its
2706 ;;; argument, and it returns the values of FORM. The returned function
2707 ;;; can signal the following conditions: INVALID-VALUE,
2708 ;;; AMBIGUOUS-VAR-NAME, and FRAME-FUN-MISMATCH.
2709 (defun preprocess-for-eval (form loc)
2710 (declare (type code-location loc))
2711 (let ((n-frame (gensym))
2712 (fun (code-location-debug-fun loc)))
2713 (unless (debug-var-info-available fun)
2714 (debug-signal 'no-debug-vars :debug-fun fun))
2715 (sb!int:collect ((binds)
2717 (do-debug-fun-vars (var fun)
2718 (let ((validity (debug-var-validity var loc)))
2719 (unless (eq validity :invalid)
2720 (let* ((sym (debug-var-symbol var))
2721 (found (assoc sym (binds))))
2723 (setf (second found) :ambiguous)
2724 (binds (list sym validity var)))))))
2725 (dolist (bind (binds))
2726 (let ((name (first bind))
2728 (ecase (second bind)
2730 (specs `(,name (debug-var-value ',var ,n-frame))))
2732 (specs `(,name (debug-signal 'invalid-value
2736 (specs `(,name (debug-signal 'ambiguous-var-name
2738 :frame ,n-frame)))))))
2739 (let ((res (coerce `(lambda (,n-frame)
2740 (declare (ignorable ,n-frame))
2741 (symbol-macrolet ,(specs) ,form))
2744 ;; This prevents these functions from being used in any
2745 ;; location other than a function return location, so maybe
2746 ;; this should only check whether FRAME's DEBUG-FUN is the
2748 (unless (code-location= (frame-code-location frame) loc)
2749 (debug-signal 'frame-fun-mismatch
2750 :code-location loc :form form :frame frame))
2751 (funcall res frame))))))
2755 ;;;; user-visible interface
2757 ;;; Create and return a breakpoint. When program execution encounters
2758 ;;; the breakpoint, the system calls HOOK-FUN. HOOK-FUN takes the
2759 ;;; current frame for the function in which the program is running and
2760 ;;; the breakpoint object.
2762 ;;; WHAT and KIND determine where in a function the system invokes
2763 ;;; HOOK-FUN. WHAT is either a code-location or a DEBUG-FUN. KIND is
2764 ;;; one of :CODE-LOCATION, :FUN-START, or :FUN-END. Since the starts
2765 ;;; and ends of functions may not have code-locations representing
2766 ;;; them, designate these places by supplying WHAT as a DEBUG-FUN and
2767 ;;; KIND indicating the :FUN-START or :FUN-END. When WHAT is a
2768 ;;; DEBUG-FUN and kind is :FUN-END, then HOOK-FUN must take two
2769 ;;; additional arguments, a list of values returned by the function
2770 ;;; and a FUN-END-COOKIE.
2772 ;;; INFO is information supplied by and used by the user.
2774 ;;; FUN-END-COOKIE is a function. To implement :FUN-END
2775 ;;; breakpoints, the system uses starter breakpoints to establish the
2776 ;;; :FUN-END breakpoint for each invocation of the function. Upon
2777 ;;; each entry, the system creates a unique cookie to identify the
2778 ;;; invocation, and when the user supplies a function for this
2779 ;;; argument, the system invokes it on the frame and the cookie. The
2780 ;;; system later invokes the :FUN-END breakpoint hook on the same
2781 ;;; cookie. The user may save the cookie for comparison in the hook
2784 ;;; Signal an error if WHAT is an unknown code-location.
2785 (defun make-breakpoint (hook-fun what
2786 &key (kind :code-location) info fun-end-cookie)
2789 (when (code-location-unknown-p what)
2790 (error "cannot make a breakpoint at an unknown code location: ~S"
2792 (aver (eq kind :code-location))
2793 (let ((bpt (%make-breakpoint hook-fun what kind info)))
2795 (compiled-code-location
2796 ;; This slot is filled in due to calling CODE-LOCATION-UNKNOWN-P.
2797 (when (eq (compiled-code-location-kind what) :unknown-return)
2798 (let ((other-bpt (%make-breakpoint hook-fun what
2799 :unknown-return-partner
2801 (setf (breakpoint-unknown-return-partner bpt) other-bpt)
2802 (setf (breakpoint-unknown-return-partner other-bpt) bpt))))
2803 ;; (There used to be more cases back before sbcl-0.7.0,,
2804 ;; when we did special tricks to debug the IR1
2811 (%make-breakpoint hook-fun what kind info))
2813 (unless (eq (sb!c::compiled-debug-fun-returns
2814 (compiled-debug-fun-compiler-debug-fun what))
2816 (error ":FUN-END breakpoints are currently unsupported ~
2817 for the known return convention."))
2819 (let* ((bpt (%make-breakpoint hook-fun what kind info))
2820 (starter (compiled-debug-fun-end-starter what)))
2822 (setf starter (%make-breakpoint #'list what :fun-start nil))
2823 (setf (breakpoint-hook-fun starter)
2824 (fun-end-starter-hook starter what))
2825 (setf (compiled-debug-fun-end-starter what) starter))
2826 (setf (breakpoint-start-helper bpt) starter)
2827 (push bpt (breakpoint-%info starter))
2828 (setf (breakpoint-cookie-fun bpt) fun-end-cookie)
2831 ;;; These are unique objects created upon entry into a function by a
2832 ;;; :FUN-END breakpoint's starter hook. These are only created
2833 ;;; when users supply :FUN-END-COOKIE to MAKE-BREAKPOINT. Also,
2834 ;;; the :FUN-END breakpoint's hook is called on the same cookie
2835 ;;; when it is created.
2836 (defstruct (fun-end-cookie
2837 (:print-object (lambda (obj str)
2838 (print-unreadable-object (obj str :type t))))
2839 (:constructor make-fun-end-cookie (bogus-lra debug-fun))
2841 ;; a pointer to the bogus-lra created for :FUN-END breakpoints
2843 ;; the DEBUG-FUN associated with this cookie
2846 ;;; This maps bogus-lra-components to cookies, so that
2847 ;;; HANDLE-FUN-END-BREAKPOINT can find the appropriate cookie for the
2848 ;;; breakpoint hook.
2849 (defvar *fun-end-cookies* (make-hash-table :test 'eq))
2851 ;;; This returns a hook function for the start helper breakpoint
2852 ;;; associated with a :FUN-END breakpoint. The returned function
2853 ;;; makes a fake LRA that all returns go through, and this piece of
2854 ;;; fake code actually breaks. Upon return from the break, the code
2855 ;;; provides the returnee with any values. Since the returned function
2856 ;;; effectively activates FUN-END-BPT on each entry to DEBUG-FUN's
2857 ;;; function, we must establish breakpoint-data about FUN-END-BPT.
2858 (defun fun-end-starter-hook (starter-bpt debug-fun)
2859 (declare (type breakpoint starter-bpt)
2860 (type compiled-debug-fun debug-fun))
2861 (lambda (frame breakpoint)
2862 (declare (ignore breakpoint)
2864 (let ((lra-sc-offset
2865 (sb!c::compiled-debug-fun-return-pc
2866 (compiled-debug-fun-compiler-debug-fun debug-fun))))
2867 (multiple-value-bind (lra component offset)
2869 (get-context-value frame
2872 (setf (get-context-value frame
2876 (let ((end-bpts (breakpoint-%info starter-bpt)))
2877 (let ((data (breakpoint-data component offset)))
2878 (setf (breakpoint-data-breakpoints data) end-bpts)
2879 (dolist (bpt end-bpts)
2880 (setf (breakpoint-internal-data bpt) data)))
2881 (let ((cookie (make-fun-end-cookie lra debug-fun)))
2882 (setf (gethash component *fun-end-cookies*) cookie)
2883 (dolist (bpt end-bpts)
2884 (let ((fun (breakpoint-cookie-fun bpt)))
2885 (when fun (funcall fun frame cookie))))))))))
2887 ;;; This takes a FUN-END-COOKIE and a frame, and it returns
2888 ;;; whether the cookie is still valid. A cookie becomes invalid when
2889 ;;; the frame that established the cookie has exited. Sometimes cookie
2890 ;;; holders are unaware of cookie invalidation because their
2891 ;;; :FUN-END breakpoint hooks didn't run due to THROW'ing.
2893 ;;; This takes a frame as an efficiency hack since the user probably
2894 ;;; has a frame object in hand when using this routine, and it saves
2895 ;;; repeated parsing of the stack and consing when asking whether a
2896 ;;; series of cookies is valid.
2897 (defun fun-end-cookie-valid-p (frame cookie)
2898 (let ((lra (fun-end-cookie-bogus-lra cookie))
2899 (lra-sc-offset (sb!c::compiled-debug-fun-return-pc
2900 (compiled-debug-fun-compiler-debug-fun
2901 (fun-end-cookie-debug-fun cookie)))))
2902 (do ((frame frame (frame-down frame)))
2904 (when (and (compiled-frame-p frame)
2905 (#!-x86 eq #!+x86 sap=
2907 (get-context-value frame lra-save-offset lra-sc-offset)))
2910 ;;;; ACTIVATE-BREAKPOINT
2912 ;;; Cause the system to invoke the breakpoint's hook function until
2913 ;;; the next call to DEACTIVATE-BREAKPOINT or DELETE-BREAKPOINT. The
2914 ;;; system invokes breakpoint hook functions in the opposite order
2915 ;;; that you activate them.
2916 (defun activate-breakpoint (breakpoint)
2917 (when (eq (breakpoint-status breakpoint) :deleted)
2918 (error "cannot activate a deleted breakpoint: ~S" breakpoint))
2919 (unless (eq (breakpoint-status breakpoint) :active)
2920 (ecase (breakpoint-kind breakpoint)
2922 (let ((loc (breakpoint-what breakpoint)))
2924 (compiled-code-location
2925 (activate-compiled-code-location-breakpoint breakpoint)
2926 (let ((other (breakpoint-unknown-return-partner breakpoint)))
2928 (activate-compiled-code-location-breakpoint other))))
2929 ;; (There used to be more cases back before sbcl-0.7.0, when
2930 ;; we did special tricks to debug the IR1 interpreter.)
2933 (etypecase (breakpoint-what breakpoint)
2935 (activate-compiled-fun-start-breakpoint breakpoint))
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 (let ((starter (breakpoint-start-helper breakpoint)))
2943 (unless (eq (breakpoint-status starter) :active)
2944 ;; may already be active by some other :FUN-END breakpoint
2945 (activate-compiled-fun-start-breakpoint starter)))
2946 (setf (breakpoint-status breakpoint) :active))
2947 ;; (There used to be more cases back before sbcl-0.7.0, when
2948 ;; we did special tricks to debug the IR1 interpreter.)
2952 (defun activate-compiled-code-location-breakpoint (breakpoint)
2953 (declare (type breakpoint breakpoint))
2954 (let ((loc (breakpoint-what breakpoint)))
2955 (declare (type compiled-code-location loc))
2956 (sub-activate-breakpoint
2958 (breakpoint-data (compiled-debug-fun-component
2959 (code-location-debug-fun loc))
2960 (+ (compiled-code-location-pc loc)
2961 (if (or (eq (breakpoint-kind breakpoint)
2962 :unknown-return-partner)
2963 (eq (compiled-code-location-kind loc)
2964 :single-value-return))
2965 sb!vm:single-value-return-byte-offset
2968 (defun activate-compiled-fun-start-breakpoint (breakpoint)
2969 (declare (type breakpoint breakpoint))
2970 (let ((debug-fun (breakpoint-what breakpoint)))
2971 (sub-activate-breakpoint
2973 (breakpoint-data (compiled-debug-fun-component debug-fun)
2974 (sb!c::compiled-debug-fun-start-pc
2975 (compiled-debug-fun-compiler-debug-fun
2978 (defun sub-activate-breakpoint (breakpoint data)
2979 (declare (type breakpoint breakpoint)
2980 (type breakpoint-data data))
2981 (setf (breakpoint-status breakpoint) :active)
2983 (unless (breakpoint-data-breakpoints data)
2984 (setf (breakpoint-data-instruction data)
2986 (breakpoint-install (get-lisp-obj-address
2987 (breakpoint-data-component data))
2988 (breakpoint-data-offset data)))))
2989 (setf (breakpoint-data-breakpoints data)
2990 (append (breakpoint-data-breakpoints data) (list breakpoint)))
2991 (setf (breakpoint-internal-data breakpoint) data)))
2993 ;;;; DEACTIVATE-BREAKPOINT
2995 ;;; Stop the system from invoking the breakpoint's hook function.
2996 (defun deactivate-breakpoint (breakpoint)
2997 (when (eq (breakpoint-status breakpoint) :active)
2999 (let ((loc (breakpoint-what breakpoint)))
3001 ((or compiled-code-location compiled-debug-fun)
3002 (deactivate-compiled-breakpoint breakpoint)
3003 (let ((other (breakpoint-unknown-return-partner breakpoint)))
3005 (deactivate-compiled-breakpoint other))))
3006 ;; (There used to be more cases back before sbcl-0.7.0, when
3007 ;; we did special tricks to debug the IR1 interpreter.)
3011 (defun deactivate-compiled-breakpoint (breakpoint)
3012 (if (eq (breakpoint-kind breakpoint) :fun-end)
3013 (let ((starter (breakpoint-start-helper breakpoint)))
3014 (unless (find-if (lambda (bpt)
3015 (and (not (eq bpt breakpoint))
3016 (eq (breakpoint-status bpt) :active)))
3017 (breakpoint-%info starter))
3018 (deactivate-compiled-breakpoint starter)))
3019 (let* ((data (breakpoint-internal-data breakpoint))
3020 (bpts (delete breakpoint (breakpoint-data-breakpoints data))))
3021 (setf (breakpoint-internal-data breakpoint) nil)
3022 (setf (breakpoint-data-breakpoints data) bpts)
3025 (breakpoint-remove (get-lisp-obj-address
3026 (breakpoint-data-component data))
3027 (breakpoint-data-offset data)
3028 (breakpoint-data-instruction data)))
3029 (delete-breakpoint-data data))))
3030 (setf (breakpoint-status breakpoint) :inactive)
3033 ;;;; BREAKPOINT-INFO
3035 ;;; Return the user-maintained info associated with breakpoint. This
3037 (defun breakpoint-info (breakpoint)
3038 (breakpoint-%info breakpoint))
3039 (defun %set-breakpoint-info (breakpoint value)
3040 (setf (breakpoint-%info breakpoint) value)
3041 (let ((other (breakpoint-unknown-return-partner breakpoint)))
3043 (setf (breakpoint-%info other) value))))
3045 ;;;; BREAKPOINT-ACTIVE-P and DELETE-BREAKPOINT
3047 (defun breakpoint-active-p (breakpoint)
3048 (ecase (breakpoint-status breakpoint)
3050 ((:inactive :deleted) nil)))
3052 ;;; Free system storage and remove computational overhead associated
3053 ;;; with breakpoint. After calling this, breakpoint is completely
3054 ;;; impotent and can never become active again.
3055 (defun delete-breakpoint (breakpoint)
3056 (let ((status (breakpoint-status breakpoint)))
3057 (unless (eq status :deleted)
3058 (when (eq status :active)
3059 (deactivate-breakpoint breakpoint))
3060 (setf (breakpoint-status breakpoint) :deleted)
3061 (let ((other (breakpoint-unknown-return-partner breakpoint)))
3063 (setf (breakpoint-status other) :deleted)))
3064 (when (eq (breakpoint-kind breakpoint) :fun-end)
3065 (let* ((starter (breakpoint-start-helper breakpoint))
3066 (breakpoints (delete breakpoint
3067 (the list (breakpoint-info starter)))))
3068 (setf (breakpoint-info starter) breakpoints)
3070 (delete-breakpoint starter)
3071 (setf (compiled-debug-fun-end-starter
3072 (breakpoint-what breakpoint))
3076 ;;;; C call out stubs
3078 ;;; This actually installs the break instruction in the component. It
3079 ;;; returns the overwritten bits. You must call this in a context in
3080 ;;; which GC is disabled, so that Lisp doesn't move objects around
3081 ;;; that C is pointing to.
3082 (sb!alien:define-alien-routine "breakpoint_install" sb!alien:unsigned-long
3083 (code-obj sb!alien:unsigned-long)
3084 (pc-offset sb!alien:int))
3086 ;;; This removes the break instruction and replaces the original
3087 ;;; instruction. You must call this in a context in which GC is disabled
3088 ;;; so Lisp doesn't move objects around that C is pointing to.
3089 (sb!alien:define-alien-routine "breakpoint_remove" sb!alien:void
3090 (code-obj sb!alien:unsigned-long)
3091 (pc-offset sb!alien:int)
3092 (old-inst sb!alien:unsigned-long))
3094 (sb!alien:define-alien-routine "breakpoint_do_displaced_inst" sb!alien:void
3095 (scp (* os-context-t))
3096 (orig-inst sb!alien:unsigned-long))
3098 ;;;; breakpoint handlers (layer between C and exported interface)
3100 ;;; This maps components to a mapping of offsets to BREAKPOINT-DATAs.
3101 (defvar *component-breakpoint-offsets* (make-hash-table :test 'eq))
3103 ;;; This returns the BREAKPOINT-DATA object associated with component cross
3104 ;;; offset. If none exists, this makes one, installs it, and returns it.
3105 (defun breakpoint-data (component offset &optional (create t))
3106 (flet ((install-breakpoint-data ()
3108 (let ((data (make-breakpoint-data component offset)))
3109 (push (cons offset data)
3110 (gethash component *component-breakpoint-offsets*))
3112 (let ((offsets (gethash component *component-breakpoint-offsets*)))
3114 (let ((data (assoc offset offsets)))
3117 (install-breakpoint-data)))
3118 (install-breakpoint-data)))))
3120 ;;; We use this when there are no longer any active breakpoints
3121 ;;; corresponding to DATA.
3122 (defun delete-breakpoint-data (data)
3123 (let* ((component (breakpoint-data-component data))
3124 (offsets (delete (breakpoint-data-offset data)
3125 (gethash component *component-breakpoint-offsets*)
3128 (setf (gethash component *component-breakpoint-offsets*) offsets)
3129 (remhash component *component-breakpoint-offsets*)))
3132 ;;; The C handler for interrupts calls this when it has a
3133 ;;; debugging-tool break instruction. This does *not* handle all
3134 ;;; breaks; for example, it does not handle breaks for internal
3136 (defun handle-breakpoint (offset component signal-context)
3137 (let ((data (breakpoint-data component offset nil)))
3139 (error "unknown breakpoint in ~S at offset ~S"
3140 (debug-fun-name (debug-fun-from-pc component offset))
3142 (let ((breakpoints (breakpoint-data-breakpoints data)))
3143 (if (or (null breakpoints)
3144 (eq (breakpoint-kind (car breakpoints)) :fun-end))
3145 (handle-fun-end-breakpoint-aux breakpoints data signal-context)
3146 (handle-breakpoint-aux breakpoints data
3147 offset component signal-context)))))
3149 ;;; This holds breakpoint-datas while invoking the breakpoint hooks
3150 ;;; associated with that particular component and location. While they
3151 ;;; are executing, if we hit the location again, we ignore the
3152 ;;; breakpoint to avoid infinite recursion. fun-end breakpoints
3153 ;;; must work differently since the breakpoint-data is unique for each
3155 (defvar *executing-breakpoint-hooks* nil)
3157 ;;; This handles code-location and DEBUG-FUN :FUN-START
3159 (defun handle-breakpoint-aux (breakpoints data offset component signal-context)
3161 (bug "breakpoint that nobody wants"))
3162 (unless (member data *executing-breakpoint-hooks*)
3163 (let ((*executing-breakpoint-hooks* (cons data
3164 *executing-breakpoint-hooks*)))
3165 (invoke-breakpoint-hooks breakpoints component offset)))
3166 ;; At this point breakpoints may not hold the same list as
3167 ;; BREAKPOINT-DATA-BREAKPOINTS since invoking hooks may have allowed
3168 ;; a breakpoint deactivation. In fact, if all breakpoints were
3169 ;; deactivated then data is invalid since it was deleted and so the
3170 ;; correct one must be looked up if it is to be used. If there are
3171 ;; no more breakpoints active at this location, then the normal
3172 ;; instruction has been put back, and we do not need to
3173 ;; DO-DISPLACED-INST.
3174 (let ((data (breakpoint-data component offset nil)))
3175 (when (and data (breakpoint-data-breakpoints data))
3176 ;; The breakpoint is still active, so we need to execute the
3177 ;; displaced instruction and leave the breakpoint instruction
3178 ;; behind. The best way to do this is different on each machine,
3179 ;; so we just leave it up to the C code.
3180 (breakpoint-do-displaced-inst signal-context
3181 (breakpoint-data-instruction data))
3182 ;; Some platforms have no usable sigreturn() call. If your
3183 ;; implementation of arch_do_displaced_inst() _does_ sigreturn(),
3184 ;; it's polite to warn here
3185 #!+(and sparc solaris)
3186 (error "BREAKPOINT-DO-DISPLACED-INST returned?"))))
3188 (defun invoke-breakpoint-hooks (breakpoints component offset)
3189 (let* ((debug-fun (debug-fun-from-pc component offset))
3190 (frame (do ((f (top-frame) (frame-down f)))
3191 ((eq debug-fun (frame-debug-fun f)) f))))
3192 (dolist (bpt breakpoints)
3193 (funcall (breakpoint-hook-fun bpt)
3195 ;; If this is an :UNKNOWN-RETURN-PARTNER, then pass the
3196 ;; hook function the original breakpoint, so that users
3197 ;; aren't forced to confront the fact that some
3198 ;; breakpoints really are two.
3199 (if (eq (breakpoint-kind bpt) :unknown-return-partner)
3200 (breakpoint-unknown-return-partner bpt)
3203 (defun handle-fun-end-breakpoint (offset component context)
3204 (let ((data (breakpoint-data component offset nil)))
3206 (error "unknown breakpoint in ~S at offset ~S"
3207 (debug-fun-name (debug-fun-from-pc component offset))
3209 (let ((breakpoints (breakpoint-data-breakpoints data)))
3211 (aver (eq (breakpoint-kind (car breakpoints)) :fun-end))
3212 (handle-fun-end-breakpoint-aux breakpoints data context)))))
3214 ;;; Either HANDLE-BREAKPOINT calls this for :FUN-END breakpoints
3215 ;;; [old C code] or HANDLE-FUN-END-BREAKPOINT calls this directly
3217 (defun handle-fun-end-breakpoint-aux (breakpoints data signal-context)
3218 (delete-breakpoint-data data)
3221 (declare (optimize (inhibit-warnings 3)))
3222 (sb!alien:sap-alien signal-context (* os-context-t))))
3223 (frame (do ((cfp (sb!vm:context-register scp sb!vm::cfp-offset))
3224 (f (top-frame) (frame-down f)))
3225 ((= cfp (sap-int (frame-pointer f))) f)
3226 (declare (type (unsigned-byte #.sb!vm:n-word-bits) cfp))))
3227 (component (breakpoint-data-component data))
3228 (cookie (gethash component *fun-end-cookies*)))
3229 (remhash component *fun-end-cookies*)
3230 (dolist (bpt breakpoints)
3231 (funcall (breakpoint-hook-fun bpt)
3233 (get-fun-end-breakpoint-values scp)
3236 (defun get-fun-end-breakpoint-values (scp)
3237 (let ((ocfp (int-sap (sb!vm:context-register
3239 #!-x86 sb!vm::ocfp-offset
3240 #!+x86 sb!vm::ebx-offset)))
3241 (nargs (make-lisp-obj
3242 (sb!vm:context-register scp sb!vm::nargs-offset)))
3243 (reg-arg-offsets '#.sb!vm::*register-arg-offsets*)
3246 (dotimes (arg-num nargs)
3247 (push (if reg-arg-offsets
3249 (sb!vm:context-register scp (pop reg-arg-offsets)))
3250 (stack-ref ocfp arg-num))
3252 (nreverse results)))
3254 ;;;; MAKE-BOGUS-LRA (used for :FUN-END breakpoints)
3256 (defconstant bogus-lra-constants
3258 (defconstant known-return-p-slot
3259 (+ sb!vm:code-constants-offset #!-x86 1 #!+x86 2))
3261 ;;; Make a bogus LRA object that signals a breakpoint trap when
3262 ;;; returned to. If the breakpoint trap handler returns, REAL-LRA is
3263 ;;; returned to. Three values are returned: the bogus LRA object, the
3264 ;;; code component it is part of, and the PC offset for the trap
3266 (defun make-bogus-lra (real-lra &optional known-return-p)
3268 (let* ((src-start (foreign-symbol-address "fun_end_breakpoint_guts"))
3269 (src-end (foreign-symbol-address "fun_end_breakpoint_end"))
3270 (trap-loc (foreign-symbol-address "fun_end_breakpoint_trap"))
3271 (length (sap- src-end src-start))
3273 (%primitive sb!c:allocate-code-object (1+ bogus-lra-constants)
3275 (dst-start (code-instructions code-object)))
3276 (declare (type system-area-pointer
3277 src-start src-end dst-start trap-loc)
3278 (type index length))
3279 (setf (%code-debug-info code-object) :bogus-lra)
3280 (setf (code-header-ref code-object sb!vm:code-trace-table-offset-slot)
3283 (setf (code-header-ref code-object real-lra-slot) real-lra)
3285 (multiple-value-bind (offset code) (compute-lra-data-from-pc real-lra)
3286 (setf (code-header-ref code-object real-lra-slot) code)
3287 (setf (code-header-ref code-object (1+ real-lra-slot)) offset))
3288 (setf (code-header-ref code-object known-return-p-slot)
3290 (system-area-copy src-start 0 dst-start 0 (* length sb!vm:n-byte-bits))
3291 (sb!vm:sanctify-for-execution code-object)
3293 (values dst-start code-object (sap- trap-loc src-start))
3295 (let ((new-lra (make-lisp-obj (+ (sap-int dst-start)
3296 sb!vm:other-pointer-lowtag))))
3299 (logandc2 (+ sb!vm:code-constants-offset bogus-lra-constants 1)
3301 (sb!vm:sanctify-for-execution code-object)
3302 (values new-lra code-object (sap- trap-loc src-start))))))
3306 ;;; This appears here because it cannot go with the DEBUG-FUN
3307 ;;; interface since DO-DEBUG-BLOCK-LOCATIONS isn't defined until after
3308 ;;; the DEBUG-FUN routines.
3310 ;;; Return a code-location before the body of a function and after all
3311 ;;; the arguments are in place; or if that location can't be
3312 ;;; determined due to a lack of debug information, return NIL.
3313 (defun debug-fun-start-location (debug-fun)
3314 (etypecase debug-fun
3316 (code-location-from-pc debug-fun
3317 (sb!c::compiled-debug-fun-start-pc
3318 (compiled-debug-fun-compiler-debug-fun
3321 ;; (There used to be more cases back before sbcl-0.7.0, when
3322 ;; we did special tricks to debug the IR1 interpreter.)