1 ;;;; stuff which is not specific to any particular build phase, but
2 ;;;; used by most of them
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.
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).
22 (defpackage "SB-COLD" (:use "CL"))
24 (in-package "SB-COLD")
26 ;;; prefixes for filename stems when cross-compiling. These are quite arbitrary
27 ;;; (although of course they shouldn't collide with anything we don't want to
28 ;;; write over). In particular, they can be either relative path names (e.g.
29 ;;; "host-objects/" or absolute pathnames (e.g. "/tmp/sbcl-xc-host-objects/").
31 ;;; The cross-compilation process will force the creation of these directories
32 ;;; by executing CL:ENSURE-DIRECTORIES-EXIST (on the xc host Common Lisp).
33 (defvar *host-obj-prefix*)
34 (defvar *target-obj-prefix*)
36 ;;; suffixes for filename stems when cross-compiling
37 (defvar *host-obj-suffix*
39 ;; On some xc hosts, it's impossible to LOAD a fasl file unless it
40 ;; has the same extension that the host uses for COMPILE-FILE
41 ;; output, so we have to be careful to use the xc host's preferred
44 ;; FIXME: This is a little ugly and annoying to maintain. And
45 ;; there's very likely some way to rearrange the build process so
46 ;; that we never explicitly refer to host object file suffixes,
47 ;; only to the result of CL:COMPILE-FILE-PATHNAME.
48 #+lispworks ".ufsl" ; as per Lieven Marchand sbcl-devel 2002-02-01
49 ;; On most xc hosts, any old extension works, so we use an
52 (defvar *target-obj-suffix*
53 ;; Target fasl files are LOADed (actually only quasi-LOADed, in
54 ;; GENESIS) only by SBCL code, and it doesn't care about particular
55 ;; extensions, so we can use something arbitrary.
58 ;;; a function of one functional argument, which calls its functional argument
59 ;;; in an environment suitable for compiling the target. (This environment
60 ;;; includes e.g. a suitable *FEATURES* value.)
61 (defvar *in-target-compilation-mode-fn*)
63 ;;; designator for a function with the same calling convention as
64 ;;; CL:COMPILE-FILE, to be used to translate ordinary Lisp source files into
65 ;;; target object files
66 (defvar *target-compile-file*)
68 ;;; designator for a function with the same calling convention as
69 ;;; SB-C:ASSEMBLE-FILE, to be used to translate assembly files into target
71 (defvar *target-assemble-file*)
75 ;;; Take the file named X and make it into a file named Y. Sorta like
76 ;;; UNIX, and unlike Common Lisp's bare RENAME-FILE, we don't allow
77 ;;; information from the original filename to influence the final
78 ;;; filename. (The reason that it's only sorta like UNIX is that in
79 ;;; UNIX "mv foo bar/" will work, but the analogous
80 ;;; (RENAME-FILE-A-LA-UNIX "foo" "bar/") should fail.)
82 ;;; (This is a workaround for the weird behavior of Debian CMU CL
83 ;;; 2.4.6, where (RENAME-FILE "dir/x" "dir/y") tries to create a file
84 ;;; called "dir/dir/y". If that behavior goes away, then we should be
85 ;;; able to get rid of this function and use plain RENAME-FILE in the
86 ;;; COMPILE-STEM function above. -- WHN 19990321
87 (defun rename-file-a-la-unix (x y)
89 (let ((path ;; (Note that the TRUENAME expression here is lifted from an
90 ;; example in the ANSI spec for TRUENAME.)
91 (with-open-file (stream y :direction :output)
93 ;; From the ANSI spec: "In this case, the file is closed
94 ;; when the truename is tried, so the truename
95 ;; information is reliable."
98 (rename-file x path)))
99 (compile 'rename-file-a-la-unix)
101 ;;; a wrapper for compilation/assembly, used mostly to centralize
102 ;;; the procedure for finding full filenames from "stems"
104 ;;; Compile the source file whose basic name is STEM, using some
105 ;;; standard-for-the-SBCL-build-process procedures to generate the
106 ;;; full pathnames of source file and object file. Return the pathname
107 ;;; of the object file for STEM. Several &KEY arguments are accepted:
108 ;;; :SRC-PREFIX, :SRC-SUFFIX =
109 ;;; strings to be concatenated to STEM to produce source filename
110 ;;; :OBJ-PREFIX, :OBJ-SUFFIX =
111 ;;; strings to be concatenated to STEM to produce object filename
112 ;;; :TMP-OBJ-SUFFIX-SUFFIX =
113 ;;; string to be appended to the name of an object file to produce
114 ;;; the name of a temporary object file
115 ;;; :COMPILE-FILE, :IGNORE-FAILURE-P =
116 ;;; :COMPILE-FILE is a function to use for compiling the file
117 ;;; (with the same calling conventions as ANSI CL:COMPILE-FILE).
118 ;;; If the third return value (FAILURE-P) of this function is
119 ;;; true, a continuable error will be signalled, unless
120 ;;; :IGNORE-FAILURE-P is set, in which case only a warning will be
122 (defun compile-stem (stem
125 (obj-suffix (error "missing OBJ-SUFFIX"))
126 (tmp-obj-suffix-suffix "-tmp")
129 (compile-file #'compile-file)
132 (let* (;; KLUDGE: Note that this CONCATENATE 'STRING stuff is not The Common
133 ;; Lisp Way, although it works just fine for common UNIX environments.
134 ;; Should it come to pass that the system is ported to environments
135 ;; where version numbers and so forth become an issue, it might become
136 ;; urgent to rewrite this using the fancy Common Lisp PATHNAME
137 ;; machinery instead of just using strings. In the absence of such a
138 ;; port, it might or might be a good idea to do the rewrite.
140 (src (concatenate 'string src-prefix stem src-suffix))
141 (obj (concatenate 'string obj-prefix stem obj-suffix))
142 (tmp-obj (concatenate 'string obj tmp-obj-suffix-suffix)))
144 (ensure-directories-exist obj :verbose t)
146 ;; We're about to set about building a new object file. First, we
147 ;; delete any preexisting object file in order to avoid confusing
148 ;; ourselves later should we happen to bail out of compilation
150 (when (probe-file obj)
153 ;; Work around a bug in CLISP 1999-01-08 #'COMPILE-FILE: CLISP
154 ;; mangles relative pathnames passed as :OUTPUT-FILE arguments,
155 ;; but works OK with absolute pathnames.
158 ;; (Note that this idiom is taken from the ANSI
159 ;; documentation for TRUENAME.)
160 (with-open-file (stream tmp-obj :direction :output)
164 ;; Try to use the compiler to generate a new temporary object file.
165 (multiple-value-bind (output-truename warnings-p failure-p)
166 (funcall compile-file src :output-file tmp-obj)
167 (declare (ignore warnings-p))
168 (cond ((not output-truename)
169 (error "couldn't compile ~S" src))
172 (warn "ignoring FAILURE-P return value from compilation of ~S"
176 ;; FIXME: This should have another option,
177 ;; redoing compilation.
178 (cerror "Continue, using possibly-bogus ~S."
179 "FAILURE-P was set when creating ~S."
181 (setf failure-p nil))
182 ;; Don't leave failed object files lying around.
183 (when (and failure-p (probe-file tmp-obj))
184 (delete-file tmp-obj)
185 (format t "~&deleted ~S~%" tmp-obj)))))
186 ;; Otherwise: success, just fall through.
189 ;; If we get to here, compilation succeeded, so it's OK to rename
190 ;; the temporary output file to the permanent object file.
191 (rename-file-a-la-unix tmp-obj obj)
193 ;; nice friendly traditional return value
195 (compile 'compile-stem)
197 ;;; other miscellaneous tools
198 (load "src/cold/read-from-file.lisp")
199 (load "src/cold/rename-package-carefully.lisp")
200 (load "src/cold/with-stuff.lisp")
202 ;;; Try to minimize/conceal any non-standardness of the host Common Lisp.
203 (load "src/cold/ansify.lisp")
205 ;;;; special read-macros for building the cold system (and even for
206 ;;;; building some of our tools for building the cold system)
208 (load "src/cold/shebang.lisp")
210 ;;; When cross-compiling, the *FEATURES* set for the target Lisp is
211 ;;; not in general the same as the *FEATURES* set for the host Lisp.
212 ;;; In order to refer to target features specifically, we refer to
213 ;;; *SHEBANG-FEATURES* instead of *FEATURES*, and use the #!+ and #!-
214 ;;; readmacros instead of the ordinary #+ and #- readmacros.
215 (setf *shebang-features*
216 (let* ((default-features
217 (append (read-from-file "base-target-features.lisp-expr")
218 (read-from-file "local-target-features.lisp-expr")))
219 (customizer-file-name "customize-target-features.lisp")
220 (customizer (if (probe-file customizer-file-name)
222 (read-from-file customizer-file-name))
224 (funcall customizer default-features)))
225 (let ((*print-length* nil)
228 "target features *SHEBANG-FEATURES*=~@<~S~:>~%"
231 (defvar *shebang-backend-subfeatures*
232 (let* ((default-subfeatures nil)
233 (customizer-file-name "customize-backend-subfeatures.lisp")
234 (customizer (if (probe-file customizer-file-name)
236 (read-from-file customizer-file-name))
238 (funcall customizer default-subfeatures)))
239 (let ((*print-length* nil)
242 "target backend-subfeatures *SHEBANG-BACKEND-FEATURES*=~@<~S~:>~%"
243 *shebang-backend-subfeatures*))
245 ;;;; cold-init-related PACKAGE and SYMBOL tools
247 ;;; Once we're done with possibly ANSIfying the COMMON-LISP package,
248 ;;; it's probably a mistake if we change it (beyond changing the
249 ;;; values of special variables such as *** and +, anyway). Set up
250 ;;; machinery to warn us when/if we change it.
252 ;;; All code depending on this is itself dependent on #!+SB-SHOW.
255 (load "src/cold/snapshot.lisp")
256 (defvar *cl-snapshot* (take-snapshot "COMMON-LISP")))
258 ;;;; master list of source files and their properties
260 ;;; flags which can be used to describe properties of source files
262 *expected-stem-flags*
263 '(;; meaning: This file is not to be compiled when building the
264 ;; cross-compiler which runs on the host ANSI Lisp.
266 ;; meaning: This file is not to be compiled as part of the target
269 ;; meaning: This file is to be processed with the SBCL assembler,
270 ;; not COMPILE-FILE. (Note that this doesn't make sense unless
271 ;; :NOT-HOST is also set, since the SBCL assembler doesn't exist
272 ;; while the cross-compiler is being built in the host ANSI Lisp.)
274 ;; meaning: The #'COMPILE-STEM argument called :IGNORE-FAILURE-P
275 ;; should be true. (This is a KLUDGE: I'd like to get rid of it.
276 ;; For now, it exists so that compilation can proceed through the
277 ;; legacy warnings in src/compiler/x86/array.lisp, which I've
278 ;; never figured out but which were apparently acceptable in CMU
279 ;; CL. Eventually, it would be great to just get rid of all
280 ;; warnings and remove support for this flag. -- WHN 19990323)
283 (defparameter *stems-and-flags* (read-from-file "build-order.lisp-expr"))
285 (defmacro do-stems-and-flags ((stem flags) &body body)
286 (let ((stem-and-flags (gensym "STEM-AND-FLAGS-")))
287 `(dolist (,stem-and-flags *stems-and-flags*)
288 (let ((,stem (first ,stem-and-flags))
289 (,flags (rest ,stem-and-flags)))
292 ;;; Check for stupid typos in FLAGS list keywords.
293 (let ((stems (make-hash-table :test 'equal)))
294 (do-stems-and-flags (stem flags)
295 (if (gethash stem stems)
296 (error "duplicate stem ~S in *STEMS-AND-FLAGS*" stem)
297 (setf (gethash stem stems) t))
298 (let ((set-difference (set-difference flags *expected-stem-flags*)))
300 (error "found unexpected flag(s) in *STEMS-AND-FLAGS*: ~S"
303 ;;;; tools to compile SBCL sources to create the cross-compiler
305 ;;; Execute function FN in an environment appropriate for compiling the
306 ;;; cross-compiler's source code in the cross-compilation host.
307 (defun in-host-compilation-mode (fn)
308 (let ((*features* (cons :sb-xc-host *features*))
309 ;; the CROSS-FLOAT-INFINITY-KLUDGE, as documented in
310 ;; base-target-features.lisp-expr:
311 (*shebang-features* (set-difference *shebang-features*
312 '(:sb-propagate-float-type
313 :sb-propagate-fun-type))))
314 (with-additional-nickname ("SB-XC" "SB!XC")
316 (compile 'in-host-compilation-mode)
318 ;;; Process a file as source code for the cross-compiler, compiling it
319 ;;; (if necessary) in the appropriate environment, then loading it
320 ;;; into the cross-compilation host Common lisp.
321 (defun host-cload-stem (stem &key ignore-failure-p)
322 (let ((compiled-filename (in-host-compilation-mode
326 :obj-prefix *host-obj-prefix*
327 :obj-suffix *host-obj-suffix*
328 :compile-file #'cl:compile-file
329 :ignore-failure-p ignore-failure-p)))))
330 (load compiled-filename)))
331 (compile 'host-cload-stem)
333 ;;; like HOST-CLOAD-STEM, except that we don't bother to compile
334 (defun host-load-stem (stem &key ignore-failure-p)
335 (declare (ignore ignore-failure-p)) ; (It's only relevant when
336 ;; compiling.) KLUDGE: It's untidy to have the knowledge of how to
337 ;; construct complete filenames from stems in here as well as in
338 ;; COMPILE-STEM. It should probably be factored out somehow. -- WHN
340 (load (concatenate 'simple-string *host-obj-prefix* stem *host-obj-suffix*)))
341 (compile 'host-load-stem)
343 ;;;; tools to compile SBCL sources to create object files which will
344 ;;;; be used to create the target SBCL .core file
346 ;;; Run the cross-compiler on a file in the source directory tree to
347 ;;; produce a corresponding file in the target object directory tree.
348 (defun target-compile-stem (stem &key assem-p ignore-failure-p)
349 (funcall *in-target-compilation-mode-fn*
352 :obj-prefix *target-obj-prefix*
353 :obj-suffix *target-obj-suffix*
354 :ignore-failure-p ignore-failure-p
355 :compile-file (if assem-p
356 *target-assemble-file*
357 *target-compile-file*)))))
358 (compile 'target-compile-stem)
360 ;;; (This function is not used by the build process, but is intended
361 ;;; for interactive use when experimenting with the system. It runs
362 ;;; the cross-compiler on test files with arbitrary filenames, not
363 ;;; necessarily in the source tree, e.g. in "/tmp".)
364 (defun target-compile-file (filename)
365 (funcall *in-target-compilation-mode-fn*
367 (funcall *target-compile-file* filename))))
368 (compile 'target-compile-file)