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 (sb!xc:char-code #\S) 24)
38 (ash (sb!xc:char-code #\B) 16)
39 (ash (sb!xc:char-code #\C) 8)
40 (sb!xc:char-code #\L)))
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. (Though now as of sbcl-0.7.8 or
51 ;;; so, we have another problem that the core incompatibility
52 ;;; detection mechanisms are on such a hair trigger -- with even
53 ;;; different builds from the same sources being considered
54 ;;; incompatible -- that any coarser-grained versioning mechanisms
55 ;;; like this are largely irrelevant as long as the hair-triggering
58 ;;; 0: inherited from CMU CL
59 ;;; 1: rearranged static symbols for sbcl-0.6.8
60 ;;; 2: eliminated non-ANSI %DEFCONSTANT/%%DEFCONSTANT support,
61 ;;; deleted a slot from DEBUG-SOURCE structure
62 ;;; 3: added build ID to cores to discourage sbcl/.core mismatch
63 (defconstant sbcl-core-version-integer 3)
65 (defun round-up (number size)
67 "Round NUMBER up to be an integral multiple of SIZE."
68 (* size (ceiling number size)))
70 ;;;; implementing the concept of "vector" in (almost) portable
73 ;;;; "If you only need to do such simple things, it doesn't really
74 ;;;; matter which language you use." -- _ANSI Common Lisp_, p. 1, Paul
75 ;;;; Graham (evidently not considering the abstraction "vector" to be
76 ;;;; such a simple thing:-)
78 (eval-when (:compile-toplevel :load-toplevel :execute)
79 (defconstant +smallvec-length+
82 ;;; an element of a BIGVEC -- a vector small enough that we have
83 ;;; a good chance of it being portable to other Common Lisps
85 `(simple-array (unsigned-byte 8) (,+smallvec-length+)))
87 (defun make-smallvec ()
88 (make-array +smallvec-length+ :element-type '(unsigned-byte 8)))
90 ;;; a big vector, implemented as a vector of SMALLVECs
92 ;;; KLUDGE: This implementation seems portable enough for our
93 ;;; purposes, since realistically every modern implementation is
94 ;;; likely to support vectors of at least 2^16 elements. But if you're
95 ;;; masochistic enough to read this far into the contortions imposed
96 ;;; on us by ANSI and the Lisp community, for daring to use the
97 ;;; abstraction of a large linearly addressable memory space, which is
98 ;;; after all only directly supported by the underlying hardware of at
99 ;;; least 99% of the general-purpose computers in use today, then you
100 ;;; may be titillated to hear that in fact this code isn't really
101 ;;; portable, because as of sbcl-0.7.4 we need somewhat more than
102 ;;; 16Mbytes to represent a core, and ANSI only guarantees that
103 ;;; ARRAY-DIMENSION-LIMIT is not less than 1024. -- WHN 2002-06-13
105 (outer-vector (vector (make-smallvec)) :type (vector smallvec)))
107 ;;; analogous to SVREF, but into a BIGVEC
108 (defun bvref (bigvec index)
109 (multiple-value-bind (outer-index inner-index)
110 (floor index +smallvec-length+)
112 (svref (bigvec-outer-vector bigvec) outer-index))
114 (defun (setf bvref) (new-value bigvec index)
115 (multiple-value-bind (outer-index inner-index)
116 (floor index +smallvec-length+)
117 (setf (aref (the smallvec
118 (svref (bigvec-outer-vector bigvec) outer-index))
122 ;;; analogous to LENGTH, but for a BIGVEC
124 ;;; the length of BIGVEC, measured in the number of BVREFable bytes it
126 (defun bvlength (bigvec)
127 (* (length (bigvec-outer-vector bigvec))
130 ;;; analogous to WRITE-SEQUENCE, but for a BIGVEC
131 (defun write-bigvec-as-sequence (bigvec stream &key (start 0) end)
132 (loop for i of-type index from start below (or end (bvlength bigvec)) do
133 (write-byte (bvref bigvec i)
136 ;;; analogous to READ-SEQUENCE-OR-DIE, but for a BIGVEC
137 (defun read-bigvec-as-sequence-or-die (bigvec stream &key (start 0) end)
138 (loop for i of-type index from start below (or end (bvlength bigvec)) do
139 (setf (bvref bigvec i)
140 (read-byte stream))))
142 ;;; Grow BIGVEC (exponentially, so that large increases in size have
143 ;;; asymptotic logarithmic cost per byte).
144 (defun expand-bigvec (bigvec)
145 (let* ((old-outer-vector (bigvec-outer-vector bigvec))
146 (length-old-outer-vector (length old-outer-vector))
147 (new-outer-vector (make-array (* 2 length-old-outer-vector))))
148 (dotimes (i length-old-outer-vector)
149 (setf (svref new-outer-vector i)
150 (svref old-outer-vector i)))
151 (loop for i from length-old-outer-vector below (length new-outer-vector) do
152 (setf (svref new-outer-vector i)
154 (setf (bigvec-outer-vector bigvec)
158 ;;;; looking up bytes and multi-byte values in a BIGVEC (considering
159 ;;;; it as an image of machine memory on the cross-compilation target)
161 ;;; BVREF-32 and friends. These are like SAP-REF-n, except that
162 ;;; instead of a SAP we use a BIGVEC.
163 (macrolet ((make-bvref-n
165 (let* ((name (intern (format nil "BVREF-~A" n)))
166 (number-octets (/ n 8))
168 (loop for i from 0 to (1- number-octets)
169 collect `(ash (bvref bigvec (+ byte-index ,i))
172 (loop for i from 0 to (1- number-octets)
173 collect `(ash (bvref bigvec
175 ,(- number-octets 1 i)))
178 (loop for i from 0 to (1- number-octets)
180 `((bvref bigvec (+ byte-index ,i))
181 (ldb (byte 8 ,(* i 8)) new-value))))
183 (loop for i from 0 to (1- number-octets)
185 `((bvref bigvec (+ byte-index ,i))
186 (ldb (byte 8 ,(- n 8 (* i 8))) new-value)))))
188 (defun ,name (bigvec byte-index)
189 (logior ,@(ecase sb!c:*backend-byte-order*
190 (:little-endian ash-list-le)
191 (:big-endian ash-list-be))))
192 (defun (setf ,name) (new-value bigvec byte-index)
193 (setf ,@(ecase sb!c:*backend-byte-order*
194 (:little-endian setf-list-le)
195 (:big-endian setf-list-be))))))))
201 ;; lispobj-sized word, whatever that may be
202 ;; hopefully nobody ever wants a 128-bit SBCL...
203 #!+#.(cl:if (cl:= 64 sb!vm:n-word-bits) '(and) '(or))
205 (defun bvref-word (bytes index)
206 (bvref-64 bytes index))
207 (defun (setf bvref-word) (new-val bytes index)
208 (setf (bvref-64 bytes index) new-val)))
210 #!+#.(cl:if (cl:= 32 sb!vm:n-word-bits) '(and) '(or))
212 (defun bvref-word (bytes index)
213 (bvref-32 bytes index))
214 (defun (setf bvref-word) (new-val bytes index)
215 (setf (bvref-32 bytes index) new-val)))
218 ;;;; representation of spaces in the core
220 ;;; If there is more than one dynamic space in memory (i.e., if a
221 ;;; copying GC is in use), then only the active dynamic space gets
224 (defconstant dynamic-core-space-id 1)
227 (defconstant static-core-space-id 2)
230 (defconstant read-only-core-space-id 3)
232 (defconstant descriptor-low-bits 16
233 "the number of bits in the low half of the descriptor")
234 (defconstant target-space-alignment (ash 1 descriptor-low-bits)
235 "the alignment requirement for spaces in the target.
236 Must be at least (ASH 1 DESCRIPTOR-LOW-BITS)")
238 ;;; a GENESIS-time representation of a memory space (e.g. read-only
239 ;;; space, dynamic space, or static space)
240 (defstruct (gspace (:constructor %make-gspace)
242 ;; name and identifier for this GSPACE
243 (name (missing-arg) :type symbol :read-only t)
244 (identifier (missing-arg) :type fixnum :read-only t)
245 ;; the word address where the data will be loaded
246 (word-address (missing-arg) :type unsigned-byte :read-only t)
247 ;; the data themselves. (Note that in CMU CL this was a pair of
248 ;; fields SAP and WORDS-ALLOCATED, but that wasn't very portable.)
249 ;; (And then in SBCL this was a VECTOR, but turned out to be
250 ;; unportable too, since ANSI doesn't think that arrays longer than
251 ;; 1024 (!) should needed by portable CL code...)
252 (bytes (make-bigvec) :read-only t)
253 ;; the index of the next unwritten word (i.e. chunk of
254 ;; SB!VM:N-WORD-BYTES bytes) in BYTES, or equivalently the number of
255 ;; words actually written in BYTES. In order to convert to an actual
256 ;; index into BYTES, thus must be multiplied by SB!VM:N-WORD-BYTES.
259 (defun gspace-byte-address (gspace)
260 (ash (gspace-word-address gspace) sb!vm:word-shift))
262 (def!method print-object ((gspace gspace) stream)
263 (print-unreadable-object (gspace stream :type t)
264 (format stream "~S" (gspace-name gspace))))
266 (defun make-gspace (name identifier byte-address)
267 (unless (zerop (rem byte-address target-space-alignment))
268 (error "The byte address #X~X is not aligned on a #X~X-byte boundary."
270 target-space-alignment))
271 (%make-gspace :name name
272 :identifier identifier
273 :word-address (ash byte-address (- sb!vm:word-shift))))
275 ;;;; representation of descriptors
277 (defstruct (descriptor
278 (:constructor make-descriptor
279 (high low &optional gspace word-offset))
281 ;; the GSPACE that this descriptor is allocated in, or NIL if not set yet.
282 (gspace nil :type (or gspace null))
283 ;; the offset in words from the start of GSPACE, or NIL if not set yet
284 (word-offset nil :type (or sb!vm:word null))
285 ;; the high and low halves of the descriptor
287 ;; KLUDGE: Judging from the comments in genesis.lisp of the CMU CL
288 ;; old-rt compiler, this split dates back from a very early version
289 ;; of genesis where 32-bit integers were represented as conses of
290 ;; two 16-bit integers. In any system with nice (UNSIGNED-BYTE 32)
291 ;; structure slots, like CMU CL >= 17 or any version of SBCL, there
292 ;; seems to be no reason to persist in this. -- WHN 19990917
295 (def!method print-object ((des descriptor) stream)
296 (let ((lowtag (descriptor-lowtag des)))
297 (print-unreadable-object (des stream :type t)
298 (cond ((or (= lowtag sb!vm:even-fixnum-lowtag)
299 (= lowtag sb!vm:odd-fixnum-lowtag))
300 (let ((unsigned (logior (ash (descriptor-high des)
301 (1+ (- descriptor-low-bits
302 sb!vm:n-lowtag-bits)))
303 (ash (descriptor-low des)
304 (- 1 sb!vm:n-lowtag-bits)))))
307 (if (> unsigned #x1FFFFFFF)
308 (- unsigned #x40000000)
310 ((or (= lowtag sb!vm:other-immediate-0-lowtag)
311 (= lowtag sb!vm:other-immediate-1-lowtag)
312 #!+#.(cl:if (cl:= 64 sb!vm:n-word-bits) '(and) '(or))
313 (= lowtag sb!vm:other-immediate-2-lowtag)
314 #!+#.(cl:if (cl:= 64 sb!vm:n-word-bits) '(and) '(or))
315 (= lowtag sb!vm:other-immediate-3-lowtag))
317 "for other immediate: #X~X, type #b~8,'0B"
318 (ash (descriptor-bits des) (- sb!vm:n-widetag-bits))
319 (logand (descriptor-low des) sb!vm:widetag-mask)))
322 "for pointer: #X~X, lowtag #b~3,'0B, ~A"
323 (logior (ash (descriptor-high des) descriptor-low-bits)
324 (logandc2 (descriptor-low des) sb!vm:lowtag-mask))
326 (let ((gspace (descriptor-gspace des)))
331 ;;; Return a descriptor for a block of LENGTH bytes out of GSPACE. The
332 ;;; free word index is boosted as necessary, and if additional memory
333 ;;; is needed, we grow the GSPACE. The descriptor returned is a
334 ;;; pointer of type LOWTAG.
335 (defun allocate-cold-descriptor (gspace length lowtag)
336 (let* ((bytes (round-up length (ash 1 sb!vm:n-lowtag-bits)))
337 (old-free-word-index (gspace-free-word-index gspace))
338 (new-free-word-index (+ old-free-word-index
339 (ash bytes (- sb!vm:word-shift)))))
340 ;; Grow GSPACE as necessary until it's big enough to handle
341 ;; NEW-FREE-WORD-INDEX.
343 ((>= (bvlength (gspace-bytes gspace))
344 (* new-free-word-index sb!vm:n-word-bytes)))
345 (expand-bigvec (gspace-bytes gspace)))
346 ;; Now that GSPACE is big enough, we can meaningfully grab a chunk of it.
347 (setf (gspace-free-word-index gspace) new-free-word-index)
348 (let ((ptr (+ (gspace-word-address gspace) old-free-word-index)))
349 (make-descriptor (ash ptr (- sb!vm:word-shift descriptor-low-bits))
350 (logior (ash (logand ptr
352 (- descriptor-low-bits
357 old-free-word-index))))
359 (defun descriptor-lowtag (des)
361 "the lowtag bits for DES"
362 (logand (descriptor-low des) sb!vm:lowtag-mask))
364 (defun descriptor-bits (des)
365 (logior (ash (descriptor-high des) descriptor-low-bits)
366 (descriptor-low des)))
368 (defun descriptor-fixnum (des)
369 (let ((bits (descriptor-bits des)))
370 (if (logbitp (1- sb!vm:n-word-bits) bits)
371 ;; KLUDGE: The (- SB!VM:N-WORD-BITS 2) term here looks right to
372 ;; me, and it works, but in CMU CL it was (1- SB!VM:N-WORD-BITS),
373 ;; and although that doesn't make sense for me, or work for me,
374 ;; it's hard to see how it could have been wrong, since CMU CL
375 ;; genesis worked. It would be nice to understand how this came
376 ;; to be.. -- WHN 19990901
377 (logior (ash bits (- 1 sb!vm:n-lowtag-bits))
378 (ash -1 (1+ sb!vm:n-positive-fixnum-bits)))
379 (ash bits (- 1 sb!vm:n-lowtag-bits)))))
382 (defun descriptor-bytes (des)
383 (gspace-bytes (descriptor-intuit-gspace des)))
384 (defun descriptor-byte-offset (des)
385 (ash (descriptor-word-offset des) sb!vm:word-shift))
387 ;;; If DESCRIPTOR-GSPACE is already set, just return that. Otherwise,
388 ;;; figure out a GSPACE which corresponds to DES, set it into
389 ;;; (DESCRIPTOR-GSPACE DES), set a consistent value into
390 ;;; (DESCRIPTOR-WORD-OFFSET DES), and return the GSPACE.
391 (declaim (ftype (function (descriptor) gspace) descriptor-intuit-gspace))
392 (defun descriptor-intuit-gspace (des)
393 (if (descriptor-gspace des)
394 (descriptor-gspace des)
395 ;; KLUDGE: It's not completely clear to me what's going on here;
396 ;; this is a literal translation from of some rather mysterious
397 ;; code from CMU CL's DESCRIPTOR-SAP function. Some explanation
398 ;; would be nice. -- WHN 19990817
399 (let ((lowtag (descriptor-lowtag des))
400 (high (descriptor-high des))
401 (low (descriptor-low des)))
402 (if (or (eql lowtag sb!vm:fun-pointer-lowtag)
403 (eql lowtag sb!vm:instance-pointer-lowtag)
404 (eql lowtag sb!vm:list-pointer-lowtag)
405 (eql lowtag sb!vm:other-pointer-lowtag))
406 (dolist (gspace (list *dynamic* *static* *read-only*)
407 (error "couldn't find a GSPACE for ~S" des))
408 ;; This code relies on the fact that GSPACEs are aligned
409 ;; such that the descriptor-low-bits low bits are zero.
410 (when (and (>= high (ash (gspace-word-address gspace)
411 (- sb!vm:word-shift descriptor-low-bits)))
412 (<= high (ash (+ (gspace-word-address gspace)
413 (gspace-free-word-index gspace))
414 (- sb!vm:word-shift descriptor-low-bits))))
415 (setf (descriptor-gspace des) gspace)
416 (setf (descriptor-word-offset des)
417 (+ (ash (- high (ash (gspace-word-address gspace)
419 descriptor-low-bits)))
420 (- descriptor-low-bits sb!vm:word-shift))
421 (ash (logandc2 low sb!vm:lowtag-mask)
422 (- sb!vm:word-shift))))
424 (error "don't even know how to look for a GSPACE for ~S" des)))))
426 (defun make-random-descriptor (value)
427 (make-descriptor (logand (ash value (- descriptor-low-bits))
430 descriptor-low-bits))))
431 (logand value (1- (ash 1 descriptor-low-bits)))))
433 (defun make-fixnum-descriptor (num)
434 (when (>= (integer-length num)
435 (1+ (- sb!vm:n-word-bits sb!vm:n-lowtag-bits)))
436 (error "~W is too big for a fixnum." num))
437 (make-random-descriptor (ash num (1- sb!vm:n-lowtag-bits))))
439 (defun make-other-immediate-descriptor (data type)
440 (make-descriptor (ash data (- sb!vm:n-widetag-bits descriptor-low-bits))
441 (logior (logand (ash data (- descriptor-low-bits
442 sb!vm:n-widetag-bits))
443 (1- (ash 1 descriptor-low-bits)))
446 (defun make-character-descriptor (data)
447 (make-other-immediate-descriptor data sb!vm:character-widetag))
449 (defun descriptor-beyond (des offset type)
450 (let* ((low (logior (+ (logandc2 (descriptor-low des) sb!vm:lowtag-mask)
453 (high (+ (descriptor-high des)
454 (ash low (- descriptor-low-bits)))))
455 (make-descriptor high (logand low (1- (ash 1 descriptor-low-bits))))))
457 ;;;; miscellaneous variables and other noise
459 ;;; a numeric value to be returned for undefined foreign symbols, or NIL if
460 ;;; undefined foreign symbols are to be treated as an error.
461 ;;; (In the first pass of GENESIS, needed to create a header file before
462 ;;; the C runtime can be built, various foreign symbols will necessarily
463 ;;; be undefined, but we don't need actual values for them anyway, and
464 ;;; we can just use 0 or some other placeholder. In the second pass of
465 ;;; GENESIS, all foreign symbols should be defined, so any undefined
466 ;;; foreign symbol is a problem.)
468 ;;; KLUDGE: It would probably be cleaner to rewrite GENESIS so that it
469 ;;; never tries to look up foreign symbols in the first place unless
470 ;;; it's actually creating a core file (as in the second pass) instead
471 ;;; of using this hack to allow it to go through the motions without
472 ;;; causing an error. -- WHN 20000825
473 (defvar *foreign-symbol-placeholder-value*)
475 ;;; a handle on the trap object
476 (defvar *unbound-marker*)
477 ;; was: (make-other-immediate-descriptor 0 sb!vm:unbound-marker-widetag)
479 ;;; a handle on the NIL object
480 (defvar *nil-descriptor*)
482 ;;; the head of a list of TOPLEVEL-THINGs describing stuff to be done
483 ;;; when the target Lisp starts up
485 ;;; Each TOPLEVEL-THING can be a function to be executed or a fixup or
486 ;;; loadtime value, represented by (CONS KEYWORD ..). The FILENAME
487 ;;; tells which fasl file each list element came from, for debugging
489 (defvar *current-reversed-cold-toplevels*)
491 ;;; the name of the object file currently being cold loaded (as a string, not a
492 ;;; pathname), or NIL if we're not currently cold loading any object file
493 (defvar *cold-load-filename* nil)
494 (declaim (type (or string null) *cold-load-filename*))
496 ;;;; miscellaneous stuff to read and write the core memory
498 ;;; FIXME: should be DEFINE-MODIFY-MACRO
499 (defmacro cold-push (thing list)
501 "Push THING onto the given cold-load LIST."
502 `(setq ,list (cold-cons ,thing ,list)))
504 (declaim (ftype (function (descriptor sb!vm:word) descriptor) read-wordindexed))
505 (defun read-wordindexed (address index)
507 "Return the value which is displaced by INDEX words from ADDRESS."
508 (let* ((gspace (descriptor-intuit-gspace address))
509 (bytes (gspace-bytes gspace))
510 (byte-index (ash (+ index (descriptor-word-offset address))
512 (value (bvref-word bytes byte-index)))
513 (make-random-descriptor value)))
515 (declaim (ftype (function (descriptor) descriptor) read-memory))
516 (defun read-memory (address)
518 "Return the value at ADDRESS."
519 (read-wordindexed address 0))
521 ;;; (Note: In CMU CL, this function expected a SAP-typed ADDRESS
522 ;;; value, instead of the SAP-INT we use here.)
523 (declaim (ftype (function (sb!vm:word descriptor) (values))
524 note-load-time-value-reference))
525 (defun note-load-time-value-reference (address marker)
526 (cold-push (cold-cons
527 (cold-intern :load-time-value-fixup)
528 (cold-cons (sap-int-to-core address)
530 (number-to-core (descriptor-word-offset marker))
532 *current-reversed-cold-toplevels*)
535 (declaim (ftype (function (descriptor sb!vm:word descriptor)) write-wordindexed))
536 (defun write-wordindexed (address index value)
538 "Write VALUE displaced INDEX words from ADDRESS."
539 ;; KLUDGE: There is an algorithm (used in DESCRIPTOR-INTUIT-GSPACE)
540 ;; for calculating the value of the GSPACE slot from scratch. It
541 ;; doesn't work for all values, only some of them, but mightn't it
542 ;; be reasonable to see whether it works on VALUE before we give up
543 ;; because (DESCRIPTOR-GSPACE VALUE) isn't set? (Or failing that,
544 ;; perhaps write a comment somewhere explaining why it's not a good
545 ;; idea?) -- WHN 19990817
546 (if (and (null (descriptor-gspace value))
547 (not (null (descriptor-word-offset value))))
548 (note-load-time-value-reference (+ (logandc2 (descriptor-bits address)
550 (ash index sb!vm:word-shift))
552 (let* ((bytes (gspace-bytes (descriptor-intuit-gspace address)))
553 (byte-index (ash (+ index (descriptor-word-offset address))
555 (setf (bvref-word bytes byte-index)
556 (descriptor-bits value)))))
558 (declaim (ftype (function (descriptor descriptor)) write-memory))
559 (defun write-memory (address value)
561 "Write VALUE (a DESCRIPTOR) at ADDRESS (also a DESCRIPTOR)."
562 (write-wordindexed address 0 value))
564 ;;;; allocating images of primitive objects in the cold core
566 ;;; There are three kinds of blocks of memory in the type system:
567 ;;; * Boxed objects (cons cells, structures, etc): These objects have no
568 ;;; header as all slots are descriptors.
569 ;;; * Unboxed objects (bignums): There is a single header word that contains
571 ;;; * Vector objects: There is a header word with the type, then a word for
572 ;;; the length, then the data.
573 (defun allocate-boxed-object (gspace length lowtag)
575 "Allocate LENGTH words in GSPACE and return a new descriptor of type LOWTAG
577 (allocate-cold-descriptor gspace (ash length sb!vm:word-shift) lowtag))
578 (defun allocate-unboxed-object (gspace element-bits length type)
580 "Allocate LENGTH units of ELEMENT-BITS bits plus a header word in GSPACE and
581 return an ``other-pointer'' descriptor to them. Initialize the header word
582 with the resultant length and TYPE."
583 (let* ((bytes (/ (* element-bits length) sb!vm:n-byte-bits))
584 (des (allocate-cold-descriptor gspace
585 (+ bytes sb!vm:n-word-bytes)
586 sb!vm:other-pointer-lowtag)))
588 (make-other-immediate-descriptor (ash bytes
589 (- sb!vm:word-shift))
592 (defun allocate-vector-object (gspace element-bits length type)
594 "Allocate LENGTH units of ELEMENT-BITS size plus a header plus a length slot in
595 GSPACE and return an ``other-pointer'' descriptor to them. Initialize the
596 header word with TYPE and the length slot with LENGTH."
597 ;; FIXME: Here and in ALLOCATE-UNBOXED-OBJECT, BYTES is calculated using
598 ;; #'/ instead of #'CEILING, which seems wrong.
599 (let* ((bytes (/ (* element-bits length) sb!vm:n-byte-bits))
600 (des (allocate-cold-descriptor gspace
601 (+ bytes (* 2 sb!vm:n-word-bytes))
602 sb!vm:other-pointer-lowtag)))
603 (write-memory des (make-other-immediate-descriptor 0 type))
604 (write-wordindexed des
605 sb!vm:vector-length-slot
606 (make-fixnum-descriptor length))
609 ;;;; copying simple objects into the cold core
611 (defun base-string-to-core (string &optional (gspace *dynamic*))
613 "Copy STRING (which must only contain STANDARD-CHARs) into the cold
614 core and return a descriptor to it."
615 ;; (Remember that the system convention for storage of strings leaves an
616 ;; extra null byte at the end to aid in call-out to C.)
617 (let* ((length (length string))
618 (des (allocate-vector-object gspace
621 sb!vm:simple-base-string-widetag))
622 (bytes (gspace-bytes gspace))
623 (offset (+ (* sb!vm:vector-data-offset sb!vm:n-word-bytes)
624 (descriptor-byte-offset des))))
625 (write-wordindexed des
626 sb!vm:vector-length-slot
627 (make-fixnum-descriptor length))
629 (setf (bvref bytes (+ offset i))
630 (sb!xc:char-code (aref string i))))
631 (setf (bvref bytes (+ offset length))
632 0) ; null string-termination character for C
635 (defun bignum-to-core (n)
637 "Copy a bignum to the cold core."
638 (let* ((words (ceiling (1+ (integer-length n)) sb!vm:n-word-bits))
639 (handle (allocate-unboxed-object *dynamic*
642 sb!vm:bignum-widetag)))
643 (declare (fixnum words))
644 (do ((index 1 (1+ index))
645 (remainder n (ash remainder (- sb!vm:n-word-bits))))
647 (unless (zerop (integer-length remainder))
648 ;; FIXME: Shouldn't this be a fatal error?
649 (warn "~W words of ~W were written, but ~W bits were left over."
651 (let ((word (ldb (byte sb!vm:n-word-bits 0) remainder)))
652 (write-wordindexed handle index
653 (make-descriptor (ash word (- descriptor-low-bits))
654 (ldb (byte descriptor-low-bits 0)
658 (defun number-pair-to-core (first second type)
660 "Makes a number pair of TYPE (ratio or complex) and fills it in."
661 (let ((des (allocate-unboxed-object *dynamic* sb!vm:n-word-bits 2 type)))
662 (write-wordindexed des 1 first)
663 (write-wordindexed des 2 second)
666 (defun write-double-float-bits (address index x)
667 (let ((hi (double-float-high-bits x))
668 (lo (double-float-low-bits x)))
669 (ecase sb!vm::n-word-bits
671 (let ((high-bits (make-random-descriptor hi))
672 (low-bits (make-random-descriptor lo)))
673 (ecase sb!c:*backend-byte-order*
675 (write-wordindexed address index low-bits)
676 (write-wordindexed address (1+ index) high-bits))
678 (write-wordindexed address index high-bits)
679 (write-wordindexed address (1+ index) low-bits)))))
681 (let ((bits (make-random-descriptor
682 (ecase sb!c:*backend-byte-order*
683 (:little-endian (logior lo (ash hi 32)))
685 #+nil (:big-endian (logior (logand hi #xffffffff)
687 (write-wordindexed address index bits))))
690 (defun float-to-core (x)
693 ;; 64-bit platforms have immediate single-floats.
694 #!+#.(cl:if (cl:= sb!vm:n-word-bits 64) '(and) '(or))
695 (make-random-descriptor (logior (ash (single-float-bits x) 32)
696 sb!vm::single-float-widetag))
697 #!-#.(cl:if (cl:= sb!vm:n-word-bits 64) '(and) '(or))
698 (let ((des (allocate-unboxed-object *dynamic*
700 (1- sb!vm:single-float-size)
701 sb!vm:single-float-widetag)))
702 (write-wordindexed des
703 sb!vm:single-float-value-slot
704 (make-random-descriptor (single-float-bits x)))
707 (let ((des (allocate-unboxed-object *dynamic*
709 (1- sb!vm:double-float-size)
710 sb!vm:double-float-widetag)))
711 (write-double-float-bits des sb!vm:double-float-value-slot x)))))
713 (defun complex-single-float-to-core (num)
714 (declare (type (complex single-float) num))
715 (let ((des (allocate-unboxed-object *dynamic* sb!vm:n-word-bits
716 (1- sb!vm:complex-single-float-size)
717 sb!vm:complex-single-float-widetag)))
718 (write-wordindexed des sb!vm:complex-single-float-real-slot
719 (make-random-descriptor (single-float-bits (realpart num))))
720 (write-wordindexed des sb!vm:complex-single-float-imag-slot
721 (make-random-descriptor (single-float-bits (imagpart num))))
724 (defun complex-double-float-to-core (num)
725 (declare (type (complex double-float) num))
726 (let ((des (allocate-unboxed-object *dynamic* sb!vm:n-word-bits
727 (1- sb!vm:complex-double-float-size)
728 sb!vm:complex-double-float-widetag)))
729 (write-double-float-bits des sb!vm:complex-double-float-real-slot
731 (write-double-float-bits des sb!vm:complex-double-float-imag-slot
734 ;;; Copy the given number to the core.
735 (defun number-to-core (number)
737 (integer (if (< (integer-length number)
738 (- (1+ sb!vm:n-word-bits) sb!vm:n-lowtag-bits))
739 (make-fixnum-descriptor number)
740 (bignum-to-core number)))
741 (ratio (number-pair-to-core (number-to-core (numerator number))
742 (number-to-core (denominator number))
743 sb!vm:ratio-widetag))
744 ((complex single-float) (complex-single-float-to-core number))
745 ((complex double-float) (complex-double-float-to-core number))
747 ((complex long-float)
748 (error "~S isn't a cold-loadable number at all!" number))
749 (complex (number-pair-to-core (number-to-core (realpart number))
750 (number-to-core (imagpart number))
751 sb!vm:complex-widetag))
752 (float (float-to-core number))
753 (t (error "~S isn't a cold-loadable number at all!" number))))
755 (declaim (ftype (function (sb!vm:word) descriptor) sap-int-to-core))
756 (defun sap-int-to-core (sap-int)
757 (let ((des (allocate-unboxed-object *dynamic*
761 (write-wordindexed des
762 sb!vm:sap-pointer-slot
763 (make-random-descriptor sap-int))
766 ;;; Allocate a cons cell in GSPACE and fill it in with CAR and CDR.
767 (defun cold-cons (car cdr &optional (gspace *dynamic*))
768 (let ((dest (allocate-boxed-object gspace 2 sb!vm:list-pointer-lowtag)))
769 (write-memory dest car)
770 (write-wordindexed dest 1 cdr)
773 ;;; Make a simple-vector on the target that holds the specified
774 ;;; OBJECTS, and return its descriptor.
775 (defun vector-in-core (&rest objects)
776 (let* ((size (length objects))
777 (result (allocate-vector-object *dynamic* sb!vm:n-word-bits size
778 sb!vm:simple-vector-widetag)))
779 (dotimes (index size)
780 (write-wordindexed result (+ index sb!vm:vector-data-offset)
786 ;;; FIXME: This should be a &KEY argument of ALLOCATE-SYMBOL.
787 (defvar *cold-symbol-allocation-gspace* nil)
789 ;;; Allocate (and initialize) a symbol.
790 (defun allocate-symbol (name)
791 (declare (simple-string name))
792 (let ((symbol (allocate-unboxed-object (or *cold-symbol-allocation-gspace*
795 (1- sb!vm:symbol-size)
796 sb!vm:symbol-header-widetag)))
797 (write-wordindexed symbol sb!vm:symbol-value-slot *unbound-marker*)
798 (write-wordindexed symbol
799 sb!vm:symbol-hash-slot
800 (make-fixnum-descriptor 0))
801 (write-wordindexed symbol sb!vm:symbol-plist-slot *nil-descriptor*)
802 (write-wordindexed symbol sb!vm:symbol-name-slot
803 (base-string-to-core name *dynamic*))
804 (write-wordindexed symbol sb!vm:symbol-package-slot *nil-descriptor*)
807 ;;; Set the cold symbol value of SYMBOL-OR-SYMBOL-DES, which can be either a
808 ;;; descriptor of a cold symbol or (in an abbreviation for the
809 ;;; most common usage pattern) an ordinary symbol, which will be
810 ;;; automatically cold-interned.
811 (declaim (ftype (function ((or descriptor symbol) descriptor)) cold-set))
812 (defun cold-set (symbol-or-symbol-des value)
813 (let ((symbol-des (etypecase symbol-or-symbol-des
814 (descriptor symbol-or-symbol-des)
815 (symbol (cold-intern symbol-or-symbol-des)))))
816 (write-wordindexed symbol-des sb!vm:symbol-value-slot value)))
818 ;;;; layouts and type system pre-initialization
820 ;;; Since we want to be able to dump structure constants and
821 ;;; predicates with reference layouts, we need to create layouts at
822 ;;; cold-load time. We use the name to intern layouts by, and dump a
823 ;;; list of all cold layouts in *!INITIAL-LAYOUTS* so that type system
824 ;;; initialization can find them. The only thing that's tricky [sic --
825 ;;; WHN 19990816] is initializing layout's layout, which must point to
828 ;;; a map from class names to lists of
829 ;;; `(,descriptor ,name ,length ,inherits ,depth)
830 ;;; KLUDGE: It would be more understandable and maintainable to use
831 ;;; DEFSTRUCT (:TYPE LIST) here. -- WHN 19990823
832 (defvar *cold-layouts* (make-hash-table :test 'equal))
834 ;;; a map from DESCRIPTOR-BITS of cold layouts to the name, for inverting
836 (defvar *cold-layout-names* (make-hash-table :test 'eql))
838 ;;; FIXME: *COLD-LAYOUTS* and *COLD-LAYOUT-NAMES* should be
839 ;;; initialized by binding in GENESIS.
841 ;;; the descriptor for layout's layout (needed when making layouts)
842 (defvar *layout-layout*)
844 ;;; FIXME: This information should probably be pulled out of the
845 ;;; cross-compiler's tables at genesis time instead of inserted by
846 ;;; hand here as a bare numeric constant.
847 (defconstant target-layout-length 16)
849 ;;; Return a list of names created from the cold layout INHERITS data
851 (defun listify-cold-inherits (x)
852 (let ((len (descriptor-fixnum (read-wordindexed x
853 sb!vm:vector-length-slot))))
856 (let* ((des (read-wordindexed x (+ sb!vm:vector-data-offset index)))
857 (found (gethash (descriptor-bits des) *cold-layout-names*)))
860 (error "unknown descriptor at index ~S (bits = ~8,'0X)"
862 (descriptor-bits des)))))
865 (declaim (ftype (function (symbol descriptor descriptor descriptor) descriptor)
867 (defun make-cold-layout (name length inherits depthoid)
868 (let ((result (allocate-boxed-object *dynamic*
869 ;; KLUDGE: Why 1+? -- WHN 19990901
870 (1+ target-layout-length)
871 sb!vm:instance-pointer-lowtag)))
873 (make-other-immediate-descriptor
874 target-layout-length sb!vm:instance-header-widetag))
876 ;; KLUDGE: The offsets into LAYOUT below should probably be pulled out
877 ;; of the cross-compiler's tables at genesis time instead of inserted
878 ;; by hand as bare numeric constants. -- WHN ca. 19990901
880 ;; Set slot 0 = the layout of the layout.
881 (write-wordindexed result sb!vm:instance-slots-offset *layout-layout*)
883 ;; Set the immediately following slots = CLOS hash values.
885 ;; Note: CMU CL didn't set these in genesis, but instead arranged
886 ;; for them to be set at cold init time. That resulted in slightly
887 ;; kludgy-looking code, but there were at least two things to be
889 ;; 1. It put the hash values under the control of the target Lisp's
890 ;; RANDOM function, so that CLOS behavior would be nearly
891 ;; deterministic (instead of depending on the implementation of
892 ;; RANDOM in the cross-compilation host, and the state of its
893 ;; RNG when genesis begins).
894 ;; 2. It automatically ensured that all hash values in the target Lisp
895 ;; were part of the same sequence, so that we didn't have to worry
896 ;; about the possibility of the first hash value set in genesis
897 ;; being precisely equal to the some hash value set in cold init time
898 ;; (because the target Lisp RNG has advanced to precisely the same
899 ;; state that the host Lisp RNG was in earlier).
900 ;; Point 1 should not be an issue in practice because of the way we do our
901 ;; build procedure in two steps, so that the SBCL that we end up with has
902 ;; been created by another SBCL (whose RNG is under our control).
903 ;; Point 2 is more of an issue. If ANSI had provided a way to feed
904 ;; entropy into an RNG, we would have no problem: we'd just feed
905 ;; some specialized genesis-time-only pattern into the RNG state
906 ;; before using it. However, they didn't, so we have a slight
907 ;; problem. We address it by generating the hash values using a
908 ;; different algorithm than we use in ordinary operation.
909 (dotimes (i sb!kernel:layout-clos-hash-length)
910 (let (;; The expression here is pretty arbitrary, we just want
911 ;; to make sure that it's not something which is (1)
912 ;; evenly distributed and (2) not foreordained to arise in
913 ;; the target Lisp's (RANDOM-LAYOUT-CLOS-HASH) sequence
914 ;; and show up as the CLOS-HASH value of some other
917 ;; FIXME: This expression here can generate a zero value,
918 ;; and the CMU CL code goes out of its way to generate
919 ;; strictly positive values (even though the field is
920 ;; declared as an INDEX). Check that it's really OK to
921 ;; have zero values in the CLOS-HASH slots.
922 (hash-value (mod (logxor (logand (random-layout-clos-hash) 15253)
923 (logandc2 (random-layout-clos-hash) 15253)
925 ;; (The MOD here is defensive programming
926 ;; to make sure we never write an
927 ;; out-of-range value even if some joker
928 ;; sets LAYOUT-CLOS-HASH-MAX to other
929 ;; than 2^n-1 at some time in the
931 (1+ sb!kernel:layout-clos-hash-max))))
932 (write-wordindexed result
933 (+ i sb!vm:instance-slots-offset 1)
934 (make-fixnum-descriptor hash-value))))
936 ;; Set other slot values.
937 (let ((base (+ sb!vm:instance-slots-offset
938 sb!kernel:layout-clos-hash-length
940 ;; (Offset 0 is CLASS, "the class this is a layout for", which
941 ;; is uninitialized at this point.)
942 (write-wordindexed result (+ base 1) *nil-descriptor*) ; marked invalid
943 (write-wordindexed result (+ base 2) inherits)
944 (write-wordindexed result (+ base 3) depthoid)
945 (write-wordindexed result (+ base 4) length)
946 (write-wordindexed result (+ base 5) *nil-descriptor*) ; info
947 (write-wordindexed result (+ base 6) *nil-descriptor*)) ; pure
949 (setf (gethash name *cold-layouts*)
952 (descriptor-fixnum length)
953 (listify-cold-inherits inherits)
954 (descriptor-fixnum depthoid)))
955 (setf (gethash (descriptor-bits result) *cold-layout-names*) name)
959 (defun initialize-layouts ()
961 (clrhash *cold-layouts*)
963 ;; We initially create the layout of LAYOUT itself with NIL as the LAYOUT and
965 (setq *layout-layout* *nil-descriptor*)
966 (setq *layout-layout*
967 (make-cold-layout 'layout
968 (number-to-core target-layout-length)
970 ;; FIXME: hard-coded LAYOUT-DEPTHOID of LAYOUT..
972 (write-wordindexed *layout-layout*
973 sb!vm:instance-slots-offset
976 ;; Then we create the layouts that we'll need to make a correct INHERITS
977 ;; vector for the layout of LAYOUT itself..
979 ;; FIXME: The various LENGTH and DEPTHOID numbers should be taken from
980 ;; the compiler's tables, not set by hand.
987 (make-cold-layout 'instance
989 (vector-in-core t-layout)
992 (make-cold-layout 'structure-object
994 (vector-in-core t-layout i-layout)
997 (make-cold-layout 'structure!object
999 (vector-in-core t-layout i-layout so-layout)
1000 (number-to-core 3)))
1001 (layout-inherits (vector-in-core t-layout
1006 ;; ..and return to backpatch the layout of LAYOUT.
1007 (setf (fourth (gethash 'layout *cold-layouts*))
1008 (listify-cold-inherits layout-inherits))
1009 (write-wordindexed *layout-layout*
1010 ;; FIXME: hardcoded offset into layout struct
1011 (+ sb!vm:instance-slots-offset
1012 layout-clos-hash-length
1017 ;;;; interning symbols in the cold image
1019 ;;; In order to avoid having to know about the package format, we
1020 ;;; build a data structure in *COLD-PACKAGE-SYMBOLS* that holds all
1021 ;;; interned symbols along with info about their packages. The data
1022 ;;; structure is a list of sublists, where the sublists have the
1023 ;;; following format:
1024 ;;; (<make-package-arglist>
1025 ;;; <internal-symbols>
1026 ;;; <external-symbols>
1027 ;;; <imported-internal-symbols>
1028 ;;; <imported-external-symbols>
1029 ;;; <shadowing-symbols>
1030 ;;; <package-documentation>)
1032 ;;; KLUDGE: It would be nice to implement the sublists as instances of
1033 ;;; a DEFSTRUCT (:TYPE LIST). (They'd still be lists, but at least we'd be
1034 ;;; using mnemonically-named operators to access them, instead of trying
1035 ;;; to remember what THIRD and FIFTH mean, and hoping that we never
1036 ;;; need to change the list layout..) -- WHN 19990825
1038 ;;; an alist from packages to lists of that package's symbols to be dumped
1039 (defvar *cold-package-symbols*)
1040 (declaim (type list *cold-package-symbols*))
1042 ;;; a map from descriptors to symbols, so that we can back up. The key
1043 ;;; is the address in the target core.
1044 (defvar *cold-symbols*)
1045 (declaim (type hash-table *cold-symbols*))
1047 ;;; sanity check for a symbol we're about to create on the target
1049 ;;; Make sure that the symbol has an appropriate package. In
1050 ;;; particular, catch the so-easy-to-make error of typing something
1051 ;;; like SB-KERNEL:%BYTE-BLT in cold sources when what you really
1052 ;;; need is SB!KERNEL:%BYTE-BLT.
1053 (defun package-ok-for-target-symbol-p (package)
1054 (let ((package-name (package-name package)))
1056 ;; Cold interning things in these standard packages is OK. (Cold
1057 ;; interning things in the other standard package, CL-USER, isn't
1058 ;; OK. We just use CL-USER to expose symbols whose homes are in
1059 ;; other packages. Thus, trying to cold intern a symbol whose
1060 ;; home package is CL-USER probably means that a coding error has
1061 ;; been made somewhere.)
1062 (find package-name '("COMMON-LISP" "KEYWORD") :test #'string=)
1063 ;; Cold interning something in one of our target-code packages,
1064 ;; which are ever-so-rigorously-and-elegantly distinguished by
1065 ;; this prefix on their names, is OK too.
1066 (string= package-name "SB!" :end1 3 :end2 3)
1067 ;; This one is OK too, since it ends up being COMMON-LISP on the
1069 (string= package-name "SB-XC")
1070 ;; Anything else looks bad. (maybe COMMON-LISP-USER? maybe an extension
1071 ;; package in the xc host? something we can't think of
1072 ;; a valid reason to cold intern, anyway...)
1075 ;;; like SYMBOL-PACKAGE, but safe for symbols which end up on the target
1077 ;;; Most host symbols we dump onto the target are created by SBCL
1078 ;;; itself, so that as long as we avoid gratuitously
1079 ;;; cross-compilation-unfriendly hacks, it just happens that their
1080 ;;; SYMBOL-PACKAGE in the host system corresponds to their
1081 ;;; SYMBOL-PACKAGE in the target system. However, that's not the case
1082 ;;; in the COMMON-LISP package, where we don't get to create the
1083 ;;; symbols but instead have to use the ones that the xc host created.
1084 ;;; In particular, while ANSI specifies which symbols are exported
1085 ;;; from COMMON-LISP, it doesn't specify that their home packages are
1086 ;;; COMMON-LISP, so the xc host can keep them in random packages which
1087 ;;; don't exist on the target (e.g. CLISP keeping some CL-exported
1088 ;;; symbols in the CLOS package).
1089 (defun symbol-package-for-target-symbol (symbol)
1090 ;; We want to catch weird symbols like CLISP's
1091 ;; CL:FIND-METHOD=CLOS::FIND-METHOD, but we don't want to get
1092 ;; sidetracked by ordinary symbols like :CHARACTER which happen to
1093 ;; have the same SYMBOL-NAME as exports from COMMON-LISP.
1094 (multiple-value-bind (cl-symbol cl-status)
1095 (find-symbol (symbol-name symbol) *cl-package*)
1096 (if (and (eq symbol cl-symbol)
1097 (eq cl-status :external))
1098 ;; special case, to work around possible xc host weirdness
1099 ;; in COMMON-LISP package
1102 (let ((result (symbol-package symbol)))
1103 (aver (package-ok-for-target-symbol-p result))
1106 ;;; Return a handle on an interned symbol. If necessary allocate the
1107 ;;; symbol and record which package the symbol was referenced in. When
1108 ;;; we allocate the symbol, make sure we record a reference to the
1109 ;;; symbol in the home package so that the package gets set.
1110 (defun cold-intern (symbol
1112 (package (symbol-package-for-target-symbol symbol)))
1114 (aver (package-ok-for-target-symbol-p package))
1116 ;; Anything on the cross-compilation host which refers to the target
1117 ;; machinery through the host SB-XC package should be translated to
1118 ;; something on the target which refers to the same machinery
1119 ;; through the target COMMON-LISP package.
1120 (let ((p (find-package "SB-XC")))
1121 (when (eq package p)
1122 (setf package *cl-package*))
1123 (when (eq (symbol-package symbol) p)
1124 (setf symbol (intern (symbol-name symbol) *cl-package*))))
1126 (let (;; Information about each cold-interned symbol is stored
1127 ;; in COLD-INTERN-INFO.
1128 ;; (CAR COLD-INTERN-INFO) = descriptor of symbol
1129 ;; (CDR COLD-INTERN-INFO) = list of packages, other than symbol's
1130 ;; own package, referring to symbol
1131 ;; (*COLD-PACKAGE-SYMBOLS* and *COLD-SYMBOLS* store basically the
1132 ;; same information, but with the mapping running the opposite way.)
1133 (cold-intern-info (get symbol 'cold-intern-info)))
1134 (unless cold-intern-info
1135 (cond ((eq (symbol-package-for-target-symbol symbol) package)
1136 (let ((handle (allocate-symbol (symbol-name symbol))))
1137 (setf (gethash (descriptor-bits handle) *cold-symbols*) symbol)
1138 (when (eq package *keyword-package*)
1139 (cold-set handle handle))
1140 (setq cold-intern-info
1141 (setf (get symbol 'cold-intern-info) (cons handle nil)))))
1143 (cold-intern symbol)
1144 (setq cold-intern-info (get symbol 'cold-intern-info)))))
1145 (unless (or (null package)
1146 (member package (cdr cold-intern-info)))
1147 (push package (cdr cold-intern-info))
1148 (let* ((old-cps-entry (assoc package *cold-package-symbols*))
1149 (cps-entry (or old-cps-entry
1150 (car (push (list package)
1151 *cold-package-symbols*)))))
1152 (unless old-cps-entry
1153 (/show "created *COLD-PACKAGE-SYMBOLS* entry for" package symbol))
1154 (push symbol (rest cps-entry))))
1155 (car cold-intern-info)))
1157 ;;; Construct and return a value for use as *NIL-DESCRIPTOR*.
1158 (defun make-nil-descriptor ()
1159 (let* ((des (allocate-unboxed-object
1164 (result (make-descriptor (descriptor-high des)
1165 (+ (descriptor-low des)
1166 (* 2 sb!vm:n-word-bytes)
1167 (- sb!vm:list-pointer-lowtag
1168 sb!vm:other-pointer-lowtag)))))
1169 (write-wordindexed des
1171 (make-other-immediate-descriptor
1173 sb!vm:symbol-header-widetag))
1174 (write-wordindexed des
1175 (+ 1 sb!vm:symbol-value-slot)
1177 (write-wordindexed des
1178 (+ 2 sb!vm:symbol-value-slot)
1180 (write-wordindexed des
1181 (+ 1 sb!vm:symbol-plist-slot)
1183 (write-wordindexed des
1184 (+ 1 sb!vm:symbol-name-slot)
1185 ;; This is *DYNAMIC*, and DES is *STATIC*,
1186 ;; because that's the way CMU CL did it; I'm
1187 ;; not sure whether there's an underlying
1188 ;; reason. -- WHN 1990826
1189 (base-string-to-core "NIL" *dynamic*))
1190 (write-wordindexed des
1191 (+ 1 sb!vm:symbol-package-slot)
1193 (setf (get nil 'cold-intern-info)
1198 ;;; Since the initial symbols must be allocated before we can intern
1199 ;;; anything else, we intern those here. We also set the value of T.
1200 (defun initialize-non-nil-symbols ()
1202 "Initialize the cold load symbol-hacking data structures."
1203 (let ((*cold-symbol-allocation-gspace* *static*))
1204 ;; Intern the others.
1205 (dolist (symbol sb!vm:*static-symbols*)
1206 (let* ((des (cold-intern symbol))
1207 (offset-wanted (sb!vm:static-symbol-offset symbol))
1208 (offset-found (- (descriptor-low des)
1209 (descriptor-low *nil-descriptor*))))
1210 (unless (= offset-wanted offset-found)
1211 ;; FIXME: should be fatal
1212 (warn "Offset from ~S to ~S is ~W, not ~W"
1217 ;; Establish the value of T.
1218 (let ((t-symbol (cold-intern t)))
1219 (cold-set t-symbol t-symbol))))
1221 ;;; a helper function for FINISH-SYMBOLS: Return a cold alist suitable
1222 ;;; to be stored in *!INITIAL-LAYOUTS*.
1223 (defun cold-list-all-layouts ()
1224 (let ((result *nil-descriptor*))
1225 (maphash (lambda (key stuff)
1226 (cold-push (cold-cons (cold-intern key)
1232 ;;; Establish initial values for magic symbols.
1234 ;;; Scan over all the symbols referenced in each package in
1235 ;;; *COLD-PACKAGE-SYMBOLS* making that for each one there's an
1236 ;;; appropriate entry in the *!INITIAL-SYMBOLS* data structure to
1238 (defun finish-symbols ()
1240 ;; I think the point of setting these functions into SYMBOL-VALUEs
1241 ;; here, instead of using SYMBOL-FUNCTION, is that in CMU CL
1242 ;; SYMBOL-FUNCTION reduces to FDEFINITION, which is a pretty
1243 ;; hairy operation (involving globaldb.lisp etc.) which we don't
1244 ;; want to invoke early in cold init. -- WHN 2001-12-05
1246 ;; FIXME: So OK, that's a reasonable reason to do something weird like
1247 ;; this, but this is still a weird thing to do, and we should change
1248 ;; the names to highlight that something weird is going on. Perhaps
1249 ;; *MAYBE-GC-FUN*, *INTERNAL-ERROR-FUN*, *HANDLE-BREAKPOINT-FUN*,
1250 ;; and *HANDLE-FUN-END-BREAKPOINT-FUN*...
1251 (macrolet ((frob (symbol)
1253 (cold-fdefinition-object (cold-intern ',symbol)))))
1255 (frob internal-error)
1256 (frob sb!kernel::control-stack-exhausted-error)
1257 (frob sb!kernel::undefined-alien-variable-error)
1258 (frob sb!kernel::undefined-alien-function-error)
1259 (frob sb!kernel::memory-fault-error)
1260 (frob sb!di::handle-breakpoint)
1261 (frob sb!di::handle-fun-end-breakpoint)
1262 (frob sb!thread::handle-thread-exit))
1264 (cold-set 'sb!vm::*current-catch-block* (make-fixnum-descriptor 0))
1265 (cold-set 'sb!vm::*current-unwind-protect-block* (make-fixnum-descriptor 0))
1267 (cold-set '*free-interrupt-context-index* (make-fixnum-descriptor 0))
1269 (cold-set '*!initial-layouts* (cold-list-all-layouts))
1271 (/show "dumping packages" (mapcar #'car *cold-package-symbols*))
1272 (let ((initial-symbols *nil-descriptor*))
1273 (dolist (cold-package-symbols-entry *cold-package-symbols*)
1274 (let* ((cold-package (car cold-package-symbols-entry))
1275 (symbols (cdr cold-package-symbols-entry))
1276 (shadows (package-shadowing-symbols cold-package))
1277 (documentation (base-string-to-core (documentation cold-package t)))
1278 (internal *nil-descriptor*)
1279 (external *nil-descriptor*)
1280 (imported-internal *nil-descriptor*)
1281 (imported-external *nil-descriptor*)
1282 (shadowing *nil-descriptor*))
1283 (declare (type package cold-package)) ; i.e. not a target descriptor
1284 (/show "dumping" cold-package symbols)
1286 ;; FIXME: Add assertions here to make sure that inappropriate stuff
1287 ;; isn't being dumped:
1288 ;; * the CL-USER package
1289 ;; * the SB-COLD package
1290 ;; * any internal symbols in the CL package
1291 ;; * basically any package other than CL, KEYWORD, or the packages
1292 ;; in package-data-list.lisp-expr
1293 ;; and that the structure of the KEYWORD package (e.g. whether
1294 ;; any symbols are internal to it) matches what we want in the
1297 ;; FIXME: It seems possible that by looking at the contents of
1298 ;; packages in the target SBCL we could find which symbols in
1299 ;; package-data-lisp.lisp-expr are now obsolete. (If I
1300 ;; understand correctly, only symbols which actually have
1301 ;; definitions or which are otherwise referred to actually end
1302 ;; up in the target packages.)
1304 (dolist (symbol symbols)
1305 (let ((handle (car (get symbol 'cold-intern-info)))
1306 (imported-p (not (eq (symbol-package-for-target-symbol symbol)
1308 (multiple-value-bind (found where)
1309 (find-symbol (symbol-name symbol) cold-package)
1310 (unless (and where (eq found symbol))
1311 (error "The symbol ~S is not available in ~S."
1314 (when (memq symbol shadows)
1315 (cold-push handle shadowing))
1317 (:internal (if imported-p
1318 (cold-push handle imported-internal)
1319 (cold-push handle internal)))
1320 (:external (if imported-p
1321 (cold-push handle imported-external)
1322 (cold-push handle external)))))))
1323 (let ((r *nil-descriptor*))
1324 (cold-push documentation r)
1325 (cold-push shadowing r)
1326 (cold-push imported-external r)
1327 (cold-push imported-internal r)
1328 (cold-push external r)
1329 (cold-push internal r)
1330 (cold-push (make-make-package-args cold-package) r)
1331 ;; FIXME: It would be more space-efficient to use vectors
1332 ;; instead of lists here, and space-efficiency here would be
1333 ;; nice, since it would reduce the peak memory usage in
1334 ;; genesis and cold init.
1335 (cold-push r initial-symbols))))
1336 (cold-set '*!initial-symbols* initial-symbols))
1338 (cold-set '*!initial-fdefn-objects* (list-all-fdefn-objects))
1340 (cold-set '*!reversed-cold-toplevels* *current-reversed-cold-toplevels*)
1344 (cold-set 'sb!vm::*fp-constant-0d0* (number-to-core 0d0))
1345 (cold-set 'sb!vm::*fp-constant-1d0* (number-to-core 1d0))
1346 (cold-set 'sb!vm::*fp-constant-0f0* (number-to-core 0f0))
1347 (cold-set 'sb!vm::*fp-constant-1f0* (number-to-core 1f0))))
1349 ;;; Make a cold list that can be used as the arg list to MAKE-PACKAGE in order
1350 ;;; to make a package that is similar to PKG.
1351 (defun make-make-package-args (pkg)
1352 (let* ((use *nil-descriptor*)
1353 (cold-nicknames *nil-descriptor*)
1354 (res *nil-descriptor*))
1355 (dolist (u (package-use-list pkg))
1356 (when (assoc u *cold-package-symbols*)
1357 (cold-push (base-string-to-core (package-name u)) use)))
1358 (let* ((pkg-name (package-name pkg))
1359 ;; Make the package nickname lists for the standard packages
1360 ;; be the minimum specified by ANSI, regardless of what value
1361 ;; the cross-compilation host happens to use.
1362 (warm-nicknames (cond ((string= pkg-name "COMMON-LISP")
1364 ((string= pkg-name "COMMON-LISP-USER")
1366 ((string= pkg-name "KEYWORD")
1368 ;; For packages other than the
1369 ;; standard packages, the nickname
1370 ;; list was specified by our package
1371 ;; setup code, not by properties of
1372 ;; what cross-compilation host we
1373 ;; happened to use, and we can just
1374 ;; propagate it into the target.
1376 (package-nicknames pkg)))))
1377 (dolist (warm-nickname warm-nicknames)
1378 (cold-push (base-string-to-core warm-nickname) cold-nicknames)))
1380 (cold-push (number-to-core (truncate (package-internal-symbol-count pkg)
1383 (cold-push (cold-intern :internal-symbols) res)
1384 (cold-push (number-to-core (truncate (package-external-symbol-count pkg)
1387 (cold-push (cold-intern :external-symbols) res)
1389 (cold-push cold-nicknames res)
1390 (cold-push (cold-intern :nicknames) res)
1393 (cold-push (cold-intern :use) res)
1395 (cold-push (base-string-to-core (package-name pkg)) res)
1398 ;;;; functions and fdefinition objects
1400 ;;; a hash table mapping from fdefinition names to descriptors of cold
1403 ;;; Note: Since fdefinition names can be lists like '(SETF FOO), and
1404 ;;; we want to have only one entry per name, this must be an 'EQUAL
1405 ;;; hash table, not the default 'EQL.
1406 (defvar *cold-fdefn-objects*)
1408 (defvar *cold-fdefn-gspace* nil)
1410 ;;; Given a cold representation of a symbol, return a warm
1412 (defun warm-symbol (des)
1413 ;; Note that COLD-INTERN is responsible for keeping the
1414 ;; *COLD-SYMBOLS* table up to date, so if DES happens to refer to an
1415 ;; uninterned symbol, the code below will fail. But as long as we
1416 ;; don't need to look up uninterned symbols during bootstrapping,
1418 (multiple-value-bind (symbol found-p)
1419 (gethash (descriptor-bits des) *cold-symbols*)
1420 (declare (type symbol symbol))
1422 (error "no warm symbol"))
1425 ;;; like CL:CAR, CL:CDR, and CL:NULL but for cold values
1426 (defun cold-car (des)
1427 (aver (= (descriptor-lowtag des) sb!vm:list-pointer-lowtag))
1428 (read-wordindexed des sb!vm:cons-car-slot))
1429 (defun cold-cdr (des)
1430 (aver (= (descriptor-lowtag des) sb!vm:list-pointer-lowtag))
1431 (read-wordindexed des sb!vm:cons-cdr-slot))
1432 (defun cold-null (des)
1433 (= (descriptor-bits des)
1434 (descriptor-bits *nil-descriptor*)))
1436 ;;; Given a cold representation of a function name, return a warm
1438 (declaim (ftype (function (descriptor) (or symbol list)) warm-fun-name))
1439 (defun warm-fun-name (des)
1441 (ecase (descriptor-lowtag des)
1442 (#.sb!vm:list-pointer-lowtag
1443 (aver (not (cold-null des))) ; function named NIL? please no..
1444 ;; Do cold (DESTRUCTURING-BIND (COLD-CAR COLD-CADR) DES ..).
1445 (let* ((car-des (cold-car des))
1446 (cdr-des (cold-cdr des))
1447 (cadr-des (cold-car cdr-des))
1448 (cddr-des (cold-cdr cdr-des)))
1449 (aver (cold-null cddr-des))
1450 (list (warm-symbol car-des)
1451 (warm-symbol cadr-des))))
1452 (#.sb!vm:other-pointer-lowtag
1453 (warm-symbol des)))))
1454 (legal-fun-name-or-type-error result)
1457 (defun cold-fdefinition-object (cold-name &optional leave-fn-raw)
1458 (declare (type descriptor cold-name))
1459 (/show0 "/cold-fdefinition-object")
1460 (let ((warm-name (warm-fun-name cold-name)))
1461 (or (gethash warm-name *cold-fdefn-objects*)
1462 (let ((fdefn (allocate-boxed-object (or *cold-fdefn-gspace* *dynamic*)
1463 (1- sb!vm:fdefn-size)
1464 sb!vm:other-pointer-lowtag)))
1466 (setf (gethash warm-name *cold-fdefn-objects*) fdefn)
1467 (write-memory fdefn (make-other-immediate-descriptor
1468 (1- sb!vm:fdefn-size) sb!vm:fdefn-widetag))
1469 (write-wordindexed fdefn sb!vm:fdefn-name-slot cold-name)
1470 (unless leave-fn-raw
1471 (write-wordindexed fdefn sb!vm:fdefn-fun-slot
1473 (write-wordindexed fdefn
1474 sb!vm:fdefn-raw-addr-slot
1475 (make-random-descriptor
1476 (cold-foreign-symbol-address-as-integer
1477 (sb!vm:extern-alien-name "undefined_tramp")))))
1480 ;;; Handle the at-cold-init-time, fset-for-static-linkage operation
1481 ;;; requested by FOP-FSET.
1482 (defun static-fset (cold-name defn)
1483 (declare (type descriptor cold-name))
1484 (let ((fdefn (cold-fdefinition-object cold-name t))
1485 (type (logand (descriptor-low (read-memory defn)) sb!vm:widetag-mask)))
1486 (write-wordindexed fdefn sb!vm:fdefn-fun-slot defn)
1487 (write-wordindexed fdefn
1488 sb!vm:fdefn-raw-addr-slot
1490 (#.sb!vm:simple-fun-header-widetag
1491 (/show0 "static-fset (simple-fun)")
1495 (make-random-descriptor
1496 (+ (logandc2 (descriptor-bits defn)
1498 (ash sb!vm:simple-fun-code-offset
1499 sb!vm:word-shift))))
1500 (#.sb!vm:closure-header-widetag
1501 (/show0 "/static-fset (closure)")
1502 (make-random-descriptor
1503 (cold-foreign-symbol-address-as-integer
1504 (sb!vm:extern-alien-name "closure_tramp"))))))
1507 (defun initialize-static-fns ()
1508 (let ((*cold-fdefn-gspace* *static*))
1509 (dolist (sym sb!vm:*static-funs*)
1510 (let* ((fdefn (cold-fdefinition-object (cold-intern sym)))
1511 (offset (- (+ (- (descriptor-low fdefn)
1512 sb!vm:other-pointer-lowtag)
1513 (* sb!vm:fdefn-raw-addr-slot sb!vm:n-word-bytes))
1514 (descriptor-low *nil-descriptor*)))
1515 (desired (sb!vm:static-fun-offset sym)))
1516 (unless (= offset desired)
1517 ;; FIXME: should be fatal
1518 (error "Offset from FDEFN ~S to ~S is ~W, not ~W."
1519 sym nil offset desired))))))
1521 (defun list-all-fdefn-objects ()
1522 (let ((result *nil-descriptor*))
1523 (maphash (lambda (key value)
1524 (declare (ignore key))
1525 (cold-push value result))
1526 *cold-fdefn-objects*)
1529 ;;;; fixups and related stuff
1531 ;;; an EQUAL hash table
1532 (defvar *cold-foreign-symbol-table*)
1533 (declaim (type hash-table *cold-foreign-symbol-table*))
1535 ;; Read the sbcl.nm file to find the addresses for foreign-symbols in
1537 (defun load-cold-foreign-symbol-table (filename)
1538 (/show "load-cold-foreign-symbol-table" filename)
1539 (with-open-file (file filename)
1540 (loop for line = (read-line file nil nil)
1542 ;; UNIX symbol tables might have tabs in them, and tabs are
1543 ;; not in Common Lisp STANDARD-CHAR, so there seems to be no
1544 ;; nice portable way to deal with them within Lisp, alas.
1545 ;; Fortunately, it's easy to use UNIX command line tools like
1546 ;; sed to remove the problem, so it's not too painful for us
1547 ;; to push responsibility for converting tabs to spaces out to
1550 ;; Other non-STANDARD-CHARs are problematic for the same reason.
1551 ;; Make sure that there aren't any..
1552 (let ((ch (find-if (lambda (char)
1553 (not (typep char 'standard-char)))
1556 (error "non-STANDARD-CHAR ~S found in foreign symbol table:~%~S"
1559 (setf line (string-trim '(#\space) line))
1560 (let ((p1 (position #\space line :from-end nil))
1561 (p2 (position #\space line :from-end t)))
1562 (if (not (and p1 p2 (< p1 p2)))
1563 ;; KLUDGE: It's too messy to try to understand all
1564 ;; possible output from nm, so we just punt the lines we
1565 ;; don't recognize. We realize that there's some chance
1566 ;; that might get us in trouble someday, so we warn
1568 (warn "ignoring unrecognized line ~S in ~A" line filename)
1569 (multiple-value-bind (value name)
1570 (if (string= "0x" line :end2 2)
1571 (values (parse-integer line :start 2 :end p1 :radix 16)
1572 (subseq line (1+ p2)))
1573 (values (parse-integer line :end p1 :radix 16)
1574 (subseq line (1+ p2))))
1575 (multiple-value-bind (old-value found)
1576 (gethash name *cold-foreign-symbol-table*)
1578 (not (= old-value value)))
1579 (warn "redefining ~S from #X~X to #X~X"
1580 name old-value value)))
1581 (/show "adding to *cold-foreign-symbol-table*:" name value)
1582 (setf (gethash name *cold-foreign-symbol-table*) value))))))
1585 (defun cold-foreign-symbol-address-as-integer (name)
1586 (or (find-foreign-symbol-in-table name *cold-foreign-symbol-table*)
1587 *foreign-symbol-placeholder-value*
1589 (format *error-output* "~&The foreign symbol table is:~%")
1590 (maphash (lambda (k v)
1591 (format *error-output* "~&~S = #X~8X~%" k v))
1592 *cold-foreign-symbol-table*)
1593 (error "The foreign symbol ~S is undefined." name))))
1595 (defvar *cold-assembler-routines*)
1597 (defvar *cold-assembler-fixups*)
1599 (defun record-cold-assembler-routine (name address)
1600 (/xhow "in RECORD-COLD-ASSEMBLER-ROUTINE" name address)
1601 (push (cons name address)
1602 *cold-assembler-routines*))
1604 (defun record-cold-assembler-fixup (routine
1609 (push (list routine code-object offset kind)
1610 *cold-assembler-fixups*))
1612 (defun lookup-assembler-reference (symbol)
1613 (let ((value (cdr (assoc symbol *cold-assembler-routines*))))
1614 ;; FIXME: Should this be ERROR instead of WARN?
1616 (warn "Assembler routine ~S not defined." symbol))
1619 ;;; The x86 port needs to store code fixups along with code objects if
1620 ;;; they are to be moved, so fixups for code objects in the dynamic
1621 ;;; heap need to be noted.
1623 (defvar *load-time-code-fixups*)
1626 (defun note-load-time-code-fixup (code-object offset value kind)
1627 ;; If CODE-OBJECT might be moved
1628 (when (= (gspace-identifier (descriptor-intuit-gspace code-object))
1629 dynamic-core-space-id)
1630 ;; FIXME: pushed thing should be a structure, not just a list
1631 (push (list code-object offset value kind) *load-time-code-fixups*))
1635 (defun output-load-time-code-fixups ()
1636 (dolist (fixups *load-time-code-fixups*)
1637 (let ((code-object (first fixups))
1638 (offset (second fixups))
1639 (value (third fixups))
1640 (kind (fourth fixups)))
1641 (cold-push (cold-cons
1642 (cold-intern :load-time-code-fixup)
1646 (number-to-core offset)
1648 (number-to-core value)
1651 *nil-descriptor*)))))
1652 *current-reversed-cold-toplevels*))))
1654 ;;; Given a pointer to a code object and an offset relative to the
1655 ;;; tail of the code object's header, return an offset relative to the
1656 ;;; (beginning of the) code object.
1658 ;;; FIXME: It might be clearer to reexpress
1659 ;;; (LET ((X (CALC-OFFSET CODE-OBJECT OFFSET0))) ..)
1661 ;;; (LET ((X (+ OFFSET0 (CODE-OBJECT-HEADER-N-BYTES CODE-OBJECT)))) ..).
1662 (declaim (ftype (function (descriptor sb!vm:word)) calc-offset))
1663 (defun calc-offset (code-object offset-from-tail-of-header)
1664 (let* ((header (read-memory code-object))
1665 (header-n-words (ash (descriptor-bits header)
1666 (- sb!vm:n-widetag-bits)))
1667 (header-n-bytes (ash header-n-words sb!vm:word-shift))
1668 (result (+ offset-from-tail-of-header header-n-bytes)))
1671 (declaim (ftype (function (descriptor sb!vm:word sb!vm:word keyword))
1673 (defun do-cold-fixup (code-object after-header value kind)
1674 (let* ((offset-within-code-object (calc-offset code-object after-header))
1675 (gspace-bytes (descriptor-bytes code-object))
1676 (gspace-byte-offset (+ (descriptor-byte-offset code-object)
1677 offset-within-code-object))
1678 (gspace-byte-address (gspace-byte-address
1679 (descriptor-gspace code-object))))
1680 (ecase +backend-fasl-file-implementation+
1681 ;; See CMU CL source for other formerly-supported architectures
1682 ;; (and note that you have to rewrite them to use BVREF-X
1683 ;; instead of SAP-REF).
1687 (assert (zerop (ldb (byte 2 0) value))))
1689 (let* ((value (if (logbitp 15 value) (+ value (ash 1 16)) value))
1690 (value (if (logbitp 31 value) (+ value (ash 1 32)) value))
1691 (value (if (logbitp 47 value) (+ value (ash 1 48)) value)))
1692 (setf (bvref-8 gspace-bytes gspace-byte-offset)
1693 (ldb (byte 8 48) value)
1694 (bvref-8 gspace-bytes (1+ gspace-byte-offset))
1695 (ldb (byte 8 56) value))))
1697 (let* ((value (if (logbitp 15 value) (+ value (ash 1 16)) value))
1698 (value (if (logbitp 31 value) (+ value (ash 1 32)) value)))
1699 (setf (bvref-8 gspace-bytes gspace-byte-offset)
1700 (ldb (byte 8 32) value)
1701 (bvref-8 gspace-bytes (1+ gspace-byte-offset))
1702 (ldb (byte 8 40) value))))
1704 (let ((value (if (logbitp 15 value) (+ value (ash 1 16)) value)))
1705 (setf (bvref-8 gspace-bytes gspace-byte-offset)
1706 (ldb (byte 8 16) value)
1707 (bvref-8 gspace-bytes (1+ gspace-byte-offset))
1708 (ldb (byte 8 24) value))))
1710 (setf (bvref-8 gspace-bytes gspace-byte-offset)
1711 (ldb (byte 8 0) value)
1712 (bvref-8 gspace-bytes (1+ gspace-byte-offset))
1713 (ldb (byte 8 8) value)))))
1717 (setf (bvref-32 gspace-bytes gspace-byte-offset)
1718 (logior (ash (ldb (byte 11 0) value) 1)
1719 (logand (bvref-32 gspace-bytes gspace-byte-offset)
1722 (let ((low-bits (ldb (byte 11 0) value)))
1723 (assert (<= 0 low-bits (1- (ash 1 4))))
1724 (setf (bvref-32 gspace-bytes gspace-byte-offset)
1725 (logior (ash low-bits 17)
1726 (logand (bvref-32 gspace-bytes gspace-byte-offset)
1729 (setf (bvref-32 gspace-bytes gspace-byte-offset)
1730 (logior (ash (ldb (byte 5 13) value) 16)
1731 (ash (ldb (byte 2 18) value) 14)
1732 (ash (ldb (byte 2 11) value) 12)
1733 (ash (ldb (byte 11 20) value) 1)
1734 (ldb (byte 1 31) value)
1735 (logand (bvref-32 gspace-bytes gspace-byte-offset)
1738 (let ((bits (ldb (byte 9 2) value)))
1739 (assert (zerop (ldb (byte 2 0) value)))
1740 (setf (bvref-32 gspace-bytes gspace-byte-offset)
1741 (logior (ash bits 3)
1742 (logand (bvref-32 gspace-bytes gspace-byte-offset)
1747 (assert (zerop (ash value -28)))
1748 (setf (ldb (byte 26 0)
1749 (bvref-32 gspace-bytes gspace-byte-offset))
1752 (setf (bvref-32 gspace-bytes gspace-byte-offset)
1753 (logior (mask-field (byte 16 16)
1754 (bvref-32 gspace-bytes gspace-byte-offset))
1756 (if (logbitp 15 value) 1 0)))))
1758 (setf (bvref-32 gspace-bytes gspace-byte-offset)
1759 (logior (mask-field (byte 16 16)
1760 (bvref-32 gspace-bytes gspace-byte-offset))
1761 (ldb (byte 16 0) value))))))
1765 (setf (bvref-32 gspace-bytes gspace-byte-offset)
1766 (dpb (ash value -2) (byte 24 2)
1767 (bvref-32 gspace-bytes gspace-byte-offset))))
1769 (let* ((h (ldb (byte 16 16) value))
1770 (l (ldb (byte 16 0) value)))
1771 (setf (bvref-16 gspace-bytes (+ gspace-byte-offset 2))
1772 (if (logbitp 15 l) (ldb (byte 16 0) (1+ h)) h))))
1774 (setf (bvref-16 gspace-bytes (+ gspace-byte-offset 2))
1775 (ldb (byte 16 0) value)))))
1779 (error "can't deal with call fixups yet"))
1781 (setf (bvref-32 gspace-bytes gspace-byte-offset)
1782 (dpb (ldb (byte 22 10) value)
1784 (bvref-32 gspace-bytes gspace-byte-offset))))
1786 (setf (bvref-32 gspace-bytes gspace-byte-offset)
1787 (dpb (ldb (byte 10 0) value)
1789 (bvref-32 gspace-bytes gspace-byte-offset))))))
1791 (let* ((un-fixed-up (bvref-word gspace-bytes
1792 gspace-byte-offset))
1793 (code-object-start-addr (logandc2 (descriptor-bits code-object)
1794 sb!vm:lowtag-mask)))
1795 (assert (= code-object-start-addr
1796 (+ gspace-byte-address
1797 (descriptor-byte-offset code-object))))
1800 (let ((fixed-up (+ value un-fixed-up)))
1801 (setf (bvref-32 gspace-bytes gspace-byte-offset)
1803 ;; comment from CMU CL sources:
1805 ;; Note absolute fixups that point within the object.
1806 ;; KLUDGE: There seems to be an implicit assumption in
1807 ;; the old CMU CL code here, that if it doesn't point
1808 ;; before the object, it must point within the object
1809 ;; (not beyond it). It would be good to add an
1810 ;; explanation of why that's true, or an assertion that
1811 ;; it's really true, or both.
1812 (unless (< fixed-up code-object-start-addr)
1813 (note-load-time-code-fixup code-object
1817 (:relative ; (used for arguments to X86 relative CALL instruction)
1818 (let ((fixed-up (- (+ value un-fixed-up)
1821 4))) ; "length of CALL argument"
1822 (setf (bvref-32 gspace-bytes gspace-byte-offset)
1824 ;; Note relative fixups that point outside the code
1825 ;; object, which is to say all relative fixups, since
1826 ;; relative addressing within a code object never needs
1828 (note-load-time-code-fixup code-object
1834 (defun resolve-assembler-fixups ()
1835 (dolist (fixup *cold-assembler-fixups*)
1836 (let* ((routine (car fixup))
1837 (value (lookup-assembler-reference routine)))
1839 (do-cold-fixup (second fixup) (third fixup) value (fourth fixup))))))
1841 ;;; *COLD-FOREIGN-SYMBOL-TABLE* becomes *!INITIAL-FOREIGN-SYMBOLS* in
1842 ;;; the core. When the core is loaded, !LOADER-COLD-INIT uses this to
1843 ;;; create *STATIC-FOREIGN-SYMBOLS*, which the code in
1844 ;;; target-load.lisp refers to.
1845 (defun foreign-symbols-to-core ()
1846 (let ((result *nil-descriptor*))
1847 (maphash (lambda (symbol value)
1848 (cold-push (cold-cons (base-string-to-core symbol)
1849 (number-to-core value))
1851 *cold-foreign-symbol-table*)
1852 (cold-set (cold-intern 'sb!kernel:*!initial-foreign-symbols*) result))
1853 (let ((result *nil-descriptor*))
1854 (dolist (rtn *cold-assembler-routines*)
1855 (cold-push (cold-cons (cold-intern (car rtn))
1856 (number-to-core (cdr rtn)))
1858 (cold-set (cold-intern '*!initial-assembler-routines*) result)))
1861 ;;;; general machinery for cold-loading FASL files
1863 ;;; FOP functions for cold loading
1864 (defvar *cold-fop-funs*
1865 ;; We start out with a copy of the ordinary *FOP-FUNS*. The ones
1866 ;; which aren't appropriate for cold load will be destructively
1868 (copy-seq *fop-funs*))
1870 (defvar *normal-fop-funs*)
1872 ;;; Cause a fop to have a special definition for cold load.
1874 ;;; This is similar to DEFINE-FOP, but unlike DEFINE-FOP, this version
1875 ;;; (1) looks up the code for this name (created by a previous
1876 ;; DEFINE-FOP) instead of creating a code, and
1877 ;;; (2) stores its definition in the *COLD-FOP-FUNS* vector,
1878 ;;; instead of storing in the *FOP-FUNS* vector.
1879 (defmacro define-cold-fop ((name &key (pushp t) (stackp t)) &rest forms)
1880 (aver (member pushp '(nil t)))
1881 (aver (member stackp '(nil t)))
1882 (let ((code (get name 'fop-code))
1883 (fname (symbolicate "COLD-" name)))
1885 (error "~S is not a defined FOP." name))
1889 `((with-fop-stack ,pushp ,@forms))
1891 (setf (svref *cold-fop-funs* ,code) #',fname))))
1893 (defmacro clone-cold-fop ((name &key (pushp t) (stackp t))
1896 (aver (member pushp '(nil t)))
1897 (aver (member stackp '(nil t)))
1899 (macrolet ((clone-arg () '(read-word-arg)))
1900 (define-cold-fop (,name :pushp ,pushp :stackp ,stackp) ,@forms))
1901 (macrolet ((clone-arg () '(read-byte-arg)))
1902 (define-cold-fop (,small-name :pushp ,pushp :stackp ,stackp) ,@forms))))
1904 ;;; Cause a fop to be undefined in cold load.
1905 (defmacro not-cold-fop (name)
1906 `(define-cold-fop (,name)
1907 (error "The fop ~S is not supported in cold load." ',name)))
1909 ;;; COLD-LOAD loads stuff into the core image being built by calling
1910 ;;; LOAD-AS-FASL with the fop function table rebound to a table of cold
1911 ;;; loading functions.
1912 (defun cold-load (filename)
1914 "Load the file named by FILENAME into the cold load image being built."
1915 (let* ((*normal-fop-funs* *fop-funs*)
1916 (*fop-funs* *cold-fop-funs*)
1917 (*cold-load-filename* (etypecase filename
1919 (pathname (namestring filename)))))
1920 (with-open-file (s filename :element-type '(unsigned-byte 8))
1921 (load-as-fasl s nil nil))))
1923 ;;;; miscellaneous cold fops
1925 (define-cold-fop (fop-misc-trap) *unbound-marker*)
1927 (define-cold-fop (fop-short-character)
1928 (make-character-descriptor (read-byte-arg)))
1930 (define-cold-fop (fop-empty-list) *nil-descriptor*)
1931 (define-cold-fop (fop-truth) (cold-intern t))
1933 (define-cold-fop (fop-normal-load :stackp nil)
1934 (setq *fop-funs* *normal-fop-funs*))
1936 (define-fop (fop-maybe-cold-load 82 :stackp nil)
1937 (when *cold-load-filename*
1938 (setq *fop-funs* *cold-fop-funs*)))
1940 (define-cold-fop (fop-maybe-cold-load :stackp nil))
1942 (clone-cold-fop (fop-struct)
1944 (let* ((size (clone-arg))
1945 (result (allocate-boxed-object *dynamic*
1947 sb!vm:instance-pointer-lowtag)))
1948 (write-memory result (make-other-immediate-descriptor
1949 size sb!vm:instance-header-widetag))
1950 (do ((index (1- size) (1- index)))
1952 (declare (fixnum index))
1953 (write-wordindexed result
1954 (+ index sb!vm:instance-slots-offset)
1958 (define-cold-fop (fop-layout)
1959 (let* ((length-des (pop-stack))
1960 (depthoid-des (pop-stack))
1961 (cold-inherits (pop-stack))
1963 (old (gethash name *cold-layouts*)))
1964 (declare (type descriptor length-des depthoid-des cold-inherits))
1965 (declare (type symbol name))
1966 ;; If a layout of this name has been defined already
1968 ;; Enforce consistency between the previous definition and the
1969 ;; current definition, then return the previous definition.
1971 ;; FIXME: This would be more maintainable if we used
1972 ;; DEFSTRUCT (:TYPE LIST) to define COLD-LAYOUT. -- WHN 19990825
1973 (old-layout-descriptor
1979 (declare (type descriptor old-layout-descriptor))
1980 (declare (type index old-length))
1981 (declare (type fixnum old-depthoid))
1982 (declare (type list old-inherits-list))
1983 (aver (eq name old-name))
1984 (let ((length (descriptor-fixnum length-des))
1985 (inherits-list (listify-cold-inherits cold-inherits))
1986 (depthoid (descriptor-fixnum depthoid-des)))
1987 (unless (= length old-length)
1988 (error "cold loading a reference to class ~S when the compile~%~
1989 time length was ~S and current length is ~S"
1993 (unless (equal inherits-list old-inherits-list)
1994 (error "cold loading a reference to class ~S when the compile~%~
1995 time inherits were ~S~%~
1996 and current inherits are ~S"
2000 (unless (= depthoid old-depthoid)
2001 (error "cold loading a reference to class ~S when the compile~%~
2002 time inheritance depthoid was ~S and current inheritance~%~
2007 old-layout-descriptor)
2008 ;; Make a new definition from scratch.
2009 (make-cold-layout name length-des cold-inherits depthoid-des))))
2011 ;;;; cold fops for loading symbols
2013 ;;; Load a symbol SIZE characters long from *FASL-INPUT-STREAM* and
2014 ;;; intern that symbol in PACKAGE.
2015 (defun cold-load-symbol (size package)
2016 (let ((string (make-string size)))
2017 (read-string-as-bytes *fasl-input-stream* string)
2018 (cold-intern (intern string package))))
2020 (macrolet ((frob (name pname-len package-len)
2021 `(define-cold-fop (,name)
2022 (let ((index (read-arg ,package-len)))
2024 (cold-load-symbol (read-arg ,pname-len)
2025 (svref *current-fop-table* index)))))))
2026 (frob fop-symbol-in-package-save #.sb!vm:n-word-bytes #.sb!vm:n-word-bytes)
2027 (frob fop-small-symbol-in-package-save 1 #.sb!vm:n-word-bytes)
2028 (frob fop-symbol-in-byte-package-save #.sb!vm:n-word-bytes 1)
2029 (frob fop-small-symbol-in-byte-package-save 1 1))
2031 (clone-cold-fop (fop-lisp-symbol-save)
2032 (fop-lisp-small-symbol-save)
2033 (push-fop-table (cold-load-symbol (clone-arg) *cl-package*)))
2035 (clone-cold-fop (fop-keyword-symbol-save)
2036 (fop-keyword-small-symbol-save)
2037 (push-fop-table (cold-load-symbol (clone-arg) *keyword-package*)))
2039 (clone-cold-fop (fop-uninterned-symbol-save)
2040 (fop-uninterned-small-symbol-save)
2041 (let* ((size (clone-arg))
2042 (name (make-string size)))
2043 (read-string-as-bytes *fasl-input-stream* name)
2044 (let ((symbol-des (allocate-symbol name)))
2045 (push-fop-table symbol-des))))
2047 ;;;; cold fops for loading lists
2049 ;;; Make a list of the top LENGTH things on the fop stack. The last
2050 ;;; cdr of the list is set to LAST.
2051 (defmacro cold-stack-list (length last)
2052 `(do* ((index ,length (1- index))
2053 (result ,last (cold-cons (pop-stack) result)))
2054 ((= index 0) result)
2055 (declare (fixnum index))))
2057 (define-cold-fop (fop-list)
2058 (cold-stack-list (read-byte-arg) *nil-descriptor*))
2059 (define-cold-fop (fop-list*)
2060 (cold-stack-list (read-byte-arg) (pop-stack)))
2061 (define-cold-fop (fop-list-1)
2062 (cold-stack-list 1 *nil-descriptor*))
2063 (define-cold-fop (fop-list-2)
2064 (cold-stack-list 2 *nil-descriptor*))
2065 (define-cold-fop (fop-list-3)
2066 (cold-stack-list 3 *nil-descriptor*))
2067 (define-cold-fop (fop-list-4)
2068 (cold-stack-list 4 *nil-descriptor*))
2069 (define-cold-fop (fop-list-5)
2070 (cold-stack-list 5 *nil-descriptor*))
2071 (define-cold-fop (fop-list-6)
2072 (cold-stack-list 6 *nil-descriptor*))
2073 (define-cold-fop (fop-list-7)
2074 (cold-stack-list 7 *nil-descriptor*))
2075 (define-cold-fop (fop-list-8)
2076 (cold-stack-list 8 *nil-descriptor*))
2077 (define-cold-fop (fop-list*-1)
2078 (cold-stack-list 1 (pop-stack)))
2079 (define-cold-fop (fop-list*-2)
2080 (cold-stack-list 2 (pop-stack)))
2081 (define-cold-fop (fop-list*-3)
2082 (cold-stack-list 3 (pop-stack)))
2083 (define-cold-fop (fop-list*-4)
2084 (cold-stack-list 4 (pop-stack)))
2085 (define-cold-fop (fop-list*-5)
2086 (cold-stack-list 5 (pop-stack)))
2087 (define-cold-fop (fop-list*-6)
2088 (cold-stack-list 6 (pop-stack)))
2089 (define-cold-fop (fop-list*-7)
2090 (cold-stack-list 7 (pop-stack)))
2091 (define-cold-fop (fop-list*-8)
2092 (cold-stack-list 8 (pop-stack)))
2094 ;;;; cold fops for loading vectors
2096 (clone-cold-fop (fop-base-string)
2097 (fop-small-base-string)
2098 (let* ((len (clone-arg))
2099 (string (make-string len)))
2100 (read-string-as-bytes *fasl-input-stream* string)
2101 (base-string-to-core string)))
2104 (clone-cold-fop (fop-character-string)
2105 (fop-small-character-string)
2106 (bug "CHARACTER-STRING dumped by cross-compiler."))
2108 (clone-cold-fop (fop-vector)
2110 (let* ((size (clone-arg))
2111 (result (allocate-vector-object *dynamic*
2114 sb!vm:simple-vector-widetag)))
2115 (do ((index (1- size) (1- index)))
2117 (declare (fixnum index))
2118 (write-wordindexed result
2119 (+ index sb!vm:vector-data-offset)
2123 (define-cold-fop (fop-int-vector)
2124 (let* ((len (read-word-arg))
2125 (sizebits (read-byte-arg))
2126 (type (case sizebits
2127 (0 sb!vm:simple-array-nil-widetag)
2128 (1 sb!vm:simple-bit-vector-widetag)
2129 (2 sb!vm:simple-array-unsigned-byte-2-widetag)
2130 (4 sb!vm:simple-array-unsigned-byte-4-widetag)
2131 (7 (prog1 sb!vm:simple-array-unsigned-byte-7-widetag
2133 (8 sb!vm:simple-array-unsigned-byte-8-widetag)
2134 (15 (prog1 sb!vm:simple-array-unsigned-byte-15-widetag
2135 (setf sizebits 16)))
2136 (16 sb!vm:simple-array-unsigned-byte-16-widetag)
2137 (31 (prog1 sb!vm:simple-array-unsigned-byte-31-widetag
2138 (setf sizebits 32)))
2139 (32 sb!vm:simple-array-unsigned-byte-32-widetag)
2140 #!+#.(cl:if (cl:= 64 sb!vm:n-word-bits) '(and) '(or))
2141 (63 (prog1 sb!vm:simple-array-unsigned-byte-63-widetag
2142 (setf sizebits 64)))
2143 #!+#.(cl:if (cl:= 64 sb!vm:n-word-bits) '(and) '(or))
2144 (64 sb!vm:simple-array-unsigned-byte-64-widetag)
2145 (t (error "losing element size: ~W" sizebits))))
2146 (result (allocate-vector-object *dynamic* sizebits len type))
2147 (start (+ (descriptor-byte-offset result)
2148 (ash sb!vm:vector-data-offset sb!vm:word-shift)))
2150 (ceiling (* len sizebits)
2151 sb!vm:n-byte-bits))))
2152 (read-bigvec-as-sequence-or-die (descriptor-bytes result)
2158 (define-cold-fop (fop-single-float-vector)
2159 (let* ((len (read-word-arg))
2160 (result (allocate-vector-object
2164 sb!vm:simple-array-single-float-widetag))
2165 (start (+ (descriptor-byte-offset result)
2166 (ash sb!vm:vector-data-offset sb!vm:word-shift)))
2167 (end (+ start (* len 4))))
2168 (read-bigvec-as-sequence-or-die (descriptor-bytes result)
2174 (not-cold-fop fop-double-float-vector)
2175 #!+long-float (not-cold-fop fop-long-float-vector)
2176 (not-cold-fop fop-complex-single-float-vector)
2177 (not-cold-fop fop-complex-double-float-vector)
2178 #!+long-float (not-cold-fop fop-complex-long-float-vector)
2180 (define-cold-fop (fop-array)
2181 (let* ((rank (read-word-arg))
2182 (data-vector (pop-stack))
2183 (result (allocate-boxed-object *dynamic*
2184 (+ sb!vm:array-dimensions-offset rank)
2185 sb!vm:other-pointer-lowtag)))
2186 (write-memory result
2187 (make-other-immediate-descriptor rank
2188 sb!vm:simple-array-widetag))
2189 (write-wordindexed result sb!vm:array-fill-pointer-slot *nil-descriptor*)
2190 (write-wordindexed result sb!vm:array-data-slot data-vector)
2191 (write-wordindexed result sb!vm:array-displacement-slot *nil-descriptor*)
2192 (write-wordindexed result sb!vm:array-displaced-p-slot *nil-descriptor*)
2193 (let ((total-elements 1))
2194 (dotimes (axis rank)
2195 (let ((dim (pop-stack)))
2196 (unless (or (= (descriptor-lowtag dim) sb!vm:even-fixnum-lowtag)
2197 (= (descriptor-lowtag dim) sb!vm:odd-fixnum-lowtag))
2198 (error "non-fixnum dimension? (~S)" dim))
2199 (setf total-elements
2201 (logior (ash (descriptor-high dim)
2202 (- descriptor-low-bits
2203 (1- sb!vm:n-lowtag-bits)))
2204 (ash (descriptor-low dim)
2205 (- 1 sb!vm:n-lowtag-bits)))))
2206 (write-wordindexed result
2207 (+ sb!vm:array-dimensions-offset axis)
2209 (write-wordindexed result
2210 sb!vm:array-elements-slot
2211 (make-fixnum-descriptor total-elements)))
2215 ;;;; cold fops for loading numbers
2217 (defmacro define-cold-number-fop (fop)
2218 `(define-cold-fop (,fop :stackp nil)
2219 ;; Invoke the ordinary warm version of this fop to push the
2222 ;; Replace the warm fop result with the cold image of the warm
2225 (let ((number (pop-stack)))
2226 (number-to-core number)))))
2228 (define-cold-number-fop fop-single-float)
2229 (define-cold-number-fop fop-double-float)
2230 (define-cold-number-fop fop-integer)
2231 (define-cold-number-fop fop-small-integer)
2232 (define-cold-number-fop fop-word-integer)
2233 (define-cold-number-fop fop-byte-integer)
2234 (define-cold-number-fop fop-complex-single-float)
2235 (define-cold-number-fop fop-complex-double-float)
2237 (define-cold-fop (fop-ratio)
2238 (let ((den (pop-stack)))
2239 (number-pair-to-core (pop-stack) den sb!vm:ratio-widetag)))
2241 (define-cold-fop (fop-complex)
2242 (let ((im (pop-stack)))
2243 (number-pair-to-core (pop-stack) im sb!vm:complex-widetag)))
2245 ;;;; cold fops for calling (or not calling)
2247 (not-cold-fop fop-eval)
2248 (not-cold-fop fop-eval-for-effect)
2250 (defvar *load-time-value-counter*)
2252 (define-cold-fop (fop-funcall)
2253 (unless (= (read-byte-arg) 0)
2254 (error "You can't FOP-FUNCALL arbitrary stuff in cold load."))
2255 (let ((counter *load-time-value-counter*))
2256 (cold-push (cold-cons
2257 (cold-intern :load-time-value)
2261 (number-to-core counter)
2263 *current-reversed-cold-toplevels*)
2264 (setf *load-time-value-counter* (1+ counter))
2265 (make-descriptor 0 0 nil counter)))
2267 (defun finalize-load-time-value-noise ()
2268 (cold-set (cold-intern '*!load-time-values*)
2269 (allocate-vector-object *dynamic*
2271 *load-time-value-counter*
2272 sb!vm:simple-vector-widetag)))
2274 (define-cold-fop (fop-funcall-for-effect :pushp nil)
2275 (if (= (read-byte-arg) 0)
2276 (cold-push (pop-stack)
2277 *current-reversed-cold-toplevels*)
2278 (error "You can't FOP-FUNCALL arbitrary stuff in cold load.")))
2280 ;;;; cold fops for fixing up circularities
2282 (define-cold-fop (fop-rplaca :pushp nil)
2283 (let ((obj (svref *current-fop-table* (read-word-arg)))
2284 (idx (read-word-arg)))
2285 (write-memory (cold-nthcdr idx obj) (pop-stack))))
2287 (define-cold-fop (fop-rplacd :pushp nil)
2288 (let ((obj (svref *current-fop-table* (read-word-arg)))
2289 (idx (read-word-arg)))
2290 (write-wordindexed (cold-nthcdr idx obj) 1 (pop-stack))))
2292 (define-cold-fop (fop-svset :pushp nil)
2293 (let ((obj (svref *current-fop-table* (read-word-arg)))
2294 (idx (read-word-arg)))
2295 (write-wordindexed obj
2297 (ecase (descriptor-lowtag obj)
2298 (#.sb!vm:instance-pointer-lowtag 1)
2299 (#.sb!vm:other-pointer-lowtag 2)))
2302 (define-cold-fop (fop-structset :pushp nil)
2303 (let ((obj (svref *current-fop-table* (read-word-arg)))
2304 (idx (read-word-arg)))
2305 (write-wordindexed obj (1+ idx) (pop-stack))))
2307 ;;; In the original CMUCL code, this actually explicitly declared PUSHP
2308 ;;; to be T, even though that's what it defaults to in DEFINE-COLD-FOP.
2309 (define-cold-fop (fop-nthcdr)
2310 (cold-nthcdr (read-word-arg) (pop-stack)))
2312 (defun cold-nthcdr (index obj)
2314 (setq obj (read-wordindexed obj 1)))
2317 ;;;; cold fops for loading code objects and functions
2319 ;;; the names of things which have had COLD-FSET used on them already
2320 ;;; (used to make sure that we don't try to statically link a name to
2321 ;;; more than one definition)
2322 (defparameter *cold-fset-warm-names*
2323 ;; This can't be an EQL hash table because names can be conses, e.g.
2325 (make-hash-table :test 'equal))
2327 (define-cold-fop (fop-fset :pushp nil)
2328 (let* ((fn (pop-stack))
2329 (cold-name (pop-stack))
2330 (warm-name (warm-fun-name cold-name)))
2331 (if (gethash warm-name *cold-fset-warm-names*)
2332 (error "duplicate COLD-FSET for ~S" warm-name)
2333 (setf (gethash warm-name *cold-fset-warm-names*) t))
2334 (static-fset cold-name fn)))
2336 (define-cold-fop (fop-fdefinition)
2337 (cold-fdefinition-object (pop-stack)))
2339 (define-cold-fop (fop-sanctify-for-execution)
2342 ;;; Setting this variable shows what code looks like before any
2343 ;;; fixups (or function headers) are applied.
2344 #!+sb-show (defvar *show-pre-fixup-code-p* nil)
2346 ;;; FIXME: The logic here should be converted into a function
2347 ;;; COLD-CODE-FOP-GUTS (NCONST CODE-SIZE) called by DEFINE-COLD-FOP
2348 ;;; FOP-CODE and DEFINE-COLD-FOP FOP-SMALL-CODE, so that
2349 ;;; variable-capture nastiness like (LET ((NCONST ,NCONST) ..) ..)
2350 ;;; doesn't keep me awake at night.
2351 (defmacro define-cold-code-fop (name nconst code-size)
2352 `(define-cold-fop (,name)
2353 (let* ((nconst ,nconst)
2354 (code-size ,code-size)
2355 (raw-header-n-words (+ sb!vm:code-trace-table-offset-slot nconst))
2357 ;; Note: we round the number of constants up to ensure
2358 ;; that the code vector will be properly aligned.
2359 (round-up raw-header-n-words 2))
2360 (des (allocate-cold-descriptor *dynamic*
2361 (+ (ash header-n-words
2364 sb!vm:other-pointer-lowtag)))
2366 (make-other-immediate-descriptor
2367 header-n-words sb!vm:code-header-widetag))
2368 (write-wordindexed des
2369 sb!vm:code-code-size-slot
2370 (make-fixnum-descriptor
2371 (ash (+ code-size (1- (ash 1 sb!vm:word-shift)))
2372 (- sb!vm:word-shift))))
2373 (write-wordindexed des sb!vm:code-entry-points-slot *nil-descriptor*)
2374 (write-wordindexed des sb!vm:code-debug-info-slot (pop-stack))
2375 (when (oddp raw-header-n-words)
2376 (write-wordindexed des
2378 (make-random-descriptor 0)))
2379 (do ((index (1- raw-header-n-words) (1- index)))
2380 ((< index sb!vm:code-trace-table-offset-slot))
2381 (write-wordindexed des index (pop-stack)))
2382 (let* ((start (+ (descriptor-byte-offset des)
2383 (ash header-n-words sb!vm:word-shift)))
2384 (end (+ start code-size)))
2385 (read-bigvec-as-sequence-or-die (descriptor-bytes des)
2390 (when *show-pre-fixup-code-p*
2391 (format *trace-output*
2392 "~&/raw code from code-fop ~W ~W:~%"
2395 (do ((i start (+ i sb!vm:n-word-bytes)))
2397 (format *trace-output*
2398 "/#X~8,'0x: #X~8,'0x~%"
2399 (+ i (gspace-byte-address (descriptor-gspace des)))
2400 (bvref-32 (descriptor-bytes des) i)))))
2403 (define-cold-code-fop fop-code (read-word-arg) (read-word-arg))
2405 (define-cold-code-fop fop-small-code (read-byte-arg) (read-halfword-arg))
2407 (clone-cold-fop (fop-alter-code :pushp nil)
2408 (fop-byte-alter-code)
2409 (let ((slot (clone-arg))
2412 (write-wordindexed code slot value)))
2414 (define-cold-fop (fop-fun-entry)
2415 (let* ((type (pop-stack))
2416 (arglist (pop-stack))
2418 (code-object (pop-stack))
2419 (offset (calc-offset code-object (read-word-arg)))
2420 (fn (descriptor-beyond code-object
2422 sb!vm:fun-pointer-lowtag))
2423 (next (read-wordindexed code-object sb!vm:code-entry-points-slot)))
2424 (unless (zerop (logand offset sb!vm:lowtag-mask))
2425 (error "unaligned function entry: ~S at #X~X" name offset))
2426 (write-wordindexed code-object sb!vm:code-entry-points-slot fn)
2428 (make-other-immediate-descriptor
2429 (ash offset (- sb!vm:word-shift))
2430 sb!vm:simple-fun-header-widetag))
2431 (write-wordindexed fn
2432 sb!vm:simple-fun-self-slot
2433 ;; KLUDGE: Wiring decisions like this in at
2434 ;; this level ("if it's an x86") instead of a
2435 ;; higher level of abstraction ("if it has such
2436 ;; and such relocation peculiarities (which
2437 ;; happen to be confined to the x86)") is bad.
2438 ;; It would be nice if the code were instead
2439 ;; conditional on some more descriptive
2440 ;; feature, :STICKY-CODE or
2441 ;; :LOAD-GC-INTERACTION or something.
2443 ;; FIXME: The X86 definition of the function
2444 ;; self slot breaks everything object.tex says
2445 ;; about it. (As far as I can tell, the X86
2446 ;; definition makes it a pointer to the actual
2447 ;; code instead of a pointer back to the object
2448 ;; itself.) Ask on the mailing list whether
2449 ;; this is documented somewhere, and if not,
2450 ;; try to reverse engineer some documentation.
2452 ;; a pointer back to the function object, as
2453 ;; described in CMU CL
2454 ;; src/docs/internals/object.tex
2457 ;; KLUDGE: a pointer to the actual code of the
2458 ;; object, as described nowhere that I can find
2460 (make-random-descriptor
2461 (+ (descriptor-bits fn)
2462 (- (ash sb!vm:simple-fun-code-offset
2464 ;; FIXME: We should mask out the type
2465 ;; bits, not assume we know what they
2466 ;; are and subtract them out this way.
2467 sb!vm:fun-pointer-lowtag))))
2468 (write-wordindexed fn sb!vm:simple-fun-next-slot next)
2469 (write-wordindexed fn sb!vm:simple-fun-name-slot name)
2470 (write-wordindexed fn sb!vm:simple-fun-arglist-slot arglist)
2471 (write-wordindexed fn sb!vm:simple-fun-type-slot type)
2474 (define-cold-fop (fop-foreign-fixup)
2475 (let* ((kind (pop-stack))
2476 (code-object (pop-stack))
2477 (len (read-byte-arg))
2478 (sym (make-string len)))
2479 (read-string-as-bytes *fasl-input-stream* sym)
2480 (let ((offset (read-word-arg))
2481 (value (cold-foreign-symbol-address-as-integer sym)))
2482 (do-cold-fixup code-object offset value kind))
2486 (define-cold-fop (fop-foreign-dataref-fixup)
2487 (let* ((kind (pop-stack))
2488 (code-object (pop-stack))
2489 (len (read-byte-arg))
2490 (sym (make-string len)))
2491 (read-string-as-bytes *fasl-input-stream* sym)
2492 (maphash (lambda (k v)
2493 (format *error-output* "~&~S = #X~8X~%" k v))
2494 *cold-foreign-symbol-table*)
2495 (error "shared foreign symbol in cold load: ~S (~S)" sym kind)))
2497 (define-cold-fop (fop-assembler-code)
2498 (let* ((length (read-word-arg))
2500 ;; Note: we round the number of constants up to ensure that
2501 ;; the code vector will be properly aligned.
2502 (round-up sb!vm:code-constants-offset 2))
2503 (des (allocate-cold-descriptor *read-only*
2504 (+ (ash header-n-words
2507 sb!vm:other-pointer-lowtag)))
2509 (make-other-immediate-descriptor
2510 header-n-words sb!vm:code-header-widetag))
2511 (write-wordindexed des
2512 sb!vm:code-code-size-slot
2513 (make-fixnum-descriptor
2514 (ash (+ length (1- (ash 1 sb!vm:word-shift)))
2515 (- sb!vm:word-shift))))
2516 (write-wordindexed des sb!vm:code-entry-points-slot *nil-descriptor*)
2517 (write-wordindexed des sb!vm:code-debug-info-slot *nil-descriptor*)
2519 (let* ((start (+ (descriptor-byte-offset des)
2520 (ash header-n-words sb!vm:word-shift)))
2521 (end (+ start length)))
2522 (read-bigvec-as-sequence-or-die (descriptor-bytes des)
2528 (define-cold-fop (fop-assembler-routine)
2529 (let* ((routine (pop-stack))
2531 (offset (calc-offset des (read-word-arg))))
2532 (record-cold-assembler-routine
2534 (+ (logandc2 (descriptor-bits des) sb!vm:lowtag-mask) offset))
2537 (define-cold-fop (fop-assembler-fixup)
2538 (let* ((routine (pop-stack))
2540 (code-object (pop-stack))
2541 (offset (read-word-arg)))
2542 (record-cold-assembler-fixup routine code-object offset kind)
2545 (define-cold-fop (fop-code-object-fixup)
2546 (let* ((kind (pop-stack))
2547 (code-object (pop-stack))
2548 (offset (read-word-arg))
2549 (value (descriptor-bits code-object)))
2550 (do-cold-fixup code-object offset value kind)
2553 ;;;; emitting C header file
2555 (defun tailwise-equal (string tail)
2556 (and (>= (length string) (length tail))
2557 (string= string tail :start1 (- (length string) (length tail)))))
2559 (defun write-boilerplate ()
2562 '("This is a machine-generated file. Please do not edit it by hand."
2563 "(As of sbcl-0.8.14, it came from WRITE-CONFIG-H in genesis.lisp.)"
2565 "This file contains low-level information about the"
2566 "internals of a particular version and configuration"
2567 "of SBCL. It is used by the C compiler to create a runtime"
2568 "support environment, an executable program in the host"
2569 "operating system's native format, which can then be used to"
2570 "load and run 'core' files, which are basically programs"
2571 "in SBCL's own format."))
2572 (format t " * ~A~%" line))
2575 (defun write-config-h ()
2576 ;; propagating *SHEBANG-FEATURES* into C-level #define's
2577 (dolist (shebang-feature-name (sort (mapcar #'symbol-name
2578 sb-cold:*shebang-features*)
2581 "#define LISP_FEATURE_~A~%"
2582 (substitute #\_ #\- shebang-feature-name)))
2584 ;; and miscellaneous constants
2585 (format t "#define SBCL_CORE_VERSION_INTEGER ~D~%" sbcl-core-version-integer)
2587 "#define SBCL_VERSION_STRING ~S~%"
2588 (sb!xc:lisp-implementation-version))
2589 (format t "#define CORE_MAGIC 0x~X~%" core-magic)
2590 (format t "#ifndef LANGUAGE_ASSEMBLY~2%")
2591 (format t "#define LISPOBJ(x) ((lispobj)x)~2%")
2592 (format t "#else /* LANGUAGE_ASSEMBLY */~2%")
2593 (format t "#define LISPOBJ(thing) thing~2%")
2594 (format t "#endif /* LANGUAGE_ASSEMBLY */~2%")
2597 (defun write-constants-h ()
2598 ;; writing entire families of named constants
2599 (let ((constants nil))
2600 (dolist (package-name '(;; Even in CMU CL, constants from VM
2601 ;; were automatically propagated
2602 ;; into the runtime.
2604 ;; In SBCL, we also propagate various
2605 ;; magic numbers related to file format,
2606 ;; which live here instead of SB!VM.
2608 (do-external-symbols (symbol (find-package package-name))
2609 (when (constantp symbol)
2610 (let ((name (symbol-name symbol)))
2611 (labels (;; shared machinery
2612 (record (string priority)
2615 (symbol-value symbol)
2616 (documentation symbol 'variable))
2618 ;; machinery for old-style CMU CL Lisp-to-C
2619 ;; arbitrary renaming, being phased out in favor of
2620 ;; the newer systematic RECORD-WITH-TRANSLATED-NAME
2622 (record-with-munged-name (prefix string priority)
2623 (record (concatenate
2626 (delete #\- (string-capitalize string)))
2628 (maybe-record-with-munged-name (tail prefix priority)
2629 (when (tailwise-equal name tail)
2630 (record-with-munged-name prefix
2635 ;; machinery for new-style SBCL Lisp-to-C naming
2636 (record-with-translated-name (priority)
2637 (record (substitute #\_ #\- name)
2639 (maybe-record-with-translated-name (suffixes priority)
2640 (when (some (lambda (suffix)
2641 (tailwise-equal name suffix))
2643 (record-with-translated-name priority))))
2645 (maybe-record-with-translated-name '("-LOWTAG") 0)
2646 (maybe-record-with-translated-name '("-WIDETAG") 1)
2647 (maybe-record-with-munged-name "-FLAG" "flag_" 2)
2648 (maybe-record-with-munged-name "-TRAP" "trap_" 3)
2649 (maybe-record-with-munged-name "-SUBTYPE" "subtype_" 4)
2650 (maybe-record-with-munged-name "-SC-NUMBER" "sc_" 5)
2651 (maybe-record-with-translated-name '("-START" "-END" "-SIZE") 6)
2652 (maybe-record-with-translated-name '("-CORE-ENTRY-TYPE-CODE") 7)
2653 (maybe-record-with-translated-name '("-CORE-SPACE-ID") 8))))))
2654 ;; KLUDGE: these constants are sort of important, but there's no
2655 ;; pleasing way to inform the code above about them. So we fake
2656 ;; it for now. nikodemus on #lisp (2004-08-09) suggested simply
2657 ;; exporting every numeric constant from SB!VM; that would work,
2658 ;; but the C runtime would have to be altered to use Lisp-like names
2659 ;; rather than the munged names currently exported. --njf, 2004-08-09
2660 (dolist (c '(sb!vm:n-word-bits sb!vm:n-word-bytes
2661 sb!vm:n-lowtag-bits sb!vm:lowtag-mask
2662 sb!vm:n-widetag-bits sb!vm:widetag-mask
2663 sb!vm:n-fixnum-tag-bits sb!vm:fixnum-tag-mask))
2664 (push (list (substitute #\_ #\- (symbol-name c))
2665 -1 ; invent a new priority
2672 (lambda (const1 const2)
2673 (if (= (second const1) (second const2))
2674 (< (third const1) (third const2))
2675 (< (second const1) (second const2))))))
2676 (let ((prev-priority (second (car constants))))
2677 (dolist (const constants)
2678 (destructuring-bind (name priority value doc) const
2679 (unless (= prev-priority priority)
2681 (setf prev-priority priority))
2682 (format t "#define ~A " name)
2684 ;; KLUDGE: As of sbcl-0.6.7.14, we're dumping two
2685 ;; different kinds of values here, (1) small codes
2686 ;; and (2) machine addresses. The small codes can be
2687 ;; dumped as bare integer values. The large machine
2688 ;; addresses might cause problems if they're large
2689 ;; and represented as (signed) C integers, so we
2690 ;; want to force them to be unsigned. We do that by
2691 ;; wrapping them in the LISPOBJ macro. (We could do
2692 ;; it with a bare "(unsigned)" cast, except that
2693 ;; this header file is used not only in C files, but
2694 ;; also in assembly files, which don't understand
2695 ;; the cast syntax. The LISPOBJ macro goes away in
2696 ;; assembly files, but that shouldn't matter because
2697 ;; we don't do arithmetic on address constants in
2698 ;; assembly files. See? It really is a kludge..) --
2700 (let (;; cutoff for treatment as a small code
2701 (cutoff (expt 2 16)))
2702 (cond ((minusp value)
2703 (error "stub: negative values unsupported"))
2709 (format t " /* 0x~X */~@[ /* ~A */~]~%" value doc))))
2712 ;; writing information about internal errors
2713 (let ((internal-errors sb!c:*backend-internal-errors*))
2714 (dotimes (i (length internal-errors))
2715 (let ((current-error (aref internal-errors i)))
2716 ;; FIXME: this UNLESS should go away (see also FIXME in
2717 ;; interr.lisp) -- APD, 2002-03-05
2718 (unless (eq nil (car current-error))
2719 (format t "#define ~A ~D~%"
2720 (substitute #\_ #\- (symbol-name (car current-error)))
2724 ;; FIXME: The SPARC has a PSEUDO-ATOMIC-TRAP that differs between
2725 ;; platforms. If we export this from the SB!VM package, it gets
2726 ;; written out as #define trap_PseudoAtomic, which is confusing as
2727 ;; the runtime treats trap_ as the prefix for illegal instruction
2728 ;; type things. We therefore don't export it, but instead do
2730 (when (boundp 'sb!vm::pseudo-atomic-trap)
2732 "#define PSEUDO_ATOMIC_TRAP ~D /* 0x~:*~X */~%"
2733 sb!vm::pseudo-atomic-trap)
2735 ;; possibly this is another candidate for a rename (to
2736 ;; pseudo-atomic-trap-number or pseudo-atomic-magic-constant
2737 ;; [possibly applicable to other platforms])
2739 (dolist (symbol '(sb!vm::float-traps-byte
2740 sb!vm::float-exceptions-byte
2741 sb!vm::float-sticky-bits
2742 sb!vm::float-rounding-mode))
2743 (format t "#define ~A_POSITION ~A /* ~:*0x~X */~%"
2744 (substitute #\_ #\- (symbol-name symbol))
2745 (sb!xc:byte-position (symbol-value symbol)))
2746 (format t "#define ~A_MASK 0x~X /* ~:*~A */~%"
2747 (substitute #\_ #\- (symbol-name symbol))
2748 (sb!xc:mask-field (symbol-value symbol) -1))))
2752 (defun write-primitive-object (obj)
2753 ;; writing primitive object layouts
2754 (format t "#ifndef LANGUAGE_ASSEMBLY~2%")
2758 (string-downcase (string (sb!vm:primitive-object-name obj)))))
2759 (when (sb!vm:primitive-object-widetag obj)
2760 (format t " lispobj header;~%"))
2761 (dolist (slot (sb!vm:primitive-object-slots obj))
2762 (format t " ~A ~A~@[[1]~];~%"
2763 (getf (sb!vm:slot-options slot) :c-type "lispobj")
2765 (string-downcase (string (sb!vm:slot-name slot))))
2766 (sb!vm:slot-rest-p slot)))
2768 (format t "#else /* LANGUAGE_ASSEMBLY */~2%")
2769 (let ((name (sb!vm:primitive-object-name obj))
2770 (lowtag (eval (sb!vm:primitive-object-lowtag obj))))
2772 (dolist (slot (sb!vm:primitive-object-slots obj))
2773 (format t "#define ~A_~A_OFFSET ~D~%"
2774 (substitute #\_ #\- (string name))
2775 (substitute #\_ #\- (string (sb!vm:slot-name slot)))
2776 (- (* (sb!vm:slot-offset slot) sb!vm:n-word-bytes) lowtag)))
2778 (format t "#endif /* LANGUAGE_ASSEMBLY */~2%"))
2780 (defun write-static-symbols ()
2781 (dolist (symbol (cons nil sb!vm:*static-symbols*))
2782 ;; FIXME: It would be nice to use longer names than NIL and
2783 ;; (particularly) T in #define statements.
2784 (format t "#define ~A LISPOBJ(0x~X)~%"
2786 (remove-if (lambda (char)
2787 (member char '(#\% #\* #\. #\!)))
2788 (symbol-name symbol)))
2789 (if *static* ; if we ran GENESIS
2790 ;; We actually ran GENESIS, use the real value.
2791 (descriptor-bits (cold-intern symbol))
2792 ;; We didn't run GENESIS, so guess at the address.
2793 (+ sb!vm:static-space-start
2795 sb!vm:other-pointer-lowtag
2796 (if symbol (sb!vm:static-symbol-offset symbol) 0))))))
2799 ;;;; writing map file
2801 ;;; Write a map file describing the cold load. Some of this
2802 ;;; information is subject to change due to relocating GC, but even so
2803 ;;; it can be very handy when attempting to troubleshoot the early
2804 ;;; stages of cold load.
2806 (let ((*print-pretty* nil)
2807 (*print-case* :upcase))
2808 (format t "assembler routines defined in core image:~2%")
2809 (dolist (routine (sort (copy-list *cold-assembler-routines*) #'<
2811 (format t "#X~8,'0X: ~S~%" (cdr routine) (car routine)))
2814 (maphash (lambda (name fdefn)
2815 (let ((fun (read-wordindexed fdefn
2816 sb!vm:fdefn-fun-slot)))
2817 (if (= (descriptor-bits fun)
2818 (descriptor-bits *nil-descriptor*))
2820 (let ((addr (read-wordindexed
2821 fdefn sb!vm:fdefn-raw-addr-slot)))
2822 (push (cons name (descriptor-bits addr))
2824 *cold-fdefn-objects*)
2825 (format t "~%~|~%initially defined functions:~2%")
2826 (setf funs (sort funs #'< :key #'cdr))
2828 (format t "0x~8,'0X: ~S #X~8,'0X~%" (cdr info) (car info)
2829 (- (cdr info) #x17)))
2832 (a note about initially undefined function references: These functions
2833 are referred to by code which is installed by GENESIS, but they are not
2834 installed by GENESIS. This is not necessarily a problem; functions can
2835 be defined later, by cold init toplevel forms, or in files compiled and
2836 loaded at warm init, or elsewhere. As long as they are defined before
2837 they are called, everything should be OK. Things are also OK if the
2838 cross-compiler knew their inline definition and used that everywhere
2839 that they were called before the out-of-line definition is installed,
2840 as is fairly common for structure accessors.)
2841 initially undefined function references:~2%")
2843 (setf undefs (sort undefs #'string< :key #'fun-name-block-name))
2844 (dolist (name undefs)
2845 (format t "~S~%" name)))
2847 (format t "~%~|~%layout names:~2%")
2849 (maphash (lambda (name gorp)
2850 (declare (ignore name))
2851 (stuff (cons (descriptor-bits (car gorp))
2854 (dolist (x (sort (stuff) #'< :key #'car))
2855 (apply #'format t "~8,'0X: ~S[~D]~%~10T~S~%" x))))
2859 ;;;; writing core file
2861 (defvar *core-file*)
2862 (defvar *data-page*)
2864 ;;; magic numbers to identify entries in a core file
2866 ;;; (In case you were wondering: No, AFAIK there's no special magic about
2867 ;;; these which requires them to be in the 38xx range. They're just
2868 ;;; arbitrary words, tested not for being in a particular range but just
2869 ;;; for equality. However, if you ever need to look at a .core file and
2870 ;;; figure out what's going on, it's slightly convenient that they're
2871 ;;; all in an easily recognizable range, and displacing the range away from
2872 ;;; zero seems likely to reduce the chance that random garbage will be
2873 ;;; misinterpreted as a .core file.)
2874 (defconstant version-core-entry-type-code 3860)
2875 (defconstant build-id-core-entry-type-code 3899)
2876 (defconstant new-directory-core-entry-type-code 3861)
2877 (defconstant initial-fun-core-entry-type-code 3863)
2878 (defconstant end-core-entry-type-code 3840)
2880 (declaim (ftype (function (sb!vm:word) sb!vm:word) write-word))
2881 (defun write-word (num)
2882 (ecase sb!c:*backend-byte-order*
2884 (dotimes (i sb!vm:n-word-bytes)
2885 (write-byte (ldb (byte 8 (* i 8)) num) *core-file*)))
2887 (dotimes (i sb!vm:n-word-bytes)
2888 (write-byte (ldb (byte 8 (* (- (1- sb!vm:n-word-bytes) i) 8)) num)
2892 (defun advance-to-page ()
2893 (force-output *core-file*)
2894 (file-position *core-file*
2895 (round-up (file-position *core-file*)
2896 sb!c:*backend-page-size*)))
2898 (defun output-gspace (gspace)
2899 (force-output *core-file*)
2900 (let* ((posn (file-position *core-file*))
2901 (bytes (* (gspace-free-word-index gspace) sb!vm:n-word-bytes))
2902 (pages (ceiling bytes sb!c:*backend-page-size*))
2903 (total-bytes (* pages sb!c:*backend-page-size*)))
2905 (file-position *core-file*
2906 (* sb!c:*backend-page-size* (1+ *data-page*)))
2908 "writing ~S byte~:P [~S page~:P] from ~S~%"
2914 ;; Note: It is assumed that the GSPACE allocation routines always
2915 ;; allocate whole pages (of size *target-page-size*) and that any
2916 ;; empty gspace between the free pointer and the end of page will
2917 ;; be zero-filled. This will always be true under Mach on machines
2918 ;; where the page size is equal. (RT is 4K, PMAX is 4K, Sun 3 is
2920 (write-bigvec-as-sequence (gspace-bytes gspace)
2923 (force-output *core-file*)
2924 (file-position *core-file* posn)
2926 ;; Write part of a (new) directory entry which looks like this:
2927 ;; GSPACE IDENTIFIER
2932 (write-word (gspace-identifier gspace))
2933 (write-word (gspace-free-word-index gspace))
2934 (write-word *data-page*)
2935 (multiple-value-bind (floor rem)
2936 (floor (gspace-byte-address gspace) sb!c:*backend-page-size*)
2941 (incf *data-page* pages)))
2943 ;;; Create a core file created from the cold loaded image. (This is
2944 ;;; the "initial core file" because core files could be created later
2945 ;;; by executing SAVE-LISP in a running system, perhaps after we've
2946 ;;; added some functionality to the system.)
2947 (declaim (ftype (function (string)) write-initial-core-file))
2948 (defun write-initial-core-file (filename)
2950 (let ((filenamestring (namestring filename))
2954 "[building initial core file in ~S: ~%"
2958 (with-open-file (*core-file* filenamestring
2960 :element-type '(unsigned-byte 8)
2961 :if-exists :rename-and-delete)
2963 ;; Write the magic number.
2964 (write-word core-magic)
2966 ;; Write the Version entry.
2967 (write-word version-core-entry-type-code)
2969 (write-word sbcl-core-version-integer)
2971 ;; Write the build ID.
2972 (write-word build-id-core-entry-type-code)
2973 (let ((build-id (with-open-file (s "output/build-id.tmp"
2976 (declare (type simple-string build-id))
2977 (/show build-id (length build-id))
2978 ;; Write length of build ID record: BUILD-ID-CORE-ENTRY-TYPE-CODE
2979 ;; word, this length word, and one word for each char of BUILD-ID.
2980 (write-word (+ 2 (length build-id)))
2981 (dovector (char build-id)
2982 ;; (We write each character as a word in order to avoid
2983 ;; having to think about word alignment issues in the
2984 ;; sbcl-0.7.8 version of coreparse.c.)
2985 (write-word (sb!xc:char-code char))))
2987 ;; Write the New Directory entry header.
2988 (write-word new-directory-core-entry-type-code)
2989 (write-word 17) ; length = (5 words/space) * 3 spaces + 2 for header.
2991 (output-gspace *read-only*)
2992 (output-gspace *static*)
2993 (output-gspace *dynamic*)
2995 ;; Write the initial function.
2996 (write-word initial-fun-core-entry-type-code)
2998 (let* ((cold-name (cold-intern '!cold-init))
2999 (cold-fdefn (cold-fdefinition-object cold-name))
3000 (initial-fun (read-wordindexed cold-fdefn
3001 sb!vm:fdefn-fun-slot)))
3003 "~&/(DESCRIPTOR-BITS INITIAL-FUN)=#X~X~%"
3004 (descriptor-bits initial-fun))
3005 (write-word (descriptor-bits initial-fun)))
3007 ;; Write the End entry.
3008 (write-word end-core-entry-type-code)
3011 (format t "done]~%")
3013 (/show "leaving WRITE-INITIAL-CORE-FILE")
3016 ;;;; the actual GENESIS function
3018 ;;; Read the FASL files in OBJECT-FILE-NAMES and produce a Lisp core,
3019 ;;; and/or information about a Lisp core, therefrom.
3021 ;;; input file arguments:
3022 ;;; SYMBOL-TABLE-FILE-NAME names a UNIX-style .nm file *with* *any*
3023 ;;; *tab* *characters* *converted* *to* *spaces*. (We push
3024 ;;; responsibility for removing tabs out to the caller it's
3025 ;;; trivial to remove them using UNIX command line tools like
3026 ;;; sed, whereas it's a headache to do it portably in Lisp because
3027 ;;; #\TAB is not a STANDARD-CHAR.) If this file is not supplied,
3028 ;;; a core file cannot be built (but a C header file can be).
3030 ;;; output files arguments (any of which may be NIL to suppress output):
3031 ;;; CORE-FILE-NAME gets a Lisp core.
3032 ;;; C-HEADER-FILE-NAME gets a C header file, traditionally called
3033 ;;; internals.h, which is used by the C compiler when constructing
3034 ;;; the executable which will load the core.
3035 ;;; MAP-FILE-NAME gets (?) a map file. (dunno about this -- WHN 19990815)
3037 ;;; FIXME: GENESIS doesn't belong in SB!VM. Perhaps in %KERNEL for now,
3038 ;;; perhaps eventually in SB-LD or SB-BOOT.
3039 (defun sb!vm:genesis (&key
3041 symbol-table-file-name
3047 "~&beginning GENESIS, ~A~%"
3049 ;; Note: This output summarizing what we're doing is
3050 ;; somewhat telegraphic in style, not meant to imply that
3051 ;; we're not e.g. also creating a header file when we
3053 (format nil "creating core ~S" core-file-name)
3054 (format nil "creating headers in ~S" c-header-dir-name)))
3056 (let ((*cold-foreign-symbol-table* (make-hash-table :test 'equal)))
3058 (when core-file-name
3059 (if symbol-table-file-name
3060 (load-cold-foreign-symbol-table symbol-table-file-name)
3061 (error "can't output a core file without symbol table file input")))
3063 ;; Now that we've successfully read our only input file (by
3064 ;; loading the symbol table, if any), it's a good time to ensure
3065 ;; that there'll be someplace for our output files to go when
3067 (flet ((frob (filename)
3069 (ensure-directories-exist filename :verbose t))))
3070 (frob core-file-name)
3071 (frob map-file-name))
3073 ;; (This shouldn't matter in normal use, since GENESIS normally
3074 ;; only runs once in any given Lisp image, but it could reduce
3075 ;; confusion if we ever experiment with running, tweaking, and
3076 ;; rerunning genesis interactively.)
3077 (do-all-symbols (sym)
3078 (remprop sym 'cold-intern-info))
3080 (let* ((*foreign-symbol-placeholder-value* (if core-file-name nil 0))
3081 (*load-time-value-counter* 0)
3082 (*cold-fdefn-objects* (make-hash-table :test 'equal))
3083 (*cold-symbols* (make-hash-table :test 'equal))
3084 (*cold-package-symbols* nil)
3085 (*read-only* (make-gspace :read-only
3086 read-only-core-space-id
3087 sb!vm:read-only-space-start))
3088 (*static* (make-gspace :static
3089 static-core-space-id
3090 sb!vm:static-space-start))
3091 (*dynamic* (make-gspace :dynamic
3092 dynamic-core-space-id
3093 #!+gencgc sb!vm:dynamic-space-start
3094 #!-gencgc sb!vm:dynamic-0-space-start))
3095 (*nil-descriptor* (make-nil-descriptor))
3096 (*current-reversed-cold-toplevels* *nil-descriptor*)
3097 (*unbound-marker* (make-other-immediate-descriptor
3099 sb!vm:unbound-marker-widetag))
3100 *cold-assembler-fixups*
3101 *cold-assembler-routines*
3102 #!+(or x86 x86-64) *load-time-code-fixups*)
3104 ;; Prepare for cold load.
3105 (initialize-non-nil-symbols)
3106 (initialize-layouts)
3107 (initialize-static-fns)
3109 ;; Initialize the *COLD-SYMBOLS* system with the information
3110 ;; from package-data-list.lisp-expr and
3111 ;; common-lisp-exports.lisp-expr.
3113 ;; Why do things this way? Historically, the *COLD-SYMBOLS*
3114 ;; machinery was designed and implemented in CMU CL long before
3115 ;; I (WHN) ever heard of CMU CL. It dumped symbols and packages
3116 ;; iff they were used in the cold image. When I added the
3117 ;; package-data-list.lisp-expr mechanism, the idea was to
3118 ;; centralize all information about packages and exports. Thus,
3119 ;; it was the natural place for information even about packages
3120 ;; (such as SB!PCL and SB!WALKER) which aren't used much until
3121 ;; after cold load. This didn't quite match the CMU CL approach
3122 ;; of filling *COLD-SYMBOLS* with symbols which appear in the
3123 ;; cold image and then dumping only those symbols. By explicitly
3124 ;; putting all the symbols from package-data-list.lisp-expr and
3125 ;; from common-lisp-exports.lisp-expr into *COLD-SYMBOLS* here,
3126 ;; we feed our centralized symbol information into the old CMU
3127 ;; CL code without having to change the old CMU CL code too
3128 ;; much. (And the old CMU CL code is still useful for making
3129 ;; sure that the appropriate keywords and internal symbols end
3130 ;; up interned in the target Lisp, which is good, e.g. in order
3131 ;; to make &KEY arguments work right and in order to make
3132 ;; BACKTRACEs into target Lisp system code be legible.)
3133 (dolist (exported-name
3134 (sb-cold:read-from-file "common-lisp-exports.lisp-expr"))
3135 (cold-intern (intern exported-name *cl-package*)))
3136 (dolist (pd (sb-cold:read-from-file "package-data-list.lisp-expr"))
3137 (declare (type sb-cold:package-data pd))
3138 (let ((package (find-package (sb-cold:package-data-name pd))))
3139 (labels (;; Call FN on every node of the TREE.
3140 (mapc-on-tree (fn tree)
3141 (declare (type function fn))
3143 (cons (mapc-on-tree fn (car tree))
3144 (mapc-on-tree fn (cdr tree)))
3145 (t (funcall fn tree)
3147 ;; Make sure that information about the association
3148 ;; between PACKAGE and the symbol named NAME gets
3149 ;; recorded in the cold-intern system or (as a
3150 ;; convenience when dealing with the tree structure
3151 ;; allowed in the PACKAGE-DATA-EXPORTS slot) do
3152 ;; nothing if NAME is NIL.
3155 (cold-intern (intern name package) package))))
3156 (mapc-on-tree #'chill (sb-cold:package-data-export pd))
3157 (mapc #'chill (sb-cold:package-data-reexport pd))
3158 (dolist (sublist (sb-cold:package-data-import-from pd))
3159 (destructuring-bind (package-name &rest symbol-names) sublist
3160 (declare (ignore package-name))
3161 (mapc #'chill symbol-names))))))
3164 (dolist (file-name object-file-names)
3165 (write-line (namestring file-name))
3166 (cold-load file-name))
3168 ;; Tidy up loose ends left by cold loading. ("Postpare from cold load?")
3169 (resolve-assembler-fixups)
3170 #!+(or x86 x86-64) (output-load-time-code-fixups)
3171 (foreign-symbols-to-core)
3173 (/show "back from FINISH-SYMBOLS")
3174 (finalize-load-time-value-noise)
3176 ;; Tell the target Lisp how much stuff we've allocated.
3177 (cold-set 'sb!vm:*read-only-space-free-pointer*
3178 (allocate-cold-descriptor *read-only*
3180 sb!vm:even-fixnum-lowtag))
3181 (cold-set 'sb!vm:*static-space-free-pointer*
3182 (allocate-cold-descriptor *static*
3184 sb!vm:even-fixnum-lowtag))
3185 (cold-set 'sb!vm:*initial-dynamic-space-free-pointer*
3186 (allocate-cold-descriptor *dynamic*
3188 sb!vm:even-fixnum-lowtag))
3189 (/show "done setting free pointers")
3191 ;; Write results to files.
3193 ;; FIXME: I dislike this approach of redefining
3194 ;; *STANDARD-OUTPUT* instead of putting the new stream in a
3195 ;; lexical variable, and it's annoying to have WRITE-MAP (to
3196 ;; *STANDARD-OUTPUT*) not be parallel to WRITE-INITIAL-CORE-FILE
3197 ;; (to a stream explicitly passed as an argument).
3198 (macrolet ((out-to (name &body body)
3199 `(let ((fn (format nil "~A/~A.h" c-header-dir-name ,name)))
3200 (ensure-directories-exist fn)
3201 (with-open-file (*standard-output* fn
3202 :if-exists :supersede :direction :output)
3204 (let ((n (substitute #\_ #\- (string-upcase ,name))))
3207 "#ifndef SBCL_GENESIS_~A~%#define SBCL_GENESIS_~A 1~%"
3211 "#endif /* SBCL_GENESIS_~A */~%"
3212 (string-upcase ,name))))))
3214 (with-open-file (*standard-output* map-file-name
3216 :if-exists :supersede)
3218 (out-to "config" (write-config-h))
3219 (out-to "constants" (write-constants-h))
3220 (let ((structs (sort (copy-list sb!vm:*primitive-objects*) #'string<
3223 (sb!vm:primitive-object-name obj))))))
3224 (dolist (obj structs)
3226 (string-downcase (string (sb!vm:primitive-object-name obj)))
3227 (write-primitive-object obj)))
3228 (out-to "primitive-objects"
3229 (dolist (obj structs)
3230 (format t "~&#include \"~A.h\"~%"
3232 (string (sb!vm:primitive-object-name obj)))))))
3233 (out-to "static-symbols" (write-static-symbols))
3235 (when core-file-name
3236 (write-initial-core-file core-file-name))))))