0.7.5.15:
[sbcl.git] / src / code / debug-int.lisp
1 ;;;; the implementation of the programmer's interface to writing
2 ;;;; debugging tools
3
4 ;;;; This software is part of the SBCL system. See the README file for
5 ;;;; more information.
6 ;;;;
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.
12
13 (in-package "SB!DI")
14
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?
17 \f
18 ;;;; conditions
19
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.
34 ;;;;
35 ;;;; Use DEBUG-SIGNAL to signal these conditions.
36
37 (define-condition debug-condition (serious-condition)
38   ()
39   #!+sb-doc
40   (:documentation
41    "All DEBUG-CONDITIONs inherit from this type. These are serious conditions
42     that must be handled, but they are not programmer errors."))
43
44 (define-condition no-debug-info (debug-condition)
45   ((code-component :reader no-debug-info-code-component
46                    :initarg :code-component))
47   #!+sb-doc
48   (:documentation "There is no usable debugging information available.")
49   (:report (lambda (condition stream)
50              (fresh-line stream)
51              (format stream
52                      "no debug information available for ~S~%"
53                      (no-debug-info-code-component condition)))))
54
55 (define-condition no-debug-fun-returns (debug-condition)
56   ((debug-fun :reader no-debug-fun-returns-debug-fun
57               :initarg :debug-fun))
58   #!+sb-doc
59   (:documentation
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))))
65                (format stream
66                        "~&Cannot return values from ~:[frame~;~:*~S~] since ~
67                         the debug information lacks details about returning ~
68                         values here."
69                        fun)))))
70
71 (define-condition no-debug-blocks (debug-condition)
72   ((debug-fun :reader no-debug-blocks-debug-fun
73               :initarg :debug-fun))
74   #!+sb-doc
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)))))
79
80 (define-condition no-debug-vars (debug-condition)
81   ((debug-fun :reader no-debug-vars-debug-fun
82               :initarg :debug-fun))
83   #!+sb-doc
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)))))
88
89 (define-condition lambda-list-unavailable (debug-condition)
90   ((debug-fun :reader lambda-list-unavailable-debug-fun
91               :initarg :debug-fun))
92   #!+sb-doc
93   (:documentation
94    "The DEBUG-FUN has no lambda list since argument DEBUG-VARs are
95     unavailable.")
96   (:report (lambda (condition stream)
97              (format stream "~&~S has no lambda-list information available."
98                      (lambda-list-unavailable-debug-fun condition)))))
99
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)))))
107
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)))))
115 \f
116 ;;;; errors and DEBUG-SIGNAL
117
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
121 ;;; come up.
122 ;;;
123 ;;; While under development, this code also signals errors in code
124 ;;; branches that remain unimplemented.
125
126 (define-condition debug-error (error) ()
127   #!+sb-doc
128   (:documentation
129    "All programmer errors from using the interface for building debugging
130     tools inherit from this type."))
131
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)))))
137
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)))))
144
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)))))
153
154 (define-condition invalid-control-stack-pointer (debug-error)
155   ()
156   (:report (lambda (condition stream)
157              (declare (ignore condition))
158              (fresh-line stream)
159              (write-string "invalid control stack pointer" stream))))
160
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)
167              (format
168               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)))))
173
174 ;;; This signals debug-conditions. If they go unhandled, then signal
175 ;;; an UNHANDLED-DEBUG-CONDITION error.
176 ;;;
177 ;;; ??? Get SIGNAL in the right package!
178 (defmacro debug-signal (datum &rest arguments)
179   `(let ((condition (make-condition ,datum ,@arguments)))
180      (signal condition)
181      (error 'unhandled-debug-condition :condition condition)))
182 \f
183 ;;;; structures
184 ;;;;
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.
190
191 ;;;; DEBUG-VARs
192
193 ;;; These exist for caching data stored in packed binary form in
194 ;;; compiler DEBUG-FUNs.
195 (defstruct (debug-var (:constructor nil)
196                       (:copier 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
200   ;; symbol
201   (id 0 :type index)
202   ;; Does the variable always have a valid value?
203   (alive-p nil :type boolean))
204 (def!method print-object ((debug-var debug-var) stream)
205   (print-unreadable-object (debug-var stream :type t :identity t)
206     (format stream
207             "~S ~W"
208             (debug-var-symbol debug-var)
209             (debug-var-id debug-var))))
210
211 #!+sb-doc
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.")
215
216 (defstruct (compiled-debug-var
217             (:include debug-var)
218             (:constructor make-compiled-debug-var
219                           (symbol id alive-p sc-offset save-sc-offset))
220             (:copier nil))
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)))
225
226 ;;;; frames
227
228 ;;; These represent call frames on the stack.
229 (defstruct (frame (:constructor nil)
230                   (:copier 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
243   ;; CODE-LOCATION.
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)
248   pointer
249   ;; This is the frame's number for prompt printing. Top is zero.
250   (number 0 :type index))
251
252 (defstruct (compiled-frame
253             (:include frame)
254             (:constructor make-compiled-frame
255                           (pointer up debug-fun code-location number
256                                    &optional escaped))
257             (:copier nil))
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.
262   escaped)
263 (def!method print-object ((obj compiled-frame) str)
264   (print-unreadable-object (obj str :type t)
265     (format str
266             "~S~:[~;, interrupted~]"
267             (debug-fun-name (frame-debug-fun obj))
268             (compiled-frame-escaped obj))))
269 \f
270 ;;;; DEBUG-FUNs
271
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)
279                       (:copier 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)))
295
296 (defstruct (compiled-debug-fun
297             (:include debug-fun)
298             (:constructor %make-compiled-debug-fun
299                           (compiler-debug-fun component))
300             (:copier nil))
301   ;; compiler's dumped DEBUG-FUN information (unexported)
302   (compiler-debug-fun nil :type sb!c::compiled-debug-fun)
303   ;; code object (unexported).
304   component
305   ;; the :FUN-START breakpoint (if any) used to facilitate
306   ;; function end breakpoints
307   (end-starter nil :type (or null breakpoint)))
308
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))
313
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))))
323
324 (defstruct (bogus-debug-fun
325             (:include debug-fun)
326             (:constructor make-bogus-debug-fun
327                           (%name &aux
328                                  (%lambda-list nil)
329                                  (%debug-vars nil)
330                                  (blocks nil)
331                                  (%function nil)))
332             (:copier nil))
333   %name)
334
335 (defvar *ir1-lambda-debug-fun* (make-hash-table :test 'eq))
336 \f
337 ;;;; DEBUG-BLOCKs
338
339 ;;; These exist for caching data stored in packed binary form in compiler
340 ;;; DEBUG-BLOCKs.
341 (defstruct (debug-block (:constructor nil)
342                         (:copier 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)))
353
354 #!+sb-doc
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.")
358
359 #!+sb-doc
360 (setf (fdocumentation 'debug-block-elsewhere-p 'function)
361   "Return whether debug-block represents elsewhere code.")
362
363 (defstruct (compiled-debug-block (:include debug-block)
364                                  (:constructor
365                                   make-compiled-debug-block
366                                   (code-locations successors elsewhere-p))
367                                  (:copier nil))
368   ;; code-location information for the block
369   (code-locations nil :type simple-vector))
370
371 (defvar *ir1-block-debug-block* (make-hash-table :test 'eq))
372 \f
373 ;;;; breakpoints
374
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
378                                           (component offset))
379                             (:copier nil))
380   ;; This is the component in which the breakpoint lies.
381   component
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"
391             (debug-fun-name
392              (debug-fun-from-pc (breakpoint-data-component obj)
393                                 (breakpoint-data-offset obj)))
394             (breakpoint-data-offset obj))))
395
396 (defstruct (breakpoint (:constructor %make-breakpoint
397                                      (hook-fun what kind %info))
398                        (:copier nil))
399   ;; This is the function invoked when execution encounters the
400   ;; breakpoint. It takes a frame, the breakpoint, and optionally a
401   ;; list of values. Values are supplied for :FUN-END breakpoints as
402   ;; values to return for the function containing the breakpoint.
403   ;; :FUN-END breakpoint hook functions also take a cookie argument.
404   ;; See the COOKIE-FUN slot.
405   (hook-fun (required-arg) :type function)
406   ;; CODE-LOCATION or DEBUG-FUN
407   (what nil :type (or code-location debug-fun))
408   ;; :CODE-LOCATION, :FUN-START, or :FUN-END for that kind
409   ;; of breakpoint. :UNKNOWN-RETURN-PARTNER if this is the partner of
410   ;; a :code-location breakpoint at an :UNKNOWN-RETURN code-location.
411   (kind nil :type (member :code-location :fun-start :fun-end
412                           :unknown-return-partner))
413   ;; Status helps the user and the implementation.
414   (status :inactive :type (member :active :inactive :deleted))
415   ;; This is a backpointer to a breakpoint-data.
416   (internal-data nil :type (or null breakpoint-data))
417   ;; With code-locations whose type is :UNKNOWN-RETURN, there are
418   ;; really two breakpoints: one at the multiple-value entry point,
419   ;; and one at the single-value entry point. This slot holds the
420   ;; breakpoint for the other one, or NIL if this isn't at an
421   ;; :UNKNOWN-RETURN code location.
422   (unknown-return-partner nil :type (or null breakpoint))
423   ;; :FUN-END breakpoints use a breakpoint at the :FUN-START
424   ;; to establish the end breakpoint upon function entry. We do this
425   ;; by frobbing the LRA to jump to a special piece of code that
426   ;; breaks and provides the return values for the returnee. This slot
427   ;; points to the start breakpoint, so we can activate, deactivate,
428   ;; and delete it.
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.
437   %info)
438 (def!method print-object ((obj breakpoint) str)
439   (let ((what (breakpoint-what obj)))
440     (print-unreadable-object (obj str :type t)
441       (format str
442               "~S~:[~;~:*~S~]"
443               (etypecase what
444                 (code-location what)
445                 (debug-fun (debug-fun-name what)))
446               (etypecase what
447                 (code-location nil)
448                 (debug-fun (breakpoint-kind obj)))))))
449 \f
450 ;;;; CODE-LOCATIONs
451
452 (defstruct (code-location (:constructor nil)
453                           (:copier 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))
477            str)))
478
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))
485             (:copier nil))
486   ;; an index into DEBUG-FUN's component slot
487   (pc nil :type index)
488   ;; a bit-vector indexed by a variable's position in
489   ;; DEBUG-FUN-DEBUG-VARS indicating whether the variable has a
490   ;; valid value at this code-location. (unexported).
491   (%live-set :unparsed :type (or simple-bit-vector (member :unparsed)))
492   ;; (unexported) To see SB!C::LOCATION-KIND, do
493   ;; (SB!KERNEL:TYPE-EXPAND 'SB!C::LOCATION-KIND).
494   (kind :unparsed :type (or (member :unparsed) sb!c::location-kind)))
495 \f
496 ;;;; DEBUG-SOURCEs
497
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))
506 \f
507 ;;;; frames
508
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)
515
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))
526
527 #!-sb-fluid (declaim (inline control-stack-pointer-valid-p))
528 (defun control-stack-pointer-valid-p (x)
529   (declare (type system-area-pointer x))
530   #!-stack-grows-downward-not-upward
531   (and (sap< x (current-sp))
532        (sap<= (int-sap control-stack-start)
533               x)
534        (zerop (logand (sap-int x) #b11)))
535   #!+stack-grows-downward-not-upward
536   (and (sap>= x (current-sp))
537        (sap> (int-sap control-stack-end) x)
538        (zerop (logand (sap-int x) #b11))))
539
540 #!+x86
541 (sb!alien:define-alien-routine component-ptr-from-pc (system-area-pointer)
542   (pc system-area-pointer))
543
544 #!+x86
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)))
549
550 ;;;; X86 support
551
552 #!+x86
553 (progn
554
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)
564                             code-header-len)))
565 ;        (format t "c-lra-fpc ~A ~A ~A~%" pc code pc-offset)
566          (values pc-offset code)))))
567
568 (defconstant sb!vm::nargs-offset #.sb!vm::ecx-offset)
569
570 ;;; Check for a valid return address - it could be any valid C/Lisp
571 ;;; address.
572 ;;;
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))
577   (and
578    ;; not the first page (which is unmapped)
579    ;;
580    ;; FIXME: Where is this documented? Is it really true of every CPU
581    ;; architecture? Is it even necessarily true in current SBCL?
582    (>= (sap-int ra) 4096)
583    ;; not a Lisp stack pointer
584    (not (control-stack-pointer-valid-p ra))))
585
586 ;;; Try to find a valid previous stack. This is complex on the x86 as
587 ;;; it can jump between C and Lisp frames. To help find a valid frame
588 ;;; it searches backwards.
589 ;;;
590 ;;; XXX Should probably check whether it has reached the bottom of the
591 ;;; stack.
592 ;;;
593 ;;; XXX Should handle interrupted frames, both Lisp and C. At present
594 ;;; it manages to find a fp trail, see linux hack below.
595 (defun x86-call-context (fp &key (depth 0))
596   (declare (type system-area-pointer fp)
597            (fixnum depth))
598   ;;(format t "*CC ~S ~S~%" fp depth)
599   (cond
600    ((not (control-stack-pointer-valid-p fp))
601     #+nil (format t "debug invalid fp ~S~%" fp)
602     nil)
603    (t
604     ;; Check the two possible frame pointers.
605     (let ((lisp-ocfp (sap-ref-sap fp (- (* (1+ ocfp-save-offset) 4))))
606           (lisp-ra (sap-ref-sap fp (- (* (1+ return-pc-save-offset)
607                                          4))))
608           (c-ocfp (sap-ref-sap fp (* 0 sb!vm:n-word-bytes)))
609           (c-ra (sap-ref-sap fp (* 1 sb!vm:n-word-bytes))))
610       (cond ((and (sap> lisp-ocfp fp) (control-stack-pointer-valid-p lisp-ocfp)
611                   (ra-pointer-valid-p lisp-ra)
612                   (sap> c-ocfp fp) (control-stack-pointer-valid-p c-ocfp)
613                   (ra-pointer-valid-p c-ra))
614              #+nil (format t
615                            "*C Both valid ~S ~S ~S ~S~%"
616                            lisp-ocfp lisp-ra c-ocfp c-ra)
617              ;; Look forward another step to check their validity.
618              (let ((lisp-path-fp (x86-call-context lisp-ocfp
619                                                    :depth (1+ depth)))
620                    (c-path-fp (x86-call-context c-ocfp :depth (1+ depth))))
621                (cond ((and lisp-path-fp c-path-fp)
622                        ;; Both still seem valid - choose the lisp frame.
623                        #+nil (when (zerop depth)
624                                (format t
625                                        "debug: both still valid ~S ~S ~S ~S~%"
626                                        lisp-ocfp lisp-ra c-ocfp c-ra))
627                       #!+freebsd
628                       (if (sap> lisp-ocfp c-ocfp)
629                         (values lisp-ra lisp-ocfp)
630                         (values c-ra c-ocfp))
631                        #!-freebsd
632                        (values lisp-ra lisp-ocfp))
633                      (lisp-path-fp
634                       ;; The lisp convention is looking good.
635                       #+nil (format t "*C lisp-ocfp ~S ~S~%" lisp-ocfp lisp-ra)
636                       (values lisp-ra lisp-ocfp))
637                      (c-path-fp
638                       ;; The C convention is looking good.
639                       #+nil (format t "*C c-ocfp ~S ~S~%" c-ocfp c-ra)
640                       (values c-ra c-ocfp))
641                      (t
642                       ;; Neither seems right?
643                       #+nil (format t "debug: no valid2 fp found ~S ~S~%"
644                                     lisp-ocfp c-ocfp)
645                       nil))))
646             ((and (sap> lisp-ocfp fp) (control-stack-pointer-valid-p lisp-ocfp)
647                   (ra-pointer-valid-p lisp-ra))
648              ;; The lisp convention is looking good.
649              #+nil (format t "*C lisp-ocfp ~S ~S~%" lisp-ocfp lisp-ra)
650              (values lisp-ra lisp-ocfp))
651             ((and (sap> c-ocfp fp) (control-stack-pointer-valid-p c-ocfp)
652                   #!-linux (ra-pointer-valid-p c-ra))
653              ;; The C convention is looking good.
654              #+nil (format t "*C c-ocfp ~S ~S~%" c-ocfp c-ra)
655              (values c-ra c-ocfp))
656             (t
657              #+nil (format t "debug: no valid fp found ~S ~S~%"
658                            lisp-ocfp c-ocfp)
659              nil))))))
660
661 ) ; #+x86 PROGN
662 \f
663 ;;; Convert the descriptor into a SAP. The bits all stay the same, we just
664 ;;; change our notion of what we think they are.
665 #!-sb-fluid (declaim (inline descriptor-sap))
666 (defun descriptor-sap (x)
667   (int-sap (get-lisp-obj-address x)))
668
669 ;;; Return the top frame of the control stack as it was before calling
670 ;;; this function.
671 (defun top-frame ()
672   (/noshow0 "entering TOP-FRAME")
673   (multiple-value-bind (fp pc) (%caller-frame-and-pc)
674     (compute-calling-frame (descriptor-sap fp) pc nil)))
675
676 ;;; Flush all of the frames above FRAME, and renumber all the frames
677 ;;; below FRAME.
678 (defun flush-frames-above (frame)
679   (setf (frame-up frame) nil)
680   (do ((number 0 (1+ number))
681        (frame frame (frame-%down frame)))
682       ((not (frame-p frame)))
683     (setf (frame-number frame) number)))
684
685 ;;; Return the frame immediately below FRAME on the stack; or when
686 ;;; FRAME is the bottom of the stack, return NIL.
687 (defun frame-down (frame)
688   (/noshow0 "entering FRAME-DOWN")
689   ;; We have to access the old-fp and return-pc out of frame and pass
690   ;; them to COMPUTE-CALLING-FRAME.
691   (let ((down (frame-%down frame)))
692     (if (eq down :unparsed)
693         (let ((debug-fun (frame-debug-fun frame)))
694           (/noshow0 "in DOWN :UNPARSED case")
695           (setf (frame-%down frame)
696                 (etypecase debug-fun
697                   (compiled-debug-fun
698                    (let ((c-d-f (compiled-debug-fun-compiler-debug-fun
699                                  debug-fun)))
700                      (compute-calling-frame
701                       (descriptor-sap
702                        (get-context-value
703                         frame ocfp-save-offset
704                         (sb!c::compiled-debug-fun-old-fp c-d-f)))
705                       (get-context-value
706                        frame lra-save-offset
707                        (sb!c::compiled-debug-fun-return-pc c-d-f))
708                       frame)))
709                   (bogus-debug-fun
710                    (let ((fp (frame-pointer frame)))
711                      (when (control-stack-pointer-valid-p fp)
712                        #!+x86
713                         (multiple-value-bind (ra ofp) (x86-call-context fp)
714                           (compute-calling-frame ofp ra frame))
715                         #!-x86
716                        (compute-calling-frame
717                         #!-alpha
718                         (sap-ref-sap fp (* ocfp-save-offset
719                                            sb!vm:n-word-bytes))
720                         #!+alpha
721                         (int-sap
722                          (sap-ref-32 fp (* ocfp-save-offset
723                                            sb!vm:n-word-bytes)))
724
725                         (stack-ref fp lra-save-offset)
726
727                         frame)))))))
728         down)))
729
730 ;;; Get the old FP or return PC out of FRAME. STACK-SLOT is the
731 ;;; standard save location offset on the stack. LOC is the saved
732 ;;; SC-OFFSET describing the main location.
733 #!-x86
734 (defun get-context-value (frame stack-slot loc)
735   (declare (type compiled-frame frame) (type unsigned-byte stack-slot)
736            (type sb!c:sc-offset loc))
737   (let ((pointer (frame-pointer frame))
738         (escaped (compiled-frame-escaped frame)))
739     (if escaped
740         (sub-access-debug-var-slot pointer loc escaped)
741         (stack-ref pointer stack-slot))))
742 #!+x86
743 (defun get-context-value (frame stack-slot loc)
744   (declare (type compiled-frame frame) (type unsigned-byte stack-slot)
745            (type sb!c:sc-offset loc))
746   (let ((pointer (frame-pointer frame))
747         (escaped (compiled-frame-escaped frame)))
748     (if escaped
749         (sub-access-debug-var-slot pointer loc escaped)
750         (ecase stack-slot
751           (#.ocfp-save-offset
752            (stack-ref pointer stack-slot))
753           (#.lra-save-offset
754            (sap-ref-sap pointer (- (* (1+ stack-slot) 4))))))))
755
756 #!-x86
757 (defun (setf get-context-value) (value frame stack-slot loc)
758   (declare (type compiled-frame frame) (type unsigned-byte stack-slot)
759            (type sb!c:sc-offset loc))
760   (let ((pointer (frame-pointer frame))
761         (escaped (compiled-frame-escaped frame)))
762     (if escaped
763         (sub-set-debug-var-slot pointer loc value escaped)
764         (setf (stack-ref pointer stack-slot) value))))
765
766 #!+x86
767 (defun (setf get-context-value) (value frame stack-slot loc)
768   (declare (type compiled-frame frame) (type unsigned-byte stack-slot)
769            (type sb!c:sc-offset loc))
770   (let ((pointer (frame-pointer frame))
771         (escaped (compiled-frame-escaped frame)))
772     (if escaped
773         (sub-set-debug-var-slot pointer loc value escaped)
774         (ecase stack-slot
775           (#.ocfp-save-offset
776            (setf (stack-ref pointer stack-slot) value))
777           (#.lra-save-offset
778            (setf (sap-ref-sap pointer (- (* (1+ stack-slot) 4))) value))))))
779
780 ;;; This returns a frame for the one existing in time immediately
781 ;;; prior to the frame referenced by current-fp. This is current-fp's
782 ;;; caller or the next frame down the control stack. If there is no
783 ;;; down frame, this returns NIL for the bottom of the stack. UP-FRAME
784 ;;; is the up link for the resulting frame object, and it is null when
785 ;;; we call this to get the top of the stack.
786 ;;;
787 ;;; The current frame contains the pointer to the temporally previous
788 ;;; frame we want, and the current frame contains the pc at which we
789 ;;; will continue executing upon returning to that previous frame.
790 ;;;
791 ;;; Note: Sometimes LRA is actually a fixnum. This happens when lisp
792 ;;; calls into C. In this case, the code object is stored on the stack
793 ;;; after the LRA, and the LRA is the word offset.
794 #!-x86
795 (defun compute-calling-frame (caller lra up-frame)
796   (declare (type system-area-pointer caller))
797   (when (control-stack-pointer-valid-p caller)
798     (multiple-value-bind (code pc-offset escaped)
799         (if lra
800             (multiple-value-bind (word-offset code)
801                 (if (fixnump lra)
802                     (let ((fp (frame-pointer up-frame)))
803                       (values lra
804                               (stack-ref fp (1+ lra-save-offset))))
805                     (values (get-header-data lra)
806                             (lra-code-header lra)))
807               (if code
808                   (values code
809                           (* (1+ (- word-offset (get-header-data code)))
810                              sb!vm:n-word-bytes)
811                           nil)
812                   (values :foreign-function
813                           0
814                           nil)))
815             (find-escaped-frame caller))
816       (if (and (code-component-p code)
817                (eq (%code-debug-info code) :bogus-lra))
818           (let ((real-lra (code-header-ref code real-lra-slot)))
819             (compute-calling-frame caller real-lra up-frame))
820           (let ((d-fun (case code
821                          (:undefined-function
822                           (make-bogus-debug-fun
823                            "undefined function"))
824                          (:foreign-function
825                           (make-bogus-debug-fun
826                            "foreign function call land"))
827                          ((nil)
828                           (make-bogus-debug-fun
829                            "bogus stack frame"))
830                          (t
831                           (debug-fun-from-pc code pc-offset)))))
832             (make-compiled-frame caller up-frame d-fun
833                                  (code-location-from-pc d-fun pc-offset
834                                                         escaped)
835                                  (if up-frame (1+ (frame-number up-frame)) 0)
836                                  escaped))))))
837 #!+x86
838 (defun compute-calling-frame (caller ra up-frame)
839   (declare (type system-area-pointer caller ra))
840   (/noshow0 "entering COMPUTE-CALLING-FRAME")
841   (when (control-stack-pointer-valid-p caller)
842     (/noshow0 "in WHEN")
843     ;; First check for an escaped frame.
844     (multiple-value-bind (code pc-offset escaped) (find-escaped-frame caller)
845       (/noshow0 "at COND")
846       (cond (code
847              (/noshow0 "in CODE clause")
848              ;; If it's escaped it may be a function end breakpoint trap.
849              (when (and (code-component-p code)
850                         (eq (%code-debug-info code) :bogus-lra))
851                ;; If :bogus-lra grab the real lra.
852                (setq pc-offset (code-header-ref
853                                 code (1+ real-lra-slot)))
854                (setq code (code-header-ref code real-lra-slot))
855                (aver code)))
856             (t
857              (/noshow0 "in T clause")
858              ;; not escaped
859              (multiple-value-setq (pc-offset code)
860                (compute-lra-data-from-pc ra))
861              (unless code
862                (setf code :foreign-function
863                      pc-offset 0
864                      escaped nil))))
865
866       (let ((d-fun (case code
867                      (:undefined-function
868                       (make-bogus-debug-fun
869                        "undefined function"))
870                      (:foreign-function
871                       (make-bogus-debug-fun
872                        "foreign function call land"))
873                      ((nil)
874                       (make-bogus-debug-fun
875                        "bogus stack frame"))
876                      (t
877                       (debug-fun-from-pc code pc-offset)))))
878         (/noshow0 "returning MAKE-COMPILED-FRAME from COMPUTE-CALLING-FRAME")
879         (make-compiled-frame caller up-frame d-fun
880                              (code-location-from-pc d-fun pc-offset
881                                                     escaped)
882                              (if up-frame (1+ (frame-number up-frame)) 0)
883                              escaped)))))
884
885 #!+x86
886 (defun find-escaped-frame (frame-pointer)
887   (declare (type system-area-pointer frame-pointer))
888   (/noshow0 "entering FIND-ESCAPED-FRAME")
889   (dotimes (index *free-interrupt-context-index* (values nil 0 nil))
890     (sb!alien:with-alien
891         ((lisp-interrupt-contexts (array (* os-context-t) nil) :extern))
892       (/noshow0 "at head of WITH-ALIEN")
893       (let ((context (sb!alien:deref lisp-interrupt-contexts index)))
894         (/noshow0 "got CONTEXT")
895         (when (= (sap-int frame-pointer)
896                  (sb!vm:context-register context sb!vm::cfp-offset))
897           (without-gcing
898            (/noshow0 "in WITHOUT-GCING")
899            (let* ((component-ptr (component-ptr-from-pc
900                                   (sb!vm:context-pc context)))
901                   (code (unless (sap= component-ptr (int-sap #x0))
902                           (component-from-component-ptr component-ptr))))
903              (/noshow0 "got CODE")
904              (when (null code)
905                (return (values code 0 context)))
906              (let* ((code-header-len (* (get-header-data code)
907                                         sb!vm:n-word-bytes))
908                     (pc-offset
909                      (- (sap-int (sb!vm:context-pc context))
910                         (- (get-lisp-obj-address code)
911                            sb!vm:other-pointer-lowtag)
912                         code-header-len)))
913                (/noshow "got PC-OFFSET")
914                (unless (<= 0 pc-offset
915                            (* (code-header-ref code sb!vm:code-code-size-slot)
916                               sb!vm:n-word-bytes))
917                  ;; We were in an assembly routine. Therefore, use the
918                  ;; LRA as the pc.
919                  ;;
920                  ;; FIXME: Should this be WARN or ERROR or what?
921                  (format t "** pc-offset ~S not in code obj ~S?~%"
922                          pc-offset code))
923                (/noshow0 "returning from FIND-ESCAPED-FRAME")
924                (return
925                 (values code pc-offset context))))))))))
926
927 #!-x86
928 (defun find-escaped-frame (frame-pointer)
929   (declare (type system-area-pointer frame-pointer))
930   (dotimes (index *free-interrupt-context-index* (values nil 0 nil))
931     (sb!alien:with-alien
932      ((lisp-interrupt-contexts (array (* os-context-t) nil) :extern))
933      (let ((scp (sb!alien:deref lisp-interrupt-contexts index)))
934        (when (= (sap-int frame-pointer)
935                 (sb!vm:context-register scp sb!vm::cfp-offset))
936          (without-gcing
937           (let ((code (code-object-from-bits
938                        (sb!vm:context-register scp sb!vm::code-offset))))
939             (when (symbolp code)
940               (return (values code 0 scp)))
941             (let* ((code-header-len (* (get-header-data code)
942                                        sb!vm:n-word-bytes))
943                    (pc-offset
944                     (- (sap-int (sb!vm:context-pc scp))
945                        (- (get-lisp-obj-address code)
946                           sb!vm:other-pointer-lowtag)
947                        code-header-len)))
948               ;; Check to see whether we were executing in a branch
949               ;; delay slot.
950               #!+(or pmax sgi) ; pmax only (and broken anyway)
951               (when (logbitp 31 (sb!alien:slot scp '%mips::sc-cause))
952                 (incf pc-offset sb!vm:n-word-bytes))
953               (unless (<= 0 pc-offset
954                           (* (code-header-ref code sb!vm:code-code-size-slot)
955                              sb!vm:n-word-bytes))
956                 ;; We were in an assembly routine. Therefore, use the
957                 ;; LRA as the pc.
958                 (setf pc-offset
959                       (- (sb!vm:context-register scp sb!vm::lra-offset)
960                          (get-lisp-obj-address code)
961                          code-header-len)))
962                (return
963                 (if (eq (%code-debug-info code) :bogus-lra)
964                     (let ((real-lra (code-header-ref code
965                                                      real-lra-slot)))
966                       (values (lra-code-header real-lra)
967                               (get-header-data real-lra)
968                               nil))
969                   (values code pc-offset scp)))))))))))
970
971 ;;; Find the code object corresponding to the object represented by
972 ;;; bits and return it. We assume bogus functions correspond to the
973 ;;; undefined-function.
974 (defun code-object-from-bits (bits)
975   (declare (type (unsigned-byte 32) bits))
976   (let ((object (make-lisp-obj bits)))
977     (if (functionp object)
978         (or (fun-code-header object)
979             :undefined-function)
980         (let ((lowtag (lowtag-of object)))
981           (if (= lowtag sb!vm:other-pointer-lowtag)
982               (let ((widetag (widetag-of object)))
983                 (cond ((= widetag sb!vm:code-header-widetag)
984                        object)
985                       ((= widetag sb!vm:return-pc-header-widetag)
986                        (lra-code-header object))
987                       (t
988                        nil))))))))
989 \f
990 ;;;; frame utilities
991
992 ;;; This returns a COMPILED-DEBUG-FUN for COMPONENT and PC. We fetch the
993 ;;; SB!C::DEBUG-INFO and run down its FUN-MAP to get a
994 ;;; SB!C::COMPILED-DEBUG-FUN from the PC. The result only needs to
995 ;;; reference the COMPONENT, for function constants, and the
996 ;;; SB!C::COMPILED-DEBUG-FUN.
997 (defun debug-fun-from-pc (component pc)
998   (let ((info (%code-debug-info component)))
999     (cond
1000      ((not info)
1001       (debug-signal 'no-debug-info :code-component component))
1002      ((eq info :bogus-lra)
1003       (make-bogus-debug-fun "function end breakpoint"))
1004      (t
1005       (let* ((fun-map (sb!c::compiled-debug-info-fun-map info))
1006              (len (length fun-map)))
1007         (declare (type simple-vector fun-map))
1008         (if (= len 1)
1009             (make-compiled-debug-fun (svref fun-map 0) component)
1010             (let ((i 1)
1011                   (elsewhere-p
1012                    (>= pc (sb!c::compiled-debug-fun-elsewhere-pc
1013                            (svref fun-map 0)))))
1014               (declare (type sb!int:index i))
1015               (loop
1016                 (when (or (= i len)
1017                           (< pc (if elsewhere-p
1018                                     (sb!c::compiled-debug-fun-elsewhere-pc
1019                                      (svref fun-map (1+ i)))
1020                                     (svref fun-map i))))
1021                   (return (make-compiled-debug-fun
1022                            (svref fun-map (1- i))
1023                            component)))
1024                 (incf i 2)))))))))
1025
1026 ;;; This returns a code-location for the COMPILED-DEBUG-FUN,
1027 ;;; DEBUG-FUN, and the pc into its code vector. If we stopped at a
1028 ;;; breakpoint, find the CODE-LOCATION for that breakpoint. Otherwise,
1029 ;;; make an :UNSURE code location, so it can be filled in when we
1030 ;;; figure out what is going on.
1031 (defun code-location-from-pc (debug-fun pc escaped)
1032   (or (and (compiled-debug-fun-p debug-fun)
1033            escaped
1034            (let ((data (breakpoint-data
1035                         (compiled-debug-fun-component debug-fun)
1036                         pc nil)))
1037              (when (and data (breakpoint-data-breakpoints data))
1038                (let ((what (breakpoint-what
1039                             (first (breakpoint-data-breakpoints data)))))
1040                  (when (compiled-code-location-p what)
1041                    what)))))
1042       (make-compiled-code-location pc debug-fun)))
1043
1044 ;;; Return an alist mapping catch tags to CODE-LOCATIONs. These are
1045 ;;; CODE-LOCATIONs at which execution would continue with frame as the
1046 ;;; top frame if someone threw to the corresponding tag.
1047 (defun frame-catches (frame)
1048   (let ((catch (descriptor-sap sb!vm:*current-catch-block*))
1049         (reversed-result nil)
1050         (fp (frame-pointer frame)))
1051     (loop until (zerop (sap-int catch))
1052           finally (return (nreverse reversed-result))
1053           do
1054           (when (sap= fp
1055                       #!-alpha
1056                       (sap-ref-sap catch
1057                                    (* sb!vm:catch-block-current-cont-slot
1058                                       sb!vm:n-word-bytes))
1059                       #!+alpha
1060                       (int-sap
1061                        (sap-ref-32 catch
1062                                    (* sb!vm:catch-block-current-cont-slot
1063                                       sb!vm:n-word-bytes))))
1064             (let* (#!-x86
1065                    (lra (stack-ref catch sb!vm:catch-block-entry-pc-slot))
1066                    #!+x86
1067                    (ra (sap-ref-sap
1068                         catch (* sb!vm:catch-block-entry-pc-slot
1069                                  sb!vm:n-word-bytes)))
1070                    #!-x86
1071                    (component
1072                     (stack-ref catch sb!vm:catch-block-current-code-slot))
1073                    #!+x86
1074                    (component (component-from-component-ptr
1075                                (component-ptr-from-pc ra)))
1076                    (offset
1077                     #!-x86
1078                     (* (- (1+ (get-header-data lra))
1079                           (get-header-data component))
1080                        sb!vm:n-word-bytes)
1081                     #!+x86
1082                     (- (sap-int ra)
1083                        (- (get-lisp-obj-address component)
1084                           sb!vm:other-pointer-lowtag)
1085                        (* (get-header-data component) sb!vm:n-word-bytes))))
1086               (push (cons #!-x86
1087                           (stack-ref catch sb!vm:catch-block-tag-slot)
1088                           #!+x86
1089                           (make-lisp-obj
1090                            (sap-ref-32 catch (* sb!vm:catch-block-tag-slot
1091                                                 sb!vm:n-word-bytes)))
1092                           (make-compiled-code-location
1093                            offset (frame-debug-fun frame)))
1094                     reversed-result)))
1095           (setf catch
1096                 #!-alpha
1097                 (sap-ref-sap catch
1098                              (* sb!vm:catch-block-previous-catch-slot
1099                                 sb!vm:n-word-bytes))
1100                 #!+alpha
1101                 (int-sap
1102                  (sap-ref-32 catch
1103                              (* sb!vm:catch-block-previous-catch-slot
1104                                 sb!vm:n-word-bytes)))))))
1105 \f
1106 ;;;; operations on DEBUG-FUNs
1107
1108 ;;; Execute the forms in a context with BLOCK-VAR bound to each
1109 ;;; DEBUG-BLOCK in DEBUG-FUN successively. Result is an optional
1110 ;;; form to execute for return values, and DO-DEBUG-FUN-BLOCKS
1111 ;;; returns nil if there is no result form. This signals a
1112 ;;; NO-DEBUG-BLOCKS condition when the DEBUG-FUN lacks
1113 ;;; DEBUG-BLOCK information.
1114 (defmacro do-debug-fun-blocks ((block-var debug-fun &optional result)
1115                                &body body)
1116   (let ((blocks (gensym))
1117         (i (gensym)))
1118     `(let ((,blocks (debug-fun-debug-blocks ,debug-fun)))
1119        (declare (simple-vector ,blocks))
1120        (dotimes (,i (length ,blocks) ,result)
1121          (let ((,block-var (svref ,blocks ,i)))
1122            ,@body)))))
1123
1124 ;;; Execute body in a context with VAR bound to each DEBUG-VAR in
1125 ;;; DEBUG-FUN. This returns the value of executing result (defaults to
1126 ;;; nil). This may iterate over only some of DEBUG-FUN's variables or
1127 ;;; none depending on debug policy; for example, possibly the
1128 ;;; compilation only preserved argument information.
1129 (defmacro do-debug-fun-vars ((var debug-fun &optional result) &body body)
1130   (let ((vars (gensym))
1131         (i (gensym)))
1132     `(let ((,vars (debug-fun-debug-vars ,debug-fun)))
1133        (declare (type (or null simple-vector) ,vars))
1134        (if ,vars
1135            (dotimes (,i (length ,vars) ,result)
1136              (let ((,var (svref ,vars ,i)))
1137                ,@body))
1138            ,result))))
1139
1140 ;;; Return the object of type FUNCTION associated with the DEBUG-FUN,
1141 ;;; or NIL if the function is unavailable or is non-existent as a user
1142 ;;; callable function object.
1143 (defun debug-fun-fun (debug-fun)
1144   (let ((cached-value (debug-fun-%function debug-fun)))
1145     (if (eq cached-value :unparsed)
1146         (setf (debug-fun-%function debug-fun)
1147               (etypecase debug-fun
1148                 (compiled-debug-fun
1149                  (let ((component
1150                         (compiled-debug-fun-component debug-fun))
1151                        (start-pc
1152                         (sb!c::compiled-debug-fun-start-pc
1153                          (compiled-debug-fun-compiler-debug-fun debug-fun))))
1154                    (do ((entry (%code-entry-points component)
1155                                (%simple-fun-next entry)))
1156                        ((null entry) nil)
1157                      (when (= start-pc
1158                               (sb!c::compiled-debug-fun-start-pc
1159                                (compiled-debug-fun-compiler-debug-fun
1160                                 (fun-debug-fun entry))))
1161                        (return entry)))))
1162                 (bogus-debug-fun nil)))
1163         cached-value)))
1164
1165 ;;; Return the name of the function represented by DEBUG-FUN. This may
1166 ;;; be a string or a cons; do not assume it is a symbol.
1167 (defun debug-fun-name (debug-fun)
1168   (declare (type debug-fun debug-fun))
1169   (etypecase debug-fun
1170     (compiled-debug-fun
1171      (sb!c::compiled-debug-fun-name
1172       (compiled-debug-fun-compiler-debug-fun debug-fun)))
1173     (bogus-debug-fun
1174      (bogus-debug-fun-%name debug-fun))))
1175
1176 ;;; Return a DEBUG-FUN that represents debug information for FUN.
1177 (defun fun-debug-fun (fun)
1178   (declare (type function fun))
1179   (ecase (widetag-of fun)
1180     (#.sb!vm:closure-header-widetag
1181      (fun-debug-fun (%closure-fun fun)))
1182     (#.sb!vm:funcallable-instance-header-widetag
1183      (fun-debug-fun (funcallable-instance-fun fun)))
1184     ((#.sb!vm:simple-fun-header-widetag
1185       #.sb!vm:closure-fun-header-widetag)
1186       (let* ((name (%simple-fun-name fun))
1187              (component (fun-code-header fun))
1188              (res (find-if
1189                    (lambda (x)
1190                      (and (sb!c::compiled-debug-fun-p x)
1191                           (eq (sb!c::compiled-debug-fun-name x) name)
1192                           (eq (sb!c::compiled-debug-fun-kind x) nil)))
1193                    (sb!c::compiled-debug-info-fun-map
1194                     (%code-debug-info component)))))
1195         (if res
1196             (make-compiled-debug-fun res component)
1197             ;; KLUDGE: comment from CMU CL:
1198             ;;   This used to be the non-interpreted branch, but
1199             ;;   William wrote it to return the debug-fun of fun's XEP
1200             ;;   instead of fun's debug-fun. The above code does this
1201             ;;   more correctly, but it doesn't get or eliminate all
1202             ;;   appropriate cases. It mostly works, and probably
1203             ;;   works for all named functions anyway.
1204             ;; -- WHN 20000120
1205             (debug-fun-from-pc component
1206                                (* (- (fun-word-offset fun)
1207                                      (get-header-data component))
1208                                   sb!vm:n-word-bytes)))))))
1209
1210 ;;; Return the kind of the function, which is one of :OPTIONAL,
1211 ;;; :EXTERNAL, :TOPLEVEL, :CLEANUP, or NIL.
1212 (defun debug-fun-kind (debug-fun)
1213   ;; FIXME: This "is one of" information should become part of the function
1214   ;; declamation, not just a doc string
1215   (etypecase debug-fun
1216     (compiled-debug-fun
1217      (sb!c::compiled-debug-fun-kind
1218       (compiled-debug-fun-compiler-debug-fun debug-fun)))
1219     (bogus-debug-fun
1220      nil)))
1221
1222 ;;; Is there any variable information for DEBUG-FUN?
1223 (defun debug-var-info-available (debug-fun)
1224   (not (not (debug-fun-debug-vars debug-fun))))
1225
1226 ;;; Return a list of DEBUG-VARs in DEBUG-FUN having the same name
1227 ;;; and package as SYMBOL. If SYMBOL is uninterned, then this returns
1228 ;;; a list of DEBUG-VARs without package names and with the same name
1229 ;;; as symbol. The result of this function is limited to the
1230 ;;; availability of variable information in DEBUG-FUN; for
1231 ;;; example, possibly DEBUG-FUN only knows about its arguments.
1232 (defun debug-fun-symbol-vars (debug-fun symbol)
1233   (let ((vars (ambiguous-debug-vars debug-fun (symbol-name symbol)))
1234         (package (and (symbol-package symbol)
1235                       (package-name (symbol-package symbol)))))
1236     (delete-if (if (stringp package)
1237                    (lambda (var)
1238                      (let ((p (debug-var-package-name var)))
1239                        (or (not (stringp p))
1240                            (string/= p package))))
1241                    (lambda (var)
1242                      (stringp (debug-var-package-name var))))
1243                vars)))
1244
1245 ;;; Return a list of DEBUG-VARs in DEBUG-FUN whose names contain
1246 ;;; NAME-PREFIX-STRING as an initial substring. The result of this
1247 ;;; function is limited to the availability of variable information in
1248 ;;; debug-fun; for example, possibly debug-fun only knows
1249 ;;; about its arguments.
1250 (defun ambiguous-debug-vars (debug-fun name-prefix-string)
1251   (declare (simple-string name-prefix-string))
1252   (let ((variables (debug-fun-debug-vars debug-fun)))
1253     (declare (type (or null simple-vector) variables))
1254     (if variables
1255         (let* ((len (length variables))
1256                (prefix-len (length name-prefix-string))
1257                (pos (find-var name-prefix-string variables len))
1258                (res nil))
1259           (when pos
1260             ;; Find names from pos to variable's len that contain prefix.
1261             (do ((i pos (1+ i)))
1262                 ((= i len))
1263               (let* ((var (svref variables i))
1264                      (name (debug-var-symbol-name var))
1265                      (name-len (length name)))
1266                 (declare (simple-string name))
1267                 (when (/= (or (string/= name-prefix-string name
1268                                         :end1 prefix-len :end2 name-len)
1269                               prefix-len)
1270                           prefix-len)
1271                   (return))
1272                 (push var res)))
1273             (setq res (nreverse res)))
1274           res))))
1275
1276 ;;; This returns a position in VARIABLES for one containing NAME as an
1277 ;;; initial substring. END is the length of VARIABLES if supplied.
1278 (defun find-var (name variables &optional end)
1279   (declare (simple-vector variables)
1280            (simple-string name))
1281   (let ((name-len (length name)))
1282     (position name variables
1283               :test (lambda (x y)
1284                       (let* ((y (debug-var-symbol-name y))
1285                              (y-len (length y)))
1286                         (declare (simple-string y))
1287                         (and (>= y-len name-len)
1288                              (string= x y :end1 name-len :end2 name-len))))
1289               :end (or end (length variables)))))
1290
1291 ;;; Return a list representing the lambda-list for DEBUG-FUN. The
1292 ;;; list has the following structure:
1293 ;;;   (required-var1 required-var2
1294 ;;;    ...
1295 ;;;    (:optional var3 suppliedp-var4)
1296 ;;;    (:optional var5)
1297 ;;;    ...
1298 ;;;    (:rest var6) (:rest var7)
1299 ;;;    ...
1300 ;;;    (:keyword keyword-symbol var8 suppliedp-var9)
1301 ;;;    (:keyword keyword-symbol var10)
1302 ;;;    ...
1303 ;;;   )
1304 ;;; Each VARi is a DEBUG-VAR; however it may be the symbol :DELETED if
1305 ;;; it is unreferenced in DEBUG-FUN. This signals a
1306 ;;; LAMBDA-LIST-UNAVAILABLE condition when there is no argument list
1307 ;;; information.
1308 (defun debug-fun-lambda-list (debug-fun)
1309   (etypecase debug-fun
1310     (compiled-debug-fun (compiled-debug-fun-lambda-list debug-fun))
1311     (bogus-debug-fun nil)))
1312
1313 ;;; Note: If this has to compute the lambda list, it caches it in DEBUG-FUN.
1314 (defun compiled-debug-fun-lambda-list (debug-fun)
1315   (let ((lambda-list (debug-fun-%lambda-list debug-fun)))
1316     (cond ((eq lambda-list :unparsed)
1317            (multiple-value-bind (args argsp)
1318                (parse-compiled-debug-fun-lambda-list debug-fun)
1319              (setf (debug-fun-%lambda-list debug-fun) args)
1320              (if argsp
1321                  args
1322                  (debug-signal 'lambda-list-unavailable
1323                                :debug-fun debug-fun))))
1324           (lambda-list)
1325           ((bogus-debug-fun-p debug-fun)
1326            nil)
1327           ((sb!c::compiled-debug-fun-arguments
1328             (compiled-debug-fun-compiler-debug-fun debug-fun))
1329            ;; If the packed information is there (whether empty or not) as
1330            ;; opposed to being nil, then returned our cached value (nil).
1331            nil)
1332           (t
1333            ;; Our cached value is nil, and the packed lambda-list information
1334            ;; is nil, so we don't have anything available.
1335            (debug-signal 'lambda-list-unavailable
1336                          :debug-fun debug-fun)))))
1337
1338 ;;; COMPILED-DEBUG-FUN-LAMBDA-LIST calls this when a
1339 ;;; COMPILED-DEBUG-FUN has no lambda list information cached. It
1340 ;;; returns the lambda list as the first value and whether there was
1341 ;;; any argument information as the second value. Therefore,
1342 ;;; (VALUES NIL T) means there were no arguments, but (VALUES NIL NIL)
1343 ;;; means there was no argument information.
1344 (defun parse-compiled-debug-fun-lambda-list (debug-fun)
1345   (let ((args (sb!c::compiled-debug-fun-arguments
1346                (compiled-debug-fun-compiler-debug-fun debug-fun))))
1347     (cond
1348      ((not args)
1349       (values nil nil))
1350      ((eq args :minimal)
1351       (values (coerce (debug-fun-debug-vars debug-fun) 'list)
1352               t))
1353      (t
1354       (let ((vars (debug-fun-debug-vars debug-fun))
1355             (i 0)
1356             (len (length args))
1357             (res nil)
1358             (optionalp nil))
1359         (declare (type (or null simple-vector) vars))
1360         (loop
1361           (when (>= i len) (return))
1362           (let ((ele (aref args i)))
1363             (cond
1364              ((symbolp ele)
1365               (case ele
1366                 (sb!c::deleted
1367                  ;; Deleted required arg at beginning of args array.
1368                  (push :deleted res))
1369                 (sb!c::optional-args
1370                  (setf optionalp t))
1371                 (sb!c::supplied-p
1372                  ;; SUPPLIED-P var immediately following keyword or
1373                  ;; optional. Stick the extra var in the result
1374                  ;; element representing the keyword or optional,
1375                  ;; which is the previous one.
1376                  (nconc (car res)
1377                         (list (compiled-debug-fun-lambda-list-var
1378                                args (incf i) vars))))
1379                 (sb!c::rest-arg
1380                  (push (list :rest
1381                              (compiled-debug-fun-lambda-list-var
1382                               args (incf i) vars))
1383                        res))
1384                 (sb!c::more-arg
1385                  ;; Just ignore the fact that the next two args are
1386                  ;; the &MORE arg context and count, and act like they
1387                  ;; are regular arguments.
1388                  nil)
1389                 (t
1390                  ;; &KEY arg
1391                  (push (list :keyword
1392                              ele
1393                              (compiled-debug-fun-lambda-list-var
1394                               args (incf i) vars))
1395                        res))))
1396              (optionalp
1397               ;; We saw an optional marker, so the following
1398               ;; non-symbols are indexes indicating optional
1399               ;; variables.
1400               (push (list :optional (svref vars ele)) res))
1401              (t
1402               ;; Required arg at beginning of args array.
1403               (push (svref vars ele) res))))
1404           (incf i))
1405         (values (nreverse res) t))))))
1406
1407 ;;; This is used in COMPILED-DEBUG-FUN-LAMBDA-LIST.
1408 (defun compiled-debug-fun-lambda-list-var (args i vars)
1409   (declare (type (simple-array * (*)) args)
1410            (simple-vector vars))
1411   (let ((ele (aref args i)))
1412     (cond ((not (symbolp ele)) (svref vars ele))
1413           ((eq ele 'sb!c::deleted) :deleted)
1414           (t (error "malformed arguments description")))))
1415
1416 (defun compiled-debug-fun-debug-info (debug-fun)
1417   (%code-debug-info (compiled-debug-fun-component debug-fun)))
1418 \f
1419 ;;;; unpacking variable and basic block data
1420
1421 (defvar *parsing-buffer*
1422   (make-array 20 :adjustable t :fill-pointer t))
1423 (defvar *other-parsing-buffer*
1424   (make-array 20 :adjustable t :fill-pointer t))
1425 ;;; PARSE-DEBUG-BLOCKS and PARSE-DEBUG-VARS
1426 ;;; use this to unpack binary encoded information. It returns the
1427 ;;; values returned by the last form in body.
1428 ;;;
1429 ;;; This binds buffer-var to *parsing-buffer*, makes sure it starts at
1430 ;;; element zero, and makes sure if we unwind, we nil out any set
1431 ;;; elements for GC purposes.
1432 ;;;
1433 ;;; This also binds other-var to *other-parsing-buffer* when it is
1434 ;;; supplied, making sure it starts at element zero and that we nil
1435 ;;; out any elements if we unwind.
1436 ;;;
1437 ;;; This defines the local macro RESULT that takes a buffer, copies
1438 ;;; its elements to a resulting simple-vector, nil's out elements, and
1439 ;;; restarts the buffer at element zero. RESULT returns the
1440 ;;; simple-vector.
1441 (eval-when (:compile-toplevel :execute)
1442 (sb!xc:defmacro with-parsing-buffer ((buffer-var &optional other-var)
1443                                      &body body)
1444   (let ((len (gensym))
1445         (res (gensym)))
1446     `(unwind-protect
1447          (let ((,buffer-var *parsing-buffer*)
1448                ,@(if other-var `((,other-var *other-parsing-buffer*))))
1449            (setf (fill-pointer ,buffer-var) 0)
1450            ,@(if other-var `((setf (fill-pointer ,other-var) 0)))
1451            (macrolet ((result (buf)
1452                         `(let* ((,',len (length ,buf))
1453                                 (,',res (make-array ,',len)))
1454                            (replace ,',res ,buf :end1 ,',len :end2 ,',len)
1455                            (fill ,buf nil :end ,',len)
1456                            (setf (fill-pointer ,buf) 0)
1457                            ,',res)))
1458              ,@body))
1459      (fill *parsing-buffer* nil)
1460      ,@(if other-var `((fill *other-parsing-buffer* nil))))))
1461 ) ; EVAL-WHEN
1462
1463 ;;; The argument is a debug internals structure. This returns the
1464 ;;; DEBUG-BLOCKs for DEBUG-FUN, regardless of whether we have unpacked
1465 ;;; them yet. It signals a NO-DEBUG-BLOCKS condition if it can't
1466 ;;; return the blocks.
1467 (defun debug-fun-debug-blocks (debug-fun)
1468   (let ((blocks (debug-fun-blocks debug-fun)))
1469     (cond ((eq blocks :unparsed)
1470            (setf (debug-fun-blocks debug-fun)
1471                  (parse-debug-blocks debug-fun))
1472            (unless (debug-fun-blocks debug-fun)
1473              (debug-signal 'no-debug-blocks
1474                            :debug-fun debug-fun))
1475            (debug-fun-blocks debug-fun))
1476           (blocks)
1477           (t
1478            (debug-signal 'no-debug-blocks
1479                          :debug-fun debug-fun)))))
1480
1481 ;;; Return a SIMPLE-VECTOR of DEBUG-BLOCKs or NIL. NIL indicates there
1482 ;;; was no basic block information.
1483 (defun parse-debug-blocks (debug-fun)
1484   (etypecase debug-fun
1485     (compiled-debug-fun
1486      (parse-compiled-debug-blocks debug-fun))
1487     (bogus-debug-fun
1488      (debug-signal 'no-debug-blocks :debug-fun debug-fun))))
1489
1490 ;;; This does some of the work of PARSE-DEBUG-BLOCKS.
1491 (defun parse-compiled-debug-blocks (debug-fun)
1492   (let* ((var-count (length (debug-fun-debug-vars debug-fun)))
1493          (compiler-debug-fun (compiled-debug-fun-compiler-debug-fun
1494                               debug-fun))
1495          (blocks (sb!c::compiled-debug-fun-blocks compiler-debug-fun))
1496          ;; KLUDGE: 8 is a hard-wired constant in the compiler for the
1497          ;; element size of the packed binary representation of the
1498          ;; blocks data.
1499          (live-set-len (ceiling var-count 8))
1500          (tlf-number (sb!c::compiled-debug-fun-tlf-number compiler-debug-fun)))
1501     (unless blocks
1502       (return-from parse-compiled-debug-blocks nil))
1503     (macrolet ((aref+ (a i) `(prog1 (aref ,a ,i) (incf ,i))))
1504       (with-parsing-buffer (blocks-buffer locations-buffer)
1505         (let ((i 0)
1506               (len (length blocks))
1507               (last-pc 0))
1508           (loop
1509             (when (>= i len) (return))
1510             (let ((succ-and-flags (aref+ blocks i))
1511                   (successors nil))
1512               (declare (type (unsigned-byte 8) succ-and-flags)
1513                        (list successors))
1514               (dotimes (k (ldb sb!c::compiled-debug-block-nsucc-byte
1515                                succ-and-flags))
1516                 (push (sb!c::read-var-integer blocks i) successors))
1517               (let* ((locations
1518                       (dotimes (k (sb!c::read-var-integer blocks i)
1519                                   (result locations-buffer))
1520                         (let ((kind (svref sb!c::*compiled-code-location-kinds*
1521                                            (aref+ blocks i)))
1522                               (pc (+ last-pc
1523                                      (sb!c::read-var-integer blocks i)))
1524                               (tlf-offset (or tlf-number
1525                                               (sb!c::read-var-integer blocks
1526                                                                       i)))
1527                               (form-number (sb!c::read-var-integer blocks i))
1528                               (live-set (sb!c::read-packed-bit-vector
1529                                          live-set-len blocks i)))
1530                           (vector-push-extend (make-known-code-location
1531                                                pc debug-fun tlf-offset
1532                                                form-number live-set kind)
1533                                               locations-buffer)
1534                           (setf last-pc pc))))
1535                      (block (make-compiled-debug-block
1536                              locations successors
1537                              (not (zerop (logand
1538                                           sb!c::compiled-debug-block-elsewhere-p
1539                                           succ-and-flags))))))
1540                 (vector-push-extend block blocks-buffer)
1541                 (dotimes (k (length locations))
1542                   (setf (code-location-%debug-block (svref locations k))
1543                         block))))))
1544         (let ((res (result blocks-buffer)))
1545           (declare (simple-vector res))
1546           (dotimes (i (length res))
1547             (let* ((block (svref res i))
1548                    (succs nil))
1549               (dolist (ele (debug-block-successors block))
1550                 (push (svref res ele) succs))
1551               (setf (debug-block-successors block) succs)))
1552           res)))))
1553
1554 ;;; The argument is a debug internals structure. This returns NIL if
1555 ;;; there is no variable information. It returns an empty
1556 ;;; simple-vector if there were no locals in the function. Otherwise
1557 ;;; it returns a SIMPLE-VECTOR of DEBUG-VARs.
1558 (defun debug-fun-debug-vars (debug-fun)
1559   (let ((vars (debug-fun-%debug-vars debug-fun)))
1560     (if (eq vars :unparsed)
1561         (setf (debug-fun-%debug-vars debug-fun)
1562               (etypecase debug-fun
1563                 (compiled-debug-fun
1564                  (parse-compiled-debug-vars debug-fun))
1565                 (bogus-debug-fun nil)))
1566         vars)))
1567
1568 ;;; VARS is the parsed variables for a minimal debug function. We need
1569 ;;; to assign names of the form ARG-NNN. We must pad with leading
1570 ;;; zeros, since the arguments must be in alphabetical order.
1571 (defun assign-minimal-var-names (vars)
1572   (declare (simple-vector vars))
1573   (let* ((len (length vars))
1574          (width (length (format nil "~W" (1- len)))))
1575     (dotimes (i len)
1576       (setf (compiled-debug-var-symbol (svref vars i))
1577             (intern (format nil "ARG-~V,'0D" width i)
1578                     ;; KLUDGE: It's somewhat nasty to have a bare
1579                     ;; package name string here. It would be
1580                     ;; nicer to have #.(FIND-PACKAGE "SB!DEBUG")
1581                     ;; instead, since then at least it would transform
1582                     ;; correctly under package renaming and stuff.
1583                     ;; However, genesis can't handle dumped packages..
1584                     ;; -- WHN 20000129
1585                     ;;
1586                     ;; FIXME: Maybe this could be fixed by moving the
1587                     ;; whole debug-int.lisp file to warm init? (after
1588                     ;; which dumping a #.(FIND-PACKAGE ..) expression
1589                     ;; would work fine) If this is possible, it would
1590                     ;; probably be a good thing, since minimizing the
1591                     ;; amount of stuff in cold init is basically good.
1592                     (or (find-package "SB-DEBUG")
1593                         (find-package "SB!DEBUG")))))))
1594
1595 ;;; Parse the packed representation of DEBUG-VARs from
1596 ;;; DEBUG-FUN's SB!C::COMPILED-DEBUG-FUN, returning a vector
1597 ;;; of DEBUG-VARs, or NIL if there was no information to parse.
1598 (defun parse-compiled-debug-vars (debug-fun)
1599   (let* ((cdebug-fun (compiled-debug-fun-compiler-debug-fun
1600                       debug-fun))
1601          (packed-vars (sb!c::compiled-debug-fun-vars cdebug-fun))
1602          (args-minimal (eq (sb!c::compiled-debug-fun-arguments cdebug-fun)
1603                            :minimal)))
1604     (when packed-vars
1605       (do ((i 0)
1606            (buffer (make-array 0 :fill-pointer 0 :adjustable t)))
1607           ((>= i (length packed-vars))
1608            (let ((result (coerce buffer 'simple-vector)))
1609              (when args-minimal
1610                (assign-minimal-var-names result))
1611              result))
1612         (flet ((geti () (prog1 (aref packed-vars i) (incf i))))
1613           (let* ((flags (geti))
1614                  (minimal (logtest sb!c::compiled-debug-var-minimal-p flags))
1615                  (deleted (logtest sb!c::compiled-debug-var-deleted-p flags))
1616                  (live (logtest sb!c::compiled-debug-var-environment-live
1617                                 flags))
1618                  (save (logtest sb!c::compiled-debug-var-save-loc-p flags))
1619                  (symbol (if minimal nil (geti)))
1620                  (id (if (logtest sb!c::compiled-debug-var-id-p flags)
1621                          (geti)
1622                          0))
1623                  (sc-offset (if deleted 0 (geti)))
1624                  (save-sc-offset (if save (geti) nil)))
1625             (aver (not (and args-minimal (not minimal))))
1626             (vector-push-extend (make-compiled-debug-var symbol
1627                                                          id
1628                                                          live
1629                                                          sc-offset
1630                                                          save-sc-offset)
1631                                 buffer)))))))
1632 \f
1633 ;;;; CODE-LOCATIONs
1634
1635 ;;; If we're sure of whether code-location is known, return T or NIL.
1636 ;;; If we're :UNSURE, then try to fill in the code-location's slots.
1637 ;;; This determines whether there is any debug-block information, and
1638 ;;; if code-location is known.
1639 ;;;
1640 ;;; ??? IF this conses closures every time it's called, then break off the
1641 ;;; :UNSURE part to get the HANDLER-CASE into another function.
1642 (defun code-location-unknown-p (basic-code-location)
1643   (ecase (code-location-%unknown-p basic-code-location)
1644     ((t) t)
1645     ((nil) nil)
1646     (:unsure
1647      (setf (code-location-%unknown-p basic-code-location)
1648            (handler-case (not (fill-in-code-location basic-code-location))
1649              (no-debug-blocks () t))))))
1650
1651 ;;; Return the DEBUG-BLOCK containing code-location if it is available.
1652 ;;; Some debug policies inhibit debug-block information, and if none
1653 ;;; is available, then this signals a NO-DEBUG-BLOCKS condition.
1654 (defun code-location-debug-block (basic-code-location)
1655   (let ((block (code-location-%debug-block basic-code-location)))
1656     (if (eq block :unparsed)
1657         (etypecase basic-code-location
1658           (compiled-code-location
1659            (compute-compiled-code-location-debug-block basic-code-location))
1660           ;; (There used to be more cases back before sbcl-0.7.0, when
1661           ;; we did special tricks to debug the IR1 interpreter.)
1662           )
1663         block)))
1664
1665 ;;; Store and return BASIC-CODE-LOCATION's debug-block. We determines
1666 ;;; the correct one using the code-location's pc. We use
1667 ;;; DEBUG-FUN-DEBUG-BLOCKS to return the cached block information
1668 ;;; or signal a NO-DEBUG-BLOCKS condition. The blocks are sorted by
1669 ;;; their first code-location's pc, in ascending order. Therefore, as
1670 ;;; soon as we find a block that starts with a pc greater than
1671 ;;; basic-code-location's pc, we know the previous block contains the
1672 ;;; pc. If we get to the last block, then the code-location is either
1673 ;;; in the second to last block or the last block, and we have to be
1674 ;;; careful in determining this since the last block could be code at
1675 ;;; the end of the function. We have to check for the last block being
1676 ;;; code first in order to see how to compare the code-location's pc.
1677 (defun compute-compiled-code-location-debug-block (basic-code-location)
1678   (let* ((pc (compiled-code-location-pc basic-code-location))
1679          (debug-fun (code-location-debug-fun
1680                           basic-code-location))
1681          (blocks (debug-fun-debug-blocks debug-fun))
1682          (len (length blocks)))
1683     (declare (simple-vector blocks))
1684     (setf (code-location-%debug-block basic-code-location)
1685           (if (= len 1)
1686               (svref blocks 0)
1687               (do ((i 1 (1+ i))
1688                    (end (1- len)))
1689                   ((= i end)
1690                    (let ((last (svref blocks end)))
1691                      (cond
1692                       ((debug-block-elsewhere-p last)
1693                        (if (< pc
1694                               (sb!c::compiled-debug-fun-elsewhere-pc
1695                                (compiled-debug-fun-compiler-debug-fun
1696                                 debug-fun)))
1697                            (svref blocks (1- end))
1698                            last))
1699                       ((< pc
1700                           (compiled-code-location-pc
1701                            (svref (compiled-debug-block-code-locations last)
1702                                   0)))
1703                        (svref blocks (1- end)))
1704                       (t last))))
1705                 (declare (type index i end))
1706                 (when (< pc
1707                          (compiled-code-location-pc
1708                           (svref (compiled-debug-block-code-locations
1709                                   (svref blocks i))
1710                                  0)))
1711                   (return (svref blocks (1- i)))))))))
1712
1713 ;;; Return the CODE-LOCATION's DEBUG-SOURCE.
1714 (defun code-location-debug-source (code-location)
1715   (etypecase code-location
1716     (compiled-code-location
1717      (let* ((info (compiled-debug-fun-debug-info
1718                    (code-location-debug-fun code-location)))
1719             (sources (sb!c::compiled-debug-info-source info))
1720             (len (length sources)))
1721        (declare (list sources))
1722        (when (zerop len)
1723          (debug-signal 'no-debug-blocks :debug-fun
1724                        (code-location-debug-fun code-location)))
1725        (if (= len 1)
1726            (car sources)
1727            (do ((prev sources src)
1728                 (src (cdr sources) (cdr src))
1729                 (offset (code-location-toplevel-form-offset code-location)))
1730                ((null src) (car prev))
1731              (when (< offset (sb!c::debug-source-source-root (car src)))
1732                (return (car prev)))))))
1733     ;; (There used to be more cases back before sbcl-0.7.0, when we
1734     ;; did special tricks to debug the IR1 interpreter.)
1735     ))
1736
1737 ;;; Returns the number of top level forms before the one containing
1738 ;;; CODE-LOCATION as seen by the compiler in some compilation unit. (A
1739 ;;; compilation unit is not necessarily a single file, see the section
1740 ;;; on debug-sources.)
1741 (defun code-location-toplevel-form-offset (code-location)
1742   (when (code-location-unknown-p code-location)
1743     (error 'unknown-code-location :code-location code-location))
1744   (let ((tlf-offset (code-location-%tlf-offset code-location)))
1745     (cond ((eq tlf-offset :unparsed)
1746            (etypecase code-location
1747              (compiled-code-location
1748               (unless (fill-in-code-location code-location)
1749                 ;; This check should be unnecessary. We're missing
1750                 ;; debug info the compiler should have dumped.
1751                 (bug "unknown code location"))
1752               (code-location-%tlf-offset code-location))
1753              ;; (There used to be more cases back before sbcl-0.7.0,,
1754              ;; when we did special tricks to debug the IR1
1755              ;; interpreter.)
1756              ))
1757           (t tlf-offset))))
1758
1759 ;;; Return the number of the form corresponding to CODE-LOCATION. The
1760 ;;; form number is derived by a walking the subforms of a top level
1761 ;;; form in depth-first order.
1762 (defun code-location-form-number (code-location)
1763   (when (code-location-unknown-p code-location)
1764     (error 'unknown-code-location :code-location code-location))
1765   (let ((form-num (code-location-%form-number code-location)))
1766     (cond ((eq form-num :unparsed)
1767            (etypecase code-location
1768              (compiled-code-location
1769               (unless (fill-in-code-location code-location)
1770                 ;; This check should be unnecessary. We're missing
1771                 ;; debug info the compiler should have dumped.
1772                 (bug "unknown code location"))
1773               (code-location-%form-number code-location))
1774              ;; (There used to be more cases back before sbcl-0.7.0,,
1775              ;; when we did special tricks to debug the IR1
1776              ;; interpreter.)
1777              ))
1778           (t form-num))))
1779
1780 ;;; Return the kind of CODE-LOCATION, one of:
1781 ;;;  :INTERPRETED, :UNKNOWN-RETURN, :KNOWN-RETURN, :INTERNAL-ERROR,
1782 ;;;  :NON-LOCAL-EXIT, :BLOCK-START, :CALL-SITE, :SINGLE-VALUE-RETURN,
1783 ;;;  :NON-LOCAL-ENTRY
1784 (defun code-location-kind (code-location)
1785   (when (code-location-unknown-p code-location)
1786     (error 'unknown-code-location :code-location code-location))
1787   (etypecase code-location
1788     (compiled-code-location
1789      (let ((kind (compiled-code-location-kind code-location)))
1790        (cond ((not (eq kind :unparsed)) kind)
1791              ((not (fill-in-code-location code-location))
1792               ;; This check should be unnecessary. We're missing
1793               ;; debug info the compiler should have dumped.
1794               (bug "unknown code location"))
1795              (t
1796               (compiled-code-location-kind code-location)))))
1797     ;; (There used to be more cases back before sbcl-0.7.0,,
1798     ;; when we did special tricks to debug the IR1
1799     ;; interpreter.)
1800     ))
1801
1802 ;;; This returns CODE-LOCATION's live-set if it is available. If
1803 ;;; there is no debug-block information, this returns NIL.
1804 (defun compiled-code-location-live-set (code-location)
1805   (if (code-location-unknown-p code-location)
1806       nil
1807       (let ((live-set (compiled-code-location-%live-set code-location)))
1808         (cond ((eq live-set :unparsed)
1809                (unless (fill-in-code-location code-location)
1810                  ;; This check should be unnecessary. We're missing
1811                  ;; debug info the compiler should have dumped.
1812                  ;;
1813                  ;; FIXME: This error and comment happen over and over again.
1814                  ;; Make them a shared function.
1815                  (bug "unknown code location"))
1816                (compiled-code-location-%live-set code-location))
1817               (t live-set)))))
1818
1819 ;;; true if OBJ1 and OBJ2 are the same place in the code
1820 (defun code-location= (obj1 obj2)
1821   (etypecase obj1
1822     (compiled-code-location
1823      (etypecase obj2
1824        (compiled-code-location
1825         (and (eq (code-location-debug-fun obj1)
1826                  (code-location-debug-fun obj2))
1827              (sub-compiled-code-location= obj1 obj2)))
1828        ;; (There used to be more cases back before sbcl-0.7.0,,
1829        ;; when we did special tricks to debug the IR1
1830        ;; interpreter.)
1831        ))
1832     ;; (There used to be more cases back before sbcl-0.7.0,,
1833     ;; when we did special tricks to debug IR1-interpreted code.)
1834     ))
1835 (defun sub-compiled-code-location= (obj1 obj2)
1836   (= (compiled-code-location-pc obj1)
1837      (compiled-code-location-pc obj2)))
1838
1839 ;;; Fill in CODE-LOCATION's :UNPARSED slots, returning T or NIL
1840 ;;; depending on whether the code-location was known in its
1841 ;;; DEBUG-FUN's debug-block information. This may signal a
1842 ;;; NO-DEBUG-BLOCKS condition due to DEBUG-FUN-DEBUG-BLOCKS, and
1843 ;;; it assumes the %UNKNOWN-P slot is already set or going to be set.
1844 (defun fill-in-code-location (code-location)
1845   (declare (type compiled-code-location code-location))
1846   (let* ((debug-fun (code-location-debug-fun code-location))
1847          (blocks (debug-fun-debug-blocks debug-fun)))
1848     (declare (simple-vector blocks))
1849     (dotimes (i (length blocks) nil)
1850       (let* ((block (svref blocks i))
1851              (locations (compiled-debug-block-code-locations block)))
1852         (declare (simple-vector locations))
1853         (dotimes (j (length locations))
1854           (let ((loc (svref locations j)))
1855             (when (sub-compiled-code-location= code-location loc)
1856               (setf (code-location-%debug-block code-location) block)
1857               (setf (code-location-%tlf-offset code-location)
1858                     (code-location-%tlf-offset loc))
1859               (setf (code-location-%form-number code-location)
1860                     (code-location-%form-number loc))
1861               (setf (compiled-code-location-%live-set code-location)
1862                     (compiled-code-location-%live-set loc))
1863               (setf (compiled-code-location-kind code-location)
1864                     (compiled-code-location-kind loc))
1865               (return-from fill-in-code-location t))))))))
1866 \f
1867 ;;;; operations on DEBUG-BLOCKs
1868
1869 ;;; Execute FORMS in a context with CODE-VAR bound to each
1870 ;;; CODE-LOCATION in DEBUG-BLOCK, and return the value of RESULT.
1871 (defmacro do-debug-block-locations ((code-var debug-block &optional result)
1872                                     &body body)
1873   (let ((code-locations (gensym))
1874         (i (gensym)))
1875     `(let ((,code-locations (debug-block-code-locations ,debug-block)))
1876        (declare (simple-vector ,code-locations))
1877        (dotimes (,i (length ,code-locations) ,result)
1878          (let ((,code-var (svref ,code-locations ,i)))
1879            ,@body)))))
1880
1881 ;;; Return the name of the function represented by DEBUG-FUN.
1882 ;;; This may be a string or a cons; do not assume it is a symbol.
1883 (defun debug-block-fun-name (debug-block)
1884   (etypecase debug-block
1885     (compiled-debug-block
1886      (let ((code-locs (compiled-debug-block-code-locations debug-block)))
1887        (declare (simple-vector code-locs))
1888        (if (zerop (length code-locs))
1889            "??? Can't get name of debug-block's function."
1890            (debug-fun-name
1891             (code-location-debug-fun (svref code-locs 0))))))
1892     ;; (There used to be more cases back before sbcl-0.7.0, when we
1893     ;; did special tricks to debug the IR1 interpreter.)
1894     ))
1895
1896 (defun debug-block-code-locations (debug-block)
1897   (etypecase debug-block
1898     (compiled-debug-block
1899      (compiled-debug-block-code-locations debug-block))
1900     ;; (There used to be more cases back before sbcl-0.7.0, when we
1901     ;; did special tricks to debug the IR1 interpreter.)
1902     ))
1903 \f
1904 ;;;; operations on debug variables
1905
1906 (defun debug-var-symbol-name (debug-var)
1907   (symbol-name (debug-var-symbol debug-var)))
1908
1909 ;;; FIXME: Make sure that this isn't called anywhere that it wouldn't
1910 ;;; be acceptable to have NIL returned, or that it's only called on
1911 ;;; DEBUG-VARs whose symbols have non-NIL packages.
1912 (defun debug-var-package-name (debug-var)
1913   (package-name (symbol-package (debug-var-symbol debug-var))))
1914
1915 ;;; Return the value stored for DEBUG-VAR in frame, or if the value is
1916 ;;; not :VALID, then signal an INVALID-VALUE error.
1917 (defun debug-var-valid-value (debug-var frame)
1918   (unless (eq (debug-var-validity debug-var (frame-code-location frame))
1919               :valid)
1920     (error 'invalid-value :debug-var debug-var :frame frame))
1921   (debug-var-value debug-var frame))
1922
1923 ;;; Returns the value stored for DEBUG-VAR in frame. The value may be
1924 ;;; invalid. This is SETFable.
1925 (defun debug-var-value (debug-var frame)
1926   (aver (typep frame 'compiled-frame))
1927   (let ((res (access-compiled-debug-var-slot debug-var frame)))
1928     (if (indirect-value-cell-p res)
1929         (value-cell-ref res)
1930         res)))
1931
1932 ;;; This returns what is stored for the variable represented by
1933 ;;; DEBUG-VAR relative to the FRAME. This may be an indirect value
1934 ;;; cell if the variable is both closed over and set.
1935 (defun access-compiled-debug-var-slot (debug-var frame)
1936   (declare (optimize (speed 1)))
1937   (let ((escaped (compiled-frame-escaped frame)))
1938     (if escaped
1939         (sub-access-debug-var-slot
1940          (frame-pointer frame)
1941          (compiled-debug-var-sc-offset debug-var)
1942          escaped)
1943       (sub-access-debug-var-slot
1944        (frame-pointer frame)
1945        (or (compiled-debug-var-save-sc-offset debug-var)
1946            (compiled-debug-var-sc-offset debug-var))))))
1947
1948 ;;; a helper function for working with possibly-invalid values:
1949 ;;; Do (MAKE-LISP-OBJ VAL) only if the value looks valid.
1950 ;;;
1951 ;;; (Such values can arise in registers on machines with conservative
1952 ;;; GC, and might also arise in debug variable locations when
1953 ;;; those variables are invalid.)
1954 (defun make-valid-lisp-obj (val)
1955   (if (or
1956        ;; fixnum
1957        (zerop (logand val 3))
1958        ;; character
1959        (and (zerop (logand val #xffff0000)) ; Top bits zero
1960             (= (logand val #xff) sb!vm:base-char-widetag)) ; char tag
1961        ;; unbound marker
1962        (= val sb!vm:unbound-marker-widetag)
1963        ;; pointer
1964        (and (logand val 1)
1965             ;; Check that the pointer is valid. XXX Could do a better
1966             ;; job. FIXME: e.g. by calling out to an is_valid_pointer
1967             ;; routine in the C runtime support code
1968             (or (< sb!vm:read-only-space-start val
1969                    (* sb!vm:*read-only-space-free-pointer*
1970                       sb!vm:n-word-bytes))
1971                 (< sb!vm:static-space-start val
1972                    (* sb!vm:*static-space-free-pointer*
1973                       sb!vm:n-word-bytes))
1974                 (< sb!vm:dynamic-space-start val
1975                    (sap-int (dynamic-space-free-pointer))))))
1976       (make-lisp-obj val)
1977       :invalid-object))
1978
1979 #!-x86
1980 (defun sub-access-debug-var-slot (fp sc-offset &optional escaped)
1981   (macrolet ((with-escaped-value ((var) &body forms)
1982                `(if escaped
1983                     (let ((,var (sb!vm:context-register
1984                                  escaped
1985                                  (sb!c:sc-offset-offset sc-offset))))
1986                       ,@forms)
1987                     :invalid-value-for-unescaped-register-storage))
1988              (escaped-float-value (format)
1989                `(if escaped
1990                     (sb!vm:context-float-register
1991                      escaped
1992                      (sb!c:sc-offset-offset sc-offset)
1993                      ',format)
1994                     :invalid-value-for-unescaped-register-storage))
1995              (with-nfp ((var) &body body)
1996                `(let ((,var (if escaped
1997                                 (sb!sys:int-sap
1998                                  (sb!vm:context-register escaped
1999                                                          sb!vm::nfp-offset))
2000                                 #!-alpha
2001                                 (sb!sys:sap-ref-sap fp (* nfp-save-offset
2002                                                           sb!vm:n-word-bytes))
2003                                 #!+alpha
2004                                 (sb!vm::make-number-stack-pointer
2005                                  (sb!sys:sap-ref-32 fp (* nfp-save-offset
2006                                                           sb!vm:n-word-bytes))))))
2007                   ,@body)))
2008     (ecase (sb!c:sc-offset-scn sc-offset)
2009       ((#.sb!vm:any-reg-sc-number
2010         #.sb!vm:descriptor-reg-sc-number
2011         #!+rt #.sb!vm:word-pointer-reg-sc-number)
2012        (sb!sys:without-gcing
2013         (with-escaped-value (val) (sb!kernel:make-lisp-obj val))))
2014                             
2015       (#.sb!vm:base-char-reg-sc-number
2016        (with-escaped-value (val)
2017          (code-char val)))
2018       (#.sb!vm:sap-reg-sc-number
2019        (with-escaped-value (val)
2020          (sb!sys:int-sap val)))
2021       (#.sb!vm:signed-reg-sc-number
2022        (with-escaped-value (val)
2023          (if (logbitp (1- sb!vm:n-word-bits) val)
2024              (logior val (ash -1 sb!vm:n-word-bits))
2025              val)))
2026       (#.sb!vm:unsigned-reg-sc-number
2027        (with-escaped-value (val)
2028          val))
2029       (#.sb!vm:non-descriptor-reg-sc-number
2030        (error "Local non-descriptor register access?"))
2031       (#.sb!vm:interior-reg-sc-number
2032        (error "Local interior register access?"))
2033       (#.sb!vm:single-reg-sc-number
2034        (escaped-float-value single-float))
2035       (#.sb!vm:double-reg-sc-number
2036        (escaped-float-value double-float))
2037       #!+long-float
2038       (#.sb!vm:long-reg-sc-number
2039        (escaped-float-value long-float))
2040       (#.sb!vm:complex-single-reg-sc-number
2041        (if escaped
2042            (complex
2043             (sb!vm:context-float-register
2044              escaped (sb!c:sc-offset-offset sc-offset) 'single-float)
2045             (sb!vm:context-float-register
2046              escaped (1+ (sb!c:sc-offset-offset sc-offset)) 'single-float))
2047            :invalid-value-for-unescaped-register-storage))
2048       (#.sb!vm:complex-double-reg-sc-number
2049        (if escaped
2050            (complex
2051             (sb!vm:context-float-register
2052              escaped (sb!c:sc-offset-offset sc-offset) 'double-float)
2053             (sb!vm:context-float-register
2054              escaped (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 2 #!-sparc 1)
2055              'double-float))
2056            :invalid-value-for-unescaped-register-storage))
2057       #!+long-float
2058       (#.sb!vm:complex-long-reg-sc-number
2059        (if escaped
2060            (complex
2061             (sb!vm:context-float-register
2062              escaped (sb!c:sc-offset-offset sc-offset) 'long-float)
2063             (sb!vm:context-float-register
2064              escaped (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 4)
2065              'long-float))
2066            :invalid-value-for-unescaped-register-storage))
2067       (#.sb!vm:single-stack-sc-number
2068        (with-nfp (nfp)
2069          (sb!sys:sap-ref-single nfp (* (sb!c:sc-offset-offset sc-offset)
2070                                        sb!vm:n-word-bytes))))
2071       (#.sb!vm:double-stack-sc-number
2072        (with-nfp (nfp)
2073          (sb!sys:sap-ref-double nfp (* (sb!c:sc-offset-offset sc-offset)
2074                                        sb!vm:n-word-bytes))))
2075       #!+long-float
2076       (#.sb!vm:long-stack-sc-number
2077        (with-nfp (nfp)
2078          (sb!sys:sap-ref-long nfp (* (sb!c:sc-offset-offset sc-offset)
2079                                      sb!vm:n-word-bytes))))
2080       (#.sb!vm:complex-single-stack-sc-number
2081        (with-nfp (nfp)
2082          (complex
2083           (sb!sys:sap-ref-single nfp (* (sb!c:sc-offset-offset sc-offset)
2084                                         sb!vm:n-word-bytes))
2085           (sb!sys:sap-ref-single nfp (* (1+ (sb!c:sc-offset-offset sc-offset))
2086                                         sb!vm:n-word-bytes)))))
2087       (#.sb!vm:complex-double-stack-sc-number
2088        (with-nfp (nfp)
2089          (complex
2090           (sb!sys:sap-ref-double nfp (* (sb!c:sc-offset-offset sc-offset)
2091                                         sb!vm:n-word-bytes))
2092           (sb!sys:sap-ref-double nfp (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2093                                         sb!vm:n-word-bytes)))))
2094       #!+long-float
2095       (#.sb!vm:complex-long-stack-sc-number
2096        (with-nfp (nfp)
2097          (complex
2098           (sb!sys:sap-ref-long nfp (* (sb!c:sc-offset-offset sc-offset)
2099                                       sb!vm:n-word-bytes))
2100           (sb!sys:sap-ref-long nfp (* (+ (sb!c:sc-offset-offset sc-offset)
2101                                          #!+sparc 4)
2102                                       sb!vm:n-word-bytes)))))
2103       (#.sb!vm:control-stack-sc-number
2104        (sb!kernel:stack-ref fp (sb!c:sc-offset-offset sc-offset)))
2105       (#.sb!vm:base-char-stack-sc-number
2106        (with-nfp (nfp)
2107          (code-char (sb!sys:sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2108                                               sb!vm:n-word-bytes)))))
2109       (#.sb!vm:unsigned-stack-sc-number
2110        (with-nfp (nfp)
2111          (sb!sys:sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2112                                    sb!vm:n-word-bytes))))
2113       (#.sb!vm:signed-stack-sc-number
2114        (with-nfp (nfp)
2115          (sb!sys:signed-sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2116                                           sb!vm:n-word-bytes))))
2117       (#.sb!vm:sap-stack-sc-number
2118        (with-nfp (nfp)
2119          (sb!sys:sap-ref-sap nfp (* (sb!c:sc-offset-offset sc-offset)
2120                                     sb!vm:n-word-bytes)))))))
2121
2122 #!+x86
2123 (defun sub-access-debug-var-slot (fp sc-offset &optional escaped)
2124   (declare (type system-area-pointer fp))
2125   (macrolet ((with-escaped-value ((var) &body forms)
2126                `(if escaped
2127                     (let ((,var (sb!vm:context-register
2128                                  escaped
2129                                  (sb!c:sc-offset-offset sc-offset))))
2130                       ,@forms)
2131                     :invalid-value-for-unescaped-register-storage))
2132              (escaped-float-value (format)
2133                `(if escaped
2134                     (sb!vm:context-float-register
2135                      escaped (sb!c:sc-offset-offset sc-offset) ',format)
2136                     :invalid-value-for-unescaped-register-storage))
2137              (escaped-complex-float-value (format)
2138                `(if escaped
2139                     (complex
2140                      (sb!vm:context-float-register
2141                       escaped (sb!c:sc-offset-offset sc-offset) ',format)
2142                      (sb!vm:context-float-register
2143                       escaped (1+ (sb!c:sc-offset-offset sc-offset)) ',format))
2144                     :invalid-value-for-unescaped-register-storage)))
2145     (ecase (sb!c:sc-offset-scn sc-offset)
2146       ((#.sb!vm:any-reg-sc-number #.sb!vm:descriptor-reg-sc-number)
2147        (without-gcing
2148         (with-escaped-value (val)
2149           (make-valid-lisp-obj val))))
2150       (#.sb!vm:base-char-reg-sc-number
2151        (with-escaped-value (val)
2152          (code-char val)))
2153       (#.sb!vm:sap-reg-sc-number
2154        (with-escaped-value (val)
2155          (int-sap val)))
2156       (#.sb!vm:signed-reg-sc-number
2157        (with-escaped-value (val)
2158          (if (logbitp (1- sb!vm:n-word-bits) val)
2159              (logior val (ash -1 sb!vm:n-word-bits))
2160              val)))
2161       (#.sb!vm:unsigned-reg-sc-number
2162        (with-escaped-value (val)
2163          val))
2164       (#.sb!vm:single-reg-sc-number
2165        (escaped-float-value single-float))
2166       (#.sb!vm:double-reg-sc-number
2167        (escaped-float-value double-float))
2168       #!+long-float
2169       (#.sb!vm:long-reg-sc-number
2170        (escaped-float-value long-float))
2171       (#.sb!vm:complex-single-reg-sc-number
2172        (escaped-complex-float-value single-float))
2173       (#.sb!vm:complex-double-reg-sc-number
2174        (escaped-complex-float-value double-float))
2175       #!+long-float
2176       (#.sb!vm:complex-long-reg-sc-number
2177        (escaped-complex-float-value long-float))
2178       (#.sb!vm:single-stack-sc-number
2179        (sap-ref-single fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2180                                 sb!vm:n-word-bytes))))
2181       (#.sb!vm:double-stack-sc-number
2182        (sap-ref-double fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2183                                 sb!vm:n-word-bytes))))
2184       #!+long-float
2185       (#.sb!vm:long-stack-sc-number
2186        (sap-ref-long fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2187                               sb!vm:n-word-bytes))))
2188       (#.sb!vm:complex-single-stack-sc-number
2189        (complex
2190         (sap-ref-single fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2191                                  sb!vm:n-word-bytes)))
2192         (sap-ref-single fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2193                                  sb!vm:n-word-bytes)))))
2194       (#.sb!vm:complex-double-stack-sc-number
2195        (complex
2196         (sap-ref-double fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2197                                  sb!vm:n-word-bytes)))
2198         (sap-ref-double fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 4)
2199                                  sb!vm:n-word-bytes)))))
2200       #!+long-float
2201       (#.sb!vm:complex-long-stack-sc-number
2202        (complex
2203         (sap-ref-long fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2204                                sb!vm:n-word-bytes)))
2205         (sap-ref-long fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 6)
2206                                sb!vm:n-word-bytes)))))
2207       (#.sb!vm:control-stack-sc-number
2208        (stack-ref fp (sb!c:sc-offset-offset sc-offset)))
2209       (#.sb!vm:base-char-stack-sc-number
2210        (code-char
2211         (sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2212                              sb!vm:n-word-bytes)))))
2213       (#.sb!vm:unsigned-stack-sc-number
2214        (sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2215                             sb!vm:n-word-bytes))))
2216       (#.sb!vm:signed-stack-sc-number
2217        (signed-sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2218                                    sb!vm:n-word-bytes))))
2219       (#.sb!vm:sap-stack-sc-number
2220        (sap-ref-sap fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2221                              sb!vm:n-word-bytes)))))))
2222
2223 ;;; This stores value as the value of DEBUG-VAR in FRAME. In the
2224 ;;; COMPILED-DEBUG-VAR case, access the current value to determine if
2225 ;;; it is an indirect value cell. This occurs when the variable is
2226 ;;; both closed over and set.
2227 (defun %set-debug-var-value (debug-var frame new-value)
2228   (aver (typep frame 'compiled-frame))
2229   (let ((old-value (access-compiled-debug-var-slot debug-var frame)))
2230     (if (indirect-value-cell-p old-value)
2231         (value-cell-set old-value new-value)
2232         (set-compiled-debug-var-slot debug-var frame new-value)))
2233   new-value)
2234
2235 ;;; This stores VALUE for the variable represented by debug-var
2236 ;;; relative to the frame. This assumes the location directly contains
2237 ;;; the variable's value; that is, there is no indirect value cell
2238 ;;; currently there in case the variable is both closed over and set.
2239 (defun set-compiled-debug-var-slot (debug-var frame value)
2240   (let ((escaped (compiled-frame-escaped frame)))
2241     (if escaped
2242         (sub-set-debug-var-slot (frame-pointer frame)
2243                                 (compiled-debug-var-sc-offset debug-var)
2244                                 value escaped)
2245         (sub-set-debug-var-slot
2246          (frame-pointer frame)
2247          (or (compiled-debug-var-save-sc-offset debug-var)
2248              (compiled-debug-var-sc-offset debug-var))
2249          value))))
2250
2251 #!-x86
2252 (defun sub-set-debug-var-slot (fp sc-offset value &optional escaped)
2253   (macrolet ((set-escaped-value (val)
2254                `(if escaped
2255                     (setf (sb!vm:context-register
2256                            escaped
2257                            (sb!c:sc-offset-offset sc-offset))
2258                           ,val)
2259                     value))
2260              (set-escaped-float-value (format val)
2261                `(if escaped
2262                     (setf (sb!vm:context-float-register
2263                            escaped
2264                            (sb!c:sc-offset-offset sc-offset)
2265                            ',format)
2266                           ,val)
2267                     value))
2268              (with-nfp ((var) &body body)
2269                `(let ((,var (if escaped
2270                                 (int-sap
2271                                  (sb!vm:context-register escaped
2272                                                          sb!vm::nfp-offset))
2273                                 #!-alpha
2274                                 (sap-ref-sap fp
2275                                              (* nfp-save-offset
2276                                                 sb!vm:n-word-bytes))
2277                                 #!+alpha
2278                                 (sb!vm::make-number-stack-pointer
2279                                  (sap-ref-32 fp
2280                                              (* nfp-save-offset
2281                                                 sb!vm:n-word-bytes))))))
2282                   ,@body)))
2283     (ecase (sb!c:sc-offset-scn sc-offset)
2284       ((#.sb!vm:any-reg-sc-number
2285         #.sb!vm:descriptor-reg-sc-number
2286         #!+rt #.sb!vm:word-pointer-reg-sc-number)
2287        (without-gcing
2288         (set-escaped-value
2289           (get-lisp-obj-address value))))
2290       (#.sb!vm:base-char-reg-sc-number
2291        (set-escaped-value (char-code value)))
2292       (#.sb!vm:sap-reg-sc-number
2293        (set-escaped-value (sap-int value)))
2294       (#.sb!vm:signed-reg-sc-number
2295        (set-escaped-value (logand value (1- (ash 1 sb!vm:n-word-bits)))))
2296       (#.sb!vm:unsigned-reg-sc-number
2297        (set-escaped-value value))
2298       (#.sb!vm:non-descriptor-reg-sc-number
2299        (error "Local non-descriptor register access?"))
2300       (#.sb!vm:interior-reg-sc-number
2301        (error "Local interior register access?"))
2302       (#.sb!vm:single-reg-sc-number
2303        (set-escaped-float-value single-float value))
2304       (#.sb!vm:double-reg-sc-number
2305        (set-escaped-float-value double-float value))
2306       #!+long-float
2307       (#.sb!vm:long-reg-sc-number
2308        (set-escaped-float-value long-float value))
2309       (#.sb!vm:complex-single-reg-sc-number
2310        (when escaped
2311          (setf (sb!vm:context-float-register escaped
2312                                              (sb!c:sc-offset-offset sc-offset)
2313                                              'single-float)
2314                (realpart value))
2315          (setf (sb!vm:context-float-register
2316                 escaped (1+ (sb!c:sc-offset-offset sc-offset))
2317                 'single-float)
2318                (imagpart value)))
2319        value)
2320       (#.sb!vm:complex-double-reg-sc-number
2321        (when escaped
2322          (setf (sb!vm:context-float-register
2323                 escaped (sb!c:sc-offset-offset sc-offset) 'double-float)
2324                (realpart value))
2325          (setf (sb!vm:context-float-register
2326                 escaped
2327                 (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 2 #!-sparc 1)
2328                 'double-float)
2329                (imagpart value)))
2330        value)
2331       #!+long-float
2332       (#.sb!vm:complex-long-reg-sc-number
2333        (when escaped
2334          (setf (sb!vm:context-float-register
2335                 escaped (sb!c:sc-offset-offset sc-offset) 'long-float)
2336                (realpart value))
2337          (setf (sb!vm:context-float-register
2338                 escaped
2339                 (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 4)
2340                 'long-float)
2341                (imagpart value)))
2342        value)
2343       (#.sb!vm:single-stack-sc-number
2344        (with-nfp (nfp)
2345          (setf (sap-ref-single nfp (* (sb!c:sc-offset-offset sc-offset)
2346                                       sb!vm:n-word-bytes))
2347                (the single-float value))))
2348       (#.sb!vm:double-stack-sc-number
2349        (with-nfp (nfp)
2350          (setf (sap-ref-double nfp (* (sb!c:sc-offset-offset sc-offset)
2351                                       sb!vm:n-word-bytes))
2352                (the double-float value))))
2353       #!+long-float
2354       (#.sb!vm:long-stack-sc-number
2355        (with-nfp (nfp)
2356          (setf (sap-ref-long nfp (* (sb!c:sc-offset-offset sc-offset)
2357                                     sb!vm:n-word-bytes))
2358                (the long-float value))))
2359       (#.sb!vm:complex-single-stack-sc-number
2360        (with-nfp (nfp)
2361          (setf (sap-ref-single
2362                 nfp (* (sb!c:sc-offset-offset sc-offset) sb!vm:n-word-bytes))
2363                (the single-float (realpart value)))
2364          (setf (sap-ref-single
2365                 nfp (* (1+ (sb!c:sc-offset-offset sc-offset))
2366                        sb!vm:n-word-bytes))
2367                (the single-float (realpart value)))))
2368       (#.sb!vm:complex-double-stack-sc-number
2369        (with-nfp (nfp)
2370          (setf (sap-ref-double
2371                 nfp (* (sb!c:sc-offset-offset sc-offset) sb!vm:n-word-bytes))
2372                (the double-float (realpart value)))
2373          (setf (sap-ref-double
2374                 nfp (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2375                        sb!vm:n-word-bytes))
2376                (the double-float (realpart value)))))
2377       #!+long-float
2378       (#.sb!vm:complex-long-stack-sc-number
2379        (with-nfp (nfp)
2380          (setf (sap-ref-long
2381                 nfp (* (sb!c:sc-offset-offset sc-offset) sb!vm:n-word-bytes))
2382                (the long-float (realpart value)))
2383          (setf (sap-ref-long
2384                 nfp (* (+ (sb!c:sc-offset-offset sc-offset) #!+sparc 4)
2385                        sb!vm:n-word-bytes))
2386                (the long-float (realpart value)))))
2387       (#.sb!vm:control-stack-sc-number
2388        (setf (stack-ref fp (sb!c:sc-offset-offset sc-offset)) value))
2389       (#.sb!vm:base-char-stack-sc-number
2390        (with-nfp (nfp)
2391          (setf (sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2392                                          sb!vm:n-word-bytes))
2393                (char-code (the character value)))))
2394       (#.sb!vm:unsigned-stack-sc-number
2395        (with-nfp (nfp)
2396          (setf (sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2397                                   sb!vm:n-word-bytes))
2398                (the (unsigned-byte 32) value))))
2399       (#.sb!vm:signed-stack-sc-number
2400        (with-nfp (nfp)
2401          (setf (signed-sap-ref-32 nfp (* (sb!c:sc-offset-offset sc-offset)
2402                                          sb!vm:n-word-bytes))
2403                (the (signed-byte 32) value))))
2404       (#.sb!vm:sap-stack-sc-number
2405        (with-nfp (nfp)
2406          (setf (sap-ref-sap nfp (* (sb!c:sc-offset-offset sc-offset)
2407                                    sb!vm:n-word-bytes))
2408                (the system-area-pointer value)))))))
2409
2410 #!+x86
2411 (defun sub-set-debug-var-slot (fp sc-offset value &optional escaped)
2412   (macrolet ((set-escaped-value (val)
2413                `(if escaped
2414                     (setf (sb!vm:context-register
2415                            escaped
2416                            (sb!c:sc-offset-offset sc-offset))
2417                           ,val)
2418                     value)))
2419     (ecase (sb!c:sc-offset-scn sc-offset)
2420       ((#.sb!vm:any-reg-sc-number #.sb!vm:descriptor-reg-sc-number)
2421        (without-gcing
2422         (set-escaped-value
2423           (get-lisp-obj-address value))))
2424       (#.sb!vm:base-char-reg-sc-number
2425        (set-escaped-value (char-code value)))
2426       (#.sb!vm:sap-reg-sc-number
2427        (set-escaped-value (sap-int value)))
2428       (#.sb!vm:signed-reg-sc-number
2429        (set-escaped-value (logand value (1- (ash 1 sb!vm:n-word-bits)))))
2430       (#.sb!vm:unsigned-reg-sc-number
2431        (set-escaped-value value))
2432       (#.sb!vm:single-reg-sc-number
2433         #+nil ;; don't have escaped floats.
2434        (set-escaped-float-value single-float value))
2435       (#.sb!vm:double-reg-sc-number
2436         #+nil ;;  don't have escaped floats -- still in npx?
2437        (set-escaped-float-value double-float value))
2438       #!+long-float
2439       (#.sb!vm:long-reg-sc-number
2440         #+nil ;;  don't have escaped floats -- still in npx?
2441        (set-escaped-float-value long-float value))
2442       (#.sb!vm:single-stack-sc-number
2443        (setf (sap-ref-single
2444               fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2445                        sb!vm:n-word-bytes)))
2446              (the single-float value)))
2447       (#.sb!vm:double-stack-sc-number
2448        (setf (sap-ref-double
2449               fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2450                        sb!vm:n-word-bytes)))
2451              (the double-float value)))
2452       #!+long-float
2453       (#.sb!vm:long-stack-sc-number
2454        (setf (sap-ref-long
2455               fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2456                        sb!vm:n-word-bytes)))
2457              (the long-float value)))
2458       (#.sb!vm:complex-single-stack-sc-number
2459        (setf (sap-ref-single
2460               fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2461                        sb!vm:n-word-bytes)))
2462              (realpart (the (complex single-float) value)))
2463        (setf (sap-ref-single
2464               fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2465                        sb!vm:n-word-bytes)))
2466              (imagpart (the (complex single-float) value))))
2467       (#.sb!vm:complex-double-stack-sc-number
2468        (setf (sap-ref-double
2469               fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 2)
2470                        sb!vm:n-word-bytes)))
2471              (realpart (the (complex double-float) value)))
2472        (setf (sap-ref-double
2473               fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 4)
2474                        sb!vm:n-word-bytes)))
2475              (imagpart (the (complex double-float) value))))
2476       #!+long-float
2477       (#.sb!vm:complex-long-stack-sc-number
2478        (setf (sap-ref-long
2479               fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 3)
2480                        sb!vm:n-word-bytes)))
2481              (realpart (the (complex long-float) value)))
2482        (setf (sap-ref-long
2483               fp (- (* (+ (sb!c:sc-offset-offset sc-offset) 6)
2484                        sb!vm:n-word-bytes)))
2485              (imagpart (the (complex long-float) value))))
2486       (#.sb!vm:control-stack-sc-number
2487        (setf (stack-ref fp (sb!c:sc-offset-offset sc-offset)) value))
2488       (#.sb!vm:base-char-stack-sc-number
2489        (setf (sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2490                                          sb!vm:n-word-bytes)))
2491              (char-code (the character value))))
2492       (#.sb!vm:unsigned-stack-sc-number
2493        (setf (sap-ref-32 fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2494                                          sb!vm:n-word-bytes)))
2495              (the (unsigned-byte 32) value)))
2496       (#.sb!vm:signed-stack-sc-number
2497        (setf (signed-sap-ref-32
2498               fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2499                        sb!vm:n-word-bytes)))
2500              (the (signed-byte 32) value)))
2501       (#.sb!vm:sap-stack-sc-number
2502        (setf (sap-ref-sap fp (- (* (1+ (sb!c:sc-offset-offset sc-offset))
2503                                           sb!vm:n-word-bytes)))
2504              (the system-area-pointer value))))))
2505
2506 ;;; The method for setting and accessing COMPILED-DEBUG-VAR values use
2507 ;;; this to determine if the value stored is the actual value or an
2508 ;;; indirection cell.
2509 (defun indirect-value-cell-p (x)
2510   (and (= (lowtag-of x) sb!vm:other-pointer-lowtag)
2511        (= (widetag-of x) sb!vm:value-cell-header-widetag)))
2512
2513 ;;; Return three values reflecting the validity of DEBUG-VAR's value
2514 ;;; at BASIC-CODE-LOCATION:
2515 ;;;   :VALID    The value is known to be available.
2516 ;;;   :INVALID  The value is known to be unavailable.
2517 ;;;   :UNKNOWN  The value's availability is unknown.
2518 ;;;
2519 ;;; If the variable is always alive, then it is valid. If the
2520 ;;; code-location is unknown, then the variable's validity is
2521 ;;; :unknown. Once we've called CODE-LOCATION-UNKNOWN-P, we know the
2522 ;;; live-set information has been cached in the code-location.
2523 (defun debug-var-validity (debug-var basic-code-location)
2524   (etypecase debug-var
2525     (compiled-debug-var
2526      (compiled-debug-var-validity debug-var basic-code-location))
2527     ;; (There used to be more cases back before sbcl-0.7.0, when
2528     ;; we did special tricks to debug the IR1 interpreter.)
2529     ))
2530
2531 ;;; This is the method for DEBUG-VAR-VALIDITY for COMPILED-DEBUG-VARs.
2532 ;;; For safety, make sure basic-code-location is what we think.
2533 (defun compiled-debug-var-validity (debug-var basic-code-location)
2534   (declare (type compiled-code-location basic-code-location))
2535   (cond ((debug-var-alive-p debug-var)
2536          (let ((debug-fun (code-location-debug-fun basic-code-location)))
2537            (if (>= (compiled-code-location-pc basic-code-location)
2538                    (sb!c::compiled-debug-fun-start-pc
2539                     (compiled-debug-fun-compiler-debug-fun debug-fun)))
2540                :valid
2541                :invalid)))
2542         ((code-location-unknown-p basic-code-location) :unknown)
2543         (t
2544          (let ((pos (position debug-var
2545                               (debug-fun-debug-vars
2546                                (code-location-debug-fun
2547                                 basic-code-location)))))
2548            (unless pos
2549              (error 'unknown-debug-var
2550                     :debug-var debug-var
2551                     :debug-fun
2552                     (code-location-debug-fun basic-code-location)))
2553            ;; There must be live-set info since basic-code-location is known.
2554            (if (zerop (sbit (compiled-code-location-live-set
2555                              basic-code-location)
2556                             pos))
2557                :invalid
2558                :valid)))))
2559 \f
2560 ;;;; sources
2561
2562 ;;; This code produces and uses what we call source-paths. A
2563 ;;; source-path is a list whose first element is a form number as
2564 ;;; returned by CODE-LOCATION-FORM-NUMBER and whose last element is a
2565 ;;; top level form number as returned by
2566 ;;; CODE-LOCATION-TOPLEVEL-FORM-NUMBER. The elements from the last to
2567 ;;; the first, exclusively, are the numbered subforms into which to
2568 ;;; descend. For example:
2569 ;;;    (defun foo (x)
2570 ;;;      (let ((a (aref x 3)))
2571 ;;;     (cons a 3)))
2572 ;;; The call to AREF in this example is form number 5. Assuming this
2573 ;;; DEFUN is the 11'th top level form, the source-path for the AREF
2574 ;;; call is as follows:
2575 ;;;    (5 1 0 1 3 11)
2576 ;;; Given the DEFUN, 3 gets you the LET, 1 gets you the bindings, 0
2577 ;;; gets the first binding, and 1 gets the AREF form.
2578
2579 ;;; temporary buffer used to build form-number => source-path translation in
2580 ;;; FORM-NUMBER-TRANSLATIONS
2581 (defvar *form-number-temp* (make-array 10 :fill-pointer 0 :adjustable t))
2582
2583 ;;; table used to detect CAR circularities in FORM-NUMBER-TRANSLATIONS
2584 (defvar *form-number-circularity-table* (make-hash-table :test 'eq))
2585
2586 ;;; This returns a table mapping form numbers to source-paths. A
2587 ;;; source-path indicates a descent into the TOPLEVEL-FORM form,
2588 ;;; going directly to the subform corressponding to the form number.
2589 ;;;
2590 ;;; The vector elements are in the same format as the compiler's
2591 ;;; NODE-SOURCE-PATH; that is, the first element is the form number and
2592 ;;; the last is the TOPLEVEL-FORM number.
2593 (defun form-number-translations (form tlf-number)
2594   (clrhash *form-number-circularity-table*)
2595   (setf (fill-pointer *form-number-temp*) 0)
2596   (sub-translate-form-numbers form (list tlf-number))
2597   (coerce *form-number-temp* 'simple-vector))
2598 (defun sub-translate-form-numbers (form path)
2599   (unless (gethash form *form-number-circularity-table*)
2600     (setf (gethash form *form-number-circularity-table*) t)
2601     (vector-push-extend (cons (fill-pointer *form-number-temp*) path)
2602                         *form-number-temp*)
2603     (let ((pos 0)
2604           (subform form)
2605           (trail form))
2606       (declare (fixnum pos))
2607       (macrolet ((frob ()
2608                    '(progn
2609                       (when (atom subform) (return))
2610                       (let ((fm (car subform)))
2611                         (when (consp fm)
2612                           (sub-translate-form-numbers fm (cons pos path)))
2613                         (incf pos))
2614                       (setq subform (cdr subform))
2615                       (when (eq subform trail) (return)))))
2616         (loop
2617           (frob)
2618           (frob)
2619           (setq trail (cdr trail)))))))
2620
2621 ;;; FORM is a top level form, and path is a source-path into it. This
2622 ;;; returns the form indicated by the source-path. Context is the
2623 ;;; number of enclosing forms to return instead of directly returning
2624 ;;; the source-path form. When context is non-zero, the form returned
2625 ;;; contains a marker, #:****HERE****, immediately before the form
2626 ;;; indicated by path.
2627 (defun source-path-context (form path context)
2628   (declare (type unsigned-byte context))
2629   ;; Get to the form indicated by path or the enclosing form indicated
2630   ;; by context and path.
2631   (let ((path (reverse (butlast (cdr path)))))
2632     (dotimes (i (- (length path) context))
2633       (let ((index (first path)))
2634         (unless (and (listp form) (< index (length form)))
2635           (error "Source path no longer exists."))
2636         (setq form (elt form index))
2637         (setq path (rest path))))
2638     ;; Recursively rebuild the source form resulting from the above
2639     ;; descent, copying the beginning of each subform up to the next
2640     ;; subform we descend into according to path. At the bottom of the
2641     ;; recursion, we return the form indicated by path preceded by our
2642     ;; marker, and this gets spliced into the resulting list structure
2643     ;; on the way back up.
2644     (labels ((frob (form path level)
2645                (if (or (zerop level) (null path))
2646                    (if (zerop context)
2647                        form
2648                        `(#:***here*** ,form))
2649                    (let ((n (first path)))
2650                      (unless (and (listp form) (< n (length form)))
2651                        (error "Source path no longer exists."))
2652                      (let ((res (frob (elt form n) (rest path) (1- level))))
2653                        (nconc (subseq form 0 n)
2654                               (cons res (nthcdr (1+ n) form))))))))
2655       (frob form path context))))
2656 \f
2657 ;;;; PREPROCESS-FOR-EVAL
2658
2659 ;;; Return a function of one argument that evaluates form in the
2660 ;;; lexical context of the BASIC-CODE-LOCATION LOC, or signal a
2661 ;;; NO-DEBUG-VARS condition when the LOC's DEBUG-FUN has no
2662 ;;; DEBUG-VAR information available.
2663 ;;;
2664 ;;; The returned function takes the frame to get values from as its
2665 ;;; argument, and it returns the values of FORM. The returned function
2666 ;;; can signal the following conditions: INVALID-VALUE,
2667 ;;; AMBIGUOUS-VAR-NAME, and FRAME-FUN-MISMATCH.
2668 (defun preprocess-for-eval (form loc)
2669   (declare (type code-location loc))
2670   (let ((n-frame (gensym))
2671         (fun (code-location-debug-fun loc)))
2672     (unless (debug-var-info-available fun)
2673       (debug-signal 'no-debug-vars :debug-fun fun))
2674     (sb!int:collect ((binds)
2675                      (specs))
2676       (do-debug-fun-vars (var fun)
2677         (let ((validity (debug-var-validity var loc)))
2678           (unless (eq validity :invalid)
2679             (let* ((sym (debug-var-symbol var))
2680                    (found (assoc sym (binds))))
2681               (if found
2682                   (setf (second found) :ambiguous)
2683                   (binds (list sym validity var)))))))
2684       (dolist (bind (binds))
2685         (let ((name (first bind))
2686               (var (third bind)))
2687           (ecase (second bind)
2688             (:valid
2689              (specs `(,name (debug-var-value ',var ,n-frame))))
2690             (:unknown
2691              (specs `(,name (debug-signal 'invalid-value
2692                                           :debug-var ',var
2693                                           :frame ,n-frame))))
2694             (:ambiguous
2695              (specs `(,name (debug-signal 'ambiguous-var-name
2696                                           :name ',name
2697                                           :frame ,n-frame)))))))
2698       (let ((res (coerce `(lambda (,n-frame)
2699                             (declare (ignorable ,n-frame))
2700                             (symbol-macrolet ,(specs) ,form))
2701                          'function)))
2702         (lambda (frame)
2703           ;; This prevents these functions from being used in any
2704           ;; location other than a function return location, so maybe
2705           ;; this should only check whether FRAME's DEBUG-FUN is the
2706           ;; same as LOC's.
2707           (unless (code-location= (frame-code-location frame) loc)
2708             (debug-signal 'frame-fun-mismatch
2709                           :code-location loc :form form :frame frame))
2710           (funcall res frame))))))
2711 \f
2712 ;;;; breakpoints
2713
2714 ;;;; user-visible interface
2715
2716 ;;; Create and return a breakpoint. When program execution encounters
2717 ;;; the breakpoint, the system calls HOOK-FUN. HOOK-FUN takes the
2718 ;;; current frame for the function in which the program is running and
2719 ;;; the breakpoint object.
2720 ;;;
2721 ;;; WHAT and KIND determine where in a function the system invokes
2722 ;;; HOOK-FUN. WHAT is either a code-location or a DEBUG-FUN. KIND is
2723 ;;; one of :CODE-LOCATION, :FUN-START, or :FUN-END. Since the starts
2724 ;;; and ends of functions may not have code-locations representing
2725 ;;; them, designate these places by supplying WHAT as a DEBUG-FUN and
2726 ;;; KIND indicating the :FUN-START or :FUN-END. When WHAT is a
2727 ;;; DEBUG-FUN and kind is :FUN-END, then HOOK-FUN must take two
2728 ;;; additional arguments, a list of values returned by the function
2729 ;;; and a FUN-END-COOKIE.
2730 ;;;
2731 ;;; INFO is information supplied by and used by the user.
2732 ;;;
2733 ;;; FUN-END-COOKIE is a function. To implement :FUN-END
2734 ;;; breakpoints, the system uses starter breakpoints to establish the
2735 ;;; :FUN-END breakpoint for each invocation of the function. Upon
2736 ;;; each entry, the system creates a unique cookie to identify the
2737 ;;; invocation, and when the user supplies a function for this
2738 ;;; argument, the system invokes it on the frame and the cookie. The
2739 ;;; system later invokes the :FUN-END breakpoint hook on the same
2740 ;;; cookie. The user may save the cookie for comparison in the hook
2741 ;;; function.
2742 ;;;
2743 ;;; Signal an error if WHAT is an unknown code-location.
2744 (defun make-breakpoint (hook-fun what
2745                         &key (kind :code-location) info fun-end-cookie)
2746   (etypecase what
2747     (code-location
2748      (when (code-location-unknown-p what)
2749        (error "cannot make a breakpoint at an unknown code location: ~S"
2750               what))
2751      (aver (eq kind :code-location))
2752      (let ((bpt (%make-breakpoint hook-fun what kind info)))
2753        (etypecase what
2754          (compiled-code-location
2755           ;; This slot is filled in due to calling CODE-LOCATION-UNKNOWN-P.
2756           (when (eq (compiled-code-location-kind what) :unknown-return)
2757             (let ((other-bpt (%make-breakpoint hook-fun what
2758                                                :unknown-return-partner
2759                                                info)))
2760               (setf (breakpoint-unknown-return-partner bpt) other-bpt)
2761               (setf (breakpoint-unknown-return-partner other-bpt) bpt))))
2762          ;; (There used to be more cases back before sbcl-0.7.0,,
2763          ;; when we did special tricks to debug the IR1
2764          ;; interpreter.)
2765          )
2766        bpt))
2767     (compiled-debug-fun
2768      (ecase kind
2769        (:fun-start
2770         (%make-breakpoint hook-fun what kind info))
2771        (:fun-end
2772         (unless (eq (sb!c::compiled-debug-fun-returns
2773                      (compiled-debug-fun-compiler-debug-fun what))
2774                     :standard)
2775           (error ":FUN-END breakpoints are currently unsupported ~
2776                   for the known return convention."))
2777
2778         (let* ((bpt (%make-breakpoint hook-fun what kind info))
2779                (starter (compiled-debug-fun-end-starter what)))
2780           (unless starter
2781             (setf starter (%make-breakpoint #'list what :fun-start nil))
2782             (setf (breakpoint-hook-fun starter)
2783                   (fun-end-starter-hook starter what))
2784             (setf (compiled-debug-fun-end-starter what) starter))
2785           (setf (breakpoint-start-helper bpt) starter)
2786           (push bpt (breakpoint-%info starter))
2787           (setf (breakpoint-cookie-fun bpt) fun-end-cookie)
2788           bpt))))))
2789
2790 ;;; These are unique objects created upon entry into a function by a
2791 ;;; :FUN-END breakpoint's starter hook. These are only created
2792 ;;; when users supply :FUN-END-COOKIE to MAKE-BREAKPOINT. Also,
2793 ;;; the :FUN-END breakpoint's hook is called on the same cookie
2794 ;;; when it is created.
2795 (defstruct (fun-end-cookie
2796             (:print-object (lambda (obj str)
2797                              (print-unreadable-object (obj str :type t))))
2798             (:constructor make-fun-end-cookie (bogus-lra debug-fun))
2799             (:copier nil))
2800   ;; a pointer to the bogus-lra created for :FUN-END breakpoints
2801   bogus-lra
2802   ;; the DEBUG-FUN associated with this cookie
2803   debug-fun)
2804
2805 ;;; This maps bogus-lra-components to cookies, so that
2806 ;;; HANDLE-FUN-END-BREAKPOINT can find the appropriate cookie for the
2807 ;;; breakpoint hook.
2808 (defvar *fun-end-cookies* (make-hash-table :test 'eq))
2809
2810 ;;; This returns a hook function for the start helper breakpoint
2811 ;;; associated with a :FUN-END breakpoint. The returned function
2812 ;;; makes a fake LRA that all returns go through, and this piece of
2813 ;;; fake code actually breaks. Upon return from the break, the code
2814 ;;; provides the returnee with any values. Since the returned function
2815 ;;; effectively activates FUN-END-BPT on each entry to DEBUG-FUN's
2816 ;;; function, we must establish breakpoint-data about FUN-END-BPT.
2817 (defun fun-end-starter-hook (starter-bpt debug-fun)
2818   (declare (type breakpoint starter-bpt)
2819            (type compiled-debug-fun debug-fun))
2820   (lambda (frame breakpoint)
2821     (declare (ignore breakpoint)
2822              (type frame frame))
2823     (let ((lra-sc-offset
2824            (sb!c::compiled-debug-fun-return-pc
2825             (compiled-debug-fun-compiler-debug-fun debug-fun))))
2826       (multiple-value-bind (lra component offset)
2827           (make-bogus-lra
2828            (get-context-value frame
2829                               lra-save-offset
2830                               lra-sc-offset))
2831         (setf (get-context-value frame
2832                                  lra-save-offset
2833                                  lra-sc-offset)
2834               lra)
2835         (let ((end-bpts (breakpoint-%info starter-bpt)))
2836           (let ((data (breakpoint-data component offset)))
2837             (setf (breakpoint-data-breakpoints data) end-bpts)
2838             (dolist (bpt end-bpts)
2839               (setf (breakpoint-internal-data bpt) data)))
2840           (let ((cookie (make-fun-end-cookie lra debug-fun)))
2841             (setf (gethash component *fun-end-cookies*) cookie)
2842             (dolist (bpt end-bpts)
2843               (let ((fun (breakpoint-cookie-fun bpt)))
2844                 (when fun (funcall fun frame cookie))))))))))
2845
2846 ;;; This takes a FUN-END-COOKIE and a frame, and it returns
2847 ;;; whether the cookie is still valid. A cookie becomes invalid when
2848 ;;; the frame that established the cookie has exited. Sometimes cookie
2849 ;;; holders are unaware of cookie invalidation because their
2850 ;;; :FUN-END breakpoint hooks didn't run due to THROW'ing.
2851 ;;;
2852 ;;; This takes a frame as an efficiency hack since the user probably
2853 ;;; has a frame object in hand when using this routine, and it saves
2854 ;;; repeated parsing of the stack and consing when asking whether a
2855 ;;; series of cookies is valid.
2856 (defun fun-end-cookie-valid-p (frame cookie)
2857   (let ((lra (fun-end-cookie-bogus-lra cookie))
2858         (lra-sc-offset (sb!c::compiled-debug-fun-return-pc
2859                         (compiled-debug-fun-compiler-debug-fun
2860                          (fun-end-cookie-debug-fun cookie)))))
2861     (do ((frame frame (frame-down frame)))
2862         ((not frame) nil)
2863       (when (and (compiled-frame-p frame)
2864                  (#!-x86 eq #!+x86 sap=
2865                   lra
2866                   (get-context-value frame lra-save-offset lra-sc-offset)))
2867         (return t)))))
2868 \f
2869 ;;;; ACTIVATE-BREAKPOINT
2870
2871 ;;; Cause the system to invoke the breakpoint's hook function until
2872 ;;; the next call to DEACTIVATE-BREAKPOINT or DELETE-BREAKPOINT. The
2873 ;;; system invokes breakpoint hook functions in the opposite order
2874 ;;; that you activate them.
2875 (defun activate-breakpoint (breakpoint)
2876   (when (eq (breakpoint-status breakpoint) :deleted)
2877     (error "cannot activate a deleted breakpoint: ~S" breakpoint))
2878   (unless (eq (breakpoint-status breakpoint) :active)
2879     (ecase (breakpoint-kind breakpoint)
2880       (:code-location
2881        (let ((loc (breakpoint-what breakpoint)))
2882          (etypecase loc
2883            (compiled-code-location
2884             (activate-compiled-code-location-breakpoint breakpoint)
2885             (let ((other (breakpoint-unknown-return-partner breakpoint)))
2886               (when other
2887                 (activate-compiled-code-location-breakpoint other))))
2888            ;; (There used to be more cases back before sbcl-0.7.0, when
2889            ;; we did special tricks to debug the IR1 interpreter.)
2890            )))
2891       (:fun-start
2892        (etypecase (breakpoint-what breakpoint)
2893          (compiled-debug-fun
2894           (activate-compiled-fun-start-breakpoint breakpoint))
2895          ;; (There used to be more cases back before sbcl-0.7.0, when
2896          ;; we did special tricks to debug the IR1 interpreter.)
2897          ))
2898       (:fun-end
2899        (etypecase (breakpoint-what breakpoint)
2900          (compiled-debug-fun
2901           (let ((starter (breakpoint-start-helper breakpoint)))
2902             (unless (eq (breakpoint-status starter) :active)
2903               ;; may already be active by some other :FUN-END breakpoint
2904               (activate-compiled-fun-start-breakpoint starter)))
2905           (setf (breakpoint-status breakpoint) :active))
2906          ;; (There used to be more cases back before sbcl-0.7.0, when
2907          ;; we did special tricks to debug the IR1 interpreter.)
2908          ))))
2909   breakpoint)
2910
2911 (defun activate-compiled-code-location-breakpoint (breakpoint)
2912   (declare (type breakpoint breakpoint))
2913   (let ((loc (breakpoint-what breakpoint)))
2914     (declare (type compiled-code-location loc))
2915     (sub-activate-breakpoint
2916      breakpoint
2917      (breakpoint-data (compiled-debug-fun-component
2918                        (code-location-debug-fun loc))
2919                       (+ (compiled-code-location-pc loc)
2920                          (if (or (eq (breakpoint-kind breakpoint)
2921                                      :unknown-return-partner)
2922                                  (eq (compiled-code-location-kind loc)
2923                                      :single-value-return))
2924                              sb!vm:single-value-return-byte-offset
2925                              0))))))
2926
2927 (defun activate-compiled-fun-start-breakpoint (breakpoint)
2928   (declare (type breakpoint breakpoint))
2929   (let ((debug-fun (breakpoint-what breakpoint)))
2930     (sub-activate-breakpoint
2931      breakpoint
2932      (breakpoint-data (compiled-debug-fun-component debug-fun)
2933                       (sb!c::compiled-debug-fun-start-pc
2934                        (compiled-debug-fun-compiler-debug-fun
2935                         debug-fun))))))
2936
2937 (defun sub-activate-breakpoint (breakpoint data)
2938   (declare (type breakpoint breakpoint)
2939            (type breakpoint-data data))
2940   (setf (breakpoint-status breakpoint) :active)
2941   (without-interrupts
2942    (unless (breakpoint-data-breakpoints data)
2943      (setf (breakpoint-data-instruction data)
2944            (without-gcing
2945             (breakpoint-install (get-lisp-obj-address
2946                                  (breakpoint-data-component data))
2947                                 (breakpoint-data-offset data)))))
2948    (setf (breakpoint-data-breakpoints data)
2949          (append (breakpoint-data-breakpoints data) (list breakpoint)))
2950    (setf (breakpoint-internal-data breakpoint) data)))
2951 \f
2952 ;;;; DEACTIVATE-BREAKPOINT
2953
2954 ;;; Stop the system from invoking the breakpoint's hook function.
2955 (defun deactivate-breakpoint (breakpoint)
2956   (when (eq (breakpoint-status breakpoint) :active)
2957     (without-interrupts
2958      (let ((loc (breakpoint-what breakpoint)))
2959        (etypecase loc
2960          ((or compiled-code-location compiled-debug-fun)
2961           (deactivate-compiled-breakpoint breakpoint)
2962           (let ((other (breakpoint-unknown-return-partner breakpoint)))
2963             (when other
2964               (deactivate-compiled-breakpoint other))))
2965          ;; (There used to be more cases back before sbcl-0.7.0, when
2966          ;; we did special tricks to debug the IR1 interpreter.)
2967          ))))
2968   breakpoint)
2969
2970 (defun deactivate-compiled-breakpoint (breakpoint)
2971   (if (eq (breakpoint-kind breakpoint) :fun-end)
2972       (let ((starter (breakpoint-start-helper breakpoint)))
2973         (unless (find-if (lambda (bpt)
2974                            (and (not (eq bpt breakpoint))
2975                                 (eq (breakpoint-status bpt) :active)))
2976                          (breakpoint-%info starter))
2977           (deactivate-compiled-breakpoint starter)))
2978       (let* ((data (breakpoint-internal-data breakpoint))
2979              (bpts (delete breakpoint (breakpoint-data-breakpoints data))))
2980         (setf (breakpoint-internal-data breakpoint) nil)
2981         (setf (breakpoint-data-breakpoints data) bpts)
2982         (unless bpts
2983           (without-gcing
2984            (breakpoint-remove (get-lisp-obj-address
2985                                (breakpoint-data-component data))
2986                               (breakpoint-data-offset data)
2987                               (breakpoint-data-instruction data)))
2988           (delete-breakpoint-data data))))
2989   (setf (breakpoint-status breakpoint) :inactive)
2990   breakpoint)
2991 \f
2992 ;;;; BREAKPOINT-INFO
2993
2994 ;;; Return the user-maintained info associated with breakpoint. This
2995 ;;; is SETF'able.
2996 (defun breakpoint-info (breakpoint)
2997   (breakpoint-%info breakpoint))
2998 (defun %set-breakpoint-info (breakpoint value)
2999   (setf (breakpoint-%info breakpoint) value)
3000   (let ((other (breakpoint-unknown-return-partner breakpoint)))
3001     (when other
3002       (setf (breakpoint-%info other) value))))
3003 \f
3004 ;;;; BREAKPOINT-ACTIVE-P and DELETE-BREAKPOINT
3005
3006 (defun breakpoint-active-p (breakpoint)
3007   (ecase (breakpoint-status breakpoint)
3008     (:active t)
3009     ((:inactive :deleted) nil)))
3010
3011 ;;; Free system storage and remove computational overhead associated
3012 ;;; with breakpoint. After calling this, breakpoint is completely
3013 ;;; impotent and can never become active again.
3014 (defun delete-breakpoint (breakpoint)
3015   (let ((status (breakpoint-status breakpoint)))
3016     (unless (eq status :deleted)
3017       (when (eq status :active)
3018         (deactivate-breakpoint breakpoint))
3019       (setf (breakpoint-status breakpoint) :deleted)
3020       (let ((other (breakpoint-unknown-return-partner breakpoint)))
3021         (when other
3022           (setf (breakpoint-status other) :deleted)))
3023       (when (eq (breakpoint-kind breakpoint) :fun-end)
3024         (let* ((starter (breakpoint-start-helper breakpoint))
3025                (breakpoints (delete breakpoint
3026                                     (the list (breakpoint-info starter)))))
3027           (setf (breakpoint-info starter) breakpoints)
3028           (unless breakpoints
3029             (delete-breakpoint starter)
3030             (setf (compiled-debug-fun-end-starter
3031                    (breakpoint-what breakpoint))
3032                   nil))))))
3033   breakpoint)
3034 \f
3035 ;;;; C call out stubs
3036
3037 ;;; This actually installs the break instruction in the component. It
3038 ;;; returns the overwritten bits. You must call this in a context in
3039 ;;; which GC is disabled, so that Lisp doesn't move objects around
3040 ;;; that C is pointing to.
3041 (sb!alien:define-alien-routine "breakpoint_install" sb!alien:unsigned-long
3042   (code-obj sb!alien:unsigned-long)
3043   (pc-offset sb!alien:int))
3044
3045 ;;; This removes the break instruction and replaces the original
3046 ;;; instruction. You must call this in a context in which GC is disabled
3047 ;;; so Lisp doesn't move objects around that C is pointing to.
3048 (sb!alien:define-alien-routine "breakpoint_remove" sb!alien:void
3049   (code-obj sb!alien:unsigned-long)
3050   (pc-offset sb!alien:int)
3051   (old-inst sb!alien:unsigned-long))
3052
3053 (sb!alien:define-alien-routine "breakpoint_do_displaced_inst" sb!alien:void
3054   (scp (* os-context-t))
3055   (orig-inst sb!alien:unsigned-long))
3056
3057 ;;;; breakpoint handlers (layer between C and exported interface)
3058
3059 ;;; This maps components to a mapping of offsets to BREAKPOINT-DATAs.
3060 (defvar *component-breakpoint-offsets* (make-hash-table :test 'eq))
3061
3062 ;;; This returns the BREAKPOINT-DATA object associated with component cross
3063 ;;; offset. If none exists, this makes one, installs it, and returns it.
3064 (defun breakpoint-data (component offset &optional (create t))
3065   (flet ((install-breakpoint-data ()
3066            (when create
3067              (let ((data (make-breakpoint-data component offset)))
3068                (push (cons offset data)
3069                      (gethash component *component-breakpoint-offsets*))
3070                data))))
3071     (let ((offsets (gethash component *component-breakpoint-offsets*)))
3072       (if offsets
3073           (let ((data (assoc offset offsets)))
3074             (if data
3075                 (cdr data)
3076                 (install-breakpoint-data)))
3077           (install-breakpoint-data)))))
3078
3079 ;;; We use this when there are no longer any active breakpoints
3080 ;;; corresponding to DATA.
3081 (defun delete-breakpoint-data (data)
3082   (let* ((component (breakpoint-data-component data))
3083          (offsets (delete (breakpoint-data-offset data)
3084                           (gethash component *component-breakpoint-offsets*)
3085                           :key #'car)))
3086     (if offsets
3087         (setf (gethash component *component-breakpoint-offsets*) offsets)
3088         (remhash component *component-breakpoint-offsets*)))
3089   (values))
3090
3091 ;;; The C handler for interrupts calls this when it has a
3092 ;;; debugging-tool break instruction. This does *not* handle all
3093 ;;; breaks; for example, it does not handle breaks for internal
3094 ;;; errors.
3095 (defun handle-breakpoint (offset component signal-context)
3096   (let ((data (breakpoint-data component offset nil)))
3097     (unless data
3098       (error "unknown breakpoint in ~S at offset ~S"
3099               (debug-fun-name (debug-fun-from-pc component offset))
3100               offset))
3101     (let ((breakpoints (breakpoint-data-breakpoints data)))
3102       (if (or (null breakpoints)
3103               (eq (breakpoint-kind (car breakpoints)) :fun-end))
3104           (handle-fun-end-breakpoint-aux breakpoints data signal-context)
3105           (handle-breakpoint-aux breakpoints data
3106                                  offset component signal-context)))))
3107
3108 ;;; This holds breakpoint-datas while invoking the breakpoint hooks
3109 ;;; associated with that particular component and location. While they
3110 ;;; are executing, if we hit the location again, we ignore the
3111 ;;; breakpoint to avoid infinite recursion. fun-end breakpoints
3112 ;;; must work differently since the breakpoint-data is unique for each
3113 ;;; invocation.
3114 (defvar *executing-breakpoint-hooks* nil)
3115
3116 ;;; This handles code-location and DEBUG-FUN :FUN-START
3117 ;;; breakpoints.
3118 (defun handle-breakpoint-aux (breakpoints data offset component signal-context)
3119   (unless breakpoints
3120     (bug "breakpoint that nobody wants"))
3121   (unless (member data *executing-breakpoint-hooks*)
3122     (let ((*executing-breakpoint-hooks* (cons data
3123                                               *executing-breakpoint-hooks*)))
3124       (invoke-breakpoint-hooks breakpoints component offset)))
3125   ;; At this point breakpoints may not hold the same list as
3126   ;; BREAKPOINT-DATA-BREAKPOINTS since invoking hooks may have allowed
3127   ;; a breakpoint deactivation. In fact, if all breakpoints were
3128   ;; deactivated then data is invalid since it was deleted and so the
3129   ;; correct one must be looked up if it is to be used. If there are
3130   ;; no more breakpoints active at this location, then the normal
3131   ;; instruction has been put back, and we do not need to
3132   ;; DO-DISPLACED-INST.
3133   (let ((data (breakpoint-data component offset nil)))
3134     (when (and data (breakpoint-data-breakpoints data))
3135       ;; The breakpoint is still active, so we need to execute the
3136       ;; displaced instruction and leave the breakpoint instruction
3137       ;; behind. The best way to do this is different on each machine,
3138       ;; so we just leave it up to the C code.
3139       (breakpoint-do-displaced-inst signal-context
3140                                     (breakpoint-data-instruction data))
3141       ;; Some platforms have no usable sigreturn() call.  If your
3142       ;; implementation of arch_do_displaced_inst() _does_ sigreturn(),
3143       ;; it's polite to warn here
3144       #!+(and sparc solaris)
3145       (error "BREAKPOINT-DO-DISPLACED-INST returned?"))))
3146
3147 (defun invoke-breakpoint-hooks (breakpoints component offset)
3148   (let* ((debug-fun (debug-fun-from-pc component offset))
3149          (frame (do ((f (top-frame) (frame-down f)))
3150                     ((eq debug-fun (frame-debug-fun f)) f))))
3151     (dolist (bpt breakpoints)
3152       (funcall (breakpoint-hook-fun bpt)
3153                frame
3154                ;; If this is an :UNKNOWN-RETURN-PARTNER, then pass the
3155                ;; hook function the original breakpoint, so that users
3156                ;; aren't forced to confront the fact that some
3157                ;; breakpoints really are two.
3158                (if (eq (breakpoint-kind bpt) :unknown-return-partner)
3159                    (breakpoint-unknown-return-partner bpt)
3160                    bpt)))))
3161
3162 (defun handle-fun-end-breakpoint (offset component context)
3163   (let ((data (breakpoint-data component offset nil)))
3164     (unless data
3165       (error "unknown breakpoint in ~S at offset ~S"
3166               (debug-fun-name (debug-fun-from-pc component offset))
3167               offset))
3168     (let ((breakpoints (breakpoint-data-breakpoints data)))
3169       (when breakpoints
3170         (aver (eq (breakpoint-kind (car breakpoints)) :fun-end))
3171         (handle-fun-end-breakpoint-aux breakpoints data context)))))
3172
3173 ;;; Either HANDLE-BREAKPOINT calls this for :FUN-END breakpoints
3174 ;;; [old C code] or HANDLE-FUN-END-BREAKPOINT calls this directly
3175 ;;; [new C code].
3176 (defun handle-fun-end-breakpoint-aux (breakpoints data signal-context)
3177   (delete-breakpoint-data data)
3178   (let* ((scp
3179           (locally
3180             (declare (optimize (inhibit-warnings 3)))
3181             (sb!alien:sap-alien signal-context (* os-context-t))))
3182          (frame (do ((cfp (sb!vm:context-register scp sb!vm::cfp-offset))
3183                      (f (top-frame) (frame-down f)))
3184                     ((= cfp (sap-int (frame-pointer f))) f)
3185                   (declare (type (unsigned-byte #.sb!vm:n-word-bits) cfp))))
3186          (component (breakpoint-data-component data))
3187          (cookie (gethash component *fun-end-cookies*)))
3188     (remhash component *fun-end-cookies*)
3189     (dolist (bpt breakpoints)
3190       (funcall (breakpoint-hook-fun bpt)
3191                frame bpt
3192                (get-fun-end-breakpoint-values scp)
3193                cookie))))
3194
3195 (defun get-fun-end-breakpoint-values (scp)
3196   (let ((ocfp (int-sap (sb!vm:context-register
3197                         scp
3198                         #!-x86 sb!vm::ocfp-offset
3199                         #!+x86 sb!vm::ebx-offset)))
3200         (nargs (make-lisp-obj
3201                 (sb!vm:context-register scp sb!vm::nargs-offset)))
3202         (reg-arg-offsets '#.sb!vm::*register-arg-offsets*)
3203         (results nil))
3204     (without-gcing
3205      (dotimes (arg-num nargs)
3206        (push (if reg-arg-offsets
3207                  (make-lisp-obj
3208                   (sb!vm:context-register scp (pop reg-arg-offsets)))
3209                (stack-ref ocfp arg-num))
3210              results)))
3211     (nreverse results)))
3212 \f
3213 ;;;; MAKE-BOGUS-LRA (used for :FUN-END breakpoints)
3214
3215 (defconstant bogus-lra-constants
3216   #!-x86 2 #!+x86 3)
3217 (defconstant known-return-p-slot
3218   (+ sb!vm:code-constants-offset #!-x86 1 #!+x86 2))
3219
3220 ;;; Make a bogus LRA object that signals a breakpoint trap when
3221 ;;; returned to. If the breakpoint trap handler returns, REAL-LRA is
3222 ;;; returned to. Three values are returned: the bogus LRA object, the
3223 ;;; code component it is part of, and the PC offset for the trap
3224 ;;; instruction.
3225 (defun make-bogus-lra (real-lra &optional known-return-p)
3226   (without-gcing
3227    (let* ((src-start (foreign-symbol-address "fun_end_breakpoint_guts"))
3228           (src-end (foreign-symbol-address "fun_end_breakpoint_end"))
3229           (trap-loc (foreign-symbol-address "fun_end_breakpoint_trap"))
3230           (length (sap- src-end src-start))
3231           (code-object
3232            (%primitive
3233             #!-(and x86 gencgc) sb!c:allocate-code-object
3234             #!+(and x86 gencgc) sb!c::allocate-dynamic-code-object
3235             (1+ bogus-lra-constants)
3236             length))
3237           (dst-start (code-instructions code-object)))
3238      (declare (type system-area-pointer
3239                     src-start src-end dst-start trap-loc)
3240               (type index length))
3241      (setf (%code-debug-info code-object) :bogus-lra)
3242      (setf (code-header-ref code-object sb!vm:code-trace-table-offset-slot)
3243            length)
3244      #!-x86
3245      (setf (code-header-ref code-object real-lra-slot) real-lra)
3246      #!+x86
3247      (multiple-value-bind (offset code) (compute-lra-data-from-pc real-lra)
3248        (setf (code-header-ref code-object real-lra-slot) code)
3249        (setf (code-header-ref code-object (1+ real-lra-slot)) offset))
3250      (setf (code-header-ref code-object known-return-p-slot)
3251            known-return-p)
3252      (system-area-copy src-start 0 dst-start 0 (* length sb!vm:n-byte-bits))
3253      (sb!vm:sanctify-for-execution code-object)
3254      #!+x86
3255      (values dst-start code-object (sap- trap-loc src-start))
3256      #!-x86
3257      (let ((new-lra (make-lisp-obj (+ (sap-int dst-start)
3258                                       sb!vm:other-pointer-lowtag))))
3259        (set-header-data
3260         new-lra
3261         (logandc2 (+ sb!vm:code-constants-offset bogus-lra-constants 1)
3262                   1))
3263        (sb!vm:sanctify-for-execution code-object)
3264        (values new-lra code-object (sap- trap-loc src-start))))))
3265 \f
3266 ;;;; miscellaneous
3267
3268 ;;; This appears here because it cannot go with the DEBUG-FUN
3269 ;;; interface since DO-DEBUG-BLOCK-LOCATIONS isn't defined until after
3270 ;;; the DEBUG-FUN routines.
3271
3272 ;;; Return a code-location before the body of a function and after all
3273 ;;; the arguments are in place; or if that location can't be
3274 ;;; determined due to a lack of debug information, return NIL.
3275 (defun debug-fun-start-location (debug-fun)
3276   (etypecase debug-fun
3277     (compiled-debug-fun
3278      (code-location-from-pc debug-fun
3279                             (sb!c::compiled-debug-fun-start-pc
3280                              (compiled-debug-fun-compiler-debug-fun
3281                               debug-fun))
3282                             nil))
3283     ;; (There used to be more cases back before sbcl-0.7.0, when
3284     ;; we did special tricks to debug the IR1 interpreter.)
3285     ))
3286
3287 (defun print-code-locations (function)
3288   (let ((debug-fun (fun-debug-fun function)))
3289     (do-debug-fun-blocks (block debug-fun)
3290       (do-debug-block-locations (loc block)
3291         (fill-in-code-location loc)
3292         (format t "~S code location at ~W"
3293                 (compiled-code-location-kind loc)
3294                 (compiled-code-location-pc loc))
3295         (sb!debug::print-code-location-source-form loc 0)
3296         (terpri)))))