src/compiler/dump.lisp

   1 ;;;; stuff that knows about dumping FASL files
   2
   3 ;;;; This software is part of the SBCL system. See the README file for
   4 ;;;; more information.
   5 ;;;;
   6 ;;;; This software is derived from the CMU CL system, which was
   7 ;;;; written at Carnegie Mellon University and released into the
   8 ;;;; public domain. The software is in the public domain and is
   9 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
  10 ;;;; files for more information.
  11
  12 (in-package "SB!FASL")
  13 ;;; KLUDGE: Even though we're IN-PACKAGE SB!FASL, some of the code in
  14 ;;; here is awfully chummy with the SB!C package. CMU CL didn't have
  15 ;;; any separation between the two packages, and a lot of tight
  16 ;;; coupling remains. -- WHN 2001-06-04
  17 \f
  18 ;;;; fasl dumper state
  19
  20 ;;; The FASL-OUTPUT structure represents everything we need to
  21 ;;; know about dumping to a fasl file. (We need to objectify the
  22 ;;; state because the fasdumper must be reentrant.)
  23 (defstruct (fasl-output
  24             #-no-ansi-print-object
  25             (:print-object (lambda (x s)
  26                              (print-unreadable-object (x s :type t)
  27                                (prin1 (namestring (fasl-output-stream x))
  28                                       s))))
  29             (:copier nil))
  30   ;; the stream we dump to
  31   (stream (missing-arg) :type stream)
  32   ;; hashtables we use to keep track of dumped constants so that we
  33   ;; can get them from the table rather than dumping them again. The
  34   ;; EQUAL-TABLE is used for lists and strings, and the EQ-TABLE is
  35   ;; used for everything else. We use a separate EQ table to avoid
  36   ;; performance pathologies with objects for which EQUAL degenerates
  37   ;; to EQL. Everything entered in the EQUAL table is also entered in
  38   ;; the EQ table.
  39   (equal-table (make-hash-table :test 'equal) :type hash-table)
  40   (eq-table (make-hash-table :test 'eq) :type hash-table)
  41   ;; the table's current free pointer: the next offset to be used
  42   (table-free 0 :type index)
  43   ;; an alist (PACKAGE . OFFSET) of the table offsets for each package
  44   ;; we have currently located.
  45   (packages () :type list)
  46   ;; a table mapping from the ENTRY-INFO structures for dumped XEPs to
  47   ;; the table offsets of the corresponding code pointers
  48   (entry-table (make-hash-table :test 'eq) :type hash-table)
  49   ;; a table holding back-patching info for forward references to XEPs.
  50   ;; The key is the ENTRY-INFO structure for the XEP, and the value is
  51   ;; a list of conses (<code-handle> . <offset>), where <code-handle>
  52   ;; is the offset in the table of the code object needing to be
  53   ;; patched, and <offset> is the offset that must be patched.
  54   (patch-table (make-hash-table :test 'eq) :type hash-table)
  55   ;; a list of the table handles for all of the DEBUG-INFO structures
  56   ;; dumped in this file. These structures must be back-patched with
  57   ;; source location information when the compilation is complete.
  58   (debug-info () :type list)
  59   ;; This is used to keep track of objects that we are in the process
  60   ;; of dumping so that circularities can be preserved. The key is the
  61   ;; object that we have previously seen, and the value is the object
  62   ;; that we reference in the table to find this previously seen
  63   ;; object. (The value is never NIL.)
  64   ;;
  65   ;; Except with list objects, the key and the value are always the
  66   ;; same. In a list, the key will be some tail of the value.
  67   (circularity-table (make-hash-table :test 'eq) :type hash-table)
  68   ;; a hash table of structures that are allowed to be dumped. If we
  69   ;; try to dump a structure that isn't in this hash table, we lose.
  70   (valid-structures (make-hash-table :test 'eq) :type hash-table))
  71
  72 ;;; This structure holds information about a circularity.
  73 (defstruct (circularity (:copier nil))
  74   ;; the kind of modification to make to create circularity
  75   (type (missing-arg) :type (member :rplaca :rplacd :svset :struct-set))
  76   ;; the object containing circularity
  77   object
  78   ;; index in object for circularity
  79   (index (missing-arg) :type index)
  80   ;; the object to be stored at INDEX in OBJECT. This is that the key
  81   ;; that we were using when we discovered the circularity.
  82   value
  83   ;; the value that was associated with VALUE in the
  84   ;; CIRCULARITY-TABLE. This is the object that we look up in the
  85   ;; EQ-TABLE to locate VALUE.
  86   enclosing-object)
  87
  88 ;;; a list of the CIRCULARITY structures for all of the circularities
  89 ;;; detected in the current top level call to DUMP-OBJECT. Setting
  90 ;;; this lobotomizes circularity detection as well, since circular
  91 ;;; dumping uses the table.
  92 (defvar *circularities-detected*)
  93
  94 ;;; used to inhibit table access when dumping forms to be read by the
  95 ;;; cold loader
  96 (defvar *cold-load-dump* nil)
  97
  98 ;;; used to turn off the structure validation during dumping of source
  99 ;;; info
 100 (defvar *dump-only-valid-structures* t)
 101 ;;;; utilities
 102
 103 ;;; Write the byte B to the specified FASL-OUTPUT stream.
 104 (defun dump-byte (b fasl-output)
 105   (declare (type (unsigned-byte 8) b) (type fasl-output fasl-output))
 106   (write-byte b (fasl-output-stream fasl-output)))
 107
 108 ;; Dump a word-sized integer.
 109 (defun dump-word (num fasl-output)
 110   (declare (type sb!vm:word num))
 111   (declare (type fasl-output fasl-output))
 112   (let ((stream (fasl-output-stream fasl-output)))
 113     (dotimes (i sb!vm:n-word-bytes)
 114       (write-byte (ldb (byte 8 (* 8 i)) num) stream))))
 115
 116 ;; Dump a 32-bit integer.
 117 (defun dump-unsigned-byte-32 (num fasl-output)
 118   (declare (type sb!vm:word num))
 119   (declare (type fasl-output fasl-output))
 120   (let ((stream (fasl-output-stream fasl-output)))
 121     (dotimes (i 4)
 122       (write-byte (ldb (byte 8 (* 8 i)) num) stream))))
 123
 124 ;;; Dump NUM to the fasl stream, represented by N bytes. This works
 125 ;;; for either signed or unsigned integers. There's no range checking
 126 ;;; -- if you don't specify enough bytes for the number to fit, this
 127 ;;; function cheerfully outputs the low bytes.
 128 (defun dump-integer-as-n-bytes  (num bytes fasl-output)
 129   (declare (integer num) (type index bytes))
 130   (declare (type fasl-output fasl-output))
 131   (do ((n num (ash n -8))
 132        (i bytes (1- i)))
 133       ((= i 0))
 134     (declare (type index i))
 135     (dump-byte (logand n #xff) fasl-output))
 136   (values))
 137
 138 ;;; Setting this variable to an (UNSIGNED-BYTE 32) value causes
 139 ;;; DUMP-FOP to use it as a counter and emit a FOP-NOP4 with the
 140 ;;; counter value before every ordinary fop. This can make it easier
 141 ;;; to follow the progress of LOAD-AS-FASL when
 142 ;;; debugging/testing/experimenting.
 143 #!+sb-show (defvar *fop-nop4-count* nil)
 144 #!+sb-show (declaim (type (or (unsigned-byte 32) null) *fop-nop4-count*))
 145
 146 ;;; Dump the FOP code for the named FOP to the specified FASL-OUTPUT.
 147 ;;;
 148 ;;; FIXME: This should be a function, with a compiler macro expansion
 149 ;;; for the common constant-FS case. (Among other things, that'll stop
 150 ;;; it from EVALing ,FILE multiple times.)
 151 ;;;
 152 ;;; FIXME: Compiler macros, frozen classes, inlining, and similar
 153 ;;; optimizations should be conditional on #!+SB-FROZEN.
 154 (defmacro dump-fop (fs file)
 155   (let* ((fs (eval fs))
 156          (val (get fs 'fop-code)))
 157     (if val
 158       `(progn
 159          #!+sb-show
 160          (when *fop-nop4-count*
 161            (dump-byte ,(get 'fop-nop4 'fop-code) ,file)
 162            (dump-integer-as-n-bytes (mod (incf *fop-nop4-count*) (expt 2 32))
 163                                     4 ,file))
 164          (dump-byte ',val ,file))
 165       (error "compiler bug: ~S is not a legal fasload operator." fs))))
 166
 167 ;;; Dump a FOP-CODE along with an integer argument, choosing the FOP
 168 ;;; based on whether the argument will fit in a single byte.
 169 ;;;
 170 ;;; FIXME: This, like DUMP-FOP, should be a function with a
 171 ;;; compiler-macro expansion.
 172 (defmacro dump-fop* (n byte-fop word-fop file)
 173   (once-only ((n-n n)
 174               (n-file file))
 175     `(cond ((< ,n-n 256)
 176             (dump-fop ',byte-fop ,n-file)
 177             (dump-byte ,n-n ,n-file))
 178            (t
 179             (dump-fop ',word-fop ,n-file)
 180             (dump-word ,n-n ,n-file)))))
 181
 182 ;;; Push the object at table offset Handle on the fasl stack.
 183 (defun dump-push (handle fasl-output)
 184   (declare (type index handle) (type fasl-output fasl-output))
 185   (dump-fop* handle fop-byte-push fop-push fasl-output)
 186   (values))
 187
 188 ;;; Pop the object currently on the fasl stack top into the table, and
 189 ;;; return the table index, incrementing the free pointer.
 190 (defun dump-pop (fasl-output)
 191   (prog1
 192       (fasl-output-table-free fasl-output)
 193     (dump-fop 'fop-pop fasl-output)
 194     (incf (fasl-output-table-free fasl-output))))
 195
 196 ;;; If X is in File's EQUAL-TABLE, then push the object and return T,
 197 ;;; otherwise NIL. If *COLD-LOAD-DUMP* is true, then do nothing and
 198 ;;; return NIL.
 199 (defun equal-check-table (x fasl-output)
 200   (declare (type fasl-output fasl-output))
 201   (unless *cold-load-dump*
 202     (let ((handle (gethash x (fasl-output-equal-table fasl-output))))
 203       (cond
 204         (handle (dump-push handle fasl-output) t)
 205         (t nil)))))
 206 (defun string-check-table (x fasl-output)
 207   (declare (type fasl-output fasl-output)
 208            (type string x))
 209   (unless *cold-load-dump*
 210     (let ((handle (cdr (assoc
 211                         (array-element-type x)
 212                         (gethash x (fasl-output-equal-table fasl-output))))))
 213       (cond
 214         (handle (dump-push handle fasl-output) t)
 215         (t nil)))))
 216
 217 ;;; These functions are called after dumping an object to save the
 218 ;;; object in the table. The object (also passed in as X) must already
 219 ;;; be on the top of the FOP stack. If *COLD-LOAD-DUMP* is true, then
 220 ;;; we don't do anything.
 221 (defun eq-save-object (x fasl-output)
 222   (declare (type fasl-output fasl-output))
 223   (unless *cold-load-dump*
 224     (let ((handle (dump-pop fasl-output)))
 225       (setf (gethash x (fasl-output-eq-table fasl-output)) handle)
 226       (dump-push handle fasl-output)))
 227   (values))
 228 (defun equal-save-object (x fasl-output)
 229   (declare (type fasl-output fasl-output))
 230   (unless *cold-load-dump*
 231     (let ((handle (dump-pop fasl-output)))
 232       (setf (gethash x (fasl-output-equal-table fasl-output)) handle)
 233       (setf (gethash x (fasl-output-eq-table fasl-output)) handle)
 234       (dump-push handle fasl-output)))
 235   (values))
 236 (defun string-save-object (x fasl-output)
 237   (declare (type fasl-output fasl-output)
 238            (type string x))
 239   (unless *cold-load-dump*
 240     (let ((handle (dump-pop fasl-output)))
 241       (push (cons (array-element-type x) handle)
 242             (gethash x (fasl-output-equal-table fasl-output)))
 243       (setf (gethash x (fasl-output-eq-table fasl-output)) handle)
 244       (dump-push handle fasl-output)))
 245   (values))
 246 ;;; Record X in File's CIRCULARITY-TABLE unless *COLD-LOAD-DUMP* is
 247 ;;; true. This is called on objects that we are about to dump might
 248 ;;; have a circular path through them.
 249 ;;;
 250 ;;; The object must not currently be in this table, since the dumper
 251 ;;; should never be recursively called on a circular reference.
 252 ;;; Instead, the dumping function must detect the circularity and
 253 ;;; arrange for the dumped object to be patched.
 254 (defun note-potential-circularity (x fasl-output)
 255   (unless *cold-load-dump*
 256     (let ((circ (fasl-output-circularity-table fasl-output)))
 257       (aver (not (gethash x circ)))
 258       (setf (gethash x circ) x)))
 259   (values))
 260
 261 ;;; Dump FORM to a fasl file so that it evaluated at load time in normal
 262 ;;; load and at cold-load time in cold load. This is used to dump package
 263 ;;; frobbing forms.
 264 (defun fasl-dump-cold-load-form (form fasl-output)
 265   (declare (type fasl-output fasl-output))
 266   (dump-fop 'fop-normal-load fasl-output)
 267   (let ((*cold-load-dump* t))
 268     (dump-object form fasl-output))
 269   (dump-fop 'fop-eval-for-effect fasl-output)
 270   (dump-fop 'fop-maybe-cold-load fasl-output)
 271   (values))
 272 \f
 273 ;;;; opening and closing fasl files
 274
 275 ;;; Open a fasl file, write its header, and return a FASL-OUTPUT
 276 ;;; object for dumping to it. Some human-readable information about
 277 ;;; the source code is given by the string WHERE.
 278 (defun open-fasl-output (name where)
 279   (declare (type pathname name))
 280   (flet ((fasl-write-string (string stream)
 281            ;; SB-EXT:STRING-TO-OCTETS is not available while cross-compiling
 282            #+sb-xc-host
 283            (loop for char across string
 284                  do (let ((code (char-code char)))
 285                       (unless (<= 0 code 127)
 286                         (setf char #\?))
 287                       (write-byte code stream)))
 288            ;; UTF-8 is safe to use, because +FASL-HEADER-STRING-STOP-CHAR-CODE+
 289            ;; may not appear in UTF-8 encoded bytes
 290            #-sb-xc-host
 291            (write-sequence (string-to-octets string :external-format :utf-8)
 292                            stream)))
 293     (let* ((stream (open name
 294                          :direction :output
 295                          :if-exists :supersede
 296                          :element-type 'sb!assem:assembly-unit))
 297            (res (make-fasl-output :stream stream)))
 298       ;; Begin the header with the constant machine-readable (and
 299       ;; semi-human-readable) string which is used to identify fasl files.
 300       (fasl-write-string *fasl-header-string-start-string* stream)
 301       ;; The constant string which begins the header is followed by
 302       ;; arbitrary human-readable text, terminated by
 303       ;; +FASL-HEADER-STRING-STOP-CHAR-CODE+.
 304       (fasl-write-string
 305        (with-standard-io-syntax
 306          (let ((*print-readably* nil)
 307                (*print-pretty* nil))
 308            (format nil
 309                    "~%  ~
 310                     compiled from ~S~%  ~
 311                     at ~A~%  ~
 312                     on ~A~%  ~
 313                     using ~A version ~A~%"
 314                    where
 315                    (format-universal-time nil (get-universal-time))
 316                    (machine-instance)
 317                    (sb!xc:lisp-implementation-type)
 318                    (sb!xc:lisp-implementation-version))))
 319        stream)
 320       (dump-byte +fasl-header-string-stop-char-code+ res)
 321       ;; Finish the header by outputting fasl file implementation,
 322       ;; version, and key *FEATURES*.
 323       (flet ((dump-counted-string (string)
 324                ;; The count is dumped as a 32-bit unsigned-byte even on 64-bit
 325                ;; platforms. This ensures that a x86-64 SBCL can gracefully
 326                ;; detect an error when trying to read a x86 fasl, instead
 327                ;; of choking on a ridiculously long counted string.
 328                ;;  -- JES, 2005-12-30
 329                (dump-unsigned-byte-32 (length string) res)
 330                (dotimes (i (length string))
 331                  (dump-byte (char-code (aref string i)) res))))
 332         (dump-counted-string (symbol-name +backend-fasl-file-implementation+))
 333         (dump-word +fasl-file-version+ res)
 334         (dump-counted-string (sb!xc:lisp-implementation-version))
 335         (dump-counted-string *features-affecting-fasl-format*))
 336       res)))
 337
 338 ;;; Close the specified FASL-OUTPUT, aborting the write if ABORT-P.
 339 (defun close-fasl-output (fasl-output abort-p)
 340   (declare (type fasl-output fasl-output))
 341
 342   (unless abort-p
 343     ;; sanity checks
 344     (aver (zerop (hash-table-count (fasl-output-patch-table fasl-output))))
 345     ;; End the group.
 346     (dump-fop 'fop-verify-empty-stack fasl-output)
 347     (dump-fop 'fop-verify-table-size fasl-output)
 348     (dump-word (fasl-output-table-free fasl-output)
 349                fasl-output)
 350     (dump-fop 'fop-end-group fasl-output))
 351
 352   ;; That's all, folks.
 353   (close (fasl-output-stream fasl-output) :abort abort-p)
 354   (values))
 355 \f
 356 ;;;; main entries to object dumping
 357
 358 ;;; This function deals with dumping objects that are complex enough
 359 ;;; so that we want to cache them in the table, rather than repeatedly
 360 ;;; dumping them. If the object is in the EQ-TABLE, then we push it,
 361 ;;; otherwise, we do a type dispatch to a type specific dumping
 362 ;;; function. The type specific branches do any appropriate
 363 ;;; EQUAL-TABLE check and table entry.
 364 ;;;
 365 ;;; When we go to dump the object, we enter it in the CIRCULARITY-TABLE.
 366 (defun dump-non-immediate-object (x file)
 367   (let ((index (gethash x (fasl-output-eq-table file))))
 368     (cond ((and index (not *cold-load-dump*))
 369            (dump-push index file))
 370           (t
 371            (typecase x
 372              (symbol (dump-symbol x file))
 373              (list
 374               ;; KLUDGE: The code in this case has been hacked
 375               ;; to match Douglas Crosher's quick fix to CMU CL
 376               ;; (on cmucl-imp 1999-12-27), applied in sbcl-0.6.8.11
 377               ;; with help from Martin Atzmueller. This is not an
 378               ;; ideal solution; to quote DTC,
 379               ;;   The compiler locks up trying to coalesce the
 380               ;;   constant lists. The hack below will disable the
 381               ;;   coalescing of lists while dumping and allows
 382               ;;   the code to compile. The real fix would be to
 383               ;;   take a little more care while dumping these.
 384               ;; So if better list coalescing is needed, start here.
 385               ;; -- WHN 2000-11-07
 386               (if (maybe-cyclic-p x)
 387                   (progn
 388                     (dump-list x file)
 389                     (eq-save-object x file))
 390                   (unless (equal-check-table x file)
 391                     (dump-list x file)
 392                     (equal-save-object x file))))
 393              (layout
 394               (dump-layout x file)
 395               (eq-save-object x file))
 396              (instance
 397               (dump-structure x file)
 398               (eq-save-object x file))
 399              (array
 400               ;; DUMP-ARRAY (and its callees) are responsible for
 401               ;; updating the EQ and EQUAL hash tables.
 402               (dump-array x file))
 403              (number
 404               (unless (equal-check-table x file)
 405                 (etypecase x
 406                   (ratio (dump-ratio x file))
 407                   (complex (dump-complex x file))
 408                   (float (dump-float x file))
 409                   (integer (dump-integer x file)))
 410                 (equal-save-object x file)))
 411              (t
 412               ;; This probably never happens, since bad things tend to
 413               ;; be detected during IR1 conversion.
 414               (error "This object cannot be dumped into a fasl file:~% ~S"
 415                      x))))))
 416   (values))
 417
 418 ;;; Dump an object of any type by dispatching to the correct
 419 ;;; type-specific dumping function. We pick off immediate objects,
 420 ;;; symbols and magic lists here. Other objects are handled by
 421 ;;; DUMP-NON-IMMEDIATE-OBJECT.
 422 ;;;
 423 ;;; This is the function used for recursive calls to the fasl dumper.
 424 ;;; We don't worry about creating circularities here, since it is
 425 ;;; assumed that there is a top level call to DUMP-OBJECT.
 426 (defun sub-dump-object (x file)
 427   (cond ((listp x)
 428          (if x
 429              (dump-non-immediate-object x file)
 430              (dump-fop 'fop-empty-list file)))
 431         ((symbolp x)
 432          (if (eq x t)
 433              (dump-fop 'fop-truth file)
 434              (dump-non-immediate-object x file)))
 435         ((fixnump x) (dump-integer x file))
 436         ((characterp x) (dump-character x file))
 437         (t
 438          (dump-non-immediate-object x file))))
 439
 440 ;;; Dump stuff to backpatch already dumped objects. INFOS is the list
 441 ;;; of CIRCULARITY structures describing what to do. The patching FOPs
 442 ;;; take the value to store on the stack. We compute this value by
 443 ;;; fetching the enclosing object from the table, and then CDR'ing it
 444 ;;; if necessary.
 445 (defun dump-circularities (infos file)
 446   (let ((table (fasl-output-eq-table file)))
 447     (dolist (info infos)
 448
 449       (let* ((value (circularity-value info))
 450              (enclosing (circularity-enclosing-object info)))
 451         (dump-push (gethash enclosing table) file)
 452         (unless (eq enclosing value)
 453           (do ((current enclosing (cdr current))
 454                (i 0 (1+ i)))
 455               ((eq current value)
 456                (dump-fop 'fop-nthcdr file)
 457                (dump-word i file))
 458             (declare (type index i)))))
 459
 460       (ecase (circularity-type info)
 461         (:rplaca     (dump-fop 'fop-rplaca    file))
 462         (:rplacd     (dump-fop 'fop-rplacd    file))
 463         (:svset      (dump-fop 'fop-svset     file))
 464         (:struct-set (dump-fop 'fop-structset file)))
 465       (dump-word (gethash (circularity-object info) table) file)
 466       (dump-word (circularity-index info) file))))
 467
 468 ;;; Set up stuff for circularity detection, then dump an object. All
 469 ;;; shared and circular structure will be exactly preserved within a
 470 ;;; single call to DUMP-OBJECT. Sharing between objects dumped by
 471 ;;; separate calls is only preserved when convenient.
 472 ;;;
 473 ;;; We peek at the object type so that we only pay the circular
 474 ;;; detection overhead on types of objects that might be circular.
 475 (defun dump-object (x file)
 476   (if (compound-object-p x)
 477       (let ((*circularities-detected* ())
 478             (circ (fasl-output-circularity-table file)))
 479         (clrhash circ)
 480         (sub-dump-object x file)
 481         (when *circularities-detected*
 482           (dump-circularities *circularities-detected* file)
 483           (clrhash circ)))
 484       (sub-dump-object x file)))
 485 \f
 486 ;;;; LOAD-TIME-VALUE and MAKE-LOAD-FORM support
 487
 488 ;;; Emit a funcall of the function and return the handle for the
 489 ;;; result.
 490 (defun fasl-dump-load-time-value-lambda (fun file)
 491   (declare (type sb!c::clambda fun) (type fasl-output file))
 492   (let ((handle (gethash (sb!c::leaf-info fun)
 493                          (fasl-output-entry-table file))))
 494     (aver handle)
 495     (dump-push handle file)
 496     (dump-fop 'fop-funcall file)
 497     (dump-byte 0 file))
 498   (dump-pop file))
 499
 500 ;;; Return T iff CONSTANT has already been dumped. It's been dumped if
 501 ;;; it's in the EQ table.
 502 ;;;
 503 ;;; Note: historically (1) the above comment was "T iff ... has not been dumped",
 504 ;;; (2) the test was  was also true if the constant had been validated / was in
 505 ;;; the valid objects table. This led to substructures occasionally skipping the
 506 ;;; validation, and hence failing the "must have been validated" test.
 507 (defun fasl-constant-already-dumped-p (constant file)
 508   (and (gethash constant (fasl-output-eq-table file)) t))
 509
 510 ;;; Use HANDLE whenever we try to dump CONSTANT. HANDLE should have been
 511 ;;; returned earlier by FASL-DUMP-LOAD-TIME-VALUE-LAMBDA.
 512 (defun fasl-note-handle-for-constant (constant handle file)
 513   (let ((table (fasl-output-eq-table file)))
 514     (when (gethash constant table)
 515       (error "~S already dumped?" constant))
 516     (setf (gethash constant table) handle))
 517   (values))
 518
 519 ;;; Note that the specified structure can just be dumped by
 520 ;;; enumerating the slots.
 521 (defun fasl-validate-structure (structure file)
 522   (setf (gethash structure (fasl-output-valid-structures file)) t)
 523   (values))
 524 \f
 525 ;;;; number dumping
 526
 527 (defun dump-ratio (x file)
 528   (sub-dump-object (numerator x) file)
 529   (sub-dump-object (denominator x) file)
 530   (dump-fop 'fop-ratio file))
 531
 532 (defun dump-integer (n file)
 533   (typecase n
 534     ((signed-byte 8)
 535      (dump-fop 'fop-byte-integer file)
 536      (dump-byte (logand #xFF n) file))
 537     ((unsigned-byte #.(1- sb!vm:n-word-bits))
 538      (dump-fop 'fop-word-integer file)
 539      (dump-word n file))
 540     ((signed-byte #.sb!vm:n-word-bits)
 541      (dump-fop 'fop-word-integer file)
 542      (dump-integer-as-n-bytes n #.sb!vm:n-word-bytes file))
 543     (t
 544      (let ((bytes (ceiling (1+ (integer-length n)) 8)))
 545        (dump-fop* bytes fop-small-integer fop-integer file)
 546        (dump-integer-as-n-bytes n bytes file)))))
 547
 548 (defun dump-float (x file)
 549   (etypecase x
 550     (single-float
 551      (dump-fop 'fop-single-float file)
 552      (dump-integer-as-n-bytes (single-float-bits x) 4 file))
 553     (double-float
 554      (dump-fop 'fop-double-float file)
 555      (let ((x x))
 556        (declare (double-float x))
 557        (dump-integer-as-n-bytes (double-float-low-bits x) 4 file)
 558        (dump-integer-as-n-bytes (double-float-high-bits x) 4 file)))
 559     #!+long-float
 560     (long-float
 561      (dump-fop 'fop-long-float file)
 562      (dump-long-float x file))))
 563
 564 (defun dump-complex (x file)
 565   (typecase x
 566     #-sb-xc-host
 567     ((complex single-float)
 568      (dump-fop 'fop-complex-single-float file)
 569      (dump-integer-as-n-bytes (single-float-bits (realpart x)) 4 file)
 570      (dump-integer-as-n-bytes (single-float-bits (imagpart x)) 4 file))
 571     #-sb-xc-host
 572     ((complex double-float)
 573      (dump-fop 'fop-complex-double-float file)
 574      (let ((re (realpart x)))
 575        (declare (double-float re))
 576        (dump-integer-as-n-bytes (double-float-low-bits re) 4 file)
 577        (dump-integer-as-n-bytes (double-float-high-bits re) 4 file))
 578      (let ((im (imagpart x)))
 579        (declare (double-float im))
 580        (dump-integer-as-n-bytes (double-float-low-bits im) 4 file)
 581        (dump-integer-as-n-bytes (double-float-high-bits im) 4 file)))
 582     #!+long-float
 583     ((complex long-float)
 584      ;; (There's no easy way to mix #!+LONG-FLOAT and #-SB-XC-HOST
 585      ;; conditionalization at read time, so we do this SB-XC-HOST
 586      ;; conditional at runtime instead.)
 587      #+sb-xc-host (error "can't dump COMPLEX-LONG-FLOAT in cross-compiler")
 588      (dump-fop 'fop-complex-long-float file)
 589      (dump-long-float (realpart x) file)
 590      (dump-long-float (imagpart x) file))
 591     (t
 592      (sub-dump-object (realpart x) file)
 593      (sub-dump-object (imagpart x) file)
 594      (dump-fop 'fop-complex file))))
 595 \f
 596 ;;;; symbol dumping
 597
 598 ;;; Return the table index of PKG, adding the package to the table if
 599 ;;; necessary. During cold load, we read the string as a normal string
 600 ;;; so that we can do the package lookup at cold load time.
 601 ;;;
 602 ;;; FIXME: Despite the parallelism in names, the functionality of
 603 ;;; this function is not parallel to other functions DUMP-FOO, e.g.
 604 ;;; DUMP-SYMBOL and DUMP-LIST. The mapping between names and behavior
 605 ;;; should be made more consistent.
 606 (declaim (ftype (function (package fasl-output) index) dump-package))
 607 (defun dump-package (pkg file)
 608   (declare (inline assoc))
 609   (cond ((cdr (assoc pkg (fasl-output-packages file) :test #'eq)))
 610         (t
 611          (unless *cold-load-dump*
 612            (dump-fop 'fop-normal-load file))
 613          #+sb-xc-host
 614          (dump-simple-base-string
 615           (coerce (package-name pkg) 'simple-base-string)
 616           file)
 617          #-sb-xc-host
 618          (#!+sb-unicode dump-simple-character-string
 619           #!-sb-unicode dump-simple-base-string
 620           (coerce (package-name pkg) '(simple-array character (*)))
 621           file)
 622          (dump-fop 'fop-package file)
 623          (unless *cold-load-dump*
 624            (dump-fop 'fop-maybe-cold-load file))
 625          (let ((entry (dump-pop file)))
 626            (push (cons pkg entry) (fasl-output-packages file))
 627            entry))))
 628 \f
 629 ;;; dumper for lists
 630
 631 ;;; Dump a list, setting up patching information when there are
 632 ;;; circularities. We scan down the list, checking for CDR and CAR
 633 ;;; circularities.
 634 ;;;
 635 ;;; If there is a CDR circularity, we terminate the list with NIL and
 636 ;;; make a CIRCULARITY notation for the CDR of the previous cons.
 637 ;;;
 638 ;;; If there is no CDR circularity, then we mark the current cons and
 639 ;;; check for a CAR circularity. When there is a CAR circularity, we
 640 ;;; make the CAR NIL initially, arranging for the current cons to be
 641 ;;; patched later.
 642 ;;;
 643 ;;; Otherwise, we recursively call the dumper to dump the current
 644 ;;; element.
 645 ;;;
 646 ;;; Marking of the conses is inhibited when *COLD-LOAD-DUMP* is true.
 647 ;;; This inhibits all circularity detection.
 648 (defun dump-list (list file)
 649   (aver (and list
 650              (not (gethash list (fasl-output-circularity-table file)))))
 651   (do* ((l list (cdr l))
 652         (n 0 (1+ n))
 653         (circ (fasl-output-circularity-table file)))
 654        ((atom l)
 655         (cond ((null l)
 656                (terminate-undotted-list n file))
 657               (t
 658                (sub-dump-object l file)
 659                (terminate-dotted-list n file))))
 660     (declare (type index n))
 661     (let ((ref (gethash l circ)))
 662       (when ref
 663         (push (make-circularity :type :rplacd
 664                                 :object list
 665                                 :index (1- n)
 666                                 :value l
 667                                 :enclosing-object ref)
 668               *circularities-detected*)
 669         (terminate-undotted-list n file)
 670         (return)))
 671
 672     (unless *cold-load-dump*
 673       (setf (gethash l circ) list))
 674
 675     (let* ((obj (car l))
 676            (ref (gethash obj circ)))
 677       (cond (ref
 678              (push (make-circularity :type :rplaca
 679                                      :object list
 680                                      :index n
 681                                      :value obj
 682                                      :enclosing-object ref)
 683                    *circularities-detected*)
 684              (sub-dump-object nil file))
 685             (t
 686              (sub-dump-object obj file))))))
 687
 688 (defun terminate-dotted-list (n file)
 689   (declare (type index n) (type fasl-output file))
 690   (case n
 691     (1 (dump-fop 'fop-list*-1 file))
 692     (2 (dump-fop 'fop-list*-2 file))
 693     (3 (dump-fop 'fop-list*-3 file))
 694     (4 (dump-fop 'fop-list*-4 file))
 695     (5 (dump-fop 'fop-list*-5 file))
 696     (6 (dump-fop 'fop-list*-6 file))
 697     (7 (dump-fop 'fop-list*-7 file))
 698     (8 (dump-fop 'fop-list*-8 file))
 699     (t (do ((nn n (- nn 255)))
 700            ((< nn 256)
 701             (dump-fop 'fop-list* file)
 702             (dump-byte nn file))
 703          (declare (type index nn))
 704          (dump-fop 'fop-list* file)
 705          (dump-byte 255 file)))))
 706
 707 ;;; If N > 255, must build list with one LIST operator, then LIST*
 708 ;;; operators.
 709
 710 (defun terminate-undotted-list (n file)
 711   (declare (type index n) (type fasl-output file))
 712   (case n
 713     (1 (dump-fop 'fop-list-1 file))
 714     (2 (dump-fop 'fop-list-2 file))
 715     (3 (dump-fop 'fop-list-3 file))
 716     (4 (dump-fop 'fop-list-4 file))
 717     (5 (dump-fop 'fop-list-5 file))
 718     (6 (dump-fop 'fop-list-6 file))
 719     (7 (dump-fop 'fop-list-7 file))
 720     (8 (dump-fop 'fop-list-8 file))
 721     (t (cond ((< n 256)
 722               (dump-fop 'fop-list file)
 723               (dump-byte n file))
 724              (t (dump-fop 'fop-list file)
 725                 (dump-byte 255 file)
 726                 (do ((nn (- n 255) (- nn 255)))
 727                     ((< nn 256)
 728                      (dump-fop 'fop-list* file)
 729                      (dump-byte nn file))
 730                   (declare (type index nn))
 731                   (dump-fop 'fop-list* file)
 732                   (dump-byte 255 file)))))))
 733 \f
 734 ;;;; array dumping
 735
 736 ;;; Dump the array thing.
 737 (defun dump-array (x file)
 738   (if (vectorp x)
 739       (dump-vector x file)
 740       (dump-multi-dim-array x file)))
 741
 742 ;;; Dump the vector object. If it's not simple, then actually dump a
 743 ;;; simple version of it. But we enter the original in the EQ or EQUAL
 744 ;;; tables.
 745 (defun dump-vector (x file)
 746   (let ((simple-version (if (array-header-p x)
 747                             (coerce x `(simple-array
 748                                         ,(array-element-type x)
 749                                         (*)))
 750                             x)))
 751     (typecase simple-version
 752       #+sb-xc-host
 753       (simple-string
 754        (unless (string-check-table x file)
 755          (dump-simple-base-string simple-version file)
 756          (string-save-object x file)))
 757       #-sb-xc-host
 758       (simple-base-string
 759        (unless (string-check-table x file)
 760          (dump-simple-base-string simple-version file)
 761          (string-save-object x file)))
 762       #-sb-xc-host
 763       ((simple-array character (*))
 764        #!+sb-unicode
 765        (unless (string-check-table x file)
 766          (dump-simple-character-string simple-version file)
 767          (string-save-object x file))
 768        #!-sb-unicode
 769        (bug "how did we get here?"))
 770       (simple-vector
 771        (dump-simple-vector simple-version file)
 772        (eq-save-object x file))
 773       ((simple-array single-float (*))
 774        (dump-single-float-vector simple-version file)
 775        (eq-save-object x file))
 776       ((simple-array double-float (*))
 777        (dump-double-float-vector simple-version file)
 778        (eq-save-object x file))
 779       #!+long-float
 780       ((simple-array long-float (*))
 781        (dump-long-float-vector simple-version file)
 782        (eq-save-object x file))
 783       ((simple-array (complex single-float) (*))
 784        (dump-complex-single-float-vector simple-version file)
 785        (eq-save-object x file))
 786       ((simple-array (complex double-float) (*))
 787        (dump-complex-double-float-vector simple-version file)
 788        (eq-save-object x file))
 789       #!+long-float
 790       ((simple-array (complex long-float) (*))
 791        (dump-complex-long-float-vector simple-version file)
 792        (eq-save-object x file))
 793       (t
 794        (dump-i-vector simple-version file)
 795        (eq-save-object x file)))))
 796
 797 ;;; Dump a SIMPLE-VECTOR, handling any circularities.
 798 (defun dump-simple-vector (v file)
 799   (declare (type simple-vector v) (type fasl-output file))
 800   (note-potential-circularity v file)
 801   (do ((index 0 (1+ index))
 802        (length (length v))
 803        (circ (fasl-output-circularity-table file)))
 804       ((= index length)
 805        (dump-fop* length fop-small-vector fop-vector file))
 806     (let* ((obj (aref v index))
 807            (ref (gethash obj circ)))
 808       (cond (ref
 809              (push (make-circularity :type :svset
 810                                      :object v
 811                                      :index index
 812                                      :value obj
 813                                      :enclosing-object ref)
 814                    *circularities-detected*)
 815              (sub-dump-object nil file))
 816             (t
 817              (sub-dump-object obj file))))))
 818
 819 ;;; In the grand scheme of things I don't pretend to understand any
 820 ;;; more how this works, or indeed whether.  But to write out specialized
 821 ;;; vectors in the same format as fop-int-vector expects to read them
 822 ;;; we need to be target-endian.  dump-integer-as-n-bytes always writes
 823 ;;; little-endian (which is correct for all other integers) so for a bigendian
 824 ;;; target we need to swap octets -- CSR, after DB
 825
 826 (defun octet-swap (word bits)
 827   "BITS must be a multiple of 8"
 828   (do ((input word (ash input -8))
 829        (output 0 (logior (ash output 8) (logand input #xff)))
 830        (bits bits (- bits 8)))
 831       ((<= bits 0) output)))
 832
 833 (defun dump-i-vector (vec file &key data-only)
 834   (declare (type (simple-array * (*)) vec))
 835   (let ((len (length vec)))
 836     (labels ((dump-unsigned-vector (size bytes)
 837                (unless data-only
 838                  (dump-fop 'fop-int-vector file)
 839                  (dump-word len file)
 840                  (dump-byte size file))
 841                ;; The case which is easy to handle in a portable way is when
 842                ;; the element size is a multiple of the output byte size, and
 843                ;; happily that's the only case we need to be portable. (The
 844                ;; cross-compiler has to output debug information (including
 845                ;; (SIMPLE-ARRAY (UNSIGNED-BYTE 8) *).) The other cases are only
 846                ;; needed in the target SBCL, so we let them be handled with
 847                ;; unportable bit bashing.
 848                (cond ((>= size 7) ; easy cases
 849                       (multiple-value-bind (floor rem) (floor size 8)
 850                         (aver (or (zerop rem) (= rem 7)))
 851                         (when (= rem 7)
 852                           (setq size (1+ size))
 853                           (setq floor (1+ floor)))
 854                         (dovector (i vec)
 855                           (dump-integer-as-n-bytes
 856                            (ecase sb!c:*backend-byte-order*
 857                              (:little-endian i)
 858                              (:big-endian (octet-swap i size)))
 859                            floor file))))
 860                      (t ; harder cases, not supported in cross-compiler
 861                       (dump-raw-bytes vec bytes file))))
 862              (dump-signed-vector (size bytes)
 863                ;; Note: Dumping specialized signed vectors isn't
 864                ;; supported in the cross-compiler. (All cases here end
 865                ;; up trying to call DUMP-RAW-BYTES, which isn't
 866                ;; provided in the cross-compilation host, only on the
 867                ;; target machine.)
 868                (unless data-only
 869                  (dump-fop 'fop-signed-int-vector file)
 870                  (dump-word len file)
 871                  (dump-byte size file))
 872                (dump-raw-bytes vec bytes file)))
 873       (etypecase vec
 874         #-sb-xc-host
 875         ((simple-array nil (*))
 876          (dump-unsigned-vector 0 0))
 877         (simple-bit-vector
 878          (dump-unsigned-vector 1 (ceiling len 8))) ; bits to bytes
 879         ;; KLUDGE: This isn't the best way of expressing that the host
 880         ;; may not have specializations for (unsigned-byte 2) and
 881         ;; (unsigned-byte 4), which means that these types are
 882         ;; type-equivalent to (simple-array (unsigned-byte 8) (*));
 883         ;; the workaround is to remove them from the etypecase, since
 884         ;; they can't be dumped from the cross-compiler anyway. --
 885         ;; CSR, 2002-05-07
 886         #-sb-xc-host
 887         ((simple-array (unsigned-byte 2) (*))
 888          (dump-unsigned-vector 2 (ceiling (ash len 1) 8))) ; bits to bytes
 889         #-sb-xc-host
 890         ((simple-array (unsigned-byte 4) (*))
 891          (dump-unsigned-vector 4 (ceiling (ash len 2) 8))) ; bits to bytes
 892         #-sb-xc-host
 893         ((simple-array (unsigned-byte 7) (*))
 894          (dump-unsigned-vector 7 len))
 895         ((simple-array (unsigned-byte 8) (*))
 896          (dump-unsigned-vector 8 len))
 897         #-sb-xc-host
 898         ((simple-array (unsigned-byte 15) (*))
 899          (dump-unsigned-vector 15 (* 2 len)))
 900         ((simple-array (unsigned-byte 16) (*))
 901          (dump-unsigned-vector 16 (* 2 len)))
 902         #-sb-xc-host
 903         ((simple-array (unsigned-byte 31) (*))
 904          (dump-unsigned-vector 31 (* 4 len)))
 905         ((simple-array (unsigned-byte 32) (*))
 906          (dump-unsigned-vector 32 (* 4 len)))
 907         #-sb-xc-host
 908         #!+#.(cl:if (cl:= 64 sb!vm:n-word-bits) '(and) '(or))
 909         ((simple-array (unsigned-byte 63) (*))
 910          (dump-unsigned-vector 63 (* 8 len)))
 911         #!+#.(cl:if (cl:= 64 sb!vm:n-word-bits) '(and) '(or))
 912         ((simple-array (unsigned-byte 64) (*))
 913          (dump-unsigned-vector 64 (* 8 len)))
 914         ((simple-array (signed-byte 8) (*))
 915          (dump-signed-vector 8 len))
 916         ((simple-array (signed-byte 16) (*))
 917          (dump-signed-vector 16 (* 2 len)))
 918         #!+#.(cl:if (cl:= 32 sb!vm:n-word-bits) '(and) '(or))
 919         ((simple-array (unsigned-byte 29) (*))
 920          (dump-signed-vector 29 (* 4 len)))
 921         #!+#.(cl:if (cl:= 32 sb!vm:n-word-bits) '(and) '(or))
 922         ((simple-array (signed-byte 30) (*))
 923          (dump-signed-vector 30 (* 4 len)))
 924         ((simple-array (signed-byte 32) (*))
 925          (dump-signed-vector 32 (* 4 len)))
 926         #!+#.(cl:if (cl:= 64 sb!vm:n-word-bits) '(and) '(or))
 927         ((simple-array (unsigned-byte 60) (*))
 928          (dump-signed-vector 60 (* 8 len)))
 929         #!+#.(cl:if (cl:= 64 sb!vm:n-word-bits) '(and) '(or))
 930         ((simple-array (signed-byte 61) (*))
 931          (dump-signed-vector 61 (* 8 len)))
 932         #!+#.(cl:if (cl:= 64 sb!vm:n-word-bits) '(and) '(or))
 933         ((simple-array (signed-byte 64) (*))
 934          (dump-signed-vector 64 (* 8 len)))))))
 935 \f
 936 ;;; Dump characters and string-ish things.
 937
 938 (defun dump-character (char file)
 939   (let ((code (sb!xc:char-code char)))
 940     (cond
 941       ((< code 256)
 942        (dump-fop 'fop-short-character file)
 943        (dump-byte code file))
 944       (t
 945        (dump-fop 'fop-character file)
 946        (dump-word code file)))))
 947
 948 (defun dump-base-chars-of-string (s fasl-output)
 949   (declare #+sb-xc-host (type simple-string s)
 950            #-sb-xc-host (type simple-base-string s)
 951            (type fasl-output fasl-output))
 952   (dovector (c s)
 953     (dump-byte (sb!xc:char-code c) fasl-output))
 954   (values))
 955
 956
 957 ;;; Dump a SIMPLE-BASE-STRING.
 958 (defun dump-simple-base-string (s file)
 959   #+sb-xc-host (declare (type simple-string s))
 960   #-sb-xc-host (declare (type simple-base-string s))
 961   (dump-fop* (length s) fop-small-base-string fop-base-string file)
 962   (dump-base-chars-of-string s file)
 963   (values))
 964
 965 ;;; If we get here, it is assumed that the symbol isn't in the table,
 966 ;;; but we are responsible for putting it there when appropriate. To
 967 ;;; avoid too much special-casing, we always push the symbol in the
 968 ;;; table, but don't record that we have done so if *COLD-LOAD-DUMP*
 969 ;;; is true.
 970 (defun dump-symbol (s file)
 971   (declare (type fasl-output file))
 972   (let* ((pname (symbol-name s))
 973          (pname-length (length pname))
 974          (pkg (symbol-package s)))
 975
 976     (cond ((null pkg)
 977            (dump-fop* pname-length
 978                       fop-uninterned-small-symbol-save
 979                       fop-uninterned-symbol-save
 980                       file))
 981           ;; CMU CL had FOP-SYMBOL-SAVE/FOP-SMALL-SYMBOL-SAVE fops which
 982           ;; used the current value of *PACKAGE*. Unfortunately that's
 983           ;; broken w.r.t. ANSI Common Lisp semantics, so those are gone
 984           ;; from SBCL.
 985           ;;((eq pkg *package*)
 986           ;; (dump-fop* pname-length
 987           ;;        fop-small-symbol-save
 988           ;;        fop-symbol-save file))
 989           ((eq pkg sb!int:*cl-package*)
 990            (dump-fop* pname-length
 991                       fop-lisp-small-symbol-save
 992                       fop-lisp-symbol-save
 993                       file))
 994           ((eq pkg sb!int:*keyword-package*)
 995            (dump-fop* pname-length
 996                       fop-keyword-small-symbol-save
 997                       fop-keyword-symbol-save
 998                       file))
 999           ((< pname-length 256)
1000            (dump-fop* (dump-package pkg file)
1001                       fop-small-symbol-in-byte-package-save
1002                       fop-small-symbol-in-package-save
1003                       file)
1004            (dump-byte pname-length file))
1005           (t
1006            (dump-fop* (dump-package pkg file)
1007                       fop-symbol-in-byte-package-save
1008                       fop-symbol-in-package-save
1009                       file)
1010            (dump-word pname-length file)))
1011
1012     #+sb-xc-host (dump-base-chars-of-string pname file)
1013     #-sb-xc-host (#!+sb-unicode dump-characters-of-string
1014                   #!-sb-unicode dump-base-chars-of-string
1015                   pname file)
1016
1017     (unless *cold-load-dump*
1018       (setf (gethash s (fasl-output-eq-table file))
1019             (fasl-output-table-free file)))
1020
1021     (incf (fasl-output-table-free file)))
1022
1023   (values))
1024 \f
1025 ;;;; component (function) dumping
1026
1027 (defun dump-segment (segment code-length fasl-output)
1028   (declare (type sb!assem:segment segment)
1029            (type fasl-output fasl-output))
1030   (let* ((stream (fasl-output-stream fasl-output))
1031          (n-written (write-segment-contents segment stream)))
1032     ;; In CMU CL there was no enforced connection between the CODE-LENGTH
1033     ;; argument and the number of bytes actually written. I added this
1034     ;; assertion while trying to debug portable genesis. -- WHN 19990902
1035     (unless (= code-length n-written)
1036       (bug "code-length=~W, n-written=~W" code-length n-written)))
1037   (values))
1038
1039 ;;; Dump all the fixups. Currently there are three flavors of fixup:
1040 ;;;  - assembly routines: named by a symbol
1041 ;;;  - foreign (C) symbols: named by a string
1042 ;;;  - code object references: don't need a name.
1043 (defun dump-fixups (fixups fasl-output)
1044   (declare (list fixups) (type fasl-output fasl-output))
1045   (dolist (note fixups)
1046     (let* ((kind (fixup-note-kind note))
1047            (fixup (fixup-note-fixup note))
1048            (position (fixup-note-position note))
1049            (name (fixup-name fixup))
1050            (flavor (fixup-flavor fixup)))
1051       (dump-fop 'fop-normal-load fasl-output)
1052       (let ((*cold-load-dump* t))
1053         (dump-object kind fasl-output))
1054       (dump-fop 'fop-maybe-cold-load fasl-output)
1055       ;; Depending on the flavor, we may have various kinds of
1056       ;; noise before the position.
1057       (ecase flavor
1058         (:assembly-routine
1059          (aver (symbolp name))
1060          (dump-fop 'fop-normal-load fasl-output)
1061          (let ((*cold-load-dump* t))
1062            (dump-object name fasl-output))
1063          (dump-fop 'fop-maybe-cold-load fasl-output)
1064          (dump-fop 'fop-assembler-fixup fasl-output))
1065         ((:foreign :foreign-dataref)
1066          (aver (stringp name))
1067          (ecase flavor
1068            (:foreign
1069             (dump-fop 'fop-foreign-fixup fasl-output))
1070            #!+linkage-table
1071            (:foreign-dataref
1072             (dump-fop 'fop-foreign-dataref-fixup fasl-output)))
1073          (let ((len (length name)))
1074            (aver (< len 256)) ; (limit imposed by fop definition)
1075            (dump-byte len fasl-output)
1076            (dotimes (i len)
1077              (dump-byte (char-code (schar name i)) fasl-output))))
1078         (:code-object
1079          (aver (null name))
1080          (dump-fop 'fop-code-object-fixup fasl-output)))
1081       ;; No matter what the flavor, we'll always dump the position
1082       (dump-word position fasl-output)))
1083   (values))
1084
1085 ;;; Dump out the constant pool and code-vector for component, push the
1086 ;;; result in the table, and return the offset.
1087 ;;;
1088 ;;; The only tricky thing is handling constant-pool references to
1089 ;;; functions. If we have already dumped the function, then we just
1090 ;;; push the code pointer. Otherwise, we must create back-patching
1091 ;;; information so that the constant will be set when the function is
1092 ;;; eventually dumped. This is a bit awkward, since we don't have the
1093 ;;; handle for the code object being dumped while we are dumping its
1094 ;;; constants.
1095 ;;;
1096 ;;; We dump trap objects in any unused slots or forward referenced slots.
1097 (defun dump-code-object (component
1098                          code-segment
1099                          code-length
1100                          trace-table-as-list
1101                          fixups
1102                          fasl-output)
1103
1104   (declare (type component component)
1105            (list trace-table-as-list)
1106            (type index code-length)
1107            (type fasl-output fasl-output))
1108
1109   (let* ((2comp (component-info component))
1110          (constants (sb!c::ir2-component-constants 2comp))
1111          (header-length (length constants))
1112          (packed-trace-table (pack-trace-table trace-table-as-list))
1113          (total-length (+ code-length
1114                           (* (length packed-trace-table)
1115                              sb!c::tt-bytes-per-entry))))
1116
1117     (collect ((patches))
1118
1119       ;; Dump the offset of the trace table.
1120       (dump-object code-length fasl-output)
1121       ;; FIXME: As long as we don't have GENGC, the trace table is
1122       ;; hardwired to be empty. And SBCL doesn't have GENGC (and as
1123       ;; far as I know no modern CMU CL does either -- WHN
1124       ;; 2001-10-05). So might we be able to get rid of trace tables?
1125       ;;
1126       ;; Note that gencgc also does something with the trace table.
1127
1128       ;; Dump the constants, noting any :ENTRY constants that have to
1129       ;; be patched.
1130       (loop for i from sb!vm:code-constants-offset below header-length do
1131         (let ((entry (aref constants i)))
1132           (etypecase entry
1133             (constant
1134              (dump-object (sb!c::constant-value entry) fasl-output))
1135             (cons
1136              (ecase (car entry)
1137                (:entry
1138                 (let* ((info (sb!c::leaf-info (cdr entry)))
1139                        (handle (gethash info
1140                                         (fasl-output-entry-table
1141                                          fasl-output))))
1142                   (declare (type sb!c::entry-info info))
1143                   (cond
1144                    (handle
1145                     (dump-push handle fasl-output))
1146                    (t
1147                     (patches (cons info i))
1148                     (dump-fop 'fop-misc-trap fasl-output)))))
1149                (:load-time-value
1150                 (dump-push (cdr entry) fasl-output))
1151                (:fdefinition
1152                 (dump-object (cdr entry) fasl-output)
1153                 (dump-fop 'fop-fdefinition fasl-output))))
1154             (null
1155              (dump-fop 'fop-misc-trap fasl-output)))))
1156
1157       ;; Dump the debug info.
1158       (let ((info (sb!c::debug-info-for-component component))
1159             (*dump-only-valid-structures* nil))
1160         (dump-object info fasl-output)
1161         (let ((info-handle (dump-pop fasl-output)))
1162           (dump-push info-handle fasl-output)
1163           (push info-handle (fasl-output-debug-info fasl-output))))
1164
1165       (let ((num-consts (- header-length sb!vm:code-trace-table-offset-slot)))
1166         (cond ((and (< num-consts #x100) (< total-length #x10000))
1167                (dump-fop 'fop-small-code fasl-output)
1168                (dump-byte num-consts fasl-output)
1169                (dump-integer-as-n-bytes total-length (/ sb!vm:n-word-bytes 2) fasl-output))
1170               (t
1171                (dump-fop 'fop-code fasl-output)
1172                (dump-word num-consts fasl-output)
1173                (dump-word total-length fasl-output))))
1174
1175       ;; These two dumps are only ones which contribute to our
1176       ;; TOTAL-LENGTH value.
1177       (dump-segment code-segment code-length fasl-output)
1178       (dump-i-vector packed-trace-table fasl-output :data-only t)
1179
1180       ;; DUMP-FIXUPS does its own internal DUMP-FOPs: the bytes it
1181       ;; dumps aren't included in the TOTAL-LENGTH passed to our
1182       ;; FOP-CODE/FOP-SMALL-CODE fop.
1183       (dump-fixups fixups fasl-output)
1184
1185       (dump-fop 'fop-sanctify-for-execution fasl-output)
1186
1187       (let ((handle (dump-pop fasl-output)))
1188         (dolist (patch (patches))
1189           (push (cons handle (cdr patch))
1190                 (gethash (car patch)
1191                          (fasl-output-patch-table fasl-output))))
1192         handle))))
1193
1194 (defun dump-assembler-routines (code-segment length fixups routines file)
1195   (dump-fop 'fop-assembler-code file)
1196   (dump-word length file)
1197   (write-segment-contents code-segment (fasl-output-stream file))
1198   (dolist (routine routines)
1199     (dump-fop 'fop-normal-load file)
1200     (let ((*cold-load-dump* t))
1201       (dump-object (car routine) file))
1202     (dump-fop 'fop-maybe-cold-load file)
1203     (dump-fop 'fop-assembler-routine file)
1204     (dump-word (label-position (cdr routine)) file))
1205   (dump-fixups fixups file)
1206   (dump-fop 'fop-sanctify-for-execution file)
1207   (dump-pop file))
1208
1209 ;;; Dump a function entry data structure corresponding to ENTRY to
1210 ;;; FILE. CODE-HANDLE is the table offset of the code object for the
1211 ;;; component.
1212 (defun dump-one-entry (entry code-handle file)
1213   (declare (type sb!c::entry-info entry) (type index code-handle)
1214            (type fasl-output file))
1215   (let ((name (sb!c::entry-info-name entry)))
1216     (dump-push code-handle file)
1217     (dump-object name file)
1218     (dump-object (sb!c::entry-info-arguments entry) file)
1219     (dump-object (sb!c::entry-info-type entry) file)
1220     (dump-object (sb!c::entry-info-xref entry) file)
1221     (dump-fop 'fop-fun-entry file)
1222     (dump-word (label-position (sb!c::entry-info-offset entry)) file)
1223     (dump-pop file)))
1224
1225 ;;; Alter the code object referenced by CODE-HANDLE at the specified
1226 ;;; OFFSET, storing the object referenced by ENTRY-HANDLE.
1227 (defun dump-alter-code-object (code-handle offset entry-handle file)
1228   (declare (type index code-handle entry-handle offset))
1229   (declare (type fasl-output file))
1230   (dump-push code-handle file)
1231   (dump-push entry-handle file)
1232   (dump-fop* offset fop-byte-alter-code fop-alter-code file)
1233   (values))
1234
1235 ;;; Dump the code, constants, etc. for component. We pass in the
1236 ;;; assembler fixups, code vector and node info.
1237 (defun fasl-dump-component (component
1238                             code-segment
1239                             code-length
1240                             trace-table
1241                             fixups
1242                             file)
1243   (declare (type component component) (list trace-table))
1244   (declare (type fasl-output file))
1245
1246   (dump-fop 'fop-verify-table-size file)
1247   (dump-word (fasl-output-table-free file) file)
1248
1249   #!+sb-dyncount
1250   (let ((info (sb!c::ir2-component-dyncount-info (component-info component))))
1251     (when info
1252       (fasl-validate-structure info file)))
1253
1254   (let ((code-handle (dump-code-object component
1255                                        code-segment
1256                                        code-length
1257                                        trace-table
1258                                        fixups
1259                                        file))
1260         (2comp (component-info component)))
1261
1262     (dolist (entry (sb!c::ir2-component-entries 2comp))
1263       (let ((entry-handle (dump-one-entry entry code-handle file)))
1264         (setf (gethash entry (fasl-output-entry-table file)) entry-handle)
1265         (let ((old (gethash entry (fasl-output-patch-table file))))
1266           (when old
1267             (dolist (patch old)
1268               (dump-alter-code-object (car patch)
1269                                       (cdr patch)
1270                                       entry-handle
1271                                       file))
1272             (remhash entry (fasl-output-patch-table file)))))))
1273   (values))
1274
1275 (defun dump-push-previously-dumped-fun (fun fasl-output)
1276   (declare (type sb!c::clambda fun))
1277   (let ((handle (gethash (sb!c::leaf-info fun)
1278                          (fasl-output-entry-table fasl-output))))
1279     (aver handle)
1280     (dump-push handle fasl-output))
1281   (values))
1282
1283 ;;; Dump a FOP-FUNCALL to call an already-dumped top level lambda at
1284 ;;; load time.
1285 (defun fasl-dump-toplevel-lambda-call (fun fasl-output)
1286   (declare (type sb!c::clambda fun))
1287   (dump-push-previously-dumped-fun fun fasl-output)
1288   (dump-fop 'fop-funcall-for-effect fasl-output)
1289   (dump-byte 0 fasl-output)
1290   (values))
1291
1292 ;;; Dump a FOP-FSET to arrange static linkage (at cold init) between
1293 ;;; FUN-NAME and the already-dumped function whose dump handle is
1294 ;;; FUN-DUMP-HANDLE.
1295 #+sb-xc-host
1296 (defun fasl-dump-cold-fset (fun-name fun-dump-handle fasl-output)
1297   (declare (type fixnum fun-dump-handle))
1298   (aver (legal-fun-name-p fun-name))
1299   (dump-non-immediate-object fun-name fasl-output)
1300   (dump-push fun-dump-handle fasl-output)
1301   (dump-fop 'fop-fset fasl-output)
1302   (values))
1303
1304 ;;; Compute the correct list of DEBUG-SOURCE structures and backpatch
1305 ;;; all of the dumped DEBUG-INFO structures. We clear the
1306 ;;; FASL-OUTPUT-DEBUG-INFO, so that subsequent components with
1307 ;;; different source info may be dumped.
1308 (defun fasl-dump-source-info (info fasl-output)
1309   (declare (type sb!c::source-info info))
1310   (let ((res (sb!c::debug-source-for-info info))
1311         (*dump-only-valid-structures* nil))
1312     (dump-object res fasl-output)
1313     (let ((res-handle (dump-pop fasl-output)))
1314       (dolist (info-handle (fasl-output-debug-info fasl-output))
1315         (dump-push res-handle fasl-output)
1316         (dump-fop 'fop-structset fasl-output)
1317         (dump-word info-handle fasl-output)
1318         ;; FIXME: what is this bare `2'?  --njf, 2004-08-16
1319         (dump-word 2 fasl-output))))
1320   (setf (fasl-output-debug-info fasl-output) nil)
1321   (values))
1322 \f
1323 ;;;; dumping structures
1324
1325 (defun dump-structure (struct file)
1326   (when *dump-only-valid-structures*
1327     (unless (gethash struct (fasl-output-valid-structures file))
1328       (error "attempt to dump invalid structure:~%  ~S~%How did this happen?"
1329              struct)))
1330   (note-potential-circularity struct file)
1331   (aver (%instance-ref struct 0))
1332   (do* ((length (%instance-length struct))
1333         (ntagged (- length (layout-n-untagged-slots (%instance-ref struct 0))))
1334         (circ (fasl-output-circularity-table file))
1335         ;; last slot first on the stack, so that the layout is on top:
1336         (index (1- length) (1- index)))
1337       ((minusp index)
1338        (dump-fop* length fop-small-struct fop-struct file))
1339     (let* ((obj (if (>= index ntagged)
1340                     (%raw-instance-ref/word struct (- length index 1))
1341                     (%instance-ref struct index)))
1342            (ref (gethash obj circ)))
1343       (cond (ref
1344              (aver (not (zerop index)))
1345              (push (make-circularity :type :struct-set
1346                                      :object struct
1347                                      :index index
1348                                      :value obj
1349                                      :enclosing-object ref)
1350                    *circularities-detected*)
1351              (sub-dump-object nil file))
1352             (t
1353              (sub-dump-object obj file))))))
1354
1355 (defun dump-layout (obj file)
1356   (when (layout-invalid obj)
1357     (compiler-error "attempt to dump reference to obsolete class: ~S"
1358                     (layout-classoid obj)))
1359   (let ((name (classoid-name (layout-classoid obj))))
1360     (unless name
1361       (compiler-error "dumping anonymous layout: ~S" obj))
1362     (dump-fop 'fop-normal-load file)
1363     (let ((*cold-load-dump* t))
1364       (dump-object name file))
1365     (dump-fop 'fop-maybe-cold-load file))
1366   (sub-dump-object (layout-inherits obj) file)
1367   (sub-dump-object (layout-depthoid obj) file)
1368   (sub-dump-object (layout-length obj) file)
1369   (sub-dump-object (layout-n-untagged-slots obj) file)
1370   (dump-fop 'fop-layout file))