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