X-Git-Url: http://repo.macrolet.net/gitweb/?a=blobdiff_plain;f=src%2Fcompiler%2Fdump.lisp;h=9e50e68a41d27d380bf4f2ac329554e0f81ce5d1;hb=581e3d62de8cb37e13ad9db63e5537c0f962be28;hp=98d482b1897cafaba61b9634711de36d00128473;hpb=f61bddabbb69f1347b81b8ab76e709635a7a0739;p=sbcl.git diff --git a/src/compiler/dump.lisp b/src/compiler/dump.lisp index 98d482b..9e50e68 100644 --- a/src/compiler/dump.lisp +++ b/src/compiler/dump.lisp @@ -28,7 +28,7 @@ s)))) (:copier nil)) ;; the stream we dump to - (stream (required-argument) :type stream) + (stream (missing-arg) :type stream) ;; hashtables we use to keep track of dumped constants so that we ;; can get them from the table rather than dumping them again. The ;; EQUAL-TABLE is used for lists and strings, and the EQ-TABLE is @@ -43,11 +43,11 @@ ;; an alist (PACKAGE . OFFSET) of the table offsets for each package ;; we have currently located. (packages () :type list) - ;; a table mapping from the Entry-Info structures for dumped XEPs to + ;; a table mapping from the ENTRY-INFO structures for dumped XEPs to ;; the table offsets of the corresponding code pointers (entry-table (make-hash-table :test 'eq) :type hash-table) ;; a table holding back-patching info for forward references to XEPs. - ;; The key is the Entry-Info structure for the XEP, and the value is + ;; The key is the ENTRY-INFO structure for the XEP, and the value is ;; a list of conses ( . ), where ;; is the offset in the table of the code object needing to be ;; patched, and is the offset that must be patched. @@ -72,11 +72,11 @@ ;;; This structure holds information about a circularity. (defstruct (circularity (:copier nil)) ;; the kind of modification to make to create circularity - (type (required-argument) :type (member :rplaca :rplacd :svset :struct-set)) + (type (missing-arg) :type (member :rplaca :rplacd :svset :struct-set)) ;; the object containing circularity object ;; index in object for circularity - (index (required-argument) :type index) + (index (missing-arg) :type index) ;; the object to be stored at INDEX in OBJECT. This is that the key ;; that we were using when we discovered the circularity. value @@ -86,7 +86,7 @@ enclosing-object) ;;; a list of the CIRCULARITY structures for all of the circularities -;;; detected in the current top-level call to DUMP-OBJECT. Setting +;;; detected in the current top level call to DUMP-OBJECT. Setting ;;; this lobotomizes circularity detection as well, since circular ;;; dumping uses the table. (defvar *circularities-detected*) @@ -155,7 +155,7 @@ (dump-byte ',val ,file)) (error "compiler bug: ~S is not a legal fasload operator." fs)))) -;;; Dump a FOP-Code along with an integer argument, choosing the FOP +;;; Dump a FOP-CODE along with an integer argument, choosing the FOP ;;; based on whether the argument will fit in a single byte. ;;; ;;; FIXME: This, like DUMP-FOP, should be a function with a @@ -246,45 +246,56 @@ ;;;; opening and closing fasl files +;;; A utility function to write strings to (unsigned-byte 8) streams. +;;; We restrict this to ASCII (with the averrance) because of +;;; ambiguity of higher bytes: Unicode, some ISO-8859-x, or what? This +;;; could be revisited in the event of doing funky things with stream +;;; encodings -- CSR, 2002-04-25 +(defun fasl-write-string (string stream) + (loop for char across string + do (let ((code (char-code char))) + (aver (<= 0 code 127)) + (write-byte code stream)))) + ;;; Open a fasl file, write its header, and return a FASL-OUTPUT ;;; object for dumping to it. Some human-readable information about ;;; the source code is given by the string WHERE. If BYTE-P is true, ;;; this file will contain no native code, and is thus largely ;;; implementation independent. -(defun open-fasl-output (name where &optional byte-p) +(defun open-fasl-output (name where) (declare (type pathname name)) (let* ((stream (open name :direction :output - :if-exists :new-version + :if-exists :supersede :element-type 'sb!assem:assembly-unit)) (res (make-fasl-output :stream stream))) ;; Begin the header with the constant machine-readable (and ;; semi-human-readable) string which is used to identify fasl files. - (write-string *fasl-header-string-start-string* stream) + (fasl-write-string *fasl-header-string-start-string* stream) ;; The constant string which begins the header is followed by ;; arbitrary human-readable text, terminated by a special ;; character code. - (with-standard-io-syntax - (format stream - "~% ~ - compiled from ~S~% ~ - at ~A~% ~ - on ~A~% ~ - using ~A version ~A~%" - where - (format-universal-time nil (get-universal-time)) - (machine-instance) - (sb!xc:lisp-implementation-type) - (sb!xc:lisp-implementation-version))) + (fasl-write-string + (with-standard-io-syntax + (format nil + "~% ~ + compiled from ~S~% ~ + at ~A~% ~ + on ~A~% ~ + using ~A version ~A~%" + where + (format-universal-time nil (get-universal-time)) + (machine-instance) + (sb!xc:lisp-implementation-type) + (sb!xc:lisp-implementation-version))) + stream) (dump-byte +fasl-header-string-stop-char-code+ res) ;; Finish the header by outputting fasl file implementation and ;; version in machine-readable form. - (let ((implementation (if byte-p - (backend-byte-fasl-file-implementation) - +backend-fasl-file-implementation+))) + (let ((implementation +backend-fasl-file-implementation+)) (dump-unsigned-32 (length (symbol-name implementation)) res) (dotimes (i (length (symbol-name implementation))) (dump-byte (char-code (aref (symbol-name implementation) i)) res))) @@ -340,7 +351,7 @@ ;; take a little more care while dumping these. ;; So if better list coalescing is needed, start here. ;; -- WHN 2000-11-07 - (if (circular-list-p x) + (if (cyclic-list-p x) (progn (dump-list x file) (eq-save-object x file)) @@ -382,7 +393,7 @@ ;;; ;;; This is the function used for recursive calls to the fasl dumper. ;;; We don't worry about creating circularities here, since it is -;;; assumed that there is a top-level call to DUMP-OBJECT. +;;; assumed that there is a top level call to DUMP-OBJECT. (defun sub-dump-object (x file) (cond ((listp x) (if x @@ -433,10 +444,7 @@ ;;; We peek at the object type so that we only pay the circular ;;; detection overhead on types of objects that might be circular. (defun dump-object (x file) - (if (or (array-header-p x) - (simple-vector-p x) - (consp x) - (typep x 'instance)) + (if (compound-object-p x) (let ((*circularities-detected* ()) (circ (fasl-output-circularity-table file))) (clrhash circ) @@ -568,9 +576,8 @@ ;;; this function is not parallel to other functions DUMP-FOO, e.g. ;;; DUMP-SYMBOL and DUMP-LIST. The mapping between names and behavior ;;; should be made more consistent. +(declaim (ftype (function (package fasl-output) index) dump-package)) (defun dump-package (pkg file) - (declare (type package pkg) (type fasl-output file)) - (declare (values index)) (declare (inline assoc)) (cond ((cdr (assoc pkg (fasl-output-packages file) :test #'eq))) (t @@ -758,6 +765,20 @@ (t (sub-dump-object obj file)))))) +;;; In the grand scheme of things I don't pretend to understand any +;;; more how this works, or indeed whether. But to write out specialized +;;; vectors in the same format as fop-int-vector expects to read them +;;; we need to be target-endian. dump-integer-as-n-bytes always writes +;;; little-endian (which is correct for all other integers) so for a bigendian +;;; target we need to swap octets -- CSR, after DB + +(defun octet-swap (word bits) + "BITS must be a multiple of 8" + (do ((input word (ash input -8)) + (output 0 (logior (ash output 8) (logand input #xff))) + (bits bits (- bits 8))) + ((<= bits 0) output))) + (defun dump-i-vector (vec file &key data-only) (declare (type (simple-array * (*)) vec)) (let ((len (length vec))) @@ -777,7 +798,11 @@ (multiple-value-bind (floor rem) (floor size 8) (aver (zerop rem)) (dovector (i vec) - (dump-integer-as-n-bytes i floor file)))) + (dump-integer-as-n-bytes + (ecase sb!c:*backend-byte-order* + (:little-endian i) + (:big-endian (octet-swap i size))) + floor file)))) (t ; harder cases, not supported in cross-compiler (dump-raw-bytes vec bytes file)))) (dump-signed-vector (size bytes) @@ -795,8 +820,17 @@ ;; KLUDGE: What exactly does the (ASH .. -3) stuff do? -- WHN 19990902 (simple-bit-vector (dump-unsigned-vector 1 (ash (+ (the index len) 7) -3))) + ;; KLUDGE: This isn't the best way of expressing that the host + ;; may not have specializations for (unsigned-byte 2) and + ;; (unsigned-byte 4), which means that these types are + ;; type-equivalent to (simple-array (unsigned-byte 8) (*)); + ;; the workaround is to remove them from the etypecase, since + ;; they can't be dumped from the cross-compiler anyway. -- + ;; CSR, 2002-05-07 + #-sb-xc-host ((simple-array (unsigned-byte 2) (*)) (dump-unsigned-vector 2 (ash (+ (the index (ash len 1)) 7) -3))) + #-sb-xc-host ((simple-array (unsigned-byte 4) (*)) (dump-unsigned-vector 4 (ash (+ (the index (ash len 2)) 7) -3))) ((simple-array (unsigned-byte 8) (*)) @@ -898,14 +932,12 @@ (declare (type sb!assem:segment segment) (type fasl-output fasl-output)) (let* ((stream (fasl-output-stream fasl-output)) - (nwritten (write-segment-contents segment stream))) + (n-written (write-segment-contents segment stream))) ;; In CMU CL there was no enforced connection between the CODE-LENGTH ;; argument and the number of bytes actually written. I added this ;; assertion while trying to debug portable genesis. -- WHN 19990902 - (unless (= code-length nwritten) - (error "internal error, code-length=~D, nwritten=~D" - code-length - nwritten))) + (unless (= code-length n-written) + (bug "code-length=~W, n-written=~W" code-length n-written))) (values)) ;;; Dump all the fixups. Currently there are three flavors of fixup: @@ -995,15 +1027,13 @@ ;; Dump the offset of the trace table. (dump-object code-length fasl-output) ;; FIXME: As long as we don't have GENGC, the trace table is - ;; hardwired to be empty. So we might be able to get rid of - ;; trace tables? However, we should probably wait for the first - ;; port to a system where CMU CL uses GENGC to see whether GENGC - ;; is really gone. (I.e. maybe other non-X86 ports will want to - ;; use it, just as in CMU CL.) - - ;; Dump the constants, noting any :entries that have to be fixed up. - (do ((i sb!vm:code-constants-offset (1+ i))) - ((>= i header-length)) + ;; hardwired to be empty. And SBCL doesn't have GENGC (and as + ;; far as I know no modern CMU CL does either -- WHN + ;; 2001-10-05). So might we be able to get rid of trace tables? + + ;; Dump the constants, noting any :ENTRY constants that have to + ;; be patched. + (loop for i from sb!vm:code-constants-offset below header-length do (let ((entry (aref constants i))) (etypecase entry (constant @@ -1015,6 +1045,7 @@ (handle (gethash info (fasl-output-entry-table fasl-output)))) + (declare (type sb!c::entry-info info)) (cond (handle (dump-push handle fasl-output)) @@ -1058,6 +1089,7 @@ (dump-fixups fixups fasl-output) (dump-fop 'fop-sanctify-for-execution fasl-output) + (let ((handle (dump-pop fasl-output))) (dolist (patch (patches)) (push (cons handle (cdr patch)) @@ -1067,9 +1099,7 @@ (defun dump-assembler-routines (code-segment length fixups routines file) (dump-fop 'fop-assembler-code file) - (dump-unsigned-32 #!+gengc (ceiling length 4) - #!-gengc length - file) + (dump-unsigned-32 length file) (write-segment-contents code-segment (fasl-output-stream file)) (dolist (routine routines) (dump-fop 'fop-normal-load file) @@ -1082,7 +1112,7 @@ (dump-fop 'fop-sanctify-for-execution file) (dump-pop file)) -;;; Dump a function-entry data structure corresponding to ENTRY to +;;; Dump a function entry data structure corresponding to ENTRY to ;;; FILE. CODE-HANDLE is the table offset of the code object for the ;;; component. (defun dump-one-entry (entry code-handle file) @@ -1093,7 +1123,7 @@ (dump-object name file) (dump-object (sb!c::entry-info-arguments entry) file) (dump-object (sb!c::entry-info-type entry) file) - (dump-fop 'fop-function-entry file) + (dump-fop 'fop-fun-entry file) (dump-unsigned-32 (label-position (sb!c::entry-info-offset entry)) file) (dump-pop file))) @@ -1139,12 +1169,7 @@ (dolist (entry (sb!c::ir2-component-entries 2comp)) (let ((entry-handle (dump-one-entry entry code-handle file))) (setf (gethash entry (fasl-output-entry-table file)) entry-handle) - (let ((old (gethash entry (fasl-output-patch-table file)))) - ;; FIXME: All this code is shared with - ;; FASL-DUMP-BYTE-COMPONENT, and should probably be gathered - ;; up into a named function (DUMP-PATCHES?) called from both - ;; functions. (when old (dolist (patch old) (dump-alter-code-object (car patch) @@ -1154,123 +1179,6 @@ (remhash entry (fasl-output-patch-table file))))))) (values)) -(defun dump-byte-code-object (segment code-length constants file) - (declare (type sb!assem:segment segment) - (type index code-length) - (type vector constants) - (type fasl-output file)) - (collect ((entry-patches)) - - ;; Dump the debug info. - #!+gengc - (let ((info (sb!c::make-debug-info - :name (sb!c::component-name *component-being-compiled*))) - (*dump-only-valid-structures* nil)) - (dump-object info file) - (let ((info-handle (dump-pop file))) - (dump-push info-handle file) - (push info-handle (fasl-output-debug-info file)))) - - ;; The "trace table" is initialized by loader to hold a list of - ;; all byte functions in this code object (for debug info.) - (dump-object nil file) - - ;; Dump the constants. - ;; - ;; FIXME: There's a family resemblance between this and the - ;; corresponding code in DUMP-CODE-OBJECT. Could some be shared? - (dotimes (i (length constants)) - (let ((entry (aref constants i))) - (etypecase entry - (constant - (dump-object (sb!c::constant-value entry) file)) - (null - (dump-fop 'fop-misc-trap file)) - (list - (ecase (car entry) - (:entry - (let* ((info (sb!c::leaf-info (cdr entry))) - (handle (gethash info - (fasl-output-entry-table file)))) - (cond - (handle - (dump-push handle file)) - (t - (entry-patches (cons info - (+ i sb!vm:code-constants-offset))) - (dump-fop 'fop-misc-trap file))))) - (:load-time-value - (dump-push (cdr entry) file)) - (:fdefinition - (dump-object (cdr entry) file) - (dump-fop 'fop-fdefinition file)) - (:type-predicate - (dump-object 'load-type-predicate file) - (let ((*unparse-function-type-simplify* t)) - (dump-object (type-specifier (cdr entry)) file)) - (dump-fop 'fop-funcall file) - (dump-byte 1 file))))))) - - ;; Dump the debug info. - #!-gengc - (let ((info (sb!c::make-debug-info :name - (sb!c::component-name - *component-being-compiled*))) - (*dump-only-valid-structures* nil)) - (dump-object info file) - (let ((info-handle (dump-pop file))) - (dump-push info-handle file) - (push info-handle (fasl-output-debug-info file)))) - - (let ((num-consts #!+gengc (+ (length constants) 2) - #!-gengc (1+ (length constants))) - (code-length #!+gengc (ceiling code-length 4) - #!-gengc code-length)) - (cond ((and (< num-consts #x100) (< code-length #x10000)) - (dump-fop 'fop-small-code file) - (dump-byte num-consts file) - (dump-integer-as-n-bytes code-length 2 file)) - (t - (dump-fop 'fop-code file) - (dump-unsigned-32 num-consts file) - (dump-unsigned-32 code-length file)))) - (dump-segment segment code-length file) - (let ((code-handle (dump-pop file)) - (patch-table (fasl-output-patch-table file))) - (dolist (patch (entry-patches)) - (push (cons code-handle (cdr patch)) - (gethash (car patch) patch-table))) - code-handle))) - -;;; Dump a byte-component. This is similar to FASL-DUMP-COMPONENT, but -;;; different. -(defun fasl-dump-byte-component (segment length constants xeps file) - (declare (type sb!assem:segment segment) - (type index length) - (type vector constants) - (type list xeps) - (type fasl-output file)) - - (let ((code-handle (dump-byte-code-object segment length constants file))) - (dolist (noise xeps) - (let* ((lambda (car noise)) - (info (sb!c::lambda-info lambda)) - (xep (cdr noise))) - (dump-byte-function xep code-handle file) - (let* ((entry-handle (dump-pop file)) - (patch-table (fasl-output-patch-table file)) - (old (gethash info patch-table))) - (setf (gethash info (fasl-output-entry-table file)) - entry-handle) - (when old - (dolist (patch old) - (dump-alter-code-object (car patch) - (cdr patch) - entry-handle - file)) - (remhash info patch-table)))))) - (values)) - (defun dump-push-previously-dumped-fun (fun fasl-output) (declare (type sb!c::clambda fun)) (let ((handle (gethash (sb!c::leaf-info fun) @@ -1279,9 +1187,9 @@ (dump-push handle fasl-output)) (values)) -;;; Dump a FOP-FUNCALL to call an already-dumped top-level lambda at +;;; Dump a FOP-FUNCALL to call an already-dumped top level lambda at ;;; load time. -(defun fasl-dump-top-level-lambda-call (fun fasl-output) +(defun fasl-dump-toplevel-lambda-call (fun fasl-output) (declare (type sb!c::clambda fun)) (dump-push-previously-dumped-fun fun fasl-output) (dump-fop 'fop-funcall-for-effect fasl-output) @@ -1294,7 +1202,7 @@ #+sb-xc-host (defun fasl-dump-cold-fset (fun-name fun-dump-handle fasl-output) (declare (type fixnum fun-dump-handle)) - (aver (legal-function-name-p fun-name)) + (aver (legal-fun-name-p fun-name)) (dump-non-immediate-object fun-name fasl-output) (dump-push fun-dump-handle fasl-output) (dump-fop 'fop-fset fasl-output)