sys/kern/kern_objcache.c

   1 /*
   2  * Copyright (c) 2005 Jeffrey M. Hsu.  All rights reserved.
   3  *
   4  * This code is derived from software contributed to The DragonFly Project
   5  * by Jeffrey M. Hsu.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. Neither the name of The DragonFly Project nor the names of its
  16  *    contributors may be used to endorse or promote products derived
  17  *    from this software without specific, prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  22  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  23  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  24  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  25  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  26  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  27  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  28  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  29  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  *
  32  * $DragonFly: src/sys/kern/kern_objcache.c,v 1.2 2005/06/08 22:22:59 dillon Exp $
  33  */
  34
  35 #include <sys/param.h>
  36 #include <sys/kernel.h>
  37 #include <sys/systm.h>
  38 #include <sys/callout.h>
  39 #include <sys/globaldata.h>
  40 #include <sys/malloc.h>
  41 #include <sys/queue.h>
  42 #include <sys/objcache.h>
  43 #include <sys/thread.h>
  44 #include <sys/thread2.h>
  45
  46 static MALLOC_DEFINE(M_OBJCACHE, "objcache", "Object Cache");
  47 static MALLOC_DEFINE(M_OBJMAG, "objcache magazine", "Object Cache Magazine");
  48
  49 #define INITIAL_MAG_CAPACITY    256
  50
  51 struct magazine {
  52         int                      rounds;
  53         int                      capacity;
  54         SLIST_ENTRY(magazine)    nextmagazine;
  55         void                    *objects[];
  56 };
  57
  58 SLIST_HEAD(magazinelist, magazine);
  59
  60 /*
  61  * per-cluster cache of magazines
  62  * All fields in this structure are protected by the token.
  63  */
  64 struct magazinedepot {
  65         /*
  66          * The per-cpu object caches only exchanges completely full or
  67          * completely empty magazines with the depot layer, so only have
  68          * to cache these two types of magazines.
  69          */
  70         struct magazinelist     fullmagazines;
  71         struct magazinelist     emptymagazines;
  72         int                     magcapacity;
  73
  74         /* protect this structure */
  75         struct lwkt_token       token;
  76
  77         /* magazines not yet allocated towards limit */
  78         int                     unallocated_objects;
  79
  80         /* infrequently used fields */
  81         int                     waiting;        /* waiting for another cpu to
  82                                                  * return a full magazine to
  83                                                  * the depot */
  84         int                     contested;      /* depot contention count */
  85 };
  86
  87 /*
  88  * per-cpu object cache
  89  * All fields in this structure are protected by crit_enter().
  90  */
  91 struct percpu_objcache {
  92         struct magazine *loaded_magazine;       /* active magazine */
  93         struct magazine *previous_magazine;     /* backup magazine */
  94
  95         /* statistics */
  96         int             gets_cumulative;        /* total calls to get */
  97         int             gets_null;              /* objcache_get returned NULL */
  98         int             puts_cumulative;        /* total calls to put */
  99         int             puts_othercluster;      /* returned to other cluster */
 100
 101         /* infrequently used fields */
 102         int             waiting;        /* waiting for a thread on this cpu to
 103                                          * return an obj to the per-cpu cache */
 104 };
 105
 106 /* only until we have NUMA cluster topology information XXX */
 107 #define MAXCLUSTERS 1
 108 #define myclusterid 0
 109 #define CLUSTER_OF(obj) 0
 110
 111 /*
 112  * Two-level object cache consisting of NUMA cluster-level depots of
 113  * fully loaded or completely empty magazines and cpu-level caches of
 114  * individual objects.
 115  */
 116 struct objcache {
 117         char                    *name;
 118
 119         /* object constructor and destructor from blank storage */
 120         objcache_ctor_fn        *ctor;
 121         objcache_dtor_fn        *dtor;
 122         void                    *private;
 123
 124         /* interface to underlying allocator */
 125         objcache_alloc_fn       *alloc;
 126         objcache_free_fn        *free;
 127         void                    *allocator_args;
 128
 129         SLIST_ENTRY(objcache)   oc_next;
 130
 131         /* NUMA-cluster level caches */
 132         struct magazinedepot    depot[MAXCLUSTERS];
 133
 134         struct percpu_objcache  cache_percpu[];         /* per-cpu caches */
 135 };
 136
 137 static struct lwkt_token objcachelist_token;
 138 static SLIST_HEAD(objcachelist, objcache) allobjcaches;
 139
 140 static struct magazine *
 141 mag_alloc(int capacity)
 142 {
 143         struct magazine *mag;
 144
 145         mag = malloc(__offsetof(struct magazine, objects[capacity]),
 146                         M_OBJMAG, M_INTWAIT | M_ZERO);
 147         mag->capacity = capacity;
 148         mag->rounds = 0;
 149         return (mag);
 150 }
 151
 152 /*
 153  * Create an object cache.
 154  */
 155 struct objcache *
 156 objcache_create(char *name, int cluster_limit, int mag_capacity,
 157                 objcache_ctor_fn *ctor, objcache_dtor_fn *dtor, void *private,
 158                 objcache_alloc_fn *alloc, objcache_free_fn *free,
 159                 void *allocator_args)
 160 {
 161         struct objcache *oc;
 162         struct magazinedepot *depot;
 163         lwkt_tokref olock;
 164         int cpuid;
 165
 166         /* allocate object cache structure */
 167         oc = malloc(__offsetof(struct objcache, cache_percpu[ncpus]),
 168                     M_OBJCACHE, M_WAITOK | M_ZERO);
 169         oc->name = strdup(name, M_TEMP);
 170         oc->ctor = ctor;
 171         oc->dtor = dtor;
 172         oc->private = private;
 173         oc->free = free;
 174         oc->allocator_args = allocator_args;
 175
 176         /* initialize depots */
 177         depot = &oc->depot[0];
 178
 179         lwkt_token_init(&depot->token);
 180         SLIST_INIT(&depot->fullmagazines);
 181         SLIST_INIT(&depot->emptymagazines);
 182
 183         if (mag_capacity == 0)
 184                 mag_capacity = INITIAL_MAG_CAPACITY;
 185         depot->magcapacity = mag_capacity;
 186
 187         /*
 188          * The cluster_limit must be sufficient to have three magazines per
 189          * cpu.
 190          */
 191         if (cluster_limit == 0) {
 192                 depot->unallocated_objects = -1;
 193         } else {
 194                 if (cluster_limit < mag_capacity * ncpus * 3)
 195                         cluster_limit = mag_capacity * ncpus * 3;
 196                 depot->unallocated_objects = cluster_limit;
 197         }
 198         oc->alloc = alloc;
 199
 200         /* initialize per-cpu caches */
 201         for (cpuid = 0; cpuid < ncpus; cpuid++) {
 202                 struct percpu_objcache *cache_percpu = &oc->cache_percpu[cpuid];
 203
 204                 cache_percpu->loaded_magazine = mag_alloc(mag_capacity);
 205                 cache_percpu->previous_magazine = mag_alloc(mag_capacity);
 206         }
 207         lwkt_gettoken(&olock, &objcachelist_token);
 208         SLIST_INSERT_HEAD(&allobjcaches, oc, oc_next);
 209         lwkt_reltoken(&olock);
 210
 211         return (oc);
 212 }
 213
 214 #define MAGAZINE_EMPTY(mag)     (mag->rounds == 0)
 215 #define MAGAZINE_NOTEMPTY(mag)  (mag->rounds != 0)
 216 #define MAGAZINE_FULL(mag)      (mag->rounds == mag->capacity)
 217
 218 #define swap(x, y)      ({ struct magazine *t = x; x = y; y = t; })
 219
 220 /*
 221  * Get an object from the object cache.
 222  */
 223 void *
 224 objcache_get(struct objcache *oc, int ocflags)
 225 {
 226         struct percpu_objcache *cpucache = &oc->cache_percpu[mycpuid];
 227         struct magazine *loadedmag;
 228         struct magazine *emptymag;
 229         void *obj;
 230         struct magazinedepot *depot;
 231         lwkt_tokref ilock;
 232
 233         crit_enter();
 234         ++cpucache->gets_cumulative;
 235
 236 retry:
 237         /*
 238          * Loaded magazine has an object.  This is the hot path.
 239          * It is lock-free and uses a critical section to block
 240          * out interrupt handlers on the same processor.
 241          */
 242         loadedmag = cpucache->loaded_magazine;
 243         if (MAGAZINE_NOTEMPTY(loadedmag)) {
 244                 obj = loadedmag->objects[--loadedmag->rounds];
 245                 crit_exit();
 246                 return (obj);
 247         }
 248
 249         /* Previous magazine has an object. */
 250         if (MAGAZINE_NOTEMPTY(cpucache->previous_magazine)) {
 251                 swap(cpucache->loaded_magazine, cpucache->previous_magazine);
 252                 loadedmag = cpucache->loaded_magazine;
 253                 obj = loadedmag->objects[--loadedmag->rounds];
 254                 crit_exit();
 255                 return (obj);
 256         }
 257
 258         /*
 259          * Both magazines empty.  Get a full magazine from the depot and
 260          * move one of the empty ones to the depot.  Do this even if we
 261          * block on the token to avoid a non-optimal corner case.
 262          *
 263          * Obtain the depot token.
 264          */
 265         depot = &oc->depot[myclusterid];
 266         if (!lwkt_trytoken(&ilock, &depot->token)) {
 267                 lwkt_gettoken(&ilock, &depot->token);
 268                 ++depot->contested;
 269         }
 270
 271         /* Check if depot has a full magazine. */
 272         if (!SLIST_EMPTY(&depot->fullmagazines)) {
 273                 emptymag = cpucache->previous_magazine;
 274                 cpucache->previous_magazine = cpucache->loaded_magazine;
 275                 cpucache->loaded_magazine = SLIST_FIRST(&depot->fullmagazines);
 276                 SLIST_REMOVE_HEAD(&depot->fullmagazines, nextmagazine);
 277
 278                 /*
 279                  * Return emptymag to the depot.  Due to blocking it may
 280                  * not be entirely empty.
 281                  */
 282                 if (MAGAZINE_EMPTY(emptymag)) {
 283                         SLIST_INSERT_HEAD(&depot->emptymagazines,
 284                                           emptymag, nextmagazine);
 285                 } else {
 286                         /*
 287                          * NOTE: magazine is not necessarily entirely full
 288                          */
 289                         SLIST_INSERT_HEAD(&depot->fullmagazines,
 290                                           emptymag, nextmagazine);
 291                         if (depot->waiting)
 292                                 wakeup(depot);
 293                 }
 294                 lwkt_reltoken(&ilock);
 295                 goto retry;
 296         }
 297
 298         /*
 299          * The depot does not have any non-empty magazines.  If we have
 300          * not hit our object limit we can allocate a new object using
 301          * the back-end allocator.
 302          *
 303          * note: unallocated_objects can be initialized to -1, which has
 304          * the effect of removing any allocation limits.
 305          */
 306         if (depot->unallocated_objects) {
 307                 --depot->unallocated_objects;
 308                 lwkt_reltoken(&ilock);
 309                 crit_exit();
 310
 311                 obj = oc->alloc(oc->allocator_args, ocflags);
 312                 if (obj) {
 313                         if (oc->ctor(obj, oc->private, ocflags))
 314                                 return (obj);
 315                         oc->free(obj, oc->allocator_args);
 316                         lwkt_gettoken(&ilock, &depot->token);
 317                         ++depot->unallocated_objects;
 318                         if (depot->waiting)
 319                                 wakeup(depot);
 320                         lwkt_reltoken(&ilock);
 321                         obj = NULL;
 322                 }
 323                 if (obj == NULL) {
 324                         crit_enter();
 325                         ++cpucache->gets_null;
 326                         crit_exit();
 327                 }
 328                 return(obj);
 329         }
 330
 331         /*
 332          * Otherwise block if allowed to.
 333          */
 334         if ((ocflags & (M_WAITOK|M_NULLOK)) == M_WAITOK) {
 335                 ++cpucache->waiting;
 336                 ++depot->waiting;
 337                 tsleep(depot, PCATCH, "objcache_get", 0);
 338                 --cpucache->waiting;
 339                 --depot->waiting;
 340                 lwkt_reltoken(&ilock);
 341                 goto retry;
 342         }
 343         ++cpucache->gets_null;
 344         crit_exit();
 345         return (NULL);
 346 }
 347
 348 /*
 349  * Wrapper for malloc allocation routines.
 350  */
 351 void *
 352 objcache_malloc_alloc(void *allocator_args, int ocflags)
 353 {
 354         struct objcache_malloc_args *alloc_args = allocator_args;
 355
 356         return (malloc(alloc_args->objsize, alloc_args->mtype,
 357                        ocflags & OC_MFLAGS));
 358 }
 359
 360 void
 361 objcache_malloc_free(void *obj, void *allocator_args)
 362 {
 363         struct objcache_malloc_args *alloc_args = allocator_args;
 364
 365         free(obj, alloc_args->mtype);
 366 }
 367
 368 /*
 369  * Wrapper for allocation policies that pre-allocate at initialization time
 370  * and don't do run-time allocation.
 371  */
 372 void *
 373 objcache_nop_alloc(void *allocator_args, int ocflags)
 374 {
 375         return (NULL);
 376 }
 377
 378 void
 379 objcache_nop_free(void *obj, void *allocator_args)
 380 {
 381 }
 382
 383 /*
 384  * Return an object to the object cache.
 385  */
 386 void
 387 objcache_put(struct objcache *oc, void *obj)
 388 {
 389         struct percpu_objcache *cpucache = &oc->cache_percpu[mycpuid];
 390         struct magazine *loadedmag;
 391         struct magazinedepot *depot;
 392         lwkt_tokref ilock;
 393
 394         crit_enter();
 395         ++cpucache->puts_cumulative;
 396
 397         if (CLUSTER_OF(obj) != myclusterid) {
 398 #ifdef notyet
 399                 /* use lazy IPI to send object to owning cluster XXX todo */
 400                 ++cpucache->puts_othercluster;
 401                 return;
 402 #endif
 403         }
 404
 405 retry:
 406         /*
 407          * Free slot available in loaded magazine.  This is the hot path.
 408          * It is lock-free and uses a critical section to block out interrupt
 409          * handlers on the same processor.
 410          */
 411         loadedmag = cpucache->loaded_magazine;
 412         if (!MAGAZINE_FULL(loadedmag)) {
 413                 loadedmag->objects[loadedmag->rounds++] = obj;
 414                 if (cpucache->waiting)
 415                         wakeup(&oc->depot[myclusterid]);
 416                 crit_exit();
 417                 return;
 418         }
 419
 420         /*
 421          * Current magazine full, but previous magazine has room.  XXX
 422          */
 423         if (!MAGAZINE_FULL(cpucache->previous_magazine)) {
 424                 swap(cpucache->loaded_magazine, cpucache->previous_magazine);
 425                 loadedmag = cpucache->loaded_magazine;
 426                 loadedmag->objects[loadedmag->rounds++] = obj;
 427                 if (cpucache->waiting)
 428                         wakeup(&oc->depot[myclusterid]);
 429                 crit_exit();
 430                 return;
 431         }
 432
 433         /*
 434          * Both magazines full.  Get an empty magazine from the depot and
 435          * move a full loaded magazine to the depot.  Even though the
 436          * magazine may wind up with space available after we block on
 437          * the token, we still cycle it through to avoid the non-optimal
 438          * corner-case.
 439          *
 440          * Obtain the depot token.
 441          */
 442         depot = &oc->depot[myclusterid];
 443         if (!lwkt_trytoken(&ilock, &depot->token)) {
 444                 lwkt_gettoken(&ilock, &depot->token);
 445                 ++depot->contested;
 446         }
 447
 448         /*
 449          * If an empty magazine is available in the depot, cycle it
 450          * through and retry.
 451          */
 452         if (!SLIST_EMPTY(&depot->emptymagazines)) {
 453                 loadedmag = cpucache->previous_magazine;
 454                 cpucache->previous_magazine = cpucache->loaded_magazine;
 455                 cpucache->loaded_magazine = SLIST_FIRST(&depot->emptymagazines);
 456                 SLIST_REMOVE_HEAD(&depot->emptymagazines, nextmagazine);
 457
 458                 /*
 459                  * Return loadedmag to the depot.  Due to blocking it may
 460                  * not be entirely full and could even be empty.
 461                  */
 462                 if (MAGAZINE_EMPTY(loadedmag)) {
 463                         SLIST_INSERT_HEAD(&depot->emptymagazines,
 464                                           loadedmag, nextmagazine);
 465                 } else {
 466                         SLIST_INSERT_HEAD(&depot->fullmagazines,
 467                                           loadedmag, nextmagazine);
 468                         if (depot->waiting)
 469                                 wakeup(depot);
 470                 }
 471                 lwkt_reltoken(&ilock);
 472                 goto retry;
 473         }
 474
 475         /*
 476          * An empty mag is not available.  This is a corner case which can
 477          * occur due to cpus holding partially full magazines.  Do not try
 478          * to allocate a mag, just free the object.
 479          */
 480         ++depot->unallocated_objects;
 481         if (depot->waiting)
 482                 wakeup(depot);
 483         lwkt_reltoken(&ilock);
 484         crit_exit();
 485         oc->dtor(obj, oc->private);
 486         oc->free(obj, oc->allocator_args);
 487 }
 488
 489 /*
 490  * The object is being put back into the cache, but the caller has
 491  * indicated that the object is not in any shape to be reused and should
 492  * be dtor'd immediately.
 493  */
 494 void
 495 objcache_dtor(struct objcache *oc, void *obj)
 496 {
 497         struct magazinedepot *depot;
 498         lwkt_tokref ilock;
 499
 500         depot = &oc->depot[myclusterid];
 501         if (!lwkt_trytoken(&ilock, &depot->token)) {
 502                 lwkt_gettoken(&ilock, &depot->token);
 503                 ++depot->contested;
 504         }
 505         ++depot->unallocated_objects;
 506         if (depot->waiting)
 507                 wakeup(depot);
 508         lwkt_reltoken(&ilock);
 509         oc->dtor(obj, oc->private);
 510         oc->free(obj, oc->allocator_args);
 511 }
 512
 513 /*
 514  * Utility routine for objects that don't require any de-construction.
 515  */
 516 void
 517 null_dtor(void *obj, void *private)
 518 {
 519         /* do nothing */
 520 }
 521
 522 /*
 523  * De-construct and de-allocate objects in a magazine.
 524  * Returns the number of objects freed.
 525  * Does not de-allocate the magazine itself.
 526  */
 527 static int
 528 mag_purge(struct objcache *oc, struct magazine *mag)
 529 {
 530         int ndeleted;
 531         void *obj;
 532
 533         ndeleted = 0;
 534         crit_enter();
 535         while (mag->rounds) {
 536                 obj = mag->objects[--mag->rounds];
 537                 crit_exit();
 538                 oc->dtor(obj, oc->private);
 539                 oc->free(obj, oc->allocator_args);
 540                 ++ndeleted;
 541                 crit_enter();
 542         }
 543         crit_exit();
 544         return(ndeleted);
 545 }
 546
 547 /*
 548  * De-allocate all magazines in a magazine list.
 549  * Returns number of objects de-allocated.
 550  */
 551 static int
 552 maglist_purge(struct objcache *oc, struct magazinelist *maglist,
 553               boolean_t purgeall)
 554 {
 555         struct magazine *mag;
 556         int ndeleted = 0;
 557
 558         /* can't use SLIST_FOREACH because blocking releases the depot token */
 559         while ((mag = SLIST_FIRST(maglist))) {
 560                 SLIST_REMOVE_HEAD(maglist, nextmagazine);
 561                 ndeleted += mag_purge(oc, mag);         /* could block! */
 562                 free(mag, M_OBJMAG);                    /* could block! */
 563                 if (!purgeall && ndeleted > 0)
 564                         break;
 565         }
 566         return (ndeleted);
 567 }
 568
 569 /*
 570  * De-allocates all magazines on the full and empty magazine lists.
 571  */
 572 static void
 573 depot_purge(struct magazinedepot *depot, struct objcache *oc)
 574 {
 575         depot->unallocated_objects +=
 576                 maglist_purge(oc, &depot->fullmagazines, TRUE);
 577         depot->unallocated_objects +=
 578                 maglist_purge(oc, &depot->emptymagazines, TRUE);
 579         if (depot->unallocated_objects && depot->waiting)
 580                 wakeup(depot);
 581 }
 582
 583 #ifdef notneeded
 584 void
 585 objcache_reclaim(struct objcache *oc)
 586 {
 587         struct percpu_objcache *cache_percpu = &oc->cache_percpu[myclusterid];
 588         struct magazinedepot *depot = &oc->depot[myclusterid];
 589
 590         mag_purge(oc, cache_percpu->loaded_magazine);
 591         mag_purge(oc, cache_percpu->previous_magazine);
 592
 593         /* XXX need depot token */
 594         depot_purge(depot, oc);
 595 }
 596 #endif
 597
 598 /*
 599  * Try to free up some memory.  Return as soon as some free memory found.
 600  * For each object cache on the reclaim list, first try the current per-cpu
 601  * cache, then the full magazine depot.
 602  */
 603 boolean_t
 604 objcache_reclaimlist(struct objcache *oclist[], int nlist, int ocflags)
 605 {
 606         struct objcache *oc;
 607         struct percpu_objcache *cpucache;
 608         struct magazinedepot *depot;
 609         lwkt_tokref ilock;
 610         int i, ndel;
 611
 612         for (i = 0; i < nlist; i++) {
 613                 oc = oclist[i];
 614                 cpucache = &oc->cache_percpu[mycpuid];
 615                 depot = &oc->depot[myclusterid];
 616
 617                 crit_enter();
 618                 if ((ndel = mag_purge(oc, cpucache->loaded_magazine)) > 0 ||
 619                     (ndel = mag_purge(oc, cpucache->previous_magazine)) > 0) {
 620                         crit_exit();
 621                         lwkt_gettoken(&ilock, &depot->token);
 622                         depot->unallocated_objects += ndel;
 623                         if (depot->unallocated_objects && depot->waiting)
 624                                 wakeup(depot);
 625                         lwkt_reltoken(&ilock);
 626                         return (TRUE);
 627                 }
 628                 crit_exit();
 629                 lwkt_gettoken(&ilock, &depot->token);
 630                 if ((ndel =
 631                      maglist_purge(oc, &depot->fullmagazines, FALSE)) > 0) {
 632                         depot->unallocated_objects += ndel;
 633                         if (depot->unallocated_objects && depot->waiting)
 634                                 wakeup(depot);
 635                         lwkt_reltoken(&ilock);
 636                         return (TRUE);
 637                 }
 638                 lwkt_reltoken(&ilock);
 639         }
 640         return (FALSE);
 641 }
 642
 643 /*
 644  * Destroy an object cache.  Must have no existing references.
 645  * XXX Not clear this is a useful API function.
 646  */
 647 void
 648 objcache_destroy(struct objcache *oc)
 649 {
 650         struct percpu_objcache *cache_percpu;
 651         int clusterid, cpuid;
 652
 653         /* XXX need depot token? */
 654         for (clusterid = 0; clusterid < MAXCLUSTERS; clusterid++)
 655                 depot_purge(&oc->depot[clusterid], oc);
 656
 657         for (cpuid = 0; cpuid < ncpus; cpuid++) {
 658                 cache_percpu = &oc->cache_percpu[cpuid];
 659
 660                 mag_purge(oc, cache_percpu->loaded_magazine);
 661                 free(cache_percpu->loaded_magazine, M_OBJMAG);
 662
 663                 mag_purge(oc, cache_percpu->previous_magazine);
 664                 free(cache_percpu->previous_magazine, M_OBJMAG);
 665         }
 666
 667         free(oc->name, M_TEMP);
 668         free(oc, M_OBJCACHE);
 669 }
 670
 671 #if 0
 672 /*
 673  * Populate the per-cluster depot with elements from a linear block
 674  * of memory.  Must be called for individually for each cluster.
 675  * Populated depots should not be destroyed.
 676  */
 677 void
 678 objcache_populate_linear(struct objcache *oc, void *base, int nelts, int size)
 679 {
 680         char *p = base;
 681         char *end = (char *)base + (nelts * size);
 682         struct magazinedepot *depot = &oc->depot[myclusterid];
 683         lwkt_tokref ilock;
 684         struct magazine sentinelfullmag = { 0, 0 };
 685         struct magazine *emptymag = &sentinelfullmag;
 686
 687         lwkt_gettoken(&ilock, &depot->token);
 688         while (p < end) {
 689                 if (MAGAZINE_FULL(emptymag)) {
 690                         emptymag = mag_alloc(depot->magcapacity);
 691                         SLIST_INSERT_HEAD(&depot->fullmagazines, emptymag,
 692                                           nextmagazine);
 693                 }
 694                 emptymag->objects[emptymag->rounds++] = p;
 695                 p += size;
 696         }
 697         depot->unallocated_objects += nelts;
 698         if (depot->unallocated_objects && depot->waiting)
 699                 wakeup(depot);
 700         lwkt_reltoken(&ilock);
 701 }
 702 #endif
 703
 704 #if 0
 705 /*
 706  * Check depot contention once a minute.
 707  * 2 contested locks per second allowed.
 708  */
 709 static int objcache_rebalance_period;
 710 static const int objcache_contention_rate = 120;
 711 static struct callout objcache_callout;
 712
 713 #define MAXMAGSIZE 512
 714
 715 /*
 716  * Check depot contention and increase magazine size if necessary.
 717  */
 718 static void
 719 objcache_timer(void *dummy)
 720 {
 721         struct objcache *oc;
 722         struct magazinedepot *depot;
 723         lwkt_tokref olock, dlock;
 724
 725         lwkt_gettoken(&olock, &objcachelist_token);
 726         SLIST_FOREACH(oc, &allobjcaches, oc_next) {
 727                 depot = &oc->depot[myclusterid];
 728                 if (depot->magcapacity < MAXMAGSIZE) {
 729                         if (depot->contested > objcache_contention_rate) {
 730                                 lwkt_gettoken(&dlock, &depot->token);
 731                                 depot_purge(depot, oc);
 732                                 depot->magcapacity *= 2;
 733                                 lwkt_reltoken(&dlock);
 734                                 printf("objcache_timer: increasing cache %s"
 735                                        " magsize to %d, contested %d times\n",
 736                                     oc->name, depot->magcapacity,
 737                                     depot->contested);
 738                         }
 739                         depot->contested = 0;
 740                 }
 741         }
 742         lwkt_reltoken(&olock);
 743
 744         callout_reset(&objcache_callout, objcache_rebalance_period,
 745                       objcache_timer, NULL);
 746 }
 747
 748 #endif
 749
 750 static void
 751 objcache_init(void)
 752 {
 753         lwkt_token_init(&objcachelist_token);
 754 #if 0
 755         callout_init(&objcache_callout);
 756         objcache_rebalance_period = 60 * hz;
 757         callout_reset(&objcache_callout, objcache_rebalance_period,
 758                       objcache_timer, NULL);
 759 #endif
 760 }
 761 SYSINIT(objcache, SI_SUB_CPU, SI_ORDER_ANY, objcache_init, 0);