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) #b11)))
530 #!+stack-grows-downward-not-upward
531 (and (sap>= x (current-sp))
532 (sap> control-stack-end x)
533 (zerop (logand (sap-int x) #b11)))))
535 (sb!alien:define-alien-routine component-ptr-from-pc (system-area-pointer)
536 (pc system-area-pointer))
538 (defun component-from-component-ptr (component-ptr)
539 (declare (type system-area-pointer component-ptr))
540 (make-lisp-obj (logior (sap-int component-ptr)
541 sb!vm:other-pointer-lowtag)))
543 ;;;; (OR X86 X86-64) support
545 (defun compute-lra-data-from-pc (pc)
546 (declare (type system-area-pointer pc))
547 (let ((component-ptr (component-ptr-from-pc pc)))
548 (unless (sap= component-ptr (int-sap #x0))
549 (let* ((code (component-from-component-ptr component-ptr))
550 (code-header-len (* (get-header-data code) sb!vm:n-word-bytes))
551 (pc-offset (- (sap-int pc)
552 (- (get-lisp-obj-address code)
553 sb!vm:other-pointer-lowtag)
555 ; (format t "c-lra-fpc ~A ~A ~A~%" pc code pc-offset)
556 (values pc-offset code)))))
561 (defconstant sb!vm::nargs-offset #.sb!vm::ecx-offset)
563 ;;; Check for a valid return address - it could be any valid C/Lisp
566 ;;; XXX Could be a little smarter.
567 #!-sb-fluid (declaim (inline ra-pointer-valid-p))
568 (defun ra-pointer-valid-p (ra)
569 (declare (type system-area-pointer ra))
571 ;; not the first page (which is unmapped)
573 ;; FIXME: Where is this documented? Is it really true of every CPU
574 ;; architecture? Is it even necessarily true in current SBCL?
575 (>= (sap-int ra) 4096)
576 ;; not a Lisp stack pointer
577 (not (control-stack-pointer-valid-p ra))))
579 ;;; Try to find a valid previous stack. This is complex on the x86 as
580 ;;; it can jump between C and Lisp frames. To help find a valid frame
581 ;;; it searches backwards.
583 ;;; XXX Should probably check whether it has reached the bottom of the
586 ;;; XXX Should handle interrupted frames, both Lisp and C. At present
587 ;;; it manages to find a fp trail, see linux hack below.
588 (defun x86-call-context (fp &key (depth 0))
589 (declare (type system-area-pointer fp)
591 ;; (format t "*CC ~S ~S~%" fp depth)
593 ((not (control-stack-pointer-valid-p fp))
594 #+nil (format t "debug invalid fp ~S~%" fp)
597 ;; Check the two possible frame pointers.
598 (let ((lisp-ocfp (sap-ref-sap fp (- (* (1+ ocfp-save-offset)
599 sb!vm::n-word-bytes))))
600 (lisp-ra (sap-ref-sap fp (- (* (1+ return-pc-save-offset)
601 sb!vm::n-word-bytes))))
602 (c-ocfp (sap-ref-sap fp (* 0 sb!vm:n-word-bytes)))
603 (c-ra (sap-ref-sap fp (* 1 sb!vm:n-word-bytes))))
604 #+nil (format t " lisp-ocfp=~S~% lisp-ra=~S~% c-ocfp=~S~% c-ra=~S~%"
605 lisp-ocfp lisp-ra c-ocfp c-ra)
606 (cond ((and (sap> lisp-ocfp fp) (control-stack-pointer-valid-p lisp-ocfp)
607 (ra-pointer-valid-p lisp-ra)
608 (sap> c-ocfp fp) (control-stack-pointer-valid-p c-ocfp)
609 (ra-pointer-valid-p c-ra))
611 "*C Both valid ~S ~S ~S ~S~%"
612 lisp-ocfp lisp-ra c-ocfp c-ra)
613 ;; Look forward another step to check their validity.
614 (let ((lisp-path-fp (x86-call-context lisp-ocfp
616 (c-path-fp (x86-call-context c-ocfp :depth (1+ depth))))
617 (cond ((and lisp-path-fp c-path-fp)
618 ;; Both still seem valid - choose the lisp frame.
619 #+nil (when (zerop depth)
621 "debug: both still valid ~S ~S ~S ~S~%"
622 lisp-ocfp lisp-ra c-ocfp c-ra))
624 (if (sap> lisp-ocfp c-ocfp)
625 (values lisp-ra lisp-ocfp)
626 (values c-ra c-ocfp))
628 (values lisp-ra lisp-ocfp))
630 ;; The lisp convention is looking good.
631 #+nil (format t "*C lisp-ocfp ~S ~S~%" lisp-ocfp lisp-ra)
632 (values lisp-ra lisp-ocfp))
634 ;; The C convention is looking good.
635 #+nil (format t "*C c-ocfp ~S ~S~%" c-ocfp c-ra)
636 (values c-ra c-ocfp))
638 ;; Neither seems right?
639 #+nil (format t "debug: no valid2 fp found ~S ~S~%"
642 ((and (sap> lisp-ocfp fp) (control-stack-pointer-valid-p lisp-ocfp)
643 (ra-pointer-valid-p lisp-ra))
644 ;; The lisp convention is looking good.
645 #+nil (format t "*C lisp-ocfp ~S ~S~%" lisp-ocfp lisp-ra)
646 (values lisp-ra lisp-ocfp))
647 ((and (sap> c-ocfp fp) (control-stack-pointer-valid-p c-ocfp)
648 #!-linux (ra-pointer-valid-p c-ra))
649 ;; The C convention is looking good.
650 #+nil (format t "*C c-ocfp ~S ~S~%" c-ocfp c-ra)
651 (values c-ra c-ocfp))
653 #+nil (format t "debug: no valid fp found ~S ~S~%"
659 ;;; Convert the descriptor into a SAP. The bits all stay the same, we just
660 ;;; change our notion of what we think they are.
661 #!-sb-fluid (declaim (inline descriptor-sap))
662 (defun descriptor-sap (x)
663 (int-sap (get-lisp-obj-address x)))
665 ;;; Return the top frame of the control stack as it was before calling
668 (/noshow0 "entering TOP-FRAME")
669 (multiple-value-bind (fp pc) (%caller-frame-and-pc)
670 (compute-calling-frame (descriptor-sap fp) pc nil)))
672 ;;; Flush all of the frames above FRAME, and renumber all the frames
674 (defun flush-frames-above (frame)
675 (setf (frame-up frame) nil)
676 (do ((number 0 (1+ number))
677 (frame frame (frame-%down frame)))
678 ((not (frame-p frame)))
679 (setf (frame-number frame) number)))
681 ;;; Return the frame immediately below FRAME on the stack; or when
682 ;;; FRAME is the bottom of the stack, return NIL.
683 (defun frame-down (frame)
684 (/noshow0 "entering FRAME-DOWN")
685 ;; We have to access the old-fp and return-pc out of frame and pass
686 ;; them to COMPUTE-CALLING-FRAME.
687 (let ((down (frame-%down frame)))
688 (if (eq down :unparsed)
689 (let ((debug-fun (frame-debug-fun frame)))
690 (/noshow0 "in DOWN :UNPARSED case")
691 (setf (frame-%down frame)
694 (let ((c-d-f (compiled-debug-fun-compiler-debug-fun
696 (compute-calling-frame
699 frame ocfp-save-offset
700 (sb!c::compiled-debug-fun-old-fp c-d-f)))
702 frame lra-save-offset
703 (sb!c::compiled-debug-fun-return-pc c-d-f))
706 (let ((fp (frame-pointer frame)))
707 (when (control-stack-pointer-valid-p fp)
709 (multiple-value-bind (ra ofp) (x86-call-context fp)
710 (and ra (compute-calling-frame ofp ra frame)))
712 (compute-calling-frame
714 (sap-ref-sap fp (* ocfp-save-offset
718 (sap-ref-32 fp (* ocfp-save-offset
719 sb!vm:n-word-bytes)))
721 (stack-ref fp lra-save-offset)
726 ;;; Get the old FP or return PC out of FRAME. STACK-SLOT is the
727 ;;; standard save location offset on the stack. LOC is the saved
728 ;;; SC-OFFSET describing the main location.
729 (defun get-context-value (frame stack-slot loc)
730 (declare (type compiled-frame frame) (type unsigned-byte stack-slot)
731 (type sb!c:sc-offset loc))
732 (let ((pointer (frame-pointer frame))
733 (escaped (compiled-frame-escaped frame)))
735 (sub-access-debug-var-slot pointer loc escaped)
737 (stack-ref pointer stack-slot)
741 (stack-ref pointer stack-slot))
743 (sap-ref-sap pointer (- (* (1+ stack-slot)
744 sb!vm::n-word-bytes))))))))
746 (defun (setf get-context-value) (value frame stack-slot loc)
747 (declare (type compiled-frame frame) (type unsigned-byte stack-slot)
748 (type sb!c:sc-offset loc))
749 (let ((pointer (frame-pointer frame))
750 (escaped (compiled-frame-escaped frame)))
752 (sub-set-debug-var-slot pointer loc value escaped)
754 (setf (stack-ref pointer stack-slot) value)
758 (setf (stack-ref pointer stack-slot) value))
760 (setf (sap-ref-sap pointer (- (* (1+ stack-slot)
761 sb!vm::n-word-bytes))) value))))))
763 (defun foreign-function-backtrace-name (sap)
764 (let ((name (sap-foreign-symbol sap)))
766 (format nil "foreign function: ~A" name)
767 (format nil "foreign function: #x~X" (sap-int sap)))))
769 ;;; This returns a frame for the one existing in time immediately
770 ;;; prior to the frame referenced by current-fp. This is current-fp's
771 ;;; caller or the next frame down the control stack. If there is no
772 ;;; down frame, this returns NIL for the bottom of the stack. UP-FRAME
773 ;;; is the up link for the resulting frame object, and it is null when
774 ;;; we call this to get the top of the stack.
776 ;;; The current frame contains the pointer to the temporally previous
777 ;;; frame we want, and the current frame contains the pc at which we
778 ;;; will continue executing upon returning to that previous frame.
780 ;;; Note: Sometimes LRA is actually a fixnum. This happens when lisp
781 ;;; calls into C. In this case, the code object is stored on the stack
782 ;;; after the LRA, and the LRA is the word offset.
784 (defun compute-calling-frame (caller lra up-frame)
785 (declare (type system-area-pointer caller))
786 (when (control-stack-pointer-valid-p caller)
787 (multiple-value-bind (code pc-offset escaped)
789 (multiple-value-bind (word-offset code)
791 (let ((fp (frame-pointer up-frame)))
793 (stack-ref fp (1+ lra-save-offset))))
794 (values (get-header-data lra)
795 (lra-code-header lra)))
798 (* (1+ (- word-offset (get-header-data code)))
801 (values :foreign-function
804 (find-escaped-frame caller))
805 (if (and (code-component-p code)
806 (eq (%code-debug-info code) :bogus-lra))
807 (let ((real-lra (code-header-ref code real-lra-slot)))
808 (compute-calling-frame caller real-lra up-frame))
809 (let ((d-fun (case code
811 (make-bogus-debug-fun
812 "undefined function"))
814 (make-bogus-debug-fun
815 (foreign-function-backtrace-name
816 (int-sap (get-lisp-obj-address lra)))))
818 (make-bogus-debug-fun
819 "bogus stack frame"))
821 (debug-fun-from-pc code pc-offset)))))
822 (make-compiled-frame caller up-frame d-fun
823 (code-location-from-pc d-fun pc-offset
825 (if up-frame (1+ (frame-number up-frame)) 0)
829 (defun compute-calling-frame (caller ra up-frame)
830 (declare (type system-area-pointer caller ra))
831 (/noshow0 "entering COMPUTE-CALLING-FRAME")
832 (when (control-stack-pointer-valid-p caller)
834 ;; First check for an escaped frame.
835 (multiple-value-bind (code pc-offset escaped) (find-escaped-frame caller)
838 ;; If it's escaped it may be a function end breakpoint trap.
839 (when (and (code-component-p code)
840 (eq (%code-debug-info code) :bogus-lra))
841 ;; If :bogus-lra grab the real lra.
842 (setq pc-offset (code-header-ref
843 code (1+ real-lra-slot)))
844 (setq code (code-header-ref code real-lra-slot))
847 (multiple-value-setq (pc-offset code)
848 (compute-lra-data-from-pc ra))
850 (setf code :foreign-function
852 (let ((d-fun (case code
854 (make-bogus-debug-fun
855 "undefined function"))
857 (make-bogus-debug-fun
858 (foreign-function-backtrace-name ra)))
860 (make-bogus-debug-fun
861 "bogus stack frame"))
863 (debug-fun-from-pc code pc-offset)))))
864 (/noshow0 "returning MAKE-COMPILED-FRAME from COMPUTE-CALLING-FRAME")
865 (make-compiled-frame caller up-frame d-fun
866 (code-location-from-pc d-fun pc-offset
868 (if up-frame (1+ (frame-number up-frame)) 0)
871 (defun nth-interrupt-context (n)
872 (declare (type (unsigned-byte 32) n)
873 (optimize (speed 3) (safety 0)))
874 (sb!alien:sap-alien (sb!vm::current-thread-offset-sap
875 (+ sb!vm::thread-interrupt-contexts-offset n))
879 (defun find-escaped-frame (frame-pointer)
880 (declare (type system-area-pointer frame-pointer))
881 (/noshow0 "entering FIND-ESCAPED-FRAME")
882 (dotimes (index *free-interrupt-context-index* (values nil 0 nil))
883 (/noshow0 "at head of WITH-ALIEN")
884 (let ((context (nth-interrupt-context index)))
885 (/noshow0 "got CONTEXT")
886 (when (= (sap-int frame-pointer)
887 (sb!vm:context-register context sb!vm::cfp-offset))
889 (/noshow0 "in WITHOUT-GCING")
890 (let* ((component-ptr (component-ptr-from-pc
891 (sb!vm:context-pc context)))
892 (code (unless (sap= component-ptr (int-sap #x0))
893 (component-from-component-ptr component-ptr))))
894 (/noshow0 "got CODE")
896 (return (values code 0 context)))
897 (let* ((code-header-len (* (get-header-data code)
900 (- (sap-int (sb!vm:context-pc context))
901 (- (get-lisp-obj-address code)
902 sb!vm:other-pointer-lowtag)
904 (/noshow "got PC-OFFSET")
905 (unless (<= 0 pc-offset
906 (* (code-header-ref code sb!vm:code-code-size-slot)
908 ;; We were in an assembly routine. Therefore, use the
911 ;; FIXME: Should this be WARN or ERROR or what?
912 (format t "** pc-offset ~S not in code obj ~S?~%"
914 (/noshow0 "returning from FIND-ESCAPED-FRAME")
916 (values code pc-offset context)))))))))
919 (defun find-escaped-frame (frame-pointer)
920 (declare (type system-area-pointer frame-pointer))
921 (dotimes (index *free-interrupt-context-index* (values nil 0 nil))
922 (let ((scp (nth-interrupt-context index)))
923 (when (= (sap-int frame-pointer)
924 (sb!vm:context-register scp sb!vm::cfp-offset))
926 (let ((code (code-object-from-bits
927 (sb!vm:context-register scp sb!vm::code-offset))))
929 (return (values code 0 scp)))
930 (let* ((code-header-len (* (get-header-data code)
933 (- (sap-int (sb!vm:context-pc scp))
934 (- (get-lisp-obj-address code)
935 sb!vm:other-pointer-lowtag)
937 (let ((code-size (* (code-header-ref code
938 sb!vm:code-code-size-slot)
939 sb!vm:n-word-bytes)))
940 (unless (<= 0 pc-offset code-size)
941 ;; We were in an assembly routine.
942 (multiple-value-bind (new-pc-offset computed-return)
943 (find-pc-from-assembly-fun code scp)
944 (setf pc-offset new-pc-offset)
945 (unless (<= 0 pc-offset code-size)
947 "Set PC-OFFSET to zero and continue backtrace."
950 "~@<PC-OFFSET (~D) not in code object. Frame details:~
951 ~2I~:@_PC: #X~X~:@_CODE: ~S~:@_CODE FUN: ~S~:@_LRA: ~
952 #X~X~:@_COMPUTED RETURN: #X~X.~:>"
955 (sap-int (sb!vm:context-pc scp))
957 (%code-entry-points code)
958 (sb!vm:context-register scp sb!vm::lra-offset)
960 ;; We failed to pinpoint where PC is, but set
961 ;; pc-offset to 0 to keep the backtrace from
963 (setf pc-offset 0)))))
965 (if (eq (%code-debug-info code) :bogus-lra)
966 (let ((real-lra (code-header-ref code
968 (values (lra-code-header real-lra)
969 (get-header-data real-lra)
971 (values code pc-offset scp))))))))))
974 (defun find-pc-from-assembly-fun (code scp)
975 "Finds the PC for the return from an assembly routine properly.
976 For some architectures (such as PPC) this will not be the $LRA
978 (let ((return-machine-address (sb!vm::return-machine-address scp))
979 (code-header-len (* (get-header-data code) sb!vm:n-word-bytes)))
980 (values (- return-machine-address
981 (- (get-lisp-obj-address code)
982 sb!vm:other-pointer-lowtag)
984 return-machine-address)))
986 ;;; Find the code object corresponding to the object represented by
987 ;;; bits and return it. We assume bogus functions correspond to the
988 ;;; undefined-function.
990 (defun code-object-from-bits (bits)
991 (declare (type (unsigned-byte 32) bits))
992 (let ((object (make-lisp-obj bits)))
993 (if (functionp object)
994 (or (fun-code-header object)
996 (let ((lowtag (lowtag-of object)))
997 (when (= lowtag sb!vm:other-pointer-lowtag)
998 (let ((widetag (widetag-of object)))
999 (cond ((= widetag sb!vm:code-header-widetag)
1001 ((= widetag sb!vm:return-pc-header-widetag)
1002 (lra-code-header object))
1006 ;;;; frame utilities
1008 ;;; This returns a COMPILED-DEBUG-FUN for COMPONENT and PC. We fetch the
1009 ;;; SB!C::DEBUG-INFO and run down its FUN-MAP to get a
1010 ;;; SB!C::COMPILED-DEBUG-FUN from the PC. The result only needs to
1011 ;;; reference the COMPONENT, for function constants, and the
1012 ;;; SB!C::COMPILED-DEBUG-FUN.
1013 (defun debug-fun-from-pc (component pc)
1014 (let ((info (%code-debug-info component)))
1017 ;; FIXME: It seems that most of these (at least on x86) are
1018 ;; actually assembler routines, and could be named by looking
1019 ;; at the sb-fasl:*assembler-routines*.
1020 (make-bogus-debug-fun "no debug information for frame"))
1021 ((eq info :bogus-lra)
1022 (make-bogus-debug-fun "function end breakpoint"))
1024 (let* ((fun-map (sb!c::compiled-debug-info-fun-map info))
1025 (len (length fun-map)))
1026 (declare (type simple-vector fun-map))
1028 (make-compiled-debug-fun (svref fun-map 0) component)
1031 (>= pc (sb!c::compiled-debug-fun-elsewhere-pc
1032 (svref fun-map 0)))))
1033 (declare (type sb!int:index i))
1036 (< pc (if elsewhere-p
1037 (sb!c::compiled-debug-fun-elsewhere-pc
1038 (svref fun-map (1+ i)))
1039 (svref fun-map i))))
1040 (return (make-compiled-debug-fun
1041 (svref fun-map (1- i))
1045 ;;; This returns a code-location for the COMPILED-DEBUG-FUN,
1046 ;;; DEBUG-FUN, and the pc into its code vector. If we stopped at a
1047 ;;; breakpoint, find the CODE-LOCATION for that breakpoint. Otherwise,
1048 ;;; make an :UNSURE code location, so it can be filled in when we
1049 ;;; figure out what is going on.
1050 (defun code-location-from-pc (debug-fun pc escaped)
1051 (or (and (compiled-debug-fun-p debug-fun)
1053 (let ((data (breakpoint-data
1054 (compiled-debug-fun-component debug-fun)
1056 (when (and data (breakpoint-data-breakpoints data))
1057 (let ((what (breakpoint-what
1058 (first (breakpoint-data-breakpoints data)))))
1059 (when (compiled-code-location-p what)
1061 (make-compiled-code-location pc debug-fun)))
1063 ;;; Return an alist mapping catch tags to CODE-LOCATIONs. These are
1064 ;;; CODE-LOCATIONs at which execution would continue with frame as the
1065 ;;; top frame if someone threw to the corresponding tag.
1066 (defun frame-catches (frame)
1067 (let ((catch (descriptor-sap sb!vm:*current-catch-block*))
1068 (reversed-result nil)
1069 (fp (frame-pointer frame)))
1070 (loop until (zerop (sap-int catch))
1071 finally (return (nreverse reversed-result))
1076 (* sb!vm:catch-block-current-cont-slot
1077 sb!vm:n-word-bytes))
1081 (* sb!vm:catch-block-current-cont-slot
1082 sb!vm:n-word-bytes))))
1083 (let* (#!-(or x86 x86-64)
1084 (lra (stack-ref catch sb!vm:catch-block-entry-pc-slot))
1087 catch (* sb!vm:catch-block-entry-pc-slot
1088 sb!vm:n-word-bytes)))
1091 (stack-ref catch sb!vm:catch-block-current-code-slot))
1093 (component (component-from-component-ptr
1094 (component-ptr-from-pc ra)))
1097 (* (- (1+ (get-header-data lra))
1098 (get-header-data component))
1102 (- (get-lisp-obj-address component)
1103 sb!vm:other-pointer-lowtag)
1104 (* (get-header-data component) sb!vm:n-word-bytes))))
1105 (push (cons #!-(or x86 x86-64)
1106 (stack-ref catch sb!vm:catch-block-tag-slot)
1109 (sap-ref-word catch (* sb!vm:catch-block-tag-slot
1110 sb!vm:n-word-bytes)))
1111 (make-compiled-code-location
1112 offset (frame-debug-fun frame)))
1117 (* sb!vm:catch-block-previous-catch-slot
1118 sb!vm:n-word-bytes))
1122 (* sb!vm:catch-block-previous-catch-slot
1123 sb!vm:n-word-bytes)))))))
1125 ;;;; operations on DEBUG-FUNs
1127 ;;; Execute the forms in a context with BLOCK-VAR bound to each
1128 ;;; DEBUG-BLOCK in DEBUG-FUN successively. Result is an optional
1129 ;;; form to execute for return values, and DO-DEBUG-FUN-BLOCKS
1130 ;;; returns nil if there is no result form. This signals a
1131 ;;; NO-DEBUG-BLOCKS condition when the DEBUG-FUN lacks
1132 ;;; DEBUG-BLOCK information.
1133 (defmacro do-debug-fun-blocks ((block-var debug-fun &optional result)
1135 (let ((blocks (gensym))
1137 `(let ((,blocks (debug-fun-debug-blocks ,debug-fun)))
1138 (declare (simple-vector ,blocks))
1139 (dotimes (,i (length ,blocks) ,result)
1140 (let ((,block-var (svref ,blocks ,i)))
1143 ;;; Execute body in a context with VAR bound to each DEBUG-VAR in
1144 ;;; DEBUG-FUN. This returns the value of executing result (defaults to
1145 ;;; nil). This may iterate over only some of DEBUG-FUN's variables or
1146 ;;; none depending on debug policy; for example, possibly the
1147 ;;; compilation only preserved argument information.
1148 (defmacro do-debug-fun-vars ((var debug-fun &optional result) &body body)
1149 (let ((vars (gensym))
1151 `(let ((,vars (debug-fun-debug-vars ,debug-fun)))
1152 (declare (type (or null simple-vector) ,vars))
1154 (dotimes (,i (length ,vars) ,result)
1155 (let ((,var (svref ,vars ,i)))
1159 ;;; Return the object of type FUNCTION associated with the DEBUG-FUN,
1160 ;;; or NIL if the function is unavailable or is non-existent as a user
1161 ;;; callable function object.
1162 (defun debug-fun-fun (debug-fun)
1163 (let ((cached-value (debug-fun-%function debug-fun)))
1164 (if (eq cached-value :unparsed)
1165 (setf (debug-fun-%function debug-fun)
1166 (etypecase debug-fun
1169 (compiled-debug-fun-component debug-fun))
1171 (sb!c::compiled-debug-fun-start-pc
1172 (compiled-debug-fun-compiler-debug-fun debug-fun))))
1173 (do ((entry (%code-entry-points component)
1174 (%simple-fun-next entry)))
1177 (sb!c::compiled-debug-fun-start-pc
1178 (compiled-debug-fun-compiler-debug-fun
1179 (fun-debug-fun entry))))
1181 (bogus-debug-fun nil)))
1184 ;;; Return the name of the function represented by DEBUG-FUN. This may
1185 ;;; be a string or a cons; do not assume it is a symbol.
1186 (defun debug-fun-name (debug-fun)
1187 (declare (type debug-fun debug-fun))
1188 (etypecase debug-fun
1190 (sb!c::compiled-debug-fun-name
1191 (compiled-debug-fun-compiler-debug-fun debug-fun)))
1193 (bogus-debug-fun-%name debug-fun))))
1195 ;;; Return a DEBUG-FUN that represents debug information for FUN.
1196 (defun fun-debug-fun (fun)
1197 (declare (type function fun))
1198 (ecase (widetag-of fun)
1199 (#.sb!vm:closure-header-widetag
1200 (fun-debug-fun (%closure-fun fun)))
1201 (#.sb!vm:funcallable-instance-header-widetag
1202 (fun-debug-fun (funcallable-instance-fun fun)))
1203 (#.sb!vm:simple-fun-header-widetag
1204 (let* ((name (%simple-fun-name fun))
1205 (component (fun-code-header fun))
1208 (and (sb!c::compiled-debug-fun-p x)
1209 (eq (sb!c::compiled-debug-fun-name x) name)
1210 (eq (sb!c::compiled-debug-fun-kind x) nil)))
1211 (sb!c::compiled-debug-info-fun-map
1212 (%code-debug-info component)))))
1214 (make-compiled-debug-fun res component)
1215 ;; KLUDGE: comment from CMU CL:
1216 ;; This used to be the non-interpreted branch, but
1217 ;; William wrote it to return the debug-fun of fun's XEP
1218 ;; instead of fun's debug-fun. The above code does this
1219 ;; more correctly, but it doesn't get or eliminate all
1220 ;; appropriate cases. It mostly works, and probably
1221 ;; works for all named functions anyway.
1223 (debug-fun-from-pc component
1224 (* (- (fun-word-offset fun)
1225 (get-header-data component))
1226 sb!vm:n-word-bytes)))))))
1228 ;;; Return the kind of the function, which is one of :OPTIONAL,
1229 ;;; :EXTERNAL, :TOPLEVEL, :CLEANUP, or NIL.
1230 (defun debug-fun-kind (debug-fun)
1231 ;; FIXME: This "is one of" information should become part of the function
1232 ;; declamation, not just a doc string
1233 (etypecase debug-fun
1235 (sb!c::compiled-debug-fun-kind
1236 (compiled-debug-fun-compiler-debug-fun debug-fun)))
1240 ;;; Is there any variable information for DEBUG-FUN?
1241 (defun debug-var-info-available (debug-fun)
1242 (not (not (debug-fun-debug-vars debug-fun))))
1244 ;;; Return a list of DEBUG-VARs in DEBUG-FUN having the same name
1245 ;;; and package as SYMBOL. If SYMBOL is uninterned, then this returns
1246 ;;; a list of DEBUG-VARs without package names and with the same name
1247 ;;; as symbol. The result of this function is limited to the
1248 ;;; availability of variable information in DEBUG-FUN; for
1249 ;;; example, possibly DEBUG-FUN only knows about its arguments.
1250 (defun debug-fun-symbol-vars (debug-fun symbol)
1251 (let ((vars (ambiguous-debug-vars debug-fun (symbol-name symbol)))
1252 (package (and (symbol-package symbol)
1253 (package-name (symbol-package symbol)))))
1254 (delete-if (if (stringp package)
1256 (let ((p (debug-var-package-name var)))
1257 (or (not (stringp p))
1258 (string/= p package))))
1260 (stringp (debug-var-package-name var))))
1263 ;;; Return a list of DEBUG-VARs in DEBUG-FUN whose names contain
1264 ;;; NAME-PREFIX-STRING as an initial substring. The result of this
1265 ;;; function is limited to the availability of variable information in
1266 ;;; debug-fun; for example, possibly debug-fun only knows
1267 ;;; about its arguments.
1268 (defun ambiguous-debug-vars (debug-fun name-prefix-string)
1269 (declare (simple-string name-prefix-string))
1270 (let ((variables (debug-fun-debug-vars debug-fun)))
1271 (declare (type (or null simple-vector) variables))
1273 (let* ((len (length variables))
1274 (prefix-len (length name-prefix-string))
1275 (pos (find-var name-prefix-string variables len))
1278 ;; Find names from pos to variable's len that contain prefix.
1279 (do ((i pos (1+ i)))
1281 (let* ((var (svref variables i))
1282 (name (debug-var-symbol-name var))
1283 (name-len (length name)))
1284 (declare (simple-string name))
1285 (when (/= (or (string/= name-prefix-string name
1286 :end1 prefix-len :end2 name-len)
1291 (setq res (nreverse res)))
1294 ;;; This returns a position in VARIABLES for one containing NAME as an
1295 ;;; initial substring. END is the length of VARIABLES if supplied.
1296 (defun find-var (name variables &optional end)
1297 (declare (simple-vector variables)
1298 (simple-string name))
1299 (let ((name-len (length name)))
1300 (position name variables
1302 (let* ((y (debug-var-symbol-name y))
1304 (declare (simple-string y))
1305 (and (>= y-len name-len)
1306 (string= x y :end1 name-len :end2 name-len))))
1307 :end (or end (length variables)))))
1309 ;;; Return a list representing the lambda-list for DEBUG-FUN. The
1310 ;;; list has the following structure:
1311 ;;; (required-var1 required-var2
1313 ;;; (:optional var3 suppliedp-var4)
1314 ;;; (:optional var5)
1316 ;;; (:rest var6) (:rest var7)
1318 ;;; (:keyword keyword-symbol var8 suppliedp-var9)
1319 ;;; (:keyword keyword-symbol var10)
1322 ;;; Each VARi is a DEBUG-VAR; however it may be the symbol :DELETED if
1323 ;;; it is unreferenced in DEBUG-FUN. This signals a
1324 ;;; LAMBDA-LIST-UNAVAILABLE condition when there is no argument list
1326 (defun debug-fun-lambda-list (debug-fun)
1327 (etypecase debug-fun
1328 (compiled-debug-fun (compiled-debug-fun-lambda-list debug-fun))
1329 (bogus-debug-fun nil)))
1331 ;;; Note: If this has to compute the lambda list, it caches it in DEBUG-FUN.
1332 (defun compiled-debug-fun-lambda-list (debug-fun)
1333 (let ((lambda-list (debug-fun-%lambda-list debug-fun)))
1334 (cond ((eq lambda-list :unparsed)
1335 (multiple-value-bind (args argsp)
1336 (parse-compiled-debug-fun-lambda-list debug-fun)
1337 (setf (debug-fun-%lambda-list debug-fun) args)
1340 (debug-signal 'lambda-list-unavailable
1341 :debug-fun debug-fun))))
1343 ((bogus-debug-fun-p debug-fun)
1345 ((sb!c::compiled-debug-fun-arguments
1346 (compiled-debug-fun-compiler-debug-fun debug-fun))
1347 ;; If the packed information is there (whether empty or not) as
1348 ;; opposed to being nil, then returned our cached value (nil).
1351 ;; Our cached value is nil, and the packed lambda-list information
1352 ;; is nil, so we don't have anything available.
1353 (debug-signal 'lambda-list-unavailable
1354 :debug-fun debug-fun)))))
1356 ;;; COMPILED-DEBUG-FUN-LAMBDA-LIST calls this when a
1357 ;;; COMPILED-DEBUG-FUN has no lambda list information cached. It
1358 ;;; returns the lambda list as the first value and whether there was
1359 ;;; any argument information as the second value. Therefore,
1360 ;;; (VALUES NIL T) means there were no arguments, but (VALUES NIL NIL)
1361 ;;; means there was no argument information.
1362 (defun parse-compiled-debug-fun-lambda-list (debug-fun)
1363 (let ((args (sb!c::compiled-debug-fun-arguments
1364 (compiled-debug-fun-compiler-debug-fun debug-fun))))
1369 (values (coerce (debug-fun-debug-vars debug-fun) 'list)
1372 (let ((vars (debug-fun-debug-vars debug-fun))
1377 (declare (type (or null simple-vector) vars))
1379 (when (>= i len) (return))
1380 (let ((ele (aref args i)))
1385 ;; Deleted required arg at beginning of args array.
1386 (push :deleted res))
1387 (sb!c::optional-args
1390 ;; SUPPLIED-P var immediately following keyword or
1391 ;; optional. Stick the extra var in the result
1392 ;; element representing the keyword or optional,
1393 ;; which is the previous one.
1395 ;; FIXME: NCONC used for side-effect: the effect is defined,
1396 ;; but this is bad style no matter what.
1398 (list (compiled-debug-fun-lambda-list-var
1399 args (incf i) vars))))
1402 (compiled-debug-fun-lambda-list-var
1403 args (incf i) vars))
1406 ;; Just ignore the fact that the next two args are
1407 ;; the &MORE arg context and count, and act like they
1408 ;; are regular arguments.
1412 (push (list :keyword
1414 (compiled-debug-fun-lambda-list-var
1415 args (incf i) vars))
1418 ;; We saw an optional marker, so the following
1419 ;; non-symbols are indexes indicating optional
1421 (push (list :optional (svref vars ele)) res))
1423 ;; Required arg at beginning of args array.
1424 (push (svref vars ele) res))))
1426 (values (nreverse res) t))))))
1428 ;;; This is used in COMPILED-DEBUG-FUN-LAMBDA-LIST.
1429 (defun compiled-debug-fun-lambda-list-var (args i vars)
1430 (declare (type (simple-array * (*)) args)
1431 (simple-vector vars))
1432 (let ((ele (aref args i)))
1433 (cond ((not (symbolp ele)) (svref vars ele))
1434 ((eq ele 'sb!c::deleted) :deleted)
1435 (t (error "malformed arguments description")))))
1437 (defun compiled-debug-fun-debug-info (debug-fun)
1438 (%code-debug-info (compiled-debug-fun-component debug-fun)))
1440 ;;;; unpacking variable and basic block data
1442 (defvar *parsing-buffer*
1443 (make-array 20 :adjustable t :fill-pointer t))
1444 (defvar *other-parsing-buffer*
1445 (make-array 20 :adjustable t :fill-pointer t))
1446 ;;; PARSE-DEBUG-BLOCKS and PARSE-DEBUG-VARS
1447 ;;; use this to unpack binary encoded information. It returns the
1448 ;;; values returned by the last form in body.
1450 ;;; This binds buffer-var to *parsing-buffer*, makes sure it starts at
1451 ;;; element zero, and makes sure if we unwind, we nil out any set
1452 ;;; elements for GC purposes.
1454 ;;; This also binds other-var to *other-parsing-buffer* when it is
1455 ;;; supplied, making sure it starts at element zero and that we nil
1456 ;;; out any elements if we unwind.
1458 ;;; This defines the local macro RESULT that takes a buffer, copies
1459 ;;; its elements to a resulting simple-vector, nil's out elements, and
1460 ;;; restarts the buffer at element zero. RESULT returns the
1462 (eval-when (:compile-toplevel :execute)
1463 (sb!xc:defmacro with-parsing-buffer ((buffer-var &optional other-var)
1465 (let ((len (gensym))
1468 (let ((,buffer-var *parsing-buffer*)
1469 ,@(if other-var `((,other-var *other-parsing-buffer*))))
1470 (setf (fill-pointer ,buffer-var) 0)
1471 ,@(if other-var `((setf (fill-pointer ,other-var) 0)))
1472 (macrolet ((result (buf)
1473 `(let* ((,',len (length ,buf))
1474 (,',res (make-array ,',len)))
1475 (replace ,',res ,buf :end1 ,',len :end2 ,',len)
1476 (fill ,buf nil :end ,',len)
1477 (setf (fill-pointer ,buf) 0)
1480 (fill *parsing-buffer* nil)
1481 ,@(if other-var `((fill *other-parsing-buffer* nil))))))
1484 ;;; The argument is a debug internals structure. This returns the
1485 ;;; DEBUG-BLOCKs for DEBUG-FUN, regardless of whether we have unpacked
1486 ;;; them yet. It signals a NO-DEBUG-BLOCKS condition if it can't
1487 ;;; return the blocks.
1488 (defun debug-fun-debug-blocks (debug-fun)
1489 (let ((blocks (debug-fun-blocks debug-fun)))
1490 (cond ((eq blocks :unparsed)
1491 (setf (debug-fun-blocks debug-fun)
1492 (parse-debug-blocks debug-fun))
1493 (unless (debug-fun-blocks debug-fun)
1494 (debug-signal 'no-debug-blocks
1495 :debug-fun debug-fun))
1496 (debug-fun-blocks debug-fun))
1499 (debug-signal 'no-debug-blocks
1500 :debug-fun debug-fun)))))
1502 ;;; Return a SIMPLE-VECTOR of DEBUG-BLOCKs or NIL. NIL indicates there
1503 ;;; was no basic block information.
1504 (defun parse-debug-blocks (debug-fun)
1505 (etypecase debug-fun
1507 (parse-compiled-debug-blocks debug-fun))
1509 (debug-signal 'no-debug-blocks :debug-fun debug-fun))))
1511 ;;; This does some of the work of PARSE-DEBUG-BLOCKS.
1512 (defun parse-compiled-debug-blocks (debug-fun)
1513 (let* ((var-count (length (debug-fun-debug-vars debug-fun)))
1514 (compiler-debug-fun (compiled-debug-fun-compiler-debug-fun
1516 (blocks (sb!c::compiled-debug-fun-blocks compiler-debug-fun))
1517 ;; KLUDGE: 8 is a hard-wired constant in the compiler for the
1518 ;; element size of the packed binary representation of the
1520 (live-set-len (ceiling var-count 8))
1521 (tlf-number (sb!c::compiled-debug-fun-tlf-number compiler-debug-fun)))
1523 (return-from parse-compiled-debug-blocks nil))
1524 (macrolet ((aref+ (a i) `(prog1 (aref ,a ,i) (incf ,i))))
1525 (with-parsing-buffer (blocks-buffer locations-buffer)
1527 (len (length blocks))
1530 (when (>= i len) (return))
1531 (let ((succ-and-flags (aref+ blocks i))
1533 (declare (type (unsigned-byte 8) succ-and-flags)
1535 (dotimes (k (ldb sb!c::compiled-debug-block-nsucc-byte
1537 (push (sb!c:read-var-integer blocks i) successors))
1539 (dotimes (k (sb!c:read-var-integer blocks i)
1540 (result locations-buffer))
1541 (let ((kind (svref sb!c::*compiled-code-location-kinds*
1544 (sb!c:read-var-integer blocks i)))
1545 (tlf-offset (or tlf-number
1546 (sb!c:read-var-integer blocks i)))
1547 (form-number (sb!c:read-var-integer blocks i))
1548 (live-set (sb!c:read-packed-bit-vector
1549 live-set-len blocks i))
1550 (step-info (sb!c:read-var-string blocks i)))
1551 (vector-push-extend (make-known-code-location
1552 pc debug-fun tlf-offset
1553 form-number live-set kind
1556 (setf last-pc pc))))
1557 (block (make-compiled-debug-block
1558 locations successors
1560 sb!c::compiled-debug-block-elsewhere-p
1561 succ-and-flags))))))
1562 (vector-push-extend block blocks-buffer)
1563 (dotimes (k (length locations))
1564 (setf (code-location-%debug-block (svref locations k))
1566 (let ((res (result blocks-buffer)))
1567 (declare (simple-vector res))
1568 (dotimes (i (length res))
1569 (let* ((block (svref res i))
1571 (dolist (ele (debug-block-successors block))
1572 (push (svref res ele) succs))
1573 (setf (debug-block-successors block) succs)))
1576 ;;; The argument is a debug internals structure. This returns NIL if
1577 ;;; there is no variable information. It returns an empty
1578 ;;; simple-vector if there were no locals in the function. Otherwise
1579 ;;; it returns a SIMPLE-VECTOR of DEBUG-VARs.
1580 (defun debug-fun-debug-vars (debug-fun)
1581 (let ((vars (debug-fun-%debug-vars debug-fun)))
1582 (if (eq vars :unparsed)
1583 (setf (debug-fun-%debug-vars debug-fun)
1584 (etypecase debug-fun
1586 (parse-compiled-debug-vars debug-fun))
1587 (bogus-debug-fun nil)))
1590 ;;; VARS is the parsed variables for a minimal debug function. We need
1591 ;;; to assign names of the form ARG-NNN. We must pad with leading
1592 ;;; zeros, since the arguments must be in alphabetical order.
1593 (defun assign-minimal-var-names (vars)
1594 (declare (simple-vector vars))
1595 (let* ((len (length vars))
1596 (width (length (format nil "~W" (1- len)))))
1598 (without-package-locks
1599 (setf (compiled-debug-var-symbol (svref vars i))
1600 (intern (format nil "ARG-~V,'0D" width i)
1601 ;; KLUDGE: It's somewhat nasty to have a bare
1602 ;; package name string here. It would be
1603 ;; nicer to have #.(FIND-PACKAGE "SB!DEBUG")
1604 ;; instead, since then at least it would transform
1605 ;; correctly under package renaming and stuff.
1606 ;; However, genesis can't handle dumped packages..
1609 ;; FIXME: Maybe this could be fixed by moving the
1610 ;; whole debug-int.lisp file to warm init? (after
1611 ;; which dumping a #.(FIND-PACKAGE ..) expression
1612 ;; would work fine) If this is possible, it would
1613 ;; probably be a good thing, since minimizing the
1614 ;; amount of stuff in cold init is basically good.
1615 (or (find-package "SB-DEBUG")
1616 (find-package "SB!DEBUG"))))))))
1618 ;;; Parse the packed representation of DEBUG-VARs from
1619 ;;; DEBUG-FUN's SB!C::COMPILED-DEBUG-FUN, returning a vector
1620 ;;; of DEBUG-VARs, or NIL if there was no information to parse.
1621 (defun parse-compiled-debug-vars (debug-fun)
1622 (let* ((cdebug-fun (compiled-debug-fun-compiler-debug-fun
1624 (packed-vars (sb!c::compiled-debug-fun-vars cdebug-fun))
1625 (args-minimal (eq (sb!c::compiled-debug-fun-arguments cdebug-fun)
1629 (buffer (make-array 0 :fill-pointer 0 :adjustable t)))
1630 ((>= i (length packed-vars))
1631 (let ((result (coerce buffer 'simple-vector)))
1633 (assign-minimal-var-names result))
1635 (flet ((geti () (prog1 (aref packed-vars i) (incf i))))
1636 (let* ((flags (geti))
1637 (minimal (logtest sb!c::compiled-debug-var-minimal-p flags))
1638 (deleted (logtest sb!c::compiled-debug-var-deleted-p flags))
1639 (live (logtest sb!c::compiled-debug-var-environment-live
1641 (save (logtest sb!c::compiled-debug-var-save-loc-p flags))
1642 (symbol (if minimal nil (geti)))
1643 (id (if (logtest sb!c::compiled-debug-var-id-p flags)
1646 (sc-offset (if deleted 0 (geti)))
1647 (save-sc-offset (if save (geti) nil)))
1648 (aver (not (and args-minimal (not minimal))))
1649 (vector-push-extend (make-compiled-debug-var symbol
1658 ;;; If we're sure of whether code-location is known, return T or NIL.
1659 ;;; If we're :UNSURE, then try to fill in the code-location's slots.
1660 ;;; This determines whether there is any debug-block information, and
1661 ;;; if code-location is known.
1663 ;;; ??? IF this conses closures every time it's called, then break off the
1664 ;;; :UNSURE part to get the HANDLER-CASE into another function.
1665 (defun code-location-unknown-p (basic-code-location)
1666 (ecase (code-location-%unknown-p basic-code-location)
1670 (setf (code-location-%unknown-p basic-code-location)
1671 (handler-case (not (fill-in-code-location basic-code-location))
1672 (no-debug-blocks () t))))))
1674 ;;; Return the DEBUG-BLOCK containing code-location if it is available.
1675 ;;; Some debug policies inhibit debug-block information, and if none
1676 ;;; is available, then this signals a NO-DEBUG-BLOCKS condition.
1677 (defun code-location-debug-block (basic-code-location)
1678 (let ((block (code-location-%debug-block basic-code-location)))
1679 (if (eq block :unparsed)
1680 (etypecase basic-code-location
1681 (compiled-code-location
1682 (compute-compiled-code-location-debug-block basic-code-location))
1683 ;; (There used to be more cases back before sbcl-0.7.0, when
1684 ;; we did special tricks to debug the IR1 interpreter.)
1688 ;;; Store and return BASIC-CODE-LOCATION's debug-block. We determines
1689 ;;; the correct one using the code-location's pc. We use
1690 ;;; DEBUG-FUN-DEBUG-BLOCKS to return the cached block information
1691 ;;; or signal a NO-DEBUG-BLOCKS condition. The blocks are sorted by
1692 ;;; their first code-location's pc, in ascending order. Therefore, as
1693 ;;; soon as we find a block that starts with a pc greater than
1694 ;;; basic-code-location's pc, we know the previous block contains the
1695 ;;; pc. If we get to the last block, then the code-location is either
1696 ;;; in the second to last block or the last block, and we have to be
1697 ;;; careful in determining this since the last block could be code at
1698 ;;; the end of the function. We have to check for the last block being
1699 ;;; code first in order to see how to compare the code-location's pc.
1700 (defun compute-compiled-code-location-debug-block (basic-code-location)
1701 (let* ((pc (compiled-code-location-pc basic-code-location))
1702 (debug-fun (code-location-debug-fun
1703 basic-code-location))
1704 (blocks (debug-fun-debug-blocks debug-fun))
1705 (len (length blocks)))
1706 (declare (simple-vector blocks))
1707 (setf (code-location-%debug-block basic-code-location)
1713 (let ((last (svref blocks end)))
1715 ((debug-block-elsewhere-p last)
1717 (sb!c::compiled-debug-fun-elsewhere-pc
1718 (compiled-debug-fun-compiler-debug-fun
1720 (svref blocks (1- end))
1723 (compiled-code-location-pc
1724 (svref (compiled-debug-block-code-locations last)
1726 (svref blocks (1- end)))
1728 (declare (type index i end))
1730 (compiled-code-location-pc
1731 (svref (compiled-debug-block-code-locations
1734 (return (svref blocks (1- i)))))))))
1736 ;;; Return the CODE-LOCATION's DEBUG-SOURCE.
1737 (defun code-location-debug-source (code-location)
1738 (let ((info (compiled-debug-fun-debug-info
1739 (code-location-debug-fun code-location))))
1740 (or (sb!c::debug-info-source info)
1741 (debug-signal 'no-debug-blocks :debug-fun
1742 (code-location-debug-fun code-location)))))
1744 ;;; Returns the number of top level forms before the one containing
1745 ;;; CODE-LOCATION as seen by the compiler in some compilation unit. (A
1746 ;;; compilation unit is not necessarily a single file, see the section
1747 ;;; on debug-sources.)
1748 (defun code-location-toplevel-form-offset (code-location)
1749 (when (code-location-unknown-p code-location)
1750 (error 'unknown-code-location :code-location code-location))
1751 (let ((tlf-offset (code-location-%tlf-offset code-location)))
1752 (cond ((eq tlf-offset :unparsed)
1753 (etypecase code-location
1754 (compiled-code-location
1755 (unless (fill-in-code-location code-location)
1756 ;; This check should be unnecessary. We're missing
1757 ;; debug info the compiler should have dumped.
1758 (bug "unknown code location"))
1759 (code-location-%tlf-offset code-location))
1760 ;; (There used to be more cases back before sbcl-0.7.0,,
1761 ;; when we did special tricks to debug the IR1
1766 ;;; Return the number of the form corresponding to CODE-LOCATION. The
1767 ;;; form number is derived by a walking the subforms of a top level
1768 ;;; form in depth-first order.
1769 (defun code-location-form-number (code-location)
1770 (when (code-location-unknown-p code-location)
1771 (error 'unknown-code-location :code-location code-location))
1772 (let ((form-num (code-location-%form-number code-location)))
1773 (cond ((eq form-num :unparsed)
1774 (etypecase code-location
1775 (compiled-code-location
1776 (unless (fill-in-code-location code-location)
1777 ;; This check should be unnecessary. We're missing
1778 ;; debug info the compiler should have dumped.
1779 (bug "unknown code location"))
1780 (code-location-%form-number code-location))
1781 ;; (There used to be more cases back before sbcl-0.7.0,,
1782 ;; when we did special tricks to debug the IR1
1787 ;;; Return the kind of CODE-LOCATION, one of:
1788 ;;; :INTERPRETED, :UNKNOWN-RETURN, :KNOWN-RETURN, :INTERNAL-ERROR,
1789 ;;; :NON-LOCAL-EXIT, :BLOCK-START, :CALL-SITE, :SINGLE-VALUE-RETURN,
1790 ;;; :NON-LOCAL-ENTRY
1791 (defun code-location-kind (code-location)
1792 (when (code-location-unknown-p code-location)
1793 (error 'unknown-code-location :code-location code-location))
1794 (etypecase code-location
1795 (compiled-code-location
1796 (let ((kind (compiled-code-location-kind code-location)))
1797 (cond ((not (eq kind :unparsed)) kind)
1798 ((not (fill-in-code-location code-location))
1799 ;; This check should be unnecessary. We're missing
1800 ;; debug info the compiler should have dumped.
1801 (bug "unknown code location"))
1803 (compiled-code-location-kind code-location)))))
1804 ;; (There used to be more cases back before sbcl-0.7.0,,
1805 ;; when we did special tricks to debug the IR1
1809 ;;; This returns CODE-LOCATION's live-set if it is available. If
1810 ;;; there is no debug-block information, this returns NIL.
1811 (defun compiled-code-location-live-set (code-location)
1812 (if (code-location-unknown-p code-location)
1814 (let ((live-set (compiled-code-location-%live-set code-location)))
1815 (cond ((eq live-set :unparsed)
1816 (unless (fill-in-code-location code-location)
1817 ;; This check should be unnecessary. We're missing
1818 ;; debug info the compiler should have dumped.
1820 ;; FIXME: This error and comment happen over and over again.
1821 ;; Make them a shared function.
1822 (bug "unknown code location"))
1823 (compiled-code-location-%live-set code-location))
1826 ;;; true if OBJ1 and OBJ2 are the same place in the code
1827 (defun code-location= (obj1 obj2)
1829 (compiled-code-location
1831 (compiled-code-location
1832 (and (eq (code-location-debug-fun obj1)
1833 (code-location-debug-fun obj2))
1834 (sub-compiled-code-location= obj1 obj2)))
1835 ;; (There used to be more cases back before sbcl-0.7.0,,
1836 ;; when we did special tricks to debug the IR1
1839 ;; (There used to be more cases back before sbcl-0.7.0,,
1840 ;; when we did special tricks to debug IR1-interpreted code.)
1842 (defun sub-compiled-code-location= (obj1 obj2)
1843 (= (compiled-code-location-pc obj1)
1844 (compiled-code-location-pc obj2)))
1846 ;;; Fill in CODE-LOCATION's :UNPARSED slots, returning T or NIL
1847 ;;; depending on whether the code-location was known in its
1848 ;;; DEBUG-FUN's debug-block information. This may signal a
1849 ;;; NO-DEBUG-BLOCKS condition due to DEBUG-FUN-DEBUG-BLOCKS, and
1850 ;;; it assumes the %UNKNOWN-P slot is already set or going to be set.
1851 (defun fill-in-code-location (code-location)
1852 (declare (type compiled-code-location code-location))
1853 (let* ((debug-fun (code-location-debug-fun code-location))
1854 (blocks (debug-fun-debug-blocks debug-fun)))
1855 (declare (simple-vector blocks))
1856 (dotimes (i (length blocks) nil)
1857 (let* ((block (svref blocks i))
1858 (locations (compiled-debug-block-code-locations block)))
1859 (declare (simple-vector locations))
1860 (dotimes (j (length locations))
1861 (let ((loc (svref locations j)))
1862 (when (sub-compiled-code-location= code-location loc)
1863 (setf (code-location-%debug-block code-location) block)
1864 (setf (code-location-%tlf-offset code-location)
1865 (code-location-%tlf-offset loc))
1866 (setf (code-location-%form-number code-location)
1867 (code-location-%form-number loc))
1868 (setf (compiled-code-location-%live-set code-location)
1869 (compiled-code-location-%live-set loc))
1870 (setf (compiled-code-location-kind code-location)
1871 (compiled-code-location-kind loc))
1872 (setf (compiled-code-location-step-info code-location)
1873 (compiled-code-location-step-info loc))
1874 (return-from fill-in-code-location t))))))))
1876 ;;;; operations on DEBUG-BLOCKs
1878 ;;; Execute FORMS in a context with CODE-VAR bound to each
1879 ;;; CODE-LOCATION in DEBUG-BLOCK, and return the value of RESULT.
1880 (defmacro do-debug-block-locations ((code-var debug-block &optional result)
1882 (let ((code-locations (gensym))
1884 `(let ((,code-locations (debug-block-code-locations ,debug-block)))
1885 (declare (simple-vector ,code-locations))
1886 (dotimes (,i (length ,code-locations) ,result)
1887 (let ((,code-var (svref ,code-locations ,i)))
1890 ;;; Return the name of the function represented by DEBUG-FUN.
1891 ;;; This may be a string or a cons; do not assume it is a symbol.
1892 (defun debug-block-fun-name (debug-block)
1893 (etypecase debug-block
1894 (compiled-debug-block
1895 (let ((code-locs (compiled-debug-block-code-locations debug-block)))
1896 (declare (simple-vector code-locs))
1897 (if (zerop (length code-locs))
1898 "??? Can't get name of debug-block's function."
1900 (code-location-debug-fun (svref code-locs 0))))))
1901 ;; (There used to be more cases back before sbcl-0.7.0, when we
1902 ;; did special tricks to debug the IR1 interpreter.)
1905 (defun debug-block-code-locations (debug-block)
1906 (etypecase debug-block
1907 (compiled-debug-block
1908 (compiled-debug-block-code-locations debug-block))
1909 ;; (There used to be more cases back before sbcl-0.7.0, when we
1910 ;; did special tricks to debug the IR1 interpreter.)
1913 ;;;; operations on debug variables
1915 (defun debug-var-symbol-name (debug-var)
1916 (symbol-name (debug-var-symbol debug-var)))
1918 ;;; FIXME: Make sure that this isn't called anywhere that it wouldn't
1919 ;;; be acceptable to have NIL returned, or that it's only called on
1920 ;;; DEBUG-VARs whose symbols have non-NIL packages.
1921 (defun debug-var-package-name (debug-var)
1922 (package-name (symbol-package (debug-var-symbol debug-var))))
1924 ;;; Return the value stored for DEBUG-VAR in frame, or if the value is
1925 ;;; not :VALID, then signal an INVALID-VALUE error.
1926 (defun debug-var-valid-value (debug-var frame)
1927 (unless (eq (debug-var-validity debug-var (frame-code-location frame))
1929 (error 'invalid-value :debug-var debug-var :frame frame))
1930 (debug-var-value debug-var frame))
1932 ;;; Returns the value stored for DEBUG-VAR in frame. The value may be
1933 ;;; invalid. This is SETFable.
1934 (defun debug-var-value (debug-var frame)
1935 (aver (typep frame 'compiled-frame))
1936 (let ((res (access-compiled-debug-var-slot debug-var frame)))
1937 (if (indirect-value-cell-p res)
1938 (value-cell-ref res)
1941 ;;; This returns what is stored for the variable represented by
1942 ;;; DEBUG-VAR relative to the FRAME. This may be an indirect value
1943 ;;; cell if the variable is both closed over and set.
1944 (defun access-compiled-debug-var-slot (debug-var frame)
1945 (declare (optimize (speed 1)))
1946 (let ((escaped (compiled-frame-escaped frame)))
1948 (sub-access-debug-var-slot
1949 (frame-pointer frame)
1950 (compiled-debug-var-sc-offset debug-var)
1952 (sub-access-debug-var-slot
1953 (frame-pointer frame)
1954 (or (compiled-debug-var-save-sc-offset debug-var)
1955 (compiled-debug-var-sc-offset debug-var))))))
1957 ;;; a helper function for working with possibly-invalid values:
1958 ;;; Do (MAKE-LISP-OBJ VAL) only if the value looks valid.
1960 ;;; (Such values can arise in registers on machines with conservative
1961 ;;; GC, and might also arise in debug variable locations when
1962 ;;; those variables are invalid.)
1963 (defun make-valid-lisp-obj (val)
1966 (zerop (logand val sb!vm:fixnum-tag-mask))
1967 ;; immediate single float, 64-bit only
1968 #!+#.(cl:if (cl:= sb!vm::n-machine-word-bits 64) '(and) '(or))
1969 (= (logand val #xff) sb!vm:single-float-widetag)
1971 (and (zerop (logandc2 val #x1fffffff)) ; Top bits zero
1972 (= (logand val #xff) sb!vm:character-widetag)) ; char tag
1974 (= val sb!vm:unbound-marker-widetag)
1976 (and (logbitp 0 val)
1977 ;; Check that the pointer is valid. XXX Could do a better
1978 ;; job. FIXME: e.g. by calling out to an is_valid_pointer
1979 ;; routine in the C runtime support code
1980 (or (< sb!vm:read-only-space-start val
1981 (* sb!vm:*read-only-space-free-pointer*
1982 sb!vm:n-word-bytes))
1983 (< sb!vm:static-space-start val
1984 (* sb!vm:*static-space-free-pointer*
1985 sb!vm:n-word-bytes))
1986 (< (current-dynamic-space-start) val
1987 (sap-int (dynamic-space-free-pointer))))))
1992 (defun sub-access-debug-var-slot (fp sc-offset &optional escaped)
1993 (macrolet ((with-escaped-value ((var) &body forms)
1995 (let ((,var (sb!vm:context-register
1997 (sb!c:sc-offset-offset sc-offset))))
1999 :invalid-value-for-unescaped-register-storage))
2000 (escaped-float-value (format)
2002 (sb!vm:context-float-register
2004 (sb!c:sc-offset-offset sc-offset)
2006 :invalid-value-for-unescaped-register-storage))
2007 (with-nfp ((var) &body body)
2008 `(let ((,var (if escaped
2010 (sb!vm:context-register escaped
2013 (sb!sys:sap-ref-sap fp (* nfp-save-offset
2014 sb!vm:n-word-bytes))
2016 (sb!vm::make-number-stack-pointer
2017 (sb!sys:sap-ref-32 fp (* nfp-save-offset
2018 sb!vm:n-word-bytes))))))
2020 (ecase (sb!c:sc-offset-scn sc-offset)
2021 ((#.sb!vm:any-reg-sc-number
2022 #.sb!vm:descriptor-reg-sc-number
2023 #!+rt #.sb!vm:word-pointer-reg-sc-number)
2024 (sb!sys:without-gcing
2025 (with-escaped-value (val) (sb!kernel:make-lisp-obj val))))
2027 (#.sb!vm:character-reg-sc-number
2028 (with-escaped-value (val)
2030 (#.sb!vm:sap-reg-sc-number
2031 (with-escaped-value (val)
2032 (sb!sys:int-sap val)))
2033 (#.sb!vm:signed-reg-sc-number
2034 (with-escaped-value (val)
2035 (if (logbitp (1- sb!vm:n-word-bits) val)
2036 (logior val (ash -1 sb!vm:n-word-bits))
2038 (#.sb!vm:unsigned-reg-sc-number
2039 (with-escaped-value (val)
2041 (#.sb!vm:non-descriptor-reg-sc-number
2042 (error "Local non-descriptor register access?"))
2043 (#.sb!vm:interior-reg-sc-number
2044 (error "Local interior register access?"))
2045 (#.sb!vm:single-reg-sc-number
2046 (escaped-float-value single-float))
2047 (#.sb!vm:double-reg-sc-number
2048 (escaped-float-value double-float))
2050 (#.sb!vm:long-reg-sc-number
2051 (escaped-float-value long-float))
2052 (#.sb!vm:complex-single-reg-sc-number
2055 (sb!vm:context-float-register
2056 escaped (sb!c:sc-offset-offset sc-offset) 'single-float)
2057 (sb!vm:context-float-register
2058 escaped (1+ (sb!c:sc-offset-offset sc-offset)) 'single-float))
2059 :invalid-value-for-unescaped-register-storage))
2060 (#.sb!vm:complex-double-reg-sc-number
2063 (sb!vm:context-float-register
2064 escaped (sb!c:sc-offset-offset sc-offset) 'double-float)
2065 (sb!vm:context-float-register
2066 escaped (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 2 #!-sparc 1)
2068 :invalid-value-for-unescaped-register-storage))
2070 (#.sb!vm:complex-long-reg-sc-number
2073 (sb!vm:context-float-register
2074 escaped (sb!c:sc-offset-offset sc-offset) 'long-float)
2075 (sb!vm:context-float-register
2076 escaped (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 4)
2078 :invalid-value-for-unescaped-register-storage))
2079 (#.sb!vm:single-stack-sc-number
2081 (sb!sys:sap-ref-single nfp (* (sb!c:sc-offset-offset sc-offset)
2082 sb!vm:n-word-bytes))))
2083 (#.sb!vm:double-stack-sc-number
2085 (sb!sys:sap-ref-double nfp (* (sb!c:sc-offset-offset sc-offset)
2086 sb!vm:n-word-bytes))))
2088 (#.sb!vm:long-stack-sc-number
2090 (sb!sys:sap-ref-long nfp (* (sb!c:sc-offset-offset sc-offset)
2091 sb!vm:n-word-bytes))))
2092 (#.sb!vm:complex-single-stack-sc-number
2095 (sb!sys:sap-ref-single nfp (* (sb!c:sc-offset-offset sc-offset)
2096 sb!vm:n-word-bytes))
2097 (sb!sys:sap-ref-single nfp (* (1+ (sb!c:sc-offset-offset sc-offset))
2098 sb!vm:n-word-bytes)))))
2099 (#.sb!vm:complex-double-stack-sc-number
2102 (sb!sys:sap-ref-double nfp (* (sb!c:sc-offset-offset sc-offset)
2103 sb!vm:n-word-bytes))
2104 (sb!sys:sap-ref-double nfp (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2105 sb!vm:n-word-bytes)))))
2107 (#.sb!vm:complex-long-stack-sc-number
2110 (sb!sys:sap-ref-long nfp (* (sb!c:sc-offset-offset sc-offset)
2111 sb!vm:n-word-bytes))
2112 (sb!sys:sap-ref-long nfp (* (+ (sb!c:sc-offset-offset sc-offset)
2114 sb!vm:n-word-bytes)))))
2115 (#.sb!vm:control-stack-sc-number
2116 (sb!kernel:stack-ref fp (sb!c:sc-offset-offset sc-offset)))
2117 (#.sb!vm:character-stack-sc-number
2119 (code-char (sb!sys:sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2120 sb!vm:n-word-bytes)))))
2121 (#.sb!vm:unsigned-stack-sc-number
2123 (sb!sys:sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2124 sb!vm:n-word-bytes))))
2125 (#.sb!vm:signed-stack-sc-number
2127 (sb!sys:signed-sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2128 sb!vm:n-word-bytes))))
2129 (#.sb!vm:sap-stack-sc-number
2131 (sb!sys:sap-ref-sap nfp (* (sb!c:sc-offset-offset sc-offset)
2132 sb!vm:n-word-bytes)))))))
2135 (defun sub-access-debug-var-slot (fp sc-offset &optional escaped)
2136 (declare (type system-area-pointer fp))
2137 (macrolet ((with-escaped-value ((var) &body forms)
2139 (let ((,var (sb!vm:context-register
2141 (sb!c:sc-offset-offset sc-offset))))
2143 :invalid-value-for-unescaped-register-storage))
2144 (escaped-float-value (format)
2146 (sb!vm:context-float-register
2147 escaped (sb!c:sc-offset-offset sc-offset) ',format)
2148 :invalid-value-for-unescaped-register-storage))
2149 (escaped-complex-float-value (format)
2152 (sb!vm:context-float-register
2153 escaped (sb!c:sc-offset-offset sc-offset) ',format)
2154 (sb!vm:context-float-register
2155 escaped (1+ (sb!c:sc-offset-offset sc-offset)) ',format))
2156 :invalid-value-for-unescaped-register-storage)))
2157 (ecase (sb!c:sc-offset-scn sc-offset)
2158 ((#.sb!vm:any-reg-sc-number #.sb!vm:descriptor-reg-sc-number)
2160 (with-escaped-value (val)
2161 (make-valid-lisp-obj val))))
2162 (#.sb!vm:character-reg-sc-number
2163 (with-escaped-value (val)
2165 (#.sb!vm:sap-reg-sc-number
2166 (with-escaped-value (val)
2168 (#.sb!vm:signed-reg-sc-number
2169 (with-escaped-value (val)
2170 (if (logbitp (1- sb!vm:n-word-bits) val)
2171 (logior val (ash -1 sb!vm:n-word-bits))
2173 (#.sb!vm:unsigned-reg-sc-number
2174 (with-escaped-value (val)
2176 (#.sb!vm:single-reg-sc-number
2177 (escaped-float-value single-float))
2178 (#.sb!vm:double-reg-sc-number
2179 (escaped-float-value double-float))
2181 (#.sb!vm:long-reg-sc-number
2182 (escaped-float-value long-float))
2183 (#.sb!vm:complex-single-reg-sc-number
2184 (escaped-complex-float-value single-float))
2185 (#.sb!vm:complex-double-reg-sc-number
2186 (escaped-complex-float-value double-float))
2188 (#.sb!vm:complex-long-reg-sc-number
2189 (escaped-complex-float-value long-float))
2190 (#.sb!vm:single-stack-sc-number
2191 (sap-ref-single fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2192 sb!vm:n-word-bytes))))
2193 (#.sb!vm:double-stack-sc-number
2194 (sap-ref-double fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2195 sb!vm:n-word-bytes))))
2197 (#.sb!vm:long-stack-sc-number
2198 (sap-ref-long fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2199 sb!vm:n-word-bytes))))
2200 (#.sb!vm:complex-single-stack-sc-number
2202 (sap-ref-single fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2203 sb!vm:n-word-bytes)))
2204 (sap-ref-single fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2205 sb!vm:n-word-bytes)))))
2206 (#.sb!vm:complex-double-stack-sc-number
2208 (sap-ref-double fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2209 sb!vm:n-word-bytes)))
2210 (sap-ref-double fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 4)
2211 sb!vm:n-word-bytes)))))
2213 (#.sb!vm:complex-long-stack-sc-number
2215 (sap-ref-long fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2216 sb!vm:n-word-bytes)))
2217 (sap-ref-long fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 6)
2218 sb!vm:n-word-bytes)))))
2219 (#.sb!vm:control-stack-sc-number
2220 (stack-ref fp (sb!c:sc-offset-offset sc-offset)))
2221 (#.sb!vm:character-stack-sc-number
2223 (sap-ref-word fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2224 sb!vm:n-word-bytes)))))
2225 (#.sb!vm:unsigned-stack-sc-number
2226 (sap-ref-word fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2227 sb!vm:n-word-bytes))))
2228 (#.sb!vm:signed-stack-sc-number
2229 (signed-sap-ref-word fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2230 sb!vm:n-word-bytes))))
2231 (#.sb!vm:sap-stack-sc-number
2232 (sap-ref-sap fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2233 sb!vm:n-word-bytes)))))))
2235 ;;; This stores value as the value of DEBUG-VAR in FRAME. In the
2236 ;;; COMPILED-DEBUG-VAR case, access the current value to determine if
2237 ;;; it is an indirect value cell. This occurs when the variable is
2238 ;;; both closed over and set.
2239 (defun %set-debug-var-value (debug-var frame new-value)
2240 (aver (typep frame 'compiled-frame))
2241 (let ((old-value (access-compiled-debug-var-slot debug-var frame)))
2242 (if (indirect-value-cell-p old-value)
2243 (value-cell-set old-value new-value)
2244 (set-compiled-debug-var-slot debug-var frame new-value)))
2247 ;;; This stores VALUE for the variable represented by debug-var
2248 ;;; relative to the frame. This assumes the location directly contains
2249 ;;; the variable's value; that is, there is no indirect value cell
2250 ;;; currently there in case the variable is both closed over and set.
2251 (defun set-compiled-debug-var-slot (debug-var frame value)
2252 (let ((escaped (compiled-frame-escaped frame)))
2254 (sub-set-debug-var-slot (frame-pointer frame)
2255 (compiled-debug-var-sc-offset debug-var)
2257 (sub-set-debug-var-slot
2258 (frame-pointer frame)
2259 (or (compiled-debug-var-save-sc-offset debug-var)
2260 (compiled-debug-var-sc-offset debug-var))
2264 (defun sub-set-debug-var-slot (fp sc-offset value &optional escaped)
2265 (macrolet ((set-escaped-value (val)
2267 (setf (sb!vm:context-register
2269 (sb!c:sc-offset-offset sc-offset))
2272 (set-escaped-float-value (format val)
2274 (setf (sb!vm:context-float-register
2276 (sb!c:sc-offset-offset sc-offset)
2280 (with-nfp ((var) &body body)
2281 `(let ((,var (if escaped
2283 (sb!vm:context-register escaped
2288 sb!vm:n-word-bytes))
2290 (sb!vm::make-number-stack-pointer
2293 sb!vm:n-word-bytes))))))
2295 (ecase (sb!c:sc-offset-scn sc-offset)
2296 ((#.sb!vm:any-reg-sc-number
2297 #.sb!vm:descriptor-reg-sc-number
2298 #!+rt #.sb!vm:word-pointer-reg-sc-number)
2301 (get-lisp-obj-address value))))
2302 (#.sb!vm:character-reg-sc-number
2303 (set-escaped-value (char-code value)))
2304 (#.sb!vm:sap-reg-sc-number
2305 (set-escaped-value (sap-int value)))
2306 (#.sb!vm:signed-reg-sc-number
2307 (set-escaped-value (logand value (1- (ash 1 sb!vm:n-word-bits)))))
2308 (#.sb!vm:unsigned-reg-sc-number
2309 (set-escaped-value value))
2310 (#.sb!vm:non-descriptor-reg-sc-number
2311 (error "Local non-descriptor register access?"))
2312 (#.sb!vm:interior-reg-sc-number
2313 (error "Local interior register access?"))
2314 (#.sb!vm:single-reg-sc-number
2315 (set-escaped-float-value single-float value))
2316 (#.sb!vm:double-reg-sc-number
2317 (set-escaped-float-value double-float value))
2319 (#.sb!vm:long-reg-sc-number
2320 (set-escaped-float-value long-float value))
2321 (#.sb!vm:complex-single-reg-sc-number
2323 (setf (sb!vm:context-float-register escaped
2324 (sb!c:sc-offset-offset sc-offset)
2327 (setf (sb!vm:context-float-register
2328 escaped (1+ (sb!c:sc-offset-offset sc-offset))
2332 (#.sb!vm:complex-double-reg-sc-number
2334 (setf (sb!vm:context-float-register
2335 escaped (sb!c:sc-offset-offset sc-offset) 'double-float)
2337 (setf (sb!vm:context-float-register
2339 (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 2 #!-sparc 1)
2344 (#.sb!vm:complex-long-reg-sc-number
2346 (setf (sb!vm:context-float-register
2347 escaped (sb!c:sc-offset-offset sc-offset) 'long-float)
2349 (setf (sb!vm:context-float-register
2351 (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 4)
2355 (#.sb!vm:single-stack-sc-number
2357 (setf (sap-ref-single nfp (* (sb!c:sc-offset-offset sc-offset)
2358 sb!vm:n-word-bytes))
2359 (the single-float value))))
2360 (#.sb!vm:double-stack-sc-number
2362 (setf (sap-ref-double nfp (* (sb!c:sc-offset-offset sc-offset)
2363 sb!vm:n-word-bytes))
2364 (the double-float value))))
2366 (#.sb!vm:long-stack-sc-number
2368 (setf (sap-ref-long nfp (* (sb!c:sc-offset-offset sc-offset)
2369 sb!vm:n-word-bytes))
2370 (the long-float value))))
2371 (#.sb!vm:complex-single-stack-sc-number
2373 (setf (sap-ref-single
2374 nfp (* (sb!c:sc-offset-offset sc-offset) sb!vm:n-word-bytes))
2375 (the single-float (realpart value)))
2376 (setf (sap-ref-single
2377 nfp (* (1+ (sb!c:sc-offset-offset sc-offset))
2378 sb!vm:n-word-bytes))
2379 (the single-float (realpart value)))))
2380 (#.sb!vm:complex-double-stack-sc-number
2382 (setf (sap-ref-double
2383 nfp (* (sb!c:sc-offset-offset sc-offset) sb!vm:n-word-bytes))
2384 (the double-float (realpart value)))
2385 (setf (sap-ref-double
2386 nfp (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2387 sb!vm:n-word-bytes))
2388 (the double-float (realpart value)))))
2390 (#.sb!vm:complex-long-stack-sc-number
2393 nfp (* (sb!c:sc-offset-offset sc-offset) sb!vm:n-word-bytes))
2394 (the long-float (realpart value)))
2396 nfp (* (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 4)
2397 sb!vm:n-word-bytes))
2398 (the long-float (realpart value)))))
2399 (#.sb!vm:control-stack-sc-number
2400 (setf (stack-ref fp (sb!c:sc-offset-offset sc-offset)) value))
2401 (#.sb!vm:character-stack-sc-number
2403 (setf (sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2404 sb!vm:n-word-bytes))
2405 (char-code (the character value)))))
2406 (#.sb!vm:unsigned-stack-sc-number
2408 (setf (sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2409 sb!vm:n-word-bytes))
2410 (the (unsigned-byte 32) value))))
2411 (#.sb!vm:signed-stack-sc-number
2413 (setf (signed-sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2414 sb!vm:n-word-bytes))
2415 (the (signed-byte 32) value))))
2416 (#.sb!vm:sap-stack-sc-number
2418 (setf (sap-ref-sap nfp (* (sb!c:sc-offset-offset sc-offset)
2419 sb!vm:n-word-bytes))
2420 (the system-area-pointer value)))))))
2423 (defun sub-set-debug-var-slot (fp sc-offset value &optional escaped)
2424 (macrolet ((set-escaped-value (val)
2426 (setf (sb!vm:context-register
2428 (sb!c:sc-offset-offset sc-offset))
2431 (ecase (sb!c:sc-offset-scn sc-offset)
2432 ((#.sb!vm:any-reg-sc-number #.sb!vm:descriptor-reg-sc-number)
2435 (get-lisp-obj-address value))))
2436 (#.sb!vm:character-reg-sc-number
2437 (set-escaped-value (char-code value)))
2438 (#.sb!vm:sap-reg-sc-number
2439 (set-escaped-value (sap-int value)))
2440 (#.sb!vm:signed-reg-sc-number
2441 (set-escaped-value (logand value (1- (ash 1 sb!vm:n-word-bits)))))
2442 (#.sb!vm:unsigned-reg-sc-number
2443 (set-escaped-value value))
2444 (#.sb!vm:single-reg-sc-number
2445 #+nil ;; don't have escaped floats.
2446 (set-escaped-float-value single-float value))
2447 (#.sb!vm:double-reg-sc-number
2448 #+nil ;; don't have escaped floats -- still in npx?
2449 (set-escaped-float-value double-float value))
2451 (#.sb!vm:long-reg-sc-number
2452 #+nil ;; don't have escaped floats -- still in npx?
2453 (set-escaped-float-value long-float value))
2454 (#.sb!vm:single-stack-sc-number
2455 (setf (sap-ref-single
2456 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2457 sb!vm:n-word-bytes)))
2458 (the single-float value)))
2459 (#.sb!vm:double-stack-sc-number
2460 (setf (sap-ref-double
2461 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2462 sb!vm:n-word-bytes)))
2463 (the double-float value)))
2465 (#.sb!vm:long-stack-sc-number
2467 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2468 sb!vm:n-word-bytes)))
2469 (the long-float value)))
2470 (#.sb!vm:complex-single-stack-sc-number
2471 (setf (sap-ref-single
2472 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2473 sb!vm:n-word-bytes)))
2474 (realpart (the (complex single-float) value)))
2475 (setf (sap-ref-single
2476 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2477 sb!vm:n-word-bytes)))
2478 (imagpart (the (complex single-float) value))))
2479 (#.sb!vm:complex-double-stack-sc-number
2480 (setf (sap-ref-double
2481 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2482 sb!vm:n-word-bytes)))
2483 (realpart (the (complex double-float) value)))
2484 (setf (sap-ref-double
2485 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 4)
2486 sb!vm:n-word-bytes)))
2487 (imagpart (the (complex double-float) value))))
2489 (#.sb!vm:complex-long-stack-sc-number
2491 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2492 sb!vm:n-word-bytes)))
2493 (realpart (the (complex long-float) value)))
2495 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 6)
2496 sb!vm:n-word-bytes)))
2497 (imagpart (the (complex long-float) value))))
2498 (#.sb!vm:control-stack-sc-number
2499 (setf (stack-ref fp (sb!c:sc-offset-offset sc-offset)) value))
2500 (#.sb!vm:character-stack-sc-number
2501 (setf (sap-ref-word fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2502 sb!vm:n-word-bytes)))
2503 (char-code (the character value))))
2504 (#.sb!vm:unsigned-stack-sc-number
2505 (setf (sap-ref-word fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2506 sb!vm:n-word-bytes)))
2507 (the sb!vm:word value)))
2508 (#.sb!vm:signed-stack-sc-number
2509 (setf (signed-sap-ref-word
2510 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2511 sb!vm:n-word-bytes)))
2512 (the (signed-byte #.sb!vm:n-word-bits) value)))
2513 (#.sb!vm:sap-stack-sc-number
2514 (setf (sap-ref-sap fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2515 sb!vm:n-word-bytes)))
2516 (the system-area-pointer value))))))
2518 ;;; The method for setting and accessing COMPILED-DEBUG-VAR values use
2519 ;;; this to determine if the value stored is the actual value or an
2520 ;;; indirection cell.
2521 (defun indirect-value-cell-p (x)
2522 (and (= (lowtag-of x) sb!vm:other-pointer-lowtag)
2523 (= (widetag-of x) sb!vm:value-cell-header-widetag)))
2525 ;;; Return three values reflecting the validity of DEBUG-VAR's value
2526 ;;; at BASIC-CODE-LOCATION:
2527 ;;; :VALID The value is known to be available.
2528 ;;; :INVALID The value is known to be unavailable.
2529 ;;; :UNKNOWN The value's availability is unknown.
2531 ;;; If the variable is always alive, then it is valid. If the
2532 ;;; code-location is unknown, then the variable's validity is
2533 ;;; :unknown. Once we've called CODE-LOCATION-UNKNOWN-P, we know the
2534 ;;; live-set information has been cached in the code-location.
2535 (defun debug-var-validity (debug-var basic-code-location)
2536 (etypecase debug-var
2538 (compiled-debug-var-validity debug-var basic-code-location))
2539 ;; (There used to be more cases back before sbcl-0.7.0, when
2540 ;; we did special tricks to debug the IR1 interpreter.)
2543 ;;; This is the method for DEBUG-VAR-VALIDITY for COMPILED-DEBUG-VARs.
2544 ;;; For safety, make sure basic-code-location is what we think.
2545 (defun compiled-debug-var-validity (debug-var basic-code-location)
2546 (declare (type compiled-code-location basic-code-location))
2547 (cond ((debug-var-alive-p debug-var)
2548 (let ((debug-fun (code-location-debug-fun basic-code-location)))
2549 (if (>= (compiled-code-location-pc basic-code-location)
2550 (sb!c::compiled-debug-fun-start-pc
2551 (compiled-debug-fun-compiler-debug-fun debug-fun)))
2554 ((code-location-unknown-p basic-code-location) :unknown)
2556 (let ((pos (position debug-var
2557 (debug-fun-debug-vars
2558 (code-location-debug-fun
2559 basic-code-location)))))
2561 (error 'unknown-debug-var
2562 :debug-var debug-var
2564 (code-location-debug-fun basic-code-location)))
2565 ;; There must be live-set info since basic-code-location is known.
2566 (if (zerop (sbit (compiled-code-location-live-set
2567 basic-code-location)
2574 ;;; This code produces and uses what we call source-paths. A
2575 ;;; source-path is a list whose first element is a form number as
2576 ;;; returned by CODE-LOCATION-FORM-NUMBER and whose last element is a
2577 ;;; top level form number as returned by
2578 ;;; CODE-LOCATION-TOPLEVEL-FORM-NUMBER. The elements from the last to
2579 ;;; the first, exclusively, are the numbered subforms into which to
2580 ;;; descend. For example:
2582 ;;; (let ((a (aref x 3)))
2584 ;;; The call to AREF in this example is form number 5. Assuming this
2585 ;;; DEFUN is the 11'th top level form, the source-path for the AREF
2586 ;;; call is as follows:
2588 ;;; Given the DEFUN, 3 gets you the LET, 1 gets you the bindings, 0
2589 ;;; gets the first binding, and 1 gets the AREF form.
2591 ;;; temporary buffer used to build form-number => source-path translation in
2592 ;;; FORM-NUMBER-TRANSLATIONS
2593 (defvar *form-number-temp* (make-array 10 :fill-pointer 0 :adjustable t))
2595 ;;; table used to detect CAR circularities in FORM-NUMBER-TRANSLATIONS
2596 (defvar *form-number-circularity-table* (make-hash-table :test 'eq))
2598 ;;; This returns a table mapping form numbers to source-paths. A
2599 ;;; source-path indicates a descent into the TOPLEVEL-FORM form,
2600 ;;; going directly to the subform corressponding to the form number.
2602 ;;; The vector elements are in the same format as the compiler's
2603 ;;; NODE-SOURCE-PATH; that is, the first element is the form number and
2604 ;;; the last is the TOPLEVEL-FORM number.
2605 (defun form-number-translations (form tlf-number)
2606 (clrhash *form-number-circularity-table*)
2607 (setf (fill-pointer *form-number-temp*) 0)
2608 (sub-translate-form-numbers form (list tlf-number))
2609 (coerce *form-number-temp* 'simple-vector))
2610 (defun sub-translate-form-numbers (form path)
2611 (unless (gethash form *form-number-circularity-table*)
2612 (setf (gethash form *form-number-circularity-table*) t)
2613 (vector-push-extend (cons (fill-pointer *form-number-temp*) path)
2618 (declare (fixnum pos))
2621 (when (atom subform) (return))
2622 (let ((fm (car subform)))
2624 (sub-translate-form-numbers fm (cons pos path)))
2626 (setq subform (cdr subform))
2627 (when (eq subform trail) (return)))))
2631 (setq trail (cdr trail)))))))
2633 ;;; FORM is a top level form, and path is a source-path into it. This
2634 ;;; returns the form indicated by the source-path. Context is the
2635 ;;; number of enclosing forms to return instead of directly returning
2636 ;;; the source-path form. When context is non-zero, the form returned
2637 ;;; contains a marker, #:****HERE****, immediately before the form
2638 ;;; indicated by path.
2639 (defun source-path-context (form path context)
2640 (declare (type unsigned-byte context))
2641 ;; Get to the form indicated by path or the enclosing form indicated
2642 ;; by context and path.
2643 (let ((path (reverse (butlast (cdr path)))))
2644 (dotimes (i (- (length path) context))
2645 (let ((index (first path)))
2646 (unless (and (listp form) (< index (length form)))
2647 (error "Source path no longer exists."))
2648 (setq form (elt form index))
2649 (setq path (rest path))))
2650 ;; Recursively rebuild the source form resulting from the above
2651 ;; descent, copying the beginning of each subform up to the next
2652 ;; subform we descend into according to path. At the bottom of the
2653 ;; recursion, we return the form indicated by path preceded by our
2654 ;; marker, and this gets spliced into the resulting list structure
2655 ;; on the way back up.
2656 (labels ((frob (form path level)
2657 (if (or (zerop level) (null path))
2660 `(#:***here*** ,form))
2661 (let ((n (first path)))
2662 (unless (and (listp form) (< n (length form)))
2663 (error "Source path no longer exists."))
2664 (let ((res (frob (elt form n) (rest path) (1- level))))
2665 (nconc (subseq form 0 n)
2666 (cons res (nthcdr (1+ n) form))))))))
2667 (frob form path context))))
2669 ;;;; PREPROCESS-FOR-EVAL
2671 ;;; Return a function of one argument that evaluates form in the
2672 ;;; lexical context of the BASIC-CODE-LOCATION LOC, or signal a
2673 ;;; NO-DEBUG-VARS condition when the LOC's DEBUG-FUN has no
2674 ;;; DEBUG-VAR information available.
2676 ;;; The returned function takes the frame to get values from as its
2677 ;;; argument, and it returns the values of FORM. The returned function
2678 ;;; can signal the following conditions: INVALID-VALUE,
2679 ;;; AMBIGUOUS-VAR-NAME, and FRAME-FUN-MISMATCH.
2680 (defun preprocess-for-eval (form loc)
2681 (declare (type code-location loc))
2682 (let ((n-frame (gensym))
2683 (fun (code-location-debug-fun loc)))
2684 (unless (debug-var-info-available fun)
2685 (debug-signal 'no-debug-vars :debug-fun fun))
2686 (sb!int:collect ((binds)
2688 (do-debug-fun-vars (var fun)
2689 (let ((validity (debug-var-validity var loc)))
2690 (unless (eq validity :invalid)
2691 (let* ((sym (debug-var-symbol var))
2692 (found (assoc sym (binds))))
2694 (setf (second found) :ambiguous)
2695 (binds (list sym validity var)))))))
2696 (dolist (bind (binds))
2697 (let ((name (first bind))
2699 (ecase (second bind)
2701 (specs `(,name (debug-var-value ',var ,n-frame))))
2703 (specs `(,name (debug-signal 'invalid-value
2707 (specs `(,name (debug-signal 'ambiguous-var-name
2709 :frame ,n-frame)))))))
2710 (let ((res (coerce `(lambda (,n-frame)
2711 (declare (ignorable ,n-frame))
2712 (symbol-macrolet ,(specs) ,form))
2715 ;; This prevents these functions from being used in any
2716 ;; location other than a function return location, so maybe
2717 ;; this should only check whether FRAME's DEBUG-FUN is the
2719 (unless (code-location= (frame-code-location frame) loc)
2720 (debug-signal 'frame-fun-mismatch
2721 :code-location loc :form form :frame frame))
2722 (funcall res frame))))))
2726 ;;;; user-visible interface
2728 ;;; Create and return a breakpoint. When program execution encounters
2729 ;;; the breakpoint, the system calls HOOK-FUN. HOOK-FUN takes the
2730 ;;; current frame for the function in which the program is running and
2731 ;;; the breakpoint object.
2733 ;;; WHAT and KIND determine where in a function the system invokes
2734 ;;; HOOK-FUN. WHAT is either a code-location or a DEBUG-FUN. KIND is
2735 ;;; one of :CODE-LOCATION, :FUN-START, or :FUN-END. Since the starts
2736 ;;; and ends of functions may not have code-locations representing
2737 ;;; them, designate these places by supplying WHAT as a DEBUG-FUN and
2738 ;;; KIND indicating the :FUN-START or :FUN-END. When WHAT is a
2739 ;;; DEBUG-FUN and kind is :FUN-END, then HOOK-FUN must take two
2740 ;;; additional arguments, a list of values returned by the function
2741 ;;; and a FUN-END-COOKIE.
2743 ;;; INFO is information supplied by and used by the user.
2745 ;;; FUN-END-COOKIE is a function. To implement :FUN-END
2746 ;;; breakpoints, the system uses starter breakpoints to establish the
2747 ;;; :FUN-END breakpoint for each invocation of the function. Upon
2748 ;;; each entry, the system creates a unique cookie to identify the
2749 ;;; invocation, and when the user supplies a function for this
2750 ;;; argument, the system invokes it on the frame and the cookie. The
2751 ;;; system later invokes the :FUN-END breakpoint hook on the same
2752 ;;; cookie. The user may save the cookie for comparison in the hook
2755 ;;; Signal an error if WHAT is an unknown code-location.
2756 (defun make-breakpoint (hook-fun what
2757 &key (kind :code-location) info fun-end-cookie)
2760 (when (code-location-unknown-p what)
2761 (error "cannot make a breakpoint at an unknown code location: ~S"
2763 (aver (eq kind :code-location))
2764 (let ((bpt (%make-breakpoint hook-fun what kind info)))
2766 (compiled-code-location
2767 ;; This slot is filled in due to calling CODE-LOCATION-UNKNOWN-P.
2768 (when (eq (compiled-code-location-kind what) :unknown-return)
2769 (let ((other-bpt (%make-breakpoint hook-fun what
2770 :unknown-return-partner
2772 (setf (breakpoint-unknown-return-partner bpt) other-bpt)
2773 (setf (breakpoint-unknown-return-partner other-bpt) bpt))))
2774 ;; (There used to be more cases back before sbcl-0.7.0,,
2775 ;; when we did special tricks to debug the IR1
2782 (%make-breakpoint hook-fun what kind info))
2784 (unless (eq (sb!c::compiled-debug-fun-returns
2785 (compiled-debug-fun-compiler-debug-fun what))
2787 (error ":FUN-END breakpoints are currently unsupported ~
2788 for the known return convention."))
2790 (let* ((bpt (%make-breakpoint hook-fun what kind info))
2791 (starter (compiled-debug-fun-end-starter what)))
2793 (setf starter (%make-breakpoint #'list what :fun-start nil))
2794 (setf (breakpoint-hook-fun starter)
2795 (fun-end-starter-hook starter what))
2796 (setf (compiled-debug-fun-end-starter what) starter))
2797 (setf (breakpoint-start-helper bpt) starter)
2798 (push bpt (breakpoint-%info starter))
2799 (setf (breakpoint-cookie-fun bpt) fun-end-cookie)
2802 ;;; These are unique objects created upon entry into a function by a
2803 ;;; :FUN-END breakpoint's starter hook. These are only created
2804 ;;; when users supply :FUN-END-COOKIE to MAKE-BREAKPOINT. Also,
2805 ;;; the :FUN-END breakpoint's hook is called on the same cookie
2806 ;;; when it is created.
2807 (defstruct (fun-end-cookie
2808 (:print-object (lambda (obj str)
2809 (print-unreadable-object (obj str :type t))))
2810 (:constructor make-fun-end-cookie (bogus-lra debug-fun))
2812 ;; a pointer to the bogus-lra created for :FUN-END breakpoints
2814 ;; the DEBUG-FUN associated with this cookie
2817 ;;; This maps bogus-lra-components to cookies, so that
2818 ;;; HANDLE-FUN-END-BREAKPOINT can find the appropriate cookie for the
2819 ;;; breakpoint hook.
2820 (defvar *fun-end-cookies* (make-hash-table :test 'eq))
2822 ;;; This returns a hook function for the start helper breakpoint
2823 ;;; associated with a :FUN-END breakpoint. The returned function
2824 ;;; makes a fake LRA that all returns go through, and this piece of
2825 ;;; fake code actually breaks. Upon return from the break, the code
2826 ;;; provides the returnee with any values. Since the returned function
2827 ;;; effectively activates FUN-END-BPT on each entry to DEBUG-FUN's
2828 ;;; function, we must establish breakpoint-data about FUN-END-BPT.
2829 (defun fun-end-starter-hook (starter-bpt debug-fun)
2830 (declare (type breakpoint starter-bpt)
2831 (type compiled-debug-fun debug-fun))
2832 (lambda (frame breakpoint)
2833 (declare (ignore breakpoint)
2835 (let ((lra-sc-offset
2836 (sb!c::compiled-debug-fun-return-pc
2837 (compiled-debug-fun-compiler-debug-fun debug-fun))))
2838 (multiple-value-bind (lra component offset)
2840 (get-context-value frame
2843 (setf (get-context-value frame
2847 (let ((end-bpts (breakpoint-%info starter-bpt)))
2848 (let ((data (breakpoint-data component offset)))
2849 (setf (breakpoint-data-breakpoints data) end-bpts)
2850 (dolist (bpt end-bpts)
2851 (setf (breakpoint-internal-data bpt) data)))
2852 (let ((cookie (make-fun-end-cookie lra debug-fun)))
2853 (setf (gethash component *fun-end-cookies*) cookie)
2854 (dolist (bpt end-bpts)
2855 (let ((fun (breakpoint-cookie-fun bpt)))
2856 (when fun (funcall fun frame cookie))))))))))
2858 ;;; This takes a FUN-END-COOKIE and a frame, and it returns
2859 ;;; whether the cookie is still valid. A cookie becomes invalid when
2860 ;;; the frame that established the cookie has exited. Sometimes cookie
2861 ;;; holders are unaware of cookie invalidation because their
2862 ;;; :FUN-END breakpoint hooks didn't run due to THROW'ing.
2864 ;;; This takes a frame as an efficiency hack since the user probably
2865 ;;; has a frame object in hand when using this routine, and it saves
2866 ;;; repeated parsing of the stack and consing when asking whether a
2867 ;;; series of cookies is valid.
2868 (defun fun-end-cookie-valid-p (frame cookie)
2869 (let ((lra (fun-end-cookie-bogus-lra cookie))
2870 (lra-sc-offset (sb!c::compiled-debug-fun-return-pc
2871 (compiled-debug-fun-compiler-debug-fun
2872 (fun-end-cookie-debug-fun cookie)))))
2873 (do ((frame frame (frame-down frame)))
2875 (when (and (compiled-frame-p frame)
2876 (#!-(or x86 x86-64) eq #!+(or x86 x86-64) sap=
2878 (get-context-value frame lra-save-offset lra-sc-offset)))
2881 ;;;; ACTIVATE-BREAKPOINT
2883 ;;; Cause the system to invoke the breakpoint's hook function until
2884 ;;; the next call to DEACTIVATE-BREAKPOINT or DELETE-BREAKPOINT. The
2885 ;;; system invokes breakpoint hook functions in the opposite order
2886 ;;; that you activate them.
2887 (defun activate-breakpoint (breakpoint)
2888 (when (eq (breakpoint-status breakpoint) :deleted)
2889 (error "cannot activate a deleted breakpoint: ~S" breakpoint))
2890 (unless (eq (breakpoint-status breakpoint) :active)
2891 (ecase (breakpoint-kind breakpoint)
2893 (let ((loc (breakpoint-what breakpoint)))
2895 (compiled-code-location
2896 (activate-compiled-code-location-breakpoint breakpoint)
2897 (let ((other (breakpoint-unknown-return-partner breakpoint)))
2899 (activate-compiled-code-location-breakpoint other))))
2900 ;; (There used to be more cases back before sbcl-0.7.0, when
2901 ;; we did special tricks to debug the IR1 interpreter.)
2904 (etypecase (breakpoint-what breakpoint)
2906 (activate-compiled-fun-start-breakpoint breakpoint))
2907 ;; (There used to be more cases back before sbcl-0.7.0, when
2908 ;; we did special tricks to debug the IR1 interpreter.)
2911 (etypecase (breakpoint-what breakpoint)
2913 (let ((starter (breakpoint-start-helper breakpoint)))
2914 (unless (eq (breakpoint-status starter) :active)
2915 ;; may already be active by some other :FUN-END breakpoint
2916 (activate-compiled-fun-start-breakpoint starter)))
2917 (setf (breakpoint-status breakpoint) :active))
2918 ;; (There used to be more cases back before sbcl-0.7.0, when
2919 ;; we did special tricks to debug the IR1 interpreter.)
2923 (defun activate-compiled-code-location-breakpoint (breakpoint)
2924 (declare (type breakpoint breakpoint))
2925 (let ((loc (breakpoint-what breakpoint)))
2926 (declare (type compiled-code-location loc))
2927 (sub-activate-breakpoint
2929 (breakpoint-data (compiled-debug-fun-component
2930 (code-location-debug-fun loc))
2931 (+ (compiled-code-location-pc loc)
2932 (if (or (eq (breakpoint-kind breakpoint)
2933 :unknown-return-partner)
2934 (eq (compiled-code-location-kind loc)
2935 :single-value-return))
2936 sb!vm:single-value-return-byte-offset
2939 (defun activate-compiled-fun-start-breakpoint (breakpoint)
2940 (declare (type breakpoint breakpoint))
2941 (let ((debug-fun (breakpoint-what breakpoint)))
2942 (sub-activate-breakpoint
2944 (breakpoint-data (compiled-debug-fun-component debug-fun)
2945 (sb!c::compiled-debug-fun-start-pc
2946 (compiled-debug-fun-compiler-debug-fun
2949 (defun sub-activate-breakpoint (breakpoint data)
2950 (declare (type breakpoint breakpoint)
2951 (type breakpoint-data data))
2952 (setf (breakpoint-status breakpoint) :active)
2954 (unless (breakpoint-data-breakpoints data)
2955 (setf (breakpoint-data-instruction data)
2957 (breakpoint-install (get-lisp-obj-address
2958 (breakpoint-data-component data))
2959 (breakpoint-data-offset data)))))
2960 (setf (breakpoint-data-breakpoints data)
2961 (append (breakpoint-data-breakpoints data) (list breakpoint)))
2962 (setf (breakpoint-internal-data breakpoint) data)))
2964 ;;;; DEACTIVATE-BREAKPOINT
2966 ;;; Stop the system from invoking the breakpoint's hook function.
2967 (defun deactivate-breakpoint (breakpoint)
2968 (when (eq (breakpoint-status breakpoint) :active)
2970 (let ((loc (breakpoint-what breakpoint)))
2972 ((or compiled-code-location compiled-debug-fun)
2973 (deactivate-compiled-breakpoint breakpoint)
2974 (let ((other (breakpoint-unknown-return-partner breakpoint)))
2976 (deactivate-compiled-breakpoint other))))
2977 ;; (There used to be more cases back before sbcl-0.7.0, when
2978 ;; we did special tricks to debug the IR1 interpreter.)
2982 (defun deactivate-compiled-breakpoint (breakpoint)
2983 (if (eq (breakpoint-kind breakpoint) :fun-end)
2984 (let ((starter (breakpoint-start-helper breakpoint)))
2985 (unless (find-if (lambda (bpt)
2986 (and (not (eq bpt breakpoint))
2987 (eq (breakpoint-status bpt) :active)))
2988 (breakpoint-%info starter))
2989 (deactivate-compiled-breakpoint starter)))
2990 (let* ((data (breakpoint-internal-data breakpoint))
2991 (bpts (delete breakpoint (breakpoint-data-breakpoints data))))
2992 (setf (breakpoint-internal-data breakpoint) nil)
2993 (setf (breakpoint-data-breakpoints data) bpts)
2996 (breakpoint-remove (get-lisp-obj-address
2997 (breakpoint-data-component data))
2998 (breakpoint-data-offset data)
2999 (breakpoint-data-instruction data)))
3000 (delete-breakpoint-data data))))
3001 (setf (breakpoint-status breakpoint) :inactive)
3004 ;;;; BREAKPOINT-INFO
3006 ;;; Return the user-maintained info associated with breakpoint. This
3008 (defun breakpoint-info (breakpoint)
3009 (breakpoint-%info breakpoint))
3010 (defun %set-breakpoint-info (breakpoint value)
3011 (setf (breakpoint-%info breakpoint) value)
3012 (let ((other (breakpoint-unknown-return-partner breakpoint)))
3014 (setf (breakpoint-%info other) value))))
3016 ;;;; BREAKPOINT-ACTIVE-P and DELETE-BREAKPOINT
3018 (defun breakpoint-active-p (breakpoint)
3019 (ecase (breakpoint-status breakpoint)
3021 ((:inactive :deleted) nil)))
3023 ;;; Free system storage and remove computational overhead associated
3024 ;;; with breakpoint. After calling this, breakpoint is completely
3025 ;;; impotent and can never become active again.
3026 (defun delete-breakpoint (breakpoint)
3027 (let ((status (breakpoint-status breakpoint)))
3028 (unless (eq status :deleted)
3029 (when (eq status :active)
3030 (deactivate-breakpoint breakpoint))
3031 (setf (breakpoint-status breakpoint) :deleted)
3032 (let ((other (breakpoint-unknown-return-partner breakpoint)))
3034 (setf (breakpoint-status other) :deleted)))
3035 (when (eq (breakpoint-kind breakpoint) :fun-end)
3036 (let* ((starter (breakpoint-start-helper breakpoint))
3037 (breakpoints (delete breakpoint
3038 (the list (breakpoint-info starter)))))
3039 (setf (breakpoint-info starter) breakpoints)
3041 (delete-breakpoint starter)
3042 (setf (compiled-debug-fun-end-starter
3043 (breakpoint-what breakpoint))
3047 ;;;; C call out stubs
3049 ;;; This actually installs the break instruction in the component. It
3050 ;;; returns the overwritten bits. You must call this in a context in
3051 ;;; which GC is disabled, so that Lisp doesn't move objects around
3052 ;;; that C is pointing to.
3053 (sb!alien:define-alien-routine "breakpoint_install" sb!alien:unsigned-int
3054 (code-obj sb!alien:unsigned-long)
3055 (pc-offset sb!alien:int))
3057 ;;; This removes the break instruction and replaces the original
3058 ;;; instruction. You must call this in a context in which GC is disabled
3059 ;;; so Lisp doesn't move objects around that C is pointing to.
3060 (sb!alien:define-alien-routine "breakpoint_remove" sb!alien:void
3061 (code-obj sb!alien:unsigned-long)
3062 (pc-offset sb!alien:int)
3063 (old-inst sb!alien:unsigned-int))
3065 (sb!alien:define-alien-routine "breakpoint_do_displaced_inst" sb!alien:void
3066 (scp (* os-context-t))
3067 (orig-inst sb!alien:unsigned-int))
3069 ;;;; breakpoint handlers (layer between C and exported interface)
3071 ;;; This maps components to a mapping of offsets to BREAKPOINT-DATAs.
3072 (defvar *component-breakpoint-offsets* (make-hash-table :test 'eq))
3074 ;;; This returns the BREAKPOINT-DATA object associated with component cross
3075 ;;; offset. If none exists, this makes one, installs it, and returns it.
3076 (defun breakpoint-data (component offset &optional (create t))
3077 (flet ((install-breakpoint-data ()
3079 (let ((data (make-breakpoint-data component offset)))
3080 (push (cons offset data)
3081 (gethash component *component-breakpoint-offsets*))
3083 (let ((offsets (gethash component *component-breakpoint-offsets*)))
3085 (let ((data (assoc offset offsets)))
3088 (install-breakpoint-data)))
3089 (install-breakpoint-data)))))
3091 ;;; We use this when there are no longer any active breakpoints
3092 ;;; corresponding to DATA.
3093 (defun delete-breakpoint-data (data)
3094 (let* ((component (breakpoint-data-component data))
3095 (offsets (delete (breakpoint-data-offset data)
3096 (gethash component *component-breakpoint-offsets*)
3099 (setf (gethash component *component-breakpoint-offsets*) offsets)
3100 (remhash component *component-breakpoint-offsets*)))
3103 ;;; The C handler for interrupts calls this when it has a
3104 ;;; debugging-tool break instruction. This does *not* handle all
3105 ;;; breaks; for example, it does not handle breaks for internal
3107 (defun handle-breakpoint (offset component signal-context)
3108 (let ((data (breakpoint-data component offset nil)))
3110 (error "unknown breakpoint in ~S at offset ~S"
3111 (debug-fun-name (debug-fun-from-pc component offset))
3113 (let ((breakpoints (breakpoint-data-breakpoints data)))
3114 (if (or (null breakpoints)
3115 (eq (breakpoint-kind (car breakpoints)) :fun-end))
3116 (handle-fun-end-breakpoint-aux breakpoints data signal-context)
3117 (handle-breakpoint-aux breakpoints data
3118 offset component signal-context)))))
3120 ;;; This holds breakpoint-datas while invoking the breakpoint hooks
3121 ;;; associated with that particular component and location. While they
3122 ;;; are executing, if we hit the location again, we ignore the
3123 ;;; breakpoint to avoid infinite recursion. fun-end breakpoints
3124 ;;; must work differently since the breakpoint-data is unique for each
3126 (defvar *executing-breakpoint-hooks* nil)
3128 ;;; This handles code-location and DEBUG-FUN :FUN-START
3130 (defun handle-breakpoint-aux (breakpoints data offset component signal-context)
3132 (bug "breakpoint that nobody wants"))
3133 (unless (member data *executing-breakpoint-hooks*)
3134 (let ((*executing-breakpoint-hooks* (cons data
3135 *executing-breakpoint-hooks*)))
3136 (invoke-breakpoint-hooks breakpoints signal-context)))
3137 ;; At this point breakpoints may not hold the same list as
3138 ;; BREAKPOINT-DATA-BREAKPOINTS since invoking hooks may have allowed
3139 ;; a breakpoint deactivation. In fact, if all breakpoints were
3140 ;; deactivated then data is invalid since it was deleted and so the
3141 ;; correct one must be looked up if it is to be used. If there are
3142 ;; no more breakpoints active at this location, then the normal
3143 ;; instruction has been put back, and we do not need to
3144 ;; DO-DISPLACED-INST.
3145 (setf data (breakpoint-data component offset nil))
3146 (when (and data (breakpoint-data-breakpoints data))
3147 ;; The breakpoint is still active, so we need to execute the
3148 ;; displaced instruction and leave the breakpoint instruction
3149 ;; behind. The best way to do this is different on each machine,
3150 ;; so we just leave it up to the C code.
3151 (breakpoint-do-displaced-inst signal-context
3152 (breakpoint-data-instruction data))
3153 ;; Some platforms have no usable sigreturn() call. If your
3154 ;; implementation of arch_do_displaced_inst() _does_ sigreturn(),
3155 ;; it's polite to warn here
3156 #!+(and sparc solaris)
3157 (error "BREAKPOINT-DO-DISPLACED-INST returned?")))
3159 (defun invoke-breakpoint-hooks (breakpoints signal-context)
3160 (let* ((frame (signal-context-frame signal-context)))
3161 (dolist (bpt breakpoints)
3162 (funcall (breakpoint-hook-fun bpt)
3164 ;; If this is an :UNKNOWN-RETURN-PARTNER, then pass the
3165 ;; hook function the original breakpoint, so that users
3166 ;; aren't forced to confront the fact that some
3167 ;; breakpoints really are two.
3168 (if (eq (breakpoint-kind bpt) :unknown-return-partner)
3169 (breakpoint-unknown-return-partner bpt)
3172 (defun signal-context-frame (signal-context)
3175 (declare (optimize (inhibit-warnings 3)))
3176 (sb!alien:sap-alien signal-context (* os-context-t))))
3177 (cfp (int-sap (sb!vm:context-register scp sb!vm::cfp-offset))))
3178 (compute-calling-frame cfp
3179 (sb!vm:context-pc scp)
3182 (defun handle-fun-end-breakpoint (offset component context)
3183 (let ((data (breakpoint-data component offset nil)))
3185 (error "unknown breakpoint in ~S at offset ~S"
3186 (debug-fun-name (debug-fun-from-pc component offset))
3188 (let ((breakpoints (breakpoint-data-breakpoints data)))
3190 (aver (eq (breakpoint-kind (car breakpoints)) :fun-end))
3191 (handle-fun-end-breakpoint-aux breakpoints data context)))))
3193 ;;; Either HANDLE-BREAKPOINT calls this for :FUN-END breakpoints
3194 ;;; [old C code] or HANDLE-FUN-END-BREAKPOINT calls this directly
3196 (defun handle-fun-end-breakpoint-aux (breakpoints data signal-context)
3197 (delete-breakpoint-data data)
3200 (declare (optimize (inhibit-warnings 3)))
3201 (sb!alien:sap-alien signal-context (* os-context-t))))
3202 (frame (signal-context-frame signal-context))
3203 (component (breakpoint-data-component data))
3204 (cookie (gethash component *fun-end-cookies*)))
3205 (remhash component *fun-end-cookies*)
3206 (dolist (bpt breakpoints)
3207 (funcall (breakpoint-hook-fun bpt)
3209 (get-fun-end-breakpoint-values scp)
3212 (defun get-fun-end-breakpoint-values (scp)
3213 (let ((ocfp (int-sap (sb!vm:context-register
3215 #!-(or x86 x86-64) sb!vm::ocfp-offset
3216 #!+(or x86 x86-64) sb!vm::ebx-offset)))
3217 (nargs (make-lisp-obj
3218 (sb!vm:context-register scp sb!vm::nargs-offset)))
3219 (reg-arg-offsets '#.sb!vm::*register-arg-offsets*)
3222 (dotimes (arg-num nargs)
3223 (push (if reg-arg-offsets
3225 (sb!vm:context-register scp (pop reg-arg-offsets)))
3226 (stack-ref ocfp arg-num))
3228 (nreverse results)))
3230 ;;;; MAKE-BOGUS-LRA (used for :FUN-END breakpoints)
3232 (defconstant bogus-lra-constants
3233 #!-(or x86 x86-64) 2 #!+(or x86 x86-64) 3)
3234 (defconstant known-return-p-slot
3235 (+ sb!vm:code-constants-offset #!-(or x86 x86-64) 1 #!+(or x86 x86-64) 2))
3237 ;;; Make a bogus LRA object that signals a breakpoint trap when
3238 ;;; returned to. If the breakpoint trap handler returns, REAL-LRA is
3239 ;;; returned to. Three values are returned: the bogus LRA object, the
3240 ;;; code component it is part of, and the PC offset for the trap
3242 (defun make-bogus-lra (real-lra &optional known-return-p)
3244 ;; These are really code labels, not variables: but this way we get
3246 (let* ((src-start (foreign-symbol-sap "fun_end_breakpoint_guts"))
3247 (src-end (foreign-symbol-sap "fun_end_breakpoint_end"))
3248 (trap-loc (foreign-symbol-sap "fun_end_breakpoint_trap"))
3249 (length (sap- src-end src-start))
3251 (%primitive sb!c:allocate-code-object (1+ bogus-lra-constants)
3253 (dst-start (code-instructions code-object)))
3254 (declare (type system-area-pointer
3255 src-start src-end dst-start trap-loc)
3256 (type index length))
3257 (setf (%code-debug-info code-object) :bogus-lra)
3258 (setf (code-header-ref code-object sb!vm:code-trace-table-offset-slot)
3261 (setf (code-header-ref code-object real-lra-slot) real-lra)
3263 (multiple-value-bind (offset code) (compute-lra-data-from-pc real-lra)
3264 (setf (code-header-ref code-object real-lra-slot) code)
3265 (setf (code-header-ref code-object (1+ real-lra-slot)) offset))
3266 (setf (code-header-ref code-object known-return-p-slot)
3268 (system-area-ub8-copy src-start 0 dst-start 0 length)
3269 (sb!vm:sanctify-for-execution code-object)
3271 (values dst-start code-object (sap- trap-loc src-start))
3273 (let ((new-lra (make-lisp-obj (+ (sap-int dst-start)
3274 sb!vm:other-pointer-lowtag))))
3277 (logandc2 (+ sb!vm:code-constants-offset bogus-lra-constants 1)
3279 (sb!vm:sanctify-for-execution code-object)
3280 (values new-lra code-object (sap- trap-loc src-start))))))
3284 ;;; This appears here because it cannot go with the DEBUG-FUN
3285 ;;; interface since DO-DEBUG-BLOCK-LOCATIONS isn't defined until after
3286 ;;; the DEBUG-FUN routines.
3288 ;;; Return a code-location before the body of a function and after all
3289 ;;; the arguments are in place; or if that location can't be
3290 ;;; determined due to a lack of debug information, return NIL.
3291 (defun debug-fun-start-location (debug-fun)
3292 (etypecase debug-fun
3294 (code-location-from-pc debug-fun
3295 (sb!c::compiled-debug-fun-start-pc
3296 (compiled-debug-fun-compiler-debug-fun
3299 ;; (There used to be more cases back before sbcl-0.7.0, when
3300 ;; we did special tricks to debug the IR1 interpreter.)
3304 ;;;; Single-stepping
3306 ;;; The single-stepper works by inserting conditional trap instructions
3307 ;;; into the generated code (see src/compiler/*/call.lisp), currently:
3309 ;;; 1) Before the code generated for a function call that was
3310 ;;; translated to a VOP
3311 ;;; 2) Just before the call instruction for a full call
3313 ;;; In both cases, the trap will only be executed if stepping has been
3314 ;;; enabled, in which case it'll ultimately be handled by
3315 ;;; HANDLE-SINGLE-STEP-TRAP, which will either signal a stepping condition,
3316 ;;; or replace the function that's about to be called with a wrapper
3317 ;;; which will signal the condition.
3319 (defun handle-single-step-trap (context-sap kind callee-register-offset)
3320 (let ((context (sb!alien:sap-alien context-sap
3322 ;; The following calls must get tail-call eliminated for
3323 ;; *STEP-FRAME* to get set correctly.
3324 (if (= kind single-step-before-trap)
3325 (handle-single-step-before-trap context)
3326 (handle-single-step-around-trap context callee-register-offset))))
3328 (defvar *step-frame* nil)
3330 (defun handle-single-step-before-trap (context)
3331 (let ((step-info (single-step-info-from-context context)))
3332 ;; If there was not enough debug information available, there's no
3333 ;; sense in signaling the condition.
3335 (let ((*step-frame* (frame-down (top-frame))))
3336 ;; KLUDGE: Use the first non-foreign frame as the
3337 ;; *STACK-TOP-HINT*. Getting the frame from the signal context
3338 ;; would be cleaner, but SIGNAL-CONTEXT-FRAME doesn't seem
3339 ;; seem to work very well currently.
3340 (loop while *step-frame*
3341 for dfun = (frame-debug-fun *step-frame*)
3342 do (when (typep dfun 'compiled-debug-fun)
3344 do (setf *step-frame* (frame-down *step-frame*)))
3345 (sb!impl::step-form step-info
3346 ;; We could theoretically store information in
3347 ;; the debug-info about to determine the
3348 ;; arguments here, but for now let's just pass
3352 ;;; This function will replace the fdefn / function that was in the
3353 ;;; register at CALLEE-REGISTER-OFFSET with a wrapper function. To
3354 ;;; ensure that the full call will use the wrapper instead of the
3355 ;;; original, conditional trap must be emitted before the fdefn /
3356 ;;; function is converted into a raw address.
3357 (defun handle-single-step-around-trap (context callee-register-offset)
3358 ;; Fetch the function / fdefn we're about to call from the
3359 ;; appropriate register.
3360 (let* ((callee (sb!kernel::make-lisp-obj
3361 (context-register context callee-register-offset)))
3362 (step-info (single-step-info-from-context context)))
3363 ;; If there was not enough debug information available, there's no
3364 ;; sense in signaling the condition.
3366 (return-from handle-single-step-around-trap))
3367 (let* ((fun (lambda (&rest args)
3369 (apply (typecase callee
3370 (fdefn (fdefn-fun callee))
3373 (let ((sb!impl::*step-out* :maybe))
3375 ;; Signal a step condition
3377 (let ((*step-frame* (frame-down (top-frame))))
3378 (sb!impl::step-form step-info args))))
3379 ;; And proceed based on its return value.
3381 ;; If STEP-INTO was selected we pass
3382 ;; the return values to STEP-VALUES which
3383 ;; will show the return value.
3384 (multiple-value-call #'sb!impl::step-values
3387 ;; If STEP-NEXT or STEP-CONTINUE was
3388 ;; selected we disable the stepper for
3389 ;; the duration of the call.
3390 (sb!impl::with-stepping-disabled
3392 ;; If the use selected the STEP-OUT restart
3393 ;; somewhere during the call, resume stepping
3394 (when (eq sb!impl::*step-out* t)
3395 (sb!impl::enable-stepping)))))))
3396 (new-callee (etypecase callee
3398 (let ((fdefn (make-fdefn (gensym))))
3399 (setf (fdefn-fun fdefn) fun)
3402 ;; And then store the wrapper in the same place.
3403 (setf (context-register context callee-register-offset)
3404 (get-lisp-obj-address new-callee)))))
3406 ;;; Given a signal context, fetch the step-info that's been stored in
3407 ;;; the debug info at the trap point.
3408 (defun single-step-info-from-context (context)
3409 (multiple-value-bind (pc-offset code)
3410 (compute-lra-data-from-pc (context-pc context))
3411 (let* ((debug-fun (debug-fun-from-pc code pc-offset))
3412 (location (code-location-from-pc debug-fun
3417 (fill-in-code-location location)
3418 (code-location-debug-source location)
3419 (compiled-code-location-step-info location))
3423 ;;; Return the frame that triggered a single-step condition. Used to
3424 ;;; provide a *STACK-TOP-HINT*.
3425 (defun find-stepped-frame ()