| blob | 759f06e4a076a280eeb36c53bd07bcd511b32d17 |
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
6 ;;;; more information.
7 ;;;;
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?
35 ;;; Whether reference to a thing which cannot be defined causes a full
36 ;;; warning.
41 ;;; Set to NIL to disable loop analysis for register allocation.
44 ;;; Bind this to a stream to capture various internal debugging output.
47 ;;; The current block compilation state. These are initialized to the
48 ;;; :BLOCK-COMPILE and :ENTRY-POINTS arguments that COMPILE-FILE was
49 ;;; called with.
50 ;;;
51 ;;; *BLOCK-COMPILE-ARG* holds the original value of the :BLOCK-COMPILE
52 ;;; argument, which overrides any internal declarations.
59 ;;; When block compiling, used by PROCESS-FORM to accumulate top level
60 ;;; lambdas resulting from compiling subforms. (In reverse order.)
64 ;;; The current non-macroexpanded toplevel form as printed when
65 ;;; *compile-print* is true.
69 #!+sb-doc
72 #!+sb-doc
75 #!+sb-doc
76 "When this is true, the compiler prints to *STANDARD-OUTPUT* progress
77 information about the phases of compilation of each function. (This
81 #!+sb-doc
82 "The defaulted pathname of the file currently being compiled, or NIL if not
85 #!+sb-doc
86 "The TRUENAME of the file currently being compiled, or NIL if not
93 ;;; the SOURCE-INFO structure for the current compilation. This is
94 ;;; null globally to indicate that we aren't currently in any
95 ;;; identifiable compilation.
98 ;;; This is true if we are within a WITH-COMPILATION-UNIT form (which
99 ;;; normally causes nested uses to be no-ops).
102 ;;; Count of the number of compilation units dynamically enclosed by
103 ;;; the current active WITH-COMPILATION-UNIT that were unwound out of.
106 ;;; Mumble conditional on *COMPILE-PROGRESS*.
120 ;; Used during compilation to map code paths to the matching
121 ;; instrumentation conses.
123 ;; Used during compilation to keep track of with source paths have been
124 ;; instrumented in which blocks.
126 ;; Stores the code coverage instrumentation results. Keys are namestrings,
127 ;; the value is a list of (CONS PATH STATE), where STATE is NIL for
128 ;; a path that has not been visited, and T for one that has.
131 \f
132 ;;;; WITH-COMPILATION-UNIT and WITH-COMPILATION-VALUES
135 #!+sb-doc
136 "WITH-COMPILATION-UNIT ({Key Value}*) Form*
137 This form affects compilations that take place within its dynamic extent. It
138 is intended to be wrapped around the compilation of all files in the same
139 system. These keywords are defined:
141 :OVERRIDE Boolean-Form
142 One of the effects of this form is to delay undefined warnings
143 until the end of the form, instead of giving them at the end of each
144 compilation. If OVERRIDE is NIL (the default), then the outermost
145 WITH-COMPILATION-UNIT form grabs the undefined warnings. Specifying
146 OVERRIDE true causes that form to grab any enclosed warnings, even if
147 it is enclosed by another WITH-COMPILATION-UNIT.
149 :SOURCE-PLIST Plist-Form
150 Attaches the value returned by the Plist-Form to internal debug-source
151 information of functions compiled in within the dynamic contour.
152 Primarily for use by development environments, in order to eg. associate
153 function definitions with editor-buffers. Can be accessed as
154 SB-INTROSPECT:DEFINITION-SOURCE-PLIST. If multiple, nested
155 WITH-COMPILATION-UNITs provide :SOURCE-PLISTs, they are appended
156 togather, innermost left. If Unaffected by :OVERRIDE."
166 ;; Inside another WITH-COMPILATION-UNIT, a WITH-COMPILATION-UNIT is
167 ;; ordinarily (unless OVERRIDE) basically a no-op.
191 ;;; Is NAME something that no conforming program can rely on
192 ;;; defining?
195 (:function
198 (:type
205 ;;; This is to be called at the end of a compilation unit. It signals
206 ;;; any residual warnings about unknown stuff, then prints the total
207 ;;; error counts. ABORT-P should be true when the compilation unit was
208 ;;; aborted by throwing out. ABORT-COUNT is the number of dynamically
209 ;;; enclosed nested compilation units that were aborted.
236 #+sb-xc-host nil
238 (:function
242 "~@<There is no function named ~S. References to ~S ~
243 in some contexts (like starts of blocks) have ~
244 special meaning, but here it would have to be a ~
245 function, and that shouldn't be right.~:@>" name
246 name))
249 "~@<The function ~S is undefined, and its name is ~
250 reserved by ANSI CL so that even if it were ~
251 defined later, the code doing so would not be ~
253 (:type
256 "~@<Undefined type ~S. The name starts with ~S: ~
257 probably use of a quoted type name in a context ~
258 where the name is not evaluated.~:@>"
261 "~@<Undefined type ~S. Note that name ~S is ~
262 reserved by ANSI CL, so code defining a type with ~
263 that name would not be portable.~:@>" name
264 name))))
273 "~W more use~:P of undefined ~(~A~) ~S"
274 more kind name)
276 "~W more use~:P of undefined ~(~A~) ~S"
277 more kind name))))))))))
287 abort-p)
291 "~& Undefined ~(~A~)~p:~
292 ~% ~{~<~% ~1:;~S~>~^ ~}"
295 ~[~:;~:*~& caught ~W ERROR condition~:P~]~
296 ~[~:;~:*~& caught ~W WARNING condition~:P~]~
297 ~[~:;~:*~& caught ~W STYLE-WARNING condition~:P~]~
298 ~[~:;~:*~& printed ~W note~:P~]"
307 ;;; Evaluate BODY, then return (VALUES BODY-VALUE WARNINGS-P
308 ;;; FAILURE-P), where BODY-VALUE is the first value of the body, and
309 ;;; WARNINGS-P and FAILURE-P are as in CL:COMPILE or CL:COMPILE-FILE.
310 ;;; This also wraps up WITH-IR1-NAMESPACE functionality.
318 \f
319 ;;;; component compilation
322 #!+sb-doc
323 "The upper limit on the number of times that we will consecutively do IR1
324 optimization that doesn't introduce any new code. A finite limit is
330 ;;; Repeatedly optimize COMPONENT until no further optimizations can
331 ;;; be found or we hit our iteration limit. When we hit the limit, we
332 ;;; clear the component and block REOPTIMIZE flags to discourage the
333 ;;; next optimization attempt from pounding on the same code.
377 ;;; KLUDGE: This was bumped from 5 to 10 in a DTC patch ported by MNA
378 ;;; from CMU CL into sbcl-0.6.11.44, the same one which allowed IR1
379 ;;; transforms to be delayed. Either DTC or MNA or both didn't explain
380 ;;; why, and I don't know what the rationale was. -- WHN 2001-04-28
381 ;;;
382 ;;; FIXME: It would be good to document why it's important to have a
383 ;;; large value here, and what the drawbacks of an excessively large
384 ;;; value are; and it might also be good to make it depend on
385 ;;; optimization policy.
391 ;;; Iterate doing FIND-DFO until no new dead code is discovered.
404 ;;; Do all the IR1 phases for a non-top-level component.
409 ;make this 0.
432 ;; We delay the generation of type checks until
433 ;; the type constraints have had time to
434 ;; propagate, else the compiler can confuse itself.
464 ;; Assign BLOCK-NUMBER for any cleanup blocks introduced by
465 ;; stack analysis. There shouldn't be any unreachable code after
466 ;; control, so this won't delete anything.
516 #-sb-xc-host
528 code-length
529 trace-table
530 fixup-notes
536 code-length
537 trace-table
538 fixup-notes
542 ;; We're done, so don't bother keeping anything around.
547 ;;; Delete components with no external entry points before we try to
548 ;;; generate code. Unreachable closures can cause IR2 conversion to
549 ;;; puke on itself, since it is the reference to the closure which
550 ;;; normally causes the components to be combined.
557 (:external
565 ;; miscellaneous sanity checks
566 ;;
567 ;; FIXME: These are basically pretty wimpy compared to the checks done
568 ;; by the old CHECK-IR1-CONSISTENCY code. It would be really nice to
569 ;; make those internal consistency checks work again and use them.
574 ;; sanity check to prevent weirdness from propagating insidiously as
575 ;; far from its root cause as it did in bug 138: Make sure that
576 ;; thing-to-COMPONENT links are consistent.
582 ;; Record xref information before optimization. This way the
583 ;; stored xref data reflects the real source as closely as
584 ;; possible.
594 #|
606 |#
608 ;; FIXME: What is MAYBE-MUMBLE for? Do we need it any more?
622 \f
623 ;;;; clearing global data structures
624 ;;;;
625 ;;;; FIXME: Is it possible to get rid of this stuff, getting rid of
626 ;;;; global data structures entirely when possible and consing up the
627 ;;;; others from scratch instead of clearing and reusing them?
629 ;;; Clear the INFO in constants in the *FREE-VARS*, etc. In
630 ;;; addition to allowing stuff to be reclaimed, this is required for
631 ;;; correct assignment of constant offsets, since we need to assign a
632 ;;; new offset for each component. We don't clear the FUNCTIONAL-INFO
633 ;;; slots, since they are used to keep track of functions across
634 ;;; component boundaries.
647 ;;; Blow away the REFS for all global variables, and let COMPONENT
648 ;;; be recycled.
660 x))
668 ;;; Clear global variables used by the compiler.
669 ;;;
670 ;;; FIXME: It seems kinda nasty and unmaintainable to have to do this,
671 ;;; and it adds overhead even when people aren't using the compiler.
672 ;;; Perhaps we could make these global vars unbound except when
673 ;;; actually in use, so that this function could go away.
676 ;; Clear global tables.
682 ;; Clear debug counters and tables.
698 ;; (Note: The CMU CL code used to set CL::*GENSYM-COUNTER* to zero here.
699 ;; Superficially, this seemed harmful -- the user could reasonably be
700 ;; surprised if *GENSYM-COUNTER* turned back to zero when something was
701 ;; compiled. A closer inspection showed that this actually turned out to be
702 ;; harmless in practice, because CLEAR-STUFF was only called from within
703 ;; forms which bound CL::*GENSYM-COUNTER* to zero. However, this means that
704 ;; even though zeroing CL::*GENSYM-COUNTER* here turned out to be harmless in
705 ;; practice, it was also useless in practice. So we don't do it any more.)
708 \f
709 ;;;; trace output
711 ;;; Print out some useful info about COMPONENT to STREAM.
732 \f
733 ;;;; file reading
734 ;;;;
735 ;;;; When reading from a file, we have to keep track of some source
736 ;;;; information. We also exploit our ability to back up for printing
737 ;;;; the error context and for recovering from errors.
738 ;;;;
739 ;;;; The interface we provide to this stuff is the stream-oid
740 ;;;; SOURCE-INFO structure. The bookkeeping is done as a side effect
741 ;;;; of getting the next source form.
743 ;;; A FILE-INFO structure holds all the source information for a
744 ;;; given file.
747 #-no-ansi-print-object
751 ;; If a file, the truename of the corresponding source file. If from
752 ;; a Lisp form, :LISP. If from a stream, :STREAM.
754 ;; the external format that we'll call OPEN with, if NAME is a file.
756 ;; the defaulted, but not necessarily absolute file name (i.e. prior
757 ;; to TRUENAME call.) Null if not a file. This is used to set
758 ;; *COMPILE-FILE-PATHNAME*, and if absolute, is dumped in the
759 ;; debug-info.
761 ;; the file's write date (if relevant)
763 ;; the source path root number of the first form in this file (i.e.
764 ;; the total number of forms converted previously in this
765 ;; compilation)
767 ;; parallel vectors containing the forms read out of the file and
768 ;; the file positions that reading of each form started at (i.e. the
769 ;; end of the previous form)
773 ;;; The SOURCE-INFO structure provides a handle on all the source
774 ;;; information for an entire compilation.
776 #-no-ansi-print-object
780 ;; the UT that compilation started at
782 ;; the IRT that compilation started at
784 ;; the FILE-INFO structure for this compilation
786 ;; the stream that we are using to read the FILE-INFO, or NIL if
787 ;; no stream has been opened yet
789 ;; if the current compilation is recursive (e.g., due to EVAL-WHEN
790 ;; processing at compile-time), the invoking compilation's
791 ;; source-info.
794 ;;; Given a pathname, return a SOURCE-INFO structure.
799 :external-format external-format
802 ;;; Return a SOURCE-INFO to describe the incremental compilation of FORM.
810 ;;; Walk up the SOURCE-INFO list until we either reach a SOURCE-INFO
811 ;;; with no parent (e.g., from a REPL evaluation) or until we reach a
812 ;;; SOURCE-INFO whose FILE-INFO denotes a file.
820 finfo))))
822 ;;; Return a form read from STREAM; or for EOF use the trick,
823 ;;; popularized by Kent Pitman, of returning STREAM itself. If an
824 ;;; error happens, then convert it to standard abort-the-compilation
825 ;;; error condition (possibly recording some extra location
826 ;;; information).
832 :condition condition
833 ;; We don't need to supply :POSITION here because
834 ;; READER-ERRORs already know their position in the file.
835 ))
836 ;; ANSI, in its wisdom, says that READ should return END-OF-FILE
837 ;; (and that this is not a READER-ERROR) when it encounters end of
838 ;; file in the middle of something it's trying to read.
841 :condition condition
842 ;; We need to supply :POSITION here because the END-OF-FILE
843 ;; condition doesn't carry the position that the user
844 ;; probably cares about, where the failed READ began.
847 ;;; If STREAM is present, return it, otherwise open a stream to the
848 ;;; current file. There must be a current file.
849 ;;;
850 ;;; FIXME: This is probably an unnecessarily roundabout way to do
851 ;;; things now that we process a single file in COMPILE-FILE (unlike
852 ;;; the old CMU CL code, which accepted multiple files). Also, the old
853 ;;; comment said
854 ;;; When we open a new file, we also reset *PACKAGE* and policy.
855 ;;; This gives the effect of rebinding around each file.
856 ;;; which doesn't seem to be true now. Check to make sure that if
857 ;;; such rebinding is necessary, it's still done somewhere.
870 ;;; Close the stream in INFO if it is open.
878 ;;; Loop over FORMS retrieved from INFO. Used by COMPILE-FILE and
879 ;;; LOAD when loading from a FILE-STREAM associated with a source
880 ;;; file.
896 file-info))))
899 file-info))
903 ;;; Read and compile the source file.
910 ;;; Return the INDEX'th source form read from INFO and the position
911 ;;; where it was read.
917 \f
918 ;;;; processing of top level forms
920 ;;; This is called by top level form processing when we are ready to
921 ;;; actually compile something. If *BLOCK-COMPILE* is T, then we still
922 ;;; convert the form, but delay compilation, pushing the result on
923 ;;; *TOPLEVEL-LAMBDAS* instead.
927 ;; Don't bother to compile simple objects that just sit there.
940 nil)))))
942 ;;; Macroexpand FORM in the current environment with an error handler.
943 ;;; We only expand one level, so that we retain all the intervening
944 ;;; forms in the source path.
952 condition))))
954 ;;; Process a PROGN-like portion of a top level form. FORMS is a list of
955 ;;; the forms, and PATH is the source path of the FORM they came out of.
956 ;;; COMPILE-TIME-TOO is as in ANSI "3.2.3.1 Processing of Top Level Forms".
962 ;;; Process a top level use of LOCALLY, or anything else (e.g.
963 ;;; MACROLET) at top level which has declarations and ordinary forms.
964 ;;; We parse declarations and then recursively process the body.
970 ;; FIXME: VALUES declaration
971 ;;
972 ;; Binding *POLICY* is pretty much of a hack, since it
973 ;; causes LOCALLY to "capture" enclosed proclamations. It
974 ;; is necessary because CONVERT-AND-MAYBE-COMPILE uses the
975 ;; value of *POLICY* as the policy. The need for this hack
976 ;; is due to the quirk that there is no way to represent in
977 ;; a POLICY that an optimize quality came from the default.
978 ;;
979 ;; FIXME: Ideally, something should be done so that DECLAIM
980 ;; inside LOCALLY works OK. Failing that, at least we could
981 ;; issue a warning instead of silently screwing up.
983 ;; This is probably also a hack
985 ;; ditto
989 ;;; Parse an EVAL-WHEN situations list, returning three flags,
990 ;;; (VALUES COMPILE-TOPLEVEL LOAD-TOPLEVEL EXECUTE), indicating
991 ;;; the types of situations present in the list.
995 '(:compile-toplevel
996 compile
997 :load-toplevel
998 load
999 :execute
1000 eval)))
1005 deprecated-names)))
1007 situations)
1012 ;;; utilities for extracting COMPONENTs of FUNCTIONALs
1023 result))))
1027 result))))
1030 &key
1031 name
1033 ;; I'd thought NIL should
1034 ;; work, but it doesn't.
1035 ;; -- WHN 2001-09-20
1046 lambda-expression
1048 ;; Convert the XEP using the policy of the real
1049 ;; function. Otherwise the wrong policy will be used for
1050 ;; deciding whether to type-check the parameters of the
1051 ;; real function (via CONVERT-CALL / PROPAGATE-TO-ARGS).
1052 ;; -- JES, 2007-02-27
1056 :source-name source-name
1065 fun)))
1067 ;;; Compile LAMBDA-EXPRESSION into *COMPILE-OBJECT*, returning a
1068 ;;; description of the result.
1069 ;;; * If *COMPILE-OBJECT* is a CORE-OBJECT, then write the function
1070 ;;; into core and return the compiled FUNCTION value.
1071 ;;; * If *COMPILE-OBJECT* is a fasl file, then write the function
1072 ;;; into the fasl file and return a dump handle.
1073 ;;;
1074 ;;; If NAME is provided, then we try to use it as the name of the
1075 ;;; function for debugging/diagnostic information.
1078 &key
1079 name
1081 ;; This magical idiom seems to be the appropriate
1082 ;; path for compiling standalone LAMBDAs, judging
1083 ;; from the CMU CL code and experiment, so it's a
1084 ;; nice default for things where we don't have a
1085 ;; real source path (as in e.g. inside CL:COMPILE).
1095 :name name
1098 ;; FIXME: The compile-it code from here on is sort of a
1099 ;; twisted version of the code in COMPILE-TOPLEVEL. It'd be
1100 ;; better to find a way to share the code there; or
1101 ;; alternatively, to use this code to replace the code there.
1102 ;; (The second alternative might be pretty easy if we used
1103 ;; the :LOCALL-ONLY option to IR1-FOR-LAMBDA. Then maybe the
1104 ;; whole FUNCTIONAL-KIND=:TOPLEVEL case could go away..)
1122 result
1123 ;; KLUDGE: This code duplicates some other code in this
1124 ;; file. In the great reorganzation, the flow of program
1125 ;; logic changed from the original CMUCL model, and that
1126 ;; path (as of sbcl-0.7.5 in SUB-COMPILE-FILE) was no
1127 ;; longer followed for CORE-OBJECTS, leading to BUG
1128 ;; 156. This place is transparently not the right one for
1129 ;; this code, but I don't have a clear enough overview of
1130 ;; the compiler to know how to rearrange it all so that
1131 ;; this operation fits in nicely, and it was blocking
1132 ;; reimplementation of (DECLAIM (INLINE FOO)) (MACROLET
1133 ;; ((..)) (DEFUN FOO ...))
1134 ;;
1135 ;; FIXME: This KLUDGE doesn't solve all the problem in an
1136 ;; ideal way, as (1) definitions typed in at the REPL
1137 ;; without an INLINE declaration will give a NULL
1138 ;; FUNCTION-LAMBDA-EXPRESSION (allowable, but not ideal)
1139 ;; and (2) INLINE declarations will yield a
1140 ;; FUNCTION-LAMBDA-EXPRESSION headed by
1141 ;; SB-C:LAMBDA-WITH-LEXENV, even for null LEXENV. -- CSR,
1142 ;; 2002-07-02
1143 ;;
1144 ;; (2) is probably fairly easy to fix -- it is, after all,
1145 ;; a matter of list manipulation (or possibly of teaching
1146 ;; CL:FUNCTION about SB-C:LAMBDA-WITH-LEXENV). (1) is
1147 ;; significantly harder, as the association between
1148 ;; function object and source is a tricky one.
1149 ;;
1150 ;; FUNCTION-LAMBDA-EXPRESSION "works" (i.e. returns a
1151 ;; non-NULL list) when the function in question has been
1152 ;; compiled by (COMPILE <x> '(LAMBDA ...)); it does not
1153 ;; work when it has been compiled as part of the top-level
1154 ;; EVAL strategy of compiling everything inside (LAMBDA ()
1155 ;; ...). -- CSR, 2002-11-02
1167 (%compile lambda-expression
1169 :name name
1183 form)
1192 form)
1196 ;;; Process a top level FORM with the specified source PATH.
1197 ;;; * If this is a magic top level form, then do stuff.
1198 ;;; * If this is a macro, then expand it.
1199 ;;; * Otherwise, just compile it.
1200 ;;;
1201 ;;; COMPILE-TIME-TOO is as defined in ANSI
1202 ;;; "3.2.3.1 Processing of Top Level Forms".
1213 path)
1218 ;; When we're cross-compiling, consider: what should we
1219 ;; do when we hit e.g.
1220 ;; (EVAL-WHEN (:COMPILE-TOPLEVEL)
1221 ;; (DEFUN FOO (X) (+ 7 X)))?
1222 ;; DEFUN has a macro definition in the cross-compiler,
1223 ;; and a different macro definition in the target
1224 ;; compiler. The only sensible thing is to use the
1225 ;; target compiler's macro definition, since the
1226 ;; cross-compiler's macro is in general into target
1227 ;; functions which can't meaningfully be executed at
1228 ;; cross-compilation time. So make sure we do the EVAL
1229 ;; here, before we macroexpand.
1230 ;;
1231 ;; Then things get even dicier with something like
1232 ;; (DEFCONSTANT-EQX SB!XC:LAMBDA-LIST-KEYWORDS ..)
1233 ;; where we have to make sure that we don't uncross
1234 ;; the SB!XC: prefix before we do EVAL, because otherwise
1235 ;; we'd be trying to redefine the cross-compilation host's
1236 ;; constants.
1237 ;;
1238 ;; (Isn't it fun to cross-compile Common Lisp?:-)
1239 #+sb-xc-host
1244 ;; like SB!XC:DEFCONSTANT and SB!XC:DEFTYPE
1245 ;; should be equivalent to their CL: counterparts
1246 ;; when being compiled as target code. We leave
1247 ;; the rest of the form uncrossed because macros
1248 ;; might yet expand into EVAL-WHEN stuff, and
1249 ;; things inside EVAL-WHEN can't be uncrossed
1250 ;; until after we've EVALed them in the
1251 ;; cross-compilation host.)
1255 slightly-uncrossed)))
1257 ;; (Now that we're no longer processing toplevel
1258 ;; forms, and hence no longer need to worry about
1259 ;; EVAL-WHEN, we can uncross everything.)
1261 ;; (We have to demote COMPILE-TIME-TOO to NIL
1262 ;; here, no matter what it was before, since
1263 ;; otherwise we'd tend to EVAL subforms more than
1264 ;; once, because of WHEN COMPILE-TIME-TOO form
1265 ;; above.)
1267 ;; When we're not cross-compiling, we only need to
1268 ;; macroexpand once, so we can follow the 1-thru-6
1269 ;; sequence of steps in ANSI's "3.2.3.1 Processing of
1270 ;; Top Level Forms".
1271 #-sb-xc-host
1279 path
1280 compile-time-too)))))))
1282 #+sb-xc-host
1283 ;; (There are no xc EVAL-WHEN issues in the ATOM case until
1284 ;; (1) SBCL gets smart enough to handle global
1285 ;; DEFINE-SYMBOL-MACRO or SYMBOL-MACROLET and (2) SBCL
1286 ;; implementors start using symbol macros in a way which
1287 ;; interacts with SB-XC/CL distinction.)
1289 #-sb-xc-host
1295 form))))
1297 ;; In the cross-compiler, top level COLD-FSET arranges
1298 ;; for static linking at cold init time.
1299 #+sb-xc-host
1305 lambda-expression
1306 path)))
1312 ;; CT, LT, and E here are as in Figure 3-7 of ANSI
1313 ;; "3.2.3.1 Processing of Top Level Forms".
1318 e))))
1320 body path new-compile-time-too))
1326 magic
1331 path
1332 compile-time-too))
1336 magic
1340 path
1341 compile-time-too
1351 \f
1352 ;;;; load time value support
1353 ;;;;
1354 ;;;; (See EMIT-MAKE-LOAD-FORM.)
1356 ;;; Return T if we are currently producing a fasl file and hence
1357 ;;; constants need to be dumped carefully.
1361 ;;; Compile FORM and arrange for it to be called at load-time. Return
1362 ;;; the dumper handle and our best guess at the type of the object.
1372 ;;; Compile the FORMS and arrange for them to be called (for effect,
1373 ;;; not value) at load time.
1378 ;;; Do the actual work of COMPILE-LOAD-TIME-VALUE or
1379 ;;; COMPILE-MAKE-LOAD-FORM-INIT-FORMS.
1385 lambda)))
1387 ;;; This is called by COMPILE-TOPLEVEL when it was passed T for
1388 ;;; LOAD-TIME-VALUE-P (which happens in COMPILE-LOAD-TIME-STUFF). We
1389 ;;; don't try to combine this component with anything else and frob
1390 ;;; the name. If not in a :TOPLEVEL component, then don't bother
1391 ;;; compiling, because it was merged with a run-time component.
1400 \f
1401 ;;;; COMPILE-FILE
1411 ;;; Smash LAMBDAS into a single component, compile it, and arrange for
1412 ;;; the resulting function to be called.
1422 ;;; Compile top level code and call the top level lambdas. We pick off
1423 ;;; top level lambdas in non-top-level components here, calling
1424 ;;; SUB-c-t-l-l on each subsequence of normal top level lambdas.
1433 lambdas
1434 ;; this used to read ":start start", but
1435 ;; start can be greater than len, which
1436 ;; is an error according to ANSI - CSR,
1437 ;; 2002-04-25
1439 len)))
1448 ;;; Compile LAMBDAS (a list of CLAMBDAs for top level forms) into the
1449 ;;; object file.
1450 ;;;
1451 ;;; LOAD-TIME-VALUE-P seems to control whether it's MAKE-LOAD-FORM and
1452 ;;; COMPILE-LOAD-TIME-VALUE stuff. -- WHN 20000201
1486 ;;; Actually compile any stuff that has been queued up for block
1487 ;;; compilation.
1507 lexenv))
1511 nil
1527 lexenv))
1537 ;;; Read all forms from INFO and compile them, with output to OBJECT.
1538 ;;; Return (VALUES ABORT-P WARNINGS-P FAILURE-P).
1566 ;; FIXME: Do we need this rebinding here? It's a literal
1567 ;; translation of the old CMU CL rebinding to
1568 ;; (OR *BACKEND-INFO-ENVIRONMENT* *INFO-ENVIRONMENT*),
1569 ;; and it's not obvious whether the rebinding to itself is
1570 ;; needed that SBCL doesn't need *BACKEND-INFO-ENVIRONMENT*.
1583 ;; Dump the code coverage records into the fasl.
1591 list))
1592 nil
1593 nil))
1601 nil)))
1602 ;; Some errors are sufficiently bewildering that we just fail
1603 ;; immediately, without trying to recover and compile more of
1604 ;; the input file.
1609 "~@<compilation aborted because of fatal error: ~2I~_~A~:>"
1610 condition))
1614 ;;; Return a pathname for the named file. The file must exist.
1623 new
1639 ;;; Print some junk at the beginning and end of compilation.
1647 file-info)
1649 :print-weekday nil
1656 won
1662 ;;; Open some files and call SUB-COMPILE-FILE. If something unwinds
1663 ;;; out of the compile, then abort the writing of the output file, so
1664 ;;; that we don't overwrite it with known garbage.
1667 &key
1669 ;; ANSI options
1671 ;; FIXME: ANSI doesn't seem to say anything about
1672 ;; *COMPILE-VERBOSE* and *COMPILE-PRINT* being rebound by this
1673 ;; function..
1678 ;; extensions
1681 #!+sb-doc
1682 "Compile INPUT-FILE, producing a corresponding fasl file and
1683 returning its filename.
1685 :PRINT
1686 If true, a message per non-macroexpanded top level form is printed
1687 to *STANDARD-OUTPUT*. Top level forms that whose subforms are
1688 processed as top level forms (eg. EVAL-WHEN, MACROLET, PROGN) receive
1689 no such message, but their subforms do.
1691 As an extension to ANSI, if :PRINT is :top-level-forms, a message
1692 per top level form after macroexpansion is printed to *STANDARD-OUTPUT*.
1693 For example, compiling an IN-PACKAGE form will result in a message about
1694 a top level SETQ in addition to the message about the IN-PACKAGE form'
1695 itself.
1697 Both forms of reporting obey the SB-EXT:*COMPILER-PRINT-VARIABLE-ALIST*.
1699 :BLOCK-COMPILE
1700 Though COMPILE-FILE accepts an additional :BLOCK-COMPILE
1701 argument, it is not currently supported. (non-standard)
1703 :TRACE-FILE
1704 If given, internal data structures are dumped to the specified
1705 file, or if a value of T is given, to a file of *.trace type
1706 derived from the input file name. (non-standard)"
1707 ;;; Block compilation is currently broken.
1708 #|
1709 "Also, as a workaround for vaguely-non-ANSI behavior, the
1710 :BLOCK-COMPILE argument is quasi-supported, to determine whether
1711 multiple functions are compiled together as a unit, resolving function
1712 references at compile time. NIL means that global function names are
1713 never resolved at compilation time. Currently NIL is the default
1715 of the ANSI spec allows this behavior under all circumstances, the
1716 compiler's runtime scales badly when it tries to do this for large
1717 files. If/when this performance problem is fixed, the block
1718 compilation default behavior will probably be made dependent on the
1719 SPEED and COMPILATION-SPEED optimization values, and the
1720 :BLOCK-COMPILE argument will probably become deprecated."
1721 |#
1745 default-trace-file-pathname
1747 default-trace-file-pathname))))
1775 ;; CLHS says that the first value is NIL if the "file could not
1776 ;; be created". We interpret this to mean "a valid fasl could not
1777 ;; be created" -- which can happen if the compilation is aborted
1778 ;; before the whole file has been processed, due to eg. a reader
1779 ;; error.
1781 ;; Hack around filesystem race condition...
1783 warnings-p
1784 failure-p)))
1785 \f
1786 ;;; a helper function for COMPILE-FILE-PATHNAME: the default for
1787 ;;; the OUTPUT-FILE argument
1788 ;;;
1789 ;;; ANSI: The defaults for the OUTPUT-FILE are taken from the pathname
1790 ;;; that results from merging the INPUT-FILE with the value of
1791 ;;; *DEFAULT-PATHNAME-DEFAULTS*, except that the type component should
1792 ;;; default to the appropriate implementation-defined default type for
1793 ;;; compiled files.
1797 retyped))
1799 ;;; KLUDGE: Part of the ANSI spec for this seems contradictory:
1800 ;;; If INPUT-FILE is a logical pathname and OUTPUT-FILE is unsupplied,
1801 ;;; the result is a logical pathname. If INPUT-FILE is a logical
1802 ;;; pathname, it is translated into a physical pathname as if by
1803 ;;; calling TRANSLATE-LOGICAL-PATHNAME.
1804 ;;; So I haven't really tried to make this precisely ANSI-compatible
1805 ;;; at the level of e.g. whether it returns logical pathname or a
1806 ;;; physical pathname. Patches to make it more correct are welcome.
1807 ;;; -- WHN 2000-12-09
1809 &key
1812 #!+sb-doc
1813 "Return a pathname describing what file COMPILE-FILE would write to given
1814 these arguments."
1818 \f
1819 ;;;; MAKE-LOAD-FORM stuff
1821 ;;; The entry point for MAKE-LOAD-FORM support. When IR1 conversion
1822 ;;; finds a constant structure, it invokes this to arrange for proper
1823 ;;; dumping. If it turns out that the constant has already been
1824 ;;; dumped, then we don't need to do anything.
1825 ;;;
1826 ;;; If the constant hasn't been dumped, then we check to see whether
1827 ;;; we are in the process of creating it. We detect this by
1828 ;;; maintaining the special *CONSTANTS-BEING-CREATED* as a list of all
1829 ;;; the constants we are in the process of creating. Actually, each
1830 ;;; entry is a list of the constant and any init forms that need to be
1831 ;;; processed on behalf of that constant.
1832 ;;;
1833 ;;; It's not necessarily an error for this to happen. If we are
1834 ;;; processing the init form for some object that showed up *after*
1835 ;;; the original reference to this constant, then we just need to
1836 ;;; defer the processing of that init form. To detect this, we
1837 ;;; maintain *CONSTANTS-CREATED-SINCE-LAST-INIT* as a list of the
1838 ;;; constants created since the last time we started processing an
1839 ;;; init form. If the constant passed to emit-make-load-form shows up
1840 ;;; in this list, then there is a circular chain through creation
1841 ;;; forms, which is an error.
1842 ;;;
1843 ;;; If there is some intervening init form, then we blow out of
1844 ;;; processing it by throwing to the tag PENDING-INIT. The value we
1845 ;;; throw is the entry from *CONSTANTS-BEING-CREATED*. This is so the
1846 ;;; offending init form can be tacked onto the init forms for the
1847 ;;; circular object.
1848 ;;;
1849 ;;; If the constant doesn't show up in *CONSTANTS-BEING-CREATED*, then
1850 ;;; we have to create it. We call MAKE-LOAD-FORM and check to see
1851 ;;; whether the creation form is the magic value
1852 ;;; :SB-JUST-DUMP-IT-NORMALLY. If it is, then we don't do anything. The
1853 ;;; dumper will eventually get its hands on the object and use the
1854 ;;; normal structure dumping noise on it.
1855 ;;;
1856 ;;; Otherwise, we bind *CONSTANTS-BEING-CREATED* and
1857 ;;; *CONSTANTS-CREATED-SINCE- LAST-INIT* and compile the creation form
1858 ;;; much the way LOAD-TIME-VALUE does. When this finishes, we tell the
1859 ;;; dumper to use that result instead whenever it sees this constant.
1860 ;;;
1861 ;;; Now we try to compile the init form. We bind
1862 ;;; *CONSTANTS-CREATED-SINCE-LAST-INIT* to NIL and compile the init
1863 ;;; form (and any init forms that were added because of circularity
1864 ;;; detection). If this works, great. If not, we add the init forms to
1865 ;;; the init forms for the object that caused the problems and let it
1866 ;;; deal with it.
1869 ;;; FIXME: Shouldn't these^ variables be unbound outside LET forms?
1873 ;; KLUDGE: This special hack is because I was too lazy
1874 ;; to rework DEF!STRUCT so that the MAKE-LOAD-FORM
1875 ;; function of LAYOUT returns nontrivial forms when
1876 ;; building the cross-compiler but :IGNORE-IT when
1877 ;; cross-compiling or running under the target Lisp. --
1878 ;; WHN 19990914
1887 ;; If the constant is a reference to a named constant, we can
1888 ;; just use SYMBOL-VALUE during LOAD.
1895 (:sb-just-dump-it-normally
1897 t)
1898 (:ignore-it
1899 nil)
1912 constant
1914 creation-form)
1916 nil)
1918 constant)))
1924 collect name into names
1925 collect form into forms
1927 nil)))
1932 \f
1933 ;;;; Host compile time definitions
1934 #+sb-xc-host
1939 #+sb-xc-host