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 (declaim (inline component-ptr-from-pc))
536 (sb!alien:define-alien-routine component-ptr-from-pc (system-area-pointer)
537 (pc system-area-pointer))
539 (declaim (inline component-from-component-ptr))
540 (defun component-from-component-ptr (component-ptr)
541 (declare (type system-area-pointer component-ptr))
542 (make-lisp-obj (logior (sap-int component-ptr)
543 sb!vm:other-pointer-lowtag)))
545 ;;;; (OR X86 X86-64) support
547 (defun compute-lra-data-from-pc (pc)
548 (declare (type system-area-pointer pc))
549 (let ((component-ptr (component-ptr-from-pc pc)))
550 (unless (sap= component-ptr (int-sap #x0))
551 (let* ((code (component-from-component-ptr component-ptr))
552 (code-header-len (* (get-header-data code) sb!vm:n-word-bytes))
553 (pc-offset (- (sap-int pc)
554 (- (get-lisp-obj-address code)
555 sb!vm:other-pointer-lowtag)
557 ; (format t "c-lra-fpc ~A ~A ~A~%" pc code pc-offset)
558 (values pc-offset code)))))
563 (defconstant sb!vm::nargs-offset #.sb!vm::ecx-offset)
565 ;;; Check for a valid return address - it could be any valid C/Lisp
568 ;;; XXX Could be a little smarter.
569 #!-sb-fluid (declaim (inline ra-pointer-valid-p))
570 (defun ra-pointer-valid-p (ra)
571 (declare (type system-area-pointer ra))
573 ;; not the first page (which is unmapped)
575 ;; FIXME: Where is this documented? Is it really true of every CPU
576 ;; architecture? Is it even necessarily true in current SBCL?
577 (>= (sap-int ra) 4096)
578 ;; not a Lisp stack pointer
579 (not (control-stack-pointer-valid-p ra))))
581 ;;; Try to find a valid previous stack. This is complex on the x86 as
582 ;;; it can jump between C and Lisp frames. To help find a valid frame
583 ;;; it searches backwards.
585 ;;; XXX Should probably check whether it has reached the bottom of the
588 ;;; XXX Should handle interrupted frames, both Lisp and C. At present
589 ;;; it manages to find a fp trail, see linux hack below.
590 (declaim (maybe-inline x86-call-context))
591 (defun x86-call-context (fp)
592 (declare (type system-area-pointer fp))
599 ((not (control-stack-pointer-valid-p fp))
602 ;; Check the two possible frame pointers.
603 (let ((lisp-ocfp (sap-ref-sap fp (- (* (1+ ocfp-save-offset)
604 sb!vm::n-word-bytes))))
605 (lisp-ra (sap-ref-sap fp (- (* (1+ return-pc-save-offset)
606 sb!vm::n-word-bytes))))
607 (c-ocfp (sap-ref-sap fp (* 0 sb!vm:n-word-bytes)))
608 (c-ra (sap-ref-sap fp (* 1 sb!vm:n-word-bytes))))
609 (cond ((and (sap> lisp-ocfp fp)
610 (control-stack-pointer-valid-p lisp-ocfp)
611 (ra-pointer-valid-p lisp-ra)
613 (control-stack-pointer-valid-p c-ocfp)
614 (ra-pointer-valid-p c-ra))
615 ;; Look forward another step to check their validity.
616 (let ((lisp-ok (handle lisp-ocfp))
617 (c-ok (handle c-ocfp)))
618 (cond ((and lisp-ok c-ok)
619 ;; Both still seem valid - choose the lisp frame.
621 (if (sap> lisp-ocfp c-ocfp)
622 (values t lisp-ra lisp-ocfp)
623 (values t c-ra c-ocfp))
625 (values t lisp-ra lisp-ocfp))
627 ;; The lisp convention is looking good.
628 (values t lisp-ra lisp-ocfp))
630 ;; The C convention is looking good.
631 (values t c-ra c-ocfp))
633 ;; Neither seems right?
635 ((and (sap> lisp-ocfp fp)
636 (control-stack-pointer-valid-p lisp-ocfp)
637 (ra-pointer-valid-p lisp-ra))
638 ;; The lisp convention is looking good.
639 (values t lisp-ra lisp-ocfp))
640 ((and (sap> c-ocfp fp)
641 (control-stack-pointer-valid-p c-ocfp)
642 #!-linux (ra-pointer-valid-p c-ra))
643 ;; The C convention is looking good.
644 (values t c-ra c-ocfp))
651 ;;; Convert the descriptor into a SAP. The bits all stay the same, we just
652 ;;; change our notion of what we think they are.
653 #!-sb-fluid (declaim (inline descriptor-sap))
654 (defun descriptor-sap (x)
655 (int-sap (get-lisp-obj-address x)))
657 ;;; Return the top frame of the control stack as it was before calling
660 (/noshow0 "entering TOP-FRAME")
661 (multiple-value-bind (fp pc) (%caller-frame-and-pc)
662 (compute-calling-frame (descriptor-sap fp) pc nil)))
664 ;;; Flush all of the frames above FRAME, and renumber all the frames
666 (defun flush-frames-above (frame)
667 (setf (frame-up frame) nil)
668 (do ((number 0 (1+ number))
669 (frame frame (frame-%down frame)))
670 ((not (frame-p frame)))
671 (setf (frame-number frame) number)))
673 ;;; Return the frame immediately below FRAME on the stack; or when
674 ;;; FRAME is the bottom of the stack, return NIL.
675 (defun frame-down (frame)
676 (/noshow0 "entering FRAME-DOWN")
677 ;; We have to access the old-fp and return-pc out of frame and pass
678 ;; them to COMPUTE-CALLING-FRAME.
679 (let ((down (frame-%down frame)))
680 (if (eq down :unparsed)
681 (let ((debug-fun (frame-debug-fun frame)))
682 (/noshow0 "in DOWN :UNPARSED case")
683 (setf (frame-%down frame)
686 (let ((c-d-f (compiled-debug-fun-compiler-debug-fun
688 (compute-calling-frame
691 frame ocfp-save-offset
692 (sb!c::compiled-debug-fun-old-fp c-d-f)))
694 frame lra-save-offset
695 (sb!c::compiled-debug-fun-return-pc c-d-f))
698 (let ((fp (frame-pointer frame)))
699 (when (control-stack-pointer-valid-p fp)
701 (multiple-value-bind (ok ra ofp) (x86-call-context fp)
703 (compute-calling-frame ofp ra frame)))
705 (compute-calling-frame
707 (sap-ref-sap fp (* ocfp-save-offset
711 (sap-ref-32 fp (* ocfp-save-offset
712 sb!vm:n-word-bytes)))
714 (stack-ref fp lra-save-offset)
719 ;;; Get the old FP or return PC out of FRAME. STACK-SLOT is the
720 ;;; standard save location offset on the stack. LOC is the saved
721 ;;; SC-OFFSET describing the main location.
722 (defun get-context-value (frame stack-slot loc)
723 (declare (type compiled-frame frame) (type unsigned-byte stack-slot)
724 (type sb!c:sc-offset loc))
725 (let ((pointer (frame-pointer frame))
726 (escaped (compiled-frame-escaped frame)))
728 (sub-access-debug-var-slot pointer loc escaped)
730 (stack-ref pointer stack-slot)
734 (stack-ref pointer stack-slot))
736 (sap-ref-sap pointer (- (* (1+ stack-slot)
737 sb!vm::n-word-bytes))))))))
739 (defun (setf get-context-value) (value frame stack-slot loc)
740 (declare (type compiled-frame frame) (type unsigned-byte stack-slot)
741 (type sb!c:sc-offset loc))
742 (let ((pointer (frame-pointer frame))
743 (escaped (compiled-frame-escaped frame)))
745 (sub-set-debug-var-slot pointer loc value escaped)
747 (setf (stack-ref pointer stack-slot) value)
751 (setf (stack-ref pointer stack-slot) value))
753 (setf (sap-ref-sap pointer (- (* (1+ stack-slot)
754 sb!vm::n-word-bytes))) value))))))
756 (defun foreign-function-backtrace-name (sap)
757 (let ((name (sap-foreign-symbol sap)))
759 (format nil "foreign function: ~A" name)
760 (format nil "foreign function: #x~X" (sap-int sap)))))
762 ;;; This returns a frame for the one existing in time immediately
763 ;;; prior to the frame referenced by current-fp. This is current-fp's
764 ;;; caller or the next frame down the control stack. If there is no
765 ;;; down frame, this returns NIL for the bottom of the stack. UP-FRAME
766 ;;; is the up link for the resulting frame object, and it is null when
767 ;;; we call this to get the top of the stack.
769 ;;; The current frame contains the pointer to the temporally previous
770 ;;; frame we want, and the current frame contains the pc at which we
771 ;;; will continue executing upon returning to that previous frame.
773 ;;; Note: Sometimes LRA is actually a fixnum. This happens when lisp
774 ;;; calls into C. In this case, the code object is stored on the stack
775 ;;; after the LRA, and the LRA is the word offset.
777 (defun compute-calling-frame (caller lra up-frame)
778 (declare (type system-area-pointer caller))
779 (when (control-stack-pointer-valid-p caller)
780 (multiple-value-bind (code pc-offset escaped)
782 (multiple-value-bind (word-offset code)
784 (let ((fp (frame-pointer up-frame)))
786 (stack-ref fp (1+ lra-save-offset))))
787 (values (get-header-data lra)
788 (lra-code-header lra)))
791 (* (1+ (- word-offset (get-header-data code)))
794 (values :foreign-function
797 (find-escaped-frame caller))
798 (if (and (code-component-p code)
799 (eq (%code-debug-info code) :bogus-lra))
800 (let ((real-lra (code-header-ref code real-lra-slot)))
801 (compute-calling-frame caller real-lra up-frame))
802 (let ((d-fun (case code
804 (make-bogus-debug-fun
805 "undefined function"))
807 (make-bogus-debug-fun
808 (foreign-function-backtrace-name
809 (int-sap (get-lisp-obj-address lra)))))
811 (make-bogus-debug-fun
812 "bogus stack frame"))
814 (debug-fun-from-pc code pc-offset)))))
815 (make-compiled-frame caller up-frame d-fun
816 (code-location-from-pc d-fun pc-offset
818 (if up-frame (1+ (frame-number up-frame)) 0)
822 (defun compute-calling-frame (caller ra up-frame)
823 (declare (type system-area-pointer caller ra))
824 (/noshow0 "entering COMPUTE-CALLING-FRAME")
825 (when (control-stack-pointer-valid-p caller)
827 ;; First check for an escaped frame.
828 (multiple-value-bind (code pc-offset escaped) (find-escaped-frame caller)
831 ;; If it's escaped it may be a function end breakpoint trap.
832 (when (and (code-component-p code)
833 (eq (%code-debug-info code) :bogus-lra))
834 ;; If :bogus-lra grab the real lra.
835 (setq pc-offset (code-header-ref
836 code (1+ real-lra-slot)))
837 (setq code (code-header-ref code real-lra-slot))
840 (multiple-value-setq (pc-offset code)
841 (compute-lra-data-from-pc ra))
843 (setf code :foreign-function
845 (let ((d-fun (case code
847 (make-bogus-debug-fun
848 "undefined function"))
850 (make-bogus-debug-fun
851 (foreign-function-backtrace-name ra)))
853 (make-bogus-debug-fun
854 "bogus stack frame"))
856 (debug-fun-from-pc code pc-offset)))))
857 (/noshow0 "returning MAKE-COMPILED-FRAME from COMPUTE-CALLING-FRAME")
858 (make-compiled-frame caller up-frame d-fun
859 (code-location-from-pc d-fun pc-offset
861 (if up-frame (1+ (frame-number up-frame)) 0)
864 (defun nth-interrupt-context (n)
865 (declare (type (unsigned-byte 32) n)
866 (optimize (speed 3) (safety 0)))
867 (sb!alien:sap-alien (sb!vm::current-thread-offset-sap
868 (+ sb!vm::thread-interrupt-contexts-offset n))
872 (defun find-escaped-frame (frame-pointer)
873 (declare (type system-area-pointer frame-pointer))
874 (/noshow0 "entering FIND-ESCAPED-FRAME")
875 (dotimes (index *free-interrupt-context-index* (values nil 0 nil))
876 (/noshow0 "at head of WITH-ALIEN")
877 (let ((context (nth-interrupt-context index)))
878 (/noshow0 "got CONTEXT")
879 (when (= (sap-int frame-pointer)
880 (sb!vm:context-register context sb!vm::cfp-offset))
882 (/noshow0 "in WITHOUT-GCING")
883 (let* ((component-ptr (component-ptr-from-pc
884 (sb!vm:context-pc context)))
885 (code (unless (sap= component-ptr (int-sap #x0))
886 (component-from-component-ptr component-ptr))))
887 (/noshow0 "got CODE")
889 (return (values code 0 context)))
890 (let* ((code-header-len (* (get-header-data code)
893 (- (sap-int (sb!vm:context-pc context))
894 (- (get-lisp-obj-address code)
895 sb!vm:other-pointer-lowtag)
897 (/noshow "got PC-OFFSET")
898 (unless (<= 0 pc-offset
899 (* (code-header-ref code sb!vm:code-code-size-slot)
901 ;; We were in an assembly routine. Therefore, use the
904 ;; FIXME: Should this be WARN or ERROR or what?
905 (format t "** pc-offset ~S not in code obj ~S?~%"
907 (/noshow0 "returning from FIND-ESCAPED-FRAME")
909 (values code pc-offset context)))))))))
912 (defun find-escaped-frame (frame-pointer)
913 (declare (type system-area-pointer frame-pointer))
914 (dotimes (index *free-interrupt-context-index* (values nil 0 nil))
915 (let ((scp (nth-interrupt-context index)))
916 (when (= (sap-int frame-pointer)
917 (sb!vm:context-register scp sb!vm::cfp-offset))
919 (let ((code (code-object-from-bits
920 (sb!vm:context-register scp sb!vm::code-offset))))
922 (return (values code 0 scp)))
923 (let* ((code-header-len (* (get-header-data code)
926 (- (sap-int (sb!vm:context-pc scp))
927 (- (get-lisp-obj-address code)
928 sb!vm:other-pointer-lowtag)
930 (let ((code-size (* (code-header-ref code
931 sb!vm:code-code-size-slot)
932 sb!vm:n-word-bytes)))
933 (unless (<= 0 pc-offset code-size)
934 ;; We were in an assembly routine.
935 (multiple-value-bind (new-pc-offset computed-return)
936 (find-pc-from-assembly-fun code scp)
937 (setf pc-offset new-pc-offset)
938 (unless (<= 0 pc-offset code-size)
940 "Set PC-OFFSET to zero and continue backtrace."
943 "~@<PC-OFFSET (~D) not in code object. Frame details:~
944 ~2I~:@_PC: #X~X~:@_CODE: ~S~:@_CODE FUN: ~S~:@_LRA: ~
945 #X~X~:@_COMPUTED RETURN: #X~X.~:>"
948 (sap-int (sb!vm:context-pc scp))
950 (%code-entry-points code)
951 (sb!vm:context-register scp sb!vm::lra-offset)
953 ;; We failed to pinpoint where PC is, but set
954 ;; pc-offset to 0 to keep the backtrace from
956 (setf pc-offset 0)))))
958 (if (eq (%code-debug-info code) :bogus-lra)
959 (let ((real-lra (code-header-ref code
961 (values (lra-code-header real-lra)
962 (get-header-data real-lra)
964 (values code pc-offset scp))))))))))
967 (defun find-pc-from-assembly-fun (code scp)
968 "Finds the PC for the return from an assembly routine properly.
969 For some architectures (such as PPC) this will not be the $LRA
971 (let ((return-machine-address (sb!vm::return-machine-address scp))
972 (code-header-len (* (get-header-data code) sb!vm:n-word-bytes)))
973 (values (- return-machine-address
974 (- (get-lisp-obj-address code)
975 sb!vm:other-pointer-lowtag)
977 return-machine-address)))
979 ;;; Find the code object corresponding to the object represented by
980 ;;; bits and return it. We assume bogus functions correspond to the
981 ;;; undefined-function.
983 (defun code-object-from-bits (bits)
984 (declare (type (unsigned-byte 32) bits))
985 (let ((object (make-lisp-obj bits)))
986 (if (functionp object)
987 (or (fun-code-header object)
989 (let ((lowtag (lowtag-of object)))
990 (when (= lowtag sb!vm:other-pointer-lowtag)
991 (let ((widetag (widetag-of object)))
992 (cond ((= widetag sb!vm:code-header-widetag)
994 ((= widetag sb!vm:return-pc-header-widetag)
995 (lra-code-header object))
1001 ;;; This returns a COMPILED-DEBUG-FUN for COMPONENT and PC. We fetch the
1002 ;;; SB!C::DEBUG-INFO and run down its FUN-MAP to get a
1003 ;;; SB!C::COMPILED-DEBUG-FUN from the PC. The result only needs to
1004 ;;; reference the COMPONENT, for function constants, and the
1005 ;;; SB!C::COMPILED-DEBUG-FUN.
1006 (defun debug-fun-from-pc (component pc)
1007 (let ((info (%code-debug-info component)))
1010 ;; FIXME: It seems that most of these (at least on x86) are
1011 ;; actually assembler routines, and could be named by looking
1012 ;; at the sb-fasl:*assembler-routines*.
1013 (make-bogus-debug-fun "no debug information for frame"))
1014 ((eq info :bogus-lra)
1015 (make-bogus-debug-fun "function end breakpoint"))
1017 (let* ((fun-map (sb!c::compiled-debug-info-fun-map info))
1018 (len (length fun-map)))
1019 (declare (type simple-vector fun-map))
1021 (make-compiled-debug-fun (svref fun-map 0) component)
1024 (>= pc (sb!c::compiled-debug-fun-elsewhere-pc
1025 (svref fun-map 0)))))
1026 (declare (type sb!int:index i))
1029 (< pc (if elsewhere-p
1030 (sb!c::compiled-debug-fun-elsewhere-pc
1031 (svref fun-map (1+ i)))
1032 (svref fun-map i))))
1033 (return (make-compiled-debug-fun
1034 (svref fun-map (1- i))
1038 ;;; This returns a code-location for the COMPILED-DEBUG-FUN,
1039 ;;; DEBUG-FUN, and the pc into its code vector. If we stopped at a
1040 ;;; breakpoint, find the CODE-LOCATION for that breakpoint. Otherwise,
1041 ;;; make an :UNSURE code location, so it can be filled in when we
1042 ;;; figure out what is going on.
1043 (defun code-location-from-pc (debug-fun pc escaped)
1044 (or (and (compiled-debug-fun-p debug-fun)
1046 (let ((data (breakpoint-data
1047 (compiled-debug-fun-component debug-fun)
1049 (when (and data (breakpoint-data-breakpoints data))
1050 (let ((what (breakpoint-what
1051 (first (breakpoint-data-breakpoints data)))))
1052 (when (compiled-code-location-p what)
1054 (make-compiled-code-location pc debug-fun)))
1056 ;;; Return an alist mapping catch tags to CODE-LOCATIONs. These are
1057 ;;; CODE-LOCATIONs at which execution would continue with frame as the
1058 ;;; top frame if someone threw to the corresponding tag.
1059 (defun frame-catches (frame)
1060 (let ((catch (descriptor-sap sb!vm:*current-catch-block*))
1061 (reversed-result nil)
1062 (fp (frame-pointer frame)))
1063 (loop until (zerop (sap-int catch))
1064 finally (return (nreverse reversed-result))
1069 (* sb!vm:catch-block-current-cont-slot
1070 sb!vm:n-word-bytes))
1074 (* sb!vm:catch-block-current-cont-slot
1075 sb!vm:n-word-bytes))))
1076 (let* (#!-(or x86 x86-64)
1077 (lra (stack-ref catch sb!vm:catch-block-entry-pc-slot))
1080 catch (* sb!vm:catch-block-entry-pc-slot
1081 sb!vm:n-word-bytes)))
1084 (stack-ref catch sb!vm:catch-block-current-code-slot))
1086 (component (component-from-component-ptr
1087 (component-ptr-from-pc ra)))
1090 (* (- (1+ (get-header-data lra))
1091 (get-header-data component))
1095 (- (get-lisp-obj-address component)
1096 sb!vm:other-pointer-lowtag)
1097 (* (get-header-data component) sb!vm:n-word-bytes))))
1098 (push (cons #!-(or x86 x86-64)
1099 (stack-ref catch sb!vm:catch-block-tag-slot)
1102 (sap-ref-word catch (* sb!vm:catch-block-tag-slot
1103 sb!vm:n-word-bytes)))
1104 (make-compiled-code-location
1105 offset (frame-debug-fun frame)))
1110 (* sb!vm:catch-block-previous-catch-slot
1111 sb!vm:n-word-bytes))
1115 (* sb!vm:catch-block-previous-catch-slot
1116 sb!vm:n-word-bytes)))))))
1118 ;;;; operations on DEBUG-FUNs
1120 ;;; Execute the forms in a context with BLOCK-VAR bound to each
1121 ;;; DEBUG-BLOCK in DEBUG-FUN successively. Result is an optional
1122 ;;; form to execute for return values, and DO-DEBUG-FUN-BLOCKS
1123 ;;; returns nil if there is no result form. This signals a
1124 ;;; NO-DEBUG-BLOCKS condition when the DEBUG-FUN lacks
1125 ;;; DEBUG-BLOCK information.
1126 (defmacro do-debug-fun-blocks ((block-var debug-fun &optional result)
1128 (let ((blocks (gensym))
1130 `(let ((,blocks (debug-fun-debug-blocks ,debug-fun)))
1131 (declare (simple-vector ,blocks))
1132 (dotimes (,i (length ,blocks) ,result)
1133 (let ((,block-var (svref ,blocks ,i)))
1136 ;;; Execute body in a context with VAR bound to each DEBUG-VAR in
1137 ;;; DEBUG-FUN. This returns the value of executing result (defaults to
1138 ;;; nil). This may iterate over only some of DEBUG-FUN's variables or
1139 ;;; none depending on debug policy; for example, possibly the
1140 ;;; compilation only preserved argument information.
1141 (defmacro do-debug-fun-vars ((var debug-fun &optional result) &body body)
1142 (let ((vars (gensym))
1144 `(let ((,vars (debug-fun-debug-vars ,debug-fun)))
1145 (declare (type (or null simple-vector) ,vars))
1147 (dotimes (,i (length ,vars) ,result)
1148 (let ((,var (svref ,vars ,i)))
1152 ;;; Return the object of type FUNCTION associated with the DEBUG-FUN,
1153 ;;; or NIL if the function is unavailable or is non-existent as a user
1154 ;;; callable function object.
1155 (defun debug-fun-fun (debug-fun)
1156 (let ((cached-value (debug-fun-%function debug-fun)))
1157 (if (eq cached-value :unparsed)
1158 (setf (debug-fun-%function debug-fun)
1159 (etypecase debug-fun
1162 (compiled-debug-fun-component debug-fun))
1164 (sb!c::compiled-debug-fun-start-pc
1165 (compiled-debug-fun-compiler-debug-fun debug-fun))))
1166 (do ((entry (%code-entry-points component)
1167 (%simple-fun-next entry)))
1170 (sb!c::compiled-debug-fun-start-pc
1171 (compiled-debug-fun-compiler-debug-fun
1172 (fun-debug-fun entry))))
1174 (bogus-debug-fun nil)))
1177 ;;; Return the name of the function represented by DEBUG-FUN. This may
1178 ;;; be a string or a cons; do not assume it is a symbol.
1179 (defun debug-fun-name (debug-fun)
1180 (declare (type debug-fun debug-fun))
1181 (etypecase debug-fun
1183 (sb!c::compiled-debug-fun-name
1184 (compiled-debug-fun-compiler-debug-fun debug-fun)))
1186 (bogus-debug-fun-%name debug-fun))))
1188 ;;; Return a DEBUG-FUN that represents debug information for FUN.
1189 (defun fun-debug-fun (fun)
1190 (declare (type function fun))
1191 (ecase (widetag-of fun)
1192 (#.sb!vm:closure-header-widetag
1193 (fun-debug-fun (%closure-fun fun)))
1194 (#.sb!vm:funcallable-instance-header-widetag
1195 (fun-debug-fun (funcallable-instance-fun fun)))
1196 (#.sb!vm:simple-fun-header-widetag
1197 (let* ((name (%simple-fun-name fun))
1198 (component (fun-code-header fun))
1201 (and (sb!c::compiled-debug-fun-p x)
1202 (eq (sb!c::compiled-debug-fun-name x) name)
1203 (eq (sb!c::compiled-debug-fun-kind x) nil)))
1204 (sb!c::compiled-debug-info-fun-map
1205 (%code-debug-info component)))))
1207 (make-compiled-debug-fun res component)
1208 ;; KLUDGE: comment from CMU CL:
1209 ;; This used to be the non-interpreted branch, but
1210 ;; William wrote it to return the debug-fun of fun's XEP
1211 ;; instead of fun's debug-fun. The above code does this
1212 ;; more correctly, but it doesn't get or eliminate all
1213 ;; appropriate cases. It mostly works, and probably
1214 ;; works for all named functions anyway.
1216 (debug-fun-from-pc component
1217 (* (- (fun-word-offset fun)
1218 (get-header-data component))
1219 sb!vm:n-word-bytes)))))))
1221 ;;; Return the kind of the function, which is one of :OPTIONAL,
1222 ;;; :EXTERNAL, :TOPLEVEL, :CLEANUP, or NIL.
1223 (defun debug-fun-kind (debug-fun)
1224 ;; FIXME: This "is one of" information should become part of the function
1225 ;; declamation, not just a doc string
1226 (etypecase debug-fun
1228 (sb!c::compiled-debug-fun-kind
1229 (compiled-debug-fun-compiler-debug-fun debug-fun)))
1233 ;;; Is there any variable information for DEBUG-FUN?
1234 (defun debug-var-info-available (debug-fun)
1235 (not (not (debug-fun-debug-vars debug-fun))))
1237 ;;; Return a list of DEBUG-VARs in DEBUG-FUN having the same name
1238 ;;; and package as SYMBOL. If SYMBOL is uninterned, then this returns
1239 ;;; a list of DEBUG-VARs without package names and with the same name
1240 ;;; as symbol. The result of this function is limited to the
1241 ;;; availability of variable information in DEBUG-FUN; for
1242 ;;; example, possibly DEBUG-FUN only knows about its arguments.
1243 (defun debug-fun-symbol-vars (debug-fun symbol)
1244 (let ((vars (ambiguous-debug-vars debug-fun (symbol-name symbol)))
1245 (package (and (symbol-package symbol)
1246 (package-name (symbol-package symbol)))))
1247 (delete-if (if (stringp package)
1249 (let ((p (debug-var-package-name var)))
1250 (or (not (stringp p))
1251 (string/= p package))))
1253 (stringp (debug-var-package-name var))))
1256 ;;; Return a list of DEBUG-VARs in DEBUG-FUN whose names contain
1257 ;;; NAME-PREFIX-STRING as an initial substring. The result of this
1258 ;;; function is limited to the availability of variable information in
1259 ;;; debug-fun; for example, possibly debug-fun only knows
1260 ;;; about its arguments.
1261 (defun ambiguous-debug-vars (debug-fun name-prefix-string)
1262 (declare (simple-string name-prefix-string))
1263 (let ((variables (debug-fun-debug-vars debug-fun)))
1264 (declare (type (or null simple-vector) variables))
1266 (let* ((len (length variables))
1267 (prefix-len (length name-prefix-string))
1268 (pos (find-var name-prefix-string variables len))
1271 ;; Find names from pos to variable's len that contain prefix.
1272 (do ((i pos (1+ i)))
1274 (let* ((var (svref variables i))
1275 (name (debug-var-symbol-name var))
1276 (name-len (length name)))
1277 (declare (simple-string name))
1278 (when (/= (or (string/= name-prefix-string name
1279 :end1 prefix-len :end2 name-len)
1284 (setq res (nreverse res)))
1287 ;;; This returns a position in VARIABLES for one containing NAME as an
1288 ;;; initial substring. END is the length of VARIABLES if supplied.
1289 (defun find-var (name variables &optional end)
1290 (declare (simple-vector variables)
1291 (simple-string name))
1292 (let ((name-len (length name)))
1293 (position name variables
1295 (let* ((y (debug-var-symbol-name y))
1297 (declare (simple-string y))
1298 (and (>= y-len name-len)
1299 (string= x y :end1 name-len :end2 name-len))))
1300 :end (or end (length variables)))))
1302 ;;; Return a list representing the lambda-list for DEBUG-FUN. The
1303 ;;; list has the following structure:
1304 ;;; (required-var1 required-var2
1306 ;;; (:optional var3 suppliedp-var4)
1307 ;;; (:optional var5)
1309 ;;; (:rest var6) (:rest var7)
1311 ;;; (:keyword keyword-symbol var8 suppliedp-var9)
1312 ;;; (:keyword keyword-symbol var10)
1315 ;;; Each VARi is a DEBUG-VAR; however it may be the symbol :DELETED if
1316 ;;; it is unreferenced in DEBUG-FUN. This signals a
1317 ;;; LAMBDA-LIST-UNAVAILABLE condition when there is no argument list
1319 (defun debug-fun-lambda-list (debug-fun)
1320 (etypecase debug-fun
1321 (compiled-debug-fun (compiled-debug-fun-lambda-list debug-fun))
1322 (bogus-debug-fun nil)))
1324 ;;; Note: If this has to compute the lambda list, it caches it in DEBUG-FUN.
1325 (defun compiled-debug-fun-lambda-list (debug-fun)
1326 (let ((lambda-list (debug-fun-%lambda-list debug-fun)))
1327 (cond ((eq lambda-list :unparsed)
1328 (multiple-value-bind (args argsp)
1329 (parse-compiled-debug-fun-lambda-list debug-fun)
1330 (setf (debug-fun-%lambda-list debug-fun) args)
1333 (debug-signal 'lambda-list-unavailable
1334 :debug-fun debug-fun))))
1336 ((bogus-debug-fun-p debug-fun)
1338 ((sb!c::compiled-debug-fun-arguments
1339 (compiled-debug-fun-compiler-debug-fun debug-fun))
1340 ;; If the packed information is there (whether empty or not) as
1341 ;; opposed to being nil, then returned our cached value (nil).
1344 ;; Our cached value is nil, and the packed lambda-list information
1345 ;; is nil, so we don't have anything available.
1346 (debug-signal 'lambda-list-unavailable
1347 :debug-fun debug-fun)))))
1349 ;;; COMPILED-DEBUG-FUN-LAMBDA-LIST calls this when a
1350 ;;; COMPILED-DEBUG-FUN has no lambda list information cached. It
1351 ;;; returns the lambda list as the first value and whether there was
1352 ;;; any argument information as the second value. Therefore,
1353 ;;; (VALUES NIL T) means there were no arguments, but (VALUES NIL NIL)
1354 ;;; means there was no argument information.
1355 (defun parse-compiled-debug-fun-lambda-list (debug-fun)
1356 (let ((args (sb!c::compiled-debug-fun-arguments
1357 (compiled-debug-fun-compiler-debug-fun debug-fun))))
1362 (values (coerce (debug-fun-debug-vars debug-fun) 'list)
1365 (let ((vars (debug-fun-debug-vars debug-fun))
1370 (declare (type (or null simple-vector) vars))
1372 (when (>= i len) (return))
1373 (let ((ele (aref args i)))
1378 ;; Deleted required arg at beginning of args array.
1379 (push :deleted res))
1380 (sb!c::optional-args
1383 ;; SUPPLIED-P var immediately following keyword or
1384 ;; optional. Stick the extra var in the result
1385 ;; element representing the keyword or optional,
1386 ;; which is the previous one.
1388 ;; FIXME: NCONC used for side-effect: the effect is defined,
1389 ;; but this is bad style no matter what.
1391 (list (compiled-debug-fun-lambda-list-var
1392 args (incf i) vars))))
1395 (compiled-debug-fun-lambda-list-var
1396 args (incf i) vars))
1399 ;; Just ignore the fact that the next two args are
1400 ;; the &MORE arg context and count, and act like they
1401 ;; are regular arguments.
1405 (push (list :keyword
1407 (compiled-debug-fun-lambda-list-var
1408 args (incf i) vars))
1411 ;; We saw an optional marker, so the following
1412 ;; non-symbols are indexes indicating optional
1414 (push (list :optional (svref vars ele)) res))
1416 ;; Required arg at beginning of args array.
1417 (push (svref vars ele) res))))
1419 (values (nreverse res) t))))))
1421 ;;; This is used in COMPILED-DEBUG-FUN-LAMBDA-LIST.
1422 (defun compiled-debug-fun-lambda-list-var (args i vars)
1423 (declare (type (simple-array * (*)) args)
1424 (simple-vector vars))
1425 (let ((ele (aref args i)))
1426 (cond ((not (symbolp ele)) (svref vars ele))
1427 ((eq ele 'sb!c::deleted) :deleted)
1428 (t (error "malformed arguments description")))))
1430 (defun compiled-debug-fun-debug-info (debug-fun)
1431 (%code-debug-info (compiled-debug-fun-component debug-fun)))
1433 ;;;; unpacking variable and basic block data
1435 (defvar *parsing-buffer*
1436 (make-array 20 :adjustable t :fill-pointer t))
1437 (defvar *other-parsing-buffer*
1438 (make-array 20 :adjustable t :fill-pointer t))
1439 ;;; PARSE-DEBUG-BLOCKS and PARSE-DEBUG-VARS
1440 ;;; use this to unpack binary encoded information. It returns the
1441 ;;; values returned by the last form in body.
1443 ;;; This binds buffer-var to *parsing-buffer*, makes sure it starts at
1444 ;;; element zero, and makes sure if we unwind, we nil out any set
1445 ;;; elements for GC purposes.
1447 ;;; This also binds other-var to *other-parsing-buffer* when it is
1448 ;;; supplied, making sure it starts at element zero and that we nil
1449 ;;; out any elements if we unwind.
1451 ;;; This defines the local macro RESULT that takes a buffer, copies
1452 ;;; its elements to a resulting simple-vector, nil's out elements, and
1453 ;;; restarts the buffer at element zero. RESULT returns the
1455 (eval-when (:compile-toplevel :execute)
1456 (sb!xc:defmacro with-parsing-buffer ((buffer-var &optional other-var)
1458 (let ((len (gensym))
1461 (let ((,buffer-var *parsing-buffer*)
1462 ,@(if other-var `((,other-var *other-parsing-buffer*))))
1463 (setf (fill-pointer ,buffer-var) 0)
1464 ,@(if other-var `((setf (fill-pointer ,other-var) 0)))
1465 (macrolet ((result (buf)
1466 `(let* ((,',len (length ,buf))
1467 (,',res (make-array ,',len)))
1468 (replace ,',res ,buf :end1 ,',len :end2 ,',len)
1469 (fill ,buf nil :end ,',len)
1470 (setf (fill-pointer ,buf) 0)
1473 (fill *parsing-buffer* nil)
1474 ,@(if other-var `((fill *other-parsing-buffer* nil))))))
1477 ;;; The argument is a debug internals structure. This returns the
1478 ;;; DEBUG-BLOCKs for DEBUG-FUN, regardless of whether we have unpacked
1479 ;;; them yet. It signals a NO-DEBUG-BLOCKS condition if it can't
1480 ;;; return the blocks.
1481 (defun debug-fun-debug-blocks (debug-fun)
1482 (let ((blocks (debug-fun-blocks debug-fun)))
1483 (cond ((eq blocks :unparsed)
1484 (setf (debug-fun-blocks debug-fun)
1485 (parse-debug-blocks debug-fun))
1486 (unless (debug-fun-blocks debug-fun)
1487 (debug-signal 'no-debug-blocks
1488 :debug-fun debug-fun))
1489 (debug-fun-blocks debug-fun))
1492 (debug-signal 'no-debug-blocks
1493 :debug-fun debug-fun)))))
1495 ;;; Return a SIMPLE-VECTOR of DEBUG-BLOCKs or NIL. NIL indicates there
1496 ;;; was no basic block information.
1497 (defun parse-debug-blocks (debug-fun)
1498 (etypecase debug-fun
1500 (parse-compiled-debug-blocks debug-fun))
1502 (debug-signal 'no-debug-blocks :debug-fun debug-fun))))
1504 ;;; This does some of the work of PARSE-DEBUG-BLOCKS.
1505 (defun parse-compiled-debug-blocks (debug-fun)
1506 (let* ((var-count (length (debug-fun-debug-vars debug-fun)))
1507 (compiler-debug-fun (compiled-debug-fun-compiler-debug-fun
1509 (blocks (sb!c::compiled-debug-fun-blocks compiler-debug-fun))
1510 ;; KLUDGE: 8 is a hard-wired constant in the compiler for the
1511 ;; element size of the packed binary representation of the
1513 (live-set-len (ceiling var-count 8))
1514 (tlf-number (sb!c::compiled-debug-fun-tlf-number compiler-debug-fun)))
1516 (return-from parse-compiled-debug-blocks nil))
1517 (macrolet ((aref+ (a i) `(prog1 (aref ,a ,i) (incf ,i))))
1518 (with-parsing-buffer (blocks-buffer locations-buffer)
1520 (len (length blocks))
1523 (when (>= i len) (return))
1524 (let ((succ-and-flags (aref+ blocks i))
1526 (declare (type (unsigned-byte 8) succ-and-flags)
1528 (dotimes (k (ldb sb!c::compiled-debug-block-nsucc-byte
1530 (push (sb!c:read-var-integer blocks i) successors))
1532 (dotimes (k (sb!c:read-var-integer blocks i)
1533 (result locations-buffer))
1534 (let ((kind (svref sb!c::*compiled-code-location-kinds*
1537 (sb!c:read-var-integer blocks i)))
1538 (tlf-offset (or tlf-number
1539 (sb!c:read-var-integer blocks i)))
1540 (form-number (sb!c:read-var-integer blocks i))
1541 (live-set (sb!c:read-packed-bit-vector
1542 live-set-len blocks i))
1543 (step-info (sb!c:read-var-string blocks i)))
1544 (vector-push-extend (make-known-code-location
1545 pc debug-fun tlf-offset
1546 form-number live-set kind
1549 (setf last-pc pc))))
1550 (block (make-compiled-debug-block
1551 locations successors
1553 sb!c::compiled-debug-block-elsewhere-p
1554 succ-and-flags))))))
1555 (vector-push-extend block blocks-buffer)
1556 (dotimes (k (length locations))
1557 (setf (code-location-%debug-block (svref locations k))
1559 (let ((res (result blocks-buffer)))
1560 (declare (simple-vector res))
1561 (dotimes (i (length res))
1562 (let* ((block (svref res i))
1564 (dolist (ele (debug-block-successors block))
1565 (push (svref res ele) succs))
1566 (setf (debug-block-successors block) succs)))
1569 ;;; The argument is a debug internals structure. This returns NIL if
1570 ;;; there is no variable information. It returns an empty
1571 ;;; simple-vector if there were no locals in the function. Otherwise
1572 ;;; it returns a SIMPLE-VECTOR of DEBUG-VARs.
1573 (defun debug-fun-debug-vars (debug-fun)
1574 (let ((vars (debug-fun-%debug-vars debug-fun)))
1575 (if (eq vars :unparsed)
1576 (setf (debug-fun-%debug-vars debug-fun)
1577 (etypecase debug-fun
1579 (parse-compiled-debug-vars debug-fun))
1580 (bogus-debug-fun nil)))
1583 ;;; VARS is the parsed variables for a minimal debug function. We need
1584 ;;; to assign names of the form ARG-NNN. We must pad with leading
1585 ;;; zeros, since the arguments must be in alphabetical order.
1586 (defun assign-minimal-var-names (vars)
1587 (declare (simple-vector vars))
1588 (let* ((len (length vars))
1589 (width (length (format nil "~W" (1- len)))))
1591 (without-package-locks
1592 (setf (compiled-debug-var-symbol (svref vars i))
1593 (intern (format nil "ARG-~V,'0D" width i)
1594 ;; KLUDGE: It's somewhat nasty to have a bare
1595 ;; package name string here. It would be
1596 ;; nicer to have #.(FIND-PACKAGE "SB!DEBUG")
1597 ;; instead, since then at least it would transform
1598 ;; correctly under package renaming and stuff.
1599 ;; However, genesis can't handle dumped packages..
1602 ;; FIXME: Maybe this could be fixed by moving the
1603 ;; whole debug-int.lisp file to warm init? (after
1604 ;; which dumping a #.(FIND-PACKAGE ..) expression
1605 ;; would work fine) If this is possible, it would
1606 ;; probably be a good thing, since minimizing the
1607 ;; amount of stuff in cold init is basically good.
1608 (or (find-package "SB-DEBUG")
1609 (find-package "SB!DEBUG"))))))))
1611 ;;; Parse the packed representation of DEBUG-VARs from
1612 ;;; DEBUG-FUN's SB!C::COMPILED-DEBUG-FUN, returning a vector
1613 ;;; of DEBUG-VARs, or NIL if there was no information to parse.
1614 (defun parse-compiled-debug-vars (debug-fun)
1615 (let* ((cdebug-fun (compiled-debug-fun-compiler-debug-fun
1617 (packed-vars (sb!c::compiled-debug-fun-vars cdebug-fun))
1618 (args-minimal (eq (sb!c::compiled-debug-fun-arguments cdebug-fun)
1622 (buffer (make-array 0 :fill-pointer 0 :adjustable t)))
1623 ((>= i (length packed-vars))
1624 (let ((result (coerce buffer 'simple-vector)))
1626 (assign-minimal-var-names result))
1628 (flet ((geti () (prog1 (aref packed-vars i) (incf i))))
1629 (let* ((flags (geti))
1630 (minimal (logtest sb!c::compiled-debug-var-minimal-p flags))
1631 (deleted (logtest sb!c::compiled-debug-var-deleted-p flags))
1632 (live (logtest sb!c::compiled-debug-var-environment-live
1634 (save (logtest sb!c::compiled-debug-var-save-loc-p flags))
1635 (symbol (if minimal nil (geti)))
1636 (id (if (logtest sb!c::compiled-debug-var-id-p flags)
1639 (sc-offset (if deleted 0 (geti)))
1640 (save-sc-offset (if save (geti) nil)))
1641 (aver (not (and args-minimal (not minimal))))
1642 (vector-push-extend (make-compiled-debug-var symbol
1651 ;;; If we're sure of whether code-location is known, return T or NIL.
1652 ;;; If we're :UNSURE, then try to fill in the code-location's slots.
1653 ;;; This determines whether there is any debug-block information, and
1654 ;;; if code-location is known.
1656 ;;; ??? IF this conses closures every time it's called, then break off the
1657 ;;; :UNSURE part to get the HANDLER-CASE into another function.
1658 (defun code-location-unknown-p (basic-code-location)
1659 (ecase (code-location-%unknown-p basic-code-location)
1663 (setf (code-location-%unknown-p basic-code-location)
1664 (handler-case (not (fill-in-code-location basic-code-location))
1665 (no-debug-blocks () t))))))
1667 ;;; Return the DEBUG-BLOCK containing code-location if it is available.
1668 ;;; Some debug policies inhibit debug-block information, and if none
1669 ;;; is available, then this signals a NO-DEBUG-BLOCKS condition.
1670 (defun code-location-debug-block (basic-code-location)
1671 (let ((block (code-location-%debug-block basic-code-location)))
1672 (if (eq block :unparsed)
1673 (etypecase basic-code-location
1674 (compiled-code-location
1675 (compute-compiled-code-location-debug-block basic-code-location))
1676 ;; (There used to be more cases back before sbcl-0.7.0, when
1677 ;; we did special tricks to debug the IR1 interpreter.)
1681 ;;; Store and return BASIC-CODE-LOCATION's debug-block. We determines
1682 ;;; the correct one using the code-location's pc. We use
1683 ;;; DEBUG-FUN-DEBUG-BLOCKS to return the cached block information
1684 ;;; or signal a NO-DEBUG-BLOCKS condition. The blocks are sorted by
1685 ;;; their first code-location's pc, in ascending order. Therefore, as
1686 ;;; soon as we find a block that starts with a pc greater than
1687 ;;; basic-code-location's pc, we know the previous block contains the
1688 ;;; pc. If we get to the last block, then the code-location is either
1689 ;;; in the second to last block or the last block, and we have to be
1690 ;;; careful in determining this since the last block could be code at
1691 ;;; the end of the function. We have to check for the last block being
1692 ;;; code first in order to see how to compare the code-location's pc.
1693 (defun compute-compiled-code-location-debug-block (basic-code-location)
1694 (let* ((pc (compiled-code-location-pc basic-code-location))
1695 (debug-fun (code-location-debug-fun
1696 basic-code-location))
1697 (blocks (debug-fun-debug-blocks debug-fun))
1698 (len (length blocks)))
1699 (declare (simple-vector blocks))
1700 (setf (code-location-%debug-block basic-code-location)
1706 (let ((last (svref blocks end)))
1708 ((debug-block-elsewhere-p last)
1710 (sb!c::compiled-debug-fun-elsewhere-pc
1711 (compiled-debug-fun-compiler-debug-fun
1713 (svref blocks (1- end))
1716 (compiled-code-location-pc
1717 (svref (compiled-debug-block-code-locations last)
1719 (svref blocks (1- end)))
1721 (declare (type index i end))
1723 (compiled-code-location-pc
1724 (svref (compiled-debug-block-code-locations
1727 (return (svref blocks (1- i)))))))))
1729 ;;; Return the CODE-LOCATION's DEBUG-SOURCE.
1730 (defun code-location-debug-source (code-location)
1731 (let ((info (compiled-debug-fun-debug-info
1732 (code-location-debug-fun code-location))))
1733 (or (sb!c::debug-info-source info)
1734 (debug-signal 'no-debug-blocks :debug-fun
1735 (code-location-debug-fun code-location)))))
1737 ;;; Returns the number of top level forms before the one containing
1738 ;;; CODE-LOCATION as seen by the compiler in some compilation unit. (A
1739 ;;; compilation unit is not necessarily a single file, see the section
1740 ;;; on debug-sources.)
1741 (defun code-location-toplevel-form-offset (code-location)
1742 (when (code-location-unknown-p code-location)
1743 (error 'unknown-code-location :code-location code-location))
1744 (let ((tlf-offset (code-location-%tlf-offset code-location)))
1745 (cond ((eq tlf-offset :unparsed)
1746 (etypecase code-location
1747 (compiled-code-location
1748 (unless (fill-in-code-location code-location)
1749 ;; This check should be unnecessary. We're missing
1750 ;; debug info the compiler should have dumped.
1751 (bug "unknown code location"))
1752 (code-location-%tlf-offset code-location))
1753 ;; (There used to be more cases back before sbcl-0.7.0,,
1754 ;; when we did special tricks to debug the IR1
1759 ;;; Return the number of the form corresponding to CODE-LOCATION. The
1760 ;;; form number is derived by a walking the subforms of a top level
1761 ;;; form in depth-first order.
1762 (defun code-location-form-number (code-location)
1763 (when (code-location-unknown-p code-location)
1764 (error 'unknown-code-location :code-location code-location))
1765 (let ((form-num (code-location-%form-number code-location)))
1766 (cond ((eq form-num :unparsed)
1767 (etypecase code-location
1768 (compiled-code-location
1769 (unless (fill-in-code-location code-location)
1770 ;; This check should be unnecessary. We're missing
1771 ;; debug info the compiler should have dumped.
1772 (bug "unknown code location"))
1773 (code-location-%form-number code-location))
1774 ;; (There used to be more cases back before sbcl-0.7.0,,
1775 ;; when we did special tricks to debug the IR1
1780 ;;; Return the kind of CODE-LOCATION, one of:
1781 ;;; :INTERPRETED, :UNKNOWN-RETURN, :KNOWN-RETURN, :INTERNAL-ERROR,
1782 ;;; :NON-LOCAL-EXIT, :BLOCK-START, :CALL-SITE, :SINGLE-VALUE-RETURN,
1783 ;;; :NON-LOCAL-ENTRY
1784 (defun code-location-kind (code-location)
1785 (when (code-location-unknown-p code-location)
1786 (error 'unknown-code-location :code-location code-location))
1787 (etypecase code-location
1788 (compiled-code-location
1789 (let ((kind (compiled-code-location-kind code-location)))
1790 (cond ((not (eq kind :unparsed)) kind)
1791 ((not (fill-in-code-location code-location))
1792 ;; This check should be unnecessary. We're missing
1793 ;; debug info the compiler should have dumped.
1794 (bug "unknown code location"))
1796 (compiled-code-location-kind code-location)))))
1797 ;; (There used to be more cases back before sbcl-0.7.0,,
1798 ;; when we did special tricks to debug the IR1
1802 ;;; This returns CODE-LOCATION's live-set if it is available. If
1803 ;;; there is no debug-block information, this returns NIL.
1804 (defun compiled-code-location-live-set (code-location)
1805 (if (code-location-unknown-p code-location)
1807 (let ((live-set (compiled-code-location-%live-set code-location)))
1808 (cond ((eq live-set :unparsed)
1809 (unless (fill-in-code-location code-location)
1810 ;; This check should be unnecessary. We're missing
1811 ;; debug info the compiler should have dumped.
1813 ;; FIXME: This error and comment happen over and over again.
1814 ;; Make them a shared function.
1815 (bug "unknown code location"))
1816 (compiled-code-location-%live-set code-location))
1819 ;;; true if OBJ1 and OBJ2 are the same place in the code
1820 (defun code-location= (obj1 obj2)
1822 (compiled-code-location
1824 (compiled-code-location
1825 (and (eq (code-location-debug-fun obj1)
1826 (code-location-debug-fun obj2))
1827 (sub-compiled-code-location= obj1 obj2)))
1828 ;; (There used to be more cases back before sbcl-0.7.0,,
1829 ;; when we did special tricks to debug the IR1
1832 ;; (There used to be more cases back before sbcl-0.7.0,,
1833 ;; when we did special tricks to debug IR1-interpreted code.)
1835 (defun sub-compiled-code-location= (obj1 obj2)
1836 (= (compiled-code-location-pc obj1)
1837 (compiled-code-location-pc obj2)))
1839 ;;; Fill in CODE-LOCATION's :UNPARSED slots, returning T or NIL
1840 ;;; depending on whether the code-location was known in its
1841 ;;; DEBUG-FUN's debug-block information. This may signal a
1842 ;;; NO-DEBUG-BLOCKS condition due to DEBUG-FUN-DEBUG-BLOCKS, and
1843 ;;; it assumes the %UNKNOWN-P slot is already set or going to be set.
1844 (defun fill-in-code-location (code-location)
1845 (declare (type compiled-code-location code-location))
1846 (let* ((debug-fun (code-location-debug-fun code-location))
1847 (blocks (debug-fun-debug-blocks debug-fun)))
1848 (declare (simple-vector blocks))
1849 (dotimes (i (length blocks) nil)
1850 (let* ((block (svref blocks i))
1851 (locations (compiled-debug-block-code-locations block)))
1852 (declare (simple-vector locations))
1853 (dotimes (j (length locations))
1854 (let ((loc (svref locations j)))
1855 (when (sub-compiled-code-location= code-location loc)
1856 (setf (code-location-%debug-block code-location) block)
1857 (setf (code-location-%tlf-offset code-location)
1858 (code-location-%tlf-offset loc))
1859 (setf (code-location-%form-number code-location)
1860 (code-location-%form-number loc))
1861 (setf (compiled-code-location-%live-set code-location)
1862 (compiled-code-location-%live-set loc))
1863 (setf (compiled-code-location-kind code-location)
1864 (compiled-code-location-kind loc))
1865 (setf (compiled-code-location-step-info code-location)
1866 (compiled-code-location-step-info loc))
1867 (return-from fill-in-code-location t))))))))
1869 ;;;; operations on DEBUG-BLOCKs
1871 ;;; Execute FORMS in a context with CODE-VAR bound to each
1872 ;;; CODE-LOCATION in DEBUG-BLOCK, and return the value of RESULT.
1873 (defmacro do-debug-block-locations ((code-var debug-block &optional result)
1875 (let ((code-locations (gensym))
1877 `(let ((,code-locations (debug-block-code-locations ,debug-block)))
1878 (declare (simple-vector ,code-locations))
1879 (dotimes (,i (length ,code-locations) ,result)
1880 (let ((,code-var (svref ,code-locations ,i)))
1883 ;;; Return the name of the function represented by DEBUG-FUN.
1884 ;;; This may be a string or a cons; do not assume it is a symbol.
1885 (defun debug-block-fun-name (debug-block)
1886 (etypecase debug-block
1887 (compiled-debug-block
1888 (let ((code-locs (compiled-debug-block-code-locations debug-block)))
1889 (declare (simple-vector code-locs))
1890 (if (zerop (length code-locs))
1891 "??? Can't get name of debug-block's function."
1893 (code-location-debug-fun (svref code-locs 0))))))
1894 ;; (There used to be more cases back before sbcl-0.7.0, when we
1895 ;; did special tricks to debug the IR1 interpreter.)
1898 (defun debug-block-code-locations (debug-block)
1899 (etypecase debug-block
1900 (compiled-debug-block
1901 (compiled-debug-block-code-locations debug-block))
1902 ;; (There used to be more cases back before sbcl-0.7.0, when we
1903 ;; did special tricks to debug the IR1 interpreter.)
1906 ;;;; operations on debug variables
1908 (defun debug-var-symbol-name (debug-var)
1909 (symbol-name (debug-var-symbol debug-var)))
1911 ;;; FIXME: Make sure that this isn't called anywhere that it wouldn't
1912 ;;; be acceptable to have NIL returned, or that it's only called on
1913 ;;; DEBUG-VARs whose symbols have non-NIL packages.
1914 (defun debug-var-package-name (debug-var)
1915 (package-name (symbol-package (debug-var-symbol debug-var))))
1917 ;;; Return the value stored for DEBUG-VAR in frame, or if the value is
1918 ;;; not :VALID, then signal an INVALID-VALUE error.
1919 (defun debug-var-valid-value (debug-var frame)
1920 (unless (eq (debug-var-validity debug-var (frame-code-location frame))
1922 (error 'invalid-value :debug-var debug-var :frame frame))
1923 (debug-var-value debug-var frame))
1925 ;;; Returns the value stored for DEBUG-VAR in frame. The value may be
1926 ;;; invalid. This is SETFable.
1927 (defun debug-var-value (debug-var frame)
1928 (aver (typep frame 'compiled-frame))
1929 (let ((res (access-compiled-debug-var-slot debug-var frame)))
1930 (if (indirect-value-cell-p res)
1931 (value-cell-ref res)
1934 ;;; This returns what is stored for the variable represented by
1935 ;;; DEBUG-VAR relative to the FRAME. This may be an indirect value
1936 ;;; cell if the variable is both closed over and set.
1937 (defun access-compiled-debug-var-slot (debug-var frame)
1938 (declare (optimize (speed 1)))
1939 (let ((escaped (compiled-frame-escaped frame)))
1941 (sub-access-debug-var-slot
1942 (frame-pointer frame)
1943 (compiled-debug-var-sc-offset debug-var)
1945 (sub-access-debug-var-slot
1946 (frame-pointer frame)
1947 (or (compiled-debug-var-save-sc-offset debug-var)
1948 (compiled-debug-var-sc-offset debug-var))))))
1950 ;;; a helper function for working with possibly-invalid values:
1951 ;;; Do (MAKE-LISP-OBJ VAL) only if the value looks valid.
1953 ;;; (Such values can arise in registers on machines with conservative
1954 ;;; GC, and might also arise in debug variable locations when
1955 ;;; those variables are invalid.)
1956 (defun make-valid-lisp-obj (val)
1959 (zerop (logand val sb!vm:fixnum-tag-mask))
1960 ;; immediate single float, 64-bit only
1961 #!+#.(cl:if (cl:= sb!vm::n-machine-word-bits 64) '(and) '(or))
1962 (= (logand val #xff) sb!vm:single-float-widetag)
1964 (and (zerop (logandc2 val #x1fffffff)) ; Top bits zero
1965 (= (logand val #xff) sb!vm:character-widetag)) ; char tag
1967 (= val sb!vm:unbound-marker-widetag)
1969 (and (logbitp 0 val)
1970 ;; Check that the pointer is valid. XXX Could do a better
1971 ;; job. FIXME: e.g. by calling out to an is_valid_pointer
1972 ;; routine in the C runtime support code
1973 (or (< sb!vm:read-only-space-start val
1974 (* sb!vm:*read-only-space-free-pointer*
1975 sb!vm:n-word-bytes))
1976 (< sb!vm:static-space-start val
1977 (* sb!vm:*static-space-free-pointer*
1978 sb!vm:n-word-bytes))
1979 (< (current-dynamic-space-start) val
1980 (sap-int (dynamic-space-free-pointer))))))
1985 (defun sub-access-debug-var-slot (fp sc-offset &optional escaped)
1986 (macrolet ((with-escaped-value ((var) &body forms)
1988 (let ((,var (sb!vm:context-register
1990 (sb!c:sc-offset-offset sc-offset))))
1992 :invalid-value-for-unescaped-register-storage))
1993 (escaped-float-value (format)
1995 (sb!vm:context-float-register
1997 (sb!c:sc-offset-offset sc-offset)
1999 :invalid-value-for-unescaped-register-storage))
2000 (with-nfp ((var) &body body)
2001 `(let ((,var (if escaped
2003 (sb!vm:context-register escaped
2006 (sb!sys:sap-ref-sap fp (* nfp-save-offset
2007 sb!vm:n-word-bytes))
2009 (sb!vm::make-number-stack-pointer
2010 (sb!sys:sap-ref-32 fp (* nfp-save-offset
2011 sb!vm:n-word-bytes))))))
2013 (ecase (sb!c:sc-offset-scn sc-offset)
2014 ((#.sb!vm:any-reg-sc-number
2015 #.sb!vm:descriptor-reg-sc-number
2016 #!+rt #.sb!vm:word-pointer-reg-sc-number)
2017 (sb!sys:without-gcing
2018 (with-escaped-value (val) (sb!kernel:make-lisp-obj val))))
2020 (#.sb!vm:character-reg-sc-number
2021 (with-escaped-value (val)
2023 (#.sb!vm:sap-reg-sc-number
2024 (with-escaped-value (val)
2025 (sb!sys:int-sap val)))
2026 (#.sb!vm:signed-reg-sc-number
2027 (with-escaped-value (val)
2028 (if (logbitp (1- sb!vm:n-word-bits) val)
2029 (logior val (ash -1 sb!vm:n-word-bits))
2031 (#.sb!vm:unsigned-reg-sc-number
2032 (with-escaped-value (val)
2034 (#.sb!vm:non-descriptor-reg-sc-number
2035 (error "Local non-descriptor register access?"))
2036 (#.sb!vm:interior-reg-sc-number
2037 (error "Local interior register access?"))
2038 (#.sb!vm:single-reg-sc-number
2039 (escaped-float-value single-float))
2040 (#.sb!vm:double-reg-sc-number
2041 (escaped-float-value double-float))
2043 (#.sb!vm:long-reg-sc-number
2044 (escaped-float-value long-float))
2045 (#.sb!vm:complex-single-reg-sc-number
2048 (sb!vm:context-float-register
2049 escaped (sb!c:sc-offset-offset sc-offset) 'single-float)
2050 (sb!vm:context-float-register
2051 escaped (1+ (sb!c:sc-offset-offset sc-offset)) 'single-float))
2052 :invalid-value-for-unescaped-register-storage))
2053 (#.sb!vm:complex-double-reg-sc-number
2056 (sb!vm:context-float-register
2057 escaped (sb!c:sc-offset-offset sc-offset) 'double-float)
2058 (sb!vm:context-float-register
2059 escaped (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 2 #!-sparc 1)
2061 :invalid-value-for-unescaped-register-storage))
2063 (#.sb!vm:complex-long-reg-sc-number
2066 (sb!vm:context-float-register
2067 escaped (sb!c:sc-offset-offset sc-offset) 'long-float)
2068 (sb!vm:context-float-register
2069 escaped (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 4)
2071 :invalid-value-for-unescaped-register-storage))
2072 (#.sb!vm:single-stack-sc-number
2074 (sb!sys:sap-ref-single nfp (* (sb!c:sc-offset-offset sc-offset)
2075 sb!vm:n-word-bytes))))
2076 (#.sb!vm:double-stack-sc-number
2078 (sb!sys:sap-ref-double nfp (* (sb!c:sc-offset-offset sc-offset)
2079 sb!vm:n-word-bytes))))
2081 (#.sb!vm:long-stack-sc-number
2083 (sb!sys:sap-ref-long nfp (* (sb!c:sc-offset-offset sc-offset)
2084 sb!vm:n-word-bytes))))
2085 (#.sb!vm:complex-single-stack-sc-number
2088 (sb!sys:sap-ref-single nfp (* (sb!c:sc-offset-offset sc-offset)
2089 sb!vm:n-word-bytes))
2090 (sb!sys:sap-ref-single nfp (* (1+ (sb!c:sc-offset-offset sc-offset))
2091 sb!vm:n-word-bytes)))))
2092 (#.sb!vm:complex-double-stack-sc-number
2095 (sb!sys:sap-ref-double nfp (* (sb!c:sc-offset-offset sc-offset)
2096 sb!vm:n-word-bytes))
2097 (sb!sys:sap-ref-double nfp (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2098 sb!vm:n-word-bytes)))))
2100 (#.sb!vm:complex-long-stack-sc-number
2103 (sb!sys:sap-ref-long nfp (* (sb!c:sc-offset-offset sc-offset)
2104 sb!vm:n-word-bytes))
2105 (sb!sys:sap-ref-long nfp (* (+ (sb!c:sc-offset-offset sc-offset)
2107 sb!vm:n-word-bytes)))))
2108 (#.sb!vm:control-stack-sc-number
2109 (sb!kernel:stack-ref fp (sb!c:sc-offset-offset sc-offset)))
2110 (#.sb!vm:character-stack-sc-number
2112 (code-char (sb!sys:sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2113 sb!vm:n-word-bytes)))))
2114 (#.sb!vm:unsigned-stack-sc-number
2116 (sb!sys:sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2117 sb!vm:n-word-bytes))))
2118 (#.sb!vm:signed-stack-sc-number
2120 (sb!sys:signed-sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2121 sb!vm:n-word-bytes))))
2122 (#.sb!vm:sap-stack-sc-number
2124 (sb!sys:sap-ref-sap nfp (* (sb!c:sc-offset-offset sc-offset)
2125 sb!vm:n-word-bytes)))))))
2128 (defun sub-access-debug-var-slot (fp sc-offset &optional escaped)
2129 (declare (type system-area-pointer fp))
2130 (macrolet ((with-escaped-value ((var) &body forms)
2132 (let ((,var (sb!vm:context-register
2134 (sb!c:sc-offset-offset sc-offset))))
2136 :invalid-value-for-unescaped-register-storage))
2137 (escaped-float-value (format)
2139 (sb!vm:context-float-register
2140 escaped (sb!c:sc-offset-offset sc-offset) ',format)
2141 :invalid-value-for-unescaped-register-storage))
2142 (escaped-complex-float-value (format)
2145 (sb!vm:context-float-register
2146 escaped (sb!c:sc-offset-offset sc-offset) ',format)
2147 (sb!vm:context-float-register
2148 escaped (1+ (sb!c:sc-offset-offset sc-offset)) ',format))
2149 :invalid-value-for-unescaped-register-storage)))
2150 (ecase (sb!c:sc-offset-scn sc-offset)
2151 ((#.sb!vm:any-reg-sc-number #.sb!vm:descriptor-reg-sc-number)
2153 (with-escaped-value (val)
2154 (make-valid-lisp-obj val))))
2155 (#.sb!vm:character-reg-sc-number
2156 (with-escaped-value (val)
2158 (#.sb!vm:sap-reg-sc-number
2159 (with-escaped-value (val)
2161 (#.sb!vm:signed-reg-sc-number
2162 (with-escaped-value (val)
2163 (if (logbitp (1- sb!vm:n-word-bits) val)
2164 (logior val (ash -1 sb!vm:n-word-bits))
2166 (#.sb!vm:unsigned-reg-sc-number
2167 (with-escaped-value (val)
2169 (#.sb!vm:single-reg-sc-number
2170 (escaped-float-value single-float))
2171 (#.sb!vm:double-reg-sc-number
2172 (escaped-float-value double-float))
2174 (#.sb!vm:long-reg-sc-number
2175 (escaped-float-value long-float))
2176 (#.sb!vm:complex-single-reg-sc-number
2177 (escaped-complex-float-value single-float))
2178 (#.sb!vm:complex-double-reg-sc-number
2179 (escaped-complex-float-value double-float))
2181 (#.sb!vm:complex-long-reg-sc-number
2182 (escaped-complex-float-value long-float))
2183 (#.sb!vm:single-stack-sc-number
2184 (sap-ref-single fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2185 sb!vm:n-word-bytes))))
2186 (#.sb!vm:double-stack-sc-number
2187 (sap-ref-double fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2188 sb!vm:n-word-bytes))))
2190 (#.sb!vm:long-stack-sc-number
2191 (sap-ref-long fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2192 sb!vm:n-word-bytes))))
2193 (#.sb!vm:complex-single-stack-sc-number
2195 (sap-ref-single fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2196 sb!vm:n-word-bytes)))
2197 (sap-ref-single fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2198 sb!vm:n-word-bytes)))))
2199 (#.sb!vm:complex-double-stack-sc-number
2201 (sap-ref-double fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2202 sb!vm:n-word-bytes)))
2203 (sap-ref-double fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 4)
2204 sb!vm:n-word-bytes)))))
2206 (#.sb!vm:complex-long-stack-sc-number
2208 (sap-ref-long fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2209 sb!vm:n-word-bytes)))
2210 (sap-ref-long fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 6)
2211 sb!vm:n-word-bytes)))))
2212 (#.sb!vm:control-stack-sc-number
2213 (stack-ref fp (sb!c:sc-offset-offset sc-offset)))
2214 (#.sb!vm:character-stack-sc-number
2216 (sap-ref-word fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2217 sb!vm:n-word-bytes)))))
2218 (#.sb!vm:unsigned-stack-sc-number
2219 (sap-ref-word fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2220 sb!vm:n-word-bytes))))
2221 (#.sb!vm:signed-stack-sc-number
2222 (signed-sap-ref-word fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2223 sb!vm:n-word-bytes))))
2224 (#.sb!vm:sap-stack-sc-number
2225 (sap-ref-sap fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2226 sb!vm:n-word-bytes)))))))
2228 ;;; This stores value as the value of DEBUG-VAR in FRAME. In the
2229 ;;; COMPILED-DEBUG-VAR case, access the current value to determine if
2230 ;;; it is an indirect value cell. This occurs when the variable is
2231 ;;; both closed over and set.
2232 (defun %set-debug-var-value (debug-var frame new-value)
2233 (aver (typep frame 'compiled-frame))
2234 (let ((old-value (access-compiled-debug-var-slot debug-var frame)))
2235 (if (indirect-value-cell-p old-value)
2236 (value-cell-set old-value new-value)
2237 (set-compiled-debug-var-slot debug-var frame new-value)))
2240 ;;; This stores VALUE for the variable represented by debug-var
2241 ;;; relative to the frame. This assumes the location directly contains
2242 ;;; the variable's value; that is, there is no indirect value cell
2243 ;;; currently there in case the variable is both closed over and set.
2244 (defun set-compiled-debug-var-slot (debug-var frame value)
2245 (let ((escaped (compiled-frame-escaped frame)))
2247 (sub-set-debug-var-slot (frame-pointer frame)
2248 (compiled-debug-var-sc-offset debug-var)
2250 (sub-set-debug-var-slot
2251 (frame-pointer frame)
2252 (or (compiled-debug-var-save-sc-offset debug-var)
2253 (compiled-debug-var-sc-offset debug-var))
2257 (defun sub-set-debug-var-slot (fp sc-offset value &optional escaped)
2258 (macrolet ((set-escaped-value (val)
2260 (setf (sb!vm:context-register
2262 (sb!c:sc-offset-offset sc-offset))
2265 (set-escaped-float-value (format val)
2267 (setf (sb!vm:context-float-register
2269 (sb!c:sc-offset-offset sc-offset)
2273 (with-nfp ((var) &body body)
2274 `(let ((,var (if escaped
2276 (sb!vm:context-register escaped
2281 sb!vm:n-word-bytes))
2283 (sb!vm::make-number-stack-pointer
2286 sb!vm:n-word-bytes))))))
2288 (ecase (sb!c:sc-offset-scn sc-offset)
2289 ((#.sb!vm:any-reg-sc-number
2290 #.sb!vm:descriptor-reg-sc-number
2291 #!+rt #.sb!vm:word-pointer-reg-sc-number)
2294 (get-lisp-obj-address value))))
2295 (#.sb!vm:character-reg-sc-number
2296 (set-escaped-value (char-code value)))
2297 (#.sb!vm:sap-reg-sc-number
2298 (set-escaped-value (sap-int value)))
2299 (#.sb!vm:signed-reg-sc-number
2300 (set-escaped-value (logand value (1- (ash 1 sb!vm:n-word-bits)))))
2301 (#.sb!vm:unsigned-reg-sc-number
2302 (set-escaped-value value))
2303 (#.sb!vm:non-descriptor-reg-sc-number
2304 (error "Local non-descriptor register access?"))
2305 (#.sb!vm:interior-reg-sc-number
2306 (error "Local interior register access?"))
2307 (#.sb!vm:single-reg-sc-number
2308 (set-escaped-float-value single-float value))
2309 (#.sb!vm:double-reg-sc-number
2310 (set-escaped-float-value double-float value))
2312 (#.sb!vm:long-reg-sc-number
2313 (set-escaped-float-value long-float value))
2314 (#.sb!vm:complex-single-reg-sc-number
2316 (setf (sb!vm:context-float-register escaped
2317 (sb!c:sc-offset-offset sc-offset)
2320 (setf (sb!vm:context-float-register
2321 escaped (1+ (sb!c:sc-offset-offset sc-offset))
2325 (#.sb!vm:complex-double-reg-sc-number
2327 (setf (sb!vm:context-float-register
2328 escaped (sb!c:sc-offset-offset sc-offset) 'double-float)
2330 (setf (sb!vm:context-float-register
2332 (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 2 #!-sparc 1)
2337 (#.sb!vm:complex-long-reg-sc-number
2339 (setf (sb!vm:context-float-register
2340 escaped (sb!c:sc-offset-offset sc-offset) 'long-float)
2342 (setf (sb!vm:context-float-register
2344 (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 4)
2348 (#.sb!vm:single-stack-sc-number
2350 (setf (sap-ref-single nfp (* (sb!c:sc-offset-offset sc-offset)
2351 sb!vm:n-word-bytes))
2352 (the single-float value))))
2353 (#.sb!vm:double-stack-sc-number
2355 (setf (sap-ref-double nfp (* (sb!c:sc-offset-offset sc-offset)
2356 sb!vm:n-word-bytes))
2357 (the double-float value))))
2359 (#.sb!vm:long-stack-sc-number
2361 (setf (sap-ref-long nfp (* (sb!c:sc-offset-offset sc-offset)
2362 sb!vm:n-word-bytes))
2363 (the long-float value))))
2364 (#.sb!vm:complex-single-stack-sc-number
2366 (setf (sap-ref-single
2367 nfp (* (sb!c:sc-offset-offset sc-offset) sb!vm:n-word-bytes))
2368 (the single-float (realpart value)))
2369 (setf (sap-ref-single
2370 nfp (* (1+ (sb!c:sc-offset-offset sc-offset))
2371 sb!vm:n-word-bytes))
2372 (the single-float (realpart value)))))
2373 (#.sb!vm:complex-double-stack-sc-number
2375 (setf (sap-ref-double
2376 nfp (* (sb!c:sc-offset-offset sc-offset) sb!vm:n-word-bytes))
2377 (the double-float (realpart value)))
2378 (setf (sap-ref-double
2379 nfp (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2380 sb!vm:n-word-bytes))
2381 (the double-float (realpart value)))))
2383 (#.sb!vm:complex-long-stack-sc-number
2386 nfp (* (sb!c:sc-offset-offset sc-offset) sb!vm:n-word-bytes))
2387 (the long-float (realpart value)))
2389 nfp (* (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 4)
2390 sb!vm:n-word-bytes))
2391 (the long-float (realpart value)))))
2392 (#.sb!vm:control-stack-sc-number
2393 (setf (stack-ref fp (sb!c:sc-offset-offset sc-offset)) value))
2394 (#.sb!vm:character-stack-sc-number
2396 (setf (sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2397 sb!vm:n-word-bytes))
2398 (char-code (the character value)))))
2399 (#.sb!vm:unsigned-stack-sc-number
2401 (setf (sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2402 sb!vm:n-word-bytes))
2403 (the (unsigned-byte 32) value))))
2404 (#.sb!vm:signed-stack-sc-number
2406 (setf (signed-sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2407 sb!vm:n-word-bytes))
2408 (the (signed-byte 32) value))))
2409 (#.sb!vm:sap-stack-sc-number
2411 (setf (sap-ref-sap nfp (* (sb!c:sc-offset-offset sc-offset)
2412 sb!vm:n-word-bytes))
2413 (the system-area-pointer value)))))))
2416 (defun sub-set-debug-var-slot (fp sc-offset value &optional escaped)
2417 (macrolet ((set-escaped-value (val)
2419 (setf (sb!vm:context-register
2421 (sb!c:sc-offset-offset sc-offset))
2424 (ecase (sb!c:sc-offset-scn sc-offset)
2425 ((#.sb!vm:any-reg-sc-number #.sb!vm:descriptor-reg-sc-number)
2428 (get-lisp-obj-address value))))
2429 (#.sb!vm:character-reg-sc-number
2430 (set-escaped-value (char-code value)))
2431 (#.sb!vm:sap-reg-sc-number
2432 (set-escaped-value (sap-int value)))
2433 (#.sb!vm:signed-reg-sc-number
2434 (set-escaped-value (logand value (1- (ash 1 sb!vm:n-word-bits)))))
2435 (#.sb!vm:unsigned-reg-sc-number
2436 (set-escaped-value value))
2437 (#.sb!vm:single-reg-sc-number
2438 #+nil ;; don't have escaped floats.
2439 (set-escaped-float-value single-float value))
2440 (#.sb!vm:double-reg-sc-number
2441 #+nil ;; don't have escaped floats -- still in npx?
2442 (set-escaped-float-value double-float value))
2444 (#.sb!vm:long-reg-sc-number
2445 #+nil ;; don't have escaped floats -- still in npx?
2446 (set-escaped-float-value long-float value))
2447 (#.sb!vm:single-stack-sc-number
2448 (setf (sap-ref-single
2449 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2450 sb!vm:n-word-bytes)))
2451 (the single-float value)))
2452 (#.sb!vm:double-stack-sc-number
2453 (setf (sap-ref-double
2454 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2455 sb!vm:n-word-bytes)))
2456 (the double-float value)))
2458 (#.sb!vm:long-stack-sc-number
2460 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2461 sb!vm:n-word-bytes)))
2462 (the long-float value)))
2463 (#.sb!vm:complex-single-stack-sc-number
2464 (setf (sap-ref-single
2465 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2466 sb!vm:n-word-bytes)))
2467 (realpart (the (complex single-float) value)))
2468 (setf (sap-ref-single
2469 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2470 sb!vm:n-word-bytes)))
2471 (imagpart (the (complex single-float) value))))
2472 (#.sb!vm:complex-double-stack-sc-number
2473 (setf (sap-ref-double
2474 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2475 sb!vm:n-word-bytes)))
2476 (realpart (the (complex double-float) value)))
2477 (setf (sap-ref-double
2478 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 4)
2479 sb!vm:n-word-bytes)))
2480 (imagpart (the (complex double-float) value))))
2482 (#.sb!vm:complex-long-stack-sc-number
2484 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2485 sb!vm:n-word-bytes)))
2486 (realpart (the (complex long-float) value)))
2488 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 6)
2489 sb!vm:n-word-bytes)))
2490 (imagpart (the (complex long-float) value))))
2491 (#.sb!vm:control-stack-sc-number
2492 (setf (stack-ref fp (sb!c:sc-offset-offset sc-offset)) value))
2493 (#.sb!vm:character-stack-sc-number
2494 (setf (sap-ref-word fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2495 sb!vm:n-word-bytes)))
2496 (char-code (the character value))))
2497 (#.sb!vm:unsigned-stack-sc-number
2498 (setf (sap-ref-word fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2499 sb!vm:n-word-bytes)))
2500 (the sb!vm:word value)))
2501 (#.sb!vm:signed-stack-sc-number
2502 (setf (signed-sap-ref-word
2503 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2504 sb!vm:n-word-bytes)))
2505 (the (signed-byte #.sb!vm:n-word-bits) value)))
2506 (#.sb!vm:sap-stack-sc-number
2507 (setf (sap-ref-sap fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2508 sb!vm:n-word-bytes)))
2509 (the system-area-pointer value))))))
2511 ;;; The method for setting and accessing COMPILED-DEBUG-VAR values use
2512 ;;; this to determine if the value stored is the actual value or an
2513 ;;; indirection cell.
2514 (defun indirect-value-cell-p (x)
2515 (and (= (lowtag-of x) sb!vm:other-pointer-lowtag)
2516 (= (widetag-of x) sb!vm:value-cell-header-widetag)))
2518 ;;; Return three values reflecting the validity of DEBUG-VAR's value
2519 ;;; at BASIC-CODE-LOCATION:
2520 ;;; :VALID The value is known to be available.
2521 ;;; :INVALID The value is known to be unavailable.
2522 ;;; :UNKNOWN The value's availability is unknown.
2524 ;;; If the variable is always alive, then it is valid. If the
2525 ;;; code-location is unknown, then the variable's validity is
2526 ;;; :unknown. Once we've called CODE-LOCATION-UNKNOWN-P, we know the
2527 ;;; live-set information has been cached in the code-location.
2528 (defun debug-var-validity (debug-var basic-code-location)
2529 (etypecase debug-var
2531 (compiled-debug-var-validity debug-var basic-code-location))
2532 ;; (There used to be more cases back before sbcl-0.7.0, when
2533 ;; we did special tricks to debug the IR1 interpreter.)
2536 ;;; This is the method for DEBUG-VAR-VALIDITY for COMPILED-DEBUG-VARs.
2537 ;;; For safety, make sure basic-code-location is what we think.
2538 (defun compiled-debug-var-validity (debug-var basic-code-location)
2539 (declare (type compiled-code-location basic-code-location))
2540 (cond ((debug-var-alive-p debug-var)
2541 (let ((debug-fun (code-location-debug-fun basic-code-location)))
2542 (if (>= (compiled-code-location-pc basic-code-location)
2543 (sb!c::compiled-debug-fun-start-pc
2544 (compiled-debug-fun-compiler-debug-fun debug-fun)))
2547 ((code-location-unknown-p basic-code-location) :unknown)
2549 (let ((pos (position debug-var
2550 (debug-fun-debug-vars
2551 (code-location-debug-fun
2552 basic-code-location)))))
2554 (error 'unknown-debug-var
2555 :debug-var debug-var
2557 (code-location-debug-fun basic-code-location)))
2558 ;; There must be live-set info since basic-code-location is known.
2559 (if (zerop (sbit (compiled-code-location-live-set
2560 basic-code-location)
2567 ;;; This code produces and uses what we call source-paths. A
2568 ;;; source-path is a list whose first element is a form number as
2569 ;;; returned by CODE-LOCATION-FORM-NUMBER and whose last element is a
2570 ;;; top level form number as returned by
2571 ;;; CODE-LOCATION-TOPLEVEL-FORM-NUMBER. The elements from the last to
2572 ;;; the first, exclusively, are the numbered subforms into which to
2573 ;;; descend. For example:
2575 ;;; (let ((a (aref x 3)))
2577 ;;; The call to AREF in this example is form number 5. Assuming this
2578 ;;; DEFUN is the 11'th top level form, the source-path for the AREF
2579 ;;; call is as follows:
2581 ;;; Given the DEFUN, 3 gets you the LET, 1 gets you the bindings, 0
2582 ;;; gets the first binding, and 1 gets the AREF form.
2584 ;;; temporary buffer used to build form-number => source-path translation in
2585 ;;; FORM-NUMBER-TRANSLATIONS
2586 (defvar *form-number-temp* (make-array 10 :fill-pointer 0 :adjustable t))
2588 ;;; table used to detect CAR circularities in FORM-NUMBER-TRANSLATIONS
2589 (defvar *form-number-circularity-table* (make-hash-table :test 'eq))
2591 ;;; This returns a table mapping form numbers to source-paths. A
2592 ;;; source-path indicates a descent into the TOPLEVEL-FORM form,
2593 ;;; going directly to the subform corressponding to the form number.
2595 ;;; The vector elements are in the same format as the compiler's
2596 ;;; NODE-SOURCE-PATH; that is, the first element is the form number and
2597 ;;; the last is the TOPLEVEL-FORM number.
2598 (defun form-number-translations (form tlf-number)
2599 (clrhash *form-number-circularity-table*)
2600 (setf (fill-pointer *form-number-temp*) 0)
2601 (sub-translate-form-numbers form (list tlf-number))
2602 (coerce *form-number-temp* 'simple-vector))
2603 (defun sub-translate-form-numbers (form path)
2604 (unless (gethash form *form-number-circularity-table*)
2605 (setf (gethash form *form-number-circularity-table*) t)
2606 (vector-push-extend (cons (fill-pointer *form-number-temp*) path)
2611 (declare (fixnum pos))
2614 (when (atom subform) (return))
2615 (let ((fm (car subform)))
2617 (sub-translate-form-numbers fm (cons pos path)))
2619 (setq subform (cdr subform))
2620 (when (eq subform trail) (return)))))
2624 (setq trail (cdr trail)))))))
2626 ;;; FORM is a top level form, and path is a source-path into it. This
2627 ;;; returns the form indicated by the source-path. Context is the
2628 ;;; number of enclosing forms to return instead of directly returning
2629 ;;; the source-path form. When context is non-zero, the form returned
2630 ;;; contains a marker, #:****HERE****, immediately before the form
2631 ;;; indicated by path.
2632 (defun source-path-context (form path context)
2633 (declare (type unsigned-byte context))
2634 ;; Get to the form indicated by path or the enclosing form indicated
2635 ;; by context and path.
2636 (let ((path (reverse (butlast (cdr path)))))
2637 (dotimes (i (- (length path) context))
2638 (let ((index (first path)))
2639 (unless (and (listp form) (< index (length form)))
2640 (error "Source path no longer exists."))
2641 (setq form (elt form index))
2642 (setq path (rest path))))
2643 ;; Recursively rebuild the source form resulting from the above
2644 ;; descent, copying the beginning of each subform up to the next
2645 ;; subform we descend into according to path. At the bottom of the
2646 ;; recursion, we return the form indicated by path preceded by our
2647 ;; marker, and this gets spliced into the resulting list structure
2648 ;; on the way back up.
2649 (labels ((frob (form path level)
2650 (if (or (zerop level) (null path))
2653 `(#:***here*** ,form))
2654 (let ((n (first path)))
2655 (unless (and (listp form) (< n (length form)))
2656 (error "Source path no longer exists."))
2657 (let ((res (frob (elt form n) (rest path) (1- level))))
2658 (nconc (subseq form 0 n)
2659 (cons res (nthcdr (1+ n) form))))))))
2660 (frob form path context))))
2662 ;;;; PREPROCESS-FOR-EVAL
2664 ;;; Return a function of one argument that evaluates form in the
2665 ;;; lexical context of the BASIC-CODE-LOCATION LOC, or signal a
2666 ;;; NO-DEBUG-VARS condition when the LOC's DEBUG-FUN has no
2667 ;;; DEBUG-VAR information available.
2669 ;;; The returned function takes the frame to get values from as its
2670 ;;; argument, and it returns the values of FORM. The returned function
2671 ;;; can signal the following conditions: INVALID-VALUE,
2672 ;;; AMBIGUOUS-VAR-NAME, and FRAME-FUN-MISMATCH.
2673 (defun preprocess-for-eval (form loc)
2674 (declare (type code-location loc))
2675 (let ((n-frame (gensym))
2676 (fun (code-location-debug-fun loc)))
2677 (unless (debug-var-info-available fun)
2678 (debug-signal 'no-debug-vars :debug-fun fun))
2679 (sb!int:collect ((binds)
2681 (do-debug-fun-vars (var fun)
2682 (let ((validity (debug-var-validity var loc)))
2683 (unless (eq validity :invalid)
2684 (let* ((sym (debug-var-symbol var))
2685 (found (assoc sym (binds))))
2687 (setf (second found) :ambiguous)
2688 (binds (list sym validity var)))))))
2689 (dolist (bind (binds))
2690 (let ((name (first bind))
2692 (ecase (second bind)
2694 (specs `(,name (debug-var-value ',var ,n-frame))))
2696 (specs `(,name (debug-signal 'invalid-value
2700 (specs `(,name (debug-signal 'ambiguous-var-name
2702 :frame ,n-frame)))))))
2703 (let ((res (coerce `(lambda (,n-frame)
2704 (declare (ignorable ,n-frame))
2705 (symbol-macrolet ,(specs) ,form))
2708 ;; This prevents these functions from being used in any
2709 ;; location other than a function return location, so maybe
2710 ;; this should only check whether FRAME's DEBUG-FUN is the
2712 (unless (code-location= (frame-code-location frame) loc)
2713 (debug-signal 'frame-fun-mismatch
2714 :code-location loc :form form :frame frame))
2715 (funcall res frame))))))
2719 ;;;; user-visible interface
2721 ;;; Create and return a breakpoint. When program execution encounters
2722 ;;; the breakpoint, the system calls HOOK-FUN. HOOK-FUN takes the
2723 ;;; current frame for the function in which the program is running and
2724 ;;; the breakpoint object.
2726 ;;; WHAT and KIND determine where in a function the system invokes
2727 ;;; HOOK-FUN. WHAT is either a code-location or a DEBUG-FUN. KIND is
2728 ;;; one of :CODE-LOCATION, :FUN-START, or :FUN-END. Since the starts
2729 ;;; and ends of functions may not have code-locations representing
2730 ;;; them, designate these places by supplying WHAT as a DEBUG-FUN and
2731 ;;; KIND indicating the :FUN-START or :FUN-END. When WHAT is a
2732 ;;; DEBUG-FUN and kind is :FUN-END, then HOOK-FUN must take two
2733 ;;; additional arguments, a list of values returned by the function
2734 ;;; and a FUN-END-COOKIE.
2736 ;;; INFO is information supplied by and used by the user.
2738 ;;; FUN-END-COOKIE is a function. To implement :FUN-END
2739 ;;; breakpoints, the system uses starter breakpoints to establish the
2740 ;;; :FUN-END breakpoint for each invocation of the function. Upon
2741 ;;; each entry, the system creates a unique cookie to identify the
2742 ;;; invocation, and when the user supplies a function for this
2743 ;;; argument, the system invokes it on the frame and the cookie. The
2744 ;;; system later invokes the :FUN-END breakpoint hook on the same
2745 ;;; cookie. The user may save the cookie for comparison in the hook
2748 ;;; Signal an error if WHAT is an unknown code-location.
2749 (defun make-breakpoint (hook-fun what
2750 &key (kind :code-location) info fun-end-cookie)
2753 (when (code-location-unknown-p what)
2754 (error "cannot make a breakpoint at an unknown code location: ~S"
2756 (aver (eq kind :code-location))
2757 (let ((bpt (%make-breakpoint hook-fun what kind info)))
2759 (compiled-code-location
2760 ;; This slot is filled in due to calling CODE-LOCATION-UNKNOWN-P.
2761 (when (eq (compiled-code-location-kind what) :unknown-return)
2762 (let ((other-bpt (%make-breakpoint hook-fun what
2763 :unknown-return-partner
2765 (setf (breakpoint-unknown-return-partner bpt) other-bpt)
2766 (setf (breakpoint-unknown-return-partner other-bpt) bpt))))
2767 ;; (There used to be more cases back before sbcl-0.7.0,,
2768 ;; when we did special tricks to debug the IR1
2775 (%make-breakpoint hook-fun what kind info))
2777 (unless (eq (sb!c::compiled-debug-fun-returns
2778 (compiled-debug-fun-compiler-debug-fun what))
2780 (error ":FUN-END breakpoints are currently unsupported ~
2781 for the known return convention."))
2783 (let* ((bpt (%make-breakpoint hook-fun what kind info))
2784 (starter (compiled-debug-fun-end-starter what)))
2786 (setf starter (%make-breakpoint #'list what :fun-start nil))
2787 (setf (breakpoint-hook-fun starter)
2788 (fun-end-starter-hook starter what))
2789 (setf (compiled-debug-fun-end-starter what) starter))
2790 (setf (breakpoint-start-helper bpt) starter)
2791 (push bpt (breakpoint-%info starter))
2792 (setf (breakpoint-cookie-fun bpt) fun-end-cookie)
2795 ;;; These are unique objects created upon entry into a function by a
2796 ;;; :FUN-END breakpoint's starter hook. These are only created
2797 ;;; when users supply :FUN-END-COOKIE to MAKE-BREAKPOINT. Also,
2798 ;;; the :FUN-END breakpoint's hook is called on the same cookie
2799 ;;; when it is created.
2800 (defstruct (fun-end-cookie
2801 (:print-object (lambda (obj str)
2802 (print-unreadable-object (obj str :type t))))
2803 (:constructor make-fun-end-cookie (bogus-lra debug-fun))
2805 ;; a pointer to the bogus-lra created for :FUN-END breakpoints
2807 ;; the DEBUG-FUN associated with this cookie
2810 ;;; This maps bogus-lra-components to cookies, so that
2811 ;;; HANDLE-FUN-END-BREAKPOINT can find the appropriate cookie for the
2812 ;;; breakpoint hook.
2813 (defvar *fun-end-cookies* (make-hash-table :test 'eq))
2815 ;;; This returns a hook function for the start helper breakpoint
2816 ;;; associated with a :FUN-END breakpoint. The returned function
2817 ;;; makes a fake LRA that all returns go through, and this piece of
2818 ;;; fake code actually breaks. Upon return from the break, the code
2819 ;;; provides the returnee with any values. Since the returned function
2820 ;;; effectively activates FUN-END-BPT on each entry to DEBUG-FUN's
2821 ;;; function, we must establish breakpoint-data about FUN-END-BPT.
2822 (defun fun-end-starter-hook (starter-bpt debug-fun)
2823 (declare (type breakpoint starter-bpt)
2824 (type compiled-debug-fun debug-fun))
2825 (lambda (frame breakpoint)
2826 (declare (ignore breakpoint)
2828 (let ((lra-sc-offset
2829 (sb!c::compiled-debug-fun-return-pc
2830 (compiled-debug-fun-compiler-debug-fun debug-fun))))
2831 (multiple-value-bind (lra component offset)
2833 (get-context-value frame
2836 (setf (get-context-value frame
2840 (let ((end-bpts (breakpoint-%info starter-bpt)))
2841 (let ((data (breakpoint-data component offset)))
2842 (setf (breakpoint-data-breakpoints data) end-bpts)
2843 (dolist (bpt end-bpts)
2844 (setf (breakpoint-internal-data bpt) data)))
2845 (let ((cookie (make-fun-end-cookie lra debug-fun)))
2846 (setf (gethash component *fun-end-cookies*) cookie)
2847 (dolist (bpt end-bpts)
2848 (let ((fun (breakpoint-cookie-fun bpt)))
2849 (when fun (funcall fun frame cookie))))))))))
2851 ;;; This takes a FUN-END-COOKIE and a frame, and it returns
2852 ;;; whether the cookie is still valid. A cookie becomes invalid when
2853 ;;; the frame that established the cookie has exited. Sometimes cookie
2854 ;;; holders are unaware of cookie invalidation because their
2855 ;;; :FUN-END breakpoint hooks didn't run due to THROW'ing.
2857 ;;; This takes a frame as an efficiency hack since the user probably
2858 ;;; has a frame object in hand when using this routine, and it saves
2859 ;;; repeated parsing of the stack and consing when asking whether a
2860 ;;; series of cookies is valid.
2861 (defun fun-end-cookie-valid-p (frame cookie)
2862 (let ((lra (fun-end-cookie-bogus-lra cookie))
2863 (lra-sc-offset (sb!c::compiled-debug-fun-return-pc
2864 (compiled-debug-fun-compiler-debug-fun
2865 (fun-end-cookie-debug-fun cookie)))))
2866 (do ((frame frame (frame-down frame)))
2868 (when (and (compiled-frame-p frame)
2869 (#!-(or x86 x86-64) eq #!+(or x86 x86-64) sap=
2871 (get-context-value frame lra-save-offset lra-sc-offset)))
2874 ;;;; ACTIVATE-BREAKPOINT
2876 ;;; Cause the system to invoke the breakpoint's hook function until
2877 ;;; the next call to DEACTIVATE-BREAKPOINT or DELETE-BREAKPOINT. The
2878 ;;; system invokes breakpoint hook functions in the opposite order
2879 ;;; that you activate them.
2880 (defun activate-breakpoint (breakpoint)
2881 (when (eq (breakpoint-status breakpoint) :deleted)
2882 (error "cannot activate a deleted breakpoint: ~S" breakpoint))
2883 (unless (eq (breakpoint-status breakpoint) :active)
2884 (ecase (breakpoint-kind breakpoint)
2886 (let ((loc (breakpoint-what breakpoint)))
2888 (compiled-code-location
2889 (activate-compiled-code-location-breakpoint breakpoint)
2890 (let ((other (breakpoint-unknown-return-partner breakpoint)))
2892 (activate-compiled-code-location-breakpoint other))))
2893 ;; (There used to be more cases back before sbcl-0.7.0, when
2894 ;; we did special tricks to debug the IR1 interpreter.)
2897 (etypecase (breakpoint-what breakpoint)
2899 (activate-compiled-fun-start-breakpoint breakpoint))
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 (let ((starter (breakpoint-start-helper breakpoint)))
2907 (unless (eq (breakpoint-status starter) :active)
2908 ;; may already be active by some other :FUN-END breakpoint
2909 (activate-compiled-fun-start-breakpoint starter)))
2910 (setf (breakpoint-status breakpoint) :active))
2911 ;; (There used to be more cases back before sbcl-0.7.0, when
2912 ;; we did special tricks to debug the IR1 interpreter.)
2916 (defun activate-compiled-code-location-breakpoint (breakpoint)
2917 (declare (type breakpoint breakpoint))
2918 (let ((loc (breakpoint-what breakpoint)))
2919 (declare (type compiled-code-location loc))
2920 (sub-activate-breakpoint
2922 (breakpoint-data (compiled-debug-fun-component
2923 (code-location-debug-fun loc))
2924 (+ (compiled-code-location-pc loc)
2925 (if (or (eq (breakpoint-kind breakpoint)
2926 :unknown-return-partner)
2927 (eq (compiled-code-location-kind loc)
2928 :single-value-return))
2929 sb!vm:single-value-return-byte-offset
2932 (defun activate-compiled-fun-start-breakpoint (breakpoint)
2933 (declare (type breakpoint breakpoint))
2934 (let ((debug-fun (breakpoint-what breakpoint)))
2935 (sub-activate-breakpoint
2937 (breakpoint-data (compiled-debug-fun-component debug-fun)
2938 (sb!c::compiled-debug-fun-start-pc
2939 (compiled-debug-fun-compiler-debug-fun
2942 (defun sub-activate-breakpoint (breakpoint data)
2943 (declare (type breakpoint breakpoint)
2944 (type breakpoint-data data))
2945 (setf (breakpoint-status breakpoint) :active)
2947 (unless (breakpoint-data-breakpoints data)
2948 (setf (breakpoint-data-instruction data)
2950 (breakpoint-install (get-lisp-obj-address
2951 (breakpoint-data-component data))
2952 (breakpoint-data-offset data)))))
2953 (setf (breakpoint-data-breakpoints data)
2954 (append (breakpoint-data-breakpoints data) (list breakpoint)))
2955 (setf (breakpoint-internal-data breakpoint) data)))
2957 ;;;; DEACTIVATE-BREAKPOINT
2959 ;;; Stop the system from invoking the breakpoint's hook function.
2960 (defun deactivate-breakpoint (breakpoint)
2961 (when (eq (breakpoint-status breakpoint) :active)
2963 (let ((loc (breakpoint-what breakpoint)))
2965 ((or compiled-code-location compiled-debug-fun)
2966 (deactivate-compiled-breakpoint breakpoint)
2967 (let ((other (breakpoint-unknown-return-partner breakpoint)))
2969 (deactivate-compiled-breakpoint other))))
2970 ;; (There used to be more cases back before sbcl-0.7.0, when
2971 ;; we did special tricks to debug the IR1 interpreter.)
2975 (defun deactivate-compiled-breakpoint (breakpoint)
2976 (if (eq (breakpoint-kind breakpoint) :fun-end)
2977 (let ((starter (breakpoint-start-helper breakpoint)))
2978 (unless (find-if (lambda (bpt)
2979 (and (not (eq bpt breakpoint))
2980 (eq (breakpoint-status bpt) :active)))
2981 (breakpoint-%info starter))
2982 (deactivate-compiled-breakpoint starter)))
2983 (let* ((data (breakpoint-internal-data breakpoint))
2984 (bpts (delete breakpoint (breakpoint-data-breakpoints data))))
2985 (setf (breakpoint-internal-data breakpoint) nil)
2986 (setf (breakpoint-data-breakpoints data) bpts)
2989 (breakpoint-remove (get-lisp-obj-address
2990 (breakpoint-data-component data))
2991 (breakpoint-data-offset data)
2992 (breakpoint-data-instruction data)))
2993 (delete-breakpoint-data data))))
2994 (setf (breakpoint-status breakpoint) :inactive)
2997 ;;;; BREAKPOINT-INFO
2999 ;;; Return the user-maintained info associated with breakpoint. This
3001 (defun breakpoint-info (breakpoint)
3002 (breakpoint-%info breakpoint))
3003 (defun %set-breakpoint-info (breakpoint value)
3004 (setf (breakpoint-%info breakpoint) value)
3005 (let ((other (breakpoint-unknown-return-partner breakpoint)))
3007 (setf (breakpoint-%info other) value))))
3009 ;;;; BREAKPOINT-ACTIVE-P and DELETE-BREAKPOINT
3011 (defun breakpoint-active-p (breakpoint)
3012 (ecase (breakpoint-status breakpoint)
3014 ((:inactive :deleted) nil)))
3016 ;;; Free system storage and remove computational overhead associated
3017 ;;; with breakpoint. After calling this, breakpoint is completely
3018 ;;; impotent and can never become active again.
3019 (defun delete-breakpoint (breakpoint)
3020 (let ((status (breakpoint-status breakpoint)))
3021 (unless (eq status :deleted)
3022 (when (eq status :active)
3023 (deactivate-breakpoint breakpoint))
3024 (setf (breakpoint-status breakpoint) :deleted)
3025 (let ((other (breakpoint-unknown-return-partner breakpoint)))
3027 (setf (breakpoint-status other) :deleted)))
3028 (when (eq (breakpoint-kind breakpoint) :fun-end)
3029 (let* ((starter (breakpoint-start-helper breakpoint))
3030 (breakpoints (delete breakpoint
3031 (the list (breakpoint-info starter)))))
3032 (setf (breakpoint-info starter) breakpoints)
3034 (delete-breakpoint starter)
3035 (setf (compiled-debug-fun-end-starter
3036 (breakpoint-what breakpoint))
3040 ;;;; C call out stubs
3042 ;;; This actually installs the break instruction in the component. It
3043 ;;; returns the overwritten bits. You must call this in a context in
3044 ;;; which GC is disabled, so that Lisp doesn't move objects around
3045 ;;; that C is pointing to.
3046 (sb!alien:define-alien-routine "breakpoint_install" sb!alien:unsigned-int
3047 (code-obj sb!alien:unsigned-long)
3048 (pc-offset sb!alien:int))
3050 ;;; This removes the break instruction and replaces the original
3051 ;;; instruction. You must call this in a context in which GC is disabled
3052 ;;; so Lisp doesn't move objects around that C is pointing to.
3053 (sb!alien:define-alien-routine "breakpoint_remove" sb!alien:void
3054 (code-obj sb!alien:unsigned-long)
3055 (pc-offset sb!alien:int)
3056 (old-inst sb!alien:unsigned-int))
3058 (sb!alien:define-alien-routine "breakpoint_do_displaced_inst" sb!alien:void
3059 (scp (* os-context-t))
3060 (orig-inst sb!alien:unsigned-int))
3062 ;;;; breakpoint handlers (layer between C and exported interface)
3064 ;;; This maps components to a mapping of offsets to BREAKPOINT-DATAs.
3065 (defvar *component-breakpoint-offsets* (make-hash-table :test 'eq))
3067 ;;; This returns the BREAKPOINT-DATA object associated with component cross
3068 ;;; offset. If none exists, this makes one, installs it, and returns it.
3069 (defun breakpoint-data (component offset &optional (create t))
3070 (flet ((install-breakpoint-data ()
3072 (let ((data (make-breakpoint-data component offset)))
3073 (push (cons offset data)
3074 (gethash component *component-breakpoint-offsets*))
3076 (let ((offsets (gethash component *component-breakpoint-offsets*)))
3078 (let ((data (assoc offset offsets)))
3081 (install-breakpoint-data)))
3082 (install-breakpoint-data)))))
3084 ;;; We use this when there are no longer any active breakpoints
3085 ;;; corresponding to DATA.
3086 (defun delete-breakpoint-data (data)
3087 (let* ((component (breakpoint-data-component data))
3088 (offsets (delete (breakpoint-data-offset data)
3089 (gethash component *component-breakpoint-offsets*)
3092 (setf (gethash component *component-breakpoint-offsets*) offsets)
3093 (remhash component *component-breakpoint-offsets*)))
3096 ;;; The C handler for interrupts calls this when it has a
3097 ;;; debugging-tool break instruction. This does *not* handle all
3098 ;;; breaks; for example, it does not handle breaks for internal
3100 (defun handle-breakpoint (offset component signal-context)
3101 (let ((data (breakpoint-data component offset nil)))
3103 (error "unknown breakpoint in ~S at offset ~S"
3104 (debug-fun-name (debug-fun-from-pc component offset))
3106 (let ((breakpoints (breakpoint-data-breakpoints data)))
3107 (if (or (null breakpoints)
3108 (eq (breakpoint-kind (car breakpoints)) :fun-end))
3109 (handle-fun-end-breakpoint-aux breakpoints data signal-context)
3110 (handle-breakpoint-aux breakpoints data
3111 offset component signal-context)))))
3113 ;;; This holds breakpoint-datas while invoking the breakpoint hooks
3114 ;;; associated with that particular component and location. While they
3115 ;;; are executing, if we hit the location again, we ignore the
3116 ;;; breakpoint to avoid infinite recursion. fun-end breakpoints
3117 ;;; must work differently since the breakpoint-data is unique for each
3119 (defvar *executing-breakpoint-hooks* nil)
3121 ;;; This handles code-location and DEBUG-FUN :FUN-START
3123 (defun handle-breakpoint-aux (breakpoints data offset component signal-context)
3125 (bug "breakpoint that nobody wants"))
3126 (unless (member data *executing-breakpoint-hooks*)
3127 (let ((*executing-breakpoint-hooks* (cons data
3128 *executing-breakpoint-hooks*)))
3129 (invoke-breakpoint-hooks breakpoints signal-context)))
3130 ;; At this point breakpoints may not hold the same list as
3131 ;; BREAKPOINT-DATA-BREAKPOINTS since invoking hooks may have allowed
3132 ;; a breakpoint deactivation. In fact, if all breakpoints were
3133 ;; deactivated then data is invalid since it was deleted and so the
3134 ;; correct one must be looked up if it is to be used. If there are
3135 ;; no more breakpoints active at this location, then the normal
3136 ;; instruction has been put back, and we do not need to
3137 ;; DO-DISPLACED-INST.
3138 (setf data (breakpoint-data component offset nil))
3139 (when (and data (breakpoint-data-breakpoints data))
3140 ;; The breakpoint is still active, so we need to execute the
3141 ;; displaced instruction and leave the breakpoint instruction
3142 ;; behind. The best way to do this is different on each machine,
3143 ;; so we just leave it up to the C code.
3144 (breakpoint-do-displaced-inst signal-context
3145 (breakpoint-data-instruction data))
3146 ;; Some platforms have no usable sigreturn() call. If your
3147 ;; implementation of arch_do_displaced_inst() _does_ sigreturn(),
3148 ;; it's polite to warn here
3149 #!+(and sparc solaris)
3150 (error "BREAKPOINT-DO-DISPLACED-INST returned?")))
3152 (defun invoke-breakpoint-hooks (breakpoints signal-context)
3153 (let* ((frame (signal-context-frame signal-context)))
3154 (dolist (bpt breakpoints)
3155 (funcall (breakpoint-hook-fun bpt)
3157 ;; If this is an :UNKNOWN-RETURN-PARTNER, then pass the
3158 ;; hook function the original breakpoint, so that users
3159 ;; aren't forced to confront the fact that some
3160 ;; breakpoints really are two.
3161 (if (eq (breakpoint-kind bpt) :unknown-return-partner)
3162 (breakpoint-unknown-return-partner bpt)
3165 (defun signal-context-frame (signal-context)
3168 (declare (optimize (inhibit-warnings 3)))
3169 (sb!alien:sap-alien signal-context (* os-context-t))))
3170 (cfp (int-sap (sb!vm:context-register scp sb!vm::cfp-offset))))
3171 (compute-calling-frame cfp
3172 (sb!vm:context-pc scp)
3175 (defun handle-fun-end-breakpoint (offset component context)
3176 (let ((data (breakpoint-data component offset nil)))
3178 (error "unknown breakpoint in ~S at offset ~S"
3179 (debug-fun-name (debug-fun-from-pc component offset))
3181 (let ((breakpoints (breakpoint-data-breakpoints data)))
3183 (aver (eq (breakpoint-kind (car breakpoints)) :fun-end))
3184 (handle-fun-end-breakpoint-aux breakpoints data context)))))
3186 ;;; Either HANDLE-BREAKPOINT calls this for :FUN-END breakpoints
3187 ;;; [old C code] or HANDLE-FUN-END-BREAKPOINT calls this directly
3189 (defun handle-fun-end-breakpoint-aux (breakpoints data signal-context)
3190 (delete-breakpoint-data data)
3193 (declare (optimize (inhibit-warnings 3)))
3194 (sb!alien:sap-alien signal-context (* os-context-t))))
3195 (frame (signal-context-frame signal-context))
3196 (component (breakpoint-data-component data))
3197 (cookie (gethash component *fun-end-cookies*)))
3198 (remhash component *fun-end-cookies*)
3199 (dolist (bpt breakpoints)
3200 (funcall (breakpoint-hook-fun bpt)
3202 (get-fun-end-breakpoint-values scp)
3205 (defun get-fun-end-breakpoint-values (scp)
3206 (let ((ocfp (int-sap (sb!vm:context-register
3208 #!-(or x86 x86-64) sb!vm::ocfp-offset
3209 #!+(or x86 x86-64) sb!vm::ebx-offset)))
3210 (nargs (make-lisp-obj
3211 (sb!vm:context-register scp sb!vm::nargs-offset)))
3212 (reg-arg-offsets '#.sb!vm::*register-arg-offsets*)
3215 (dotimes (arg-num nargs)
3216 (push (if reg-arg-offsets
3218 (sb!vm:context-register scp (pop reg-arg-offsets)))
3219 (stack-ref ocfp arg-num))
3221 (nreverse results)))
3223 ;;;; MAKE-BOGUS-LRA (used for :FUN-END breakpoints)
3225 (defconstant bogus-lra-constants
3226 #!-(or x86 x86-64) 2 #!+(or x86 x86-64) 3)
3227 (defconstant known-return-p-slot
3228 (+ sb!vm:code-constants-offset #!-(or x86 x86-64) 1 #!+(or x86 x86-64) 2))
3230 ;;; Make a bogus LRA object that signals a breakpoint trap when
3231 ;;; returned to. If the breakpoint trap handler returns, REAL-LRA is
3232 ;;; returned to. Three values are returned: the bogus LRA object, the
3233 ;;; code component it is part of, and the PC offset for the trap
3235 (defun make-bogus-lra (real-lra &optional known-return-p)
3237 ;; These are really code labels, not variables: but this way we get
3239 (let* ((src-start (foreign-symbol-sap "fun_end_breakpoint_guts"))
3240 (src-end (foreign-symbol-sap "fun_end_breakpoint_end"))
3241 (trap-loc (foreign-symbol-sap "fun_end_breakpoint_trap"))
3242 (length (sap- src-end src-start))
3244 (%primitive sb!c:allocate-code-object (1+ bogus-lra-constants)
3246 (dst-start (code-instructions code-object)))
3247 (declare (type system-area-pointer
3248 src-start src-end dst-start trap-loc)
3249 (type index length))
3250 (setf (%code-debug-info code-object) :bogus-lra)
3251 (setf (code-header-ref code-object sb!vm:code-trace-table-offset-slot)
3254 (setf (code-header-ref code-object real-lra-slot) real-lra)
3256 (multiple-value-bind (offset code) (compute-lra-data-from-pc real-lra)
3257 (setf (code-header-ref code-object real-lra-slot) code)
3258 (setf (code-header-ref code-object (1+ real-lra-slot)) offset))
3259 (setf (code-header-ref code-object known-return-p-slot)
3261 (system-area-ub8-copy src-start 0 dst-start 0 length)
3262 (sb!vm:sanctify-for-execution code-object)
3264 (values dst-start code-object (sap- trap-loc src-start))
3266 (let ((new-lra (make-lisp-obj (+ (sap-int dst-start)
3267 sb!vm:other-pointer-lowtag))))
3270 (logandc2 (+ sb!vm:code-constants-offset bogus-lra-constants 1)
3272 (sb!vm:sanctify-for-execution code-object)
3273 (values new-lra code-object (sap- trap-loc src-start))))))
3277 ;;; This appears here because it cannot go with the DEBUG-FUN
3278 ;;; interface since DO-DEBUG-BLOCK-LOCATIONS isn't defined until after
3279 ;;; the DEBUG-FUN routines.
3281 ;;; Return a code-location before the body of a function and after all
3282 ;;; the arguments are in place; or if that location can't be
3283 ;;; determined due to a lack of debug information, return NIL.
3284 (defun debug-fun-start-location (debug-fun)
3285 (etypecase debug-fun
3287 (code-location-from-pc debug-fun
3288 (sb!c::compiled-debug-fun-start-pc
3289 (compiled-debug-fun-compiler-debug-fun
3292 ;; (There used to be more cases back before sbcl-0.7.0, when
3293 ;; we did special tricks to debug the IR1 interpreter.)
3297 ;;;; Single-stepping
3299 ;;; The single-stepper works by inserting conditional trap instructions
3300 ;;; into the generated code (see src/compiler/*/call.lisp), currently:
3302 ;;; 1) Before the code generated for a function call that was
3303 ;;; translated to a VOP
3304 ;;; 2) Just before the call instruction for a full call
3306 ;;; In both cases, the trap will only be executed if stepping has been
3307 ;;; enabled, in which case it'll ultimately be handled by
3308 ;;; HANDLE-SINGLE-STEP-TRAP, which will either signal a stepping condition,
3309 ;;; or replace the function that's about to be called with a wrapper
3310 ;;; which will signal the condition.
3312 (defun handle-single-step-trap (context-sap kind callee-register-offset)
3313 (let ((context (sb!alien:sap-alien context-sap (* os-context-t))))
3314 ;; The following calls must get tail-call eliminated for
3315 ;; *STEP-FRAME* to get set correctly on non-x86.
3316 (if (= kind single-step-before-trap)
3317 (handle-single-step-before-trap context)
3318 (handle-single-step-around-trap context callee-register-offset))))
3320 (defvar *step-frame* nil)
3322 (defun handle-single-step-before-trap (context)
3323 (let ((step-info (single-step-info-from-context context)))
3324 ;; If there was not enough debug information available, there's no
3325 ;; sense in signaling the condition.
3329 (signal-context-frame (sb!alien::alien-sap context))
3331 ;; KLUDGE: Use the first non-foreign frame as the
3332 ;; *STACK-TOP-HINT*. Getting the frame from the signal
3333 ;; context as on x86 would be cleaner, but
3334 ;; SIGNAL-CONTEXT-FRAME doesn't seem seem to work at all
3336 (loop with frame = (frame-down (top-frame))
3338 for dfun = (frame-debug-fun frame)
3339 do (when (typep dfun 'compiled-debug-fun)
3341 do (setf frame (frame-down frame)))))
3342 (sb!impl::step-form step-info
3343 ;; We could theoretically store information in
3344 ;; the debug-info about to determine the
3345 ;; arguments here, but for now let's just pass
3349 ;;; This function will replace the fdefn / function that was in the
3350 ;;; register at CALLEE-REGISTER-OFFSET with a wrapper function. To
3351 ;;; ensure that the full call will use the wrapper instead of the
3352 ;;; original, conditional trap must be emitted before the fdefn /
3353 ;;; function is converted into a raw address.
3354 (defun handle-single-step-around-trap (context callee-register-offset)
3355 ;; Fetch the function / fdefn we're about to call from the
3356 ;; appropriate register.
3357 (let* ((callee (sb!kernel::make-lisp-obj
3358 (context-register context callee-register-offset)))
3359 (step-info (single-step-info-from-context context)))
3360 ;; If there was not enough debug information available, there's no
3361 ;; sense in signaling the condition.
3363 (return-from handle-single-step-around-trap))
3364 (let* ((fun (lambda (&rest args)
3366 (apply (typecase callee
3367 (fdefn (fdefn-fun callee))
3370 ;; Signal a step condition
3372 (let ((*step-frame* (frame-down (top-frame))))
3373 (sb!impl::step-form step-info args))))
3374 ;; And proceed based on its return value.
3376 ;; STEP-INTO was selected. Use *STEP-OUT* to
3377 ;; let the stepper know that selecting the
3378 ;; STEP-OUT restart is valid inside this
3379 (let ((sb!impl::*step-out* :maybe))
3380 ;; Pass the return values of the call to
3381 ;; STEP-VALUES, which will signal a
3382 ;; condition with them in the VALUES slot.
3384 (multiple-value-call #'sb!impl::step-values
3387 ;; If the user selected the STEP-OUT
3388 ;; restart during the call, resume
3390 (when (eq sb!impl::*step-out* t)
3391 (sb!impl::enable-stepping))))
3392 ;; STEP-NEXT / CONTINUE / OUT selected:
3393 ;; Disable the stepper for the duration of
3395 (sb!impl::with-stepping-disabled
3397 (new-callee (etypecase callee
3399 (let ((fdefn (make-fdefn (gensym))))
3400 (setf (fdefn-fun fdefn) fun)
3403 ;; And then store the wrapper in the same place.
3404 (setf (context-register context callee-register-offset)
3405 (get-lisp-obj-address new-callee)))))
3407 ;;; Given a signal context, fetch the step-info that's been stored in
3408 ;;; the debug info at the trap point.
3409 (defun single-step-info-from-context (context)
3410 (multiple-value-bind (pc-offset code)
3411 (compute-lra-data-from-pc (context-pc context))
3412 (let* ((debug-fun (debug-fun-from-pc code pc-offset))
3413 (location (code-location-from-pc debug-fun
3418 (fill-in-code-location location)
3419 (code-location-debug-source location)
3420 (compiled-code-location-step-info location))
3424 ;;; Return the frame that triggered a single-step condition. Used to
3425 ;;; provide a *STACK-TOP-HINT*.
3426 (defun find-stepped-frame ()