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 ;;; 4: added gc page table data
64 (defconstant sbcl-core-version-integer 4)
66 (defun round-up (number size)
68 "Round NUMBER up to be an integral multiple of SIZE."
69 (* size (ceiling number size)))
71 ;;;; implementing the concept of "vector" in (almost) portable
74 ;;;; "If you only need to do such simple things, it doesn't really
75 ;;;; matter which language you use." -- _ANSI Common Lisp_, p. 1, Paul
76 ;;;; Graham (evidently not considering the abstraction "vector" to be
77 ;;;; such a simple thing:-)
79 (eval-when (:compile-toplevel :load-toplevel :execute)
80 (defconstant +smallvec-length+
83 ;;; an element of a BIGVEC -- a vector small enough that we have
84 ;;; a good chance of it being portable to other Common Lisps
86 `(simple-array (unsigned-byte 8) (,+smallvec-length+)))
88 (defun make-smallvec ()
89 (make-array +smallvec-length+ :element-type '(unsigned-byte 8)))
91 ;;; a big vector, implemented as a vector of SMALLVECs
93 ;;; KLUDGE: This implementation seems portable enough for our
94 ;;; purposes, since realistically every modern implementation is
95 ;;; likely to support vectors of at least 2^16 elements. But if you're
96 ;;; masochistic enough to read this far into the contortions imposed
97 ;;; on us by ANSI and the Lisp community, for daring to use the
98 ;;; abstraction of a large linearly addressable memory space, which is
99 ;;; after all only directly supported by the underlying hardware of at
100 ;;; least 99% of the general-purpose computers in use today, then you
101 ;;; may be titillated to hear that in fact this code isn't really
102 ;;; portable, because as of sbcl-0.7.4 we need somewhat more than
103 ;;; 16Mbytes to represent a core, and ANSI only guarantees that
104 ;;; ARRAY-DIMENSION-LIMIT is not less than 1024. -- WHN 2002-06-13
106 (outer-vector (vector (make-smallvec)) :type (vector smallvec)))
108 ;;; analogous to SVREF, but into a BIGVEC
109 (defun bvref (bigvec index)
110 (multiple-value-bind (outer-index inner-index)
111 (floor index +smallvec-length+)
113 (svref (bigvec-outer-vector bigvec) outer-index))
115 (defun (setf bvref) (new-value bigvec index)
116 (multiple-value-bind (outer-index inner-index)
117 (floor index +smallvec-length+)
118 (setf (aref (the smallvec
119 (svref (bigvec-outer-vector bigvec) outer-index))
123 ;;; analogous to LENGTH, but for a BIGVEC
125 ;;; the length of BIGVEC, measured in the number of BVREFable bytes it
127 (defun bvlength (bigvec)
128 (* (length (bigvec-outer-vector bigvec))
131 ;;; analogous to WRITE-SEQUENCE, but for a BIGVEC
132 (defun write-bigvec-as-sequence (bigvec stream &key (start 0) end)
133 (loop for i of-type index from start below (or end (bvlength bigvec)) do
134 (write-byte (bvref bigvec i)
137 ;;; analogous to READ-SEQUENCE-OR-DIE, but for a BIGVEC
138 (defun read-bigvec-as-sequence-or-die (bigvec stream &key (start 0) end)
139 (loop for i of-type index from start below (or end (bvlength bigvec)) do
140 (setf (bvref bigvec i)
141 (read-byte stream))))
143 ;;; Grow BIGVEC (exponentially, so that large increases in size have
144 ;;; asymptotic logarithmic cost per byte).
145 (defun expand-bigvec (bigvec)
146 (let* ((old-outer-vector (bigvec-outer-vector bigvec))
147 (length-old-outer-vector (length old-outer-vector))
148 (new-outer-vector (make-array (* 2 length-old-outer-vector))))
149 (dotimes (i length-old-outer-vector)
150 (setf (svref new-outer-vector i)
151 (svref old-outer-vector i)))
152 (loop for i from length-old-outer-vector below (length new-outer-vector) do
153 (setf (svref new-outer-vector i)
155 (setf (bigvec-outer-vector bigvec)
159 ;;;; looking up bytes and multi-byte values in a BIGVEC (considering
160 ;;;; it as an image of machine memory on the cross-compilation target)
162 ;;; BVREF-32 and friends. These are like SAP-REF-n, except that
163 ;;; instead of a SAP we use a BIGVEC.
164 (macrolet ((make-bvref-n
166 (let* ((name (intern (format nil "BVREF-~A" n)))
167 (number-octets (/ n 8))
169 (loop for i from 0 to (1- number-octets)
170 collect `(ash (bvref bigvec (+ byte-index ,i))
173 (loop for i from 0 to (1- number-octets)
174 collect `(ash (bvref bigvec
176 ,(- number-octets 1 i)))
179 (loop for i from 0 to (1- number-octets)
181 `((bvref bigvec (+ byte-index ,i))
182 (ldb (byte 8 ,(* i 8)) new-value))))
184 (loop for i from 0 to (1- number-octets)
186 `((bvref bigvec (+ byte-index ,i))
187 (ldb (byte 8 ,(- n 8 (* i 8))) new-value)))))
189 (defun ,name (bigvec byte-index)
190 (logior ,@(ecase sb!c:*backend-byte-order*
191 (:little-endian ash-list-le)
192 (:big-endian ash-list-be))))
193 (defun (setf ,name) (new-value bigvec byte-index)
194 (setf ,@(ecase sb!c:*backend-byte-order*
195 (:little-endian setf-list-le)
196 (:big-endian setf-list-be))))))))
202 ;; lispobj-sized word, whatever that may be
203 ;; hopefully nobody ever wants a 128-bit SBCL...
204 #!+#.(cl:if (cl:= 64 sb!vm:n-word-bits) '(and) '(or))
206 (defun bvref-word (bytes index)
207 (bvref-64 bytes index))
208 (defun (setf bvref-word) (new-val bytes index)
209 (setf (bvref-64 bytes index) new-val)))
211 #!+#.(cl:if (cl:= 32 sb!vm:n-word-bits) '(and) '(or))
213 (defun bvref-word (bytes index)
214 (bvref-32 bytes index))
215 (defun (setf bvref-word) (new-val bytes index)
216 (setf (bvref-32 bytes index) new-val)))
219 ;;;; representation of spaces in the core
221 ;;; If there is more than one dynamic space in memory (i.e., if a
222 ;;; copying GC is in use), then only the active dynamic space gets
225 (defconstant dynamic-core-space-id 1)
228 (defconstant static-core-space-id 2)
231 (defconstant read-only-core-space-id 3)
233 (defconstant descriptor-low-bits 16
234 "the number of bits in the low half of the descriptor")
235 (defconstant target-space-alignment (ash 1 descriptor-low-bits)
236 "the alignment requirement for spaces in the target.
237 Must be at least (ASH 1 DESCRIPTOR-LOW-BITS)")
239 ;;; a GENESIS-time representation of a memory space (e.g. read-only
240 ;;; space, dynamic space, or static space)
241 (defstruct (gspace (:constructor %make-gspace)
243 ;; name and identifier for this GSPACE
244 (name (missing-arg) :type symbol :read-only t)
245 (identifier (missing-arg) :type fixnum :read-only t)
246 ;; the word address where the data will be loaded
247 (word-address (missing-arg) :type unsigned-byte :read-only t)
248 ;; the data themselves. (Note that in CMU CL this was a pair of
249 ;; fields SAP and WORDS-ALLOCATED, but that wasn't very portable.)
250 ;; (And then in SBCL this was a VECTOR, but turned out to be
251 ;; unportable too, since ANSI doesn't think that arrays longer than
252 ;; 1024 (!) should needed by portable CL code...)
253 (bytes (make-bigvec) :read-only t)
254 ;; the index of the next unwritten word (i.e. chunk of
255 ;; SB!VM:N-WORD-BYTES bytes) in BYTES, or equivalently the number of
256 ;; words actually written in BYTES. In order to convert to an actual
257 ;; index into BYTES, thus must be multiplied by SB!VM:N-WORD-BYTES.
260 (defun gspace-byte-address (gspace)
261 (ash (gspace-word-address gspace) sb!vm:word-shift))
263 (def!method print-object ((gspace gspace) stream)
264 (print-unreadable-object (gspace stream :type t)
265 (format stream "~S" (gspace-name gspace))))
267 (defun make-gspace (name identifier byte-address)
268 (unless (zerop (rem byte-address target-space-alignment))
269 (error "The byte address #X~X is not aligned on a #X~X-byte boundary."
271 target-space-alignment))
272 (%make-gspace :name name
273 :identifier identifier
274 :word-address (ash byte-address (- sb!vm:word-shift))))
276 ;;;; representation of descriptors
278 (defstruct (descriptor
279 (:constructor make-descriptor
280 (high low &optional gspace word-offset))
282 ;; the GSPACE that this descriptor is allocated in, or NIL if not set yet.
283 (gspace nil :type (or gspace null))
284 ;; the offset in words from the start of GSPACE, or NIL if not set yet
285 (word-offset nil :type (or sb!vm:word null))
286 ;; the high and low halves of the descriptor
288 ;; KLUDGE: Judging from the comments in genesis.lisp of the CMU CL
289 ;; old-rt compiler, this split dates back from a very early version
290 ;; of genesis where 32-bit integers were represented as conses of
291 ;; two 16-bit integers. In any system with nice (UNSIGNED-BYTE 32)
292 ;; structure slots, like CMU CL >= 17 or any version of SBCL, there
293 ;; seems to be no reason to persist in this. -- WHN 19990917
296 (def!method print-object ((des descriptor) stream)
297 (let ((lowtag (descriptor-lowtag des)))
298 (print-unreadable-object (des stream :type t)
299 (cond ((or (= lowtag sb!vm:even-fixnum-lowtag)
300 (= lowtag sb!vm:odd-fixnum-lowtag))
301 (let ((unsigned (logior (ash (descriptor-high des)
302 (1+ (- descriptor-low-bits
303 sb!vm:n-lowtag-bits)))
304 (ash (descriptor-low des)
305 (- 1 sb!vm:n-lowtag-bits)))))
308 (if (> unsigned #x1FFFFFFF)
309 (- unsigned #x40000000)
311 ((or (= lowtag sb!vm:other-immediate-0-lowtag)
312 (= lowtag sb!vm:other-immediate-1-lowtag)
313 #!+#.(cl:if (cl:= 64 sb!vm:n-word-bits) '(and) '(or))
314 (= lowtag sb!vm:other-immediate-2-lowtag)
315 #!+#.(cl:if (cl:= 64 sb!vm:n-word-bits) '(and) '(or))
316 (= lowtag sb!vm:other-immediate-3-lowtag))
318 "for other immediate: #X~X, type #b~8,'0B"
319 (ash (descriptor-bits des) (- sb!vm:n-widetag-bits))
320 (logand (descriptor-low des) sb!vm:widetag-mask)))
323 "for pointer: #X~X, lowtag #b~3,'0B, ~A"
324 (logior (ash (descriptor-high des) descriptor-low-bits)
325 (logandc2 (descriptor-low des) sb!vm:lowtag-mask))
327 (let ((gspace (descriptor-gspace des)))
332 ;;; Return a descriptor for a block of LENGTH bytes out of GSPACE. The
333 ;;; free word index is boosted as necessary, and if additional memory
334 ;;; is needed, we grow the GSPACE. The descriptor returned is a
335 ;;; pointer of type LOWTAG.
336 (defun allocate-cold-descriptor (gspace length lowtag)
337 (let* ((bytes (round-up length (ash 1 sb!vm:n-lowtag-bits)))
338 (old-free-word-index (gspace-free-word-index gspace))
339 (new-free-word-index (+ old-free-word-index
340 (ash bytes (- sb!vm:word-shift)))))
341 ;; Grow GSPACE as necessary until it's big enough to handle
342 ;; NEW-FREE-WORD-INDEX.
344 ((>= (bvlength (gspace-bytes gspace))
345 (* new-free-word-index sb!vm:n-word-bytes)))
346 (expand-bigvec (gspace-bytes gspace)))
347 ;; Now that GSPACE is big enough, we can meaningfully grab a chunk of it.
348 (setf (gspace-free-word-index gspace) new-free-word-index)
349 (let ((ptr (+ (gspace-word-address gspace) old-free-word-index)))
350 (make-descriptor (ash ptr (- sb!vm:word-shift descriptor-low-bits))
351 (logior (ash (logand ptr
353 (- descriptor-low-bits
358 old-free-word-index))))
360 (defun descriptor-lowtag (des)
362 "the lowtag bits for DES"
363 (logand (descriptor-low des) sb!vm:lowtag-mask))
365 (defun descriptor-bits (des)
366 (logior (ash (descriptor-high des) descriptor-low-bits)
367 (descriptor-low des)))
369 (defun descriptor-fixnum (des)
370 (let ((bits (descriptor-bits des)))
371 (if (logbitp (1- sb!vm:n-word-bits) bits)
372 ;; KLUDGE: The (- SB!VM:N-WORD-BITS 2) term here looks right to
373 ;; me, and it works, but in CMU CL it was (1- SB!VM:N-WORD-BITS),
374 ;; and although that doesn't make sense for me, or work for me,
375 ;; it's hard to see how it could have been wrong, since CMU CL
376 ;; genesis worked. It would be nice to understand how this came
377 ;; to be.. -- WHN 19990901
378 (logior (ash bits (- 1 sb!vm:n-lowtag-bits))
379 (ash -1 (1+ sb!vm:n-positive-fixnum-bits)))
380 (ash bits (- 1 sb!vm:n-lowtag-bits)))))
382 (defun descriptor-word-sized-integer (des)
383 ;; Extract an (unsigned-byte 32), from either its fixnum or bignum
385 (let ((lowtag (descriptor-lowtag des)))
386 (if (or (= lowtag sb!vm:even-fixnum-lowtag)
387 (= lowtag sb!vm:odd-fixnum-lowtag))
388 (make-random-descriptor (descriptor-fixnum des))
389 (read-wordindexed des 1))))
392 (defun descriptor-bytes (des)
393 (gspace-bytes (descriptor-intuit-gspace des)))
394 (defun descriptor-byte-offset (des)
395 (ash (descriptor-word-offset des) sb!vm:word-shift))
397 ;;; If DESCRIPTOR-GSPACE is already set, just return that. Otherwise,
398 ;;; figure out a GSPACE which corresponds to DES, set it into
399 ;;; (DESCRIPTOR-GSPACE DES), set a consistent value into
400 ;;; (DESCRIPTOR-WORD-OFFSET DES), and return the GSPACE.
401 (declaim (ftype (function (descriptor) gspace) descriptor-intuit-gspace))
402 (defun descriptor-intuit-gspace (des)
403 (if (descriptor-gspace des)
404 (descriptor-gspace des)
405 ;; KLUDGE: It's not completely clear to me what's going on here;
406 ;; this is a literal translation from of some rather mysterious
407 ;; code from CMU CL's DESCRIPTOR-SAP function. Some explanation
408 ;; would be nice. -- WHN 19990817
409 (let ((lowtag (descriptor-lowtag des))
410 (high (descriptor-high des))
411 (low (descriptor-low des)))
412 (if (or (eql lowtag sb!vm:fun-pointer-lowtag)
413 (eql lowtag sb!vm:instance-pointer-lowtag)
414 (eql lowtag sb!vm:list-pointer-lowtag)
415 (eql lowtag sb!vm:other-pointer-lowtag))
416 (dolist (gspace (list *dynamic* *static* *read-only*)
417 (error "couldn't find a GSPACE for ~S" des))
418 ;; This code relies on the fact that GSPACEs are aligned
419 ;; such that the descriptor-low-bits low bits are zero.
420 (when (and (>= high (ash (gspace-word-address gspace)
421 (- sb!vm:word-shift descriptor-low-bits)))
422 (<= high (ash (+ (gspace-word-address gspace)
423 (gspace-free-word-index gspace))
424 (- sb!vm:word-shift descriptor-low-bits))))
425 (setf (descriptor-gspace des) gspace)
426 (setf (descriptor-word-offset des)
427 (+ (ash (- high (ash (gspace-word-address gspace)
429 descriptor-low-bits)))
430 (- descriptor-low-bits sb!vm:word-shift))
431 (ash (logandc2 low sb!vm:lowtag-mask)
432 (- sb!vm:word-shift))))
434 (error "don't even know how to look for a GSPACE for ~S" des)))))
436 (defun make-random-descriptor (value)
437 (make-descriptor (logand (ash value (- descriptor-low-bits))
440 descriptor-low-bits))))
441 (logand value (1- (ash 1 descriptor-low-bits)))))
443 (defun make-fixnum-descriptor (num)
444 (when (>= (integer-length num)
445 (1+ (- sb!vm:n-word-bits sb!vm:n-lowtag-bits)))
446 (error "~W is too big for a fixnum." num))
447 (make-random-descriptor (ash num (1- sb!vm:n-lowtag-bits))))
449 (defun make-other-immediate-descriptor (data type)
450 (make-descriptor (ash data (- sb!vm:n-widetag-bits descriptor-low-bits))
451 (logior (logand (ash data (- descriptor-low-bits
452 sb!vm:n-widetag-bits))
453 (1- (ash 1 descriptor-low-bits)))
456 (defun make-character-descriptor (data)
457 (make-other-immediate-descriptor data sb!vm:character-widetag))
459 (defun descriptor-beyond (des offset type)
460 (let* ((low (logior (+ (logandc2 (descriptor-low des) sb!vm:lowtag-mask)
463 (high (+ (descriptor-high des)
464 (ash low (- descriptor-low-bits)))))
465 (make-descriptor high (logand low (1- (ash 1 descriptor-low-bits))))))
467 ;;;; miscellaneous variables and other noise
469 ;;; a numeric value to be returned for undefined foreign symbols, or NIL if
470 ;;; undefined foreign symbols are to be treated as an error.
471 ;;; (In the first pass of GENESIS, needed to create a header file before
472 ;;; the C runtime can be built, various foreign symbols will necessarily
473 ;;; be undefined, but we don't need actual values for them anyway, and
474 ;;; we can just use 0 or some other placeholder. In the second pass of
475 ;;; GENESIS, all foreign symbols should be defined, so any undefined
476 ;;; foreign symbol is a problem.)
478 ;;; KLUDGE: It would probably be cleaner to rewrite GENESIS so that it
479 ;;; never tries to look up foreign symbols in the first place unless
480 ;;; it's actually creating a core file (as in the second pass) instead
481 ;;; of using this hack to allow it to go through the motions without
482 ;;; causing an error. -- WHN 20000825
483 (defvar *foreign-symbol-placeholder-value*)
485 ;;; a handle on the trap object
486 (defvar *unbound-marker*)
487 ;; was: (make-other-immediate-descriptor 0 sb!vm:unbound-marker-widetag)
489 ;;; a handle on the NIL object
490 (defvar *nil-descriptor*)
492 ;;; the head of a list of TOPLEVEL-THINGs describing stuff to be done
493 ;;; when the target Lisp starts up
495 ;;; Each TOPLEVEL-THING can be a function to be executed or a fixup or
496 ;;; loadtime value, represented by (CONS KEYWORD ..). The FILENAME
497 ;;; tells which fasl file each list element came from, for debugging
499 (defvar *current-reversed-cold-toplevels*)
501 ;;; the name of the object file currently being cold loaded (as a string, not a
502 ;;; pathname), or NIL if we're not currently cold loading any object file
503 (defvar *cold-load-filename* nil)
504 (declaim (type (or string null) *cold-load-filename*))
506 ;;;; miscellaneous stuff to read and write the core memory
508 ;;; FIXME: should be DEFINE-MODIFY-MACRO
509 (defmacro cold-push (thing list)
511 "Push THING onto the given cold-load LIST."
512 `(setq ,list (cold-cons ,thing ,list)))
514 (declaim (ftype (function (descriptor sb!vm:word) descriptor) read-wordindexed))
515 (defun read-wordindexed (address index)
517 "Return the value which is displaced by INDEX words from ADDRESS."
518 (let* ((gspace (descriptor-intuit-gspace address))
519 (bytes (gspace-bytes gspace))
520 (byte-index (ash (+ index (descriptor-word-offset address))
522 (value (bvref-word bytes byte-index)))
523 (make-random-descriptor value)))
525 (declaim (ftype (function (descriptor) descriptor) read-memory))
526 (defun read-memory (address)
528 "Return the value at ADDRESS."
529 (read-wordindexed address 0))
531 ;;; (Note: In CMU CL, this function expected a SAP-typed ADDRESS
532 ;;; value, instead of the SAP-INT we use here.)
533 (declaim (ftype (function (sb!vm:word descriptor) (values))
534 note-load-time-value-reference))
535 (defun note-load-time-value-reference (address marker)
536 (cold-push (cold-cons
537 (cold-intern :load-time-value-fixup)
538 (cold-cons (sap-int-to-core address)
540 (number-to-core (descriptor-word-offset marker))
542 *current-reversed-cold-toplevels*)
545 (declaim (ftype (function (descriptor sb!vm:word descriptor)) write-wordindexed))
546 (defun write-wordindexed (address index value)
548 "Write VALUE displaced INDEX words from ADDRESS."
549 ;; KLUDGE: There is an algorithm (used in DESCRIPTOR-INTUIT-GSPACE)
550 ;; for calculating the value of the GSPACE slot from scratch. It
551 ;; doesn't work for all values, only some of them, but mightn't it
552 ;; be reasonable to see whether it works on VALUE before we give up
553 ;; because (DESCRIPTOR-GSPACE VALUE) isn't set? (Or failing that,
554 ;; perhaps write a comment somewhere explaining why it's not a good
555 ;; idea?) -- WHN 19990817
556 (if (and (null (descriptor-gspace value))
557 (not (null (descriptor-word-offset value))))
558 (note-load-time-value-reference (+ (logandc2 (descriptor-bits address)
560 (ash index sb!vm:word-shift))
562 (let* ((bytes (gspace-bytes (descriptor-intuit-gspace address)))
563 (byte-index (ash (+ index (descriptor-word-offset address))
565 (setf (bvref-word bytes byte-index)
566 (descriptor-bits value)))))
568 (declaim (ftype (function (descriptor descriptor)) write-memory))
569 (defun write-memory (address value)
571 "Write VALUE (a DESCRIPTOR) at ADDRESS (also a DESCRIPTOR)."
572 (write-wordindexed address 0 value))
574 ;;;; allocating images of primitive objects in the cold core
576 ;;; There are three kinds of blocks of memory in the type system:
577 ;;; * Boxed objects (cons cells, structures, etc): These objects have no
578 ;;; header as all slots are descriptors.
579 ;;; * Unboxed objects (bignums): There is a single header word that contains
581 ;;; * Vector objects: There is a header word with the type, then a word for
582 ;;; the length, then the data.
583 (defun allocate-boxed-object (gspace length lowtag)
585 "Allocate LENGTH words in GSPACE and return a new descriptor of type LOWTAG
587 (allocate-cold-descriptor gspace (ash length sb!vm:word-shift) lowtag))
588 (defun allocate-unboxed-object (gspace element-bits length type)
590 "Allocate LENGTH units of ELEMENT-BITS bits plus a header word in GSPACE and
591 return an ``other-pointer'' descriptor to them. Initialize the header word
592 with the resultant length and TYPE."
593 (let* ((bytes (/ (* element-bits length) sb!vm:n-byte-bits))
594 (des (allocate-cold-descriptor gspace
595 (+ bytes sb!vm:n-word-bytes)
596 sb!vm:other-pointer-lowtag)))
598 (make-other-immediate-descriptor (ash bytes
599 (- sb!vm:word-shift))
602 (defun allocate-vector-object (gspace element-bits length type)
604 "Allocate LENGTH units of ELEMENT-BITS size plus a header plus a length slot in
605 GSPACE and return an ``other-pointer'' descriptor to them. Initialize the
606 header word with TYPE and the length slot with LENGTH."
607 ;; FIXME: Here and in ALLOCATE-UNBOXED-OBJECT, BYTES is calculated using
608 ;; #'/ instead of #'CEILING, which seems wrong.
609 (let* ((bytes (/ (* element-bits length) sb!vm:n-byte-bits))
610 (des (allocate-cold-descriptor gspace
611 (+ bytes (* 2 sb!vm:n-word-bytes))
612 sb!vm:other-pointer-lowtag)))
613 (write-memory des (make-other-immediate-descriptor 0 type))
614 (write-wordindexed des
615 sb!vm:vector-length-slot
616 (make-fixnum-descriptor length))
619 ;;;; copying simple objects into the cold core
621 (defun base-string-to-core (string &optional (gspace *dynamic*))
623 "Copy STRING (which must only contain STANDARD-CHARs) into the cold
624 core and return a descriptor to it."
625 ;; (Remember that the system convention for storage of strings leaves an
626 ;; extra null byte at the end to aid in call-out to C.)
627 (let* ((length (length string))
628 (des (allocate-vector-object gspace
631 sb!vm:simple-base-string-widetag))
632 (bytes (gspace-bytes gspace))
633 (offset (+ (* sb!vm:vector-data-offset sb!vm:n-word-bytes)
634 (descriptor-byte-offset des))))
635 (write-wordindexed des
636 sb!vm:vector-length-slot
637 (make-fixnum-descriptor length))
639 (setf (bvref bytes (+ offset i))
640 (sb!xc:char-code (aref string i))))
641 (setf (bvref bytes (+ offset length))
642 0) ; null string-termination character for C
645 (defun bignum-to-core (n)
647 "Copy a bignum to the cold core."
648 (let* ((words (ceiling (1+ (integer-length n)) sb!vm:n-word-bits))
649 (handle (allocate-unboxed-object *dynamic*
652 sb!vm:bignum-widetag)))
653 (declare (fixnum words))
654 (do ((index 1 (1+ index))
655 (remainder n (ash remainder (- sb!vm:n-word-bits))))
657 (unless (zerop (integer-length remainder))
658 ;; FIXME: Shouldn't this be a fatal error?
659 (warn "~W words of ~W were written, but ~W bits were left over."
661 (let ((word (ldb (byte sb!vm:n-word-bits 0) remainder)))
662 (write-wordindexed handle index
663 (make-descriptor (ash word (- descriptor-low-bits))
664 (ldb (byte descriptor-low-bits 0)
668 (defun number-pair-to-core (first second type)
670 "Makes a number pair of TYPE (ratio or complex) and fills it in."
671 (let ((des (allocate-unboxed-object *dynamic* sb!vm:n-word-bits 2 type)))
672 (write-wordindexed des 1 first)
673 (write-wordindexed des 2 second)
676 (defun write-double-float-bits (address index x)
677 (let ((hi (double-float-high-bits x))
678 (lo (double-float-low-bits x)))
679 (ecase sb!vm::n-word-bits
681 (let ((high-bits (make-random-descriptor hi))
682 (low-bits (make-random-descriptor lo)))
683 (ecase sb!c:*backend-byte-order*
685 (write-wordindexed address index low-bits)
686 (write-wordindexed address (1+ index) high-bits))
688 (write-wordindexed address index high-bits)
689 (write-wordindexed address (1+ index) low-bits)))))
691 (let ((bits (make-random-descriptor
692 (ecase sb!c:*backend-byte-order*
693 (:little-endian (logior lo (ash hi 32)))
695 #+nil (:big-endian (logior (logand hi #xffffffff)
697 (write-wordindexed address index bits))))
700 (defun float-to-core (x)
703 ;; 64-bit platforms have immediate single-floats.
704 #!+#.(cl:if (cl:= sb!vm:n-word-bits 64) '(and) '(or))
705 (make-random-descriptor (logior (ash (single-float-bits x) 32)
706 sb!vm::single-float-widetag))
707 #!-#.(cl:if (cl:= sb!vm:n-word-bits 64) '(and) '(or))
708 (let ((des (allocate-unboxed-object *dynamic*
710 (1- sb!vm:single-float-size)
711 sb!vm:single-float-widetag)))
712 (write-wordindexed des
713 sb!vm:single-float-value-slot
714 (make-random-descriptor (single-float-bits x)))
717 (let ((des (allocate-unboxed-object *dynamic*
719 (1- sb!vm:double-float-size)
720 sb!vm:double-float-widetag)))
721 (write-double-float-bits des sb!vm:double-float-value-slot x)))))
723 (defun complex-single-float-to-core (num)
724 (declare (type (complex single-float) num))
725 (let ((des (allocate-unboxed-object *dynamic* sb!vm:n-word-bits
726 (1- sb!vm:complex-single-float-size)
727 sb!vm:complex-single-float-widetag)))
728 (write-wordindexed des sb!vm:complex-single-float-real-slot
729 (make-random-descriptor (single-float-bits (realpart num))))
730 (write-wordindexed des sb!vm:complex-single-float-imag-slot
731 (make-random-descriptor (single-float-bits (imagpart num))))
734 (defun complex-double-float-to-core (num)
735 (declare (type (complex double-float) num))
736 (let ((des (allocate-unboxed-object *dynamic* sb!vm:n-word-bits
737 (1- sb!vm:complex-double-float-size)
738 sb!vm:complex-double-float-widetag)))
739 (write-double-float-bits des sb!vm:complex-double-float-real-slot
741 (write-double-float-bits des sb!vm:complex-double-float-imag-slot
744 ;;; Copy the given number to the core.
745 (defun number-to-core (number)
747 (integer (if (< (integer-length number)
748 (- (1+ sb!vm:n-word-bits) sb!vm:n-lowtag-bits))
749 (make-fixnum-descriptor number)
750 (bignum-to-core number)))
751 (ratio (number-pair-to-core (number-to-core (numerator number))
752 (number-to-core (denominator number))
753 sb!vm:ratio-widetag))
754 ((complex single-float) (complex-single-float-to-core number))
755 ((complex double-float) (complex-double-float-to-core number))
757 ((complex long-float)
758 (error "~S isn't a cold-loadable number at all!" number))
759 (complex (number-pair-to-core (number-to-core (realpart number))
760 (number-to-core (imagpart number))
761 sb!vm:complex-widetag))
762 (float (float-to-core number))
763 (t (error "~S isn't a cold-loadable number at all!" number))))
765 (declaim (ftype (function (sb!vm:word) descriptor) sap-int-to-core))
766 (defun sap-int-to-core (sap-int)
767 (let ((des (allocate-unboxed-object *dynamic*
771 (write-wordindexed des
772 sb!vm:sap-pointer-slot
773 (make-random-descriptor sap-int))
776 ;;; Allocate a cons cell in GSPACE and fill it in with CAR and CDR.
777 (defun cold-cons (car cdr &optional (gspace *dynamic*))
778 (let ((dest (allocate-boxed-object gspace 2 sb!vm:list-pointer-lowtag)))
779 (write-memory dest car)
780 (write-wordindexed dest 1 cdr)
783 ;;; Make a simple-vector on the target that holds the specified
784 ;;; OBJECTS, and return its descriptor.
785 (defun vector-in-core (&rest objects)
786 (let* ((size (length objects))
787 (result (allocate-vector-object *dynamic* sb!vm:n-word-bits size
788 sb!vm:simple-vector-widetag)))
789 (dotimes (index size)
790 (write-wordindexed result (+ index sb!vm:vector-data-offset)
796 ;;; FIXME: This should be a &KEY argument of ALLOCATE-SYMBOL.
797 (defvar *cold-symbol-allocation-gspace* nil)
799 ;;; Allocate (and initialize) a symbol.
800 (defun allocate-symbol (name)
801 (declare (simple-string name))
802 (let ((symbol (allocate-unboxed-object (or *cold-symbol-allocation-gspace*
805 (1- sb!vm:symbol-size)
806 sb!vm:symbol-header-widetag)))
807 (write-wordindexed symbol sb!vm:symbol-value-slot *unbound-marker*)
808 (write-wordindexed symbol
809 sb!vm:symbol-hash-slot
810 (make-fixnum-descriptor 0))
811 (write-wordindexed symbol sb!vm:symbol-plist-slot *nil-descriptor*)
812 (write-wordindexed symbol sb!vm:symbol-name-slot
813 (base-string-to-core name *dynamic*))
814 (write-wordindexed symbol sb!vm:symbol-package-slot *nil-descriptor*)
817 ;;; Set the cold symbol value of SYMBOL-OR-SYMBOL-DES, which can be either a
818 ;;; descriptor of a cold symbol or (in an abbreviation for the
819 ;;; most common usage pattern) an ordinary symbol, which will be
820 ;;; automatically cold-interned.
821 (declaim (ftype (function ((or descriptor symbol) descriptor)) cold-set))
822 (defun cold-set (symbol-or-symbol-des value)
823 (let ((symbol-des (etypecase symbol-or-symbol-des
824 (descriptor symbol-or-symbol-des)
825 (symbol (cold-intern symbol-or-symbol-des)))))
826 (write-wordindexed symbol-des sb!vm:symbol-value-slot value)))
828 ;;;; layouts and type system pre-initialization
830 ;;; Since we want to be able to dump structure constants and
831 ;;; predicates with reference layouts, we need to create layouts at
832 ;;; cold-load time. We use the name to intern layouts by, and dump a
833 ;;; list of all cold layouts in *!INITIAL-LAYOUTS* so that type system
834 ;;; initialization can find them. The only thing that's tricky [sic --
835 ;;; WHN 19990816] is initializing layout's layout, which must point to
838 ;;; a map from class names to lists of
839 ;;; `(,descriptor ,name ,length ,inherits ,depth)
840 ;;; KLUDGE: It would be more understandable and maintainable to use
841 ;;; DEFSTRUCT (:TYPE LIST) here. -- WHN 19990823
842 (defvar *cold-layouts* (make-hash-table :test 'equal))
844 ;;; a map from DESCRIPTOR-BITS of cold layouts to the name, for inverting
846 (defvar *cold-layout-names* (make-hash-table :test 'eql))
848 ;;; FIXME: *COLD-LAYOUTS* and *COLD-LAYOUT-NAMES* should be
849 ;;; initialized by binding in GENESIS.
851 ;;; the descriptor for layout's layout (needed when making layouts)
852 (defvar *layout-layout*)
854 ;;; FIXME: This information should probably be pulled out of the
855 ;;; cross-compiler's tables at genesis time instead of inserted by
856 ;;; hand here as a bare numeric constant.
857 (defconstant target-layout-length 18)
859 ;;; Return a list of names created from the cold layout INHERITS data
861 (defun listify-cold-inherits (x)
862 (let ((len (descriptor-fixnum (read-wordindexed x
863 sb!vm:vector-length-slot))))
866 (let* ((des (read-wordindexed x (+ sb!vm:vector-data-offset index)))
867 (found (gethash (descriptor-bits des) *cold-layout-names*)))
870 (error "unknown descriptor at index ~S (bits = ~8,'0X)"
872 (descriptor-bits des)))))
875 (declaim (ftype (function (symbol descriptor descriptor descriptor descriptor)
878 (defun make-cold-layout (name length inherits depthoid nuntagged)
879 (let ((result (allocate-boxed-object *dynamic*
880 ;; KLUDGE: Why 1+? -- WHN 19990901
881 (1+ target-layout-length)
882 sb!vm:instance-pointer-lowtag)))
884 (make-other-immediate-descriptor
885 target-layout-length sb!vm:instance-header-widetag))
887 ;; KLUDGE: The offsets into LAYOUT below should probably be pulled out
888 ;; of the cross-compiler's tables at genesis time instead of inserted
889 ;; by hand as bare numeric constants. -- WHN ca. 19990901
891 ;; Set slot 0 = the layout of the layout.
892 (write-wordindexed result sb!vm:instance-slots-offset *layout-layout*)
894 ;; Set the immediately following slots = CLOS hash values.
896 ;; Note: CMU CL didn't set these in genesis, but instead arranged
897 ;; for them to be set at cold init time. That resulted in slightly
898 ;; kludgy-looking code, but there were at least two things to be
900 ;; 1. It put the hash values under the control of the target Lisp's
901 ;; RANDOM function, so that CLOS behavior would be nearly
902 ;; deterministic (instead of depending on the implementation of
903 ;; RANDOM in the cross-compilation host, and the state of its
904 ;; RNG when genesis begins).
905 ;; 2. It automatically ensured that all hash values in the target Lisp
906 ;; were part of the same sequence, so that we didn't have to worry
907 ;; about the possibility of the first hash value set in genesis
908 ;; being precisely equal to the some hash value set in cold init time
909 ;; (because the target Lisp RNG has advanced to precisely the same
910 ;; state that the host Lisp RNG was in earlier).
911 ;; Point 1 should not be an issue in practice because of the way we do our
912 ;; build procedure in two steps, so that the SBCL that we end up with has
913 ;; been created by another SBCL (whose RNG is under our control).
914 ;; Point 2 is more of an issue. If ANSI had provided a way to feed
915 ;; entropy into an RNG, we would have no problem: we'd just feed
916 ;; some specialized genesis-time-only pattern into the RNG state
917 ;; before using it. However, they didn't, so we have a slight
918 ;; problem. We address it by generating the hash values using a
919 ;; different algorithm than we use in ordinary operation.
920 (dotimes (i sb!kernel:layout-clos-hash-length)
921 (let (;; The expression here is pretty arbitrary, we just want
922 ;; to make sure that it's not something which is (1)
923 ;; evenly distributed and (2) not foreordained to arise in
924 ;; the target Lisp's (RANDOM-LAYOUT-CLOS-HASH) sequence
925 ;; and show up as the CLOS-HASH value of some other
928 (1+ (mod (logxor (logand (random-layout-clos-hash) 15253)
929 (logandc2 (random-layout-clos-hash) 15253)
931 ;; (The MOD here is defensive programming
932 ;; to make sure we never write an
933 ;; out-of-range value even if some joker
934 ;; sets LAYOUT-CLOS-HASH-MAX to other
935 ;; than 2^n-1 at some time in the
937 sb!kernel:layout-clos-hash-max))))
938 (write-wordindexed result
939 (+ i sb!vm:instance-slots-offset 1)
940 (make-fixnum-descriptor hash-value))))
942 ;; Set other slot values.
943 (let ((base (+ sb!vm:instance-slots-offset
944 sb!kernel:layout-clos-hash-length
946 ;; (Offset 0 is CLASS, "the class this is a layout for", which
947 ;; is uninitialized at this point.)
948 (write-wordindexed result (+ base 1) *nil-descriptor*) ; marked invalid
949 (write-wordindexed result (+ base 2) inherits)
950 (write-wordindexed result (+ base 3) depthoid)
951 (write-wordindexed result (+ base 4) length)
952 (write-wordindexed result (+ base 5) *nil-descriptor*) ; info
953 (write-wordindexed result (+ base 6) *nil-descriptor*) ; pure
954 (write-wordindexed result (+ base 7) nuntagged))
956 (setf (gethash name *cold-layouts*)
959 (descriptor-fixnum length)
960 (listify-cold-inherits inherits)
961 (descriptor-fixnum depthoid)
962 (descriptor-fixnum nuntagged)))
963 (setf (gethash (descriptor-bits result) *cold-layout-names*) name)
967 (defun initialize-layouts ()
969 (clrhash *cold-layouts*)
971 ;; We initially create the layout of LAYOUT itself with NIL as the LAYOUT and
973 (setq *layout-layout* *nil-descriptor*)
974 (setq *layout-layout*
975 (make-cold-layout 'layout
976 (number-to-core target-layout-length)
978 ;; FIXME: hard-coded LAYOUT-DEPTHOID of LAYOUT..
980 ;; no raw slots in LAYOUT:
982 (write-wordindexed *layout-layout*
983 sb!vm:instance-slots-offset
986 ;; Then we create the layouts that we'll need to make a correct INHERITS
987 ;; vector for the layout of LAYOUT itself..
989 ;; FIXME: The various LENGTH and DEPTHOID numbers should be taken from
990 ;; the compiler's tables, not set by hand.
998 (make-cold-layout 'structure-object
1000 (vector-in-core t-layout)
1002 (number-to-core 0)))
1004 (make-cold-layout 'structure!object
1006 (vector-in-core t-layout so-layout)
1008 (number-to-core 0)))
1009 (layout-inherits (vector-in-core t-layout
1013 ;; ..and return to backpatch the layout of LAYOUT.
1014 (setf (fourth (gethash 'layout *cold-layouts*))
1015 (listify-cold-inherits layout-inherits))
1016 (write-wordindexed *layout-layout*
1017 ;; FIXME: hardcoded offset into layout struct
1018 (+ sb!vm:instance-slots-offset
1019 layout-clos-hash-length
1024 ;;;; interning symbols in the cold image
1026 ;;; In order to avoid having to know about the package format, we
1027 ;;; build a data structure in *COLD-PACKAGE-SYMBOLS* that holds all
1028 ;;; interned symbols along with info about their packages. The data
1029 ;;; structure is a list of sublists, where the sublists have the
1030 ;;; following format:
1031 ;;; (<make-package-arglist>
1032 ;;; <internal-symbols>
1033 ;;; <external-symbols>
1034 ;;; <imported-internal-symbols>
1035 ;;; <imported-external-symbols>
1036 ;;; <shadowing-symbols>
1037 ;;; <package-documentation>)
1039 ;;; KLUDGE: It would be nice to implement the sublists as instances of
1040 ;;; a DEFSTRUCT (:TYPE LIST). (They'd still be lists, but at least we'd be
1041 ;;; using mnemonically-named operators to access them, instead of trying
1042 ;;; to remember what THIRD and FIFTH mean, and hoping that we never
1043 ;;; need to change the list layout..) -- WHN 19990825
1045 ;;; an alist from packages to lists of that package's symbols to be dumped
1046 (defvar *cold-package-symbols*)
1047 (declaim (type list *cold-package-symbols*))
1049 ;;; a map from descriptors to symbols, so that we can back up. The key
1050 ;;; is the address in the target core.
1051 (defvar *cold-symbols*)
1052 (declaim (type hash-table *cold-symbols*))
1054 ;;; sanity check for a symbol we're about to create on the target
1056 ;;; Make sure that the symbol has an appropriate package. In
1057 ;;; particular, catch the so-easy-to-make error of typing something
1058 ;;; like SB-KERNEL:%BYTE-BLT in cold sources when what you really
1059 ;;; need is SB!KERNEL:%BYTE-BLT.
1060 (defun package-ok-for-target-symbol-p (package)
1061 (let ((package-name (package-name package)))
1063 ;; Cold interning things in these standard packages is OK. (Cold
1064 ;; interning things in the other standard package, CL-USER, isn't
1065 ;; OK. We just use CL-USER to expose symbols whose homes are in
1066 ;; other packages. Thus, trying to cold intern a symbol whose
1067 ;; home package is CL-USER probably means that a coding error has
1068 ;; been made somewhere.)
1069 (find package-name '("COMMON-LISP" "KEYWORD") :test #'string=)
1070 ;; Cold interning something in one of our target-code packages,
1071 ;; which are ever-so-rigorously-and-elegantly distinguished by
1072 ;; this prefix on their names, is OK too.
1073 (string= package-name "SB!" :end1 3 :end2 3)
1074 ;; This one is OK too, since it ends up being COMMON-LISP on the
1076 (string= package-name "SB-XC")
1077 ;; Anything else looks bad. (maybe COMMON-LISP-USER? maybe an extension
1078 ;; package in the xc host? something we can't think of
1079 ;; a valid reason to cold intern, anyway...)
1082 ;;; like SYMBOL-PACKAGE, but safe for symbols which end up on the target
1084 ;;; Most host symbols we dump onto the target are created by SBCL
1085 ;;; itself, so that as long as we avoid gratuitously
1086 ;;; cross-compilation-unfriendly hacks, it just happens that their
1087 ;;; SYMBOL-PACKAGE in the host system corresponds to their
1088 ;;; SYMBOL-PACKAGE in the target system. However, that's not the case
1089 ;;; in the COMMON-LISP package, where we don't get to create the
1090 ;;; symbols but instead have to use the ones that the xc host created.
1091 ;;; In particular, while ANSI specifies which symbols are exported
1092 ;;; from COMMON-LISP, it doesn't specify that their home packages are
1093 ;;; COMMON-LISP, so the xc host can keep them in random packages which
1094 ;;; don't exist on the target (e.g. CLISP keeping some CL-exported
1095 ;;; symbols in the CLOS package).
1096 (defun symbol-package-for-target-symbol (symbol)
1097 ;; We want to catch weird symbols like CLISP's
1098 ;; CL:FIND-METHOD=CLOS::FIND-METHOD, but we don't want to get
1099 ;; sidetracked by ordinary symbols like :CHARACTER which happen to
1100 ;; have the same SYMBOL-NAME as exports from COMMON-LISP.
1101 (multiple-value-bind (cl-symbol cl-status)
1102 (find-symbol (symbol-name symbol) *cl-package*)
1103 (if (and (eq symbol cl-symbol)
1104 (eq cl-status :external))
1105 ;; special case, to work around possible xc host weirdness
1106 ;; in COMMON-LISP package
1109 (let ((result (symbol-package symbol)))
1110 (aver (package-ok-for-target-symbol-p result))
1113 ;;; Return a handle on an interned symbol. If necessary allocate the
1114 ;;; symbol and record which package the symbol was referenced in. When
1115 ;;; we allocate the symbol, make sure we record a reference to the
1116 ;;; symbol in the home package so that the package gets set.
1117 (defun cold-intern (symbol
1119 (package (symbol-package-for-target-symbol symbol)))
1121 (aver (package-ok-for-target-symbol-p package))
1123 ;; Anything on the cross-compilation host which refers to the target
1124 ;; machinery through the host SB-XC package should be translated to
1125 ;; something on the target which refers to the same machinery
1126 ;; through the target COMMON-LISP package.
1127 (let ((p (find-package "SB-XC")))
1128 (when (eq package p)
1129 (setf package *cl-package*))
1130 (when (eq (symbol-package symbol) p)
1131 (setf symbol (intern (symbol-name symbol) *cl-package*))))
1133 (let (;; Information about each cold-interned symbol is stored
1134 ;; in COLD-INTERN-INFO.
1135 ;; (CAR COLD-INTERN-INFO) = descriptor of symbol
1136 ;; (CDR COLD-INTERN-INFO) = list of packages, other than symbol's
1137 ;; own package, referring to symbol
1138 ;; (*COLD-PACKAGE-SYMBOLS* and *COLD-SYMBOLS* store basically the
1139 ;; same information, but with the mapping running the opposite way.)
1140 (cold-intern-info (get symbol 'cold-intern-info)))
1141 (unless cold-intern-info
1142 (cond ((eq (symbol-package-for-target-symbol symbol) package)
1143 (let ((handle (allocate-symbol (symbol-name symbol))))
1144 (setf (gethash (descriptor-bits handle) *cold-symbols*) symbol)
1145 (when (eq package *keyword-package*)
1146 (cold-set handle handle))
1147 (setq cold-intern-info
1148 (setf (get symbol 'cold-intern-info) (cons handle nil)))))
1150 (cold-intern symbol)
1151 (setq cold-intern-info (get symbol 'cold-intern-info)))))
1152 (unless (or (null package)
1153 (member package (cdr cold-intern-info)))
1154 (push package (cdr cold-intern-info))
1155 (let* ((old-cps-entry (assoc package *cold-package-symbols*))
1156 (cps-entry (or old-cps-entry
1157 (car (push (list package)
1158 *cold-package-symbols*)))))
1159 (unless old-cps-entry
1160 (/show "created *COLD-PACKAGE-SYMBOLS* entry for" package symbol))
1161 (push symbol (rest cps-entry))))
1162 (car cold-intern-info)))
1164 ;;; Construct and return a value for use as *NIL-DESCRIPTOR*.
1165 (defun make-nil-descriptor ()
1166 (let* ((des (allocate-unboxed-object
1171 (result (make-descriptor (descriptor-high des)
1172 (+ (descriptor-low des)
1173 (* 2 sb!vm:n-word-bytes)
1174 (- sb!vm:list-pointer-lowtag
1175 sb!vm:other-pointer-lowtag)))))
1176 (write-wordindexed des
1178 (make-other-immediate-descriptor
1180 sb!vm:symbol-header-widetag))
1181 (write-wordindexed des
1182 (+ 1 sb!vm:symbol-value-slot)
1184 (write-wordindexed des
1185 (+ 2 sb!vm:symbol-value-slot)
1187 (write-wordindexed des
1188 (+ 1 sb!vm:symbol-plist-slot)
1190 (write-wordindexed des
1191 (+ 1 sb!vm:symbol-name-slot)
1192 ;; This is *DYNAMIC*, and DES is *STATIC*,
1193 ;; because that's the way CMU CL did it; I'm
1194 ;; not sure whether there's an underlying
1195 ;; reason. -- WHN 1990826
1196 (base-string-to-core "NIL" *dynamic*))
1197 (write-wordindexed des
1198 (+ 1 sb!vm:symbol-package-slot)
1200 (setf (get nil 'cold-intern-info)
1205 ;;; Since the initial symbols must be allocated before we can intern
1206 ;;; anything else, we intern those here. We also set the value of T.
1207 (defun initialize-non-nil-symbols ()
1209 "Initialize the cold load symbol-hacking data structures."
1210 (let ((*cold-symbol-allocation-gspace* *static*))
1211 ;; Intern the others.
1212 (dolist (symbol sb!vm:*static-symbols*)
1213 (let* ((des (cold-intern symbol))
1214 (offset-wanted (sb!vm:static-symbol-offset symbol))
1215 (offset-found (- (descriptor-low des)
1216 (descriptor-low *nil-descriptor*))))
1217 (unless (= offset-wanted offset-found)
1218 ;; FIXME: should be fatal
1219 (warn "Offset from ~S to ~S is ~W, not ~W"
1224 ;; Establish the value of T.
1225 (let ((t-symbol (cold-intern t)))
1226 (cold-set t-symbol t-symbol))))
1228 ;;; a helper function for FINISH-SYMBOLS: Return a cold alist suitable
1229 ;;; to be stored in *!INITIAL-LAYOUTS*.
1230 (defun cold-list-all-layouts ()
1231 (let ((result *nil-descriptor*))
1232 (maphash (lambda (key stuff)
1233 (cold-push (cold-cons (cold-intern key)
1239 ;;; Establish initial values for magic symbols.
1241 ;;; Scan over all the symbols referenced in each package in
1242 ;;; *COLD-PACKAGE-SYMBOLS* making that for each one there's an
1243 ;;; appropriate entry in the *!INITIAL-SYMBOLS* data structure to
1245 (defun finish-symbols ()
1247 ;; I think the point of setting these functions into SYMBOL-VALUEs
1248 ;; here, instead of using SYMBOL-FUNCTION, is that in CMU CL
1249 ;; SYMBOL-FUNCTION reduces to FDEFINITION, which is a pretty
1250 ;; hairy operation (involving globaldb.lisp etc.) which we don't
1251 ;; want to invoke early in cold init. -- WHN 2001-12-05
1253 ;; FIXME: So OK, that's a reasonable reason to do something weird like
1254 ;; this, but this is still a weird thing to do, and we should change
1255 ;; the names to highlight that something weird is going on. Perhaps
1256 ;; *MAYBE-GC-FUN*, *INTERNAL-ERROR-FUN*, *HANDLE-BREAKPOINT-FUN*,
1257 ;; and *HANDLE-FUN-END-BREAKPOINT-FUN*...
1258 (macrolet ((frob (symbol)
1260 (cold-fdefinition-object (cold-intern ',symbol)))))
1262 (frob internal-error)
1263 #!+win32 (frob handle-win32-exception)
1264 (frob sb!kernel::control-stack-exhausted-error)
1265 (frob sb!kernel::undefined-alien-variable-error)
1266 (frob sb!kernel::undefined-alien-function-error)
1267 (frob sb!kernel::memory-fault-error)
1268 (frob sb!di::handle-breakpoint)
1269 (frob sb!di::handle-fun-end-breakpoint)
1270 #!+sb-thread (frob sb!thread::run-interruption))
1272 (cold-set 'sb!vm::*current-catch-block* (make-fixnum-descriptor 0))
1273 (cold-set 'sb!vm::*current-unwind-protect-block* (make-fixnum-descriptor 0))
1275 (cold-set '*free-interrupt-context-index* (make-fixnum-descriptor 0))
1277 (cold-set '*!initial-layouts* (cold-list-all-layouts))
1279 (/show "dumping packages" (mapcar #'car *cold-package-symbols*))
1280 (let ((initial-symbols *nil-descriptor*))
1281 (dolist (cold-package-symbols-entry *cold-package-symbols*)
1282 (let* ((cold-package (car cold-package-symbols-entry))
1283 (symbols (cdr cold-package-symbols-entry))
1284 (shadows (package-shadowing-symbols cold-package))
1285 (documentation (base-string-to-core (documentation cold-package t)))
1286 (internal *nil-descriptor*)
1287 (external *nil-descriptor*)
1288 (imported-internal *nil-descriptor*)
1289 (imported-external *nil-descriptor*)
1290 (shadowing *nil-descriptor*))
1291 (declare (type package cold-package)) ; i.e. not a target descriptor
1292 (/show "dumping" cold-package symbols)
1294 ;; FIXME: Add assertions here to make sure that inappropriate stuff
1295 ;; isn't being dumped:
1296 ;; * the CL-USER package
1297 ;; * the SB-COLD package
1298 ;; * any internal symbols in the CL package
1299 ;; * basically any package other than CL, KEYWORD, or the packages
1300 ;; in package-data-list.lisp-expr
1301 ;; and that the structure of the KEYWORD package (e.g. whether
1302 ;; any symbols are internal to it) matches what we want in the
1305 ;; FIXME: It seems possible that by looking at the contents of
1306 ;; packages in the target SBCL we could find which symbols in
1307 ;; package-data-lisp.lisp-expr are now obsolete. (If I
1308 ;; understand correctly, only symbols which actually have
1309 ;; definitions or which are otherwise referred to actually end
1310 ;; up in the target packages.)
1312 (dolist (symbol symbols)
1313 (let ((handle (car (get symbol 'cold-intern-info)))
1314 (imported-p (not (eq (symbol-package-for-target-symbol symbol)
1316 (multiple-value-bind (found where)
1317 (find-symbol (symbol-name symbol) cold-package)
1318 (unless (and where (eq found symbol))
1319 (error "The symbol ~S is not available in ~S."
1322 (when (memq symbol shadows)
1323 (cold-push handle shadowing))
1325 (:internal (if imported-p
1326 (cold-push handle imported-internal)
1327 (cold-push handle internal)))
1328 (:external (if imported-p
1329 (cold-push handle imported-external)
1330 (cold-push handle external)))))))
1331 (let ((r *nil-descriptor*))
1332 (cold-push documentation r)
1333 (cold-push shadowing r)
1334 (cold-push imported-external r)
1335 (cold-push imported-internal r)
1336 (cold-push external r)
1337 (cold-push internal r)
1338 (cold-push (make-make-package-args cold-package) r)
1339 ;; FIXME: It would be more space-efficient to use vectors
1340 ;; instead of lists here, and space-efficiency here would be
1341 ;; nice, since it would reduce the peak memory usage in
1342 ;; genesis and cold init.
1343 (cold-push r initial-symbols))))
1344 (cold-set '*!initial-symbols* initial-symbols))
1346 (cold-set '*!initial-fdefn-objects* (list-all-fdefn-objects))
1348 (cold-set '*!reversed-cold-toplevels* *current-reversed-cold-toplevels*)
1352 (cold-set 'sb!vm::*fp-constant-0d0* (number-to-core 0d0))
1353 (cold-set 'sb!vm::*fp-constant-1d0* (number-to-core 1d0))
1354 (cold-set 'sb!vm::*fp-constant-0f0* (number-to-core 0f0))
1355 (cold-set 'sb!vm::*fp-constant-1f0* (number-to-core 1f0))))
1357 ;;; Make a cold list that can be used as the arg list to MAKE-PACKAGE in order
1358 ;;; to make a package that is similar to PKG.
1359 (defun make-make-package-args (pkg)
1360 (let* ((use *nil-descriptor*)
1361 (cold-nicknames *nil-descriptor*)
1362 (res *nil-descriptor*))
1363 (dolist (u (package-use-list pkg))
1364 (when (assoc u *cold-package-symbols*)
1365 (cold-push (base-string-to-core (package-name u)) use)))
1366 (let* ((pkg-name (package-name pkg))
1367 ;; Make the package nickname lists for the standard packages
1368 ;; be the minimum specified by ANSI, regardless of what value
1369 ;; the cross-compilation host happens to use.
1370 (warm-nicknames (cond ((string= pkg-name "COMMON-LISP")
1372 ((string= pkg-name "COMMON-LISP-USER")
1374 ((string= pkg-name "KEYWORD")
1376 ;; For packages other than the
1377 ;; standard packages, the nickname
1378 ;; list was specified by our package
1379 ;; setup code, not by properties of
1380 ;; what cross-compilation host we
1381 ;; happened to use, and we can just
1382 ;; propagate it into the target.
1384 (package-nicknames pkg)))))
1385 (dolist (warm-nickname warm-nicknames)
1386 (cold-push (base-string-to-core warm-nickname) cold-nicknames)))
1388 (cold-push (number-to-core (truncate (package-internal-symbol-count pkg)
1391 (cold-push (cold-intern :internal-symbols) res)
1392 (cold-push (number-to-core (truncate (package-external-symbol-count pkg)
1395 (cold-push (cold-intern :external-symbols) res)
1397 (cold-push cold-nicknames res)
1398 (cold-push (cold-intern :nicknames) res)
1401 (cold-push (cold-intern :use) res)
1403 (cold-push (base-string-to-core (package-name pkg)) res)
1406 ;;;; functions and fdefinition objects
1408 ;;; a hash table mapping from fdefinition names to descriptors of cold
1411 ;;; Note: Since fdefinition names can be lists like '(SETF FOO), and
1412 ;;; we want to have only one entry per name, this must be an 'EQUAL
1413 ;;; hash table, not the default 'EQL.
1414 (defvar *cold-fdefn-objects*)
1416 (defvar *cold-fdefn-gspace* nil)
1418 ;;; Given a cold representation of a symbol, return a warm
1420 (defun warm-symbol (des)
1421 ;; Note that COLD-INTERN is responsible for keeping the
1422 ;; *COLD-SYMBOLS* table up to date, so if DES happens to refer to an
1423 ;; uninterned symbol, the code below will fail. But as long as we
1424 ;; don't need to look up uninterned symbols during bootstrapping,
1426 (multiple-value-bind (symbol found-p)
1427 (gethash (descriptor-bits des) *cold-symbols*)
1428 (declare (type symbol symbol))
1430 (error "no warm symbol"))
1433 ;;; like CL:CAR, CL:CDR, and CL:NULL but for cold values
1434 (defun cold-car (des)
1435 (aver (= (descriptor-lowtag des) sb!vm:list-pointer-lowtag))
1436 (read-wordindexed des sb!vm:cons-car-slot))
1437 (defun cold-cdr (des)
1438 (aver (= (descriptor-lowtag des) sb!vm:list-pointer-lowtag))
1439 (read-wordindexed des sb!vm:cons-cdr-slot))
1440 (defun cold-null (des)
1441 (= (descriptor-bits des)
1442 (descriptor-bits *nil-descriptor*)))
1444 ;;; Given a cold representation of a function name, return a warm
1446 (declaim (ftype (function (descriptor) (or symbol list)) warm-fun-name))
1447 (defun warm-fun-name (des)
1449 (ecase (descriptor-lowtag des)
1450 (#.sb!vm:list-pointer-lowtag
1451 (aver (not (cold-null des))) ; function named NIL? please no..
1452 ;; Do cold (DESTRUCTURING-BIND (COLD-CAR COLD-CADR) DES ..).
1453 (let* ((car-des (cold-car des))
1454 (cdr-des (cold-cdr des))
1455 (cadr-des (cold-car cdr-des))
1456 (cddr-des (cold-cdr cdr-des)))
1457 (aver (cold-null cddr-des))
1458 (list (warm-symbol car-des)
1459 (warm-symbol cadr-des))))
1460 (#.sb!vm:other-pointer-lowtag
1461 (warm-symbol des)))))
1462 (legal-fun-name-or-type-error result)
1465 (defun cold-fdefinition-object (cold-name &optional leave-fn-raw)
1466 (declare (type descriptor cold-name))
1467 (/show0 "/cold-fdefinition-object")
1468 (let ((warm-name (warm-fun-name cold-name)))
1469 (or (gethash warm-name *cold-fdefn-objects*)
1470 (let ((fdefn (allocate-boxed-object (or *cold-fdefn-gspace* *dynamic*)
1471 (1- sb!vm:fdefn-size)
1472 sb!vm:other-pointer-lowtag)))
1474 (setf (gethash warm-name *cold-fdefn-objects*) fdefn)
1475 (write-memory fdefn (make-other-immediate-descriptor
1476 (1- sb!vm:fdefn-size) sb!vm:fdefn-widetag))
1477 (write-wordindexed fdefn sb!vm:fdefn-name-slot cold-name)
1478 (unless leave-fn-raw
1479 (write-wordindexed fdefn sb!vm:fdefn-fun-slot
1481 (write-wordindexed fdefn
1482 sb!vm:fdefn-raw-addr-slot
1483 (make-random-descriptor
1484 (cold-foreign-symbol-address "undefined_tramp"))))
1487 ;;; Handle the at-cold-init-time, fset-for-static-linkage operation
1488 ;;; requested by FOP-FSET.
1489 (defun static-fset (cold-name defn)
1490 (declare (type descriptor cold-name))
1491 (let ((fdefn (cold-fdefinition-object cold-name t))
1492 (type (logand (descriptor-low (read-memory defn)) sb!vm:widetag-mask)))
1493 (write-wordindexed fdefn sb!vm:fdefn-fun-slot defn)
1494 (write-wordindexed fdefn
1495 sb!vm:fdefn-raw-addr-slot
1497 (#.sb!vm:simple-fun-header-widetag
1498 (/show0 "static-fset (simple-fun)")
1502 (make-random-descriptor
1503 (+ (logandc2 (descriptor-bits defn)
1505 (ash sb!vm:simple-fun-code-offset
1506 sb!vm:word-shift))))
1507 (#.sb!vm:closure-header-widetag
1508 (/show0 "/static-fset (closure)")
1509 (make-random-descriptor
1510 (cold-foreign-symbol-address "closure_tramp")))))
1513 (defun initialize-static-fns ()
1514 (let ((*cold-fdefn-gspace* *static*))
1515 (dolist (sym sb!vm:*static-funs*)
1516 (let* ((fdefn (cold-fdefinition-object (cold-intern sym)))
1517 (offset (- (+ (- (descriptor-low fdefn)
1518 sb!vm:other-pointer-lowtag)
1519 (* sb!vm:fdefn-raw-addr-slot sb!vm:n-word-bytes))
1520 (descriptor-low *nil-descriptor*)))
1521 (desired (sb!vm:static-fun-offset sym)))
1522 (unless (= offset desired)
1523 ;; FIXME: should be fatal
1524 (error "Offset from FDEFN ~S to ~S is ~W, not ~W."
1525 sym nil offset desired))))))
1527 (defun list-all-fdefn-objects ()
1528 (let ((result *nil-descriptor*))
1529 (maphash (lambda (key value)
1530 (declare (ignore key))
1531 (cold-push value result))
1532 *cold-fdefn-objects*)
1535 ;;;; fixups and related stuff
1537 ;;; an EQUAL hash table
1538 (defvar *cold-foreign-symbol-table*)
1539 (declaim (type hash-table *cold-foreign-symbol-table*))
1541 ;; Read the sbcl.nm file to find the addresses for foreign-symbols in
1543 (defun load-cold-foreign-symbol-table (filename)
1544 (/show "load-cold-foreign-symbol-table" filename)
1545 (with-open-file (file filename)
1546 (loop for line = (read-line file nil nil)
1548 ;; UNIX symbol tables might have tabs in them, and tabs are
1549 ;; not in Common Lisp STANDARD-CHAR, so there seems to be no
1550 ;; nice portable way to deal with them within Lisp, alas.
1551 ;; Fortunately, it's easy to use UNIX command line tools like
1552 ;; sed to remove the problem, so it's not too painful for us
1553 ;; to push responsibility for converting tabs to spaces out to
1556 ;; Other non-STANDARD-CHARs are problematic for the same reason.
1557 ;; Make sure that there aren't any..
1558 (let ((ch (find-if (lambda (char)
1559 (not (typep char 'standard-char)))
1562 (error "non-STANDARD-CHAR ~S found in foreign symbol table:~%~S"
1565 (setf line (string-trim '(#\space) line))
1566 (let ((p1 (position #\space line :from-end nil))
1567 (p2 (position #\space line :from-end t)))
1568 (if (not (and p1 p2 (< p1 p2)))
1569 ;; KLUDGE: It's too messy to try to understand all
1570 ;; possible output from nm, so we just punt the lines we
1571 ;; don't recognize. We realize that there's some chance
1572 ;; that might get us in trouble someday, so we warn
1574 (warn "ignoring unrecognized line ~S in ~A" line filename)
1575 (multiple-value-bind (value name)
1576 (if (string= "0x" line :end2 2)
1577 (values (parse-integer line :start 2 :end p1 :radix 16)
1578 (subseq line (1+ p2)))
1579 (values (parse-integer line :end p1 :radix 16)
1580 (subseq line (1+ p2))))
1581 (multiple-value-bind (old-value found)
1582 (gethash name *cold-foreign-symbol-table*)
1584 (not (= old-value value)))
1585 (warn "redefining ~S from #X~X to #X~X"
1586 name old-value value)))
1587 (/show "adding to *cold-foreign-symbol-table*:" name value)
1588 (setf (gethash name *cold-foreign-symbol-table*) value))))))
1591 (defun cold-foreign-symbol-address (name)
1592 (or (find-foreign-symbol-in-table name *cold-foreign-symbol-table*)
1593 *foreign-symbol-placeholder-value*
1595 (format *error-output* "~&The foreign symbol table is:~%")
1596 (maphash (lambda (k v)
1597 (format *error-output* "~&~S = #X~8X~%" k v))
1598 *cold-foreign-symbol-table*)
1599 (error "The foreign symbol ~S is undefined." name))))
1601 (defvar *cold-assembler-routines*)
1603 (defvar *cold-assembler-fixups*)
1605 (defun record-cold-assembler-routine (name address)
1606 (/xhow "in RECORD-COLD-ASSEMBLER-ROUTINE" name address)
1607 (push (cons name address)
1608 *cold-assembler-routines*))
1610 (defun record-cold-assembler-fixup (routine
1615 (push (list routine code-object offset kind)
1616 *cold-assembler-fixups*))
1618 (defun lookup-assembler-reference (symbol)
1619 (let ((value (cdr (assoc symbol *cold-assembler-routines*))))
1620 ;; FIXME: Should this be ERROR instead of WARN?
1622 (warn "Assembler routine ~S not defined." symbol))
1625 ;;; The x86 port needs to store code fixups along with code objects if
1626 ;;; they are to be moved, so fixups for code objects in the dynamic
1627 ;;; heap need to be noted.
1629 (defvar *load-time-code-fixups*)
1632 (defun note-load-time-code-fixup (code-object offset value kind)
1633 ;; If CODE-OBJECT might be moved
1634 (when (= (gspace-identifier (descriptor-intuit-gspace code-object))
1635 dynamic-core-space-id)
1636 ;; FIXME: pushed thing should be a structure, not just a list
1637 (push (list code-object offset value kind) *load-time-code-fixups*))
1641 (defun output-load-time-code-fixups ()
1642 (dolist (fixups *load-time-code-fixups*)
1643 (let ((code-object (first fixups))
1644 (offset (second fixups))
1645 (value (third fixups))
1646 (kind (fourth fixups)))
1647 (cold-push (cold-cons
1648 (cold-intern :load-time-code-fixup)
1652 (number-to-core offset)
1654 (number-to-core value)
1657 *nil-descriptor*)))))
1658 *current-reversed-cold-toplevels*))))
1660 ;;; Given a pointer to a code object and an offset relative to the
1661 ;;; tail of the code object's header, return an offset relative to the
1662 ;;; (beginning of the) code object.
1664 ;;; FIXME: It might be clearer to reexpress
1665 ;;; (LET ((X (CALC-OFFSET CODE-OBJECT OFFSET0))) ..)
1667 ;;; (LET ((X (+ OFFSET0 (CODE-OBJECT-HEADER-N-BYTES CODE-OBJECT)))) ..).
1668 (declaim (ftype (function (descriptor sb!vm:word)) calc-offset))
1669 (defun calc-offset (code-object offset-from-tail-of-header)
1670 (let* ((header (read-memory code-object))
1671 (header-n-words (ash (descriptor-bits header)
1672 (- sb!vm:n-widetag-bits)))
1673 (header-n-bytes (ash header-n-words sb!vm:word-shift))
1674 (result (+ offset-from-tail-of-header header-n-bytes)))
1677 (declaim (ftype (function (descriptor sb!vm:word sb!vm:word keyword))
1679 (defun do-cold-fixup (code-object after-header value kind)
1680 (let* ((offset-within-code-object (calc-offset code-object after-header))
1681 (gspace-bytes (descriptor-bytes code-object))
1682 (gspace-byte-offset (+ (descriptor-byte-offset code-object)
1683 offset-within-code-object))
1684 (gspace-byte-address (gspace-byte-address
1685 (descriptor-gspace code-object))))
1686 (ecase +backend-fasl-file-implementation+
1687 ;; See CMU CL source for other formerly-supported architectures
1688 ;; (and note that you have to rewrite them to use BVREF-X
1689 ;; instead of SAP-REF).
1693 (assert (zerop (ldb (byte 2 0) value))))
1695 (let* ((value (if (logbitp 15 value) (+ value (ash 1 16)) value))
1696 (value (if (logbitp 31 value) (+ value (ash 1 32)) value))
1697 (value (if (logbitp 47 value) (+ value (ash 1 48)) value)))
1698 (setf (bvref-8 gspace-bytes gspace-byte-offset)
1699 (ldb (byte 8 48) value)
1700 (bvref-8 gspace-bytes (1+ gspace-byte-offset))
1701 (ldb (byte 8 56) value))))
1703 (let* ((value (if (logbitp 15 value) (+ value (ash 1 16)) value))
1704 (value (if (logbitp 31 value) (+ value (ash 1 32)) value)))
1705 (setf (bvref-8 gspace-bytes gspace-byte-offset)
1706 (ldb (byte 8 32) value)
1707 (bvref-8 gspace-bytes (1+ gspace-byte-offset))
1708 (ldb (byte 8 40) value))))
1710 (let ((value (if (logbitp 15 value) (+ value (ash 1 16)) value)))
1711 (setf (bvref-8 gspace-bytes gspace-byte-offset)
1712 (ldb (byte 8 16) value)
1713 (bvref-8 gspace-bytes (1+ gspace-byte-offset))
1714 (ldb (byte 8 24) value))))
1716 (setf (bvref-8 gspace-bytes gspace-byte-offset)
1717 (ldb (byte 8 0) value)
1718 (bvref-8 gspace-bytes (1+ gspace-byte-offset))
1719 (ldb (byte 8 8) value)))))
1723 (setf (bvref-32 gspace-bytes gspace-byte-offset)
1724 (logior (ash (ldb (byte 11 0) value) 1)
1725 (logand (bvref-32 gspace-bytes gspace-byte-offset)
1728 (let ((low-bits (ldb (byte 11 0) value)))
1729 (assert (<= 0 low-bits (1- (ash 1 4))))
1730 (setf (bvref-32 gspace-bytes gspace-byte-offset)
1731 (logior (ash low-bits 17)
1732 (logand (bvref-32 gspace-bytes gspace-byte-offset)
1735 (setf (bvref-32 gspace-bytes gspace-byte-offset)
1736 (logior (ash (ldb (byte 5 13) value) 16)
1737 (ash (ldb (byte 2 18) value) 14)
1738 (ash (ldb (byte 2 11) value) 12)
1739 (ash (ldb (byte 11 20) value) 1)
1740 (ldb (byte 1 31) value)
1741 (logand (bvref-32 gspace-bytes gspace-byte-offset)
1744 (let ((bits (ldb (byte 9 2) value)))
1745 (assert (zerop (ldb (byte 2 0) value)))
1746 (setf (bvref-32 gspace-bytes gspace-byte-offset)
1747 (logior (ash bits 3)
1748 (logand (bvref-32 gspace-bytes gspace-byte-offset)
1753 (assert (zerop (ash value -28)))
1754 (setf (ldb (byte 26 0)
1755 (bvref-32 gspace-bytes gspace-byte-offset))
1758 (setf (bvref-32 gspace-bytes gspace-byte-offset)
1759 (logior (mask-field (byte 16 16)
1760 (bvref-32 gspace-bytes gspace-byte-offset))
1762 (if (logbitp 15 value) 1 0)))))
1764 (setf (bvref-32 gspace-bytes gspace-byte-offset)
1765 (logior (mask-field (byte 16 16)
1766 (bvref-32 gspace-bytes gspace-byte-offset))
1767 (ldb (byte 16 0) value))))))
1771 (setf (bvref-32 gspace-bytes gspace-byte-offset)
1772 (dpb (ash value -2) (byte 24 2)
1773 (bvref-32 gspace-bytes gspace-byte-offset))))
1775 (let* ((h (ldb (byte 16 16) value))
1776 (l (ldb (byte 16 0) value)))
1777 (setf (bvref-16 gspace-bytes (+ gspace-byte-offset 2))
1778 (if (logbitp 15 l) (ldb (byte 16 0) (1+ h)) h))))
1780 (setf (bvref-16 gspace-bytes (+ gspace-byte-offset 2))
1781 (ldb (byte 16 0) value)))))
1785 (error "can't deal with call fixups yet"))
1787 (setf (bvref-32 gspace-bytes gspace-byte-offset)
1788 (dpb (ldb (byte 22 10) value)
1790 (bvref-32 gspace-bytes gspace-byte-offset))))
1792 (setf (bvref-32 gspace-bytes gspace-byte-offset)
1793 (dpb (ldb (byte 10 0) value)
1795 (bvref-32 gspace-bytes gspace-byte-offset))))))
1797 (let* ((un-fixed-up (bvref-word gspace-bytes
1798 gspace-byte-offset))
1799 (code-object-start-addr (logandc2 (descriptor-bits code-object)
1800 sb!vm:lowtag-mask)))
1801 (assert (= code-object-start-addr
1802 (+ gspace-byte-address
1803 (descriptor-byte-offset code-object))))
1806 (let ((fixed-up (+ value un-fixed-up)))
1807 (setf (bvref-32 gspace-bytes gspace-byte-offset)
1809 ;; comment from CMU CL sources:
1811 ;; Note absolute fixups that point within the object.
1812 ;; KLUDGE: There seems to be an implicit assumption in
1813 ;; the old CMU CL code here, that if it doesn't point
1814 ;; before the object, it must point within the object
1815 ;; (not beyond it). It would be good to add an
1816 ;; explanation of why that's true, or an assertion that
1817 ;; it's really true, or both.
1818 (unless (< fixed-up code-object-start-addr)
1819 (note-load-time-code-fixup code-object
1823 (:relative ; (used for arguments to X86 relative CALL instruction)
1824 (let ((fixed-up (- (+ value un-fixed-up)
1827 4))) ; "length of CALL argument"
1828 (setf (bvref-32 gspace-bytes gspace-byte-offset)
1830 ;; Note relative fixups that point outside the code
1831 ;; object, which is to say all relative fixups, since
1832 ;; relative addressing within a code object never needs
1834 (note-load-time-code-fixup code-object
1840 (defun resolve-assembler-fixups ()
1841 (dolist (fixup *cold-assembler-fixups*)
1842 (let* ((routine (car fixup))
1843 (value (lookup-assembler-reference routine)))
1845 (do-cold-fixup (second fixup) (third fixup) value (fourth fixup))))))
1847 ;;; *COLD-FOREIGN-SYMBOL-TABLE* becomes *!INITIAL-FOREIGN-SYMBOLS* in
1848 ;;; the core. When the core is loaded, !LOADER-COLD-INIT uses this to
1849 ;;; create *STATIC-FOREIGN-SYMBOLS*, which the code in
1850 ;;; target-load.lisp refers to.
1851 (defun foreign-symbols-to-core ()
1852 (let ((result *nil-descriptor*))
1853 (maphash (lambda (symbol value)
1854 (cold-push (cold-cons (base-string-to-core symbol)
1855 (number-to-core value))
1857 *cold-foreign-symbol-table*)
1858 (cold-set (cold-intern 'sb!kernel:*!initial-foreign-symbols*) result))
1859 (let ((result *nil-descriptor*))
1860 (dolist (rtn *cold-assembler-routines*)
1861 (cold-push (cold-cons (cold-intern (car rtn))
1862 (number-to-core (cdr rtn)))
1864 (cold-set (cold-intern '*!initial-assembler-routines*) result)))
1867 ;;;; general machinery for cold-loading FASL files
1869 ;;; FOP functions for cold loading
1870 (defvar *cold-fop-funs*
1871 ;; We start out with a copy of the ordinary *FOP-FUNS*. The ones
1872 ;; which aren't appropriate for cold load will be destructively
1874 (copy-seq *fop-funs*))
1876 (defvar *normal-fop-funs*)
1878 ;;; Cause a fop to have a special definition for cold load.
1880 ;;; This is similar to DEFINE-FOP, but unlike DEFINE-FOP, this version
1881 ;;; (1) looks up the code for this name (created by a previous
1882 ;; DEFINE-FOP) instead of creating a code, and
1883 ;;; (2) stores its definition in the *COLD-FOP-FUNS* vector,
1884 ;;; instead of storing in the *FOP-FUNS* vector.
1885 (defmacro define-cold-fop ((name &key (pushp t) (stackp t)) &rest forms)
1886 (aver (member pushp '(nil t)))
1887 (aver (member stackp '(nil t)))
1888 (let ((code (get name 'fop-code))
1889 (fname (symbolicate "COLD-" name)))
1891 (error "~S is not a defined FOP." name))
1895 `((with-fop-stack ,pushp ,@forms))
1897 (setf (svref *cold-fop-funs* ,code) #',fname))))
1899 (defmacro clone-cold-fop ((name &key (pushp t) (stackp t))
1902 (aver (member pushp '(nil t)))
1903 (aver (member stackp '(nil t)))
1905 (macrolet ((clone-arg () '(read-word-arg)))
1906 (define-cold-fop (,name :pushp ,pushp :stackp ,stackp) ,@forms))
1907 (macrolet ((clone-arg () '(read-byte-arg)))
1908 (define-cold-fop (,small-name :pushp ,pushp :stackp ,stackp) ,@forms))))
1910 ;;; Cause a fop to be undefined in cold load.
1911 (defmacro not-cold-fop (name)
1912 `(define-cold-fop (,name)
1913 (error "The fop ~S is not supported in cold load." ',name)))
1915 ;;; COLD-LOAD loads stuff into the core image being built by calling
1916 ;;; LOAD-AS-FASL with the fop function table rebound to a table of cold
1917 ;;; loading functions.
1918 (defun cold-load (filename)
1920 "Load the file named by FILENAME into the cold load image being built."
1921 (let* ((*normal-fop-funs* *fop-funs*)
1922 (*fop-funs* *cold-fop-funs*)
1923 (*cold-load-filename* (etypecase filename
1925 (pathname (namestring filename)))))
1926 (with-open-file (s filename :element-type '(unsigned-byte 8))
1927 (load-as-fasl s nil nil))))
1929 ;;;; miscellaneous cold fops
1931 (define-cold-fop (fop-misc-trap) *unbound-marker*)
1933 (define-cold-fop (fop-short-character)
1934 (make-character-descriptor (read-byte-arg)))
1936 (define-cold-fop (fop-empty-list) *nil-descriptor*)
1937 (define-cold-fop (fop-truth) (cold-intern t))
1939 (define-cold-fop (fop-normal-load :stackp nil)
1940 (setq *fop-funs* *normal-fop-funs*))
1942 (define-fop (fop-maybe-cold-load 82 :stackp nil)
1943 (when *cold-load-filename*
1944 (setq *fop-funs* *cold-fop-funs*)))
1946 (define-cold-fop (fop-maybe-cold-load :stackp nil))
1948 (clone-cold-fop (fop-struct)
1950 (let* ((size (clone-arg))
1951 (result (allocate-boxed-object *dynamic*
1953 sb!vm:instance-pointer-lowtag))
1954 (layout (pop-stack))
1957 (read-wordindexed layout (+ sb!vm:instance-slots-offset 16))))
1958 (ntagged (- size nuntagged)))
1959 (write-memory result (make-other-immediate-descriptor
1960 size sb!vm:instance-header-widetag))
1961 (write-wordindexed result sb!vm:instance-slots-offset layout)
1962 (do ((index 1 (1+ index)))
1964 (declare (fixnum index))
1965 (write-wordindexed result
1966 (+ index sb!vm:instance-slots-offset)
1967 (if (>= index ntagged)
1968 (descriptor-word-sized-integer (pop-stack))
1972 (define-cold-fop (fop-layout)
1973 (let* ((nuntagged-des (pop-stack))
1974 (length-des (pop-stack))
1975 (depthoid-des (pop-stack))
1976 (cold-inherits (pop-stack))
1978 (old (gethash name *cold-layouts*)))
1979 (declare (type descriptor length-des depthoid-des cold-inherits))
1980 (declare (type symbol name))
1981 ;; If a layout of this name has been defined already
1983 ;; Enforce consistency between the previous definition and the
1984 ;; current definition, then return the previous definition.
1986 ;; FIXME: This would be more maintainable if we used
1987 ;; DEFSTRUCT (:TYPE LIST) to define COLD-LAYOUT. -- WHN 19990825
1988 (old-layout-descriptor
1995 (declare (type descriptor old-layout-descriptor))
1996 (declare (type index old-length old-nuntagged))
1997 (declare (type fixnum old-depthoid))
1998 (declare (type list old-inherits-list))
1999 (aver (eq name old-name))
2000 (let ((length (descriptor-fixnum length-des))
2001 (inherits-list (listify-cold-inherits cold-inherits))
2002 (depthoid (descriptor-fixnum depthoid-des))
2003 (nuntagged (descriptor-fixnum nuntagged-des)))
2004 (unless (= length old-length)
2005 (error "cold loading a reference to class ~S when the compile~%~
2006 time length was ~S and current length is ~S"
2010 (unless (equal inherits-list old-inherits-list)
2011 (error "cold loading a reference to class ~S when the compile~%~
2012 time inherits were ~S~%~
2013 and current inherits are ~S"
2017 (unless (= depthoid old-depthoid)
2018 (error "cold loading a reference to class ~S when the compile~%~
2019 time inheritance depthoid was ~S and current inheritance~%~
2024 (unless (= nuntagged old-nuntagged)
2025 (error "cold loading a reference to class ~S when the compile~%~
2026 time number of untagged slots was ~S and is currently ~S"
2030 old-layout-descriptor)
2031 ;; Make a new definition from scratch.
2032 (make-cold-layout name length-des cold-inherits depthoid-des
2035 ;;;; cold fops for loading symbols
2037 ;;; Load a symbol SIZE characters long from *FASL-INPUT-STREAM* and
2038 ;;; intern that symbol in PACKAGE.
2039 (defun cold-load-symbol (size package)
2040 (let ((string (make-string size)))
2041 (read-string-as-bytes *fasl-input-stream* string)
2042 (cold-intern (intern string package))))
2044 (macrolet ((frob (name pname-len package-len)
2045 `(define-cold-fop (,name)
2046 (let ((index (read-arg ,package-len)))
2048 (cold-load-symbol (read-arg ,pname-len)
2049 (svref *current-fop-table* index)))))))
2050 (frob fop-symbol-in-package-save #.sb!vm:n-word-bytes #.sb!vm:n-word-bytes)
2051 (frob fop-small-symbol-in-package-save 1 #.sb!vm:n-word-bytes)
2052 (frob fop-symbol-in-byte-package-save #.sb!vm:n-word-bytes 1)
2053 (frob fop-small-symbol-in-byte-package-save 1 1))
2055 (clone-cold-fop (fop-lisp-symbol-save)
2056 (fop-lisp-small-symbol-save)
2057 (push-fop-table (cold-load-symbol (clone-arg) *cl-package*)))
2059 (clone-cold-fop (fop-keyword-symbol-save)
2060 (fop-keyword-small-symbol-save)
2061 (push-fop-table (cold-load-symbol (clone-arg) *keyword-package*)))
2063 (clone-cold-fop (fop-uninterned-symbol-save)
2064 (fop-uninterned-small-symbol-save)
2065 (let* ((size (clone-arg))
2066 (name (make-string size)))
2067 (read-string-as-bytes *fasl-input-stream* name)
2068 (let ((symbol-des (allocate-symbol name)))
2069 (push-fop-table symbol-des))))
2071 ;;;; cold fops for loading lists
2073 ;;; Make a list of the top LENGTH things on the fop stack. The last
2074 ;;; cdr of the list is set to LAST.
2075 (defmacro cold-stack-list (length last)
2076 `(do* ((index ,length (1- index))
2077 (result ,last (cold-cons (pop-stack) result)))
2078 ((= index 0) result)
2079 (declare (fixnum index))))
2081 (define-cold-fop (fop-list)
2082 (cold-stack-list (read-byte-arg) *nil-descriptor*))
2083 (define-cold-fop (fop-list*)
2084 (cold-stack-list (read-byte-arg) (pop-stack)))
2085 (define-cold-fop (fop-list-1)
2086 (cold-stack-list 1 *nil-descriptor*))
2087 (define-cold-fop (fop-list-2)
2088 (cold-stack-list 2 *nil-descriptor*))
2089 (define-cold-fop (fop-list-3)
2090 (cold-stack-list 3 *nil-descriptor*))
2091 (define-cold-fop (fop-list-4)
2092 (cold-stack-list 4 *nil-descriptor*))
2093 (define-cold-fop (fop-list-5)
2094 (cold-stack-list 5 *nil-descriptor*))
2095 (define-cold-fop (fop-list-6)
2096 (cold-stack-list 6 *nil-descriptor*))
2097 (define-cold-fop (fop-list-7)
2098 (cold-stack-list 7 *nil-descriptor*))
2099 (define-cold-fop (fop-list-8)
2100 (cold-stack-list 8 *nil-descriptor*))
2101 (define-cold-fop (fop-list*-1)
2102 (cold-stack-list 1 (pop-stack)))
2103 (define-cold-fop (fop-list*-2)
2104 (cold-stack-list 2 (pop-stack)))
2105 (define-cold-fop (fop-list*-3)
2106 (cold-stack-list 3 (pop-stack)))
2107 (define-cold-fop (fop-list*-4)
2108 (cold-stack-list 4 (pop-stack)))
2109 (define-cold-fop (fop-list*-5)
2110 (cold-stack-list 5 (pop-stack)))
2111 (define-cold-fop (fop-list*-6)
2112 (cold-stack-list 6 (pop-stack)))
2113 (define-cold-fop (fop-list*-7)
2114 (cold-stack-list 7 (pop-stack)))
2115 (define-cold-fop (fop-list*-8)
2116 (cold-stack-list 8 (pop-stack)))
2118 ;;;; cold fops for loading vectors
2120 (clone-cold-fop (fop-base-string)
2121 (fop-small-base-string)
2122 (let* ((len (clone-arg))
2123 (string (make-string len)))
2124 (read-string-as-bytes *fasl-input-stream* string)
2125 (base-string-to-core string)))
2128 (clone-cold-fop (fop-character-string)
2129 (fop-small-character-string)
2130 (bug "CHARACTER-STRING dumped by cross-compiler."))
2132 (clone-cold-fop (fop-vector)
2134 (let* ((size (clone-arg))
2135 (result (allocate-vector-object *dynamic*
2138 sb!vm:simple-vector-widetag)))
2139 (do ((index (1- size) (1- index)))
2141 (declare (fixnum index))
2142 (write-wordindexed result
2143 (+ index sb!vm:vector-data-offset)
2147 (define-cold-fop (fop-int-vector)
2148 (let* ((len (read-word-arg))
2149 (sizebits (read-byte-arg))
2150 (type (case sizebits
2151 (0 sb!vm:simple-array-nil-widetag)
2152 (1 sb!vm:simple-bit-vector-widetag)
2153 (2 sb!vm:simple-array-unsigned-byte-2-widetag)
2154 (4 sb!vm:simple-array-unsigned-byte-4-widetag)
2155 (7 (prog1 sb!vm:simple-array-unsigned-byte-7-widetag
2157 (8 sb!vm:simple-array-unsigned-byte-8-widetag)
2158 (15 (prog1 sb!vm:simple-array-unsigned-byte-15-widetag
2159 (setf sizebits 16)))
2160 (16 sb!vm:simple-array-unsigned-byte-16-widetag)
2161 (31 (prog1 sb!vm:simple-array-unsigned-byte-31-widetag
2162 (setf sizebits 32)))
2163 (32 sb!vm:simple-array-unsigned-byte-32-widetag)
2164 #!+#.(cl:if (cl:= 64 sb!vm:n-word-bits) '(and) '(or))
2165 (63 (prog1 sb!vm:simple-array-unsigned-byte-63-widetag
2166 (setf sizebits 64)))
2167 #!+#.(cl:if (cl:= 64 sb!vm:n-word-bits) '(and) '(or))
2168 (64 sb!vm:simple-array-unsigned-byte-64-widetag)
2169 (t (error "losing element size: ~W" sizebits))))
2170 (result (allocate-vector-object *dynamic* sizebits len type))
2171 (start (+ (descriptor-byte-offset result)
2172 (ash sb!vm:vector-data-offset sb!vm:word-shift)))
2174 (ceiling (* len sizebits)
2175 sb!vm:n-byte-bits))))
2176 (read-bigvec-as-sequence-or-die (descriptor-bytes result)
2182 (define-cold-fop (fop-single-float-vector)
2183 (let* ((len (read-word-arg))
2184 (result (allocate-vector-object
2188 sb!vm:simple-array-single-float-widetag))
2189 (start (+ (descriptor-byte-offset result)
2190 (ash sb!vm:vector-data-offset sb!vm:word-shift)))
2191 (end (+ start (* len 4))))
2192 (read-bigvec-as-sequence-or-die (descriptor-bytes result)
2198 (not-cold-fop fop-double-float-vector)
2199 #!+long-float (not-cold-fop fop-long-float-vector)
2200 (not-cold-fop fop-complex-single-float-vector)
2201 (not-cold-fop fop-complex-double-float-vector)
2202 #!+long-float (not-cold-fop fop-complex-long-float-vector)
2204 (define-cold-fop (fop-array)
2205 (let* ((rank (read-word-arg))
2206 (data-vector (pop-stack))
2207 (result (allocate-boxed-object *dynamic*
2208 (+ sb!vm:array-dimensions-offset rank)
2209 sb!vm:other-pointer-lowtag)))
2210 (write-memory result
2211 (make-other-immediate-descriptor rank
2212 sb!vm:simple-array-widetag))
2213 (write-wordindexed result sb!vm:array-fill-pointer-slot *nil-descriptor*)
2214 (write-wordindexed result sb!vm:array-data-slot data-vector)
2215 (write-wordindexed result sb!vm:array-displacement-slot *nil-descriptor*)
2216 (write-wordindexed result sb!vm:array-displaced-p-slot *nil-descriptor*)
2217 (let ((total-elements 1))
2218 (dotimes (axis rank)
2219 (let ((dim (pop-stack)))
2220 (unless (or (= (descriptor-lowtag dim) sb!vm:even-fixnum-lowtag)
2221 (= (descriptor-lowtag dim) sb!vm:odd-fixnum-lowtag))
2222 (error "non-fixnum dimension? (~S)" dim))
2223 (setf total-elements
2225 (logior (ash (descriptor-high dim)
2226 (- descriptor-low-bits
2227 (1- sb!vm:n-lowtag-bits)))
2228 (ash (descriptor-low dim)
2229 (- 1 sb!vm:n-lowtag-bits)))))
2230 (write-wordindexed result
2231 (+ sb!vm:array-dimensions-offset axis)
2233 (write-wordindexed result
2234 sb!vm:array-elements-slot
2235 (make-fixnum-descriptor total-elements)))
2239 ;;;; cold fops for loading numbers
2241 (defmacro define-cold-number-fop (fop)
2242 `(define-cold-fop (,fop :stackp nil)
2243 ;; Invoke the ordinary warm version of this fop to push the
2246 ;; Replace the warm fop result with the cold image of the warm
2249 (let ((number (pop-stack)))
2250 (number-to-core number)))))
2252 (define-cold-number-fop fop-single-float)
2253 (define-cold-number-fop fop-double-float)
2254 (define-cold-number-fop fop-integer)
2255 (define-cold-number-fop fop-small-integer)
2256 (define-cold-number-fop fop-word-integer)
2257 (define-cold-number-fop fop-byte-integer)
2258 (define-cold-number-fop fop-complex-single-float)
2259 (define-cold-number-fop fop-complex-double-float)
2261 (define-cold-fop (fop-ratio)
2262 (let ((den (pop-stack)))
2263 (number-pair-to-core (pop-stack) den sb!vm:ratio-widetag)))
2265 (define-cold-fop (fop-complex)
2266 (let ((im (pop-stack)))
2267 (number-pair-to-core (pop-stack) im sb!vm:complex-widetag)))
2269 ;;;; cold fops for calling (or not calling)
2271 (not-cold-fop fop-eval)
2272 (not-cold-fop fop-eval-for-effect)
2274 (defvar *load-time-value-counter*)
2276 (define-cold-fop (fop-funcall)
2277 (unless (= (read-byte-arg) 0)
2278 (error "You can't FOP-FUNCALL arbitrary stuff in cold load."))
2279 (let ((counter *load-time-value-counter*))
2280 (cold-push (cold-cons
2281 (cold-intern :load-time-value)
2285 (number-to-core counter)
2287 *current-reversed-cold-toplevels*)
2288 (setf *load-time-value-counter* (1+ counter))
2289 (make-descriptor 0 0 nil counter)))
2291 (defun finalize-load-time-value-noise ()
2292 (cold-set (cold-intern '*!load-time-values*)
2293 (allocate-vector-object *dynamic*
2295 *load-time-value-counter*
2296 sb!vm:simple-vector-widetag)))
2298 (define-cold-fop (fop-funcall-for-effect :pushp nil)
2299 (if (= (read-byte-arg) 0)
2300 (cold-push (pop-stack)
2301 *current-reversed-cold-toplevels*)
2302 (error "You can't FOP-FUNCALL arbitrary stuff in cold load.")))
2304 ;;;; cold fops for fixing up circularities
2306 (define-cold-fop (fop-rplaca :pushp nil)
2307 (let ((obj (svref *current-fop-table* (read-word-arg)))
2308 (idx (read-word-arg)))
2309 (write-memory (cold-nthcdr idx obj) (pop-stack))))
2311 (define-cold-fop (fop-rplacd :pushp nil)
2312 (let ((obj (svref *current-fop-table* (read-word-arg)))
2313 (idx (read-word-arg)))
2314 (write-wordindexed (cold-nthcdr idx obj) 1 (pop-stack))))
2316 (define-cold-fop (fop-svset :pushp nil)
2317 (let ((obj (svref *current-fop-table* (read-word-arg)))
2318 (idx (read-word-arg)))
2319 (write-wordindexed obj
2321 (ecase (descriptor-lowtag obj)
2322 (#.sb!vm:instance-pointer-lowtag 1)
2323 (#.sb!vm:other-pointer-lowtag 2)))
2326 (define-cold-fop (fop-structset :pushp nil)
2327 (let ((obj (svref *current-fop-table* (read-word-arg)))
2328 (idx (read-word-arg)))
2329 (write-wordindexed obj (1+ idx) (pop-stack))))
2331 ;;; In the original CMUCL code, this actually explicitly declared PUSHP
2332 ;;; to be T, even though that's what it defaults to in DEFINE-COLD-FOP.
2333 (define-cold-fop (fop-nthcdr)
2334 (cold-nthcdr (read-word-arg) (pop-stack)))
2336 (defun cold-nthcdr (index obj)
2338 (setq obj (read-wordindexed obj 1)))
2341 ;;;; cold fops for loading code objects and functions
2343 ;;; the names of things which have had COLD-FSET used on them already
2344 ;;; (used to make sure that we don't try to statically link a name to
2345 ;;; more than one definition)
2346 (defparameter *cold-fset-warm-names*
2347 ;; This can't be an EQL hash table because names can be conses, e.g.
2349 (make-hash-table :test 'equal))
2351 (define-cold-fop (fop-fset :pushp nil)
2352 (let* ((fn (pop-stack))
2353 (cold-name (pop-stack))
2354 (warm-name (warm-fun-name cold-name)))
2355 (if (gethash warm-name *cold-fset-warm-names*)
2356 (error "duplicate COLD-FSET for ~S" warm-name)
2357 (setf (gethash warm-name *cold-fset-warm-names*) t))
2358 (static-fset cold-name fn)))
2360 (define-cold-fop (fop-fdefinition)
2361 (cold-fdefinition-object (pop-stack)))
2363 (define-cold-fop (fop-sanctify-for-execution)
2366 ;;; Setting this variable shows what code looks like before any
2367 ;;; fixups (or function headers) are applied.
2368 #!+sb-show (defvar *show-pre-fixup-code-p* nil)
2370 ;;; FIXME: The logic here should be converted into a function
2371 ;;; COLD-CODE-FOP-GUTS (NCONST CODE-SIZE) called by DEFINE-COLD-FOP
2372 ;;; FOP-CODE and DEFINE-COLD-FOP FOP-SMALL-CODE, so that
2373 ;;; variable-capture nastiness like (LET ((NCONST ,NCONST) ..) ..)
2374 ;;; doesn't keep me awake at night.
2375 (defmacro define-cold-code-fop (name nconst code-size)
2376 `(define-cold-fop (,name)
2377 (let* ((nconst ,nconst)
2378 (code-size ,code-size)
2379 (raw-header-n-words (+ sb!vm:code-trace-table-offset-slot nconst))
2381 ;; Note: we round the number of constants up to ensure
2382 ;; that the code vector will be properly aligned.
2383 (round-up raw-header-n-words 2))
2384 (des (allocate-cold-descriptor *dynamic*
2385 (+ (ash header-n-words
2388 sb!vm:other-pointer-lowtag)))
2390 (make-other-immediate-descriptor
2391 header-n-words sb!vm:code-header-widetag))
2392 (write-wordindexed des
2393 sb!vm:code-code-size-slot
2394 (make-fixnum-descriptor
2395 (ash (+ code-size (1- (ash 1 sb!vm:word-shift)))
2396 (- sb!vm:word-shift))))
2397 (write-wordindexed des sb!vm:code-entry-points-slot *nil-descriptor*)
2398 (write-wordindexed des sb!vm:code-debug-info-slot (pop-stack))
2399 (when (oddp raw-header-n-words)
2400 (write-wordindexed des
2402 (make-random-descriptor 0)))
2403 (do ((index (1- raw-header-n-words) (1- index)))
2404 ((< index sb!vm:code-trace-table-offset-slot))
2405 (write-wordindexed des index (pop-stack)))
2406 (let* ((start (+ (descriptor-byte-offset des)
2407 (ash header-n-words sb!vm:word-shift)))
2408 (end (+ start code-size)))
2409 (read-bigvec-as-sequence-or-die (descriptor-bytes des)
2414 (when *show-pre-fixup-code-p*
2415 (format *trace-output*
2416 "~&/raw code from code-fop ~W ~W:~%"
2419 (do ((i start (+ i sb!vm:n-word-bytes)))
2421 (format *trace-output*
2422 "/#X~8,'0x: #X~8,'0x~%"
2423 (+ i (gspace-byte-address (descriptor-gspace des)))
2424 (bvref-32 (descriptor-bytes des) i)))))
2427 (define-cold-code-fop fop-code (read-word-arg) (read-word-arg))
2429 (define-cold-code-fop fop-small-code (read-byte-arg) (read-halfword-arg))
2431 (clone-cold-fop (fop-alter-code :pushp nil)
2432 (fop-byte-alter-code)
2433 (let ((slot (clone-arg))
2436 (write-wordindexed code slot value)))
2438 (define-cold-fop (fop-fun-entry)
2439 (let* ((type (pop-stack))
2440 (arglist (pop-stack))
2442 (code-object (pop-stack))
2443 (offset (calc-offset code-object (read-word-arg)))
2444 (fn (descriptor-beyond code-object
2446 sb!vm:fun-pointer-lowtag))
2447 (next (read-wordindexed code-object sb!vm:code-entry-points-slot)))
2448 (unless (zerop (logand offset sb!vm:lowtag-mask))
2449 (error "unaligned function entry: ~S at #X~X" name offset))
2450 (write-wordindexed code-object sb!vm:code-entry-points-slot fn)
2452 (make-other-immediate-descriptor
2453 (ash offset (- sb!vm:word-shift))
2454 sb!vm:simple-fun-header-widetag))
2455 (write-wordindexed fn
2456 sb!vm:simple-fun-self-slot
2457 ;; KLUDGE: Wiring decisions like this in at
2458 ;; this level ("if it's an x86") instead of a
2459 ;; higher level of abstraction ("if it has such
2460 ;; and such relocation peculiarities (which
2461 ;; happen to be confined to the x86)") is bad.
2462 ;; It would be nice if the code were instead
2463 ;; conditional on some more descriptive
2464 ;; feature, :STICKY-CODE or
2465 ;; :LOAD-GC-INTERACTION or something.
2467 ;; FIXME: The X86 definition of the function
2468 ;; self slot breaks everything object.tex says
2469 ;; about it. (As far as I can tell, the X86
2470 ;; definition makes it a pointer to the actual
2471 ;; code instead of a pointer back to the object
2472 ;; itself.) Ask on the mailing list whether
2473 ;; this is documented somewhere, and if not,
2474 ;; try to reverse engineer some documentation.
2476 ;; a pointer back to the function object, as
2477 ;; described in CMU CL
2478 ;; src/docs/internals/object.tex
2481 ;; KLUDGE: a pointer to the actual code of the
2482 ;; object, as described nowhere that I can find
2484 (make-random-descriptor
2485 (+ (descriptor-bits fn)
2486 (- (ash sb!vm:simple-fun-code-offset
2488 ;; FIXME: We should mask out the type
2489 ;; bits, not assume we know what they
2490 ;; are and subtract them out this way.
2491 sb!vm:fun-pointer-lowtag))))
2492 (write-wordindexed fn sb!vm:simple-fun-next-slot next)
2493 (write-wordindexed fn sb!vm:simple-fun-name-slot name)
2494 (write-wordindexed fn sb!vm:simple-fun-arglist-slot arglist)
2495 (write-wordindexed fn sb!vm:simple-fun-type-slot type)
2498 (define-cold-fop (fop-foreign-fixup)
2499 (let* ((kind (pop-stack))
2500 (code-object (pop-stack))
2501 (len (read-byte-arg))
2502 (sym (make-string len)))
2503 (read-string-as-bytes *fasl-input-stream* sym)
2504 (let ((offset (read-word-arg))
2505 (value (cold-foreign-symbol-address sym)))
2506 (do-cold-fixup code-object offset value kind))
2510 (define-cold-fop (fop-foreign-dataref-fixup)
2511 (let* ((kind (pop-stack))
2512 (code-object (pop-stack))
2513 (len (read-byte-arg))
2514 (sym (make-string len)))
2515 (read-string-as-bytes *fasl-input-stream* sym)
2516 (maphash (lambda (k v)
2517 (format *error-output* "~&~S = #X~8X~%" k v))
2518 *cold-foreign-symbol-table*)
2519 (error "shared foreign symbol in cold load: ~S (~S)" sym kind)))
2521 (define-cold-fop (fop-assembler-code)
2522 (let* ((length (read-word-arg))
2524 ;; Note: we round the number of constants up to ensure that
2525 ;; the code vector will be properly aligned.
2526 (round-up sb!vm:code-constants-offset 2))
2527 (des (allocate-cold-descriptor *read-only*
2528 (+ (ash header-n-words
2531 sb!vm:other-pointer-lowtag)))
2533 (make-other-immediate-descriptor
2534 header-n-words sb!vm:code-header-widetag))
2535 (write-wordindexed des
2536 sb!vm:code-code-size-slot
2537 (make-fixnum-descriptor
2538 (ash (+ length (1- (ash 1 sb!vm:word-shift)))
2539 (- sb!vm:word-shift))))
2540 (write-wordindexed des sb!vm:code-entry-points-slot *nil-descriptor*)
2541 (write-wordindexed des sb!vm:code-debug-info-slot *nil-descriptor*)
2543 (let* ((start (+ (descriptor-byte-offset des)
2544 (ash header-n-words sb!vm:word-shift)))
2545 (end (+ start length)))
2546 (read-bigvec-as-sequence-or-die (descriptor-bytes des)
2552 (define-cold-fop (fop-assembler-routine)
2553 (let* ((routine (pop-stack))
2555 (offset (calc-offset des (read-word-arg))))
2556 (record-cold-assembler-routine
2558 (+ (logandc2 (descriptor-bits des) sb!vm:lowtag-mask) offset))
2561 (define-cold-fop (fop-assembler-fixup)
2562 (let* ((routine (pop-stack))
2564 (code-object (pop-stack))
2565 (offset (read-word-arg)))
2566 (record-cold-assembler-fixup routine code-object offset kind)
2569 (define-cold-fop (fop-code-object-fixup)
2570 (let* ((kind (pop-stack))
2571 (code-object (pop-stack))
2572 (offset (read-word-arg))
2573 (value (descriptor-bits code-object)))
2574 (do-cold-fixup code-object offset value kind)
2577 ;;;; emitting C header file
2579 (defun tailwise-equal (string tail)
2580 (and (>= (length string) (length tail))
2581 (string= string tail :start1 (- (length string) (length tail)))))
2583 (defun write-boilerplate ()
2586 '("This is a machine-generated file. Please do not edit it by hand."
2587 "(As of sbcl-0.8.14, it came from WRITE-CONFIG-H in genesis.lisp.)"
2589 "This file contains low-level information about the"
2590 "internals of a particular version and configuration"
2591 "of SBCL. It is used by the C compiler to create a runtime"
2592 "support environment, an executable program in the host"
2593 "operating system's native format, which can then be used to"
2594 "load and run 'core' files, which are basically programs"
2595 "in SBCL's own format."))
2596 (format t " *~@[ ~A~]~%" line))
2599 (defun write-config-h ()
2600 ;; propagating *SHEBANG-FEATURES* into C-level #define's
2601 (dolist (shebang-feature-name (sort (mapcar #'symbol-name
2602 sb-cold:*shebang-features*)
2605 "#define LISP_FEATURE_~A~%"
2606 (substitute #\_ #\- shebang-feature-name)))
2608 ;; and miscellaneous constants
2609 (format t "#define SBCL_CORE_VERSION_INTEGER ~D~%" sbcl-core-version-integer)
2611 "#define SBCL_VERSION_STRING ~S~%"
2612 (sb!xc:lisp-implementation-version))
2613 (format t "#define CORE_MAGIC 0x~X~%" core-magic)
2614 (format t "#ifndef LANGUAGE_ASSEMBLY~2%")
2615 (format t "#define LISPOBJ(x) ((lispobj)x)~2%")
2616 (format t "#else /* LANGUAGE_ASSEMBLY */~2%")
2617 (format t "#define LISPOBJ(thing) thing~2%")
2618 (format t "#endif /* LANGUAGE_ASSEMBLY */~2%")
2621 (defun write-constants-h ()
2622 ;; writing entire families of named constants
2623 (let ((constants nil))
2624 (dolist (package-name '(;; Even in CMU CL, constants from VM
2625 ;; were automatically propagated
2626 ;; into the runtime.
2628 ;; In SBCL, we also propagate various
2629 ;; magic numbers related to file format,
2630 ;; which live here instead of SB!VM.
2632 (do-external-symbols (symbol (find-package package-name))
2633 (when (constantp symbol)
2634 (let ((name (symbol-name symbol)))
2635 (labels (;; shared machinery
2636 (record (string priority)
2639 (symbol-value symbol)
2640 (documentation symbol 'variable))
2642 ;; machinery for old-style CMU CL Lisp-to-C
2643 ;; arbitrary renaming, being phased out in favor of
2644 ;; the newer systematic RECORD-WITH-TRANSLATED-NAME
2646 (record-with-munged-name (prefix string priority)
2647 (record (concatenate
2650 (delete #\- (string-capitalize string)))
2652 (maybe-record-with-munged-name (tail prefix priority)
2653 (when (tailwise-equal name tail)
2654 (record-with-munged-name prefix
2659 ;; machinery for new-style SBCL Lisp-to-C naming
2660 (record-with-translated-name (priority)
2661 (record (substitute #\_ #\- name)
2663 (maybe-record-with-translated-name (suffixes priority)
2664 (when (some (lambda (suffix)
2665 (tailwise-equal name suffix))
2667 (record-with-translated-name priority))))
2669 (maybe-record-with-translated-name '("-LOWTAG") 0)
2670 (maybe-record-with-translated-name '("-WIDETAG") 1)
2671 (maybe-record-with-munged-name "-FLAG" "flag_" 2)
2672 (maybe-record-with-munged-name "-TRAP" "trap_" 3)
2673 (maybe-record-with-munged-name "-SUBTYPE" "subtype_" 4)
2674 (maybe-record-with-munged-name "-SC-NUMBER" "sc_" 5)
2675 (maybe-record-with-translated-name '("-START" "-END" "-SIZE") 6)
2676 (maybe-record-with-translated-name '("-CORE-ENTRY-TYPE-CODE") 7)
2677 (maybe-record-with-translated-name '("-CORE-SPACE-ID") 8))))))
2678 ;; KLUDGE: these constants are sort of important, but there's no
2679 ;; pleasing way to inform the code above about them. So we fake
2680 ;; it for now. nikodemus on #lisp (2004-08-09) suggested simply
2681 ;; exporting every numeric constant from SB!VM; that would work,
2682 ;; but the C runtime would have to be altered to use Lisp-like names
2683 ;; rather than the munged names currently exported. --njf, 2004-08-09
2684 (dolist (c '(sb!vm:n-word-bits sb!vm:n-word-bytes
2685 sb!vm:n-lowtag-bits sb!vm:lowtag-mask
2686 sb!vm:n-widetag-bits sb!vm:widetag-mask
2687 sb!vm:n-fixnum-tag-bits sb!vm:fixnum-tag-mask))
2688 (push (list (substitute #\_ #\- (symbol-name c))
2689 -1 ; invent a new priority
2693 ;; One more symbol that doesn't fit into the code above.
2694 (flet ((translate (name)
2695 (delete #\+ (substitute #\_ #\- name))))
2696 (let ((c 'sb!impl::+magic-hash-vector-value+))
2697 (push (list (translate (symbol-name c))
2705 (lambda (const1 const2)
2706 (if (= (second const1) (second const2))
2707 (< (third const1) (third const2))
2708 (< (second const1) (second const2))))))
2709 (let ((prev-priority (second (car constants))))
2710 (dolist (const constants)
2711 (destructuring-bind (name priority value doc) const
2712 (unless (= prev-priority priority)
2714 (setf prev-priority priority))
2715 (format t "#define ~A " name)
2717 ;; KLUDGE: As of sbcl-0.6.7.14, we're dumping two
2718 ;; different kinds of values here, (1) small codes
2719 ;; and (2) machine addresses. The small codes can be
2720 ;; dumped as bare integer values. The large machine
2721 ;; addresses might cause problems if they're large
2722 ;; and represented as (signed) C integers, so we
2723 ;; want to force them to be unsigned. We do that by
2724 ;; wrapping them in the LISPOBJ macro. (We could do
2725 ;; it with a bare "(unsigned)" cast, except that
2726 ;; this header file is used not only in C files, but
2727 ;; also in assembly files, which don't understand
2728 ;; the cast syntax. The LISPOBJ macro goes away in
2729 ;; assembly files, but that shouldn't matter because
2730 ;; we don't do arithmetic on address constants in
2731 ;; assembly files. See? It really is a kludge..) --
2733 (let (;; cutoff for treatment as a small code
2734 (cutoff (expt 2 16)))
2735 (cond ((minusp value)
2736 (error "stub: negative values unsupported"))
2742 (format t " /* 0x~X */~@[ /* ~A */~]~%" value doc))))
2745 ;; writing information about internal errors
2746 (let ((internal-errors sb!c:*backend-internal-errors*))
2747 (dotimes (i (length internal-errors))
2748 (let ((current-error (aref internal-errors i)))
2749 ;; FIXME: this UNLESS should go away (see also FIXME in
2750 ;; interr.lisp) -- APD, 2002-03-05
2751 (unless (eq nil (car current-error))
2752 (format t "#define ~A ~D~%"
2753 (substitute #\_ #\- (symbol-name (car current-error)))
2757 ;; FIXME: The SPARC has a PSEUDO-ATOMIC-TRAP that differs between
2758 ;; platforms. If we export this from the SB!VM package, it gets
2759 ;; written out as #define trap_PseudoAtomic, which is confusing as
2760 ;; the runtime treats trap_ as the prefix for illegal instruction
2761 ;; type things. We therefore don't export it, but instead do
2763 (when (boundp 'sb!vm::pseudo-atomic-trap)
2765 "#define PSEUDO_ATOMIC_TRAP ~D /* 0x~:*~X */~%"
2766 sb!vm::pseudo-atomic-trap)
2768 ;; possibly this is another candidate for a rename (to
2769 ;; pseudo-atomic-trap-number or pseudo-atomic-magic-constant
2770 ;; [possibly applicable to other platforms])
2772 (dolist (symbol '(sb!vm::float-traps-byte
2773 sb!vm::float-exceptions-byte
2774 sb!vm::float-sticky-bits
2775 sb!vm::float-rounding-mode))
2776 (format t "#define ~A_POSITION ~A /* ~:*0x~X */~%"
2777 (substitute #\_ #\- (symbol-name symbol))
2778 (sb!xc:byte-position (symbol-value symbol)))
2779 (format t "#define ~A_MASK 0x~X /* ~:*~A */~%"
2780 (substitute #\_ #\- (symbol-name symbol))
2781 (sb!xc:mask-field (symbol-value symbol) -1))))
2785 (defun write-primitive-object (obj)
2786 ;; writing primitive object layouts
2787 (format t "#ifndef LANGUAGE_ASSEMBLY~2%")
2791 (string-downcase (string (sb!vm:primitive-object-name obj)))))
2792 (when (sb!vm:primitive-object-widetag obj)
2793 (format t " lispobj header;~%"))
2794 (dolist (slot (sb!vm:primitive-object-slots obj))
2795 (format t " ~A ~A~@[[1]~];~%"
2796 (getf (sb!vm:slot-options slot) :c-type "lispobj")
2798 (string-downcase (string (sb!vm:slot-name slot))))
2799 (sb!vm:slot-rest-p slot)))
2801 (format t "#else /* LANGUAGE_ASSEMBLY */~2%")
2802 (let ((name (sb!vm:primitive-object-name obj))
2803 (lowtag (eval (sb!vm:primitive-object-lowtag obj))))
2805 (dolist (slot (sb!vm:primitive-object-slots obj))
2806 (format t "#define ~A_~A_OFFSET ~D~%"
2807 (substitute #\_ #\- (string name))
2808 (substitute #\_ #\- (string (sb!vm:slot-name slot)))
2809 (- (* (sb!vm:slot-offset slot) sb!vm:n-word-bytes) lowtag)))
2811 (format t "#endif /* LANGUAGE_ASSEMBLY */~2%"))
2813 (defun write-structure-object (dd)
2814 (flet ((cstring (designator)
2817 (substitute #\_ #\- (string-downcase (string designator))))))
2818 (format t "#ifndef LANGUAGE_ASSEMBLY~2%")
2819 (format t "struct ~A {~%" (cstring (dd-name dd)))
2820 (format t " lispobj header;~%")
2821 (format t " lispobj layout;~%")
2822 (dolist (slot (dd-slots dd))
2823 (when (eq t (dsd-raw-type slot))
2824 (format t " lispobj ~A;~%" (cstring (dsd-name slot)))))
2825 (unless (oddp (+ (dd-length dd) (dd-raw-length dd)))
2826 (format t " long raw_slot_padding;~%"))
2827 (dotimes (n (dd-raw-length dd))
2828 (format t " long raw~D;~%" (- (dd-raw-length dd) n 1)))
2830 (format t "#endif /* LANGUAGE_ASSEMBLY */~2%")))
2832 (defun write-static-symbols ()
2833 (dolist (symbol (cons nil sb!vm:*static-symbols*))
2834 ;; FIXME: It would be nice to use longer names than NIL and
2835 ;; (particularly) T in #define statements.
2836 (format t "#define ~A LISPOBJ(0x~X)~%"
2838 (remove-if (lambda (char)
2839 (member char '(#\% #\* #\. #\!)))
2840 (symbol-name symbol)))
2841 (if *static* ; if we ran GENESIS
2842 ;; We actually ran GENESIS, use the real value.
2843 (descriptor-bits (cold-intern symbol))
2844 ;; We didn't run GENESIS, so guess at the address.
2845 (+ sb!vm:static-space-start
2847 sb!vm:other-pointer-lowtag
2848 (if symbol (sb!vm:static-symbol-offset symbol) 0))))))
2851 ;;;; writing map file
2853 ;;; Write a map file describing the cold load. Some of this
2854 ;;; information is subject to change due to relocating GC, but even so
2855 ;;; it can be very handy when attempting to troubleshoot the early
2856 ;;; stages of cold load.
2858 (let ((*print-pretty* nil)
2859 (*print-case* :upcase))
2860 (format t "assembler routines defined in core image:~2%")
2861 (dolist (routine (sort (copy-list *cold-assembler-routines*) #'<
2863 (format t "#X~8,'0X: ~S~%" (cdr routine) (car routine)))
2866 (maphash (lambda (name fdefn)
2867 (let ((fun (read-wordindexed fdefn
2868 sb!vm:fdefn-fun-slot)))
2869 (if (= (descriptor-bits fun)
2870 (descriptor-bits *nil-descriptor*))
2872 (let ((addr (read-wordindexed
2873 fdefn sb!vm:fdefn-raw-addr-slot)))
2874 (push (cons name (descriptor-bits addr))
2876 *cold-fdefn-objects*)
2877 (format t "~%~|~%initially defined functions:~2%")
2878 (setf funs (sort funs #'< :key #'cdr))
2880 (format t "0x~8,'0X: ~S #X~8,'0X~%" (cdr info) (car info)
2881 (- (cdr info) #x17)))
2884 (a note about initially undefined function references: These functions
2885 are referred to by code which is installed by GENESIS, but they are not
2886 installed by GENESIS. This is not necessarily a problem; functions can
2887 be defined later, by cold init toplevel forms, or in files compiled and
2888 loaded at warm init, or elsewhere. As long as they are defined before
2889 they are called, everything should be OK. Things are also OK if the
2890 cross-compiler knew their inline definition and used that everywhere
2891 that they were called before the out-of-line definition is installed,
2892 as is fairly common for structure accessors.)
2893 initially undefined function references:~2%")
2895 (setf undefs (sort undefs #'string< :key #'fun-name-block-name))
2896 (dolist (name undefs)
2897 (format t "~S~%" name)))
2899 (format t "~%~|~%layout names:~2%")
2901 (maphash (lambda (name gorp)
2902 (declare (ignore name))
2903 (stuff (cons (descriptor-bits (car gorp))
2906 (dolist (x (sort (stuff) #'< :key #'car))
2907 (apply #'format t "~8,'0X: ~S[~D]~%~10T~S~%" x))))
2911 ;;;; writing core file
2913 (defvar *core-file*)
2914 (defvar *data-page*)
2916 ;;; magic numbers to identify entries in a core file
2918 ;;; (In case you were wondering: No, AFAIK there's no special magic about
2919 ;;; these which requires them to be in the 38xx range. They're just
2920 ;;; arbitrary words, tested not for being in a particular range but just
2921 ;;; for equality. However, if you ever need to look at a .core file and
2922 ;;; figure out what's going on, it's slightly convenient that they're
2923 ;;; all in an easily recognizable range, and displacing the range away from
2924 ;;; zero seems likely to reduce the chance that random garbage will be
2925 ;;; misinterpreted as a .core file.)
2926 (defconstant version-core-entry-type-code 3860)
2927 (defconstant build-id-core-entry-type-code 3899)
2928 (defconstant new-directory-core-entry-type-code 3861)
2929 (defconstant initial-fun-core-entry-type-code 3863)
2930 (defconstant page-table-core-entry-type-code 3880)
2931 (defconstant end-core-entry-type-code 3840)
2933 (declaim (ftype (function (sb!vm:word) sb!vm:word) write-word))
2934 (defun write-word (num)
2935 (ecase sb!c:*backend-byte-order*
2937 (dotimes (i sb!vm:n-word-bytes)
2938 (write-byte (ldb (byte 8 (* i 8)) num) *core-file*)))
2940 (dotimes (i sb!vm:n-word-bytes)
2941 (write-byte (ldb (byte 8 (* (- (1- sb!vm:n-word-bytes) i) 8)) num)
2945 (defun advance-to-page ()
2946 (force-output *core-file*)
2947 (file-position *core-file*
2948 (round-up (file-position *core-file*)
2949 sb!c:*backend-page-size*)))
2951 (defun output-gspace (gspace)
2952 (force-output *core-file*)
2953 (let* ((posn (file-position *core-file*))
2954 (bytes (* (gspace-free-word-index gspace) sb!vm:n-word-bytes))
2955 (pages (ceiling bytes sb!c:*backend-page-size*))
2956 (total-bytes (* pages sb!c:*backend-page-size*)))
2958 (file-position *core-file*
2959 (* sb!c:*backend-page-size* (1+ *data-page*)))
2961 "writing ~S byte~:P [~S page~:P] from ~S~%"
2967 ;; Note: It is assumed that the GSPACE allocation routines always
2968 ;; allocate whole pages (of size *target-page-size*) and that any
2969 ;; empty gspace between the free pointer and the end of page will
2970 ;; be zero-filled. This will always be true under Mach on machines
2971 ;; where the page size is equal. (RT is 4K, PMAX is 4K, Sun 3 is
2973 (write-bigvec-as-sequence (gspace-bytes gspace)
2976 (force-output *core-file*)
2977 (file-position *core-file* posn)
2979 ;; Write part of a (new) directory entry which looks like this:
2980 ;; GSPACE IDENTIFIER
2985 (write-word (gspace-identifier gspace))
2986 (write-word (gspace-free-word-index gspace))
2987 (write-word *data-page*)
2988 (multiple-value-bind (floor rem)
2989 (floor (gspace-byte-address gspace) sb!c:*backend-page-size*)
2994 (incf *data-page* pages)))
2996 ;;; Create a core file created from the cold loaded image. (This is
2997 ;;; the "initial core file" because core files could be created later
2998 ;;; by executing SAVE-LISP in a running system, perhaps after we've
2999 ;;; added some functionality to the system.)
3000 (declaim (ftype (function (string)) write-initial-core-file))
3001 (defun write-initial-core-file (filename)
3003 (let ((filenamestring (namestring filename))
3007 "[building initial core file in ~S: ~%"
3011 (with-open-file (*core-file* filenamestring
3013 :element-type '(unsigned-byte 8)
3014 :if-exists :rename-and-delete)
3016 ;; Write the magic number.
3017 (write-word core-magic)
3019 ;; Write the Version entry.
3020 (write-word version-core-entry-type-code)
3022 (write-word sbcl-core-version-integer)
3024 ;; Write the build ID.
3025 (write-word build-id-core-entry-type-code)
3026 (let ((build-id (with-open-file (s "output/build-id.tmp"
3029 (declare (type simple-string build-id))
3030 (/show build-id (length build-id))
3031 ;; Write length of build ID record: BUILD-ID-CORE-ENTRY-TYPE-CODE
3032 ;; word, this length word, and one word for each char of BUILD-ID.
3033 (write-word (+ 2 (length build-id)))
3034 (dovector (char build-id)
3035 ;; (We write each character as a word in order to avoid
3036 ;; having to think about word alignment issues in the
3037 ;; sbcl-0.7.8 version of coreparse.c.)
3038 (write-word (sb!xc:char-code char))))
3040 ;; Write the New Directory entry header.
3041 (write-word new-directory-core-entry-type-code)
3042 (write-word 17) ; length = (5 words/space) * 3 spaces + 2 for header.
3044 (output-gspace *read-only*)
3045 (output-gspace *static*)
3046 (output-gspace *dynamic*)
3048 ;; Write the initial function.
3049 (write-word initial-fun-core-entry-type-code)
3051 (let* ((cold-name (cold-intern '!cold-init))
3052 (cold-fdefn (cold-fdefinition-object cold-name))
3053 (initial-fun (read-wordindexed cold-fdefn
3054 sb!vm:fdefn-fun-slot)))
3056 "~&/(DESCRIPTOR-BITS INITIAL-FUN)=#X~X~%"
3057 (descriptor-bits initial-fun))
3058 (write-word (descriptor-bits initial-fun)))
3060 ;; Write the End entry.
3061 (write-word end-core-entry-type-code)
3064 (format t "done]~%")
3066 (/show "leaving WRITE-INITIAL-CORE-FILE")
3069 ;;;; the actual GENESIS function
3071 ;;; Read the FASL files in OBJECT-FILE-NAMES and produce a Lisp core,
3072 ;;; and/or information about a Lisp core, therefrom.
3074 ;;; input file arguments:
3075 ;;; SYMBOL-TABLE-FILE-NAME names a UNIX-style .nm file *with* *any*
3076 ;;; *tab* *characters* *converted* *to* *spaces*. (We push
3077 ;;; responsibility for removing tabs out to the caller it's
3078 ;;; trivial to remove them using UNIX command line tools like
3079 ;;; sed, whereas it's a headache to do it portably in Lisp because
3080 ;;; #\TAB is not a STANDARD-CHAR.) If this file is not supplied,
3081 ;;; a core file cannot be built (but a C header file can be).
3083 ;;; output files arguments (any of which may be NIL to suppress output):
3084 ;;; CORE-FILE-NAME gets a Lisp core.
3085 ;;; C-HEADER-FILE-NAME gets a C header file, traditionally called
3086 ;;; internals.h, which is used by the C compiler when constructing
3087 ;;; the executable which will load the core.
3088 ;;; MAP-FILE-NAME gets (?) a map file. (dunno about this -- WHN 19990815)
3090 ;;; FIXME: GENESIS doesn't belong in SB!VM. Perhaps in %KERNEL for now,
3091 ;;; perhaps eventually in SB-LD or SB-BOOT.
3092 (defun sb!vm:genesis (&key
3094 symbol-table-file-name
3100 "~&beginning GENESIS, ~A~%"
3102 ;; Note: This output summarizing what we're doing is
3103 ;; somewhat telegraphic in style, not meant to imply that
3104 ;; we're not e.g. also creating a header file when we
3106 (format nil "creating core ~S" core-file-name)
3107 (format nil "creating headers in ~S" c-header-dir-name)))
3109 (let ((*cold-foreign-symbol-table* (make-hash-table :test 'equal)))
3111 (when core-file-name
3112 (if symbol-table-file-name
3113 (load-cold-foreign-symbol-table symbol-table-file-name)
3114 (error "can't output a core file without symbol table file input")))
3116 ;; Now that we've successfully read our only input file (by
3117 ;; loading the symbol table, if any), it's a good time to ensure
3118 ;; that there'll be someplace for our output files to go when
3120 (flet ((frob (filename)
3122 (ensure-directories-exist filename :verbose t))))
3123 (frob core-file-name)
3124 (frob map-file-name))
3126 ;; (This shouldn't matter in normal use, since GENESIS normally
3127 ;; only runs once in any given Lisp image, but it could reduce
3128 ;; confusion if we ever experiment with running, tweaking, and
3129 ;; rerunning genesis interactively.)
3130 (do-all-symbols (sym)
3131 (remprop sym 'cold-intern-info))
3133 (let* ((*foreign-symbol-placeholder-value* (if core-file-name nil 0))
3134 (*load-time-value-counter* 0)
3135 (*cold-fdefn-objects* (make-hash-table :test 'equal))
3136 (*cold-symbols* (make-hash-table :test 'equal))
3137 (*cold-package-symbols* nil)
3138 (*read-only* (make-gspace :read-only
3139 read-only-core-space-id
3140 sb!vm:read-only-space-start))
3141 (*static* (make-gspace :static
3142 static-core-space-id
3143 sb!vm:static-space-start))
3144 (*dynamic* (make-gspace :dynamic
3145 dynamic-core-space-id
3146 #!+gencgc sb!vm:dynamic-space-start
3147 #!-gencgc sb!vm:dynamic-0-space-start))
3148 (*nil-descriptor* (make-nil-descriptor))
3149 (*current-reversed-cold-toplevels* *nil-descriptor*)
3150 (*unbound-marker* (make-other-immediate-descriptor
3152 sb!vm:unbound-marker-widetag))
3153 *cold-assembler-fixups*
3154 *cold-assembler-routines*
3155 #!+(or x86 x86-64) *load-time-code-fixups*)
3157 ;; Prepare for cold load.
3158 (initialize-non-nil-symbols)
3159 (initialize-layouts)
3160 (initialize-static-fns)
3162 ;; Initialize the *COLD-SYMBOLS* system with the information
3163 ;; from package-data-list.lisp-expr and
3164 ;; common-lisp-exports.lisp-expr.
3166 ;; Why do things this way? Historically, the *COLD-SYMBOLS*
3167 ;; machinery was designed and implemented in CMU CL long before
3168 ;; I (WHN) ever heard of CMU CL. It dumped symbols and packages
3169 ;; iff they were used in the cold image. When I added the
3170 ;; package-data-list.lisp-expr mechanism, the idea was to
3171 ;; centralize all information about packages and exports. Thus,
3172 ;; it was the natural place for information even about packages
3173 ;; (such as SB!PCL and SB!WALKER) which aren't used much until
3174 ;; after cold load. This didn't quite match the CMU CL approach
3175 ;; of filling *COLD-SYMBOLS* with symbols which appear in the
3176 ;; cold image and then dumping only those symbols. By explicitly
3177 ;; putting all the symbols from package-data-list.lisp-expr and
3178 ;; from common-lisp-exports.lisp-expr into *COLD-SYMBOLS* here,
3179 ;; we feed our centralized symbol information into the old CMU
3180 ;; CL code without having to change the old CMU CL code too
3181 ;; much. (And the old CMU CL code is still useful for making
3182 ;; sure that the appropriate keywords and internal symbols end
3183 ;; up interned in the target Lisp, which is good, e.g. in order
3184 ;; to make &KEY arguments work right and in order to make
3185 ;; BACKTRACEs into target Lisp system code be legible.)
3186 (dolist (exported-name
3187 (sb-cold:read-from-file "common-lisp-exports.lisp-expr"))
3188 (cold-intern (intern exported-name *cl-package*)))
3189 (dolist (pd (sb-cold:read-from-file "package-data-list.lisp-expr"))
3190 (declare (type sb-cold:package-data pd))
3191 (let ((package (find-package (sb-cold:package-data-name pd))))
3192 (labels (;; Call FN on every node of the TREE.
3193 (mapc-on-tree (fn tree)
3194 (declare (type function fn))
3196 (cons (mapc-on-tree fn (car tree))
3197 (mapc-on-tree fn (cdr tree)))
3198 (t (funcall fn tree)
3200 ;; Make sure that information about the association
3201 ;; between PACKAGE and the symbol named NAME gets
3202 ;; recorded in the cold-intern system or (as a
3203 ;; convenience when dealing with the tree structure
3204 ;; allowed in the PACKAGE-DATA-EXPORTS slot) do
3205 ;; nothing if NAME is NIL.
3208 (cold-intern (intern name package) package))))
3209 (mapc-on-tree #'chill (sb-cold:package-data-export pd))
3210 (mapc #'chill (sb-cold:package-data-reexport pd))
3211 (dolist (sublist (sb-cold:package-data-import-from pd))
3212 (destructuring-bind (package-name &rest symbol-names) sublist
3213 (declare (ignore package-name))
3214 (mapc #'chill symbol-names))))))
3217 (dolist (file-name object-file-names)
3218 (write-line (namestring file-name))
3219 (cold-load file-name))
3221 ;; Tidy up loose ends left by cold loading. ("Postpare from cold load?")
3222 (resolve-assembler-fixups)
3223 #!+(or x86 x86-64) (output-load-time-code-fixups)
3224 (foreign-symbols-to-core)
3226 (/show "back from FINISH-SYMBOLS")
3227 (finalize-load-time-value-noise)
3229 ;; Tell the target Lisp how much stuff we've allocated.
3230 (cold-set 'sb!vm:*read-only-space-free-pointer*
3231 (allocate-cold-descriptor *read-only*
3233 sb!vm:even-fixnum-lowtag))
3234 (cold-set 'sb!vm:*static-space-free-pointer*
3235 (allocate-cold-descriptor *static*
3237 sb!vm:even-fixnum-lowtag))
3238 (cold-set 'sb!vm:*initial-dynamic-space-free-pointer*
3239 (allocate-cold-descriptor *dynamic*
3241 sb!vm:even-fixnum-lowtag))
3242 (/show "done setting free pointers")
3244 ;; Write results to files.
3246 ;; FIXME: I dislike this approach of redefining
3247 ;; *STANDARD-OUTPUT* instead of putting the new stream in a
3248 ;; lexical variable, and it's annoying to have WRITE-MAP (to
3249 ;; *STANDARD-OUTPUT*) not be parallel to WRITE-INITIAL-CORE-FILE
3250 ;; (to a stream explicitly passed as an argument).
3251 (macrolet ((out-to (name &body body)
3252 `(let ((fn (format nil "~A/~A.h" c-header-dir-name ,name)))
3253 (ensure-directories-exist fn)
3254 (with-open-file (*standard-output* fn
3255 :if-exists :supersede :direction :output)
3257 (let ((n (substitute #\_ #\- (string-upcase ,name))))
3260 "#ifndef SBCL_GENESIS_~A~%#define SBCL_GENESIS_~A 1~%"
3264 "#endif /* SBCL_GENESIS_~A */~%"
3265 (string-upcase ,name))))))
3267 (with-open-file (*standard-output* map-file-name
3269 :if-exists :supersede)
3271 (out-to "config" (write-config-h))
3272 (out-to "constants" (write-constants-h))
3273 (let ((structs (sort (copy-list sb!vm:*primitive-objects*) #'string<
3276 (sb!vm:primitive-object-name obj))))))
3277 (dolist (obj structs)
3279 (string-downcase (string (sb!vm:primitive-object-name obj)))
3280 (write-primitive-object obj)))
3281 (out-to "primitive-objects"
3282 (dolist (obj structs)
3283 (format t "~&#include \"~A.h\"~%"
3285 (string (sb!vm:primitive-object-name obj)))))))
3286 (dolist (class '(hash-table
3288 sb!c::compiled-debug-info
3289 sb!c::compiled-debug-fun
3292 (string-downcase (string class))
3293 (write-structure-object
3294 (sb!kernel:layout-info (sb!kernel:find-layout class)))))
3295 (out-to "static-symbols" (write-static-symbols))
3297 (when core-file-name
3298 (write-initial-core-file core-file-name))))))