1 ;;;; the implementation of the programmer's interface to writing
4 ;;;; This software is part of the SBCL system. See the README file for
7 ;;;; This software is derived from the CMU CL system, which was
8 ;;;; written at Carnegie Mellon University and released into the
9 ;;;; public domain. The software is in the public domain and is
10 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
11 ;;;; files for more information.
15 ;;; FIXME: There are an awful lot of package prefixes in this code.
16 ;;; Couldn't we have SB-DI use the SB-C and SB-VM packages?
20 ;;;; The interface to building debugging tools signals conditions that
21 ;;;; prevent it from adhering to its contract. These are
22 ;;;; serious-conditions because the program using the interface must
23 ;;;; handle them before it can correctly continue execution. These
24 ;;;; debugging conditions are not errors since it is no fault of the
25 ;;;; programmers that the conditions occur. The interface does not
26 ;;;; provide for programs to detect these situations other than
27 ;;;; calling a routine that detects them and signals a condition. For
28 ;;;; example, programmers call A which may fail to return successfully
29 ;;;; due to a lack of debug information, and there is no B the they
30 ;;;; could have called to realize A would fail. It is not an error to
31 ;;;; have called A, but it is an error for the program to then ignore
32 ;;;; the signal generated by A since it cannot continue without A's
33 ;;;; correctly returning a value or performing some operation.
35 ;;;; Use DEBUG-SIGNAL to signal these conditions.
37 (define-condition debug-condition (serious-condition)
41 "All DEBUG-CONDITIONs inherit from this type. These are serious conditions
42 that must be handled, but they are not programmer errors."))
44 (define-condition no-debug-fun-returns (debug-condition)
45 ((debug-fun :reader no-debug-fun-returns-debug-fun
49 "The system could not return values from a frame with DEBUG-FUN since
50 it lacked information about returning values.")
51 (:report (lambda (condition stream)
52 (let ((fun (debug-fun-fun
53 (no-debug-fun-returns-debug-fun condition))))
55 "~&Cannot return values from ~:[frame~;~:*~S~] since ~
56 the debug information lacks details about returning ~
60 (define-condition no-debug-blocks (debug-condition)
61 ((debug-fun :reader no-debug-blocks-debug-fun
64 (:documentation "The debug-fun has no debug-block information.")
65 (:report (lambda (condition stream)
66 (format stream "~&~S has no debug-block information."
67 (no-debug-blocks-debug-fun condition)))))
69 (define-condition no-debug-vars (debug-condition)
70 ((debug-fun :reader no-debug-vars-debug-fun
73 (:documentation "The DEBUG-FUN has no DEBUG-VAR information.")
74 (:report (lambda (condition stream)
75 (format stream "~&~S has no debug variable information."
76 (no-debug-vars-debug-fun condition)))))
78 (define-condition lambda-list-unavailable (debug-condition)
79 ((debug-fun :reader lambda-list-unavailable-debug-fun
83 "The DEBUG-FUN has no lambda list since argument DEBUG-VARs are
85 (:report (lambda (condition stream)
86 (format stream "~&~S has no lambda-list information available."
87 (lambda-list-unavailable-debug-fun condition)))))
89 (define-condition invalid-value (debug-condition)
90 ((debug-var :reader invalid-value-debug-var :initarg :debug-var)
91 (frame :reader invalid-value-frame :initarg :frame))
92 (:report (lambda (condition stream)
93 (format stream "~&~S has :invalid or :unknown value in ~S."
94 (invalid-value-debug-var condition)
95 (invalid-value-frame condition)))))
97 (define-condition ambiguous-var-name (debug-condition)
98 ((name :reader ambiguous-var-name-name :initarg :name)
99 (frame :reader ambiguous-var-name-frame :initarg :frame))
100 (:report (lambda (condition stream)
101 (format stream "~&~S names more than one valid variable in ~S."
102 (ambiguous-var-name-name condition)
103 (ambiguous-var-name-frame condition)))))
105 ;;;; errors and DEBUG-SIGNAL
107 ;;; The debug-internals code tries to signal all programmer errors as
108 ;;; subtypes of DEBUG-ERROR. There are calls to ERROR signalling
109 ;;; SIMPLE-ERRORs, but these dummy checks in the code and shouldn't
112 ;;; While under development, this code also signals errors in code
113 ;;; branches that remain unimplemented.
115 (define-condition debug-error (error) ()
118 "All programmer errors from using the interface for building debugging
119 tools inherit from this type."))
121 (define-condition unhandled-debug-condition (debug-error)
122 ((condition :reader unhandled-debug-condition-condition :initarg :condition))
123 (:report (lambda (condition stream)
124 (format stream "~&unhandled DEBUG-CONDITION:~%~A"
125 (unhandled-debug-condition-condition condition)))))
127 (define-condition unknown-code-location (debug-error)
128 ((code-location :reader unknown-code-location-code-location
129 :initarg :code-location))
130 (:report (lambda (condition stream)
131 (format stream "~&invalid use of an unknown code-location: ~S"
132 (unknown-code-location-code-location condition)))))
134 (define-condition unknown-debug-var (debug-error)
135 ((debug-var :reader unknown-debug-var-debug-var :initarg :debug-var)
136 (debug-fun :reader unknown-debug-var-debug-fun
137 :initarg :debug-fun))
138 (:report (lambda (condition stream)
139 (format stream "~&~S is not in ~S."
140 (unknown-debug-var-debug-var condition)
141 (unknown-debug-var-debug-fun condition)))))
143 (define-condition invalid-control-stack-pointer (debug-error)
145 (:report (lambda (condition stream)
146 (declare (ignore condition))
148 (write-string "invalid control stack pointer" stream))))
150 (define-condition frame-fun-mismatch (debug-error)
151 ((code-location :reader frame-fun-mismatch-code-location
152 :initarg :code-location)
153 (frame :reader frame-fun-mismatch-frame :initarg :frame)
154 (form :reader frame-fun-mismatch-form :initarg :form))
155 (:report (lambda (condition stream)
158 "~&Form was preprocessed for ~S,~% but called on ~S:~% ~S"
159 (frame-fun-mismatch-code-location condition)
160 (frame-fun-mismatch-frame condition)
161 (frame-fun-mismatch-form condition)))))
163 ;;; This signals debug-conditions. If they go unhandled, then signal
164 ;;; an UNHANDLED-DEBUG-CONDITION error.
166 ;;; ??? Get SIGNAL in the right package!
167 (defmacro debug-signal (datum &rest arguments)
168 `(let ((condition (make-condition ,datum ,@arguments)))
170 (error 'unhandled-debug-condition :condition condition)))
174 ;;;; Most of these structures model information stored in internal
175 ;;;; data structures created by the compiler. Whenever comments
176 ;;;; preface an object or type with "compiler", they refer to the
177 ;;;; internal compiler thing, not to the object or type with the same
178 ;;;; name in the "SB-DI" package.
182 ;;; These exist for caching data stored in packed binary form in
183 ;;; compiler DEBUG-FUNs.
184 (defstruct (debug-var (:constructor nil)
186 ;; the name of the variable
187 (symbol (missing-arg) :type symbol)
188 ;; a unique integer identification relative to other variables with the same
191 ;; Does the variable always have a valid value?
192 (alive-p nil :type boolean))
193 (def!method print-object ((debug-var debug-var) stream)
194 (print-unreadable-object (debug-var stream :type t :identity t)
197 (debug-var-symbol debug-var)
198 (debug-var-id debug-var))))
201 (setf (fdocumentation 'debug-var-id 'function)
202 "Return the integer that makes DEBUG-VAR's name and package unique
203 with respect to other DEBUG-VARs in the same function.")
205 (defstruct (compiled-debug-var
207 (:constructor make-compiled-debug-var
208 (symbol id alive-p sc-offset save-sc-offset))
210 ;; storage class and offset (unexported)
211 (sc-offset nil :type sb!c:sc-offset)
212 ;; storage class and offset when saved somewhere
213 (save-sc-offset nil :type (or sb!c:sc-offset null)))
217 ;;; These represent call frames on the stack.
218 (defstruct (frame (:constructor nil)
220 ;; the next frame up, or NIL when top frame
221 (up nil :type (or frame null))
222 ;; the previous frame down, or NIL when the bottom frame. Before
223 ;; computing the next frame down, this slot holds the frame pointer
224 ;; to the control stack for the given frame. This lets us get the
225 ;; next frame down and the return-pc for that frame.
226 (%down :unparsed :type (or frame (member nil :unparsed)))
227 ;; the DEBUG-FUN for the function whose call this frame represents
228 (debug-fun nil :type debug-fun)
229 ;; the CODE-LOCATION where the frame's DEBUG-FUN will continue
230 ;; running when program execution returns to this frame. If someone
231 ;; interrupted this frame, the result could be an unknown
233 (code-location nil :type code-location)
234 ;; an a-list of catch-tags to code-locations
235 (%catches :unparsed :type (or list (member :unparsed)))
236 ;; pointer to frame on control stack (unexported)
238 ;; This is the frame's number for prompt printing. Top is zero.
239 (number 0 :type index))
241 (defstruct (compiled-frame
243 (:constructor make-compiled-frame
244 (pointer up debug-fun code-location number
247 ;; This indicates whether someone interrupted the frame.
248 ;; (unexported). If escaped, this is a pointer to the state that was
249 ;; saved when we were interrupted, an os_context_t, i.e. the third
250 ;; argument to an SA_SIGACTION-style signal handler.
252 (def!method print-object ((obj compiled-frame) str)
253 (print-unreadable-object (obj str :type t)
255 "~S~:[~;, interrupted~]"
256 (debug-fun-name (frame-debug-fun obj))
257 (compiled-frame-escaped obj))))
261 ;;; These exist for caching data stored in packed binary form in
262 ;;; compiler DEBUG-FUNs. *COMPILED-DEBUG-FUNS* maps a SB!C::DEBUG-FUN
263 ;;; to a DEBUG-FUN. There should only be one DEBUG-FUN in existence
264 ;;; for any function; that is, all CODE-LOCATIONs and other objects
265 ;;; that reference DEBUG-FUNs point to unique objects. This is
266 ;;; due to the overhead in cached information.
267 (defstruct (debug-fun (:constructor nil)
269 ;; some representation of the function arguments. See
270 ;; DEBUG-FUN-LAMBDA-LIST.
271 ;; NOTE: must parse vars before parsing arg list stuff.
272 (%lambda-list :unparsed)
273 ;; cached DEBUG-VARS information (unexported).
274 ;; These are sorted by their name.
275 (%debug-vars :unparsed :type (or simple-vector null (member :unparsed)))
276 ;; cached debug-block information. This is NIL when we have tried to
277 ;; parse the packed binary info, but none is available.
278 (blocks :unparsed :type (or simple-vector null (member :unparsed)))
279 ;; the actual function if available
280 (%function :unparsed :type (or null function (member :unparsed))))
281 (def!method print-object ((obj debug-fun) stream)
282 (print-unreadable-object (obj stream :type t)
283 (prin1 (debug-fun-name obj) stream)))
285 (defstruct (compiled-debug-fun
287 (:constructor %make-compiled-debug-fun
288 (compiler-debug-fun component))
290 ;; compiler's dumped DEBUG-FUN information (unexported)
291 (compiler-debug-fun nil :type sb!c::compiled-debug-fun)
292 ;; code object (unexported).
294 ;; the :FUN-START breakpoint (if any) used to facilitate
295 ;; function end breakpoints
296 (end-starter nil :type (or null breakpoint)))
298 ;;; This maps SB!C::COMPILED-DEBUG-FUNs to
299 ;;; COMPILED-DEBUG-FUNs, so we can get at cached stuff and not
300 ;;; duplicate COMPILED-DEBUG-FUN structures.
301 (defvar *compiled-debug-funs* (make-hash-table :test 'eq))
303 ;;; Make a COMPILED-DEBUG-FUN for a SB!C::COMPILER-DEBUG-FUN
304 ;;; and its component. This maps the latter to the former in
305 ;;; *COMPILED-DEBUG-FUNS*. If there already is a
306 ;;; COMPILED-DEBUG-FUN, then this returns it from
307 ;;; *COMPILED-DEBUG-FUNS*.
308 (defun make-compiled-debug-fun (compiler-debug-fun component)
309 (or (gethash compiler-debug-fun *compiled-debug-funs*)
310 (setf (gethash compiler-debug-fun *compiled-debug-funs*)
311 (%make-compiled-debug-fun compiler-debug-fun component))))
313 (defstruct (bogus-debug-fun
315 (:constructor make-bogus-debug-fun
324 (defvar *ir1-lambda-debug-fun* (make-hash-table :test 'eq))
328 ;;; These exist for caching data stored in packed binary form in compiler
330 (defstruct (debug-block (:constructor nil)
332 ;; Code-locations where execution continues after this block.
333 (successors nil :type list)
334 ;; This indicates whether the block is a special glob of code shared
335 ;; by various functions and tucked away elsewhere in a component.
336 ;; This kind of block has no start code-location. This slot is in
337 ;; all debug-blocks since it is an exported interface.
338 (elsewhere-p nil :type boolean))
339 (def!method print-object ((obj debug-block) str)
340 (print-unreadable-object (obj str :type t)
341 (prin1 (debug-block-fun-name obj) str)))
344 (setf (fdocumentation 'debug-block-successors 'function)
345 "Return the list of possible code-locations where execution may continue
346 when the basic-block represented by debug-block completes its execution.")
349 (setf (fdocumentation 'debug-block-elsewhere-p 'function)
350 "Return whether debug-block represents elsewhere code.")
352 (defstruct (compiled-debug-block (:include debug-block)
354 make-compiled-debug-block
355 (code-locations successors elsewhere-p))
357 ;; code-location information for the block
358 (code-locations nil :type simple-vector))
360 (defvar *ir1-block-debug-block* (make-hash-table :test 'eq))
364 ;;; This is an internal structure that manages information about a
365 ;;; breakpoint locations. See *COMPONENT-BREAKPOINT-OFFSETS*.
366 (defstruct (breakpoint-data (:constructor make-breakpoint-data
369 ;; This is the component in which the breakpoint lies.
371 ;; This is the byte offset into the component.
372 (offset nil :type index)
373 ;; The original instruction replaced by the breakpoint.
374 (instruction nil :type (or null (unsigned-byte 32)))
375 ;; A list of user breakpoints at this location.
376 (breakpoints nil :type list))
377 (def!method print-object ((obj breakpoint-data) str)
378 (print-unreadable-object (obj str :type t)
379 (format str "~S at ~S"
381 (debug-fun-from-pc (breakpoint-data-component obj)
382 (breakpoint-data-offset obj)))
383 (breakpoint-data-offset obj))))
385 (defstruct (breakpoint (:constructor %make-breakpoint
386 (hook-fun what kind %info))
388 ;; This is the function invoked when execution encounters the
389 ;; breakpoint. It takes a frame, the breakpoint, and optionally a
390 ;; list of values. Values are supplied for :FUN-END breakpoints as
391 ;; values to return for the function containing the breakpoint.
392 ;; :FUN-END breakpoint hook functions also take a cookie argument.
393 ;; See the COOKIE-FUN slot.
394 (hook-fun (required-arg) :type function)
395 ;; CODE-LOCATION or DEBUG-FUN
396 (what nil :type (or code-location debug-fun))
397 ;; :CODE-LOCATION, :FUN-START, or :FUN-END for that kind
398 ;; of breakpoint. :UNKNOWN-RETURN-PARTNER if this is the partner of
399 ;; a :code-location breakpoint at an :UNKNOWN-RETURN code-location.
400 (kind nil :type (member :code-location :fun-start :fun-end
401 :unknown-return-partner))
402 ;; Status helps the user and the implementation.
403 (status :inactive :type (member :active :inactive :deleted))
404 ;; This is a backpointer to a breakpoint-data.
405 (internal-data nil :type (or null breakpoint-data))
406 ;; With code-locations whose type is :UNKNOWN-RETURN, there are
407 ;; really two breakpoints: one at the multiple-value entry point,
408 ;; and one at the single-value entry point. This slot holds the
409 ;; breakpoint for the other one, or NIL if this isn't at an
410 ;; :UNKNOWN-RETURN code location.
411 (unknown-return-partner nil :type (or null breakpoint))
412 ;; :FUN-END breakpoints use a breakpoint at the :FUN-START
413 ;; to establish the end breakpoint upon function entry. We do this
414 ;; by frobbing the LRA to jump to a special piece of code that
415 ;; breaks and provides the return values for the returnee. This slot
416 ;; points to the start breakpoint, so we can activate, deactivate,
418 (start-helper nil :type (or null breakpoint))
419 ;; This is a hook users supply to get a dynamically unique cookie
420 ;; for identifying :FUN-END breakpoint executions. That is, if
421 ;; there is one :FUN-END breakpoint, but there may be multiple
422 ;; pending calls of its function on the stack. This function takes
423 ;; the cookie, and the hook function takes the cookie too.
424 (cookie-fun nil :type (or null function))
425 ;; This slot users can set with whatever information they find useful.
427 (def!method print-object ((obj breakpoint) str)
428 (let ((what (breakpoint-what obj)))
429 (print-unreadable-object (obj str :type t)
434 (debug-fun (debug-fun-name what)))
437 (debug-fun (breakpoint-kind obj)))))))
441 (defstruct (code-location (:constructor nil)
443 ;; the DEBUG-FUN containing this CODE-LOCATION
444 (debug-fun nil :type debug-fun)
445 ;; This is initially :UNSURE. Upon first trying to access an
446 ;; :UNPARSED slot, if the data is unavailable, then this becomes T,
447 ;; and the code-location is unknown. If the data is available, this
448 ;; becomes NIL, a known location. We can't use a separate type
449 ;; code-location for this since we must return code-locations before
450 ;; we can tell whether they're known or unknown. For example, when
451 ;; parsing the stack, we don't want to unpack all the variables and
452 ;; blocks just to make frames.
453 (%unknown-p :unsure :type (member t nil :unsure))
454 ;; the DEBUG-BLOCK containing CODE-LOCATION. XXX Possibly toss this
455 ;; out and just find it in the blocks cache in DEBUG-FUN.
456 (%debug-block :unparsed :type (or debug-block (member :unparsed)))
457 ;; This is the number of forms processed by the compiler or loader
458 ;; before the top level form containing this code-location.
459 (%tlf-offset :unparsed :type (or index (member :unparsed)))
460 ;; This is the depth-first number of the node that begins
461 ;; code-location within its top level form.
462 (%form-number :unparsed :type (or index (member :unparsed))))
463 (def!method print-object ((obj code-location) str)
464 (print-unreadable-object (obj str :type t)
465 (prin1 (debug-fun-name (code-location-debug-fun obj))
468 (defstruct (compiled-code-location
469 (:include code-location)
470 (:constructor make-known-code-location
471 (pc debug-fun %tlf-offset %form-number
472 %live-set kind &aux (%unknown-p nil)))
473 (:constructor make-compiled-code-location (pc debug-fun))
475 ;; an index into DEBUG-FUN's component slot
477 ;; a bit-vector indexed by a variable's position in
478 ;; DEBUG-FUN-DEBUG-VARS indicating whether the variable has a
479 ;; valid value at this code-location. (unexported).
480 (%live-set :unparsed :type (or simple-bit-vector (member :unparsed)))
481 ;; (unexported) To see SB!C::LOCATION-KIND, do
482 ;; (SB!KERNEL:TYPE-EXPAND 'SB!C::LOCATION-KIND).
483 (kind :unparsed :type (or (member :unparsed) sb!c::location-kind)))
487 ;;; Return the number of top level forms processed by the compiler
488 ;;; before compiling this source. If this source is uncompiled, this
489 ;;; is zero. This may be zero even if the source is compiled since the
490 ;;; first form in the first file compiled in one compilation, for
491 ;;; example, must have a root number of zero -- the compiler saw no
492 ;;; other top level forms before it.
493 (defun debug-source-root-number (debug-source)
494 (sb!c::debug-source-source-root debug-source))
498 ;;; This is used in FIND-ESCAPED-FRAME and with the bogus components
499 ;;; and LRAs used for :FUN-END breakpoints. When a component's
500 ;;; debug-info slot is :BOGUS-LRA, then the REAL-LRA-SLOT contains the
501 ;;; real component to continue executing, as opposed to the bogus
502 ;;; component which appeared in some frame's LRA location.
503 (defconstant real-lra-slot sb!vm:code-constants-offset)
505 ;;; These are magically converted by the compiler.
506 (defun current-sp () (current-sp))
507 (defun current-fp () (current-fp))
508 (defun stack-ref (s n) (stack-ref s n))
509 (defun %set-stack-ref (s n value) (%set-stack-ref s n value))
510 (defun fun-code-header (fun) (fun-code-header fun))
511 (defun lra-code-header (lra) (lra-code-header lra))
512 (defun make-lisp-obj (value) (make-lisp-obj value))
513 (defun get-lisp-obj-address (thing) (get-lisp-obj-address thing))
514 (defun fun-word-offset (fun) (fun-word-offset fun))
516 #!-sb-fluid (declaim (inline control-stack-pointer-valid-p))
517 (defun control-stack-pointer-valid-p (x)
518 (declare (type system-area-pointer x))
519 (let* (#!-stack-grows-downward-not-upward
521 (descriptor-sap *control-stack-start*))
522 #!+stack-grows-downward-not-upward
524 (descriptor-sap *control-stack-end*)))
525 #!-stack-grows-downward-not-upward
526 (and (sap< x (current-sp))
527 (sap<= control-stack-start x)
528 (zerop (logand (sap-int x) #b11)))
529 #!+stack-grows-downward-not-upward
530 (and (sap>= x (current-sp))
531 (sap> control-stack-end x)
532 (zerop (logand (sap-int x) #b11)))))
534 (sb!alien:define-alien-routine component-ptr-from-pc (system-area-pointer)
535 (pc system-area-pointer))
537 (defun component-from-component-ptr (component-ptr)
538 (declare (type system-area-pointer component-ptr))
539 (make-lisp-obj (logior (sap-int component-ptr)
540 sb!vm:other-pointer-lowtag)))
547 (defun compute-lra-data-from-pc (pc)
548 (declare (type system-area-pointer pc))
549 (let ((component-ptr (component-ptr-from-pc pc)))
550 (unless (sap= component-ptr (int-sap #x0))
551 (let* ((code (component-from-component-ptr component-ptr))
552 (code-header-len (* (get-header-data code) sb!vm:n-word-bytes))
553 (pc-offset (- (sap-int pc)
554 (- (get-lisp-obj-address code)
555 sb!vm:other-pointer-lowtag)
557 ; (format t "c-lra-fpc ~A ~A ~A~%" pc code pc-offset)
558 (values pc-offset code)))))
560 (defconstant sb!vm::nargs-offset #.sb!vm::ecx-offset)
562 ;;; Check for a valid return address - it could be any valid C/Lisp
565 ;;; XXX Could be a little smarter.
566 #!-sb-fluid (declaim (inline ra-pointer-valid-p))
567 (defun ra-pointer-valid-p (ra)
568 (declare (type system-area-pointer ra))
570 ;; not the first page (which is unmapped)
572 ;; FIXME: Where is this documented? Is it really true of every CPU
573 ;; architecture? Is it even necessarily true in current SBCL?
574 (>= (sap-int ra) 4096)
575 ;; not a Lisp stack pointer
576 (not (control-stack-pointer-valid-p ra))))
578 ;;; Try to find a valid previous stack. This is complex on the x86 as
579 ;;; it can jump between C and Lisp frames. To help find a valid frame
580 ;;; it searches backwards.
582 ;;; XXX Should probably check whether it has reached the bottom of the
585 ;;; XXX Should handle interrupted frames, both Lisp and C. At present
586 ;;; it manages to find a fp trail, see linux hack below.
587 (defun x86-call-context (fp &key (depth 0))
588 (declare (type system-area-pointer fp)
590 ;;(format t "*CC ~S ~S~%" fp depth)
592 ((not (control-stack-pointer-valid-p fp))
593 #+nil (format t "debug invalid fp ~S~%" fp)
596 ;; Check the two possible frame pointers.
597 (let ((lisp-ocfp (sap-ref-sap fp (- (* (1+ ocfp-save-offset) 4))))
598 (lisp-ra (sap-ref-sap fp (- (* (1+ return-pc-save-offset)
600 (c-ocfp (sap-ref-sap fp (* 0 sb!vm:n-word-bytes)))
601 (c-ra (sap-ref-sap fp (* 1 sb!vm:n-word-bytes))))
602 (cond ((and (sap> lisp-ocfp fp) (control-stack-pointer-valid-p lisp-ocfp)
603 (ra-pointer-valid-p lisp-ra)
604 (sap> c-ocfp fp) (control-stack-pointer-valid-p c-ocfp)
605 (ra-pointer-valid-p c-ra))
607 "*C Both valid ~S ~S ~S ~S~%"
608 lisp-ocfp lisp-ra c-ocfp c-ra)
609 ;; Look forward another step to check their validity.
610 (let ((lisp-path-fp (x86-call-context lisp-ocfp
612 (c-path-fp (x86-call-context c-ocfp :depth (1+ depth))))
613 (cond ((and lisp-path-fp c-path-fp)
614 ;; Both still seem valid - choose the lisp frame.
615 #+nil (when (zerop depth)
617 "debug: both still valid ~S ~S ~S ~S~%"
618 lisp-ocfp lisp-ra c-ocfp c-ra))
620 (if (sap> lisp-ocfp c-ocfp)
621 (values lisp-ra lisp-ocfp)
622 (values c-ra c-ocfp))
624 (values lisp-ra lisp-ocfp))
626 ;; The lisp convention is looking good.
627 #+nil (format t "*C lisp-ocfp ~S ~S~%" lisp-ocfp lisp-ra)
628 (values lisp-ra lisp-ocfp))
630 ;; The C convention is looking good.
631 #+nil (format t "*C c-ocfp ~S ~S~%" c-ocfp c-ra)
632 (values c-ra c-ocfp))
634 ;; Neither seems right?
635 #+nil (format t "debug: no valid2 fp found ~S ~S~%"
638 ((and (sap> lisp-ocfp fp) (control-stack-pointer-valid-p lisp-ocfp)
639 (ra-pointer-valid-p lisp-ra))
640 ;; The lisp convention is looking good.
641 #+nil (format t "*C lisp-ocfp ~S ~S~%" lisp-ocfp lisp-ra)
642 (values lisp-ra lisp-ocfp))
643 ((and (sap> c-ocfp fp) (control-stack-pointer-valid-p c-ocfp)
644 #!-linux (ra-pointer-valid-p c-ra))
645 ;; The C convention is looking good.
646 #+nil (format t "*C c-ocfp ~S ~S~%" c-ocfp c-ra)
647 (values c-ra c-ocfp))
649 #+nil (format t "debug: no valid fp found ~S ~S~%"
655 ;;; Convert the descriptor into a SAP. The bits all stay the same, we just
656 ;;; change our notion of what we think they are.
657 #!-sb-fluid (declaim (inline descriptor-sap))
658 (defun descriptor-sap (x)
659 (int-sap (get-lisp-obj-address x)))
661 ;;; Return the top frame of the control stack as it was before calling
664 (/noshow0 "entering TOP-FRAME")
665 (multiple-value-bind (fp pc) (%caller-frame-and-pc)
666 (compute-calling-frame (descriptor-sap fp) pc nil)))
668 ;;; Flush all of the frames above FRAME, and renumber all the frames
670 (defun flush-frames-above (frame)
671 (setf (frame-up frame) nil)
672 (do ((number 0 (1+ number))
673 (frame frame (frame-%down frame)))
674 ((not (frame-p frame)))
675 (setf (frame-number frame) number)))
677 ;;; Return the frame immediately below FRAME on the stack; or when
678 ;;; FRAME is the bottom of the stack, return NIL.
679 (defun frame-down (frame)
680 (/noshow0 "entering FRAME-DOWN")
681 ;; We have to access the old-fp and return-pc out of frame and pass
682 ;; them to COMPUTE-CALLING-FRAME.
683 (let ((down (frame-%down frame)))
684 (if (eq down :unparsed)
685 (let ((debug-fun (frame-debug-fun frame)))
686 (/noshow0 "in DOWN :UNPARSED case")
687 (setf (frame-%down frame)
690 (let ((c-d-f (compiled-debug-fun-compiler-debug-fun
692 (compute-calling-frame
695 frame ocfp-save-offset
696 (sb!c::compiled-debug-fun-old-fp c-d-f)))
698 frame lra-save-offset
699 (sb!c::compiled-debug-fun-return-pc c-d-f))
702 (let ((fp (frame-pointer frame)))
703 (when (control-stack-pointer-valid-p fp)
705 (multiple-value-bind (ra ofp) (x86-call-context fp)
706 (and ra (compute-calling-frame ofp ra frame)))
708 (compute-calling-frame
710 (sap-ref-sap fp (* ocfp-save-offset
714 (sap-ref-32 fp (* ocfp-save-offset
715 sb!vm:n-word-bytes)))
717 (stack-ref fp lra-save-offset)
722 ;;; Get the old FP or return PC out of FRAME. STACK-SLOT is the
723 ;;; standard save location offset on the stack. LOC is the saved
724 ;;; SC-OFFSET describing the main location.
726 (defun get-context-value (frame stack-slot loc)
727 (declare (type compiled-frame frame) (type unsigned-byte stack-slot)
728 (type sb!c:sc-offset loc))
729 (let ((pointer (frame-pointer frame))
730 (escaped (compiled-frame-escaped frame)))
732 (sub-access-debug-var-slot pointer loc escaped)
733 (stack-ref pointer stack-slot))))
735 (defun get-context-value (frame stack-slot loc)
736 (declare (type compiled-frame frame) (type unsigned-byte stack-slot)
737 (type sb!c:sc-offset loc))
738 (let ((pointer (frame-pointer frame))
739 (escaped (compiled-frame-escaped frame)))
741 (sub-access-debug-var-slot pointer loc escaped)
744 (stack-ref pointer stack-slot))
746 (sap-ref-sap pointer (- (* (1+ stack-slot) 4))))))))
749 (defun (setf get-context-value) (value frame stack-slot loc)
750 (declare (type compiled-frame frame) (type unsigned-byte stack-slot)
751 (type sb!c:sc-offset loc))
752 (let ((pointer (frame-pointer frame))
753 (escaped (compiled-frame-escaped frame)))
755 (sub-set-debug-var-slot pointer loc value escaped)
756 (setf (stack-ref pointer stack-slot) value))))
759 (defun (setf get-context-value) (value frame stack-slot loc)
760 (declare (type compiled-frame frame) (type unsigned-byte stack-slot)
761 (type sb!c:sc-offset loc))
762 (let ((pointer (frame-pointer frame))
763 (escaped (compiled-frame-escaped frame)))
765 (sub-set-debug-var-slot pointer loc value escaped)
768 (setf (stack-ref pointer stack-slot) value))
770 (setf (sap-ref-sap pointer (- (* (1+ stack-slot) 4))) value))))))
772 (defun foreign-function-backtrace-name (sap)
773 (let ((name (foreign-symbol-in-address sap)))
775 (format nil "foreign function: ~A" name)
776 (format nil "foreign function: #x~X" (sap-int sap)))))
778 ;;; This returns a frame for the one existing in time immediately
779 ;;; prior to the frame referenced by current-fp. This is current-fp's
780 ;;; caller or the next frame down the control stack. If there is no
781 ;;; down frame, this returns NIL for the bottom of the stack. UP-FRAME
782 ;;; is the up link for the resulting frame object, and it is null when
783 ;;; we call this to get the top of the stack.
785 ;;; The current frame contains the pointer to the temporally previous
786 ;;; frame we want, and the current frame contains the pc at which we
787 ;;; will continue executing upon returning to that previous frame.
789 ;;; Note: Sometimes LRA is actually a fixnum. This happens when lisp
790 ;;; calls into C. In this case, the code object is stored on the stack
791 ;;; after the LRA, and the LRA is the word offset.
793 (defun compute-calling-frame (caller lra up-frame)
794 (declare (type system-area-pointer caller))
795 (when (control-stack-pointer-valid-p caller)
796 (multiple-value-bind (code pc-offset escaped)
798 (multiple-value-bind (word-offset code)
800 (let ((fp (frame-pointer up-frame)))
802 (stack-ref fp (1+ lra-save-offset))))
803 (values (get-header-data lra)
804 (lra-code-header lra)))
807 (* (1+ (- word-offset (get-header-data code)))
810 (values :foreign-function
813 (find-escaped-frame caller))
814 (if (and (code-component-p code)
815 (eq (%code-debug-info code) :bogus-lra))
816 (let ((real-lra (code-header-ref code real-lra-slot)))
817 (compute-calling-frame caller real-lra up-frame))
818 (let ((d-fun (case code
820 (make-bogus-debug-fun
821 "undefined function"))
823 (make-bogus-debug-fun
824 (foreign-function-backtrace-name
825 (int-sap (get-lisp-obj-address lra)))))
827 (make-bogus-debug-fun
828 "bogus stack frame"))
830 (debug-fun-from-pc code pc-offset)))))
831 (make-compiled-frame caller up-frame d-fun
832 (code-location-from-pc d-fun pc-offset
834 (if up-frame (1+ (frame-number up-frame)) 0)
837 (defun compute-calling-frame (caller ra up-frame)
838 (declare (type system-area-pointer caller ra))
839 (/noshow0 "entering COMPUTE-CALLING-FRAME")
840 (when (control-stack-pointer-valid-p caller)
842 ;; First check for an escaped frame.
843 (multiple-value-bind (code pc-offset escaped) (find-escaped-frame caller)
846 ;; If it's escaped it may be a function end breakpoint trap.
847 (when (and (code-component-p code)
848 (eq (%code-debug-info code) :bogus-lra))
849 ;; If :bogus-lra grab the real lra.
850 (setq pc-offset (code-header-ref
851 code (1+ real-lra-slot)))
852 (setq code (code-header-ref code real-lra-slot))
855 (multiple-value-setq (pc-offset code)
856 (compute-lra-data-from-pc ra))
858 (setf code :foreign-function
860 (let ((d-fun (case code
862 (make-bogus-debug-fun
863 "undefined function"))
865 (make-bogus-debug-fun
866 (foreign-function-backtrace-name ra)))
868 (make-bogus-debug-fun
869 "bogus stack frame"))
871 (debug-fun-from-pc code pc-offset)))))
872 (/noshow0 "returning MAKE-COMPILED-FRAME from COMPUTE-CALLING-FRAME")
873 (make-compiled-frame caller up-frame d-fun
874 (code-location-from-pc d-fun pc-offset
876 (if up-frame (1+ (frame-number up-frame)) 0)
879 (defun nth-interrupt-context (n)
880 (declare (type (unsigned-byte 32) n)
881 (optimize (speed 3) (safety 0)))
882 (sb!alien:sap-alien (sb!vm::current-thread-offset-sap
883 (+ sb!vm::thread-interrupt-contexts-offset n))
887 (defun find-escaped-frame (frame-pointer)
888 (declare (type system-area-pointer frame-pointer))
889 (/noshow0 "entering FIND-ESCAPED-FRAME")
890 (dotimes (index *free-interrupt-context-index* (values nil 0 nil))
891 (/noshow0 "at head of WITH-ALIEN")
892 (let ((context (nth-interrupt-context index)))
893 (/noshow0 "got CONTEXT")
894 (when (= (sap-int frame-pointer)
895 (sb!vm:context-register context sb!vm::cfp-offset))
897 (/noshow0 "in WITHOUT-GCING")
898 (let* ((component-ptr (component-ptr-from-pc
899 (sb!vm:context-pc context)))
900 (code (unless (sap= component-ptr (int-sap #x0))
901 (component-from-component-ptr component-ptr))))
902 (/noshow0 "got CODE")
904 (return (values code 0 context)))
905 (let* ((code-header-len (* (get-header-data code)
908 (- (sap-int (sb!vm:context-pc context))
909 (- (get-lisp-obj-address code)
910 sb!vm:other-pointer-lowtag)
912 (/noshow "got PC-OFFSET")
913 (unless (<= 0 pc-offset
914 (* (code-header-ref code sb!vm:code-code-size-slot)
916 ;; We were in an assembly routine. Therefore, use the
919 ;; FIXME: Should this be WARN or ERROR or what?
920 (format t "** pc-offset ~S not in code obj ~S?~%"
922 (/noshow0 "returning from FIND-ESCAPED-FRAME")
924 (values code pc-offset context)))))))))
927 (defun find-escaped-frame (frame-pointer)
928 (declare (type system-area-pointer frame-pointer))
929 (dotimes (index *free-interrupt-context-index* (values nil 0 nil))
930 (let ((scp (nth-interrupt-context index)))
931 (when (= (sap-int frame-pointer)
932 (sb!vm:context-register scp sb!vm::cfp-offset))
934 (let ((code (code-object-from-bits
935 (sb!vm:context-register scp sb!vm::code-offset))))
937 (return (values code 0 scp)))
938 (let* ((code-header-len (* (get-header-data code)
941 (- (sap-int (sb!vm:context-pc scp))
942 (- (get-lisp-obj-address code)
943 sb!vm:other-pointer-lowtag)
945 ;; Check to see whether we were executing in a branch
947 #!+(or pmax sgi) ; pmax only (and broken anyway)
948 (when (logbitp 31 (sb!alien:slot scp '%mips::sc-cause))
949 (incf pc-offset sb!vm:n-word-bytes))
950 (let ((code-size (* (code-header-ref code
951 sb!vm:code-code-size-slot)
952 sb!vm:n-word-bytes)))
953 (unless (<= 0 pc-offset code-size)
954 ;; We were in an assembly routine.
955 (multiple-value-bind (new-pc-offset computed-return)
956 (find-pc-from-assembly-fun code scp)
957 (setf pc-offset new-pc-offset)
958 (unless (<= 0 pc-offset code-size)
960 "Set PC-OFFSET to zero and continue backtrace."
963 "~@<PC-OFFSET (~D) not in code object. Frame details:~
964 ~2I~:@_PC: #X~X~:@_CODE: ~S~:@_CODE FUN: ~S~:@_LRA: ~
965 #X~X~:@_COMPUTED RETURN: #X~X.~:>"
968 (sap-int (sb!vm:context-pc scp))
970 (%code-entry-points code)
971 (sb!vm:context-register scp sb!vm::lra-offset)
973 ;; We failed to pinpoint where PC is, but set
974 ;; pc-offset to 0 to keep the backtrace from
976 (setf pc-offset 0)))))
978 (if (eq (%code-debug-info code) :bogus-lra)
979 (let ((real-lra (code-header-ref code
981 (values (lra-code-header real-lra)
982 (get-header-data real-lra)
984 (values code pc-offset scp))))))))))
987 (defun find-pc-from-assembly-fun (code scp)
988 "Finds the PC for the return from an assembly routine properly.
989 For some architectures (such as PPC) this will not be the $LRA
991 (let ((return-machine-address (sb!vm::return-machine-address scp))
992 (code-header-len (* (get-header-data code) sb!vm:n-word-bytes)))
993 (values (- return-machine-address
994 (- (get-lisp-obj-address code)
995 sb!vm:other-pointer-lowtag)
997 return-machine-address)))
999 ;;; Find the code object corresponding to the object represented by
1000 ;;; bits and return it. We assume bogus functions correspond to the
1001 ;;; undefined-function.
1002 (defun code-object-from-bits (bits)
1003 (declare (type (unsigned-byte 32) bits))
1004 (let ((object (make-lisp-obj bits)))
1005 (if (functionp object)
1006 (or (fun-code-header object)
1007 :undefined-function)
1008 (let ((lowtag (lowtag-of object)))
1009 (if (= lowtag sb!vm:other-pointer-lowtag)
1010 (let ((widetag (widetag-of object)))
1011 (cond ((= widetag sb!vm:code-header-widetag)
1013 ((= widetag sb!vm:return-pc-header-widetag)
1014 (lra-code-header object))
1018 ;;;; frame utilities
1020 ;;; This returns a COMPILED-DEBUG-FUN for COMPONENT and PC. We fetch the
1021 ;;; SB!C::DEBUG-INFO and run down its FUN-MAP to get a
1022 ;;; SB!C::COMPILED-DEBUG-FUN from the PC. The result only needs to
1023 ;;; reference the COMPONENT, for function constants, and the
1024 ;;; SB!C::COMPILED-DEBUG-FUN.
1025 (defun debug-fun-from-pc (component pc)
1026 (let ((info (%code-debug-info component)))
1029 ;; FIXME: It seems that most of these (at least on x86) are
1030 ;; actually assembler routines, and could be named by looking
1031 ;; at the sb-fasl:*assembler-routines*.
1032 (make-bogus-debug-fun "no debug information for frame"))
1033 ((eq info :bogus-lra)
1034 (make-bogus-debug-fun "function end breakpoint"))
1036 (let* ((fun-map (sb!c::compiled-debug-info-fun-map info))
1037 (len (length fun-map)))
1038 (declare (type simple-vector fun-map))
1040 (make-compiled-debug-fun (svref fun-map 0) component)
1043 (>= pc (sb!c::compiled-debug-fun-elsewhere-pc
1044 (svref fun-map 0)))))
1045 (declare (type sb!int:index i))
1048 (< pc (if elsewhere-p
1049 (sb!c::compiled-debug-fun-elsewhere-pc
1050 (svref fun-map (1+ i)))
1051 (svref fun-map i))))
1052 (return (make-compiled-debug-fun
1053 (svref fun-map (1- i))
1057 ;;; This returns a code-location for the COMPILED-DEBUG-FUN,
1058 ;;; DEBUG-FUN, and the pc into its code vector. If we stopped at a
1059 ;;; breakpoint, find the CODE-LOCATION for that breakpoint. Otherwise,
1060 ;;; make an :UNSURE code location, so it can be filled in when we
1061 ;;; figure out what is going on.
1062 (defun code-location-from-pc (debug-fun pc escaped)
1063 (or (and (compiled-debug-fun-p debug-fun)
1065 (let ((data (breakpoint-data
1066 (compiled-debug-fun-component debug-fun)
1068 (when (and data (breakpoint-data-breakpoints data))
1069 (let ((what (breakpoint-what
1070 (first (breakpoint-data-breakpoints data)))))
1071 (when (compiled-code-location-p what)
1073 (make-compiled-code-location pc debug-fun)))
1075 ;;; Return an alist mapping catch tags to CODE-LOCATIONs. These are
1076 ;;; CODE-LOCATIONs at which execution would continue with frame as the
1077 ;;; top frame if someone threw to the corresponding tag.
1078 (defun frame-catches (frame)
1079 (let ((catch (descriptor-sap sb!vm:*current-catch-block*))
1080 (reversed-result nil)
1081 (fp (frame-pointer frame)))
1082 (loop until (zerop (sap-int catch))
1083 finally (return (nreverse reversed-result))
1088 (* sb!vm:catch-block-current-cont-slot
1089 sb!vm:n-word-bytes))
1093 (* sb!vm:catch-block-current-cont-slot
1094 sb!vm:n-word-bytes))))
1096 (lra (stack-ref catch sb!vm:catch-block-entry-pc-slot))
1099 catch (* sb!vm:catch-block-entry-pc-slot
1100 sb!vm:n-word-bytes)))
1103 (stack-ref catch sb!vm:catch-block-current-code-slot))
1105 (component (component-from-component-ptr
1106 (component-ptr-from-pc ra)))
1109 (* (- (1+ (get-header-data lra))
1110 (get-header-data component))
1114 (- (get-lisp-obj-address component)
1115 sb!vm:other-pointer-lowtag)
1116 (* (get-header-data component) sb!vm:n-word-bytes))))
1118 (stack-ref catch sb!vm:catch-block-tag-slot)
1121 (sap-ref-32 catch (* sb!vm:catch-block-tag-slot
1122 sb!vm:n-word-bytes)))
1123 (make-compiled-code-location
1124 offset (frame-debug-fun frame)))
1129 (* sb!vm:catch-block-previous-catch-slot
1130 sb!vm:n-word-bytes))
1134 (* sb!vm:catch-block-previous-catch-slot
1135 sb!vm:n-word-bytes)))))))
1137 ;;;; operations on DEBUG-FUNs
1139 ;;; Execute the forms in a context with BLOCK-VAR bound to each
1140 ;;; DEBUG-BLOCK in DEBUG-FUN successively. Result is an optional
1141 ;;; form to execute for return values, and DO-DEBUG-FUN-BLOCKS
1142 ;;; returns nil if there is no result form. This signals a
1143 ;;; NO-DEBUG-BLOCKS condition when the DEBUG-FUN lacks
1144 ;;; DEBUG-BLOCK information.
1145 (defmacro do-debug-fun-blocks ((block-var debug-fun &optional result)
1147 (let ((blocks (gensym))
1149 `(let ((,blocks (debug-fun-debug-blocks ,debug-fun)))
1150 (declare (simple-vector ,blocks))
1151 (dotimes (,i (length ,blocks) ,result)
1152 (let ((,block-var (svref ,blocks ,i)))
1155 ;;; Execute body in a context with VAR bound to each DEBUG-VAR in
1156 ;;; DEBUG-FUN. This returns the value of executing result (defaults to
1157 ;;; nil). This may iterate over only some of DEBUG-FUN's variables or
1158 ;;; none depending on debug policy; for example, possibly the
1159 ;;; compilation only preserved argument information.
1160 (defmacro do-debug-fun-vars ((var debug-fun &optional result) &body body)
1161 (let ((vars (gensym))
1163 `(let ((,vars (debug-fun-debug-vars ,debug-fun)))
1164 (declare (type (or null simple-vector) ,vars))
1166 (dotimes (,i (length ,vars) ,result)
1167 (let ((,var (svref ,vars ,i)))
1171 ;;; Return the object of type FUNCTION associated with the DEBUG-FUN,
1172 ;;; or NIL if the function is unavailable or is non-existent as a user
1173 ;;; callable function object.
1174 (defun debug-fun-fun (debug-fun)
1175 (let ((cached-value (debug-fun-%function debug-fun)))
1176 (if (eq cached-value :unparsed)
1177 (setf (debug-fun-%function debug-fun)
1178 (etypecase debug-fun
1181 (compiled-debug-fun-component debug-fun))
1183 (sb!c::compiled-debug-fun-start-pc
1184 (compiled-debug-fun-compiler-debug-fun debug-fun))))
1185 (do ((entry (%code-entry-points component)
1186 (%simple-fun-next entry)))
1189 (sb!c::compiled-debug-fun-start-pc
1190 (compiled-debug-fun-compiler-debug-fun
1191 (fun-debug-fun entry))))
1193 (bogus-debug-fun nil)))
1196 ;;; Return the name of the function represented by DEBUG-FUN. This may
1197 ;;; be a string or a cons; do not assume it is a symbol.
1198 (defun debug-fun-name (debug-fun)
1199 (declare (type debug-fun debug-fun))
1200 (etypecase debug-fun
1202 (sb!c::compiled-debug-fun-name
1203 (compiled-debug-fun-compiler-debug-fun debug-fun)))
1205 (bogus-debug-fun-%name debug-fun))))
1207 ;;; Return a DEBUG-FUN that represents debug information for FUN.
1208 (defun fun-debug-fun (fun)
1209 (declare (type function fun))
1210 (ecase (widetag-of fun)
1211 (#.sb!vm:closure-header-widetag
1212 (fun-debug-fun (%closure-fun fun)))
1213 (#.sb!vm:funcallable-instance-header-widetag
1214 (fun-debug-fun (funcallable-instance-fun fun)))
1215 (#.sb!vm:simple-fun-header-widetag
1216 (let* ((name (%simple-fun-name fun))
1217 (component (fun-code-header fun))
1220 (and (sb!c::compiled-debug-fun-p x)
1221 (eq (sb!c::compiled-debug-fun-name x) name)
1222 (eq (sb!c::compiled-debug-fun-kind x) nil)))
1223 (sb!c::compiled-debug-info-fun-map
1224 (%code-debug-info component)))))
1226 (make-compiled-debug-fun res component)
1227 ;; KLUDGE: comment from CMU CL:
1228 ;; This used to be the non-interpreted branch, but
1229 ;; William wrote it to return the debug-fun of fun's XEP
1230 ;; instead of fun's debug-fun. The above code does this
1231 ;; more correctly, but it doesn't get or eliminate all
1232 ;; appropriate cases. It mostly works, and probably
1233 ;; works for all named functions anyway.
1235 (debug-fun-from-pc component
1236 (* (- (fun-word-offset fun)
1237 (get-header-data component))
1238 sb!vm:n-word-bytes)))))))
1240 ;;; Return the kind of the function, which is one of :OPTIONAL,
1241 ;;; :EXTERNAL, :TOPLEVEL, :CLEANUP, or NIL.
1242 (defun debug-fun-kind (debug-fun)
1243 ;; FIXME: This "is one of" information should become part of the function
1244 ;; declamation, not just a doc string
1245 (etypecase debug-fun
1247 (sb!c::compiled-debug-fun-kind
1248 (compiled-debug-fun-compiler-debug-fun debug-fun)))
1252 ;;; Is there any variable information for DEBUG-FUN?
1253 (defun debug-var-info-available (debug-fun)
1254 (not (not (debug-fun-debug-vars debug-fun))))
1256 ;;; Return a list of DEBUG-VARs in DEBUG-FUN having the same name
1257 ;;; and package as SYMBOL. If SYMBOL is uninterned, then this returns
1258 ;;; a list of DEBUG-VARs without package names and with the same name
1259 ;;; as symbol. The result of this function is limited to the
1260 ;;; availability of variable information in DEBUG-FUN; for
1261 ;;; example, possibly DEBUG-FUN only knows about its arguments.
1262 (defun debug-fun-symbol-vars (debug-fun symbol)
1263 (let ((vars (ambiguous-debug-vars debug-fun (symbol-name symbol)))
1264 (package (and (symbol-package symbol)
1265 (package-name (symbol-package symbol)))))
1266 (delete-if (if (stringp package)
1268 (let ((p (debug-var-package-name var)))
1269 (or (not (stringp p))
1270 (string/= p package))))
1272 (stringp (debug-var-package-name var))))
1275 ;;; Return a list of DEBUG-VARs in DEBUG-FUN whose names contain
1276 ;;; NAME-PREFIX-STRING as an initial substring. The result of this
1277 ;;; function is limited to the availability of variable information in
1278 ;;; debug-fun; for example, possibly debug-fun only knows
1279 ;;; about its arguments.
1280 (defun ambiguous-debug-vars (debug-fun name-prefix-string)
1281 (declare (simple-string name-prefix-string))
1282 (let ((variables (debug-fun-debug-vars debug-fun)))
1283 (declare (type (or null simple-vector) variables))
1285 (let* ((len (length variables))
1286 (prefix-len (length name-prefix-string))
1287 (pos (find-var name-prefix-string variables len))
1290 ;; Find names from pos to variable's len that contain prefix.
1291 (do ((i pos (1+ i)))
1293 (let* ((var (svref variables i))
1294 (name (debug-var-symbol-name var))
1295 (name-len (length name)))
1296 (declare (simple-string name))
1297 (when (/= (or (string/= name-prefix-string name
1298 :end1 prefix-len :end2 name-len)
1303 (setq res (nreverse res)))
1306 ;;; This returns a position in VARIABLES for one containing NAME as an
1307 ;;; initial substring. END is the length of VARIABLES if supplied.
1308 (defun find-var (name variables &optional end)
1309 (declare (simple-vector variables)
1310 (simple-string name))
1311 (let ((name-len (length name)))
1312 (position name variables
1314 (let* ((y (debug-var-symbol-name y))
1316 (declare (simple-string y))
1317 (and (>= y-len name-len)
1318 (string= x y :end1 name-len :end2 name-len))))
1319 :end (or end (length variables)))))
1321 ;;; Return a list representing the lambda-list for DEBUG-FUN. The
1322 ;;; list has the following structure:
1323 ;;; (required-var1 required-var2
1325 ;;; (:optional var3 suppliedp-var4)
1326 ;;; (:optional var5)
1328 ;;; (:rest var6) (:rest var7)
1330 ;;; (:keyword keyword-symbol var8 suppliedp-var9)
1331 ;;; (:keyword keyword-symbol var10)
1334 ;;; Each VARi is a DEBUG-VAR; however it may be the symbol :DELETED if
1335 ;;; it is unreferenced in DEBUG-FUN. This signals a
1336 ;;; LAMBDA-LIST-UNAVAILABLE condition when there is no argument list
1338 (defun debug-fun-lambda-list (debug-fun)
1339 (etypecase debug-fun
1340 (compiled-debug-fun (compiled-debug-fun-lambda-list debug-fun))
1341 (bogus-debug-fun nil)))
1343 ;;; Note: If this has to compute the lambda list, it caches it in DEBUG-FUN.
1344 (defun compiled-debug-fun-lambda-list (debug-fun)
1345 (let ((lambda-list (debug-fun-%lambda-list debug-fun)))
1346 (cond ((eq lambda-list :unparsed)
1347 (multiple-value-bind (args argsp)
1348 (parse-compiled-debug-fun-lambda-list debug-fun)
1349 (setf (debug-fun-%lambda-list debug-fun) args)
1352 (debug-signal 'lambda-list-unavailable
1353 :debug-fun debug-fun))))
1355 ((bogus-debug-fun-p debug-fun)
1357 ((sb!c::compiled-debug-fun-arguments
1358 (compiled-debug-fun-compiler-debug-fun debug-fun))
1359 ;; If the packed information is there (whether empty or not) as
1360 ;; opposed to being nil, then returned our cached value (nil).
1363 ;; Our cached value is nil, and the packed lambda-list information
1364 ;; is nil, so we don't have anything available.
1365 (debug-signal 'lambda-list-unavailable
1366 :debug-fun debug-fun)))))
1368 ;;; COMPILED-DEBUG-FUN-LAMBDA-LIST calls this when a
1369 ;;; COMPILED-DEBUG-FUN has no lambda list information cached. It
1370 ;;; returns the lambda list as the first value and whether there was
1371 ;;; any argument information as the second value. Therefore,
1372 ;;; (VALUES NIL T) means there were no arguments, but (VALUES NIL NIL)
1373 ;;; means there was no argument information.
1374 (defun parse-compiled-debug-fun-lambda-list (debug-fun)
1375 (let ((args (sb!c::compiled-debug-fun-arguments
1376 (compiled-debug-fun-compiler-debug-fun debug-fun))))
1381 (values (coerce (debug-fun-debug-vars debug-fun) 'list)
1384 (let ((vars (debug-fun-debug-vars debug-fun))
1389 (declare (type (or null simple-vector) vars))
1391 (when (>= i len) (return))
1392 (let ((ele (aref args i)))
1397 ;; Deleted required arg at beginning of args array.
1398 (push :deleted res))
1399 (sb!c::optional-args
1402 ;; SUPPLIED-P var immediately following keyword or
1403 ;; optional. Stick the extra var in the result
1404 ;; element representing the keyword or optional,
1405 ;; which is the previous one.
1407 (list (compiled-debug-fun-lambda-list-var
1408 args (incf i) vars))))
1411 (compiled-debug-fun-lambda-list-var
1412 args (incf i) vars))
1415 ;; Just ignore the fact that the next two args are
1416 ;; the &MORE arg context and count, and act like they
1417 ;; are regular arguments.
1421 (push (list :keyword
1423 (compiled-debug-fun-lambda-list-var
1424 args (incf i) vars))
1427 ;; We saw an optional marker, so the following
1428 ;; non-symbols are indexes indicating optional
1430 (push (list :optional (svref vars ele)) res))
1432 ;; Required arg at beginning of args array.
1433 (push (svref vars ele) res))))
1435 (values (nreverse res) t))))))
1437 ;;; This is used in COMPILED-DEBUG-FUN-LAMBDA-LIST.
1438 (defun compiled-debug-fun-lambda-list-var (args i vars)
1439 (declare (type (simple-array * (*)) args)
1440 (simple-vector vars))
1441 (let ((ele (aref args i)))
1442 (cond ((not (symbolp ele)) (svref vars ele))
1443 ((eq ele 'sb!c::deleted) :deleted)
1444 (t (error "malformed arguments description")))))
1446 (defun compiled-debug-fun-debug-info (debug-fun)
1447 (%code-debug-info (compiled-debug-fun-component debug-fun)))
1449 ;;;; unpacking variable and basic block data
1451 (defvar *parsing-buffer*
1452 (make-array 20 :adjustable t :fill-pointer t))
1453 (defvar *other-parsing-buffer*
1454 (make-array 20 :adjustable t :fill-pointer t))
1455 ;;; PARSE-DEBUG-BLOCKS and PARSE-DEBUG-VARS
1456 ;;; use this to unpack binary encoded information. It returns the
1457 ;;; values returned by the last form in body.
1459 ;;; This binds buffer-var to *parsing-buffer*, makes sure it starts at
1460 ;;; element zero, and makes sure if we unwind, we nil out any set
1461 ;;; elements for GC purposes.
1463 ;;; This also binds other-var to *other-parsing-buffer* when it is
1464 ;;; supplied, making sure it starts at element zero and that we nil
1465 ;;; out any elements if we unwind.
1467 ;;; This defines the local macro RESULT that takes a buffer, copies
1468 ;;; its elements to a resulting simple-vector, nil's out elements, and
1469 ;;; restarts the buffer at element zero. RESULT returns the
1471 (eval-when (:compile-toplevel :execute)
1472 (sb!xc:defmacro with-parsing-buffer ((buffer-var &optional other-var)
1474 (let ((len (gensym))
1477 (let ((,buffer-var *parsing-buffer*)
1478 ,@(if other-var `((,other-var *other-parsing-buffer*))))
1479 (setf (fill-pointer ,buffer-var) 0)
1480 ,@(if other-var `((setf (fill-pointer ,other-var) 0)))
1481 (macrolet ((result (buf)
1482 `(let* ((,',len (length ,buf))
1483 (,',res (make-array ,',len)))
1484 (replace ,',res ,buf :end1 ,',len :end2 ,',len)
1485 (fill ,buf nil :end ,',len)
1486 (setf (fill-pointer ,buf) 0)
1489 (fill *parsing-buffer* nil)
1490 ,@(if other-var `((fill *other-parsing-buffer* nil))))))
1493 ;;; The argument is a debug internals structure. This returns the
1494 ;;; DEBUG-BLOCKs for DEBUG-FUN, regardless of whether we have unpacked
1495 ;;; them yet. It signals a NO-DEBUG-BLOCKS condition if it can't
1496 ;;; return the blocks.
1497 (defun debug-fun-debug-blocks (debug-fun)
1498 (let ((blocks (debug-fun-blocks debug-fun)))
1499 (cond ((eq blocks :unparsed)
1500 (setf (debug-fun-blocks debug-fun)
1501 (parse-debug-blocks debug-fun))
1502 (unless (debug-fun-blocks debug-fun)
1503 (debug-signal 'no-debug-blocks
1504 :debug-fun debug-fun))
1505 (debug-fun-blocks debug-fun))
1508 (debug-signal 'no-debug-blocks
1509 :debug-fun debug-fun)))))
1511 ;;; Return a SIMPLE-VECTOR of DEBUG-BLOCKs or NIL. NIL indicates there
1512 ;;; was no basic block information.
1513 (defun parse-debug-blocks (debug-fun)
1514 (etypecase debug-fun
1516 (parse-compiled-debug-blocks debug-fun))
1518 (debug-signal 'no-debug-blocks :debug-fun debug-fun))))
1520 ;;; This does some of the work of PARSE-DEBUG-BLOCKS.
1521 (defun parse-compiled-debug-blocks (debug-fun)
1522 (let* ((var-count (length (debug-fun-debug-vars debug-fun)))
1523 (compiler-debug-fun (compiled-debug-fun-compiler-debug-fun
1525 (blocks (sb!c::compiled-debug-fun-blocks compiler-debug-fun))
1526 ;; KLUDGE: 8 is a hard-wired constant in the compiler for the
1527 ;; element size of the packed binary representation of the
1529 (live-set-len (ceiling var-count 8))
1530 (tlf-number (sb!c::compiled-debug-fun-tlf-number compiler-debug-fun)))
1532 (return-from parse-compiled-debug-blocks nil))
1533 (macrolet ((aref+ (a i) `(prog1 (aref ,a ,i) (incf ,i))))
1534 (with-parsing-buffer (blocks-buffer locations-buffer)
1536 (len (length blocks))
1539 (when (>= i len) (return))
1540 (let ((succ-and-flags (aref+ blocks i))
1542 (declare (type (unsigned-byte 8) succ-and-flags)
1544 (dotimes (k (ldb sb!c::compiled-debug-block-nsucc-byte
1546 (push (sb!c:read-var-integer blocks i) successors))
1548 (dotimes (k (sb!c:read-var-integer blocks i)
1549 (result locations-buffer))
1550 (let ((kind (svref sb!c::*compiled-code-location-kinds*
1553 (sb!c:read-var-integer blocks i)))
1554 (tlf-offset (or tlf-number
1555 (sb!c:read-var-integer blocks i)))
1556 (form-number (sb!c:read-var-integer blocks i))
1557 (live-set (sb!c:read-packed-bit-vector
1558 live-set-len blocks i)))
1559 (vector-push-extend (make-known-code-location
1560 pc debug-fun tlf-offset
1561 form-number live-set kind)
1563 (setf last-pc pc))))
1564 (block (make-compiled-debug-block
1565 locations successors
1567 sb!c::compiled-debug-block-elsewhere-p
1568 succ-and-flags))))))
1569 (vector-push-extend block blocks-buffer)
1570 (dotimes (k (length locations))
1571 (setf (code-location-%debug-block (svref locations k))
1573 (let ((res (result blocks-buffer)))
1574 (declare (simple-vector res))
1575 (dotimes (i (length res))
1576 (let* ((block (svref res i))
1578 (dolist (ele (debug-block-successors block))
1579 (push (svref res ele) succs))
1580 (setf (debug-block-successors block) succs)))
1583 ;;; The argument is a debug internals structure. This returns NIL if
1584 ;;; there is no variable information. It returns an empty
1585 ;;; simple-vector if there were no locals in the function. Otherwise
1586 ;;; it returns a SIMPLE-VECTOR of DEBUG-VARs.
1587 (defun debug-fun-debug-vars (debug-fun)
1588 (let ((vars (debug-fun-%debug-vars debug-fun)))
1589 (if (eq vars :unparsed)
1590 (setf (debug-fun-%debug-vars debug-fun)
1591 (etypecase debug-fun
1593 (parse-compiled-debug-vars debug-fun))
1594 (bogus-debug-fun nil)))
1597 ;;; VARS is the parsed variables for a minimal debug function. We need
1598 ;;; to assign names of the form ARG-NNN. We must pad with leading
1599 ;;; zeros, since the arguments must be in alphabetical order.
1600 (defun assign-minimal-var-names (vars)
1601 (declare (simple-vector vars))
1602 (let* ((len (length vars))
1603 (width (length (format nil "~W" (1- len)))))
1605 (without-package-locks
1606 (setf (compiled-debug-var-symbol (svref vars i))
1607 (intern (format nil "ARG-~V,'0D" width i)
1608 ;; KLUDGE: It's somewhat nasty to have a bare
1609 ;; package name string here. It would be
1610 ;; nicer to have #.(FIND-PACKAGE "SB!DEBUG")
1611 ;; instead, since then at least it would transform
1612 ;; correctly under package renaming and stuff.
1613 ;; However, genesis can't handle dumped packages..
1616 ;; FIXME: Maybe this could be fixed by moving the
1617 ;; whole debug-int.lisp file to warm init? (after
1618 ;; which dumping a #.(FIND-PACKAGE ..) expression
1619 ;; would work fine) If this is possible, it would
1620 ;; probably be a good thing, since minimizing the
1621 ;; amount of stuff in cold init is basically good.
1622 (or (find-package "SB-DEBUG")
1623 (find-package "SB!DEBUG"))))))))
1625 ;;; Parse the packed representation of DEBUG-VARs from
1626 ;;; DEBUG-FUN's SB!C::COMPILED-DEBUG-FUN, returning a vector
1627 ;;; of DEBUG-VARs, or NIL if there was no information to parse.
1628 (defun parse-compiled-debug-vars (debug-fun)
1629 (let* ((cdebug-fun (compiled-debug-fun-compiler-debug-fun
1631 (packed-vars (sb!c::compiled-debug-fun-vars cdebug-fun))
1632 (args-minimal (eq (sb!c::compiled-debug-fun-arguments cdebug-fun)
1636 (buffer (make-array 0 :fill-pointer 0 :adjustable t)))
1637 ((>= i (length packed-vars))
1638 (let ((result (coerce buffer 'simple-vector)))
1640 (assign-minimal-var-names result))
1642 (flet ((geti () (prog1 (aref packed-vars i) (incf i))))
1643 (let* ((flags (geti))
1644 (minimal (logtest sb!c::compiled-debug-var-minimal-p flags))
1645 (deleted (logtest sb!c::compiled-debug-var-deleted-p flags))
1646 (live (logtest sb!c::compiled-debug-var-environment-live
1648 (save (logtest sb!c::compiled-debug-var-save-loc-p flags))
1649 (symbol (if minimal nil (geti)))
1650 (id (if (logtest sb!c::compiled-debug-var-id-p flags)
1653 (sc-offset (if deleted 0 (geti)))
1654 (save-sc-offset (if save (geti) nil)))
1655 (aver (not (and args-minimal (not minimal))))
1656 (vector-push-extend (make-compiled-debug-var symbol
1665 ;;; If we're sure of whether code-location is known, return T or NIL.
1666 ;;; If we're :UNSURE, then try to fill in the code-location's slots.
1667 ;;; This determines whether there is any debug-block information, and
1668 ;;; if code-location is known.
1670 ;;; ??? IF this conses closures every time it's called, then break off the
1671 ;;; :UNSURE part to get the HANDLER-CASE into another function.
1672 (defun code-location-unknown-p (basic-code-location)
1673 (ecase (code-location-%unknown-p basic-code-location)
1677 (setf (code-location-%unknown-p basic-code-location)
1678 (handler-case (not (fill-in-code-location basic-code-location))
1679 (no-debug-blocks () t))))))
1681 ;;; Return the DEBUG-BLOCK containing code-location if it is available.
1682 ;;; Some debug policies inhibit debug-block information, and if none
1683 ;;; is available, then this signals a NO-DEBUG-BLOCKS condition.
1684 (defun code-location-debug-block (basic-code-location)
1685 (let ((block (code-location-%debug-block basic-code-location)))
1686 (if (eq block :unparsed)
1687 (etypecase basic-code-location
1688 (compiled-code-location
1689 (compute-compiled-code-location-debug-block basic-code-location))
1690 ;; (There used to be more cases back before sbcl-0.7.0, when
1691 ;; we did special tricks to debug the IR1 interpreter.)
1695 ;;; Store and return BASIC-CODE-LOCATION's debug-block. We determines
1696 ;;; the correct one using the code-location's pc. We use
1697 ;;; DEBUG-FUN-DEBUG-BLOCKS to return the cached block information
1698 ;;; or signal a NO-DEBUG-BLOCKS condition. The blocks are sorted by
1699 ;;; their first code-location's pc, in ascending order. Therefore, as
1700 ;;; soon as we find a block that starts with a pc greater than
1701 ;;; basic-code-location's pc, we know the previous block contains the
1702 ;;; pc. If we get to the last block, then the code-location is either
1703 ;;; in the second to last block or the last block, and we have to be
1704 ;;; careful in determining this since the last block could be code at
1705 ;;; the end of the function. We have to check for the last block being
1706 ;;; code first in order to see how to compare the code-location's pc.
1707 (defun compute-compiled-code-location-debug-block (basic-code-location)
1708 (let* ((pc (compiled-code-location-pc basic-code-location))
1709 (debug-fun (code-location-debug-fun
1710 basic-code-location))
1711 (blocks (debug-fun-debug-blocks debug-fun))
1712 (len (length blocks)))
1713 (declare (simple-vector blocks))
1714 (setf (code-location-%debug-block basic-code-location)
1720 (let ((last (svref blocks end)))
1722 ((debug-block-elsewhere-p last)
1724 (sb!c::compiled-debug-fun-elsewhere-pc
1725 (compiled-debug-fun-compiler-debug-fun
1727 (svref blocks (1- end))
1730 (compiled-code-location-pc
1731 (svref (compiled-debug-block-code-locations last)
1733 (svref blocks (1- end)))
1735 (declare (type index i end))
1737 (compiled-code-location-pc
1738 (svref (compiled-debug-block-code-locations
1741 (return (svref blocks (1- i)))))))))
1743 ;;; Return the CODE-LOCATION's DEBUG-SOURCE.
1744 (defun code-location-debug-source (code-location)
1745 (etypecase code-location
1746 (compiled-code-location
1747 (let* ((info (compiled-debug-fun-debug-info
1748 (code-location-debug-fun code-location)))
1749 (sources (sb!c::compiled-debug-info-source info))
1750 (len (length sources)))
1751 (declare (list sources))
1753 (debug-signal 'no-debug-blocks :debug-fun
1754 (code-location-debug-fun code-location)))
1757 (do ((prev sources src)
1758 (src (cdr sources) (cdr src))
1759 (offset (code-location-toplevel-form-offset code-location)))
1760 ((null src) (car prev))
1761 (when (< offset (sb!c::debug-source-source-root (car src)))
1762 (return (car prev)))))))
1763 ;; (There used to be more cases back before sbcl-0.7.0, when we
1764 ;; did special tricks to debug the IR1 interpreter.)
1767 ;;; Returns the number of top level forms before the one containing
1768 ;;; CODE-LOCATION as seen by the compiler in some compilation unit. (A
1769 ;;; compilation unit is not necessarily a single file, see the section
1770 ;;; on debug-sources.)
1771 (defun code-location-toplevel-form-offset (code-location)
1772 (when (code-location-unknown-p code-location)
1773 (error 'unknown-code-location :code-location code-location))
1774 (let ((tlf-offset (code-location-%tlf-offset code-location)))
1775 (cond ((eq tlf-offset :unparsed)
1776 (etypecase code-location
1777 (compiled-code-location
1778 (unless (fill-in-code-location code-location)
1779 ;; This check should be unnecessary. We're missing
1780 ;; debug info the compiler should have dumped.
1781 (bug "unknown code location"))
1782 (code-location-%tlf-offset code-location))
1783 ;; (There used to be more cases back before sbcl-0.7.0,,
1784 ;; when we did special tricks to debug the IR1
1789 ;;; Return the number of the form corresponding to CODE-LOCATION. The
1790 ;;; form number is derived by a walking the subforms of a top level
1791 ;;; form in depth-first order.
1792 (defun code-location-form-number (code-location)
1793 (when (code-location-unknown-p code-location)
1794 (error 'unknown-code-location :code-location code-location))
1795 (let ((form-num (code-location-%form-number code-location)))
1796 (cond ((eq form-num :unparsed)
1797 (etypecase code-location
1798 (compiled-code-location
1799 (unless (fill-in-code-location code-location)
1800 ;; This check should be unnecessary. We're missing
1801 ;; debug info the compiler should have dumped.
1802 (bug "unknown code location"))
1803 (code-location-%form-number code-location))
1804 ;; (There used to be more cases back before sbcl-0.7.0,,
1805 ;; when we did special tricks to debug the IR1
1810 ;;; Return the kind of CODE-LOCATION, one of:
1811 ;;; :INTERPRETED, :UNKNOWN-RETURN, :KNOWN-RETURN, :INTERNAL-ERROR,
1812 ;;; :NON-LOCAL-EXIT, :BLOCK-START, :CALL-SITE, :SINGLE-VALUE-RETURN,
1813 ;;; :NON-LOCAL-ENTRY
1814 (defun code-location-kind (code-location)
1815 (when (code-location-unknown-p code-location)
1816 (error 'unknown-code-location :code-location code-location))
1817 (etypecase code-location
1818 (compiled-code-location
1819 (let ((kind (compiled-code-location-kind code-location)))
1820 (cond ((not (eq kind :unparsed)) kind)
1821 ((not (fill-in-code-location code-location))
1822 ;; This check should be unnecessary. We're missing
1823 ;; debug info the compiler should have dumped.
1824 (bug "unknown code location"))
1826 (compiled-code-location-kind code-location)))))
1827 ;; (There used to be more cases back before sbcl-0.7.0,,
1828 ;; when we did special tricks to debug the IR1
1832 ;;; This returns CODE-LOCATION's live-set if it is available. If
1833 ;;; there is no debug-block information, this returns NIL.
1834 (defun compiled-code-location-live-set (code-location)
1835 (if (code-location-unknown-p code-location)
1837 (let ((live-set (compiled-code-location-%live-set code-location)))
1838 (cond ((eq live-set :unparsed)
1839 (unless (fill-in-code-location code-location)
1840 ;; This check should be unnecessary. We're missing
1841 ;; debug info the compiler should have dumped.
1843 ;; FIXME: This error and comment happen over and over again.
1844 ;; Make them a shared function.
1845 (bug "unknown code location"))
1846 (compiled-code-location-%live-set code-location))
1849 ;;; true if OBJ1 and OBJ2 are the same place in the code
1850 (defun code-location= (obj1 obj2)
1852 (compiled-code-location
1854 (compiled-code-location
1855 (and (eq (code-location-debug-fun obj1)
1856 (code-location-debug-fun obj2))
1857 (sub-compiled-code-location= obj1 obj2)))
1858 ;; (There used to be more cases back before sbcl-0.7.0,,
1859 ;; when we did special tricks to debug the IR1
1862 ;; (There used to be more cases back before sbcl-0.7.0,,
1863 ;; when we did special tricks to debug IR1-interpreted code.)
1865 (defun sub-compiled-code-location= (obj1 obj2)
1866 (= (compiled-code-location-pc obj1)
1867 (compiled-code-location-pc obj2)))
1869 ;;; Fill in CODE-LOCATION's :UNPARSED slots, returning T or NIL
1870 ;;; depending on whether the code-location was known in its
1871 ;;; DEBUG-FUN's debug-block information. This may signal a
1872 ;;; NO-DEBUG-BLOCKS condition due to DEBUG-FUN-DEBUG-BLOCKS, and
1873 ;;; it assumes the %UNKNOWN-P slot is already set or going to be set.
1874 (defun fill-in-code-location (code-location)
1875 (declare (type compiled-code-location code-location))
1876 (let* ((debug-fun (code-location-debug-fun code-location))
1877 (blocks (debug-fun-debug-blocks debug-fun)))
1878 (declare (simple-vector blocks))
1879 (dotimes (i (length blocks) nil)
1880 (let* ((block (svref blocks i))
1881 (locations (compiled-debug-block-code-locations block)))
1882 (declare (simple-vector locations))
1883 (dotimes (j (length locations))
1884 (let ((loc (svref locations j)))
1885 (when (sub-compiled-code-location= code-location loc)
1886 (setf (code-location-%debug-block code-location) block)
1887 (setf (code-location-%tlf-offset code-location)
1888 (code-location-%tlf-offset loc))
1889 (setf (code-location-%form-number code-location)
1890 (code-location-%form-number loc))
1891 (setf (compiled-code-location-%live-set code-location)
1892 (compiled-code-location-%live-set loc))
1893 (setf (compiled-code-location-kind code-location)
1894 (compiled-code-location-kind loc))
1895 (return-from fill-in-code-location t))))))))
1897 ;;;; operations on DEBUG-BLOCKs
1899 ;;; Execute FORMS in a context with CODE-VAR bound to each
1900 ;;; CODE-LOCATION in DEBUG-BLOCK, and return the value of RESULT.
1901 (defmacro do-debug-block-locations ((code-var debug-block &optional result)
1903 (let ((code-locations (gensym))
1905 `(let ((,code-locations (debug-block-code-locations ,debug-block)))
1906 (declare (simple-vector ,code-locations))
1907 (dotimes (,i (length ,code-locations) ,result)
1908 (let ((,code-var (svref ,code-locations ,i)))
1911 ;;; Return the name of the function represented by DEBUG-FUN.
1912 ;;; This may be a string or a cons; do not assume it is a symbol.
1913 (defun debug-block-fun-name (debug-block)
1914 (etypecase debug-block
1915 (compiled-debug-block
1916 (let ((code-locs (compiled-debug-block-code-locations debug-block)))
1917 (declare (simple-vector code-locs))
1918 (if (zerop (length code-locs))
1919 "??? Can't get name of debug-block's function."
1921 (code-location-debug-fun (svref code-locs 0))))))
1922 ;; (There used to be more cases back before sbcl-0.7.0, when we
1923 ;; did special tricks to debug the IR1 interpreter.)
1926 (defun debug-block-code-locations (debug-block)
1927 (etypecase debug-block
1928 (compiled-debug-block
1929 (compiled-debug-block-code-locations debug-block))
1930 ;; (There used to be more cases back before sbcl-0.7.0, when we
1931 ;; did special tricks to debug the IR1 interpreter.)
1934 ;;;; operations on debug variables
1936 (defun debug-var-symbol-name (debug-var)
1937 (symbol-name (debug-var-symbol debug-var)))
1939 ;;; FIXME: Make sure that this isn't called anywhere that it wouldn't
1940 ;;; be acceptable to have NIL returned, or that it's only called on
1941 ;;; DEBUG-VARs whose symbols have non-NIL packages.
1942 (defun debug-var-package-name (debug-var)
1943 (package-name (symbol-package (debug-var-symbol debug-var))))
1945 ;;; Return the value stored for DEBUG-VAR in frame, or if the value is
1946 ;;; not :VALID, then signal an INVALID-VALUE error.
1947 (defun debug-var-valid-value (debug-var frame)
1948 (unless (eq (debug-var-validity debug-var (frame-code-location frame))
1950 (error 'invalid-value :debug-var debug-var :frame frame))
1951 (debug-var-value debug-var frame))
1953 ;;; Returns the value stored for DEBUG-VAR in frame. The value may be
1954 ;;; invalid. This is SETFable.
1955 (defun debug-var-value (debug-var frame)
1956 (aver (typep frame 'compiled-frame))
1957 (let ((res (access-compiled-debug-var-slot debug-var frame)))
1958 (if (indirect-value-cell-p res)
1959 (value-cell-ref res)
1962 ;;; This returns what is stored for the variable represented by
1963 ;;; DEBUG-VAR relative to the FRAME. This may be an indirect value
1964 ;;; cell if the variable is both closed over and set.
1965 (defun access-compiled-debug-var-slot (debug-var frame)
1966 (declare (optimize (speed 1)))
1967 (let ((escaped (compiled-frame-escaped frame)))
1969 (sub-access-debug-var-slot
1970 (frame-pointer frame)
1971 (compiled-debug-var-sc-offset debug-var)
1973 (sub-access-debug-var-slot
1974 (frame-pointer frame)
1975 (or (compiled-debug-var-save-sc-offset debug-var)
1976 (compiled-debug-var-sc-offset debug-var))))))
1978 ;;; a helper function for working with possibly-invalid values:
1979 ;;; Do (MAKE-LISP-OBJ VAL) only if the value looks valid.
1981 ;;; (Such values can arise in registers on machines with conservative
1982 ;;; GC, and might also arise in debug variable locations when
1983 ;;; those variables are invalid.)
1984 (defun make-valid-lisp-obj (val)
1987 (zerop (logand val 3))
1989 (and (zerop (logand val #xffff0000)) ; Top bits zero
1990 (= (logand val #xff) sb!vm:character-widetag)) ; char tag
1992 (= val sb!vm:unbound-marker-widetag)
1995 ;; Check that the pointer is valid. XXX Could do a better
1996 ;; job. FIXME: e.g. by calling out to an is_valid_pointer
1997 ;; routine in the C runtime support code
1998 (or (< sb!vm:read-only-space-start val
1999 (* sb!vm:*read-only-space-free-pointer*
2000 sb!vm:n-word-bytes))
2001 (< sb!vm:static-space-start val
2002 (* sb!vm:*static-space-free-pointer*
2003 sb!vm:n-word-bytes))
2004 (< sb!vm:dynamic-space-start val
2005 (sap-int (dynamic-space-free-pointer))))))
2010 (defun sub-access-debug-var-slot (fp sc-offset &optional escaped)
2011 (macrolet ((with-escaped-value ((var) &body forms)
2013 (let ((,var (sb!vm:context-register
2015 (sb!c:sc-offset-offset sc-offset))))
2017 :invalid-value-for-unescaped-register-storage))
2018 (escaped-float-value (format)
2020 (sb!vm:context-float-register
2022 (sb!c:sc-offset-offset sc-offset)
2024 :invalid-value-for-unescaped-register-storage))
2025 (with-nfp ((var) &body body)
2026 `(let ((,var (if escaped
2028 (sb!vm:context-register escaped
2031 (sb!sys:sap-ref-sap fp (* nfp-save-offset
2032 sb!vm:n-word-bytes))
2034 (sb!vm::make-number-stack-pointer
2035 (sb!sys:sap-ref-32 fp (* nfp-save-offset
2036 sb!vm:n-word-bytes))))))
2038 (ecase (sb!c:sc-offset-scn sc-offset)
2039 ((#.sb!vm:any-reg-sc-number
2040 #.sb!vm:descriptor-reg-sc-number
2041 #!+rt #.sb!vm:word-pointer-reg-sc-number)
2042 (sb!sys:without-gcing
2043 (with-escaped-value (val) (sb!kernel:make-lisp-obj val))))
2045 (#.sb!vm:character-reg-sc-number
2046 (with-escaped-value (val)
2048 (#.sb!vm:sap-reg-sc-number
2049 (with-escaped-value (val)
2050 (sb!sys:int-sap val)))
2051 (#.sb!vm:signed-reg-sc-number
2052 (with-escaped-value (val)
2053 (if (logbitp (1- sb!vm:n-word-bits) val)
2054 (logior val (ash -1 sb!vm:n-word-bits))
2056 (#.sb!vm:unsigned-reg-sc-number
2057 (with-escaped-value (val)
2059 (#.sb!vm:non-descriptor-reg-sc-number
2060 (error "Local non-descriptor register access?"))
2061 (#.sb!vm:interior-reg-sc-number
2062 (error "Local interior register access?"))
2063 (#.sb!vm:single-reg-sc-number
2064 (escaped-float-value single-float))
2065 (#.sb!vm:double-reg-sc-number
2066 (escaped-float-value double-float))
2068 (#.sb!vm:long-reg-sc-number
2069 (escaped-float-value long-float))
2070 (#.sb!vm:complex-single-reg-sc-number
2073 (sb!vm:context-float-register
2074 escaped (sb!c:sc-offset-offset sc-offset) 'single-float)
2075 (sb!vm:context-float-register
2076 escaped (1+ (sb!c:sc-offset-offset sc-offset)) 'single-float))
2077 :invalid-value-for-unescaped-register-storage))
2078 (#.sb!vm:complex-double-reg-sc-number
2081 (sb!vm:context-float-register
2082 escaped (sb!c:sc-offset-offset sc-offset) 'double-float)
2083 (sb!vm:context-float-register
2084 escaped (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 2 #!-sparc 1)
2086 :invalid-value-for-unescaped-register-storage))
2088 (#.sb!vm:complex-long-reg-sc-number
2091 (sb!vm:context-float-register
2092 escaped (sb!c:sc-offset-offset sc-offset) 'long-float)
2093 (sb!vm:context-float-register
2094 escaped (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 4)
2096 :invalid-value-for-unescaped-register-storage))
2097 (#.sb!vm:single-stack-sc-number
2099 (sb!sys:sap-ref-single nfp (* (sb!c:sc-offset-offset sc-offset)
2100 sb!vm:n-word-bytes))))
2101 (#.sb!vm:double-stack-sc-number
2103 (sb!sys:sap-ref-double nfp (* (sb!c:sc-offset-offset sc-offset)
2104 sb!vm:n-word-bytes))))
2106 (#.sb!vm:long-stack-sc-number
2108 (sb!sys:sap-ref-long nfp (* (sb!c:sc-offset-offset sc-offset)
2109 sb!vm:n-word-bytes))))
2110 (#.sb!vm:complex-single-stack-sc-number
2113 (sb!sys:sap-ref-single nfp (* (sb!c:sc-offset-offset sc-offset)
2114 sb!vm:n-word-bytes))
2115 (sb!sys:sap-ref-single nfp (* (1+ (sb!c:sc-offset-offset sc-offset))
2116 sb!vm:n-word-bytes)))))
2117 (#.sb!vm:complex-double-stack-sc-number
2120 (sb!sys:sap-ref-double nfp (* (sb!c:sc-offset-offset sc-offset)
2121 sb!vm:n-word-bytes))
2122 (sb!sys:sap-ref-double nfp (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2123 sb!vm:n-word-bytes)))))
2125 (#.sb!vm:complex-long-stack-sc-number
2128 (sb!sys:sap-ref-long nfp (* (sb!c:sc-offset-offset sc-offset)
2129 sb!vm:n-word-bytes))
2130 (sb!sys:sap-ref-long nfp (* (+ (sb!c:sc-offset-offset sc-offset)
2132 sb!vm:n-word-bytes)))))
2133 (#.sb!vm:control-stack-sc-number
2134 (sb!kernel:stack-ref fp (sb!c:sc-offset-offset sc-offset)))
2135 (#.sb!vm:character-stack-sc-number
2137 (code-char (sb!sys:sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2138 sb!vm:n-word-bytes)))))
2139 (#.sb!vm:unsigned-stack-sc-number
2141 (sb!sys:sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2142 sb!vm:n-word-bytes))))
2143 (#.sb!vm:signed-stack-sc-number
2145 (sb!sys:signed-sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2146 sb!vm:n-word-bytes))))
2147 (#.sb!vm:sap-stack-sc-number
2149 (sb!sys:sap-ref-sap nfp (* (sb!c:sc-offset-offset sc-offset)
2150 sb!vm:n-word-bytes)))))))
2153 (defun sub-access-debug-var-slot (fp sc-offset &optional escaped)
2154 (declare (type system-area-pointer fp))
2155 (macrolet ((with-escaped-value ((var) &body forms)
2157 (let ((,var (sb!vm:context-register
2159 (sb!c:sc-offset-offset sc-offset))))
2161 :invalid-value-for-unescaped-register-storage))
2162 (escaped-float-value (format)
2164 (sb!vm:context-float-register
2165 escaped (sb!c:sc-offset-offset sc-offset) ',format)
2166 :invalid-value-for-unescaped-register-storage))
2167 (escaped-complex-float-value (format)
2170 (sb!vm:context-float-register
2171 escaped (sb!c:sc-offset-offset sc-offset) ',format)
2172 (sb!vm:context-float-register
2173 escaped (1+ (sb!c:sc-offset-offset sc-offset)) ',format))
2174 :invalid-value-for-unescaped-register-storage)))
2175 (ecase (sb!c:sc-offset-scn sc-offset)
2176 ((#.sb!vm:any-reg-sc-number #.sb!vm:descriptor-reg-sc-number)
2178 (with-escaped-value (val)
2179 (make-valid-lisp-obj val))))
2180 (#.sb!vm:character-reg-sc-number
2181 (with-escaped-value (val)
2183 (#.sb!vm:sap-reg-sc-number
2184 (with-escaped-value (val)
2186 (#.sb!vm:signed-reg-sc-number
2187 (with-escaped-value (val)
2188 (if (logbitp (1- sb!vm:n-word-bits) val)
2189 (logior val (ash -1 sb!vm:n-word-bits))
2191 (#.sb!vm:unsigned-reg-sc-number
2192 (with-escaped-value (val)
2194 (#.sb!vm:single-reg-sc-number
2195 (escaped-float-value single-float))
2196 (#.sb!vm:double-reg-sc-number
2197 (escaped-float-value double-float))
2199 (#.sb!vm:long-reg-sc-number
2200 (escaped-float-value long-float))
2201 (#.sb!vm:complex-single-reg-sc-number
2202 (escaped-complex-float-value single-float))
2203 (#.sb!vm:complex-double-reg-sc-number
2204 (escaped-complex-float-value double-float))
2206 (#.sb!vm:complex-long-reg-sc-number
2207 (escaped-complex-float-value long-float))
2208 (#.sb!vm:single-stack-sc-number
2209 (sap-ref-single fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2210 sb!vm:n-word-bytes))))
2211 (#.sb!vm:double-stack-sc-number
2212 (sap-ref-double fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2213 sb!vm:n-word-bytes))))
2215 (#.sb!vm:long-stack-sc-number
2216 (sap-ref-long fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2217 sb!vm:n-word-bytes))))
2218 (#.sb!vm:complex-single-stack-sc-number
2220 (sap-ref-single fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2221 sb!vm:n-word-bytes)))
2222 (sap-ref-single fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2223 sb!vm:n-word-bytes)))))
2224 (#.sb!vm:complex-double-stack-sc-number
2226 (sap-ref-double fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2227 sb!vm:n-word-bytes)))
2228 (sap-ref-double fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 4)
2229 sb!vm:n-word-bytes)))))
2231 (#.sb!vm:complex-long-stack-sc-number
2233 (sap-ref-long fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2234 sb!vm:n-word-bytes)))
2235 (sap-ref-long fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 6)
2236 sb!vm:n-word-bytes)))))
2237 (#.sb!vm:control-stack-sc-number
2238 (stack-ref fp (sb!c:sc-offset-offset sc-offset)))
2239 (#.sb!vm:character-stack-sc-number
2241 (sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2242 sb!vm:n-word-bytes)))))
2243 (#.sb!vm:unsigned-stack-sc-number
2244 (sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2245 sb!vm:n-word-bytes))))
2246 (#.sb!vm:signed-stack-sc-number
2247 (signed-sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2248 sb!vm:n-word-bytes))))
2249 (#.sb!vm:sap-stack-sc-number
2250 (sap-ref-sap fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2251 sb!vm:n-word-bytes)))))))
2253 ;;; This stores value as the value of DEBUG-VAR in FRAME. In the
2254 ;;; COMPILED-DEBUG-VAR case, access the current value to determine if
2255 ;;; it is an indirect value cell. This occurs when the variable is
2256 ;;; both closed over and set.
2257 (defun %set-debug-var-value (debug-var frame new-value)
2258 (aver (typep frame 'compiled-frame))
2259 (let ((old-value (access-compiled-debug-var-slot debug-var frame)))
2260 (if (indirect-value-cell-p old-value)
2261 (value-cell-set old-value new-value)
2262 (set-compiled-debug-var-slot debug-var frame new-value)))
2265 ;;; This stores VALUE for the variable represented by debug-var
2266 ;;; relative to the frame. This assumes the location directly contains
2267 ;;; the variable's value; that is, there is no indirect value cell
2268 ;;; currently there in case the variable is both closed over and set.
2269 (defun set-compiled-debug-var-slot (debug-var frame value)
2270 (let ((escaped (compiled-frame-escaped frame)))
2272 (sub-set-debug-var-slot (frame-pointer frame)
2273 (compiled-debug-var-sc-offset debug-var)
2275 (sub-set-debug-var-slot
2276 (frame-pointer frame)
2277 (or (compiled-debug-var-save-sc-offset debug-var)
2278 (compiled-debug-var-sc-offset debug-var))
2282 (defun sub-set-debug-var-slot (fp sc-offset value &optional escaped)
2283 (macrolet ((set-escaped-value (val)
2285 (setf (sb!vm:context-register
2287 (sb!c:sc-offset-offset sc-offset))
2290 (set-escaped-float-value (format val)
2292 (setf (sb!vm:context-float-register
2294 (sb!c:sc-offset-offset sc-offset)
2298 (with-nfp ((var) &body body)
2299 `(let ((,var (if escaped
2301 (sb!vm:context-register escaped
2306 sb!vm:n-word-bytes))
2308 (sb!vm::make-number-stack-pointer
2311 sb!vm:n-word-bytes))))))
2313 (ecase (sb!c:sc-offset-scn sc-offset)
2314 ((#.sb!vm:any-reg-sc-number
2315 #.sb!vm:descriptor-reg-sc-number
2316 #!+rt #.sb!vm:word-pointer-reg-sc-number)
2319 (get-lisp-obj-address value))))
2320 (#.sb!vm:character-reg-sc-number
2321 (set-escaped-value (char-code value)))
2322 (#.sb!vm:sap-reg-sc-number
2323 (set-escaped-value (sap-int value)))
2324 (#.sb!vm:signed-reg-sc-number
2325 (set-escaped-value (logand value (1- (ash 1 sb!vm:n-word-bits)))))
2326 (#.sb!vm:unsigned-reg-sc-number
2327 (set-escaped-value value))
2328 (#.sb!vm:non-descriptor-reg-sc-number
2329 (error "Local non-descriptor register access?"))
2330 (#.sb!vm:interior-reg-sc-number
2331 (error "Local interior register access?"))
2332 (#.sb!vm:single-reg-sc-number
2333 (set-escaped-float-value single-float value))
2334 (#.sb!vm:double-reg-sc-number
2335 (set-escaped-float-value double-float value))
2337 (#.sb!vm:long-reg-sc-number
2338 (set-escaped-float-value long-float value))
2339 (#.sb!vm:complex-single-reg-sc-number
2341 (setf (sb!vm:context-float-register escaped
2342 (sb!c:sc-offset-offset sc-offset)
2345 (setf (sb!vm:context-float-register
2346 escaped (1+ (sb!c:sc-offset-offset sc-offset))
2350 (#.sb!vm:complex-double-reg-sc-number
2352 (setf (sb!vm:context-float-register
2353 escaped (sb!c:sc-offset-offset sc-offset) 'double-float)
2355 (setf (sb!vm:context-float-register
2357 (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 2 #!-sparc 1)
2362 (#.sb!vm:complex-long-reg-sc-number
2364 (setf (sb!vm:context-float-register
2365 escaped (sb!c:sc-offset-offset sc-offset) 'long-float)
2367 (setf (sb!vm:context-float-register
2369 (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 4)
2373 (#.sb!vm:single-stack-sc-number
2375 (setf (sap-ref-single nfp (* (sb!c:sc-offset-offset sc-offset)
2376 sb!vm:n-word-bytes))
2377 (the single-float value))))
2378 (#.sb!vm:double-stack-sc-number
2380 (setf (sap-ref-double nfp (* (sb!c:sc-offset-offset sc-offset)
2381 sb!vm:n-word-bytes))
2382 (the double-float value))))
2384 (#.sb!vm:long-stack-sc-number
2386 (setf (sap-ref-long nfp (* (sb!c:sc-offset-offset sc-offset)
2387 sb!vm:n-word-bytes))
2388 (the long-float value))))
2389 (#.sb!vm:complex-single-stack-sc-number
2391 (setf (sap-ref-single
2392 nfp (* (sb!c:sc-offset-offset sc-offset) sb!vm:n-word-bytes))
2393 (the single-float (realpart value)))
2394 (setf (sap-ref-single
2395 nfp (* (1+ (sb!c:sc-offset-offset sc-offset))
2396 sb!vm:n-word-bytes))
2397 (the single-float (realpart value)))))
2398 (#.sb!vm:complex-double-stack-sc-number
2400 (setf (sap-ref-double
2401 nfp (* (sb!c:sc-offset-offset sc-offset) sb!vm:n-word-bytes))
2402 (the double-float (realpart value)))
2403 (setf (sap-ref-double
2404 nfp (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2405 sb!vm:n-word-bytes))
2406 (the double-float (realpart value)))))
2408 (#.sb!vm:complex-long-stack-sc-number
2411 nfp (* (sb!c:sc-offset-offset sc-offset) sb!vm:n-word-bytes))
2412 (the long-float (realpart value)))
2414 nfp (* (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 4)
2415 sb!vm:n-word-bytes))
2416 (the long-float (realpart value)))))
2417 (#.sb!vm:control-stack-sc-number
2418 (setf (stack-ref fp (sb!c:sc-offset-offset sc-offset)) value))
2419 (#.sb!vm:character-stack-sc-number
2421 (setf (sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2422 sb!vm:n-word-bytes))
2423 (char-code (the character value)))))
2424 (#.sb!vm:unsigned-stack-sc-number
2426 (setf (sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2427 sb!vm:n-word-bytes))
2428 (the (unsigned-byte 32) value))))
2429 (#.sb!vm:signed-stack-sc-number
2431 (setf (signed-sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2432 sb!vm:n-word-bytes))
2433 (the (signed-byte 32) value))))
2434 (#.sb!vm:sap-stack-sc-number
2436 (setf (sap-ref-sap nfp (* (sb!c:sc-offset-offset sc-offset)
2437 sb!vm:n-word-bytes))
2438 (the system-area-pointer value)))))))
2441 (defun sub-set-debug-var-slot (fp sc-offset value &optional escaped)
2442 (macrolet ((set-escaped-value (val)
2444 (setf (sb!vm:context-register
2446 (sb!c:sc-offset-offset sc-offset))
2449 (ecase (sb!c:sc-offset-scn sc-offset)
2450 ((#.sb!vm:any-reg-sc-number #.sb!vm:descriptor-reg-sc-number)
2453 (get-lisp-obj-address value))))
2454 (#.sb!vm:character-reg-sc-number
2455 (set-escaped-value (char-code value)))
2456 (#.sb!vm:sap-reg-sc-number
2457 (set-escaped-value (sap-int value)))
2458 (#.sb!vm:signed-reg-sc-number
2459 (set-escaped-value (logand value (1- (ash 1 sb!vm:n-word-bits)))))
2460 (#.sb!vm:unsigned-reg-sc-number
2461 (set-escaped-value value))
2462 (#.sb!vm:single-reg-sc-number
2463 #+nil ;; don't have escaped floats.
2464 (set-escaped-float-value single-float value))
2465 (#.sb!vm:double-reg-sc-number
2466 #+nil ;; don't have escaped floats -- still in npx?
2467 (set-escaped-float-value double-float value))
2469 (#.sb!vm:long-reg-sc-number
2470 #+nil ;; don't have escaped floats -- still in npx?
2471 (set-escaped-float-value long-float value))
2472 (#.sb!vm:single-stack-sc-number
2473 (setf (sap-ref-single
2474 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2475 sb!vm:n-word-bytes)))
2476 (the single-float value)))
2477 (#.sb!vm:double-stack-sc-number
2478 (setf (sap-ref-double
2479 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2480 sb!vm:n-word-bytes)))
2481 (the double-float value)))
2483 (#.sb!vm:long-stack-sc-number
2485 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2486 sb!vm:n-word-bytes)))
2487 (the long-float value)))
2488 (#.sb!vm:complex-single-stack-sc-number
2489 (setf (sap-ref-single
2490 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2491 sb!vm:n-word-bytes)))
2492 (realpart (the (complex single-float) value)))
2493 (setf (sap-ref-single
2494 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2495 sb!vm:n-word-bytes)))
2496 (imagpart (the (complex single-float) value))))
2497 (#.sb!vm:complex-double-stack-sc-number
2498 (setf (sap-ref-double
2499 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2500 sb!vm:n-word-bytes)))
2501 (realpart (the (complex double-float) value)))
2502 (setf (sap-ref-double
2503 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 4)
2504 sb!vm:n-word-bytes)))
2505 (imagpart (the (complex double-float) value))))
2507 (#.sb!vm:complex-long-stack-sc-number
2509 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2510 sb!vm:n-word-bytes)))
2511 (realpart (the (complex long-float) value)))
2513 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 6)
2514 sb!vm:n-word-bytes)))
2515 (imagpart (the (complex long-float) value))))
2516 (#.sb!vm:control-stack-sc-number
2517 (setf (stack-ref fp (sb!c:sc-offset-offset sc-offset)) value))
2518 (#.sb!vm:character-stack-sc-number
2519 (setf (sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2520 sb!vm:n-word-bytes)))
2521 (char-code (the character value))))
2522 (#.sb!vm:unsigned-stack-sc-number
2523 (setf (sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2524 sb!vm:n-word-bytes)))
2525 (the (unsigned-byte 32) value)))
2526 (#.sb!vm:signed-stack-sc-number
2527 (setf (signed-sap-ref-32
2528 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2529 sb!vm:n-word-bytes)))
2530 (the (signed-byte 32) value)))
2531 (#.sb!vm:sap-stack-sc-number
2532 (setf (sap-ref-sap fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2533 sb!vm:n-word-bytes)))
2534 (the system-area-pointer value))))))
2536 ;;; The method for setting and accessing COMPILED-DEBUG-VAR values use
2537 ;;; this to determine if the value stored is the actual value or an
2538 ;;; indirection cell.
2539 (defun indirect-value-cell-p (x)
2540 (and (= (lowtag-of x) sb!vm:other-pointer-lowtag)
2541 (= (widetag-of x) sb!vm:value-cell-header-widetag)))
2543 ;;; Return three values reflecting the validity of DEBUG-VAR's value
2544 ;;; at BASIC-CODE-LOCATION:
2545 ;;; :VALID The value is known to be available.
2546 ;;; :INVALID The value is known to be unavailable.
2547 ;;; :UNKNOWN The value's availability is unknown.
2549 ;;; If the variable is always alive, then it is valid. If the
2550 ;;; code-location is unknown, then the variable's validity is
2551 ;;; :unknown. Once we've called CODE-LOCATION-UNKNOWN-P, we know the
2552 ;;; live-set information has been cached in the code-location.
2553 (defun debug-var-validity (debug-var basic-code-location)
2554 (etypecase debug-var
2556 (compiled-debug-var-validity debug-var basic-code-location))
2557 ;; (There used to be more cases back before sbcl-0.7.0, when
2558 ;; we did special tricks to debug the IR1 interpreter.)
2561 ;;; This is the method for DEBUG-VAR-VALIDITY for COMPILED-DEBUG-VARs.
2562 ;;; For safety, make sure basic-code-location is what we think.
2563 (defun compiled-debug-var-validity (debug-var basic-code-location)
2564 (declare (type compiled-code-location basic-code-location))
2565 (cond ((debug-var-alive-p debug-var)
2566 (let ((debug-fun (code-location-debug-fun basic-code-location)))
2567 (if (>= (compiled-code-location-pc basic-code-location)
2568 (sb!c::compiled-debug-fun-start-pc
2569 (compiled-debug-fun-compiler-debug-fun debug-fun)))
2572 ((code-location-unknown-p basic-code-location) :unknown)
2574 (let ((pos (position debug-var
2575 (debug-fun-debug-vars
2576 (code-location-debug-fun
2577 basic-code-location)))))
2579 (error 'unknown-debug-var
2580 :debug-var debug-var
2582 (code-location-debug-fun basic-code-location)))
2583 ;; There must be live-set info since basic-code-location is known.
2584 (if (zerop (sbit (compiled-code-location-live-set
2585 basic-code-location)
2592 ;;; This code produces and uses what we call source-paths. A
2593 ;;; source-path is a list whose first element is a form number as
2594 ;;; returned by CODE-LOCATION-FORM-NUMBER and whose last element is a
2595 ;;; top level form number as returned by
2596 ;;; CODE-LOCATION-TOPLEVEL-FORM-NUMBER. The elements from the last to
2597 ;;; the first, exclusively, are the numbered subforms into which to
2598 ;;; descend. For example:
2600 ;;; (let ((a (aref x 3)))
2602 ;;; The call to AREF in this example is form number 5. Assuming this
2603 ;;; DEFUN is the 11'th top level form, the source-path for the AREF
2604 ;;; call is as follows:
2606 ;;; Given the DEFUN, 3 gets you the LET, 1 gets you the bindings, 0
2607 ;;; gets the first binding, and 1 gets the AREF form.
2609 ;;; temporary buffer used to build form-number => source-path translation in
2610 ;;; FORM-NUMBER-TRANSLATIONS
2611 (defvar *form-number-temp* (make-array 10 :fill-pointer 0 :adjustable t))
2613 ;;; table used to detect CAR circularities in FORM-NUMBER-TRANSLATIONS
2614 (defvar *form-number-circularity-table* (make-hash-table :test 'eq))
2616 ;;; This returns a table mapping form numbers to source-paths. A
2617 ;;; source-path indicates a descent into the TOPLEVEL-FORM form,
2618 ;;; going directly to the subform corressponding to the form number.
2620 ;;; The vector elements are in the same format as the compiler's
2621 ;;; NODE-SOURCE-PATH; that is, the first element is the form number and
2622 ;;; the last is the TOPLEVEL-FORM number.
2623 (defun form-number-translations (form tlf-number)
2624 (clrhash *form-number-circularity-table*)
2625 (setf (fill-pointer *form-number-temp*) 0)
2626 (sub-translate-form-numbers form (list tlf-number))
2627 (coerce *form-number-temp* 'simple-vector))
2628 (defun sub-translate-form-numbers (form path)
2629 (unless (gethash form *form-number-circularity-table*)
2630 (setf (gethash form *form-number-circularity-table*) t)
2631 (vector-push-extend (cons (fill-pointer *form-number-temp*) path)
2636 (declare (fixnum pos))
2639 (when (atom subform) (return))
2640 (let ((fm (car subform)))
2642 (sub-translate-form-numbers fm (cons pos path)))
2644 (setq subform (cdr subform))
2645 (when (eq subform trail) (return)))))
2649 (setq trail (cdr trail)))))))
2651 ;;; FORM is a top level form, and path is a source-path into it. This
2652 ;;; returns the form indicated by the source-path. Context is the
2653 ;;; number of enclosing forms to return instead of directly returning
2654 ;;; the source-path form. When context is non-zero, the form returned
2655 ;;; contains a marker, #:****HERE****, immediately before the form
2656 ;;; indicated by path.
2657 (defun source-path-context (form path context)
2658 (declare (type unsigned-byte context))
2659 ;; Get to the form indicated by path or the enclosing form indicated
2660 ;; by context and path.
2661 (let ((path (reverse (butlast (cdr path)))))
2662 (dotimes (i (- (length path) context))
2663 (let ((index (first path)))
2664 (unless (and (listp form) (< index (length form)))
2665 (error "Source path no longer exists."))
2666 (setq form (elt form index))
2667 (setq path (rest path))))
2668 ;; Recursively rebuild the source form resulting from the above
2669 ;; descent, copying the beginning of each subform up to the next
2670 ;; subform we descend into according to path. At the bottom of the
2671 ;; recursion, we return the form indicated by path preceded by our
2672 ;; marker, and this gets spliced into the resulting list structure
2673 ;; on the way back up.
2674 (labels ((frob (form path level)
2675 (if (or (zerop level) (null path))
2678 `(#:***here*** ,form))
2679 (let ((n (first path)))
2680 (unless (and (listp form) (< n (length form)))
2681 (error "Source path no longer exists."))
2682 (let ((res (frob (elt form n) (rest path) (1- level))))
2683 (nconc (subseq form 0 n)
2684 (cons res (nthcdr (1+ n) form))))))))
2685 (frob form path context))))
2687 ;;;; PREPROCESS-FOR-EVAL
2689 ;;; Return a function of one argument that evaluates form in the
2690 ;;; lexical context of the BASIC-CODE-LOCATION LOC, or signal a
2691 ;;; NO-DEBUG-VARS condition when the LOC's DEBUG-FUN has no
2692 ;;; DEBUG-VAR information available.
2694 ;;; The returned function takes the frame to get values from as its
2695 ;;; argument, and it returns the values of FORM. The returned function
2696 ;;; can signal the following conditions: INVALID-VALUE,
2697 ;;; AMBIGUOUS-VAR-NAME, and FRAME-FUN-MISMATCH.
2698 (defun preprocess-for-eval (form loc)
2699 (declare (type code-location loc))
2700 (let ((n-frame (gensym))
2701 (fun (code-location-debug-fun loc)))
2702 (unless (debug-var-info-available fun)
2703 (debug-signal 'no-debug-vars :debug-fun fun))
2704 (sb!int:collect ((binds)
2706 (do-debug-fun-vars (var fun)
2707 (let ((validity (debug-var-validity var loc)))
2708 (unless (eq validity :invalid)
2709 (let* ((sym (debug-var-symbol var))
2710 (found (assoc sym (binds))))
2712 (setf (second found) :ambiguous)
2713 (binds (list sym validity var)))))))
2714 (dolist (bind (binds))
2715 (let ((name (first bind))
2717 (ecase (second bind)
2719 (specs `(,name (debug-var-value ',var ,n-frame))))
2721 (specs `(,name (debug-signal 'invalid-value
2725 (specs `(,name (debug-signal 'ambiguous-var-name
2727 :frame ,n-frame)))))))
2728 (let ((res (coerce `(lambda (,n-frame)
2729 (declare (ignorable ,n-frame))
2730 (symbol-macrolet ,(specs) ,form))
2733 ;; This prevents these functions from being used in any
2734 ;; location other than a function return location, so maybe
2735 ;; this should only check whether FRAME's DEBUG-FUN is the
2737 (unless (code-location= (frame-code-location frame) loc)
2738 (debug-signal 'frame-fun-mismatch
2739 :code-location loc :form form :frame frame))
2740 (funcall res frame))))))
2744 ;;;; user-visible interface
2746 ;;; Create and return a breakpoint. When program execution encounters
2747 ;;; the breakpoint, the system calls HOOK-FUN. HOOK-FUN takes the
2748 ;;; current frame for the function in which the program is running and
2749 ;;; the breakpoint object.
2751 ;;; WHAT and KIND determine where in a function the system invokes
2752 ;;; HOOK-FUN. WHAT is either a code-location or a DEBUG-FUN. KIND is
2753 ;;; one of :CODE-LOCATION, :FUN-START, or :FUN-END. Since the starts
2754 ;;; and ends of functions may not have code-locations representing
2755 ;;; them, designate these places by supplying WHAT as a DEBUG-FUN and
2756 ;;; KIND indicating the :FUN-START or :FUN-END. When WHAT is a
2757 ;;; DEBUG-FUN and kind is :FUN-END, then HOOK-FUN must take two
2758 ;;; additional arguments, a list of values returned by the function
2759 ;;; and a FUN-END-COOKIE.
2761 ;;; INFO is information supplied by and used by the user.
2763 ;;; FUN-END-COOKIE is a function. To implement :FUN-END
2764 ;;; breakpoints, the system uses starter breakpoints to establish the
2765 ;;; :FUN-END breakpoint for each invocation of the function. Upon
2766 ;;; each entry, the system creates a unique cookie to identify the
2767 ;;; invocation, and when the user supplies a function for this
2768 ;;; argument, the system invokes it on the frame and the cookie. The
2769 ;;; system later invokes the :FUN-END breakpoint hook on the same
2770 ;;; cookie. The user may save the cookie for comparison in the hook
2773 ;;; Signal an error if WHAT is an unknown code-location.
2774 (defun make-breakpoint (hook-fun what
2775 &key (kind :code-location) info fun-end-cookie)
2778 (when (code-location-unknown-p what)
2779 (error "cannot make a breakpoint at an unknown code location: ~S"
2781 (aver (eq kind :code-location))
2782 (let ((bpt (%make-breakpoint hook-fun what kind info)))
2784 (compiled-code-location
2785 ;; This slot is filled in due to calling CODE-LOCATION-UNKNOWN-P.
2786 (when (eq (compiled-code-location-kind what) :unknown-return)
2787 (let ((other-bpt (%make-breakpoint hook-fun what
2788 :unknown-return-partner
2790 (setf (breakpoint-unknown-return-partner bpt) other-bpt)
2791 (setf (breakpoint-unknown-return-partner other-bpt) bpt))))
2792 ;; (There used to be more cases back before sbcl-0.7.0,,
2793 ;; when we did special tricks to debug the IR1
2800 (%make-breakpoint hook-fun what kind info))
2802 (unless (eq (sb!c::compiled-debug-fun-returns
2803 (compiled-debug-fun-compiler-debug-fun what))
2805 (error ":FUN-END breakpoints are currently unsupported ~
2806 for the known return convention."))
2808 (let* ((bpt (%make-breakpoint hook-fun what kind info))
2809 (starter (compiled-debug-fun-end-starter what)))
2811 (setf starter (%make-breakpoint #'list what :fun-start nil))
2812 (setf (breakpoint-hook-fun starter)
2813 (fun-end-starter-hook starter what))
2814 (setf (compiled-debug-fun-end-starter what) starter))
2815 (setf (breakpoint-start-helper bpt) starter)
2816 (push bpt (breakpoint-%info starter))
2817 (setf (breakpoint-cookie-fun bpt) fun-end-cookie)
2820 ;;; These are unique objects created upon entry into a function by a
2821 ;;; :FUN-END breakpoint's starter hook. These are only created
2822 ;;; when users supply :FUN-END-COOKIE to MAKE-BREAKPOINT. Also,
2823 ;;; the :FUN-END breakpoint's hook is called on the same cookie
2824 ;;; when it is created.
2825 (defstruct (fun-end-cookie
2826 (:print-object (lambda (obj str)
2827 (print-unreadable-object (obj str :type t))))
2828 (:constructor make-fun-end-cookie (bogus-lra debug-fun))
2830 ;; a pointer to the bogus-lra created for :FUN-END breakpoints
2832 ;; the DEBUG-FUN associated with this cookie
2835 ;;; This maps bogus-lra-components to cookies, so that
2836 ;;; HANDLE-FUN-END-BREAKPOINT can find the appropriate cookie for the
2837 ;;; breakpoint hook.
2838 (defvar *fun-end-cookies* (make-hash-table :test 'eq))
2840 ;;; This returns a hook function for the start helper breakpoint
2841 ;;; associated with a :FUN-END breakpoint. The returned function
2842 ;;; makes a fake LRA that all returns go through, and this piece of
2843 ;;; fake code actually breaks. Upon return from the break, the code
2844 ;;; provides the returnee with any values. Since the returned function
2845 ;;; effectively activates FUN-END-BPT on each entry to DEBUG-FUN's
2846 ;;; function, we must establish breakpoint-data about FUN-END-BPT.
2847 (defun fun-end-starter-hook (starter-bpt debug-fun)
2848 (declare (type breakpoint starter-bpt)
2849 (type compiled-debug-fun debug-fun))
2850 (lambda (frame breakpoint)
2851 (declare (ignore breakpoint)
2853 (let ((lra-sc-offset
2854 (sb!c::compiled-debug-fun-return-pc
2855 (compiled-debug-fun-compiler-debug-fun debug-fun))))
2856 (multiple-value-bind (lra component offset)
2858 (get-context-value frame
2861 (setf (get-context-value frame
2865 (let ((end-bpts (breakpoint-%info starter-bpt)))
2866 (let ((data (breakpoint-data component offset)))
2867 (setf (breakpoint-data-breakpoints data) end-bpts)
2868 (dolist (bpt end-bpts)
2869 (setf (breakpoint-internal-data bpt) data)))
2870 (let ((cookie (make-fun-end-cookie lra debug-fun)))
2871 (setf (gethash component *fun-end-cookies*) cookie)
2872 (dolist (bpt end-bpts)
2873 (let ((fun (breakpoint-cookie-fun bpt)))
2874 (when fun (funcall fun frame cookie))))))))))
2876 ;;; This takes a FUN-END-COOKIE and a frame, and it returns
2877 ;;; whether the cookie is still valid. A cookie becomes invalid when
2878 ;;; the frame that established the cookie has exited. Sometimes cookie
2879 ;;; holders are unaware of cookie invalidation because their
2880 ;;; :FUN-END breakpoint hooks didn't run due to THROW'ing.
2882 ;;; This takes a frame as an efficiency hack since the user probably
2883 ;;; has a frame object in hand when using this routine, and it saves
2884 ;;; repeated parsing of the stack and consing when asking whether a
2885 ;;; series of cookies is valid.
2886 (defun fun-end-cookie-valid-p (frame cookie)
2887 (let ((lra (fun-end-cookie-bogus-lra cookie))
2888 (lra-sc-offset (sb!c::compiled-debug-fun-return-pc
2889 (compiled-debug-fun-compiler-debug-fun
2890 (fun-end-cookie-debug-fun cookie)))))
2891 (do ((frame frame (frame-down frame)))
2893 (when (and (compiled-frame-p frame)
2894 (#!-x86 eq #!+x86 sap=
2896 (get-context-value frame lra-save-offset lra-sc-offset)))
2899 ;;;; ACTIVATE-BREAKPOINT
2901 ;;; Cause the system to invoke the breakpoint's hook function until
2902 ;;; the next call to DEACTIVATE-BREAKPOINT or DELETE-BREAKPOINT. The
2903 ;;; system invokes breakpoint hook functions in the opposite order
2904 ;;; that you activate them.
2905 (defun activate-breakpoint (breakpoint)
2906 (when (eq (breakpoint-status breakpoint) :deleted)
2907 (error "cannot activate a deleted breakpoint: ~S" breakpoint))
2908 (unless (eq (breakpoint-status breakpoint) :active)
2909 (ecase (breakpoint-kind breakpoint)
2911 (let ((loc (breakpoint-what breakpoint)))
2913 (compiled-code-location
2914 (activate-compiled-code-location-breakpoint breakpoint)
2915 (let ((other (breakpoint-unknown-return-partner breakpoint)))
2917 (activate-compiled-code-location-breakpoint other))))
2918 ;; (There used to be more cases back before sbcl-0.7.0, when
2919 ;; we did special tricks to debug the IR1 interpreter.)
2922 (etypecase (breakpoint-what breakpoint)
2924 (activate-compiled-fun-start-breakpoint breakpoint))
2925 ;; (There used to be more cases back before sbcl-0.7.0, when
2926 ;; we did special tricks to debug the IR1 interpreter.)
2929 (etypecase (breakpoint-what breakpoint)
2931 (let ((starter (breakpoint-start-helper breakpoint)))
2932 (unless (eq (breakpoint-status starter) :active)
2933 ;; may already be active by some other :FUN-END breakpoint
2934 (activate-compiled-fun-start-breakpoint starter)))
2935 (setf (breakpoint-status breakpoint) :active))
2936 ;; (There used to be more cases back before sbcl-0.7.0, when
2937 ;; we did special tricks to debug the IR1 interpreter.)
2941 (defun activate-compiled-code-location-breakpoint (breakpoint)
2942 (declare (type breakpoint breakpoint))
2943 (let ((loc (breakpoint-what breakpoint)))
2944 (declare (type compiled-code-location loc))
2945 (sub-activate-breakpoint
2947 (breakpoint-data (compiled-debug-fun-component
2948 (code-location-debug-fun loc))
2949 (+ (compiled-code-location-pc loc)
2950 (if (or (eq (breakpoint-kind breakpoint)
2951 :unknown-return-partner)
2952 (eq (compiled-code-location-kind loc)
2953 :single-value-return))
2954 sb!vm:single-value-return-byte-offset
2957 (defun activate-compiled-fun-start-breakpoint (breakpoint)
2958 (declare (type breakpoint breakpoint))
2959 (let ((debug-fun (breakpoint-what breakpoint)))
2960 (sub-activate-breakpoint
2962 (breakpoint-data (compiled-debug-fun-component debug-fun)
2963 (sb!c::compiled-debug-fun-start-pc
2964 (compiled-debug-fun-compiler-debug-fun
2967 (defun sub-activate-breakpoint (breakpoint data)
2968 (declare (type breakpoint breakpoint)
2969 (type breakpoint-data data))
2970 (setf (breakpoint-status breakpoint) :active)
2972 (unless (breakpoint-data-breakpoints data)
2973 (setf (breakpoint-data-instruction data)
2975 (breakpoint-install (get-lisp-obj-address
2976 (breakpoint-data-component data))
2977 (breakpoint-data-offset data)))))
2978 (setf (breakpoint-data-breakpoints data)
2979 (append (breakpoint-data-breakpoints data) (list breakpoint)))
2980 (setf (breakpoint-internal-data breakpoint) data)))
2982 ;;;; DEACTIVATE-BREAKPOINT
2984 ;;; Stop the system from invoking the breakpoint's hook function.
2985 (defun deactivate-breakpoint (breakpoint)
2986 (when (eq (breakpoint-status breakpoint) :active)
2988 (let ((loc (breakpoint-what breakpoint)))
2990 ((or compiled-code-location compiled-debug-fun)
2991 (deactivate-compiled-breakpoint breakpoint)
2992 (let ((other (breakpoint-unknown-return-partner breakpoint)))
2994 (deactivate-compiled-breakpoint other))))
2995 ;; (There used to be more cases back before sbcl-0.7.0, when
2996 ;; we did special tricks to debug the IR1 interpreter.)
3000 (defun deactivate-compiled-breakpoint (breakpoint)
3001 (if (eq (breakpoint-kind breakpoint) :fun-end)
3002 (let ((starter (breakpoint-start-helper breakpoint)))
3003 (unless (find-if (lambda (bpt)
3004 (and (not (eq bpt breakpoint))
3005 (eq (breakpoint-status bpt) :active)))
3006 (breakpoint-%info starter))
3007 (deactivate-compiled-breakpoint starter)))
3008 (let* ((data (breakpoint-internal-data breakpoint))
3009 (bpts (delete breakpoint (breakpoint-data-breakpoints data))))
3010 (setf (breakpoint-internal-data breakpoint) nil)
3011 (setf (breakpoint-data-breakpoints data) bpts)
3014 (breakpoint-remove (get-lisp-obj-address
3015 (breakpoint-data-component data))
3016 (breakpoint-data-offset data)
3017 (breakpoint-data-instruction data)))
3018 (delete-breakpoint-data data))))
3019 (setf (breakpoint-status breakpoint) :inactive)
3022 ;;;; BREAKPOINT-INFO
3024 ;;; Return the user-maintained info associated with breakpoint. This
3026 (defun breakpoint-info (breakpoint)
3027 (breakpoint-%info breakpoint))
3028 (defun %set-breakpoint-info (breakpoint value)
3029 (setf (breakpoint-%info breakpoint) value)
3030 (let ((other (breakpoint-unknown-return-partner breakpoint)))
3032 (setf (breakpoint-%info other) value))))
3034 ;;;; BREAKPOINT-ACTIVE-P and DELETE-BREAKPOINT
3036 (defun breakpoint-active-p (breakpoint)
3037 (ecase (breakpoint-status breakpoint)
3039 ((:inactive :deleted) nil)))
3041 ;;; Free system storage and remove computational overhead associated
3042 ;;; with breakpoint. After calling this, breakpoint is completely
3043 ;;; impotent and can never become active again.
3044 (defun delete-breakpoint (breakpoint)
3045 (let ((status (breakpoint-status breakpoint)))
3046 (unless (eq status :deleted)
3047 (when (eq status :active)
3048 (deactivate-breakpoint breakpoint))
3049 (setf (breakpoint-status breakpoint) :deleted)
3050 (let ((other (breakpoint-unknown-return-partner breakpoint)))
3052 (setf (breakpoint-status other) :deleted)))
3053 (when (eq (breakpoint-kind breakpoint) :fun-end)
3054 (let* ((starter (breakpoint-start-helper breakpoint))
3055 (breakpoints (delete breakpoint
3056 (the list (breakpoint-info starter)))))
3057 (setf (breakpoint-info starter) breakpoints)
3059 (delete-breakpoint starter)
3060 (setf (compiled-debug-fun-end-starter
3061 (breakpoint-what breakpoint))
3065 ;;;; C call out stubs
3067 ;;; This actually installs the break instruction in the component. It
3068 ;;; returns the overwritten bits. You must call this in a context in
3069 ;;; which GC is disabled, so that Lisp doesn't move objects around
3070 ;;; that C is pointing to.
3071 (sb!alien:define-alien-routine "breakpoint_install" sb!alien:unsigned-long
3072 (code-obj sb!alien:unsigned-long)
3073 (pc-offset sb!alien:int))
3075 ;;; This removes the break instruction and replaces the original
3076 ;;; instruction. You must call this in a context in which GC is disabled
3077 ;;; so Lisp doesn't move objects around that C is pointing to.
3078 (sb!alien:define-alien-routine "breakpoint_remove" sb!alien:void
3079 (code-obj sb!alien:unsigned-long)
3080 (pc-offset sb!alien:int)
3081 (old-inst sb!alien:unsigned-long))
3083 (sb!alien:define-alien-routine "breakpoint_do_displaced_inst" sb!alien:void
3084 (scp (* os-context-t))
3085 (orig-inst sb!alien:unsigned-long))
3087 ;;;; breakpoint handlers (layer between C and exported interface)
3089 ;;; This maps components to a mapping of offsets to BREAKPOINT-DATAs.
3090 (defvar *component-breakpoint-offsets* (make-hash-table :test 'eq))
3092 ;;; This returns the BREAKPOINT-DATA object associated with component cross
3093 ;;; offset. If none exists, this makes one, installs it, and returns it.
3094 (defun breakpoint-data (component offset &optional (create t))
3095 (flet ((install-breakpoint-data ()
3097 (let ((data (make-breakpoint-data component offset)))
3098 (push (cons offset data)
3099 (gethash component *component-breakpoint-offsets*))
3101 (let ((offsets (gethash component *component-breakpoint-offsets*)))
3103 (let ((data (assoc offset offsets)))
3106 (install-breakpoint-data)))
3107 (install-breakpoint-data)))))
3109 ;;; We use this when there are no longer any active breakpoints
3110 ;;; corresponding to DATA.
3111 (defun delete-breakpoint-data (data)
3112 (let* ((component (breakpoint-data-component data))
3113 (offsets (delete (breakpoint-data-offset data)
3114 (gethash component *component-breakpoint-offsets*)
3117 (setf (gethash component *component-breakpoint-offsets*) offsets)
3118 (remhash component *component-breakpoint-offsets*)))
3121 ;;; The C handler for interrupts calls this when it has a
3122 ;;; debugging-tool break instruction. This does *not* handle all
3123 ;;; breaks; for example, it does not handle breaks for internal
3125 (defun handle-breakpoint (offset component signal-context)
3126 (let ((data (breakpoint-data component offset nil)))
3128 (error "unknown breakpoint in ~S at offset ~S"
3129 (debug-fun-name (debug-fun-from-pc component offset))
3131 (let ((breakpoints (breakpoint-data-breakpoints data)))
3132 (if (or (null breakpoints)
3133 (eq (breakpoint-kind (car breakpoints)) :fun-end))
3134 (handle-fun-end-breakpoint-aux breakpoints data signal-context)
3135 (handle-breakpoint-aux breakpoints data
3136 offset component signal-context)))))
3138 ;;; This holds breakpoint-datas while invoking the breakpoint hooks
3139 ;;; associated with that particular component and location. While they
3140 ;;; are executing, if we hit the location again, we ignore the
3141 ;;; breakpoint to avoid infinite recursion. fun-end breakpoints
3142 ;;; must work differently since the breakpoint-data is unique for each
3144 (defvar *executing-breakpoint-hooks* nil)
3146 ;;; This handles code-location and DEBUG-FUN :FUN-START
3148 (defun handle-breakpoint-aux (breakpoints data offset component signal-context)
3150 (bug "breakpoint that nobody wants"))
3151 (unless (member data *executing-breakpoint-hooks*)
3152 (let ((*executing-breakpoint-hooks* (cons data
3153 *executing-breakpoint-hooks*)))
3154 (invoke-breakpoint-hooks breakpoints component offset)))
3155 ;; At this point breakpoints may not hold the same list as
3156 ;; BREAKPOINT-DATA-BREAKPOINTS since invoking hooks may have allowed
3157 ;; a breakpoint deactivation. In fact, if all breakpoints were
3158 ;; deactivated then data is invalid since it was deleted and so the
3159 ;; correct one must be looked up if it is to be used. If there are
3160 ;; no more breakpoints active at this location, then the normal
3161 ;; instruction has been put back, and we do not need to
3162 ;; DO-DISPLACED-INST.
3163 (let ((data (breakpoint-data component offset nil)))
3164 (when (and data (breakpoint-data-breakpoints data))
3165 ;; The breakpoint is still active, so we need to execute the
3166 ;; displaced instruction and leave the breakpoint instruction
3167 ;; behind. The best way to do this is different on each machine,
3168 ;; so we just leave it up to the C code.
3169 (breakpoint-do-displaced-inst signal-context
3170 (breakpoint-data-instruction data))
3171 ;; Some platforms have no usable sigreturn() call. If your
3172 ;; implementation of arch_do_displaced_inst() _does_ sigreturn(),
3173 ;; it's polite to warn here
3174 #!+(and sparc solaris)
3175 (error "BREAKPOINT-DO-DISPLACED-INST returned?"))))
3177 (defun invoke-breakpoint-hooks (breakpoints component offset)
3178 (let* ((debug-fun (debug-fun-from-pc component offset))
3179 (frame (do ((f (top-frame) (frame-down f)))
3180 ((eq debug-fun (frame-debug-fun f)) f))))
3181 (dolist (bpt breakpoints)
3182 (funcall (breakpoint-hook-fun bpt)
3184 ;; If this is an :UNKNOWN-RETURN-PARTNER, then pass the
3185 ;; hook function the original breakpoint, so that users
3186 ;; aren't forced to confront the fact that some
3187 ;; breakpoints really are two.
3188 (if (eq (breakpoint-kind bpt) :unknown-return-partner)
3189 (breakpoint-unknown-return-partner bpt)
3192 (defun handle-fun-end-breakpoint (offset component context)
3193 (let ((data (breakpoint-data component offset nil)))
3195 (error "unknown breakpoint in ~S at offset ~S"
3196 (debug-fun-name (debug-fun-from-pc component offset))
3198 (let ((breakpoints (breakpoint-data-breakpoints data)))
3200 (aver (eq (breakpoint-kind (car breakpoints)) :fun-end))
3201 (handle-fun-end-breakpoint-aux breakpoints data context)))))
3203 ;;; Either HANDLE-BREAKPOINT calls this for :FUN-END breakpoints
3204 ;;; [old C code] or HANDLE-FUN-END-BREAKPOINT calls this directly
3206 (defun handle-fun-end-breakpoint-aux (breakpoints data signal-context)
3207 (delete-breakpoint-data data)
3210 (declare (optimize (inhibit-warnings 3)))
3211 (sb!alien:sap-alien signal-context (* os-context-t))))
3212 (frame (do ((cfp (sb!vm:context-register scp sb!vm::cfp-offset))
3213 (f (top-frame) (frame-down f)))
3214 ((= cfp (sap-int (frame-pointer f))) f)
3215 (declare (type (unsigned-byte #.sb!vm:n-word-bits) cfp))))
3216 (component (breakpoint-data-component data))
3217 (cookie (gethash component *fun-end-cookies*)))
3218 (remhash component *fun-end-cookies*)
3219 (dolist (bpt breakpoints)
3220 (funcall (breakpoint-hook-fun bpt)
3222 (get-fun-end-breakpoint-values scp)
3225 (defun get-fun-end-breakpoint-values (scp)
3226 (let ((ocfp (int-sap (sb!vm:context-register
3228 #!-x86 sb!vm::ocfp-offset
3229 #!+x86 sb!vm::ebx-offset)))
3230 (nargs (make-lisp-obj
3231 (sb!vm:context-register scp sb!vm::nargs-offset)))
3232 (reg-arg-offsets '#.sb!vm::*register-arg-offsets*)
3235 (dotimes (arg-num nargs)
3236 (push (if reg-arg-offsets
3238 (sb!vm:context-register scp (pop reg-arg-offsets)))
3239 (stack-ref ocfp arg-num))
3241 (nreverse results)))
3243 ;;;; MAKE-BOGUS-LRA (used for :FUN-END breakpoints)
3245 (defconstant bogus-lra-constants
3247 (defconstant known-return-p-slot
3248 (+ sb!vm:code-constants-offset #!-x86 1 #!+x86 2))
3250 ;;; Make a bogus LRA object that signals a breakpoint trap when
3251 ;;; returned to. If the breakpoint trap handler returns, REAL-LRA is
3252 ;;; returned to. Three values are returned: the bogus LRA object, the
3253 ;;; code component it is part of, and the PC offset for the trap
3255 (defun make-bogus-lra (real-lra &optional known-return-p)
3257 ;; These are really code labels, not variables: but this way we get
3259 (let* ((src-start (foreign-symbol-address "fun_end_breakpoint_guts"))
3260 (src-end (foreign-symbol-address "fun_end_breakpoint_end"))
3261 (trap-loc (foreign-symbol-address "fun_end_breakpoint_trap"))
3262 (length (sap- src-end src-start))
3264 (%primitive sb!c:allocate-code-object (1+ bogus-lra-constants)
3266 (dst-start (code-instructions code-object)))
3267 (declare (type system-area-pointer
3268 src-start src-end dst-start trap-loc)
3269 (type index length))
3270 (setf (%code-debug-info code-object) :bogus-lra)
3271 (setf (code-header-ref code-object sb!vm:code-trace-table-offset-slot)
3274 (setf (code-header-ref code-object real-lra-slot) real-lra)
3276 (multiple-value-bind (offset code) (compute-lra-data-from-pc real-lra)
3277 (setf (code-header-ref code-object real-lra-slot) code)
3278 (setf (code-header-ref code-object (1+ real-lra-slot)) offset))
3279 (setf (code-header-ref code-object known-return-p-slot)
3281 (system-area-copy src-start 0 dst-start 0 (* length sb!vm:n-byte-bits))
3282 (sb!vm:sanctify-for-execution code-object)
3284 (values dst-start code-object (sap- trap-loc src-start))
3286 (let ((new-lra (make-lisp-obj (+ (sap-int dst-start)
3287 sb!vm:other-pointer-lowtag))))
3290 (logandc2 (+ sb!vm:code-constants-offset bogus-lra-constants 1)
3292 (sb!vm:sanctify-for-execution code-object)
3293 (values new-lra code-object (sap- trap-loc src-start))))))
3297 ;;; This appears here because it cannot go with the DEBUG-FUN
3298 ;;; interface since DO-DEBUG-BLOCK-LOCATIONS isn't defined until after
3299 ;;; the DEBUG-FUN routines.
3301 ;;; Return a code-location before the body of a function and after all
3302 ;;; the arguments are in place; or if that location can't be
3303 ;;; determined due to a lack of debug information, return NIL.
3304 (defun debug-fun-start-location (debug-fun)
3305 (etypecase debug-fun
3307 (code-location-from-pc debug-fun
3308 (sb!c::compiled-debug-fun-start-pc
3309 (compiled-debug-fun-compiler-debug-fun
3312 ;; (There used to be more cases back before sbcl-0.7.0, when
3313 ;; we did special tricks to debug the IR1 interpreter.)