X-Git-Url: http://repo.macrolet.net/gitweb/?a=blobdiff_plain;f=src%2Fcode%2Fdefstruct.lisp;h=dfd7be2c23dd7821f453a9b3a4c7a1a6f7d6f279;hb=a37de74b393a808825585000bb5b2b92218d46c0;hp=f00df2fc9f44f7f18d43e67ab4a6137b24dd17ae;hpb=e27303999070c06c788a0e1359ee4b0900186aa1;p=sbcl.git diff --git a/src/code/defstruct.lisp b/src/code/defstruct.lisp index f00df2f..dfd7be2 100644 --- a/src/code/defstruct.lisp +++ b/src/code/defstruct.lisp @@ -16,7 +16,7 @@ ;;;; getting LAYOUTs -;;; Return the compiler layout for Name. (The class referred to by +;;; Return the compiler layout for NAME. (The class referred to by ;;; NAME must be a structure-like class.) (defun compiler-layout-or-lose (name) (let ((res (info :type :compiler-layout name))) @@ -42,8 +42,10 @@ ;;; 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) @@ -60,7 +62,7 @@ ;; all the explicit :CONSTRUCTOR specs, with name defaulted (constructors () :type list) ;; name of copying function - (copier (symbolicate "COPY-" name) :type (or symbol null)) + (copier-name (symbolicate "COPY-" name) :type (or symbol null)) ;; name of type predicate (predicate-name (symbolicate name "-P") :type (or symbol null)) ;; the arguments to the :INCLUDE option, or NIL if no included @@ -82,7 +84,7 @@ funcallable-structure)) ;; The next three slots are for :TYPE'd structures (which aren't - ;; classes, CLASS-STRUCTURE-P = NIL) + ;; classes, DD-CLASS-P = NIL) ;; ;; vector element type (element-type t) @@ -99,17 +101,28 @@ ;; option was given with no argument, or 0 if no PRINT-OBJECT option ;; was given (print-object 0 :type (or cons symbol (member 0))) - ;; the index of the raw data vector and the number of words in it. - ;; NIL and 0 if not allocated yet. + ;; the index of the raw data vector and the number of words in it, + ;; or NIL and 0 if not allocated (either because this structure + ;; has no raw slots, or because we're still parsing it and haven't + ;; run across any raw slots yet) (raw-index nil :type (or index null)) (raw-length 0 :type index) ;; the value of the :PURE option, or :UNSPECIFIED. This is only - ;; meaningful if CLASS-STRUCTURE-P = T. + ;; meaningful if DD-CLASS-P = T. (pure :unspecified :type (member t nil :substructure :unspecified))) (def!method print-object ((x defstruct-description) stream) (print-unreadable-object (x stream :type t) (prin1 (dd-name x) stream))) +;;; Is DD a structure with a class? +(defun dd-class-p (defstruct) + (member (dd-type defstruct) '(structure funcallable-structure))) + +(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 @@ -146,10 +159,6 @@ (print-unreadable-object (x stream :type t) (prin1 (dsd-name x) stream))) -;;; Is DEFSTRUCT a structure with a class? -(defun class-structure-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) @@ -166,6 +175,266 @@ (list 'list) (vector `(simple-array ,(dd-element-type defstruct) (*))))) +;;;; 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 + "~@" + :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 + "~@" + :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 'simple-type-error + :datum x + :expected-type (sb!xc:class-name (layout-class layout)))) + (values)) + +;;;; shared machinery for inline and out-of-line slot accessor functions + +;;; an alist mapping from raw slot type to the operator used to access +;;; the raw slot +;;; +;;; FIXME: should be shared +(eval-when (:compile-toplevel :load-toplevel :execute) + (defvar *raw-type->rawref-fun-name* + '(;; 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)))) + +;;;; generating out-of-line slot accessor functions + +;;; code generators for cases of DEFUN SLOT-ACCESSOR-FUNS +;;; +;;; (caution: These macros are sleazily specialized for use only in +;;; DEFUN SLOT-ACCESSOR-FUNS, not anywhere near fully parameterized: +;;; they grab symbols like INSTANCE and DSD-FOO automatically. +;;; Logically they probably belong in a MACROLET inside the DEFUN, but +;;; separating them like this makes it easier to experiment with them +;;; in the interpreter and reduces indentation hell.) +;;; +;;; FIXME: Ideally, the presence of the type checks in the functions +;;; here would be conditional on the optimization policy at the point +;;; of expansion of DEFSTRUCT. (For now we're just doing the simpler +;;; thing, putting in the type checks unconditionally.) +(eval-when (:compile-toplevel) + + ;; code shared between funcallable instance case and the ordinary + ;; STRUCTURE-OBJECT case: Handle native structures with LAYOUTs and + ;; (possibly) raw slots. + (defmacro %native-slot-accessor-funs (dd-ref-fun-name) + (let ((instance-type-check-form '(%check-structure-type-from-layout + instance layout))) + `(let ((layout (dd-layout-or-lose dd)) + (dsd-raw-type (dsd-raw-type dsd))) + ;; Map over all the possible RAW-TYPEs, compiling a different + ;; closure-function for each one, so that once the COND over + ;; RAW-TYPEs happens (at the time closure is allocated) there + ;; are no more decisions to be made and things execute + ;; reasonably efficiently. + (cond + ;; nonraw slot case + ((eql (dsd-raw-type dsd) t) + (%slotplace-accessor-funs (,dd-ref-fun-name instance dsd-index) + ,instance-type-check-form)) + ;; raw slot cases + ,@(mapcar (lambda (raw-type-and-rawref-fun-name) + (destructuring-bind (raw-type . rawref-fun-name) + raw-type-and-rawref-fun-name + `((equal dsd-raw-type ',raw-type) + (let ((raw-index (dd-raw-index dd))) + (%slotplace-accessor-funs + (,rawref-fun-name (,dd-ref-fun-name instance + raw-index) + dsd-index) + ,instance-type-check-form))))) + *raw-type->rawref-fun-name*))))) + + ;; code shared between DEFSTRUCT :TYPE LIST and + ;; DEFSTRUCT :TYPE VECTOR cases: Handle the "typed structure" case, + ;; with no LAYOUTs and no raw slots. + (defmacro %colontyped-slot-accessor-funs () (error "stub")) + + ;; the common structure of the raw-slot and not-raw-slot cases, + ;; defined in terms of the writable SLOTPLACE. All possible flavors + ;; of slot access should be able to pass through here. + (defmacro %slotplace-accessor-funs (slotplace instance-type-check-form) + (cl-user:/show slotplace instance-type-check-form) + `(values (lambda (instance) + ,instance-type-check-form + ,slotplace) + (let ((typecheckfun (typespec-typecheckfun dsd-type))) + (lambda (new-value instance) + ,instance-type-check-form + (funcall typecheckfun new-value) + (setf ,slotplace new-value)))))) + +;;; Return (VALUES SLOT-READER-FUN SLOT-WRITER-FUN). +(defun slot-accessor-funs (dd dsd) + + (let ((dsd-index (dsd-index dsd)) + (dsd-type (dsd-type dsd))) + + (ecase (dd-type dd) + + ;; native structures + (structure (%native-slot-accessor-funs %instance-ref)) + (funcallable-structure (%native-slot-accessor-funs + %funcallable-instance-info)) + + ;; structures with the :TYPE option + + ;; FIXME: Worry about these later.. + #| + ;; In :TYPE LIST and :TYPE VECTOR structures, ANSI specifies the + ;; layout completely, so that raw slots are impossible. + (list + (dd-type-slot-accessor-funs nth-but-with-sane-arg-order + `(%check-structure-type-from-dd + :maybe-raw-p nil)) + (vector + (dd-type-slot-accessor-funs aref + :maybe-raw-p nil))) + |# + ))) + +;;;; REMOVEME: baby steps for the new out-of-line slot accessor functions + +#| +(in-package :sb-kernel) + +(defstruct foo + ;; vanilla slots + a + (b 5 :type package :read-only t) + ;; raw slots + (x 5 :type (unsigned-byte 32)) + (y 5.0 :type single-float :read-only t)) + +(load "/usr/stuff/sbcl/src/cold/chill") +(cl-user:fasl "/usr/stuff/sbcl/src/code/typecheckfuns") +(cl-user:fasl "/usr/stuff/outsacc") + +(let* ((foo-layout (compiler-layout-or-lose 'foo)) + (foo-dd (layout-info foo-layout)) + (foo-dsds (dd-slots foo-dd)) + (foo-a-dsd (find "A" foo-dsds :test #'string= :key #'dsd-%name)) + (foo-b-dsd (find "B" foo-dsds :test #'string= :key #'dsd-%name)) + (foo-x-dsd (find "X" foo-dsds :test #'string= :key #'dsd-%name)) + (foo-y-dsd (find "X" foo-dsds :test #'string= :key #'dsd-%name)) + (foo (make-foo :a 'avalue + :b (find-package :cl) + :x 50))) + (declare (type layout foo-layout)) + (declare (type defstruct-description foo-dd)) + (declare (type defstruct-slot-description foo-a-dsd)) + + (cl-user:/show foo) + + (multiple-value-bind (foo-a-reader foo-a-writer) + (slot-accessor-funs foo-dd foo-a-dsd) + + ;; basic functionality + (cl-user:/show foo-a-reader) + (cl-user:/show (funcall foo-a-reader foo)) + (aver (eql (funcall foo-a-reader foo) 'avalue)) + (cl-user:/show foo-a-writer) + (cl-user:/show (funcall foo-a-writer 'replacedavalue foo)) + (cl-user:/show "new" (funcall foo-a-reader foo)) + (aver (eql (funcall foo-a-reader foo) 'replacedavalue)) + + ;; type checks on FOO-ness of instance argument + (cl-user:/show (nth-value 1 (ignore-errors (funcall foo-a-reader 3)))) + (aver (typep (nth-value 1 (ignore-errors (funcall foo-a-reader 3))) + 'type-error)) + (aver (typep (nth-value 1 (ignore-errors (funcall foo-a-writer 3 4))) + 'type-error))) + + ;; type checks on written slot value + (multiple-value-bind (foo-b-reader foo-b-writer) + (slot-accessor-funs foo-dd foo-b-dsd) + (cl-user:/show "old" (funcall foo-b-reader foo)) + (aver (not (eql (funcall foo-b-reader foo) (find-package :cl-user)))) + (funcall foo-b-writer (find-package :cl-user) foo) + (cl-user:/show "new" (funcall foo-b-reader foo)) + (aver (eql (funcall foo-b-reader foo) (find-package :cl-user))) + (aver (typep (nth-value 1 (ignore-errors (funcall foo-b-writer 5 foo))) + 'type-error)) + (aver (eql (funcall foo-b-reader foo) (find-package :cl-user)))) + + ;; raw slots + (cl-user:/describe foo-x-dsd) + (cl-user:/describe foo-y-dsd) + (multiple-value-bind (foo-x-reader foo-x-writer) + (slot-accessor-funs foo-dd foo-x-dsd) + (multiple-value-bind (foo-y-reader foo-y-writer) + (slot-accessor-funs foo-dd foo-y-dsd) + + ;; basic functionality for (UNSIGNED-BYTE 32) slot + (cl-user:/show foo-x-reader) + (cl-user:/show (funcall foo-x-reader foo)) + (aver (eql (funcall foo-x-reader foo) 50)) + (cl-user:/show foo-x-writer) + (cl-user:/show (funcall foo-x-writer 14 foo)) + (cl-user:/show "new" (funcall foo-x-reader foo)) + (aver (eql (funcall foo-x-reader foo) 14))) + + ;; type check for (UNSIGNED-BYTE 32) slot + (/show "to do: type check X") + + ;; SINGLE-FLOAT slot + (/show "to do: Y"))) +|# + ;;;; the legendary DEFSTRUCT macro itself (both CL:DEFSTRUCT and its ;;;; close personal friend SB!XC:DEFSTRUCT) @@ -193,8 +462,8 @@ (flet (;; Given an arg from a :PRINT-OBJECT or :PRINT-FUNCTION ;; option, return the value to pass as an arg to FUNCTION. (farg (oarg) - (destructuring-bind (function-name) oarg - function-name))) + (destructuring-bind (fun-name) oarg + fun-name))) (cond ((not (eql pf 0)) `((def!method print-object ((,x ,name) ,s) (funcall #',(farg pf) ,x ,s *current-level*)))) @@ -215,48 +484,29 @@ (when (and def-con (not (dd-alternate-metaclass defstruct))) `((setf (structure-class-constructor (sb!xc:find-class ',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.) +;;; 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 -;;; -;;; FIXME: There should be some way to make this not be present in the -;;; target executable, with EVAL-WHEN (COMPILE EXECUTE) and all that good -;;; stuff, but for now I can't be bothered because of the messiness of -;;; using CL:DEFMACRO in one case and SB!XC:DEFMACRO in another case. -;;; Perhaps I could dodge this by defining it as an inline function instead? -;;; Or perhaps just use MACROLET? I tried MACROLET and got nowhere and thought -;;; I was tripping over either a compiler bug or ANSI weirdness, but this -;;; test case seems to work in Debian CMU CL 2.4.9: -;;; (macrolet ((emit-printer () ''(print "********"))) -;;; (defmacro fizz () (emit-printer))) -;;; giving -;;; * (fizz) -;;; "********" -;;; "********" -;;; * -(defmacro expander-for-defstruct (name-and-options - slot-descriptions - expanding-into-code-for-xc-host-p) +(defmacro !expander-for-defstruct (name-and-options + slot-descriptions + expanding-into-code-for-xc-host-p) `(let ((name-and-options ,name-and-options) (slot-descriptions ,slot-descriptions) (expanding-into-code-for-xc-host-p ,expanding-into-code-for-xc-host-p)) - (let* ((dd (parse-name-and-options-and-slot-descriptions + (let* ((dd (parse-defstruct-name-and-options-and-slot-descriptions name-and-options slot-descriptions)) (name (dd-name dd))) - (if (class-structure-p dd) + (if (dd-class-p dd) (let ((inherits (inherits-for-structure dd))) `(progn - (/noshow0 "doing CLASS-STRUCTURE-P case for DEFSTRUCT " ,name) (eval-when (:compile-toplevel :load-toplevel :execute) - (%compiler-only-defstruct ',dd ',inherits)) + (%compiler-defstruct ',dd ',inherits)) (%defstruct ',dd ',inherits) - ,@(when (eq (dd-type dd) 'structure) - `((%compiler-defstruct ',dd))) - (/noshow0 "starting not-for-the-xc-host section in DEFSTRUCT") ,@(unless expanding-into-code-for-xc-host-p (append (raw-accessor-definitions dd) (predicate-definitions dd) @@ -266,10 +516,8 @@ ;(copier-definition dd) (constructor-definitions dd) (class-method-definitions dd))) - (/noshow0 "done with DEFSTRUCT " ,name) ',name)) `(progn - (/show0 "doing NOT CLASS-STRUCTURE-P case for DEFSTRUCT " ,name) (eval-when (:compile-toplevel :load-toplevel :execute) (setf (info :typed-structure :info ',name) ',dd)) ,@(unless expanding-into-code-for-xc-host-p @@ -277,7 +525,6 @@ (typed-predicate-definitions dd) (typed-copier-definitions dd) (constructor-definitions dd))) - (/noshow0 "done with DEFSTRUCT " ,name) ',name))))) (sb!xc:defmacro defstruct (name-and-options &rest slot-descriptions) @@ -309,15 +556,15 @@ :READ-ONLY {T | NIL} If true, no setter function is defined for this slot." - (expander-for-defstruct name-and-options slot-descriptions nil)) + (!expander-for-defstruct name-and-options slot-descriptions nil)) #+sb-xc-host (defmacro sb!xc:defstruct (name-and-options &rest slot-descriptions) #!+sb-doc "Cause information about a target structure to be built into the cross-compiler." - (expander-for-defstruct name-and-options slot-descriptions t)) + (!expander-for-defstruct name-and-options slot-descriptions t)) -;;;; functions to create various parts of DEFSTRUCT definitions +;;;; functions to generate code for various parts of DEFSTRUCT definitions ;;; Catch requests to mess up definitions in COMMON-LISP. #-sb-xc-host @@ -335,7 +582,7 @@ (let* ((name (dd-name dd))) (collect ((res)) (dolist (slot (dd-slots dd)) - (let ((stype (dsd-type slot)) + (let ((slot-type (dsd-type slot)) (accessor-name (dsd-accessor-name slot)) (argname (gensym "ARG")) (nvname (gensym "NEW-VALUE-"))) @@ -345,17 +592,25 @@ (when (and accessor-name (not (eq accessor-name '%instance-ref))) (res `(declaim (inline ,accessor-name))) - (res `(declaim (ftype (function (,name) ,stype) ,accessor-name))) + (res `(declaim (ftype (function (,name) ,slot-type) + ,accessor-name))) (res `(defun ,accessor-name (,argname) - (truly-the ,stype (,accessor ,data ,offset)))) + ;; 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 (,stype ,name) ,stype) + (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)))) @@ -416,9 +671,9 @@ ;;; Return a list of forms to create a copier function of a typed DEFSTRUCT. (defun typed-copier-definitions (defstruct) - (when (dd-copier defstruct) - `((setf (fdefinition ',(dd-copier defstruct)) #'copy-seq) - (declaim (ftype function ,(dd-copier 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, @@ -428,7 +683,7 @@ (collect ((stuff)) (let ((ltype (dd-lisp-type defstruct))) (dolist (slot (dd-slots defstruct)) - (let ((name (dsd-accessor slot)) + (let ((name (dsd-accessor-name slot)) (index (dsd-index slot)) (slot-type `(and ,(dsd-type slot) ,(dd-element-type defstruct)))) @@ -451,17 +706,17 @@ (defun require-no-print-options-so-far (defstruct) (unless (and (eql (dd-print-function defstruct) 0) (eql (dd-print-object defstruct) 0)) - (error "no more than one of the following options may be specified: + (error "No more than one of the following options may be specified: :PRINT-FUNCTION, :PRINT-OBJECT, :TYPE"))) -;;; Parse a single defstruct option and store the results in DEFSTRUCT. -(defun parse-1-option (option defstruct) +;;; Parse a single DEFSTRUCT option and store the results in DD. +(defun parse-1-dd-option (option dd) (let ((args (rest option)) - (name (dd-name defstruct))) + (name (dd-name dd))) (case (first option) (:conc-name (destructuring-bind (conc-name) args - (setf (dd-conc-name defstruct) + (setf (dd-conc-name dd) (if (symbolp conc-name) conc-name (make-symbol (string conc-name)))))) @@ -469,97 +724,96 @@ (destructuring-bind (&optional (cname (symbolicate "MAKE-" name)) &rest stuff) args - (push (cons cname stuff) (dd-constructors defstruct)))) + (push (cons cname stuff) (dd-constructors dd)))) (:copier (destructuring-bind (&optional (copier (symbolicate "COPY-" name))) args - (setf (dd-copier defstruct) copier))) + (setf (dd-copier-name dd) copier))) (:predicate (destructuring-bind (&optional (predicate-name (symbolicate name "-P"))) args - (setf (dd-predicate-name defstruct) predicate-name))) + (setf (dd-predicate-name dd) predicate-name))) (:include - (when (dd-include defstruct) + (when (dd-include dd) (error "more than one :INCLUDE option")) - (setf (dd-include defstruct) args)) + (setf (dd-include dd) args)) (:alternate-metaclass - (setf (dd-alternate-metaclass defstruct) args)) + (setf (dd-alternate-metaclass dd) args)) (:print-function - (require-no-print-options-so-far defstruct) - (setf (dd-print-function defstruct) + (require-no-print-options-so-far dd) + (setf (dd-print-function dd) (the (or symbol cons) args))) (:print-object - (require-no-print-options-so-far defstruct) - (setf (dd-print-object defstruct) + (require-no-print-options-so-far dd) + (setf (dd-print-object dd) (the (or symbol cons) args))) (:type (destructuring-bind (type) args (cond ((eq type 'funcallable-structure) - (setf (dd-type defstruct) type)) + (setf (dd-type dd) type)) ((member type '(list vector)) - (setf (dd-element-type defstruct) t) - (setf (dd-type defstruct) type)) + (setf (dd-element-type dd) t) + (setf (dd-type dd) type)) ((and (consp type) (eq (first type) 'vector)) (destructuring-bind (vector vtype) type (declare (ignore vector)) - (setf (dd-element-type defstruct) vtype) - (setf (dd-type defstruct) 'vector))) + (setf (dd-element-type dd) vtype) + (setf (dd-type dd) 'vector))) (t - (error "~S is a bad :TYPE for Defstruct." type))))) + (error "~S is a bad :TYPE for DEFSTRUCT." type))))) (:named (error "The DEFSTRUCT option :NAMED takes no arguments.")) (:initial-offset (destructuring-bind (offset) args - (setf (dd-offset defstruct) offset))) + (setf (dd-offset dd) offset))) (:pure (destructuring-bind (fun) args - (setf (dd-pure defstruct) fun))) + (setf (dd-pure dd) fun))) (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-name-and-options (name-and-options) +(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 ((defstruct (make-defstruct-description name))) + (let ((dd (make-defstruct-description name))) (dolist (option options) (cond ((consp option) - (parse-1-option option defstruct)) + (parse-1-dd-option option dd)) ((eq option :named) - (setf (dd-named defstruct) t)) + (setf (dd-named dd) t)) ((member option '(:constructor :copier :predicate :named)) - (parse-1-option (list option) defstruct)) + (parse-1-dd-option (list option) dd)) (t (error "unrecognized DEFSTRUCT option: ~S" option)))) - (case (dd-type defstruct) + (case (dd-type dd) (structure - (when (dd-offset defstruct) + (when (dd-offset dd) (error ":OFFSET can't be specified unless :TYPE is specified.")) - (unless (dd-include defstruct) - (incf (dd-length defstruct)))) + (unless (dd-include dd) + (incf (dd-length dd)))) (funcallable-structure) (t - (require-no-print-options-so-far defstruct) - (when (dd-named defstruct) - (incf (dd-length defstruct))) - (let ((offset (dd-offset defstruct))) - (when offset (incf (dd-length defstruct) offset))))) + (require-no-print-options-so-far dd) + (when (dd-named dd) + (incf (dd-length dd))) + (let ((offset (dd-offset dd))) + (when offset (incf (dd-length dd) offset))))) - (when (dd-include defstruct) - (do-inclusion-stuff defstruct)) + (when (dd-include dd) + (do-dd-inclusion-stuff dd)) - defstruct))) + dd))) ;;; Given name and options and slot descriptions (and possibly doc ;;; string at the head of slot descriptions) return a DD holding that ;;; info. -(defun parse-name-and-options-and-slot-descriptions (name-and-options - slot-descriptions) - (/noshow "PARSE-NAME-AND-OPTIONS-AND-SLOT-DESCRIPTIONS" name-and-options) - (let ((result (parse-name-and-options (if (atom name-and-options) - (list name-and-options) - name-and-options)))) +(defun parse-defstruct-name-and-options-and-slot-descriptions + (name-and-options slot-descriptions) + (let ((result (parse-defstruct-name-and-options (if (atom name-and-options) + (list name-and-options) + name-and-options)))) (when (stringp (car slot-descriptions)) (setf (dd-doc result) (pop slot-descriptions))) (dolist (slot-description slot-descriptions) @@ -680,29 +934,29 @@ (t (values nil nil nil)))) -;;; Allocate storage for a DSD in DEFSTRUCT. This is where we decide -;;; whether a slot is raw or not. If raw, and we haven't allocated a -;;; raw-index yet for the raw data vector, then do it. Raw objects are -;;; aligned on the unit of their size. -(defun allocate-1-slot (defstruct dsd) +;;; Allocate storage for a DSD in DD. This is where we decide whether +;;; a slot is raw or not. If raw, and we haven't allocated a raw-index +;;; yet for the raw data vector, then do it. Raw objects are aligned +;;; on the unit of their size. +(defun allocate-1-slot (dd dsd) (multiple-value-bind (raw? raw-type words) - (if (eq (dd-type defstruct) 'structure) + (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 defstruct)) - (incf (dd-length defstruct))) + (setf (dsd-index dsd) (dd-length dd)) + (incf (dd-length dd))) (t - (unless (dd-raw-index defstruct) - (setf (dd-raw-index defstruct) (dd-length defstruct)) - (incf (dd-length defstruct))) - (let ((off (rem (dd-raw-length defstruct) words))) + (unless (dd-raw-index dd) + (setf (dd-raw-index dd) (dd-length dd)) + (incf (dd-length dd))) + (let ((off (rem (dd-raw-length dd) words))) (unless (zerop off) - (incf (dd-raw-length defstruct) (- words off)))) + (incf (dd-raw-length dd) (- words off)))) (setf (dsd-raw-type dsd) raw-type) - (setf (dsd-index dsd) (dd-raw-length defstruct)) - (incf (dd-raw-length defstruct) words)))) + (setf (dsd-index dsd) (dd-raw-length dd)) + (incf (dd-raw-length dd) words)))) (values)) (defun typed-structure-info-or-lose (name) @@ -711,31 +965,29 @@ ;;; Process any included slots pretty much like they were specified. ;;; Also inherit various other attributes. -(defun do-inclusion-stuff (defstruct) - (destructuring-bind - (included-name &rest modified-slots) - (dd-include defstruct) - (let* ((type (dd-type defstruct)) +(defun do-dd-inclusion-stuff (dd) + (destructuring-bind (included-name &rest modified-slots) (dd-include dd) + (let* ((type (dd-type dd)) (included-structure - (if (class-structure-p defstruct) + (if (dd-class-p dd) (layout-info (compiler-layout-or-lose included-name)) (typed-structure-info-or-lose included-name)))) (unless (and (eq type (dd-type included-structure)) (type= (specifier-type (dd-element-type included-structure)) - (specifier-type (dd-element-type defstruct)))) - (error ":TYPE option mismatch between structures ~S and ~S." - (dd-name defstruct) included-name)) + (specifier-type (dd-element-type dd)))) + (error ":TYPE option mismatch between structures ~S and ~S" + (dd-name dd) included-name)) - (incf (dd-length defstruct) (dd-length included-structure)) - (when (class-structure-p defstruct) + (incf (dd-length dd) (dd-length included-structure)) + (when (dd-class-p dd) (let ((mc (rest (dd-alternate-metaclass included-structure)))) - (when (and mc (not (dd-alternate-metaclass defstruct))) - (setf (dd-alternate-metaclass defstruct) + (when (and mc (not (dd-alternate-metaclass dd))) + (setf (dd-alternate-metaclass dd) (cons included-name mc)))) - (when (eq (dd-pure defstruct) :unspecified) - (setf (dd-pure defstruct) (dd-pure included-structure))) - (setf (dd-raw-index defstruct) (dd-raw-index included-structure)) - (setf (dd-raw-length defstruct) (dd-raw-length included-structure))) + (when (eq (dd-pure dd) :unspecified) + (setf (dd-pure dd) (dd-pure included-structure))) + (setf (dd-raw-index dd) (dd-raw-index included-structure)) + (setf (dd-raw-length dd) (dd-raw-length included-structure))) (dolist (included-slot (dd-slots included-structure)) (let* ((included-name (dsd-name included-slot)) @@ -743,10 +995,12 @@ :key #'(lambda (x) (if (atom x) x (car x))) :test #'string=) `(,included-name)))) - (parse-1-dsd defstruct + (parse-1-dsd dd modified (copy-structure included-slot))))))) +;;;; various helper functions for setting up DEFSTRUCTs + ;;; This function is called at macroexpand time to compute the INHERITS ;;; vector for a structure type definition. (defun inherits-for-structure (info) @@ -770,35 +1024,36 @@ (vector super))))) ;;; Do miscellaneous (LOAD EVAL) time actions for the structure -;;; described by INFO. Create the class & layout, checking for +;;; described by DD. 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)) +;;; predicate, documentation, instantiate definition in load-time +;;; environment. +(defun %defstruct (dd inherits) + (declare (type defstruct-description dd)) + (remhash (dd-name dd) *typecheckfuns*) (multiple-value-bind (class layout old-layout) - (ensure-structure-class info inherits "current" "new") + (ensure-structure-class dd inherits "current" "new") (cond ((not old-layout) (unless (eq (class-layout class) 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-dd 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)))) - (setf (sb!xc:find-class (dd-name info)) class) + (setf (sb!xc:find-class (dd-name dd)) class) ;; Set FDEFINITIONs for structure accessors, setters, predicates, ;; and copiers. #-sb-xc-host - (unless (eq (dd-type info) 'funcallable-structure) + (unless (eq (dd-type dd) 'funcallable-structure) - (dolist (slot (dd-slots info)) + (dolist (slot (dd-slots dd)) (let ((dsd slot)) (when (and (dsd-accessor-name slot) (eq (dsd-raw-type slot) t)) @@ -809,19 +1064,20 @@ (setf (fdefinition `(setf ,(dsd-accessor-name slot))) (structure-slot-setter layout dsd)))))) - ;; FIXME: See comment on corresponding code in %%COMPILER-DEFSTRUCT. + ;; 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)) + (when (dd-predicate dd) + (protect-cl (dd-predicate dd)) + (setf (symbol-function (dd-predicate dd)) #'(lambda (object) (declare (optimize (speed 3) (safety 0))) (typep-to-layout object layout)))) |# - (when (dd-copier info) - (protect-cl (dd-copier info)) - (setf (symbol-function (dd-copier info)) + (when (dd-copier-name dd) + (protect-cl (dd-copier-name dd)) + (setf (symbol-function (dd-copier-name dd)) #'(lambda (structure) (declare (optimize (speed 3) (safety 0))) (flet ((layout-test (structure) @@ -837,49 +1093,68 @@ structure)))) (copy-structure structure)))))) - (when (dd-doc info) - (setf (fdocumentation (dd-name info) 'type) (dd-doc info))) + (when (dd-doc dd) + (setf (fdocumentation (dd-name dd) 'type) + (dd-doc dd))) (values)) -;;; This function is called at compile-time to do the -;;; compile-time-only actions for defining a structure type. It -;;; installs the class in the type system in a similar way to -;;; %DEFSTRUCT, but is quieter and safer in the case of redefinition. -;;; -;;; The comments for the classic CMU CL version of this function said -;;; that EVAL-WHEN doesn't do the right thing when nested or -;;; non-top-level, and so CMU CL had the function magically called by -;;; the compiler. Unfortunately, this doesn't do the right thing -;;; either: compiling a function (DEFUN FOO () (DEFSTRUCT FOO X Y)) -;;; causes the class FOO to become defined, even though FOO is never -;;; loaded or executed. Even more unfortunately, I've been unable to -;;; come up with any EVAL-WHEN tricks which work -- I finally gave up -;;; on this approach when trying to get the system to cross-compile -;;; error.lisp. (Just because I haven't found it doesn't mean that it -;;; doesn't exist, of course. Alas, I continue to have some trouble -;;; understanding compile/load semantics in Common Lisp.) So we -;;; continue to use the IR1 transformation approach, even though it's -;;; known to be buggy. -- WHN 19990507 -;;; -;;; Basically, this function avoids trashing the compiler by only -;;; actually defining the class if there is no current definition. -;;; Instead, we just set the INFO TYPE COMPILER-LAYOUT. This behavior -;;; is left over from classic CMU CL and may not be necessary in the -;;; new build system. -- WHN 19990507 -;;; -;;; FUNCTION-%COMPILER-ONLY-DEFSTRUCT is an ordinary function, called -;;; by both the IR1 transform version of %COMPILER-ONLY-DEFSTRUCT and -;;; by the ordinary function version of %COMPILER-ONLY-DEFSTRUCT. (The -;;; ordinary function version is there for the interpreter and for -;;; code walkers.) -(defun %compiler-only-defstruct (info inherits) - (function-%compiler-only-defstruct info inherits)) -(defun function-%compiler-only-defstruct (info inherits) +;;; 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) + (let (;; the operator that we'll use to access a typed slot or, in + ;; 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)))))) + +;;; Return inline expansion designators (i.e. values suitable for +;;; (INFO :FUNCTION :INLINE-EXPANSSION-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) (multiple-value-bind (clayout clayout-p) - (info :type :compiler-layout (dd-name info)) - (ensure-structure-class info + (info :type :compiler-layout (dd-name dd)) + (ensure-structure-class dd inherits (if clayout-p "previously compiled" "current") "compiled" @@ -894,64 +1169,54 @@ (undefine-structure class) (subs (class-proper-name class))) (when (subs) - (warn "Removing old subclasses of ~S:~% ~S" + (warn "removing old subclasses of ~S:~% ~S" (sb!xc:class-name class) (subs)))))) (t (unless (eq (class-layout class) layout) (register-layout layout :invalidate nil)) - (setf (sb!xc:find-class (dd-name info)) class))) + (setf (sb!xc:find-class (dd-name dd)) class))) - (setf (info :type :compiler-layout (dd-name info)) layout)) - (values)) + (setf (info :type :compiler-layout (dd-name dd)) layout)) -;;; This function does the (COMPILE LOAD EVAL) time actions for updating the -;;; compiler's global meta-information to represent the definition of the -;;; structure described by Info. This primarily amounts to setting up info -;;; about the accessor and other implicitly defined functions. The constructors -;;; are explicitly defined by top-level code. -(defun %%compiler-defstruct (info) - (declare (type defstruct-description info)) - (let* ((name (dd-name info)) - (class (sb!xc:find-class name))) - (let ((copier (dd-copier info))) - (when copier - (proclaim `(ftype (function (,name) ,name) ,copier)))) - - ;; FIXME: This (and corresponding code in %DEFSTRUCT) are the way - ;; that CMU CL defined the predicate, instead of using DEFUN. - ;; Perhaps it would be better to go back to to the CMU CL way, or - ;; something similar. I want to reduce the amount of magic in - ;; defstruct functions, but making the predicate be a closure - ;; looks like a good thing, and can even be done without magic. - ;; (OTOH, there are some bootstrapping issues involved, since - ;; GENESIS understands DEFUN but doesn't understand a - ;; (SETF SYMBOL-FUNCTION) call inside %DEFSTRUCT.) - #| - (let ((predicate-name (dd-predicate-name info))) + (let* ((dd-name (dd-name dd)) + (class (sb!xc:find-class dd-name))) + + (let ((copier-name (dd-copier-name dd))) + (when copier-name + (sb!xc:proclaim `(ftype (function (,dd-name) ,dd-name) ,copier-name)))) + + (let ((predicate-name (dd-predicate-name dd))) (when predicate-name - (proclaim-as-defstruct-function-name predicate-name) - (setf (info :function :inlinep pred) :inline) - (setf (info :function :inline-expansion predicate-name) - `(lambda (x) (typep x ',name))))) - |# - - (dolist (slot (dd-slots info)) - (let* ((fun (dsd-accessor-name slot)) - (setf-fun `(setf ,fun))) - (when (and fun (eq (dsd-raw-type slot) t)) - (proclaim-as-defstruct-function-name fun) - (setf (info :function :accessor-for fun) class) - (unless (dsd-read-only slot) - (proclaim-as-defstruct-function-name setf-fun) - (setf (info :function :accessor-for setf-fun) class)))))) + (sb!xc:proclaim `(ftype (function (t) t) ,predicate-name)))) + + (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)))))))) (values)) - -;;; Ordinarily this is preempted by an IR1 transformation, but this -;;; definition is still useful for the interpreter and code walkers. -(defun %compiler-defstruct (info) - (%%compiler-defstruct info)) ;;;; redefinition stuff @@ -998,7 +1263,7 @@ 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) @@ -1098,13 +1363,13 @@ (when (defstruct-description-p info) (let ((type (dd-name info))) (setf (info :type :compiler-layout type) nil) - (undefine-function-name (dd-copier info)) - (undefine-function-name (dd-predicate-name info)) + (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-function-name fun) + (undefine-fun-name fun) (unless (dsd-read-only slot) - (undefine-function-name `(setf ,fun)))))) + (undefine-fun-name `(setf ,fun)))))) ;; Clear out the SPECIFIER-TYPE cache so that subsequent ;; references are unknown types. (values-specifier-type-cache-clear))) @@ -1135,9 +1400,9 @@ ;;;; 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 (we can't use the -;;; accessor function, since some slots are read-only.) If supplied, -;;; DATA is a variable holding the raw-data vector. +;;; 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) @@ -1401,23 +1666,6 @@ (res)))) -;;;; compiler stuff - -;;; This is like PROCLAIM-AS-FUNCTION-NAME, but we also set the kind to -;;; :DECLARED and blow away any ASSUMED-TYPE. Also, if the thing is a -;;; slot accessor currently, quietly unaccessorize it. And if there -;;; are any undefined warnings, we nuke them. -(defun proclaim-as-defstruct-function-name (name) - (when name - (when (info :function :accessor-for name) - (setf (info :function :accessor-for name) nil)) - (proclaim-as-function-name name) - (note-name-defined name :function) - (setf (info :function :where-from name) :declared) - (when (info :function :assumed-type name) - (setf (info :function :assumed-type name) nil))) - (values)) - ;;;; finalizing bootstrapping ;;; early structure placeholder definitions: Set up layout and class @@ -1425,10 +1673,10 @@ (dolist (args '#.(sb-cold:read-from-file "src/code/early-defstruct-args.lisp-expr")) - (let* ((defstruct (parse-name-and-options-and-slot-descriptions - (first args) - (rest args))) - (inherits (inherits-for-structure defstruct))) - (function-%compiler-only-defstruct defstruct inherits))) + (let* ((dd (parse-defstruct-name-and-options-and-slot-descriptions + (first args) + (rest args))) + (inherits (inherits-for-structure dd))) + (%compiler-defstruct dd inherits))) (/show0 "code/defstruct.lisp end of file")