1 ;;;; This software is part of the SBCL system. See the README file for
4 ;;;; This software is derived from the CMU CL system, which was
5 ;;;; written at Carnegie Mellon University and released into the
6 ;;;; public domain. The software is in the public domain and is
7 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
8 ;;;; files for more information.
10 (in-package "SB!KERNEL")
12 (/show0 "target-defstruct.lisp 12")
14 ;;;; structure frobbing primitives
16 ;;; Allocate a new instance with LENGTH data slots.
17 (defun %make-instance (length)
18 (declare (type index length))
19 (%make-instance length))
21 ;;; Given an instance, return its length.
22 (defun %instance-length (instance)
23 (declare (type instance instance))
24 (%instance-length instance))
26 ;;; Return the value from the INDEXth slot of INSTANCE. This is SETFable.
27 (defun %instance-ref (instance index)
28 (%instance-ref instance index))
30 ;;; Set the INDEXth slot of INSTANCE to NEW-VALUE.
31 (defun %instance-set (instance index new-value)
32 (setf (%instance-ref instance index) new-value))
34 (defun %raw-ref-single (vec index)
35 (declare (type index index))
36 (%raw-ref-single vec index))
38 (defun %raw-ref-double (vec index)
39 (declare (type index index))
40 (%raw-ref-double vec index))
43 (defun %raw-ref-long (vec index)
44 (declare (type index index))
45 (%raw-ref-long vec index))
47 (defun %raw-set-single (vec index val)
48 (declare (type index index))
49 (%raw-set-single vec index val))
51 (defun %raw-set-double (vec index val)
52 (declare (type index index))
53 (%raw-set-double vec index val))
56 (defun %raw-set-long (vec index val)
57 (declare (type index index))
58 (%raw-set-long vec index val))
60 (defun %raw-ref-complex-single (vec index)
61 (declare (type index index))
62 (%raw-ref-complex-single vec index))
64 (defun %raw-ref-complex-double (vec index)
65 (declare (type index index))
66 (%raw-ref-complex-double vec index))
69 (defun %raw-ref-complex-long (vec index)
70 (declare (type index index))
71 (%raw-ref-complex-long vec index))
73 (defun %raw-set-complex-single (vec index val)
74 (declare (type index index))
75 (%raw-set-complex-single vec index val))
77 (defun %raw-set-complex-double (vec index val)
78 (declare (type index index))
79 (%raw-set-complex-double vec index val))
82 (defun %raw-set-complex-long (vec index val)
83 (declare (type index index))
84 (%raw-set-complex-long vec index val))
86 (defun %instance-layout (instance)
87 (%instance-layout instance))
89 (defun %set-instance-layout (instance new-value)
90 (%set-instance-layout instance new-value))
92 (defun %make-funcallable-instance (len layout)
93 (%make-funcallable-instance len layout))
95 (defun funcallable-instance-p (x) (funcallable-instance-p x))
97 (defun %funcallable-instance-info (fin i)
98 (%funcallable-instance-info fin i))
100 (defun %set-funcallable-instance-info (fin i new-value)
101 (%set-funcallable-instance-info fin i new-value))
103 (defun funcallable-instance-fun (fin)
104 (%funcallable-instance-lexenv fin))
106 ;;; The heart of the magic of funcallable instances ("FINs"). The
107 ;;; function for a FIN must be a magical INSTANCE-LAMBDA form. When
108 ;;; called (as with any other function), we grab the code pointer, and
109 ;;; call it, leaving the original function object in LEXENV (in case
110 ;;; it was a closure). If it is actually a FIN, then we need to do an
111 ;;; extra indirection with funcallable-instance-lexenv to get at any
112 ;;; closure environment. This extra indirection is set up when
113 ;;; accessing the closure environment of an INSTANCE-LAMBDA. Note that
114 ;;; the original FIN pointer is lost, so if the called function wants
115 ;;; to get at the original object to do some slot accesses, it must
116 ;;; close over the FIN object.
118 ;;; If we set the FIN function to be a FIN, we directly copy across
119 ;;; both the code pointer and the lexenv, since that code pointer (for
120 ;;; an instance-lambda) is expecting that lexenv to be accessed. This
121 ;;; effectively pre-flattens what would otherwise be a chain of
122 ;;; indirections. (That used to happen when PCL dispatch functions
123 ;;; were byte-compiled; now that the byte compiler is gone, I can't
124 ;;; think of another example offhand. -- WHN 2001-10-06)
126 ;;; The only loss is that if someone accesses the
127 ;;; FUNCALLABLE-INSTANCE-FUN, then won't get a FIN back. This probably
128 ;;; doesn't matter, since PCL only sets the FIN function.
129 (defun (setf funcallable-instance-fun) (new-value fin)
130 (setf (%funcallable-instance-fun fin)
131 (%closure-fun new-value))
132 (setf (%funcallable-instance-lexenv fin)
133 (if (funcallable-instance-p new-value)
134 (%funcallable-instance-lexenv new-value)
137 ;;;; target-only parts of the DEFSTRUCT top-level code
139 ;;; Catch attempts to mess up definitions of symbols in the CL package.
140 (defun protect-cl (symbol)
141 (/show0 "entering PROTECT-CL, SYMBOL=..")
143 (when (and *cold-init-complete-p*
144 (eq (symbol-package symbol) *cl-package*))
145 (cerror "Go ahead and patch the system."
146 "attempting to modify a symbol in the COMMON-LISP package: ~S"
148 (/show0 "leaving PROTECT-CL")
151 ;;; the part of %DEFSTRUCT which sets up out-of-line implementations
152 ;;; of those structure functions which are sufficiently similar
153 ;;; between structures that they can be closures
155 ;;; (The "static" in the name is because it needs to be done not only
156 ;;; in ordinary toplevel %DEFSTRUCT, but also in cold init as early as
157 ;;; possible, to simulate static linking of structure functions as
158 ;;; nearly as possible.)
159 (defun %target-defstruct (dd layout)
160 (declare (type defstruct-description dd))
161 (declare (type layout layout))
163 (/show0 "entering %TARGET-DEFSTRUCT")
165 ;; (Constructors aren't set up here, because constructors are
166 ;; varied enough (possibly parsing any specified argument list)
167 ;; that we can't reasonably implement them as closures, and so
168 ;; implement them with DEFUN instead.)
170 ;; Set FDEFINITIONs for slot accessors.
171 (dolist (dsd (dd-slots dd))
172 (/show0 "doing FDEFINITION for slot accessor")
173 (let ((accessor-name (dsd-accessor-name dsd)))
174 (/show0 "ACCESSOR-NAME=..")
175 (/hexstr accessor-name)
176 (protect-cl accessor-name)
177 (/hexstr "getting READER-FUN and WRITER-FUN")
178 (multiple-value-bind (reader-fun writer-fun) (slot-accessor-funs dd dsd)
179 (declare (type function reader-fun writer-fun))
180 (/show0 "got READER-FUN and WRITER-FUN=..")
182 (setf (symbol-function accessor-name) reader-fun)
183 (unless (dsd-read-only dsd)
184 (/show0 "setting FDEFINITION for WRITER-FUN=..")
186 (setf (fdefinition `(setf ,accessor-name)) writer-fun)))))
188 ;; Set FDEFINITION for copier.
189 (when (dd-copier-name dd)
190 (/show0 "doing FDEFINITION for copier")
191 (protect-cl (dd-copier-name dd))
192 ;; We can't use COPY-STRUCTURE for other kinds of objects, notably
193 ;; funcallable structures, since it returns a STRUCTURE-OBJECT.
194 ;; (And funcallable instances don't need copiers anyway.)
195 (aver (eql (dd-type dd) 'structure))
196 (setf (symbol-function (dd-copier-name dd))
197 ;; FIXME: should use a closure which checks arg type before copying
200 ;; Set FDEFINITION for predicate.
201 (when (dd-predicate-name dd)
202 (/show0 "doing FDEFINITION for predicate")
203 (protect-cl (dd-predicate-name dd))
204 (setf (symbol-function (dd-predicate-name dd))
206 ;; structures with LAYOUTs
207 ((structure funcallable-structure)
208 (/show0 "with-LAYOUT case")
210 (declare (optimize (speed 3) (safety 0)))
211 (/noshow0 "in with-LAYOUT structure predicate closure, OBJECT,LAYOUT=..")
214 (typep-to-layout object layout)))
215 ;; structures with no LAYOUT (i.e. :TYPE VECTOR or :TYPE LIST)
217 ;; FIXME: should handle the :NAMED T case in these cases
219 (/show0 ":TYPE VECTOR case")
222 (/show0 ":TYPE LIST case")
225 (/show0 "leaving %TARGET-DEFSTRUCT")
229 ;;;; generating out-of-line slot accessor functions
231 ;;; FIXME: Ideally, the presence of the type checks in the functions
232 ;;; here would be conditional on the optimization policy at the point
233 ;;; of expansion of DEFSTRUCT. (For now we're just doing the simpler
234 ;;; thing, putting in the type checks unconditionally.)
236 ;;; Return (VALUES SLOT-READER-FUN SLOT-WRITER-FUN).
237 (defun slot-accessor-funs (dd dsd)
239 #+sb-xc (/show0 "entering SLOT-ACCESSOR-FUNS")
241 ;; various code generators
243 ;; Note: They're only minimally parameterized, and cavalierly grab
244 ;; things like INSTANCE and DSD-INDEX from the namespace they're
246 (macrolet (;; code shared between funcallable instance case and the
247 ;; ordinary STRUCTURE-OBJECT case: Handle native
248 ;; structures with LAYOUTs and (possibly) raw slots.
249 (%native-slot-accessor-funs (dd-ref-fun-name)
250 (let ((instance-type-check-form
251 '(%check-structure-type-from-layout instance layout)))
252 (/show "macroexpanding %NATIVE-SLOT-ACCESSOR-FUNS" dd-ref-fun-name instance-type-check-form)
253 `(let ((layout (dd-layout-or-lose dd))
254 (dsd-raw-type (dsd-raw-type dsd)))
255 #+sb-xc (/show0 "in %NATIVE-SLOT-ACCESSOR-FUNS macroexpanded code")
256 ;; Map over all the possible RAW-TYPEs, compiling
257 ;; a different closure-function for each one, so
258 ;; that once the COND over RAW-TYPEs happens (at
259 ;; the time closure is allocated) there are no
260 ;; more decisions to be made and things execute
261 ;; reasonably efficiently.
264 ((eql dsd-raw-type t)
265 #+sb-xc (/show0 "in nonraw slot case")
266 (%slotplace-accessor-funs
267 (,dd-ref-fun-name instance dsd-index)
268 ,instance-type-check-form))
270 ,@(mapcar (lambda (raw-type-and-rawref-fun-name)
271 (destructuring-bind (raw-type
273 raw-type-and-rawref-fun-name
274 `((equal dsd-raw-type ',raw-type)
275 #+sb-xc (/show0 "in raw slot case")
276 (let ((raw-index (dd-raw-index dd)))
277 (%slotplace-accessor-funs
278 (,rawref-fun-name (,dd-ref-fun-name
282 ,instance-type-check-form)))))
283 *raw-type->rawref-fun-name*)
286 (error "internal error: unexpected DSD-RAW-TYPE ~S"
288 ;; code shared between DEFSTRUCT :TYPE LIST and
289 ;; DEFSTRUCT :TYPE VECTOR cases: Handle the "typed
290 ;; structure" case, with no LAYOUTs and no raw slots.
291 (%colontyped-slot-accessor-funs () (error "stub"))
292 ;; the common structure of the raw-slot and not-raw-slot
293 ;; cases, defined in terms of the writable SLOTPLACE. All
294 ;; possible flavors of slot access should be able to pass
296 (%slotplace-accessor-funs (slotplace instance-type-check-form)
297 (/show "macroexpanding %SLOTPLACE-ACCESSOR-FUNS" slotplace instance-type-check-form)
298 `(values (lambda (instance)
299 (/noshow0 "in %SLOTPLACE-ACCESSOR-FUNS-defined reader")
300 ,instance-type-check-form
301 (/noshow0 "back from INSTANCE-TYPE-CHECK-FORM")
303 (let ((typecheckfun (typespec-typecheckfun dsd-type)))
304 (lambda (new-value instance)
305 (/noshow0 "in %SLOTPLACE-ACCESSOR-FUNS-defined writer")
306 ,instance-type-check-form
307 (/noshow0 "back from INSTANCE-TYPE-CHECK-FORM")
308 (funcall typecheckfun new-value)
309 (/noshow0 "back from TYPECHECKFUN")
310 (setf ,slotplace new-value))))))
312 (let ((dsd-index (dsd-index dsd))
313 (dsd-type (dsd-type dsd)))
315 #+sb-xc (/show0 "got DSD-TYPE=..")
316 #+sb-xc (/hexstr dsd-type)
321 #+sb-xc (/show0 "case of DSD-TYPE = STRUCTURE")
322 (%native-slot-accessor-funs %instance-ref))
324 ;; structures with the :TYPE option
326 ;; FIXME: Worry about these later..
328 ;; In :TYPE LIST and :TYPE VECTOR structures, ANSI specifies the
329 ;; layout completely, so that raw slots are impossible.
331 (dd-type-slot-accessor-funs nth-but-with-sane-arg-order
332 `(%check-structure-type-from-dd
335 (dd-type-slot-accessor-funs aref
340 ;;; Copy any old kind of structure.
341 (defun copy-structure (structure)
343 "Return a copy of STRUCTURE with the same (EQL) slot values."
344 (declare (type structure-object structure))
345 (let* ((len (%instance-length structure))
346 (res (%make-instance len))
347 (layout (%instance-layout structure)))
349 (declare (type index len))
350 (when (layout-invalid layout)
351 (error "attempt to copy an obsolete structure:~% ~S" structure))
353 ;; Copy ordinary slots.
355 (declare (type index i))
356 (setf (%instance-ref res i)
357 (%instance-ref structure i)))
360 (let ((raw-index (dd-raw-index (layout-info layout))))
362 (let* ((data (%instance-ref structure raw-index))
363 (raw-len (length data))
364 (new (make-array raw-len :element-type '(unsigned-byte 32))))
365 (declare (type (simple-array (unsigned-byte 32) (*)) data))
366 (setf (%instance-ref res raw-index) new)
368 (setf (aref new i) (aref data i))))))
372 ;;; default PRINT-OBJECT and MAKE-LOAD-FORM methods
374 (defun %default-structure-pretty-print (structure stream)
375 (let* ((layout (%instance-layout structure))
376 (name (sb!xc:class-name (layout-class layout)))
377 (dd (layout-info layout)))
378 (pprint-logical-block (stream nil :prefix "#S(" :suffix ")")
380 (let ((remaining-slots (dd-slots dd)))
381 (when remaining-slots
382 (write-char #\space stream)
383 ;; CMU CL had (PPRINT-INDENT :BLOCK 2 STREAM) here,
384 ;; but I can't see why. -- WHN 20000205
385 (pprint-newline :linear stream)
388 (let ((slot (pop remaining-slots)))
389 (write-char #\: stream)
390 (output-symbol-name (dsd-%name slot) stream)
391 (write-char #\space stream)
392 (pprint-newline :miser stream)
393 (output-object (funcall (fdefinition (dsd-accessor-name slot))
396 (when (null remaining-slots)
398 (write-char #\space stream)
399 (pprint-newline :linear stream))))))))
400 (defun %default-structure-ugly-print (structure stream)
401 (let* ((layout (%instance-layout structure))
402 (name (sb!xc:class-name (layout-class layout)))
403 (dd (layout-info layout)))
404 (descend-into (stream)
405 (write-string "#S(" stream)
407 (do ((index 0 (1+ index))
408 (remaining-slots (dd-slots dd) (cdr remaining-slots)))
409 ((or (null remaining-slots)
410 (and (not *print-readably*)
412 (>= index *print-length*)))
413 (if (null remaining-slots)
414 (write-string ")" stream)
415 (write-string " ...)" stream)))
416 (declare (type index index))
417 (write-char #\space stream)
418 (write-char #\: stream)
419 (let ((slot (first remaining-slots)))
420 (output-symbol-name (dsd-%name slot) stream)
421 (write-char #\space stream)
423 (funcall (fdefinition (dsd-accessor-name slot))
426 (defun default-structure-print (structure stream depth)
427 (declare (ignore depth))
428 (cond ((funcallable-instance-p structure)
429 (print-unreadable-object (structure stream :identity t :type t)))
431 (%default-structure-pretty-print structure stream))
433 (%default-structure-ugly-print structure-stream))))
434 (def!method print-object ((x structure-object) stream)
435 (default-structure-print x stream *current-level*))
437 (defun make-load-form-saving-slots (object &key slot-names environment)
438 (declare (ignore object environment))
440 (error "stub: MAKE-LOAD-FORM-SAVING-SLOTS :SLOT-NAMES not implemented") ; KLUDGE
441 :just-dump-it-normally))
443 ;;;; testing structure types
445 ;;; Return true if OBJ is an object of the structure type
446 ;;; corresponding to LAYOUT. This is called by the accessor closures,
447 ;;; which have a handle on the type's LAYOUT.
449 ;;; FIXME: This is fairly big, so it should probably become
450 ;;; MAYBE-INLINE instead of INLINE. Or else we could fix things up so
451 ;;; that the things which call it are all closures, so that it's
452 ;;; expanded only in a small number of places.
453 #!-sb-fluid (declaim (inline typep-to-layout))
454 (defun typep-to-layout (obj layout)
455 (declare (type layout layout) (optimize (speed 3) (safety 0)))
456 (/noshow0 "entering TYPEP-TO-LAYOUT, OBJ,LAYOUT=..")
459 (when (layout-invalid layout)
460 (error "An obsolete structure accessor function was called."))
461 (/noshow0 "back from testing LAYOUT-INVALID LAYOUT")
462 ;; FIXME: CMU CL used (%INSTANCEP OBJ) here. Check that
463 ;; (TYPEP OBJ 'INSTANCE) is optimized to equally efficient code.
464 (and (typep obj 'instance)
465 (let ((obj-layout (%instance-layout obj)))
466 (cond ((eq obj-layout layout)
467 ;; (In this case OBJ-LAYOUT can't be invalid, because
468 ;; we determined LAYOUT is valid in the test above.)
471 ((layout-invalid obj-layout)
472 (/noshow0 "LAYOUT-INVALID case")
473 (error 'layout-invalid
474 :expected-type (layout-class obj-layout)
477 (let ((depthoid (layout-depthoid layout)))
478 (/noshow0 "DEPTHOID case, DEPTHOID,LAYOUT-INHERITS=..")
480 (/nohexstr layout-inherits)
481 (and (> (layout-depthoid obj-layout) depthoid)
482 (eq (svref (layout-inherits obj-layout) depthoid)
485 ;;;; checking structure types
487 ;;; Check that X is an instance of the named structure type.
488 (defmacro %check-structure-type-from-name (x name)
489 `(%check-structure-type-from-layout ,x ,(compiler-layout-or-lose name)))
491 ;;; Check that X is a structure of the type described by DD.
492 (defmacro %check-structure-type-from-dd (x dd)
493 (declare (type defstruct-description dd))
494 (let ((class-name (dd-name dd)))
496 ((structure funcallable-instance)
497 `(%check-structure-type-from-layout
499 ,(compiler-layout-or-lose class-name)))
501 (let ((xx (gensym "X")))
503 (declare (type vector ,xx))
504 ,@(when (dd-named dd)
505 `((unless (eql (aref ,xx 0) ',class-name)
509 :expected-type `(member ,class-name)
511 "~@<missing name in instance of ~
512 VECTOR-typed structure ~S: ~2I~_S~:>"
513 :format-arguments (list ',class-name ,xx)))))
516 (let ((xx (gensym "X")))
518 (declare (type list ,xx))
519 ,@(when (dd-named dd)
520 `((unless (eql (first ,xx) ',class-name)
524 :expected-type `(member ,class-name)
526 "~@<missing name in instance of LIST-typed structure ~S: ~
528 :format-arguments (list ',class-name ,xx)))))
531 ;;; Check that X is an instance of the structure class with layout LAYOUT.
532 (defun %check-structure-type-from-layout (x layout)
533 (unless (typep-to-layout x layout)
536 :expected-type (class-name (layout-class layout))))
539 (/show0 "target-defstruct.lisp end of file")