src/pcl/dfun.lisp

   1 ;;;; This software is part of the SBCL system. See the README file for
   2 ;;;; more information.
   3
   4 ;;;; This software is derived from software originally released by Xerox
   5 ;;;; Corporation. Copyright and release statements follow. Later modifications
   6 ;;;; to the software are in the public domain and are provided with
   7 ;;;; absolutely no warranty. See the COPYING and CREDITS files for more
   8 ;;;; information.
   9
  10 ;;;; copyright information from original PCL sources:
  11 ;;;;
  12 ;;;; Copyright (c) 1985, 1986, 1987, 1988, 1989, 1990 Xerox Corporation.
  13 ;;;; All rights reserved.
  14 ;;;;
  15 ;;;; Use and copying of this software and preparation of derivative works based
  16 ;;;; upon this software are permitted. Any distribution of this software or
  17 ;;;; derivative works must comply with all applicable United States export
  18 ;;;; control laws.
  19 ;;;;
  20 ;;;; This software is made available AS IS, and Xerox Corporation makes no
  21 ;;;; warranty about the software, its performance or its conformity to any
  22 ;;;; specification.
  23
  24 (in-package "SB-PCL")
  25 \f
  26 #|
  27
  28 This implementation of method lookup was redone in early August of 89.
  29
  30 It has the following properties:
  31
  32  - Its modularity makes it easy to modify the actual caching algorithm.
  33    The caching algorithm is almost completely separated into the files
  34    cache.lisp and dlap.lisp. This file just contains the various uses
  35    of it. There will be more tuning as we get more results from Luis'
  36    measurements of caching behavior.
  37
  38  - The metacircularity issues have been dealt with properly. All of
  39    PCL now grounds out properly. Moreover, it is now possible to have
  40    metaobject classes which are themselves not instances of standard
  41    metaobject classes.
  42
  43 ** Modularity of the code **
  44
  45 The actual caching algorithm is isolated in a modest number of functions.
  46 The code which generates cache lookup code is all found in cache.lisp and
  47 dlap.lisp. Certain non-wrapper-caching special cases are in this file.
  48
  49 ** Handling the metacircularity **
  50
  51 In CLOS, method lookup is the potential source of infinite metacircular
  52 regress. The metaobject protocol specification gives us wide flexibility
  53 in how to address this problem. PCL uses a technique which handles the
  54 problem not only for the metacircular language described in Chapter 3, but
  55 also for the PCL protocol which includes additional generic functions
  56 which control more aspects of the CLOS implementation.
  57
  58 The source of the metacircular regress can be seen in a number of ways.
  59 One is that the specified method lookup protocol must, as part of doing
  60 the method lookup (or at least the cache miss case), itself call generic
  61 functions. It is easy to see that if the method lookup for a generic
  62 function ends up calling that same generic function there can be trouble.
  63
  64 Fortunately, there is an easy solution at hand. The solution is based on
  65 the restriction that portable code cannot change the class of a specified
  66 metaobject. This restriction implies that for specified generic functions,
  67 the method lookup protocol they follow is fixed.
  68
  69 More precisely, for such specified generic functions, most generic functions
  70 that are called during their own method lookup will not run portable methods.
  71 This allows the implementation to usurp the actual generic function call in
  72 this case. In short, method lookup of a standard generic function, in the
  73 case where the only applicable methods are themselves standard doesn't
  74 have to do any method lookup to implement itself.
  75
  76 And so, we are saved.
  77
  78 Except see also BREAK-VICIOUS-METACIRCLE.  -- CSR, 2003-05-28
  79
  80 |#
  81 \f
  82 ;;; an alist in which each entry is of the form
  83 ;;;   (<generator> . (<subentry> ...)).
  84 ;;; Each subentry is of the form
  85 ;;;   (<args> <constructor> <system>).
  86 (defvar *dfun-constructors* ())
  87
  88 ;;; If this is NIL, then the whole mechanism for caching dfun constructors is
  89 ;;; turned off. The only time that makes sense is when debugging LAP code.
  90 (defvar *enable-dfun-constructor-caching* t)
  91
  92 (defun show-dfun-constructors ()
  93   (format t "~&DFUN constructor caching is ~A."
  94           (if *enable-dfun-constructor-caching*
  95               "enabled" "disabled"))
  96   (dolist (generator-entry *dfun-constructors*)
  97     (dolist (args-entry (cdr generator-entry))
  98       (format t "~&~S ~S"
  99               (cons (car generator-entry) (caar args-entry))
 100               (caddr args-entry)))))
 101
 102 (defvar *raise-metatypes-to-class-p* t)
 103
 104 (defun get-dfun-constructor (generator &rest args)
 105   (when (and *raise-metatypes-to-class-p*
 106              (member generator '(emit-checking emit-caching
 107                                  emit-in-checking-cache-p emit-constant-value)))
 108     (setq args (cons (mapcar (lambda (mt)
 109                                (if (eq mt t)
 110                                    mt
 111                                    'class))
 112                              (car args))
 113                      (cdr args))))
 114   (let* ((generator-entry (assq generator *dfun-constructors*))
 115          (args-entry (assoc args (cdr generator-entry) :test #'equal)))
 116     (if (null *enable-dfun-constructor-caching*)
 117         (apply (fdefinition generator) args)
 118         (or (cadr args-entry)
 119             (multiple-value-bind (new not-best-p)
 120                 (apply (symbol-function generator) args)
 121               (let ((entry (list (copy-list args) new (unless not-best-p 'pcl)
 122                                  not-best-p)))
 123                 (if generator-entry
 124                     (push entry (cdr generator-entry))
 125                     (push (list generator entry)
 126                           *dfun-constructors*)))
 127               (values new not-best-p))))))
 128
 129 (defun load-precompiled-dfun-constructor (generator args system constructor)
 130   (let* ((generator-entry (assq generator *dfun-constructors*))
 131          (args-entry (assoc args (cdr generator-entry) :test #'equal)))
 132     (if args-entry
 133         (when (fourth args-entry)
 134           (let* ((dfun-type (case generator
 135                               (emit-checking 'checking)
 136                               (emit-caching 'caching)
 137                               (emit-constant-value 'constant-value)
 138                               (emit-default-only 'default-method-only)))
 139                  (metatypes (car args))
 140                  (gfs (when dfun-type (gfs-of-type dfun-type))))
 141             (dolist (gf gfs)
 142               (when (and (equal metatypes
 143                                 (arg-info-metatypes (gf-arg-info gf)))
 144                          (let ((gf-name (generic-function-name gf)))
 145                            (and (not (eq gf-name 'slot-value-using-class))
 146                                 (not (equal gf-name
 147                                             '(setf slot-value-using-class)))
 148                                 (not (eq gf-name 'slot-boundp-using-class)))))
 149                 (update-dfun gf)))
 150             (setf (second args-entry) constructor)
 151             (setf (third args-entry) system)
 152             (setf (fourth args-entry) nil)))
 153         (let ((entry (list args constructor system nil)))
 154           (if generator-entry
 155               (push entry (cdr generator-entry))
 156               (push (list generator entry) *dfun-constructors*))))))
 157
 158 (defmacro precompile-dfun-constructors (&optional system)
 159   (let ((*precompiling-lap* t))
 160     `(progn
 161        ,@(let (collect)
 162            (dolist (generator-entry *dfun-constructors*)
 163              (dolist (args-entry (cdr generator-entry))
 164                (when (or (null (caddr args-entry))
 165                          (eq (caddr args-entry) system))
 166                  (when system (setf (caddr args-entry) system))
 167                  (push `(load-precompiled-dfun-constructor
 168                          ',(car generator-entry)
 169                          ',(car args-entry)
 170                          ',system
 171                          ,(apply (fdefinition (car generator-entry))
 172                                  (car args-entry)))
 173                        collect))))
 174            (nreverse collect)))))
 175 \f
 176 ;;; Standardized class slot access: when trying to break vicious
 177 ;;; metacircles, we need a way to get at the values of slots of some
 178 ;;; standard classes without going through the whole meta machinery,
 179 ;;; because that would likely enter the vicious circle again.  The
 180 ;;; following are helper functions that short-circuit the generic
 181 ;;; lookup machinery.
 182
 183 (defvar *standard-classes*
 184   '(standard-method standard-generic-function standard-class
 185     standard-effective-slot-definition))
 186
 187 (defvar *standard-slot-locations* (make-hash-table :test 'equal))
 188
 189 (defun compute-standard-slot-locations ()
 190   (clrhash *standard-slot-locations*)
 191   (dolist (class-name *standard-classes*)
 192     (let ((class (find-class class-name)))
 193       (dolist (slot (class-slots class))
 194         (setf (gethash (cons class (slot-definition-name slot))
 195                        *standard-slot-locations*)
 196               (slot-definition-location slot))))))
 197
 198 ;;; FIXME: harmonize the names between COMPUTE-STANDARD-SLOT-LOCATIONS
 199 ;;; and MAYBE-UPDATE-STANDARD-CLASS-LOCATIONS.
 200 (defun maybe-update-standard-class-locations (class)
 201   (when (and (eq *boot-state* 'complete)
 202              (memq (class-name class) *standard-classes*))
 203     (compute-standard-slot-locations)))
 204
 205 (defun standard-slot-value (object slot-name class)
 206   (let ((location (gethash (cons class slot-name) *standard-slot-locations*)))
 207     (if location
 208         (let ((value (if (funcallable-instance-p object)
 209                          (funcallable-standard-instance-access object location)
 210                          (standard-instance-access object location))))
 211           (when (eq +slot-unbound+ value)
 212             (error "~@<slot ~S of class ~S is unbound in object ~S~@:>"
 213                    slot-name class object))
 214           value)
 215         (error "~@<cannot get standard value of slot ~S of class ~S ~
 216                 in object ~S~@:>"
 217                slot-name class object))))
 218
 219 (defun standard-slot-value/gf (gf slot-name)
 220   (standard-slot-value gf slot-name *the-class-standard-generic-function*))
 221
 222 (defun standard-slot-value/method (method slot-name)
 223   (standard-slot-value method slot-name *the-class-standard-method*))
 224
 225 (defun standard-slot-value/eslotd (slotd slot-name)
 226   (standard-slot-value slotd slot-name
 227                        *the-class-standard-effective-slot-definition*))
 228
 229 (defun standard-slot-value/class (class slot-name)
 230   (standard-slot-value class slot-name *the-class-standard-class*))
 231 \f
 232 ;;; When all the methods of a generic function are automatically
 233 ;;; generated reader or writer methods a number of special
 234 ;;; optimizations are possible. These are important because of the
 235 ;;; large number of generic functions of this type.
 236 ;;;
 237 ;;; There are a number of cases:
 238 ;;;
 239 ;;;   ONE-CLASS-ACCESSOR
 240 ;;;     In this case, the accessor generic function has only been
 241 ;;;     called with one class of argument. There is no cache vector,
 242 ;;;     the wrapper of the one class, and the slot index are stored
 243 ;;;     directly as closure variables of the discriminating function.
 244 ;;;     This case can convert to either of the next kind.
 245 ;;;
 246 ;;;   TWO-CLASS-ACCESSOR
 247 ;;;     Like above, but two classes. This is common enough to do
 248 ;;;     specially. There is no cache vector. The two classes are
 249 ;;;     stored a separate closure variables.
 250 ;;;
 251 ;;;   ONE-INDEX-ACCESSOR
 252 ;;;     In this case, the accessor generic function has seen more than
 253 ;;;     one class of argument, but the index of the slot is the same
 254 ;;;     for all the classes that have been seen. A cache vector is
 255 ;;;     used to store the wrappers that have been seen, the slot index
 256 ;;;     is stored directly as a closure variable of the discriminating
 257 ;;;     function. This case can convert to the next kind.
 258 ;;;
 259 ;;;   N-N-ACCESSOR
 260 ;;;     This is the most general case. In this case, the accessor
 261 ;;;     generic function has seen more than one class of argument and
 262 ;;;     more than one slot index. A cache vector stores the wrappers
 263 ;;;     and corresponding slot indexes. Because each cache line is
 264 ;;;     more than one element long, a cache lock count is used.
 265 (defstruct (dfun-info (:constructor nil)
 266                       (:copier nil))
 267   (cache nil))
 268
 269 (defstruct (no-methods (:constructor no-methods-dfun-info ())
 270                        (:include dfun-info)
 271                        (:copier nil)))
 272
 273 (defstruct (initial (:constructor initial-dfun-info ())
 274                     (:include dfun-info)
 275                     (:copier nil)))
 276
 277 (defstruct (initial-dispatch (:constructor initial-dispatch-dfun-info ())
 278                              (:include dfun-info)
 279                              (:copier nil)))
 280
 281 (defstruct (dispatch (:constructor dispatch-dfun-info ())
 282                      (:include dfun-info)
 283                      (:copier nil)))
 284
 285 (defstruct (default-method-only (:constructor default-method-only-dfun-info ())
 286                                 (:include dfun-info)
 287                                 (:copier nil)))
 288
 289 ;without caching:
 290 ;  dispatch one-class two-class default-method-only
 291
 292 ;with caching:
 293 ;  one-index n-n checking caching
 294
 295 ;accessor:
 296 ;  one-class two-class one-index n-n
 297 (defstruct (accessor-dfun-info (:constructor nil)
 298                                (:include dfun-info)
 299                                (:copier nil))
 300   accessor-type) ; (member reader writer)
 301
 302 (defmacro dfun-info-accessor-type (di)
 303   `(accessor-dfun-info-accessor-type ,di))
 304
 305 (defstruct (one-index-dfun-info (:constructor nil)
 306                                 (:include accessor-dfun-info)
 307                                 (:copier nil))
 308   index)
 309
 310 (defmacro dfun-info-index (di)
 311   `(one-index-dfun-info-index ,di))
 312
 313 (defstruct (n-n (:constructor n-n-dfun-info (accessor-type cache))
 314                 (:include accessor-dfun-info)
 315                 (:copier nil)))
 316
 317 (defstruct (one-class (:constructor one-class-dfun-info
 318                                     (accessor-type index wrapper0))
 319                       (:include one-index-dfun-info)
 320                       (:copier nil))
 321   wrapper0)
 322
 323 (defmacro dfun-info-wrapper0 (di)
 324   `(one-class-wrapper0 ,di))
 325
 326 (defstruct (two-class (:constructor two-class-dfun-info
 327                                     (accessor-type index wrapper0 wrapper1))
 328                       (:include one-class)
 329                       (:copier nil))
 330   wrapper1)
 331
 332 (defmacro dfun-info-wrapper1 (di)
 333   `(two-class-wrapper1 ,di))
 334
 335 (defstruct (one-index (:constructor one-index-dfun-info
 336                                     (accessor-type index cache))
 337                       (:include one-index-dfun-info)
 338                       (:copier nil)))
 339
 340 (defstruct (checking (:constructor checking-dfun-info (function cache))
 341                      (:include dfun-info)
 342                      (:copier nil))
 343   function)
 344
 345 (defmacro dfun-info-function (di)
 346   `(checking-function ,di))
 347
 348 (defstruct (caching (:constructor caching-dfun-info (cache))
 349                     (:include dfun-info)
 350                     (:copier nil)))
 351
 352 (defstruct (constant-value (:constructor constant-value-dfun-info (cache))
 353                            (:include dfun-info)
 354                            (:copier nil)))
 355
 356 (defmacro dfun-update (generic-function function &rest args)
 357   `(multiple-value-bind (dfun cache info)
 358        (funcall ,function ,generic-function ,@args)
 359      (update-dfun ,generic-function dfun cache info)))
 360
 361 (defun accessor-miss-function (gf dfun-info)
 362   (ecase (dfun-info-accessor-type dfun-info)
 363     ((reader boundp)
 364      (lambda (arg)
 365        (accessor-miss gf nil arg dfun-info)))
 366     (writer
 367      (lambda (new arg)
 368        (accessor-miss gf new arg dfun-info)))))
 369
 370 #-sb-fluid (declaim (sb-ext:freeze-type dfun-info))
 371 \f
 372 (defun make-one-class-accessor-dfun (gf type wrapper index)
 373   (let ((emit (ecase type
 374                 (reader 'emit-one-class-reader)
 375                 (boundp 'emit-one-class-boundp)
 376                 (writer 'emit-one-class-writer)))
 377         (dfun-info (one-class-dfun-info type index wrapper)))
 378     (values
 379      (funcall (get-dfun-constructor emit (consp index))
 380               wrapper index
 381               (accessor-miss-function gf dfun-info))
 382      nil
 383      dfun-info)))
 384
 385 (defun make-two-class-accessor-dfun (gf type w0 w1 index)
 386   (let ((emit (ecase type
 387                 (reader 'emit-two-class-reader)
 388                 (boundp 'emit-two-class-boundp)
 389                 (writer 'emit-two-class-writer)))
 390         (dfun-info (two-class-dfun-info type index w0 w1)))
 391     (values
 392      (funcall (get-dfun-constructor emit (consp index))
 393               w0 w1 index
 394               (accessor-miss-function gf dfun-info))
 395      nil
 396      dfun-info)))
 397
 398 ;;; std accessors same index dfun
 399 (defun make-one-index-accessor-dfun (gf type index &optional cache)
 400   (let* ((emit (ecase type
 401                  (reader 'emit-one-index-readers)
 402                  (boundp 'emit-one-index-boundps)
 403                  (writer 'emit-one-index-writers)))
 404          (cache (or cache (get-cache 1 nil #'one-index-limit-fn 4)))
 405          (dfun-info (one-index-dfun-info type index cache)))
 406     (declare (type cache cache))
 407     (values
 408      (funcall (get-dfun-constructor emit (consp index))
 409               cache
 410               index
 411               (accessor-miss-function gf dfun-info))
 412      cache
 413      dfun-info)))
 414
 415 (defun make-final-one-index-accessor-dfun (gf type index table)
 416   (let ((cache (fill-dfun-cache table nil 1 #'one-index-limit-fn)))
 417     (make-one-index-accessor-dfun gf type index cache)))
 418
 419 (defun one-index-limit-fn (nlines)
 420   (default-limit-fn nlines))
 421
 422 (defun make-n-n-accessor-dfun (gf type &optional cache)
 423   (let* ((emit (ecase type
 424                  (reader 'emit-n-n-readers)
 425                  (boundp 'emit-n-n-boundps)
 426                  (writer 'emit-n-n-writers)))
 427          (cache (or cache (get-cache 1 t #'n-n-accessors-limit-fn 2)))
 428          (dfun-info (n-n-dfun-info type cache)))
 429     (declare (type cache cache))
 430     (values
 431      (funcall (get-dfun-constructor emit)
 432               cache
 433               (accessor-miss-function gf dfun-info))
 434      cache
 435      dfun-info)))
 436
 437 (defun make-final-n-n-accessor-dfun (gf type table)
 438   (let ((cache (fill-dfun-cache table t 1 #'n-n-accessors-limit-fn)))
 439     (make-n-n-accessor-dfun gf type cache)))
 440
 441 (defun n-n-accessors-limit-fn (nlines)
 442   (default-limit-fn nlines))
 443
 444 (defun make-checking-dfun (generic-function function &optional cache)
 445   (unless cache
 446     (when (use-caching-dfun-p generic-function)
 447       (return-from make-checking-dfun (make-caching-dfun generic-function)))
 448     (when (use-dispatch-dfun-p generic-function)
 449       (return-from make-checking-dfun (make-dispatch-dfun generic-function))))
 450   (multiple-value-bind (nreq applyp metatypes nkeys)
 451       (get-generic-fun-info generic-function)
 452     (declare (ignore nreq))
 453     (if (every (lambda (mt) (eq mt t)) metatypes)
 454         (let ((dfun-info (default-method-only-dfun-info)))
 455           (values
 456            (funcall (get-dfun-constructor 'emit-default-only metatypes applyp)
 457                     function)
 458            nil
 459            dfun-info))
 460         (let* ((cache (or cache (get-cache nkeys nil #'checking-limit-fn 2)))
 461                (dfun-info (checking-dfun-info function cache)))
 462           (values
 463            (funcall (get-dfun-constructor 'emit-checking metatypes applyp)
 464                     cache
 465                     function
 466                     (lambda (&rest args)
 467                       (checking-miss generic-function args dfun-info)))
 468            cache
 469            dfun-info)))))
 470
 471 (defun make-final-checking-dfun (generic-function function
 472                                                   classes-list new-class)
 473   (multiple-value-bind (nreq applyp metatypes nkeys)
 474       (get-generic-fun-info generic-function)
 475     (declare (ignore nreq applyp nkeys))
 476     (if (every (lambda (mt) (eq mt t)) metatypes)
 477         (values (lambda (&rest args)
 478                   (invoke-emf function args))
 479                 nil (default-method-only-dfun-info))
 480         (let ((cache (make-final-ordinary-dfun-internal
 481                       generic-function nil #'checking-limit-fn
 482                       classes-list new-class)))
 483           (make-checking-dfun generic-function function cache)))))
 484
 485 (defun use-default-method-only-dfun-p (generic-function)
 486   (multiple-value-bind (nreq applyp metatypes nkeys)
 487       (get-generic-fun-info generic-function)
 488     (declare (ignore nreq applyp nkeys))
 489     (every (lambda (mt) (eq mt t)) metatypes)))
 490
 491 (defun use-caching-dfun-p (generic-function)
 492   (some (lambda (method) (method-plist-value method :slot-name-lists))
 493         ;; KLUDGE: As of sbcl-0.6.4, it's very important for
 494         ;; efficiency to know the type of the sequence argument to
 495         ;; quantifiers (SOME/NOTANY/etc.) at compile time, but
 496         ;; the compiler isn't smart enough to understand the :TYPE
 497         ;; slot option for DEFCLASS, so we just tell
 498         ;; it the type by hand here.
 499         (the list
 500              (if (early-gf-p generic-function)
 501                  (early-gf-methods generic-function)
 502                  (generic-function-methods generic-function)))))
 503
 504 (defun checking-limit-fn (nlines)
 505   (default-limit-fn nlines))
 506 \f
 507 (defun make-caching-dfun (generic-function &optional cache)
 508   (unless cache
 509     (when (use-constant-value-dfun-p generic-function)
 510       (return-from make-caching-dfun
 511         (make-constant-value-dfun generic-function)))
 512     (when (use-dispatch-dfun-p generic-function)
 513       (return-from make-caching-dfun
 514         (make-dispatch-dfun generic-function))))
 515   (multiple-value-bind (nreq applyp metatypes nkeys)
 516       (get-generic-fun-info generic-function)
 517     (declare (ignore nreq))
 518     (let* ((cache (or cache (get-cache nkeys t #'caching-limit-fn 2)))
 519            (dfun-info (caching-dfun-info cache)))
 520       (values
 521        (funcall (get-dfun-constructor 'emit-caching metatypes applyp)
 522                 cache
 523                 (lambda (&rest args)
 524                   (caching-miss generic-function args dfun-info)))
 525        cache
 526        dfun-info))))
 527
 528 (defun make-final-caching-dfun (generic-function classes-list new-class)
 529   (let ((cache (make-final-ordinary-dfun-internal
 530                 generic-function t #'caching-limit-fn
 531                 classes-list new-class)))
 532     (make-caching-dfun generic-function cache)))
 533
 534 (defun caching-limit-fn (nlines)
 535   (default-limit-fn nlines))
 536
 537 (defun insure-caching-dfun (gf)
 538   (multiple-value-bind (nreq applyp metatypes nkeys)
 539       (get-generic-fun-info gf)
 540     (declare (ignore nreq nkeys))
 541     (when (and metatypes
 542                (not (null (car metatypes)))
 543                (dolist (mt metatypes nil)
 544                  (unless (eq mt t) (return t))))
 545       (get-dfun-constructor 'emit-caching metatypes applyp))))
 546
 547 (defun use-constant-value-dfun-p (gf &optional boolean-values-p)
 548   (multiple-value-bind (nreq applyp metatypes nkeys)
 549       (get-generic-fun-info gf)
 550     (declare (ignore nreq metatypes nkeys))
 551     (let* ((early-p (early-gf-p gf))
 552            (methods (if early-p
 553                         (early-gf-methods gf)
 554                         (generic-function-methods gf)))
 555            (default '(unknown)))
 556       (and (null applyp)
 557            (or (not (eq *boot-state* 'complete))
 558                ;; If COMPUTE-APPLICABLE-METHODS is specialized, we
 559                ;; can't use this, of course, because we can't tell
 560                ;; which methods will be considered applicable.
 561                ;;
 562                ;; Also, don't use this dfun method if the generic
 563                ;; function has a non-standard method combination,
 564                ;; because if it has, it's not sure that method
 565                ;; functions are used directly as effective methods,
 566                ;; which CONSTANT-VALUE-MISS depends on.  The
 567                ;; pre-defined method combinations like LIST are
 568                ;; examples of that.
 569                (and (compute-applicable-methods-emf-std-p gf)
 570                     (eq (generic-function-method-combination gf)
 571                         *standard-method-combination*)))
 572            ;; Check that no method is eql-specialized, and that all
 573            ;; methods return a constant value.  If BOOLEAN-VALUES-P,
 574            ;; check that all return T or NIL.  Also, check that no
 575            ;; method has qualifiers, to make sure that emfs are really
 576            ;; method functions; see above.
 577            (dolist (method methods t)
 578              (when (eq *boot-state* 'complete)
 579                (when (or (some #'eql-specializer-p
 580                                (safe-method-specializers method))
 581                          (safe-method-qualifiers method))
 582                  (return nil)))
 583              (let ((value (method-plist-value method :constant-value default)))
 584                (when (or (eq value default)
 585                          (and boolean-values-p
 586                               (not (member value '(t nil)))))
 587                  (return nil))))))))
 588
 589 (defun make-constant-value-dfun (generic-function &optional cache)
 590   (multiple-value-bind (nreq applyp metatypes nkeys)
 591       (get-generic-fun-info generic-function)
 592     (declare (ignore nreq applyp))
 593     (let* ((cache (or cache (get-cache nkeys t #'caching-limit-fn 2)))
 594            (dfun-info (constant-value-dfun-info cache)))
 595       (values
 596        (funcall (get-dfun-constructor 'emit-constant-value metatypes)
 597                 cache
 598                 (lambda (&rest args)
 599                   (constant-value-miss generic-function args dfun-info)))
 600        cache
 601        dfun-info))))
 602
 603 (defun make-final-constant-value-dfun (generic-function classes-list new-class)
 604   (let ((cache (make-final-ordinary-dfun-internal
 605                 generic-function :constant-value #'caching-limit-fn
 606                 classes-list new-class)))
 607     (make-constant-value-dfun generic-function cache)))
 608
 609 (defun use-dispatch-dfun-p (gf &optional (caching-p (use-caching-dfun-p gf)))
 610   (when (eq *boot-state* 'complete)
 611     (unless (or caching-p
 612                 (gf-requires-emf-keyword-checks gf))
 613       ;; This should return T when almost all dispatching is by
 614       ;; eql specializers or built-in classes. In other words,
 615       ;; return NIL if we might ever need to do more than
 616       ;; one (non built-in) typep.
 617       ;; Otherwise, it is probably at least as fast to use
 618       ;; a caching dfun first, possibly followed by secondary dispatching.
 619
 620       #||;;; Original found in cmu 17f -- S L O W
 621       (< (dispatch-dfun-cost gf) (caching-dfun-cost gf))
 622       ||#
 623       ;; This uses improved dispatch-dfun-cost below
 624       (let ((cdc  (caching-dfun-cost gf))) ; fast
 625         (> cdc (dispatch-dfun-cost gf cdc))))))
 626
 627 (defparameter *non-built-in-typep-cost* 100)
 628 (defparameter *structure-typep-cost*  15)
 629 (defparameter *built-in-typep-cost* 5)
 630
 631 ;;; According to comments in the original CMU CL version of PCL,
 632 ;;; the cost LIMIT is important to cut off exponential growth for
 633 ;;; large numbers of gf methods and argument lists.
 634 (defun dispatch-dfun-cost (gf &optional limit)
 635   (generate-discrimination-net-internal
 636    gf (generic-function-methods gf) nil
 637    (lambda (methods known-types)
 638      (declare (ignore methods known-types))
 639      0)
 640    (lambda (position type true-value false-value)
 641      (declare (ignore position))
 642      (let* ((type-test-cost
 643              (if (eq 'class (car type))
 644                  (let* ((metaclass (class-of (cadr type)))
 645                         (mcpl (class-precedence-list metaclass)))
 646                    (cond ((memq *the-class-built-in-class* mcpl)
 647                           *built-in-typep-cost*)
 648                          ((memq *the-class-structure-class* mcpl)
 649                           *structure-typep-cost*)
 650                          (t
 651                           *non-built-in-typep-cost*)))
 652                  0))
 653             (max-cost-so-far
 654              (+ (max true-value false-value) type-test-cost)))
 655        (when (and limit (<= limit max-cost-so-far))
 656          (return-from dispatch-dfun-cost max-cost-so-far))
 657        max-cost-so-far))
 658    #'identity))
 659
 660 (defparameter *cache-lookup-cost*  30)
 661 (defparameter *wrapper-of-cost* 15)
 662 (defparameter *secondary-dfun-call-cost* 30)
 663
 664 (defun caching-dfun-cost (gf)
 665   (let ((nreq (get-generic-fun-info gf)))
 666     (+ *cache-lookup-cost*
 667        (* *wrapper-of-cost* nreq)
 668        (if (methods-contain-eql-specializer-p
 669             (generic-function-methods gf))
 670            *secondary-dfun-call-cost*
 671            0))))
 672
 673 (declaim (inline make-callable))
 674 (defun make-callable (gf methods generator method-alist wrappers)
 675   (let* ((*applicable-methods* methods)
 676          (callable (function-funcall generator method-alist wrappers)))
 677     callable))
 678
 679 (defun make-dispatch-dfun (gf)
 680   (values (get-dispatch-function gf) nil (dispatch-dfun-info)))
 681
 682 (defun get-dispatch-function (gf)
 683   (let* ((methods (generic-function-methods gf))
 684          (generator (get-secondary-dispatch-function1
 685                      gf methods nil nil nil nil nil t)))
 686     (make-callable gf methods generator nil nil)))
 687
 688 (defun make-final-dispatch-dfun (gf)
 689   (make-dispatch-dfun gf))
 690
 691 (defun update-dispatch-dfuns ()
 692   (dolist (gf (gfs-of-type '(dispatch initial-dispatch)))
 693     (dfun-update gf #'make-dispatch-dfun)))
 694
 695 (defun fill-dfun-cache (table valuep nkeys limit-fn &optional cache)
 696   (let ((cache (or cache (get-cache nkeys valuep limit-fn
 697                                     (+ (hash-table-count table) 3)))))
 698     (maphash (lambda (classes value)
 699                (setq cache (fill-cache cache
 700                                        (class-wrapper classes)
 701                                        value)))
 702              table)
 703     cache))
 704
 705 (defun make-final-ordinary-dfun-internal (generic-function valuep limit-fn
 706                                                            classes-list new-class)
 707   (let* ((arg-info (gf-arg-info generic-function))
 708          (nkeys (arg-info-nkeys arg-info))
 709          (new-class (and new-class
 710                          (equal (type-of (gf-dfun-info generic-function))
 711                                 (cond ((eq valuep t) 'caching)
 712                                       ((eq valuep :constant-value) 'constant-value)
 713                                       ((null valuep) 'checking)))
 714                          new-class))
 715          (cache (if new-class
 716                     (copy-cache (gf-dfun-cache generic-function))
 717                     (get-cache nkeys (not (null valuep)) limit-fn 4))))
 718       (make-emf-cache generic-function valuep cache classes-list new-class)))
 719 \f
 720 (defvar *dfun-miss-gfs-on-stack* ())
 721
 722 (defmacro dfun-miss ((gf args wrappers invalidp nemf
 723                       &optional type index caching-p applicable)
 724                      &body body)
 725   (unless applicable (setq applicable (gensym)))
 726   `(multiple-value-bind (,nemf ,applicable ,wrappers ,invalidp
 727                          ,@(when type `(,type ,index)))
 728        (cache-miss-values ,gf ,args ',(cond (caching-p 'caching)
 729                                             (type 'accessor)
 730                                             (t 'checking)))
 731     (when (and ,applicable (not (memq ,gf *dfun-miss-gfs-on-stack*)))
 732       (let ((*dfun-miss-gfs-on-stack* (cons ,gf *dfun-miss-gfs-on-stack*)))
 733         ,@body))
 734     ;; Create a FAST-INSTANCE-BOUNDP structure instance for a cached
 735     ;; SLOT-BOUNDP so that INVOKE-EMF does the right thing, that is,
 736     ;; does not signal a SLOT-UNBOUND error for a boundp test.
 737     ,@(if type
 738           ;; FIXME: could the NEMF not be a CONS (for :CLASS-allocated
 739           ;; slots?)
 740           `((if (and (eq ,type 'boundp) (integerp ,nemf))
 741                 (invoke-emf (make-fast-instance-boundp :index ,nemf) ,args)
 742                 (invoke-emf ,nemf ,args)))
 743           `((invoke-emf ,nemf ,args)))))
 744
 745 ;;; The dynamically adaptive method lookup algorithm is implemented is
 746 ;;; implemented as a kind of state machine. The kinds of
 747 ;;; discriminating function is the state, the various kinds of reasons
 748 ;;; for a cache miss are the state transitions.
 749 ;;;
 750 ;;; The code which implements the transitions is all in the miss
 751 ;;; handlers for each kind of dfun. Those appear here.
 752 ;;;
 753 ;;; Note that within the states that cache, there are dfun updates
 754 ;;; which simply select a new cache or cache field. Those are not
 755 ;;; considered as state transitions.
 756 (defvar *lazy-dfun-compute-p* t)
 757 (defvar *early-p* nil)
 758
 759 (declaim (type (or null unsigned-byte) *max-emf-precomputation-methods*))
 760 (defvar *max-emf-precomputation-methods* nil)
 761
 762 (defun finalize-specializers (gf)
 763   (let ((methods (generic-function-methods gf)))
 764     (when (or (null *max-emf-precomputation-methods*)
 765               (<= (length methods) *max-emf-precomputation-methods*))
 766       (let ((all-finalized t))
 767         (dolist (method methods all-finalized)
 768           (dolist (specializer (method-specializers method))
 769             (when (and (classp specializer)
 770                        (not (class-finalized-p specializer)))
 771               (if (class-has-a-forward-referenced-superclass-p specializer)
 772                   (setq all-finalized nil)
 773                   (finalize-inheritance specializer)))))))))
 774
 775 (defun make-initial-dfun (gf)
 776   (let ((initial-dfun
 777          #'(lambda (&rest args)
 778              (initial-dfun gf args))))
 779     (multiple-value-bind (dfun cache info)
 780         (cond
 781           ((and (eq *boot-state* 'complete)
 782                 (not (finalize-specializers gf)))
 783            (values initial-dfun nil (initial-dfun-info)))
 784           ((and (eq *boot-state* 'complete)
 785                 (compute-applicable-methods-emf-std-p gf))
 786            (let* ((caching-p (use-caching-dfun-p gf))
 787                   ;; KLUDGE: the only effect of this (when
 788                   ;; *LAZY-DFUN-COMPUTE-P* is true, as it usually is)
 789                   ;; is to signal an error when we try to add methods
 790                   ;; with the wrong qualifiers to a generic function.
 791                   (classes-list (precompute-effective-methods
 792                                  gf caching-p
 793                                  (not *lazy-dfun-compute-p*))))
 794              (if *lazy-dfun-compute-p*
 795                  (cond ((use-dispatch-dfun-p gf caching-p)
 796                         (values initial-dfun
 797                                 nil
 798                                 (initial-dispatch-dfun-info)))
 799                        (caching-p
 800                         (insure-caching-dfun gf)
 801                         (values initial-dfun nil (initial-dfun-info)))
 802                        (t
 803                         (values initial-dfun nil (initial-dfun-info))))
 804                  (make-final-dfun-internal gf classes-list))))
 805           (t
 806            (let ((arg-info (if (early-gf-p gf)
 807                                (early-gf-arg-info gf)
 808                                (gf-arg-info gf)))
 809                  (type nil))
 810              (if (and (gf-precompute-dfun-and-emf-p arg-info)
 811                       (setq type (final-accessor-dfun-type gf)))
 812                  (if *early-p*
 813                      (values (make-early-accessor gf type) nil nil)
 814                      (make-final-accessor-dfun gf type))
 815                  (values initial-dfun nil (initial-dfun-info))))))
 816       (set-dfun gf dfun cache info))))
 817
 818 (defun make-early-accessor (gf type)
 819   (let* ((methods (early-gf-methods gf))
 820          (slot-name (early-method-standard-accessor-slot-name (car methods))))
 821     (ecase type
 822       (reader #'(lambda (instance)
 823                   (let* ((class (class-of instance))
 824                          (class-name (!bootstrap-get-slot 'class class 'name)))
 825                     (!bootstrap-get-slot class-name instance slot-name))))
 826       (boundp #'(lambda (instance)
 827                   (let* ((class (class-of instance))
 828                          (class-name (!bootstrap-get-slot 'class class 'name)))
 829                     (not (eq +slot-unbound+
 830                              (!bootstrap-get-slot class-name
 831                                                   instance slot-name))))))
 832       (writer #'(lambda (new-value instance)
 833                   (let* ((class (class-of instance))
 834                          (class-name (!bootstrap-get-slot 'class class 'name)))
 835                     (!bootstrap-set-slot class-name instance slot-name new-value)))))))
 836
 837 (defun initial-dfun (gf args)
 838   (dfun-miss (gf args wrappers invalidp nemf ntype nindex)
 839     (cond (invalidp)
 840           ((and ntype nindex)
 841            (dfun-update
 842             gf #'make-one-class-accessor-dfun ntype wrappers nindex))
 843           ((use-caching-dfun-p gf)
 844            (dfun-update gf #'make-caching-dfun))
 845           (t
 846            (dfun-update
 847             gf #'make-checking-dfun
 848             ;; nemf is suitable only for caching, have to do this:
 849             (cache-miss-values gf args 'checking))))))
 850
 851 (defun make-final-dfun (gf &optional classes-list)
 852   (multiple-value-bind (dfun cache info)
 853       (make-final-dfun-internal gf classes-list)
 854     (set-dfun gf dfun cache info)))
 855
 856 (defvar *new-class* nil)
 857
 858 (defvar *free-hash-tables* (mapcar #'list '(eq equal eql)))
 859
 860 (defmacro with-hash-table ((table test) &body forms)
 861   `(let* ((.free. (assoc ',test *free-hash-tables*))
 862           (,table (if (cdr .free.)
 863                       (pop (cdr .free.))
 864                       (make-hash-table :test ',test))))
 865      (multiple-value-prog1
 866          (progn ,@forms)
 867        (clrhash ,table)
 868        (push ,table (cdr .free.)))))
 869
 870 (defmacro with-eq-hash-table ((table) &body forms)
 871   `(with-hash-table (,table eq) ,@forms))
 872
 873 (defun final-accessor-dfun-type (gf)
 874   (let ((methods (if (early-gf-p gf)
 875                      (early-gf-methods gf)
 876                      (generic-function-methods gf))))
 877     (cond ((every (lambda (method)
 878                     (if (consp method)
 879                         (let ((class (early-method-class method)))
 880                           (or (eq class *the-class-standard-reader-method*)
 881                               (eq class *the-class-global-reader-method*)))
 882                         (or (standard-reader-method-p method)
 883                             (global-reader-method-p method))))
 884                   methods)
 885            'reader)
 886           ((every (lambda (method)
 887                     (if (consp method)
 888                         (let ((class (early-method-class method)))
 889                           (or (eq class *the-class-standard-boundp-method*)
 890                               (eq class *the-class-global-boundp-method*)))
 891                         (or (standard-boundp-method-p method)
 892                             (global-boundp-method-p method))))
 893                   methods)
 894            'boundp)
 895           ((every (lambda (method)
 896                     (if (consp method)
 897                         (let ((class (early-method-class method)))
 898                           (or (eq class *the-class-standard-writer-method*)
 899                               (eq class *the-class-global-writer-method*)))
 900                         (and
 901                          (or (standard-writer-method-p method)
 902                              (global-writer-method-p method))
 903                          (not (safe-p
 904                                (slot-definition-class
 905                                 (accessor-method-slot-definition method)))))))
 906                   methods)
 907            'writer))))
 908
 909 (defun make-final-accessor-dfun (gf type &optional classes-list new-class)
 910   (with-eq-hash-table (table)
 911     (multiple-value-bind (table all-index first second size no-class-slots-p)
 912         (make-accessor-table gf type table)
 913       (if table
 914           (cond ((= size 1)
 915                  (let ((w (class-wrapper first)))
 916                    (make-one-class-accessor-dfun gf type w all-index)))
 917                 ((and (= size 2) (or (integerp all-index) (consp all-index)))
 918                  (let ((w0 (class-wrapper first))
 919                        (w1 (class-wrapper second)))
 920                    (make-two-class-accessor-dfun gf type w0 w1 all-index)))
 921                 ((or (integerp all-index) (consp all-index))
 922                  (make-final-one-index-accessor-dfun
 923                   gf type all-index table))
 924                 (no-class-slots-p
 925                  (make-final-n-n-accessor-dfun gf type table))
 926                 (t
 927                  (make-final-caching-dfun gf classes-list new-class)))
 928           (make-final-caching-dfun gf classes-list new-class)))))
 929
 930 (defun make-final-dfun-internal (gf &optional classes-list)
 931   (let ((methods (generic-function-methods gf)) type
 932         (new-class *new-class*) (*new-class* nil)
 933         specls all-same-p)
 934     (cond ((null methods)
 935            (values
 936             #'(lambda (&rest args)
 937                 (apply #'no-applicable-method gf args))
 938             nil
 939             (no-methods-dfun-info)))
 940           ((setq type (final-accessor-dfun-type gf))
 941            (make-final-accessor-dfun gf type classes-list new-class))
 942           ((and (not (and (every (lambda (specl) (eq specl *the-class-t*))
 943                                  (setq specls
 944                                        (method-specializers (car methods))))
 945                           (setq all-same-p
 946                                 (every (lambda (method)
 947                                          (and (equal specls
 948                                                      (method-specializers
 949                                                       method))))
 950                                        methods))))
 951                 (use-constant-value-dfun-p gf))
 952            (make-final-constant-value-dfun gf classes-list new-class))
 953           ((use-dispatch-dfun-p gf)
 954            (make-final-dispatch-dfun gf))
 955           ((and all-same-p (not (use-caching-dfun-p gf)))
 956            (let ((emf (get-secondary-dispatch-function gf methods nil)))
 957              (make-final-checking-dfun gf emf classes-list new-class)))
 958           (t
 959            (make-final-caching-dfun gf classes-list new-class)))))
 960
 961 (defvar *accessor-miss-history* nil)
 962
 963 (defun accessor-miss (gf new object dfun-info)
 964   (let ((wrapper (wrapper-of object))
 965         (previous-miss (assq gf *accessor-miss-history*)))
 966     (when (eq wrapper (cdr previous-miss))
 967       (error "~@<Vicious metacircle:  The computation of a ~
 968               dfun of ~s for argument ~s uses the dfun being ~
 969               computed.~@:>"
 970              gf object))
 971     (let* ((*accessor-miss-history* (acons gf wrapper *accessor-miss-history*))
 972            (ostate (type-of dfun-info))
 973            (otype (dfun-info-accessor-type dfun-info))
 974            oindex ow0 ow1 cache
 975            (args (ecase otype
 976                    ((reader boundp) (list object))
 977                    (writer (list new object)))))
 978       (dfun-miss (gf args wrappers invalidp nemf ntype nindex)
 979         ;; The following lexical functions change the state of the
 980         ;; dfun to that which is their name.  They accept arguments
 981         ;; which are the parameters of the new state, and get other
 982         ;; information from the lexical variables bound above.
 983         (flet ((two-class (index w0 w1)
 984                (when (zerop (random 2 *pcl-misc-random-state*))
 985                  (psetf w0 w1 w1 w0))
 986                (dfun-update gf
 987                             #'make-two-class-accessor-dfun
 988                             ntype
 989                             w0
 990                             w1
 991                             index))
 992              (one-index (index &optional cache)
 993                (dfun-update gf
 994                             #'make-one-index-accessor-dfun
 995                             ntype
 996                             index
 997                             cache))
 998              (n-n (&optional cache)
 999                (if (consp nindex)
1000                    (dfun-update gf #'make-checking-dfun nemf)
1001                    (dfun-update gf #'make-n-n-accessor-dfun ntype cache)))
1002              (caching () ; because cached accessor emfs are much faster
1003                          ; for accessors
1004                (dfun-update gf #'make-caching-dfun))
1005              (do-fill (update-fn)
1006                (let ((ncache (fill-cache cache wrappers nindex)))
1007                  (unless (eq ncache cache)
1008                    (funcall update-fn ncache)))))
1009
1010         (cond ((null ntype)
1011                (caching))
1012               ((or invalidp
1013                    (null nindex)))
1014               ((not (pcl-instance-p object))
1015                (caching))
1016               ((or (neq ntype otype) (listp wrappers))
1017                (caching))
1018               (t
1019                (ecase ostate
1020                  (one-class
1021                   (setq oindex (dfun-info-index dfun-info))
1022                   (setq ow0 (dfun-info-wrapper0 dfun-info))
1023                   (unless (eq ow0 wrappers)
1024                     (if (eql nindex oindex)
1025                         (two-class nindex ow0 wrappers)
1026                         (n-n))))
1027                  (two-class
1028                   (setq oindex (dfun-info-index dfun-info))
1029                   (setq ow0 (dfun-info-wrapper0 dfun-info))
1030                   (setq ow1 (dfun-info-wrapper1 dfun-info))
1031                   (unless (or (eq ow0 wrappers) (eq ow1 wrappers))
1032                     (if (eql nindex oindex)
1033                         (one-index nindex)
1034                         (n-n))))
1035                  (one-index
1036                   (setq oindex (dfun-info-index dfun-info))
1037                   (setq cache (dfun-info-cache dfun-info))
1038                   (if (eql nindex oindex)
1039                       (do-fill (lambda (ncache)
1040                                  (one-index nindex ncache)))
1041                       (n-n)))
1042                  (n-n
1043                   (setq cache (dfun-info-cache dfun-info))
1044                   (if (consp nindex)
1045                       (caching)
1046                       (do-fill #'n-n)))))))))))
1047
1048 (defun checking-miss (generic-function args dfun-info)
1049   (let ((oemf (dfun-info-function dfun-info))
1050         (cache (dfun-info-cache dfun-info)))
1051     (dfun-miss (generic-function args wrappers invalidp nemf)
1052       (cond (invalidp)
1053             ((eq oemf nemf)
1054              (let ((ncache (fill-cache cache wrappers nil)))
1055                (unless (eq ncache cache)
1056                  (dfun-update generic-function #'make-checking-dfun
1057                               nemf ncache))))
1058             (t
1059              (dfun-update generic-function #'make-caching-dfun))))))
1060
1061 (defun caching-miss (generic-function args dfun-info)
1062   (let ((ocache (dfun-info-cache dfun-info)))
1063     (dfun-miss (generic-function args wrappers invalidp emf nil nil t)
1064       (cond (invalidp)
1065             (t
1066              (let ((ncache (fill-cache ocache wrappers emf)))
1067                (unless (eq ncache ocache)
1068                  (dfun-update generic-function
1069                               #'make-caching-dfun ncache))))))))
1070
1071 (defun constant-value-miss (generic-function args dfun-info)
1072   (let ((ocache (dfun-info-cache dfun-info)))
1073     (dfun-miss (generic-function args wrappers invalidp emf nil nil t)
1074       (unless invalidp
1075         (let* ((value
1076                 (typecase emf
1077                   (constant-fast-method-call
1078                    (constant-fast-method-call-value emf))
1079                   (constant-method-call (constant-method-call-value emf))
1080                   (t (bug "~S with non-constant EMF ~S"
1081                           'constant-value-miss emf))))
1082                (ncache (fill-cache ocache wrappers value)))
1083           (unless (eq ncache ocache)
1084             (dfun-update generic-function
1085                          #'make-constant-value-dfun ncache)))))))
1086 \f
1087 ;;; Given a generic function and a set of arguments to that generic
1088 ;;; function, return a mess of values.
1089 ;;;
1090 ;;;  <function>   The compiled effective method function for this set of
1091 ;;;            arguments.
1092 ;;;
1093 ;;;  <applicable> Sorted list of applicable methods.
1094 ;;;
1095 ;;;  <wrappers>   Is a single wrapper if the generic function has only
1096 ;;;            one key, that is arg-info-nkeys of the arg-info is 1.
1097 ;;;            Otherwise a list of the wrappers of the specialized
1098 ;;;            arguments to the generic function.
1099 ;;;
1100 ;;;            Note that all these wrappers are valid. This function
1101 ;;;            does invalid wrapper traps when it finds an invalid
1102 ;;;            wrapper and then returns the new, valid wrapper.
1103 ;;;
1104 ;;;  <invalidp>   True if any of the specialized arguments had an invalid
1105 ;;;            wrapper, false otherwise.
1106 ;;;
1107 ;;;  <type>       READER or WRITER when the only method that would be run
1108 ;;;            is a standard reader or writer method. To be specific,
1109 ;;;            the value is READER when the method combination is eq to
1110 ;;;            *standard-method-combination*; there are no applicable
1111 ;;;            :before, :after or :around methods; and the most specific
1112 ;;;            primary method is a standard reader method.
1113 ;;;
1114 ;;;  <index>      If <type> is READER or WRITER, and the slot accessed is
1115 ;;;            an :instance slot, this is the index number of that slot
1116 ;;;            in the object argument.
1117 (defvar *cache-miss-values-stack* ())
1118
1119 (defun cache-miss-values (gf args state)
1120   (multiple-value-bind (nreq applyp metatypes nkeys arg-info)
1121       (get-generic-fun-info gf)
1122     (declare (ignore nreq applyp nkeys))
1123     (with-dfun-wrappers (args metatypes)
1124       (dfun-wrappers invalid-wrapper-p wrappers classes types)
1125       (error-need-at-least-n-args gf (length metatypes))
1126       (multiple-value-bind (emf methods accessor-type index)
1127           (cache-miss-values-internal
1128            gf arg-info wrappers classes types state)
1129         (values emf methods
1130                 dfun-wrappers
1131                 invalid-wrapper-p
1132                 accessor-type index)))))
1133
1134 (defun cache-miss-values-internal (gf arg-info wrappers classes types state)
1135   (if (and classes (equal classes (cdr (assq gf *cache-miss-values-stack*))))
1136       (break-vicious-metacircle gf classes arg-info)
1137       (let ((*cache-miss-values-stack*
1138              (acons gf classes *cache-miss-values-stack*))
1139             (cam-std-p (or (null arg-info)
1140                            (gf-info-c-a-m-emf-std-p arg-info))))
1141         (multiple-value-bind (methods all-applicable-and-sorted-p)
1142             (if cam-std-p
1143                 (compute-applicable-methods-using-types gf types)
1144                 (compute-applicable-methods-using-classes gf classes))
1145
1146   (let* ((for-accessor-p (eq state 'accessor))
1147          (for-cache-p (or (eq state 'caching) (eq state 'accessor)))
1148          (emf (if (or cam-std-p all-applicable-and-sorted-p)
1149                   (let ((generator
1150                          (get-secondary-dispatch-function1
1151                           gf methods types nil (and for-cache-p wrappers)
1152                           all-applicable-and-sorted-p)))
1153                     (make-callable gf methods generator
1154                                    nil (and for-cache-p wrappers)))
1155                   (default-secondary-dispatch-function gf))))
1156     (multiple-value-bind (index accessor-type)
1157         (and for-accessor-p all-applicable-and-sorted-p methods
1158              (accessor-values gf arg-info classes methods))
1159       (values (if (integerp index) index emf)
1160               methods accessor-type index)))))))
1161
1162 ;;; Try to break a vicious circle while computing a cache miss.
1163 ;;; GF is the generic function, CLASSES are the classes of actual
1164 ;;; arguments, and ARG-INFO is the generic functions' arg-info.
1165 ;;;
1166 ;;; A vicious circle can be entered when the computation of the cache
1167 ;;; miss values itself depends on the values being computed.  For
1168 ;;; instance, adding a method which is an instance of a subclass of
1169 ;;; STANDARD-METHOD leads to cache misses for slot accessors of
1170 ;;; STANDARD-METHOD like METHOD-SPECIALIZERS, and METHOD-SPECIALIZERS
1171 ;;; is itself used while we compute cache miss values.
1172 (defun break-vicious-metacircle (gf classes arg-info)
1173   (when (typep gf 'standard-generic-function)
1174     (multiple-value-bind (class slotd accessor-type)
1175         (accesses-standard-class-slot-p gf)
1176       (when class
1177         (let ((method (find-standard-class-accessor-method
1178                        gf class accessor-type))
1179               (index (standard-slot-value/eslotd slotd 'location))
1180               (type (gf-info-simple-accessor-type arg-info)))
1181           (when (and method
1182                      (subtypep (ecase accessor-type
1183                                  ((reader) (car classes))
1184                                  ((writer) (cadr classes)))
1185                                class))
1186             (return-from break-vicious-metacircle
1187               (values index (list method) type index)))))))
1188   (error "~@<vicious metacircle:  The computation of an ~
1189           effective method of ~s for arguments of types ~s uses ~
1190           the effective method being computed.~@:>"
1191          gf classes))
1192
1193 ;;; Return (CLASS SLOTD ACCESSOR-TYPE) if some method of generic
1194 ;;; function GF accesses a slot of some class in *STANDARD-CLASSES*.
1195 ;;; CLASS is the class accessed, SLOTD is the effective slot definition
1196 ;;; object of the slot accessed, and ACCESSOR-TYPE is one of the symbols
1197 ;;; READER or WRITER describing the slot access.
1198 (defun accesses-standard-class-slot-p (gf)
1199   (flet ((standard-class-slot-access (gf class)
1200            (loop with gf-name = (standard-slot-value/gf gf 'name)
1201                  for slotd in (standard-slot-value/class class 'slots)
1202                  ;; FIXME: where does BOUNDP fit in here?  Is it
1203                  ;; relevant?
1204                  as readers = (standard-slot-value/eslotd slotd 'readers)
1205                  as writers = (standard-slot-value/eslotd slotd 'writers)
1206                  if (member gf-name readers :test #'equal)
1207                    return (values slotd 'reader)
1208                  else if (member gf-name writers :test #'equal)
1209                    return (values slotd 'writer))))
1210     (dolist (class-name *standard-classes*)
1211       (let ((class (find-class class-name)))
1212         (multiple-value-bind (slotd accessor-type)
1213             (standard-class-slot-access gf class)
1214           (when slotd
1215             (return (values class slotd accessor-type))))))))
1216
1217 ;;; Find a slot reader/writer method among the methods of generic
1218 ;;; function GF which reads/writes instances of class CLASS.
1219 ;;; TYPE is one of the symbols READER or WRITER.
1220 (defun find-standard-class-accessor-method (gf class type)
1221   (let ((cpl (standard-slot-value/class class '%class-precedence-list))
1222         (found-specializer *the-class-t*)
1223         (found-method nil))
1224     (dolist (method (standard-slot-value/gf gf 'methods) found-method)
1225       (let ((specializers (standard-slot-value/method method 'specializers))
1226             (qualifiers (standard-slot-value/method method 'qualifiers)))
1227         (when (and (null qualifiers)
1228                    (let ((subcpl (member (ecase type
1229                                            (reader (car specializers))
1230                                            (writer (cadr specializers)))
1231                                          cpl)))
1232                      (and subcpl (member found-specializer subcpl))))
1233           (setf found-specializer (ecase type
1234                                     (reader (car specializers))
1235                                     (writer (cadr specializers))))
1236           (setf found-method method))))))
1237
1238 (defun accessor-values (gf arg-info classes methods)
1239   (declare (ignore gf))
1240   (let* ((accessor-type (gf-info-simple-accessor-type arg-info))
1241          (accessor-class (case accessor-type
1242                            ((reader boundp) (car classes))
1243                            (writer (cadr classes)))))
1244     (accessor-values-internal accessor-type accessor-class methods)))
1245
1246 (defun accessor-values1 (gf accessor-type accessor-class)
1247   (let* ((type `(class-eq ,accessor-class))
1248          (types (ecase accessor-type
1249                   ((reader boundp) `(,type))
1250                   (writer `(t ,type))))
1251          (methods (compute-applicable-methods-using-types gf types)))
1252     (accessor-values-internal accessor-type accessor-class methods)))
1253
1254 (defun accessor-values-internal (accessor-type accessor-class methods)
1255   (dolist (meth methods)
1256     (when (if (consp meth)
1257               (early-method-qualifiers meth)
1258               (safe-method-qualifiers meth))
1259       (return-from accessor-values-internal (values nil nil))))
1260   (let* ((meth (car methods))
1261          (early-p (not (eq *boot-state* 'complete)))
1262          (slot-name (when accessor-class
1263                       (if (consp meth)
1264                           (and (early-method-standard-accessor-p meth)
1265                                (early-method-standard-accessor-slot-name meth))
1266                           (and (member *the-class-standard-object*
1267                                        (if early-p
1268                                            (early-class-precedence-list
1269                                             accessor-class)
1270                                            (class-precedence-list
1271                                             accessor-class)))
1272                                (if early-p
1273                                    (not (eq *the-class-standard-method*
1274                                             (early-method-class meth)))
1275                                    (accessor-method-p meth))
1276                                (if early-p
1277                                    (early-accessor-method-slot-name meth)
1278                                    (accessor-method-slot-name meth))))))
1279          (slotd (and accessor-class
1280                      (if early-p
1281                          (dolist (slot (early-class-slotds accessor-class) nil)
1282                            (when (eql slot-name
1283                                       (early-slot-definition-name slot))
1284                              (return slot)))
1285                          (find-slot-definition accessor-class slot-name)))))
1286     (when (and slotd
1287                (or early-p
1288                    (slot-accessor-std-p slotd accessor-type))
1289                (or early-p
1290                    (not (safe-p accessor-class))))
1291       (values (if early-p
1292                   (early-slot-definition-location slotd)
1293                   (slot-definition-location slotd))
1294               accessor-type))))
1295
1296 (defun make-accessor-table (gf type &optional table)
1297   (unless table (setq table (make-hash-table :test 'eq)))
1298   (let ((methods (if (early-gf-p gf)
1299                      (early-gf-methods gf)
1300                      (generic-function-methods gf)))
1301         (all-index nil)
1302         (no-class-slots-p t)
1303         (early-p (not (eq *boot-state* 'complete)))
1304         first second (size 0))
1305     (declare (fixnum size))
1306     ;; class -> {(specl slotd)}
1307     (dolist (method methods)
1308       (let* ((specializers (if (consp method)
1309                                (early-method-specializers method t)
1310                                (method-specializers method)))
1311              (specl (ecase type
1312                       ((reader boundp) (car specializers))
1313                       (writer (cadr specializers))))
1314              (specl-cpl (if early-p
1315                             (early-class-precedence-list specl)
1316                             (and (class-finalized-p specl)
1317                                  (class-precedence-list specl))))
1318              (so-p (member *the-class-standard-object* specl-cpl))
1319              (slot-name (if (consp method)
1320                             (and (early-method-standard-accessor-p method)
1321                                  (early-method-standard-accessor-slot-name
1322                                   method))
1323                             (accessor-method-slot-name method))))
1324         (when (or (null specl-cpl)
1325                   (null so-p)
1326                   (member *the-class-structure-object* specl-cpl))
1327           (return-from make-accessor-table nil))
1328         ;; Collect all the slot-definitions for SLOT-NAME from SPECL and
1329         ;; all of its subclasses. If either SPECL or one of the subclasses
1330         ;; is not a standard-class, bail out.
1331         (labels ((aux (class)
1332                    ;; FIND-SLOT-DEFINITION might not be defined yet
1333                    (let ((slotd (find-if (lambda (x)
1334                                            (eq (sb-pcl::slot-definition-name x)
1335                                                slot-name))
1336                                          (sb-pcl::class-slots class))))
1337                      (when slotd
1338                        (unless (or early-p
1339                                    (slot-accessor-std-p slotd type))
1340                          (return-from make-accessor-table nil))
1341                        (push (cons specl slotd) (gethash class table))))
1342                    (dolist (subclass (sb-pcl::class-direct-subclasses class))
1343                      (aux subclass))))
1344           (aux specl))))
1345     (maphash (lambda (class specl+slotd-list)
1346                (dolist (sclass (if early-p
1347                                    (early-class-precedence-list class)
1348                                    (class-precedence-list class))
1349                                (error "This can't happen."))
1350                  (let ((a (assq sclass specl+slotd-list)))
1351                    (when a
1352                      (let* ((slotd (cdr a))
1353                             (index (if early-p
1354                                        (early-slot-definition-location slotd)
1355                                        (slot-definition-location slotd))))
1356                        (unless index (return-from make-accessor-table nil))
1357                        (setf (gethash class table) index)
1358                        (when (consp index) (setq no-class-slots-p nil))
1359                        (setq all-index (if (or (null all-index)
1360                                                (eql all-index index))
1361                                            index t))
1362                        (incf size)
1363                        (cond ((= size 1) (setq first class))
1364                              ((= size 2) (setq second class)))
1365                        (return nil))))))
1366              table)
1367     (values table all-index first second size no-class-slots-p)))
1368
1369 (defun compute-applicable-methods-using-types (generic-function types)
1370   (let ((definite-p t) (possibly-applicable-methods nil))
1371     (dolist (method (if (early-gf-p generic-function)
1372                         (early-gf-methods generic-function)
1373                         (safe-generic-function-methods generic-function)))
1374       (let ((specls (if (consp method)
1375                         (early-method-specializers method t)
1376                         (safe-method-specializers method)))
1377             (types types)
1378             (possibly-applicable-p t) (applicable-p t))
1379         (dolist (specl specls)
1380           (multiple-value-bind (specl-applicable-p specl-possibly-applicable-p)
1381               (specializer-applicable-using-type-p specl (pop types))
1382             (unless specl-applicable-p
1383               (setq applicable-p nil))
1384             (unless specl-possibly-applicable-p
1385               (setq possibly-applicable-p nil)
1386               (return nil))))
1387         (when possibly-applicable-p
1388           (unless applicable-p (setq definite-p nil))
1389           (push method possibly-applicable-methods))))
1390     (multiple-value-bind (nreq applyp metatypes nkeys arg-info)
1391         (get-generic-fun-info generic-function)
1392       (declare (ignore nreq applyp metatypes nkeys))
1393       (let* ((precedence (arg-info-precedence arg-info)))
1394         (values (sort-applicable-methods precedence
1395                                          (nreverse possibly-applicable-methods)
1396                                          types)
1397                 definite-p)))))
1398
1399 (defun sort-applicable-methods (precedence methods types)
1400   (sort-methods methods
1401                 precedence
1402                 (lambda (class1 class2 index)
1403                   (let* ((class (type-class (nth index types)))
1404                          (cpl (if (eq *boot-state* 'complete)
1405                                   (class-precedence-list class)
1406                                   (early-class-precedence-list class))))
1407                     (if (memq class2 (memq class1 cpl))
1408                         class1 class2)))))
1409
1410 (defun sort-methods (methods precedence compare-classes-function)
1411   (flet ((sorter (method1 method2)
1412            (dolist (index precedence)
1413              (let* ((specl1 (nth index (if (listp method1)
1414                                            (early-method-specializers method1
1415                                                                       t)
1416                                            (method-specializers method1))))
1417                     (specl2 (nth index (if (listp method2)
1418                                            (early-method-specializers method2
1419                                                                       t)
1420                                            (method-specializers method2))))
1421                     (order (order-specializers
1422                              specl1 specl2 index compare-classes-function)))
1423                (when order
1424                  (return-from sorter (eq order specl1)))))))
1425     (stable-sort methods #'sorter)))
1426
1427 (defun order-specializers (specl1 specl2 index compare-classes-function)
1428   (let ((type1 (if (eq *boot-state* 'complete)
1429                    (specializer-type specl1)
1430                    (!bootstrap-get-slot 'specializer specl1 '%type)))
1431         (type2 (if (eq *boot-state* 'complete)
1432                    (specializer-type specl2)
1433                    (!bootstrap-get-slot 'specializer specl2 '%type))))
1434     (cond ((eq specl1 specl2)
1435            nil)
1436           ((atom type1)
1437            specl2)
1438           ((atom type2)
1439            specl1)
1440           (t
1441            (case (car type1)
1442              (class    (case (car type2)
1443                          (class (funcall compare-classes-function
1444                                          specl1 specl2 index))
1445                          (t specl2)))
1446              (prototype (case (car type2)
1447                          (class (funcall compare-classes-function
1448                                          specl1 specl2 index))
1449                          (t specl2)))
1450              (class-eq (case (car type2)
1451                          (eql specl2)
1452                          (class-eq nil)
1453                          (class type1)))
1454              (eql      (case (car type2)
1455                          (eql nil)
1456                          (t specl1))))))))
1457
1458 (defun map-all-orders (methods precedence function)
1459   (let ((choices nil))
1460     (flet ((compare-classes-function (class1 class2 index)
1461              (declare (ignore index))
1462              (let ((choice nil))
1463                (dolist (c choices nil)
1464                  (when (or (and (eq (first c) class1)
1465                                 (eq (second c) class2))
1466                            (and (eq (first c) class2)
1467                                 (eq (second c) class1)))
1468                    (return (setq choice c))))
1469                (unless choice
1470                  (setq choice
1471                        (if (class-might-precede-p class1 class2)
1472                            (if (class-might-precede-p class2 class1)
1473                                (list class1 class2 nil t)
1474                                (list class1 class2 t))
1475                            (if (class-might-precede-p class2 class1)
1476                                (list class2 class1 t)
1477                                (let ((name1 (class-name class1))
1478                                      (name2 (class-name class2)))
1479                                  (if (and name1
1480                                           name2
1481                                           (symbolp name1)
1482                                           (symbolp name2)
1483                                           (string< (symbol-name name1)
1484                                                    (symbol-name name2)))
1485                                      (list class1 class2 t)
1486                                      (list class2 class1 t))))))
1487                  (push choice choices))
1488                (car choice))))
1489       (loop (funcall function
1490                      (sort-methods methods
1491                                    precedence
1492                                    #'compare-classes-function))
1493             (unless (dolist (c choices nil)
1494                       (unless (third c)
1495                         (rotatef (car c) (cadr c))
1496                         (return (setf (third c) t))))
1497               (return nil))))))
1498
1499 ;;; CMUCL comment: used only in map-all-orders
1500 (defun class-might-precede-p (class1 class2)
1501   (if (not *in-precompute-effective-methods-p*)
1502       (not (member class1 (cdr (class-precedence-list class2))))
1503       (class-can-precede-p class1 class2)))
1504
1505 (defun compute-precedence (lambda-list nreq argument-precedence-order)
1506   (if (null argument-precedence-order)
1507       (let ((list nil))
1508         (dotimes-fixnum (i nreq list) (push (- (1- nreq) i) list)))
1509       (mapcar (lambda (x) (position x lambda-list))
1510               argument-precedence-order)))
1511
1512 (defun cpl-or-nil (class)
1513   (if (eq *boot-state* 'complete)
1514       (progn
1515         ;; KLUDGE: why not use (slot-boundp class
1516         ;; 'class-precedence-list)?  Well, unfortunately, CPL-OR-NIL is
1517         ;; used within COMPUTE-APPLICABLE-METHODS, including for
1518         ;; SLOT-BOUNDP-USING-CLASS... and the available mechanism for
1519         ;; breaking such nasty cycles in effective method computation
1520         ;; only works for readers and writers, not boundps.  It might
1521         ;; not be too hard to make it work for BOUNDP accessors, but in
1522         ;; the meantime we use an extra slot for exactly the result of
1523         ;; the SLOT-BOUNDP that we want.  (We cannot use
1524         ;; CLASS-FINALIZED-P, because in the process of class
1525         ;; finalization we need to use the CPL which has been computed
1526         ;; to cache effective methods for slot accessors.) -- CSR,
1527         ;; 2004-09-19.
1528
1529         (when (cpl-available-p class)
1530           (return-from cpl-or-nil (class-precedence-list class)))
1531
1532         ;; if we can finalize an unfinalized class, then do so
1533         (when (and (not (class-finalized-p class))
1534                    (not (class-has-a-forward-referenced-superclass-p class)))
1535           (finalize-inheritance class)
1536           (class-precedence-list class)))
1537
1538       (early-class-precedence-list class)))
1539
1540 (defun saut-and (specl type)
1541   (let ((applicable nil)
1542         (possibly-applicable t))
1543     (dolist (type (cdr type))
1544       (multiple-value-bind (appl poss-appl)
1545           (specializer-applicable-using-type-p specl type)
1546         (when appl (return (setq applicable t)))
1547         (unless poss-appl (return (setq possibly-applicable nil)))))
1548     (values applicable possibly-applicable)))
1549
1550 (defun saut-not (specl type)
1551   (let ((ntype (cadr type)))
1552     (values nil
1553             (case (car ntype)
1554               (class      (saut-not-class specl ntype))
1555               (class-eq   (saut-not-class-eq specl ntype))
1556               (prototype  (saut-not-prototype specl ntype))
1557               (eql      (saut-not-eql specl ntype))
1558               (t (error "~S cannot handle the second argument ~S"
1559                         'specializer-applicable-using-type-p type))))))
1560
1561 (defun saut-not-class (specl ntype)
1562   (let* ((class (type-class specl))
1563          (cpl (cpl-or-nil class)))
1564     (not (memq (cadr ntype) cpl))))
1565
1566 (defun saut-not-prototype (specl ntype)
1567   (let* ((class (case (car specl)
1568                   (eql       (class-of (cadr specl)))
1569                   (class-eq  (cadr specl))
1570                   (prototype (cadr specl))
1571                   (class     (cadr specl))))
1572          (cpl (cpl-or-nil class)))
1573     (not (memq (cadr ntype) cpl))))
1574
1575 (defun saut-not-class-eq (specl ntype)
1576   (let ((class (case (car specl)
1577                  (eql      (class-of (cadr specl)))
1578                  (class-eq (cadr specl)))))
1579     (not (eq class (cadr ntype)))))
1580
1581 (defun saut-not-eql (specl ntype)
1582   (case (car specl)
1583     (eql (not (eql (cadr specl) (cadr ntype))))
1584     (t   t)))
1585
1586 (defun class-applicable-using-class-p (specl type)
1587   (let ((pred (memq specl (cpl-or-nil type))))
1588     (values pred
1589             (or pred
1590                 (if (not *in-precompute-effective-methods-p*)
1591                     ;; classes might get common subclass
1592                     (superclasses-compatible-p specl type)
1593                     ;; worry only about existing classes
1594                     (classes-have-common-subclass-p specl type))))))
1595
1596 (defun classes-have-common-subclass-p (class1 class2)
1597   (or (eq class1 class2)
1598       (let ((class1-subs (class-direct-subclasses class1)))
1599         (or (memq class2 class1-subs)
1600             (dolist (class1-sub class1-subs nil)
1601               (when (classes-have-common-subclass-p class1-sub class2)
1602                 (return t)))))))
1603
1604 (defun saut-class (specl type)
1605   (case (car specl)
1606     (class (class-applicable-using-class-p (cadr specl) (cadr type)))
1607     (t     (values nil (let ((class (type-class specl)))
1608                          (memq (cadr type)
1609                                (cpl-or-nil class)))))))
1610
1611 (defun saut-class-eq (specl type)
1612   (if (eq (car specl) 'eql)
1613       (values nil (eq (class-of (cadr specl)) (cadr type)))
1614       (let ((pred (case (car specl)
1615                     (class-eq
1616                      (eq (cadr specl) (cadr type)))
1617                     (class
1618                      (or (eq (cadr specl) (cadr type))
1619                          (memq (cadr specl) (cpl-or-nil (cadr type))))))))
1620         (values pred pred))))
1621
1622 (defun saut-prototype (specl type)
1623   (declare (ignore specl type))
1624   (values nil nil)) ; XXX original PCL comment: fix this someday
1625
1626 (defun saut-eql (specl type)
1627   (let ((pred (case (car specl)
1628                 (eql    (eql (cadr specl) (cadr type)))
1629                 (class-eq   (eq (cadr specl) (class-of (cadr type))))
1630                 (class      (memq (cadr specl)
1631                                   (let ((class (class-of (cadr type))))
1632                                     (cpl-or-nil class)))))))
1633     (values pred pred)))
1634
1635 (defun specializer-applicable-using-type-p (specl type)
1636   (setq specl (type-from-specializer specl))
1637   (when (eq specl t)
1638     (return-from specializer-applicable-using-type-p (values t t)))
1639   ;; This is used by C-A-M-U-T and GENERATE-DISCRIMINATION-NET-INTERNAL,
1640   ;; and has only what they need.
1641   (if (or (atom type) (eq (car type) t))
1642       (values nil t)
1643       (case (car type)
1644         (and    (saut-and specl type))
1645         (not    (saut-not specl type))
1646         (class      (saut-class specl type))
1647         (prototype  (saut-prototype specl type))
1648         (class-eq   (saut-class-eq specl type))
1649         (eql    (saut-eql specl type))
1650         (t        (error "~S cannot handle the second argument ~S."
1651                            'specializer-applicable-using-type-p
1652                            type)))))
1653
1654 (defun map-all-classes (fun &optional (root t))
1655   (let ((all-classes (make-hash-table :test 'eq))
1656         (braid-p (or (eq *boot-state* 'braid)
1657                      (eq *boot-state* 'complete))))
1658     (labels ((do-class (class)
1659                (unless (gethash class all-classes)
1660                  (setf (gethash class all-classes) t)
1661                  (funcall fun class)
1662                  (mapc #'do-class
1663                        (if braid-p
1664                            (class-direct-subclasses class)
1665                            (early-class-direct-subclasses class))))))
1666       (do-class (if (symbolp root)
1667                     (find-class root)
1668                     root)))
1669     nil))
1670 \f
1671 (defvar *effective-method-cache* (make-hash-table :test 'eq))
1672
1673 (defun flush-effective-method-cache (generic-function)
1674   (dolist (method (generic-function-methods generic-function))
1675     (remhash method *effective-method-cache*)))
1676
1677 (defun get-secondary-dispatch-function (gf methods types
1678                                         &optional method-alist wrappers)
1679   (let ((generator
1680          (get-secondary-dispatch-function1
1681           gf methods types (not (null method-alist)) (not (null wrappers))
1682           (not (methods-contain-eql-specializer-p methods)))))
1683     (make-callable gf methods generator method-alist wrappers)))
1684
1685 (defun get-secondary-dispatch-function1 (gf methods types method-alist-p
1686                                             wrappers-p
1687                                             &optional
1688                                             all-applicable-p
1689                                             (all-sorted-p t)
1690                                             function-p)
1691   (if (null methods)
1692       (if function-p
1693           (lambda (method-alist wrappers)
1694             (declare (ignore method-alist wrappers))
1695             #'(lambda (&rest args)
1696                 (apply #'no-applicable-method gf args)))
1697           (lambda (method-alist wrappers)
1698             (declare (ignore method-alist wrappers))
1699             (lambda (&rest args)
1700               (apply #'no-applicable-method gf args))))
1701       (let* ((key (car methods))
1702              (ht-value (or (gethash key *effective-method-cache*)
1703                            (setf (gethash key *effective-method-cache*)
1704                                  (cons nil nil)))))
1705         (if (and (null (cdr methods)) all-applicable-p ; the most common case
1706                  (null method-alist-p) wrappers-p (not function-p))
1707             (or (car ht-value)
1708                 (setf (car ht-value)
1709                       (get-secondary-dispatch-function2
1710                        gf methods types method-alist-p wrappers-p
1711                        all-applicable-p all-sorted-p function-p)))
1712             (let ((akey (list methods
1713                               (if all-applicable-p 'all-applicable types)
1714                               method-alist-p wrappers-p function-p)))
1715               (or (cdr (assoc akey (cdr ht-value) :test #'equal))
1716                   (let ((value (get-secondary-dispatch-function2
1717                                 gf methods types method-alist-p wrappers-p
1718                                 all-applicable-p all-sorted-p function-p)))
1719                     (push (cons akey value) (cdr ht-value))
1720                     value)))))))
1721
1722 (defun get-secondary-dispatch-function2 (gf methods types method-alist-p
1723                                             wrappers-p all-applicable-p
1724                                             all-sorted-p function-p)
1725   (if (and all-applicable-p all-sorted-p (not function-p))
1726       (if (eq *boot-state* 'complete)
1727           (let* ((combin (generic-function-method-combination gf))
1728                  (effective (compute-effective-method gf combin methods)))
1729             (make-effective-method-function1 gf effective method-alist-p
1730                                              wrappers-p))
1731           (let ((effective (standard-compute-effective-method gf nil methods)))
1732             (make-effective-method-function1 gf effective method-alist-p
1733                                              wrappers-p)))
1734       (let ((net (generate-discrimination-net
1735                   gf methods types all-sorted-p)))
1736         (compute-secondary-dispatch-function1 gf net function-p))))
1737
1738 (defun get-effective-method-function (gf methods
1739                                          &optional method-alist wrappers)
1740   (let ((generator
1741          (get-secondary-dispatch-function1
1742           gf methods nil (not (null method-alist)) (not (null wrappers)) t)))
1743     (make-callable gf methods generator method-alist wrappers)))
1744
1745 (defun get-effective-method-function1 (gf methods &optional (sorted-p t))
1746   (get-secondary-dispatch-function1 gf methods nil nil nil t sorted-p))
1747
1748 (defun methods-contain-eql-specializer-p (methods)
1749   (and (eq *boot-state* 'complete)
1750        (dolist (method methods nil)
1751          (when (dolist (spec (method-specializers method) nil)
1752                  (when (eql-specializer-p spec) (return t)))
1753            (return t)))))
1754 \f
1755 (defun update-dfun (generic-function &optional dfun cache info)
1756   (let* ((early-p (early-gf-p generic-function)))
1757     (set-dfun generic-function dfun cache info)
1758     (let ((dfun (if early-p
1759                     (or dfun (make-initial-dfun generic-function))
1760                     (compute-discriminating-function generic-function))))
1761       (set-funcallable-instance-function generic-function dfun)
1762       (let ((gf-name (if early-p
1763                          (!early-gf-name generic-function)
1764                          (generic-function-name generic-function))))
1765         (set-fun-name generic-function gf-name)
1766         dfun))))
1767 \f
1768 (defvar *dfun-count* nil)
1769 (defvar *dfun-list* nil)
1770 (defvar *minimum-cache-size-to-list*)
1771
1772 ;;; These functions aren't used in SBCL, or documented anywhere that
1773 ;;; I'm aware of, but they look like they might be useful for
1774 ;;; debugging or performance tweaking or something, so I've just
1775 ;;; commented them out instead of deleting them. -- WHN 2001-03-28
1776 #|
1777 (defun list-dfun (gf)
1778   (let* ((sym (type-of (gf-dfun-info gf)))
1779          (a (assq sym *dfun-list*)))
1780     (unless a
1781       (push (setq a (list sym)) *dfun-list*))
1782     (push (generic-function-name gf) (cdr a))))
1783
1784 (defun list-all-dfuns ()
1785   (setq *dfun-list* nil)
1786   (map-all-generic-functions #'list-dfun)
1787   *dfun-list*)
1788
1789 (defun list-large-cache (gf)
1790   (let* ((sym (type-of (gf-dfun-info gf)))
1791          (cache (gf-dfun-cache gf)))
1792     (when cache
1793       (let ((size (cache-size cache)))
1794         (when (>= size *minimum-cache-size-to-list*)
1795           (let ((a (assoc size *dfun-list*)))
1796             (unless a
1797               (push (setq a (list size)) *dfun-list*))
1798             (push (let ((name (generic-function-name gf)))
1799                     (if (eq sym 'caching) name (list name sym)))
1800                   (cdr a))))))))
1801
1802 (defun list-large-caches (&optional (*minimum-cache-size-to-list* 130))
1803   (setq *dfun-list* nil)
1804   (map-all-generic-functions #'list-large-cache)
1805   (setq *dfun-list* (sort *dfun-list* #'< :key #'car))
1806   (mapc #'print *dfun-list*)
1807   (values))
1808
1809 (defun count-dfun (gf)
1810   (let* ((sym (type-of (gf-dfun-info gf)))
1811          (cache (gf-dfun-cache gf))
1812          (a (assq sym *dfun-count*)))
1813     (unless a
1814       (push (setq a (list sym 0 nil)) *dfun-count*))
1815     (incf (cadr a))
1816     (when cache
1817       (let* ((size (cache-size cache))
1818              (b (assoc size (third a))))
1819         (unless b
1820           (push (setq b (cons size 0)) (third a)))
1821         (incf (cdr b))))))
1822
1823 (defun count-all-dfuns ()
1824   (setq *dfun-count* (mapcar (lambda (type) (list type 0 nil))
1825                              '(ONE-CLASS TWO-CLASS DEFAULT-METHOD-ONLY
1826                                ONE-INDEX N-N CHECKING CACHING
1827                                DISPATCH)))
1828   (map-all-generic-functions #'count-dfun)
1829   (mapc (lambda (type+count+sizes)
1830           (setf (third type+count+sizes)
1831                 (sort (third type+count+sizes) #'< :key #'car)))
1832         *dfun-count*)
1833   (mapc (lambda (type+count+sizes)
1834           (format t "~&There are ~W dfuns of type ~S."
1835                   (cadr type+count+sizes) (car type+count+sizes))
1836           (format t "~%   ~S~%" (caddr type+count+sizes)))
1837         *dfun-count*)
1838   (values))
1839 |#
1840
1841 (defun gfs-of-type (type)
1842   (unless (consp type) (setq type (list type)))
1843   (let ((gf-list nil))
1844     (map-all-generic-functions (lambda (gf)
1845                                  (when (memq (type-of (gf-dfun-info gf))
1846                                              type)
1847                                    (push gf gf-list))))
1848     gf-list))