1 ;;;; bootstrapping the meta-braid
3 ;;;; The code in this file takes the early definitions that have been
4 ;;;; saved up and actually builds those class objects. This work is
5 ;;;; largely driven off of those class definitions, but the fact that
6 ;;;; STANDARD-CLASS is the class of all metaclasses in the braid is
7 ;;;; built into this code pretty deeply.
9 ;;;; This software is part of the SBCL system. See the README file for
10 ;;;; more information.
12 ;;;; This software is derived from software originally released by Xerox
13 ;;;; Corporation. Copyright and release statements follow. Later modifications
14 ;;;; to the software are in the public domain and are provided with
15 ;;;; absolutely no warranty. See the COPYING and CREDITS files for more
18 ;;;; copyright information from original PCL sources:
20 ;;;; Copyright (c) 1985, 1986, 1987, 1988, 1989, 1990 Xerox Corporation.
21 ;;;; All rights reserved.
23 ;;;; Use and copying of this software and preparation of derivative works based
24 ;;;; upon this software are permitted. Any distribution of this software or
25 ;;;; derivative works must comply with all applicable United States export
28 ;;;; This software is made available AS IS, and Xerox Corporation makes no
29 ;;;; warranty about the software, its performance or its conformity to any
34 (defun allocate-standard-instance (wrapper
35 &optional (slots-init nil slots-init-p))
36 (let ((instance (%%allocate-instance--class))
37 (no-of-slots (wrapper-no-of-instance-slots wrapper)))
38 (setf (std-instance-wrapper instance) wrapper)
39 (setf (std-instance-slots instance)
41 ;; Inline the slots vector allocation and initialization.
42 (let ((slots (make-array no-of-slots :initial-element 0)))
43 (do ((rem-slots slots-init (rest rem-slots))
45 ((>= i no-of-slots)) ;endp rem-slots))
46 (declare (list rem-slots)
48 (setf (aref slots i) (first rem-slots)))
51 (make-array no-of-slots
52 :initial-element +slot-unbound+))))
55 (defmacro allocate-funcallable-instance-slots (wrapper &optional
56 slots-init-p slots-init)
57 `(let ((no-of-slots (wrapper-no-of-instance-slots ,wrapper)))
60 (make-array no-of-slots :initial-contents ,slots-init)
61 (make-array no-of-slots :initial-element +slot-unbound+))
62 `(make-array no-of-slots :initial-element +slot-unbound+))))
64 (defun allocate-funcallable-instance (wrapper &optional
65 (slots-init nil slots-init-p))
66 (let ((fin (allocate-funcallable-instance-1)))
67 (set-funcallable-instance-function
69 #'(sb-kernel:instance-lambda (&rest args)
70 (declare (ignore args))
71 (error "The function of the funcallable-instance ~S has not been set."
73 (setf (fsc-instance-wrapper fin) wrapper
74 (fsc-instance-slots fin) (allocate-funcallable-instance-slots
75 wrapper slots-init-p slots-init))
78 (defun allocate-structure-instance (wrapper &optional
79 (slots-init nil slots-init-p))
80 (let* ((class (wrapper-class wrapper))
81 (constructor (class-defstruct-constructor class)))
83 (let ((instance (funcall constructor))
84 (slots (class-slots class)))
87 (setf (slot-value-using-class class instance slot)
90 (error "can't allocate an instance of class ~S" (class-name class)))))
92 ;;;; BOOTSTRAP-META-BRAID
94 ;;;; This function builds the base metabraid from the early class definitions.
96 ;;;; FIXME: This, like lotso the other stuff in PCL, is not needed in target
97 ;;;; Lisp, only at bootstrap time. Perhaps we should do something kludgy like
98 ;;;; putting a special character (#\$, perhaps) at the beginning of each
99 ;;;; needed-only-at-bootstrap-time symbol and then UNINTERN them all once we're
100 ;;;; done bootstrapping?
102 (defmacro initial-classes-and-wrappers (&rest classes)
104 ,@(mapcar #'(lambda (class)
105 (let ((wr (intern (format nil "~A-WRAPPER" class)
107 `(setf ,wr ,(if (eq class 'standard-generic-function)
110 (early-class-size ',class)
112 ,class (allocate-standard-instance
113 ,(if (eq class 'standard-generic-function)
114 'funcallable-standard-class-wrapper
115 'standard-class-wrapper))
116 (wrapper-class ,wr) ,class
117 (find-class ',class) ,class)))
120 (defun !bootstrap-meta-braid ()
122 (predicate-name (make-type-predicate-name name)))
123 (setf (gdefinition predicate-name)
124 #'(lambda (x) (declare (ignore x)) t))
125 (do-satisfies-deftype name predicate-name))
126 (let* ((*create-classes-from-internal-structure-definitions-p* nil)
127 std-class-wrapper std-class
128 standard-class-wrapper standard-class
129 funcallable-standard-class-wrapper funcallable-standard-class
130 slot-class-wrapper slot-class
131 built-in-class-wrapper built-in-class
132 structure-class-wrapper structure-class
133 standard-direct-slot-definition-wrapper
134 standard-direct-slot-definition
135 standard-effective-slot-definition-wrapper
136 standard-effective-slot-definition
137 class-eq-specializer-wrapper class-eq-specializer
138 standard-generic-function-wrapper standard-generic-function)
139 (initial-classes-and-wrappers
140 standard-class funcallable-standard-class
141 slot-class built-in-class structure-class std-class
142 standard-direct-slot-definition standard-effective-slot-definition
143 class-eq-specializer standard-generic-function)
144 ;; First, make a class metaobject for each of the early classes. For
145 ;; each metaobject we also set its wrapper. Except for the class T,
146 ;; the wrapper is always that of STANDARD-CLASS.
147 (dolist (definition *early-class-definitions*)
148 (let* ((name (ecd-class-name definition))
149 (meta (ecd-metaclass definition))
151 (slot-class slot-class-wrapper)
152 (std-class std-class-wrapper)
153 (standard-class standard-class-wrapper)
154 (funcallable-standard-class
155 funcallable-standard-class-wrapper)
156 (built-in-class built-in-class-wrapper)
157 (structure-class structure-class-wrapper)))
158 (class (or (find-class name nil)
159 (allocate-standard-instance wrapper))))
160 (when (or (eq meta 'standard-class)
161 (eq meta 'funcallable-standard-class))
162 (inform-type-system-about-std-class name))
163 (setf (find-class name) class)))
164 (dolist (definition *early-class-definitions*)
165 (let ((name (ecd-class-name definition))
166 (meta (ecd-metaclass definition))
167 (source (ecd-source definition))
168 (direct-supers (ecd-superclass-names definition))
169 (direct-slots (ecd-canonical-slots definition))
170 (other-initargs (ecd-other-initargs definition)))
171 (let ((direct-default-initargs
172 (getf other-initargs :direct-default-initargs)))
173 (multiple-value-bind (slots cpl default-initargs direct-subclasses)
174 (early-collect-inheritance name)
175 (let* ((class (find-class name))
176 (wrapper (cond ((eq class slot-class)
178 ((eq class std-class)
180 ((eq class standard-class)
181 standard-class-wrapper)
182 ((eq class funcallable-standard-class)
183 funcallable-standard-class-wrapper)
184 ((eq class standard-direct-slot-definition)
185 standard-direct-slot-definition-wrapper)
187 standard-effective-slot-definition)
188 standard-effective-slot-definition-wrapper)
189 ((eq class built-in-class)
190 built-in-class-wrapper)
191 ((eq class structure-class)
192 structure-class-wrapper)
193 ((eq class class-eq-specializer)
194 class-eq-specializer-wrapper)
195 ((eq class standard-generic-function)
196 standard-generic-function-wrapper)
198 (boot-make-wrapper (length slots) name))))
200 (when (eq name t) (setq *the-wrapper-of-t* wrapper))
201 (set (intern (format nil "*THE-CLASS-~A*" (symbol-name name))
205 (unless (eq (getf slot :allocation :instance) :instance)
206 (error "Slot allocation ~S is not supported in bootstrap.")))
208 (when (typep wrapper 'wrapper)
209 (setf (wrapper-instance-slots-layout wrapper)
210 (mapcar #'canonical-slot-name slots))
211 (setf (wrapper-class-slots wrapper)
214 (setq proto (if (eq meta 'funcallable-standard-class)
215 (allocate-funcallable-instance wrapper)
216 (allocate-standard-instance wrapper)))
219 (!bootstrap-make-slot-definitions
220 name class direct-slots
221 standard-direct-slot-definition-wrapper nil))
223 (!bootstrap-make-slot-definitions
225 standard-effective-slot-definition-wrapper t))
228 ((std-class standard-class funcallable-standard-class)
229 (!bootstrap-initialize-class
231 class name class-eq-specializer-wrapper source
232 direct-supers direct-subclasses cpl wrapper proto
233 direct-slots slots direct-default-initargs default-initargs))
234 (built-in-class ; *the-class-t*
235 (!bootstrap-initialize-class
237 class name class-eq-specializer-wrapper source
238 direct-supers direct-subclasses cpl wrapper proto))
239 (slot-class ; *the-class-slot-object*
240 (!bootstrap-initialize-class
242 class name class-eq-specializer-wrapper source
243 direct-supers direct-subclasses cpl wrapper proto))
244 (structure-class ; *the-class-structure-object*
245 (!bootstrap-initialize-class
247 class name class-eq-specializer-wrapper source
248 direct-supers direct-subclasses cpl wrapper))))))))
250 (let* ((smc-class (find-class 'standard-method-combination))
251 (smc-wrapper (!bootstrap-get-slot 'standard-class
254 (smc (allocate-standard-instance smc-wrapper)))
255 (flet ((set-slot (name value)
256 (!bootstrap-set-slot 'standard-method-combination
260 (set-slot 'source *load-truename*)
261 (set-slot 'type 'standard)
262 (set-slot 'documentation "The standard method combination.")
263 (set-slot 'options ()))
264 (setq *standard-method-combination* smc))))
266 ;;; Initialize a class metaobject.
267 (defun !bootstrap-initialize-class
268 (metaclass-name class name
269 class-eq-wrapper source direct-supers direct-subclasses cpl wrapper
271 proto direct-slots slots direct-default-initargs default-initargs)
272 (flet ((classes (names) (mapcar #'find-class names))
273 (set-slot (slot-name value)
274 (!bootstrap-set-slot metaclass-name class slot-name value)))
275 (set-slot 'name name)
276 (set-slot 'source source)
277 (set-slot 'type (if (eq class (find-class t))
279 ;; FIXME: Could this just be CLASS instead
280 ;; of `(CLASS ,CLASS)? If not, why not?
281 ;; (See also similar expression in
282 ;; SHARED-INITIALIZE :BEFORE (CLASS).)
284 (set-slot 'class-eq-specializer
285 (let ((spec (allocate-standard-instance class-eq-wrapper)))
286 (!bootstrap-set-slot 'class-eq-specializer spec 'type
288 (!bootstrap-set-slot 'class-eq-specializer spec 'object
291 (set-slot 'class-precedence-list (classes cpl))
292 (set-slot 'can-precede-list (classes (cdr cpl)))
293 (set-slot 'incompatible-superclass-list nil)
294 (set-slot 'direct-superclasses (classes direct-supers))
295 (set-slot 'direct-subclasses (classes direct-subclasses))
296 (set-slot 'direct-methods (cons nil nil))
297 (set-slot 'wrapper wrapper)
298 (set-slot 'predicate-name (or (cadr (assoc name *early-class-predicates*))
299 (make-class-predicate-name name)))
301 `(,@(and direct-default-initargs
302 `(direct-default-initargs ,direct-default-initargs))
303 ,@(and default-initargs
304 `(default-initargs ,default-initargs))))
305 (when (memq metaclass-name '(standard-class funcallable-standard-class
306 structure-class slot-class std-class))
307 (set-slot 'direct-slots direct-slots)
308 (set-slot 'slots slots)
309 (set-slot 'initialize-info nil))
310 (if (eq metaclass-name 'structure-class)
311 (let ((constructor-sym '|STRUCTURE-OBJECT class constructor|))
312 (set-slot 'predicate-name (or (cadr (assoc name
313 *early-class-predicates*))
314 (make-class-predicate-name name)))
315 (set-slot 'defstruct-form
316 `(defstruct (structure-object (:constructor
319 (set-slot 'defstruct-constructor constructor-sym)
320 (set-slot 'from-defclass-p t)
321 (set-slot 'plist nil)
322 (set-slot 'prototype (funcall constructor-sym)))
323 (set-slot 'prototype (or proto (allocate-standard-instance wrapper))))
326 (defun !bootstrap-make-slot-definitions (name class slots wrapper effective-p)
328 (mapcar (lambda (slot)
330 (!bootstrap-make-slot-definition
331 name class slot wrapper effective-p index))
334 (defun !bootstrap-make-slot-definition
335 (name class slot wrapper effective-p index)
336 (let* ((slotd-class-name (if effective-p
337 'standard-effective-slot-definition
338 'standard-direct-slot-definition))
339 (slotd (allocate-standard-instance wrapper))
340 (slot-name (getf slot :name)))
341 (flet ((get-val (name) (getf slot name))
343 (!bootstrap-set-slot slotd-class-name slotd name val)))
344 (set-val 'name slot-name)
345 (set-val 'initform (get-val :initform))
346 (set-val 'initfunction (get-val :initfunction))
347 (set-val 'initargs (get-val :initargs))
348 (set-val 'readers (get-val :readers))
349 (set-val 'writers (get-val :writers))
350 (set-val 'allocation :instance)
351 (set-val 'type (or (get-val :type) t))
352 (set-val 'documentation (or (get-val :documentation) ""))
353 (set-val 'class class)
355 (set-val 'location index)
357 (set-val 'reader-function (make-optimized-std-reader-method-function
358 fsc-p slot-name index))
359 (set-val 'writer-function (make-optimized-std-writer-method-function
360 fsc-p slot-name index))
361 (set-val 'boundp-function (make-optimized-std-boundp-method-function
362 fsc-p slot-name index)))
363 (set-val 'accessor-flags 7)
364 (let ((table (or (gethash slot-name *name->class->slotd-table*)
365 (setf (gethash slot-name *name->class->slotd-table*)
366 (make-hash-table :test 'eq :size 5)))))
367 (setf (gethash class table) slotd)))
368 (when (and (eq name 'standard-class)
369 (eq slot-name 'slots) effective-p)
370 (setq *the-eslotd-standard-class-slots* slotd))
371 (when (and (eq name 'funcallable-standard-class)
372 (eq slot-name 'slots) effective-p)
373 (setq *the-eslotd-funcallable-standard-class-slots* slotd))
376 (defun !bootstrap-accessor-definitions (early-p)
377 (let ((*early-p* early-p))
378 (dolist (definition *early-class-definitions*)
379 (let ((name (ecd-class-name definition))
380 (meta (ecd-metaclass definition)))
381 (unless (eq meta 'built-in-class)
382 (let ((direct-slots (ecd-canonical-slots definition)))
383 (dolist (slotd direct-slots)
384 (let ((slot-name (getf slotd :name))
385 (readers (getf slotd :readers))
386 (writers (getf slotd :writers)))
387 (!bootstrap-accessor-definitions1
393 (!bootstrap-accessor-definitions1
396 (list (slot-reader-symbol slot-name))
397 (list (slot-writer-symbol slot-name))
398 (list (slot-boundp-symbol slot-name)))))))))))
400 (defun !bootstrap-accessor-definition (class-name accessor-name slot-name type)
401 (multiple-value-bind (accessor-class make-method-function arglist specls doc)
403 (reader (values 'standard-reader-method
404 #'make-std-reader-method-function
407 "automatically generated reader method"))
408 (writer (values 'standard-writer-method
409 #'make-std-writer-method-function
410 (list 'new-value class-name)
412 "automatically generated writer method"))
413 (boundp (values 'standard-boundp-method
414 #'make-std-boundp-method-function
417 "automatically generated boundp method")))
418 (let ((gf (ensure-generic-function accessor-name)))
419 (if (find specls (early-gf-methods gf)
420 :key #'early-method-specializers
422 (unless (assoc accessor-name *!generic-function-fixups*
426 (make-a-method accessor-class
429 (funcall make-method-function
430 class-name slot-name)
434 (defun !bootstrap-accessor-definitions1 (class-name
439 (flet ((do-reader-definition (reader)
440 (!bootstrap-accessor-definition class-name
444 (do-writer-definition (writer)
445 (!bootstrap-accessor-definition class-name
449 (do-boundp-definition (boundp)
450 (!bootstrap-accessor-definition class-name
454 (dolist (reader readers) (do-reader-definition reader))
455 (dolist (writer writers) (do-writer-definition writer))
456 (dolist (boundp boundps) (do-boundp-definition boundp))))
458 (defun !bootstrap-class-predicates (early-p)
459 (let ((*early-p* early-p))
460 (dolist (definition *early-class-definitions*)
461 (let* ((name (ecd-class-name definition))
462 (class (find-class name)))
463 (setf (find-class-predicate name)
464 (make-class-predicate class (class-predicate-name class)))))))
466 (defun !bootstrap-built-in-classes ()
468 ;; First make sure that all the supers listed in
469 ;; *BUILT-IN-CLASS-LATTICE* are themselves defined by
470 ;; *BUILT-IN-CLASS-LATTICE*. This is just to check for typos and
471 ;; other sorts of brainos.
472 (dolist (e *built-in-classes*)
473 (dolist (super (cadr e))
474 (unless (or (eq super t)
475 (assq super *built-in-classes*))
476 (error "in *BUILT-IN-CLASSES*: ~S has ~S as a super,~%~
477 but ~S is not itself a class in *BUILT-IN-CLASSES*."
478 (car e) super super))))
480 ;; In the first pass, we create a skeletal object to be bound to the
482 (let* ((built-in-class (find-class 'built-in-class))
483 (built-in-class-wrapper (class-wrapper built-in-class)))
484 (dolist (e *built-in-classes*)
485 (let ((class (allocate-standard-instance built-in-class-wrapper)))
486 (setf (find-class (car e)) class))))
488 ;; In the second pass, we initialize the class objects.
489 (let ((class-eq-wrapper (class-wrapper (find-class 'class-eq-specializer))))
490 (dolist (e *built-in-classes*)
491 (destructuring-bind (name supers subs cpl prototype) e
492 (let* ((class (find-class name))
493 (lclass (cl:find-class name))
494 (wrapper (sb-kernel:class-layout lclass)))
495 (set (get-built-in-class-symbol name) class)
496 (set (get-built-in-wrapper-symbol name) wrapper)
497 (setf (sb-kernel:class-pcl-class lclass) class)
499 (!bootstrap-initialize-class 'built-in-class class
500 name class-eq-wrapper nil
503 wrapper prototype)))))
505 (dolist (e *built-in-classes*)
506 (let* ((name (car e))
507 (class (find-class name)))
508 (setf (find-class-predicate name)
509 (make-class-predicate class (class-predicate-name class))))))
511 (defmacro wrapper-of-macro (x)
512 `(sb-kernel:layout-of ,x))
515 (wrapper-class* (wrapper-of-macro x)))
517 ;;; FIXME: We probably don't need both WRAPPER-OF and WRAPPER-OF-MACRO.
518 #-sb-fluid (declaim (inline wrapper-of))
519 (defun wrapper-of (x)
520 (wrapper-of-macro x))
522 (defvar *find-structure-class* nil)
524 (defun eval-form (form)
525 #'(lambda () (eval form)))
527 (defun slot-initargs-from-structure-slotd (slotd)
528 `(:name ,(structure-slotd-name slotd)
529 :defstruct-accessor-symbol ,(structure-slotd-accessor-symbol slotd)
530 :internal-reader-function ,(structure-slotd-reader-function slotd)
531 :internal-writer-function ,(structure-slotd-writer-function slotd)
532 :type ,(or (structure-slotd-type slotd) t)
533 :initform ,(structure-slotd-init-form slotd)
534 :initfunction ,(eval-form (structure-slotd-init-form slotd))))
536 (defun find-structure-class (symbol)
537 (if (structure-type-p symbol)
538 (unless (eq *find-structure-class* symbol)
539 (let ((*find-structure-class* symbol))
541 :metaclass 'structure-class
544 (cond ;; Handle our CMU-CL-ish structure-based
546 ((cl:subtypep symbol 'condition)
547 (mapcar #'cl:class-name
548 (sb-kernel:class-direct-superclasses
549 (cl:find-class symbol))))
550 ;; a hack to add the STREAM class as a
551 ;; mixin to the LISP-STREAM class.
552 ((eq symbol 'sb-kernel:lisp-stream)
553 '(structure-object stream))
554 ((structure-type-included-type-name symbol)
555 (list (structure-type-included-type-name
558 (mapcar #'slot-initargs-from-structure-slotd
559 (structure-type-slot-description-list
561 (error "~S is not a legal structure class name." symbol)))
563 (defun make-class-predicate (class name)
564 (let* ((gf (ensure-generic-function name))
565 (mlist (if (eq *boot-state* 'complete)
566 (generic-function-methods gf)
567 (early-gf-methods gf))))
569 (unless (eq class *the-class-t*)
570 (let* ((default-method-function #'constantly-nil)
571 (default-method-initargs (list :function
572 default-method-function))
573 (default-method (make-a-method 'standard-method
577 default-method-initargs
578 "class predicate default method")))
579 (setf (method-function-get default-method-function :constant-value)
581 (add-method gf default-method)))
582 (let* ((class-method-function #'constantly-t)
583 (class-method-initargs (list :function
584 class-method-function))
585 (class-method (make-a-method 'standard-method
589 class-method-initargs
590 "class predicate class method")))
591 (setf (method-function-get class-method-function :constant-value) t)
592 (add-method gf class-method)))
595 ;;; Set the inherits from CPL, and register the layout. This actually
596 ;;; installs the class in the Lisp type system.
597 (defun update-lisp-class-layout (class layout)
598 (let ((lclass (sb-kernel:layout-class layout)))
599 (unless (eq (sb-kernel:class-layout lclass) layout)
600 (setf (sb-kernel:layout-inherits layout)
601 (map 'vector #'class-wrapper
602 (reverse (rest (class-precedence-list class)))))
603 (sb-kernel:register-layout layout :invalidate nil)
605 ;; Subclasses of formerly forward-referenced-class may be
606 ;; unknown to CL:FIND-CLASS and also anonymous. This
607 ;; functionality moved here from (SETF FIND-CLASS).
608 (let ((name (class-name class)))
609 (setf (cl:find-class name) lclass
610 ;; FIXME: It's nasty to use double colons. Perhaps the
611 ;; best way to fix this is not to export CLASS-%NAME
612 ;; from SB-KERNEL, but instead to move the whole
613 ;; UPDATE-LISP-CLASS-LAYOUT function to SB-KERNEL, and
614 ;; export it. (since it's also nasty for us to be
615 ;; reaching into %KERNEL implementation details my
616 ;; messing with raw CLASS-%NAME)
617 (sb-kernel::class-%name lclass) name)))))
619 (clrhash *find-class*)
620 (!bootstrap-meta-braid)
621 (!bootstrap-accessor-definitions t)
622 (!bootstrap-class-predicates t)
623 (!bootstrap-accessor-definitions nil)
624 (!bootstrap-class-predicates nil)
625 (!bootstrap-built-in-classes)
627 (dohash (name x *find-class*)
628 (let* ((class (find-class-from-cell name x))
629 (layout (class-wrapper class))
630 (lclass (sb-kernel:layout-class layout))
631 (lclass-pcl-class (sb-kernel:class-pcl-class lclass))
632 (olclass (cl:find-class name nil)))
634 (aver (eq class lclass-pcl-class))
635 (setf (sb-kernel:class-pcl-class lclass) class))
637 (update-lisp-class-layout class layout)
640 (aver (eq lclass olclass)))
642 (setf (cl:find-class name) lclass)))))
644 (setq *boot-state* 'braid)
646 (defmethod no-applicable-method (generic-function &rest args)
647 (error "~@<There is no matching method for the generic function ~2I~_~S~
648 ~I~_when called with arguments ~2I~_~S.~:>"