debug-dump.lisp 17.4 KB
Newer Older
wlott's avatar
wlott committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
;;; -*- Package: C; Log: C.Log -*-
;;;
;;; **********************************************************************
;;; This code was written as part of the Spice Lisp project at
;;; Carnegie-Mellon University, and has been placed in the public domain.
;;; If you want to use this code or any part of Spice Lisp, please contact
;;; Scott Fahlman (FAHLMAN@CMUC). 
;;; **********************************************************************
;;;
;;;    This file contains stuff that creates debugger information from the
;;; compiler's internal data structures.
;;; 
;;; Written by Rob MacLachlan
;;;
(in-package 'c)

17
18
19
20
(defvar *byte-buffer*
  (make-array 10 :element-type '(unsigned-byte 8)
	      :fill-pointer 0  :adjustable t))

21
22
23
24

;;;; Debug blocks:

(deftype location-kind ()
ram's avatar
ram committed
25
26
  '(member :unknown-return :known-return :internal-error :non-local-exit
	   :block-start))
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50


;;; The Location-Info structure holds the information what we need about
;;; locations which code generation decided were "interesting".
;;;
(defstruct (location-info
	    (:constructor make-location-info (kind label vop)))
  ;;
  ;; The kind of location noted.
  (kind nil :type location-kind)
  ;;
  ;; The label pointing to the interesting code location.
  (label nil :type label)
  ;;
  ;; The VOP that emitted this location (for node, save-set, ir2-block, etc.)
  (vop nil :type vop))


;;; NOTE-DEBUG-LOCATION  --  Interface
;;;
;;;    Called during code generation in places where there is an "interesting"
;;; location: some place where we are likely to end up in the debugger, and
;;; thus want debug info.
;;;
51
(defun note-debug-location (vop label kind)
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
  (declare (type vop vop) (type label label) (type location-kind kind))
  (setf (ir2-block-locations (vop-block vop))
	(nconc (ir2-block-locations (vop-block vop))
	       (list (make-location-info kind label vop))))
  (undefined-value))


