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