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-variable-name (debug-condition)
109 ((name :reader ambiguous-variable-name-name :initarg :name)
110 (frame :reader ambiguous-variable-name-frame :initarg :frame))
111 (:report (lambda (condition stream)
112 (format stream "~&~S names more than one valid variable in ~S."
113 (ambiguous-variable-name-name condition)
114 (ambiguous-variable-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 (required-argument) :type symbol)
199 ;; a unique integer identification relative to other variables with the same
201 (id 0 :type sb!c::index)
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-function-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 sb!c::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-function 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
402 ;; as values to return for the function containing the breakpoint.
403 ;; :FUN-END breakpoint hook-functions also take a cookie
404 ;; argument. See COOKIE-FUN slot.
405 (hook-function nil :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 sb!c::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 sb!c::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
487 (pc nil :type sb!c::index)
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:def-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: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+ sb!vm::ocfp-save-offset) 4))))
603 (lisp-ra (sap-ref-sap fp (- (* (1+ sb!vm::return-pc-save-offset)
605 (c-ocfp (sap-ref-sap fp (* 0 sb!vm:word-bytes)))
606 (c-ra (sap-ref-sap fp (* 1 sb!vm: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 (/show0 "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 (/show0 "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 (/show0 "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 sb!vm::ocfp-save-offset
701 (sb!c::compiled-debug-fun-old-fp c-d-f)))
703 frame sb!vm::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 (* sb!vm::ocfp-save-offset
719 (sap-ref-32 fp (* sb!vm::ocfp-save-offset
722 (stack-ref fp sb!vm::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)
748 (#.sb!vm::ocfp-save-offset
749 (stack-ref pointer stack-slot))
750 (#.sb!vm::lra-save-offset
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)
772 (#.sb!vm::ocfp-save-offset
773 (setf (stack-ref pointer stack-slot) value))
774 (#.sb!vm::lra-save-offset
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 nil 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+ sb!vm::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)
836 (defun compute-calling-frame (caller ra up-frame)
837 (declare (type system-area-pointer caller ra))
838 (/show0 "entering COMPUTE-CALLING-FRAME")
839 (when (cstack-pointer-valid-p caller)
841 ;; First check for an escaped frame.
842 (multiple-value-bind (code pc-offset escaped) (find-escaped-frame caller)
845 (/show0 "in CODE clause")
846 ;; If it's escaped it may be a function end breakpoint trap.
847 (when (and (code-component-p code)
848 (eq (%code-debug-info code) :bogus-lra))
849 ;; If :bogus-lra grab the real lra.
850 (setq pc-offset (code-header-ref
851 code (1+ real-lra-slot)))
852 (setq code (code-header-ref code real-lra-slot))
855 (/show0 "in T clause")
857 (multiple-value-setq (pc-offset code)
858 (compute-lra-data-from-pc ra))
860 (setf code :foreign-function
864 (let ((d-fun (case code
866 (make-bogus-debug-fun
867 "undefined function"))
869 (make-bogus-debug-fun
870 "foreign function call land"))
872 (make-bogus-debug-fun
873 "bogus stack frame"))
875 (debug-fun-from-pc code pc-offset)))))
876 (/show0 "returning MAKE-COMPILED-FRAME from COMPUTE-CALLING-FRAME")
877 (make-compiled-frame caller up-frame d-fun
878 (code-location-from-pc d-fun pc-offset
880 (if up-frame (1+ (frame-number up-frame)) 0)
884 (defun find-escaped-frame (frame-pointer)
885 (declare (type system-area-pointer frame-pointer))
886 (/show0 "entering FIND-ESCAPED-FRAME")
887 (dotimes (index *free-interrupt-context-index* (values nil 0 nil))
889 ((lisp-interrupt-contexts (array (* os-context-t) nil) :extern))
890 (/show0 "at head of WITH-ALIEN")
891 (let ((context (sb!alien:deref lisp-interrupt-contexts index)))
892 (/show0 "got CONTEXT")
893 (when (= (sap-int frame-pointer)
894 (sb!vm:context-register context sb!vm::cfp-offset))
896 (/show0 "in WITHOUT-GCING")
897 (let* ((component-ptr (component-ptr-from-pc
898 (sb!vm:context-pc context)))
899 (code (unless (sap= component-ptr (int-sap #x0))
900 (component-from-component-ptr component-ptr))))
903 (return (values code 0 context)))
904 (let* ((code-header-len (* (get-header-data code)
907 (- (sap-int (sb!vm:context-pc context))
908 (- (get-lisp-obj-address code)
909 sb!vm:other-pointer-lowtag)
911 (/show "got PC-OFFSET")
912 (unless (<= 0 pc-offset
913 (* (code-header-ref code sb!vm:code-code-size-slot)
915 ;; We were in an assembly routine. Therefore, use the
918 ;; FIXME: Should this be WARN or ERROR or what?
919 (format t "** pc-offset ~S not in code obj ~S?~%"
921 (/show0 "returning from FIND-ESCAPED-FRAME")
923 (values code pc-offset context))))))))))
926 (defun find-escaped-frame (frame-pointer)
927 (declare (type system-area-pointer frame-pointer))
928 (dotimes (index *free-interrupt-context-index* (values nil 0 nil))
930 ((lisp-interrupt-contexts (array (* os-context-t) nil) :extern))
931 (let ((scp (sb!alien:deref lisp-interrupt-contexts index)))
932 (when (= (sap-int frame-pointer)
933 (sb!vm:context-register scp sb!vm::cfp-offset))
935 (let ((code (code-object-from-bits
936 (sb!vm:context-register scp sb!vm::code-offset))))
938 (return (values code 0 scp)))
939 (let* ((code-header-len (* (get-header-data code)
942 (- (sap-int (sb!vm:context-pc scp))
943 (- (get-lisp-obj-address code)
944 sb!vm:other-pointer-lowtag)
946 ;; Check to see whether we were executing in a branch
948 #!+(or pmax sgi) ; pmax only (and broken anyway)
949 (when (logbitp 31 (sb!alien:slot scp '%mips::sc-cause))
950 (incf pc-offset sb!vm:word-bytes))
951 (unless (<= 0 pc-offset
952 (* (code-header-ref code sb!vm:code-code-size-slot)
954 ;; We were in an assembly routine. Therefore, use the
957 (- (sb!vm:context-register scp sb!vm::lra-offset)
958 (get-lisp-obj-address code)
961 (if (eq (%code-debug-info code) :bogus-lra)
962 (let ((real-lra (code-header-ref code
964 (values (lra-code-header real-lra)
965 (get-header-data real-lra)
967 (values code pc-offset scp)))))))))))
969 ;;; Find the code object corresponding to the object represented by
970 ;;; bits and return it. We assume bogus functions correspond to the
971 ;;; undefined-function.
972 (defun code-object-from-bits (bits)
973 (declare (type (unsigned-byte 32) bits))
974 (let ((object (make-lisp-obj bits)))
975 (if (functionp object)
976 (or (fun-code-header object)
978 (let ((lowtag (get-lowtag object)))
979 (if (= lowtag sb!vm:other-pointer-lowtag)
980 (let ((type (get-type object)))
981 (cond ((= type sb!vm:code-header-type)
983 ((= type sb!vm:return-pc-header-type)
984 (lra-code-header object))
990 ;;; This returns a COMPILED-DEBUG-FUN for code and pc. We fetch the
991 ;;; SB!C::DEBUG-INFO and run down its FUN-MAP to get a
992 ;;; SB!C::COMPILED-DEBUG-FUN from the pc. The result only needs to
993 ;;; reference the component, for function constants, and the
994 ;;; SB!C::COMPILED-DEBUG-FUN.
995 (defun debug-fun-from-pc (component pc)
996 (let ((info (%code-debug-info component)))
999 (debug-signal 'no-debug-info :code-component component))
1000 ((eq info :bogus-lra)
1001 (make-bogus-debug-fun "function end breakpoint"))
1003 (let* ((fun-map (get-debug-info-fun-map info))
1004 (len (length fun-map)))
1005 (declare (type simple-vector fun-map))
1007 (make-compiled-debug-fun (svref fun-map 0) component)
1010 (>= pc (sb!c::compiled-debug-fun-elsewhere-pc
1011 (svref fun-map 0)))))
1012 (declare (type sb!int:index i))
1015 (< pc (if elsewhere-p
1016 (sb!c::compiled-debug-fun-elsewhere-pc
1017 (svref fun-map (1+ i)))
1018 (svref fun-map i))))
1019 (return (make-compiled-debug-fun
1020 (svref fun-map (1- i))
1024 ;;; This returns a code-location for the COMPILED-DEBUG-FUN,
1025 ;;; DEBUG-FUN, and the pc into its code vector. If we stopped at a
1026 ;;; breakpoint, find the CODE-LOCATION for that breakpoint. Otherwise,
1027 ;;; make an :UNSURE code location, so it can be filled in when we
1028 ;;; figure out what is going on.
1029 (defun code-location-from-pc (debug-fun pc escaped)
1030 (or (and (compiled-debug-fun-p debug-fun)
1032 (let ((data (breakpoint-data
1033 (compiled-debug-fun-component debug-fun)
1035 (when (and data (breakpoint-data-breakpoints data))
1036 (let ((what (breakpoint-what
1037 (first (breakpoint-data-breakpoints data)))))
1038 (when (compiled-code-location-p what)
1040 (make-compiled-code-location pc debug-fun)))
1042 ;;; Return an alist mapping catch tags to CODE-LOCATIONs. These are
1043 ;;; CODE-LOCATIONs at which execution would continue with frame as the
1044 ;;; top frame if someone threw to the corresponding tag.
1045 (defun frame-catches (frame)
1046 (let ((catch (descriptor-sap *current-catch-block*))
1048 (fp (frame-pointer frame)))
1050 (when (zerop (sap-int catch)) (return (nreverse res)))
1054 (* sb!vm:catch-block-current-cont-slot
1059 (* sb!vm:catch-block-current-cont-slot
1060 sb!vm:word-bytes))))
1062 (lra (stack-ref catch sb!vm:catch-block-entry-pc-slot))
1065 catch (* sb!vm:catch-block-entry-pc-slot
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:word-bytes))))
1084 (stack-ref catch sb!vm:catch-block-tag-slot)
1087 (sap-ref-32 catch (* sb!vm:catch-block-tag-slot
1089 (make-compiled-code-location
1090 offset (frame-debug-fun frame)))
1095 (* sb!vm:catch-block-previous-catch-slot
1100 (* sb!vm:catch-block-previous-catch-slot
1101 sb!vm: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-variables ((var debug-fun &optional result)
1128 (let ((vars (gensym))
1130 `(let ((,vars (debug-fun-debug-vars ,debug-fun)))
1131 (declare (type (or null simple-vector) ,vars))
1133 (dotimes (,i (length ,vars) ,result)
1134 (let ((,var (svref ,vars ,i)))
1138 ;;; Return the object of type FUNCTION associated with the DEBUG-FUN,
1139 ;;; or NIL if the function is unavailable or is non-existent as a user
1140 ;;; callable function object.
1141 (defun debug-fun-fun (debug-fun)
1142 (let ((cached-value (debug-fun-%function debug-fun)))
1143 (if (eq cached-value :unparsed)
1144 (setf (debug-fun-%function debug-fun)
1145 (etypecase debug-fun
1148 (compiled-debug-fun-component debug-fun))
1150 (sb!c::compiled-debug-fun-start-pc
1151 (compiled-debug-fun-compiler-debug-fun debug-fun))))
1152 (do ((entry (%code-entry-points component)
1153 (%simple-fun-next entry)))
1156 (sb!c::compiled-debug-fun-start-pc
1157 (compiled-debug-fun-compiler-debug-fun
1158 (fun-debug-fun entry))))
1160 (bogus-debug-fun nil)))
1163 ;;; Return the name of the function represented by DEBUG-FUN. This may
1164 ;;; be a string or a cons; do not assume it is a symbol.
1165 (defun debug-fun-name (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 (get-type fun)
1177 (#.sb!vm:closure-header-type
1178 (fun-debug-fun (%closure-fun fun)))
1179 (#.sb!vm:funcallable-instance-header-type
1180 (fun-debug-fun (funcallable-instance-fun fun)))
1181 ((#.sb!vm:simple-fun-header-type
1182 #.sb!vm:closure-fun-header-type)
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 (get-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:word-bytes)))))))
1207 ;;; Return the kind of the function, which is one of :OPTIONAL,
1208 ;;; :EXTERNAL, TOP-level, :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-variables (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-variable 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-variable (name variables &optional end)
1276 (declare (simple-vector variables)
1277 (simple-string name))
1278 (let ((name-len (length name)))
1279 (position name variables
1280 :test #'(lambda (x y)
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 ;;; This returns a SIMPLE-VECTOR of DEBUG-BLOCKs or NIL. NIL indicates
1479 ;;; there 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* ((debug-fun (compiled-debug-fun-compiler-debug-fun
1491 (var-count (length (debug-fun-debug-vars debug-fun)))
1492 (blocks (sb!c::compiled-debug-fun-blocks 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 debug-fun)))
1498 (unless blocks (return-from parse-compiled-debug-blocks nil))
1499 (macrolet ((aref+ (a i) `(prog1 (aref ,a ,i) (incf ,i))))
1500 (with-parsing-buffer (blocks-buffer locations-buffer)
1502 (len (length blocks))
1505 (when (>= i len) (return))
1506 (let ((succ-and-flags (aref+ blocks i))
1508 (declare (type (unsigned-byte 8) succ-and-flags)
1510 (dotimes (k (ldb sb!c::compiled-debug-block-nsucc-byte
1512 (push (sb!c::read-var-integer blocks i) successors))
1514 (dotimes (k (sb!c::read-var-integer blocks i)
1515 (result locations-buffer))
1516 (let ((kind (svref sb!c::*compiled-code-location-kinds*
1519 (sb!c::read-var-integer blocks i)))
1520 (tlf-offset (or tlf-number
1521 (sb!c::read-var-integer blocks
1523 (form-number (sb!c::read-var-integer blocks i))
1524 (live-set (sb!c::read-packed-bit-vector
1525 live-set-len blocks i)))
1526 (vector-push-extend (make-known-code-location
1527 pc debug-fun tlf-offset
1528 form-number live-set kind)
1530 (setf last-pc pc))))
1531 (block (make-compiled-debug-block
1532 locations successors
1534 sb!c::compiled-debug-block-elsewhere-p
1535 succ-and-flags))))))
1536 (vector-push-extend block blocks-buffer)
1537 (dotimes (k (length locations))
1538 (setf (code-location-%debug-block (svref locations k))
1540 (let ((res (result blocks-buffer)))
1541 (declare (simple-vector res))
1542 (dotimes (i (length res))
1543 (let* ((block (svref res i))
1545 (dolist (ele (debug-block-successors block))
1546 (push (svref res ele) succs))
1547 (setf (debug-block-successors block) succs)))
1550 ;;; The argument is a debug internals structure. This returns NIL if
1551 ;;; there is no variable information. It returns an empty
1552 ;;; simple-vector if there were no locals in the function. Otherwise
1553 ;;; it returns a SIMPLE-VECTOR of DEBUG-VARs.
1554 (defun debug-fun-debug-vars (debug-fun)
1555 (let ((vars (debug-fun-%debug-vars debug-fun)))
1556 (if (eq vars :unparsed)
1557 (setf (debug-fun-%debug-vars debug-fun)
1558 (etypecase debug-fun
1560 (parse-compiled-debug-vars debug-fun))
1561 (bogus-debug-fun nil)))
1564 ;;; VARS is the parsed variables for a minimal debug function. We need
1565 ;;; to assign names of the form ARG-NNN. We must pad with leading
1566 ;;; zeros, since the arguments must be in alphabetical order.
1567 (defun assign-minimal-var-names (vars)
1568 (declare (simple-vector vars))
1569 (let* ((len (length vars))
1570 (width (length (format nil "~D" (1- len)))))
1572 (setf (compiled-debug-var-symbol (svref vars i))
1573 (intern (format nil "ARG-~V,'0D" width i)
1574 ;; KLUDGE: It's somewhat nasty to have a bare
1575 ;; package name string here. It would be
1576 ;; nicer to have #.(FIND-PACKAGE "SB!DEBUG")
1577 ;; instead, since then at least it would transform
1578 ;; correctly under package renaming and stuff.
1579 ;; However, genesis can't handle dumped packages..
1582 ;; FIXME: Maybe this could be fixed by moving the
1583 ;; whole debug-int.lisp file to warm init? (after
1584 ;; which dumping a #.(FIND-PACKAGE ..) expression
1585 ;; would work fine) If this is possible, it would
1586 ;; probably be a good thing, since minimizing the
1587 ;; amount of stuff in cold init is basically good.
1588 (or (find-package "SB-DEBUG")
1589 (find-package "SB!DEBUG")))))))
1591 ;;; Parse the packed representation of DEBUG-VARs from
1592 ;;; DEBUG-FUN's SB!C::COMPILED-DEBUG-FUN, returning a vector
1593 ;;; of DEBUG-VARs, or NIL if there was no information to parse.
1594 (defun parse-compiled-debug-vars (debug-fun)
1595 (let* ((cdebug-fun (compiled-debug-fun-compiler-debug-fun
1597 (packed-vars (sb!c::compiled-debug-fun-variables cdebug-fun))
1598 (args-minimal (eq (sb!c::compiled-debug-fun-arguments cdebug-fun)
1602 (buffer (make-array 0 :fill-pointer 0 :adjustable t)))
1603 ((>= i (length packed-vars))
1604 (let ((result (coerce buffer 'simple-vector)))
1606 (assign-minimal-var-names result))
1608 (flet ((geti () (prog1 (aref packed-vars i) (incf i))))
1609 (let* ((flags (geti))
1610 (minimal (logtest sb!c::compiled-debug-var-minimal-p flags))
1611 (deleted (logtest sb!c::compiled-debug-var-deleted-p flags))
1612 (live (logtest sb!c::compiled-debug-var-environment-live
1614 (save (logtest sb!c::compiled-debug-var-save-loc-p flags))
1615 (symbol (if minimal nil (geti)))
1616 (id (if (logtest sb!c::compiled-debug-var-id-p flags)
1619 (sc-offset (if deleted 0 (geti)))
1620 (save-sc-offset (if save (geti) nil)))
1621 (aver (not (and args-minimal (not minimal))))
1622 (vector-push-extend (make-compiled-debug-var symbol
1629 ;;;; unpacking minimal debug functions
1631 ;;; Return a FUN-MAP for a given COMPILED-DEBUG-INFO object.
1632 (defun get-debug-info-fun-map (info)
1633 (declare (type sb!c::compiled-debug-info info))
1634 (let ((map (sb!c::compiled-debug-info-fun-map info)))
1635 ;; The old CMU CL had various hairy possibilities here, but in
1636 ;; SBCL we only use this one, right?
1637 (aver (simple-vector-p map))
1643 ;;; If we're sure of whether code-location is known, return T or NIL.
1644 ;;; If we're :UNSURE, then try to fill in the code-location's slots.
1645 ;;; This determines whether there is any debug-block information, and
1646 ;;; if code-location is known.
1648 ;;; ??? IF this conses closures every time it's called, then break off the
1649 ;;; :UNSURE part to get the HANDLER-CASE into another function.
1650 (defun code-location-unknown-p (basic-code-location)
1651 (ecase (code-location-%unknown-p basic-code-location)
1655 (setf (code-location-%unknown-p basic-code-location)
1656 (handler-case (not (fill-in-code-location basic-code-location))
1657 (no-debug-blocks () t))))))
1659 ;;; Return the DEBUG-BLOCK containing code-location if it is available.
1660 ;;; Some debug policies inhibit debug-block information, and if none
1661 ;;; is available, then this signals a NO-DEBUG-BLOCKS condition.
1662 (defun code-location-debug-block (basic-code-location)
1663 (let ((block (code-location-%debug-block basic-code-location)))
1664 (if (eq block :unparsed)
1665 (etypecase basic-code-location
1666 (compiled-code-location
1667 (compute-compiled-code-location-debug-block basic-code-location))
1668 ;; (There used to be more cases back before sbcl-0.7.0, when
1669 ;; we did special tricks to debug the IR1 interpreter.)
1673 ;;; Store and return BASIC-CODE-LOCATION's debug-block. We determines
1674 ;;; the correct one using the code-location's pc. We use
1675 ;;; DEBUG-FUN-DEBUG-BLOCKS to return the cached block information
1676 ;;; or signal a NO-DEBUG-BLOCKS condition. The blocks are sorted by
1677 ;;; their first code-location's pc, in ascending order. Therefore, as
1678 ;;; soon as we find a block that starts with a pc greater than
1679 ;;; basic-code-location's pc, we know the previous block contains the
1680 ;;; pc. If we get to the last block, then the code-location is either
1681 ;;; in the second to last block or the last block, and we have to be
1682 ;;; careful in determining this since the last block could be code at
1683 ;;; the end of the function. We have to check for the last block being
1684 ;;; code first in order to see how to compare the code-location's pc.
1685 (defun compute-compiled-code-location-debug-block (basic-code-location)
1686 (let* ((pc (compiled-code-location-pc basic-code-location))
1687 (debug-fun (code-location-debug-fun
1688 basic-code-location))
1689 (blocks (debug-fun-debug-blocks debug-fun))
1690 (len (length blocks)))
1691 (declare (simple-vector blocks))
1692 (setf (code-location-%debug-block basic-code-location)
1698 (let ((last (svref blocks end)))
1700 ((debug-block-elsewhere-p last)
1702 (sb!c::compiled-debug-fun-elsewhere-pc
1703 (compiled-debug-fun-compiler-debug-fun
1705 (svref blocks (1- end))
1708 (compiled-code-location-pc
1709 (svref (compiled-debug-block-code-locations last)
1711 (svref blocks (1- end)))
1713 (declare (type sb!c::index i end))
1715 (compiled-code-location-pc
1716 (svref (compiled-debug-block-code-locations
1719 (return (svref blocks (1- i)))))))))
1721 ;;; Return the CODE-LOCATION's DEBUG-SOURCE.
1722 (defun code-location-debug-source (code-location)
1723 (etypecase code-location
1724 (compiled-code-location
1725 (let* ((info (compiled-debug-fun-debug-info
1726 (code-location-debug-fun code-location)))
1727 (sources (sb!c::compiled-debug-info-source info))
1728 (len (length sources)))
1729 (declare (list sources))
1731 (debug-signal 'no-debug-blocks :debug-fun
1732 (code-location-debug-fun code-location)))
1735 (do ((prev sources src)
1736 (src (cdr sources) (cdr src))
1737 (offset (code-location-top-level-form-offset code-location)))
1738 ((null src) (car prev))
1739 (when (< offset (sb!c::debug-source-source-root (car src)))
1740 (return (car prev)))))))
1741 ;; (There used to be more cases back before sbcl-0.7.0, when we
1742 ;; did special tricks to debug the IR1 interpreter.)
1745 ;;; Returns the number of top-level forms before the one containing
1746 ;;; CODE-LOCATION as seen by the compiler in some compilation unit. (A
1747 ;;; compilation unit is not necessarily a single file, see the section
1748 ;;; on debug-sources.)
1749 (defun code-location-top-level-form-offset (code-location)
1750 (when (code-location-unknown-p code-location)
1751 (error 'unknown-code-location :code-location code-location))
1752 (let ((tlf-offset (code-location-%tlf-offset code-location)))
1753 (cond ((eq tlf-offset :unparsed)
1754 (etypecase code-location
1755 (compiled-code-location
1756 (unless (fill-in-code-location code-location)
1757 ;; This check should be unnecessary. We're missing
1758 ;; debug info the compiler should have dumped.
1759 (error "internal error: unknown code location"))
1760 (code-location-%tlf-offset code-location))
1761 ;; (There used to be more cases back before sbcl-0.7.0,,
1762 ;; when we did special tricks to debug the IR1
1767 ;;; Return the number of the form corresponding to CODE-LOCATION. The
1768 ;;; form number is derived by a walking the subforms of a top-level
1769 ;;; form in depth-first order.
1770 (defun code-location-form-number (code-location)
1771 (when (code-location-unknown-p code-location)
1772 (error 'unknown-code-location :code-location code-location))
1773 (let ((form-num (code-location-%form-number code-location)))
1774 (cond ((eq form-num :unparsed)
1775 (etypecase code-location
1776 (compiled-code-location
1777 (unless (fill-in-code-location code-location)
1778 ;; This check should be unnecessary. We're missing
1779 ;; debug info the compiler should have dumped.
1780 (error "internal error: unknown code location"))
1781 (code-location-%form-number code-location))
1782 ;; (There used to be more cases back before sbcl-0.7.0,,
1783 ;; when we did special tricks to debug the IR1
1788 ;;; Return the kind of CODE-LOCATION, one of:
1789 ;;; :INTERPRETED, :UNKNOWN-RETURN, :KNOWN-RETURN, :INTERNAL-ERROR,
1790 ;;; :NON-LOCAL-EXIT, :BLOCK-START, :CALL-SITE, :SINGLE-VALUE-RETURN,
1791 ;;; :NON-LOCAL-ENTRY
1792 (defun code-location-kind (code-location)
1793 (when (code-location-unknown-p code-location)
1794 (error 'unknown-code-location :code-location code-location))
1795 (etypecase code-location
1796 (compiled-code-location
1797 (let ((kind (compiled-code-location-kind code-location)))
1798 (cond ((not (eq kind :unparsed)) kind)
1799 ((not (fill-in-code-location code-location))
1800 ;; This check should be unnecessary. We're missing
1801 ;; debug info the compiler should have dumped.
1802 (error "internal error: unknown code location"))
1804 (compiled-code-location-kind code-location)))))
1805 ;; (There used to be more cases back before sbcl-0.7.0,,
1806 ;; when we did special tricks to debug the IR1
1810 ;;; This returns CODE-LOCATION's live-set if it is available. If
1811 ;;; there is no debug-block information, this returns NIL.
1812 (defun compiled-code-location-live-set (code-location)
1813 (if (code-location-unknown-p code-location)
1815 (let ((live-set (compiled-code-location-%live-set code-location)))
1816 (cond ((eq live-set :unparsed)
1817 (unless (fill-in-code-location code-location)
1818 ;; This check should be unnecessary. We're missing
1819 ;; debug info the compiler should have dumped.
1821 ;; FIXME: This error and comment happen over and over again.
1822 ;; Make them a shared function.
1823 (error "internal error: unknown code location"))
1824 (compiled-code-location-%live-set code-location))
1827 ;;; true if OBJ1 and OBJ2 are the same place in the code
1828 (defun code-location= (obj1 obj2)
1830 (compiled-code-location
1832 (compiled-code-location
1833 (and (eq (code-location-debug-fun obj1)
1834 (code-location-debug-fun obj2))
1835 (sub-compiled-code-location= obj1 obj2)))
1836 ;; (There used to be more cases back before sbcl-0.7.0,,
1837 ;; when we did special tricks to debug the IR1
1840 ;; (There used to be more cases back before sbcl-0.7.0,,
1841 ;; when we did special tricks to debug the IR1
1844 (defun sub-compiled-code-location= (obj1 obj2)
1845 (= (compiled-code-location-pc obj1)
1846 (compiled-code-location-pc obj2)))
1848 ;;; Fill in CODE-LOCATION's :UNPARSED slots, returning T or NIL
1849 ;;; depending on whether the code-location was known in its
1850 ;;; DEBUG-FUN's debug-block information. This may signal a
1851 ;;; NO-DEBUG-BLOCKS condition due to DEBUG-FUN-DEBUG-BLOCKS, and
1852 ;;; it assumes the %UNKNOWN-P slot is already set or going to be set.
1853 (defun fill-in-code-location (code-location)
1854 (declare (type compiled-code-location code-location))
1855 (let* ((debug-fun (code-location-debug-fun code-location))
1856 (blocks (debug-fun-debug-blocks debug-fun)))
1857 (declare (simple-vector blocks))
1858 (dotimes (i (length blocks) nil)
1859 (let* ((block (svref blocks i))
1860 (locations (compiled-debug-block-code-locations block)))
1861 (declare (simple-vector locations))
1862 (dotimes (j (length locations))
1863 (let ((loc (svref locations j)))
1864 (when (sub-compiled-code-location= code-location loc)
1865 (setf (code-location-%debug-block code-location) block)
1866 (setf (code-location-%tlf-offset code-location)
1867 (code-location-%tlf-offset loc))
1868 (setf (code-location-%form-number code-location)
1869 (code-location-%form-number loc))
1870 (setf (compiled-code-location-%live-set code-location)
1871 (compiled-code-location-%live-set loc))
1872 (setf (compiled-code-location-kind code-location)
1873 (compiled-code-location-kind loc))
1874 (return-from fill-in-code-location t))))))))
1876 ;;;; operations on DEBUG-BLOCKs
1878 ;;; Execute FORMS in a context with CODE-VAR bound to each
1879 ;;; CODE-LOCATION in DEBUG-BLOCK, and return the value of RESULT.
1880 (defmacro do-debug-block-locations ((code-var debug-block &optional result)
1882 (let ((code-locations (gensym))
1884 `(let ((,code-locations (debug-block-code-locations ,debug-block)))
1885 (declare (simple-vector ,code-locations))
1886 (dotimes (,i (length ,code-locations) ,result)
1887 (let ((,code-var (svref ,code-locations ,i)))
1890 ;;; Return the name of the function represented by DEBUG-FUN.
1891 ;;; This may be a string or a cons; do not assume it is a symbol.
1892 (defun debug-block-function-name (debug-block)
1893 (etypecase debug-block
1894 (compiled-debug-block
1895 (let ((code-locs (compiled-debug-block-code-locations debug-block)))
1896 (declare (simple-vector code-locs))
1897 (if (zerop (length code-locs))
1898 "??? Can't get name of debug-block's function."
1900 (code-location-debug-fun (svref code-locs 0))))))
1901 ;; (There used to be more cases back before sbcl-0.7.0, when we
1902 ;; did special tricks to debug the IR1 interpreter.)
1905 (defun debug-block-code-locations (debug-block)
1906 (etypecase debug-block
1907 (compiled-debug-block
1908 (compiled-debug-block-code-locations debug-block))
1909 ;; (There used to be more cases back before sbcl-0.7.0, when we
1910 ;; did special tricks to debug the IR1 interpreter.)
1913 ;;;; operations on debug variables
1915 (defun debug-var-symbol-name (debug-var)
1916 (symbol-name (debug-var-symbol debug-var)))
1918 ;;; FIXME: Make sure that this isn't called anywhere that it wouldn't
1919 ;;; be acceptable to have NIL returned, or that it's only called on
1920 ;;; DEBUG-VARs whose symbols have non-NIL packages.
1921 (defun debug-var-package-name (debug-var)
1922 (package-name (symbol-package (debug-var-symbol debug-var))))
1924 ;;; Return the value stored for DEBUG-VAR in frame, or if the value is
1925 ;;; not :VALID, then signal an INVALID-VALUE error.
1926 (defun debug-var-valid-value (debug-var frame)
1927 (unless (eq (debug-var-validity debug-var (frame-code-location frame))
1929 (error 'invalid-value :debug-var debug-var :frame frame))
1930 (debug-var-value debug-var frame))
1932 ;;; Returns the value stored for DEBUG-VAR in frame. The value may be
1933 ;;; invalid. This is SETFable.
1934 (defun debug-var-value (debug-var frame)
1935 (aver (typep frame 'compiled-frame))
1936 (let ((res (access-compiled-debug-var-slot debug-var frame)))
1937 (if (indirect-value-cell-p res)
1938 (value-cell-ref res)
1941 ;;; This returns what is stored for the variable represented by
1942 ;;; DEBUG-VAR relative to the FRAME. This may be an indirect value
1943 ;;; cell if the variable is both closed over and set.
1944 (defun access-compiled-debug-var-slot (debug-var frame)
1945 (declare (optimize (speed 1)))
1946 (let ((escaped (compiled-frame-escaped frame)))
1948 (sub-access-debug-var-slot
1949 (frame-pointer frame)
1950 (compiled-debug-var-sc-offset debug-var)
1952 (sub-access-debug-var-slot
1953 (frame-pointer frame)
1954 (or (compiled-debug-var-save-sc-offset debug-var)
1955 (compiled-debug-var-sc-offset debug-var))))))
1957 ;;; a helper function for working with possibly-invalid values:
1958 ;;; Do (MAKE-LISP-OBJ VAL) only if the value looks valid.
1960 ;;; (Such values can arise in registers on machines with conservative
1961 ;;; GC, and might also arise in debug variable locations when
1962 ;;; those variables are invalid.)
1963 (defun make-valid-lisp-obj (val)
1964 (/show0 "entering MAKE-VALID-LISP-OBJ, VAL=..")
1965 #!+sb-show (/hexstr val)
1968 (zerop (logand val 3))
1970 (and (zerop (logand val #xffff0000)) ; Top bits zero
1971 (= (logand val #xff) sb!vm:base-char-type)) ; Char tag
1973 (= val sb!vm:unbound-marker-type)
1976 ;; Check that the pointer is valid. XXX Could do a better
1977 ;; job. FIXME: e.g. by calling out to an is_valid_pointer
1978 ;; routine in the C runtime support code
1979 (or (< sb!vm:read-only-space-start val
1980 (* sb!vm:*read-only-space-free-pointer*
1982 (< sb!vm:static-space-start val
1983 (* sb!vm:*static-space-free-pointer*
1985 (< sb!vm:dynamic-space-start val
1986 (sap-int (dynamic-space-free-pointer))))))
1991 (defun sub-access-debug-var-slot (fp sc-offset &optional escaped)
1992 (macrolet ((with-escaped-value ((var) &body forms)
1994 (let ((,var (sb!vm:context-register
1996 (sb!c:sc-offset-offset sc-offset))))
1998 :invalid-value-for-unescaped-register-storage))
1999 (escaped-float-value (format)
2001 (sb!vm:context-float-register
2003 (sb!c:sc-offset-offset sc-offset)
2005 :invalid-value-for-unescaped-register-storage))
2006 (with-nfp ((var) &body body)
2007 `(let ((,var (if escaped
2009 (sb!vm:context-register escaped
2012 (sb!sys:sap-ref-sap fp (* sb!vm::nfp-save-offset
2015 (sb!vm::make-number-stack-pointer
2016 (sb!sys:sap-ref-32 fp (* sb!vm::nfp-save-offset
2017 sb!vm:word-bytes))))))
2019 (ecase (sb!c:sc-offset-scn sc-offset)
2020 ((#.sb!vm:any-reg-sc-number
2021 #.sb!vm:descriptor-reg-sc-number
2022 #!+rt #.sb!vm:word-pointer-reg-sc-number)
2023 (sb!sys:without-gcing
2024 (with-escaped-value (val) (sb!kernel:make-lisp-obj val))))
2026 (#.sb!vm:base-char-reg-sc-number
2027 (with-escaped-value (val)
2029 (#.sb!vm:sap-reg-sc-number
2030 (with-escaped-value (val)
2031 (sb!sys:int-sap val)))
2032 (#.sb!vm:signed-reg-sc-number
2033 (with-escaped-value (val)
2034 (if (logbitp (1- sb!vm:word-bits) val)
2035 (logior val (ash -1 sb!vm:word-bits))
2037 (#.sb!vm:unsigned-reg-sc-number
2038 (with-escaped-value (val)
2040 (#.sb!vm:non-descriptor-reg-sc-number
2041 (error "Local non-descriptor register access?"))
2042 (#.sb!vm:interior-reg-sc-number
2043 (error "Local interior register access?"))
2044 (#.sb!vm:single-reg-sc-number
2045 (escaped-float-value single-float))
2046 (#.sb!vm:double-reg-sc-number
2047 (escaped-float-value double-float))
2049 (#.sb!vm:long-reg-sc-number
2050 (escaped-float-value long-float))
2051 (#.sb!vm:complex-single-reg-sc-number
2054 (sb!vm:context-float-register
2055 escaped (sb!c:sc-offset-offset sc-offset) 'single-float)
2056 (sb!vm:context-float-register
2057 escaped (1+ (sb!c:sc-offset-offset sc-offset)) 'single-float))
2058 :invalid-value-for-unescaped-register-storage))
2059 (#.sb!vm:complex-double-reg-sc-number
2062 (sb!vm:context-float-register
2063 escaped (sb!c:sc-offset-offset sc-offset) 'double-float)
2064 (sb!vm:context-float-register
2065 escaped (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 2 #-sparc 1)
2067 :invalid-value-for-unescaped-register-storage))
2069 (#.sb!vm:complex-long-reg-sc-number
2072 (sb!vm:context-float-register
2073 escaped (sb!c:sc-offset-offset sc-offset) 'long-float)
2074 (sb!vm:context-float-register
2075 escaped (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 4)
2077 :invalid-value-for-unescaped-register-storage))
2078 (#.sb!vm:single-stack-sc-number
2080 (sb!sys:sap-ref-single nfp (* (sb!c:sc-offset-offset sc-offset)
2081 sb!vm:word-bytes))))
2082 (#.sb!vm:double-stack-sc-number
2084 (sb!sys:sap-ref-double nfp (* (sb!c:sc-offset-offset sc-offset)
2085 sb!vm:word-bytes))))
2087 (#.sb!vm:long-stack-sc-number
2089 (sb!sys:sap-ref-long nfp (* (sb!c:sc-offset-offset sc-offset)
2090 sb!vm:word-bytes))))
2091 (#.sb!vm:complex-single-stack-sc-number
2094 (sb!sys:sap-ref-single nfp (* (sb!c:sc-offset-offset sc-offset)
2096 (sb!sys:sap-ref-single nfp (* (1+ (sb!c:sc-offset-offset sc-offset))
2097 sb!vm:word-bytes)))))
2098 (#.sb!vm:complex-double-stack-sc-number
2101 (sb!sys:sap-ref-double nfp (* (sb!c:sc-offset-offset sc-offset)
2103 (sb!sys:sap-ref-double nfp (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2104 sb!vm:word-bytes)))))
2106 (#.sb!vm:complex-long-stack-sc-number
2109 (sb!sys:sap-ref-long nfp (* (sb!c:sc-offset-offset sc-offset)
2111 (sb!sys:sap-ref-long nfp (* (+ (sb!c:sc-offset-offset sc-offset)
2113 sb!vm:word-bytes)))))
2114 (#.sb!vm:control-stack-sc-number
2115 (sb!kernel:stack-ref fp (sb!c:sc-offset-offset sc-offset)))
2116 (#.sb!vm:base-char-stack-sc-number
2118 (code-char (sb!sys:sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2119 sb!vm:word-bytes)))))
2120 (#.sb!vm:unsigned-stack-sc-number
2122 (sb!sys:sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2123 sb!vm:word-bytes))))
2124 (#.sb!vm:signed-stack-sc-number
2126 (sb!sys:signed-sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2127 sb!vm:word-bytes))))
2128 (#.sb!vm:sap-stack-sc-number
2130 (sb!sys:sap-ref-sap nfp (* (sb!c:sc-offset-offset sc-offset)
2131 sb!vm:word-bytes)))))))
2134 (defun sub-access-debug-var-slot (fp sc-offset &optional escaped)
2135 (declare (type system-area-pointer fp))
2136 (/show0 "entering SUB-ACCESS-DEBUG-VAR-SLOT, FP,SC-OFFSET,ESCAPED=..")
2137 (/hexstr fp) (/hexstr sc-offset) (/hexstr escaped)
2138 (macrolet ((with-escaped-value ((var) &body forms)
2140 (let ((,var (sb!vm:context-register
2142 (sb!c:sc-offset-offset sc-offset))))
2143 (/show0 "in escaped case, ,VAR value=..")
2146 :invalid-value-for-unescaped-register-storage))
2147 (escaped-float-value (format)
2149 (sb!vm:context-float-register
2150 escaped (sb!c:sc-offset-offset sc-offset) ',format)
2151 :invalid-value-for-unescaped-register-storage))
2152 (escaped-complex-float-value (format)
2155 (sb!vm:context-float-register
2156 escaped (sb!c:sc-offset-offset sc-offset) ',format)
2157 (sb!vm:context-float-register
2158 escaped (1+ (sb!c:sc-offset-offset sc-offset)) ',format))
2159 :invalid-value-for-unescaped-register-storage)))
2160 (ecase (sb!c:sc-offset-scn sc-offset)
2161 ((#.sb!vm:any-reg-sc-number #.sb!vm:descriptor-reg-sc-number)
2162 (/show0 "case of ANY-REG-SC-NUMBER or DESCRIPTOR-REG-SC-NUMBER")
2164 (with-escaped-value (val)
2167 (make-valid-lisp-obj val))))
2168 (#.sb!vm:base-char-reg-sc-number
2169 (/show0 "case of BASE-CHAR-REG-SC-NUMBER")
2170 (with-escaped-value (val)
2172 (#.sb!vm:sap-reg-sc-number
2173 (/show0 "case of SAP-REG-SC-NUMBER")
2174 (with-escaped-value (val)
2176 (#.sb!vm:signed-reg-sc-number
2177 (/show0 "case of SIGNED-REG-SC-NUMBER")
2178 (with-escaped-value (val)
2179 (if (logbitp (1- sb!vm:word-bits) val)
2180 (logior val (ash -1 sb!vm:word-bits))
2182 (#.sb!vm:unsigned-reg-sc-number
2183 (/show0 "case of UNSIGNED-REG-SC-NUMBER")
2184 (with-escaped-value (val)
2186 (#.sb!vm:single-reg-sc-number
2187 (/show0 "case of SINGLE-REG-SC-NUMBER")
2188 (escaped-float-value single-float))
2189 (#.sb!vm:double-reg-sc-number
2190 (/show0 "case of DOUBLE-REG-SC-NUMBER")
2191 (escaped-float-value double-float))
2193 (#.sb!vm:long-reg-sc-number
2194 (/show0 "case of LONG-REG-SC-NUMBER")
2195 (escaped-float-value long-float))
2196 (#.sb!vm:complex-single-reg-sc-number
2197 (/show0 "case of COMPLEX-SINGLE-REG-SC-NUMBER")
2198 (escaped-complex-float-value single-float))
2199 (#.sb!vm:complex-double-reg-sc-number
2200 (/show0 "case of COMPLEX-DOUBLE-REG-SC-NUMBER")
2201 (escaped-complex-float-value double-float))
2203 (#.sb!vm:complex-long-reg-sc-number
2204 (/show0 "case of COMPLEX-LONG-REG-SC-NUMBER")
2205 (escaped-complex-float-value long-float))
2206 (#.sb!vm:single-stack-sc-number
2207 (/show0 "case of SINGLE-STACK-SC-NUMBER")
2208 (sap-ref-single fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2209 sb!vm:word-bytes))))
2210 (#.sb!vm:double-stack-sc-number
2211 (/show0 "case of DOUBLE-STACK-SC-NUMBER")
2212 (sap-ref-double fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2213 sb!vm:word-bytes))))
2215 (#.sb!vm:long-stack-sc-number
2216 (/show0 "case of LONG-STACK-SC-NUMBER")
2217 (sap-ref-long fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2218 sb!vm:word-bytes))))
2219 (#.sb!vm:complex-single-stack-sc-number
2220 (/show0 "case of COMPLEX-STACK-SC-NUMBER")
2222 (sap-ref-single fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2224 (sap-ref-single fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2225 sb!vm:word-bytes)))))
2226 (#.sb!vm:complex-double-stack-sc-number
2227 (/show0 "case of COMPLEX-DOUBLE-STACK-SC-NUMBER")
2229 (sap-ref-double fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2231 (sap-ref-double fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 4)
2232 sb!vm:word-bytes)))))
2234 (#.sb!vm:complex-long-stack-sc-number
2235 (/show0 "case of COMPLEX-LONG-STACK-SC-NUMBER")
2237 (sap-ref-long fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2239 (sap-ref-long fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 6)
2240 sb!vm:word-bytes)))))
2241 (#.sb!vm:control-stack-sc-number
2242 (/show0 "case of CONTROL-STACK-SC-NUMBER")
2243 (stack-ref fp (sb!c:sc-offset-offset sc-offset)))
2244 (#.sb!vm:base-char-stack-sc-number
2245 (/show0 "case of BASE-CHAR-STACK-SC-NUMBER")
2247 (sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2248 sb!vm:word-bytes)))))
2249 (#.sb!vm:unsigned-stack-sc-number
2250 (/show0 "case of UNSIGNED-STACK-SC-NUMBER")
2251 (sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2252 sb!vm:word-bytes))))
2253 (#.sb!vm:signed-stack-sc-number
2254 (/show0 "case of SIGNED-STACK-SC-NUMBER")
2255 (signed-sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2256 sb!vm:word-bytes))))
2257 (#.sb!vm:sap-stack-sc-number
2258 (/show0 "case of SAP-STACK-SC-NUMBER")
2259 (sap-ref-sap fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2260 sb!vm:word-bytes)))))))
2262 ;;; This stores value as the value of DEBUG-VAR in FRAME. In the
2263 ;;; COMPILED-DEBUG-VAR case, access the current value to determine if
2264 ;;; it is an indirect value cell. This occurs when the variable is
2265 ;;; both closed over and set.
2266 (defun %set-debug-var-value (debug-var frame new-value)
2267 (aver (typep frame 'compiled-frame))
2268 (let ((old-value (access-compiled-debug-var-slot debug-var frame)))
2269 (if (indirect-value-cell-p old-value)
2270 (value-cell-set old-value new-value)
2271 (set-compiled-debug-var-slot debug-var frame new-value)))
2274 ;;; This stores VALUE for the variable represented by debug-var
2275 ;;; relative to the frame. This assumes the location directly contains
2276 ;;; the variable's value; that is, there is no indirect value cell
2277 ;;; currently there in case the variable is both closed over and set.
2278 (defun set-compiled-debug-var-slot (debug-var frame value)
2279 (let ((escaped (compiled-frame-escaped frame)))
2281 (sub-set-debug-var-slot (frame-pointer frame)
2282 (compiled-debug-var-sc-offset debug-var)
2284 (sub-set-debug-var-slot
2285 (frame-pointer frame)
2286 (or (compiled-debug-var-save-sc-offset debug-var)
2287 (compiled-debug-var-sc-offset debug-var))
2291 (defun sub-set-debug-var-slot (fp sc-offset value &optional escaped)
2292 (macrolet ((set-escaped-value (val)
2294 (setf (sb!vm:context-register
2296 (sb!c:sc-offset-offset sc-offset))
2299 (set-escaped-float-value (format val)
2301 (setf (sb!vm:context-float-register
2303 (sb!c:sc-offset-offset sc-offset)
2307 (with-nfp ((var) &body body)
2308 `(let ((,var (if escaped
2310 (sb!vm:context-register escaped
2314 (* sb!vm::nfp-save-offset
2317 (sb!vm::make-number-stack-pointer
2319 (* sb!vm::nfp-save-offset
2320 sb!vm:word-bytes))))))
2322 (ecase (sb!c:sc-offset-scn sc-offset)
2323 ((#.sb!vm:any-reg-sc-number
2324 #.sb!vm:descriptor-reg-sc-number
2325 #!+rt #.sb!vm:word-pointer-reg-sc-number)
2328 (get-lisp-obj-address value))))
2329 (#.sb!vm:base-char-reg-sc-number
2330 (set-escaped-value (char-code value)))
2331 (#.sb!vm:sap-reg-sc-number
2332 (set-escaped-value (sap-int value)))
2333 (#.sb!vm:signed-reg-sc-number
2334 (set-escaped-value (logand value (1- (ash 1 sb!vm:word-bits)))))
2335 (#.sb!vm:unsigned-reg-sc-number
2336 (set-escaped-value value))
2337 (#.sb!vm:non-descriptor-reg-sc-number
2338 (error "Local non-descriptor register access?"))
2339 (#.sb!vm:interior-reg-sc-number
2340 (error "Local interior register access?"))
2341 (#.sb!vm:single-reg-sc-number
2342 (set-escaped-float-value single-float value))
2343 (#.sb!vm:double-reg-sc-number
2344 (set-escaped-float-value double-float value))
2346 (#.sb!vm:long-reg-sc-number
2347 (set-escaped-float-value long-float value))
2348 (#.sb!vm:complex-single-reg-sc-number
2350 (setf (sb!vm:context-float-register escaped
2351 (sb!c:sc-offset-offset sc-offset)
2354 (setf (sb!vm:context-float-register
2355 escaped (1+ (sb!c:sc-offset-offset sc-offset))
2359 (#.sb!vm:complex-double-reg-sc-number
2361 (setf (sb!vm:context-float-register
2362 escaped (sb!c:sc-offset-offset sc-offset) 'double-float)
2364 (setf (sb!vm:context-float-register
2366 (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 2 #!-sparc 1)
2371 (#.sb!vm:complex-long-reg-sc-number
2373 (setf (sb!vm:context-float-register
2374 escaped (sb!c:sc-offset-offset sc-offset) 'long-float)
2376 (setf (sb!vm:context-float-register
2378 (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 4)
2382 (#.sb!vm:single-stack-sc-number
2384 (setf (sap-ref-single nfp (* (sb!c:sc-offset-offset sc-offset)
2386 (the single-float value))))
2387 (#.sb!vm:double-stack-sc-number
2389 (setf (sap-ref-double nfp (* (sb!c:sc-offset-offset sc-offset)
2391 (the double-float value))))
2393 (#.sb!vm:long-stack-sc-number
2395 (setf (sap-ref-long nfp (* (sb!c:sc-offset-offset sc-offset)
2397 (the long-float value))))
2398 (#.sb!vm:complex-single-stack-sc-number
2400 (setf (sap-ref-single
2401 nfp (* (sb!c:sc-offset-offset sc-offset) sb!vm:word-bytes))
2402 (the single-float (realpart value)))
2403 (setf (sap-ref-single
2404 nfp (* (1+ (sb!c:sc-offset-offset sc-offset))
2406 (the single-float (realpart value)))))
2407 (#.sb!vm:complex-double-stack-sc-number
2409 (setf (sap-ref-double
2410 nfp (* (sb!c:sc-offset-offset sc-offset) sb!vm:word-bytes))
2411 (the double-float (realpart value)))
2412 (setf (sap-ref-double
2413 nfp (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2415 (the double-float (realpart value)))))
2417 (#.sb!vm:complex-long-stack-sc-number
2420 nfp (* (sb!c:sc-offset-offset sc-offset) sb!vm:word-bytes))
2421 (the long-float (realpart value)))
2423 nfp (* (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 4)
2425 (the long-float (realpart value)))))
2426 (#.sb!vm:control-stack-sc-number
2427 (setf (stack-ref fp (sb!c:sc-offset-offset sc-offset)) value))
2428 (#.sb!vm:base-char-stack-sc-number
2430 (setf (sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2432 (char-code (the character value)))))
2433 (#.sb!vm:unsigned-stack-sc-number
2435 (setf (sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2437 (the (unsigned-byte 32) value))))
2438 (#.sb!vm:signed-stack-sc-number
2440 (setf (signed-sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2442 (the (signed-byte 32) value))))
2443 (#.sb!vm:sap-stack-sc-number
2445 (setf (sap-ref-sap nfp (* (sb!c:sc-offset-offset sc-offset)
2447 (the system-area-pointer value)))))))
2450 (defun sub-set-debug-var-slot (fp sc-offset value &optional escaped)
2451 (macrolet ((set-escaped-value (val)
2453 (setf (sb!vm:context-register
2455 (sb!c:sc-offset-offset sc-offset))
2458 (ecase (sb!c:sc-offset-scn sc-offset)
2459 ((#.sb!vm:any-reg-sc-number #.sb!vm:descriptor-reg-sc-number)
2462 (get-lisp-obj-address value))))
2463 (#.sb!vm:base-char-reg-sc-number
2464 (set-escaped-value (char-code value)))
2465 (#.sb!vm:sap-reg-sc-number
2466 (set-escaped-value (sap-int value)))
2467 (#.sb!vm:signed-reg-sc-number
2468 (set-escaped-value (logand value (1- (ash 1 sb!vm:word-bits)))))
2469 (#.sb!vm:unsigned-reg-sc-number
2470 (set-escaped-value value))
2471 (#.sb!vm:single-reg-sc-number
2472 #+nil ;; don't have escaped floats.
2473 (set-escaped-float-value single-float value))
2474 (#.sb!vm:double-reg-sc-number
2475 #+nil ;; don't have escaped floats -- still in npx?
2476 (set-escaped-float-value double-float value))
2478 (#.sb!vm:long-reg-sc-number
2479 #+nil ;; don't have escaped floats -- still in npx?
2480 (set-escaped-float-value long-float value))
2481 (#.sb!vm:single-stack-sc-number
2482 (setf (sap-ref-single
2483 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2485 (the single-float value)))
2486 (#.sb!vm:double-stack-sc-number
2487 (setf (sap-ref-double
2488 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2490 (the double-float value)))
2492 (#.sb!vm:long-stack-sc-number
2494 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2496 (the long-float value)))
2497 (#.sb!vm:complex-single-stack-sc-number
2498 (setf (sap-ref-single
2499 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2501 (realpart (the (complex single-float) value)))
2502 (setf (sap-ref-single
2503 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2505 (imagpart (the (complex single-float) value))))
2506 (#.sb!vm:complex-double-stack-sc-number
2507 (setf (sap-ref-double
2508 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2510 (realpart (the (complex double-float) value)))
2511 (setf (sap-ref-double
2512 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 4)
2514 (imagpart (the (complex double-float) value))))
2516 (#.sb!vm:complex-long-stack-sc-number
2518 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2520 (realpart (the (complex long-float) value)))
2522 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 6)
2524 (imagpart (the (complex long-float) value))))
2525 (#.sb!vm:control-stack-sc-number
2526 (setf (stack-ref fp (sb!c:sc-offset-offset sc-offset)) value))
2527 (#.sb!vm:base-char-stack-sc-number
2528 (setf (sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2530 (char-code (the character value))))
2531 (#.sb!vm:unsigned-stack-sc-number
2532 (setf (sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2534 (the (unsigned-byte 32) value)))
2535 (#.sb!vm:signed-stack-sc-number
2536 (setf (signed-sap-ref-32
2537 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset)) sb!vm:word-bytes)))
2538 (the (signed-byte 32) value)))
2539 (#.sb!vm:sap-stack-sc-number
2540 (setf (sap-ref-sap fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2542 (the system-area-pointer value))))))
2544 ;;; The method for setting and accessing COMPILED-DEBUG-VAR values use
2545 ;;; this to determine if the value stored is the actual value or an
2546 ;;; indirection cell.
2547 (defun indirect-value-cell-p (x)
2548 (and (= (get-lowtag x) sb!vm:other-pointer-lowtag)
2549 (= (get-type x) sb!vm:value-cell-header-type)))
2551 ;;; Return three values reflecting the validity of DEBUG-VAR's value
2552 ;;; at BASIC-CODE-LOCATION:
2553 ;;; :VALID The value is known to be available.
2554 ;;; :INVALID The value is known to be unavailable.
2555 ;;; :UNKNOWN The value's availability is unknown.
2557 ;;; If the variable is always alive, then it is valid. If the
2558 ;;; code-location is unknown, then the variable's validity is
2559 ;;; :unknown. Once we've called CODE-LOCATION-UNKNOWN-P, we know the
2560 ;;; live-set information has been cached in the code-location.
2561 (defun debug-var-validity (debug-var basic-code-location)
2562 (etypecase debug-var
2564 (compiled-debug-var-validity debug-var basic-code-location))
2565 ;; (There used to be more cases back before sbcl-0.7.0, when
2566 ;; we did special tricks to debug the IR1 interpreter.)
2569 ;;; This is the method for DEBUG-VAR-VALIDITY for COMPILED-DEBUG-VARs.
2570 ;;; For safety, make sure basic-code-location is what we think.
2571 (defun compiled-debug-var-validity (debug-var basic-code-location)
2572 (declare (type compiled-code-location basic-code-location))
2573 (cond ((debug-var-alive-p debug-var)
2574 (let ((debug-fun (code-location-debug-fun basic-code-location)))
2575 (if (>= (compiled-code-location-pc basic-code-location)
2576 (sb!c::compiled-debug-fun-start-pc
2577 (compiled-debug-fun-compiler-debug-fun debug-fun)))
2580 ((code-location-unknown-p basic-code-location) :unknown)
2582 (let ((pos (position debug-var
2583 (debug-fun-debug-vars
2584 (code-location-debug-fun
2585 basic-code-location)))))
2587 (error 'unknown-debug-var
2588 :debug-var debug-var
2590 (code-location-debug-fun basic-code-location)))
2591 ;; There must be live-set info since basic-code-location is known.
2592 (if (zerop (sbit (compiled-code-location-live-set
2593 basic-code-location)
2600 ;;; This code produces and uses what we call source-paths. A
2601 ;;; source-path is a list whose first element is a form number as
2602 ;;; returned by CODE-LOCATION-FORM-NUMBER and whose last element is a
2603 ;;; top-level-form number as returned by
2604 ;;; CODE-LOCATION-TOP-LEVEL-FORM-NUMBER. The elements from the last to
2605 ;;; the first, exclusively, are the numbered subforms into which to
2606 ;;; descend. For example:
2608 ;;; (let ((a (aref x 3)))
2610 ;;; The call to AREF in this example is form number 5. Assuming this
2611 ;;; DEFUN is the 11'th top-level-form, the source-path for the AREF
2612 ;;; call is as follows:
2614 ;;; Given the DEFUN, 3 gets you the LET, 1 gets you the bindings, 0
2615 ;;; gets the first binding, and 1 gets the AREF form.
2617 ;;; temporary buffer used to build form-number => source-path translation in
2618 ;;; FORM-NUMBER-TRANSLATIONS
2619 (defvar *form-number-temp* (make-array 10 :fill-pointer 0 :adjustable t))
2621 ;;; table used to detect CAR circularities in FORM-NUMBER-TRANSLATIONS
2622 (defvar *form-number-circularity-table* (make-hash-table :test 'eq))
2624 ;;; This returns a table mapping form numbers to source-paths. A source-path
2625 ;;; indicates a descent into the top-level-form form, going directly to the
2626 ;;; subform corressponding to the form number.
2628 ;;; The vector elements are in the same format as the compiler's
2629 ;;; NODE-SOURCE-PATH; that is, the first element is the form number and
2630 ;;; the last is the top-level-form number.
2631 (defun form-number-translations (form tlf-number)
2632 (clrhash *form-number-circularity-table*)
2633 (setf (fill-pointer *form-number-temp*) 0)
2634 (sub-translate-form-numbers form (list tlf-number))
2635 (coerce *form-number-temp* 'simple-vector))
2636 (defun sub-translate-form-numbers (form path)
2637 (unless (gethash form *form-number-circularity-table*)
2638 (setf (gethash form *form-number-circularity-table*) t)
2639 (vector-push-extend (cons (fill-pointer *form-number-temp*) path)
2644 (declare (fixnum pos))
2647 (when (atom subform) (return))
2648 (let ((fm (car subform)))
2650 (sub-translate-form-numbers fm (cons pos path)))
2652 (setq subform (cdr subform))
2653 (when (eq subform trail) (return)))))
2657 (setq trail (cdr trail)))))))
2659 ;;; FORM is a top-level form, and path is a source-path into it. This
2660 ;;; returns the form indicated by the source-path. Context is the
2661 ;;; number of enclosing forms to return instead of directly returning
2662 ;;; the source-path form. When context is non-zero, the form returned
2663 ;;; contains a marker, #:****HERE****, immediately before the form
2664 ;;; indicated by path.
2665 (defun source-path-context (form path context)
2666 (declare (type unsigned-byte context))
2667 ;; Get to the form indicated by path or the enclosing form indicated
2668 ;; by context and path.
2669 (let ((path (reverse (butlast (cdr path)))))
2670 (dotimes (i (- (length path) context))
2671 (let ((index (first path)))
2672 (unless (and (listp form) (< index (length form)))
2673 (error "Source path no longer exists."))
2674 (setq form (elt form index))
2675 (setq path (rest path))))
2676 ;; Recursively rebuild the source form resulting from the above
2677 ;; descent, copying the beginning of each subform up to the next
2678 ;; subform we descend into according to path. At the bottom of the
2679 ;; recursion, we return the form indicated by path preceded by our
2680 ;; marker, and this gets spliced into the resulting list structure
2681 ;; on the way back up.
2682 (labels ((frob (form path level)
2683 (if (or (zerop level) (null path))
2686 `(#:***here*** ,form))
2687 (let ((n (first path)))
2688 (unless (and (listp form) (< n (length form)))
2689 (error "Source path no longer exists."))
2690 (let ((res (frob (elt form n) (rest path) (1- level))))
2691 (nconc (subseq form 0 n)
2692 (cons res (nthcdr (1+ n) form))))))))
2693 (frob form path context))))
2695 ;;;; PREPROCESS-FOR-EVAL
2697 ;;; Return a function of one argument that evaluates form in the
2698 ;;; lexical context of the BASIC-CODE-LOCATION LOC, or signal a
2699 ;;; NO-DEBUG-VARS condition when the LOC's DEBUG-FUN has no
2700 ;;; DEBUG-VAR information available.
2702 ;;; The returned function takes the frame to get values from as its
2703 ;;; argument, and it returns the values of FORM. The returned function
2704 ;;; can signal the following conditions: INVALID-VALUE,
2705 ;;; AMBIGUOUS-VARIABLE-NAME, and FRAME-FUN-MISMATCH.
2706 (defun preprocess-for-eval (form loc)
2707 (declare (type code-location loc))
2708 (let ((n-frame (gensym))
2709 (fun (code-location-debug-fun loc)))
2710 (unless (debug-var-info-available fun)
2711 (debug-signal 'no-debug-vars :debug-fun fun))
2712 (sb!int:collect ((binds)
2714 (do-debug-fun-variables (var fun)
2715 (let ((validity (debug-var-validity var loc)))
2716 (unless (eq validity :invalid)
2717 (let* ((sym (debug-var-symbol var))
2718 (found (assoc sym (binds))))
2720 (setf (second found) :ambiguous)
2721 (binds (list sym validity var)))))))
2722 (dolist (bind (binds))
2723 (let ((name (first bind))
2725 (ecase (second bind)
2727 (specs `(,name (debug-var-value ',var ,n-frame))))
2729 (specs `(,name (debug-signal 'invalid-value :debug-var ',var
2732 (specs `(,name (debug-signal 'ambiguous-variable-name :name ',name
2733 :frame ,n-frame)))))))
2734 (let ((res (coerce `(lambda (,n-frame)
2735 (declare (ignorable ,n-frame))
2736 (symbol-macrolet ,(specs) ,form))
2739 ;; This prevents these functions from being used in any
2740 ;; location other than a function return location, so
2741 ;; maybe this should only check whether frame's
2742 ;; DEBUG-FUN is the same as loc's.
2743 (unless (code-location= (frame-code-location frame) loc)
2744 (debug-signal 'frame-fun-mismatch
2745 :code-location loc :form form :frame frame))
2746 (funcall res frame))))))
2750 ;;;; user-visible interface
2752 ;;; Create and return a breakpoint. When program execution encounters
2753 ;;; the breakpoint, the system calls HOOK-FUNCTION. HOOK-FUNCTION takes the
2754 ;;; current frame for the function in which the program is running and the
2755 ;;; breakpoint object.
2757 ;;; WHAT and KIND determine where in a function the system invokes
2758 ;;; HOOK-FUNCTION. WHAT is either a code-location or a DEBUG-FUN.
2759 ;;; KIND is one of :CODE-LOCATION, :FUN-START, or :FUN-END.
2760 ;;; Since the starts and ends of functions may not have code-locations
2761 ;;; representing them, designate these places by supplying WHAT as a
2762 ;;; DEBUG-FUN and KIND indicating the :FUN-START or
2763 ;;; :FUN-END. When WHAT is a DEBUG-FUN and kind is
2764 ;;; :FUN-END, then hook-function must take two additional
2765 ;;; arguments, a list of values returned by the function and a
2768 ;;; INFO is information supplied by and used by the user.
2770 ;;; FUN-END-COOKIE is a function. To implement :FUN-END
2771 ;;; breakpoints, the system uses starter breakpoints to establish the
2772 ;;; :FUN-END breakpoint for each invocation of the function. Upon
2773 ;;; each entry, the system creates a unique cookie to identify the
2774 ;;; invocation, and when the user supplies a function for this
2775 ;;; argument, the system invokes it on the frame and the cookie. The
2776 ;;; system later invokes the :FUN-END breakpoint hook on the same
2777 ;;; cookie. The user may save the cookie for comparison in the hook
2780 ;;; Signal an error if WHAT is an unknown code-location.
2781 (defun make-breakpoint (hook-function what
2782 &key (kind :code-location) info fun-end-cookie)
2785 (when (code-location-unknown-p what)
2786 (error "cannot make a breakpoint at an unknown code location: ~S"
2788 (aver (eq kind :code-location))
2789 (let ((bpt (%make-breakpoint hook-function what kind info)))
2791 (compiled-code-location
2792 ;; This slot is filled in due to calling CODE-LOCATION-UNKNOWN-P.
2793 (when (eq (compiled-code-location-kind what) :unknown-return)
2794 (let ((other-bpt (%make-breakpoint hook-function what
2795 :unknown-return-partner
2797 (setf (breakpoint-unknown-return-partner bpt) other-bpt)
2798 (setf (breakpoint-unknown-return-partner other-bpt) bpt))))
2799 ;; (There used to be more cases back before sbcl-0.7.0,,
2800 ;; when we did special tricks to debug the IR1
2807 (%make-breakpoint hook-function what kind info))
2809 (unless (eq (sb!c::compiled-debug-fun-returns
2810 (compiled-debug-fun-compiler-debug-fun what))
2812 (error ":FUN-END breakpoints are currently unsupported ~
2813 for the known return convention."))
2815 (let* ((bpt (%make-breakpoint hook-function what kind info))
2816 (starter (compiled-debug-fun-end-starter what)))
2818 (setf starter (%make-breakpoint #'list what :fun-start nil))
2819 (setf (breakpoint-hook-function starter)
2820 (fun-end-starter-hook starter what))
2821 (setf (compiled-debug-fun-end-starter what) starter))
2822 (setf (breakpoint-start-helper bpt) starter)
2823 (push bpt (breakpoint-%info starter))
2824 (setf (breakpoint-cookie-fun bpt) fun-end-cookie)
2827 ;;; These are unique objects created upon entry into a function by a
2828 ;;; :FUN-END breakpoint's starter hook. These are only created
2829 ;;; when users supply :FUN-END-COOKIE to MAKE-BREAKPOINT. Also,
2830 ;;; the :FUN-END breakpoint's hook is called on the same cookie
2831 ;;; when it is created.
2832 (defstruct (fun-end-cookie
2833 (:print-object (lambda (obj str)
2834 (print-unreadable-object (obj str :type t))))
2835 (:constructor make-fun-end-cookie (bogus-lra debug-fun))
2837 ;; a pointer to the bogus-lra created for :FUN-END breakpoints
2839 ;; the DEBUG-FUN associated with this cookie
2842 ;;; This maps bogus-lra-components to cookies, so that
2843 ;;; HANDLE-FUN-END-BREAKPOINT can find the appropriate cookie for the
2844 ;;; breakpoint hook.
2845 (defvar *fun-end-cookies* (make-hash-table :test 'eq))
2847 ;;; This returns a hook function for the start helper breakpoint
2848 ;;; associated with a :FUN-END breakpoint. The returned function
2849 ;;; makes a fake LRA that all returns go through, and this piece of
2850 ;;; fake code actually breaks. Upon return from the break, the code
2851 ;;; provides the returnee with any values. Since the returned function
2852 ;;; effectively activates FUN-END-BPT on each entry to DEBUG-FUN's
2853 ;;; function, we must establish breakpoint-data about FUN-END-BPT.
2854 (defun fun-end-starter-hook (starter-bpt debug-fun)
2855 (declare (type breakpoint starter-bpt)
2856 (type compiled-debug-fun debug-fun))
2857 #'(lambda (frame breakpoint)
2858 (declare (ignore breakpoint)
2860 (let ((lra-sc-offset
2861 (sb!c::compiled-debug-fun-return-pc
2862 (compiled-debug-fun-compiler-debug-fun debug-fun))))
2863 (multiple-value-bind (lra component offset)
2865 (get-context-value frame
2866 sb!vm::lra-save-offset
2868 (setf (get-context-value frame
2869 sb!vm::lra-save-offset
2872 (let ((end-bpts (breakpoint-%info starter-bpt)))
2873 (let ((data (breakpoint-data component offset)))
2874 (setf (breakpoint-data-breakpoints data) end-bpts)
2875 (dolist (bpt end-bpts)
2876 (setf (breakpoint-internal-data bpt) data)))
2877 (let ((cookie (make-fun-end-cookie lra debug-fun)))
2878 (setf (gethash component *fun-end-cookies*) cookie)
2879 (dolist (bpt end-bpts)
2880 (let ((fun (breakpoint-cookie-fun bpt)))
2881 (when fun (funcall fun frame cookie))))))))))
2883 ;;; This takes a FUN-END-COOKIE and a frame, and it returns
2884 ;;; whether the cookie is still valid. A cookie becomes invalid when
2885 ;;; the frame that established the cookie has exited. Sometimes cookie
2886 ;;; holders are unaware of cookie invalidation because their
2887 ;;; :FUN-END breakpoint hooks didn't run due to THROW'ing.
2889 ;;; This takes a frame as an efficiency hack since the user probably
2890 ;;; has a frame object in hand when using this routine, and it saves
2891 ;;; repeated parsing of the stack and consing when asking whether a
2892 ;;; series of cookies is valid.
2893 (defun fun-end-cookie-valid-p (frame cookie)
2894 (let ((lra (fun-end-cookie-bogus-lra cookie))
2895 (lra-sc-offset (sb!c::compiled-debug-fun-return-pc
2896 (compiled-debug-fun-compiler-debug-fun
2897 (fun-end-cookie-debug-fun cookie)))))
2898 (do ((frame frame (frame-down frame)))
2900 (when (and (compiled-frame-p frame)
2902 (get-context-value frame
2903 sb!vm::lra-save-offset
2907 ;;;; ACTIVATE-BREAKPOINT
2909 ;;; Cause the system to invoke the breakpoint's hook-function until
2910 ;;; the next call to DEACTIVATE-BREAKPOINT or DELETE-BREAKPOINT. The
2911 ;;; system invokes breakpoint hook functions in the opposite order
2912 ;;; that you activate them.
2913 (defun activate-breakpoint (breakpoint)
2914 (when (eq (breakpoint-status breakpoint) :deleted)
2915 (error "cannot activate a deleted breakpoint: ~S" breakpoint))
2916 (unless (eq (breakpoint-status breakpoint) :active)
2917 (ecase (breakpoint-kind breakpoint)
2919 (let ((loc (breakpoint-what breakpoint)))
2921 (compiled-code-location
2922 (activate-compiled-code-location-breakpoint breakpoint)
2923 (let ((other (breakpoint-unknown-return-partner breakpoint)))
2925 (activate-compiled-code-location-breakpoint other))))
2926 ;; (There used to be more cases back before sbcl-0.7.0, when
2927 ;; we did special tricks to debug the IR1 interpreter.)
2930 (etypecase (breakpoint-what breakpoint)
2932 (activate-compiled-fun-start-breakpoint breakpoint))
2933 ;; (There used to be more cases back before sbcl-0.7.0, when
2934 ;; we did special tricks to debug the IR1 interpreter.)
2937 (etypecase (breakpoint-what breakpoint)
2939 (let ((starter (breakpoint-start-helper breakpoint)))
2940 (unless (eq (breakpoint-status starter) :active)
2941 ;; may already be active by some other :FUN-END breakpoint
2942 (activate-compiled-fun-start-breakpoint starter)))
2943 (setf (breakpoint-status breakpoint) :active))
2944 ;; (There used to be more cases back before sbcl-0.7.0, when
2945 ;; we did special tricks to debug the IR1 interpreter.)
2949 (defun activate-compiled-code-location-breakpoint (breakpoint)
2950 (declare (type breakpoint breakpoint))
2951 (let ((loc (breakpoint-what breakpoint)))
2952 (declare (type compiled-code-location loc))
2953 (sub-activate-breakpoint
2955 (breakpoint-data (compiled-debug-fun-component
2956 (code-location-debug-fun loc))
2957 (+ (compiled-code-location-pc loc)
2958 (if (or (eq (breakpoint-kind breakpoint)
2959 :unknown-return-partner)
2960 (eq (compiled-code-location-kind loc)
2961 :single-value-return))
2962 sb!vm:single-value-return-byte-offset
2965 (defun activate-compiled-fun-start-breakpoint (breakpoint)
2966 (declare (type breakpoint breakpoint))
2967 (let ((debug-fun (breakpoint-what breakpoint)))
2968 (sub-activate-breakpoint
2970 (breakpoint-data (compiled-debug-fun-component debug-fun)
2971 (sb!c::compiled-debug-fun-start-pc
2972 (compiled-debug-fun-compiler-debug-fun
2975 (defun sub-activate-breakpoint (breakpoint data)
2976 (declare (type breakpoint breakpoint)
2977 (type breakpoint-data data))
2978 (setf (breakpoint-status breakpoint) :active)
2980 (unless (breakpoint-data-breakpoints data)
2981 (setf (breakpoint-data-instruction data)
2983 (breakpoint-install (get-lisp-obj-address
2984 (breakpoint-data-component data))
2985 (breakpoint-data-offset data)))))
2986 (setf (breakpoint-data-breakpoints data)
2987 (append (breakpoint-data-breakpoints data) (list breakpoint)))
2988 (setf (breakpoint-internal-data breakpoint) data)))
2990 ;;;; DEACTIVATE-BREAKPOINT
2992 ;;; Stop the system from invoking the breakpoint's hook-function.
2993 (defun deactivate-breakpoint (breakpoint)
2994 (when (eq (breakpoint-status breakpoint) :active)
2996 (let ((loc (breakpoint-what breakpoint)))
2998 ((or compiled-code-location compiled-debug-fun)
2999 (deactivate-compiled-breakpoint breakpoint)
3000 (let ((other (breakpoint-unknown-return-partner breakpoint)))
3002 (deactivate-compiled-breakpoint other))))
3003 ;; (There used to be more cases back before sbcl-0.7.0, when
3004 ;; we did special tricks to debug the IR1 interpreter.)
3008 (defun deactivate-compiled-breakpoint (breakpoint)
3009 (if (eq (breakpoint-kind breakpoint) :fun-end)
3010 (let ((starter (breakpoint-start-helper breakpoint)))
3011 (unless (find-if #'(lambda (bpt)
3012 (and (not (eq bpt breakpoint))
3013 (eq (breakpoint-status bpt) :active)))
3014 (breakpoint-%info starter))
3015 (deactivate-compiled-breakpoint starter)))
3016 (let* ((data (breakpoint-internal-data breakpoint))
3017 (bpts (delete breakpoint (breakpoint-data-breakpoints data))))
3018 (setf (breakpoint-internal-data breakpoint) nil)
3019 (setf (breakpoint-data-breakpoints data) bpts)
3022 (breakpoint-remove (get-lisp-obj-address
3023 (breakpoint-data-component data))
3024 (breakpoint-data-offset data)
3025 (breakpoint-data-instruction data)))
3026 (delete-breakpoint-data data))))
3027 (setf (breakpoint-status breakpoint) :inactive)
3030 ;;;; BREAKPOINT-INFO
3032 ;;; Return the user-maintained info associated with breakpoint. This
3034 (defun breakpoint-info (breakpoint)
3035 (breakpoint-%info breakpoint))
3036 (defun %set-breakpoint-info (breakpoint value)
3037 (setf (breakpoint-%info breakpoint) value)
3038 (let ((other (breakpoint-unknown-return-partner breakpoint)))
3040 (setf (breakpoint-%info other) value))))
3042 ;;;; BREAKPOINT-ACTIVE-P and DELETE-BREAKPOINT
3044 (defun breakpoint-active-p (breakpoint)
3045 (ecase (breakpoint-status breakpoint)
3047 ((:inactive :deleted) nil)))
3049 ;;; Free system storage and remove computational overhead associated
3050 ;;; with breakpoint. After calling this, breakpoint is completely
3051 ;;; impotent and can never become active again.
3052 (defun delete-breakpoint (breakpoint)
3053 (let ((status (breakpoint-status breakpoint)))
3054 (unless (eq status :deleted)
3055 (when (eq status :active)
3056 (deactivate-breakpoint breakpoint))
3057 (setf (breakpoint-status breakpoint) :deleted)
3058 (let ((other (breakpoint-unknown-return-partner breakpoint)))
3060 (setf (breakpoint-status other) :deleted)))
3061 (when (eq (breakpoint-kind breakpoint) :fun-end)
3062 (let* ((starter (breakpoint-start-helper breakpoint))
3063 (breakpoints (delete breakpoint
3064 (the list (breakpoint-info starter)))))
3065 (setf (breakpoint-info starter) breakpoints)
3067 (delete-breakpoint starter)
3068 (setf (compiled-debug-fun-end-starter
3069 (breakpoint-what breakpoint))
3073 ;;;; C call out stubs
3075 ;;; This actually installs the break instruction in the component. It
3076 ;;; returns the overwritten bits. You must call this in a context in
3077 ;;; which GC is disabled, so that Lisp doesn't move objects around
3078 ;;; that C is pointing to.
3079 (sb!alien:def-alien-routine "breakpoint_install" sb!c-call:unsigned-long
3080 (code-obj sb!c-call:unsigned-long)
3081 (pc-offset sb!c-call:int))
3083 ;;; This removes the break instruction and replaces the original
3084 ;;; instruction. You must call this in a context in which GC is disabled
3085 ;;; so Lisp doesn't move objects around that C is pointing to.
3086 (sb!alien:def-alien-routine "breakpoint_remove" sb!c-call:void
3087 (code-obj sb!c-call:unsigned-long)
3088 (pc-offset sb!c-call:int)
3089 (old-inst sb!c-call:unsigned-long))
3091 (sb!alien:def-alien-routine "breakpoint_do_displaced_inst" sb!c-call:void
3092 (scp (* os-context-t))
3093 (orig-inst sb!c-call:unsigned-long))
3095 ;;;; breakpoint handlers (layer between C and exported interface)
3097 ;;; This maps components to a mapping of offsets to breakpoint-datas.
3098 (defvar *component-breakpoint-offsets* (make-hash-table :test 'eq))
3100 ;;; This returns the breakpoint-data associated with component cross
3101 ;;; offset. If none exists, this makes one, installs it, and returns it.
3102 (defun breakpoint-data (component offset &optional (create t))
3103 (flet ((install-breakpoint-data ()
3105 (let ((data (make-breakpoint-data component offset)))
3106 (push (cons offset data)
3107 (gethash component *component-breakpoint-offsets*))
3109 (let ((offsets (gethash component *component-breakpoint-offsets*)))
3111 (let ((data (assoc offset offsets)))
3114 (install-breakpoint-data)))
3115 (install-breakpoint-data)))))
3117 ;;; We use this when there are no longer any active breakpoints
3118 ;;; corresponding to data.
3119 (defun delete-breakpoint-data (data)
3120 (let* ((component (breakpoint-data-component data))
3121 (offsets (delete (breakpoint-data-offset data)
3122 (gethash component *component-breakpoint-offsets*)
3125 (setf (gethash component *component-breakpoint-offsets*) offsets)
3126 (remhash component *component-breakpoint-offsets*)))
3129 ;;; The C handler for interrupts calls this when it has a
3130 ;;; debugging-tool break instruction. This does NOT handle all breaks;
3131 ;;; for example, it does not handle breaks for internal errors.
3132 (defun handle-breakpoint (offset component signal-context)
3133 (/show0 "entering HANDLE-BREAKPOINT")
3134 (let ((data (breakpoint-data component offset nil)))
3136 (error "unknown breakpoint in ~S at offset ~S"
3137 (debug-fun-name (debug-fun-from-pc component offset))
3139 (let ((breakpoints (breakpoint-data-breakpoints data)))
3140 (if (or (null breakpoints)
3141 (eq (breakpoint-kind (car breakpoints)) :fun-end))
3142 (handle-fun-end-breakpoint-aux breakpoints data signal-context)
3143 (handle-breakpoint-aux breakpoints data
3144 offset component signal-context)))))
3146 ;;; This holds breakpoint-datas while invoking the breakpoint hooks
3147 ;;; associated with that particular component and location. While they
3148 ;;; are executing, if we hit the location again, we ignore the
3149 ;;; breakpoint to avoid infinite recursion. fun-end breakpoints
3150 ;;; must work differently since the breakpoint-data is unique for each
3152 (defvar *executing-breakpoint-hooks* nil)
3154 ;;; This handles code-location and DEBUG-FUN :FUN-START
3156 (defun handle-breakpoint-aux (breakpoints data offset component signal-context)
3157 (/show0 "entering HANDLE-BREAKPOINT-AUX")
3159 (error "internal error: breakpoint that nobody wants"))
3160 (unless (member data *executing-breakpoint-hooks*)
3161 (let ((*executing-breakpoint-hooks* (cons data
3162 *executing-breakpoint-hooks*)))
3163 (invoke-breakpoint-hooks breakpoints component offset)))
3164 ;; At this point breakpoints may not hold the same list as
3165 ;; BREAKPOINT-DATA-BREAKPOINTS since invoking hooks may have allowed
3166 ;; a breakpoint deactivation. In fact, if all breakpoints were
3167 ;; deactivated then data is invalid since it was deleted and so the
3168 ;; correct one must be looked up if it is to be used. If there are
3169 ;; no more breakpoints active at this location, then the normal
3170 ;; instruction has been put back, and we do not need to
3171 ;; DO-DISPLACED-INST.
3172 (let ((data (breakpoint-data component offset nil)))
3173 (when (and data (breakpoint-data-breakpoints data))
3174 ;; The breakpoint is still active, so we need to execute the
3175 ;; displaced instruction and leave the breakpoint instruction
3176 ;; behind. The best way to do this is different on each machine,
3177 ;; so we just leave it up to the C code.
3178 (breakpoint-do-displaced-inst signal-context
3179 (breakpoint-data-instruction data))
3180 ;; Some platforms have no usable sigreturn() call. If your
3181 ;; implementation of arch_do_displaced_inst() doesn't sigreturn(),
3182 ;; add it to this list.
3183 #!-(or hpux irix x86 alpha)
3184 (error "BREAKPOINT-DO-DISPLACED-INST returned?"))))
3186 (defun invoke-breakpoint-hooks (breakpoints component offset)
3187 (let* ((debug-fun (debug-fun-from-pc component offset))
3188 (frame (do ((f (top-frame) (frame-down f)))
3189 ((eq debug-fun (frame-debug-fun f)) f))))
3190 (dolist (bpt breakpoints)
3191 (funcall (breakpoint-hook-function bpt)
3193 ;; If this is an :UNKNOWN-RETURN-PARTNER, then pass the
3194 ;; hook function the original breakpoint, so that users
3195 ;; aren't forced to confront the fact that some
3196 ;; breakpoints really are two.
3197 (if (eq (breakpoint-kind bpt) :unknown-return-partner)
3198 (breakpoint-unknown-return-partner bpt)
3201 (defun handle-fun-end-breakpoint (offset component context)
3202 (/show0 "entering HANDLE-FUN-END-BREAKPOINT")
3203 (let ((data (breakpoint-data component offset nil)))
3205 (error "unknown breakpoint in ~S at offset ~S"
3206 (debug-fun-name (debug-fun-from-pc component offset))
3208 (let ((breakpoints (breakpoint-data-breakpoints data)))
3210 (aver (eq (breakpoint-kind (car breakpoints)) :fun-end))
3211 (handle-fun-end-breakpoint-aux breakpoints data context)))))
3213 ;;; Either HANDLE-BREAKPOINT calls this for :FUN-END breakpoints
3214 ;;; [old C code] or HANDLE-FUN-END-BREAKPOINT calls this directly
3216 (defun handle-fun-end-breakpoint-aux (breakpoints data signal-context)
3217 (/show0 "entering HANDLE-FUN-END-BREAKPOINT-AUX")
3218 (delete-breakpoint-data data)
3221 (declare (optimize (inhibit-warnings 3)))
3222 (sb!alien:sap-alien signal-context (* os-context-t))))
3223 (frame (do ((cfp (sb!vm:context-register scp sb!vm::cfp-offset))
3224 (f (top-frame) (frame-down f)))
3225 ((= cfp (sap-int (frame-pointer f))) f)
3226 (declare (type (unsigned-byte #.sb!vm:word-bits) cfp))))
3227 (component (breakpoint-data-component data))
3228 (cookie (gethash component *fun-end-cookies*)))
3229 (remhash component *fun-end-cookies*)
3230 (dolist (bpt breakpoints)
3231 (funcall (breakpoint-hook-function bpt)
3233 (get-fun-end-breakpoint-values scp)
3236 (defun get-fun-end-breakpoint-values (scp)
3237 (let ((ocfp (int-sap (sb!vm:context-register
3239 #!-x86 sb!vm::ocfp-offset
3240 #!+x86 sb!vm::ebx-offset)))
3241 (nargs (make-lisp-obj
3242 (sb!vm:context-register scp sb!vm::nargs-offset)))
3243 (reg-arg-offsets '#.sb!vm::*register-arg-offsets*)
3246 (dotimes (arg-num nargs)
3247 (push (if reg-arg-offsets
3249 (sb!vm:context-register scp (pop reg-arg-offsets)))
3250 (stack-ref ocfp arg-num))
3252 (nreverse results)))
3254 ;;;; MAKE-BOGUS-LRA (used for :FUN-END breakpoints)
3256 (defconstant bogus-lra-constants
3258 (defconstant known-return-p-slot
3259 (+ sb!vm:code-constants-offset #!-x86 1 #!+x86 2))
3261 ;;; Make a bogus LRA object that signals a breakpoint trap when
3262 ;;; returned to. If the breakpoint trap handler returns, REAL-LRA is
3263 ;;; returned to. Three values are returned: the bogus LRA object, the
3264 ;;; code component it is part of, and the PC offset for the trap
3266 (defun make-bogus-lra (real-lra &optional known-return-p)
3268 (let* ((src-start (foreign-symbol-address "fun_end_breakpoint_guts"))
3269 (src-end (foreign-symbol-address "fun_end_breakpoint_end"))
3270 (trap-loc (foreign-symbol-address "fun_end_breakpoint_trap"))
3271 (length (sap- src-end src-start))
3274 #!-(and x86 gencgc) sb!c:allocate-code-object
3275 #!+(and x86 gencgc) sb!c::allocate-dynamic-code-object
3276 (1+ bogus-lra-constants)
3278 (dst-start (code-instructions code-object)))
3279 (declare (type system-area-pointer
3280 src-start src-end dst-start trap-loc)
3281 (type index length))
3282 (setf (%code-debug-info code-object) :bogus-lra)
3283 (setf (code-header-ref code-object sb!vm:code-trace-table-offset-slot)
3286 (setf (code-header-ref code-object real-lra-slot) real-lra)
3288 (multiple-value-bind (offset code) (compute-lra-data-from-pc real-lra)
3289 (setf (code-header-ref code-object real-lra-slot) code)
3290 (setf (code-header-ref code-object (1+ real-lra-slot)) offset))
3291 (setf (code-header-ref code-object known-return-p-slot)
3293 (system-area-copy src-start 0 dst-start 0 (* length sb!vm:byte-bits))
3294 (sb!vm:sanctify-for-execution code-object)
3296 (values dst-start code-object (sap- trap-loc src-start))
3298 (let ((new-lra (make-lisp-obj (+ (sap-int dst-start)
3299 sb!vm:other-pointer-lowtag))))
3302 (logandc2 (+ sb!vm:code-constants-offset bogus-lra-constants 1)
3304 (sb!vm:sanctify-for-execution code-object)
3305 (values new-lra code-object (sap- trap-loc src-start))))))
3309 ;;; This appears here because it cannot go with the DEBUG-FUN
3310 ;;; interface since DO-DEBUG-BLOCK-LOCATIONS isn't defined until after
3311 ;;; the DEBUG-FUN routines.
3313 ;;; Return a code-location before the body of a function and after all
3314 ;;; the arguments are in place; or if that location can't be
3315 ;;; determined due to a lack of debug information, return NIL.
3316 (defun debug-fun-start-location (debug-fun)
3317 (etypecase debug-fun
3319 (code-location-from-pc debug-fun
3320 (sb!c::compiled-debug-fun-start-pc
3321 (compiled-debug-fun-compiler-debug-fun
3324 ;; (There used to be more cases back before sbcl-0.7.0, when
3325 ;; we did special tricks to debug the IR1 interpreter.)
3328 (defun print-code-locations (function)
3329 (let ((debug-fun (fun-debug-fun function)))
3330 (do-debug-fun-blocks (block debug-fun)
3331 (do-debug-block-locations (loc block)
3332 (fill-in-code-location loc)
3333 (format t "~S code location at ~D"
3334 (compiled-code-location-kind loc)
3335 (compiled-code-location-pc loc))
3336 (sb!debug::print-code-location-source-form loc 0)