0.7.4.1:
[sbcl.git] / src / code / target-load.lisp
index 8f8a1f0..48a96c4 100644 (file)
 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
 ;;;; files for more information.
 
-(in-package "SB!IMPL")
+(in-package "SB!FASL")
 
-(file-comment
-  "$Header$")
-
-(defvar *load-source-types* '("lisp" "l" "cl" "lsp")
-  #!+sb-doc
-  "The source file types which LOAD recognizes.")
-
-(defvar *load-object-types*
-  '(#.sb!c:*backend-fasl-file-type*
-    #.(sb!c:backend-byte-fasl-file-type)
-    "fasl")
+(defvar *load-source-default-type* "lisp"
   #!+sb-doc
-  "A list of the object file types recognized by LOAD.")
-
-(declaim (list *load-source-types* *load-object-types*))
+  "The source file types which LOAD looks for by default.")
 
+(declaim (type (or pathname null) *load-truename* *load-pathname*))
 (defvar *load-truename* nil
   #!+sb-doc
   "the TRUENAME of the file that LOAD is currently loading")
-
 (defvar *load-pathname* nil
   #!+sb-doc
   "the defaulted pathname that LOAD is currently loading")
-
-(declaim (type (or pathname null) *load-truename* *load-pathname*))
 \f
-;;;; SLOLOAD
-
-;;; something not EQ to anything read from a file
-;;; FIXME: shouldn't be DEFCONSTANT; and maybe make a shared EOF cookie in
-;;; SB-INT:*EOF-VALUE*?
-(defconstant load-eof-value '(()))
+;;;; LOAD-AS-SOURCE
 
 ;;; Load a text file.
-(defun sloload (stream verbose print)
-  (do-load-verbose stream verbose)
-  (do ((sexpr (read stream nil load-eof-value)
-             (read stream nil load-eof-value)))
-      ((eq sexpr load-eof-value)
+(defun load-as-source (stream verbose print)
+  (maybe-announce-load stream verbose)
+  (do ((sexpr (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))
-       (eval sexpr))))
+      (eval sexpr))))
 \f
 ;;;; LOAD itself
 
        (with-open-file (stream truename
                               :direction :input
                               :if-does-not-exist if-does-not-exist)
-        (sloload stream verbose print)))
+        (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))
-        (fasload stream verbose print)))
+        (load-as-fasl stream verbose print)))
       (t
        (let ((first-line (with-open-file (stream truename :direction :input)
                           (read-line stream nil)))
-            (fhs sb!c:*fasl-header-string-start-string*))
+            (fhsss *fasl-header-string-start-string*))
         (cond
          ((and first-line
                (>= (length (the simple-string first-line))
-                   (length fhs))
-               (string= first-line fhs :end1 (length fhs)))
+                   (length fhsss))
+               (string= first-line fhsss :end1 (length fhsss)))
           (internal-load pathname truename if-does-not-exist verbose print
                          :binary))
          (t
-          (when (member (pathname-type truename)
-                        *load-object-types*
-                        :test #'string=)
+          (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))))))))
 
-;;; a helper function for INTERNAL-LOAD-DEFAULT-TYPE
-(defun try-default-types (pathname types lp-type)
-  ;; Modified 18-Jan-97/pw for logical-pathname support.
-  ;;
-  ;; FIXME: How does logical-pathname support interact with
-  ;; *LOAD-SOURCE-TYPES* and *LOAD-OBJECT-TYPES*?
-  (flet ((frob (pathname type)
-          (let* ((pn (make-pathname :type type :defaults pathname))
-                 (tn (probe-file pn)))
-            (values pn tn))))
-    (if (typep pathname 'logical-pathname)
-       (frob pathname lp-type)
-       (dolist (type types (values nil nil))
-         (multiple-value-bind (pn tn) (frob pathname type)
-           (when tn
-             (return (values pn tn))))))))
+;;; 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))))
 
-;;; a helper function for LOAD: Handle the case of INTERNAL-LOAD where the file
-;;; does not exist.
+;;; 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))
-  ;; FIXME: How do the fixed "LISP" and "FASL" types interact with the
-  ;; *LOAD-SOURCE-TYPES* and *LOAD-OBJECT-TYPES* values?
   (multiple-value-bind (src-pn src-tn)
-      (try-default-types pathname *load-source-types* "LISP")
+      (try-default-type pathname *load-source-default-type*)
     (multiple-value-bind (obj-pn obj-tn)
-       (try-default-types pathname *load-object-types* "FASL")
+       (try-default-type pathname *fasl-file-type*)
       (cond
        ((and obj-tn
             src-tn
        (t
        (internal-load pathname nil if-does-not-exist verbose print nil))))))
 
-;;; 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: ANSI specifies an EXTERNAL-FORMAT keyword argument.
+;;; 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
             &key
             (verbose *load-verbose*)
             (print *load-print*)
-            (if-does-not-exist t))
+            (if-does-not-exist t)
+            (external-format :default))
   #!+sb-doc
