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   (let ((metatypes (arg-info-metatypes (gf-arg-info generic-function))))
 474     (if (every (lambda (mt) (eq mt t)) metatypes)
 475         (values (lambda (&rest args)
 476                   (invoke-emf function args))
 477                 nil (default-method-only-dfun-info))
 478         (let ((cache (make-final-ordinary-dfun-internal
 479                       generic-function nil #'checking-limit-fn
 480                       classes-list new-class)))
 481           (make-checking-dfun generic-function function cache)))))
 482
 483 (defun use-default-method-only-dfun-p (generic-function)
 484   (multiple-value-bind (nreq applyp metatypes nkeys)
 485       (get-generic-fun-info generic-function)
 486     (declare (ignore nreq applyp nkeys))
 487     (every (lambda (mt) (eq mt t)) metatypes)))
 488
 489 (defun use-caching-dfun-p (generic-function)
 490   (some (lambda (method)
 491           (let ((fmf (if (listp method)
 492                          (third method)
 493                          (method-fast-function method))))
 494             (method-function-get fmf :slot-name-lists)))
 495         ;; KLUDGE: As of sbcl-0.6.4, it's very important for
 496         ;; efficiency to know the type of the sequence argument to
 497         ;; quantifiers (SOME/NOTANY/etc.) at compile time, but
 498         ;; the compiler isn't smart enough to understand the :TYPE
 499         ;; slot option for DEFCLASS, so we just tell
 500         ;; it the type by hand here.
 501         (the list
 502              (if (early-gf-p generic-function)
 503                  (early-gf-methods generic-function)
 504                  (generic-function-methods generic-function)))))
 505
 506 (defun checking-limit-fn (nlines)
 507   (default-limit-fn nlines))
 508 \f
 509 (defun make-caching-dfun (generic-function &optional cache)
 510   (unless cache
 511     (when (use-constant-value-dfun-p generic-function)
 512       (return-from make-caching-dfun
 513         (make-constant-value-dfun generic-function)))
 514     (when (use-dispatch-dfun-p generic-function)
 515       (return-from make-caching-dfun
 516         (make-dispatch-dfun generic-function))))
 517   (multiple-value-bind (nreq applyp metatypes nkeys)
 518       (get-generic-fun-info generic-function)
 519     (declare (ignore nreq))
 520     (let* ((cache (or cache (get-cache nkeys t #'caching-limit-fn 2)))
 521            (dfun-info (caching-dfun-info cache)))
 522       (values
 523        (funcall (get-dfun-constructor 'emit-caching metatypes applyp)
 524                 cache
 525                 (lambda (&rest args)
 526                   (caching-miss generic-function args dfun-info)))
 527        cache
 528        dfun-info))))
 529
 530 (defun make-final-caching-dfun (generic-function classes-list new-class)
 531   (let ((cache (make-final-ordinary-dfun-internal
 532                 generic-function t #'caching-limit-fn
 533                 classes-list new-class)))
 534     (make-caching-dfun generic-function cache)))
 535
 536 (defun caching-limit-fn (nlines)
 537   (default-limit-fn nlines))
 538
 539 (defun insure-caching-dfun (gf)
 540   (multiple-value-bind (nreq applyp metatypes nkeys)
 541       (get-generic-fun-info gf)
 542     (declare (ignore nreq nkeys))
 543     (when (and metatypes
 544                (not (null (car metatypes)))
 545                (dolist (mt metatypes nil)
 546                  (unless (eq mt t) (return t))))
 547       (get-dfun-constructor 'emit-caching metatypes applyp))))
 548
 549 (defun use-constant-value-dfun-p (gf &optional boolean-values-p)
 550   (multiple-value-bind (nreq applyp metatypes nkeys)
 551       (get-generic-fun-info gf)
 552     (declare (ignore nreq metatypes nkeys))
 553     (let* ((early-p (early-gf-p gf))
 554            (methods (if early-p
 555                         (early-gf-methods gf)
 556                         (generic-function-methods gf)))
 557            (default '(unknown)))
 558       (and (null applyp)
 559            (or (not (eq *boot-state* 'complete))
 560                ;; If COMPUTE-APPLICABLE-METHODS is specialized, we
 561                ;; can't use this, of course, because we can't tell
 562                ;; which methods will be considered applicable.
 563                ;;
 564                ;; Also, don't use this dfun method if the generic
 565                ;; function has a non-standard method combination,
 566                ;; because if it has, it's not sure that method
 567                ;; functions are used directly as effective methods,
 568                ;; which CONSTANT-VALUE-MISS depends on.  The
 569                ;; pre-defined method combinations like LIST are
 570                ;; examples of that.
 571                (and (compute-applicable-methods-emf-std-p gf)
 572                     (eq (generic-function-method-combination gf)
 573                         *standard-method-combination*)))
 574            ;; Check that no method is eql-specialized, and that all
 575            ;; methods return a constant value.  If BOOLEAN-VALUES-P,
 576            ;; check that all return T or NIL.  Also, check that no
 577            ;; method has qualifiers, to make sure that emfs are really
 578            ;; method functions; see above.
 579            (dolist (method methods t)
 580              (when (eq *boot-state* 'complete)
 581                (when (or (some #'eql-specializer-p
 582                                (method-specializers method))
 583                          (method-qualifiers method))
 584                  (return nil)))
 585              (let ((value (method-function-get
 586                            (if early-p
 587                                (or (third method) (second method))
 588                                (or (method-fast-function method)
 589                                    (method-function method)))
 590                            :constant-value default)))
 591                (when (or (eq value default)
 592                          (and boolean-values-p
 593                               (not (member value '(t nil)))))
 594                  (return nil))))))))
 595
 596 (defun make-constant-value-dfun (generic-function &optional cache)
 597   (multiple-value-bind (nreq applyp metatypes nkeys)
 598       (get-generic-fun-info generic-function)
 599     (declare (ignore nreq applyp))
 600     (let* ((cache (or cache (get-cache nkeys t #'caching-limit-fn 2)))
 601            (dfun-info (constant-value-dfun-info cache)))
 602       (values
 603        (funcall (get-dfun-constructor 'emit-constant-value metatypes)
 604                 cache
 605                 (lambda (&rest args)
 606                   (constant-value-miss generic-function args dfun-info)))
 607        cache
 608        dfun-info))))
 609
 610 (defun make-final-constant-value-dfun (generic-function classes-list new-class)
 611   (let ((cache (make-final-ordinary-dfun-internal
 612                 generic-function :constant-value #'caching-limit-fn
 613                 classes-list new-class)))
 614     (make-constant-value-dfun generic-function cache)))
 615
 616 (defun use-dispatch-dfun-p (gf &optional (caching-p (use-caching-dfun-p gf)))
 617   (when (eq *boot-state* 'complete)
 618     (unless (or caching-p (gf-requires-emf-keyword-checks gf))
 619       ;; This should return T when almost all dispatching is by
 620       ;; eql specializers or built-in classes. In other words,
 621       ;; return NIL if we might ever need to do more than
 622       ;; one (non built-in) typep.
 623       ;; Otherwise, it is probably at least as fast to use
 624       ;; a caching dfun first, possibly followed by secondary dispatching.
 625
 626       #||;;; Original found in cmu 17f -- S L O W
 627       (< (dispatch-dfun-cost gf) (caching-dfun-cost gf))
 628       ||#
 629       ;; This uses improved dispatch-dfun-cost below
 630       (let ((cdc  (caching-dfun-cost gf))) ; fast
 631         (> cdc (dispatch-dfun-cost gf cdc))))))
 632
 633 (defparameter *non-built-in-typep-cost* 1)
 634 (defparameter *structure-typep-cost* 1)
 635 (defparameter *built-in-typep-cost* 0)
 636
 637 ;;; According to comments in the original CMU CL version of PCL,
 638 ;;; the cost LIMIT is important to cut off exponential growth for
 639 ;;; large numbers of gf methods and argument lists.
 640 (defun dispatch-dfun-cost (gf &optional limit)
 641   (generate-discrimination-net-internal
 642    gf (generic-function-methods gf) nil
 643    (lambda (methods known-types)
 644      (declare (ignore methods known-types))
 645      0)
 646    (lambda (position type true-value false-value)
 647      (declare (ignore position))
 648      (let* ((type-test-cost
 649              (if (eq 'class (car type))
 650                  (let* ((metaclass (class-of (cadr type)))
 651                         (mcpl (class-precedence-list metaclass)))
 652                    (cond ((memq *the-class-built-in-class* mcpl)
 653                           *built-in-typep-cost*)
 654                          ((memq *the-class-structure-class* mcpl)
 655                           *structure-typep-cost*)
 656                          (t
 657                           *non-built-in-typep-cost*)))
 658                  0))
 659             (max-cost-so-far
 660              (+ (max true-value false-value) type-test-cost)))
 661        (when (and limit (<= limit max-cost-so-far))
 662          (return-from dispatch-dfun-cost max-cost-so-far))
 663        max-cost-so-far))
 664    #'identity))
 665
 666 (defparameter *cache-lookup-cost* 1)
 667 (defparameter *wrapper-of-cost* 0)
 668 (defparameter *secondary-dfun-call-cost* 1)
 669
 670 (defun caching-dfun-cost (gf)
 671   (let* ((arg-info (gf-arg-info gf))
 672          (nreq (length (arg-info-metatypes arg-info))))
 673     (+ *cache-lookup-cost*
 674        (* *wrapper-of-cost* nreq)
 675        (if (methods-contain-eql-specializer-p
 676             (generic-function-methods gf))
 677            *secondary-dfun-call-cost*
 678            0))))
 679
 680 (setq *non-built-in-typep-cost* 100)
 681 (setq *structure-typep-cost* 15)
 682 (setq *built-in-typep-cost* 5)
 683 (setq *cache-lookup-cost* 30)
 684 (setq *wrapper-of-cost* 15)
 685 (setq *secondary-dfun-call-cost* 30)
 686
 687 (declaim (inline make-callable))
 688 (defun make-callable (gf methods generator method-alist wrappers)
 689   (let* ((*applicable-methods* methods)
 690          (callable (function-funcall generator method-alist wrappers)))
 691     callable))
 692
 693 (defun make-dispatch-dfun (gf)
 694   (values (get-dispatch-function gf) nil (dispatch-dfun-info)))
 695
 696 (defun get-dispatch-function (gf)
 697   (let* ((methods (generic-function-methods gf))
 698          (generator (get-secondary-dispatch-function1
 699                      gf methods nil nil nil nil nil t)))
 700     (make-callable gf methods generator nil nil)))
 701
 702 (defun make-final-dispatch-dfun (gf)
 703   (make-dispatch-dfun gf))
 704
 705 (defun update-dispatch-dfuns ()
 706   (dolist (gf (gfs-of-type '(dispatch initial-dispatch)))
 707     (dfun-update gf #'make-dispatch-dfun)))
 708
 709 (defun fill-dfun-cache (table valuep nkeys limit-fn &optional cache)
 710   (let ((cache (or cache (get-cache nkeys valuep limit-fn
 711                                     (+ (hash-table-count table) 3)))))
 712     (maphash (lambda (classes value)
 713                (setq cache (fill-cache cache
 714                                        (class-wrapper classes)
 715                                        value)))
 716              table)
 717     cache))
 718
 719 (defun make-final-ordinary-dfun-internal (generic-function valuep limit-fn
 720                                                            classes-list new-class)
 721   (let* ((arg-info (gf-arg-info generic-function))
 722          (nkeys (arg-info-nkeys arg-info))
 723          (new-class (and new-class
 724                          (equal (type-of (gf-dfun-info generic-function))
 725                                 (cond ((eq valuep t) 'caching)
 726                                       ((eq valuep :constant-value) 'constant-value)
 727                                       ((null valuep) 'checking)))
 728                          new-class))
 729          (cache (if new-class
 730                     (copy-cache (gf-dfun-cache generic-function))
 731                     (get-cache nkeys (not (null valuep)) limit-fn 4))))
 732       (make-emf-cache generic-function valuep cache classes-list new-class)))
 733 \f
 734 (defvar *dfun-miss-gfs-on-stack* ())
 735
 736 (defmacro dfun-miss ((gf args wrappers invalidp nemf
 737                       &optional type index caching-p applicable)
 738                      &body body)
 739   (unless applicable (setq applicable (gensym)))
 740   `(multiple-value-bind (,nemf ,applicable ,wrappers ,invalidp
 741                          ,@(when type `(,type ,index)))
 742        (cache-miss-values ,gf ,args ',(cond (caching-p 'caching)
 743                                             (type 'accessor)
 744                                             (t 'checking)))
 745     (when (and ,applicable (not (memq ,gf *dfun-miss-gfs-on-stack*)))
 746       (let ((*dfun-miss-gfs-on-stack* (cons ,gf *dfun-miss-gfs-on-stack*)))
 747         ,@body))
 748     ;; Create a FAST-INSTANCE-BOUNDP structure instance for a cached
 749     ;; SLOT-BOUNDP so that INVOKE-EMF does the right thing, that is,
 750     ;; does not signal a SLOT-UNBOUND error for a boundp test.
 751     ,@(if type
 752           ;; FIXME: could the NEMF not be a CONS (for :CLASS-allocated
 753           ;; slots?)
 754           `((if (and (eq ,type 'boundp) (integerp ,nemf))
 755                 (invoke-emf (make-fast-instance-boundp :index ,nemf) ,args)
 756                 (invoke-emf ,nemf ,args)))
 757           `((invoke-emf ,nemf ,args)))))
 758
 759 ;;; The dynamically adaptive method lookup algorithm is implemented is
 760 ;;; implemented as a kind of state machine. The kinds of
 761 ;;; discriminating function is the state, the various kinds of reasons
 762 ;;; for a cache miss are the state transitions.
 763 ;;;
 764 ;;; The code which implements the transitions is all in the miss
 765 ;;; handlers for each kind of dfun. Those appear here.
 766 ;;;
 767 ;;; Note that within the states that cache, there are dfun updates
 768 ;;; which simply select a new cache or cache field. Those are not
 769 ;;; considered as state transitions.
 770 (defvar *lazy-dfun-compute-p* t)
 771 (defvar *early-p* nil)
 772
 773 (declaim (type (or null unsigned-byte) *max-emf-precomputation-methods*))
 774 (defvar *max-emf-precomputation-methods* nil)
 775
 776 (defun finalize-specializers (gf)
 777   (let ((methods (generic-function-methods gf)))
 778     (when (or (null *max-emf-precomputation-methods*)
 779               (<= (length methods) *max-emf-precomputation-methods*))
 780       (let ((all-finalized t))
 781         (dolist (method methods all-finalized)
 782           (dolist (specializer (method-specializers method))
 783             (when (and (classp specializer)
 784                        (not (class-finalized-p specializer)))
 785               (if (class-has-a-forward-referenced-superclass-p specializer)
 786                   (setq all-finalized nil)
 787                   (finalize-inheritance specializer)))))))))
 788
 789 (defun make-initial-dfun (gf)
 790   (let ((initial-dfun
 791          #'(instance-lambda (&rest args)
 792              (initial-dfun gf args))))
 793     (multiple-value-bind (dfun cache info)
 794         (cond
 795           ((and (eq *boot-state* 'complete)
 796                 (not (finalize-specializers gf)))
 797            (values initial-dfun nil (initial-dfun-info)))
 798           ((and (eq *boot-state* 'complete)
 799                 (compute-applicable-methods-emf-std-p gf))
 800            (let* ((caching-p (use-caching-dfun-p gf))
 801                   ;; KLUDGE: the only effect of this (when
 802                   ;; *LAZY-DFUN-COMPUTE-P* is true, as it usually is)
 803                   ;; is to signal an error when we try to add methods
 804                   ;; with the wrong qualifiers to a generic function.
 805                   (classes-list (precompute-effective-methods
 806                                  gf caching-p
 807                                  (not *lazy-dfun-compute-p*))))
 808              (if *lazy-dfun-compute-p*
 809                  (cond ((use-dispatch-dfun-p gf caching-p)
 810                         (values initial-dfun
 811                                 nil
 812                                 (initial-dispatch-dfun-info)))
 813                        (caching-p
 814                         (insure-caching-dfun gf)
 815                         (values initial-dfun nil (initial-dfun-info)))
 816                        (t
 817                         (values initial-dfun nil (initial-dfun-info))))
 818                  (make-final-dfun-internal gf classes-list))))
 819           (t
 820            (let ((arg-info (if (early-gf-p gf)
 821                                (early-gf-arg-info gf)
 822                                (gf-arg-info gf)))
 823                  (type nil))
 824              (if (and (gf-precompute-dfun-and-emf-p arg-info)
 825                       (setq type (final-accessor-dfun-type gf)))
 826                  (if *early-p*
 827                      (values (make-early-accessor gf type) nil nil)
 828                      (make-final-accessor-dfun gf type))
 829                  (values initial-dfun nil (initial-dfun-info))))))
 830       (set-dfun gf dfun cache info))))
 831
 832 (defun make-early-accessor (gf type)
 833   (let* ((methods (early-gf-methods gf))
 834          (slot-name (early-method-standard-accessor-slot-name (car methods))))
 835     (ecase type
 836       (reader #'(instance-lambda (instance)
 837                   (let* ((class (class-of instance))
 838                          (class-name (!bootstrap-get-slot 'class class 'name)))
 839                     (!bootstrap-get-slot class-name instance slot-name))))
 840       (boundp #'(instance-lambda (instance)
 841                   (let* ((class (class-of instance))
 842                          (class-name (!bootstrap-get-slot 'class class 'name)))
 843                     (not (eq +slot-unbound+
 844                              (!bootstrap-get-slot class-name
 845                                                   instance slot-name))))))
 846       (writer #'(instance-lambda (new-value instance)
 847                   (let* ((class (class-of instance))
 848                          (class-name (!bootstrap-get-slot 'class class 'name)))
 849                     (!bootstrap-set-slot class-name instance slot-name new-value)))))))
 850
 851 (defun initial-dfun (gf args)
 852   (dfun-miss (gf args wrappers invalidp nemf ntype nindex)
 853     (cond (invalidp)
 854           ((and ntype nindex)
 855            (dfun-update
 856             gf #'make-one-class-accessor-dfun ntype wrappers nindex))
 857           ((use-caching-dfun-p gf)
 858            (dfun-update gf #'make-caching-dfun))
 859           (t
 860            (dfun-update
 861             gf #'make-checking-dfun
 862             ;; nemf is suitable only for caching, have to do this:
 863             (cache-miss-values gf args 'checking))))))
 864
 865 (defun make-final-dfun (gf &optional classes-list)
 866   (multiple-value-bind (dfun cache info)
 867       (make-final-dfun-internal gf classes-list)
 868     (set-dfun gf dfun cache info)))
 869
 870 (defvar *new-class* nil)
 871
 872 (defvar *free-hash-tables* (mapcar #'list '(eq equal eql)))
 873
 874 (defmacro with-hash-table ((table test) &body forms)
 875   `(let* ((.free. (assoc ',test *free-hash-tables*))
 876           (,table (if (cdr .free.)
 877                       (pop (cdr .free.))
 878                       (make-hash-table :test ',test))))
 879      (multiple-value-prog1
 880          (progn ,@forms)
 881        (clrhash ,table)
 882        (push ,table (cdr .free.)))))
 883
 884 (defmacro with-eq-hash-table ((table) &body forms)
 885   `(with-hash-table (,table eq) ,@forms))
 886
 887 (defun final-accessor-dfun-type (gf)
 888   (let ((methods (if (early-gf-p gf)
 889                      (early-gf-methods gf)
 890                      (generic-function-methods gf))))
 891     (cond ((every (lambda (method)
 892                     (if (consp method)
 893                         (eq *the-class-standard-reader-method*
 894                             (early-method-class method))
 895                         (standard-reader-method-p method)))
 896                   methods)
 897            'reader)
 898           ((every (lambda (method)
 899                     (if (consp method)
 900                         (eq *the-class-standard-boundp-method*
 901                             (early-method-class method))
 902                         (standard-boundp-method-p method)))
 903                   methods)
 904            'boundp)
 905           ((every (lambda (method)
 906                     (if (consp method)
 907                         (eq *the-class-standard-writer-method*
 908                             (early-method-class method))
 909                         (standard-writer-method-p method)))
 910                   methods)
 911            'writer))))
 912
 913 (defun make-final-accessor-dfun (gf type &optional classes-list new-class)
 914   (with-eq-hash-table (table)
 915     (multiple-value-bind (table all-index first second size no-class-slots-p)
 916         (make-accessor-table gf type table)
 917       (if table
 918           (cond ((= size 1)
 919                  (let ((w (class-wrapper first)))
 920                    (make-one-class-accessor-dfun gf type w all-index)))
 921                 ((and (= size 2) (or (integerp all-index) (consp all-index)))
 922                  (let ((w0 (class-wrapper first))
 923                        (w1 (class-wrapper second)))
 924                    (make-two-class-accessor-dfun gf type w0 w1 all-index)))
 925                 ((or (integerp all-index) (consp all-index))
 926                  (make-final-one-index-accessor-dfun
 927                   gf type all-index table))
 928                 (no-class-slots-p
 929                  (make-final-n-n-accessor-dfun gf type table))
 930                 (t
 931                  (make-final-caching-dfun gf classes-list new-class)))
 932           (make-final-caching-dfun gf classes-list new-class)))))
 933
 934 (defun make-final-dfun-internal (gf &optional classes-list)
 935   (let ((methods (generic-function-methods gf)) type
 936         (new-class *new-class*) (*new-class* nil)
 937         specls all-same-p)
 938     (cond ((null methods)
 939            (values
 940             #'(instance-lambda (&rest args)
 941                 (apply #'no-applicable-method gf args))
 942             nil
 943             (no-methods-dfun-info)))
 944           ((setq type (final-accessor-dfun-type gf))
 945            (make-final-accessor-dfun gf type classes-list new-class))
 946           ((and (not (and (every (lambda (specl) (eq specl *the-class-t*))
 947                                  (setq specls
 948                                        (method-specializers (car methods))))
 949                           (setq all-same-p
 950                                 (every (lambda (method)
 951                                          (and (equal specls
 952                                                      (method-specializers
 953                                                       method))))
 954                                        methods))))
 955                 (use-constant-value-dfun-p gf))
 956            (make-final-constant-value-dfun gf classes-list new-class))
 957           ((use-dispatch-dfun-p gf)
 958            (make-final-dispatch-dfun gf))
 959           ((and all-same-p (not (use-caching-dfun-p gf)))
 960            (let ((emf (get-secondary-dispatch-function gf methods nil)))
 961              (make-final-checking-dfun gf emf classes-list new-class)))
 962           (t
 963            (make-final-caching-dfun gf classes-list new-class)))))
 964
 965 (defun accessor-miss (gf new object dfun-info)
 966   (let* ((ostate (type-of dfun-info))
 967          (otype (dfun-info-accessor-type dfun-info))
 968          oindex ow0 ow1 cache
 969          (args (ecase otype
 970                  ;; The congruence rules ensure that this is safe
 971                  ;; despite not knowing the new type yet.
 972                  ((reader boundp) (list object))
 973                  (writer (list new object)))))
 974     (dfun-miss (gf args wrappers invalidp nemf ntype nindex)
 975
 976       ;; The following lexical functions change the state of the
 977       ;; dfun to that which is their name. They accept arguments
 978       ;; which are the parameters of the new state, and get other
 979       ;; information from the lexical variables bound above.
 980       (flet ((two-class (index w0 w1)
 981                (when (zerop (random 2)) (psetf w0 w1 w1 w0))
 982                (dfun-update gf
 983                             #'make-two-class-accessor-dfun
 984                             ntype
 985                             w0
 986                             w1
 987                             index))
 988              (one-index (index &optional cache)
 989                (dfun-update gf
 990                             #'make-one-index-accessor-dfun
 991                             ntype
 992                             index
 993                             cache))
 994              (n-n (&optional cache)
 995                (if (consp nindex)
 996                    (dfun-update gf #'make-checking-dfun nemf)
 997                    (dfun-update gf #'make-n-n-accessor-dfun ntype cache)))
 998              (caching () ; because cached accessor emfs are much faster
 999                          ; for accessors
1000                (dfun-update gf #'make-caching-dfun))
1001              (do-fill (update-fn)
1002                (let ((ncache (fill-cache cache wrappers nindex)))
1003                  (unless (eq ncache cache)
1004                    (funcall update-fn ncache)))))
1005
1006         (cond ((null ntype)
1007                (caching))
1008               ((or invalidp
1009                    (null nindex)))
1010               ((not (pcl-instance-p object))
1011                (caching))
1012               ((or (neq ntype otype) (listp wrappers))
1013                (caching))
1014               (t
1015                (ecase ostate
1016                  (one-class
1017                   (setq oindex (dfun-info-index dfun-info))
1018                   (setq ow0 (dfun-info-wrapper0 dfun-info))
1019                   (unless (eq ow0 wrappers)
1020                     (if (eql nindex oindex)
1021                         (two-class nindex ow0 wrappers)
1022                         (n-n))))
1023                  (two-class
1024                   (setq oindex (dfun-info-index dfun-info))
1025                   (setq ow0 (dfun-info-wrapper0 dfun-info))
1026                   (setq ow1 (dfun-info-wrapper1 dfun-info))
1027                   (unless (or (eq ow0 wrappers) (eq ow1 wrappers))
1028                     (if (eql nindex oindex)
1029                         (one-index nindex)
1030                         (n-n))))
1031                  (one-index
1032                   (setq oindex (dfun-info-index dfun-info))
1033                   (setq cache (dfun-info-cache dfun-info))
1034                   (if (eql nindex oindex)
1035                       (do-fill (lambda (ncache)
1036                                  (one-index nindex ncache)))
1037                       (n-n)))
1038                  (n-n
1039                   (setq cache (dfun-info-cache dfun-info))
1040                   (if (consp nindex)
1041                       (caching)
1042                       (do-fill #'n-n))))))))))
1043
1044 (defun checking-miss (generic-function args dfun-info)
1045   (let ((oemf (dfun-info-function dfun-info))
1046         (cache (dfun-info-cache dfun-info)))
1047     (dfun-miss (generic-function args wrappers invalidp nemf)
1048       (cond (invalidp)
1049             ((eq oemf nemf)
1050              (let ((ncache (fill-cache cache wrappers nil)))
1051                (unless (eq ncache cache)
1052                  (dfun-update generic-function #'make-checking-dfun
1053                               nemf ncache))))
1054             (t
1055              (dfun-update generic-function #'make-caching-dfun))))))
1056
1057 (defun caching-miss (generic-function args dfun-info)
1058   (let ((ocache (dfun-info-cache dfun-info)))
1059     (dfun-miss (generic-function args wrappers invalidp emf nil nil t)
1060       (cond (invalidp)
1061             (t
1062              (let ((ncache (fill-cache ocache wrappers emf)))
1063                (unless (eq ncache ocache)
1064                  (dfun-update generic-function
1065                               #'make-caching-dfun ncache))))))))
1066
1067 (defun constant-value-miss (generic-function args dfun-info)
1068   (let ((ocache (dfun-info-cache dfun-info)))
1069     (dfun-miss (generic-function args wrappers invalidp emf nil nil t)
1070       (unless invalidp
1071         (let* ((function
1072                 (typecase emf
1073                   (fast-method-call (fast-method-call-function emf))
1074                   (method-call (method-call-function emf))))
1075                (value (let ((val (method-function-get
1076                                   function :constant-value '.not-found.)))
1077                         (aver (not (eq val '.not-found.)))
1078                         val))
1079                (ncache (fill-cache ocache wrappers value)))
1080           (unless (eq ncache ocache)
1081             (dfun-update generic-function
1082                          #'make-constant-value-dfun ncache)))))))
1083 \f
1084 ;;; Given a generic function and a set of arguments to that generic
1085 ;;; function, return a mess of values.
1086 ;;;
1087 ;;;  <function>   The compiled effective method function for this set of
1088 ;;;            arguments.
1089 ;;;
1090 ;;;  <applicable> Sorted list of applicable methods.
1091 ;;;
1092 ;;;  <wrappers>   Is a single wrapper if the generic function has only
1093 ;;;            one key, that is arg-info-nkeys of the arg-info is 1.
1094 ;;;            Otherwise a list of the wrappers of the specialized
1095 ;;;            arguments to the generic function.
1096 ;;;
1097 ;;;            Note that all these wrappers are valid. This function
1098 ;;;            does invalid wrapper traps when it finds an invalid
1099 ;;;            wrapper and then returns the new, valid wrapper.
1100 ;;;
1101 ;;;  <invalidp>   True if any of the specialized arguments had an invalid
1102 ;;;            wrapper, false otherwise.
1103 ;;;
1104 ;;;  <type>       READER or WRITER when the only method that would be run
1105 ;;;            is a standard reader or writer method. To be specific,
1106 ;;;            the value is READER when the method combination is eq to
1107 ;;;            *standard-method-combination*; there are no applicable
1108 ;;;            :before, :after or :around methods; and the most specific
1109 ;;;            primary method is a standard reader method.
1110 ;;;
1111 ;;;  <index>      If <type> is READER or WRITER, and the slot accessed is
1112 ;;;            an :instance slot, this is the index number of that slot
1113 ;;;            in the object argument.
1114 (defvar *cache-miss-values-stack* ())
1115
1116 (defun cache-miss-values (gf args state)
1117   (multiple-value-bind (nreq applyp metatypes nkeys arg-info)
1118       (get-generic-fun-info gf)
1119     (declare (ignore nreq applyp nkeys))
1120     (with-dfun-wrappers (args metatypes)
1121       (dfun-wrappers invalid-wrapper-p wrappers classes types)
1122       (error-need-at-least-n-args gf (length metatypes))
1123       (multiple-value-bind (emf methods accessor-type index)
1124           (cache-miss-values-internal
1125            gf arg-info wrappers classes types state)
1126         (values emf methods
1127                 dfun-wrappers
1128                 invalid-wrapper-p
1129                 accessor-type index)))))
1130
1131 (defun cache-miss-values-internal (gf arg-info wrappers classes types state)
1132   (if (and classes (equal classes (cdr (assq gf *cache-miss-values-stack*))))
1133       (break-vicious-metacircle gf classes arg-info)
1134       (let ((*cache-miss-values-stack*
1135              (acons gf classes *cache-miss-values-stack*))
1136             (cam-std-p (or (null arg-info)
1137                            (gf-info-c-a-m-emf-std-p arg-info))))
1138         (multiple-value-bind (methods all-applicable-and-sorted-p)
1139             (if cam-std-p
1140                 (compute-applicable-methods-using-types gf types)
1141                 (compute-applicable-methods-using-classes gf classes))
1142
1143   (let* ((for-accessor-p (eq state 'accessor))
1144          (for-cache-p (or (eq state 'caching) (eq state 'accessor)))
1145          (emf (if (or cam-std-p all-applicable-and-sorted-p)
1146                   (let ((generator
1147                          (get-secondary-dispatch-function1
1148                           gf methods types nil (and for-cache-p wrappers)
1149                           all-applicable-and-sorted-p)))
1150                     (make-callable gf methods generator
1151                                    nil (and for-cache-p wrappers)))
1152                   (default-secondary-dispatch-function gf))))
1153     (multiple-value-bind (index accessor-type)
1154         (and for-accessor-p all-applicable-and-sorted-p methods
1155              (accessor-values gf arg-info classes methods))
1156       (values (if (integerp index) index emf)
1157               methods accessor-type index)))))))
1158
1159 ;;; Try to break a vicious circle while computing a cache miss.
1160 ;;; GF is the generic function, CLASSES are the classes of actual
1161 ;;; arguments, and ARG-INFO is the generic functions' arg-info.
1162 ;;;
1163 ;;; A vicious circle can be entered when the computation of the cache
1164 ;;; miss values itself depends on the values being computed.  For
1165 ;;; instance, adding a method which is an instance of a subclass of
1166 ;;; STANDARD-METHOD leads to cache misses for slot accessors of
1167 ;;; STANDARD-METHOD like METHOD-SPECIALIZERS, and METHOD-SPECIALIZERS
1168 ;;; is itself used while we compute cache miss values.
1169 (defun break-vicious-metacircle (gf classes arg-info)
1170   (when (typep gf 'standard-generic-function)
1171     (multiple-value-bind (class slotd accessor-type)
1172         (accesses-standard-class-slot-p gf)
1173       (when class
1174         (let ((method (find-standard-class-accessor-method
1175                        gf class accessor-type))
1176               (index (standard-slot-value/eslotd slotd 'location))
1177               (type (gf-info-simple-accessor-type arg-info)))
1178           (when (and method
1179                      (subtypep (ecase accessor-type
1180                                  ((reader) (car classes))
1181                                  ((writer) (cadr classes)))
1182                                class))
1183             (return-from break-vicious-metacircle
1184               (values index (list method) type index)))))))
1185   (error "~@<vicious metacircle:  The computation of an ~
1186           effective method of ~s for arguments of types ~s uses ~
1187           the effective method being computed.~@:>"
1188          gf classes))
1189
1190 ;;; Return (CLASS SLOTD ACCESSOR-TYPE) if some method of generic
1191 ;;; function GF accesses a slot of some class in *STANDARD-CLASSES*.
1192 ;;; CLASS is the class accessed, SLOTD is the effective slot definition
1193 ;;; object of the slot accessed, and ACCESSOR-TYPE is one of the symbols
1194 ;;; READER or WRITER describing the slot access.
1195 (defun accesses-standard-class-slot-p (gf)
1196   (flet ((standard-class-slot-access (gf class)
1197            (loop with gf-name = (standard-slot-value/gf gf 'name)
1198                  for slotd in (standard-slot-value/class class 'slots)
1199                  ;; FIXME: where does BOUNDP fit in here?  Is it
1200                  ;; relevant?
1201                  as readers = (standard-slot-value/eslotd slotd 'readers)
1202                  as writers = (standard-slot-value/eslotd slotd 'writers)
1203                  if (member gf-name readers :test #'equal)
1204                    return (values slotd 'reader)
1205                  else if (member gf-name writers :test #'equal)
1206                    return (values slotd 'writer))))
1207     (dolist (class-name *standard-classes*)
1208       (let ((class (find-class class-name)))
1209         (multiple-value-bind (slotd accessor-type)
1210             (standard-class-slot-access gf class)
1211           (when slotd
1212             (return (values class slotd accessor-type))))))))
1213
1214 ;;; Find a slot reader/writer method among the methods of generic
1215 ;;; function GF which reads/writes instances of class CLASS.
1216 ;;; TYPE is one of the symbols READER or WRITER.
1217 (defun find-standard-class-accessor-method (gf class type)
1218   (let ((cpl (standard-slot-value/class class 'class-precedence-list))
1219         (found-specializer *the-class-t*)
1220         (found-method nil))
1221     (dolist (method (standard-slot-value/gf gf 'methods) found-method)
1222       (let ((specializers (standard-slot-value/method method 'specializers))
1223             (qualifiers (plist-value method 'qualifiers)))
1224         (when (and (null qualifiers)
1225                    (let ((subcpl (member (ecase type
1226                                            (reader (car specializers))
1227                                            (writer (cadr specializers)))
1228                                          cpl)))
1229                      (and subcpl (member found-specializer subcpl))))
1230           (setf found-specializer (ecase type
1231                                     (reader (car specializers))
1232                                     (writer (cadr specializers))))
1233           (setf found-method method))))))
1234
1235 (defun accessor-values (gf arg-info classes methods)
1236   (declare (ignore gf))
1237   (let* ((accessor-type (gf-info-simple-accessor-type arg-info))
1238          (accessor-class (case accessor-type
1239                            ((reader boundp) (car classes))
1240                            (writer (cadr classes)))))
1241     (accessor-values-internal accessor-type accessor-class methods)))
1242
1243 (defun accessor-values1 (gf accessor-type accessor-class)
1244   (let* ((type `(class-eq ,accessor-class))
1245          (types (ecase accessor-type
1246                   ((reader boundp) `(,type))
1247                   (writer `(t ,type))))
1248          (methods (compute-applicable-methods-using-types gf types)))
1249     (accessor-values-internal accessor-type accessor-class methods)))
1250
1251 (defun accessor-values-internal (accessor-type accessor-class methods)
1252   (dolist (meth methods)
1253     (when (if (consp meth)
1254               (early-method-qualifiers meth)
1255               (method-qualifiers meth))
1256       (return-from accessor-values-internal (values nil nil))))
1257   (let* ((meth (car methods))
1258          (early-p (not (eq *boot-state* 'complete)))
1259          (slot-name (when accessor-class
1260                       (if (consp meth)
1261                           (and (early-method-standard-accessor-p meth)
1262                                (early-method-standard-accessor-slot-name meth))
1263                           (and (member *the-class-std-object*
1264                                        (if early-p
1265                                            (early-class-precedence-list
1266                                             accessor-class)
1267                                            (class-precedence-list
1268                                             accessor-class)))
1269                                (if early-p
1270                                    (not (eq *the-class-standard-method*
1271                                             (early-method-class meth)))
1272                                    (standard-accessor-method-p meth))
1273                                (if early-p
1274                                    (early-accessor-method-slot-name meth)
1275                                    (accessor-method-slot-name meth))))))
1276          (slotd (and accessor-class
1277                      (if early-p
1278                          (dolist (slot (early-class-slotds accessor-class) nil)
1279                            (when (eql slot-name
1280                                       (early-slot-definition-name slot))
1281                              (return slot)))
1282                          (find-slot-definition accessor-class slot-name)))))
1283     (when (and slotd
1284                (or early-p
1285                    (slot-accessor-std-p slotd accessor-type)))
1286       (values (if early-p
1287                   (early-slot-definition-location slotd)
1288                   (slot-definition-location slotd))
1289               accessor-type))))
1290
1291 (defun make-accessor-table (gf type &optional table)
1292   (unless table (setq table (make-hash-table :test 'eq)))
1293   (let ((methods (if (early-gf-p gf)
1294                      (early-gf-methods gf)
1295                      (generic-function-methods gf)))
1296         (all-index nil)
1297         (no-class-slots-p t)
1298         (early-p (not (eq *boot-state* 'complete)))
1299         first second (size 0))
1300     (declare (fixnum size))
1301     ;; class -> {(specl slotd)}
1302     (dolist (method methods)
1303       (let* ((specializers (if (consp method)
1304                                (early-method-specializers method t)
1305                                (method-specializers method)))
1306              (specl (ecase type
1307                       ((reader boundp) (car specializers))
1308                       (writer (cadr specializers))))
1309              (specl-cpl (if early-p
1310                             (early-class-precedence-list specl)
1311                             (and (class-finalized-p specl)
1312                                  (class-precedence-list specl))))
1313              (so-p (member *the-class-std-object* specl-cpl))
1314              (slot-name (if (consp method)
1315                             (and (early-method-standard-accessor-p method)
1316                                  (early-method-standard-accessor-slot-name
1317                                   method))
1318                             (accessor-method-slot-name method))))
1319         (when (or (null specl-cpl)
1320                   (member *the-class-structure-object* specl-cpl))
1321           (return-from make-accessor-table nil))
1322         (maphash (lambda (class slotd)
1323                    (let ((cpl (if early-p
1324                                   (early-class-precedence-list class)
1325                                   (class-precedence-list class))))
1326                      (when (memq specl cpl)
1327                        (unless (and (or so-p
1328                                         (member *the-class-std-object* cpl))
1329                                     (or early-p
1330                                         (slot-accessor-std-p slotd type)))
1331                          (return-from make-accessor-table nil))
1332                        (push (cons specl slotd) (gethash class table)))))
1333                  (gethash slot-name *name->class->slotd-table*))))
1334     (maphash (lambda (class specl+slotd-list)
1335                (dolist (sclass (if early-p
1336                                    (early-class-precedence-list class)
1337                                    (class-precedence-list class))
1338                                (error "This can't happen."))
1339                  (let ((a (assq sclass specl+slotd-list)))
1340                    (when a
1341                      (let* ((slotd (cdr a))
1342                             (index (if early-p
1343                                        (early-slot-definition-location slotd)
1344                                        (slot-definition-location slotd))))
1345                        (unless index (return-from make-accessor-table nil))
1346                        (setf (gethash class table) index)
1347                        (when (consp index) (setq no-class-slots-p nil))
1348                        (setq all-index (if (or (null all-index)
1349                                                (eql all-index index))
1350                                            index t))
1351                        (incf size)
1352                        (cond ((= size 1) (setq first class))
1353                              ((= size 2) (setq second class)))
1354                        (return nil))))))
1355              table)
1356     (values table all-index first second size no-class-slots-p)))
1357
1358 (defun compute-applicable-methods-using-types (generic-function types)
1359   (let ((definite-p t) (possibly-applicable-methods nil))
1360     (dolist (method (if (early-gf-p generic-function)
1361                         (early-gf-methods generic-function)
1362                         (generic-function-methods generic-function)))
1363       (let ((specls (if (consp method)
1364                         (early-method-specializers method t)
1365                         (method-specializers method)))
1366             (types types)
1367             (possibly-applicable-p t) (applicable-p t))
1368         (dolist (specl specls)
1369           (multiple-value-bind (specl-applicable-p specl-possibly-applicable-p)
1370               (specializer-applicable-using-type-p specl (pop types))
1371             (unless specl-applicable-p
1372               (setq applicable-p nil))
1373             (unless specl-possibly-applicable-p
1374               (setq possibly-applicable-p nil)
1375               (return nil))))
1376         (when possibly-applicable-p
1377           (unless applicable-p (setq definite-p nil))
1378           (push method possibly-applicable-methods))))
1379     (let ((precedence (arg-info-precedence (if (early-gf-p generic-function)
1380                                                (early-gf-arg-info
1381                                                 generic-function)
1382                                                (gf-arg-info
1383                                                 generic-function)))))
1384       (values (sort-applicable-methods precedence
1385                                        (nreverse possibly-applicable-methods)
1386                                        types)
1387               definite-p))))
1388
1389 (defun sort-applicable-methods (precedence methods types)
1390   (sort-methods methods
1391                 precedence
1392                 (lambda (class1 class2 index)
1393                   (let* ((class (type-class (nth index types)))
1394                          (cpl (if (eq *boot-state* 'complete)
1395                                   (class-precedence-list class)
1396                                   (early-class-precedence-list class))))
1397                     (if (memq class2 (memq class1 cpl))
1398                         class1 class2)))))
1399
1400 (defun sort-methods (methods precedence compare-classes-function)
1401   (flet ((sorter (method1 method2)
1402            (dolist (index precedence)
1403              (let* ((specl1 (nth index (if (listp method1)
1404                                            (early-method-specializers method1
1405                                                                       t)
1406                                            (method-specializers method1))))
1407                     (specl2 (nth index (if (listp method2)
1408                                            (early-method-specializers method2
1409                                                                       t)
1410                                            (method-specializers method2))))
1411                     (order (order-specializers
1412                              specl1 specl2 index compare-classes-function)))
1413                (when order
1414                  (return-from sorter (eq order specl1)))))))
1415     (stable-sort methods #'sorter)))
1416
1417 (defun order-specializers (specl1 specl2 index compare-classes-function)
1418   (let ((type1 (if (eq *boot-state* 'complete)
1419                    (specializer-type specl1)
1420                    (!bootstrap-get-slot 'specializer specl1 'type)))
1421         (type2 (if (eq *boot-state* 'complete)
1422                    (specializer-type specl2)
1423                    (!bootstrap-get-slot 'specializer specl2 'type))))
1424     (cond ((eq specl1 specl2)
1425            nil)
1426           ((atom type1)
1427            specl2)
1428           ((atom type2)
1429            specl1)
1430           (t
1431            (case (car type1)
1432              (class    (case (car type2)
1433                          (class (funcall compare-classes-function
1434                                          specl1 specl2 index))
1435                          (t specl2)))
1436              (prototype (case (car type2)
1437                          (class (funcall compare-classes-function
1438                                          specl1 specl2 index))
1439                          (t specl2)))
1440              (class-eq (case (car type2)
1441                          (eql specl2)
1442                          (class-eq nil)
1443                          (class type1)))
1444              (eql      (case (car type2)
1445                          (eql nil)
1446                          (t specl1))))))))
1447
1448 (defun map-all-orders (methods precedence function)
1449   (let ((choices nil))
1450     (flet ((compare-classes-function (class1 class2 index)
1451              (declare (ignore index))
1452              (let ((choice nil))
1453                (dolist (c choices nil)
1454                  (when (or (and (eq (first c) class1)
1455                                 (eq (second c) class2))
1456                            (and (eq (first c) class2)
1457                                 (eq (second c) class1)))
1458                    (return (setq choice c))))
1459                (unless choice
1460                  (setq choice
1461                        (if (class-might-precede-p class1 class2)
1462                            (if (class-might-precede-p class2 class1)
1463                                (list class1 class2 nil t)
1464                                (list class1 class2 t))
1465                            (if (class-might-precede-p class2 class1)
1466                                (list class2 class1 t)
1467                                (let ((name1 (class-name class1))
1468                                      (name2 (class-name class2)))
1469                                  (if (and name1
1470                                           name2
1471                                           (symbolp name1)
1472                                           (symbolp name2)
1473                                           (string< (symbol-name name1)
1474                                                    (symbol-name name2)))
1475                                      (list class1 class2 t)
1476                                      (list class2 class1 t))))))
1477                  (push choice choices))
1478                (car choice))))
1479       (loop (funcall function
1480                      (sort-methods methods
1481                                    precedence
1482                                    #'compare-classes-function))
1483             (unless (dolist (c choices nil)
1484                       (unless (third c)
1485                         (rotatef (car c) (cadr c))
1486                         (return (setf (third c) t))))
1487               (return nil))))))
1488
1489 ;;; CMUCL comment: used only in map-all-orders
1490 (defun class-might-precede-p (class1 class2)
1491   (if (not *in-precompute-effective-methods-p*)
1492       (not (member class1 (cdr (class-precedence-list class2))))
1493       (class-can-precede-p class1 class2)))
1494
1495 (defun compute-precedence (lambda-list nreq argument-precedence-order)
1496   (if (null argument-precedence-order)
1497       (let ((list nil))
1498         (dotimes-fixnum (i nreq list) (push (- (1- nreq) i) list)))
1499       (mapcar (lambda (x) (position x lambda-list))
1500               argument-precedence-order)))
1501
1502 (defun cpl-or-nil (class)
1503   (if (eq *boot-state* 'complete)
1504       ;; KLUDGE: why not use (slot-boundp class
1505       ;; 'class-precedence-list)?  Well, unfortunately, CPL-OR-NIL is
1506       ;; used within COMPUTE-APPLICABLE-METHODS, including for
1507       ;; SLOT-BOUNDP-USING-CLASS... and the available mechanism for
1508       ;; breaking such nasty cycles in effective method computation
1509       ;; only works for readers and writers, not boundps.  It might
1510       ;; not be too hard to make it work for BOUNDP accessors, but in
1511       ;; the meantime we use an extra slot for exactly the result of
1512       ;; the SLOT-BOUNDP that we want.  (We cannot use
1513       ;; CLASS-FINALIZED-P, because in the process of class
1514       ;; finalization we need to use the CPL which has been computed
1515       ;; to cache effective methods for slot accessors.) -- CSR,
1516       ;; 2004-09-19.
1517       (when (cpl-available-p class)
1518         (class-precedence-list class))
1519       (early-class-precedence-list class)))
1520
1521 (defun saut-and (specl type)
1522   (let ((applicable nil)
1523         (possibly-applicable t))
1524     (dolist (type (cdr type))
1525       (multiple-value-bind (appl poss-appl)
1526           (specializer-applicable-using-type-p specl type)
1527         (when appl (return (setq applicable t)))
1528         (unless poss-appl (return (setq possibly-applicable nil)))))
1529     (values applicable possibly-applicable)))
1530
1531 (defun saut-not (specl type)
1532   (let ((ntype (cadr type)))
1533     (values nil
1534             (case (car ntype)
1535               (class      (saut-not-class specl ntype))
1536               (class-eq   (saut-not-class-eq specl ntype))
1537               (prototype  (saut-not-prototype specl ntype))
1538               (eql      (saut-not-eql specl ntype))
1539               (t (error "~S cannot handle the second argument ~S"
1540                         'specializer-applicable-using-type-p type))))))
1541
1542 (defun saut-not-class (specl ntype)
1543   (let* ((class (type-class specl))
1544          (cpl (cpl-or-nil class)))
1545     (not (memq (cadr ntype) cpl))))
1546
1547 (defun saut-not-prototype (specl ntype)
1548   (let* ((class (case (car specl)
1549                   (eql       (class-of (cadr specl)))
1550                   (class-eq  (cadr specl))
1551                   (prototype (cadr specl))
1552                   (class     (cadr specl))))
1553          (cpl (cpl-or-nil class)))
1554     (not (memq (cadr ntype) cpl))))
1555
1556 (defun saut-not-class-eq (specl ntype)
1557   (let ((class (case (car specl)
1558                  (eql      (class-of (cadr specl)))
1559                  (class-eq (cadr specl)))))
1560     (not (eq class (cadr ntype)))))
1561
1562 (defun saut-not-eql (specl ntype)
1563   (case (car specl)
1564     (eql (not (eql (cadr specl) (cadr ntype))))
1565     (t   t)))
1566
1567 (defun class-applicable-using-class-p (specl type)
1568   (let ((pred (memq specl (cpl-or-nil type))))
1569     (values pred
1570             (or pred
1571                 (if (not *in-precompute-effective-methods-p*)
1572                     ;; classes might get common subclass
1573                     (superclasses-compatible-p specl type)
1574                     ;; worry only about existing classes
1575                     (classes-have-common-subclass-p specl type))))))
1576
1577 (defun classes-have-common-subclass-p (class1 class2)
1578   (or (eq class1 class2)
1579       (let ((class1-subs (class-direct-subclasses class1)))
1580         (or (memq class2 class1-subs)
1581             (dolist (class1-sub class1-subs nil)
1582               (when (classes-have-common-subclass-p class1-sub class2)
1583                 (return t)))))))
1584
1585 (defun saut-class (specl type)
1586   (case (car specl)
1587     (class (class-applicable-using-class-p (cadr specl) (cadr type)))
1588     (t     (values nil (let ((class (type-class specl)))
1589                          (memq (cadr type)
1590                                (cpl-or-nil class)))))))
1591
1592 (defun saut-class-eq (specl type)
1593   (if (eq (car specl) 'eql)
1594       (values nil (eq (class-of (cadr specl)) (cadr type)))
1595       (let ((pred (case (car specl)
1596                     (class-eq
1597                      (eq (cadr specl) (cadr type)))
1598                     (class
1599                      (or (eq (cadr specl) (cadr type))
1600                          (memq (cadr specl) (cpl-or-nil (cadr type))))))))
1601         (values pred pred))))
1602
1603 (defun saut-prototype (specl type)
1604   (declare (ignore specl type))
1605   (values nil nil)) ; XXX original PCL comment: fix this someday
1606
1607 (defun saut-eql (specl type)
1608   (let ((pred (case (car specl)
1609                 (eql    (eql (cadr specl) (cadr type)))
1610                 (class-eq   (eq (cadr specl) (class-of (cadr type))))
1611                 (class      (memq (cadr specl)
1612                                   (let ((class (class-of (cadr type))))
1613                                     (cpl-or-nil class)))))))
1614     (values pred pred)))
1615
1616 (defun specializer-applicable-using-type-p (specl type)
1617   (setq specl (type-from-specializer specl))
1618   (when (eq specl t)
1619     (return-from specializer-applicable-using-type-p (values t t)))
1620   ;; This is used by C-A-M-U-T and GENERATE-DISCRIMINATION-NET-INTERNAL,
1621   ;; and has only what they need.
1622   (if (or (atom type) (eq (car type) t))
1623       (values nil t)
1624       (case (car type)
1625         (and    (saut-and specl type))
1626         (not    (saut-not specl type))
1627         (class      (saut-class specl type))
1628         (prototype  (saut-prototype specl type))
1629         (class-eq   (saut-class-eq specl type))
1630         (eql    (saut-eql specl type))
1631         (t        (error "~S cannot handle the second argument ~S."
1632                            'specializer-applicable-using-type-p
1633                            type)))))
1634
1635 (defun map-all-classes (function &optional (root t))
1636   (let ((braid-p (or (eq *boot-state* 'braid)
1637                      (eq *boot-state* 'complete))))
1638     (labels ((do-class (class)
1639                (mapc #'do-class
1640                      (if braid-p
1641                          (class-direct-subclasses class)
1642                          (early-class-direct-subclasses class)))
1643                (funcall function class)))
1644       (do-class (if (symbolp root)
1645                     (find-class root)
1646                     root)))))
1647 \f
1648 (defvar *effective-method-cache* (make-hash-table :test 'eq))
1649
1650 (defun flush-effective-method-cache (generic-function)
1651   (dolist (method (generic-function-methods generic-function))
1652     (remhash method *effective-method-cache*)))
1653
1654 (defun get-secondary-dispatch-function (gf methods types
1655                                         &optional method-alist wrappers)
1656   (let ((generator
1657          (get-secondary-dispatch-function1
1658           gf methods types (not (null method-alist)) (not (null wrappers))
1659           (not (methods-contain-eql-specializer-p methods)))))
1660     (make-callable gf methods generator method-alist wrappers)))
1661
1662 (defun get-secondary-dispatch-function1 (gf methods types method-alist-p
1663                                             wrappers-p
1664                                             &optional
1665                                             all-applicable-p
1666                                             (all-sorted-p t)
1667                                             function-p)
1668   (if (null methods)
1669       (if function-p
1670           (lambda (method-alist wrappers)
1671             (declare (ignore method-alist wrappers))
1672             #'(instance-lambda (&rest args)
1673                 (apply #'no-applicable-method gf args)))
1674           (lambda (method-alist wrappers)
1675             (declare (ignore method-alist wrappers))
1676             (lambda (&rest args)
1677               (apply #'no-applicable-method gf args))))
1678       (let* ((key (car methods))
1679              (ht-value (or (gethash key *effective-method-cache*)
1680                            (setf (gethash key *effective-method-cache*)
1681                                  (cons nil nil)))))
1682         (if (and (null (cdr methods)) all-applicable-p ; the most common case
1683                  (null method-alist-p) wrappers-p (not function-p))
1684             (or (car ht-value)
1685                 (setf (car ht-value)
1686                       (get-secondary-dispatch-function2
1687                        gf methods types method-alist-p wrappers-p
1688                        all-applicable-p all-sorted-p function-p)))
1689             (let ((akey (list methods
1690                               (if all-applicable-p 'all-applicable types)
1691                               method-alist-p wrappers-p function-p)))
1692               (or (cdr (assoc akey (cdr ht-value) :test #'equal))
1693                   (let ((value (get-secondary-dispatch-function2
1694                                 gf methods types method-alist-p wrappers-p
1695                                 all-applicable-p all-sorted-p function-p)))
1696                     (push (cons akey value) (cdr ht-value))
1697                     value)))))))
1698
1699 (defun get-secondary-dispatch-function2 (gf methods types method-alist-p
1700                                             wrappers-p all-applicable-p
1701                                             all-sorted-p function-p)
1702   (if (and all-applicable-p all-sorted-p (not function-p))
1703       (if (eq *boot-state* 'complete)
1704           (let* ((combin (generic-function-method-combination gf))
1705                  (effective (compute-effective-method gf combin methods)))
1706             (make-effective-method-function1 gf effective method-alist-p
1707                                              wrappers-p))
1708           (let ((effective (standard-compute-effective-method gf nil methods)))
1709             (make-effective-method-function1 gf effective method-alist-p
1710                                              wrappers-p)))
1711       (let ((net (generate-discrimination-net
1712                   gf methods types all-sorted-p)))
1713         (compute-secondary-dispatch-function1 gf net function-p))))
1714
1715 (defun get-effective-method-function (gf methods
1716                                          &optional method-alist wrappers)
1717   (let ((generator
1718          (get-secondary-dispatch-function1
1719           gf methods nil (not (null method-alist)) (not (null wrappers)) t)))
1720     (make-callable gf methods generator method-alist wrappers)))
1721
1722 (defun get-effective-method-function1 (gf methods &optional (sorted-p t))
1723   (get-secondary-dispatch-function1 gf methods nil nil nil t sorted-p))
1724
1725 (defun methods-contain-eql-specializer-p (methods)
1726   (and (eq *boot-state* 'complete)
1727        (dolist (method methods nil)
1728          (when (dolist (spec (method-specializers method) nil)
1729                  (when (eql-specializer-p spec) (return t)))
1730            (return t)))))
1731 \f
1732 (defun update-dfun (generic-function &optional dfun cache info)
1733   (let* ((early-p (early-gf-p generic-function))
1734          (gf-name (if early-p
1735                       (!early-gf-name generic-function)
1736                       (generic-function-name generic-function))))
1737     (set-dfun generic-function dfun cache info)
1738     (let ((dfun (if early-p
1739                     (or dfun (make-initial-dfun generic-function))
1740                     (compute-discriminating-function generic-function))))
1741       (set-funcallable-instance-function generic-function dfun)
1742       (set-fun-name generic-function gf-name)
1743       dfun)))
1744 \f
1745 (defvar *dfun-count* nil)
1746 (defvar *dfun-list* nil)
1747 (defvar *minimum-cache-size-to-list*)
1748
1749 ;;; These functions aren't used in SBCL, or documented anywhere that
1750 ;;; I'm aware of, but they look like they might be useful for
1751 ;;; debugging or performance tweaking or something, so I've just
1752 ;;; commented them out instead of deleting them. -- WHN 2001-03-28
1753 #|
1754 (defun list-dfun (gf)
1755   (let* ((sym (type-of (gf-dfun-info gf)))
1756          (a (assq sym *dfun-list*)))
1757     (unless a
1758       (push (setq a (list sym)) *dfun-list*))
1759     (push (generic-function-name gf) (cdr a))))
1760
1761 (defun list-all-dfuns ()
1762   (setq *dfun-list* nil)
1763   (map-all-generic-functions #'list-dfun)
1764   *dfun-list*)
1765
1766 (defun list-large-cache (gf)
1767   (let* ((sym (type-of (gf-dfun-info gf)))
1768          (cache (gf-dfun-cache gf)))
1769     (when cache
1770       (let ((size (cache-size cache)))
1771         (when (>= size *minimum-cache-size-to-list*)
1772           (let ((a (assoc size *dfun-list*)))
1773             (unless a
1774               (push (setq a (list size)) *dfun-list*))
1775             (push (let ((name (generic-function-name gf)))
1776                     (if (eq sym 'caching) name (list name sym)))
1777                   (cdr a))))))))
1778
1779 (defun list-large-caches (&optional (*minimum-cache-size-to-list* 130))
1780   (setq *dfun-list* nil)
1781   (map-all-generic-functions #'list-large-cache)
1782   (setq *dfun-list* (sort *dfun-list* #'< :key #'car))
1783   (mapc #'print *dfun-list*)
1784   (values))
1785
1786 (defun count-dfun (gf)
1787   (let* ((sym (type-of (gf-dfun-info gf)))
1788          (cache (gf-dfun-cache gf))
1789          (a (assq sym *dfun-count*)))
1790     (unless a
1791       (push (setq a (list sym 0 nil)) *dfun-count*))
1792     (incf (cadr a))
1793     (when cache
1794       (let* ((size (cache-size cache))
1795              (b (assoc size (third a))))
1796         (unless b
1797           (push (setq b (cons size 0)) (third a)))
1798         (incf (cdr b))))))
1799
1800 (defun count-all-dfuns ()
1801   (setq *dfun-count* (mapcar (lambda (type) (list type 0 nil))
1802                              '(ONE-CLASS TWO-CLASS DEFAULT-METHOD-ONLY
1803                                ONE-INDEX N-N CHECKING CACHING
1804                                DISPATCH)))
1805   (map-all-generic-functions #'count-dfun)
1806   (mapc (lambda (type+count+sizes)
1807           (setf (third type+count+sizes)
1808                 (sort (third type+count+sizes) #'< :key #'car)))
1809         *dfun-count*)
1810   (mapc (lambda (type+count+sizes)
1811           (format t "~&There are ~W dfuns of type ~S."
1812                   (cadr type+count+sizes) (car type+count+sizes))
1813           (format t "~%   ~S~%" (caddr type+count+sizes)))
1814         *dfun-count*)
1815   (values))
1816 |#
1817
1818 (defun gfs-of-type (type)
1819   (unless (consp type) (setq type (list type)))
1820   (let ((gf-list nil))
1821     (map-all-generic-functions (lambda (gf)
1822                                  (when (memq (type-of (gf-dfun-info gf))
1823                                              type)
1824                                    (push gf gf-list))))
1825     gf-list))