main.lisp 57.5 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/main.lisp,v 1.60 1992/05/16 01:11:07 wlott Exp $")
ram's avatar
ram committed
11
;;;
wlott's avatar
wlott committed
12
13
14
15
16
17
;;; **********************************************************************
;;;
;;;    This file contains the top-level interfaces to the compiler.
;;; 
;;; Written by Rob MacLachlan
;;;
ram's avatar
ram committed
18
(in-package "C")
19
(in-package "EXTENSIONS")
20
21
22
23
24
(export '(*compile-progress* compile-from-stream *block-compile-default*
			     start-block end-block))
(in-package "LISP")
(export '(*compile-verbose* *compile-print* *compile-file-pathname*
			    *compile-file-truename*))
25
(in-package "C")
wlott's avatar
wlott committed
26
27
28
29
30
31
32

(proclaim '(special *constants* *free-variables* *compile-component*
		    *code-vector* *next-location* *result-fixups*
		    *free-functions* *source-paths* *failed-optimizations*
		    *seen-blocks* *seen-functions* *list-conflicts-table*
		    *continuation-number* *continuation-numbers*
		    *number-continuations* *tn-id* *tn-ids* *id-tns*
33
		    *label-ids* *label-id* *id-labels*
ram's avatar
ram committed
34
		    *undefined-warnings* *compiler-error-count*
wlott's avatar
wlott committed
35
36
37
38
39
		    *compiler-warning-count* *compiler-note-count*
		    *compiler-error-output* *compiler-error-bailout*
		    *compiler-trace-output*
		    *last-source-context* *last-original-source*
		    *last-source-form* *last-format-string* *last-format-args*
40
		    *last-message-count* *lexical-environment*))
wlott's avatar
wlott committed
41

42
43
44
(defvar *block-compile-default* :specified
  "The default value for the :Block-Compile argument to COMPILE-FILE.")

45
46
47
(defvar *byte-compile* :maybe
  "Whether or not to use the byte-compiler.  Can be T, NIL, or :MAYBE")

48
(defvar compiler-version "1.0")
wlott's avatar
wlott committed
49

50
(defvar *check-consistency* nil)
wlott's avatar
wlott committed
51
52
(defvar *all-components*)

53
54
55
;;; The current block compilation state.  These are initialized to the 
;;; :Block-Compile and :Entry-Points arguments that COMPILE-FILE was called
;;; with.  Subsequent START-BLOCK or END-BLOCK declarations alter the values.
wlott's avatar
wlott committed
56
57
;;;
(defvar *block-compile*)
58
59
60
(declaim (type (member nil t :specified) *block-compile*))
(defvar *entry-points*)
(declaim (list *entry-points*))
wlott's avatar
wlott committed
61
62
63
64
65

;;; When block compiling, used by PROCESS-FORM to accumulate top-level lambdas
;;; resulting from compiling subforms.  (In reverse order.)
;;;
(defvar *top-level-lambdas*)
66
(declaim (list *top-level-lambdas*))
wlott's avatar
wlott committed
67

68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
(defvar *compile-verbose* t
  "The default for the :VERBOSE argument to COMPILE-FILE.")
(defvar *compile-print* t
  "The default for the :PRINT argument to COMPILE-FILE.")
(defvar *compile-progress* nil
  "The default for the :PROGRESS argument to COMPILE-FILE.")