-  "Loads the file given by FILESPEC into the Lisp environment, returning
-   T on success. These options are defined:
-
-   :IF-DOES-NOT-EXIST
-       What should we do if the file can't be located? If true (the
-       default), signal an error. If NIL, simply return NIL.
-
-   :VERBOSE
-       If true, print a line describing each file loaded. The default
-       is *LOAD-VERBOSE*.
+  "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."))
 
-   :PRINT
-       If true, print information about loaded values. When loading the
-       source, the result of evaluating each top-level form is printed.
-       The default is *LOAD-PRINT*."
-
-  (let ((sb!c::*default-cookie* sb!c::*default-cookie*)
-       (sb!c::*default-interface-cookie* sb!c::*default-interface-cookie*)
-       (*package* *package*)
+  (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*)
-       (*load-depth* (1+ *load-depth*))
-       ;; 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.
+       ;; 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.
+    ;; 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)))
-            (fasload filespec verbose print)
-            (sloload filespec verbose print))
-        (let ((pn (merge-pathnames (pathname filespec)
-                                   *default-pathname-defaults*)))
-          (if (wild-pathname-p pn)
-              (let ((files (directory pn)))
-                #!+high-security
-                (when (null files)
-                  (error 'file-error :pathname filespec))
-                (dolist (file files t)
-                  (internal-load pn
-                                 file
-                                 internal-if-does-not-exist
-                                 verbose
-                                 print)))
-              (let ((tn (probe-file pn)))
-                (if (or tn (pathname-type pn))
-                    (internal-load pn
-                                   tn
-                                   internal-if-does-not-exist
-                                   verbose
-                                   print)
-                    (internal-load-default-type
-                     pn
-                     internal-if-does-not-exist
-                     verbose
-                     print)))))))))
+            (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)))
+               (unix-name (unix-namestring ppn t)))
+          (if (or unix-name (pathname-type ppn))
+              (internal-load ppn
+                             unix-name
+                             internal-if-does-not-exist
+                             verbose
+                             print)
+              (internal-load-default-type
+               ppn
+               internal-if-does-not-exist
+               verbose
+               print)))))))
 \f
 ;;; 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.
   (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)))
       (sb!sys:without-gcing
-       (read-n-bytes *fasl-file*
+       (read-n-bytes *fasl-input-stream*
                      (code-instructions code)
                      0
-                     #!-gengc code-length
-                     #!+gengc (* code-length sb!vm:word-bytes)))
+                     code-length))
       code)))
 
+;;; Moving native code during a GC or purify is not so trivial on the
+;;; x86 port.
+;;;
+;;; Our strategy for allowing the loading of x86 native code into the
+;;; dynamic heap requires that the addresses of fixups be saved for
+;;; 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.
 #!+x86
 (defun load-code (box-num code-length)
   (declare (fixnum box-num code-length))
        (push (pop-stack) stuff))
       (let* ((dbi (car (last stuff)))  ; debug-info
             (tto (first stuff))        ; trace-table-offset
-            (load-to-dynamic-space
-             (or *enable-dynamic-space-code*
-                 ;; definitely byte-compiled code?
-                 (and *load-byte-compiled-code-to-dynamic-space*
-                      (sb!c::debug-info-p dbi)
-                      (not (sb!c::compiled-debug-info-p dbi)))
-                 ;; or a x86 top level form?
-                 (and *load-x86-tlf-to-dynamic-space*
-                      (sb!c::compiled-debug-info-p dbi)
-                      (string= (sb!c::compiled-debug-info-name dbi)
-                               "top-level form")))) )
+            ;; 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))
 
        (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)
            (declare (fixnum i))
            (setf (code-header-ref code (decf index)) (pop stuff)))
          (sb!sys:without-gcing
-          (read-n-bytes *fasl-file* (code-instructions code) 0 code-length))
+          (read-n-bytes *fasl-input-stream*
+                        (code-instructions code)
+                        0
+                        code-length))
          code)))))
 \f
 ;;;; linkage fixups
   (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))
+(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 (gethash foreign-symbol *static-foreign-symbols*)
-      (gethash (concatenate 'simple-string
-                           #!+linux "ldso_stub__"
-                           #!+openbsd "_"
-                           #!+freebsd "ldso_stub__"
-                           foreign-symbol)
-              *static-foreign-symbols*)
+  (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))))
+  (int-sap (foreign-symbol-address-as-integer
+           (sb!vm:extern-alien-name symbol))))