63b899b61a1c68a5613572b0a8a68992817a560a
[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 :weakness :key))
302
303 ;;; Make a COMPILED-DEBUG-FUN for a SB!C::COMPILER-DEBUG-FUN and its
304 ;;; component. This maps the latter to the former in
305 ;;; *COMPILED-DEBUG-FUNS*. If there already is a COMPILED-DEBUG-FUN,
306 ;;; then this returns it from *COMPILED-DEBUG-FUNS*.
307 ;;;
308 ;;; FIXME: It seems this table can potentially grow without bounds,
309 ;;; and retains roots to functions that might otherwise be collected.
310 (defun make-compiled-debug-fun (compiler-debug-fun component)
311   (let ((table *compiled-debug-funs*))
312     (with-locked-hash-table (table)
313       (or (gethash compiler-debug-fun table)
314           (setf (gethash compiler-debug-fun table)
315                 (%make-compiled-debug-fun compiler-debug-fun component))))))
316
317 (defstruct (bogus-debug-fun
318             (:include debug-fun)
319             (:constructor make-bogus-debug-fun
320                           (%name &aux
321                                  (%lambda-list nil)
322                                  (%debug-vars nil)
323                                  (blocks nil)
324                                  (%function nil)))
325             (:copier nil))
326   %name)
327 \f
328 ;;;; DEBUG-BLOCKs
329
330 ;;; These exist for caching data stored in packed binary form in compiler
331 ;;; DEBUG-BLOCKs.
332 (defstruct (debug-block (:constructor nil)
333                         (:copier nil))
334   ;; Code-locations where execution continues after this block.
335   (successors nil :type list)
336   ;; This indicates whether the block is a special glob of code shared
337   ;; by various functions and tucked away elsewhere in a component.
338   ;; This kind of block has no start code-location. This slot is in
339   ;; all debug-blocks since it is an exported interface.
340   (elsewhere-p nil :type boolean))
341 (def!method print-object ((obj debug-block) str)
342   (print-unreadable-object (obj str :type t)
343     (prin1 (debug-block-fun-name obj) str)))
344
345 #!+sb-doc
346 (setf (fdocumentation 'debug-block-successors 'function)
347   "Return the list of possible code-locations where execution may continue
348    when the basic-block represented by debug-block completes its execution.")
349
350 #!+sb-doc
351 (setf (fdocumentation 'debug-block-elsewhere-p 'function)
352   "Return whether debug-block represents elsewhere code.")
353
354 (defstruct (compiled-debug-block (:include debug-block)
355                                  (:constructor
356                                   make-compiled-debug-block
357                                   (code-locations successors elsewhere-p))
358                                  (:copier nil))
359   ;; code-location information for the block
360   (code-locations nil :type simple-vector))
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 step-info &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:TYPEXPAND 'SB!C::LOCATION-KIND).
483   (kind :unparsed :type (or (member :unparsed) sb!c::location-kind))
484   (step-info :unparsed :type (or (member :unparsed :foo) simple-string)))
485 \f
486 ;;;; DEBUG-SOURCEs
487
488 ;;; Return the number of top level forms processed by the compiler
489 ;;; before compiling this source. If this source is uncompiled, this
490 ;;; is zero. This may be zero even if the source is compiled since the
491 ;;; first form in the first file compiled in one compilation, for
492 ;;; example, must have a root number of zero -- the compiler saw no
493 ;;; other top level forms before it.
494 (defun debug-source-root-number (debug-source)
495   (sb!c::debug-source-source-root debug-source))
496 \f
497 ;;;; frames
498
499 ;;; This is used in FIND-ESCAPED-FRAME and with the bogus components
500 ;;; and LRAs used for :FUN-END breakpoints. When a component's
501 ;;; debug-info slot is :BOGUS-LRA, then the REAL-LRA-SLOT contains the
502 ;;; real component to continue executing, as opposed to the bogus
503 ;;; component which appeared in some frame's LRA location.
504 (defconstant real-lra-slot sb!vm:code-constants-offset)
505
506 ;;; These are magically converted by the compiler.
507 (defun current-sp () (current-sp))
508 (defun current-fp () (current-fp))
509 (defun stack-ref (s n) (stack-ref s n))
510 (defun %set-stack-ref (s n value) (%set-stack-ref s n value))
511 (defun fun-code-header (fun) (fun-code-header fun))
512 (defun lra-code-header (lra) (lra-code-header lra))
513 (defun %make-lisp-obj (value) (%make-lisp-obj value))
514 (defun get-lisp-obj-address (thing) (get-lisp-obj-address thing))
515 (defun fun-word-offset (fun) (fun-word-offset fun))
516
517 #!-sb-fluid (declaim (inline control-stack-pointer-valid-p))
518 (defun control-stack-pointer-valid-p (x &optional (aligned t))
519   (declare (type system-area-pointer x))
520   (let* (#!-stack-grows-downward-not-upward
521          (control-stack-start
522           (descriptor-sap *control-stack-start*))
523          #!+stack-grows-downward-not-upward
524          (control-stack-end
525           (descriptor-sap *control-stack-end*)))
526     #!-stack-grows-downward-not-upward
527     (and (sap< x (current-sp))
528          (sap<= control-stack-start x)
529          (or (not aligned) (zerop (logand (sap-int x) sb!vm:fixnum-tag-mask))))
530     #!+stack-grows-downward-not-upward
531     (and (sap>= x (current-sp))
532          (sap> control-stack-end x)
533          (or (not aligned) (zerop (logand (sap-int x) sb!vm:fixnum-tag-mask))))))
534
535 (declaim (inline component-ptr-from-pc))
536 (sb!alien:define-alien-routine component-ptr-from-pc (system-area-pointer)
537   (pc system-area-pointer))
538
539 #!+(or x86 x86-64)
540 (sb!alien:define-alien-routine valid-lisp-pointer-p sb!alien:int
541   (pointer system-area-pointer))
542
543 (declaim (inline component-from-component-ptr))
544 (defun component-from-component-ptr (component-ptr)
545   (declare (type system-area-pointer component-ptr))
546   (make-lisp-obj (logior (sap-int component-ptr)
547                          sb!vm:other-pointer-lowtag)))
548
549 ;;;; (OR X86 X86-64) support
550
551 (defun compute-lra-data-from-pc (pc)
552   (declare (type system-area-pointer pc))
553   (let ((component-ptr (component-ptr-from-pc pc)))
554     (unless (sap= component-ptr (int-sap #x0))
555        (let* ((code (component-from-component-ptr component-ptr))
556               (code-header-len (* (get-header-data code) sb!vm:n-word-bytes))
557               (pc-offset (- (sap-int pc)
558                             (- (get-lisp-obj-address code)
559                                sb!vm:other-pointer-lowtag)
560                             code-header-len)))
561          ;;(format t "c-lra-fpc ~A ~A ~A~%" pc code pc-offset)
562          (values pc-offset code)))))
563
564 #!+(or x86 x86-64)
565 (progn
566
567 (defconstant sb!vm::nargs-offset #.sb!vm::ecx-offset)
568
569 ;;; Check for a valid return address - it could be any valid C/Lisp
570 ;;; address.
571 ;;;
572 ;;; XXX Could be a little smarter.
573 #!-sb-fluid (declaim (inline ra-pointer-valid-p))
574 (defun ra-pointer-valid-p (ra)
575   (declare (type system-area-pointer ra))
576   (and
577    ;; not the first page (which is unmapped)
578    ;;
579    ;; FIXME: Where is this documented? Is it really true of every CPU
580    ;; architecture? Is it even necessarily true in current SBCL?
581    (>= (sap-int ra) 4096)
582    ;; not a Lisp stack pointer
583    (not (control-stack-pointer-valid-p ra))))
584
585 ;;; Try to find a valid previous stack. This is complex on the x86 as
586 ;;; it can jump between C and Lisp frames. To help find a valid frame
587 ;;; it searches backwards.
588 ;;;
589 ;;; XXX Should probably check whether it has reached the bottom of the
590 ;;; stack.
591 ;;;
592 ;;; XXX Should handle interrupted frames, both Lisp and C. At present
593 ;;; it manages to find a fp trail, see linux hack below.
594 (declaim (maybe-inline x86-call-context))
595 (defun x86-call-context (fp)
596   (declare (type system-area-pointer fp))
597   (let ((ocfp (sap-ref-sap fp (sb!vm::frame-byte-offset ocfp-save-offset)))
598         (ra (sap-ref-sap fp (sb!vm::frame-byte-offset return-pc-save-offset))))
599     (if (and (control-stack-pointer-valid-p fp)
600              (sap> ocfp fp)
601              (control-stack-pointer-valid-p ocfp)
602              (ra-pointer-valid-p ra))
603         (values t ra ocfp)
604         (values nil (int-sap 0) (int-sap 0)))))
605
606 ) ; #+x86 PROGN
607 \f
608 ;;; Convert the descriptor into a SAP. The bits all stay the same, we just
609 ;;; change our notion of what we think they are.
610 #!-sb-fluid (declaim (inline descriptor-sap))
611 (defun descriptor-sap (x)
612   (int-sap (get-lisp-obj-address x)))
613
614 ;;; Return the top frame of the control stack as it was before calling
615 ;;; this function.
616 (defun top-frame ()
617   (/noshow0 "entering TOP-FRAME")
618   (compute-calling-frame (descriptor-sap (%caller-frame))
619                          (%caller-pc)
620                          nil))
621
622 ;;; Flush all of the frames above FRAME, and renumber all the frames
623 ;;; below FRAME.
624 (defun flush-frames-above (frame)
625   (setf (frame-up frame) nil)
626   (do ((number 0 (1+ number))
627        (frame frame (frame-%down frame)))
628       ((not (frame-p frame)))
629     (setf (frame-number frame) number)))
630
631 (defun find-saved-frame-down (fp up-frame)
632   (multiple-value-bind (saved-fp saved-pc) (sb!c:find-saved-fp-and-pc fp)
633     (when saved-fp
634       (compute-calling-frame (descriptor-sap saved-fp)
635                              (descriptor-sap saved-pc)
636                              up-frame))))
637
638 ;;; Return the frame immediately below FRAME on the stack; or when
639 ;;; FRAME is the bottom of the stack, return NIL.
640 (defun frame-down (frame)
641   (/noshow0 "entering FRAME-DOWN")
642   ;; We have to access the old-fp and return-pc out of frame and pass
643   ;; them to COMPUTE-CALLING-FRAME.
644   (let ((down (frame-%down frame)))
645     (if (eq down :unparsed)
646         (let ((debug-fun (frame-debug-fun frame)))
647           (/noshow0 "in DOWN :UNPARSED case")
648           (setf (frame-%down frame)
649                 (etypecase debug-fun
650                   (compiled-debug-fun
651                    (let ((c-d-f (compiled-debug-fun-compiler-debug-fun
652                                  debug-fun)))
653                      (compute-calling-frame
654                       (descriptor-sap
655                        (get-context-value
656                         frame ocfp-save-offset
657                         (sb!c::compiled-debug-fun-old-fp c-d-f)))
658                       (get-context-value
659                        frame lra-save-offset
660                        (sb!c::compiled-debug-fun-return-pc c-d-f))
661                       frame)))
662                   (bogus-debug-fun
663                    (let ((fp (frame-pointer frame)))
664                      (when (control-stack-pointer-valid-p fp)
665                        #!+(or x86 x86-64)
666                        (multiple-value-bind (ok ra ofp) (x86-call-context fp)
667                          (if ok
668                              (compute-calling-frame ofp ra frame)
669                              (find-saved-frame-down fp frame)))
670                        #!-(or x86 x86-64)
671                        (compute-calling-frame
672                         #!-alpha
673                         (sap-ref-sap fp (* ocfp-save-offset
674                                            sb!vm:n-word-bytes))
675                         #!+alpha
676                         (int-sap
677                          (sap-ref-32 fp (* ocfp-save-offset
678                                            sb!vm:n-word-bytes)))
679
680                         (stack-ref fp lra-save-offset)
681
682                         frame)))))))
683         down)))
684
685 ;;; Get the old FP or return PC out of FRAME. STACK-SLOT is the
686 ;;; standard save location offset on the stack. LOC is the saved
687 ;;; SC-OFFSET describing the main location.
688 (defun get-context-value (frame stack-slot loc)
689   (declare (type compiled-frame frame) (type unsigned-byte stack-slot)
690            (type sb!c:sc-offset loc))
691   (let ((pointer (frame-pointer frame))
692         (escaped (compiled-frame-escaped frame)))
693     (if escaped
694         (sub-access-debug-var-slot pointer loc escaped)
695         #!-(or x86 x86-64)
696         (stack-ref pointer stack-slot)
697         #!+(or x86 x86-64)
698         (ecase stack-slot
699           (#.ocfp-save-offset
700            (stack-ref pointer stack-slot))
701           (#.lra-save-offset
702            (sap-ref-sap pointer (sb!vm::frame-byte-offset stack-slot)))))))
703
704 (defun (setf get-context-value) (value frame stack-slot loc)
705   (declare (type compiled-frame frame) (type unsigned-byte stack-slot)
706            (type sb!c:sc-offset loc))
707   (let ((pointer (frame-pointer frame))
708         (escaped (compiled-frame-escaped frame)))
709     (if escaped
710         (sub-set-debug-var-slot pointer loc value escaped)
711         #!-(or x86 x86-64)
712         (setf (stack-ref pointer stack-slot) value)
713         #!+(or x86 x86-64)
714         (ecase stack-slot
715           (#.ocfp-save-offset
716            (setf (stack-ref pointer stack-slot) value))
717           (#.lra-save-offset
718            (setf (sap-ref-sap pointer (sb!vm::frame-byte-offset stack-slot))
719                  value))))))
720
721 (defun foreign-function-backtrace-name (sap)
722   (let ((name (sap-foreign-symbol sap)))
723     (if name
724         (format nil "foreign function: ~A" name)
725         (format nil "foreign function: #x~X" (sap-int sap)))))
726
727 ;;; This returns a frame for the one existing in time immediately
728 ;;; prior to the frame referenced by current-fp. This is current-fp's
729 ;;; caller or the next frame down the control stack. If there is no
730 ;;; down frame, this returns NIL for the bottom of the stack. UP-FRAME
731 ;;; is the up link for the resulting frame object, and it is null when
732 ;;; we call this to get the top of the stack.
733 ;;;
734 ;;; The current frame contains the pointer to the temporally previous
735 ;;; frame we want, and the current frame contains the pc at which we
736 ;;; will continue executing upon returning to that previous frame.
737 ;;;
738 ;;; Note: Sometimes LRA is actually a fixnum. This happens when lisp
739 ;;; calls into C. In this case, the code object is stored on the stack
740 ;;; after the LRA, and the LRA is the word offset.
741 #!-(or x86 x86-64)
742 (defun compute-calling-frame (caller lra up-frame)
743   (declare (type system-area-pointer caller))
744   (/noshow0 "entering COMPUTE-CALLING-FRAME")
745   (when (control-stack-pointer-valid-p caller)
746     (/noshow0 "in WHEN")
747     (multiple-value-bind (code pc-offset escaped)
748         (if lra
749             (multiple-value-bind (word-offset code)
750                 (if (fixnump lra)
751                     (let ((fp (frame-pointer up-frame)))
752                       (values lra
753                               (stack-ref fp (1+ lra-save-offset))))
754                     (values (get-header-data lra)
755                             (lra-code-header lra)))
756               (if code
757                   (values code
758                           (* (1+ (- word-offset (get-header-data code)))
759                              sb!vm:n-word-bytes)
760                           nil)
761                   (values :foreign-function
762                           0
763                           nil)))
764             (find-escaped-frame caller))
765       (if (and (code-component-p code)
766                (eq (%code-debug-info code) :bogus-lra))
767           (let ((real-lra (code-header-ref code real-lra-slot)))
768             (compute-calling-frame caller real-lra up-frame))
769           (let ((d-fun (case code
770                          (:undefined-function
771                           (make-bogus-debug-fun
772                            "undefined function"))
773                          (:foreign-function
774                           (make-bogus-debug-fun
775                            (foreign-function-backtrace-name
776                             (int-sap (get-lisp-obj-address lra)))))
777                          ((nil)
778                           (make-bogus-debug-fun
779                            "bogus stack frame"))
780                          (t
781                           (debug-fun-from-pc code pc-offset)))))
782             (/noshow0 "returning MAKE-COMPILED-FRAME from COMPUTE-CALLING-FRAME")
783             (make-compiled-frame caller up-frame d-fun
784                                  (code-location-from-pc d-fun pc-offset
785                                                         escaped)
786                                  (if up-frame (1+ (frame-number up-frame)) 0)
787                                  escaped))))))
788
789 #!+(or x86 x86-64)
790 (defun compute-calling-frame (caller ra up-frame)
791   (declare (type system-area-pointer caller ra))
792   (/noshow0 "entering COMPUTE-CALLING-FRAME")
793   (when (control-stack-pointer-valid-p caller)
794     (/noshow0 "in WHEN")
795     ;; First check for an escaped frame.
796     (multiple-value-bind (code pc-offset escaped) (find-escaped-frame caller)
797       (/noshow0 "at COND")
798       (cond (code
799              ;; If it's escaped it may be a function end breakpoint trap.
800              (when (and (code-component-p code)
801                         (eq (%code-debug-info code) :bogus-lra))
802                ;; If :bogus-lra grab the real lra.
803                (setq pc-offset (code-header-ref
804                                 code (1+ real-lra-slot)))
805                (setq code (code-header-ref code real-lra-slot))
806                (aver code)))
807             ((not escaped)
808              (multiple-value-setq (pc-offset code)
809                (compute-lra-data-from-pc ra))
810              (unless code
811                (setf code :foreign-function
812                      pc-offset 0))))
813       (let ((d-fun (case code
814                      (:undefined-function
815                       (make-bogus-debug-fun
816                        "undefined function"))
817                      (:foreign-function
818                       (make-bogus-debug-fun
819                        (foreign-function-backtrace-name ra)))
820                      ((nil)
821                       (make-bogus-debug-fun
822                        "bogus stack frame"))
823                      (t
824                       (debug-fun-from-pc code pc-offset)))))
825         (/noshow0 "returning MAKE-COMPILED-FRAME from COMPUTE-CALLING-FRAME")
826         (make-compiled-frame caller up-frame d-fun
827                              (code-location-from-pc d-fun pc-offset
828                                                     escaped)
829                              (if up-frame (1+ (frame-number up-frame)) 0)
830                              escaped)))))
831
832 (defun nth-interrupt-context (n)
833   (declare (type (unsigned-byte 32) n)
834            (optimize (speed 3) (safety 0)))
835   (sb!alien:sap-alien (sb!vm::current-thread-offset-sap
836                        (+ sb!vm::thread-interrupt-contexts-offset
837                           #!-alpha n
838                           #!+alpha (* 2 n)))
839                       (* os-context-t)))
840
841 #!+(or x86 x86-64)
842 (defun find-escaped-frame (frame-pointer)
843   (declare (type system-area-pointer frame-pointer))
844   (/noshow0 "entering FIND-ESCAPED-FRAME")
845   (dotimes (index *free-interrupt-context-index* (values nil 0 nil))
846       (/noshow0 "at head of WITH-ALIEN")
847     (let ((context (nth-interrupt-context index)))
848         (/noshow0 "got CONTEXT")
849         (when (= (sap-int frame-pointer)
850                  (sb!vm:context-register context sb!vm::cfp-offset))
851           (without-gcing
852            (/noshow0 "in WITHOUT-GCING")
853            (let* ((component-ptr (component-ptr-from-pc
854                                   (sb!vm:context-pc context)))
855                   (code (unless (sap= component-ptr (int-sap #x0))
856                           (component-from-component-ptr component-ptr))))
857              (/noshow0 "got CODE")
858              (when (null code)
859                (return (values code 0 context)))
860              (let* ((code-header-len (* (get-header-data code)
861                                         sb!vm:n-word-bytes))
862                     (pc-offset
863                      (- (sap-int (sb!vm:context-pc context))
864                         (- (get-lisp-obj-address code)
865                            sb!vm:other-pointer-lowtag)
866                         code-header-len)))
867                (/noshow "got PC-OFFSET")
868                (unless (<= 0 pc-offset
869                            (* (code-header-ref code sb!vm:code-code-size-slot)
870                               sb!vm:n-word-bytes))
871                  ;; We were in an assembly routine. Therefore, use the
872                  ;; LRA as the pc.
873                  ;;
874                  ;; FIXME: Should this be WARN or ERROR or what?
875                  (format t "** pc-offset ~S not in code obj ~S?~%"
876                          pc-offset code))
877                (/noshow0 "returning from FIND-ESCAPED-FRAME")
878                (return
879                (values code pc-offset context)))))))))
880
881 #!-(or x86 x86-64)
882 (defun find-escaped-frame (frame-pointer)
883   (declare (type system-area-pointer frame-pointer))
884   (/noshow0 "entering FIND-ESCAPED-FRAME")
885   (dotimes (index *free-interrupt-context-index* (values nil 0 nil))
886       (/noshow0 "at head of WITH-ALIEN")
887     (let ((scp (nth-interrupt-context index)))
888         (/noshow0 "got SCP")
889       (when (= (sap-int frame-pointer)
890                (sb!vm:context-register scp sb!vm::cfp-offset))
891         (without-gcing
892          (/noshow0 "in WITHOUT-GCING")
893          (let ((code (code-object-from-bits
894                       (sb!vm:context-register scp sb!vm::code-offset))))
895            (/noshow0 "got CODE")
896            (when (symbolp code)
897              (return (values code 0 scp)))
898            (let* ((code-header-len (* (get-header-data code)
899                                       sb!vm:n-word-bytes))
900                   (pc-offset
901                    (- (sap-int (sb!vm:context-pc scp))
902                       (- (get-lisp-obj-address code)
903                          sb!vm:other-pointer-lowtag)
904                       code-header-len)))
905              (let ((code-size (* (code-header-ref code
906                                                   sb!vm:code-code-size-slot)
907                                  sb!vm:n-word-bytes)))
908                (unless (<= 0 pc-offset code-size)
909                  ;; We were in an assembly routine.
910                  (multiple-value-bind (new-pc-offset computed-return)
911                      (find-pc-from-assembly-fun code scp)
912                    (setf pc-offset new-pc-offset)
913                    (unless (<= 0 pc-offset code-size)
914                      (cerror
915                       "Set PC-OFFSET to zero and continue backtrace."
916                       'bug
917                       :format-control
918                       "~@<PC-OFFSET (~D) not in code object. Frame details:~
919                        ~2I~:@_PC: #X~X~:@_CODE: ~S~:@_CODE FUN: ~S~:@_LRA: ~
920                        #X~X~:@_COMPUTED RETURN: #X~X.~:>"
921                       :format-arguments
922                       (list pc-offset
923                             (sap-int (sb!vm:context-pc scp))
924                             code
925                             (%code-entry-points code)
926                             (sb!vm:context-register scp sb!vm::lra-offset)
927                             computed-return))
928                      ;; We failed to pinpoint where PC is, but set
929                      ;; pc-offset to 0 to keep the backtrace from
930                      ;; exploding.
931                      (setf pc-offset 0)))))
932              (/noshow0 "returning from FIND-ESCAPED-FRAME")
933              (return
934                (if (eq (%code-debug-info code) :bogus-lra)
935                    (let ((real-lra (code-header-ref code
936                                                     real-lra-slot)))
937                      (values (lra-code-header real-lra)
938                              (get-header-data real-lra)
939                              nil))
940                    (values code pc-offset scp))))))))))
941
942 #!-(or x86 x86-64)
943 (defun find-pc-from-assembly-fun (code scp)
944   "Finds the PC for the return from an assembly routine properly.
945 For some architectures (such as PPC) this will not be the $LRA
946 register."
947   (let ((return-machine-address (sb!vm::return-machine-address scp))
948         (code-header-len (* (get-header-data code) sb!vm:n-word-bytes)))
949     (values (- return-machine-address
950                (- (get-lisp-obj-address code)
951                   sb!vm:other-pointer-lowtag)
952                code-header-len)
953             return-machine-address)))
954
955 ;;; Find the code object corresponding to the object represented by
956 ;;; bits and return it. We assume bogus functions correspond to the
957 ;;; undefined-function.
958 #!-(or x86 x86-64)
959 (defun code-object-from-bits (bits)
960   (declare (type (unsigned-byte 32) bits))
961   (let ((object (make-lisp-obj bits nil)))
962     (if (functionp object)
963         (or (fun-code-header object)
964             :undefined-function)
965         (let ((lowtag (lowtag-of object)))
966           (when (= lowtag sb!vm:other-pointer-lowtag)
967             (let ((widetag (widetag-of object)))
968               (cond ((= widetag sb!vm:code-header-widetag)
969                      object)
970                     ((= widetag sb!vm:return-pc-header-widetag)
971                      (lra-code-header object))
972                     (t
973                      nil))))))))
974 \f
975 ;;;; frame utilities
976
977 ;;; This returns a COMPILED-DEBUG-FUN for COMPONENT and PC. We fetch the
978 ;;; SB!C::DEBUG-INFO and run down its FUN-MAP to get a
979 ;;; SB!C::COMPILED-DEBUG-FUN from the PC. The result only needs to
980 ;;; reference the COMPONENT, for function constants, and the
981 ;;; SB!C::COMPILED-DEBUG-FUN.
982 (defun debug-fun-from-pc (component pc)
983   (let ((info (%code-debug-info component)))
984     (cond
985       ((not info)
986        ;; FIXME: It seems that most of these (at least on x86) are
987        ;; actually assembler routines, and could be named by looking
988        ;; at the sb-fasl:*assembler-routines*.
989        (make-bogus-debug-fun "no debug information for frame"))
990      ((eq info :bogus-lra)
991       (make-bogus-debug-fun "function end breakpoint"))
992      (t
993       (let* ((fun-map (sb!c::compiled-debug-info-fun-map info))
994              (len (length fun-map)))
995         (declare (type simple-vector fun-map))
996         (if (= len 1)
997             (make-compiled-debug-fun (svref fun-map 0) component)
998             (let ((i 1)
999                   (elsewhere-p
1000                    (>= pc (sb!c::compiled-debug-fun-elsewhere-pc
1001                            (svref fun-map 0)))))
1002               (declare (type sb!int:index i))
1003               (loop
1004                 (when (or (= i len)
1005                           (< pc (if elsewhere-p
1006                                     (sb!c::compiled-debug-fun-elsewhere-pc
1007                                      (svref fun-map (1+ i)))
1008                                     (svref fun-map i))))
1009                   (return (make-compiled-debug-fun
1010                            (svref fun-map (1- i))
1011                            component)))
1012                 (incf i 2)))))))))
1013
1014 ;;; This returns a code-location for the COMPILED-DEBUG-FUN,
1015 ;;; DEBUG-FUN, and the pc into its code vector. If we stopped at a
1016 ;;; breakpoint, find the CODE-LOCATION for that breakpoint. Otherwise,
1017 ;;; make an :UNSURE code location, so it can be filled in when we
1018 ;;; figure out what is going on.
1019 (defun code-location-from-pc (debug-fun pc escaped)
1020   (or (and (compiled-debug-fun-p debug-fun)
1021            escaped
1022            (let ((data (breakpoint-data
1023                         (compiled-debug-fun-component debug-fun)
1024                         pc nil)))
1025              (when (and data (breakpoint-data-breakpoints data))
1026                (let ((what (breakpoint-what
1027                             (first (breakpoint-data-breakpoints data)))))
1028                  (when (compiled-code-location-p what)
1029                    what)))))
1030       (make-compiled-code-location pc debug-fun)))
1031
1032 ;;; Return an alist mapping catch tags to CODE-LOCATIONs. These are
1033 ;;; CODE-LOCATIONs at which execution would continue with frame as the
1034 ;;; top frame if someone threw to the corresponding tag.
1035 (defun frame-catches (frame)
1036   (let ((catch (descriptor-sap sb!vm:*current-catch-block*))
1037         (reversed-result nil)
1038         (fp (frame-pointer frame)))
1039     (loop until (zerop (sap-int catch))
1040           finally (return (nreverse reversed-result))
1041           do
1042           (when (sap= fp
1043                       #!-alpha
1044                       (sap-ref-sap catch
1045                                    (* sb!vm:catch-block-current-cont-slot
1046                                       sb!vm:n-word-bytes))
1047                       #!+alpha
1048                       (int-sap
1049                        (sap-ref-32 catch
1050                                    (* sb!vm:catch-block-current-cont-slot
1051                                       sb!vm:n-word-bytes))))
1052             (let* (#!-(or x86 x86-64)
1053                    (lra (stack-ref catch sb!vm:catch-block-entry-pc-slot))
1054                    #!+(or x86 x86-64)
1055                    (ra (sap-ref-sap
1056                         catch (* sb!vm:catch-block-entry-pc-slot
1057                                  sb!vm:n-word-bytes)))
1058                    #!-(or x86 x86-64)
1059                    (component
1060                     (stack-ref catch sb!vm:catch-block-current-code-slot))
1061                    #!+(or x86 x86-64)
1062                    (component (component-from-component-ptr
1063                                (component-ptr-from-pc ra)))
1064                    (offset
1065                     #!-(or x86 x86-64)
1066                     (* (- (1+ (get-header-data lra))
1067                           (get-header-data component))
1068                        sb!vm:n-word-bytes)
1069                     #!+(or x86 x86-64)
1070                     (- (sap-int ra)
1071                        (- (get-lisp-obj-address component)
1072                           sb!vm:other-pointer-lowtag)
1073                        (* (get-header-data component) sb!vm:n-word-bytes))))
1074               (push (cons #!-(or x86 x86-64)
1075                           (stack-ref catch sb!vm:catch-block-tag-slot)
1076                           #!+(or x86 x86-64)
1077                           (make-lisp-obj
1078                            (sap-ref-word catch (* sb!vm:catch-block-tag-slot
1079                                                   sb!vm:n-word-bytes)))
1080                           (make-compiled-code-location
1081                            offset (frame-debug-fun frame)))
1082                     reversed-result)))
1083           (setf catch
1084                 #!-alpha
1085                 (sap-ref-sap catch
1086                              (* sb!vm:catch-block-previous-catch-slot
1087                                 sb!vm:n-word-bytes))
1088                 #!+alpha
1089                 (int-sap
1090                  (sap-ref-32 catch
1091                              (* sb!vm:catch-block-previous-catch-slot
1092                                 sb!vm:n-word-bytes)))))))
1093
1094 ;;; Modify the value of the OLD-TAG catches in FRAME to NEW-TAG
1095 (defun replace-frame-catch-tag (frame old-tag new-tag)
1096   (let ((catch (descriptor-sap sb!vm:*current-catch-block*))
1097         (fp (frame-pointer frame)))
1098     (loop until (zerop (sap-int catch))
1099           do (when (sap= fp
1100                          #!-alpha
1101                          (sap-ref-sap catch
1102                                       (* sb!vm:catch-block-current-cont-slot
1103                                          sb!vm:n-word-bytes))
1104                          #!+alpha
1105                          (int-sap
1106                           (sap-ref-32 catch
1107                                       (* sb!vm:catch-block-current-cont-slot
1108                                          sb!vm:n-word-bytes))))
1109                (let ((current-tag
1110                       #!-(or x86 x86-64)
1111                       (stack-ref catch sb!vm:catch-block-tag-slot)
1112                       #!+(or x86 x86-64)
1113                       (make-lisp-obj
1114                        (sap-ref-word catch (* sb!vm:catch-block-tag-slot
1115                                               sb!vm:n-word-bytes)))))
1116                  (when (eq current-tag old-tag)
1117                    #!-(or x86 x86-64)
1118                    (setf (stack-ref catch sb!vm:catch-block-tag-slot) new-tag)
1119                    #!+(or x86 x86-64)
1120                    (setf (sap-ref-word catch (* sb!vm:catch-block-tag-slot
1121                                                 sb!vm:n-word-bytes))
1122                          (get-lisp-obj-address new-tag)))))
1123           do (setf catch
1124                    #!-alpha
1125                    (sap-ref-sap catch
1126                                 (* sb!vm:catch-block-previous-catch-slot
1127                                    sb!vm:n-word-bytes))
1128                    #!+alpha
1129                    (int-sap
1130                     (sap-ref-32 catch
1131                                 (* sb!vm:catch-block-previous-catch-slot
1132                                    sb!vm:n-word-bytes)))))))
1133
1134
1135 \f
1136 ;;;; operations on DEBUG-FUNs
1137
1138 ;;; Execute the forms in a context with BLOCK-VAR bound to each
1139 ;;; DEBUG-BLOCK in DEBUG-FUN successively. Result is an optional
1140 ;;; form to execute for return values, and DO-DEBUG-FUN-BLOCKS
1141 ;;; returns nil if there is no result form. This signals a
1142 ;;; NO-DEBUG-BLOCKS condition when the DEBUG-FUN lacks
1143 ;;; DEBUG-BLOCK information.
1144 (defmacro do-debug-fun-blocks ((block-var debug-fun &optional result)
1145                                &body body)
1146   (let ((blocks (gensym))
1147         (i (gensym)))
1148     `(let ((,blocks (debug-fun-debug-blocks ,debug-fun)))
1149        (declare (simple-vector ,blocks))
1150        (dotimes (,i (length ,blocks) ,result)
1151          (let ((,block-var (svref ,blocks ,i)))
1152            ,@body)))))
1153
1154 ;;; Execute body in a context with VAR bound to each DEBUG-VAR in
1155 ;;; DEBUG-FUN. This returns the value of executing result (defaults to
1156 ;;; nil). This may iterate over only some of DEBUG-FUN's variables or
1157 ;;; none depending on debug policy; for example, possibly the
1158 ;;; compilation only preserved argument information.
1159 (defmacro do-debug-fun-vars ((var debug-fun &optional result) &body body)
1160   (let ((vars (gensym))
1161         (i (gensym)))
1162     `(let ((,vars (debug-fun-debug-vars ,debug-fun)))
1163        (declare (type (or null simple-vector) ,vars))
1164        (if ,vars
1165            (dotimes (,i (length ,vars) ,result)
1166              (let ((,var (svref ,vars ,i)))
1167                ,@body))
1168            ,result))))
1169
1170 ;;; Return the object of type FUNCTION associated with the DEBUG-FUN,
1171 ;;; or NIL if the function is unavailable or is non-existent as a user
1172 ;;; callable function object.
1173 (defun debug-fun-fun (debug-fun)
1174   (let ((cached-value (debug-fun-%function debug-fun)))
1175     (if (eq cached-value :unparsed)
1176         (setf (debug-fun-%function debug-fun)
1177               (etypecase debug-fun
1178                 (compiled-debug-fun
1179                  (let ((component
1180                         (compiled-debug-fun-component debug-fun))
1181                        (start-pc
1182                         (sb!c::compiled-debug-fun-start-pc
1183                          (compiled-debug-fun-compiler-debug-fun debug-fun))))
1184                    (do ((entry (%code-entry-points component)
1185                                (%simple-fun-next entry)))
1186                        ((null entry) nil)
1187                      (when (= start-pc
1188                               (sb!c::compiled-debug-fun-start-pc
1189                                (compiled-debug-fun-compiler-debug-fun
1190                                 (fun-debug-fun entry))))
1191                        (return entry)))))
1192                 (bogus-debug-fun nil)))
1193         cached-value)))
1194
1195 ;;; Return the name of the function represented by DEBUG-FUN. This may
1196 ;;; be a string or a cons; do not assume it is a symbol.
1197 (defun debug-fun-name (debug-fun)
1198   (declare (type debug-fun debug-fun))
1199   (etypecase debug-fun
1200     (compiled-debug-fun
1201      (sb!c::compiled-debug-fun-name
1202       (compiled-debug-fun-compiler-debug-fun debug-fun)))
1203     (bogus-debug-fun
1204      (bogus-debug-fun-%name debug-fun))))
1205
1206 ;;; Return a DEBUG-FUN that represents debug information for FUN.
1207 (defun fun-debug-fun (fun)
1208   (declare (type function fun))
1209   (let ((simple-fun (%fun-fun fun)))
1210     (let* ((name (%simple-fun-name simple-fun))
1211            (component (fun-code-header simple-fun))
1212            (res (find-if
1213                  (lambda (x)
1214                    (and (sb!c::compiled-debug-fun-p x)
1215                         (eq (sb!c::compiled-debug-fun-name x) name)
1216                         (eq (sb!c::compiled-debug-fun-kind x) nil)))
1217                  (sb!c::compiled-debug-info-fun-map
1218                   (%code-debug-info component)))))
1219       (if res
1220           (make-compiled-debug-fun res component)
1221           ;; KLUDGE: comment from CMU CL:
1222           ;;   This used to be the non-interpreted branch, but
1223           ;;   William wrote it to return the debug-fun of fun's XEP
1224           ;;   instead of fun's debug-fun. The above code does this
1225           ;;   more correctly, but it doesn't get or eliminate all
1226           ;;   appropriate cases. It mostly works, and probably
1227           ;;   works for all named functions anyway.
1228           ;; -- WHN 20000120
1229           (debug-fun-from-pc component
1230                              (* (- (fun-word-offset simple-fun)
1231                                    (get-header-data component))
1232                                 sb!vm:n-word-bytes))))))
1233
1234 ;;; Return the kind of the function, which is one of :OPTIONAL,
1235 ;;; :EXTERNAL, :TOPLEVEL, :CLEANUP, or NIL.
1236 (defun debug-fun-kind (debug-fun)
1237   ;; FIXME: This "is one of" information should become part of the function
1238   ;; declamation, not just a doc string
1239   (etypecase debug-fun
1240     (compiled-debug-fun
1241      (sb!c::compiled-debug-fun-kind
1242       (compiled-debug-fun-compiler-debug-fun debug-fun)))
1243     (bogus-debug-fun
1244      nil)))
1245
1246 ;;; Is there any variable information for DEBUG-FUN?
1247 (defun debug-var-info-available (debug-fun)
1248   (not (not (debug-fun-debug-vars debug-fun))))
1249
1250 ;;; Return a list of DEBUG-VARs in DEBUG-FUN having the same name
1251 ;;; and package as SYMBOL. If SYMBOL is uninterned, then this returns
1252 ;;; a list of DEBUG-VARs without package names and with the same name
1253 ;;; as symbol. The result of this function is limited to the
1254 ;;; availability of variable information in DEBUG-FUN; for
1255 ;;; example, possibly DEBUG-FUN only knows about its arguments.
1256 (defun debug-fun-symbol-vars (debug-fun symbol)
1257   (let ((vars (ambiguous-debug-vars debug-fun (symbol-name symbol)))
1258         (package (and (symbol-package symbol)
1259                       (package-name (symbol-package symbol)))))
1260     (delete-if (if (stringp package)
1261                    (lambda (var)
1262                      (let ((p (debug-var-package-name var)))
1263                        (or (not (stringp p))
1264                            (string/= p package))))
1265                    (lambda (var)
1266                      (stringp (debug-var-package-name var))))
1267                vars)))
1268
1269 ;;; Return a list of DEBUG-VARs in DEBUG-FUN whose names contain
1270 ;;; NAME-PREFIX-STRING as an initial substring. The result of this
1271 ;;; function is limited to the availability of variable information in
1272 ;;; debug-fun; for example, possibly debug-fun only knows
1273 ;;; about its arguments.
1274 (defun ambiguous-debug-vars (debug-fun name-prefix-string)
1275   (declare (simple-string name-prefix-string))
1276   (let ((variables (debug-fun-debug-vars debug-fun)))
1277     (declare (type (or null simple-vector) variables))
1278     (if variables
1279         (let* ((len (length variables))
1280                (prefix-len (length name-prefix-string))
1281                (pos (find-var name-prefix-string variables len))
1282                (res nil))
1283           (when pos
1284             ;; Find names from pos to variable's len that contain prefix.
1285             (do ((i pos (1+ i)))
1286                 ((= i len))
1287               (let* ((var (svref variables i))
1288                      (name (debug-var-symbol-name var))
1289                      (name-len (length name)))
1290                 (declare (simple-string name))
1291                 (when (/= (or (string/= name-prefix-string name
1292                                         :end1 prefix-len :end2 name-len)
1293                               prefix-len)
1294                           prefix-len)
1295                   (return))
1296                 (push var res)))
1297             (setq res (nreverse res)))
1298           res))))
1299
1300 ;;; This returns a position in VARIABLES for one containing NAME as an
1301 ;;; initial substring. END is the length of VARIABLES if supplied.
1302 (defun find-var (name variables &optional end)
1303   (declare (simple-vector variables)
1304            (simple-string name))
1305   (let ((name-len (length name)))
1306     (position name variables
1307               :test (lambda (x y)
1308                       (let* ((y (debug-var-symbol-name y))
1309                              (y-len (length y)))
1310                         (declare (simple-string y))
1311                         (and (>= y-len name-len)
1312                              (string= x y :end1 name-len :end2 name-len))))
1313               :end (or end (length variables)))))
1314
1315 ;;; Return a list representing the lambda-list for DEBUG-FUN. The
1316 ;;; list has the following structure:
1317 ;;;   (required-var1 required-var2
1318 ;;;    ...
1319 ;;;    (:optional var3 suppliedp-var4)
1320 ;;;    (:optional var5)
1321 ;;;    ...
1322 ;;;    (:rest var6) (:rest var7)
1323 ;;;    ...
1324 ;;;    (:keyword keyword-symbol var8 suppliedp-var9)
1325 ;;;    (:keyword keyword-symbol var10)
1326 ;;;    ...
1327 ;;;   )
1328 ;;; Each VARi is a DEBUG-VAR; however it may be the symbol :DELETED if
1329 ;;; it is unreferenced in DEBUG-FUN. This signals a
1330 ;;; LAMBDA-LIST-UNAVAILABLE condition when there is no argument list
1331 ;;; information.
1332 (defun debug-fun-lambda-list (debug-fun)
1333   (etypecase debug-fun
1334     (compiled-debug-fun (compiled-debug-fun-lambda-list debug-fun))
1335     (bogus-debug-fun nil)))
1336
1337 ;;; Note: If this has to compute the lambda list, it caches it in DEBUG-FUN.
1338 (defun compiled-debug-fun-lambda-list (debug-fun)
1339   (let ((lambda-list (debug-fun-%lambda-list debug-fun)))
1340     (cond ((eq lambda-list :unparsed)
1341            (multiple-value-bind (args argsp)
1342                (parse-compiled-debug-fun-lambda-list debug-fun)
1343              (setf (debug-fun-%lambda-list debug-fun) args)
1344              (if argsp
1345                  args
1346                  (debug-signal 'lambda-list-unavailable
1347                                :debug-fun debug-fun))))
1348           (lambda-list)
1349           ((bogus-debug-fun-p debug-fun)
1350            nil)
1351           ((sb!c::compiled-debug-fun-arguments
1352             (compiled-debug-fun-compiler-debug-fun debug-fun))
1353            ;; If the packed information is there (whether empty or not) as
1354            ;; opposed to being nil, then returned our cached value (nil).
1355            nil)
1356           (t
1357            ;; Our cached value is nil, and the packed lambda-list information
1358            ;; is nil, so we don't have anything available.
1359            (debug-signal 'lambda-list-unavailable
1360                          :debug-fun debug-fun)))))
1361
1362 ;;; COMPILED-DEBUG-FUN-LAMBDA-LIST calls this when a
1363 ;;; COMPILED-DEBUG-FUN has no lambda list information cached. It
1364 ;;; returns the lambda list as the first value and whether there was
1365 ;;; any argument information as the second value. Therefore,
1366 ;;; (VALUES NIL T) means there were no arguments, but (VALUES NIL NIL)
1367 ;;; means there was no argument information.
1368 (defun parse-compiled-debug-fun-lambda-list (debug-fun)
1369   (let ((args (sb!c::compiled-debug-fun-arguments
1370                (compiled-debug-fun-compiler-debug-fun debug-fun))))
1371     (cond
1372      ((not args)
1373       (values nil nil))
1374      ((eq args :minimal)
1375       (values (coerce (debug-fun-debug-vars debug-fun) 'list)
1376               t))
1377      (t
1378       (let ((vars (debug-fun-debug-vars debug-fun))
1379             (i 0)
1380             (len (length args))
1381             (res nil)
1382             (optionalp nil))
1383         (declare (type (or null simple-vector) vars))
1384         (loop
1385           (when (>= i len) (return))
1386           (let ((ele (aref args i)))
1387             (cond
1388              ((symbolp ele)
1389               (case ele
1390                 (sb!c::deleted
1391                  ;; Deleted required arg at beginning of args array.
1392                  (push :deleted res))
1393                 (sb!c::optional-args
1394                  (setf optionalp t))
1395                 (sb!c::supplied-p
1396                  ;; SUPPLIED-P var immediately following keyword or
1397                  ;; optional. Stick the extra var in the result
1398                  ;; element representing the keyword or optional,
1399                  ;; which is the previous one.
1400                  ;;
1401                  ;; FIXME: NCONC used for side-effect: the effect is defined,
1402                  ;; but this is bad style no matter what.
1403                  (nconc (car res)
1404                         (list (compiled-debug-fun-lambda-list-var
1405                                args (incf i) vars))))
1406                 (sb!c::rest-arg
1407                  (push (list :rest
1408                              (compiled-debug-fun-lambda-list-var
1409                               args (incf i) vars))
1410                        res))
1411                 (sb!c::more-arg
1412                  ;; Just ignore the fact that the next two args are
1413                  ;; the &MORE arg context and count, and act like they
1414                  ;; are regular arguments.
1415                  nil)
1416                 (t
1417                  ;; &KEY arg
1418                  (push (list :keyword
1419                              ele
1420                              (compiled-debug-fun-lambda-list-var
1421                               args (incf i) vars))
1422                        res))))
1423              (optionalp
1424               ;; We saw an optional marker, so the following
1425               ;; non-symbols are indexes indicating optional
1426               ;; variables.
1427               (push (list :optional (svref vars ele)) res))
1428              (t
1429               ;; Required arg at beginning of args array.
1430               (push (svref vars ele) res))))
1431           (incf i))
1432         (values (nreverse res) t))))))
1433
1434 ;;; This is used in COMPILED-DEBUG-FUN-LAMBDA-LIST.
1435 (defun compiled-debug-fun-lambda-list-var (args i vars)
1436   (declare (type (simple-array * (*)) args)
1437            (simple-vector vars))
1438   (let ((ele (aref args i)))
1439     (cond ((not (symbolp ele)) (svref vars ele))
1440           ((eq ele 'sb!c::deleted) :deleted)
1441           (t (error "malformed arguments description")))))
1442
1443 (defun compiled-debug-fun-debug-info (debug-fun)
1444   (%code-debug-info (compiled-debug-fun-component debug-fun)))
1445 \f
1446 ;;;; unpacking variable and basic block data
1447
1448 (defvar *parsing-buffer*
1449   (make-array 20 :adjustable t :fill-pointer t))
1450 (defvar *other-parsing-buffer*
1451   (make-array 20 :adjustable t :fill-pointer t))
1452 ;;; PARSE-DEBUG-BLOCKS and PARSE-DEBUG-VARS
1453 ;;; use this to unpack binary encoded information. It returns the
1454 ;;; values returned by the last form in body.
1455 ;;;
1456 ;;; This binds buffer-var to *parsing-buffer*, makes sure it starts at
1457 ;;; element zero, and makes sure if we unwind, we nil out any set
1458 ;;; elements for GC purposes.
1459 ;;;
1460 ;;; This also binds other-var to *other-parsing-buffer* when it is
1461 ;;; supplied, making sure it starts at element zero and that we nil
1462 ;;; out any elements if we unwind.
1463 ;;;
1464 ;;; This defines the local macro RESULT that takes a buffer, copies
1465 ;;; its elements to a resulting simple-vector, nil's out elements, and
1466 ;;; restarts the buffer at element zero. RESULT returns the
1467 ;;; simple-vector.
1468 (eval-when (:compile-toplevel :execute)
1469 (sb!xc:defmacro with-parsing-buffer ((buffer-var &optional other-var)
1470                                      &body body)
1471   (let ((len (gensym))
1472         (res (gensym)))
1473     `(unwind-protect
1474          (let ((,buffer-var *parsing-buffer*)
1475                ,@(if other-var `((,other-var *other-parsing-buffer*))))
1476            (setf (fill-pointer ,buffer-var) 0)
1477            ,@(if other-var `((setf (fill-pointer ,other-var) 0)))
1478            (macrolet ((result (buf)
1479                         `(let* ((,',len (length ,buf))
1480                                 (,',res (make-array ,',len)))
1481                            (replace ,',res ,buf :end1 ,',len :end2 ,',len)
1482                            (fill ,buf nil :end ,',len)
1483                            (setf (fill-pointer ,buf) 0)
1484                            ,',res)))
1485              ,@body))
1486      (fill *parsing-buffer* nil)
1487      ,@(if other-var `((fill *other-parsing-buffer* nil))))))
1488 ) ; EVAL-WHEN
1489
1490 ;;; The argument is a debug internals structure. This returns the
1491 ;;; DEBUG-BLOCKs for DEBUG-FUN, regardless of whether we have unpacked
1492 ;;; them yet. It signals a NO-DEBUG-BLOCKS condition if it can't
1493 ;;; return the blocks.
1494 (defun debug-fun-debug-blocks (debug-fun)
1495   (let ((blocks (debug-fun-blocks debug-fun)))
1496     (cond ((eq blocks :unparsed)
1497            (setf (debug-fun-blocks debug-fun)
1498                  (parse-debug-blocks debug-fun))
1499            (unless (debug-fun-blocks debug-fun)
1500              (debug-signal 'no-debug-blocks
1501                            :debug-fun debug-fun))
1502            (debug-fun-blocks debug-fun))
1503           (blocks)
1504           (t
1505            (debug-signal 'no-debug-blocks
1506                          :debug-fun debug-fun)))))
1507
1508 ;;; Return a SIMPLE-VECTOR of DEBUG-BLOCKs or NIL. NIL indicates there
1509 ;;; was no basic block information.
1510 (defun parse-debug-blocks (debug-fun)
1511   (etypecase debug-fun
1512     (compiled-debug-fun
1513      (parse-compiled-debug-blocks debug-fun))
1514     (bogus-debug-fun
1515      (debug-signal 'no-debug-blocks :debug-fun debug-fun))))
1516
1517 ;;; This does some of the work of PARSE-DEBUG-BLOCKS.
1518 (defun parse-compiled-debug-blocks (debug-fun)
1519   (let* ((var-count (length (debug-fun-debug-vars debug-fun)))
1520          (compiler-debug-fun (compiled-debug-fun-compiler-debug-fun
1521                               debug-fun))
1522          (blocks (sb!c::compiled-debug-fun-blocks compiler-debug-fun))
1523          ;; KLUDGE: 8 is a hard-wired constant in the compiler for the
1524          ;; element size of the packed binary representation of the
1525          ;; blocks data.
1526          (live-set-len (ceiling var-count 8))
1527          (tlf-number (sb!c::compiled-debug-fun-tlf-number compiler-debug-fun)))
1528     (unless blocks
1529       (return-from parse-compiled-debug-blocks nil))
1530     (macrolet ((aref+ (a i) `(prog1 (aref ,a ,i) (incf ,i))))
1531       (with-parsing-buffer (blocks-buffer locations-buffer)
1532         (let ((i 0)
1533               (len (length blocks))
1534               (last-pc 0))
1535           (loop
1536             (when (>= i len) (return))
1537             (let ((succ-and-flags (aref+ blocks i))
1538                   (successors nil))
1539               (declare (type (unsigned-byte 8) succ-and-flags)
1540                        (list successors))
1541               (dotimes (k (ldb sb!c::compiled-debug-block-nsucc-byte
1542                                succ-and-flags))
1543                 (push (sb!c:read-var-integer blocks i) successors))
1544               (let* ((locations
1545                       (dotimes (k (sb!c:read-var-integer blocks i)
1546                                   (result locations-buffer))
1547                         (let ((kind (svref sb!c::*compiled-code-location-kinds*
1548                                            (aref+ blocks i)))
1549                               (pc (+ last-pc
1550                                      (sb!c:read-var-integer blocks i)))
1551                               (tlf-offset (or tlf-number
1552                                               (sb!c:read-var-integer blocks i)))
1553                               (form-number (sb!c:read-var-integer blocks i))
1554                               (live-set (sb!c:read-packed-bit-vector
1555                                          live-set-len blocks i))
1556                               (step-info (sb!c:read-var-string blocks i)))
1557                           (vector-push-extend (make-known-code-location
1558                                                pc debug-fun tlf-offset
1559                                                form-number live-set kind
1560                                                step-info)
1561                                               locations-buffer)
1562                           (setf last-pc pc))))
1563                      (block (make-compiled-debug-block
1564                              locations successors
1565                              (not (zerop (logand
1566                                           sb!c::compiled-debug-block-elsewhere-p
1567                                           succ-and-flags))))))
1568                 (vector-push-extend block blocks-buffer)
1569                 (dotimes (k (length locations))
1570                   (setf (code-location-%debug-block (svref locations k))
1571                         block))))))
1572         (let ((res (result blocks-buffer)))
1573           (declare (simple-vector res))
1574           (dotimes (i (length res))
1575             (let* ((block (svref res i))
1576                    (succs nil))
1577               (dolist (ele (debug-block-successors block))
1578                 (push (svref res ele) succs))
1579               (setf (debug-block-successors block) succs)))
1580           res)))))
1581
1582 ;;; The argument is a debug internals structure. This returns NIL if
1583 ;;; there is no variable information. It returns an empty
1584 ;;; simple-vector if there were no locals in the function. Otherwise
1585 ;;; it returns a SIMPLE-VECTOR of DEBUG-VARs.
1586 (defun debug-fun-debug-vars (debug-fun)
1587   (let ((vars (debug-fun-%debug-vars debug-fun)))
1588     (if (eq vars :unparsed)
1589         (setf (debug-fun-%debug-vars debug-fun)
1590               (etypecase debug-fun
1591                 (compiled-debug-fun
1592                  (parse-compiled-debug-vars debug-fun))
1593                 (bogus-debug-fun nil)))
1594         vars)))
1595
1596 ;;; VARS is the parsed variables for a minimal debug function. We need
1597 ;;; to assign names of the form ARG-NNN. We must pad with leading
1598 ;;; zeros, since the arguments must be in alphabetical order.
1599 (defun assign-minimal-var-names (vars)
1600   (declare (simple-vector vars))
1601   (let* ((len (length vars))
1602          (width (length (format nil "~W" (1- len)))))
1603     (dotimes (i len)
1604       (without-package-locks
1605         (setf (compiled-debug-var-symbol (svref vars i))
1606               (intern (format nil "ARG-~V,'0D" width i)
1607                       ;; The cross-compiler won't dump literal package
1608                       ;; references because the target package objects
1609                       ;; aren't created until partway through
1610                       ;; cold-init. In lieu of adding smarts to the
1611                       ;; build framework to handle this, we use an
1612                       ;; explicit load-time-value form.
1613                       (load-time-value (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               (setf (compiled-code-location-step-info code-location)
1870                     (compiled-code-location-step-info loc))
1871               (return-from fill-in-code-location t))))))))
1872 \f
1873 ;;;; operations on DEBUG-BLOCKs
1874
1875 ;;; Execute FORMS in a context with CODE-VAR bound to each
1876 ;;; CODE-LOCATION in DEBUG-BLOCK, and return the value of RESULT.
1877 (defmacro do-debug-block-locations ((code-var debug-block &optional result)
1878                                     &body body)
1879   (let ((code-locations (gensym))
1880         (i (gensym)))
1881     `(let ((,code-locations (debug-block-code-locations ,debug-block)))
1882        (declare (simple-vector ,code-locations))
1883        (dotimes (,i (length ,code-locations) ,result)
1884          (let ((,code-var (svref ,code-locations ,i)))
1885            ,@body)))))
1886
1887 ;;; Return the name of the function represented by DEBUG-FUN.
1888 ;;; This may be a string or a cons; do not assume it is a symbol.
1889 (defun debug-block-fun-name (debug-block)
1890   (etypecase debug-block
1891     (compiled-debug-block
1892      (let ((code-locs (compiled-debug-block-code-locations debug-block)))
1893        (declare (simple-vector code-locs))
1894        (if (zerop (length code-locs))
1895            "??? Can't get name of debug-block's function."
1896            (debug-fun-name
1897             (code-location-debug-fun (svref code-locs 0))))))
1898     ;; (There used to be more cases back before sbcl-0.7.0, when we
1899     ;; did special tricks to debug the IR1 interpreter.)
1900     ))
1901
1902 (defun debug-block-code-locations (debug-block)
1903   (etypecase debug-block
1904     (compiled-debug-block
1905      (compiled-debug-block-code-locations debug-block))
1906     ;; (There used to be more cases back before sbcl-0.7.0, when we
1907     ;; did special tricks to debug the IR1 interpreter.)
1908     ))
1909 \f
1910 ;;;; operations on debug variables
1911
1912 (defun debug-var-symbol-name (debug-var)
1913   (symbol-name (debug-var-symbol debug-var)))
1914
1915 ;;; FIXME: Make sure that this isn't called anywhere that it wouldn't
1916 ;;; be acceptable to have NIL returned, or that it's only called on
1917 ;;; DEBUG-VARs whose symbols have non-NIL packages.
1918 (defun debug-var-package-name (debug-var)
1919   (package-name (symbol-package (debug-var-symbol debug-var))))
1920
1921 ;;; Return the value stored for DEBUG-VAR in frame, or if the value is
1922 ;;; not :VALID, then signal an INVALID-VALUE error.
1923 (defun debug-var-valid-value (debug-var frame)
1924   (unless (eq (debug-var-validity debug-var (frame-code-location frame))
1925               :valid)
1926     (error 'invalid-value :debug-var debug-var :frame frame))
1927   (debug-var-value debug-var frame))
1928
1929 ;;; Returns the value stored for DEBUG-VAR in frame. The value may be
1930 ;;; invalid. This is SETFable.
1931 (defun debug-var-value (debug-var frame)
1932   (aver (typep frame 'compiled-frame))
1933   (let ((res (access-compiled-debug-var-slot debug-var frame)))
1934     (if (indirect-value-cell-p res)
1935         (value-cell-ref res)
1936         res)))
1937
1938 ;;; This returns what is stored for the variable represented by
1939 ;;; DEBUG-VAR relative to the FRAME. This may be an indirect value
1940 ;;; cell if the variable is both closed over and set.
1941 (defun access-compiled-debug-var-slot (debug-var frame)
1942   (declare (optimize (speed 1)))
1943   (let ((escaped (compiled-frame-escaped frame)))
1944     (if escaped
1945         (sub-access-debug-var-slot
1946          (frame-pointer frame)
1947          (compiled-debug-var-sc-offset debug-var)
1948          escaped)
1949       (sub-access-debug-var-slot
1950        (frame-pointer frame)
1951        (or (compiled-debug-var-save-sc-offset debug-var)
1952            (compiled-debug-var-sc-offset debug-var))))))
1953
1954 ;;; a helper function for working with possibly-invalid values:
1955 ;;; Do (%MAKE-LISP-OBJ VAL) only if the value looks valid.
1956 ;;;
1957 ;;; (Such values can arise in registers on machines with conservative
1958 ;;; GC, and might also arise in debug variable locations when
1959 ;;; those variables are invalid.)
1960 (defun make-lisp-obj (val &optional (errorp t))
1961   (if (or
1962        ;; fixnum
1963        (zerop (logand val sb!vm:fixnum-tag-mask))
1964        ;; immediate single float, 64-bit only
1965        #!+#.(cl:if (cl:= sb!vm::n-machine-word-bits 64) '(and) '(or))
1966        (= (logand val #xff) sb!vm:single-float-widetag)
1967        ;; character
1968        (and (zerop (logandc2 val #x1fffffff)) ; Top bits zero
1969             (= (logand val #xff) sb!vm:character-widetag)) ; char tag
1970        ;; unbound marker
1971        (= val sb!vm:unbound-marker-widetag)
1972        ;; pointer
1973        #!+(or x86 x86-64)
1974        (not (zerop (valid-lisp-pointer-p (int-sap val))))
1975        ;; FIXME: There is no fundamental reason not to use the above
1976        ;; function on other platforms as well, but I didn't have
1977        ;; others available while doing this. --NS 2007-06-21
1978        #!-(or x86 x86-64)
1979        (and (logbitp 0 val)
1980             (or (< sb!vm:read-only-space-start val
1981                    (* sb!vm:*read-only-space-free-pointer*
1982                       sb!vm:n-word-bytes))
1983                 (< sb!vm:static-space-start val
1984                    (* sb!vm:*static-space-free-pointer*
1985                       sb!vm:n-word-bytes))
1986                 (< (current-dynamic-space-start) val
1987                    (sap-int (dynamic-space-free-pointer))))))
1988       (values (%make-lisp-obj val) t)
1989       (if errorp
1990           (error "~S is not a valid argument to ~S"
1991                  val 'make-lisp-obj)
1992           (values (make-unprintable-object (format nil "invalid object #x~X" val))
1993                   nil))))
1994
1995 (defun sub-access-debug-var-slot (fp sc-offset &optional escaped)
1996   ;; NOTE: The long-float support in here is obviously decayed.  When
1997   ;; the x86oid and non-x86oid versions of this function were unified,
1998   ;; the behavior of long-floats was preserved, which only served to
1999   ;; highlight its brokenness.
2000   (macrolet ((with-escaped-value ((var) &body forms)
2001                `(if escaped
2002                     (let ((,var (sb!vm:context-register
2003                                  escaped
2004                                  (sb!c:sc-offset-offset sc-offset))))
2005                       ,@forms)
2006                     :invalid-value-for-unescaped-register-storage))
2007              (escaped-float-value (format)
2008                `(if escaped
2009                     (sb!vm:context-float-register
2010                      escaped
2011                      (sb!c:sc-offset-offset sc-offset)
2012                      ',format)
2013                     :invalid-value-for-unescaped-register-storage))
2014              (escaped-complex-float-value (format offset)
2015                `(if escaped
2016                     (complex
2017                      (sb!vm:context-float-register
2018                       escaped (sb!c:sc-offset-offset sc-offset) ',format)
2019                      (sb!vm:context-float-register
2020                       escaped (+ (sb!c:sc-offset-offset sc-offset) ,offset) ',format))
2021                     :invalid-value-for-unescaped-register-storage))
2022              (with-nfp ((var) &body body)
2023                ;; x86oids have no separate number stack, so dummy it
2024                ;; up for them.
2025                #!+(or x86 x86-64)
2026                `(let ((,var fp))
2027                   ,@body)
2028                #!-(or x86 x86-64)
2029                `(let ((,var (if escaped
2030                                 (sb!sys:int-sap
2031                                  (sb!vm:context-register escaped
2032                                                          sb!vm::nfp-offset))
2033                                 #!-alpha
2034                                 (sb!sys:sap-ref-sap fp (* nfp-save-offset
2035                                                           sb!vm:n-word-bytes))
2036                                 #!+alpha
2037                                 (sb!vm::make-number-stack-pointer
2038                                  (sb!sys:sap-ref-32 fp (* nfp-save-offset
2039                                                           sb!vm:n-word-bytes))))))
2040                   ,@body))
2041              (stack-frame-offset (data-width offset)
2042                #!+(or x86 x86-64)
2043                `(sb!vm::frame-byte-offset (+ (sb!c:sc-offset-offset sc-offset)
2044                                            (1- ,data-width)
2045                                            ,offset))
2046                #!-(or x86 x86-64)
2047                (declare (ignore data-width))
2048                #!-(or x86 x86-64)
2049                `(* (+ (sb!c:sc-offset-offset sc-offset) ,offset)
2050                    sb!vm:n-word-bytes)))
2051     (ecase (sb!c:sc-offset-scn sc-offset)
2052       ((#.sb!vm:any-reg-sc-number
2053         #.sb!vm:descriptor-reg-sc-number
2054         #!+rt #.sb!vm:word-pointer-reg-sc-number)
2055        (without-gcing
2056         (with-escaped-value (val)
2057           (make-lisp-obj val nil))))
2058       (#.sb!vm:character-reg-sc-number
2059        (with-escaped-value (val)
2060          (code-char val)))
2061       (#.sb!vm:sap-reg-sc-number
2062        (with-escaped-value (val)
2063          (sb!sys:int-sap val)))
2064       (#.sb!vm:signed-reg-sc-number
2065        (with-escaped-value (val)
2066          (if (logbitp (1- sb!vm:n-word-bits) val)
2067              (logior val (ash -1 sb!vm:n-word-bits))
2068              val)))
2069       (#.sb!vm:unsigned-reg-sc-number
2070        (with-escaped-value (val)
2071          val))
2072       #!-(or x86 x86-64)
2073       (#.sb!vm:non-descriptor-reg-sc-number
2074        (error "Local non-descriptor register access?"))
2075       #!-(or x86 x86-64)
2076       (#.sb!vm:interior-reg-sc-number
2077        (error "Local interior register access?"))
2078       (#.sb!vm:single-reg-sc-number
2079        (escaped-float-value single-float))
2080       (#.sb!vm:double-reg-sc-number
2081        (escaped-float-value double-float))
2082       #!+long-float
2083       (#.sb!vm:long-reg-sc-number
2084        (escaped-float-value long-float))
2085       (#.sb!vm:complex-single-reg-sc-number
2086        (escaped-complex-float-value single-float 1))
2087       (#.sb!vm:complex-double-reg-sc-number
2088        (escaped-complex-float-value double-float #!+sparc 2 #!-sparc 1))
2089       #!+long-float
2090       (#.sb!vm:complex-long-reg-sc-number
2091        (escaped-complex-float-value long-float
2092                                     #!+sparc 4 #!+(or x86 x86-64) 1
2093                                     #!-(or sparc x86 x86-64) 0))
2094       (#.sb!vm:single-stack-sc-number
2095        (with-nfp (nfp)
2096          (sb!sys:sap-ref-single nfp (stack-frame-offset 1 0))))
2097       (#.sb!vm:double-stack-sc-number
2098        (with-nfp (nfp)
2099          (sb!sys:sap-ref-double nfp (stack-frame-offset 2 0))))
2100       #!+long-float
2101       (#.sb!vm:long-stack-sc-number
2102        (with-nfp (nfp)
2103          (sb!sys:sap-ref-long nfp (stack-frame-offset 3 0))))
2104       (#.sb!vm:complex-single-stack-sc-number
2105        (with-nfp (nfp)
2106          (complex
2107           (sb!sys:sap-ref-single nfp (stack-frame-offset 1 0))
2108           (sb!sys:sap-ref-single nfp (stack-frame-offset 1 1)))))
2109       (#.sb!vm:complex-double-stack-sc-number
2110        (with-nfp (nfp)
2111          (complex
2112           (sb!sys:sap-ref-double nfp (stack-frame-offset 2 0))
2113           (sb!sys:sap-ref-double nfp (stack-frame-offset 2 2)))))
2114       #!+long-float
2115       (#.sb!vm:complex-long-stack-sc-number
2116        (with-nfp (nfp)
2117          (complex
2118           (sb!sys:sap-ref-long nfp (stack-frame-offset 3 0))
2119           (sb!sys:sap-ref-long nfp
2120                                (stack-frame-offset 3 #!+sparc 4
2121                                                    #!+(or x86 x86-64) 3
2122                                                    #!-(or sparc x86 x86-64) 0)))))
2123       (#.sb!vm:control-stack-sc-number
2124        (stack-ref fp (sb!c:sc-offset-offset sc-offset)))
2125       (#.sb!vm:character-stack-sc-number
2126        (with-nfp (nfp)
2127          (code-char (sb!sys:sap-ref-word nfp (stack-frame-offset 1 0)))))
2128       (#.sb!vm:unsigned-stack-sc-number
2129        (with-nfp (nfp)
2130          (sb!sys:sap-ref-word nfp (stack-frame-offset 1 0))))
2131       (#.sb!vm:signed-stack-sc-number
2132        (with-nfp (nfp)
2133          (sb!sys:signed-sap-ref-word nfp (stack-frame-offset 1 0))))
2134       (#.sb!vm:sap-stack-sc-number
2135        (with-nfp (nfp)
2136          (sb!sys:sap-ref-sap nfp (stack-frame-offset 1 0)))))))
2137
2138 ;;; This stores value as the value of DEBUG-VAR in FRAME. In the
2139 ;;; COMPILED-DEBUG-VAR case, access the current value to determine if
2140 ;;; it is an indirect value cell. This occurs when the variable is
2141 ;;; both closed over and set.
2142 (defun %set-debug-var-value (debug-var frame new-value)
2143   (aver (typep frame 'compiled-frame))
2144   (let ((old-value (access-compiled-debug-var-slot debug-var frame)))
2145     (if (indirect-value-cell-p old-value)
2146         (value-cell-set old-value new-value)
2147         (set-compiled-debug-var-slot debug-var frame new-value)))
2148   new-value)
2149
2150 ;;; This stores VALUE for the variable represented by debug-var
2151 ;;; relative to the frame. This assumes the location directly contains
2152 ;;; the variable's value; that is, there is no indirect value cell
2153 ;;; currently there in case the variable is both closed over and set.
2154 (defun set-compiled-debug-var-slot (debug-var frame value)
2155   (let ((escaped (compiled-frame-escaped frame)))
2156     (if escaped
2157         (sub-set-debug-var-slot (frame-pointer frame)
2158                                 (compiled-debug-var-sc-offset debug-var)
2159                                 value escaped)
2160         (sub-set-debug-var-slot
2161          (frame-pointer frame)
2162          (or (compiled-debug-var-save-sc-offset debug-var)
2163              (compiled-debug-var-sc-offset debug-var))
2164          value))))
2165
2166 (defun sub-set-debug-var-slot (fp sc-offset value &optional escaped)
2167   ;; Like sub-access-debug-var-slot, this is the unification of two
2168   ;; divergent copy-pasted functions.  The astute reviewer will notice
2169   ;; that long-floats are messed up here as well, that x86oids
2170   ;; apparently don't support accessing float values that are in
2171   ;; registers, and that non-x86oids store the real part of a float
2172   ;; for both the real and imaginary parts of a complex on the stack
2173   ;; (but not in registers, oddly enough).  Some research has
2174   ;; indicated that the different forms of THE used for validating the
2175   ;; type of complex float components between x86oid and non-x86oid
2176   ;; systems are only significant in the case of using a non-complex
2177   ;; number as input (as the non-x86oid case effectively converts
2178   ;; non-complex numbers to complex ones and the x86oid case will
2179   ;; error out).  That said, the error message from entering a value
2180   ;; of the wrong type will be slightly easier to understand on x86oid
2181   ;; systems.
2182   (macrolet ((set-escaped-value (val)
2183                `(if escaped
2184                     (setf (sb!vm:context-register
2185                            escaped
2186                            (sb!c:sc-offset-offset sc-offset))
2187                           ,val)
2188                     value))
2189              (set-escaped-float-value (format val)
2190                `(if escaped
2191                     (setf (sb!vm:context-float-register
2192                            escaped
2193                            (sb!c:sc-offset-offset sc-offset)
2194                            ',format)
2195                           ,val)
2196                     value))
2197              (set-escaped-complex-float-value (format offset val)
2198                `(progn
2199                   (when escaped
2200                     (setf (sb!vm:context-float-register
2201                            escaped (sb!c:sc-offset-offset sc-offset) ',format)
2202                           (realpart value))
2203                     (setf (sb!vm:context-float-register
2204                            escaped (+ (sb!c:sc-offset-offset sc-offset) ,offset)
2205                            ',format)
2206                           (imagpart value)))
2207                   ,val))
2208              (with-nfp ((var) &body body)
2209                ;; x86oids have no separate number stack, so dummy it
2210                ;; up for them.
2211                #!+(or x86 x86-64)
2212                `(let ((,var fp))
2213                   ,@body)
2214                #!-(or x86 x86-64)
2215                `(let ((,var (if escaped
2216                                 (int-sap
2217                                  (sb!vm:context-register escaped
2218                                                          sb!vm::nfp-offset))
2219                                 #!-alpha
2220                                 (sap-ref-sap fp
2221                                              (* nfp-save-offset
2222                                                 sb!vm:n-word-bytes))
2223                                 #!+alpha
2224                                 (sb!vm::make-number-stack-pointer
2225                                  (sap-ref-32 fp
2226                                              (* nfp-save-offset
2227                                                 sb!vm:n-word-bytes))))))
2228                   ,@body))
2229              (stack-frame-offset (data-width offset)
2230                #!+(or x86 x86-64)
2231                `(sb!vm::frame-byte-offset (+ (sb!c:sc-offset-offset sc-offset)
2232                                            (1- ,data-width)
2233                                            ,offset))
2234                #!-(or x86 x86-64)
2235                (declare (ignore data-width))
2236                #!-(or x86 x86-64)
2237                `(* (+ (sb!c:sc-offset-offset sc-offset) ,offset)
2238                    sb!vm:n-word-bytes)))
2239     (ecase (sb!c:sc-offset-scn sc-offset)
2240       ((#.sb!vm:any-reg-sc-number
2241         #.sb!vm:descriptor-reg-sc-number
2242         #!+rt #.sb!vm:word-pointer-reg-sc-number)
2243        (without-gcing
2244         (set-escaped-value
2245           (get-lisp-obj-address value))))
2246       (#.sb!vm:character-reg-sc-number
2247        (set-escaped-value (char-code value)))
2248       (#.sb!vm:sap-reg-sc-number
2249        (set-escaped-value (sap-int value)))
2250       (#.sb!vm:signed-reg-sc-number
2251        (set-escaped-value (logand value (1- (ash 1 sb!vm:n-word-bits)))))
2252       (#.sb!vm:unsigned-reg-sc-number
2253        (set-escaped-value value))
2254       #!-(or x86 x86-64)
2255       (#.sb!vm:non-descriptor-reg-sc-number
2256        (error "Local non-descriptor register access?"))
2257       #!-(or x86 x86-64)
2258       (#.sb!vm:interior-reg-sc-number
2259        (error "Local interior register access?"))
2260       (#.sb!vm:single-reg-sc-number
2261        #!-(or x86 x86-64) ;; don't have escaped floats.
2262        (set-escaped-float-value single-float value))
2263       (#.sb!vm:double-reg-sc-number
2264        #!-(or x86 x86-64) ;; don't have escaped floats -- still in npx?
2265        (set-escaped-float-value double-float value))
2266       #!+long-float
2267       (#.sb!vm:long-reg-sc-number
2268        #!-(or x86 x86-64) ;; don't have escaped floats -- still in npx?
2269        (set-escaped-float-value long-float value))
2270       #!-(or x86 x86-64)
2271       (#.sb!vm:complex-single-reg-sc-number
2272        (set-escaped-complex-float-value single-float 1 value))
2273       #!-(or x86 x86-64)
2274       (#.sb!vm:complex-double-reg-sc-number
2275        (set-escaped-complex-float-value double-float #!+sparc 2 #!-sparc 1 value))
2276       #!+(and long-float (not (or x86 x86-64)))
2277       (#.sb!vm:complex-long-reg-sc-number
2278        (set-escaped-complex-float-value long-float #!+sparc 4 #!-sparc 0 value))
2279       (#.sb!vm:single-stack-sc-number
2280        (with-nfp (nfp)
2281          (setf (sap-ref-single nfp (stack-frame-offset 1 0))
2282                (the single-float value))))
2283       (#.sb!vm:double-stack-sc-number
2284        (with-nfp (nfp)
2285          (setf (sap-ref-double nfp (stack-frame-offset 2 0))
2286                (the double-float value))))
2287       #!+long-float
2288       (#.sb!vm:long-stack-sc-number
2289        (with-nfp (nfp)
2290          (setf (sap-ref-long nfp (stack-frame-offset 3 0))
2291                (the long-float value))))
2292       (#.sb!vm:complex-single-stack-sc-number
2293        (with-nfp (nfp)
2294          (setf (sap-ref-single
2295                 nfp (stack-frame-offset 1 0))
2296                #!+(or x86 x86-64)
2297                (realpart (the (complex single-float) value))
2298                #!-(or x86 x86-64)
2299                (the single-float (realpart value)))
2300          (setf (sap-ref-single
2301                 nfp (stack-frame-offset 1 1))
2302                #!+(or x86 x86-64)
2303                (imagpart (the (complex single-float) value))
2304                #!-(or x86 x86-64)
2305                (the single-float (realpart value)))))
2306       (#.sb!vm:complex-double-stack-sc-number
2307        (with-nfp (nfp)
2308          (setf (sap-ref-double
2309                 nfp (stack-frame-offset 2 0))
2310                #!+(or x86 x86-64)
2311                (realpart (the (complex double-float) value))
2312                #!-(or x86 x86-64)
2313                (the double-float (realpart value)))
2314          (setf (sap-ref-double
2315                 nfp (stack-frame-offset 2 2))
2316                #!+(or x86 x86-64)
2317                (imagpart (the (complex double-float) value))
2318                #!-(or x86 x86-64)
2319                (the double-float (realpart value)))))
2320       #!+long-float
2321       (#.sb!vm:complex-long-stack-sc-number
2322        (with-nfp (nfp)
2323          (setf (sap-ref-long
2324                 nfp (stack-frame-offset 3 0))
2325                #!+(or x86 x86-64)
2326                (realpart (the (complex long-float) value))
2327                #!-(or x86 x86-64)
2328                (the long-float (realpart value)))
2329          (setf (sap-ref-long
2330                 nfp (stack-frame-offset 3 #!+sparc 4
2331                                         #!+(or x86 x86-64) 3
2332                                         #!-(or sparc x86 x86-64) 0))
2333                #!+(or x86 x86-64)
2334                (imagpart (the (complex long-float) value))
2335                #!-(or x86 x86-64)
2336                (the long-float (realpart value)))))
2337       (#.sb!vm:control-stack-sc-number
2338        (setf (stack-ref fp (sb!c:sc-offset-offset sc-offset)) value))
2339       (#.sb!vm:character-stack-sc-number
2340        (with-nfp (nfp)
2341          (setf (sap-ref-word nfp (stack-frame-offset 1 0))
2342                (char-code (the character value)))))
2343       (#.sb!vm:unsigned-stack-sc-number
2344        (with-nfp (nfp)
2345          (setf (sap-ref-word nfp (stack-frame-offset 1 0))
2346                (the (unsigned-byte 32) value))))
2347       (#.sb!vm:signed-stack-sc-number
2348        (with-nfp (nfp)
2349          (setf (signed-sap-ref-word nfp (stack-frame-offset 1 0))
2350                (the (signed-byte 32) value))))
2351       (#.sb!vm:sap-stack-sc-number
2352        (with-nfp (nfp)
2353          (setf (sap-ref-sap nfp (stack-frame-offset 1 0))
2354                (the system-area-pointer value)))))))
2355
2356 ;;; The method for setting and accessing COMPILED-DEBUG-VAR values use
2357 ;;; this to determine if the value stored is the actual value or an
2358 ;;; indirection cell.
2359 (defun indirect-value-cell-p (x)
2360   (and (= (lowtag-of x) sb!vm:other-pointer-lowtag)
2361        (= (widetag-of x) sb!vm:value-cell-header-widetag)))
2362
2363 ;;; Return three values reflecting the validity of DEBUG-VAR's value
2364 ;;; at BASIC-CODE-LOCATION:
2365 ;;;   :VALID    The value is known to be available.
2366 ;;;   :INVALID  The value is known to be unavailable.
2367 ;;;   :UNKNOWN  The value's availability is unknown.
2368 ;;;
2369 ;;; If the variable is always alive, then it is valid. If the
2370 ;;; code-location is unknown, then the variable's validity is
2371 ;;; :unknown. Once we've called CODE-LOCATION-UNKNOWN-P, we know the
2372 ;;; live-set information has been cached in the code-location.
2373 (defun debug-var-validity (debug-var basic-code-location)
2374   (etypecase debug-var
2375     (compiled-debug-var
2376      (compiled-debug-var-validity debug-var basic-code-location))
2377     ;; (There used to be more cases back before sbcl-0.7.0, when
2378     ;; we did special tricks to debug the IR1 interpreter.)
2379     ))
2380
2381 ;;; This is the method for DEBUG-VAR-VALIDITY for COMPILED-DEBUG-VARs.
2382 ;;; For safety, make sure basic-code-location is what we think.
2383 (defun compiled-debug-var-validity (debug-var basic-code-location)
2384   (declare (type compiled-code-location basic-code-location))
2385   (cond ((debug-var-alive-p debug-var)
2386          (let ((debug-fun (code-location-debug-fun basic-code-location)))
2387            (if (>= (compiled-code-location-pc basic-code-location)
2388                    (sb!c::compiled-debug-fun-start-pc
2389                     (compiled-debug-fun-compiler-debug-fun debug-fun)))
2390                :valid
2391                :invalid)))
2392         ((code-location-unknown-p basic-code-location) :unknown)
2393         (t
2394          (let ((pos (position debug-var
2395                               (debug-fun-debug-vars
2396                                (code-location-debug-fun
2397                                 basic-code-location)))))
2398            (unless pos
2399              (error 'unknown-debug-var
2400                     :debug-var debug-var
2401                     :debug-fun
2402                     (code-location-debug-fun basic-code-location)))
2403            ;; There must be live-set info since basic-code-location is known.
2404            (if (zerop (sbit (compiled-code-location-live-set
2405                              basic-code-location)
2406                             pos))
2407                :invalid
2408                :valid)))))
2409 \f
2410 ;;;; sources
2411
2412 ;;; This code produces and uses what we call source-paths. A
2413 ;;; source-path is a list whose first element is a form number as
2414 ;;; returned by CODE-LOCATION-FORM-NUMBER and whose last element is a
2415 ;;; top level form number as returned by
2416 ;;; CODE-LOCATION-TOPLEVEL-FORM-NUMBER. The elements from the last to
2417 ;;; the first, exclusively, are the numbered subforms into which to
2418 ;;; descend. For example:
2419 ;;;    (defun foo (x)
2420 ;;;      (let ((a (aref x 3)))
2421 ;;;     (cons a 3)))
2422 ;;; The call to AREF in this example is form number 5. Assuming this
2423 ;;; DEFUN is the 11'th top level form, the source-path for the AREF
2424 ;;; call is as follows:
2425 ;;;    (5 1 0 1 3 11)
2426 ;;; Given the DEFUN, 3 gets you the LET, 1 gets you the bindings, 0
2427 ;;; gets the first binding, and 1 gets the AREF form.
2428
2429 ;;; This returns a table mapping form numbers to source-paths. A
2430 ;;; source-path indicates a descent into the TOPLEVEL-FORM form,
2431 ;;; going directly to the subform corressponding to the form number.
2432 ;;;
2433 ;;; The vector elements are in the same format as the compiler's
2434 ;;; NODE-SOURCE-PATH; that is, the first element is the form number and
2435 ;;; the last is the TOPLEVEL-FORM number.
2436 (defun form-number-translations (form tlf-number)
2437   (let ((seen nil)
2438         (translations (make-array 12 :fill-pointer 0 :adjustable t)))
2439     (labels ((translate1 (form path)
2440                (unless (member form seen)
2441                  (push form seen)
2442                  (vector-push-extend (cons (fill-pointer translations) path)
2443                                      translations)
2444                  (let ((pos 0)
2445                        (subform form)
2446                        (trail form))
2447                    (declare (fixnum pos))
2448                    (macrolet ((frob ()
2449                                 '(progn
2450                                   (when (atom subform) (return))
2451                                   (let ((fm (car subform)))
2452                                     (when (consp fm)
2453                                       (translate1 fm (cons pos path)))
2454                                     (incf pos))
2455                                   (setq subform (cdr subform))
2456                                   (when (eq subform trail) (return)))))
2457                      (loop
2458                        (frob)
2459                        (frob)
2460                        (setq trail (cdr trail))))))))
2461       (translate1 form (list tlf-number)))
2462     (coerce translations 'simple-vector)))
2463
2464 ;;; FORM is a top level form, and path is a source-path into it. This
2465 ;;; returns the form indicated by the source-path. Context is the
2466 ;;; number of enclosing forms to return instead of directly returning
2467 ;;; the source-path form. When context is non-zero, the form returned
2468 ;;; contains a marker, #:****HERE****, immediately before the form
2469 ;;; indicated by path.
2470 (defun source-path-context (form path context)
2471   (declare (type unsigned-byte context))
2472   ;; Get to the form indicated by path or the enclosing form indicated
2473   ;; by context and path.
2474   (let ((path (reverse (butlast (cdr path)))))
2475     (dotimes (i (- (length path) context))
2476       (let ((index (first path)))
2477         (unless (and (listp form) (< index (length form)))
2478           (error "Source path no longer exists."))
2479         (setq form (elt form index))
2480         (setq path (rest path))))
2481     ;; Recursively rebuild the source form resulting from the above
2482     ;; descent, copying the beginning of each subform up to the next
2483     ;; subform we descend into according to path. At the bottom of the
2484     ;; recursion, we return the form indicated by path preceded by our
2485     ;; marker, and this gets spliced into the resulting list structure
2486     ;; on the way back up.
2487     (labels ((frob (form path level)
2488                (if (or (zerop level) (null path))
2489                    (if (zerop context)
2490                        form
2491                        `(#:***here*** ,form))
2492                    (let ((n (first path)))
2493                      (unless (and (listp form) (< n (length form)))
2494                        (error "Source path no longer exists."))
2495                      (let ((res (frob (elt form n) (rest path) (1- level))))
2496                        (nconc (subseq form 0 n)
2497                               (cons res (nthcdr (1+ n) form))))))))
2498       (frob form path context))))
2499 \f
2500 ;;;; PREPROCESS-FOR-EVAL
2501
2502 ;;; Return a function of one argument that evaluates form in the
2503 ;;; lexical context of the BASIC-CODE-LOCATION LOC, or signal a
2504 ;;; NO-DEBUG-VARS condition when the LOC's DEBUG-FUN has no
2505 ;;; DEBUG-VAR information available.
2506 ;;;
2507 ;;; The returned function takes the frame to get values from as its
2508 ;;; argument, and it returns the values of FORM. The returned function
2509 ;;; can signal the following conditions: INVALID-VALUE,
2510 ;;; AMBIGUOUS-VAR-NAME, and FRAME-FUN-MISMATCH.
2511 (defun preprocess-for-eval (form loc)
2512   (declare (type code-location loc))
2513   (let ((n-frame (gensym))
2514         (fun (code-location-debug-fun loc)))
2515     (unless (debug-var-info-available fun)
2516       (debug-signal 'no-debug-vars :debug-fun fun))
2517     (sb!int:collect ((binds)
2518                      (specs))
2519       (do-debug-fun-vars (var fun)
2520         (let ((validity (debug-var-validity var loc)))
2521           (unless (eq validity :invalid)
2522             (let* ((sym (debug-var-symbol var))
2523                    (found (assoc sym (binds))))
2524               (if found
2525                   (setf (second found) :ambiguous)
2526                   (binds (list sym validity var)))))))
2527       (dolist (bind (binds))
2528         (let ((name (first bind))
2529               (var (third bind)))
2530           (ecase (second bind)
2531             (:valid
2532              (specs `(,name (debug-var-value ',var ,n-frame))))
2533             (:unknown
2534              (specs `(,name (debug-signal 'invalid-value
2535                                           :debug-var ',var
2536                                           :frame ,n-frame))))
2537             (:ambiguous
2538              (specs `(,name (debug-signal 'ambiguous-var-name
2539                                           :name ',name
2540                                           :frame ,n-frame)))))))
2541       (let ((res (coerce `(lambda (,n-frame)
2542                             (declare (ignorable ,n-frame))
2543                             (symbol-macrolet ,(specs) ,form))
2544                          'function)))
2545         (lambda (frame)
2546           ;; This prevents these functions from being used in any
2547           ;; location other than a function return location, so maybe
2548           ;; this should only check whether FRAME's DEBUG-FUN is the
2549           ;; same as LOC's.
2550           (unless (code-location= (frame-code-location frame) loc)
2551             (debug-signal 'frame-fun-mismatch
2552                           :code-location loc :form form :frame frame))
2553           (funcall res frame))))))
2554
2555 ;;; EVAL-IN-FRAME
2556
2557 (defun eval-in-frame (frame form)
2558   (declare (type frame frame))
2559   #!+sb-doc
2560   "Evaluate FORM in the lexical context of FRAME's current code location,
2561    returning the results of the evaluation."
2562   (funcall (preprocess-for-eval form (frame-code-location frame)) frame))
2563 \f
2564 ;;;; breakpoints
2565
2566 ;;;; user-visible interface
2567
2568 ;;; Create and return a breakpoint. When program execution encounters
2569 ;;; the breakpoint, the system calls HOOK-FUN. HOOK-FUN takes the
2570 ;;; current frame for the function in which the program is running and
2571 ;;; the breakpoint object.
2572 ;;;
2573 ;;; WHAT and KIND determine where in a function the system invokes
2574 ;;; HOOK-FUN. WHAT is either a code-location or a DEBUG-FUN. KIND is
2575 ;;; one of :CODE-LOCATION, :FUN-START, or :FUN-END. Since the starts
2576 ;;; and ends of functions may not have code-locations representing
2577 ;;; them, designate these places by supplying WHAT as a DEBUG-FUN and
2578 ;;; KIND indicating the :FUN-START or :FUN-END. When WHAT is a
2579 ;;; DEBUG-FUN and kind is :FUN-END, then HOOK-FUN must take two
2580 ;;; additional arguments, a list of values returned by the function
2581 ;;; and a FUN-END-COOKIE.
2582 ;;;
2583 ;;; INFO is information supplied by and used by the user.
2584 ;;;
2585 ;;; FUN-END-COOKIE is a function. To implement :FUN-END
2586 ;;; breakpoints, the system uses starter breakpoints to establish the
2587 ;;; :FUN-END breakpoint for each invocation of the function. Upon
2588 ;;; each entry, the system creates a unique cookie to identify the
2589 ;;; invocation, and when the user supplies a function for this
2590 ;;; argument, the system invokes it on the frame and the cookie. The
2591 ;;; system later invokes the :FUN-END breakpoint hook on the same
2592 ;;; cookie. The user may save the cookie for comparison in the hook
2593 ;;; function.
2594 ;;;
2595 ;;; Signal an error if WHAT is an unknown code-location.
2596 (defun make-breakpoint (hook-fun what
2597                         &key (kind :code-location) info fun-end-cookie)
2598   (etypecase what
2599     (code-location
2600      (when (code-location-unknown-p what)
2601        (error "cannot make a breakpoint at an unknown code location: ~S"
2602               what))
2603      (aver (eq kind :code-location))
2604      (let ((bpt (%make-breakpoint hook-fun what kind info)))
2605        (etypecase what
2606          (compiled-code-location
2607           ;; This slot is filled in due to calling CODE-LOCATION-UNKNOWN-P.
2608           (when (eq (compiled-code-location-kind what) :unknown-return)
2609             (let ((other-bpt (%make-breakpoint hook-fun what
2610                                                :unknown-return-partner
2611                                                info)))
2612               (setf (breakpoint-unknown-return-partner bpt) other-bpt)
2613               (setf (breakpoint-unknown-return-partner other-bpt) bpt))))
2614          ;; (There used to be more cases back before sbcl-0.7.0,,
2615          ;; when we did special tricks to debug the IR1
2616          ;; interpreter.)
2617          )
2618        bpt))
2619     (compiled-debug-fun
2620      (ecase kind
2621        (:fun-start
2622         (%make-breakpoint hook-fun what kind info))
2623        (:fun-end
2624         (unless (eq (sb!c::compiled-debug-fun-returns
2625                      (compiled-debug-fun-compiler-debug-fun what))
2626                     :standard)
2627           (error ":FUN-END breakpoints are currently unsupported ~
2628                   for the known return convention."))
2629
2630         (let* ((bpt (%make-breakpoint hook-fun what kind info))
2631                (starter (compiled-debug-fun-end-starter what)))
2632           (unless starter
2633             (setf starter (%make-breakpoint #'list what :fun-start nil))
2634             (setf (breakpoint-hook-fun starter)
2635                   (fun-end-starter-hook starter what))
2636             (setf (compiled-debug-fun-end-starter what) starter))
2637           (setf (breakpoint-start-helper bpt) starter)
2638           (push bpt (breakpoint-%info starter))
2639           (setf (breakpoint-cookie-fun bpt) fun-end-cookie)
2640           bpt))))))
2641
2642 ;;; These are unique objects created upon entry into a function by a
2643 ;;; :FUN-END breakpoint's starter hook. These are only created
2644 ;;; when users supply :FUN-END-COOKIE to MAKE-BREAKPOINT. Also,
2645 ;;; the :FUN-END breakpoint's hook is called on the same cookie
2646 ;;; when it is created.
2647 (defstruct (fun-end-cookie
2648             (:print-object (lambda (obj str)
2649                              (print-unreadable-object (obj str :type t))))
2650             (:constructor make-fun-end-cookie (bogus-lra debug-fun))
2651             (:copier nil))
2652   ;; a pointer to the bogus-lra created for :FUN-END breakpoints
2653   bogus-lra
2654   ;; the DEBUG-FUN associated with this cookie
2655   debug-fun)
2656
2657 ;;; This maps bogus-lra-components to cookies, so that
2658 ;;; HANDLE-FUN-END-BREAKPOINT can find the appropriate cookie for the
2659 ;;; breakpoint hook.
2660 (defvar *fun-end-cookies* (make-hash-table :test 'eq :synchronized t))
2661
2662 ;;; This returns a hook function for the start helper breakpoint
2663 ;;; associated with a :FUN-END breakpoint. The returned function
2664 ;;; makes a fake LRA that all returns go through, and this piece of
2665 ;;; fake code actually breaks. Upon return from the break, the code
2666 ;;; provides the returnee with any values. Since the returned function
2667 ;;; effectively activates FUN-END-BPT on each entry to DEBUG-FUN's
2668 ;;; function, we must establish breakpoint-data about FUN-END-BPT.
2669 (defun fun-end-starter-hook (starter-bpt debug-fun)
2670   (declare (type breakpoint starter-bpt)
2671            (type compiled-debug-fun debug-fun))
2672   (lambda (frame breakpoint)
2673     (declare (ignore breakpoint)
2674              (type frame frame))
2675     (let ((lra-sc-offset
2676            (sb!c::compiled-debug-fun-return-pc
2677             (compiled-debug-fun-compiler-debug-fun debug-fun))))
2678       (multiple-value-bind (lra component offset)
2679           (make-bogus-lra
2680            (get-context-value frame
2681                               lra-save-offset
2682                               lra-sc-offset))
2683         (setf (get-context-value frame
2684                                  lra-save-offset
2685                                  lra-sc-offset)
2686               lra)
2687         (let ((end-bpts (breakpoint-%info starter-bpt)))
2688           (let ((data (breakpoint-data component offset)))
2689             (setf (breakpoint-data-breakpoints data) end-bpts)
2690             (dolist (bpt end-bpts)
2691               (setf (breakpoint-internal-data bpt) data)))
2692           (let ((cookie (make-fun-end-cookie lra debug-fun)))
2693             (setf (gethash component *fun-end-cookies*) cookie)
2694             (dolist (bpt end-bpts)
2695               (let ((fun (breakpoint-cookie-fun bpt)))
2696                 (when fun (funcall fun frame cookie))))))))))
2697
2698 ;;; This takes a FUN-END-COOKIE and a frame, and it returns
2699 ;;; whether the cookie is still valid. A cookie becomes invalid when
2700 ;;; the frame that established the cookie has exited. Sometimes cookie
2701 ;;; holders are unaware of cookie invalidation because their
2702 ;;; :FUN-END breakpoint hooks didn't run due to THROW'ing.
2703 ;;;
2704 ;;; This takes a frame as an efficiency hack since the user probably
2705 ;;; has a frame object in hand when using this routine, and it saves
2706 ;;; repeated parsing of the stack and consing when asking whether a
2707 ;;; series of cookies is valid.
2708 (defun fun-end-cookie-valid-p (frame cookie)
2709   (let ((lra (fun-end-cookie-bogus-lra cookie))
2710         (lra-sc-offset (sb!c::compiled-debug-fun-return-pc
2711                         (compiled-debug-fun-compiler-debug-fun
2712                          (fun-end-cookie-debug-fun cookie)))))
2713     (do ((frame frame (frame-down frame)))
2714         ((not frame) nil)
2715       (when (and (compiled-frame-p frame)
2716                  (#!-(or x86 x86-64) eq #!+(or x86 x86-64) sap=
2717                   lra
2718                   (get-context-value frame lra-save-offset lra-sc-offset)))
2719         (return t)))))
2720 \f
2721 ;;;; ACTIVATE-BREAKPOINT
2722
2723 ;;; Cause the system to invoke the breakpoint's hook function until
2724 ;;; the next call to DEACTIVATE-BREAKPOINT or DELETE-BREAKPOINT. The
2725 ;;; system invokes breakpoint hook functions in the opposite order
2726 ;;; that you activate them.
2727 (defun activate-breakpoint (breakpoint)
2728   (when (eq (breakpoint-status breakpoint) :deleted)
2729     (error "cannot activate a deleted breakpoint: ~S" breakpoint))
2730   (unless (eq (breakpoint-status breakpoint) :active)
2731     (ecase (breakpoint-kind breakpoint)
2732       (:code-location
2733        (let ((loc (breakpoint-what breakpoint)))
2734          (etypecase loc
2735            (compiled-code-location
2736             (activate-compiled-code-location-breakpoint breakpoint)
2737             (let ((other (breakpoint-unknown-return-partner breakpoint)))
2738               (when other
2739                 (activate-compiled-code-location-breakpoint other))))
2740            ;; (There used to be more cases back before sbcl-0.7.0, when
2741            ;; we did special tricks to debug the IR1 interpreter.)
2742            )))
2743       (:fun-start
2744        (etypecase (breakpoint-what breakpoint)
2745          (compiled-debug-fun
2746           (activate-compiled-fun-start-breakpoint breakpoint))
2747          ;; (There used to be more cases back before sbcl-0.7.0, when
2748          ;; we did special tricks to debug the IR1 interpreter.)
2749          ))
2750       (:fun-end
2751        (etypecase (breakpoint-what breakpoint)
2752          (compiled-debug-fun
2753           (let ((starter (breakpoint-start-helper breakpoint)))
2754             (unless (eq (breakpoint-status starter) :active)
2755               ;; may already be active by some other :FUN-END breakpoint
2756               (activate-compiled-fun-start-breakpoint starter)))
2757           (setf (breakpoint-status breakpoint) :active))
2758          ;; (There used to be more cases back before sbcl-0.7.0, when
2759          ;; we did special tricks to debug the IR1 interpreter.)
2760          ))))
2761   breakpoint)
2762
2763 (defun activate-compiled-code-location-breakpoint (breakpoint)
2764   (declare (type breakpoint breakpoint))
2765   (let ((loc (breakpoint-what breakpoint)))
2766     (declare (type compiled-code-location loc))
2767     (sub-activate-breakpoint
2768      breakpoint
2769      (breakpoint-data (compiled-debug-fun-component
2770                        (code-location-debug-fun loc))
2771                       (+ (compiled-code-location-pc loc)
2772                          (if (or (eq (breakpoint-kind breakpoint)
2773                                      :unknown-return-partner)
2774                                  (eq (compiled-code-location-kind loc)
2775                                      :single-value-return))
2776                              sb!vm:single-value-return-byte-offset
2777                              0))))))
2778
2779 (defun activate-compiled-fun-start-breakpoint (breakpoint)
2780   (declare (type breakpoint breakpoint))
2781   (let ((debug-fun (breakpoint-what breakpoint)))
2782     (sub-activate-breakpoint
2783      breakpoint
2784      (breakpoint-data (compiled-debug-fun-component debug-fun)
2785                       (sb!c::compiled-debug-fun-start-pc
2786                        (compiled-debug-fun-compiler-debug-fun
2787                         debug-fun))))))
2788
2789 (defun sub-activate-breakpoint (breakpoint data)
2790   (declare (type breakpoint breakpoint)
2791            (type breakpoint-data data))
2792   (setf (breakpoint-status breakpoint) :active)
2793   (without-interrupts
2794    (unless (breakpoint-data-breakpoints data)
2795      (setf (breakpoint-data-instruction data)
2796            (without-gcing
2797             (breakpoint-install (get-lisp-obj-address
2798                                  (breakpoint-data-component data))
2799                                 (breakpoint-data-offset data)))))
2800    (setf (breakpoint-data-breakpoints data)
2801          (append (breakpoint-data-breakpoints data) (list breakpoint)))
2802    (setf (breakpoint-internal-data breakpoint) data)))
2803 \f
2804 ;;;; DEACTIVATE-BREAKPOINT
2805
2806 ;;; Stop the system from invoking the breakpoint's hook function.
2807 (defun deactivate-breakpoint (breakpoint)
2808   (when (eq (breakpoint-status breakpoint) :active)
2809     (without-interrupts
2810      (let ((loc (breakpoint-what breakpoint)))
2811        (etypecase loc
2812          ((or compiled-code-location compiled-debug-fun)
2813           (deactivate-compiled-breakpoint breakpoint)
2814           (let ((other (breakpoint-unknown-return-partner breakpoint)))
2815             (when other
2816               (deactivate-compiled-breakpoint other))))
2817          ;; (There used to be more cases back before sbcl-0.7.0, when
2818          ;; we did special tricks to debug the IR1 interpreter.)
2819          ))))
2820   breakpoint)
2821
2822 (defun deactivate-compiled-breakpoint (breakpoint)
2823   (if (eq (breakpoint-kind breakpoint) :fun-end)
2824       (let ((starter (breakpoint-start-helper breakpoint)))
2825         (unless (find-if (lambda (bpt)
2826                            (and (not (eq bpt breakpoint))
2827                                 (eq (breakpoint-status bpt) :active)))
2828                          (breakpoint-%info starter))
2829           (deactivate-compiled-breakpoint starter)))
2830       (let* ((data (breakpoint-internal-data breakpoint))
2831              (bpts (delete breakpoint (breakpoint-data-breakpoints data))))
2832         (setf (breakpoint-internal-data breakpoint) nil)
2833         (setf (breakpoint-data-breakpoints data) bpts)
2834         (unless bpts
2835           (without-gcing
2836            (breakpoint-remove (get-lisp-obj-address
2837                                (breakpoint-data-component data))
2838                               (breakpoint-data-offset data)
2839                               (breakpoint-data-instruction data)))
2840           (delete-breakpoint-data data))))
2841   (setf (breakpoint-status breakpoint) :inactive)
2842   breakpoint)
2843 \f
2844 ;;;; BREAKPOINT-INFO
2845
2846 ;;; Return the user-maintained info associated with breakpoint. This
2847 ;;; is SETF'able.
2848 (defun breakpoint-info (breakpoint)
2849   (breakpoint-%info breakpoint))
2850 (defun %set-breakpoint-info (breakpoint value)
2851   (setf (breakpoint-%info breakpoint) value)
2852   (let ((other (breakpoint-unknown-return-partner breakpoint)))
2853     (when other
2854       (setf (breakpoint-%info other) value))))
2855 \f
2856 ;;;; BREAKPOINT-ACTIVE-P and DELETE-BREAKPOINT
2857
2858 (defun breakpoint-active-p (breakpoint)
2859   (ecase (breakpoint-status breakpoint)
2860     (:active t)
2861     ((:inactive :deleted) nil)))
2862
2863 ;;; Free system storage and remove computational overhead associated
2864 ;;; with breakpoint. After calling this, breakpoint is completely
2865 ;;; impotent and can never become active again.
2866 (defun delete-breakpoint (breakpoint)
2867   (let ((status (breakpoint-status breakpoint)))
2868     (unless (eq status :deleted)
2869       (when (eq status :active)
2870         (deactivate-breakpoint breakpoint))
2871       (setf (breakpoint-status breakpoint) :deleted)
2872       (let ((other (breakpoint-unknown-return-partner breakpoint)))
2873         (when other
2874           (setf (breakpoint-status other) :deleted)))
2875       (when (eq (breakpoint-kind breakpoint) :fun-end)
2876         (let* ((starter (breakpoint-start-helper breakpoint))
2877                (breakpoints (delete breakpoint
2878                                     (the list (breakpoint-info starter)))))
2879           (setf (breakpoint-info starter) breakpoints)
2880           (unless breakpoints
2881             (delete-breakpoint starter)
2882             (setf (compiled-debug-fun-end-starter
2883                    (breakpoint-what breakpoint))
2884                   nil))))))
2885   breakpoint)
2886 \f
2887 ;;;; C call out stubs
2888
2889 ;;; This actually installs the break instruction in the component. It
2890 ;;; returns the overwritten bits. You must call this in a context in
2891 ;;; which GC is disabled, so that Lisp doesn't move objects around
2892 ;;; that C is pointing to.
2893 (sb!alien:define-alien-routine "breakpoint_install" sb!alien:unsigned-int
2894   (code-obj sb!alien:unsigned-long)
2895   (pc-offset sb!alien:int))
2896
2897 ;;; This removes the break instruction and replaces the original
2898 ;;; instruction. You must call this in a context in which GC is disabled
2899 ;;; so Lisp doesn't move objects around that C is pointing to.
2900 (sb!alien:define-alien-routine "breakpoint_remove" sb!alien:void
2901   (code-obj sb!alien:unsigned-long)
2902   (pc-offset sb!alien:int)
2903   (old-inst sb!alien:unsigned-int))
2904
2905 (sb!alien:define-alien-routine "breakpoint_do_displaced_inst" sb!alien:void
2906   (scp (* os-context-t))
2907   (orig-inst sb!alien:unsigned-int))
2908
2909 ;;;; breakpoint handlers (layer between C and exported interface)
2910
2911 ;;; This maps components to a mapping of offsets to BREAKPOINT-DATAs.
2912 (defvar *component-breakpoint-offsets* (make-hash-table :test 'eq :synchronized t))
2913
2914 ;;; This returns the BREAKPOINT-DATA object associated with component cross
2915 ;;; offset. If none exists, this makes one, installs it, and returns it.
2916 (defun breakpoint-data (component offset &optional (create t))
2917   (flet ((install-breakpoint-data ()
2918            (when create
2919              (let ((data (make-breakpoint-data component offset)))
2920                (push (cons offset data)
2921                      (gethash component *component-breakpoint-offsets*))
2922                data))))
2923     (let ((offsets (gethash component *component-breakpoint-offsets*)))
2924       (if offsets
2925           (let ((data (assoc offset offsets)))
2926             (if data
2927                 (cdr data)
2928                 (install-breakpoint-data)))
2929           (install-breakpoint-data)))))
2930
2931 ;;; We use this when there are no longer any active breakpoints
2932 ;;; corresponding to DATA.
2933 (defun delete-breakpoint-data (data)
2934   ;; Again, this looks brittle. Is there no danger of being interrupted
2935   ;; here?
2936   (let* ((component (breakpoint-data-component data))
2937          (offsets (delete (breakpoint-data-offset data)
2938                           (gethash component *component-breakpoint-offsets*)
2939                           :key #'car)))
2940     (if offsets
2941         (setf (gethash component *component-breakpoint-offsets*) offsets)
2942         (remhash component *component-breakpoint-offsets*)))
2943   (values))
2944
2945 ;;; The C handler for interrupts calls this when it has a
2946 ;;; debugging-tool break instruction. This does *not* handle all
2947 ;;; breaks; for example, it does not handle breaks for internal
2948 ;;; errors.
2949 (defun handle-breakpoint (offset component signal-context)
2950   (let ((data (breakpoint-data component offset nil)))
2951     (unless data
2952       (error "unknown breakpoint in ~S at offset ~S"
2953               (debug-fun-name (debug-fun-from-pc component offset))
2954               offset))
2955     (let ((breakpoints (breakpoint-data-breakpoints data)))
2956       (if (or (null breakpoints)
2957               (eq (breakpoint-kind (car breakpoints)) :fun-end))
2958           (handle-fun-end-breakpoint-aux breakpoints data signal-context)
2959           (handle-breakpoint-aux breakpoints data
2960                                  offset component signal-context)))))
2961
2962 ;;; This holds breakpoint-datas while invoking the breakpoint hooks
2963 ;;; associated with that particular component and location. While they
2964 ;;; are executing, if we hit the location again, we ignore the
2965 ;;; breakpoint to avoid infinite recursion. fun-end breakpoints
2966 ;;; must work differently since the breakpoint-data is unique for each
2967 ;;; invocation.
2968 (defvar *executing-breakpoint-hooks* nil)
2969
2970 ;;; This handles code-location and DEBUG-FUN :FUN-START
2971 ;;; breakpoints.
2972 (defun handle-breakpoint-aux (breakpoints data offset component signal-context)
2973   (unless breakpoints
2974     (bug "breakpoint that nobody wants"))
2975   (unless (member data *executing-breakpoint-hooks*)
2976     (let ((*executing-breakpoint-hooks* (cons data
2977                                               *executing-breakpoint-hooks*)))
2978       (invoke-breakpoint-hooks breakpoints signal-context)))
2979   ;; At this point breakpoints may not hold the same list as
2980   ;; BREAKPOINT-DATA-BREAKPOINTS since invoking hooks may have allowed
2981   ;; a breakpoint deactivation. In fact, if all breakpoints were
2982   ;; deactivated then data is invalid since it was deleted and so the
2983   ;; correct one must be looked up if it is to be used. If there are
2984   ;; no more breakpoints active at this location, then the normal
2985   ;; instruction has been put back, and we do not need to
2986   ;; DO-DISPLACED-INST.
2987   (setf data (breakpoint-data component offset nil))
2988   (when (and data (breakpoint-data-breakpoints data))
2989     ;; The breakpoint is still active, so we need to execute the
2990     ;; displaced instruction and leave the breakpoint instruction
2991     ;; behind. The best way to do this is different on each machine,
2992     ;; so we just leave it up to the C code.
2993     (breakpoint-do-displaced-inst signal-context
2994                                   (breakpoint-data-instruction data))
2995     ;; Some platforms have no usable sigreturn() call.  If your
2996     ;; implementation of arch_do_displaced_inst() _does_ sigreturn(),
2997     ;; it's polite to warn here
2998     #!+(and sparc solaris)
2999     (error "BREAKPOINT-DO-DISPLACED-INST returned?")))
3000
3001 (defun invoke-breakpoint-hooks (breakpoints signal-context)
3002   (let* ((frame (signal-context-frame signal-context)))
3003     (dolist (bpt breakpoints)
3004       (funcall (breakpoint-hook-fun bpt)
3005                frame
3006                ;; If this is an :UNKNOWN-RETURN-PARTNER, then pass the
3007                ;; hook function the original breakpoint, so that users
3008                ;; aren't forced to confront the fact that some
3009                ;; breakpoints really are two.
3010                (if (eq (breakpoint-kind bpt) :unknown-return-partner)
3011                    (breakpoint-unknown-return-partner bpt)
3012                    bpt)))))
3013
3014 (defun signal-context-frame (signal-context)
3015   (let* ((scp
3016           (locally
3017             (declare (optimize (inhibit-warnings 3)))
3018             (sb!alien:sap-alien signal-context (* os-context-t))))
3019          (cfp (int-sap (sb!vm:context-register scp sb!vm::cfp-offset))))
3020     (compute-calling-frame cfp
3021                            (sb!vm:context-pc scp)
3022                            nil)))
3023
3024 (defun handle-fun-end-breakpoint (offset component context)
3025   (let ((data (breakpoint-data component offset nil)))
3026     (unless data
3027       (error "unknown breakpoint in ~S at offset ~S"
3028               (debug-fun-name (debug-fun-from-pc component offset))
3029               offset))
3030     (let ((breakpoints (breakpoint-data-breakpoints data)))
3031       (when breakpoints
3032         (aver (eq (breakpoint-kind (car breakpoints)) :fun-end))
3033         (handle-fun-end-breakpoint-aux breakpoints data context)))))
3034
3035 ;;; Either HANDLE-BREAKPOINT calls this for :FUN-END breakpoints
3036 ;;; [old C code] or HANDLE-FUN-END-BREAKPOINT calls this directly
3037 ;;; [new C code].
3038 (defun handle-fun-end-breakpoint-aux (breakpoints data signal-context)
3039   ;; FIXME: This looks brittle: what if we are interrupted somewhere
3040   ;; here? ...or do we have interrupts disabled here?
3041   (delete-breakpoint-data data)
3042   (let* ((scp
3043           (locally
3044             (declare (optimize (inhibit-warnings 3)))
3045             (sb!alien:sap-alien signal-context (* os-context-t))))
3046          (frame (signal-context-frame signal-context))
3047          (component (breakpoint-data-component data))
3048          (cookie (gethash component *fun-end-cookies*)))
3049     (remhash component *fun-end-cookies*)
3050     (dolist (bpt breakpoints)
3051       (funcall (breakpoint-hook-fun bpt)
3052                frame bpt
3053                (get-fun-end-breakpoint-values scp)
3054                cookie))))
3055
3056 (defun get-fun-end-breakpoint-values (scp)
3057   (let ((ocfp (int-sap (sb!vm:context-register
3058                         scp
3059                         #!-(or x86 x86-64) sb!vm::ocfp-offset
3060                         #!+(or x86 x86-64) sb!vm::ebx-offset)))
3061         (nargs (make-lisp-obj
3062                 (sb!vm:context-register scp sb!vm::nargs-offset)))
3063         (reg-arg-offsets '#.sb!vm::*register-arg-offsets*)
3064         (results nil))
3065     (without-gcing
3066      (dotimes (arg-num nargs)
3067        (push (if reg-arg-offsets
3068                  (make-lisp-obj
3069                   (sb!vm:context-register scp (pop reg-arg-offsets)))
3070                (stack-ref ocfp arg-num))
3071              results)))
3072     (nreverse results)))
3073 \f
3074 ;;;; MAKE-BOGUS-LRA (used for :FUN-END breakpoints)
3075
3076 (defconstant bogus-lra-constants
3077   #!-(or x86 x86-64) 2 #!+(or x86 x86-64) 3)
3078 (defconstant known-return-p-slot
3079   (+ sb!vm:code-constants-offset #!-(or x86 x86-64) 1 #!+(or x86 x86-64) 2))
3080
3081 ;;; Make a bogus LRA object that signals a breakpoint trap when
3082 ;;; returned to. If the breakpoint trap handler returns, REAL-LRA is
3083 ;;; returned to. Three values are returned: the bogus LRA object, the
3084 ;;; code component it is part of, and the PC offset for the trap
3085 ;;; instruction.
3086 (defun make-bogus-lra (real-lra &optional known-return-p)
3087   (without-gcing
3088    ;; These are really code labels, not variables: but this way we get
3089    ;; their addresses.
3090    (let* ((src-start (foreign-symbol-sap "fun_end_breakpoint_guts"))
3091           (src-end (foreign-symbol-sap "fun_end_breakpoint_end"))
3092           (trap-loc (foreign-symbol-sap "fun_end_breakpoint_trap"))
3093           (length (sap- src-end src-start))
3094           (code-object
3095            (sb!c:allocate-code-object (1+ bogus-lra-constants) length))
3096           (dst-start (code-instructions code-object)))
3097      (declare (type system-area-pointer
3098                     src-start src-end dst-start trap-loc)
3099               (type index length))
3100      (setf (%code-debug-info code-object) :bogus-lra)
3101      (setf (code-header-ref code-object sb!vm:code-trace-table-offset-slot)
3102            length)
3103      #!-(or x86 x86-64)
3104      (setf (code-header-ref code-object real-lra-slot) real-lra)
3105      #!+(or x86 x86-64)
3106      (multiple-value-bind (offset code) (compute-lra-data-from-pc real-lra)
3107        (setf (code-header-ref code-object real-lra-slot) code)
3108        (setf (code-header-ref code-object (1+ real-lra-slot)) offset))
3109      (setf (code-header-ref code-object known-return-p-slot)
3110            known-return-p)
3111      (system-area-ub8-copy src-start 0 dst-start 0 length)
3112      (sb!vm:sanctify-for-execution code-object)
3113      #!+(or x86 x86-64)
3114      (values dst-start code-object (sap- trap-loc src-start))
3115      #!-(or x86 x86-64)
3116      (let ((new-lra (make-lisp-obj (+ (sap-int dst-start)
3117                                       sb!vm:other-pointer-lowtag))))
3118        (set-header-data
3119         new-lra
3120         (logandc2 (+ sb!vm:code-constants-offset bogus-lra-constants 1)
3121                   1))
3122        (sb!vm:sanctify-for-execution code-object)
3123        (values new-lra code-object (sap- trap-loc src-start))))))
3124 \f
3125 ;;;; miscellaneous
3126
3127 ;;; This appears here because it cannot go with the DEBUG-FUN
3128 ;;; interface since DO-DEBUG-BLOCK-LOCATIONS isn't defined until after
3129 ;;; the DEBUG-FUN routines.
3130
3131 ;;; Return a code-location before the body of a function and after all
3132 ;;; the arguments are in place; or if that location can't be
3133 ;;; determined due to a lack of debug information, return NIL.
3134 (defun debug-fun-start-location (debug-fun)
3135   (etypecase debug-fun
3136     (compiled-debug-fun
3137      (code-location-from-pc debug-fun
3138                             (sb!c::compiled-debug-fun-start-pc
3139                              (compiled-debug-fun-compiler-debug-fun
3140                               debug-fun))
3141                             nil))
3142     ;; (There used to be more cases back before sbcl-0.7.0, when
3143     ;; we did special tricks to debug the IR1 interpreter.)
3144     ))
3145
3146 \f
3147 ;;;; Single-stepping
3148
3149 ;;; The single-stepper works by inserting conditional trap instructions
3150 ;;; into the generated code (see src/compiler/*/call.lisp), currently:
3151 ;;;
3152 ;;;   1) Before the code generated for a function call that was
3153 ;;;      translated to a VOP
3154 ;;;   2) Just before the call instruction for a full call
3155 ;;;
3156 ;;; In both cases, the trap will only be executed if stepping has been
3157 ;;; enabled, in which case it'll ultimately be handled by
3158 ;;; HANDLE-SINGLE-STEP-TRAP, which will either signal a stepping condition,
3159 ;;; or replace the function that's about to be called with a wrapper
3160 ;;; which will signal the condition.
3161
3162 (defun handle-single-step-trap (kind callee-register-offset)
3163   (let ((context (nth-interrupt-context (1- *free-interrupt-context-index*))))
3164     ;; The following calls must get tail-call eliminated for
3165     ;; *STEP-FRAME* to get set correctly on non-x86.
3166     (if (= kind single-step-before-trap)
3167         (handle-single-step-before-trap context)
3168         (handle-single-step-around-trap context callee-register-offset))))
3169
3170 (defvar *step-frame* nil)
3171
3172 (defun handle-single-step-before-trap (context)
3173   (let ((step-info (single-step-info-from-context context)))
3174     ;; If there was not enough debug information available, there's no
3175     ;; sense in signaling the condition.
3176     (when step-info
3177       (let ((*step-frame*
3178              #!+(or x86 x86-64)
3179              (signal-context-frame (sb!alien::alien-sap context))
3180              #!-(or x86 x86-64)
3181              ;; KLUDGE: Use the first non-foreign frame as the
3182              ;; *STACK-TOP-HINT*. Getting the frame from the signal
3183              ;; context as on x86 would be cleaner, but
3184              ;; SIGNAL-CONTEXT-FRAME doesn't seem seem to work at all
3185              ;; on non-x86.
3186              (loop with frame = (frame-down (top-frame))
3187                    while frame
3188                    for dfun = (frame-debug-fun frame)
3189                    do (when (typep dfun 'compiled-debug-fun)
3190                         (return frame))
3191                    do (setf frame (frame-down frame)))))
3192         (sb!impl::step-form step-info
3193                             ;; We could theoretically store information in
3194                             ;; the debug-info about to determine the
3195                             ;; arguments here, but for now let's just pass
3196                             ;; on it.
3197                             :unknown)))))
3198
3199 ;;; This function will replace the fdefn / function that was in the
3200 ;;; register at CALLEE-REGISTER-OFFSET with a wrapper function. To
3201 ;;; ensure that the full call will use the wrapper instead of the
3202 ;;; original, conditional trap must be emitted before the fdefn /
3203 ;;; function is converted into a raw address.
3204 (defun handle-single-step-around-trap (context callee-register-offset)
3205   ;; Fetch the function / fdefn we're about to call from the
3206   ;; appropriate register.
3207   (let* ((callee (make-lisp-obj
3208                   (context-register context callee-register-offset)))
3209          (step-info (single-step-info-from-context context)))
3210     ;; If there was not enough debug information available, there's no
3211     ;; sense in signaling the condition.
3212     (unless step-info
3213       (return-from handle-single-step-around-trap))
3214     (let* ((fun (lambda (&rest args)
3215                   (flet ((call ()
3216                            (apply (typecase callee
3217                                     (fdefn (fdefn-fun callee))
3218                                     (function callee))
3219                                   args)))
3220                     ;; Signal a step condition
3221                     (let* ((step-in
3222                             (let ((*step-frame* (frame-down (top-frame))))
3223                               (sb!impl::step-form step-info args))))
3224                       ;; And proceed based on its return value.
3225                       (if step-in
3226                           ;; STEP-INTO was selected. Use *STEP-OUT* to
3227                           ;; let the stepper know that selecting the
3228                           ;; STEP-OUT restart is valid inside this
3229                           (let ((sb!impl::*step-out* :maybe))
3230                             ;; Pass the return values of the call to
3231                             ;; STEP-VALUES, which will signal a
3232                             ;; condition with them in the VALUES slot.
3233                             (unwind-protect
3234                                  (multiple-value-call #'sb!impl::step-values
3235                                    step-info
3236                                    (call))
3237                               ;; If the user selected the STEP-OUT
3238                               ;; restart during the call, resume
3239                               ;; stepping
3240                               (when (eq sb!impl::*step-out* t)
3241                                 (sb!impl::enable-stepping))))
3242                           ;; STEP-NEXT / CONTINUE / OUT selected:
3243                           ;; Disable the stepper for the duration of
3244                           ;; the call.
3245                           (sb!impl::with-stepping-disabled
3246                             (call)))))))
3247            (new-callee (etypecase callee
3248                          (fdefn
3249                           (let ((fdefn (make-fdefn (gensym))))
3250                             (setf (fdefn-fun fdefn) fun)
3251                             fdefn))
3252                          (function fun))))
3253       ;; And then store the wrapper in the same place.
3254       (setf (context-register context callee-register-offset)
3255             (get-lisp-obj-address new-callee)))))
3256
3257 ;;; Given a signal context, fetch the step-info that's been stored in
3258 ;;; the debug info at the trap point.
3259 (defun single-step-info-from-context (context)
3260   (multiple-value-bind (pc-offset code)
3261       (compute-lra-data-from-pc (context-pc context))
3262     (let* ((debug-fun (debug-fun-from-pc code pc-offset))
3263            (location (code-location-from-pc debug-fun
3264                                             pc-offset
3265                                             nil)))
3266       (handler-case
3267           (progn
3268             (fill-in-code-location location)
3269             (code-location-debug-source location)
3270             (compiled-code-location-step-info location))
3271         (debug-condition ()
3272           nil)))))
3273
3274 ;;; Return the frame that triggered a single-step condition. Used to
3275 ;;; provide a *STACK-TOP-HINT*.
3276 (defun find-stepped-frame ()
3277   (or *step-frame*
3278       (top-frame)))