debug-dump.lisp 25.4 KB
Newer Older
wlott's avatar
wlott committed
1
2
3
;;; -*- Package: C; Log: C.Log -*-
;;;
;;; **********************************************************************
ram's avatar
ram committed
4
5
6
7
8
9
;;; This code was written as part of the CMU Common 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 CMU Common Lisp, please contact
;;; Scott Fahlman or slisp-group@cs.cmu.edu.
;;;
(ext:file-comment
10
  "$Header: /Volumes/share2/src/cmucl/cvs2git/cvsroot/src/compiler/debug-dump.lisp,v 1.23 1991/04/08 12:44:34 ram Exp $")
ram's avatar
ram committed
11
;;;
wlott's avatar
wlott committed
12
13
14
15
16
17
18
19
20
;;; **********************************************************************
;;;
;;;    This file contains stuff that creates debugger information from the
;;; compiler's internal data structures.
;;; 
;;; Written by Rob MacLachlan
;;;
(in-package 'c)

21
22
(defvar *byte-buffer*)
(declaim (type (vector (unsigned-byte 8)) *byte-buffer*))
23

24
25
26
27

;;;; Debug blocks:

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


;;; 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.
;;;
54
(defun note-debug-location (vop label kind)
55
56
57
58
59
60
61
62
63
64
65
66
  (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))
67
  (block-environment (ir2-block-block 2block)))
68
69
70
71
72


;;; COMPUTE-LIVE-VARS  --  Internal
;;;
;;;    Given a local conflicts vector and an IR2 block to represent the set of
73
;;; live TNs, and the Var-Locs hash-table representing the variables dumped,
74
75
;;; compute a bit-vector representing the set of live variables.  If the TN is
;;; environment-live, we only mark it as live when it is in scope at Node.
76
;;;
77
(defun compute-live-vars (live node block var-locs vop)
78
  (declare (type ir2-block block) (type local-tn-bit-vector live)
79
80
	   (type hash-table var-locs) (type node node)
	   (type (or vop null) vop))
81
  (let ((res (make-array (logandc2 (+ (hash-table-count var-locs) 7) 7)
82
			 :element-type 'bit
83
84
85
86
			 :initial-element 0))
	(spilled (gethash vop
			  (ir2-component-spilled-vops
			   (component-info *compile-component*)))))
87
88
    (do-live-tns (tn live block)
      (let ((leaf (tn-leaf tn)))
89
	(when (and (lambda-var-p leaf)
90
91
		   (or (not (member (tn-kind tn)
				    '(:environment :debug-environment)))
92
93
94
		       (rassoc leaf (lexenv-variables (node-lexenv node))))
		   (or (null spilled)
		       (not (member tn spilled))))
95
96
	  (let ((num (gethash leaf var-locs)))
	    (when num
ram's avatar
ram committed
97
98
	      (setf (sbit res num) 1))))))
    res))
99
100
101
102
103


;;; The PC for the location most recently dumped.
;;;
(defvar *previous-location*)
104
(proclaim '(type index *previous-location*))
105
106
107
108

;;; DUMP-1-LOCATION  --  Internal
;;;
;;;    Dump a compiled debug-location into *BYTE-BUFFER* that describes the
109
110
;;; code/source map and live info.  If true, VOP is the VOP associated with
;;; this location, for use in determining whether TNs are spilled.
111
;;;
112
(defun dump-1-location (node block kind tlf-num label live var-locs vop)
113
114
  (declare (type node node) (type ir2-block block)
	   (type local-tn-bit-vector live) (type label label)
ram's avatar
ram committed
115
	   (type location-kind kind) (type (or index null) tlf-num)
116
	   (type hash-table var-locs) (type (or vop null) vop))
117
118
  
  (vector-push-extend
119
120
121
   (dpb (position kind compiled-code-location-kinds)
	compiled-code-location-kind-byte
	0)
122
123
   *byte-buffer*)
  
wlott's avatar
wlott committed
124
  (let ((loc (label-position label)))
125
126
    (write-var-integer (- loc *previous-location*) *byte-buffer*)
    (setq *previous-location* loc))
127
128
129
130
131

  (let ((path (node-source-path node)))
    (unless tlf-num
      (write-var-integer (source-path-tlf-number path) *byte-buffer*))
    (write-var-integer (source-path-form-number path) *byte-buffer*))
132
  
133
  (write-packed-bit-vector (compute-live-vars live node block var-locs vop)
134
135
136
137
138
139
140
141
142
143
			   *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
144
145
146
(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))
147
148
149
150
151
152
153
  (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)
154
155
		     var-locs
		     vop))
156
157
158
  (undefined-value))


159
160
161
162
163
164
165
;;; 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))
166
  (let ((res (source-path-tlf-number (node-source-path (lambda-bind fun))))
167
	(num 0))
168
    (declare (type index num) (type (or index null) res))
169
170
171
172
173
    (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)
174
175
176
177
	  (unless (eql (source-path-tlf-number
			(node-source-path
			 (continuation-next
			  (block-start block))))
178
179
180
181
		       res)
	    (setq res nil)))
	
	(dolist (loc (ir2-block-locations 2block))
182
183
184
	  (unless (eql (source-path-tlf-number
			(node-source-path
			 (vop-node (location-info-vop loc))))
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
		       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)
202
203
		     var-locs
		     nil))
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
  (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)
