;; TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
;; SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-;; $Id: proxy.lisp,v 1.21 2005-04-24 13:26:40 espen Exp $
+;; $Id: proxy.lisp,v 1.26 2006-02-06 11:52:24 espen Exp $
(in-package "GLIB")
((setter :reader slot-definition-setter :initarg :setter)
(getter :reader slot-definition-getter :initarg :getter)
(unbound :reader slot-definition-unbound :initarg :unbound)
- (boundp :reader slot-definition-boundp :initarg :boundp))))
-
- (defvar *unbound-marker* (gensym "UNBOUND-MARKER-"))
-
- (defun most-specific-slot-value (instances slot &optional
- (default *unbound-marker*))
- (let ((object (find-if
- #'(lambda (ob)
- (and (slot-exists-p ob slot) (slot-boundp ob slot)))
- instances)))
- (if object
- (slot-value object slot)
- default)));)
+ (boundp :reader slot-definition-boundp :initarg :boundp)))
+ (defclass direct-special-slot-definition (standard-direct-slot-definition)
+ ())
+ (defclass effective-special-slot-definition (standard-effective-slot-definition)
+ ()))
+
+(defvar *unbound-marker* (gensym "UNBOUND-MARKER-"))
+
+(defun most-specific-slot-value (instances slot &optional (default *unbound-marker*))
+ (let ((object (find-if
+ #'(lambda (ob)
+ (and (slot-exists-p ob slot) (slot-boundp ob slot)))
+ instances)))
+ (if object
+ (slot-value object slot)
+ default)))
+
+(defmethod initialize-instance ((slotd effective-special-slot-definition) &rest initargs)
+ (declare (ignore initargs))
+ (call-next-method)
+ (setf (slot-value slotd 'allocation) :instance))
+
(defmethod direct-slot-definition-class ((class virtual-slots-class) &rest initargs)
- (if (eq (getf initargs :allocation) :virtual)
- (find-class 'direct-virtual-slot-definition)
- (call-next-method)))
+ (case (getf initargs :allocation)
+ (:virtual (find-class 'direct-virtual-slot-definition))
+ (:special (find-class 'direct-special-slot-definition))
+ (t (call-next-method))))
(defmethod effective-slot-definition-class ((class virtual-slots-class) &rest initargs)
- (if (eq (getf initargs :allocation) :virtual)
- (find-class 'effective-virtual-slot-definition)
- (call-next-method)))
+ (case (getf initargs :allocation)
+ (:virtual (find-class 'effective-virtual-slot-definition))
+ (:special (find-class 'effective-special-slot-definition))
+ (t (call-next-method))))
(defmethod initialize-internal-slot-functions ((slotd effective-virtual-slot-definition))
(setq reader
(mkbinding getter
(slot-definition-type slotd) 'pointer)))
- (funcall reader (proxy-location object))))))))))
+ (funcall reader (foreign-location object))))))))))
(setf
(slot-value slotd 'boundp-function)
(setq reader
(mkbinding boundp
(slot-definition-type slotd) 'pointer)))
- (funcall reader (proxy-location object))))))))
+ (funcall reader (foreign-location object))))))))
((multiple-value-bind (unbound-p unbound-value)
(unbound-value (slot-definition-type slotd))
(when unbound-p
(setq writer
(mkbinding setter 'nil 'pointer
(slot-definition-type slotd))))
- (funcall writer (proxy-location object) value)))))))))
+ (funcall writer (foreign-location object) value)))))))))
(initialize-internal-slot-gfs (slot-definition-name slotd)))
(internal *instance-cache*)
(defvar *instance-cache* (make-hash-table :test #'eql))
-(defun cache-instance (instance)
+(defun cache-instance (instance &optional (weak-ref t))
(setf
- (gethash (sap-int (proxy-location instance)) *instance-cache*)
- (make-weak-pointer instance)))
+ (gethash (sap-int (foreign-location instance)) *instance-cache*)
+ (if weak-ref
+ (make-weak-pointer instance)
+ instance)))
(defun find-cached-instance (location)
(let ((ref (gethash (sap-int location) *instance-cache*)))
(when ref
- (weak-pointer-value ref))))
+ (if (weak-pointer-p ref)
+ (weak-pointer-value ref)
+ ref))))
(defun instance-cached-p (location)
(gethash (sap-int location) *instance-cache*))
(remhash (sap-int location) *instance-cache*))
;; For debuging
-(defun cached-instances ()
+(defun list-cached-instances ()
(let ((instances ()))
(maphash #'(lambda (location ref)
(declare (ignore location))
- (push (weak-pointer-value ref) instances))
+ (push ref instances))
*instance-cache*)
instances))
;;;; Proxy for alien instances
+;; TODO: add a ref-counted-proxy subclass
(defclass proxy ()
- ((location :reader proxy-location :type system-area-pointer)))
+ ((location :allocation :special :reader foreign-location :type pointer))
+ (:metaclass virtual-slots-class))
-(defgeneric initialize-proxy (object &rest initargs))
(defgeneric instance-finalizer (object))
(defgeneric reference-foreign (class location))
(defgeneric unreference-foreign (class location))
+(defgeneric invalidate-instance (object))
(defmethod reference-foreign ((name symbol) location)
(reference-foreign (find-class name) location))
(defmethod unreference-foreign :around ((class class) location)
(unless (null-pointer-p location)
-;; (format t "Unreferencing ~A at ~A" (class-name class) location)
-;; (finish-output *standard-output*)
- (call-next-method)
-;; (write-line " done")
-;; (finish-output *standard-output*)
- ))
+ (call-next-method)))
(defmethod print-object ((instance proxy) stream)
(print-unreadable-object (instance stream :type t :identity nil)
- (when (slot-boundp instance 'location)
- (format stream "at 0x~X" (sap-int (proxy-location instance))))))
+ (if (slot-boundp instance 'location)
+ (format stream "at 0x~X" (sap-int (foreign-location instance)))
+ (write-string "at \"unbound\"" stream))))
-(defmethod initialize-instance :around ((instance proxy) &key location)
- (if location
- (setf (slot-value instance 'location) location)
- (call-next-method))
- (cache-instance instance)
- (finalize instance (instance-finalizer instance))
- instance)
+(defmethod initialize-instance :around ((instance proxy) &rest initargs)
+ (declare (ignore initargs))
+ (prog1
+ (call-next-method)
+ (cache-instance instance)
+ (finalize instance (instance-finalizer instance))))
(defmethod instance-finalizer ((instance proxy))
- (let ((location (proxy-location instance))
+ (let ((location (foreign-location instance))
(class (class-of instance)))
;; (unless (find-method #'unreference-foreign nil (list (class-of class) t) nil)
;; (error "No matching method for UNREFERENCE-INSTANCE when called with class ~A" class))
(remove-cached-instance location)
(unreference-foreign class location))))
+(defmethod invalidate-instance ((instance proxy))
+ (remove-cached-instance (foreign-location instance))
+ (slot-makunbound instance 'location))
+
;;;; Metaclass used for subclasses of proxy
(defgeneric most-specific-proxy-superclass (class))
(defgeneric direct-proxy-superclass (class))
+(defgeneric compute-foreign-size (class))
(eval-when (:compile-toplevel :load-toplevel :execute)
(defclass proxy-class (virtual-slots-class)
- ((size :reader proxy-instance-size)))
+ ((size :reader foreign-size)))
(defclass direct-alien-slot-definition (direct-virtual-slot-definition)
((allocation :initform :alien)
(cond
(size (setf (slot-value class 'size) (first size)))
((slot-boundp class 'size) (slot-makunbound class 'size))))
-
+
(defmethod direct-slot-definition-class ((class proxy-class) &rest initargs)
(case (getf initargs :allocation)
- ((nil :alien) (find-class 'direct-alien-slot-definition))
+ (:alien (find-class 'direct-alien-slot-definition))
(t (call-next-method))))
(defmethod effective-slot-definition-class ((class proxy-class) &rest initargs)
(setf
(slot-value slotd 'getter)
#'(lambda (object)
- (funcall reader (proxy-location object) offset)))))
+ (funcall reader (foreign-location object) offset)))))
(unless (slot-boundp slotd 'setter)
(let ((writer (writer-function type))
(setf
(slot-value slotd 'setter)
#'(lambda (value object)
- (let ((location (proxy-location object)))
+ (let ((location (foreign-location object)))
(funcall destroy location offset) ; destroy old value
(funcall writer value location offset))))))))
(call-next-method))
+ (defmethod compute-foreign-size ((class proxy-class))
+ nil)
;; TODO: call some C code to detect this a compile time
(defconstant +struct-alignmen+ 4)
+ (defun align-offset (size)
+ (if (zerop (mod size +struct-alignmen+))
+ size
+ (+ size (- +struct-alignmen+ (mod size +struct-alignmen+)))))
+
(defmethod compute-slots ((class proxy-class))
- (loop
- with offset = (let ((size-of-super-classes
- (proxy-instance-size
- (most-specific-proxy-superclass class))))
- (+ size-of-super-classes
- (mod size-of-super-classes +struct-alignmen+)))
- with size = offset
- for slotd in (class-direct-slots class)
- when (eq (slot-definition-allocation slotd) :alien)
- do (if (not (slot-boundp slotd 'offset))
- (setf (slot-value slotd 'offset) offset)
- (setq offset (slot-value slotd 'offset)))
-
- (incf offset (size-of (slot-definition-type slotd)))
- (incf offset (mod offset +struct-alignmen+))
- (setq size (max size offset))
-
- finally (unless (slot-boundp class 'size)
- (setf (slot-value class 'size) size)))
+ (let ((alien-slots
+ (remove-if-not
+ #'(lambda (slotd)
+ (eq (slot-definition-allocation slotd) :alien))
+ (class-direct-slots class))))
+ (when alien-slots
+ (loop
+ as offset = (align-offset (foreign-size
+ (most-specific-proxy-superclass class)))
+ then (align-offset
+ (+
+ (slot-definition-offset slotd)
+ (size-of (slot-definition-type slotd))))
+ for slotd in alien-slots
+ unless (slot-boundp slotd 'offset)
+ do (setf (slot-value slotd 'offset) offset))))
(call-next-method))
+ (defmethod compute-slots :after ((class proxy-class))
+ (when (and (class-finalized-p class) (not (slot-boundp class 'size)))
+ (let ((size (compute-foreign-size class)))
+ (when size
+ (setf (slot-value class 'size) size)))))
(defmethod validate-superclass ((class proxy-class) (super standard-class))
(subtypep (class-name super) 'proxy))
- (defmethod proxy-instance-size (class)
- (declare (ignore class))
- 0)
+ (defmethod foreign-size ((class-name symbol))
+ (foreign-size (find-class class-name))))
- (defmethod proxy-instance-size ((class-name symbol))
- (proxy-instance-size (find-class class-name)))
-)
+(defmethod foreign-size ((object proxy))
+ (foreign-size (class-of object)))
+
(defmethod alien-type ((class proxy-class) &rest args)
(declare (ignore class args))
(alien-type 'pointer))
(defmethod to-alien-form (instance (class proxy-class) &rest args)
(declare (ignore class args))
- `(proxy-location ,instance))
+ `(foreign-location ,instance))
(defmethod to-alien-function ((class proxy-class) &rest args)
(declare (ignore class args))
- #'proxy-location)
+ #'foreign-location)
(defmethod copy-from-alien-form (location (class proxy-class) &rest args)
(declare (ignore args))
(defmethod copy-to-alien-form (instance (class proxy-class) &rest args)
(declare (ignore args))
- `(reference-foreign ',(class-name class) (proxy-location ,instance)))
+ `(reference-foreign ',(class-name class) (foreign-location ,instance)))
(defmethod copy-to-alien-function ((class proxy-class) &rest args)
(declare (ignore args))
#'(lambda (instance)
- (reference-foreign class (proxy-location instance))))
+ (reference-foreign class (foreign-location instance))))
(defmethod writer-function ((class proxy-class) &rest args)
(declare (ignore args))
(assert (null-pointer-p (sap-ref-sap location offset)))
(setf
(sap-ref-sap location offset)
- (reference-foreign class (proxy-location instance)))))
+ (reference-foreign class (foreign-location instance)))))
(defmethod reader-function ((class proxy-class) &rest args)
(declare (ignore args))
(declare (ignore args))
(values t nil))
-(defgeneric ensure-proxy-instance (class location)
- (:documentation "Returns a proxy object representing the foreign object at the give location."))
-
-(defmethod ensure-proxy-instance :around (class location)
+(defun ensure-proxy-instance (class location &rest initargs)
+ "Returns a proxy object representing the foreign object at the give
+location. If an existing object is not found in the cache
+MAKE-PROXY-INSTANCE is called to create one."
(unless (null-pointer-p location)
(or
- (find-cached-instance location)
- (call-next-method))))
-
-(defmethod ensure-proxy-instance ((class symbol) location)
- (ensure-proxy-instance (find-class class) location))
-
-(defmethod ensure-proxy-instance ((class proxy-class) location)
- (make-instance class :location location))
+ (let ((instance (find-cached-instance location)))
+ (when instance
+ (format t "Object found in cache: ~A~%" instance)
+ instance))
+ (let ((instance (apply #'make-proxy-instance class location initargs)))
+ (cache-instance instance)
+ instance))))
+
+(defgeneric make-proxy-instance (class location &key weak)
+ (:documentation "Creates a new proxy object representing the foreign
+object at the give location. If WEAK is non NIL the foreign memory
+will not be released when the proxy is garbage collected."))
+
+(defmethod make-proxy-instance ((class symbol) location &rest initargs)
+ (apply #'make-proxy-instance (find-class class) location initargs))
+
+(defmethod make-proxy-instance ((class proxy-class) location &key weak)
+ (let ((instance (allocate-instance class)))
+ (setf (slot-value instance 'location) location)
+ (unless weak
+ (finalize instance (instance-finalizer instance)))
+ instance))
;;;; Superclasses for wrapping of C structures
(defclass struct (proxy)
()
- (:metaclass proxy-class))
+ (:metaclass proxy-class)
+ (:size 0))
(defmethod initialize-instance ((struct struct) &rest initargs)
(declare (ignore initargs))
(unless (slot-boundp struct 'location)
- (let ((size (proxy-instance-size (class-of struct))))
+ (let ((size (foreign-size (class-of struct))))
(if (zerop size)
(error "~A has zero size" (class-of struct))
(setf (slot-value struct 'location) (allocate-memory size)))))
(defclass struct-class (proxy-class)
())
+(defmethod direct-slot-definition-class ((class struct-class) &rest initargs)
+ (if (not (getf initargs :allocation))
+ (find-class 'direct-alien-slot-definition)
+ (call-next-method)))
+
(defmethod reference-foreign ((class struct-class) location)
- (copy-memory location (proxy-instance-size class)))
+ (copy-memory location (foreign-size class)))
(defmethod unreference-foreign ((class struct-class) location)
(deallocate-memory location))
+(defmethod compute-foreign-size ((class struct-class))
+ (let ((size (loop
+ for slotd in (class-slots class)
+ when (eq (slot-definition-allocation slotd) :alien)
+ maximize (+
+ (slot-definition-offset slotd)
+ (size-of (slot-definition-type slotd))))))
+ (+ size (mod size +struct-alignmen+))))
+
+(defmethod weak-reader-function ((class struct-class) &rest args)
+ (declare (ignore args))
+ #'(lambda (location &optional (offset 0))
+ (let ((instance (sap-ref-sap location offset)))
+ (unless (null-pointer-p instance)
+ (ensure-proxy-instance class instance :weak t)))))
+
(defclass static-struct-class (struct-class)
())
(defmethod size-of ((type (eql 'inlined)) &rest args)
(declare (ignore type))
- (proxy-instance-size (first args)))
+ (foreign-size (first args)))
(defmethod reader-function ((type (eql 'inlined)) &rest args)
(declare (ignore type))
(ensure-proxy-instance class
(reference-foreign class (sap+ location offset))))))
+(defmethod writer-function ((type (eql 'inlined)) &rest args)
+ (declare (ignore type))
+ (destructuring-bind (class) args
+ #'(lambda (instance location &optional (offset 0))
+ (copy-memory (foreign-location instance) (foreign-size class) (sap+ location offset)))))
+
(defmethod destroy-function ((type (eql 'inlined)) &rest args)
(declare (ignore args))
#'(lambda (location &optional (offset 0))
~mdw / clg / blobdiff