(defvar *compile-file-pathname* nil
  "The defaulted pathname of the file currently being compiler, or NIL if not
  compiling.")
(defvar *compile-file-truename* nil
  "The TRUENAME of the file currently being compiler, or NIL if not
  compiling.")

(declaim (type (or pathname null) *compile-file-pathname*
	       *compile-file-truename*))
wlott's avatar
wlott committed
84

85
;;; The values of *Package* and policy when compilation started.
wlott's avatar
wlott committed
86
87
88
;;;
(defvar *initial-package*)
(defvar *initial-cookie*)
89
(defvar *initial-interface-cookie*)
wlott's avatar
wlott committed
90
91
92
93
94
95
96
97
98
99

;;; The source-info structure for the current compilation.  This is null
;;; globally to indicate that we aren't currently in any identifiable
;;; compilation.
;;;
(defvar *source-info* nil)


;;; Maybe-Mumble  --  Internal
;;;
100
;;;    Mumble conditional on *compile-progress*.
wlott's avatar
wlott committed
101
102
;;;
(defun maybe-mumble (&rest foo)
103
  (when *compile-progress*
wlott's avatar
wlott committed
104
105
    (apply #'compiler-mumble foo)))

106

wlott's avatar
wlott committed
107
108
(deftype object () '(or fasl-file core-object null))

109
110
111
112
(defvar *compile-object* nil)
(declaim (type object *compile-object*))


wlott's avatar
wlott committed
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159

;;;; Component compilation:

(defparameter max-optimize-iterations 3
  "The upper limit on the number of times that we will consecutively do IR1
  optimization that doesn't introduce any new code.  A finite limit is
  necessary, since type inference may take arbitrarily long to converge.")

(defevent ir1-optimize-until-done "IR1-OPTIMIZE-UNTIL-DONE called.")
(defevent ir1-optimize-maxed-out "Hit MAX-OPTIMIZE-ITERATIONS limit.")

;;; IR1-Optimize-Until-Done  --  Internal
;;;
;;;    Repeatedly optimize Component until no further optimizations can be
;;; found or we hit our iteration limit.  When we hit the limit, we clear the
;;; component and block REOPTIMIZE flags to discourage following the next
;;; optimization attempt from pounding on the same code.
;;;
(defun ir1-optimize-until-done (component)
  (declare (type component component))
  (maybe-mumble "Opt")
  (event ir1-optimize-until-done)
  (let ((count 0)
	(cleared-reanalyze nil))
    (loop
      (when (component-reanalyze component)
	(setq count 0)
	(setq cleared-reanalyze t)
	(setf (component-reanalyze component) nil))
      (setf (component-reoptimize component) nil)
      (ir1-optimize component)
      (unless (component-reoptimize component)
	(maybe-mumble " ")
	(return))
      (incf count)
      (when (= count max-optimize-iterations)
	(event ir1-optimize-maxed-out)
	(maybe-mumble "* ")
	(setf (component-reoptimize component) nil)
	(do-blocks (block component)
	  (setf (block-reoptimize block) nil))
	(return))
      (maybe-mumble "."))
    (when cleared-reanalyze
      (setf (component-reanalyze component) t)))
  (undefined-value))

160
161
162
163
164
(defparameter *constraint-propagate* t)
(defparameter *reoptimize-after-type-check-max* 5)

(defevent reoptimize-maxed-out
  "*REOPTIMIZE-AFTER-TYPE-CHECK-MAX* exceeded.")
wlott's avatar
wlott committed
165

166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183

;;; DFO-AS-NEEDED  --  Internal
;;;
;;;    Iterate doing FIND-DFO until no new dead code is discovered.
;;;
(defun dfo-as-needed (component)
  (declare (type component component))
  (when (component-reanalyze component)
    (maybe-mumble "DFO")
    (loop
      (find-dfo component)
      (unless (component-reanalyze component)
	(maybe-mumble " ")
	(return))
      (maybe-mumble ".")))
  (undefined-value))


wlott's avatar
wlott committed
184
185
186
187
188
189
;;; IR1-Phases  --  Internal
;;;
;;;    Do all the IR1 phases for a non-top-level component.
;;;
(defun ir1-phases (component)
  (declare (type component component))
190
191
  (let ((*constraint-number* 0)
	(loop-count 1))
wlott's avatar
wlott committed
192
    (declare (special *constraint-number*))
193
    (loop
wlott's avatar
wlott committed
194
      (ir1-optimize-until-done component)
195
      (dfo-as-needed component)
wlott's avatar
wlott committed
196
197
198
199
200
201
202
      (when *constraint-propagate*
	(maybe-mumble "Constraint ")
	(constraint-propagate component))
      (maybe-mumble "Type ")
      (generate-type-checks component)
      (unless (or (component-reoptimize component)
		  (component-reanalyze component))
203
204
205
206
207
208
	(return))
      (when (>= loop-count *reoptimize-after-type-check-max*)
	(maybe-mumble "[Reoptimize Limit]")
	(event reoptimize-maxed-out)
	(return))
      (incf loop-count)))
209
210

  (ir1-finalize component)
211
  (undefined-value))
wlott's avatar
wlott committed
212
213


214
;;; Native-Compile-Component  --  Internal
wlott's avatar
wlott committed
215
;;;
216
217
(defun native-compile-component (component)
  (let ((*code-segment* nil)
wlott's avatar
wlott committed
218
	(*elsewhere* nil))
wlott's avatar
wlott committed
219
220
221
222
    (maybe-mumble "GTN ")
    (gtn-analyze component)
    (maybe-mumble "LTN ")
    (ltn-analyze component)
223
    (dfo-as-needed component)
ram's avatar
ram committed
224
    (maybe-mumble "Control ")
225
    (control-analyze component #'make-ir2-block)
wlott's avatar
wlott committed
226
227
228

    (when (ir2-component-values-receivers (component-info component))
      (maybe-mumble "Stack ")
229
230
231
232
233
234
      (stack-analyze component)
      ;;
      ;; Assign BLOCK-NUMBER for any cleanup blocks introduced by stack
      ;; analysis.  There shouldn't be any unreachable code after control, so
      ;; this won't delete anything.
      (dfo-as-needed component))
wlott's avatar
wlott committed
235
236
237
238
239
240

    (maybe-mumble "IR2Tran ")
    (init-assembler)
    (entry-analyze component)
    (ir2-convert component)

ram's avatar
ram committed
241
242
243
244
    (when (policy nil (>= speed cspeed))
      (maybe-mumble "Copy ")
      (copy-propagate component))

ram's avatar
ram committed
245
246
    (select-representations component)

wlott's avatar
wlott committed
247
248
249
    (when *check-consistency*
      (maybe-mumble "Check2 ")
      (check-ir2-consistency component))
250
251

    (delete-unreferenced-tns component)
wlott's avatar
wlott committed
252
253
254
255
    
    (maybe-mumble "Life ")
    (lifetime-analyze component)

256
    (when *compile-progress*
wlott's avatar
wlott committed
257
258
259
260
261
262
263
264
265
266
      (compiler-mumble "") ; Sync before doing random output.
      (pre-pack-tn-stats component *compiler-error-output*))

    (when *check-consistency*
      (maybe-mumble "CheckL ")
      (check-life-consistency component))

    (maybe-mumble "Pack ")
    (pack component)

267
268
269
270
    (when *check-consistency*
      (maybe-mumble "CheckP ")
      (check-pack-consistency component))

wlott's avatar
wlott committed
271
272
273
274
    (when *compiler-trace-output*
      (describe-component component *compiler-trace-output*))
    
    (maybe-mumble "Code ")
275
276
277
    (multiple-value-bind
	(length trace-table)
	(generate-code component)
wlott's avatar
wlott committed
278
279
280
281
282
      
      (when *compiler-trace-output*
	(format *compiler-trace-output*
		"~|~%Assembly code for ~S~2%"
		component)
283
	(dump-segment *code-segment* :stream *compiler-trace-output*))
wlott's avatar
wlott committed
284

285
      (when *count-vop-usages*
286
287
288
289
	(count-vops component))

      (when *collect-dynamic-statistics*
	(setup-dynamic-count-info component))
290

291
      (etypecase *compile-object*
wlott's avatar
wlott committed
292
293
	(fasl-file
	 (maybe-mumble "FASL")
294
	 (fasl-dump-component component *code-segment*
295
			      length trace-table *compile-object*))
wlott's avatar
wlott committed
296
297
	(core-object
	 (maybe-mumble "Core")
298
	 (make-core-component component *code-segment*
299
			      length trace-table *compile-object*))
wlott's avatar
wlott committed
300
301
302
303
	(null))

      (nuke-segment *code-segment*)))

304
305
  (when *compile-print*
    (compiler-mumble "~&"))
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339

  ;; We are done, so don't bother keeping anything around.
  (clear-ir2-info component)
  
  (undefined-value))


;;; COMPILE-COMPONENT -- internal.
;;;
(defun compile-component (component)
  (let ((*compile-component* component))
    (when *compile-print*
      (compiler-mumble "~&Compiling ~A: " (component-name component)))

    (ir1-phases component)

    #|
    (maybe-mumble "Dom ")
    (find-dominators component)
    (maybe-mumble "Loop ")
    (loop-analyze component)
    |#

    (maybe-mumble "Env ")
    (environment-analyze component)
    (dfo-as-needed component)

    (if (ecase *byte-compile*
	  ((t) t)
	  ((nil) nil)
	  (:maybe nil))
	(byte-compile-component component)
	(native-compile-component component)))

wlott's avatar
wlott committed
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
  (undefined-value))


;;;; Clearing global data structures:

;;; CLEAR-IR2-INFO  --  Internal
;;;
;;;    Clear all the INFO slots in sight in Component to allow the IR2 data
;;; structures to be reclaimed.  We also clear the INFO in constants in the
;;; *FREE-VARIABLES*, etc.  The latter is required for correct assignment of
;;; costant TNs, in addition to allowing stuff to be reclaimed.
;;;
;;;    We don't clear the FUNCTIONAL-INFO slots, since they are used to keep
;;; track of functions across component boundaries.
;;;
(defun clear-ir2-info (component)
  (declare (type component component))
357
  (nuke-ir2-component component)
wlott's avatar
wlott committed
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
  (setf (component-info component) nil)

  (maphash #'(lambda (k v)
	       (declare (ignore k))
	       (setf (leaf-info v) nil))
	   *constants*)

  (maphash #'(lambda (k v)
	       (declare (ignore k))
	       (when (constant-p v)
		 (setf (leaf-info v) nil)))
	   *free-variables*)

  (undefined-value))


374
375
376
377
378
379
380
;;; CLEAR-IR1-INFO  --  Internal
;;;
;;;    Blow away the REFS for all global variables, and recycle the IR1 for
;;; Component.
;;;
(defun clear-ir1-info (component)
  (declare (type component component))
381
382
383
  (labels ((blast (x)
	     (maphash #'(lambda (k v)
			  (declare (ignore k))
wlott's avatar
wlott committed
384
385
386
387
388
389
			  (when (leaf-p v)
			    (setf (leaf-refs v)
				  (delete-if #'here-p (leaf-refs v)))
			    (when (basic-var-p v)
			      (setf (basic-var-sets v)
				    (delete-if #'here-p (basic-var-sets v))))))
390
391
392
		      x))
	   (here-p (x)
	     (eq (block-component (node-block x)) component)))
393
394
395
396
397
398
399
    (blast *free-variables*)
    (blast *free-functions*)
    (blast *constants*))
  (macerate-ir1-component component)
  (undefined-value))


400
;;; CLEAR-STUFF  --  Interface
401
402
;;;
;;;    Clear all the global variables used by the compiler.
wlott's avatar
wlott committed
403
;;;
404
(defun clear-stuff (&optional (debug-too t))
wlott's avatar
wlott committed
405
406
  ;;
  ;; Clear global tables.
407
408
409
410
  (when (boundp '*free-functions*)
    (clrhash *free-functions*)
    (clrhash *free-variables*)
    (clrhash *constants*))
wlott's avatar
wlott committed
411
412
413
414
415
416
  (clrhash *failed-optimizations*)
  ;;
  ;; Clear debug counters and tables.
  (clrhash *seen-blocks*)
  (clrhash *seen-functions*)
  (clrhash *list-conflicts-table*)
417
418
419
420
421
422
423
424
425
426

  (when debug-too
    (clrhash *continuation-numbers*)
    (clrhash *number-continuations*)
    (setq *continuation-number* 0)
    (clrhash *tn-ids*)
    (clrhash *id-tns*)
    (setq *tn-id* 0)
    (clrhash *label-ids*)
    (clrhash *id-labels*)
427
428
429
430
431
432
433
    (setq *label-id* 0)
    ;;
    ;; Clear some Pack data structures (for GC purposes only.)
    (assert (not *in-pack*))
    (dolist (sb (backend-sb-list *backend*))
      (when (finite-sb-p sb)
	(fill (finite-sb-live-tns sb) nil))))
wlott's avatar
wlott committed
434
435
  ;;
  ;; Reset Gensym.
436
437
438
  (setq lisp:*gensym-counter* 0)

  (values))
wlott's avatar
wlott committed
439

440

wlott's avatar
wlott committed
441
442
443
444
445
446
447
448
449
450
;;; PRINT-SUMMARY  --  Interface
;;;
;;;    This function is called by WITH-COMPILATION-UNIT at the end of a
;;; compilation unit.  It prints out any residual unknown function warnings and
;;; the total error counts.  Abort-P should be true when the compilation unit
;;; was aborted by throwing out.  Abort-Count is the number of dynamically
;;; enclosed nested compilation units that were aborted.
;;;
(defun print-summary (abort-p abort-count)
  (unless abort-p
451
452
453
454
455
456
    (let ((undefs (sort *undefined-warnings* #'string<
			:key #'(lambda (x)
				 (let ((x (undefined-warning-name x)))
				   (if (symbolp x)
				       (symbol-name x)
				       (prin1-to-string x)))))))
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
      (unless *converting-for-interpreter*
	(dolist (undef undefs)
	  (let ((name (undefined-warning-name undef))
		(kind (undefined-warning-kind undef))
		(warnings (undefined-warning-warnings undef))
		(count (undefined-warning-count undef)))
	    (dolist (*compiler-error-context* warnings)
	      (compiler-warning "Undefined ~(~A~): ~S" kind name))
	    
	    (let ((warn-count (length warnings)))
	      (when (and warnings (> count warn-count))
		(let ((more (- count warn-count)))
		  (compiler-warning "~D more use~:P of undefined ~(~A~) ~S."
				    more kind name)))))))
  
472
473
474
475
476
477
      (dolist (kind '(:variable :function :type))
	(let ((summary (mapcar #'undefined-warning-name
			       (remove kind undefs :test-not #'eq
				       :key #'undefined-warning-kind))))
	  (when summary
	    (compiler-warning
478
479
480
	     "~:[This ~(~A~) is~;These ~(~A~)s are~] undefined:~
	      ~%  ~{~<~%  ~1:;~S~>~^ ~}"
	     (cdr summary) kind summary))))))
481
  
482
483
484
485
486
  (unless (or *converting-for-interpreter*
	      (and (not abort-p) (zerop abort-count)
		   (zerop *compiler-error-count*)
		   (zerop *compiler-warning-count*)
		   (zerop *compiler-note-count*)))
487
488
489
490
491
492
493
494
495
496
497
    (compiler-mumble
     "~2&Compilation unit ~:[finished~;aborted~].~
      ~[~:;~:*~&  ~D fatal error~:P~]~
      ~[~:;~:*~&  ~D error~:P~]~
      ~[~:;~:*~&  ~D warning~:P~]~
      ~[~:;~:*~&  ~D note~:P~]~2%"
     abort-p
     abort-count
     *compiler-error-count*
     *compiler-warning-count*
     *compiler-note-count*)))
498

499
   
wlott's avatar
wlott committed
500
501
502
503
504
505
;;; Describe-Component  --  Internal
;;;
;;;    Print out some useful info about Component to Stream.
;;;
(defun describe-component (component &optional
				     (*standard-output* *standard-output*))
506
  (declare (type component component))
wlott's avatar
wlott committed
507
508
509
  (format t "~|~%;;;; Component: ~S~2%" (component-name component))
  (print-blocks component)
  
510
511
512
  (typecase (component-info component)
    (ir2-component
     (format t "~%~|~%;;;; IR2 component: ~S~2%" (component-name component))
wlott's avatar
wlott committed
513
  
514
515
516
517
518
519
     (format t "Entries:~%")
     (dolist (entry (ir2-component-entries (component-info component)))
       (format t "~4TL~D: ~S~:[~; [Closure]~]~%"
	       (label-id (entry-info-offset entry))
	       (entry-info-name entry)
	       (entry-info-closure-p entry)))
wlott's avatar
wlott committed
520
  
521
522
523
524
525
     (terpri)
     (pre-pack-tn-stats component *standard-output*)
     (terpri)
     (print-ir2-blocks component)
     (terpri)))
wlott's avatar
wlott committed
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
  
  (undefined-value))


;;;; File reading:
;;;
;;;    When reading from a file, we have to keep track of some source
;;; information.  We also exploit our ability to back up for printing the error
;;; context and for recovering from errors.
;;;
;;; The interface we provide to this stuff is the stream-oid Source-Info
;;; structure.  The bookkeeping is done as a side-effect of getting the next
;;; source form.


;;; The File-Info structure holds all the source information for a given file.
;;;
(defstruct file-info
  ;;
  ;; If a file, the truename of the corresponding source file.  If from a Lisp
  ;; form, :LISP, if from a stream, :STREAM.
547
  (name (required-argument) :type (or simple-string (member :lisp :stream)))
wlott's avatar
wlott committed
548
  ;;
549
550
551
  ;; The defaulted, but not necessarily absolute file name (i.e. prior to
  ;; TRUENAME call.)  Null if not a file.  This is only used to set
  ;; *COMPILE-FILE-PATHNAME* 
552
  (untruename nil :type (or simple-string null))
553
  ;;
wlott's avatar
wlott committed
554
555
556
  ;; The file's write date (if relevant.)
  (write-date nil :type (or unsigned-byte null))
  ;;
ram's avatar
ram committed
557
558
559
  ;; This file's FILE-COMMENT, or NIL if none.
  (comment nil :type (or simple-string null))
  ;;
wlott's avatar
wlott committed
560
561
562
563
564
565
566
  ;; The source path root number of the first form in this file (i.e. the
  ;; total number of forms converted previously in this compilation.)
  (source-root 0 :type unsigned-byte)
  ;;
  ;; Parallel vectors containing the forms read out of the file and the file
  ;; positions that reading of each form started at (i.e. the end of the
  ;; previous form.)
567
568
  (forms (make-array 10 :fill-pointer 0 :adjustable t) :type (vector t))
  (positions (make-array 10 :fill-pointer 0 :adjustable t) :type (vector t)))
wlott's avatar
wlott committed
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


;;; The Source-Info structure provides a handle on all the source information
;;; for an entire compilation.
;;;
(defstruct (source-info
	    (:print-function
	     (lambda (s stream d)
	       (declare (ignore s d))
	       (format stream "#<Source-Info>"))))
  ;;
  ;; The UT that compilation started at.
  (start-time (get-universal-time) :type unsigned-byte)
  ;;
  ;; A list of the file-info structures for this compilation.
  (files nil :type list)
  ;;
  ;; The tail of the Files for the file we are currently reading.
  (current-file nil :type list)
  ;;
  ;; The stream that we are using to read the Current-File.  Null if no stream
  ;; has been opened yet.
  (stream nil :type (or stream null)))


;;; Make-File-Source-Info  --  Internal
;;;
;;;    Given a list of pathnames, return a Source-Info structure.
;;;
(defun make-file-source-info (files)
  (declare (list files))
  (let ((file-info
	 (mapcar #'(lambda (x)
602
603
		     (make-file-info :name (namestring (truename x))
				     :untruename (namestring x)
wlott's avatar
wlott committed
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
				     :write-date (file-write-date x)))
		 files)))

    (make-source-info :files file-info
		      :current-file file-info)))


;;; MAKE-LISP-SOURCE-INFO  --  Interface
;;;
;;;    Return a SOURCE-INFO to describe the incremental compilation of Form.
;;; Also used by EVAL:INTERNAL-EVAL.
;;;
(defun make-lisp-source-info (form)
  (make-source-info
   :start-time (get-universal-time)
   :files (list (make-file-info :name :lisp
				:forms (vector form)
				:positions '#(0)))))


;;; MAKE-STREAM-SOURCE-INFO  --  Internal
;;;
;;;    Return a SOURCE-INFO which will read from Stream.
;;;
(defun make-stream-source-info (stream)
  (let ((files (list (make-file-info :name :stream))))
    (make-source-info
     :files files
     :current-file files
     :stream stream)))


;;; Normal-Read-Error  --  Internal
;;;
;;;    Print an error message for a non-EOF error on Stream.  Old-Pos is a
;;; preceding file position that hopefully comes before the beginning of the
;;; line.  Of course, this only works on streams that support the file-position
;;; operation.
;;;
(defun normal-read-error (stream old-pos condition)
644
  (declare (type stream stream) (type unsigned-byte old-pos))
wlott's avatar
wlott committed
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
  (let ((pos (file-position stream)))
    (file-position stream old-pos)
    (let ((start old-pos))
      (loop
	(let ((line (read-line stream nil))
	      (end (file-position stream)))
	  (when (>= end pos)
	    (compiler-error-message
	     "Read error at ~D:~% \"~A/\\~A\"~%~A"
	     pos
	     (string-left-trim " 	"
			       (subseq line 0 (- pos start)))
	     (subseq line (- pos start))
	     condition)
	    (return))
	  (setq start end)))))
  (undefined-value))


;;; Ignore-Error-Form  --  Internal
;;;
;;;    Back Stream up to the position Pos, then read a form with
;;; *Read-Suppress* on, discarding the result.  If an error happens during this
;;; read, then bail out using Compiler-Error (fatal in this context).
;;;
(defun ignore-error-form (stream pos)
  (declare (type stream stream) (type unsigned-byte pos))
  (file-position stream pos)
  (handler-case (let ((*read-suppress* t))
		  (read stream))
    (error (condition)
      (declare (ignore condition))
      (compiler-error "Unable to recover from read error."))))


;;; Unexpected-EOF-Error  --  Internal
;;;
;;;    Print an error message giving some context for an EOF error.  We print
;;; the first line after Pos that contains #\" or #\(, or lacking that, the
;;; first non-empty line.
;;;
(defun unexpected-eof-error (stream pos condition)
  (declare (type stream stream) (type unsigned-byte pos))
  (let ((res nil))
    (file-position stream pos)
    (loop
      (let ((line (read-line stream nil nil))) 
	(unless line (return))
	(when (or (find #\" line) (find #\( line))
	  (setq res line)
	  (return))
	(unless (or res (zerop (length line)))
	  (setq res line))))

    (compiler-error-message
     "Read error in form starting at ~D:~%~@[ \"~A\"~%~]~A"
     pos res condition))

  (file-position stream (file-length stream))
  (undefined-value))


;;; Careful-Read  --  Internal
;;;
;;;    Read a form from Stream, returning EOF at EOF.  If a read error happens,
;;; then attempt to recover if possible, returing a proxy error form.
;;;
(defun careful-read (stream eof pos)
  (handler-case (read stream nil eof)
    (error (condition)
      (let ((new-pos (file-position stream)))
	(cond ((= new-pos (file-length stream))
	       (unexpected-eof-error stream pos condition))
	      (t
	       (normal-read-error stream pos condition)
	       (ignore-error-form stream pos))))
721
722
      '(cerror "Skip this form."
	       "Attempt to load a file having a compile-time read error."))))
wlott's avatar
wlott committed
723
724
725
726
727
728


;;; Get-Source-Stream  --  Internal
;;;
;;;    If Stream is present, return it, otherwise open a stream to the current
;;; file.  There must be a current file.  When we open a new file, we also
729
;;; reset *Package* and policy.  This gives the effect of rebinding
wlott's avatar
wlott committed
730
731
732
733
734
735
736
737
;;; around each file.
;;;
(defun get-source-stream (info)
  (declare (type source-info info))
  (cond ((source-info-stream info))
	(t
	 (setq *package* *initial-package*)
	 (setq *default-cookie* (copy-cookie *initial-cookie*))
738
739
	 (setq *default-interface-cookie*
	       (copy-cookie *initial-interface-cookie*))
740
741
	 (let* ((finfo (first (source-info-current-file info)))
		(name (file-info-name finfo)))
742
743
744
	   (setq *compile-file-truename* (pathname name))
	   (setq *compile-file-pathname*
		 (pathname (file-info-untruename finfo)))
745
	   (setf (source-info-stream info) (open name :direction :input))))))
wlott's avatar
wlott committed
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778

;;; CLOSE-SOURCE-INFO  --  Internal
;;;
;;;    Close the stream in Info if it is open.
;;;
(defun close-source-info (info)
  (declare (type source-info info))
  (let ((stream (source-info-stream info)))
    (when stream (close stream)))
  (setf (source-info-stream info) nil)
  (undefined-value))


;;; Advance-Source-File  --  Internal
;;;
;;;    Advance Info to the next source file.  If none, return NIL, otherwise T.
;;;
(defun advance-source-file (info)
  (declare (type source-info info))
  (close-source-info info)
  (let ((prev (pop (source-info-current-file info))))
    (if (source-info-current-file info)
	(let ((current (first (source-info-current-file info))))
	  (setf (file-info-source-root current)
		(+ (file-info-source-root prev)
		   (length (file-info-forms prev))))
	  t)
	nil)))


;;; Read-Source-Form  --  Internal
;;;
;;;    Read the next form from the source designated by Info.  The second value
779
780
;;; is the top-level form number of the read form.  The third value is true
;;; when at EOF.
wlott's avatar
wlott committed
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
;;;
;;;   We carefully read from the current source file.  If it is at EOF, we
;;; advance to the next file and try again.  When we get a form, we enter it
;;; into the per-file Forms and Positions vectors.
;;;
(defun read-source-form (info) 
  (declare (type source-info info))
  (let ((eof '(*eof*)))
    (loop
      (let* ((file (first (source-info-current-file info)))
	     (stream (get-source-stream info))
	     (pos (file-position stream))
	     (res (careful-read stream eof pos)))
	(unless (eq res eof)
	  (let* ((forms (file-info-forms file))
		 (current-idx (+ (fill-pointer forms)
				 (file-info-source-root file))))
	    (vector-push-extend res forms)
	    (vector-push-extend pos (file-info-positions file))
800
	    (return (values res current-idx nil))))
wlott's avatar
wlott committed
801
802
803
804
805

	(unless (advance-source-file info)
	  (return (values nil nil t)))))))


806
807
808
809
810
811
812
813
814
815
816
817
818
819
;;; FIND-FILE-INFO  --  Interface
;;;
;;;    Return the File-Info describing the Index'th form.
;;;
(defun find-file-info (index info)
  (declare (type index index) (type source-info info))
  (dolist (file (source-info-files info))
    (when (> (+ (length (file-info-forms file))
		(file-info-source-root file))
	     index)
      (return file))))


;;; FIND-SOURCE-ROOT  --  Interface
wlott's avatar
wlott committed
820
821
822
823
824
;;;
;;;    Return the Index'th source form read from Info and the position that it
;;; was read at.
;;;
(defun find-source-root (index info)
825
826
827
828
829
  (declare (type source-info info) (type index index))
  (let* ((file (find-file-info index info))
	 (idx (- index (file-info-source-root file))))
    (values (aref (file-info-forms file) idx)
	    (aref (file-info-positions file) idx))))
wlott's avatar
wlott committed
830
831
832
833
834
835

;;;; Top-level form processing:

;;; CONVERT-AND-MAYBE-COMPILE  --  Internal
;;;
;;;    Called by top-level form processing when we are ready to actually
836
;;; compile something.  If *BLOCK-COMPILE* is T, then we still convert the
wlott's avatar
wlott committed
837
838
;;; form, but delay compilation, pushing the result on *TOP-LEVEL-LAMBDAS*
;;; instead.
839
;;;
840
841
842
;;;   The cookies at this time becomes the default policy for compiling the
;;; form.  Any enclosed PROCLAIMs will affect only subsequent forms.
;;;
843
844
(defun convert-and-maybe-compile (form path)
  (declare (list path))
845
846
847
848
849
850
851
852
853
854
855
856
857
  (let ((orig (bytes-consed-between-gcs)))
    (unwind-protect
	(progn
	  (setf (bytes-consed-between-gcs) (* orig 4))
	  (let* ((*lexical-environment*
		  (make-lexenv :cookie *default-cookie*
			       :interface-cookie *default-interface-cookie*))
		 (tll (ir1-top-level form path nil)))
	    (cond ((eq *block-compile* t) (push tll *top-level-lambdas*))
		  (t
		   (compile-top-level (list tll) nil)))))
      (system:scrub-control-stack)
      (setf (bytes-consed-between-gcs) orig))))
wlott's avatar
wlott committed
858
859
860
861

;;; PROCESS-PROGN  --  Internal
;;;
;;;    Process a PROGN-like portion of a top-level form.  Forms is a list of
862
;;; the forms, and Path is source path of the form they came out of.
wlott's avatar
wlott committed
863
;;;
864
865
(defun process-progn (forms path)
  (declare (list forms) (list path))
866
  (dolist (form forms)
867
    (process-form form path)))
wlott's avatar
wlott committed
868
869


870
871
;;; PREPROCESSOR-MACROEXPAND  --  Internal
;;;
872
873
874
;;;    Macroexpand form in the current environment with an error handler.  We
;;; only expand one level, so that we retain all the intervening forms in the
;;; source path.
875
876
;;;
(defun preprocessor-macroexpand (form)
877
  (handler-case (macroexpand-1 form *lexical-environment*)
878
    (error (condition)
879
       (compiler-error "(during macroexpansion)~%~A" condition))))
880
881


882
883
884
885
886
;;; PROCESS-LOCALLY  --  Internal
;;;
;;;    Process a top-level use of LOCALLY.  We parse declarations and then
;;; recursively process the body.
;;;
887
;;;    Binding *DEFAULT-xxx-COOKIE* is pretty much of a hack, since it causes
888
889
890
891
892
;;; LOCALLY to "capture" enclosed proclamations.  It is necessary because
;;; CONVERT-AND-MAYBE-COMPILE uses the value of *DEFAULT-COOKIE* as the policy.
;;; The need for this hack is due to the quirk that there is no way to
;;; represent in a cookie that an optimize quality came from the default.
;;;
893
894
(defun process-locally (form path)
  (declare (list path))
895
896
897
898
899
  (multiple-value-bind
      (body decls)
      (system:parse-body (cdr form) *lexical-environment* nil)
    (let* ((*lexical-environment*
	    (process-declarations decls nil nil (make-continuation)))
900
901
902
	   (*default-cookie* (lexenv-cookie *lexical-environment*))
	   (*default-interface-cookie*
	    (lexenv-interface-cookie *lexical-environment*)))
903
      (process-progn body path))))
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922


;;; PROCESS-FILE-COMMENT  --  Internal
;;;
;;;    Stash file comment in the file-info structure.
;;;
(defun process-file-comment (form)
  (unless (and (= (length form) 2) (stringp (second form)))
    (compiler-error "Bad FILE-COMMENT form: ~S." form))
  (let ((file (first (source-info-current-file *source-info*))))
    (cond ((file-info-comment file)
	   (compiler-warning "Ignoring extra file comment:~%  ~S." form))
	  (t
	   (let ((comment (coerce (second form) 'simple-string)))
	     (setf (file-info-comment file) comment)
	     (when *compile-verbose*
	       (compiler-mumble "~&Comment: ~A~2&" comment)))))))


923
;;; PROCESS-COLD-LOAD-FORM  --  Internal
924
925
;;;
;;;    Force any pending top-level forms to be compiled and dumped so that they
926
927
;;; will be evaluated in the correct package environment.  Eval the form if
;;; Eval is true, then dump the form to evaled at (cold) load time.
928
;;;
929
930
931
932
933
934
935
936
937
938
939
(defun process-cold-load-form (form path eval)
  (let ((object *compile-object*))
    (typecase object
      (fasl-file
       (compile-top-level-lambdas () t)))
    (when eval (eval form))
    (etypecase object
      (fasl-file
       (fasl-dump-cold-load-form form object))
      ((or null core-object)
       (convert-and-maybe-compile form path)))))
940
941
942
943
944


;;; PROCESS-PROCLAIM  --  Internal
;;;
;;;    If a special block compilation delimiter, then start or end the block as
945
946
;;; appropriate.  Otherwise, just convert-and-maybe-compile the form.  If
;;; *BLOCK-COMPILE* is NIL, then we ignore block declarations.
947
;;;
948
(defun process-proclaim (form path)
949
950
951
952
953
  (if (and (eql (length form) 2) (constantp (cadr form)))
      (let ((spec (eval (cadr form))))
	(if (consp spec)
	    (case (first spec)
	      (start-block
954
	       (when *block-compile*
955
		 (finish-block-compilation)
956
957
958
		 (setq *block-compile* t)
		 (setq *entry-points* (rest spec))))
	      (end-block
959
	       (finish-block-compilation))
960
	      (t
961
962
963
	       (convert-and-maybe-compile form path)))
	    (convert-and-maybe-compile form path)))
      (convert-and-maybe-compile form path)))
964
965


wlott's avatar
wlott committed
966
967
968
969
970
(proclaim '(special *compiler-error-bailout*))

;;; PROCESS-FORM  --  Internal
;;;
;;;    Process a top-level Form with the specified source Path and output to
ram's avatar
ram committed
971
972
973
974
;;; Object.
;;; -- If this is a magic top-level form, then do stuff.
;;; -- If it is a macro expand it.
;;; -- Otherwise, just compile it.
wlott's avatar
wlott committed
975
;;;
976
977
(defun process-form (form path)
  (declare (list path))
wlott's avatar
wlott committed
978
  (catch 'process-form-error-abort
979
980
    (let* ((path (or (gethash form *source-paths*) (cons form path)))
	   (*compiler-error-bailout*
981
982
983
984
	    #'(lambda ()
		(convert-and-maybe-compile
		 `(error "Execution of a form compiled with errors:~% ~S"
			 ',form)
985
		 path)
986
		(throw 'process-form-error-abort nil))))
wlott's avatar
wlott committed
987
      (if (atom form)
988
	  (convert-and-maybe-compile form path)
wlott's avatar
wlott committed
989
	  (case (car form)
990
991
992
	    ((make-package shadow shadowing-import export
	      unexport use-package unuse-package import
	      old-in-package %in-package)
993
	     (process-cold-load-form form path t))
994
	    ((error cerror break signal)
995
	     (process-cold-load-form form path nil))
wlott's avatar
wlott committed
996
997
998
999
1000
	    ((eval-when)
	     (unless (>= (length form) 2)
	       (compiler-error "EVAL-WHEN form is too short: ~S." form))
	     (do-eval-when-stuff
	      (cadr form) (cddr form)