221
		       (not (eq (block-environment (car succ)) env))))
222
223
224
225
226
227
228
229
230
231
	      ()
	      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))


232
233
234
235
236
237
238
;;; 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.
239
240
;;; -- Dump the elsewhere block header and all the elsewhere locations (if
;;;    any.)
241
242
243
244
245
;;;
(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)
246
247
248
249
250
251
	(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)
252
253
	(let ((block (ir2-block-block 2block)))
	  (when (eq (block-info block) 2block)
254
255
256
257
258
259
	    (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))
260
	  (dolist (loc (ir2-block-locations 2block))
261
262
263
264
	    (if (label-elsewhere-p (location-info-label loc))
		(elsewhere loc)
		(here loc)))
	  (setq prev-locs (here))))
265

266
      (dump-block-locations prev-block prev-locs tlf-num var-locs)
267
268
269
270
271
272

      (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))))
273
274
275
276

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


wlott's avatar
wlott committed
277
278
279
;;; DEBUG-SOURCE-FOR-INFO  --  Interface
;;;
;;;    Return a list of DEBUG-SOURCE structures containing information derived
280
281
;;; from Info.  We always dump the Start-Positions, since it is too hard
;;; figure out whether we need them or not.
wlott's avatar
wlott committed
282
283
284
285
286
287
288
289
;;;
(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
290
			  :comment (file-info-comment x)
wlott's avatar
wlott committed
291
292
293
			  :created (file-info-write-date x)
			  :compiled (source-info-start-time info)
			  :source-root (file-info-source-root x)
ram's avatar
ram committed
294
			  :start-positions
295
296
			  (coerce-to-smallest-eltype
			   (file-info-positions x)))))
wlott's avatar
wlott committed
297
298
299
300
		(cond ((pathnamep name)
		       (setf (debug-source-name res) name))
		      (t
		       (setf (debug-source-from res) name)
301
302
		       (setf (debug-source-name res)
			     (coerce (file-info-forms x) 'simple-vector))))
wlott's avatar
wlott committed
303
304
305
306
		res))
	  (source-info-files info)))


