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 sb!vm::word))
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 step-info &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))
484 (step-info :unparsed :type (or (member :unparsed :foo) simple-string)))
488 ;;; Return the number of top level forms processed by the compiler
489 ;;; before compiling this source. If this source is uncompiled, this
490 ;;; is zero. This may be zero even if the source is compiled since the
491 ;;; first form in the first file compiled in one compilation, for
492 ;;; example, must have a root number of zero -- the compiler saw no
493 ;;; other top level forms before it.
494 (defun debug-source-root-number (debug-source)
495 (sb!c::debug-source-source-root debug-source))
499 ;;; This is used in FIND-ESCAPED-FRAME and with the bogus components
500 ;;; and LRAs used for :FUN-END breakpoints. When a component's
501 ;;; debug-info slot is :BOGUS-LRA, then the REAL-LRA-SLOT contains the
502 ;;; real component to continue executing, as opposed to the bogus
503 ;;; component which appeared in some frame's LRA location.
504 (defconstant real-lra-slot sb!vm:code-constants-offset)
506 ;;; These are magically converted by the compiler.
507 (defun current-sp () (current-sp))
508 (defun current-fp () (current-fp))
509 (defun stack-ref (s n) (stack-ref s n))
510 (defun %set-stack-ref (s n value) (%set-stack-ref s n value))
511 (defun fun-code-header (fun) (fun-code-header fun))
512 (defun lra-code-header (lra) (lra-code-header lra))
513 (defun make-lisp-obj (value) (make-lisp-obj value))
514 (defun get-lisp-obj-address (thing) (get-lisp-obj-address thing))
515 (defun fun-word-offset (fun) (fun-word-offset fun))
517 #!-sb-fluid (declaim (inline control-stack-pointer-valid-p))
518 (defun control-stack-pointer-valid-p (x)
519 (declare (type system-area-pointer x))
520 (let* (#!-stack-grows-downward-not-upward
522 (descriptor-sap *control-stack-start*))
523 #!+stack-grows-downward-not-upward
525 (descriptor-sap *control-stack-end*)))
526 #!-stack-grows-downward-not-upward
527 (and (sap< x (current-sp))
528 (sap<= control-stack-start x)
529 (zerop (logand (sap-int x) sb!vm:fixnum-tag-mask)))
530 #!+stack-grows-downward-not-upward
531 (and (sap>= x (current-sp))
532 (sap> control-stack-end x)
533 (zerop (logand (sap-int x) sb!vm:fixnum-tag-mask)))))
535 (declaim (inline component-ptr-from-pc))
536 (sb!alien:define-alien-routine component-ptr-from-pc (system-area-pointer)
537 (pc system-area-pointer))
539 (declaim (inline component-from-component-ptr))
540 (defun component-from-component-ptr (component-ptr)
541 (declare (type system-area-pointer component-ptr))
542 (make-lisp-obj (logior (sap-int component-ptr)
543 sb!vm:other-pointer-lowtag)))
545 ;;;; (OR X86 X86-64) support
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)))))
563 (defconstant sb!vm::nargs-offset #.sb!vm::ecx-offset)
565 ;;; Check for a valid return address - it could be any valid C/Lisp
568 ;;; XXX Could be a little smarter.
569 #!-sb-fluid (declaim (inline ra-pointer-valid-p))
570 (defun ra-pointer-valid-p (ra)
571 (declare (type system-area-pointer ra))
573 ;; not the first page (which is unmapped)
575 ;; FIXME: Where is this documented? Is it really true of every CPU
576 ;; architecture? Is it even necessarily true in current SBCL?
577 (>= (sap-int ra) 4096)
578 ;; not a Lisp stack pointer
579 (not (control-stack-pointer-valid-p ra))))
581 ;;; Try to find a valid previous stack. This is complex on the x86 as
582 ;;; it can jump between C and Lisp frames. To help find a valid frame
583 ;;; it searches backwards.
585 ;;; XXX Should probably check whether it has reached the bottom of the
588 ;;; XXX Should handle interrupted frames, both Lisp and C. At present
589 ;;; it manages to find a fp trail, see linux hack below.
590 (declaim (maybe-inline x86-call-context))
591 (defun x86-call-context (fp)
592 (declare (type system-area-pointer fp))
599 ((not (control-stack-pointer-valid-p fp))
602 ;; Check the two possible frame pointers.
603 (let ((lisp-ocfp (sap-ref-sap fp (- (* (1+ ocfp-save-offset)
604 sb!vm::n-word-bytes))))
605 (lisp-ra (sap-ref-sap fp (- (* (1+ return-pc-save-offset)
606 sb!vm::n-word-bytes))))
607 (c-ocfp (sap-ref-sap fp (* 0 sb!vm:n-word-bytes)))
608 (c-ra (sap-ref-sap fp (* 1 sb!vm:n-word-bytes))))
609 (cond ((and (sap> lisp-ocfp fp)
610 (control-stack-pointer-valid-p lisp-ocfp)
611 (ra-pointer-valid-p lisp-ra)
613 (control-stack-pointer-valid-p c-ocfp)
614 (ra-pointer-valid-p c-ra))
615 ;; Look forward another step to check their validity.
616 (let ((lisp-ok (handle lisp-ocfp))
617 (c-ok (handle c-ocfp)))
618 (cond ((and lisp-ok c-ok)
619 ;; Both still seem valid - choose the lisp frame.
621 (if (sap> lisp-ocfp c-ocfp)
622 (values t lisp-ra lisp-ocfp)
623 (values t c-ra c-ocfp))
625 (values t lisp-ra lisp-ocfp))
627 ;; The lisp convention is looking good.
628 (values t lisp-ra lisp-ocfp))
630 ;; The C convention is looking good.
631 (values t c-ra c-ocfp))
633 ;; Neither seems right?
635 ((and (sap> lisp-ocfp fp)
636 (control-stack-pointer-valid-p lisp-ocfp)
637 (ra-pointer-valid-p lisp-ra))
638 ;; The lisp convention is looking good.
639 (values t lisp-ra lisp-ocfp))
640 ((and (sap> c-ocfp fp)
641 (control-stack-pointer-valid-p c-ocfp)
642 #!-linux (ra-pointer-valid-p c-ra))
643 ;; The C convention is looking good.
644 (values t c-ra c-ocfp))
651 ;;; Convert the descriptor into a SAP. The bits all stay the same, we just
652 ;;; change our notion of what we think they are.
653 #!-sb-fluid (declaim (inline descriptor-sap))
654 (defun descriptor-sap (x)
655 (int-sap (get-lisp-obj-address x)))
657 ;;; Return the top frame of the control stack as it was before calling
660 (/noshow0 "entering TOP-FRAME")
661 ;; if we have a stored context in *internal-error-context*, use it
662 ;; to compute the fp and pc (and rebind this variable to nil in case
663 ;; we signal another error), otherwise use the (%caller-frame-and-pc
666 (if sb!kernel::*internal-error-context*
667 (let* ((context sb!kernel::*internal-error-context*)
668 (sb!kernel::*internal-error-context* nil)
669 (alien-context (locally
670 (declare (optimize (inhibit-warnings 3)))
671 (sb!alien:sap-alien context (* os-context-t)))))
672 (compute-calling-frame
673 (int-sap (sb!vm:context-register alien-context
675 (context-pc alien-context) nil))
676 (multiple-value-bind (fp pc) (%caller-frame-and-pc)
677 (compute-calling-frame (descriptor-sap fp) pc nil))))
679 ;;; Flush all of the frames above FRAME, and renumber all the frames
681 (defun flush-frames-above (frame)
682 (setf (frame-up frame) nil)
683 (do ((number 0 (1+ number))
684 (frame frame (frame-%down frame)))
685 ((not (frame-p frame)))
686 (setf (frame-number frame) number)))
688 ;;; Return the frame immediately below FRAME on the stack; or when
689 ;;; FRAME is the bottom of the stack, return NIL.
690 (defun frame-down (frame)
691 (/noshow0 "entering FRAME-DOWN")
692 ;; We have to access the old-fp and return-pc out of frame and pass
693 ;; them to COMPUTE-CALLING-FRAME.
694 (let ((down (frame-%down frame)))
695 (if (eq down :unparsed)
696 (let ((debug-fun (frame-debug-fun frame)))
697 (/noshow0 "in DOWN :UNPARSED case")
698 (setf (frame-%down frame)
701 (let ((c-d-f (compiled-debug-fun-compiler-debug-fun
703 (compute-calling-frame
706 frame ocfp-save-offset
707 (sb!c::compiled-debug-fun-old-fp c-d-f)))
709 frame lra-save-offset
710 (sb!c::compiled-debug-fun-return-pc c-d-f))
713 (let ((fp (frame-pointer frame)))
714 (when (control-stack-pointer-valid-p fp)
716 (multiple-value-bind (ok ra ofp) (x86-call-context fp)
718 (compute-calling-frame ofp ra frame)))
720 (compute-calling-frame
722 (sap-ref-sap fp (* ocfp-save-offset
726 (sap-ref-32 fp (* ocfp-save-offset
727 sb!vm:n-word-bytes)))
729 (stack-ref fp lra-save-offset)
734 ;;; Get the old FP or return PC out of FRAME. STACK-SLOT is the
735 ;;; standard save location offset on the stack. LOC is the saved
736 ;;; SC-OFFSET describing the main location.
737 (defun get-context-value (frame stack-slot loc)
738 (declare (type compiled-frame frame) (type unsigned-byte stack-slot)
739 (type sb!c:sc-offset loc))
740 (let ((pointer (frame-pointer frame))
741 (escaped (compiled-frame-escaped frame)))
743 (sub-access-debug-var-slot pointer loc escaped)
745 (stack-ref pointer stack-slot)
749 (stack-ref pointer stack-slot))
751 (sap-ref-sap pointer (- (* (1+ stack-slot)
752 sb!vm::n-word-bytes))))))))
754 (defun (setf get-context-value) (value frame stack-slot loc)
755 (declare (type compiled-frame frame) (type unsigned-byte stack-slot)
756 (type sb!c:sc-offset loc))
757 (let ((pointer (frame-pointer frame))
758 (escaped (compiled-frame-escaped frame)))
760 (sub-set-debug-var-slot pointer loc value escaped)
762 (setf (stack-ref pointer stack-slot) value)
766 (setf (stack-ref pointer stack-slot) value))
768 (setf (sap-ref-sap pointer (- (* (1+ stack-slot)
769 sb!vm::n-word-bytes))) value))))))
771 (defun foreign-function-backtrace-name (sap)
772 (let ((name (sap-foreign-symbol sap)))
774 (format nil "foreign function: ~A" name)
775 (format nil "foreign function: #x~X" (sap-int sap)))))
777 ;;; This returns a frame for the one existing in time immediately
778 ;;; prior to the frame referenced by current-fp. This is current-fp's
779 ;;; caller or the next frame down the control stack. If there is no
780 ;;; down frame, this returns NIL for the bottom of the stack. UP-FRAME
781 ;;; is the up link for the resulting frame object, and it is null when
782 ;;; we call this to get the top of the stack.
784 ;;; The current frame contains the pointer to the temporally previous
785 ;;; frame we want, and the current frame contains the pc at which we
786 ;;; will continue executing upon returning to that previous frame.
788 ;;; Note: Sometimes LRA is actually a fixnum. This happens when lisp
789 ;;; calls into C. In this case, the code object is stored on the stack
790 ;;; after the LRA, and the LRA is the word offset.
792 (defun compute-calling-frame (caller lra up-frame)
793 (declare (type system-area-pointer caller))
794 (when (control-stack-pointer-valid-p caller)
795 (multiple-value-bind (code pc-offset escaped)
797 (multiple-value-bind (word-offset code)
799 (let ((fp (frame-pointer up-frame)))
801 (stack-ref fp (1+ lra-save-offset))))
802 (values (get-header-data lra)
803 (lra-code-header lra)))
806 (* (1+ (- word-offset (get-header-data code)))
809 (values :foreign-function
812 (find-escaped-frame caller))
813 (if (and (code-component-p code)
814 (eq (%code-debug-info code) :bogus-lra))
815 (let ((real-lra (code-header-ref code real-lra-slot)))
816 (compute-calling-frame caller real-lra up-frame))
817 (let ((d-fun (case code
819 (make-bogus-debug-fun
820 "undefined function"))
822 (make-bogus-debug-fun
823 (foreign-function-backtrace-name
824 (int-sap (get-lisp-obj-address lra)))))
826 (make-bogus-debug-fun
827 "bogus stack frame"))
829 (debug-fun-from-pc code pc-offset)))))
830 (make-compiled-frame caller up-frame d-fun
831 (code-location-from-pc d-fun pc-offset
833 (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 (let ((code-size (* (code-header-ref code
946 sb!vm:code-code-size-slot)
947 sb!vm:n-word-bytes)))
948 (unless (<= 0 pc-offset code-size)
949 ;; We were in an assembly routine.
950 (multiple-value-bind (new-pc-offset computed-return)
951 (find-pc-from-assembly-fun code scp)
952 (setf pc-offset new-pc-offset)
953 (unless (<= 0 pc-offset code-size)
955 "Set PC-OFFSET to zero and continue backtrace."
958 "~@<PC-OFFSET (~D) not in code object. Frame details:~
959 ~2I~:@_PC: #X~X~:@_CODE: ~S~:@_CODE FUN: ~S~:@_LRA: ~
960 #X~X~:@_COMPUTED RETURN: #X~X.~:>"
963 (sap-int (sb!vm:context-pc scp))
965 (%code-entry-points code)
966 (sb!vm:context-register scp sb!vm::lra-offset)
968 ;; We failed to pinpoint where PC is, but set
969 ;; pc-offset to 0 to keep the backtrace from
971 (setf pc-offset 0)))))
973 (if (eq (%code-debug-info code) :bogus-lra)
974 (let ((real-lra (code-header-ref code
976 (values (lra-code-header real-lra)
977 (get-header-data real-lra)
979 (values code pc-offset scp))))))))))
982 (defun find-pc-from-assembly-fun (code scp)
983 "Finds the PC for the return from an assembly routine properly.
984 For some architectures (such as PPC) this will not be the $LRA
986 (let ((return-machine-address (sb!vm::return-machine-address scp))
987 (code-header-len (* (get-header-data code) sb!vm:n-word-bytes)))
988 (values (- return-machine-address
989 (- (get-lisp-obj-address code)
990 sb!vm:other-pointer-lowtag)
992 return-machine-address)))
994 ;;; Find the code object corresponding to the object represented by
995 ;;; bits and return it. We assume bogus functions correspond to the
996 ;;; undefined-function.
998 (defun code-object-from-bits (bits)
999 (declare (type (unsigned-byte 32) bits))
1000 (let ((object (make-lisp-obj bits)))
1001 (if (functionp object)
1002 (or (fun-code-header object)
1003 :undefined-function)
1004 (let ((lowtag (lowtag-of object)))
1005 (when (= lowtag sb!vm:other-pointer-lowtag)
1006 (let ((widetag (widetag-of object)))
1007 (cond ((= widetag sb!vm:code-header-widetag)
1009 ((= widetag sb!vm:return-pc-header-widetag)
1010 (lra-code-header object))
1014 ;;;; frame utilities
1016 ;;; This returns a COMPILED-DEBUG-FUN for COMPONENT and PC. We fetch the
1017 ;;; SB!C::DEBUG-INFO and run down its FUN-MAP to get a
1018 ;;; SB!C::COMPILED-DEBUG-FUN from the PC. The result only needs to
1019 ;;; reference the COMPONENT, for function constants, and the
1020 ;;; SB!C::COMPILED-DEBUG-FUN.
1021 (defun debug-fun-from-pc (component pc)
1022 (let ((info (%code-debug-info component)))
1025 ;; FIXME: It seems that most of these (at least on x86) are
1026 ;; actually assembler routines, and could be named by looking
1027 ;; at the sb-fasl:*assembler-routines*.
1028 (make-bogus-debug-fun "no debug information for frame"))
1029 ((eq info :bogus-lra)
1030 (make-bogus-debug-fun "function end breakpoint"))
1032 (let* ((fun-map (sb!c::compiled-debug-info-fun-map info))
1033 (len (length fun-map)))
1034 (declare (type simple-vector fun-map))
1036 (make-compiled-debug-fun (svref fun-map 0) component)
1039 (>= pc (sb!c::compiled-debug-fun-elsewhere-pc
1040 (svref fun-map 0)))))
1041 (declare (type sb!int:index i))
1044 (< pc (if elsewhere-p
1045 (sb!c::compiled-debug-fun-elsewhere-pc
1046 (svref fun-map (1+ i)))
1047 (svref fun-map i))))
1048 (return (make-compiled-debug-fun
1049 (svref fun-map (1- i))
1053 ;;; This returns a code-location for the COMPILED-DEBUG-FUN,
1054 ;;; DEBUG-FUN, and the pc into its code vector. If we stopped at a
1055 ;;; breakpoint, find the CODE-LOCATION for that breakpoint. Otherwise,
1056 ;;; make an :UNSURE code location, so it can be filled in when we
1057 ;;; figure out what is going on.
1058 (defun code-location-from-pc (debug-fun pc escaped)
1059 (or (and (compiled-debug-fun-p debug-fun)
1061 (let ((data (breakpoint-data
1062 (compiled-debug-fun-component debug-fun)
1064 (when (and data (breakpoint-data-breakpoints data))
1065 (let ((what (breakpoint-what
1066 (first (breakpoint-data-breakpoints data)))))
1067 (when (compiled-code-location-p what)
1069 (make-compiled-code-location pc debug-fun)))
1071 ;;; Return an alist mapping catch tags to CODE-LOCATIONs. These are
1072 ;;; CODE-LOCATIONs at which execution would continue with frame as the
1073 ;;; top frame if someone threw to the corresponding tag.
1074 (defun frame-catches (frame)
1075 (let ((catch (descriptor-sap sb!vm:*current-catch-block*))
1076 (reversed-result nil)
1077 (fp (frame-pointer frame)))
1078 (loop until (zerop (sap-int catch))
1079 finally (return (nreverse reversed-result))
1084 (* sb!vm:catch-block-current-cont-slot
1085 sb!vm:n-word-bytes))
1089 (* sb!vm:catch-block-current-cont-slot
1090 sb!vm:n-word-bytes))))
1091 (let* (#!-(or x86 x86-64)
1092 (lra (stack-ref catch sb!vm:catch-block-entry-pc-slot))
1095 catch (* sb!vm:catch-block-entry-pc-slot
1096 sb!vm:n-word-bytes)))
1099 (stack-ref catch sb!vm:catch-block-current-code-slot))
1101 (component (component-from-component-ptr
1102 (component-ptr-from-pc ra)))
1105 (* (- (1+ (get-header-data lra))
1106 (get-header-data component))
1110 (- (get-lisp-obj-address component)
1111 sb!vm:other-pointer-lowtag)
1112 (* (get-header-data component) sb!vm:n-word-bytes))))
1113 (push (cons #!-(or x86 x86-64)
1114 (stack-ref catch sb!vm:catch-block-tag-slot)
1117 (sap-ref-word catch (* sb!vm:catch-block-tag-slot
1118 sb!vm:n-word-bytes)))
1119 (make-compiled-code-location
1120 offset (frame-debug-fun frame)))
1125 (* sb!vm:catch-block-previous-catch-slot
1126 sb!vm:n-word-bytes))
1130 (* sb!vm:catch-block-previous-catch-slot
1131 sb!vm:n-word-bytes)))))))
1133 ;;; Modify the value of the OLD-TAG catches in FRAME to NEW-TAG
1134 (defun replace-frame-catch-tag (frame old-tag new-tag)
1135 (let ((catch (descriptor-sap sb!vm:*current-catch-block*))
1136 (fp (frame-pointer frame)))
1137 (loop until (zerop (sap-int catch))
1141 (* sb!vm:catch-block-current-cont-slot
1142 sb!vm:n-word-bytes))
1146 (* sb!vm:catch-block-current-cont-slot
1147 sb!vm:n-word-bytes))))
1150 (stack-ref catch sb!vm:catch-block-tag-slot)
1153 (sap-ref-word catch (* sb!vm:catch-block-tag-slot
1154 sb!vm:n-word-bytes)))))
1155 (when (eq current-tag old-tag)
1157 (setf (stack-ref catch sb!vm:catch-block-tag-slot) new-tag)
1159 (setf (sap-ref-word catch (* sb!vm:catch-block-tag-slot
1160 sb!vm:n-word-bytes))
1161 (get-lisp-obj-address new-tag)))))
1165 (* sb!vm:catch-block-previous-catch-slot
1166 sb!vm:n-word-bytes))
1170 (* sb!vm:catch-block-previous-catch-slot
1171 sb!vm:n-word-bytes)))))))
1175 ;;;; operations on DEBUG-FUNs
1177 ;;; Execute the forms in a context with BLOCK-VAR bound to each
1178 ;;; DEBUG-BLOCK in DEBUG-FUN successively. Result is an optional
1179 ;;; form to execute for return values, and DO-DEBUG-FUN-BLOCKS
1180 ;;; returns nil if there is no result form. This signals a
1181 ;;; NO-DEBUG-BLOCKS condition when the DEBUG-FUN lacks
1182 ;;; DEBUG-BLOCK information.
1183 (defmacro do-debug-fun-blocks ((block-var debug-fun &optional result)
1185 (let ((blocks (gensym))
1187 `(let ((,blocks (debug-fun-debug-blocks ,debug-fun)))
1188 (declare (simple-vector ,blocks))
1189 (dotimes (,i (length ,blocks) ,result)
1190 (let ((,block-var (svref ,blocks ,i)))
1193 ;;; Execute body in a context with VAR bound to each DEBUG-VAR in
1194 ;;; DEBUG-FUN. This returns the value of executing result (defaults to
1195 ;;; nil). This may iterate over only some of DEBUG-FUN's variables or
1196 ;;; none depending on debug policy; for example, possibly the
1197 ;;; compilation only preserved argument information.
1198 (defmacro do-debug-fun-vars ((var debug-fun &optional result) &body body)
1199 (let ((vars (gensym))
1201 `(let ((,vars (debug-fun-debug-vars ,debug-fun)))
1202 (declare (type (or null simple-vector) ,vars))
1204 (dotimes (,i (length ,vars) ,result)
1205 (let ((,var (svref ,vars ,i)))
1209 ;;; Return the object of type FUNCTION associated with the DEBUG-FUN,
1210 ;;; or NIL if the function is unavailable or is non-existent as a user
1211 ;;; callable function object.
1212 (defun debug-fun-fun (debug-fun)
1213 (let ((cached-value (debug-fun-%function debug-fun)))
1214 (if (eq cached-value :unparsed)
1215 (setf (debug-fun-%function debug-fun)
1216 (etypecase debug-fun
1219 (compiled-debug-fun-component debug-fun))
1221 (sb!c::compiled-debug-fun-start-pc
1222 (compiled-debug-fun-compiler-debug-fun debug-fun))))
1223 (do ((entry (%code-entry-points component)
1224 (%simple-fun-next entry)))
1227 (sb!c::compiled-debug-fun-start-pc
1228 (compiled-debug-fun-compiler-debug-fun
1229 (fun-debug-fun entry))))
1231 (bogus-debug-fun nil)))
1234 ;;; Return the name of the function represented by DEBUG-FUN. This may
1235 ;;; be a string or a cons; do not assume it is a symbol.
1236 (defun debug-fun-name (debug-fun)
1237 (declare (type debug-fun debug-fun))
1238 (etypecase debug-fun
1240 (sb!c::compiled-debug-fun-name
1241 (compiled-debug-fun-compiler-debug-fun debug-fun)))
1243 (bogus-debug-fun-%name debug-fun))))
1245 ;;; Return a DEBUG-FUN that represents debug information for FUN.
1246 (defun fun-debug-fun (fun)
1247 (declare (type function fun))
1248 (ecase (widetag-of fun)
1249 (#.sb!vm:closure-header-widetag
1250 (fun-debug-fun (%closure-fun fun)))
1251 (#.sb!vm:funcallable-instance-header-widetag
1252 (fun-debug-fun (funcallable-instance-fun fun)))
1253 (#.sb!vm:simple-fun-header-widetag
1254 (let* ((name (%simple-fun-name fun))
1255 (component (fun-code-header fun))
1258 (and (sb!c::compiled-debug-fun-p x)
1259 (eq (sb!c::compiled-debug-fun-name x) name)
1260 (eq (sb!c::compiled-debug-fun-kind x) nil)))
1261 (sb!c::compiled-debug-info-fun-map
1262 (%code-debug-info component)))))
1264 (make-compiled-debug-fun res component)
1265 ;; KLUDGE: comment from CMU CL:
1266 ;; This used to be the non-interpreted branch, but
1267 ;; William wrote it to return the debug-fun of fun's XEP
1268 ;; instead of fun's debug-fun. The above code does this
1269 ;; more correctly, but it doesn't get or eliminate all
1270 ;; appropriate cases. It mostly works, and probably
1271 ;; works for all named functions anyway.
1273 (debug-fun-from-pc component
1274 (* (- (fun-word-offset fun)
1275 (get-header-data component))
1276 sb!vm:n-word-bytes)))))))
1278 ;;; Return the kind of the function, which is one of :OPTIONAL,
1279 ;;; :EXTERNAL, :TOPLEVEL, :CLEANUP, or NIL.
1280 (defun debug-fun-kind (debug-fun)
1281 ;; FIXME: This "is one of" information should become part of the function
1282 ;; declamation, not just a doc string
1283 (etypecase debug-fun
1285 (sb!c::compiled-debug-fun-kind
1286 (compiled-debug-fun-compiler-debug-fun debug-fun)))
1290 ;;; Is there any variable information for DEBUG-FUN?
1291 (defun debug-var-info-available (debug-fun)
1292 (not (not (debug-fun-debug-vars debug-fun))))
1294 ;;; Return a list of DEBUG-VARs in DEBUG-FUN having the same name
1295 ;;; and package as SYMBOL. If SYMBOL is uninterned, then this returns
1296 ;;; a list of DEBUG-VARs without package names and with the same name
1297 ;;; as symbol. The result of this function is limited to the
1298 ;;; availability of variable information in DEBUG-FUN; for
1299 ;;; example, possibly DEBUG-FUN only knows about its arguments.
1300 (defun debug-fun-symbol-vars (debug-fun symbol)
1301 (let ((vars (ambiguous-debug-vars debug-fun (symbol-name symbol)))
1302 (package (and (symbol-package symbol)
1303 (package-name (symbol-package symbol)))))
1304 (delete-if (if (stringp package)
1306 (let ((p (debug-var-package-name var)))
1307 (or (not (stringp p))
1308 (string/= p package))))
1310 (stringp (debug-var-package-name var))))
1313 ;;; Return a list of DEBUG-VARs in DEBUG-FUN whose names contain
1314 ;;; NAME-PREFIX-STRING as an initial substring. The result of this
1315 ;;; function is limited to the availability of variable information in
1316 ;;; debug-fun; for example, possibly debug-fun only knows
1317 ;;; about its arguments.
1318 (defun ambiguous-debug-vars (debug-fun name-prefix-string)
1319 (declare (simple-string name-prefix-string))
1320 (let ((variables (debug-fun-debug-vars debug-fun)))
1321 (declare (type (or null simple-vector) variables))
1323 (let* ((len (length variables))
1324 (prefix-len (length name-prefix-string))
1325 (pos (find-var name-prefix-string variables len))
1328 ;; Find names from pos to variable's len that contain prefix.
1329 (do ((i pos (1+ i)))
1331 (let* ((var (svref variables i))
1332 (name (debug-var-symbol-name var))
1333 (name-len (length name)))
1334 (declare (simple-string name))
1335 (when (/= (or (string/= name-prefix-string name
1336 :end1 prefix-len :end2 name-len)
1341 (setq res (nreverse res)))
1344 ;;; This returns a position in VARIABLES for one containing NAME as an
1345 ;;; initial substring. END is the length of VARIABLES if supplied.
1346 (defun find-var (name variables &optional end)
1347 (declare (simple-vector variables)
1348 (simple-string name))
1349 (let ((name-len (length name)))
1350 (position name variables
1352 (let* ((y (debug-var-symbol-name y))
1354 (declare (simple-string y))
1355 (and (>= y-len name-len)
1356 (string= x y :end1 name-len :end2 name-len))))
1357 :end (or end (length variables)))))
1359 ;;; Return a list representing the lambda-list for DEBUG-FUN. The
1360 ;;; list has the following structure:
1361 ;;; (required-var1 required-var2
1363 ;;; (:optional var3 suppliedp-var4)
1364 ;;; (:optional var5)
1366 ;;; (:rest var6) (:rest var7)
1368 ;;; (:keyword keyword-symbol var8 suppliedp-var9)
1369 ;;; (:keyword keyword-symbol var10)
1372 ;;; Each VARi is a DEBUG-VAR; however it may be the symbol :DELETED if
1373 ;;; it is unreferenced in DEBUG-FUN. This signals a
1374 ;;; LAMBDA-LIST-UNAVAILABLE condition when there is no argument list
1376 (defun debug-fun-lambda-list (debug-fun)
1377 (etypecase debug-fun
1378 (compiled-debug-fun (compiled-debug-fun-lambda-list debug-fun))
1379 (bogus-debug-fun nil)))
1381 ;;; Note: If this has to compute the lambda list, it caches it in DEBUG-FUN.
1382 (defun compiled-debug-fun-lambda-list (debug-fun)
1383 (let ((lambda-list (debug-fun-%lambda-list debug-fun)))
1384 (cond ((eq lambda-list :unparsed)
1385 (multiple-value-bind (args argsp)
1386 (parse-compiled-debug-fun-lambda-list debug-fun)
1387 (setf (debug-fun-%lambda-list debug-fun) args)
1390 (debug-signal 'lambda-list-unavailable
1391 :debug-fun debug-fun))))
1393 ((bogus-debug-fun-p debug-fun)
1395 ((sb!c::compiled-debug-fun-arguments
1396 (compiled-debug-fun-compiler-debug-fun debug-fun))
1397 ;; If the packed information is there (whether empty or not) as
1398 ;; opposed to being nil, then returned our cached value (nil).
1401 ;; Our cached value is nil, and the packed lambda-list information
1402 ;; is nil, so we don't have anything available.
1403 (debug-signal 'lambda-list-unavailable
1404 :debug-fun debug-fun)))))
1406 ;;; COMPILED-DEBUG-FUN-LAMBDA-LIST calls this when a
1407 ;;; COMPILED-DEBUG-FUN has no lambda list information cached. It
1408 ;;; returns the lambda list as the first value and whether there was
1409 ;;; any argument information as the second value. Therefore,
1410 ;;; (VALUES NIL T) means there were no arguments, but (VALUES NIL NIL)
1411 ;;; means there was no argument information.
1412 (defun parse-compiled-debug-fun-lambda-list (debug-fun)
1413 (let ((args (sb!c::compiled-debug-fun-arguments
1414 (compiled-debug-fun-compiler-debug-fun debug-fun))))
1419 (values (coerce (debug-fun-debug-vars debug-fun) 'list)
1422 (let ((vars (debug-fun-debug-vars debug-fun))
1427 (declare (type (or null simple-vector) vars))
1429 (when (>= i len) (return))
1430 (let ((ele (aref args i)))
1435 ;; Deleted required arg at beginning of args array.
1436 (push :deleted res))
1437 (sb!c::optional-args
1440 ;; SUPPLIED-P var immediately following keyword or
1441 ;; optional. Stick the extra var in the result
1442 ;; element representing the keyword or optional,
1443 ;; which is the previous one.
1445 ;; FIXME: NCONC used for side-effect: the effect is defined,
1446 ;; but this is bad style no matter what.
1448 (list (compiled-debug-fun-lambda-list-var
1449 args (incf i) vars))))
1452 (compiled-debug-fun-lambda-list-var
1453 args (incf i) vars))
1456 ;; Just ignore the fact that the next two args are
1457 ;; the &MORE arg context and count, and act like they
1458 ;; are regular arguments.
1462 (push (list :keyword
1464 (compiled-debug-fun-lambda-list-var
1465 args (incf i) vars))
1468 ;; We saw an optional marker, so the following
1469 ;; non-symbols are indexes indicating optional
1471 (push (list :optional (svref vars ele)) res))
1473 ;; Required arg at beginning of args array.
1474 (push (svref vars ele) res))))
1476 (values (nreverse res) t))))))
1478 ;;; This is used in COMPILED-DEBUG-FUN-LAMBDA-LIST.
1479 (defun compiled-debug-fun-lambda-list-var (args i vars)
1480 (declare (type (simple-array * (*)) args)
1481 (simple-vector vars))
1482 (let ((ele (aref args i)))
1483 (cond ((not (symbolp ele)) (svref vars ele))
1484 ((eq ele 'sb!c::deleted) :deleted)
1485 (t (error "malformed arguments description")))))
1487 (defun compiled-debug-fun-debug-info (debug-fun)
1488 (%code-debug-info (compiled-debug-fun-component debug-fun)))
1490 ;;;; unpacking variable and basic block data
1492 (defvar *parsing-buffer*
1493 (make-array 20 :adjustable t :fill-pointer t))
1494 (defvar *other-parsing-buffer*
1495 (make-array 20 :adjustable t :fill-pointer t))
1496 ;;; PARSE-DEBUG-BLOCKS and PARSE-DEBUG-VARS
1497 ;;; use this to unpack binary encoded information. It returns the
1498 ;;; values returned by the last form in body.
1500 ;;; This binds buffer-var to *parsing-buffer*, makes sure it starts at
1501 ;;; element zero, and makes sure if we unwind, we nil out any set
1502 ;;; elements for GC purposes.
1504 ;;; This also binds other-var to *other-parsing-buffer* when it is
1505 ;;; supplied, making sure it starts at element zero and that we nil
1506 ;;; out any elements if we unwind.
1508 ;;; This defines the local macro RESULT that takes a buffer, copies
1509 ;;; its elements to a resulting simple-vector, nil's out elements, and
1510 ;;; restarts the buffer at element zero. RESULT returns the
1512 (eval-when (:compile-toplevel :execute)
1513 (sb!xc:defmacro with-parsing-buffer ((buffer-var &optional other-var)
1515 (let ((len (gensym))
1518 (let ((,buffer-var *parsing-buffer*)
1519 ,@(if other-var `((,other-var *other-parsing-buffer*))))
1520 (setf (fill-pointer ,buffer-var) 0)
1521 ,@(if other-var `((setf (fill-pointer ,other-var) 0)))
1522 (macrolet ((result (buf)
1523 `(let* ((,',len (length ,buf))
1524 (,',res (make-array ,',len)))
1525 (replace ,',res ,buf :end1 ,',len :end2 ,',len)
1526 (fill ,buf nil :end ,',len)
1527 (setf (fill-pointer ,buf) 0)
1530 (fill *parsing-buffer* nil)
1531 ,@(if other-var `((fill *other-parsing-buffer* nil))))))
1534 ;;; The argument is a debug internals structure. This returns the
1535 ;;; DEBUG-BLOCKs for DEBUG-FUN, regardless of whether we have unpacked
1536 ;;; them yet. It signals a NO-DEBUG-BLOCKS condition if it can't
1537 ;;; return the blocks.
1538 (defun debug-fun-debug-blocks (debug-fun)
1539 (let ((blocks (debug-fun-blocks debug-fun)))
1540 (cond ((eq blocks :unparsed)
1541 (setf (debug-fun-blocks debug-fun)
1542 (parse-debug-blocks debug-fun))
1543 (unless (debug-fun-blocks debug-fun)
1544 (debug-signal 'no-debug-blocks
1545 :debug-fun debug-fun))
1546 (debug-fun-blocks debug-fun))
1549 (debug-signal 'no-debug-blocks
1550 :debug-fun debug-fun)))))
1552 ;;; Return a SIMPLE-VECTOR of DEBUG-BLOCKs or NIL. NIL indicates there
1553 ;;; was no basic block information.
1554 (defun parse-debug-blocks (debug-fun)
1555 (etypecase debug-fun
1557 (parse-compiled-debug-blocks debug-fun))
1559 (debug-signal 'no-debug-blocks :debug-fun debug-fun))))
1561 ;;; This does some of the work of PARSE-DEBUG-BLOCKS.
1562 (defun parse-compiled-debug-blocks (debug-fun)
1563 (let* ((var-count (length (debug-fun-debug-vars debug-fun)))
1564 (compiler-debug-fun (compiled-debug-fun-compiler-debug-fun
1566 (blocks (sb!c::compiled-debug-fun-blocks compiler-debug-fun))
1567 ;; KLUDGE: 8 is a hard-wired constant in the compiler for the
1568 ;; element size of the packed binary representation of the
1570 (live-set-len (ceiling var-count 8))
1571 (tlf-number (sb!c::compiled-debug-fun-tlf-number compiler-debug-fun)))
1573 (return-from parse-compiled-debug-blocks nil))
1574 (macrolet ((aref+ (a i) `(prog1 (aref ,a ,i) (incf ,i))))
1575 (with-parsing-buffer (blocks-buffer locations-buffer)
1577 (len (length blocks))
1580 (when (>= i len) (return))
1581 (let ((succ-and-flags (aref+ blocks i))
1583 (declare (type (unsigned-byte 8) succ-and-flags)
1585 (dotimes (k (ldb sb!c::compiled-debug-block-nsucc-byte
1587 (push (sb!c:read-var-integer blocks i) successors))
1589 (dotimes (k (sb!c:read-var-integer blocks i)
1590 (result locations-buffer))
1591 (let ((kind (svref sb!c::*compiled-code-location-kinds*
1594 (sb!c:read-var-integer blocks i)))
1595 (tlf-offset (or tlf-number
1596 (sb!c:read-var-integer blocks i)))
1597 (form-number (sb!c:read-var-integer blocks i))
1598 (live-set (sb!c:read-packed-bit-vector
1599 live-set-len blocks i))
1600 (step-info (sb!c:read-var-string blocks i)))
1601 (vector-push-extend (make-known-code-location
1602 pc debug-fun tlf-offset
1603 form-number live-set kind
1606 (setf last-pc pc))))
1607 (block (make-compiled-debug-block
1608 locations successors
1610 sb!c::compiled-debug-block-elsewhere-p
1611 succ-and-flags))))))
1612 (vector-push-extend block blocks-buffer)
1613 (dotimes (k (length locations))
1614 (setf (code-location-%debug-block (svref locations k))
1616 (let ((res (result blocks-buffer)))
1617 (declare (simple-vector res))
1618 (dotimes (i (length res))
1619 (let* ((block (svref res i))
1621 (dolist (ele (debug-block-successors block))
1622 (push (svref res ele) succs))
1623 (setf (debug-block-successors block) succs)))
1626 ;;; The argument is a debug internals structure. This returns NIL if
1627 ;;; there is no variable information. It returns an empty
1628 ;;; simple-vector if there were no locals in the function. Otherwise
1629 ;;; it returns a SIMPLE-VECTOR of DEBUG-VARs.
1630 (defun debug-fun-debug-vars (debug-fun)
1631 (let ((vars (debug-fun-%debug-vars debug-fun)))
1632 (if (eq vars :unparsed)
1633 (setf (debug-fun-%debug-vars debug-fun)
1634 (etypecase debug-fun
1636 (parse-compiled-debug-vars debug-fun))
1637 (bogus-debug-fun nil)))
1640 ;;; VARS is the parsed variables for a minimal debug function. We need
1641 ;;; to assign names of the form ARG-NNN. We must pad with leading
1642 ;;; zeros, since the arguments must be in alphabetical order.
1643 (defun assign-minimal-var-names (vars)
1644 (declare (simple-vector vars))
1645 (let* ((len (length vars))
1646 (width (length (format nil "~W" (1- len)))))
1648 (without-package-locks
1649 (setf (compiled-debug-var-symbol (svref vars i))
1650 (intern (format nil "ARG-~V,'0D" width i)
1651 ;; KLUDGE: It's somewhat nasty to have a bare
1652 ;; package name string here. It would be
1653 ;; nicer to have #.(FIND-PACKAGE "SB!DEBUG")
1654 ;; instead, since then at least it would transform
1655 ;; correctly under package renaming and stuff.
1656 ;; However, genesis can't handle dumped packages..
1659 ;; FIXME: Maybe this could be fixed by moving the
1660 ;; whole debug-int.lisp file to warm init? (after
1661 ;; which dumping a #.(FIND-PACKAGE ..) expression
1662 ;; would work fine) If this is possible, it would
1663 ;; probably be a good thing, since minimizing the
1664 ;; amount of stuff in cold init is basically good.
1665 (or (find-package "SB-DEBUG")
1666 (find-package "SB!DEBUG"))))))))
1668 ;;; Parse the packed representation of DEBUG-VARs from
1669 ;;; DEBUG-FUN's SB!C::COMPILED-DEBUG-FUN, returning a vector
1670 ;;; of DEBUG-VARs, or NIL if there was no information to parse.
1671 (defun parse-compiled-debug-vars (debug-fun)
1672 (let* ((cdebug-fun (compiled-debug-fun-compiler-debug-fun
1674 (packed-vars (sb!c::compiled-debug-fun-vars cdebug-fun))
1675 (args-minimal (eq (sb!c::compiled-debug-fun-arguments cdebug-fun)
1679 (buffer (make-array 0 :fill-pointer 0 :adjustable t)))
1680 ((>= i (length packed-vars))
1681 (let ((result (coerce buffer 'simple-vector)))
1683 (assign-minimal-var-names result))
1685 (flet ((geti () (prog1 (aref packed-vars i) (incf i))))
1686 (let* ((flags (geti))
1687 (minimal (logtest sb!c::compiled-debug-var-minimal-p flags))
1688 (deleted (logtest sb!c::compiled-debug-var-deleted-p flags))
1689 (live (logtest sb!c::compiled-debug-var-environment-live
1691 (save (logtest sb!c::compiled-debug-var-save-loc-p flags))
1692 (symbol (if minimal nil (geti)))
1693 (id (if (logtest sb!c::compiled-debug-var-id-p flags)
1696 (sc-offset (if deleted 0 (geti)))
1697 (save-sc-offset (if save (geti) nil)))
1698 (aver (not (and args-minimal (not minimal))))
1699 (vector-push-extend (make-compiled-debug-var symbol
1708 ;;; If we're sure of whether code-location is known, return T or NIL.
1709 ;;; If we're :UNSURE, then try to fill in the code-location's slots.
1710 ;;; This determines whether there is any debug-block information, and
1711 ;;; if code-location is known.
1713 ;;; ??? IF this conses closures every time it's called, then break off the
1714 ;;; :UNSURE part to get the HANDLER-CASE into another function.
1715 (defun code-location-unknown-p (basic-code-location)
1716 (ecase (code-location-%unknown-p basic-code-location)
1720 (setf (code-location-%unknown-p basic-code-location)
1721 (handler-case (not (fill-in-code-location basic-code-location))
1722 (no-debug-blocks () t))))))
1724 ;;; Return the DEBUG-BLOCK containing code-location if it is available.
1725 ;;; Some debug policies inhibit debug-block information, and if none
1726 ;;; is available, then this signals a NO-DEBUG-BLOCKS condition.
1727 (defun code-location-debug-block (basic-code-location)
1728 (let ((block (code-location-%debug-block basic-code-location)))
1729 (if (eq block :unparsed)
1730 (etypecase basic-code-location
1731 (compiled-code-location
1732 (compute-compiled-code-location-debug-block basic-code-location))
1733 ;; (There used to be more cases back before sbcl-0.7.0, when
1734 ;; we did special tricks to debug the IR1 interpreter.)
1738 ;;; Store and return BASIC-CODE-LOCATION's debug-block. We determines
1739 ;;; the correct one using the code-location's pc. We use
1740 ;;; DEBUG-FUN-DEBUG-BLOCKS to return the cached block information
1741 ;;; or signal a NO-DEBUG-BLOCKS condition. The blocks are sorted by
1742 ;;; their first code-location's pc, in ascending order. Therefore, as
1743 ;;; soon as we find a block that starts with a pc greater than
1744 ;;; basic-code-location's pc, we know the previous block contains the
1745 ;;; pc. If we get to the last block, then the code-location is either
1746 ;;; in the second to last block or the last block, and we have to be
1747 ;;; careful in determining this since the last block could be code at
1748 ;;; the end of the function. We have to check for the last block being
1749 ;;; code first in order to see how to compare the code-location's pc.
1750 (defun compute-compiled-code-location-debug-block (basic-code-location)
1751 (let* ((pc (compiled-code-location-pc basic-code-location))
1752 (debug-fun (code-location-debug-fun
1753 basic-code-location))
1754 (blocks (debug-fun-debug-blocks debug-fun))
1755 (len (length blocks)))
1756 (declare (simple-vector blocks))
1757 (setf (code-location-%debug-block basic-code-location)
1763 (let ((last (svref blocks end)))
1765 ((debug-block-elsewhere-p last)
1767 (sb!c::compiled-debug-fun-elsewhere-pc
1768 (compiled-debug-fun-compiler-debug-fun
1770 (svref blocks (1- end))
1773 (compiled-code-location-pc
1774 (svref (compiled-debug-block-code-locations last)
1776 (svref blocks (1- end)))
1778 (declare (type index i end))
1780 (compiled-code-location-pc
1781 (svref (compiled-debug-block-code-locations
1784 (return (svref blocks (1- i)))))))))
1786 ;;; Return the CODE-LOCATION's DEBUG-SOURCE.
1787 (defun code-location-debug-source (code-location)
1788 (let ((info (compiled-debug-fun-debug-info
1789 (code-location-debug-fun code-location))))
1790 (or (sb!c::debug-info-source info)
1791 (debug-signal 'no-debug-blocks :debug-fun
1792 (code-location-debug-fun code-location)))))
1794 ;;; Returns the number of top level forms before the one containing
1795 ;;; CODE-LOCATION as seen by the compiler in some compilation unit. (A
1796 ;;; compilation unit is not necessarily a single file, see the section
1797 ;;; on debug-sources.)
1798 (defun code-location-toplevel-form-offset (code-location)
1799 (when (code-location-unknown-p code-location)
1800 (error 'unknown-code-location :code-location code-location))
1801 (let ((tlf-offset (code-location-%tlf-offset code-location)))
1802 (cond ((eq tlf-offset :unparsed)
1803 (etypecase code-location
1804 (compiled-code-location
1805 (unless (fill-in-code-location code-location)
1806 ;; This check should be unnecessary. We're missing
1807 ;; debug info the compiler should have dumped.
1808 (bug "unknown code location"))
1809 (code-location-%tlf-offset code-location))
1810 ;; (There used to be more cases back before sbcl-0.7.0,,
1811 ;; when we did special tricks to debug the IR1
1816 ;;; Return the number of the form corresponding to CODE-LOCATION. The
1817 ;;; form number is derived by a walking the subforms of a top level
1818 ;;; form in depth-first order.
1819 (defun code-location-form-number (code-location)
1820 (when (code-location-unknown-p code-location)
1821 (error 'unknown-code-location :code-location code-location))
1822 (let ((form-num (code-location-%form-number code-location)))
1823 (cond ((eq form-num :unparsed)
1824 (etypecase code-location
1825 (compiled-code-location
1826 (unless (fill-in-code-location code-location)
1827 ;; This check should be unnecessary. We're missing
1828 ;; debug info the compiler should have dumped.
1829 (bug "unknown code location"))
1830 (code-location-%form-number code-location))
1831 ;; (There used to be more cases back before sbcl-0.7.0,,
1832 ;; when we did special tricks to debug the IR1
1837 ;;; Return the kind of CODE-LOCATION, one of:
1838 ;;; :INTERPRETED, :UNKNOWN-RETURN, :KNOWN-RETURN, :INTERNAL-ERROR,
1839 ;;; :NON-LOCAL-EXIT, :BLOCK-START, :CALL-SITE, :SINGLE-VALUE-RETURN,
1840 ;;; :NON-LOCAL-ENTRY
1841 (defun code-location-kind (code-location)
1842 (when (code-location-unknown-p code-location)
1843 (error 'unknown-code-location :code-location code-location))
1844 (etypecase code-location
1845 (compiled-code-location
1846 (let ((kind (compiled-code-location-kind code-location)))
1847 (cond ((not (eq kind :unparsed)) kind)
1848 ((not (fill-in-code-location code-location))
1849 ;; This check should be unnecessary. We're missing
1850 ;; debug info the compiler should have dumped.
1851 (bug "unknown code location"))
1853 (compiled-code-location-kind code-location)))))
1854 ;; (There used to be more cases back before sbcl-0.7.0,,
1855 ;; when we did special tricks to debug the IR1
1859 ;;; This returns CODE-LOCATION's live-set if it is available. If
1860 ;;; there is no debug-block information, this returns NIL.
1861 (defun compiled-code-location-live-set (code-location)
1862 (if (code-location-unknown-p code-location)
1864 (let ((live-set (compiled-code-location-%live-set code-location)))
1865 (cond ((eq live-set :unparsed)
1866 (unless (fill-in-code-location code-location)
1867 ;; This check should be unnecessary. We're missing
1868 ;; debug info the compiler should have dumped.
1870 ;; FIXME: This error and comment happen over and over again.
1871 ;; Make them a shared function.
1872 (bug "unknown code location"))
1873 (compiled-code-location-%live-set code-location))
1876 ;;; true if OBJ1 and OBJ2 are the same place in the code
1877 (defun code-location= (obj1 obj2)
1879 (compiled-code-location
1881 (compiled-code-location
1882 (and (eq (code-location-debug-fun obj1)
1883 (code-location-debug-fun obj2))
1884 (sub-compiled-code-location= obj1 obj2)))
1885 ;; (There used to be more cases back before sbcl-0.7.0,,
1886 ;; when we did special tricks to debug the IR1
1889 ;; (There used to be more cases back before sbcl-0.7.0,,
1890 ;; when we did special tricks to debug IR1-interpreted code.)
1892 (defun sub-compiled-code-location= (obj1 obj2)
1893 (= (compiled-code-location-pc obj1)
1894 (compiled-code-location-pc obj2)))
1896 ;;; Fill in CODE-LOCATION's :UNPARSED slots, returning T or NIL
1897 ;;; depending on whether the code-location was known in its
1898 ;;; DEBUG-FUN's debug-block information. This may signal a
1899 ;;; NO-DEBUG-BLOCKS condition due to DEBUG-FUN-DEBUG-BLOCKS, and
1900 ;;; it assumes the %UNKNOWN-P slot is already set or going to be set.
1901 (defun fill-in-code-location (code-location)
1902 (declare (type compiled-code-location code-location))
1903 (let* ((debug-fun (code-location-debug-fun code-location))
1904 (blocks (debug-fun-debug-blocks debug-fun)))
1905 (declare (simple-vector blocks))
1906 (dotimes (i (length blocks) nil)
1907 (let* ((block (svref blocks i))
1908 (locations (compiled-debug-block-code-locations block)))
1909 (declare (simple-vector locations))
1910 (dotimes (j (length locations))
1911 (let ((loc (svref locations j)))
1912 (when (sub-compiled-code-location= code-location loc)
1913 (setf (code-location-%debug-block code-location) block)
1914 (setf (code-location-%tlf-offset code-location)
1915 (code-location-%tlf-offset loc))
1916 (setf (code-location-%form-number code-location)
1917 (code-location-%form-number loc))
1918 (setf (compiled-code-location-%live-set code-location)
1919 (compiled-code-location-%live-set loc))
1920 (setf (compiled-code-location-kind code-location)
1921 (compiled-code-location-kind loc))
1922 (setf (compiled-code-location-step-info code-location)
1923 (compiled-code-location-step-info loc))
1924 (return-from fill-in-code-location t))))))))
1926 ;;;; operations on DEBUG-BLOCKs
1928 ;;; Execute FORMS in a context with CODE-VAR bound to each
1929 ;;; CODE-LOCATION in DEBUG-BLOCK, and return the value of RESULT.
1930 (defmacro do-debug-block-locations ((code-var debug-block &optional result)
1932 (let ((code-locations (gensym))
1934 `(let ((,code-locations (debug-block-code-locations ,debug-block)))
1935 (declare (simple-vector ,code-locations))
1936 (dotimes (,i (length ,code-locations) ,result)
1937 (let ((,code-var (svref ,code-locations ,i)))
1940 ;;; Return the name of the function represented by DEBUG-FUN.
1941 ;;; This may be a string or a cons; do not assume it is a symbol.
1942 (defun debug-block-fun-name (debug-block)
1943 (etypecase debug-block
1944 (compiled-debug-block
1945 (let ((code-locs (compiled-debug-block-code-locations debug-block)))
1946 (declare (simple-vector code-locs))
1947 (if (zerop (length code-locs))
1948 "??? Can't get name of debug-block's function."
1950 (code-location-debug-fun (svref code-locs 0))))))
1951 ;; (There used to be more cases back before sbcl-0.7.0, when we
1952 ;; did special tricks to debug the IR1 interpreter.)
1955 (defun debug-block-code-locations (debug-block)
1956 (etypecase debug-block
1957 (compiled-debug-block
1958 (compiled-debug-block-code-locations debug-block))
1959 ;; (There used to be more cases back before sbcl-0.7.0, when we
1960 ;; did special tricks to debug the IR1 interpreter.)
1963 ;;;; operations on debug variables
1965 (defun debug-var-symbol-name (debug-var)
1966 (symbol-name (debug-var-symbol debug-var)))
1968 ;;; FIXME: Make sure that this isn't called anywhere that it wouldn't
1969 ;;; be acceptable to have NIL returned, or that it's only called on
1970 ;;; DEBUG-VARs whose symbols have non-NIL packages.
1971 (defun debug-var-package-name (debug-var)
1972 (package-name (symbol-package (debug-var-symbol debug-var))))
1974 ;;; Return the value stored for DEBUG-VAR in frame, or if the value is
1975 ;;; not :VALID, then signal an INVALID-VALUE error.
1976 (defun debug-var-valid-value (debug-var frame)
1977 (unless (eq (debug-var-validity debug-var (frame-code-location frame))
1979 (error 'invalid-value :debug-var debug-var :frame frame))
1980 (debug-var-value debug-var frame))
1982 ;;; Returns the value stored for DEBUG-VAR in frame. The value may be
1983 ;;; invalid. This is SETFable.
1984 (defun debug-var-value (debug-var frame)
1985 (aver (typep frame 'compiled-frame))
1986 (let ((res (access-compiled-debug-var-slot debug-var frame)))
1987 (if (indirect-value-cell-p res)
1988 (value-cell-ref res)
1991 ;;; This returns what is stored for the variable represented by
1992 ;;; DEBUG-VAR relative to the FRAME. This may be an indirect value
1993 ;;; cell if the variable is both closed over and set.
1994 (defun access-compiled-debug-var-slot (debug-var frame)
1995 (declare (optimize (speed 1)))
1996 (let ((escaped (compiled-frame-escaped frame)))
1998 (sub-access-debug-var-slot
1999 (frame-pointer frame)
2000 (compiled-debug-var-sc-offset debug-var)
2002 (sub-access-debug-var-slot
2003 (frame-pointer frame)
2004 (or (compiled-debug-var-save-sc-offset debug-var)
2005 (compiled-debug-var-sc-offset debug-var))))))
2007 ;;; a helper function for working with possibly-invalid values:
2008 ;;; Do (MAKE-LISP-OBJ VAL) only if the value looks valid.
2010 ;;; (Such values can arise in registers on machines with conservative
2011 ;;; GC, and might also arise in debug variable locations when
2012 ;;; those variables are invalid.)
2013 (defun make-valid-lisp-obj (val)
2016 (zerop (logand val sb!vm:fixnum-tag-mask))
2017 ;; immediate single float, 64-bit only
2018 #!+#.(cl:if (cl:= sb!vm::n-machine-word-bits 64) '(and) '(or))
2019 (= (logand val #xff) sb!vm:single-float-widetag)
2021 (and (zerop (logandc2 val #x1fffffff)) ; Top bits zero
2022 (= (logand val #xff) sb!vm:character-widetag)) ; char tag
2024 (= val sb!vm:unbound-marker-widetag)
2026 (and (logbitp 0 val)
2027 ;; Check that the pointer is valid. XXX Could do a better
2028 ;; job. FIXME: e.g. by calling out to an is_valid_pointer
2029 ;; routine in the C runtime support code
2030 (or (< sb!vm:read-only-space-start val
2031 (* sb!vm:*read-only-space-free-pointer*
2032 sb!vm:n-word-bytes))
2033 (< sb!vm:static-space-start val
2034 (* sb!vm:*static-space-free-pointer*
2035 sb!vm:n-word-bytes))
2036 (< (current-dynamic-space-start) val
2037 (sap-int (dynamic-space-free-pointer))))))
2042 (defun sub-access-debug-var-slot (fp sc-offset &optional escaped)
2043 (macrolet ((with-escaped-value ((var) &body forms)
2045 (let ((,var (sb!vm:context-register
2047 (sb!c:sc-offset-offset sc-offset))))
2049 :invalid-value-for-unescaped-register-storage))
2050 (escaped-float-value (format)
2052 (sb!vm:context-float-register
2054 (sb!c:sc-offset-offset sc-offset)
2056 :invalid-value-for-unescaped-register-storage))
2057 (with-nfp ((var) &body body)
2058 `(let ((,var (if escaped
2060 (sb!vm:context-register escaped
2063 (sb!sys:sap-ref-sap fp (* nfp-save-offset
2064 sb!vm:n-word-bytes))
2066 (sb!vm::make-number-stack-pointer
2067 (sb!sys:sap-ref-32 fp (* nfp-save-offset
2068 sb!vm:n-word-bytes))))))
2070 (ecase (sb!c:sc-offset-scn sc-offset)
2071 ((#.sb!vm:any-reg-sc-number
2072 #.sb!vm:descriptor-reg-sc-number
2073 #!+rt #.sb!vm:word-pointer-reg-sc-number)
2074 (sb!sys:without-gcing
2075 (with-escaped-value (val) (sb!kernel:make-lisp-obj val))))
2077 (#.sb!vm:character-reg-sc-number
2078 (with-escaped-value (val)
2080 (#.sb!vm:sap-reg-sc-number
2081 (with-escaped-value (val)
2082 (sb!sys:int-sap val)))
2083 (#.sb!vm:signed-reg-sc-number
2084 (with-escaped-value (val)
2085 (if (logbitp (1- sb!vm:n-word-bits) val)
2086 (logior val (ash -1 sb!vm:n-word-bits))
2088 (#.sb!vm:unsigned-reg-sc-number
2089 (with-escaped-value (val)
2091 (#.sb!vm:non-descriptor-reg-sc-number
2092 (error "Local non-descriptor register access?"))
2093 (#.sb!vm:interior-reg-sc-number
2094 (error "Local interior register access?"))
2095 (#.sb!vm:single-reg-sc-number
2096 (escaped-float-value single-float))
2097 (#.sb!vm:double-reg-sc-number
2098 (escaped-float-value double-float))
2100 (#.sb!vm:long-reg-sc-number
2101 (escaped-float-value long-float))
2102 (#.sb!vm:complex-single-reg-sc-number
2105 (sb!vm:context-float-register
2106 escaped (sb!c:sc-offset-offset sc-offset) 'single-float)
2107 (sb!vm:context-float-register
2108 escaped (1+ (sb!c:sc-offset-offset sc-offset)) 'single-float))
2109 :invalid-value-for-unescaped-register-storage))
2110 (#.sb!vm:complex-double-reg-sc-number
2113 (sb!vm:context-float-register
2114 escaped (sb!c:sc-offset-offset sc-offset) 'double-float)
2115 (sb!vm:context-float-register
2116 escaped (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 2 #!-sparc 1)
2118 :invalid-value-for-unescaped-register-storage))
2120 (#.sb!vm:complex-long-reg-sc-number
2123 (sb!vm:context-float-register
2124 escaped (sb!c:sc-offset-offset sc-offset) 'long-float)
2125 (sb!vm:context-float-register
2126 escaped (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 4)
2128 :invalid-value-for-unescaped-register-storage))
2129 (#.sb!vm:single-stack-sc-number
2131 (sb!sys:sap-ref-single nfp (* (sb!c:sc-offset-offset sc-offset)
2132 sb!vm:n-word-bytes))))
2133 (#.sb!vm:double-stack-sc-number
2135 (sb!sys:sap-ref-double nfp (* (sb!c:sc-offset-offset sc-offset)
2136 sb!vm:n-word-bytes))))
2138 (#.sb!vm:long-stack-sc-number
2140 (sb!sys:sap-ref-long nfp (* (sb!c:sc-offset-offset sc-offset)
2141 sb!vm:n-word-bytes))))
2142 (#.sb!vm:complex-single-stack-sc-number
2145 (sb!sys:sap-ref-single nfp (* (sb!c:sc-offset-offset sc-offset)
2146 sb!vm:n-word-bytes))
2147 (sb!sys:sap-ref-single nfp (* (1+ (sb!c:sc-offset-offset sc-offset))
2148 sb!vm:n-word-bytes)))))
2149 (#.sb!vm:complex-double-stack-sc-number
2152 (sb!sys:sap-ref-double nfp (* (sb!c:sc-offset-offset sc-offset)
2153 sb!vm:n-word-bytes))
2154 (sb!sys:sap-ref-double nfp (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2155 sb!vm:n-word-bytes)))))
2157 (#.sb!vm:complex-long-stack-sc-number
2160 (sb!sys:sap-ref-long nfp (* (sb!c:sc-offset-offset sc-offset)
2161 sb!vm:n-word-bytes))
2162 (sb!sys:sap-ref-long nfp (* (+ (sb!c:sc-offset-offset sc-offset)
2164 sb!vm:n-word-bytes)))))
2165 (#.sb!vm:control-stack-sc-number
2166 (sb!kernel:stack-ref fp (sb!c:sc-offset-offset sc-offset)))
2167 (#.sb!vm:character-stack-sc-number
2169 (code-char (sb!sys:sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2170 sb!vm:n-word-bytes)))))
2171 (#.sb!vm:unsigned-stack-sc-number
2173 (sb!sys:sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2174 sb!vm:n-word-bytes))))
2175 (#.sb!vm:signed-stack-sc-number
2177 (sb!sys:signed-sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2178 sb!vm:n-word-bytes))))
2179 (#.sb!vm:sap-stack-sc-number
2181 (sb!sys:sap-ref-sap nfp (* (sb!c:sc-offset-offset sc-offset)
2182 sb!vm:n-word-bytes)))))))
2185 (defun sub-access-debug-var-slot (fp sc-offset &optional escaped)
2186 (declare (type system-area-pointer fp))
2187 (macrolet ((with-escaped-value ((var) &body forms)
2189 (let ((,var (sb!vm:context-register
2191 (sb!c:sc-offset-offset sc-offset))))
2193 :invalid-value-for-unescaped-register-storage))
2194 (escaped-float-value (format)
2196 (sb!vm:context-float-register
2197 escaped (sb!c:sc-offset-offset sc-offset) ',format)
2198 :invalid-value-for-unescaped-register-storage))
2199 (escaped-complex-float-value (format)
2202 (sb!vm:context-float-register
2203 escaped (sb!c:sc-offset-offset sc-offset) ',format)
2204 (sb!vm:context-float-register
2205 escaped (1+ (sb!c:sc-offset-offset sc-offset)) ',format))
2206 :invalid-value-for-unescaped-register-storage)))
2207 (ecase (sb!c:sc-offset-scn sc-offset)
2208 ((#.sb!vm:any-reg-sc-number #.sb!vm:descriptor-reg-sc-number)
2210 (with-escaped-value (val)
2211 (make-valid-lisp-obj val))))
2212 (#.sb!vm:character-reg-sc-number
2213 (with-escaped-value (val)
2215 (#.sb!vm:sap-reg-sc-number
2216 (with-escaped-value (val)
2218 (#.sb!vm:signed-reg-sc-number
2219 (with-escaped-value (val)
2220 (if (logbitp (1- sb!vm:n-word-bits) val)
2221 (logior val (ash -1 sb!vm:n-word-bits))
2223 (#.sb!vm:unsigned-reg-sc-number
2224 (with-escaped-value (val)
2226 (#.sb!vm:single-reg-sc-number
2227 (escaped-float-value single-float))
2228 (#.sb!vm:double-reg-sc-number
2229 (escaped-float-value double-float))
2231 (#.sb!vm:long-reg-sc-number
2232 (escaped-float-value long-float))
2233 (#.sb!vm:complex-single-reg-sc-number
2234 (escaped-complex-float-value single-float))
2235 (#.sb!vm:complex-double-reg-sc-number
2236 (escaped-complex-float-value double-float))
2238 (#.sb!vm:complex-long-reg-sc-number
2239 (escaped-complex-float-value long-float))
2240 (#.sb!vm:single-stack-sc-number
2241 (sap-ref-single fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2242 sb!vm:n-word-bytes))))
2243 (#.sb!vm:double-stack-sc-number
2244 (sap-ref-double fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2245 sb!vm:n-word-bytes))))
2247 (#.sb!vm:long-stack-sc-number
2248 (sap-ref-long fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2249 sb!vm:n-word-bytes))))
2250 (#.sb!vm:complex-single-stack-sc-number
2252 (sap-ref-single fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2253 sb!vm:n-word-bytes)))
2254 (sap-ref-single fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2255 sb!vm:n-word-bytes)))))
2256 (#.sb!vm:complex-double-stack-sc-number
2258 (sap-ref-double fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2259 sb!vm:n-word-bytes)))
2260 (sap-ref-double fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 4)
2261 sb!vm:n-word-bytes)))))
2263 (#.sb!vm:complex-long-stack-sc-number
2265 (sap-ref-long fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2266 sb!vm:n-word-bytes)))
2267 (sap-ref-long fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 6)
2268 sb!vm:n-word-bytes)))))
2269 (#.sb!vm:control-stack-sc-number
2270 (stack-ref fp (sb!c:sc-offset-offset sc-offset)))
2271 (#.sb!vm:character-stack-sc-number
2273 (sap-ref-word fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2274 sb!vm:n-word-bytes)))))
2275 (#.sb!vm:unsigned-stack-sc-number
2276 (sap-ref-word fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2277 sb!vm:n-word-bytes))))
2278 (#.sb!vm:signed-stack-sc-number
2279 (signed-sap-ref-word fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2280 sb!vm:n-word-bytes))))
2281 (#.sb!vm:sap-stack-sc-number
2282 (sap-ref-sap fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2283 sb!vm:n-word-bytes)))))))
2285 ;;; This stores value as the value of DEBUG-VAR in FRAME. In the
2286 ;;; COMPILED-DEBUG-VAR case, access the current value to determine if
2287 ;;; it is an indirect value cell. This occurs when the variable is
2288 ;;; both closed over and set.
2289 (defun %set-debug-var-value (debug-var frame new-value)
2290 (aver (typep frame 'compiled-frame))
2291 (let ((old-value (access-compiled-debug-var-slot debug-var frame)))
2292 (if (indirect-value-cell-p old-value)
2293 (value-cell-set old-value new-value)
2294 (set-compiled-debug-var-slot debug-var frame new-value)))
2297 ;;; This stores VALUE for the variable represented by debug-var
2298 ;;; relative to the frame. This assumes the location directly contains
2299 ;;; the variable's value; that is, there is no indirect value cell
2300 ;;; currently there in case the variable is both closed over and set.
2301 (defun set-compiled-debug-var-slot (debug-var frame value)
2302 (let ((escaped (compiled-frame-escaped frame)))
2304 (sub-set-debug-var-slot (frame-pointer frame)
2305 (compiled-debug-var-sc-offset debug-var)
2307 (sub-set-debug-var-slot
2308 (frame-pointer frame)
2309 (or (compiled-debug-var-save-sc-offset debug-var)
2310 (compiled-debug-var-sc-offset debug-var))
2314 (defun sub-set-debug-var-slot (fp sc-offset value &optional escaped)
2315 (macrolet ((set-escaped-value (val)
2317 (setf (sb!vm:context-register
2319 (sb!c:sc-offset-offset sc-offset))
2322 (set-escaped-float-value (format val)
2324 (setf (sb!vm:context-float-register
2326 (sb!c:sc-offset-offset sc-offset)
2330 (with-nfp ((var) &body body)
2331 `(let ((,var (if escaped
2333 (sb!vm:context-register escaped
2338 sb!vm:n-word-bytes))
2340 (sb!vm::make-number-stack-pointer
2343 sb!vm:n-word-bytes))))))
2345 (ecase (sb!c:sc-offset-scn sc-offset)
2346 ((#.sb!vm:any-reg-sc-number
2347 #.sb!vm:descriptor-reg-sc-number
2348 #!+rt #.sb!vm:word-pointer-reg-sc-number)
2351 (get-lisp-obj-address value))))
2352 (#.sb!vm:character-reg-sc-number
2353 (set-escaped-value (char-code value)))
2354 (#.sb!vm:sap-reg-sc-number
2355 (set-escaped-value (sap-int value)))
2356 (#.sb!vm:signed-reg-sc-number
2357 (set-escaped-value (logand value (1- (ash 1 sb!vm:n-word-bits)))))
2358 (#.sb!vm:unsigned-reg-sc-number
2359 (set-escaped-value value))
2360 (#.sb!vm:non-descriptor-reg-sc-number
2361 (error "Local non-descriptor register access?"))
2362 (#.sb!vm:interior-reg-sc-number
2363 (error "Local interior register access?"))
2364 (#.sb!vm:single-reg-sc-number
2365 (set-escaped-float-value single-float value))
2366 (#.sb!vm:double-reg-sc-number
2367 (set-escaped-float-value double-float value))
2369 (#.sb!vm:long-reg-sc-number
2370 (set-escaped-float-value long-float value))
2371 (#.sb!vm:complex-single-reg-sc-number
2373 (setf (sb!vm:context-float-register escaped
2374 (sb!c:sc-offset-offset sc-offset)
2377 (setf (sb!vm:context-float-register
2378 escaped (1+ (sb!c:sc-offset-offset sc-offset))
2382 (#.sb!vm:complex-double-reg-sc-number
2384 (setf (sb!vm:context-float-register
2385 escaped (sb!c:sc-offset-offset sc-offset) 'double-float)
2387 (setf (sb!vm:context-float-register
2389 (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 2 #!-sparc 1)
2394 (#.sb!vm:complex-long-reg-sc-number
2396 (setf (sb!vm:context-float-register
2397 escaped (sb!c:sc-offset-offset sc-offset) 'long-float)
2399 (setf (sb!vm:context-float-register
2401 (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 4)
2405 (#.sb!vm:single-stack-sc-number
2407 (setf (sap-ref-single nfp (* (sb!c:sc-offset-offset sc-offset)
2408 sb!vm:n-word-bytes))
2409 (the single-float value))))
2410 (#.sb!vm:double-stack-sc-number
2412 (setf (sap-ref-double nfp (* (sb!c:sc-offset-offset sc-offset)
2413 sb!vm:n-word-bytes))
2414 (the double-float value))))
2416 (#.sb!vm:long-stack-sc-number
2418 (setf (sap-ref-long nfp (* (sb!c:sc-offset-offset sc-offset)
2419 sb!vm:n-word-bytes))
2420 (the long-float value))))
2421 (#.sb!vm:complex-single-stack-sc-number
2423 (setf (sap-ref-single
2424 nfp (* (sb!c:sc-offset-offset sc-offset) sb!vm:n-word-bytes))
2425 (the single-float (realpart value)))
2426 (setf (sap-ref-single
2427 nfp (* (1+ (sb!c:sc-offset-offset sc-offset))
2428 sb!vm:n-word-bytes))
2429 (the single-float (realpart value)))))
2430 (#.sb!vm:complex-double-stack-sc-number
2432 (setf (sap-ref-double
2433 nfp (* (sb!c:sc-offset-offset sc-offset) sb!vm:n-word-bytes))
2434 (the double-float (realpart value)))
2435 (setf (sap-ref-double
2436 nfp (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2437 sb!vm:n-word-bytes))
2438 (the double-float (realpart value)))))
2440 (#.sb!vm:complex-long-stack-sc-number
2443 nfp (* (sb!c:sc-offset-offset sc-offset) sb!vm:n-word-bytes))
2444 (the long-float (realpart value)))
2446 nfp (* (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 4)
2447 sb!vm:n-word-bytes))
2448 (the long-float (realpart value)))))
2449 (#.sb!vm:control-stack-sc-number
2450 (setf (stack-ref fp (sb!c:sc-offset-offset sc-offset)) value))
2451 (#.sb!vm:character-stack-sc-number
2453 (setf (sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2454 sb!vm:n-word-bytes))
2455 (char-code (the character value)))))
2456 (#.sb!vm:unsigned-stack-sc-number
2458 (setf (sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2459 sb!vm:n-word-bytes))
2460 (the (unsigned-byte 32) value))))
2461 (#.sb!vm:signed-stack-sc-number
2463 (setf (signed-sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2464 sb!vm:n-word-bytes))
2465 (the (signed-byte 32) value))))
2466 (#.sb!vm:sap-stack-sc-number
2468 (setf (sap-ref-sap nfp (* (sb!c:sc-offset-offset sc-offset)
2469 sb!vm:n-word-bytes))
2470 (the system-area-pointer value)))))))
2473 (defun sub-set-debug-var-slot (fp sc-offset value &optional escaped)
2474 (macrolet ((set-escaped-value (val)
2476 (setf (sb!vm:context-register
2478 (sb!c:sc-offset-offset sc-offset))
2481 (ecase (sb!c:sc-offset-scn sc-offset)
2482 ((#.sb!vm:any-reg-sc-number #.sb!vm:descriptor-reg-sc-number)
2485 (get-lisp-obj-address value))))
2486 (#.sb!vm:character-reg-sc-number
2487 (set-escaped-value (char-code value)))
2488 (#.sb!vm:sap-reg-sc-number
2489 (set-escaped-value (sap-int value)))
2490 (#.sb!vm:signed-reg-sc-number
2491 (set-escaped-value (logand value (1- (ash 1 sb!vm:n-word-bits)))))
2492 (#.sb!vm:unsigned-reg-sc-number
2493 (set-escaped-value value))
2494 (#.sb!vm:single-reg-sc-number
2495 #+nil ;; don't have escaped floats.
2496 (set-escaped-float-value single-float value))
2497 (#.sb!vm:double-reg-sc-number
2498 #+nil ;; don't have escaped floats -- still in npx?
2499 (set-escaped-float-value double-float value))
2501 (#.sb!vm:long-reg-sc-number
2502 #+nil ;; don't have escaped floats -- still in npx?
2503 (set-escaped-float-value long-float value))
2504 (#.sb!vm:single-stack-sc-number
2505 (setf (sap-ref-single
2506 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2507 sb!vm:n-word-bytes)))
2508 (the single-float value)))
2509 (#.sb!vm:double-stack-sc-number
2510 (setf (sap-ref-double
2511 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2512 sb!vm:n-word-bytes)))
2513 (the double-float value)))
2515 (#.sb!vm:long-stack-sc-number
2517 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2518 sb!vm:n-word-bytes)))
2519 (the long-float value)))
2520 (#.sb!vm:complex-single-stack-sc-number
2521 (setf (sap-ref-single
2522 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2523 sb!vm:n-word-bytes)))
2524 (realpart (the (complex single-float) value)))
2525 (setf (sap-ref-single
2526 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2527 sb!vm:n-word-bytes)))
2528 (imagpart (the (complex single-float) value))))
2529 (#.sb!vm:complex-double-stack-sc-number
2530 (setf (sap-ref-double
2531 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2532 sb!vm:n-word-bytes)))
2533 (realpart (the (complex double-float) value)))
2534 (setf (sap-ref-double
2535 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 4)
2536 sb!vm:n-word-bytes)))
2537 (imagpart (the (complex double-float) value))))
2539 (#.sb!vm:complex-long-stack-sc-number
2541 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2542 sb!vm:n-word-bytes)))
2543 (realpart (the (complex long-float) value)))
2545 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 6)
2546 sb!vm:n-word-bytes)))
2547 (imagpart (the (complex long-float) value))))
2548 (#.sb!vm:control-stack-sc-number
2549 (setf (stack-ref fp (sb!c:sc-offset-offset sc-offset)) value))
2550 (#.sb!vm:character-stack-sc-number
2551 (setf (sap-ref-word fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2552 sb!vm:n-word-bytes)))
2553 (char-code (the character value))))
2554 (#.sb!vm:unsigned-stack-sc-number
2555 (setf (sap-ref-word fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2556 sb!vm:n-word-bytes)))
2557 (the sb!vm:word value)))
2558 (#.sb!vm:signed-stack-sc-number
2559 (setf (signed-sap-ref-word
2560 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2561 sb!vm:n-word-bytes)))
2562 (the (signed-byte #.sb!vm:n-word-bits) value)))
2563 (#.sb!vm:sap-stack-sc-number
2564 (setf (sap-ref-sap fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2565 sb!vm:n-word-bytes)))
2566 (the system-area-pointer value))))))
2568 ;;; The method for setting and accessing COMPILED-DEBUG-VAR values use
2569 ;;; this to determine if the value stored is the actual value or an
2570 ;;; indirection cell.
2571 (defun indirect-value-cell-p (x)
2572 (and (= (lowtag-of x) sb!vm:other-pointer-lowtag)
2573 (= (widetag-of x) sb!vm:value-cell-header-widetag)))
2575 ;;; Return three values reflecting the validity of DEBUG-VAR's value
2576 ;;; at BASIC-CODE-LOCATION:
2577 ;;; :VALID The value is known to be available.
2578 ;;; :INVALID The value is known to be unavailable.
2579 ;;; :UNKNOWN The value's availability is unknown.
2581 ;;; If the variable is always alive, then it is valid. If the
2582 ;;; code-location is unknown, then the variable's validity is
2583 ;;; :unknown. Once we've called CODE-LOCATION-UNKNOWN-P, we know the
2584 ;;; live-set information has been cached in the code-location.
2585 (defun debug-var-validity (debug-var basic-code-location)
2586 (etypecase debug-var
2588 (compiled-debug-var-validity debug-var basic-code-location))
2589 ;; (There used to be more cases back before sbcl-0.7.0, when
2590 ;; we did special tricks to debug the IR1 interpreter.)
2593 ;;; This is the method for DEBUG-VAR-VALIDITY for COMPILED-DEBUG-VARs.
2594 ;;; For safety, make sure basic-code-location is what we think.
2595 (defun compiled-debug-var-validity (debug-var basic-code-location)
2596 (declare (type compiled-code-location basic-code-location))
2597 (cond ((debug-var-alive-p debug-var)
2598 (let ((debug-fun (code-location-debug-fun basic-code-location)))
2599 (if (>= (compiled-code-location-pc basic-code-location)
2600 (sb!c::compiled-debug-fun-start-pc
2601 (compiled-debug-fun-compiler-debug-fun debug-fun)))
2604 ((code-location-unknown-p basic-code-location) :unknown)
2606 (let ((pos (position debug-var
2607 (debug-fun-debug-vars
2608 (code-location-debug-fun
2609 basic-code-location)))))
2611 (error 'unknown-debug-var
2612 :debug-var debug-var
2614 (code-location-debug-fun basic-code-location)))
2615 ;; There must be live-set info since basic-code-location is known.
2616 (if (zerop (sbit (compiled-code-location-live-set
2617 basic-code-location)
2624 ;;; This code produces and uses what we call source-paths. A
2625 ;;; source-path is a list whose first element is a form number as
2626 ;;; returned by CODE-LOCATION-FORM-NUMBER and whose last element is a
2627 ;;; top level form number as returned by
2628 ;;; CODE-LOCATION-TOPLEVEL-FORM-NUMBER. The elements from the last to
2629 ;;; the first, exclusively, are the numbered subforms into which to
2630 ;;; descend. For example:
2632 ;;; (let ((a (aref x 3)))
2634 ;;; The call to AREF in this example is form number 5. Assuming this
2635 ;;; DEFUN is the 11'th top level form, the source-path for the AREF
2636 ;;; call is as follows:
2638 ;;; Given the DEFUN, 3 gets you the LET, 1 gets you the bindings, 0
2639 ;;; gets the first binding, and 1 gets the AREF form.
2641 ;;; temporary buffer used to build form-number => source-path translation in
2642 ;;; FORM-NUMBER-TRANSLATIONS
2643 (defvar *form-number-temp* (make-array 10 :fill-pointer 0 :adjustable t))
2645 ;;; table used to detect CAR circularities in FORM-NUMBER-TRANSLATIONS
2646 (defvar *form-number-circularity-table* (make-hash-table :test 'eq))
2648 ;;; This returns a table mapping form numbers to source-paths. A
2649 ;;; source-path indicates a descent into the TOPLEVEL-FORM form,
2650 ;;; going directly to the subform corressponding to the form number.
2652 ;;; The vector elements are in the same format as the compiler's
2653 ;;; NODE-SOURCE-PATH; that is, the first element is the form number and
2654 ;;; the last is the TOPLEVEL-FORM number.
2655 (defun form-number-translations (form tlf-number)
2656 (clrhash *form-number-circularity-table*)
2657 (setf (fill-pointer *form-number-temp*) 0)
2658 (sub-translate-form-numbers form (list tlf-number))
2659 (coerce *form-number-temp* 'simple-vector))
2660 (defun sub-translate-form-numbers (form path)
2661 (unless (gethash form *form-number-circularity-table*)
2662 (setf (gethash form *form-number-circularity-table*) t)
2663 (vector-push-extend (cons (fill-pointer *form-number-temp*) path)
2668 (declare (fixnum pos))
2671 (when (atom subform) (return))
2672 (let ((fm (car subform)))
2674 (sub-translate-form-numbers fm (cons pos path)))
2676 (setq subform (cdr subform))
2677 (when (eq subform trail) (return)))))
2681 (setq trail (cdr trail)))))))
2683 ;;; FORM is a top level form, and path is a source-path into it. This
2684 ;;; returns the form indicated by the source-path. Context is the
2685 ;;; number of enclosing forms to return instead of directly returning
2686 ;;; the source-path form. When context is non-zero, the form returned
2687 ;;; contains a marker, #:****HERE****, immediately before the form
2688 ;;; indicated by path.
2689 (defun source-path-context (form path context)
2690 (declare (type unsigned-byte context))
2691 ;; Get to the form indicated by path or the enclosing form indicated
2692 ;; by context and path.
2693 (let ((path (reverse (butlast (cdr path)))))
2694 (dotimes (i (- (length path) context))
2695 (let ((index (first path)))
2696 (unless (and (listp form) (< index (length form)))
2697 (error "Source path no longer exists."))
2698 (setq form (elt form index))
2699 (setq path (rest path))))
2700 ;; Recursively rebuild the source form resulting from the above
2701 ;; descent, copying the beginning of each subform up to the next
2702 ;; subform we descend into according to path. At the bottom of the
2703 ;; recursion, we return the form indicated by path preceded by our
2704 ;; marker, and this gets spliced into the resulting list structure
2705 ;; on the way back up.
2706 (labels ((frob (form path level)
2707 (if (or (zerop level) (null path))
2710 `(#:***here*** ,form))
2711 (let ((n (first path)))
2712 (unless (and (listp form) (< n (length form)))
2713 (error "Source path no longer exists."))
2714 (let ((res (frob (elt form n) (rest path) (1- level))))
2715 (nconc (subseq form 0 n)
2716 (cons res (nthcdr (1+ n) form))))))))
2717 (frob form path context))))
2719 ;;;; PREPROCESS-FOR-EVAL
2721 ;;; Return a function of one argument that evaluates form in the
2722 ;;; lexical context of the BASIC-CODE-LOCATION LOC, or signal a
2723 ;;; NO-DEBUG-VARS condition when the LOC's DEBUG-FUN has no
2724 ;;; DEBUG-VAR information available.
2726 ;;; The returned function takes the frame to get values from as its
2727 ;;; argument, and it returns the values of FORM. The returned function
2728 ;;; can signal the following conditions: INVALID-VALUE,
2729 ;;; AMBIGUOUS-VAR-NAME, and FRAME-FUN-MISMATCH.
2730 (defun preprocess-for-eval (form loc)
2731 (declare (type code-location loc))
2732 (let ((n-frame (gensym))
2733 (fun (code-location-debug-fun loc)))
2734 (unless (debug-var-info-available fun)
2735 (debug-signal 'no-debug-vars :debug-fun fun))
2736 (sb!int:collect ((binds)
2738 (do-debug-fun-vars (var fun)
2739 (let ((validity (debug-var-validity var loc)))
2740 (unless (eq validity :invalid)
2741 (let* ((sym (debug-var-symbol var))
2742 (found (assoc sym (binds))))
2744 (setf (second found) :ambiguous)
2745 (binds (list sym validity var)))))))
2746 (dolist (bind (binds))
2747 (let ((name (first bind))
2749 (ecase (second bind)
2751 (specs `(,name (debug-var-value ',var ,n-frame))))
2753 (specs `(,name (debug-signal 'invalid-value
2757 (specs `(,name (debug-signal 'ambiguous-var-name
2759 :frame ,n-frame)))))))
2760 (let ((res (coerce `(lambda (,n-frame)
2761 (declare (ignorable ,n-frame))
2762 (symbol-macrolet ,(specs) ,form))
2765 ;; This prevents these functions from being used in any
2766 ;; location other than a function return location, so maybe
2767 ;; this should only check whether FRAME's DEBUG-FUN is the
2769 (unless (code-location= (frame-code-location frame) loc)
2770 (debug-signal 'frame-fun-mismatch
2771 :code-location loc :form form :frame frame))
2772 (funcall res frame))))))
2776 ;;;; user-visible interface
2778 ;;; Create and return a breakpoint. When program execution encounters
2779 ;;; the breakpoint, the system calls HOOK-FUN. HOOK-FUN takes the
2780 ;;; current frame for the function in which the program is running and
2781 ;;; the breakpoint object.
2783 ;;; WHAT and KIND determine where in a function the system invokes
2784 ;;; HOOK-FUN. WHAT is either a code-location or a DEBUG-FUN. KIND is
2785 ;;; one of :CODE-LOCATION, :FUN-START, or :FUN-END. Since the starts
2786 ;;; and ends of functions may not have code-locations representing
2787 ;;; them, designate these places by supplying WHAT as a DEBUG-FUN and
2788 ;;; KIND indicating the :FUN-START or :FUN-END. When WHAT is a
2789 ;;; DEBUG-FUN and kind is :FUN-END, then HOOK-FUN must take two
2790 ;;; additional arguments, a list of values returned by the function
2791 ;;; and a FUN-END-COOKIE.
2793 ;;; INFO is information supplied by and used by the user.
2795 ;;; FUN-END-COOKIE is a function. To implement :FUN-END
2796 ;;; breakpoints, the system uses starter breakpoints to establish the
2797 ;;; :FUN-END breakpoint for each invocation of the function. Upon
2798 ;;; each entry, the system creates a unique cookie to identify the
2799 ;;; invocation, and when the user supplies a function for this
2800 ;;; argument, the system invokes it on the frame and the cookie. The
2801 ;;; system later invokes the :FUN-END breakpoint hook on the same
2802 ;;; cookie. The user may save the cookie for comparison in the hook
2805 ;;; Signal an error if WHAT is an unknown code-location.
2806 (defun make-breakpoint (hook-fun what
2807 &key (kind :code-location) info fun-end-cookie)
2810 (when (code-location-unknown-p what)
2811 (error "cannot make a breakpoint at an unknown code location: ~S"
2813 (aver (eq kind :code-location))
2814 (let ((bpt (%make-breakpoint hook-fun what kind info)))
2816 (compiled-code-location
2817 ;; This slot is filled in due to calling CODE-LOCATION-UNKNOWN-P.
2818 (when (eq (compiled-code-location-kind what) :unknown-return)
2819 (let ((other-bpt (%make-breakpoint hook-fun what
2820 :unknown-return-partner
2822 (setf (breakpoint-unknown-return-partner bpt) other-bpt)
2823 (setf (breakpoint-unknown-return-partner other-bpt) bpt))))
2824 ;; (There used to be more cases back before sbcl-0.7.0,,
2825 ;; when we did special tricks to debug the IR1
2832 (%make-breakpoint hook-fun what kind info))
2834 (unless (eq (sb!c::compiled-debug-fun-returns
2835 (compiled-debug-fun-compiler-debug-fun what))
2837 (error ":FUN-END breakpoints are currently unsupported ~
2838 for the known return convention."))
2840 (let* ((bpt (%make-breakpoint hook-fun what kind info))
2841 (starter (compiled-debug-fun-end-starter what)))
2843 (setf starter (%make-breakpoint #'list what :fun-start nil))
2844 (setf (breakpoint-hook-fun starter)
2845 (fun-end-starter-hook starter what))
2846 (setf (compiled-debug-fun-end-starter what) starter))
2847 (setf (breakpoint-start-helper bpt) starter)
2848 (push bpt (breakpoint-%info starter))
2849 (setf (breakpoint-cookie-fun bpt) fun-end-cookie)
2852 ;;; These are unique objects created upon entry into a function by a
2853 ;;; :FUN-END breakpoint's starter hook. These are only created
2854 ;;; when users supply :FUN-END-COOKIE to MAKE-BREAKPOINT. Also,
2855 ;;; the :FUN-END breakpoint's hook is called on the same cookie
2856 ;;; when it is created.
2857 (defstruct (fun-end-cookie
2858 (:print-object (lambda (obj str)
2859 (print-unreadable-object (obj str :type t))))
2860 (:constructor make-fun-end-cookie (bogus-lra debug-fun))
2862 ;; a pointer to the bogus-lra created for :FUN-END breakpoints
2864 ;; the DEBUG-FUN associated with this cookie
2867 ;;; This maps bogus-lra-components to cookies, so that
2868 ;;; HANDLE-FUN-END-BREAKPOINT can find the appropriate cookie for the
2869 ;;; breakpoint hook.
2870 (defvar *fun-end-cookies* (make-hash-table :test 'eq))
2872 ;;; This returns a hook function for the start helper breakpoint
2873 ;;; associated with a :FUN-END breakpoint. The returned function
2874 ;;; makes a fake LRA that all returns go through, and this piece of
2875 ;;; fake code actually breaks. Upon return from the break, the code
2876 ;;; provides the returnee with any values. Since the returned function
2877 ;;; effectively activates FUN-END-BPT on each entry to DEBUG-FUN's
2878 ;;; function, we must establish breakpoint-data about FUN-END-BPT.
2879 (defun fun-end-starter-hook (starter-bpt debug-fun)
2880 (declare (type breakpoint starter-bpt)
2881 (type compiled-debug-fun debug-fun))
2882 (lambda (frame breakpoint)
2883 (declare (ignore breakpoint)
2885 (let ((lra-sc-offset
2886 (sb!c::compiled-debug-fun-return-pc
2887 (compiled-debug-fun-compiler-debug-fun debug-fun))))
2888 (multiple-value-bind (lra component offset)
2890 (get-context-value frame
2893 (setf (get-context-value frame
2897 (let ((end-bpts (breakpoint-%info starter-bpt)))
2898 (let ((data (breakpoint-data component offset)))
2899 (setf (breakpoint-data-breakpoints data) end-bpts)
2900 (dolist (bpt end-bpts)
2901 (setf (breakpoint-internal-data bpt) data)))
2902 (let ((cookie (make-fun-end-cookie lra debug-fun)))
2903 (setf (gethash component *fun-end-cookies*) cookie)
2904 (dolist (bpt end-bpts)
2905 (let ((fun (breakpoint-cookie-fun bpt)))
2906 (when fun (funcall fun frame cookie))))))))))
2908 ;;; This takes a FUN-END-COOKIE and a frame, and it returns
2909 ;;; whether the cookie is still valid. A cookie becomes invalid when
2910 ;;; the frame that established the cookie has exited. Sometimes cookie
2911 ;;; holders are unaware of cookie invalidation because their
2912 ;;; :FUN-END breakpoint hooks didn't run due to THROW'ing.
2914 ;;; This takes a frame as an efficiency hack since the user probably
2915 ;;; has a frame object in hand when using this routine, and it saves
2916 ;;; repeated parsing of the stack and consing when asking whether a
2917 ;;; series of cookies is valid.
2918 (defun fun-end-cookie-valid-p (frame cookie)
2919 (let ((lra (fun-end-cookie-bogus-lra cookie))
2920 (lra-sc-offset (sb!c::compiled-debug-fun-return-pc
2921 (compiled-debug-fun-compiler-debug-fun
2922 (fun-end-cookie-debug-fun cookie)))))
2923 (do ((frame frame (frame-down frame)))
2925 (when (and (compiled-frame-p frame)
2926 (#!-(or x86 x86-64) eq #!+(or x86 x86-64) sap=
2928 (get-context-value frame lra-save-offset lra-sc-offset)))
2931 ;;;; ACTIVATE-BREAKPOINT
2933 ;;; Cause the system to invoke the breakpoint's hook function until
2934 ;;; the next call to DEACTIVATE-BREAKPOINT or DELETE-BREAKPOINT. The
2935 ;;; system invokes breakpoint hook functions in the opposite order
2936 ;;; that you activate them.
2937 (defun activate-breakpoint (breakpoint)
2938 (when (eq (breakpoint-status breakpoint) :deleted)
2939 (error "cannot activate a deleted breakpoint: ~S" breakpoint))
2940 (unless (eq (breakpoint-status breakpoint) :active)
2941 (ecase (breakpoint-kind breakpoint)
2943 (let ((loc (breakpoint-what breakpoint)))
2945 (compiled-code-location
2946 (activate-compiled-code-location-breakpoint breakpoint)
2947 (let ((other (breakpoint-unknown-return-partner breakpoint)))
2949 (activate-compiled-code-location-breakpoint other))))
2950 ;; (There used to be more cases back before sbcl-0.7.0, when
2951 ;; we did special tricks to debug the IR1 interpreter.)
2954 (etypecase (breakpoint-what breakpoint)
2956 (activate-compiled-fun-start-breakpoint breakpoint))
2957 ;; (There used to be more cases back before sbcl-0.7.0, when
2958 ;; we did special tricks to debug the IR1 interpreter.)
2961 (etypecase (breakpoint-what breakpoint)
2963 (let ((starter (breakpoint-start-helper breakpoint)))
2964 (unless (eq (breakpoint-status starter) :active)
2965 ;; may already be active by some other :FUN-END breakpoint
2966 (activate-compiled-fun-start-breakpoint starter)))
2967 (setf (breakpoint-status breakpoint) :active))
2968 ;; (There used to be more cases back before sbcl-0.7.0, when
2969 ;; we did special tricks to debug the IR1 interpreter.)
2973 (defun activate-compiled-code-location-breakpoint (breakpoint)
2974 (declare (type breakpoint breakpoint))
2975 (let ((loc (breakpoint-what breakpoint)))
2976 (declare (type compiled-code-location loc))
2977 (sub-activate-breakpoint
2979 (breakpoint-data (compiled-debug-fun-component
2980 (code-location-debug-fun loc))
2981 (+ (compiled-code-location-pc loc)
2982 (if (or (eq (breakpoint-kind breakpoint)
2983 :unknown-return-partner)
2984 (eq (compiled-code-location-kind loc)
2985 :single-value-return))
2986 sb!vm:single-value-return-byte-offset
2989 (defun activate-compiled-fun-start-breakpoint (breakpoint)
2990 (declare (type breakpoint breakpoint))
2991 (let ((debug-fun (breakpoint-what breakpoint)))
2992 (sub-activate-breakpoint
2994 (breakpoint-data (compiled-debug-fun-component debug-fun)
2995 (sb!c::compiled-debug-fun-start-pc
2996 (compiled-debug-fun-compiler-debug-fun
2999 (defun sub-activate-breakpoint (breakpoint data)
3000 (declare (type breakpoint breakpoint)
3001 (type breakpoint-data data))
3002 (setf (breakpoint-status breakpoint) :active)
3004 (unless (breakpoint-data-breakpoints data)
3005 (setf (breakpoint-data-instruction data)
3007 (breakpoint-install (get-lisp-obj-address
3008 (breakpoint-data-component data))
3009 (breakpoint-data-offset data)))))
3010 (setf (breakpoint-data-breakpoints data)
3011 (append (breakpoint-data-breakpoints data) (list breakpoint)))
3012 (setf (breakpoint-internal-data breakpoint) data)))
3014 ;;;; DEACTIVATE-BREAKPOINT
3016 ;;; Stop the system from invoking the breakpoint's hook function.
3017 (defun deactivate-breakpoint (breakpoint)
3018 (when (eq (breakpoint-status breakpoint) :active)
3020 (let ((loc (breakpoint-what breakpoint)))
3022 ((or compiled-code-location compiled-debug-fun)
3023 (deactivate-compiled-breakpoint breakpoint)
3024 (let ((other (breakpoint-unknown-return-partner breakpoint)))
3026 (deactivate-compiled-breakpoint other))))
3027 ;; (There used to be more cases back before sbcl-0.7.0, when
3028 ;; we did special tricks to debug the IR1 interpreter.)
3032 (defun deactivate-compiled-breakpoint (breakpoint)
3033 (if (eq (breakpoint-kind breakpoint) :fun-end)
3034 (let ((starter (breakpoint-start-helper breakpoint)))
3035 (unless (find-if (lambda (bpt)
3036 (and (not (eq bpt breakpoint))
3037 (eq (breakpoint-status bpt) :active)))
3038 (breakpoint-%info starter))
3039 (deactivate-compiled-breakpoint starter)))
3040 (let* ((data (breakpoint-internal-data breakpoint))
3041 (bpts (delete breakpoint (breakpoint-data-breakpoints data))))
3042 (setf (breakpoint-internal-data breakpoint) nil)
3043 (setf (breakpoint-data-breakpoints data) bpts)
3046 (breakpoint-remove (get-lisp-obj-address
3047 (breakpoint-data-component data))
3048 (breakpoint-data-offset data)
3049 (breakpoint-data-instruction data)))
3050 (delete-breakpoint-data data))))
3051 (setf (breakpoint-status breakpoint) :inactive)
3054 ;;;; BREAKPOINT-INFO
3056 ;;; Return the user-maintained info associated with breakpoint. This
3058 (defun breakpoint-info (breakpoint)
3059 (breakpoint-%info breakpoint))
3060 (defun %set-breakpoint-info (breakpoint value)
3061 (setf (breakpoint-%info breakpoint) value)
3062 (let ((other (breakpoint-unknown-return-partner breakpoint)))
3064 (setf (breakpoint-%info other) value))))
3066 ;;;; BREAKPOINT-ACTIVE-P and DELETE-BREAKPOINT
3068 (defun breakpoint-active-p (breakpoint)
3069 (ecase (breakpoint-status breakpoint)
3071 ((:inactive :deleted) nil)))
3073 ;;; Free system storage and remove computational overhead associated
3074 ;;; with breakpoint. After calling this, breakpoint is completely
3075 ;;; impotent and can never become active again.
3076 (defun delete-breakpoint (breakpoint)
3077 (let ((status (breakpoint-status breakpoint)))
3078 (unless (eq status :deleted)
3079 (when (eq status :active)
3080 (deactivate-breakpoint breakpoint))
3081 (setf (breakpoint-status breakpoint) :deleted)
3082 (let ((other (breakpoint-unknown-return-partner breakpoint)))
3084 (setf (breakpoint-status other) :deleted)))
3085 (when (eq (breakpoint-kind breakpoint) :fun-end)
3086 (let* ((starter (breakpoint-start-helper breakpoint))
3087 (breakpoints (delete breakpoint
3088 (the list (breakpoint-info starter)))))
3089 (setf (breakpoint-info starter) breakpoints)
3091 (delete-breakpoint starter)
3092 (setf (compiled-debug-fun-end-starter
3093 (breakpoint-what breakpoint))
3097 ;;;; C call out stubs
3099 ;;; This actually installs the break instruction in the component. It
3100 ;;; returns the overwritten bits. You must call this in a context in
3101 ;;; which GC is disabled, so that Lisp doesn't move objects around
3102 ;;; that C is pointing to.
3103 (sb!alien:define-alien-routine "breakpoint_install" sb!alien:unsigned-int
3104 (code-obj sb!alien:unsigned-long)
3105 (pc-offset sb!alien:int))
3107 ;;; This removes the break instruction and replaces the original
3108 ;;; instruction. You must call this in a context in which GC is disabled
3109 ;;; so Lisp doesn't move objects around that C is pointing to.
3110 (sb!alien:define-alien-routine "breakpoint_remove" sb!alien:void
3111 (code-obj sb!alien:unsigned-long)
3112 (pc-offset sb!alien:int)
3113 (old-inst sb!alien:unsigned-int))
3115 (sb!alien:define-alien-routine "breakpoint_do_displaced_inst" sb!alien:void
3116 (scp (* os-context-t))
3117 (orig-inst sb!alien:unsigned-int))
3119 ;;;; breakpoint handlers (layer between C and exported interface)
3121 ;;; This maps components to a mapping of offsets to BREAKPOINT-DATAs.
3122 (defvar *component-breakpoint-offsets* (make-hash-table :test 'eq))
3124 ;;; This returns the BREAKPOINT-DATA object associated with component cross
3125 ;;; offset. If none exists, this makes one, installs it, and returns it.
3126 (defun breakpoint-data (component offset &optional (create t))
3127 (flet ((install-breakpoint-data ()
3129 (let ((data (make-breakpoint-data component offset)))
3130 (push (cons offset data)
3131 (gethash component *component-breakpoint-offsets*))
3133 (let ((offsets (gethash component *component-breakpoint-offsets*)))
3135 (let ((data (assoc offset offsets)))
3138 (install-breakpoint-data)))
3139 (install-breakpoint-data)))))
3141 ;;; We use this when there are no longer any active breakpoints
3142 ;;; corresponding to DATA.
3143 (defun delete-breakpoint-data (data)
3144 (let* ((component (breakpoint-data-component data))
3145 (offsets (delete (breakpoint-data-offset data)
3146 (gethash component *component-breakpoint-offsets*)
3149 (setf (gethash component *component-breakpoint-offsets*) offsets)
3150 (remhash component *component-breakpoint-offsets*)))
3153 ;;; The C handler for interrupts calls this when it has a
3154 ;;; debugging-tool break instruction. This does *not* handle all
3155 ;;; breaks; for example, it does not handle breaks for internal
3157 (defun handle-breakpoint (offset component signal-context)
3158 (let ((data (breakpoint-data component offset nil)))
3160 (error "unknown breakpoint in ~S at offset ~S"
3161 (debug-fun-name (debug-fun-from-pc component offset))
3163 (let ((breakpoints (breakpoint-data-breakpoints data)))
3164 (if (or (null breakpoints)
3165 (eq (breakpoint-kind (car breakpoints)) :fun-end))
3166 (handle-fun-end-breakpoint-aux breakpoints data signal-context)
3167 (handle-breakpoint-aux breakpoints data
3168 offset component signal-context)))))
3170 ;;; This holds breakpoint-datas while invoking the breakpoint hooks
3171 ;;; associated with that particular component and location. While they
3172 ;;; are executing, if we hit the location again, we ignore the
3173 ;;; breakpoint to avoid infinite recursion. fun-end breakpoints
3174 ;;; must work differently since the breakpoint-data is unique for each
3176 (defvar *executing-breakpoint-hooks* nil)
3178 ;;; This handles code-location and DEBUG-FUN :FUN-START
3180 (defun handle-breakpoint-aux (breakpoints data offset component signal-context)
3182 (bug "breakpoint that nobody wants"))
3183 (unless (member data *executing-breakpoint-hooks*)
3184 (let ((*executing-breakpoint-hooks* (cons data
3185 *executing-breakpoint-hooks*)))
3186 (invoke-breakpoint-hooks breakpoints signal-context)))
3187 ;; At this point breakpoints may not hold the same list as
3188 ;; BREAKPOINT-DATA-BREAKPOINTS since invoking hooks may have allowed
3189 ;; a breakpoint deactivation. In fact, if all breakpoints were
3190 ;; deactivated then data is invalid since it was deleted and so the
3191 ;; correct one must be looked up if it is to be used. If there are
3192 ;; no more breakpoints active at this location, then the normal
3193 ;; instruction has been put back, and we do not need to
3194 ;; DO-DISPLACED-INST.
3195 (setf data (breakpoint-data component offset nil))
3196 (when (and data (breakpoint-data-breakpoints data))
3197 ;; The breakpoint is still active, so we need to execute the
3198 ;; displaced instruction and leave the breakpoint instruction
3199 ;; behind. The best way to do this is different on each machine,
3200 ;; so we just leave it up to the C code.
3201 (breakpoint-do-displaced-inst signal-context
3202 (breakpoint-data-instruction data))
3203 ;; Some platforms have no usable sigreturn() call. If your
3204 ;; implementation of arch_do_displaced_inst() _does_ sigreturn(),
3205 ;; it's polite to warn here
3206 #!+(and sparc solaris)
3207 (error "BREAKPOINT-DO-DISPLACED-INST returned?")))
3209 (defun invoke-breakpoint-hooks (breakpoints signal-context)
3210 (let* ((frame (signal-context-frame signal-context)))
3211 (dolist (bpt breakpoints)
3212 (funcall (breakpoint-hook-fun bpt)
3214 ;; If this is an :UNKNOWN-RETURN-PARTNER, then pass the
3215 ;; hook function the original breakpoint, so that users
3216 ;; aren't forced to confront the fact that some
3217 ;; breakpoints really are two.
3218 (if (eq (breakpoint-kind bpt) :unknown-return-partner)
3219 (breakpoint-unknown-return-partner bpt)
3222 (defun signal-context-frame (signal-context)
3225 (declare (optimize (inhibit-warnings 3)))
3226 (sb!alien:sap-alien signal-context (* os-context-t))))
3227 (cfp (int-sap (sb!vm:context-register scp sb!vm::cfp-offset))))
3228 (compute-calling-frame cfp
3229 (sb!vm:context-pc scp)
3232 (defun handle-fun-end-breakpoint (offset component context)
3233 (let ((data (breakpoint-data component offset nil)))
3235 (error "unknown breakpoint in ~S at offset ~S"
3236 (debug-fun-name (debug-fun-from-pc component offset))
3238 (let ((breakpoints (breakpoint-data-breakpoints data)))
3240 (aver (eq (breakpoint-kind (car breakpoints)) :fun-end))
3241 (handle-fun-end-breakpoint-aux breakpoints data context)))))
3243 ;;; Either HANDLE-BREAKPOINT calls this for :FUN-END breakpoints
3244 ;;; [old C code] or HANDLE-FUN-END-BREAKPOINT calls this directly
3246 (defun handle-fun-end-breakpoint-aux (breakpoints data signal-context)
3247 (delete-breakpoint-data data)
3250 (declare (optimize (inhibit-warnings 3)))
3251 (sb!alien:sap-alien signal-context (* os-context-t))))
3252 (frame (signal-context-frame signal-context))
3253 (component (breakpoint-data-component data))
3254 (cookie (gethash component *fun-end-cookies*)))
3255 (remhash component *fun-end-cookies*)
3256 (dolist (bpt breakpoints)
3257 (funcall (breakpoint-hook-fun bpt)
3259 (get-fun-end-breakpoint-values scp)
3262 (defun get-fun-end-breakpoint-values (scp)
3263 (let ((ocfp (int-sap (sb!vm:context-register
3265 #!-(or x86 x86-64) sb!vm::ocfp-offset
3266 #!+(or x86 x86-64) sb!vm::ebx-offset)))
3267 (nargs (make-lisp-obj
3268 (sb!vm:context-register scp sb!vm::nargs-offset)))
3269 (reg-arg-offsets '#.sb!vm::*register-arg-offsets*)
3272 (dotimes (arg-num nargs)
3273 (push (if reg-arg-offsets
3275 (sb!vm:context-register scp (pop reg-arg-offsets)))
3276 (stack-ref ocfp arg-num))
3278 (nreverse results)))
3280 ;;;; MAKE-BOGUS-LRA (used for :FUN-END breakpoints)
3282 (defconstant bogus-lra-constants
3283 #!-(or x86 x86-64) 2 #!+(or x86 x86-64) 3)
3284 (defconstant known-return-p-slot
3285 (+ sb!vm:code-constants-offset #!-(or x86 x86-64) 1 #!+(or x86 x86-64) 2))
3287 ;;; Make a bogus LRA object that signals a breakpoint trap when
3288 ;;; returned to. If the breakpoint trap handler returns, REAL-LRA is
3289 ;;; returned to. Three values are returned: the bogus LRA object, the
3290 ;;; code component it is part of, and the PC offset for the trap
3292 (defun make-bogus-lra (real-lra &optional known-return-p)
3294 ;; These are really code labels, not variables: but this way we get
3296 (let* ((src-start (foreign-symbol-sap "fun_end_breakpoint_guts"))
3297 (src-end (foreign-symbol-sap "fun_end_breakpoint_end"))
3298 (trap-loc (foreign-symbol-sap "fun_end_breakpoint_trap"))
3299 (length (sap- src-end src-start))
3301 (%primitive sb!c:allocate-code-object (1+ bogus-lra-constants)
3303 (dst-start (code-instructions code-object)))
3304 (declare (type system-area-pointer
3305 src-start src-end dst-start trap-loc)
3306 (type index length))
3307 (setf (%code-debug-info code-object) :bogus-lra)
3308 (setf (code-header-ref code-object sb!vm:code-trace-table-offset-slot)
3311 (setf (code-header-ref code-object real-lra-slot) real-lra)
3313 (multiple-value-bind (offset code) (compute-lra-data-from-pc real-lra)
3314 (setf (code-header-ref code-object real-lra-slot) code)
3315 (setf (code-header-ref code-object (1+ real-lra-slot)) offset))
3316 (setf (code-header-ref code-object known-return-p-slot)
3318 (system-area-ub8-copy src-start 0 dst-start 0 length)
3319 (sb!vm:sanctify-for-execution code-object)
3321 (values dst-start code-object (sap- trap-loc src-start))
3323 (let ((new-lra (make-lisp-obj (+ (sap-int dst-start)
3324 sb!vm:other-pointer-lowtag))))
3327 (logandc2 (+ sb!vm:code-constants-offset bogus-lra-constants 1)
3329 (sb!vm:sanctify-for-execution code-object)
3330 (values new-lra code-object (sap- trap-loc src-start))))))
3334 ;;; This appears here because it cannot go with the DEBUG-FUN
3335 ;;; interface since DO-DEBUG-BLOCK-LOCATIONS isn't defined until after
3336 ;;; the DEBUG-FUN routines.
3338 ;;; Return a code-location before the body of a function and after all
3339 ;;; the arguments are in place; or if that location can't be
3340 ;;; determined due to a lack of debug information, return NIL.
3341 (defun debug-fun-start-location (debug-fun)
3342 (etypecase debug-fun
3344 (code-location-from-pc debug-fun
3345 (sb!c::compiled-debug-fun-start-pc
3346 (compiled-debug-fun-compiler-debug-fun
3349 ;; (There used to be more cases back before sbcl-0.7.0, when
3350 ;; we did special tricks to debug the IR1 interpreter.)
3354 ;;;; Single-stepping
3356 ;;; The single-stepper works by inserting conditional trap instructions
3357 ;;; into the generated code (see src/compiler/*/call.lisp), currently:
3359 ;;; 1) Before the code generated for a function call that was
3360 ;;; translated to a VOP
3361 ;;; 2) Just before the call instruction for a full call
3363 ;;; In both cases, the trap will only be executed if stepping has been
3364 ;;; enabled, in which case it'll ultimately be handled by
3365 ;;; HANDLE-SINGLE-STEP-TRAP, which will either signal a stepping condition,
3366 ;;; or replace the function that's about to be called with a wrapper
3367 ;;; which will signal the condition.
3369 (defun handle-single-step-trap (context-sap kind callee-register-offset)
3370 (let ((context (sb!alien:sap-alien context-sap (* os-context-t))))
3371 ;; The following calls must get tail-call eliminated for
3372 ;; *STEP-FRAME* to get set correctly on non-x86.
3373 (if (= kind single-step-before-trap)
3374 (handle-single-step-before-trap context)
3375 (handle-single-step-around-trap context callee-register-offset))))
3377 (defvar *step-frame* nil)
3379 (defun handle-single-step-before-trap (context)
3380 (let ((step-info (single-step-info-from-context context)))
3381 ;; If there was not enough debug information available, there's no
3382 ;; sense in signaling the condition.
3386 (signal-context-frame (sb!alien::alien-sap context))
3388 ;; KLUDGE: Use the first non-foreign frame as the
3389 ;; *STACK-TOP-HINT*. Getting the frame from the signal
3390 ;; context as on x86 would be cleaner, but
3391 ;; SIGNAL-CONTEXT-FRAME doesn't seem seem to work at all
3393 (loop with frame = (frame-down (top-frame))
3395 for dfun = (frame-debug-fun frame)
3396 do (when (typep dfun 'compiled-debug-fun)
3398 do (setf frame (frame-down frame)))))
3399 (sb!impl::step-form step-info
3400 ;; We could theoretically store information in
3401 ;; the debug-info about to determine the
3402 ;; arguments here, but for now let's just pass
3406 ;;; This function will replace the fdefn / function that was in the
3407 ;;; register at CALLEE-REGISTER-OFFSET with a wrapper function. To
3408 ;;; ensure that the full call will use the wrapper instead of the
3409 ;;; original, conditional trap must be emitted before the fdefn /
3410 ;;; function is converted into a raw address.
3411 (defun handle-single-step-around-trap (context callee-register-offset)
3412 ;; Fetch the function / fdefn we're about to call from the
3413 ;; appropriate register.
3414 (let* ((callee (sb!kernel::make-lisp-obj
3415 (context-register context callee-register-offset)))
3416 (step-info (single-step-info-from-context context)))
3417 ;; If there was not enough debug information available, there's no
3418 ;; sense in signaling the condition.
3420 (return-from handle-single-step-around-trap))
3421 (let* ((fun (lambda (&rest args)
3423 (apply (typecase callee
3424 (fdefn (fdefn-fun callee))
3427 ;; Signal a step condition
3429 (let ((*step-frame* (frame-down (top-frame))))
3430 (sb!impl::step-form step-info args))))
3431 ;; And proceed based on its return value.
3433 ;; STEP-INTO was selected. Use *STEP-OUT* to
3434 ;; let the stepper know that selecting the
3435 ;; STEP-OUT restart is valid inside this
3436 (let ((sb!impl::*step-out* :maybe))
3437 ;; Pass the return values of the call to
3438 ;; STEP-VALUES, which will signal a
3439 ;; condition with them in the VALUES slot.
3441 (multiple-value-call #'sb!impl::step-values
3444 ;; If the user selected the STEP-OUT
3445 ;; restart during the call, resume
3447 (when (eq sb!impl::*step-out* t)
3448 (sb!impl::enable-stepping))))
3449 ;; STEP-NEXT / CONTINUE / OUT selected:
3450 ;; Disable the stepper for the duration of
3452 (sb!impl::with-stepping-disabled
3454 (new-callee (etypecase callee
3456 (let ((fdefn (make-fdefn (gensym))))
3457 (setf (fdefn-fun fdefn) fun)
3460 ;; And then store the wrapper in the same place.
3461 (setf (context-register context callee-register-offset)
3462 (get-lisp-obj-address new-callee)))))
3464 ;;; Given a signal context, fetch the step-info that's been stored in
3465 ;;; the debug info at the trap point.
3466 (defun single-step-info-from-context (context)
3467 (multiple-value-bind (pc-offset code)
3468 (compute-lra-data-from-pc (context-pc context))
3469 (let* ((debug-fun (debug-fun-from-pc code pc-offset))
3470 (location (code-location-from-pc debug-fun
3475 (fill-in-code-location location)
3476 (code-location-debug-source location)
3477 (compiled-code-location-step-info location))
3481 ;;; Return the frame that triggered a single-step condition. Used to
3482 ;;; provide a *STACK-TOP-HINT*.
3483 (defun find-stepped-frame ()