X-Git-Url: http://repo.macrolet.net/gitweb/?a=blobdiff_plain;f=src%2Fcode%2Ftarget-load.lisp;h=ed607ff6c99947a8ef92e7e06a3c16633b223d98;hb=a01e7ac2e8a9f3afae8f759381a0829fceb5bfde;hp=7810634cf2f5d8e571763e0b9b6192c7497973db;hpb=bee53328c93be3433477821131ab805557476c8b;p=sbcl.git diff --git a/src/code/target-load.lisp b/src/code/target-load.lisp index 7810634..ed607ff 100644 --- a/src/code/target-load.lisp +++ b/src/code/target-load.lisp @@ -27,196 +27,217 @@ ;;;; LOAD-AS-SOURCE -;;; Load a text file. +;;; Load a text file. (Note that load-as-fasl is in another file.) (defun load-as-source (stream verbose print) - (do-load-verbose stream verbose) + (maybe-announce-load stream verbose) (do ((sexpr (read stream nil *eof-object*) - (read stream nil *eof-object*))) + (read stream nil *eof-object*))) ((eq sexpr *eof-object*) t) (if print - (let ((results (multiple-value-list (eval sexpr)))) - (load-fresh-line) - (format t "~{~S~^, ~}~%" results)) + (let ((results (multiple-value-list (eval sexpr)))) + (load-fresh-line) + (format t "~{~S~^, ~}~%" results)) (eval sexpr)))) ;;;; LOAD itself -;;; a helper function for LOAD: Load the stuff in a file when we have the name. -(defun internal-load (pathname truename if-does-not-exist verbose print - &optional contents) - (declare (type (member nil :error) if-does-not-exist)) - (unless truename - (if if-does-not-exist - (error 'simple-file-error - :pathname pathname - :format-control "~S does not exist." - :format-arguments (list (namestring pathname))) - (return-from internal-load nil))) +(define-condition fasl-header-missing (invalid-fasl) + ((fhsss :reader invalid-fasl-fhsss :initarg :fhsss)) + (:report + (lambda (condition stream) + (format stream "~@" + (invalid-fasl-stream condition) + (invalid-fasl-expected condition) + (invalid-fasl-fhsss condition))))) - (let ((*load-truename* truename) - (*load-pathname* pathname)) - (case contents - (:source - (with-open-file (stream truename - :direction :input - :if-does-not-exist if-does-not-exist) - (load-as-source stream verbose print))) - (:binary - (with-open-file (stream truename - :direction :input - :if-does-not-exist if-does-not-exist - :element-type '(unsigned-byte 8)) - (load-as-fasl stream verbose print))) - (t - (let ((first-line (with-open-file (stream truename :direction :input) - (read-line stream nil))) - (fhsss *fasl-header-string-start-string*)) - (cond - ((and first-line - (>= (length (the simple-string first-line)) - (length fhsss)) - (string= first-line fhsss :end1 (length fhsss))) - (internal-load pathname truename if-does-not-exist verbose print - :binary)) - (t - (when (string= (pathname-type truename) *fasl-file-type*) - (error "File has a fasl file type, but no fasl file header:~% ~S" - (namestring truename))) - (internal-load pathname truename if-does-not-exist verbose print - :source)))))))) +;; Pretty well any way of doing LOAD will expose race conditions: for +;; example, a file might get deleted or renamed after we open it but +;; before we find its truename. It seems useful to say that +;; detectible ways the file system can fail to be static are good +;; enough reason to stop loading, but to stop in a way that +;; distinguishes errors that occur mid-way through LOAD from the +;; initial failure to OPEN the file, so that handlers can try do +;; defaulting only when the file didn't exist at the start of LOAD, +;; while allowing race conditions to get through. +(define-condition load-race-condition (error) + ((pathname :reader load-race-condition-pathname :initarg :pathname)) + (:report (lambda (condition stream) + (format stream "~@" + (load-race-condition-pathname condition))))) -;;; a helper function for INTERNAL-LOAD-DEFAULT-TYPE: Try the default -;;; file type TYPE and return (VALUES PATHNAME TRUENAME) for a match, -;;; or (VALUES PATHNAME NIL) if the file doesn't exist. -;;; -;;; This is analogous to CMU CL's TRY-DEFAULT-TYPES, but we only try a -;;; single type. By avoiding CMU CL's generality here, we avoid having -;;; to worry about some annoying ambiguities. (E.g. what if the -;;; possible types are ".lisp" and ".cl", and both "foo.lisp" and -;;; "foo.cl" exist?) -(defun try-default-type (pathname type) - (let ((pn (make-pathname :type type :defaults pathname))) - (values pn (probe-file pn)))) +(defmacro resignal-race-condition (&body body) + `(handler-case (progn ,@body) + (file-error (error) + (error 'load-race-condition :pathname (file-error-pathname error))))) -;;; a helper function for LOAD: Handle the case of INTERNAL-LOAD where -;;; the file does not exist. -(defun internal-load-default-type (pathname if-does-not-exist verbose print) - (declare (type (member nil :error) if-does-not-exist)) - (multiple-value-bind (src-pn src-tn) - (try-default-type pathname *load-source-default-type*) - (multiple-value-bind (obj-pn obj-tn) - (try-default-type pathname *fasl-file-type*) - (cond - ((and obj-tn - src-tn - (> (file-write-date src-tn) (file-write-date obj-tn))) - (restart-case - (error "The object file ~A is~@ - older than the presumed source:~% ~A." - (namestring obj-tn) - (namestring src-tn)) - ;; FIXME: In CMU CL one of these was a CONTINUE case. - ;; There's not one now. I don't remember how restart-case - ;; works very well, make sure that it doesn't do anything - ;; weird when we don't specify the CONTINUE case. - (source () :report "load source file" - (internal-load src-pn src-tn if-does-not-exist verbose print - :source)) - (object () :report "load object file" - (internal-load src-pn obj-tn if-does-not-exist verbose print - :binary)))) - (obj-tn - (internal-load obj-pn obj-tn if-does-not-exist verbose print :binary)) - (src-pn - (internal-load src-pn src-tn if-does-not-exist verbose print :source)) - (t - (internal-load pathname nil if-does-not-exist verbose print nil)))))) +;;; The following comment preceded the pre 1.0.12.36 definition of +;;; LOAD; it may no longer be accurate: -;;; This function mainly sets up special bindings and then calls -;;; sub-functions. We conditionally bind the switches with PROGV so -;;; that people can set them in their init files and have the values -;;; take effect. If the compiler is loaded, we make the -;;; compiler-policy local to LOAD by binding it to itself. -;;; -;;; FIXME: Daniel Barlow's ilsb.tar ILISP-for-SBCL patches contain an -;;; implementation of "DEFUN SOURCE-FILE" which claims, in a comment, that CMU -;;; CL does not correctly record source file information when LOADing a -;;; non-compiled file. Check whether this bug exists in SBCL and fix it if so. -(defun load (filespec - &key - (verbose *load-verbose*) - (print *load-print*) - (if-does-not-exist t) - (external-format :default)) +;; FIXME: Daniel Barlow's ilsb.tar ILISP-for-SBCL patches contain an +;; implementation of "DEFUN SOURCE-FILE" which claims, in a comment, +;; that CMU CL does not correctly record source file information when +;; LOADing a non-compiled file. Check whether this bug exists in SBCL +;; and fix it if so. + +;;; This is our real LOAD. The LOAD below is just a wrapper that does +;;; some defaulting in case the user asks us to load a file that +;;; doesn't exist at the time we start. +(defun %load (pathspec &key (verbose *load-verbose*) (print *load-print*) + (if-does-not-exist t) (external-format :default)) + (when (streamp pathspec) + (let* ( ;; Bindings required by ANSI. + (*readtable* *readtable*) + (*package* (sane-package)) + ;; FIXME: we should probably document the circumstances + ;; where *LOAD-PATHNAME* and *LOAD-TRUENAME* aren't + ;; pathnames during LOAD. ANSI makes no exceptions here. + (*load-pathname* (handler-case (pathname pathspec) + ;; FIXME: it should probably be a type + ;; error to try to get a pathname for a + ;; stream that doesn't have one, but I + ;; don't know if we guarantee that. + (error () nil))) + (*load-truename* (when *load-pathname* + (handler-case (truename *load-pathname*) + (file-error () nil)))) + ;; Bindings used internally. + (*load-depth* (1+ *load-depth*)) + ;; KLUDGE: I can't find in the ANSI spec where it says + ;; that DECLAIM/PROCLAIM of optimization policy should + ;; have file scope. CMU CL did this, and it seems + ;; reasonable, but it might not be right; after all, + ;; things like (PROCLAIM '(TYPE ..)) don't have file + ;; scope, and I can't find anything under PROCLAIM or + ;; COMPILE-FILE or LOAD or OPTIMIZE which justifies this + ;; behavior. Hmm. -- WHN 2001-04-06 + (sb!c::*policy* sb!c::*policy*)) + (return-from %load + (if (equal (stream-element-type pathspec) '(unsigned-byte 8)) + (load-as-fasl pathspec verbose print) + (load-as-source pathspec verbose print))))) + ;; If we're here, PATHSPEC isn't a stream, so must be some other + ;; kind of pathname designator. + (with-open-file (stream pathspec + :element-type '(unsigned-byte 8) + :if-does-not-exist + (if if-does-not-exist :error nil)) + (unless stream + (return-from %load nil)) + (let* ((header-line (make-array + (length *fasl-header-string-start-string*) + :element-type '(unsigned-byte 8)))) + (read-sequence header-line stream) + (if (mismatch header-line *fasl-header-string-start-string* + :test #'(lambda (code char) (= code (char-code char)))) + (let ((truename (resignal-race-condition (probe-file stream)))) + (when (and truename + (string= (pathname-type truename) *fasl-file-type*)) + (error 'fasl-header-missing + :stream (namestring truename) + :fhsss header-line + :expected *fasl-header-string-start-string*))) + (progn + (file-position stream :start) + (return-from %load + (%load stream :verbose verbose :print print)))))) + ;; Because we're just opening for input, we don't need + ;; WITH-OPEN-FILE's abort handling semantics, and we want to say + ;; it's an error for PATHSPEC to have existed before but not now, so + ;; WITH-OPEN-STREAM it is. + (with-open-stream (stream (resignal-race-condition + (open pathspec + :external-format external-format))) + (%load stream :verbose verbose :print print))) + +;; Given a simple %LOAD like the above, one can implement any +;; particular defaulting strategy with a wrapper like this one: +(defun load (pathspec &key (verbose *load-verbose*) (print *load-print*) + (if-does-not-exist :error) (external-format :default)) #!+sb-doc "Load the file given by FILESPEC into the Lisp environment, returning T on success." - (unless (eq external-format :default) - (error "Non-:DEFAULT EXTERNAL-FORMAT values are not supported.")) + (handler-bind ((file-error + #'(lambda (error) + ;; This handler will run if %LOAD failed to OPEN + ;; the file to look for a fasl header. + (let ((pathname (file-error-pathname error))) + ;; As PROBE-FILE returned NIL, the file + ;; doesn't exist. If the filename we tried to + ;; open lacked a type, try loading a filename + ;; determined by our defaulting. + (when (null (handler-case (probe-file pathname) + (file-error (error) error))) + (when (null (pathname-type pathname)) + (let ((default (probe-load-defaults pathname))) + (when default + (return-from load + (resignal-race-condition + (%load default + :verbose verbose + :print print + :external-format + external-format + :if-does-not-exist + if-does-not-exist)))))))) + ;; If we're here, one of three things happened: + ;; (1) %LOAD errored and PROBE-FILE succeeded, + ;; in which case the file must be a bad symlink, + ;; unreadable, or it was created between %LOAD + ;; and PROBE-FILE; (2) %LOAD errored and + ;; PROBE-FILE errored, and so things are amiss + ;; in the file system (albeit possibly + ;; differently now than when OPEN errored); (3) + ;; our defaulting did not find a file. In any + ;; of these cases, decline to handle the + ;; original error or return NIL, depending on + ;; IF-DOES-NOT-EXIST. + (if if-does-not-exist + nil + (return-from load nil))))) + (%load pathspec :verbose verbose :print print + :external-format external-format))) - (let ((*load-depth* (1+ *load-depth*)) - ;; KLUDGE: I can't find in the ANSI spec where it says that - ;; DECLAIM/PROCLAIM of optimization policy should have file - ;; scope. CMU CL did this, and it seems reasonable, but it - ;; might not be right; after all, things like (PROCLAIM '(TYPE - ;; ..)) don't have file scope, and I can't find anything under - ;; PROCLAIM or COMPILE-FILE or LOAD or OPTIMIZE which - ;; justifies this behavior. Hmm. -- WHN 2001-04-06 - (sb!c::*policy* sb!c::*policy*) - ;; The ANSI spec for LOAD says "LOAD binds *READTABLE* and - ;; *PACKAGE* to the values they held before loading the file." - (*package* (sane-package)) - (*readtable* *readtable*) - ;; The old CMU CL LOAD function used an IF-DOES-NOT-EXIST - ;; argument of (MEMBER :ERROR NIL) type. ANSI constrains us to - ;; accept a generalized boolean argument value for this - ;; externally-visible function, but the internal functions - ;; still use the old convention. - (internal-if-does-not-exist (if if-does-not-exist :error nil))) - ;; FIXME: This VALUES wrapper is inherited from CMU CL. Once SBCL - ;; gets function return type checking right, we can achieve a - ;; similar effect better by adding FTYPE declarations. - (values - (if (streamp filespec) - (if (or (equal (stream-element-type filespec) - '(unsigned-byte 8))) - (load-as-fasl filespec verbose print) - (load-as-source filespec verbose print)) - (let (;; FIXME: MERGE-PATHNAMES doesn't work here for - ;; FILESPEC="TEST:Load-Test" and - ;; (LOGICAL-PATHNAME-TRANSLATIONS "TEST") - ;; = (("**;*.*.*" "/foo/bar/**/*.*")). - ;; Physicalizing the pathname before merging - ;; is a workaround, but the ANSI spec talks about - ;; MERGE-PATHNAMES accepting (and returning) - ;; logical pathnames, so a true fix would probably - ;; include fixing MERGE-PATHNAMES, then probably - ;; revisiting this code. - (ppn (physicalize-pathname (pathname filespec)))) - (if (wild-pathname-p ppn) - (let ((files (directory ppn))) - #!+high-security - (when (null files) - (error 'file-error :pathname filespec)) - (dolist (file files t) - (internal-load ppn - file - internal-if-does-not-exist - verbose - print))) - (let ((tn (probe-file ppn))) - (if (or tn (pathname-type ppn)) - (internal-load ppn - tn - internal-if-does-not-exist - verbose - print) - (internal-load-default-type - ppn - internal-if-does-not-exist - verbose - print))))))))) +;; This implements the defaulting SBCL seems to have inherited from +;; CMU. This routine does not try to perform any loading; all it does +;; is return the pathname (not the truename) of a file to be loaded, +;; or NIL if no such file can be found. This routine is supposed to +;; signal an error if a fasl's timestamp is older than its source +;; file, but we protect against errors in PROBE-FILE, because any of +;; the ways that we might fail to find a defaulted file are reasons +;; not to load it, but not worth exposing to the user who didn't +;; expicitly ask us to load a file with a made-up name (e.g., the +;; defaulted filename might exceed filename length limits). +(defun probe-load-defaults (pathname) + (destructuring-bind (defaulted-source-pathname + defaulted-source-truename + defaulted-fasl-pathname + defaulted-fasl-truename) + (loop for type in (list *load-source-default-type* + *fasl-file-type*) + as probe-pathname = (make-pathname :type type + :defaults pathname) + collect probe-pathname + collect (handler-case (probe-file probe-pathname) + (file-error () nil))) + (cond ((and defaulted-fasl-truename + defaulted-source-truename + (> (resignal-race-condition + (file-write-date defaulted-source-truename)) + (resignal-race-condition + (file-write-date defaulted-fasl-truename)))) + (restart-case + (error "The object file ~A is~@ + older than the presumed source:~% ~A." + defaulted-fasl-truename + defaulted-source-truename) + (source () :report "load source file" + defaulted-source-pathname) + (object () :report "load object file" + defaulted-fasl-pathname))) + (defaulted-fasl-truename defaulted-fasl-pathname) + (defaulted-source-truename defaulted-source-pathname)))) ;;; Load a code object. BOX-NUM objects are popped off the stack for ;;; the boxed storage section, then SIZE bytes of code are read in. @@ -225,20 +246,17 @@ (declare (fixnum box-num code-length)) (with-fop-stack t (let ((code (%primitive sb!c:allocate-code-object box-num code-length)) - (index (+ #!-gengc sb!vm:code-trace-table-offset-slot - #!+gengc sb!vm:code-debug-info-slot - box-num))) + (index (+ sb!vm:code-trace-table-offset-slot box-num))) (declare (type index index)) - #!-gengc (setf (%code-debug-info code) (pop-stack)) + (setf (%code-debug-info code) (pop-stack)) (dotimes (i box-num) - (declare (fixnum i)) - (setf (code-header-ref code (decf index)) (pop-stack))) + (declare (fixnum i)) + (setf (code-header-ref code (decf index)) (pop-stack))) (sb!sys:without-gcing - (read-n-bytes *fasl-input-stream* - (code-instructions code) - 0 - #!-gengc code-length - #!+gengc (* code-length sb!vm:word-bytes))) + (read-n-bytes *fasl-input-stream* + (code-instructions code) + 0 + code-length)) code))) ;;; Moving native code during a GC or purify is not so trivial on the @@ -249,97 +267,56 @@ ;;; all these code objects. After a purify these fixups can be ;;; dropped. In CMU CL, this policy was enabled with ;;; *ENABLE-DYNAMIC-SPACE-CODE*; in SBCL it's always used. -;;; -;;; A little analysis of the header information is used to determine -;;; if a code object is byte compiled, or native code. #!+x86 (defun load-code (box-num code-length) (declare (fixnum box-num code-length)) (with-fop-stack t (let ((stuff (list (pop-stack)))) (dotimes (i box-num) - (declare (fixnum i)) - (push (pop-stack) stuff)) - (let* ((dbi (car (last stuff))) ; debug-info - (tto (first stuff)) ; trace-table-offset - ;; Old CMU CL code had maybe-we-shouldn't-load-to-dyn-space - ;; pussyfooting around here, apparently dating back to the - ;; stone age of the X86 port, but in SBCL we always load - ;; to dynamic space. FIXME: So now this "variable" could go - ;; away entirely. - (load-to-dynamic-space t)) + (declare (fixnum i)) + (push (pop-stack) stuff)) + (let* ((dbi (car (last stuff))) ; debug-info + (tto (first stuff))) ; trace-table-offset - (setq stuff (nreverse stuff)) + (setq stuff (nreverse stuff)) - ;; Check that tto is always a list for byte-compiled - ;; code. Could be used an alternate check. - (when (and (typep tto 'list) - (not (and (sb!c::debug-info-p dbi) - (not (sb!c::compiled-debug-info-p dbi))))) - ;; FIXME: What is this for? - (format t "* tto list on non-bc code: ~S~% ~S ~S~%" - stuff dbi tto)) - - ;; FIXME: *LOAD-CODE-VERBOSE* should probably be #!+SB-SHOW. - (when *load-code-verbose* - (format t "stuff: ~S~%" stuff) - (format t - " : ~S ~S ~S ~S~%" - (sb!c::compiled-debug-info-p dbi) - (sb!c::debug-info-p dbi) - (sb!c::compiled-debug-info-name dbi) - tto) - (if load-to-dynamic-space - (format t " loading to the dynamic space~%") - (format t " loading to the static space~%"))) + ;; FIXME: *LOAD-CODE-VERBOSE* should probably be #!+SB-SHOW. + (when *load-code-verbose* + (format t "stuff: ~S~%" stuff) + (format t + " : ~S ~S ~S ~S~%" + (sb!c::compiled-debug-info-p dbi) + (sb!c::debug-info-p dbi) + (sb!c::compiled-debug-info-name dbi) + tto) + (format t " loading to the dynamic space~%")) - (let ((code - (if load-to-dynamic-space - (%primitive sb!c:allocate-dynamic-code-object - box-num - code-length) - (%primitive sb!c:allocate-code-object - box-num - code-length))) - (index (+ sb!vm:code-trace-table-offset-slot box-num))) - (declare (type index index)) - (when *load-code-verbose* - (format t - " obj addr=~X~%" - (sb!kernel::get-lisp-obj-address code))) - (setf (%code-debug-info code) (pop stuff)) - (dotimes (i box-num) - (declare (fixnum i)) - (setf (code-header-ref code (decf index)) (pop stuff))) - (sb!sys:without-gcing - (read-n-bytes *fasl-input-stream* - (code-instructions code) - 0 - code-length)) - code))))) + (let ((code (%primitive sb!c:allocate-code-object + box-num + code-length)) + (index (+ sb!vm:code-trace-table-offset-slot box-num))) + (declare (type index index)) + (when *load-code-verbose* + (format t + " obj addr=~X~%" + (sb!kernel::get-lisp-obj-address code))) + (setf (%code-debug-info code) (pop stuff)) + (dotimes (i box-num) + (declare (fixnum i)) + (setf (code-header-ref code (decf index)) (pop stuff))) + (sb!sys:without-gcing + (read-n-bytes *fasl-input-stream* + (code-instructions code) + 0 + code-length)) + code))))) ;;;; linkage fixups -;;; how we learn about assembler routines and foreign symbols at startup +;;; how we learn about assembler routines at startup (defvar *!initial-assembler-routines*) -(defvar *!initial-foreign-symbols*) + (defun !loader-cold-init () + (/show0 "/!loader-cold-init") (dolist (routine *!initial-assembler-routines*) - (setf (gethash (car routine) *assembler-routines*) (cdr routine))) - (dolist (symbol *!initial-foreign-symbols*) - (setf (gethash (car symbol) *static-foreign-symbols*) (cdr symbol)))) - -(declaim (ftype (function (string) sb!vm:word) - foreign-symbol-address-as-integer)) - - -;;; sb!sys:get-dynamic-foreign-symbol-address is in foreign.lisp, on -;;; platforms that have dynamic loading -(defun foreign-symbol-address-as-integer (foreign-symbol) - (or (find-foreign-symbol-in-table foreign-symbol *static-foreign-symbols*) - (sb!sys:get-dynamic-foreign-symbol-address foreign-symbol) - (error "unknown foreign symbol: ~S" foreign-symbol))) - -(defun foreign-symbol-address (symbol) - (int-sap (foreign-symbol-address-as-integer - (sb!vm:extern-alien-name symbol)))) + (setf (gethash (car routine) *assembler-routines*) (cdr routine))))