1.0.12.27: FILL on lists was broken by 1.0.12.16, oops!
[sbcl.git] / src / compiler / generic / genesis.lisp
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.
5 ;;;;
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
15 ;;;; top level forms.
16 ;;;;
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.)
23
24 ;;;; This software is part of the SBCL system. See the README file for
25 ;;;; more information.
26 ;;;;
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.
32
33 (in-package "SB!FASL")
34
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)))
41
42 ;;; the current version of SBCL core files
43 ;;;
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
56 ;;; persists.)
57 ;;;
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)
65
66 (defun round-up (number size)
67   #!+sb-doc
68   "Round NUMBER up to be an integral multiple of SIZE."
69   (* size (ceiling number size)))
70 \f
71 ;;;; implementing the concept of "vector" in (almost) portable
72 ;;;; Common Lisp
73 ;;;;
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:-)
78
79 (eval-when (:compile-toplevel :load-toplevel :execute)
80   (defconstant +smallvec-length+
81     (expt 2 16)))
82
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
85 (deftype smallvec ()
86   `(simple-array (unsigned-byte 8) (,+smallvec-length+)))
87
88 (defun make-smallvec ()
89   (make-array +smallvec-length+ :element-type '(unsigned-byte 8)))
90
91 ;;; a big vector, implemented as a vector of SMALLVECs
92 ;;;
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
105 (defstruct bigvec
106   (outer-vector (vector (make-smallvec)) :type (vector smallvec)))
107
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+)
112     (aref (the smallvec
113             (svref (bigvec-outer-vector bigvec) outer-index))
114           inner-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))
120                 inner-index)
121           new-value)))
122
123 ;;; analogous to LENGTH, but for a BIGVEC
124 ;;;
125 ;;; the length of BIGVEC, measured in the number of BVREFable bytes it
126 ;;; can hold
127 (defun bvlength (bigvec)
128   (* (length (bigvec-outer-vector bigvec))
129      +smallvec-length+))
130
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)
135                     stream)))
136
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))))
142
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)
154                 (make-smallvec)))
155     (setf (bigvec-outer-vector bigvec)
156           new-outer-vector))
157   bigvec)
158 \f
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)
161
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
165             (n)
166             (let* ((name (intern (format nil "BVREF-~A" n)))
167                    (number-octets (/ n 8))
168                    (ash-list-le
169                     (loop for i from 0 to (1- number-octets)
170                           collect `(ash (bvref bigvec (+ byte-index ,i))
171                                         ,(* i 8))))
172                    (ash-list-be
173                     (loop for i from 0 to (1- number-octets)
174                           collect `(ash (bvref bigvec
175                                                (+ byte-index
176                                                   ,(- number-octets 1 i)))
177                                         ,(* i 8))))
178                    (setf-list-le
179                     (loop for i from 0 to (1- number-octets)
180                           append
181                           `((bvref bigvec (+ byte-index ,i))
182                             (ldb (byte 8 ,(* i 8)) new-value))))
183                    (setf-list-be
184                     (loop for i from 0 to (1- number-octets)
185                           append
186                           `((bvref bigvec (+ byte-index ,i))
187                             (ldb (byte 8 ,(- n 8 (* i 8))) new-value)))))
188               `(progn
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))))))))
197   (make-bvref-n 8)
198   (make-bvref-n 16)
199   (make-bvref-n 32)
200   (make-bvref-n 64))
201
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))
205 (progn
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)))
210
211 #!+#.(cl:if (cl:= 32 sb!vm:n-word-bits) '(and) '(or))
212 (progn
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)))
217
218 \f
219 ;;;; representation of spaces in the core
220
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
223 ;;; dumped to core.
224 (defvar *dynamic*)
225 (defconstant dynamic-core-space-id 1)
226
227 (defvar *static*)
228 (defconstant static-core-space-id 2)
229
230 (defvar *read-only*)
231 (defconstant read-only-core-space-id 3)
232
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)")
238
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)
242                    (:copier nil))
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.
258   (free-word-index 0))
259
260 (defun gspace-byte-address (gspace)
261   (ash (gspace-word-address gspace) sb!vm:word-shift))
262
263 (def!method print-object ((gspace gspace) stream)
264   (print-unreadable-object (gspace stream :type t)
265     (format stream "~S" (gspace-name gspace))))
266
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."
270            byte-address
271            target-space-alignment))
272   (%make-gspace :name name
273                 :identifier identifier
274                 :word-address (ash byte-address (- sb!vm:word-shift))))
275 \f
276 ;;;; representation of descriptors
277
278 (defstruct (descriptor
279             (:constructor make-descriptor
280                           (high low &optional gspace word-offset))
281             (:copier nil))
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
287   ;;
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
294   high
295   low)
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)))))
306                (format stream
307                        "for fixnum: ~W"
308                        (if (> unsigned #x1FFFFFFF)
309                            (- unsigned #x40000000)
310                            unsigned))))
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))
317              (format stream
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)))
321             (t
322              (format stream
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))
326                      lowtag
327                      (let ((gspace (descriptor-gspace des)))
328                        (if gspace
329                            (gspace-name gspace)
330                            "unknown"))))))))
331
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.
343     (do ()
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
352                                             (1- (ash 1
353                                                      (- descriptor-low-bits
354                                                         sb!vm:word-shift))))
355                                     sb!vm:word-shift)
356                                lowtag)
357                        gspace
358                        old-free-word-index))))
359
360 (defun descriptor-lowtag (des)
361   #!+sb-doc
362   "the lowtag bits for DES"
363   (logand (descriptor-low des) sb!vm:lowtag-mask))
364
365 (defun descriptor-bits (des)
366   (logior (ash (descriptor-high des) descriptor-low-bits)
367           (descriptor-low des)))
368
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)))))
381
382 (defun descriptor-word-sized-integer (des)
383   ;; Extract an (unsigned-byte 32), from either its fixnum or bignum
384   ;; representation.
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))))
390
391 ;;; common idioms
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))
396
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)
428                                        (- sb!vm:word-shift
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))))
433             (return gspace)))
434         (error "don't even know how to look for a GSPACE for ~S" des)))))
435
436 (defun make-random-descriptor (value)
437   (make-descriptor (logand (ash value (- descriptor-low-bits))
438                            (1- (ash 1
439                                     (- sb!vm:n-word-bits
440                                        descriptor-low-bits))))
441                    (logand value (1- (ash 1 descriptor-low-bits)))))
442
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))))
448
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)))
454                            type)))
455
456 (defun make-character-descriptor (data)
457   (make-other-immediate-descriptor data sb!vm:character-widetag))
458
459 (defun descriptor-beyond (des offset type)
460   (let* ((low (logior (+ (logandc2 (descriptor-low des) sb!vm:lowtag-mask)
461                          offset)
462                       type))
463          (high (+ (descriptor-high des)
464                   (ash low (- descriptor-low-bits)))))
465     (make-descriptor high (logand low (1- (ash 1 descriptor-low-bits))))))
466 \f
467 ;;;; miscellaneous variables and other noise
468
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.)
477 ;;;
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*)
484
485 ;;; a handle on the trap object
486 (defvar *unbound-marker*)
487 ;; was:  (make-other-immediate-descriptor 0 sb!vm:unbound-marker-widetag)
488
489 ;;; a handle on the NIL object
490 (defvar *nil-descriptor*)
491
492 ;;; the head of a list of TOPLEVEL-THINGs describing stuff to be done
493 ;;; when the target Lisp starts up
494 ;;;
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
498 ;;; purposes.
499 (defvar *current-reversed-cold-toplevels*)
500
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*))
505 \f
506 ;;;; miscellaneous stuff to read and write the core memory
507
508 ;;; FIXME: should be DEFINE-MODIFY-MACRO
509 (defmacro cold-push (thing list)
510   #!+sb-doc
511   "Push THING onto the given cold-load LIST."
512   `(setq ,list (cold-cons ,thing ,list)))
513
514 (declaim (ftype (function (descriptor sb!vm:word) descriptor) read-wordindexed))
515 (defun read-wordindexed (address index)
516   #!+sb-doc
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))
521                           sb!vm:word-shift))
522          (value (bvref-word bytes byte-index)))
523     (make-random-descriptor value)))
524
525 (declaim (ftype (function (descriptor) descriptor) read-memory))
526 (defun read-memory (address)
527   #!+sb-doc
528   "Return the value at ADDRESS."
529   (read-wordindexed address 0))
530
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)
539                          (cold-cons
540                           (number-to-core (descriptor-word-offset marker))
541                           *nil-descriptor*)))
542              *current-reversed-cold-toplevels*)
543   (values))
544
545 (declaim (ftype (function (descriptor sb!vm:word descriptor)) write-wordindexed))
546 (defun write-wordindexed (address index value)
547   #!+sb-doc
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)
559                                                  sb!vm:lowtag-mask)
560                                        (ash index sb!vm:word-shift))
561                                     value)
562     (let* ((bytes (gspace-bytes (descriptor-intuit-gspace address)))
563            (byte-index (ash (+ index (descriptor-word-offset address))
564                                sb!vm:word-shift)))
565       (setf (bvref-word bytes byte-index)
566             (descriptor-bits value)))))
567
568 (declaim (ftype (function (descriptor descriptor)) write-memory))
569 (defun write-memory (address value)
570   #!+sb-doc
571   "Write VALUE (a DESCRIPTOR) at ADDRESS (also a DESCRIPTOR)."
572   (write-wordindexed address 0 value))
573 \f
574 ;;;; allocating images of primitive objects in the cold core
575
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
580 ;;;   the length.
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)
584   #!+sb-doc
585   "Allocate LENGTH words in GSPACE and return a new descriptor of type LOWTAG
586   pointing to them."
587   (allocate-cold-descriptor gspace (ash length sb!vm:word-shift) lowtag))
588 (defun allocate-unboxed-object (gspace element-bits length type)
589   #!+sb-doc
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)))
597     (write-memory des
598                   (make-other-immediate-descriptor (ash bytes
599                                                         (- sb!vm:word-shift))
600                                                    type))
601     des))
602 (defun allocate-vector-object (gspace element-bits length type)
603   #!+sb-doc
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))
617     des))
618 \f
619 ;;;; copying simple objects into the cold core
620
621 (defun base-string-to-core (string &optional (gspace *dynamic*))
622   #!+sb-doc
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
629                                       sb!vm:n-byte-bits
630                                       (1+ length)
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))
638     (dotimes (i 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
643     des))
644
645 (defun bignum-to-core (n)
646   #!+sb-doc
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*
650                                           sb!vm:n-word-bits
651                                           words
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))))
656         ((> index words)
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."
660                  words n remainder)))
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)
665                                                  word)))))
666     handle))
667
668 (defun number-pair-to-core (first second type)
669   #!+sb-doc
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)
674     des))
675
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
680       (32
681        (let ((high-bits (make-random-descriptor hi))
682              (low-bits (make-random-descriptor lo)))
683          (ecase sb!c:*backend-byte-order*
684            (:little-endian
685             (write-wordindexed address index low-bits)
686             (write-wordindexed address (1+ index) high-bits))
687            (:big-endian
688             (write-wordindexed address index high-bits)
689             (write-wordindexed address (1+ index) low-bits)))))
690       (64
691        (let ((bits (make-random-descriptor
692                     (ecase sb!c:*backend-byte-order*
693                       (:little-endian (logior lo (ash hi 32)))
694                       ;; Just guessing.
695                       #+nil (:big-endian (logior (logand hi #xffffffff)
696                                                  (ash lo 32)))))))
697          (write-wordindexed address index bits))))
698     address))
699
700 (defun float-to-core (x)
701   (etypecase x
702     (single-float
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*
709                                          sb!vm:n-word-bits
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)))
715        des))
716     (double-float
717      (let ((des (allocate-unboxed-object *dynamic*
718                                          sb!vm:n-word-bits
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)))))
722
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))))
732     des))
733
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
740                              (realpart num))
741     (write-double-float-bits des sb!vm:complex-double-float-imag-slot
742                              (imagpart num))))
743
744 ;;; Copy the given number to the core.
745 (defun number-to-core (number)
746   (typecase 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))
756     #!+long-float
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))))
764
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*
768                                       sb!vm:n-word-bits
769                                       (1- sb!vm:sap-size)
770                                       sb!vm:sap-widetag)))
771     (write-wordindexed des
772                        sb!vm:sap-pointer-slot
773                        (make-random-descriptor sap-int))
774     des))
775
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)
781     dest))
782
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)
791                          (pop objects)))
792     result))
793 \f
794 ;;;; symbol magic
795
796 ;;; FIXME: This should be a &KEY argument of ALLOCATE-SYMBOL.
797 (defvar *cold-symbol-allocation-gspace* nil)
798
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*
803                                              *dynamic*)
804                                          sb!vm:n-word-bits
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*)
815     symbol))
816
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)))
827 \f
828 ;;;; layouts and type system pre-initialization
829
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
836 ;;; itself.
837
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))
843
844 ;;; a map from DESCRIPTOR-BITS of cold layouts to the name, for inverting
845 ;;; mapping
846 (defvar *cold-layout-names* (make-hash-table :test 'eql))
847
848 ;;; FIXME: *COLD-LAYOUTS* and *COLD-LAYOUT-NAMES* should be
849 ;;; initialized by binding in GENESIS.
850
851 ;;; the descriptor for layout's layout (needed when making layouts)
852 (defvar *layout-layout*)
853
854 (defconstant target-layout-length
855   (layout-length (find-layout 'layout)))
856
857 (defun target-layout-index (slot-name)
858   ;; KLUDGE: this is a little bit sleazy, but the tricky thing is that
859   ;; structure slots don't have a terribly firm idea of their names.
860   ;; At least here if we change LAYOUT's package of definition, we
861   ;; only have to change one thing...
862   (let* ((name (find-symbol (symbol-name slot-name) "SB!KERNEL"))
863          (layout (find-layout 'layout))
864          (dd (layout-info layout))
865          (slots (dd-slots dd))
866          (dsd (find name slots :key #'dsd-name)))
867     (aver dsd)
868     (dsd-index dsd)))
869
870 (defun cold-set-layout-slot (cold-layout slot-name value)
871   (write-wordindexed
872    cold-layout
873    (+ sb!vm:instance-slots-offset (target-layout-index slot-name))
874    value))
875
876 ;;; Return a list of names created from the cold layout INHERITS data
877 ;;; in X.
878 (defun listify-cold-inherits (x)
879   (let ((len (descriptor-fixnum (read-wordindexed x
880                                                   sb!vm:vector-length-slot))))
881     (collect ((res))
882       (dotimes (index len)
883         (let* ((des (read-wordindexed x (+ sb!vm:vector-data-offset index)))
884                (found (gethash (descriptor-bits des) *cold-layout-names*)))
885           (if found
886             (res found)
887             (error "unknown descriptor at index ~S (bits = ~8,'0X)"
888                    index
889                    (descriptor-bits des)))))
890       (res))))
891
892 (declaim (ftype (function (symbol descriptor descriptor descriptor descriptor)
893                           descriptor)
894                 make-cold-layout))
895 (defun make-cold-layout (name length inherits depthoid nuntagged)
896   (let ((result (allocate-boxed-object *dynamic*
897                                        ;; KLUDGE: Why 1+? -- WHN 19990901
898                                        ;; header word? -- CSR 20051204
899                                        (1+ target-layout-length)
900                                        sb!vm:instance-pointer-lowtag)))
901     (write-memory result
902                   (make-other-immediate-descriptor
903                    target-layout-length sb!vm:instance-header-widetag))
904
905     ;; KLUDGE: The offsets into LAYOUT below should probably be pulled out
906     ;; of the cross-compiler's tables at genesis time instead of inserted
907     ;; by hand as bare numeric constants. -- WHN ca. 19990901
908
909     ;; Set slot 0 = the layout of the layout.
910     (write-wordindexed result sb!vm:instance-slots-offset *layout-layout*)
911
912     ;; Set the CLOS hash value.
913     ;;
914     ;; Note: CMU CL didn't set these in genesis, but instead arranged
915     ;; for them to be set at cold init time. That resulted in slightly
916     ;; kludgy-looking code, but there were at least two things to be
917     ;; said for it:
918     ;;   1. It put the hash values under the control of the target Lisp's
919     ;;      RANDOM function, so that CLOS behavior would be nearly
920     ;;      deterministic (instead of depending on the implementation of
921     ;;      RANDOM in the cross-compilation host, and the state of its
922     ;;      RNG when genesis begins).
923     ;;   2. It automatically ensured that all hash values in the target Lisp
924     ;;      were part of the same sequence, so that we didn't have to worry
925     ;;      about the possibility of the first hash value set in genesis
926     ;;      being precisely equal to the some hash value set in cold init time
927     ;;      (because the target Lisp RNG has advanced to precisely the same
928     ;;      state that the host Lisp RNG was in earlier).
929     ;; Point 1 should not be an issue in practice because of the way we do our
930     ;; build procedure in two steps, so that the SBCL that we end up with has
931     ;; been created by another SBCL (whose RNG is under our control).
932     ;; Point 2 is more of an issue. If ANSI had provided a way to feed
933     ;; entropy into an RNG, we would have no problem: we'd just feed
934     ;; some specialized genesis-time-only pattern into the RNG state
935     ;; before using it. However, they didn't, so we have a slight
936     ;; problem. We address it by generating the hash values using a
937     ;; different algorithm than we use in ordinary operation.
938     (let (;; The expression here is pretty arbitrary, we just want
939           ;; to make sure that it's not something which is (1)
940           ;; evenly distributed and (2) not foreordained to arise in
941           ;; the target Lisp's (RANDOM-LAYOUT-CLOS-HASH) sequence
942           ;; and show up as the CLOS-HASH value of some other
943           ;; LAYOUT.
944           (hash-value
945            (1+ (mod (logxor (logand   (random-layout-clos-hash) 15253)
946                             (logandc2 (random-layout-clos-hash) 15253)
947                             1)
948                     (1- sb!kernel:layout-clos-hash-limit)))))
949       (cold-set-layout-slot result 'clos-hash
950                             (make-fixnum-descriptor hash-value)))
951
952     ;; Set other slot values.
953     ;;
954     ;; leave CLASSOID uninitialized for now
955     (cold-set-layout-slot result 'invalid *nil-descriptor*)
956     (cold-set-layout-slot result 'inherits inherits)
957     (cold-set-layout-slot result 'depthoid depthoid)
958     (cold-set-layout-slot result 'length length)
959     (cold-set-layout-slot result 'info *nil-descriptor*)
960     (cold-set-layout-slot result 'pure *nil-descriptor*)
961     (cold-set-layout-slot result 'n-untagged-slots nuntagged)
962     (cold-set-layout-slot result 'for-std-class-p *nil-descriptor*)
963
964     (setf (gethash name *cold-layouts*)
965           (list result
966                 name
967                 (descriptor-fixnum length)
968                 (listify-cold-inherits inherits)
969                 (descriptor-fixnum depthoid)
970                 (descriptor-fixnum nuntagged)))
971     (setf (gethash (descriptor-bits result) *cold-layout-names*) name)
972
973     result))
974
975 (defun initialize-layouts ()
976
977   (clrhash *cold-layouts*)
978
979   ;; We initially create the layout of LAYOUT itself with NIL as the LAYOUT and
980   ;; #() as INHERITS,
981   (setq *layout-layout* *nil-descriptor*)
982   (let ((xlayout-layout (find-layout 'layout)))
983     (aver (= 0 (layout-n-untagged-slots xlayout-layout)))
984     (setq *layout-layout*
985           (make-cold-layout 'layout
986                             (number-to-core target-layout-length)
987                             (vector-in-core)
988                             (number-to-core (layout-depthoid xlayout-layout))
989                             (number-to-core 0)))
990   (write-wordindexed
991    *layout-layout* sb!vm:instance-slots-offset *layout-layout*)
992
993   ;; Then we create the layouts that we'll need to make a correct INHERITS
994   ;; vector for the layout of LAYOUT itself..
995   ;;
996   ;; FIXME: The various LENGTH and DEPTHOID numbers should be taken from
997   ;; the compiler's tables, not set by hand.
998   (let* ((t-layout
999           (make-cold-layout 't
1000                             (number-to-core 0)
1001                             (vector-in-core)
1002                             (number-to-core 0)
1003                             (number-to-core 0)))
1004          (so-layout
1005           (make-cold-layout 'structure-object
1006                             (number-to-core 1)
1007                             (vector-in-core t-layout)
1008                             (number-to-core 1)
1009                             (number-to-core 0)))
1010          (bso-layout
1011           (make-cold-layout 'structure!object
1012                             (number-to-core 1)
1013                             (vector-in-core t-layout so-layout)
1014                             (number-to-core 2)
1015                             (number-to-core 0)))
1016          (layout-inherits (vector-in-core t-layout
1017                                           so-layout
1018                                           bso-layout)))
1019
1020     ;; ..and return to backpatch the layout of LAYOUT.
1021     (setf (fourth (gethash 'layout *cold-layouts*))
1022           (listify-cold-inherits layout-inherits))
1023     (cold-set-layout-slot *layout-layout* 'inherits layout-inherits))))
1024 \f
1025 ;;;; interning symbols in the cold image
1026
1027 ;;; In order to avoid having to know about the package format, we
1028 ;;; build a data structure in *COLD-PACKAGE-SYMBOLS* that holds all
1029 ;;; interned symbols along with info about their packages. The data
1030 ;;; structure is a list of sublists, where the sublists have the
1031 ;;; following format:
1032 ;;;   (<make-package-arglist>
1033 ;;;    <internal-symbols>
1034 ;;;    <external-symbols>
1035 ;;;    <imported-internal-symbols>
1036 ;;;    <imported-external-symbols>
1037 ;;;    <shadowing-symbols>
1038 ;;;    <package-documentation>)
1039 ;;;
1040 ;;; KLUDGE: It would be nice to implement the sublists as instances of
1041 ;;; a DEFSTRUCT (:TYPE LIST). (They'd still be lists, but at least we'd be
1042 ;;; using mnemonically-named operators to access them, instead of trying
1043 ;;; to remember what THIRD and FIFTH mean, and hoping that we never
1044 ;;; need to change the list layout..) -- WHN 19990825
1045
1046 ;;; an alist from packages to lists of that package's symbols to be dumped
1047 (defvar *cold-package-symbols*)
1048 (declaim (type list *cold-package-symbols*))
1049
1050 ;;; a map from descriptors to symbols, so that we can back up. The key
1051 ;;; is the address in the target core.
1052 (defvar *cold-symbols*)
1053 (declaim (type hash-table *cold-symbols*))
1054
1055 ;;; sanity check for a symbol we're about to create on the target
1056 ;;;
1057 ;;; Make sure that the symbol has an appropriate package. In
1058 ;;; particular, catch the so-easy-to-make error of typing something
1059 ;;; like SB-KERNEL:%BYTE-BLT in cold sources when what you really
1060 ;;; need is SB!KERNEL:%BYTE-BLT.
1061 (defun package-ok-for-target-symbol-p (package)
1062   (let ((package-name (package-name package)))
1063     (or
1064      ;; Cold interning things in these standard packages is OK. (Cold
1065      ;; interning things in the other standard package, CL-USER, isn't
1066      ;; OK. We just use CL-USER to expose symbols whose homes are in
1067      ;; other packages. Thus, trying to cold intern a symbol whose
1068      ;; home package is CL-USER probably means that a coding error has
1069      ;; been made somewhere.)
1070      (find package-name '("COMMON-LISP" "KEYWORD") :test #'string=)
1071      ;; Cold interning something in one of our target-code packages,
1072      ;; which are ever-so-rigorously-and-elegantly distinguished by
1073      ;; this prefix on their names, is OK too.
1074      (string= package-name "SB!" :end1 3 :end2 3)
1075      ;; This one is OK too, since it ends up being COMMON-LISP on the
1076      ;; target.
1077      (string= package-name "SB-XC")
1078      ;; Anything else looks bad. (maybe COMMON-LISP-USER? maybe an extension
1079      ;; package in the xc host? something we can't think of
1080      ;; a valid reason to cold intern, anyway...)
1081      )))
1082
1083 ;;; like SYMBOL-PACKAGE, but safe for symbols which end up on the target
1084 ;;;
1085 ;;; Most host symbols we dump onto the target are created by SBCL
1086 ;;; itself, so that as long as we avoid gratuitously
1087 ;;; cross-compilation-unfriendly hacks, it just happens that their
1088 ;;; SYMBOL-PACKAGE in the host system corresponds to their
1089 ;;; SYMBOL-PACKAGE in the target system. However, that's not the case
1090 ;;; in the COMMON-LISP package, where we don't get to create the
1091 ;;; symbols but instead have to use the ones that the xc host created.
1092 ;;; In particular, while ANSI specifies which symbols are exported
1093 ;;; from COMMON-LISP, it doesn't specify that their home packages are
1094 ;;; COMMON-LISP, so the xc host can keep them in random packages which
1095 ;;; don't exist on the target (e.g. CLISP keeping some CL-exported
1096 ;;; symbols in the CLOS package).
1097 (defun symbol-package-for-target-symbol (symbol)
1098   ;; We want to catch weird symbols like CLISP's
1099   ;; CL:FIND-METHOD=CLOS::FIND-METHOD, but we don't want to get
1100   ;; sidetracked by ordinary symbols like :CHARACTER which happen to
1101   ;; have the same SYMBOL-NAME as exports from COMMON-LISP.
1102   (multiple-value-bind (cl-symbol cl-status)
1103       (find-symbol (symbol-name symbol) *cl-package*)
1104     (if (and (eq symbol cl-symbol)
1105              (eq cl-status :external))
1106         ;; special case, to work around possible xc host weirdness
1107         ;; in COMMON-LISP package
1108         *cl-package*
1109         ;; ordinary case
1110         (let ((result (symbol-package symbol)))
1111           (aver (package-ok-for-target-symbol-p result))
1112           result))))
1113
1114 ;;; Return a handle on an interned symbol. If necessary allocate the
1115 ;;; symbol and record which package the symbol was referenced in. When
1116 ;;; we allocate the symbol, make sure we record a reference to the
1117 ;;; symbol in the home package so that the package gets set.
1118 (defun cold-intern (symbol
1119                     &optional
1120                     (package (symbol-package-for-target-symbol symbol)))
1121
1122   (aver (package-ok-for-target-symbol-p package))
1123
1124   ;; Anything on the cross-compilation host which refers to the target
1125   ;; machinery through the host SB-XC package should be translated to
1126   ;; something on the target which refers to the same machinery
1127   ;; through the target COMMON-LISP package.
1128   (let ((p (find-package "SB-XC")))
1129     (when (eq package p)
1130       (setf package *cl-package*))
1131     (when (eq (symbol-package symbol) p)
1132       (setf symbol (intern (symbol-name symbol) *cl-package*))))
1133
1134   (let (;; Information about each cold-interned symbol is stored
1135         ;; in COLD-INTERN-INFO.
1136         ;;   (CAR COLD-INTERN-INFO) = descriptor of symbol
1137         ;;   (CDR COLD-INTERN-INFO) = list of packages, other than symbol's
1138         ;;                            own package, referring to symbol
1139         ;; (*COLD-PACKAGE-SYMBOLS* and *COLD-SYMBOLS* store basically the
1140         ;; same information, but with the mapping running the opposite way.)
1141         (cold-intern-info (get symbol 'cold-intern-info)))
1142     (unless cold-intern-info
1143       (cond ((eq (symbol-package-for-target-symbol symbol) package)
1144              (let ((handle (allocate-symbol (symbol-name symbol))))
1145                (setf (gethash (descriptor-bits handle) *cold-symbols*) symbol)
1146                (when (eq package *keyword-package*)
1147                  (cold-set handle handle))
1148                (setq cold-intern-info
1149                      (setf (get symbol 'cold-intern-info) (cons handle nil)))))
1150             (t
1151              (cold-intern symbol)
1152              (setq cold-intern-info (get symbol 'cold-intern-info)))))
1153     (unless (or (null package)
1154                 (member package (cdr cold-intern-info)))
1155       (push package (cdr cold-intern-info))
1156       (let* ((old-cps-entry (assoc package *cold-package-symbols*))
1157              (cps-entry (or old-cps-entry
1158                             (car (push (list package)
1159                                        *cold-package-symbols*)))))
1160         (unless old-cps-entry
1161           (/show "created *COLD-PACKAGE-SYMBOLS* entry for" package symbol))
1162         (push symbol (rest cps-entry))))
1163     (car cold-intern-info)))
1164
1165 ;;; Construct and return a value for use as *NIL-DESCRIPTOR*.
1166 (defun make-nil-descriptor ()
1167   (let* ((des (allocate-unboxed-object
1168                *static*
1169                sb!vm:n-word-bits
1170                sb!vm:symbol-size
1171                0))
1172          (result (make-descriptor (descriptor-high des)
1173                                   (+ (descriptor-low des)
1174                                      (* 2 sb!vm:n-word-bytes)
1175                                      (- sb!vm:list-pointer-lowtag
1176                                         sb!vm:other-pointer-lowtag)))))
1177     (write-wordindexed des
1178                        1
1179                        (make-other-immediate-descriptor
1180                         0
1181                         sb!vm:symbol-header-widetag))
1182     (write-wordindexed des
1183                        (+ 1 sb!vm:symbol-value-slot)
1184                        result)
1185     (write-wordindexed des
1186                        (+ 2 sb!vm:symbol-value-slot)
1187                        result)
1188     (write-wordindexed des
1189                        (+ 1 sb!vm:symbol-plist-slot)
1190                        result)
1191     (write-wordindexed des
1192                        (+ 1 sb!vm:symbol-name-slot)
1193                        ;; This is *DYNAMIC*, and DES is *STATIC*,
1194                        ;; because that's the way CMU CL did it; I'm
1195                        ;; not sure whether there's an underlying
1196                        ;; reason. -- WHN 1990826
1197                        (base-string-to-core "NIL" *dynamic*))
1198     (write-wordindexed des
1199                        (+ 1 sb!vm:symbol-package-slot)
1200                        result)
1201     (setf (get nil 'cold-intern-info)
1202           (cons result nil))
1203     (cold-intern nil)
1204     result))
1205
1206 ;;; Since the initial symbols must be allocated before we can intern
1207 ;;; anything else, we intern those here. We also set the value of T.
1208 (defun initialize-non-nil-symbols ()
1209   #!+sb-doc
1210   "Initialize the cold load symbol-hacking data structures."
1211   (let ((*cold-symbol-allocation-gspace* *static*))
1212     ;; Intern the others.
1213     (dolist (symbol sb!vm:*static-symbols*)
1214       (let* ((des (cold-intern symbol))
1215              (offset-wanted (sb!vm:static-symbol-offset symbol))
1216              (offset-found (- (descriptor-low des)
1217                               (descriptor-low *nil-descriptor*))))
1218         (unless (= offset-wanted offset-found)
1219           ;; FIXME: should be fatal
1220           (warn "Offset from ~S to ~S is ~W, not ~W"
1221                 symbol
1222                 nil
1223                 offset-found
1224                 offset-wanted))))
1225     ;; Establish the value of T.
1226     (let ((t-symbol (cold-intern t)))
1227       (cold-set t-symbol t-symbol))
1228     ;; Establish the value of *PSEUDO-ATOMIC-BITS* so that the
1229     ;; allocation sequences that expect it to be zero upon entrance
1230     ;; actually find it to be so.
1231     #!+(or x86-64 x86)
1232     (let ((p-a-a-symbol (cold-intern 'sb!kernel:*pseudo-atomic-bits*)))
1233       (cold-set p-a-a-symbol (make-fixnum-descriptor 0)))))
1234
1235 ;;; a helper function for FINISH-SYMBOLS: Return a cold alist suitable
1236 ;;; to be stored in *!INITIAL-LAYOUTS*.
1237 (defun cold-list-all-layouts ()
1238   (let ((result *nil-descriptor*))
1239     (maphash (lambda (key stuff)
1240                (cold-push (cold-cons (cold-intern key)
1241                                      (first stuff))
1242                           result))
1243              *cold-layouts*)
1244     result))
1245
1246 ;;; Establish initial values for magic symbols.
1247 ;;;
1248 ;;; Scan over all the symbols referenced in each package in
1249 ;;; *COLD-PACKAGE-SYMBOLS* making that for each one there's an
1250 ;;; appropriate entry in the *!INITIAL-SYMBOLS* data structure to
1251 ;;; intern it.
1252 (defun finish-symbols ()
1253
1254   ;; I think the point of setting these functions into SYMBOL-VALUEs
1255   ;; here, instead of using SYMBOL-FUNCTION, is that in CMU CL
1256   ;; SYMBOL-FUNCTION reduces to FDEFINITION, which is a pretty
1257   ;; hairy operation (involving globaldb.lisp etc.) which we don't
1258   ;; want to invoke early in cold init. -- WHN 2001-12-05
1259   ;;
1260   ;; FIXME: So OK, that's a reasonable reason to do something weird like
1261   ;; this, but this is still a weird thing to do, and we should change
1262   ;; the names to highlight that something weird is going on. Perhaps
1263   ;; *MAYBE-GC-FUN*, *INTERNAL-ERROR-FUN*, *HANDLE-BREAKPOINT-FUN*,
1264   ;; and *HANDLE-FUN-END-BREAKPOINT-FUN*...
1265   (dolist (symbol sb!vm::*c-callable-static-symbols*)
1266     (cold-set symbol (cold-fdefinition-object (cold-intern symbol))))
1267
1268   (cold-set 'sb!vm::*current-catch-block*          (make-fixnum-descriptor 0))
1269   (cold-set 'sb!vm::*current-unwind-protect-block* (make-fixnum-descriptor 0))
1270
1271   (cold-set '*free-interrupt-context-index* (make-fixnum-descriptor 0))
1272
1273   (cold-set '*!initial-layouts* (cold-list-all-layouts))
1274
1275   (/show "dumping packages" (mapcar #'car *cold-package-symbols*))
1276   (let ((initial-symbols *nil-descriptor*))
1277     (dolist (cold-package-symbols-entry *cold-package-symbols*)
1278       (let* ((cold-package (car cold-package-symbols-entry))
1279              (symbols (cdr cold-package-symbols-entry))
1280              (shadows (package-shadowing-symbols cold-package))
1281              (documentation (base-string-to-core (documentation cold-package t)))
1282              (internal-count 0)
1283              (external-count 0)
1284              (internal *nil-descriptor*)
1285              (external *nil-descriptor*)
1286              (imported-internal *nil-descriptor*)
1287              (imported-external *nil-descriptor*)
1288              (shadowing *nil-descriptor*))
1289         (declare (type package cold-package)) ; i.e. not a target descriptor
1290         (/show "dumping" cold-package symbols)
1291
1292         ;; FIXME: Add assertions here to make sure that inappropriate stuff
1293         ;; isn't being dumped:
1294         ;;   * the CL-USER package
1295         ;;   * the SB-COLD package
1296         ;;   * any internal symbols in the CL package
1297         ;;   * basically any package other than CL, KEYWORD, or the packages
1298         ;;     in package-data-list.lisp-expr
1299         ;; and that the structure of the KEYWORD package (e.g. whether
1300         ;; any symbols are internal to it) matches what we want in the
1301         ;; target SBCL.
1302
1303         ;; FIXME: It seems possible that by looking at the contents of
1304         ;; packages in the target SBCL we could find which symbols in
1305         ;; package-data-lisp.lisp-expr are now obsolete. (If I
1306         ;; understand correctly, only symbols which actually have
1307         ;; definitions or which are otherwise referred to actually end
1308         ;; up in the target packages.)
1309
1310         (dolist (symbol symbols)
1311           (let ((handle (car (get symbol 'cold-intern-info)))
1312                 (imported-p (not (eq (symbol-package-for-target-symbol symbol)
1313                                      cold-package))))
1314             (multiple-value-bind (found where)
1315                 (find-symbol (symbol-name symbol) cold-package)
1316               (unless (and where (eq found symbol))
1317                 (error "The symbol ~S is not available in ~S."
1318                        symbol
1319                        cold-package))
1320               (when (memq symbol shadows)
1321                 (cold-push handle shadowing))
1322               (case where
1323                 (:internal (if imported-p
1324                                (cold-push handle imported-internal)
1325                                (progn
1326                                  (cold-push handle internal)
1327                                  (incf internal-count))))
1328                 (:external (if imported-p
1329                                (cold-push handle imported-external)
1330                                (progn
1331                                  (cold-push handle external)
1332                                  (incf external-count))))))))
1333         (let ((r *nil-descriptor*))
1334           (cold-push documentation r)
1335           (cold-push shadowing r)
1336           (cold-push imported-external r)
1337           (cold-push imported-internal r)
1338           (cold-push external r)
1339           (cold-push internal r)
1340           (cold-push (make-make-package-args cold-package
1341                                              internal-count
1342                                              external-count)
1343                      r)
1344           ;; FIXME: It would be more space-efficient to use vectors
1345           ;; instead of lists here, and space-efficiency here would be
1346           ;; nice, since it would reduce the peak memory usage in
1347           ;; genesis and cold init.
1348           (cold-push r initial-symbols))))
1349     (cold-set '*!initial-symbols* initial-symbols))
1350
1351   (cold-set '*!initial-fdefn-objects* (list-all-fdefn-objects))
1352
1353   (cold-set '*!reversed-cold-toplevels* *current-reversed-cold-toplevels*)
1354
1355   #!+(or x86 x86-64)
1356   (progn
1357     (cold-set 'sb!vm::*fp-constant-0d0* (number-to-core 0d0))
1358     (cold-set 'sb!vm::*fp-constant-1d0* (number-to-core 1d0))
1359     (cold-set 'sb!vm::*fp-constant-0f0* (number-to-core 0f0))
1360     (cold-set 'sb!vm::*fp-constant-1f0* (number-to-core 1f0))))
1361
1362 ;;; Make a cold list that can be used as the arg list to MAKE-PACKAGE in
1363 ;;; order to make a package that is similar to PKG.
1364 (defun make-make-package-args (pkg internal-count external-count)
1365   (let* ((use *nil-descriptor*)
1366          (cold-nicknames *nil-descriptor*)
1367          (res *nil-descriptor*))
1368     (dolist (u (package-use-list pkg))
1369       (when (assoc u *cold-package-symbols*)
1370         (cold-push (base-string-to-core (package-name u)) use)))
1371     (let* ((pkg-name (package-name pkg))
1372            ;; Make the package nickname lists for the standard packages
1373            ;; be the minimum specified by ANSI, regardless of what value
1374            ;; the cross-compilation host happens to use.
1375            (warm-nicknames (cond ((string= pkg-name "COMMON-LISP")
1376                                   '("CL"))
1377                                  ((string= pkg-name "COMMON-LISP-USER")
1378                                   '("CL-USER"))
1379                                  ((string= pkg-name "KEYWORD")
1380                                   '())
1381                                  ;; For packages other than the
1382                                  ;; standard packages, the nickname
1383                                  ;; list was specified by our package
1384                                  ;; setup code, not by properties of
1385                                  ;; what cross-compilation host we
1386                                  ;; happened to use, and we can just
1387                                  ;; propagate it into the target.
1388                                  (t
1389                                   (package-nicknames pkg)))))
1390       (dolist (warm-nickname warm-nicknames)
1391         (cold-push (base-string-to-core warm-nickname) cold-nicknames)))
1392
1393     ;; INTERNAL-COUNT and EXTERNAL-COUNT are the number of symbols that
1394     ;; the package contains in the core. We arrange for the package
1395     ;; symbol tables to be created somewhat larger so that they don't
1396     ;; need to be rehashed so easily when additional symbols are
1397     ;; interned during the warm build.
1398     (cold-push (number-to-core (truncate internal-count 0.8)) res)
1399     (cold-push (cold-intern :internal-symbols) res)
1400     (cold-push (number-to-core (truncate external-count 0.8)) res)
1401     (cold-push (cold-intern :external-symbols) res)
1402
1403     (cold-push cold-nicknames res)
1404     (cold-push (cold-intern :nicknames) res)
1405
1406     (cold-push use res)
1407     (cold-push (cold-intern :use) res)
1408
1409     (cold-push (base-string-to-core (package-name pkg)) res)
1410     res))
1411 \f
1412 ;;;; functions and fdefinition objects
1413
1414 ;;; a hash table mapping from fdefinition names to descriptors of cold
1415 ;;; objects
1416 ;;;
1417 ;;; Note: Since fdefinition names can be lists like '(SETF FOO), and
1418 ;;; we want to have only one entry per name, this must be an 'EQUAL
1419 ;;; hash table, not the default 'EQL.
1420 (defvar *cold-fdefn-objects*)
1421
1422 (defvar *cold-fdefn-gspace* nil)
1423
1424 ;;; Given a cold representation of a symbol, return a warm
1425 ;;; representation.
1426 (defun warm-symbol (des)
1427   ;; Note that COLD-INTERN is responsible for keeping the
1428   ;; *COLD-SYMBOLS* table up to date, so if DES happens to refer to an
1429   ;; uninterned symbol, the code below will fail. But as long as we
1430   ;; don't need to look up uninterned symbols during bootstrapping,
1431   ;; that's OK..
1432   (multiple-value-bind (symbol found-p)
1433       (gethash (descriptor-bits des) *cold-symbols*)
1434     (declare (type symbol symbol))
1435     (unless found-p
1436       (error "no warm symbol"))
1437     symbol))
1438
1439 ;;; like CL:CAR, CL:CDR, and CL:NULL but for cold values
1440 (defun cold-car (des)
1441   (aver (= (descriptor-lowtag des) sb!vm:list-pointer-lowtag))
1442   (read-wordindexed des sb!vm:cons-car-slot))
1443 (defun cold-cdr (des)
1444   (aver (= (descriptor-lowtag des) sb!vm:list-pointer-lowtag))
1445   (read-wordindexed des sb!vm:cons-cdr-slot))
1446 (defun cold-null (des)
1447   (= (descriptor-bits des)
1448      (descriptor-bits *nil-descriptor*)))
1449
1450 ;;; Given a cold representation of a function name, return a warm
1451 ;;; representation.
1452 (declaim (ftype (function (descriptor) (or symbol list)) warm-fun-name))
1453 (defun warm-fun-name (des)
1454   (let ((result
1455          (ecase (descriptor-lowtag des)
1456            (#.sb!vm:list-pointer-lowtag
1457             (aver (not (cold-null des))) ; function named NIL? please no..
1458             ;; Do cold (DESTRUCTURING-BIND (COLD-CAR COLD-CADR) DES ..).
1459             (let* ((car-des (cold-car des))
1460                    (cdr-des (cold-cdr des))
1461                    (cadr-des (cold-car cdr-des))
1462                    (cddr-des (cold-cdr cdr-des)))
1463               (aver (cold-null cddr-des))
1464               (list (warm-symbol car-des)
1465                     (warm-symbol cadr-des))))
1466            (#.sb!vm:other-pointer-lowtag
1467             (warm-symbol des)))))
1468     (legal-fun-name-or-type-error result)
1469     result))
1470
1471 (defun cold-fdefinition-object (cold-name &optional leave-fn-raw)
1472   (declare (type descriptor cold-name))
1473   (/show0 "/cold-fdefinition-object")
1474   (let ((warm-name (warm-fun-name cold-name)))
1475     (or (gethash warm-name *cold-fdefn-objects*)
1476         (let ((fdefn (allocate-boxed-object (or *cold-fdefn-gspace* *dynamic*)
1477                                             (1- sb!vm:fdefn-size)
1478                                             sb!vm:other-pointer-lowtag)))
1479
1480           (setf (gethash warm-name *cold-fdefn-objects*) fdefn)
1481           (write-memory fdefn (make-other-immediate-descriptor
1482                                (1- sb!vm:fdefn-size) sb!vm:fdefn-widetag))
1483           (write-wordindexed fdefn sb!vm:fdefn-name-slot cold-name)
1484           (unless leave-fn-raw
1485             (write-wordindexed fdefn sb!vm:fdefn-fun-slot
1486                                *nil-descriptor*)
1487             (write-wordindexed fdefn
1488                                sb!vm:fdefn-raw-addr-slot
1489                                (make-random-descriptor
1490                                 (cold-foreign-symbol-address "undefined_tramp"))))
1491           fdefn))))
1492
1493 ;;; Handle the at-cold-init-time, fset-for-static-linkage operation
1494 ;;; requested by FOP-FSET.
1495 (defun static-fset (cold-name defn)
1496   (declare (type descriptor cold-name))
1497   (let ((fdefn (cold-fdefinition-object cold-name t))
1498         (type (logand (descriptor-low (read-memory defn)) sb!vm:widetag-mask)))
1499     (write-wordindexed fdefn sb!vm:fdefn-fun-slot defn)
1500     (write-wordindexed fdefn
1501                        sb!vm:fdefn-raw-addr-slot
1502                        (ecase type
1503                          (#.sb!vm:simple-fun-header-widetag
1504                           (/show0 "static-fset (simple-fun)")
1505                           #!+sparc
1506                           defn
1507                           #!-sparc
1508                           (make-random-descriptor
1509                            (+ (logandc2 (descriptor-bits defn)
1510                                         sb!vm:lowtag-mask)
1511                               (ash sb!vm:simple-fun-code-offset
1512                                    sb!vm:word-shift))))
1513                          (#.sb!vm:closure-header-widetag
1514                           (/show0 "/static-fset (closure)")
1515                           (make-random-descriptor
1516                            (cold-foreign-symbol-address "closure_tramp")))))
1517     fdefn))
1518
1519 (defun initialize-static-fns ()
1520   (let ((*cold-fdefn-gspace* *static*))
1521     (dolist (sym sb!vm:*static-funs*)
1522       (let* ((fdefn (cold-fdefinition-object (cold-intern sym)))
1523              (offset (- (+ (- (descriptor-low fdefn)
1524                               sb!vm:other-pointer-lowtag)
1525                            (* sb!vm:fdefn-raw-addr-slot sb!vm:n-word-bytes))
1526                         (descriptor-low *nil-descriptor*)))
1527              (desired (sb!vm:static-fun-offset sym)))
1528         (unless (= offset desired)
1529           ;; FIXME: should be fatal
1530           (error "Offset from FDEFN ~S to ~S is ~W, not ~W."
1531                  sym nil offset desired))))))
1532
1533 (defun list-all-fdefn-objects ()
1534   (let ((result *nil-descriptor*))
1535     (maphash (lambda (key value)
1536                (declare (ignore key))
1537                (cold-push value result))
1538              *cold-fdefn-objects*)
1539     result))
1540 \f
1541 ;;;; fixups and related stuff
1542
1543 ;;; an EQUAL hash table
1544 (defvar *cold-foreign-symbol-table*)
1545 (declaim (type hash-table *cold-foreign-symbol-table*))
1546
1547 ;; Read the sbcl.nm file to find the addresses for foreign-symbols in
1548 ;; the C runtime.
1549 (defun load-cold-foreign-symbol-table (filename)
1550   (/show "load-cold-foreign-symbol-table" filename)
1551   (with-open-file (file filename)
1552     (loop for line = (read-line file nil nil)
1553           while line do
1554           ;; UNIX symbol tables might have tabs in them, and tabs are
1555           ;; not in Common Lisp STANDARD-CHAR, so there seems to be no
1556           ;; nice portable way to deal with them within Lisp, alas.
1557           ;; Fortunately, it's easy to use UNIX command line tools like
1558           ;; sed to remove the problem, so it's not too painful for us
1559           ;; to push responsibility for converting tabs to spaces out to
1560           ;; the caller.
1561           ;;
1562           ;; Other non-STANDARD-CHARs are problematic for the same reason.
1563           ;; Make sure that there aren't any..
1564           (let ((ch (find-if (lambda (char)
1565                                (not (typep char 'standard-char)))
1566                              line)))
1567             (when ch
1568               (error "non-STANDARD-CHAR ~S found in foreign symbol table:~%~S"
1569                      ch
1570                      line)))
1571           (setf line (string-trim '(#\space) line))
1572           (let ((p1 (position #\space line :from-end nil))
1573                 (p2 (position #\space line :from-end t)))
1574             (if (not (and p1 p2 (< p1 p2)))
1575                 ;; KLUDGE: It's too messy to try to understand all
1576                 ;; possible output from nm, so we just punt the lines we
1577                 ;; don't recognize. We realize that there's some chance
1578                 ;; that might get us in trouble someday, so we warn
1579                 ;; about it.
1580                 (warn "ignoring unrecognized line ~S in ~A" line filename)
1581                 (multiple-value-bind (value name)
1582                     (if (string= "0x" line :end2 2)
1583                         (values (parse-integer line :start 2 :end p1 :radix 16)
1584                                 (subseq line (1+ p2)))
1585                         (values (parse-integer line :end p1 :radix 16)
1586                                 (subseq line (1+ p2))))
1587                   (multiple-value-bind (old-value found)
1588                       (gethash name *cold-foreign-symbol-table*)
1589                     (when (and found
1590                                (not (= old-value value)))
1591                       (warn "redefining ~S from #X~X to #X~X"
1592                             name old-value value)))
1593                   (/show "adding to *cold-foreign-symbol-table*:" name value)
1594                   (setf (gethash name *cold-foreign-symbol-table*) value))))))
1595   (values))     ;; PROGN
1596
1597 (defun cold-foreign-symbol-address (name)
1598   (or (find-foreign-symbol-in-table name *cold-foreign-symbol-table*)
1599       *foreign-symbol-placeholder-value*
1600       (progn
1601         (format *error-output* "~&The foreign symbol table is:~%")
1602         (maphash (lambda (k v)
1603                    (format *error-output* "~&~S = #X~8X~%" k v))
1604                  *cold-foreign-symbol-table*)
1605         (error "The foreign symbol ~S is undefined." name))))
1606
1607 (defvar *cold-assembler-routines*)
1608
1609 (defvar *cold-assembler-fixups*)
1610
1611 (defun record-cold-assembler-routine (name address)
1612   (/xhow "in RECORD-COLD-ASSEMBLER-ROUTINE" name address)
1613   (push (cons name address)
1614         *cold-assembler-routines*))
1615
1616 (defun record-cold-assembler-fixup (routine
1617                                     code-object
1618                                     offset
1619                                     &optional
1620                                     (kind :both))
1621   (push (list routine code-object offset kind)
1622         *cold-assembler-fixups*))
1623
1624 (defun lookup-assembler-reference (symbol)
1625   (let ((value (cdr (assoc symbol *cold-assembler-routines*))))
1626     ;; FIXME: Should this be ERROR instead of WARN?
1627     (unless value
1628       (warn "Assembler routine ~S not defined." symbol))
1629     value))
1630
1631 ;;; The x86 port needs to store code fixups along with code objects if
1632 ;;; they are to be moved, so fixups for code objects in the dynamic
1633 ;;; heap need to be noted.
1634 #!+(or x86 x86-64)
1635 (defvar *load-time-code-fixups*)
1636
1637 #!+(or x86 x86-64)
1638 (defun note-load-time-code-fixup (code-object offset value kind)
1639   ;; If CODE-OBJECT might be moved
1640   (when (= (gspace-identifier (descriptor-intuit-gspace code-object))
1641            dynamic-core-space-id)
1642     ;; FIXME: pushed thing should be a structure, not just a list
1643     (push (list code-object offset value kind) *load-time-code-fixups*))
1644   (values))
1645
1646 #!+(or x86 x86-64)
1647 (defun output-load-time-code-fixups ()
1648   (dolist (fixups *load-time-code-fixups*)
1649     (let ((code-object (first fixups))
1650           (offset (second fixups))
1651           (value (third fixups))
1652           (kind (fourth fixups)))
1653       (cold-push (cold-cons
1654                   (cold-intern :load-time-code-fixup)
1655                   (cold-cons
1656                    code-object
1657                    (cold-cons
1658                     (number-to-core offset)
1659                     (cold-cons
1660                      (number-to-core value)
1661                      (cold-cons
1662                       (cold-intern kind)
1663                       *nil-descriptor*)))))
1664                  *current-reversed-cold-toplevels*))))
1665
1666 ;;; Given a pointer to a code object and an offset relative to the
1667 ;;; tail of the code object's header, return an offset relative to the
1668 ;;; (beginning of the) code object.
1669 ;;;
1670 ;;; FIXME: It might be clearer to reexpress
1671 ;;;    (LET ((X (CALC-OFFSET CODE-OBJECT OFFSET0))) ..)
1672 ;;; as
1673 ;;;    (LET ((X (+ OFFSET0 (CODE-OBJECT-HEADER-N-BYTES CODE-OBJECT)))) ..).
1674 (declaim (ftype (function (descriptor sb!vm:word)) calc-offset))
1675 (defun calc-offset (code-object offset-from-tail-of-header)
1676   (let* ((header (read-memory code-object))
1677          (header-n-words (ash (descriptor-bits header)
1678                               (- sb!vm:n-widetag-bits)))
1679          (header-n-bytes (ash header-n-words sb!vm:word-shift))
1680          (result (+ offset-from-tail-of-header header-n-bytes)))
1681     result))
1682
1683 (declaim (ftype (function (descriptor sb!vm:word sb!vm:word keyword))
1684                 do-cold-fixup))
1685 (defun do-cold-fixup (code-object after-header value kind)
1686   (let* ((offset-within-code-object (calc-offset code-object after-header))
1687          (gspace-bytes (descriptor-bytes code-object))
1688          (gspace-byte-offset (+ (descriptor-byte-offset code-object)
1689                                 offset-within-code-object))
1690          (gspace-byte-address (gspace-byte-address
1691                                (descriptor-gspace code-object))))
1692     (ecase +backend-fasl-file-implementation+
1693       ;; See CMU CL source for other formerly-supported architectures
1694       ;; (and note that you have to rewrite them to use BVREF-X
1695       ;; instead of SAP-REF).
1696       (:alpha
1697          (ecase kind
1698          (:jmp-hint
1699           (assert (zerop (ldb (byte 2 0) value))))
1700          (:bits-63-48
1701           (let* ((value (if (logbitp 15 value) (+ value (ash 1 16)) value))
1702                  (value (if (logbitp 31 value) (+ value (ash 1 32)) value))
1703                  (value (if (logbitp 47 value) (+ value (ash 1 48)) value)))
1704             (setf (bvref-8 gspace-bytes gspace-byte-offset)
1705                   (ldb (byte 8 48) value)
1706                   (bvref-8 gspace-bytes (1+ gspace-byte-offset))
1707                   (ldb (byte 8 56) value))))
1708          (:bits-47-32
1709           (let* ((value (if (logbitp 15 value) (+ value (ash 1 16)) value))
1710                  (value (if (logbitp 31 value) (+ value (ash 1 32)) value)))
1711             (setf (bvref-8 gspace-bytes gspace-byte-offset)
1712                   (ldb (byte 8 32) value)
1713                   (bvref-8 gspace-bytes (1+ gspace-byte-offset))
1714                   (ldb (byte 8 40) value))))
1715          (:ldah
1716           (let ((value (if (logbitp 15 value) (+ value (ash 1 16)) value)))
1717             (setf (bvref-8 gspace-bytes gspace-byte-offset)
1718                   (ldb (byte 8 16) value)
1719                   (bvref-8 gspace-bytes (1+ gspace-byte-offset))
1720                   (ldb (byte 8 24) value))))
1721          (:lda
1722           (setf (bvref-8 gspace-bytes gspace-byte-offset)
1723                 (ldb (byte 8 0) value)
1724                 (bvref-8 gspace-bytes (1+ gspace-byte-offset))
1725                 (ldb (byte 8 8) value)))))
1726       (:hppa
1727        (ecase kind
1728          (:load
1729           (setf (bvref-32 gspace-bytes gspace-byte-offset)
1730                 (logior (ash (ldb (byte 11 0) value) 1)
1731                         (logand (bvref-32 gspace-bytes gspace-byte-offset)
1732                                 #xffffc000))))
1733          (:load-short
1734           (let ((low-bits (ldb (byte 11 0) value)))
1735             (assert (<= 0 low-bits (1- (ash 1 4))))
1736             (setf (bvref-32 gspace-bytes gspace-byte-offset)
1737                   (logior (ash low-bits 17)
1738                           (logand (bvref-32 gspace-bytes gspace-byte-offset)
1739                                   #xffe0ffff)))))
1740          (:hi
1741           (setf (bvref-32 gspace-bytes gspace-byte-offset)
1742                 (logior (ash (ldb (byte 5 13) value) 16)
1743                         (ash (ldb (byte 2 18) value) 14)
1744                         (ash (ldb (byte 2 11) value) 12)
1745                         (ash (ldb (byte 11 20) value) 1)
1746                         (ldb (byte 1 31) value)
1747                         (logand (bvref-32 gspace-bytes gspace-byte-offset)
1748                                 #xffe00000))))
1749          (:branch
1750           (let ((bits (ldb (byte 9 2) value)))
1751             (assert (zerop (ldb (byte 2 0) value)))
1752             (setf (bvref-32 gspace-bytes gspace-byte-offset)
1753                   (logior (ash bits 3)
1754                           (logand (bvref-32 gspace-bytes gspace-byte-offset)
1755                                   #xffe0e002)))))))
1756       (:mips
1757        (ecase kind
1758          (:jump
1759           (assert (zerop (ash value -28)))
1760           (setf (ldb (byte 26 0)
1761                      (bvref-32 gspace-bytes gspace-byte-offset))
1762                 (ash value -2)))
1763          (:lui
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                         (ash (1+ (ldb (byte 17 15) value)) -1))))
1768          (:addi
1769           (setf (bvref-32 gspace-bytes gspace-byte-offset)
1770                 (logior (mask-field (byte 16 16)
1771                                     (bvref-32 gspace-bytes gspace-byte-offset))
1772                         (ldb (byte 16 0) value))))))
1773        ;; FIXME: PowerPC Fixups are not fully implemented. The bit
1774        ;; here starts to set things up to work properly, but there
1775        ;; needs to be corresponding code in ppc-vm.lisp
1776        (:ppc
1777         (ecase kind
1778           (:ba
1779            (setf (bvref-32 gspace-bytes gspace-byte-offset)
1780                  (dpb (ash value -2) (byte 24 2)
1781                       (bvref-32 gspace-bytes gspace-byte-offset))))
1782           (:ha
1783            (let* ((un-fixed-up (bvref-16 gspace-bytes
1784                                          (+ gspace-byte-offset 2)))
1785                   (fixed-up (+ un-fixed-up value))
1786                   (h (ldb (byte 16 16) fixed-up))
1787                   (l (ldb (byte 16 0) fixed-up)))
1788              (setf (bvref-16 gspace-bytes (+ gspace-byte-offset 2))
1789                    (if (logbitp 15 l) (ldb (byte 16 0) (1+ h)) h))))
1790           (:l
1791            (let* ((un-fixed-up (bvref-16 gspace-bytes
1792                                          (+ gspace-byte-offset 2)))
1793                   (fixed-up (+ un-fixed-up value)))
1794              (setf (bvref-16 gspace-bytes (+ gspace-byte-offset 2))
1795                    (ldb (byte 16 0) fixed-up))))))
1796       (:sparc
1797        (ecase kind
1798          (:call
1799           (error "can't deal with call fixups yet"))
1800          (:sethi
1801           (setf (bvref-32 gspace-bytes gspace-byte-offset)
1802                 (dpb (ldb (byte 22 10) value)
1803                      (byte 22 0)
1804                      (bvref-32 gspace-bytes gspace-byte-offset))))
1805          (:add
1806           (setf (bvref-32 gspace-bytes gspace-byte-offset)
1807                 (dpb (ldb (byte 10 0) value)
1808                      (byte 10 0)
1809                      (bvref-32 gspace-bytes gspace-byte-offset))))))
1810       ((:x86 :x86-64)
1811        (let* ((un-fixed-up (bvref-word gspace-bytes
1812                                                gspace-byte-offset))
1813               (code-object-start-addr (logandc2 (descriptor-bits code-object)
1814                                                 sb!vm:lowtag-mask)))
1815          (assert (= code-object-start-addr
1816                   (+ gspace-byte-address
1817                      (descriptor-byte-offset code-object))))
1818          (ecase kind
1819            (:absolute
1820             (let ((fixed-up (+ value un-fixed-up)))
1821               (setf (bvref-32 gspace-bytes gspace-byte-offset)
1822                     fixed-up)
1823               ;; comment from CMU CL sources:
1824               ;;
1825               ;; Note absolute fixups that point within the object.
1826               ;; KLUDGE: There seems to be an implicit assumption in
1827               ;; the old CMU CL code here, that if it doesn't point
1828               ;; before the object, it must point within the object
1829               ;; (not beyond it). It would be good to add an
1830               ;; explanation of why that's true, or an assertion that
1831               ;; it's really true, or both.
1832               (unless (< fixed-up code-object-start-addr)
1833                 (note-load-time-code-fixup code-object
1834                                            after-header
1835                                            value
1836                                            kind))))
1837            (:relative ; (used for arguments to X86 relative CALL instruction)
1838             (let ((fixed-up (- (+ value un-fixed-up)
1839                                gspace-byte-address
1840                                gspace-byte-offset
1841                                4))) ; "length of CALL argument"
1842               (setf (bvref-32 gspace-bytes gspace-byte-offset)
1843                     fixed-up)
1844               ;; Note relative fixups that point outside the code
1845               ;; object, which is to say all relative fixups, since
1846               ;; relative addressing within a code object never needs
1847               ;; a fixup.
1848               (note-load-time-code-fixup code-object
1849                                          after-header
1850                                          value
1851                                          kind))))))))
1852   (values))
1853
1854 (defun resolve-assembler-fixups ()
1855   (dolist (fixup *cold-assembler-fixups*)
1856     (let* ((routine (car fixup))
1857            (value (lookup-assembler-reference routine)))
1858       (when value
1859         (do-cold-fixup (second fixup) (third fixup) value (fourth fixup))))))
1860
1861 ;;; *COLD-FOREIGN-SYMBOL-TABLE* becomes *!INITIAL-FOREIGN-SYMBOLS* in
1862 ;;; the core. When the core is loaded, !LOADER-COLD-INIT uses this to
1863 ;;; create *STATIC-FOREIGN-SYMBOLS*, which the code in
1864 ;;; target-load.lisp refers to.
1865 (defun foreign-symbols-to-core ()
1866   (let ((result *nil-descriptor*))
1867     (maphash (lambda (symbol value)
1868                (cold-push (cold-cons (base-string-to-core symbol)
1869                                      (number-to-core value))
1870                           result))
1871              *cold-foreign-symbol-table*)
1872     (cold-set (cold-intern 'sb!kernel:*!initial-foreign-symbols*) result))
1873   (let ((result *nil-descriptor*))
1874     (dolist (rtn *cold-assembler-routines*)
1875       (cold-push (cold-cons (cold-intern (car rtn))
1876                             (number-to-core (cdr rtn)))
1877                  result))
1878     (cold-set (cold-intern '*!initial-assembler-routines*) result)))
1879
1880 \f
1881 ;;;; general machinery for cold-loading FASL files
1882
1883 ;;; FOP functions for cold loading
1884 (defvar *cold-fop-funs*
1885   ;; We start out with a copy of the ordinary *FOP-FUNS*. The ones
1886   ;; which aren't appropriate for cold load will be destructively
1887   ;; modified.
1888   (copy-seq *fop-funs*))
1889
1890 (defvar *normal-fop-funs*)
1891
1892 ;;; Cause a fop to have a special definition for cold load.
1893 ;;;
1894 ;;; This is similar to DEFINE-FOP, but unlike DEFINE-FOP, this version
1895 ;;;   (1) looks up the code for this name (created by a previous
1896 ;;        DEFINE-FOP) instead of creating a code, and
1897 ;;;   (2) stores its definition in the *COLD-FOP-FUNS* vector,
1898 ;;;       instead of storing in the *FOP-FUNS* vector.
1899 (defmacro define-cold-fop ((name &key (pushp t) (stackp t)) &rest forms)
1900   (aver (member pushp '(nil t)))
1901   (aver (member stackp '(nil t)))
1902   (let ((code (get name 'fop-code))
1903         (fname (symbolicate "COLD-" name)))
1904     (unless code
1905       (error "~S is not a defined FOP." name))
1906     `(progn
1907        (defun ,fname ()
1908          ,@(if stackp
1909                `((with-fop-stack ,pushp ,@forms))
1910                forms))
1911        (setf (svref *cold-fop-funs* ,code) #',fname))))
1912
1913 (defmacro clone-cold-fop ((name &key (pushp t) (stackp t))
1914                           (small-name)
1915                           &rest forms)
1916   (aver (member pushp '(nil t)))
1917   (aver (member stackp '(nil t)))
1918   `(progn
1919     (macrolet ((clone-arg () '(read-word-arg)))
1920       (define-cold-fop (,name :pushp ,pushp :stackp ,stackp) ,@forms))
1921     (macrolet ((clone-arg () '(read-byte-arg)))
1922       (define-cold-fop (,small-name :pushp ,pushp :stackp ,stackp) ,@forms))))
1923
1924 ;;; Cause a fop to be undefined in cold load.
1925 (defmacro not-cold-fop (name)
1926   `(define-cold-fop (,name)
1927      (error "The fop ~S is not supported in cold load." ',name)))
1928
1929 ;;; COLD-LOAD loads stuff into the core image being built by calling
1930 ;;; LOAD-AS-FASL with the fop function table rebound to a table of cold
1931 ;;; loading functions.
1932 (defun cold-load (filename)
1933   #!+sb-doc
1934   "Load the file named by FILENAME into the cold load image being built."
1935   (let* ((*normal-fop-funs* *fop-funs*)
1936          (*fop-funs* *cold-fop-funs*)
1937          (*cold-load-filename* (etypecase filename
1938                                  (string filename)
1939                                  (pathname (namestring filename)))))
1940     (with-open-file (s filename :element-type '(unsigned-byte 8))
1941       (load-as-fasl s nil nil))))
1942 \f
1943 ;;;; miscellaneous cold fops
1944
1945 (define-cold-fop (fop-misc-trap) *unbound-marker*)
1946
1947 (define-cold-fop (fop-short-character)
1948   (make-character-descriptor (read-byte-arg)))
1949
1950 (define-cold-fop (fop-empty-list) *nil-descriptor*)
1951 (define-cold-fop (fop-truth) (cold-intern t))
1952
1953 (define-cold-fop (fop-normal-load :stackp nil)
1954   (setq *fop-funs* *normal-fop-funs*))
1955
1956 (define-fop (fop-maybe-cold-load 82 :stackp nil)
1957   (when *cold-load-filename*
1958     (setq *fop-funs* *cold-fop-funs*)))
1959
1960 (define-cold-fop (fop-maybe-cold-load :stackp nil))
1961
1962 (clone-cold-fop (fop-struct)
1963                 (fop-small-struct)
1964   (let* ((size (clone-arg))
1965          (result (allocate-boxed-object *dynamic*
1966                                         (1+ size)
1967                                         sb!vm:instance-pointer-lowtag))
1968          (layout (pop-stack))
1969          (nuntagged
1970           (descriptor-fixnum
1971            (read-wordindexed
1972             layout
1973             (+ sb!vm:instance-slots-offset
1974                (target-layout-index 'n-untagged-slots)))))
1975          (ntagged (- size nuntagged)))
1976     (write-memory result (make-other-immediate-descriptor
1977                           size sb!vm:instance-header-widetag))
1978     (write-wordindexed result sb!vm:instance-slots-offset layout)
1979     (do ((index 1 (1+ index)))
1980         ((eql index size))
1981       (declare (fixnum index))
1982       (write-wordindexed result
1983                          (+ index sb!vm:instance-slots-offset)
1984                          (if (>= index ntagged)
1985                              (descriptor-word-sized-integer (pop-stack))
1986                              (pop-stack))))
1987     result))
1988
1989 (define-cold-fop (fop-layout)
1990   (let* ((nuntagged-des (pop-stack))
1991          (length-des (pop-stack))
1992          (depthoid-des (pop-stack))
1993          (cold-inherits (pop-stack))
1994          (name (pop-stack))
1995          (old (gethash name *cold-layouts*)))
1996     (declare (type descriptor length-des depthoid-des cold-inherits))
1997     (declare (type symbol name))
1998     ;; If a layout of this name has been defined already
1999     (if old
2000       ;; Enforce consistency between the previous definition and the
2001       ;; current definition, then return the previous definition.
2002       (destructuring-bind
2003           ;; FIXME: This would be more maintainable if we used
2004           ;; DEFSTRUCT (:TYPE LIST) to define COLD-LAYOUT. -- WHN 19990825
2005           (old-layout-descriptor
2006            old-name
2007            old-length
2008            old-inherits-list
2009            old-depthoid
2010            old-nuntagged)
2011           old
2012         (declare (type descriptor old-layout-descriptor))
2013         (declare (type index old-length old-nuntagged))
2014         (declare (type fixnum old-depthoid))
2015         (declare (type list old-inherits-list))
2016         (aver (eq name old-name))
2017         (let ((length (descriptor-fixnum length-des))
2018               (inherits-list (listify-cold-inherits cold-inherits))
2019               (depthoid (descriptor-fixnum depthoid-des))
2020               (nuntagged (descriptor-fixnum nuntagged-des)))
2021           (unless (= length old-length)
2022             (error "cold loading a reference to class ~S when the compile~%~
2023                     time length was ~S and current length is ~S"
2024                    name
2025                    length
2026                    old-length))
2027           (unless (equal inherits-list old-inherits-list)
2028             (error "cold loading a reference to class ~S when the compile~%~
2029                     time inherits were ~S~%~
2030                     and current inherits are ~S"
2031                    name
2032                    inherits-list
2033                    old-inherits-list))
2034           (unless (= depthoid old-depthoid)
2035             (error "cold loading a reference to class ~S when the compile~%~
2036                     time inheritance depthoid was ~S and current inheritance~%~
2037                     depthoid is ~S"
2038                    name
2039                    depthoid
2040                    old-depthoid))
2041           (unless (= nuntagged old-nuntagged)
2042             (error "cold loading a reference to class ~S when the compile~%~
2043                     time number of untagged slots was ~S and is currently ~S"
2044                    name
2045                    nuntagged
2046                    old-nuntagged)))
2047         old-layout-descriptor)
2048       ;; Make a new definition from scratch.
2049       (make-cold-layout name length-des cold-inherits depthoid-des
2050                         nuntagged-des))))
2051 \f
2052 ;;;; cold fops for loading symbols
2053
2054 ;;; Load a symbol SIZE characters long from *FASL-INPUT-STREAM* and
2055 ;;; intern that symbol in PACKAGE.
2056 (defun cold-load-symbol (size package)
2057   (let ((string (make-string size)))
2058     (read-string-as-bytes *fasl-input-stream* string)
2059     (cold-intern (intern string package))))
2060
2061 (macrolet ((frob (name pname-len package-len)
2062              `(define-cold-fop (,name)
2063                 (let ((index (read-arg ,package-len)))
2064                   (push-fop-table
2065                    (cold-load-symbol (read-arg ,pname-len)
2066                                      (svref *current-fop-table* index)))))))
2067   (frob fop-symbol-in-package-save #.sb!vm:n-word-bytes #.sb!vm:n-word-bytes)
2068   (frob fop-small-symbol-in-package-save 1 #.sb!vm:n-word-bytes)
2069   (frob fop-symbol-in-byte-package-save #.sb!vm:n-word-bytes 1)
2070   (frob fop-small-symbol-in-byte-package-save 1 1))
2071
2072 (clone-cold-fop (fop-lisp-symbol-save)
2073                 (fop-lisp-small-symbol-save)
2074   (push-fop-table (cold-load-symbol (clone-arg) *cl-package*)))
2075
2076 (clone-cold-fop (fop-keyword-symbol-save)
2077                 (fop-keyword-small-symbol-save)
2078   (push-fop-table (cold-load-symbol (clone-arg) *keyword-package*)))
2079
2080 (clone-cold-fop (fop-uninterned-symbol-save)
2081                 (fop-uninterned-small-symbol-save)
2082   (let* ((size (clone-arg))
2083          (name (make-string size)))
2084     (read-string-as-bytes *fasl-input-stream* name)
2085     (let ((symbol-des (allocate-symbol name)))
2086       (push-fop-table symbol-des))))
2087 \f
2088 ;;;; cold fops for loading lists
2089
2090 ;;; Make a list of the top LENGTH things on the fop stack. The last
2091 ;;; cdr of the list is set to LAST.
2092 (defmacro cold-stack-list (length last)
2093   `(do* ((index ,length (1- index))
2094          (result ,last (cold-cons (pop-stack) result)))
2095         ((= index 0) result)
2096      (declare (fixnum index))))
2097
2098 (define-cold-fop (fop-list)
2099   (cold-stack-list (read-byte-arg) *nil-descriptor*))
2100 (define-cold-fop (fop-list*)
2101   (cold-stack-list (read-byte-arg) (pop-stack)))
2102 (define-cold-fop (fop-list-1)
2103   (cold-stack-list 1 *nil-descriptor*))
2104 (define-cold-fop (fop-list-2)
2105   (cold-stack-list 2 *nil-descriptor*))
2106 (define-cold-fop (fop-list-3)
2107   (cold-stack-list 3 *nil-descriptor*))
2108 (define-cold-fop (fop-list-4)
2109   (cold-stack-list 4 *nil-descriptor*))
2110 (define-cold-fop (fop-list-5)
2111   (cold-stack-list 5 *nil-descriptor*))
2112 (define-cold-fop (fop-list-6)
2113   (cold-stack-list 6 *nil-descriptor*))
2114 (define-cold-fop (fop-list-7)
2115   (cold-stack-list 7 *nil-descriptor*))
2116 (define-cold-fop (fop-list-8)
2117   (cold-stack-list 8 *nil-descriptor*))
2118 (define-cold-fop (fop-list*-1)
2119   (cold-stack-list 1 (pop-stack)))
2120 (define-cold-fop (fop-list*-2)
2121   (cold-stack-list 2 (pop-stack)))
2122 (define-cold-fop (fop-list*-3)
2123   (cold-stack-list 3 (pop-stack)))
2124 (define-cold-fop (fop-list*-4)
2125   (cold-stack-list 4 (pop-stack)))
2126 (define-cold-fop (fop-list*-5)
2127   (cold-stack-list 5 (pop-stack)))
2128 (define-cold-fop (fop-list*-6)
2129   (cold-stack-list 6 (pop-stack)))
2130 (define-cold-fop (fop-list*-7)
2131   (cold-stack-list 7 (pop-stack)))
2132 (define-cold-fop (fop-list*-8)
2133   (cold-stack-list 8 (pop-stack)))
2134 \f
2135 ;;;; cold fops for loading vectors
2136
2137 (clone-cold-fop (fop-base-string)
2138                 (fop-small-base-string)
2139   (let* ((len (clone-arg))
2140          (string (make-string len)))
2141     (read-string-as-bytes *fasl-input-stream* string)
2142     (base-string-to-core string)))
2143
2144 #!+sb-unicode
2145 (clone-cold-fop (fop-character-string)
2146                 (fop-small-character-string)
2147   (bug "CHARACTER-STRING dumped by cross-compiler."))
2148
2149 (clone-cold-fop (fop-vector)
2150                 (fop-small-vector)
2151   (let* ((size (clone-arg))
2152          (result (allocate-vector-object *dynamic*
2153                                          sb!vm:n-word-bits
2154                                          size
2155                                          sb!vm:simple-vector-widetag)))
2156     (do ((index (1- size) (1- index)))
2157         ((minusp index))
2158       (declare (fixnum index))
2159       (write-wordindexed result
2160                          (+ index sb!vm:vector-data-offset)
2161                          (pop-stack)))
2162     result))
2163
2164 (define-cold-fop (fop-int-vector)
2165   (let* ((len (read-word-arg))
2166          (sizebits (read-byte-arg))
2167          (type (case sizebits
2168                  (0 sb!vm:simple-array-nil-widetag)
2169                  (1 sb!vm:simple-bit-vector-widetag)
2170                  (2 sb!vm:simple-array-unsigned-byte-2-widetag)
2171                  (4 sb!vm:simple-array-unsigned-byte-4-widetag)
2172                  (7 (prog1 sb!vm:simple-array-unsigned-byte-7-widetag
2173                       (setf sizebits 8)))
2174                  (8 sb!vm:simple-array-unsigned-byte-8-widetag)
2175                  (15 (prog1 sb!vm:simple-array-unsigned-byte-15-widetag
2176                        (setf sizebits 16)))
2177                  (16 sb!vm:simple-array-unsigned-byte-16-widetag)
2178                  (31 (prog1 sb!vm:simple-array-unsigned-byte-31-widetag
2179                        (setf sizebits 32)))
2180                  (32 sb!vm:simple-array-unsigned-byte-32-widetag)
2181                  #!+#.(cl:if (cl:= 64 sb!vm:n-word-bits) '(and) '(or))
2182                  (63 (prog1 sb!vm:simple-array-unsigned-byte-63-widetag
2183                        (setf sizebits 64)))
2184                  #!+#.(cl:if (cl:= 64 sb!vm:n-word-bits) '(and) '(or))
2185                  (64 sb!vm:simple-array-unsigned-byte-64-widetag)
2186                  (t (error "losing element size: ~W" sizebits))))
2187          (result (allocate-vector-object *dynamic* sizebits len type))
2188          (start (+ (descriptor-byte-offset result)
2189                    (ash sb!vm:vector-data-offset sb!vm:word-shift)))
2190          (end (+ start
2191                  (ceiling (* len sizebits)
2192                           sb!vm:n-byte-bits))))
2193     (read-bigvec-as-sequence-or-die (descriptor-bytes result)
2194                                     *fasl-input-stream*
2195                                     :start start
2196                                     :end end)
2197     result))
2198
2199 (define-cold-fop (fop-single-float-vector)
2200   (let* ((len (read-word-arg))
2201          (result (allocate-vector-object
2202                   *dynamic*
2203                   sb!vm:n-word-bits
2204                   len
2205                   sb!vm:simple-array-single-float-widetag))
2206          (start (+ (descriptor-byte-offset result)
2207                    (ash sb!vm:vector-data-offset sb!vm:word-shift)))
2208          (end (+ start (* len 4))))
2209     (read-bigvec-as-sequence-or-die (descriptor-bytes result)
2210                                     *fasl-input-stream*
2211                                     :start start
2212                                     :end end)
2213     result))
2214
2215 (not-cold-fop fop-double-float-vector)
2216 #!+long-float (not-cold-fop fop-long-float-vector)
2217 (not-cold-fop fop-complex-single-float-vector)
2218 (not-cold-fop fop-complex-double-float-vector)
2219 #!+long-float (not-cold-fop fop-complex-long-float-vector)
2220
2221 (define-cold-fop (fop-array)
2222   (let* ((rank (read-word-arg))
2223          (data-vector (pop-stack))
2224          (result (allocate-boxed-object *dynamic*
2225                                         (+ sb!vm:array-dimensions-offset rank)
2226                                         sb!vm:other-pointer-lowtag)))
2227     (write-memory result
2228                   (make-other-immediate-descriptor rank
2229                                                    sb!vm:simple-array-widetag))
2230     (write-wordindexed result sb!vm:array-fill-pointer-slot *nil-descriptor*)
2231     (write-wordindexed result sb!vm:array-data-slot data-vector)
2232     (write-wordindexed result sb!vm:array-displacement-slot *nil-descriptor*)
2233     (write-wordindexed result sb!vm:array-displaced-p-slot *nil-descriptor*)
2234     (let ((total-elements 1))
2235       (dotimes (axis rank)
2236         (let ((dim (pop-stack)))
2237           (unless (or (= (descriptor-lowtag dim) sb!vm:even-fixnum-lowtag)
2238                       (= (descriptor-lowtag dim) sb!vm:odd-fixnum-lowtag))
2239             (error "non-fixnum dimension? (~S)" dim))
2240           (setf total-elements
2241                 (* total-elements
2242                    (logior (ash (descriptor-high dim)
2243                                 (- descriptor-low-bits
2244                                    (1- sb!vm:n-lowtag-bits)))
2245                            (ash (descriptor-low dim)
2246                                 (- 1 sb!vm:n-lowtag-bits)))))
2247           (write-wordindexed result
2248                              (+ sb!vm:array-dimensions-offset axis)
2249                              dim)))
2250       (write-wordindexed result
2251                          sb!vm:array-elements-slot
2252                          (make-fixnum-descriptor total-elements)))
2253     result))
2254
2255 \f
2256 ;;;; cold fops for loading numbers
2257
2258 (defmacro define-cold-number-fop (fop)
2259   `(define-cold-fop (,fop :stackp nil)
2260      ;; Invoke the ordinary warm version of this fop to push the
2261      ;; number.
2262      (,fop)
2263      ;; Replace the warm fop result with the cold image of the warm
2264      ;; fop result.
2265      (with-fop-stack t
2266        (let ((number (pop-stack)))
2267          (number-to-core number)))))
2268
2269 (define-cold-number-fop fop-single-float)
2270 (define-cold-number-fop fop-double-float)
2271 (define-cold-number-fop fop-integer)
2272 (define-cold-number-fop fop-small-integer)
2273 (define-cold-number-fop fop-word-integer)
2274 (define-cold-number-fop fop-byte-integer)
2275 (define-cold-number-fop fop-complex-single-float)
2276 (define-cold-number-fop fop-complex-double-float)
2277
2278 (define-cold-fop (fop-ratio)
2279   (let ((den (pop-stack)))
2280     (number-pair-to-core (pop-stack) den sb!vm:ratio-widetag)))
2281
2282 (define-cold-fop (fop-complex)
2283   (let ((im (pop-stack)))
2284     (number-pair-to-core (pop-stack) im sb!vm:complex-widetag)))
2285 \f
2286 ;;;; cold fops for calling (or not calling)
2287
2288 (not-cold-fop fop-eval)
2289 (not-cold-fop fop-eval-for-effect)
2290
2291 (defvar *load-time-value-counter*)
2292
2293 (define-cold-fop (fop-funcall)
2294   (unless (= (read-byte-arg) 0)
2295     (error "You can't FOP-FUNCALL arbitrary stuff in cold load."))
2296   (let ((counter *load-time-value-counter*))
2297     (cold-push (cold-cons
2298                 (cold-intern :load-time-value)
2299                 (cold-cons
2300                  (pop-stack)
2301                  (cold-cons
2302                   (number-to-core counter)
2303                   *nil-descriptor*)))
2304                *current-reversed-cold-toplevels*)
2305     (setf *load-time-value-counter* (1+ counter))
2306     (make-descriptor 0 0 nil counter)))
2307
2308 (defun finalize-load-time-value-noise ()
2309   (cold-set (cold-intern '*!load-time-values*)
2310             (allocate-vector-object *dynamic*
2311                                     sb!vm:n-word-bits
2312                                     *load-time-value-counter*
2313                                     sb!vm:simple-vector-widetag)))
2314
2315 (define-cold-fop (fop-funcall-for-effect :pushp nil)
2316   (if (= (read-byte-arg) 0)
2317       (cold-push (pop-stack)
2318                  *current-reversed-cold-toplevels*)
2319       (error "You can't FOP-FUNCALL arbitrary stuff in cold load.")))
2320 \f
2321 ;;;; cold fops for fixing up circularities
2322
2323 (define-cold-fop (fop-rplaca :pushp nil)
2324   (let ((obj (svref *current-fop-table* (read-word-arg)))
2325         (idx (read-word-arg)))
2326     (write-memory (cold-nthcdr idx obj) (pop-stack))))
2327
2328 (define-cold-fop (fop-rplacd :pushp nil)
2329   (let ((obj (svref *current-fop-table* (read-word-arg)))
2330         (idx (read-word-arg)))
2331     (write-wordindexed (cold-nthcdr idx obj) 1 (pop-stack))))
2332
2333 (define-cold-fop (fop-svset :pushp nil)
2334   (let ((obj (svref *current-fop-table* (read-word-arg)))
2335         (idx (read-word-arg)))
2336     (write-wordindexed obj
2337                    (+ idx
2338                       (ecase (descriptor-lowtag obj)
2339                         (#.sb!vm:instance-pointer-lowtag 1)
2340                         (#.sb!vm:other-pointer-lowtag 2)))
2341                    (pop-stack))))
2342
2343 (define-cold-fop (fop-structset :pushp nil)
2344   (let ((obj (svref *current-fop-table* (read-word-arg)))
2345         (idx (read-word-arg)))
2346     (write-wordindexed obj (1+ idx) (pop-stack))))
2347
2348 ;;; In the original CMUCL code, this actually explicitly declared PUSHP
2349 ;;; to be T, even though that's what it defaults to in DEFINE-COLD-FOP.
2350 (define-cold-fop (fop-nthcdr)
2351   (cold-nthcdr (read-word-arg) (pop-stack)))
2352
2353 (defun cold-nthcdr (index obj)
2354   (dotimes (i index)
2355     (setq obj (read-wordindexed obj 1)))
2356   obj)
2357 \f
2358 ;;;; cold fops for loading code objects and functions
2359
2360 ;;; the names of things which have had COLD-FSET used on them already
2361 ;;; (used to make sure that we don't try to statically link a name to
2362 ;;; more than one definition)
2363 (defparameter *cold-fset-warm-names*
2364   ;; This can't be an EQL hash table because names can be conses, e.g.
2365   ;; (SETF CAR).
2366   (make-hash-table :test 'equal))
2367
2368 (define-cold-fop (fop-fset :pushp nil)
2369   (let* ((fn (pop-stack))
2370          (cold-name (pop-stack))
2371          (warm-name (warm-fun-name cold-name)))
2372     (if (gethash warm-name *cold-fset-warm-names*)
2373         (error "duplicate COLD-FSET for ~S" warm-name)
2374         (setf (gethash warm-name *cold-fset-warm-names*) t))
2375     (static-fset cold-name fn)))
2376
2377 (define-cold-fop (fop-fdefinition)
2378   (cold-fdefinition-object (pop-stack)))
2379
2380 (define-cold-fop (fop-sanctify-for-execution)
2381   (pop-stack))
2382
2383 ;;; Setting this variable shows what code looks like before any
2384 ;;; fixups (or function headers) are applied.
2385 #!+sb-show (defvar *show-pre-fixup-code-p* nil)
2386
2387 ;;; FIXME: The logic here should be converted into a function
2388 ;;; COLD-CODE-FOP-GUTS (NCONST CODE-SIZE) called by DEFINE-COLD-FOP
2389 ;;; FOP-CODE and DEFINE-COLD-FOP FOP-SMALL-CODE, so that
2390 ;;; variable-capture nastiness like (LET ((NCONST ,NCONST) ..) ..)
2391 ;;; doesn't keep me awake at night.
2392 (defmacro define-cold-code-fop (name nconst code-size)
2393   `(define-cold-fop (,name)
2394      (let* ((nconst ,nconst)
2395             (code-size ,code-size)
2396             (raw-header-n-words (+ sb!vm:code-trace-table-offset-slot nconst))
2397             (header-n-words
2398              ;; Note: we round the number of constants up to ensure
2399              ;; that the code vector will be properly aligned.
2400              (round-up raw-header-n-words 2))
2401             (des (allocate-cold-descriptor *dynamic*
2402                                            (+ (ash header-n-words
2403                                                    sb!vm:word-shift)
2404                                               code-size)
2405                                            sb!vm:other-pointer-lowtag)))
2406        (write-memory des
2407                      (make-other-immediate-descriptor
2408                       header-n-words sb!vm:code-header-widetag))
2409        (write-wordindexed des
2410                           sb!vm:code-code-size-slot
2411                           (make-fixnum-descriptor
2412                            (ash (+ code-size (1- (ash 1 sb!vm:word-shift)))
2413                                 (- sb!vm:word-shift))))
2414        (write-wordindexed des sb!vm:code-entry-points-slot *nil-descriptor*)
2415        (write-wordindexed des sb!vm:code-debug-info-slot (pop-stack))
2416        (when (oddp raw-header-n-words)
2417          (write-wordindexed des
2418                             raw-header-n-words
2419                             (make-random-descriptor 0)))
2420        (do ((index (1- raw-header-n-words) (1- index)))
2421            ((< index sb!vm:code-trace-table-offset-slot))
2422          (write-wordindexed des index (pop-stack)))
2423        (let* ((start (+ (descriptor-byte-offset des)
2424                         (ash header-n-words sb!vm:word-shift)))
2425               (end (+ start code-size)))
2426          (read-bigvec-as-sequence-or-die (descriptor-bytes des)
2427                                          *fasl-input-stream*
2428                                          :start start
2429                                          :end end)
2430          #!+sb-show
2431          (when *show-pre-fixup-code-p*
2432            (format *trace-output*
2433                    "~&/raw code from code-fop ~W ~W:~%"
2434                    nconst
2435                    code-size)
2436            (do ((i start (+ i sb!vm:n-word-bytes)))
2437                ((>= i end))
2438              (format *trace-output*
2439                      "/#X~8,'0x: #X~8,'0x~%"
2440                      (+ i (gspace-byte-address (descriptor-gspace des)))
2441                      (bvref-32 (descriptor-bytes des) i)))))
2442        des)))
2443
2444 (define-cold-code-fop fop-code (read-word-arg) (read-word-arg))
2445
2446 (define-cold-code-fop fop-small-code (read-byte-arg) (read-halfword-arg))
2447
2448 (clone-cold-fop (fop-alter-code :pushp nil)
2449                 (fop-byte-alter-code)
2450   (let ((slot (clone-arg))
2451         (value (pop-stack))
2452         (code (pop-stack)))
2453     (write-wordindexed code slot value)))
2454
2455 (define-cold-fop (fop-fun-entry)
2456   (let* ((xrefs (pop-stack))
2457          (type (pop-stack))
2458          (arglist (pop-stack))
2459          (name (pop-stack))
2460          (code-object (pop-stack))
2461          (offset (calc-offset code-object (read-word-arg)))
2462          (fn (descriptor-beyond code-object
2463                                 offset
2464                                 sb!vm:fun-pointer-lowtag))
2465          (next (read-wordindexed code-object sb!vm:code-entry-points-slot)))
2466     (unless (zerop (logand offset sb!vm:lowtag-mask))
2467       (error "unaligned function entry: ~S at #X~X" name offset))
2468     (write-wordindexed code-object sb!vm:code-entry-points-slot fn)
2469     (write-memory fn
2470                   (make-other-immediate-descriptor
2471                    (ash offset (- sb!vm:word-shift))
2472                    sb!vm:simple-fun-header-widetag))
2473     (write-wordindexed fn
2474                        sb!vm:simple-fun-self-slot
2475                        ;; KLUDGE: Wiring decisions like this in at
2476                        ;; this level ("if it's an x86") instead of a
2477                        ;; higher level of abstraction ("if it has such
2478                        ;; and such relocation peculiarities (which
2479                        ;; happen to be confined to the x86)") is bad.
2480                        ;; It would be nice if the code were instead
2481                        ;; conditional on some more descriptive
2482                        ;; feature, :STICKY-CODE or
2483                        ;; :LOAD-GC-INTERACTION or something.
2484                        ;;
2485                        ;; FIXME: The X86 definition of the function
2486                        ;; self slot breaks everything object.tex says
2487                        ;; about it. (As far as I can tell, the X86
2488                        ;; definition makes it a pointer to the actual
2489                        ;; code instead of a pointer back to the object
2490                        ;; itself.) Ask on the mailing list whether
2491                        ;; this is documented somewhere, and if not,
2492                        ;; try to reverse engineer some documentation.
2493                        #!-(or x86 x86-64)
2494                        ;; a pointer back to the function object, as
2495                        ;; described in CMU CL
2496                        ;; src/docs/internals/object.tex
2497                        fn
2498                        #!+(or x86 x86-64)
2499                        ;; KLUDGE: a pointer to the actual code of the
2500                        ;; object, as described nowhere that I can find
2501                        ;; -- WHN 19990907
2502                        (make-random-descriptor
2503                         (+ (descriptor-bits fn)
2504                            (- (ash sb!vm:simple-fun-code-offset
2505                                    sb!vm:word-shift)
2506                               ;; FIXME: We should mask out the type
2507                               ;; bits, not assume we know what they
2508                               ;; are and subtract them out this way.
2509                               sb!vm:fun-pointer-lowtag))))
2510     (write-wordindexed fn sb!vm:simple-fun-next-slot next)
2511     (write-wordindexed fn sb!vm:simple-fun-name-slot name)
2512     (write-wordindexed fn sb!vm:simple-fun-arglist-slot arglist)
2513     (write-wordindexed fn sb!vm:simple-fun-type-slot type)
2514     (write-wordindexed fn sb!vm::simple-fun-xrefs-slot xrefs)
2515     fn))
2516
2517 (define-cold-fop (fop-foreign-fixup)
2518   (let* ((kind (pop-stack))
2519          (code-object (pop-stack))
2520          (len (read-byte-arg))
2521          (sym (make-string len)))
2522     (read-string-as-bytes *fasl-input-stream* sym)
2523     (let ((offset (read-word-arg))
2524           (value (cold-foreign-symbol-address sym)))
2525       (do-cold-fixup code-object offset value kind))
2526    code-object))
2527
2528 #!+linkage-table
2529 (define-cold-fop (fop-foreign-dataref-fixup)
2530   (let* ((kind (pop-stack))
2531          (code-object (pop-stack))
2532          (len (read-byte-arg))
2533          (sym (make-string len)))
2534     (read-string-as-bytes *fasl-input-stream* sym)
2535     (maphash (lambda (k v)
2536                (format *error-output* "~&~S = #X~8X~%" k v))
2537              *cold-foreign-symbol-table*)
2538     (error "shared foreign symbol in cold load: ~S (~S)" sym kind)))
2539
2540 (define-cold-fop (fop-assembler-code)
2541   (let* ((length (read-word-arg))
2542          (header-n-words
2543           ;; Note: we round the number of constants up to ensure that
2544           ;; the code vector will be properly aligned.
2545           (round-up sb!vm:code-constants-offset 2))
2546          (des (allocate-cold-descriptor *read-only*
2547                                         (+ (ash header-n-words
2548                                                 sb!vm:word-shift)
2549                                            length)
2550                                         sb!vm:other-pointer-lowtag)))
2551     (write-memory des
2552                   (make-other-immediate-descriptor
2553                    header-n-words sb!vm:code-header-widetag))
2554     (write-wordindexed des
2555                        sb!vm:code-code-size-slot
2556                        (make-fixnum-descriptor
2557                         (ash (+ length (1- (ash 1 sb!vm:word-shift)))
2558                              (- sb!vm:word-shift))))
2559     (write-wordindexed des sb!vm:code-entry-points-slot *nil-descriptor*)
2560     (write-wordindexed des sb!vm:code-debug-info-slot *nil-descriptor*)
2561
2562     (let* ((start (+ (descriptor-byte-offset des)
2563                      (ash header-n-words sb!vm:word-shift)))
2564            (end (+ start length)))
2565       (read-bigvec-as-sequence-or-die (descriptor-bytes des)
2566                                       *fasl-input-stream*
2567                                       :start start
2568                                       :end end))
2569     des))
2570
2571 (define-cold-fop (fop-assembler-routine)
2572   (let* ((routine (pop-stack))
2573          (des (pop-stack))
2574          (offset (calc-offset des (read-word-arg))))
2575     (record-cold-assembler-routine
2576      routine
2577      (+ (logandc2 (descriptor-bits des) sb!vm:lowtag-mask) offset))
2578     des))
2579
2580 (define-cold-fop (fop-assembler-fixup)
2581   (let* ((routine (pop-stack))
2582          (kind (pop-stack))
2583          (code-object (pop-stack))
2584          (offset (read-word-arg)))
2585     (record-cold-assembler-fixup routine code-object offset kind)
2586     code-object))
2587
2588 (define-cold-fop (fop-code-object-fixup)
2589   (let* ((kind (pop-stack))
2590          (code-object (pop-stack))
2591          (offset (read-word-arg))
2592          (value (descriptor-bits code-object)))
2593     (do-cold-fixup code-object offset value kind)
2594     code-object))
2595 \f
2596 ;;;; emitting C header file
2597
2598 (defun tailwise-equal (string tail)
2599   (and (>= (length string) (length tail))
2600        (string= string tail :start1 (- (length string) (length tail)))))
2601
2602 (defun write-boilerplate ()
2603   (format t "/*~%")
2604   (dolist (line
2605            '("This is a machine-generated file. Please do not edit it by hand."
2606              "(As of sbcl-0.8.14, it came from WRITE-CONFIG-H in genesis.lisp.)"
2607              nil
2608              "This file contains low-level information about the"
2609              "internals of a particular version and configuration"
2610              "of SBCL. It is used by the C compiler to create a runtime"
2611              "support environment, an executable program in the host"
2612              "operating system's native format, which can then be used to"
2613              "load and run 'core' files, which are basically programs"
2614              "in SBCL's own format."))
2615     (format t " *~@[ ~A~]~%" line))
2616   (format t " */~%"))
2617
2618 (defun c-name (string &optional strip)
2619   (delete #\+
2620           (substitute-if #\_ (lambda (c) (member c '(#\- #\/ #\%)))
2621                          (remove-if (lambda (c) (position c strip))
2622                                     string))))
2623
2624 (defun c-symbol-name (symbol &optional strip)
2625   (c-name (symbol-name symbol) strip))
2626
2627 (defun write-makefile-features ()
2628   ;; propagating *SHEBANG-FEATURES* into the Makefiles
2629   (dolist (shebang-feature-name (sort (mapcar #'c-symbol-name
2630                                               sb-cold:*shebang-features*)
2631                                       #'string<))
2632     (format t "LISP_FEATURE_~A=1~%" shebang-feature-name)))
2633
2634 (defun write-config-h ()
2635   ;; propagating *SHEBANG-FEATURES* into C-level #define's
2636   (dolist (shebang-feature-name (sort (mapcar #'c-symbol-name
2637                                               sb-cold:*shebang-features*)
2638                                       #'string<))
2639     (format t "#define LISP_FEATURE_~A~%" shebang-feature-name))
2640   (terpri)
2641   ;; and miscellaneous constants
2642   (format t "#define SBCL_CORE_VERSION_INTEGER ~D~%" sbcl-core-version-integer)
2643   (format t
2644           "#define SBCL_VERSION_STRING ~S~%"
2645           (sb!xc:lisp-implementation-version))
2646   (format t "#define CORE_MAGIC 0x~X~%" core-magic)
2647   (format t "#ifndef LANGUAGE_ASSEMBLY~2%")
2648   (format t "#define LISPOBJ(x) ((lispobj)x)~2%")
2649   (format t "#else /* LANGUAGE_ASSEMBLY */~2%")
2650   (format t "#define LISPOBJ(thing) thing~2%")
2651   (format t "#endif /* LANGUAGE_ASSEMBLY */~2%")
2652   (terpri))
2653
2654 (defun write-constants-h ()
2655   ;; writing entire families of named constants
2656   (let ((constants nil))
2657     (dolist (package-name '( ;; Even in CMU CL, constants from VM
2658                             ;; were automatically propagated
2659                             ;; into the runtime.
2660                             "SB!VM"
2661                             ;; In SBCL, we also propagate various
2662                             ;; magic numbers related to file format,
2663                             ;; which live here instead of SB!VM.
2664                             "SB!FASL"))
2665       (do-external-symbols (symbol (find-package package-name))
2666         (when (constantp symbol)
2667           (let ((name (symbol-name symbol)))
2668             (labels ( ;; shared machinery
2669                      (record (string priority)
2670                        (push (list string
2671                                    priority
2672                                    (symbol-value symbol)
2673                                    (documentation symbol 'variable))
2674                              constants))
2675                      ;; machinery for old-style CMU CL Lisp-to-C
2676                      ;; arbitrary renaming, being phased out in favor of
2677                      ;; the newer systematic RECORD-WITH-TRANSLATED-NAME
2678                      ;; renaming
2679                      (record-with-munged-name (prefix string priority)
2680                        (record (concatenate
2681                                 'simple-string
2682                                 prefix
2683                                 (delete #\- (string-capitalize string)))
2684                                priority))
2685                      (maybe-record-with-munged-name (tail prefix priority)
2686                        (when (tailwise-equal name tail)
2687                          (record-with-munged-name prefix
2688                                                   (subseq name 0
2689                                                           (- (length name)
2690                                                              (length tail)))
2691                                                   priority)))
2692                      ;; machinery for new-style SBCL Lisp-to-C naming
2693                      (record-with-translated-name (priority)
2694                        (record (c-name name) priority))
2695                      (maybe-record-with-translated-name (suffixes priority)
2696                        (when (some (lambda (suffix)
2697                                      (tailwise-equal name suffix))
2698                                    suffixes)
2699                          (record-with-translated-name priority))))
2700
2701               (maybe-record-with-translated-name '("-LOWTAG") 0)
2702               (maybe-record-with-translated-name '("-WIDETAG") 1)
2703               (maybe-record-with-munged-name "-FLAG" "flag_" 2)
2704               (maybe-record-with-munged-name "-TRAP" "trap_" 3)
2705               (maybe-record-with-munged-name "-SUBTYPE" "subtype_" 4)
2706               (maybe-record-with-munged-name "-SC-NUMBER" "sc_" 5)
2707               (maybe-record-with-translated-name '("-START" "-END" "-SIZE") 6)
2708               (maybe-record-with-translated-name '("-CORE-ENTRY-TYPE-CODE") 7)
2709               (maybe-record-with-translated-name '("-CORE-SPACE-ID") 8))))))
2710     ;; KLUDGE: these constants are sort of important, but there's no
2711     ;; pleasing way to inform the code above about them.  So we fake
2712     ;; it for now.  nikodemus on #lisp (2004-08-09) suggested simply
2713     ;; exporting every numeric constant from SB!VM; that would work,
2714     ;; but the C runtime would have to be altered to use Lisp-like names
2715     ;; rather than the munged names currently exported.  --njf, 2004-08-09
2716     (dolist (c '(sb!vm:n-word-bits sb!vm:n-word-bytes
2717                  sb!vm:n-lowtag-bits sb!vm:lowtag-mask
2718                  sb!vm:n-widetag-bits sb!vm:widetag-mask
2719                  sb!vm:n-fixnum-tag-bits sb!vm:fixnum-tag-mask))
2720       (push (list (c-symbol-name c)
2721                   -1                    ; invent a new priority
2722                   (symbol-value c)
2723                   nil)
2724             constants))
2725     ;; One more symbol that doesn't fit into the code above.
2726     (let ((c 'sb!impl::+magic-hash-vector-value+))
2727       (push (list (c-symbol-name c)
2728                   9
2729                   (symbol-value c)
2730                   nil)
2731             constants))
2732     (setf constants
2733           (sort constants
2734                 (lambda (const1 const2)
2735                   (if (= (second const1) (second const2))
2736                       (< (third const1) (third const2))
2737                       (< (second const1) (second const2))))))
2738     (let ((prev-priority (second (car constants))))
2739       (dolist (const constants)
2740         (destructuring-bind (name priority value doc) const
2741           (unless (= prev-priority priority)
2742             (terpri)
2743             (setf prev-priority priority))
2744           (format t "#define ~A " name)
2745           (format t
2746                   ;; KLUDGE: We're dumping two different kinds of
2747                   ;; values here, (1) small codes and (2) machine
2748                   ;; addresses. The small codes can be dumped as bare
2749                   ;; integer values. The large machine addresses might
2750                   ;; cause problems if they're large and represented
2751                   ;; as (signed) C integers, so we want to force them
2752                   ;; to be unsigned by appending an U to the
2753                   ;; literal. We can't dump all the values using the
2754                   ;; literal-U syntax, since the assembler doesn't
2755                   ;; support that syntax and some of the small
2756                   ;; constants can be used in assembler files.
2757                   (let ( ;; cutoff for treatment as a small code
2758                         (cutoff (expt 2 16)))
2759                     (cond ((minusp value)
2760                            (error "stub: negative values unsupported"))
2761                           ((< value cutoff)
2762                            "~D")
2763                           (t
2764                            "~DU")))
2765                   value)
2766           (format t " /* 0x~X */~@[  /* ~A */~]~%" value doc))))
2767     (terpri))
2768
2769   ;; writing information about internal errors
2770   (let ((internal-errors sb!c:*backend-internal-errors*))
2771     (dotimes (i (length internal-errors))
2772       (let ((current-error (aref internal-errors i)))
2773         ;; FIXME: this UNLESS should go away (see also FIXME in
2774         ;; interr.lisp) -- APD, 2002-03-05
2775         (unless (eq nil (car current-error))
2776           (format t "#define ~A ~D~%"
2777                   (c-symbol-name (car current-error))
2778                   i)))))
2779   (terpri)
2780
2781   ;; I'm not really sure why this is in SB!C, since it seems
2782   ;; conceptually like something that belongs to SB!VM. In any case,
2783   ;; it's needed C-side.
2784   (format t "#define BACKEND_PAGE_SIZE ~DU~%" sb!c:*backend-page-size*)
2785
2786   (terpri)
2787
2788   ;; FIXME: The SPARC has a PSEUDO-ATOMIC-TRAP that differs between
2789   ;; platforms. If we export this from the SB!VM package, it gets
2790   ;; written out as #define trap_PseudoAtomic, which is confusing as
2791   ;; the runtime treats trap_ as the prefix for illegal instruction
2792   ;; type things. We therefore don't export it, but instead do
2793   #!+sparc
2794   (when (boundp 'sb!vm::pseudo-atomic-trap)
2795     (format t
2796             "#define PSEUDO_ATOMIC_TRAP ~D /* 0x~:*~X */~%"
2797             sb!vm::pseudo-atomic-trap)
2798     (terpri))
2799   ;; possibly this is another candidate for a rename (to
2800   ;; pseudo-atomic-trap-number or pseudo-atomic-magic-constant
2801   ;; [possibly applicable to other platforms])
2802
2803   (dolist (symbol '(sb!vm::float-traps-byte
2804                     sb!vm::float-exceptions-byte
2805                     sb!vm::float-sticky-bits
2806                     sb!vm::float-rounding-mode))
2807     (format t "#define ~A_POSITION ~A /* ~:*0x~X */~%"
2808             (c-symbol-name symbol)
2809             (sb!xc:byte-position (symbol-value symbol)))
2810     (format t "#define ~A_MASK 0x~X /* ~:*~A */~%"
2811             (c-symbol-name symbol)
2812             (sb!xc:mask-field (symbol-value symbol) -1))))
2813
2814
2815
2816 (defun write-primitive-object (obj)
2817   ;; writing primitive object layouts
2818   (format t "#ifndef LANGUAGE_ASSEMBLY~2%")
2819   (format t
2820           "struct ~A {~%"
2821           (c-name (string-downcase (string (sb!vm:primitive-object-name obj)))))
2822   (when (sb!vm:primitive-object-widetag obj)
2823     (format t "    lispobj header;~%"))
2824   (dolist (slot (sb!vm:primitive-object-slots obj))
2825     (format t "    ~A ~A~@[[1]~];~%"
2826             (getf (sb!vm:slot-options slot) :c-type "lispobj")
2827             (c-name (string-downcase (string (sb!vm:slot-name slot))))
2828             (sb!vm:slot-rest-p slot)))
2829   (format t "};~2%")
2830   (format t "#else /* LANGUAGE_ASSEMBLY */~2%")
2831   (format t "/* These offsets are SLOT-OFFSET * N-WORD-BYTES - LOWTAG~%")
2832   (format t " * so they work directly on tagged addresses. */~2%")
2833   (let ((name (sb!vm:primitive-object-name obj))
2834         (lowtag (eval (sb!vm:primitive-object-lowtag obj))))
2835     (when lowtag
2836       (dolist (slot (sb!vm:primitive-object-slots obj))
2837         (format t "#define ~A_~A_OFFSET ~D~%"
2838                 (c-symbol-name name)
2839                 (c-symbol-name (sb!vm:slot-name slot))
2840                 (- (* (sb!vm:slot-offset slot) sb!vm:n-word-bytes) lowtag)))
2841       (terpri)))
2842   (format t "#endif /* LANGUAGE_ASSEMBLY */~2%"))
2843
2844 (defun write-structure-object (dd)
2845   (flet ((cstring (designator)
2846            (c-name (string-downcase (string designator)))))
2847     (format t "#ifndef LANGUAGE_ASSEMBLY~2%")
2848     (format t "struct ~A {~%" (cstring (dd-name dd)))
2849     (format t "    lispobj header;~%")
2850     (format t "    lispobj layout;~%")
2851     (dolist (slot (dd-slots dd))
2852       (when (eq t (dsd-raw-type slot))
2853         (format t "    lispobj ~A;~%" (cstring (dsd-name slot)))))
2854     (unless (oddp (+ (dd-length dd) (dd-raw-length dd)))
2855       (format t "    lispobj raw_slot_padding;~%"))
2856     (dotimes (n (dd-raw-length dd))
2857       (format t "    lispobj raw~D;~%" (- (dd-raw-length dd) n 1)))
2858     (format t "};~2%")
2859     (format t "#endif /* LANGUAGE_ASSEMBLY */~2%")))
2860
2861 (defun write-static-symbols ()
2862   (dolist (symbol (cons nil sb!vm:*static-symbols*))
2863     ;; FIXME: It would be nice to use longer names than NIL and
2864     ;; (particularly) T in #define statements.
2865     (format t "#define ~A LISPOBJ(0x~X)~%"
2866             ;; FIXME: It would be nice not to need to strip anything
2867             ;; that doesn't get stripped always by C-SYMBOL-NAME.
2868             (c-symbol-name symbol "%*.!")
2869             (if *static*                ; if we ran GENESIS
2870               ;; We actually ran GENESIS, use the real value.
2871               (descriptor-bits (cold-intern symbol))
2872               ;; We didn't run GENESIS, so guess at the address.
2873               (+ sb!vm:static-space-start
2874                  sb!vm:n-word-bytes
2875                  sb!vm:other-pointer-lowtag
2876                    (if symbol (sb!vm:static-symbol-offset symbol) 0))))))
2877
2878 \f
2879 ;;;; writing map file
2880
2881 ;;; Write a map file describing the cold load. Some of this
2882 ;;; information is subject to change due to relocating GC, but even so
2883 ;;; it can be very handy when attempting to troubleshoot the early
2884 ;;; stages of cold load.
2885 (defun write-map ()
2886   (let ((*print-pretty* nil)
2887         (*print-case* :upcase))
2888     (format t "assembler routines defined in core image:~2%")
2889     (dolist (routine (sort (copy-list *cold-assembler-routines*) #'<
2890                            :key #'cdr))
2891       (format t "#X~8,'0X: ~S~%" (cdr routine) (car routine)))
2892     (let ((funs nil)
2893           (undefs nil))
2894       (maphash (lambda (name fdefn)
2895                  (let ((fun (read-wordindexed fdefn
2896                                               sb!vm:fdefn-fun-slot)))
2897                    (if (= (descriptor-bits fun)
2898                           (descriptor-bits *nil-descriptor*))
2899                        (push name undefs)
2900                        (let ((addr (read-wordindexed
2901                                     fdefn sb!vm:fdefn-raw-addr-slot)))
2902                          (push (cons name (descriptor-bits addr))
2903                                funs)))))
2904                *cold-fdefn-objects*)
2905       (format t "~%~|~%initially defined functions:~2%")
2906       (setf funs (sort funs #'< :key #'cdr))
2907       (dolist (info funs)
2908         (format t "0x~8,'0X: ~S   #X~8,'0X~%" (cdr info) (car info)
2909                 (- (cdr info) #x17)))
2910       (format t
2911 "~%~|
2912 (a note about initially undefined function references: These functions
2913 are referred to by code which is installed by GENESIS, but they are not
2914 installed by GENESIS. This is not necessarily a problem; functions can
2915 be defined later, by cold init toplevel forms, or in files compiled and
2916 loaded at warm init, or elsewhere. As long as they are defined before
2917 they are called, everything should be OK. Things are also OK if the
2918 cross-compiler knew their inline definition and used that everywhere
2919 that they were called before the out-of-line definition is installed,
2920 as is fairly common for structure accessors.)
2921 initially undefined function references:~2%")
2922
2923       (setf undefs (sort undefs #'string< :key #'fun-name-block-name))
2924       (dolist (name undefs)
2925         (format t "~S~%" name)))
2926
2927     (format t "~%~|~%layout names:~2%")
2928     (collect ((stuff))
2929       (maphash (lambda (name gorp)
2930                  (declare (ignore name))
2931                  (stuff (cons (descriptor-bits (car gorp))
2932                               (cdr gorp))))
2933                *cold-layouts*)
2934       (dolist (x (sort (stuff) #'< :key #'car))
2935         (apply #'format t "~8,'0X: ~S[~D]~%~10T~S~%" x))))
2936
2937   (values))
2938 \f
2939 ;;;; writing core file
2940
2941 (defvar *core-file*)
2942 (defvar *data-page*)
2943
2944 ;;; magic numbers to identify entries in a core file
2945 ;;;
2946 ;;; (In case you were wondering: No, AFAIK there's no special magic about
2947 ;;; these which requires them to be in the 38xx range. They're just
2948 ;;; arbitrary words, tested not for being in a particular range but just
2949 ;;; for equality. However, if you ever need to look at a .core file and
2950 ;;; figure out what's going on, it's slightly convenient that they're
2951 ;;; all in an easily recognizable range, and displacing the range away from
2952 ;;; zero seems likely to reduce the chance that random garbage will be
2953 ;;; misinterpreted as a .core file.)
2954 (defconstant version-core-entry-type-code 3860)
2955 (defconstant build-id-core-entry-type-code 3899)
2956 (defconstant new-directory-core-entry-type-code 3861)
2957 (defconstant initial-fun-core-entry-type-code 3863)
2958 (defconstant page-table-core-entry-type-code 3880)
2959 #!+(and sb-lutex sb-thread)
2960 (defconstant lutex-table-core-entry-type-code 3887)
2961 (defconstant end-core-entry-type-code 3840)
2962
2963 (declaim (ftype (function (sb!vm:word) sb!vm:word) write-word))
2964 (defun write-word (num)
2965   (ecase sb!c:*backend-byte-order*
2966     (:little-endian
2967      (dotimes (i sb!vm:n-word-bytes)
2968        (write-byte (ldb (byte 8 (* i 8)) num) *core-file*)))
2969     (:big-endian
2970      (dotimes (i sb!vm:n-word-bytes)
2971        (write-byte (ldb (byte 8 (* (- (1- sb!vm:n-word-bytes) i) 8)) num)
2972                    *core-file*))))
2973   num)
2974
2975 (defun advance-to-page ()
2976   (force-output *core-file*)
2977   (file-position *core-file*
2978                  (round-up (file-position *core-file*)
2979                            sb!c:*backend-page-size*)))
2980
2981 (defun output-gspace (gspace)
2982   (force-output *core-file*)
2983   (let* ((posn (file-position *core-file*))
2984          (bytes (* (gspace-free-word-index gspace) sb!vm:n-word-bytes))
2985          (pages (ceiling bytes sb!c:*backend-page-size*))
2986          (total-bytes (* pages sb!c:*backend-page-size*)))
2987
2988     (file-position *core-file*
2989                    (* sb!c:*backend-page-size* (1+ *data-page*)))
2990     (format t
2991             "writing ~S byte~:P [~S page~:P] from ~S~%"
2992             total-bytes
2993             pages
2994             gspace)
2995     (force-output)
2996
2997     ;; Note: It is assumed that the GSPACE allocation routines always
2998     ;; allocate whole pages (of size *target-page-size*) and that any
2999     ;; empty gspace between the free pointer and the end of page will
3000     ;; be zero-filled. This will always be true under Mach on machines
3001     ;; where the page size is equal. (RT is 4K, PMAX is 4K, Sun 3 is
3002     ;; 8K).
3003     (write-bigvec-as-sequence (gspace-bytes gspace)
3004                               *core-file*
3005                               :end total-bytes)
3006     (force-output *core-file*)
3007     (file-position *core-file* posn)
3008
3009     ;; Write part of a (new) directory entry which looks like this:
3010     ;;   GSPACE IDENTIFIER
3011     ;;   WORD COUNT
3012     ;;   DATA PAGE
3013     ;;   ADDRESS
3014     ;;   PAGE COUNT
3015     (write-word (gspace-identifier gspace))
3016     (write-word (gspace-free-word-index gspace))
3017     (write-word *data-page*)
3018     (multiple-value-bind (floor rem)
3019         (floor (gspace-byte-address gspace) sb!c:*backend-page-size*)
3020       (aver (zerop rem))
3021       (write-word floor))
3022     (write-word pages)
3023
3024     (incf *data-page* pages)))
3025
3026 ;;; Create a core file created from the cold loaded image. (This is
3027 ;;; the "initial core file" because core files could be created later
3028 ;;; by executing SAVE-LISP in a running system, perhaps after we've
3029 ;;; added some functionality to the system.)
3030 (declaim (ftype (function (string)) write-initial-core-file))
3031 (defun write-initial-core-file (filename)
3032
3033   (let ((filenamestring (namestring filename))
3034         (*data-page* 0))
3035
3036     (format t
3037             "[building initial core file in ~S: ~%"
3038             filenamestring)
3039     (force-output)
3040
3041     (with-open-file (*core-file* filenamestring
3042                                  :direction :output
3043                                  :element-type '(unsigned-byte 8)
3044                                  :if-exists :rename-and-delete)
3045
3046       ;; Write the magic number.
3047       (write-word core-magic)
3048
3049       ;; Write the Version entry.
3050       (write-word version-core-entry-type-code)
3051       (write-word 3)
3052       (write-word sbcl-core-version-integer)
3053
3054       ;; Write the build ID.
3055       (write-word build-id-core-entry-type-code)
3056       (let ((build-id (with-open-file (s "output/build-id.tmp"
3057                                          :direction :input)
3058                         (read s))))
3059         (declare (type simple-string build-id))
3060         (/show build-id (length build-id))
3061         ;; Write length of build ID record: BUILD-ID-CORE-ENTRY-TYPE-CODE
3062         ;; word, this length word, and one word for each char of BUILD-ID.
3063         (write-word (+ 2 (length build-id)))
3064         (dovector (char build-id)
3065           ;; (We write each character as a word in order to avoid
3066           ;; having to think about word alignment issues in the
3067           ;; sbcl-0.7.8 version of coreparse.c.)
3068           (write-word (sb!xc:char-code char))))
3069
3070       ;; Write the New Directory entry header.
3071       (write-word new-directory-core-entry-type-code)
3072       (write-word 17) ; length = (5 words/space) * 3 spaces + 2 for header.
3073
3074       (output-gspace *read-only*)
3075       (output-gspace *static*)
3076       (output-gspace *dynamic*)
3077
3078       ;; Write the initial function.
3079       (write-word initial-fun-core-entry-type-code)
3080       (write-word 3)
3081       (let* ((cold-name (cold-intern '!cold-init))
3082              (cold-fdefn (cold-fdefinition-object cold-name))
3083              (initial-fun (read-wordindexed cold-fdefn
3084                                             sb!vm:fdefn-fun-slot)))
3085         (format t
3086                 "~&/(DESCRIPTOR-BITS INITIAL-FUN)=#X~X~%"
3087                 (descriptor-bits initial-fun))
3088         (write-word (descriptor-bits initial-fun)))
3089
3090       ;; Write the End entry.
3091       (write-word end-core-entry-type-code)
3092       (write-word 2)))
3093
3094   (format t "done]~%")
3095   (force-output)
3096   (/show "leaving WRITE-INITIAL-CORE-FILE")
3097   (values))
3098 \f
3099 ;;;; the actual GENESIS function
3100
3101 ;;; Read the FASL files in OBJECT-FILE-NAMES and produce a Lisp core,
3102 ;;; and/or information about a Lisp core, therefrom.
3103 ;;;
3104 ;;; input file arguments:
3105 ;;;   SYMBOL-TABLE-FILE-NAME names a UNIX-style .nm file *with* *any*
3106 ;;;     *tab* *characters* *converted* *to* *spaces*. (We push
3107 ;;;     responsibility for removing tabs out to the caller it's
3108 ;;;     trivial to remove them using UNIX command line tools like
3109 ;;;     sed, whereas it's a headache to do it portably in Lisp because
3110 ;;;     #\TAB is not a STANDARD-CHAR.) If this file is not supplied,
3111 ;;;     a core file cannot be built (but a C header file can be).
3112 ;;;
3113 ;;; output files arguments (any of which may be NIL to suppress output):
3114 ;;;   CORE-FILE-NAME gets a Lisp core.
3115 ;;;   C-HEADER-FILE-NAME gets a C header file, traditionally called
3116 ;;;     internals.h, which is used by the C compiler when constructing
3117 ;;;     the executable which will load the core.
3118 ;;;   MAP-FILE-NAME gets (?) a map file. (dunno about this -- WHN 19990815)
3119 ;;;
3120 ;;; FIXME: GENESIS doesn't belong in SB!VM. Perhaps in %KERNEL for now,
3121 ;;; perhaps eventually in SB-LD or SB-BOOT.
3122 (defun sb!vm:genesis (&key
3123                       object-file-names
3124                       symbol-table-file-name
3125                       core-file-name
3126                       map-file-name
3127                       c-header-dir-name)
3128
3129   (format t
3130           "~&beginning GENESIS, ~A~%"
3131           (if core-file-name
3132             ;; Note: This output summarizing what we're doing is
3133             ;; somewhat telegraphic in style, not meant to imply that
3134             ;; we're not e.g. also creating a header file when we
3135             ;; create a core.
3136             (format nil "creating core ~S" core-file-name)
3137             (format nil "creating headers in ~S" c-header-dir-name)))
3138
3139   (let ((*cold-foreign-symbol-table* (make-hash-table :test 'equal)))
3140
3141     (when core-file-name
3142       (if symbol-table-file-name
3143           (load-cold-foreign-symbol-table symbol-table-file-name)
3144           (error "can't output a core file without symbol table file input")))
3145
3146     ;; Now that we've successfully read our only input file (by
3147     ;; loading the symbol table, if any), it's a good time to ensure
3148     ;; that there'll be someplace for our output files to go when
3149     ;; we're done.
3150     (flet ((frob (filename)
3151              (when filename
3152                (ensure-directories-exist filename :verbose t))))
3153       (frob core-file-name)
3154       (frob map-file-name))
3155
3156     ;; (This shouldn't matter in normal use, since GENESIS normally
3157     ;; only runs once in any given Lisp image, but it could reduce
3158     ;; confusion if we ever experiment with running, tweaking, and
3159     ;; rerunning genesis interactively.)
3160     (do-all-symbols (sym)
3161       (remprop sym 'cold-intern-info))
3162
3163     (let* ((*foreign-symbol-placeholder-value* (if core-file-name nil 0))
3164            (*load-time-value-counter* 0)
3165            (*cold-fdefn-objects* (make-hash-table :test 'equal))
3166            (*cold-symbols* (make-hash-table :test 'equal))
3167            (*cold-package-symbols* nil)
3168            (*read-only* (make-gspace :read-only
3169                                      read-only-core-space-id
3170                                      sb!vm:read-only-space-start))
3171            (*static*    (make-gspace :static
3172                                      static-core-space-id
3173                                      sb!vm:static-space-start))
3174            (*dynamic*   (make-gspace :dynamic
3175                                      dynamic-core-space-id
3176                                      #!+gencgc sb!vm:dynamic-space-start
3177                                      #!-gencgc sb!vm:dynamic-0-space-start))
3178            (*nil-descriptor* (make-nil-descriptor))
3179            (*current-reversed-cold-toplevels* *nil-descriptor*)
3180            (*unbound-marker* (make-other-immediate-descriptor
3181                               0
3182                               sb!vm:unbound-marker-widetag))
3183            *cold-assembler-fixups*
3184            *cold-assembler-routines*
3185            #!+(or x86 x86-64) *load-time-code-fixups*)
3186
3187       ;; Prepare for cold load.
3188       (initialize-non-nil-symbols)
3189       (initialize-layouts)
3190       (initialize-static-fns)
3191
3192       ;; Initialize the *COLD-SYMBOLS* system with the information
3193       ;; from package-data-list.lisp-expr and
3194       ;; common-lisp-exports.lisp-expr.
3195       ;;
3196       ;; Why do things this way? Historically, the *COLD-SYMBOLS*
3197       ;; machinery was designed and implemented in CMU CL long before
3198       ;; I (WHN) ever heard of CMU CL. It dumped symbols and packages
3199       ;; iff they were used in the cold image. When I added the
3200       ;; package-data-list.lisp-expr mechanism, the idea was to
3201       ;; centralize all information about packages and exports. Thus,
3202       ;; it was the natural place for information even about packages
3203       ;; (such as SB!PCL and SB!WALKER) which aren't used much until
3204       ;; after cold load. This didn't quite match the CMU CL approach
3205       ;; of filling *COLD-SYMBOLS* with symbols which appear in the
3206       ;; cold image and then dumping only those symbols. By explicitly
3207       ;; putting all the symbols from package-data-list.lisp-expr and
3208       ;; from common-lisp-exports.lisp-expr into *COLD-SYMBOLS* here,
3209       ;; we feed our centralized symbol information into the old CMU
3210       ;; CL code without having to change the old CMU CL code too
3211       ;; much. (And the old CMU CL code is still useful for making
3212       ;; sure that the appropriate keywords and internal symbols end
3213       ;; up interned in the target Lisp, which is good, e.g. in order
3214       ;; to make &KEY arguments work right and in order to make
3215       ;; BACKTRACEs into target Lisp system code be legible.)
3216       (dolist (exported-name
3217                (sb-cold:read-from-file "common-lisp-exports.lisp-expr"))
3218         (cold-intern (intern exported-name *cl-package*)))
3219       (dolist (pd (sb-cold:read-from-file "package-data-list.lisp-expr"))
3220         (declare (type sb-cold:package-data pd))
3221         (let ((package (find-package (sb-cold:package-data-name pd))))
3222           (labels (;; Call FN on every node of the TREE.
3223                    (mapc-on-tree (fn tree)
3224                                  (declare (type function fn))
3225                                  (typecase tree
3226                                    (cons (mapc-on-tree fn (car tree))
3227                                          (mapc-on-tree fn (cdr tree)))
3228                                    (t (funcall fn tree)
3229                                       (values))))
3230                    ;; Make sure that information about the association
3231                    ;; between PACKAGE and the symbol named NAME gets
3232                    ;; recorded in the cold-intern system or (as a
3233                    ;; convenience when dealing with the tree structure
3234                    ;; allowed in the PACKAGE-DATA-EXPORTS slot) do
3235                    ;; nothing if NAME is NIL.
3236                    (chill (name)
3237                      (when name
3238                        (cold-intern (intern name package) package))))
3239             (mapc-on-tree #'chill (sb-cold:package-data-export pd))
3240             (mapc #'chill (sb-cold:package-data-reexport pd))
3241             (dolist (sublist (sb-cold:package-data-import-from pd))
3242               (destructuring-bind (package-name &rest symbol-names) sublist
3243                 (declare (ignore package-name))
3244                 (mapc #'chill symbol-names))))))
3245
3246       ;; Cold load.
3247       (dolist (file-name object-file-names)
3248         (write-line (namestring file-name))
3249         (cold-load file-name))
3250
3251       ;; Tidy up loose ends left by cold loading. ("Postpare from cold load?")
3252       (resolve-assembler-fixups)
3253       #!+(or x86 x86-64) (output-load-time-code-fixups)
3254       (foreign-symbols-to-core)
3255       (finish-symbols)
3256       (/show "back from FINISH-SYMBOLS")
3257       (finalize-load-time-value-noise)
3258
3259       ;; Tell the target Lisp how much stuff we've allocated.
3260       (cold-set 'sb!vm:*read-only-space-free-pointer*
3261                 (allocate-cold-descriptor *read-only*
3262                                           0
3263                                           sb!vm:even-fixnum-lowtag))
3264       (cold-set 'sb!vm:*static-space-free-pointer*
3265                 (allocate-cold-descriptor *static*
3266                                           0
3267                                           sb!vm:even-fixnum-lowtag))
3268       (/show "done setting free pointers")
3269
3270       ;; Write results to files.
3271       ;;
3272       ;; FIXME: I dislike this approach of redefining
3273       ;; *STANDARD-OUTPUT* instead of putting the new stream in a
3274       ;; lexical variable, and it's annoying to have WRITE-MAP (to
3275       ;; *STANDARD-OUTPUT*) not be parallel to WRITE-INITIAL-CORE-FILE
3276       ;; (to a stream explicitly passed as an argument).
3277       (macrolet ((out-to (name &body body)
3278                    `(let ((fn (format nil "~A/~A.h" c-header-dir-name ,name)))
3279                      (ensure-directories-exist fn)
3280                      (with-open-file (*standard-output* fn
3281                                       :if-exists :supersede :direction :output)
3282                        (write-boilerplate)
3283                        (let ((n (c-name (string-upcase ,name))))
3284                          (format
3285                           t
3286                           "#ifndef SBCL_GENESIS_~A~%#define SBCL_GENESIS_~A 1~%"
3287                           n n))
3288                        ,@body
3289                        (format t
3290                         "#endif /* SBCL_GENESIS_~A */~%"
3291                         (string-upcase ,name))))))
3292         (when map-file-name
3293           (with-open-file (*standard-output* map-file-name
3294                                              :direction :output
3295                                              :if-exists :supersede)
3296             (write-map)))
3297         (out-to "config" (write-config-h))
3298         (out-to "constants" (write-constants-h))
3299         (let ((structs (sort (copy-list sb!vm:*primitive-objects*) #'string<
3300                              :key (lambda (obj)
3301                                     (symbol-name
3302                                      (sb!vm:primitive-object-name obj))))))
3303           (dolist (obj structs)
3304             (out-to
3305              (string-downcase (string (sb!vm:primitive-object-name obj)))
3306              (write-primitive-object obj)))
3307           (out-to "primitive-objects"
3308                   (dolist (obj structs)
3309                     (format t "~&#include \"~A.h\"~%"
3310                             (string-downcase
3311                              (string (sb!vm:primitive-object-name obj)))))))
3312         (dolist (class '(hash-table
3313                          layout
3314                          sb!c::compiled-debug-info
3315                          sb!c::compiled-debug-fun
3316                          sb!xc:package))
3317           (out-to
3318            (string-downcase (string class))
3319            (write-structure-object
3320             (sb!kernel:layout-info (sb!kernel:find-layout class)))))
3321         (out-to "static-symbols" (write-static-symbols))
3322
3323         (let ((fn (format nil "~A/Makefile.features" c-header-dir-name)))
3324           (ensure-directories-exist fn)
3325           (with-open-file (*standard-output* fn :if-exists :supersede
3326                                              :direction :output)
3327             (write-makefile-features)))
3328
3329         (when core-file-name
3330           (write-initial-core-file core-file-name))))))
3331
3332