307
308
309
310
311
312
;;; COERCE-TO-SMALLEST-ELTYPE  --  Internal
;;;
;;;    Given an arbirtary sequence, coerce it to an unsigned vector if
;;; possible.
;;;
(defun coerce-to-smallest-eltype (seq)
313
  (declare (type sequence seq))
314
  (let ((max 0))
315
    (declare (type (or index null) max))
316
    (macrolet ((frob ()
317
		 '(if (and (typep val 'index) max)
318
319
320
321
		      (when (> val max)
			(setq max val))
		      (setq max nil))))
      (if (listp seq)
ram's avatar
ram committed
322
	  (dolist (val seq)
323
324
325
326
327
328
	    (frob))
	  (dotimes (i (length seq))
	    (let ((val (aref seq i)))
	      (frob)))))
    
    (if max
329
	(coerce seq `(simple-array (integer 0 ,max)))
330
331
332
	(coerce seq 'simple-vector))))


333
;;;; Variables:
334

335
336
337
338
339
340
341
342
343
344
;;; 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)))


345
;;; DUMP-1-VARIABLE  --  Internal
346
347
348
;;;
;;;    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
349
350
;;; result in.  If Minimal is true, we suppress name dumping, and set the
;;; minimal flag.
wlott's avatar
wlott committed
351
;;;
352
353
354
355
356
;;;    The debug-variable is only marked as always-live if the TN is
;;; environment live and is an argument.  If a :debug-environment TN, then we
;;; also exclude set variables, since the variable is not guranteed to be live
;;; everywhere in that case.
;;;
357
358
(defun dump-1-variable (fun var tn id minimal buffer)
  (declare (type lambda-var var) (type (or tn null) tn) (type index id)
359
	   (type clambda fun))
360
361
362
  (let* ((name (leaf-name var))
	 (package (symbol-package name))
	 (package-p (and package (not (eq package *package*))))
363
364
	 (save-tn (and tn (tn-save-tn tn)))
	 (kind (and tn (tn-kind tn)))
365
	 (flags 0))
366
    (declare (type index flags))
367
368
369
370
371
372
373
374
375
    (cond (minimal
	   (setq flags (logior flags compiled-debug-variable-minimal-p))
	   (unless tn
	     (setq flags (logior flags compiled-debug-variable-deleted-p))))
	  (t
	   (unless package
	     (setq flags (logior flags compiled-debug-variable-uninterned)))
	   (when package-p
	     (setq flags (logior flags compiled-debug-variable-packaged)))))
376
377
378
    (when (and (or (eq kind :environment)
		   (and (eq kind :debug-environment)
			(null (basic-var-sets var))))
379
380
	       (not (gethash tn (ir2-component-spilled-tns
				 (component-info *compile-component*))))
381
	       (eq (lambda-var-home var) fun))
382
      (setq flags (logior flags compiled-debug-variable-environment-live)))
383
    (when save-tn
384
      (setq flags (logior flags compiled-debug-variable-save-loc-p)))
385
    (unless (or (zerop id) minimal)
386
      (setq flags (logior flags compiled-debug-variable-id-p)))
387
    (vector-push-extend flags buffer)
388
389
390
391
392
393
394
395
396
    (unless minimal
      (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)))
    (if tn
	(write-var-integer (tn-sc-offset tn) buffer)
	(assert minimal))
397
398
399
    (when save-tn
      (write-var-integer (tn-sc-offset save-tn) buffer)))
  (undefined-value))
wlott's avatar
wlott committed
400
401
402
403
404


;;; COMPUTE-VARIABLES  --  Internal
;;;
;;;    Return a vector suitable for use as the DEBUG-FUNCTION-VARIABLES of Fun.
405
406
407
;;; 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
408
;;;
409
(defun compute-variables (fun level var-locs)
wlott's avatar
wlott committed
410
  (declare (type clambda fun) (type hash-table var-locs))
411
412
  (collect ((vars))
    (labels ((frob-leaf (leaf tn gensym-p)
wlott's avatar
wlott committed
413
	       (let ((name (leaf-name leaf)))
414
		 (when (and name (leaf-refs leaf) (tn-offset tn)
415
416
417
418
419
420
421
422
423
424
425
426
427
428
			    (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
429
	  (frob-lambda let (= level 3)))))
wlott's avatar
wlott committed
430
    
431
432
433
434
435
436
437
    (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))
438
439
      (declare (type (or simple-string null) prev-name)
	       (type index id i))
440
441
442
443
444
445
446
      (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)))
447
	  (dump-1-variable fun var (cdr x) id nil *byte-buffer*)
448
	  (setf (gethash var var-locs) i))
449
450
451
452
453
	(incf i)))

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


454
455
456
457
458
459
460
461
462
463
464
465
;;; COMPUTE-MINIMAL-VARIABLES  --  Internal
;;;
;;;    Dump out the arguments to Fun in the minimal variable format.
;;;
(defun compute-minimal-variables (fun)
  (declare (type clambda fun))
  (setf (fill-pointer *byte-buffer*) 0)
  (dolist (var (lambda-vars fun))
    (dump-1-variable fun var (leaf-info var) 0 t *byte-buffer*))
  (copy-seq *byte-buffer*))


466
467
468
;;; DEBUG-LOCATION-FOR  --  Internal
;;;
;;;    Return Var's relative position in the function's variables (determined
469
;;; from the Var-Locs hashtable.)  If Var is deleted, the return DELETED.
470
471
;;;
(defun debug-location-for (var var-locs)
ram's avatar
ram committed
472
  (declare (type lambda-var var) (type hash-table var-locs))
473
  (let ((res (gethash var var-locs)))
474
475
    (cond (res)
	  (t
476
477
	   (assert (or (null (leaf-refs var))
		       (not (tn-offset (leaf-info var)))))
478
	   'deleted))))
wlott's avatar
wlott committed
479

480
481

;;;; Arguments/returns:
wlott's avatar
wlott committed
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496

;;; 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))
497
498
	  (let ((actual-vars (lambda-vars fun))
		(saw-optional nil))
wlott's avatar
wlott committed
499
500
501
502
503
504
505
506
	    (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
507
508
509
510
511
			  (res 'rest-arg))
			 (:optional
			  (unless saw-optional
			    (res 'optional-args)
			    (setq saw-optional t))))
wlott's avatar
wlott committed
512
513
514
515
516
517
518
519
520
		       (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)))))

521
    (coerce-to-smallest-eltype (res))))
wlott's avatar
wlott committed
522
523
524
525


;;; COMPUTE-DEBUG-RETURNS  --  Internal
;;;
526
527
;;;    Return a vector of SC offsets describing Fun's return locations.  (Must
;;; be known values return...)
wlott's avatar
wlott committed
528
529
;;;
(defun compute-debug-returns (fun)
530
531
532
533
  (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
534

535

536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
;;;; Debug functions:

;;; DFUN-FROM-FUN  --  Internal
;;;
;;;    Return a C-D-F structure with all the mandatory slots filled in.
;;;
(defun dfun-from-fun (fun)
  (declare (type clambda fun))
  (let* ((2env (environment-info (lambda-environment fun)))
	 (dispatch (lambda-optional-dispatch fun))
	 (main-p (and dispatch
		      (eq fun (optional-dispatch-main-entry dispatch)))))
    (make-compiled-debug-function
     :name (cond ((leaf-name fun))
		 ((let ((ef (functional-entry-function
			     fun)))
		    (and ef (leaf-name ef))))
		 ((and main-p (leaf-name dispatch)))
		 (t
		  (component-name
		   (block-component (node-block (lambda-bind fun))))))
     :kind (if main-p nil (functional-kind fun))
     :return-pc (tn-sc-offset (ir2-environment-return-pc 2env))
     :old-fp (tn-sc-offset (ir2-environment-old-fp 2env))
     :start-pc (label-position (ir2-environment-environment-start 2env))
     :elsewhere-pc (label-position (ir2-environment-elsewhere-start 2env)))))


;;; COMPUTE-1-DEBUG-FUNCTION  --  Internal
;;;
;;;    Return a complete C-D-F structure for Fun.  This involves determining
;;; the DEBUG-INFO level and filling in optional slots as appropriate.
;;;
(defun compute-1-debug-function (fun var-locs)
  (declare (type clambda fun) (type hash-table var-locs))
  (let* ((dfun (dfun-from-fun fun))
	 (level (cookie-debug
		 (lexenv-cookie (node-lexenv (lambda-bind fun))))))

    (cond ((zerop level))
	  ((and (<= level 1)
		(let ((od (lambda-optional-dispatch fun)))
		  (or (not od)
		      (not (eq (optional-dispatch-main-entry od) fun)))))
	   (setf (compiled-debug-function-variables dfun)
		 (compute-minimal-variables fun))
	   (setf (compiled-debug-function-arguments dfun) :minimal))
	  (t
	   (when (>= level 1)
	     (setf (compiled-debug-function-variables dfun)
		   (compute-variables fun level var-locs)))
	   
	   (unless (= level 0)
	     (setf (compiled-debug-function-arguments dfun)
		   (compute-arguments fun var-locs)))))
    
    (when (>= level 2)
      (multiple-value-bind (blocks tlf-num)
			   (compute-debug-blocks fun var-locs)
	(setf (compiled-debug-function-tlf-number dfun) tlf-num)
	(setf (compiled-debug-function-blocks dfun) blocks)))

    (if (external-entry-point-p fun)
	(setf (compiled-debug-function-returns dfun) :standard)
	(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))
		    ((/= level 0)
		     (setf (compiled-debug-function-returns dfun)
			   (compute-debug-returns fun))))))))
    dfun))


;;;; Minimal debug functions:

;;; DEBUG-FUNCTION-MINIMAL-P  --  Internal
;;;
;;;    Return true if Dfun can be represented as a minimal debug function.
;;; Dfun is a cons (<start offset> . C-D-F).
;;;
(defun debug-function-minimal-p (dfun)
  (declare (type cons dfun))
  (let ((dfun (cdr dfun)))
    (and (member (compiled-debug-function-arguments dfun) '(:minimal nil))
	 (null (compiled-debug-function-blocks dfun)))))


;;; DUMP-1-MINIMAL-DFUN  --  Internal
;;;
;;;    Dump a packed binary representation of a Dfun into *byte-buffer*.
;;; Prev-Start and Start are the byte offsets in the code where the previous
;;; function started and where this one starts.  Prev-Elsewhere is the previous
;;; function's elsewhere PC.
;;;
(defun dump-1-minimal-dfun (dfun prev-start start prev-elsewhere)
  (declare (type compiled-debug-function dfun)
	   (type index prev-start start prev-elsewhere))
  (let* ((name (compiled-debug-function-name dfun))
	 (setf-p (and (consp name) (eq (car name) 'setf)
		      (consp (cdr name)) (symbolp (cadr name))))
	 (base-name (if setf-p (cadr name) name))
	 (pkg (when (symbolp base-name)
		(symbol-package base-name)))
	 (name-rep
	  (cond ((stringp base-name)
		 minimal-debug-function-name-component)
		((not pkg)
		 minimal-debug-function-name-uninterned)
		((eq pkg *package*)
		 minimal-debug-function-name-symbol)
		(t
		 minimal-debug-function-name-packaged))))
    (assert (or (atom name) setf-p))
    (let ((options 0))
      (setf (ldb minimal-debug-function-name-style-byte options) name-rep)
      (setf (ldb minimal-debug-function-kind-byte options)
	    (position (compiled-debug-function-kind dfun)
		      minimal-debug-function-kinds))
      (setf (ldb minimal-debug-function-returns-byte options)
	    (etypecase (compiled-debug-function-returns dfun)
	      ((member :standard) minimal-debug-function-returns-standard)
	      ((member :fixed) minimal-debug-function-returns-fixed)
	      (vector minimal-debug-function-returns-specified)))
      (vector-push-extend options *byte-buffer*))

    (let ((flags 0))
      (when setf-p
	(setq flags (logior flags minimal-debug-function-setf-bit)))
      (when (compiled-debug-function-nfp dfun)
	(setq flags (logior flags minimal-debug-function-nfp-bit)))
      (when (compiled-debug-function-variables dfun)
	(setq flags (logior flags minimal-debug-function-variables-bit)))
      (vector-push-extend flags *byte-buffer*))

    (when (eql name-rep minimal-debug-function-name-packaged)
      (write-var-string (package-name pkg) *byte-buffer*))
    (unless (stringp base-name)
      (write-var-string (symbol-name base-name) *byte-buffer*))

    (let ((vars (compiled-debug-function-variables dfun)))
      (when vars
	(let ((len (length vars)))
	  (write-var-integer len *byte-buffer*)
	  (dotimes (i len)
	    (vector-push-extend (aref vars i) *byte-buffer*)))))

    (let ((returns (compiled-debug-function-returns dfun)))
      (when (vectorp returns)
	(let ((len (length returns)))
	  (write-var-integer len *byte-buffer*)
	  (dotimes (i len)
	    (write-var-integer (aref returns i) *byte-buffer*)))))

    (write-var-integer (compiled-debug-function-return-pc dfun)
		       *byte-buffer*)
    (write-var-integer (compiled-debug-function-old-fp dfun)
		       *byte-buffer*)
    (when (compiled-debug-function-nfp dfun)
      (write-var-integer (compiled-debug-function-nfp dfun)
			 *byte-buffer*))
    (write-var-integer (- start prev-start) *byte-buffer*)
    (write-var-integer (- (compiled-debug-function-start-pc dfun) start)
		       *byte-buffer*)
    (write-var-integer (- (compiled-debug-function-elsewhere-pc dfun)
			  prev-elsewhere)
		       *byte-buffer*)))


;;; COMPUTE-MINIMAL-DEBUG-FUNCTIONS  --  Internal
;;;
;;;    Return a byte-vector holding all the debug functions for a component in
;;; the packed binary minimal-debug-function format.
;;;
(defun compute-minimal-debug-functions (dfuns)
  (declare (list dfuns))
  (setf (fill-pointer *byte-buffer*) 0)
  (let ((prev-start 0)
	(prev-elsewhere 0))
    (dolist (dfun dfuns)
      (let ((start (car dfun))
	    (elsewhere (compiled-debug-function-elsewhere-pc (cdr dfun))))
	(dump-1-minimal-dfun (cdr dfun) prev-start start prev-elsewhere)
	(setq prev-start start  prev-elsewhere elsewhere))))
  (copy-seq *byte-buffer*))


;;;; Full component dumping:

;;; COMPUTE-DEBUG-FUNCTION-MAP  --  Internal
;;;
;;;    Compute the full form (simple-vector) function map.
;;;
(defun compute-debug-function-map (sorted)
  (declare (list sorted))
  (let* ((len (1- (* (length sorted) 2)))
	 (funs-vec (make-array len)))
    (do ((i -1 (+ i 2))
	 (sorted sorted (cdr sorted)))
	((= i len))
      (declare (fixnum i))
      (let ((dfun (car sorted)))
	(unless (minusp i)
	  (setf (svref funs-vec i) (car dfun)))
	(setf (svref funs-vec (1+ i)) (cdr dfun))))
    funs-vec))


wlott's avatar
wlott committed
746
747
;;; DEBUG-INFO-FOR-COMPONENT  --  Interface
;;;
748
749
750
;;;    Return a debug-info structure describing component.  This has to be
;;; called after assembly so that source map information is available.
;;;
wlott's avatar
wlott committed
751
752
(defun debug-info-for-component (component)
  (declare (type component component))
753
  (let ((res (make-compiled-debug-info :name (component-name component)
754
				       :package (package-name *package*))))
wlott's avatar
wlott committed
755
    (collect ((dfuns))
756
757
758
759
      (let ((var-locs (make-hash-table :test #'eq))
	    (*byte-buffer* 
	     (make-array 10 :element-type '(unsigned-byte 8)
			 :fill-pointer 0  :adjustable t)))
wlott's avatar
wlott committed
760
761
	(dolist (fun (component-lambdas component))
	  (clrhash var-locs)
762
763
	  (dfuns (cons (label-position
			(block-label (node-block (lambda-bind fun))))
764
765
766
767
768
769
770
		       (compute-1-debug-function fun var-locs))))
	
	(let ((sorted (sort (dfuns) #'< :key #'car)))
	  (setf (compiled-debug-info-function-map res)
		(if (every #'debug-function-minimal-p sorted)
		    (compute-minimal-debug-functions sorted)
		    (compute-debug-function-map sorted))))))
wlott's avatar
wlott committed
771
772

    res))