;;; IR2-BLOCK-ENVIRONMENT  --  Interface
;;;
(proclaim '(inline ir2-block-environment))
(defun ir2-block-environment (2block)
  (declare (type ir2-block 2block))
  (lambda-environment (block-lambda (ir2-block-block 2block))))


;;; COMPUTE-LIVE-VARS  --  Internal
;;;
;;;    Given a local conflicts vector and an IR2 block to represent the set of
;;; live TNs, and the Var-Locs hashtable representing the variables dumped,
;;; compute a bit-vector representing the set of live variables.
;;;
(defun compute-live-vars (live block var-locs)
  (declare (type ir2-block block) (type local-tn-bit-vector live)
	   (type hash-table var-locs))
76
  (let ((res (make-array (logandc2 (+ (hash-table-count var-locs) 7) 7)
77
78
79
80
81
82
83
			 :element-type 'bit
			 :initial-element 0)))
    (do-live-tns (tn live block)
      (let ((leaf (tn-leaf tn)))
	(when (lambda-var-p leaf)
	  (let ((num (gethash leaf var-locs)))
	    (when num
ram's avatar
ram committed
84
85
	      (setf (sbit res num) 1))))))
    res))
86
87
88
89
90
91
92
93
94
95
96
97
98
99


;;; The PC for the location most recently dumped.
;;;
(defvar *previous-location*)

;;; DUMP-1-LOCATION  --  Internal
;;;
;;;    Dump a compiled debug-location into *BYTE-BUFFER* that describes the
;;; code/source map and live info.
;;;
(defun dump-1-location (node block kind tlf-num label live var-locs)
  (declare (type node node) (type ir2-block block)
	   (type local-tn-bit-vector live) (type label label)
ram's avatar
ram committed
100
	   (type location-kind kind) (type (or index null) tlf-num)
101
102
103
	   (type hash-table var-locs))
  
  (vector-push-extend
104
105
106
   (dpb (position kind compiled-code-location-kinds)
	compiled-code-location-kind-byte
	0)
107
108
109
110
111
112
113
   *byte-buffer*)
  
  (let ((loc (label-location label)))
    (write-var-integer (- loc *previous-location*) *byte-buffer*)
    (setq *previous-location* loc))
  
  (unless tlf-num
ram's avatar
ram committed
114
115
    (write-var-integer (node-tlf-number node) *byte-buffer*))
  (write-var-integer (first (node-source-path node)) *byte-buffer*)
116
117
118
119
120
121
122
123
124
125
126
127
  
  (write-packed-bit-vector (compute-live-vars live block var-locs)
			   *byte-buffer*)
  
  (undefined-value))


;;; DUMP-LOCATION-FROM-INFO  --  Internal
;;;
;;;    Extract context info from a Location-Info structure and use it to dump a
;;; compiled code-location.
;;;
ram's avatar
ram committed
128
129
130
(defun dump-location-from-info (loc tlf-num var-locs)
  (declare (type location-info loc) (type (or index null) tlf-num)
	   (type hash-table var-locs))
131
132
133
134
135
136
137
138
139
140
141
  (let ((vop (location-info-vop loc)))
    (dump-1-location (vop-node vop)
		     (vop-block vop)
		     (location-info-kind loc)
		     tlf-num
		     (location-info-label loc)
		     (vop-save-set vop)
		     var-locs))
  (undefined-value))


142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
;;; FIND-TLF-AND-BLOCK-NUMBERS  --  Internal
;;;
;;;    Scan all the blocks, caching the block numbering in the BLOCK-FLAG and
;;; determining if all locations are in the same TLF.
;;;
(defun find-tlf-and-block-numbers (fun)
  (declare (type clambda fun))
  (let ((res (node-tlf-number (lambda-bind fun)))
	(num 0))
    (do-environment-ir2-blocks (2block (lambda-environment fun))
      (let ((block (ir2-block-block 2block)))
	(when (eq (block-info block) 2block)
	  (setf (block-flag block) num)
	  (incf num)
	  (unless (eql (node-tlf-number (continuation-next (block-start block)))
		       res)
	    (setq res nil)))
	
	(dolist (loc (ir2-block-locations 2block))
	  (unless (eql (node-tlf-number (vop-node (location-info-vop loc)))
		       res)
	    (setq res nil)))))
    res))


;;; DUMP-BLOCK-LOCATIONS  --  Internal
;;;
;;;    Dump out the number of locations and the locations for Block.
;;;
(defun dump-block-locations (block locations tlf-num var-locs)
  (declare (type cblock block) (list locations))
  (write-var-integer (1+ (length locations)) *byte-buffer*)
  (let ((2block (block-info block)))
    (dump-1-location (continuation-next (block-start block))
		     2block :block-start tlf-num
		     (ir2-block-%label 2block)
		     (ir2-block-live-out 2block)
		     var-locs))
  (dolist (loc locations)
    (dump-location-from-info loc tlf-num var-locs))
  (undefined-value))


;;; DUMP-BLOCK-SUCCESSORS  --  Internal
;;;
;;;    Dump the successors of Block, being careful not to fly into space on
;;; weird successors.
;;;
(defun dump-block-successors (block env)
  (declare (type cblock block) (type environment env))
  (let* ((tail (component-tail (block-component block)))
	 (succ (block-succ block))
	 (valid-succ
	  (if (and succ
		   (or (eq (car succ) tail)
		       (not (eq (lambda-environment (block-lambda (car succ)))
				env))))
	      ()
	      succ)))
    (vector-push-extend
     (dpb (length valid-succ) compiled-debug-block-nsucc-byte 0)
     *byte-buffer*)
    (dolist (b valid-succ)
      (write-var-integer (block-flag b) *byte-buffer*)))
  (undefined-value))


209
210
211
212
213
214
215
;;; COMPUTE-DEBUG-BLOCKS  --  Internal
;;;
;;;    Return a vector and an integer (or null) suitable for use as the BLOCKS
;;; and TLF-NUMBER in Fun's debug-function.  This requires three passes to
;;; compute:
;;; -- Scan all blocks, dumping the header and successors followed by all the
;;;    non-elsewhere locations.
216
217
;;; -- Dump the elsewhere block header and all the elsewhere locations (if
;;;    any.)
218
219
220
221
222
;;;
(defun compute-debug-blocks (fun var-locs)
  (declare (type clambda fun) (type hash-table var-locs))
  (setf (fill-pointer *byte-buffer*) 0)
  (let ((*previous-location* 0)
223
224
225
226
227
228
	(tlf-num (find-tlf-and-block-numbers fun))
	(env (lambda-environment fun))
	(prev-locs nil)
	(prev-block nil))
    (collect ((elsewhere))
      (do-environment-ir2-blocks (2block env)
229
230
	(let ((block (ir2-block-block 2block)))
	  (when (eq (block-info block) 2block)
231
232
233
234
235
236
	    (when prev-block
	      (dump-block-locations prev-block prev-locs tlf-num var-locs))
	    (setq prev-block block  prev-locs ())
	    (dump-block-successors block env)))
	
	(collect ((here prev-locs))
237
	  (dolist (loc (ir2-block-locations 2block))
238
239
240
241
	    (if (label-elsewhere-p (location-info-label loc))
		(elsewhere loc)
		(here loc)))
	  (setq prev-locs (here))))
242

243
      (dump-block-locations prev-block prev-locs tlf-num var-locs)
244
245
246
247
248
249

      (when (elsewhere)
	(vector-push-extend compiled-debug-block-elsewhere-p *byte-buffer*)
	(write-var-integer (length (elsewhere)) *byte-buffer*)
	(dolist (loc (elsewhere))
	  (dump-location-from-info loc tlf-num var-locs))))
250
251
252
253

    (values (copy-seq *byte-buffer*) tlf-num)))


wlott's avatar
wlott committed
254
255
256
257
258
259
260
261
262
263
264
265
;;; DEBUG-SOURCE-FOR-INFO  --  Interface
;;;
;;;    Return a list of DEBUG-SOURCE structures containing information derived
;;; from Info.
;;;
(defun debug-source-for-info (info)
  (declare (type source-info info))
  (assert (not (source-info-current-file info)))
  (mapcar #'(lambda (x)
	      (let ((name (file-info-name x))
		    (res (make-debug-source
			  :from :file
266
			  :comment (file-info-comment x)
wlott's avatar
wlott committed
267
268
269
			  :created (file-info-write-date x)
			  :compiled (source-info-start-time info)
			  :source-root (file-info-source-root x)
ram's avatar
ram committed
270
271
272
273
			  :start-positions
			  (when (policy nil (>= debug 2))
			    (coerce-to-smallest-eltype
			     (file-info-positions x))))))
wlott's avatar
wlott committed
274
275
276
277
278
279
280
281
282
283
284
		(cond ((pathnamep name)
		       (setf (debug-source-name res) name))
		      (t
		       (setf (debug-source-from res) name)
		       (when (eq name :lisp)
			 (setf (debug-source-name res)
			       (cadr (aref (file-info-forms x) 0))))))
		res))
	  (source-info-files info)))


