(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) (sb-ext:inhibit-warnings 3)))
) ; EVAL-WHEN
(defmacro dotimes-fixnum ((var count &optional (result nil)) &body body)
`(dotimes (,var (the fixnum ,count) ,result)
(declare (fixnum ,var))
,@body))
+
+(declaim (inline random-fixnum))
+(defun random-fixnum ()
+ (random (1+ most-positive-fixnum)))
+
+;;; Lambda which executes its body (or not) randomly. Used to drop
+;;; random cache entries.
+(defmacro randomly-punting-lambda (lambda-list &body body)
+ (with-unique-names (drops drop-pos)
+ `(let ((,drops (random-fixnum))
+ (,drop-pos sb-vm:n-fixnum-bits))
+ (declare (fixnum ,drops)
+ (type (integer 0 #.sb-vm:n-fixnum-bits) ,drop-pos))
+ (lambda ,lambda-list
+ (when (logbitp (the unsigned-byte (decf ,drop-pos)) ,drops)
+ (locally ,@body))
+ (when (zerop ,drop-pos)
+ (setf ,drops (random-fixnum)
+ ,drop-pos sb-vm:n-fixnum-bits))))))
+\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 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)
+ ;; This allows quick testing of wrapperness.
+ (for-std-class-p t))
+ (:constructor make-wrapper-internal)
+ (:copier nil))
+ (slots () :type list))
+#-sb-fluid (declaim (sb-ext:freeze-type wrapper))
\f
+;;;; PCL's view of funcallable instances
+
+(!defstruct-with-alternate-metaclass standard-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-standard-funcallable-instance
+ :superclass-name function
+ :metaclass-name standard-classoid
+ :metaclass-constructor make-standard-classoid
+ :dd-type 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-function (fin new-value)
+ (declare (type function new-value)
+ ;; KLUDGE: it might be nice to restrict
+ ;; SB-MOP:SET-FUNCALLABLE-INSTANCE-FUNCTION to operate only
+ ;; on generalized instances of
+ ;; SB-MOP:FUNCALLABLE-STANDARD-OBJECT; at present, even
+ ;; PCL's internal use of SET-FUNCALLABLE-INSTANCE-FUNCTION
+ ;; doesn't obey this restriction.
+ (type funcallable-instance fin))
+ (setf (funcallable-instance-fun fin) new-value))
+
+;;; FIXME: these macros should just go away. It's not clear whether
+;;; the inline functions defined by
+;;; !DEFSTRUCT-WITH-ALTERNATE-METACLASS are as efficient as they could
+;;; be; ordinary defstruct accessors are defined as source transforms.
+(defun fsc-instance-p (fin)
+ (funcallable-instance-p fin))
+(define-compiler-macro fsc-instance-p (fin)
+ `(funcallable-instance-p ,fin))
+(defmacro fsc-instance-wrapper (fin)
+ `(%funcallable-instance-layout ,fin))
+(defmacro fsc-instance-slots (fin)
+ `(%funcallable-instance-info ,fin 1))
+(defmacro fsc-instance-hash (fin)
+ `(%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))
;;; and normal instances, so we can return true on structures also. A
;;; few uses of (OR STD-INSTANCE-P FSC-INSTANCE-P) are changed to
;;; PCL-INSTANCE-P.
-(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?"))))
+(defun std-instance-p (x)
+ (%instancep x))
+(define-compiler-macro std-instance-p (x)
+ `(%instancep ,x))
;; a temporary definition used for debugging the bootstrap
#+sb-show
(defun print-std-instance (instance stream depth)
- (declare (ignore depth))
+ (declare (ignore depth))
(print-unreadable-object (instance stream :type t :identity t)
(let ((class (class-of instance)))
(when (or (eq class (find-class 'standard-class nil))
- (eq class (find-class 'funcallable-standard-class nil))
- (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..
+ (eq class (find-class 'funcallable-standard-class nil))
+ (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.
;;;
-;;; FIXME: Now that we're tightly integrated into SBCL, we could use the
-;;; SBCL built-in unbound value token instead.
-(defconstant +slot-unbound+ '..slot-unbound..)
+;;; It seems only reasonable to also export this for users, since
+;;; otherwise dealing with STANDARD-INSTANCE-ACCESS becomes harder
+;;; -- and slower -- than it needs to be.
+(defconstant +slot-unbound+ '..slot-unbound..
+ "SBCL specific extensions to MOP: if this value is read from an
+instance using STANDARD-INSTANCE-ACCESS, the slot is unbound.
+Similarly, an :INSTANCE allocated slot can be made unbound by
+assigning this to it using (SETF STANDARD-INSTANCE-ACCESS).
+
+Value of +SLOT-UNBOUND+ is unspecified, and should not be relied to be
+of any particular type, but it is guaranteed to be suitable for EQ
+comparison.")
(defmacro %allocate-static-slot-storage--class (no-of-slots)
`(make-array ,no-of-slots :initial-element +slot-unbound+))
(defmacro std-instance-class (instance)
`(wrapper-class* (std-instance-wrapper ,instance)))
\f
-
-;;; SET-FUNCTION-NAME
-;;;
-;;; 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 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.
;;;
-;;; 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.
-;;;
-;;; 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 (fun 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))
- ((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))))
- fcn)
- (t
- ;; pw-- This seems wrong and causes trouble. Tests show
- ;; that loading CL-HTTP resulted in ~5400 closures being
- ;; passed through this code of which ~4000 of them pointed
- ;; to but 16 closure-functions, including 1015 each of
- ;; DEFUN MAKE-OPTIMIZED-STD-WRITER-METHOD-FUNCTION
- ;; DEFUN MAKE-OPTIMIZED-STD-READER-METHOD-FUNCTION
- ;; DEFUN MAKE-OPTIMIZED-STD-BOUNDP-METHOD-FUNCTION.
- ;; Since the actual functions have been moved by PURIFY
- ;; to memory not seen by GC, changing a pointer there
- ;; not only clobbers the last change but leaves a dangling
- ;; pointer invalid after the next GC. Comments in low.lisp
- ;; indicate this code need do nothing. Setting the
- ;; function-name to NIL loses some info, and not changing
- ;; 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))
-
- ;; Maybe add better scheme here someday.
- fcn)))
-
-(defun intern-function-name (name)
- (cond ((symbolp name) name)
- ((listp name)
- (intern (let ((*package* *pcl-package*)
- (*print-case* :upcase)
- (*print-pretty* nil)
- (*print-gensym* t))
- (format nil "~S" name))
- *pcl-package*))))
+ (when (valid-function-name-p fun)
+ (setq fun (fdefinition fun)))
+ (typecase fun
+ (%method-function (setf (%method-function-name fun) new-name))
+ #+sb-eval
+ (sb-eval:interpreted-function
+ (setf (sb-eval:interpreted-function-name fun) new-name))
+ (funcallable-instance ;; KLUDGE: probably a generic function...
+ (cond ((if (eq **boot-state** 'complete)
+ (typep fun 'generic-function)
+ (eq (class-of fun) *the-class-standard-generic-function*))
+ (setf (%funcallable-instance-info fun 2) new-name))
+ (t
+ (bug "unanticipated function type")))))
+ ;; Fixup name-to-function mappings in cases where the function
+ ;; hasn't been defined by DEFUN. (FIXME: is this right? This logic
+ ;; comes from CMUCL). -- CSR, 2004-12-31
+ (when (and (consp new-name)
+ (member (car new-name) '(slow-method fast-method slot-accessor)))
+ (setf (fdefinition new-name) fun))
+ fun)
\f
;;; FIXME: probably no longer needed after init
(defmacro precompile-random-code-segments (&optional system)
`(progn
(eval-when (:compile-toplevel)
- (update-dispatch-dfuns)
- (compile-iis-functions nil))
+ (update-dispatch-dfuns))
(precompile-function-generators ,system)
(precompile-dfun-constructors ,system)
- (precompile-iis-functions ,system)
- (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)
+ (precompile-ctors)))
\f
;;; This definition is for interpreted code.
(defun pcl-instance-p (x)
- (typep (sb-kernel:layout-of x) 'wrapper))
+ (typep (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
- sb-kernel:make-standard-class))
+ (:predicate nil)
+ (:constructor %%allocate-instance--class ())
+ (:copier nil)
+ (:alternate-metaclass instance
+ cl:standard-class
+ make-standard-class))
(slots nil))
+|#
+(!defstruct-with-alternate-metaclass standard-instance
+ :slot-names (slots hash-code)
+ :boa-constructor %make-standard-instance
+ :superclass-name t
+ :metaclass-name standard-classoid
+ :metaclass-constructor make-standard-classoid
+ :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))
+(defmacro std-instance-slots (x) `(%instance-ref ,x 1))
+(defmacro std-instance-wrapper (x) `(%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) `(%instance-ref ,x 2))
-(defmacro built-in-or-structure-wrapper (x) `(sb-kernel:layout-of ,x))
+;;; 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)
+ ;; Suppress a code-deletion note. FIXME: doing the FIXME above,
+ ;; integrating PCL more with the compiler, would remove the need for
+ ;; this icky stuff.
+ (declare (optimize (inhibit-warnings 3)))
+ (when (pcl-instance-p instance)
+ (get-slots instance)))
(defmacro get-wrapper (inst)
(once-only ((wrapper `(wrapper-of ,inst)))
`(progn
- (assert (typep ,wrapper 'wrapper) () "What kind of instance is this?")
+ (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)))
-
-(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)))))
+ ,wrapper
+ nil)))
\f
-;;;; structure-instance stuff
-;;; The definition of STRUCTURE-TYPE-P was moved to early-low.lisp.
+;;;; support for useful hashing of PCL instances
-(defun get-structure-dd (type)
- (sb-kernel:layout-info (sb-kernel:class-layout (cl:find-class type))))
+(defvar *instance-hash-code-random-state* (make-random-state))
+(defun get-instance-hash-code ()
+ ;; ANSI SXHASH wants us to make a good-faith effort to produce
+ ;; hash-codes that are well distributed within the range of
+ ;; non-negative fixnums, and this RANDOM operation does that, unlike
+ ;; the sbcl<=0.8.16 implementation of this operation as
+ ;; (INCF COUNTER).
+ ;;
+ ;; Hopefully there was no virtue to the old counter implementation
+ ;; that I am insufficiently insightful to insee. -- WHN 2004-10-28
+ (random most-positive-fixnum
+ *instance-hash-code-random-state*))
-(defun structure-type-included-type-name (type)
- (let ((include (sb-kernel::dd-include (get-structure-dd type))))
- (if (consp include)
- (car include)
- include)))
+(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 structure-type-slot-description-list (type)
- (nthcdr (length (let ((include (structure-type-included-type-name type)))
- (and include
- (sb-kernel:dd-slots (get-structure-dd include)))))
- (sb-kernel:dd-slots (get-structure-dd type))))
+ (let* ((dd (find-defstruct-description type))
+ (include (dd-include dd))
+ (all-slots (dd-slots dd)))
+ (multiple-value-bind (super slot-overrides)
+ (if (consp include)
+ (values (car include) (mapcar #'car (cdr include)))
+ (values include nil))
+ (let ((included-slots
+ (when super
+ (dd-slots (find-defstruct-description super)))))
+ (loop for slot = (pop all-slots)
+ for included-slot = (pop included-slots)
+ while slot
+ when (or (not included-slot)
+ (member (dsd-name included-slot) slot-overrides :test #'eq))
+ collect slot)))))
+
+(defun uninitialized-accessor-function (type slotd)
+ (lambda (&rest args)
+ (declare (ignore args))
+ (error "~:(~A~) function~@[ for ~S ~] not yet initialized."
+ type slotd)))
(defun structure-slotd-name (slotd)
- (sb-kernel:dsd-name slotd))
+ (dsd-name slotd))
(defun structure-slotd-accessor-symbol (slotd)
- (sb-kernel:dsd-accessor slotd))
+ (dsd-accessor-name slotd))
(defun structure-slotd-reader-function (slotd)
- (fdefinition (sb-kernel:dsd-accessor slotd)))
+ (let ((name (dsd-accessor-name slotd)))
+ (if (fboundp name)
+ (fdefinition name)
+ (uninitialized-accessor-function :reader slotd))))
-(defun structure-slotd-writer-function (slotd)
- (unless (sb-kernel:dsd-read-only slotd)
- (fdefinition `(setf ,(sb-kernel:dsd-accessor slotd)))))
+(defun structure-slotd-writer-function (type slotd)
+ (if (dsd-read-only slotd)
+ (let ((dd (find-defstruct-description type)))
+ (coerce (slot-setter-lambda-form dd slotd) 'function))
+ (let ((name `(setf ,(dsd-accessor-name slotd))))
+ (if (fboundp name)
+ (fdefinition name)
+ (uninitialized-accessor-function :writer slotd)))))
(defun structure-slotd-type (slotd)
- (sb-kernel:dsd-type slotd))
+ (dsd-type slotd))
(defun structure-slotd-init-form (slotd)
- (sb-kernel::dsd-default slotd))
+ (dsd-default slotd))
+\f
+;;; method function stuff.
+;;;
+;;; PCL historically included a so-called method-fast-function, which
+;;; is essentially a method function but with (a) a precomputed
+;;; continuation for CALL-NEXT-METHOD and (b) a permutation vector for
+;;; slot access. [ FIXME: see if we can understand these two
+;;; optimizations before commit. ] However, the presence of the
+;;; fast-function meant that we violated AMOP and the effect of the
+;;; :FUNCTION initarg, and furthermore got to potentially confusing
+;;; situations where the function and the fast-function got out of
+;;; sync, so that calling (method-function method) with the defined
+;;; protocol would do different things from (call-method method) in
+;;; method combination.
+;;;
+;;; So we define this internal method function structure, which we use
+;;; when we create a method function ourselves. This means that we
+;;; can hang the various bits of information that we want off the
+;;; method function itself, and also that if a user overrides method
+;;; function creation there is no danger of having the system get
+;;; confused.
+(!defstruct-with-alternate-metaclass %method-function
+ :slot-names (fast-function name)
+ :boa-constructor %make-method-function
+ :superclass-name function
+ :metaclass-name static-classoid
+ :metaclass-constructor make-static-classoid
+ :dd-type funcallable-structure)
+