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 SAP-INT we use here.)
467 (declaim (ftype (function (sb!vm:word descriptor) (values))
468 note-load-time-value-reference))
469 (defun note-load-time-value-reference (address marker)
470 (cold-push (cold-cons
471 (cold-intern :load-time-value-fixup)
472 (cold-cons (sap-int-to-core address)
474 (number-to-core (descriptor-word-offset marker))
476 *current-reversed-cold-toplevels*)
479 (declaim (ftype (function (descriptor sb!vm:word descriptor)) write-wordindexed))
480 (defun write-wordindexed (address index value)
482 "Write VALUE displaced INDEX words from ADDRESS."
483 ;; KLUDGE: There is an algorithm (used in DESCRIPTOR-INTUIT-GSPACE)
484 ;; for calculating the value of the GSPACE slot from scratch. It
485 ;; doesn't work for all values, only some of them, but mightn't it
486 ;; be reasonable to see whether it works on VALUE before we give up
487 ;; because (DESCRIPTOR-GSPACE VALUE) isn't set? (Or failing that,
488 ;; perhaps write a comment somewhere explaining why it's not a good
489 ;; idea?) -- WHN 19990817
490 (if (and (null (descriptor-gspace value))
491 (not (null (descriptor-word-offset value))))
492 (note-load-time-value-reference (+ (logandc2 (descriptor-bits address)
494 (ash index sb!vm:word-shift))
496 ;; Note: There's a MAYBE-BYTE-SWAP in here in CMU CL, which I
497 ;; think is unnecessary now that we're doing the write
498 ;; byte-by-byte at high level. (I can't test this, though..) --
500 (let* ((bytes (gspace-bytes (descriptor-intuit-gspace address)))
501 (byte-index (ash (+ index (descriptor-word-offset address))
503 (setf (byte-vector-ref-32 bytes byte-index)
504 (maybe-byte-swap (descriptor-bits value))))))
506 (declaim (ftype (function (descriptor descriptor)) write-memory))
507 (defun write-memory (address value)
509 "Write VALUE (a DESCRIPTOR) at ADDRESS (also a DESCRIPTOR)."
510 (write-wordindexed address 0 value))
512 ;;;; allocating images of primitive objects in the cold core
514 ;;; There are three kinds of blocks of memory in the type system:
515 ;;; * Boxed objects (cons cells, structures, etc): These objects have no
516 ;;; header as all slots are descriptors.
517 ;;; * Unboxed objects (bignums): There is a single header word that contains
519 ;;; * Vector objects: There is a header word with the type, then a word for
520 ;;; the length, then the data.
521 (defun allocate-boxed-object (gspace length lowtag)
523 "Allocate LENGTH words in GSPACE and return a new descriptor of type LOWTAG
525 (allocate-cold-descriptor gspace (ash length sb!vm:word-shift) lowtag))
526 (defun allocate-unboxed-object (gspace element-bits length type)
528 "Allocate LENGTH units of ELEMENT-BITS bits plus a header word in GSPACE and
529 return an ``other-pointer'' descriptor to them. Initialize the header word
530 with the resultant length and TYPE."
531 (let* ((bytes (/ (* element-bits length) sb!vm:n-byte-bits))
532 (des (allocate-cold-descriptor gspace
533 (+ bytes sb!vm:n-word-bytes)
534 sb!vm:other-pointer-lowtag)))
536 (make-other-immediate-descriptor (ash bytes
537 (- sb!vm:word-shift))
540 (defun allocate-vector-object (gspace element-bits length type)
542 "Allocate LENGTH units of ELEMENT-BITS size plus a header plus a length slot in
543 GSPACE and return an ``other-pointer'' descriptor to them. Initialize the
544 header word with TYPE and the length slot with LENGTH."
545 ;; FIXME: Here and in ALLOCATE-UNBOXED-OBJECT, BYTES is calculated using
546 ;; #'/ instead of #'CEILING, which seems wrong.
547 (let* ((bytes (/ (* element-bits length) sb!vm:n-byte-bits))
548 (des (allocate-cold-descriptor gspace
549 (+ bytes (* 2 sb!vm:n-word-bytes))
550 sb!vm:other-pointer-lowtag)))
551 (write-memory des (make-other-immediate-descriptor 0 type))
552 (write-wordindexed des
553 sb!vm:vector-length-slot
554 (make-fixnum-descriptor length))
557 ;;;; copying simple objects into the cold core
559 (defun string-to-core (string &optional (gspace *dynamic*))
561 "Copy string into the cold core and return a descriptor to it."
562 ;; (Remember that the system convention for storage of strings leaves an
563 ;; extra null byte at the end to aid in call-out to C.)
564 (let* ((length (length string))
565 (des (allocate-vector-object gspace
568 sb!vm:simple-string-widetag))
569 (bytes (gspace-bytes gspace))
570 (offset (+ (* sb!vm:vector-data-offset sb!vm:n-word-bytes)
571 (descriptor-byte-offset des))))
572 (write-wordindexed des
573 sb!vm:vector-length-slot
574 (make-fixnum-descriptor length))
576 (setf (aref bytes (+ offset i))
577 ;; KLUDGE: There's no guarantee that the character
578 ;; encoding here will be the same as the character
579 ;; encoding on the target machine, so using CHAR-CODE as
580 ;; we do, or a bitwise copy as CMU CL code did, is sleazy.
581 ;; (To make this more portable, perhaps we could use
582 ;; indices into the sequence which is used to test whether
583 ;; a character is a STANDARD-CHAR?) -- WHN 19990817
584 (char-code (aref string i))))
585 (setf (aref bytes (+ offset length))
586 0) ; null string-termination character for C
589 (defun bignum-to-core (n)
591 "Copy a bignum to the cold core."
592 (let* ((words (ceiling (1+ (integer-length n)) sb!vm:n-word-bits))
593 (handle (allocate-unboxed-object *dynamic*
596 sb!vm:bignum-widetag)))
597 (declare (fixnum words))
598 (do ((index 1 (1+ index))
599 (remainder n (ash remainder (- sb!vm:n-word-bits))))
601 (unless (zerop (integer-length remainder))
602 ;; FIXME: Shouldn't this be a fatal error?
603 (warn "~W words of ~W were written, but ~W bits were left over."
605 (let ((word (ldb (byte sb!vm:n-word-bits 0) remainder)))
606 (write-wordindexed handle index
607 (make-descriptor (ash word (- descriptor-low-bits))
608 (ldb (byte descriptor-low-bits 0)
612 (defun number-pair-to-core (first second type)
614 "Makes a number pair of TYPE (ratio or complex) and fills it in."
615 (let ((des (allocate-unboxed-object *dynamic* sb!vm:n-word-bits 2 type)))
616 (write-wordindexed des 1 first)
617 (write-wordindexed des 2 second)
620 (defun float-to-core (x)
623 (let ((des (allocate-unboxed-object *dynamic*
625 (1- sb!vm:single-float-size)
626 sb!vm:single-float-widetag)))
627 (write-wordindexed des
628 sb!vm:single-float-value-slot
629 (make-random-descriptor (single-float-bits x)))
632 (let ((des (allocate-unboxed-object *dynamic*
634 (1- sb!vm:double-float-size)
635 sb!vm:double-float-widetag))
636 (high-bits (make-random-descriptor (double-float-high-bits x)))
637 (low-bits (make-random-descriptor (double-float-low-bits x))))
638 (ecase sb!c:*backend-byte-order*
640 (write-wordindexed des sb!vm:double-float-value-slot low-bits)
641 (write-wordindexed des (1+ sb!vm:double-float-value-slot) high-bits))
643 (write-wordindexed des sb!vm:double-float-value-slot high-bits)
644 (write-wordindexed des (1+ sb!vm:double-float-value-slot) low-bits)))
646 #!+(and long-float x86)
648 (let ((des (allocate-unboxed-object *dynamic*
650 (1- sb!vm:long-float-size)
651 sb!vm:long-float-widetag))
652 (exp-bits (make-random-descriptor (long-float-exp-bits x)))
653 (high-bits (make-random-descriptor (long-float-high-bits x)))
654 (low-bits (make-random-descriptor (long-float-low-bits x))))
655 (ecase sb!c:*backend-byte-order*
657 (write-wordindexed des sb!vm:long-float-value-slot low-bits)
658 (write-wordindexed des (1+ sb!vm:long-float-value-slot) high-bits)
659 (write-wordindexed des (+ 2 sb!vm:long-float-value-slot) exp-bits))
661 (error "LONG-FLOAT is not supported for big-endian byte order.")))
664 (defun complex-single-float-to-core (num)
665 (declare (type (complex single-float) num))
666 (let ((des (allocate-unboxed-object *dynamic* sb!vm:n-word-bits
667 (1- sb!vm:complex-single-float-size)
668 sb!vm:complex-single-float-widetag)))
669 (write-wordindexed des sb!vm:complex-single-float-real-slot
670 (make-random-descriptor (single-float-bits (realpart num))))
671 (write-wordindexed des sb!vm:complex-single-float-imag-slot
672 (make-random-descriptor (single-float-bits (imagpart num))))
675 (defun complex-double-float-to-core (num)
676 (declare (type (complex double-float) num))
677 (let ((des (allocate-unboxed-object *dynamic* sb!vm:n-word-bits
678 (1- sb!vm:complex-double-float-size)
679 sb!vm:complex-double-float-widetag)))
680 (let* ((real (realpart num))
681 (high-bits (make-random-descriptor (double-float-high-bits real)))
682 (low-bits (make-random-descriptor (double-float-low-bits real))))
683 (ecase sb!c:*backend-byte-order*
685 (write-wordindexed des sb!vm:complex-double-float-real-slot low-bits)
686 (write-wordindexed des (1+ sb!vm:complex-double-float-real-slot) high-bits))
688 (write-wordindexed des sb!vm:complex-double-float-real-slot high-bits)
689 (write-wordindexed des (1+ sb!vm:complex-double-float-real-slot) low-bits))))
690 (let* ((imag (imagpart num))
691 (high-bits (make-random-descriptor (double-float-high-bits imag)))
692 (low-bits (make-random-descriptor (double-float-low-bits imag))))
693 (ecase sb!c:*backend-byte-order*
695 (write-wordindexed des sb!vm:complex-double-float-imag-slot low-bits)
696 (write-wordindexed des (1+ sb!vm:complex-double-float-imag-slot) high-bits))
698 (write-wordindexed des sb!vm:complex-double-float-imag-slot high-bits)
699 (write-wordindexed des (1+ sb!vm:complex-double-float-imag-slot) low-bits))))
702 (defun number-to-core (number)
704 "Copy the given number to the core, or flame out if we can't deal with it."
706 (integer (if (< (integer-length number) 30)
707 (make-fixnum-descriptor number)
708 (bignum-to-core number)))
709 (ratio (number-pair-to-core (number-to-core (numerator number))
710 (number-to-core (denominator number))
711 sb!vm:ratio-widetag))
712 ((complex single-float) (complex-single-float-to-core number))
713 ((complex double-float) (complex-double-float-to-core number))
715 ((complex long-float)
716 (error "~S isn't a cold-loadable number at all!" number))
717 (complex (number-pair-to-core (number-to-core (realpart number))
718 (number-to-core (imagpart number))
719 sb!vm:complex-widetag))
720 (float (float-to-core number))
721 (t (error "~S isn't a cold-loadable number at all!" number))))
723 (declaim (ftype (function (sb!vm:word) descriptor) sap-int-to-core))
724 (defun sap-int-to-core (sap-int)
725 (let ((des (allocate-unboxed-object *dynamic*
729 (write-wordindexed des
730 sb!vm:sap-pointer-slot
731 (make-random-descriptor sap-int))
734 ;;; Allocate a cons cell in GSPACE and fill it in with CAR and CDR.
735 (defun cold-cons (car cdr &optional (gspace *dynamic*))
736 (let ((dest (allocate-boxed-object gspace 2 sb!vm:list-pointer-lowtag)))
737 (write-memory dest car)
738 (write-wordindexed dest 1 cdr)
741 ;;; Make a simple-vector that holds the specified OBJECTS, and return its
743 (defun vector-in-core (&rest objects)
744 (let* ((size (length objects))
745 (result (allocate-vector-object *dynamic* sb!vm:n-word-bits size
746 sb!vm:simple-vector-widetag)))
747 (dotimes (index size)
748 (write-wordindexed result (+ index sb!vm:vector-data-offset)
754 ;;; FIXME: This should be a &KEY argument of ALLOCATE-SYMBOL.
755 (defvar *cold-symbol-allocation-gspace* nil)
757 ;;; Allocate (and initialize) a symbol.
758 (defun allocate-symbol (name)
759 (declare (simple-string name))
760 (let ((symbol (allocate-unboxed-object (or *cold-symbol-allocation-gspace*
763 (1- sb!vm:symbol-size)
764 sb!vm:symbol-header-widetag)))
765 (write-wordindexed symbol sb!vm:symbol-value-slot *unbound-marker*)
767 (write-wordindexed symbol
768 sb!vm:symbol-hash-slot
769 (make-fixnum-descriptor
770 (1+ (random sb!xc:most-positive-fixnum))))
771 (write-wordindexed symbol sb!vm:symbol-plist-slot *nil-descriptor*)
772 (write-wordindexed symbol sb!vm:symbol-name-slot
773 (string-to-core name *dynamic*))
774 (write-wordindexed symbol sb!vm:symbol-package-slot *nil-descriptor*)
777 ;;; Set the cold symbol value of SYMBOL-OR-SYMBOL-DES, which can be either a
778 ;;; descriptor of a cold symbol or (in an abbreviation for the
779 ;;; most common usage pattern) an ordinary symbol, which will be
780 ;;; automatically cold-interned.
781 (declaim (ftype (function ((or descriptor symbol) descriptor)) cold-set))
782 (defun cold-set (symbol-or-symbol-des value)
783 (let ((symbol-des (etypecase symbol-or-symbol-des
784 (descriptor symbol-or-symbol-des)
785 (symbol (cold-intern symbol-or-symbol-des)))))
786 (write-wordindexed symbol-des sb!vm:symbol-value-slot value)))
788 ;;;; layouts and type system pre-initialization
790 ;;; Since we want to be able to dump structure constants and
791 ;;; predicates with reference layouts, we need to create layouts at
792 ;;; cold-load time. We use the name to intern layouts by, and dump a
793 ;;; list of all cold layouts in *!INITIAL-LAYOUTS* so that type system
794 ;;; initialization can find them. The only thing that's tricky [sic --
795 ;;; WHN 19990816] is initializing layout's layout, which must point to
798 ;;; a map from class names to lists of
799 ;;; `(,descriptor ,name ,length ,inherits ,depth)
800 ;;; KLUDGE: It would be more understandable and maintainable to use
801 ;;; DEFSTRUCT (:TYPE LIST) here. -- WHN 19990823
802 (defvar *cold-layouts* (make-hash-table :test 'equal))
804 ;;; a map from DESCRIPTOR-BITS of cold layouts to the name, for inverting
806 (defvar *cold-layout-names* (make-hash-table :test 'eql))
808 ;;; FIXME: *COLD-LAYOUTS* and *COLD-LAYOUT-NAMES* should be
809 ;;; initialized by binding in GENESIS.
811 ;;; the descriptor for layout's layout (needed when making layouts)
812 (defvar *layout-layout*)
814 ;;; FIXME: This information should probably be pulled out of the
815 ;;; cross-compiler's tables at genesis time instead of inserted by
816 ;;; hand here as a bare numeric constant.
817 (defconstant target-layout-length 16)
819 ;;; Return a list of names created from the cold layout INHERITS data
821 (defun listify-cold-inherits (x)
822 (let ((len (descriptor-fixnum (read-wordindexed x
823 sb!vm:vector-length-slot))))
826 (let* ((des (read-wordindexed x (+ sb!vm:vector-data-offset index)))
827 (found (gethash (descriptor-bits des) *cold-layout-names*)))
830 (error "unknown descriptor at index ~S (bits = ~8,'0X)"
832 (descriptor-bits des)))))
835 (declaim (ftype (function (symbol descriptor descriptor descriptor) descriptor)
837 (defun make-cold-layout (name length inherits depthoid)
838 (let ((result (allocate-boxed-object *dynamic*
839 ;; KLUDGE: Why 1+? -- WHN 19990901
840 (1+ target-layout-length)
841 sb!vm:instance-pointer-lowtag)))
843 (make-other-immediate-descriptor
844 target-layout-length sb!vm:instance-header-widetag))
846 ;; KLUDGE: The offsets into LAYOUT below should probably be pulled out
847 ;; of the cross-compiler's tables at genesis time instead of inserted
848 ;; by hand as bare numeric constants. -- WHN ca. 19990901
850 ;; Set slot 0 = the layout of the layout.
851 (write-wordindexed result sb!vm:instance-slots-offset *layout-layout*)
853 ;; Set the immediately following slots = CLOS hash values.
855 ;; Note: CMU CL didn't set these in genesis, but instead arranged
856 ;; for them to be set at cold init time. That resulted in slightly
857 ;; kludgy-looking code, but there were at least two things to be
859 ;; 1. It put the hash values under the control of the target Lisp's
860 ;; RANDOM function, so that CLOS behavior would be nearly
861 ;; deterministic (instead of depending on the implementation of
862 ;; RANDOM in the cross-compilation host, and the state of its
863 ;; RNG when genesis begins).
864 ;; 2. It automatically ensured that all hash values in the target Lisp
865 ;; were part of the same sequence, so that we didn't have to worry
866 ;; about the possibility of the first hash value set in genesis
867 ;; being precisely equal to the some hash value set in cold init time
868 ;; (because the target Lisp RNG has advanced to precisely the same
869 ;; state that the host Lisp RNG was in earlier).
870 ;; Point 1 should not be an issue in practice because of the way we do our
871 ;; build procedure in two steps, so that the SBCL that we end up with has
872 ;; been created by another SBCL (whose RNG is under our control).
873 ;; Point 2 is more of an issue. If ANSI had provided a way to feed
874 ;; entropy into an RNG, we would have no problem: we'd just feed
875 ;; some specialized genesis-time-only pattern into the RNG state
876 ;; before using it. However, they didn't, so we have a slight
877 ;; problem. We address it by generating the hash values using a
878 ;; different algorithm than we use in ordinary operation.
879 (dotimes (i sb!kernel:layout-clos-hash-length)
880 (let (;; The expression here is pretty arbitrary, we just want
881 ;; to make sure that it's not something which is (1)
882 ;; evenly distributed and (2) not foreordained to arise in
883 ;; the target Lisp's (RANDOM-LAYOUT-CLOS-HASH) sequence
884 ;; and show up as the CLOS-HASH value of some other
887 ;; FIXME: This expression here can generate a zero value,
888 ;; and the CMU CL code goes out of its way to generate
889 ;; strictly positive values (even though the field is
890 ;; declared as an INDEX). Check that it's really OK to
891 ;; have zero values in the CLOS-HASH slots.
892 (hash-value (mod (logxor (logand (random-layout-clos-hash) 15253)
893 (logandc2 (random-layout-clos-hash) 15253)
895 ;; (The MOD here is defensive programming
896 ;; to make sure we never write an
897 ;; out-of-range value even if some joker
898 ;; sets LAYOUT-CLOS-HASH-MAX to other
899 ;; than 2^n-1 at some time in the
901 (1+ sb!kernel:layout-clos-hash-max))))
902 (write-wordindexed result
903 (+ i sb!vm:instance-slots-offset 1)
904 (make-fixnum-descriptor hash-value))))
906 ;; Set other slot values.
907 (let ((base (+ sb!vm:instance-slots-offset
908 sb!kernel:layout-clos-hash-length
910 ;; (Offset 0 is CLASS, "the class this is a layout for", which
911 ;; is uninitialized at this point.)
912 (write-wordindexed result (+ base 1) *nil-descriptor*) ; marked invalid
913 (write-wordindexed result (+ base 2) inherits)
914 (write-wordindexed result (+ base 3) depthoid)
915 (write-wordindexed result (+ base 4) length)
916 (write-wordindexed result (+ base 5) *nil-descriptor*) ; info
917 (write-wordindexed result (+ base 6) *nil-descriptor*)) ; pure
919 (setf (gethash name *cold-layouts*)
922 (descriptor-fixnum length)
923 (listify-cold-inherits inherits)
924 (descriptor-fixnum depthoid)))
925 (setf (gethash (descriptor-bits result) *cold-layout-names*) name)
929 (defun initialize-layouts ()
931 (clrhash *cold-layouts*)
933 ;; We initially create the layout of LAYOUT itself with NIL as the LAYOUT and
935 (setq *layout-layout* *nil-descriptor*)
936 (setq *layout-layout*
937 (make-cold-layout 'layout
938 (number-to-core target-layout-length)
940 ;; FIXME: hard-coded LAYOUT-DEPTHOID of LAYOUT..
942 (write-wordindexed *layout-layout*
943 sb!vm:instance-slots-offset
946 ;; Then we create the layouts that we'll need to make a correct INHERITS
947 ;; vector for the layout of LAYOUT itself..
949 ;; FIXME: The various LENGTH and DEPTHOID numbers should be taken from
950 ;; the compiler's tables, not set by hand.
957 (make-cold-layout 'instance
959 (vector-in-core t-layout)
962 (make-cold-layout 'structure-object
964 (vector-in-core t-layout i-layout)
967 (make-cold-layout 'structure!object
969 (vector-in-core t-layout i-layout so-layout)
971 (layout-inherits (vector-in-core t-layout
976 ;; ..and return to backpatch the layout of LAYOUT.
977 (setf (fourth (gethash 'layout *cold-layouts*))
978 (listify-cold-inherits layout-inherits))
979 (write-wordindexed *layout-layout*
980 ;; FIXME: hardcoded offset into layout struct
981 (+ sb!vm:instance-slots-offset
982 layout-clos-hash-length
987 ;;;; interning symbols in the cold image
989 ;;; In order to avoid having to know about the package format, we
990 ;;; build a data structure in *COLD-PACKAGE-SYMBOLS* that holds all
991 ;;; interned symbols along with info about their packages. The data
992 ;;; structure is a list of sublists, where the sublists have the
993 ;;; following format:
994 ;;; (<make-package-arglist>
995 ;;; <internal-symbols>
996 ;;; <external-symbols>
997 ;;; <imported-internal-symbols>
998 ;;; <imported-external-symbols>
999 ;;; <shadowing-symbols>)
1001 ;;; KLUDGE: It would be nice to implement the sublists as instances of
1002 ;;; a DEFSTRUCT (:TYPE LIST). (They'd still be lists, but at least we'd be
1003 ;;; using mnemonically-named operators to access them, instead of trying
1004 ;;; to remember what THIRD and FIFTH mean, and hoping that we never
1005 ;;; need to change the list layout..) -- WHN 19990825
1007 ;;; an alist from packages to lists of that package's symbols to be dumped
1008 (defvar *cold-package-symbols*)
1009 (declaim (type list *cold-package-symbols*))
1011 ;;; a map from descriptors to symbols, so that we can back up. The key
1012 ;;; is the address in the target core.
1013 (defvar *cold-symbols*)
1014 (declaim (type hash-table *cold-symbols*))
1016 ;;; Return a handle on an interned symbol. If necessary allocate the
1017 ;;; symbol and record which package the symbol was referenced in. When
1018 ;;; we allocate the symbol, make sure we record a reference to the
1019 ;;; symbol in the home package so that the package gets set.
1020 (defun cold-intern (symbol &optional (package (symbol-package symbol)))
1022 ;; Anything on the cross-compilation host which refers to the target
1023 ;; machinery through the host SB-XC package should be translated to
1024 ;; something on the target which refers to the same machinery
1025 ;; through the target COMMON-LISP package.
1026 (let ((p (find-package "SB-XC")))
1027 (when (eq package p)
1028 (setf package *cl-package*))
1029 (when (eq (symbol-package symbol) p)
1030 (setf symbol (intern (symbol-name symbol) *cl-package*))))
1032 ;; Make sure that the symbol has an appropriate package. In
1033 ;; particular, catch the so-easy-to-make error of typing something
1034 ;; like SB-KERNEL:%BYTE-BLT in cold sources when what you really
1035 ;; need is SB!KERNEL:%BYTE-BLT.
1036 (let ((package-name (package-name package)))
1037 (cond ((find package-name '("COMMON-LISP" "KEYWORD") :test #'string=)
1038 ;; Cold interning things in these standard packages is OK.
1039 ;; (Cold interning things in the other standard package,
1040 ;; CL-USER, isn't OK. We just use CL-USER to expose symbols
1041 ;; whose homes are in other packages. Thus, trying to cold
1042 ;; intern a symbol whose home package is CL-USER probably
1043 ;; means that a coding error has been made somewhere.)
1045 ((string= package-name "SB!" :end1 3 :end2 3)
1046 ;; That looks OK, too. (All the target-code packages
1047 ;; have names like that.)
1050 ;; looks bad: maybe COMMON-LISP-USER? maybe an extension
1051 ;; package in the xc host? something we can't think of
1052 ;; a valid reason to cold intern, anyway...
1053 (error ; not #'BUG, because #'BUG isn't defined yet
1054 "internal error: PACKAGE-NAME=~S looks too much like a typo."
1057 (let (;; Information about each cold-interned symbol is stored
1058 ;; in COLD-INTERN-INFO.
1059 ;; (CAR COLD-INTERN-INFO) = descriptor of symbol
1060 ;; (CDR COLD-INTERN-INFO) = list of packages, other than symbol's
1061 ;; own package, referring to symbol
1062 ;; (*COLD-PACKAGE-SYMBOLS* and *COLD-SYMBOLS* store basically the
1063 ;; same information, but with the mapping running the opposite way.)
1064 (cold-intern-info (get symbol 'cold-intern-info)))
1065 (unless cold-intern-info
1066 (cond ((eq (symbol-package symbol) package)
1067 (let ((handle (allocate-symbol (symbol-name symbol))))
1068 (setf (gethash (descriptor-bits handle) *cold-symbols*) symbol)
1069 (when (eq package *keyword-package*)
1070 (cold-set handle handle))
1071 (setq cold-intern-info
1072 (setf (get symbol 'cold-intern-info) (cons handle nil)))))
1074 (cold-intern symbol)
1075 (setq cold-intern-info (get symbol 'cold-intern-info)))))
1076 (unless (or (null package)
1077 (member package (cdr cold-intern-info)))
1078 (push package (cdr cold-intern-info))
1079 (let* ((old-cps-entry (assoc package *cold-package-symbols*))
1080 (cps-entry (or old-cps-entry
1081 (car (push (list package)
1082 *cold-package-symbols*)))))
1083 (unless old-cps-entry
1084 (/show "created *COLD-PACKAGE-SYMBOLS* entry for" package symbol))
1085 (push symbol (rest cps-entry))))
1086 (car cold-intern-info)))
1088 ;;; Construct and return a value for use as *NIL-DESCRIPTOR*.
1089 (defun make-nil-descriptor ()
1090 (let* ((des (allocate-unboxed-object
1095 (result (make-descriptor (descriptor-high des)
1096 (+ (descriptor-low des)
1097 (* 2 sb!vm:n-word-bytes)
1098 (- sb!vm:list-pointer-lowtag
1099 sb!vm:other-pointer-lowtag)))))
1100 (write-wordindexed des
1102 (make-other-immediate-descriptor
1104 sb!vm:symbol-header-widetag))
1105 (write-wordindexed des
1106 (+ 1 sb!vm:symbol-value-slot)
1108 (write-wordindexed des
1109 (+ 2 sb!vm:symbol-value-slot)
1111 (write-wordindexed des
1112 (+ 1 sb!vm:symbol-plist-slot)
1114 (write-wordindexed des
1115 (+ 1 sb!vm:symbol-name-slot)
1116 ;; This is *DYNAMIC*, and DES is *STATIC*,
1117 ;; because that's the way CMU CL did it; I'm
1118 ;; not sure whether there's an underlying
1119 ;; reason. -- WHN 1990826
1120 (string-to-core "NIL" *dynamic*))
1121 (write-wordindexed des
1122 (+ 1 sb!vm:symbol-package-slot)
1124 (setf (get nil 'cold-intern-info)
1129 ;;; Since the initial symbols must be allocated before we can intern
1130 ;;; anything else, we intern those here. We also set the value of T.
1131 (defun initialize-non-nil-symbols ()
1133 "Initialize the cold load symbol-hacking data structures."
1134 (let ((*cold-symbol-allocation-gspace* *static*))
1135 ;; Intern the others.
1136 (dolist (symbol sb!vm:*static-symbols*)
1137 (let* ((des (cold-intern symbol))
1138 (offset-wanted (sb!vm:static-symbol-offset symbol))
1139 (offset-found (- (descriptor-low des)
1140 (descriptor-low *nil-descriptor*))))
1141 (unless (= offset-wanted offset-found)
1142 ;; FIXME: should be fatal
1143 (warn "Offset from ~S to ~S is ~W, not ~W"
1148 ;; Establish the value of T.
1149 (let ((t-symbol (cold-intern t)))
1150 (cold-set t-symbol t-symbol))))
1152 ;;; a helper function for FINISH-SYMBOLS: Return a cold alist suitable
1153 ;;; to be stored in *!INITIAL-LAYOUTS*.
1154 (defun cold-list-all-layouts ()
1155 (let ((result *nil-descriptor*))
1156 (maphash (lambda (key stuff)
1157 (cold-push (cold-cons (cold-intern key)
1163 ;;; Establish initial values for magic symbols.
1165 ;;; Scan over all the symbols referenced in each package in
1166 ;;; *COLD-PACKAGE-SYMBOLS* making that for each one there's an
1167 ;;; appropriate entry in the *!INITIAL-SYMBOLS* data structure to
1169 (defun finish-symbols ()
1171 ;; I think the point of setting these functions into SYMBOL-VALUEs
1172 ;; here, instead of using SYMBOL-FUNCTION, is that in CMU CL
1173 ;; SYMBOL-FUNCTION reduces to FDEFINITION, which is a pretty
1174 ;; hairy operation (involving globaldb.lisp etc.) which we don't
1175 ;; want to invoke early in cold init. -- WHN 2001-12-05
1177 ;; FIXME: So OK, that's a reasonable reason to do something weird like
1178 ;; this, but this is still a weird thing to do, and we should change
1179 ;; the names to highlight that something weird is going on. Perhaps
1180 ;; *MAYBE-GC-FUN*, *INTERNAL-ERROR-FUN*, *HANDLE-BREAKPOINT-FUN*,
1181 ;; and *HANDLE-FUN-END-BREAKPOINT-FUN*...
1182 (macrolet ((frob (symbol)
1184 (cold-fdefinition-object (cold-intern ',symbol)))))
1186 (frob internal-error)
1187 (frob sb!di::handle-breakpoint)
1188 (frob sb!di::handle-fun-end-breakpoint))
1190 (cold-set '*current-catch-block* (make-fixnum-descriptor 0))
1191 (cold-set '*current-unwind-protect-block* (make-fixnum-descriptor 0))
1193 (cold-set '*free-interrupt-context-index* (make-fixnum-descriptor 0))
1195 (cold-set '*!initial-layouts* (cold-list-all-layouts))
1197 (/show "dumping packages" (mapcar #'car *cold-package-symbols*))
1198 (let ((initial-symbols *nil-descriptor*))
1199 (dolist (cold-package-symbols-entry *cold-package-symbols*)
1200 (let* ((cold-package (car cold-package-symbols-entry))
1201 (symbols (cdr cold-package-symbols-entry))
1202 (shadows (package-shadowing-symbols cold-package))
1203 (internal *nil-descriptor*)
1204 (external *nil-descriptor*)
1205 (imported-internal *nil-descriptor*)
1206 (imported-external *nil-descriptor*)
1207 (shadowing *nil-descriptor*))
1208 (/show "dumping" cold-package symbols)
1210 ;; FIXME: Add assertions here to make sure that inappropriate stuff
1211 ;; isn't being dumped:
1212 ;; * the CL-USER package
1213 ;; * the SB-COLD package
1214 ;; * any internal symbols in the CL package
1215 ;; * basically any package other than CL, KEYWORD, or the packages
1216 ;; in package-data-list.lisp-expr
1217 ;; and that the structure of the KEYWORD package (e.g. whether
1218 ;; any symbols are internal to it) matches what we want in the
1221 ;; FIXME: It seems possible that by looking at the contents of
1222 ;; packages in the target SBCL we could find which symbols in
1223 ;; package-data-lisp.lisp-expr are now obsolete. (If I
1224 ;; understand correctly, only symbols which actually have
1225 ;; definitions or which are otherwise referred to actually end
1226 ;; up in the target packages.)
1228 (dolist (symbol symbols)
1229 (let ((handle (car (get symbol 'cold-intern-info)))
1230 (imported-p (not (eq (symbol-package symbol) cold-package))))
1231 (multiple-value-bind (found where)
1232 (find-symbol (symbol-name symbol) cold-package)
1233 (unless (and where (eq found symbol))
1234 (error "The symbol ~S is not available in ~S."
1237 (when (memq symbol shadows)
1238 (cold-push handle shadowing))
1240 (:internal (if imported-p
1241 (cold-push handle imported-internal)
1242 (cold-push handle internal)))
1243 (:external (if imported-p
1244 (cold-push handle imported-external)
1245 (cold-push handle external)))))))
1246 (let ((r *nil-descriptor*))
1247 (cold-push shadowing r)
1248 (cold-push imported-external r)
1249 (cold-push imported-internal r)
1250 (cold-push external r)
1251 (cold-push internal r)
1252 (cold-push (make-make-package-args cold-package) r)
1253 ;; FIXME: It would be more space-efficient to use vectors
1254 ;; instead of lists here, and space-efficiency here would be
1255 ;; nice, since it would reduce the peak memory usage in
1256 ;; genesis and cold init.
1257 (cold-push r initial-symbols))))
1258 (cold-set '*!initial-symbols* initial-symbols))
1260 (cold-set '*!initial-fdefn-objects* (list-all-fdefn-objects))
1262 (cold-set '*!reversed-cold-toplevels* *current-reversed-cold-toplevels*)
1266 (cold-set 'sb!vm::*fp-constant-0d0* (number-to-core 0d0))
1267 (cold-set 'sb!vm::*fp-constant-1d0* (number-to-core 1d0))
1268 (cold-set 'sb!vm::*fp-constant-0s0* (number-to-core 0s0))
1269 (cold-set 'sb!vm::*fp-constant-1s0* (number-to-core 1s0))
1272 (cold-set 'sb!vm::*fp-constant-0l0* (number-to-core 0L0))
1273 (cold-set 'sb!vm::*fp-constant-1l0* (number-to-core 1L0))
1274 ;; FIXME: Why is initialization of PI conditional on LONG-FLOAT?
1275 ;; (ditto LG2, LN2, L2E, etc.)
1276 (cold-set 'sb!vm::*fp-constant-pi* (number-to-core pi))
1277 (cold-set 'sb!vm::*fp-constant-l2t* (number-to-core (log 10L0 2L0)))
1278 (cold-set 'sb!vm::*fp-constant-l2e*
1279 (number-to-core (log 2.718281828459045235360287471352662L0 2L0)))
1280 (cold-set 'sb!vm::*fp-constant-lg2* (number-to-core (log 2L0 10L0)))
1281 (cold-set 'sb!vm::*fp-constant-ln2*
1283 (log 2L0 2.718281828459045235360287471352662L0))))))
1285 ;;; Make a cold list that can be used as the arg list to MAKE-PACKAGE in order
1286 ;;; to make a package that is similar to PKG.
1287 (defun make-make-package-args (pkg)
1288 (let* ((use *nil-descriptor*)
1289 (cold-nicknames *nil-descriptor*)
1290 (res *nil-descriptor*))
1291 (dolist (u (package-use-list pkg))
1292 (when (assoc u *cold-package-symbols*)
1293 (cold-push (string-to-core (package-name u)) use)))
1294 (let* ((pkg-name (package-name pkg))
1295 ;; Make the package nickname lists for the standard packages
1296 ;; be the minimum specified by ANSI, regardless of what value
1297 ;; the cross-compilation host happens to use.
1298 (warm-nicknames (cond ((string= pkg-name "COMMON-LISP")
1300 ((string= pkg-name "COMMON-LISP-USER")
1302 ((string= pkg-name "KEYWORD")
1304 ;; For packages other than the
1305 ;; standard packages, the nickname
1306 ;; list was specified by our package
1307 ;; setup code, not by properties of
1308 ;; what cross-compilation host we
1309 ;; happened to use, and we can just
1310 ;; propagate it into the target.
1312 (package-nicknames pkg)))))
1313 (dolist (warm-nickname warm-nicknames)
1314 (cold-push (string-to-core warm-nickname) cold-nicknames)))
1316 (cold-push (number-to-core (truncate (package-internal-symbol-count pkg)
1319 (cold-push (cold-intern :internal-symbols) res)
1320 (cold-push (number-to-core (truncate (package-external-symbol-count pkg)
1323 (cold-push (cold-intern :external-symbols) res)
1325 (cold-push cold-nicknames res)
1326 (cold-push (cold-intern :nicknames) res)
1329 (cold-push (cold-intern :use) res)
1331 (cold-push (string-to-core (package-name pkg)) res)
1334 ;;;; functions and fdefinition objects
1336 ;;; a hash table mapping from fdefinition names to descriptors of cold
1339 ;;; Note: Since fdefinition names can be lists like '(SETF FOO), and
1340 ;;; we want to have only one entry per name, this must be an 'EQUAL
1341 ;;; hash table, not the default 'EQL.
1342 (defvar *cold-fdefn-objects*)
1344 (defvar *cold-fdefn-gspace* nil)
1346 ;;; Given a cold representation of a symbol, return a warm
1348 (defun warm-symbol (des)
1349 ;; Note that COLD-INTERN is responsible for keeping the
1350 ;; *COLD-SYMBOLS* table up to date, so if DES happens to refer to an
1351 ;; uninterned symbol, the code below will fail. But as long as we
1352 ;; don't need to look up uninterned symbols during bootstrapping,
1354 (multiple-value-bind (symbol found-p)
1355 (gethash (descriptor-bits des) *cold-symbols*)
1356 (declare (type symbol symbol))
1358 (error "no warm symbol"))
1361 ;;; like CL:CAR, CL:CDR, and CL:NULL but for cold values
1362 (defun cold-car (des)
1363 (aver (= (descriptor-lowtag des) sb!vm:list-pointer-lowtag))
1364 (read-wordindexed des sb!vm:cons-car-slot))
1365 (defun cold-cdr (des)
1366 (aver (= (descriptor-lowtag des) sb!vm:list-pointer-lowtag))
1367 (read-wordindexed des sb!vm:cons-cdr-slot))
1368 (defun cold-null (des)
1369 (= (descriptor-bits des)
1370 (descriptor-bits *nil-descriptor*)))
1372 ;;; Given a cold representation of a function name, return a warm
1374 (declaim (ftype (function (descriptor) (or symbol list)) warm-fun-name))
1375 (defun warm-fun-name (des)
1377 (ecase (descriptor-lowtag des)
1378 (#.sb!vm:list-pointer-lowtag
1379 (aver (not (cold-null des))) ; function named NIL? please no..
1380 ;; Do cold (DESTRUCTURING-BIND (COLD-CAR COLD-CADR) DES ..).
1381 (let* ((car-des (cold-car des))
1382 (cdr-des (cold-cdr des))
1383 (cadr-des (cold-car cdr-des))
1384 (cddr-des (cold-cdr cdr-des)))
1385 (aver (cold-null cddr-des))
1386 (list (warm-symbol car-des)
1387 (warm-symbol cadr-des))))
1388 (#.sb!vm:other-pointer-lowtag
1389 (warm-symbol des)))))
1390 (unless (legal-fun-name-p result)
1391 (error "not a legal function name: ~S" result))
1394 (defun cold-fdefinition-object (cold-name &optional leave-fn-raw)
1395 (declare (type descriptor cold-name))
1396 (let ((warm-name (warm-fun-name cold-name)))
1397 (or (gethash warm-name *cold-fdefn-objects*)
1398 (let ((fdefn (allocate-boxed-object (or *cold-fdefn-gspace* *dynamic*)
1399 (1- sb!vm:fdefn-size)
1400 sb!vm:other-pointer-lowtag)))
1402 (setf (gethash warm-name *cold-fdefn-objects*) fdefn)
1403 (write-memory fdefn (make-other-immediate-descriptor
1404 (1- sb!vm:fdefn-size) sb!vm:fdefn-widetag))
1405 (write-wordindexed fdefn sb!vm:fdefn-name-slot cold-name)
1406 (unless leave-fn-raw
1407 (write-wordindexed fdefn sb!vm:fdefn-fun-slot
1409 (write-wordindexed fdefn
1410 sb!vm:fdefn-raw-addr-slot
1411 (make-random-descriptor
1412 (cold-foreign-symbol-address-as-integer
1413 "undefined_tramp"))))
1416 ;;; Handle the at-cold-init-time, fset-for-static-linkage operation
1417 ;;; requested by FOP-FSET.
1418 (defun static-fset (cold-name defn)
1419 (declare (type descriptor cold-name))
1420 (let ((fdefn (cold-fdefinition-object cold-name t))
1421 (type (logand (descriptor-low (read-memory defn)) sb!vm:widetag-mask)))
1422 (write-wordindexed fdefn sb!vm:fdefn-fun-slot defn)
1423 (write-wordindexed fdefn
1424 sb!vm:fdefn-raw-addr-slot
1426 (#.sb!vm:simple-fun-header-widetag
1430 (make-random-descriptor
1431 (+ (logandc2 (descriptor-bits defn)
1433 (ash sb!vm:simple-fun-code-offset
1434 sb!vm:word-shift))))
1435 (#.sb!vm:closure-header-widetag
1436 (make-random-descriptor
1437 (cold-foreign-symbol-address-as-integer
1438 "closure_tramp")))))
1441 (defun initialize-static-fns ()
1442 (let ((*cold-fdefn-gspace* *static*))
1443 (dolist (sym sb!vm:*static-funs*)
1444 (let* ((fdefn (cold-fdefinition-object (cold-intern sym)))
1445 (offset (- (+ (- (descriptor-low fdefn)
1446 sb!vm:other-pointer-lowtag)
1447 (* sb!vm:fdefn-raw-addr-slot sb!vm:n-word-bytes))
1448 (descriptor-low *nil-descriptor*)))
1449 (desired (sb!vm:static-fun-offset sym)))
1450 (unless (= offset desired)
1451 ;; FIXME: should be fatal
1452 (warn "Offset from FDEFN ~S to ~S is ~W, not ~W."
1453 sym nil offset desired))))))
1455 (defun list-all-fdefn-objects ()
1456 (let ((result *nil-descriptor*))
1457 (maphash (lambda (key value)
1458 (declare (ignore key))
1459 (cold-push value result))
1460 *cold-fdefn-objects*)
1463 ;;;; fixups and related stuff
1465 ;;; an EQUAL hash table
1466 (defvar *cold-foreign-symbol-table*)
1467 (declaim (type hash-table *cold-foreign-symbol-table*))
1469 ;;; Read the sbcl.nm file to find the addresses for foreign-symbols in
1471 (defun load-cold-foreign-symbol-table (filename)
1472 (with-open-file (file filename)
1474 (let ((line (read-line file nil nil)))
1477 ;; UNIX symbol tables might have tabs in them, and tabs are
1478 ;; not in Common Lisp STANDARD-CHAR, so there seems to be no
1479 ;; nice portable way to deal with them within Lisp, alas.
1480 ;; Fortunately, it's easy to use UNIX command line tools like
1481 ;; sed to remove the problem, so it's not too painful for us
1482 ;; to push responsibility for converting tabs to spaces out to
1485 ;; Other non-STANDARD-CHARs are problematic for the same reason.
1486 ;; Make sure that there aren't any..
1487 (let ((ch (find-if (lambda (char)
1488 (not (typep char 'standard-char)))
1491 (error "non-STANDARD-CHAR ~S found in foreign symbol table:~%~S"
1494 (setf line (string-trim '(#\space) line))
1495 (let ((p1 (position #\space line :from-end nil))
1496 (p2 (position #\space line :from-end t)))
1497 (if (not (and p1 p2 (< p1 p2)))
1498 ;; KLUDGE: It's too messy to try to understand all
1499 ;; possible output from nm, so we just punt the lines we
1500 ;; don't recognize. We realize that there's some chance
1501 ;; that might get us in trouble someday, so we warn
1503 (warn "ignoring unrecognized line ~S in ~A" line filename)
1504 (multiple-value-bind (value name)
1505 (if (string= "0x" line :end2 2)
1506 (values (parse-integer line :start 2 :end p1 :radix 16)
1507 (subseq line (1+ p2)))
1508 (values (parse-integer line :end p1 :radix 16)
1509 (subseq line (1+ p2))))
1510 (multiple-value-bind (old-value found)
1511 (gethash name *cold-foreign-symbol-table*)
1513 (not (= old-value value)))
1514 (warn "redefining ~S from #X~X to #X~X"
1515 name old-value value)))
1516 (setf (gethash name *cold-foreign-symbol-table*) value))))))
1519 (defun cold-foreign-symbol-address-as-integer (name)
1520 (or (find-foreign-symbol-in-table name *cold-foreign-symbol-table*)
1521 *foreign-symbol-placeholder-value*
1523 (format *error-output* "~&The foreign symbol table is:~%")
1524 (maphash (lambda (k v)
1525 (format *error-output* "~&~S = #X~8X~%" k v))
1526 *cold-foreign-symbol-table*)
1527 (error "The foreign symbol ~S is undefined." name))))
1529 (defvar *cold-assembler-routines*)
1531 (defvar *cold-assembler-fixups*)
1533 (defun record-cold-assembler-routine (name address)
1534 (/xhow "in RECORD-COLD-ASSEMBLER-ROUTINE" name address)
1535 (push (cons name address)
1536 *cold-assembler-routines*))
1538 (defun record-cold-assembler-fixup (routine
1543 (push (list routine code-object offset kind)
1544 *cold-assembler-fixups*))
1546 (defun lookup-assembler-reference (symbol)
1547 (let ((value (cdr (assoc symbol *cold-assembler-routines*))))
1548 ;; FIXME: Should this be ERROR instead of WARN?
1550 (warn "Assembler routine ~S not defined." symbol))
1553 ;;; The x86 port needs to store code fixups along with code objects if
1554 ;;; they are to be moved, so fixups for code objects in the dynamic
1555 ;;; heap need to be noted.
1557 (defvar *load-time-code-fixups*)
1560 (defun note-load-time-code-fixup (code-object offset value kind)
1561 ;; If CODE-OBJECT might be moved
1562 (when (= (gspace-identifier (descriptor-intuit-gspace code-object))
1564 ;; FIXME: pushed thing should be a structure, not just a list
1565 (push (list code-object offset value kind) *load-time-code-fixups*))
1569 (defun output-load-time-code-fixups ()
1570 (dolist (fixups *load-time-code-fixups*)
1571 (let ((code-object (first fixups))
1572 (offset (second fixups))
1573 (value (third fixups))
1574 (kind (fourth fixups)))
1575 (cold-push (cold-cons
1576 (cold-intern :load-time-code-fixup)
1580 (number-to-core offset)
1582 (number-to-core value)
1585 *nil-descriptor*)))))
1586 *current-reversed-cold-toplevels*))))
1588 ;;; Given a pointer to a code object and an offset relative to the
1589 ;;; tail of the code object's header, return an offset relative to the
1590 ;;; (beginning of the) code object.
1592 ;;; FIXME: It might be clearer to reexpress
1593 ;;; (LET ((X (CALC-OFFSET CODE-OBJECT OFFSET0))) ..)
1595 ;;; (LET ((X (+ OFFSET0 (CODE-OBJECT-HEADER-N-BYTES CODE-OBJECT)))) ..).
1596 (declaim (ftype (function (descriptor sb!vm:word)) calc-offset))
1597 (defun calc-offset (code-object offset-from-tail-of-header)
1598 (let* ((header (read-memory code-object))
1599 (header-n-words (ash (descriptor-bits header)
1600 (- sb!vm:n-widetag-bits)))
1601 (header-n-bytes (ash header-n-words sb!vm:word-shift))
1602 (result (+ offset-from-tail-of-header header-n-bytes)))
1605 (declaim (ftype (function (descriptor sb!vm:word sb!vm:word keyword))
1607 (defun do-cold-fixup (code-object after-header value kind)
1608 (let* ((offset-within-code-object (calc-offset code-object after-header))
1609 (gspace-bytes (descriptor-bytes code-object))
1610 (gspace-byte-offset (+ (descriptor-byte-offset code-object)
1611 offset-within-code-object))
1612 (gspace-byte-address (gspace-byte-address
1613 (descriptor-gspace code-object))))
1614 (ecase +backend-fasl-file-implementation+
1615 ;; See CMU CL source for other formerly-supported architectures
1616 ;; (and note that you have to rewrite them to use VECTOR-REF
1617 ;; unstead of SAP-REF).
1621 (assert (zerop (ldb (byte 2 0) value))))
1623 (let* ((value (if (logbitp 15 value) (+ value (ash 1 16)) value))
1624 (value (if (logbitp 31 value) (+ value (ash 1 32)) value))
1625 (value (if (logbitp 47 value) (+ value (ash 1 48)) value)))
1626 (setf (byte-vector-ref-8 gspace-bytes gspace-byte-offset)
1627 (ldb (byte 8 48) value)
1628 (byte-vector-ref-8 gspace-bytes (1+ gspace-byte-offset))
1629 (ldb (byte 8 56) value))))
1631 (let* ((value (if (logbitp 15 value) (+ value (ash 1 16)) value))
1632 (value (if (logbitp 31 value) (+ value (ash 1 32)) value)))
1633 (setf (byte-vector-ref-8 gspace-bytes gspace-byte-offset)
1634 (ldb (byte 8 32) value)
1635 (byte-vector-ref-8 gspace-bytes (1+ gspace-byte-offset))
1636 (ldb (byte 8 40) value))))
1638 (let ((value (if (logbitp 15 value) (+ value (ash 1 16)) value)))
1639 (setf (byte-vector-ref-8 gspace-bytes gspace-byte-offset)
1640 (ldb (byte 8 16) value)
1641 (byte-vector-ref-8 gspace-bytes (1+ gspace-byte-offset))
1642 (ldb (byte 8 24) value))))
1644 (setf (byte-vector-ref-8 gspace-bytes gspace-byte-offset)
1645 (ldb (byte 8 0) value)
1646 (byte-vector-ref-8 gspace-bytes (1+ gspace-byte-offset))
1647 (ldb (byte 8 8) value)))))
1651 (setf (byte-vector-ref-32 gspace-bytes gspace-byte-offset)
1652 (dpb (ash value -2) (byte 24 2)
1653 (byte-vector-ref-32 gspace-bytes gspace-byte-offset))))
1655 (let* ((h (ldb (byte 16 16) value))
1656 (l (ldb (byte 16 0) value)))
1657 (setf (byte-vector-ref-16 gspace-bytes (+ gspace-byte-offset 2))
1658 (if (logbitp 15 l) (ldb (byte 16 0) (1+ h)) h))))
1660 (setf (byte-vector-ref-16 gspace-bytes (+ gspace-byte-offset 2))
1661 (ldb (byte 16 0) value)))))
1665 (error "Can't deal with call fixups yet."))
1667 (setf (byte-vector-ref-32 gspace-bytes gspace-byte-offset)
1668 (dpb (ldb (byte 22 10) value)
1670 (byte-vector-ref-32 gspace-bytes gspace-byte-offset))))
1672 (setf (byte-vector-ref-32 gspace-bytes gspace-byte-offset)
1673 (dpb (ldb (byte 10 0) value)
1675 (byte-vector-ref-32 gspace-bytes gspace-byte-offset))))))
1677 (let* ((un-fixed-up (byte-vector-ref-32 gspace-bytes
1678 gspace-byte-offset))
1679 (code-object-start-addr (logandc2 (descriptor-bits code-object)
1680 sb!vm:lowtag-mask)))
1681 (assert (= code-object-start-addr
1682 (+ gspace-byte-address
1683 (descriptor-byte-offset code-object))))
1686 (let ((fixed-up (+ value un-fixed-up)))
1687 (setf (byte-vector-ref-32 gspace-bytes gspace-byte-offset)
1689 ;; comment from CMU CL sources:
1691 ;; Note absolute fixups that point within the object.
1692 ;; KLUDGE: There seems to be an implicit assumption in
1693 ;; the old CMU CL code here, that if it doesn't point
1694 ;; before the object, it must point within the object
1695 ;; (not beyond it). It would be good to add an
1696 ;; explanation of why that's true, or an assertion that
1697 ;; it's really true, or both.
1698 (unless (< fixed-up code-object-start-addr)
1699 (note-load-time-code-fixup code-object
1703 (:relative ; (used for arguments to X86 relative CALL instruction)
1704 (let ((fixed-up (- (+ value un-fixed-up)
1707 sb!vm:n-word-bytes))) ; length of CALL argument
1708 (setf (byte-vector-ref-32 gspace-bytes gspace-byte-offset)
1710 ;; Note relative fixups that point outside the code
1711 ;; object, which is to say all relative fixups, since
1712 ;; relative addressing within a code object never needs
1714 (note-load-time-code-fixup code-object
1720 (defun resolve-assembler-fixups ()
1721 (dolist (fixup *cold-assembler-fixups*)
1722 (let* ((routine (car fixup))
1723 (value (lookup-assembler-reference routine)))
1725 (do-cold-fixup (second fixup) (third fixup) value (fourth fixup))))))
1727 ;;; *COLD-FOREIGN-SYMBOL-TABLE* becomes *!INITIAL-FOREIGN-SYMBOLS* in
1728 ;;; the core. When the core is loaded, !LOADER-COLD-INIT uses this to
1729 ;;; create *STATIC-FOREIGN-SYMBOLS*, which the code in
1730 ;;; target-load.lisp refers to.
1731 (defun linkage-info-to-core ()
1732 (let ((result *nil-descriptor*))
1733 (maphash (lambda (symbol value)
1734 (cold-push (cold-cons (string-to-core symbol)
1735 (number-to-core value))
1737 *cold-foreign-symbol-table*)
1738 (cold-set (cold-intern '*!initial-foreign-symbols*) result))
1739 (let ((result *nil-descriptor*))
1740 (dolist (rtn *cold-assembler-routines*)
1741 (cold-push (cold-cons (cold-intern (car rtn))
1742 (number-to-core (cdr rtn)))
1744 (cold-set (cold-intern '*!initial-assembler-routines*) result)))
1746 ;;;; general machinery for cold-loading FASL files
1748 ;;; FOP functions for cold loading
1749 (defvar *cold-fop-funs*
1750 ;; We start out with a copy of the ordinary *FOP-FUNS*. The ones
1751 ;; which aren't appropriate for cold load will be destructively
1753 (copy-seq *fop-funs*))
1755 (defvar *normal-fop-funs*)
1757 ;;; Cause a fop to have a special definition for cold load.
1759 ;;; This is similar to DEFINE-FOP, but unlike DEFINE-FOP, this version
1760 ;;; (1) looks up the code for this name (created by a previous
1761 ;; DEFINE-FOP) instead of creating a code, and
1762 ;;; (2) stores its definition in the *COLD-FOP-FUNS* vector,
1763 ;;; instead of storing in the *FOP-FUNS* vector.
1764 (defmacro define-cold-fop ((name &key (pushp t) (stackp t)) &rest forms)
1765 (aver (member pushp '(nil t)))
1766 (aver (member stackp '(nil t)))
1767 (let ((code (get name 'fop-code))
1768 (fname (symbolicate "COLD-" name)))
1770 (error "~S is not a defined FOP." name))
1774 `((with-fop-stack ,pushp ,@forms))
1776 (setf (svref *cold-fop-funs* ,code) #',fname))))
1778 (defmacro clone-cold-fop ((name &key (pushp t) (stackp t)) (small-name) &rest forms)
1779 (aver (member pushp '(nil t)))
1780 (aver (member stackp '(nil t)))
1782 (macrolet ((clone-arg () '(read-arg 4)))
1783 (define-cold-fop (,name :pushp ,pushp :stackp ,stackp) ,@forms))
1784 (macrolet ((clone-arg () '(read-arg 1)))
1785 (define-cold-fop (,small-name :pushp ,pushp :stackp ,stackp) ,@forms))))
1787 ;;; Cause a fop to be undefined in cold load.
1788 (defmacro not-cold-fop (name)
1789 `(define-cold-fop (,name)
1790 (error "The fop ~S is not supported in cold load." ',name)))
1792 ;;; COLD-LOAD loads stuff into the core image being built by calling
1793 ;;; LOAD-AS-FASL with the fop function table rebound to a table of cold
1794 ;;; loading functions.
1795 (defun cold-load (filename)
1797 "Load the file named by FILENAME into the cold load image being built."
1798 (let* ((*normal-fop-funs* *fop-funs*)
1799 (*fop-funs* *cold-fop-funs*)
1800 (*cold-load-filename* (etypecase filename
1802 (pathname (namestring filename)))))
1803 (with-open-file (s filename :element-type '(unsigned-byte 8))
1804 (load-as-fasl s nil nil))))
1806 ;;;; miscellaneous cold fops
1808 (define-cold-fop (fop-misc-trap) *unbound-marker*)
1810 (define-cold-fop (fop-character)
1811 (make-character-descriptor (read-arg 3)))
1812 (define-cold-fop (fop-short-character)
1813 (make-character-descriptor (read-arg 1)))
1815 (define-cold-fop (fop-empty-list) *nil-descriptor*)
1816 (define-cold-fop (fop-truth) (cold-intern t))
1818 (define-cold-fop (fop-normal-load :stackp nil)
1819 (setq *fop-funs* *normal-fop-funs*))
1821 (define-fop (fop-maybe-cold-load 82 :stackp nil)
1822 (when *cold-load-filename*
1823 (setq *fop-funs* *cold-fop-funs*)))
1825 (define-cold-fop (fop-maybe-cold-load :stackp nil))
1827 (clone-cold-fop (fop-struct)
1829 (let* ((size (clone-arg))
1830 (result (allocate-boxed-object *dynamic*
1832 sb!vm:instance-pointer-lowtag)))
1833 (write-memory result (make-other-immediate-descriptor
1834 size sb!vm:instance-header-widetag))
1835 (do ((index (1- size) (1- index)))
1837 (declare (fixnum index))
1838 (write-wordindexed result
1839 (+ index sb!vm:instance-slots-offset)
1843 (define-cold-fop (fop-layout)
1844 (let* ((length-des (pop-stack))
1845 (depthoid-des (pop-stack))
1846 (cold-inherits (pop-stack))
1848 (old (gethash name *cold-layouts*)))
1849 (declare (type descriptor length-des depthoid-des cold-inherits))
1850 (declare (type symbol name))
1851 ;; If a layout of this name has been defined already
1853 ;; Enforce consistency between the previous definition and the
1854 ;; current definition, then return the previous definition.
1856 ;; FIXME: This would be more maintainable if we used
1857 ;; DEFSTRUCT (:TYPE LIST) to define COLD-LAYOUT. -- WHN 19990825
1858 (old-layout-descriptor
1864 (declare (type descriptor old-layout-descriptor))
1865 (declare (type index old-length))
1866 (declare (type fixnum old-depthoid))
1867 (declare (type list old-inherits-list))
1868 (aver (eq name old-name))
1869 (let ((length (descriptor-fixnum length-des))
1870 (inherits-list (listify-cold-inherits cold-inherits))
1871 (depthoid (descriptor-fixnum depthoid-des)))
1872 (unless (= length old-length)
1873 (error "cold loading a reference to class ~S when the compile~%~
1874 time length was ~S and current length is ~S"
1878 (unless (equal inherits-list old-inherits-list)
1879 (error "cold loading a reference to class ~S when the compile~%~
1880 time inherits were ~S~%~
1881 and current inherits are ~S"
1885 (unless (= depthoid old-depthoid)
1886 (error "cold loading a reference to class ~S when the compile~%~
1887 time inheritance depthoid was ~S and current inheritance~%~
1892 old-layout-descriptor)
1893 ;; Make a new definition from scratch.
1894 (make-cold-layout name length-des cold-inherits depthoid-des))))
1896 ;;;; cold fops for loading symbols
1898 ;;; Load a symbol SIZE characters long from *FASL-INPUT-STREAM* and
1899 ;;; intern that symbol in PACKAGE.
1900 (defun cold-load-symbol (size package)
1901 (let ((string (make-string size)))
1902 (read-string-as-bytes *fasl-input-stream* string)
1903 (cold-intern (intern string package) package)))
1905 (macrolet ((frob (name pname-len package-len)
1906 `(define-cold-fop (,name)
1907 (let ((index (read-arg ,package-len)))
1909 (cold-load-symbol (read-arg ,pname-len)
1910 (svref *current-fop-table* index)))))))
1911 (frob fop-symbol-in-package-save 4 4)
1912 (frob fop-small-symbol-in-package-save 1 4)
1913 (frob fop-symbol-in-byte-package-save 4 1)
1914 (frob fop-small-symbol-in-byte-package-save 1 1))
1916 (clone-cold-fop (fop-lisp-symbol-save)
1917 (fop-lisp-small-symbol-save)
1918 (push-fop-table (cold-load-symbol (clone-arg) *cl-package*)))
1920 (clone-cold-fop (fop-keyword-symbol-save)
1921 (fop-keyword-small-symbol-save)
1922 (push-fop-table (cold-load-symbol (clone-arg) *keyword-package*)))
1924 (clone-cold-fop (fop-uninterned-symbol-save)
1925 (fop-uninterned-small-symbol-save)
1926 (let* ((size (clone-arg))
1927 (name (make-string size)))
1928 (read-string-as-bytes *fasl-input-stream* name)
1929 (let ((symbol-des (allocate-symbol name)))
1930 (push-fop-table symbol-des))))
1932 ;;;; cold fops for loading lists
1934 ;;; Make a list of the top LENGTH things on the fop stack. The last
1935 ;;; cdr of the list is set to LAST.
1936 (defmacro cold-stack-list (length last)
1937 `(do* ((index ,length (1- index))
1938 (result ,last (cold-cons (pop-stack) result)))
1939 ((= index 0) result)
1940 (declare (fixnum index))))
1942 (define-cold-fop (fop-list)
1943 (cold-stack-list (read-arg 1) *nil-descriptor*))
1944 (define-cold-fop (fop-list*)
1945 (cold-stack-list (read-arg 1) (pop-stack)))
1946 (define-cold-fop (fop-list-1)
1947 (cold-stack-list 1 *nil-descriptor*))
1948 (define-cold-fop (fop-list-2)
1949 (cold-stack-list 2 *nil-descriptor*))
1950 (define-cold-fop (fop-list-3)
1951 (cold-stack-list 3 *nil-descriptor*))
1952 (define-cold-fop (fop-list-4)
1953 (cold-stack-list 4 *nil-descriptor*))
1954 (define-cold-fop (fop-list-5)
1955 (cold-stack-list 5 *nil-descriptor*))
1956 (define-cold-fop (fop-list-6)
1957 (cold-stack-list 6 *nil-descriptor*))
1958 (define-cold-fop (fop-list-7)
1959 (cold-stack-list 7 *nil-descriptor*))
1960 (define-cold-fop (fop-list-8)
1961 (cold-stack-list 8 *nil-descriptor*))
1962 (define-cold-fop (fop-list*-1)
1963 (cold-stack-list 1 (pop-stack)))
1964 (define-cold-fop (fop-list*-2)
1965 (cold-stack-list 2 (pop-stack)))
1966 (define-cold-fop (fop-list*-3)
1967 (cold-stack-list 3 (pop-stack)))
1968 (define-cold-fop (fop-list*-4)
1969 (cold-stack-list 4 (pop-stack)))
1970 (define-cold-fop (fop-list*-5)
1971 (cold-stack-list 5 (pop-stack)))
1972 (define-cold-fop (fop-list*-6)
1973 (cold-stack-list 6 (pop-stack)))
1974 (define-cold-fop (fop-list*-7)
1975 (cold-stack-list 7 (pop-stack)))
1976 (define-cold-fop (fop-list*-8)
1977 (cold-stack-list 8 (pop-stack)))
1979 ;;;; cold fops for loading vectors
1981 (clone-cold-fop (fop-string)
1983 (let* ((len (clone-arg))
1984 (string (make-string len)))
1985 (read-string-as-bytes *fasl-input-stream* string)
1986 (string-to-core string)))
1988 (clone-cold-fop (fop-vector)
1990 (let* ((size (clone-arg))
1991 (result (allocate-vector-object *dynamic*
1994 sb!vm:simple-vector-widetag)))
1995 (do ((index (1- size) (1- index)))
1997 (declare (fixnum index))
1998 (write-wordindexed result
1999 (+ index sb!vm:vector-data-offset)
2003 (define-cold-fop (fop-int-vector)
2004 (let* ((len (read-arg 4))
2005 (sizebits (read-arg 1))
2006 (type (case sizebits
2007 (1 sb!vm:simple-bit-vector-widetag)
2008 (2 sb!vm:simple-array-unsigned-byte-2-widetag)
2009 (4 sb!vm:simple-array-unsigned-byte-4-widetag)
2010 (8 sb!vm:simple-array-unsigned-byte-8-widetag)
2011 (16 sb!vm:simple-array-unsigned-byte-16-widetag)
2012 (32 sb!vm:simple-array-unsigned-byte-32-widetag)
2013 (t (error "losing element size: ~W" sizebits))))
2014 (result (allocate-vector-object *dynamic* sizebits len type))
2015 (start (+ (descriptor-byte-offset result)
2016 (ash sb!vm:vector-data-offset sb!vm:word-shift)))
2018 (ceiling (* len sizebits)
2019 sb!vm:n-byte-bits))))
2020 (read-sequence-or-die (descriptor-bytes result)
2026 (define-cold-fop (fop-single-float-vector)
2027 (let* ((len (read-arg 4))
2028 (result (allocate-vector-object
2032 sb!vm:simple-array-single-float-widetag))
2033 (start (+ (descriptor-byte-offset result)
2034 (ash sb!vm:vector-data-offset sb!vm:word-shift)))
2035 (end (+ start (* len sb!vm:n-word-bytes))))
2036 (read-sequence-or-die (descriptor-bytes result)
2042 (not-cold-fop fop-double-float-vector)
2043 #!+long-float (not-cold-fop fop-long-float-vector)
2044 (not-cold-fop fop-complex-single-float-vector)
2045 (not-cold-fop fop-complex-double-float-vector)
2046 #!+long-float (not-cold-fop fop-complex-long-float-vector)
2048 (define-cold-fop (fop-array)
2049 (let* ((rank (read-arg 4))
2050 (data-vector (pop-stack))
2051 (result (allocate-boxed-object *dynamic*
2052 (+ sb!vm:array-dimensions-offset rank)
2053 sb!vm:other-pointer-lowtag)))
2054 (write-memory result
2055 (make-other-immediate-descriptor rank
2056 sb!vm:simple-array-widetag))
2057 (write-wordindexed result sb!vm:array-fill-pointer-slot *nil-descriptor*)
2058 (write-wordindexed result sb!vm:array-data-slot data-vector)
2059 (write-wordindexed result sb!vm:array-displacement-slot *nil-descriptor*)
2060 (write-wordindexed result sb!vm:array-displaced-p-slot *nil-descriptor*)
2061 (let ((total-elements 1))
2062 (dotimes (axis rank)
2063 (let ((dim (pop-stack)))
2064 (unless (or (= (descriptor-lowtag dim) sb!vm:even-fixnum-lowtag)
2065 (= (descriptor-lowtag dim) sb!vm:odd-fixnum-lowtag))
2066 (error "non-fixnum dimension? (~S)" dim))
2067 (setf total-elements
2069 (logior (ash (descriptor-high dim)
2070 (- descriptor-low-bits
2071 (1- sb!vm:n-lowtag-bits)))
2072 (ash (descriptor-low dim)
2073 (- 1 sb!vm:n-lowtag-bits)))))
2074 (write-wordindexed result
2075 (+ sb!vm:array-dimensions-offset axis)
2077 (write-wordindexed result
2078 sb!vm:array-elements-slot
2079 (make-fixnum-descriptor total-elements)))
2082 ;;;; cold fops for loading numbers
2084 (defmacro define-cold-number-fop (fop)
2085 `(define-cold-fop (,fop :stackp nil)
2086 ;; Invoke the ordinary warm version of this fop to push the
2089 ;; Replace the warm fop result with the cold image of the warm
2092 (let ((number (pop-stack)))
2093 (number-to-core number)))))
2095 (define-cold-number-fop fop-single-float)
2096 (define-cold-number-fop fop-double-float)
2097 (define-cold-number-fop fop-integer)
2098 (define-cold-number-fop fop-small-integer)
2099 (define-cold-number-fop fop-word-integer)
2100 (define-cold-number-fop fop-byte-integer)
2101 (define-cold-number-fop fop-complex-single-float)
2102 (define-cold-number-fop fop-complex-double-float)
2105 (define-cold-fop (fop-long-float)
2106 (ecase +backend-fasl-file-implementation+
2107 (:x86 ; (which has 80-bit long-float format)
2108 (prepare-for-fast-read-byte *fasl-input-stream*
2109 (let* ((des (allocate-unboxed-object *dynamic* sb!vm:n-word-bits
2110 (1- sb!vm:long-float-size)
2111 sb!vm:long-float-widetag))
2112 (low-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 2))))
2115 (done-with-fast-read-byte)
2116 (write-wordindexed des sb!vm:long-float-value-slot low-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) exp-bits)
2120 ;; This was supported in CMU CL, but isn't currently supported in
2123 (#.sb!c:sparc-fasl-file-implementation ; 128 bit long-float format
2124 (prepare-for-fast-read-byte *fasl-input-stream*
2125 (let* ((des (allocate-unboxed-object *dynamic* sb!vm:n-word-bits
2126 (1- sb!vm:long-float-size)
2127 sb!vm:long-float-widetag))
2128 (low-bits (make-random-descriptor (fast-read-u-integer 4)))
2129 (mid-bits (make-random-descriptor (fast-read-u-integer 4)))
2130 (high-bits (make-random-descriptor (fast-read-u-integer 4)))
2131 (exp-bits (make-random-descriptor (fast-read-s-integer 4))))
2132 (done-with-fast-read-byte)
2133 (write-wordindexed des sb!vm:long-float-value-slot exp-bits)
2134 (write-wordindexed des (1+ sb!vm:long-float-value-slot) high-bits)
2135 (write-wordindexed des (+ 2 sb!vm:long-float-value-slot) mid-bits)
2136 (write-wordindexed des (+ 3 sb!vm:long-float-value-slot) low-bits)
2140 (define-cold-fop (fop-complex-long-float)
2141 (ecase +backend-fasl-file-implementation+
2142 (:x86 ; (which has 80-bit long-float format)
2143 (prepare-for-fast-read-byte *fasl-input-stream*
2144 (let* ((des (allocate-unboxed-object *dynamic* sb!vm:n-word-bits
2145 (1- sb!vm:complex-long-float-size)
2146 sb!vm:complex-long-float-widetag))
2147 (real-low-bits (make-random-descriptor (fast-read-u-integer 4)))
2148 (real-high-bits (make-random-descriptor (fast-read-u-integer 4)))
2149 (real-exp-bits (make-random-descriptor (fast-read-s-integer 2)))
2150 (imag-low-bits (make-random-descriptor (fast-read-u-integer 4)))
2151 (imag-high-bits (make-random-descriptor (fast-read-u-integer 4)))
2152 (imag-exp-bits (make-random-descriptor (fast-read-s-integer 2))))
2153 (done-with-fast-read-byte)
2154 (write-wordindexed des
2155 sb!vm:complex-long-float-real-slot
2157 (write-wordindexed des
2158 (1+ sb!vm:complex-long-float-real-slot)
2160 (write-wordindexed des
2161 (+ 2 sb!vm:complex-long-float-real-slot)
2163 (write-wordindexed des
2164 sb!vm:complex-long-float-imag-slot
2166 (write-wordindexed des
2167 (1+ sb!vm:complex-long-float-imag-slot)
2169 (write-wordindexed des
2170 (+ 2 sb!vm:complex-long-float-imag-slot)
2173 ;; This was supported in CMU CL, but isn't currently supported in SBCL.
2175 (#.sb!c:sparc-fasl-file-implementation ; 128 bit long-float format
2176 (prepare-for-fast-read-byte *fasl-input-stream*
2177 (let* ((des (allocate-unboxed-object *dynamic* sb!vm:n-word-bits
2178 (1- sb!vm:complex-long-float-size)
2179 sb!vm:complex-long-float-widetag))
2180 (real-low-bits (make-random-descriptor (fast-read-u-integer 4)))
2181 (real-mid-bits (make-random-descriptor (fast-read-u-integer 4)))
2182 (real-high-bits (make-random-descriptor (fast-read-u-integer 4)))
2183 (real-exp-bits (make-random-descriptor (fast-read-s-integer 4)))
2184 (imag-low-bits (make-random-descriptor (fast-read-u-integer 4)))
2185 (imag-mid-bits (make-random-descriptor (fast-read-u-integer 4)))
2186 (imag-high-bits (make-random-descriptor (fast-read-u-integer 4)))
2187 (imag-exp-bits (make-random-descriptor (fast-read-s-integer 4))))
2188 (done-with-fast-read-byte)
2189 (write-wordindexed des
2190 sb!vm:complex-long-float-real-slot
2192 (write-wordindexed des
2193 (1+ sb!vm:complex-long-float-real-slot)
2195 (write-wordindexed des
2196 (+ 2 sb!vm:complex-long-float-real-slot)
2198 (write-wordindexed des
2199 (+ 3 sb!vm:complex-long-float-real-slot)
2201 (write-wordindexed des
2202 sb!vm:complex-long-float-real-slot
2204 (write-wordindexed des
2205 (1+ sb!vm:complex-long-float-real-slot)
2207 (write-wordindexed des
2208 (+ 2 sb!vm:complex-long-float-real-slot)
2210 (write-wordindexed des
2211 (+ 3 sb!vm:complex-long-float-real-slot)
2215 (define-cold-fop (fop-ratio)
2216 (let ((den (pop-stack)))
2217 (number-pair-to-core (pop-stack) den sb!vm:ratio-widetag)))
2219 (define-cold-fop (fop-complex)
2220 (let ((im (pop-stack)))
2221 (number-pair-to-core (pop-stack) im sb!vm:complex-widetag)))
2223 ;;;; cold fops for calling (or not calling)
2225 (not-cold-fop fop-eval)
2226 (not-cold-fop fop-eval-for-effect)
2228 (defvar *load-time-value-counter*)
2230 (define-cold-fop (fop-funcall)
2231 (unless (= (read-arg 1) 0)
2232 (error "You can't FOP-FUNCALL arbitrary stuff in cold load."))
2233 (let ((counter *load-time-value-counter*))
2234 (cold-push (cold-cons
2235 (cold-intern :load-time-value)
2239 (number-to-core counter)
2241 *current-reversed-cold-toplevels*)
2242 (setf *load-time-value-counter* (1+ counter))
2243 (make-descriptor 0 0 nil counter)))
2245 (defun finalize-load-time-value-noise ()
2246 (cold-set (cold-intern '*!load-time-values*)
2247 (allocate-vector-object *dynamic*
2249 *load-time-value-counter*
2250 sb!vm:simple-vector-widetag)))
2252 (define-cold-fop (fop-funcall-for-effect :pushp nil)
2253 (if (= (read-arg 1) 0)
2254 (cold-push (pop-stack)
2255 *current-reversed-cold-toplevels*)
2256 (error "You can't FOP-FUNCALL arbitrary stuff in cold load.")))
2258 ;;;; cold fops for fixing up circularities
2260 (define-cold-fop (fop-rplaca :pushp nil)
2261 (let ((obj (svref *current-fop-table* (read-arg 4)))
2263 (write-memory (cold-nthcdr idx obj) (pop-stack))))
2265 (define-cold-fop (fop-rplacd :pushp nil)
2266 (let ((obj (svref *current-fop-table* (read-arg 4)))
2268 (write-wordindexed (cold-nthcdr idx obj) 1 (pop-stack))))
2270 (define-cold-fop (fop-svset :pushp nil)
2271 (let ((obj (svref *current-fop-table* (read-arg 4)))
2273 (write-wordindexed obj
2275 (ecase (descriptor-lowtag obj)
2276 (#.sb!vm:instance-pointer-lowtag 1)
2277 (#.sb!vm:other-pointer-lowtag 2)))
2280 (define-cold-fop (fop-structset :pushp nil)
2281 (let ((obj (svref *current-fop-table* (read-arg 4)))
2283 (write-wordindexed obj (1+ idx) (pop-stack))))
2285 ;;; In the original CMUCL code, this actually explicitly declared PUSHP
2286 ;;; to be T, even though that's what it defaults to in DEFINE-COLD-FOP.
2287 (define-cold-fop (fop-nthcdr)
2288 (cold-nthcdr (read-arg 4) (pop-stack)))
2290 (defun cold-nthcdr (index obj)
2292 (setq obj (read-wordindexed obj 1)))
2295 ;;;; cold fops for loading code objects and functions
2297 ;;; the names of things which have had COLD-FSET used on them already
2298 ;;; (used to make sure that we don't try to statically link a name to
2299 ;;; more than one definition)
2300 (defparameter *cold-fset-warm-names*
2301 ;; This can't be an EQL hash table because names can be conses, e.g.
2303 (make-hash-table :test 'equal))
2305 (define-cold-fop (fop-fset :pushp nil)
2306 (let* ((fn (pop-stack))
2307 (cold-name (pop-stack))
2308 (warm-name (warm-fun-name cold-name)))
2309 (if (gethash warm-name *cold-fset-warm-names*)
2310 (error "duplicate COLD-FSET for ~S" warm-name)
2311 (setf (gethash warm-name *cold-fset-warm-names*) t))
2312 (static-fset cold-name fn)))
2314 (define-cold-fop (fop-fdefinition)
2315 (cold-fdefinition-object (pop-stack)))
2317 (define-cold-fop (fop-sanctify-for-execution)
2320 ;;; Setting this variable shows what code looks like before any
2321 ;;; fixups (or function headers) are applied.
2322 #!+sb-show (defvar *show-pre-fixup-code-p* nil)
2324 ;;; FIXME: The logic here should be converted into a function
2325 ;;; COLD-CODE-FOP-GUTS (NCONST CODE-SIZE) called by DEFINE-COLD-FOP
2326 ;;; FOP-CODE and DEFINE-COLD-FOP FOP-SMALL-CODE, so that
2327 ;;; variable-capture nastiness like (LET ((NCONST ,NCONST) ..) ..)
2328 ;;; doesn't keep me awake at night.
2329 (defmacro define-cold-code-fop (name nconst code-size)
2330 `(define-cold-fop (,name)
2331 (let* ((nconst ,nconst)
2332 (code-size ,code-size)
2333 (raw-header-n-words (+ sb!vm:code-trace-table-offset-slot nconst))
2335 ;; Note: we round the number of constants up to ensure
2336 ;; that the code vector will be properly aligned.
2337 (round-up raw-header-n-words 2))
2338 (des (allocate-cold-descriptor *dynamic*
2339 (+ (ash header-n-words
2342 sb!vm:other-pointer-lowtag)))
2344 (make-other-immediate-descriptor
2345 header-n-words sb!vm:code-header-widetag))
2346 (write-wordindexed des
2347 sb!vm:code-code-size-slot
2348 (make-fixnum-descriptor
2349 (ash (+ code-size (1- (ash 1 sb!vm:word-shift)))
2350 (- sb!vm:word-shift))))
2351 (write-wordindexed des sb!vm:code-entry-points-slot *nil-descriptor*)
2352 (write-wordindexed des sb!vm:code-debug-info-slot (pop-stack))
2353 (when (oddp raw-header-n-words)
2354 (write-wordindexed des
2356 (make-random-descriptor 0)))
2357 (do ((index (1- raw-header-n-words) (1- index)))
2358 ((< index sb!vm:code-trace-table-offset-slot))
2359 (write-wordindexed des index (pop-stack)))
2360 (let* ((start (+ (descriptor-byte-offset des)
2361 (ash header-n-words sb!vm:word-shift)))
2362 (end (+ start code-size)))
2363 (read-sequence-or-die (descriptor-bytes des)
2368 (when *show-pre-fixup-code-p*
2369 (format *trace-output*
2370 "~&/raw code from code-fop ~W ~W:~%"
2373 (do ((i start (+ i sb!vm:n-word-bytes)))
2375 (format *trace-output*
2376 "/#X~8,'0x: #X~8,'0x~%"
2377 (+ i (gspace-byte-address (descriptor-gspace des)))
2378 (byte-vector-ref-32 (descriptor-bytes des) i)))))
2381 (define-cold-code-fop fop-code (read-arg 4) (read-arg 4))
2383 (define-cold-code-fop fop-small-code (read-arg 1) (read-arg 2))
2385 (clone-cold-fop (fop-alter-code :pushp nil)
2386 (fop-byte-alter-code)
2387 (let ((slot (clone-arg))
2390 (write-wordindexed code slot value)))
2392 (define-cold-fop (fop-fun-entry)
2393 (let* ((type (pop-stack))
2394 (arglist (pop-stack))
2396 (code-object (pop-stack))
2397 (offset (calc-offset code-object (read-arg 4)))
2398 (fn (descriptor-beyond code-object
2400 sb!vm:fun-pointer-lowtag))
2401 (next (read-wordindexed code-object sb!vm:code-entry-points-slot)))
2402 (unless (zerop (logand offset sb!vm:lowtag-mask))
2403 (error "unaligned function entry: ~S at #X~X" name offset))
2404 (write-wordindexed code-object sb!vm:code-entry-points-slot fn)
2406 (make-other-immediate-descriptor
2407 (ash offset (- sb!vm:word-shift))
2408 sb!vm:simple-fun-header-widetag))
2409 (write-wordindexed fn
2410 sb!vm:simple-fun-self-slot
2411 ;; KLUDGE: Wiring decisions like this in at
2412 ;; this level ("if it's an x86") instead of a
2413 ;; higher level of abstraction ("if it has such
2414 ;; and such relocation peculiarities (which
2415 ;; happen to be confined to the x86)") is bad.
2416 ;; It would be nice if the code were instead
2417 ;; conditional on some more descriptive
2418 ;; feature, :STICKY-CODE or
2419 ;; :LOAD-GC-INTERACTION or something.
2421 ;; FIXME: The X86 definition of the function
2422 ;; self slot breaks everything object.tex says
2423 ;; about it. (As far as I can tell, the X86
2424 ;; definition makes it a pointer to the actual
2425 ;; code instead of a pointer back to the object
2426 ;; itself.) Ask on the mailing list whether
2427 ;; this is documented somewhere, and if not,
2428 ;; try to reverse engineer some documentation.
2430 ;; a pointer back to the function object, as
2431 ;; described in CMU CL
2432 ;; src/docs/internals/object.tex
2435 ;; KLUDGE: a pointer to the actual code of the
2436 ;; object, as described nowhere that I can find
2438 (make-random-descriptor
2439 (+ (descriptor-bits fn)
2440 (- (ash sb!vm:simple-fun-code-offset
2442 ;; FIXME: We should mask out the type
2443 ;; bits, not assume we know what they
2444 ;; are and subtract them out this way.
2445 sb!vm:fun-pointer-lowtag))))
2446 (write-wordindexed fn sb!vm:simple-fun-next-slot next)
2447 (write-wordindexed fn sb!vm:simple-fun-name-slot name)
2448 (write-wordindexed fn sb!vm:simple-fun-arglist-slot arglist)
2449 (write-wordindexed fn sb!vm:simple-fun-type-slot type)
2452 (define-cold-fop (fop-foreign-fixup)
2453 (let* ((kind (pop-stack))
2454 (code-object (pop-stack))
2456 (sym (make-string len)))
2457 (read-string-as-bytes *fasl-input-stream* sym)
2458 (let ((offset (read-arg 4))
2459 (value (cold-foreign-symbol-address-as-integer sym)))
2460 (do-cold-fixup code-object offset value kind))
2463 (define-cold-fop (fop-assembler-code)
2464 (let* ((length (read-arg 4))
2466 ;; Note: we round the number of constants up to ensure that
2467 ;; the code vector will be properly aligned.
2468 (round-up sb!vm:code-constants-offset 2))
2469 (des (allocate-cold-descriptor *read-only*
2470 (+ (ash header-n-words
2473 sb!vm:other-pointer-lowtag)))
2475 (make-other-immediate-descriptor
2476 header-n-words sb!vm:code-header-widetag))
2477 (write-wordindexed des
2478 sb!vm:code-code-size-slot
2479 (make-fixnum-descriptor
2480 (ash (+ length (1- (ash 1 sb!vm:word-shift)))
2481 (- sb!vm:word-shift))))
2482 (write-wordindexed des sb!vm:code-entry-points-slot *nil-descriptor*)
2483 (write-wordindexed des sb!vm:code-debug-info-slot *nil-descriptor*)
2485 (let* ((start (+ (descriptor-byte-offset des)
2486 (ash header-n-words sb!vm:word-shift)))
2487 (end (+ start length)))
2488 (read-sequence-or-die (descriptor-bytes des)
2494 (define-cold-fop (fop-assembler-routine)
2495 (let* ((routine (pop-stack))
2497 (offset (calc-offset des (read-arg 4))))
2498 (record-cold-assembler-routine
2500 (+ (logandc2 (descriptor-bits des) sb!vm:lowtag-mask) offset))
2503 (define-cold-fop (fop-assembler-fixup)
2504 (let* ((routine (pop-stack))
2506 (code-object (pop-stack))
2507 (offset (read-arg 4)))
2508 (record-cold-assembler-fixup routine code-object offset kind)
2511 (define-cold-fop (fop-code-object-fixup)
2512 (let* ((kind (pop-stack))
2513 (code-object (pop-stack))
2514 (offset (read-arg 4))
2515 (value (descriptor-bits code-object)))
2516 (do-cold-fixup code-object offset value kind)
2519 ;;;; emitting C header file
2521 (defun tailwise-equal (string tail)
2522 (and (>= (length string) (length tail))
2523 (string= string tail :start1 (- (length string) (length tail)))))
2525 (defun write-c-header ()
2527 ;; writing beginning boilerplate
2530 '("This is a machine-generated file. Please do not edit it by hand."
2532 "This file contains low-level information about the"
2533 "internals of a particular version and configuration"
2534 "of SBCL. It is used by the C compiler to create a runtime"
2535 "support environment, an executable program in the host"
2536 "operating system's native format, which can then be used to"
2537 "load and run 'core' files, which are basically programs"
2538 "in SBCL's own format."))
2539 (format t " * ~A~%" line))
2542 (format t "#ifndef _SBCL_H_~%#define _SBCL_H_~%")
2545 ;; propagating *SHEBANG-FEATURES* into C-level #define's
2546 (dolist (shebang-feature-name (sort (mapcar #'symbol-name
2547 sb-cold:*shebang-features*)
2550 "#define LISP_FEATURE_~A~%"
2551 (substitute #\_ #\- shebang-feature-name)))
2554 ;; writing miscellaneous constants
2555 (format t "#define SBCL_CORE_VERSION_INTEGER ~D~%" sbcl-core-version-integer)
2557 "#define SBCL_VERSION_STRING ~S~%"
2558 (sb!xc:lisp-implementation-version))
2559 (format t "#define CORE_MAGIC 0x~X~%" core-magic)
2561 ;; FIXME: Other things from core.h should be defined here too:
2562 ;; #define CORE_END 3840
2563 ;; #define CORE_NDIRECTORY 3861
2564 ;; #define CORE_VALIDATE 3845
2565 ;; #define CORE_VERSION 3860
2566 ;; #define CORE_MACHINE_STATE 3862
2567 ;; (Except that some of them are obsolete and should be deleted instead.)
2569 ;; #define DYNAMIC_SPACE_ID (1)
2570 ;; #define STATIC_SPACE_ID (2)
2571 ;; #define READ_ONLY_SPACE_ID (3)
2573 ;; writing entire families of named constants from SB!VM
2574 (let ((constants nil))
2575 (do-external-symbols (symbol (find-package "SB!VM"))
2576 (when (constantp symbol)
2577 (let ((name (symbol-name symbol)))
2578 (labels (;; shared machinery
2579 (record (string priority)
2582 (symbol-value symbol)
2583 (documentation symbol 'variable))
2585 ;; machinery for old-style CMU CL Lisp-to-C
2586 ;; arbitrary renaming, being phased out in favor of
2587 ;; the newer systematic RECORD-WITH-TRANSLATED-NAME
2589 (record-with-munged-name (prefix string priority)
2590 (record (concatenate
2593 (delete #\- (string-capitalize string)))
2595 (maybe-record-with-munged-name (tail prefix priority)
2596 (when (tailwise-equal name tail)
2597 (record-with-munged-name prefix
2602 ;; machinery for new-style SBCL Lisp-to-C naming
2603 (record-with-translated-name (priority)
2604 (record (substitute #\_ #\- name)
2606 (maybe-record-with-translated-name (suffixes priority)
2607 (when (some (lambda (suffix)
2608 (tailwise-equal name suffix))
2610 (record-with-translated-name priority))))
2612 (maybe-record-with-translated-name '("-LOWTAG") 0)
2613 (maybe-record-with-translated-name '("-WIDETAG") 1)
2614 (maybe-record-with-munged-name "-FLAG" "flag_" 2)
2615 (maybe-record-with-munged-name "-TRAP" "trap_" 3)
2616 (maybe-record-with-munged-name "-SUBTYPE" "subtype_" 4)
2617 (maybe-record-with-munged-name "-SC-NUMBER" "sc_" 5)
2618 (maybe-record-with-translated-name '("-START" "-END") 6)))))
2621 (lambda (const1 const2)
2622 (if (= (second const1) (second const2))
2623 (< (third const1) (third const2))
2624 (< (second const1) (second const2))))))
2625 (let ((prev-priority (second (car constants))))
2626 (dolist (const constants)
2627 (destructuring-bind (name priority value doc) const
2628 (unless (= prev-priority priority)
2630 (setf prev-priority priority))
2631 (format t "#define ~A " name)
2633 ;; KLUDGE: As of sbcl-0.6.7.14, we're dumping two
2634 ;; different kinds of values here, (1) small codes
2635 ;; and (2) machine addresses. The small codes can be
2636 ;; dumped as bare integer values. The large machine
2637 ;; addresses might cause problems if they're large
2638 ;; and represented as (signed) C integers, so we
2639 ;; want to force them to be unsigned. We do that by
2640 ;; wrapping them in the LISPOBJ macro. (We could do
2641 ;; it with a bare "(unsigned)" cast, except that
2642 ;; this header file is used not only in C files, but
2643 ;; also in assembly files, which don't understand
2644 ;; the cast syntax. The LISPOBJ macro goes away in
2645 ;; assembly files, but that shouldn't matter because
2646 ;; we don't do arithmetic on address constants in
2647 ;; assembly files. See? It really is a kludge..) --
2649 (let (;; cutoff for treatment as a small code
2650 (cutoff (expt 2 16)))
2651 (cond ((minusp value)
2652 (error "stub: negative values unsupported"))
2658 (format t " /* 0x~X */~@[ /* ~A */~]~%" value doc))))
2661 ;; writing information about internal errors
2662 (let ((internal-errors sb!c:*backend-internal-errors*))
2663 (dotimes (i (length internal-errors))
2664 (let ((current-error (aref internal-errors i)))
2665 ;; FIXME: this UNLESS should go away (see also FIXME in
2666 ;; interr.lisp) -- APD, 2002-03-05
2667 (unless (eq nil (car current-error))
2668 (format t "#define ~A ~D~%"
2669 (substitute #\_ #\- (symbol-name (car current-error)))
2673 ;; FIXME: The SPARC has a PSEUDO-ATOMIC-TRAP that differs between
2674 ;; platforms. If we export this from the SB!VM package, it gets
2675 ;; written out as #define trap_PseudoAtomic, which is confusing as
2676 ;; the runtime treats trap_ as the prefix for illegal instruction
2677 ;; type things. We therefore don't export it, but instead do
2678 (when (boundp 'sb!vm::pseudo-atomic-trap)
2679 (format t "#define PSEUDO_ATOMIC_TRAP ~D /* 0x~:*~X */~%" sb!vm::pseudo-atomic-trap)
2681 ;; possibly this is another candidate for a rename (to
2682 ;; pseudo-atomic-trap-number or pseudo-atomic-magic-constant
2683 ;; [possibly applicable to other platforms])
2685 ;; writing primitive object layouts
2686 (let ((structs (sort (copy-list sb!vm:*primitive-objects*) #'string<
2689 (sb!vm:primitive-object-name obj))))))
2690 (format t "#ifndef LANGUAGE_ASSEMBLY~2%")
2691 (format t "#define LISPOBJ(x) ((lispobj)x)~2%")
2692 (dolist (obj structs)
2695 (nsubstitute #\_ #\-
2696 (string-downcase (string (sb!vm:primitive-object-name obj)))))
2697 (when (sb!vm:primitive-object-widetag obj)
2698 (format t " lispobj header;~%"))
2699 (dolist (slot (sb!vm:primitive-object-slots obj))
2700 (format t " ~A ~A~@[[1]~];~%"
2701 (getf (sb!vm:slot-options slot) :c-type "lispobj")
2702 (nsubstitute #\_ #\-
2703 (string-downcase (string (sb!vm:slot-name slot))))
2704 (sb!vm:slot-rest-p slot)))
2706 (format t "#else /* LANGUAGE_ASSEMBLY */~2%")
2707 (format t "#define LISPOBJ(thing) thing~2%")
2708 (dolist (obj structs)
2709 (let ((name (sb!vm:primitive-object-name obj))
2710 (lowtag (eval (sb!vm:primitive-object-lowtag obj))))
2712 (dolist (slot (sb!vm:primitive-object-slots obj))
2713 (format t "#define ~A_~A_OFFSET ~D~%"
2714 (substitute #\_ #\- (string name))
2715 (substitute #\_ #\- (string (sb!vm:slot-name slot)))
2716 (- (* (sb!vm:slot-offset slot) sb!vm:n-word-bytes) lowtag)))
2718 (format t "#endif /* LANGUAGE_ASSEMBLY */~2%"))
2720 ;; writing static symbol offsets
2721 (dolist (symbol (cons nil sb!vm:*static-symbols*))
2722 ;; FIXME: It would be nice to use longer names than NIL and
2723 ;; (particularly) T in #define statements.
2724 (format t "#define ~A LISPOBJ(0x~X)~%"
2725 (nsubstitute #\_ #\-
2726 (remove-if (lambda (char)
2727 (member char '(#\% #\* #\. #\!)))
2728 (symbol-name symbol)))
2729 (if *static* ; if we ran GENESIS
2730 ;; We actually ran GENESIS, use the real value.
2731 (descriptor-bits (cold-intern symbol))
2732 ;; We didn't run GENESIS, so guess at the address.
2733 (+ sb!vm:static-space-start
2735 sb!vm:other-pointer-lowtag
2736 (if symbol (sb!vm:static-symbol-offset symbol) 0)))))
2739 (format t "~%#endif~%"))
2741 ;;;; writing map file
2743 ;;; Write a map file describing the cold load. Some of this
2744 ;;; information is subject to change due to relocating GC, but even so
2745 ;;; it can be very handy when attempting to troubleshoot the early
2746 ;;; stages of cold load.
2748 (let ((*print-pretty* nil)
2749 (*print-case* :upcase))
2750 (format t "assembler routines defined in core image:~2%")
2751 (dolist (routine (sort (copy-list *cold-assembler-routines*) #'<
2753 (format t "#X~8,'0X: ~S~%" (cdr routine) (car routine)))
2756 (maphash (lambda (name fdefn)
2757 (let ((fun (read-wordindexed fdefn
2758 sb!vm:fdefn-fun-slot)))
2759 (if (= (descriptor-bits fun)
2760 (descriptor-bits *nil-descriptor*))
2762 (let ((addr (read-wordindexed
2763 fdefn sb!vm:fdefn-raw-addr-slot)))
2764 (push (cons name (descriptor-bits addr))
2766 *cold-fdefn-objects*)
2767 (format t "~%~|~%initially defined functions:~2%")
2768 (setf funs (sort funs #'< :key #'cdr))
2770 (format t "0x~8,'0X: ~S #X~8,'0X~%" (cdr info) (car info)
2771 (- (cdr info) #x17)))
2774 (a note about initially undefined function references: These functions
2775 are referred to by code which is installed by GENESIS, but they are not
2776 installed by GENESIS. This is not necessarily a problem; functions can
2777 be defined later, by cold init toplevel forms, or in files compiled and
2778 loaded at warm init, or elsewhere. As long as they are defined before
2779 they are called, everything should be OK. Things are also OK if the
2780 cross-compiler knew their inline definition and used that everywhere
2781 that they were called before the out-of-line definition is installed,
2782 as is fairly common for structure accessors.)
2783 initially undefined function references:~2%")
2785 (setf undefs (sort undefs #'string< :key #'fun-name-block-name))
2786 (dolist (name undefs)
2787 (format t "~S~%" name)))
2789 (format t "~%~|~%layout names:~2%")
2791 (maphash (lambda (name gorp)
2792 (declare (ignore name))
2793 (stuff (cons (descriptor-bits (car gorp))
2796 (dolist (x (sort (stuff) #'< :key #'car))
2797 (apply #'format t "~8,'0X: ~S[~D]~%~10T~S~%" x))))
2801 ;;;; writing core file
2803 (defvar *core-file*)
2804 (defvar *data-page*)
2806 ;;; KLUDGE: These numbers correspond to values in core.h. If they're
2807 ;;; documented anywhere, I haven't found it. (I haven't tried very
2808 ;;; hard yet.) -- WHN 19990826
2809 (defparameter version-entry-type-code 3860)
2810 (defparameter validate-entry-type-code 3845)
2811 (defparameter directory-entry-type-code 3841)
2812 (defparameter new-directory-entry-type-code 3861)
2813 (defparameter initial-fun-entry-type-code 3863)
2814 (defparameter end-entry-type-code 3840)
2816 (declaim (ftype (function (sb!vm:word) sb!vm:word) write-word))
2817 (defun write-word (num)
2818 (ecase sb!c:*backend-byte-order*
2821 (write-byte (ldb (byte 8 (* i 8)) num) *core-file*)))
2824 (write-byte (ldb (byte 8 (* (- 3 i) 8)) num) *core-file*))))
2827 (defun advance-to-page ()
2828 (force-output *core-file*)
2829 (file-position *core-file*
2830 (round-up (file-position *core-file*)
2831 sb!c:*backend-page-size*)))
2833 (defun output-gspace (gspace)
2834 (force-output *core-file*)
2835 (let* ((posn (file-position *core-file*))
2836 (bytes (* (gspace-free-word-index gspace) sb!vm:n-word-bytes))
2837 (pages (ceiling bytes sb!c:*backend-page-size*))
2838 (total-bytes (* pages sb!c:*backend-page-size*)))
2840 (file-position *core-file*
2841 (* sb!c:*backend-page-size* (1+ *data-page*)))
2843 "writing ~S byte~:P [~S page~:P] from ~S~%"
2849 ;; Note: It is assumed that the GSPACE allocation routines always
2850 ;; allocate whole pages (of size *target-page-size*) and that any
2851 ;; empty gspace between the free pointer and the end of page will
2852 ;; be zero-filled. This will always be true under Mach on machines
2853 ;; where the page size is equal. (RT is 4K, PMAX is 4K, Sun 3 is
2855 (write-sequence (gspace-bytes gspace) *core-file* :end total-bytes)
2856 (force-output *core-file*)
2857 (file-position *core-file* posn)
2859 ;; Write part of a (new) directory entry which looks like this:
2860 ;; GSPACE IDENTIFIER
2865 (write-word (gspace-identifier gspace))
2866 (write-word (gspace-free-word-index gspace))
2867 (write-word *data-page*)
2868 (multiple-value-bind (floor rem)
2869 (floor (gspace-byte-address gspace) sb!c:*backend-page-size*)
2874 (incf *data-page* pages)))
2876 ;;; Create a core file created from the cold loaded image. (This is
2877 ;;; the "initial core file" because core files could be created later
2878 ;;; by executing SAVE-LISP in a running system, perhaps after we've
2879 ;;; added some functionality to the system.)
2880 (declaim (ftype (function (string)) write-initial-core-file))
2881 (defun write-initial-core-file (filename)
2883 (let ((filenamestring (namestring filename))
2887 "[building initial core file in ~S: ~%"
2891 (with-open-file (*core-file* filenamestring
2893 :element-type '(unsigned-byte 8)
2894 :if-exists :rename-and-delete)
2896 ;; Write the magic number.
2897 (write-word core-magic)
2899 ;; Write the Version entry.
2900 (write-word version-entry-type-code)
2902 (write-word sbcl-core-version-integer)
2904 ;; Write the New Directory entry header.
2905 (write-word new-directory-entry-type-code)
2906 (write-word 17) ; length = (5 words/space) * 3 spaces + 2 for header.
2908 (output-gspace *read-only*)
2909 (output-gspace *static*)
2910 (output-gspace *dynamic*)
2912 ;; Write the initial function.
2913 (write-word initial-fun-entry-type-code)
2915 (let* ((cold-name (cold-intern '!cold-init))
2916 (cold-fdefn (cold-fdefinition-object cold-name))
2917 (initial-fun (read-wordindexed cold-fdefn
2918 sb!vm:fdefn-fun-slot)))
2920 "~&/(DESCRIPTOR-BITS INITIAL-FUN)=#X~X~%"
2921 (descriptor-bits initial-fun))
2922 (write-word (descriptor-bits initial-fun)))
2924 ;; Write the End entry.
2925 (write-word end-entry-type-code)
2928 (format t "done]~%")
2930 (/show "leaving WRITE-INITIAL-CORE-FILE")
2933 ;;;; the actual GENESIS function
2935 ;;; Read the FASL files in OBJECT-FILE-NAMES and produce a Lisp core,
2936 ;;; and/or information about a Lisp core, therefrom.
2938 ;;; input file arguments:
2939 ;;; SYMBOL-TABLE-FILE-NAME names a UNIX-style .nm file *with* *any*
2940 ;;; *tab* *characters* *converted* *to* *spaces*. (We push
2941 ;;; responsibility for removing tabs out to the caller it's
2942 ;;; trivial to remove them using UNIX command line tools like
2943 ;;; sed, whereas it's a headache to do it portably in Lisp because
2944 ;;; #\TAB is not a STANDARD-CHAR.) If this file is not supplied,
2945 ;;; a core file cannot be built (but a C header file can be).
2947 ;;; output files arguments (any of which may be NIL to suppress output):
2948 ;;; CORE-FILE-NAME gets a Lisp core.
2949 ;;; C-HEADER-FILE-NAME gets a C header file, traditionally called
2950 ;;; internals.h, which is used by the C compiler when constructing
2951 ;;; the executable which will load the core.
2952 ;;; MAP-FILE-NAME gets (?) a map file. (dunno about this -- WHN 19990815)
2954 ;;; other arguments:
2955 ;;; BYTE-ORDER-SWAP-P controls whether GENESIS tries to swap bytes
2956 ;;; in some places in the output. It's only appropriate when
2957 ;;; cross-compiling from a machine with one byte order to a
2958 ;;; machine with the opposite byte order, which is irrelevant in
2959 ;;; current (19990816) SBCL, since only the X86 architecture is
2960 ;;; supported. If you're trying to add support for more
2961 ;;; architectures, see the comments on DEFVAR
2962 ;;; *GENESIS-BYTE-ORDER-SWAP-P* for more information.
2964 ;;; FIXME: GENESIS doesn't belong in SB!VM. Perhaps in %KERNEL for now,
2965 ;;; perhaps eventually in SB-LD or SB-BOOT.
2966 (defun sb!vm:genesis (&key
2968 symbol-table-file-name
2974 (when (and core-file-name
2975 (not symbol-table-file-name))
2976 (error "can't output a core file without symbol table file input"))
2979 "~&beginning GENESIS, ~A~%"
2981 ;; Note: This output summarizing what we're doing is
2982 ;; somewhat telegraphic in style, not meant to imply that
2983 ;; we're not e.g. also creating a header file when we
2985 (format nil "creating core ~S" core-file-name)
2986 (format nil "creating header ~S" c-header-file-name)))
2988 (let* ((*cold-foreign-symbol-table* (make-hash-table :test 'equal)))
2990 ;; Read symbol table, if any.
2991 (when symbol-table-file-name
2992 (load-cold-foreign-symbol-table symbol-table-file-name))
2994 ;; Now that we've successfully read our only input file (by
2995 ;; loading the symbol table, if any), it's a good time to ensure
2996 ;; that there'll be someplace for our output files to go when
2998 (flet ((frob (filename)
3000 (ensure-directories-exist filename :verbose t))))
3001 (frob core-file-name)
3002 (frob map-file-name)
3003 (frob c-header-file-name))
3005 ;; (This shouldn't matter in normal use, since GENESIS normally
3006 ;; only runs once in any given Lisp image, but it could reduce
3007 ;; confusion if we ever experiment with running, tweaking, and
3008 ;; rerunning genesis interactively.)
3009 (do-all-symbols (sym)
3010 (remprop sym 'cold-intern-info))
3012 (let* ((*foreign-symbol-placeholder-value* (if core-file-name nil 0))
3013 (*load-time-value-counter* 0)
3014 (*genesis-byte-order-swap-p* byte-order-swap-p)
3015 (*cold-fdefn-objects* (make-hash-table :test 'equal))
3016 (*cold-symbols* (make-hash-table :test 'equal))
3017 (*cold-package-symbols* nil)
3018 (*read-only* (make-gspace :read-only
3020 sb!vm:read-only-space-start))
3021 (*static* (make-gspace :static
3023 sb!vm:static-space-start))
3024 (*dynamic* (make-gspace :dynamic
3026 #!+gencgc sb!vm:dynamic-space-start
3027 #!-gencgc sb!vm:dynamic-0-space-start))
3028 (*nil-descriptor* (make-nil-descriptor))
3029 (*current-reversed-cold-toplevels* *nil-descriptor*)
3030 (*unbound-marker* (make-other-immediate-descriptor
3032 sb!vm:unbound-marker-widetag))
3033 *cold-assembler-fixups*
3034 *cold-assembler-routines*
3035 #!+x86 *load-time-code-fixups*)
3037 ;; Prepare for cold load.
3038 (initialize-non-nil-symbols)
3039 (initialize-layouts)
3040 (initialize-static-fns)
3042 ;; Initialize the *COLD-SYMBOLS* system with the information
3043 ;; from package-data-list.lisp-expr and
3044 ;; common-lisp-exports.lisp-expr.
3046 ;; Why do things this way? Historically, the *COLD-SYMBOLS*
3047 ;; machinery was designed and implemented in CMU CL long before
3048 ;; I (WHN) ever heard of CMU CL. It dumped symbols and packages
3049 ;; iff they were used in the cold image. When I added the
3050 ;; package-data-list.lisp-expr mechanism, the idea was to
3051 ;; centralize all information about packages and exports. Thus,
3052 ;; it was the natural place for information even about packages
3053 ;; (such as SB!PCL and SB!WALKER) which aren't used much until
3054 ;; after cold load. This didn't quite match the CMU CL approach
3055 ;; of filling *COLD-SYMBOLS* with symbols which appear in the
3056 ;; cold image and then dumping only those symbols. By explicitly
3057 ;; putting all the symbols from package-data-list.lisp-expr and
3058 ;; from common-lisp-exports.lisp-expr into *COLD-SYMBOLS* here,
3059 ;; we feed our centralized symbol information into the old CMU
3060 ;; CL code without having to change the old CMU CL code too
3061 ;; much. (And the old CMU CL code is still useful for making
3062 ;; sure that the appropriate keywords and internal symbols end
3063 ;; up interned in the target Lisp, which is good, e.g. in order
3064 ;; to make &KEY arguments work right and in order to make
3065 ;; BACKTRACEs into target Lisp system code be legible.)
3066 (dolist (exported-name
3067 (sb-cold:read-from-file "common-lisp-exports.lisp-expr"))
3068 (cold-intern (intern exported-name *cl-package*)))
3069 (dolist (pd (sb-cold:read-from-file "package-data-list.lisp-expr"))
3070 (declare (type sb-cold:package-data pd))
3071 (let ((package (find-package (sb-cold:package-data-name pd))))
3072 (labels (;; Call FN on every node of the TREE.
3073 (mapc-on-tree (fn tree)
3075 (cons (mapc-on-tree fn (car tree))
3076 (mapc-on-tree fn (cdr tree)))
3077 (t (funcall fn tree)
3079 ;; Make sure that information about the association
3080 ;; between PACKAGE and the symbol named NAME gets
3081 ;; recorded in the cold-intern system or (as a
3082 ;; convenience when dealing with the tree structure
3083 ;; allowed in the PACKAGE-DATA-EXPORTS slot) do
3084 ;; nothing if NAME is NIL.
3087 (cold-intern (intern name package) package))))
3088 (mapc-on-tree #'chill (sb-cold:package-data-export pd))
3089 (mapc #'chill (sb-cold:package-data-reexport pd))
3090 (dolist (sublist (sb-cold:package-data-import-from pd))
3091 (destructuring-bind (package-name &rest symbol-names) sublist
3092 (declare (ignore package-name))
3093 (mapc #'chill symbol-names))))))
3096 (dolist (file-name object-file-names)
3097 (write-line (namestring file-name))
3098 (cold-load file-name))
3100 ;; Tidy up loose ends left by cold loading. ("Postpare from cold load?")
3101 (resolve-assembler-fixups)
3102 #!+x86 (output-load-time-code-fixups)
3103 (linkage-info-to-core)
3105 (/show "back from FINISH-SYMBOLS")
3106 (finalize-load-time-value-noise)
3108 ;; Tell the target Lisp how much stuff we've allocated.
3109 (cold-set 'sb!vm:*read-only-space-free-pointer*
3110 (allocate-cold-descriptor *read-only*
3112 sb!vm:even-fixnum-lowtag))
3113 (cold-set 'sb!vm:*static-space-free-pointer*
3114 (allocate-cold-descriptor *static*
3116 sb!vm:even-fixnum-lowtag))
3117 (cold-set 'sb!vm:*initial-dynamic-space-free-pointer*
3118 (allocate-cold-descriptor *dynamic*
3120 sb!vm:even-fixnum-lowtag))
3121 (/show "done setting free pointers")
3123 ;; Write results to files.
3125 ;; FIXME: I dislike this approach of redefining
3126 ;; *STANDARD-OUTPUT* instead of putting the new stream in a
3127 ;; lexical variable, and it's annoying to have WRITE-MAP (to
3128 ;; *STANDARD-OUTPUT*) not be parallel to WRITE-INITIAL-CORE-FILE
3129 ;; (to a stream explicitly passed as an argument).
3131 (with-open-file (*standard-output* map-file-name
3133 :if-exists :supersede)
3135 (when c-header-file-name
3136 (with-open-file (*standard-output* c-header-file-name
3138 :if-exists :supersede)
3140 (when core-file-name
3141 (write-initial-core-file core-file-name)))))