X-Git-Url: http://repo.macrolet.net/gitweb/?a=blobdiff_plain;f=src%2Fcode%2Fdefstruct.lisp;h=56190514113c9ededd92acb6fff5a451f19a413f;hb=8af1983e6de2609fec800b6ac2bf3b12ff9c68b9;hp=ab9d722932bba91fedd6840f1a43aa627d39279d;hpb=89eb73c035f05ae53b1148ef8a83e1d4030b2dd8;p=sbcl.git diff --git a/src/code/defstruct.lisp b/src/code/defstruct.lisp index ab9d722..5619051 100644 --- a/src/code/defstruct.lisp +++ b/src/code/defstruct.lisp @@ -27,10 +27,36 @@ (t res)))) ;;; Delay looking for compiler-layout until the constructor is being -;;; compiled, since it doesn't exist until after the eval-when -;;; (compile) is compiled. +;;; compiled, since it doesn't exist until after the EVAL-WHEN +;;; (COMPILE) stuff is compiled. (Or, in the oddball case when +;;; DEFSTRUCT is executing in a non-toplevel context, the +;;; compiler-layout still doesn't exist at compilation time, and we +;;; delay still further.) (sb!xc:defmacro %delayed-get-compiler-layout (name) - `',(compiler-layout-or-lose name)) + (let ((layout (info :type :compiler-layout name))) + (cond (layout + ;; ordinary case: When the DEFSTRUCT is at top level, + ;; then EVAL-WHEN (COMPILE) stuff will have set up the + ;; layout for us to use. + (unless (typep (layout-info layout) 'defstruct-description) + (error "Class is not a structure class: ~S" name)) + `,layout) + (t + ;; KLUDGE: In the case that DEFSTRUCT is not at top-level + ;; the layout doesn't exist at compile time. In that case + ;; we laboriously look it up at run time. This code will + ;; run on every constructor call and will likely be quite + ;; slow, so if anyone cares about performance of + ;; non-toplevel DEFSTRUCTs, it should be rewritten to be + ;; cleverer. -- WHN 2002-10-23 + (sb!c::compiler-note + "implementation limitation: ~ + Non-toplevel DEFSTRUCT constructors are slow.") + (with-unique-names (layout) + `(let ((,layout (info :type :compiler-layout ',name))) + (unless (typep (layout-info ,layout) 'defstruct-description) + (error "Class is not a structure class: ~S" ',name)) + ,layout)))))) ;;; Get layout right away. (sb!xc:defmacro compile-time-find-layout (name) @@ -42,39 +68,46 @@ ;;; FIXME: Do we really need both? If so, their names and implementations ;;; should probably be tweaked to be more parallel. -;;; The DEFSTRUCT-DESCRIPTION structure holds compile-time information about a -;;; structure type. +;;;; DEFSTRUCT-DESCRIPTION + +;;; The DEFSTRUCT-DESCRIPTION structure holds compile-time information +;;; about a structure type. (def!struct (defstruct-description (:conc-name dd-) (:make-load-form-fun just-dump-it-normally) #-sb-xc-host (:pure t) - (:constructor make-defstruct-description (name))) + (:constructor make-defstruct-description + (name &aux + (conc-name (symbolicate name "-")) + (copier-name (symbolicate "COPY-" name)) + (predicate-name (symbolicate name "-P"))))) ;; name of the structure - (name (required-argument) :type symbol) + (name (missing-arg) :type symbol :read-only t) ;; documentation on the structure (doc nil :type (or string null)) ;; prefix for slot names. If NIL, none. - (conc-name (symbolicate name "-") :type (or symbol null)) + (conc-name nil :type (or symbol null)) ;; the name of the primary standard keyword constructor, or NIL if none (default-constructor nil :type (or symbol null)) ;; all the explicit :CONSTRUCTOR specs, with name defaulted (constructors () :type list) ;; name of copying function - (copier-name (symbolicate "COPY-" name) :type (or symbol null)) + (copier-name nil :type (or symbol null)) ;; name of type predicate - (predicate-name (symbolicate name "-P") :type (or symbol null)) + (predicate-name nil :type (or symbol null)) ;; the arguments to the :INCLUDE option, or NIL if no included ;; structure (include nil :type list) - ;; The arguments to the :ALTERNATE-METACLASS option (an extension - ;; used to define structure-like objects with an arbitrary - ;; superclass and that may not have STRUCTURE-CLASS as the - ;; metaclass.) Syntax is: + ;; properties used to define structure-like classes with an + ;; arbitrary superclass and that may not have STRUCTURE-CLASS as the + ;; metaclass. Syntax is: ;; (superclass-name metaclass-name metaclass-constructor) (alternate-metaclass nil :type list) ;; a list of DEFSTRUCT-SLOT-DESCRIPTION objects for all slots ;; (including included ones) (slots () :type list) + ;; a list of (NAME . INDEX) pairs for accessors of included structures + (inherited-accessor-alist () :type list) ;; number of elements we've allocated (See also RAW-LENGTH.) (length 0 :type index) ;; General kind of implementation. @@ -112,6 +145,28 @@ (print-unreadable-object (x stream :type t) (prin1 (dd-name x) stream))) +;;; Does DD describe a structure with a class? +(defun dd-class-p (dd) + (member (dd-type dd) + '(structure funcallable-structure))) + +;;; a type name which can be used when declaring things which operate +;;; on structure instances +(defun dd-declarable-type (dd) + (if (dd-class-p dd) + ;; Native classes are known to the type system, and we can + ;; declare them as types. + (dd-name dd) + ;; Structures layered on :TYPE LIST or :TYPE VECTOR aren't part + ;; of the type system, so all we can declare is the underlying + ;; LIST or VECTOR type. + (dd-type dd))) + +(defun dd-layout-or-lose (dd) + (compiler-layout-or-lose (dd-name dd))) + +;;;; DEFSTRUCT-SLOT-DESCRIPTION + ;;; A DEFSTRUCT-SLOT-DESCRIPTION holds compile-time information about ;;; a structure slot. (def!struct (defstruct-slot-description @@ -119,10 +174,10 @@ (:conc-name dsd-) (:copier nil) #-sb-xc-host (:pure t)) - ;; string name of slot - %name + ;; name of slot + name ;; its position in the implementation sequence - (index (required-argument) :type fixnum) + (index (missing-arg) :type fixnum) ;; the name of the accessor function ;; ;; (CMU CL had extra complexity here ("..or NIL if this accessor has @@ -132,6 +187,8 @@ (accessor-name nil) default ; default value expression (type t) ; declared type specifier + (safe-p t :type boolean) ; whether the slot is known to be + ; always of the specified type ;; If this object does not describe a raw slot, this value is T. ;; ;; If this object describes a raw slot, this value is the type of the @@ -147,18 +204,6 @@ (def!method print-object ((x defstruct-slot-description) stream) (print-unreadable-object (x stream :type t) (prin1 (dsd-name x) stream))) - -;;; Is DEFSTRUCT a structure with a class? -(defun dd-class-p (defstruct) - (member (dd-type defstruct) '(structure funcallable-structure))) - -;;; Return the name of a defstruct slot as a symbol. We store it as a -;;; string to avoid creating lots of worthless symbols at load time. -(defun dsd-name (dsd) - (intern (string (dsd-%name dsd)) - (if (dsd-accessor-name dsd) - (symbol-package (dsd-accessor-name dsd)) - (sane-package)))) ;;;; typed (non-class) structures @@ -168,6 +213,62 @@ (list 'list) (vector `(simple-array ,(dd-element-type defstruct) (*))))) +;;;; shared machinery for inline and out-of-line slot accessor functions + +(eval-when (#-sb-xc :compile-toplevel :load-toplevel :execute) + + ;; information about how a slot of a given DSD-RAW-TYPE is to be accessed + (defstruct raw-slot-data + ;; the raw slot type, or T for a non-raw slot + ;; + ;; (Raw slots are allocated in the raw slots array in a vector which + ;; the GC doesn't need to scavenge. Non-raw slots are in the + ;; ordinary place you'd expect, directly indexed off the instance + ;; pointer.) + (raw-type (missing-arg) :type (or symbol cons) :read-only t) + ;; What operator is used (on the raw data vector) to access a slot + ;; of this type? + (accessor-name (missing-arg) :type symbol :read-only t) + ;; How many words are each value of this type? (This is used to + ;; rescale the offset into the raw data vector.) + (n-words (missing-arg) :type (and index (integer 1)) :read-only t)) + + (defvar *raw-slot-data-list* + (list + ;; The compiler thinks that the raw data vector is a vector of + ;; word-sized unsigned bytes, so if the slot we want to access + ;; actually *is* an unsigned byte, it'll access the slot for us + ;; even if we don't lie to it at all, just let it use normal AREF. + (make-raw-slot-data :raw-type 'unsigned-byte + :accessor-name 'aref + :n-words 1) + ;; In the other cases, we lie to the compiler, making it use + ;; some low-level AREFish access in order to pun the hapless + ;; bits into some other-than-unsigned-byte meaning. + ;; + ;; "A lie can travel halfway round the world while the truth is + ;; putting on its shoes." -- Mark Twain + (make-raw-slot-data :raw-type 'single-float + :accessor-name '%raw-ref-single + :n-words 1) + (make-raw-slot-data :raw-type 'double-float + :accessor-name '%raw-ref-double + :n-words 2) + (make-raw-slot-data :raw-type 'complex-single-float + :accessor-name '%raw-ref-complex-single + :n-words 2) + (make-raw-slot-data :raw-type 'complex-double-float + :accessor-name '%raw-ref-complex-double + :n-words 4) + #!+long-float + (make-raw-slot-data :raw-type long-float + :accessor-name '%raw-ref-long + :n-words #!+x86 3 #!+sparc 4) + #!+long-float + (make-raw-slot-data :raw-type complex-long-float + :accessor-name '%raw-ref-complex-long + :n-words #!+x86 6 #!+sparc 8)))) + ;;;; the legendary DEFSTRUCT macro itself (both CL:DEFSTRUCT and its ;;;; close personal friend SB!XC:DEFSTRUCT) @@ -180,7 +281,7 @@ ;; class names which creates fast but non-cold-loadable, ;; non-compact code. In this context, we'd rather have ;; compact, cold-loadable code. -- WHN 19990928 - (declare (notinline sb!xc:find-class)) + (declare (notinline find-classoid)) ,@(let ((pf (dd-print-function defstruct)) (po (dd-print-object defstruct)) (x (gensym)) @@ -199,28 +300,27 @@ fun-name))) (cond ((not (eql pf 0)) `((def!method print-object ((,x ,name) ,s) - (funcall #',(farg pf) ,x ,s *current-level*)))) + (funcall #',(farg pf) + ,x + ,s + *current-level-in-print*)))) ((not (eql po 0)) `((def!method print-object ((,x ,name) ,s) (funcall #',(farg po) ,x ,s)))) (t nil)))) ,@(let ((pure (dd-pure defstruct))) (cond ((eq pure t) - `((setf (layout-pure (class-layout - (sb!xc:find-class ',name))) + `((setf (layout-pure (classoid-layout + (find-classoid ',name))) t))) ((eq pure :substructure) - `((setf (layout-pure (class-layout - (sb!xc:find-class ',name))) + `((setf (layout-pure (classoid-layout + (find-classoid ',name))) 0))))) ,@(let ((def-con (dd-default-constructor defstruct))) (when (and def-con (not (dd-alternate-metaclass defstruct))) - `((setf (structure-class-constructor (sb!xc:find-class ',name)) + `((setf (structure-classoid-constructor (find-classoid ',name)) #',def-con)))))))) -;;; FIXME: I really would like to make structure accessors less -;;; special, just ordinary inline functions. (Or perhaps inline -;;; functions with special compact implementations of their -;;; expansions, to avoid bloating the system.) ;;; shared logic for CL:DEFSTRUCT and SB!XC:DEFSTRUCT (defmacro !expander-for-defstruct (name-and-options @@ -237,16 +337,23 @@ (if (dd-class-p dd) (let ((inherits (inherits-for-structure dd))) `(progn + ;; Note we intentionally call %DEFSTRUCT first, and + ;; especially before %COMPILER-DEFSTRUCT. %DEFSTRUCT + ;; has the tests (and resulting CERROR) for collisions + ;; with LAYOUTs which already exist in the runtime. If + ;; there are any collisions, we want the user's + ;; response to CERROR to control what happens. + ;; Especially, if the user responds to the collision + ;; with ABORT, we don't want %COMPILER-DEFSTRUCT to + ;; modify the definition of the class. + (%defstruct ',dd ',inherits) (eval-when (:compile-toplevel :load-toplevel :execute) (%compiler-defstruct ',dd ',inherits)) - (%defstruct ',dd ',inherits) ,@(unless expanding-into-code-for-xc-host-p - (append (raw-accessor-definitions dd) - (predicate-definitions dd) - ;; FIXME: We've inherited from CMU CL nonparallel + (append ;; FIXME: We've inherited from CMU CL nonparallel ;; code for creating copiers for typed and untyped ;; structures. This should be fixed. - ;(copier-definition dd) + ;(copier-definition dd) (constructor-definitions dd) (class-method-definitions dd))) ',name)) @@ -299,119 +406,44 @@ ;;;; functions to generate code for various parts of DEFSTRUCT definitions -;;; Catch requests to mess up definitions in COMMON-LISP. -#-sb-xc-host -(eval-when (:compile-toplevel :load-toplevel :execute) - (defun protect-cl (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)))) - -;;; Return forms to define readers and writers for raw slots as inline -;;; functions. -(defun raw-accessor-definitions (dd) - (let* ((name (dd-name dd))) - (collect ((res)) - (dolist (slot (dd-slots dd)) - (let ((slot-type (dsd-type slot)) - (accessor-name (dsd-accessor-name slot)) - (argname (gensym "ARG")) - (nvname (gensym "NEW-VALUE-"))) - (multiple-value-bind (accessor offset data) - (slot-accessor-form dd slot argname) - ;; When accessor exists and is raw - (when (and accessor-name - (not (eq accessor-name '%instance-ref))) - (res `(declaim (inline ,accessor-name))) - (res `(declaim (ftype (function (,name) ,slot-type) - ,accessor-name))) - (res `(defun ,accessor-name (,argname) - ;; Note: The DECLARE here might seem redundant - ;; with the DECLAIM FTYPE above, but it's not: - ;; If we're not at toplevel, the PROCLAIM inside - ;; the DECLAIM doesn't get executed until after - ;; this function is compiled. - (declare (type ,name ,argname)) - (truly-the ,slot-type (,accessor ,data ,offset)))) - (unless (dsd-read-only slot) - (res `(declaim (inline (setf ,accessor-name)))) - (res `(declaim (ftype (function (,slot-type ,name) ,slot-type) - (setf ,accessor-name)))) - ;; FIXME: I rewrote this somewhat from the CMU CL definition. - ;; Do some basic tests to make sure that reading and writing - ;; raw slots still works correctly. - (res `(defun (setf ,accessor-name) (,nvname ,argname) - (declare (type ,name ,argname)) - (setf (,accessor ,data ,offset) ,nvname) - ,nvname))))))) - (res)))) +;;; First, a helper to determine whether a name names an inherited +;;; accessor. +(defun accessor-inherited-data (name defstruct) + (assoc name (dd-inherited-accessor-alist defstruct) :test #'eq)) -;;; Return a list of forms which create a predicate for an untyped DEFSTRUCT. -(defun predicate-definitions (dd) - (let ((pred (dd-predicate-name dd)) - (argname (gensym))) - (when pred - (if (eq (dd-type dd) 'funcallable-structure) - ;; FIXME: Why does this need to be special-cased for - ;; FUNCALLABLE-STRUCTURE? CMU CL did it, but without explanation. - ;; Could we do without it? What breaks if we do? Or could we - ;; perhaps get by with no predicates for funcallable structures? - `((declaim (inline ,pred)) - (defun ,pred (,argname) (typep ,argname ',(dd-name dd)))) - `((protect-cl ',pred) - (declaim (inline ,pred)) - (defun ,pred (,argname) - (declare (optimize (speed 3) (safety 0))) - (typep-to-layout ,argname - (compile-time-find-layout ,(dd-name dd))))))))) - -;;; Return a list of forms which create a predicate function for a typed -;;; DEFSTRUCT. +;;; Return a list of forms which create a predicate function for a +;;; typed DEFSTRUCT. (defun typed-predicate-definitions (defstruct) (let ((name (dd-name defstruct)) (predicate-name (dd-predicate-name defstruct)) (argname (gensym))) (when (and predicate-name (dd-named defstruct)) - (let ((ltype (dd-lisp-type defstruct))) + (let ((ltype (dd-lisp-type defstruct)) + (name-index (cdr (car (last (find-name-indices defstruct)))))) `((defun ,predicate-name (,argname) (and (typep ,argname ',ltype) + ,(cond + ((subtypep ltype 'list) + `(consp (nthcdr ,name-index (the ,ltype ,argname)))) + ((subtypep ltype 'vector) + `(= (length (the ,ltype ,argname)) + ,(dd-length defstruct))) + (t (bug "Uncatered-for lisp type in typed DEFSTRUCT: ~S." + ltype))) (eq (elt (the ,ltype ,argname) - ,(cdr (car (last (find-name-indices defstruct))))) + ,name-index) ',name)))))))) -;;; FIXME: We've inherited from CMU CL code to do typed structure copiers -;;; in a completely different way than untyped structure copiers. Fix this. -;;; (This function was my first attempt to fix this, but I stopped before -;;; figuring out how to install it completely and remove the parallel -;;; code which simply SETF's the FDEFINITION of the DD-COPIER name. -#| -;;; Return the copier definition for an untyped DEFSTRUCT. -(defun copier-definition (dd) - (when (and (dd-copier dd) - ;; FUNCALLABLE-STRUCTUREs don't need copiers, and this - ;; implementation wouldn't work for them anyway, since - ;; COPY-STRUCTURE returns a STRUCTURE-OBJECT and they're not. - (not (eq (dd-type info) 'funcallable-structure))) - (let ((argname (gensym))) - `(progn - (protect-cl ',(dd-copier dd)) - (defun ,(dd-copier dd) (,argname) - (declare (type ,(dd-name dd) ,argname)) - (copy-structure ,argname)))))) -|# - ;;; Return a list of forms to create a copier function of a typed DEFSTRUCT. (defun typed-copier-definitions (defstruct) (when (dd-copier-name defstruct) `((setf (fdefinition ',(dd-copier-name defstruct)) #'copy-seq) (declaim (ftype function ,(dd-copier-name defstruct)))))) -;;; Return a list of function definitions for accessing and setting the -;;; slots of a typed DEFSTRUCT. The functions are proclaimed to be inline, -;;; and the types of their arguments and results are declared as well. We -;;; count on the compiler to do clever things with ELT. +;;; Return a list of function definitions for accessing and setting +;;; the slots of a typed DEFSTRUCT. The functions are proclaimed to be +;;; inline, and the types of their arguments and results are declared +;;; as well. We count on the compiler to do clever things with ELT. (defun typed-accessor-definitions (defstruct) (collect ((stuff)) (let ((ltype (dd-lisp-type defstruct))) @@ -420,18 +452,26 @@ (index (dsd-index slot)) (slot-type `(and ,(dsd-type slot) ,(dd-element-type defstruct)))) - (stuff `(proclaim '(inline ,name (setf ,name)))) - ;; FIXME: The arguments in the next two DEFUNs should be - ;; gensyms. (Otherwise e.g. if NEW-VALUE happened to be the - ;; name of a special variable, things could get weird.) - (stuff `(defun ,name (structure) - (declare (type ,ltype structure)) - (the ,slot-type (elt structure ,index)))) - (unless (dsd-read-only slot) - (stuff - `(defun (setf ,name) (new-value structure) - (declare (type ,ltype structure) (type ,slot-type new-value)) - (setf (elt structure ,index) new-value))))))) + (let ((inherited (accessor-inherited-data name defstruct))) + (cond + ((not inherited) + (stuff `(proclaim '(inline ,name (setf ,name)))) + ;; FIXME: The arguments in the next two DEFUNs should + ;; be gensyms. (Otherwise e.g. if NEW-VALUE happened to + ;; be the name of a special variable, things could get + ;; weird.) + (stuff `(defun ,name (structure) + (declare (type ,ltype structure)) + (the ,slot-type (elt structure ,index)))) + (unless (dsd-read-only slot) + (stuff + `(defun (setf ,name) (new-value structure) + (declare (type ,ltype structure) (type ,slot-type new-value)) + (setf (elt structure ,index) new-value))))) + ((not (= (cdr inherited) index)) + (style-warn "~@" name (dsd-name slot)))))))) (stuff))) ;;;; parsing @@ -448,7 +488,7 @@ (name (dd-name dd))) (case (first option) (:conc-name - (destructuring-bind (conc-name) args + (destructuring-bind (&optional conc-name) args (setf (dd-conc-name dd) (if (symbolp conc-name) conc-name @@ -470,8 +510,6 @@ (when (dd-include dd) (error "more than one :INCLUDE option")) (setf (dd-include dd) args)) - (:alternate-metaclass - (setf (dd-alternate-metaclass dd) args)) (:print-function (require-no-print-options-so-far dd) (setf (dd-print-function dd) @@ -482,9 +520,7 @@ (the (or symbol cons) args))) (:type (destructuring-bind (type) args - (cond ((eq type 'funcallable-structure) - (setf (dd-type dd) type)) - ((member type '(list vector)) + (cond ((member type '(list vector)) (setf (dd-element-type dd) t) (setf (dd-type dd) type)) ((and (consp type) (eq (first type) 'vector)) @@ -505,17 +541,16 @@ (t (error "unknown DEFSTRUCT option:~% ~S" option))))) ;;; Given name and options, return a DD holding that info. -(eval-when (:compile-toplevel :load-toplevel :execute) (defun parse-defstruct-name-and-options (name-and-options) (destructuring-bind (name &rest options) name-and-options (aver name) ; A null name doesn't seem to make sense here. (let ((dd (make-defstruct-description name))) (dolist (option options) - (cond ((consp option) - (parse-1-dd-option option dd)) - ((eq option :named) + (cond ((eq option :named) (setf (dd-named dd) t)) - ((member option '(:constructor :copier :predicate :named)) + ((consp option) + (parse-1-dd-option option dd)) + ((member option '(:conc-name :constructor :copier :predicate)) (parse-1-dd-option (list option) dd)) (t (error "unrecognized DEFSTRUCT option: ~S" option)))) @@ -525,8 +560,13 @@ (when (dd-offset dd) (error ":OFFSET can't be specified unless :TYPE is specified.")) (unless (dd-include dd) + ;; FIXME: It'd be cleaner to treat no-:INCLUDE as defaulting + ;; to :INCLUDE STRUCTURE-OBJECT, and then let the general-case + ;; (INCF (DD-LENGTH DD) (DD-LENGTH included-DD)) logic take + ;; care of this. (Except that the :TYPE VECTOR and :TYPE + ;; LIST cases, with their :NAMED and un-:NAMED flavors, + ;; make that messy, alas.) (incf (dd-length dd)))) - (funcallable-structure) (t (require-no-print-options-so-far dd) (when (dd-named dd) @@ -535,7 +575,7 @@ (when offset (incf (dd-length dd) offset))))) (when (dd-include dd) - (do-dd-inclusion-stuff dd)) + (frob-dd-inclusion-stuff dd)) dd))) @@ -552,8 +592,6 @@ (dolist (slot-description slot-descriptions) (allocate-1-slot result (parse-1-dsd result slot-description))) result)) - -) ; EVAL-WHEN ;;;; stuff to parse slot descriptions @@ -562,7 +600,7 @@ ;;; that we modify to get the new slot. This is supplied when handling ;;; included slots. (defun parse-1-dsd (defstruct spec &optional - (slot (make-defstruct-slot-description :%name "" + (slot (make-defstruct-slot-description :name "" :index 0 :type t))) (multiple-value-bind (name default default-p type type-p read-only ro-p) @@ -584,14 +622,18 @@ spec)) spec)) - (when (find name (dd-slots defstruct) :test #'string= :key #'dsd-%name) + (when (find name (dd-slots defstruct) + :test #'string= + :key (lambda (x) (symbol-name (dsd-name x)))) (error 'simple-program-error :format-control "duplicate slot name ~S" :format-arguments (list name))) - (setf (dsd-%name slot) (string name)) + (setf (dsd-name slot) name) (setf (dd-slots defstruct) (nconc (dd-slots defstruct) (list slot))) - (let ((accessor-name (symbolicate (or (dd-conc-name defstruct) "") name)) + (let ((accessor-name (if (dd-conc-name defstruct) + (symbolicate (dd-conc-name defstruct) name) + name)) (predicate-name (dd-predicate-name defstruct))) (setf (dsd-accessor-name slot) accessor-name) (when (eql accessor-name predicate-name) @@ -605,10 +647,15 @@ (style-warn "~@" + this case. We'll overwrite the type predicate with the slot ~ + accessor, but you can't rely on this behavior, so it'd be wise to ~ + remove the ambiguity in your code.~@:>" accessor-name) - (setf (dd-predicate-name defstruct) nil))) + (setf (dd-predicate-name defstruct) nil)) + #-sb-xc-host + (when (and (fboundp accessor-name) + (not (accessor-inherited-data accessor-name defstruct))) + (style-warn "redefining ~S in DEFSTRUCT" accessor-name))) (when default-p (setf (dsd-default slot) default)) @@ -631,8 +678,9 @@ ;;; RAW? is true if TYPE should be stored in a raw slot. ;;; RAW-TYPE is the raw slot type, or NIL if no raw slot. ;;; WORDS is the number of words in the raw slot, or NIL if no raw slot. +;;; +;;; FIXME: This should use the data in *RAW-SLOT-DATA-LIST*. (defun structure-raw-slot-type-and-size (type) - (/noshow "in STRUCTURE-RAW-SLOT-TYPE-AND-SIZE" type (sb!xc:subtypep type 'fixnum)) (cond #+nil (;; FIXME: For now we suppress raw slots, since there are various ;; issues about the way that the cross-compiler handles them. @@ -641,7 +689,6 @@ ((and (sb!xc:subtypep type '(unsigned-byte 32)) (multiple-value-bind (fixnum? fixnum-certain?) (sb!xc:subtypep type 'fixnum) - (/noshow fixnum? fixnum-certain?) ;; (The extra test for FIXNUM-CERTAIN? here is ;; intended for bootstrapping the system. In ;; particular, in sbcl-0.6.2, we set up LAYOUT before @@ -676,7 +723,6 @@ (if (eq (dd-type dd) 'structure) (structure-raw-slot-type-and-size (dsd-type dsd)) (values nil nil nil)) - (/noshow "ALLOCATE-1-SLOT" dsd raw? raw-type words) (cond ((not raw?) (setf (dsd-index dsd) (dd-length dd)) (incf (dd-length dd))) @@ -698,18 +744,36 @@ ;;; Process any included slots pretty much like they were specified. ;;; Also inherit various other attributes. -(defun do-dd-inclusion-stuff (dd) +(defun frob-dd-inclusion-stuff (dd) (destructuring-bind (included-name &rest modified-slots) (dd-include dd) (let* ((type (dd-type dd)) (included-structure (if (dd-class-p dd) (layout-info (compiler-layout-or-lose included-name)) (typed-structure-info-or-lose included-name)))) + + ;; checks on legality (unless (and (eq type (dd-type included-structure)) (type= (specifier-type (dd-element-type included-structure)) (specifier-type (dd-element-type dd)))) (error ":TYPE option mismatch between structures ~S and ~S" (dd-name dd) included-name)) + (let ((included-classoid (find-classoid included-name nil))) + (when included-classoid + ;; It's not particularly well-defined to :INCLUDE any of the + ;; CMU CL INSTANCE weirdosities like CONDITION or + ;; GENERIC-FUNCTION, and it's certainly not ANSI-compliant. + (let* ((included-layout (classoid-layout included-classoid)) + (included-dd (layout-info included-layout))) + (when (and (dd-alternate-metaclass included-dd) + ;; As of sbcl-0.pre7.73, anyway, STRUCTURE-OBJECT + ;; is represented with an ALTERNATE-METACLASS. But + ;; it's specifically OK to :INCLUDE (and PCL does) + ;; so in this one case, it's OK to include + ;; something with :ALTERNATE-METACLASS after all. + (not (eql included-name 'structure-object))) + (error "can't :INCLUDE class ~S (has alternate metaclass)" + included-name))))) (incf (dd-length dd) (dd-length included-structure)) (when (dd-class-p dd) @@ -722,12 +786,26 @@ (setf (dd-raw-index dd) (dd-raw-index included-structure)) (setf (dd-raw-length dd) (dd-raw-length included-structure))) + (setf (dd-inherited-accessor-alist dd) + (dd-inherited-accessor-alist included-structure)) (dolist (included-slot (dd-slots included-structure)) (let* ((included-name (dsd-name included-slot)) (modified (or (find included-name modified-slots - :key #'(lambda (x) (if (atom x) x (car x))) + :key (lambda (x) (if (atom x) x (car x))) :test #'string=) `(,included-name)))) + ;; We stash away an alist of accessors to parents' slots + ;; that have already been created to avoid conflicts later + ;; so that structures with :INCLUDE and :CONC-NAME (and + ;; other edge cases) can work as specified. + (when (dsd-accessor-name included-slot) + ;; the "oldest" (i.e. highest up the tree of inheritance) + ;; will prevail, so don't push new ones on if they + ;; conflict. + (pushnew (cons (dsd-accessor-name included-slot) + (dsd-index included-slot)) + (dd-inherited-accessor-alist dd) + :test #'eq :key #'car)) (parse-1-dsd dd modified (copy-structure included-slot))))))) @@ -743,93 +821,50 @@ (super (if include (compiler-layout-or-lose (first include)) - (class-layout (sb!xc:find-class - (or (first superclass-opt) - 'structure-object)))))) - (if (eq (dd-name info) 'lisp-stream) - ;; a hack to added the stream class as a mixin for LISP-STREAMs + (classoid-layout (find-classoid + (or (first superclass-opt) + 'structure-object)))))) + (if (eq (dd-name info) 'ansi-stream) + ;; a hack to add the CL:STREAM class as a mixin for ANSI-STREAMs (concatenate 'simple-vector (layout-inherits super) (vector super - (class-layout (sb!xc:find-class 'stream)))) + (classoid-layout (find-classoid 'stream)))) (concatenate 'simple-vector (layout-inherits super) (vector super))))) ;;; Do miscellaneous (LOAD EVAL) time actions for the structure -;;; described by INFO. Create the class & layout, checking for -;;; incompatible redefinition. Define setters, accessors, copier, -;;; predicate, documentation, instantiate definition in load-time env. -;;; This is only called for default structures. -(defun %defstruct (info inherits) - (declare (type defstruct-description info)) - (multiple-value-bind (class layout old-layout) - (ensure-structure-class info inherits "current" "new") +;;; described by DD. Create the class and LAYOUT, checking for +;;; incompatible redefinition. Define those functions which are +;;; sufficiently stereotyped that we can implement them as standard +;;; closures. +(defun %defstruct (dd inherits) + (declare (type defstruct-description dd)) + + ;; We set up LAYOUTs even in the cross-compilation host. + (multiple-value-bind (classoid layout old-layout) + (ensure-structure-class dd inherits "current" "new") (cond ((not old-layout) - (unless (eq (class-layout class) layout) + (unless (eq (classoid-layout classoid) layout) (register-layout layout))) (t - (let ((old-info (layout-info old-layout))) - (when (defstruct-description-p old-info) - (dolist (slot (dd-slots old-info)) + (let ((old-dd (layout-info old-layout))) + (when (defstruct-description-p old-dd) + (dolist (slot (dd-slots old-dd)) (fmakunbound (dsd-accessor-name slot)) (unless (dsd-read-only slot) (fmakunbound `(setf ,(dsd-accessor-name slot))))))) - (%redefine-defstruct class old-layout layout) - (setq layout (class-layout class)))) + (%redefine-defstruct classoid old-layout layout) + (setq layout (classoid-layout classoid)))) + (setf (find-classoid (dd-name dd)) classoid) - (setf (sb!xc:find-class (dd-name info)) class) - - ;; Set FDEFINITIONs for structure accessors, setters, predicates, - ;; and copiers. + ;; Various other operations only make sense on the target SBCL. #-sb-xc-host - (unless (eq (dd-type info) 'funcallable-structure) - - (dolist (slot (dd-slots info)) - (let ((dsd slot)) - (when (and (dsd-accessor-name slot) - (eq (dsd-raw-type slot) t)) - (protect-cl (dsd-accessor-name slot)) - (setf (symbol-function (dsd-accessor-name slot)) - (structure-slot-getter layout dsd)) - (unless (dsd-read-only slot) - (setf (fdefinition `(setf ,(dsd-accessor-name slot))) - (structure-slot-setter layout dsd)))))) - - ;; FIXME: Someday it'd probably be good to go back to using - ;; closures for the out-of-line forms of structure accessors. - #| - (when (dd-predicate info) - (protect-cl (dd-predicate info)) - (setf (symbol-function (dd-predicate info)) - #'(lambda (object) - (declare (optimize (speed 3) (safety 0))) - (typep-to-layout object layout)))) - |# - - (when (dd-copier-name info) - (protect-cl (dd-copier-name info)) - (setf (symbol-function (dd-copier-name info)) - #'(lambda (structure) - (declare (optimize (speed 3) (safety 0))) - (flet ((layout-test (structure) - (typep-to-layout structure layout))) - (unless (layout-test structure) - (error 'simple-type-error - :datum structure - :expected-type '(satisfies layout-test) - :format-control - "Structure for copier is not a ~S:~% ~S" - :format-arguments - (list (sb!xc:class-name (layout-class layout)) - structure)))) - (copy-structure structure)))))) - - (when (dd-doc info) - (setf (fdocumentation (dd-name info) 'type) (dd-doc info))) + (%target-defstruct dd layout)) (values)) - + ;;; Return a form describing the writable place used for this slot ;;; in the instance named INSTANCE-NAME. (defun %accessor-place-form (dd dsd instance-name) @@ -837,52 +872,57 @@ ;; the case of a raw slot, to read the vector of raw slots (ref (ecase (dd-type dd) (structure '%instance-ref) - (funcallable-structure '%funcallable-instance-info) (list 'nth-but-with-sane-arg-order) (vector 'aref))) (raw-type (dsd-raw-type dsd))) (if (eq raw-type t) ; if not raw slot `(,ref ,instance-name ,(dsd-index dsd)) - (let (;; the operator that we'll use to access one value in - ;; the raw data vector - (rawref (ecase raw-type - ;; The compiler thinks that the raw data - ;; vector is a vector of unsigned bytes, so if - ;; the slot we want to access actually *is* an - ;; unsigned byte, it'll access the slot for - ;; us even if we don't lie to it at all. - (unsigned-byte 'aref) - ;; "A lie can travel halfway round the world while - ;; the truth is putting on its shoes." -- Mark Twain - (single-float '%raw-ref-single) - (double-float '%raw-ref-double) - #!+long-float (long-float '%raw-ref-long) - (complex-single-float '%raw-ref-complex-single) - (complex-double-float '%raw-ref-complex-double) - #!+long-float (complex-long-float - '%raw-ref-complex-long)))) - `(,rawref (,ref ,instance-name ,(dd-raw-index dd)) - ,(dsd-index dsd)))))) + (let* ((raw-slot-data (find raw-type *raw-slot-data-list* + :key #'raw-slot-data-raw-type + :test #'equal)) + (raw-slot-accessor (raw-slot-data-accessor-name raw-slot-data)) + (raw-n-words (raw-slot-data-n-words raw-slot-data))) + (multiple-value-bind (scaled-dsd-index misalignment) + (floor (dsd-index dsd) raw-n-words) + (aver (zerop misalignment)) + `(,raw-slot-accessor (,ref ,instance-name ,(dd-raw-index dd)) + ,scaled-dsd-index)))))) ;;; Return inline expansion designators (i.e. values suitable for -;;; (INFO :FUNCTION :INLINE-EXPANSSION-DESIGNATOR ..)) for the reader +;;; (INFO :FUNCTION :INLINE-EXPANSION-DESIGNATOR ..)) for the reader ;;; and writer functions of the slot described by DSD. -(defun accessor-inline-expansion-designators (dd dsd) - (values (lambda () - `(lambda (instance) - (declare (type ,(dd-name dd) instance)) - (truly-the ,(dsd-type dsd) - ,(%accessor-place-form dd dsd 'instance)))) - (lambda () - `(lambda (new-value instance) - (declare (type ,(dsd-type dsd) new-value)) - (declare (type ,(dd-name dd) structure-object)) - (setf ,(%accessor-place-form dd dsd 'instance) new-value))))) - -;;; Do (COMPILE LOAD EVAL)-time actions for the defstruct described by DD. -(defun %compiler-defstruct (dd inherits) - (declare (type defstruct-description dd)) - (multiple-value-bind (class layout old-layout) +(defun slot-accessor-inline-expansion-designators (dd dsd) + (let ((instance-type-decl `(declare (type ,(dd-name dd) instance))) + (accessor-place-form (%accessor-place-form dd dsd 'instance)) + (dsd-type (dsd-type dsd)) + (value-the (if (dsd-safe-p dsd) 'truly-the 'the))) + (values (lambda () `(lambda (instance) + ,instance-type-decl + (,value-the ,dsd-type ,accessor-place-form))) + (lambda () `(lambda (new-value instance) + (declare (type ,dsd-type new-value)) + ,instance-type-decl + (setf ,accessor-place-form new-value)))))) + +;;; Return a LAMBDA form which can be used to set a slot. +(defun slot-setter-lambda-form (dd dsd) + (funcall (nth-value 1 + (slot-accessor-inline-expansion-designators dd dsd)))) + +;;; core compile-time setup of any class with a LAYOUT, used even by +;;; !DEFSTRUCT-WITH-ALTERNATE-METACLASS weirdosities +(defun %compiler-set-up-layout (dd + &optional + ;; Several special cases (STRUCTURE-OBJECT + ;; itself, and structures with alternate + ;; metaclasses) call this function directly, + ;; and they're all at the base of the + ;; instance class structure, so this is + ;; a handy default. + (inherits (vector (find-layout t) + (find-layout 'instance)))) + + (multiple-value-bind (classoid layout old-layout) (multiple-value-bind (clayout clayout-p) (info :type :compiler-layout (dd-name dd)) (ensure-structure-class dd @@ -891,62 +931,102 @@ "compiled" :compiler-layout clayout)) (cond (old-layout - (undefine-structure (layout-class old-layout)) - (when (and (class-subclasses class) + (undefine-structure (layout-classoid old-layout)) + (when (and (classoid-subclasses classoid) (not (eq layout old-layout))) (collect ((subs)) - (dohash (class layout (class-subclasses class)) + (dohash (classoid layout (classoid-subclasses classoid)) (declare (ignore layout)) - (undefine-structure class) - (subs (class-proper-name class))) + (undefine-structure classoid) + (subs (classoid-proper-name classoid))) (when (subs) (warn "removing old subclasses of ~S:~% ~S" - (sb!xc:class-name class) + (classoid-name classoid) (subs)))))) (t - (unless (eq (class-layout class) layout) + (unless (eq (classoid-layout classoid) layout) (register-layout layout :invalidate nil)) - (setf (sb!xc:find-class (dd-name dd)) class))) + (setf (find-classoid (dd-name dd)) classoid))) + + ;; At this point the class should be set up in the INFO database. + ;; But the logic that enforces this is a little tangled and + ;; scattered, so it's not obvious, so let's check. + (aver (find-classoid (dd-name dd) nil)) (setf (info :type :compiler-layout (dd-name dd)) layout)) - (let* ((dd-name (dd-name dd)) - (class (sb!xc:find-class dd-name))) + (values)) + +;;; Do (COMPILE LOAD EVAL)-time actions for the normal (not +;;; ALTERNATE-LAYOUT) DEFSTRUCT described by DD. +(defun %compiler-defstruct (dd inherits) + (declare (type defstruct-description dd)) + + (%compiler-set-up-layout dd inherits) + + (let* ((dtype (dd-declarable-type dd))) (let ((copier-name (dd-copier-name dd))) (when copier-name - (sb!xc:proclaim `(ftype (function (,dd-name) ,dd-name) ,copier-name)))) + (sb!xc:proclaim `(ftype (function (,dtype) ,dtype) ,copier-name)))) (let ((predicate-name (dd-predicate-name dd))) (when predicate-name - (sb!xc:proclaim `(ftype (function (t) t) ,predicate-name)))) + (sb!xc:proclaim `(ftype (function (t) t) ,predicate-name)) + ;; Provide inline expansion (or not). + (ecase (dd-type dd) + ((structure funcallable-structure) + ;; Let the predicate be inlined. + (setf (info :function :inline-expansion-designator predicate-name) + (lambda () + `(lambda (x) + ;; This dead simple definition works because the + ;; type system knows how to generate inline type + ;; tests for instances. + (typep x ',(dd-name dd)))) + (info :function :inlinep predicate-name) + :inline)) + ((list vector) + ;; Just punt. We could provide inline expansions for :TYPE + ;; LIST and :TYPE VECTOR predicates too, but it'd be a + ;; little messier and we don't bother. (Does anyway use + ;; typed DEFSTRUCTs at all, let alone for high + ;; performance?) + )))) (dolist (dsd (dd-slots dd)) (let* ((accessor-name (dsd-accessor-name dsd)) (dsd-type (dsd-type dsd))) (when accessor-name - (multiple-value-bind (reader-designator writer-designator) - (accessor-inline-expansion-designators dd dsd) - (sb!xc:proclaim `(ftype (function (,dd-name) ,dsd-type) - ,accessor-name)) - (setf (info :function - :inline-expansion-designator - accessor-name) - reader-designator - (info :function :inlinep accessor-name) - :inline) - (unless (dsd-read-only dsd) - (let ((setf-accessor-name `(setf ,accessor-name))) - (sb!xc:proclaim - `(ftype (function (,dsd-type ,dd-name) ,dsd-type) - ,setf-accessor-name)) - (setf (info :function - :inline-expansion-designator - setf-accessor-name) - writer-designator - (info :function :inlinep setf-accessor-name) - :inline)))))))) - + (let ((inherited (accessor-inherited-data accessor-name dd))) + (cond + ((not inherited) + (multiple-value-bind (reader-designator writer-designator) + (slot-accessor-inline-expansion-designators dd dsd) + (sb!xc:proclaim `(ftype (function (,dtype) ,dsd-type) + ,accessor-name)) + (setf (info :function :inline-expansion-designator + accessor-name) + reader-designator + (info :function :inlinep accessor-name) + :inline) + (unless (dsd-read-only dsd) + (let ((setf-accessor-name `(setf ,accessor-name))) + (sb!xc:proclaim + `(ftype (function (,dsd-type ,dtype) ,dsd-type) + ,setf-accessor-name)) + (setf (info :function + :inline-expansion-designator + setf-accessor-name) + writer-designator + (info :function :inlinep setf-accessor-name) + :inline))))) + ((not (= (cdr inherited) (dsd-index dsd))) + (style-warn "~@" + accessor-name + (dsd-name dsd))))))))) (values)) ;;;; redefinition stuff @@ -963,24 +1043,23 @@ (collect ((moved) (retyped)) (dolist (name (intersection onames nnames)) - (let ((os (find name oslots :key #'dsd-name)) - (ns (find name nslots :key #'dsd-name))) - (unless (subtypep (dsd-type ns) (dsd-type os)) - (/noshow "found retyped slots" ns os (dsd-type ns) (dsd-type os)) + (let ((os (find name oslots :key #'dsd-name :test #'string=)) + (ns (find name nslots :key #'dsd-name :test #'string=))) + (unless (sb!xc:subtypep (dsd-type ns) (dsd-type os)) (retyped name)) (unless (and (= (dsd-index os) (dsd-index ns)) (eq (dsd-raw-type os) (dsd-raw-type ns))) (moved name)))) (values (moved) (retyped) - (set-difference onames nnames))))) + (set-difference onames nnames :test #'string=))))) ;;; If we are redefining a structure with different slots than in the ;;; currently loaded version, give a warning and return true. -(defun redefine-structure-warning (class old new) +(defun redefine-structure-warning (classoid old new) (declare (type defstruct-description old new) - (type sb!xc:class class) - (ignore class)) + (type classoid classoid) + (ignore classoid)) (let ((name (dd-name new))) (multiple-value-bind (moved retyped deleted) (compare-slots old new) (when (or moved retyped deleted) @@ -994,26 +1073,45 @@ t)))) ;;; This function is called when we are incompatibly redefining a -;;; structure Class to have the specified New-Layout. We signal an +;;; structure CLASS to have the specified NEW-LAYOUT. We signal an ;;; error with some proceed options and return the layout that should ;;; be used. -(defun %redefine-defstruct (class old-layout new-layout) - (declare (type sb!xc:class class) (type layout old-layout new-layout)) - (let ((name (class-proper-name class))) +(defun %redefine-defstruct (classoid old-layout new-layout) + (declare (type classoid classoid) + (type layout old-layout new-layout)) + (let ((name (classoid-proper-name classoid))) (restart-case - (error "redefining class ~S incompatibly with the current definition" + (error "~@" + 'structure-object name) (continue () - :report "Invalidate current definition." - (warn "Previously loaded ~S accessors will no longer work." name) - (register-layout new-layout)) + :report (lambda (s) + (format s + "~@" + name)) + (register-layout new-layout)) + (recklessly-continue () + :report (lambda (s) + (format s + "~@" + name)) + ;; classic CMU CL warning: "Any old ~S instances will be in a bad way. + ;; I hope you know what you're doing..." + (register-layout new-layout + :invalidate nil + :destruct-layout old-layout)) (clobber-it () - :report "Smash current layout, preserving old code." - (warn "Any old ~S instances will be in a bad way.~@ - I hope you know what you're doing..." - name) - (register-layout new-layout :invalidate nil - :destruct-layout old-layout)))) + ;; FIXME: deprecated 2002-10-16, and since it's only interactive + ;; hackery instead of a supported feature, can probably be deleted + ;; in early 2003 + :report "(deprecated synonym for RECKLESSLY-CONTINUE)" + (register-layout new-layout + :invalidate nil + :destruct-layout old-layout)))) (values)) ;;; This is called when we are about to define a structure class. It @@ -1028,24 +1126,25 @@ (destructuring-bind (&optional name - (class 'sb!xc:structure-class) - (constructor 'make-structure-class)) + (class 'structure-classoid) + (constructor 'make-structure-classoid)) (dd-alternate-metaclass info) (declare (ignore name)) - (insured-find-class (dd-name info) - (if (eq class 'sb!xc:structure-class) - (lambda (x) - (typep x 'sb!xc:structure-class)) - (lambda (x) - (sb!xc:typep x (sb!xc:find-class class)))) - (fdefinition constructor))) - (setf (class-direct-superclasses class) - (if (eq (dd-name info) 'lisp-stream) - ;; a hack to add STREAM as a superclass mixin to LISP-STREAMs - (list (layout-class (svref inherits (1- (length inherits)))) - (layout-class (svref inherits (- (length inherits) 2)))) - (list (layout-class (svref inherits (1- (length inherits))))))) - (let ((new-layout (make-layout :class class + (insured-find-classoid (dd-name info) + (if (eq class 'structure-classoid) + (lambda (x) + (sb!xc:typep x 'structure-classoid)) + (lambda (x) + (sb!xc:typep x (find-classoid class)))) + (fdefinition constructor))) + (setf (classoid-direct-superclasses class) + (if (eq (dd-name info) 'ansi-stream) + ;; a hack to add CL:STREAM as a superclass mixin to ANSI-STREAMs + (list (layout-classoid (svref inherits (1- (length inherits)))) + (layout-classoid (svref inherits (- (length inherits) 2)))) + (list (layout-classoid + (svref inherits (1- (length inherits))))))) + (let ((new-layout (make-layout :classoid class :inherits inherits :depthoid (length inherits) :length (dd-length info) @@ -1057,7 +1156,7 @@ (;; This clause corresponds to an assertion in REDEFINE-LAYOUT-WARNING ;; of classic CMU CL. I moved it out to here because it was only ;; exercised in this code path anyway. -- WHN 19990510 - (not (eq (layout-class new-layout) (layout-class old-layout))) + (not (eq (layout-classoid new-layout) (layout-classoid old-layout))) (error "shouldn't happen: weird state of OLD-LAYOUT?")) ((not *type-system-initialized*) (setf (layout-info old-layout) info) @@ -1090,17 +1189,19 @@ ;;; over this type, clearing the compiler structure type info, and ;;; undefining all the associated functions. (defun undefine-structure (class) - (let ((info (layout-info (class-layout class)))) + (let ((info (layout-info (classoid-layout class)))) (when (defstruct-description-p info) (let ((type (dd-name info))) + (remhash type *typecheckfuns*) (setf (info :type :compiler-layout type) nil) (undefine-fun-name (dd-copier-name info)) (undefine-fun-name (dd-predicate-name info)) (dolist (slot (dd-slots info)) (let ((fun (dsd-accessor-name slot))) - (undefine-fun-name fun) - (unless (dsd-read-only slot) - (undefine-fun-name `(setf ,fun)))))) + (unless (accessor-inherited-data fun info) + (undefine-fun-name fun) + (unless (dsd-read-only slot) + (undefine-fun-name `(setf ,fun))))))) ;; Clear out the SPECIFIER-TYPE cache so that subsequent ;; references are unknown types. (values-specifier-type-cache-clear))) @@ -1128,145 +1229,78 @@ (res))) -;;;; slot accessors for raw slots - -;;; Return info about how to read/write a slot in the value stored in -;;; OBJECT. This is also used by constructors (since we can't safely -;;; use the accessor function, since some slots are read-only). If -;;; supplied, DATA is a variable holding the raw-data vector. -;;; -;;; returned values: -;;; 1. accessor function name (SETFable) -;;; 2. index to pass to accessor. -;;; 3. object form to pass to accessor -(defun slot-accessor-form (defstruct slot object &optional data) - (let ((rtype (dsd-raw-type slot))) - (values - (ecase rtype - (single-float '%raw-ref-single) - (double-float '%raw-ref-double) - #!+long-float - (long-float '%raw-ref-long) - (complex-single-float '%raw-ref-complex-single) - (complex-double-float '%raw-ref-complex-double) - #!+long-float - (complex-long-float '%raw-ref-complex-long) - (unsigned-byte 'aref) - ((t) - (if (eq (dd-type defstruct) 'funcallable-structure) - '%funcallable-instance-info - '%instance-ref))) - (case rtype - #!+long-float - (complex-long-float - (truncate (dsd-index slot) #!+x86 6 #!+sparc 8)) - #!+long-float - (long-float - (truncate (dsd-index slot) #!+x86 3 #!+sparc 4)) - (double-float - (ash (dsd-index slot) -1)) - (complex-double-float - (ash (dsd-index slot) -2)) - (complex-single-float - (ash (dsd-index slot) -1)) - (t - (dsd-index slot))) - (cond - ((eq rtype t) object) - (data) - (t - `(truly-the (simple-array (unsigned-byte 32) (*)) - (%instance-ref ,object ,(dd-raw-index defstruct)))))))) - ;;; These functions are called to actually make a constructor after we ;;; have processed the arglist. The correct variant (according to the ;;; DD-TYPE) should be called. The function is defined with the -;;; specified name and arglist. Vars and Types are used for argument -;;; type declarations. Values are the values for the slots (in order.) +;;; specified name and arglist. VARS and TYPES are used for argument +;;; type declarations. VALUES are the values for the slots (in order.) ;;; -;;; This is split four ways because: -;;; 1] list & vector structures need "name" symbols stuck in at -;;; various weird places, whereas STRUCTURE structures have -;;; a LAYOUT slot. -;;; 2] We really want to use LIST to make list structures, instead of -;;; MAKE-LIST/(SETF ELT). -;;; 3] STRUCTURE structures can have raw slots that must also be -;;; allocated and indirectly referenced. We use SLOT-ACCESSOR-FORM -;;; to compute how to set the slots, which deals with raw slots. -;;; 4] Funcallable structures are weird. -(defun create-vector-constructor - (defstruct cons-name arglist vars types values) +;;; This is split three ways because: +;;; * LIST & VECTOR structures need "name" symbols stuck in at +;;; various weird places, whereas STRUCTURE structures have +;;; a LAYOUT slot. +;;; * We really want to use LIST to make list structures, instead of +;;; MAKE-LIST/(SETF ELT). (We can't in general use VECTOR in an +;;; analogous way, since VECTOR makes a SIMPLE-VECTOR and vector-typed +;;; structures can have arbitrary subtypes of VECTOR, not necessarily +;;; SIMPLE-VECTOR.) +;;; * STRUCTURE structures can have raw slots that must also be +;;; allocated and indirectly referenced. +(defun create-vector-constructor (dd cons-name arglist vars types values) (let ((temp (gensym)) - (etype (dd-element-type defstruct))) + (etype (dd-element-type dd))) `(defun ,cons-name ,arglist - (declare ,@(mapcar #'(lambda (var type) `(type (and ,type ,etype) ,var)) + (declare ,@(mapcar (lambda (var type) `(type (and ,type ,etype) ,var)) vars types)) - (let ((,temp (make-array ,(dd-length defstruct) - :element-type ',(dd-element-type defstruct)))) - ,@(mapcar #'(lambda (x) - `(setf (aref ,temp ,(cdr x)) ',(car x))) - (find-name-indices defstruct)) - ,@(mapcar #'(lambda (dsd value) - `(setf (aref ,temp ,(dsd-index dsd)) ,value)) - (dd-slots defstruct) values) + (let ((,temp (make-array ,(dd-length dd) + :element-type ',(dd-element-type dd)))) + ,@(mapcar (lambda (x) + `(setf (aref ,temp ,(cdr x)) ',(car x))) + (find-name-indices dd)) + ,@(mapcar (lambda (dsd value) + (unless (eq value '.do-not-initialize-slot.) + `(setf (aref ,temp ,(dsd-index dsd)) ,value))) + (dd-slots dd) values) ,temp)))) -(defun create-list-constructor - (defstruct cons-name arglist vars types values) - (let ((vals (make-list (dd-length defstruct) :initial-element nil))) - (dolist (x (find-name-indices defstruct)) +(defun create-list-constructor (dd cons-name arglist vars types values) + (let ((vals (make-list (dd-length dd) :initial-element nil))) + (dolist (x (find-name-indices dd)) (setf (elt vals (cdr x)) `',(car x))) - (loop for dsd in (dd-slots defstruct) and val in values do - (setf (elt vals (dsd-index dsd)) val)) + (loop for dsd in (dd-slots dd) and val in values do + (setf (elt vals (dsd-index dsd)) + (if (eq val '.do-not-initialize-slot.) 0 val))) `(defun ,cons-name ,arglist - (declare ,@(mapcar #'(lambda (var type) `(type ,type ,var)) - vars types)) + (declare ,@(mapcar (lambda (var type) `(type ,type ,var)) vars types)) (list ,@vals)))) -(defun create-structure-constructor - (defstruct cons-name arglist vars types values) - (let* ((temp (gensym)) - (raw-index (dd-raw-index defstruct)) - (n-raw-data (when raw-index (gensym)))) +(defun create-structure-constructor (dd cons-name arglist vars types values) + (let* ((instance (gensym "INSTANCE")) + (raw-index (dd-raw-index dd))) `(defun ,cons-name ,arglist - (declare ,@(mapcar #'(lambda (var type) `(type ,type ,var)) + (declare ,@(mapcar (lambda (var type) `(type ,type ,var)) vars types)) - (let ((,temp (truly-the ,(dd-name defstruct) - (%make-instance ,(dd-length defstruct)))) - ,@(when n-raw-data - `((,n-raw-data - (make-array ,(dd-raw-length defstruct) - :element-type '(unsigned-byte 32)))))) - (setf (%instance-layout ,temp) - (%delayed-get-compiler-layout ,(dd-name defstruct))) - ,@(when n-raw-data - `((setf (%instance-ref ,temp ,raw-index) ,n-raw-data))) + (let ((,instance (truly-the ,(dd-name dd) + (%make-instance-with-layout + (%delayed-get-compiler-layout ,(dd-name dd)))))) + ,@(when raw-index + `((setf (%instance-ref ,instance ,raw-index) + (make-array ,(dd-raw-length dd) + :element-type '(unsigned-byte 32))))) ,@(mapcar (lambda (dsd value) - (multiple-value-bind (accessor index data) - (slot-accessor-form defstruct dsd temp n-raw-data) - `(setf (,accessor ,data ,index) ,value))) - (dd-slots defstruct) + ;; (Note that we can't in general use the + ;; ordinary named slot setter function here + ;; because the slot might be :READ-ONLY, so we + ;; whip up new LAMBDA representations of slot + ;; setters for the occasion.) + (unless (eq value '.do-not-initialize-slot.) + `(,(slot-setter-lambda-form dd dsd) ,value ,instance))) + (dd-slots dd) values) - ,temp)))) -(defun create-fin-constructor - (defstruct cons-name arglist vars types values) - (let ((temp (gensym))) - `(defun ,cons-name ,arglist - (declare ,@(mapcar #'(lambda (var type) `(type ,type ,var)) - vars types)) - (let ((,temp (truly-the - ,(dd-name defstruct) - (%make-funcallable-instance - ,(dd-length defstruct) - (%delayed-get-compiler-layout ,(dd-name defstruct)))))) - ,@(mapcar #'(lambda (dsd value) - `(setf (%funcallable-instance-info - ,temp ,(dsd-index dsd)) - ,value)) - (dd-slots defstruct) values) - ,temp)))) + ,instance)))) ;;; Create a default (non-BOA) keyword constructor. (defun create-keyword-constructor (defstruct creator) + (declare (type function creator)) (collect ((arglist (list '&key)) (types) (vals)) @@ -1283,11 +1317,13 @@ ;;; Given a structure and a BOA constructor spec, call CREATOR with ;;; the appropriate args to make a constructor. (defun create-boa-constructor (defstruct boa creator) - (multiple-value-bind (req opt restp rest keyp keys allowp aux) - (sb!kernel:parse-lambda-list (second boa)) + (declare (type function creator)) + (multiple-value-bind (req opt restp rest keyp keys allowp auxp aux) + (parse-lambda-list (second boa)) (collect ((arglist) (vars) - (types)) + (types) + (skipped-vars)) (labels ((get-slot (name) (let ((res (find name (dd-slots defstruct) :test #'string= @@ -1304,15 +1340,22 @@ (arglist arg) (vars arg) (types (get-slot arg))) - + (when opt (arglist '&optional) (dolist (arg opt) (cond ((consp arg) (destructuring-bind - (name &optional (def (nth-value 1 (get-slot name)))) + ;; FIXME: this shares some logic (though not + ;; code) with the &key case below (and it + ;; looks confusing) -- factor out the logic + ;; if possible. - CSR, 2002-04-19 + (name + &optional + (def (nth-value 1 (get-slot name))) + (supplied-test nil supplied-test-p)) arg - (arglist `(,name ,def)) + (arglist `(,name ,def ,@(if supplied-test-p `(,supplied-test) nil))) (vars name) (types (get-slot name)))) (t @@ -1327,35 +1370,45 @@ (arglist '&key) (dolist (key keys) (if (consp key) - (destructuring-bind (wot &optional (def nil def-p)) key + (destructuring-bind (wot + &optional + (def nil def-p) + (supplied-test nil supplied-test-p)) + key (let ((name (if (consp wot) (destructuring-bind (key var) wot (declare (ignore key)) var) wot))) - (multiple-value-bind (type slot-def) (get-slot name) - (arglist `(,wot ,(if def-p def slot-def))) + (multiple-value-bind (type slot-def) + (get-slot name) + (arglist `(,wot ,(if def-p def slot-def) + ,@(if supplied-test-p `(,supplied-test) nil))) (vars name) (types type)))) (do-default key)))) (when allowp (arglist '&allow-other-keys)) - (when aux + (when auxp (arglist '&aux) (dolist (arg aux) - (let* ((arg (if (consp arg) arg (list arg))) - (var (first arg))) - (arglist arg) - (vars var) - (types (get-slot var)))))) + (arglist arg) + (if (proper-list-of-length-p arg 2) + (let ((var (first arg))) + (vars var) + (types (get-slot var))) + (skipped-vars (if (consp arg) (first arg) arg)))))) (funcall creator defstruct (first boa) (arglist) (vars) (types) - (mapcar #'(lambda (slot) - (or (find (dsd-name slot) (vars) :test #'string=) - (dsd-default slot))) - (dd-slots defstruct)))))) + (loop for slot in (dd-slots defstruct) + for name = (dsd-name slot) + collect (cond ((find name (skipped-vars) :test #'string=) + (setf (dsd-safe-p slot) nil) + '.do-not-initialize-slot.) + ((or (find (dsd-name slot) (vars) :test #'string=) + (dsd-default slot))))))))) ;;; Grovel the constructor options, and decide what constructors (if ;;; any) to create. @@ -1365,7 +1418,6 @@ (defaults ()) (creator (ecase (dd-type defstruct) (structure #'create-structure-constructor) - (funcallable-structure #'create-fin-constructor) (vector #'create-vector-constructor) (list #'create-list-constructor)))) (dolist (constructor (dd-constructors defstruct)) @@ -1397,10 +1449,183 @@ (res)))) +;;;; instances with ALTERNATE-METACLASS +;;;; +;;;; The CMU CL support for structures with ALTERNATE-METACLASS was a +;;;; fairly general extension embedded in the main DEFSTRUCT code, and +;;;; the result was an fairly impressive mess as ALTERNATE-METACLASS +;;;; extension mixed with ANSI CL generality (e.g. :TYPE and :INCLUDE) +;;;; and CMU CL implementation hairiness (esp. raw slots). This SBCL +;;;; version is much less ambitious, noticing that ALTERNATE-METACLASS +;;;; is only used to implement CONDITION, STANDARD-INSTANCE, and +;;;; GENERIC-FUNCTION, and defining a simple specialized +;;;; separate-from-DEFSTRUCT macro to provide only enough +;;;; functionality to support those. +;;;; +;;;; KLUDGE: The defining macro here is so specialized that it's ugly +;;;; in its own way. It also violates once-and-only-once by knowing +;;;; much about structures and layouts that is already known by the +;;;; main DEFSTRUCT macro. Hopefully it will go away presently +;;;; (perhaps when CL:CLASS and SB-PCL:CLASS meet) as per FIXME below. +;;;; -- WHN 2001-10-28 +;;;; +;;;; FIXME: There seems to be no good reason to shoehorn CONDITION, +;;;; STANDARD-INSTANCE, and GENERIC-FUNCTION into mutated structures +;;;; instead of just implementing them as primitive objects. (This +;;;; reduced-functionality macro seems pretty close to the +;;;; functionality of DEFINE-PRIMITIVE-OBJECT..) + +(defun make-dd-with-alternate-metaclass (&key (class-name (missing-arg)) + (superclass-name (missing-arg)) + (metaclass-name (missing-arg)) + (dd-type (missing-arg)) + metaclass-constructor + slot-names) + (let* ((dd (make-defstruct-description class-name)) + (conc-name (concatenate 'string (symbol-name class-name) "-")) + (dd-slots (let ((reversed-result nil) + ;; The index starts at 1 for ordinary + ;; named slots because slot 0 is + ;; magical, used for LAYOUT in + ;; CONDITIONs or for something (?) in + ;; funcallable instances. + (index 1)) + (dolist (slot-name slot-names) + (push (make-defstruct-slot-description + :name slot-name + :index index + :accessor-name (symbolicate conc-name slot-name)) + reversed-result) + (incf index)) + (nreverse reversed-result)))) + (setf (dd-alternate-metaclass dd) (list superclass-name + metaclass-name + metaclass-constructor) + (dd-slots dd) dd-slots + (dd-length dd) (1+ (length slot-names)) + (dd-type dd) dd-type) + dd)) + +(sb!xc:defmacro !defstruct-with-alternate-metaclass + (class-name &key + (slot-names (missing-arg)) + (boa-constructor (missing-arg)) + (superclass-name (missing-arg)) + (metaclass-name (missing-arg)) + (metaclass-constructor (missing-arg)) + (dd-type (missing-arg)) + predicate + (runtime-type-checks-p t)) + + (declare (type (and list (not null)) slot-names)) + (declare (type (and symbol (not null)) + boa-constructor + superclass-name + metaclass-name + metaclass-constructor)) + (declare (type symbol predicate)) + (declare (type (member structure funcallable-structure) dd-type)) + + (let* ((dd (make-dd-with-alternate-metaclass + :class-name class-name + :slot-names slot-names + :superclass-name superclass-name + :metaclass-name metaclass-name + :metaclass-constructor metaclass-constructor + :dd-type dd-type)) + (dd-slots (dd-slots dd)) + (dd-length (1+ (length slot-names))) + (object-gensym (gensym "OBJECT")) + (new-value-gensym (gensym "NEW-VALUE-")) + (delayed-layout-form `(%delayed-get-compiler-layout ,class-name))) + (multiple-value-bind (raw-maker-form raw-reffer-operator) + (ecase dd-type + (structure + (values `(let ((,object-gensym (%make-instance ,dd-length))) + (setf (%instance-layout ,object-gensym) + ,delayed-layout-form) + ,object-gensym) + '%instance-ref)) + (funcallable-structure + (values `(%make-funcallable-instance ,dd-length + ,delayed-layout-form) + '%funcallable-instance-info))) + `(progn + + (eval-when (:compile-toplevel :load-toplevel :execute) + (%compiler-set-up-layout ',dd)) + + ;; slot readers and writers + (declaim (inline ,@(mapcar #'dsd-accessor-name dd-slots))) + ,@(mapcar (lambda (dsd) + `(defun ,(dsd-accessor-name dsd) (,object-gensym) + ,@(when runtime-type-checks-p + `((declare (type ,class-name ,object-gensym)))) + (,raw-reffer-operator ,object-gensym + ,(dsd-index dsd)))) + dd-slots) + (declaim (inline ,@(mapcar (lambda (dsd) + `(setf ,(dsd-accessor-name dsd))) + dd-slots))) + ,@(mapcar (lambda (dsd) + `(defun (setf ,(dsd-accessor-name dsd)) (,new-value-gensym + ,object-gensym) + ,@(when runtime-type-checks-p + `((declare (type ,class-name ,object-gensym)))) + (setf (,raw-reffer-operator ,object-gensym + ,(dsd-index dsd)) + ,new-value-gensym))) + dd-slots) + + ;; constructor + (defun ,boa-constructor ,slot-names + (let ((,object-gensym ,raw-maker-form)) + ,@(mapcar (lambda (slot-name) + (let ((dsd (find (symbol-name slot-name) dd-slots + :key (lambda (x) + (symbol-name (dsd-name x))) + :test #'string=))) + ;; KLUDGE: bug 117 bogowarning. Neither + ;; DECLAREing the type nor TRULY-THE cut + ;; the mustard -- it still gives warnings. + (enforce-type dsd defstruct-slot-description) + `(setf (,(dsd-accessor-name dsd) ,object-gensym) + ,slot-name))) + slot-names) + ,object-gensym)) + + ;; predicate + ,@(when predicate + ;; Just delegate to the compiler's type optimization + ;; code, which knows how to generate inline type tests + ;; for the whole CMU CL INSTANCE menagerie. + `(defun ,predicate (,object-gensym) + (typep ,object-gensym ',class-name))))))) + ;;;; finalizing bootstrapping -;;; early structure placeholder definitions: Set up layout and class -;;; data for structures which are needed early. +;;; Set up DD and LAYOUT for STRUCTURE-OBJECT class itself. +;;; +;;; Ordinary structure classes effectively :INCLUDE STRUCTURE-OBJECT +;;; when they have no explicit :INCLUDEs, so (1) it needs to be set up +;;; before we can define ordinary structure classes, and (2) it's +;;; special enough (and simple enough) that we just build it by hand +;;; instead of trying to generalize the ordinary DEFSTRUCT code. +(defun !set-up-structure-object-class () + (let ((dd (make-defstruct-description 'structure-object))) + (setf + ;; Note: This has an ALTERNATE-METACLASS only because of blind + ;; clueless imitation of the CMU CL code -- dunno if or why it's + ;; needed. -- WHN + (dd-alternate-metaclass dd) '(instance) + (dd-slots dd) nil + (dd-length dd) 1 + (dd-type dd) 'structure) + (%compiler-set-up-layout dd))) +(!set-up-structure-object-class) + +;;; early structure predeclarations: Set up DD and LAYOUT for ordinary +;;; (non-ALTERNATE-METACLASS) structures which are needed early. (dolist (args '#.(sb-cold:read-from-file "src/code/early-defstruct-args.lisp-expr"))