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-info (debug-condition)
45 ((code-component :reader no-debug-info-code-component
46 :initarg :code-component))
48 (:documentation "There is no usable debugging information available.")
49 (:report (lambda (condition stream)
52 "no debug information available for ~S~%"
53 (no-debug-info-code-component condition)))))
55 (define-condition no-debug-fun-returns (debug-condition)
56 ((debug-fun :reader no-debug-fun-returns-debug-fun
60 "The system could not return values from a frame with DEBUG-FUN since
61 it lacked information about returning values.")
62 (:report (lambda (condition stream)
63 (let ((fun (debug-fun-fun
64 (no-debug-fun-returns-debug-fun condition))))
66 "~&Cannot return values from ~:[frame~;~:*~S~] since ~
67 the debug information lacks details about returning ~
71 (define-condition no-debug-blocks (debug-condition)
72 ((debug-fun :reader no-debug-blocks-debug-fun
75 (:documentation "The debug-fun has no debug-block information.")
76 (:report (lambda (condition stream)
77 (format stream "~&~S has no debug-block information."
78 (no-debug-blocks-debug-fun condition)))))
80 (define-condition no-debug-vars (debug-condition)
81 ((debug-fun :reader no-debug-vars-debug-fun
84 (:documentation "The DEBUG-FUN has no DEBUG-VAR information.")
85 (:report (lambda (condition stream)
86 (format stream "~&~S has no debug variable information."
87 (no-debug-vars-debug-fun condition)))))
89 (define-condition lambda-list-unavailable (debug-condition)
90 ((debug-fun :reader lambda-list-unavailable-debug-fun
94 "The DEBUG-FUN has no lambda list since argument DEBUG-VARs are
96 (:report (lambda (condition stream)
97 (format stream "~&~S has no lambda-list information available."
98 (lambda-list-unavailable-debug-fun condition)))))
100 (define-condition invalid-value (debug-condition)
101 ((debug-var :reader invalid-value-debug-var :initarg :debug-var)
102 (frame :reader invalid-value-frame :initarg :frame))
103 (:report (lambda (condition stream)
104 (format stream "~&~S has :invalid or :unknown value in ~S."
105 (invalid-value-debug-var condition)
106 (invalid-value-frame condition)))))
108 (define-condition ambiguous-var-name (debug-condition)
109 ((name :reader ambiguous-var-name-name :initarg :name)
110 (frame :reader ambiguous-var-name-frame :initarg :frame))
111 (:report (lambda (condition stream)
112 (format stream "~&~S names more than one valid variable in ~S."
113 (ambiguous-var-name-name condition)
114 (ambiguous-var-name-frame condition)))))
116 ;;;; errors and DEBUG-SIGNAL
118 ;;; The debug-internals code tries to signal all programmer errors as
119 ;;; subtypes of DEBUG-ERROR. There are calls to ERROR signalling
120 ;;; SIMPLE-ERRORs, but these dummy checks in the code and shouldn't
123 ;;; While under development, this code also signals errors in code
124 ;;; branches that remain unimplemented.
126 (define-condition debug-error (error) ()
129 "All programmer errors from using the interface for building debugging
130 tools inherit from this type."))
132 (define-condition unhandled-debug-condition (debug-error)
133 ((condition :reader unhandled-debug-condition-condition :initarg :condition))
134 (:report (lambda (condition stream)
135 (format stream "~&unhandled DEBUG-CONDITION:~%~A"
136 (unhandled-debug-condition-condition condition)))))
138 (define-condition unknown-code-location (debug-error)
139 ((code-location :reader unknown-code-location-code-location
140 :initarg :code-location))
141 (:report (lambda (condition stream)
142 (format stream "~&invalid use of an unknown code-location: ~S"
143 (unknown-code-location-code-location condition)))))
145 (define-condition unknown-debug-var (debug-error)
146 ((debug-var :reader unknown-debug-var-debug-var :initarg :debug-var)
147 (debug-fun :reader unknown-debug-var-debug-fun
148 :initarg :debug-fun))
149 (:report (lambda (condition stream)
150 (format stream "~&~S is not in ~S."
151 (unknown-debug-var-debug-var condition)
152 (unknown-debug-var-debug-fun condition)))))
154 (define-condition invalid-control-stack-pointer (debug-error)
156 (:report (lambda (condition stream)
157 (declare (ignore condition))
159 (write-string "invalid control stack pointer" stream))))
161 (define-condition frame-fun-mismatch (debug-error)
162 ((code-location :reader frame-fun-mismatch-code-location
163 :initarg :code-location)
164 (frame :reader frame-fun-mismatch-frame :initarg :frame)
165 (form :reader frame-fun-mismatch-form :initarg :form))
166 (:report (lambda (condition stream)
169 "~&Form was preprocessed for ~S,~% but called on ~S:~% ~S"
170 (frame-fun-mismatch-code-location condition)
171 (frame-fun-mismatch-frame condition)
172 (frame-fun-mismatch-form condition)))))
174 ;;; This signals debug-conditions. If they go unhandled, then signal
175 ;;; an UNHANDLED-DEBUG-CONDITION error.
177 ;;; ??? Get SIGNAL in the right package!
178 (defmacro debug-signal (datum &rest arguments)
179 `(let ((condition (make-condition ,datum ,@arguments)))
181 (error 'unhandled-debug-condition :condition condition)))
185 ;;;; Most of these structures model information stored in internal
186 ;;;; data structures created by the compiler. Whenever comments
187 ;;;; preface an object or type with "compiler", they refer to the
188 ;;;; internal compiler thing, not to the object or type with the same
189 ;;;; name in the "SB-DI" package.
193 ;;; These exist for caching data stored in packed binary form in
194 ;;; compiler DEBUG-FUNs.
195 (defstruct (debug-var (:constructor nil)
197 ;; the name of the variable
198 (symbol (missing-arg) :type symbol)
199 ;; a unique integer identification relative to other variables with the same
202 ;; Does the variable always have a valid value?
203 (alive-p nil :type boolean))
204 (def!method print-object ((debug-var debug-var) stream)
205 (print-unreadable-object (debug-var stream :type t :identity t)
208 (debug-var-symbol debug-var)
209 (debug-var-id debug-var))))
212 (setf (fdocumentation 'debug-var-id 'function)
213 "Return the integer that makes DEBUG-VAR's name and package unique
214 with respect to other DEBUG-VARs in the same function.")
216 (defstruct (compiled-debug-var
218 (:constructor make-compiled-debug-var
219 (symbol id alive-p sc-offset save-sc-offset))
221 ;; storage class and offset (unexported)
222 (sc-offset nil :type sb!c:sc-offset)
223 ;; storage class and offset when saved somewhere
224 (save-sc-offset nil :type (or sb!c:sc-offset null)))
228 ;;; These represent call frames on the stack.
229 (defstruct (frame (:constructor nil)
231 ;; the next frame up, or NIL when top frame
232 (up nil :type (or frame null))
233 ;; the previous frame down, or NIL when the bottom frame. Before
234 ;; computing the next frame down, this slot holds the frame pointer
235 ;; to the control stack for the given frame. This lets us get the
236 ;; next frame down and the return-pc for that frame.
237 (%down :unparsed :type (or frame (member nil :unparsed)))
238 ;; the DEBUG-FUN for the function whose call this frame represents
239 (debug-fun nil :type debug-fun)
240 ;; the CODE-LOCATION where the frame's DEBUG-FUN will continue
241 ;; running when program execution returns to this frame. If someone
242 ;; interrupted this frame, the result could be an unknown
244 (code-location nil :type code-location)
245 ;; an a-list of catch-tags to code-locations
246 (%catches :unparsed :type (or list (member :unparsed)))
247 ;; pointer to frame on control stack (unexported)
249 ;; This is the frame's number for prompt printing. Top is zero.
250 (number 0 :type index))
252 (defstruct (compiled-frame
254 (:constructor make-compiled-frame
255 (pointer up debug-fun code-location number
258 ;; This indicates whether someone interrupted the frame.
259 ;; (unexported). If escaped, this is a pointer to the state that was
260 ;; saved when we were interrupted, an os_context_t, i.e. the third
261 ;; argument to an SA_SIGACTION-style signal handler.
263 (def!method print-object ((obj compiled-frame) str)
264 (print-unreadable-object (obj str :type t)
266 "~S~:[~;, interrupted~]"
267 (debug-fun-name (frame-debug-fun obj))
268 (compiled-frame-escaped obj))))
272 ;;; These exist for caching data stored in packed binary form in
273 ;;; compiler DEBUG-FUNs. *COMPILED-DEBUG-FUNS* maps a SB!C::DEBUG-FUN
274 ;;; to a DEBUG-FUN. There should only be one DEBUG-FUN in existence
275 ;;; for any function; that is, all CODE-LOCATIONs and other objects
276 ;;; that reference DEBUG-FUNs point to unique objects. This is
277 ;;; due to the overhead in cached information.
278 (defstruct (debug-fun (:constructor nil)
280 ;; some representation of the function arguments. See
281 ;; DEBUG-FUN-LAMBDA-LIST.
282 ;; NOTE: must parse vars before parsing arg list stuff.
283 (%lambda-list :unparsed)
284 ;; cached DEBUG-VARS information (unexported).
285 ;; These are sorted by their name.
286 (%debug-vars :unparsed :type (or simple-vector null (member :unparsed)))
287 ;; cached debug-block information. This is NIL when we have tried to
288 ;; parse the packed binary info, but none is available.
289 (blocks :unparsed :type (or simple-vector null (member :unparsed)))
290 ;; the actual function if available
291 (%function :unparsed :type (or null function (member :unparsed))))
292 (def!method print-object ((obj debug-fun) stream)
293 (print-unreadable-object (obj stream :type t)
294 (prin1 (debug-fun-name obj) stream)))
296 (defstruct (compiled-debug-fun
298 (:constructor %make-compiled-debug-fun
299 (compiler-debug-fun component))
301 ;; compiler's dumped DEBUG-FUN information (unexported)
302 (compiler-debug-fun nil :type sb!c::compiled-debug-fun)
303 ;; code object (unexported).
305 ;; the :FUN-START breakpoint (if any) used to facilitate
306 ;; function end breakpoints
307 (end-starter nil :type (or null breakpoint)))
309 ;;; This maps SB!C::COMPILED-DEBUG-FUNs to
310 ;;; COMPILED-DEBUG-FUNs, so we can get at cached stuff and not
311 ;;; duplicate COMPILED-DEBUG-FUN structures.
312 (defvar *compiled-debug-funs* (make-hash-table :test 'eq))
314 ;;; Make a COMPILED-DEBUG-FUN for a SB!C::COMPILER-DEBUG-FUN
315 ;;; and its component. This maps the latter to the former in
316 ;;; *COMPILED-DEBUG-FUNS*. If there already is a
317 ;;; COMPILED-DEBUG-FUN, then this returns it from
318 ;;; *COMPILED-DEBUG-FUNS*.
319 (defun make-compiled-debug-fun (compiler-debug-fun component)
320 (or (gethash compiler-debug-fun *compiled-debug-funs*)
321 (setf (gethash compiler-debug-fun *compiled-debug-funs*)
322 (%make-compiled-debug-fun compiler-debug-fun component))))
324 (defstruct (bogus-debug-fun
326 (:constructor make-bogus-debug-fun
335 (defvar *ir1-lambda-debug-fun* (make-hash-table :test 'eq))
339 ;;; These exist for caching data stored in packed binary form in compiler
341 (defstruct (debug-block (:constructor nil)
343 ;; Code-locations where execution continues after this block.
344 (successors nil :type list)
345 ;; This indicates whether the block is a special glob of code shared
346 ;; by various functions and tucked away elsewhere in a component.
347 ;; This kind of block has no start code-location. This slot is in
348 ;; all debug-blocks since it is an exported interface.
349 (elsewhere-p nil :type boolean))
350 (def!method print-object ((obj debug-block) str)
351 (print-unreadable-object (obj str :type t)
352 (prin1 (debug-block-fun-name obj) str)))
355 (setf (fdocumentation 'debug-block-successors 'function)
356 "Return the list of possible code-locations where execution may continue
357 when the basic-block represented by debug-block completes its execution.")
360 (setf (fdocumentation 'debug-block-elsewhere-p 'function)
361 "Return whether debug-block represents elsewhere code.")
363 (defstruct (compiled-debug-block (:include debug-block)
365 make-compiled-debug-block
366 (code-locations successors elsewhere-p))
368 ;; code-location information for the block
369 (code-locations nil :type simple-vector))
371 (defvar *ir1-block-debug-block* (make-hash-table :test 'eq))
375 ;;; This is an internal structure that manages information about a
376 ;;; breakpoint locations. See *COMPONENT-BREAKPOINT-OFFSETS*.
377 (defstruct (breakpoint-data (:constructor make-breakpoint-data
380 ;; This is the component in which the breakpoint lies.
382 ;; This is the byte offset into the component.
383 (offset nil :type index)
384 ;; The original instruction replaced by the breakpoint.
385 (instruction nil :type (or null (unsigned-byte 32)))
386 ;; A list of user breakpoints at this location.
387 (breakpoints nil :type list))
388 (def!method print-object ((obj breakpoint-data) str)
389 (print-unreadable-object (obj str :type t)
390 (format str "~S at ~S"
392 (debug-fun-from-pc (breakpoint-data-component obj)
393 (breakpoint-data-offset obj)))
394 (breakpoint-data-offset obj))))
396 (defstruct (breakpoint (:constructor %make-breakpoint
397 (hook-fun what kind %info))
399 ;; This is the function invoked when execution encounters the
400 ;; breakpoint. It takes a frame, the breakpoint, and optionally a
401 ;; list of values. Values are supplied for :FUN-END breakpoints as
402 ;; values to return for the function containing the breakpoint.
403 ;; :FUN-END breakpoint hook functions also take a cookie argument.
404 ;; See the COOKIE-FUN slot.
405 (hook-fun (required-arg) :type function)
406 ;; CODE-LOCATION or DEBUG-FUN
407 (what nil :type (or code-location debug-fun))
408 ;; :CODE-LOCATION, :FUN-START, or :FUN-END for that kind
409 ;; of breakpoint. :UNKNOWN-RETURN-PARTNER if this is the partner of
410 ;; a :code-location breakpoint at an :UNKNOWN-RETURN code-location.
411 (kind nil :type (member :code-location :fun-start :fun-end
412 :unknown-return-partner))
413 ;; Status helps the user and the implementation.
414 (status :inactive :type (member :active :inactive :deleted))
415 ;; This is a backpointer to a breakpoint-data.
416 (internal-data nil :type (or null breakpoint-data))
417 ;; With code-locations whose type is :UNKNOWN-RETURN, there are
418 ;; really two breakpoints: one at the multiple-value entry point,
419 ;; and one at the single-value entry point. This slot holds the
420 ;; breakpoint for the other one, or NIL if this isn't at an
421 ;; :UNKNOWN-RETURN code location.
422 (unknown-return-partner nil :type (or null breakpoint))
423 ;; :FUN-END breakpoints use a breakpoint at the :FUN-START
424 ;; to establish the end breakpoint upon function entry. We do this
425 ;; by frobbing the LRA to jump to a special piece of code that
426 ;; breaks and provides the return values for the returnee. This slot
427 ;; points to the start breakpoint, so we can activate, deactivate,
429 (start-helper nil :type (or null breakpoint))
430 ;; This is a hook users supply to get a dynamically unique cookie
431 ;; for identifying :FUN-END breakpoint executions. That is, if
432 ;; there is one :FUN-END breakpoint, but there may be multiple
433 ;; pending calls of its function on the stack. This function takes
434 ;; the cookie, and the hook function takes the cookie too.
435 (cookie-fun nil :type (or null function))
436 ;; This slot users can set with whatever information they find useful.
438 (def!method print-object ((obj breakpoint) str)
439 (let ((what (breakpoint-what obj)))
440 (print-unreadable-object (obj str :type t)
445 (debug-fun (debug-fun-name what)))
448 (debug-fun (breakpoint-kind obj)))))))
452 (defstruct (code-location (:constructor nil)
454 ;; the DEBUG-FUN containing this CODE-LOCATION
455 (debug-fun nil :type debug-fun)
456 ;; This is initially :UNSURE. Upon first trying to access an
457 ;; :UNPARSED slot, if the data is unavailable, then this becomes T,
458 ;; and the code-location is unknown. If the data is available, this
459 ;; becomes NIL, a known location. We can't use a separate type
460 ;; code-location for this since we must return code-locations before
461 ;; we can tell whether they're known or unknown. For example, when
462 ;; parsing the stack, we don't want to unpack all the variables and
463 ;; blocks just to make frames.
464 (%unknown-p :unsure :type (member t nil :unsure))
465 ;; the DEBUG-BLOCK containing CODE-LOCATION. XXX Possibly toss this
466 ;; out and just find it in the blocks cache in DEBUG-FUN.
467 (%debug-block :unparsed :type (or debug-block (member :unparsed)))
468 ;; This is the number of forms processed by the compiler or loader
469 ;; before the top level form containing this code-location.
470 (%tlf-offset :unparsed :type (or index (member :unparsed)))
471 ;; This is the depth-first number of the node that begins
472 ;; code-location within its top level form.
473 (%form-number :unparsed :type (or index (member :unparsed))))
474 (def!method print-object ((obj code-location) str)
475 (print-unreadable-object (obj str :type t)
476 (prin1 (debug-fun-name (code-location-debug-fun obj))
479 (defstruct (compiled-code-location
480 (:include code-location)
481 (:constructor make-known-code-location
482 (pc debug-fun %tlf-offset %form-number
483 %live-set kind &aux (%unknown-p nil)))
484 (:constructor make-compiled-code-location (pc debug-fun))
486 ;; an index into DEBUG-FUN's component slot
488 ;; a bit-vector indexed by a variable's position in
489 ;; DEBUG-FUN-DEBUG-VARS indicating whether the variable has a
490 ;; valid value at this code-location. (unexported).
491 (%live-set :unparsed :type (or simple-bit-vector (member :unparsed)))
492 ;; (unexported) To see SB!C::LOCATION-KIND, do
493 ;; (SB!KERNEL:TYPE-EXPAND 'SB!C::LOCATION-KIND).
494 (kind :unparsed :type (or (member :unparsed) sb!c::location-kind)))
498 ;;; Return the number of top level forms processed by the compiler
499 ;;; before compiling this source. If this source is uncompiled, this
500 ;;; is zero. This may be zero even if the source is compiled since the
501 ;;; first form in the first file compiled in one compilation, for
502 ;;; example, must have a root number of zero -- the compiler saw no
503 ;;; other top level forms before it.
504 (defun debug-source-root-number (debug-source)
505 (sb!c::debug-source-source-root debug-source))
509 ;;; This is used in FIND-ESCAPED-FRAME and with the bogus components
510 ;;; and LRAs used for :FUN-END breakpoints. When a components
511 ;;; debug-info slot is :BOGUS-LRA, then the REAL-LRA-SLOT contains the
512 ;;; real component to continue executing, as opposed to the bogus
513 ;;; component which appeared in some frame's LRA location.
514 (defconstant real-lra-slot sb!vm:code-constants-offset)
516 ;;; These are magically converted by the compiler.
517 (defun current-sp () (current-sp))
518 (defun current-fp () (current-fp))
519 (defun stack-ref (s n) (stack-ref s n))
520 (defun %set-stack-ref (s n value) (%set-stack-ref s n value))
521 (defun fun-code-header (fun) (fun-code-header fun))
522 (defun lra-code-header (lra) (lra-code-header lra))
523 (defun make-lisp-obj (value) (make-lisp-obj value))
524 (defun get-lisp-obj-address (thing) (get-lisp-obj-address thing))
525 (defun fun-word-offset (fun) (fun-word-offset fun))
527 #!-sb-fluid (declaim (inline cstack-pointer-valid-p))
528 (defun cstack-pointer-valid-p (x)
529 (declare (type system-area-pointer x))
530 #!-x86 ; stack grows toward high address values
531 (and (sap< x (current-sp))
532 (sap<= (int-sap control-stack-start)
534 (zerop (logand (sap-int x) #b11)))
535 #!+x86 ; stack grows toward low address values
536 (and (sap>= x (current-sp))
537 (sap> (int-sap control-stack-end) x)
538 (zerop (logand (sap-int x) #b11))))
541 (sb!alien:define-alien-routine component-ptr-from-pc (system-area-pointer)
542 (pc system-area-pointer))
545 (defun component-from-component-ptr (component-ptr)
546 (declare (type system-area-pointer component-ptr))
547 (make-lisp-obj (logior (sap-int component-ptr)
548 sb!vm:other-pointer-lowtag)))
555 (defun compute-lra-data-from-pc (pc)
556 (declare (type system-area-pointer pc))
557 (let ((component-ptr (component-ptr-from-pc pc)))
558 (unless (sap= component-ptr (int-sap #x0))
559 (let* ((code (component-from-component-ptr component-ptr))
560 (code-header-len (* (get-header-data code) sb!vm:n-word-bytes))
561 (pc-offset (- (sap-int pc)
562 (- (get-lisp-obj-address code)
563 sb!vm:other-pointer-lowtag)
565 ; (format t "c-lra-fpc ~A ~A ~A~%" pc code pc-offset)
566 (values pc-offset code)))))
568 (defconstant sb!vm::nargs-offset #.sb!vm::ecx-offset)
570 ;;; Check for a valid return address - it could be any valid C/Lisp
573 ;;; XXX Could be a little smarter.
574 #!-sb-fluid (declaim (inline ra-pointer-valid-p))
575 (defun ra-pointer-valid-p (ra)
576 (declare (type system-area-pointer ra))
578 ;; Not the first page which is unmapped.
579 (>= (sap-int ra) 4096)
580 ;; Not a Lisp stack pointer.
581 (not (cstack-pointer-valid-p ra))))
583 ;;; Try to find a valid previous stack. This is complex on the x86 as
584 ;;; it can jump between C and Lisp frames. To help find a valid frame
585 ;;; it searches backwards.
587 ;;; XXX Should probably check whether it has reached the bottom of the
590 ;;; XXX Should handle interrupted frames, both Lisp and C. At present
591 ;;; it manages to find a fp trail, see linux hack below.
592 (defun x86-call-context (fp &key (depth 0))
593 (declare (type system-area-pointer fp)
595 ;;(format t "*CC ~S ~S~%" fp depth)
597 ((not (cstack-pointer-valid-p fp))
598 #+nil (format t "debug invalid fp ~S~%" fp)
601 ;; Check the two possible frame pointers.
602 (let ((lisp-ocfp (sap-ref-sap fp (- (* (1+ ocfp-save-offset) 4))))
603 (lisp-ra (sap-ref-sap fp (- (* (1+ return-pc-save-offset)
605 (c-ocfp (sap-ref-sap fp (* 0 sb!vm:n-word-bytes)))
606 (c-ra (sap-ref-sap fp (* 1 sb!vm:n-word-bytes))))
607 (cond ((and (sap> lisp-ocfp fp) (cstack-pointer-valid-p lisp-ocfp)
608 (ra-pointer-valid-p lisp-ra)
609 (sap> c-ocfp fp) (cstack-pointer-valid-p c-ocfp)
610 (ra-pointer-valid-p c-ra))
612 "*C Both valid ~S ~S ~S ~S~%"
613 lisp-ocfp lisp-ra c-ocfp c-ra)
614 ;; Look forward another step to check their validity.
615 (let ((lisp-path-fp (x86-call-context lisp-ocfp
617 (c-path-fp (x86-call-context c-ocfp :depth (1+ depth))))
618 (cond ((and lisp-path-fp c-path-fp)
619 ;; Both still seem valid - choose the lisp frame.
620 #+nil (when (zerop depth)
622 "debug: both still valid ~S ~S ~S ~S~%"
623 lisp-ocfp lisp-ra c-ocfp c-ra))
625 (if (sap> lisp-ocfp c-ocfp)
626 (values lisp-ra lisp-ocfp)
627 (values c-ra c-ocfp))
629 (values lisp-ra lisp-ocfp))
631 ;; The lisp convention is looking good.
632 #+nil (format t "*C lisp-ocfp ~S ~S~%" lisp-ocfp lisp-ra)
633 (values lisp-ra lisp-ocfp))
635 ;; The C convention is looking good.
636 #+nil (format t "*C c-ocfp ~S ~S~%" c-ocfp c-ra)
637 (values c-ra c-ocfp))
639 ;; Neither seems right?
640 #+nil (format t "debug: no valid2 fp found ~S ~S~%"
643 ((and (sap> lisp-ocfp fp) (cstack-pointer-valid-p lisp-ocfp)
644 (ra-pointer-valid-p lisp-ra))
645 ;; The lisp convention is looking good.
646 #+nil (format t "*C lisp-ocfp ~S ~S~%" lisp-ocfp lisp-ra)
647 (values lisp-ra lisp-ocfp))
648 ((and (sap> c-ocfp fp) (cstack-pointer-valid-p c-ocfp)
649 #!-linux (ra-pointer-valid-p c-ra))
650 ;; The C convention is looking good.
651 #+nil (format t "*C c-ocfp ~S ~S~%" c-ocfp c-ra)
652 (values c-ra c-ocfp))
654 #+nil (format t "debug: no valid fp found ~S ~S~%"
660 ;;; Convert the descriptor into a SAP. The bits all stay the same, we just
661 ;;; change our notion of what we think they are.
662 #!-sb-fluid (declaim (inline descriptor-sap))
663 (defun descriptor-sap (x)
664 (int-sap (get-lisp-obj-address x)))
666 ;;; Return the top frame of the control stack as it was before calling
669 (/noshow0 "entering TOP-FRAME")
670 (multiple-value-bind (fp pc) (%caller-frame-and-pc)
671 (compute-calling-frame (descriptor-sap fp) pc nil)))
673 ;;; Flush all of the frames above FRAME, and renumber all the frames
675 (defun flush-frames-above (frame)
676 (setf (frame-up frame) nil)
677 (do ((number 0 (1+ number))
678 (frame frame (frame-%down frame)))
679 ((not (frame-p frame)))
680 (setf (frame-number frame) number)))
682 ;;; Return the frame immediately below FRAME on the stack; or when
683 ;;; FRAME is the bottom of the stack, return NIL.
684 (defun frame-down (frame)
685 (/noshow0 "entering FRAME-DOWN")
686 ;; We have to access the old-fp and return-pc out of frame and pass
687 ;; them to COMPUTE-CALLING-FRAME.
688 (let ((down (frame-%down frame)))
689 (if (eq down :unparsed)
690 (let ((debug-fun (frame-debug-fun frame)))
691 (/noshow0 "in DOWN :UNPARSED case")
692 (setf (frame-%down frame)
695 (let ((c-d-f (compiled-debug-fun-compiler-debug-fun
697 (compute-calling-frame
700 frame ocfp-save-offset
701 (sb!c::compiled-debug-fun-old-fp c-d-f)))
703 frame lra-save-offset
704 (sb!c::compiled-debug-fun-return-pc c-d-f))
707 (let ((fp (frame-pointer frame)))
708 (when (cstack-pointer-valid-p fp)
710 (multiple-value-bind (ra ofp) (x86-call-context fp)
711 (compute-calling-frame ofp ra frame))
713 (compute-calling-frame
715 (sap-ref-sap fp (* ocfp-save-offset
719 (sap-ref-32 fp (* ocfp-save-offset
720 sb!vm:n-word-bytes)))
722 (stack-ref fp lra-save-offset)
727 ;;; Get the old FP or return PC out of FRAME. STACK-SLOT is the
728 ;;; standard save location offset on the stack. LOC is the saved
729 ;;; SC-OFFSET describing the main location.
731 (defun get-context-value (frame stack-slot loc)
732 (declare (type compiled-frame frame) (type unsigned-byte stack-slot)
733 (type sb!c:sc-offset loc))
734 (let ((pointer (frame-pointer frame))
735 (escaped (compiled-frame-escaped frame)))
737 (sub-access-debug-var-slot pointer loc escaped)
738 (stack-ref pointer stack-slot))))
740 (defun get-context-value (frame stack-slot loc)
741 (declare (type compiled-frame frame) (type unsigned-byte stack-slot)
742 (type sb!c:sc-offset loc))
743 (let ((pointer (frame-pointer frame))
744 (escaped (compiled-frame-escaped frame)))
746 (sub-access-debug-var-slot pointer loc escaped)
749 (stack-ref pointer stack-slot))
751 (sap-ref-sap pointer (- (* (1+ stack-slot) 4))))))))
754 (defun (setf get-context-value) (value frame stack-slot loc)
755 (declare (type compiled-frame frame) (type unsigned-byte stack-slot)
756 (type sb!c:sc-offset loc))
757 (let ((pointer (frame-pointer frame))
758 (escaped (compiled-frame-escaped frame)))
760 (sub-set-debug-var-slot pointer loc value escaped)
761 (setf (stack-ref pointer stack-slot) value))))
764 (defun (setf get-context-value) (value frame stack-slot loc)
765 (declare (type compiled-frame frame) (type unsigned-byte stack-slot)
766 (type sb!c:sc-offset loc))
767 (let ((pointer (frame-pointer frame))
768 (escaped (compiled-frame-escaped frame)))
770 (sub-set-debug-var-slot pointer loc value escaped)
773 (setf (stack-ref pointer stack-slot) value))
775 (setf (sap-ref-sap pointer (- (* (1+ stack-slot) 4))) value))))))
777 ;;; This returns a frame for the one existing in time immediately
778 ;;; prior to the frame referenced by current-fp. This is current-fp's
779 ;;; caller or the next frame down the control stack. If there is no
780 ;;; down frame, this returns NIL for the bottom of the stack. UP-FRAME
781 ;;; is the up link for the resulting frame object, and it is null when
782 ;;; we call this to get the top of the stack.
784 ;;; The current frame contains the pointer to the temporally previous
785 ;;; frame we want, and the current frame contains the pc at which we
786 ;;; will continue executing upon returning to that previous frame.
788 ;;; Note: Sometimes LRA is actually a fixnum. This happens when lisp
789 ;;; calls into C. In this case, the code object is stored on the stack
790 ;;; after the LRA, and the LRA is the word offset.
792 (defun compute-calling-frame (caller lra up-frame)
793 (declare (type system-area-pointer caller))
794 (when (cstack-pointer-valid-p caller)
795 (multiple-value-bind (code pc-offset escaped)
797 (multiple-value-bind (word-offset code)
799 (let ((fp (frame-pointer up-frame)))
801 (stack-ref fp (1+ lra-save-offset))))
802 (values (get-header-data lra)
803 (lra-code-header lra)))
806 (* (1+ (- word-offset (get-header-data code)))
809 (values :foreign-function
812 (find-escaped-frame caller))
813 (if (and (code-component-p code)
814 (eq (%code-debug-info code) :bogus-lra))
815 (let ((real-lra (code-header-ref code real-lra-slot)))
816 (compute-calling-frame caller real-lra up-frame))
817 (let ((d-fun (case code
819 (make-bogus-debug-fun
820 "undefined function"))
822 (make-bogus-debug-fun
823 "foreign function call land"))
825 (make-bogus-debug-fun
826 "bogus stack frame"))
828 (debug-fun-from-pc code pc-offset)))))
829 (make-compiled-frame caller up-frame d-fun
830 (code-location-from-pc d-fun pc-offset
832 (if up-frame (1+ (frame-number up-frame)) 0)
835 (defun compute-calling-frame (caller ra up-frame)
836 (declare (type system-area-pointer caller ra))
837 (/noshow0 "entering COMPUTE-CALLING-FRAME")
838 (when (cstack-pointer-valid-p caller)
840 ;; First check for an escaped frame.
841 (multiple-value-bind (code pc-offset escaped) (find-escaped-frame caller)
844 (/noshow0 "in CODE clause")
845 ;; If it's escaped it may be a function end breakpoint trap.
846 (when (and (code-component-p code)
847 (eq (%code-debug-info code) :bogus-lra))
848 ;; If :bogus-lra grab the real lra.
849 (setq pc-offset (code-header-ref
850 code (1+ real-lra-slot)))
851 (setq code (code-header-ref code real-lra-slot))
854 (/noshow0 "in T clause")
856 (multiple-value-setq (pc-offset code)
857 (compute-lra-data-from-pc ra))
859 (setf code :foreign-function
863 (let ((d-fun (case code
865 (make-bogus-debug-fun
866 "undefined function"))
868 (make-bogus-debug-fun
869 "foreign function call land"))
871 (make-bogus-debug-fun
872 "bogus stack frame"))
874 (debug-fun-from-pc code pc-offset)))))
875 (/noshow0 "returning MAKE-COMPILED-FRAME from COMPUTE-CALLING-FRAME")
876 (make-compiled-frame caller up-frame d-fun
877 (code-location-from-pc d-fun pc-offset
879 (if up-frame (1+ (frame-number up-frame)) 0)
883 (defun find-escaped-frame (frame-pointer)
884 (declare (type system-area-pointer frame-pointer))
885 (/noshow0 "entering FIND-ESCAPED-FRAME")
886 (dotimes (index *free-interrupt-context-index* (values nil 0 nil))
888 ((lisp-interrupt-contexts (array (* os-context-t) nil) :extern))
889 (/noshow0 "at head of WITH-ALIEN")
890 (let ((context (sb!alien:deref lisp-interrupt-contexts index)))
891 (/noshow0 "got CONTEXT")
892 (when (= (sap-int frame-pointer)
893 (sb!vm:context-register context sb!vm::cfp-offset))
895 (/noshow0 "in WITHOUT-GCING")
896 (let* ((component-ptr (component-ptr-from-pc
897 (sb!vm:context-pc context)))
898 (code (unless (sap= component-ptr (int-sap #x0))
899 (component-from-component-ptr component-ptr))))
900 (/noshow0 "got CODE")
902 (return (values code 0 context)))
903 (let* ((code-header-len (* (get-header-data code)
906 (- (sap-int (sb!vm:context-pc context))
907 (- (get-lisp-obj-address code)
908 sb!vm:other-pointer-lowtag)
910 (/noshow "got PC-OFFSET")
911 (unless (<= 0 pc-offset
912 (* (code-header-ref code sb!vm:code-code-size-slot)
914 ;; We were in an assembly routine. Therefore, use the
917 ;; FIXME: Should this be WARN or ERROR or what?
918 (format t "** pc-offset ~S not in code obj ~S?~%"
920 (/noshow0 "returning from FIND-ESCAPED-FRAME")
922 (values code pc-offset context))))))))))
925 (defun find-escaped-frame (frame-pointer)
926 (declare (type system-area-pointer frame-pointer))
927 (dotimes (index *free-interrupt-context-index* (values nil 0 nil))
929 ((lisp-interrupt-contexts (array (* os-context-t) nil) :extern))
930 (let ((scp (sb!alien:deref lisp-interrupt-contexts index)))
931 (when (= (sap-int frame-pointer)
932 (sb!vm:context-register scp sb!vm::cfp-offset))
934 (let ((code (code-object-from-bits
935 (sb!vm:context-register scp sb!vm::code-offset))))
937 (return (values code 0 scp)))
938 (let* ((code-header-len (* (get-header-data code)
941 (- (sap-int (sb!vm:context-pc scp))
942 (- (get-lisp-obj-address code)
943 sb!vm:other-pointer-lowtag)
945 ;; Check to see whether we were executing in a branch
947 #!+(or pmax sgi) ; pmax only (and broken anyway)
948 (when (logbitp 31 (sb!alien:slot scp '%mips::sc-cause))
949 (incf pc-offset sb!vm:n-word-bytes))
950 (unless (<= 0 pc-offset
951 (* (code-header-ref code sb!vm:code-code-size-slot)
953 ;; We were in an assembly routine. Therefore, use the
956 (- (sb!vm:context-register scp sb!vm::lra-offset)
957 (get-lisp-obj-address code)
960 (if (eq (%code-debug-info code) :bogus-lra)
961 (let ((real-lra (code-header-ref code
963 (values (lra-code-header real-lra)
964 (get-header-data real-lra)
966 (values code pc-offset scp)))))))))))
968 ;;; Find the code object corresponding to the object represented by
969 ;;; bits and return it. We assume bogus functions correspond to the
970 ;;; undefined-function.
971 (defun code-object-from-bits (bits)
972 (declare (type (unsigned-byte 32) bits))
973 (let ((object (make-lisp-obj bits)))
974 (if (functionp object)
975 (or (fun-code-header object)
977 (let ((lowtag (lowtag-of object)))
978 (if (= lowtag sb!vm:other-pointer-lowtag)
979 (let ((widetag (widetag-of object)))
980 (cond ((= widetag sb!vm:code-header-widetag)
982 ((= widetag sb!vm:return-pc-header-widetag)
983 (lra-code-header object))
989 ;;; This returns a COMPILED-DEBUG-FUN for COMPONENT and PC. We fetch the
990 ;;; SB!C::DEBUG-INFO and run down its FUN-MAP to get a
991 ;;; SB!C::COMPILED-DEBUG-FUN from the PC. The result only needs to
992 ;;; reference the COMPONENT, for function constants, and the
993 ;;; SB!C::COMPILED-DEBUG-FUN.
994 (defun debug-fun-from-pc (component pc)
995 (let ((info (%code-debug-info component)))
998 (debug-signal 'no-debug-info :code-component component))
999 ((eq info :bogus-lra)
1000 (make-bogus-debug-fun "function end breakpoint"))
1002 (let* ((fun-map (sb!c::compiled-debug-info-fun-map info))
1003 (len (length fun-map)))
1004 (declare (type simple-vector fun-map))
1006 (make-compiled-debug-fun (svref fun-map 0) component)
1009 (>= pc (sb!c::compiled-debug-fun-elsewhere-pc
1010 (svref fun-map 0)))))
1011 (declare (type sb!int:index i))
1014 (< pc (if elsewhere-p
1015 (sb!c::compiled-debug-fun-elsewhere-pc
1016 (svref fun-map (1+ i)))
1017 (svref fun-map i))))
1018 (return (make-compiled-debug-fun
1019 (svref fun-map (1- i))
1023 ;;; This returns a code-location for the COMPILED-DEBUG-FUN,
1024 ;;; DEBUG-FUN, and the pc into its code vector. If we stopped at a
1025 ;;; breakpoint, find the CODE-LOCATION for that breakpoint. Otherwise,
1026 ;;; make an :UNSURE code location, so it can be filled in when we
1027 ;;; figure out what is going on.
1028 (defun code-location-from-pc (debug-fun pc escaped)
1029 (or (and (compiled-debug-fun-p debug-fun)
1031 (let ((data (breakpoint-data
1032 (compiled-debug-fun-component debug-fun)
1034 (when (and data (breakpoint-data-breakpoints data))
1035 (let ((what (breakpoint-what
1036 (first (breakpoint-data-breakpoints data)))))
1037 (when (compiled-code-location-p what)
1039 (make-compiled-code-location pc debug-fun)))
1041 ;;; Return an alist mapping catch tags to CODE-LOCATIONs. These are
1042 ;;; CODE-LOCATIONs at which execution would continue with frame as the
1043 ;;; top frame if someone threw to the corresponding tag.
1044 (defun frame-catches (frame)
1045 (let ((catch (descriptor-sap sb!vm:*current-catch-block*))
1046 (reversed-result nil)
1047 (fp (frame-pointer frame)))
1048 (loop until (zerop (sap-int catch))
1049 finally (return (nreverse reversed-result))
1054 (* sb!vm:catch-block-current-cont-slot
1055 sb!vm:n-word-bytes))
1059 (* sb!vm:catch-block-current-cont-slot
1060 sb!vm:n-word-bytes))))
1062 (lra (stack-ref catch sb!vm:catch-block-entry-pc-slot))
1065 catch (* sb!vm:catch-block-entry-pc-slot
1066 sb!vm:n-word-bytes)))
1069 (stack-ref catch sb!vm:catch-block-current-code-slot))
1071 (component (component-from-component-ptr
1072 (component-ptr-from-pc ra)))
1075 (* (- (1+ (get-header-data lra))
1076 (get-header-data component))
1080 (- (get-lisp-obj-address component)
1081 sb!vm:other-pointer-lowtag)
1082 (* (get-header-data component) sb!vm:n-word-bytes))))
1084 (stack-ref catch sb!vm:catch-block-tag-slot)
1087 (sap-ref-32 catch (* sb!vm:catch-block-tag-slot
1088 sb!vm:n-word-bytes)))
1089 (make-compiled-code-location
1090 offset (frame-debug-fun frame)))
1095 (* sb!vm:catch-block-previous-catch-slot
1096 sb!vm:n-word-bytes))
1100 (* sb!vm:catch-block-previous-catch-slot
1101 sb!vm:n-word-bytes)))))))
1103 ;;;; operations on DEBUG-FUNs
1105 ;;; Execute the forms in a context with BLOCK-VAR bound to each
1106 ;;; DEBUG-BLOCK in DEBUG-FUN successively. Result is an optional
1107 ;;; form to execute for return values, and DO-DEBUG-FUN-BLOCKS
1108 ;;; returns nil if there is no result form. This signals a
1109 ;;; NO-DEBUG-BLOCKS condition when the DEBUG-FUN lacks
1110 ;;; DEBUG-BLOCK information.
1111 (defmacro do-debug-fun-blocks ((block-var debug-fun &optional result)
1113 (let ((blocks (gensym))
1115 `(let ((,blocks (debug-fun-debug-blocks ,debug-fun)))
1116 (declare (simple-vector ,blocks))
1117 (dotimes (,i (length ,blocks) ,result)
1118 (let ((,block-var (svref ,blocks ,i)))
1121 ;;; Execute body in a context with VAR bound to each DEBUG-VAR in
1122 ;;; DEBUG-FUN. This returns the value of executing result (defaults to
1123 ;;; nil). This may iterate over only some of DEBUG-FUN's variables or
1124 ;;; none depending on debug policy; for example, possibly the
1125 ;;; compilation only preserved argument information.
1126 (defmacro do-debug-fun-vars ((var debug-fun &optional result) &body body)
1127 (let ((vars (gensym))
1129 `(let ((,vars (debug-fun-debug-vars ,debug-fun)))
1130 (declare (type (or null simple-vector) ,vars))
1132 (dotimes (,i (length ,vars) ,result)
1133 (let ((,var (svref ,vars ,i)))
1137 ;;; Return the object of type FUNCTION associated with the DEBUG-FUN,
1138 ;;; or NIL if the function is unavailable or is non-existent as a user
1139 ;;; callable function object.
1140 (defun debug-fun-fun (debug-fun)
1141 (let ((cached-value (debug-fun-%function debug-fun)))
1142 (if (eq cached-value :unparsed)
1143 (setf (debug-fun-%function debug-fun)
1144 (etypecase debug-fun
1147 (compiled-debug-fun-component debug-fun))
1149 (sb!c::compiled-debug-fun-start-pc
1150 (compiled-debug-fun-compiler-debug-fun debug-fun))))
1151 (do ((entry (%code-entry-points component)
1152 (%simple-fun-next entry)))
1155 (sb!c::compiled-debug-fun-start-pc
1156 (compiled-debug-fun-compiler-debug-fun
1157 (fun-debug-fun entry))))
1159 (bogus-debug-fun nil)))
1162 ;;; Return the name of the function represented by DEBUG-FUN. This may
1163 ;;; be a string or a cons; do not assume it is a symbol.
1164 (defun debug-fun-name (debug-fun)
1165 (declare (type debug-fun debug-fun))
1166 (etypecase debug-fun
1168 (sb!c::compiled-debug-fun-name
1169 (compiled-debug-fun-compiler-debug-fun debug-fun)))
1171 (bogus-debug-fun-%name debug-fun))))
1173 ;;; Return a DEBUG-FUN that represents debug information for FUN.
1174 (defun fun-debug-fun (fun)
1175 (declare (type function fun))
1176 (ecase (widetag-of fun)
1177 (#.sb!vm:closure-header-widetag
1178 (fun-debug-fun (%closure-fun fun)))
1179 (#.sb!vm:funcallable-instance-header-widetag
1180 (fun-debug-fun (funcallable-instance-fun fun)))
1181 ((#.sb!vm:simple-fun-header-widetag
1182 #.sb!vm:closure-fun-header-widetag)
1183 (let* ((name (%simple-fun-name fun))
1184 (component (fun-code-header fun))
1187 (and (sb!c::compiled-debug-fun-p x)
1188 (eq (sb!c::compiled-debug-fun-name x) name)
1189 (eq (sb!c::compiled-debug-fun-kind x) nil)))
1190 (sb!c::compiled-debug-info-fun-map
1191 (%code-debug-info component)))))
1193 (make-compiled-debug-fun res component)
1194 ;; KLUDGE: comment from CMU CL:
1195 ;; This used to be the non-interpreted branch, but
1196 ;; William wrote it to return the debug-fun of fun's XEP
1197 ;; instead of fun's debug-fun. The above code does this
1198 ;; more correctly, but it doesn't get or eliminate all
1199 ;; appropriate cases. It mostly works, and probably
1200 ;; works for all named functions anyway.
1202 (debug-fun-from-pc component
1203 (* (- (fun-word-offset fun)
1204 (get-header-data component))
1205 sb!vm:n-word-bytes)))))))
1207 ;;; Return the kind of the function, which is one of :OPTIONAL,
1208 ;;; :EXTERNAL, :TOPLEVEL, :CLEANUP, or NIL.
1209 (defun debug-fun-kind (debug-fun)
1210 ;; FIXME: This "is one of" information should become part of the function
1211 ;; declamation, not just a doc string
1212 (etypecase debug-fun
1214 (sb!c::compiled-debug-fun-kind
1215 (compiled-debug-fun-compiler-debug-fun debug-fun)))
1219 ;;; Is there any variable information for DEBUG-FUN?
1220 (defun debug-var-info-available (debug-fun)
1221 (not (not (debug-fun-debug-vars debug-fun))))
1223 ;;; Return a list of DEBUG-VARs in DEBUG-FUN having the same name
1224 ;;; and package as SYMBOL. If SYMBOL is uninterned, then this returns
1225 ;;; a list of DEBUG-VARs without package names and with the same name
1226 ;;; as symbol. The result of this function is limited to the
1227 ;;; availability of variable information in DEBUG-FUN; for
1228 ;;; example, possibly DEBUG-FUN only knows about its arguments.
1229 (defun debug-fun-symbol-vars (debug-fun symbol)
1230 (let ((vars (ambiguous-debug-vars debug-fun (symbol-name symbol)))
1231 (package (and (symbol-package symbol)
1232 (package-name (symbol-package symbol)))))
1233 (delete-if (if (stringp package)
1235 (let ((p (debug-var-package-name var)))
1236 (or (not (stringp p))
1237 (string/= p package))))
1239 (stringp (debug-var-package-name var))))
1242 ;;; Return a list of DEBUG-VARs in DEBUG-FUN whose names contain
1243 ;;; NAME-PREFIX-STRING as an initial substring. The result of this
1244 ;;; function is limited to the availability of variable information in
1245 ;;; debug-fun; for example, possibly debug-fun only knows
1246 ;;; about its arguments.
1247 (defun ambiguous-debug-vars (debug-fun name-prefix-string)
1248 (declare (simple-string name-prefix-string))
1249 (let ((variables (debug-fun-debug-vars debug-fun)))
1250 (declare (type (or null simple-vector) variables))
1252 (let* ((len (length variables))
1253 (prefix-len (length name-prefix-string))
1254 (pos (find-var name-prefix-string variables len))
1257 ;; Find names from pos to variable's len that contain prefix.
1258 (do ((i pos (1+ i)))
1260 (let* ((var (svref variables i))
1261 (name (debug-var-symbol-name var))
1262 (name-len (length name)))
1263 (declare (simple-string name))
1264 (when (/= (or (string/= name-prefix-string name
1265 :end1 prefix-len :end2 name-len)
1270 (setq res (nreverse res)))
1273 ;;; This returns a position in VARIABLES for one containing NAME as an
1274 ;;; initial substring. END is the length of VARIABLES if supplied.
1275 (defun find-var (name variables &optional end)
1276 (declare (simple-vector variables)
1277 (simple-string name))
1278 (let ((name-len (length name)))
1279 (position name variables
1281 (let* ((y (debug-var-symbol-name y))
1283 (declare (simple-string y))
1284 (and (>= y-len name-len)
1285 (string= x y :end1 name-len :end2 name-len))))
1286 :end (or end (length variables)))))
1288 ;;; Return a list representing the lambda-list for DEBUG-FUN. The
1289 ;;; list has the following structure:
1290 ;;; (required-var1 required-var2
1292 ;;; (:optional var3 suppliedp-var4)
1293 ;;; (:optional var5)
1295 ;;; (:rest var6) (:rest var7)
1297 ;;; (:keyword keyword-symbol var8 suppliedp-var9)
1298 ;;; (:keyword keyword-symbol var10)
1301 ;;; Each VARi is a DEBUG-VAR; however it may be the symbol :DELETED if
1302 ;;; it is unreferenced in DEBUG-FUN. This signals a
1303 ;;; LAMBDA-LIST-UNAVAILABLE condition when there is no argument list
1305 (defun debug-fun-lambda-list (debug-fun)
1306 (etypecase debug-fun
1307 (compiled-debug-fun (compiled-debug-fun-lambda-list debug-fun))
1308 (bogus-debug-fun nil)))
1310 ;;; Note: If this has to compute the lambda list, it caches it in DEBUG-FUN.
1311 (defun compiled-debug-fun-lambda-list (debug-fun)
1312 (let ((lambda-list (debug-fun-%lambda-list debug-fun)))
1313 (cond ((eq lambda-list :unparsed)
1314 (multiple-value-bind (args argsp)
1315 (parse-compiled-debug-fun-lambda-list debug-fun)
1316 (setf (debug-fun-%lambda-list debug-fun) args)
1319 (debug-signal 'lambda-list-unavailable
1320 :debug-fun debug-fun))))
1322 ((bogus-debug-fun-p debug-fun)
1324 ((sb!c::compiled-debug-fun-arguments
1325 (compiled-debug-fun-compiler-debug-fun debug-fun))
1326 ;; If the packed information is there (whether empty or not) as
1327 ;; opposed to being nil, then returned our cached value (nil).
1330 ;; Our cached value is nil, and the packed lambda-list information
1331 ;; is nil, so we don't have anything available.
1332 (debug-signal 'lambda-list-unavailable
1333 :debug-fun debug-fun)))))
1335 ;;; COMPILED-DEBUG-FUN-LAMBDA-LIST calls this when a
1336 ;;; COMPILED-DEBUG-FUN has no lambda list information cached. It
1337 ;;; returns the lambda list as the first value and whether there was
1338 ;;; any argument information as the second value. Therefore,
1339 ;;; (VALUES NIL T) means there were no arguments, but (VALUES NIL NIL)
1340 ;;; means there was no argument information.
1341 (defun parse-compiled-debug-fun-lambda-list (debug-fun)
1342 (let ((args (sb!c::compiled-debug-fun-arguments
1343 (compiled-debug-fun-compiler-debug-fun debug-fun))))
1348 (values (coerce (debug-fun-debug-vars debug-fun) 'list)
1351 (let ((vars (debug-fun-debug-vars debug-fun))
1356 (declare (type (or null simple-vector) vars))
1358 (when (>= i len) (return))
1359 (let ((ele (aref args i)))
1364 ;; Deleted required arg at beginning of args array.
1365 (push :deleted res))
1366 (sb!c::optional-args
1369 ;; SUPPLIED-P var immediately following keyword or
1370 ;; optional. Stick the extra var in the result
1371 ;; element representing the keyword or optional,
1372 ;; which is the previous one.
1374 (list (compiled-debug-fun-lambda-list-var
1375 args (incf i) vars))))
1378 (compiled-debug-fun-lambda-list-var
1379 args (incf i) vars))
1382 ;; Just ignore the fact that the next two args are
1383 ;; the &MORE arg context and count, and act like they
1384 ;; are regular arguments.
1388 (push (list :keyword
1390 (compiled-debug-fun-lambda-list-var
1391 args (incf i) vars))
1394 ;; We saw an optional marker, so the following
1395 ;; non-symbols are indexes indicating optional
1397 (push (list :optional (svref vars ele)) res))
1399 ;; Required arg at beginning of args array.
1400 (push (svref vars ele) res))))
1402 (values (nreverse res) t))))))
1404 ;;; This is used in COMPILED-DEBUG-FUN-LAMBDA-LIST.
1405 (defun compiled-debug-fun-lambda-list-var (args i vars)
1406 (declare (type (simple-array * (*)) args)
1407 (simple-vector vars))
1408 (let ((ele (aref args i)))
1409 (cond ((not (symbolp ele)) (svref vars ele))
1410 ((eq ele 'sb!c::deleted) :deleted)
1411 (t (error "malformed arguments description")))))
1413 (defun compiled-debug-fun-debug-info (debug-fun)
1414 (%code-debug-info (compiled-debug-fun-component debug-fun)))
1416 ;;;; unpacking variable and basic block data
1418 (defvar *parsing-buffer*
1419 (make-array 20 :adjustable t :fill-pointer t))
1420 (defvar *other-parsing-buffer*
1421 (make-array 20 :adjustable t :fill-pointer t))
1422 ;;; PARSE-DEBUG-BLOCKS and PARSE-DEBUG-VARS
1423 ;;; use this to unpack binary encoded information. It returns the
1424 ;;; values returned by the last form in body.
1426 ;;; This binds buffer-var to *parsing-buffer*, makes sure it starts at
1427 ;;; element zero, and makes sure if we unwind, we nil out any set
1428 ;;; elements for GC purposes.
1430 ;;; This also binds other-var to *other-parsing-buffer* when it is
1431 ;;; supplied, making sure it starts at element zero and that we nil
1432 ;;; out any elements if we unwind.
1434 ;;; This defines the local macro RESULT that takes a buffer, copies
1435 ;;; its elements to a resulting simple-vector, nil's out elements, and
1436 ;;; restarts the buffer at element zero. RESULT returns the
1438 (eval-when (:compile-toplevel :execute)
1439 (sb!xc:defmacro with-parsing-buffer ((buffer-var &optional other-var)
1441 (let ((len (gensym))
1444 (let ((,buffer-var *parsing-buffer*)
1445 ,@(if other-var `((,other-var *other-parsing-buffer*))))
1446 (setf (fill-pointer ,buffer-var) 0)
1447 ,@(if other-var `((setf (fill-pointer ,other-var) 0)))
1448 (macrolet ((result (buf)
1449 `(let* ((,',len (length ,buf))
1450 (,',res (make-array ,',len)))
1451 (replace ,',res ,buf :end1 ,',len :end2 ,',len)
1452 (fill ,buf nil :end ,',len)
1453 (setf (fill-pointer ,buf) 0)
1456 (fill *parsing-buffer* nil)
1457 ,@(if other-var `((fill *other-parsing-buffer* nil))))))
1460 ;;; The argument is a debug internals structure. This returns the
1461 ;;; DEBUG-BLOCKs for DEBUG-FUN, regardless of whether we have unpacked
1462 ;;; them yet. It signals a NO-DEBUG-BLOCKS condition if it can't
1463 ;;; return the blocks.
1464 (defun debug-fun-debug-blocks (debug-fun)
1465 (let ((blocks (debug-fun-blocks debug-fun)))
1466 (cond ((eq blocks :unparsed)
1467 (setf (debug-fun-blocks debug-fun)
1468 (parse-debug-blocks debug-fun))
1469 (unless (debug-fun-blocks debug-fun)
1470 (debug-signal 'no-debug-blocks
1471 :debug-fun debug-fun))
1472 (debug-fun-blocks debug-fun))
1475 (debug-signal 'no-debug-blocks
1476 :debug-fun debug-fun)))))
1478 ;;; Return a SIMPLE-VECTOR of DEBUG-BLOCKs or NIL. NIL indicates there
1479 ;;; was no basic block information.
1480 (defun parse-debug-blocks (debug-fun)
1481 (etypecase debug-fun
1483 (parse-compiled-debug-blocks debug-fun))
1485 (debug-signal 'no-debug-blocks :debug-fun debug-fun))))
1487 ;;; This does some of the work of PARSE-DEBUG-BLOCKS.
1488 (defun parse-compiled-debug-blocks (debug-fun)
1489 (let* ((var-count (length (debug-fun-debug-vars debug-fun)))
1490 (compiler-debug-fun (compiled-debug-fun-compiler-debug-fun
1492 (blocks (sb!c::compiled-debug-fun-blocks compiler-debug-fun))
1493 ;; KLUDGE: 8 is a hard-wired constant in the compiler for the
1494 ;; element size of the packed binary representation of the
1496 (live-set-len (ceiling var-count 8))
1497 (tlf-number (sb!c::compiled-debug-fun-tlf-number compiler-debug-fun)))
1499 (return-from parse-compiled-debug-blocks nil))
1500 (macrolet ((aref+ (a i) `(prog1 (aref ,a ,i) (incf ,i))))
1501 (with-parsing-buffer (blocks-buffer locations-buffer)
1503 (len (length blocks))
1506 (when (>= i len) (return))
1507 (let ((succ-and-flags (aref+ blocks i))
1509 (declare (type (unsigned-byte 8) succ-and-flags)
1511 (dotimes (k (ldb sb!c::compiled-debug-block-nsucc-byte
1513 (push (sb!c::read-var-integer blocks i) successors))
1515 (dotimes (k (sb!c::read-var-integer blocks i)
1516 (result locations-buffer))
1517 (let ((kind (svref sb!c::*compiled-code-location-kinds*
1520 (sb!c::read-var-integer blocks i)))
1521 (tlf-offset (or tlf-number
1522 (sb!c::read-var-integer blocks
1524 (form-number (sb!c::read-var-integer blocks i))
1525 (live-set (sb!c::read-packed-bit-vector
1526 live-set-len blocks i)))
1527 (vector-push-extend (make-known-code-location
1528 pc debug-fun tlf-offset
1529 form-number live-set kind)
1531 (setf last-pc pc))))
1532 (block (make-compiled-debug-block
1533 locations successors
1535 sb!c::compiled-debug-block-elsewhere-p
1536 succ-and-flags))))))
1537 (vector-push-extend block blocks-buffer)
1538 (dotimes (k (length locations))
1539 (setf (code-location-%debug-block (svref locations k))
1541 (let ((res (result blocks-buffer)))
1542 (declare (simple-vector res))
1543 (dotimes (i (length res))
1544 (let* ((block (svref res i))
1546 (dolist (ele (debug-block-successors block))
1547 (push (svref res ele) succs))
1548 (setf (debug-block-successors block) succs)))
1551 ;;; The argument is a debug internals structure. This returns NIL if
1552 ;;; there is no variable information. It returns an empty
1553 ;;; simple-vector if there were no locals in the function. Otherwise
1554 ;;; it returns a SIMPLE-VECTOR of DEBUG-VARs.
1555 (defun debug-fun-debug-vars (debug-fun)
1556 (let ((vars (debug-fun-%debug-vars debug-fun)))
1557 (if (eq vars :unparsed)
1558 (setf (debug-fun-%debug-vars debug-fun)
1559 (etypecase debug-fun
1561 (parse-compiled-debug-vars debug-fun))
1562 (bogus-debug-fun nil)))
1565 ;;; VARS is the parsed variables for a minimal debug function. We need
1566 ;;; to assign names of the form ARG-NNN. We must pad with leading
1567 ;;; zeros, since the arguments must be in alphabetical order.
1568 (defun assign-minimal-var-names (vars)
1569 (declare (simple-vector vars))
1570 (let* ((len (length vars))
1571 (width (length (format nil "~W" (1- len)))))
1573 (setf (compiled-debug-var-symbol (svref vars i))
1574 (intern (format nil "ARG-~V,'0D" width i)
1575 ;; KLUDGE: It's somewhat nasty to have a bare
1576 ;; package name string here. It would be
1577 ;; nicer to have #.(FIND-PACKAGE "SB!DEBUG")
1578 ;; instead, since then at least it would transform
1579 ;; correctly under package renaming and stuff.
1580 ;; However, genesis can't handle dumped packages..
1583 ;; FIXME: Maybe this could be fixed by moving the
1584 ;; whole debug-int.lisp file to warm init? (after
1585 ;; which dumping a #.(FIND-PACKAGE ..) expression
1586 ;; would work fine) If this is possible, it would
1587 ;; probably be a good thing, since minimizing the
1588 ;; amount of stuff in cold init is basically good.
1589 (or (find-package "SB-DEBUG")
1590 (find-package "SB!DEBUG")))))))
1592 ;;; Parse the packed representation of DEBUG-VARs from
1593 ;;; DEBUG-FUN's SB!C::COMPILED-DEBUG-FUN, returning a vector
1594 ;;; of DEBUG-VARs, or NIL if there was no information to parse.
1595 (defun parse-compiled-debug-vars (debug-fun)
1596 (let* ((cdebug-fun (compiled-debug-fun-compiler-debug-fun
1598 (packed-vars (sb!c::compiled-debug-fun-vars cdebug-fun))
1599 (args-minimal (eq (sb!c::compiled-debug-fun-arguments cdebug-fun)
1603 (buffer (make-array 0 :fill-pointer 0 :adjustable t)))
1604 ((>= i (length packed-vars))
1605 (let ((result (coerce buffer 'simple-vector)))
1607 (assign-minimal-var-names result))
1609 (flet ((geti () (prog1 (aref packed-vars i) (incf i))))
1610 (let* ((flags (geti))
1611 (minimal (logtest sb!c::compiled-debug-var-minimal-p flags))
1612 (deleted (logtest sb!c::compiled-debug-var-deleted-p flags))
1613 (live (logtest sb!c::compiled-debug-var-environment-live
1615 (save (logtest sb!c::compiled-debug-var-save-loc-p flags))
1616 (symbol (if minimal nil (geti)))
1617 (id (if (logtest sb!c::compiled-debug-var-id-p flags)
1620 (sc-offset (if deleted 0 (geti)))
1621 (save-sc-offset (if save (geti) nil)))
1622 (aver (not (and args-minimal (not minimal))))
1623 (vector-push-extend (make-compiled-debug-var symbol
1632 ;;; If we're sure of whether code-location is known, return T or NIL.
1633 ;;; If we're :UNSURE, then try to fill in the code-location's slots.
1634 ;;; This determines whether there is any debug-block information, and
1635 ;;; if code-location is known.
1637 ;;; ??? IF this conses closures every time it's called, then break off the
1638 ;;; :UNSURE part to get the HANDLER-CASE into another function.
1639 (defun code-location-unknown-p (basic-code-location)
1640 (ecase (code-location-%unknown-p basic-code-location)
1644 (setf (code-location-%unknown-p basic-code-location)
1645 (handler-case (not (fill-in-code-location basic-code-location))
1646 (no-debug-blocks () t))))))
1648 ;;; Return the DEBUG-BLOCK containing code-location if it is available.
1649 ;;; Some debug policies inhibit debug-block information, and if none
1650 ;;; is available, then this signals a NO-DEBUG-BLOCKS condition.
1651 (defun code-location-debug-block (basic-code-location)
1652 (let ((block (code-location-%debug-block basic-code-location)))
1653 (if (eq block :unparsed)
1654 (etypecase basic-code-location
1655 (compiled-code-location
1656 (compute-compiled-code-location-debug-block basic-code-location))
1657 ;; (There used to be more cases back before sbcl-0.7.0, when
1658 ;; we did special tricks to debug the IR1 interpreter.)
1662 ;;; Store and return BASIC-CODE-LOCATION's debug-block. We determines
1663 ;;; the correct one using the code-location's pc. We use
1664 ;;; DEBUG-FUN-DEBUG-BLOCKS to return the cached block information
1665 ;;; or signal a NO-DEBUG-BLOCKS condition. The blocks are sorted by
1666 ;;; their first code-location's pc, in ascending order. Therefore, as
1667 ;;; soon as we find a block that starts with a pc greater than
1668 ;;; basic-code-location's pc, we know the previous block contains the
1669 ;;; pc. If we get to the last block, then the code-location is either
1670 ;;; in the second to last block or the last block, and we have to be
1671 ;;; careful in determining this since the last block could be code at
1672 ;;; the end of the function. We have to check for the last block being
1673 ;;; code first in order to see how to compare the code-location's pc.
1674 (defun compute-compiled-code-location-debug-block (basic-code-location)
1675 (let* ((pc (compiled-code-location-pc basic-code-location))
1676 (debug-fun (code-location-debug-fun
1677 basic-code-location))
1678 (blocks (debug-fun-debug-blocks debug-fun))
1679 (len (length blocks)))
1680 (declare (simple-vector blocks))
1681 (setf (code-location-%debug-block basic-code-location)
1687 (let ((last (svref blocks end)))
1689 ((debug-block-elsewhere-p last)
1691 (sb!c::compiled-debug-fun-elsewhere-pc
1692 (compiled-debug-fun-compiler-debug-fun
1694 (svref blocks (1- end))
1697 (compiled-code-location-pc
1698 (svref (compiled-debug-block-code-locations last)
1700 (svref blocks (1- end)))
1702 (declare (type index i end))
1704 (compiled-code-location-pc
1705 (svref (compiled-debug-block-code-locations
1708 (return (svref blocks (1- i)))))))))
1710 ;;; Return the CODE-LOCATION's DEBUG-SOURCE.
1711 (defun code-location-debug-source (code-location)
1712 (etypecase code-location
1713 (compiled-code-location
1714 (let* ((info (compiled-debug-fun-debug-info
1715 (code-location-debug-fun code-location)))
1716 (sources (sb!c::compiled-debug-info-source info))
1717 (len (length sources)))
1718 (declare (list sources))
1720 (debug-signal 'no-debug-blocks :debug-fun
1721 (code-location-debug-fun code-location)))
1724 (do ((prev sources src)
1725 (src (cdr sources) (cdr src))
1726 (offset (code-location-toplevel-form-offset code-location)))
1727 ((null src) (car prev))
1728 (when (< offset (sb!c::debug-source-source-root (car src)))
1729 (return (car prev)))))))
1730 ;; (There used to be more cases back before sbcl-0.7.0, when we
1731 ;; did special tricks to debug the IR1 interpreter.)
1734 ;;; Returns the number of top level forms before the one containing
1735 ;;; CODE-LOCATION as seen by the compiler in some compilation unit. (A
1736 ;;; compilation unit is not necessarily a single file, see the section
1737 ;;; on debug-sources.)
1738 (defun code-location-toplevel-form-offset (code-location)
1739 (when (code-location-unknown-p code-location)
1740 (error 'unknown-code-location :code-location code-location))
1741 (let ((tlf-offset (code-location-%tlf-offset code-location)))
1742 (cond ((eq tlf-offset :unparsed)
1743 (etypecase code-location
1744 (compiled-code-location
1745 (unless (fill-in-code-location code-location)
1746 ;; This check should be unnecessary. We're missing
1747 ;; debug info the compiler should have dumped.
1748 (bug "unknown code location"))
1749 (code-location-%tlf-offset code-location))
1750 ;; (There used to be more cases back before sbcl-0.7.0,,
1751 ;; when we did special tricks to debug the IR1
1756 ;;; Return the number of the form corresponding to CODE-LOCATION. The
1757 ;;; form number is derived by a walking the subforms of a top level
1758 ;;; form in depth-first order.
1759 (defun code-location-form-number (code-location)
1760 (when (code-location-unknown-p code-location)
1761 (error 'unknown-code-location :code-location code-location))
1762 (let ((form-num (code-location-%form-number code-location)))
1763 (cond ((eq form-num :unparsed)
1764 (etypecase code-location
1765 (compiled-code-location
1766 (unless (fill-in-code-location code-location)
1767 ;; This check should be unnecessary. We're missing
1768 ;; debug info the compiler should have dumped.
1769 (bug "unknown code location"))
1770 (code-location-%form-number code-location))
1771 ;; (There used to be more cases back before sbcl-0.7.0,,
1772 ;; when we did special tricks to debug the IR1
1777 ;;; Return the kind of CODE-LOCATION, one of:
1778 ;;; :INTERPRETED, :UNKNOWN-RETURN, :KNOWN-RETURN, :INTERNAL-ERROR,
1779 ;;; :NON-LOCAL-EXIT, :BLOCK-START, :CALL-SITE, :SINGLE-VALUE-RETURN,
1780 ;;; :NON-LOCAL-ENTRY
1781 (defun code-location-kind (code-location)
1782 (when (code-location-unknown-p code-location)
1783 (error 'unknown-code-location :code-location code-location))
1784 (etypecase code-location
1785 (compiled-code-location
1786 (let ((kind (compiled-code-location-kind code-location)))
1787 (cond ((not (eq kind :unparsed)) kind)
1788 ((not (fill-in-code-location code-location))
1789 ;; This check should be unnecessary. We're missing
1790 ;; debug info the compiler should have dumped.
1791 (bug "unknown code location"))
1793 (compiled-code-location-kind code-location)))))
1794 ;; (There used to be more cases back before sbcl-0.7.0,,
1795 ;; when we did special tricks to debug the IR1
1799 ;;; This returns CODE-LOCATION's live-set if it is available. If
1800 ;;; there is no debug-block information, this returns NIL.
1801 (defun compiled-code-location-live-set (code-location)
1802 (if (code-location-unknown-p code-location)
1804 (let ((live-set (compiled-code-location-%live-set code-location)))
1805 (cond ((eq live-set :unparsed)
1806 (unless (fill-in-code-location code-location)
1807 ;; This check should be unnecessary. We're missing
1808 ;; debug info the compiler should have dumped.
1810 ;; FIXME: This error and comment happen over and over again.
1811 ;; Make them a shared function.
1812 (bug "unknown code location"))
1813 (compiled-code-location-%live-set code-location))
1816 ;;; true if OBJ1 and OBJ2 are the same place in the code
1817 (defun code-location= (obj1 obj2)
1819 (compiled-code-location
1821 (compiled-code-location
1822 (and (eq (code-location-debug-fun obj1)
1823 (code-location-debug-fun obj2))
1824 (sub-compiled-code-location= obj1 obj2)))
1825 ;; (There used to be more cases back before sbcl-0.7.0,,
1826 ;; when we did special tricks to debug the IR1
1829 ;; (There used to be more cases back before sbcl-0.7.0,,
1830 ;; when we did special tricks to debug IR1-interpreted code.)
1832 (defun sub-compiled-code-location= (obj1 obj2)
1833 (= (compiled-code-location-pc obj1)
1834 (compiled-code-location-pc obj2)))
1836 ;;; Fill in CODE-LOCATION's :UNPARSED slots, returning T or NIL
1837 ;;; depending on whether the code-location was known in its
1838 ;;; DEBUG-FUN's debug-block information. This may signal a
1839 ;;; NO-DEBUG-BLOCKS condition due to DEBUG-FUN-DEBUG-BLOCKS, and
1840 ;;; it assumes the %UNKNOWN-P slot is already set or going to be set.
1841 (defun fill-in-code-location (code-location)
1842 (declare (type compiled-code-location code-location))
1843 (let* ((debug-fun (code-location-debug-fun code-location))
1844 (blocks (debug-fun-debug-blocks debug-fun)))
1845 (declare (simple-vector blocks))
1846 (dotimes (i (length blocks) nil)
1847 (let* ((block (svref blocks i))
1848 (locations (compiled-debug-block-code-locations block)))
1849 (declare (simple-vector locations))
1850 (dotimes (j (length locations))
1851 (let ((loc (svref locations j)))
1852 (when (sub-compiled-code-location= code-location loc)
1853 (setf (code-location-%debug-block code-location) block)
1854 (setf (code-location-%tlf-offset code-location)
1855 (code-location-%tlf-offset loc))
1856 (setf (code-location-%form-number code-location)
1857 (code-location-%form-number loc))
1858 (setf (compiled-code-location-%live-set code-location)
1859 (compiled-code-location-%live-set loc))
1860 (setf (compiled-code-location-kind code-location)
1861 (compiled-code-location-kind loc))
1862 (return-from fill-in-code-location t))))))))
1864 ;;;; operations on DEBUG-BLOCKs
1866 ;;; Execute FORMS in a context with CODE-VAR bound to each
1867 ;;; CODE-LOCATION in DEBUG-BLOCK, and return the value of RESULT.
1868 (defmacro do-debug-block-locations ((code-var debug-block &optional result)
1870 (let ((code-locations (gensym))
1872 `(let ((,code-locations (debug-block-code-locations ,debug-block)))
1873 (declare (simple-vector ,code-locations))
1874 (dotimes (,i (length ,code-locations) ,result)
1875 (let ((,code-var (svref ,code-locations ,i)))
1878 ;;; Return the name of the function represented by DEBUG-FUN.
1879 ;;; This may be a string or a cons; do not assume it is a symbol.
1880 (defun debug-block-fun-name (debug-block)
1881 (etypecase debug-block
1882 (compiled-debug-block
1883 (let ((code-locs (compiled-debug-block-code-locations debug-block)))
1884 (declare (simple-vector code-locs))
1885 (if (zerop (length code-locs))
1886 "??? Can't get name of debug-block's function."
1888 (code-location-debug-fun (svref code-locs 0))))))
1889 ;; (There used to be more cases back before sbcl-0.7.0, when we
1890 ;; did special tricks to debug the IR1 interpreter.)
1893 (defun debug-block-code-locations (debug-block)
1894 (etypecase debug-block
1895 (compiled-debug-block
1896 (compiled-debug-block-code-locations debug-block))
1897 ;; (There used to be more cases back before sbcl-0.7.0, when we
1898 ;; did special tricks to debug the IR1 interpreter.)
1901 ;;;; operations on debug variables
1903 (defun debug-var-symbol-name (debug-var)
1904 (symbol-name (debug-var-symbol debug-var)))
1906 ;;; FIXME: Make sure that this isn't called anywhere that it wouldn't
1907 ;;; be acceptable to have NIL returned, or that it's only called on
1908 ;;; DEBUG-VARs whose symbols have non-NIL packages.
1909 (defun debug-var-package-name (debug-var)
1910 (package-name (symbol-package (debug-var-symbol debug-var))))
1912 ;;; Return the value stored for DEBUG-VAR in frame, or if the value is
1913 ;;; not :VALID, then signal an INVALID-VALUE error.
1914 (defun debug-var-valid-value (debug-var frame)
1915 (unless (eq (debug-var-validity debug-var (frame-code-location frame))
1917 (error 'invalid-value :debug-var debug-var :frame frame))
1918 (debug-var-value debug-var frame))
1920 ;;; Returns the value stored for DEBUG-VAR in frame. The value may be
1921 ;;; invalid. This is SETFable.
1922 (defun debug-var-value (debug-var frame)
1923 (aver (typep frame 'compiled-frame))
1924 (let ((res (access-compiled-debug-var-slot debug-var frame)))
1925 (if (indirect-value-cell-p res)
1926 (value-cell-ref res)
1929 ;;; This returns what is stored for the variable represented by
1930 ;;; DEBUG-VAR relative to the FRAME. This may be an indirect value
1931 ;;; cell if the variable is both closed over and set.
1932 (defun access-compiled-debug-var-slot (debug-var frame)
1933 (declare (optimize (speed 1)))
1934 (let ((escaped (compiled-frame-escaped frame)))
1936 (sub-access-debug-var-slot
1937 (frame-pointer frame)
1938 (compiled-debug-var-sc-offset debug-var)
1940 (sub-access-debug-var-slot
1941 (frame-pointer frame)
1942 (or (compiled-debug-var-save-sc-offset debug-var)
1943 (compiled-debug-var-sc-offset debug-var))))))
1945 ;;; a helper function for working with possibly-invalid values:
1946 ;;; Do (MAKE-LISP-OBJ VAL) only if the value looks valid.
1948 ;;; (Such values can arise in registers on machines with conservative
1949 ;;; GC, and might also arise in debug variable locations when
1950 ;;; those variables are invalid.)
1951 (defun make-valid-lisp-obj (val)
1954 (zerop (logand val 3))
1956 (and (zerop (logand val #xffff0000)) ; Top bits zero
1957 (= (logand val #xff) sb!vm:base-char-widetag)) ; char tag
1959 (= val sb!vm:unbound-marker-widetag)
1962 ;; Check that the pointer is valid. XXX Could do a better
1963 ;; job. FIXME: e.g. by calling out to an is_valid_pointer
1964 ;; routine in the C runtime support code
1965 (or (< sb!vm:read-only-space-start val
1966 (* sb!vm:*read-only-space-free-pointer*
1967 sb!vm:n-word-bytes))
1968 (< sb!vm:static-space-start val
1969 (* sb!vm:*static-space-free-pointer*
1970 sb!vm:n-word-bytes))
1971 (< sb!vm:dynamic-space-start val
1972 (sap-int (dynamic-space-free-pointer))))))
1977 (defun sub-access-debug-var-slot (fp sc-offset &optional escaped)
1978 (macrolet ((with-escaped-value ((var) &body forms)
1980 (let ((,var (sb!vm:context-register
1982 (sb!c:sc-offset-offset sc-offset))))
1984 :invalid-value-for-unescaped-register-storage))
1985 (escaped-float-value (format)
1987 (sb!vm:context-float-register
1989 (sb!c:sc-offset-offset sc-offset)
1991 :invalid-value-for-unescaped-register-storage))
1992 (with-nfp ((var) &body body)
1993 `(let ((,var (if escaped
1995 (sb!vm:context-register escaped
1998 (sb!sys:sap-ref-sap fp (* nfp-save-offset
1999 sb!vm:n-word-bytes))
2001 (sb!vm::make-number-stack-pointer
2002 (sb!sys:sap-ref-32 fp (* nfp-save-offset
2003 sb!vm:n-word-bytes))))))
2005 (ecase (sb!c:sc-offset-scn sc-offset)
2006 ((#.sb!vm:any-reg-sc-number
2007 #.sb!vm:descriptor-reg-sc-number
2008 #!+rt #.sb!vm:word-pointer-reg-sc-number)
2009 (sb!sys:without-gcing
2010 (with-escaped-value (val) (sb!kernel:make-lisp-obj val))))
2012 (#.sb!vm:base-char-reg-sc-number
2013 (with-escaped-value (val)
2015 (#.sb!vm:sap-reg-sc-number
2016 (with-escaped-value (val)
2017 (sb!sys:int-sap val)))
2018 (#.sb!vm:signed-reg-sc-number
2019 (with-escaped-value (val)
2020 (if (logbitp (1- sb!vm:n-word-bits) val)
2021 (logior val (ash -1 sb!vm:n-word-bits))
2023 (#.sb!vm:unsigned-reg-sc-number
2024 (with-escaped-value (val)
2026 (#.sb!vm:non-descriptor-reg-sc-number
2027 (error "Local non-descriptor register access?"))
2028 (#.sb!vm:interior-reg-sc-number
2029 (error "Local interior register access?"))
2030 (#.sb!vm:single-reg-sc-number
2031 (escaped-float-value single-float))
2032 (#.sb!vm:double-reg-sc-number
2033 (escaped-float-value double-float))
2035 (#.sb!vm:long-reg-sc-number
2036 (escaped-float-value long-float))
2037 (#.sb!vm:complex-single-reg-sc-number
2040 (sb!vm:context-float-register
2041 escaped (sb!c:sc-offset-offset sc-offset) 'single-float)
2042 (sb!vm:context-float-register
2043 escaped (1+ (sb!c:sc-offset-offset sc-offset)) 'single-float))
2044 :invalid-value-for-unescaped-register-storage))
2045 (#.sb!vm:complex-double-reg-sc-number
2048 (sb!vm:context-float-register
2049 escaped (sb!c:sc-offset-offset sc-offset) 'double-float)
2050 (sb!vm:context-float-register
2051 escaped (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 2 #-sparc 1)
2053 :invalid-value-for-unescaped-register-storage))
2055 (#.sb!vm:complex-long-reg-sc-number
2058 (sb!vm:context-float-register
2059 escaped (sb!c:sc-offset-offset sc-offset) 'long-float)
2060 (sb!vm:context-float-register
2061 escaped (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 4)
2063 :invalid-value-for-unescaped-register-storage))
2064 (#.sb!vm:single-stack-sc-number
2066 (sb!sys:sap-ref-single nfp (* (sb!c:sc-offset-offset sc-offset)
2067 sb!vm:n-word-bytes))))
2068 (#.sb!vm:double-stack-sc-number
2070 (sb!sys:sap-ref-double nfp (* (sb!c:sc-offset-offset sc-offset)
2071 sb!vm:n-word-bytes))))
2073 (#.sb!vm:long-stack-sc-number
2075 (sb!sys:sap-ref-long nfp (* (sb!c:sc-offset-offset sc-offset)
2076 sb!vm:n-word-bytes))))
2077 (#.sb!vm:complex-single-stack-sc-number
2080 (sb!sys:sap-ref-single nfp (* (sb!c:sc-offset-offset sc-offset)
2081 sb!vm:n-word-bytes))
2082 (sb!sys:sap-ref-single nfp (* (1+ (sb!c:sc-offset-offset sc-offset))
2083 sb!vm:n-word-bytes)))))
2084 (#.sb!vm:complex-double-stack-sc-number
2087 (sb!sys:sap-ref-double nfp (* (sb!c:sc-offset-offset sc-offset)
2088 sb!vm:n-word-bytes))
2089 (sb!sys:sap-ref-double nfp (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2090 sb!vm:n-word-bytes)))))
2092 (#.sb!vm:complex-long-stack-sc-number
2095 (sb!sys:sap-ref-long nfp (* (sb!c:sc-offset-offset sc-offset)
2096 sb!vm:n-word-bytes))
2097 (sb!sys:sap-ref-long nfp (* (+ (sb!c:sc-offset-offset sc-offset)
2099 sb!vm:n-word-bytes)))))
2100 (#.sb!vm:control-stack-sc-number
2101 (sb!kernel:stack-ref fp (sb!c:sc-offset-offset sc-offset)))
2102 (#.sb!vm:base-char-stack-sc-number
2104 (code-char (sb!sys:sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2105 sb!vm:n-word-bytes)))))
2106 (#.sb!vm:unsigned-stack-sc-number
2108 (sb!sys:sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2109 sb!vm:n-word-bytes))))
2110 (#.sb!vm:signed-stack-sc-number
2112 (sb!sys:signed-sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2113 sb!vm:n-word-bytes))))
2114 (#.sb!vm:sap-stack-sc-number
2116 (sb!sys:sap-ref-sap nfp (* (sb!c:sc-offset-offset sc-offset)
2117 sb!vm:n-word-bytes)))))))
2120 (defun sub-access-debug-var-slot (fp sc-offset &optional escaped)
2121 (declare (type system-area-pointer fp))
2122 (macrolet ((with-escaped-value ((var) &body forms)
2124 (let ((,var (sb!vm:context-register
2126 (sb!c:sc-offset-offset sc-offset))))
2128 :invalid-value-for-unescaped-register-storage))
2129 (escaped-float-value (format)
2131 (sb!vm:context-float-register
2132 escaped (sb!c:sc-offset-offset sc-offset) ',format)
2133 :invalid-value-for-unescaped-register-storage))
2134 (escaped-complex-float-value (format)
2137 (sb!vm:context-float-register
2138 escaped (sb!c:sc-offset-offset sc-offset) ',format)
2139 (sb!vm:context-float-register
2140 escaped (1+ (sb!c:sc-offset-offset sc-offset)) ',format))
2141 :invalid-value-for-unescaped-register-storage)))
2142 (ecase (sb!c:sc-offset-scn sc-offset)
2143 ((#.sb!vm:any-reg-sc-number #.sb!vm:descriptor-reg-sc-number)
2145 (with-escaped-value (val)
2146 (make-valid-lisp-obj val))))
2147 (#.sb!vm:base-char-reg-sc-number
2148 (with-escaped-value (val)
2150 (#.sb!vm:sap-reg-sc-number
2151 (with-escaped-value (val)
2153 (#.sb!vm:signed-reg-sc-number
2154 (with-escaped-value (val)
2155 (if (logbitp (1- sb!vm:n-word-bits) val)
2156 (logior val (ash -1 sb!vm:n-word-bits))
2158 (#.sb!vm:unsigned-reg-sc-number
2159 (with-escaped-value (val)
2161 (#.sb!vm:single-reg-sc-number
2162 (escaped-float-value single-float))
2163 (#.sb!vm:double-reg-sc-number
2164 (escaped-float-value double-float))
2166 (#.sb!vm:long-reg-sc-number
2167 (escaped-float-value long-float))
2168 (#.sb!vm:complex-single-reg-sc-number
2169 (escaped-complex-float-value single-float))
2170 (#.sb!vm:complex-double-reg-sc-number
2171 (escaped-complex-float-value double-float))
2173 (#.sb!vm:complex-long-reg-sc-number
2174 (escaped-complex-float-value long-float))
2175 (#.sb!vm:single-stack-sc-number
2176 (sap-ref-single fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2177 sb!vm:n-word-bytes))))
2178 (#.sb!vm:double-stack-sc-number
2179 (sap-ref-double fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2180 sb!vm:n-word-bytes))))
2182 (#.sb!vm:long-stack-sc-number
2183 (sap-ref-long fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2184 sb!vm:n-word-bytes))))
2185 (#.sb!vm:complex-single-stack-sc-number
2187 (sap-ref-single fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2188 sb!vm:n-word-bytes)))
2189 (sap-ref-single fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2190 sb!vm:n-word-bytes)))))
2191 (#.sb!vm:complex-double-stack-sc-number
2193 (sap-ref-double fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2194 sb!vm:n-word-bytes)))
2195 (sap-ref-double fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 4)
2196 sb!vm:n-word-bytes)))))
2198 (#.sb!vm:complex-long-stack-sc-number
2200 (sap-ref-long fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2201 sb!vm:n-word-bytes)))
2202 (sap-ref-long fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 6)
2203 sb!vm:n-word-bytes)))))
2204 (#.sb!vm:control-stack-sc-number
2205 (stack-ref fp (sb!c:sc-offset-offset sc-offset)))
2206 (#.sb!vm:base-char-stack-sc-number
2208 (sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2209 sb!vm:n-word-bytes)))))
2210 (#.sb!vm:unsigned-stack-sc-number
2211 (sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2212 sb!vm:n-word-bytes))))
2213 (#.sb!vm:signed-stack-sc-number
2214 (signed-sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2215 sb!vm:n-word-bytes))))
2216 (#.sb!vm:sap-stack-sc-number
2217 (sap-ref-sap fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2218 sb!vm:n-word-bytes)))))))
2220 ;;; This stores value as the value of DEBUG-VAR in FRAME. In the
2221 ;;; COMPILED-DEBUG-VAR case, access the current value to determine if
2222 ;;; it is an indirect value cell. This occurs when the variable is
2223 ;;; both closed over and set.
2224 (defun %set-debug-var-value (debug-var frame new-value)
2225 (aver (typep frame 'compiled-frame))
2226 (let ((old-value (access-compiled-debug-var-slot debug-var frame)))
2227 (if (indirect-value-cell-p old-value)
2228 (value-cell-set old-value new-value)
2229 (set-compiled-debug-var-slot debug-var frame new-value)))
2232 ;;; This stores VALUE for the variable represented by debug-var
2233 ;;; relative to the frame. This assumes the location directly contains
2234 ;;; the variable's value; that is, there is no indirect value cell
2235 ;;; currently there in case the variable is both closed over and set.
2236 (defun set-compiled-debug-var-slot (debug-var frame value)
2237 (let ((escaped (compiled-frame-escaped frame)))
2239 (sub-set-debug-var-slot (frame-pointer frame)
2240 (compiled-debug-var-sc-offset debug-var)
2242 (sub-set-debug-var-slot
2243 (frame-pointer frame)
2244 (or (compiled-debug-var-save-sc-offset debug-var)
2245 (compiled-debug-var-sc-offset debug-var))
2249 (defun sub-set-debug-var-slot (fp sc-offset value &optional escaped)
2250 (macrolet ((set-escaped-value (val)
2252 (setf (sb!vm:context-register
2254 (sb!c:sc-offset-offset sc-offset))
2257 (set-escaped-float-value (format val)
2259 (setf (sb!vm:context-float-register
2261 (sb!c:sc-offset-offset sc-offset)
2265 (with-nfp ((var) &body body)
2266 `(let ((,var (if escaped
2268 (sb!vm:context-register escaped
2273 sb!vm:n-word-bytes))
2275 (sb!vm::make-number-stack-pointer
2278 sb!vm:n-word-bytes))))))
2280 (ecase (sb!c:sc-offset-scn sc-offset)
2281 ((#.sb!vm:any-reg-sc-number
2282 #.sb!vm:descriptor-reg-sc-number
2283 #!+rt #.sb!vm:word-pointer-reg-sc-number)
2286 (get-lisp-obj-address value))))
2287 (#.sb!vm:base-char-reg-sc-number
2288 (set-escaped-value (char-code value)))
2289 (#.sb!vm:sap-reg-sc-number
2290 (set-escaped-value (sap-int value)))
2291 (#.sb!vm:signed-reg-sc-number
2292 (set-escaped-value (logand value (1- (ash 1 sb!vm:n-word-bits)))))
2293 (#.sb!vm:unsigned-reg-sc-number
2294 (set-escaped-value value))
2295 (#.sb!vm:non-descriptor-reg-sc-number
2296 (error "Local non-descriptor register access?"))
2297 (#.sb!vm:interior-reg-sc-number
2298 (error "Local interior register access?"))
2299 (#.sb!vm:single-reg-sc-number
2300 (set-escaped-float-value single-float value))
2301 (#.sb!vm:double-reg-sc-number
2302 (set-escaped-float-value double-float value))
2304 (#.sb!vm:long-reg-sc-number
2305 (set-escaped-float-value long-float value))
2306 (#.sb!vm:complex-single-reg-sc-number
2308 (setf (sb!vm:context-float-register escaped
2309 (sb!c:sc-offset-offset sc-offset)
2312 (setf (sb!vm:context-float-register
2313 escaped (1+ (sb!c:sc-offset-offset sc-offset))
2317 (#.sb!vm:complex-double-reg-sc-number
2319 (setf (sb!vm:context-float-register
2320 escaped (sb!c:sc-offset-offset sc-offset) 'double-float)
2322 (setf (sb!vm:context-float-register
2324 (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 2 #!-sparc 1)
2329 (#.sb!vm:complex-long-reg-sc-number
2331 (setf (sb!vm:context-float-register
2332 escaped (sb!c:sc-offset-offset sc-offset) 'long-float)
2334 (setf (sb!vm:context-float-register
2336 (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 4)
2340 (#.sb!vm:single-stack-sc-number
2342 (setf (sap-ref-single nfp (* (sb!c:sc-offset-offset sc-offset)
2343 sb!vm:n-word-bytes))
2344 (the single-float value))))
2345 (#.sb!vm:double-stack-sc-number
2347 (setf (sap-ref-double nfp (* (sb!c:sc-offset-offset sc-offset)
2348 sb!vm:n-word-bytes))
2349 (the double-float value))))
2351 (#.sb!vm:long-stack-sc-number
2353 (setf (sap-ref-long nfp (* (sb!c:sc-offset-offset sc-offset)
2354 sb!vm:n-word-bytes))
2355 (the long-float value))))
2356 (#.sb!vm:complex-single-stack-sc-number
2358 (setf (sap-ref-single
2359 nfp (* (sb!c:sc-offset-offset sc-offset) sb!vm:n-word-bytes))
2360 (the single-float (realpart value)))
2361 (setf (sap-ref-single
2362 nfp (* (1+ (sb!c:sc-offset-offset sc-offset))
2363 sb!vm:n-word-bytes))
2364 (the single-float (realpart value)))))
2365 (#.sb!vm:complex-double-stack-sc-number
2367 (setf (sap-ref-double
2368 nfp (* (sb!c:sc-offset-offset sc-offset) sb!vm:n-word-bytes))
2369 (the double-float (realpart value)))
2370 (setf (sap-ref-double
2371 nfp (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2372 sb!vm:n-word-bytes))
2373 (the double-float (realpart value)))))
2375 (#.sb!vm:complex-long-stack-sc-number
2378 nfp (* (sb!c:sc-offset-offset sc-offset) sb!vm:n-word-bytes))
2379 (the long-float (realpart value)))
2381 nfp (* (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 4)
2382 sb!vm:n-word-bytes))
2383 (the long-float (realpart value)))))
2384 (#.sb!vm:control-stack-sc-number
2385 (setf (stack-ref fp (sb!c:sc-offset-offset sc-offset)) value))
2386 (#.sb!vm:base-char-stack-sc-number
2388 (setf (sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2389 sb!vm:n-word-bytes))
2390 (char-code (the character value)))))
2391 (#.sb!vm:unsigned-stack-sc-number
2393 (setf (sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2394 sb!vm:n-word-bytes))
2395 (the (unsigned-byte 32) value))))
2396 (#.sb!vm:signed-stack-sc-number
2398 (setf (signed-sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2399 sb!vm:n-word-bytes))
2400 (the (signed-byte 32) value))))
2401 (#.sb!vm:sap-stack-sc-number
2403 (setf (sap-ref-sap nfp (* (sb!c:sc-offset-offset sc-offset)
2404 sb!vm:n-word-bytes))
2405 (the system-area-pointer value)))))))
2408 (defun sub-set-debug-var-slot (fp sc-offset value &optional escaped)
2409 (macrolet ((set-escaped-value (val)
2411 (setf (sb!vm:context-register
2413 (sb!c:sc-offset-offset sc-offset))
2416 (ecase (sb!c:sc-offset-scn sc-offset)
2417 ((#.sb!vm:any-reg-sc-number #.sb!vm:descriptor-reg-sc-number)
2420 (get-lisp-obj-address value))))
2421 (#.sb!vm:base-char-reg-sc-number
2422 (set-escaped-value (char-code value)))
2423 (#.sb!vm:sap-reg-sc-number
2424 (set-escaped-value (sap-int value)))
2425 (#.sb!vm:signed-reg-sc-number
2426 (set-escaped-value (logand value (1- (ash 1 sb!vm:n-word-bits)))))
2427 (#.sb!vm:unsigned-reg-sc-number
2428 (set-escaped-value value))
2429 (#.sb!vm:single-reg-sc-number
2430 #+nil ;; don't have escaped floats.
2431 (set-escaped-float-value single-float value))
2432 (#.sb!vm:double-reg-sc-number
2433 #+nil ;; don't have escaped floats -- still in npx?
2434 (set-escaped-float-value double-float value))
2436 (#.sb!vm:long-reg-sc-number
2437 #+nil ;; don't have escaped floats -- still in npx?
2438 (set-escaped-float-value long-float value))
2439 (#.sb!vm:single-stack-sc-number
2440 (setf (sap-ref-single
2441 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2442 sb!vm:n-word-bytes)))
2443 (the single-float value)))
2444 (#.sb!vm:double-stack-sc-number
2445 (setf (sap-ref-double
2446 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2447 sb!vm:n-word-bytes)))
2448 (the double-float value)))
2450 (#.sb!vm:long-stack-sc-number
2452 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2453 sb!vm:n-word-bytes)))
2454 (the long-float value)))
2455 (#.sb!vm:complex-single-stack-sc-number
2456 (setf (sap-ref-single
2457 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2458 sb!vm:n-word-bytes)))
2459 (realpart (the (complex single-float) value)))
2460 (setf (sap-ref-single
2461 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2462 sb!vm:n-word-bytes)))
2463 (imagpart (the (complex single-float) value))))
2464 (#.sb!vm:complex-double-stack-sc-number
2465 (setf (sap-ref-double
2466 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2467 sb!vm:n-word-bytes)))
2468 (realpart (the (complex double-float) value)))
2469 (setf (sap-ref-double
2470 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 4)
2471 sb!vm:n-word-bytes)))
2472 (imagpart (the (complex double-float) value))))
2474 (#.sb!vm:complex-long-stack-sc-number
2476 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2477 sb!vm:n-word-bytes)))
2478 (realpart (the (complex long-float) value)))
2480 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 6)
2481 sb!vm:n-word-bytes)))
2482 (imagpart (the (complex long-float) value))))
2483 (#.sb!vm:control-stack-sc-number
2484 (setf (stack-ref fp (sb!c:sc-offset-offset sc-offset)) value))
2485 (#.sb!vm:base-char-stack-sc-number
2486 (setf (sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2487 sb!vm:n-word-bytes)))
2488 (char-code (the character value))))
2489 (#.sb!vm:unsigned-stack-sc-number
2490 (setf (sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2491 sb!vm:n-word-bytes)))
2492 (the (unsigned-byte 32) value)))
2493 (#.sb!vm:signed-stack-sc-number
2494 (setf (signed-sap-ref-32
2495 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2496 sb!vm:n-word-bytes)))
2497 (the (signed-byte 32) value)))
2498 (#.sb!vm:sap-stack-sc-number
2499 (setf (sap-ref-sap fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2500 sb!vm:n-word-bytes)))
2501 (the system-area-pointer value))))))
2503 ;;; The method for setting and accessing COMPILED-DEBUG-VAR values use
2504 ;;; this to determine if the value stored is the actual value or an
2505 ;;; indirection cell.
2506 (defun indirect-value-cell-p (x)
2507 (and (= (lowtag-of x) sb!vm:other-pointer-lowtag)
2508 (= (widetag-of x) sb!vm:value-cell-header-widetag)))
2510 ;;; Return three values reflecting the validity of DEBUG-VAR's value
2511 ;;; at BASIC-CODE-LOCATION:
2512 ;;; :VALID The value is known to be available.
2513 ;;; :INVALID The value is known to be unavailable.
2514 ;;; :UNKNOWN The value's availability is unknown.
2516 ;;; If the variable is always alive, then it is valid. If the
2517 ;;; code-location is unknown, then the variable's validity is
2518 ;;; :unknown. Once we've called CODE-LOCATION-UNKNOWN-P, we know the
2519 ;;; live-set information has been cached in the code-location.
2520 (defun debug-var-validity (debug-var basic-code-location)
2521 (etypecase debug-var
2523 (compiled-debug-var-validity debug-var basic-code-location))
2524 ;; (There used to be more cases back before sbcl-0.7.0, when
2525 ;; we did special tricks to debug the IR1 interpreter.)
2528 ;;; This is the method for DEBUG-VAR-VALIDITY for COMPILED-DEBUG-VARs.
2529 ;;; For safety, make sure basic-code-location is what we think.
2530 (defun compiled-debug-var-validity (debug-var basic-code-location)
2531 (declare (type compiled-code-location basic-code-location))
2532 (cond ((debug-var-alive-p debug-var)
2533 (let ((debug-fun (code-location-debug-fun basic-code-location)))
2534 (if (>= (compiled-code-location-pc basic-code-location)
2535 (sb!c::compiled-debug-fun-start-pc
2536 (compiled-debug-fun-compiler-debug-fun debug-fun)))
2539 ((code-location-unknown-p basic-code-location) :unknown)
2541 (let ((pos (position debug-var
2542 (debug-fun-debug-vars
2543 (code-location-debug-fun
2544 basic-code-location)))))
2546 (error 'unknown-debug-var
2547 :debug-var debug-var
2549 (code-location-debug-fun basic-code-location)))
2550 ;; There must be live-set info since basic-code-location is known.
2551 (if (zerop (sbit (compiled-code-location-live-set
2552 basic-code-location)
2559 ;;; This code produces and uses what we call source-paths. A
2560 ;;; source-path is a list whose first element is a form number as
2561 ;;; returned by CODE-LOCATION-FORM-NUMBER and whose last element is a
2562 ;;; top level form number as returned by
2563 ;;; CODE-LOCATION-TOPLEVEL-FORM-NUMBER. The elements from the last to
2564 ;;; the first, exclusively, are the numbered subforms into which to
2565 ;;; descend. For example:
2567 ;;; (let ((a (aref x 3)))
2569 ;;; The call to AREF in this example is form number 5. Assuming this
2570 ;;; DEFUN is the 11'th top level form, the source-path for the AREF
2571 ;;; call is as follows:
2573 ;;; Given the DEFUN, 3 gets you the LET, 1 gets you the bindings, 0
2574 ;;; gets the first binding, and 1 gets the AREF form.
2576 ;;; temporary buffer used to build form-number => source-path translation in
2577 ;;; FORM-NUMBER-TRANSLATIONS
2578 (defvar *form-number-temp* (make-array 10 :fill-pointer 0 :adjustable t))
2580 ;;; table used to detect CAR circularities in FORM-NUMBER-TRANSLATIONS
2581 (defvar *form-number-circularity-table* (make-hash-table :test 'eq))
2583 ;;; This returns a table mapping form numbers to source-paths. A
2584 ;;; source-path indicates a descent into the TOPLEVEL-FORM form,
2585 ;;; going directly to the subform corressponding to the form number.
2587 ;;; The vector elements are in the same format as the compiler's
2588 ;;; NODE-SOURCE-PATH; that is, the first element is the form number and
2589 ;;; the last is the TOPLEVEL-FORM number.
2590 (defun form-number-translations (form tlf-number)
2591 (clrhash *form-number-circularity-table*)
2592 (setf (fill-pointer *form-number-temp*) 0)
2593 (sub-translate-form-numbers form (list tlf-number))
2594 (coerce *form-number-temp* 'simple-vector))
2595 (defun sub-translate-form-numbers (form path)
2596 (unless (gethash form *form-number-circularity-table*)
2597 (setf (gethash form *form-number-circularity-table*) t)
2598 (vector-push-extend (cons (fill-pointer *form-number-temp*) path)
2603 (declare (fixnum pos))
2606 (when (atom subform) (return))
2607 (let ((fm (car subform)))
2609 (sub-translate-form-numbers fm (cons pos path)))
2611 (setq subform (cdr subform))
2612 (when (eq subform trail) (return)))))
2616 (setq trail (cdr trail)))))))
2618 ;;; FORM is a top level form, and path is a source-path into it. This
2619 ;;; returns the form indicated by the source-path. Context is the
2620 ;;; number of enclosing forms to return instead of directly returning
2621 ;;; the source-path form. When context is non-zero, the form returned
2622 ;;; contains a marker, #:****HERE****, immediately before the form
2623 ;;; indicated by path.
2624 (defun source-path-context (form path context)
2625 (declare (type unsigned-byte context))
2626 ;; Get to the form indicated by path or the enclosing form indicated
2627 ;; by context and path.
2628 (let ((path (reverse (butlast (cdr path)))))
2629 (dotimes (i (- (length path) context))
2630 (let ((index (first path)))
2631 (unless (and (listp form) (< index (length form)))
2632 (error "Source path no longer exists."))
2633 (setq form (elt form index))
2634 (setq path (rest path))))
2635 ;; Recursively rebuild the source form resulting from the above
2636 ;; descent, copying the beginning of each subform up to the next
2637 ;; subform we descend into according to path. At the bottom of the
2638 ;; recursion, we return the form indicated by path preceded by our
2639 ;; marker, and this gets spliced into the resulting list structure
2640 ;; on the way back up.
2641 (labels ((frob (form path level)
2642 (if (or (zerop level) (null path))
2645 `(#:***here*** ,form))
2646 (let ((n (first path)))
2647 (unless (and (listp form) (< n (length form)))
2648 (error "Source path no longer exists."))
2649 (let ((res (frob (elt form n) (rest path) (1- level))))
2650 (nconc (subseq form 0 n)
2651 (cons res (nthcdr (1+ n) form))))))))
2652 (frob form path context))))
2654 ;;;; PREPROCESS-FOR-EVAL
2656 ;;; Return a function of one argument that evaluates form in the
2657 ;;; lexical context of the BASIC-CODE-LOCATION LOC, or signal a
2658 ;;; NO-DEBUG-VARS condition when the LOC's DEBUG-FUN has no
2659 ;;; DEBUG-VAR information available.
2661 ;;; The returned function takes the frame to get values from as its
2662 ;;; argument, and it returns the values of FORM. The returned function
2663 ;;; can signal the following conditions: INVALID-VALUE,
2664 ;;; AMBIGUOUS-VAR-NAME, and FRAME-FUN-MISMATCH.
2665 (defun preprocess-for-eval (form loc)
2666 (declare (type code-location loc))
2667 (let ((n-frame (gensym))
2668 (fun (code-location-debug-fun loc)))
2669 (unless (debug-var-info-available fun)
2670 (debug-signal 'no-debug-vars :debug-fun fun))
2671 (sb!int:collect ((binds)
2673 (do-debug-fun-vars (var fun)
2674 (let ((validity (debug-var-validity var loc)))
2675 (unless (eq validity :invalid)
2676 (let* ((sym (debug-var-symbol var))
2677 (found (assoc sym (binds))))
2679 (setf (second found) :ambiguous)
2680 (binds (list sym validity var)))))))
2681 (dolist (bind (binds))
2682 (let ((name (first bind))
2684 (ecase (second bind)
2686 (specs `(,name (debug-var-value ',var ,n-frame))))
2688 (specs `(,name (debug-signal 'invalid-value
2692 (specs `(,name (debug-signal 'ambiguous-var-name
2694 :frame ,n-frame)))))))
2695 (let ((res (coerce `(lambda (,n-frame)
2696 (declare (ignorable ,n-frame))
2697 (symbol-macrolet ,(specs) ,form))
2700 ;; This prevents these functions from being used in any
2701 ;; location other than a function return location, so maybe
2702 ;; this should only check whether FRAME's DEBUG-FUN is the
2704 (unless (code-location= (frame-code-location frame) loc)
2705 (debug-signal 'frame-fun-mismatch
2706 :code-location loc :form form :frame frame))
2707 (funcall res frame))))))
2711 ;;;; user-visible interface
2713 ;;; Create and return a breakpoint. When program execution encounters
2714 ;;; the breakpoint, the system calls HOOK-FUN. HOOK-FUN takes the
2715 ;;; current frame for the function in which the program is running and
2716 ;;; the breakpoint object.
2718 ;;; WHAT and KIND determine where in a function the system invokes
2719 ;;; HOOK-FUN. WHAT is either a code-location or a DEBUG-FUN. KIND is
2720 ;;; one of :CODE-LOCATION, :FUN-START, or :FUN-END. Since the starts
2721 ;;; and ends of functions may not have code-locations representing
2722 ;;; them, designate these places by supplying WHAT as a DEBUG-FUN and
2723 ;;; KIND indicating the :FUN-START or :FUN-END. When WHAT is a
2724 ;;; DEBUG-FUN and kind is :FUN-END, then HOOK-FUN must take two
2725 ;;; additional arguments, a list of values returned by the function
2726 ;;; and a FUN-END-COOKIE.
2728 ;;; INFO is information supplied by and used by the user.
2730 ;;; FUN-END-COOKIE is a function. To implement :FUN-END
2731 ;;; breakpoints, the system uses starter breakpoints to establish the
2732 ;;; :FUN-END breakpoint for each invocation of the function. Upon
2733 ;;; each entry, the system creates a unique cookie to identify the
2734 ;;; invocation, and when the user supplies a function for this
2735 ;;; argument, the system invokes it on the frame and the cookie. The
2736 ;;; system later invokes the :FUN-END breakpoint hook on the same
2737 ;;; cookie. The user may save the cookie for comparison in the hook
2740 ;;; Signal an error if WHAT is an unknown code-location.
2741 (defun make-breakpoint (hook-fun what
2742 &key (kind :code-location) info fun-end-cookie)
2745 (when (code-location-unknown-p what)
2746 (error "cannot make a breakpoint at an unknown code location: ~S"
2748 (aver (eq kind :code-location))
2749 (let ((bpt (%make-breakpoint hook-fun what kind info)))
2751 (compiled-code-location
2752 ;; This slot is filled in due to calling CODE-LOCATION-UNKNOWN-P.
2753 (when (eq (compiled-code-location-kind what) :unknown-return)
2754 (let ((other-bpt (%make-breakpoint hook-fun what
2755 :unknown-return-partner
2757 (setf (breakpoint-unknown-return-partner bpt) other-bpt)
2758 (setf (breakpoint-unknown-return-partner other-bpt) bpt))))
2759 ;; (There used to be more cases back before sbcl-0.7.0,,
2760 ;; when we did special tricks to debug the IR1
2767 (%make-breakpoint hook-fun what kind info))
2769 (unless (eq (sb!c::compiled-debug-fun-returns
2770 (compiled-debug-fun-compiler-debug-fun what))
2772 (error ":FUN-END breakpoints are currently unsupported ~
2773 for the known return convention."))
2775 (let* ((bpt (%make-breakpoint hook-fun what kind info))
2776 (starter (compiled-debug-fun-end-starter what)))
2778 (setf starter (%make-breakpoint #'list what :fun-start nil))
2779 (setf (breakpoint-hook-fun starter)
2780 (fun-end-starter-hook starter what))
2781 (setf (compiled-debug-fun-end-starter what) starter))
2782 (setf (breakpoint-start-helper bpt) starter)
2783 (push bpt (breakpoint-%info starter))
2784 (setf (breakpoint-cookie-fun bpt) fun-end-cookie)
2787 ;;; These are unique objects created upon entry into a function by a
2788 ;;; :FUN-END breakpoint's starter hook. These are only created
2789 ;;; when users supply :FUN-END-COOKIE to MAKE-BREAKPOINT. Also,
2790 ;;; the :FUN-END breakpoint's hook is called on the same cookie
2791 ;;; when it is created.
2792 (defstruct (fun-end-cookie
2793 (:print-object (lambda (obj str)
2794 (print-unreadable-object (obj str :type t))))
2795 (:constructor make-fun-end-cookie (bogus-lra debug-fun))
2797 ;; a pointer to the bogus-lra created for :FUN-END breakpoints
2799 ;; the DEBUG-FUN associated with this cookie
2802 ;;; This maps bogus-lra-components to cookies, so that
2803 ;;; HANDLE-FUN-END-BREAKPOINT can find the appropriate cookie for the
2804 ;;; breakpoint hook.
2805 (defvar *fun-end-cookies* (make-hash-table :test 'eq))
2807 ;;; This returns a hook function for the start helper breakpoint
2808 ;;; associated with a :FUN-END breakpoint. The returned function
2809 ;;; makes a fake LRA that all returns go through, and this piece of
2810 ;;; fake code actually breaks. Upon return from the break, the code
2811 ;;; provides the returnee with any values. Since the returned function
2812 ;;; effectively activates FUN-END-BPT on each entry to DEBUG-FUN's
2813 ;;; function, we must establish breakpoint-data about FUN-END-BPT.
2814 (defun fun-end-starter-hook (starter-bpt debug-fun)
2815 (declare (type breakpoint starter-bpt)
2816 (type compiled-debug-fun debug-fun))
2817 (lambda (frame breakpoint)
2818 (declare (ignore breakpoint)
2820 (let ((lra-sc-offset
2821 (sb!c::compiled-debug-fun-return-pc
2822 (compiled-debug-fun-compiler-debug-fun debug-fun))))
2823 (multiple-value-bind (lra component offset)
2825 (get-context-value frame
2828 (setf (get-context-value frame
2832 (let ((end-bpts (breakpoint-%info starter-bpt)))
2833 (let ((data (breakpoint-data component offset)))
2834 (setf (breakpoint-data-breakpoints data) end-bpts)
2835 (dolist (bpt end-bpts)
2836 (setf (breakpoint-internal-data bpt) data)))
2837 (let ((cookie (make-fun-end-cookie lra debug-fun)))
2838 (setf (gethash component *fun-end-cookies*) cookie)
2839 (dolist (bpt end-bpts)
2840 (let ((fun (breakpoint-cookie-fun bpt)))
2841 (when fun (funcall fun frame cookie))))))))))
2843 ;;; This takes a FUN-END-COOKIE and a frame, and it returns
2844 ;;; whether the cookie is still valid. A cookie becomes invalid when
2845 ;;; the frame that established the cookie has exited. Sometimes cookie
2846 ;;; holders are unaware of cookie invalidation because their
2847 ;;; :FUN-END breakpoint hooks didn't run due to THROW'ing.
2849 ;;; This takes a frame as an efficiency hack since the user probably
2850 ;;; has a frame object in hand when using this routine, and it saves
2851 ;;; repeated parsing of the stack and consing when asking whether a
2852 ;;; series of cookies is valid.
2853 (defun fun-end-cookie-valid-p (frame cookie)
2854 (let ((lra (fun-end-cookie-bogus-lra cookie))
2855 (lra-sc-offset (sb!c::compiled-debug-fun-return-pc
2856 (compiled-debug-fun-compiler-debug-fun
2857 (fun-end-cookie-debug-fun cookie)))))
2858 (do ((frame frame (frame-down frame)))
2860 (when (and (compiled-frame-p frame)
2861 (#-x86 eq #+x86 sap=
2863 (get-context-value frame lra-save-offset lra-sc-offset)))
2866 ;;;; ACTIVATE-BREAKPOINT
2868 ;;; Cause the system to invoke the breakpoint's hook function until
2869 ;;; the next call to DEACTIVATE-BREAKPOINT or DELETE-BREAKPOINT. The
2870 ;;; system invokes breakpoint hook functions in the opposite order
2871 ;;; that you activate them.
2872 (defun activate-breakpoint (breakpoint)
2873 (when (eq (breakpoint-status breakpoint) :deleted)
2874 (error "cannot activate a deleted breakpoint: ~S" breakpoint))
2875 (unless (eq (breakpoint-status breakpoint) :active)
2876 (ecase (breakpoint-kind breakpoint)
2878 (let ((loc (breakpoint-what breakpoint)))
2880 (compiled-code-location
2881 (activate-compiled-code-location-breakpoint breakpoint)
2882 (let ((other (breakpoint-unknown-return-partner breakpoint)))
2884 (activate-compiled-code-location-breakpoint other))))
2885 ;; (There used to be more cases back before sbcl-0.7.0, when
2886 ;; we did special tricks to debug the IR1 interpreter.)
2889 (etypecase (breakpoint-what breakpoint)
2891 (activate-compiled-fun-start-breakpoint breakpoint))
2892 ;; (There used to be more cases back before sbcl-0.7.0, when
2893 ;; we did special tricks to debug the IR1 interpreter.)
2896 (etypecase (breakpoint-what breakpoint)
2898 (let ((starter (breakpoint-start-helper breakpoint)))
2899 (unless (eq (breakpoint-status starter) :active)
2900 ;; may already be active by some other :FUN-END breakpoint
2901 (activate-compiled-fun-start-breakpoint starter)))
2902 (setf (breakpoint-status breakpoint) :active))
2903 ;; (There used to be more cases back before sbcl-0.7.0, when
2904 ;; we did special tricks to debug the IR1 interpreter.)
2908 (defun activate-compiled-code-location-breakpoint (breakpoint)
2909 (declare (type breakpoint breakpoint))
2910 (let ((loc (breakpoint-what breakpoint)))
2911 (declare (type compiled-code-location loc))
2912 (sub-activate-breakpoint
2914 (breakpoint-data (compiled-debug-fun-component
2915 (code-location-debug-fun loc))
2916 (+ (compiled-code-location-pc loc)
2917 (if (or (eq (breakpoint-kind breakpoint)
2918 :unknown-return-partner)
2919 (eq (compiled-code-location-kind loc)
2920 :single-value-return))
2921 sb!vm:single-value-return-byte-offset
2924 (defun activate-compiled-fun-start-breakpoint (breakpoint)
2925 (declare (type breakpoint breakpoint))
2926 (let ((debug-fun (breakpoint-what breakpoint)))
2927 (sub-activate-breakpoint
2929 (breakpoint-data (compiled-debug-fun-component debug-fun)
2930 (sb!c::compiled-debug-fun-start-pc
2931 (compiled-debug-fun-compiler-debug-fun
2934 (defun sub-activate-breakpoint (breakpoint data)
2935 (declare (type breakpoint breakpoint)
2936 (type breakpoint-data data))
2937 (setf (breakpoint-status breakpoint) :active)
2939 (unless (breakpoint-data-breakpoints data)
2940 (setf (breakpoint-data-instruction data)
2942 (breakpoint-install (get-lisp-obj-address
2943 (breakpoint-data-component data))
2944 (breakpoint-data-offset data)))))
2945 (setf (breakpoint-data-breakpoints data)
2946 (append (breakpoint-data-breakpoints data) (list breakpoint)))
2947 (setf (breakpoint-internal-data breakpoint) data)))
2949 ;;;; DEACTIVATE-BREAKPOINT
2951 ;;; Stop the system from invoking the breakpoint's hook function.
2952 (defun deactivate-breakpoint (breakpoint)
2953 (when (eq (breakpoint-status breakpoint) :active)
2955 (let ((loc (breakpoint-what breakpoint)))
2957 ((or compiled-code-location compiled-debug-fun)
2958 (deactivate-compiled-breakpoint breakpoint)
2959 (let ((other (breakpoint-unknown-return-partner breakpoint)))
2961 (deactivate-compiled-breakpoint other))))
2962 ;; (There used to be more cases back before sbcl-0.7.0, when
2963 ;; we did special tricks to debug the IR1 interpreter.)
2967 (defun deactivate-compiled-breakpoint (breakpoint)
2968 (if (eq (breakpoint-kind breakpoint) :fun-end)
2969 (let ((starter (breakpoint-start-helper breakpoint)))
2970 (unless (find-if (lambda (bpt)
2971 (and (not (eq bpt breakpoint))
2972 (eq (breakpoint-status bpt) :active)))
2973 (breakpoint-%info starter))
2974 (deactivate-compiled-breakpoint starter)))
2975 (let* ((data (breakpoint-internal-data breakpoint))
2976 (bpts (delete breakpoint (breakpoint-data-breakpoints data))))
2977 (setf (breakpoint-internal-data breakpoint) nil)
2978 (setf (breakpoint-data-breakpoints data) bpts)
2981 (breakpoint-remove (get-lisp-obj-address
2982 (breakpoint-data-component data))
2983 (breakpoint-data-offset data)
2984 (breakpoint-data-instruction data)))
2985 (delete-breakpoint-data data))))
2986 (setf (breakpoint-status breakpoint) :inactive)
2989 ;;;; BREAKPOINT-INFO
2991 ;;; Return the user-maintained info associated with breakpoint. This
2993 (defun breakpoint-info (breakpoint)
2994 (breakpoint-%info breakpoint))
2995 (defun %set-breakpoint-info (breakpoint value)
2996 (setf (breakpoint-%info breakpoint) value)
2997 (let ((other (breakpoint-unknown-return-partner breakpoint)))
2999 (setf (breakpoint-%info other) value))))
3001 ;;;; BREAKPOINT-ACTIVE-P and DELETE-BREAKPOINT
3003 (defun breakpoint-active-p (breakpoint)
3004 (ecase (breakpoint-status breakpoint)
3006 ((:inactive :deleted) nil)))
3008 ;;; Free system storage and remove computational overhead associated
3009 ;;; with breakpoint. After calling this, breakpoint is completely
3010 ;;; impotent and can never become active again.
3011 (defun delete-breakpoint (breakpoint)
3012 (let ((status (breakpoint-status breakpoint)))
3013 (unless (eq status :deleted)
3014 (when (eq status :active)
3015 (deactivate-breakpoint breakpoint))
3016 (setf (breakpoint-status breakpoint) :deleted)
3017 (let ((other (breakpoint-unknown-return-partner breakpoint)))
3019 (setf (breakpoint-status other) :deleted)))
3020 (when (eq (breakpoint-kind breakpoint) :fun-end)
3021 (let* ((starter (breakpoint-start-helper breakpoint))
3022 (breakpoints (delete breakpoint
3023 (the list (breakpoint-info starter)))))
3024 (setf (breakpoint-info starter) breakpoints)
3026 (delete-breakpoint starter)
3027 (setf (compiled-debug-fun-end-starter
3028 (breakpoint-what breakpoint))
3032 ;;;; C call out stubs
3034 ;;; This actually installs the break instruction in the component. It
3035 ;;; returns the overwritten bits. You must call this in a context in
3036 ;;; which GC is disabled, so that Lisp doesn't move objects around
3037 ;;; that C is pointing to.
3038 (sb!alien:define-alien-routine "breakpoint_install" sb!alien:unsigned-long
3039 (code-obj sb!alien:unsigned-long)
3040 (pc-offset sb!alien:int))
3042 ;;; This removes the break instruction and replaces the original
3043 ;;; instruction. You must call this in a context in which GC is disabled
3044 ;;; so Lisp doesn't move objects around that C is pointing to.
3045 (sb!alien:define-alien-routine "breakpoint_remove" sb!alien:void
3046 (code-obj sb!alien:unsigned-long)
3047 (pc-offset sb!alien:int)
3048 (old-inst sb!alien:unsigned-long))
3050 (sb!alien:define-alien-routine "breakpoint_do_displaced_inst" sb!alien:void
3051 (scp (* os-context-t))
3052 (orig-inst sb!alien:unsigned-long))
3054 ;;;; breakpoint handlers (layer between C and exported interface)
3056 ;;; This maps components to a mapping of offsets to BREAKPOINT-DATAs.
3057 (defvar *component-breakpoint-offsets* (make-hash-table :test 'eq))
3059 ;;; This returns the BREAKPOINT-DATA object associated with component cross
3060 ;;; offset. If none exists, this makes one, installs it, and returns it.
3061 (defun breakpoint-data (component offset &optional (create t))
3062 (flet ((install-breakpoint-data ()
3064 (let ((data (make-breakpoint-data component offset)))
3065 (push (cons offset data)
3066 (gethash component *component-breakpoint-offsets*))
3068 (let ((offsets (gethash component *component-breakpoint-offsets*)))
3070 (let ((data (assoc offset offsets)))
3073 (install-breakpoint-data)))
3074 (install-breakpoint-data)))))
3076 ;;; We use this when there are no longer any active breakpoints
3077 ;;; corresponding to DATA.
3078 (defun delete-breakpoint-data (data)
3079 (let* ((component (breakpoint-data-component data))
3080 (offsets (delete (breakpoint-data-offset data)
3081 (gethash component *component-breakpoint-offsets*)
3084 (setf (gethash component *component-breakpoint-offsets*) offsets)
3085 (remhash component *component-breakpoint-offsets*)))
3088 ;;; The C handler for interrupts calls this when it has a
3089 ;;; debugging-tool break instruction. This does *not* handle all
3090 ;;; breaks; for example, it does not handle breaks for internal
3092 (defun handle-breakpoint (offset component signal-context)
3093 (let ((data (breakpoint-data component offset nil)))
3095 (error "unknown breakpoint in ~S at offset ~S"
3096 (debug-fun-name (debug-fun-from-pc component offset))
3098 (let ((breakpoints (breakpoint-data-breakpoints data)))
3099 (if (or (null breakpoints)
3100 (eq (breakpoint-kind (car breakpoints)) :fun-end))
3101 (handle-fun-end-breakpoint-aux breakpoints data signal-context)
3102 (handle-breakpoint-aux breakpoints data
3103 offset component signal-context)))))
3105 ;;; This holds breakpoint-datas while invoking the breakpoint hooks
3106 ;;; associated with that particular component and location. While they
3107 ;;; are executing, if we hit the location again, we ignore the
3108 ;;; breakpoint to avoid infinite recursion. fun-end breakpoints
3109 ;;; must work differently since the breakpoint-data is unique for each
3111 (defvar *executing-breakpoint-hooks* nil)
3113 ;;; This handles code-location and DEBUG-FUN :FUN-START
3115 (defun handle-breakpoint-aux (breakpoints data offset component signal-context)
3117 (bug "breakpoint that nobody wants"))
3118 (unless (member data *executing-breakpoint-hooks*)
3119 (let ((*executing-breakpoint-hooks* (cons data
3120 *executing-breakpoint-hooks*)))
3121 (invoke-breakpoint-hooks breakpoints component offset)))
3122 ;; At this point breakpoints may not hold the same list as
3123 ;; BREAKPOINT-DATA-BREAKPOINTS since invoking hooks may have allowed
3124 ;; a breakpoint deactivation. In fact, if all breakpoints were
3125 ;; deactivated then data is invalid since it was deleted and so the
3126 ;; correct one must be looked up if it is to be used. If there are
3127 ;; no more breakpoints active at this location, then the normal
3128 ;; instruction has been put back, and we do not need to
3129 ;; DO-DISPLACED-INST.
3130 (let ((data (breakpoint-data component offset nil)))
3131 (when (and data (breakpoint-data-breakpoints data))
3132 ;; The breakpoint is still active, so we need to execute the
3133 ;; displaced instruction and leave the breakpoint instruction
3134 ;; behind. The best way to do this is different on each machine,
3135 ;; so we just leave it up to the C code.
3136 (breakpoint-do-displaced-inst signal-context
3137 (breakpoint-data-instruction data))
3138 ;; Some platforms have no usable sigreturn() call. If your
3139 ;; implementation of arch_do_displaced_inst() doesn't sigreturn(),
3140 ;; add it to this list.
3141 #!-(or hpux irix x86 alpha)
3142 (error "BREAKPOINT-DO-DISPLACED-INST returned?"))))
3144 (defun invoke-breakpoint-hooks (breakpoints component offset)
3145 (let* ((debug-fun (debug-fun-from-pc component offset))
3146 (frame (do ((f (top-frame) (frame-down f)))
3147 ((eq debug-fun (frame-debug-fun f)) f))))
3148 (dolist (bpt breakpoints)
3149 (funcall (breakpoint-hook-fun bpt)
3151 ;; If this is an :UNKNOWN-RETURN-PARTNER, then pass the
3152 ;; hook function the original breakpoint, so that users
3153 ;; aren't forced to confront the fact that some
3154 ;; breakpoints really are two.
3155 (if (eq (breakpoint-kind bpt) :unknown-return-partner)
3156 (breakpoint-unknown-return-partner bpt)
3159 (defun handle-fun-end-breakpoint (offset component context)
3160 (let ((data (breakpoint-data component offset nil)))
3162 (error "unknown breakpoint in ~S at offset ~S"
3163 (debug-fun-name (debug-fun-from-pc component offset))
3165 (let ((breakpoints (breakpoint-data-breakpoints data)))
3167 (aver (eq (breakpoint-kind (car breakpoints)) :fun-end))
3168 (handle-fun-end-breakpoint-aux breakpoints data context)))))
3170 ;;; Either HANDLE-BREAKPOINT calls this for :FUN-END breakpoints
3171 ;;; [old C code] or HANDLE-FUN-END-BREAKPOINT calls this directly
3173 (defun handle-fun-end-breakpoint-aux (breakpoints data signal-context)
3174 (delete-breakpoint-data data)
3177 (declare (optimize (inhibit-warnings 3)))
3178 (sb!alien:sap-alien signal-context (* os-context-t))))
3179 (frame (do ((cfp (sb!vm:context-register scp sb!vm::cfp-offset))
3180 (f (top-frame) (frame-down f)))
3181 ((= cfp (sap-int (frame-pointer f))) f)
3182 (declare (type (unsigned-byte #.sb!vm:n-word-bits) cfp))))
3183 (component (breakpoint-data-component data))
3184 (cookie (gethash component *fun-end-cookies*)))
3185 (remhash component *fun-end-cookies*)
3186 (dolist (bpt breakpoints)
3187 (funcall (breakpoint-hook-fun bpt)
3189 (get-fun-end-breakpoint-values scp)
3192 (defun get-fun-end-breakpoint-values (scp)
3193 (let ((ocfp (int-sap (sb!vm:context-register
3195 #!-x86 sb!vm::ocfp-offset
3196 #!+x86 sb!vm::ebx-offset)))
3197 (nargs (make-lisp-obj
3198 (sb!vm:context-register scp sb!vm::nargs-offset)))
3199 (reg-arg-offsets '#.sb!vm::*register-arg-offsets*)
3202 (dotimes (arg-num nargs)
3203 (push (if reg-arg-offsets
3205 (sb!vm:context-register scp (pop reg-arg-offsets)))
3206 (stack-ref ocfp arg-num))
3208 (nreverse results)))
3210 ;;;; MAKE-BOGUS-LRA (used for :FUN-END breakpoints)
3212 (defconstant bogus-lra-constants
3214 (defconstant known-return-p-slot
3215 (+ sb!vm:code-constants-offset #!-x86 1 #!+x86 2))
3217 ;;; Make a bogus LRA object that signals a breakpoint trap when
3218 ;;; returned to. If the breakpoint trap handler returns, REAL-LRA is
3219 ;;; returned to. Three values are returned: the bogus LRA object, the
3220 ;;; code component it is part of, and the PC offset for the trap
3222 (defun make-bogus-lra (real-lra &optional known-return-p)
3224 (let* ((src-start (foreign-symbol-address "fun_end_breakpoint_guts"))
3225 (src-end (foreign-symbol-address "fun_end_breakpoint_end"))
3226 (trap-loc (foreign-symbol-address "fun_end_breakpoint_trap"))
3227 (length (sap- src-end src-start))
3230 #!-(and x86 gencgc) sb!c:allocate-code-object
3231 #!+(and x86 gencgc) sb!c::allocate-dynamic-code-object
3232 (1+ bogus-lra-constants)
3234 (dst-start (code-instructions code-object)))
3235 (declare (type system-area-pointer
3236 src-start src-end dst-start trap-loc)
3237 (type index length))
3238 (setf (%code-debug-info code-object) :bogus-lra)
3239 (setf (code-header-ref code-object sb!vm:code-trace-table-offset-slot)
3242 (setf (code-header-ref code-object real-lra-slot) real-lra)
3244 (multiple-value-bind (offset code) (compute-lra-data-from-pc real-lra)
3245 (setf (code-header-ref code-object real-lra-slot) code)
3246 (setf (code-header-ref code-object (1+ real-lra-slot)) offset))
3247 (setf (code-header-ref code-object known-return-p-slot)
3249 (system-area-copy src-start 0 dst-start 0 (* length sb!vm:n-byte-bits))
3250 (sb!vm:sanctify-for-execution code-object)
3252 (values dst-start code-object (sap- trap-loc src-start))
3254 (let ((new-lra (make-lisp-obj (+ (sap-int dst-start)
3255 sb!vm:other-pointer-lowtag))))
3258 (logandc2 (+ sb!vm:code-constants-offset bogus-lra-constants 1)
3260 (sb!vm:sanctify-for-execution code-object)
3261 (values new-lra code-object (sap- trap-loc src-start))))))
3265 ;;; This appears here because it cannot go with the DEBUG-FUN
3266 ;;; interface since DO-DEBUG-BLOCK-LOCATIONS isn't defined until after
3267 ;;; the DEBUG-FUN routines.
3269 ;;; Return a code-location before the body of a function and after all
3270 ;;; the arguments are in place; or if that location can't be
3271 ;;; determined due to a lack of debug information, return NIL.
3272 (defun debug-fun-start-location (debug-fun)
3273 (etypecase debug-fun
3275 (code-location-from-pc debug-fun
3276 (sb!c::compiled-debug-fun-start-pc
3277 (compiled-debug-fun-compiler-debug-fun
3280 ;; (There used to be more cases back before sbcl-0.7.0, when
3281 ;; we did special tricks to debug the IR1 interpreter.)
3284 (defun print-code-locations (function)
3285 (let ((debug-fun (fun-debug-fun function)))
3286 (do-debug-fun-blocks (block debug-fun)
3287 (do-debug-block-locations (loc block)
3288 (fill-in-code-location loc)
3289 (format t "~S code location at ~W"
3290 (compiled-code-location-kind loc)
3291 (compiled-code-location-pc loc))
3292 (sb!debug::print-code-location-source-form loc 0)