main.lisp 58 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.65 1992/07/11 02:11:20 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")
ram's avatar
ram committed
49
50
51
52
53
(pushnew :python *features*)
(setf (getf ext:*herald-items* :python)
      `("    Python " ,compiler-version ", target "
	,#'(lambda (stream)
	     (write-string (backend-version *backend*) stream))))
wlott's avatar
wlott committed
54

55
(defvar *check-consistency* nil)
wlott's avatar
wlott committed
56
57
(defvar *all-components*)

58
59
60
;;; 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
61
62
;;;
(defvar *block-compile*)
63
64
65
(declaim (type (member nil t :specified) *block-compile*))
(defvar *entry-points*)
(declaim (list *entry-points*))
wlott's avatar
wlott committed
66
67
68
69
70

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

73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
(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
89

90
;;; The values of *Package* and policy when compilation started.
wlott's avatar
wlott committed
91
92
93
;;;
(defvar *initial-package*)
(defvar *initial-cookie*)
94
(defvar *initial-interface-cookie*)
wlott's avatar
wlott committed
95
96
97
98
99
100
101
102
103
104

;;; 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
;;;
105
;;;    Mumble conditional on *compile-progress*.
wlott's avatar
wlott committed
106
107
;;;
(defun maybe-mumble (&rest foo)
108
  (when *compile-progress*
wlott's avatar
wlott committed
109
110
    (apply #'compiler-mumble foo)))

111

wlott's avatar
wlott committed
112
113
(deftype object () '(or fasl-file core-object null))

114
115
116
117
(defvar *compile-object* nil)
(declaim (type object *compile-object*))


wlott's avatar
wlott committed
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
160
161
162
163
164

;;;; 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))

165
166
167
168
169
(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
170

171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188

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

  (ir1-finalize component)
216
  (undefined-value))
wlott's avatar
wlott committed
217
218


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

    (when (ir2-component-values-receivers (component-info component))
      (maybe-mumble "Stack ")
234
235
236
237
238
239
      (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
240

241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
    (unwind-protect
	(progn
	  (maybe-mumble "IR2Tran ")
	  (init-assembler)
	  (entry-analyze component)
	  (ir2-convert component)
	  
	  (when (policy nil (>= speed cspeed))
	    (maybe-mumble "Copy ")
	    (copy-propagate component))
	  
	  (select-representations component)
	  
	  (when *check-consistency*
	    (maybe-mumble "Check2 ")
	    (check-ir2-consistency component))
	  
	  (delete-unreferenced-tns component)
	  
	  (maybe-mumble "Life ")
	  (lifetime-analyze component)
	  
	  (when *compile-progress*
	    (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)
	  
	  (when *check-consistency*
	    (maybe-mumble "CheckP ")
	    (check-pack-consistency component))
	  
	  (when *compiler-trace-output*
	    (describe-component component *compiler-trace-output*))
	  
	  (maybe-mumble "Code ")
	  (multiple-value-bind
	      (length trace-table fixups)
	      (generate-code component)
	    
	    (when (and *compiler-trace-output*
		       (not (backend-featurep :new-assembler)))
	      (format *compiler-trace-output*
		      "~|~%Assembly code for ~S~2%"
		      component)
	      (assem:dump-segment *code-segment* :stream *compiler-trace-output*))
	    
	    (when *count-vop-usages*
	      (count-vops component))
	    
	    (when *collect-dynamic-statistics*
	      (setup-dynamic-count-info component))
	    
	    (etypecase *compile-object*
	      (fasl-file
	       (maybe-mumble "FASL")
	       (fasl-dump-component component *code-segment*
				    length trace-table fixups
				    *compile-object*))
	      (core-object
	       (maybe-mumble "Core")
	       (make-core-component component *code-segment*
308
309
				    length trace-table fixups
				    *compile-object*))
310
311
312
313
314
315
316
317
318
	      (null))))
	    
      (cond ((backend-featurep :new-assembler)
	     (when *code-segment*
	       (new-assem:release-segment *code-segment*))
	     (when *elsewhere*
	       (new-assem:release-segment *elsewhere*)))
	    (t
	     (assem:nuke-segment *code-segment*)))))
wlott's avatar
wlott committed
319

320
321
  (when *compile-print*
    (compiler-mumble "~&"))
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355

  ;; 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
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
  (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))
373
  (nuke-ir2-component component)
wlott's avatar
wlott committed
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
  (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))


390
391
392
393
394
395
396
;;; 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))
397
398
399
  (labels ((blast (x)
	     (maphash #'(lambda (k v)
			  (declare (ignore k))
wlott's avatar
wlott committed
400
401
402
403
404
405
			  (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))))))
406
407
408
		      x))
	   (here-p (x)
	     (eq (block-component (node-block x)) component)))
409
410
411
412
413
414
415
    (blast *free-variables*)
    (blast *free-functions*)
    (blast *constants*))
  (macerate-ir1-component component)
  (undefined-value))


416
;;; CLEAR-STUFF  --  Interface
417
418
;;;
;;;    Clear all the global variables used by the compiler.
wlott's avatar
wlott committed
419
;;;
420
(defun clear-stuff (&optional (debug-too t))
wlott's avatar
wlott committed
421
422
  ;;
  ;; Clear global tables.
423
424
425
426
  (when (boundp '*free-functions*)
    (clrhash *free-functions*)
    (clrhash *free-variables*)
    (clrhash *constants*))
wlott's avatar
wlott committed
427
428
429
430
431
432
  (clrhash *failed-optimizations*)
  ;;
  ;; Clear debug counters and tables.
  (clrhash *seen-blocks*)
  (clrhash *seen-functions*)
  (clrhash *list-conflicts-table*)
433
434
435
436
437
438
439
440
441
442

  (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*)
443
444
445
446
447
448
449
    (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
450
451
  ;;
  ;; Reset Gensym.
452
453
454
  (setq lisp:*gensym-counter* 0)

  (values))
wlott's avatar
wlott committed
455

456

wlott's avatar
wlott committed
457
458
459
460
461
462
463
464
465
466
;;; 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
467
468
469
470
471
472
    (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)))))))
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
      (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)))))))
  
488
489
490
491
492
493
      (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
494
495
496
	     "~:[This ~(~A~) is~;These ~(~A~)s are~] undefined:~
	      ~%  ~{~<~%  ~1:;~S~>~^ ~}"
	     (cdr summary) kind summary))))))
497
  
498
499
500
501
502
  (unless (or *converting-for-interpreter*
	      (and (not abort-p) (zerop abort-count)
		   (zerop *compiler-error-count*)
		   (zerop *compiler-warning-count*)
		   (zerop *compiler-note-count*)))
503
504
505
506
507
508
509
510
511
512
513
    (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*)))
514

515
   
wlott's avatar
wlott committed
516
517
518
519
520
521
;;; Describe-Component  --  Internal
;;;
;;;    Print out some useful info about Component to Stream.
;;;
(defun describe-component (component &optional
				     (*standard-output* *standard-output*))
522
  (declare (type component component))
wlott's avatar
wlott committed
523
524
525
  (format t "~|~%;;;; Component: ~S~2%" (component-name component))
  (print-blocks component)
  
526
527
528
  (typecase (component-info component)
    (ir2-component
     (format t "~%~|~%;;;; IR2 component: ~S~2%" (component-name component))
wlott's avatar
wlott committed
529
  
530
531
532
533
534
535
     (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
536
  
537
538
539
540
541
     (terpri)
     (pre-pack-tn-stats component *standard-output*)
     (terpri)
     (print-ir2-blocks component)
     (terpri)))
wlott's avatar
wlott committed
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
  
  (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.
563
  (name (required-argument) :type (or simple-string (member :lisp :stream)))
wlott's avatar
wlott committed
564
  ;;
565
566
567
  ;; 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* 
568
  (untruename nil :type (or simple-string null))
569
  ;;
wlott's avatar
wlott committed
570
571
572
  ;; The file's write date (if relevant.)
  (write-date nil :type (or unsigned-byte null))
  ;;
ram's avatar
ram committed
573
574
575
  ;; This file's FILE-COMMENT, or NIL if none.
  (comment nil :type (or simple-string null))
  ;;
wlott's avatar
wlott committed
576
577
578
579
580
581
582
  ;; 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.)
583
584
  (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
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


;;; 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)
618
619
		     (make-file-info :name (namestring (truename x))
				     :untruename (namestring x)
wlott's avatar
wlott committed
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
				     :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)
660
  (declare (type stream stream) (type unsigned-byte old-pos))
wlott's avatar
wlott committed
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
  (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)
689
690
  (handler-case (let ((*read-suppress* t)
		      (*features* (backend-features *target-backend*)))
wlott's avatar
wlott committed
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
		  (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)
730
731
  (handler-case (let ((*features* (backend-features *target-backend*)))
		  (read stream nil eof))
wlott's avatar
wlott committed
732
733
734
735
736
737
738
    (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))))
739
740
      '(cerror "Skip this form."
	       "Attempt to load a file having a compile-time read error."))))
wlott's avatar
wlott committed
741
742
743
744
745
746


;;; 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
747
;;; reset *Package* and policy.  This gives the effect of rebinding
wlott's avatar
wlott committed
748
749
750
751
752
753
754
755
;;; 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*))
756
757
	 (setq *default-interface-cookie*
	       (copy-cookie *initial-interface-cookie*))
758
759
	 (let* ((finfo (first (source-info-current-file info)))
		(name (file-info-name finfo)))
760
761
762
	   (setq *compile-file-truename* (pathname name))
	   (setq *compile-file-pathname*
		 (pathname (file-info-untruename finfo)))
763
	   (setf (source-info-stream info) (open name :direction :input))))))
wlott's avatar
wlott committed
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796

;;; 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
797
798
;;; is the top-level form number of the read form.  The third value is true
;;; when at EOF.
wlott's avatar
wlott committed
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
;;;
;;;   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))
818
	    (return (values res current-idx nil))))
wlott's avatar
wlott committed
819
820
821
822
823

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


824
825
826
827
828
829
830
831
832
833
834
835
836
837
;;; 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
838
839
840
841
842
;;;
;;;    Return the Index'th source form read from Info and the position that it
;;; was read at.
;;;
(defun find-source-root (index info)
843
844
845
846
847
  (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
848
849
850
851
852
853

;;;; Top-level form processing:

;;; CONVERT-AND-MAYBE-COMPILE  --  Internal
;;;
;;;    Called by top-level form processing when we are ready to actually
854
;;; compile something.  If *BLOCK-COMPILE* is T, then we still convert the
wlott's avatar
wlott committed
855
856
;;; form, but delay compilation, pushing the result on *TOP-LEVEL-LAMBDAS*
;;; instead.
857
;;;
858
859
860
;;;   The cookies at this time becomes the default policy for compiling the
;;; form.  Any enclosed PROCLAIMs will affect only subsequent forms.
;;;
861
862
(defun convert-and-maybe-compile (form path)
  (declare (list path))
863
864
865
866
867
868
869
870
871
872
873
874
875
  (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
876
877
878
879

;;; PROCESS-PROGN  --  Internal
;;;
;;;    Process a PROGN-like portion of a top-level form.  Forms is a list of
880
;;; the forms, and Path is source path of the form they came out of.
wlott's avatar
wlott committed
881
;;;
882
883
(defun process-progn (forms path)
  (declare (list forms) (list path))
884
  (dolist (form forms)
885
    (process-form form path)))
wlott's avatar
wlott committed
886
887


888
889
;;; PREPROCESSOR-MACROEXPAND  --  Internal
;;;
890
891
892
;;;    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.
893
894
;;;
(defun preprocessor-macroexpand (form)
895
  (handler-case (macroexpand-1 form *lexical-environment*)
896
    (error (condition)
897
       (compiler-error "(during macroexpansion)~%~A" condition))))
898
899


900
901
902
903
904
;;; PROCESS-LOCALLY  --  Internal
;;;
;;;    Process a top-level use of LOCALLY.  We parse declarations and then
;;; recursively process the body.
;;;
905
;;;    Binding *DEFAULT-xxx-COOKIE* is pretty much of a hack, since it causes
906
907
908
909
910
;;; 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.
;;;
911
912
(defun process-locally (form path)
  (declare (list path))
913
914
915
916
917
  (multiple-value-bind
      (body decls)
      (system:parse-body (cdr form) *lexical-environment* nil)
    (let* ((*lexical-environment*
	    (process-declarations decls nil nil (make-continuation)))
918
919
920
	   (*default-cookie* (lexenv-cookie *lexical-environment*))
	   (*default-interface-cookie*
	    (lexenv-interface-cookie *lexical-environment*)))
921
      (process-progn body path))))
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940


;;; 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)))))))


941
;;; PROCESS-COLD-LOAD-FORM  --  Internal
942
943
;;;
;;;    Force any pending top-level forms to be compiled and dumped so that they
944
945
;;; 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.
946
;;;
947
948
949
950
(defun process-cold-load-form (form path eval)
  (let ((object *compile-object*))
    (etypecase object
      (fasl-file
951
       (compile-top-level-lambdas () t)
952
953
       (fasl-dump-cold-load-form form object))
      ((or null core-object)
954
955
       (convert-and-maybe-compile form path)))
    (when eval (eval form))))
956
957
958
959
960


;;; PROCESS-PROCLAIM  --  Internal
;;;
;;;    If a special block compilation delimiter, then start or end the block as
961
962
;;; appropriate.  Otherwise, just convert-and-maybe-compile the form.  If
;;; *BLOCK-COMPILE* is NIL, then we ignore block declarations.
963
;;;
964
(defun process-proclaim (form path)
965
966
967
968
969
  (if (and (eql (length form) 2) (constantp (cadr form)))
      (let ((spec (eval (cadr form))))
	(if (consp spec)
	    (case (first spec)
	      (start-block
970
	       (when *block-compile*
971
		 (finish-block-compilation)
972
973
974
		 (setq *block-compile* t)
		 (setq *entry-points* (rest spec))))
	      (end-block
975
	       (finish-block-compilation))
976
	      (t
977
978
979
	       (convert-and-maybe-compile form path)))
	    (convert-and-maybe-compile form path)))
      (convert-and-maybe-compile form path)))
980
981


wlott's avatar
wlott committed
982
983
984
985
986
(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
987
988
989
990
;;; 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
991
;;;
992
993
(defun process-form (form path)
  (declare (list path))
wlott's avatar
wlott committed
994
  (catch 'process-form-error-abort
995
996
    (let* ((path (or (gethash form *source-paths*) (cons form path)))
	   (*compiler-error-bailout*
997
998
999
1000
	    #'(lambda ()
		(convert-and-maybe-compile
		 `(error "Execution of a form compiled with errors:~% ~S"
			 ',form)
1001
		 path)
1002
		(throw 'process-form-error-abort nil))))
wlott's avatar
wlott committed
1003
      (if (atom form)
1004
	  (convert-and-maybe-compile form path)
wlott's avatar
wlott committed
1005
	  (case (car form)
1006
1007
1008
	    ((make-package shadow shadowing-import export
	      unexport use-package unuse-package import
	      old-in-package %in-package)
1009
	     (process-cold-load-form form path t))
1010
	    ((error cerror break signal)
1011
	     (process-cold-load-form form path nil))
wlott's avatar
wlott committed
1012
1013
1014
1015
1016
1017
	    ((eval-when)
	     (unless (>= (length form) 2)
	       (compiler-error "EVAL-WHEN form is too short: ~S." form))
	     (do-eval-when-stuff
	      (cadr form) (cddr form)
	      #'(lambda (forms)
1018
		  (process-progn forms path))))
wlott's avatar
wlott committed
1019
1020
1021
1022
1023
1024
	    ((macrolet)
	     (unless (>= (length form) 2)
	       (compiler-error "MACROLET form is too short: ~S." form))
	     (do-macrolet-stuff
	      (cadr form)
	      #'(lambda ()
1025
1026
1027
		  (process-progn (cddr form) path))))
	    (locally (process-locally form path))
	    (progn (process-progn (cdr form) path))
1028
	    (file-comment (process-file-comment form))
1029
	    (proclaim (process-proclaim form path))
wlott's avatar
wlott committed
1030
	    (t
ram's avatar
ram committed
1031
1032
	     (let ((exp (preprocessor-macroexpand form)))
	       (if (eq exp form)
1033
1034
		   (convert-and-maybe-compile form path)
		   (process-form exp path))))))))
