1 ;;;; stuff that creates debugger information from the compiler's
2 ;;;; internal data structures
4 ;;;; This software is part of the SBCL system. See the README file for
7 ;;;; This software is derived from the CMU CL system, which was
8 ;;;; written at Carnegie Mellon University and released into the
9 ;;;; public domain. The software is in the public domain and is
10 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
11 ;;;; files for more information.
15 (deftype byte-buffer
() '(vector (unsigned-byte 8)))
16 (defvar *byte-buffer
*)
17 (declaim (type byte-buffer
*byte-buffer
*))
21 (deftype location-kind
()
22 '(member :unknown-return
:known-return
:internal-error
:non-local-exit
23 :block-start
:call-site
:single-value-return
:non-local-entry
))
25 ;;; The LOCATION-INFO structure holds the information what we need
26 ;;; about locations which code generation decided were "interesting".
27 (defstruct (location-info
28 (:constructor make-location-info
(kind label vop
))
30 ;; The kind of location noted.
31 (kind nil
:type location-kind
)
32 ;; The label pointing to the interesting code location.
33 (label nil
:type
(or label index null
))
34 ;; The VOP that emitted this location (for node, save-set, ir2-block, etc.)
37 ;;; This is called during code generation in places where there is an
38 ;;; "interesting" location: someplace where we are likely to end up
39 ;;; in the debugger, and thus want debug info.
40 (defun note-debug-location (vop label kind
)
41 (declare (type vop vop
) (type (or label null
) label
)
42 (type location-kind kind
))
43 (let ((location (make-location-info kind label vop
)))
44 (setf (ir2-block-locations (vop-block vop
))
45 (nconc (ir2-block-locations (vop-block vop
))
49 #!-sb-fluid
(declaim (inline ir2-block-physenv
))
50 (defun ir2-block-physenv (2block)
51 (declare (type ir2-block
2block
))
52 (block-physenv (ir2-block-block 2block
)))
54 ;;; Given a local conflicts vector and an IR2 block to represent the
55 ;;; set of live TNs, and the VAR-LOCS hash-table representing the
56 ;;; variables dumped, compute a bit-vector representing the set of
57 ;;; live variables. If the TN is environment-live, we only mark it as
58 ;;; live when it is in scope at NODE.
59 (defun compute-live-vars (live node block var-locs vop
)
60 (declare (type ir2-block block
) (type local-tn-bit-vector live
)
61 (type hash-table var-locs
) (type node node
)
62 (type (or vop null
) vop
))
63 (let ((res (make-array (logandc2 (+ (hash-table-count var-locs
) 7) 7)
67 (ir2-component-spilled-vops
68 (component-info *component-being-compiled
*)))))
69 (do-live-tns (tn live block
)
70 (let ((leaf (tn-leaf tn
)))
71 (when (and (lambda-var-p leaf
)
72 (or (not (member (tn-kind tn
)
73 '(:environment
:debug-environment
)))
74 (rassoc leaf
(lexenv-variables (node-lexenv node
))))
76 (not (member tn spilled
))))
77 (let ((num (gethash leaf var-locs
)))
79 (setf (sbit res num
) 1))))))
82 ;;; The PC for the location most recently dumped.
83 (defvar *previous-location
*)
84 (declaim (type index
*previous-location
*))
86 ;;; Dump a compiled debug-location into *BYTE-BUFFER* that describes
87 ;;; the code/source map and live info. If true, VOP is the VOP
88 ;;; associated with this location, for use in determining whether TNs
90 (defun dump-1-location (node block kind tlf-num label live var-locs vop
)
91 (declare (type node node
) (type ir2-block block
)
92 (type local-tn-bit-vector live
)
93 (type (or label index
) label
)
94 (type location-kind kind
) (type (or index null
) tlf-num
)
95 (type hash-table var-locs
) (type (or vop null
) vop
))
98 (dpb (position-or-lose kind
*compiled-code-location-kinds
*)
99 compiled-code-location-kind-byte
103 (let ((loc (if (fixnump label
) label
(label-position label
))))
104 (write-var-integer (- loc
*previous-location
*) *byte-buffer
*)
105 (setq *previous-location
* loc
))
107 (let ((path (node-source-path node
)))
109 (write-var-integer (source-path-tlf-number path
) *byte-buffer
*))
110 (write-var-integer (source-path-form-number path
) *byte-buffer
*))
112 (write-packed-bit-vector (compute-live-vars live node block var-locs vop
)
117 ;;; Extract context info from a Location-Info structure and use it to
118 ;;; dump a compiled code-location.
119 (defun dump-location-from-info (loc tlf-num var-locs
)
120 (declare (type location-info loc
) (type (or index null
) tlf-num
)
121 (type hash-table var-locs
))
122 (let ((vop (location-info-vop loc
)))
123 (dump-1-location (vop-node vop
)
125 (location-info-kind loc
)
127 (location-info-label loc
)
133 ;;; Scan all the blocks, determining if all locations are in the same
134 ;;; TLF, and returning it or NIL.
135 (defun find-tlf-number (fun)
136 (declare (type clambda fun
))
137 (let ((res (source-path-tlf-number (node-source-path (lambda-bind fun
)))))
138 (declare (type (or index null
) res
))
139 (do-physenv-ir2-blocks (2block (lambda-physenv fun
))
140 (let ((block (ir2-block-block 2block
)))
141 (when (eq (block-info block
) 2block
)
142 (unless (eql (source-path-tlf-number
145 (block-start block
))))
149 (dolist (loc (ir2-block-locations 2block
))
150 (unless (eql (source-path-tlf-number
152 (vop-node (location-info-vop loc
))))
157 ;;; Dump out the number of locations and the locations for Block.
158 (defun dump-block-locations (block locations tlf-num var-locs
)
159 (declare (type cblock block
) (list locations
))
161 (eq (location-info-kind (first locations
))
163 (write-var-integer (length locations
) *byte-buffer
*)
164 (let ((2block (block-info block
)))
165 (write-var-integer (+ (length locations
) 1) *byte-buffer
*)
166 (dump-1-location (continuation-next (block-start block
))
167 2block
:block-start tlf-num
168 (ir2-block-%label
2block
)
169 (ir2-block-live-out 2block
)
172 (dolist (loc locations
)
173 (dump-location-from-info loc tlf-num var-locs
))
176 ;;; Dump the successors of Block, being careful not to fly into space
177 ;;; on weird successors.
178 (defun dump-block-successors (block physenv
)
179 (declare (type cblock block
) (type physenv physenv
))
180 (let* ((tail (component-tail (block-component block
)))
181 (succ (block-succ block
))
184 (or (eq (car succ
) tail
)
185 (not (eq (block-physenv (car succ
)) physenv
))))
189 (dpb (length valid-succ
) compiled-debug-block-nsucc-byte
0)
191 (let ((base (block-number
193 (lambda-bind (physenv-lambda physenv
))))))
194 (dolist (b valid-succ
)
196 (the index
(- (block-number b
) base
))
200 ;;; Return a vector and an integer (or null) suitable for use as the
201 ;;; BLOCKS and TLF-NUMBER in FUN's DEBUG-FUN. This requires two
202 ;;; passes to compute:
203 ;;; -- Scan all blocks, dumping the header and successors followed
204 ;;; by all the non-elsewhere locations.
205 ;;; -- Dump the elsewhere block header and all the elsewhere
206 ;;; locations (if any.)
207 (defun compute-debug-blocks (fun var-locs
)
208 (declare (type clambda fun
) (type hash-table var-locs
))
209 (setf (fill-pointer *byte-buffer
*) 0)
210 (let ((*previous-location
* 0)
211 (tlf-num (find-tlf-number fun
))
212 (physenv (lambda-physenv fun
))
215 (collect ((elsewhere))
216 (do-physenv-ir2-blocks (2block physenv
)
217 (let ((block (ir2-block-block 2block
)))
218 (when (eq (block-info block
) 2block
)
220 (dump-block-locations prev-block prev-locs tlf-num var-locs
))
221 (setq prev-block block prev-locs
())
222 (dump-block-successors block physenv
)))
224 (collect ((here prev-locs
))
225 (dolist (loc (ir2-block-locations 2block
))
226 (if (label-elsewhere-p (location-info-label loc
))
229 (setq prev-locs
(here))))
231 (dump-block-locations prev-block prev-locs tlf-num var-locs
)
234 (vector-push-extend compiled-debug-block-elsewhere-p
*byte-buffer
*)
235 (write-var-integer (length (elsewhere)) *byte-buffer
*)
236 (dolist (loc (elsewhere))
237 (dump-location-from-info loc tlf-num var-locs
))))
239 (values (copy-seq *byte-buffer
*) tlf-num
)))
241 ;;; Return a list of DEBUG-SOURCE structures containing information
242 ;;; derived from INFO. Unless :BYTE-COMPILE T was specified, we always
243 ;;; dump the Start-Positions, since it is too hard figure out whether
244 ;;; we need them or not.
245 (defun debug-source-for-info (info)
246 (declare (type source-info info
))
247 (let* ((file-info (source-info-file-info info
))
248 (res (make-debug-source
250 :created
(file-info-write-date file-info
)
251 :compiled
(source-info-start-time info
)
252 :source-root
(file-info-source-root file-info
)
253 :start-positions
(coerce-to-smallest-eltype
254 (file-info-positions file-info
))))
255 (name (file-info-name file-info
)))
258 (setf (debug-source-from res
) name
)
259 (setf (debug-source-name res
)
260 (coerce (file-info-forms file-info
) 'simple-vector
)))
262 (let* ((untruename (file-info-untruename file-info
))
263 (dir (pathname-directory untruename
)))
264 (setf (debug-source-name res
)
266 (if (and dir
(eq (first dir
) :absolute
))
272 ;;; Given an arbitrary sequence, coerce it to an unsigned vector if
273 ;;; possible. Ordinarily we coerce it to the smallest specialized
274 ;;; vector we can. However, we also have a special hack for
275 ;;; cross-compiling at bootstrap time, when arbitrarily-specialized
276 ;;; vectors aren't fully supported: in that case, we coerce it only to
277 ;;; a vector whose element size is an integer multiple of output byte
279 (defun coerce-to-smallest-eltype (seq)
280 (let ((maxoid #-sb-xc-host
0
281 ;; An initial value of 255 prevents us from
282 ;; specializing the array to anything smaller than
283 ;; (UNSIGNED-BYTE 8), which keeps the cross-compiler's
284 ;; portable specialized array output functions happy.
287 (if (typep x
'unsigned-byte
)
290 (return-from coerce-to-smallest-eltype
291 (coerce seq
'simple-vector
)))))
297 (coerce seq
`(simple-array (integer 0 ,maxoid
) (*))))))
301 ;;; Return a SC-OFFSET describing TN's location.
302 (defun tn-sc-offset (tn)
303 (declare (type tn tn
))
304 (make-sc-offset (sc-number (tn-sc tn
))
307 ;;; Dump info to represent VAR's location being TN. ID is an integer
308 ;;; that makes VAR's name unique in the function. BUFFER is the vector
309 ;;; we stick the result in. If MINIMAL, we suppress name dumping, and
310 ;;; set the minimal flag.
312 ;;; The DEBUG-VAR is only marked as always-live if the TN is
313 ;;; environment live and is an argument. If a :DEBUG-ENVIRONMENT TN,
314 ;;; then we also exclude set variables, since the variable is not
315 ;;; guaranteed to be live everywhere in that case.
316 (defun dump-1-variable (fun var tn id minimal buffer
)
317 (declare (type lambda-var var
) (type (or tn null
) tn
) (type index id
)
319 (let* ((name (leaf-debug-name var
))
320 (save-tn (and tn
(tn-save-tn tn
)))
321 (kind (and tn
(tn-kind tn
)))
323 (declare (type index flags
))
325 (setq flags
(logior flags compiled-debug-var-minimal-p
))
327 (setq flags
(logior flags compiled-debug-var-deleted-p
))))
328 (when (and (or (eq kind
:environment
)
329 (and (eq kind
:debug-environment
)
330 (null (basic-var-sets var
))))
331 (not (gethash tn
(ir2-component-spilled-tns
332 (component-info *component-being-compiled
*))))
333 (eq (lambda-var-home var
) fun
))
334 (setq flags
(logior flags compiled-debug-var-environment-live
)))
336 (setq flags
(logior flags compiled-debug-var-save-loc-p
)))
337 (unless (or (zerop id
) minimal
)
338 (setq flags
(logior flags compiled-debug-var-id-p
)))
339 (vector-push-extend flags buffer
)
341 (vector-push-extend name buffer
)
343 (vector-push-extend id buffer
)))
345 (vector-push-extend (tn-sc-offset tn
) buffer
)
348 (vector-push-extend (tn-sc-offset save-tn
) buffer
)))
351 ;;; Return a vector suitable for use as the DEBUG-FUN-VARIABLES
352 ;;; of FUN. LEVEL is the current DEBUG-INFO quality. VAR-LOCS is a
353 ;;; hash table in which we enter the translation from LAMBDA-VARS to
354 ;;; the relative position of that variable's location in the resulting
356 (defun compute-variables (fun level var-locs
)
357 (declare (type clambda fun
) (type hash-table var-locs
))
359 (labels ((frob-leaf (leaf tn gensym-p
)
360 (let ((name (leaf-debug-name leaf
)))
361 (when (and name
(leaf-refs leaf
) (tn-offset tn
)
362 (or gensym-p
(symbol-package name
)))
363 (vars (cons leaf tn
)))))
364 (frob-lambda (x gensym-p
)
365 (dolist (leaf (lambda-vars x
))
366 (frob-leaf leaf
(leaf-info leaf
) gensym-p
))))
369 (dolist (x (ir2-physenv-closure (physenv-info (lambda-physenv fun
))))
370 (let ((thing (car x
)))
371 (when (lambda-var-p thing
)
372 (frob-leaf thing
(cdr x
) (= level
3)))))
374 (dolist (let (lambda-lets fun
))
375 (frob-lambda let
(= level
3)))))
377 (let ((sorted (sort (vars) #'string
<
379 (symbol-name (leaf-debug-name (car x
))))))
383 (buffer (make-array 0 :fill-pointer
0 :adjustable t
)))
384 (declare (type (or simple-string null
) prev-name
)
388 (name (symbol-name (leaf-debug-name var
))))
389 (cond ((and prev-name
(string= prev-name name
))
392 (setq id
0 prev-name name
)))
393 (dump-1-variable fun var
(cdr x
) id nil buffer
)
394 (setf (gethash var var-locs
) i
))
396 (coerce buffer
'simple-vector
))))
398 ;;; Return a vector suitable for use as the DEBUG-FUN-VARIABLES of
399 ;;; FUN, representing the arguments to FUN in minimal variable format.
400 (defun compute-minimal-variables (fun)
401 (declare (type clambda fun
))
402 (let ((buffer (make-array 0 :fill-pointer
0 :adjustable t
)))
403 (dolist (var (lambda-vars fun
))
404 (dump-1-variable fun var
(leaf-info var
) 0 t buffer
))
405 (coerce buffer
'simple-vector
)))
407 ;;; Return VAR's relative position in the function's variables (determined
408 ;;; from the VAR-LOCS hashtable). If VAR is deleted, then return DELETED.
409 (defun debug-location-for (var var-locs
)
410 (declare (type lambda-var var
) (type hash-table var-locs
))
411 (let ((res (gethash var var-locs
)))
414 (aver (or (null (leaf-refs var
))
415 (not (tn-offset (leaf-info var
)))))
418 ;;;; arguments/returns
420 ;;; Return a vector to be used as the
421 ;;; COMPILED-DEBUG-FUN-ARGUMENTS for Fun. If fun is the
422 ;;; MAIN-ENTRY for an optional dispatch, then look at the ARGLIST to
423 ;;; determine the syntax, otherwise pretend all arguments are fixed.
425 ;;; ### This assumption breaks down in EPs other than the main-entry,
426 ;;; since they may or may not have supplied-p vars, etc.
427 (defun compute-arguments (fun var-locs
)
428 (declare (type clambda fun
) (type hash-table var-locs
))
430 (let ((od (lambda-optional-dispatch fun
)))
431 (if (and od
(eq (optional-dispatch-main-entry od
) fun
))
432 (let ((actual-vars (lambda-vars fun
))
434 (dolist (arg (optional-dispatch-arglist od
))
435 (let ((info (lambda-var-arg-info arg
))
436 (actual (pop actual-vars
)))
438 (case (arg-info-kind info
)
440 (res (arg-info-key info
)))
448 (setq saw-optional t
))))
449 (res (debug-location-for actual var-locs
))
450 (when (arg-info-supplied-p info
)
452 (res (debug-location-for (pop actual-vars
) var-locs
))))
454 (res (debug-location-for actual var-locs
)))))))
455 (dolist (var (lambda-vars fun
))
456 (res (debug-location-for var var-locs
)))))
458 (coerce-to-smallest-eltype (res))))
460 ;;; Return a vector of SC offsets describing FUN's return locations.
461 ;;; (Must be known values return...)
462 (defun compute-debug-returns (fun)
463 (coerce-to-smallest-eltype
464 (mapcar (lambda (loc)
466 (return-info-locations (tail-set-info (lambda-tail-set fun
))))))
470 ;;; Return a C-D-F structure with all the mandatory slots filled in.
471 (defun dfun-from-fun (fun)
472 (declare (type clambda fun
))
473 (let* ((2env (physenv-info (lambda-physenv fun
)))
474 (dispatch (lambda-optional-dispatch fun
))
475 (main-p (and dispatch
476 (eq fun
(optional-dispatch-main-entry dispatch
)))))
477 (make-compiled-debug-fun
478 :name
(leaf-debug-name fun
)
479 :kind
(if main-p nil
(functional-kind fun
))
480 :return-pc
(tn-sc-offset (ir2-physenv-return-pc 2env
))
481 :old-fp
(tn-sc-offset (ir2-physenv-old-fp 2env
))
482 :start-pc
(label-position (ir2-physenv-environment-start 2env
))
483 :elsewhere-pc
(label-position (ir2-physenv-elsewhere-start 2env
)))))
485 ;;; Return a complete C-D-F structure for FUN. This involves
486 ;;; determining the DEBUG-INFO level and filling in optional slots as
488 (defun compute-1-debug-fun (fun var-locs
)
489 (declare (type clambda fun
) (type hash-table var-locs
))
490 (let* ((dfun (dfun-from-fun fun
))
491 (actual-level (policy (lambda-bind fun
) debug
))
492 (level (if #!+sb-dyncount
*collect-dynamic-statistics
*
496 (cond ((zerop level
))
498 (let ((od (lambda-optional-dispatch fun
)))
500 (not (eq (optional-dispatch-main-entry od
) fun
)))))
501 (setf (compiled-debug-fun-variables dfun
)
502 (compute-minimal-variables fun
))
503 (setf (compiled-debug-fun-arguments dfun
) :minimal
))
505 (setf (compiled-debug-fun-variables dfun
)
506 (compute-variables fun level var-locs
))
507 (setf (compiled-debug-fun-arguments dfun
)
508 (compute-arguments fun var-locs
))))
511 (multiple-value-bind (blocks tlf-num
) (compute-debug-blocks fun var-locs
)
512 (setf (compiled-debug-fun-tlf-number dfun
) tlf-num
)
513 (setf (compiled-debug-fun-blocks dfun
) blocks
)))
516 (setf (compiled-debug-fun-returns dfun
) :standard
)
517 (let ((info (tail-set-info (lambda-tail-set fun
))))
519 (cond ((eq (return-info-kind info
) :unknown
)
520 (setf (compiled-debug-fun-returns dfun
)
523 (setf (compiled-debug-fun-returns dfun
)
524 (compute-debug-returns fun
)))))))
527 ;;;; full component dumping
529 ;;; Compute the full form (simple-vector) function map.
530 (defun compute-debug-fun-map (sorted)
531 (declare (list sorted
))
532 (let* ((len (1- (* (length sorted
) 2)))
533 (funs-vec (make-array len
)))
535 (sorted sorted
(cdr sorted
)))
538 (let ((dfun (car sorted
)))
540 (setf (svref funs-vec i
) (car dfun
)))
541 (setf (svref funs-vec
(1+ i
)) (cdr dfun
))))
544 ;;; Return a DEBUG-INFO structure describing COMPONENT. This has to be
545 ;;; called after assembly so that source map information is available.
546 (defun debug-info-for-component (component)
547 (declare (type component component
))
549 (var-locs (make-hash-table :test
'eq
))
550 (*byte-buffer
* (make-array 10
551 :element-type
'(unsigned-byte 8)
554 (dolist (lambda (component-lambdas component
))
556 (push (cons (label-position (block-label (lambda-block lambda
)))
557 (compute-1-debug-fun lambda var-locs
))
559 (let* ((sorted (sort dfuns
#'< :key
#'car
))
560 (fun-map (compute-debug-fun-map sorted
)))
561 (make-compiled-debug-info :name
(component-name component
)
564 ;;; Write BITS out to BYTE-BUFFER in backend byte order. The length of
565 ;;; BITS must be evenly divisible by eight.
566 (defun write-packed-bit-vector (bits byte-buffer
)
567 (declare (type simple-bit-vector bits
) (type byte-buffer byte-buffer
))
569 ;; Enforce constraint from CMU-CL-era comment.
570 (aver (zerop (mod (length bits
) 8)))
572 (multiple-value-bind (initial step done
)
573 (ecase *backend-byte-order
*
574 (:little-endian
(values 0 1 8))
575 (:big-endian
(values 7 -
1 -
1)))
576 (let ((shift initial
)
578 (dotimes (i (length bits
))
579 (let ((int (aref bits i
)))
580 (setf byte
(logior byte
(ash int shift
)))
583 (vector-push-extend byte byte-buffer
)
586 (unless (= shift initial
)
587 (vector-push-extend byte byte-buffer
))))