1 ;;;; the top-level interfaces to the compiler, plus some other
2 ;;;; compiler-related stuff (e.g. CL:CALL-ARGUMENTS-LIMIT) which
3 ;;;; doesn't obviously belong anywhere else
5 ;;;; This software is part of the SBCL system. See the README file for
8 ;;;; This software is derived from the CMU CL system, which was
9 ;;;; written at Carnegie Mellon University and released into the
10 ;;;; public domain. The software is in the public domain and is
11 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
12 ;;;; files for more information.
16 ;;; FIXME: Doesn't this belong somewhere else, like early-c.lisp?
17 (declaim (special *constants* *free-variables* *component-being-compiled*
18 *code-vector* *next-location* *result-fixups*
19 *free-functions* *source-paths*
20 *seen-blocks* *seen-functions* *list-conflicts-table*
21 *continuation-number* *continuation-numbers*
22 *number-continuations* *tn-id* *tn-ids* *id-tns*
23 *label-ids* *label-id* *id-labels*
24 *undefined-warnings* *compiler-error-count*
25 *compiler-warning-count* *compiler-style-warning-count*
27 *compiler-error-bailout*
28 #!+sb-show *compiler-trace-output*
29 *last-source-context* *last-original-source*
30 *last-source-form* *last-format-string* *last-format-args*
31 *last-message-count* *lexenv*))
33 (defvar *check-consistency* nil)
34 (defvar *all-components*)
36 ;;; Bind this to a stream to capture various internal debugging output.
37 (defvar *compiler-trace-output* nil)
39 ;;; The current block compilation state. These are initialized to the
40 ;;; :BLOCK-COMPILE and :ENTRY-POINTS arguments that COMPILE-FILE was
43 ;;; *BLOCK-COMPILE-ARGUMENT* holds the original value of the
44 ;;; :BLOCK-COMPILE argument, which overrides any internal
46 (defvar *block-compile*)
47 (defvar *block-compile-argument*)
48 (declaim (type (member nil t :specified)
49 *block-compile* *block-compile-argument*))
50 (defvar *entry-points*)
51 (declaim (list *entry-points*))
53 ;;; When block compiling, used by PROCESS-FORM to accumulate top-level
54 ;;; lambdas resulting from compiling subforms. (In reverse order.)
55 (defvar *top-level-lambdas*)
56 (declaim (list *top-level-lambdas*))
58 (defvar sb!xc:*compile-verbose* t
60 "The default for the :VERBOSE argument to COMPILE-FILE.")
61 (defvar sb!xc:*compile-print* t
63 "The default for the :PRINT argument to COMPILE-FILE.")
64 (defvar *compile-progress* nil
66 "When this is true, the compiler prints to *ERROR-OUTPUT* progress
67 information about the phases of compilation of each function. (This
68 is useful mainly in large block compilations.)")
70 (defvar sb!xc:*compile-file-pathname* nil
72 "The defaulted pathname of the file currently being compiled, or NIL if not
74 (defvar sb!xc:*compile-file-truename* nil
76 "The TRUENAME of the file currently being compiled, or NIL if not
79 (declaim (type (or pathname null)
80 sb!xc:*compile-file-pathname*
81 sb!xc:*compile-file-truename*))
83 ;;; the SOURCE-INFO structure for the current compilation. This is
84 ;;; null globally to indicate that we aren't currently in any
85 ;;; identifiable compilation.
86 (defvar *source-info* nil)
88 ;;; This is true if we are within a WITH-COMPILATION-UNIT form (which
89 ;;; normally causes nested uses to be no-ops).
90 (defvar *in-compilation-unit* nil)
92 ;;; Count of the number of compilation units dynamically enclosed by
93 ;;; the current active WITH-COMPILATION-UNIT that were unwound out of.
94 (defvar *aborted-compilation-unit-count*)
96 ;;; Mumble conditional on *COMPILE-PROGRESS*.
97 (defun maybe-mumble (&rest foo)
98 (when *compile-progress*
99 (compiler-mumble "~&")
100 (pprint-logical-block (*error-output* nil :per-line-prefix "; ")
101 (apply #'compiler-mumble foo))))
103 (deftype object () '(or fasl-output core-object null))
105 (defvar *compile-object* nil)
106 (declaim (type object *compile-object*))
108 ;;;; WITH-COMPILATION-UNIT and WITH-COMPILATION-VALUES
110 (defmacro sb!xc:with-compilation-unit (options &body body)
112 "WITH-COMPILATION-UNIT ({Key Value}*) Form*
113 This form affects compilations that take place within its dynamic extent. It
114 is intended to be wrapped around the compilation of all files in the same
115 system. These keywords are defined:
116 :OVERRIDE Boolean-Form
117 One of the effects of this form is to delay undefined warnings
118 until the end of the form, instead of giving them at the end of each
119 compilation. If OVERRIDE is NIL (the default), then the outermost
120 WITH-COMPILATION-UNIT form grabs the undefined warnings. Specifying
121 OVERRIDE true causes that form to grab any enclosed warnings, even if
122 it is enclosed by another WITH-COMPILATION-UNIT."
123 `(%with-compilation-unit (lambda () ,@body) ,@options))
125 (defun %with-compilation-unit (fn &key override)
126 (let ((succeeded-p nil))
127 (if (and *in-compilation-unit* (not override))
128 ;; Inside another WITH-COMPILATION-UNIT, a WITH-COMPILATION-UNIT is
129 ;; ordinarily (unless OVERRIDE) basically a no-op.
131 (multiple-value-prog1 (funcall fn) (setf succeeded-p t))
133 (incf *aborted-compilation-unit-count*)))
134 ;; FIXME: Now *COMPILER-FOO-COUNT* stuff is bound in more than
135 ;; one place. If we can get rid of the IR1 interpreter, this
136 ;; should be easier to clean up.
137 (let ((*aborted-compilation-unit-count* 0)
138 (*compiler-error-count* 0)
139 (*compiler-warning-count* 0)
140 (*compiler-style-warning-count* 0)
141 (*compiler-note-count* 0)
142 (*undefined-warnings* nil)
143 (*in-compilation-unit* t))
144 (handler-bind ((parse-unknown-type
146 (note-undefined-reference
147 (parse-unknown-type-specifier c)
150 (multiple-value-prog1 (funcall fn) (setf succeeded-p t))
152 (incf *aborted-compilation-unit-count*))
153 (summarize-compilation-unit (not succeeded-p))))))))
155 ;;; This is to be called at the end of a compilation unit. It signals
156 ;;; any residual warnings about unknown stuff, then prints the total
157 ;;; error counts. ABORT-P should be true when the compilation unit was
158 ;;; aborted by throwing out. ABORT-COUNT is the number of dynamically
159 ;;; enclosed nested compilation units that were aborted.
160 (defun summarize-compilation-unit (abort-p)
162 (handler-bind ((style-warning #'compiler-style-warning-handler)
163 (warning #'compiler-warning-handler))
165 (let ((undefs (sort *undefined-warnings* #'string<
167 (let ((x (undefined-warning-name x)))
170 (prin1-to-string x)))))))
171 (dolist (undef undefs)
172 (let ((name (undefined-warning-name undef))
173 (kind (undefined-warning-kind undef))
174 (warnings (undefined-warning-warnings undef))
175 (undefined-warning-count (undefined-warning-count undef)))
176 (dolist (*compiler-error-context* warnings)
177 (compiler-style-warning "undefined ~(~A~): ~S" kind name))
178 (let ((warn-count (length warnings)))
179 (when (and warnings (> undefined-warning-count warn-count))
180 (let ((more (- undefined-warning-count warn-count)))
181 (compiler-style-warning
182 "~D more use~:P of undefined ~(~A~) ~S"
185 (dolist (kind '(:variable :function :type))
186 (let ((summary (mapcar #'undefined-warning-name
187 (remove kind undefs :test-not #'eq
188 :key #'undefined-warning-kind))))
190 (compiler-style-warning
191 "~:[This ~(~A~) is~;These ~(~A~)s are~] undefined:~
192 ~% ~{~<~% ~1:;~S~>~^ ~}"
193 (cdr summary) kind summary)))))))
195 (unless (and (not abort-p)
196 (zerop *aborted-compilation-unit-count*)
197 (zerop *compiler-error-count*)
198 (zerop *compiler-warning-count*)
199 (zerop *compiler-style-warning-count*)
200 (zerop *compiler-note-count*))
201 (format *error-output* "~&")
202 (pprint-logical-block (*error-output* nil :per-line-prefix "; ")
203 (compiler-mumble "compilation unit ~:[finished~;aborted~]~
204 ~[~:;~:*~& caught ~D fatal ERROR condition~:P~]~
205 ~[~:;~:*~& caught ~D ERROR condition~:P~]~
206 ~[~:;~:*~& caught ~D WARNING condition~:P~]~
207 ~[~:;~:*~& caught ~D STYLE-WARNING condition~:P~]~
208 ~[~:;~:*~& printed ~D note~:P~]"
210 *aborted-compilation-unit-count*
211 *compiler-error-count*
212 *compiler-warning-count*
213 *compiler-style-warning-count*
214 *compiler-note-count*)))
215 (format *error-output* "~&"))
217 ;;; Evaluate BODY, then return (VALUES BODY-VALUE WARNINGS-P
218 ;;; FAILURE-P), where BODY-VALUE is the first value of the body, and
219 ;;; WARNINGS-P and FAILURE-P are as in CL:COMPILE or CL:COMPILE-FILE.
220 ;;; This also wraps up WITH-IR1-NAMESPACE functionality.
221 (defmacro with-compilation-values (&body body)
223 (let ((*warnings-p* nil)
225 (values (progn ,@body)
229 ;;;; component compilation
231 (defparameter *max-optimize-iterations* 3 ; ARB
233 "The upper limit on the number of times that we will consecutively do IR1
234 optimization that doesn't introduce any new code. A finite limit is
235 necessary, since type inference may take arbitrarily long to converge.")
237 (defevent ir1-optimize-until-done "IR1-OPTIMIZE-UNTIL-DONE called")
238 (defevent ir1-optimize-maxed-out "hit *MAX-OPTIMIZE-ITERATIONS* limit")
240 ;;; Repeatedly optimize COMPONENT until no further optimizations can
241 ;;; be found or we hit our iteration limit. When we hit the limit, we
242 ;;; clear the component and block REOPTIMIZE flags to discourage the
243 ;;; next optimization attempt from pounding on the same code.
244 (defun ir1-optimize-until-done (component)
245 (declare (type component component))
247 (event ir1-optimize-until-done)
249 (cleared-reanalyze nil))
251 (when (component-reanalyze component)
253 (setq cleared-reanalyze t)
254 (setf (component-reanalyze component) nil))
255 (setf (component-reoptimize component) nil)
256 (ir1-optimize component)
257 (cond ((component-reoptimize component)
259 (when (= count *max-optimize-iterations*)
261 (cond ((retry-delayed-ir1-transforms :optimize)
265 (event ir1-optimize-maxed-out)
266 (setf (component-reoptimize component) nil)
267 (do-blocks (block component)
268 (setf (block-reoptimize block) nil))
270 ((retry-delayed-ir1-transforms :optimize)
277 (when cleared-reanalyze
278 (setf (component-reanalyze component) t)))
281 (defparameter *constraint-propagate* t)
283 ;;; KLUDGE: This was bumped from 5 to 10 in a DTC patch ported by MNA
284 ;;; from CMU CL into sbcl-0.6.11.44, the same one which allowed IR1
285 ;;; transforms to be delayed. Either DTC or MNA or both didn't explain
286 ;;; why, and I don't know what the rationale was. -- WHN 2001-04-28
288 ;;; FIXME: It would be good to document why it's important to have a
289 ;;; large value here, and what the drawbacks of an excessively large
290 ;;; value are; and it might also be good to make it depend on
291 ;;; optimization policy.
292 (defparameter *reoptimize-after-type-check-max* 10)
294 (defevent reoptimize-maxed-out
295 "*REOPTIMIZE-AFTER-TYPE-CHECK-MAX* exceeded.")
297 ;;; Iterate doing FIND-DFO until no new dead code is discovered.
298 (defun dfo-as-needed (component)
299 (declare (type component component))
300 (when (component-reanalyze component)
304 (unless (component-reanalyze component)
310 ;;; Do all the IR1 phases for a non-top-level component.
311 (defun ir1-phases (component)
312 (declare (type component component))
313 (let ((*constraint-number* 0)
315 (*delayed-ir1-transforms* nil))
316 (declare (special *constraint-number* *delayed-ir1-transforms*))
318 (ir1-optimize-until-done component)
319 (when (or (component-new-functions component)
320 (component-reanalyze-functions component))
321 (maybe-mumble "locall ")
322 (local-call-analyze component))
323 (dfo-as-needed component)
324 (when *constraint-propagate*
325 (maybe-mumble "constraint ")
326 (constraint-propagate component))
327 (when (retry-delayed-ir1-transforms :constraint)
328 (maybe-mumble "Rtran "))
329 ;; Delay the generation of type checks until the type
330 ;; constraints have had time to propagate, else the compiler can
332 (unless (and (or (component-reoptimize component)
333 (component-reanalyze component)
334 (component-new-functions component)
335 (component-reanalyze-functions component))
336 (< loop-count (- *reoptimize-after-type-check-max* 4)))
337 (maybe-mumble "type ")
338 (generate-type-checks component)
339 (unless (or (component-reoptimize component)
340 (component-reanalyze component)
341 (component-new-functions component)
342 (component-reanalyze-functions component))
344 (when (>= loop-count *reoptimize-after-type-check-max*)
345 (maybe-mumble "[reoptimize limit]")
346 (event reoptimize-maxed-out)
350 (ir1-finalize component)
353 (defun %compile-component (component)
354 (let ((*code-segment* nil)
356 (maybe-mumble "GTN ")
357 (gtn-analyze component)
358 (maybe-mumble "LTN ")
359 (ltn-analyze component)
360 (dfo-as-needed component)
361 (maybe-mumble "control ")
362 (control-analyze component #'make-ir2-block)
364 (when (ir2-component-values-receivers (component-info component))
365 (maybe-mumble "stack ")
366 (stack-analyze component)
367 ;; Assign BLOCK-NUMBER for any cleanup blocks introduced by
368 ;; stack analysis. There shouldn't be any unreachable code after
369 ;; control, so this won't delete anything.
370 (dfo-as-needed component))
374 (maybe-mumble "IR2tran ")
376 (entry-analyze component)
377 (ir2-convert component)
379 (when (policy *lexenv* (>= speed compilation-speed))
380 (maybe-mumble "copy ")
381 (copy-propagate component))
383 (select-representations component)
385 (when *check-consistency*
386 (maybe-mumble "check2 ")
387 (check-ir2-consistency component))
389 (delete-unreferenced-tns component)
391 (maybe-mumble "life ")
392 (lifetime-analyze component)
394 (when *compile-progress*
395 (compiler-mumble "") ; Sync before doing more output.
396 (pre-pack-tn-stats component *error-output*))
398 (when *check-consistency*
399 (maybe-mumble "check-life ")
400 (check-life-consistency component))
402 (maybe-mumble "pack ")
405 (when *check-consistency*
406 (maybe-mumble "check-pack ")
407 (check-pack-consistency component))
409 (when *compiler-trace-output*
410 (describe-component component *compiler-trace-output*)
411 (describe-ir2-component component *compiler-trace-output*))
413 (maybe-mumble "code ")
414 (multiple-value-bind (code-length trace-table fixups)
415 (generate-code component)
417 (when *compiler-trace-output*
418 (format *compiler-trace-output*
419 "~|~%disassembly of code for ~S~2%" component)
420 (sb!disassem:disassemble-assem-segment *code-segment*
421 *compiler-trace-output*))
423 (etypecase *compile-object*
425 (maybe-mumble "fasl")
426 (fasl-dump-component component
433 (maybe-mumble "core")
434 (make-core-component component
442 ;; We're done, so don't bother keeping anything around.
443 (setf (component-info component) nil)
447 ;;; Delete components with no external entry points before we try to
448 ;;; generate code. Unreachable closures can cause IR2 conversion to
449 ;;; puke on itself, since it is the reference to the closure which
450 ;;; normally causes the components to be combined.
451 (defun delete-if-no-entries (component)
452 (dolist (fun (component-lambdas component) (delete-component component))
453 (when (functional-has-external-references-p fun)
455 (case (functional-kind fun)
456 (:top-level (return))
458 (unless (every (lambda (ref)
459 (eq (block-component (node-block ref))
464 (defun compile-component (component)
465 (let* ((*component-being-compiled* component))
466 (when sb!xc:*compile-print*
467 (compiler-mumble "~&; compiling ~A: " (component-name component)))
469 (ir1-phases component)
471 ;; FIXME: What is MAYBE-MUMBLE for? Do we need it any more?
472 (maybe-mumble "env ")
473 (physenv-analyze component)
474 (dfo-as-needed component)
476 (delete-if-no-entries component)
478 (unless (eq (block-next (component-head component))
479 (component-tail component))
480 (%compile-component component)))
482 (clear-constant-info)
484 (when sb!xc:*compile-print*
485 (compiler-mumble "~&"))
489 ;;;; clearing global data structures
491 ;;;; FIXME: Is it possible to get rid of this stuff, getting rid of
492 ;;;; global data structures entirely when possible and consing up the
493 ;;;; others from scratch instead of clearing and reusing them?
495 ;;; Clear the INFO in constants in the *FREE-VARIABLES*, etc. In
496 ;;; addition to allowing stuff to be reclaimed, this is required for
497 ;;; correct assignment of constant offsets, since we need to assign a
498 ;;; new offset for each component. We don't clear the FUNCTIONAL-INFO
499 ;;; slots, since they are used to keep track of functions across
500 ;;; component boundaries.
501 (defun clear-constant-info ()
502 (maphash #'(lambda (k v)
504 (setf (leaf-info v) nil))
506 (maphash #'(lambda (k v)
509 (setf (leaf-info v) nil)))
513 ;;; Blow away the REFS for all global variables, and let COMPONENT
515 (defun clear-ir1-info (component)
516 (declare (type component component))
518 (maphash #'(lambda (k v)
522 (delete-if #'here-p (leaf-refs v)))
523 (when (basic-var-p v)
524 (setf (basic-var-sets v)
525 (delete-if #'here-p (basic-var-sets v))))))
528 (eq (block-component (node-block x)) component)))
529 (blast *free-variables*)
530 (blast *free-functions*)
534 ;;; Clear global variables used by the compiler.
536 ;;; FIXME: It seems kinda nasty and unmaintainable to have to do this,
537 ;;; and it adds overhead even when people aren't using the compiler.
538 ;;; Perhaps we could make these global vars unbound except when
539 ;;; actually in use, so that this function could go away.
540 (defun clear-stuff (&optional (debug-too t))
542 ;; Clear global tables.
543 (when (boundp '*free-functions*)
544 (clrhash *free-functions*)
545 (clrhash *free-variables*)
546 (clrhash *constants*))
548 ;; Clear debug counters and tables.
549 (clrhash *seen-blocks*)
550 (clrhash *seen-functions*)
551 (clrhash *list-conflicts-table*)
554 (clrhash *continuation-numbers*)
555 (clrhash *number-continuations*)
556 (setq *continuation-number* 0)
560 (clrhash *label-ids*)
561 (clrhash *id-labels*)
564 ;; Clear some PACK data structures (for GC purposes only).
565 (aver (not *in-pack*))
566 (dolist (sb *backend-sb-list*)
567 (when (finite-sb-p sb)
568 (fill (finite-sb-live-tns sb) nil))))
570 ;; (Note: The CMU CL code used to set CL::*GENSYM-COUNTER* to zero here.
571 ;; Superficially, this seemed harmful -- the user could reasonably be
572 ;; surprised if *GENSYM-COUNTER* turned back to zero when something was
573 ;; compiled. A closer inspection showed that this actually turned out to be
574 ;; harmless in practice, because CLEAR-STUFF was only called from within
575 ;; forms which bound CL::*GENSYM-COUNTER* to zero. However, this means that
576 ;; even though zeroing CL::*GENSYM-COUNTER* here turned out to be harmless in
577 ;; practice, it was also useless in practice. So we don't do it any more.)
583 ;;; Print out some useful info about Component to Stream.
584 (defun describe-component (component *standard-output*)
585 (declare (type component component))
586 (format t "~|~%;;;; component: ~S~2%" (component-name component))
587 (print-blocks component)
590 (defun describe-ir2-component (component *standard-output*)
591 (format t "~%~|~%;;;; IR2 component: ~S~2%" (component-name component))
592 (format t "entries:~%")
593 (dolist (entry (ir2-component-entries (component-info component)))
594 (format t "~4TL~D: ~S~:[~; [closure]~]~%"
595 (label-id (entry-info-offset entry))
596 (entry-info-name entry)
597 (entry-info-closure-p entry)))
599 (pre-pack-tn-stats component *standard-output*)
601 (print-ir2-blocks component)
607 ;;;; When reading from a file, we have to keep track of some source
608 ;;;; information. We also exploit our ability to back up for printing
609 ;;;; the error context and for recovering from errors.
611 ;;;; The interface we provide to this stuff is the stream-oid
612 ;;;; Source-Info structure. The bookkeeping is done as a side-effect
613 ;;;; of getting the next source form.
615 ;;; A FILE-INFO structure holds all the source information for a
617 (defstruct (file-info (:copier nil))
618 ;; If a file, the truename of the corresponding source file. If from
619 ;; a Lisp form, :LISP. If from a stream, :STREAM.
620 (name (missing-arg) :type (or pathname (member :lisp :stream)))
621 ;; the defaulted, but not necessarily absolute file name (i.e. prior
622 ;; to TRUENAME call.) Null if not a file. This is used to set
623 ;; *COMPILE-FILE-PATHNAME*, and if absolute, is dumped in the
625 (untruename nil :type (or pathname null))
626 ;; the file's write date (if relevant)
627 (write-date nil :type (or unsigned-byte null))
628 ;; the source path root number of the first form in this file (i.e.
629 ;; the total number of forms converted previously in this
631 (source-root 0 :type unsigned-byte)
632 ;; parallel vectors containing the forms read out of the file and
633 ;; the file positions that reading of each form started at (i.e. the
634 ;; end of the previous form)
635 (forms (make-array 10 :fill-pointer 0 :adjustable t) :type (vector t))
636 (positions (make-array 10 :fill-pointer 0 :adjustable t) :type (vector t)))
638 ;;; The SOURCE-INFO structure provides a handle on all the source
639 ;;; information for an entire compilation.
640 (defstruct (source-info
641 #-no-ansi-print-object
642 (:print-object (lambda (s stream)
643 (print-unreadable-object (s stream :type t))))
645 ;; the UT that compilation started at
646 (start-time (get-universal-time) :type unsigned-byte)
647 ;; the FILE-INFO structure for this compilation
648 (file-info nil :type (or file-info null))
649 ;; the stream that we are using to read the FILE-INFO, or NIL if
650 ;; no stream has been opened yet
651 (stream nil :type (or stream null)))
653 ;;; Given a pathname, return a SOURCE-INFO structure.
654 (defun make-file-source-info (file)
655 (let ((file-info (make-file-info :name (truename file)
657 :write-date (file-write-date file))))
659 (make-source-info :file-info file-info)))
661 ;;; Return a SOURCE-INFO to describe the incremental compilation of FORM.
662 (defun make-lisp-source-info (form)
663 (make-source-info :start-time (get-universal-time)
664 :file-info (make-file-info :name :lisp
668 ;;; Return a SOURCE-INFO which will read from STREAM.
669 (defun make-stream-source-info (stream)
670 (let ((file-info (make-file-info :name :stream)))
671 (make-source-info :file-info file-info
674 ;;; Return a form read from STREAM; or for EOF use the trick,
675 ;;; popularized by Kent Pitman, of returning STREAM itself. If an
676 ;;; error happens, then convert it to standard abort-the-compilation
677 ;;; error condition (possibly recording some extra location
679 (defun read-for-compile-file (stream position)
680 (handler-case (read stream nil stream)
681 (reader-error (condition)
682 (error 'input-error-in-compile-file
684 ;; We don't need to supply :POSITION here because
685 ;; READER-ERRORs already know their position in the file.
687 ;; ANSI, in its wisdom, says that READ should return END-OF-FILE
688 ;; (and that this is not a READER-ERROR) when it encounters end of
689 ;; file in the middle of something it's trying to read.
690 (end-of-file (condition)
691 (error 'input-error-in-compile-file
693 ;; We need to supply :POSITION here because the END-OF-FILE
694 ;; condition doesn't carry the position that the user
695 ;; probably cares about, where the failed READ began.
696 :position position))))
698 ;;; If STREAM is present, return it, otherwise open a stream to the
699 ;;; current file. There must be a current file.
701 ;;; FIXME: This is probably an unnecessarily roundabout way to do
702 ;;; things now that we process a single file in COMPILE-FILE (unlike
703 ;;; the old CMU CL code, which accepted multiple files). Also, the old
705 ;;; When we open a new file, we also reset *PACKAGE* and policy.
706 ;;; This gives the effect of rebinding around each file.
707 ;;; which doesn't seem to be true now. Check to make sure that if
708 ;;; such rebinding is necessary, it's still done somewhere.
709 (defun get-source-stream (info)
710 (declare (type source-info info))
711 (or (source-info-stream info)
712 (let* ((file-info (source-info-file-info info))
713 (name (file-info-name file-info)))
714 (setf sb!xc:*compile-file-truename* name
715 sb!xc:*compile-file-pathname* (file-info-untruename file-info)
716 (source-info-stream info) (open name :direction :input)))))
718 ;;; Close the stream in INFO if it is open.
719 (defun close-source-info (info)
720 (declare (type source-info info))
721 (let ((stream (source-info-stream info)))
722 (when stream (close stream)))
723 (setf (source-info-stream info) nil)
726 ;;; Read and compile the source file.
727 (defun sub-sub-compile-file (info)
728 (let* ((file-info (source-info-file-info info))
729 (stream (get-source-stream info)))
731 (let* ((pos (file-position stream))
732 (form (read-for-compile-file stream pos)))
733 (if (eq form stream) ; i.e., if EOF
735 (let* ((forms (file-info-forms file-info))
736 (current-idx (+ (fill-pointer forms)
737 (file-info-source-root file-info))))
738 (vector-push-extend form forms)
739 (vector-push-extend pos (file-info-positions file-info))
740 (find-source-paths form current-idx)
741 (process-top-level-form form
742 `(original-source-start 0 ,current-idx)
745 ;;; Return the INDEX'th source form read from INFO and the position
746 ;;; where it was read.
747 (defun find-source-root (index info)
748 (declare (type index index) (type source-info info))
749 (let ((file-info (source-info-file-info info)))
750 (values (aref (file-info-forms file-info) index)
751 (aref (file-info-positions file-info) index))))
753 ;;;; top-level form processing
755 ;;; This is called by top-level form processing when we are ready to
756 ;;; actually compile something. If *BLOCK-COMPILE* is T, then we still
757 ;;; convert the form, but delay compilation, pushing the result on
758 ;;; *TOP-LEVEL-LAMBDAS* instead.
759 (defun convert-and-maybe-compile (form path)
760 (declare (list path))
761 (let* ((*lexenv* (make-lexenv :policy *policy*))
762 (tll (ir1-top-level form path nil)))
763 (cond ((eq *block-compile* t) (push tll *top-level-lambdas*))
764 (t (compile-top-level (list tll) nil)))))
766 ;;; Macroexpand FORM in the current environment with an error handler.
767 ;;; We only expand one level, so that we retain all the intervening
768 ;;; forms in the source path.
769 (defun preprocessor-macroexpand-1 (form)
770 (handler-case (sb!xc:macroexpand-1 form *lexenv*)
772 (compiler-error "(during macroexpansion of ~A)~%~A"
773 (let ((*print-level* 1)
775 (format nil "~S" form))
778 ;;; Process a PROGN-like portion of a top-level form. FORMS is a list of
779 ;;; the forms, and PATH is the source path of the FORM they came out of.
780 ;;; COMPILE-TIME-TOO is as in ANSI "3.2.3.1 Processing of Top Level Forms".
781 (defun process-top-level-progn (forms path compile-time-too)
782 (declare (list forms) (list path))
784 (process-top-level-form form path compile-time-too)))
786 ;;; Process a top-level use of LOCALLY, or anything else (e.g.
787 ;;; MACROLET) at top-level which has declarations and ordinary forms.
788 ;;; We parse declarations and then recursively process the body.
789 (defun process-top-level-locally (body path compile-time-too)
790 (declare (list path))
791 (multiple-value-bind (forms decls) (sb!sys:parse-body body nil)
793 (process-decls decls nil nil (make-continuation)))
794 ;; Binding *POLICY* is pretty much of a hack, since it
795 ;; causes LOCALLY to "capture" enclosed proclamations. It
796 ;; is necessary because CONVERT-AND-MAYBE-COMPILE uses the
797 ;; value of *POLICY* as the policy. The need for this hack
798 ;; is due to the quirk that there is no way to represent in
799 ;; a POLICY that an optimize quality came from the default.
801 ;; FIXME: Ideally, something should be done so that DECLAIM
802 ;; inside LOCALLY works OK. Failing that, at least we could
803 ;; issue a warning instead of silently screwing up.
804 (*policy* (lexenv-policy *lexenv*)))
805 (process-top-level-progn forms path compile-time-too))))
807 ;;; Parse an EVAL-WHEN situations list, returning three flags,
808 ;;; (VALUES COMPILE-TOPLEVEL LOAD-TOPLEVEL EXECUTE), indicating
809 ;;; the types of situations present in the list.
810 (defun parse-eval-when-situations (situations)
811 (when (or (not (listp situations))
812 (set-difference situations
819 (compiler-error "bad EVAL-WHEN situation list: ~S" situations))
820 (let ((deprecated-names (intersection situations '(compile load eval))))
821 (when deprecated-names
822 (style-warn "using deprecated EVAL-WHEN situation names~{ ~S~}"
824 (values (intersection '(:compile-toplevel compile)
826 (intersection '(:load-toplevel load) situations)
827 (intersection '(:execute eval) situations)))
830 ;;; utilities for extracting COMPONENTs of FUNCTIONALs
831 (defun clambda-component (clambda)
832 (block-component (node-block (lambda-bind clambda))))
833 (defun functional-components (f)
834 (declare (type functional f))
836 (clambda (list (clambda-component f)))
837 (optional-dispatch (let ((result nil))
838 (labels ((frob (clambda)
839 (pushnew (clambda-component clambda)
841 (maybe-frob (maybe-clambda)
843 (frob maybe-clambda))))
844 (mapc #'frob (optional-dispatch-entry-points f))
845 (maybe-frob (optional-dispatch-more-entry f))
846 (maybe-frob (optional-dispatch-main-entry f)))))))
848 (defun make-functional-from-top-level-lambda (definition
852 ;; I'd thought NIL should
853 ;; work, but it doesn't.
856 (let* ((*current-path* path)
857 (component (make-empty-component))
858 (*current-component* component))
859 (setf (component-name component)
860 (format nil "~S initial component" name))
861 (setf (component-kind component) :initial)
862 (let* ((locall-fun (ir1-convert-lambda definition
863 (format nil "locall ~S" name)))
864 (fun (ir1-convert-lambda (make-xep-lambda locall-fun) name)))
865 (setf (functional-entry-function fun) locall-fun
866 (functional-kind fun) :external
867 (functional-has-external-references-p fun) t)
870 ;;; Compile LAMBDA-EXPRESSION into *COMPILE-OBJECT*, returning a
871 ;;; description of the result.
872 ;;; * If *COMPILE-OBJECT* is a CORE-OBJECT, then write the function
873 ;;; into core and return the compiled FUNCTION value.
874 ;;; * If *COMPILE-OBJECT* is a fasl file, then write the function
875 ;;; into the fasl file and return a dump handle.
877 ;;; If NAME is provided, then we try to use it as the name of the
878 ;;; function for debugging/diagnostic information.
879 (defun %compile (lambda-expression
884 ;; This magical idiom seems to be the appropriate
885 ;; path for compiling standalone LAMBDAs, judging
886 ;; from the CMU CL code and experiment, so it's a
887 ;; nice default for things where we don't have a
888 ;; real source path (as in e.g. inside CL:COMPILE).
889 '(original-source-start 0 0)))
890 (unless (or (null name) (legal-fun-name-p name))
891 (error "not a legal function name: ~S" name))
892 (let* ((*lexenv* (make-lexenv :policy *policy*))
893 (fun (make-functional-from-top-level-lambda lambda-expression
897 ;; FIXME: The compile-it code from here on is sort of a
898 ;; twisted version of the code in COMPILE-TOP-LEVEL. It'd be
899 ;; better to find a way to share the code there; or
900 ;; alternatively, to use this code to replace the code there.
901 ;; (The second alternative might be pretty easy if we used
902 ;; the :LOCALL-ONLY option to IR1-FOR-LAMBDA. Then maybe the
903 ;; whole FUNCTIONAL-KIND=:TOP-LEVEL case could go away..)
905 (local-call-analyze-until-done (list fun))
907 (multiple-value-bind (components-from-dfo top-components hairy-top)
908 (find-initial-dfo (list fun))
910 (let ((*all-components* (append components-from-dfo top-components)))
911 (mapc #'preallocate-physenvs-for-top-levelish-lambdas
912 (append hairy-top top-components))
913 (dolist (component-from-dfo components-from-dfo)
914 (compile-component component-from-dfo)
915 (replace-top-level-xeps component-from-dfo)))
918 (let ((entry-table (etypecase *compile-object*
919 (fasl-output (fasl-output-entry-table
921 (core-object (core-object-entry-table
922 *compile-object*)))))
923 (multiple-value-bind (result found-p)
924 (gethash (leaf-info fun) entry-table)
927 (mapc #'clear-ir1-info components-from-dfo)
930 (defun process-top-level-cold-fset (name lambda-expression path)
931 (unless (producing-fasl-file)
932 (error "can't COLD-FSET except in a fasl file"))
933 (unless (legal-fun-name-p name)
934 (error "not a legal function name: ~S" name))
935 (fasl-dump-cold-fset name
936 (%compile lambda-expression
943 ;;; Process a top-level FORM with the specified source PATH.
944 ;;; * If this is a magic top-level form, then do stuff.
945 ;;; * If this is a macro, then expand it.
946 ;;; * Otherwise, just compile it.
948 ;;; COMPILE-TIME-TOO is as defined in ANSI
949 ;;; "3.2.3.1 Processing of Top Level Forms".
950 (defun process-top-level-form (form path compile-time-too)
952 (declare (list path))
954 (catch 'process-top-level-form-error-abort
955 (let* ((path (or (gethash form *source-paths*) (cons form path)))
956 (*compiler-error-bailout*
958 (convert-and-maybe-compile
959 `(error "execution of a form compiled with errors:~% ~S"
962 (throw 'process-top-level-form-error-abort nil))))
965 ;; (There are no EVAL-WHEN issues in the ATOM case until
966 ;; SBCL gets smart enough to handle global
967 ;; DEFINE-SYMBOL-MACRO.)
968 (convert-and-maybe-compile form path)
969 (flet ((need-at-least-one-arg (form)
971 (compiler-error "~S form is too short: ~S"
975 ;; In the cross-compiler, top level COLD-FSET arranges
976 ;; for static linking at cold init time.
979 (aver (not compile-time-too))
980 (destructuring-bind (cold-fset fun-name lambda-expression) form
981 (declare (ignore cold-fset))
982 (process-top-level-cold-fset fun-name
985 ((eval-when macrolet symbol-macrolet);things w/ 1 arg before body
986 (need-at-least-one-arg form)
987 (destructuring-bind (special-operator magic &rest body) form
988 (ecase special-operator
990 ;; CT, LT, and E here are as in Figure 3-7 of ANSI
991 ;; "3.2.3.1 Processing of Top Level Forms".
992 (multiple-value-bind (ct lt e)
993 (parse-eval-when-situations magic)
994 (let ((new-compile-time-too (or ct
995 (and compile-time-too
997 (cond (lt (process-top-level-progn
998 body path new-compile-time-too))
999 (new-compile-time-too (eval
1000 `(progn ,@body)))))))
1002 (funcall-in-macrolet-lexenv
1005 (process-top-level-locally body
1007 compile-time-too))))
1009 (funcall-in-symbol-macrolet-lexenv
1012 (process-top-level-locally body
1014 compile-time-too)))))))
1016 (process-top-level-locally (rest form) path compile-time-too))
1018 (process-top-level-progn (rest form) path compile-time-too))
1019 ;; When we're cross-compiling, consider: what should we
1020 ;; do when we hit e.g.
1021 ;; (EVAL-WHEN (:COMPILE-TOPLEVEL)
1022 ;; (DEFUN FOO (X) (+ 7 X)))?
1023 ;; DEFUN has a macro definition in the cross-compiler,
1024 ;; and a different macro definition in the target
1025 ;; compiler. The only sensible thing is to use the
1026 ;; target compiler's macro definition, since the
1027 ;; cross-compiler's macro is in general into target
1028 ;; functions which can't meaningfully be executed at
1029 ;; cross-compilation time. So make sure we do the EVAL
1030 ;; here, before we macroexpand.
1032 ;; Then things get even dicier with something like
1033 ;; (DEFCONSTANT-EQX SB!XC:LAMBDA-LIST-KEYWORDS ..)
1034 ;; where we have to make sure that we don't uncross
1035 ;; the SB!XC: prefix before we do EVAL, because otherwise
1036 ;; we'd be trying to redefine the cross-compilation host's
1039 ;; (Isn't it fun to cross-compile Common Lisp?:-)
1042 (when compile-time-too
1043 (eval form)) ; letting xc host EVAL do its own macroexpansion
1044 (let* (;; (We uncross the operator name because things
1045 ;; like SB!XC:DEFCONSTANT and SB!XC:DEFTYPE
1046 ;; should be equivalent to their CL: counterparts
1047 ;; when being compiled as target code. We leave
1048 ;; the rest of the form uncrossed because macros
1049 ;; might yet expand into EVAL-WHEN stuff, and
1050 ;; things inside EVAL-WHEN can't be uncrossed
1051 ;; until after we've EVALed them in the
1052 ;; cross-compilation host.)
1053 (slightly-uncrossed (cons (uncross (first form))
1055 (expanded (preprocessor-macroexpand-1 slightly-uncrossed)))
1056 (if (eq expanded slightly-uncrossed)
1057 ;; (Now that we're no longer processing toplevel
1058 ;; forms, and hence no longer need to worry about
1059 ;; EVAL-WHEN, we can uncross everything.)
1060 (convert-and-maybe-compile expanded path)
1061 ;; (We have to demote COMPILE-TIME-TOO to NIL
1062 ;; here, no matter what it was before, since
1063 ;; otherwise we'd tend to EVAL subforms more than
1064 ;; once, because of WHEN COMPILE-TIME-TOO form
1066 (process-top-level-form expanded path nil))))
1067 ;; When we're not cross-compiling, we only need to
1068 ;; macroexpand once, so we can follow the 1-thru-6
1069 ;; sequence of steps in ANSI's "3.2.3.1 Processing of
1070 ;; Top Level Forms".
1073 (let ((expanded (preprocessor-macroexpand-1 form)))
1074 (cond ((eq expanded form)
1075 (when compile-time-too
1077 (convert-and-maybe-compile form path))
1079 (process-top-level-form expanded
1081 compile-time-too))))))))))
1085 ;;;; load time value support
1087 ;;;; (See EMIT-MAKE-LOAD-FORM.)
1089 ;;; Return T if we are currently producing a fasl file and hence
1090 ;;; constants need to be dumped carefully.
1091 (defun producing-fasl-file ()
1092 (fasl-output-p *compile-object*))
1094 ;;; Compile FORM and arrange for it to be called at load-time. Return
1095 ;;; the dumper handle and our best guess at the type of the object.
1096 (defun compile-load-time-value
1098 (name (let ((*print-level* 2) (*print-length* 3))
1099 (format nil "load time value of ~S"
1100 (if (and (listp form)
1101 (eq (car form) 'make-value-cell))
1104 (let ((lambda (compile-load-time-stuff form name t)))
1106 (fasl-dump-load-time-value-lambda lambda *compile-object*)
1107 (let ((type (leaf-type lambda)))
1108 (if (fun-type-p type)
1109 (single-value-type (fun-type-returns type))
1112 ;;; Compile the FORMS and arrange for them to be called (for effect,
1113 ;;; not value) at load time.
1114 (defun compile-make-load-form-init-forms (forms name)
1115 (let ((lambda (compile-load-time-stuff `(progn ,@forms) name nil)))
1116 (fasl-dump-top-level-lambda-call lambda *compile-object*)))
1118 ;;; Does the actual work of COMPILE-LOAD-TIME-VALUE or
1119 ;;; COMPILE-MAKE-LOAD-FORM- INIT-FORMS.
1120 (defun compile-load-time-stuff (form name for-value)
1122 (let* ((*lexenv* (make-null-lexenv))
1123 (lambda (ir1-top-level form *current-path* for-value)))
1124 (setf (leaf-name lambda) name)
1125 (compile-top-level (list lambda) t)
1128 ;;; This is called by COMPILE-TOP-LEVEL when it was passed T for
1129 ;;; LOAD-TIME-VALUE-P (which happens in COMPILE-LOAD-TIME-STUFF). We
1130 ;;; don't try to combine this component with anything else and frob
1131 ;;; the name. If not in a :TOP-LEVEL component, then don't bother
1132 ;;; compiling, because it was merged with a run-time component.
1133 (defun compile-load-time-value-lambda (lambdas)
1134 (aver (null (cdr lambdas)))
1135 (let* ((lambda (car lambdas))
1136 (component (block-component (node-block (lambda-bind lambda)))))
1137 (when (eql (component-kind component) :top-level)
1138 (setf (component-name component) (leaf-name lambda))
1139 (compile-component component)
1140 (clear-ir1-info component))))
1144 ;;; We build a list of top-level lambdas, and then periodically smash
1145 ;;; them together into a single component and compile it.
1146 (defvar *pending-top-level-lambdas*)
1148 ;;; The maximum number of top-level lambdas we put in a single
1149 ;;; top-level component.
1151 ;;; CMU CL 18b used this nontrivially by default (setting it to 10)
1152 ;;; but consequently suffered from the inability to execute some
1153 ;;; troublesome constructs correctly, e.g. inability to load a fasl
1154 ;;; file compiled from the source file
1155 ;;; (defpackage "FOO" (:use "CL"))
1156 ;;; (print 'foo::bar)
1157 ;;; because it would dump data-setup fops (including a FOP-PACKAGE for
1158 ;;; "FOO") for the second form before dumping the the code in the
1159 ;;; first form, or the fop to execute the code in the first form. By
1160 ;;; setting this value to 0 by default, we avoid this badness. This
1161 ;;; increases the number of toplevel form functions, and so increases
1162 ;;; the size of object files.
1164 ;;; The variable is still supported because when we are compiling the
1165 ;;; SBCL system itself, which is known not contain any troublesome
1166 ;;; constructs, we can set it to a nonzero value, which reduces the
1167 ;;; number of toplevel form objects, reducing the peak memory usage in
1168 ;;; GENESIS, which is desirable, since at least for SBCL version
1169 ;;; 0.6.7, this is the high water mark for memory usage during system
1171 (defparameter *top-level-lambda-max* 0)
1173 (defun object-call-top-level-lambda (tll)
1174 (declare (type functional tll))
1175 (let ((object *compile-object*))
1178 (fasl-dump-top-level-lambda-call tll object))
1180 (core-call-top-level-lambda tll object))
1183 ;;; Add LAMBDAS to the pending lambdas. If this leaves more than
1184 ;;; *TOP-LEVEL-LAMBDA-MAX* lambdas in the list, or if FORCE-P is true,
1185 ;;; then smash the lambdas into a single component, compile it, and
1186 ;;; call the resulting function.
1187 (defun sub-compile-top-level-lambdas (lambdas force-p)
1188 (declare (list lambdas))
1189 (setq *pending-top-level-lambdas*
1190 (append *pending-top-level-lambdas* lambdas))
1191 (let ((pending *pending-top-level-lambdas*))
1193 (or (> (length pending) *top-level-lambda-max*)
1195 (multiple-value-bind (component tll) (merge-top-level-lambdas pending)
1196 (setq *pending-top-level-lambdas* ())
1197 (compile-component component)
1198 (clear-ir1-info component)
1199 (object-call-top-level-lambda tll))))
1202 ;;; Compile top-level code and call the top-level lambdas. We pick off
1203 ;;; top-level lambdas in non-top-level components here, calling
1204 ;;; SUB-c-t-l-l on each subsequence of normal top-level lambdas.
1205 (defun compile-top-level-lambdas (lambdas force-p)
1206 (declare (list lambdas))
1207 (let ((len (length lambdas)))
1208 (flet ((loser (start)
1209 (or (position-if (lambda (x)
1210 (not (eq (component-kind
1218 (do* ((start 0 (1+ loser))
1219 (loser (loser start) (loser start)))
1222 (sub-compile-top-level-lambdas nil t)))
1223 (sub-compile-top-level-lambdas (subseq lambdas start loser)
1224 (or force-p (/= loser len)))
1225 (unless (= loser len)
1226 (object-call-top-level-lambda (elt lambdas loser))))))
1229 ;;; Compile LAMBDAS (a list of CLAMBDAs for top-level forms) into the
1232 ;;; LOAD-TIME-VALUE-P seems to control whether it's MAKE-LOAD-FORM and
1233 ;;; COMPILE-LOAD-TIME-VALUE stuff. -- WHN 20000201
1234 (defun compile-top-level (lambdas load-time-value-p)
1235 (declare (list lambdas))
1237 (maybe-mumble "locall ")
1238 (local-call-analyze-until-done lambdas)
1240 (maybe-mumble "IDFO ")
1241 (multiple-value-bind (components top-components hairy-top)
1242 (find-initial-dfo lambdas)
1243 (let ((*all-components* (append components top-components))
1244 (top-level-closure nil))
1245 (when *check-consistency*
1246 (maybe-mumble "[check]~%")
1247 (check-ir1-consistency *all-components*))
1249 (dolist (component (append hairy-top top-components))
1250 (when (pre-physenv-analyze-top-level component)
1251 (setq top-level-closure t)))
1253 (dolist (component components)
1254 (compile-component component)
1255 (when (replace-top-level-xeps component)
1256 (setq top-level-closure t)))
1258 (when *check-consistency*
1259 (maybe-mumble "[check]~%")
1260 (check-ir1-consistency *all-components*))
1262 (if load-time-value-p
1263 (compile-load-time-value-lambda lambdas)
1264 (compile-top-level-lambdas lambdas top-level-closure))
1266 (mapc #'clear-ir1-info components)
1270 ;;; Actually compile any stuff that has been queued up for block
1272 (defun finish-block-compilation ()
1273 (when *block-compile*
1274 (when *top-level-lambdas*
1275 (compile-top-level (nreverse *top-level-lambdas*) nil)
1276 (setq *top-level-lambdas* ()))
1277 (setq *block-compile* nil)
1278 (setq *entry-points* nil)))
1280 ;;; Read all forms from INFO and compile them, with output to OBJECT.
1281 ;;; Return (VALUES NIL WARNINGS-P FAILURE-P).
1282 (defun sub-compile-file (info)
1283 (declare (type source-info info))
1284 (let* ((*block-compile* *block-compile-argument*)
1285 (*package* (sane-package))
1287 (*lexenv* (make-null-lexenv))
1288 (*source-info* info)
1289 (sb!xc:*compile-file-pathname* nil)
1290 (sb!xc:*compile-file-truename* nil)
1291 (*top-level-lambdas* ())
1292 (*pending-top-level-lambdas* ())
1293 (*compiler-error-bailout*
1295 (compiler-mumble "~2&; fatal error, aborting compilation~%")
1296 (return-from sub-compile-file (values nil t t))))
1297 (*current-path* nil)
1298 (*last-source-context* nil)
1299 (*last-original-source* nil)
1300 (*last-source-form* nil)
1301 (*last-format-string* nil)
1302 (*last-format-args* nil)
1303 (*last-message-count* 0)
1304 ;; FIXME: Do we need this rebinding here? It's a literal
1305 ;; translation of the old CMU CL rebinding to
1306 ;; (OR *BACKEND-INFO-ENVIRONMENT* *INFO-ENVIRONMENT*),
1307 ;; and it's not obvious whether the rebinding to itself is
1308 ;; needed that SBCL doesn't need *BACKEND-INFO-ENVIRONMENT*.
1309 (*info-environment* *info-environment*)
1310 (*gensym-counter* 0))
1312 (with-compilation-values
1313 (sb!xc:with-compilation-unit ()
1316 (sub-sub-compile-file info)
1318 (finish-block-compilation)
1319 (compile-top-level-lambdas () t)
1320 (let ((object *compile-object*))
1322 (fasl-output (fasl-dump-source-info info object))
1323 (core-object (fix-core-source-info info object))
1326 ;; Some errors are sufficiently bewildering that we just fail
1327 ;; immediately, without trying to recover and compile more of
1329 (input-error-in-compile-file (condition)
1330 (format *error-output*
1331 "~@<compilation aborted because of input error: ~2I~_~A~:>"
1333 (values nil t t)))))
1335 ;;; Return a pathname for the named file. The file must exist.
1336 (defun verify-source-file (pathname-designator)
1337 (let* ((pathname (pathname pathname-designator))
1338 (default-host (make-pathname :host (pathname-host pathname))))
1339 (flet ((try-with-type (path type error-p)
1340 (let ((new (merge-pathnames
1341 path (make-pathname :type type
1342 :defaults default-host))))
1343 (if (probe-file new)
1345 (and error-p (truename new))))))
1346 (cond ((typep pathname 'logical-pathname)
1347 (try-with-type pathname "LISP" t))
1348 ((probe-file pathname) pathname)
1349 ((try-with-type pathname "lisp" nil))
1350 ((try-with-type pathname "lisp" t))))))
1352 (defun elapsed-time-to-string (tsec)
1353 (multiple-value-bind (tmin sec) (truncate tsec 60)
1354 (multiple-value-bind (thr min) (truncate tmin 60)
1355 (format nil "~D:~2,'0D:~2,'0D" thr min sec))))
1357 ;;; Print some junk at the beginning and end of compilation.
1358 (defun start-error-output (source-info)
1359 (declare (type source-info source-info))
1360 (let ((file-info (source-info-file-info source-info)))
1361 (compiler-mumble "~&; compiling file ~S (written ~A):~%"
1362 (namestring (file-info-name file-info))
1363 (sb!int:format-universal-time nil
1364 (file-info-write-date
1368 :print-timezone nil)))
1370 (defun finish-error-output (source-info won)
1371 (declare (type source-info source-info))
1372 (compiler-mumble "~&; compilation ~:[aborted after~;finished in~] ~A~&"
1374 (elapsed-time-to-string
1375 (- (get-universal-time)
1376 (source-info-start-time source-info))))
1379 ;;; Open some files and call SUB-COMPILE-FILE. If something unwinds
1380 ;;; out of the compile, then abort the writing of the output file, so
1381 ;;; that we don't overwrite it with known garbage.
1382 (defun sb!xc:compile-file
1387 (output-file (cfp-output-file-default input-file))
1388 ;; FIXME: ANSI doesn't seem to say anything about
1389 ;; *COMPILE-VERBOSE* and *COMPILE-PRINT* being rebound by this
1391 ((:verbose sb!xc:*compile-verbose*) sb!xc:*compile-verbose*)
1392 ((:print sb!xc:*compile-print*) sb!xc:*compile-print*)
1393 (external-format :default)
1397 ((:block-compile *block-compile-argument*) nil))
1400 "Compile INPUT-FILE, producing a corresponding fasl file and returning
1401 its filename. Besides the ANSI &KEY arguments :OUTPUT-FILE, :VERBOSE,
1402 :PRINT, and :EXTERNAL-FORMAT,the following extensions are supported:
1404 If given, internal data structures are dumped to the specified
1405 file, or if a value of T is given, to a file of *.trace type
1406 derived from the input file name.
1407 Also, as a workaround for vaguely-non-ANSI behavior, the :BLOCK-COMPILE
1408 argument is quasi-supported, to determine whether multiple
1409 functions are compiled together as a unit, resolving function
1410 references at compile time. NIL means that global function names
1411 are never resolved at compilation time. Currently NIL is the
1412 default behavior, because although section 3.2.2.3, \"Semantic
1413 Constraints\", of the ANSI spec allows this behavior under all
1414 circumstances, the compiler's runtime scales badly when it
1415 tries to do this for large files. If/when this performance
1416 problem is fixed, the block compilation default behavior will
1417 probably be made dependent on the SPEED and COMPILATION-SPEED
1418 optimization values, and the :BLOCK-COMPILE argument will probably
1421 (unless (eq external-format :default)
1422 (error "Non-:DEFAULT EXTERNAL-FORMAT values are not supported."))
1423 (let* ((fasl-output nil)
1424 (output-file-name nil)
1427 (failure-p t) ; T in case error keeps this from being set later
1428 (input-pathname (verify-source-file input-file))
1429 (source-info (make-file-source-info input-pathname))
1430 (*compiler-trace-output* nil)) ; might be modified below
1435 (setq output-file-name
1436 (sb!xc:compile-file-pathname input-file
1437 :output-file output-file))
1439 (open-fasl-output output-file-name
1440 (namestring input-pathname))))
1442 (let* ((default-trace-file-pathname
1443 (make-pathname :type "trace" :defaults input-pathname))
1444 (trace-file-pathname
1445 (if (eql trace-file t)
1446 default-trace-file-pathname
1447 (merge-pathnames trace-file
1448 default-trace-file-pathname))))
1449 (setf *compiler-trace-output*
1450 (open trace-file-pathname
1451 :if-exists :supersede
1452 :direction :output))))
1454 (when sb!xc:*compile-verbose*
1455 (start-error-output source-info))
1456 (let ((*compile-object* fasl-output)
1458 (multiple-value-setq (dummy warnings-p failure-p)
1459 (sub-compile-file source-info)))
1460 (setq compile-won t))
1462 (close-source-info source-info)
1465 (close-fasl-output fasl-output (not compile-won))
1466 (setq output-file-name
1467 (pathname (fasl-output-stream fasl-output)))
1468 (when (and compile-won sb!xc:*compile-verbose*)
1469 (compiler-mumble "~2&; ~A written~%" (namestring output-file-name))))
1471 (when sb!xc:*compile-verbose*
1472 (finish-error-output source-info compile-won))
1474 (when *compiler-trace-output*
1475 (close *compiler-trace-output*)))
1477 (values (if output-file
1478 ;; Hack around filesystem race condition...
1479 (or (probe-file output-file-name) output-file-name)
1484 ;;; a helper function for COMPILE-FILE-PATHNAME: the default for
1485 ;;; the OUTPUT-FILE argument
1487 ;;; ANSI: The defaults for the OUTPUT-FILE are taken from the pathname
1488 ;;; that results from merging the INPUT-FILE with the value of
1489 ;;; *DEFAULT-PATHNAME-DEFAULTS*, except that the type component should
1490 ;;; default to the appropriate implementation-defined default type for
1492 (defun cfp-output-file-default (input-file)
1493 (let* ((defaults (merge-pathnames input-file *default-pathname-defaults*))
1494 (retyped (make-pathname :type *fasl-file-type* :defaults defaults)))
1497 ;;; KLUDGE: Part of the ANSI spec for this seems contradictory:
1498 ;;; If INPUT-FILE is a logical pathname and OUTPUT-FILE is unsupplied,
1499 ;;; the result is a logical pathname. If INPUT-FILE is a logical
1500 ;;; pathname, it is translated into a physical pathname as if by
1501 ;;; calling TRANSLATE-LOGICAL-PATHNAME.
1502 ;;; So I haven't really tried to make this precisely ANSI-compatible
1503 ;;; at the level of e.g. whether it returns logical pathname or a
1504 ;;; physical pathname. Patches to make it more correct are welcome.
1505 ;;; -- WHN 2000-12-09
1506 (defun sb!xc:compile-file-pathname (input-file
1508 (output-file (cfp-output-file-default
1512 "Return a pathname describing what file COMPILE-FILE would write to given
1514 (pathname output-file))
1516 ;;;; MAKE-LOAD-FORM stuff
1518 ;;; The entry point for MAKE-LOAD-FORM support. When IR1 conversion
1519 ;;; finds a constant structure, it invokes this to arrange for proper
1520 ;;; dumping. If it turns out that the constant has already been
1521 ;;; dumped, then we don't need to do anything.
1523 ;;; If the constant hasn't been dumped, then we check to see whether
1524 ;;; we are in the process of creating it. We detect this by
1525 ;;; maintaining the special *CONSTANTS-BEING-CREATED* as a list of all
1526 ;;; the constants we are in the process of creating. Actually, each
1527 ;;; entry is a list of the constant and any init forms that need to be
1528 ;;; processed on behalf of that constant.
1530 ;;; It's not necessarily an error for this to happen. If we are
1531 ;;; processing the init form for some object that showed up *after*
1532 ;;; the original reference to this constant, then we just need to
1533 ;;; defer the processing of that init form. To detect this, we
1534 ;;; maintain *CONSTANTS-CREATED-SINCE-LAST-INIT* as a list of the
1535 ;;; constants created since the last time we started processing an
1536 ;;; init form. If the constant passed to emit-make-load-form shows up
1537 ;;; in this list, then there is a circular chain through creation
1538 ;;; forms, which is an error.
1540 ;;; If there is some intervening init form, then we blow out of
1541 ;;; processing it by throwing to the tag PENDING-INIT. The value we
1542 ;;; throw is the entry from *CONSTANTS-BEING-CREATED*. This is so the
1543 ;;; offending init form can be tacked onto the init forms for the
1544 ;;; circular object.
1546 ;;; If the constant doesn't show up in *CONSTANTS-BEING-CREATED*, then
1547 ;;; we have to create it. We call MAKE-LOAD-FORM and check to see
1548 ;;; whether the creation form is the magic value
1549 ;;; :JUST-DUMP-IT-NORMALLY. If it is, then we don't do anything. The
1550 ;;; dumper will eventually get its hands on the object and use the
1551 ;;; normal structure dumping noise on it.
1553 ;;; Otherwise, we bind *CONSTANTS-BEING-CREATED* and
1554 ;;; *CONSTANTS-CREATED-SINCE- LAST-INIT* and compile the creation form
1555 ;;; much the way LOAD-TIME-VALUE does. When this finishes, we tell the
1556 ;;; dumper to use that result instead whenever it sees this constant.
1558 ;;; Now we try to compile the init form. We bind
1559 ;;; *CONSTANTS-CREATED-SINCE-LAST-INIT* to NIL and compile the init
1560 ;;; form (and any init forms that were added because of circularity
1561 ;;; detection). If this works, great. If not, we add the init forms to
1562 ;;; the init forms for the object that caused the problems and let it
1564 (defvar *constants-being-created* nil)
1565 (defvar *constants-created-since-last-init* nil)
1566 ;;; FIXME: Shouldn't these^ variables be bound in LET forms?
1567 (defun emit-make-load-form (constant)
1568 (aver (fasl-output-p *compile-object*))
1569 (unless (or (fasl-constant-already-dumped-p constant *compile-object*)
1570 ;; KLUDGE: This special hack is because I was too lazy
1571 ;; to rework DEF!STRUCT so that the MAKE-LOAD-FORM
1572 ;; function of LAYOUT returns nontrivial forms when
1573 ;; building the cross-compiler but :IGNORE-IT when
1574 ;; cross-compiling or running under the target Lisp. --
1576 #+sb-xc-host (typep constant 'layout))
1577 (let ((circular-ref (assoc constant *constants-being-created* :test #'eq)))
1579 (when (find constant *constants-created-since-last-init* :test #'eq)
1581 (throw 'pending-init circular-ref)))
1582 (multiple-value-bind (creation-form init-form)
1584 (sb!xc:make-load-form constant (make-null-lexenv))
1586 (compiler-error "(while making load form for ~S)~%~A"
1590 (:just-dump-it-normally
1591 (fasl-validate-structure constant *compile-object*)
1596 (compile-top-level-lambdas () t)
1597 (when (fasl-constant-already-dumped-p constant *compile-object*)
1598 (return-from emit-make-load-form nil))
1599 (let* ((name (let ((*print-level* 1) (*print-length* 2))
1600 (with-output-to-string (stream)
1601 (write constant :stream stream))))
1603 (list constant name init-form)
1605 (let ((*constants-being-created*
1606 (cons info *constants-being-created*))
1607 (*constants-created-since-last-init*
1608 (cons constant *constants-created-since-last-init*)))
1611 (fasl-note-handle-for-constant
1613 (compile-load-time-value
1615 (format nil "creation form for ~A" name))
1618 (compiler-error "circular references in creation form for ~S"
1621 (let* ((*constants-created-since-last-init* nil)
1623 (catch 'pending-init
1624 (loop for (name form) on (cdr info) by #'cddr
1625 collect name into names
1626 collect form into forms
1628 (compile-make-load-form-init-forms
1630 (format nil "init form~:[~;s~] for ~{~A~^, ~}"
1631 (cdr forms) names)))
1634 (setf (cdr circular-ref)
1635 (append (cdr circular-ref) (cdr info))))))))))))