wlott's avatar
wlott committed
1035
1036
1037
      
  (undefined-value))

1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153

;;;; Load time value support.

;;; PRODUCING-FASL-FILE  --  interface.
;;;
;;; Returns T iff we are currently producing a fasl-file and hence constants
;;; need to be dumped carfully.
;;; 
(defun producing-fasl-file ()
  (unless *converting-for-interpreter*
    (fasl-file-p *compile-object*)))

;;; COMPILE-LOAD-TIME-VALUE  --  interface.
;;;
;;; Compile FORM and arrange for it to be called at load-time.  Returns the
;;; dumper handle and our best guess at the type of the object.
;;; 
(defun compile-load-time-value
       (form &optional
	     (name (let ((*print-level* 2) (*print-length* 3))
		     (format nil "Load Time Value of ~S" form))))
  (let ((lambda (compile-load-time-stuff form name t)))
    (values
     (fasl-dump-load-time-value-lambda lambda *compile-object*)
     (let ((type (leaf-type lambda)))
       (if (function-type-p type)
	   (single-value-type (function-type-returns type))
	   *wild-type*)))))

;;; COMPILE-MAKE-LOAD-FORM-INIT-FORMS  --  internal.
;;;
;;; Compile the FORMS and arrange for them to be called (for effect, not value)
;;; at load-time.
;;; 
(defun compile-make-load-form-init-forms (forms name)
  (let ((lambda (compile-load-time-stuff `(progn ,@forms) name nil)))
    (fasl-dump-top-level-lambda-call lambda *compile-object*)))

;;; COMPILE-LOAD-TIME-STUFF  --  internal.
;;;
;;; Does the actual work of COMPILE-LOAD-TIME-VALUE or COMPILE-MAKE-LOAD-FORM-
;;; INIT-FORMS.
;;; 
(defun compile-load-time-stuff (form name for-value)
  (compile-top-level-lambdas () t)
  (with-ir1-namespace
   (let* ((*lexical-environment* (make-null-environment))
	  (lambda (ir1-top-level form *current-path* for-value)))
     (setf (leaf-name lambda) name)
     (compile-top-level (list lambda) t)
     lambda)))

;;; COMPILE-LOAD-TIME-VALUE-LAMBDA  --  internal.
;;;
;;; Called by COMPILE-TOP-LEVEL when it was pased T for LOAD-TIME-VALUE-P
;;; (which happens in COMPILE-LOAD-TIME-STUFF).  We don't try to combine
;;; this component with anything else and frob the name.
;;; 
(defun compile-load-time-value-lambda (lambdas)
  (assert (null (cdr lambdas)))
  (let* ((lambda (car lambdas))
	 (component (block-component (node-block (lambda-bind lambda)))))
    (setf (component-name component) (leaf-name lambda))
    (compile-component component)
    (clear-ir1-info component)))


;;; EMIT-MAKE-LOAD-FORM  --  interface.
;;;
;;; The entry point for MAKE-LOAD-FORM support.  When IR1 conversion finds a
;;; constant structure, it invokes this to arrange for proper dumping.  If it
;;; turns out that the constant has already been dumped, then we don't need
;;; to do anything.
;;;
;;; If the constant hasn't been dumped, then we check to see if we are in the
;;; process of creating it.  We detect this by maintaining the special
;;; *constants-being-created* as a list of all the constants we are in the
;;; process of creating.  Actually, each entry is a list of the constant and
;;; any init forms that need to be processed on behalf of that constant.
;;;
;;; It's not necessarily an error for this to happen.  If we are processing the
;;; init form for some object that showed up *after* the original reference
;;; to this constant, then we just need to defer the processing of that init
;;; form.  To detect this, we maintain *constants-created-sense-last-init* as
;;; a list of the constants created sense the last time we started processing
;;; an init form.  If the constant passed to emit-make-load-form shows up in
;;; this list, then there is a circular chain through creation forms, which is
;;; an error.
;;;
;;; If there is some intervening init form, then we blow out of processing it
;;; by throwing to the tag PENDING-INIT.  The value we throw is the entry from
;;; *constants-being-created*.  This is so the offending init form can be
;;; tacked onto the init forms for the circular object.
;;;
;;; If the constant doesn't show up in *constants-being-created*, then we have
;;; to create it.  We call MAKE-LOAD-FORM and check to see if the creation
;;; form is the magic value :just-dump-it-normally.  If it is, then we don't
;;; do anything.  The dumper will eventually get it's hands on the object
;;; and use the normal structure dumping noise on it.
;;;
;;; Otherwise, we bind *constants-being-created* and *constants-created-sense-
;;; last-init* and compile the creation form a la load-time-value.  When this
;;; finishes, we tell the dumper to use that result instead whenever it sees
;;; this constant.
;;;
;;; Now we try to compile the init form.  We bind *constants-created-sense-
;;; last-init* to NIL and compile the init form (and any init forms that were
;;; added because of circularity detection).  If this works, great.  If not,
;;; we add the init forms to the init forms for the object that caused the
;;; problems and let it deal with it.
;;; 
(defvar *constants-being-created* nil)
(defvar *constants-created-sense-last-init* nil)
;;;
(defun emit-make-load-form (constant)
  (assert (fasl-file-p *compile-object*))
1154
  (unless (fasl-constant-already-dumped constant *compile-object*)
1155
1156
1157
1158
1159
1160
1161
    (let ((circular-ref (assoc constant *constants-being-created* :test #'eq)))
      (when circular-ref
	(when (find constant *constants-created-sense-last-init* :test #'eq)
	  (throw constant t))
	(throw 'pending-init circular-ref)))
    (multiple-value-bind
	(creation-form init-form)
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
	(handler-case
	    (if (fboundp 'lisp::make-load-form)
		(locally
		 (declare (optimize (inhibit-warnings 3)))
		 (lisp::make-load-form constant (make-null-environment)))
		(make-structure-load-form constant))
	  (error (condition)
		 (compiler-error "(while making load form for ~S)~%~A"
				 constant condition)))
      (case creation-form
	(:just-dump-it-normally
	 (fasl-validate-structure constant *compile-object*)
	 t)
	(:ignore-it
	 nil)
	(t
	 (let* ((name (let ((*print-level* 1) (*print-length* 2))
			(with-output-to-string (stream)
			  (write constant :stream stream))))
		(info (if init-form
			  (list constant name init-form)
			  (list constant))))
	   (let ((*constants-being-created*
		  (cons info *constants-being-created*))
		 (*constants-created-sense-last-init*
		  (cons constant *constants-created-sense-last-init*)))
	     (when
		 (catch constant
		   (fasl-note-handle-for-constant
		    constant
		    (compile-load-time-value
		     creation-form
		     (format nil "Creation Form for ~A" name))
		    *compile-object*)
		   nil)
	       (compiler-error "Circular references in creation form for ~S"
			       constant)))
	   (when (cdr info)
	     (let* ((*constants-created-sense-last-init* nil)
		    (circular-ref
		     (catch 'pending-init
		       (loop for (name form) on (cdr info) by #'cddr
			 collect name into names
			 collect form into forms
			 finally do
			 (compile-make-load-form-init-forms
			  forms
			  (format nil "Init Form~:[~;s~] for ~{~A~^, ~}"
				  (cdr forms) names)))
		       nil)))
	       (when circular-ref
		 (setf (cdr circular-ref)
		       (append (cdr circular-ref) (cdr info))))))))))))
1215
1216


wlott's avatar
wlott committed
1217
1218
1219

;;;; COMPILE-FILE and COMPILE-FROM-STREAM: 

1220
1221
1222
1223
1224
1225
1226
1227
;;; We build a list of top-level lambdas, and then periodically smash them
;;; together into a single component and compile it.
;;;
(defvar *pending-top-level-lambdas*)

;;; The maximum number of top-level lambdas we put in a single top-level
;;; component.
;;;
1228
(defparameter top-level-lambda-max 10)
1229
1230


1231
1232
;;; OBJECT-CALL-TOP-LEVEL-LAMBDA  --  Internal
;;;
1233
1234
1235
1236
1237
1238
1239
1240
1241
(defun object-call-top-level-lambda (tll)
  (declare (type functional tll))
  (let ((object *compile-object*))
    (etypecase object
      (fasl-file
       (fasl-dump-top-level-lambda-call tll object))
      (core-object
       (core-call-top-level-lambda tll object))
      (null))))
1242
1243
1244


;;; SUB-COMPILE-TOP-LEVEL-LAMBDAS  --  Internal
1245
1246
1247
1248
1249
1250
;;;
;;;    Add Lambdas to the pending lambdas.  If this leaves more than
;;; TOP-LEVEL-LAMBDA-MAX lambdas in the list, or if Force-P is true, then smash
;;; the lambdas into a single component, compile it, and call the resulting
;;; function.
;;;
1251
1252
(defun sub-compile-top-level-lambdas (lambdas force-p)
  (declare (list lambdas))
1253
1254
1255
1256
1257
1258
1259
1260
1261
  (setq *pending-top-level-lambdas*
	(append *pending-top-level-lambdas* lambdas))
  (let ((pending *pending-top-level-lambdas*))
    (when (and pending
	       (or (> (length pending) top-level-lambda-max)
		   force-p))
      (multiple-value-bind (component tll)
			   (merge-top-level-lambdas pending)
	(setq *pending-top-level-lambdas* ())
1262
	(compile-component component)
1263
	(clear-ir1-info component)
1264
	(object-call-top-level-lambda tll))))
1265
1266
1267
1268
1269
1270
1271
1272
1273
  (undefined-value))


;;; COMPILE-TOP-LEVEL-LAMBDAS  --  Internal
;;;
;;;    Compile top-level code and call the Top-Level lambdas.  We pick off
;;; top-level lambdas in non-top-level components here, calling SUB-c-t-l-l on
;;; each subsequence of normal top-level lambdas.
;;;
1274
1275
(defun compile-top-level-lambdas (lambdas force-p)
  (declare (list lambdas))
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
  (let ((len (length lambdas)))
    (flet ((loser (start)
	     (or (position-if #'(lambda (x)
				  (not (eq (component-kind
					    (block-component
					     (node-block
					      (lambda-bind x))))
					   :top-level)))
			      lambdas
			      :start start)
		 len)))
      (do* ((start 0 (1+ loser))
	    (loser (loser start) (loser start)))
	   ((>= start len)
	    (when force-p
1291
	      (sub-compile-top-level-lambdas nil t)))
1292
	(sub-compile-top-level-lambdas (subseq lambdas start loser)
1293
				       (or force-p (/= loser len)))
1294
	(unless (= loser len)
1295
	  (object-call-top-level-lambda (elt lambdas loser))))))
1296
1297
1298
1299
1300
1301
  (undefined-value))


;;; Compile-Top-Level  --  Internal
;;;
;;;    Compile Lambdas (a list of the lambdas for top-level forms) into the
1302
1303
1304
;;; Object file.  We loop doing local call analysis until it converges, since a
;;; single pass might miss something due to components being joined by let
;;; conversion.
1305
;;;
1306
1307
(defun compile-top-level (lambdas load-time-value-p)
  (declare (list lambdas))
1308
  (maybe-mumble "Locall ")
1309
1310
1311
1312
1313
1314
1315
1316
1317
  (loop
    (let ((did-something nil))
      (dolist (lambda lambdas)
	(let* ((component (block-component (node-block (lambda-bind lambda))))
	       (*all-components* (list component)))
	  (when (component-new-functions component)
	    (setq did-something t)
	    (local-call-analyze component))))
      (unless did-something (return))))
1318
  
1319
  (maybe-mumble "IDFO ")
1320
  (multiple-value-bind (components top-components hairy-top)
1321
		       (find-initial-dfo lambdas)
1322
1323
    (let ((*all-components* (append components top-components))
	  (top-level-closure nil))
1324
1325
1326
1327
      (when *check-consistency*
	(maybe-mumble "[Check]~%")
	(check-ir1-consistency *all-components*))
      
1328
      (dolist (component (append hairy-top top-components))
1329
1330
1331
	(pre-environment-analyze-top-level component))
      
      (dolist (component components)
1332
	(compile-component component)
1333
1334
	(when (replace-top-level-xeps component)
	    (setq top-level-closure t)))
1335
1336
1337
1338
1339
      
      (when *check-consistency*
	(maybe-mumble "[Check]~%")
	(check-ir1-consistency *all-components*))
      
1340
1341
1342
      (if load-time-value-p
	  (compile-load-time-value-lambda lambdas)
	  (compile-top-level-lambdas lambdas top-level-closure))
1343

1344
1345
1346
      (dolist (component components)
	(clear-ir1-info component))
      (clear-stuff)))
1347
1348
1349
  (undefined-value))


1350
1351
1352
1353
1354
;;; FINISH-BLOCK-COMPILATION  --  Internal
;;;
;;;    Actually compile any stuff that has been queued up for block
;;; compilation.
;;;
1355
(defun finish-block-compilation ()
1356
1357
  (when *block-compile*
    (when *top-level-lambdas*
1358
      (compile-top-level (nreverse *top-level-lambdas*) nil)
1359
1360
1361
      (setq *top-level-lambdas* ()))
    (setq *block-compile* :specified)
    (setq *entry-points* nil)))
1362
1363


wlott's avatar
wlott committed
1364
1365
;;; Sub-Compile-File  --  Internal
;;;
1366
1367
1368
;;;    Read all forms from Info and compile them, with output to Object.  We
;;; return :ERROR, :WARNING, :NOTE or NIL to indicate the most severe kind of
;;; compiler diagnostic emitted.
wlott's avatar
wlott committed
1369
;;;
1370
1371
(defun sub-compile-file (info &optional d-s-info)
  (declare (type source-info info))
ram's avatar
ram committed
1372
1373
1374
1375
1376
1377
1378
1379
  (with-ir1-namespace
    (clear-stuff)
    (let* ((start-errors *compiler-error-count*)
	   (start-warnings *compiler-warning-count*)
	   (start-notes *compiler-note-count*)
	   (*package* *package*)
	   (*initial-package* *package*)
	   (*initial-cookie* *default-cookie*)
1380
	   (*initial-interface-cookie* *default-interface-cookie*)
ram's avatar
ram committed
1381
	   (*default-cookie* (copy-cookie *initial-cookie*))
1382
1383
	   (*default-interface-cookie*
	    (copy-cookie *initial-interface-cookie*))
1384
1385
	   (*lexical-environment* (make-null-environment))
	   (*converting-for-interpreter* nil)
ram's avatar
ram committed
1386
	   (*source-info* info)
1387
1388
	   (*compile-file-pathname* nil)
	   (*compile-file-truename* nil)
ram's avatar
ram committed
1389
	   (*top-level-lambdas* ())
1390
	   (*pending-top-level-lambdas* ())
ram's avatar
ram committed
1391
1392
1393
1394
1395
	   (*compiler-error-bailout*
	    #'(lambda ()
		(compiler-mumble
		 "~2&Fatal error, aborting compilation...~%")
		(return-from sub-compile-file :error)))
1396
	   (*current-path* nil)
ram's avatar
ram committed
1397
1398
1399
1400
1401
	   (*last-source-context* nil)
	   (*last-original-source* nil)
	   (*last-source-form* nil)
	   (*last-format-string* nil)
	   (*last-format-args* nil)
1402
1403
1404
	   (*last-message-count* 0)
	   (*info-environment*
	    (or (backend-info-environment *backend*)
1405
		*info-environment*)))
ram's avatar
ram committed
1406
1407
1408
1409
1410
1411
1412
      (with-compilation-unit ()
	(loop
	  (multiple-value-bind (form tlf eof-p)
			       (read-source-form info)
	    (when eof-p (return))
	    (clrhash *source-paths*)
	    (find-source-paths form tlf)
1413
1414
1415
1416
1417
1418
1419
1420
1421
	    (process-form form `(original-source-start 0 ,tlf))))

	(finish-block-compilation)
	(compile-top-level-lambdas () t)
	(let ((object *compile-object*))
	  (etypecase object
	    (fasl-file (fasl-dump-source-info info object))
	    (core-object (fix-core-source-info info object d-s-info))
	    (null)))
ram's avatar
ram committed
1422
1423
1424
1425
1426
    
	(cond ((> *compiler-error-count* start-errors) :error)
	      ((> *compiler-warning-count* start-warnings) :warning)
	      ((> *compiler-note-count* start-notes) :note)
	      (t nil))))))
