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