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 ;;; service function for structure constructors
138 (defun %make-instance-with-layout (layout)
139 (let ((result (%make-instance (layout-length layout))))
140 (setf (%instance-layout result) layout)
143 ;;;; target-only parts of the DEFSTRUCT top level code
145 ;;; A list of hooks designating functions of one argument, the
146 ;;; classoid, to be called when a defstruct is evaluated.
147 (defvar *defstruct-hooks* nil)
149 ;;; Catch attempts to mess up definitions of symbols in the CL package.
150 (defun protect-cl (symbol)
151 (/show0 "entering PROTECT-CL, SYMBOL=..")
153 (when (and *cold-init-complete-p*
154 (eq (symbol-package symbol) *cl-package*))
155 (cerror "Go ahead and patch the system."
156 "attempting to modify a symbol in the COMMON-LISP package: ~S"
158 (/show0 "leaving PROTECT-CL")
161 ;;; the part of %DEFSTRUCT which makes sense only on the target SBCL
163 ;;; (The "static" in the name is because it needs to be done not only
164 ;;; in ordinary toplevel %DEFSTRUCT, but also in cold init as early as
165 ;;; possible, to simulate static linking of structure functions as
166 ;;; nearly as possible.)
167 (defun %target-defstruct (dd layout)
168 (declare (type defstruct-description dd))
169 (declare (type layout layout))
171 (/show0 "entering %TARGET-DEFSTRUCT")
173 (remhash (dd-name dd) *typecheckfuns*)
175 ;; (Constructors aren't set up here, because constructors are
176 ;; varied enough (possibly parsing any specified argument list)
177 ;; that we can't reasonably implement them as closures, so we
178 ;; implement them with DEFUN instead.)
180 ;; Set FDEFINITIONs for slot accessors.
181 (dolist (dsd (dd-slots dd))
182 (/show0 "doing FDEFINITION for slot accessor")
183 (let ((accessor-name (dsd-accessor-name dsd)))
184 ;; We mustn't step on any inherited accessors
185 (unless (accessor-inherited-data accessor-name dd)
186 (/show0 "ACCESSOR-NAME=..")
187 (/hexstr accessor-name)
188 (protect-cl accessor-name)
189 (/hexstr "getting READER-FUN and WRITER-FUN")
190 (multiple-value-bind (reader-fun writer-fun)
191 (slot-accessor-funs dd dsd)
192 (declare (type function reader-fun writer-fun))
193 (/show0 "got READER-FUN and WRITER-FUN=..")
195 (setf (symbol-function accessor-name) reader-fun)
196 (unless (dsd-read-only dsd)
197 (/show0 "setting FDEFINITION for WRITER-FUN=..")
199 (setf (fdefinition `(setf ,accessor-name)) writer-fun))))))
201 ;; Set FDEFINITION for copier.
202 (when (dd-copier-name dd)
203 (/show0 "doing FDEFINITION for copier")
204 (protect-cl (dd-copier-name dd))
205 ;; We can't use COPY-STRUCTURE for other kinds of objects, notably
206 ;; funcallable structures, since it returns a STRUCTURE-OBJECT.
207 ;; (And funcallable instances don't need copiers anyway.)
208 (aver (eql (dd-type dd) 'structure))
209 (setf (symbol-function (dd-copier-name dd))
210 ;; FIXME: should use a closure which checks arg type before copying
213 ;; Set FDEFINITION for predicate.
214 (when (dd-predicate-name dd)
215 (/show0 "doing FDEFINITION for predicate")
216 (protect-cl (dd-predicate-name dd))
217 (setf (symbol-function (dd-predicate-name dd))
219 ;; structures with LAYOUTs
220 ((structure funcallable-structure)
221 (/show0 "with-LAYOUT case")
223 (locally ; <- to keep SAFETY 0 from affecting arg count checking
224 (declare (optimize (speed 3) (safety 0)))
225 (/noshow0 "in with-LAYOUT structure predicate closure, OBJECT,LAYOUT=..")
228 (typep-to-layout object layout))))
229 ;; structures with no LAYOUT (i.e. :TYPE VECTOR or :TYPE LIST)
231 ;; FIXME: should handle the :NAMED T case in these cases
233 (/show0 ":TYPE VECTOR case")
236 (/show0 ":TYPE LIST case")
240 (setf (fdocumentation (dd-name dd) 'type)
243 ;; the BOUNDP test here is to get past cold-init.
244 (when (boundp '*defstruct-hooks*)
245 (dolist (fun *defstruct-hooks*)
246 (funcall fun (find-classoid (dd-name dd)))))
248 (/show0 "leaving %TARGET-DEFSTRUCT")
251 ;;;; generating out-of-line slot accessor functions
253 ;;; FIXME: Ideally, the presence of the type checks in the functions
254 ;;; here would be conditional on the optimization policy at the point
255 ;;; of expansion of DEFSTRUCT. (For now we're just doing the simpler
256 ;;; thing, putting in the type checks unconditionally.)
258 ;;; Return (VALUES SLOT-READER-FUN SLOT-WRITER-FUN).
259 (defun slot-accessor-funs (dd dsd)
261 #+sb-xc (/show0 "entering SLOT-ACCESSOR-FUNS")
263 ;; various code generators
265 ;; Note: They're only minimally parameterized, and cavalierly grab
266 ;; things like INSTANCE and DSD-INDEX from the namespace they're
268 (macrolet (;; code shared between funcallable instance case and the
269 ;; ordinary STRUCTURE-OBJECT case: Handle native
270 ;; structures with LAYOUTs and (possibly) raw slots.
271 (%native-slot-accessor-funs (dd-ref-fun-name)
272 (let ((instance-type-check-form
273 '(%check-structure-type-from-layout instance layout)))
274 (/show "macroexpanding %NATIVE-SLOT-ACCESSOR-FUNS" dd-ref-fun-name instance-type-check-form)
275 `(let ((layout (dd-layout-or-lose dd))
276 (dsd-raw-type (dsd-raw-type dsd)))
277 #+sb-xc (/show0 "in %NATIVE-SLOT-ACCESSOR-FUNS macroexpanded code")
278 ;; Map over all the possible RAW-TYPEs, compiling
279 ;; a different closure function for each one, so
280 ;; that once the COND over RAW-TYPEs happens (at
281 ;; the time closure is allocated) there are no
282 ;; more decisions to be made and things execute
283 ;; reasonably efficiently.
286 ((eql dsd-raw-type t)
287 #+sb-xc (/show0 "in nonraw slot case")
288 (%slotplace-accessor-funs
289 (,dd-ref-fun-name instance dsd-index)
290 ,instance-type-check-form))
292 ,@(mapcar (lambda (rtd)
293 (let ((raw-type (raw-slot-data-raw-type rtd))
295 (raw-slot-data-accessor-name rtd))
296 (n-words (raw-slot-data-n-words rtd)))
297 `((equal dsd-raw-type ',raw-type)
298 #+sb-xc (/show0 "in raw slot case")
299 (let ((raw-index (dd-raw-index dd)))
300 (multiple-value-bind (scaled-dsd-index
302 (floor dsd-index ,n-words)
303 (aver (zerop misalignment))
304 (%slotplace-accessor-funs
305 (,accessor-name (,dd-ref-fun-name
309 ,instance-type-check-form))))))
310 *raw-slot-data-list*)
313 (bug "unexpected DSD-RAW-TYPE ~S" dsd-raw-type))))))
314 ;; code shared between DEFSTRUCT :TYPE LIST and
315 ;; DEFSTRUCT :TYPE VECTOR cases: Handle the "typed
316 ;; structure" case, with no LAYOUTs and no raw slots.
317 (%colontyped-slot-accessor-funs () (error "stub"))
318 ;; the common structure of the raw-slot and not-raw-slot
319 ;; cases, defined in terms of the writable SLOTPLACE. All
320 ;; possible flavors of slot access should be able to pass
322 (%slotplace-accessor-funs (slotplace instance-type-check-form)
323 (/show "macroexpanding %SLOTPLACE-ACCESSOR-FUNS" slotplace instance-type-check-form)
324 `(values (lambda (instance)
325 (/noshow0 "in %SLOTPLACE-ACCESSOR-FUNS-defined reader")
326 ,instance-type-check-form
327 (/noshow0 "back from INSTANCE-TYPE-CHECK-FORM")
329 (let ((typecheckfun (typespec-typecheckfun dsd-type)))
330 (lambda (new-value instance)
331 (/noshow0 "in %SLOTPLACE-ACCESSOR-FUNS-defined writer")
332 ,instance-type-check-form
333 (/noshow0 "back from INSTANCE-TYPE-CHECK-FORM")
334 (funcall typecheckfun new-value)
335 (/noshow0 "back from TYPECHECKFUN")
336 (setf ,slotplace new-value))))))
338 (let ((dsd-index (dsd-index dsd))
339 (dsd-type (dsd-type dsd)))
341 #+sb-xc (/show0 "got DSD-TYPE=..")
342 #+sb-xc (/hexstr dsd-type)
347 #+sb-xc (/show0 "case of DSD-TYPE = STRUCTURE")
348 (%native-slot-accessor-funs %instance-ref))
350 ;; structures with the :TYPE option
352 ;; FIXME: Worry about these later..
354 ;; In :TYPE LIST and :TYPE VECTOR structures, ANSI specifies the
355 ;; layout completely, so that raw slots are impossible.
357 (dd-type-slot-accessor-funs nth-but-with-sane-arg-order
358 `(%check-structure-type-from-dd
361 (dd-type-slot-accessor-funs aref
366 ;;; Copy any old kind of structure.
367 (defun copy-structure (structure)
369 "Return a copy of STRUCTURE with the same (EQL) slot values."
370 (declare (type structure-object structure))
371 (let* ((len (%instance-length structure))
372 (res (%make-instance len))
373 (layout (%instance-layout structure)))
375 (declare (type index len))
376 (when (layout-invalid layout)
377 (error "attempt to copy an obsolete structure:~% ~S" structure))
379 ;; Copy ordinary slots.
381 (declare (type index i))
382 (setf (%instance-ref res i)
383 (%instance-ref structure i)))
386 (let ((raw-index (dd-raw-index (layout-info layout))))
388 (let* ((data (%instance-ref structure raw-index))
389 (raw-len (length data))
390 (new (make-array raw-len :element-type '(unsigned-byte 32))))
391 (declare (type (simple-array (unsigned-byte 32) (*)) data))
392 (setf (%instance-ref res raw-index) new)
394 (setf (aref new i) (aref data i))))))
398 ;;; default PRINT-OBJECT method
400 (defun %default-structure-pretty-print (structure stream)
401 (let* ((layout (%instance-layout structure))
402 (name (classoid-name (layout-classoid layout)))
403 (dd (layout-info layout)))
404 ;; KLUDGE: during the build process with SB-SHOW, we can sometimes
405 ;; attempt to print out a PCL object (with null LAYOUT-INFO).
408 (pprint-logical-block (stream nil :prefix "#<" :suffix ">")
410 (write-char #\space stream)
411 (write-string "(no LAYOUT-INFO)"))
412 (return-from %default-structure-pretty-print nil))
413 (pprint-logical-block (stream nil :prefix "#S(" :suffix ")")
415 (let ((remaining-slots (dd-slots dd)))
416 (when remaining-slots
417 (write-char #\space stream)
418 ;; CMU CL had (PPRINT-INDENT :BLOCK 2 STREAM) here,
419 ;; but I can't see why. -- WHN 20000205
420 (pprint-newline :linear stream)
423 (let ((slot (pop remaining-slots)))
424 (write-char #\: stream)
425 (output-symbol-name (symbol-name (dsd-name slot)) stream)
426 (write-char #\space stream)
427 (pprint-newline :miser stream)
428 (output-object (funcall (fdefinition (dsd-accessor-name slot))
431 (when (null remaining-slots)
433 (write-char #\space stream)
434 (pprint-newline :linear stream))))))))
435 (defun %default-structure-ugly-print (structure stream)
436 (let* ((layout (%instance-layout structure))
437 (name (classoid-name (layout-classoid layout)))
438 (dd (layout-info layout)))
439 (descend-into (stream)
440 (write-string "#S(" stream)
442 (do ((index 0 (1+ index))
443 (remaining-slots (dd-slots dd) (cdr remaining-slots)))
444 ((or (null remaining-slots)
445 (and (not *print-readably*)
447 (>= index *print-length*)))
448 (if (null remaining-slots)
449 (write-string ")" stream)
450 (write-string " ...)" stream)))
451 (declare (type index index))
452 (write-char #\space stream)
453 (write-char #\: stream)
454 (let ((slot (first remaining-slots)))
455 (output-symbol-name (symbol-name (dsd-name slot)) stream)
456 (write-char #\space stream)
458 (funcall (fdefinition (dsd-accessor-name slot))
461 (defun default-structure-print (structure stream depth)
462 (declare (ignore depth))
463 (cond ((funcallable-instance-p structure)
464 (print-unreadable-object (structure stream :identity t :type t)))
466 (%default-structure-pretty-print structure stream))
468 (%default-structure-ugly-print structure stream))))
469 (def!method print-object ((x structure-object) stream)
470 (default-structure-print x stream *current-level-in-print*))
472 ;;;; testing structure types
474 ;;; Return true if OBJ is an object of the structure type
475 ;;; corresponding to LAYOUT. This is called by the accessor closures,
476 ;;; which have a handle on the type's LAYOUT.
478 ;;; FIXME: This is fairly big, so it should probably become
479 ;;; MAYBE-INLINE instead of INLINE, or its inlineness should become
480 ;;; conditional (probably through DEFTRANSFORM) on (> SPEED SPACE). Or
481 ;;; else we could fix things up so that the things which call it are
482 ;;; all closures, so that it's expanded only in a small number of
484 #!-sb-fluid (declaim (inline typep-to-layout))
485 (defun typep-to-layout (obj layout)
486 (declare (type layout layout) (optimize (speed 3) (safety 0)))
487 (/noshow0 "entering TYPEP-TO-LAYOUT, OBJ,LAYOUT=..")
490 (when (layout-invalid layout)
491 (error "An obsolete structure accessor function was called."))
492 (/noshow0 "back from testing LAYOUT-INVALID LAYOUT")
493 ;; FIXME: CMU CL used (%INSTANCEP OBJ) here. Check that
494 ;; (TYPEP OBJ 'INSTANCE) is optimized to equally efficient code.
495 (and (typep obj 'instance)
496 (let ((obj-layout (%instance-layout obj)))
497 (cond ((eq obj-layout layout)
498 ;; (In this case OBJ-LAYOUT can't be invalid, because
499 ;; we determined LAYOUT is valid in the test above.)
502 ((layout-invalid obj-layout)
503 (/noshow0 "LAYOUT-INVALID case")
504 (error 'layout-invalid
505 :expected-type (layout-classoid obj-layout)
508 (let ((depthoid (layout-depthoid layout)))
509 (/noshow0 "DEPTHOID case, DEPTHOID,LAYOUT-INHERITS=..")
511 (/nohexstr layout-inherits)
512 (and (> (layout-depthoid obj-layout) depthoid)
513 (eq (svref (layout-inherits obj-layout) depthoid)
516 ;;;; checking structure types
518 ;;; Check that X is an instance of the named structure type.
519 (defmacro %check-structure-type-from-name (x name)
520 `(%check-structure-type-from-layout ,x ,(compiler-layout-or-lose name)))
522 ;;; Check that X is a structure of the type described by DD.
523 (defmacro %check-structure-type-from-dd (x dd)
524 (declare (type defstruct-description dd))
525 (let ((class-name (dd-name dd)))
527 ((structure funcallable-instance)
528 `(%check-structure-type-from-layout
530 ,(compiler-layout-or-lose class-name)))
532 (with-unique-names (xx)
534 (declare (type vector ,xx))
535 ,@(when (dd-named dd)
536 `((unless (eql (aref ,xx 0) ',class-name)
540 :expected-type `(member ,class-name)
542 "~@<missing name in instance of ~
543 VECTOR-typed structure ~S: ~2I~_S~:>"
544 :format-arguments (list ',class-name ,xx)))))
547 (with-unique-names (xx)
549 (declare (type list ,xx))
550 ,@(when (dd-named dd)
551 `((unless (eql (first ,xx) ',class-name)
555 :expected-type `(member ,class-name)
557 "~@<missing name in instance of LIST-typed structure ~S: ~
559 :format-arguments (list ',class-name ,xx)))))
562 ;;; Check that X is an instance of the structure class with layout LAYOUT.
563 (defun %check-structure-type-from-layout (x layout)
564 (unless (typep-to-layout x layout)
567 :expected-type (classoid-name (layout-classoid layout))))
570 (/show0 "target-defstruct.lisp end of file")