0.7.9.36:
[sbcl.git] / src / pcl / low.lisp
index e9539ec..073228d 100644 (file)
@@ -38,7 +38,8 @@
 (in-package "SB-PCL")
 \f
 (eval-when (:compile-toplevel :load-toplevel :execute)
-(defvar *optimize-speed* '(optimize (speed 3) (safety 0)))
+(defvar *optimize-speed*
+  '(optimize (speed 3) (safety 0)))
 ) ; EVAL-WHEN
 
 (defmacro dotimes-fixnum ((var count &optional (result nil)) &body body)
      (declare (fixnum ,var))
      ,@body))
 \f
+;;;; early definition of WRAPPER
+;;;;
+;;;; Most WRAPPER stuff is defined later, but the DEFSTRUCT itself
+;;;; is here early so that things like (TYPEP .. 'WRAPPER) can be
+;;;; compiled efficiently.
+
+;;; Note that for SBCL, as for CMU CL, the WRAPPER of a built-in or
+;;; structure class will be some other kind of SB-KERNEL:LAYOUT, but
+;;; this shouldn't matter, since the only two slots that WRAPPER adds
+;;; are meaningless in those cases.
+(defstruct (wrapper
+           (:include sb-kernel:layout
+                     ;; KLUDGE: In CMU CL, the initialization default
+                     ;; for LAYOUT-INVALID was NIL. In SBCL, that has
+                     ;; changed to :UNINITIALIZED, but PCL code might
+                     ;; still expect NIL for the initialization
+                     ;; default of WRAPPER-INVALID. Instead of trying
+                     ;; to find out, I just overrode the LAYOUT
+                     ;; default here. -- WHN 19991204
+                     (invalid nil))
+           (:conc-name %wrapper-)
+           (:constructor make-wrapper-internal)
+           (:copier nil))
+  (instance-slots-layout nil :type list)
+  (class-slots nil :type list))
+#-sb-fluid (declaim (sb-ext:freeze-type wrapper))
+\f
+;;;; PCL's view of funcallable instances
+
+(sb-kernel:!defstruct-with-alternate-metaclass pcl-funcallable-instance
+  ;; KLUDGE: Note that neither of these slots is ever accessed by its
+  ;; accessor name as of sbcl-0.pre7.63. Presumably everything works
+  ;; by puns based on absolute locations. Fun fun fun.. -- WHN 2001-10-30
+  :slot-names (clos-slots name hash-code)
+  :boa-constructor %make-pcl-funcallable-instance
+  :superclass-name sb-kernel:funcallable-instance
+  :metaclass-name sb-kernel:random-pcl-class
+  :metaclass-constructor sb-kernel:make-random-pcl-class
+  :dd-type sb-kernel:funcallable-structure
+  ;; Only internal implementation code will access these, and these
+  ;; accesses (slot readers in particular) could easily be a
+  ;; bottleneck, so it seems reasonable to suppress runtime type
+  ;; checks.
+  ;;
+  ;; (Except note KLUDGE above that these accessors aren't used at all
+  ;; (!) as of sbcl-0.pre7.63, so for now it's academic.)
+  :runtime-type-checks-p nil)
+
+(import 'sb-kernel:funcallable-instance-p)
+
+(defun set-funcallable-instance-fun (fin new-value)
+  (declare (type function new-value))
+  (aver (funcallable-instance-p fin))
+  (setf (sb-kernel:funcallable-instance-fun fin) new-value))
+(defmacro fsc-instance-p (fin)
+  `(funcallable-instance-p ,fin))
+(defmacro fsc-instance-wrapper (fin)
+  `(sb-kernel:%funcallable-instance-layout ,fin))
+;;; FIXME: This seems to bear no relation at all to the CLOS-SLOTS
+;;; slot in the FUNCALLABLE-INSTANCE structure, above, which
+;;; (bizarrely) seems to be set to the NAME of the
+;;; FUNCALLABLE-INSTANCE. At least, the index 1 seems to return the
+;;; NAME, and the index 2 NIL.  Weird.  -- CSR, 2002-11-07
+(defmacro fsc-instance-slots (fin)
+  `(sb-kernel:%funcallable-instance-info ,fin 0))
+(defmacro fsc-instance-hash (fin)
+  `(sb-kernel:%funcallable-instance-info ,fin 3))
+\f
+(declaim (inline clos-slots-ref (setf clos-slots-ref)))
 (declaim (ftype (function (simple-vector index) t) clos-slots-ref))
 (defun clos-slots-ref (slots index)
   (svref slots index))
 (defmacro std-instance-p (x)
   `(sb-kernel:%instancep ,x))
 
-(defmacro get-slots (inst)
-  `(cond ((std-instance-p ,inst) (std-instance-slots ,inst))
-        ((fsc-instance-p ,inst) (fsc-instance-slots ,inst))
-        (t (error "What kind of instance is this?"))))
-
 ;; a temporary definition used for debugging the bootstrap
 #+sb-show
 (defun print-std-instance (instance stream depth)
                (eq class (find-class 'built-in-class nil)))
        (princ (early-class-name instance) stream)))))
 
-;;; This is the value that we stick into a slot to tell us that it is unbound.
-;;; It may seem gross, but for performance reasons, we make this an interned
-;;; symbol. That means that the fast check to see whether a slot is unbound is
-;;; to say (EQ <val> '..SLOT-UNBOUND..). That is considerably faster than
-;;; looking at the value of a special variable. Be careful, there are places in
-;;; the code which actually use ..slot-unbound.. rather than this variable. So
-;;; much for modularity..
+;;; This is the value that we stick into a slot to tell us that it is
+;;; unbound. It may seem gross, but for performance reasons, we make
+;;; this an interned symbol. That means that the fast check to see
+;;; whether a slot is unbound is to say (EQ <val> '..SLOT-UNBOUND..).
+;;; That is considerably faster than looking at the value of a special
+;;; variable. Be careful, there are places in the code which actually
+;;; use ..SLOT-UNBOUND.. rather than this variable. So much for
+;;; modularity..
 ;;;
-;;; FIXME: Now that we're tightly integrated into SBCL, we could use the
-;;; SBCL built-in unbound value token instead.
+;;; FIXME: Now that we're tightly integrated into SBCL, we could use
+;;; the SBCL built-in unbound value token instead. Perhaps if we did
+;;; so it would be a good idea to define collections of CLOS slots as
+;;; a new type of heap object, instead of using bare SIMPLE-VECTOR, in
+;;; order to avoid problems (in the debugger if nowhere else) with
+;;; SIMPLE-VECTORs some of whose elements are unbound tokens.
 (defconstant +slot-unbound+ '..slot-unbound..)
 
 (defmacro %allocate-static-slot-storage--class (no-of-slots)
 (defmacro std-instance-class (instance)
   `(wrapper-class* (std-instance-wrapper ,instance)))
 \f
-
-;;; When given a function should give this function the name <new-name>.
-;;; Note that <new-name> is sometimes a list. Some lisps get the upset
-;;; in the tummy when they start thinking about functions which have
-;;; lists as names. To deal with that there is set-function-name-intern
-;;; which takes a list spec for a function name and turns it into a symbol
-;;; if need be.
+;;; When given a function should give this function the name
+;;; NEW-NAME. Note that NEW-NAME is sometimes a list. Some lisps
+;;; get the upset in the tummy when they start thinking about
+;;; functions which have lists as names. To deal with that there is
+;;; SET-FUN-NAME-INTERN which takes a list spec for a function
+;;; name and turns it into a symbol if need be.
 ;;;
-;;; When given a funcallable instance, set-function-name MUST side-effect
-;;; that FIN to give it the name. When given any other kind of function
-;;; set-function-name is allowed to return new function which is the 'same'
-;;; except that it has the name.
+;;; When given a funcallable instance, SET-FUN-NAME *must* side-effect
+;;; that FIN to give it the name. When given any other kind of
+;;; function SET-FUN-NAME is allowed to return a new function which is
+;;; "the same" except that it has the name.
 ;;;
-;;; In all cases, set-function-name must return the new (or same) function.
-;;; (Unlike other functions to set stuff, it does not return the new value.)
-(defun set-function-name (fcn new-name)
+;;; In all cases, SET-FUN-NAME must return the new (or same)
+;;; function. (Unlike other functions to set stuff, it does not return
+;;; the new value.)
+(defun set-fun-name (fcn new-name)
   #+sb-doc
   "Set the name of a compiled function object. Return the function."
   (declare (special *boot-state* *the-class-standard-generic-function*))
   (cond ((symbolp fcn)
-        (set-function-name (symbol-function fcn) new-name))
+        (set-fun-name (symbol-function fcn) new-name))
        ((funcallable-instance-p fcn)
         (if (if (eq *boot-state* 'complete)
                 (typep fcn 'generic-function)
                 (eq (class-of fcn) *the-class-standard-generic-function*))
             (setf (sb-kernel:%funcallable-instance-info fcn 1) new-name)
-            (typecase fcn
-              (sb-kernel:byte-closure
-               (set-function-name (sb-kernel:byte-closure-function fcn)
-                                  new-name))
-              (sb-kernel:byte-function
-               (setf (sb-kernel:byte-function-name fcn) new-name))
-              (sb-eval:interpreted-function
-               (setf (sb-eval:interpreted-function-name fcn) new-name))))
+            (bug "unanticipated function type"))
         fcn)
        (t
         ;; pw-- This seems wrong and causes trouble. Tests show
         ;; it loses some info of potential hacking value. So,
         ;; lets not do this...
         #+nil
-        (let ((header (sb-kernel:%closure-function fcn)))
-          (setf (sb-c::%function-name header) new-name))
+        (let ((header (sb-kernel:%closure-fun fcn)))
+          (setf (sb-kernel:%simple-fun-name header) new-name))
 
-        ;; Maybe add better scheme here someday.
+        ;; XXX Maybe add better scheme here someday.
         fcn)))
 
-(defun intern-function-name (name)
+(defun intern-fun-name (name)
   (cond ((symbolp name) name)
        ((listp name)
         (intern (let ((*package* *pcl-package*)
      (eval-when (:load-toplevel)
        (compile-iis-functions t))))
 \f
-(defun record-definition (type spec &rest args)
-  (declare (ignore type spec args))
-  ())
-
-(defun doctor-dfun-for-the-debugger (gf dfun) (declare (ignore gf)) dfun)
-\f
 ;;; This definition is for interpreted code.
 (defun pcl-instance-p (x)
   (typep (sb-kernel:layout-of x) 'wrapper))
 
-;;; We define this as STANDARD-INSTANCE, since we're going to clobber
-;;; the layout with some standard-instance layout as soon as we make
-;;; it, and we want the accessor to still be type-correct.
+;;; CMU CL comment:
+;;;   We define this as STANDARD-INSTANCE, since we're going to
+;;;   clobber the layout with some standard-instance layout as soon as
+;;;   we make it, and we want the accessor to still be type-correct.
+#|
 (defstruct (standard-instance
            (:predicate nil)
            (:constructor %%allocate-instance--class ())
            (:copier nil)
-           (:alternate-metaclass sb-kernel:instance cl:standard-class
+           (:alternate-metaclass sb-kernel:instance
+                                 cl:standard-class
                                  sb-kernel:make-standard-class))
   (slots nil))
+|#
+(sb-kernel:!defstruct-with-alternate-metaclass standard-instance
+  :slot-names (slots hash-code)
+  :boa-constructor %make-standard-instance
+  :superclass-name sb-kernel:instance
+  :metaclass-name cl:standard-class
+  :metaclass-constructor sb-kernel:make-standard-class
+  :dd-type structure
+  :runtime-type-checks-p nil)
 
 ;;; Both of these operations "work" on structures, which allows the above
 ;;; weakening of STD-INSTANCE-P.
 (defmacro std-instance-slots (x) `(sb-kernel:%instance-ref ,x 1))
 (defmacro std-instance-wrapper (x) `(sb-kernel:%instance-layout ,x))
+;;; KLUDGE: This one doesn't "work" on structures.  However, we
+;;; ensure, in SXHASH and friends, never to call it on structures.
+(defmacro std-instance-hash (x) `(sb-kernel:%instance-ref ,x 2))
+
+;;; FIXME: These functions are called every place we do a
+;;; CALL-NEXT-METHOD, and probably other places too. It's likely worth
+;;; selectively optimizing them with DEFTRANSFORMs and stuff, rather
+;;; than just indiscriminately expanding them inline everywhere.
+(declaim (inline get-slots get-slots-or-nil))
+(declaim (ftype (function (t) simple-vector) get-slots))
+(declaim (ftype (function (t) (or simple-vector null)) get-slots-or-nil))
+(defun get-slots (instance)
+  (if (std-instance-p instance)
+      (std-instance-slots instance)
+      (fsc-instance-slots instance)))
+(defun get-slots-or-nil (instance)
+  (when (pcl-instance-p instance)
+    (get-slots instance)))
 
 (defmacro built-in-or-structure-wrapper (x) `(sb-kernel:layout-of ,x))
 
        (aver (typep ,wrapper 'wrapper))
        ,wrapper)))
 
-;;; FIXME: could be an inline function (like many other things around
-;;; here)
+;;; FIXME: could be an inline function or ordinary function (like many
+;;; other things around here)
 (defmacro get-instance-wrapper-or-nil (inst)
   (once-only ((wrapper `(wrapper-of ,inst)))
     `(if (typep ,wrapper 'wrapper)
         ,wrapper
         nil)))
+\f
+;;;; support for useful hashing of PCL instances
+(let ((hash-code 0))
+  (declare (fixnum hash-code))
+  (defun get-instance-hash-code ()
+    (if (< hash-code most-positive-fixnum)
+       (incf hash-code)
+       (setq hash-code 0))))
 
-(defmacro get-slots-or-nil (inst)
-  (once-only ((n-inst inst))
-    `(when (pcl-instance-p ,n-inst)
-       (if (std-instance-p ,n-inst)
-          (std-instance-slots ,n-inst)
-          (fsc-instance-slots ,n-inst)))))
+(defun sb-impl::sxhash-instance (x)
+  (cond
+    ((std-instance-p x) (std-instance-hash x))
+    ((fsc-instance-p x) (fsc-instance-hash x))
+    (t (bug "SXHASH-INSTANCE called on some weird thing: ~S" x))))
 \f
 ;;;; structure-instance stuff
+;;;;
+;;;; FIXME: Now that the code is SBCL-only, this extra layer of
+;;;; abstraction around our native structure representation doesn't
+;;;; seem to add anything useful, and could probably go away.
+
 ;;; The definition of STRUCTURE-TYPE-P was moved to early-low.lisp.
 
 (defun get-structure-dd (type)
   (sb-kernel:dsd-name slotd))
 
 (defun structure-slotd-accessor-symbol (slotd)
-  (sb-kernel:dsd-accessor slotd))
+  (sb-kernel:dsd-accessor-name slotd))
 
 (defun structure-slotd-reader-function (slotd)
-  (fdefinition (sb-kernel:dsd-accessor slotd)))
+  (fdefinition (sb-kernel:dsd-accessor-name slotd)))
 
 (defun structure-slotd-writer-function (slotd)
   (unless (sb-kernel:dsd-read-only slotd)
-    (fdefinition `(setf ,(sb-kernel:dsd-accessor slotd)))))
+    (fdefinition `(setf ,(sb-kernel:dsd-accessor-name slotd)))))
 
 (defun structure-slotd-type (slotd)
   (sb-kernel:dsd-type slotd))