1 ;;;; permutation vectors
3 ;;;; This software is part of the SBCL system. See the README file for
6 ;;;; This software is derived from software originally released by Xerox
7 ;;;; Corporation. Copyright and release statements follow. Later modifications
8 ;;;; to the software are in the public domain and are provided with
9 ;;;; absolutely no warranty. See the COPYING and CREDITS files for more
12 ;;;; copyright information from original PCL sources:
14 ;;;; Copyright (c) 1985, 1986, 1987, 1988, 1989, 1990 Xerox Corporation.
15 ;;;; All rights reserved.
17 ;;;; Use and copying of this software and preparation of derivative works based
18 ;;;; upon this software are permitted. Any distribution of this software or
19 ;;;; derivative works must comply with all applicable United States export
22 ;;;; This software is made available AS IS, and Xerox Corporation makes no
23 ;;;; warranty about the software, its performance or its conformity to any
28 (defmacro instance-slot-index (wrapper slot-name)
30 (declare (fixnum pos))
32 (dolist (sn (wrapper-instance-slots-layout ,wrapper))
33 (when (eq ,slot-name sn) (return-from loop pos))
36 (defun pv-cache-limit-fn (nlines)
37 (default-limit-fn nlines))
39 (defstruct (pv-table (:predicate pv-tablep)
40 (:constructor make-pv-table-internal
41 (slot-name-lists call-list))
43 (cache nil :type (or cache null))
44 (pv-size 0 :type fixnum)
45 (slot-name-lists nil :type list)
46 (call-list nil :type list))
48 #-sb-fluid (declaim (sb-ext:freeze-type pv-table))
50 (defvar *initial-pv-table* (make-pv-table-internal nil nil))
52 ; help new slot-value-using-class methods affect fast iv access
53 (defvar *all-pv-table-list* nil)
55 (defun make-pv-table (&key slot-name-lists call-list)
56 (let ((pv-table (make-pv-table-internal slot-name-lists call-list)))
57 (push pv-table *all-pv-table-list*)
60 (defun make-pv-table-type-declaration (var)
61 `(type pv-table ,var))
63 (defvar *slot-name-lists-inner* (make-hash-table :test 'equal))
64 (defvar *slot-name-lists-outer* (make-hash-table :test 'equal))
66 ;;; Entries in this are lists of (table . pv-offset-list).
67 (defvar *pv-key-to-pv-table-table* (make-hash-table :test 'equal))
69 (defun intern-pv-table (&key slot-name-lists call-list)
72 (or (gethash x *slot-name-lists-inner*)
73 (setf (gethash x *slot-name-lists-inner*) (copy-list x))))
75 (or (gethash x *slot-name-lists-outer*)
76 (setf (gethash x *slot-name-lists-outer*)
77 (let ((snl (copy-list (cdr x)))
80 (make-pv-table :slot-name-lists snl
82 (let ((pv-table (outer (mapcar #'inner (cons call-list slot-name-lists)))))
85 (dolist (slot-name-list slot-name-lists)
86 (dolist (slot-name (cdr slot-name-list))
87 (note-pv-table-reference slot-name pv-index pv-table)
89 (dolist (gf-call call-list)
90 (note-pv-table-reference gf-call pv-index pv-table)
92 (setf (pv-table-pv-size pv-table) pv-index)))
95 (defun note-pv-table-reference (ref pv-offset pv-table)
96 (let ((entry (gethash ref *pv-key-to-pv-table-table*)))
98 (let ((table-entry (assq pv-table entry)))
99 (when (and (null table-entry)
100 (> (length entry) 8))
101 (let ((new-table-table (make-hash-table :size 16 :test 'eq)))
102 (dolist (table-entry entry)
103 (setf (gethash (car table-entry) new-table-table)
105 (setf (gethash ref *pv-key-to-pv-table-table*) new-table-table)))
107 (if (null table-entry)
108 (let ((new (cons pv-table pv-offset)))
110 (push new (cdr entry))
111 (setf (gethash ref *pv-key-to-pv-table-table*)
113 (push pv-offset (cdr table-entry)))
114 (return-from note-pv-table-reference nil))))
115 (let ((list (gethash pv-table entry)))
117 (push pv-offset (cdr list))
118 (setf (gethash pv-table entry) (list pv-offset)))))
121 (defun map-pv-table-references-of (ref function)
122 (let ((entry (gethash ref *pv-key-to-pv-table-table*)))
124 (dolist (table+pv-offset-list entry)
126 (car table+pv-offset-list)
127 (cdr table+pv-offset-list)))
128 (maphash function entry)))
131 (defvar *pvs* (make-hash-table :test 'equal))
133 (defun optimize-slot-value-by-class-p (class slot-name type)
134 (or (not (eq *boot-state* 'complete))
135 (let ((slotd (find-slot-definition class slot-name)))
137 (slot-accessor-std-p slotd type)))))
139 (defun compute-pv-slot (slot-name wrapper class class-slots class-slot-p-cell)
140 (if (symbolp slot-name)
141 (when (optimize-slot-value-by-class-p class slot-name 'all)
142 (or (instance-slot-index wrapper slot-name)
143 (let ((cell (assq slot-name class-slots)))
145 (setf (car class-slot-p-cell) t)
147 (when (consp slot-name)
148 (dolist (type '(reader writer) nil)
149 (when (eq (car slot-name) type)
151 (let* ((gf-name (cadr slot-name))
152 (gf (gdefinition gf-name))
153 (location (when (eq *boot-state* 'complete)
154 (accessor-values1 gf type class))))
155 (when (consp location)
156 (setf (car class-slot-p-cell) t))
159 (defun compute-pv (slot-name-lists wrappers)
160 (unless (listp wrappers) (setq wrappers (list wrappers)))
161 (let* ((not-simple-p-cell (list nil))
163 (let ((elements nil))
164 (dolist (slot-names slot-name-lists)
166 (let* ((wrapper (pop wrappers))
167 (std-p (typep wrapper 'wrapper))
168 (class (wrapper-class* wrapper))
169 (class-slots (and std-p (wrapper-class-slots wrapper))))
170 (dolist (slot-name (cdr slot-names))
171 ;; Original PCL code had this idiom. why not:
176 (compute-pv-slot slot-name wrapper class
177 class-slots not-simple-p-cell))
179 (nreverse elements))))
180 (if (car not-simple-p-cell)
181 (make-permutation-vector (cons t elements))
182 (or (gethash elements *pvs*)
183 (setf (gethash elements *pvs*)
184 (make-permutation-vector (cons nil elements)))))))
186 (defun compute-calls (call-list wrappers)
187 (declare (ignore call-list wrappers))
191 (compute-emf-from-wrappers call wrappers))
196 #|| ; Need to finish this, then write the maintenance functions.
197 (defun compute-emf-from-wrappers (call wrappers)
199 (destructuring-bind (gf-name nreq restp arg-info) call
200 (if (eq gf-name 'make-instance)
201 (error "should not get here") ; there is another mechanism for this.
203 (if (not (eq *boot-state* 'complete))
204 (apply (gdefinition gf-name) args)
205 (let* ((gf (gdefinition gf-name))
206 (arg-info (arg-info-reader gf))
209 (emf (cache-miss-values-internal gf arg-info
210 wrappers classes types
212 (update-all-pv-tables call wrappers emf)
213 (invoke-emf emf args))))))))
216 (defun make-permutation-vector (indexes)
217 (make-array (length indexes) :initial-contents indexes))
219 (defun pv-table-lookup (pv-table pv-wrappers)
220 (let* ((slot-name-lists (pv-table-slot-name-lists pv-table))
221 (call-list (pv-table-call-list pv-table))
222 (cache (or (pv-table-cache pv-table)
223 (setf (pv-table-cache pv-table)
224 (get-cache (- (length slot-name-lists)
225 (count nil slot-name-lists))
229 (or (probe-cache cache pv-wrappers)
230 (let* ((pv (compute-pv slot-name-lists pv-wrappers))
231 (calls (compute-calls call-list pv-wrappers))
232 (pv-cell (cons pv calls))
233 (new-cache (fill-cache cache pv-wrappers pv-cell)))
234 (unless (eq new-cache cache)
235 (setf (pv-table-cache pv-table) new-cache))
238 (defun make-pv-type-declaration (var)
239 `(type simple-vector ,var))
241 (defvar *empty-pv* #())
243 (defmacro pvref (pv index)
246 (defmacro copy-pv (pv)
249 (defun make-calls-type-declaration (var)
250 `(type simple-vector ,var))
252 (defmacro callsref (calls index)
253 `(svref ,calls ,index))
255 (defvar *pv-table-cache-update-info* nil)
257 (defun update-pv-table-cache-info (class)
258 (let ((slot-names-for-pv-table-update nil)
260 (dolist (icu *pv-table-cache-update-info*)
261 (if (eq (car icu) class)
262 (pushnew (cdr icu) slot-names-for-pv-table-update)
263 (push icu new-icui)))
264 (setq *pv-table-cache-update-info* new-icui)
265 (when slot-names-for-pv-table-update
266 (update-all-pv-table-caches class slot-names-for-pv-table-update))))
268 (defun update-all-pv-table-caches (class slot-names)
269 (let* ((cwrapper (class-wrapper class))
270 (std-p (typep cwrapper 'wrapper))
271 (class-slots (and std-p (wrapper-class-slots cwrapper)))
272 (class-slot-p-cell (list nil))
273 (new-values (mapcar (lambda (slot-name)
277 slot-name cwrapper class
278 class-slots class-slot-p-cell))))
281 (dolist (slot-name slot-names)
282 (map-pv-table-references-of
284 (lambda (pv-table pv-offset-list)
285 (declare (ignore pv-offset-list))
286 (pushnew pv-table pv-tables))))
287 (dolist (pv-table pv-tables)
288 (let* ((cache (pv-table-cache pv-table))
289 (slot-name-lists (pv-table-slot-name-lists pv-table))
290 (pv-size (pv-table-pv-size pv-table))
291 (pv-map (make-array pv-size :initial-element nil)))
292 (let ((map-index 1) (param-index 0))
293 (dolist (slot-name-list slot-name-lists)
294 (dolist (slot-name (cdr slot-name-list))
295 (let ((a (assoc slot-name new-values)))
296 (setf (svref pv-map map-index)
297 (and a (cons param-index (cdr a)))))
301 (map-cache (lambda (wrappers pv-cell)
303 (update-slots-in-pv wrappers (car pv-cell)
304 cwrapper pv-size pv-map)))
307 (defun update-slots-in-pv (wrappers pv cwrapper pv-size pv-map)
308 (if (not (if (atom wrappers)
309 (eq cwrapper wrappers)
310 (dolist (wrapper wrappers nil)
311 (when (eq wrapper cwrapper)
314 (let* ((old-intern-p (listp (pvref pv 0)))
315 (new-pv (if old-intern-p
320 (dotimes-fixnum (i pv-size)
321 (when (consp (let ((map (svref pv-map i)))
323 (setf (pvref new-pv i) (cdr map))
325 (setq new-intern-p nil)))
327 (dolist (wrapper wrappers)
328 (when (eq wrapper cwrapper)
329 (dotimes-fixnum (i pv-size)
330 (when (consp (let ((map (svref pv-map i)))
331 (if (and map (= (car map) param))
332 (setf (pvref new-pv i) (cdr map))
334 (setq new-intern-p nil))))
337 (setq new-pv (let ((list-pv (coerce pv 'list)))
338 (or (gethash (cdr list-pv) *pvs*)
339 (setf (gethash (cdr list-pv) *pvs*)
342 (make-permutation-vector list-pv)))))))
345 (defun maybe-expand-accessor-form (form required-parameters slots env)
346 (let* ((fname (car form))
347 #||(len (length form))||#
348 (gf (if (symbolp fname)
349 (unencapsulated-fdefinition fname)
350 (gdefinition fname))))
351 (macrolet ((maybe-optimize-reader ()
353 (can-optimize-access1 (cadr form)
354 required-parameters env)))
356 (optimize-reader slots parameter gf-name form))))
357 (maybe-optimize-writer ()
359 (can-optimize-access1 (caddr form)
360 required-parameters env)))
362 (optimize-writer slots parameter gf-name form)))))
363 (unless (and (consp (cadr form))
364 (eq 'instance-accessor-parameter (caadr form)))
365 (when (and (eq *boot-state* 'complete)
366 (generic-function-p gf))
367 (let ((methods (generic-function-methods gf)))
369 (let* ((gf-name (generic-function-name gf))
370 (arg-info (gf-arg-info gf))
371 (metatypes (arg-info-metatypes arg-info))
372 (nreq (length metatypes))
373 (applyp (arg-info-applyp arg-info)))
376 (when (some #'standard-reader-method-p methods)
377 (maybe-optimize-reader)))
380 (eq (car gf-name) 'setf))
381 (when (some #'standard-writer-method-p methods)
382 (maybe-optimize-writer)))))))))))))
384 (defun optimize-generic-function-call (form
389 (declare (ignore required-parameters env slots calls))
390 (or ; (optimize-reader ...)?
393 (defun can-optimize-access (form required-parameters env)
394 (let ((type (ecase (car form)
396 (set-slot-value 'writer)
397 (slot-boundp 'boundp)))
399 (slot-name (eval (caddr form)))) ; known to be constant
400 (can-optimize-access1 var required-parameters env type slot-name)))
402 ;;; FIXME: This looks like an internal helper function for
403 ;;; CAN-OPTIMIZE-ACCESS, and it is used that way, but it's also called
404 ;;; bare from several places in the code. Perhaps the two functions
405 ;;; should be renamed CAN-OPTIMIZE-ACCESS-FOR-FORM and
406 ;;; CAN-OPTIMIZE-ACCESS-FOR-VAR. If so, I'd just as soon use keyword
407 ;;; args instead of optional ones, too.
408 (defun can-optimize-access1 (var required-parameters env
409 &optional type slot-name)
410 (when (and (consp var) (eq 'the (car var)))
411 ;; FIXME: We should assert list of length 3 here. Or maybe we
412 ;; should just define EXTRACT-THE, replace the whole
415 ;; (AWHEN (EXTRACT-THE VAR)
417 ;; and then use EXTRACT-THE similarly to clean up the other tests
418 ;; against 'THE scattered through the PCL code.
419 (setq var (caddr var)))
421 (let* ((rebound? (caddr (var-declaration '%variable-rebinding var env)))
422 (parameter-or-nil (car (memq (or rebound? var)
423 required-parameters))))
424 (when parameter-or-nil
425 (let* ((class-name (caddr (var-declaration '%class
428 (class (find-class class-name nil)))
429 (when (or (not (eq *boot-state* 'complete))
430 (and class (not (class-finalized-p class))))
432 (when (and class-name (not (eq class-name t)))
433 (when (or (null type)
435 (memq *the-class-structure-object*
436 (class-precedence-list class))))
437 (optimize-slot-value-by-class-p class slot-name type))
438 (cons parameter-or-nil (or class class-name)))))))))
440 (defun optimize-slot-value (slots sparameter form)
442 (destructuring-bind (ignore1 ignore2 slot-name-form) form
443 (declare (ignore ignore1 ignore2))
444 (let ((slot-name (eval slot-name-form)))
445 (optimize-instance-access slots :read sparameter slot-name nil)))
446 `(accessor-slot-value ,@(cdr form))))
448 (defun optimize-set-slot-value (slots sparameter form)
450 (destructuring-bind (ignore1 ignore2 slot-name-form new-value) form
451 (declare (ignore ignore1 ignore2))
452 (let ((slot-name (eval slot-name-form)))
453 (optimize-instance-access slots
458 `(accessor-set-slot-value ,@(cdr form))))
460 (defun optimize-slot-boundp (slots sparameter form)
463 ;; FIXME: In CMU CL ca. 19991205, this binding list had a
464 ;; fourth element in it, NEW-VALUE. It's hard to see how
465 ;; that could possibly be right, since SLOT-BOUNDP has no
466 ;; NEW-VALUE. Since it was causing a failure in building PCL
467 ;; for SBCL, so I changed it to match the definition of
468 ;; SLOT-BOUNDP (and also to match the list used in the
469 ;; similar OPTIMIZE-SLOT-VALUE, above). However, I'm weirded
470 ;; out by this, since this is old code which has worked for
471 ;; ages to build PCL for CMU CL, so it's hard to see why it
472 ;; should need a patch like this in order to build PCL for
473 ;; SBCL. I'd like to return to this and find a test case
474 ;; which exercises this function both in CMU CL, to see
475 ;; whether it's really a previously-unexercised bug or
476 ;; whether I've misunderstood something (and, presumably,
477 ;; patched it wrong).
478 (slot-boundp-symbol instance slot-name-form)
480 (declare (ignore slot-boundp-symbol instance))
481 (let ((slot-name (eval slot-name-form)))
482 (optimize-instance-access slots
487 `(accessor-slot-boundp ,@(cdr form))))
489 (defun optimize-reader (slots sparameter gf-name form)
491 (optimize-accessor-call slots :read sparameter gf-name nil)
494 (defun optimize-writer (slots sparameter gf-name form)
496 (destructuring-bind (ignore1 ignore2 new-value) form
497 (declare (ignore ignore1 ignore2))
498 (optimize-accessor-call slots :write sparameter gf-name new-value))
501 ;;; The SLOTS argument is an alist, the CAR of each entry is the name
502 ;;; of a required parameter to the function. The alist is in order, so
503 ;;; the position of an entry in the alist corresponds to the
504 ;;; argument's position in the lambda list.
505 (defun optimize-instance-access (slots
510 (let ((class (if (consp sparameter) (cdr sparameter) *the-class-t*))
511 (parameter (if (consp sparameter) (car sparameter) sparameter)))
512 (if (and (eq *boot-state* 'complete)
514 (memq *the-class-structure-object* (class-precedence-list class)))
515 (let ((slotd (find-slot-definition class slot-name)))
518 `(,(slot-definition-defstruct-accessor-symbol slotd) ,parameter))
520 `(setf (,(slot-definition-defstruct-accessor-symbol slotd)
525 (let* ((parameter-entry (assq parameter slots))
526 (slot-entry (assq slot-name (cdr parameter-entry)))
527 (position (posq parameter-entry slots))
528 (pv-offset-form (list 'pv-offset ''.PV-OFFSET.)))
529 (unless parameter-entry
530 (bug "slot optimization bewilderment: O-I-A"))
532 (setq slot-entry (list slot-name))
533 (push slot-entry (cdr parameter-entry)))
534 (push pv-offset-form (cdr slot-entry))
537 `(instance-read ,pv-offset-form ,parameter ,position
538 ',slot-name ',class))
540 `(let ((.new-value. ,new-value))
541 (instance-write ,pv-offset-form ,parameter ,position
542 ',slot-name ',class .new-value.)))
544 `(instance-boundp ,pv-offset-form ,parameter ,position
545 ',slot-name ',class)))))))
547 (defun optimize-accessor-call (slots read/write sparameter gf-name new-value)
548 (let* ((class (if (consp sparameter) (cdr sparameter) *the-class-t*))
549 (parameter (if (consp sparameter) (car sparameter) sparameter))
550 (parameter-entry (assq parameter slots))
551 (name (case read/write
552 (:read `(reader ,gf-name))
553 (:write `(writer ,gf-name))))
554 (slot-entry (assoc name (cdr parameter-entry) :test #'equal))
555 (position (posq parameter-entry slots))
556 (pv-offset-form (list 'pv-offset ''.PV-OFFSET.)))
557 (unless parameter-entry
558 (error "slot optimization bewilderment: O-A-C"))
560 (setq slot-entry (list name))
561 (push slot-entry (cdr parameter-entry)))
562 (push pv-offset-form (cdr slot-entry))
565 `(instance-reader ,pv-offset-form ,parameter ,position ,gf-name ',class))
567 `(let ((.new-value. ,new-value))
568 (instance-writer ,pv-offset-form ,parameter ,position ,gf-name ',class
571 (defvar *unspecific-arg* '..unspecific-arg..)
573 (defun optimize-gf-call-internal (form slots env)
574 (when (and (consp form)
575 (eq (car form) 'the))
576 (setq form (caddr form)))
577 (or (and (symbolp form)
578 (let* ((rebound? (caddr (var-declaration '%variable-rebinding
581 (parameter-or-nil (car (assq (or rebound? form) slots))))
582 (when parameter-or-nil
583 (let* ((class-name (caddr (var-declaration 'class
586 (when (and class-name (not (eq class-name t)))
587 (position parameter-or-nil slots :key #'car))))))
589 (let ((form (eval form)))
595 (defun optimize-gf-call (slots calls gf-call-form nreq restp env)
596 (unless (eq (car gf-call-form) 'make-instance) ; XXX needs more work
597 (let* ((args (cdr gf-call-form))
598 (all-args-p (eq (car gf-call-form) 'make-instance))
599 (non-required-args (nthcdr nreq args))
600 (required-args (ldiff args non-required-args))
601 (call-spec (list (car gf-call-form) nreq restp
602 (mapcar (lambda (form)
603 (optimize-gf-call-internal form slots env))
607 (call-entry (assoc call-spec calls :test #'equal))
608 (pv-offset-form (list 'pv-offset ''.PV-OFFSET.)))
609 (unless (some #'integerp
610 (let ((spec-args (cdr call-spec)))
612 (ldiff spec-args (nthcdr nreq spec-args))
614 (return-from optimize-gf-call nil))
616 (setq call-entry (list call-spec))
617 (push call-entry (cdr calls)))
618 (push pv-offset-form (cdr call-entry))
619 (if (eq (car call-spec) 'make-instance)
620 `(funcall (pv-ref .pv. ,pv-offset-form) ,@(cdr gf-call-form))
621 `(let ((.emf. (pv-ref .pv. ,pv-offset-form)))
622 (invoke-effective-method-function .emf. ,restp
623 ,@required-args ,@(when restp `((list ,@non-required-args)))))))))
625 (define-walker-template pv-offset) ; These forms get munged by mutate slots.
626 (defmacro pv-offset (arg) arg)
627 (define-walker-template instance-accessor-parameter)
628 (defmacro instance-accessor-parameter (x) x)
630 ;;; It is safe for these two functions to be wrong. They just try to
631 ;;; guess what the most likely case will be.
632 (defun generate-fast-class-slot-access-p (class-form slot-name-form)
633 (let ((class (and (constantp class-form) (eval class-form)))
634 (slot-name (and (constantp slot-name-form) (eval slot-name-form))))
635 (and (eq *boot-state* 'complete)
636 (standard-class-p class)
637 (not (eq class *the-class-t*)) ; shouldn't happen, though.
638 (let ((slotd (find-slot-definition class slot-name)))
639 (and slotd (eq :class (slot-definition-allocation slotd)))))))
641 (defun skip-fast-slot-access-p (class-form slot-name-form type)
642 (let ((class (and (constantp class-form) (eval class-form)))
643 (slot-name (and (constantp slot-name-form) (eval slot-name-form))))
644 (and (eq *boot-state* 'complete)
645 (standard-class-p class)
646 (not (eq class *the-class-t*)) ; shouldn't happen, though.
647 (let ((slotd (find-slot-definition class slot-name)))
648 (and slotd (skip-optimize-slot-value-by-class-p class
652 (defun skip-optimize-slot-value-by-class-p (class slot-name type)
653 (let ((slotd (find-slot-definition class slot-name)))
655 (eq *boot-state* 'complete)
656 (not (slot-accessor-std-p slotd type)))))
658 (defmacro instance-read-internal (pv slots pv-offset default &optional type)
659 (unless (member type '(nil :instance :class :default))
660 (error "illegal type argument to ~S: ~S" 'instance-read-internal type))
661 (if (eq type :default)
663 (let* ((index (gensym))
665 `(locally (declare #.*optimize-speed*)
666 (let ((,index (pvref ,pv ,pv-offset)))
667 (setq ,value (typecase ,index
668 ;; FIXME: the line marked by KLUDGE below
669 ;; (and the analogous spot in
670 ;; INSTANCE-WRITE-INTERNAL) is there purely
671 ;; to suppress a type mismatch warning that
672 ;; propagates through to user code.
673 ;; Presumably SLOTS at this point can never
674 ;; actually be NIL, but the compiler seems
675 ;; to think it could, so we put this here
676 ;; to shut it up. (see also mail Rudi
677 ;; Schlatte sbcl-devel 2003-09-21) -- CSR,
679 ,@(when (or (null type) (eq type :instance))
682 (clos-slots-ref ,slots ,index)))))
683 ,@(when (or (null type) (eq type :class))
684 `((cons (cdr ,index))))
686 (if (eq ,value +slot-unbound+)
690 (defmacro instance-read (pv-offset parameter position slot-name class)
691 (if (skip-fast-slot-access-p class slot-name 'reader)
692 `(accessor-slot-value ,parameter ,slot-name)
693 `(instance-read-internal .pv. ,(slot-vector-symbol position)
694 ,pv-offset (accessor-slot-value ,parameter ,slot-name)
695 ,(if (generate-fast-class-slot-access-p class slot-name)
698 (defmacro instance-reader (pv-offset parameter position gf-name class)
699 (declare (ignore class))
700 `(instance-read-internal .pv. ,(slot-vector-symbol position)
702 (,gf-name (instance-accessor-parameter ,parameter))
705 (defmacro instance-write-internal (pv slots pv-offset new-value default
707 (unless (member type '(nil :instance :class :default))
708 (error "illegal type argument to ~S: ~S" 'instance-write-internal type))
709 (if (eq type :default)
711 (let* ((index (gensym)))
712 `(locally (declare #.*optimize-speed*)
713 (let ((,index (pvref ,pv ,pv-offset)))
715 ,@(when (or (null type) (eq type :instance))
716 `((fixnum (and ,slots
717 (setf (clos-slots-ref ,slots ,index)
719 ,@(when (or (null type) (eq type :class))
720 `((cons (setf (cdr ,index) ,new-value))))
723 (defmacro instance-write (pv-offset
729 (if (skip-fast-slot-access-p class slot-name 'writer)
730 `(accessor-set-slot-value ,parameter ,slot-name ,new-value)
731 `(instance-write-internal .pv. ,(slot-vector-symbol position)
732 ,pv-offset ,new-value
733 (accessor-set-slot-value ,parameter ,slot-name ,new-value)
734 ,(if (generate-fast-class-slot-access-p class slot-name)
737 (defmacro instance-writer (pv-offset
743 (declare (ignore class))
744 `(instance-write-internal .pv. ,(slot-vector-symbol position)
745 ,pv-offset ,new-value
746 (,(if (consp gf-name)
747 (get-setf-fun-name gf-name)
749 (instance-accessor-parameter ,parameter)
753 (defmacro instance-boundp-internal (pv slots pv-offset default
755 (unless (member type '(nil :instance :class :default))
756 (error "illegal type argument to ~S: ~S" 'instance-boundp-internal type))
757 (if (eq type :default)
759 (let* ((index (gensym)))
760 `(locally (declare #.*optimize-speed*)
761 (let ((,index (pvref ,pv ,pv-offset)))
763 ,@(when (or (null type) (eq type :instance))
764 `((fixnum (not (and ,slots
765 (eq (clos-slots-ref ,slots ,index)
767 ,@(when (or (null type) (eq type :class))
768 `((cons (not (eq (cdr ,index) +slot-unbound+)))))
771 (defmacro instance-boundp (pv-offset parameter position slot-name class)
772 (if (skip-fast-slot-access-p class slot-name 'boundp)
773 `(accessor-slot-boundp ,parameter ,slot-name)
774 `(instance-boundp-internal .pv. ,(slot-vector-symbol position)
775 ,pv-offset (accessor-slot-boundp ,parameter ,slot-name)
776 ,(if (generate-fast-class-slot-access-p class slot-name)
779 ;;; This magic function has quite a job to do indeed.
781 ;;; The careful reader will recall that <slots> contains all of the
782 ;;; optimized slot access forms produced by OPTIMIZE-INSTANCE-ACCESS.
783 ;;; Each of these is a call to either INSTANCE-READ or INSTANCE-WRITE.
785 ;;; At the time these calls were produced, the first argument was
786 ;;; specified as the symbol .PV-OFFSET.; what we have to do now is
787 ;;; convert those pv-offset arguments into the actual number that is
788 ;;; the correct offset into the pv.
790 ;;; But first, oh but first, we sort <slots> a bit so that for each
791 ;;; argument we have the slots in alphabetical order. This
792 ;;; canonicalizes the PV-TABLE's a bit and will hopefully lead to
793 ;;; having fewer PV's floating around. Even if the gain is only
794 ;;; modest, it costs nothing.
795 (defun slot-name-lists-from-slots (slots calls)
796 (multiple-value-bind (slots calls) (mutate-slots-and-calls slots calls)
797 (let* ((slot-name-lists
798 (mapcar (lambda (parameter-entry)
799 (cons nil (mapcar #'car (cdr parameter-entry))))
802 (mapcar #'car calls)))
803 (dolist (call call-list)
804 (dolist (arg (cdr call))
806 (setf (car (nth arg slot-name-lists)) t))))
807 (setq slot-name-lists (mapcar (lambda (r+snl)
808 (when (or (car r+snl) (cdr r+snl))
811 (let ((cvt (apply #'vector
813 (mapcar (lambda (r+snl)
814 (when r+snl (incf i)))
816 (setq call-list (mapcar (lambda (call)
818 (mapcar (lambda (arg)
824 (values slot-name-lists call-list))))
826 (defun mutate-slots-and-calls (slots calls)
827 (let ((sorted-slots (sort-slots slots))
828 (sorted-calls (sort-calls (cdr calls)))
829 (pv-offset 0)) ; index 0 is for info
830 (dolist (parameter-entry sorted-slots)
831 (dolist (slot-entry (cdr parameter-entry))
833 (dolist (form (cdr slot-entry))
834 (setf (cadr form) pv-offset))))
835 (dolist (call-entry sorted-calls)
837 (dolist (form (cdr call-entry))
838 (setf (cadr form) pv-offset)))
839 (values sorted-slots sorted-calls)))
841 (defun symbol-pkg-name (sym)
842 (let ((pkg (symbol-package sym)))
843 (if pkg (package-name pkg) "")))
845 ;;; FIXME: Because of the existence of UNINTERN and RENAME-PACKAGE,
846 ;;; the part of this ordering which is based on SYMBOL-PKG-NAME is not
847 ;;; stable. This ordering is only used in to
848 ;;; SLOT-NAME-LISTS-FROM-SLOTS, where it serves to "canonicalize the
849 ;;; PV-TABLE's a bit and will hopefully lead to having fewer PV's
850 ;;; floating around", so it sounds as though the instability won't
851 ;;; actually lead to bugs, just small inefficiency. But still, it
852 ;;; would be better to reimplement this function as a comparison based
854 ;;; * stable comparison
855 ;;; * smaller code (here, and in being able to discard SYMBOL-PKG-NAME)
857 (defun symbol-lessp (a b)
858 (if (eq (symbol-package a)
860 (string-lessp (symbol-name a)
862 (string-lessp (symbol-pkg-name a)
863 (symbol-pkg-name b))))
865 (defun symbol-or-cons-lessp (a b)
868 (symbol (symbol-lessp a b))
872 (cons (if (eq (car a) (car b))
873 (symbol-or-cons-lessp (cdr a) (cdr b))
874 (symbol-or-cons-lessp (car a) (car b))))))))
876 (defun sort-slots (slots)
877 (mapcar (lambda (parameter-entry)
878 (cons (car parameter-entry)
879 (sort (cdr parameter-entry) ;slot entries
880 #'symbol-or-cons-lessp
884 (defun sort-calls (calls)
885 (sort calls #'symbol-or-cons-lessp :key #'car))
887 ;;;; This needs to work in terms of metatypes and also needs to work
888 ;;;; for automatically generated reader and writer functions.
889 ;;;; Automatically generated reader and writer functions use this
892 (defmacro pv-binding ((required-parameters slot-name-lists pv-table-symbol)
894 (let (slot-vars pv-parameters)
895 (loop for slots in slot-name-lists
896 for required-parameter in required-parameters
899 (push required-parameter pv-parameters)
900 (push (slot-vector-symbol i) slot-vars)))
901 `(pv-binding1 (.pv. .calls. ,pv-table-symbol
902 ,(nreverse pv-parameters) ,(nreverse slot-vars))
905 (defmacro pv-binding1 ((pv calls pv-table-symbol pv-parameters slot-vars)
907 `(pv-env (,pv ,calls ,pv-table-symbol ,pv-parameters)
908 (let (,@(mapcar (lambda (slot-var p) `(,slot-var (get-slots-or-nil ,p)))
909 slot-vars pv-parameters))
910 (declare (ignorable ,@(mapcar #'identity slot-vars)))
913 ;;; This gets used only when the default MAKE-METHOD-LAMBDA is
915 (defmacro pv-env ((pv calls pv-table-symbol pv-parameters)
917 `(let* ((.pv-table. ,pv-table-symbol)
918 (.pv-cell. (pv-table-lookup-pv-args .pv-table. ,@pv-parameters))
919 (,pv (car .pv-cell.))
920 (,calls (cdr .pv-cell.)))
921 (declare ,(make-pv-type-declaration pv))
922 (declare ,(make-calls-type-declaration calls))
923 ,@(when (symbolp pv-table-symbol)
924 `((declare (special ,pv-table-symbol))))
928 (defvar *non-var-declarations*
929 ;; FIXME: VALUES was in this list, conditionalized with #+CMU, but I
930 ;; don't *think* CMU CL had, or SBCL has, VALUES declarations. If
931 ;; SBCL doesn't have 'em, VALUES should probably be removed from
941 (defvar *var-declarations-with-arg*
945 (defvar *var-declarations-without-arg*
947 ignorable special dynamic-extent
948 ;; FIXME: Possibly this entire list and variable could go away.
949 ;; If not, certainly we should remove all these built-in typenames
950 ;; from the list, and replace them with a test for "is it a type
951 ;; name?" (CLTL1 allowed only built-in type names as declarations,
952 ;; but ANSI CL allows any type name as a declaration.)
953 array atom base-char bignum bit bit-vector character compiled-function
954 complex cons double-float extended-char
955 fixnum float function hash-table integer
956 keyword list long-float nil null number package pathname random-state ratio
957 rational readtable sequence short-float signed-byte simple-array
958 simple-bit-vector simple-string simple-vector single-float standard-char
959 stream string symbol t unsigned-byte vector))
961 (defun split-declarations (body args maybe-reads-params-p)
962 (let ((inner-decls nil)
965 (loop (when (null body) (return nil))
966 (setq decl (car body))
967 (unless (and (consp decl)
968 (eq (car decl) 'declare))
970 (dolist (form (cdr decl))
972 (let ((declaration-name (car form)))
973 (if (member declaration-name *non-var-declarations*)
974 (push `(declare ,form) outer-decls)
976 (member declaration-name
977 *var-declarations-with-arg*))
979 (member declaration-name
980 *var-declarations-without-arg*))
981 (dname (list (pop form)))
982 (inners nil) (outers nil))
983 (unless (or arg-p non-arg-p)
984 ;; FIXME: This warning, and perhaps the
985 ;; various *VAR-DECLARATIONS-FOO* and/or
986 ;; *NON-VAR-DECLARATIONS* variables,
987 ;; could probably go away now that we're not
988 ;; trying to be portable between different
989 ;; CLTL1 hosts the way PCL was. (Note that to
990 ;; do this right, we need to be able to handle
991 ;; user-defined (DECLAIM (DECLARATION FOO))
993 (warn "The declaration ~S is not understood by ~S.~@
994 Please put ~S on one of the lists ~S,~%~S, or~%~S.~@
995 (Assuming it is a variable declaration without argument)."
996 declaration-name 'split-declarations
998 '*non-var-declarations*
999 '*var-declarations-with-arg*
1000 '*var-declarations-without-arg*)
1001 (push declaration-name *var-declarations-without-arg*))
1003 (setq dname (append dname (list (pop form)))))
1005 (%class (push `(declare (,@dname ,@form)) inner-decls))
1008 (if (member var args)
1009 ;; Quietly remove IGNORE declarations
1010 ;; on args when a next-method is
1011 ;; involved, to prevent compiler
1012 ;; warnings about ignored args being
1014 (unless (and maybe-reads-params-p
1015 (eq (car dname) 'ignore))
1019 (push `(declare (,@dname ,@outers)) outer-decls))
1022 `(declare (,@dname ,@inners))
1023 inner-decls)))))))))
1024 (setq body (cdr body)))
1025 (values outer-decls inner-decls body)))
1027 ;;; Pull a name out of the %METHOD-NAME declaration in the function
1028 ;;; body given, or return NIL if no %METHOD-NAME declaration is found.
1029 (defun body-method-name (body)
1030 (multiple-value-bind (real-body declarations documentation)
1032 (declare (ignore real-body documentation))
1033 (let ((name-decl (get-declaration '%method-name declarations)))
1035 (destructuring-bind (name) name-decl
1038 ;;; Convert a lambda expression containing a SB-PCL::%METHOD-NAME
1039 ;;; declaration (which is a naming style internal to PCL) into an
1040 ;;; SB-INT:NAMED-LAMBDA expression (which is a naming style used
1041 ;;; throughout SBCL, understood by the main compiler); or if there's
1042 ;;; no SB-PCL::%METHOD-NAME declaration, then just return the original
1043 ;;; lambda expression.
1044 (defun name-method-lambda (method-lambda)
1045 (let ((method-name (body-method-name (cddr method-lambda))))
1047 `(named-lambda ,method-name ,(rest method-lambda))
1050 (defun make-method-initargs-form-internal (method-lambda initargs env)
1051 (declare (ignore env))
1052 (let (method-lambda-args
1053 lmf ; becomes body of function
1055 (if (not (and (= 3 (length method-lambda))
1056 (= 2 (length (setq method-lambda-args (cadr method-lambda))))
1057 (consp (setq lmf (third method-lambda)))
1058 (eq 'simple-lexical-method-functions (car lmf))
1059 (eq (car method-lambda-args)
1060 (cadr (setq lmf-params (cadr lmf))))
1061 (eq (cadr method-lambda-args)
1062 (caddr lmf-params))))
1063 `(list* :function ,(name-method-lambda method-lambda)
1065 (let* ((lambda-list (car lmf-params))
1069 (dolist (arg lambda-list)
1070 (when (member arg '(&optional &rest &key))
1073 (when (eq arg '&aux)
1077 (setq args (nreverse args))
1078 (setf (getf (getf initargs :plist) :arg-info) (cons nreq restp))
1079 (make-method-initargs-form-internal1
1080 initargs (cddr lmf) args lmf-params restp)))))
1082 (defun make-method-initargs-form-internal1
1083 (initargs body req-args lmf-params restp)
1084 (multiple-value-bind (outer-decls inner-decls body-sans-decls)
1086 body req-args (or (getf (cdr lmf-params) :call-next-method-p)
1087 (getf (cdr lmf-params) :setq-p)))
1088 (let* ((rest-arg (when restp '.rest-arg.))
1089 (args+rest-arg (if restp
1090 (append req-args (list rest-arg))
1094 (,(if (body-method-name body) 'named-lambda 'lambda)
1095 ,@(when (body-method-name body)
1096 (list (body-method-name body))) ; function name
1097 (.pv-cell. .next-method-call. ,@args+rest-arg) ; function args
1098 ;; body of the function
1099 (declare (ignorable .pv-cell. .next-method-call.))
1101 (declare (disable-package-locks pv-env))
1102 (macrolet ((pv-env ((pv calls pv-table-symbol pv-parameters)
1104 (declare (ignore pv-table-symbol
1106 (declare (enable-package-locks pv-env))
1107 `(let ((,pv (car .pv-cell.))
1108 (,calls (cdr .pv-cell.)))
1109 (declare ,(make-pv-type-declaration pv)
1110 ,(make-calls-type-declaration calls))
1113 (declare (enable-package-locks pv-env))
1114 (fast-lexical-method-functions
1115 (,(car lmf-params) .next-method-call. ,req-args ,rest-arg
1116 ,@(cdddr lmf-params))
1118 ,@body-sans-decls)))
1121 ;;; Use arrays and hash tables and the fngen stuff to make this much
1122 ;;; better. It doesn't really matter, though, because a function
1123 ;;; returned by this will get called only when the user explicitly
1124 ;;; funcalls a result of method-function. BUT, this is needed to make
1125 ;;; early methods work.
1126 (defun method-function-from-fast-function (fmf)
1127 (declare (type function fmf))
1128 (let* ((method-function nil) (pv-table nil)
1129 (arg-info (method-function-get fmf :arg-info))
1130 (nreq (car arg-info))
1131 (restp (cdr arg-info)))
1132 (setq method-function
1133 (lambda (method-args next-methods)
1135 (setq pv-table (method-function-pv-table fmf)))
1136 (let* ((pv-cell (when pv-table
1137 (get-method-function-pv-cell
1138 method-function method-args pv-table)))
1139 (nm (car next-methods))
1140 (nms (cdr next-methods))
1143 :function (if (std-instance-p nm)
1144 (method-function nm)
1146 :call-method-args (list nms)))))
1148 (let* ((rest (nthcdr nreq method-args))
1149 (args (ldiff method-args rest)))
1150 (apply fmf pv-cell nmc (nconc args (list rest))))
1151 (apply fmf pv-cell nmc method-args)))))
1152 (let* ((fname (method-function-get fmf :name))
1153 (name `(,(or (get (car fname) 'method-sym)
1154 (setf (get (car fname) 'method-sym)
1155 (let ((str (symbol-name (car fname))))
1156 (if (string= "FAST-" str :end2 5)
1157 (format-symbol *pcl-package* (subseq str 5))
1160 (set-fun-name method-function name))
1161 (setf (method-function-get method-function :fast-function) fmf)
1164 (defun get-method-function-pv-cell (method-function
1167 (let ((pv-table (or pv-table (method-function-pv-table method-function))))
1169 (let ((pv-wrappers (pv-wrappers-from-all-args pv-table method-args)))
1171 (pv-table-lookup pv-table pv-wrappers))))))
1173 (defun pv-table-lookup-pv-args (pv-table &rest pv-parameters)
1174 (pv-table-lookup pv-table (pv-wrappers-from-pv-args pv-parameters)))
1176 (defun pv-wrappers-from-pv-args (&rest args)
1178 (dolist (arg args (if (cdr wrappers) (nreverse wrappers) (car wrappers)))
1179 (let ((wrapper (wrapper-of arg)))
1180 (push (if (invalid-wrapper-p wrapper)
1181 (check-wrapper-validity wrapper)
1185 (defun pv-wrappers-from-all-args (pv-table args)
1186 (loop for snl in (pv-table-slot-name-lists pv-table) and arg in args
1188 collect (wrapper-of arg) into wrappers
1189 finally (return (if (cdr wrappers) wrappers (car wrappers)))))
1191 ;;; Return the subset of WRAPPERS which is used in the cache
1193 (defun pv-wrappers-from-all-wrappers (pv-table wrappers)
1194 (loop for snl in (pv-table-slot-name-lists pv-table) and w in wrappers
1196 collect w into result
1197 finally (return (if (cdr result) result (car result)))))