285
286
287
288
289
290
291
292
293
294
295
296
297
;;; COERCE-TO-SMALLEST-ELTYPE  --  Internal
;;;
;;;    Given an arbirtary sequence, coerce it to an unsigned vector if
;;; possible.
;;;
(defun coerce-to-smallest-eltype (seq)
  (let ((max 0))
    (macrolet ((frob ()
		 '(if (and (integerp val) (>= val 0) max)
		      (when (> val max)
			(setq max val))
		      (setq max nil))))
      (if (listp seq)
ram's avatar
ram committed
298
	  (dolist (val seq)
299
300
301
302
303
304
	    (frob))
	  (dotimes (i (length seq))
	    (let ((val (aref seq i)))
	      (frob)))))
    
    (if max
305
	(coerce seq `(simple-array (integer 0 ,max)))
306
307
308
309
310
	(coerce seq 'simple-vector))))


;;;; Locations:

311
312
313
314
315
316
317
318
319
320
;;; TN-SC-OFFSET  --  Internal
;;;
;;;    Return a SC-OFFSET describing TN's location.
;;;
(defun tn-sc-offset (tn)
  (declare (type tn tn))
  (make-sc-offset (sc-number (tn-sc tn))
		  (tn-offset tn)))


321
;;; DUMP-1-VARIABLE  --  Internal
322
323
324
325
;;;
;;;    Dump info to represent Var's location being TN.  ID is an integer that
;;; makes Var's name unique in the function.  Buffer is the vector we stick the
;;; result in.
wlott's avatar
wlott committed
326
;;;
327
(defun dump-1-variable (var tn id buffer)
328
329
330
331
332
333
334
  (declare (type lambda-var var) (type tn tn) (type unsigned-byte id))
  (let* ((name (leaf-name var))
	 (package (symbol-package name))
	 (package-p (and package (not (eq package *package*))))
	 (save-tn (tn-save-tn tn))
	 (flags 0))
    (unless package
335
      (setq flags (logior flags compiled-debug-variable-uninterned)))
336
    (when package-p
337
      (setq flags (logior flags compiled-debug-variable-packaged)))
338
    (when (eq (tn-kind tn) :environment)
339
      (setq flags (logior flags compiled-debug-variable-environment-live)))
340
    (when save-tn
341
      (setq flags (logior flags compiled-debug-variable-save-loc-p)))
342
    (unless (zerop id)
343
      (setq flags (logior flags compiled-debug-variable-id-p)))
344
345
346
347
348
349
350
351
352
353
    (vector-push-extend flags buffer)
    (write-var-string (symbol-name name) buffer)
    (when package-p
      (write-var-string (package-name package) buffer))
    (unless (zerop id)
      (write-var-integer id buffer))
    (write-var-integer (tn-sc-offset tn) buffer)
    (when save-tn
      (write-var-integer (tn-sc-offset save-tn) buffer)))
  (undefined-value))
wlott's avatar
wlott committed
354
355
356
357
358


;;; COMPUTE-VARIABLES  --  Internal
;;;
;;;    Return a vector suitable for use as the DEBUG-FUNCTION-VARIABLES of Fun.
359
360
361
;;; Level is the current DEBUG-INFO quality.  Var-Locs is a hashtable in which
;;; we enter the translation from LAMBDA-VARS to the relative position of that
;;; variable's location in the resulting vector.
wlott's avatar
wlott committed
362
;;;
363
(defun compute-variables (fun level var-locs)
wlott's avatar
wlott committed
364
  (declare (type clambda fun) (type hash-table var-locs))
365
366
  (collect ((vars))
    (labels ((frob-leaf (leaf tn gensym-p)
wlott's avatar
wlott committed
367
368
	       (let ((name (leaf-name leaf)))
		 (when (and name (leaf-refs leaf)
369
370
371
372
373
374
375
376
377
378
379
380
381
382
			    (or gensym-p (symbol-package name)))
		   (vars (cons leaf tn)))))
	     (frob-lambda (x gensym-p)
	       (dolist (leaf (lambda-vars x))
		 (frob-leaf leaf (leaf-info leaf) gensym-p))))
      (frob-lambda fun t)
      (when (>= level 2)
	(dolist (x (ir2-environment-environment
		    (environment-info (lambda-environment fun))))
	  (let ((thing (car x)))
	    (when (lambda-var-p thing)
	      (frob-leaf thing (cdr x) (= level 3)))))
	
	(dolist (let (lambda-lets fun))
ram's avatar
ram committed
383
	  (frob-lambda let (= level 3)))))
wlott's avatar
wlott committed
384
    
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
    (setf (fill-pointer *byte-buffer*) 0)
    (let ((sorted (sort (vars) #'string<
			:key #'(lambda (x)
				 (symbol-name (leaf-name (car x))))))
	  (prev-name nil)
	  (id 0)
	  (i 0))
      (declare (type (or simple-string null) prev-name))
      (dolist (x sorted)
	(let* ((var (car x))
	       (name (symbol-name (leaf-name var))))
	  (cond ((and prev-name (string= prev-name name))
		 (incf id))
		(t
		 (setq id 0  prev-name name)))
400
401
	  (dump-1-variable var (cdr x) id *byte-buffer*)
	  (setf (gethash var var-locs) i))
402
403
404
405
406
407
408
409
	(incf i)))

    (copy-seq *byte-buffer*)))


;;; DEBUG-LOCATION-FOR  --  Internal
;;;
;;;    Return Var's relative position in the function's variables (determined
410
;;; from the Var-Locs hashtable.)  If Var is deleted, the return DELETED.
411
412
;;;
(defun debug-location-for (var var-locs)
ram's avatar
ram committed
413
  (declare (type lambda-var var) (type hash-table var-locs))
414
  (let ((res (gethash var var-locs)))
415
416
417
418
    (cond (res)
	  (t
	   (assert (null (leaf-refs var)))
	   'deleted))))
wlott's avatar
wlott committed
419

420
421

;;;; Arguments/returns:
wlott's avatar
wlott committed
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436

;;; COMPUTE-ARGUMENTS  --  Internal
;;;
;;;    Return a vector to be used as the COMPILED-DEBUG-FUNCTION-ARGUMENTS for
;;; Fun.  If fun is the MAIN-ENTRY for an optional dispatch, then look at the
;;; ARGLIST to determine the syntax, otherwise pretend all arguments are fixed.
;;;
;;; ### This assumption breaks down in EPs other than the main-entry, since
;;; they may or may not have supplied-p vars, etc.
;;;
(defun compute-arguments (fun var-locs)
  (declare (type clambda fun) (type hash-table var-locs))
  (collect ((res))
    (let ((od (lambda-optional-dispatch fun)))
      (if (and od (eq (optional-dispatch-main-entry od) fun))
437
438
	  (let ((actual-vars (lambda-vars fun))
		(saw-optional nil))
wlott's avatar
wlott committed
439
440
441
442
443
444
445
446
	    (dolist (arg (optional-dispatch-arglist od))
	      (let ((info (lambda-var-arg-info arg))
		    (actual (pop actual-vars)))
		(cond (info
		       (case (arg-info-kind info)
			 (:keyword
			  (res (arg-info-keyword info)))
			 (:rest
447
448
449
450
451
			  (res 'rest-arg))
			 (:optional
			  (unless saw-optional
			    (res 'optional-args)
			    (setq saw-optional t))))
wlott's avatar
wlott committed
452
453
454
455
456
457
458
459
460
		       (res (debug-location-for actual var-locs))
		       (when (arg-info-supplied-p info)
			 (res 'supplied-p)
			 (res (debug-location-for (pop actual-vars) var-locs))))
		      (t
		       (res (debug-location-for actual var-locs)))))))
	  (dolist (var (lambda-vars fun))
	    (res (debug-location-for var var-locs)))))

461
    (coerce-to-smallest-eltype (res))))
wlott's avatar
wlott committed
462
463
464
465


;;; COMPUTE-DEBUG-RETURNS  --  Internal
;;;
466
467
;;;    Return a vector of SC offsets describing Fun's return locations.  (Must
;;; be known values return...)
wlott's avatar
wlott committed
468
469
;;;
(defun compute-debug-returns (fun)
470
471
472
473
  (coerce-to-smallest-eltype 
   (mapcar #'(lambda (loc)
	       (tn-sc-offset loc))
	   (return-info-locations (tail-set-info (lambda-tail-set fun))))))
wlott's avatar
wlott committed
474

475

wlott's avatar
wlott committed
476
477
478
479
480
481
482
483
484
;;; DEBUG-INFO-FOR-COMPONENT  --  Interface
;;;
;;; Return a debug-info structure describing component.  This has to be called
;;; at some particular time (after assembly) so that source map information is
;;; available.
;;; 
(defun debug-info-for-component (component assem-nodes count)
  (declare (type component component) (simple-vector assem-nodes)
	   (type index count))
485
486
487
  (let ((level (cookie-debug *default-cookie*))
	(res (make-compiled-debug-info :name (component-name component)
				       :package (package-name *package*))))
wlott's avatar
wlott committed
488
489
490
491
    (collect ((dfuns))
      (let ((var-locs (make-hash-table :test #'eq)))
	(dolist (fun (component-lambdas component))
	  (clrhash var-locs)
492
	  (let* ((2env (environment-info (lambda-environment fun)))
493
494
495
		 (dispatch (lambda-optional-dispatch fun))
		 (main-p (and dispatch
			      (eq fun (optional-dispatch-main-entry fun))))
496
497
		 (dfun (make-compiled-debug-function
			:name (cond ((leaf-name fun))
498
499
				    ((let ((ef (functional-entry-function
						fun)))
500
				       (and ef (leaf-name ef))))
501
				    (main-p (leaf-name dispatch))
502
503
				    (t
				     (component-name component)))
504
			:kind (if main-p nil (functional-kind fun))
505
506
			:return-pc (tn-sc-offset
				    (ir2-environment-return-pc 2env))
507
508
			:old-fp (tn-sc-offset
				 (ir2-environment-old-fp 2env))
509
510
511
512
513
514
			:start-pc (label-location
				   (ir2-environment-environment-start 2env))

			:elsewhere-pc
			(label-location
			 (ir2-environment-elsewhere-start 2env)))))
wlott's avatar
wlott committed
515
	    
516
	    (when (>= level 1)
wlott's avatar
wlott committed
517
	      (setf (compiled-debug-function-variables dfun)
518
		    (compute-variables fun level var-locs)))
wlott's avatar
wlott committed
519

520
	    (unless (= level 0)
wlott's avatar
wlott committed
521
522
523
	      (setf (compiled-debug-function-arguments dfun)
		    (compute-arguments fun var-locs)))

524
525
	    (when (>= level 2)
	      (multiple-value-bind (blocks tlf-num)
ram's avatar
ram committed
526
				   (compute-debug-blocks fun var-locs)
527
528
		(setf (compiled-debug-function-tlf-number dfun) tlf-num)
		(setf (compiled-debug-function-blocks dfun) blocks)))
529

wlott's avatar
wlott committed
530
531
532
533
534
535
	    (let ((tails (lambda-tail-set fun)))
	      (when tails
		(let ((info (tail-set-info tails)))
		  (cond ((eq (return-info-kind info) :unknown)
			 (setf (compiled-debug-function-returns dfun)
			       :standard))
536
			((/= level 0)
wlott's avatar
wlott committed
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
			 (setf (compiled-debug-function-returns dfun)
			       (compute-debug-returns fun)))))))

	    (dfuns (cons (label-location
			  (block-label
			   (node-block
			    (lambda-bind fun))))
			 dfun)))))

      (let* ((sorted (sort (dfuns) #'< :key #'car))
	     (len (1- (* (length sorted) 2)))
	     (funs-vec (make-array len)))
	(do ((i -1 (+ i 2))
	     (sorted sorted (cdr sorted)))
	    ((= i len))
	  (let ((dfun (car sorted)))
	    (unless (minusp i)
	      (setf (svref funs-vec i) (car dfun)))
	    (setf (svref funs-vec (1+ i)) (cdr dfun))))
	(setf (compiled-debug-info-function-map res) funs-vec)))

    res))