1 ;;;; "cold" core image builder: This is how we create a target Lisp
2 ;;;; system from scratch, by converting from fasl files to an image
3 ;;;; file in the cross-compilation host, without the help of the
4 ;;;; target Lisp system.
6 ;;;; As explained by Rob MacLachlan on the CMU CL mailing list Wed, 06
7 ;;;; Jan 1999 11:05:02 -0500, this cold load generator more or less
8 ;;;; fakes up static function linking. I.e. it makes sure that all the
9 ;;;; DEFUN-defined functions in the fasl files it reads are bound to the
10 ;;;; corresponding symbols before execution starts. It doesn't do
11 ;;;; anything to initialize variable values; instead it just arranges
12 ;;;; for !COLD-INIT to be called at cold load time. !COLD-INIT is
13 ;;;; responsible for explicitly initializing anything which has to be
14 ;;;; initialized early before it transfers control to the ordinary
17 ;;;; (In CMU CL, and in SBCL as of 0.6.9 anyway, functions not defined
18 ;;;; by DEFUN aren't set up specially by GENESIS. In particular,
19 ;;;; structure slot accessors are not set up. Slot accessors are
20 ;;;; available at cold init time because they're usually compiled
21 ;;;; inline. They're not available as out-of-line functions until the
22 ;;;; toplevel forms installing them have run.)
24 ;;;; This software is part of the SBCL system. See the README file for
25 ;;;; more information.
27 ;;;; This software is derived from the CMU CL system, which was
28 ;;;; written at Carnegie Mellon University and released into the
29 ;;;; public domain. The software is in the public domain and is
30 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
31 ;;;; files for more information.
33 (in-package "SB!FASL")
35 ;;; a magic number used to identify our core files
36 (defconstant core-magic
37 (logior (ash (char-code #\S) 24)
38 (ash (char-code #\B) 16)
39 (ash (char-code #\C) 8)
42 ;;; the current version of SBCL core files
44 ;;; FIXME: This is left over from CMU CL, and not well thought out.
45 ;;; It's good to make sure that the runtime doesn't try to run core
46 ;;; files from the wrong version, but a single number is not the ideal
47 ;;; way to do this in high level data like this (as opposed to e.g. in
48 ;;; IP packets), and in fact the CMU CL version number never ended up
49 ;;; being incremented past 0. A better approach might be to use a
50 ;;; string which is set from CVS data.
52 ;;; 0: inherited from CMU CL
53 ;;; 1: rearranged static symbols for sbcl-0.6.8
54 ;;; 2: eliminated non-ANSI %DEFCONSTANT/%%DEFCONSTANT support,
55 ;;; deleted a slot from DEBUG-SOURCE structure
56 (defconstant sbcl-core-version-integer 2)
58 (defun round-up (number size)
60 "Round NUMBER up to be an integral multiple of SIZE."
61 (* size (ceiling number size)))
63 ;;;; representation of spaces in the core
65 ;;; If there is more than one dynamic space in memory (i.e., if a
66 ;;; copying GC is in use), then only the active dynamic space gets
69 (defconstant dynamic-space-id 1)
72 (defconstant static-space-id 2)
75 (defconstant read-only-space-id 3)
77 (defconstant descriptor-low-bits 16
78 "the number of bits in the low half of the descriptor")
79 (defconstant target-space-alignment (ash 1 descriptor-low-bits)
80 "the alignment requirement for spaces in the target.
81 Must be at least (ASH 1 DESCRIPTOR-LOW-BITS)")
83 ;;; a GENESIS-time representation of a memory space (e.g. read-only space,
84 ;;; dynamic space, or static space)
85 (defstruct (gspace (:constructor %make-gspace)
87 ;; name and identifier for this GSPACE
88 (name (missing-arg) :type symbol :read-only t)
89 (identifier (missing-arg) :type fixnum :read-only t)
90 ;; the word address where the data will be loaded
91 (word-address (missing-arg) :type unsigned-byte :read-only t)
92 ;; the data themselves. (Note that in CMU CL this was a pair
93 ;; of fields SAP and WORDS-ALLOCATED, but that wasn't very portable.)
94 (bytes (make-array target-space-alignment :element-type '(unsigned-byte 8))
95 :type (simple-array (unsigned-byte 8) 1))
96 ;; the index of the next unwritten word (i.e. chunk of
97 ;; SB!VM:N-WORD-BYTES bytes) in BYTES, or equivalently the number of
98 ;; words actually written in BYTES. In order to convert to an actual
99 ;; index into BYTES, thus must be multiplied by SB!VM:N-WORD-BYTES.
102 (defun gspace-byte-address (gspace)
103 (ash (gspace-word-address gspace) sb!vm:word-shift))
105 (def!method print-object ((gspace gspace) stream)
106 (print-unreadable-object (gspace stream :type t)
107 (format stream "~S" (gspace-name gspace))))
109 (defun make-gspace (name identifier byte-address)
110 (unless (zerop (rem byte-address target-space-alignment))
111 (error "The byte address #X~X is not aligned on a #X~X-byte boundary."
113 target-space-alignment))
114 (%make-gspace :name name
115 :identifier identifier
116 :word-address (ash byte-address (- sb!vm:word-shift))))
118 ;;; KLUDGE: Doing it this way seems to partly replicate the
119 ;;; functionality of Common Lisp adjustable arrays. Is there any way
120 ;;; to do this stuff in one line of code by using standard Common Lisp
121 ;;; stuff? -- WHN 19990816
122 (defun expand-gspace-bytes (gspace)
123 (let* ((old-bytes (gspace-bytes gspace))
124 (old-length (length old-bytes))
125 (new-length (* 2 old-length))
126 (new-bytes (make-array new-length :element-type '(unsigned-byte 8))))
127 (replace new-bytes old-bytes :end1 old-length)
128 (setf (gspace-bytes gspace)
132 ;;;; representation of descriptors
134 (defstruct (descriptor
135 (:constructor make-descriptor
136 (high low &optional gspace word-offset))
138 ;; the GSPACE that this descriptor is allocated in, or NIL if not set yet.
139 (gspace nil :type (or gspace null))
140 ;; the offset in words from the start of GSPACE, or NIL if not set yet
141 (word-offset nil :type (or (unsigned-byte #.sb!vm:n-word-bits) null))
142 ;; the high and low halves of the descriptor
144 ;; KLUDGE: Judging from the comments in genesis.lisp of the CMU CL
145 ;; old-rt compiler, this split dates back from a very early version
146 ;; of genesis where 32-bit integers were represented as conses of
147 ;; two 16-bit integers. In any system with nice (UNSIGNED-BYTE 32)
148 ;; structure slots, like CMU CL >= 17 or any version of SBCL, there
149 ;; seems to be no reason to persist in this. -- WHN 19990917
152 (def!method print-object ((des descriptor) stream)
153 (let ((lowtag (descriptor-lowtag des)))
154 (print-unreadable-object (des stream :type t)
155 (cond ((or (= lowtag sb!vm:even-fixnum-lowtag)
156 (= lowtag sb!vm:odd-fixnum-lowtag))
157 (let ((unsigned (logior (ash (descriptor-high des)
158 (1+ (- descriptor-low-bits
159 sb!vm:n-lowtag-bits)))
160 (ash (descriptor-low des)
161 (- 1 sb!vm:n-lowtag-bits)))))
164 (if (> unsigned #x1FFFFFFF)
165 (- unsigned #x40000000)
167 ((or (= lowtag sb!vm:other-immediate-0-lowtag)
168 (= lowtag sb!vm:other-immediate-1-lowtag))
170 "for other immediate: #X~X, type #b~8,'0B"
171 (ash (descriptor-bits des) (- sb!vm:n-widetag-bits))
172 (logand (descriptor-low des) sb!vm:widetag-mask)))
175 "for pointer: #X~X, lowtag #b~3,'0B, ~A"
176 (logior (ash (descriptor-high des) descriptor-low-bits)
177 (logandc2 (descriptor-low des) sb!vm:lowtag-mask))
179 (let ((gspace (descriptor-gspace des)))
184 ;;; Return a descriptor for a block of LENGTH bytes out of GSPACE. The
185 ;;; free word index is boosted as necessary, and if additional memory
186 ;;; is needed, we grow the GSPACE. The descriptor returned is a
187 ;;; pointer of type LOWTAG.
188 (defun allocate-cold-descriptor (gspace length lowtag)
189 (let* ((bytes (round-up length (ash 1 sb!vm:n-lowtag-bits)))
190 (old-free-word-index (gspace-free-word-index gspace))
191 (new-free-word-index (+ old-free-word-index
192 (ash bytes (- sb!vm:word-shift)))))
193 ;; Grow GSPACE as necessary until it's big enough to handle
194 ;; NEW-FREE-WORD-INDEX.
196 ((>= (length (gspace-bytes gspace))
197 (* new-free-word-index sb!vm:n-word-bytes)))
198 (expand-gspace-bytes gspace))
199 ;; Now that GSPACE is big enough, we can meaningfully grab a chunk of it.
200 (setf (gspace-free-word-index gspace) new-free-word-index)
201 (let ((ptr (+ (gspace-word-address gspace) old-free-word-index)))
202 (make-descriptor (ash ptr (- sb!vm:word-shift descriptor-low-bits))
203 (logior (ash (logand ptr
205 (- descriptor-low-bits
210 old-free-word-index))))
212 (defun descriptor-lowtag (des)
214 "the lowtag bits for DES"
215 (logand (descriptor-low des) sb!vm:lowtag-mask))
217 (defun descriptor-bits (des)
218 (logior (ash (descriptor-high des) descriptor-low-bits)
219 (descriptor-low des)))
221 (defun descriptor-fixnum (des)
222 (let ((bits (descriptor-bits des)))
223 (if (logbitp (1- sb!vm:n-word-bits) bits)
224 ;; KLUDGE: The (- SB!VM:N-WORD-BITS 2) term here looks right to
225 ;; me, and it works, but in CMU CL it was (1- SB!VM:N-WORD-BITS),
226 ;; and although that doesn't make sense for me, or work for me,
227 ;; it's hard to see how it could have been wrong, since CMU CL
228 ;; genesis worked. It would be nice to understand how this came
229 ;; to be.. -- WHN 19990901
230 (logior (ash bits -2) (ash -1 (- sb!vm:n-word-bits 2)))
234 (defun descriptor-bytes (des)
235 (gspace-bytes (descriptor-intuit-gspace des)))
236 (defun descriptor-byte-offset (des)
237 (ash (descriptor-word-offset des) sb!vm:word-shift))
239 ;;; If DESCRIPTOR-GSPACE is already set, just return that. Otherwise,
240 ;;; figure out a GSPACE which corresponds to DES, set it into
241 ;;; (DESCRIPTOR-GSPACE DES), set a consistent value into
242 ;;; (DESCRIPTOR-WORD-OFFSET DES), and return the GSPACE.
243 (declaim (ftype (function (descriptor) gspace) descriptor-intuit-gspace))
244 (defun descriptor-intuit-gspace (des)
245 (if (descriptor-gspace des)
246 (descriptor-gspace des)
247 ;; KLUDGE: It's not completely clear to me what's going on here;
248 ;; this is a literal translation from of some rather mysterious
249 ;; code from CMU CL's DESCRIPTOR-SAP function. Some explanation
250 ;; would be nice. -- WHN 19990817
251 (let ((lowtag (descriptor-lowtag des))
252 (high (descriptor-high des))
253 (low (descriptor-low des)))
254 (if (or (eql lowtag sb!vm:fun-pointer-lowtag)
255 (eql lowtag sb!vm:instance-pointer-lowtag)
256 (eql lowtag sb!vm:list-pointer-lowtag)
257 (eql lowtag sb!vm:other-pointer-lowtag))
258 (dolist (gspace (list *dynamic* *static* *read-only*)
259 (error "couldn't find a GSPACE for ~S" des))
260 ;; This code relies on the fact that GSPACEs are aligned
261 ;; such that the descriptor-low-bits low bits are zero.
262 (when (and (>= high (ash (gspace-word-address gspace)
263 (- sb!vm:word-shift descriptor-low-bits)))
264 (<= high (ash (+ (gspace-word-address gspace)
265 (gspace-free-word-index gspace))
266 (- sb!vm:word-shift descriptor-low-bits))))
267 (setf (descriptor-gspace des) gspace)
268 (setf (descriptor-word-offset des)
269 (+ (ash (- high (ash (gspace-word-address gspace)
271 descriptor-low-bits)))
272 (- descriptor-low-bits sb!vm:word-shift))
273 (ash (logandc2 low sb!vm:lowtag-mask)
274 (- sb!vm:word-shift))))
276 (error "don't even know how to look for a GSPACE for ~S" des)))))
278 (defun make-random-descriptor (value)
279 (make-descriptor (logand (ash value (- descriptor-low-bits))
282 descriptor-low-bits))))
283 (logand value (1- (ash 1 descriptor-low-bits)))))
285 (defun make-fixnum-descriptor (num)
286 (when (>= (integer-length num)
287 (1+ (- sb!vm:n-word-bits sb!vm:n-lowtag-bits)))
288 (error "~W is too big for a fixnum." num))
289 (make-random-descriptor (ash num (1- sb!vm:n-lowtag-bits))))
291 (defun make-other-immediate-descriptor (data type)
292 (make-descriptor (ash data (- sb!vm:n-widetag-bits descriptor-low-bits))
293 (logior (logand (ash data (- descriptor-low-bits
294 sb!vm:n-widetag-bits))
295 (1- (ash 1 descriptor-low-bits)))
298 (defun make-character-descriptor (data)
299 (make-other-immediate-descriptor data sb!vm:base-char-widetag))
301 (defun descriptor-beyond (des offset type)
302 (let* ((low (logior (+ (logandc2 (descriptor-low des) sb!vm:lowtag-mask)
305 (high (+ (descriptor-high des)
306 (ash low (- descriptor-low-bits)))))
307 (make-descriptor high (logand low (1- (ash 1 descriptor-low-bits))))))
309 ;;;; miscellaneous variables and other noise
311 ;;; a numeric value to be returned for undefined foreign symbols, or NIL if
312 ;;; undefined foreign symbols are to be treated as an error.
313 ;;; (In the first pass of GENESIS, needed to create a header file before
314 ;;; the C runtime can be built, various foreign symbols will necessarily
315 ;;; be undefined, but we don't need actual values for them anyway, and
316 ;;; we can just use 0 or some other placeholder. In the second pass of
317 ;;; GENESIS, all foreign symbols should be defined, so any undefined
318 ;;; foreign symbol is a problem.)
320 ;;; KLUDGE: It would probably be cleaner to rewrite GENESIS so that it
321 ;;; never tries to look up foreign symbols in the first place unless
322 ;;; it's actually creating a core file (as in the second pass) instead
323 ;;; of using this hack to allow it to go through the motions without
324 ;;; causing an error. -- WHN 20000825
325 (defvar *foreign-symbol-placeholder-value*)
327 ;;; a handle on the trap object
328 (defvar *unbound-marker*)
329 ;; was: (make-other-immediate-descriptor 0 sb!vm:unbound-marker-widetag)
331 ;;; a handle on the NIL object
332 (defvar *nil-descriptor*)
334 ;;; the head of a list of TOPLEVEL-THINGs describing stuff to be done
335 ;;; when the target Lisp starts up
337 ;;; Each TOPLEVEL-THING can be a function to be executed or a fixup or
338 ;;; loadtime value, represented by (CONS KEYWORD ..). The FILENAME
339 ;;; tells which fasl file each list element came from, for debugging
341 (defvar *current-reversed-cold-toplevels*)
343 ;;; the name of the object file currently being cold loaded (as a string, not a
344 ;;; pathname), or NIL if we're not currently cold loading any object file
345 (defvar *cold-load-filename* nil)
346 (declaim (type (or string null) *cold-load-filename*))
348 ;;; This is vestigial support for the CMU CL byte-swapping code. CMU
349 ;;; CL code tested for whether it needed to swap bytes in GENESIS by
350 ;;; comparing the byte order of *BACKEND* to the byte order of
351 ;;; *NATIVE-BACKEND*, a concept which doesn't exist in SBCL. Instead,
352 ;;; in SBCL byte order swapping would need to be explicitly requested
353 ;;; with a &KEY argument to GENESIS.
355 ;;; I'm not sure whether this is a problem or not, and I don't have a
356 ;;; machine with different byte order to test to find out for sure.
357 ;;; The version of the system which is fed to the cross-compiler is
358 ;;; now written in a subset of Common Lisp which doesn't require
359 ;;; dumping a lot of things in such a way that machine byte order
360 ;;; matters. (Mostly this is a matter of not using any specialized
361 ;;; array type unless there's portable, high-level code to dump it.)
362 ;;; If it *is* a problem, and you're trying to resurrect this code,
363 ;;; please test particularly carefully, since I haven't had a chance
364 ;;; to test the byte-swapping code at all. -- WHN 19990816
366 ;;; When this variable is non-NIL, byte-swapping is enabled wherever
367 ;;; classic GENESIS would have done it. I.e. the value of this variable
368 ;;; is the logical complement of
369 ;;; (EQ (SB!C:BACKEND-BYTE-ORDER SB!C:*NATIVE-BACKEND*)
370 ;;; (SB!C:BACKEND-BYTE-ORDER SB!C:*BACKEND*))
372 (defvar *genesis-byte-order-swap-p*)
374 ;;;; miscellaneous stuff to read and write the core memory
376 ;;; FIXME: should be DEFINE-MODIFY-MACRO
377 (defmacro cold-push (thing list)
379 "Push THING onto the given cold-load LIST."
380 `(setq ,list (cold-cons ,thing ,list)))
382 (defun maybe-byte-swap (word)
383 (declare (type (unsigned-byte 32) word))
384 (aver (= sb!vm:n-word-bits 32))
385 (aver (= sb!vm:n-byte-bits 8))
386 (if (not *genesis-byte-order-swap-p*)
388 (logior (ash (ldb (byte 8 0) word) 24)
389 (ash (ldb (byte 8 8) word) 16)
390 (ash (ldb (byte 8 16) word) 8)
391 (ldb (byte 8 24) word))))
393 (defun maybe-byte-swap-short (short)
394 (declare (type (unsigned-byte 16) short))
395 (aver (= sb!vm:n-word-bits 32))
396 (aver (= sb!vm:n-byte-bits 8))
397 (if (not *genesis-byte-order-swap-p*)
399 (logior (ash (ldb (byte 8 0) short) 8)
400 (ldb (byte 8 8) short))))
402 ;;; BYTE-VECTOR-REF-32 and friends. These are like SAP-REF-n, except
403 ;;; that instead of a SAP we use a byte vector
404 (macrolet ((make-byte-vector-ref-n
406 (let* ((name (intern (format nil "BYTE-VECTOR-REF-~A" n)))
407 (number-octets (/ n 8))
409 (loop for i from 0 to (1- number-octets)
410 collect `(ash (aref byte-vector (+ byte-index ,i))
413 (loop for i from 0 to (1- number-octets)
415 `((aref byte-vector (+ byte-index ,i))
416 (ldb (byte 8 ,(* i 8)) new-value)))))
418 (defun ,name (byte-vector byte-index)
419 (aver (= sb!vm:n-word-bits 32))
420 (aver (= sb!vm:n-byte-bits 8))
421 (ecase sb!c:*backend-byte-order*
425 (error "stub: no big-endian ports of SBCL (yet?)"))))
426 (defun (setf ,name) (new-value byte-vector byte-index)
427 (aver (= sb!vm:n-word-bits 32))
428 (aver (= sb!vm:n-byte-bits 8))
429 (ecase sb!c:*backend-byte-order*
433 (error "stub: no big-endian ports of SBCL (yet?)"))))))))
434 (make-byte-vector-ref-n 8)
435 (make-byte-vector-ref-n 16)
436 (make-byte-vector-ref-n 32))
438 (declaim (ftype (function (descriptor sb!vm:word) descriptor) read-wordindexed))
439 (defun read-wordindexed (address index)
441 "Return the value which is displaced by INDEX words from ADDRESS."
442 (let* ((gspace (descriptor-intuit-gspace address))
443 (bytes (gspace-bytes gspace))
444 (byte-index (ash (+ index (descriptor-word-offset address))
446 ;; KLUDGE: Do we really need to do byte swap here? It seems
447 ;; as though we shouldn't.. (This attempts to be a literal
448 ;; translation of CMU CL code, and I don't have a big-endian
449 ;; machine to test it.) -- WHN 19990817
450 (value (maybe-byte-swap (byte-vector-ref-32 bytes byte-index))))
451 (make-random-descriptor value)))
453 (declaim (ftype (function (descriptor) descriptor) read-memory))
454 (defun read-memory (address)
456 "Return the value at ADDRESS."
457 (read-wordindexed address 0))
459 ;;; (Note: In CMU CL, this function expected a SAP-typed ADDRESS
460 ;;; value, instead of the SAPINT we use here.)
461 (declaim (ftype (function (sb!vm:word descriptor) (values)) note-load-time-value-reference))
462 (defun note-load-time-value-reference (address marker)
463 (cold-push (cold-cons
464 (cold-intern :load-time-value-fixup)
465 (cold-cons (sapint-to-core address)
467 (number-to-core (descriptor-word-offset marker))
469 *current-reversed-cold-toplevels*)
472 (declaim (ftype (function (descriptor sb!vm:word descriptor)) write-wordindexed))
473 (defun write-wordindexed (address index value)
475 "Write VALUE displaced INDEX words from ADDRESS."
476 ;; KLUDGE: There is an algorithm (used in DESCRIPTOR-INTUIT-GSPACE)
477 ;; for calculating the value of the GSPACE slot from scratch. It
478 ;; doesn't work for all values, only some of them, but mightn't it
479 ;; be reasonable to see whether it works on VALUE before we give up
480 ;; because (DESCRIPTOR-GSPACE VALUE) isn't set? (Or failing that,
481 ;; perhaps write a comment somewhere explaining why it's not a good
482 ;; idea?) -- WHN 19990817
483 (if (and (null (descriptor-gspace value))
484 (not (null (descriptor-word-offset value))))
485 (note-load-time-value-reference (+ (logandc2 (descriptor-bits address)
487 (ash index sb!vm:word-shift))
489 ;; Note: There's a MAYBE-BYTE-SWAP in here in CMU CL, which I
490 ;; think is unnecessary now that we're doing the write
491 ;; byte-by-byte at high level. (I can't test this, though..) --
493 (let* ((bytes (gspace-bytes (descriptor-intuit-gspace address)))
494 (byte-index (ash (+ index (descriptor-word-offset address))
496 (setf (byte-vector-ref-32 bytes byte-index)
497 (maybe-byte-swap (descriptor-bits value))))))
499 (declaim (ftype (function (descriptor descriptor)) write-memory))
500 (defun write-memory (address value)
502 "Write VALUE (a DESCRIPTOR) at ADDRESS (also a DESCRIPTOR)."
503 (write-wordindexed address 0 value))
505 ;;;; allocating images of primitive objects in the cold core
507 ;;; There are three kinds of blocks of memory in the type system:
508 ;;; * Boxed objects (cons cells, structures, etc): These objects have no
509 ;;; header as all slots are descriptors.
510 ;;; * Unboxed objects (bignums): There is a single header word that contains
512 ;;; * Vector objects: There is a header word with the type, then a word for
513 ;;; the length, then the data.
514 (defun allocate-boxed-object (gspace length lowtag)
516 "Allocate LENGTH words in GSPACE and return a new descriptor of type LOWTAG
518 (allocate-cold-descriptor gspace (ash length sb!vm:word-shift) lowtag))
519 (defun allocate-unboxed-object (gspace element-bits length type)
521 "Allocate LENGTH units of ELEMENT-BITS bits plus a header word in GSPACE and
522 return an ``other-pointer'' descriptor to them. Initialize the header word
523 with the resultant length and TYPE."
524 (let* ((bytes (/ (* element-bits length) sb!vm:n-byte-bits))
525 (des (allocate-cold-descriptor gspace
526 (+ bytes sb!vm:n-word-bytes)
527 sb!vm:other-pointer-lowtag)))
529 (make-other-immediate-descriptor (ash bytes
530 (- sb!vm:word-shift))
533 (defun allocate-vector-object (gspace element-bits length type)
535 "Allocate LENGTH units of ELEMENT-BITS size plus a header plus a length slot in
536 GSPACE and return an ``other-pointer'' descriptor to them. Initialize the
537 header word with TYPE and the length slot with LENGTH."
538 ;; FIXME: Here and in ALLOCATE-UNBOXED-OBJECT, BYTES is calculated using
539 ;; #'/ instead of #'CEILING, which seems wrong.
540 (let* ((bytes (/ (* element-bits length) sb!vm:n-byte-bits))
541 (des (allocate-cold-descriptor gspace
542 (+ bytes (* 2 sb!vm:n-word-bytes))
543 sb!vm:other-pointer-lowtag)))
544 (write-memory des (make-other-immediate-descriptor 0 type))
545 (write-wordindexed des
546 sb!vm:vector-length-slot
547 (make-fixnum-descriptor length))
550 ;;;; copying simple objects into the cold core
552 (defun string-to-core (string &optional (gspace *dynamic*))
554 "Copy string into the cold core and return a descriptor to it."
555 ;; (Remember that the system convention for storage of strings leaves an
556 ;; extra null byte at the end to aid in call-out to C.)
557 (let* ((length (length string))
558 (des (allocate-vector-object gspace
561 sb!vm:simple-string-widetag))
562 (bytes (gspace-bytes gspace))
563 (offset (+ (* sb!vm:vector-data-offset sb!vm:n-word-bytes)
564 (descriptor-byte-offset des))))
565 (write-wordindexed des
566 sb!vm:vector-length-slot
567 (make-fixnum-descriptor length))
569 (setf (aref bytes (+ offset i))
570 ;; KLUDGE: There's no guarantee that the character
571 ;; encoding here will be the same as the character
572 ;; encoding on the target machine, so using CHAR-CODE as
573 ;; we do, or a bitwise copy as CMU CL code did, is sleazy.
574 ;; (To make this more portable, perhaps we could use
575 ;; indices into the sequence which is used to test whether
576 ;; a character is a STANDARD-CHAR?) -- WHN 19990817
577 (char-code (aref string i))))
578 (setf (aref bytes (+ offset length))
579 0) ; null string-termination character for C
582 (defun bignum-to-core (n)
584 "Copy a bignum to the cold core."
585 (let* ((words (ceiling (1+ (integer-length n)) sb!vm:n-word-bits))
586 (handle (allocate-unboxed-object *dynamic*
589 sb!vm:bignum-widetag)))
590 (declare (fixnum words))
591 (do ((index 1 (1+ index))
592 (remainder n (ash remainder (- sb!vm:n-word-bits))))
594 (unless (zerop (integer-length remainder))
595 ;; FIXME: Shouldn't this be a fatal error?
596 (warn "~W words of ~W were written, but ~W bits were left over."
598 (let ((word (ldb (byte sb!vm:n-word-bits 0) remainder)))
599 (write-wordindexed handle index
600 (make-descriptor (ash word (- descriptor-low-bits))
601 (ldb (byte descriptor-low-bits 0)
605 (defun number-pair-to-core (first second type)
607 "Makes a number pair of TYPE (ratio or complex) and fills it in."
608 (let ((des (allocate-unboxed-object *dynamic* sb!vm:n-word-bits 2 type)))
609 (write-wordindexed des 1 first)
610 (write-wordindexed des 2 second)
613 (defun float-to-core (x)
616 (let ((des (allocate-unboxed-object *dynamic*
618 (1- sb!vm:single-float-size)
619 sb!vm:single-float-widetag)))
620 (write-wordindexed des
621 sb!vm:single-float-value-slot
622 (make-random-descriptor (single-float-bits x)))
625 (let ((des (allocate-unboxed-object *dynamic*
627 (1- sb!vm:double-float-size)
628 sb!vm:double-float-widetag))
629 (high-bits (make-random-descriptor (double-float-high-bits x)))
630 (low-bits (make-random-descriptor (double-float-low-bits x))))
631 (ecase sb!c:*backend-byte-order*
633 (write-wordindexed des sb!vm:double-float-value-slot low-bits)
634 (write-wordindexed des (1+ sb!vm:double-float-value-slot) high-bits))
636 (write-wordindexed des sb!vm:double-float-value-slot high-bits)
637 (write-wordindexed des (1+ sb!vm:double-float-value-slot) low-bits)))
639 #!+(and long-float x86)
641 (let ((des (allocate-unboxed-object *dynamic*
643 (1- sb!vm:long-float-size)
644 sb!vm:long-float-widetag))
645 (exp-bits (make-random-descriptor (long-float-exp-bits x)))
646 (high-bits (make-random-descriptor (long-float-high-bits x)))
647 (low-bits (make-random-descriptor (long-float-low-bits x))))
648 (ecase sb!c:*backend-byte-order*
650 (write-wordindexed des sb!vm:long-float-value-slot low-bits)
651 (write-wordindexed des (1+ sb!vm:long-float-value-slot) high-bits)
652 (write-wordindexed des (+ 2 sb!vm:long-float-value-slot) exp-bits))
654 (error "LONG-FLOAT is not supported for big-endian byte order.")))
657 (defun complex-single-float-to-core (num)
658 (declare (type (complex single-float) num))
659 (let ((des (allocate-unboxed-object *dynamic* sb!vm:n-word-bits
660 (1- sb!vm:complex-single-float-size)
661 sb!vm:complex-single-float-widetag)))
662 (write-wordindexed des sb!vm:complex-single-float-real-slot
663 (make-random-descriptor (single-float-bits (realpart num))))
664 (write-wordindexed des sb!vm:complex-single-float-imag-slot
665 (make-random-descriptor (single-float-bits (imagpart num))))
668 (defun complex-double-float-to-core (num)
669 (declare (type (complex double-float) num))
670 (let ((des (allocate-unboxed-object *dynamic* sb!vm:n-word-bits
671 (1- sb!vm:complex-double-float-size)
672 sb!vm:complex-double-float-widetag)))
673 (let* ((real (realpart num))
674 (high-bits (make-random-descriptor (double-float-high-bits real)))
675 (low-bits (make-random-descriptor (double-float-low-bits real))))
676 (ecase sb!c:*backend-byte-order*
678 (write-wordindexed des sb!vm:complex-double-float-real-slot low-bits)
679 (write-wordindexed des (1+ sb!vm:complex-double-float-real-slot) high-bits))
681 (write-wordindexed des sb!vm:complex-double-float-real-slot high-bits)
682 (write-wordindexed des (1+ sb!vm:complex-double-float-real-slot) low-bits))))
683 (let* ((imag (imagpart num))
684 (high-bits (make-random-descriptor (double-float-high-bits imag)))
685 (low-bits (make-random-descriptor (double-float-low-bits imag))))
686 (ecase sb!c:*backend-byte-order*
688 (write-wordindexed des sb!vm:complex-double-float-imag-slot low-bits)
689 (write-wordindexed des (1+ sb!vm:complex-double-float-imag-slot) high-bits))
691 (write-wordindexed des sb!vm:complex-double-float-imag-slot high-bits)
692 (write-wordindexed des (1+ sb!vm:complex-double-float-imag-slot) low-bits))))
695 (defun number-to-core (number)
697 "Copy the given number to the core, or flame out if we can't deal with it."
699 (integer (if (< (integer-length number) 30)
700 (make-fixnum-descriptor number)
701 (bignum-to-core number)))
702 (ratio (number-pair-to-core (number-to-core (numerator number))
703 (number-to-core (denominator number))
704 sb!vm:ratio-widetag))
705 ((complex single-float) (complex-single-float-to-core number))
706 ((complex double-float) (complex-double-float-to-core number))
708 ((complex long-float)
709 (error "~S isn't a cold-loadable number at all!" number))
710 (complex (number-pair-to-core (number-to-core (realpart number))
711 (number-to-core (imagpart number))
712 sb!vm:complex-widetag))
713 (float (float-to-core number))
714 (t (error "~S isn't a cold-loadable number at all!" number))))
716 (declaim (ftype (function (sb!vm:word) descriptor) sap-to-core))
717 (defun sapint-to-core (sapint)
718 (let ((des (allocate-unboxed-object *dynamic*
722 (write-wordindexed des
723 sb!vm:sap-pointer-slot
724 (make-random-descriptor sapint))
727 ;;; Allocate a cons cell in GSPACE and fill it in with CAR and CDR.
728 (defun cold-cons (car cdr &optional (gspace *dynamic*))
729 (let ((dest (allocate-boxed-object gspace 2 sb!vm:list-pointer-lowtag)))
730 (write-memory dest car)
731 (write-wordindexed dest 1 cdr)
734 ;;; Make a simple-vector that holds the specified OBJECTS, and return its
736 (defun vector-in-core (&rest objects)
737 (let* ((size (length objects))
738 (result (allocate-vector-object *dynamic* sb!vm:n-word-bits size
739 sb!vm:simple-vector-widetag)))
740 (dotimes (index size)
741 (write-wordindexed result (+ index sb!vm:vector-data-offset)
747 ;;; FIXME: This should be a &KEY argument of ALLOCATE-SYMBOL.
748 (defvar *cold-symbol-allocation-gspace* nil)
750 ;;; Allocate (and initialize) a symbol.
751 (defun allocate-symbol (name)
752 (declare (simple-string name))
753 (let ((symbol (allocate-unboxed-object (or *cold-symbol-allocation-gspace*
756 (1- sb!vm:symbol-size)
757 sb!vm:symbol-header-widetag)))
758 (write-wordindexed symbol sb!vm:symbol-value-slot *unbound-marker*)
760 (write-wordindexed symbol
761 sb!vm:symbol-hash-slot
762 (make-fixnum-descriptor
763 (1+ (random sb!vm:*target-most-positive-fixnum*))))
764 (write-wordindexed symbol sb!vm:symbol-plist-slot *nil-descriptor*)
765 (write-wordindexed symbol sb!vm:symbol-name-slot
766 (string-to-core name *dynamic*))
767 (write-wordindexed symbol sb!vm:symbol-package-slot *nil-descriptor*)
770 ;;; Set the cold symbol value of SYMBOL-OR-SYMBOL-DES, which can be either a
771 ;;; descriptor of a cold symbol or (in an abbreviation for the
772 ;;; most common usage pattern) an ordinary symbol, which will be
773 ;;; automatically cold-interned.
774 (declaim (ftype (function ((or descriptor symbol) descriptor)) cold-set))
775 (defun cold-set (symbol-or-symbol-des value)
776 (let ((symbol-des (etypecase symbol-or-symbol-des
777 (descriptor symbol-or-symbol-des)
778 (symbol (cold-intern symbol-or-symbol-des)))))
779 (write-wordindexed symbol-des sb!vm:symbol-value-slot value)))
781 ;;;; layouts and type system pre-initialization
783 ;;; Since we want to be able to dump structure constants and
784 ;;; predicates with reference layouts, we need to create layouts at
785 ;;; cold-load time. We use the name to intern layouts by, and dump a
786 ;;; list of all cold layouts in *!INITIAL-LAYOUTS* so that type system
787 ;;; initialization can find them. The only thing that's tricky [sic --
788 ;;; WHN 19990816] is initializing layout's layout, which must point to
791 ;;; a map from class names to lists of
792 ;;; `(,descriptor ,name ,length ,inherits ,depth)
793 ;;; KLUDGE: It would be more understandable and maintainable to use
794 ;;; DEFSTRUCT (:TYPE LIST) here. -- WHN 19990823
795 (defvar *cold-layouts* (make-hash-table :test 'equal))
797 ;;; a map from DESCRIPTOR-BITS of cold layouts to the name, for inverting
799 (defvar *cold-layout-names* (make-hash-table :test 'eql))
801 ;;; FIXME: *COLD-LAYOUTS* and *COLD-LAYOUT-NAMES* should be
802 ;;; initialized by binding in GENESIS.
804 ;;; the descriptor for layout's layout (needed when making layouts)
805 (defvar *layout-layout*)
807 ;;; FIXME: This information should probably be pulled out of the
808 ;;; cross-compiler's tables at genesis time instead of inserted by
809 ;;; hand here as a bare numeric constant.
810 (defconstant target-layout-length 16)
812 ;;; Return a list of names created from the cold layout INHERITS data
814 (defun listify-cold-inherits (x)
815 (let ((len (descriptor-fixnum (read-wordindexed x
816 sb!vm:vector-length-slot))))
819 (let* ((des (read-wordindexed x (+ sb!vm:vector-data-offset index)))
820 (found (gethash (descriptor-bits des) *cold-layout-names*)))
823 (error "unknown descriptor at index ~S (bits = ~8,'0X)"
825 (descriptor-bits des)))))
828 (declaim (ftype (function (symbol descriptor descriptor descriptor) descriptor)
830 (defun make-cold-layout (name length inherits depthoid)
831 (let ((result (allocate-boxed-object *dynamic*
832 ;; KLUDGE: Why 1+? -- WHN 19990901
833 (1+ target-layout-length)
834 sb!vm:instance-pointer-lowtag)))
836 (make-other-immediate-descriptor
837 target-layout-length sb!vm:instance-header-widetag))
839 ;; KLUDGE: The offsets into LAYOUT below should probably be pulled out
840 ;; of the cross-compiler's tables at genesis time instead of inserted
841 ;; by hand as bare numeric constants. -- WHN ca. 19990901
843 ;; Set slot 0 = the layout of the layout.
844 (write-wordindexed result sb!vm:instance-slots-offset *layout-layout*)
846 ;; Set the immediately following slots = CLOS hash values.
848 ;; Note: CMU CL didn't set these in genesis, but instead arranged
849 ;; for them to be set at cold init time. That resulted in slightly
850 ;; kludgy-looking code, but there were at least two things to be
852 ;; 1. It put the hash values under the control of the target Lisp's
853 ;; RANDOM function, so that CLOS behavior would be nearly
854 ;; deterministic (instead of depending on the implementation of
855 ;; RANDOM in the cross-compilation host, and the state of its
856 ;; RNG when genesis begins).
857 ;; 2. It automatically ensured that all hash values in the target Lisp
858 ;; were part of the same sequence, so that we didn't have to worry
859 ;; about the possibility of the first hash value set in genesis
860 ;; being precisely equal to the some hash value set in cold init time
861 ;; (because the target Lisp RNG has advanced to precisely the same
862 ;; state that the host Lisp RNG was in earlier).
863 ;; Point 1 should not be an issue in practice because of the way we do our
864 ;; build procedure in two steps, so that the SBCL that we end up with has
865 ;; been created by another SBCL (whose RNG is under our control).
866 ;; Point 2 is more of an issue. If ANSI had provided a way to feed
867 ;; entropy into an RNG, we would have no problem: we'd just feed
868 ;; some specialized genesis-time-only pattern into the RNG state
869 ;; before using it. However, they didn't, so we have a slight
870 ;; problem. We address it by generating the hash values using a
871 ;; different algorithm than we use in ordinary operation.
872 (dotimes (i sb!kernel:layout-clos-hash-length)
873 (let (;; The expression here is pretty arbitrary, we just want
874 ;; to make sure that it's not something which is (1)
875 ;; evenly distributed and (2) not foreordained to arise in
876 ;; the target Lisp's (RANDOM-LAYOUT-CLOS-HASH) sequence
877 ;; and show up as the CLOS-HASH value of some other
880 ;; FIXME: This expression here can generate a zero value,
881 ;; and the CMU CL code goes out of its way to generate
882 ;; strictly positive values (even though the field is
883 ;; declared as an INDEX). Check that it's really OK to
884 ;; have zero values in the CLOS-HASH slots.
885 (hash-value (mod (logxor (logand (random-layout-clos-hash) 15253)
886 (logandc2 (random-layout-clos-hash) 15253)
888 ;; (The MOD here is defensive programming
889 ;; to make sure we never write an
890 ;; out-of-range value even if some joker
891 ;; sets LAYOUT-CLOS-HASH-MAX to other
892 ;; than 2^n-1 at some time in the
894 (1+ sb!kernel:layout-clos-hash-max))))
895 (write-wordindexed result
896 (+ i sb!vm:instance-slots-offset 1)
897 (make-fixnum-descriptor hash-value))))
899 ;; Set other slot values.
900 (let ((base (+ sb!vm:instance-slots-offset
901 sb!kernel:layout-clos-hash-length
903 ;; (Offset 0 is CLASS, "the class this is a layout for", which
904 ;; is uninitialized at this point.)
905 (write-wordindexed result (+ base 1) *nil-descriptor*) ; marked invalid
906 (write-wordindexed result (+ base 2) inherits)
907 (write-wordindexed result (+ base 3) depthoid)
908 (write-wordindexed result (+ base 4) length)
909 (write-wordindexed result (+ base 5) *nil-descriptor*) ; info
910 (write-wordindexed result (+ base 6) *nil-descriptor*)) ; pure
912 (setf (gethash name *cold-layouts*)
915 (descriptor-fixnum length)
916 (listify-cold-inherits inherits)
917 (descriptor-fixnum depthoid)))
918 (setf (gethash (descriptor-bits result) *cold-layout-names*) name)
922 (defun initialize-layouts ()
924 (clrhash *cold-layouts*)
926 ;; We initially create the layout of LAYOUT itself with NIL as the LAYOUT and
928 (setq *layout-layout* *nil-descriptor*)
929 (setq *layout-layout*
930 (make-cold-layout 'layout
931 (number-to-core target-layout-length)
933 ;; FIXME: hard-coded LAYOUT-DEPTHOID of LAYOUT..
935 (write-wordindexed *layout-layout*
936 sb!vm:instance-slots-offset
939 ;; Then we create the layouts that we'll need to make a correct INHERITS
940 ;; vector for the layout of LAYOUT itself..
942 ;; FIXME: The various LENGTH and DEPTHOID numbers should be taken from
943 ;; the compiler's tables, not set by hand.
950 (make-cold-layout 'instance
952 (vector-in-core t-layout)
955 (make-cold-layout 'structure-object
957 (vector-in-core t-layout i-layout)
960 (make-cold-layout 'structure!object
962 (vector-in-core t-layout i-layout so-layout)
964 (layout-inherits (vector-in-core t-layout
969 ;; ..and return to backpatch the layout of LAYOUT.
970 (setf (fourth (gethash 'layout *cold-layouts*))
971 (listify-cold-inherits layout-inherits))
972 (write-wordindexed *layout-layout*
973 ;; FIXME: hardcoded offset into layout struct
974 (+ sb!vm:instance-slots-offset
975 layout-clos-hash-length
980 ;;;; interning symbols in the cold image
982 ;;; In order to avoid having to know about the package format, we
983 ;;; build a data structure in *COLD-PACKAGE-SYMBOLS* that holds all
984 ;;; interned symbols along with info about their packages. The data
985 ;;; structure is a list of sublists, where the sublists have the
986 ;;; following format:
987 ;;; (<make-package-arglist>
988 ;;; <internal-symbols>
989 ;;; <external-symbols>
990 ;;; <imported-internal-symbols>
991 ;;; <imported-external-symbols>
992 ;;; <shadowing-symbols>)
994 ;;; KLUDGE: It would be nice to implement the sublists as instances of
995 ;;; a DEFSTRUCT (:TYPE LIST). (They'd still be lists, but at least we'd be
996 ;;; using mnemonically-named operators to access them, instead of trying
997 ;;; to remember what THIRD and FIFTH mean, and hoping that we never
998 ;;; need to change the list layout..) -- WHN 19990825
1000 ;;; an alist from packages to lists of that package's symbols to be dumped
1001 (defvar *cold-package-symbols*)
1002 (declaim (type list *cold-package-symbols*))
1004 ;;; a map from descriptors to symbols, so that we can back up. The key is the
1005 ;;; address in the target core.
1006 (defvar *cold-symbols*)
1007 (declaim (type hash-table *cold-symbols*))
1009 ;;; Return a handle on an interned symbol. If necessary allocate the
1010 ;;; symbol and record which package the symbol was referenced in. When
1011 ;;; we allocate the symbol, make sure we record a reference to the
1012 ;;; symbol in the home package so that the package gets set.
1013 (defun cold-intern (symbol &optional (package (symbol-package symbol)))
1015 ;; Anything on the cross-compilation host which refers to the target
1016 ;; machinery through the host SB-XC package can be translated to
1017 ;; something on the target which refers to the same machinery
1018 ;; through the target COMMON-LISP package.
1019 (let ((p (find-package "SB-XC")))
1020 (when (eq package p)
1021 (setf package *cl-package*))
1022 (when (eq (symbol-package symbol) p)
1023 (setf symbol (intern (symbol-name symbol) *cl-package*))))
1025 (let (;; Information about each cold-interned symbol is stored
1026 ;; in COLD-INTERN-INFO.
1027 ;; (CAR COLD-INTERN-INFO) = descriptor of symbol
1028 ;; (CDR COLD-INTERN-INFO) = list of packages, other than symbol's
1029 ;; own package, referring to symbol
1030 ;; (*COLD-PACKAGE-SYMBOLS* and *COLD-SYMBOLS* store basically the
1031 ;; same information, but with the mapping running the opposite way.)
1032 (cold-intern-info (get symbol 'cold-intern-info)))
1033 (unless cold-intern-info
1034 (cond ((eq (symbol-package symbol) package)
1035 (let ((handle (allocate-symbol (symbol-name symbol))))
1036 (setf (gethash (descriptor-bits handle) *cold-symbols*) symbol)
1037 (when (eq package *keyword-package*)
1038 (cold-set handle handle))
1039 (setq cold-intern-info
1040 (setf (get symbol 'cold-intern-info) (cons handle nil)))))
1042 (cold-intern symbol)
1043 (setq cold-intern-info (get symbol 'cold-intern-info)))))
1044 (unless (or (null package)
1045 (member package (cdr cold-intern-info)))
1046 (push package (cdr cold-intern-info))
1047 (let* ((old-cps-entry (assoc package *cold-package-symbols*))
1048 (cps-entry (or old-cps-entry
1049 (car (push (list package)
1050 *cold-package-symbols*)))))
1051 (unless old-cps-entry
1052 (/show "created *COLD-PACKAGE-SYMBOLS* entry for" package symbol))
1053 (push symbol (rest cps-entry))))
1054 (car cold-intern-info)))
1056 ;;; Construct and return a value for use as *NIL-DESCRIPTOR*.
1057 (defun make-nil-descriptor ()
1058 (let* ((des (allocate-unboxed-object
1063 (result (make-descriptor (descriptor-high des)
1064 (+ (descriptor-low des)
1065 (* 2 sb!vm:n-word-bytes)
1066 (- sb!vm:list-pointer-lowtag
1067 sb!vm:other-pointer-lowtag)))))
1068 (write-wordindexed des
1070 (make-other-immediate-descriptor
1072 sb!vm:symbol-header-widetag))
1073 (write-wordindexed des
1074 (+ 1 sb!vm:symbol-value-slot)
1076 (write-wordindexed des
1077 (+ 2 sb!vm:symbol-value-slot)
1079 (write-wordindexed des
1080 (+ 1 sb!vm:symbol-plist-slot)
1082 (write-wordindexed des
1083 (+ 1 sb!vm:symbol-name-slot)
1084 ;; This is *DYNAMIC*, and DES is *STATIC*,
1085 ;; because that's the way CMU CL did it; I'm
1086 ;; not sure whether there's an underlying
1087 ;; reason. -- WHN 1990826
1088 (string-to-core "NIL" *dynamic*))
1089 (write-wordindexed des
1090 (+ 1 sb!vm:symbol-package-slot)
1092 (setf (get nil 'cold-intern-info)
1097 ;;; Since the initial symbols must be allocated before we can intern
1098 ;;; anything else, we intern those here. We also set the value of T.
1099 (defun initialize-non-nil-symbols ()
1101 "Initialize the cold load symbol-hacking data structures."
1102 (let ((*cold-symbol-allocation-gspace* *static*))
1103 ;; Intern the others.
1104 (dolist (symbol sb!vm:*static-symbols*)
1105 (let* ((des (cold-intern symbol))
1106 (offset-wanted (sb!vm:static-symbol-offset symbol))
1107 (offset-found (- (descriptor-low des)
1108 (descriptor-low *nil-descriptor*))))
1109 (unless (= offset-wanted offset-found)
1110 ;; FIXME: should be fatal
1111 (warn "Offset from ~S to ~S is ~W, not ~W"
1116 ;; Establish the value of T.
1117 (let ((t-symbol (cold-intern t)))
1118 (cold-set t-symbol t-symbol))))
1120 ;;; a helper function for FINISH-SYMBOLS: Return a cold alist suitable
1121 ;;; to be stored in *!INITIAL-LAYOUTS*.
1122 (defun cold-list-all-layouts ()
1123 (let ((result *nil-descriptor*))
1124 (maphash (lambda (key stuff)
1125 (cold-push (cold-cons (cold-intern key)
1131 ;;; Establish initial values for magic symbols.
1133 ;;; Scan over all the symbols referenced in each package in
1134 ;;; *COLD-PACKAGE-SYMBOLS* making that for each one there's an
1135 ;;; appropriate entry in the *!INITIAL-SYMBOLS* data structure to
1137 (defun finish-symbols ()
1139 ;; I think the point of setting these functions into SYMBOL-VALUEs
1140 ;; here, instead of using SYMBOL-FUNCTION, is that in CMU CL
1141 ;; SYMBOL-FUNCTION reduces to FDEFINITION, which is a pretty
1142 ;; hairy operation (involving globaldb.lisp etc.) which we don't
1143 ;; want to invoke early in cold init. -- WHN 2001-12-05
1145 ;; FIXME: So OK, that's a reasonable reason to do something weird like
1146 ;; this, but this is still a weird thing to do, and we should change
1147 ;; the names to highlight that something weird is going on. Perhaps
1148 ;; *MAYBE-GC-FUN*, *INTERNAL-ERROR-FUN*, *HANDLE-BREAKPOINT-FUN*,
1149 ;; and *HANDLE-FUN-END-BREAKPOINT-FUN*...
1150 (macrolet ((frob (symbol)
1152 (cold-fdefinition-object (cold-intern ',symbol)))))
1154 (frob internal-error)
1155 (frob sb!di::handle-breakpoint)
1156 (frob sb!di::handle-fun-end-breakpoint))
1158 (cold-set '*current-catch-block* (make-fixnum-descriptor 0))
1159 (cold-set '*current-unwind-protect-block* (make-fixnum-descriptor 0))
1160 (cold-set '*eval-stack-top* (make-fixnum-descriptor 0))
1162 (cold-set '*free-interrupt-context-index* (make-fixnum-descriptor 0))
1164 (cold-set '*!initial-layouts* (cold-list-all-layouts))
1166 (/show "dumping packages" (mapcar #'car *cold-package-symbols*))
1167 (let ((initial-symbols *nil-descriptor*))
1168 (dolist (cold-package-symbols-entry *cold-package-symbols*)
1169 (let* ((cold-package (car cold-package-symbols-entry))
1170 (symbols (cdr cold-package-symbols-entry))
1171 (shadows (package-shadowing-symbols cold-package))
1172 (internal *nil-descriptor*)
1173 (external *nil-descriptor*)
1174 (imported-internal *nil-descriptor*)
1175 (imported-external *nil-descriptor*)
1176 (shadowing *nil-descriptor*))
1177 (/show "dumping" cold-package symbols)
1179 ;; FIXME: Add assertions here to make sure that inappropriate stuff
1180 ;; isn't being dumped:
1181 ;; * the CL-USER package
1182 ;; * the SB-COLD package
1183 ;; * any internal symbols in the CL package
1184 ;; * basically any package other than CL, KEYWORD, or the packages
1185 ;; in package-data-list.lisp-expr
1186 ;; and that the structure of the KEYWORD package (e.g. whether
1187 ;; any symbols are internal to it) matches what we want in the
1190 ;; FIXME: It seems possible that by looking at the contents of
1191 ;; packages in the target SBCL we could find which symbols in
1192 ;; package-data-lisp.lisp-expr are now obsolete. (If I
1193 ;; understand correctly, only symbols which actually have
1194 ;; definitions or which are otherwise referred to actually end
1195 ;; up in the target packages.)
1197 (dolist (symbol symbols)
1198 (let ((handle (car (get symbol 'cold-intern-info)))
1199 (imported-p (not (eq (symbol-package symbol) cold-package))))
1200 (multiple-value-bind (found where)
1201 (find-symbol (symbol-name symbol) cold-package)
1202 (unless (and where (eq found symbol))
1203 (error "The symbol ~S is not available in ~S."
1206 (when (memq symbol shadows)
1207 (cold-push handle shadowing))
1209 (:internal (if imported-p
1210 (cold-push handle imported-internal)
1211 (cold-push handle internal)))
1212 (:external (if imported-p
1213 (cold-push handle imported-external)
1214 (cold-push handle external)))))))
1215 (let ((r *nil-descriptor*))
1216 (cold-push shadowing r)
1217 (cold-push imported-external r)
1218 (cold-push imported-internal r)
1219 (cold-push external r)
1220 (cold-push internal r)
1221 (cold-push (make-make-package-args cold-package) r)
1222 ;; FIXME: It would be more space-efficient to use vectors
1223 ;; instead of lists here, and space-efficiency here would be
1224 ;; nice, since it would reduce the peak memory usage in
1225 ;; genesis and cold init.
1226 (cold-push r initial-symbols))))
1227 (cold-set '*!initial-symbols* initial-symbols))
1229 (cold-set '*!initial-fdefn-objects* (list-all-fdefn-objects))
1231 (cold-set '*!reversed-cold-toplevels* *current-reversed-cold-toplevels*)
1235 (cold-set 'sb!vm::*fp-constant-0d0* (number-to-core 0d0))
1236 (cold-set 'sb!vm::*fp-constant-1d0* (number-to-core 1d0))
1237 (cold-set 'sb!vm::*fp-constant-0s0* (number-to-core 0s0))
1238 (cold-set 'sb!vm::*fp-constant-1s0* (number-to-core 1s0))
1241 (cold-set 'sb!vm::*fp-constant-0l0* (number-to-core 0L0))
1242 (cold-set 'sb!vm::*fp-constant-1l0* (number-to-core 1L0))
1243 ;; FIXME: Why is initialization of PI conditional on LONG-FLOAT?
1244 ;; (ditto LG2, LN2, L2E, etc.)
1245 (cold-set 'sb!vm::*fp-constant-pi* (number-to-core pi))
1246 (cold-set 'sb!vm::*fp-constant-l2t* (number-to-core (log 10L0 2L0)))
1247 (cold-set 'sb!vm::*fp-constant-l2e*
1248 (number-to-core (log 2.718281828459045235360287471352662L0 2L0)))
1249 (cold-set 'sb!vm::*fp-constant-lg2* (number-to-core (log 2L0 10L0)))
1250 (cold-set 'sb!vm::*fp-constant-ln2*
1252 (log 2L0 2.718281828459045235360287471352662L0))))))
1254 ;;; Make a cold list that can be used as the arg list to MAKE-PACKAGE in order
1255 ;;; to make a package that is similar to PKG.
1256 (defun make-make-package-args (pkg)
1257 (let* ((use *nil-descriptor*)
1258 (cold-nicknames *nil-descriptor*)
1259 (res *nil-descriptor*))
1260 (dolist (u (package-use-list pkg))
1261 (when (assoc u *cold-package-symbols*)
1262 (cold-push (string-to-core (package-name u)) use)))
1263 (let* ((pkg-name (package-name pkg))
1264 ;; Make the package nickname lists for the standard packages
1265 ;; be the minimum specified by ANSI, regardless of what value
1266 ;; the cross-compilation host happens to use.
1267 (warm-nicknames (cond ((string= pkg-name "COMMON-LISP")
1269 ((string= pkg-name "COMMON-LISP-USER")
1271 ((string= pkg-name "KEYWORD")
1273 ;; For packages other than the
1274 ;; standard packages, the nickname
1275 ;; list was specified by our package
1276 ;; setup code, not by properties of
1277 ;; what cross-compilation host we
1278 ;; happened to use, and we can just
1279 ;; propagate it into the target.
1281 (package-nicknames pkg)))))
1282 (dolist (warm-nickname warm-nicknames)
1283 (cold-push (string-to-core warm-nickname) cold-nicknames)))
1285 (cold-push (number-to-core (truncate (package-internal-symbol-count pkg)
1288 (cold-push (cold-intern :internal-symbols) res)
1289 (cold-push (number-to-core (truncate (package-external-symbol-count pkg)
1292 (cold-push (cold-intern :external-symbols) res)
1294 (cold-push cold-nicknames res)
1295 (cold-push (cold-intern :nicknames) res)
1298 (cold-push (cold-intern :use) res)
1300 (cold-push (string-to-core (package-name pkg)) res)
1303 ;;;; functions and fdefinition objects
1305 ;;; a hash table mapping from fdefinition names to descriptors of cold
1308 ;;; Note: Since fdefinition names can be lists like '(SETF FOO), and
1309 ;;; we want to have only one entry per name, this must be an 'EQUAL
1310 ;;; hash table, not the default 'EQL.
1311 (defvar *cold-fdefn-objects*)
1313 (defvar *cold-fdefn-gspace* nil)
1315 ;;; Given a cold representation of a symbol, return a warm
1317 (defun warm-symbol (des)
1318 ;; Note that COLD-INTERN is responsible for keeping the
1319 ;; *COLD-SYMBOLS* table up to date, so if DES happens to refer to an
1320 ;; uninterned symbol, the code below will fail. But as long as we
1321 ;; don't need to look up uninterned symbols during bootstrapping,
1323 (multiple-value-bind (symbol found-p)
1324 (gethash (descriptor-bits des) *cold-symbols*)
1325 (declare (type symbol symbol))
1327 (error "no warm symbol"))
1330 ;;; like CL:CAR, CL:CDR, and CL:NULL but for cold values
1331 (defun cold-car (des)
1332 (aver (= (descriptor-lowtag des) sb!vm:list-pointer-lowtag))
1333 (read-wordindexed des sb!vm:cons-car-slot))
1334 (defun cold-cdr (des)
1335 (aver (= (descriptor-lowtag des) sb!vm:list-pointer-lowtag))
1336 (read-wordindexed des sb!vm:cons-cdr-slot))
1337 (defun cold-null (des)
1338 (= (descriptor-bits des)
1339 (descriptor-bits *nil-descriptor*)))
1341 ;;; Given a cold representation of a function name, return a warm
1343 (declaim (ftype (function (descriptor) (or symbol list)) warm-fun-name))
1344 (defun warm-fun-name (des)
1346 (ecase (descriptor-lowtag des)
1347 (#.sb!vm:list-pointer-lowtag
1348 (aver (not (cold-null des))) ; function named NIL? please no..
1349 ;; Do cold (DESTRUCTURING-BIND (COLD-CAR COLD-CADR) DES ..).
1350 (let* ((car-des (cold-car des))
1351 (cdr-des (cold-cdr des))
1352 (cadr-des (cold-car cdr-des))
1353 (cddr-des (cold-cdr cdr-des)))
1354 (aver (cold-null cddr-des))
1355 (list (warm-symbol car-des)
1356 (warm-symbol cadr-des))))
1357 (#.sb!vm:other-pointer-lowtag
1358 (warm-symbol des)))))
1359 (unless (legal-fun-name-p result)
1360 (error "not a legal function name: ~S" result))
1363 (defun cold-fdefinition-object (cold-name &optional leave-fn-raw)
1364 (declare (type descriptor cold-name))
1365 (let ((warm-name (warm-fun-name cold-name)))
1366 (or (gethash warm-name *cold-fdefn-objects*)
1367 (let ((fdefn (allocate-boxed-object (or *cold-fdefn-gspace* *dynamic*)
1368 (1- sb!vm:fdefn-size)
1369 sb!vm:other-pointer-lowtag)))
1371 (setf (gethash warm-name *cold-fdefn-objects*) fdefn)
1372 (write-memory fdefn (make-other-immediate-descriptor
1373 (1- sb!vm:fdefn-size) sb!vm:fdefn-widetag))
1374 (write-wordindexed fdefn sb!vm:fdefn-name-slot cold-name)
1375 (unless leave-fn-raw
1376 (write-wordindexed fdefn sb!vm:fdefn-fun-slot
1378 (write-wordindexed fdefn
1379 sb!vm:fdefn-raw-addr-slot
1380 (make-random-descriptor
1381 (cold-foreign-symbol-address-as-integer
1382 "undefined_tramp"))))
1385 ;;; Handle the at-cold-init-time, fset-for-static-linkage operation
1386 ;;; requested by FOP-FSET.
1387 (defun static-fset (cold-name defn)
1388 (declare (type descriptor cold-name))
1389 (let ((fdefn (cold-fdefinition-object cold-name t))
1390 (type (logand (descriptor-low (read-memory defn)) sb!vm:widetag-mask)))
1391 (write-wordindexed fdefn sb!vm:fdefn-fun-slot defn)
1392 (write-wordindexed fdefn
1393 sb!vm:fdefn-raw-addr-slot
1395 (#.sb!vm:simple-fun-header-widetag
1399 (make-random-descriptor
1400 (+ (logandc2 (descriptor-bits defn)
1402 (ash sb!vm:simple-fun-code-offset
1403 sb!vm:word-shift))))
1404 (#.sb!vm:closure-header-widetag
1405 (make-random-descriptor
1406 (cold-foreign-symbol-address-as-integer
1407 "closure_tramp")))))
1410 (defun initialize-static-fns ()
1411 (let ((*cold-fdefn-gspace* *static*))
1412 (dolist (sym sb!vm:*static-funs*)
1413 (let* ((fdefn (cold-fdefinition-object (cold-intern sym)))
1414 (offset (- (+ (- (descriptor-low fdefn)
1415 sb!vm:other-pointer-lowtag)
1416 (* sb!vm:fdefn-raw-addr-slot sb!vm:n-word-bytes))
1417 (descriptor-low *nil-descriptor*)))
1418 (desired (sb!vm:static-fun-offset sym)))
1419 (unless (= offset desired)
1420 ;; FIXME: should be fatal
1421 (warn "Offset from FDEFN ~S to ~S is ~W, not ~W."
1422 sym nil offset desired))))))
1424 (defun list-all-fdefn-objects ()
1425 (let ((result *nil-descriptor*))
1426 (maphash #'(lambda (key value)
1427 (declare (ignore key))
1428 (cold-push value result))
1429 *cold-fdefn-objects*)
1432 ;;;; fixups and related stuff
1434 ;;; an EQUAL hash table
1435 (defvar *cold-foreign-symbol-table*)
1436 (declaim (type hash-table *cold-foreign-symbol-table*))
1438 ;;; Read the sbcl.nm file to find the addresses for foreign-symbols in
1440 (defun load-cold-foreign-symbol-table (filename)
1441 (with-open-file (file filename)
1443 (let ((line (read-line file nil nil)))
1446 ;; UNIX symbol tables might have tabs in them, and tabs are
1447 ;; not in Common Lisp STANDARD-CHAR, so there seems to be no
1448 ;; nice portable way to deal with them within Lisp, alas.
1449 ;; Fortunately, it's easy to use UNIX command line tools like
1450 ;; sed to remove the problem, so it's not too painful for us
1451 ;; to push responsibility for converting tabs to spaces out to
1454 ;; Other non-STANDARD-CHARs are problematic for the same reason.
1455 ;; Make sure that there aren't any..
1456 (let ((ch (find-if (lambda (char)
1457 (not (typep char 'standard-char)))
1460 (error "non-STANDARD-CHAR ~S found in foreign symbol table:~%~S"
1463 (setf line (string-trim '(#\space) line))
1464 (let ((p1 (position #\space line :from-end nil))
1465 (p2 (position #\space line :from-end t)))
1466 (if (not (and p1 p2 (< p1 p2)))
1467 ;; KLUDGE: It's too messy to try to understand all
1468 ;; possible output from nm, so we just punt the lines we
1469 ;; don't recognize. We realize that there's some chance
1470 ;; that might get us in trouble someday, so we warn
1472 (warn "ignoring unrecognized line ~S in ~A" line filename)
1473 (multiple-value-bind (value name)
1474 (if (string= "0x" line :end2 2)
1475 (values (parse-integer line :start 2 :end p1 :radix 16)
1476 (subseq line (1+ p2)))
1477 (values (parse-integer line :end p1 :radix 16)
1478 (subseq line (1+ p2))))
1479 (multiple-value-bind (old-value found)
1480 (gethash name *cold-foreign-symbol-table*)
1482 (not (= old-value value)))
1483 (warn "redefining ~S from #X~X to #X~X"
1484 name old-value value)))
1485 (setf (gethash name *cold-foreign-symbol-table*) value))))))
1488 (defun cold-foreign-symbol-address-as-integer (name)
1489 (or (find-foreign-symbol-in-table name *cold-foreign-symbol-table*)
1490 *foreign-symbol-placeholder-value*
1492 (format *error-output* "~&The foreign symbol table is:~%")
1493 (maphash (lambda (k v)
1494 (format *error-output* "~&~S = #X~8X~%" k v))
1495 *cold-foreign-symbol-table*)
1496 (error "The foreign symbol ~S is undefined." name))))
1498 (defvar *cold-assembler-routines*)
1500 (defvar *cold-assembler-fixups*)
1502 (defun record-cold-assembler-routine (name address)
1503 (/xhow "in RECORD-COLD-ASSEMBLER-ROUTINE" name address)
1504 (push (cons name address)
1505 *cold-assembler-routines*))
1507 (defun record-cold-assembler-fixup (routine
1512 (push (list routine code-object offset kind)
1513 *cold-assembler-fixups*))
1515 (defun lookup-assembler-reference (symbol)
1516 (let ((value (cdr (assoc symbol *cold-assembler-routines*))))
1517 ;; FIXME: Should this be ERROR instead of WARN?
1519 (warn "Assembler routine ~S not defined." symbol))
1522 ;;; The x86 port needs to store code fixups along with code objects if
1523 ;;; they are to be moved, so fixups for code objects in the dynamic
1524 ;;; heap need to be noted.
1526 (defvar *load-time-code-fixups*)
1529 (defun note-load-time-code-fixup (code-object offset value kind)
1530 ;; If CODE-OBJECT might be moved
1531 (when (= (gspace-identifier (descriptor-intuit-gspace code-object))
1533 ;; FIXME: pushed thing should be a structure, not just a list
1534 (push (list code-object offset value kind) *load-time-code-fixups*))
1538 (defun output-load-time-code-fixups ()
1539 (dolist (fixups *load-time-code-fixups*)
1540 (let ((code-object (first fixups))
1541 (offset (second fixups))
1542 (value (third fixups))
1543 (kind (fourth fixups)))
1544 (cold-push (cold-cons
1545 (cold-intern :load-time-code-fixup)
1549 (number-to-core offset)
1551 (number-to-core value)
1554 *nil-descriptor*)))))
1555 *current-reversed-cold-toplevels*))))
1557 ;;; Given a pointer to a code object and an offset relative to the
1558 ;;; tail of the code object's header, return an offset relative to the
1559 ;;; (beginning of the) code object.
1561 ;;; FIXME: It might be clearer to reexpress
1562 ;;; (LET ((X (CALC-OFFSET CODE-OBJECT OFFSET0))) ..)
1564 ;;; (LET ((X (+ OFFSET0 (CODE-OBJECT-HEADER-N-BYTES CODE-OBJECT)))) ..).
1565 (declaim (ftype (function (descriptor sb!vm:word)) calc-offset))
1566 (defun calc-offset (code-object offset-from-tail-of-header)
1567 (let* ((header (read-memory code-object))
1568 (header-n-words (ash (descriptor-bits header)
1569 (- sb!vm:n-widetag-bits)))
1570 (header-n-bytes (ash header-n-words sb!vm:word-shift))
1571 (result (+ offset-from-tail-of-header header-n-bytes)))
1574 (declaim (ftype (function (descriptor sb!vm:word sb!vm:word keyword))
1576 (defun do-cold-fixup (code-object after-header value kind)
1577 (let* ((offset-within-code-object (calc-offset code-object after-header))
1578 (gspace-bytes (descriptor-bytes code-object))
1579 (gspace-byte-offset (+ (descriptor-byte-offset code-object)
1580 offset-within-code-object))
1581 (gspace-byte-address (gspace-byte-address
1582 (descriptor-gspace code-object))))
1583 (ecase +backend-fasl-file-implementation+
1584 ;; See CMU CL source for other formerly-supported architectures
1585 ;; (and note that you have to rewrite them to use VECTOR-REF
1586 ;; unstead of SAP-REF).
1590 (assert (zerop (ldb (byte 2 0) value)))
1591 #+nil ;; was commented out in cmucl source too. Don't know what
1592 ;; it does -dan 2001.05.03
1593 (setf (sap-ref-16 sap 0)
1594 (logior (sap-ref-16 sap 0) (ldb (byte 14 0) (ash value -2)))))
1596 (let* ((value (if (logbitp 15 value) (+ value (ash 1 16)) value))
1597 (value (if (logbitp 31 value) (+ value (ash 1 32)) value))
1598 (value (if (logbitp 47 value) (+ value (ash 1 48)) value)))
1599 (setf (byte-vector-ref-8 gspace-bytes gspace-byte-offset)
1600 (ldb (byte 8 48) value)
1601 (byte-vector-ref-8 gspace-bytes (1+ gspace-byte-offset))
1602 (ldb (byte 8 56) value))))
1604 (let* ((value (if (logbitp 15 value) (+ value (ash 1 16)) value))
1605 (value (if (logbitp 31 value) (+ value (ash 1 32)) value)))
1606 (setf (byte-vector-ref-8 gspace-bytes gspace-byte-offset)
1607 (ldb (byte 8 32) value)
1608 (byte-vector-ref-8 gspace-bytes (1+ gspace-byte-offset))
1609 (ldb (byte 8 40) value))))
1611 (let ((value (if (logbitp 15 value) (+ value (ash 1 16)) value)))
1612 (setf (byte-vector-ref-8 gspace-bytes gspace-byte-offset)
1613 (ldb (byte 8 16) value)
1614 (byte-vector-ref-8 gspace-bytes (1+ gspace-byte-offset))
1615 (ldb (byte 8 24) value))))
1617 (setf (byte-vector-ref-8 gspace-bytes gspace-byte-offset)
1618 (ldb (byte 8 0) value)
1619 (byte-vector-ref-8 gspace-bytes (1+ gspace-byte-offset))
1620 (ldb (byte 8 8) value)))))
1622 (let* ((un-fixed-up (byte-vector-ref-32 gspace-bytes
1623 gspace-byte-offset))
1624 (code-object-start-addr (logandc2 (descriptor-bits code-object)
1625 sb!vm:lowtag-mask)))
1626 (assert (= code-object-start-addr
1627 (+ gspace-byte-address
1628 (descriptor-byte-offset code-object))))
1631 (let ((fixed-up (+ value un-fixed-up)))
1632 (setf (byte-vector-ref-32 gspace-bytes gspace-byte-offset)
1634 ;; comment from CMU CL sources:
1636 ;; Note absolute fixups that point within the object.
1637 ;; KLUDGE: There seems to be an implicit assumption in
1638 ;; the old CMU CL code here, that if it doesn't point
1639 ;; before the object, it must point within the object
1640 ;; (not beyond it). It would be good to add an
1641 ;; explanation of why that's true, or an assertion that
1642 ;; it's really true, or both.
1643 (unless (< fixed-up code-object-start-addr)
1644 (note-load-time-code-fixup code-object
1648 (:relative ; (used for arguments to X86 relative CALL instruction)
1649 (let ((fixed-up (- (+ value un-fixed-up)
1652 sb!vm:n-word-bytes))) ; length of CALL argument
1653 (setf (byte-vector-ref-32 gspace-bytes gspace-byte-offset)
1655 ;; Note relative fixups that point outside the code
1656 ;; object, which is to say all relative fixups, since
1657 ;; relative addressing within a code object never needs
1659 (note-load-time-code-fixup code-object
1665 (defun resolve-assembler-fixups ()
1666 (dolist (fixup *cold-assembler-fixups*)
1667 (let* ((routine (car fixup))
1668 (value (lookup-assembler-reference routine)))
1670 (do-cold-fixup (second fixup) (third fixup) value (fourth fixup))))))
1672 ;;; *COLD-FOREIGN-SYMBOL-TABLE* becomes *!INITIAL-FOREIGN-SYMBOLS* in
1673 ;;; the core. When the core is loaded, !LOADER-COLD-INIT uses this to
1674 ;;; create *STATIC-FOREIGN-SYMBOLS*, which the code in
1675 ;;; target-load.lisp refers to.
1676 (defun linkage-info-to-core ()
1677 (let ((result *nil-descriptor*))
1678 (maphash (lambda (symbol value)
1679 (cold-push (cold-cons (string-to-core symbol)
1680 (number-to-core value))
1682 *cold-foreign-symbol-table*)
1683 (cold-set (cold-intern '*!initial-foreign-symbols*) result))
1684 (let ((result *nil-descriptor*))
1685 (dolist (rtn *cold-assembler-routines*)
1686 (cold-push (cold-cons (cold-intern (car rtn))
1687 (number-to-core (cdr rtn)))
1689 (cold-set (cold-intern '*!initial-assembler-routines*) result)))
1691 ;;;; general machinery for cold-loading FASL files
1693 ;;; FOP functions for cold loading
1694 (defvar *cold-fop-functions*
1695 ;; We start out with a copy of the ordinary *FOP-FUNCTIONS*. The
1696 ;; ones which aren't appropriate for cold load will be destructively
1698 (copy-seq *fop-functions*))
1700 (defvar *normal-fop-functions*)
1702 ;;; Cause a fop to have a special definition for cold load.
1704 ;;; This is similar to DEFINE-FOP, but unlike DEFINE-FOP, this version
1705 ;;; (1) looks up the code for this name (created by a previous
1706 ;; DEFINE-FOP) instead of creating a code, and
1707 ;;; (2) stores its definition in the *COLD-FOP-FUNCTIONS* vector,
1708 ;;; instead of storing in the *FOP-FUNCTIONS* vector.
1709 (defmacro define-cold-fop ((name &optional (pushp t)) &rest forms)
1710 (aver (member pushp '(nil t :nope)))
1711 (let ((code (get name 'fop-code))
1712 (fname (symbolicate "COLD-" name)))
1714 (error "~S is not a defined FOP." name))
1717 ,@(if (eq pushp :nope)
1719 `((with-fop-stack ,pushp ,@forms))))
1720 (setf (svref *cold-fop-functions* ,code) #',fname))))
1722 (defmacro clone-cold-fop ((name &optional (pushp t)) (small-name) &rest forms)
1723 (aver (member pushp '(nil t :nope)))
1725 (macrolet ((clone-arg () '(read-arg 4)))
1726 (define-cold-fop (,name ,pushp) ,@forms))
1727 (macrolet ((clone-arg () '(read-arg 1)))
1728 (define-cold-fop (,small-name ,pushp) ,@forms))))
1730 ;;; Cause a fop to be undefined in cold load.
1731 (defmacro not-cold-fop (name)
1732 `(define-cold-fop (,name)
1733 (error "The fop ~S is not supported in cold load." ',name)))
1735 ;;; COLD-LOAD loads stuff into the core image being built by calling
1736 ;;; LOAD-AS-FASL with the fop function table rebound to a table of cold
1737 ;;; loading functions.
1738 (defun cold-load (filename)
1740 "Load the file named by FILENAME into the cold load image being built."
1741 (let* ((*normal-fop-functions* *fop-functions*)
1742 (*fop-functions* *cold-fop-functions*)
1743 (*cold-load-filename* (etypecase filename
1745 (pathname (namestring filename)))))
1746 (with-open-file (s filename :element-type '(unsigned-byte 8))
1747 (load-as-fasl s nil nil))))
1749 ;;;; miscellaneous cold fops
1751 (define-cold-fop (fop-misc-trap) *unbound-marker*)
1753 (define-cold-fop (fop-character)
1754 (make-character-descriptor (read-arg 3)))
1755 (define-cold-fop (fop-short-character)
1756 (make-character-descriptor (read-arg 1)))
1758 (define-cold-fop (fop-empty-list) *nil-descriptor*)
1759 (define-cold-fop (fop-truth) (cold-intern t))
1761 (define-cold-fop (fop-normal-load :nope)
1762 (setq *fop-functions* *normal-fop-functions*))
1764 (define-fop (fop-maybe-cold-load 82 :nope)
1765 (when *cold-load-filename*
1766 (setq *fop-functions* *cold-fop-functions*)))
1768 (define-cold-fop (fop-maybe-cold-load :nope))
1770 (clone-cold-fop (fop-struct)
1772 (let* ((size (clone-arg))
1773 (result (allocate-boxed-object *dynamic*
1775 sb!vm:instance-pointer-lowtag)))
1776 (write-memory result (make-other-immediate-descriptor
1777 size sb!vm:instance-header-widetag))
1778 (do ((index (1- size) (1- index)))
1780 (declare (fixnum index))
1781 (write-wordindexed result
1782 (+ index sb!vm:instance-slots-offset)
1786 (define-cold-fop (fop-layout)
1787 (let* ((length-des (pop-stack))
1788 (depthoid-des (pop-stack))
1789 (cold-inherits (pop-stack))
1791 (old (gethash name *cold-layouts*)))
1792 (declare (type descriptor length-des depthoid-des cold-inherits))
1793 (declare (type symbol name))
1794 ;; If a layout of this name has been defined already
1796 ;; Enforce consistency between the previous definition and the
1797 ;; current definition, then return the previous definition.
1799 ;; FIXME: This would be more maintainable if we used
1800 ;; DEFSTRUCT (:TYPE LIST) to define COLD-LAYOUT. -- WHN 19990825
1801 (old-layout-descriptor
1807 (declare (type descriptor old-layout-descriptor))
1808 (declare (type index old-length))
1809 (declare (type fixnum old-depthoid))
1810 (declare (type list old-inherits-list))
1811 (aver (eq name old-name))
1812 (let ((length (descriptor-fixnum length-des))
1813 (inherits-list (listify-cold-inherits cold-inherits))
1814 (depthoid (descriptor-fixnum depthoid-des)))
1815 (unless (= length old-length)
1816 (error "cold loading a reference to class ~S when the compile~%~
1817 time length was ~S and current length is ~S"
1821 (unless (equal inherits-list old-inherits-list)
1822 (error "cold loading a reference to class ~S when the compile~%~
1823 time inherits were ~S~%~
1824 and current inherits are ~S"
1828 (unless (= depthoid old-depthoid)
1829 (error "cold loading a reference to class ~S when the compile~%~
1830 time inheritance depthoid was ~S and current inheritance~%~
1835 old-layout-descriptor)
1836 ;; Make a new definition from scratch.
1837 (make-cold-layout name length-des cold-inherits depthoid-des))))
1839 ;;;; cold fops for loading symbols
1841 ;;; Load a symbol SIZE characters long from *FASL-INPUT-STREAM* and
1842 ;;; intern that symbol in PACKAGE.
1843 (defun cold-load-symbol (size package)
1844 (let ((string (make-string size)))
1845 (read-string-as-bytes *fasl-input-stream* string)
1846 (cold-intern (intern string package) package)))
1848 (macrolet ((frob (name pname-len package-len)
1849 `(define-cold-fop (,name)
1850 (let ((index (read-arg ,package-len)))
1852 (cold-load-symbol (read-arg ,pname-len)
1853 (svref *current-fop-table* index)))))))
1854 (frob fop-symbol-in-package-save 4 4)
1855 (frob fop-small-symbol-in-package-save 1 4)
1856 (frob fop-symbol-in-byte-package-save 4 1)
1857 (frob fop-small-symbol-in-byte-package-save 1 1))
1859 (clone-cold-fop (fop-lisp-symbol-save)
1860 (fop-lisp-small-symbol-save)
1861 (push-fop-table (cold-load-symbol (clone-arg) *cl-package*)))
1863 (clone-cold-fop (fop-keyword-symbol-save)
1864 (fop-keyword-small-symbol-save)
1865 (push-fop-table (cold-load-symbol (clone-arg) *keyword-package*)))
1867 (clone-cold-fop (fop-uninterned-symbol-save)
1868 (fop-uninterned-small-symbol-save)
1869 (let* ((size (clone-arg))
1870 (name (make-string size)))
1871 (read-string-as-bytes *fasl-input-stream* name)
1872 (let ((symbol-des (allocate-symbol name)))
1873 (push-fop-table symbol-des))))
1875 ;;;; cold fops for loading lists
1877 ;;; Make a list of the top LENGTH things on the fop stack. The last
1878 ;;; cdr of the list is set to LAST.
1879 (defmacro cold-stack-list (length last)
1880 `(do* ((index ,length (1- index))
1881 (result ,last (cold-cons (pop-stack) result)))
1882 ((= index 0) result)
1883 (declare (fixnum index))))
1885 (define-cold-fop (fop-list)
1886 (cold-stack-list (read-arg 1) *nil-descriptor*))
1887 (define-cold-fop (fop-list*)
1888 (cold-stack-list (read-arg 1) (pop-stack)))
1889 (define-cold-fop (fop-list-1)
1890 (cold-stack-list 1 *nil-descriptor*))
1891 (define-cold-fop (fop-list-2)
1892 (cold-stack-list 2 *nil-descriptor*))
1893 (define-cold-fop (fop-list-3)
1894 (cold-stack-list 3 *nil-descriptor*))
1895 (define-cold-fop (fop-list-4)
1896 (cold-stack-list 4 *nil-descriptor*))
1897 (define-cold-fop (fop-list-5)
1898 (cold-stack-list 5 *nil-descriptor*))
1899 (define-cold-fop (fop-list-6)
1900 (cold-stack-list 6 *nil-descriptor*))
1901 (define-cold-fop (fop-list-7)
1902 (cold-stack-list 7 *nil-descriptor*))
1903 (define-cold-fop (fop-list-8)
1904 (cold-stack-list 8 *nil-descriptor*))
1905 (define-cold-fop (fop-list*-1)
1906 (cold-stack-list 1 (pop-stack)))
1907 (define-cold-fop (fop-list*-2)
1908 (cold-stack-list 2 (pop-stack)))
1909 (define-cold-fop (fop-list*-3)
1910 (cold-stack-list 3 (pop-stack)))
1911 (define-cold-fop (fop-list*-4)
1912 (cold-stack-list 4 (pop-stack)))
1913 (define-cold-fop (fop-list*-5)
1914 (cold-stack-list 5 (pop-stack)))
1915 (define-cold-fop (fop-list*-6)
1916 (cold-stack-list 6 (pop-stack)))
1917 (define-cold-fop (fop-list*-7)
1918 (cold-stack-list 7 (pop-stack)))
1919 (define-cold-fop (fop-list*-8)
1920 (cold-stack-list 8 (pop-stack)))
1922 ;;;; cold fops for loading vectors
1924 (clone-cold-fop (fop-string)
1926 (let* ((len (clone-arg))
1927 (string (make-string len)))
1928 (read-string-as-bytes *fasl-input-stream* string)
1929 (string-to-core string)))
1931 (clone-cold-fop (fop-vector)
1933 (let* ((size (clone-arg))
1934 (result (allocate-vector-object *dynamic*
1937 sb!vm:simple-vector-widetag)))
1938 (do ((index (1- size) (1- index)))
1940 (declare (fixnum index))
1941 (write-wordindexed result
1942 (+ index sb!vm:vector-data-offset)
1946 (define-cold-fop (fop-int-vector)
1947 (let* ((len (read-arg 4))
1948 (sizebits (read-arg 1))
1949 (type (case sizebits
1950 (1 sb!vm:simple-bit-vector-widetag)
1951 (2 sb!vm:simple-array-unsigned-byte-2-widetag)
1952 (4 sb!vm:simple-array-unsigned-byte-4-widetag)
1953 (8 sb!vm:simple-array-unsigned-byte-8-widetag)
1954 (16 sb!vm:simple-array-unsigned-byte-16-widetag)
1955 (32 sb!vm:simple-array-unsigned-byte-32-widetag)
1956 (t (error "losing element size: ~W" sizebits))))
1957 (result (allocate-vector-object *dynamic* sizebits len type))
1958 (start (+ (descriptor-byte-offset result)
1959 (ash sb!vm:vector-data-offset sb!vm:word-shift)))
1961 (ceiling (* len sizebits)
1962 sb!vm:n-byte-bits))))
1963 (read-sequence-or-die (descriptor-bytes result)
1969 (define-cold-fop (fop-single-float-vector)
1970 (let* ((len (read-arg 4))
1971 (result (allocate-vector-object
1975 sb!vm:simple-array-single-float-widetag))
1976 (start (+ (descriptor-byte-offset result)
1977 (ash sb!vm:vector-data-offset sb!vm:word-shift)))
1978 (end (+ start (* len sb!vm:n-word-bytes))))
1979 (read-sequence-or-die (descriptor-bytes result)
1985 (not-cold-fop fop-double-float-vector)
1986 #!+long-float (not-cold-fop fop-long-float-vector)
1987 (not-cold-fop fop-complex-single-float-vector)
1988 (not-cold-fop fop-complex-double-float-vector)
1989 #!+long-float (not-cold-fop fop-complex-long-float-vector)
1991 (define-cold-fop (fop-array)
1992 (let* ((rank (read-arg 4))
1993 (data-vector (pop-stack))
1994 (result (allocate-boxed-object *dynamic*
1995 (+ sb!vm:array-dimensions-offset rank)
1996 sb!vm:other-pointer-lowtag)))
1997 (write-memory result
1998 (make-other-immediate-descriptor rank
1999 sb!vm:simple-array-widetag))
2000 (write-wordindexed result sb!vm:array-fill-pointer-slot *nil-descriptor*)
2001 (write-wordindexed result sb!vm:array-data-slot data-vector)
2002 (write-wordindexed result sb!vm:array-displacement-slot *nil-descriptor*)
2003 (write-wordindexed result sb!vm:array-displaced-p-slot *nil-descriptor*)
2004 (let ((total-elements 1))
2005 (dotimes (axis rank)
2006 (let ((dim (pop-stack)))
2007 (unless (or (= (descriptor-lowtag dim) sb!vm:even-fixnum-lowtag)
2008 (= (descriptor-lowtag dim) sb!vm:odd-fixnum-lowtag))
2009 (error "non-fixnum dimension? (~S)" dim))
2010 (setf total-elements
2012 (logior (ash (descriptor-high dim)
2013 (- descriptor-low-bits
2014 (1- sb!vm:n-lowtag-bits)))
2015 (ash (descriptor-low dim)
2016 (- 1 sb!vm:n-lowtag-bits)))))
2017 (write-wordindexed result
2018 (+ sb!vm:array-dimensions-offset axis)
2020 (write-wordindexed result
2021 sb!vm:array-elements-slot
2022 (make-fixnum-descriptor total-elements)))
2025 ;;;; cold fops for loading numbers
2027 (defmacro define-cold-number-fop (fop)
2028 `(define-cold-fop (,fop :nope)
2029 ;; Invoke the ordinary warm version of this fop to push the
2032 ;; Replace the warm fop result with the cold image of the warm
2035 (let ((number (pop-stack)))
2036 (number-to-core number)))))
2038 (define-cold-number-fop fop-single-float)
2039 (define-cold-number-fop fop-double-float)
2040 (define-cold-number-fop fop-integer)
2041 (define-cold-number-fop fop-small-integer)
2042 (define-cold-number-fop fop-word-integer)
2043 (define-cold-number-fop fop-byte-integer)
2044 (define-cold-number-fop fop-complex-single-float)
2045 (define-cold-number-fop fop-complex-double-float)
2048 (define-cold-fop (fop-long-float)
2049 (ecase +backend-fasl-file-implementation+
2050 (:x86 ; (which has 80-bit long-float format)
2051 (prepare-for-fast-read-byte *fasl-input-stream*
2052 (let* ((des (allocate-unboxed-object *dynamic* sb!vm:n-word-bits
2053 (1- sb!vm:long-float-size)
2054 sb!vm:long-float-widetag))
2055 (low-bits (make-random-descriptor (fast-read-u-integer 4)))
2056 (high-bits (make-random-descriptor (fast-read-u-integer 4)))
2057 (exp-bits (make-random-descriptor (fast-read-s-integer 2))))
2058 (done-with-fast-read-byte)
2059 (write-wordindexed des sb!vm:long-float-value-slot low-bits)
2060 (write-wordindexed des (1+ sb!vm:long-float-value-slot) high-bits)
2061 (write-wordindexed des (+ 2 sb!vm:long-float-value-slot) exp-bits)
2063 ;; This was supported in CMU CL, but isn't currently supported in
2066 (#.sb!c:sparc-fasl-file-implementation ; 128 bit long-float format
2067 (prepare-for-fast-read-byte *fasl-input-stream*
2068 (let* ((des (allocate-unboxed-object *dynamic* sb!vm:n-word-bits
2069 (1- sb!vm:long-float-size)
2070 sb!vm:long-float-widetag))
2071 (low-bits (make-random-descriptor (fast-read-u-integer 4)))
2072 (mid-bits (make-random-descriptor (fast-read-u-integer 4)))
2073 (high-bits (make-random-descriptor (fast-read-u-integer 4)))
2074 (exp-bits (make-random-descriptor (fast-read-s-integer 4))))
2075 (done-with-fast-read-byte)
2076 (write-wordindexed des sb!vm:long-float-value-slot exp-bits)
2077 (write-wordindexed des (1+ sb!vm:long-float-value-slot) high-bits)
2078 (write-wordindexed des (+ 2 sb!vm:long-float-value-slot) mid-bits)
2079 (write-wordindexed des (+ 3 sb!vm:long-float-value-slot) low-bits)
2083 (define-cold-fop (fop-complex-long-float)
2084 (ecase +backend-fasl-file-implementation+
2085 (:x86 ; (which has 80-bit long-float format)
2086 (prepare-for-fast-read-byte *fasl-input-stream*
2087 (let* ((des (allocate-unboxed-object *dynamic* sb!vm:n-word-bits
2088 (1- sb!vm:complex-long-float-size)
2089 sb!vm:complex-long-float-widetag))
2090 (real-low-bits (make-random-descriptor (fast-read-u-integer 4)))
2091 (real-high-bits (make-random-descriptor (fast-read-u-integer 4)))
2092 (real-exp-bits (make-random-descriptor (fast-read-s-integer 2)))
2093 (imag-low-bits (make-random-descriptor (fast-read-u-integer 4)))
2094 (imag-high-bits (make-random-descriptor (fast-read-u-integer 4)))
2095 (imag-exp-bits (make-random-descriptor (fast-read-s-integer 2))))
2096 (done-with-fast-read-byte)
2097 (write-wordindexed des
2098 sb!vm:complex-long-float-real-slot
2100 (write-wordindexed des
2101 (1+ sb!vm:complex-long-float-real-slot)
2103 (write-wordindexed des
2104 (+ 2 sb!vm:complex-long-float-real-slot)
2106 (write-wordindexed des
2107 sb!vm:complex-long-float-imag-slot
2109 (write-wordindexed des
2110 (1+ sb!vm:complex-long-float-imag-slot)
2112 (write-wordindexed des
2113 (+ 2 sb!vm:complex-long-float-imag-slot)
2116 ;; This was supported in CMU CL, but isn't currently supported in SBCL.
2118 (#.sb!c:sparc-fasl-file-implementation ; 128 bit long-float format
2119 (prepare-for-fast-read-byte *fasl-input-stream*
2120 (let* ((des (allocate-unboxed-object *dynamic* sb!vm:n-word-bits
2121 (1- sb!vm:complex-long-float-size)
2122 sb!vm:complex-long-float-widetag))
2123 (real-low-bits (make-random-descriptor (fast-read-u-integer 4)))
2124 (real-mid-bits (make-random-descriptor (fast-read-u-integer 4)))
2125 (real-high-bits (make-random-descriptor (fast-read-u-integer 4)))
2126 (real-exp-bits (make-random-descriptor (fast-read-s-integer 4)))
2127 (imag-low-bits (make-random-descriptor (fast-read-u-integer 4)))
2128 (imag-mid-bits (make-random-descriptor (fast-read-u-integer 4)))
2129 (imag-high-bits (make-random-descriptor (fast-read-u-integer 4)))
2130 (imag-exp-bits (make-random-descriptor (fast-read-s-integer 4))))
2131 (done-with-fast-read-byte)
2132 (write-wordindexed des
2133 sb!vm:complex-long-float-real-slot
2135 (write-wordindexed des
2136 (1+ sb!vm:complex-long-float-real-slot)
2138 (write-wordindexed des
2139 (+ 2 sb!vm:complex-long-float-real-slot)
2141 (write-wordindexed des
2142 (+ 3 sb!vm:complex-long-float-real-slot)
2144 (write-wordindexed des
2145 sb!vm:complex-long-float-real-slot
2147 (write-wordindexed des
2148 (1+ sb!vm:complex-long-float-real-slot)
2150 (write-wordindexed des
2151 (+ 2 sb!vm:complex-long-float-real-slot)
2153 (write-wordindexed des
2154 (+ 3 sb!vm:complex-long-float-real-slot)
2158 (define-cold-fop (fop-ratio)
2159 (let ((den (pop-stack)))
2160 (number-pair-to-core (pop-stack) den sb!vm:ratio-widetag)))
2162 (define-cold-fop (fop-complex)
2163 (let ((im (pop-stack)))
2164 (number-pair-to-core (pop-stack) im sb!vm:complex-widetag)))
2166 ;;;; cold fops for calling (or not calling)
2168 (not-cold-fop fop-eval)
2169 (not-cold-fop fop-eval-for-effect)
2171 (defvar *load-time-value-counter*)
2173 (define-cold-fop (fop-funcall)
2174 (unless (= (read-arg 1) 0)
2175 (error "You can't FOP-FUNCALL arbitrary stuff in cold load."))
2176 (let ((counter *load-time-value-counter*))
2177 (cold-push (cold-cons
2178 (cold-intern :load-time-value)
2182 (number-to-core counter)
2184 *current-reversed-cold-toplevels*)
2185 (setf *load-time-value-counter* (1+ counter))
2186 (make-descriptor 0 0 nil counter)))
2188 (defun finalize-load-time-value-noise ()
2189 (cold-set (cold-intern '*!load-time-values*)
2190 (allocate-vector-object *dynamic*
2192 *load-time-value-counter*
2193 sb!vm:simple-vector-widetag)))
2195 (define-cold-fop (fop-funcall-for-effect nil)
2196 (if (= (read-arg 1) 0)
2197 (cold-push (pop-stack)
2198 *current-reversed-cold-toplevels*)
2199 (error "You can't FOP-FUNCALL arbitrary stuff in cold load.")))
2201 ;;;; cold fops for fixing up circularities
2203 (define-cold-fop (fop-rplaca nil)
2204 (let ((obj (svref *current-fop-table* (read-arg 4)))
2206 (write-memory (cold-nthcdr idx obj) (pop-stack))))
2208 (define-cold-fop (fop-rplacd nil)
2209 (let ((obj (svref *current-fop-table* (read-arg 4)))
2211 (write-wordindexed (cold-nthcdr idx obj) 1 (pop-stack))))
2213 (define-cold-fop (fop-svset nil)
2214 (let ((obj (svref *current-fop-table* (read-arg 4)))
2216 (write-wordindexed obj
2218 (ecase (descriptor-lowtag obj)
2219 (#.sb!vm:instance-pointer-lowtag 1)
2220 (#.sb!vm:other-pointer-lowtag 2)))
2223 (define-cold-fop (fop-structset nil)
2224 (let ((obj (svref *current-fop-table* (read-arg 4)))
2226 (write-wordindexed obj (1+ idx) (pop-stack))))
2228 (define-cold-fop (fop-nthcdr t)
2229 (cold-nthcdr (read-arg 4) (pop-stack)))
2231 (defun cold-nthcdr (index obj)
2233 (setq obj (read-wordindexed obj 1)))
2236 ;;;; cold fops for loading code objects and functions
2238 ;;; the names of things which have had COLD-FSET used on them already
2239 ;;; (used to make sure that we don't try to statically link a name to
2240 ;;; more than one definition)
2241 (defparameter *cold-fset-warm-names*
2242 ;; This can't be an EQL hash table because names can be conses, e.g.
2244 (make-hash-table :test 'equal))
2246 (define-cold-fop (fop-fset nil)
2247 (let* ((fn (pop-stack))
2248 (cold-name (pop-stack))
2249 (warm-name (warm-fun-name cold-name)))
2250 (if (gethash warm-name *cold-fset-warm-names*)
2251 (error "duplicate COLD-FSET for ~S" warm-name)
2252 (setf (gethash warm-name *cold-fset-warm-names*) t))
2253 (static-fset cold-name fn)))
2255 (define-cold-fop (fop-fdefinition)
2256 (cold-fdefinition-object (pop-stack)))
2258 (define-cold-fop (fop-sanctify-for-execution)
2261 ;;; Setting this variable shows what code looks like before any
2262 ;;; fixups (or function headers) are applied.
2263 #!+sb-show (defvar *show-pre-fixup-code-p* nil)
2265 ;;; FIXME: The logic here should be converted into a function
2266 ;;; COLD-CODE-FOP-GUTS (NCONST CODE-SIZE) called by DEFINE-COLD-FOP
2267 ;;; FOP-CODE and DEFINE-COLD-FOP FOP-SMALL-CODE, so that
2268 ;;; variable-capture nastiness like (LET ((NCONST ,NCONST) ..) ..)
2269 ;;; doesn't keep me awake at night.
2270 (defmacro define-cold-code-fop (name nconst code-size)
2271 `(define-cold-fop (,name)
2272 (let* ((nconst ,nconst)
2273 (code-size ,code-size)
2274 (raw-header-n-words (+ sb!vm:code-trace-table-offset-slot nconst))
2276 ;; Note: we round the number of constants up to ensure
2277 ;; that the code vector will be properly aligned.
2278 (round-up raw-header-n-words 2))
2279 (des (allocate-cold-descriptor *dynamic*
2280 (+ (ash header-n-words
2283 sb!vm:other-pointer-lowtag)))
2285 (make-other-immediate-descriptor
2286 header-n-words sb!vm:code-header-widetag))
2287 (write-wordindexed des
2288 sb!vm:code-code-size-slot
2289 (make-fixnum-descriptor
2290 (ash (+ code-size (1- (ash 1 sb!vm:word-shift)))
2291 (- sb!vm:word-shift))))
2292 (write-wordindexed des sb!vm:code-entry-points-slot *nil-descriptor*)
2293 (write-wordindexed des sb!vm:code-debug-info-slot (pop-stack))
2294 (when (oddp raw-header-n-words)
2295 (write-wordindexed des
2297 (make-random-descriptor 0)))
2298 (do ((index (1- raw-header-n-words) (1- index)))
2299 ((< index sb!vm:code-trace-table-offset-slot))
2300 (write-wordindexed des index (pop-stack)))
2301 (let* ((start (+ (descriptor-byte-offset des)
2302 (ash header-n-words sb!vm:word-shift)))
2303 (end (+ start code-size)))
2304 (read-sequence-or-die (descriptor-bytes des)
2309 (when *show-pre-fixup-code-p*
2310 (format *trace-output*
2311 "~&/raw code from code-fop ~W ~W:~%"
2314 (do ((i start (+ i sb!vm:n-word-bytes)))
2316 (format *trace-output*
2317 "/#X~8,'0x: #X~8,'0x~%"
2318 (+ i (gspace-byte-address (descriptor-gspace des)))
2319 (byte-vector-ref-32 (descriptor-bytes des) i)))))
2322 (define-cold-code-fop fop-code (read-arg 4) (read-arg 4))
2324 (define-cold-code-fop fop-small-code (read-arg 1) (read-arg 2))
2326 (clone-cold-fop (fop-alter-code nil)
2327 (fop-byte-alter-code)
2328 (let ((slot (clone-arg))
2331 (write-wordindexed code slot value)))
2333 (define-cold-fop (fop-function-entry)
2334 (let* ((type (pop-stack))
2335 (arglist (pop-stack))
2337 (code-object (pop-stack))
2338 (offset (calc-offset code-object (read-arg 4)))
2339 (fn (descriptor-beyond code-object
2341 sb!vm:fun-pointer-lowtag))
2342 (next (read-wordindexed code-object sb!vm:code-entry-points-slot)))
2343 (unless (zerop (logand offset sb!vm:lowtag-mask))
2344 ;; FIXME: This should probably become a fatal error.
2345 (warn "unaligned function entry: ~S at #X~X" name offset))
2346 (write-wordindexed code-object sb!vm:code-entry-points-slot fn)
2348 (make-other-immediate-descriptor
2349 (ash offset (- sb!vm:word-shift))
2350 sb!vm:simple-fun-header-widetag))
2351 (write-wordindexed fn
2352 sb!vm:simple-fun-self-slot
2353 ;; KLUDGE: Wiring decisions like this in at
2354 ;; this level ("if it's an x86") instead of a
2355 ;; higher level of abstraction ("if it has such
2356 ;; and such relocation peculiarities (which
2357 ;; happen to be confined to the x86)") is bad.
2358 ;; It would be nice if the code were instead
2359 ;; conditional on some more descriptive
2360 ;; feature, :STICKY-CODE or
2361 ;; :LOAD-GC-INTERACTION or something.
2363 ;; FIXME: The X86 definition of the function
2364 ;; self slot breaks everything object.tex says
2365 ;; about it. (As far as I can tell, the X86
2366 ;; definition makes it a pointer to the actual
2367 ;; code instead of a pointer back to the object
2368 ;; itself.) Ask on the mailing list whether
2369 ;; this is documented somewhere, and if not,
2370 ;; try to reverse engineer some documentation
2373 ;; a pointer back to the function object, as
2374 ;; described in CMU CL
2375 ;; src/docs/internals/object.tex
2378 ;; KLUDGE: a pointer to the actual code of the
2379 ;; object, as described nowhere that I can find
2381 (make-random-descriptor
2382 (+ (descriptor-bits fn)
2383 (- (ash sb!vm:simple-fun-code-offset
2385 ;; FIXME: We should mask out the type
2386 ;; bits, not assume we know what they
2387 ;; are and subtract them out this way.
2388 sb!vm:fun-pointer-lowtag))))
2389 (write-wordindexed fn sb!vm:simple-fun-next-slot next)
2390 (write-wordindexed fn sb!vm:simple-fun-name-slot name)
2391 (write-wordindexed fn sb!vm:simple-fun-arglist-slot arglist)
2392 (write-wordindexed fn sb!vm:simple-fun-type-slot type)
2395 (define-cold-fop (fop-foreign-fixup)
2396 (let* ((kind (pop-stack))
2397 (code-object (pop-stack))
2399 (sym (make-string len)))
2400 (read-string-as-bytes *fasl-input-stream* sym)
2401 (let ((offset (read-arg 4))
2402 (value (cold-foreign-symbol-address-as-integer sym)))
2403 (do-cold-fixup code-object offset value kind))
2406 (define-cold-fop (fop-assembler-code)
2407 (let* ((length (read-arg 4))
2409 ;; Note: we round the number of constants up to ensure that
2410 ;; the code vector will be properly aligned.
2411 (round-up sb!vm:code-constants-offset 2))
2412 (des (allocate-cold-descriptor *read-only*
2413 (+ (ash header-n-words
2416 sb!vm:other-pointer-lowtag)))
2418 (make-other-immediate-descriptor
2419 header-n-words sb!vm:code-header-widetag))
2420 (write-wordindexed des
2421 sb!vm:code-code-size-slot
2422 (make-fixnum-descriptor
2423 (ash (+ length (1- (ash 1 sb!vm:word-shift)))
2424 (- sb!vm:word-shift))))
2425 (write-wordindexed des sb!vm:code-entry-points-slot *nil-descriptor*)
2426 (write-wordindexed des sb!vm:code-debug-info-slot *nil-descriptor*)
2428 (let* ((start (+ (descriptor-byte-offset des)
2429 (ash header-n-words sb!vm:word-shift)))
2430 (end (+ start length)))
2431 (read-sequence-or-die (descriptor-bytes des)
2437 (define-cold-fop (fop-assembler-routine)
2438 (let* ((routine (pop-stack))
2440 (offset (calc-offset des (read-arg 4))))
2441 (record-cold-assembler-routine
2443 (+ (logandc2 (descriptor-bits des) sb!vm:lowtag-mask) offset))
2446 (define-cold-fop (fop-assembler-fixup)
2447 (let* ((routine (pop-stack))
2449 (code-object (pop-stack))
2450 (offset (read-arg 4)))
2451 (record-cold-assembler-fixup routine code-object offset kind)
2454 (define-cold-fop (fop-code-object-fixup)
2455 (let* ((kind (pop-stack))
2456 (code-object (pop-stack))
2457 (offset (read-arg 4))
2458 (value (descriptor-bits code-object)))
2459 (do-cold-fixup code-object offset value kind)
2462 ;;;; emitting C header file
2464 (defun tailwise-equal (string tail)
2465 (and (>= (length string) (length tail))
2466 (string= string tail :start1 (- (length string) (length tail)))))
2468 (defun write-c-header ()
2470 ;; writing beginning boilerplate
2473 '("This is a machine-generated file. Please do not edit it by hand."
2475 "This file contains low-level information about the"
2476 "internals of a particular version and configuration"
2477 "of SBCL. It is used by the C compiler to create a runtime"
2478 "support environment, an executable program in the host"
2479 "operating system's native format, which can then be used to"
2480 "load and run 'core' files, which are basically programs"
2481 "in SBCL's own format."))
2482 (format t " * ~A~%" line))
2485 (format t "#ifndef _SBCL_H_~%#define _SBCL_H_~%")
2488 ;; propagating *SHEBANG-FEATURES* into C-level #define's
2489 (dolist (shebang-feature-name (sort (mapcar #'symbol-name
2490 sb-cold:*shebang-features*)
2493 "#define LISP_FEATURE_~A~%"
2494 (substitute #\_ #\- shebang-feature-name)))
2497 ;; writing miscellaneous constants
2498 (format t "#define SBCL_CORE_VERSION_INTEGER ~D~%" sbcl-core-version-integer)
2500 "#define SBCL_VERSION_STRING ~S~%"
2501 (sb!xc:lisp-implementation-version))
2502 (format t "#define CORE_MAGIC 0x~X~%" core-magic)
2504 ;; FIXME: Other things from core.h should be defined here too:
2505 ;; #define CORE_END 3840
2506 ;; #define CORE_NDIRECTORY 3861
2507 ;; #define CORE_VALIDATE 3845
2508 ;; #define CORE_VERSION 3860
2509 ;; #define CORE_MACHINE_STATE 3862
2510 ;; (Except that some of them are obsolete and should be deleted instead.)
2512 ;; #define DYNAMIC_SPACE_ID (1)
2513 ;; #define STATIC_SPACE_ID (2)
2514 ;; #define READ_ONLY_SPACE_ID (3)
2516 ;; writing entire families of named constants from SB!VM
2517 (let ((constants nil))
2518 (do-external-symbols (symbol (find-package "SB!VM"))
2519 (when (constantp symbol)
2520 (let ((name (symbol-name symbol)))
2521 (labels (;; shared machinery
2522 (record (string priority)
2525 (symbol-value symbol)
2526 (documentation symbol 'variable))
2528 ;; machinery for old-style CMU CL Lisp-to-C
2529 ;; arbitrary renaming, being phased out in favor of
2530 ;; the newer systematic RECORD-WITH-TRANSLATED-NAME
2532 (record-with-munged-name (prefix string priority)
2533 (record (concatenate
2536 (delete #\- (string-capitalize string)))
2538 (maybe-record-with-munged-name (tail prefix priority)
2539 (when (tailwise-equal name tail)
2540 (record-with-munged-name prefix
2545 ;; machinery for new-style SBCL Lisp-to-C naming
2546 (record-with-translated-name (priority)
2547 (record (substitute #\_ #\- name)
2549 (maybe-record-with-translated-name (suffixes priority)
2550 (when (some (lambda (suffix)
2551 (tailwise-equal name suffix))
2553 (record-with-translated-name priority))))
2555 (maybe-record-with-translated-name '("-LOWTAG") 0)
2556 (maybe-record-with-translated-name '("-WIDETAG") 1)
2557 (maybe-record-with-munged-name "-FLAG" "flag_" 2)
2558 (maybe-record-with-munged-name "-TRAP" "trap_" 3)
2559 (maybe-record-with-munged-name "-SUBTYPE" "subtype_" 4)
2560 (maybe-record-with-munged-name "-SC-NUMBER" "sc_" 5)
2561 (maybe-record-with-translated-name '("-START" "-END") 6)))))
2564 #'(lambda (const1 const2)
2565 (if (= (second const1) (second const2))
2566 (< (third const1) (third const2))
2567 (< (second const1) (second const2))))))
2568 (let ((prev-priority (second (car constants))))
2569 (dolist (const constants)
2570 (destructuring-bind (name priority value doc) const
2571 (unless (= prev-priority priority)
2573 (setf prev-priority priority))
2574 (format t "#define ~A " name)
2576 ;; KLUDGE: As of sbcl-0.6.7.14, we're dumping two
2577 ;; different kinds of values here, (1) small codes
2578 ;; and (2) machine addresses. The small codes can be
2579 ;; dumped as bare integer values. The large machine
2580 ;; addresses might cause problems if they're large
2581 ;; and represented as (signed) C integers, so we
2582 ;; want to force them to be unsigned. We do that by
2583 ;; wrapping them in the LISPOBJ macro. (We could do
2584 ;; it with a bare "(unsigned)" cast, except that
2585 ;; this header file is used not only in C files, but
2586 ;; also in assembly files, which don't understand
2587 ;; the cast syntax. The LISPOBJ macro goes away in
2588 ;; assembly files, but that shouldn't matter because
2589 ;; we don't do arithmetic on address constants in
2590 ;; assembly files. See? It really is a kludge..) --
2592 (let (;; cutoff for treatment as a small code
2593 (cutoff (expt 2 16)))
2594 (cond ((minusp value)
2595 (error "stub: negative values unsupported"))
2601 (format t " /* 0x~X */~@[ /* ~A */~]~%" value doc))))
2604 ;; writing codes/strings for internal errors
2605 (format t "#define ERRORS { \\~%")
2606 ;; FIXME: Is this just DOVECTOR?
2607 (let ((internal-errors sb!c:*backend-internal-errors*))
2608 (dotimes (i (length internal-errors))
2609 (format t " ~S, /*~D*/ \\~%" (cdr (aref internal-errors i)) i)))
2610 (format t " NULL \\~%}~%")
2613 ;; writing primitive object layouts
2614 (let ((structs (sort (copy-list sb!vm:*primitive-objects*) #'string<
2615 :key #'(lambda (obj)
2617 (sb!vm:primitive-object-name obj))))))
2618 (format t "#ifndef LANGUAGE_ASSEMBLY~2%")
2619 (format t "#define LISPOBJ(x) ((lispobj)x)~2%")
2620 (dolist (obj structs)
2623 (nsubstitute #\_ #\-
2624 (string-downcase (string (sb!vm:primitive-object-name obj)))))
2625 (when (sb!vm:primitive-object-widetag obj)
2626 (format t " lispobj header;~%"))
2627 (dolist (slot (sb!vm:primitive-object-slots obj))
2628 (format t " ~A ~A~@[[1]~];~%"
2629 (getf (sb!vm:slot-options slot) :c-type "lispobj")
2630 (nsubstitute #\_ #\-
2631 (string-downcase (string (sb!vm:slot-name slot))))
2632 (sb!vm:slot-rest-p slot)))
2634 (format t "#else /* LANGUAGE_ASSEMBLY */~2%")
2635 (format t "#define LISPOBJ(thing) thing~2%")
2636 (dolist (obj structs)
2637 (let ((name (sb!vm:primitive-object-name obj))
2638 (lowtag (eval (sb!vm:primitive-object-lowtag obj))))
2640 (dolist (slot (sb!vm:primitive-object-slots obj))
2641 (format t "#define ~A_~A_OFFSET ~D~%"
2642 (substitute #\_ #\- (string name))
2643 (substitute #\_ #\- (string (sb!vm:slot-name slot)))
2644 (- (* (sb!vm:slot-offset slot) sb!vm:n-word-bytes) lowtag)))
2646 (format t "#endif /* LANGUAGE_ASSEMBLY */~2%"))
2648 ;; writing static symbol offsets
2649 (dolist (symbol (cons nil sb!vm:*static-symbols*))
2650 ;; FIXME: It would be nice to use longer names NIL and (particularly) T
2651 ;; in #define statements.
2652 (format t "#define ~A LISPOBJ(0x~X)~%"
2653 (nsubstitute #\_ #\-
2654 (remove-if #'(lambda (char)
2655 (member char '(#\% #\* #\. #\!)))
2656 (symbol-name symbol)))
2657 (if *static* ; if we ran GENESIS
2658 ;; We actually ran GENESIS, use the real value.
2659 (descriptor-bits (cold-intern symbol))
2660 ;; We didn't run GENESIS, so guess at the address.
2661 (+ sb!vm:static-space-start
2663 sb!vm:other-pointer-lowtag
2664 (if symbol (sb!vm:static-symbol-offset symbol) 0)))))
2667 (format t "~%#endif~%"))
2669 ;;;; writing map file
2671 ;;; Write a map file describing the cold load. Some of this
2672 ;;; information is subject to change due to relocating GC, but even so
2673 ;;; it can be very handy when attempting to troubleshoot the early
2674 ;;; stages of cold load.
2676 (let ((*print-pretty* nil)
2677 (*print-case* :upcase))
2678 (format t "assembler routines defined in core image:~2%")
2679 (dolist (routine (sort (copy-list *cold-assembler-routines*) #'<
2681 (format t "#X~8,'0X: ~S~%" (cdr routine) (car routine)))
2684 (maphash #'(lambda (name fdefn)
2685 (let ((fun (read-wordindexed fdefn
2686 sb!vm:fdefn-fun-slot)))
2687 (if (= (descriptor-bits fun)
2688 (descriptor-bits *nil-descriptor*))
2690 (let ((addr (read-wordindexed
2691 fdefn sb!vm:fdefn-raw-addr-slot)))
2692 (push (cons name (descriptor-bits addr))
2694 *cold-fdefn-objects*)
2695 (format t "~%~|~%initially defined functions:~2%")
2696 (setf funs (sort funs #'< :key #'cdr))
2698 (format t "0x~8,'0X: ~S #X~8,'0X~%" (cdr info) (car info)
2699 (- (cdr info) #x17)))
2702 (a note about initially undefined function references: These functions
2703 are referred to by code which is installed by GENESIS, but they are not
2704 installed by GENESIS. This is not necessarily a problem; functions can
2705 be defined later, by cold init toplevel forms, or in files compiled and
2706 loaded at warm init, or elsewhere. As long as they are defined before
2707 they are called, everything should be OK. Things are also OK if the
2708 cross-compiler knew their inline definition and used that everywhere
2709 that they were called before the out-of-line definition is installed,
2710 as is fairly common for structure accessors.)
2711 initially undefined function references:~2%")
2713 (setf undefs (sort undefs #'string< :key #'fun-name-block-name))
2714 (dolist (name undefs)
2715 (format t "~S~%" name)))
2717 (format t "~%~|~%layout names:~2%")
2719 (maphash #'(lambda (name gorp)
2720 (declare (ignore name))
2721 (stuff (cons (descriptor-bits (car gorp))
2724 (dolist (x (sort (stuff) #'< :key #'car))
2725 (apply #'format t "~8,'0X: ~S[~D]~%~10T~S~%" x))))
2729 ;;;; writing core file
2731 (defvar *core-file*)
2732 (defvar *data-page*)
2734 ;;; KLUDGE: These numbers correspond to values in core.h. If they're
2735 ;;; documented anywhere, I haven't found it. (I haven't tried very
2736 ;;; hard yet.) -- WHN 19990826
2737 (defparameter version-entry-type-code 3860)
2738 (defparameter validate-entry-type-code 3845)
2739 (defparameter directory-entry-type-code 3841)
2740 (defparameter new-directory-entry-type-code 3861)
2741 (defparameter initial-function-entry-type-code 3863)
2742 (defparameter end-entry-type-code 3840)
2744 (declaim (ftype (function (sb!vm:word) sb!vm:word) write-long))
2745 (defun write-long (num) ; FIXME: WRITE-WORD would be a better name.
2746 (ecase sb!c:*backend-byte-order*
2749 (write-byte (ldb (byte 8 (* i 8)) num) *core-file*)))
2752 (write-byte (ldb (byte 8 (* (- 3 i) 8)) num) *core-file*))))
2755 (defun advance-to-page ()
2756 (force-output *core-file*)
2757 (file-position *core-file*
2758 (round-up (file-position *core-file*)
2759 sb!c:*backend-page-size*)))
2761 (defun output-gspace (gspace)
2762 (force-output *core-file*)
2763 (let* ((posn (file-position *core-file*))
2764 (bytes (* (gspace-free-word-index gspace) sb!vm:n-word-bytes))
2765 (pages (ceiling bytes sb!c:*backend-page-size*))
2766 (total-bytes (* pages sb!c:*backend-page-size*)))
2768 (file-position *core-file*
2769 (* sb!c:*backend-page-size* (1+ *data-page*)))
2771 "writing ~S byte~:P [~S page~:P] from ~S~%"
2777 ;; Note: It is assumed that the GSPACE allocation routines always
2778 ;; allocate whole pages (of size *target-page-size*) and that any
2779 ;; empty gspace between the free pointer and the end of page will
2780 ;; be zero-filled. This will always be true under Mach on machines
2781 ;; where the page size is equal. (RT is 4K, PMAX is 4K, Sun 3 is
2783 (write-sequence (gspace-bytes gspace) *core-file* :end total-bytes)
2784 (force-output *core-file*)
2785 (file-position *core-file* posn)
2787 ;; Write part of a (new) directory entry which looks like this:
2788 ;; GSPACE IDENTIFIER
2793 (write-long (gspace-identifier gspace))
2794 (write-long (gspace-free-word-index gspace))
2795 (write-long *data-page*)
2796 (multiple-value-bind (floor rem)
2797 (floor (gspace-byte-address gspace) sb!c:*backend-page-size*)
2802 (incf *data-page* pages)))
2804 ;;; Create a core file created from the cold loaded image. (This is
2805 ;;; the "initial core file" because core files could be created later
2806 ;;; by executing SAVE-LISP in a running system, perhaps after we've
2807 ;;; added some functionality to the system.)
2808 (declaim (ftype (function (string)) write-initial-core-file))
2809 (defun write-initial-core-file (filename)
2811 (let ((filenamestring (namestring filename))
2815 "[building initial core file in ~S: ~%"
2819 (with-open-file (*core-file* filenamestring
2821 :element-type '(unsigned-byte 8)
2822 :if-exists :rename-and-delete)
2824 ;; Write the magic number.
2825 (write-long core-magic)
2827 ;; Write the Version entry.
2828 (write-long version-entry-type-code)
2830 (write-long sbcl-core-version-integer)
2832 ;; Write the New Directory entry header.
2833 (write-long new-directory-entry-type-code)
2834 (write-long 17) ; length = (5 words/space) * 3 spaces + 2 for header.
2836 (output-gspace *read-only*)
2837 (output-gspace *static*)
2838 (output-gspace *dynamic*)
2840 ;; Write the initial function.
2841 (write-long initial-function-entry-type-code)
2843 (let* ((cold-name (cold-intern '!cold-init))
2844 (cold-fdefn (cold-fdefinition-object cold-name))
2845 (initial-function (read-wordindexed cold-fdefn
2846 sb!vm:fdefn-fun-slot)))
2848 "~&/(DESCRIPTOR-BITS INITIAL-FUNCTION)=#X~X~%"
2849 (descriptor-bits initial-function))
2850 (write-long (descriptor-bits initial-function)))
2852 ;; Write the End entry.
2853 (write-long end-entry-type-code)
2856 (format t "done]~%")
2858 (/show "leaving WRITE-INITIAL-CORE-FILE")
2861 ;;;; the actual GENESIS function
2863 ;;; Read the FASL files in OBJECT-FILE-NAMES and produce a Lisp core,
2864 ;;; and/or information about a Lisp core, therefrom.
2866 ;;; input file arguments:
2867 ;;; SYMBOL-TABLE-FILE-NAME names a UNIX-style .nm file *with* *any*
2868 ;;; *tab* *characters* *converted* *to* *spaces*. (We push
2869 ;;; responsibility for removing tabs out to the caller it's
2870 ;;; trivial to remove them using UNIX command line tools like
2871 ;;; sed, whereas it's a headache to do it portably in Lisp because
2872 ;;; #\TAB is not a STANDARD-CHAR.) If this file is not supplied,
2873 ;;; a core file cannot be built (but a C header file can be).
2875 ;;; output files arguments (any of which may be NIL to suppress output):
2876 ;;; CORE-FILE-NAME gets a Lisp core.
2877 ;;; C-HEADER-FILE-NAME gets a C header file, traditionally called
2878 ;;; internals.h, which is used by the C compiler when constructing
2879 ;;; the executable which will load the core.
2880 ;;; MAP-FILE-NAME gets (?) a map file. (dunno about this -- WHN 19990815)
2882 ;;; other arguments:
2883 ;;; BYTE-ORDER-SWAP-P controls whether GENESIS tries to swap bytes
2884 ;;; in some places in the output. It's only appropriate when
2885 ;;; cross-compiling from a machine with one byte order to a
2886 ;;; machine with the opposite byte order, which is irrelevant in
2887 ;;; current (19990816) SBCL, since only the X86 architecture is
2888 ;;; supported. If you're trying to add support for more
2889 ;;; architectures, see the comments on DEFVAR
2890 ;;; *GENESIS-BYTE-ORDER-SWAP-P* for more information.
2892 ;;; FIXME: GENESIS doesn't belong in SB!VM. Perhaps in %KERNEL for now,
2893 ;;; perhaps eventually in SB-LD or SB-BOOT.
2894 (defun sb!vm:genesis (&key
2896 symbol-table-file-name
2902 (when (and core-file-name
2903 (not symbol-table-file-name))
2904 (error "can't output a core file without symbol table file input"))
2907 "~&beginning GENESIS, ~A~%"
2909 ;; Note: This output summarizing what we're doing is
2910 ;; somewhat telegraphic in style, not meant to imply that
2911 ;; we're not e.g. also creating a header file when we
2913 (format nil "creating core ~S" core-file-name)
2914 (format nil "creating header ~S" c-header-file-name)))
2916 (let* ((*cold-foreign-symbol-table* (make-hash-table :test 'equal)))
2918 ;; Read symbol table, if any.
2919 (when symbol-table-file-name
2920 (load-cold-foreign-symbol-table symbol-table-file-name))
2922 ;; Now that we've successfully read our only input file (by
2923 ;; loading the symbol table, if any), it's a good time to ensure
2924 ;; that there'll be someplace for our output files to go when
2926 (flet ((frob (filename)
2928 (ensure-directories-exist filename :verbose t))))
2929 (frob core-file-name)
2930 (frob map-file-name)
2931 (frob c-header-file-name))
2933 ;; (This shouldn't matter in normal use, since GENESIS normally
2934 ;; only runs once in any given Lisp image, but it could reduce
2935 ;; confusion if we ever experiment with running, tweaking, and
2936 ;; rerunning genesis interactively.)
2937 (do-all-symbols (sym)
2938 (remprop sym 'cold-intern-info))
2940 (let* ((*foreign-symbol-placeholder-value* (if core-file-name nil 0))
2941 (*load-time-value-counter* 0)
2942 (*genesis-byte-order-swap-p* byte-order-swap-p)
2943 (*cold-fdefn-objects* (make-hash-table :test 'equal))
2944 (*cold-symbols* (make-hash-table :test 'equal))
2945 (*cold-package-symbols* nil)
2946 (*read-only* (make-gspace :read-only
2948 sb!vm:read-only-space-start))
2949 (*static* (make-gspace :static
2951 sb!vm:static-space-start))
2952 (*dynamic* (make-gspace :dynamic
2954 sb!vm:dynamic-space-start))
2955 (*nil-descriptor* (make-nil-descriptor))
2956 (*current-reversed-cold-toplevels* *nil-descriptor*)
2957 (*unbound-marker* (make-other-immediate-descriptor
2959 sb!vm:unbound-marker-widetag))
2960 *cold-assembler-fixups*
2961 *cold-assembler-routines*
2962 #!+x86 *load-time-code-fixups*)
2964 ;; Prepare for cold load.
2965 (initialize-non-nil-symbols)
2966 (initialize-layouts)
2967 (initialize-static-fns)
2969 ;; Initialize the *COLD-SYMBOLS* system with the information
2970 ;; from package-data-list.lisp-expr and
2971 ;; common-lisp-exports.lisp-expr.
2973 ;; Why do things this way? Historically, the *COLD-SYMBOLS*
2974 ;; machinery was designed and implemented in CMU CL long before
2975 ;; I (WHN) ever heard of CMU CL. It dumped symbols and packages
2976 ;; iff they were used in the cold image. When I added the
2977 ;; package-data-list.lisp-expr mechanism, the idea was to
2978 ;; centralize all information about packages and exports. Thus,
2979 ;; it was the natural place for information even about packages
2980 ;; (such as SB!PCL and SB!WALKER) which aren't used much until
2981 ;; after cold load. This didn't quite match the CMU CL approach
2982 ;; of filling *COLD-SYMBOLS* with symbols which appear in the
2983 ;; cold image and then dumping only those symbols. By explicitly
2984 ;; putting all the symbols from package-data-list.lisp-expr and
2985 ;; from common-lisp-exports.lisp-expr into *COLD-SYMBOLS* here,
2986 ;; we feed our centralized symbol information into the old CMU
2987 ;; CL code without having to change the old CMU CL code too
2988 ;; much. (And the old CMU CL code is still useful for making
2989 ;; sure that the appropriate keywords and internal symbols end
2990 ;; up interned in the target Lisp, which is good, e.g. in order
2991 ;; to make &KEY arguments work right and in order to make
2992 ;; BACKTRACEs into target Lisp system code be legible.)
2993 (dolist (exported-name
2994 (sb-cold:read-from-file "common-lisp-exports.lisp-expr"))
2995 (cold-intern (intern exported-name *cl-package*)))
2996 (dolist (pd (sb-cold:read-from-file "package-data-list.lisp-expr"))
2997 (declare (type sb-cold:package-data pd))
2998 (let ((package (find-package (sb-cold:package-data-name pd))))
2999 (labels (;; Call FN on every node of the TREE.
3000 (mapc-on-tree (fn tree)
3002 (cons (mapc-on-tree fn (car tree))
3003 (mapc-on-tree fn (cdr tree)))
3004 (t (funcall fn tree)
3006 ;; Make sure that information about the association
3007 ;; between PACKAGE and the symbol named NAME gets
3008 ;; recorded in the cold-intern system or (as a
3009 ;; convenience when dealing with the tree structure
3010 ;; allowed in the PACKAGE-DATA-EXPORTS slot) do
3011 ;; nothing if NAME is NIL.
3014 (cold-intern (intern name package) package))))
3015 (mapc-on-tree #'chill (sb-cold:package-data-export pd))
3016 (mapc #'chill (sb-cold:package-data-reexport pd))
3017 (dolist (sublist (sb-cold:package-data-import-from pd))
3018 (destructuring-bind (package-name &rest symbol-names) sublist
3019 (declare (ignore package-name))
3020 (mapc #'chill symbol-names))))))
3023 (dolist (file-name object-file-names)
3024 (write-line (namestring file-name))
3025 (cold-load file-name))
3027 ;; Tidy up loose ends left by cold loading. ("Postpare from cold load?")
3028 (resolve-assembler-fixups)
3029 #!+x86 (output-load-time-code-fixups)
3030 (linkage-info-to-core)
3032 (/show "back from FINISH-SYMBOLS")
3033 (finalize-load-time-value-noise)
3035 ;; Tell the target Lisp how much stuff we've allocated.
3036 (cold-set 'sb!vm:*read-only-space-free-pointer*
3037 (allocate-cold-descriptor *read-only*
3039 sb!vm:even-fixnum-lowtag))
3040 (cold-set 'sb!vm:*static-space-free-pointer*
3041 (allocate-cold-descriptor *static*
3043 sb!vm:even-fixnum-lowtag))
3044 (cold-set 'sb!vm:*initial-dynamic-space-free-pointer*
3045 (allocate-cold-descriptor *dynamic*
3047 sb!vm:even-fixnum-lowtag))
3048 (/show "done setting free pointers")
3050 ;; Write results to files.
3052 ;; FIXME: I dislike this approach of redefining
3053 ;; *STANDARD-OUTPUT* instead of putting the new stream in a
3054 ;; lexical variable, and it's annoying to have WRITE-MAP (to
3055 ;; *STANDARD-OUTPUT*) not be parallel to WRITE-INITIAL-CORE-FILE
3056 ;; (to a stream explicitly passed as an argument).
3058 (with-open-file (*standard-output* map-file-name
3060 :if-exists :supersede)
3062 (when c-header-file-name
3063 (with-open-file (*standard-output* c-header-file-name
3065 :if-exists :supersede)
3067 (when core-file-name
3068 (write-initial-core-file core-file-name)))))