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)
414 collect `(ash (aref byte-vector (+ byte-index
415 ,(- number-octets 1 i)))
418 (loop for i from 0 to (1- number-octets)
420 `((aref byte-vector (+ byte-index ,i))
421 (ldb (byte 8 ,(* i 8)) new-value))))
423 (loop for i from 0 to (1- number-octets)
425 `((aref byte-vector (+ byte-index ,i))
426 (ldb (byte 8 ,(- n 8 (* i 8))) new-value)))))
428 (defun ,name (byte-vector byte-index)
429 (aver (= sb!vm:n-word-bits 32))
430 (aver (= sb!vm:n-byte-bits 8))
431 (logior ,@(ecase sb!c:*backend-byte-order*
432 (:little-endian ash-list-le)
433 (:big-endian ash-list-be))))
434 (defun (setf ,name) (new-value byte-vector byte-index)
435 (aver (= sb!vm:n-word-bits 32))
436 (aver (= sb!vm:n-byte-bits 8))
437 (setf ,@(ecase sb!c:*backend-byte-order*
438 (:little-endian setf-list-le)
439 (:big-endian setf-list-be))))))))
440 (make-byte-vector-ref-n 8)
441 (make-byte-vector-ref-n 16)
442 (make-byte-vector-ref-n 32))
444 (declaim (ftype (function (descriptor sb!vm:word) descriptor) read-wordindexed))
445 (defun read-wordindexed (address index)
447 "Return the value which is displaced by INDEX words from ADDRESS."
448 (let* ((gspace (descriptor-intuit-gspace address))
449 (bytes (gspace-bytes gspace))
450 (byte-index (ash (+ index (descriptor-word-offset address))
452 ;; KLUDGE: Do we really need to do byte swap here? It seems
453 ;; as though we shouldn't.. (This attempts to be a literal
454 ;; translation of CMU CL code, and I don't have a big-endian
455 ;; machine to test it.) -- WHN 19990817
456 (value (maybe-byte-swap (byte-vector-ref-32 bytes byte-index))))
457 (make-random-descriptor value)))
459 (declaim (ftype (function (descriptor) descriptor) read-memory))
460 (defun read-memory (address)
462 "Return the value at ADDRESS."
463 (read-wordindexed address 0))
465 ;;; (Note: In CMU CL, this function expected a SAP-typed ADDRESS
466 ;;; value, instead of the SAPINT we use here.)
467 (declaim (ftype (function (sb!vm:word descriptor) (values)) note-load-time-value-reference))
468 (defun note-load-time-value-reference (address marker)
469 (cold-push (cold-cons
470 (cold-intern :load-time-value-fixup)
471 (cold-cons (sapint-to-core address)
473 (number-to-core (descriptor-word-offset marker))
475 *current-reversed-cold-toplevels*)
478 (declaim (ftype (function (descriptor sb!vm:word descriptor)) write-wordindexed))
479 (defun write-wordindexed (address index value)
481 "Write VALUE displaced INDEX words from ADDRESS."
482 ;; KLUDGE: There is an algorithm (used in DESCRIPTOR-INTUIT-GSPACE)
483 ;; for calculating the value of the GSPACE slot from scratch. It
484 ;; doesn't work for all values, only some of them, but mightn't it
485 ;; be reasonable to see whether it works on VALUE before we give up
486 ;; because (DESCRIPTOR-GSPACE VALUE) isn't set? (Or failing that,
487 ;; perhaps write a comment somewhere explaining why it's not a good
488 ;; idea?) -- WHN 19990817
489 (if (and (null (descriptor-gspace value))
490 (not (null (descriptor-word-offset value))))
491 (note-load-time-value-reference (+ (logandc2 (descriptor-bits address)
493 (ash index sb!vm:word-shift))
495 ;; Note: There's a MAYBE-BYTE-SWAP in here in CMU CL, which I
496 ;; think is unnecessary now that we're doing the write
497 ;; byte-by-byte at high level. (I can't test this, though..) --
499 (let* ((bytes (gspace-bytes (descriptor-intuit-gspace address)))
500 (byte-index (ash (+ index (descriptor-word-offset address))
502 (setf (byte-vector-ref-32 bytes byte-index)
503 (maybe-byte-swap (descriptor-bits value))))))
505 (declaim (ftype (function (descriptor descriptor)) write-memory))
506 (defun write-memory (address value)
508 "Write VALUE (a DESCRIPTOR) at ADDRESS (also a DESCRIPTOR)."
509 (write-wordindexed address 0 value))
511 ;;;; allocating images of primitive objects in the cold core
513 ;;; There are three kinds of blocks of memory in the type system:
514 ;;; * Boxed objects (cons cells, structures, etc): These objects have no
515 ;;; header as all slots are descriptors.
516 ;;; * Unboxed objects (bignums): There is a single header word that contains
518 ;;; * Vector objects: There is a header word with the type, then a word for
519 ;;; the length, then the data.
520 (defun allocate-boxed-object (gspace length lowtag)
522 "Allocate LENGTH words in GSPACE and return a new descriptor of type LOWTAG
524 (allocate-cold-descriptor gspace (ash length sb!vm:word-shift) lowtag))
525 (defun allocate-unboxed-object (gspace element-bits length type)
527 "Allocate LENGTH units of ELEMENT-BITS bits plus a header word in GSPACE and
528 return an ``other-pointer'' descriptor to them. Initialize the header word
529 with the resultant length and TYPE."
530 (let* ((bytes (/ (* element-bits length) sb!vm:n-byte-bits))
531 (des (allocate-cold-descriptor gspace
532 (+ bytes sb!vm:n-word-bytes)
533 sb!vm:other-pointer-lowtag)))
535 (make-other-immediate-descriptor (ash bytes
536 (- sb!vm:word-shift))
539 (defun allocate-vector-object (gspace element-bits length type)
541 "Allocate LENGTH units of ELEMENT-BITS size plus a header plus a length slot in
542 GSPACE and return an ``other-pointer'' descriptor to them. Initialize the
543 header word with TYPE and the length slot with LENGTH."
544 ;; FIXME: Here and in ALLOCATE-UNBOXED-OBJECT, BYTES is calculated using
545 ;; #'/ instead of #'CEILING, which seems wrong.
546 (let* ((bytes (/ (* element-bits length) sb!vm:n-byte-bits))
547 (des (allocate-cold-descriptor gspace
548 (+ bytes (* 2 sb!vm:n-word-bytes))
549 sb!vm:other-pointer-lowtag)))
550 (write-memory des (make-other-immediate-descriptor 0 type))
551 (write-wordindexed des
552 sb!vm:vector-length-slot
553 (make-fixnum-descriptor length))
556 ;;;; copying simple objects into the cold core
558 (defun string-to-core (string &optional (gspace *dynamic*))
560 "Copy string into the cold core and return a descriptor to it."
561 ;; (Remember that the system convention for storage of strings leaves an
562 ;; extra null byte at the end to aid in call-out to C.)
563 (let* ((length (length string))
564 (des (allocate-vector-object gspace
567 sb!vm:simple-string-widetag))
568 (bytes (gspace-bytes gspace))
569 (offset (+ (* sb!vm:vector-data-offset sb!vm:n-word-bytes)
570 (descriptor-byte-offset des))))
571 (write-wordindexed des
572 sb!vm:vector-length-slot
573 (make-fixnum-descriptor length))
575 (setf (aref bytes (+ offset i))
576 ;; KLUDGE: There's no guarantee that the character
577 ;; encoding here will be the same as the character
578 ;; encoding on the target machine, so using CHAR-CODE as
579 ;; we do, or a bitwise copy as CMU CL code did, is sleazy.
580 ;; (To make this more portable, perhaps we could use
581 ;; indices into the sequence which is used to test whether
582 ;; a character is a STANDARD-CHAR?) -- WHN 19990817
583 (char-code (aref string i))))
584 (setf (aref bytes (+ offset length))
585 0) ; null string-termination character for C
588 (defun bignum-to-core (n)
590 "Copy a bignum to the cold core."
591 (let* ((words (ceiling (1+ (integer-length n)) sb!vm:n-word-bits))
592 (handle (allocate-unboxed-object *dynamic*
595 sb!vm:bignum-widetag)))
596 (declare (fixnum words))
597 (do ((index 1 (1+ index))
598 (remainder n (ash remainder (- sb!vm:n-word-bits))))
600 (unless (zerop (integer-length remainder))
601 ;; FIXME: Shouldn't this be a fatal error?
602 (warn "~W words of ~W were written, but ~W bits were left over."
604 (let ((word (ldb (byte sb!vm:n-word-bits 0) remainder)))
605 (write-wordindexed handle index
606 (make-descriptor (ash word (- descriptor-low-bits))
607 (ldb (byte descriptor-low-bits 0)
611 (defun number-pair-to-core (first second type)
613 "Makes a number pair of TYPE (ratio or complex) and fills it in."
614 (let ((des (allocate-unboxed-object *dynamic* sb!vm:n-word-bits 2 type)))
615 (write-wordindexed des 1 first)
616 (write-wordindexed des 2 second)
619 (defun float-to-core (x)
622 (let ((des (allocate-unboxed-object *dynamic*
624 (1- sb!vm:single-float-size)
625 sb!vm:single-float-widetag)))
626 (write-wordindexed des
627 sb!vm:single-float-value-slot
628 (make-random-descriptor (single-float-bits x)))
631 (let ((des (allocate-unboxed-object *dynamic*
633 (1- sb!vm:double-float-size)
634 sb!vm:double-float-widetag))
635 (high-bits (make-random-descriptor (double-float-high-bits x)))
636 (low-bits (make-random-descriptor (double-float-low-bits x))))
637 (ecase sb!c:*backend-byte-order*
639 (write-wordindexed des sb!vm:double-float-value-slot low-bits)
640 (write-wordindexed des (1+ sb!vm:double-float-value-slot) high-bits))
642 (write-wordindexed des sb!vm:double-float-value-slot high-bits)
643 (write-wordindexed des (1+ sb!vm:double-float-value-slot) low-bits)))
645 #!+(and long-float x86)
647 (let ((des (allocate-unboxed-object *dynamic*
649 (1- sb!vm:long-float-size)
650 sb!vm:long-float-widetag))
651 (exp-bits (make-random-descriptor (long-float-exp-bits x)))
652 (high-bits (make-random-descriptor (long-float-high-bits x)))
653 (low-bits (make-random-descriptor (long-float-low-bits x))))
654 (ecase sb!c:*backend-byte-order*
656 (write-wordindexed des sb!vm:long-float-value-slot low-bits)
657 (write-wordindexed des (1+ sb!vm:long-float-value-slot) high-bits)
658 (write-wordindexed des (+ 2 sb!vm:long-float-value-slot) exp-bits))
660 (error "LONG-FLOAT is not supported for big-endian byte order.")))
663 (defun complex-single-float-to-core (num)
664 (declare (type (complex single-float) num))
665 (let ((des (allocate-unboxed-object *dynamic* sb!vm:n-word-bits
666 (1- sb!vm:complex-single-float-size)
667 sb!vm:complex-single-float-widetag)))
668 (write-wordindexed des sb!vm:complex-single-float-real-slot
669 (make-random-descriptor (single-float-bits (realpart num))))
670 (write-wordindexed des sb!vm:complex-single-float-imag-slot
671 (make-random-descriptor (single-float-bits (imagpart num))))
674 (defun complex-double-float-to-core (num)
675 (declare (type (complex double-float) num))
676 (let ((des (allocate-unboxed-object *dynamic* sb!vm:n-word-bits
677 (1- sb!vm:complex-double-float-size)
678 sb!vm:complex-double-float-widetag)))
679 (let* ((real (realpart num))
680 (high-bits (make-random-descriptor (double-float-high-bits real)))
681 (low-bits (make-random-descriptor (double-float-low-bits real))))
682 (ecase sb!c:*backend-byte-order*
684 (write-wordindexed des sb!vm:complex-double-float-real-slot low-bits)
685 (write-wordindexed des (1+ sb!vm:complex-double-float-real-slot) high-bits))
687 (write-wordindexed des sb!vm:complex-double-float-real-slot high-bits)
688 (write-wordindexed des (1+ sb!vm:complex-double-float-real-slot) low-bits))))
689 (let* ((imag (imagpart num))
690 (high-bits (make-random-descriptor (double-float-high-bits imag)))
691 (low-bits (make-random-descriptor (double-float-low-bits imag))))
692 (ecase sb!c:*backend-byte-order*
694 (write-wordindexed des sb!vm:complex-double-float-imag-slot low-bits)
695 (write-wordindexed des (1+ sb!vm:complex-double-float-imag-slot) high-bits))
697 (write-wordindexed des sb!vm:complex-double-float-imag-slot high-bits)
698 (write-wordindexed des (1+ sb!vm:complex-double-float-imag-slot) low-bits))))
701 (defun number-to-core (number)
703 "Copy the given number to the core, or flame out if we can't deal with it."
705 (integer (if (< (integer-length number) 30)
706 (make-fixnum-descriptor number)
707 (bignum-to-core number)))
708 (ratio (number-pair-to-core (number-to-core (numerator number))
709 (number-to-core (denominator number))
710 sb!vm:ratio-widetag))
711 ((complex single-float) (complex-single-float-to-core number))
712 ((complex double-float) (complex-double-float-to-core number))
714 ((complex long-float)
715 (error "~S isn't a cold-loadable number at all!" number))
716 (complex (number-pair-to-core (number-to-core (realpart number))
717 (number-to-core (imagpart number))
718 sb!vm:complex-widetag))
719 (float (float-to-core number))
720 (t (error "~S isn't a cold-loadable number at all!" number))))
722 (declaim (ftype (function (sb!vm:word) descriptor) sap-to-core))
723 (defun sapint-to-core (sapint)
724 (let ((des (allocate-unboxed-object *dynamic*
728 (write-wordindexed des
729 sb!vm:sap-pointer-slot
730 (make-random-descriptor sapint))
733 ;;; Allocate a cons cell in GSPACE and fill it in with CAR and CDR.
734 (defun cold-cons (car cdr &optional (gspace *dynamic*))
735 (let ((dest (allocate-boxed-object gspace 2 sb!vm:list-pointer-lowtag)))
736 (write-memory dest car)
737 (write-wordindexed dest 1 cdr)
740 ;;; Make a simple-vector that holds the specified OBJECTS, and return its
742 (defun vector-in-core (&rest objects)
743 (let* ((size (length objects))
744 (result (allocate-vector-object *dynamic* sb!vm:n-word-bits size
745 sb!vm:simple-vector-widetag)))
746 (dotimes (index size)
747 (write-wordindexed result (+ index sb!vm:vector-data-offset)
753 ;;; FIXME: This should be a &KEY argument of ALLOCATE-SYMBOL.
754 (defvar *cold-symbol-allocation-gspace* nil)
756 ;;; Allocate (and initialize) a symbol.
757 (defun allocate-symbol (name)
758 (declare (simple-string name))
759 (let ((symbol (allocate-unboxed-object (or *cold-symbol-allocation-gspace*
762 (1- sb!vm:symbol-size)
763 sb!vm:symbol-header-widetag)))
764 (write-wordindexed symbol sb!vm:symbol-value-slot *unbound-marker*)
766 (write-wordindexed symbol
767 sb!vm:symbol-hash-slot
768 (make-fixnum-descriptor
769 (1+ (random sb!vm:*target-most-positive-fixnum*))))
770 (write-wordindexed symbol sb!vm:symbol-plist-slot *nil-descriptor*)
771 (write-wordindexed symbol sb!vm:symbol-name-slot
772 (string-to-core name *dynamic*))
773 (write-wordindexed symbol sb!vm:symbol-package-slot *nil-descriptor*)
776 ;;; Set the cold symbol value of SYMBOL-OR-SYMBOL-DES, which can be either a
777 ;;; descriptor of a cold symbol or (in an abbreviation for the
778 ;;; most common usage pattern) an ordinary symbol, which will be
779 ;;; automatically cold-interned.
780 (declaim (ftype (function ((or descriptor symbol) descriptor)) cold-set))
781 (defun cold-set (symbol-or-symbol-des value)
782 (let ((symbol-des (etypecase symbol-or-symbol-des
783 (descriptor symbol-or-symbol-des)
784 (symbol (cold-intern symbol-or-symbol-des)))))
785 (write-wordindexed symbol-des sb!vm:symbol-value-slot value)))
787 ;;;; layouts and type system pre-initialization
789 ;;; Since we want to be able to dump structure constants and
790 ;;; predicates with reference layouts, we need to create layouts at
791 ;;; cold-load time. We use the name to intern layouts by, and dump a
792 ;;; list of all cold layouts in *!INITIAL-LAYOUTS* so that type system
793 ;;; initialization can find them. The only thing that's tricky [sic --
794 ;;; WHN 19990816] is initializing layout's layout, which must point to
797 ;;; a map from class names to lists of
798 ;;; `(,descriptor ,name ,length ,inherits ,depth)
799 ;;; KLUDGE: It would be more understandable and maintainable to use
800 ;;; DEFSTRUCT (:TYPE LIST) here. -- WHN 19990823
801 (defvar *cold-layouts* (make-hash-table :test 'equal))
803 ;;; a map from DESCRIPTOR-BITS of cold layouts to the name, for inverting
805 (defvar *cold-layout-names* (make-hash-table :test 'eql))
807 ;;; FIXME: *COLD-LAYOUTS* and *COLD-LAYOUT-NAMES* should be
808 ;;; initialized by binding in GENESIS.
810 ;;; the descriptor for layout's layout (needed when making layouts)
811 (defvar *layout-layout*)
813 ;;; FIXME: This information should probably be pulled out of the
814 ;;; cross-compiler's tables at genesis time instead of inserted by
815 ;;; hand here as a bare numeric constant.
816 (defconstant target-layout-length 16)
818 ;;; Return a list of names created from the cold layout INHERITS data
820 (defun listify-cold-inherits (x)
821 (let ((len (descriptor-fixnum (read-wordindexed x
822 sb!vm:vector-length-slot))))
825 (let* ((des (read-wordindexed x (+ sb!vm:vector-data-offset index)))
826 (found (gethash (descriptor-bits des) *cold-layout-names*)))
829 (error "unknown descriptor at index ~S (bits = ~8,'0X)"
831 (descriptor-bits des)))))
834 (declaim (ftype (function (symbol descriptor descriptor descriptor) descriptor)
836 (defun make-cold-layout (name length inherits depthoid)
837 (let ((result (allocate-boxed-object *dynamic*
838 ;; KLUDGE: Why 1+? -- WHN 19990901
839 (1+ target-layout-length)
840 sb!vm:instance-pointer-lowtag)))
842 (make-other-immediate-descriptor
843 target-layout-length sb!vm:instance-header-widetag))
845 ;; KLUDGE: The offsets into LAYOUT below should probably be pulled out
846 ;; of the cross-compiler's tables at genesis time instead of inserted
847 ;; by hand as bare numeric constants. -- WHN ca. 19990901
849 ;; Set slot 0 = the layout of the layout.
850 (write-wordindexed result sb!vm:instance-slots-offset *layout-layout*)
852 ;; Set the immediately following slots = CLOS hash values.
854 ;; Note: CMU CL didn't set these in genesis, but instead arranged
855 ;; for them to be set at cold init time. That resulted in slightly
856 ;; kludgy-looking code, but there were at least two things to be
858 ;; 1. It put the hash values under the control of the target Lisp's
859 ;; RANDOM function, so that CLOS behavior would be nearly
860 ;; deterministic (instead of depending on the implementation of
861 ;; RANDOM in the cross-compilation host, and the state of its
862 ;; RNG when genesis begins).
863 ;; 2. It automatically ensured that all hash values in the target Lisp
864 ;; were part of the same sequence, so that we didn't have to worry
865 ;; about the possibility of the first hash value set in genesis
866 ;; being precisely equal to the some hash value set in cold init time
867 ;; (because the target Lisp RNG has advanced to precisely the same
868 ;; state that the host Lisp RNG was in earlier).
869 ;; Point 1 should not be an issue in practice because of the way we do our
870 ;; build procedure in two steps, so that the SBCL that we end up with has
871 ;; been created by another SBCL (whose RNG is under our control).
872 ;; Point 2 is more of an issue. If ANSI had provided a way to feed
873 ;; entropy into an RNG, we would have no problem: we'd just feed
874 ;; some specialized genesis-time-only pattern into the RNG state
875 ;; before using it. However, they didn't, so we have a slight
876 ;; problem. We address it by generating the hash values using a
877 ;; different algorithm than we use in ordinary operation.
878 (dotimes (i sb!kernel:layout-clos-hash-length)
879 (let (;; The expression here is pretty arbitrary, we just want
880 ;; to make sure that it's not something which is (1)
881 ;; evenly distributed and (2) not foreordained to arise in
882 ;; the target Lisp's (RANDOM-LAYOUT-CLOS-HASH) sequence
883 ;; and show up as the CLOS-HASH value of some other
886 ;; FIXME: This expression here can generate a zero value,
887 ;; and the CMU CL code goes out of its way to generate
888 ;; strictly positive values (even though the field is
889 ;; declared as an INDEX). Check that it's really OK to
890 ;; have zero values in the CLOS-HASH slots.
891 (hash-value (mod (logxor (logand (random-layout-clos-hash) 15253)
892 (logandc2 (random-layout-clos-hash) 15253)
894 ;; (The MOD here is defensive programming
895 ;; to make sure we never write an
896 ;; out-of-range value even if some joker
897 ;; sets LAYOUT-CLOS-HASH-MAX to other
898 ;; than 2^n-1 at some time in the
900 (1+ sb!kernel:layout-clos-hash-max))))
901 (write-wordindexed result
902 (+ i sb!vm:instance-slots-offset 1)
903 (make-fixnum-descriptor hash-value))))
905 ;; Set other slot values.
906 (let ((base (+ sb!vm:instance-slots-offset
907 sb!kernel:layout-clos-hash-length
909 ;; (Offset 0 is CLASS, "the class this is a layout for", which
910 ;; is uninitialized at this point.)
911 (write-wordindexed result (+ base 1) *nil-descriptor*) ; marked invalid
912 (write-wordindexed result (+ base 2) inherits)
913 (write-wordindexed result (+ base 3) depthoid)
914 (write-wordindexed result (+ base 4) length)
915 (write-wordindexed result (+ base 5) *nil-descriptor*) ; info
916 (write-wordindexed result (+ base 6) *nil-descriptor*)) ; pure
918 (setf (gethash name *cold-layouts*)
921 (descriptor-fixnum length)
922 (listify-cold-inherits inherits)
923 (descriptor-fixnum depthoid)))
924 (setf (gethash (descriptor-bits result) *cold-layout-names*) name)
928 (defun initialize-layouts ()
930 (clrhash *cold-layouts*)
932 ;; We initially create the layout of LAYOUT itself with NIL as the LAYOUT and
934 (setq *layout-layout* *nil-descriptor*)
935 (setq *layout-layout*
936 (make-cold-layout 'layout
937 (number-to-core target-layout-length)
939 ;; FIXME: hard-coded LAYOUT-DEPTHOID of LAYOUT..
941 (write-wordindexed *layout-layout*
942 sb!vm:instance-slots-offset
945 ;; Then we create the layouts that we'll need to make a correct INHERITS
946 ;; vector for the layout of LAYOUT itself..
948 ;; FIXME: The various LENGTH and DEPTHOID numbers should be taken from
949 ;; the compiler's tables, not set by hand.
956 (make-cold-layout 'instance
958 (vector-in-core t-layout)
961 (make-cold-layout 'structure-object
963 (vector-in-core t-layout i-layout)
966 (make-cold-layout 'structure!object
968 (vector-in-core t-layout i-layout so-layout)
970 (layout-inherits (vector-in-core t-layout
975 ;; ..and return to backpatch the layout of LAYOUT.
976 (setf (fourth (gethash 'layout *cold-layouts*))
977 (listify-cold-inherits layout-inherits))
978 (write-wordindexed *layout-layout*
979 ;; FIXME: hardcoded offset into layout struct
980 (+ sb!vm:instance-slots-offset
981 layout-clos-hash-length
986 ;;;; interning symbols in the cold image
988 ;;; In order to avoid having to know about the package format, we
989 ;;; build a data structure in *COLD-PACKAGE-SYMBOLS* that holds all
990 ;;; interned symbols along with info about their packages. The data
991 ;;; structure is a list of sublists, where the sublists have the
992 ;;; following format:
993 ;;; (<make-package-arglist>
994 ;;; <internal-symbols>
995 ;;; <external-symbols>
996 ;;; <imported-internal-symbols>
997 ;;; <imported-external-symbols>
998 ;;; <shadowing-symbols>)
1000 ;;; KLUDGE: It would be nice to implement the sublists as instances of
1001 ;;; a DEFSTRUCT (:TYPE LIST). (They'd still be lists, but at least we'd be
1002 ;;; using mnemonically-named operators to access them, instead of trying
1003 ;;; to remember what THIRD and FIFTH mean, and hoping that we never
1004 ;;; need to change the list layout..) -- WHN 19990825
1006 ;;; an alist from packages to lists of that package's symbols to be dumped
1007 (defvar *cold-package-symbols*)
1008 (declaim (type list *cold-package-symbols*))
1010 ;;; a map from descriptors to symbols, so that we can back up. The key is the
1011 ;;; address in the target core.
1012 (defvar *cold-symbols*)
1013 (declaim (type hash-table *cold-symbols*))
1015 ;;; Return a handle on an interned symbol. If necessary allocate the
1016 ;;; symbol and record which package the symbol was referenced in. When
1017 ;;; we allocate the symbol, make sure we record a reference to the
1018 ;;; symbol in the home package so that the package gets set.
1019 (defun cold-intern (symbol &optional (package (symbol-package symbol)))
1021 ;; Anything on the cross-compilation host which refers to the target
1022 ;; machinery through the host SB-XC package should be translated to
1023 ;; something on the target which refers to the same machinery
1024 ;; through the target COMMON-LISP package.
1025 (let ((p (find-package "SB-XC")))
1026 (when (eq package p)
1027 (setf package *cl-package*))
1028 (when (eq (symbol-package symbol) p)
1029 (setf symbol (intern (symbol-name symbol) *cl-package*))))
1031 ;; Make sure that the symbol has an appropriate package. In
1032 ;; particular, catch the so-easy-to-make error of typing something
1033 ;; like SB-KERNEL:%BYTE-BLT in cold sources when what you really
1034 ;; need is SB!KERNEL:%BYTE-BLT.
1035 (let ((package-name (package-name package)))
1036 (cond ((find package-name '("COMMON-LISP" "KEYWORD") :test #'string=)
1039 ((string= package-name "SB!" :end1 3 :end2 3)
1040 ;; That looks OK, too. (All the target-code packages
1041 ;; have names like that.)
1044 ;; looks bad: maybe COMMON-LISP-USER? maybe an extension
1045 ;; package in the xc host? something we can't think of
1046 ;; a valid reason to dump, anyway...
1047 (bug "internal error: PACKAGE-NAME=~S looks too much like a typo."
1050 (let (;; Information about each cold-interned symbol is stored
1051 ;; in COLD-INTERN-INFO.
1052 ;; (CAR COLD-INTERN-INFO) = descriptor of symbol
1053 ;; (CDR COLD-INTERN-INFO) = list of packages, other than symbol's
1054 ;; own package, referring to symbol
1055 ;; (*COLD-PACKAGE-SYMBOLS* and *COLD-SYMBOLS* store basically the
1056 ;; same information, but with the mapping running the opposite way.)
1057 (cold-intern-info (get symbol 'cold-intern-info)))
1058 (unless cold-intern-info
1059 (cond ((eq (symbol-package symbol) package)
1060 (let ((handle (allocate-symbol (symbol-name symbol))))
1061 (setf (gethash (descriptor-bits handle) *cold-symbols*) symbol)
1062 (when (eq package *keyword-package*)
1063 (cold-set handle handle))
1064 (setq cold-intern-info
1065 (setf (get symbol 'cold-intern-info) (cons handle nil)))))
1067 (cold-intern symbol)
1068 (setq cold-intern-info (get symbol 'cold-intern-info)))))
1069 (unless (or (null package)
1070 (member package (cdr cold-intern-info)))
1071 (push package (cdr cold-intern-info))
1072 (let* ((old-cps-entry (assoc package *cold-package-symbols*))
1073 (cps-entry (or old-cps-entry
1074 (car (push (list package)
1075 *cold-package-symbols*)))))
1076 (unless old-cps-entry
1077 (/show "created *COLD-PACKAGE-SYMBOLS* entry for" package symbol))
1078 (push symbol (rest cps-entry))))
1079 (car cold-intern-info)))
1081 ;;; Construct and return a value for use as *NIL-DESCRIPTOR*.
1082 (defun make-nil-descriptor ()
1083 (let* ((des (allocate-unboxed-object
1088 (result (make-descriptor (descriptor-high des)
1089 (+ (descriptor-low des)
1090 (* 2 sb!vm:n-word-bytes)
1091 (- sb!vm:list-pointer-lowtag
1092 sb!vm:other-pointer-lowtag)))))
1093 (write-wordindexed des
1095 (make-other-immediate-descriptor
1097 sb!vm:symbol-header-widetag))
1098 (write-wordindexed des
1099 (+ 1 sb!vm:symbol-value-slot)
1101 (write-wordindexed des
1102 (+ 2 sb!vm:symbol-value-slot)
1104 (write-wordindexed des
1105 (+ 1 sb!vm:symbol-plist-slot)
1107 (write-wordindexed des
1108 (+ 1 sb!vm:symbol-name-slot)
1109 ;; This is *DYNAMIC*, and DES is *STATIC*,
1110 ;; because that's the way CMU CL did it; I'm
1111 ;; not sure whether there's an underlying
1112 ;; reason. -- WHN 1990826
1113 (string-to-core "NIL" *dynamic*))
1114 (write-wordindexed des
1115 (+ 1 sb!vm:symbol-package-slot)
1117 (setf (get nil 'cold-intern-info)
1122 ;;; Since the initial symbols must be allocated before we can intern
1123 ;;; anything else, we intern those here. We also set the value of T.
1124 (defun initialize-non-nil-symbols ()
1126 "Initialize the cold load symbol-hacking data structures."
1127 (let ((*cold-symbol-allocation-gspace* *static*))
1128 ;; Intern the others.
1129 (dolist (symbol sb!vm:*static-symbols*)
1130 (let* ((des (cold-intern symbol))
1131 (offset-wanted (sb!vm:static-symbol-offset symbol))
1132 (offset-found (- (descriptor-low des)
1133 (descriptor-low *nil-descriptor*))))
1134 (unless (= offset-wanted offset-found)
1135 ;; FIXME: should be fatal
1136 (warn "Offset from ~S to ~S is ~W, not ~W"
1141 ;; Establish the value of T.
1142 (let ((t-symbol (cold-intern t)))
1143 (cold-set t-symbol t-symbol))))
1145 ;;; a helper function for FINISH-SYMBOLS: Return a cold alist suitable
1146 ;;; to be stored in *!INITIAL-LAYOUTS*.
1147 (defun cold-list-all-layouts ()
1148 (let ((result *nil-descriptor*))
1149 (maphash (lambda (key stuff)
1150 (cold-push (cold-cons (cold-intern key)
1156 ;;; Establish initial values for magic symbols.
1158 ;;; Scan over all the symbols referenced in each package in
1159 ;;; *COLD-PACKAGE-SYMBOLS* making that for each one there's an
1160 ;;; appropriate entry in the *!INITIAL-SYMBOLS* data structure to
1162 (defun finish-symbols ()
1164 ;; I think the point of setting these functions into SYMBOL-VALUEs
1165 ;; here, instead of using SYMBOL-FUNCTION, is that in CMU CL
1166 ;; SYMBOL-FUNCTION reduces to FDEFINITION, which is a pretty
1167 ;; hairy operation (involving globaldb.lisp etc.) which we don't
1168 ;; want to invoke early in cold init. -- WHN 2001-12-05
1170 ;; FIXME: So OK, that's a reasonable reason to do something weird like
1171 ;; this, but this is still a weird thing to do, and we should change
1172 ;; the names to highlight that something weird is going on. Perhaps
1173 ;; *MAYBE-GC-FUN*, *INTERNAL-ERROR-FUN*, *HANDLE-BREAKPOINT-FUN*,
1174 ;; and *HANDLE-FUN-END-BREAKPOINT-FUN*...
1175 (macrolet ((frob (symbol)
1177 (cold-fdefinition-object (cold-intern ',symbol)))))
1179 (frob internal-error)
1180 (frob sb!di::handle-breakpoint)
1181 (frob sb!di::handle-fun-end-breakpoint))
1183 (cold-set '*current-catch-block* (make-fixnum-descriptor 0))
1184 (cold-set '*current-unwind-protect-block* (make-fixnum-descriptor 0))
1186 (cold-set '*free-interrupt-context-index* (make-fixnum-descriptor 0))
1188 (cold-set '*!initial-layouts* (cold-list-all-layouts))
1190 (/show "dumping packages" (mapcar #'car *cold-package-symbols*))
1191 (let ((initial-symbols *nil-descriptor*))
1192 (dolist (cold-package-symbols-entry *cold-package-symbols*)
1193 (let* ((cold-package (car cold-package-symbols-entry))
1194 (symbols (cdr cold-package-symbols-entry))
1195 (shadows (package-shadowing-symbols cold-package))
1196 (internal *nil-descriptor*)
1197 (external *nil-descriptor*)
1198 (imported-internal *nil-descriptor*)
1199 (imported-external *nil-descriptor*)
1200 (shadowing *nil-descriptor*))
1201 (/show "dumping" cold-package symbols)
1203 ;; FIXME: Add assertions here to make sure that inappropriate stuff
1204 ;; isn't being dumped:
1205 ;; * the CL-USER package
1206 ;; * the SB-COLD package
1207 ;; * any internal symbols in the CL package
1208 ;; * basically any package other than CL, KEYWORD, or the packages
1209 ;; in package-data-list.lisp-expr
1210 ;; and that the structure of the KEYWORD package (e.g. whether
1211 ;; any symbols are internal to it) matches what we want in the
1214 ;; FIXME: It seems possible that by looking at the contents of
1215 ;; packages in the target SBCL we could find which symbols in
1216 ;; package-data-lisp.lisp-expr are now obsolete. (If I
1217 ;; understand correctly, only symbols which actually have
1218 ;; definitions or which are otherwise referred to actually end
1219 ;; up in the target packages.)
1221 (dolist (symbol symbols)
1222 (let ((handle (car (get symbol 'cold-intern-info)))
1223 (imported-p (not (eq (symbol-package symbol) cold-package))))
1224 (multiple-value-bind (found where)
1225 (find-symbol (symbol-name symbol) cold-package)
1226 (unless (and where (eq found symbol))
1227 (error "The symbol ~S is not available in ~S."
1230 (when (memq symbol shadows)
1231 (cold-push handle shadowing))
1233 (:internal (if imported-p
1234 (cold-push handle imported-internal)
1235 (cold-push handle internal)))
1236 (:external (if imported-p
1237 (cold-push handle imported-external)
1238 (cold-push handle external)))))))
1239 (let ((r *nil-descriptor*))
1240 (cold-push shadowing r)
1241 (cold-push imported-external r)
1242 (cold-push imported-internal r)
1243 (cold-push external r)
1244 (cold-push internal r)
1245 (cold-push (make-make-package-args cold-package) r)
1246 ;; FIXME: It would be more space-efficient to use vectors
1247 ;; instead of lists here, and space-efficiency here would be
1248 ;; nice, since it would reduce the peak memory usage in
1249 ;; genesis and cold init.
1250 (cold-push r initial-symbols))))
1251 (cold-set '*!initial-symbols* initial-symbols))
1253 (cold-set '*!initial-fdefn-objects* (list-all-fdefn-objects))
1255 (cold-set '*!reversed-cold-toplevels* *current-reversed-cold-toplevels*)
1259 (cold-set 'sb!vm::*fp-constant-0d0* (number-to-core 0d0))
1260 (cold-set 'sb!vm::*fp-constant-1d0* (number-to-core 1d0))
1261 (cold-set 'sb!vm::*fp-constant-0s0* (number-to-core 0s0))
1262 (cold-set 'sb!vm::*fp-constant-1s0* (number-to-core 1s0))
1265 (cold-set 'sb!vm::*fp-constant-0l0* (number-to-core 0L0))
1266 (cold-set 'sb!vm::*fp-constant-1l0* (number-to-core 1L0))
1267 ;; FIXME: Why is initialization of PI conditional on LONG-FLOAT?
1268 ;; (ditto LG2, LN2, L2E, etc.)
1269 (cold-set 'sb!vm::*fp-constant-pi* (number-to-core pi))
1270 (cold-set 'sb!vm::*fp-constant-l2t* (number-to-core (log 10L0 2L0)))
1271 (cold-set 'sb!vm::*fp-constant-l2e*
1272 (number-to-core (log 2.718281828459045235360287471352662L0 2L0)))
1273 (cold-set 'sb!vm::*fp-constant-lg2* (number-to-core (log 2L0 10L0)))
1274 (cold-set 'sb!vm::*fp-constant-ln2*
1276 (log 2L0 2.718281828459045235360287471352662L0))))))
1278 ;;; Make a cold list that can be used as the arg list to MAKE-PACKAGE in order
1279 ;;; to make a package that is similar to PKG.
1280 (defun make-make-package-args (pkg)
1281 (let* ((use *nil-descriptor*)
1282 (cold-nicknames *nil-descriptor*)
1283 (res *nil-descriptor*))
1284 (dolist (u (package-use-list pkg))
1285 (when (assoc u *cold-package-symbols*)
1286 (cold-push (string-to-core (package-name u)) use)))
1287 (let* ((pkg-name (package-name pkg))
1288 ;; Make the package nickname lists for the standard packages
1289 ;; be the minimum specified by ANSI, regardless of what value
1290 ;; the cross-compilation host happens to use.
1291 (warm-nicknames (cond ((string= pkg-name "COMMON-LISP")
1293 ((string= pkg-name "COMMON-LISP-USER")
1295 ((string= pkg-name "KEYWORD")
1297 ;; For packages other than the
1298 ;; standard packages, the nickname
1299 ;; list was specified by our package
1300 ;; setup code, not by properties of
1301 ;; what cross-compilation host we
1302 ;; happened to use, and we can just
1303 ;; propagate it into the target.
1305 (package-nicknames pkg)))))
1306 (dolist (warm-nickname warm-nicknames)
1307 (cold-push (string-to-core warm-nickname) cold-nicknames)))
1309 (cold-push (number-to-core (truncate (package-internal-symbol-count pkg)
1312 (cold-push (cold-intern :internal-symbols) res)
1313 (cold-push (number-to-core (truncate (package-external-symbol-count pkg)
1316 (cold-push (cold-intern :external-symbols) res)
1318 (cold-push cold-nicknames res)
1319 (cold-push (cold-intern :nicknames) res)
1322 (cold-push (cold-intern :use) res)
1324 (cold-push (string-to-core (package-name pkg)) res)
1327 ;;;; functions and fdefinition objects
1329 ;;; a hash table mapping from fdefinition names to descriptors of cold
1332 ;;; Note: Since fdefinition names can be lists like '(SETF FOO), and
1333 ;;; we want to have only one entry per name, this must be an 'EQUAL
1334 ;;; hash table, not the default 'EQL.
1335 (defvar *cold-fdefn-objects*)
1337 (defvar *cold-fdefn-gspace* nil)
1339 ;;; Given a cold representation of a symbol, return a warm
1341 (defun warm-symbol (des)
1342 ;; Note that COLD-INTERN is responsible for keeping the
1343 ;; *COLD-SYMBOLS* table up to date, so if DES happens to refer to an
1344 ;; uninterned symbol, the code below will fail. But as long as we
1345 ;; don't need to look up uninterned symbols during bootstrapping,
1347 (multiple-value-bind (symbol found-p)
1348 (gethash (descriptor-bits des) *cold-symbols*)
1349 (declare (type symbol symbol))
1351 (error "no warm symbol"))
1354 ;;; like CL:CAR, CL:CDR, and CL:NULL but for cold values
1355 (defun cold-car (des)
1356 (aver (= (descriptor-lowtag des) sb!vm:list-pointer-lowtag))
1357 (read-wordindexed des sb!vm:cons-car-slot))
1358 (defun cold-cdr (des)
1359 (aver (= (descriptor-lowtag des) sb!vm:list-pointer-lowtag))
1360 (read-wordindexed des sb!vm:cons-cdr-slot))
1361 (defun cold-null (des)
1362 (= (descriptor-bits des)
1363 (descriptor-bits *nil-descriptor*)))
1365 ;;; Given a cold representation of a function name, return a warm
1367 (declaim (ftype (function (descriptor) (or symbol list)) warm-fun-name))
1368 (defun warm-fun-name (des)
1370 (ecase (descriptor-lowtag des)
1371 (#.sb!vm:list-pointer-lowtag
1372 (aver (not (cold-null des))) ; function named NIL? please no..
1373 ;; Do cold (DESTRUCTURING-BIND (COLD-CAR COLD-CADR) DES ..).
1374 (let* ((car-des (cold-car des))
1375 (cdr-des (cold-cdr des))
1376 (cadr-des (cold-car cdr-des))
1377 (cddr-des (cold-cdr cdr-des)))
1378 (aver (cold-null cddr-des))
1379 (list (warm-symbol car-des)
1380 (warm-symbol cadr-des))))
1381 (#.sb!vm:other-pointer-lowtag
1382 (warm-symbol des)))))
1383 (unless (legal-fun-name-p result)
1384 (error "not a legal function name: ~S" result))
1387 (defun cold-fdefinition-object (cold-name &optional leave-fn-raw)
1388 (declare (type descriptor cold-name))
1389 (let ((warm-name (warm-fun-name cold-name)))
1390 (or (gethash warm-name *cold-fdefn-objects*)
1391 (let ((fdefn (allocate-boxed-object (or *cold-fdefn-gspace* *dynamic*)
1392 (1- sb!vm:fdefn-size)
1393 sb!vm:other-pointer-lowtag)))
1395 (setf (gethash warm-name *cold-fdefn-objects*) fdefn)
1396 (write-memory fdefn (make-other-immediate-descriptor
1397 (1- sb!vm:fdefn-size) sb!vm:fdefn-widetag))
1398 (write-wordindexed fdefn sb!vm:fdefn-name-slot cold-name)
1399 (unless leave-fn-raw
1400 (write-wordindexed fdefn sb!vm:fdefn-fun-slot
1402 (write-wordindexed fdefn
1403 sb!vm:fdefn-raw-addr-slot
1404 (make-random-descriptor
1405 (cold-foreign-symbol-address-as-integer
1406 "undefined_tramp"))))
1409 ;;; Handle the at-cold-init-time, fset-for-static-linkage operation
1410 ;;; requested by FOP-FSET.
1411 (defun static-fset (cold-name defn)
1412 (declare (type descriptor cold-name))
1413 (let ((fdefn (cold-fdefinition-object cold-name t))
1414 (type (logand (descriptor-low (read-memory defn)) sb!vm:widetag-mask)))
1415 (write-wordindexed fdefn sb!vm:fdefn-fun-slot defn)
1416 (write-wordindexed fdefn
1417 sb!vm:fdefn-raw-addr-slot
1419 (#.sb!vm:simple-fun-header-widetag
1423 (make-random-descriptor
1424 (+ (logandc2 (descriptor-bits defn)
1426 (ash sb!vm:simple-fun-code-offset
1427 sb!vm:word-shift))))
1428 (#.sb!vm:closure-header-widetag
1429 (make-random-descriptor
1430 (cold-foreign-symbol-address-as-integer
1431 "closure_tramp")))))
1434 (defun initialize-static-fns ()
1435 (let ((*cold-fdefn-gspace* *static*))
1436 (dolist (sym sb!vm:*static-funs*)
1437 (let* ((fdefn (cold-fdefinition-object (cold-intern sym)))
1438 (offset (- (+ (- (descriptor-low fdefn)
1439 sb!vm:other-pointer-lowtag)
1440 (* sb!vm:fdefn-raw-addr-slot sb!vm:n-word-bytes))
1441 (descriptor-low *nil-descriptor*)))
1442 (desired (sb!vm:static-fun-offset sym)))
1443 (unless (= offset desired)
1444 ;; FIXME: should be fatal
1445 (warn "Offset from FDEFN ~S to ~S is ~W, not ~W."
1446 sym nil offset desired))))))
1448 (defun list-all-fdefn-objects ()
1449 (let ((result *nil-descriptor*))
1450 (maphash (lambda (key value)
1451 (declare (ignore key))
1452 (cold-push value result))
1453 *cold-fdefn-objects*)
1456 ;;;; fixups and related stuff
1458 ;;; an EQUAL hash table
1459 (defvar *cold-foreign-symbol-table*)
1460 (declaim (type hash-table *cold-foreign-symbol-table*))
1462 ;;; Read the sbcl.nm file to find the addresses for foreign-symbols in
1464 (defun load-cold-foreign-symbol-table (filename)
1465 (with-open-file (file filename)
1467 (let ((line (read-line file nil nil)))
1470 ;; UNIX symbol tables might have tabs in them, and tabs are
1471 ;; not in Common Lisp STANDARD-CHAR, so there seems to be no
1472 ;; nice portable way to deal with them within Lisp, alas.
1473 ;; Fortunately, it's easy to use UNIX command line tools like
1474 ;; sed to remove the problem, so it's not too painful for us
1475 ;; to push responsibility for converting tabs to spaces out to
1478 ;; Other non-STANDARD-CHARs are problematic for the same reason.
1479 ;; Make sure that there aren't any..
1480 (let ((ch (find-if (lambda (char)
1481 (not (typep char 'standard-char)))
1484 (error "non-STANDARD-CHAR ~S found in foreign symbol table:~%~S"
1487 (setf line (string-trim '(#\space) line))
1488 (let ((p1 (position #\space line :from-end nil))
1489 (p2 (position #\space line :from-end t)))
1490 (if (not (and p1 p2 (< p1 p2)))
1491 ;; KLUDGE: It's too messy to try to understand all
1492 ;; possible output from nm, so we just punt the lines we
1493 ;; don't recognize. We realize that there's some chance
1494 ;; that might get us in trouble someday, so we warn
1496 (warn "ignoring unrecognized line ~S in ~A" line filename)
1497 (multiple-value-bind (value name)
1498 (if (string= "0x" line :end2 2)
1499 (values (parse-integer line :start 2 :end p1 :radix 16)
1500 (subseq line (1+ p2)))
1501 (values (parse-integer line :end p1 :radix 16)
1502 (subseq line (1+ p2))))
1503 (multiple-value-bind (old-value found)
1504 (gethash name *cold-foreign-symbol-table*)
1506 (not (= old-value value)))
1507 (warn "redefining ~S from #X~X to #X~X"
1508 name old-value value)))
1509 (setf (gethash name *cold-foreign-symbol-table*) value))))))
1512 (defun cold-foreign-symbol-address-as-integer (name)
1513 (or (find-foreign-symbol-in-table name *cold-foreign-symbol-table*)
1514 *foreign-symbol-placeholder-value*
1516 (format *error-output* "~&The foreign symbol table is:~%")
1517 (maphash (lambda (k v)
1518 (format *error-output* "~&~S = #X~8X~%" k v))
1519 *cold-foreign-symbol-table*)
1520 (error "The foreign symbol ~S is undefined." name))))
1522 (defvar *cold-assembler-routines*)
1524 (defvar *cold-assembler-fixups*)
1526 (defun record-cold-assembler-routine (name address)
1527 (/xhow "in RECORD-COLD-ASSEMBLER-ROUTINE" name address)
1528 (push (cons name address)
1529 *cold-assembler-routines*))
1531 (defun record-cold-assembler-fixup (routine
1536 (push (list routine code-object offset kind)
1537 *cold-assembler-fixups*))
1539 (defun lookup-assembler-reference (symbol)
1540 (let ((value (cdr (assoc symbol *cold-assembler-routines*))))
1541 ;; FIXME: Should this be ERROR instead of WARN?
1543 (warn "Assembler routine ~S not defined." symbol))
1546 ;;; The x86 port needs to store code fixups along with code objects if
1547 ;;; they are to be moved, so fixups for code objects in the dynamic
1548 ;;; heap need to be noted.
1550 (defvar *load-time-code-fixups*)
1553 (defun note-load-time-code-fixup (code-object offset value kind)
1554 ;; If CODE-OBJECT might be moved
1555 (when (= (gspace-identifier (descriptor-intuit-gspace code-object))
1557 ;; FIXME: pushed thing should be a structure, not just a list
1558 (push (list code-object offset value kind) *load-time-code-fixups*))
1562 (defun output-load-time-code-fixups ()
1563 (dolist (fixups *load-time-code-fixups*)
1564 (let ((code-object (first fixups))
1565 (offset (second fixups))
1566 (value (third fixups))
1567 (kind (fourth fixups)))
1568 (cold-push (cold-cons
1569 (cold-intern :load-time-code-fixup)
1573 (number-to-core offset)
1575 (number-to-core value)
1578 *nil-descriptor*)))))
1579 *current-reversed-cold-toplevels*))))
1581 ;;; Given a pointer to a code object and an offset relative to the
1582 ;;; tail of the code object's header, return an offset relative to the
1583 ;;; (beginning of the) code object.
1585 ;;; FIXME: It might be clearer to reexpress
1586 ;;; (LET ((X (CALC-OFFSET CODE-OBJECT OFFSET0))) ..)
1588 ;;; (LET ((X (+ OFFSET0 (CODE-OBJECT-HEADER-N-BYTES CODE-OBJECT)))) ..).
1589 (declaim (ftype (function (descriptor sb!vm:word)) calc-offset))
1590 (defun calc-offset (code-object offset-from-tail-of-header)
1591 (let* ((header (read-memory code-object))
1592 (header-n-words (ash (descriptor-bits header)
1593 (- sb!vm:n-widetag-bits)))
1594 (header-n-bytes (ash header-n-words sb!vm:word-shift))
1595 (result (+ offset-from-tail-of-header header-n-bytes)))
1598 (declaim (ftype (function (descriptor sb!vm:word sb!vm:word keyword))
1600 (defun do-cold-fixup (code-object after-header value kind)
1601 (let* ((offset-within-code-object (calc-offset code-object after-header))
1602 (gspace-bytes (descriptor-bytes code-object))
1603 (gspace-byte-offset (+ (descriptor-byte-offset code-object)
1604 offset-within-code-object))
1605 (gspace-byte-address (gspace-byte-address
1606 (descriptor-gspace code-object))))
1607 (ecase +backend-fasl-file-implementation+
1608 ;; See CMU CL source for other formerly-supported architectures
1609 ;; (and note that you have to rewrite them to use VECTOR-REF
1610 ;; unstead of SAP-REF).
1614 (assert (zerop (ldb (byte 2 0) value)))
1615 #+nil ;; was commented out in cmucl source too. Don't know what
1616 ;; it does -dan 2001.05.03
1617 (setf (sap-ref-16 sap 0)
1618 (logior (sap-ref-16 sap 0) (ldb (byte 14 0) (ash value -2)))))
1620 (let* ((value (if (logbitp 15 value) (+ value (ash 1 16)) value))
1621 (value (if (logbitp 31 value) (+ value (ash 1 32)) value))
1622 (value (if (logbitp 47 value) (+ value (ash 1 48)) value)))
1623 (setf (byte-vector-ref-8 gspace-bytes gspace-byte-offset)
1624 (ldb (byte 8 48) value)
1625 (byte-vector-ref-8 gspace-bytes (1+ gspace-byte-offset))
1626 (ldb (byte 8 56) value))))
1628 (let* ((value (if (logbitp 15 value) (+ value (ash 1 16)) value))
1629 (value (if (logbitp 31 value) (+ value (ash 1 32)) value)))
1630 (setf (byte-vector-ref-8 gspace-bytes gspace-byte-offset)
1631 (ldb (byte 8 32) value)
1632 (byte-vector-ref-8 gspace-bytes (1+ gspace-byte-offset))
1633 (ldb (byte 8 40) value))))
1635 (let ((value (if (logbitp 15 value) (+ value (ash 1 16)) value)))
1636 (setf (byte-vector-ref-8 gspace-bytes gspace-byte-offset)
1637 (ldb (byte 8 16) value)
1638 (byte-vector-ref-8 gspace-bytes (1+ gspace-byte-offset))
1639 (ldb (byte 8 24) value))))
1641 (setf (byte-vector-ref-8 gspace-bytes gspace-byte-offset)
1642 (ldb (byte 8 0) value)
1643 (byte-vector-ref-8 gspace-bytes (1+ gspace-byte-offset))
1644 (ldb (byte 8 8) value)))))
1648 (error "Can't deal with call fixups yet."))
1650 (setf (byte-vector-ref-32 gspace-bytes gspace-byte-offset)
1651 (dpb (ldb (byte 22 10) value)
1653 (byte-vector-ref-32 gspace-bytes gspace-byte-offset))))
1655 (setf (byte-vector-ref-32 gspace-bytes gspace-byte-offset)
1656 (dpb (ldb (byte 10 0) value)
1658 (byte-vector-ref-32 gspace-bytes gspace-byte-offset))))))
1660 (let* ((un-fixed-up (byte-vector-ref-32 gspace-bytes
1661 gspace-byte-offset))
1662 (code-object-start-addr (logandc2 (descriptor-bits code-object)
1663 sb!vm:lowtag-mask)))
1664 (assert (= code-object-start-addr
1665 (+ gspace-byte-address
1666 (descriptor-byte-offset code-object))))
1669 (let ((fixed-up (+ value un-fixed-up)))
1670 (setf (byte-vector-ref-32 gspace-bytes gspace-byte-offset)
1672 ;; comment from CMU CL sources:
1674 ;; Note absolute fixups that point within the object.
1675 ;; KLUDGE: There seems to be an implicit assumption in
1676 ;; the old CMU CL code here, that if it doesn't point
1677 ;; before the object, it must point within the object
1678 ;; (not beyond it). It would be good to add an
1679 ;; explanation of why that's true, or an assertion that
1680 ;; it's really true, or both.
1681 (unless (< fixed-up code-object-start-addr)
1682 (note-load-time-code-fixup code-object
1686 (:relative ; (used for arguments to X86 relative CALL instruction)
1687 (let ((fixed-up (- (+ value un-fixed-up)
1690 sb!vm:n-word-bytes))) ; length of CALL argument
1691 (setf (byte-vector-ref-32 gspace-bytes gspace-byte-offset)
1693 ;; Note relative fixups that point outside the code
1694 ;; object, which is to say all relative fixups, since
1695 ;; relative addressing within a code object never needs
1697 (note-load-time-code-fixup code-object
1703 (defun resolve-assembler-fixups ()
1704 (dolist (fixup *cold-assembler-fixups*)
1705 (let* ((routine (car fixup))
1706 (value (lookup-assembler-reference routine)))
1708 (do-cold-fixup (second fixup) (third fixup) value (fourth fixup))))))
1710 ;;; *COLD-FOREIGN-SYMBOL-TABLE* becomes *!INITIAL-FOREIGN-SYMBOLS* in
1711 ;;; the core. When the core is loaded, !LOADER-COLD-INIT uses this to
1712 ;;; create *STATIC-FOREIGN-SYMBOLS*, which the code in
1713 ;;; target-load.lisp refers to.
1714 (defun linkage-info-to-core ()
1715 (let ((result *nil-descriptor*))
1716 (maphash (lambda (symbol value)
1717 (cold-push (cold-cons (string-to-core symbol)
1718 (number-to-core value))
1720 *cold-foreign-symbol-table*)
1721 (cold-set (cold-intern '*!initial-foreign-symbols*) result))
1722 (let ((result *nil-descriptor*))
1723 (dolist (rtn *cold-assembler-routines*)
1724 (cold-push (cold-cons (cold-intern (car rtn))
1725 (number-to-core (cdr rtn)))
1727 (cold-set (cold-intern '*!initial-assembler-routines*) result)))
1729 ;;;; general machinery for cold-loading FASL files
1731 ;;; FOP functions for cold loading
1732 (defvar *cold-fop-funs*
1733 ;; We start out with a copy of the ordinary *FOP-FUNS*. The ones
1734 ;; which aren't appropriate for cold load will be destructively
1736 (copy-seq *fop-funs*))
1738 (defvar *normal-fop-funs*)
1740 ;;; Cause a fop to have a special definition for cold load.
1742 ;;; This is similar to DEFINE-FOP, but unlike DEFINE-FOP, this version
1743 ;;; (1) looks up the code for this name (created by a previous
1744 ;; DEFINE-FOP) instead of creating a code, and
1745 ;;; (2) stores its definition in the *COLD-FOP-FUNS* vector,
1746 ;;; instead of storing in the *FOP-FUNS* vector.
1747 (defmacro define-cold-fop ((name &key (pushp t) (stackp t)) &rest forms)
1748 (aver (member pushp '(nil t)))
1749 (aver (member stackp '(nil t)))
1750 (let ((code (get name 'fop-code))
1751 (fname (symbolicate "COLD-" name)))
1753 (error "~S is not a defined FOP." name))
1757 `((with-fop-stack ,pushp ,@forms))
1759 (setf (svref *cold-fop-funs* ,code) #',fname))))
1761 (defmacro clone-cold-fop ((name &key (pushp t) (stackp t)) (small-name) &rest forms)
1762 (aver (member pushp '(nil t)))
1763 (aver (member stackp '(nil t)))
1765 (macrolet ((clone-arg () '(read-arg 4)))
1766 (define-cold-fop (,name :pushp ,pushp :stackp ,stackp) ,@forms))
1767 (macrolet ((clone-arg () '(read-arg 1)))
1768 (define-cold-fop (,small-name :pushp ,pushp :stackp ,stackp) ,@forms))))
1770 ;;; Cause a fop to be undefined in cold load.
1771 (defmacro not-cold-fop (name)
1772 `(define-cold-fop (,name)
1773 (error "The fop ~S is not supported in cold load." ',name)))
1775 ;;; COLD-LOAD loads stuff into the core image being built by calling
1776 ;;; LOAD-AS-FASL with the fop function table rebound to a table of cold
1777 ;;; loading functions.
1778 (defun cold-load (filename)
1780 "Load the file named by FILENAME into the cold load image being built."
1781 (let* ((*normal-fop-funs* *fop-funs*)
1782 (*fop-funs* *cold-fop-funs*)
1783 (*cold-load-filename* (etypecase filename
1785 (pathname (namestring filename)))))
1786 (with-open-file (s filename :element-type '(unsigned-byte 8))
1787 (load-as-fasl s nil nil))))
1789 ;;;; miscellaneous cold fops
1791 (define-cold-fop (fop-misc-trap) *unbound-marker*)
1793 (define-cold-fop (fop-character)
1794 (make-character-descriptor (read-arg 3)))
1795 (define-cold-fop (fop-short-character)
1796 (make-character-descriptor (read-arg 1)))
1798 (define-cold-fop (fop-empty-list) *nil-descriptor*)
1799 (define-cold-fop (fop-truth) (cold-intern t))
1801 (define-cold-fop (fop-normal-load :stackp nil)
1802 (setq *fop-funs* *normal-fop-funs*))
1804 (define-fop (fop-maybe-cold-load 82 :stackp nil)
1805 (when *cold-load-filename*
1806 (setq *fop-funs* *cold-fop-funs*)))
1808 (define-cold-fop (fop-maybe-cold-load :stackp nil))
1810 (clone-cold-fop (fop-struct)
1812 (let* ((size (clone-arg))
1813 (result (allocate-boxed-object *dynamic*
1815 sb!vm:instance-pointer-lowtag)))
1816 (write-memory result (make-other-immediate-descriptor
1817 size sb!vm:instance-header-widetag))
1818 (do ((index (1- size) (1- index)))
1820 (declare (fixnum index))
1821 (write-wordindexed result
1822 (+ index sb!vm:instance-slots-offset)
1826 (define-cold-fop (fop-layout)
1827 (let* ((length-des (pop-stack))
1828 (depthoid-des (pop-stack))
1829 (cold-inherits (pop-stack))
1831 (old (gethash name *cold-layouts*)))
1832 (declare (type descriptor length-des depthoid-des cold-inherits))
1833 (declare (type symbol name))
1834 ;; If a layout of this name has been defined already
1836 ;; Enforce consistency between the previous definition and the
1837 ;; current definition, then return the previous definition.
1839 ;; FIXME: This would be more maintainable if we used
1840 ;; DEFSTRUCT (:TYPE LIST) to define COLD-LAYOUT. -- WHN 19990825
1841 (old-layout-descriptor
1847 (declare (type descriptor old-layout-descriptor))
1848 (declare (type index old-length))
1849 (declare (type fixnum old-depthoid))
1850 (declare (type list old-inherits-list))
1851 (aver (eq name old-name))
1852 (let ((length (descriptor-fixnum length-des))
1853 (inherits-list (listify-cold-inherits cold-inherits))
1854 (depthoid (descriptor-fixnum depthoid-des)))
1855 (unless (= length old-length)
1856 (error "cold loading a reference to class ~S when the compile~%~
1857 time length was ~S and current length is ~S"
1861 (unless (equal inherits-list old-inherits-list)
1862 (error "cold loading a reference to class ~S when the compile~%~
1863 time inherits were ~S~%~
1864 and current inherits are ~S"
1868 (unless (= depthoid old-depthoid)
1869 (error "cold loading a reference to class ~S when the compile~%~
1870 time inheritance depthoid was ~S and current inheritance~%~
1875 old-layout-descriptor)
1876 ;; Make a new definition from scratch.
1877 (make-cold-layout name length-des cold-inherits depthoid-des))))
1879 ;;;; cold fops for loading symbols
1881 ;;; Load a symbol SIZE characters long from *FASL-INPUT-STREAM* and
1882 ;;; intern that symbol in PACKAGE.
1883 (defun cold-load-symbol (size package)
1884 (let ((string (make-string size)))
1885 (read-string-as-bytes *fasl-input-stream* string)
1886 (cold-intern (intern string package) package)))
1888 (macrolet ((frob (name pname-len package-len)
1889 `(define-cold-fop (,name)
1890 (let ((index (read-arg ,package-len)))
1892 (cold-load-symbol (read-arg ,pname-len)
1893 (svref *current-fop-table* index)))))))
1894 (frob fop-symbol-in-package-save 4 4)
1895 (frob fop-small-symbol-in-package-save 1 4)
1896 (frob fop-symbol-in-byte-package-save 4 1)
1897 (frob fop-small-symbol-in-byte-package-save 1 1))
1899 (clone-cold-fop (fop-lisp-symbol-save)
1900 (fop-lisp-small-symbol-save)
1901 (push-fop-table (cold-load-symbol (clone-arg) *cl-package*)))
1903 (clone-cold-fop (fop-keyword-symbol-save)
1904 (fop-keyword-small-symbol-save)
1905 (push-fop-table (cold-load-symbol (clone-arg) *keyword-package*)))
1907 (clone-cold-fop (fop-uninterned-symbol-save)
1908 (fop-uninterned-small-symbol-save)
1909 (let* ((size (clone-arg))
1910 (name (make-string size)))
1911 (read-string-as-bytes *fasl-input-stream* name)
1912 (let ((symbol-des (allocate-symbol name)))
1913 (push-fop-table symbol-des))))
1915 ;;;; cold fops for loading lists
1917 ;;; Make a list of the top LENGTH things on the fop stack. The last
1918 ;;; cdr of the list is set to LAST.
1919 (defmacro cold-stack-list (length last)
1920 `(do* ((index ,length (1- index))
1921 (result ,last (cold-cons (pop-stack) result)))
1922 ((= index 0) result)
1923 (declare (fixnum index))))
1925 (define-cold-fop (fop-list)
1926 (cold-stack-list (read-arg 1) *nil-descriptor*))
1927 (define-cold-fop (fop-list*)
1928 (cold-stack-list (read-arg 1) (pop-stack)))
1929 (define-cold-fop (fop-list-1)
1930 (cold-stack-list 1 *nil-descriptor*))
1931 (define-cold-fop (fop-list-2)
1932 (cold-stack-list 2 *nil-descriptor*))
1933 (define-cold-fop (fop-list-3)
1934 (cold-stack-list 3 *nil-descriptor*))
1935 (define-cold-fop (fop-list-4)
1936 (cold-stack-list 4 *nil-descriptor*))
1937 (define-cold-fop (fop-list-5)
1938 (cold-stack-list 5 *nil-descriptor*))
1939 (define-cold-fop (fop-list-6)
1940 (cold-stack-list 6 *nil-descriptor*))
1941 (define-cold-fop (fop-list-7)
1942 (cold-stack-list 7 *nil-descriptor*))
1943 (define-cold-fop (fop-list-8)
1944 (cold-stack-list 8 *nil-descriptor*))
1945 (define-cold-fop (fop-list*-1)
1946 (cold-stack-list 1 (pop-stack)))
1947 (define-cold-fop (fop-list*-2)
1948 (cold-stack-list 2 (pop-stack)))
1949 (define-cold-fop (fop-list*-3)
1950 (cold-stack-list 3 (pop-stack)))
1951 (define-cold-fop (fop-list*-4)
1952 (cold-stack-list 4 (pop-stack)))
1953 (define-cold-fop (fop-list*-5)
1954 (cold-stack-list 5 (pop-stack)))
1955 (define-cold-fop (fop-list*-6)
1956 (cold-stack-list 6 (pop-stack)))
1957 (define-cold-fop (fop-list*-7)
1958 (cold-stack-list 7 (pop-stack)))
1959 (define-cold-fop (fop-list*-8)
1960 (cold-stack-list 8 (pop-stack)))
1962 ;;;; cold fops for loading vectors
1964 (clone-cold-fop (fop-string)
1966 (let* ((len (clone-arg))
1967 (string (make-string len)))
1968 (read-string-as-bytes *fasl-input-stream* string)
1969 (string-to-core string)))
1971 (clone-cold-fop (fop-vector)
1973 (let* ((size (clone-arg))
1974 (result (allocate-vector-object *dynamic*
1977 sb!vm:simple-vector-widetag)))
1978 (do ((index (1- size) (1- index)))
1980 (declare (fixnum index))
1981 (write-wordindexed result
1982 (+ index sb!vm:vector-data-offset)
1986 (define-cold-fop (fop-int-vector)
1987 (let* ((len (read-arg 4))
1988 (sizebits (read-arg 1))
1989 (type (case sizebits
1990 (1 sb!vm:simple-bit-vector-widetag)
1991 (2 sb!vm:simple-array-unsigned-byte-2-widetag)
1992 (4 sb!vm:simple-array-unsigned-byte-4-widetag)
1993 (8 sb!vm:simple-array-unsigned-byte-8-widetag)
1994 (16 sb!vm:simple-array-unsigned-byte-16-widetag)
1995 (32 sb!vm:simple-array-unsigned-byte-32-widetag)
1996 (t (error "losing element size: ~W" sizebits))))
1997 (result (allocate-vector-object *dynamic* sizebits len type))
1998 (start (+ (descriptor-byte-offset result)
1999 (ash sb!vm:vector-data-offset sb!vm:word-shift)))
2001 (ceiling (* len sizebits)
2002 sb!vm:n-byte-bits))))
2003 (read-sequence-or-die (descriptor-bytes result)
2009 (define-cold-fop (fop-single-float-vector)
2010 (let* ((len (read-arg 4))
2011 (result (allocate-vector-object
2015 sb!vm:simple-array-single-float-widetag))
2016 (start (+ (descriptor-byte-offset result)
2017 (ash sb!vm:vector-data-offset sb!vm:word-shift)))
2018 (end (+ start (* len sb!vm:n-word-bytes))))
2019 (read-sequence-or-die (descriptor-bytes result)
2025 (not-cold-fop fop-double-float-vector)
2026 #!+long-float (not-cold-fop fop-long-float-vector)
2027 (not-cold-fop fop-complex-single-float-vector)
2028 (not-cold-fop fop-complex-double-float-vector)
2029 #!+long-float (not-cold-fop fop-complex-long-float-vector)
2031 (define-cold-fop (fop-array)
2032 (let* ((rank (read-arg 4))
2033 (data-vector (pop-stack))
2034 (result (allocate-boxed-object *dynamic*
2035 (+ sb!vm:array-dimensions-offset rank)
2036 sb!vm:other-pointer-lowtag)))
2037 (write-memory result
2038 (make-other-immediate-descriptor rank
2039 sb!vm:simple-array-widetag))
2040 (write-wordindexed result sb!vm:array-fill-pointer-slot *nil-descriptor*)
2041 (write-wordindexed result sb!vm:array-data-slot data-vector)
2042 (write-wordindexed result sb!vm:array-displacement-slot *nil-descriptor*)
2043 (write-wordindexed result sb!vm:array-displaced-p-slot *nil-descriptor*)
2044 (let ((total-elements 1))
2045 (dotimes (axis rank)
2046 (let ((dim (pop-stack)))
2047 (unless (or (= (descriptor-lowtag dim) sb!vm:even-fixnum-lowtag)
2048 (= (descriptor-lowtag dim) sb!vm:odd-fixnum-lowtag))
2049 (error "non-fixnum dimension? (~S)" dim))
2050 (setf total-elements
2052 (logior (ash (descriptor-high dim)
2053 (- descriptor-low-bits
2054 (1- sb!vm:n-lowtag-bits)))
2055 (ash (descriptor-low dim)
2056 (- 1 sb!vm:n-lowtag-bits)))))
2057 (write-wordindexed result
2058 (+ sb!vm:array-dimensions-offset axis)
2060 (write-wordindexed result
2061 sb!vm:array-elements-slot
2062 (make-fixnum-descriptor total-elements)))
2065 ;;;; cold fops for loading numbers
2067 (defmacro define-cold-number-fop (fop)
2068 `(define-cold-fop (,fop :stackp nil)
2069 ;; Invoke the ordinary warm version of this fop to push the
2072 ;; Replace the warm fop result with the cold image of the warm
2075 (let ((number (pop-stack)))
2076 (number-to-core number)))))
2078 (define-cold-number-fop fop-single-float)
2079 (define-cold-number-fop fop-double-float)
2080 (define-cold-number-fop fop-integer)
2081 (define-cold-number-fop fop-small-integer)
2082 (define-cold-number-fop fop-word-integer)
2083 (define-cold-number-fop fop-byte-integer)
2084 (define-cold-number-fop fop-complex-single-float)
2085 (define-cold-number-fop fop-complex-double-float)
2088 (define-cold-fop (fop-long-float)
2089 (ecase +backend-fasl-file-implementation+
2090 (:x86 ; (which has 80-bit long-float format)
2091 (prepare-for-fast-read-byte *fasl-input-stream*
2092 (let* ((des (allocate-unboxed-object *dynamic* sb!vm:n-word-bits
2093 (1- sb!vm:long-float-size)
2094 sb!vm:long-float-widetag))
2095 (low-bits (make-random-descriptor (fast-read-u-integer 4)))
2096 (high-bits (make-random-descriptor (fast-read-u-integer 4)))
2097 (exp-bits (make-random-descriptor (fast-read-s-integer 2))))
2098 (done-with-fast-read-byte)
2099 (write-wordindexed des sb!vm:long-float-value-slot low-bits)
2100 (write-wordindexed des (1+ sb!vm:long-float-value-slot) high-bits)
2101 (write-wordindexed des (+ 2 sb!vm:long-float-value-slot) exp-bits)
2103 ;; This was supported in CMU CL, but isn't currently supported in
2106 (#.sb!c:sparc-fasl-file-implementation ; 128 bit long-float format
2107 (prepare-for-fast-read-byte *fasl-input-stream*
2108 (let* ((des (allocate-unboxed-object *dynamic* sb!vm:n-word-bits
2109 (1- sb!vm:long-float-size)
2110 sb!vm:long-float-widetag))
2111 (low-bits (make-random-descriptor (fast-read-u-integer 4)))
2112 (mid-bits (make-random-descriptor (fast-read-u-integer 4)))
2113 (high-bits (make-random-descriptor (fast-read-u-integer 4)))
2114 (exp-bits (make-random-descriptor (fast-read-s-integer 4))))
2115 (done-with-fast-read-byte)
2116 (write-wordindexed des sb!vm:long-float-value-slot exp-bits)
2117 (write-wordindexed des (1+ sb!vm:long-float-value-slot) high-bits)
2118 (write-wordindexed des (+ 2 sb!vm:long-float-value-slot) mid-bits)
2119 (write-wordindexed des (+ 3 sb!vm:long-float-value-slot) low-bits)
2123 (define-cold-fop (fop-complex-long-float)
2124 (ecase +backend-fasl-file-implementation+
2125 (:x86 ; (which has 80-bit long-float format)
2126 (prepare-for-fast-read-byte *fasl-input-stream*
2127 (let* ((des (allocate-unboxed-object *dynamic* sb!vm:n-word-bits
2128 (1- sb!vm:complex-long-float-size)
2129 sb!vm:complex-long-float-widetag))
2130 (real-low-bits (make-random-descriptor (fast-read-u-integer 4)))
2131 (real-high-bits (make-random-descriptor (fast-read-u-integer 4)))
2132 (real-exp-bits (make-random-descriptor (fast-read-s-integer 2)))
2133 (imag-low-bits (make-random-descriptor (fast-read-u-integer 4)))
2134 (imag-high-bits (make-random-descriptor (fast-read-u-integer 4)))
2135 (imag-exp-bits (make-random-descriptor (fast-read-s-integer 2))))
2136 (done-with-fast-read-byte)
2137 (write-wordindexed des
2138 sb!vm:complex-long-float-real-slot
2140 (write-wordindexed des
2141 (1+ sb!vm:complex-long-float-real-slot)
2143 (write-wordindexed des
2144 (+ 2 sb!vm:complex-long-float-real-slot)
2146 (write-wordindexed des
2147 sb!vm:complex-long-float-imag-slot
2149 (write-wordindexed des
2150 (1+ sb!vm:complex-long-float-imag-slot)
2152 (write-wordindexed des
2153 (+ 2 sb!vm:complex-long-float-imag-slot)
2156 ;; This was supported in CMU CL, but isn't currently supported in SBCL.
2158 (#.sb!c:sparc-fasl-file-implementation ; 128 bit long-float format
2159 (prepare-for-fast-read-byte *fasl-input-stream*
2160 (let* ((des (allocate-unboxed-object *dynamic* sb!vm:n-word-bits
2161 (1- sb!vm:complex-long-float-size)
2162 sb!vm:complex-long-float-widetag))
2163 (real-low-bits (make-random-descriptor (fast-read-u-integer 4)))
2164 (real-mid-bits (make-random-descriptor (fast-read-u-integer 4)))
2165 (real-high-bits (make-random-descriptor (fast-read-u-integer 4)))
2166 (real-exp-bits (make-random-descriptor (fast-read-s-integer 4)))
2167 (imag-low-bits (make-random-descriptor (fast-read-u-integer 4)))
2168 (imag-mid-bits (make-random-descriptor (fast-read-u-integer 4)))
2169 (imag-high-bits (make-random-descriptor (fast-read-u-integer 4)))
2170 (imag-exp-bits (make-random-descriptor (fast-read-s-integer 4))))
2171 (done-with-fast-read-byte)
2172 (write-wordindexed des
2173 sb!vm:complex-long-float-real-slot
2175 (write-wordindexed des
2176 (1+ sb!vm:complex-long-float-real-slot)
2178 (write-wordindexed des
2179 (+ 2 sb!vm:complex-long-float-real-slot)
2181 (write-wordindexed des
2182 (+ 3 sb!vm:complex-long-float-real-slot)
2184 (write-wordindexed des
2185 sb!vm:complex-long-float-real-slot
2187 (write-wordindexed des
2188 (1+ sb!vm:complex-long-float-real-slot)
2190 (write-wordindexed des
2191 (+ 2 sb!vm:complex-long-float-real-slot)
2193 (write-wordindexed des
2194 (+ 3 sb!vm:complex-long-float-real-slot)
2198 (define-cold-fop (fop-ratio)
2199 (let ((den (pop-stack)))
2200 (number-pair-to-core (pop-stack) den sb!vm:ratio-widetag)))
2202 (define-cold-fop (fop-complex)
2203 (let ((im (pop-stack)))
2204 (number-pair-to-core (pop-stack) im sb!vm:complex-widetag)))
2206 ;;;; cold fops for calling (or not calling)
2208 (not-cold-fop fop-eval)
2209 (not-cold-fop fop-eval-for-effect)
2211 (defvar *load-time-value-counter*)
2213 (define-cold-fop (fop-funcall)
2214 (unless (= (read-arg 1) 0)
2215 (error "You can't FOP-FUNCALL arbitrary stuff in cold load."))
2216 (let ((counter *load-time-value-counter*))
2217 (cold-push (cold-cons
2218 (cold-intern :load-time-value)
2222 (number-to-core counter)
2224 *current-reversed-cold-toplevels*)
2225 (setf *load-time-value-counter* (1+ counter))
2226 (make-descriptor 0 0 nil counter)))
2228 (defun finalize-load-time-value-noise ()
2229 (cold-set (cold-intern '*!load-time-values*)
2230 (allocate-vector-object *dynamic*
2232 *load-time-value-counter*
2233 sb!vm:simple-vector-widetag)))
2235 (define-cold-fop (fop-funcall-for-effect :pushp nil)
2236 (if (= (read-arg 1) 0)
2237 (cold-push (pop-stack)
2238 *current-reversed-cold-toplevels*)
2239 (error "You can't FOP-FUNCALL arbitrary stuff in cold load.")))
2241 ;;;; cold fops for fixing up circularities
2243 (define-cold-fop (fop-rplaca :pushp nil)
2244 (let ((obj (svref *current-fop-table* (read-arg 4)))
2246 (write-memory (cold-nthcdr idx obj) (pop-stack))))
2248 (define-cold-fop (fop-rplacd :pushp nil)
2249 (let ((obj (svref *current-fop-table* (read-arg 4)))
2251 (write-wordindexed (cold-nthcdr idx obj) 1 (pop-stack))))
2253 (define-cold-fop (fop-svset :pushp nil)
2254 (let ((obj (svref *current-fop-table* (read-arg 4)))
2256 (write-wordindexed obj
2258 (ecase (descriptor-lowtag obj)
2259 (#.sb!vm:instance-pointer-lowtag 1)
2260 (#.sb!vm:other-pointer-lowtag 2)))
2263 (define-cold-fop (fop-structset :pushp nil)
2264 (let ((obj (svref *current-fop-table* (read-arg 4)))
2266 (write-wordindexed obj (1+ idx) (pop-stack))))
2268 ;;; In the original CMUCL code, this actually explicitly declared PUSHP
2269 ;;; to be T, even though that's what it defaults to in DEFINE-COLD-FOP.
2270 (define-cold-fop (fop-nthcdr)
2271 (cold-nthcdr (read-arg 4) (pop-stack)))
2273 (defun cold-nthcdr (index obj)
2275 (setq obj (read-wordindexed obj 1)))
2278 ;;;; cold fops for loading code objects and functions
2280 ;;; the names of things which have had COLD-FSET used on them already
2281 ;;; (used to make sure that we don't try to statically link a name to
2282 ;;; more than one definition)
2283 (defparameter *cold-fset-warm-names*
2284 ;; This can't be an EQL hash table because names can be conses, e.g.
2286 (make-hash-table :test 'equal))
2288 (define-cold-fop (fop-fset :pushp nil)
2289 (let* ((fn (pop-stack))
2290 (cold-name (pop-stack))
2291 (warm-name (warm-fun-name cold-name)))
2292 (if (gethash warm-name *cold-fset-warm-names*)
2293 (error "duplicate COLD-FSET for ~S" warm-name)
2294 (setf (gethash warm-name *cold-fset-warm-names*) t))
2295 (static-fset cold-name fn)))
2297 (define-cold-fop (fop-fdefinition)
2298 (cold-fdefinition-object (pop-stack)))
2300 (define-cold-fop (fop-sanctify-for-execution)
2303 ;;; Setting this variable shows what code looks like before any
2304 ;;; fixups (or function headers) are applied.
2305 #!+sb-show (defvar *show-pre-fixup-code-p* nil)
2307 ;;; FIXME: The logic here should be converted into a function
2308 ;;; COLD-CODE-FOP-GUTS (NCONST CODE-SIZE) called by DEFINE-COLD-FOP
2309 ;;; FOP-CODE and DEFINE-COLD-FOP FOP-SMALL-CODE, so that
2310 ;;; variable-capture nastiness like (LET ((NCONST ,NCONST) ..) ..)
2311 ;;; doesn't keep me awake at night.
2312 (defmacro define-cold-code-fop (name nconst code-size)
2313 `(define-cold-fop (,name)
2314 (let* ((nconst ,nconst)
2315 (code-size ,code-size)
2316 (raw-header-n-words (+ sb!vm:code-trace-table-offset-slot nconst))
2318 ;; Note: we round the number of constants up to ensure
2319 ;; that the code vector will be properly aligned.
2320 (round-up raw-header-n-words 2))
2321 (des (allocate-cold-descriptor *dynamic*
2322 (+ (ash header-n-words
2325 sb!vm:other-pointer-lowtag)))
2327 (make-other-immediate-descriptor
2328 header-n-words sb!vm:code-header-widetag))
2329 (write-wordindexed des
2330 sb!vm:code-code-size-slot
2331 (make-fixnum-descriptor
2332 (ash (+ code-size (1- (ash 1 sb!vm:word-shift)))
2333 (- sb!vm:word-shift))))
2334 (write-wordindexed des sb!vm:code-entry-points-slot *nil-descriptor*)
2335 (write-wordindexed des sb!vm:code-debug-info-slot (pop-stack))
2336 (when (oddp raw-header-n-words)
2337 (write-wordindexed des
2339 (make-random-descriptor 0)))
2340 (do ((index (1- raw-header-n-words) (1- index)))
2341 ((< index sb!vm:code-trace-table-offset-slot))
2342 (write-wordindexed des index (pop-stack)))
2343 (let* ((start (+ (descriptor-byte-offset des)
2344 (ash header-n-words sb!vm:word-shift)))
2345 (end (+ start code-size)))
2346 (read-sequence-or-die (descriptor-bytes des)
2351 (when *show-pre-fixup-code-p*
2352 (format *trace-output*
2353 "~&/raw code from code-fop ~W ~W:~%"
2356 (do ((i start (+ i sb!vm:n-word-bytes)))
2358 (format *trace-output*
2359 "/#X~8,'0x: #X~8,'0x~%"
2360 (+ i (gspace-byte-address (descriptor-gspace des)))
2361 (byte-vector-ref-32 (descriptor-bytes des) i)))))
2364 (define-cold-code-fop fop-code (read-arg 4) (read-arg 4))
2366 (define-cold-code-fop fop-small-code (read-arg 1) (read-arg 2))
2368 (clone-cold-fop (fop-alter-code :pushp nil)
2369 (fop-byte-alter-code)
2370 (let ((slot (clone-arg))
2373 (write-wordindexed code slot value)))
2375 (define-cold-fop (fop-fun-entry)
2376 (let* ((type (pop-stack))
2377 (arglist (pop-stack))
2379 (code-object (pop-stack))
2380 (offset (calc-offset code-object (read-arg 4)))
2381 (fn (descriptor-beyond code-object
2383 sb!vm:fun-pointer-lowtag))
2384 (next (read-wordindexed code-object sb!vm:code-entry-points-slot)))
2385 (unless (zerop (logand offset sb!vm:lowtag-mask))
2386 (error "unaligned function entry: ~S at #X~X" name offset))
2387 (write-wordindexed code-object sb!vm:code-entry-points-slot fn)
2389 (make-other-immediate-descriptor
2390 (ash offset (- sb!vm:word-shift))
2391 sb!vm:simple-fun-header-widetag))
2392 (write-wordindexed fn
2393 sb!vm:simple-fun-self-slot
2394 ;; KLUDGE: Wiring decisions like this in at
2395 ;; this level ("if it's an x86") instead of a
2396 ;; higher level of abstraction ("if it has such
2397 ;; and such relocation peculiarities (which
2398 ;; happen to be confined to the x86)") is bad.
2399 ;; It would be nice if the code were instead
2400 ;; conditional on some more descriptive
2401 ;; feature, :STICKY-CODE or
2402 ;; :LOAD-GC-INTERACTION or something.
2404 ;; FIXME: The X86 definition of the function
2405 ;; self slot breaks everything object.tex says
2406 ;; about it. (As far as I can tell, the X86
2407 ;; definition makes it a pointer to the actual
2408 ;; code instead of a pointer back to the object
2409 ;; itself.) Ask on the mailing list whether
2410 ;; this is documented somewhere, and if not,
2411 ;; try to reverse engineer some documentation.
2413 ;; a pointer back to the function object, as
2414 ;; described in CMU CL
2415 ;; src/docs/internals/object.tex
2418 ;; KLUDGE: a pointer to the actual code of the
2419 ;; object, as described nowhere that I can find
2421 (make-random-descriptor
2422 (+ (descriptor-bits fn)
2423 (- (ash sb!vm:simple-fun-code-offset
2425 ;; FIXME: We should mask out the type
2426 ;; bits, not assume we know what they
2427 ;; are and subtract them out this way.
2428 sb!vm:fun-pointer-lowtag))))
2429 (write-wordindexed fn sb!vm:simple-fun-next-slot next)
2430 (write-wordindexed fn sb!vm:simple-fun-name-slot name)
2431 (write-wordindexed fn sb!vm:simple-fun-arglist-slot arglist)
2432 (write-wordindexed fn sb!vm:simple-fun-type-slot type)
2435 (define-cold-fop (fop-foreign-fixup)
2436 (let* ((kind (pop-stack))
2437 (code-object (pop-stack))
2439 (sym (make-string len)))
2440 (read-string-as-bytes *fasl-input-stream* sym)
2441 (let ((offset (read-arg 4))
2442 (value (cold-foreign-symbol-address-as-integer sym)))
2443 (do-cold-fixup code-object offset value kind))
2446 (define-cold-fop (fop-assembler-code)
2447 (let* ((length (read-arg 4))
2449 ;; Note: we round the number of constants up to ensure that
2450 ;; the code vector will be properly aligned.
2451 (round-up sb!vm:code-constants-offset 2))
2452 (des (allocate-cold-descriptor *read-only*
2453 (+ (ash header-n-words
2456 sb!vm:other-pointer-lowtag)))
2458 (make-other-immediate-descriptor
2459 header-n-words sb!vm:code-header-widetag))
2460 (write-wordindexed des
2461 sb!vm:code-code-size-slot
2462 (make-fixnum-descriptor
2463 (ash (+ length (1- (ash 1 sb!vm:word-shift)))
2464 (- sb!vm:word-shift))))
2465 (write-wordindexed des sb!vm:code-entry-points-slot *nil-descriptor*)
2466 (write-wordindexed des sb!vm:code-debug-info-slot *nil-descriptor*)
2468 (let* ((start (+ (descriptor-byte-offset des)
2469 (ash header-n-words sb!vm:word-shift)))
2470 (end (+ start length)))
2471 (read-sequence-or-die (descriptor-bytes des)
2477 (define-cold-fop (fop-assembler-routine)
2478 (let* ((routine (pop-stack))
2480 (offset (calc-offset des (read-arg 4))))
2481 (record-cold-assembler-routine
2483 (+ (logandc2 (descriptor-bits des) sb!vm:lowtag-mask) offset))
2486 (define-cold-fop (fop-assembler-fixup)
2487 (let* ((routine (pop-stack))
2489 (code-object (pop-stack))
2490 (offset (read-arg 4)))
2491 (record-cold-assembler-fixup routine code-object offset kind)
2494 (define-cold-fop (fop-code-object-fixup)
2495 (let* ((kind (pop-stack))
2496 (code-object (pop-stack))
2497 (offset (read-arg 4))
2498 (value (descriptor-bits code-object)))
2499 (do-cold-fixup code-object offset value kind)
2502 ;;;; emitting C header file
2504 (defun tailwise-equal (string tail)
2505 (and (>= (length string) (length tail))
2506 (string= string tail :start1 (- (length string) (length tail)))))
2508 (defun write-c-header ()
2510 ;; writing beginning boilerplate
2513 '("This is a machine-generated file. Please do not edit it by hand."
2515 "This file contains low-level information about the"
2516 "internals of a particular version and configuration"
2517 "of SBCL. It is used by the C compiler to create a runtime"
2518 "support environment, an executable program in the host"
2519 "operating system's native format, which can then be used to"
2520 "load and run 'core' files, which are basically programs"
2521 "in SBCL's own format."))
2522 (format t " * ~A~%" line))
2525 (format t "#ifndef _SBCL_H_~%#define _SBCL_H_~%")
2528 ;; propagating *SHEBANG-FEATURES* into C-level #define's
2529 (dolist (shebang-feature-name (sort (mapcar #'symbol-name
2530 sb-cold:*shebang-features*)
2533 "#define LISP_FEATURE_~A~%"
2534 (substitute #\_ #\- shebang-feature-name)))
2537 ;; writing miscellaneous constants
2538 (format t "#define SBCL_CORE_VERSION_INTEGER ~D~%" sbcl-core-version-integer)
2540 "#define SBCL_VERSION_STRING ~S~%"
2541 (sb!xc:lisp-implementation-version))
2542 (format t "#define CORE_MAGIC 0x~X~%" core-magic)
2544 ;; FIXME: Other things from core.h should be defined here too:
2545 ;; #define CORE_END 3840
2546 ;; #define CORE_NDIRECTORY 3861
2547 ;; #define CORE_VALIDATE 3845
2548 ;; #define CORE_VERSION 3860
2549 ;; #define CORE_MACHINE_STATE 3862
2550 ;; (Except that some of them are obsolete and should be deleted instead.)
2552 ;; #define DYNAMIC_SPACE_ID (1)
2553 ;; #define STATIC_SPACE_ID (2)
2554 ;; #define READ_ONLY_SPACE_ID (3)
2556 ;; writing entire families of named constants from SB!VM
2557 (let ((constants nil))
2558 (do-external-symbols (symbol (find-package "SB!VM"))
2559 (when (constantp symbol)
2560 (let ((name (symbol-name symbol)))
2561 (labels (;; shared machinery
2562 (record (string priority)
2565 (symbol-value symbol)
2566 (documentation symbol 'variable))
2568 ;; machinery for old-style CMU CL Lisp-to-C
2569 ;; arbitrary renaming, being phased out in favor of
2570 ;; the newer systematic RECORD-WITH-TRANSLATED-NAME
2572 (record-with-munged-name (prefix string priority)
2573 (record (concatenate
2576 (delete #\- (string-capitalize string)))
2578 (maybe-record-with-munged-name (tail prefix priority)
2579 (when (tailwise-equal name tail)
2580 (record-with-munged-name prefix
2585 ;; machinery for new-style SBCL Lisp-to-C naming
2586 (record-with-translated-name (priority)
2587 (record (substitute #\_ #\- name)
2589 (maybe-record-with-translated-name (suffixes priority)
2590 (when (some (lambda (suffix)
2591 (tailwise-equal name suffix))
2593 (record-with-translated-name priority))))
2595 (maybe-record-with-translated-name '("-LOWTAG") 0)
2596 (maybe-record-with-translated-name '("-WIDETAG") 1)
2597 (maybe-record-with-munged-name "-FLAG" "flag_" 2)
2598 (maybe-record-with-munged-name "-TRAP" "trap_" 3)
2599 (maybe-record-with-munged-name "-SUBTYPE" "subtype_" 4)
2600 (maybe-record-with-munged-name "-SC-NUMBER" "sc_" 5)
2601 (maybe-record-with-translated-name '("-START" "-END") 6)))))
2604 (lambda (const1 const2)
2605 (if (= (second const1) (second const2))
2606 (< (third const1) (third const2))
2607 (< (second const1) (second const2))))))
2608 (let ((prev-priority (second (car constants))))
2609 (dolist (const constants)
2610 (destructuring-bind (name priority value doc) const
2611 (unless (= prev-priority priority)
2613 (setf prev-priority priority))
2614 (format t "#define ~A " name)
2616 ;; KLUDGE: As of sbcl-0.6.7.14, we're dumping two
2617 ;; different kinds of values here, (1) small codes
2618 ;; and (2) machine addresses. The small codes can be
2619 ;; dumped as bare integer values. The large machine
2620 ;; addresses might cause problems if they're large
2621 ;; and represented as (signed) C integers, so we
2622 ;; want to force them to be unsigned. We do that by
2623 ;; wrapping them in the LISPOBJ macro. (We could do
2624 ;; it with a bare "(unsigned)" cast, except that
2625 ;; this header file is used not only in C files, but
2626 ;; also in assembly files, which don't understand
2627 ;; the cast syntax. The LISPOBJ macro goes away in
2628 ;; assembly files, but that shouldn't matter because
2629 ;; we don't do arithmetic on address constants in
2630 ;; assembly files. See? It really is a kludge..) --
2632 (let (;; cutoff for treatment as a small code
2633 (cutoff (expt 2 16)))
2634 (cond ((minusp value)
2635 (error "stub: negative values unsupported"))
2641 (format t " /* 0x~X */~@[ /* ~A */~]~%" value doc))))
2644 ;; writing codes/strings for internal errors
2645 (format t "#define ERRORS { \\~%")
2646 (let ((internal-errors sb!c:*backend-internal-errors*))
2647 (dotimes (i (length internal-errors))
2648 (format t " ~S, /*~D*/ \\~%" (cdr (aref internal-errors i)) i)))
2649 (format t " NULL \\~%}~%")
2652 ;; writing primitive object layouts
2653 (let ((structs (sort (copy-list sb!vm:*primitive-objects*) #'string<
2656 (sb!vm:primitive-object-name obj))))))
2657 (format t "#ifndef LANGUAGE_ASSEMBLY~2%")
2658 (format t "#define LISPOBJ(x) ((lispobj)x)~2%")
2659 (dolist (obj structs)
2662 (nsubstitute #\_ #\-
2663 (string-downcase (string (sb!vm:primitive-object-name obj)))))
2664 (when (sb!vm:primitive-object-widetag obj)
2665 (format t " lispobj header;~%"))
2666 (dolist (slot (sb!vm:primitive-object-slots obj))
2667 (format t " ~A ~A~@[[1]~];~%"
2668 (getf (sb!vm:slot-options slot) :c-type "lispobj")
2669 (nsubstitute #\_ #\-
2670 (string-downcase (string (sb!vm:slot-name slot))))
2671 (sb!vm:slot-rest-p slot)))
2673 (format t "#else /* LANGUAGE_ASSEMBLY */~2%")
2674 (format t "#define LISPOBJ(thing) thing~2%")
2675 (dolist (obj structs)
2676 (let ((name (sb!vm:primitive-object-name obj))
2677 (lowtag (eval (sb!vm:primitive-object-lowtag obj))))
2679 (dolist (slot (sb!vm:primitive-object-slots obj))
2680 (format t "#define ~A_~A_OFFSET ~D~%"
2681 (substitute #\_ #\- (string name))
2682 (substitute #\_ #\- (string (sb!vm:slot-name slot)))
2683 (- (* (sb!vm:slot-offset slot) sb!vm:n-word-bytes) lowtag)))
2685 (format t "#endif /* LANGUAGE_ASSEMBLY */~2%"))
2687 ;; writing static symbol offsets
2688 (dolist (symbol (cons nil sb!vm:*static-symbols*))
2689 ;; FIXME: It would be nice to use longer names than NIL and
2690 ;; (particularly) T in #define statements.
2691 (format t "#define ~A LISPOBJ(0x~X)~%"
2692 (nsubstitute #\_ #\-
2693 (remove-if (lambda (char)
2694 (member char '(#\% #\* #\. #\!)))
2695 (symbol-name symbol)))
2696 (if *static* ; if we ran GENESIS
2697 ;; We actually ran GENESIS, use the real value.
2698 (descriptor-bits (cold-intern symbol))
2699 ;; We didn't run GENESIS, so guess at the address.
2700 (+ sb!vm:static-space-start
2702 sb!vm:other-pointer-lowtag
2703 (if symbol (sb!vm:static-symbol-offset symbol) 0)))))
2706 (format t "~%#endif~%"))
2708 ;;;; writing map file
2710 ;;; Write a map file describing the cold load. Some of this
2711 ;;; information is subject to change due to relocating GC, but even so
2712 ;;; it can be very handy when attempting to troubleshoot the early
2713 ;;; stages of cold load.
2715 (let ((*print-pretty* nil)
2716 (*print-case* :upcase))
2717 (format t "assembler routines defined in core image:~2%")
2718 (dolist (routine (sort (copy-list *cold-assembler-routines*) #'<
2720 (format t "#X~8,'0X: ~S~%" (cdr routine) (car routine)))
2723 (maphash (lambda (name fdefn)
2724 (let ((fun (read-wordindexed fdefn
2725 sb!vm:fdefn-fun-slot)))
2726 (if (= (descriptor-bits fun)
2727 (descriptor-bits *nil-descriptor*))
2729 (let ((addr (read-wordindexed
2730 fdefn sb!vm:fdefn-raw-addr-slot)))
2731 (push (cons name (descriptor-bits addr))
2733 *cold-fdefn-objects*)
2734 (format t "~%~|~%initially defined functions:~2%")
2735 (setf funs (sort funs #'< :key #'cdr))
2737 (format t "0x~8,'0X: ~S #X~8,'0X~%" (cdr info) (car info)
2738 (- (cdr info) #x17)))
2741 (a note about initially undefined function references: These functions
2742 are referred to by code which is installed by GENESIS, but they are not
2743 installed by GENESIS. This is not necessarily a problem; functions can
2744 be defined later, by cold init toplevel forms, or in files compiled and
2745 loaded at warm init, or elsewhere. As long as they are defined before
2746 they are called, everything should be OK. Things are also OK if the
2747 cross-compiler knew their inline definition and used that everywhere
2748 that they were called before the out-of-line definition is installed,
2749 as is fairly common for structure accessors.)
2750 initially undefined function references:~2%")
2752 (setf undefs (sort undefs #'string< :key #'fun-name-block-name))
2753 (dolist (name undefs)
2754 (format t "~S~%" name)))
2756 (format t "~%~|~%layout names:~2%")
2758 (maphash (lambda (name gorp)
2759 (declare (ignore name))
2760 (stuff (cons (descriptor-bits (car gorp))
2763 (dolist (x (sort (stuff) #'< :key #'car))
2764 (apply #'format t "~8,'0X: ~S[~D]~%~10T~S~%" x))))
2768 ;;;; writing core file
2770 (defvar *core-file*)
2771 (defvar *data-page*)
2773 ;;; KLUDGE: These numbers correspond to values in core.h. If they're
2774 ;;; documented anywhere, I haven't found it. (I haven't tried very
2775 ;;; hard yet.) -- WHN 19990826
2776 (defparameter version-entry-type-code 3860)
2777 (defparameter validate-entry-type-code 3845)
2778 (defparameter directory-entry-type-code 3841)
2779 (defparameter new-directory-entry-type-code 3861)
2780 (defparameter initial-fun-entry-type-code 3863)
2781 (defparameter end-entry-type-code 3840)
2783 (declaim (ftype (function (sb!vm:word) sb!vm:word) write-word))
2784 (defun write-word (num)
2785 (ecase sb!c:*backend-byte-order*
2788 (write-byte (ldb (byte 8 (* i 8)) num) *core-file*)))
2791 (write-byte (ldb (byte 8 (* (- 3 i) 8)) num) *core-file*))))
2794 (defun advance-to-page ()
2795 (force-output *core-file*)
2796 (file-position *core-file*
2797 (round-up (file-position *core-file*)
2798 sb!c:*backend-page-size*)))
2800 (defun output-gspace (gspace)
2801 (force-output *core-file*)
2802 (let* ((posn (file-position *core-file*))
2803 (bytes (* (gspace-free-word-index gspace) sb!vm:n-word-bytes))
2804 (pages (ceiling bytes sb!c:*backend-page-size*))
2805 (total-bytes (* pages sb!c:*backend-page-size*)))
2807 (file-position *core-file*
2808 (* sb!c:*backend-page-size* (1+ *data-page*)))
2810 "writing ~S byte~:P [~S page~:P] from ~S~%"
2816 ;; Note: It is assumed that the GSPACE allocation routines always
2817 ;; allocate whole pages (of size *target-page-size*) and that any
2818 ;; empty gspace between the free pointer and the end of page will
2819 ;; be zero-filled. This will always be true under Mach on machines
2820 ;; where the page size is equal. (RT is 4K, PMAX is 4K, Sun 3 is
2822 (write-sequence (gspace-bytes gspace) *core-file* :end total-bytes)
2823 (force-output *core-file*)
2824 (file-position *core-file* posn)
2826 ;; Write part of a (new) directory entry which looks like this:
2827 ;; GSPACE IDENTIFIER
2832 (write-word (gspace-identifier gspace))
2833 (write-word (gspace-free-word-index gspace))
2834 (write-word *data-page*)
2835 (multiple-value-bind (floor rem)
2836 (floor (gspace-byte-address gspace) sb!c:*backend-page-size*)
2841 (incf *data-page* pages)))
2843 ;;; Create a core file created from the cold loaded image. (This is
2844 ;;; the "initial core file" because core files could be created later
2845 ;;; by executing SAVE-LISP in a running system, perhaps after we've
2846 ;;; added some functionality to the system.)
2847 (declaim (ftype (function (string)) write-initial-core-file))
2848 (defun write-initial-core-file (filename)
2850 (let ((filenamestring (namestring filename))
2854 "[building initial core file in ~S: ~%"
2858 (with-open-file (*core-file* filenamestring
2860 :element-type '(unsigned-byte 8)
2861 :if-exists :rename-and-delete)
2863 ;; Write the magic number.
2864 (write-word core-magic)
2866 ;; Write the Version entry.
2867 (write-word version-entry-type-code)
2869 (write-word sbcl-core-version-integer)
2871 ;; Write the New Directory entry header.
2872 (write-word new-directory-entry-type-code)
2873 (write-word 17) ; length = (5 words/space) * 3 spaces + 2 for header.
2875 (output-gspace *read-only*)
2876 (output-gspace *static*)
2877 (output-gspace *dynamic*)
2879 ;; Write the initial function.
2880 (write-word initial-fun-entry-type-code)
2882 (let* ((cold-name (cold-intern '!cold-init))
2883 (cold-fdefn (cold-fdefinition-object cold-name))
2884 (initial-fun (read-wordindexed cold-fdefn
2885 sb!vm:fdefn-fun-slot)))
2887 "~&/(DESCRIPTOR-BITS INITIAL-FUN)=#X~X~%"
2888 (descriptor-bits initial-fun))
2889 (write-word (descriptor-bits initial-fun)))
2891 ;; Write the End entry.
2892 (write-word end-entry-type-code)
2895 (format t "done]~%")
2897 (/show "leaving WRITE-INITIAL-CORE-FILE")
2900 ;;;; the actual GENESIS function
2902 ;;; Read the FASL files in OBJECT-FILE-NAMES and produce a Lisp core,
2903 ;;; and/or information about a Lisp core, therefrom.
2905 ;;; input file arguments:
2906 ;;; SYMBOL-TABLE-FILE-NAME names a UNIX-style .nm file *with* *any*
2907 ;;; *tab* *characters* *converted* *to* *spaces*. (We push
2908 ;;; responsibility for removing tabs out to the caller it's
2909 ;;; trivial to remove them using UNIX command line tools like
2910 ;;; sed, whereas it's a headache to do it portably in Lisp because
2911 ;;; #\TAB is not a STANDARD-CHAR.) If this file is not supplied,
2912 ;;; a core file cannot be built (but a C header file can be).
2914 ;;; output files arguments (any of which may be NIL to suppress output):
2915 ;;; CORE-FILE-NAME gets a Lisp core.
2916 ;;; C-HEADER-FILE-NAME gets a C header file, traditionally called
2917 ;;; internals.h, which is used by the C compiler when constructing
2918 ;;; the executable which will load the core.
2919 ;;; MAP-FILE-NAME gets (?) a map file. (dunno about this -- WHN 19990815)
2921 ;;; other arguments:
2922 ;;; BYTE-ORDER-SWAP-P controls whether GENESIS tries to swap bytes
2923 ;;; in some places in the output. It's only appropriate when
2924 ;;; cross-compiling from a machine with one byte order to a
2925 ;;; machine with the opposite byte order, which is irrelevant in
2926 ;;; current (19990816) SBCL, since only the X86 architecture is
2927 ;;; supported. If you're trying to add support for more
2928 ;;; architectures, see the comments on DEFVAR
2929 ;;; *GENESIS-BYTE-ORDER-SWAP-P* for more information.
2931 ;;; FIXME: GENESIS doesn't belong in SB!VM. Perhaps in %KERNEL for now,
2932 ;;; perhaps eventually in SB-LD or SB-BOOT.
2933 (defun sb!vm:genesis (&key
2935 symbol-table-file-name
2941 (when (and core-file-name
2942 (not symbol-table-file-name))
2943 (error "can't output a core file without symbol table file input"))
2946 "~&beginning GENESIS, ~A~%"
2948 ;; Note: This output summarizing what we're doing is
2949 ;; somewhat telegraphic in style, not meant to imply that
2950 ;; we're not e.g. also creating a header file when we
2952 (format nil "creating core ~S" core-file-name)
2953 (format nil "creating header ~S" c-header-file-name)))
2955 (let* ((*cold-foreign-symbol-table* (make-hash-table :test 'equal)))
2957 ;; Read symbol table, if any.
2958 (when symbol-table-file-name
2959 (load-cold-foreign-symbol-table symbol-table-file-name))
2961 ;; Now that we've successfully read our only input file (by
2962 ;; loading the symbol table, if any), it's a good time to ensure
2963 ;; that there'll be someplace for our output files to go when
2965 (flet ((frob (filename)
2967 (ensure-directories-exist filename :verbose t))))
2968 (frob core-file-name)
2969 (frob map-file-name)
2970 (frob c-header-file-name))
2972 ;; (This shouldn't matter in normal use, since GENESIS normally
2973 ;; only runs once in any given Lisp image, but it could reduce
2974 ;; confusion if we ever experiment with running, tweaking, and
2975 ;; rerunning genesis interactively.)
2976 (do-all-symbols (sym)
2977 (remprop sym 'cold-intern-info))
2979 (let* ((*foreign-symbol-placeholder-value* (if core-file-name nil 0))
2980 (*load-time-value-counter* 0)
2981 (*genesis-byte-order-swap-p* byte-order-swap-p)
2982 (*cold-fdefn-objects* (make-hash-table :test 'equal))
2983 (*cold-symbols* (make-hash-table :test 'equal))
2984 (*cold-package-symbols* nil)
2985 (*read-only* (make-gspace :read-only
2987 sb!vm:read-only-space-start))
2988 (*static* (make-gspace :static
2990 sb!vm:static-space-start))
2991 (*dynamic* (make-gspace :dynamic
2993 #!+gencgc sb!vm:dynamic-space-start
2994 #!-gencgc sb!vm:dynamic-0-space-start))
2995 (*nil-descriptor* (make-nil-descriptor))
2996 (*current-reversed-cold-toplevels* *nil-descriptor*)
2997 (*unbound-marker* (make-other-immediate-descriptor
2999 sb!vm:unbound-marker-widetag))
3000 *cold-assembler-fixups*
3001 *cold-assembler-routines*
3002 #!+x86 *load-time-code-fixups*)
3004 ;; Prepare for cold load.
3005 (initialize-non-nil-symbols)
3006 (initialize-layouts)
3007 (initialize-static-fns)
3009 ;; Initialize the *COLD-SYMBOLS* system with the information
3010 ;; from package-data-list.lisp-expr and
3011 ;; common-lisp-exports.lisp-expr.
3013 ;; Why do things this way? Historically, the *COLD-SYMBOLS*
3014 ;; machinery was designed and implemented in CMU CL long before
3015 ;; I (WHN) ever heard of CMU CL. It dumped symbols and packages
3016 ;; iff they were used in the cold image. When I added the
3017 ;; package-data-list.lisp-expr mechanism, the idea was to
3018 ;; centralize all information about packages and exports. Thus,
3019 ;; it was the natural place for information even about packages
3020 ;; (such as SB!PCL and SB!WALKER) which aren't used much until
3021 ;; after cold load. This didn't quite match the CMU CL approach
3022 ;; of filling *COLD-SYMBOLS* with symbols which appear in the
3023 ;; cold image and then dumping only those symbols. By explicitly
3024 ;; putting all the symbols from package-data-list.lisp-expr and
3025 ;; from common-lisp-exports.lisp-expr into *COLD-SYMBOLS* here,
3026 ;; we feed our centralized symbol information into the old CMU
3027 ;; CL code without having to change the old CMU CL code too
3028 ;; much. (And the old CMU CL code is still useful for making
3029 ;; sure that the appropriate keywords and internal symbols end
3030 ;; up interned in the target Lisp, which is good, e.g. in order
3031 ;; to make &KEY arguments work right and in order to make
3032 ;; BACKTRACEs into target Lisp system code be legible.)
3033 (dolist (exported-name
3034 (sb-cold:read-from-file "common-lisp-exports.lisp-expr"))
3035 (cold-intern (intern exported-name *cl-package*)))
3036 (dolist (pd (sb-cold:read-from-file "package-data-list.lisp-expr"))
3037 (declare (type sb-cold:package-data pd))
3038 (let ((package (find-package (sb-cold:package-data-name pd))))
3039 (labels (;; Call FN on every node of the TREE.
3040 (mapc-on-tree (fn tree)
3042 (cons (mapc-on-tree fn (car tree))
3043 (mapc-on-tree fn (cdr tree)))
3044 (t (funcall fn tree)
3046 ;; Make sure that information about the association
3047 ;; between PACKAGE and the symbol named NAME gets
3048 ;; recorded in the cold-intern system or (as a
3049 ;; convenience when dealing with the tree structure
3050 ;; allowed in the PACKAGE-DATA-EXPORTS slot) do
3051 ;; nothing if NAME is NIL.
3054 (cold-intern (intern name package) package))))
3055 (mapc-on-tree #'chill (sb-cold:package-data-export pd))
3056 (mapc #'chill (sb-cold:package-data-reexport pd))
3057 (dolist (sublist (sb-cold:package-data-import-from pd))
3058 (destructuring-bind (package-name &rest symbol-names) sublist
3059 (declare (ignore package-name))
3060 (mapc #'chill symbol-names))))))
3063 (dolist (file-name object-file-names)
3064 (write-line (namestring file-name))
3065 (cold-load file-name))
3067 ;; Tidy up loose ends left by cold loading. ("Postpare from cold load?")
3068 (resolve-assembler-fixups)
3069 #!+x86 (output-load-time-code-fixups)
3070 (linkage-info-to-core)
3072 (/show "back from FINISH-SYMBOLS")
3073 (finalize-load-time-value-noise)
3075 ;; Tell the target Lisp how much stuff we've allocated.
3076 (cold-set 'sb!vm:*read-only-space-free-pointer*
3077 (allocate-cold-descriptor *read-only*
3079 sb!vm:even-fixnum-lowtag))
3080 (cold-set 'sb!vm:*static-space-free-pointer*
3081 (allocate-cold-descriptor *static*
3083 sb!vm:even-fixnum-lowtag))
3084 (cold-set 'sb!vm:*initial-dynamic-space-free-pointer*
3085 (allocate-cold-descriptor *dynamic*
3087 sb!vm:even-fixnum-lowtag))
3088 (/show "done setting free pointers")
3090 ;; Write results to files.
3092 ;; FIXME: I dislike this approach of redefining
3093 ;; *STANDARD-OUTPUT* instead of putting the new stream in a
3094 ;; lexical variable, and it's annoying to have WRITE-MAP (to
3095 ;; *STANDARD-OUTPUT*) not be parallel to WRITE-INITIAL-CORE-FILE
3096 ;; (to a stream explicitly passed as an argument).
3098 (with-open-file (*standard-output* map-file-name
3100 :if-exists :supersede)
3102 (when c-header-file-name
3103 (with-open-file (*standard-output* c-header-file-name
3105 :if-exists :supersede)
3107 (when core-file-name
3108 (write-initial-core-file core-file-name)))))