1 ;;;; This file contains the optimization machinery for make-instance.
3 ;;;; This software is part of the SBCL system. See the README file for
6 ;;;; This software is derived from software originally released by
7 ;;;; Gerd Moellmann. Copyright and release statements follow. Later
8 ;;;; modifications to the software are in the public domain and are
9 ;;;; provided with absolutely no warranty. See the COPYING and
10 ;;;; CREDITS files for more information.
12 ;;; Copyright (C) 2002 Gerd Moellmann <gerd.moellmann@t-online.de>
13 ;;; All rights reserved.
15 ;;; Redistribution and use in source and binary forms, with or without
16 ;;; modification, are permitted provided that the following conditions
19 ;;; 1. Redistributions of source code must retain the above copyright
20 ;;; notice, this list of conditions and the following disclaimer.
21 ;;; 2. Redistributions in binary form must reproduce the above copyright
22 ;;; notice, this list of conditions and the following disclaimer in the
23 ;;; documentation and/or other materials provided with the distribution.
24 ;;; 3. The name of the author may not be used to endorse or promote
25 ;;; products derived from this software without specific prior written
28 ;;; THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
29 ;;; OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
30 ;;; WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
31 ;;; ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE
32 ;;; LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
33 ;;; CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
34 ;;; OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
35 ;;; BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
36 ;;; LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 ;;; (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
38 ;;; USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
45 ;;; Compiler macro for MAKE-INSTANCE, and load-time generation of
46 ;;; optimized instance constructor functions.
48 ;;; ********************
49 ;;; Entry Points ******
50 ;;; ********************
52 ;;; UPDATE-CTORS must be called when methods are added/removed,
53 ;;; classes are changed, etc., which affect instance creation.
55 ;;; PRECOMPILE-CTORS can be called to precompile constructor functions
56 ;;; for classes whose definitions are known at the time the function
61 ;;; ******************
63 ;;; ******************
65 (defun plist-keys (plist &key test)
66 (loop for (key . more) on plist by #'cddr
68 (error "Not a property list: ~S" plist)
69 else if (or (null test) (funcall test key))
72 (defun plist-values (plist &key test)
73 (loop for (key . more) on plist by #'cddr
75 (error "Not a property list: ~S" plist)
76 else if (or (null test) (funcall test (car more)))
79 (defun constant-symbol-p (form)
81 (let ((constant (eval form)))
82 (and (symbolp constant)
83 (not (null (symbol-package constant)))))))
90 ;;; Ctors are funcallable instances whose initial function is a
91 ;;; function computing an optimized constructor function when called.
92 ;;; When the optimized function is computed, the function of the
93 ;;; funcallable instance is set to it.
95 (!defstruct-with-alternate-metaclass ctor
96 :slot-names (function-name class-name class initargs)
97 :boa-constructor %make-ctor
98 :superclass-name pcl-funcallable-instance
99 :metaclass-name random-pcl-classoid
100 :metaclass-constructor make-random-pcl-classoid
101 :dd-type funcallable-structure
102 :runtime-type-checks-p nil)
104 ;;; List of all defined ctors.
106 (defvar *all-ctors* ())
108 (defun make-ctor-parameter-list (ctor)
109 (plist-values (ctor-initargs ctor) :test (complement #'constantp)))
112 ;;; Reset CTOR to use a default function that will compute an
113 ;;; optimized constructor function when called.
115 (defun install-initial-constructor (ctor &key force-p)
116 (when (or force-p (ctor-class ctor))
117 (setf (ctor-class ctor) nil)
118 (setf (funcallable-instance-fun ctor)
119 #'(instance-lambda (&rest args)
120 (install-optimized-constructor ctor)
122 (setf (%funcallable-instance-info ctor 1)
123 (ctor-function-name ctor))))
126 ;;; Keep this a separate function for testing.
128 (defun make-ctor-function-name (class-name initargs)
129 (let ((*package* *pcl-package*)
130 (*print-case* :upcase)
133 (intern (format nil "CTOR ~S::~S ~S ~S"
134 (package-name (symbol-package class-name))
135 (symbol-name class-name)
136 (plist-keys initargs)
137 (plist-values initargs :test #'constantp))
141 ;;; Keep this a separate function for testing.
143 (defun ensure-ctor (function-name class-name initargs)
144 (unless (fboundp function-name)
145 (make-ctor function-name class-name initargs)))
148 ;;; Keep this a separate function for testing.
150 (defun make-ctor (function-name class-name initargs)
151 (let ((ctor (%make-ctor function-name class-name nil initargs)))
152 (push ctor *all-ctors*)
153 (setf (symbol-function function-name) ctor)
154 (install-initial-constructor ctor :force-p t)
158 ;;; ***********************************************
159 ;;; Compile-Time Expansion of MAKE-INSTANCE *******
160 ;;; ***********************************************
162 (define-compiler-macro make-instance (&whole form &rest args)
163 (declare (ignore args))
164 (or (make-instance->constructor-call form)
167 (defun make-instance->constructor-call (form)
168 (destructuring-bind (fn class-name &rest args) form
169 (declare (ignore fn))
171 ;; Return the name of parameter number I of a constructor
174 (let ((ps #(.p0. .p1. .p2. .p3. .p4. .p5.)))
175 (if (array-in-bounds-p ps i)
177 (intern (format nil ".P~D." i) *pcl-package*))))
179 ;; Check if CLASS-NAME is a constant symbol. Give up if
182 (unless (and class-name (constant-symbol-p class-name))
183 (return-from make-instance->constructor-call nil)))
185 ;; Check if ARGS are suitable for an optimized constructor.
186 ;; Return NIL from the outer function if not.
188 (loop for (key . more) on args by #'cddr do
189 (when (or (null more)
190 (not (constant-symbol-p key))
191 (eq :allow-other-keys (eval key)))
192 (return-from make-instance->constructor-call nil)))))
196 ;; Collect a plist of initargs and constant values/parameter names
197 ;; in INITARGS. Collect non-constant initialization forms in
199 (multiple-value-bind (initargs value-forms)
200 (loop for (key value) on args by #'cddr and i from 0
201 collect (eval key) into initargs
203 collect value into initargs
205 collect (parameter-name i) into initargs
206 and collect value into value-forms
208 (return (values initargs value-forms)))
209 (let* ((class-name (eval class-name))
210 (function-name (make-ctor-function-name class-name initargs)))
212 ;; Prevent compiler warnings for calling the ctor.
213 (proclaim-as-fun-name function-name)
214 (note-name-defined function-name :function)
215 (when (eq (info :function :where-from function-name) :assumed)
216 (setf (info :function :where-from function-name) :defined)
217 (when (info :function :assumed-type function-name)
218 (setf (info :function :assumed-type function-name) nil)))
220 ;; Return code constructing a ctor at load time, which, when
221 ;; called, will set its funcallable instance function to an
222 ;; optimized constructor function.
223 `(let ((.x. (load-time-value
224 (ensure-ctor ',function-name ',class-name ',initargs))))
225 (declare (ignore .x.))
226 ;;; ??? check if this is worth it.
228 (ftype (or (function ,(make-list (length value-forms)
231 (function (&rest t) t))
233 (,function-name ,@value-forms)))))))
236 ;;; **************************************************
237 ;;; Load-Time Constructor Function Generation *******
238 ;;; **************************************************
241 ;;; The system-supplied primary INITIALIZE-INSTANCE and
242 ;;; SHARED-INITIALIZE methods. One cannot initialized these variables
243 ;;; to the right values here because said functions don't exist yet
244 ;;; when this file is first loaded.
246 (defvar *the-system-ii-method* nil)
247 (defvar *the-system-si-method* nil)
249 (defun install-optimized-constructor (ctor)
250 (let ((class (find-class (ctor-class-name ctor))))
251 (unless (class-finalized-p class)
252 (finalize-inheritance class))
253 (setf (ctor-class ctor) class)
254 (pushnew ctor (plist-value class 'ctors))
255 (setf (funcallable-instance-fun ctor)
256 ;; KLUDGE: Gerd here has the equivalent of (COMPILE NIL
257 ;; (CONSTRUCTOR-FUNCTION-FORM)), but SBCL's COMPILE doesn't
258 ;; deal with INSTANCE-LAMBDA expressions, only with LAMBDA
259 ;; expressions. The below should be equivalent, since we
260 ;; have a compiler-only implementation.
261 (eval `(function ,(constructor-function-form ctor))))))
263 (defun constructor-function-form (ctor)
264 (let* ((class (ctor-class ctor))
265 (proto (class-prototype class))
266 (make-instance-methods
267 (compute-applicable-methods #'make-instance (list class)))
268 (allocate-instance-methods
269 (compute-applicable-methods #'allocate-instance (list class)))
271 (compute-applicable-methods #'initialize-instance (list proto)))
273 (compute-applicable-methods #'shared-initialize (list proto t))))
274 ;; Cannot initialize these variables earlier because the generic
275 ;; functions don't exist when PCL is built.
276 (when (null *the-system-si-method*)
277 (setq *the-system-si-method*
278 (find-method #'shared-initialize
279 () (list *the-class-slot-object* *the-class-t*)))
280 (setq *the-system-ii-method*
281 (find-method #'initialize-instance
282 () (list *the-class-slot-object*))))
283 ;; Note that when there are user-defined applicable methods on
284 ;; MAKE-INSTANCE and/or ALLOCATE-INSTANCE, these will show up
285 ;; together with the system-defined ones in what
286 ;; COMPUTE-APPLICABLE-METHODS returns.
287 (or (and (not (structure-class-p class))
288 (null (cdr make-instance-methods))
289 (null (cdr allocate-instance-methods))
290 (null (check-initargs-1 class (plist-keys (ctor-initargs ctor))
291 (append ii-methods si-methods) nil nil))
292 (not (around-or-nonstandard-primary-method-p
293 ii-methods *the-system-ii-method*))
294 (not (around-or-nonstandard-primary-method-p
295 si-methods *the-system-si-method*))
296 (optimizing-generator ctor ii-methods si-methods))
297 (fallback-generator ctor ii-methods si-methods))))
299 (defun around-or-nonstandard-primary-method-p
300 (methods &optional standard-method)
301 (loop with primary-checked-p = nil
302 for method in methods
303 as qualifiers = (method-qualifiers method)
304 when (or (eq :around (car qualifiers))
305 (and (null qualifiers)
306 (not primary-checked-p)
307 (not (null standard-method))
308 (not (eq standard-method method))))
310 when (null qualifiers) do
311 (setq primary-checked-p t)))
313 (defun fallback-generator (ctor ii-methods si-methods)
314 (declare (ignore ii-methods si-methods))
315 `(instance-lambda ,(make-ctor-parameter-list ctor)
316 (make-instance ,(ctor-class ctor) ,@(ctor-initargs ctor))))
318 (defun optimizing-generator (ctor ii-methods si-methods)
319 (multiple-value-bind (body before-method-p)
320 (fake-initialization-emf ctor ii-methods si-methods)
321 `(instance-lambda ,(make-ctor-parameter-list ctor)
322 (declare #.*optimize-speed*)
323 ,(wrap-in-allocate-forms ctor body before-method-p))))
326 ;;; Return a form wrapped around BODY that allocates an instance
327 ;;; constructed by CTOR. BEFORE-METHOD-P set means we have to run
328 ;;; before-methods, in which case we initialize instance slots to
329 ;;; +SLOT-UNBOUND+. The resulting form binds the local variables
330 ;;; .INSTANCE. to the instance, and .SLOTS. to the instance's slot
331 ;;; vector around BODY.
333 (defun wrap-in-allocate-forms (ctor body before-method-p)
334 (let* ((class (ctor-class ctor))
335 (wrapper (class-wrapper class))
336 (allocation-function (raw-instance-allocator class))
337 (slots-fetcher (slots-fetcher class)))
338 (if (eq allocation-function 'allocate-standard-instance)
339 `(let ((.instance. (%make-standard-instance nil
340 (get-instance-hash-code)))
342 ,(layout-length wrapper)
343 ,@(when before-method-p
344 '(:initial-element +slot-unbound+)))))
345 (setf (std-instance-wrapper .instance.) ,wrapper)
346 (setf (std-instance-slots .instance.) .slots.)
349 `(let* ((.instance. (,allocation-function ,wrapper))
350 (.slots. (,slots-fetcher .instance.)))
355 ;;; Return a form for invoking METHOD with arguments from ARGS. As
356 ;;; can be seen in METHOD-FUNCTION-FROM-FAST-FUNCTION, method
357 ;;; functions look like (LAMBDA (ARGS NEXT-METHODS) ...). We could
358 ;;; call fast method functions directly here, but benchmarks show that
359 ;;; there's no speed to gain, so lets avoid the hair here.
361 (defmacro invoke-method (method args)
362 `(funcall ,(method-function method) ,args ()))
365 ;;; Return a form that is sort of an effective method comprising all
366 ;;; calls to INITIALIZE-INSTANCE and SHARED-INITIALIZE that would
367 ;;; normally have taken place when calling MAKE-INSTANCE.
369 (defun fake-initialization-emf (ctor ii-methods si-methods)
370 (multiple-value-bind (ii-around ii-before ii-primary ii-after)
371 (standard-sort-methods ii-methods)
372 (declare (ignore ii-primary))
373 (multiple-value-bind (si-around si-before si-primary si-after)
374 (standard-sort-methods si-methods)
375 (declare (ignore si-primary))
376 (aver (and (null ii-around) (null si-around)))
377 (let ((initargs (ctor-initargs ctor))
378 (slot-inits (slot-init-forms ctor (or ii-before si-before))))
380 `(let (,@(when (or ii-before ii-after)
381 `((.ii-args. (list .instance. ,@initargs))))
382 ,@(when (or si-before si-after)
383 `((.si-args. (list .instance. t ,@initargs)))))
384 ,@(loop for method in ii-before
385 collect `(invoke-method ,method .ii-args.))
386 ,@(loop for method in si-before
387 collect `(invoke-method ,method .si-args.))
389 ,@(loop for method in si-after
390 collect `(invoke-method ,method .si-args.))
391 ,@(loop for method in ii-after
392 collect `(invoke-method ,method .ii-args.)))
393 (or ii-before si-before))))))
396 ;;; Return four values from APPLICABLE-METHODS: around methods, before
397 ;;; methods, the applicable primary method, and applicable after
398 ;;; methods. Before and after methods are sorted in the order they
401 (defun standard-sort-methods (applicable-methods)
402 (loop for method in applicable-methods
403 as qualifiers = (method-qualifiers method)
405 collect method into primary
406 else if (eq :around (car qualifiers))
407 collect method into around
408 else if (eq :after (car qualifiers))
409 collect method into after
410 else if (eq :before (car qualifiers))
411 collect method into before
413 (return (values around before (first primary) (reverse after)))))
416 ;;; Return a form initializing instance and class slots of an object
417 ;;; costructed by CTOR. The variable .SLOTS. is assumed to bound to
418 ;;; the instance's slot vector. BEFORE-METHOD-P T means
419 ;;; before-methods will be called, which means that 1) other code will
420 ;;; initialize instance slots to +SLOT-UNBOUND+ before the
421 ;;; before-methods are run, and that we have to check if these
422 ;;; before-methods have set slots.
424 (defun slot-init-forms (ctor before-method-p)
425 (let* ((class (ctor-class ctor))
426 (initargs (ctor-initargs ctor))
427 (initkeys (plist-keys initargs))
429 (make-array (layout-length (class-wrapper class))
430 :initial-element nil))
432 (default-initargs (class-default-initargs class))
434 (compute-initarg-locations
435 class (append initkeys (mapcar #'car default-initargs)))))
436 (labels ((initarg-locations (initarg)
437 (cdr (assoc initarg initarg-locations :test #'eq)))
439 (class-init (location type val)
440 (aver (consp location))
441 (unless (assoc location class-inits :test #'eq)
442 (push (list location type val) class-inits)))
444 (instance-init (location type val)
445 (aver (integerp location))
446 (unless (instance-slot-initialized-p location)
447 (setf (aref slot-vector location) (list type val))))
449 (instance-slot-initialized-p (location)
450 (not (null (aref slot-vector location)))))
452 ;; Loop over supplied initargs and values and record which
453 ;; instance and class slots they initialize.
454 (loop for (key value) on initargs by #'cddr
455 as locations = (initarg-locations key) do
456 (if (constantp value)
457 (dolist (location locations)
459 (class-init location 'constant value)
460 (instance-init location 'constant value)))
461 (dolist (location locations)
463 (class-init location 'param value)
464 (instance-init location 'param value)))))
466 ;; Loop over default initargs of the class, recording
467 ;; initializations of slots that have not been initialized
469 (loop for (key initfn initform) in default-initargs do
470 (unless (member key initkeys :test #'eq)
471 (if (constantp initform)
472 (dolist (location (initarg-locations key))
474 (class-init location 'constant initform)
475 (instance-init location 'constant initform)))
476 (dolist (location (initarg-locations key))
478 (class-init location 'initfn initfn)
479 (instance-init location 'initfn initfn))))))
481 ;; Loop over all slots of the class, filling in the rest from
483 (loop for slotd in (class-slots class)
484 as location = (slot-definition-location slotd)
485 as allocation = (slot-definition-allocation slotd)
486 as initfn = (slot-definition-initfunction slotd)
487 as initform = (slot-definition-initform slotd) do
488 (unless (or (eq allocation :class)
490 (instance-slot-initialized-p location))
491 (if (constantp initform)
492 (instance-init location 'initform initform)
493 (instance-init location 'initform/initfn initfn))))
495 ;; Generate the forms for initializing instance and class slots.
496 (let ((instance-init-forms
497 (loop for slot-entry across slot-vector and i from 0
498 as (type value) = slot-entry collect
501 (unless before-method-p
502 `(setf (clos-slots-ref .slots. ,i) +slot-unbound+)))
504 `(setf (clos-slots-ref .slots. ,i) ,value))
506 `(setf (clos-slots-ref .slots. ,i) (funcall ,value)))
509 `(when (eq (clos-slots-ref .slots. ,i)
511 (setf (clos-slots-ref .slots. ,i)
513 `(setf (clos-slots-ref .slots. ,i)
517 `(when (eq (clos-slots-ref .slots. ,i)
519 (setf (clos-slots-ref .slots. ,i)
521 `(setf (clos-slots-ref .slots. ,i)
524 `(setf (clos-slots-ref .slots. ,i) ',(eval value))))))
526 (loop for (location type value) in class-inits collect
527 `(setf (cdr ',location)
529 (constant `',(eval value))
531 (initfn `(funcall ,value)))))))
533 ,@(delete nil instance-init-forms)
534 ,@class-init-forms)))))
537 ;;; Return an alist of lists (KEY LOCATION ...) telling, for each
538 ;;; key in INITKEYS, which locations the initarg initializes.
539 ;;; CLASS is the class of the instance being initialized.
541 (defun compute-initarg-locations (class initkeys)
542 (loop with slots = (class-slots class)
543 for key in initkeys collect
544 (loop for slot in slots
545 if (memq key (slot-definition-initargs slot))
546 collect (slot-definition-location slot) into locations
548 collect slot into remaining-slots
550 (setq slots remaining-slots)
551 (return (cons key locations)))))
554 ;;; *******************************
555 ;;; External Entry Points ********
556 ;;; *******************************
558 (defun update-ctors (reason &key class name generic-function method)
559 (labels ((reset (class &optional ri-cache-p (ctorsp t))
561 (dolist (ctor (plist-value class 'ctors))
562 (install-initial-constructor ctor)))
564 (setf (plist-value class 'ri-initargs) ()))
565 (dolist (subclass (class-direct-subclasses class))
566 (reset subclass ri-cache-p ctorsp))))
569 ;; CLASS must have been specified.
570 (finalize-inheritance
573 ;; NAME must have been specified.
575 (loop for ctor in *all-ctors*
576 when (eq (ctor-class-name ctor) name) do
577 (when (ctor-class ctor)
578 (reset (ctor-class ctor)))
581 ;; GENERIC-FUNCTION and METHOD must have been specified.
582 ((add-method remove-method)
583 (flet ((class-of-1st-method-param (method)
584 (type-class (first (method-specializers method)))))
585 (case (generic-function-name generic-function)
586 ((make-instance allocate-instance
587 initialize-instance shared-initialize)
588 (reset (class-of-1st-method-param method) t t))
589 ((reinitialize-instance)
590 (reset (class-of-1st-method-param method) t nil))))))))
592 (defun precompile-ctors ()
593 (dolist (ctor *all-ctors*)
594 (when (null (ctor-class ctor))
595 (let ((class (find-class (ctor-class-name ctor) nil)))
596 (when (and class (class-finalized-p class))
597 (install-optimized-constructor ctor))))))
599 (defun check-ri-initargs (instance initargs)
600 (let* ((class (class-of instance))
601 (keys (plist-keys initargs))
602 (cached (assoc keys (plist-value class 'ri-initargs)
608 ;; FIXME: give CHECK-INITARGS-1 and friends a
609 ;; more mnemonic name and (possibly) a nicer,
610 ;; more orthogonal interface.
613 (list (list* 'reinitialize-instance instance initargs)
614 (list* 'shared-initialize instance nil initargs))
616 (setf (plist-value class 'ri-initargs)
617 (acons keys invalid cached))
620 (error 'initarg-error :class class :initargs invalid-keys))))