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 &aux (%unknown-p nil)))
473 (:constructor make-compiled-code-location (pc debug-fun))
475 ;; an index into DEBUG-FUN's component slot
477 ;; a bit-vector indexed by a variable's position in
478 ;; DEBUG-FUN-DEBUG-VARS indicating whether the variable has a
479 ;; valid value at this code-location. (unexported).
480 (%live-set :unparsed :type (or simple-bit-vector (member :unparsed)))
481 ;; (unexported) To see SB!C::LOCATION-KIND, do
482 ;; (SB!KERNEL:TYPE-EXPAND 'SB!C::LOCATION-KIND).
483 (kind :unparsed :type (or (member :unparsed) sb!c::location-kind)))
487 ;;; Return the number of top level forms processed by the compiler
488 ;;; before compiling this source. If this source is uncompiled, this
489 ;;; is zero. This may be zero even if the source is compiled since the
490 ;;; first form in the first file compiled in one compilation, for
491 ;;; example, must have a root number of zero -- the compiler saw no
492 ;;; other top level forms before it.
493 (defun debug-source-root-number (debug-source)
494 (sb!c::debug-source-source-root debug-source))
498 ;;; This is used in FIND-ESCAPED-FRAME and with the bogus components
499 ;;; and LRAs used for :FUN-END breakpoints. When a component's
500 ;;; debug-info slot is :BOGUS-LRA, then the REAL-LRA-SLOT contains the
501 ;;; real component to continue executing, as opposed to the bogus
502 ;;; component which appeared in some frame's LRA location.
503 (defconstant real-lra-slot sb!vm:code-constants-offset)
505 ;;; These are magically converted by the compiler.
506 (defun current-sp () (current-sp))
507 (defun current-fp () (current-fp))
508 (defun stack-ref (s n) (stack-ref s n))
509 (defun %set-stack-ref (s n value) (%set-stack-ref s n value))
510 (defun fun-code-header (fun) (fun-code-header fun))
511 (defun lra-code-header (lra) (lra-code-header lra))
512 (defun make-lisp-obj (value) (make-lisp-obj value))
513 (defun get-lisp-obj-address (thing) (get-lisp-obj-address thing))
514 (defun fun-word-offset (fun) (fun-word-offset fun))
516 #!-sb-fluid (declaim (inline control-stack-pointer-valid-p))
517 (defun control-stack-pointer-valid-p (x)
518 (declare (type system-area-pointer x))
519 (let* (#!-stack-grows-downward-not-upward
521 (descriptor-sap *control-stack-start*))
522 #!+stack-grows-downward-not-upward
524 (descriptor-sap *control-stack-end*)))
525 #!-stack-grows-downward-not-upward
526 (and (sap< x (current-sp))
527 (sap<= control-stack-start x)
528 (zerop (logand (sap-int x) #b11)))
529 #!+stack-grows-downward-not-upward
530 (and (sap>= x (current-sp))
531 (sap> control-stack-end x)
532 (zerop (logand (sap-int x) #b11)))))
534 (sb!alien:define-alien-routine component-ptr-from-pc (system-area-pointer)
535 (pc system-area-pointer))
537 (defun component-from-component-ptr (component-ptr)
538 (declare (type system-area-pointer component-ptr))
539 (make-lisp-obj (logior (sap-int component-ptr)
540 sb!vm:other-pointer-lowtag)))
542 ;;;; (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)))))
560 (defconstant sb!vm::nargs-offset #.sb!vm::ecx-offset)
562 ;;; Check for a valid return address - it could be any valid C/Lisp
565 ;;; XXX Could be a little smarter.
566 #!-sb-fluid (declaim (inline ra-pointer-valid-p))
567 (defun ra-pointer-valid-p (ra)
568 (declare (type system-area-pointer ra))
570 ;; not the first page (which is unmapped)
572 ;; FIXME: Where is this documented? Is it really true of every CPU
573 ;; architecture? Is it even necessarily true in current SBCL?
574 (>= (sap-int ra) 4096)
575 ;; not a Lisp stack pointer
576 (not (control-stack-pointer-valid-p ra))))
578 ;;; Try to find a valid previous stack. This is complex on the x86 as
579 ;;; it can jump between C and Lisp frames. To help find a valid frame
580 ;;; it searches backwards.
582 ;;; XXX Should probably check whether it has reached the bottom of the
585 ;;; XXX Should handle interrupted frames, both Lisp and C. At present
586 ;;; it manages to find a fp trail, see linux hack below.
587 (defun x86-call-context (fp &key (depth 0))
588 (declare (type system-area-pointer fp)
590 ;; (format t "*CC ~S ~S~%" fp depth)
592 ((not (control-stack-pointer-valid-p fp))
593 #+nil (format t "debug invalid fp ~S~%" fp)
596 ;; Check the two possible frame pointers.
597 (let ((lisp-ocfp (sap-ref-sap fp (- (* (1+ ocfp-save-offset)
598 sb!vm::n-word-bytes))))
599 (lisp-ra (sap-ref-sap fp (- (* (1+ return-pc-save-offset)
600 sb!vm::n-word-bytes))))
601 (c-ocfp (sap-ref-sap fp (* 0 sb!vm:n-word-bytes)))
602 (c-ra (sap-ref-sap fp (* 1 sb!vm:n-word-bytes))))
603 #+nil (format t " lisp-ocfp=~S~% lisp-ra=~S~% c-ocfp=~S~% c-ra=~S~%"
604 lisp-ocfp lisp-ra c-ocfp c-ra)
605 (cond ((and (sap> lisp-ocfp fp) (control-stack-pointer-valid-p lisp-ocfp)
606 (ra-pointer-valid-p lisp-ra)
607 (sap> c-ocfp fp) (control-stack-pointer-valid-p c-ocfp)
608 (ra-pointer-valid-p c-ra))
610 "*C Both valid ~S ~S ~S ~S~%"
611 lisp-ocfp lisp-ra c-ocfp c-ra)
612 ;; Look forward another step to check their validity.
613 (let ((lisp-path-fp (x86-call-context lisp-ocfp
615 (c-path-fp (x86-call-context c-ocfp :depth (1+ depth))))
616 (cond ((and lisp-path-fp c-path-fp)
617 ;; Both still seem valid - choose the lisp frame.
618 #+nil (when (zerop depth)
620 "debug: both still valid ~S ~S ~S ~S~%"
621 lisp-ocfp lisp-ra c-ocfp c-ra))
623 (if (sap> lisp-ocfp c-ocfp)
624 (values lisp-ra lisp-ocfp)
625 (values c-ra c-ocfp))
627 (values lisp-ra lisp-ocfp))
629 ;; The lisp convention is looking good.
630 #+nil (format t "*C lisp-ocfp ~S ~S~%" lisp-ocfp lisp-ra)
631 (values lisp-ra lisp-ocfp))
633 ;; The C convention is looking good.
634 #+nil (format t "*C c-ocfp ~S ~S~%" c-ocfp c-ra)
635 (values c-ra c-ocfp))
637 ;; Neither seems right?
638 #+nil (format t "debug: no valid2 fp found ~S ~S~%"
641 ((and (sap> lisp-ocfp fp) (control-stack-pointer-valid-p lisp-ocfp)
642 (ra-pointer-valid-p lisp-ra))
643 ;; The lisp convention is looking good.
644 #+nil (format t "*C lisp-ocfp ~S ~S~%" lisp-ocfp lisp-ra)
645 (values lisp-ra lisp-ocfp))
646 ((and (sap> c-ocfp fp) (control-stack-pointer-valid-p c-ocfp)
647 #!-linux (ra-pointer-valid-p c-ra))
648 ;; The C convention is looking good.
649 #+nil (format t "*C c-ocfp ~S ~S~%" c-ocfp c-ra)
650 (values c-ra c-ocfp))
652 #+nil (format t "debug: no valid fp found ~S ~S~%"
658 ;;; Convert the descriptor into a SAP. The bits all stay the same, we just
659 ;;; change our notion of what we think they are.
660 #!-sb-fluid (declaim (inline descriptor-sap))
661 (defun descriptor-sap (x)
662 (int-sap (get-lisp-obj-address x)))
664 ;;; Return the top frame of the control stack as it was before calling
667 (/noshow0 "entering TOP-FRAME")
668 (multiple-value-bind (fp pc) (%caller-frame-and-pc)
669 (compute-calling-frame (descriptor-sap fp) pc nil)))
671 ;;; Flush all of the frames above FRAME, and renumber all the frames
673 (defun flush-frames-above (frame)
674 (setf (frame-up frame) nil)
675 (do ((number 0 (1+ number))
676 (frame frame (frame-%down frame)))
677 ((not (frame-p frame)))
678 (setf (frame-number frame) number)))
680 ;;; Return the frame immediately below FRAME on the stack; or when
681 ;;; FRAME is the bottom of the stack, return NIL.
682 (defun frame-down (frame)
683 (/noshow0 "entering FRAME-DOWN")
684 ;; We have to access the old-fp and return-pc out of frame and pass
685 ;; them to COMPUTE-CALLING-FRAME.
686 (let ((down (frame-%down frame)))
687 (if (eq down :unparsed)
688 (let ((debug-fun (frame-debug-fun frame)))
689 (/noshow0 "in DOWN :UNPARSED case")
690 (setf (frame-%down frame)
693 (let ((c-d-f (compiled-debug-fun-compiler-debug-fun
695 (compute-calling-frame
698 frame ocfp-save-offset
699 (sb!c::compiled-debug-fun-old-fp c-d-f)))
701 frame lra-save-offset
702 (sb!c::compiled-debug-fun-return-pc c-d-f))
705 (let ((fp (frame-pointer frame)))
706 (when (control-stack-pointer-valid-p fp)
708 (multiple-value-bind (ra ofp) (x86-call-context fp)
709 (and ra (compute-calling-frame ofp ra frame)))
711 (compute-calling-frame
713 (sap-ref-sap fp (* ocfp-save-offset
717 (sap-ref-32 fp (* ocfp-save-offset
718 sb!vm:n-word-bytes)))
720 (stack-ref fp lra-save-offset)
725 ;;; Get the old FP or return PC out of FRAME. STACK-SLOT is the
726 ;;; standard save location offset on the stack. LOC is the saved
727 ;;; SC-OFFSET describing the main location.
728 (defun get-context-value (frame stack-slot loc)
729 (declare (type compiled-frame frame) (type unsigned-byte stack-slot)
730 (type sb!c:sc-offset loc))
731 (let ((pointer (frame-pointer frame))
732 (escaped (compiled-frame-escaped frame)))
734 (sub-access-debug-var-slot pointer loc escaped)
736 (stack-ref pointer stack-slot)
740 (stack-ref pointer stack-slot))
742 (sap-ref-sap pointer (- (* (1+ stack-slot)
743 sb!vm::n-word-bytes))))))))
745 (defun (setf get-context-value) (value frame stack-slot loc)
746 (declare (type compiled-frame frame) (type unsigned-byte stack-slot)
747 (type sb!c:sc-offset loc))
748 (let ((pointer (frame-pointer frame))
749 (escaped (compiled-frame-escaped frame)))
751 (sub-set-debug-var-slot pointer loc value escaped)
753 (setf (stack-ref pointer stack-slot) value)
757 (setf (stack-ref pointer stack-slot) value))
759 (setf (sap-ref-sap pointer (- (* (1+ stack-slot)
760 sb!vm::n-word-bytes))) value))))))
762 (defun foreign-function-backtrace-name (sap)
763 (let ((name (sap-foreign-symbol sap)))
765 (format nil "foreign function: ~A" name)
766 (format nil "foreign function: #x~X" (sap-int sap)))))
768 ;;; This returns a frame for the one existing in time immediately
769 ;;; prior to the frame referenced by current-fp. This is current-fp's
770 ;;; caller or the next frame down the control stack. If there is no
771 ;;; down frame, this returns NIL for the bottom of the stack. UP-FRAME
772 ;;; is the up link for the resulting frame object, and it is null when
773 ;;; we call this to get the top of the stack.
775 ;;; The current frame contains the pointer to the temporally previous
776 ;;; frame we want, and the current frame contains the pc at which we
777 ;;; will continue executing upon returning to that previous frame.
779 ;;; Note: Sometimes LRA is actually a fixnum. This happens when lisp
780 ;;; calls into C. In this case, the code object is stored on the stack
781 ;;; after the LRA, and the LRA is the word offset.
783 (defun compute-calling-frame (caller lra up-frame)
784 (declare (type system-area-pointer caller))
785 (when (control-stack-pointer-valid-p caller)
786 (multiple-value-bind (code pc-offset escaped)
788 (multiple-value-bind (word-offset code)
790 (let ((fp (frame-pointer up-frame)))
792 (stack-ref fp (1+ lra-save-offset))))
793 (values (get-header-data lra)
794 (lra-code-header lra)))
797 (* (1+ (- word-offset (get-header-data code)))
800 (values :foreign-function
803 (find-escaped-frame caller))
804 (if (and (code-component-p code)
805 (eq (%code-debug-info code) :bogus-lra))
806 (let ((real-lra (code-header-ref code real-lra-slot)))
807 (compute-calling-frame caller real-lra up-frame))
808 (let ((d-fun (case code
810 (make-bogus-debug-fun
811 "undefined function"))
813 (make-bogus-debug-fun
814 (foreign-function-backtrace-name
815 (int-sap (get-lisp-obj-address lra)))))
817 (make-bogus-debug-fun
818 "bogus stack frame"))
820 (debug-fun-from-pc code pc-offset)))))
821 (make-compiled-frame caller up-frame d-fun
822 (code-location-from-pc d-fun pc-offset
824 (if up-frame (1+ (frame-number up-frame)) 0)
827 (defun compute-calling-frame (caller ra up-frame)
828 (declare (type system-area-pointer caller ra))
829 (/noshow0 "entering COMPUTE-CALLING-FRAME")
830 (when (control-stack-pointer-valid-p caller)
832 ;; First check for an escaped frame.
833 (multiple-value-bind (code pc-offset escaped) (find-escaped-frame caller)
836 ;; If it's escaped it may be a function end breakpoint trap.
837 (when (and (code-component-p code)
838 (eq (%code-debug-info code) :bogus-lra))
839 ;; If :bogus-lra grab the real lra.
840 (setq pc-offset (code-header-ref
841 code (1+ real-lra-slot)))
842 (setq code (code-header-ref code real-lra-slot))
845 (multiple-value-setq (pc-offset code)
846 (compute-lra-data-from-pc ra))
848 (setf code :foreign-function
850 (let ((d-fun (case code
852 (make-bogus-debug-fun
853 "undefined function"))
855 (make-bogus-debug-fun
856 (foreign-function-backtrace-name ra)))
858 (make-bogus-debug-fun
859 "bogus stack frame"))
861 (debug-fun-from-pc code pc-offset)))))
862 (/noshow0 "returning MAKE-COMPILED-FRAME from COMPUTE-CALLING-FRAME")
863 (make-compiled-frame caller up-frame d-fun
864 (code-location-from-pc d-fun pc-offset
866 (if up-frame (1+ (frame-number up-frame)) 0)
869 (defun nth-interrupt-context (n)
870 (declare (type (unsigned-byte 32) n)
871 (optimize (speed 3) (safety 0)))
872 (sb!alien:sap-alien (sb!vm::current-thread-offset-sap
873 (+ sb!vm::thread-interrupt-contexts-offset n))
877 (defun find-escaped-frame (frame-pointer)
878 (declare (type system-area-pointer frame-pointer))
879 (/noshow0 "entering FIND-ESCAPED-FRAME")
880 (dotimes (index *free-interrupt-context-index* (values nil 0 nil))
881 (/noshow0 "at head of WITH-ALIEN")
882 (let ((context (nth-interrupt-context index)))
883 (/noshow0 "got CONTEXT")
884 (when (= (sap-int frame-pointer)
885 (sb!vm:context-register context sb!vm::cfp-offset))
887 (/noshow0 "in WITHOUT-GCING")
888 (let* ((component-ptr (component-ptr-from-pc
889 (sb!vm:context-pc context)))
890 (code (unless (sap= component-ptr (int-sap #x0))
891 (component-from-component-ptr component-ptr))))
892 (/noshow0 "got CODE")
894 (return (values code 0 context)))
895 (let* ((code-header-len (* (get-header-data code)
898 (- (sap-int (sb!vm:context-pc context))
899 (- (get-lisp-obj-address code)
900 sb!vm:other-pointer-lowtag)
902 (/noshow "got PC-OFFSET")
903 (unless (<= 0 pc-offset
904 (* (code-header-ref code sb!vm:code-code-size-slot)
906 ;; We were in an assembly routine. Therefore, use the
909 ;; FIXME: Should this be WARN or ERROR or what?
910 (format t "** pc-offset ~S not in code obj ~S?~%"
912 (/noshow0 "returning from FIND-ESCAPED-FRAME")
914 (values code pc-offset context)))))))))
917 (defun find-escaped-frame (frame-pointer)
918 (declare (type system-area-pointer frame-pointer))
919 (dotimes (index *free-interrupt-context-index* (values nil 0 nil))
920 (let ((scp (nth-interrupt-context index)))
921 (when (= (sap-int frame-pointer)
922 (sb!vm:context-register scp sb!vm::cfp-offset))
924 (let ((code (code-object-from-bits
925 (sb!vm:context-register scp sb!vm::code-offset))))
927 (return (values code 0 scp)))
928 (let* ((code-header-len (* (get-header-data code)
931 (- (sap-int (sb!vm:context-pc scp))
932 (- (get-lisp-obj-address code)
933 sb!vm:other-pointer-lowtag)
935 (let ((code-size (* (code-header-ref code
936 sb!vm:code-code-size-slot)
937 sb!vm:n-word-bytes)))
938 (unless (<= 0 pc-offset code-size)
939 ;; We were in an assembly routine.
940 (multiple-value-bind (new-pc-offset computed-return)
941 (find-pc-from-assembly-fun code scp)
942 (setf pc-offset new-pc-offset)
943 (unless (<= 0 pc-offset code-size)
945 "Set PC-OFFSET to zero and continue backtrace."
948 "~@<PC-OFFSET (~D) not in code object. Frame details:~
949 ~2I~:@_PC: #X~X~:@_CODE: ~S~:@_CODE FUN: ~S~:@_LRA: ~
950 #X~X~:@_COMPUTED RETURN: #X~X.~:>"
953 (sap-int (sb!vm:context-pc scp))
955 (%code-entry-points code)
956 (sb!vm:context-register scp sb!vm::lra-offset)
958 ;; We failed to pinpoint where PC is, but set
959 ;; pc-offset to 0 to keep the backtrace from
961 (setf pc-offset 0)))))
963 (if (eq (%code-debug-info code) :bogus-lra)
964 (let ((real-lra (code-header-ref code
966 (values (lra-code-header real-lra)
967 (get-header-data real-lra)
969 (values code pc-offset scp))))))))))
972 (defun find-pc-from-assembly-fun (code scp)
973 "Finds the PC for the return from an assembly routine properly.
974 For some architectures (such as PPC) this will not be the $LRA
976 (let ((return-machine-address (sb!vm::return-machine-address scp))
977 (code-header-len (* (get-header-data code) sb!vm:n-word-bytes)))
978 (values (- return-machine-address
979 (- (get-lisp-obj-address code)
980 sb!vm:other-pointer-lowtag)
982 return-machine-address)))
984 ;;; Find the code object corresponding to the object represented by
985 ;;; bits and return it. We assume bogus functions correspond to the
986 ;;; undefined-function.
988 (defun code-object-from-bits (bits)
989 (declare (type (unsigned-byte 32) bits))
990 (let ((object (make-lisp-obj bits)))
991 (if (functionp object)
992 (or (fun-code-header object)
994 (let ((lowtag (lowtag-of object)))
995 (if (= lowtag sb!vm:other-pointer-lowtag)
996 (let ((widetag (widetag-of object)))
997 (cond ((= widetag sb!vm:code-header-widetag)
999 ((= widetag sb!vm:return-pc-header-widetag)
1000 (lra-code-header object))
1004 ;;;; frame utilities
1006 ;;; This returns a COMPILED-DEBUG-FUN for COMPONENT and PC. We fetch the
1007 ;;; SB!C::DEBUG-INFO and run down its FUN-MAP to get a
1008 ;;; SB!C::COMPILED-DEBUG-FUN from the PC. The result only needs to
1009 ;;; reference the COMPONENT, for function constants, and the
1010 ;;; SB!C::COMPILED-DEBUG-FUN.
1011 (defun debug-fun-from-pc (component pc)
1012 (let ((info (%code-debug-info component)))
1015 ;; FIXME: It seems that most of these (at least on x86) are
1016 ;; actually assembler routines, and could be named by looking
1017 ;; at the sb-fasl:*assembler-routines*.
1018 (make-bogus-debug-fun "no debug information for frame"))
1019 ((eq info :bogus-lra)
1020 (make-bogus-debug-fun "function end breakpoint"))
1022 (let* ((fun-map (sb!c::compiled-debug-info-fun-map info))
1023 (len (length fun-map)))
1024 (declare (type simple-vector fun-map))
1026 (make-compiled-debug-fun (svref fun-map 0) component)
1029 (>= pc (sb!c::compiled-debug-fun-elsewhere-pc
1030 (svref fun-map 0)))))
1031 (declare (type sb!int:index i))
1034 (< pc (if elsewhere-p
1035 (sb!c::compiled-debug-fun-elsewhere-pc
1036 (svref fun-map (1+ i)))
1037 (svref fun-map i))))
1038 (return (make-compiled-debug-fun
1039 (svref fun-map (1- i))
1043 ;;; This returns a code-location for the COMPILED-DEBUG-FUN,
1044 ;;; DEBUG-FUN, and the pc into its code vector. If we stopped at a
1045 ;;; breakpoint, find the CODE-LOCATION for that breakpoint. Otherwise,
1046 ;;; make an :UNSURE code location, so it can be filled in when we
1047 ;;; figure out what is going on.
1048 (defun code-location-from-pc (debug-fun pc escaped)
1049 (or (and (compiled-debug-fun-p debug-fun)
1051 (let ((data (breakpoint-data
1052 (compiled-debug-fun-component debug-fun)
1054 (when (and data (breakpoint-data-breakpoints data))
1055 (let ((what (breakpoint-what
1056 (first (breakpoint-data-breakpoints data)))))
1057 (when (compiled-code-location-p what)
1059 (make-compiled-code-location pc debug-fun)))
1061 ;;; Return an alist mapping catch tags to CODE-LOCATIONs. These are
1062 ;;; CODE-LOCATIONs at which execution would continue with frame as the
1063 ;;; top frame if someone threw to the corresponding tag.
1064 (defun frame-catches (frame)
1065 (let ((catch (descriptor-sap sb!vm:*current-catch-block*))
1066 (reversed-result nil)
1067 (fp (frame-pointer frame)))
1068 (loop until (zerop (sap-int catch))
1069 finally (return (nreverse reversed-result))
1074 (* sb!vm:catch-block-current-cont-slot
1075 sb!vm:n-word-bytes))
1079 (* sb!vm:catch-block-current-cont-slot
1080 sb!vm:n-word-bytes))))
1081 (let* (#!-(or x86 x86-64)
1082 (lra (stack-ref catch sb!vm:catch-block-entry-pc-slot))
1085 catch (* sb!vm:catch-block-entry-pc-slot
1086 sb!vm:n-word-bytes)))
1089 (stack-ref catch sb!vm:catch-block-current-code-slot))
1091 (component (component-from-component-ptr
1092 (component-ptr-from-pc ra)))
1095 (* (- (1+ (get-header-data lra))
1096 (get-header-data component))
1100 (- (get-lisp-obj-address component)
1101 sb!vm:other-pointer-lowtag)
1102 (* (get-header-data component) sb!vm:n-word-bytes))))
1103 (push (cons #!-(or x86 x86-64)
1104 (stack-ref catch sb!vm:catch-block-tag-slot)
1107 (sap-ref-word catch (* sb!vm:catch-block-tag-slot
1108 sb!vm:n-word-bytes)))
1109 (make-compiled-code-location
1110 offset (frame-debug-fun frame)))
1115 (* sb!vm:catch-block-previous-catch-slot
1116 sb!vm:n-word-bytes))
1120 (* sb!vm:catch-block-previous-catch-slot
1121 sb!vm:n-word-bytes)))))))
1123 ;;;; operations on DEBUG-FUNs
1125 ;;; Execute the forms in a context with BLOCK-VAR bound to each
1126 ;;; DEBUG-BLOCK in DEBUG-FUN successively. Result is an optional
1127 ;;; form to execute for return values, and DO-DEBUG-FUN-BLOCKS
1128 ;;; returns nil if there is no result form. This signals a
1129 ;;; NO-DEBUG-BLOCKS condition when the DEBUG-FUN lacks
1130 ;;; DEBUG-BLOCK information.
1131 (defmacro do-debug-fun-blocks ((block-var debug-fun &optional result)
1133 (let ((blocks (gensym))
1135 `(let ((,blocks (debug-fun-debug-blocks ,debug-fun)))
1136 (declare (simple-vector ,blocks))
1137 (dotimes (,i (length ,blocks) ,result)
1138 (let ((,block-var (svref ,blocks ,i)))
1141 ;;; Execute body in a context with VAR bound to each DEBUG-VAR in
1142 ;;; DEBUG-FUN. This returns the value of executing result (defaults to
1143 ;;; nil). This may iterate over only some of DEBUG-FUN's variables or
1144 ;;; none depending on debug policy; for example, possibly the
1145 ;;; compilation only preserved argument information.
1146 (defmacro do-debug-fun-vars ((var debug-fun &optional result) &body body)
1147 (let ((vars (gensym))
1149 `(let ((,vars (debug-fun-debug-vars ,debug-fun)))
1150 (declare (type (or null simple-vector) ,vars))
1152 (dotimes (,i (length ,vars) ,result)
1153 (let ((,var (svref ,vars ,i)))
1157 ;;; Return the object of type FUNCTION associated with the DEBUG-FUN,
1158 ;;; or NIL if the function is unavailable or is non-existent as a user
1159 ;;; callable function object.
1160 (defun debug-fun-fun (debug-fun)
1161 (let ((cached-value (debug-fun-%function debug-fun)))
1162 (if (eq cached-value :unparsed)
1163 (setf (debug-fun-%function debug-fun)
1164 (etypecase debug-fun
1167 (compiled-debug-fun-component debug-fun))
1169 (sb!c::compiled-debug-fun-start-pc
1170 (compiled-debug-fun-compiler-debug-fun debug-fun))))
1171 (do ((entry (%code-entry-points component)
1172 (%simple-fun-next entry)))
1175 (sb!c::compiled-debug-fun-start-pc
1176 (compiled-debug-fun-compiler-debug-fun
1177 (fun-debug-fun entry))))
1179 (bogus-debug-fun nil)))
1182 ;;; Return the name of the function represented by DEBUG-FUN. This may
1183 ;;; be a string or a cons; do not assume it is a symbol.
1184 (defun debug-fun-name (debug-fun)
1185 (declare (type debug-fun debug-fun))
1186 (etypecase debug-fun
1188 (sb!c::compiled-debug-fun-name
1189 (compiled-debug-fun-compiler-debug-fun debug-fun)))
1191 (bogus-debug-fun-%name debug-fun))))
1193 ;;; Return a DEBUG-FUN that represents debug information for FUN.
1194 (defun fun-debug-fun (fun)
1195 (declare (type function fun))
1196 (ecase (widetag-of fun)
1197 (#.sb!vm:closure-header-widetag
1198 (fun-debug-fun (%closure-fun fun)))
1199 (#.sb!vm:funcallable-instance-header-widetag
1200 (fun-debug-fun (funcallable-instance-fun fun)))
1201 (#.sb!vm:simple-fun-header-widetag
1202 (let* ((name (%simple-fun-name fun))
1203 (component (fun-code-header fun))
1206 (and (sb!c::compiled-debug-fun-p x)
1207 (eq (sb!c::compiled-debug-fun-name x) name)
1208 (eq (sb!c::compiled-debug-fun-kind x) nil)))
1209 (sb!c::compiled-debug-info-fun-map
1210 (%code-debug-info component)))))
1212 (make-compiled-debug-fun res component)
1213 ;; KLUDGE: comment from CMU CL:
1214 ;; This used to be the non-interpreted branch, but
1215 ;; William wrote it to return the debug-fun of fun's XEP
1216 ;; instead of fun's debug-fun. The above code does this
1217 ;; more correctly, but it doesn't get or eliminate all
1218 ;; appropriate cases. It mostly works, and probably
1219 ;; works for all named functions anyway.
1221 (debug-fun-from-pc component
1222 (* (- (fun-word-offset fun)
1223 (get-header-data component))
1224 sb!vm:n-word-bytes)))))))
1226 ;;; Return the kind of the function, which is one of :OPTIONAL,
1227 ;;; :EXTERNAL, :TOPLEVEL, :CLEANUP, or NIL.
1228 (defun debug-fun-kind (debug-fun)
1229 ;; FIXME: This "is one of" information should become part of the function
1230 ;; declamation, not just a doc string
1231 (etypecase debug-fun
1233 (sb!c::compiled-debug-fun-kind
1234 (compiled-debug-fun-compiler-debug-fun debug-fun)))
1238 ;;; Is there any variable information for DEBUG-FUN?
1239 (defun debug-var-info-available (debug-fun)
1240 (not (not (debug-fun-debug-vars debug-fun))))
1242 ;;; Return a list of DEBUG-VARs in DEBUG-FUN having the same name
1243 ;;; and package as SYMBOL. If SYMBOL is uninterned, then this returns
1244 ;;; a list of DEBUG-VARs without package names and with the same name
1245 ;;; as symbol. The result of this function is limited to the
1246 ;;; availability of variable information in DEBUG-FUN; for
1247 ;;; example, possibly DEBUG-FUN only knows about its arguments.
1248 (defun debug-fun-symbol-vars (debug-fun symbol)
1249 (let ((vars (ambiguous-debug-vars debug-fun (symbol-name symbol)))
1250 (package (and (symbol-package symbol)
1251 (package-name (symbol-package symbol)))))
1252 (delete-if (if (stringp package)
1254 (let ((p (debug-var-package-name var)))
1255 (or (not (stringp p))
1256 (string/= p package))))
1258 (stringp (debug-var-package-name var))))
1261 ;;; Return a list of DEBUG-VARs in DEBUG-FUN whose names contain
1262 ;;; NAME-PREFIX-STRING as an initial substring. The result of this
1263 ;;; function is limited to the availability of variable information in
1264 ;;; debug-fun; for example, possibly debug-fun only knows
1265 ;;; about its arguments.
1266 (defun ambiguous-debug-vars (debug-fun name-prefix-string)
1267 (declare (simple-string name-prefix-string))
1268 (let ((variables (debug-fun-debug-vars debug-fun)))
1269 (declare (type (or null simple-vector) variables))
1271 (let* ((len (length variables))
1272 (prefix-len (length name-prefix-string))
1273 (pos (find-var name-prefix-string variables len))
1276 ;; Find names from pos to variable's len that contain prefix.
1277 (do ((i pos (1+ i)))
1279 (let* ((var (svref variables i))
1280 (name (debug-var-symbol-name var))
1281 (name-len (length name)))
1282 (declare (simple-string name))
1283 (when (/= (or (string/= name-prefix-string name
1284 :end1 prefix-len :end2 name-len)
1289 (setq res (nreverse res)))
1292 ;;; This returns a position in VARIABLES for one containing NAME as an
1293 ;;; initial substring. END is the length of VARIABLES if supplied.
1294 (defun find-var (name variables &optional end)
1295 (declare (simple-vector variables)
1296 (simple-string name))
1297 (let ((name-len (length name)))
1298 (position name variables
1300 (let* ((y (debug-var-symbol-name y))
1302 (declare (simple-string y))
1303 (and (>= y-len name-len)
1304 (string= x y :end1 name-len :end2 name-len))))
1305 :end (or end (length variables)))))
1307 ;;; Return a list representing the lambda-list for DEBUG-FUN. The
1308 ;;; list has the following structure:
1309 ;;; (required-var1 required-var2
1311 ;;; (:optional var3 suppliedp-var4)
1312 ;;; (:optional var5)
1314 ;;; (:rest var6) (:rest var7)
1316 ;;; (:keyword keyword-symbol var8 suppliedp-var9)
1317 ;;; (:keyword keyword-symbol var10)
1320 ;;; Each VARi is a DEBUG-VAR; however it may be the symbol :DELETED if
1321 ;;; it is unreferenced in DEBUG-FUN. This signals a
1322 ;;; LAMBDA-LIST-UNAVAILABLE condition when there is no argument list
1324 (defun debug-fun-lambda-list (debug-fun)
1325 (etypecase debug-fun
1326 (compiled-debug-fun (compiled-debug-fun-lambda-list debug-fun))
1327 (bogus-debug-fun nil)))
1329 ;;; Note: If this has to compute the lambda list, it caches it in DEBUG-FUN.
1330 (defun compiled-debug-fun-lambda-list (debug-fun)
1331 (let ((lambda-list (debug-fun-%lambda-list debug-fun)))
1332 (cond ((eq lambda-list :unparsed)
1333 (multiple-value-bind (args argsp)
1334 (parse-compiled-debug-fun-lambda-list debug-fun)
1335 (setf (debug-fun-%lambda-list debug-fun) args)
1338 (debug-signal 'lambda-list-unavailable
1339 :debug-fun debug-fun))))
1341 ((bogus-debug-fun-p debug-fun)
1343 ((sb!c::compiled-debug-fun-arguments
1344 (compiled-debug-fun-compiler-debug-fun debug-fun))
1345 ;; If the packed information is there (whether empty or not) as
1346 ;; opposed to being nil, then returned our cached value (nil).
1349 ;; Our cached value is nil, and the packed lambda-list information
1350 ;; is nil, so we don't have anything available.
1351 (debug-signal 'lambda-list-unavailable
1352 :debug-fun debug-fun)))))
1354 ;;; COMPILED-DEBUG-FUN-LAMBDA-LIST calls this when a
1355 ;;; COMPILED-DEBUG-FUN has no lambda list information cached. It
1356 ;;; returns the lambda list as the first value and whether there was
1357 ;;; any argument information as the second value. Therefore,
1358 ;;; (VALUES NIL T) means there were no arguments, but (VALUES NIL NIL)
1359 ;;; means there was no argument information.
1360 (defun parse-compiled-debug-fun-lambda-list (debug-fun)
1361 (let ((args (sb!c::compiled-debug-fun-arguments
1362 (compiled-debug-fun-compiler-debug-fun debug-fun))))
1367 (values (coerce (debug-fun-debug-vars debug-fun) 'list)
1370 (let ((vars (debug-fun-debug-vars debug-fun))
1375 (declare (type (or null simple-vector) vars))
1377 (when (>= i len) (return))
1378 (let ((ele (aref args i)))
1383 ;; Deleted required arg at beginning of args array.
1384 (push :deleted res))
1385 (sb!c::optional-args
1388 ;; SUPPLIED-P var immediately following keyword or
1389 ;; optional. Stick the extra var in the result
1390 ;; element representing the keyword or optional,
1391 ;; which is the previous one.
1393 ;; FIXME: NCONC used for side-effect: the effect is defined,
1394 ;; but this is bad style no matter what.
1396 (list (compiled-debug-fun-lambda-list-var
1397 args (incf i) vars))))
1400 (compiled-debug-fun-lambda-list-var
1401 args (incf i) vars))
1404 ;; Just ignore the fact that the next two args are
1405 ;; the &MORE arg context and count, and act like they
1406 ;; are regular arguments.
1410 (push (list :keyword
1412 (compiled-debug-fun-lambda-list-var
1413 args (incf i) vars))
1416 ;; We saw an optional marker, so the following
1417 ;; non-symbols are indexes indicating optional
1419 (push (list :optional (svref vars ele)) res))
1421 ;; Required arg at beginning of args array.
1422 (push (svref vars ele) res))))
1424 (values (nreverse res) t))))))
1426 ;;; This is used in COMPILED-DEBUG-FUN-LAMBDA-LIST.
1427 (defun compiled-debug-fun-lambda-list-var (args i vars)
1428 (declare (type (simple-array * (*)) args)
1429 (simple-vector vars))
1430 (let ((ele (aref args i)))
1431 (cond ((not (symbolp ele)) (svref vars ele))
1432 ((eq ele 'sb!c::deleted) :deleted)
1433 (t (error "malformed arguments description")))))
1435 (defun compiled-debug-fun-debug-info (debug-fun)
1436 (%code-debug-info (compiled-debug-fun-component debug-fun)))
1438 ;;;; unpacking variable and basic block data
1440 (defvar *parsing-buffer*
1441 (make-array 20 :adjustable t :fill-pointer t))
1442 (defvar *other-parsing-buffer*
1443 (make-array 20 :adjustable t :fill-pointer t))
1444 ;;; PARSE-DEBUG-BLOCKS and PARSE-DEBUG-VARS
1445 ;;; use this to unpack binary encoded information. It returns the
1446 ;;; values returned by the last form in body.
1448 ;;; This binds buffer-var to *parsing-buffer*, makes sure it starts at
1449 ;;; element zero, and makes sure if we unwind, we nil out any set
1450 ;;; elements for GC purposes.
1452 ;;; This also binds other-var to *other-parsing-buffer* when it is
1453 ;;; supplied, making sure it starts at element zero and that we nil
1454 ;;; out any elements if we unwind.
1456 ;;; This defines the local macro RESULT that takes a buffer, copies
1457 ;;; its elements to a resulting simple-vector, nil's out elements, and
1458 ;;; restarts the buffer at element zero. RESULT returns the
1460 (eval-when (:compile-toplevel :execute)
1461 (sb!xc:defmacro with-parsing-buffer ((buffer-var &optional other-var)
1463 (let ((len (gensym))
1466 (let ((,buffer-var *parsing-buffer*)
1467 ,@(if other-var `((,other-var *other-parsing-buffer*))))
1468 (setf (fill-pointer ,buffer-var) 0)
1469 ,@(if other-var `((setf (fill-pointer ,other-var) 0)))
1470 (macrolet ((result (buf)
1471 `(let* ((,',len (length ,buf))
1472 (,',res (make-array ,',len)))
1473 (replace ,',res ,buf :end1 ,',len :end2 ,',len)
1474 (fill ,buf nil :end ,',len)
1475 (setf (fill-pointer ,buf) 0)
1478 (fill *parsing-buffer* nil)
1479 ,@(if other-var `((fill *other-parsing-buffer* nil))))))
1482 ;;; The argument is a debug internals structure. This returns the
1483 ;;; DEBUG-BLOCKs for DEBUG-FUN, regardless of whether we have unpacked
1484 ;;; them yet. It signals a NO-DEBUG-BLOCKS condition if it can't
1485 ;;; return the blocks.
1486 (defun debug-fun-debug-blocks (debug-fun)
1487 (let ((blocks (debug-fun-blocks debug-fun)))
1488 (cond ((eq blocks :unparsed)
1489 (setf (debug-fun-blocks debug-fun)
1490 (parse-debug-blocks debug-fun))
1491 (unless (debug-fun-blocks debug-fun)
1492 (debug-signal 'no-debug-blocks
1493 :debug-fun debug-fun))
1494 (debug-fun-blocks debug-fun))
1497 (debug-signal 'no-debug-blocks
1498 :debug-fun debug-fun)))))
1500 ;;; Return a SIMPLE-VECTOR of DEBUG-BLOCKs or NIL. NIL indicates there
1501 ;;; was no basic block information.
1502 (defun parse-debug-blocks (debug-fun)
1503 (etypecase debug-fun
1505 (parse-compiled-debug-blocks debug-fun))
1507 (debug-signal 'no-debug-blocks :debug-fun debug-fun))))
1509 ;;; This does some of the work of PARSE-DEBUG-BLOCKS.
1510 (defun parse-compiled-debug-blocks (debug-fun)
1511 (let* ((var-count (length (debug-fun-debug-vars debug-fun)))
1512 (compiler-debug-fun (compiled-debug-fun-compiler-debug-fun
1514 (blocks (sb!c::compiled-debug-fun-blocks compiler-debug-fun))
1515 ;; KLUDGE: 8 is a hard-wired constant in the compiler for the
1516 ;; element size of the packed binary representation of the
1518 (live-set-len (ceiling var-count 8))
1519 (tlf-number (sb!c::compiled-debug-fun-tlf-number compiler-debug-fun)))
1521 (return-from parse-compiled-debug-blocks nil))
1522 (macrolet ((aref+ (a i) `(prog1 (aref ,a ,i) (incf ,i))))
1523 (with-parsing-buffer (blocks-buffer locations-buffer)
1525 (len (length blocks))
1528 (when (>= i len) (return))
1529 (let ((succ-and-flags (aref+ blocks i))
1531 (declare (type (unsigned-byte 8) succ-and-flags)
1533 (dotimes (k (ldb sb!c::compiled-debug-block-nsucc-byte
1535 (push (sb!c:read-var-integer blocks i) successors))
1537 (dotimes (k (sb!c:read-var-integer blocks i)
1538 (result locations-buffer))
1539 (let ((kind (svref sb!c::*compiled-code-location-kinds*
1542 (sb!c:read-var-integer blocks i)))
1543 (tlf-offset (or tlf-number
1544 (sb!c:read-var-integer blocks i)))
1545 (form-number (sb!c:read-var-integer blocks i))
1546 (live-set (sb!c:read-packed-bit-vector
1547 live-set-len blocks i)))
1548 (vector-push-extend (make-known-code-location
1549 pc debug-fun tlf-offset
1550 form-number live-set kind)
1552 (setf last-pc pc))))
1553 (block (make-compiled-debug-block
1554 locations successors
1556 sb!c::compiled-debug-block-elsewhere-p
1557 succ-and-flags))))))
1558 (vector-push-extend block blocks-buffer)
1559 (dotimes (k (length locations))
1560 (setf (code-location-%debug-block (svref locations k))
1562 (let ((res (result blocks-buffer)))
1563 (declare (simple-vector res))
1564 (dotimes (i (length res))
1565 (let* ((block (svref res i))
1567 (dolist (ele (debug-block-successors block))
1568 (push (svref res ele) succs))
1569 (setf (debug-block-successors block) succs)))
1572 ;;; The argument is a debug internals structure. This returns NIL if
1573 ;;; there is no variable information. It returns an empty
1574 ;;; simple-vector if there were no locals in the function. Otherwise
1575 ;;; it returns a SIMPLE-VECTOR of DEBUG-VARs.
1576 (defun debug-fun-debug-vars (debug-fun)
1577 (let ((vars (debug-fun-%debug-vars debug-fun)))
1578 (if (eq vars :unparsed)
1579 (setf (debug-fun-%debug-vars debug-fun)
1580 (etypecase debug-fun
1582 (parse-compiled-debug-vars debug-fun))
1583 (bogus-debug-fun nil)))
1586 ;;; VARS is the parsed variables for a minimal debug function. We need
1587 ;;; to assign names of the form ARG-NNN. We must pad with leading
1588 ;;; zeros, since the arguments must be in alphabetical order.
1589 (defun assign-minimal-var-names (vars)
1590 (declare (simple-vector vars))
1591 (let* ((len (length vars))
1592 (width (length (format nil "~W" (1- len)))))
1594 (without-package-locks
1595 (setf (compiled-debug-var-symbol (svref vars i))
1596 (intern (format nil "ARG-~V,'0D" width i)
1597 ;; KLUDGE: It's somewhat nasty to have a bare
1598 ;; package name string here. It would be
1599 ;; nicer to have #.(FIND-PACKAGE "SB!DEBUG")
1600 ;; instead, since then at least it would transform
1601 ;; correctly under package renaming and stuff.
1602 ;; However, genesis can't handle dumped packages..
1605 ;; FIXME: Maybe this could be fixed by moving the
1606 ;; whole debug-int.lisp file to warm init? (after
1607 ;; which dumping a #.(FIND-PACKAGE ..) expression
1608 ;; would work fine) If this is possible, it would
1609 ;; probably be a good thing, since minimizing the
1610 ;; amount of stuff in cold init is basically good.
1611 (or (find-package "SB-DEBUG")
1612 (find-package "SB!DEBUG"))))))))
1614 ;;; Parse the packed representation of DEBUG-VARs from
1615 ;;; DEBUG-FUN's SB!C::COMPILED-DEBUG-FUN, returning a vector
1616 ;;; of DEBUG-VARs, or NIL if there was no information to parse.
1617 (defun parse-compiled-debug-vars (debug-fun)
1618 (let* ((cdebug-fun (compiled-debug-fun-compiler-debug-fun
1620 (packed-vars (sb!c::compiled-debug-fun-vars cdebug-fun))
1621 (args-minimal (eq (sb!c::compiled-debug-fun-arguments cdebug-fun)
1625 (buffer (make-array 0 :fill-pointer 0 :adjustable t)))
1626 ((>= i (length packed-vars))
1627 (let ((result (coerce buffer 'simple-vector)))
1629 (assign-minimal-var-names result))
1631 (flet ((geti () (prog1 (aref packed-vars i) (incf i))))
1632 (let* ((flags (geti))
1633 (minimal (logtest sb!c::compiled-debug-var-minimal-p flags))
1634 (deleted (logtest sb!c::compiled-debug-var-deleted-p flags))
1635 (live (logtest sb!c::compiled-debug-var-environment-live
1637 (save (logtest sb!c::compiled-debug-var-save-loc-p flags))
1638 (symbol (if minimal nil (geti)))
1639 (id (if (logtest sb!c::compiled-debug-var-id-p flags)
1642 (sc-offset (if deleted 0 (geti)))
1643 (save-sc-offset (if save (geti) nil)))
1644 (aver (not (and args-minimal (not minimal))))
1645 (vector-push-extend (make-compiled-debug-var symbol
1654 ;;; If we're sure of whether code-location is known, return T or NIL.
1655 ;;; If we're :UNSURE, then try to fill in the code-location's slots.
1656 ;;; This determines whether there is any debug-block information, and
1657 ;;; if code-location is known.
1659 ;;; ??? IF this conses closures every time it's called, then break off the
1660 ;;; :UNSURE part to get the HANDLER-CASE into another function.
1661 (defun code-location-unknown-p (basic-code-location)
1662 (ecase (code-location-%unknown-p basic-code-location)
1666 (setf (code-location-%unknown-p basic-code-location)
1667 (handler-case (not (fill-in-code-location basic-code-location))
1668 (no-debug-blocks () t))))))
1670 ;;; Return the DEBUG-BLOCK containing code-location if it is available.
1671 ;;; Some debug policies inhibit debug-block information, and if none
1672 ;;; is available, then this signals a NO-DEBUG-BLOCKS condition.
1673 (defun code-location-debug-block (basic-code-location)
1674 (let ((block (code-location-%debug-block basic-code-location)))
1675 (if (eq block :unparsed)
1676 (etypecase basic-code-location
1677 (compiled-code-location
1678 (compute-compiled-code-location-debug-block basic-code-location))
1679 ;; (There used to be more cases back before sbcl-0.7.0, when
1680 ;; we did special tricks to debug the IR1 interpreter.)
1684 ;;; Store and return BASIC-CODE-LOCATION's debug-block. We determines
1685 ;;; the correct one using the code-location's pc. We use
1686 ;;; DEBUG-FUN-DEBUG-BLOCKS to return the cached block information
1687 ;;; or signal a NO-DEBUG-BLOCKS condition. The blocks are sorted by
1688 ;;; their first code-location's pc, in ascending order. Therefore, as
1689 ;;; soon as we find a block that starts with a pc greater than
1690 ;;; basic-code-location's pc, we know the previous block contains the
1691 ;;; pc. If we get to the last block, then the code-location is either
1692 ;;; in the second to last block or the last block, and we have to be
1693 ;;; careful in determining this since the last block could be code at
1694 ;;; the end of the function. We have to check for the last block being
1695 ;;; code first in order to see how to compare the code-location's pc.
1696 (defun compute-compiled-code-location-debug-block (basic-code-location)
1697 (let* ((pc (compiled-code-location-pc basic-code-location))
1698 (debug-fun (code-location-debug-fun
1699 basic-code-location))
1700 (blocks (debug-fun-debug-blocks debug-fun))
1701 (len (length blocks)))
1702 (declare (simple-vector blocks))
1703 (setf (code-location-%debug-block basic-code-location)
1709 (let ((last (svref blocks end)))
1711 ((debug-block-elsewhere-p last)
1713 (sb!c::compiled-debug-fun-elsewhere-pc
1714 (compiled-debug-fun-compiler-debug-fun
1716 (svref blocks (1- end))
1719 (compiled-code-location-pc
1720 (svref (compiled-debug-block-code-locations last)
1722 (svref blocks (1- end)))
1724 (declare (type index i end))
1726 (compiled-code-location-pc
1727 (svref (compiled-debug-block-code-locations
1730 (return (svref blocks (1- i)))))))))
1732 ;;; Return the CODE-LOCATION's DEBUG-SOURCE.
1733 (defun code-location-debug-source (code-location)
1734 (let ((info (compiled-debug-fun-debug-info
1735 (code-location-debug-fun code-location))))
1736 (or (sb!c::debug-info-source info)
1737 (debug-signal 'no-debug-blocks :debug-fun
1738 (code-location-debug-fun code-location)))))
1740 ;;; Returns the number of top level forms before the one containing
1741 ;;; CODE-LOCATION as seen by the compiler in some compilation unit. (A
1742 ;;; compilation unit is not necessarily a single file, see the section
1743 ;;; on debug-sources.)
1744 (defun code-location-toplevel-form-offset (code-location)
1745 (when (code-location-unknown-p code-location)
1746 (error 'unknown-code-location :code-location code-location))
1747 (let ((tlf-offset (code-location-%tlf-offset code-location)))
1748 (cond ((eq tlf-offset :unparsed)
1749 (etypecase code-location
1750 (compiled-code-location
1751 (unless (fill-in-code-location code-location)
1752 ;; This check should be unnecessary. We're missing
1753 ;; debug info the compiler should have dumped.
1754 (bug "unknown code location"))
1755 (code-location-%tlf-offset code-location))
1756 ;; (There used to be more cases back before sbcl-0.7.0,,
1757 ;; when we did special tricks to debug the IR1
1762 ;;; Return the number of the form corresponding to CODE-LOCATION. The
1763 ;;; form number is derived by a walking the subforms of a top level
1764 ;;; form in depth-first order.
1765 (defun code-location-form-number (code-location)
1766 (when (code-location-unknown-p code-location)
1767 (error 'unknown-code-location :code-location code-location))
1768 (let ((form-num (code-location-%form-number code-location)))
1769 (cond ((eq form-num :unparsed)
1770 (etypecase code-location
1771 (compiled-code-location
1772 (unless (fill-in-code-location code-location)
1773 ;; This check should be unnecessary. We're missing
1774 ;; debug info the compiler should have dumped.
1775 (bug "unknown code location"))
1776 (code-location-%form-number code-location))
1777 ;; (There used to be more cases back before sbcl-0.7.0,,
1778 ;; when we did special tricks to debug the IR1
1783 ;;; Return the kind of CODE-LOCATION, one of:
1784 ;;; :INTERPRETED, :UNKNOWN-RETURN, :KNOWN-RETURN, :INTERNAL-ERROR,
1785 ;;; :NON-LOCAL-EXIT, :BLOCK-START, :CALL-SITE, :SINGLE-VALUE-RETURN,
1786 ;;; :NON-LOCAL-ENTRY
1787 (defun code-location-kind (code-location)
1788 (when (code-location-unknown-p code-location)
1789 (error 'unknown-code-location :code-location code-location))
1790 (etypecase code-location
1791 (compiled-code-location
1792 (let ((kind (compiled-code-location-kind code-location)))
1793 (cond ((not (eq kind :unparsed)) kind)
1794 ((not (fill-in-code-location code-location))
1795 ;; This check should be unnecessary. We're missing
1796 ;; debug info the compiler should have dumped.
1797 (bug "unknown code location"))
1799 (compiled-code-location-kind code-location)))))
1800 ;; (There used to be more cases back before sbcl-0.7.0,,
1801 ;; when we did special tricks to debug the IR1
1805 ;;; This returns CODE-LOCATION's live-set if it is available. If
1806 ;;; there is no debug-block information, this returns NIL.
1807 (defun compiled-code-location-live-set (code-location)
1808 (if (code-location-unknown-p code-location)
1810 (let ((live-set (compiled-code-location-%live-set code-location)))
1811 (cond ((eq live-set :unparsed)
1812 (unless (fill-in-code-location code-location)
1813 ;; This check should be unnecessary. We're missing
1814 ;; debug info the compiler should have dumped.
1816 ;; FIXME: This error and comment happen over and over again.
1817 ;; Make them a shared function.
1818 (bug "unknown code location"))
1819 (compiled-code-location-%live-set code-location))
1822 ;;; true if OBJ1 and OBJ2 are the same place in the code
1823 (defun code-location= (obj1 obj2)
1825 (compiled-code-location
1827 (compiled-code-location
1828 (and (eq (code-location-debug-fun obj1)
1829 (code-location-debug-fun obj2))
1830 (sub-compiled-code-location= obj1 obj2)))
1831 ;; (There used to be more cases back before sbcl-0.7.0,,
1832 ;; when we did special tricks to debug the IR1
1835 ;; (There used to be more cases back before sbcl-0.7.0,,
1836 ;; when we did special tricks to debug IR1-interpreted code.)
1838 (defun sub-compiled-code-location= (obj1 obj2)
1839 (= (compiled-code-location-pc obj1)
1840 (compiled-code-location-pc obj2)))
1842 ;;; Fill in CODE-LOCATION's :UNPARSED slots, returning T or NIL
1843 ;;; depending on whether the code-location was known in its
1844 ;;; DEBUG-FUN's debug-block information. This may signal a
1845 ;;; NO-DEBUG-BLOCKS condition due to DEBUG-FUN-DEBUG-BLOCKS, and
1846 ;;; it assumes the %UNKNOWN-P slot is already set or going to be set.
1847 (defun fill-in-code-location (code-location)
1848 (declare (type compiled-code-location code-location))
1849 (let* ((debug-fun (code-location-debug-fun code-location))
1850 (blocks (debug-fun-debug-blocks debug-fun)))
1851 (declare (simple-vector blocks))
1852 (dotimes (i (length blocks) nil)
1853 (let* ((block (svref blocks i))
1854 (locations (compiled-debug-block-code-locations block)))
1855 (declare (simple-vector locations))
1856 (dotimes (j (length locations))
1857 (let ((loc (svref locations j)))
1858 (when (sub-compiled-code-location= code-location loc)
1859 (setf (code-location-%debug-block code-location) block)
1860 (setf (code-location-%tlf-offset code-location)
1861 (code-location-%tlf-offset loc))
1862 (setf (code-location-%form-number code-location)
1863 (code-location-%form-number loc))
1864 (setf (compiled-code-location-%live-set code-location)
1865 (compiled-code-location-%live-set loc))
1866 (setf (compiled-code-location-kind code-location)
1867 (compiled-code-location-kind loc))
1868 (return-from fill-in-code-location t))))))))
1870 ;;;; operations on DEBUG-BLOCKs
1872 ;;; Execute FORMS in a context with CODE-VAR bound to each
1873 ;;; CODE-LOCATION in DEBUG-BLOCK, and return the value of RESULT.
1874 (defmacro do-debug-block-locations ((code-var debug-block &optional result)
1876 (let ((code-locations (gensym))
1878 `(let ((,code-locations (debug-block-code-locations ,debug-block)))
1879 (declare (simple-vector ,code-locations))
1880 (dotimes (,i (length ,code-locations) ,result)
1881 (let ((,code-var (svref ,code-locations ,i)))
1884 ;;; Return the name of the function represented by DEBUG-FUN.
1885 ;;; This may be a string or a cons; do not assume it is a symbol.
1886 (defun debug-block-fun-name (debug-block)
1887 (etypecase debug-block
1888 (compiled-debug-block
1889 (let ((code-locs (compiled-debug-block-code-locations debug-block)))
1890 (declare (simple-vector code-locs))
1891 (if (zerop (length code-locs))
1892 "??? Can't get name of debug-block's function."
1894 (code-location-debug-fun (svref code-locs 0))))))
1895 ;; (There used to be more cases back before sbcl-0.7.0, when we
1896 ;; did special tricks to debug the IR1 interpreter.)
1899 (defun debug-block-code-locations (debug-block)
1900 (etypecase debug-block
1901 (compiled-debug-block
1902 (compiled-debug-block-code-locations debug-block))
1903 ;; (There used to be more cases back before sbcl-0.7.0, when we
1904 ;; did special tricks to debug the IR1 interpreter.)
1907 ;;;; operations on debug variables
1909 (defun debug-var-symbol-name (debug-var)
1910 (symbol-name (debug-var-symbol debug-var)))
1912 ;;; FIXME: Make sure that this isn't called anywhere that it wouldn't
1913 ;;; be acceptable to have NIL returned, or that it's only called on
1914 ;;; DEBUG-VARs whose symbols have non-NIL packages.
1915 (defun debug-var-package-name (debug-var)
1916 (package-name (symbol-package (debug-var-symbol debug-var))))
1918 ;;; Return the value stored for DEBUG-VAR in frame, or if the value is
1919 ;;; not :VALID, then signal an INVALID-VALUE error.
1920 (defun debug-var-valid-value (debug-var frame)
1921 (unless (eq (debug-var-validity debug-var (frame-code-location frame))
1923 (error 'invalid-value :debug-var debug-var :frame frame))
1924 (debug-var-value debug-var frame))
1926 ;;; Returns the value stored for DEBUG-VAR in frame. The value may be
1927 ;;; invalid. This is SETFable.
1928 (defun debug-var-value (debug-var frame)
1929 (aver (typep frame 'compiled-frame))
1930 (let ((res (access-compiled-debug-var-slot debug-var frame)))
1931 (if (indirect-value-cell-p res)
1932 (value-cell-ref res)
1935 ;;; This returns what is stored for the variable represented by
1936 ;;; DEBUG-VAR relative to the FRAME. This may be an indirect value
1937 ;;; cell if the variable is both closed over and set.
1938 (defun access-compiled-debug-var-slot (debug-var frame)
1939 (declare (optimize (speed 1)))
1940 (let ((escaped (compiled-frame-escaped frame)))
1942 (sub-access-debug-var-slot
1943 (frame-pointer frame)
1944 (compiled-debug-var-sc-offset debug-var)
1946 (sub-access-debug-var-slot
1947 (frame-pointer frame)
1948 (or (compiled-debug-var-save-sc-offset debug-var)
1949 (compiled-debug-var-sc-offset debug-var))))))
1951 ;;; a helper function for working with possibly-invalid values:
1952 ;;; Do (MAKE-LISP-OBJ VAL) only if the value looks valid.
1954 ;;; (Such values can arise in registers on machines with conservative
1955 ;;; GC, and might also arise in debug variable locations when
1956 ;;; those variables are invalid.)
1957 (defun make-valid-lisp-obj (val)
1960 (zerop (logand val sb!vm:fixnum-tag-mask))
1961 ;; immediate single float, 64-bit only
1962 #!+#.(cl:if (cl:= sb!vm::n-machine-word-bits 64) '(and) '(or))
1963 (= (logand val #xff) sb!vm:single-float-widetag)
1965 (and (zerop (logandc2 val #x1fffffff)) ; Top bits zero
1966 (= (logand val #xff) sb!vm:character-widetag)) ; char tag
1968 (= val sb!vm:unbound-marker-widetag)
1970 (and (logbitp 0 val)
1971 ;; Check that the pointer is valid. XXX Could do a better
1972 ;; job. FIXME: e.g. by calling out to an is_valid_pointer
1973 ;; routine in the C runtime support code
1974 (or (< sb!vm:read-only-space-start val
1975 (* sb!vm:*read-only-space-free-pointer*
1976 sb!vm:n-word-bytes))
1977 (< sb!vm:static-space-start val
1978 (* sb!vm:*static-space-free-pointer*
1979 sb!vm:n-word-bytes))
1980 (< (current-dynamic-space-start) val
1981 (sap-int (dynamic-space-free-pointer))))))
1986 (defun sub-access-debug-var-slot (fp sc-offset &optional escaped)
1987 (macrolet ((with-escaped-value ((var) &body forms)
1989 (let ((,var (sb!vm:context-register
1991 (sb!c:sc-offset-offset sc-offset))))
1993 :invalid-value-for-unescaped-register-storage))
1994 (escaped-float-value (format)
1996 (sb!vm:context-float-register
1998 (sb!c:sc-offset-offset sc-offset)
2000 :invalid-value-for-unescaped-register-storage))
2001 (with-nfp ((var) &body body)
2002 `(let ((,var (if escaped
2004 (sb!vm:context-register escaped
2007 (sb!sys:sap-ref-sap fp (* nfp-save-offset
2008 sb!vm:n-word-bytes))
2010 (sb!vm::make-number-stack-pointer
2011 (sb!sys:sap-ref-32 fp (* nfp-save-offset
2012 sb!vm:n-word-bytes))))))
2014 (ecase (sb!c:sc-offset-scn sc-offset)
2015 ((#.sb!vm:any-reg-sc-number
2016 #.sb!vm:descriptor-reg-sc-number
2017 #!+rt #.sb!vm:word-pointer-reg-sc-number)
2018 (sb!sys:without-gcing
2019 (with-escaped-value (val) (sb!kernel:make-lisp-obj val))))
2021 (#.sb!vm:character-reg-sc-number
2022 (with-escaped-value (val)
2024 (#.sb!vm:sap-reg-sc-number
2025 (with-escaped-value (val)
2026 (sb!sys:int-sap val)))
2027 (#.sb!vm:signed-reg-sc-number
2028 (with-escaped-value (val)
2029 (if (logbitp (1- sb!vm:n-word-bits) val)
2030 (logior val (ash -1 sb!vm:n-word-bits))
2032 (#.sb!vm:unsigned-reg-sc-number
2033 (with-escaped-value (val)
2035 (#.sb!vm:non-descriptor-reg-sc-number
2036 (error "Local non-descriptor register access?"))
2037 (#.sb!vm:interior-reg-sc-number
2038 (error "Local interior register access?"))
2039 (#.sb!vm:single-reg-sc-number
2040 (escaped-float-value single-float))
2041 (#.sb!vm:double-reg-sc-number
2042 (escaped-float-value double-float))
2044 (#.sb!vm:long-reg-sc-number
2045 (escaped-float-value long-float))
2046 (#.sb!vm:complex-single-reg-sc-number
2049 (sb!vm:context-float-register
2050 escaped (sb!c:sc-offset-offset sc-offset) 'single-float)
2051 (sb!vm:context-float-register
2052 escaped (1+ (sb!c:sc-offset-offset sc-offset)) 'single-float))
2053 :invalid-value-for-unescaped-register-storage))
2054 (#.sb!vm:complex-double-reg-sc-number
2057 (sb!vm:context-float-register
2058 escaped (sb!c:sc-offset-offset sc-offset) 'double-float)
2059 (sb!vm:context-float-register
2060 escaped (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 2 #!-sparc 1)
2062 :invalid-value-for-unescaped-register-storage))
2064 (#.sb!vm:complex-long-reg-sc-number
2067 (sb!vm:context-float-register
2068 escaped (sb!c:sc-offset-offset sc-offset) 'long-float)
2069 (sb!vm:context-float-register
2070 escaped (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 4)
2072 :invalid-value-for-unescaped-register-storage))
2073 (#.sb!vm:single-stack-sc-number
2075 (sb!sys:sap-ref-single nfp (* (sb!c:sc-offset-offset sc-offset)
2076 sb!vm:n-word-bytes))))
2077 (#.sb!vm:double-stack-sc-number
2079 (sb!sys:sap-ref-double nfp (* (sb!c:sc-offset-offset sc-offset)
2080 sb!vm:n-word-bytes))))
2082 (#.sb!vm:long-stack-sc-number
2084 (sb!sys:sap-ref-long nfp (* (sb!c:sc-offset-offset sc-offset)
2085 sb!vm:n-word-bytes))))
2086 (#.sb!vm:complex-single-stack-sc-number
2089 (sb!sys:sap-ref-single nfp (* (sb!c:sc-offset-offset sc-offset)
2090 sb!vm:n-word-bytes))
2091 (sb!sys:sap-ref-single nfp (* (1+ (sb!c:sc-offset-offset sc-offset))
2092 sb!vm:n-word-bytes)))))
2093 (#.sb!vm:complex-double-stack-sc-number
2096 (sb!sys:sap-ref-double nfp (* (sb!c:sc-offset-offset sc-offset)
2097 sb!vm:n-word-bytes))
2098 (sb!sys:sap-ref-double nfp (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2099 sb!vm:n-word-bytes)))))
2101 (#.sb!vm:complex-long-stack-sc-number
2104 (sb!sys:sap-ref-long nfp (* (sb!c:sc-offset-offset sc-offset)
2105 sb!vm:n-word-bytes))
2106 (sb!sys:sap-ref-long nfp (* (+ (sb!c:sc-offset-offset sc-offset)
2108 sb!vm:n-word-bytes)))))
2109 (#.sb!vm:control-stack-sc-number
2110 (sb!kernel:stack-ref fp (sb!c:sc-offset-offset sc-offset)))
2111 (#.sb!vm:character-stack-sc-number
2113 (code-char (sb!sys:sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2114 sb!vm:n-word-bytes)))))
2115 (#.sb!vm:unsigned-stack-sc-number
2117 (sb!sys:sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2118 sb!vm:n-word-bytes))))
2119 (#.sb!vm:signed-stack-sc-number
2121 (sb!sys:signed-sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2122 sb!vm:n-word-bytes))))
2123 (#.sb!vm:sap-stack-sc-number
2125 (sb!sys:sap-ref-sap nfp (* (sb!c:sc-offset-offset sc-offset)
2126 sb!vm:n-word-bytes)))))))
2129 (defun sub-access-debug-var-slot (fp sc-offset &optional escaped)
2130 (declare (type system-area-pointer fp))
2131 (macrolet ((with-escaped-value ((var) &body forms)
2133 (let ((,var (sb!vm:context-register
2135 (sb!c:sc-offset-offset sc-offset))))
2137 :invalid-value-for-unescaped-register-storage))
2138 (escaped-float-value (format)
2140 (sb!vm:context-float-register
2141 escaped (sb!c:sc-offset-offset sc-offset) ',format)
2142 :invalid-value-for-unescaped-register-storage))
2143 (escaped-complex-float-value (format)
2146 (sb!vm:context-float-register
2147 escaped (sb!c:sc-offset-offset sc-offset) ',format)
2148 (sb!vm:context-float-register
2149 escaped (1+ (sb!c:sc-offset-offset sc-offset)) ',format))
2150 :invalid-value-for-unescaped-register-storage)))
2151 (ecase (sb!c:sc-offset-scn sc-offset)
2152 ((#.sb!vm:any-reg-sc-number #.sb!vm:descriptor-reg-sc-number)
2154 (with-escaped-value (val)
2155 (make-valid-lisp-obj val))))
2156 (#.sb!vm:character-reg-sc-number
2157 (with-escaped-value (val)
2159 (#.sb!vm:sap-reg-sc-number
2160 (with-escaped-value (val)
2162 (#.sb!vm:signed-reg-sc-number
2163 (with-escaped-value (val)
2164 (if (logbitp (1- sb!vm:n-word-bits) val)
2165 (logior val (ash -1 sb!vm:n-word-bits))
2167 (#.sb!vm:unsigned-reg-sc-number
2168 (with-escaped-value (val)
2170 (#.sb!vm:single-reg-sc-number
2171 (escaped-float-value single-float))
2172 (#.sb!vm:double-reg-sc-number
2173 (escaped-float-value double-float))
2175 (#.sb!vm:long-reg-sc-number
2176 (escaped-float-value long-float))
2177 (#.sb!vm:complex-single-reg-sc-number
2178 (escaped-complex-float-value single-float))
2179 (#.sb!vm:complex-double-reg-sc-number
2180 (escaped-complex-float-value double-float))
2182 (#.sb!vm:complex-long-reg-sc-number
2183 (escaped-complex-float-value long-float))
2184 (#.sb!vm:single-stack-sc-number
2185 (sap-ref-single fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2186 sb!vm:n-word-bytes))))
2187 (#.sb!vm:double-stack-sc-number
2188 (sap-ref-double fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2189 sb!vm:n-word-bytes))))
2191 (#.sb!vm:long-stack-sc-number
2192 (sap-ref-long fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2193 sb!vm:n-word-bytes))))
2194 (#.sb!vm:complex-single-stack-sc-number
2196 (sap-ref-single fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2197 sb!vm:n-word-bytes)))
2198 (sap-ref-single fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2199 sb!vm:n-word-bytes)))))
2200 (#.sb!vm:complex-double-stack-sc-number
2202 (sap-ref-double fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2203 sb!vm:n-word-bytes)))
2204 (sap-ref-double fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 4)
2205 sb!vm:n-word-bytes)))))
2207 (#.sb!vm:complex-long-stack-sc-number
2209 (sap-ref-long fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2210 sb!vm:n-word-bytes)))
2211 (sap-ref-long fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 6)
2212 sb!vm:n-word-bytes)))))
2213 (#.sb!vm:control-stack-sc-number
2214 (stack-ref fp (sb!c:sc-offset-offset sc-offset)))
2215 (#.sb!vm:character-stack-sc-number
2217 (sap-ref-word fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2218 sb!vm:n-word-bytes)))))
2219 (#.sb!vm:unsigned-stack-sc-number
2220 (sap-ref-word fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2221 sb!vm:n-word-bytes))))
2222 (#.sb!vm:signed-stack-sc-number
2223 (signed-sap-ref-word fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2224 sb!vm:n-word-bytes))))
2225 (#.sb!vm:sap-stack-sc-number
2226 (sap-ref-sap fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2227 sb!vm:n-word-bytes)))))))
2229 ;;; This stores value as the value of DEBUG-VAR in FRAME. In the
2230 ;;; COMPILED-DEBUG-VAR case, access the current value to determine if
2231 ;;; it is an indirect value cell. This occurs when the variable is
2232 ;;; both closed over and set.
2233 (defun %set-debug-var-value (debug-var frame new-value)
2234 (aver (typep frame 'compiled-frame))
2235 (let ((old-value (access-compiled-debug-var-slot debug-var frame)))
2236 (if (indirect-value-cell-p old-value)
2237 (value-cell-set old-value new-value)
2238 (set-compiled-debug-var-slot debug-var frame new-value)))
2241 ;;; This stores VALUE for the variable represented by debug-var
2242 ;;; relative to the frame. This assumes the location directly contains
2243 ;;; the variable's value; that is, there is no indirect value cell
2244 ;;; currently there in case the variable is both closed over and set.
2245 (defun set-compiled-debug-var-slot (debug-var frame value)
2246 (let ((escaped (compiled-frame-escaped frame)))
2248 (sub-set-debug-var-slot (frame-pointer frame)
2249 (compiled-debug-var-sc-offset debug-var)
2251 (sub-set-debug-var-slot
2252 (frame-pointer frame)
2253 (or (compiled-debug-var-save-sc-offset debug-var)
2254 (compiled-debug-var-sc-offset debug-var))
2258 (defun sub-set-debug-var-slot (fp sc-offset value &optional escaped)
2259 (macrolet ((set-escaped-value (val)
2261 (setf (sb!vm:context-register
2263 (sb!c:sc-offset-offset sc-offset))
2266 (set-escaped-float-value (format val)
2268 (setf (sb!vm:context-float-register
2270 (sb!c:sc-offset-offset sc-offset)
2274 (with-nfp ((var) &body body)
2275 `(let ((,var (if escaped
2277 (sb!vm:context-register escaped
2282 sb!vm:n-word-bytes))
2284 (sb!vm::make-number-stack-pointer
2287 sb!vm:n-word-bytes))))))
2289 (ecase (sb!c:sc-offset-scn sc-offset)
2290 ((#.sb!vm:any-reg-sc-number
2291 #.sb!vm:descriptor-reg-sc-number
2292 #!+rt #.sb!vm:word-pointer-reg-sc-number)
2295 (get-lisp-obj-address value))))
2296 (#.sb!vm:character-reg-sc-number
2297 (set-escaped-value (char-code value)))
2298 (#.sb!vm:sap-reg-sc-number
2299 (set-escaped-value (sap-int value)))
2300 (#.sb!vm:signed-reg-sc-number
2301 (set-escaped-value (logand value (1- (ash 1 sb!vm:n-word-bits)))))
2302 (#.sb!vm:unsigned-reg-sc-number
2303 (set-escaped-value value))
2304 (#.sb!vm:non-descriptor-reg-sc-number
2305 (error "Local non-descriptor register access?"))
2306 (#.sb!vm:interior-reg-sc-number
2307 (error "Local interior register access?"))
2308 (#.sb!vm:single-reg-sc-number
2309 (set-escaped-float-value single-float value))
2310 (#.sb!vm:double-reg-sc-number
2311 (set-escaped-float-value double-float value))
2313 (#.sb!vm:long-reg-sc-number
2314 (set-escaped-float-value long-float value))
2315 (#.sb!vm:complex-single-reg-sc-number
2317 (setf (sb!vm:context-float-register escaped
2318 (sb!c:sc-offset-offset sc-offset)
2321 (setf (sb!vm:context-float-register
2322 escaped (1+ (sb!c:sc-offset-offset sc-offset))
2326 (#.sb!vm:complex-double-reg-sc-number
2328 (setf (sb!vm:context-float-register
2329 escaped (sb!c:sc-offset-offset sc-offset) 'double-float)
2331 (setf (sb!vm:context-float-register
2333 (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 2 #!-sparc 1)
2338 (#.sb!vm:complex-long-reg-sc-number
2340 (setf (sb!vm:context-float-register
2341 escaped (sb!c:sc-offset-offset sc-offset) 'long-float)
2343 (setf (sb!vm:context-float-register
2345 (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 4)
2349 (#.sb!vm:single-stack-sc-number
2351 (setf (sap-ref-single nfp (* (sb!c:sc-offset-offset sc-offset)
2352 sb!vm:n-word-bytes))
2353 (the single-float value))))
2354 (#.sb!vm:double-stack-sc-number
2356 (setf (sap-ref-double nfp (* (sb!c:sc-offset-offset sc-offset)
2357 sb!vm:n-word-bytes))
2358 (the double-float value))))
2360 (#.sb!vm:long-stack-sc-number
2362 (setf (sap-ref-long nfp (* (sb!c:sc-offset-offset sc-offset)
2363 sb!vm:n-word-bytes))
2364 (the long-float value))))
2365 (#.sb!vm:complex-single-stack-sc-number
2367 (setf (sap-ref-single
2368 nfp (* (sb!c:sc-offset-offset sc-offset) sb!vm:n-word-bytes))
2369 (the single-float (realpart value)))
2370 (setf (sap-ref-single
2371 nfp (* (1+ (sb!c:sc-offset-offset sc-offset))
2372 sb!vm:n-word-bytes))
2373 (the single-float (realpart value)))))
2374 (#.sb!vm:complex-double-stack-sc-number
2376 (setf (sap-ref-double
2377 nfp (* (sb!c:sc-offset-offset sc-offset) sb!vm:n-word-bytes))
2378 (the double-float (realpart value)))
2379 (setf (sap-ref-double
2380 nfp (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2381 sb!vm:n-word-bytes))
2382 (the double-float (realpart value)))))
2384 (#.sb!vm:complex-long-stack-sc-number
2387 nfp (* (sb!c:sc-offset-offset sc-offset) sb!vm:n-word-bytes))
2388 (the long-float (realpart value)))
2390 nfp (* (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 4)
2391 sb!vm:n-word-bytes))
2392 (the long-float (realpart value)))))
2393 (#.sb!vm:control-stack-sc-number
2394 (setf (stack-ref fp (sb!c:sc-offset-offset sc-offset)) value))
2395 (#.sb!vm:character-stack-sc-number
2397 (setf (sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2398 sb!vm:n-word-bytes))
2399 (char-code (the character value)))))
2400 (#.sb!vm:unsigned-stack-sc-number
2402 (setf (sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2403 sb!vm:n-word-bytes))
2404 (the (unsigned-byte 32) value))))
2405 (#.sb!vm:signed-stack-sc-number
2407 (setf (signed-sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2408 sb!vm:n-word-bytes))
2409 (the (signed-byte 32) value))))
2410 (#.sb!vm:sap-stack-sc-number
2412 (setf (sap-ref-sap nfp (* (sb!c:sc-offset-offset sc-offset)
2413 sb!vm:n-word-bytes))
2414 (the system-area-pointer value)))))))
2417 (defun sub-set-debug-var-slot (fp sc-offset value &optional escaped)
2418 (macrolet ((set-escaped-value (val)
2420 (setf (sb!vm:context-register
2422 (sb!c:sc-offset-offset sc-offset))
2425 (ecase (sb!c:sc-offset-scn sc-offset)
2426 ((#.sb!vm:any-reg-sc-number #.sb!vm:descriptor-reg-sc-number)
2429 (get-lisp-obj-address value))))
2430 (#.sb!vm:character-reg-sc-number
2431 (set-escaped-value (char-code value)))
2432 (#.sb!vm:sap-reg-sc-number
2433 (set-escaped-value (sap-int value)))
2434 (#.sb!vm:signed-reg-sc-number
2435 (set-escaped-value (logand value (1- (ash 1 sb!vm:n-word-bits)))))
2436 (#.sb!vm:unsigned-reg-sc-number
2437 (set-escaped-value value))
2438 (#.sb!vm:single-reg-sc-number
2439 #+nil ;; don't have escaped floats.
2440 (set-escaped-float-value single-float value))
2441 (#.sb!vm:double-reg-sc-number
2442 #+nil ;; don't have escaped floats -- still in npx?
2443 (set-escaped-float-value double-float value))
2445 (#.sb!vm:long-reg-sc-number
2446 #+nil ;; don't have escaped floats -- still in npx?
2447 (set-escaped-float-value long-float value))
2448 (#.sb!vm:single-stack-sc-number
2449 (setf (sap-ref-single
2450 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2451 sb!vm:n-word-bytes)))
2452 (the single-float value)))
2453 (#.sb!vm:double-stack-sc-number
2454 (setf (sap-ref-double
2455 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2456 sb!vm:n-word-bytes)))
2457 (the double-float value)))
2459 (#.sb!vm:long-stack-sc-number
2461 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2462 sb!vm:n-word-bytes)))
2463 (the long-float value)))
2464 (#.sb!vm:complex-single-stack-sc-number
2465 (setf (sap-ref-single
2466 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2467 sb!vm:n-word-bytes)))
2468 (realpart (the (complex single-float) value)))
2469 (setf (sap-ref-single
2470 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2471 sb!vm:n-word-bytes)))
2472 (imagpart (the (complex single-float) value))))
2473 (#.sb!vm:complex-double-stack-sc-number
2474 (setf (sap-ref-double
2475 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2476 sb!vm:n-word-bytes)))
2477 (realpart (the (complex double-float) value)))
2478 (setf (sap-ref-double
2479 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 4)
2480 sb!vm:n-word-bytes)))
2481 (imagpart (the (complex double-float) value))))
2483 (#.sb!vm:complex-long-stack-sc-number
2485 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2486 sb!vm:n-word-bytes)))
2487 (realpart (the (complex long-float) value)))
2489 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 6)
2490 sb!vm:n-word-bytes)))
2491 (imagpart (the (complex long-float) value))))
2492 (#.sb!vm:control-stack-sc-number
2493 (setf (stack-ref fp (sb!c:sc-offset-offset sc-offset)) value))
2494 (#.sb!vm:character-stack-sc-number
2495 (setf (sap-ref-word fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2496 sb!vm:n-word-bytes)))
2497 (char-code (the character value))))
2498 (#.sb!vm:unsigned-stack-sc-number
2499 (setf (sap-ref-word fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2500 sb!vm:n-word-bytes)))
2501 (the sb!vm:word value)))
2502 (#.sb!vm:signed-stack-sc-number
2503 (setf (signed-sap-ref-word
2504 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2505 sb!vm:n-word-bytes)))
2506 (the (signed-byte #.sb!vm:n-word-bits) value)))
2507 (#.sb!vm:sap-stack-sc-number
2508 (setf (sap-ref-sap fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2509 sb!vm:n-word-bytes)))
2510 (the system-area-pointer value))))))
2512 ;;; The method for setting and accessing COMPILED-DEBUG-VAR values use
2513 ;;; this to determine if the value stored is the actual value or an
2514 ;;; indirection cell.
2515 (defun indirect-value-cell-p (x)
2516 (and (= (lowtag-of x) sb!vm:other-pointer-lowtag)
2517 (= (widetag-of x) sb!vm:value-cell-header-widetag)))
2519 ;;; Return three values reflecting the validity of DEBUG-VAR's value
2520 ;;; at BASIC-CODE-LOCATION:
2521 ;;; :VALID The value is known to be available.
2522 ;;; :INVALID The value is known to be unavailable.
2523 ;;; :UNKNOWN The value's availability is unknown.
2525 ;;; If the variable is always alive, then it is valid. If the
2526 ;;; code-location is unknown, then the variable's validity is
2527 ;;; :unknown. Once we've called CODE-LOCATION-UNKNOWN-P, we know the
2528 ;;; live-set information has been cached in the code-location.
2529 (defun debug-var-validity (debug-var basic-code-location)
2530 (etypecase debug-var
2532 (compiled-debug-var-validity debug-var basic-code-location))
2533 ;; (There used to be more cases back before sbcl-0.7.0, when
2534 ;; we did special tricks to debug the IR1 interpreter.)
2537 ;;; This is the method for DEBUG-VAR-VALIDITY for COMPILED-DEBUG-VARs.
2538 ;;; For safety, make sure basic-code-location is what we think.
2539 (defun compiled-debug-var-validity (debug-var basic-code-location)
2540 (declare (type compiled-code-location basic-code-location))
2541 (cond ((debug-var-alive-p debug-var)
2542 (let ((debug-fun (code-location-debug-fun basic-code-location)))
2543 (if (>= (compiled-code-location-pc basic-code-location)
2544 (sb!c::compiled-debug-fun-start-pc
2545 (compiled-debug-fun-compiler-debug-fun debug-fun)))
2548 ((code-location-unknown-p basic-code-location) :unknown)
2550 (let ((pos (position debug-var
2551 (debug-fun-debug-vars
2552 (code-location-debug-fun
2553 basic-code-location)))))
2555 (error 'unknown-debug-var
2556 :debug-var debug-var
2558 (code-location-debug-fun basic-code-location)))
2559 ;; There must be live-set info since basic-code-location is known.
2560 (if (zerop (sbit (compiled-code-location-live-set
2561 basic-code-location)
2568 ;;; This code produces and uses what we call source-paths. A
2569 ;;; source-path is a list whose first element is a form number as
2570 ;;; returned by CODE-LOCATION-FORM-NUMBER and whose last element is a
2571 ;;; top level form number as returned by
2572 ;;; CODE-LOCATION-TOPLEVEL-FORM-NUMBER. The elements from the last to
2573 ;;; the first, exclusively, are the numbered subforms into which to
2574 ;;; descend. For example:
2576 ;;; (let ((a (aref x 3)))
2578 ;;; The call to AREF in this example is form number 5. Assuming this
2579 ;;; DEFUN is the 11'th top level form, the source-path for the AREF
2580 ;;; call is as follows:
2582 ;;; Given the DEFUN, 3 gets you the LET, 1 gets you the bindings, 0
2583 ;;; gets the first binding, and 1 gets the AREF form.
2585 ;;; temporary buffer used to build form-number => source-path translation in
2586 ;;; FORM-NUMBER-TRANSLATIONS
2587 (defvar *form-number-temp* (make-array 10 :fill-pointer 0 :adjustable t))
2589 ;;; table used to detect CAR circularities in FORM-NUMBER-TRANSLATIONS
2590 (defvar *form-number-circularity-table* (make-hash-table :test 'eq))
2592 ;;; This returns a table mapping form numbers to source-paths. A
2593 ;;; source-path indicates a descent into the TOPLEVEL-FORM form,
2594 ;;; going directly to the subform corressponding to the form number.
2596 ;;; The vector elements are in the same format as the compiler's
2597 ;;; NODE-SOURCE-PATH; that is, the first element is the form number and
2598 ;;; the last is the TOPLEVEL-FORM number.
2599 (defun form-number-translations (form tlf-number)
2600 (clrhash *form-number-circularity-table*)
2601 (setf (fill-pointer *form-number-temp*) 0)
2602 (sub-translate-form-numbers form (list tlf-number))
2603 (coerce *form-number-temp* 'simple-vector))
2604 (defun sub-translate-form-numbers (form path)
2605 (unless (gethash form *form-number-circularity-table*)
2606 (setf (gethash form *form-number-circularity-table*) t)
2607 (vector-push-extend (cons (fill-pointer *form-number-temp*) path)
2612 (declare (fixnum pos))
2615 (when (atom subform) (return))
2616 (let ((fm (car subform)))
2618 (sub-translate-form-numbers fm (cons pos path)))
2620 (setq subform (cdr subform))
2621 (when (eq subform trail) (return)))))
2625 (setq trail (cdr trail)))))))
2627 ;;; FORM is a top level form, and path is a source-path into it. This
2628 ;;; returns the form indicated by the source-path. Context is the
2629 ;;; number of enclosing forms to return instead of directly returning
2630 ;;; the source-path form. When context is non-zero, the form returned
2631 ;;; contains a marker, #:****HERE****, immediately before the form
2632 ;;; indicated by path.
2633 (defun source-path-context (form path context)
2634 (declare (type unsigned-byte context))
2635 ;; Get to the form indicated by path or the enclosing form indicated
2636 ;; by context and path.
2637 (let ((path (reverse (butlast (cdr path)))))
2638 (dotimes (i (- (length path) context))
2639 (let ((index (first path)))
2640 (unless (and (listp form) (< index (length form)))
2641 (error "Source path no longer exists."))
2642 (setq form (elt form index))
2643 (setq path (rest path))))
2644 ;; Recursively rebuild the source form resulting from the above
2645 ;; descent, copying the beginning of each subform up to the next
2646 ;; subform we descend into according to path. At the bottom of the
2647 ;; recursion, we return the form indicated by path preceded by our
2648 ;; marker, and this gets spliced into the resulting list structure
2649 ;; on the way back up.
2650 (labels ((frob (form path level)
2651 (if (or (zerop level) (null path))
2654 `(#:***here*** ,form))
2655 (let ((n (first path)))
2656 (unless (and (listp form) (< n (length form)))
2657 (error "Source path no longer exists."))
2658 (let ((res (frob (elt form n) (rest path) (1- level))))
2659 (nconc (subseq form 0 n)
2660 (cons res (nthcdr (1+ n) form))))))))
2661 (frob form path context))))
2663 ;;;; PREPROCESS-FOR-EVAL
2665 ;;; Return a function of one argument that evaluates form in the
2666 ;;; lexical context of the BASIC-CODE-LOCATION LOC, or signal a
2667 ;;; NO-DEBUG-VARS condition when the LOC's DEBUG-FUN has no
2668 ;;; DEBUG-VAR information available.
2670 ;;; The returned function takes the frame to get values from as its
2671 ;;; argument, and it returns the values of FORM. The returned function
2672 ;;; can signal the following conditions: INVALID-VALUE,
2673 ;;; AMBIGUOUS-VAR-NAME, and FRAME-FUN-MISMATCH.
2674 (defun preprocess-for-eval (form loc)
2675 (declare (type code-location loc))
2676 (let ((n-frame (gensym))
2677 (fun (code-location-debug-fun loc)))
2678 (unless (debug-var-info-available fun)
2679 (debug-signal 'no-debug-vars :debug-fun fun))
2680 (sb!int:collect ((binds)
2682 (do-debug-fun-vars (var fun)
2683 (let ((validity (debug-var-validity var loc)))
2684 (unless (eq validity :invalid)
2685 (let* ((sym (debug-var-symbol var))
2686 (found (assoc sym (binds))))
2688 (setf (second found) :ambiguous)
2689 (binds (list sym validity var)))))))
2690 (dolist (bind (binds))
2691 (let ((name (first bind))
2693 (ecase (second bind)
2695 (specs `(,name (debug-var-value ',var ,n-frame))))
2697 (specs `(,name (debug-signal 'invalid-value
2701 (specs `(,name (debug-signal 'ambiguous-var-name
2703 :frame ,n-frame)))))))
2704 (let ((res (coerce `(lambda (,n-frame)
2705 (declare (ignorable ,n-frame))
2706 (symbol-macrolet ,(specs) ,form))
2709 ;; This prevents these functions from being used in any
2710 ;; location other than a function return location, so maybe
2711 ;; this should only check whether FRAME's DEBUG-FUN is the
2713 (unless (code-location= (frame-code-location frame) loc)
2714 (debug-signal 'frame-fun-mismatch
2715 :code-location loc :form form :frame frame))
2716 (funcall res frame))))))
2720 ;;;; user-visible interface
2722 ;;; Create and return a breakpoint. When program execution encounters
2723 ;;; the breakpoint, the system calls HOOK-FUN. HOOK-FUN takes the
2724 ;;; current frame for the function in which the program is running and
2725 ;;; the breakpoint object.
2727 ;;; WHAT and KIND determine where in a function the system invokes
2728 ;;; HOOK-FUN. WHAT is either a code-location or a DEBUG-FUN. KIND is
2729 ;;; one of :CODE-LOCATION, :FUN-START, or :FUN-END. Since the starts
2730 ;;; and ends of functions may not have code-locations representing
2731 ;;; them, designate these places by supplying WHAT as a DEBUG-FUN and
2732 ;;; KIND indicating the :FUN-START or :FUN-END. When WHAT is a
2733 ;;; DEBUG-FUN and kind is :FUN-END, then HOOK-FUN must take two
2734 ;;; additional arguments, a list of values returned by the function
2735 ;;; and a FUN-END-COOKIE.
2737 ;;; INFO is information supplied by and used by the user.
2739 ;;; FUN-END-COOKIE is a function. To implement :FUN-END
2740 ;;; breakpoints, the system uses starter breakpoints to establish the
2741 ;;; :FUN-END breakpoint for each invocation of the function. Upon
2742 ;;; each entry, the system creates a unique cookie to identify the
2743 ;;; invocation, and when the user supplies a function for this
2744 ;;; argument, the system invokes it on the frame and the cookie. The
2745 ;;; system later invokes the :FUN-END breakpoint hook on the same
2746 ;;; cookie. The user may save the cookie for comparison in the hook
2749 ;;; Signal an error if WHAT is an unknown code-location.
2750 (defun make-breakpoint (hook-fun what
2751 &key (kind :code-location) info fun-end-cookie)
2754 (when (code-location-unknown-p what)
2755 (error "cannot make a breakpoint at an unknown code location: ~S"
2757 (aver (eq kind :code-location))
2758 (let ((bpt (%make-breakpoint hook-fun what kind info)))
2760 (compiled-code-location
2761 ;; This slot is filled in due to calling CODE-LOCATION-UNKNOWN-P.
2762 (when (eq (compiled-code-location-kind what) :unknown-return)
2763 (let ((other-bpt (%make-breakpoint hook-fun what
2764 :unknown-return-partner
2766 (setf (breakpoint-unknown-return-partner bpt) other-bpt)
2767 (setf (breakpoint-unknown-return-partner other-bpt) bpt))))
2768 ;; (There used to be more cases back before sbcl-0.7.0,,
2769 ;; when we did special tricks to debug the IR1
2776 (%make-breakpoint hook-fun what kind info))
2778 (unless (eq (sb!c::compiled-debug-fun-returns
2779 (compiled-debug-fun-compiler-debug-fun what))
2781 (error ":FUN-END breakpoints are currently unsupported ~
2782 for the known return convention."))
2784 (let* ((bpt (%make-breakpoint hook-fun what kind info))
2785 (starter (compiled-debug-fun-end-starter what)))
2787 (setf starter (%make-breakpoint #'list what :fun-start nil))
2788 (setf (breakpoint-hook-fun starter)
2789 (fun-end-starter-hook starter what))
2790 (setf (compiled-debug-fun-end-starter what) starter))
2791 (setf (breakpoint-start-helper bpt) starter)
2792 (push bpt (breakpoint-%info starter))
2793 (setf (breakpoint-cookie-fun bpt) fun-end-cookie)
2796 ;;; These are unique objects created upon entry into a function by a
2797 ;;; :FUN-END breakpoint's starter hook. These are only created
2798 ;;; when users supply :FUN-END-COOKIE to MAKE-BREAKPOINT. Also,
2799 ;;; the :FUN-END breakpoint's hook is called on the same cookie
2800 ;;; when it is created.
2801 (defstruct (fun-end-cookie
2802 (:print-object (lambda (obj str)
2803 (print-unreadable-object (obj str :type t))))
2804 (:constructor make-fun-end-cookie (bogus-lra debug-fun))
2806 ;; a pointer to the bogus-lra created for :FUN-END breakpoints
2808 ;; the DEBUG-FUN associated with this cookie
2811 ;;; This maps bogus-lra-components to cookies, so that
2812 ;;; HANDLE-FUN-END-BREAKPOINT can find the appropriate cookie for the
2813 ;;; breakpoint hook.
2814 (defvar *fun-end-cookies* (make-hash-table :test 'eq))
2816 ;;; This returns a hook function for the start helper breakpoint
2817 ;;; associated with a :FUN-END breakpoint. The returned function
2818 ;;; makes a fake LRA that all returns go through, and this piece of
2819 ;;; fake code actually breaks. Upon return from the break, the code
2820 ;;; provides the returnee with any values. Since the returned function
2821 ;;; effectively activates FUN-END-BPT on each entry to DEBUG-FUN's
2822 ;;; function, we must establish breakpoint-data about FUN-END-BPT.
2823 (defun fun-end-starter-hook (starter-bpt debug-fun)
2824 (declare (type breakpoint starter-bpt)
2825 (type compiled-debug-fun debug-fun))
2826 (lambda (frame breakpoint)
2827 (declare (ignore breakpoint)
2829 (let ((lra-sc-offset
2830 (sb!c::compiled-debug-fun-return-pc
2831 (compiled-debug-fun-compiler-debug-fun debug-fun))))
2832 (multiple-value-bind (lra component offset)
2834 (get-context-value frame
2837 (setf (get-context-value frame
2841 (let ((end-bpts (breakpoint-%info starter-bpt)))
2842 (let ((data (breakpoint-data component offset)))
2843 (setf (breakpoint-data-breakpoints data) end-bpts)
2844 (dolist (bpt end-bpts)
2845 (setf (breakpoint-internal-data bpt) data)))
2846 (let ((cookie (make-fun-end-cookie lra debug-fun)))
2847 (setf (gethash component *fun-end-cookies*) cookie)
2848 (dolist (bpt end-bpts)
2849 (let ((fun (breakpoint-cookie-fun bpt)))
2850 (when fun (funcall fun frame cookie))))))))))
2852 ;;; This takes a FUN-END-COOKIE and a frame, and it returns
2853 ;;; whether the cookie is still valid. A cookie becomes invalid when
2854 ;;; the frame that established the cookie has exited. Sometimes cookie
2855 ;;; holders are unaware of cookie invalidation because their
2856 ;;; :FUN-END breakpoint hooks didn't run due to THROW'ing.
2858 ;;; This takes a frame as an efficiency hack since the user probably
2859 ;;; has a frame object in hand when using this routine, and it saves
2860 ;;; repeated parsing of the stack and consing when asking whether a
2861 ;;; series of cookies is valid.
2862 (defun fun-end-cookie-valid-p (frame cookie)
2863 (let ((lra (fun-end-cookie-bogus-lra cookie))
2864 (lra-sc-offset (sb!c::compiled-debug-fun-return-pc
2865 (compiled-debug-fun-compiler-debug-fun
2866 (fun-end-cookie-debug-fun cookie)))))
2867 (do ((frame frame (frame-down frame)))
2869 (when (and (compiled-frame-p frame)
2870 (#!-(or x86 x86-64) eq #!+(or x86 x86-64) sap=
2872 (get-context-value frame lra-save-offset lra-sc-offset)))
2875 ;;;; ACTIVATE-BREAKPOINT
2877 ;;; Cause the system to invoke the breakpoint's hook function until
2878 ;;; the next call to DEACTIVATE-BREAKPOINT or DELETE-BREAKPOINT. The
2879 ;;; system invokes breakpoint hook functions in the opposite order
2880 ;;; that you activate them.
2881 (defun activate-breakpoint (breakpoint)
2882 (when (eq (breakpoint-status breakpoint) :deleted)
2883 (error "cannot activate a deleted breakpoint: ~S" breakpoint))
2884 (unless (eq (breakpoint-status breakpoint) :active)
2885 (ecase (breakpoint-kind breakpoint)
2887 (let ((loc (breakpoint-what breakpoint)))
2889 (compiled-code-location
2890 (activate-compiled-code-location-breakpoint breakpoint)
2891 (let ((other (breakpoint-unknown-return-partner breakpoint)))
2893 (activate-compiled-code-location-breakpoint other))))
2894 ;; (There used to be more cases back before sbcl-0.7.0, when
2895 ;; we did special tricks to debug the IR1 interpreter.)
2898 (etypecase (breakpoint-what breakpoint)
2900 (activate-compiled-fun-start-breakpoint breakpoint))
2901 ;; (There used to be more cases back before sbcl-0.7.0, when
2902 ;; we did special tricks to debug the IR1 interpreter.)
2905 (etypecase (breakpoint-what breakpoint)
2907 (let ((starter (breakpoint-start-helper breakpoint)))
2908 (unless (eq (breakpoint-status starter) :active)
2909 ;; may already be active by some other :FUN-END breakpoint
2910 (activate-compiled-fun-start-breakpoint starter)))
2911 (setf (breakpoint-status breakpoint) :active))
2912 ;; (There used to be more cases back before sbcl-0.7.0, when
2913 ;; we did special tricks to debug the IR1 interpreter.)
2917 (defun activate-compiled-code-location-breakpoint (breakpoint)
2918 (declare (type breakpoint breakpoint))
2919 (let ((loc (breakpoint-what breakpoint)))
2920 (declare (type compiled-code-location loc))
2921 (sub-activate-breakpoint
2923 (breakpoint-data (compiled-debug-fun-component
2924 (code-location-debug-fun loc))
2925 (+ (compiled-code-location-pc loc)
2926 (if (or (eq (breakpoint-kind breakpoint)
2927 :unknown-return-partner)
2928 (eq (compiled-code-location-kind loc)
2929 :single-value-return))
2930 sb!vm:single-value-return-byte-offset
2933 (defun activate-compiled-fun-start-breakpoint (breakpoint)
2934 (declare (type breakpoint breakpoint))
2935 (let ((debug-fun (breakpoint-what breakpoint)))
2936 (sub-activate-breakpoint
2938 (breakpoint-data (compiled-debug-fun-component debug-fun)
2939 (sb!c::compiled-debug-fun-start-pc
2940 (compiled-debug-fun-compiler-debug-fun
2943 (defun sub-activate-breakpoint (breakpoint data)
2944 (declare (type breakpoint breakpoint)
2945 (type breakpoint-data data))
2946 (setf (breakpoint-status breakpoint) :active)
2948 (unless (breakpoint-data-breakpoints data)
2949 (setf (breakpoint-data-instruction data)
2951 (breakpoint-install (get-lisp-obj-address
2952 (breakpoint-data-component data))
2953 (breakpoint-data-offset data)))))
2954 (setf (breakpoint-data-breakpoints data)
2955 (append (breakpoint-data-breakpoints data) (list breakpoint)))
2956 (setf (breakpoint-internal-data breakpoint) data)))
2958 ;;;; DEACTIVATE-BREAKPOINT
2960 ;;; Stop the system from invoking the breakpoint's hook function.
2961 (defun deactivate-breakpoint (breakpoint)
2962 (when (eq (breakpoint-status breakpoint) :active)
2964 (let ((loc (breakpoint-what breakpoint)))
2966 ((or compiled-code-location compiled-debug-fun)
2967 (deactivate-compiled-breakpoint breakpoint)
2968 (let ((other (breakpoint-unknown-return-partner breakpoint)))
2970 (deactivate-compiled-breakpoint other))))
2971 ;; (There used to be more cases back before sbcl-0.7.0, when
2972 ;; we did special tricks to debug the IR1 interpreter.)
2976 (defun deactivate-compiled-breakpoint (breakpoint)
2977 (if (eq (breakpoint-kind breakpoint) :fun-end)
2978 (let ((starter (breakpoint-start-helper breakpoint)))
2979 (unless (find-if (lambda (bpt)
2980 (and (not (eq bpt breakpoint))
2981 (eq (breakpoint-status bpt) :active)))
2982 (breakpoint-%info starter))
2983 (deactivate-compiled-breakpoint starter)))
2984 (let* ((data (breakpoint-internal-data breakpoint))
2985 (bpts (delete breakpoint (breakpoint-data-breakpoints data))))
2986 (setf (breakpoint-internal-data breakpoint) nil)
2987 (setf (breakpoint-data-breakpoints data) bpts)
2990 (breakpoint-remove (get-lisp-obj-address
2991 (breakpoint-data-component data))
2992 (breakpoint-data-offset data)
2993 (breakpoint-data-instruction data)))
2994 (delete-breakpoint-data data))))
2995 (setf (breakpoint-status breakpoint) :inactive)
2998 ;;;; BREAKPOINT-INFO
3000 ;;; Return the user-maintained info associated with breakpoint. This
3002 (defun breakpoint-info (breakpoint)
3003 (breakpoint-%info breakpoint))
3004 (defun %set-breakpoint-info (breakpoint value)
3005 (setf (breakpoint-%info breakpoint) value)
3006 (let ((other (breakpoint-unknown-return-partner breakpoint)))
3008 (setf (breakpoint-%info other) value))))
3010 ;;;; BREAKPOINT-ACTIVE-P and DELETE-BREAKPOINT
3012 (defun breakpoint-active-p (breakpoint)
3013 (ecase (breakpoint-status breakpoint)
3015 ((:inactive :deleted) nil)))
3017 ;;; Free system storage and remove computational overhead associated
3018 ;;; with breakpoint. After calling this, breakpoint is completely
3019 ;;; impotent and can never become active again.
3020 (defun delete-breakpoint (breakpoint)
3021 (let ((status (breakpoint-status breakpoint)))
3022 (unless (eq status :deleted)
3023 (when (eq status :active)
3024 (deactivate-breakpoint breakpoint))
3025 (setf (breakpoint-status breakpoint) :deleted)
3026 (let ((other (breakpoint-unknown-return-partner breakpoint)))
3028 (setf (breakpoint-status other) :deleted)))
3029 (when (eq (breakpoint-kind breakpoint) :fun-end)
3030 (let* ((starter (breakpoint-start-helper breakpoint))
3031 (breakpoints (delete breakpoint
3032 (the list (breakpoint-info starter)))))
3033 (setf (breakpoint-info starter) breakpoints)
3035 (delete-breakpoint starter)
3036 (setf (compiled-debug-fun-end-starter
3037 (breakpoint-what breakpoint))
3041 ;;;; C call out stubs
3043 ;;; This actually installs the break instruction in the component. It
3044 ;;; returns the overwritten bits. You must call this in a context in
3045 ;;; which GC is disabled, so that Lisp doesn't move objects around
3046 ;;; that C is pointing to.
3047 (sb!alien:define-alien-routine "breakpoint_install" sb!alien:unsigned-long
3048 (code-obj sb!alien:unsigned-long)
3049 (pc-offset sb!alien:int))
3051 ;;; This removes the break instruction and replaces the original
3052 ;;; instruction. You must call this in a context in which GC is disabled
3053 ;;; so Lisp doesn't move objects around that C is pointing to.
3054 (sb!alien:define-alien-routine "breakpoint_remove" sb!alien:void
3055 (code-obj sb!alien:unsigned-long)
3056 (pc-offset sb!alien:int)
3057 (old-inst sb!alien:unsigned-long))
3059 (sb!alien:define-alien-routine "breakpoint_do_displaced_inst" sb!alien:void
3060 (scp (* os-context-t))
3061 (orig-inst sb!alien:unsigned-long))
3063 ;;;; breakpoint handlers (layer between C and exported interface)
3065 ;;; This maps components to a mapping of offsets to BREAKPOINT-DATAs.
3066 (defvar *component-breakpoint-offsets* (make-hash-table :test 'eq))
3068 ;;; This returns the BREAKPOINT-DATA object associated with component cross
3069 ;;; offset. If none exists, this makes one, installs it, and returns it.
3070 (defun breakpoint-data (component offset &optional (create t))
3071 (flet ((install-breakpoint-data ()
3073 (let ((data (make-breakpoint-data component offset)))
3074 (push (cons offset data)
3075 (gethash component *component-breakpoint-offsets*))
3077 (let ((offsets (gethash component *component-breakpoint-offsets*)))
3079 (let ((data (assoc offset offsets)))
3082 (install-breakpoint-data)))
3083 (install-breakpoint-data)))))
3085 ;;; We use this when there are no longer any active breakpoints
3086 ;;; corresponding to DATA.
3087 (defun delete-breakpoint-data (data)
3088 (let* ((component (breakpoint-data-component data))
3089 (offsets (delete (breakpoint-data-offset data)
3090 (gethash component *component-breakpoint-offsets*)
3093 (setf (gethash component *component-breakpoint-offsets*) offsets)
3094 (remhash component *component-breakpoint-offsets*)))
3097 ;;; The C handler for interrupts calls this when it has a
3098 ;;; debugging-tool break instruction. This does *not* handle all
3099 ;;; breaks; for example, it does not handle breaks for internal
3101 (defun handle-breakpoint (offset component signal-context)
3102 (let ((data (breakpoint-data component offset nil)))
3104 (error "unknown breakpoint in ~S at offset ~S"
3105 (debug-fun-name (debug-fun-from-pc component offset))
3107 (let ((breakpoints (breakpoint-data-breakpoints data)))
3108 (if (or (null breakpoints)
3109 (eq (breakpoint-kind (car breakpoints)) :fun-end))
3110 (handle-fun-end-breakpoint-aux breakpoints data signal-context)
3111 (handle-breakpoint-aux breakpoints data
3112 offset component signal-context)))))
3114 ;;; This holds breakpoint-datas while invoking the breakpoint hooks
3115 ;;; associated with that particular component and location. While they
3116 ;;; are executing, if we hit the location again, we ignore the
3117 ;;; breakpoint to avoid infinite recursion. fun-end breakpoints
3118 ;;; must work differently since the breakpoint-data is unique for each
3120 (defvar *executing-breakpoint-hooks* nil)
3122 ;;; This handles code-location and DEBUG-FUN :FUN-START
3124 (defun handle-breakpoint-aux (breakpoints data offset component signal-context)
3126 (bug "breakpoint that nobody wants"))
3127 (unless (member data *executing-breakpoint-hooks*)
3128 (let ((*executing-breakpoint-hooks* (cons data
3129 *executing-breakpoint-hooks*)))
3130 (invoke-breakpoint-hooks breakpoints component offset)))
3131 ;; At this point breakpoints may not hold the same list as
3132 ;; BREAKPOINT-DATA-BREAKPOINTS since invoking hooks may have allowed
3133 ;; a breakpoint deactivation. In fact, if all breakpoints were
3134 ;; deactivated then data is invalid since it was deleted and so the
3135 ;; correct one must be looked up if it is to be used. If there are
3136 ;; no more breakpoints active at this location, then the normal
3137 ;; instruction has been put back, and we do not need to
3138 ;; DO-DISPLACED-INST.
3139 (let ((data (breakpoint-data component offset nil)))
3140 (when (and data (breakpoint-data-breakpoints data))
3141 ;; The breakpoint is still active, so we need to execute the
3142 ;; displaced instruction and leave the breakpoint instruction
3143 ;; behind. The best way to do this is different on each machine,
3144 ;; so we just leave it up to the C code.
3145 (breakpoint-do-displaced-inst signal-context
3146 (breakpoint-data-instruction data))
3147 ;; Some platforms have no usable sigreturn() call. If your
3148 ;; implementation of arch_do_displaced_inst() _does_ sigreturn(),
3149 ;; it's polite to warn here
3150 #!+(and sparc solaris)
3151 (error "BREAKPOINT-DO-DISPLACED-INST returned?"))))
3153 (defun invoke-breakpoint-hooks (breakpoints component offset)
3154 (let* ((debug-fun (debug-fun-from-pc component offset))
3155 (frame (do ((f (top-frame) (frame-down f)))
3156 ((eq debug-fun (frame-debug-fun f)) f))))
3157 (dolist (bpt breakpoints)
3158 (funcall (breakpoint-hook-fun bpt)
3160 ;; If this is an :UNKNOWN-RETURN-PARTNER, then pass the
3161 ;; hook function the original breakpoint, so that users
3162 ;; aren't forced to confront the fact that some
3163 ;; breakpoints really are two.
3164 (if (eq (breakpoint-kind bpt) :unknown-return-partner)
3165 (breakpoint-unknown-return-partner bpt)
3168 (defun handle-fun-end-breakpoint (offset component context)
3169 (let ((data (breakpoint-data component offset nil)))
3171 (error "unknown breakpoint in ~S at offset ~S"
3172 (debug-fun-name (debug-fun-from-pc component offset))
3174 (let ((breakpoints (breakpoint-data-breakpoints data)))
3176 (aver (eq (breakpoint-kind (car breakpoints)) :fun-end))
3177 (handle-fun-end-breakpoint-aux breakpoints data context)))))
3179 ;;; Either HANDLE-BREAKPOINT calls this for :FUN-END breakpoints
3180 ;;; [old C code] or HANDLE-FUN-END-BREAKPOINT calls this directly
3182 (defun handle-fun-end-breakpoint-aux (breakpoints data signal-context)
3183 (delete-breakpoint-data data)
3186 (declare (optimize (inhibit-warnings 3)))
3187 (sb!alien:sap-alien signal-context (* os-context-t))))
3188 (frame (do ((cfp (sb!vm:context-register scp sb!vm::cfp-offset))
3189 (f (top-frame) (frame-down f)))
3190 ((= cfp (sap-int (frame-pointer f))) f)
3191 (declare (type (unsigned-byte #.sb!vm:n-word-bits) cfp))))
3192 (component (breakpoint-data-component data))
3193 (cookie (gethash component *fun-end-cookies*)))
3194 (remhash component *fun-end-cookies*)
3195 (dolist (bpt breakpoints)
3196 (funcall (breakpoint-hook-fun bpt)
3198 (get-fun-end-breakpoint-values scp)
3201 (defun get-fun-end-breakpoint-values (scp)
3202 (let ((ocfp (int-sap (sb!vm:context-register
3204 #!-(or x86 x86-64) sb!vm::ocfp-offset
3205 #!+(or x86 x86-64) sb!vm::ebx-offset)))
3206 (nargs (make-lisp-obj
3207 (sb!vm:context-register scp sb!vm::nargs-offset)))
3208 (reg-arg-offsets '#.sb!vm::*register-arg-offsets*)
3211 (dotimes (arg-num nargs)
3212 (push (if reg-arg-offsets
3214 (sb!vm:context-register scp (pop reg-arg-offsets)))
3215 (stack-ref ocfp arg-num))
3217 (nreverse results)))
3219 ;;;; MAKE-BOGUS-LRA (used for :FUN-END breakpoints)
3221 (defconstant bogus-lra-constants
3222 #!-(or x86 x86-64) 2 #!+(or x86 x86-64) 3)
3223 (defconstant known-return-p-slot
3224 (+ sb!vm:code-constants-offset #!-(or x86 x86-64) 1 #!+(or x86 x86-64) 2))
3226 ;;; Make a bogus LRA object that signals a breakpoint trap when
3227 ;;; returned to. If the breakpoint trap handler returns, REAL-LRA is
3228 ;;; returned to. Three values are returned: the bogus LRA object, the
3229 ;;; code component it is part of, and the PC offset for the trap
3231 (defun make-bogus-lra (real-lra &optional known-return-p)
3233 ;; These are really code labels, not variables: but this way we get
3235 (let* ((src-start (foreign-symbol-sap "fun_end_breakpoint_guts"))
3236 (src-end (foreign-symbol-sap "fun_end_breakpoint_end"))
3237 (trap-loc (foreign-symbol-sap "fun_end_breakpoint_trap"))
3238 (length (sap- src-end src-start))
3240 (%primitive sb!c:allocate-code-object (1+ bogus-lra-constants)
3242 (dst-start (code-instructions code-object)))
3243 (declare (type system-area-pointer
3244 src-start src-end dst-start trap-loc)
3245 (type index length))
3246 (setf (%code-debug-info code-object) :bogus-lra)
3247 (setf (code-header-ref code-object sb!vm:code-trace-table-offset-slot)
3250 (setf (code-header-ref code-object real-lra-slot) real-lra)
3252 (multiple-value-bind (offset code) (compute-lra-data-from-pc real-lra)
3253 (setf (code-header-ref code-object real-lra-slot) code)
3254 (setf (code-header-ref code-object (1+ real-lra-slot)) offset))
3255 (setf (code-header-ref code-object known-return-p-slot)
3257 (system-area-ub8-copy src-start 0 dst-start 0 length)
3258 (sb!vm:sanctify-for-execution code-object)
3260 (values dst-start code-object (sap- trap-loc src-start))
3262 (let ((new-lra (make-lisp-obj (+ (sap-int dst-start)
3263 sb!vm:other-pointer-lowtag))))
3266 (logandc2 (+ sb!vm:code-constants-offset bogus-lra-constants 1)
3268 (sb!vm:sanctify-for-execution code-object)
3269 (values new-lra code-object (sap- trap-loc src-start))))))
3273 ;;; This appears here because it cannot go with the DEBUG-FUN
3274 ;;; interface since DO-DEBUG-BLOCK-LOCATIONS isn't defined until after
3275 ;;; the DEBUG-FUN routines.
3277 ;;; Return a code-location before the body of a function and after all
3278 ;;; the arguments are in place; or if that location can't be
3279 ;;; determined due to a lack of debug information, return NIL.
3280 (defun debug-fun-start-location (debug-fun)
3281 (etypecase debug-fun
3283 (code-location-from-pc debug-fun
3284 (sb!c::compiled-debug-fun-start-pc
3285 (compiled-debug-fun-compiler-debug-fun
3288 ;; (There used to be more cases back before sbcl-0.7.0, when
3289 ;; we did special tricks to debug the IR1 interpreter.)