;;;; provided with absolutely no warranty. See the COPYING and CREDITS
;;;; files for more information.
-(in-package "SB!IMPL")
-\f
-;;;; variables
-
-;;; FIXME: It's awkward having LOAD stuff in SB!IMPL and dump stuff in
-;;; SB!C. Among other things, it makes it hard to figure out where
-;;; *FASL-HEADER-STRING-START-STRING* and
-;;; *FASL-HEADER-STRING-STOP-CHAR-CODE* should go. Perhaps we should
-;;; make a package called SB-DUMP or SB-LD which includes all
-;;; knowledge of both loading and dumping.
-
-;;; This value is used to identify fasl files. Even though this is not
-;;; declared as a constant (because ANSI Common Lisp has no facility
-;;; for declaring values which are constant under EQUAL but not EQL),
-;;; obviously you shouldn't mess with it lightly. If you do set a new
-;;; value for some reason, keep these things in mind:
-;;; * To avoid confusion with the similar but incompatible CMU CL
-;;; fasl file format, the value should not be "FASL FILE", which
-;;; is what CMU CL used for the same purpose.
-;;; * Since its presence at the head of a file is used by LOAD to
-;;; decide whether a file is to be fasloaded or sloloaded, the value
-;;; should be something which can't legally appear at the head of a
-;;; Lisp source file.
-;;; * The value should not contain any line-terminating characters,
-;;; because they're hard to express portably and because the LOAD
-;;; code might reasonably use READ-LINE to get the value to compare
-;;; against.
-(defparameter sb!c:*fasl-header-string-start-string* "# FASL"
- #!+sb-doc
- "a string which appears at the start of a fasl file header")
-
-(defparameter sb!c:*fasl-header-string-stop-char-code* 255
- #!+sb-doc
- "the code for a character which terminates a fasl file header")
-
-(defvar *load-depth* 0
- #!+sb-doc
- "the current number of recursive loads")
-(declaim (type index *load-depth*))
-
-;;; the FASL file we're reading from
-(defvar *fasl-file*)
-(declaim (type lisp-stream *fasl-file*))
-
-(defvar *load-print* nil
- #!+sb-doc
- "the default for the :PRINT argument to LOAD")
-(defvar *load-verbose* nil
- ;; Note that CMU CL's default for this was T, and ANSI says it's
- ;; implementation-dependent. We choose NIL on the theory that it's
- ;; a nicer default behavior for Unix programs.
- #!+sb-doc
- "the default for the :VERBOSE argument to LOAD")
+(in-package "SB!FASL")
\f
+;;;; There looks to be an exciting amount of state being modified
+;;;; here: certainly enough that I (dan, 2003.1.22) don't want to mess
+;;;; around deciding how to thread-safetify it. So we use a Big Lock.
+;;;; Because this code is mutually recursive with the compiler, we use
+;;;; the *big-compiler-lock*
+
;;;; miscellaneous load utilities
;;; Output the current number of semicolons after a fresh-line.
(write-string semicolons))
(write-char #\space)))
-;;; If VERBOSE, output (to *STANDARD-OUTPUT*) a message about how we're
-;;; loading from STREAM-WE-ARE-LOADING-FROM.
-;;; FIXME: non-mnemonic name
-(defun do-load-verbose (stream-we-are-loading-from verbose)
+;;; If VERBOSE, output (to *STANDARD-OUTPUT*) a message about how
+;;; we're loading from STREAM-WE-ARE-LOADING-FROM.
+(defun maybe-announce-load (stream-we-are-loading-from verbose)
(when verbose
(load-fresh-line)
(let ((name #-sb-xc-host (file-name stream-we-are-loading-from)
#!-sb-fluid (declaim (inline read-byte))
-;;; Expands into code to read an N-byte unsigned integer using
-;;; fast-read-byte.
+;;; This expands into code to read an N-byte unsigned integer using
+;;; FAST-READ-BYTE.
(defmacro fast-read-u-integer (n)
(declare (optimize (speed 0)))
(do ((res '(fast-read-byte)
(cnt 1 (1+ cnt)))
((>= cnt n) res)))
-;;; Like Fast-Read-U-Integer, but the size may be determined at run time.
-(defmacro fast-read-variable-u-integer (n)
+;;; like FAST-READ-U-INTEGER, but the size may be determined at run time
+(defmacro fast-read-var-u-integer (n)
(let ((n-pos (gensym))
(n-res (gensym))
(n-cnt (gensym)))
(cnt 1 (1+ cnt)))
((>= cnt n) res))))
-;;; Read an N-byte unsigned integer from the *FASL-FILE*
+;;; Read an N-byte unsigned integer from the *FASL-INPUT-STREAM*
(defmacro read-arg (n)
(declare (optimize (speed 0)))
(if (= n 1)
- `(the (unsigned-byte 8) (read-byte *fasl-file*))
- `(prepare-for-fast-read-byte *fasl-file*
+ `(the (unsigned-byte 8) (read-byte *fasl-input-stream*))
+ `(prepare-for-fast-read-byte *fasl-input-stream*
(prog1
(fast-read-u-integer ,n)
(done-with-fast-read-byte)))))
+
;;; FIXME: This deserves a more descriptive name, and should probably
;;; be implemented as an ordinary function, not a macro.
;;;
;;; offset. We may need to have several, since LOAD can be called
;;; recursively.
-(defvar *free-fop-tables* (list (make-array 1000))
- #!+sb-doc
- "List of free fop tables for the fasloader.")
+;;; a list of free fop tables for the fasloader
+;;;
+;;; FIXME: Is it really a win to have this permanently bound?
+;;; Couldn't we just bind it on entry to LOAD-AS-FASL?
+(defvar *free-fop-tables* (list (make-array 1000)))
;;; the current fop table
(defvar *current-fop-table*)
\f
;;;; the fop stack
-;;; (This is in a simple-vector, but it grows down, since it is
+;;; (This is in a SIMPLE-VECTOR, but it grows down, since it is
;;; somewhat cheaper to test for overflow that way.)
-(defvar *fop-stack* (make-array 100)
- #!+sb-doc
- "The fop stack (we only need one!).")
+(defvar *fop-stack* (make-array 100))
(declaim (simple-vector *fop-stack*))
-;;; the index of the most recently pushed item on the fop-stack
+;;; the index of the most recently pushed item on the fop stack
(defvar *fop-stack-pointer* 100)
;;; the current index into the fop stack when we last recursively
(setq *fop-stack-pointer* size)
(setq *fop-stack* new-stack)))
-;;; Cache information about the fop-stack in local variables. Define a
+;;; Cache information about the fop stack in local variables. Define a
;;; local macro to pop from the stack. Push the result of evaluation
;;; if specified.
(defmacro with-fop-stack (pushp &body forms)
- (check-type pushp (member nil t :nope))
+ (aver (member pushp '(nil t :nope)))
(let ((n-stack (gensym))
(n-index (gensym))
(n-res (gensym)))
(progn ,@forms)
(setq *fop-stack-pointer* ,n-index)))))))
\f
-;;;; FASLOAD
+;;;; Conditions signalled on invalid fasls (wrong fasl version, etc),
+;;;; so that user code (esp. ASDF) can reasonably handle attempts to
+;;;; load such fasls by recompiling them, etc. For simplicity's sake
+;;;; make only condition INVALID-FASL part of the public interface,
+;;;; and keep the guts internal.
+
+(define-condition invalid-fasl (error)
+ ((stream :reader invalid-fasl-stream :initarg :stream)
+ (expected :reader invalid-fasl-expected :initarg :expected))
+ (:report
+ (lambda (condition stream)
+ (format stream "~S is an invalid fasl file."
+ (invalid-fasl-stream condition)))))
+
+(define-condition invalid-fasl-header (invalid-fasl)
+ ((byte :reader invalid-fasl-byte :initarg :byte)
+ (byte-nr :reader invalid-fasl-byte-nr :initarg :byte-nr))
+ (:report
+ (lambda (condition stream)
+ (format stream "~@<~S contains an illegal byte in the FASL header at ~
+ position ~A: Expected ~A, got ~A.~:@>"
+ (invalid-fasl-stream condition)
+ (invalid-fasl-byte-nr condition)
+ (invalid-fasl-byte condition)
+ (invalid-fasl-expected condition)))))
+
+(define-condition invalid-fasl-version (invalid-fasl)
+ ((variant :reader invalid-fasl-variant :initarg :variant)
+ (version :reader invalid-fasl-version :initarg :version))
+ (:report
+ (lambda (condition stream)
+ (format stream "~@<~S is in ~A fasl file format version ~W, ~
+ but this version of SBCL uses format version ~W.~:@>"
+ (invalid-fasl-stream condition)
+ (invalid-fasl-variant condition)
+ (invalid-fasl-version condition)
+ (invalid-fasl-expected condition)))))
+
+(define-condition invalid-fasl-implementation (invalid-fasl)
+ ((implementation :reader invalid-fasl-implementation
+ :initarg :implementation))
+ (:report
+ (lambda (condition stream)
+ (format stream "~S was compiled for implementation ~A, but this is a ~A."
+ (invalid-fasl-stream condition)
+ (invalid-fasl-implementation condition)
+ (invalid-fasl-expected condition)))))
+
+(define-condition invalid-fasl-features (invalid-fasl)
+ ((potential-features :reader invalid-fasl-potential-features
+ :initarg :potential-features)
+ (features :reader invalid-fasl-features :initarg :features))
+ (:report
+ (lambda (condition stream)
+ (format stream "~@<incompatible ~S in fasl file ~S: ~2I~_~
+ Of features affecting binary compatibility, ~4I~_~S~2I~_~
+ the fasl has ~4I~_~A,~2I~_~
+ while the runtime expects ~4I~_~A.~:>"
+ '*features*
+ (invalid-fasl-stream condition)
+ (invalid-fasl-potential-features condition)
+ (invalid-fasl-features condition)
+ (invalid-fasl-expected condition)))))
+
+;;;; LOAD-AS-FASL
;;;;
-;;;; Note: FASLOAD is used not only by LOAD, but also (after suitable
-;;;; modification of the fop table) in genesis. Therefore, it's needed
-;;;; not only in the target Lisp, but also in the cross-compilation
-;;;; host.
+;;;; Note: LOAD-AS-FASL is used not only by LOAD, but also (with
+;;;; suitable modification of the fop table) in GENESIS. Therefore,
+;;;; it's needed not only in the target Lisp, but also in the
+;;;; cross-compilation host.
;;; a helper function for LOAD-FASL-GROUP
;;;
(let ((byte (read-byte stream nil)))
(when byte
- ;; Read the string part of the fasl header, or die.
- (let* ((fhsss sb!c:*fasl-header-string-start-string*)
+ ;; Read and validate constant string prefix in fasl header.
+ (let* ((fhsss *fasl-header-string-start-string*)
(fhsss-length (length fhsss)))
(unless (= byte (char-code (schar fhsss 0)))
- (error "illegal fasl file header"))
+ (error 'invalid-fasl-header
+ :stream stream
+ :first-byte-p t
+ :byte byte
+ :expected (char-code (schar fhsss 0))))
(do ((byte (read-byte stream) (read-byte stream))
(count 1 (1+ count)))
- ((= byte sb!c:*fasl-header-string-stop-char-code*)
+ ((= byte +fasl-header-string-stop-char-code+)
t)
(declare (fixnum byte count))
(when (and (< count fhsss-length)
(not (eql byte (char-code (schar fhsss count)))))
- (error "illegal fasl file header"))))
-
- ;; Read and validate implementation and version, or die.
- (let* ((implementation-length (read-arg 4))
- (implementation-string (make-string implementation-length))
- (ignore (read-string-as-bytes stream implementation-string))
- (implementation (keywordicate implementation-string))
- ;; FIXME: The logic above to read a keyword from the fasl file
- ;; could probably be shared with the read-a-keyword fop.
- (version (read-arg 4)))
- (declare (ignore ignore))
- (flet ((check-version (variant possible-implementation needed-version)
- (when (string= possible-implementation implementation)
- (unless (= version needed-version)
- (error "~@<~S was compiled for ~A fasl file format ~
- version ~D, but we need version ~D.~:@>"
- stream
- variant
- version
- needed-version))
- t)))
- (or (check-version "native code"
- #.sb!c:*backend-fasl-file-implementation*
- #.sb!c:*backend-fasl-file-version*)
- (check-version "byte code"
- #.(sb!c:backend-byte-fasl-file-implementation)
- sb!c:byte-fasl-file-version)
- (error "~S was compiled for implementation ~A, but this is a ~A."
- stream
- implementation
- sb!c:*backend-fasl-file-implementation*)))))))
+ (error 'invalid-fasl-header
+ :stream stream
+ :byte-nr count
+ :byte byte
+ :expected (char-code (schar fhsss count))))))
+
+ ;; Read and validate version-specific compatibility stuff.
+ (flet ((string-from-stream ()
+ (let* ((length (read-arg 4))
+ (result (make-string length)))
+ (read-string-as-bytes stream result)
+ result)))
+ ;; Read and validate implementation and version.
+ (let* ((implementation (keywordicate (string-from-stream)))
+ ;; FIXME: The logic above to read a keyword from the fasl file
+ ;; could probably be shared with the read-a-keyword fop.
+ (version (read-arg 4)))
+ (flet ((check-version (variant
+ possible-implementation
+ needed-version)
+ (when (string= possible-implementation implementation)
+ (or (= version needed-version)
+ (error 'invalid-fasl-version
+ ;; :error :wrong-version
+ :stream stream
+ :variant variant
+ :version version
+ :expected needed-version)))))
+ (or (check-version "native code"
+ +backend-fasl-file-implementation+
+ +fasl-file-version+)
+ (error 'invalid-fasl-implementation
+ :stream stream
+ :implementation implementation
+ :expected +backend-fasl-file-implementation+))))
+ ;; Read and validate *FEATURES* which affect binary compatibility.
+ (let ((faff-in-this-file (string-from-stream)))
+ (unless (string= faff-in-this-file *features-affecting-fasl-format*)
+ (error 'invalid-fasl-features
+ :stream stream
+ :potential-features *features-potentially-affecting-fasl-format*
+ :expected *features-affecting-fasl-format*
+ :features faff-in-this-file)))
+ ;; success
+ t))))
;; Setting this variable gives you a trace of fops as they are loaded and
;; executed.
#!+sb-show
(defvar *show-fops-p* nil)
-;;; a helper function for FASLOAD
+;;; a helper function for LOAD-AS-FASL
;;;
-;;; Return true if we successfully load a group from the stream, or NIL if EOF
-;;; was encountered while trying to read from the stream. Dispatch to the right
-;;; function for each fop. Special-case FOP-BYTE-PUSH since it is real common.
+;;; Return true if we successfully load a group from the stream, or
+;;; NIL if EOF was encountered while trying to read from the stream.
+;;; Dispatch to the right function for each fop. Special-case
+;;; FOP-BYTE-PUSH since it is real common.
(defun load-fasl-group (stream)
(when (check-fasl-header stream)
(catch 'fasl-group-end
(svref *fop-names* byte)
byte
(1- (file-position stream))
- (svref *fop-functions* byte))))
+ (svref *fop-funs* byte))))
;; Actually execute the fop.
(if (eql byte 3)
(setq *fop-stack-pointer* index)
(setf (svref *fop-stack* index)
(svref *current-fop-table* (read-byte stream))))
- (funcall (the function (svref *fop-functions* byte))))))))))
+ (funcall (the function (svref *fop-funs* byte))))))))))
-(defun fasload (stream verbose print)
+(defun load-as-fasl (stream verbose print)
;; KLUDGE: ANSI says it's good to do something with the :PRINT
;; argument to LOAD when we're fasloading a file, but currently we
;; don't. (CMU CL did, but implemented it in a non-ANSI way, and I
(declare (ignore print))
(when (zerop (file-length stream))
(error "attempt to load an empty FASL file:~% ~S" (namestring stream)))
- (do-load-verbose stream verbose)
- (let* ((*fasl-file* stream)
- (*current-fop-table* (or (pop *free-fop-tables*) (make-array 1000)))
- (*current-fop-table-size* (length *current-fop-table*))
- (*fop-stack-pointer-on-entry* *fop-stack-pointer*))
- (unwind-protect
- ;; FIXME: This should probably become
- ;; (LOOP WHILE (LOAD-FASL-GROUP-STREAM))
- ;; but as a LOOP newbie I don't want to do that until I can
- ;; test it.
- (do ((loaded-group (load-fasl-group stream) (load-fasl-group stream)))
- ((not loaded-group)))
- (setq *fop-stack-pointer* *fop-stack-pointer-on-entry*)
- (push *current-fop-table* *free-fop-tables*)
- ;; NIL out the stack and table, so that we don't hold onto garbage.
- ;;
- ;; FIXME: Couldn't we just get rid of the free fop table pool so
- ;; that some of this NILing out would go away?
- (fill *fop-stack* nil :end *fop-stack-pointer-on-entry*)
- (fill *current-fop-table* nil)))
+ (maybe-announce-load stream verbose)
+ (sb!thread:with-recursive-lock (sb!c::*big-compiler-lock*)
+ (let* ((*fasl-input-stream* stream)
+ (*current-fop-table* (or (pop *free-fop-tables*) (make-array 1000)))
+ (*current-fop-table-size* (length *current-fop-table*))
+ (*fop-stack-pointer-on-entry* *fop-stack-pointer*))
+ (unwind-protect
+ (loop while (load-fasl-group stream))
+ (setq *fop-stack-pointer* *fop-stack-pointer-on-entry*)
+ (push *current-fop-table* *free-fop-tables*)
+ ;; NIL out the stack and table, so that we don't hold onto garbage.
+ ;;
+ ;; FIXME: Couldn't we just get rid of the free fop table pool so
+ ;; that some of this NILing out would go away?
+ (fill *fop-stack* nil :end *fop-stack-pointer-on-entry*)
+ (fill *current-fop-table* nil))))
t)
+
+;;; This is used in in target-load and also genesis, using
+;;; *COLD-FOREIGN-SYMBOL-TABLE*. All the speculative prefix-adding
+;;; code for foreign symbol lookup should be here.
+(defun find-foreign-symbol-in-table (name table)
+ (let ((prefixes
+ #!+(or osf1 sunos linux freebsd darwin) #("" "ldso_stub__")
+ #!+openbsd #("")))
+ (declare (notinline some)) ; to suppress bug 117 bogowarning
+ (some (lambda (prefix)
+ (gethash (concatenate 'string prefix name)
+ table
+ nil))
+ prefixes)))
\f
;;;; stuff for debugging/tuning by collecting statistics on FOPs (?)
(let ((n (svref ,vec i)))
(push (cons (svref *fop-names* i) n) ,lvar)
(incf ,tvar n)))
- (setq ,lvar (subseq (sort ,lvar #'(lambda (x y)
- (> (cdr x) (cdr y))))
+ (setq ,lvar (subseq (sort ,lvar (lambda (x y)
+ (> (cdr x) (cdr y))))
0 10)))))
(breakdown counts total-count *fop-counts*)
projects / sbcl.git / blobdiff