\f
;;;; structure frobbing primitives
+;;; Allocate a new instance with LENGTH data slots.
(defun %make-instance (length)
- #!+sb-doc
- "Allocate a new instance with LENGTH data slots."
(declare (type index length))
(%make-instance length))
+;;; Given an instance, return its length.
(defun %instance-length (instance)
- #!+sb-doc
- "Given an instance, return its length."
(declare (type instance instance))
(%instance-length instance))
+;;; Return the value from the INDEXth slot of INSTANCE. This is SETFable.
(defun %instance-ref (instance index)
- #!+sb-doc
- "Return the value from the INDEXth slot of INSTANCE. This is SETFable."
(%instance-ref instance index))
+;;; Set the INDEXth slot of INSTANCE to NEW-VALUE.
(defun %instance-set (instance index new-value)
- #!+sb-doc
- "Set the INDEXth slot of INSTANCE to NEW-VALUE."
(setf (%instance-ref instance index) new-value))
(defun %raw-ref-single (vec index)
;;;
;;; The only loss is that if someone accesses the
;;; FUNCALLABLE-INSTANCE-FUN, then won't get a FIN back. This probably
-;;; doesn't matter, since PCL only sets the FIN function. And the only
-;;; reason that interpreted functions are FINs instead of bare
-;;; closures is for debuggability.
+;;; doesn't matter, since PCL only sets the FIN function.
(defun (setf funcallable-instance-fun) (new-value fin)
(setf (%funcallable-instance-fun fin)
(%closure-fun new-value))
(%funcallable-instance-lexenv new-value)
new-value)))
\f
+;;;; target-only parts of the DEFSTRUCT top-level code
+
+;;; Catch attempts to mess up definitions of symbols in the CL package.
+(defun protect-cl (symbol)
+ (/show0 "entering PROTECT-CL, SYMBOL=..")
+ (/hexstr symbol)
+ (when (and *cold-init-complete-p*
+ (eq (symbol-package symbol) *cl-package*))
+ (cerror "Go ahead and patch the system."
+ "attempting to modify a symbol in the COMMON-LISP package: ~S"
+ symbol))
+ (/show0 "leaving PROTECT-CL")
+ (values))
+
+;;; the part of %DEFSTRUCT which sets up out-of-line implementations
+;;; of those structure functions which are sufficiently similar
+;;; between structures that they can be closures
+;;;
+;;; (The "static" in the name is because it needs to be done not only
+;;; in ordinary toplevel %DEFSTRUCT, but also in cold init as early as
+;;; possible, to simulate static linking of structure functions as
+;;; nearly as possible.)
+(defun %target-defstruct (dd layout)
+ (declare (type defstruct-description dd))
+ (declare (type layout layout))
+
+ (/show0 "entering %TARGET-DEFSTRUCT")
+
+ ;; (Constructors aren't set up here, because constructors are
+ ;; varied enough (possibly parsing any specified argument list)
+ ;; that we can't reasonably implement them as closures, and so
+ ;; implement them with DEFUN instead.)
+
+ ;; Set FDEFINITIONs for slot accessors.
+ (dolist (dsd (dd-slots dd))
+ (/show0 "doing FDEFINITION for slot accessor")
+ (let ((accessor-name (dsd-accessor-name dsd)))
+ (/show0 "ACCESSOR-NAME=..")
+ (/hexstr accessor-name)
+ (protect-cl accessor-name)
+ (/hexstr "getting READER-FUN and WRITER-FUN")
+ (multiple-value-bind (reader-fun writer-fun) (slot-accessor-funs dd dsd)
+ (declare (type function reader-fun writer-fun))
+ (/show0 "got READER-FUN and WRITER-FUN=..")
+ (/hexstr reader-fun)
+ (setf (symbol-function accessor-name) reader-fun)
+ (unless (dsd-read-only dsd)
+ (/show0 "setting FDEFINITION for WRITER-FUN=..")
+ (/hexstr writer-fun)
+ (setf (fdefinition `(setf ,accessor-name)) writer-fun)))))
+
+ ;; Set FDEFINITION for copier.
+ (when (dd-copier-name dd)
+ (/show0 "doing FDEFINITION for copier")
+ (protect-cl (dd-copier-name dd))
+ ;; We can't use COPY-STRUCTURE for other kinds of objects, notably
+ ;; funcallable structures, since it returns a STRUCTURE-OBJECT.
+ ;; (And funcallable instances don't need copiers anyway.)
+ (aver (eql (dd-type dd) 'structure))
+ (setf (symbol-function (dd-copier-name dd))
+ ;; FIXME: should use a closure which checks arg type before copying
+ #'copy-structure))
+
+ ;; Set FDEFINITION for predicate.
+ (when (dd-predicate-name dd)
+ (/show0 "doing FDEFINITION for predicate")
+ (protect-cl (dd-predicate-name dd))
+ (setf (symbol-function (dd-predicate-name dd))
+ (ecase (dd-type dd)
+ ;; structures with LAYOUTs
+ ((structure funcallable-structure)
+ (/show0 "with-LAYOUT case")
+ (lambda (object)
+ (declare (optimize (speed 3) (safety 0)))
+ (/noshow0 "in with-LAYOUT structure predicate closure, OBJECT,LAYOUT=..")
+ (/nohexstr object)
+ (/nohexstr layout)
+ (typep-to-layout object layout)))
+ ;; structures with no LAYOUT (i.e. :TYPE VECTOR or :TYPE LIST)
+ ;;
+ ;; FIXME: should handle the :NAMED T case in these cases
+ (vector
+ (/show0 ":TYPE VECTOR case")
+ #'vectorp)
+ (list
+ (/show0 ":TYPE LIST case")
+ #'listp))))
+
+ (/show0 "leaving %TARGET-DEFSTRUCT")
+ (values))
+\f
;;; Copy any old kind of structure.
(defun copy-structure (structure)
#!+sb-doc
res))
\f
-;;; default PRINT and MAKE-LOAD-FORM methods
-
+;;; default PRINT-OBJECT and MAKE-LOAD-FORM methods
+
+(defun %default-structure-pretty-print (structure stream)
+ (let* ((layout (%instance-layout structure))
+ (name (sb!xc:class-name (layout-class layout)))
+ (dd (layout-info layout)))
+ (pprint-logical-block (stream nil :prefix "#S(" :suffix ")")
+ (prin1 name stream)
+ (let ((remaining-slots (dd-slots dd)))
+ (when remaining-slots
+ (write-char #\space stream)
+ ;; CMU CL had (PPRINT-INDENT :BLOCK 2 STREAM) here,
+ ;; but I can't see why. -- WHN 20000205
+ (pprint-newline :linear stream)
+ (loop
+ (pprint-pop)
+ (let ((slot (pop remaining-slots)))
+ (write-char #\: stream)
+ (output-symbol-name (dsd-%name slot) stream)
+ (write-char #\space stream)
+ (pprint-newline :miser stream)
+ (output-object (funcall (fdefinition (dsd-accessor-name slot))
+ structure)
+ stream)
+ (when (null remaining-slots)
+ (return))
+ (write-char #\space stream)
+ (pprint-newline :linear stream))))))))
+(defun %default-structure-ugly-print (structure stream)
+ (let* ((layout (%instance-layout structure))
+ (name (sb!xc:class-name (layout-class layout)))
+ (dd (layout-info layout)))
+ (descend-into (stream)
+ (write-string "#S(" stream)
+ (prin1 name stream)
+ (do ((index 0 (1+ index))
+ (remaining-slots (dd-slots dd) (cdr remaining-slots)))
+ ((or (null remaining-slots)
+ (and (not *print-readably*)
+ *print-length*
+ (>= index *print-length*)))
+ (if (null remaining-slots)
+ (write-string ")" stream)
+ (write-string " ...)" stream)))
+ (declare (type index index))
+ (write-char #\space stream)
+ (write-char #\: stream)
+ (let ((slot (first remaining-slots)))
+ (output-symbol-name (dsd-%name slot) stream)
+ (write-char #\space stream)
+ (output-object
+ (funcall (fdefinition (dsd-accessor-name slot))
+ structure)
+ stream))))))
(defun default-structure-print (structure stream depth)
(declare (ignore depth))
- (if (funcallable-instance-p structure)
- (print-unreadable-object (structure stream :identity t :type t))
- (let* ((type (%instance-layout structure))
- (name (sb!xc:class-name (layout-class type)))
- (dd (layout-info type)))
- (if *print-pretty*
- (pprint-logical-block (stream nil :prefix "#S(" :suffix ")")
- (prin1 name stream)
- (let ((slots (dd-slots dd)))
- (when slots
- (write-char #\space stream)
- ;; CMU CL had (PPRINT-INDENT :BLOCK 2 STREAM) here,
- ;; but I can't see why. -- WHN 20000205
- (pprint-newline :linear stream)
- (loop
- (pprint-pop)
- (let ((slot (pop slots)))
- (write-char #\: stream)
- (output-symbol-name (dsd-%name slot) stream)
- (write-char #\space stream)
- (pprint-newline :miser stream)
- (output-object
- (funcall (fdefinition (dsd-accessor-name slot))
- structure)
- stream)
- (when (null slots)
- (return))
- (write-char #\space stream)
- (pprint-newline :linear stream))))))
- (descend-into (stream)
- (write-string "#S(" stream)
- (prin1 name stream)
- (do ((index 0 (1+ index))
- (slots (dd-slots dd) (cdr slots)))
- ((or (null slots)
- (and (not *print-readably*)
- *print-length*
- (>= index *print-length*)))
- (if (null slots)
- (write-string ")" stream)
- (write-string " ...)" stream)))
- (declare (type index index))
- (write-char #\space stream)
- (write-char #\: stream)
- (let ((slot (first slots)))
- (output-symbol-name (dsd-%name slot) stream)
- (write-char #\space stream)
- (output-object
- (funcall (fdefinition (dsd-accessor-name slot))
- structure)
- stream))))))))
+ (cond ((funcallable-instance-p structure)
+ (print-unreadable-object (structure stream :identity t :type t)))
+ (*print-pretty*
+ (%default-structure-pretty-print structure stream))
+ (t
+ (%default-structure-ugly-print structure-stream))))
(def!method print-object ((x structure-object) stream)
(default-structure-print x stream *current-level*))
(error "stub: MAKE-LOAD-FORM-SAVING-SLOTS :SLOT-NAMES not implemented") ; KLUDGE
:just-dump-it-normally))
\f
+;;;; testing structure types
+
;;; Return true if OBJ is an object of the structure type
;;; corresponding to LAYOUT. This is called by the accessor closures,
-;;; which have a handle on the type's layout.
+;;; which have a handle on the type's LAYOUT.
;;;
;;; FIXME: This is fairly big, so it should probably become
;;; MAYBE-INLINE instead of INLINE. Or else we could fix things up so
#!-sb-fluid (declaim (inline typep-to-layout))
(defun typep-to-layout (obj layout)
(declare (type layout layout) (optimize (speed 3) (safety 0)))
+ (/noshow0 "entering TYPEP-TO-LAYOUT, OBJ,LAYOUT=..")
+ (/nohexstr obj)
+ (/nohexstr layout)
(when (layout-invalid layout)
(error "An obsolete structure accessor function was called."))
+ (/noshow0 "back from testing LAYOUT-INVALID LAYOUT")
;; FIXME: CMU CL used (%INSTANCEP OBJ) here. Check that
;; (TYPEP OBJ 'INSTANCE) is optimized to equally efficient code.
(and (typep obj 'instance)
(let ((obj-layout (%instance-layout obj)))
(cond ((eq obj-layout layout)
+ ;; (In this case OBJ-LAYOUT can't be invalid, because
+ ;; we determined LAYOUT is valid in the test above.)
+ (/noshow0 "EQ case")
t)
- ;; FIXME: Does the test for LAYOUT-INVALID really belong
- ;; after the test for EQ LAYOUT? Either explain why this
- ;; is, or change the order.
((layout-invalid obj-layout)
+ (/noshow0 "LAYOUT-INVALID case")
(error 'layout-invalid
:expected-type (layout-class obj-layout)
:datum obj))
(t
- (let ((depthoid (layout-depthoid layout)))
- (and (> (layout-depthoid obj-layout) depthoid)
- (eq (svref (layout-inherits obj-layout) depthoid)
- layout))))))))
+ (let ((depthoid (layout-depthoid layout)))
+ (/noshow0 "DEPTHOID case, DEPTHOID,LAYOUT-INHERITS=..")
+ (/nohexstr depthoid)
+ (/nohexstr layout-inherits)
+ (and (> (layout-depthoid obj-layout) depthoid)
+ (eq (svref (layout-inherits obj-layout) depthoid)
+ layout))))))))
\f
-;;;; implementing structure slot accessors as closures
-
-;;; In the normal case of structures that have a real type (i.e. no
-;;; :TYPE option was specified), we want to optimize things for space
-;;; as well as speed, since there can be thousands of defined slot
-;;; accessors.
-;;;
-;;; What we do is define the accessors and copier as closures over
-;;; general-case code. Since the compiler will normally open-code
-;;; accessors, the (minor) extra speed penalty for full calls is not a
-;;; concern.
-;;;
-;;; KLUDGE: This is a minor headache at cold init time, since genesis
-;;; doesn't know how to create the closures in the cold image, so the
-;;; function definitions aren't done until the appropriate top level
-;;; forms are executed, so any forward references to structure slots
-;;; (which are compiled into full calls) fail. The headache can be
-;;; treated by using SB!XC:DEFSTRUCT on the relevant structure at
-;;; build-the-cross-compiler time, so that the compiler is born
-;;; knowing how to inline accesses to the relevant structure, so no
-;;; full calls are made. This can be achieved by calling
-;;; SB!XC:DEFSTRUCT directly, or by using DEF!STRUCT, which (among
-;;; other things) calls SB!XC:DEFSTRUCT for you.
-
-;;; Return closures to do slot access according to Layout and DSD. We check
-;;; types, then do the access. This is only used for normal slots, not raw
-;;; slots.
-(defun structure-slot-getter (layout dsd)
- (let ((class (layout-class layout)))
- (if (typep class 'basic-structure-class)
- #'(lambda (structure)
- (declare (optimize (speed 3) (safety 0)))
- (flet ((structure-test (structure)
- (typep-to-layout structure layout)))
- (unless (structure-test structure)
- (error 'simple-type-error
- :datum structure
- :expected-type (class-name (layout-class layout))
- :format-control
- "Structure for accessor ~S is not a ~S:~% ~S"
- :format-arguments
- (list (dsd-accessor-name dsd)
- (sb!xc:class-name (layout-class layout))
- structure))))
- (%instance-ref structure (dsd-index dsd)))
- #'(lambda (structure)
- (declare (optimize (speed 3) (safety 0)))
- (unless (%typep structure class)
- (error 'simple-type-error
- :datum structure
- :expected-type 'class
+;;;; checking structure types
+
+;;; Check that X is an instance of the named structure type.
+(defmacro %check-structure-type-from-name (x name)
+ `(%check-structure-type-from-layout ,x ,(compiler-layout-or-lose name)))
+
+;;; Check that X is a structure of the type described by DD.
+(defmacro %check-structure-type-from-dd (x dd)
+ (declare (type defstruct-description dd))
+ (let ((class-name (dd-name dd)))
+ (ecase (dd-type dd)
+ ((structure funcallable-instance)
+ `(%check-structure-type-from-layout
+ ,x
+ ,(compiler-layout-or-lose class-name)))
+ ((vector)
+ (let ((xx (gensym "X")))
+ `(let ((,xx ,x))
+ (declare (type vector ,xx))
+ ,@(when (dd-named dd)
+ `((unless (eql (aref ,xx 0) ',class-name)
+ (error
+ 'simple-type-error
+ :datum (aref ,xx 0)
+ :expected-type `(member ,class-name)
:format-control
- "The structure for accessor ~S is not a ~S:~% ~S"
- :format-arguments
- (list (dsd-accessor-name dsd) class
- structure)))
- (%instance-ref structure (dsd-index dsd))))))
-(defun structure-slot-setter (layout dsd)
- (let ((class (layout-class layout)))
- (if (typep class 'basic-structure-class)
- #'(lambda (new-value structure)
- (declare (optimize (speed 3) (safety 0)))
- (flet ((structure-test (structure)
- (typep-to-layout structure layout))
- (typep-test (new-value)
- (%typep new-value (dsd-type dsd))))
- (unless (structure-test structure)
- (error 'simple-type-error
- :datum structure
- :expected-type (class-name (layout-class layout))
- :format-control
- "The structure for setter ~S is not a ~S:~% ~S"
- :format-arguments
- (list `(setf ,(dsd-accessor-name dsd))
- (sb!xc:class-name (layout-class layout))
- structure)))
- (unless (typep-test new-value)
- (error 'simple-type-error
- :datum new-value
- :expected-type (class-name (layout-class layout))
- :format-control
- "The new value for setter ~S is not a ~S:~% ~S"
- :format-arguments
- (list `(setf ,(dsd-accessor-name dsd))
- (dsd-type dsd)
- new-value))))
- (setf (%instance-ref structure (dsd-index dsd)) new-value))
- #'(lambda (new-value structure)
- (declare (optimize (speed 3) (safety 0)))
- (flet ((structure-test (structure)
- (sb!xc:typep structure class))
- (typep-test (new-value)
- (%typep new-value (dsd-type dsd))))
- (unless (structure-test structure)
- (error 'simple-type-error
- :datum structure
- :expected-type (class-name (layout-class layout))
- :format-control
- "The structure for setter ~S is not a ~S:~% ~S"
- :format-arguments
- (list `(setf ,(dsd-accessor-name dsd))
- (sb!xc:class-name class)
- structure)))
- (unless (typep-test new-value)
- (error 'simple-type-error
- :datum new-value
- :expected-type (class-name (layout-class layout))
- :format-control
- "The new value for setter ~S is not a ~S:~% ~S"
- :format-arguments
- (list `(setf ,(dsd-accessor-name dsd))
- (dsd-type dsd)
- new-value))))
- (setf (%instance-ref structure (dsd-index dsd)) new-value)))))
-
+ "~@<missing name in instance of ~
+ VECTOR-typed structure ~S: ~2I~_S~:>"
+ :format-arguments (list ',class-name ,xx)))))
+ (values))))
+ ((list)
+ (let ((xx (gensym "X")))
+ `(let ((,xx ,x))
+ (declare (type list ,xx))
+ ,@(when (dd-named dd)
+ `((unless (eql (first ,xx) ',class-name)
+ (error
+ 'simple-type-error
+ :datum (aref ,xx 0)
+ :expected-type `(member ,class-name)
+ :format-control
+ "~@<missing name in instance of LIST-typed structure ~S: ~
+ ~2I~_S~:>"
+ :format-arguments (list ',class-name ,xx)))))
+ (values)))))))
+
+;;; Check that X is an instance of the structure class with layout LAYOUT.
+(defun %check-structure-type-from-layout (x layout)
+ (unless (typep-to-layout x layout)
+ (error 'type-error
+ :datum x
+ :expected-type (class-name (layout-class layout))))
+ (values))
+\f
(/show0 "target-defstruct.lisp end of file")
projects / sbcl.git / blobdiff