1 ;;;; the implementation of the programmer's interface to writing
4 ;;;; This software is part of the SBCL system. See the README file for
7 ;;;; This software is derived from the CMU CL system, which was
8 ;;;; written at Carnegie Mellon University and released into the
9 ;;;; public domain. The software is in the public domain and is
10 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
11 ;;;; files for more information.
15 ;;; FIXME: There are an awful lot of package prefixes in this code.
16 ;;; Couldn't we have SB-DI use the SB-C and SB-VM packages?
20 ;;;; The interface to building debugging tools signals conditions that
21 ;;;; prevent it from adhering to its contract. These are
22 ;;;; serious-conditions because the program using the interface must
23 ;;;; handle them before it can correctly continue execution. These
24 ;;;; debugging conditions are not errors since it is no fault of the
25 ;;;; programmers that the conditions occur. The interface does not
26 ;;;; provide for programs to detect these situations other than
27 ;;;; calling a routine that detects them and signals a condition. For
28 ;;;; example, programmers call A which may fail to return successfully
29 ;;;; due to a lack of debug information, and there is no B the they
30 ;;;; could have called to realize A would fail. It is not an error to
31 ;;;; have called A, but it is an error for the program to then ignore
32 ;;;; the signal generated by A since it cannot continue without A's
33 ;;;; correctly returning a value or performing some operation.
35 ;;;; Use DEBUG-SIGNAL to signal these conditions.
37 (define-condition debug-condition (serious-condition)
41 "All DEBUG-CONDITIONs inherit from this type. These are serious conditions
42 that must be handled, but they are not programmer errors."))
44 (define-condition no-debug-info (debug-condition)
45 ((code-component :reader no-debug-info-code-component
46 :initarg :code-component))
48 (:documentation "There is no usable debugging information available.")
49 (:report (lambda (condition stream)
52 "no debug information available for ~S~%"
53 (no-debug-info-code-component condition)))))
55 (define-condition no-debug-fun-returns (debug-condition)
56 ((debug-fun :reader no-debug-fun-returns-debug-fun
60 "The system could not return values from a frame with DEBUG-FUN since
61 it lacked information about returning values.")
62 (:report (lambda (condition stream)
63 (let ((fun (debug-fun-fun
64 (no-debug-fun-returns-debug-fun condition))))
66 "~&Cannot return values from ~:[frame~;~:*~S~] since ~
67 the debug information lacks details about returning ~
71 (define-condition no-debug-blocks (debug-condition)
72 ((debug-fun :reader no-debug-blocks-debug-fun
75 (:documentation "The debug-fun has no debug-block information.")
76 (:report (lambda (condition stream)
77 (format stream "~&~S has no debug-block information."
78 (no-debug-blocks-debug-fun condition)))))
80 (define-condition no-debug-vars (debug-condition)
81 ((debug-fun :reader no-debug-vars-debug-fun
84 (:documentation "The DEBUG-FUN has no DEBUG-VAR information.")
85 (:report (lambda (condition stream)
86 (format stream "~&~S has no debug variable information."
87 (no-debug-vars-debug-fun condition)))))
89 (define-condition lambda-list-unavailable (debug-condition)
90 ((debug-fun :reader lambda-list-unavailable-debug-fun
94 "The DEBUG-FUN has no lambda list since argument DEBUG-VARs are
96 (:report (lambda (condition stream)
97 (format stream "~&~S has no lambda-list information available."
98 (lambda-list-unavailable-debug-fun condition)))))
100 (define-condition invalid-value (debug-condition)
101 ((debug-var :reader invalid-value-debug-var :initarg :debug-var)
102 (frame :reader invalid-value-frame :initarg :frame))
103 (:report (lambda (condition stream)
104 (format stream "~&~S has :invalid or :unknown value in ~S."
105 (invalid-value-debug-var condition)
106 (invalid-value-frame condition)))))
108 (define-condition ambiguous-var-name (debug-condition)
109 ((name :reader ambiguous-var-name-name :initarg :name)
110 (frame :reader ambiguous-var-name-frame :initarg :frame))
111 (:report (lambda (condition stream)
112 (format stream "~&~S names more than one valid variable in ~S."
113 (ambiguous-var-name-name condition)
114 (ambiguous-var-name-frame condition)))))
116 ;;;; errors and DEBUG-SIGNAL
118 ;;; The debug-internals code tries to signal all programmer errors as
119 ;;; subtypes of DEBUG-ERROR. There are calls to ERROR signalling
120 ;;; SIMPLE-ERRORs, but these dummy checks in the code and shouldn't
123 ;;; While under development, this code also signals errors in code
124 ;;; branches that remain unimplemented.
126 (define-condition debug-error (error) ()
129 "All programmer errors from using the interface for building debugging
130 tools inherit from this type."))
132 (define-condition unhandled-debug-condition (debug-error)
133 ((condition :reader unhandled-debug-condition-condition :initarg :condition))
134 (:report (lambda (condition stream)
135 (format stream "~&unhandled DEBUG-CONDITION:~%~A"
136 (unhandled-debug-condition-condition condition)))))
138 (define-condition unknown-code-location (debug-error)
139 ((code-location :reader unknown-code-location-code-location
140 :initarg :code-location))
141 (:report (lambda (condition stream)
142 (format stream "~&invalid use of an unknown code-location: ~S"
143 (unknown-code-location-code-location condition)))))
145 (define-condition unknown-debug-var (debug-error)
146 ((debug-var :reader unknown-debug-var-debug-var :initarg :debug-var)
147 (debug-fun :reader unknown-debug-var-debug-fun
148 :initarg :debug-fun))
149 (:report (lambda (condition stream)
150 (format stream "~&~S is not in ~S."
151 (unknown-debug-var-debug-var condition)
152 (unknown-debug-var-debug-fun condition)))))
154 (define-condition invalid-control-stack-pointer (debug-error)
156 (:report (lambda (condition stream)
157 (declare (ignore condition))
159 (write-string "invalid control stack pointer" stream))))
161 (define-condition frame-fun-mismatch (debug-error)
162 ((code-location :reader frame-fun-mismatch-code-location
163 :initarg :code-location)
164 (frame :reader frame-fun-mismatch-frame :initarg :frame)
165 (form :reader frame-fun-mismatch-form :initarg :form))
166 (:report (lambda (condition stream)
169 "~&Form was preprocessed for ~S,~% but called on ~S:~% ~S"
170 (frame-fun-mismatch-code-location condition)
171 (frame-fun-mismatch-frame condition)
172 (frame-fun-mismatch-form condition)))))
174 ;;; This signals debug-conditions. If they go unhandled, then signal
175 ;;; an UNHANDLED-DEBUG-CONDITION error.
177 ;;; ??? Get SIGNAL in the right package!
178 (defmacro debug-signal (datum &rest arguments)
179 `(let ((condition (make-condition ,datum ,@arguments)))
181 (error 'unhandled-debug-condition :condition condition)))
185 ;;;; Most of these structures model information stored in internal
186 ;;;; data structures created by the compiler. Whenever comments
187 ;;;; preface an object or type with "compiler", they refer to the
188 ;;;; internal compiler thing, not to the object or type with the same
189 ;;;; name in the "SB-DI" package.
193 ;;; These exist for caching data stored in packed binary form in
194 ;;; compiler DEBUG-FUNs.
195 (defstruct (debug-var (:constructor nil)
197 ;; the name of the variable
198 (symbol (missing-arg) :type symbol)
199 ;; a unique integer identification relative to other variables with the same
202 ;; Does the variable always have a valid value?
203 (alive-p nil :type boolean))
204 (def!method print-object ((debug-var debug-var) stream)
205 (print-unreadable-object (debug-var stream :type t :identity t)
208 (debug-var-symbol debug-var)
209 (debug-var-id debug-var))))
212 (setf (fdocumentation 'debug-var-id 'function)
213 "Return the integer that makes DEBUG-VAR's name and package unique
214 with respect to other DEBUG-VARs in the same function.")
216 (defstruct (compiled-debug-var
218 (:constructor make-compiled-debug-var
219 (symbol id alive-p sc-offset save-sc-offset))
221 ;; storage class and offset (unexported)
222 (sc-offset nil :type sb!c:sc-offset)
223 ;; storage class and offset when saved somewhere
224 (save-sc-offset nil :type (or sb!c:sc-offset null)))
228 ;;; These represent call frames on the stack.
229 (defstruct (frame (:constructor nil)
231 ;; the next frame up, or NIL when top frame
232 (up nil :type (or frame null))
233 ;; the previous frame down, or NIL when the bottom frame. Before
234 ;; computing the next frame down, this slot holds the frame pointer
235 ;; to the control stack for the given frame. This lets us get the
236 ;; next frame down and the return-pc for that frame.
237 (%down :unparsed :type (or frame (member nil :unparsed)))
238 ;; the DEBUG-FUN for the function whose call this frame represents
239 (debug-fun nil :type debug-fun)
240 ;; the CODE-LOCATION where the frame's DEBUG-FUN will continue
241 ;; running when program execution returns to this frame. If someone
242 ;; interrupted this frame, the result could be an unknown
244 (code-location nil :type code-location)
245 ;; an a-list of catch-tags to code-locations
246 (%catches :unparsed :type (or list (member :unparsed)))
247 ;; pointer to frame on control stack (unexported)
249 ;; This is the frame's number for prompt printing. Top is zero.
250 (number 0 :type index))
252 (defstruct (compiled-frame
254 (:constructor make-compiled-frame
255 (pointer up debug-fun code-location number
258 ;; This indicates whether someone interrupted the frame.
259 ;; (unexported). If escaped, this is a pointer to the state that was
260 ;; saved when we were interrupted, an os_context_t, i.e. the third
261 ;; argument to an SA_SIGACTION-style signal handler.
263 (def!method print-object ((obj compiled-frame) str)
264 (print-unreadable-object (obj str :type t)
266 "~S~:[~;, interrupted~]"
267 (debug-fun-name (frame-debug-fun obj))
268 (compiled-frame-escaped obj))))
272 ;;; These exist for caching data stored in packed binary form in
273 ;;; compiler DEBUG-FUNs. *COMPILED-DEBUG-FUNS* maps a SB!C::DEBUG-FUN
274 ;;; to a DEBUG-FUN. There should only be one DEBUG-FUN in existence
275 ;;; for any function; that is, all CODE-LOCATIONs and other objects
276 ;;; that reference DEBUG-FUNs point to unique objects. This is
277 ;;; due to the overhead in cached information.
278 (defstruct (debug-fun (:constructor nil)
280 ;; some representation of the function arguments. See
281 ;; DEBUG-FUN-LAMBDA-LIST.
282 ;; NOTE: must parse vars before parsing arg list stuff.
283 (%lambda-list :unparsed)
284 ;; cached DEBUG-VARS information (unexported).
285 ;; These are sorted by their name.
286 (%debug-vars :unparsed :type (or simple-vector null (member :unparsed)))
287 ;; cached debug-block information. This is NIL when we have tried to
288 ;; parse the packed binary info, but none is available.
289 (blocks :unparsed :type (or simple-vector null (member :unparsed)))
290 ;; the actual function if available
291 (%function :unparsed :type (or null function (member :unparsed))))
292 (def!method print-object ((obj debug-fun) stream)
293 (print-unreadable-object (obj stream :type t)
294 (prin1 (debug-fun-name obj) stream)))
296 (defstruct (compiled-debug-fun
298 (:constructor %make-compiled-debug-fun
299 (compiler-debug-fun component))
301 ;; compiler's dumped DEBUG-FUN information (unexported)
302 (compiler-debug-fun nil :type sb!c::compiled-debug-fun)
303 ;; code object (unexported).
305 ;; the :FUN-START breakpoint (if any) used to facilitate
306 ;; function end breakpoints
307 (end-starter nil :type (or null breakpoint)))
309 ;;; This maps SB!C::COMPILED-DEBUG-FUNs to
310 ;;; COMPILED-DEBUG-FUNs, so we can get at cached stuff and not
311 ;;; duplicate COMPILED-DEBUG-FUN structures.
312 (defvar *compiled-debug-funs* (make-hash-table :test 'eq))
314 ;;; Make a COMPILED-DEBUG-FUN for a SB!C::COMPILER-DEBUG-FUN
315 ;;; and its component. This maps the latter to the former in
316 ;;; *COMPILED-DEBUG-FUNS*. If there already is a
317 ;;; COMPILED-DEBUG-FUN, then this returns it from
318 ;;; *COMPILED-DEBUG-FUNS*.
319 (defun make-compiled-debug-fun (compiler-debug-fun component)
320 (or (gethash compiler-debug-fun *compiled-debug-funs*)
321 (setf (gethash compiler-debug-fun *compiled-debug-funs*)
322 (%make-compiled-debug-fun compiler-debug-fun component))))
324 (defstruct (bogus-debug-fun
326 (:constructor make-bogus-debug-fun
335 (defvar *ir1-lambda-debug-fun* (make-hash-table :test 'eq))
339 ;;; These exist for caching data stored in packed binary form in compiler
341 (defstruct (debug-block (:constructor nil)
343 ;; Code-locations where execution continues after this block.
344 (successors nil :type list)
345 ;; This indicates whether the block is a special glob of code shared
346 ;; by various functions and tucked away elsewhere in a component.
347 ;; This kind of block has no start code-location. This slot is in
348 ;; all debug-blocks since it is an exported interface.
349 (elsewhere-p nil :type boolean))
350 (def!method print-object ((obj debug-block) str)
351 (print-unreadable-object (obj str :type t)
352 (prin1 (debug-block-fun-name obj) str)))
355 (setf (fdocumentation 'debug-block-successors 'function)
356 "Return the list of possible code-locations where execution may continue
357 when the basic-block represented by debug-block completes its execution.")
360 (setf (fdocumentation 'debug-block-elsewhere-p 'function)
361 "Return whether debug-block represents elsewhere code.")
363 (defstruct (compiled-debug-block (:include debug-block)
365 make-compiled-debug-block
366 (code-locations successors elsewhere-p))
368 ;; code-location information for the block
369 (code-locations nil :type simple-vector))
371 (defvar *ir1-block-debug-block* (make-hash-table :test 'eq))
375 ;;; This is an internal structure that manages information about a
376 ;;; breakpoint locations. See *COMPONENT-BREAKPOINT-OFFSETS*.
377 (defstruct (breakpoint-data (:constructor make-breakpoint-data
380 ;; This is the component in which the breakpoint lies.
382 ;; This is the byte offset into the component.
383 (offset nil :type index)
384 ;; The original instruction replaced by the breakpoint.
385 (instruction nil :type (or null (unsigned-byte 32)))
386 ;; A list of user breakpoints at this location.
387 (breakpoints nil :type list))
388 (def!method print-object ((obj breakpoint-data) str)
389 (print-unreadable-object (obj str :type t)
390 (format str "~S at ~S"
392 (debug-fun-from-pc (breakpoint-data-component obj)
393 (breakpoint-data-offset obj)))
394 (breakpoint-data-offset obj))))
396 (defstruct (breakpoint (:constructor %make-breakpoint
397 (hook-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 index (member :unparsed)))
471 ;; This is the depth-first number of the node that begins
472 ;; code-location within its top level form.
473 (%form-number :unparsed :type (or index (member :unparsed))))
474 (def!method print-object ((obj code-location) str)
475 (print-unreadable-object (obj str :type t)
476 (prin1 (debug-fun-name (code-location-debug-fun obj))
479 (defstruct (compiled-code-location
480 (:include code-location)
481 (:constructor make-known-code-location
482 (pc debug-fun %tlf-offset %form-number
483 %live-set kind &aux (%unknown-p nil)))
484 (:constructor make-compiled-code-location (pc debug-fun))
486 ;; an index into DEBUG-FUN's component slot
488 ;; a bit-vector indexed by a variable's position in
489 ;; DEBUG-FUN-DEBUG-VARS indicating whether the variable has a
490 ;; valid value at this code-location. (unexported).
491 (%live-set :unparsed :type (or simple-bit-vector (member :unparsed)))
492 ;; (unexported) To see SB!C::LOCATION-KIND, do
493 ;; (SB!KERNEL:TYPE-EXPAND 'SB!C::LOCATION-KIND).
494 (kind :unparsed :type (or (member :unparsed) sb!c::location-kind)))
498 ;;; Return the number of top level forms processed by the compiler
499 ;;; before compiling this source. If this source is uncompiled, this
500 ;;; is zero. This may be zero even if the source is compiled since the
501 ;;; first form in the first file compiled in one compilation, for
502 ;;; example, must have a root number of zero -- the compiler saw no
503 ;;; other top level forms before it.
504 (defun debug-source-root-number (debug-source)
505 (sb!c::debug-source-source-root debug-source))
509 ;;; This is used in FIND-ESCAPED-FRAME and with the bogus components
510 ;;; and LRAs used for :FUN-END breakpoints. When a components
511 ;;; debug-info slot is :BOGUS-LRA, then the REAL-LRA-SLOT contains the
512 ;;; real component to continue executing, as opposed to the bogus
513 ;;; component which appeared in some frame's LRA location.
514 (defconstant real-lra-slot sb!vm:code-constants-offset)
516 ;;; These are magically converted by the compiler.
517 (defun current-sp () (current-sp))
518 (defun current-fp () (current-fp))
519 (defun stack-ref (s n) (stack-ref s n))
520 (defun %set-stack-ref (s n value) (%set-stack-ref s n value))
521 (defun fun-code-header (fun) (fun-code-header fun))
522 (defun lra-code-header (lra) (lra-code-header lra))
523 (defun make-lisp-obj (value) (make-lisp-obj value))
524 (defun get-lisp-obj-address (thing) (get-lisp-obj-address thing))
525 (defun fun-word-offset (fun) (fun-word-offset fun))
527 #!-sb-fluid (declaim (inline cstack-pointer-valid-p))
528 (defun cstack-pointer-valid-p (x)
529 (declare (type system-area-pointer x))
530 #!-x86 ; stack grows toward high address values
531 (and (sap< x (current-sp))
532 (sap<= (int-sap control-stack-start)
534 (zerop (logand (sap-int x) #b11)))
535 #!+x86 ; stack grows toward low address values
536 (and (sap>= x (current-sp))
537 (sap> (int-sap control-stack-end) x)
538 (zerop (logand (sap-int x) #b11))))
541 (sb!alien:define-alien-routine component-ptr-from-pc (system-area-pointer)
542 (pc system-area-pointer))
545 (defun component-from-component-ptr (component-ptr)
546 (declare (type system-area-pointer component-ptr))
547 (make-lisp-obj (logior (sap-int component-ptr)
548 sb!vm:other-pointer-lowtag)))
555 (defun compute-lra-data-from-pc (pc)
556 (declare (type system-area-pointer pc))
557 (let ((component-ptr (component-ptr-from-pc pc)))
558 (unless (sap= component-ptr (int-sap #x0))
559 (let* ((code (component-from-component-ptr component-ptr))
560 (code-header-len (* (get-header-data code) sb!vm:n-word-bytes))
561 (pc-offset (- (sap-int pc)
562 (- (get-lisp-obj-address code)
563 sb!vm:other-pointer-lowtag)
565 ; (format t "c-lra-fpc ~A ~A ~A~%" pc code pc-offset)
566 (values pc-offset code)))))
568 (defconstant sb!vm::nargs-offset #.sb!vm::ecx-offset)
570 ;;; Check for a valid return address - it could be any valid C/Lisp
573 ;;; XXX Could be a little smarter.
574 #!-sb-fluid (declaim (inline ra-pointer-valid-p))
575 (defun ra-pointer-valid-p (ra)
576 (declare (type system-area-pointer ra))
578 ;; Not the first page which is unmapped.
579 (>= (sap-int ra) 4096)
580 ;; Not a Lisp stack pointer.
581 (not (cstack-pointer-valid-p ra))))
583 ;;; Try to find a valid previous stack. This is complex on the x86 as
584 ;;; it can jump between C and Lisp frames. To help find a valid frame
585 ;;; it searches backwards.
587 ;;; XXX Should probably check whether it has reached the bottom of the
590 ;;; XXX Should handle interrupted frames, both Lisp and C. At present
591 ;;; it manages to find a fp trail, see linux hack below.
592 (defun x86-call-context (fp &key (depth 0))
593 (declare (type system-area-pointer fp)
595 ;;(format t "*CC ~S ~S~%" fp depth)
597 ((not (cstack-pointer-valid-p fp))
598 #+nil (format t "debug invalid fp ~S~%" fp)
601 ;; Check the two possible frame pointers.
602 (let ((lisp-ocfp (sap-ref-sap fp (- (* (1+ ocfp-save-offset) 4))))
603 (lisp-ra (sap-ref-sap fp (- (* (1+ return-pc-save-offset)
605 (c-ocfp (sap-ref-sap fp (* 0 sb!vm:n-word-bytes)))
606 (c-ra (sap-ref-sap fp (* 1 sb!vm:n-word-bytes))))
607 (cond ((and (sap> lisp-ocfp fp) (cstack-pointer-valid-p lisp-ocfp)
608 (ra-pointer-valid-p lisp-ra)
609 (sap> c-ocfp fp) (cstack-pointer-valid-p c-ocfp)
610 (ra-pointer-valid-p c-ra))
612 "*C Both valid ~S ~S ~S ~S~%"
613 lisp-ocfp lisp-ra c-ocfp c-ra)
614 ;; Look forward another step to check their validity.
615 (let ((lisp-path-fp (x86-call-context lisp-ocfp
617 (c-path-fp (x86-call-context c-ocfp :depth (1+ depth))))
618 (cond ((and lisp-path-fp c-path-fp)
619 ;; Both still seem valid - choose the lisp frame.
620 #+nil (when (zerop depth)
622 "debug: both still valid ~S ~S ~S ~S~%"
623 lisp-ocfp lisp-ra c-ocfp c-ra))
625 (if (sap> lisp-ocfp c-ocfp)
626 (values lisp-ra lisp-ocfp)
627 (values c-ra c-ocfp))
629 (values lisp-ra lisp-ocfp))
631 ;; The lisp convention is looking good.
632 #+nil (format t "*C lisp-ocfp ~S ~S~%" lisp-ocfp lisp-ra)
633 (values lisp-ra lisp-ocfp))
635 ;; The C convention is looking good.
636 #+nil (format t "*C c-ocfp ~S ~S~%" c-ocfp c-ra)
637 (values c-ra c-ocfp))
639 ;; Neither seems right?
640 #+nil (format t "debug: no valid2 fp found ~S ~S~%"
643 ((and (sap> lisp-ocfp fp) (cstack-pointer-valid-p lisp-ocfp)
644 (ra-pointer-valid-p lisp-ra))
645 ;; The lisp convention is looking good.
646 #+nil (format t "*C lisp-ocfp ~S ~S~%" lisp-ocfp lisp-ra)
647 (values lisp-ra lisp-ocfp))
648 ((and (sap> c-ocfp fp) (cstack-pointer-valid-p c-ocfp)
649 #!-linux (ra-pointer-valid-p c-ra))
650 ;; The C convention is looking good.
651 #+nil (format t "*C c-ocfp ~S ~S~%" c-ocfp c-ra)
652 (values c-ra c-ocfp))
654 #+nil (format t "debug: no valid fp found ~S ~S~%"
660 ;;; Convert the descriptor into a SAP. The bits all stay the same, we just
661 ;;; change our notion of what we think they are.
662 #!-sb-fluid (declaim (inline descriptor-sap))
663 (defun descriptor-sap (x)
664 (int-sap (get-lisp-obj-address x)))
666 ;;; Return the top frame of the control stack as it was before calling
669 (/noshow0 "entering TOP-FRAME")
670 (multiple-value-bind (fp pc) (%caller-frame-and-pc)
671 (compute-calling-frame (descriptor-sap fp) pc nil)))
673 ;;; Flush all of the frames above FRAME, and renumber all the frames
675 (defun flush-frames-above (frame)
676 (setf (frame-up frame) nil)
677 (do ((number 0 (1+ number))
678 (frame frame (frame-%down frame)))
679 ((not (frame-p frame)))
680 (setf (frame-number frame) number)))
682 ;;; Return the frame immediately below FRAME on the stack; or when
683 ;;; FRAME is the bottom of the stack, return NIL.
684 (defun frame-down (frame)
685 (/noshow0 "entering FRAME-DOWN")
686 ;; We have to access the old-fp and return-pc out of frame and pass
687 ;; them to COMPUTE-CALLING-FRAME.
688 (let ((down (frame-%down frame)))
689 (if (eq down :unparsed)
690 (let ((debug-fun (frame-debug-fun frame)))
691 (/noshow0 "in DOWN :UNPARSED case")
692 (setf (frame-%down frame)
695 (let ((c-d-f (compiled-debug-fun-compiler-debug-fun
697 (compute-calling-frame
700 frame ocfp-save-offset
701 (sb!c::compiled-debug-fun-old-fp c-d-f)))
703 frame lra-save-offset
704 (sb!c::compiled-debug-fun-return-pc c-d-f))
707 (let ((fp (frame-pointer frame)))
708 (when (cstack-pointer-valid-p fp)
710 (multiple-value-bind (ra ofp) (x86-call-context fp)
711 (compute-calling-frame ofp ra frame))
713 (compute-calling-frame
715 (sap-ref-sap fp (* ocfp-save-offset
719 (sap-ref-32 fp (* ocfp-save-offset
720 sb!vm:n-word-bytes)))
722 (stack-ref fp lra-save-offset)
727 ;;; Get the old FP or return PC out of FRAME. STACK-SLOT is the
728 ;;; standard save location offset on the stack. LOC is the saved
729 ;;; SC-OFFSET describing the main location.
731 (defun get-context-value (frame stack-slot loc)
732 (declare (type compiled-frame frame) (type unsigned-byte stack-slot)
733 (type sb!c:sc-offset loc))
734 (let ((pointer (frame-pointer frame))
735 (escaped (compiled-frame-escaped frame)))
737 (sub-access-debug-var-slot pointer loc escaped)
738 (stack-ref pointer stack-slot))))
740 (defun get-context-value (frame stack-slot loc)
741 (declare (type compiled-frame frame) (type unsigned-byte stack-slot)
742 (type sb!c:sc-offset loc))
743 (let ((pointer (frame-pointer frame))
744 (escaped (compiled-frame-escaped frame)))
746 (sub-access-debug-var-slot pointer loc escaped)
749 (stack-ref pointer stack-slot))
751 (sap-ref-sap pointer (- (* (1+ stack-slot) 4))))))))
754 (defun (setf get-context-value) (value frame stack-slot loc)
755 (declare (type compiled-frame frame) (type unsigned-byte stack-slot)
756 (type sb!c:sc-offset loc))
757 (let ((pointer (frame-pointer frame))
758 (escaped (compiled-frame-escaped frame)))
760 (sub-set-debug-var-slot pointer loc value escaped)
761 (setf (stack-ref pointer stack-slot) value))))
764 (defun (setf get-context-value) (value frame stack-slot loc)
765 (declare (type compiled-frame frame) (type unsigned-byte stack-slot)
766 (type sb!c:sc-offset loc))
767 (let ((pointer (frame-pointer frame))
768 (escaped (compiled-frame-escaped frame)))
770 (sub-set-debug-var-slot pointer loc value escaped)
773 (setf (stack-ref pointer stack-slot) value))
775 (setf (sap-ref-sap pointer (- (* (1+ stack-slot) 4))) value))))))
777 ;;; This returns a frame for the one existing in time immediately
778 ;;; prior to the frame referenced by current-fp. This is current-fp's
779 ;;; caller or the next frame down the control stack. If there is no
780 ;;; down frame, this returns NIL for the bottom of the stack. UP-FRAME
781 ;;; is the up link for the resulting frame object, and it is null when
782 ;;; we call this to get the top of the stack.
784 ;;; The current frame contains the pointer to the temporally previous
785 ;;; frame we want, and the current frame contains the pc at which we
786 ;;; will continue executing upon returning to that previous frame.
788 ;;; Note: Sometimes LRA is actually a fixnum. This happens when lisp
789 ;;; calls into C. In this case, the code object is stored on the stack
790 ;;; after the LRA, and the LRA is the word offset.
792 (defun compute-calling-frame (caller lra up-frame)
793 (declare (type system-area-pointer caller))
794 (when (cstack-pointer-valid-p caller)
795 (multiple-value-bind (code pc-offset escaped)
797 (multiple-value-bind (word-offset code)
799 (let ((fp (frame-pointer up-frame)))
801 (stack-ref fp (1+ lra-save-offset))))
802 (values (get-header-data lra)
803 (lra-code-header lra)))
806 (* (1+ (- word-offset (get-header-data code)))
809 (values :foreign-function
812 (find-escaped-frame caller))
813 (if (and (code-component-p code)
814 (eq (%code-debug-info code) :bogus-lra))
815 (let ((real-lra (code-header-ref code real-lra-slot)))
816 (compute-calling-frame caller real-lra up-frame))
817 (let ((d-fun (case code
819 (make-bogus-debug-fun
820 "undefined function"))
822 (make-bogus-debug-fun
823 "foreign function call land"))
825 (make-bogus-debug-fun
826 "bogus stack frame"))
828 (debug-fun-from-pc code pc-offset)))))
829 (make-compiled-frame caller up-frame d-fun
830 (code-location-from-pc d-fun pc-offset
832 (if up-frame (1+ (frame-number up-frame)) 0)
835 (defun compute-calling-frame (caller ra up-frame)
836 (declare (type system-area-pointer caller ra))
837 (/noshow0 "entering COMPUTE-CALLING-FRAME")
838 (when (cstack-pointer-valid-p caller)
840 ;; First check for an escaped frame.
841 (multiple-value-bind (code pc-offset escaped) (find-escaped-frame caller)
844 (/noshow0 "in CODE clause")
845 ;; If it's escaped it may be a function end breakpoint trap.
846 (when (and (code-component-p code)
847 (eq (%code-debug-info code) :bogus-lra))
848 ;; If :bogus-lra grab the real lra.
849 (setq pc-offset (code-header-ref
850 code (1+ real-lra-slot)))
851 (setq code (code-header-ref code real-lra-slot))
854 (/noshow0 "in T clause")
856 (multiple-value-setq (pc-offset code)
857 (compute-lra-data-from-pc ra))
859 (setf code :foreign-function
863 (let ((d-fun (case code
865 (make-bogus-debug-fun
866 "undefined function"))
868 (make-bogus-debug-fun
869 "foreign function call land"))
871 (make-bogus-debug-fun
872 "bogus stack frame"))
874 (debug-fun-from-pc code pc-offset)))))
875 (/noshow0 "returning MAKE-COMPILED-FRAME from COMPUTE-CALLING-FRAME")
876 (make-compiled-frame caller up-frame d-fun
877 (code-location-from-pc d-fun pc-offset
879 (if up-frame (1+ (frame-number up-frame)) 0)
883 (defun find-escaped-frame (frame-pointer)
884 (declare (type system-area-pointer frame-pointer))
885 (/noshow0 "entering FIND-ESCAPED-FRAME")
886 (dotimes (index *free-interrupt-context-index* (values nil 0 nil))
888 ((lisp-interrupt-contexts (array (* os-context-t) nil) :extern))
889 (/noshow0 "at head of WITH-ALIEN")
890 (let ((context (sb!alien:deref lisp-interrupt-contexts index)))
891 (/noshow0 "got CONTEXT")
892 (when (= (sap-int frame-pointer)
893 (sb!vm:context-register context sb!vm::cfp-offset))
895 (/noshow0 "in WITHOUT-GCING")
896 (let* ((component-ptr (component-ptr-from-pc
897 (sb!vm:context-pc context)))
898 (code (unless (sap= component-ptr (int-sap #x0))
899 (component-from-component-ptr component-ptr))))
900 (/noshow0 "got CODE")
902 (return (values code 0 context)))
903 (let* ((code-header-len (* (get-header-data code)
906 (- (sap-int (sb!vm:context-pc context))
907 (- (get-lisp-obj-address code)
908 sb!vm:other-pointer-lowtag)
910 (/noshow "got PC-OFFSET")
911 (unless (<= 0 pc-offset
912 (* (code-header-ref code sb!vm:code-code-size-slot)
914 ;; We were in an assembly routine. Therefore, use the
917 ;; FIXME: Should this be WARN or ERROR or what?
918 (format t "** pc-offset ~S not in code obj ~S?~%"
920 (/noshow0 "returning from FIND-ESCAPED-FRAME")
922 (values code pc-offset context))))))))))
925 (defun find-escaped-frame (frame-pointer)
926 (declare (type system-area-pointer frame-pointer))
927 (dotimes (index *free-interrupt-context-index* (values nil 0 nil))
929 ((lisp-interrupt-contexts (array (* os-context-t) nil) :extern))
930 (let ((scp (sb!alien:deref lisp-interrupt-contexts index)))
931 (when (= (sap-int frame-pointer)
932 (sb!vm:context-register scp sb!vm::cfp-offset))
934 (let ((code (code-object-from-bits
935 (sb!vm:context-register scp sb!vm::code-offset))))
937 (return (values code 0 scp)))
938 (let* ((code-header-len (* (get-header-data code)
941 (- (sap-int (sb!vm:context-pc scp))
942 (- (get-lisp-obj-address code)
943 sb!vm:other-pointer-lowtag)
945 ;; Check to see whether we were executing in a branch
947 #!+(or pmax sgi) ; pmax only (and broken anyway)
948 (when (logbitp 31 (sb!alien:slot scp '%mips::sc-cause))
949 (incf pc-offset sb!vm:n-word-bytes))
950 (unless (<= 0 pc-offset
951 (* (code-header-ref code sb!vm:code-code-size-slot)
953 ;; We were in an assembly routine. Therefore, use the
956 (- (sb!vm:context-register scp sb!vm::lra-offset)
957 (get-lisp-obj-address code)
960 (if (eq (%code-debug-info code) :bogus-lra)
961 (let ((real-lra (code-header-ref code
963 (values (lra-code-header real-lra)
964 (get-header-data real-lra)
966 (values code pc-offset scp)))))))))))
968 ;;; Find the code object corresponding to the object represented by
969 ;;; bits and return it. We assume bogus functions correspond to the
970 ;;; undefined-function.
971 (defun code-object-from-bits (bits)
972 (declare (type (unsigned-byte 32) bits))
973 (let ((object (make-lisp-obj bits)))
974 (if (functionp object)
975 (or (fun-code-header object)
977 (let ((lowtag (lowtag-of object)))
978 (if (= lowtag sb!vm:other-pointer-lowtag)
979 (let ((widetag (widetag-of object)))
980 (cond ((= widetag sb!vm:code-header-widetag)
982 ((= widetag sb!vm:return-pc-header-widetag)
983 (lra-code-header object))
989 ;;; This returns a COMPILED-DEBUG-FUN for COMPONENT and PC. We fetch the
990 ;;; SB!C::DEBUG-INFO and run down its FUN-MAP to get a
991 ;;; SB!C::COMPILED-DEBUG-FUN from the PC. The result only needs to
992 ;;; reference the COMPONENT, for function constants, and the
993 ;;; SB!C::COMPILED-DEBUG-FUN.
994 (defun debug-fun-from-pc (component pc)
995 (let ((info (%code-debug-info component)))
998 (debug-signal 'no-debug-info :code-component component))
999 ((eq info :bogus-lra)
1000 (make-bogus-debug-fun "function end breakpoint"))
1002 (let* ((fun-map (sb!c::compiled-debug-info-fun-map info))
1003 (len (length fun-map)))
1004 (declare (type simple-vector fun-map))
1006 (make-compiled-debug-fun (svref fun-map 0) component)
1009 (>= pc (sb!c::compiled-debug-fun-elsewhere-pc
1010 (svref fun-map 0)))))
1011 (declare (type sb!int:index i))
1014 (< pc (if elsewhere-p
1015 (sb!c::compiled-debug-fun-elsewhere-pc
1016 (svref fun-map (1+ i)))
1017 (svref fun-map i))))
1018 (return (make-compiled-debug-fun
1019 (svref fun-map (1- i))
1023 ;;; This returns a code-location for the COMPILED-DEBUG-FUN,
1024 ;;; DEBUG-FUN, and the pc into its code vector. If we stopped at a
1025 ;;; breakpoint, find the CODE-LOCATION for that breakpoint. Otherwise,
1026 ;;; make an :UNSURE code location, so it can be filled in when we
1027 ;;; figure out what is going on.
1028 (defun code-location-from-pc (debug-fun pc escaped)
1029 (or (and (compiled-debug-fun-p debug-fun)
1031 (let ((data (breakpoint-data
1032 (compiled-debug-fun-component debug-fun)
1034 (when (and data (breakpoint-data-breakpoints data))
1035 (let ((what (breakpoint-what
1036 (first (breakpoint-data-breakpoints data)))))
1037 (when (compiled-code-location-p what)
1039 (make-compiled-code-location pc debug-fun)))
1041 ;;; Return an alist mapping catch tags to CODE-LOCATIONs. These are
1042 ;;; CODE-LOCATIONs at which execution would continue with frame as the
1043 ;;; top frame if someone threw to the corresponding tag.
1044 (defun frame-catches (frame)
1045 (let ((catch (descriptor-sap sb!vm:*current-catch-block*))
1046 (reversed-result nil)
1047 (fp (frame-pointer frame)))
1048 (loop until (zerop (sap-int catch))
1049 finally (return (nreverse reversed-result))
1054 (* sb!vm:catch-block-current-cont-slot
1055 sb!vm:n-word-bytes))
1059 (* sb!vm:catch-block-current-cont-slot
1060 sb!vm:n-word-bytes))))
1062 (lra (stack-ref catch sb!vm:catch-block-entry-pc-slot))
1065 catch (* sb!vm:catch-block-entry-pc-slot
1066 sb!vm:n-word-bytes)))
1069 (stack-ref catch sb!vm:catch-block-current-code-slot))
1071 (component (component-from-component-ptr
1072 (component-ptr-from-pc ra)))
1075 (* (- (1+ (get-header-data lra))
1076 (get-header-data component))
1080 (- (get-lisp-obj-address component)
1081 sb!vm:other-pointer-lowtag)
1082 (* (get-header-data component) sb!vm:n-word-bytes))))
1084 (stack-ref catch sb!vm:catch-block-tag-slot)
1087 (sap-ref-32 catch (* sb!vm:catch-block-tag-slot
1088 sb!vm:n-word-bytes)))
1089 (make-compiled-code-location
1090 offset (frame-debug-fun frame)))
1095 (* sb!vm:catch-block-previous-catch-slot
1096 sb!vm:n-word-bytes))
1100 (* sb!vm:catch-block-previous-catch-slot
1101 sb!vm:n-word-bytes)))))))
1103 ;;;; operations on DEBUG-FUNs
1105 ;;; Execute the forms in a context with BLOCK-VAR bound to each
1106 ;;; DEBUG-BLOCK in DEBUG-FUN successively. Result is an optional
1107 ;;; form to execute for return values, and DO-DEBUG-FUN-BLOCKS
1108 ;;; returns nil if there is no result form. This signals a
1109 ;;; NO-DEBUG-BLOCKS condition when the DEBUG-FUN lacks
1110 ;;; DEBUG-BLOCK information.
1111 (defmacro do-debug-fun-blocks ((block-var debug-fun &optional result)
1113 (let ((blocks (gensym))
1115 `(let ((,blocks (debug-fun-debug-blocks ,debug-fun)))
1116 (declare (simple-vector ,blocks))
1117 (dotimes (,i (length ,blocks) ,result)
1118 (let ((,block-var (svref ,blocks ,i)))
1121 ;;; Execute body in a context with VAR bound to each DEBUG-VAR in
1122 ;;; DEBUG-FUN. This returns the value of executing result (defaults to
1123 ;;; nil). This may iterate over only some of DEBUG-FUN's variables or
1124 ;;; none depending on debug policy; for example, possibly the
1125 ;;; compilation only preserved argument information.
1126 (defmacro do-debug-fun-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 (declare (type debug-fun debug-fun))
1167 (etypecase debug-fun
1169 (sb!c::compiled-debug-fun-name
1170 (compiled-debug-fun-compiler-debug-fun debug-fun)))
1172 (bogus-debug-fun-%name debug-fun))))
1174 ;;; Return a DEBUG-FUN that represents debug information for FUN.
1175 (defun fun-debug-fun (fun)
1176 (declare (type function fun))
1177 (ecase (widetag-of fun)
1178 (#.sb!vm:closure-header-widetag
1179 (fun-debug-fun (%closure-fun fun)))
1180 (#.sb!vm:funcallable-instance-header-widetag
1181 (fun-debug-fun (funcallable-instance-fun fun)))
1182 ((#.sb!vm:simple-fun-header-widetag
1183 #.sb!vm:closure-fun-header-widetag)
1184 (let* ((name (%simple-fun-name fun))
1185 (component (fun-code-header fun))
1188 (and (sb!c::compiled-debug-fun-p x)
1189 (eq (sb!c::compiled-debug-fun-name x) name)
1190 (eq (sb!c::compiled-debug-fun-kind x) nil)))
1191 (sb!c::compiled-debug-info-fun-map
1192 (%code-debug-info component)))))
1194 (make-compiled-debug-fun res component)
1195 ;; KLUDGE: comment from CMU CL:
1196 ;; This used to be the non-interpreted branch, but
1197 ;; William wrote it to return the debug-fun of fun's XEP
1198 ;; instead of fun's debug-fun. The above code does this
1199 ;; more correctly, but it doesn't get or eliminate all
1200 ;; appropriate cases. It mostly works, and probably
1201 ;; works for all named functions anyway.
1203 (debug-fun-from-pc component
1204 (* (- (fun-word-offset fun)
1205 (get-header-data component))
1206 sb!vm:n-word-bytes)))))))
1208 ;;; Return the kind of the function, which is one of :OPTIONAL,
1209 ;;; :EXTERNAL, :TOPLEVEL, :CLEANUP, or NIL.
1210 (defun debug-fun-kind (debug-fun)
1211 ;; FIXME: This "is one of" information should become part of the function
1212 ;; declamation, not just a doc string
1213 (etypecase debug-fun
1215 (sb!c::compiled-debug-fun-kind
1216 (compiled-debug-fun-compiler-debug-fun debug-fun)))
1220 ;;; Is there any variable information for DEBUG-FUN?
1221 (defun debug-var-info-available (debug-fun)
1222 (not (not (debug-fun-debug-vars debug-fun))))
1224 ;;; Return a list of DEBUG-VARs in DEBUG-FUN having the same name
1225 ;;; and package as SYMBOL. If SYMBOL is uninterned, then this returns
1226 ;;; a list of DEBUG-VARs without package names and with the same name
1227 ;;; as symbol. The result of this function is limited to the
1228 ;;; availability of variable information in DEBUG-FUN; for
1229 ;;; example, possibly DEBUG-FUN only knows about its arguments.
1230 (defun debug-fun-symbol-variables (debug-fun symbol)
1231 (let ((vars (ambiguous-debug-vars debug-fun (symbol-name symbol)))
1232 (package (and (symbol-package symbol)
1233 (package-name (symbol-package symbol)))))
1234 (delete-if (if (stringp package)
1236 (let ((p (debug-var-package-name var)))
1237 (or (not (stringp p))
1238 (string/= p package))))
1240 (stringp (debug-var-package-name var))))
1243 ;;; Return a list of DEBUG-VARs in DEBUG-FUN whose names contain
1244 ;;; NAME-PREFIX-STRING as an initial substring. The result of this
1245 ;;; function is limited to the availability of variable information in
1246 ;;; debug-fun; for example, possibly debug-fun only knows
1247 ;;; about its arguments.
1248 (defun ambiguous-debug-vars (debug-fun name-prefix-string)
1249 (declare (simple-string name-prefix-string))
1250 (let ((variables (debug-fun-debug-vars debug-fun)))
1251 (declare (type (or null simple-vector) variables))
1253 (let* ((len (length variables))
1254 (prefix-len (length name-prefix-string))
1255 (pos (find-variable name-prefix-string variables len))
1258 ;; Find names from pos to variable's len that contain prefix.
1259 (do ((i pos (1+ i)))
1261 (let* ((var (svref variables i))
1262 (name (debug-var-symbol-name var))
1263 (name-len (length name)))
1264 (declare (simple-string name))
1265 (when (/= (or (string/= name-prefix-string name
1266 :end1 prefix-len :end2 name-len)
1271 (setq res (nreverse res)))
1274 ;;; This returns a position in variables for one containing name as an
1275 ;;; initial substring. End is the length of variables if supplied.
1276 (defun find-variable (name variables &optional end)
1277 (declare (simple-vector variables)
1278 (simple-string name))
1279 (let ((name-len (length name)))
1280 (position name variables
1281 :test #'(lambda (x y)
1282 (let* ((y (debug-var-symbol-name y))
1284 (declare (simple-string y))
1285 (and (>= y-len name-len)
1286 (string= x y :end1 name-len :end2 name-len))))
1287 :end (or end (length variables)))))
1289 ;;; Return a list representing the lambda-list for DEBUG-FUN. The
1290 ;;; list has the following structure:
1291 ;;; (required-var1 required-var2
1293 ;;; (:optional var3 suppliedp-var4)
1294 ;;; (:optional var5)
1296 ;;; (:rest var6) (:rest var7)
1298 ;;; (:keyword keyword-symbol var8 suppliedp-var9)
1299 ;;; (:keyword keyword-symbol var10)
1302 ;;; Each VARi is a DEBUG-VAR; however it may be the symbol :DELETED if
1303 ;;; it is unreferenced in DEBUG-FUN. This signals a
1304 ;;; LAMBDA-LIST-UNAVAILABLE condition when there is no argument list
1306 (defun debug-fun-lambda-list (debug-fun)
1307 (etypecase debug-fun
1308 (compiled-debug-fun (compiled-debug-fun-lambda-list debug-fun))
1309 (bogus-debug-fun nil)))
1311 ;;; Note: If this has to compute the lambda list, it caches it in DEBUG-FUN.
1312 (defun compiled-debug-fun-lambda-list (debug-fun)
1313 (let ((lambda-list (debug-fun-%lambda-list debug-fun)))
1314 (cond ((eq lambda-list :unparsed)
1315 (multiple-value-bind (args argsp)
1316 (parse-compiled-debug-fun-lambda-list debug-fun)
1317 (setf (debug-fun-%lambda-list debug-fun) args)
1320 (debug-signal 'lambda-list-unavailable
1321 :debug-fun debug-fun))))
1323 ((bogus-debug-fun-p debug-fun)
1325 ((sb!c::compiled-debug-fun-arguments
1326 (compiled-debug-fun-compiler-debug-fun debug-fun))
1327 ;; If the packed information is there (whether empty or not) as
1328 ;; opposed to being nil, then returned our cached value (nil).
1331 ;; Our cached value is nil, and the packed lambda-list information
1332 ;; is nil, so we don't have anything available.
1333 (debug-signal 'lambda-list-unavailable
1334 :debug-fun debug-fun)))))
1336 ;;; COMPILED-DEBUG-FUN-LAMBDA-LIST calls this when a
1337 ;;; COMPILED-DEBUG-FUN has no lambda list information cached. It
1338 ;;; returns the lambda list as the first value and whether there was
1339 ;;; any argument information as the second value. Therefore,
1340 ;;; (VALUES NIL T) means there were no arguments, but (VALUES NIL NIL)
1341 ;;; means there was no argument information.
1342 (defun parse-compiled-debug-fun-lambda-list (debug-fun)
1343 (let ((args (sb!c::compiled-debug-fun-arguments
1344 (compiled-debug-fun-compiler-debug-fun debug-fun))))
1349 (values (coerce (debug-fun-debug-vars debug-fun) 'list)
1352 (let ((vars (debug-fun-debug-vars debug-fun))
1357 (declare (type (or null simple-vector) vars))
1359 (when (>= i len) (return))
1360 (let ((ele (aref args i)))
1365 ;; Deleted required arg at beginning of args array.
1366 (push :deleted res))
1367 (sb!c::optional-args
1370 ;; SUPPLIED-P var immediately following keyword or
1371 ;; optional. Stick the extra var in the result
1372 ;; element representing the keyword or optional,
1373 ;; which is the previous one.
1375 (list (compiled-debug-fun-lambda-list-var
1376 args (incf i) vars))))
1379 (compiled-debug-fun-lambda-list-var
1380 args (incf i) vars))
1383 ;; Just ignore the fact that the next two args are
1384 ;; the &MORE arg context and count, and act like they
1385 ;; are regular arguments.
1389 (push (list :keyword
1391 (compiled-debug-fun-lambda-list-var
1392 args (incf i) vars))
1395 ;; We saw an optional marker, so the following
1396 ;; non-symbols are indexes indicating optional
1398 (push (list :optional (svref vars ele)) res))
1400 ;; Required arg at beginning of args array.
1401 (push (svref vars ele) res))))
1403 (values (nreverse res) t))))))
1405 ;;; This is used in COMPILED-DEBUG-FUN-LAMBDA-LIST.
1406 (defun compiled-debug-fun-lambda-list-var (args i vars)
1407 (declare (type (simple-array * (*)) args)
1408 (simple-vector vars))
1409 (let ((ele (aref args i)))
1410 (cond ((not (symbolp ele)) (svref vars ele))
1411 ((eq ele 'sb!c::deleted) :deleted)
1412 (t (error "malformed arguments description")))))
1414 (defun compiled-debug-fun-debug-info (debug-fun)
1415 (%code-debug-info (compiled-debug-fun-component debug-fun)))
1417 ;;;; unpacking variable and basic block data
1419 (defvar *parsing-buffer*
1420 (make-array 20 :adjustable t :fill-pointer t))
1421 (defvar *other-parsing-buffer*
1422 (make-array 20 :adjustable t :fill-pointer t))
1423 ;;; PARSE-DEBUG-BLOCKS and PARSE-DEBUG-VARS
1424 ;;; use this to unpack binary encoded information. It returns the
1425 ;;; values returned by the last form in body.
1427 ;;; This binds buffer-var to *parsing-buffer*, makes sure it starts at
1428 ;;; element zero, and makes sure if we unwind, we nil out any set
1429 ;;; elements for GC purposes.
1431 ;;; This also binds other-var to *other-parsing-buffer* when it is
1432 ;;; supplied, making sure it starts at element zero and that we nil
1433 ;;; out any elements if we unwind.
1435 ;;; This defines the local macro RESULT that takes a buffer, copies
1436 ;;; its elements to a resulting simple-vector, nil's out elements, and
1437 ;;; restarts the buffer at element zero. RESULT returns the
1439 (eval-when (:compile-toplevel :execute)
1440 (sb!xc:defmacro with-parsing-buffer ((buffer-var &optional other-var)
1442 (let ((len (gensym))
1445 (let ((,buffer-var *parsing-buffer*)
1446 ,@(if other-var `((,other-var *other-parsing-buffer*))))
1447 (setf (fill-pointer ,buffer-var) 0)
1448 ,@(if other-var `((setf (fill-pointer ,other-var) 0)))
1449 (macrolet ((result (buf)
1450 `(let* ((,',len (length ,buf))
1451 (,',res (make-array ,',len)))
1452 (replace ,',res ,buf :end1 ,',len :end2 ,',len)
1453 (fill ,buf nil :end ,',len)
1454 (setf (fill-pointer ,buf) 0)
1457 (fill *parsing-buffer* nil)
1458 ,@(if other-var `((fill *other-parsing-buffer* nil))))))
1461 ;;; The argument is a debug internals structure. This returns the
1462 ;;; DEBUG-BLOCKs for DEBUG-FUN, regardless of whether we have unpacked
1463 ;;; them yet. It signals a NO-DEBUG-BLOCKS condition if it can't
1464 ;;; return the blocks.
1465 (defun debug-fun-debug-blocks (debug-fun)
1466 (let ((blocks (debug-fun-blocks debug-fun)))
1467 (cond ((eq blocks :unparsed)
1468 (setf (debug-fun-blocks debug-fun)
1469 (parse-debug-blocks debug-fun))
1470 (unless (debug-fun-blocks debug-fun)
1471 (debug-signal 'no-debug-blocks
1472 :debug-fun debug-fun))
1473 (debug-fun-blocks debug-fun))
1476 (debug-signal 'no-debug-blocks
1477 :debug-fun debug-fun)))))
1479 ;;; Return a SIMPLE-VECTOR of DEBUG-BLOCKs or NIL. NIL indicates there
1480 ;;; was no basic block information.
1481 (defun parse-debug-blocks (debug-fun)
1482 (etypecase debug-fun
1484 (parse-compiled-debug-blocks debug-fun))
1486 (debug-signal 'no-debug-blocks :debug-fun debug-fun))))
1488 ;;; This does some of the work of PARSE-DEBUG-BLOCKS.
1489 (defun parse-compiled-debug-blocks (debug-fun)
1490 (let* ((var-count (length (debug-fun-debug-vars debug-fun)))
1491 (compiler-debug-fun (compiled-debug-fun-compiler-debug-fun
1493 (blocks (sb!c::compiled-debug-fun-blocks compiler-debug-fun))
1494 ;; KLUDGE: 8 is a hard-wired constant in the compiler for the
1495 ;; element size of the packed binary representation of the
1497 (live-set-len (ceiling var-count 8))
1498 (tlf-number (sb!c::compiled-debug-fun-tlf-number compiler-debug-fun)))
1500 (return-from parse-compiled-debug-blocks nil))
1501 (macrolet ((aref+ (a i) `(prog1 (aref ,a ,i) (incf ,i))))
1502 (with-parsing-buffer (blocks-buffer locations-buffer)
1504 (len (length blocks))
1507 (when (>= i len) (return))
1508 (let ((succ-and-flags (aref+ blocks i))
1510 (declare (type (unsigned-byte 8) succ-and-flags)
1512 (dotimes (k (ldb sb!c::compiled-debug-block-nsucc-byte
1514 (push (sb!c::read-var-integer blocks i) successors))
1516 (dotimes (k (sb!c::read-var-integer blocks i)
1517 (result locations-buffer))
1518 (let ((kind (svref sb!c::*compiled-code-location-kinds*
1521 (sb!c::read-var-integer blocks i)))
1522 (tlf-offset (or tlf-number
1523 (sb!c::read-var-integer blocks
1525 (form-number (sb!c::read-var-integer blocks i))
1526 (live-set (sb!c::read-packed-bit-vector
1527 live-set-len blocks i)))
1528 (vector-push-extend (make-known-code-location
1529 pc debug-fun tlf-offset
1530 form-number live-set kind)
1532 (setf last-pc pc))))
1533 (block (make-compiled-debug-block
1534 locations successors
1536 sb!c::compiled-debug-block-elsewhere-p
1537 succ-and-flags))))))
1538 (vector-push-extend block blocks-buffer)
1539 (dotimes (k (length locations))
1540 (setf (code-location-%debug-block (svref locations k))
1542 (let ((res (result blocks-buffer)))
1543 (declare (simple-vector res))
1544 (dotimes (i (length res))
1545 (let* ((block (svref res i))
1547 (dolist (ele (debug-block-successors block))
1548 (push (svref res ele) succs))
1549 (setf (debug-block-successors block) succs)))
1552 ;;; The argument is a debug internals structure. This returns NIL if
1553 ;;; there is no variable information. It returns an empty
1554 ;;; simple-vector if there were no locals in the function. Otherwise
1555 ;;; it returns a SIMPLE-VECTOR of DEBUG-VARs.
1556 (defun debug-fun-debug-vars (debug-fun)
1557 (let ((vars (debug-fun-%debug-vars debug-fun)))
1558 (if (eq vars :unparsed)
1559 (setf (debug-fun-%debug-vars debug-fun)
1560 (etypecase debug-fun
1562 (parse-compiled-debug-vars debug-fun))
1563 (bogus-debug-fun nil)))
1566 ;;; VARS is the parsed variables for a minimal debug function. We need
1567 ;;; to assign names of the form ARG-NNN. We must pad with leading
1568 ;;; zeros, since the arguments must be in alphabetical order.
1569 (defun assign-minimal-var-names (vars)
1570 (declare (simple-vector vars))
1571 (let* ((len (length vars))
1572 (width (length (format nil "~W" (1- len)))))
1574 (setf (compiled-debug-var-symbol (svref vars i))
1575 (intern (format nil "ARG-~V,'0D" width i)
1576 ;; KLUDGE: It's somewhat nasty to have a bare
1577 ;; package name string here. It would be
1578 ;; nicer to have #.(FIND-PACKAGE "SB!DEBUG")
1579 ;; instead, since then at least it would transform
1580 ;; correctly under package renaming and stuff.
1581 ;; However, genesis can't handle dumped packages..
1584 ;; FIXME: Maybe this could be fixed by moving the
1585 ;; whole debug-int.lisp file to warm init? (after
1586 ;; which dumping a #.(FIND-PACKAGE ..) expression
1587 ;; would work fine) If this is possible, it would
1588 ;; probably be a good thing, since minimizing the
1589 ;; amount of stuff in cold init is basically good.
1590 (or (find-package "SB-DEBUG")
1591 (find-package "SB!DEBUG")))))))
1593 ;;; Parse the packed representation of DEBUG-VARs from
1594 ;;; DEBUG-FUN's SB!C::COMPILED-DEBUG-FUN, returning a vector
1595 ;;; of DEBUG-VARs, or NIL if there was no information to parse.
1596 (defun parse-compiled-debug-vars (debug-fun)
1597 (let* ((cdebug-fun (compiled-debug-fun-compiler-debug-fun
1599 (packed-vars (sb!c::compiled-debug-fun-variables cdebug-fun))
1600 (args-minimal (eq (sb!c::compiled-debug-fun-arguments cdebug-fun)
1604 (buffer (make-array 0 :fill-pointer 0 :adjustable t)))
1605 ((>= i (length packed-vars))
1606 (let ((result (coerce buffer 'simple-vector)))
1608 (assign-minimal-var-names result))
1610 (flet ((geti () (prog1 (aref packed-vars i) (incf i))))
1611 (let* ((flags (geti))
1612 (minimal (logtest sb!c::compiled-debug-var-minimal-p flags))
1613 (deleted (logtest sb!c::compiled-debug-var-deleted-p flags))
1614 (live (logtest sb!c::compiled-debug-var-environment-live
1616 (save (logtest sb!c::compiled-debug-var-save-loc-p flags))
1617 (symbol (if minimal nil (geti)))
1618 (id (if (logtest sb!c::compiled-debug-var-id-p flags)
1621 (sc-offset (if deleted 0 (geti)))
1622 (save-sc-offset (if save (geti) nil)))
1623 (aver (not (and args-minimal (not minimal))))
1624 (vector-push-extend (make-compiled-debug-var symbol
1633 ;;; If we're sure of whether code-location is known, return T or NIL.
1634 ;;; If we're :UNSURE, then try to fill in the code-location's slots.
1635 ;;; This determines whether there is any debug-block information, and
1636 ;;; if code-location is known.
1638 ;;; ??? IF this conses closures every time it's called, then break off the
1639 ;;; :UNSURE part to get the HANDLER-CASE into another function.
1640 (defun code-location-unknown-p (basic-code-location)
1641 (ecase (code-location-%unknown-p basic-code-location)
1645 (setf (code-location-%unknown-p basic-code-location)
1646 (handler-case (not (fill-in-code-location basic-code-location))
1647 (no-debug-blocks () t))))))
1649 ;;; Return the DEBUG-BLOCK containing code-location if it is available.
1650 ;;; Some debug policies inhibit debug-block information, and if none
1651 ;;; is available, then this signals a NO-DEBUG-BLOCKS condition.
1652 (defun code-location-debug-block (basic-code-location)
1653 (let ((block (code-location-%debug-block basic-code-location)))
1654 (if (eq block :unparsed)
1655 (etypecase basic-code-location
1656 (compiled-code-location
1657 (compute-compiled-code-location-debug-block basic-code-location))
1658 ;; (There used to be more cases back before sbcl-0.7.0, when
1659 ;; we did special tricks to debug the IR1 interpreter.)
1663 ;;; Store and return BASIC-CODE-LOCATION's debug-block. We determines
1664 ;;; the correct one using the code-location's pc. We use
1665 ;;; DEBUG-FUN-DEBUG-BLOCKS to return the cached block information
1666 ;;; or signal a NO-DEBUG-BLOCKS condition. The blocks are sorted by
1667 ;;; their first code-location's pc, in ascending order. Therefore, as
1668 ;;; soon as we find a block that starts with a pc greater than
1669 ;;; basic-code-location's pc, we know the previous block contains the
1670 ;;; pc. If we get to the last block, then the code-location is either
1671 ;;; in the second to last block or the last block, and we have to be
1672 ;;; careful in determining this since the last block could be code at
1673 ;;; the end of the function. We have to check for the last block being
1674 ;;; code first in order to see how to compare the code-location's pc.
1675 (defun compute-compiled-code-location-debug-block (basic-code-location)
1676 (let* ((pc (compiled-code-location-pc basic-code-location))
1677 (debug-fun (code-location-debug-fun
1678 basic-code-location))
1679 (blocks (debug-fun-debug-blocks debug-fun))
1680 (len (length blocks)))
1681 (declare (simple-vector blocks))
1682 (setf (code-location-%debug-block basic-code-location)
1688 (let ((last (svref blocks end)))
1690 ((debug-block-elsewhere-p last)
1692 (sb!c::compiled-debug-fun-elsewhere-pc
1693 (compiled-debug-fun-compiler-debug-fun
1695 (svref blocks (1- end))
1698 (compiled-code-location-pc
1699 (svref (compiled-debug-block-code-locations last)
1701 (svref blocks (1- end)))
1703 (declare (type index i end))
1705 (compiled-code-location-pc
1706 (svref (compiled-debug-block-code-locations
1709 (return (svref blocks (1- i)))))))))
1711 ;;; Return the CODE-LOCATION's DEBUG-SOURCE.
1712 (defun code-location-debug-source (code-location)
1713 (etypecase code-location
1714 (compiled-code-location
1715 (let* ((info (compiled-debug-fun-debug-info
1716 (code-location-debug-fun code-location)))
1717 (sources (sb!c::compiled-debug-info-source info))
1718 (len (length sources)))
1719 (declare (list sources))
1721 (debug-signal 'no-debug-blocks :debug-fun
1722 (code-location-debug-fun code-location)))
1725 (do ((prev sources src)
1726 (src (cdr sources) (cdr src))
1727 (offset (code-location-toplevel-form-offset code-location)))
1728 ((null src) (car prev))
1729 (when (< offset (sb!c::debug-source-source-root (car src)))
1730 (return (car prev)))))))
1731 ;; (There used to be more cases back before sbcl-0.7.0, when we
1732 ;; did special tricks to debug the IR1 interpreter.)
1735 ;;; Returns the number of top level forms before the one containing
1736 ;;; CODE-LOCATION as seen by the compiler in some compilation unit. (A
1737 ;;; compilation unit is not necessarily a single file, see the section
1738 ;;; on debug-sources.)
1739 (defun code-location-toplevel-form-offset (code-location)
1740 (when (code-location-unknown-p code-location)
1741 (error 'unknown-code-location :code-location code-location))
1742 (let ((tlf-offset (code-location-%tlf-offset code-location)))
1743 (cond ((eq tlf-offset :unparsed)
1744 (etypecase code-location
1745 (compiled-code-location
1746 (unless (fill-in-code-location code-location)
1747 ;; This check should be unnecessary. We're missing
1748 ;; debug info the compiler should have dumped.
1749 (error "internal error: unknown code location"))
1750 (code-location-%tlf-offset code-location))
1751 ;; (There used to be more cases back before sbcl-0.7.0,,
1752 ;; when we did special tricks to debug the IR1
1757 ;;; Return the number of the form corresponding to CODE-LOCATION. The
1758 ;;; form number is derived by a walking the subforms of a top level
1759 ;;; form in depth-first order.
1760 (defun code-location-form-number (code-location)
1761 (when (code-location-unknown-p code-location)
1762 (error 'unknown-code-location :code-location code-location))
1763 (let ((form-num (code-location-%form-number code-location)))
1764 (cond ((eq form-num :unparsed)
1765 (etypecase code-location
1766 (compiled-code-location
1767 (unless (fill-in-code-location code-location)
1768 ;; This check should be unnecessary. We're missing
1769 ;; debug info the compiler should have dumped.
1770 (error "internal error: unknown code location"))
1771 (code-location-%form-number code-location))
1772 ;; (There used to be more cases back before sbcl-0.7.0,,
1773 ;; when we did special tricks to debug the IR1
1778 ;;; Return the kind of CODE-LOCATION, one of:
1779 ;;; :INTERPRETED, :UNKNOWN-RETURN, :KNOWN-RETURN, :INTERNAL-ERROR,
1780 ;;; :NON-LOCAL-EXIT, :BLOCK-START, :CALL-SITE, :SINGLE-VALUE-RETURN,
1781 ;;; :NON-LOCAL-ENTRY
1782 (defun code-location-kind (code-location)
1783 (when (code-location-unknown-p code-location)
1784 (error 'unknown-code-location :code-location code-location))
1785 (etypecase code-location
1786 (compiled-code-location
1787 (let ((kind (compiled-code-location-kind code-location)))
1788 (cond ((not (eq kind :unparsed)) kind)
1789 ((not (fill-in-code-location code-location))
1790 ;; This check should be unnecessary. We're missing
1791 ;; debug info the compiler should have dumped.
1792 (error "internal error: unknown code location"))
1794 (compiled-code-location-kind code-location)))))
1795 ;; (There used to be more cases back before sbcl-0.7.0,,
1796 ;; when we did special tricks to debug the IR1
1800 ;;; This returns CODE-LOCATION's live-set if it is available. If
1801 ;;; there is no debug-block information, this returns NIL.
1802 (defun compiled-code-location-live-set (code-location)
1803 (if (code-location-unknown-p code-location)
1805 (let ((live-set (compiled-code-location-%live-set code-location)))
1806 (cond ((eq live-set :unparsed)
1807 (unless (fill-in-code-location code-location)
1808 ;; This check should be unnecessary. We're missing
1809 ;; debug info the compiler should have dumped.
1811 ;; FIXME: This error and comment happen over and over again.
1812 ;; Make them a shared function.
1813 (error "internal error: unknown code location"))
1814 (compiled-code-location-%live-set code-location))
1817 ;;; true if OBJ1 and OBJ2 are the same place in the code
1818 (defun code-location= (obj1 obj2)
1820 (compiled-code-location
1822 (compiled-code-location
1823 (and (eq (code-location-debug-fun obj1)
1824 (code-location-debug-fun obj2))
1825 (sub-compiled-code-location= obj1 obj2)))
1826 ;; (There used to be more cases back before sbcl-0.7.0,,
1827 ;; when we did special tricks to debug the IR1
1830 ;; (There used to be more cases back before sbcl-0.7.0,,
1831 ;; when we did special tricks to debug IR1-interpreted code.)
1833 (defun sub-compiled-code-location= (obj1 obj2)
1834 (= (compiled-code-location-pc obj1)
1835 (compiled-code-location-pc obj2)))
1837 ;;; Fill in CODE-LOCATION's :UNPARSED slots, returning T or NIL
1838 ;;; depending on whether the code-location was known in its
1839 ;;; DEBUG-FUN's debug-block information. This may signal a
1840 ;;; NO-DEBUG-BLOCKS condition due to DEBUG-FUN-DEBUG-BLOCKS, and
1841 ;;; it assumes the %UNKNOWN-P slot is already set or going to be set.
1842 (defun fill-in-code-location (code-location)
1843 (declare (type compiled-code-location code-location))
1844 (let* ((debug-fun (code-location-debug-fun code-location))
1845 (blocks (debug-fun-debug-blocks debug-fun)))
1846 (declare (simple-vector blocks))
1847 (dotimes (i (length blocks) nil)
1848 (let* ((block (svref blocks i))
1849 (locations (compiled-debug-block-code-locations block)))
1850 (declare (simple-vector locations))
1851 (dotimes (j (length locations))
1852 (let ((loc (svref locations j)))
1853 (when (sub-compiled-code-location= code-location loc)
1854 (setf (code-location-%debug-block code-location) block)
1855 (setf (code-location-%tlf-offset code-location)
1856 (code-location-%tlf-offset loc))
1857 (setf (code-location-%form-number code-location)
1858 (code-location-%form-number loc))
1859 (setf (compiled-code-location-%live-set code-location)
1860 (compiled-code-location-%live-set loc))
1861 (setf (compiled-code-location-kind code-location)
1862 (compiled-code-location-kind loc))
1863 (return-from fill-in-code-location t))))))))
1865 ;;;; operations on DEBUG-BLOCKs
1867 ;;; Execute FORMS in a context with CODE-VAR bound to each
1868 ;;; CODE-LOCATION in DEBUG-BLOCK, and return the value of RESULT.
1869 (defmacro do-debug-block-locations ((code-var debug-block &optional result)
1871 (let ((code-locations (gensym))
1873 `(let ((,code-locations (debug-block-code-locations ,debug-block)))
1874 (declare (simple-vector ,code-locations))
1875 (dotimes (,i (length ,code-locations) ,result)
1876 (let ((,code-var (svref ,code-locations ,i)))
1879 ;;; Return the name of the function represented by DEBUG-FUN.
1880 ;;; This may be a string or a cons; do not assume it is a symbol.
1881 (defun debug-block-fun-name (debug-block)
1882 (etypecase debug-block
1883 (compiled-debug-block
1884 (let ((code-locs (compiled-debug-block-code-locations debug-block)))
1885 (declare (simple-vector code-locs))
1886 (if (zerop (length code-locs))
1887 "??? Can't get name of debug-block's function."
1889 (code-location-debug-fun (svref code-locs 0))))))
1890 ;; (There used to be more cases back before sbcl-0.7.0, when we
1891 ;; did special tricks to debug the IR1 interpreter.)
1894 (defun debug-block-code-locations (debug-block)
1895 (etypecase debug-block
1896 (compiled-debug-block
1897 (compiled-debug-block-code-locations debug-block))
1898 ;; (There used to be more cases back before sbcl-0.7.0, when we
1899 ;; did special tricks to debug the IR1 interpreter.)
1902 ;;;; operations on debug variables
1904 (defun debug-var-symbol-name (debug-var)
1905 (symbol-name (debug-var-symbol debug-var)))
1907 ;;; FIXME: Make sure that this isn't called anywhere that it wouldn't
1908 ;;; be acceptable to have NIL returned, or that it's only called on
1909 ;;; DEBUG-VARs whose symbols have non-NIL packages.
1910 (defun debug-var-package-name (debug-var)
1911 (package-name (symbol-package (debug-var-symbol debug-var))))
1913 ;;; Return the value stored for DEBUG-VAR in frame, or if the value is
1914 ;;; not :VALID, then signal an INVALID-VALUE error.
1915 (defun debug-var-valid-value (debug-var frame)
1916 (unless (eq (debug-var-validity debug-var (frame-code-location frame))
1918 (error 'invalid-value :debug-var debug-var :frame frame))
1919 (debug-var-value debug-var frame))
1921 ;;; Returns the value stored for DEBUG-VAR in frame. The value may be
1922 ;;; invalid. This is SETFable.
1923 (defun debug-var-value (debug-var frame)
1924 (aver (typep frame 'compiled-frame))
1925 (let ((res (access-compiled-debug-var-slot debug-var frame)))
1926 (if (indirect-value-cell-p res)
1927 (value-cell-ref res)
1930 ;;; This returns what is stored for the variable represented by
1931 ;;; DEBUG-VAR relative to the FRAME. This may be an indirect value
1932 ;;; cell if the variable is both closed over and set.
1933 (defun access-compiled-debug-var-slot (debug-var frame)
1934 (declare (optimize (speed 1)))
1935 (let ((escaped (compiled-frame-escaped frame)))
1937 (sub-access-debug-var-slot
1938 (frame-pointer frame)
1939 (compiled-debug-var-sc-offset debug-var)
1941 (sub-access-debug-var-slot
1942 (frame-pointer frame)
1943 (or (compiled-debug-var-save-sc-offset debug-var)
1944 (compiled-debug-var-sc-offset debug-var))))))
1946 ;;; a helper function for working with possibly-invalid values:
1947 ;;; Do (MAKE-LISP-OBJ VAL) only if the value looks valid.
1949 ;;; (Such values can arise in registers on machines with conservative
1950 ;;; GC, and might also arise in debug variable locations when
1951 ;;; those variables are invalid.)
1952 (defun make-valid-lisp-obj (val)
1955 (zerop (logand val 3))
1957 (and (zerop (logand val #xffff0000)) ; Top bits zero
1958 (= (logand val #xff) sb!vm:base-char-widetag)) ; char tag
1960 (= val sb!vm:unbound-marker-widetag)
1963 ;; Check that the pointer is valid. XXX Could do a better
1964 ;; job. FIXME: e.g. by calling out to an is_valid_pointer
1965 ;; routine in the C runtime support code
1966 (or (< sb!vm:read-only-space-start val
1967 (* sb!vm:*read-only-space-free-pointer*
1968 sb!vm:n-word-bytes))
1969 (< sb!vm:static-space-start val
1970 (* sb!vm:*static-space-free-pointer*
1971 sb!vm:n-word-bytes))
1972 (< sb!vm:dynamic-space-start val
1973 (sap-int (dynamic-space-free-pointer))))))
1978 (defun sub-access-debug-var-slot (fp sc-offset &optional escaped)
1979 (macrolet ((with-escaped-value ((var) &body forms)
1981 (let ((,var (sb!vm:context-register
1983 (sb!c:sc-offset-offset sc-offset))))
1985 :invalid-value-for-unescaped-register-storage))
1986 (escaped-float-value (format)
1988 (sb!vm:context-float-register
1990 (sb!c:sc-offset-offset sc-offset)
1992 :invalid-value-for-unescaped-register-storage))
1993 (with-nfp ((var) &body body)
1994 `(let ((,var (if escaped
1996 (sb!vm:context-register escaped
1999 (sb!sys:sap-ref-sap fp (* nfp-save-offset
2000 sb!vm:n-word-bytes))
2002 (sb!vm::make-number-stack-pointer
2003 (sb!sys:sap-ref-32 fp (* nfp-save-offset
2004 sb!vm:n-word-bytes))))))
2006 (ecase (sb!c:sc-offset-scn sc-offset)
2007 ((#.sb!vm:any-reg-sc-number
2008 #.sb!vm:descriptor-reg-sc-number
2009 #!+rt #.sb!vm:word-pointer-reg-sc-number)
2010 (sb!sys:without-gcing
2011 (with-escaped-value (val) (sb!kernel:make-lisp-obj val))))
2013 (#.sb!vm:base-char-reg-sc-number
2014 (with-escaped-value (val)
2016 (#.sb!vm:sap-reg-sc-number
2017 (with-escaped-value (val)
2018 (sb!sys:int-sap val)))
2019 (#.sb!vm:signed-reg-sc-number
2020 (with-escaped-value (val)
2021 (if (logbitp (1- sb!vm:n-word-bits) val)
2022 (logior val (ash -1 sb!vm:n-word-bits))
2024 (#.sb!vm:unsigned-reg-sc-number
2025 (with-escaped-value (val)
2027 (#.sb!vm:non-descriptor-reg-sc-number
2028 (error "Local non-descriptor register access?"))
2029 (#.sb!vm:interior-reg-sc-number
2030 (error "Local interior register access?"))
2031 (#.sb!vm:single-reg-sc-number
2032 (escaped-float-value single-float))
2033 (#.sb!vm:double-reg-sc-number
2034 (escaped-float-value double-float))
2036 (#.sb!vm:long-reg-sc-number
2037 (escaped-float-value long-float))
2038 (#.sb!vm:complex-single-reg-sc-number
2041 (sb!vm:context-float-register
2042 escaped (sb!c:sc-offset-offset sc-offset) 'single-float)
2043 (sb!vm:context-float-register
2044 escaped (1+ (sb!c:sc-offset-offset sc-offset)) 'single-float))
2045 :invalid-value-for-unescaped-register-storage))
2046 (#.sb!vm:complex-double-reg-sc-number
2049 (sb!vm:context-float-register
2050 escaped (sb!c:sc-offset-offset sc-offset) 'double-float)
2051 (sb!vm:context-float-register
2052 escaped (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 2 #-sparc 1)
2054 :invalid-value-for-unescaped-register-storage))
2056 (#.sb!vm:complex-long-reg-sc-number
2059 (sb!vm:context-float-register
2060 escaped (sb!c:sc-offset-offset sc-offset) 'long-float)
2061 (sb!vm:context-float-register
2062 escaped (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 4)
2064 :invalid-value-for-unescaped-register-storage))
2065 (#.sb!vm:single-stack-sc-number
2067 (sb!sys:sap-ref-single nfp (* (sb!c:sc-offset-offset sc-offset)
2068 sb!vm:n-word-bytes))))
2069 (#.sb!vm:double-stack-sc-number
2071 (sb!sys:sap-ref-double nfp (* (sb!c:sc-offset-offset sc-offset)
2072 sb!vm:n-word-bytes))))
2074 (#.sb!vm:long-stack-sc-number
2076 (sb!sys:sap-ref-long nfp (* (sb!c:sc-offset-offset sc-offset)
2077 sb!vm:n-word-bytes))))
2078 (#.sb!vm:complex-single-stack-sc-number
2081 (sb!sys:sap-ref-single nfp (* (sb!c:sc-offset-offset sc-offset)
2082 sb!vm:n-word-bytes))
2083 (sb!sys:sap-ref-single nfp (* (1+ (sb!c:sc-offset-offset sc-offset))
2084 sb!vm:n-word-bytes)))))
2085 (#.sb!vm:complex-double-stack-sc-number
2088 (sb!sys:sap-ref-double nfp (* (sb!c:sc-offset-offset sc-offset)
2089 sb!vm:n-word-bytes))
2090 (sb!sys:sap-ref-double nfp (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2091 sb!vm:n-word-bytes)))))
2093 (#.sb!vm:complex-long-stack-sc-number
2096 (sb!sys:sap-ref-long nfp (* (sb!c:sc-offset-offset sc-offset)
2097 sb!vm:n-word-bytes))
2098 (sb!sys:sap-ref-long nfp (* (+ (sb!c:sc-offset-offset sc-offset)
2100 sb!vm:n-word-bytes)))))
2101 (#.sb!vm:control-stack-sc-number
2102 (sb!kernel:stack-ref fp (sb!c:sc-offset-offset sc-offset)))
2103 (#.sb!vm:base-char-stack-sc-number
2105 (code-char (sb!sys:sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2106 sb!vm:n-word-bytes)))))
2107 (#.sb!vm:unsigned-stack-sc-number
2109 (sb!sys:sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2110 sb!vm:n-word-bytes))))
2111 (#.sb!vm:signed-stack-sc-number
2113 (sb!sys:signed-sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2114 sb!vm:n-word-bytes))))
2115 (#.sb!vm:sap-stack-sc-number
2117 (sb!sys:sap-ref-sap nfp (* (sb!c:sc-offset-offset sc-offset)
2118 sb!vm:n-word-bytes)))))))
2121 (defun sub-access-debug-var-slot (fp sc-offset &optional escaped)
2122 (declare (type system-area-pointer fp))
2123 (macrolet ((with-escaped-value ((var) &body forms)
2125 (let ((,var (sb!vm:context-register
2127 (sb!c:sc-offset-offset sc-offset))))
2129 :invalid-value-for-unescaped-register-storage))
2130 (escaped-float-value (format)
2132 (sb!vm:context-float-register
2133 escaped (sb!c:sc-offset-offset sc-offset) ',format)
2134 :invalid-value-for-unescaped-register-storage))
2135 (escaped-complex-float-value (format)
2138 (sb!vm:context-float-register
2139 escaped (sb!c:sc-offset-offset sc-offset) ',format)
2140 (sb!vm:context-float-register
2141 escaped (1+ (sb!c:sc-offset-offset sc-offset)) ',format))
2142 :invalid-value-for-unescaped-register-storage)))
2143 (ecase (sb!c:sc-offset-scn sc-offset)
2144 ((#.sb!vm:any-reg-sc-number #.sb!vm:descriptor-reg-sc-number)
2146 (with-escaped-value (val)
2147 (make-valid-lisp-obj val))))
2148 (#.sb!vm:base-char-reg-sc-number
2149 (with-escaped-value (val)
2151 (#.sb!vm:sap-reg-sc-number
2152 (with-escaped-value (val)
2154 (#.sb!vm:signed-reg-sc-number
2155 (with-escaped-value (val)
2156 (if (logbitp (1- sb!vm:n-word-bits) val)
2157 (logior val (ash -1 sb!vm:n-word-bits))
2159 (#.sb!vm:unsigned-reg-sc-number
2160 (with-escaped-value (val)
2162 (#.sb!vm:single-reg-sc-number
2163 (escaped-float-value single-float))
2164 (#.sb!vm:double-reg-sc-number
2165 (escaped-float-value double-float))
2167 (#.sb!vm:long-reg-sc-number
2168 (escaped-float-value long-float))
2169 (#.sb!vm:complex-single-reg-sc-number
2170 (escaped-complex-float-value single-float))
2171 (#.sb!vm:complex-double-reg-sc-number
2172 (escaped-complex-float-value double-float))
2174 (#.sb!vm:complex-long-reg-sc-number
2175 (escaped-complex-float-value long-float))
2176 (#.sb!vm:single-stack-sc-number
2177 (sap-ref-single fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2178 sb!vm:n-word-bytes))))
2179 (#.sb!vm:double-stack-sc-number
2180 (sap-ref-double fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2181 sb!vm:n-word-bytes))))
2183 (#.sb!vm:long-stack-sc-number
2184 (sap-ref-long fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2185 sb!vm:n-word-bytes))))
2186 (#.sb!vm:complex-single-stack-sc-number
2188 (sap-ref-single fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2189 sb!vm:n-word-bytes)))
2190 (sap-ref-single fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2191 sb!vm:n-word-bytes)))))
2192 (#.sb!vm:complex-double-stack-sc-number
2194 (sap-ref-double fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2195 sb!vm:n-word-bytes)))
2196 (sap-ref-double fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 4)
2197 sb!vm:n-word-bytes)))))
2199 (#.sb!vm:complex-long-stack-sc-number
2201 (sap-ref-long fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2202 sb!vm:n-word-bytes)))
2203 (sap-ref-long fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 6)
2204 sb!vm:n-word-bytes)))))
2205 (#.sb!vm:control-stack-sc-number
2206 (stack-ref fp (sb!c:sc-offset-offset sc-offset)))
2207 (#.sb!vm:base-char-stack-sc-number
2209 (sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2210 sb!vm:n-word-bytes)))))
2211 (#.sb!vm:unsigned-stack-sc-number
2212 (sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2213 sb!vm:n-word-bytes))))
2214 (#.sb!vm:signed-stack-sc-number
2215 (signed-sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2216 sb!vm:n-word-bytes))))
2217 (#.sb!vm:sap-stack-sc-number
2218 (sap-ref-sap fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2219 sb!vm:n-word-bytes)))))))
2221 ;;; This stores value as the value of DEBUG-VAR in FRAME. In the
2222 ;;; COMPILED-DEBUG-VAR case, access the current value to determine if
2223 ;;; it is an indirect value cell. This occurs when the variable is
2224 ;;; both closed over and set.
2225 (defun %set-debug-var-value (debug-var frame new-value)
2226 (aver (typep frame 'compiled-frame))
2227 (let ((old-value (access-compiled-debug-var-slot debug-var frame)))
2228 (if (indirect-value-cell-p old-value)
2229 (value-cell-set old-value new-value)
2230 (set-compiled-debug-var-slot debug-var frame new-value)))
2233 ;;; This stores VALUE for the variable represented by debug-var
2234 ;;; relative to the frame. This assumes the location directly contains
2235 ;;; the variable's value; that is, there is no indirect value cell
2236 ;;; currently there in case the variable is both closed over and set.
2237 (defun set-compiled-debug-var-slot (debug-var frame value)
2238 (let ((escaped (compiled-frame-escaped frame)))
2240 (sub-set-debug-var-slot (frame-pointer frame)
2241 (compiled-debug-var-sc-offset debug-var)
2243 (sub-set-debug-var-slot
2244 (frame-pointer frame)
2245 (or (compiled-debug-var-save-sc-offset debug-var)
2246 (compiled-debug-var-sc-offset debug-var))
2250 (defun sub-set-debug-var-slot (fp sc-offset value &optional escaped)
2251 (macrolet ((set-escaped-value (val)
2253 (setf (sb!vm:context-register
2255 (sb!c:sc-offset-offset sc-offset))
2258 (set-escaped-float-value (format val)
2260 (setf (sb!vm:context-float-register
2262 (sb!c:sc-offset-offset sc-offset)
2266 (with-nfp ((var) &body body)
2267 `(let ((,var (if escaped
2269 (sb!vm:context-register escaped
2274 sb!vm:n-word-bytes))
2276 (sb!vm::make-number-stack-pointer
2279 sb!vm:n-word-bytes))))))
2281 (ecase (sb!c:sc-offset-scn sc-offset)
2282 ((#.sb!vm:any-reg-sc-number
2283 #.sb!vm:descriptor-reg-sc-number
2284 #!+rt #.sb!vm:word-pointer-reg-sc-number)
2287 (get-lisp-obj-address value))))
2288 (#.sb!vm:base-char-reg-sc-number
2289 (set-escaped-value (char-code value)))
2290 (#.sb!vm:sap-reg-sc-number
2291 (set-escaped-value (sap-int value)))
2292 (#.sb!vm:signed-reg-sc-number
2293 (set-escaped-value (logand value (1- (ash 1 sb!vm:n-word-bits)))))
2294 (#.sb!vm:unsigned-reg-sc-number
2295 (set-escaped-value value))
2296 (#.sb!vm:non-descriptor-reg-sc-number
2297 (error "Local non-descriptor register access?"))
2298 (#.sb!vm:interior-reg-sc-number
2299 (error "Local interior register access?"))
2300 (#.sb!vm:single-reg-sc-number
2301 (set-escaped-float-value single-float value))
2302 (#.sb!vm:double-reg-sc-number
2303 (set-escaped-float-value double-float value))
2305 (#.sb!vm:long-reg-sc-number
2306 (set-escaped-float-value long-float value))
2307 (#.sb!vm:complex-single-reg-sc-number
2309 (setf (sb!vm:context-float-register escaped
2310 (sb!c:sc-offset-offset sc-offset)
2313 (setf (sb!vm:context-float-register
2314 escaped (1+ (sb!c:sc-offset-offset sc-offset))
2318 (#.sb!vm:complex-double-reg-sc-number
2320 (setf (sb!vm:context-float-register
2321 escaped (sb!c:sc-offset-offset sc-offset) 'double-float)
2323 (setf (sb!vm:context-float-register
2325 (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 2 #!-sparc 1)
2330 (#.sb!vm:complex-long-reg-sc-number
2332 (setf (sb!vm:context-float-register
2333 escaped (sb!c:sc-offset-offset sc-offset) 'long-float)
2335 (setf (sb!vm:context-float-register
2337 (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 4)
2341 (#.sb!vm:single-stack-sc-number
2343 (setf (sap-ref-single nfp (* (sb!c:sc-offset-offset sc-offset)
2344 sb!vm:n-word-bytes))
2345 (the single-float value))))
2346 (#.sb!vm:double-stack-sc-number
2348 (setf (sap-ref-double nfp (* (sb!c:sc-offset-offset sc-offset)
2349 sb!vm:n-word-bytes))
2350 (the double-float value))))
2352 (#.sb!vm:long-stack-sc-number
2354 (setf (sap-ref-long nfp (* (sb!c:sc-offset-offset sc-offset)
2355 sb!vm:n-word-bytes))
2356 (the long-float value))))
2357 (#.sb!vm:complex-single-stack-sc-number
2359 (setf (sap-ref-single
2360 nfp (* (sb!c:sc-offset-offset sc-offset) sb!vm:n-word-bytes))
2361 (the single-float (realpart value)))
2362 (setf (sap-ref-single
2363 nfp (* (1+ (sb!c:sc-offset-offset sc-offset))
2364 sb!vm:n-word-bytes))
2365 (the single-float (realpart value)))))
2366 (#.sb!vm:complex-double-stack-sc-number
2368 (setf (sap-ref-double
2369 nfp (* (sb!c:sc-offset-offset sc-offset) sb!vm:n-word-bytes))
2370 (the double-float (realpart value)))
2371 (setf (sap-ref-double
2372 nfp (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2373 sb!vm:n-word-bytes))
2374 (the double-float (realpart value)))))
2376 (#.sb!vm:complex-long-stack-sc-number
2379 nfp (* (sb!c:sc-offset-offset sc-offset) sb!vm:n-word-bytes))
2380 (the long-float (realpart value)))
2382 nfp (* (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 4)
2383 sb!vm:n-word-bytes))
2384 (the long-float (realpart value)))))
2385 (#.sb!vm:control-stack-sc-number
2386 (setf (stack-ref fp (sb!c:sc-offset-offset sc-offset)) value))
2387 (#.sb!vm:base-char-stack-sc-number
2389 (setf (sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2390 sb!vm:n-word-bytes))
2391 (char-code (the character value)))))
2392 (#.sb!vm:unsigned-stack-sc-number
2394 (setf (sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2395 sb!vm:n-word-bytes))
2396 (the (unsigned-byte 32) value))))
2397 (#.sb!vm:signed-stack-sc-number
2399 (setf (signed-sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2400 sb!vm:n-word-bytes))
2401 (the (signed-byte 32) value))))
2402 (#.sb!vm:sap-stack-sc-number
2404 (setf (sap-ref-sap nfp (* (sb!c:sc-offset-offset sc-offset)
2405 sb!vm:n-word-bytes))
2406 (the system-area-pointer value)))))))
2409 (defun sub-set-debug-var-slot (fp sc-offset value &optional escaped)
2410 (macrolet ((set-escaped-value (val)
2412 (setf (sb!vm:context-register
2414 (sb!c:sc-offset-offset sc-offset))
2417 (ecase (sb!c:sc-offset-scn sc-offset)
2418 ((#.sb!vm:any-reg-sc-number #.sb!vm:descriptor-reg-sc-number)
2421 (get-lisp-obj-address value))))
2422 (#.sb!vm:base-char-reg-sc-number
2423 (set-escaped-value (char-code value)))
2424 (#.sb!vm:sap-reg-sc-number
2425 (set-escaped-value (sap-int value)))
2426 (#.sb!vm:signed-reg-sc-number
2427 (set-escaped-value (logand value (1- (ash 1 sb!vm:n-word-bits)))))
2428 (#.sb!vm:unsigned-reg-sc-number
2429 (set-escaped-value value))
2430 (#.sb!vm:single-reg-sc-number
2431 #+nil ;; don't have escaped floats.
2432 (set-escaped-float-value single-float value))
2433 (#.sb!vm:double-reg-sc-number
2434 #+nil ;; don't have escaped floats -- still in npx?
2435 (set-escaped-float-value double-float value))
2437 (#.sb!vm:long-reg-sc-number
2438 #+nil ;; don't have escaped floats -- still in npx?
2439 (set-escaped-float-value long-float value))
2440 (#.sb!vm:single-stack-sc-number
2441 (setf (sap-ref-single
2442 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2443 sb!vm:n-word-bytes)))
2444 (the single-float value)))
2445 (#.sb!vm:double-stack-sc-number
2446 (setf (sap-ref-double
2447 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2448 sb!vm:n-word-bytes)))
2449 (the double-float value)))
2451 (#.sb!vm:long-stack-sc-number
2453 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2454 sb!vm:n-word-bytes)))
2455 (the long-float value)))
2456 (#.sb!vm:complex-single-stack-sc-number
2457 (setf (sap-ref-single
2458 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2459 sb!vm:n-word-bytes)))
2460 (realpart (the (complex single-float) value)))
2461 (setf (sap-ref-single
2462 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2463 sb!vm:n-word-bytes)))
2464 (imagpart (the (complex single-float) value))))
2465 (#.sb!vm:complex-double-stack-sc-number
2466 (setf (sap-ref-double
2467 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2468 sb!vm:n-word-bytes)))
2469 (realpart (the (complex double-float) value)))
2470 (setf (sap-ref-double
2471 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 4)
2472 sb!vm:n-word-bytes)))
2473 (imagpart (the (complex double-float) value))))
2475 (#.sb!vm:complex-long-stack-sc-number
2477 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2478 sb!vm:n-word-bytes)))
2479 (realpart (the (complex long-float) value)))
2481 fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 6)
2482 sb!vm:n-word-bytes)))
2483 (imagpart (the (complex long-float) value))))
2484 (#.sb!vm:control-stack-sc-number
2485 (setf (stack-ref fp (sb!c:sc-offset-offset sc-offset)) value))
2486 (#.sb!vm:base-char-stack-sc-number
2487 (setf (sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2488 sb!vm:n-word-bytes)))
2489 (char-code (the character value))))
2490 (#.sb!vm:unsigned-stack-sc-number
2491 (setf (sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2492 sb!vm:n-word-bytes)))
2493 (the (unsigned-byte 32) value)))
2494 (#.sb!vm:signed-stack-sc-number
2495 (setf (signed-sap-ref-32
2496 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2497 sb!vm:n-word-bytes)))
2498 (the (signed-byte 32) value)))
2499 (#.sb!vm:sap-stack-sc-number
2500 (setf (sap-ref-sap fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2501 sb!vm:n-word-bytes)))
2502 (the system-area-pointer value))))))
2504 ;;; The method for setting and accessing COMPILED-DEBUG-VAR values use
2505 ;;; this to determine if the value stored is the actual value or an
2506 ;;; indirection cell.
2507 (defun indirect-value-cell-p (x)
2508 (and (= (lowtag-of x) sb!vm:other-pointer-lowtag)
2509 (= (widetag-of x) sb!vm:value-cell-header-widetag)))
2511 ;;; Return three values reflecting the validity of DEBUG-VAR's value
2512 ;;; at BASIC-CODE-LOCATION:
2513 ;;; :VALID The value is known to be available.
2514 ;;; :INVALID The value is known to be unavailable.
2515 ;;; :UNKNOWN The value's availability is unknown.
2517 ;;; If the variable is always alive, then it is valid. If the
2518 ;;; code-location is unknown, then the variable's validity is
2519 ;;; :unknown. Once we've called CODE-LOCATION-UNKNOWN-P, we know the
2520 ;;; live-set information has been cached in the code-location.
2521 (defun debug-var-validity (debug-var basic-code-location)
2522 (etypecase debug-var
2524 (compiled-debug-var-validity debug-var basic-code-location))
2525 ;; (There used to be more cases back before sbcl-0.7.0, when
2526 ;; we did special tricks to debug the IR1 interpreter.)
2529 ;;; This is the method for DEBUG-VAR-VALIDITY for COMPILED-DEBUG-VARs.
2530 ;;; For safety, make sure basic-code-location is what we think.
2531 (defun compiled-debug-var-validity (debug-var basic-code-location)
2532 (declare (type compiled-code-location basic-code-location))
2533 (cond ((debug-var-alive-p debug-var)
2534 (let ((debug-fun (code-location-debug-fun basic-code-location)))
2535 (if (>= (compiled-code-location-pc basic-code-location)
2536 (sb!c::compiled-debug-fun-start-pc
2537 (compiled-debug-fun-compiler-debug-fun debug-fun)))
2540 ((code-location-unknown-p basic-code-location) :unknown)
2542 (let ((pos (position debug-var
2543 (debug-fun-debug-vars
2544 (code-location-debug-fun
2545 basic-code-location)))))
2547 (error 'unknown-debug-var
2548 :debug-var debug-var
2550 (code-location-debug-fun basic-code-location)))
2551 ;; There must be live-set info since basic-code-location is known.
2552 (if (zerop (sbit (compiled-code-location-live-set
2553 basic-code-location)
2560 ;;; This code produces and uses what we call source-paths. A
2561 ;;; source-path is a list whose first element is a form number as
2562 ;;; returned by CODE-LOCATION-FORM-NUMBER and whose last element is a
2563 ;;; top level form number as returned by
2564 ;;; CODE-LOCATION-TOPLEVEL-FORM-NUMBER. The elements from the last to
2565 ;;; the first, exclusively, are the numbered subforms into which to
2566 ;;; descend. For example:
2568 ;;; (let ((a (aref x 3)))
2570 ;;; The call to AREF in this example is form number 5. Assuming this
2571 ;;; DEFUN is the 11'th top level form, the source-path for the AREF
2572 ;;; call is as follows:
2574 ;;; Given the DEFUN, 3 gets you the LET, 1 gets you the bindings, 0
2575 ;;; gets the first binding, and 1 gets the AREF form.
2577 ;;; temporary buffer used to build form-number => source-path translation in
2578 ;;; FORM-NUMBER-TRANSLATIONS
2579 (defvar *form-number-temp* (make-array 10 :fill-pointer 0 :adjustable t))
2581 ;;; table used to detect CAR circularities in FORM-NUMBER-TRANSLATIONS
2582 (defvar *form-number-circularity-table* (make-hash-table :test 'eq))
2584 ;;; This returns a table mapping form numbers to source-paths. A
2585 ;;; source-path indicates a descent into the TOPLEVEL-FORM form,
2586 ;;; going directly to the subform corressponding to the form number.
2588 ;;; The vector elements are in the same format as the compiler's
2589 ;;; NODE-SOURCE-PATH; that is, the first element is the form number and
2590 ;;; the last is the TOPLEVEL-FORM number.
2591 (defun form-number-translations (form tlf-number)
2592 (clrhash *form-number-circularity-table*)
2593 (setf (fill-pointer *form-number-temp*) 0)
2594 (sub-translate-form-numbers form (list tlf-number))
2595 (coerce *form-number-temp* 'simple-vector))
2596 (defun sub-translate-form-numbers (form path)
2597 (unless (gethash form *form-number-circularity-table*)
2598 (setf (gethash form *form-number-circularity-table*) t)
2599 (vector-push-extend (cons (fill-pointer *form-number-temp*) path)
2604 (declare (fixnum pos))
2607 (when (atom subform) (return))
2608 (let ((fm (car subform)))
2610 (sub-translate-form-numbers fm (cons pos path)))
2612 (setq subform (cdr subform))
2613 (when (eq subform trail) (return)))))
2617 (setq trail (cdr trail)))))))
2619 ;;; FORM is a top level form, and path is a source-path into it. This
2620 ;;; returns the form indicated by the source-path. Context is the
2621 ;;; number of enclosing forms to return instead of directly returning
2622 ;;; the source-path form. When context is non-zero, the form returned
2623 ;;; contains a marker, #:****HERE****, immediately before the form
2624 ;;; indicated by path.
2625 (defun source-path-context (form path context)
2626 (declare (type unsigned-byte context))
2627 ;; Get to the form indicated by path or the enclosing form indicated
2628 ;; by context and path.
2629 (let ((path (reverse (butlast (cdr path)))))
2630 (dotimes (i (- (length path) context))
2631 (let ((index (first path)))
2632 (unless (and (listp form) (< index (length form)))
2633 (error "Source path no longer exists."))
2634 (setq form (elt form index))
2635 (setq path (rest path))))
2636 ;; Recursively rebuild the source form resulting from the above
2637 ;; descent, copying the beginning of each subform up to the next
2638 ;; subform we descend into according to path. At the bottom of the
2639 ;; recursion, we return the form indicated by path preceded by our
2640 ;; marker, and this gets spliced into the resulting list structure
2641 ;; on the way back up.
2642 (labels ((frob (form path level)
2643 (if (or (zerop level) (null path))
2646 `(#:***here*** ,form))
2647 (let ((n (first path)))
2648 (unless (and (listp form) (< n (length form)))
2649 (error "Source path no longer exists."))
2650 (let ((res (frob (elt form n) (rest path) (1- level))))
2651 (nconc (subseq form 0 n)
2652 (cons res (nthcdr (1+ n) form))))))))
2653 (frob form path context))))
2655 ;;;; PREPROCESS-FOR-EVAL
2657 ;;; Return a function of one argument that evaluates form in the
2658 ;;; lexical context of the BASIC-CODE-LOCATION LOC, or signal a
2659 ;;; NO-DEBUG-VARS condition when the LOC's DEBUG-FUN has no
2660 ;;; DEBUG-VAR information available.
2662 ;;; The returned function takes the frame to get values from as its
2663 ;;; argument, and it returns the values of FORM. The returned function
2664 ;;; can signal the following conditions: INVALID-VALUE,
2665 ;;; AMBIGUOUS-VAR-NAME, and FRAME-FUN-MISMATCH.
2666 (defun preprocess-for-eval (form loc)
2667 (declare (type code-location loc))
2668 (let ((n-frame (gensym))
2669 (fun (code-location-debug-fun loc)))
2670 (unless (debug-var-info-available fun)
2671 (debug-signal 'no-debug-vars :debug-fun fun))
2672 (sb!int:collect ((binds)
2674 (do-debug-fun-variables (var fun)
2675 (let ((validity (debug-var-validity var loc)))
2676 (unless (eq validity :invalid)
2677 (let* ((sym (debug-var-symbol var))
2678 (found (assoc sym (binds))))
2680 (setf (second found) :ambiguous)
2681 (binds (list sym validity var)))))))
2682 (dolist (bind (binds))
2683 (let ((name (first bind))
2685 (ecase (second bind)
2687 (specs `(,name (debug-var-value ',var ,n-frame))))
2689 (specs `(,name (debug-signal 'invalid-value
2693 (specs `(,name (debug-signal 'ambiguous-var-name
2695 :frame ,n-frame)))))))
2696 (let ((res (coerce `(lambda (,n-frame)
2697 (declare (ignorable ,n-frame))
2698 (symbol-macrolet ,(specs) ,form))
2701 ;; This prevents these functions from being used in any
2702 ;; location other than a function return location, so
2703 ;; maybe this should only check whether frame's
2704 ;; DEBUG-FUN is the same as loc's.
2705 (unless (code-location= (frame-code-location frame) loc)
2706 (debug-signal 'frame-fun-mismatch
2707 :code-location loc :form form :frame frame))
2708 (funcall res frame))))))
2712 ;;;; user-visible interface
2714 ;;; Create and return a breakpoint. When program execution encounters
2715 ;;; the breakpoint, the system calls HOOK-FUNCTION. HOOK-FUNCTION takes the
2716 ;;; current frame for the function in which the program is running and the
2717 ;;; breakpoint object.
2719 ;;; WHAT and KIND determine where in a function the system invokes
2720 ;;; HOOK-FUNCTION. WHAT is either a code-location or a DEBUG-FUN.
2721 ;;; KIND is one of :CODE-LOCATION, :FUN-START, or :FUN-END.
2722 ;;; Since the starts and ends of functions may not have code-locations
2723 ;;; representing them, designate these places by supplying WHAT as a
2724 ;;; DEBUG-FUN and KIND indicating the :FUN-START or
2725 ;;; :FUN-END. When WHAT is a DEBUG-FUN and kind is
2726 ;;; :FUN-END, then hook-function must take two additional
2727 ;;; arguments, a list of values returned by the function and a
2730 ;;; INFO is information supplied by and used by the user.
2732 ;;; FUN-END-COOKIE is a function. To implement :FUN-END
2733 ;;; breakpoints, the system uses starter breakpoints to establish the
2734 ;;; :FUN-END breakpoint for each invocation of the function. Upon
2735 ;;; each entry, the system creates a unique cookie to identify the
2736 ;;; invocation, and when the user supplies a function for this
2737 ;;; argument, the system invokes it on the frame and the cookie. The
2738 ;;; system later invokes the :FUN-END breakpoint hook on the same
2739 ;;; cookie. The user may save the cookie for comparison in the hook
2742 ;;; Signal an error if WHAT is an unknown code-location.
2743 (defun make-breakpoint (hook-function what
2744 &key (kind :code-location) info fun-end-cookie)
2747 (when (code-location-unknown-p what)
2748 (error "cannot make a breakpoint at an unknown code location: ~S"
2750 (aver (eq kind :code-location))
2751 (let ((bpt (%make-breakpoint hook-function what kind info)))
2753 (compiled-code-location
2754 ;; This slot is filled in due to calling CODE-LOCATION-UNKNOWN-P.
2755 (when (eq (compiled-code-location-kind what) :unknown-return)
2756 (let ((other-bpt (%make-breakpoint hook-function what
2757 :unknown-return-partner
2759 (setf (breakpoint-unknown-return-partner bpt) other-bpt)
2760 (setf (breakpoint-unknown-return-partner other-bpt) bpt))))
2761 ;; (There used to be more cases back before sbcl-0.7.0,,
2762 ;; when we did special tricks to debug the IR1
2769 (%make-breakpoint hook-function what kind info))
2771 (unless (eq (sb!c::compiled-debug-fun-returns
2772 (compiled-debug-fun-compiler-debug-fun what))
2774 (error ":FUN-END breakpoints are currently unsupported ~
2775 for the known return convention."))
2777 (let* ((bpt (%make-breakpoint hook-function what kind info))
2778 (starter (compiled-debug-fun-end-starter what)))
2780 (setf starter (%make-breakpoint #'list what :fun-start nil))
2781 (setf (breakpoint-hook-function starter)
2782 (fun-end-starter-hook starter what))
2783 (setf (compiled-debug-fun-end-starter what) starter))
2784 (setf (breakpoint-start-helper bpt) starter)
2785 (push bpt (breakpoint-%info starter))
2786 (setf (breakpoint-cookie-fun bpt) fun-end-cookie)
2789 ;;; These are unique objects created upon entry into a function by a
2790 ;;; :FUN-END breakpoint's starter hook. These are only created
2791 ;;; when users supply :FUN-END-COOKIE to MAKE-BREAKPOINT. Also,
2792 ;;; the :FUN-END breakpoint's hook is called on the same cookie
2793 ;;; when it is created.
2794 (defstruct (fun-end-cookie
2795 (:print-object (lambda (obj str)
2796 (print-unreadable-object (obj str :type t))))
2797 (:constructor make-fun-end-cookie (bogus-lra debug-fun))
2799 ;; a pointer to the bogus-lra created for :FUN-END breakpoints
2801 ;; the DEBUG-FUN associated with this cookie
2804 ;;; This maps bogus-lra-components to cookies, so that
2805 ;;; HANDLE-FUN-END-BREAKPOINT can find the appropriate cookie for the
2806 ;;; breakpoint hook.
2807 (defvar *fun-end-cookies* (make-hash-table :test 'eq))
2809 ;;; This returns a hook function for the start helper breakpoint
2810 ;;; associated with a :FUN-END breakpoint. The returned function
2811 ;;; makes a fake LRA that all returns go through, and this piece of
2812 ;;; fake code actually breaks. Upon return from the break, the code
2813 ;;; provides the returnee with any values. Since the returned function
2814 ;;; effectively activates FUN-END-BPT on each entry to DEBUG-FUN's
2815 ;;; function, we must establish breakpoint-data about FUN-END-BPT.
2816 (defun fun-end-starter-hook (starter-bpt debug-fun)
2817 (declare (type breakpoint starter-bpt)
2818 (type compiled-debug-fun debug-fun))
2819 #'(lambda (frame breakpoint)
2820 (declare (ignore breakpoint)
2822 (let ((lra-sc-offset
2823 (sb!c::compiled-debug-fun-return-pc
2824 (compiled-debug-fun-compiler-debug-fun debug-fun))))
2825 (multiple-value-bind (lra component offset)
2827 (get-context-value frame
2830 (setf (get-context-value frame
2834 (let ((end-bpts (breakpoint-%info starter-bpt)))
2835 (let ((data (breakpoint-data component offset)))
2836 (setf (breakpoint-data-breakpoints data) end-bpts)
2837 (dolist (bpt end-bpts)
2838 (setf (breakpoint-internal-data bpt) data)))
2839 (let ((cookie (make-fun-end-cookie lra debug-fun)))
2840 (setf (gethash component *fun-end-cookies*) cookie)
2841 (dolist (bpt end-bpts)
2842 (let ((fun (breakpoint-cookie-fun bpt)))
2843 (when fun (funcall fun frame cookie))))))))))
2845 ;;; This takes a FUN-END-COOKIE and a frame, and it returns
2846 ;;; whether the cookie is still valid. A cookie becomes invalid when
2847 ;;; the frame that established the cookie has exited. Sometimes cookie
2848 ;;; holders are unaware of cookie invalidation because their
2849 ;;; :FUN-END breakpoint hooks didn't run due to THROW'ing.
2851 ;;; This takes a frame as an efficiency hack since the user probably
2852 ;;; has a frame object in hand when using this routine, and it saves
2853 ;;; repeated parsing of the stack and consing when asking whether a
2854 ;;; series of cookies is valid.
2855 (defun fun-end-cookie-valid-p (frame cookie)
2856 (let ((lra (fun-end-cookie-bogus-lra cookie))
2857 (lra-sc-offset (sb!c::compiled-debug-fun-return-pc
2858 (compiled-debug-fun-compiler-debug-fun
2859 (fun-end-cookie-debug-fun cookie)))))
2860 (do ((frame frame (frame-down frame)))
2862 (when (and (compiled-frame-p frame)
2863 (#-x86 eq #+x86 sap=
2865 (get-context-value frame lra-save-offset lra-sc-offset)))
2868 ;;;; ACTIVATE-BREAKPOINT
2870 ;;; Cause the system to invoke the breakpoint's hook-function until
2871 ;;; the next call to DEACTIVATE-BREAKPOINT or DELETE-BREAKPOINT. The
2872 ;;; system invokes breakpoint hook functions in the opposite order
2873 ;;; that you activate them.
2874 (defun activate-breakpoint (breakpoint)
2875 (when (eq (breakpoint-status breakpoint) :deleted)
2876 (error "cannot activate a deleted breakpoint: ~S" breakpoint))
2877 (unless (eq (breakpoint-status breakpoint) :active)
2878 (ecase (breakpoint-kind breakpoint)
2880 (let ((loc (breakpoint-what breakpoint)))
2882 (compiled-code-location
2883 (activate-compiled-code-location-breakpoint breakpoint)
2884 (let ((other (breakpoint-unknown-return-partner breakpoint)))
2886 (activate-compiled-code-location-breakpoint other))))
2887 ;; (There used to be more cases back before sbcl-0.7.0, when
2888 ;; we did special tricks to debug the IR1 interpreter.)
2891 (etypecase (breakpoint-what breakpoint)
2893 (activate-compiled-fun-start-breakpoint breakpoint))
2894 ;; (There used to be more cases back before sbcl-0.7.0, when
2895 ;; we did special tricks to debug the IR1 interpreter.)
2898 (etypecase (breakpoint-what breakpoint)
2900 (let ((starter (breakpoint-start-helper breakpoint)))
2901 (unless (eq (breakpoint-status starter) :active)
2902 ;; may already be active by some other :FUN-END breakpoint
2903 (activate-compiled-fun-start-breakpoint starter)))
2904 (setf (breakpoint-status breakpoint) :active))
2905 ;; (There used to be more cases back before sbcl-0.7.0, when
2906 ;; we did special tricks to debug the IR1 interpreter.)
2910 (defun activate-compiled-code-location-breakpoint (breakpoint)
2911 (declare (type breakpoint breakpoint))
2912 (let ((loc (breakpoint-what breakpoint)))
2913 (declare (type compiled-code-location loc))
2914 (sub-activate-breakpoint
2916 (breakpoint-data (compiled-debug-fun-component
2917 (code-location-debug-fun loc))
2918 (+ (compiled-code-location-pc loc)
2919 (if (or (eq (breakpoint-kind breakpoint)
2920 :unknown-return-partner)
2921 (eq (compiled-code-location-kind loc)
2922 :single-value-return))
2923 sb!vm:single-value-return-byte-offset
2926 (defun activate-compiled-fun-start-breakpoint (breakpoint)
2927 (declare (type breakpoint breakpoint))
2928 (let ((debug-fun (breakpoint-what breakpoint)))
2929 (sub-activate-breakpoint
2931 (breakpoint-data (compiled-debug-fun-component debug-fun)
2932 (sb!c::compiled-debug-fun-start-pc
2933 (compiled-debug-fun-compiler-debug-fun
2936 (defun sub-activate-breakpoint (breakpoint data)
2937 (declare (type breakpoint breakpoint)
2938 (type breakpoint-data data))
2939 (setf (breakpoint-status breakpoint) :active)
2941 (unless (breakpoint-data-breakpoints data)
2942 (setf (breakpoint-data-instruction data)
2944 (breakpoint-install (get-lisp-obj-address
2945 (breakpoint-data-component data))
2946 (breakpoint-data-offset data)))))
2947 (setf (breakpoint-data-breakpoints data)
2948 (append (breakpoint-data-breakpoints data) (list breakpoint)))
2949 (setf (breakpoint-internal-data breakpoint) data)))
2951 ;;;; DEACTIVATE-BREAKPOINT
2953 ;;; Stop the system from invoking the breakpoint's hook-function.
2954 (defun deactivate-breakpoint (breakpoint)
2955 (when (eq (breakpoint-status breakpoint) :active)
2957 (let ((loc (breakpoint-what breakpoint)))
2959 ((or compiled-code-location compiled-debug-fun)
2960 (deactivate-compiled-breakpoint breakpoint)
2961 (let ((other (breakpoint-unknown-return-partner breakpoint)))
2963 (deactivate-compiled-breakpoint other))))
2964 ;; (There used to be more cases back before sbcl-0.7.0, when
2965 ;; we did special tricks to debug the IR1 interpreter.)
2969 (defun deactivate-compiled-breakpoint (breakpoint)
2970 (if (eq (breakpoint-kind breakpoint) :fun-end)
2971 (let ((starter (breakpoint-start-helper breakpoint)))
2972 (unless (find-if #'(lambda (bpt)
2973 (and (not (eq bpt breakpoint))
2974 (eq (breakpoint-status bpt) :active)))
2975 (breakpoint-%info starter))
2976 (deactivate-compiled-breakpoint starter)))
2977 (let* ((data (breakpoint-internal-data breakpoint))
2978 (bpts (delete breakpoint (breakpoint-data-breakpoints data))))
2979 (setf (breakpoint-internal-data breakpoint) nil)
2980 (setf (breakpoint-data-breakpoints data) bpts)
2983 (breakpoint-remove (get-lisp-obj-address
2984 (breakpoint-data-component data))
2985 (breakpoint-data-offset data)
2986 (breakpoint-data-instruction data)))
2987 (delete-breakpoint-data data))))
2988 (setf (breakpoint-status breakpoint) :inactive)
2991 ;;;; BREAKPOINT-INFO
2993 ;;; Return the user-maintained info associated with breakpoint. This
2995 (defun breakpoint-info (breakpoint)
2996 (breakpoint-%info breakpoint))
2997 (defun %set-breakpoint-info (breakpoint value)
2998 (setf (breakpoint-%info breakpoint) value)
2999 (let ((other (breakpoint-unknown-return-partner breakpoint)))
3001 (setf (breakpoint-%info other) value))))
3003 ;;;; BREAKPOINT-ACTIVE-P and DELETE-BREAKPOINT
3005 (defun breakpoint-active-p (breakpoint)
3006 (ecase (breakpoint-status breakpoint)
3008 ((:inactive :deleted) nil)))
3010 ;;; Free system storage and remove computational overhead associated
3011 ;;; with breakpoint. After calling this, breakpoint is completely
3012 ;;; impotent and can never become active again.
3013 (defun delete-breakpoint (breakpoint)
3014 (let ((status (breakpoint-status breakpoint)))
3015 (unless (eq status :deleted)
3016 (when (eq status :active)
3017 (deactivate-breakpoint breakpoint))
3018 (setf (breakpoint-status breakpoint) :deleted)
3019 (let ((other (breakpoint-unknown-return-partner breakpoint)))
3021 (setf (breakpoint-status other) :deleted)))
3022 (when (eq (breakpoint-kind breakpoint) :fun-end)
3023 (let* ((starter (breakpoint-start-helper breakpoint))
3024 (breakpoints (delete breakpoint
3025 (the list (breakpoint-info starter)))))
3026 (setf (breakpoint-info starter) breakpoints)
3028 (delete-breakpoint starter)
3029 (setf (compiled-debug-fun-end-starter
3030 (breakpoint-what breakpoint))
3034 ;;;; C call out stubs
3036 ;;; This actually installs the break instruction in the component. It
3037 ;;; returns the overwritten bits. You must call this in a context in
3038 ;;; which GC is disabled, so that Lisp doesn't move objects around
3039 ;;; that C is pointing to.
3040 (sb!alien:define-alien-routine "breakpoint_install" sb!c-call:unsigned-long
3041 (code-obj sb!c-call:unsigned-long)
3042 (pc-offset sb!c-call:int))
3044 ;;; This removes the break instruction and replaces the original
3045 ;;; instruction. You must call this in a context in which GC is disabled
3046 ;;; so Lisp doesn't move objects around that C is pointing to.
3047 (sb!alien:define-alien-routine "breakpoint_remove" sb!c-call:void
3048 (code-obj sb!c-call:unsigned-long)
3049 (pc-offset sb!c-call:int)
3050 (old-inst sb!c-call:unsigned-long))
3052 (sb!alien:define-alien-routine "breakpoint_do_displaced_inst" sb!c-call:void
3053 (scp (* os-context-t))
3054 (orig-inst sb!c-call:unsigned-long))
3056 ;;;; breakpoint handlers (layer between C and exported interface)
3058 ;;; This maps components to a mapping of offsets to BREAKPOINT-DATAs.
3059 (defvar *component-breakpoint-offsets* (make-hash-table :test 'eq))
3061 ;;; This returns the BREAKPOINT-DATA object associated with component cross
3062 ;;; offset. If none exists, this makes one, installs it, and returns it.
3063 (defun breakpoint-data (component offset &optional (create t))
3064 (flet ((install-breakpoint-data ()
3066 (let ((data (make-breakpoint-data component offset)))
3067 (push (cons offset data)
3068 (gethash component *component-breakpoint-offsets*))
3070 (let ((offsets (gethash component *component-breakpoint-offsets*)))
3072 (let ((data (assoc offset offsets)))
3075 (install-breakpoint-data)))
3076 (install-breakpoint-data)))))
3078 ;;; We use this when there are no longer any active breakpoints
3079 ;;; corresponding to DATA.
3080 (defun delete-breakpoint-data (data)
3081 (let* ((component (breakpoint-data-component data))
3082 (offsets (delete (breakpoint-data-offset data)
3083 (gethash component *component-breakpoint-offsets*)
3086 (setf (gethash component *component-breakpoint-offsets*) offsets)
3087 (remhash component *component-breakpoint-offsets*)))
3090 ;;; The C handler for interrupts calls this when it has a
3091 ;;; debugging-tool break instruction. This does *not* handle all
3092 ;;; breaks; for example, it does not handle breaks for internal
3094 (defun handle-breakpoint (offset component signal-context)
3095 (let ((data (breakpoint-data component offset nil)))
3097 (error "unknown breakpoint in ~S at offset ~S"
3098 (debug-fun-name (debug-fun-from-pc component offset))
3100 (let ((breakpoints (breakpoint-data-breakpoints data)))
3101 (if (or (null breakpoints)
3102 (eq (breakpoint-kind (car breakpoints)) :fun-end))
3103 (handle-fun-end-breakpoint-aux breakpoints data signal-context)
3104 (handle-breakpoint-aux breakpoints data
3105 offset component signal-context)))))
3107 ;;; This holds breakpoint-datas while invoking the breakpoint hooks
3108 ;;; associated with that particular component and location. While they
3109 ;;; are executing, if we hit the location again, we ignore the
3110 ;;; breakpoint to avoid infinite recursion. fun-end breakpoints
3111 ;;; must work differently since the breakpoint-data is unique for each
3113 (defvar *executing-breakpoint-hooks* nil)
3115 ;;; This handles code-location and DEBUG-FUN :FUN-START
3117 (defun handle-breakpoint-aux (breakpoints data offset component signal-context)
3119 (error "internal error: breakpoint that nobody wants"))
3120 (unless (member data *executing-breakpoint-hooks*)
3121 (let ((*executing-breakpoint-hooks* (cons data
3122 *executing-breakpoint-hooks*)))
3123 (invoke-breakpoint-hooks breakpoints component offset)))
3124 ;; At this point breakpoints may not hold the same list as
3125 ;; BREAKPOINT-DATA-BREAKPOINTS since invoking hooks may have allowed
3126 ;; a breakpoint deactivation. In fact, if all breakpoints were
3127 ;; deactivated then data is invalid since it was deleted and so the
3128 ;; correct one must be looked up if it is to be used. If there are
3129 ;; no more breakpoints active at this location, then the normal
3130 ;; instruction has been put back, and we do not need to
3131 ;; DO-DISPLACED-INST.
3132 (let ((data (breakpoint-data component offset nil)))
3133 (when (and data (breakpoint-data-breakpoints data))
3134 ;; The breakpoint is still active, so we need to execute the
3135 ;; displaced instruction and leave the breakpoint instruction
3136 ;; behind. The best way to do this is different on each machine,
3137 ;; so we just leave it up to the C code.
3138 (breakpoint-do-displaced-inst signal-context
3139 (breakpoint-data-instruction data))
3140 ;; Some platforms have no usable sigreturn() call. If your
3141 ;; implementation of arch_do_displaced_inst() doesn't sigreturn(),
3142 ;; add it to this list.
3143 #!-(or hpux irix x86 alpha)
3144 (error "BREAKPOINT-DO-DISPLACED-INST returned?"))))
3146 (defun invoke-breakpoint-hooks (breakpoints component offset)
3147 (let* ((debug-fun (debug-fun-from-pc component offset))
3148 (frame (do ((f (top-frame) (frame-down f)))
3149 ((eq debug-fun (frame-debug-fun f)) f))))
3150 (dolist (bpt breakpoints)
3151 (funcall (breakpoint-hook-function bpt)
3153 ;; If this is an :UNKNOWN-RETURN-PARTNER, then pass the
3154 ;; hook function the original breakpoint, so that users
3155 ;; aren't forced to confront the fact that some
3156 ;; breakpoints really are two.
3157 (if (eq (breakpoint-kind bpt) :unknown-return-partner)
3158 (breakpoint-unknown-return-partner bpt)
3161 (defun handle-fun-end-breakpoint (offset component context)
3162 (let ((data (breakpoint-data component offset nil)))
3164 (error "unknown breakpoint in ~S at offset ~S"
3165 (debug-fun-name (debug-fun-from-pc component offset))
3167 (let ((breakpoints (breakpoint-data-breakpoints data)))
3169 (aver (eq (breakpoint-kind (car breakpoints)) :fun-end))
3170 (handle-fun-end-breakpoint-aux breakpoints data context)))))
3172 ;;; Either HANDLE-BREAKPOINT calls this for :FUN-END breakpoints
3173 ;;; [old C code] or HANDLE-FUN-END-BREAKPOINT calls this directly
3175 (defun handle-fun-end-breakpoint-aux (breakpoints data signal-context)
3176 (delete-breakpoint-data data)
3179 (declare (optimize (inhibit-warnings 3)))
3180 (sb!alien:sap-alien signal-context (* os-context-t))))
3181 (frame (do ((cfp (sb!vm:context-register scp sb!vm::cfp-offset))
3182 (f (top-frame) (frame-down f)))
3183 ((= cfp (sap-int (frame-pointer f))) f)
3184 (declare (type (unsigned-byte #.sb!vm:n-word-bits) cfp))))
3185 (component (breakpoint-data-component data))
3186 (cookie (gethash component *fun-end-cookies*)))
3187 (remhash component *fun-end-cookies*)
3188 (dolist (bpt breakpoints)
3189 (funcall (breakpoint-hook-function bpt)
3191 (get-fun-end-breakpoint-values scp)
3194 (defun get-fun-end-breakpoint-values (scp)
3195 (let ((ocfp (int-sap (sb!vm:context-register
3197 #!-x86 sb!vm::ocfp-offset
3198 #!+x86 sb!vm::ebx-offset)))
3199 (nargs (make-lisp-obj
3200 (sb!vm:context-register scp sb!vm::nargs-offset)))
3201 (reg-arg-offsets '#.sb!vm::*register-arg-offsets*)
3204 (dotimes (arg-num nargs)
3205 (push (if reg-arg-offsets
3207 (sb!vm:context-register scp (pop reg-arg-offsets)))
3208 (stack-ref ocfp arg-num))
3210 (nreverse results)))
3212 ;;;; MAKE-BOGUS-LRA (used for :FUN-END breakpoints)
3214 (defconstant bogus-lra-constants
3216 (defconstant known-return-p-slot
3217 (+ sb!vm:code-constants-offset #!-x86 1 #!+x86 2))
3219 ;;; Make a bogus LRA object that signals a breakpoint trap when
3220 ;;; returned to. If the breakpoint trap handler returns, REAL-LRA is
3221 ;;; returned to. Three values are returned: the bogus LRA object, the
3222 ;;; code component it is part of, and the PC offset for the trap
3224 (defun make-bogus-lra (real-lra &optional known-return-p)
3226 (let* ((src-start (foreign-symbol-address "fun_end_breakpoint_guts"))
3227 (src-end (foreign-symbol-address "fun_end_breakpoint_end"))
3228 (trap-loc (foreign-symbol-address "fun_end_breakpoint_trap"))
3229 (length (sap- src-end src-start))
3232 #!-(and x86 gencgc) sb!c:allocate-code-object
3233 #!+(and x86 gencgc) sb!c::allocate-dynamic-code-object
3234 (1+ bogus-lra-constants)
3236 (dst-start (code-instructions code-object)))
3237 (declare (type system-area-pointer
3238 src-start src-end dst-start trap-loc)
3239 (type index length))
3240 (setf (%code-debug-info code-object) :bogus-lra)
3241 (setf (code-header-ref code-object sb!vm:code-trace-table-offset-slot)
3244 (setf (code-header-ref code-object real-lra-slot) real-lra)
3246 (multiple-value-bind (offset code) (compute-lra-data-from-pc real-lra)
3247 (setf (code-header-ref code-object real-lra-slot) code)
3248 (setf (code-header-ref code-object (1+ real-lra-slot)) offset))
3249 (setf (code-header-ref code-object known-return-p-slot)
3251 (system-area-copy src-start 0 dst-start 0 (* length sb!vm:n-byte-bits))
3252 (sb!vm:sanctify-for-execution code-object)
3254 (values dst-start code-object (sap- trap-loc src-start))
3256 (let ((new-lra (make-lisp-obj (+ (sap-int dst-start)
3257 sb!vm:other-pointer-lowtag))))
3260 (logandc2 (+ sb!vm:code-constants-offset bogus-lra-constants 1)
3262 (sb!vm:sanctify-for-execution code-object)
3263 (values new-lra code-object (sap- trap-loc src-start))))))
3267 ;;; This appears here because it cannot go with the DEBUG-FUN
3268 ;;; interface since DO-DEBUG-BLOCK-LOCATIONS isn't defined until after
3269 ;;; the DEBUG-FUN routines.
3271 ;;; Return a code-location before the body of a function and after all
3272 ;;; the arguments are in place; or if that location can't be
3273 ;;; determined due to a lack of debug information, return NIL.
3274 (defun debug-fun-start-location (debug-fun)
3275 (etypecase debug-fun
3277 (code-location-from-pc debug-fun
3278 (sb!c::compiled-debug-fun-start-pc
3279 (compiled-debug-fun-compiler-debug-fun
3282 ;; (There used to be more cases back before sbcl-0.7.0, when
3283 ;; we did special tricks to debug the IR1 interpreter.)
3286 (defun print-code-locations (function)
3287 (let ((debug-fun (fun-debug-fun function)))
3288 (do-debug-fun-blocks (block debug-fun)
3289 (do-debug-block-locations (loc block)
3290 (fill-in-code-location loc)
3291 (format t "~S code location at ~W"
3292 (compiled-code-location-kind loc)
3293 (compiled-code-location-pc loc))
3294 (sb!debug::print-code-location-source-form loc 0)