wlott's avatar
wlott committed
1427
1428
1429
1430


;;; Verify-Source-Files  --  Internal
;;;
1431
1432
;;;    Return a list of pathnames for the named files.  All the files must
;;; exist.
wlott's avatar
wlott committed
1433
1434
1435
1436
1437
;;;
(defun verify-source-files (stuff)
  (unless stuff
    (error "Can't compile with no source files."))
  (mapcar #'(lambda (x)
1438
1439
1440
1441
1442
1443
1444
	      (let ((x (pathname x)))
		(if (probe-file x)
		    x
		    (let ((x (merge-pathnames x (make-pathname :type "lisp"))))
		      (if (probe-file x)
			  x
			  (truename x))))))
wlott's avatar
wlott committed
1445
1446
1447
1448
1449
1450
1451
1452
	  (if (listp stuff) stuff (list stuff))))


;;; COMPILE-FROM-STREAM  --  Public
;;;
;;;    Just call SUB-COMPILE-FILE on the on a stream source info for the
;;; stream, sending output to core.
;;;
1453
1454
1455
1456
(defun compile-from-stream
       (stream &key
	       ((:error-stream *compiler-error-output*) *error-output*)
	       ((:trace-stream *compiler-trace-output*) nil)
1457
1458
1459
	       ((:verbose *compile-verbose*) *compile-verbose*)
	       ((:print *compile-print*) *compile-print*)
	       ((:progress *compile-progress*) *compile-progress*)
1460
1461
1462
	       ((:block-compile *block-compile*) *block-compile-default*)
	       ((:entry-points *entry-points*) nil)
	       source-info)
wlott's avatar
wlott committed
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
  "Similar to COMPILE-FILE, but compiles text from Stream into the current lisp
  environment.  Stream is closed when compilation is complete.  These keywords
  are supported:

  :Error-Stream
      The stream to write compiler error output to (default *ERROR-OUTPUT*.)
  :Trace-Stream
      The stream that we write compiler trace output to, or NIL (the default)
      to inhibit trace output.
  :Block-Compile
1473
1474
1475
        If true, then function names will be resolved at compile time.
  :Source-Info
        Some object to be placed in the DEBUG-SOURCE-INFO."
1476
1477
  (let ((info (make-stream-source-info stream))
	(*backend* *native-backend*))
wlott's avatar
wlott committed
1478
    (unwind-protect
1479
1480
	(let* ((*compile-object* (make-core-object))
	       (won (sub-compile-file info source-info)))
wlott's avatar
wlott committed
1481
1482
1483
1484
1485
	  (values (not (null won))
		  (if (member won '(:error :warning)) t nil)))
      (close-source-info info))))


ram's avatar
ram committed
1486
1487
1488
1489
1490
1491
(defun elapsed-time-to-string (tsec)
  (multiple-value-bind (tmin sec)
		       (truncate tsec 60)
    (multiple-value-bind (thr min)
			 (truncate tmin 60)
      (format nil "~D:~2,'0D:~2,'0D" thr min sec))))
1492
1493
1494
1495
1496
1497
1498
1499


;;; START-ERROR-OUTPUT, FINISH-ERROR-OUTPUT  --  Internal
;;;
;;;    Print some junk at the beginning and end of compilation.
;;;
(defun start-error-output (source-info)
  (declare (type source-info source-info))
ram's avatar
ram committed
1500
  (compiler-mumble "~2&Python version ~A, VM version ~A on ~A.~%"
1501
		   compiler-version (backend-version *backend*)
1502
		   (ext:format-universal-time nil (get-universal-time)
1503
					      :style :government
1504
1505
1506
1507
					      :print-weekday nil
					      :print-timezone nil))
  (dolist (x (source-info-files source-info))
    (compiler-mumble "Compiling: ~A ~A~%"
1508
		     (file-info-name x)
1509
		     (ext:format-universal-time nil (file-info-write-date x)
1510
						:style :government
1511
1512
1513
1514
1515
1516
1517
						:print-weekday nil
						:print-timezone nil)))
  (compiler-mumble "~%")
  (undefined-value))
;;;
(defun finish-error-output (source-info won)
  (declare (type source-info source-info))
1518
  (compiler-mumble "~&Compilation ~:[aborted after~;finished in~] ~A.~&"
1519
1520
1521
1522
1523
1524
1525
		   won
		   (elapsed-time-to-string
		    (- (get-universal-time)
		       (source-info-start-time source-info))))
  (undefined-value))


chiles's avatar
   
chiles committed
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
;;; COMPILE-FILE  --  Public.
;;;
;;; Open some files and call SUB-COMPILE-FILE.  If something unwinds out of the
;;; compile, then abort the writing of the output file, so we don't overwrite
;;; it with known garbage.
;;;
(defun compile-file (source &key
			    (output-file t)
			    (error-file nil)
			    (trace-file nil) 
			    (error-output t)
			    (load nil)
			    ((:verbose *compile-verbose*) *compile-verbose*)
			    ((:print *compile-print*) *compile-print*)
			    ((:progress *compile-progress*) *compile-progress*)
			    ((:block-compile *block-compile*)
			     *block-compile-default*)
			    ((:entry-points *entry-points*) nil))
wlott's avatar
wlott committed
1544
  "Compiles Source, producing a corresponding .FASL file.  Source may be a list
chiles's avatar
   
chiles committed
1545