| blob | aeb365b2741300d472d359d3fc91b8fbf331dea6 |
1 ;;;; stuff which is not specific to any particular build phase, but
2 ;;;; used by most of them
3 ;;;;
4 ;;;; Note: It's specifically not used when bootstrapping PCL, because
5 ;;;; we do SAVE-LISP after that, and we don't want to save extraneous
6 ;;;; bootstrapping machinery into the frozen image which will
7 ;;;; subsequently be used as the mother of all Lisp sessions.
9 ;;;; This software is part of the SBCL system. See the README file for
10 ;;;; more information.
11 ;;;;
12 ;;;; This software is derived from the CMU CL system, which was
13 ;;;; written at Carnegie Mellon University and released into the
14 ;;;; public domain. The software is in the public domain and is
15 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
16 ;;;; files for more information.
18 ;;; SB-COLD holds stuff used to build the initial SBCL core file
19 ;;; (including not only the final construction of the core file, but
20 ;;; also the preliminary steps like e.g. building the cross-compiler
21 ;;; and running the cross-compiler to produce target FASL files).
33 ;; If only 1 integer, assume same parallelism for both passes.
36 ;; 0 means no parallelism. 1 means use at most one subjob,
37 ;; just in case you want to test the controlling loop.
40 ;; Parallelism on pass 1 works only if LOAD does not compile.
41 ;; Otherwise it's slower than compiling serially.
42 ;; (And this has only been tested with sb-fasteval, not sb-eval.)
44 value2)))))
56 #+sbcl
61 ;;; If TRUE, then COMPILE-FILE is being invoked only to process
62 ;;; :COMPILE-TOPLEVEL forms, not to produce an output file.
63 ;;; This is part of the implementation of parallelized make-host-2.
66 ;;; prefixes for filename stems when cross-compiling. These are quite arbitrary
67 ;;; (although of course they shouldn't collide with anything we don't want to
68 ;;; write over). In particular, they can be either relative path names (e.g.
69 ;;; "host-objects/" or absolute pathnames (e.g. "/tmp/sbcl-xc-host-objects/").
70 ;;;
71 ;;; The cross-compilation process will force the creation of these directories
72 ;;; by executing CL:ENSURE-DIRECTORIES-EXIST (on the xc host Common Lisp).
77 ;; Target fasl files are LOADed (actually only quasi-LOADed, in
78 ;; GENESIS) only by SBCL code, and it doesn't care about particular
79 ;; extensions, so we can use something arbitrary.
82 ;; Target fasl files from SB!C:ASSEMBLE-FILE are LOADed via GENESIS.
83 ;; The source files are compiled once as assembly files and once as
84 ;; normal lisp files. In the past, they were kept separate by
85 ;; clever symlinking in the source tree, but that became less clean
86 ;; as ports to host environments without symlinks started appearing.
87 ;; In order to keep them separate, we have the assembled versions
88 ;; with a separate suffix.
91 ;;; a function of one functional argument, which calls its functional argument
92 ;;; in an environment suitable for compiling the target. (This environment
93 ;;; includes e.g. a suitable *FEATURES* value.)
97 ;;; a function with the same calling convention as CL:COMPILE-FILE, to be
98 ;;; used to translate ordinary Lisp source files into target object files
102 ;;; designator for a function with the same calling convention as
103 ;;; SB-C:ASSEMBLE-FILE, to be used to translate assembly files into target
104 ;;; object files
106 \f
107 ;;;; some tools
109 ;;; Take the file named X and make it into a file named Y. Sorta like
110 ;;; UNIX, and unlike Common Lisp's bare RENAME-FILE, we don't allow
111 ;;; information from the original filename to influence the final
112 ;;; filename. (The reason that it's only sorta like UNIX is that in
113 ;;; UNIX "mv foo bar/" will work, but the analogous
114 ;;; (RENAME-FILE-A-LA-UNIX "foo" "bar/") should fail.)
115 ;;;
116 ;;; (This is a workaround for the weird behavior of Debian CMU CL
117 ;;; 2.4.6, where (RENAME-FILE "dir/x" "dir/y") tries to create a file
118 ;;; called "dir/dir/y". If that behavior goes away, then we should be
119 ;;; able to get rid of this function and use plain RENAME-FILE in the
120 ;;; COMPILE-STEM function above. -- WHN 19990321
124 ;; example in the ANSI spec for TRUENAME.)
127 ;; From the ANSI spec: "In this case, the file is closed
128 ;; when the truename is tried, so the truename
129 ;; information is reliable."
138 ;;; See remark in COMPILE-STEM about strings vs. The Common Lisp Way
141 ;; if exact match to "output/", or mismatch at the next character
145 namestring))
148 ;;; Return an expression read from the file named NAMESTRING.
149 ;;; For user-supplied inputs, protect against more than one expression
150 ;;; appearing in the file. With trusted inputs we needn't bother.
156 ;; build-order uses both host and target conditionals.
157 ;; Our sanity checks during make-host-1 would complain
158 ;; about #+feature when reading the second expression in the file
159 ;; whenever such feature is also a possible target feature.
163 result)))
166 ;;; Try to minimize/conceal any non-standardness of the host Common Lisp.
169 ;;;; Do not put SBCL-specific things in 'ansify'. Put them here.
170 ;;;; And there had better not be a reason that SBCL needs ansification.
171 #+sbcl
175 ;; Let's just say we never care to see these.
180 \f
181 ;;;; special read-macros for building the cold system (and even for
182 ;;;; building some of our tools for building the cold system)
186 ;;; When cross-compiling, the *FEATURES* set for the target Lisp is
187 ;;; not in general the same as the *FEATURES* set for the host Lisp.
188 ;;; In order to refer to target features specifically, we refer to
189 ;;; *SHEBANG-FEATURES* instead of *FEATURES*, and use the #!+ and #!-
190 ;;; readmacros instead of the ordinary #+ and #- readmacros.
194 nil
213 ;;; Call for effect of signaling an error if no target picked.
216 ;;; You can get all the way through make-host-1 without either one of these
217 ;;; features, but then 'bit-bash' will fail to cross-compile.
221 ;;; Some feature combinations simply don't work, and sometimes don't
222 ;;; fail until quite a ways into the build. Pick off the more obvious
223 ;;; combinations now, and provide a description of what the actual
224 ;;; failure is (not always obvious from when the build fails).
253 ;; It sorta kinda works to have both, but there should be no need,
254 ;; and it's not really supported.
264 ;; There is still hope to make multithreading on DragonFly x86-64
274 failed-test-descriptions)))
275 \f
276 ;;;; cold-init-related PACKAGE and SYMBOL tools
278 ;;; Once we're done with possibly ANSIfying the COMMON-LISP package,
279 ;;; it's probably a mistake if we change it (beyond changing the
280 ;;; values of special variables such as *** and +, anyway). Set up
281 ;;; machinery to warn us when/if we change it.
282 ;;;
283 ;;; All code depending on this is itself dependent on #!+SB-SHOW.
284 #!+sb-show
288 \f
289 ;;;; master list of source files and their properties
291 ;;; flags which can be used to describe properties of source files
295 ;; independently of make-host-1
296 :c-headers
297 ;; meaning: This file is not to be compiled when building the
298 ;; cross-compiler which runs on the host ANSI Lisp. ("not host
299 ;; code", i.e. does not execute on host -- but may still be
300 ;; cross-compiled by the host, so that it executes on the target)
301 :not-host
302 ;; meaning: This file is not to be compiled as part of the target
303 ;; SBCL. ("not target code" -- but still presumably host code,
304 ;; used to support the cross-compilation process)
305 :not-target
306 ;; meaning: This file must always be compiled by 'slam.lisp' even if
307 ;; the object is not out of date with respect to its source.
308 ;; Necessary if there are compile-time-too effects that are not
309 ;; reflected into make-host-2 by load-time actions of make-host-1.
310 :slam-forcibly
311 ;; meaning: The #'COMPILE-STEM argument :TRACE-FILE should be T.
312 ;; When the compiler is SBCL's COMPILE-FILE or something like it,
313 ;; compiling "foo.lisp" will generate "foo.trace" which contains lots
314 ;; of exciting low-level information about representation selection,
315 ;; VOPs used by the compiler, and bits of assembly.
316 :trace-file
317 ;; meaning: This file is to be processed with the SBCL assembler,
318 ;; not COMPILE-FILE. (Note that this doesn't make sense unless
319 ;; :NOT-HOST is also set, since the SBCL assembler doesn't exist
320 ;; while the cross-compiler is being built in the host ANSI Lisp.)
321 :assem
322 ;; meaning: The #'COMPILE-STEM argument called :IGNORE-FAILURE-P
323 ;; should be true. (This is a KLUDGE: I'd like to get rid of it.
324 ;; For now, it exists so that compilation can proceed through the
325 ;; legacy warnings in src/compiler/x86/array.lisp, which I've
326 ;; never figured out but which were apparently acceptable in CMU
327 ;; CL. Eventually, it would be great to just get rid of all
328 ;; warnings and remove support for this flag. -- WHN 19990323)
329 :ignore-failure-p
330 ;; meaning: Build this file, but don't put it on the list for
331 ;; genesis to include in the cold core.
341 ,@body
344 ;;; Given a STEM, remap the path component "/target/" to a suitable
345 ;;; target directory.
353 stem)))
356 ;;; Determine the source path for a stem by remapping from the abstract name
357 ;;; if it contains "/target/" and appending a ".lisp" suffix.
358 ;;; Assume that STEM is source-tree-relative unless it starts with "output/"
359 ;;; in which case it could be elsewhere, if you prefer to keep the sources
360 ;;; devoid of compilation artifacts. (The production of out-of-tree artifacts
361 ;;; is not actually implemented in the generic build, however if your build
362 ;;; system does that by itself, then hooray for you)
367 ;;; Determine the object path for a stem/flags/mode combination.
372 (:host-compile
373 ;; On some xc hosts, it's impossible to LOAD a fasl file unless it
374 ;; has the same extension that the host uses for COMPILE-FILE
375 ;; output, so we have to be careful to use the xc host's preferred
376 ;; extension.
388 ;;; Check for stupid typos in FLAGS list keywords.
395 ;; We do duplicate stem comparison based on the object path in
396 ;; order to cover the case of stems with an :assem flag, which
397 ;; have two entries but separate object paths for each. KLUDGE:
398 ;; We have to bind *target-obj-prefix* here because it's normally
399 ;; set up later in the build process and we don't actually care
400 ;; what it is so long as it doesn't change while we're checking
401 ;; for duplicate stems.
407 ;; FIXME: We should make sure that the :assem flag is only used
408 ;; when paired with :not-host.
412 set-difference)))))
414 \f
415 ;;;; tools to compile SBCL sources to create the cross-compiler
417 ;;; a wrapper for compilation/assembly, used mostly to centralize
418 ;;; the procedure for finding full filenames from "stems"
419 ;;;
420 ;;; Compile the source file whose basic name is STEM, using some
421 ;;; standard-for-the-SBCL-build-process procedures to generate the
422 ;;; full pathnames of source file and object file. Return the pathname
423 ;;; of the object file for STEM.
424 ;;;
425 ;;; STEM and FLAGS are as per DO-STEMS-AND-FLAGS. MODE is one of
426 ;;; :HOST-COMPILE and :TARGET-COMPILE.
430 ;; Lisp Way, although it works just fine for common UNIX environments.
431 ;; Should it come to pass that the system is ported to environments
432 ;; where version numbers and so forth become an issue, it might become
433 ;; urgent to rewrite this using the fancy Common Lisp PATHNAME
434 ;; machinery instead of just using strings. In the absence of such a
435 ;; port, it might or might be a good idea to do the rewrite.
436 ;; -- WHN 19990815
439 ;; Compile-for-effect happens simultaneously with a forked compile,
440 ;; so we need the for-effect output not to stomp on the real output.
456 ;; We're about to set about building a new object file. First, we
457 ;; delete any preexisting object file in order to avoid confusing
458 ;; ourselves later should we happen to bail out of compilation
459 ;; with an error.
463 ;; Original comment:
464 ;;
465 ;; Work around a bug in CLISP 1999-01-08 #'COMPILE-FILE: CLISP
466 ;; mangles relative pathnames passed as :OUTPUT-FILE arguments,
467 ;; but works OK with absolute pathnames.
468 ;;
469 ;; following discussion on cmucl-imp 2002-07
470 ;; "COMPILE-FILE-PATHNAME", it would seem safer to deal with
471 ;; absolute pathnames all the time; it is no longer clear that the
472 ;; original behaviour in CLISP was wrong or that the current
473 ;; behaviour is right; and in any case absolutifying the pathname
474 ;; insulates us against changes of behaviour. -- CSR, 2002-08-09
476 ;; (Note that this idiom is taken from the ANSI
477 ;; documentation for TRUENAME.)
480 ;; Compilation would overwrite the
481 ;; temporary object anyway and overly
482 ;; strict implementations default
483 ;; to :ERROR.
487 ;; and some compilers (e.g. OpenMCL) will complain if they're
488 ;; asked to write over a file that exists already (and isn't
489 ;; recognizeably a fasl file), so
493 ;; Try to use the compiler to generate a new temporary object file.
499 retry-compile-file
507 :report report-recompile-restart
515 src)
519 obj)
521 :report report-recompile-restart
524 :report report-continue-restart
526 ;; Don't leave failed object files lying around.
530 ;; Otherwise: success, just fall through.
533 ;; If we get to here, compilation succeeded, so it's OK to rename
534 ;; the temporary output file to the permanent object file.
540 ;; nice friendly traditional return value
544 ;;; Execute function FN in an environment appropriate for compiling the
545 ;;; cross-compiler's source code in the cross-compilation host.
552 ;;; Process a file as source code for the cross-compiler, compiling it
553 ;;; (if necessary) in the appropriate environment, then loading it
554 ;;; into the cross-compilation host Common lisp.
565 ;;; like HOST-CLOAD-STEM, except that we don't bother to compile
571 \f
572 ;;;; tools to compile SBCL sources to create object files which will
573 ;;;; be used to create the target SBCL .core file
576 ;; Don't want genfiles path to sneak in - avoid (STEM-SOURCE-PATH ...) here.
578 ;; Distrust that random hosts don't bork up the translation.
579 ;; Simply replace '/' with ';' and be done.
583 ;;; Run the cross-compiler on a file in the source directory tree to
584 ;;; produce a corresponding file in the target object directory tree.
593 ;;; (This function is not used by the build process, but is intended
594 ;;; for interactive use when experimenting with the system. It runs
595 ;;; the cross-compiler on test files with arbitrary filenames, not
596 ;;; necessarily in the source tree, e.g. in "/tmp".)