sys/vm/uma_core.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2002-2019 Jeffrey Roberson <jeff@FreeBSD.org>
   5  * Copyright (c) 2004, 2005 Bosko Milekic <bmilekic@FreeBSD.org>
   6  * Copyright (c) 2004-2006 Robert N. M. Watson
   7  * All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice unmodified, this list of conditions, and the following
  14  *    disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  20  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  21  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  22  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  23  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  24  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  28  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 /*
  32  * uma_core.c  Implementation of the Universal Memory allocator
  33  *
  34  * This allocator is intended to replace the multitude of similar object caches
  35  * in the standard FreeBSD kernel.  The intent is to be flexible as well as
  36  * efficient.  A primary design goal is to return unused memory to the rest of
  37  * the system.  This will make the system as a whole more flexible due to the
  38  * ability to move memory to subsystems which most need it instead of leaving
  39  * pools of reserved memory unused.
  40  *
  41  * The basic ideas stem from similar slab/zone based allocators whose algorithms
  42  * are well known.
  43  *
  44  */
  45
  46 /*
  47  * TODO:
  48  *      - Improve memory usage for large allocations
  49  *      - Investigate cache size adjustments
  50  */
  51
  52 #include <sys/cdefs.h>
  53 __FBSDID("$FreeBSD$");
  54
  55 #include "opt_ddb.h"
  56 #include "opt_param.h"
  57 #include "opt_vm.h"
  58
  59 #include <sys/param.h>
  60 #include <sys/systm.h>
  61 #include <sys/asan.h>
  62 #include <sys/bitset.h>
  63 #include <sys/domainset.h>
  64 #include <sys/eventhandler.h>
  65 #include <sys/kernel.h>
  66 #include <sys/types.h>
  67 #include <sys/limits.h>
  68 #include <sys/queue.h>
  69 #include <sys/malloc.h>
  70 #include <sys/ktr.h>
  71 #include <sys/lock.h>
  72 #include <sys/sysctl.h>
  73 #include <sys/mutex.h>
  74 #include <sys/proc.h>
  75 #include <sys/random.h>
  76 #include <sys/rwlock.h>
  77 #include <sys/sbuf.h>
  78 #include <sys/sched.h>
  79 #include <sys/sleepqueue.h>
  80 #include <sys/smp.h>
  81 #include <sys/smr.h>
  82 #include <sys/taskqueue.h>
  83 #include <sys/vmmeter.h>
  84
  85 #include <vm/vm.h>
  86 #include <vm/vm_param.h>
  87 #include <vm/vm_domainset.h>
  88 #include <vm/vm_object.h>
  89 #include <vm/vm_page.h>
  90 #include <vm/vm_pageout.h>
  91 #include <vm/vm_phys.h>
  92 #include <vm/vm_pagequeue.h>
  93 #include <vm/vm_map.h>
  94 #include <vm/vm_kern.h>
  95 #include <vm/vm_extern.h>
  96 #include <vm/vm_dumpset.h>
  97 #include <vm/uma.h>
  98 #include <vm/uma_int.h>
  99 #include <vm/uma_dbg.h>
 100
 101 #include <ddb/ddb.h>
 102
 103 #ifdef DEBUG_MEMGUARD
 104 #include <vm/memguard.h>
 105 #endif
 106
 107 #include <machine/md_var.h>
 108
 109 #ifdef INVARIANTS
 110 #define UMA_ALWAYS_CTORDTOR     1
 111 #else
 112 #define UMA_ALWAYS_CTORDTOR     0
 113 #endif
 114
 115 /*
 116  * This is the zone and keg from which all zones are spawned.
 117  */
 118 static uma_zone_t kegs;
 119 static uma_zone_t zones;
 120
 121 /*
 122  * On INVARIANTS builds, the slab contains a second bitset of the same size,
 123  * "dbg_bits", which is laid out immediately after us_free.
 124  */
 125 #ifdef INVARIANTS
 126 #define SLAB_BITSETS    2
 127 #else
 128 #define SLAB_BITSETS    1
 129 #endif
 130
 131 /*
 132  * These are the two zones from which all offpage uma_slab_ts are allocated.
 133  *
 134  * One zone is for slab headers that can represent a larger number of items,
 135  * making the slabs themselves more efficient, and the other zone is for
 136  * headers that are smaller and represent fewer items, making the headers more
 137  * efficient.
 138  */
 139 #define SLABZONE_SIZE(setsize)                                  \
 140     (sizeof(struct uma_hash_slab) + BITSET_SIZE(setsize) * SLAB_BITSETS)
 141 #define SLABZONE0_SETSIZE       (PAGE_SIZE / 16)
 142 #define SLABZONE1_SETSIZE       SLAB_MAX_SETSIZE
 143 #define SLABZONE0_SIZE  SLABZONE_SIZE(SLABZONE0_SETSIZE)
 144 #define SLABZONE1_SIZE  SLABZONE_SIZE(SLABZONE1_SETSIZE)
 145 static uma_zone_t slabzones[2];
 146
 147 /*
 148  * The initial hash tables come out of this zone so they can be allocated
 149  * prior to malloc coming up.
 150  */
 151 static uma_zone_t hashzone;
 152
 153 /* The boot-time adjusted value for cache line alignment. */
 154 int uma_align_cache = 64 - 1;
 155
 156 static MALLOC_DEFINE(M_UMAHASH, "UMAHash", "UMA Hash Buckets");
 157 static MALLOC_DEFINE(M_UMA, "UMA", "UMA Misc");
 158
 159 /*
 160  * Are we allowed to allocate buckets?
 161  */
 162 static int bucketdisable = 1;
 163
 164 /* Linked list of all kegs in the system */
 165 static LIST_HEAD(,uma_keg) uma_kegs = LIST_HEAD_INITIALIZER(uma_kegs);
 166
 167 /* Linked list of all cache-only zones in the system */
 168 static LIST_HEAD(,uma_zone) uma_cachezones =
 169     LIST_HEAD_INITIALIZER(uma_cachezones);
 170
 171 /*
 172  * Mutex for global lists: uma_kegs, uma_cachezones, and the per-keg list of
 173  * zones.
 174  */
 175 static struct rwlock_padalign __exclusive_cache_line uma_rwlock;
 176
 177 static struct sx uma_reclaim_lock;
 178
 179 /*
 180  * First available virual address for boot time allocations.
 181  */
 182 static vm_offset_t bootstart;
 183 static vm_offset_t bootmem;
 184
 185 /*
 186  * kmem soft limit, initialized by uma_set_limit().  Ensure that early
 187  * allocations don't trigger a wakeup of the reclaim thread.
 188  */
 189 unsigned long uma_kmem_limit = LONG_MAX;
 190 SYSCTL_ULONG(_vm, OID_AUTO, uma_kmem_limit, CTLFLAG_RD, &uma_kmem_limit, 0,
 191     "UMA kernel memory soft limit");
 192 unsigned long uma_kmem_total;
 193 SYSCTL_ULONG(_vm, OID_AUTO, uma_kmem_total, CTLFLAG_RD, &uma_kmem_total, 0,
 194     "UMA kernel memory usage");
 195
 196 /* Is the VM done starting up? */
 197 static enum {
 198         BOOT_COLD,
 199         BOOT_KVA,
 200         BOOT_PCPU,
 201         BOOT_RUNNING,
 202         BOOT_SHUTDOWN,
 203 } booted = BOOT_COLD;
 204
 205 /*
 206  * This is the handle used to schedule events that need to happen
 207  * outside of the allocation fast path.
 208  */
 209 static struct callout uma_callout;
 210 #define UMA_TIMEOUT     20              /* Seconds for callout interval. */
 211
 212 /*
 213  * This structure is passed as the zone ctor arg so that I don't have to create
 214  * a special allocation function just for zones.
 215  */
 216 struct uma_zctor_args {
 217         const char *name;
 218         size_t size;
 219         uma_ctor ctor;
 220         uma_dtor dtor;
 221         uma_init uminit;
 222         uma_fini fini;
 223         uma_import import;
 224         uma_release release;
 225         void *arg;
 226         uma_keg_t keg;
 227         int align;
 228         uint32_t flags;
 229 };
 230
 231 struct uma_kctor_args {
 232         uma_zone_t zone;
 233         size_t size;
 234         uma_init uminit;
 235         uma_fini fini;
 236         int align;
 237         uint32_t flags;
 238 };
 239
 240 struct uma_bucket_zone {
 241         uma_zone_t      ubz_zone;
 242         const char      *ubz_name;
 243         int             ubz_entries;    /* Number of items it can hold. */
 244         int             ubz_maxsize;    /* Maximum allocation size per-item. */
 245 };
 246
 247 /*
 248  * Compute the actual number of bucket entries to pack them in power
 249  * of two sizes for more efficient space utilization.
 250  */
 251 #define BUCKET_SIZE(n)                                          \
 252     (((sizeof(void *) * (n)) - sizeof(struct uma_bucket)) / sizeof(void *))
 253
 254 #define BUCKET_MAX      BUCKET_SIZE(256)
 255
 256 struct uma_bucket_zone bucket_zones[] = {
 257         /* Literal bucket sizes. */
 258         { NULL, "2 Bucket", 2, 4096 },
 259         { NULL, "4 Bucket", 4, 3072 },
 260         { NULL, "8 Bucket", 8, 2048 },
 261         { NULL, "16 Bucket", 16, 1024 },
 262         /* Rounded down power of 2 sizes for efficiency. */
 263         { NULL, "32 Bucket", BUCKET_SIZE(32), 512 },
 264         { NULL, "64 Bucket", BUCKET_SIZE(64), 256 },
 265         { NULL, "128 Bucket", BUCKET_SIZE(128), 128 },
 266         { NULL, "256 Bucket", BUCKET_SIZE(256), 64 },
 267         { NULL, NULL, 0}
 268 };
 269
 270 /*
 271  * Flags and enumerations to be passed to internal functions.
 272  */
 273 enum zfreeskip {
 274         SKIP_NONE =     0,
 275         SKIP_CNT =      0x00000001,
 276         SKIP_DTOR =     0x00010000,
 277         SKIP_FINI =     0x00020000,
 278 };
 279
 280 /* Prototypes.. */
 281
 282 void    uma_startup1(vm_offset_t);
 283 void    uma_startup2(void);
 284
 285 static void *noobj_alloc(uma_zone_t, vm_size_t, int, uint8_t *, int);
 286 static void *page_alloc(uma_zone_t, vm_size_t, int, uint8_t *, int);
 287 static void *pcpu_page_alloc(uma_zone_t, vm_size_t, int, uint8_t *, int);
 288 static void *startup_alloc(uma_zone_t, vm_size_t, int, uint8_t *, int);
 289 static void *contig_alloc(uma_zone_t, vm_size_t, int, uint8_t *, int);
 290 static void page_free(void *, vm_size_t, uint8_t);
 291 static void pcpu_page_free(void *, vm_size_t, uint8_t);
 292 static uma_slab_t keg_alloc_slab(uma_keg_t, uma_zone_t, int, int, int);
 293 static void cache_drain(uma_zone_t);
 294 static void bucket_drain(uma_zone_t, uma_bucket_t);
 295 static void bucket_cache_reclaim(uma_zone_t zone, bool, int);
 296 static bool bucket_cache_reclaim_domain(uma_zone_t, bool, bool, int);
 297 static int keg_ctor(void *, int, void *, int);
 298 static void keg_dtor(void *, int, void *);
 299 static void keg_drain(uma_keg_t keg, int domain);
 300 static int zone_ctor(void *, int, void *, int);
 301 static void zone_dtor(void *, int, void *);
 302 static inline void item_dtor(uma_zone_t zone, void *item, int size,
 303     void *udata, enum zfreeskip skip);
 304 static int zero_init(void *, int, int);
 305 static void zone_free_bucket(uma_zone_t zone, uma_bucket_t bucket, void *udata,
 306     int itemdomain, bool ws);
 307 static void zone_foreach(void (*zfunc)(uma_zone_t, void *), void *);
 308 static void zone_foreach_unlocked(void (*zfunc)(uma_zone_t, void *), void *);
 309 static void zone_timeout(uma_zone_t zone, void *);
 310 static int hash_alloc(struct uma_hash *, u_int);
 311 static int hash_expand(struct uma_hash *, struct uma_hash *);
 312 static void hash_free(struct uma_hash *hash);
 313 static void uma_timeout(void *);
 314 static void uma_shutdown(void);
 315 static void *zone_alloc_item(uma_zone_t, void *, int, int);
 316 static void zone_free_item(uma_zone_t, void *, void *, enum zfreeskip);
 317 static int zone_alloc_limit(uma_zone_t zone, int count, int flags);
 318 static void zone_free_limit(uma_zone_t zone, int count);
 319 static void bucket_enable(void);
 320 static void bucket_init(void);
 321 static uma_bucket_t bucket_alloc(uma_zone_t zone, void *, int);
 322 static void bucket_free(uma_zone_t zone, uma_bucket_t, void *);
 323 static void bucket_zone_drain(int domain);
 324 static uma_bucket_t zone_alloc_bucket(uma_zone_t, void *, int, int);
 325 static void *slab_alloc_item(uma_keg_t keg, uma_slab_t slab);
 326 static void slab_free_item(uma_zone_t zone, uma_slab_t slab, void *item);
 327 static size_t slab_sizeof(int nitems);
 328 static uma_keg_t uma_kcreate(uma_zone_t zone, size_t size, uma_init uminit,
 329     uma_fini fini, int align, uint32_t flags);
 330 static int zone_import(void *, void **, int, int, int);
 331 static void zone_release(void *, void **, int);
 332 static bool cache_alloc(uma_zone_t, uma_cache_t, void *, int);
 333 static bool cache_free(uma_zone_t, uma_cache_t, void *, void *, int);
 334
 335 static int sysctl_vm_zone_count(SYSCTL_HANDLER_ARGS);
 336 static int sysctl_vm_zone_stats(SYSCTL_HANDLER_ARGS);
 337 static int sysctl_handle_uma_zone_allocs(SYSCTL_HANDLER_ARGS);
 338 static int sysctl_handle_uma_zone_frees(SYSCTL_HANDLER_ARGS);
 339 static int sysctl_handle_uma_zone_flags(SYSCTL_HANDLER_ARGS);
 340 static int sysctl_handle_uma_slab_efficiency(SYSCTL_HANDLER_ARGS);
 341 static int sysctl_handle_uma_zone_items(SYSCTL_HANDLER_ARGS);
 342
 343 static uint64_t uma_zone_get_allocs(uma_zone_t zone);
 344
 345 static SYSCTL_NODE(_vm, OID_AUTO, debug, CTLFLAG_RD | CTLFLAG_MPSAFE, 0,
 346     "Memory allocation debugging");
 347
 348 #ifdef INVARIANTS
 349 static uint64_t uma_keg_get_allocs(uma_keg_t zone);
 350 static inline struct noslabbits *slab_dbg_bits(uma_slab_t slab, uma_keg_t keg);
 351
 352 static bool uma_dbg_kskip(uma_keg_t keg, void *mem);
 353 static bool uma_dbg_zskip(uma_zone_t zone, void *mem);
 354 static void uma_dbg_free(uma_zone_t zone, uma_slab_t slab, void *item);
 355 static void uma_dbg_alloc(uma_zone_t zone, uma_slab_t slab, void *item);
 356
 357 static u_int dbg_divisor = 1;
 358 SYSCTL_UINT(_vm_debug, OID_AUTO, divisor,
 359     CTLFLAG_RDTUN | CTLFLAG_NOFETCH, &dbg_divisor, 0,
 360     "Debug & thrash every this item in memory allocator");
 361
 362 static counter_u64_t uma_dbg_cnt = EARLY_COUNTER;
 363 static counter_u64_t uma_skip_cnt = EARLY_COUNTER;
 364 SYSCTL_COUNTER_U64(_vm_debug, OID_AUTO, trashed, CTLFLAG_RD,
 365     &uma_dbg_cnt, "memory items debugged");
 366 SYSCTL_COUNTER_U64(_vm_debug, OID_AUTO, skipped, CTLFLAG_RD,
 367     &uma_skip_cnt, "memory items skipped, not debugged");
 368 #endif
 369
 370 SYSCTL_NODE(_vm, OID_AUTO, uma, CTLFLAG_RW | CTLFLAG_MPSAFE, 0,
 371     "Universal Memory Allocator");
 372
 373 SYSCTL_PROC(_vm, OID_AUTO, zone_count, CTLFLAG_RD|CTLFLAG_MPSAFE|CTLTYPE_INT,
 374     0, 0, sysctl_vm_zone_count, "I", "Number of UMA zones");
 375
 376 SYSCTL_PROC(_vm, OID_AUTO, zone_stats, CTLFLAG_RD|CTLFLAG_MPSAFE|CTLTYPE_STRUCT,
 377     0, 0, sysctl_vm_zone_stats, "s,struct uma_type_header", "Zone Stats");
 378
 379 static int zone_warnings = 1;
 380 SYSCTL_INT(_vm, OID_AUTO, zone_warnings, CTLFLAG_RWTUN, &zone_warnings, 0,
 381     "Warn when UMA zones becomes full");
 382
 383 static int multipage_slabs = 1;
 384 TUNABLE_INT("vm.debug.uma_multipage_slabs", &multipage_slabs);
 385 SYSCTL_INT(_vm_debug, OID_AUTO, uma_multipage_slabs,
 386     CTLFLAG_RDTUN | CTLFLAG_NOFETCH, &multipage_slabs, 0,
 387     "UMA may choose larger slab sizes for better efficiency");
 388
 389 /*
 390  * Select the slab zone for an offpage slab with the given maximum item count.
 391  */
 392 static inline uma_zone_t
 393 slabzone(int ipers)
 394 {
 395
 396         return (slabzones[ipers > SLABZONE0_SETSIZE]);
 397 }
 398
 399 /*
 400  * This routine checks to see whether or not it's safe to enable buckets.
 401  */
 402 static void
 403 bucket_enable(void)
 404 {
 405
 406         KASSERT(booted >= BOOT_KVA, ("Bucket enable before init"));
 407         bucketdisable = vm_page_count_min();
 408 }
 409
 410 /*
 411  * Initialize bucket_zones, the array of zones of buckets of various sizes.
 412  *
 413  * For each zone, calculate the memory required for each bucket, consisting
 414  * of the header and an array of pointers.
 415  */
 416 static void
 417 bucket_init(void)
 418 {
 419         struct uma_bucket_zone *ubz;
 420         int size;
 421
 422         for (ubz = &bucket_zones[0]; ubz->ubz_entries != 0; ubz++) {
 423                 size = roundup(sizeof(struct uma_bucket), sizeof(void *));
 424                 size += sizeof(void *) * ubz->ubz_entries;
 425                 ubz->ubz_zone = uma_zcreate(ubz->ubz_name, size,
 426                     NULL, NULL, NULL, NULL, UMA_ALIGN_PTR,
 427                     UMA_ZONE_MTXCLASS | UMA_ZFLAG_BUCKET |
 428                     UMA_ZONE_FIRSTTOUCH);
 429         }
 430 }
 431
 432 /*
 433  * Given a desired number of entries for a bucket, return the zone from which
 434  * to allocate the bucket.
 435  */
 436 static struct uma_bucket_zone *
 437 bucket_zone_lookup(int entries)
 438 {
 439         struct uma_bucket_zone *ubz;
 440
 441         for (ubz = &bucket_zones[0]; ubz->ubz_entries != 0; ubz++)
 442                 if (ubz->ubz_entries >= entries)
 443                         return (ubz);
 444         ubz--;
 445         return (ubz);
 446 }
 447
 448 static int
 449 bucket_select(int size)
 450 {
 451         struct uma_bucket_zone *ubz;
 452
 453         ubz = &bucket_zones[0];
 454         if (size > ubz->ubz_maxsize)
 455                 return MAX((ubz->ubz_maxsize * ubz->ubz_entries) / size, 1);
 456
 457         for (; ubz->ubz_entries != 0; ubz++)
 458                 if (ubz->ubz_maxsize < size)
 459                         break;
 460         ubz--;
 461         return (ubz->ubz_entries);
 462 }
 463
 464 static uma_bucket_t
 465 bucket_alloc(uma_zone_t zone, void *udata, int flags)
 466 {
 467         struct uma_bucket_zone *ubz;
 468         uma_bucket_t bucket;
 469
 470         /*
 471          * Don't allocate buckets early in boot.
 472          */
 473         if (__predict_false(booted < BOOT_KVA))
 474                 return (NULL);
 475
 476         /*
 477          * To limit bucket recursion we store the original zone flags
 478          * in a cookie passed via zalloc_arg/zfree_arg.  This allows the
 479          * NOVM flag to persist even through deep recursions.  We also
 480          * store ZFLAG_BUCKET once we have recursed attempting to allocate
 481          * a bucket for a bucket zone so we do not allow infinite bucket
 482          * recursion.  This cookie will even persist to frees of unused
 483          * buckets via the allocation path or bucket allocations in the
 484          * free path.
 485          */
 486         if ((zone->uz_flags & UMA_ZFLAG_BUCKET) == 0)
 487                 udata = (void *)(uintptr_t)zone->uz_flags;
 488         else {
 489                 if ((uintptr_t)udata & UMA_ZFLAG_BUCKET)
 490                         return (NULL);
 491                 udata = (void *)((uintptr_t)udata | UMA_ZFLAG_BUCKET);
 492         }
 493         if (((uintptr_t)udata & UMA_ZONE_VM) != 0)
 494                 flags |= M_NOVM;
 495         ubz = bucket_zone_lookup(atomic_load_16(&zone->uz_bucket_size));
 496         if (ubz->ubz_zone == zone && (ubz + 1)->ubz_entries != 0)
 497                 ubz++;
 498         bucket = uma_zalloc_arg(ubz->ubz_zone, udata, flags);
 499         if (bucket) {
 500 #ifdef INVARIANTS
 501                 bzero(bucket->ub_bucket, sizeof(void *) * ubz->ubz_entries);
 502 #endif
 503                 bucket->ub_cnt = 0;
 504                 bucket->ub_entries = min(ubz->ubz_entries,
 505                     zone->uz_bucket_size_max);
 506                 bucket->ub_seq = SMR_SEQ_INVALID;
 507                 CTR3(KTR_UMA, "bucket_alloc: zone %s(%p) allocated bucket %p",
 508                     zone->uz_name, zone, bucket);
 509         }
 510
 511         return (bucket);
 512 }
 513
 514 static void
 515 bucket_free(uma_zone_t zone, uma_bucket_t bucket, void *udata)
 516 {
 517         struct uma_bucket_zone *ubz;
 518
 519         if (bucket->ub_cnt != 0)
 520                 bucket_drain(zone, bucket);
 521
 522         KASSERT(bucket->ub_cnt == 0,
 523             ("bucket_free: Freeing a non free bucket."));
 524         KASSERT(bucket->ub_seq == SMR_SEQ_INVALID,
 525             ("bucket_free: Freeing an SMR bucket."));
 526         if ((zone->uz_flags & UMA_ZFLAG_BUCKET) == 0)
 527                 udata = (void *)(uintptr_t)zone->uz_flags;
 528         ubz = bucket_zone_lookup(bucket->ub_entries);
 529         uma_zfree_arg(ubz->ubz_zone, bucket, udata);
 530 }
 531
 532 static void
 533 bucket_zone_drain(int domain)
 534 {
 535         struct uma_bucket_zone *ubz;
 536
 537         for (ubz = &bucket_zones[0]; ubz->ubz_entries != 0; ubz++)
 538                 uma_zone_reclaim_domain(ubz->ubz_zone, UMA_RECLAIM_DRAIN,
 539                     domain);
 540 }
 541
 542 #ifdef KASAN
 543 _Static_assert(UMA_SMALLEST_UNIT % KASAN_SHADOW_SCALE == 0,
 544     "Base UMA allocation size not a multiple of the KASAN scale factor");
 545
 546 static void
 547 kasan_mark_item_valid(uma_zone_t zone, void *item)
 548 {
 549         void *pcpu_item;
 550         size_t sz, rsz;
 551         int i;
 552
 553         if ((zone->uz_flags & UMA_ZONE_NOKASAN) != 0)
 554                 return;
 555
 556         sz = zone->uz_size;
 557         rsz = roundup2(sz, KASAN_SHADOW_SCALE);
 558         if ((zone->uz_flags & UMA_ZONE_PCPU) == 0) {
 559                 kasan_mark(item, sz, rsz, KASAN_GENERIC_REDZONE);
 560         } else {
 561                 pcpu_item = zpcpu_base_to_offset(item);
 562                 for (i = 0; i <= mp_maxid; i++)
 563                         kasan_mark(zpcpu_get_cpu(pcpu_item, i), sz, rsz,
 564                             KASAN_GENERIC_REDZONE);
 565         }
 566 }
 567
 568 static void
 569 kasan_mark_item_invalid(uma_zone_t zone, void *item)
 570 {
 571         void *pcpu_item;
 572         size_t sz;
 573         int i;
 574
 575         if ((zone->uz_flags & UMA_ZONE_NOKASAN) != 0)
 576                 return;
 577
 578         sz = roundup2(zone->uz_size, KASAN_SHADOW_SCALE);
 579         if ((zone->uz_flags & UMA_ZONE_PCPU) == 0) {
 580                 kasan_mark(item, 0, sz, KASAN_UMA_FREED);
 581         } else {
 582                 pcpu_item = zpcpu_base_to_offset(item);
 583                 for (i = 0; i <= mp_maxid; i++)
 584                         kasan_mark(zpcpu_get_cpu(pcpu_item, i), 0, sz,
 585                             KASAN_UMA_FREED);
 586         }
 587 }
 588
 589 static void
 590 kasan_mark_slab_valid(uma_keg_t keg, void *mem)
 591 {
 592         size_t sz;
 593
 594         if ((keg->uk_flags & UMA_ZONE_NOKASAN) == 0) {
 595                 sz = keg->uk_ppera * PAGE_SIZE;
 596                 kasan_mark(mem, sz, sz, 0);
 597         }
 598 }
 599
 600 static void
 601 kasan_mark_slab_invalid(uma_keg_t keg, void *mem)
 602 {
 603         size_t sz;
 604
 605         if ((keg->uk_flags & UMA_ZONE_NOKASAN) == 0) {
 606                 if ((keg->uk_flags & UMA_ZFLAG_OFFPAGE) != 0)
 607                         sz = keg->uk_ppera * PAGE_SIZE;
 608                 else
 609                         sz = keg->uk_pgoff;
 610                 kasan_mark(mem, 0, sz, KASAN_UMA_FREED);
 611         }
 612 }
 613 #else /* !KASAN */
 614 static void
 615 kasan_mark_item_valid(uma_zone_t zone __unused, void *item __unused)
 616 {
 617 }
 618
 619 static void
 620 kasan_mark_item_invalid(uma_zone_t zone __unused, void *item __unused)
 621 {
 622 }
 623
 624 static void
 625 kasan_mark_slab_valid(uma_keg_t keg __unused, void *mem __unused)
 626 {
 627 }
 628
 629 static void
 630 kasan_mark_slab_invalid(uma_keg_t keg __unused, void *mem __unused)
 631 {
 632 }
 633 #endif /* KASAN */
 634
 635 /*
 636  * Acquire the domain lock and record contention.
 637  */
 638 static uma_zone_domain_t
 639 zone_domain_lock(uma_zone_t zone, int domain)
 640 {
 641         uma_zone_domain_t zdom;
 642         bool lockfail;
 643
 644         zdom = ZDOM_GET(zone, domain);
 645         lockfail = false;
 646         if (ZDOM_OWNED(zdom))
 647                 lockfail = true;
 648         ZDOM_LOCK(zdom);
 649         /* This is unsynchronized.  The counter does not need to be precise. */
 650         if (lockfail && zone->uz_bucket_size < zone->uz_bucket_size_max)
 651                 zone->uz_bucket_size++;
 652         return (zdom);
 653 }
 654
 655 /*
 656  * Search for the domain with the least cached items and return it if it
 657  * is out of balance with the preferred domain.
 658  */
 659 static __noinline int
 660 zone_domain_lowest(uma_zone_t zone, int pref)
 661 {
 662         long least, nitems, prefitems;
 663         int domain;
 664         int i;
 665
 666         prefitems = least = LONG_MAX;
 667         domain = 0;
 668         for (i = 0; i < vm_ndomains; i++) {
 669                 nitems = ZDOM_GET(zone, i)->uzd_nitems;
 670                 if (nitems < least) {
 671                         domain = i;
 672                         least = nitems;
 673                 }
 674                 if (domain == pref)
 675                         prefitems = nitems;
 676         }
 677         if (prefitems < least * 2)
 678                 return (pref);
 679
 680         return (domain);
 681 }
 682
 683 /*
 684  * Search for the domain with the most cached items and return it or the
 685  * preferred domain if it has enough to proceed.
 686  */
 687 static __noinline int
 688 zone_domain_highest(uma_zone_t zone, int pref)
 689 {
 690         long most, nitems;
 691         int domain;
 692         int i;
 693
 694         if (ZDOM_GET(zone, pref)->uzd_nitems > BUCKET_MAX)
 695                 return (pref);
 696
 697         most = 0;
 698         domain = 0;
 699         for (i = 0; i < vm_ndomains; i++) {
 700                 nitems = ZDOM_GET(zone, i)->uzd_nitems;
 701                 if (nitems > most) {
 702                         domain = i;
 703                         most = nitems;
 704                 }
 705         }
 706
 707         return (domain);
 708 }
 709
 710 /*
 711  * Set the maximum imax value.
 712  */
 713 static void
 714 zone_domain_imax_set(uma_zone_domain_t zdom, int nitems)
 715 {
 716         long old;
 717
 718         old = zdom->uzd_imax;
 719         do {
 720                 if (old >= nitems)
 721                         return;
 722         } while (atomic_fcmpset_long(&zdom->uzd_imax, &old, nitems) == 0);
 723
 724         /*
 725          * We are at new maximum, so do the last WSS update for the old
 726          * bimin and prepare to measure next allocation batch.
 727          */
 728         if (zdom->uzd_wss < old - zdom->uzd_bimin)
 729                 zdom->uzd_wss = old - zdom->uzd_bimin;
 730         zdom->uzd_bimin = nitems;
 731 }
 732
 733 /*
 734  * Attempt to satisfy an allocation by retrieving a full bucket from one of the
 735  * zone's caches.  If a bucket is found the zone is not locked on return.
 736  */
 737 static uma_bucket_t
 738 zone_fetch_bucket(uma_zone_t zone, uma_zone_domain_t zdom, bool reclaim)
 739 {
 740         uma_bucket_t bucket;
 741         long cnt;
 742         int i;
 743         bool dtor = false;
 744
 745         ZDOM_LOCK_ASSERT(zdom);
 746
 747         if ((bucket = STAILQ_FIRST(&zdom->uzd_buckets)) == NULL)
 748                 return (NULL);
 749
 750         /* SMR Buckets can not be re-used until readers expire. */
 751         if ((zone->uz_flags & UMA_ZONE_SMR) != 0 &&
 752             bucket->ub_seq != SMR_SEQ_INVALID) {
 753                 if (!smr_poll(zone->uz_smr, bucket->ub_seq, false))
 754                         return (NULL);
 755                 bucket->ub_seq = SMR_SEQ_INVALID;
 756                 dtor = (zone->uz_dtor != NULL) || UMA_ALWAYS_CTORDTOR;
 757                 if (STAILQ_NEXT(bucket, ub_link) != NULL)
 758                         zdom->uzd_seq = STAILQ_NEXT(bucket, ub_link)->ub_seq;
 759         }
 760         STAILQ_REMOVE_HEAD(&zdom->uzd_buckets, ub_link);
 761
 762         KASSERT(zdom->uzd_nitems >= bucket->ub_cnt,
 763             ("%s: item count underflow (%ld, %d)",
 764             __func__, zdom->uzd_nitems, bucket->ub_cnt));
 765         KASSERT(bucket->ub_cnt > 0,
 766             ("%s: empty bucket in bucket cache", __func__));
 767         zdom->uzd_nitems -= bucket->ub_cnt;
 768
 769         if (reclaim) {
 770                 /*
 771                  * Shift the bounds of the current WSS interval to avoid
 772                  * perturbing the estimates.
 773                  */
 774                 cnt = lmin(zdom->uzd_bimin, bucket->ub_cnt);
 775                 atomic_subtract_long(&zdom->uzd_imax, cnt);
 776                 zdom->uzd_bimin -= cnt;
 777                 zdom->uzd_imin -= lmin(zdom->uzd_imin, bucket->ub_cnt);
 778                 if (zdom->uzd_limin >= bucket->ub_cnt) {
 779                         zdom->uzd_limin -= bucket->ub_cnt;
 780                 } else {
 781                         zdom->uzd_limin = 0;
 782                         zdom->uzd_timin = 0;
 783                 }
 784         } else if (zdom->uzd_bimin > zdom->uzd_nitems) {
 785                 zdom->uzd_bimin = zdom->uzd_nitems;
 786                 if (zdom->uzd_imin > zdom->uzd_nitems)
 787                         zdom->uzd_imin = zdom->uzd_nitems;
 788         }
 789
 790         ZDOM_UNLOCK(zdom);
 791         if (dtor)
 792                 for (i = 0; i < bucket->ub_cnt; i++)
 793                         item_dtor(zone, bucket->ub_bucket[i], zone->uz_size,
 794                             NULL, SKIP_NONE);
 795
 796         return (bucket);
 797 }
 798
 799 /*
 800  * Insert a full bucket into the specified cache.  The "ws" parameter indicates
 801  * whether the bucket's contents should be counted as part of the zone's working
 802  * set.  The bucket may be freed if it exceeds the bucket limit.
 803  */
 804 static void
 805 zone_put_bucket(uma_zone_t zone, int domain, uma_bucket_t bucket, void *udata,
 806     const bool ws)
 807 {
 808         uma_zone_domain_t zdom;
 809
 810         /* We don't cache empty buckets.  This can happen after a reclaim. */
 811         if (bucket->ub_cnt == 0)
 812                 goto out;
 813         zdom = zone_domain_lock(zone, domain);
 814
 815         /*
 816          * Conditionally set the maximum number of items.
 817          */
 818         zdom->uzd_nitems += bucket->ub_cnt;
 819         if (__predict_true(zdom->uzd_nitems < zone->uz_bucket_max)) {
 820                 if (ws) {
 821                         zone_domain_imax_set(zdom, zdom->uzd_nitems);
 822                 } else {
 823                         /*
 824                          * Shift the bounds of the current WSS interval to
 825                          * avoid perturbing the estimates.
 826                          */
 827                         atomic_add_long(&zdom->uzd_imax, bucket->ub_cnt);
 828                         zdom->uzd_imin += bucket->ub_cnt;
 829                         zdom->uzd_bimin += bucket->ub_cnt;
 830                         zdom->uzd_limin += bucket->ub_cnt;
 831                 }
 832                 if (STAILQ_EMPTY(&zdom->uzd_buckets))
 833                         zdom->uzd_seq = bucket->ub_seq;
 834
 835                 /*
 836                  * Try to promote reuse of recently used items.  For items
 837                  * protected by SMR, try to defer reuse to minimize polling.
 838                  */
 839                 if (bucket->ub_seq == SMR_SEQ_INVALID)
 840                         STAILQ_INSERT_HEAD(&zdom->uzd_buckets, bucket, ub_link);
 841                 else
 842                         STAILQ_INSERT_TAIL(&zdom->uzd_buckets, bucket, ub_link);
 843                 ZDOM_UNLOCK(zdom);
 844                 return;
 845         }
 846         zdom->uzd_nitems -= bucket->ub_cnt;
 847         ZDOM_UNLOCK(zdom);
 848 out:
 849         bucket_free(zone, bucket, udata);
 850 }
 851
 852 /* Pops an item out of a per-cpu cache bucket. */
 853 static inline void *
 854 cache_bucket_pop(uma_cache_t cache, uma_cache_bucket_t bucket)
 855 {
 856         void *item;
 857
 858         CRITICAL_ASSERT(curthread);
 859
 860         bucket->ucb_cnt--;
 861         item = bucket->ucb_bucket->ub_bucket[bucket->ucb_cnt];
 862 #ifdef INVARIANTS
 863         bucket->ucb_bucket->ub_bucket[bucket->ucb_cnt] = NULL;
 864         KASSERT(item != NULL, ("uma_zalloc: Bucket pointer mangled."));
 865 #endif
 866         cache->uc_allocs++;
 867
 868         return (item);
 869 }
 870
 871 /* Pushes an item into a per-cpu cache bucket. */
 872 static inline void
 873 cache_bucket_push(uma_cache_t cache, uma_cache_bucket_t bucket, void *item)
 874 {
 875
 876         CRITICAL_ASSERT(curthread);
 877         KASSERT(bucket->ucb_bucket->ub_bucket[bucket->ucb_cnt] == NULL,
 878             ("uma_zfree: Freeing to non free bucket index."));
 879
 880         bucket->ucb_bucket->ub_bucket[bucket->ucb_cnt] = item;
 881         bucket->ucb_cnt++;
 882         cache->uc_frees++;
 883 }
 884
 885 /*
 886  * Unload a UMA bucket from a per-cpu cache.
 887  */
 888 static inline uma_bucket_t
 889 cache_bucket_unload(uma_cache_bucket_t bucket)
 890 {
 891         uma_bucket_t b;
 892
 893         b = bucket->ucb_bucket;
 894         if (b != NULL) {
 895                 MPASS(b->ub_entries == bucket->ucb_entries);
 896                 b->ub_cnt = bucket->ucb_cnt;
 897                 bucket->ucb_bucket = NULL;
 898                 bucket->ucb_entries = bucket->ucb_cnt = 0;
 899         }
 900
 901         return (b);
 902 }
 903
 904 static inline uma_bucket_t
 905 cache_bucket_unload_alloc(uma_cache_t cache)
 906 {
 907
 908         return (cache_bucket_unload(&cache->uc_allocbucket));
 909 }
 910
 911 static inline uma_bucket_t
 912 cache_bucket_unload_free(uma_cache_t cache)
 913 {
 914
 915         return (cache_bucket_unload(&cache->uc_freebucket));
 916 }
 917
 918 static inline uma_bucket_t
 919 cache_bucket_unload_cross(uma_cache_t cache)
 920 {
 921
 922         return (cache_bucket_unload(&cache->uc_crossbucket));
 923 }
 924
 925 /*
 926  * Load a bucket into a per-cpu cache bucket.
 927  */
 928 static inline void
 929 cache_bucket_load(uma_cache_bucket_t bucket, uma_bucket_t b)
 930 {
 931
 932         CRITICAL_ASSERT(curthread);
 933         MPASS(bucket->ucb_bucket == NULL);
 934         MPASS(b->ub_seq == SMR_SEQ_INVALID);
 935
 936         bucket->ucb_bucket = b;
 937         bucket->ucb_cnt = b->ub_cnt;
 938         bucket->ucb_entries = b->ub_entries;
 939 }
 940
 941 static inline void
 942 cache_bucket_load_alloc(uma_cache_t cache, uma_bucket_t b)
 943 {
 944
 945         cache_bucket_load(&cache->uc_allocbucket, b);
 946 }
 947
 948 static inline void
 949 cache_bucket_load_free(uma_cache_t cache, uma_bucket_t b)
 950 {
 951
 952         cache_bucket_load(&cache->uc_freebucket, b);
 953 }
 954
 955 #ifdef NUMA
 956 static inline void
 957 cache_bucket_load_cross(uma_cache_t cache, uma_bucket_t b)
 958 {
 959
 960         cache_bucket_load(&cache->uc_crossbucket, b);
 961 }
 962 #endif
 963
 964 /*
 965  * Copy and preserve ucb_spare.
 966  */
 967 static inline void
 968 cache_bucket_copy(uma_cache_bucket_t b1, uma_cache_bucket_t b2)
 969 {
 970
 971         b1->ucb_bucket = b2->ucb_bucket;
 972         b1->ucb_entries = b2->ucb_entries;
 973         b1->ucb_cnt = b2->ucb_cnt;
 974 }
 975
 976 /*
 977  * Swap two cache buckets.
 978  */
 979 static inline void
 980 cache_bucket_swap(uma_cache_bucket_t b1, uma_cache_bucket_t b2)
 981 {
 982         struct uma_cache_bucket b3;
 983
 984         CRITICAL_ASSERT(curthread);
 985
 986         cache_bucket_copy(&b3, b1);
 987         cache_bucket_copy(b1, b2);
 988         cache_bucket_copy(b2, &b3);
 989 }
 990
 991 /*
 992  * Attempt to fetch a bucket from a zone on behalf of the current cpu cache.
 993  */
 994 static uma_bucket_t
 995 cache_fetch_bucket(uma_zone_t zone, uma_cache_t cache, int domain)
 996 {
 997         uma_zone_domain_t zdom;
 998         uma_bucket_t bucket;
 999         smr_seq_t seq;
1000
1001         /*
1002          * Avoid the lock if possible.
1003          */
1004         zdom = ZDOM_GET(zone, domain);
1005         if (zdom->uzd_nitems == 0)
1006                 return (NULL);
1007
1008         if ((cache_uz_flags(cache) & UMA_ZONE_SMR) != 0 &&
1009             (seq = atomic_load_32(&zdom->uzd_seq)) != SMR_SEQ_INVALID &&
1010             !smr_poll(zone->uz_smr, seq, false))
1011                 return (NULL);
1012
1013         /*
1014          * Check the zone's cache of buckets.
1015          */
1016         zdom = zone_domain_lock(zone, domain);
1017         if ((bucket = zone_fetch_bucket(zone, zdom, false)) != NULL)
1018                 return (bucket);
1019         ZDOM_UNLOCK(zdom);
1020
1021         return (NULL);
1022 }
1023
1024 static void
1025 zone_log_warning(uma_zone_t zone)
1026 {
1027         static const struct timeval warninterval = { 300, 0 };
1028
1029         if (!zone_warnings || zone->uz_warning == NULL)
1030                 return;
1031
1032         if (ratecheck(&zone->uz_ratecheck, &warninterval))
1033                 printf("[zone: %s] %s\n", zone->uz_name, zone->uz_warning);
1034 }
1035
1036 static inline void
1037 zone_maxaction(uma_zone_t zone)
1038 {
1039
1040         if (zone->uz_maxaction.ta_func != NULL)
1041                 taskqueue_enqueue(taskqueue_thread, &zone->uz_maxaction);
1042 }
1043
1044 /*
1045  * Routine called by timeout which is used to fire off some time interval
1046  * based calculations.  (stats, hash size, etc.)
1047  *
1048  * Arguments:
1049  *      arg   Unused
1050  *
1051  * Returns:
1052  *      Nothing
1053  */
1054 static void
1055 uma_timeout(void *unused)
1056 {
1057         bucket_enable();
1058         zone_foreach(zone_timeout, NULL);
1059
1060         /* Reschedule this event */
1061         callout_reset(&uma_callout, UMA_TIMEOUT * hz, uma_timeout, NULL);
1062 }
1063
1064 /*
1065  * Update the working set size estimates for the zone's bucket cache.
1066  * The constants chosen here are somewhat arbitrary.
1067  */
1068 static void
1069 zone_domain_update_wss(uma_zone_domain_t zdom)
1070 {
1071         long m;
1072
1073         ZDOM_LOCK_ASSERT(zdom);
1074         MPASS(zdom->uzd_imax >= zdom->uzd_nitems);
1075         MPASS(zdom->uzd_nitems >= zdom->uzd_bimin);
1076         MPASS(zdom->uzd_bimin >= zdom->uzd_imin);
1077
1078         /*
1079          * Estimate WSS as modified moving average of biggest allocation
1080          * batches for each period over few minutes (UMA_TIMEOUT of 20s).
1081          */
1082         zdom->uzd_wss = lmax(zdom->uzd_wss * 3 / 4,
1083             zdom->uzd_imax - zdom->uzd_bimin);
1084
1085         /*
1086          * Estimate longtime minimum item count as a combination of recent
1087          * minimum item count, adjusted by WSS for safety, and the modified
1088          * moving average over the last several hours (UMA_TIMEOUT of 20s).
1089          * timin measures time since limin tried to go negative, that means
1090          * we were dangerously close to or got out of cache.
1091          */
1092         m = zdom->uzd_imin - zdom->uzd_wss;
1093         if (m >= 0) {
1094                 if (zdom->uzd_limin >= m)
1095                         zdom->uzd_limin = m;
1096                 else
1097                         zdom->uzd_limin = (m + zdom->uzd_limin * 255) / 256;
1098                 zdom->uzd_timin++;
1099         } else {
1100                 zdom->uzd_limin = 0;
1101                 zdom->uzd_timin = 0;
1102         }
1103
1104         /* To reduce period edge effects on WSS keep half of the imax. */
1105         atomic_subtract_long(&zdom->uzd_imax,
1106             (zdom->uzd_imax - zdom->uzd_nitems + 1) / 2);
1107         zdom->uzd_imin = zdom->uzd_bimin = zdom->uzd_nitems;
1108 }
1109
1110 /*
1111  * Routine to perform timeout driven calculations.  This expands the
1112  * hashes and does per cpu statistics aggregation.
1113  *
1114  *  Returns nothing.
1115  */
1116 static void
1117 zone_timeout(uma_zone_t zone, void *unused)
1118 {
1119         uma_keg_t keg;
1120         u_int slabs, pages;
1121
1122         if ((zone->uz_flags & UMA_ZFLAG_HASH) == 0)
1123                 goto trim;
1124
1125         keg = zone->uz_keg;
1126
1127         /*
1128          * Hash zones are non-numa by definition so the first domain
1129          * is the only one present.
1130          */
1131         KEG_LOCK(keg, 0);
1132         pages = keg->uk_domain[0].ud_pages;
1133
1134         /*
1135          * Expand the keg hash table.
1136          *
1137          * This is done if the number of slabs is larger than the hash size.
1138          * What I'm trying to do here is completely reduce collisions.  This
1139          * may be a little aggressive.  Should I allow for two collisions max?
1140          */
1141         if ((slabs = pages / keg->uk_ppera) > keg->uk_hash.uh_hashsize) {
1142                 struct uma_hash newhash;
1143                 struct uma_hash oldhash;
1144                 int ret;
1145
1146                 /*
1147                  * This is so involved because allocating and freeing
1148                  * while the keg lock is held will lead to deadlock.
1149                  * I have to do everything in stages and check for
1150                  * races.
1151                  */
1152                 KEG_UNLOCK(keg, 0);
1153                 ret = hash_alloc(&newhash, 1 << fls(slabs));
1154                 KEG_LOCK(keg, 0);
1155                 if (ret) {
1156                         if (hash_expand(&keg->uk_hash, &newhash)) {
1157                                 oldhash = keg->uk_hash;
1158                                 keg->uk_hash = newhash;
1159                         } else
1160                                 oldhash = newhash;
1161
1162                         KEG_UNLOCK(keg, 0);
1163                         hash_free(&oldhash);
1164                         goto trim;
1165                 }
1166         }
1167         KEG_UNLOCK(keg, 0);
1168
1169 trim:
1170         /* Trim caches not used for a long time. */
1171         for (int i = 0; i < vm_ndomains; i++) {
1172                 if (bucket_cache_reclaim_domain(zone, false, false, i) &&
1173                     (zone->uz_flags & UMA_ZFLAG_CACHE) == 0)
1174                         keg_drain(zone->uz_keg, i);
1175         }
1176 }
1177
1178 /*
1179  * Allocate and zero fill the next sized hash table from the appropriate
1180  * backing store.
1181  *
1182  * Arguments:
1183  *      hash  A new hash structure with the old hash size in uh_hashsize
1184  *
1185  * Returns:
1186  *      1 on success and 0 on failure.
1187  */
1188 static int
1189 hash_alloc(struct uma_hash *hash, u_int size)
1190 {
1191         size_t alloc;
1192
1193         KASSERT(powerof2(size), ("hash size must be power of 2"));
1194         if (size > UMA_HASH_SIZE_INIT)  {
1195                 hash->uh_hashsize = size;
1196                 alloc = sizeof(hash->uh_slab_hash[0]) * hash->uh_hashsize;
1197                 hash->uh_slab_hash = malloc(alloc, M_UMAHASH, M_NOWAIT);
1198         } else {
1199                 alloc = sizeof(hash->uh_slab_hash[0]) * UMA_HASH_SIZE_INIT;
1200                 hash->uh_slab_hash = zone_alloc_item(hashzone, NULL,
1201                     UMA_ANYDOMAIN, M_WAITOK);
1202                 hash->uh_hashsize = UMA_HASH_SIZE_INIT;
1203         }
1204         if (hash->uh_slab_hash) {
1205                 bzero(hash->uh_slab_hash, alloc);
1206                 hash->uh_hashmask = hash->uh_hashsize - 1;
1207                 return (1);
1208         }
1209
1210         return (0);
1211 }
1212
1213 /*
1214  * Expands the hash table for HASH zones.  This is done from zone_timeout
1215  * to reduce collisions.  This must not be done in the regular allocation
1216  * path, otherwise, we can recurse on the vm while allocating pages.
1217  *
1218  * Arguments:
1219  *      oldhash  The hash you want to expand
1220  *      newhash  The hash structure for the new table
1221  *
1222  * Returns:
1223  *      Nothing
1224  *
1225  * Discussion:
1226  */
1227 static int
1228 hash_expand(struct uma_hash *oldhash, struct uma_hash *newhash)
1229 {
1230         uma_hash_slab_t slab;
1231         u_int hval;
1232         u_int idx;
1233
1234         if (!newhash->uh_slab_hash)
1235                 return (0);
1236
1237         if (oldhash->uh_hashsize >= newhash->uh_hashsize)
1238                 return (0);
1239
1240         /*
1241          * I need to investigate hash algorithms for resizing without a
1242          * full rehash.
1243          */
1244
1245         for (idx = 0; idx < oldhash->uh_hashsize; idx++)
1246                 while (!LIST_EMPTY(&oldhash->uh_slab_hash[idx])) {
1247                         slab = LIST_FIRST(&oldhash->uh_slab_hash[idx]);
1248                         LIST_REMOVE(slab, uhs_hlink);
1249                         hval = UMA_HASH(newhash, slab->uhs_data);
1250                         LIST_INSERT_HEAD(&newhash->uh_slab_hash[hval],
1251                             slab, uhs_hlink);
1252                 }
1253
1254         return (1);
1255 }
1256
1257 /*
1258  * Free the hash bucket to the appropriate backing store.
1259  *
1260  * Arguments:
1261  *      slab_hash  The hash bucket we're freeing
1262  *      hashsize   The number of entries in that hash bucket
1263  *
1264  * Returns:
1265  *      Nothing
1266  */
1267 static void
1268 hash_free(struct uma_hash *hash)
1269 {
1270         if (hash->uh_slab_hash == NULL)
1271                 return;
1272         if (hash->uh_hashsize == UMA_HASH_SIZE_INIT)
1273                 zone_free_item(hashzone, hash->uh_slab_hash, NULL, SKIP_NONE);
1274         else
1275                 free(hash->uh_slab_hash, M_UMAHASH);
1276 }
1277
1278 /*
1279  * Frees all outstanding items in a bucket
1280  *
1281  * Arguments:
1282  *      zone   The zone to free to, must be unlocked.
1283  *      bucket The free/alloc bucket with items.
1284  *
1285  * Returns:
1286  *      Nothing
1287  */
1288 static void
1289 bucket_drain(uma_zone_t zone, uma_bucket_t bucket)
1290 {
1291         int i;
1292
1293         if (bucket->ub_cnt == 0)
1294                 return;
1295
1296         if ((zone->uz_flags & UMA_ZONE_SMR) != 0 &&
1297             bucket->ub_seq != SMR_SEQ_INVALID) {
1298                 smr_wait(zone->uz_smr, bucket->ub_seq);
1299                 bucket->ub_seq = SMR_SEQ_INVALID;
1300                 for (i = 0; i < bucket->ub_cnt; i++)
1301                         item_dtor(zone, bucket->ub_bucket[i],
1302                             zone->uz_size, NULL, SKIP_NONE);
1303         }
1304         if (zone->uz_fini)
1305                 for (i = 0; i < bucket->ub_cnt; i++) {
1306                         kasan_mark_item_valid(zone, bucket->ub_bucket[i]);
1307                         zone->uz_fini(bucket->ub_bucket[i], zone->uz_size);
1308                         kasan_mark_item_invalid(zone, bucket->ub_bucket[i]);
1309                 }
1310         zone->uz_release(zone->uz_arg, bucket->ub_bucket, bucket->ub_cnt);
1311         if (zone->uz_max_items > 0)
1312                 zone_free_limit(zone, bucket->ub_cnt);
1313 #ifdef INVARIANTS
1314         bzero(bucket->ub_bucket, sizeof(void *) * bucket->ub_cnt);
1315 #endif
1316         bucket->ub_cnt = 0;
1317 }
1318
1319 /*
1320  * Drains the per cpu caches for a zone.
1321  *
1322  * NOTE: This may only be called while the zone is being torn down, and not
1323  * during normal operation.  This is necessary in order that we do not have
1324  * to migrate CPUs to drain the per-CPU caches.
1325  *
1326  * Arguments:
1327  *      zone     The zone to drain, must be unlocked.
1328  *
1329  * Returns:
1330  *      Nothing
1331  */
1332 static void
1333 cache_drain(uma_zone_t zone)
1334 {
1335         uma_cache_t cache;
1336         uma_bucket_t bucket;
1337         smr_seq_t seq;
1338         int cpu;
1339
1340         /*
1341          * XXX: It is safe to not lock the per-CPU caches, because we're
1342          * tearing down the zone anyway.  I.e., there will be no further use
1343          * of the caches at this point.
1344          *
1345          * XXX: It would good to be able to assert that the zone is being
1346          * torn down to prevent improper use of cache_drain().
1347          */
1348         seq = SMR_SEQ_INVALID;
1349         if ((zone->uz_flags & UMA_ZONE_SMR) != 0)
1350                 seq = smr_advance(zone->uz_smr);
1351         CPU_FOREACH(cpu) {
1352                 cache = &zone->uz_cpu[cpu];
1353                 bucket = cache_bucket_unload_alloc(cache);
1354                 if (bucket != NULL)
1355                         bucket_free(zone, bucket, NULL);
1356                 bucket = cache_bucket_unload_free(cache);
1357                 if (bucket != NULL) {
1358                         bucket->ub_seq = seq;
1359                         bucket_free(zone, bucket, NULL);
1360                 }
1361                 bucket = cache_bucket_unload_cross(cache);
1362                 if (bucket != NULL) {
1363                         bucket->ub_seq = seq;
1364                         bucket_free(zone, bucket, NULL);
1365                 }
1366         }
1367         bucket_cache_reclaim(zone, true, UMA_ANYDOMAIN);
1368 }
1369
1370 static void
1371 cache_shrink(uma_zone_t zone, void *unused)
1372 {
1373
1374         if (zone->uz_flags & UMA_ZFLAG_INTERNAL)
1375                 return;
1376
1377         ZONE_LOCK(zone);
1378         zone->uz_bucket_size =
1379             (zone->uz_bucket_size_min + zone->uz_bucket_size) / 2;
1380         ZONE_UNLOCK(zone);
1381 }
1382
1383 static void
1384 cache_drain_safe_cpu(uma_zone_t zone, void *unused)
1385 {
1386         uma_cache_t cache;
1387         uma_bucket_t b1, b2, b3;
1388         int domain;
1389
1390         if (zone->uz_flags & UMA_ZFLAG_INTERNAL)
1391                 return;
1392
1393         b1 = b2 = b3 = NULL;
1394         critical_enter();
1395         cache = &zone->uz_cpu[curcpu];
1396         domain = PCPU_GET(domain);
1397         b1 = cache_bucket_unload_alloc(cache);
1398
1399         /*
1400          * Don't flush SMR zone buckets.  This leaves the zone without a
1401          * bucket and forces every free to synchronize().
1402          */
1403         if ((zone->uz_flags & UMA_ZONE_SMR) == 0) {
1404                 b2 = cache_bucket_unload_free(cache);
1405                 b3 = cache_bucket_unload_cross(cache);
1406         }
1407         critical_exit();
1408
1409         if (b1 != NULL)
1410                 zone_free_bucket(zone, b1, NULL, domain, false);
1411         if (b2 != NULL)
1412                 zone_free_bucket(zone, b2, NULL, domain, false);
1413         if (b3 != NULL) {
1414                 /* Adjust the domain so it goes to zone_free_cross. */
1415                 domain = (domain + 1) % vm_ndomains;
1416                 zone_free_bucket(zone, b3, NULL, domain, false);
1417         }
1418 }
1419
1420 /*
1421  * Safely drain per-CPU caches of a zone(s) to alloc bucket.
1422  * This is an expensive call because it needs to bind to all CPUs
1423  * one by one and enter a critical section on each of them in order
1424  * to safely access their cache buckets.
1425  * Zone lock must not be held on call this function.
1426  */
1427 static void
1428 pcpu_cache_drain_safe(uma_zone_t zone)
1429 {
1430         int cpu;
1431
1432         /*
1433          * Polite bucket sizes shrinking was not enough, shrink aggressively.
1434          */
1435         if (zone)
1436                 cache_shrink(zone, NULL);
1437         else
1438                 zone_foreach(cache_shrink, NULL);
1439
1440         CPU_FOREACH(cpu) {
1441                 thread_lock(curthread);
1442                 sched_bind(curthread, cpu);
1443                 thread_unlock(curthread);
1444
1445                 if (zone)
1446                         cache_drain_safe_cpu(zone, NULL);
1447                 else
1448                         zone_foreach(cache_drain_safe_cpu, NULL);
1449         }
1450         thread_lock(curthread);
1451         sched_unbind(curthread);
1452         thread_unlock(curthread);
1453 }
1454
1455 /*
1456  * Reclaim cached buckets from a zone.  All buckets are reclaimed if the caller
1457  * requested a drain, otherwise the per-domain caches are trimmed to either
1458  * estimated working set size.
1459  */
1460 static bool
1461 bucket_cache_reclaim_domain(uma_zone_t zone, bool drain, bool trim, int domain)
1462 {
1463         uma_zone_domain_t zdom;
1464         uma_bucket_t bucket;
1465         long target;
1466         bool done = false;
1467
1468         /*
1469          * The cross bucket is partially filled and not part of
1470          * the item count.  Reclaim it individually here.
1471          */
1472         zdom = ZDOM_GET(zone, domain);
1473         if ((zone->uz_flags & UMA_ZONE_SMR) == 0 || drain) {
1474                 ZONE_CROSS_LOCK(zone);
1475                 bucket = zdom->uzd_cross;
1476                 zdom->uzd_cross = NULL;
1477                 ZONE_CROSS_UNLOCK(zone);
1478                 if (bucket != NULL)
1479                         bucket_free(zone, bucket, NULL);
1480         }
1481
1482         /*
1483          * If we were asked to drain the zone, we are done only once
1484          * this bucket cache is empty.  If trim, we reclaim items in
1485          * excess of the zone's estimated working set size.  Multiple
1486          * consecutive calls will shrink the WSS and so reclaim more.
1487          * If neither drain nor trim, then voluntarily reclaim 1/4
1488          * (to reduce first spike) of items not used for a long time.
1489          */
1490         ZDOM_LOCK(zdom);
1491         zone_domain_update_wss(zdom);
1492         if (drain)
1493                 target = 0;
1494         else if (trim)
1495                 target = zdom->uzd_wss;
1496         else if (zdom->uzd_timin > 900 / UMA_TIMEOUT)
1497                 target = zdom->uzd_nitems - zdom->uzd_limin / 4;
1498         else {
1499                 ZDOM_UNLOCK(zdom);
1500                 return (done);
1501         }
1502         while ((bucket = STAILQ_FIRST(&zdom->uzd_buckets)) != NULL &&
1503             zdom->uzd_nitems >= target + bucket->ub_cnt) {
1504                 bucket = zone_fetch_bucket(zone, zdom, true);
1505                 if (bucket == NULL)
1506                         break;
1507                 bucket_free(zone, bucket, NULL);
1508                 done = true;
1509                 ZDOM_LOCK(zdom);
1510         }
1511         ZDOM_UNLOCK(zdom);
1512         return (done);
1513 }
1514
1515 static void
1516 bucket_cache_reclaim(uma_zone_t zone, bool drain, int domain)
1517 {
1518         int i;
1519
1520         /*
1521          * Shrink the zone bucket size to ensure that the per-CPU caches
1522          * don't grow too large.
1523          */
1524         if (zone->uz_bucket_size > zone->uz_bucket_size_min)
1525                 zone->uz_bucket_size--;
1526
1527         if (domain != UMA_ANYDOMAIN &&
1528             (zone->uz_flags & UMA_ZONE_ROUNDROBIN) == 0) {
1529                 bucket_cache_reclaim_domain(zone, drain, true, domain);
1530         } else {
1531                 for (i = 0; i < vm_ndomains; i++)
1532                         bucket_cache_reclaim_domain(zone, drain, true, i);
1533         }
1534 }
1535
1536 static void
1537 keg_free_slab(uma_keg_t keg, uma_slab_t slab, int start)
1538 {
1539         uint8_t *mem;
1540         size_t size;
1541         int i;
1542         uint8_t flags;
1543
1544         CTR4(KTR_UMA, "keg_free_slab keg %s(%p) slab %p, returning %d bytes",
1545             keg->uk_name, keg, slab, PAGE_SIZE * keg->uk_ppera);
1546
1547         mem = slab_data(slab, keg);
1548         size = PAGE_SIZE * keg->uk_ppera;
1549
1550         kasan_mark_slab_valid(keg, mem);
1551         if (keg->uk_fini != NULL) {
1552                 for (i = start - 1; i > -1; i--)
1553 #ifdef INVARIANTS
1554                 /*
1555                  * trash_fini implies that dtor was trash_dtor. trash_fini
1556                  * would check that memory hasn't been modified since free,
1557                  * which executed trash_dtor.
1558                  * That's why we need to run uma_dbg_kskip() check here,
1559                  * albeit we don't make skip check for other init/fini
1560                  * invocations.
1561                  */
1562                 if (!uma_dbg_kskip(keg, slab_item(slab, keg, i)) ||
1563                     keg->uk_fini != trash_fini)
1564 #endif
1565                         keg->uk_fini(slab_item(slab, keg, i), keg->uk_size);
1566         }
1567         flags = slab->us_flags;
1568         if (keg->uk_flags & UMA_ZFLAG_OFFPAGE) {
1569                 zone_free_item(slabzone(keg->uk_ipers), slab_tohashslab(slab),
1570                     NULL, SKIP_NONE);
1571         }
1572         keg->uk_freef(mem, size, flags);
1573         uma_total_dec(size);
1574 }
1575
1576 static void
1577 keg_drain_domain(uma_keg_t keg, int domain)
1578 {
1579         struct slabhead freeslabs;
1580         uma_domain_t dom;
1581         uma_slab_t slab, tmp;
1582         uint32_t i, stofree, stokeep, partial;
1583
1584         dom = &keg->uk_domain[domain];
1585         LIST_INIT(&freeslabs);
1586
1587         CTR4(KTR_UMA, "keg_drain %s(%p) domain %d free items: %u",
1588             keg->uk_name, keg, domain, dom->ud_free_items);
1589
1590         KEG_LOCK(keg, domain);
1591
1592         /*
1593          * Are the free items in partially allocated slabs sufficient to meet
1594          * the reserve? If not, compute the number of fully free slabs that must
1595          * be kept.
1596          */
1597         partial = dom->ud_free_items - dom->ud_free_slabs * keg->uk_ipers;
1598         if (partial < keg->uk_reserve) {
1599                 stokeep = min(dom->ud_free_slabs,
1600                     howmany(keg->uk_reserve - partial, keg->uk_ipers));
1601         } else {
1602                 stokeep = 0;
1603         }
1604         stofree = dom->ud_free_slabs - stokeep;
1605
1606         /*
1607          * Partition the free slabs into two sets: those that must be kept in
1608          * order to maintain the reserve, and those that may be released back to
1609          * the system.  Since one set may be much larger than the other,
1610          * populate the smaller of the two sets and swap them if necessary.
1611          */
1612         for (i = min(stofree, stokeep); i > 0; i--) {
1613                 slab = LIST_FIRST(&dom->ud_free_slab);
1614                 LIST_REMOVE(slab, us_link);
1615                 LIST_INSERT_HEAD(&freeslabs, slab, us_link);
1616         }
1617         if (stofree > stokeep)
1618                 LIST_SWAP(&freeslabs, &dom->ud_free_slab, uma_slab, us_link);
1619
1620         if ((keg->uk_flags & UMA_ZFLAG_HASH) != 0) {
1621                 LIST_FOREACH(slab, &freeslabs, us_link)
1622                         UMA_HASH_REMOVE(&keg->uk_hash, slab);
1623         }
1624         dom->ud_free_items -= stofree * keg->uk_ipers;
1625         dom->ud_free_slabs -= stofree;
1626         dom->ud_pages -= stofree * keg->uk_ppera;
1627         KEG_UNLOCK(keg, domain);
1628
1629         LIST_FOREACH_SAFE(slab, &freeslabs, us_link, tmp)
1630                 keg_free_slab(keg, slab, keg->uk_ipers);
1631 }
1632
1633 /*
1634  * Frees pages from a keg back to the system.  This is done on demand from
1635  * the pageout daemon.
1636  *
1637  * Returns nothing.
1638  */
1639 static void
1640 keg_drain(uma_keg_t keg, int domain)
1641 {
1642         int i;
1643
1644         if ((keg->uk_flags & UMA_ZONE_NOFREE) != 0)
1645                 return;
1646         if (domain != UMA_ANYDOMAIN) {
1647                 keg_drain_domain(keg, domain);
1648         } else {
1649                 for (i = 0; i < vm_ndomains; i++)
1650                         keg_drain_domain(keg, i);
1651         }
1652 }
1653
1654 static void
1655 zone_reclaim(uma_zone_t zone, int domain, int waitok, bool drain)
1656 {
1657         /*
1658          * Count active reclaim operations in order to interlock with
1659          * zone_dtor(), which removes the zone from global lists before
1660          * attempting to reclaim items itself.
1661          *
1662          * The zone may be destroyed while sleeping, so only zone_dtor() should
1663          * specify M_WAITOK.
1664          */
1665         ZONE_LOCK(zone);
1666         if (waitok == M_WAITOK) {
1667                 while (zone->uz_reclaimers > 0)
1668                         msleep(zone, ZONE_LOCKPTR(zone), PVM, "zonedrain", 1);
1669         }
1670         zone->uz_reclaimers++;
1671         ZONE_UNLOCK(zone);
1672         bucket_cache_reclaim(zone, drain, domain);
1673
1674         if ((zone->uz_flags & UMA_ZFLAG_CACHE) == 0)
1675                 keg_drain(zone->uz_keg, domain);
1676         ZONE_LOCK(zone);
1677         zone->uz_reclaimers--;
1678         if (zone->uz_reclaimers == 0)
1679                 wakeup(zone);
1680         ZONE_UNLOCK(zone);
1681 }
1682
1683 static void
1684 zone_drain(uma_zone_t zone, void *arg)
1685 {
1686         int domain;
1687
1688         domain = (int)(uintptr_t)arg;
1689         zone_reclaim(zone, domain, M_NOWAIT, true);
1690 }
1691
1692 static void
1693 zone_trim(uma_zone_t zone, void *arg)
1694 {
1695         int domain;
1696
1697         domain = (int)(uintptr_t)arg;
1698         zone_reclaim(zone, domain, M_NOWAIT, false);
1699 }
1700
1701 /*
1702  * Allocate a new slab for a keg and inserts it into the partial slab list.
1703  * The keg should be unlocked on entry.  If the allocation succeeds it will
1704  * be locked on return.
1705  *
1706  * Arguments:
1707  *      flags   Wait flags for the item initialization routine
1708  *      aflags  Wait flags for the slab allocation
1709  *
1710  * Returns:
1711  *      The slab that was allocated or NULL if there is no memory and the
1712  *      caller specified M_NOWAIT.
1713  */
1714 static uma_slab_t
1715 keg_alloc_slab(uma_keg_t keg, uma_zone_t zone, int domain, int flags,
1716     int aflags)
1717 {
1718         uma_domain_t dom;
1719         uma_slab_t slab;
1720         unsigned long size;
1721         uint8_t *mem;
1722         uint8_t sflags;
1723         int i;
1724
1725         KASSERT(domain >= 0 && domain < vm_ndomains,
1726             ("keg_alloc_slab: domain %d out of range", domain));
1727
1728         slab = NULL;
1729         mem = NULL;
1730         if (keg->uk_flags & UMA_ZFLAG_OFFPAGE) {
1731                 uma_hash_slab_t hslab;
1732                 hslab = zone_alloc_item(slabzone(keg->uk_ipers), NULL,
1733                     domain, aflags);
1734                 if (hslab == NULL)
1735                         goto fail;
1736                 slab = &hslab->uhs_slab;
1737         }
1738
1739         /*
1740          * This reproduces the old vm_zone behavior of zero filling pages the
1741          * first time they are added to a zone.
1742          *
1743          * Malloced items are zeroed in uma_zalloc.
1744          */
1745
1746         if ((keg->uk_flags & UMA_ZONE_MALLOC) == 0)
1747                 aflags |= M_ZERO;
1748         else
1749                 aflags &= ~M_ZERO;
1750
1751         if (keg->uk_flags & UMA_ZONE_NODUMP)
1752                 aflags |= M_NODUMP;
1753
1754         /* zone is passed for legacy reasons. */
1755         size = keg->uk_ppera * PAGE_SIZE;
1756         mem = keg->uk_allocf(zone, size, domain, &sflags, aflags);
1757         if (mem == NULL) {
1758                 if (keg->uk_flags & UMA_ZFLAG_OFFPAGE)
1759                         zone_free_item(slabzone(keg->uk_ipers),
1760                             slab_tohashslab(slab), NULL, SKIP_NONE);
1761                 goto fail;
1762         }
1763         uma_total_inc(size);
1764
1765         /* For HASH zones all pages go to the same uma_domain. */
1766         if ((keg->uk_flags & UMA_ZFLAG_HASH) != 0)
1767                 domain = 0;
1768
1769         /* Point the slab into the allocated memory */
1770         if (!(keg->uk_flags & UMA_ZFLAG_OFFPAGE))
1771                 slab = (uma_slab_t)(mem + keg->uk_pgoff);
1772         else
1773                 slab_tohashslab(slab)->uhs_data = mem;
1774
1775         if (keg->uk_flags & UMA_ZFLAG_VTOSLAB)
1776                 for (i = 0; i < keg->uk_ppera; i++)
1777                         vsetzoneslab((vm_offset_t)mem + (i * PAGE_SIZE),
1778                             zone, slab);
1779
1780         slab->us_freecount = keg->uk_ipers;
1781         slab->us_flags = sflags;
1782         slab->us_domain = domain;
1783
1784         BIT_FILL(keg->uk_ipers, &slab->us_free);
1785 #ifdef INVARIANTS
1786         BIT_ZERO(keg->uk_ipers, slab_dbg_bits(slab, keg));
1787 #endif
1788
1789         if (keg->uk_init != NULL) {
1790                 for (i = 0; i < keg->uk_ipers; i++)
1791                         if (keg->uk_init(slab_item(slab, keg, i),
1792                             keg->uk_size, flags) != 0)
1793                                 break;
1794                 if (i != keg->uk_ipers) {
1795                         keg_free_slab(keg, slab, i);
1796                         goto fail;
1797                 }
1798         }
1799         kasan_mark_slab_invalid(keg, mem);
1800         KEG_LOCK(keg, domain);
1801
1802         CTR3(KTR_UMA, "keg_alloc_slab: allocated slab %p for %s(%p)",
1803             slab, keg->uk_name, keg);
1804
1805         if (keg->uk_flags & UMA_ZFLAG_HASH)
1806                 UMA_HASH_INSERT(&keg->uk_hash, slab, mem);
1807
1808         /*
1809          * If we got a slab here it's safe to mark it partially used
1810          * and return.  We assume that the caller is going to remove
1811          * at least one item.
1812          */
1813         dom = &keg->uk_domain[domain];
1814         LIST_INSERT_HEAD(&dom->ud_part_slab, slab, us_link);
1815         dom->ud_pages += keg->uk_ppera;
1816         dom->ud_free_items += keg->uk_ipers;
1817
1818         return (slab);
1819
1820 fail:
1821         return (NULL);
1822 }
1823
1824 /*
1825  * This function is intended to be used early on in place of page_alloc().  It
1826  * performs contiguous physical memory allocations and uses a bump allocator for
1827  * KVA, so is usable before the kernel map is initialized.
1828  */
1829 static void *
1830 startup_alloc(uma_zone_t zone, vm_size_t bytes, int domain, uint8_t *pflag,
1831     int wait)
1832 {
1833         vm_paddr_t pa;
1834         vm_page_t m;
1835         int i, pages;
1836
1837         pages = howmany(bytes, PAGE_SIZE);
1838         KASSERT(pages > 0, ("%s can't reserve 0 pages", __func__));
1839
1840         *pflag = UMA_SLAB_BOOT;
1841         m = vm_page_alloc_noobj_contig_domain(domain, malloc2vm_flags(wait) |
1842             VM_ALLOC_WIRED, pages, (vm_paddr_t)0, ~(vm_paddr_t)0, 1, 0,
1843             VM_MEMATTR_DEFAULT);
1844         if (m == NULL)
1845                 return (NULL);
1846
1847         pa = VM_PAGE_TO_PHYS(m);
1848         for (i = 0; i < pages; i++, pa += PAGE_SIZE) {
1849 #if defined(__aarch64__) || defined(__amd64__) || defined(__mips__) || \
1850     defined(__riscv) || defined(__powerpc64__)
1851                 if ((wait & M_NODUMP) == 0)
1852                         dump_add_page(pa);
1853 #endif
1854         }
1855
1856         /* Allocate KVA and indirectly advance bootmem. */
1857         return ((void *)pmap_map(&bootmem, m->phys_addr,
1858             m->phys_addr + (pages * PAGE_SIZE), VM_PROT_READ | VM_PROT_WRITE));
1859 }
1860
1861 static void
1862 startup_free(void *mem, vm_size_t bytes)
1863 {
1864         vm_offset_t va;
1865         vm_page_t m;
1866
1867         va = (vm_offset_t)mem;
1868         m = PHYS_TO_VM_PAGE(pmap_kextract(va));
1869
1870         /*
1871          * startup_alloc() returns direct-mapped slabs on some platforms.  Avoid
1872          * unmapping ranges of the direct map.
1873          */
1874         if (va >= bootstart && va + bytes <= bootmem)
1875                 pmap_remove(kernel_pmap, va, va + bytes);
1876         for (; bytes != 0; bytes -= PAGE_SIZE, m++) {
1877 #if defined(__aarch64__) || defined(__amd64__) || defined(__mips__) || \
1878     defined(__riscv) || defined(__powerpc64__)
1879                 dump_drop_page(VM_PAGE_TO_PHYS(m));
1880 #endif
1881                 vm_page_unwire_noq(m);
1882                 vm_page_free(m);
1883         }
1884 }
1885
1886 /*
1887  * Allocates a number of pages from the system
1888  *
1889  * Arguments:
1890  *      bytes  The number of bytes requested
1891  *      wait  Shall we wait?
1892  *
1893  * Returns:
1894  *      A pointer to the alloced memory or possibly
1895  *      NULL if M_NOWAIT is set.
1896  */
1897 static void *
1898 page_alloc(uma_zone_t zone, vm_size_t bytes, int domain, uint8_t *pflag,
1899     int wait)
1900 {
1901         void *p;        /* Returned page */
1902
1903         *pflag = UMA_SLAB_KERNEL;
1904         p = (void *)kmem_malloc_domainset(DOMAINSET_FIXED(domain), bytes, wait);
1905
1906         return (p);
1907 }
1908
1909 static void *
1910 pcpu_page_alloc(uma_zone_t zone, vm_size_t bytes, int domain, uint8_t *pflag,
1911     int wait)
1912 {
1913         struct pglist alloctail;
1914         vm_offset_t addr, zkva;
1915         int cpu, flags;
1916         vm_page_t p, p_next;
1917 #ifdef NUMA
1918         struct pcpu *pc;
1919 #endif
1920
1921         MPASS(bytes == (mp_maxid + 1) * PAGE_SIZE);
1922
1923         TAILQ_INIT(&alloctail);
1924         flags = VM_ALLOC_SYSTEM | VM_ALLOC_WIRED | malloc2vm_flags(wait);
1925         *pflag = UMA_SLAB_KERNEL;
1926         for (cpu = 0; cpu <= mp_maxid; cpu++) {
1927                 if (CPU_ABSENT(cpu)) {
1928                         p = vm_page_alloc_noobj(flags);
1929                 } else {
1930 #ifndef NUMA
1931                         p = vm_page_alloc_noobj(flags);
1932 #else
1933                         pc = pcpu_find(cpu);
1934                         if (__predict_false(VM_DOMAIN_EMPTY(pc->pc_domain)))
1935                                 p = NULL;
1936                         else
1937                                 p = vm_page_alloc_noobj_domain(pc->pc_domain,
1938                                     flags);
1939                         if (__predict_false(p == NULL))
1940                                 p = vm_page_alloc_noobj(flags);
1941 #endif
1942                 }
1943                 if (__predict_false(p == NULL))
1944                         goto fail;
1945                 TAILQ_INSERT_TAIL(&alloctail, p, listq);
1946         }
1947         if ((addr = kva_alloc(bytes)) == 0)
1948                 goto fail;
1949         zkva = addr;
1950         TAILQ_FOREACH(p, &alloctail, listq) {
1951                 pmap_qenter(zkva, &p, 1);
1952                 zkva += PAGE_SIZE;
1953         }
1954         return ((void*)addr);
1955 fail:
1956         TAILQ_FOREACH_SAFE(p, &alloctail, listq, p_next) {
1957                 vm_page_unwire_noq(p);
1958                 vm_page_free(p);
1959         }
1960         return (NULL);
1961 }
1962
1963 /*
1964  * Allocates a number of pages from within an object
1965  *
1966  * Arguments:
1967  *      bytes  The number of bytes requested
1968  *      wait   Shall we wait?
1969  *
1970  * Returns:
1971  *      A pointer to the alloced memory or possibly
1972  *      NULL if M_NOWAIT is set.
1973  */
1974 static void *
1975 noobj_alloc(uma_zone_t zone, vm_size_t bytes, int domain, uint8_t *flags,
1976     int wait)
1977 {
1978         TAILQ_HEAD(, vm_page) alloctail;
1979         u_long npages;
1980         vm_offset_t retkva, zkva;
1981         vm_page_t p, p_next;
1982         uma_keg_t keg;
1983         int req;
1984
1985         TAILQ_INIT(&alloctail);
1986         keg = zone->uz_keg;
1987         req = VM_ALLOC_INTERRUPT | VM_ALLOC_WIRED;
1988         if ((wait & M_WAITOK) != 0)
1989                 req |= VM_ALLOC_WAITOK;
1990
1991         npages = howmany(bytes, PAGE_SIZE);
1992         while (npages > 0) {
1993                 p = vm_page_alloc_noobj_domain(domain, req);
1994                 if (p != NULL) {
1995                         /*
1996                          * Since the page does not belong to an object, its
1997                          * listq is unused.
1998                          */
1999                         TAILQ_INSERT_TAIL(&alloctail, p, listq);
2000                         npages--;
2001                         continue;
2002                 }
2003                 /*
2004                  * Page allocation failed, free intermediate pages and
2005                  * exit.
2006                  */
2007                 TAILQ_FOREACH_SAFE(p, &alloctail, listq, p_next) {
2008                         vm_page_unwire_noq(p);
2009                         vm_page_free(p);
2010                 }
2011                 return (NULL);
2012         }
2013         *flags = UMA_SLAB_PRIV;
2014         zkva = keg->uk_kva +
2015             atomic_fetchadd_long(&keg->uk_offset, round_page(bytes));
2016         retkva = zkva;
2017         TAILQ_FOREACH(p, &alloctail, listq) {
2018                 pmap_qenter(zkva, &p, 1);
2019                 zkva += PAGE_SIZE;
2020         }
2021
2022         return ((void *)retkva);
2023 }
2024
2025 /*
2026  * Allocate physically contiguous pages.
2027  */
2028 static void *
2029 contig_alloc(uma_zone_t zone, vm_size_t bytes, int domain, uint8_t *pflag,
2030     int wait)
2031 {
2032
2033         *pflag = UMA_SLAB_KERNEL;
2034         return ((void *)kmem_alloc_contig_domainset(DOMAINSET_FIXED(domain),
2035             bytes, wait, 0, ~(vm_paddr_t)0, 1, 0, VM_MEMATTR_DEFAULT));
2036 }
2037
2038 /*
2039  * Frees a number of pages to the system
2040  *
2041  * Arguments:
2042  *      mem   A pointer to the memory to be freed
2043  *      size  The size of the memory being freed
2044  *      flags The original p->us_flags field
2045  *
2046  * Returns:
2047  *      Nothing
2048  */
2049 static void
2050 page_free(void *mem, vm_size_t size, uint8_t flags)
2051 {
2052
2053         if ((flags & UMA_SLAB_BOOT) != 0) {
2054                 startup_free(mem, size);
2055                 return;
2056         }
2057
2058         KASSERT((flags & UMA_SLAB_KERNEL) != 0,
2059             ("UMA: page_free used with invalid flags %x", flags));
2060
2061         kmem_free((vm_offset_t)mem, size);
2062 }
2063
2064 /*
2065  * Frees pcpu zone allocations
2066  *
2067  * Arguments:
2068  *      mem   A pointer to the memory to be freed
2069  *      size  The size of the memory being freed
2070  *      flags The original p->us_flags field
2071  *
2072  * Returns:
2073  *      Nothing
2074  */
2075 static void
2076 pcpu_page_free(void *mem, vm_size_t size, uint8_t flags)
2077 {
2078         vm_offset_t sva, curva;
2079         vm_paddr_t paddr;
2080         vm_page_t m;
2081
2082         MPASS(size == (mp_maxid+1)*PAGE_SIZE);
2083
2084         if ((flags & UMA_SLAB_BOOT) != 0) {
2085                 startup_free(mem, size);
2086                 return;
2087         }
2088
2089         sva = (vm_offset_t)mem;
2090         for (curva = sva; curva < sva + size; curva += PAGE_SIZE) {
2091                 paddr = pmap_kextract(curva);
2092                 m = PHYS_TO_VM_PAGE(paddr);
2093                 vm_page_unwire_noq(m);
2094                 vm_page_free(m);
2095         }
2096         pmap_qremove(sva, size >> PAGE_SHIFT);
2097         kva_free(sva, size);
2098 }
2099
2100 /*
2101  * Zero fill initializer
2102  *
2103  * Arguments/Returns follow uma_init specifications
2104  */
2105 static int
2106 zero_init(void *mem, int size, int flags)
2107 {
2108         bzero(mem, size);
2109         return (0);
2110 }
2111
2112 #ifdef INVARIANTS
2113 static struct noslabbits *
2114 slab_dbg_bits(uma_slab_t slab, uma_keg_t keg)
2115 {
2116
2117         return ((void *)((char *)&slab->us_free + BITSET_SIZE(keg->uk_ipers)));
2118 }
2119 #endif
2120
2121 /*
2122  * Actual size of embedded struct slab (!OFFPAGE).
2123  */
2124 static size_t
2125 slab_sizeof(int nitems)
2126 {
2127         size_t s;
2128
2129         s = sizeof(struct uma_slab) + BITSET_SIZE(nitems) * SLAB_BITSETS;
2130         return (roundup(s, UMA_ALIGN_PTR + 1));
2131 }
2132
2133 #define UMA_FIXPT_SHIFT 31
2134 #define UMA_FRAC_FIXPT(n, d)                                            \
2135         ((uint32_t)(((uint64_t)(n) << UMA_FIXPT_SHIFT) / (d)))
2136 #define UMA_FIXPT_PCT(f)                                                \
2137         ((u_int)(((uint64_t)100 * (f)) >> UMA_FIXPT_SHIFT))
2138 #define UMA_PCT_FIXPT(pct)      UMA_FRAC_FIXPT((pct), 100)
2139 #define UMA_MIN_EFF     UMA_PCT_FIXPT(100 - UMA_MAX_WASTE)
2140
2141 /*
2142  * Compute the number of items that will fit in a slab.  If hdr is true, the
2143  * item count may be limited to provide space in the slab for an inline slab
2144  * header.  Otherwise, all slab space will be provided for item storage.
2145  */
2146 static u_int
2147 slab_ipers_hdr(u_int size, u_int rsize, u_int slabsize, bool hdr)
2148 {
2149         u_int ipers;
2150         u_int padpi;
2151
2152         /* The padding between items is not needed after the last item. */
2153         padpi = rsize - size;
2154
2155         if (hdr) {
2156                 /*
2157                  * Start with the maximum item count and remove items until
2158                  * the slab header first alongside the allocatable memory.
2159                  */
2160                 for (ipers = MIN(SLAB_MAX_SETSIZE,
2161                     (slabsize + padpi - slab_sizeof(1)) / rsize);
2162                     ipers > 0 &&
2163                     ipers * rsize - padpi + slab_sizeof(ipers) > slabsize;
2164                     ipers--)
2165                         continue;
2166         } else {
2167                 ipers = MIN((slabsize + padpi) / rsize, SLAB_MAX_SETSIZE);
2168         }
2169
2170         return (ipers);
2171 }
2172
2173 struct keg_layout_result {
2174         u_int format;
2175         u_int slabsize;
2176         u_int ipers;
2177         u_int eff;
2178 };
2179
2180 static void
2181 keg_layout_one(uma_keg_t keg, u_int rsize, u_int slabsize, u_int fmt,
2182     struct keg_layout_result *kl)
2183 {
2184         u_int total;
2185
2186         kl->format = fmt;
2187         kl->slabsize = slabsize;
2188
2189         /* Handle INTERNAL as inline with an extra page. */
2190         if ((fmt & UMA_ZFLAG_INTERNAL) != 0) {
2191                 kl->format &= ~UMA_ZFLAG_INTERNAL;
2192                 kl->slabsize += PAGE_SIZE;
2193         }
2194
2195         kl->ipers = slab_ipers_hdr(keg->uk_size, rsize, kl->slabsize,
2196             (fmt & UMA_ZFLAG_OFFPAGE) == 0);
2197
2198         /* Account for memory used by an offpage slab header. */
2199         total = kl->slabsize;
2200         if ((fmt & UMA_ZFLAG_OFFPAGE) != 0)
2201                 total += slabzone(kl->ipers)->uz_keg->uk_rsize;
2202
2203         kl->eff = UMA_FRAC_FIXPT(kl->ipers * rsize, total);
2204 }
2205
2206 /*
2207  * Determine the format of a uma keg.  This determines where the slab header
2208  * will be placed (inline or offpage) and calculates ipers, rsize, and ppera.
2209  *
2210  * Arguments
2211  *      keg  The zone we should initialize
2212  *
2213  * Returns
2214  *      Nothing
2215  */
2216 static void
2217 keg_layout(uma_keg_t keg)
2218 {
2219         struct keg_layout_result kl = {}, kl_tmp;
2220         u_int fmts[2];
2221         u_int alignsize;
2222         u_int nfmt;
2223         u_int pages;
2224         u_int rsize;
2225         u_int slabsize;
2226         u_int i, j;
2227
2228         KASSERT((keg->uk_flags & UMA_ZONE_PCPU) == 0 ||
2229             (keg->uk_size <= UMA_PCPU_ALLOC_SIZE &&
2230              (keg->uk_flags & UMA_ZONE_CACHESPREAD) == 0),
2231             ("%s: cannot configure for PCPU: keg=%s, size=%u, flags=0x%b",
2232              __func__, keg->uk_name, keg->uk_size, keg->uk_flags,
2233              PRINT_UMA_ZFLAGS));
2234         KASSERT((keg->uk_flags & (UMA_ZFLAG_INTERNAL | UMA_ZONE_VM)) == 0 ||
2235             (keg->uk_flags & (UMA_ZONE_NOTOUCH | UMA_ZONE_PCPU)) == 0,
2236             ("%s: incompatible flags 0x%b", __func__, keg->uk_flags,
2237              PRINT_UMA_ZFLAGS));
2238
2239         alignsize = keg->uk_align + 1;
2240 #ifdef KASAN
2241         /*
2242          * ASAN requires that each allocation be aligned to the shadow map
2243          * scale factor.
2244          */
2245         if (alignsize < KASAN_SHADOW_SCALE)
2246                 alignsize = KASAN_SHADOW_SCALE;
2247 #endif
2248
2249         /*
2250          * Calculate the size of each allocation (rsize) according to
2251          * alignment.  If the requested size is smaller than we have
2252          * allocation bits for we round it up.
2253          */
2254         rsize = MAX(keg->uk_size, UMA_SMALLEST_UNIT);
2255         rsize = roundup2(rsize, alignsize);
2256
2257         if ((keg->uk_flags & UMA_ZONE_CACHESPREAD) != 0) {
2258                 /*
2259                  * We want one item to start on every align boundary in a page.
2260                  * To do this we will span pages.  We will also extend the item
2261                  * by the size of align if it is an even multiple of align.
2262                  * Otherwise, it would fall on the same boundary every time.
2263                  */
2264                 if ((rsize & alignsize) == 0)
2265                         rsize += alignsize;
2266                 slabsize = rsize * (PAGE_SIZE / alignsize);
2267                 slabsize = MIN(slabsize, rsize * SLAB_MAX_SETSIZE);
2268                 slabsize = MIN(slabsize, UMA_CACHESPREAD_MAX_SIZE);
2269                 slabsize = round_page(slabsize);
2270         } else {
2271                 /*
2272                  * Start with a slab size of as many pages as it takes to
2273                  * represent a single item.  We will try to fit as many
2274                  * additional items into the slab as possible.
2275                  */
2276                 slabsize = round_page(keg->uk_size);
2277         }
2278
2279         /* Build a list of all of the available formats for this keg. */
2280         nfmt = 0;
2281
2282         /* Evaluate an inline slab layout. */
2283         if ((keg->uk_flags & (UMA_ZONE_NOTOUCH | UMA_ZONE_PCPU)) == 0)
2284                 fmts[nfmt++] = 0;
2285
2286         /* TODO: vm_page-embedded slab. */
2287
2288         /*
2289          * We can't do OFFPAGE if we're internal or if we've been
2290          * asked to not go to the VM for buckets.  If we do this we
2291          * may end up going to the VM for slabs which we do not want
2292          * to do if we're UMA_ZONE_VM, which clearly forbids it.
2293          * In those cases, evaluate a pseudo-format called INTERNAL
2294          * which has an inline slab header and one extra page to
2295          * guarantee that it fits.
2296          *
2297          * Otherwise, see if using an OFFPAGE slab will improve our
2298          * efficiency.
2299          */
2300         if ((keg->uk_flags & (UMA_ZFLAG_INTERNAL | UMA_ZONE_VM)) != 0)
2301                 fmts[nfmt++] = UMA_ZFLAG_INTERNAL;
2302         else
2303                 fmts[nfmt++] = UMA_ZFLAG_OFFPAGE;
2304
2305         /*
2306          * Choose a slab size and format which satisfy the minimum efficiency.
2307          * Prefer the smallest slab size that meets the constraints.
2308          *
2309          * Start with a minimum slab size, to accommodate CACHESPREAD.  Then,
2310          * for small items (up to PAGE_SIZE), the iteration increment is one
2311          * page; and for large items, the increment is one item.
2312          */
2313         i = (slabsize + rsize - keg->uk_size) / MAX(PAGE_SIZE, rsize);
2314         KASSERT(i >= 1, ("keg %s(%p) flags=0x%b slabsize=%u, rsize=%u, i=%u",
2315             keg->uk_name, keg, keg->uk_flags, PRINT_UMA_ZFLAGS, slabsize,
2316             rsize, i));
2317         for ( ; ; i++) {
2318                 slabsize = (rsize <= PAGE_SIZE) ? ptoa(i) :
2319                     round_page(rsize * (i - 1) + keg->uk_size);
2320
2321                 for (j = 0; j < nfmt; j++) {
2322                         /* Only if we have no viable format yet. */
2323                         if ((fmts[j] & UMA_ZFLAG_INTERNAL) != 0 &&
2324                             kl.ipers > 0)
2325                                 continue;
2326
2327                         keg_layout_one(keg, rsize, slabsize, fmts[j], &kl_tmp);
2328                         if (kl_tmp.eff <= kl.eff)
2329                                 continue;
2330
2331                         kl = kl_tmp;
2332
2333                         CTR6(KTR_UMA, "keg %s layout: format %#x "
2334                             "(ipers %u * rsize %u) / slabsize %#x = %u%% eff",
2335                             keg->uk_name, kl.format, kl.ipers, rsize,
2336                             kl.slabsize, UMA_FIXPT_PCT(kl.eff));
2337
2338                         /* Stop when we reach the minimum efficiency. */
2339                         if (kl.eff >= UMA_MIN_EFF)
2340                                 break;
2341                 }
2342
2343                 if (kl.eff >= UMA_MIN_EFF || !multipage_slabs ||
2344                     slabsize >= SLAB_MAX_SETSIZE * rsize ||
2345                     (keg->uk_flags & (UMA_ZONE_PCPU | UMA_ZONE_CONTIG)) != 0)
2346                         break;
2347         }
2348
2349         pages = atop(kl.slabsize);
2350         if ((keg->uk_flags & UMA_ZONE_PCPU) != 0)
2351                 pages *= mp_maxid + 1;
2352
2353         keg->uk_rsize = rsize;
2354         keg->uk_ipers = kl.ipers;
2355         keg->uk_ppera = pages;
2356         keg->uk_flags |= kl.format;
2357
2358         /*
2359          * How do we find the slab header if it is offpage or if not all item
2360          * start addresses are in the same page?  We could solve the latter
2361          * case with vaddr alignment, but we don't.
2362          */
2363         if ((keg->uk_flags & UMA_ZFLAG_OFFPAGE) != 0 ||
2364             (keg->uk_ipers - 1) * rsize >= PAGE_SIZE) {
2365                 if ((keg->uk_flags & UMA_ZONE_NOTPAGE) != 0)
2366                         keg->uk_flags |= UMA_ZFLAG_HASH;
2367                 else
2368                         keg->uk_flags |= UMA_ZFLAG_VTOSLAB;
2369         }
2370
2371         CTR6(KTR_UMA, "%s: keg=%s, flags=%#x, rsize=%u, ipers=%u, ppera=%u",
2372             __func__, keg->uk_name, keg->uk_flags, rsize, keg->uk_ipers,
2373             pages);
2374         KASSERT(keg->uk_ipers > 0 && keg->uk_ipers <= SLAB_MAX_SETSIZE,
2375             ("%s: keg=%s, flags=0x%b, rsize=%u, ipers=%u, ppera=%u", __func__,
2376              keg->uk_name, keg->uk_flags, PRINT_UMA_ZFLAGS, rsize,
2377              keg->uk_ipers, pages));
2378 }
2379
2380 /*
2381  * Keg header ctor.  This initializes all fields, locks, etc.  And inserts
2382  * the keg onto the global keg list.
2383  *
2384  * Arguments/Returns follow uma_ctor specifications
2385  *      udata  Actually uma_kctor_args
2386  */
2387 static int
2388 keg_ctor(void *mem, int size, void *udata, int flags)
2389 {
2390         struct uma_kctor_args *arg = udata;
2391         uma_keg_t keg = mem;
2392         uma_zone_t zone;
2393         int i;
2394
2395         bzero(keg, size);
2396         keg->uk_size = arg->size;
2397         keg->uk_init = arg->uminit;
2398         keg->uk_fini = arg->fini;
2399         keg->uk_align = arg->align;
2400         keg->uk_reserve = 0;
2401         keg->uk_flags = arg->flags;
2402
2403         /*
2404          * We use a global round-robin policy by default.  Zones with
2405          * UMA_ZONE_FIRSTTOUCH set will use first-touch instead, in which
2406          * case the iterator is never run.
2407          */
2408         keg->uk_dr.dr_policy = DOMAINSET_RR();
2409         keg->uk_dr.dr_iter = 0;
2410
2411         /*
2412          * The primary zone is passed to us at keg-creation time.
2413          */
2414         zone = arg->zone;
2415         keg->uk_name = zone->uz_name;
2416
2417         if (arg->flags & UMA_ZONE_ZINIT)
2418                 keg->uk_init = zero_init;
2419
2420         if (arg->flags & UMA_ZONE_MALLOC)
2421                 keg->uk_flags |= UMA_ZFLAG_VTOSLAB;
2422
2423 #ifndef SMP
2424         keg->uk_flags &= ~UMA_ZONE_PCPU;
2425 #endif
2426
2427         keg_layout(keg);
2428
2429         /*
2430          * Use a first-touch NUMA policy for kegs that pmap_extract() will
2431          * work on.  Use round-robin for everything else.
2432          *
2433          * Zones may override the default by specifying either.
2434          */
2435 #ifdef NUMA
2436         if ((keg->uk_flags &
2437             (UMA_ZONE_ROUNDROBIN | UMA_ZFLAG_CACHE | UMA_ZONE_NOTPAGE)) == 0)
2438                 keg->uk_flags |= UMA_ZONE_FIRSTTOUCH;
2439         else if ((keg->uk_flags & UMA_ZONE_FIRSTTOUCH) == 0)
2440                 keg->uk_flags |= UMA_ZONE_ROUNDROBIN;
2441 #endif
2442
2443         /*
2444          * If we haven't booted yet we need allocations to go through the
2445          * startup cache until the vm is ready.
2446          */
2447 #ifdef UMA_MD_SMALL_ALLOC
2448         if (keg->uk_ppera == 1)
2449                 keg->uk_allocf = uma_small_alloc;
2450         else
2451 #endif
2452         if (booted < BOOT_KVA)
2453                 keg->uk_allocf = startup_alloc;
2454         else if (keg->uk_flags & UMA_ZONE_PCPU)
2455                 keg->uk_allocf = pcpu_page_alloc;
2456         else if ((keg->uk_flags & UMA_ZONE_CONTIG) != 0 && keg->uk_ppera > 1)
2457                 keg->uk_allocf = contig_alloc;
2458         else
2459                 keg->uk_allocf = page_alloc;
2460 #ifdef UMA_MD_SMALL_ALLOC
2461         if (keg->uk_ppera == 1)
2462                 keg->uk_freef = uma_small_free;
2463         else
2464 #endif
2465         if (keg->uk_flags & UMA_ZONE_PCPU)
2466                 keg->uk_freef = pcpu_page_free;
2467         else
2468                 keg->uk_freef = page_free;
2469
2470         /*
2471          * Initialize keg's locks.
2472          */
2473         for (i = 0; i < vm_ndomains; i++)
2474                 KEG_LOCK_INIT(keg, i, (arg->flags & UMA_ZONE_MTXCLASS));
2475
2476         /*
2477          * If we're putting the slab header in the actual page we need to
2478          * figure out where in each page it goes.  See slab_sizeof
2479          * definition.
2480          */
2481         if (!(keg->uk_flags & UMA_ZFLAG_OFFPAGE)) {
2482                 size_t shsize;
2483
2484                 shsize = slab_sizeof(keg->uk_ipers);
2485                 keg->uk_pgoff = (PAGE_SIZE * keg->uk_ppera) - shsize;
2486                 /*
2487                  * The only way the following is possible is if with our
2488                  * UMA_ALIGN_PTR adjustments we are now bigger than
2489                  * UMA_SLAB_SIZE.  I haven't checked whether this is
2490                  * mathematically possible for all cases, so we make
2491                  * sure here anyway.
2492                  */
2493                 KASSERT(keg->uk_pgoff + shsize <= PAGE_SIZE * keg->uk_ppera,
2494                     ("zone %s ipers %d rsize %d size %d slab won't fit",
2495                     zone->uz_name, keg->uk_ipers, keg->uk_rsize, keg->uk_size));
2496         }
2497
2498         if (keg->uk_flags & UMA_ZFLAG_HASH)
2499                 hash_alloc(&keg->uk_hash, 0);
2500
2501         CTR3(KTR_UMA, "keg_ctor %p zone %s(%p)", keg, zone->uz_name, zone);
2502
2503         LIST_INSERT_HEAD(&keg->uk_zones, zone, uz_link);
2504
2505         rw_wlock(&uma_rwlock);
2506         LIST_INSERT_HEAD(&uma_kegs, keg, uk_link);
2507         rw_wunlock(&uma_rwlock);
2508         return (0);
2509 }
2510
2511 static void
2512 zone_kva_available(uma_zone_t zone, void *unused)
2513 {
2514         uma_keg_t keg;
2515
2516         if ((zone->uz_flags & UMA_ZFLAG_CACHE) != 0)
2517                 return;
2518         KEG_GET(zone, keg);
2519
2520         if (keg->uk_allocf == startup_alloc) {
2521                 /* Switch to the real allocator. */
2522                 if (keg->uk_flags & UMA_ZONE_PCPU)
2523                         keg->uk_allocf = pcpu_page_alloc;
2524                 else if ((keg->uk_flags & UMA_ZONE_CONTIG) != 0 &&
2525                     keg->uk_ppera > 1)
2526                         keg->uk_allocf = contig_alloc;
2527                 else
2528                         keg->uk_allocf = page_alloc;
2529         }
2530 }
2531
2532 static void
2533 zone_alloc_counters(uma_zone_t zone, void *unused)
2534 {
2535
2536         zone->uz_allocs = counter_u64_alloc(M_WAITOK);
2537         zone->uz_frees = counter_u64_alloc(M_WAITOK);
2538         zone->uz_fails = counter_u64_alloc(M_WAITOK);
2539         zone->uz_xdomain = counter_u64_alloc(M_WAITOK);
2540 }
2541
2542 static void
2543 zone_alloc_sysctl(uma_zone_t zone, void *unused)
2544 {
2545         uma_zone_domain_t zdom;
2546         uma_domain_t dom;
2547         uma_keg_t keg;
2548         struct sysctl_oid *oid, *domainoid;
2549         int domains, i, cnt;
2550         static const char *nokeg = "cache zone";
2551         char *c;
2552
2553         /*
2554          * Make a sysctl safe copy of the zone name by removing
2555          * any special characters and handling dups by appending
2556          * an index.
2557          */
2558         if (zone->uz_namecnt != 0) {
2559                 /* Count the number of decimal digits and '_' separator. */
2560                 for (i = 1, cnt = zone->uz_namecnt; cnt != 0; i++)
2561                         cnt /= 10;
2562                 zone->uz_ctlname = malloc(strlen(zone->uz_name) + i + 1,
2563                     M_UMA, M_WAITOK);
2564                 sprintf(zone->uz_ctlname, "%s_%d", zone->uz_name,
2565                     zone->uz_namecnt);
2566         } else
2567                 zone->uz_ctlname = strdup(zone->uz_name, M_UMA);
2568         for (c = zone->uz_ctlname; *c != '\0'; c++)
2569                 if (strchr("./\\ -", *c) != NULL)
2570                         *c = '_';
2571
2572         /*
2573          * Basic parameters at the root.
2574          */
2575         zone->uz_oid = SYSCTL_ADD_NODE(NULL, SYSCTL_STATIC_CHILDREN(_vm_uma),
2576             OID_AUTO, zone->uz_ctlname, CTLFLAG_RD | CTLFLAG_MPSAFE, NULL, "");
2577         oid = zone->uz_oid;
2578         SYSCTL_ADD_U32(NULL, SYSCTL_CHILDREN(oid), OID_AUTO,
2579             "size", CTLFLAG_RD, &zone->uz_size, 0, "Allocation size");
2580         SYSCTL_ADD_PROC(NULL, SYSCTL_CHILDREN(oid), OID_AUTO,
2581             "flags", CTLFLAG_RD | CTLTYPE_STRING | CTLFLAG_MPSAFE,
2582             zone, 0, sysctl_handle_uma_zone_flags, "A",
2583             "Allocator configuration flags");
2584         SYSCTL_ADD_U16(NULL, SYSCTL_CHILDREN(oid), OID_AUTO,
2585             "bucket_size", CTLFLAG_RD, &zone->uz_bucket_size, 0,
2586             "Desired per-cpu cache size");
2587         SYSCTL_ADD_U16(NULL, SYSCTL_CHILDREN(oid), OID_AUTO,
2588             "bucket_size_max", CTLFLAG_RD, &zone->uz_bucket_size_max, 0,
2589             "Maximum allowed per-cpu cache size");
2590
2591         /*
2592          * keg if present.
2593          */
2594         if ((zone->uz_flags & UMA_ZFLAG_HASH) == 0)
2595                 domains = vm_ndomains;
2596         else
2597                 domains = 1;
2598         oid = SYSCTL_ADD_NODE(NULL, SYSCTL_CHILDREN(zone->uz_oid), OID_AUTO,
2599             "keg", CTLFLAG_RD | CTLFLAG_MPSAFE, NULL, "");
2600         keg = zone->uz_keg;
2601         if ((zone->uz_flags & UMA_ZFLAG_CACHE) == 0) {
2602                 SYSCTL_ADD_CONST_STRING(NULL, SYSCTL_CHILDREN(oid), OID_AUTO,
2603                     "name", CTLFLAG_RD, keg->uk_name, "Keg name");
2604                 SYSCTL_ADD_U32(NULL, SYSCTL_CHILDREN(oid), OID_AUTO,
2605                     "rsize", CTLFLAG_RD, &keg->uk_rsize, 0,
2606                     "Real object size with alignment");
2607                 SYSCTL_ADD_U16(NULL, SYSCTL_CHILDREN(oid), OID_AUTO,
2608                     "ppera", CTLFLAG_RD, &keg->uk_ppera, 0,
2609                     "pages per-slab allocation");
2610                 SYSCTL_ADD_U16(NULL, SYSCTL_CHILDREN(oid), OID_AUTO,
2611                     "ipers", CTLFLAG_RD, &keg->uk_ipers, 0,
2612                     "items available per-slab");
2613                 SYSCTL_ADD_U32(NULL, SYSCTL_CHILDREN(oid), OID_AUTO,
2614                     "align", CTLFLAG_RD, &keg->uk_align, 0,
2615                     "item alignment mask");
2616                 SYSCTL_ADD_U32(NULL, SYSCTL_CHILDREN(oid), OID_AUTO,
2617                     "reserve", CTLFLAG_RD, &keg->uk_reserve, 0,
2618                     "number of reserved items");
2619                 SYSCTL_ADD_PROC(NULL, SYSCTL_CHILDREN(oid), OID_AUTO,
2620                     "efficiency", CTLFLAG_RD | CTLTYPE_INT | CTLFLAG_MPSAFE,
2621                     keg, 0, sysctl_handle_uma_slab_efficiency, "I",
2622                     "Slab utilization (100 - internal fragmentation %)");
2623                 domainoid = SYSCTL_ADD_NODE(NULL, SYSCTL_CHILDREN(oid),
2624                     OID_AUTO, "domain", CTLFLAG_RD | CTLFLAG_MPSAFE, NULL, "");
2625                 for (i = 0; i < domains; i++) {
2626                         dom = &keg->uk_domain[i];
2627                         oid = SYSCTL_ADD_NODE(NULL, SYSCTL_CHILDREN(domainoid),
2628                             OID_AUTO, VM_DOMAIN(i)->vmd_name,
2629                             CTLFLAG_RD | CTLFLAG_MPSAFE, NULL, "");
2630                         SYSCTL_ADD_U32(NULL, SYSCTL_CHILDREN(oid), OID_AUTO,
2631                             "pages", CTLFLAG_RD, &dom->ud_pages, 0,
2632                             "Total pages currently allocated from VM");
2633                         SYSCTL_ADD_U32(NULL, SYSCTL_CHILDREN(oid), OID_AUTO,
2634                             "free_items", CTLFLAG_RD, &dom->ud_free_items, 0,
2635                             "Items free in the slab layer");
2636                         SYSCTL_ADD_U32(NULL, SYSCTL_CHILDREN(oid), OID_AUTO,
2637                             "free_slabs", CTLFLAG_RD, &dom->ud_free_slabs, 0,
2638                             "Unused slabs");
2639                 }
2640         } else
2641                 SYSCTL_ADD_CONST_STRING(NULL, SYSCTL_CHILDREN(oid), OID_AUTO,
2642                     "name", CTLFLAG_RD, nokeg, "Keg name");
2643
2644         /*
2645          * Information about zone limits.
2646          */
2647         oid = SYSCTL_ADD_NODE(NULL, SYSCTL_CHILDREN(zone->uz_oid), OID_AUTO,
2648             "limit", CTLFLAG_RD | CTLFLAG_MPSAFE, NULL, "");
2649         SYSCTL_ADD_PROC(NULL, SYSCTL_CHILDREN(oid), OID_AUTO,
2650             "items", CTLFLAG_RD | CTLTYPE_U64 | CTLFLAG_MPSAFE,
2651             zone, 0, sysctl_handle_uma_zone_items, "QU",
2652             "Current number of allocated items if limit is set");
2653         SYSCTL_ADD_U64(NULL, SYSCTL_CHILDREN(oid), OID_AUTO,
2654             "max_items", CTLFLAG_RD, &zone->uz_max_items, 0,
2655             "Maximum number of allocated and cached items");
2656         SYSCTL_ADD_U32(NULL, SYSCTL_CHILDREN(oid), OID_AUTO,
2657             "sleepers", CTLFLAG_RD, &zone->uz_sleepers, 0,
2658             "Number of threads sleeping at limit");
2659         SYSCTL_ADD_U64(NULL, SYSCTL_CHILDREN(oid), OID_AUTO,
2660             "sleeps", CTLFLAG_RD, &zone->uz_sleeps, 0,
2661             "Total zone limit sleeps");
2662         SYSCTL_ADD_U64(NULL, SYSCTL_CHILDREN(oid), OID_AUTO,
2663             "bucket_max", CTLFLAG_RD, &zone->uz_bucket_max, 0,
2664             "Maximum number of items in each domain's bucket cache");
2665
2666         /*
2667          * Per-domain zone information.
2668          */
2669         domainoid = SYSCTL_ADD_NODE(NULL, SYSCTL_CHILDREN(zone->uz_oid),
2670             OID_AUTO, "domain", CTLFLAG_RD | CTLFLAG_MPSAFE, NULL, "");
2671         for (i = 0; i < domains; i++) {
2672                 zdom = ZDOM_GET(zone, i);
2673                 oid = SYSCTL_ADD_NODE(NULL, SYSCTL_CHILDREN(domainoid),
2674                     OID_AUTO, VM_DOMAIN(i)->vmd_name,
2675                     CTLFLAG_RD | CTLFLAG_MPSAFE, NULL, "");
2676                 SYSCTL_ADD_LONG(NULL, SYSCTL_CHILDREN(oid), OID_AUTO,
2677                     "nitems", CTLFLAG_RD, &zdom->uzd_nitems,
2678                     "number of items in this domain");
2679                 SYSCTL_ADD_LONG(NULL, SYSCTL_CHILDREN(oid), OID_AUTO,
2680                     "imax", CTLFLAG_RD, &zdom->uzd_imax,
2681                     "maximum item count in this period");
2682                 SYSCTL_ADD_LONG(NULL, SYSCTL_CHILDREN(oid), OID_AUTO,
2683                     "imin", CTLFLAG_RD, &zdom->uzd_imin,
2684                     "minimum item count in this period");
2685                 SYSCTL_ADD_LONG(NULL, SYSCTL_CHILDREN(oid), OID_AUTO,
2686                     "bimin", CTLFLAG_RD, &zdom->uzd_bimin,
2687                     "Minimum item count in this batch");
2688                 SYSCTL_ADD_LONG(NULL, SYSCTL_CHILDREN(oid), OID_AUTO,
2689                     "wss", CTLFLAG_RD, &zdom->uzd_wss,
2690                     "Working set size");
2691                 SYSCTL_ADD_LONG(NULL, SYSCTL_CHILDREN(oid), OID_AUTO,
2692                     "limin", CTLFLAG_RD, &zdom->uzd_limin,
2693                     "Long time minimum item count");
2694                 SYSCTL_ADD_INT(NULL, SYSCTL_CHILDREN(oid), OID_AUTO,
2695                     "timin", CTLFLAG_RD, &zdom->uzd_timin, 0,
2696                     "Time since zero long time minimum item count");
2697         }
2698
2699         /*
2700          * General statistics.
2701          */
2702         oid = SYSCTL_ADD_NODE(NULL, SYSCTL_CHILDREN(zone->uz_oid), OID_AUTO,
2703             "stats", CTLFLAG_RD | CTLFLAG_MPSAFE, NULL, "");
2704         SYSCTL_ADD_PROC(NULL, SYSCTL_CHILDREN(oid), OID_AUTO,
2705             "current", CTLFLAG_RD | CTLTYPE_INT | CTLFLAG_MPSAFE,
2706             zone, 1, sysctl_handle_uma_zone_cur, "I",
2707             "Current number of allocated items");
2708         SYSCTL_ADD_PROC(NULL, SYSCTL_CHILDREN(oid), OID_AUTO,
2709             "allocs", CTLFLAG_RD | CTLTYPE_U64 | CTLFLAG_MPSAFE,
2710             zone, 0, sysctl_handle_uma_zone_allocs, "QU",
2711             "Total allocation calls");
2712         SYSCTL_ADD_PROC(NULL, SYSCTL_CHILDREN(oid), OID_AUTO,
2713             "frees", CTLFLAG_RD | CTLTYPE_U64 | CTLFLAG_MPSAFE,
2714             zone, 0, sysctl_handle_uma_zone_frees, "QU",
2715             "Total free calls");
2716         SYSCTL_ADD_COUNTER_U64(NULL, SYSCTL_CHILDREN(oid), OID_AUTO,
2717             "fails", CTLFLAG_RD, &zone->uz_fails,
2718             "Number of allocation failures");
2719         SYSCTL_ADD_COUNTER_U64(NULL, SYSCTL_CHILDREN(oid), OID_AUTO,
2720             "xdomain", CTLFLAG_RD, &zone->uz_xdomain,
2721             "Free calls from the wrong domain");
2722 }
2723
2724 struct uma_zone_count {
2725         const char      *name;
2726         int             count;
2727 };
2728
2729 static void
2730 zone_count(uma_zone_t zone, void *arg)
2731 {
2732         struct uma_zone_count *cnt;
2733
2734         cnt = arg;
2735         /*
2736          * Some zones are rapidly created with identical names and
2737          * destroyed out of order.  This can lead to gaps in the count.
2738          * Use one greater than the maximum observed for this name.
2739          */
2740         if (strcmp(zone->uz_name, cnt->name) == 0)
2741                 cnt->count = MAX(cnt->count,
2742                     zone->uz_namecnt + 1);
2743 }
2744
2745 static void
2746 zone_update_caches(uma_zone_t zone)
2747 {
2748         int i;
2749
2750         for (i = 0; i <= mp_maxid; i++) {
2751                 cache_set_uz_size(&zone->uz_cpu[i], zone->uz_size);
2752                 cache_set_uz_flags(&zone->uz_cpu[i], zone->uz_flags);
2753         }
2754 }
2755
2756 /*
2757  * Zone header ctor.  This initializes all fields, locks, etc.
2758  *
2759  * Arguments/Returns follow uma_ctor specifications
2760  *      udata  Actually uma_zctor_args
2761  */
2762 static int
2763 zone_ctor(void *mem, int size, void *udata, int flags)
2764 {
2765         struct uma_zone_count cnt;
2766         struct uma_zctor_args *arg = udata;
2767         uma_zone_domain_t zdom;
2768         uma_zone_t zone = mem;
2769         uma_zone_t z;
2770         uma_keg_t keg;
2771         int i;
2772
2773         bzero(zone, size);
2774         zone->uz_name = arg->name;
2775         zone->uz_ctor = arg->ctor;
2776         zone->uz_dtor = arg->dtor;
2777         zone->uz_init = NULL;
2778         zone->uz_fini = NULL;
2779         zone->uz_sleeps = 0;
2780         zone->uz_bucket_size = 0;
2781         zone->uz_bucket_size_min = 0;
2782         zone->uz_bucket_size_max = BUCKET_MAX;
2783         zone->uz_flags = (arg->flags & UMA_ZONE_SMR);
2784         zone->uz_warning = NULL;
2785         /* The domain structures follow the cpu structures. */
2786         zone->uz_bucket_max = ULONG_MAX;
2787         timevalclear(&zone->uz_ratecheck);
2788
2789         /* Count the number of duplicate names. */
2790         cnt.name = arg->name;
2791         cnt.count = 0;
2792         zone_foreach(zone_count, &cnt);
2793         zone->uz_namecnt = cnt.count;
2794         ZONE_CROSS_LOCK_INIT(zone);
2795
2796         for (i = 0; i < vm_ndomains; i++) {
2797                 zdom = ZDOM_GET(zone, i);
2798                 ZDOM_LOCK_INIT(zone, zdom, (arg->flags & UMA_ZONE_MTXCLASS));
2799                 STAILQ_INIT(&zdom->uzd_buckets);
2800         }
2801
2802 #if defined(INVARIANTS) && !defined(KASAN)
2803         if (arg->uminit == trash_init && arg->fini == trash_fini)
2804                 zone->uz_flags |= UMA_ZFLAG_TRASH | UMA_ZFLAG_CTORDTOR;
2805 #elif defined(KASAN)
2806         if ((arg->flags & (UMA_ZONE_NOFREE | UMA_ZFLAG_CACHE)) != 0)
2807                 arg->flags |= UMA_ZONE_NOKASAN;
2808 #endif
2809
2810         /*
2811          * This is a pure cache zone, no kegs.
2812          */
2813         if (arg->import) {
2814                 KASSERT((arg->flags & UMA_ZFLAG_CACHE) != 0,
2815                     ("zone_ctor: Import specified for non-cache zone."));
2816                 zone->uz_flags = arg->flags;
2817                 zone->uz_size = arg->size;
2818                 zone->uz_import = arg->import;
2819                 zone->uz_release = arg->release;
2820                 zone->uz_arg = arg->arg;
2821 #ifdef NUMA
2822                 /*
2823                  * Cache zones are round-robin unless a policy is
2824                  * specified because they may have incompatible
2825                  * constraints.
2826                  */
2827                 if ((zone->uz_flags & UMA_ZONE_FIRSTTOUCH) == 0)
2828                         zone->uz_flags |= UMA_ZONE_ROUNDROBIN;
2829 #endif
2830                 rw_wlock(&uma_rwlock);
2831                 LIST_INSERT_HEAD(&uma_cachezones, zone, uz_link);
2832                 rw_wunlock(&uma_rwlock);
2833                 goto out;
2834         }
2835
2836         /*
2837          * Use the regular zone/keg/slab allocator.
2838          */
2839         zone->uz_import = zone_import;
2840         zone->uz_release = zone_release;
2841         zone->uz_arg = zone;
2842         keg = arg->keg;
2843
2844         if (arg->flags & UMA_ZONE_SECONDARY) {
2845                 KASSERT((zone->uz_flags & UMA_ZONE_SECONDARY) == 0,
2846                     ("Secondary zone requested UMA_ZFLAG_INTERNAL"));
2847                 KASSERT(arg->keg != NULL, ("Secondary zone on zero'd keg"));
2848                 zone->uz_init = arg->uminit;
2849                 zone->uz_fini = arg->fini;
2850                 zone->uz_flags |= UMA_ZONE_SECONDARY;
2851                 rw_wlock(&uma_rwlock);
2852                 ZONE_LOCK(zone);
2853                 LIST_FOREACH(z, &keg->uk_zones, uz_link) {
2854                         if (LIST_NEXT(z, uz_link) == NULL) {
2855                                 LIST_INSERT_AFTER(z, zone, uz_link);
2856                                 break;
2857                         }
2858                 }
2859                 ZONE_UNLOCK(zone);
2860                 rw_wunlock(&uma_rwlock);
2861         } else if (keg == NULL) {
2862                 if ((keg = uma_kcreate(zone, arg->size, arg->uminit, arg->fini,
2863                     arg->align, arg->flags)) == NULL)
2864                         return (ENOMEM);
2865         } else {
2866                 struct uma_kctor_args karg;
2867                 int error;
2868
2869                 /* We should only be here from uma_startup() */
2870                 karg.size = arg->size;
2871                 karg.uminit = arg->uminit;
2872                 karg.fini = arg->fini;
2873                 karg.align = arg->align;
2874                 karg.flags = (arg->flags & ~UMA_ZONE_SMR);
2875                 karg.zone = zone;
2876                 error = keg_ctor(arg->keg, sizeof(struct uma_keg), &karg,
2877                     flags);
2878                 if (error)
2879                         return (error);
2880         }
2881
2882         /* Inherit properties from the keg. */
2883         zone->uz_keg = keg;
2884         zone->uz_size = keg->uk_size;
2885         zone->uz_flags |= (keg->uk_flags &
2886             (UMA_ZONE_INHERIT | UMA_ZFLAG_INHERIT));
2887
2888 out:
2889         if (booted >= BOOT_PCPU) {
2890                 zone_alloc_counters(zone, NULL);
2891                 if (booted >= BOOT_RUNNING)
2892                         zone_alloc_sysctl(zone, NULL);
2893         } else {
2894                 zone->uz_allocs = EARLY_COUNTER;
2895                 zone->uz_frees = EARLY_COUNTER;
2896                 zone->uz_fails = EARLY_COUNTER;
2897         }
2898
2899         /* Caller requests a private SMR context. */
2900         if ((zone->uz_flags & UMA_ZONE_SMR) != 0)
2901                 zone->uz_smr = smr_create(zone->uz_name, 0, 0);
2902
2903         KASSERT((arg->flags & (UMA_ZONE_MAXBUCKET | UMA_ZONE_NOBUCKET)) !=
2904             (UMA_ZONE_MAXBUCKET | UMA_ZONE_NOBUCKET),
2905             ("Invalid zone flag combination"));
2906         if (arg->flags & UMA_ZFLAG_INTERNAL)
2907                 zone->uz_bucket_size_max = zone->uz_bucket_size = 0;
2908         if ((arg->flags & UMA_ZONE_MAXBUCKET) != 0)
2909                 zone->uz_bucket_size = BUCKET_MAX;
2910         else if ((arg->flags & UMA_ZONE_NOBUCKET) != 0)
2911                 zone->uz_bucket_size = 0;
2912         else
2913                 zone->uz_bucket_size = bucket_select(zone->uz_size);
2914         zone->uz_bucket_size_min = zone->uz_bucket_size;
2915         if (zone->uz_dtor != NULL || zone->uz_ctor != NULL)
2916                 zone->uz_flags |= UMA_ZFLAG_CTORDTOR;
2917         zone_update_caches(zone);
2918
2919         return (0);
2920 }
2921
2922 /*
2923  * Keg header dtor.  This frees all data, destroys locks, frees the hash
2924  * table and removes the keg from the global list.
2925  *
2926  * Arguments/Returns follow uma_dtor specifications
2927  *      udata  unused
2928  */
2929 static void
2930 keg_dtor(void *arg, int size, void *udata)
2931 {
2932         uma_keg_t keg;
2933         uint32_t free, pages;
2934         int i;
2935
2936         keg = (uma_keg_t)arg;
2937         free = pages = 0;
2938         for (i = 0; i < vm_ndomains; i++) {
2939                 free += keg->uk_domain[i].ud_free_items;
2940                 pages += keg->uk_domain[i].ud_pages;
2941                 KEG_LOCK_FINI(keg, i);
2942         }
2943         if (pages != 0)
2944                 printf("Freed UMA keg (%s) was not empty (%u items). "
2945                     " Lost %u pages of memory.\n",
2946                     keg->uk_name ? keg->uk_name : "",
2947                     pages / keg->uk_ppera * keg->uk_ipers - free, pages);
2948
2949         hash_free(&keg->uk_hash);
2950 }
2951
2952 /*
2953  * Zone header dtor.
2954  *
2955  * Arguments/Returns follow uma_dtor specifications
2956  *      udata  unused
2957  */
2958 static void
2959 zone_dtor(void *arg, int size, void *udata)
2960 {
2961         uma_zone_t zone;
2962         uma_keg_t keg;
2963         int i;
2964
2965         zone = (uma_zone_t)arg;
2966
2967         sysctl_remove_oid(zone->uz_oid, 1, 1);
2968
2969         if (!(zone->uz_flags & UMA_ZFLAG_INTERNAL))
2970                 cache_drain(zone);
2971
2972         rw_wlock(&uma_rwlock);
2973         LIST_REMOVE(zone, uz_link);
2974         rw_wunlock(&uma_rwlock);
2975         if ((zone->uz_flags & (UMA_ZONE_SECONDARY | UMA_ZFLAG_CACHE)) == 0) {
2976                 keg = zone->uz_keg;
2977                 keg->uk_reserve = 0;
2978         }
2979         zone_reclaim(zone, UMA_ANYDOMAIN, M_WAITOK, true);
2980
2981         /*
2982          * We only destroy kegs from non secondary/non cache zones.
2983          */
2984         if ((zone->uz_flags & (UMA_ZONE_SECONDARY | UMA_ZFLAG_CACHE)) == 0) {
2985                 keg = zone->uz_keg;
2986                 rw_wlock(&uma_rwlock);
2987                 LIST_REMOVE(keg, uk_link);
2988                 rw_wunlock(&uma_rwlock);
2989                 zone_free_item(kegs, keg, NULL, SKIP_NONE);
2990         }
2991         counter_u64_free(zone->uz_allocs);
2992         counter_u64_free(zone->uz_frees);
2993         counter_u64_free(zone->uz_fails);
2994         counter_u64_free(zone->uz_xdomain);
2995         free(zone->uz_ctlname, M_UMA);
2996         for (i = 0; i < vm_ndomains; i++)
2997                 ZDOM_LOCK_FINI(ZDOM_GET(zone, i));
2998         ZONE_CROSS_LOCK_FINI(zone);
2999 }
3000
3001 static void
3002 zone_foreach_unlocked(void (*zfunc)(uma_zone_t, void *arg), void *arg)
3003 {
3004         uma_keg_t keg;
3005         uma_zone_t zone;
3006
3007         LIST_FOREACH(keg, &uma_kegs, uk_link) {
3008                 LIST_FOREACH(zone, &keg->uk_zones, uz_link)
3009                         zfunc(zone, arg);
3010         }
3011         LIST_FOREACH(zone, &uma_cachezones, uz_link)
3012                 zfunc(zone, arg);
3013 }
3014
3015 /*
3016  * Traverses every zone in the system and calls a callback
3017  *
3018  * Arguments:
3019  *      zfunc  A pointer to a function which accepts a zone
3020  *              as an argument.
3021  *
3022  * Returns:
3023  *      Nothing
3024  */
3025 static void
3026 zone_foreach(void (*zfunc)(uma_zone_t, void *arg), void *arg)
3027 {
3028
3029         rw_rlock(&uma_rwlock);
3030         zone_foreach_unlocked(zfunc, arg);
3031         rw_runlock(&uma_rwlock);
3032 }
3033
3034 /*
3035  * Initialize the kernel memory allocator.  This is done after pages can be
3036  * allocated but before general KVA is available.
3037  */
3038 void
3039 uma_startup1(vm_offset_t virtual_avail)
3040 {
3041         struct uma_zctor_args args;
3042         size_t ksize, zsize, size;
3043         uma_keg_t primarykeg;
3044         uintptr_t m;
3045         int domain;
3046         uint8_t pflag;
3047
3048         bootstart = bootmem = virtual_avail;
3049
3050         rw_init(&uma_rwlock, "UMA lock");
3051         sx_init(&uma_reclaim_lock, "umareclaim");
3052
3053         ksize = sizeof(struct uma_keg) +
3054             (sizeof(struct uma_domain) * vm_ndomains);
3055         ksize = roundup(ksize, UMA_SUPER_ALIGN);
3056         zsize = sizeof(struct uma_zone) +
3057             (sizeof(struct uma_cache) * (mp_maxid + 1)) +
3058             (sizeof(struct uma_zone_domain) * vm_ndomains);
3059         zsize = roundup(zsize, UMA_SUPER_ALIGN);
3060
3061         /* Allocate the zone of zones, zone of kegs, and zone of zones keg. */
3062         size = (zsize * 2) + ksize;
3063         for (domain = 0; domain < vm_ndomains; domain++) {
3064                 m = (uintptr_t)startup_alloc(NULL, size, domain, &pflag,
3065                     M_NOWAIT | M_ZERO);
3066                 if (m != 0)
3067                         break;
3068         }
3069         zones = (uma_zone_t)m;
3070         m += zsize;
3071         kegs = (uma_zone_t)m;
3072         m += zsize;
3073         primarykeg = (uma_keg_t)m;
3074
3075         /* "manually" create the initial zone */
3076         memset(&args, 0, sizeof(args));
3077         args.name = "UMA Kegs";
3078         args.size = ksize;
3079         args.ctor = keg_ctor;
3080         args.dtor = keg_dtor;
3081         args.uminit = zero_init;
3082         args.fini = NULL;
3083         args.keg = primarykeg;
3084         args.align = UMA_SUPER_ALIGN - 1;
3085         args.flags = UMA_ZFLAG_INTERNAL;
3086         zone_ctor(kegs, zsize, &args, M_WAITOK);
3087
3088         args.name = "UMA Zones";
3089         args.size = zsize;
3090         args.ctor = zone_ctor;
3091         args.dtor = zone_dtor;
3092         args.uminit = zero_init;
3093         args.fini = NULL;
3094         args.keg = NULL;
3095         args.align = UMA_SUPER_ALIGN - 1;
3096         args.flags = UMA_ZFLAG_INTERNAL;
3097         zone_ctor(zones, zsize, &args, M_WAITOK);
3098
3099         /* Now make zones for slab headers */
3100         slabzones[0] = uma_zcreate("UMA Slabs 0", SLABZONE0_SIZE,
3101             NULL, NULL, NULL, NULL, UMA_ALIGN_PTR, UMA_ZFLAG_INTERNAL);
3102         slabzones[1] = uma_zcreate("UMA Slabs 1", SLABZONE1_SIZE,
3103             NULL, NULL, NULL, NULL, UMA_ALIGN_PTR, UMA_ZFLAG_INTERNAL);
3104
3105         hashzone = uma_zcreate("UMA Hash",
3106             sizeof(struct slabhead *) * UMA_HASH_SIZE_INIT,
3107             NULL, NULL, NULL, NULL, UMA_ALIGN_PTR, UMA_ZFLAG_INTERNAL);
3108
3109         bucket_init();
3110         smr_init();
3111 }
3112
3113 #ifndef UMA_MD_SMALL_ALLOC
3114 extern void vm_radix_reserve_kva(void);
3115 #endif
3116
3117 /*
3118  * Advertise the availability of normal kva allocations and switch to
3119  * the default back-end allocator.  Marks the KVA we consumed on startup
3120  * as used in the map.
3121  */
3122 void
3123 uma_startup2(void)
3124 {
3125
3126         if (bootstart != bootmem) {
3127                 vm_map_lock(kernel_map);
3128                 (void)vm_map_insert(kernel_map, NULL, 0, bootstart, bootmem,
3129                     VM_PROT_RW, VM_PROT_RW, MAP_NOFAULT);
3130                 vm_map_unlock(kernel_map);
3131         }
3132
3133 #ifndef UMA_MD_SMALL_ALLOC
3134         /* Set up radix zone to use noobj_alloc. */
3135         vm_radix_reserve_kva();
3136 #endif
3137
3138         booted = BOOT_KVA;
3139         zone_foreach_unlocked(zone_kva_available, NULL);
3140         bucket_enable();
3141 }
3142
3143 /*
3144  * Allocate counters as early as possible so that boot-time allocations are
3145  * accounted more precisely.
3146  */
3147 static void
3148 uma_startup_pcpu(void *arg __unused)
3149 {
3150
3151         zone_foreach_unlocked(zone_alloc_counters, NULL);
3152         booted = BOOT_PCPU;
3153 }
3154 SYSINIT(uma_startup_pcpu, SI_SUB_COUNTER, SI_ORDER_ANY, uma_startup_pcpu, NULL);
3155
3156 /*
3157  * Finish our initialization steps.
3158  */
3159 static void
3160 uma_startup3(void *arg __unused)
3161 {
3162
3163 #ifdef INVARIANTS
3164         TUNABLE_INT_FETCH("vm.debug.divisor", &dbg_divisor);
3165         uma_dbg_cnt = counter_u64_alloc(M_WAITOK);
3166         uma_skip_cnt = counter_u64_alloc(M_WAITOK);
3167 #endif
3168         zone_foreach_unlocked(zone_alloc_sysctl, NULL);
3169         callout_init(&uma_callout, 1);
3170         callout_reset(&uma_callout, UMA_TIMEOUT * hz, uma_timeout, NULL);
3171         booted = BOOT_RUNNING;
3172
3173         EVENTHANDLER_REGISTER(shutdown_post_sync, uma_shutdown, NULL,
3174             EVENTHANDLER_PRI_FIRST);
3175 }
3176 SYSINIT(uma_startup3, SI_SUB_VM_CONF, SI_ORDER_SECOND, uma_startup3, NULL);
3177
3178 static void
3179 uma_shutdown(void)
3180 {
3181
3182         booted = BOOT_SHUTDOWN;
3183 }
3184
3185 static uma_keg_t
3186 uma_kcreate(uma_zone_t zone, size_t size, uma_init uminit, uma_fini fini,
3187                 int align, uint32_t flags)
3188 {
3189         struct uma_kctor_args args;
3190
3191         args.size = size;
3192         args.uminit = uminit;
3193         args.fini = fini;
3194         args.align = (align == UMA_ALIGN_CACHE) ? uma_align_cache : align;
3195         args.flags = flags;
3196         args.zone = zone;
3197         return (zone_alloc_item(kegs, &args, UMA_ANYDOMAIN, M_WAITOK));
3198 }
3199
3200 /* Public functions */
3201 /* See uma.h */
3202 void
3203 uma_set_align(int align)
3204 {
3205
3206         if (align != UMA_ALIGN_CACHE)
3207                 uma_align_cache = align;
3208 }
3209
3210 /* See uma.h */
3211 uma_zone_t
3212 uma_zcreate(const char *name, size_t size, uma_ctor ctor, uma_dtor dtor,
3213                 uma_init uminit, uma_fini fini, int align, uint32_t flags)
3214
3215 {
3216         struct uma_zctor_args args;
3217         uma_zone_t res;
3218
3219         KASSERT(powerof2(align + 1), ("invalid zone alignment %d for \"%s\"",
3220             align, name));
3221
3222         /* This stuff is essential for the zone ctor */
3223         memset(&args, 0, sizeof(args));
3224         args.name = name;
3225         args.size = size;
3226         args.ctor = ctor;
3227         args.dtor = dtor;
3228         args.uminit = uminit;
3229         args.fini = fini;
3230 #if defined(INVARIANTS) && !defined(KASAN)
3231         /*
3232          * Inject procedures which check for memory use after free if we are
3233          * allowed to scramble the memory while it is not allocated.  This
3234          * requires that: UMA is actually able to access the memory, no init
3235          * or fini procedures, no dependency on the initial value of the
3236          * memory, and no (legitimate) use of the memory after free.  Note,
3237          * the ctor and dtor do not need to be empty.
3238          */
3239         if ((!(flags & (UMA_ZONE_ZINIT | UMA_ZONE_NOTOUCH |
3240             UMA_ZONE_NOFREE))) && uminit == NULL && fini == NULL) {
3241                 args.uminit = trash_init;
3242                 args.fini = trash_fini;
3243         }
3244 #endif
3245         args.align = align;
3246         args.flags = flags;
3247         args.keg = NULL;
3248
3249         sx_xlock(&uma_reclaim_lock);
3250         res = zone_alloc_item(zones, &args, UMA_ANYDOMAIN, M_WAITOK);
3251         sx_xunlock(&uma_reclaim_lock);
3252
3253         return (res);
3254 }
3255
3256 /* See uma.h */
3257 uma_zone_t
3258 uma_zsecond_create(const char *name, uma_ctor ctor, uma_dtor dtor,
3259     uma_init zinit, uma_fini zfini, uma_zone_t primary)
3260 {
3261         struct uma_zctor_args args;
3262         uma_keg_t keg;
3263         uma_zone_t res;
3264
3265         keg = primary->uz_keg;
3266         memset(&args, 0, sizeof(args));
3267         args.name = name;
3268         args.size = keg->uk_size;
3269         args.ctor = ctor;
3270         args.dtor = dtor;
3271         args.uminit = zinit;
3272         args.fini = zfini;
3273         args.align = keg->uk_align;
3274         args.flags = keg->uk_flags | UMA_ZONE_SECONDARY;
3275         args.keg = keg;
3276
3277         sx_xlock(&uma_reclaim_lock);
3278         res = zone_alloc_item(zones, &args, UMA_ANYDOMAIN, M_WAITOK);
3279         sx_xunlock(&uma_reclaim_lock);
3280
3281         return (res);
3282 }
3283
3284 /* See uma.h */
3285 uma_zone_t
3286 uma_zcache_create(const char *name, int size, uma_ctor ctor, uma_dtor dtor,
3287     uma_init zinit, uma_fini zfini, uma_import zimport, uma_release zrelease,
3288     void *arg, int flags)
3289 {
3290         struct uma_zctor_args args;
3291
3292         memset(&args, 0, sizeof(args));
3293         args.name = name;
3294         args.size = size;
3295         args.ctor = ctor;
3296         args.dtor = dtor;
3297         args.uminit = zinit;
3298         args.fini = zfini;
3299         args.import = zimport;
3300         args.release = zrelease;
3301         args.arg = arg;
3302         args.align = 0;
3303         args.flags = flags | UMA_ZFLAG_CACHE;
3304
3305         return (zone_alloc_item(zones, &args, UMA_ANYDOMAIN, M_WAITOK));
3306 }
3307
3308 /* See uma.h */
3309 void
3310 uma_zdestroy(uma_zone_t zone)
3311 {
3312
3313         /*
3314          * Large slabs are expensive to reclaim, so don't bother doing
3315          * unnecessary work if we're shutting down.
3316          */
3317         if (booted == BOOT_SHUTDOWN &&
3318             zone->uz_fini == NULL && zone->uz_release == zone_release)
3319                 return;
3320         sx_xlock(&uma_reclaim_lock);
3321         zone_free_item(zones, zone, NULL, SKIP_NONE);
3322         sx_xunlock(&uma_reclaim_lock);
3323 }
3324
3325 void
3326 uma_zwait(uma_zone_t zone)
3327 {
3328
3329         if ((zone->uz_flags & UMA_ZONE_SMR) != 0)
3330                 uma_zfree_smr(zone, uma_zalloc_smr(zone, M_WAITOK));
3331         else if ((zone->uz_flags & UMA_ZONE_PCPU) != 0)
3332                 uma_zfree_pcpu(zone, uma_zalloc_pcpu(zone, M_WAITOK));
3333         else
3334                 uma_zfree(zone, uma_zalloc(zone, M_WAITOK));
3335 }
3336
3337 void *
3338 uma_zalloc_pcpu_arg(uma_zone_t zone, void *udata, int flags)
3339 {
3340         void *item, *pcpu_item;
3341 #ifdef SMP
3342         int i;
3343
3344         MPASS(zone->uz_flags & UMA_ZONE_PCPU);
3345 #endif
3346         item = uma_zalloc_arg(zone, udata, flags & ~M_ZERO);
3347         if (item == NULL)
3348                 return (NULL);
3349         pcpu_item = zpcpu_base_to_offset(item);
3350         if (flags & M_ZERO) {
3351 #ifdef SMP
3352                 for (i = 0; i <= mp_maxid; i++)
3353                         bzero(zpcpu_get_cpu(pcpu_item, i), zone->uz_size);
3354 #else
3355                 bzero(item, zone->uz_size);
3356 #endif
3357         }
3358         return (pcpu_item);
3359 }
3360
3361 /*
3362  * A stub while both regular and pcpu cases are identical.
3363  */
3364 void
3365 uma_zfree_pcpu_arg(uma_zone_t zone, void *pcpu_item, void *udata)
3366 {
3367         void *item;
3368
3369 #ifdef SMP
3370         MPASS(zone->uz_flags & UMA_ZONE_PCPU);
3371 #endif
3372
3373         /* uma_zfree_pcu_*(..., NULL) does nothing, to match free(9). */
3374         if (pcpu_item == NULL)
3375                 return;
3376
3377         item = zpcpu_offset_to_base(pcpu_item);
3378         uma_zfree_arg(zone, item, udata);
3379 }
3380
3381 static inline void *
3382 item_ctor(uma_zone_t zone, int uz_flags, int size, void *udata, int flags,
3383     void *item)
3384 {
3385 #ifdef INVARIANTS
3386         bool skipdbg;
3387 #endif
3388
3389         kasan_mark_item_valid(zone, item);
3390
3391 #ifdef INVARIANTS
3392         skipdbg = uma_dbg_zskip(zone, item);
3393         if (!skipdbg && (uz_flags & UMA_ZFLAG_TRASH) != 0 &&
3394             zone->uz_ctor != trash_ctor)
3395                 trash_ctor(item, size, udata, flags);
3396 #endif
3397
3398         /* Check flags before loading ctor pointer. */
3399         if (__predict_false((uz_flags & UMA_ZFLAG_CTORDTOR) != 0) &&
3400             __predict_false(zone->uz_ctor != NULL) &&
3401             zone->uz_ctor(item, size, udata, flags) != 0) {
3402                 counter_u64_add(zone->uz_fails, 1);
3403                 zone_free_item(zone, item, udata, SKIP_DTOR | SKIP_CNT);
3404                 return (NULL);
3405         }
3406 #ifdef INVARIANTS
3407         if (!skipdbg)
3408                 uma_dbg_alloc(zone, NULL, item);
3409 #endif
3410         if (__predict_false(flags & M_ZERO))
3411                 return (memset(item, 0, size));
3412
3413         return (item);
3414 }
3415
3416 static inline void
3417 item_dtor(uma_zone_t zone, void *item, int size, void *udata,
3418     enum zfreeskip skip)
3419 {
3420 #ifdef INVARIANTS
3421         bool skipdbg;
3422
3423         skipdbg = uma_dbg_zskip(zone, item);
3424         if (skip == SKIP_NONE && !skipdbg) {
3425                 if ((zone->uz_flags & UMA_ZONE_MALLOC) != 0)
3426                         uma_dbg_free(zone, udata, item);
3427                 else
3428                         uma_dbg_free(zone, NULL, item);
3429         }
3430 #endif
3431         if (__predict_true(skip < SKIP_DTOR)) {
3432                 if (zone->uz_dtor != NULL)
3433                         zone->uz_dtor(item, size, udata);
3434 #ifdef INVARIANTS
3435                 if (!skipdbg && (zone->uz_flags & UMA_ZFLAG_TRASH) != 0 &&
3436                     zone->uz_dtor != trash_dtor)
3437                         trash_dtor(item, size, udata);
3438 #endif
3439         }
3440         kasan_mark_item_invalid(zone, item);
3441 }
3442
3443 #ifdef NUMA
3444 static int
3445 item_domain(void *item)
3446 {
3447         int domain;
3448
3449         domain = vm_phys_domain(vtophys(item));
3450         KASSERT(domain >= 0 && domain < vm_ndomains,
3451             ("%s: unknown domain for item %p", __func__, item));
3452         return (domain);
3453 }
3454 #endif
3455
3456 #if defined(INVARIANTS) || defined(DEBUG_MEMGUARD) || defined(WITNESS)
3457 #define UMA_ZALLOC_DEBUG
3458 static int
3459 uma_zalloc_debug(uma_zone_t zone, void **itemp, void *udata, int flags)
3460 {
3461         int error;
3462
3463         error = 0;
3464 #ifdef WITNESS
3465         if (flags & M_WAITOK) {
3466                 WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL,
3467                     "uma_zalloc_debug: zone \"%s\"", zone->uz_name);
3468         }
3469 #endif
3470
3471 #ifdef INVARIANTS
3472         KASSERT((flags & M_EXEC) == 0,
3473             ("uma_zalloc_debug: called with M_EXEC"));
3474         KASSERT(curthread->td_critnest == 0 || SCHEDULER_STOPPED(),
3475             ("uma_zalloc_debug: called within spinlock or critical section"));
3476         KASSERT((zone->uz_flags & UMA_ZONE_PCPU) == 0 || (flags & M_ZERO) == 0,
3477             ("uma_zalloc_debug: allocating from a pcpu zone with M_ZERO"));
3478 #endif
3479
3480 #ifdef DEBUG_MEMGUARD
3481         if ((zone->uz_flags & UMA_ZONE_SMR) == 0 && memguard_cmp_zone(zone)) {
3482                 void *item;
3483                 item = memguard_alloc(zone->uz_size, flags);
3484                 if (item != NULL) {
3485                         error = EJUSTRETURN;
3486                         if (zone->uz_init != NULL &&
3487                             zone->uz_init(item, zone->uz_size, flags) != 0) {
3488                                 *itemp = NULL;
3489                                 return (error);
3490                         }
3491                         if (zone->uz_ctor != NULL &&
3492                             zone->uz_ctor(item, zone->uz_size, udata,
3493                             flags) != 0) {
3494                                 counter_u64_add(zone->uz_fails, 1);
3495                                 zone->uz_fini(item, zone->uz_size);
3496                                 *itemp = NULL;
3497                                 return (error);
3498                         }
3499                         *itemp = item;
3500                         return (error);
3501                 }
3502                 /* This is unfortunate but should not be fatal. */
3503         }
3504 #endif
3505         return (error);
3506 }
3507
3508 static int
3509 uma_zfree_debug(uma_zone_t zone, void *item, void *udata)
3510 {
3511         KASSERT(curthread->td_critnest == 0 || SCHEDULER_STOPPED(),
3512             ("uma_zfree_debug: called with spinlock or critical section held"));
3513
3514 #ifdef DEBUG_MEMGUARD
3515         if ((zone->uz_flags & UMA_ZONE_SMR) == 0 && is_memguard_addr(item)) {
3516                 if (zone->uz_dtor != NULL)
3517                         zone->uz_dtor(item, zone->uz_size, udata);
3518                 if (zone->uz_fini != NULL)
3519                         zone->uz_fini(item, zone->uz_size);
3520                 memguard_free(item);
3521                 return (EJUSTRETURN);
3522         }
3523 #endif
3524         return (0);
3525 }
3526 #endif
3527
3528 static inline void *
3529 cache_alloc_item(uma_zone_t zone, uma_cache_t cache, uma_cache_bucket_t bucket,
3530     void *udata, int flags)
3531 {
3532         void *item;
3533         int size, uz_flags;
3534
3535         item = cache_bucket_pop(cache, bucket);
3536         size = cache_uz_size(cache);
3537         uz_flags = cache_uz_flags(cache);
3538         critical_exit();
3539         return (item_ctor(zone, uz_flags, size, udata, flags, item));
3540 }
3541
3542 static __noinline void *
3543 cache_alloc_retry(uma_zone_t zone, uma_cache_t cache, void *udata, int flags)
3544 {
3545         uma_cache_bucket_t bucket;
3546         int domain;
3547
3548         while (cache_alloc(zone, cache, udata, flags)) {
3549                 cache = &zone->uz_cpu[curcpu];
3550                 bucket = &cache->uc_allocbucket;
3551                 if (__predict_false(bucket->ucb_cnt == 0))
3552                         continue;
3553                 return (cache_alloc_item(zone, cache, bucket, udata, flags));
3554         }
3555         critical_exit();
3556
3557         /*
3558          * We can not get a bucket so try to return a single item.
3559          */
3560         if (zone->uz_flags & UMA_ZONE_FIRSTTOUCH)
3561                 domain = PCPU_GET(domain);
3562         else
3563                 domain = UMA_ANYDOMAIN;
3564         return (zone_alloc_item(zone, udata, domain, flags));
3565 }
3566
3567 /* See uma.h */
3568 void *
3569 uma_zalloc_smr(uma_zone_t zone, int flags)
3570 {
3571         uma_cache_bucket_t bucket;
3572         uma_cache_t cache;
3573
3574 #ifdef UMA_ZALLOC_DEBUG
3575         void *item;
3576
3577         KASSERT((zone->uz_flags & UMA_ZONE_SMR) != 0,
3578             ("uma_zalloc_arg: called with non-SMR zone."));
3579         if (uma_zalloc_debug(zone, &item, NULL, flags) == EJUSTRETURN)
3580                 return (item);
3581 #endif
3582
3583         critical_enter();
3584         cache = &zone->uz_cpu[curcpu];
3585         bucket = &cache->uc_allocbucket;
3586         if (__predict_false(bucket->ucb_cnt == 0))
3587                 return (cache_alloc_retry(zone, cache, NULL, flags));
3588         return (cache_alloc_item(zone, cache, bucket, NULL, flags));
3589 }
3590
3591 /* See uma.h */
3592 void *
3593 uma_zalloc_arg(uma_zone_t zone, void *udata, int flags)
3594 {
3595         uma_cache_bucket_t bucket;
3596         uma_cache_t cache;
3597
3598         /* Enable entropy collection for RANDOM_ENABLE_UMA kernel option */
3599         random_harvest_fast_uma(&zone, sizeof(zone), RANDOM_UMA);
3600
3601         /* This is the fast path allocation */
3602         CTR3(KTR_UMA, "uma_zalloc_arg zone %s(%p) flags %d", zone->uz_name,
3603             zone, flags);
3604
3605 #ifdef UMA_ZALLOC_DEBUG
3606         void *item;
3607
3608         KASSERT((zone->uz_flags & UMA_ZONE_SMR) == 0,
3609             ("uma_zalloc_arg: called with SMR zone."));
3610         if (uma_zalloc_debug(zone, &item, udata, flags) == EJUSTRETURN)
3611                 return (item);
3612 #endif
3613
3614         /*
3615          * If possible, allocate from the per-CPU cache.  There are two
3616          * requirements for safe access to the per-CPU cache: (1) the thread
3617          * accessing the cache must not be preempted or yield during access,
3618          * and (2) the thread must not migrate CPUs without switching which
3619          * cache it accesses.  We rely on a critical section to prevent
3620          * preemption and migration.  We release the critical section in
3621          * order to acquire the zone mutex if we are unable to allocate from
3622          * the current cache; when we re-acquire the critical section, we
3623          * must detect and handle migration if it has occurred.
3624          */
3625         critical_enter();
3626         cache = &zone->uz_cpu[curcpu];
3627         bucket = &cache->uc_allocbucket;
3628         if (__predict_false(bucket->ucb_cnt == 0))
3629                 return (cache_alloc_retry(zone, cache, udata, flags));
3630         return (cache_alloc_item(zone, cache, bucket, udata, flags));
3631 }
3632
3633 /*
3634  * Replenish an alloc bucket and possibly restore an old one.  Called in
3635  * a critical section.  Returns in a critical section.
3636  *
3637  * A false return value indicates an allocation failure.
3638  * A true return value indicates success and the caller should retry.
3639  */
3640 static __noinline bool
3641 cache_alloc(uma_zone_t zone, uma_cache_t cache, void *udata, int flags)
3642 {
3643         uma_bucket_t bucket;
3644         int curdomain, domain;
3645         bool new;
3646
3647         CRITICAL_ASSERT(curthread);
3648
3649         /*
3650          * If we have run out of items in our alloc bucket see
3651          * if we can switch with the free bucket.
3652          *
3653          * SMR Zones can't re-use the free bucket until the sequence has
3654          * expired.
3655          */
3656         if ((cache_uz_flags(cache) & UMA_ZONE_SMR) == 0 &&
3657             cache->uc_freebucket.ucb_cnt != 0) {
3658                 cache_bucket_swap(&cache->uc_freebucket,
3659                     &cache->uc_allocbucket);
3660                 return (true);
3661         }
3662
3663         /*
3664          * Discard any empty allocation bucket while we hold no locks.
3665          */
3666         bucket = cache_bucket_unload_alloc(cache);
3667         critical_exit();
3668
3669         if (bucket != NULL) {
3670                 KASSERT(bucket->ub_cnt == 0,
3671                     ("cache_alloc: Entered with non-empty alloc bucket."));
3672                 bucket_free(zone, bucket, udata);
3673         }
3674
3675         /*
3676          * Attempt to retrieve the item from the per-CPU cache has failed, so
3677          * we must go back to the zone.  This requires the zdom lock, so we
3678          * must drop the critical section, then re-acquire it when we go back
3679          * to the cache.  Since the critical section is released, we may be
3680          * preempted or migrate.  As such, make sure not to maintain any
3681          * thread-local state specific to the cache from prior to releasing
3682          * the critical section.
3683          */
3684         domain = PCPU_GET(domain);
3685         if ((cache_uz_flags(cache) & UMA_ZONE_ROUNDROBIN) != 0 ||
3686             VM_DOMAIN_EMPTY(domain))
3687                 domain = zone_domain_highest(zone, domain);
3688         bucket = cache_fetch_bucket(zone, cache, domain);
3689         if (bucket == NULL && zone->uz_bucket_size != 0 && !bucketdisable) {
3690                 bucket = zone_alloc_bucket(zone, udata, domain, flags);
3691                 new = true;
3692         } else {
3693                 new = false;
3694         }
3695
3696         CTR3(KTR_UMA, "uma_zalloc: zone %s(%p) bucket zone returned %p",
3697             zone->uz_name, zone, bucket);
3698         if (bucket == NULL) {
3699                 critical_enter();
3700                 return (false);
3701         }
3702
3703         /*
3704          * See if we lost the race or were migrated.  Cache the
3705          * initialized bucket to make this less likely or claim
3706          * the memory directly.
3707          */
3708         critical_enter();
3709         cache = &zone->uz_cpu[curcpu];
3710         if (cache->uc_allocbucket.ucb_bucket == NULL &&
3711             ((cache_uz_flags(cache) & UMA_ZONE_FIRSTTOUCH) == 0 ||
3712             (curdomain = PCPU_GET(domain)) == domain ||
3713             VM_DOMAIN_EMPTY(curdomain))) {
3714                 if (new)
3715                         atomic_add_long(&ZDOM_GET(zone, domain)->uzd_imax,
3716                             bucket->ub_cnt);
3717                 cache_bucket_load_alloc(cache, bucket);
3718                 return (true);
3719         }
3720
3721         /*
3722          * We lost the race, release this bucket and start over.
3723          */
3724         critical_exit();
3725         zone_put_bucket(zone, domain, bucket, udata, !new);
3726         critical_enter();
3727
3728         return (true);
3729 }
3730
3731 void *
3732 uma_zalloc_domain(uma_zone_t zone, void *udata, int domain, int flags)
3733 {
3734 #ifdef NUMA
3735         uma_bucket_t bucket;
3736         uma_zone_domain_t zdom;
3737         void *item;
3738 #endif
3739
3740         /* Enable entropy collection for RANDOM_ENABLE_UMA kernel option */
3741         random_harvest_fast_uma(&zone, sizeof(zone), RANDOM_UMA);
3742
3743         /* This is the fast path allocation */
3744         CTR4(KTR_UMA, "uma_zalloc_domain zone %s(%p) domain %d flags %d",
3745             zone->uz_name, zone, domain, flags);
3746
3747         if (flags & M_WAITOK) {
3748                 WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL,
3749                     "uma_zalloc_domain: zone \"%s\"", zone->uz_name);
3750         }
3751         KASSERT(curthread->td_critnest == 0 || SCHEDULER_STOPPED(),
3752             ("uma_zalloc_domain: called with spinlock or critical section held"));
3753         KASSERT((zone->uz_flags & UMA_ZONE_SMR) == 0,
3754             ("uma_zalloc_domain: called with SMR zone."));
3755 #ifdef NUMA
3756         KASSERT((zone->uz_flags & UMA_ZONE_FIRSTTOUCH) != 0,
3757             ("uma_zalloc_domain: called with non-FIRSTTOUCH zone."));
3758
3759         if (vm_ndomains == 1)
3760                 return (uma_zalloc_arg(zone, udata, flags));
3761
3762         /*
3763          * Try to allocate from the bucket cache before falling back to the keg.
3764          * We could try harder and attempt to allocate from per-CPU caches or
3765          * the per-domain cross-domain buckets, but the complexity is probably
3766          * not worth it.  It is more important that frees of previous
3767          * cross-domain allocations do not blow up the cache.
3768          */
3769         zdom = zone_domain_lock(zone, domain);
3770         if ((bucket = zone_fetch_bucket(zone, zdom, false)) != NULL) {
3771                 item = bucket->ub_bucket[bucket->ub_cnt - 1];
3772 #ifdef INVARIANTS
3773                 bucket->ub_bucket[bucket->ub_cnt - 1] = NULL;
3774 #endif
3775                 bucket->ub_cnt--;
3776                 zone_put_bucket(zone, domain, bucket, udata, true);
3777                 item = item_ctor(zone, zone->uz_flags, zone->uz_size, udata,
3778                     flags, item);
3779                 if (item != NULL) {
3780                         KASSERT(item_domain(item) == domain,
3781                             ("%s: bucket cache item %p from wrong domain",
3782                             __func__, item));
3783                         counter_u64_add(zone->uz_allocs, 1);
3784                 }
3785                 return (item);
3786         }
3787         ZDOM_UNLOCK(zdom);
3788         return (zone_alloc_item(zone, udata, domain, flags));
3789 #else
3790         return (uma_zalloc_arg(zone, udata, flags));
3791 #endif
3792 }
3793
3794 /*
3795  * Find a slab with some space.  Prefer slabs that are partially used over those
3796  * that are totally full.  This helps to reduce fragmentation.
3797  *
3798  * If 'rr' is 1, search all domains starting from 'domain'.  Otherwise check
3799  * only 'domain'.
3800  */
3801 static uma_slab_t
3802 keg_first_slab(uma_keg_t keg, int domain, bool rr)
3803 {
3804         uma_domain_t dom;
3805         uma_slab_t slab;
3806         int start;
3807
3808         KASSERT(domain >= 0 && domain < vm_ndomains,
3809             ("keg_first_slab: domain %d out of range", domain));
3810         KEG_LOCK_ASSERT(keg, domain);
3811
3812         slab = NULL;
3813         start = domain;
3814         do {
3815                 dom = &keg->uk_domain[domain];
3816                 if ((slab = LIST_FIRST(&dom->ud_part_slab)) != NULL)
3817                         return (slab);
3818                 if ((slab = LIST_FIRST(&dom->ud_free_slab)) != NULL) {
3819                         LIST_REMOVE(slab, us_link);
3820                         dom->ud_free_slabs--;
3821                         LIST_INSERT_HEAD(&dom->ud_part_slab, slab, us_link);
3822                         return (slab);
3823                 }
3824                 if (rr)
3825                         domain = (domain + 1) % vm_ndomains;
3826         } while (domain != start);
3827
3828         return (NULL);
3829 }
3830
3831 /*
3832  * Fetch an existing slab from a free or partial list.  Returns with the
3833  * keg domain lock held if a slab was found or unlocked if not.
3834  */
3835 static uma_slab_t
3836 keg_fetch_free_slab(uma_keg_t keg, int domain, bool rr, int flags)
3837 {
3838         uma_slab_t slab;
3839         uint32_t reserve;
3840
3841         /* HASH has a single free list. */
3842         if ((keg->uk_flags & UMA_ZFLAG_HASH) != 0)
3843                 domain = 0;
3844
3845         KEG_LOCK(keg, domain);
3846         reserve = (flags & M_USE_RESERVE) != 0 ? 0 : keg->uk_reserve;
3847         if (keg->uk_domain[domain].ud_free_items <= reserve ||
3848             (slab = keg_first_slab(keg, domain, rr)) == NULL) {
3849                 KEG_UNLOCK(keg, domain);
3850                 return (NULL);
3851         }
3852         return (slab);
3853 }
3854
3855 static uma_slab_t
3856 keg_fetch_slab(uma_keg_t keg, uma_zone_t zone, int rdomain, const int flags)
3857 {
3858         struct vm_domainset_iter di;
3859         uma_slab_t slab;
3860         int aflags, domain;
3861         bool rr;
3862
3863         KASSERT((flags & (M_WAITOK | M_NOVM)) != (M_WAITOK | M_NOVM),
3864             ("%s: invalid flags %#x", __func__, flags));
3865
3866 restart:
3867         /*
3868          * Use the keg's policy if upper layers haven't already specified a
3869          * domain (as happens with first-touch zones).
3870          *
3871          * To avoid races we run the iterator with the keg lock held, but that
3872          * means that we cannot allow the vm_domainset layer to sleep.  Thus,
3873          * clear M_WAITOK and handle low memory conditions locally.
3874          */
3875         rr = rdomain == UMA_ANYDOMAIN;
3876         if (rr) {
3877                 aflags = (flags & ~M_WAITOK) | M_NOWAIT;
3878                 vm_domainset_iter_policy_ref_init(&di, &keg->uk_dr, &domain,
3879                     &aflags);
3880         } else {
3881                 aflags = flags;
3882                 domain = rdomain;
3883         }
3884
3885         for (;;) {
3886                 slab = keg_fetch_free_slab(keg, domain, rr, flags);
3887                 if (slab != NULL)
3888                         return (slab);
3889
3890                 /*
3891                  * M_NOVM is used to break the recursion that can otherwise
3892                  * occur if low-level memory management routines use UMA.
3893                  */
3894                 if ((flags & M_NOVM) == 0) {
3895                         slab = keg_alloc_slab(keg, zone, domain, flags, aflags);
3896                         if (slab != NULL)
3897                                 return (slab);
3898                 }
3899
3900                 if (!rr) {
3901                         if ((flags & M_USE_RESERVE) != 0) {
3902                                 /*
3903                                  * Drain reserves from other domains before
3904                                  * giving up or sleeping.  It may be useful to
3905                                  * support per-domain reserves eventually.
3906                                  */
3907                                 rdomain = UMA_ANYDOMAIN;
3908                                 goto restart;
3909                         }
3910                         if ((flags & M_WAITOK) == 0)
3911                                 break;
3912                         vm_wait_domain(domain);
3913                 } else if (vm_domainset_iter_policy(&di, &domain) != 0) {
3914                         if ((flags & M_WAITOK) != 0) {
3915                                 vm_wait_doms(&keg->uk_dr.dr_policy->ds_mask, 0);
3916                                 goto restart;
3917                         }
3918                         break;
3919                 }
3920         }
3921
3922         /*
3923          * We might not have been able to get a slab but another cpu
3924          * could have while we were unlocked.  Check again before we
3925          * fail.
3926          */
3927         if ((slab = keg_fetch_free_slab(keg, domain, rr, flags)) != NULL)
3928                 return (slab);
3929
3930         return (NULL);
3931 }
3932
3933 static void *
3934 slab_alloc_item(uma_keg_t keg, uma_slab_t slab)
3935 {
3936         uma_domain_t dom;
3937         void *item;
3938         int freei;
3939
3940         KEG_LOCK_ASSERT(keg, slab->us_domain);
3941
3942         dom = &keg->uk_domain[slab->us_domain];
3943         freei = BIT_FFS(keg->uk_ipers, &slab->us_free) - 1;
3944         BIT_CLR(keg->uk_ipers, freei, &slab->us_free);
3945         item = slab_item(slab, keg, freei);
3946         slab->us_freecount--;
3947         dom->ud_free_items--;
3948
3949         /*
3950          * Move this slab to the full list.  It must be on the partial list, so
3951          * we do not need to update the free slab count.  In particular,
3952          * keg_fetch_slab() always returns slabs on the partial list.
3953          */
3954         if (slab->us_freecount == 0) {
3955                 LIST_REMOVE(slab, us_link);
3956                 LIST_INSERT_HEAD(&dom->ud_full_slab, slab, us_link);
3957         }
3958
3959         return (item);
3960 }
3961
3962 static int
3963 zone_import(void *arg, void **bucket, int max, int domain, int flags)
3964 {
3965         uma_domain_t dom;
3966         uma_zone_t zone;
3967         uma_slab_t slab;
3968         uma_keg_t keg;
3969 #ifdef NUMA
3970         int stripe;
3971 #endif
3972         int i;
3973
3974         zone = arg;
3975         slab = NULL;
3976         keg = zone->uz_keg;
3977         /* Try to keep the buckets totally full */
3978         for (i = 0; i < max; ) {
3979                 if ((slab = keg_fetch_slab(keg, zone, domain, flags)) == NULL)
3980                         break;
3981 #ifdef NUMA
3982                 stripe = howmany(max, vm_ndomains);
3983 #endif
3984                 dom = &keg->uk_domain[slab->us_domain];
3985                 do {
3986                         bucket[i++] = slab_alloc_item(keg, slab);
3987                         if (keg->uk_reserve > 0 &&
3988                             dom->ud_free_items <= keg->uk_reserve) {
3989                                 /*
3990                                  * Avoid depleting the reserve after a
3991                                  * successful item allocation, even if
3992                                  * M_USE_RESERVE is specified.
3993                                  */
3994                                 KEG_UNLOCK(keg, slab->us_domain);
3995                                 goto out;
3996                         }
3997 #ifdef NUMA
3998                         /*
3999                          * If the zone is striped we pick a new slab for every
4000                          * N allocations.  Eliminating this conditional will
4001                          * instead pick a new domain for each bucket rather
4002                          * than stripe within each bucket.  The current option
4003                          * produces more fragmentation and requires more cpu
4004                          * time but yields better distribution.
4005                          */
4006                         if ((zone->uz_flags & UMA_ZONE_ROUNDROBIN) != 0 &&
4007                             vm_ndomains > 1 && --stripe == 0)
4008                                 break;
4009 #endif
4010                 } while (slab->us_freecount != 0 && i < max);
4011                 KEG_UNLOCK(keg, slab->us_domain);
4012
4013                 /* Don't block if we allocated any successfully. */
4014                 flags &= ~M_WAITOK;
4015                 flags |= M_NOWAIT;
4016         }
4017 out:
4018         return i;
4019 }
4020
4021 static int
4022 zone_alloc_limit_hard(uma_zone_t zone, int count, int flags)
4023 {
4024         uint64_t old, new, total, max;
4025
4026         /*
4027          * The hard case.  We're going to sleep because there were existing
4028          * sleepers or because we ran out of items.  This routine enforces
4029          * fairness by keeping fifo order.
4030          *
4031          * First release our ill gotten gains and make some noise.
4032          */
4033         for (;;) {
4034                 zone_free_limit(zone, count);
4035                 zone_log_warning(zone);
4036                 zone_maxaction(zone);
4037                 if (flags & M_NOWAIT)
4038                         return (0);
4039
4040                 /*
4041                  * We need to allocate an item or set ourself as a sleeper
4042                  * while the sleepq lock is held to avoid wakeup races.  This
4043                  * is essentially a home rolled semaphore.
4044                  */
4045                 sleepq_lock(&zone->uz_max_items);
4046                 old = zone->uz_items;
4047                 do {
4048                         MPASS(UZ_ITEMS_SLEEPERS(old) < UZ_ITEMS_SLEEPERS_MAX);
4049                         /* Cache the max since we will evaluate twice. */
4050                         max = zone->uz_max_items;
4051                         if (UZ_ITEMS_SLEEPERS(old) != 0 ||
4052                             UZ_ITEMS_COUNT(old) >= max)
4053                                 new = old + UZ_ITEMS_SLEEPER;
4054                         else
4055                                 new = old + MIN(count, max - old);
4056                 } while (atomic_fcmpset_64(&zone->uz_items, &old, new) == 0);
4057
4058                 /* We may have successfully allocated under the sleepq lock. */
4059                 if (UZ_ITEMS_SLEEPERS(new) == 0) {
4060                         sleepq_release(&zone->uz_max_items);
4061                         return (new - old);
4062                 }
4063
4064                 /*
4065                  * This is in a different cacheline from uz_items so that we
4066                  * don't constantly invalidate the fastpath cacheline when we
4067                  * adjust item counts.  This could be limited to toggling on
4068                  * transitions.
4069                  */
4070                 atomic_add_32(&zone->uz_sleepers, 1);
4071                 atomic_add_64(&zone->uz_sleeps, 1);
4072
4073                 /*
4074                  * We have added ourselves as a sleeper.  The sleepq lock
4075                  * protects us from wakeup races.  Sleep now and then retry.
4076                  */
4077                 sleepq_add(&zone->uz_max_items, NULL, "zonelimit", 0, 0);
4078                 sleepq_wait(&zone->uz_max_items, PVM);
4079
4080                 /*
4081                  * After wakeup, remove ourselves as a sleeper and try
4082                  * again.  We no longer have the sleepq lock for protection.
4083                  *
4084                  * Subract ourselves as a sleeper while attempting to add
4085                  * our count.
4086                  */
4087                 atomic_subtract_32(&zone->uz_sleepers, 1);
4088                 old = atomic_fetchadd_64(&zone->uz_items,
4089                     -(UZ_ITEMS_SLEEPER - count));
4090                 /* We're no longer a sleeper. */
4091                 old -= UZ_ITEMS_SLEEPER;
4092
4093                 /*
4094                  * If we're still at the limit, restart.  Notably do not
4095                  * block on other sleepers.  Cache the max value to protect
4096                  * against changes via sysctl.
4097                  */
4098                 total = UZ_ITEMS_COUNT(old);
4099                 max = zone->uz_max_items;
4100                 if (total >= max)
4101                         continue;
4102                 /* Truncate if necessary, otherwise wake other sleepers. */
4103                 if (total + count > max) {
4104                         zone_free_limit(zone, total + count - max);
4105                         count = max - total;
4106                 } else if (total + count < max && UZ_ITEMS_SLEEPERS(old) != 0)
4107                         wakeup_one(&zone->uz_max_items);
4108
4109                 return (count);
4110         }
4111 }
4112
4113 /*
4114  * Allocate 'count' items from our max_items limit.  Returns the number
4115  * available.  If M_NOWAIT is not specified it will sleep until at least
4116  * one item can be allocated.
4117  */
4118 static int
4119 zone_alloc_limit(uma_zone_t zone, int count, int flags)
4120 {
4121         uint64_t old;
4122         uint64_t max;
4123
4124         max = zone->uz_max_items;
4125         MPASS(max > 0);
4126
4127         /*
4128          * We expect normal allocations to succeed with a simple
4129          * fetchadd.
4130          */
4131         old = atomic_fetchadd_64(&zone->uz_items, count);
4132         if (__predict_true(old + count <= max))
4133                 return (count);
4134
4135         /*
4136          * If we had some items and no sleepers just return the
4137          * truncated value.  We have to release the excess space
4138          * though because that may wake sleepers who weren't woken
4139          * because we were temporarily over the limit.
4140          */
4141         if (old < max) {
4142                 zone_free_limit(zone, (old + count) - max);
4143                 return (max - old);
4144         }
4145         return (zone_alloc_limit_hard(zone, count, flags));
4146 }
4147
4148 /*
4149  * Free a number of items back to the limit.
4150  */
4151 static void
4152 zone_free_limit(uma_zone_t zone, int count)
4153 {
4154         uint64_t old;
4155
4156         MPASS(count > 0);
4157
4158         /*
4159          * In the common case we either have no sleepers or
4160          * are still over the limit and can just return.
4161          */
4162         old = atomic_fetchadd_64(&zone->uz_items, -count);
4163         if (__predict_true(UZ_ITEMS_SLEEPERS(old) == 0 ||
4164            UZ_ITEMS_COUNT(old) - count >= zone->uz_max_items))
4165                 return;
4166
4167         /*
4168          * Moderate the rate of wakeups.  Sleepers will continue
4169          * to generate wakeups if necessary.
4170          */
4171         wakeup_one(&zone->uz_max_items);
4172 }
4173
4174 static uma_bucket_t
4175 zone_alloc_bucket(uma_zone_t zone, void *udata, int domain, int flags)
4176 {
4177         uma_bucket_t bucket;
4178         int error, maxbucket, cnt;
4179
4180         CTR3(KTR_UMA, "zone_alloc_bucket zone %s(%p) domain %d", zone->uz_name,
4181             zone, domain);
4182
4183         /* Avoid allocs targeting empty domains. */
4184         if (domain != UMA_ANYDOMAIN && VM_DOMAIN_EMPTY(domain))
4185                 domain = UMA_ANYDOMAIN;
4186         else if ((zone->uz_flags & UMA_ZONE_ROUNDROBIN) != 0)
4187                 domain = UMA_ANYDOMAIN;
4188
4189         if (zone->uz_max_items > 0)
4190                 maxbucket = zone_alloc_limit(zone, zone->uz_bucket_size,
4191                     M_NOWAIT);
4192         else
4193                 maxbucket = zone->uz_bucket_size;
4194         if (maxbucket == 0)
4195                 return (false);
4196
4197         /* Don't wait for buckets, preserve caller's NOVM setting. */
4198         bucket = bucket_alloc(zone, udata, M_NOWAIT | (flags & M_NOVM));
4199         if (bucket == NULL) {
4200                 cnt = 0;
4201                 goto out;
4202         }
4203
4204         bucket->ub_cnt = zone->uz_import(zone->uz_arg, bucket->ub_bucket,
4205             MIN(maxbucket, bucket->ub_entries), domain, flags);
4206
4207         /*
4208          * Initialize the memory if necessary.
4209          */
4210         if (bucket->ub_cnt != 0 && zone->uz_init != NULL) {
4211                 int i;
4212
4213                 for (i = 0; i < bucket->ub_cnt; i++) {
4214                         kasan_mark_item_valid(zone, bucket->ub_bucket[i]);
4215                         error = zone->uz_init(bucket->ub_bucket[i],
4216                             zone->uz_size, flags);
4217                         kasan_mark_item_invalid(zone, bucket->ub_bucket[i]);
4218                         if (error != 0)
4219                                 break;
4220                 }
4221
4222                 /*
4223                  * If we couldn't initialize the whole bucket, put the
4224                  * rest back onto the freelist.
4225                  */
4226                 if (i != bucket->ub_cnt) {
4227                         zone->uz_release(zone->uz_arg, &bucket->ub_bucket[i],
4228                             bucket->ub_cnt - i);
4229 #ifdef INVARIANTS
4230                         bzero(&bucket->ub_bucket[i],
4231                             sizeof(void *) * (bucket->ub_cnt - i));
4232 #endif
4233                         bucket->ub_cnt = i;
4234                 }
4235         }
4236
4237         cnt = bucket->ub_cnt;
4238         if (bucket->ub_cnt == 0) {
4239                 bucket_free(zone, bucket, udata);
4240                 counter_u64_add(zone->uz_fails, 1);
4241                 bucket = NULL;
4242         }
4243 out:
4244         if (zone->uz_max_items > 0 && cnt < maxbucket)
4245                 zone_free_limit(zone, maxbucket - cnt);
4246
4247         return (bucket);
4248 }
4249
4250 /*
4251  * Allocates a single item from a zone.
4252  *
4253  * Arguments
4254  *      zone   The zone to alloc for.
4255  *      udata  The data to be passed to the constructor.
4256  *      domain The domain to allocate from or UMA_ANYDOMAIN.
4257  *      flags  M_WAITOK, M_NOWAIT, M_ZERO.
4258  *
4259  * Returns
4260  *      NULL if there is no memory and M_NOWAIT is set
4261  *      An item if successful
4262  */
4263
4264 static void *
4265 zone_alloc_item(uma_zone_t zone, void *udata, int domain, int flags)
4266 {
4267         void *item;
4268
4269         if (zone->uz_max_items > 0 && zone_alloc_limit(zone, 1, flags) == 0) {
4270                 counter_u64_add(zone->uz_fails, 1);
4271                 return (NULL);
4272         }
4273
4274         /* Avoid allocs targeting empty domains. */
4275         if (domain != UMA_ANYDOMAIN && VM_DOMAIN_EMPTY(domain))
4276                 domain = UMA_ANYDOMAIN;
4277
4278         if (zone->uz_import(zone->uz_arg, &item, 1, domain, flags) != 1)
4279                 goto fail_cnt;
4280
4281         /*
4282          * We have to call both the zone's init (not the keg's init)
4283          * and the zone's ctor.  This is because the item is going from
4284          * a keg slab directly to the user, and the user is expecting it
4285          * to be both zone-init'd as well as zone-ctor'd.
4286          */
4287         if (zone->uz_init != NULL) {
4288                 int error;
4289
4290                 kasan_mark_item_valid(zone, item);
4291                 error = zone->uz_init(item, zone->uz_size, flags);
4292                 kasan_mark_item_invalid(zone, item);
4293                 if (error != 0) {
4294                         zone_free_item(zone, item, udata, SKIP_FINI | SKIP_CNT);
4295                         goto fail_cnt;
4296                 }
4297         }
4298         item = item_ctor(zone, zone->uz_flags, zone->uz_size, udata, flags,
4299             item);
4300         if (item == NULL)
4301                 goto fail;
4302
4303         counter_u64_add(zone->uz_allocs, 1);
4304         CTR3(KTR_UMA, "zone_alloc_item item %p from %s(%p)", item,
4305             zone->uz_name, zone);
4306
4307         return (item);
4308
4309 fail_cnt:
4310         counter_u64_add(zone->uz_fails, 1);
4311 fail:
4312         if (zone->uz_max_items > 0)
4313                 zone_free_limit(zone, 1);
4314         CTR2(KTR_UMA, "zone_alloc_item failed from %s(%p)",
4315             zone->uz_name, zone);
4316
4317         return (NULL);
4318 }
4319
4320 /* See uma.h */
4321 void
4322 uma_zfree_smr(uma_zone_t zone, void *item)
4323 {
4324         uma_cache_t cache;
4325         uma_cache_bucket_t bucket;
4326         int itemdomain, uz_flags;
4327
4328 #ifdef UMA_ZALLOC_DEBUG
4329         KASSERT((zone->uz_flags & UMA_ZONE_SMR) != 0,
4330             ("uma_zfree_smr: called with non-SMR zone."));
4331         KASSERT(item != NULL, ("uma_zfree_smr: Called with NULL pointer."));
4332         SMR_ASSERT_NOT_ENTERED(zone->uz_smr);
4333         if (uma_zfree_debug(zone, item, NULL) == EJUSTRETURN)
4334                 return;
4335 #endif
4336         cache = &zone->uz_cpu[curcpu];
4337         uz_flags = cache_uz_flags(cache);
4338         itemdomain = 0;
4339 #ifdef NUMA
4340         if ((uz_flags & UMA_ZONE_FIRSTTOUCH) != 0)
4341                 itemdomain = item_domain(item);
4342 #endif
4343         critical_enter();
4344         do {
4345                 cache = &zone->uz_cpu[curcpu];
4346                 /* SMR Zones must free to the free bucket. */
4347                 bucket = &cache->uc_freebucket;
4348 #ifdef NUMA
4349                 if ((uz_flags & UMA_ZONE_FIRSTTOUCH) != 0 &&
4350                     PCPU_GET(domain) != itemdomain) {
4351                         bucket = &cache->uc_crossbucket;
4352                 }
4353 #endif
4354                 if (__predict_true(bucket->ucb_cnt < bucket->ucb_entries)) {
4355                         cache_bucket_push(cache, bucket, item);
4356                         critical_exit();
4357                         return;
4358                 }
4359         } while (cache_free(zone, cache, NULL, item, itemdomain));
4360         critical_exit();
4361
4362         /*
4363          * If nothing else caught this, we'll just do an internal free.
4364          */
4365         zone_free_item(zone, item, NULL, SKIP_NONE);
4366 }
4367
4368 /* See uma.h */
4369 void
4370 uma_zfree_arg(uma_zone_t zone, void *item, void *udata)
4371 {
4372         uma_cache_t cache;
4373         uma_cache_bucket_t bucket;
4374         int itemdomain, uz_flags;
4375
4376         /* Enable entropy collection for RANDOM_ENABLE_UMA kernel option */
4377         random_harvest_fast_uma(&zone, sizeof(zone), RANDOM_UMA);
4378
4379         CTR2(KTR_UMA, "uma_zfree_arg zone %s(%p)", zone->uz_name, zone);
4380
4381 #ifdef UMA_ZALLOC_DEBUG
4382         KASSERT((zone->uz_flags & UMA_ZONE_SMR) == 0,
4383             ("uma_zfree_arg: called with SMR zone."));
4384         if (uma_zfree_debug(zone, item, udata) == EJUSTRETURN)
4385                 return;
4386 #endif
4387         /* uma_zfree(..., NULL) does nothing, to match free(9). */
4388         if (item == NULL)
4389                 return;
4390
4391         /*
4392          * We are accessing the per-cpu cache without a critical section to
4393          * fetch size and flags.  This is acceptable, if we are preempted we
4394          * will simply read another cpu's line.
4395          */
4396         cache = &zone->uz_cpu[curcpu];
4397         uz_flags = cache_uz_flags(cache);
4398         if (UMA_ALWAYS_CTORDTOR ||
4399             __predict_false((uz_flags & UMA_ZFLAG_CTORDTOR) != 0))
4400                 item_dtor(zone, item, cache_uz_size(cache), udata, SKIP_NONE);
4401
4402         /*
4403          * The race here is acceptable.  If we miss it we'll just have to wait
4404          * a little longer for the limits to be reset.
4405          */
4406         if (__predict_false(uz_flags & UMA_ZFLAG_LIMIT)) {
4407                 if (atomic_load_32(&zone->uz_sleepers) > 0)
4408                         goto zfree_item;
4409         }
4410
4411         /*
4412          * If possible, free to the per-CPU cache.  There are two
4413          * requirements for safe access to the per-CPU cache: (1) the thread
4414          * accessing the cache must not be preempted or yield during access,
4415          * and (2) the thread must not migrate CPUs without switching which
4416          * cache it accesses.  We rely on a critical section to prevent
4417          * preemption and migration.  We release the critical section in
4418          * order to acquire the zone mutex if we are unable to free to the
4419          * current cache; when we re-acquire the critical section, we must
4420          * detect and handle migration if it has occurred.
4421          */
4422         itemdomain = 0;
4423 #ifdef NUMA
4424         if ((uz_flags & UMA_ZONE_FIRSTTOUCH) != 0)
4425                 itemdomain = item_domain(item);
4426 #endif
4427         critical_enter();
4428         do {
4429                 cache = &zone->uz_cpu[curcpu];
4430                 /*
4431                  * Try to free into the allocbucket first to give LIFO
4432                  * ordering for cache-hot datastructures.  Spill over
4433                  * into the freebucket if necessary.  Alloc will swap
4434                  * them if one runs dry.
4435                  */
4436                 bucket = &cache->uc_allocbucket;
4437 #ifdef NUMA
4438                 if ((uz_flags & UMA_ZONE_FIRSTTOUCH) != 0 &&
4439                     PCPU_GET(domain) != itemdomain) {
4440                         bucket = &cache->uc_crossbucket;
4441                 } else
4442 #endif
4443                 if (bucket->ucb_cnt == bucket->ucb_entries &&
4444                    cache->uc_freebucket.ucb_cnt <
4445                    cache->uc_freebucket.ucb_entries)
4446                         cache_bucket_swap(&cache->uc_freebucket,
4447                             &cache->uc_allocbucket);
4448                 if (__predict_true(bucket->ucb_cnt < bucket->ucb_entries)) {
4449                         cache_bucket_push(cache, bucket, item);
4450                         critical_exit();
4451                         return;
4452                 }
4453         } while (cache_free(zone, cache, udata, item, itemdomain));
4454         critical_exit();
4455
4456         /*
4457          * If nothing else caught this, we'll just do an internal free.
4458          */
4459 zfree_item:
4460         zone_free_item(zone, item, udata, SKIP_DTOR);
4461 }
4462
4463 #ifdef NUMA
4464 /*
4465  * sort crossdomain free buckets to domain correct buckets and cache
4466  * them.
4467  */
4468 static void
4469 zone_free_cross(uma_zone_t zone, uma_bucket_t bucket, void *udata)
4470 {
4471         struct uma_bucketlist emptybuckets, fullbuckets;
4472         uma_zone_domain_t zdom;
4473         uma_bucket_t b;
4474         smr_seq_t seq;
4475         void *item;
4476         int domain;
4477
4478         CTR3(KTR_UMA,
4479             "uma_zfree: zone %s(%p) draining cross bucket %p",
4480             zone->uz_name, zone, bucket);
4481
4482         /*
4483          * It is possible for buckets to arrive here out of order so we fetch
4484          * the current smr seq rather than accepting the bucket's.
4485          */
4486         seq = SMR_SEQ_INVALID;
4487         if ((zone->uz_flags & UMA_ZONE_SMR) != 0)
4488                 seq = smr_advance(zone->uz_smr);
4489
4490         /*
4491          * To avoid having ndomain * ndomain buckets for sorting we have a
4492          * lock on the current crossfree bucket.  A full matrix with
4493          * per-domain locking could be used if necessary.
4494          */
4495         STAILQ_INIT(&emptybuckets);
4496         STAILQ_INIT(&fullbuckets);
4497         ZONE_CROSS_LOCK(zone);
4498         for (; bucket->ub_cnt > 0; bucket->ub_cnt--) {
4499                 item = bucket->ub_bucket[bucket->ub_cnt - 1];
4500                 domain = item_domain(item);
4501                 zdom = ZDOM_GET(zone, domain);
4502                 if (zdom->uzd_cross == NULL) {
4503                         if ((b = STAILQ_FIRST(&emptybuckets)) != NULL) {
4504                                 STAILQ_REMOVE_HEAD(&emptybuckets, ub_link);
4505                                 zdom->uzd_cross = b;
4506                         } else {
4507                                 /*
4508                                  * Avoid allocating a bucket with the cross lock
4509                                  * held, since allocation can trigger a
4510                                  * cross-domain free and bucket zones may
4511                                  * allocate from each other.
4512                                  */
4513                                 ZONE_CROSS_UNLOCK(zone);
4514                                 b = bucket_alloc(zone, udata, M_NOWAIT);
4515                                 if (b == NULL)
4516                                         goto out;
4517                                 ZONE_CROSS_LOCK(zone);
4518                                 if (zdom->uzd_cross != NULL) {
4519                                         STAILQ_INSERT_HEAD(&emptybuckets, b,
4520                                             ub_link);
4521                                 } else {
4522                                         zdom->uzd_cross = b;
4523                                 }
4524                         }
4525                 }
4526                 b = zdom->uzd_cross;
4527                 b->ub_bucket[b->ub_cnt++] = item;
4528                 b->ub_seq = seq;
4529                 if (b->ub_cnt == b->ub_entries) {
4530                         STAILQ_INSERT_HEAD(&fullbuckets, b, ub_link);
4531                         if ((b = STAILQ_FIRST(&emptybuckets)) != NULL)
4532                                 STAILQ_REMOVE_HEAD(&emptybuckets, ub_link);
4533                         zdom->uzd_cross = b;
4534                 }
4535         }
4536         ZONE_CROSS_UNLOCK(zone);
4537 out:
4538         if (bucket->ub_cnt == 0)
4539                 bucket->ub_seq = SMR_SEQ_INVALID;
4540         bucket_free(zone, bucket, udata);
4541
4542         while ((b = STAILQ_FIRST(&emptybuckets)) != NULL) {
4543                 STAILQ_REMOVE_HEAD(&emptybuckets, ub_link);
4544                 bucket_free(zone, b, udata);
4545         }
4546         while ((b = STAILQ_FIRST(&fullbuckets)) != NULL) {
4547                 STAILQ_REMOVE_HEAD(&fullbuckets, ub_link);
4548                 domain = item_domain(b->ub_bucket[0]);
4549                 zone_put_bucket(zone, domain, b, udata, true);
4550         }
4551 }
4552 #endif
4553
4554 static void
4555 zone_free_bucket(uma_zone_t zone, uma_bucket_t bucket, void *udata,
4556     int itemdomain, bool ws)
4557 {
4558
4559 #ifdef NUMA
4560         /*
4561          * Buckets coming from the wrong domain will be entirely for the
4562          * only other domain on two domain systems.  In this case we can
4563          * simply cache them.  Otherwise we need to sort them back to
4564          * correct domains.
4565          */
4566         if ((zone->uz_flags & UMA_ZONE_FIRSTTOUCH) != 0 &&
4567             vm_ndomains > 2 && PCPU_GET(domain) != itemdomain) {
4568                 zone_free_cross(zone, bucket, udata);
4569                 return;
4570         }
4571 #endif
4572
4573         /*
4574          * Attempt to save the bucket in the zone's domain bucket cache.
4575          */
4576         CTR3(KTR_UMA,
4577             "uma_zfree: zone %s(%p) putting bucket %p on free list",
4578             zone->uz_name, zone, bucket);
4579         /* ub_cnt is pointing to the last free item */
4580         if ((zone->uz_flags & UMA_ZONE_ROUNDROBIN) != 0)
4581                 itemdomain = zone_domain_lowest(zone, itemdomain);
4582         zone_put_bucket(zone, itemdomain, bucket, udata, ws);
4583 }
4584
4585 /*
4586  * Populate a free or cross bucket for the current cpu cache.  Free any
4587  * existing full bucket either to the zone cache or back to the slab layer.
4588  *
4589  * Enters and returns in a critical section.  false return indicates that
4590  * we can not satisfy this free in the cache layer.  true indicates that
4591  * the caller should retry.
4592  */
4593 static __noinline bool
4594 cache_free(uma_zone_t zone, uma_cache_t cache, void *udata, void *item,
4595     int itemdomain)
4596 {
4597         uma_cache_bucket_t cbucket;
4598         uma_bucket_t newbucket, bucket;
4599
4600         CRITICAL_ASSERT(curthread);
4601
4602         if (zone->uz_bucket_size == 0)
4603                 return false;
4604
4605         cache = &zone->uz_cpu[curcpu];
4606         newbucket = NULL;
4607
4608         /*
4609          * FIRSTTOUCH domains need to free to the correct zdom.  When
4610          * enabled this is the zdom of the item.   The bucket is the
4611          * cross bucket if the current domain and itemdomain do not match.
4612          */
4613         cbucket = &cache->uc_freebucket;
4614 #ifdef NUMA
4615         if ((cache_uz_flags(cache) & UMA_ZONE_FIRSTTOUCH) != 0) {
4616                 if (PCPU_GET(domain) != itemdomain) {
4617                         cbucket = &cache->uc_crossbucket;
4618                         if (cbucket->ucb_cnt != 0)
4619                                 counter_u64_add(zone->uz_xdomain,
4620                                     cbucket->ucb_cnt);
4621                 }
4622         }
4623 #endif
4624         bucket = cache_bucket_unload(cbucket);
4625         KASSERT(bucket == NULL || bucket->ub_cnt == bucket->ub_entries,
4626             ("cache_free: Entered with non-full free bucket."));
4627
4628         /* We are no longer associated with this CPU. */
4629         critical_exit();
4630
4631         /*
4632          * Don't let SMR zones operate without a free bucket.  Force
4633          * a synchronize and re-use this one.  We will only degrade
4634          * to a synchronize every bucket_size items rather than every
4635          * item if we fail to allocate a bucket.
4636          */
4637         if ((zone->uz_flags & UMA_ZONE_SMR) != 0) {
4638                 if (bucket != NULL)
4639                         bucket->ub_seq = smr_advance(zone->uz_smr);
4640                 newbucket = bucket_alloc(zone, udata, M_NOWAIT);
4641                 if (newbucket == NULL && bucket != NULL) {
4642                         bucket_drain(zone, bucket);
4643                         newbucket = bucket;
4644                         bucket = NULL;
4645                 }
4646         } else if (!bucketdisable)
4647                 newbucket = bucket_alloc(zone, udata, M_NOWAIT);
4648
4649         if (bucket != NULL)
4650                 zone_free_bucket(zone, bucket, udata, itemdomain, true);
4651
4652         critical_enter();
4653         if ((bucket = newbucket) == NULL)
4654                 return (false);
4655         cache = &zone->uz_cpu[curcpu];
4656 #ifdef NUMA
4657         /*
4658          * Check to see if we should be populating the cross bucket.  If it
4659          * is already populated we will fall through and attempt to populate
4660          * the free bucket.
4661          */
4662         if ((cache_uz_flags(cache) & UMA_ZONE_FIRSTTOUCH) != 0) {
4663                 if (PCPU_GET(domain) != itemdomain &&
4664                     cache->uc_crossbucket.ucb_bucket == NULL) {
4665                         cache_bucket_load_cross(cache, bucket);
4666                         return (true);
4667                 }
4668         }
4669 #endif
4670         /*
4671          * We may have lost the race to fill the bucket or switched CPUs.
4672          */
4673         if (cache->uc_freebucket.ucb_bucket != NULL) {
4674                 critical_exit();
4675                 bucket_free(zone, bucket, udata);
4676                 critical_enter();
4677         } else
4678                 cache_bucket_load_free(cache, bucket);
4679
4680         return (true);
4681 }
4682
4683 static void
4684 slab_free_item(uma_zone_t zone, uma_slab_t slab, void *item)
4685 {
4686         uma_keg_t keg;
4687         uma_domain_t dom;
4688         int freei;
4689
4690         keg = zone->uz_keg;
4691         KEG_LOCK_ASSERT(keg, slab->us_domain);
4692
4693         /* Do we need to remove from any lists? */
4694         dom = &keg->uk_domain[slab->us_domain];
4695         if (slab->us_freecount + 1 == keg->uk_ipers) {
4696                 LIST_REMOVE(slab, us_link);
4697                 LIST_INSERT_HEAD(&dom->ud_free_slab, slab, us_link);
4698                 dom->ud_free_slabs++;
4699         } else if (slab->us_freecount == 0) {
4700                 LIST_REMOVE(slab, us_link);
4701                 LIST_INSERT_HEAD(&dom->ud_part_slab, slab, us_link);
4702         }
4703
4704         /* Slab management. */
4705         freei = slab_item_index(slab, keg, item);
4706         BIT_SET(keg->uk_ipers, freei, &slab->us_free);
4707         slab->us_freecount++;
4708
4709         /* Keg statistics. */
4710         dom->ud_free_items++;
4711 }
4712
4713 static void
4714 zone_release(void *arg, void **bucket, int cnt)
4715 {
4716         struct mtx *lock;
4717         uma_zone_t zone;
4718         uma_slab_t slab;
4719         uma_keg_t keg;
4720         uint8_t *mem;
4721         void *item;
4722         int i;
4723
4724         zone = arg;
4725         keg = zone->uz_keg;
4726         lock = NULL;
4727         if (__predict_false((zone->uz_flags & UMA_ZFLAG_HASH) != 0))
4728                 lock = KEG_LOCK(keg, 0);
4729         for (i = 0; i < cnt; i++) {
4730                 item = bucket[i];
4731                 if (__predict_true((zone->uz_flags & UMA_ZFLAG_VTOSLAB) != 0)) {
4732                         slab = vtoslab((vm_offset_t)item);
4733                 } else {
4734                         mem = (uint8_t *)((uintptr_t)item & (~UMA_SLAB_MASK));
4735                         if ((zone->uz_flags & UMA_ZFLAG_HASH) != 0)
4736                                 slab = hash_sfind(&keg->uk_hash, mem);
4737                         else
4738                                 slab = (uma_slab_t)(mem + keg->uk_pgoff);
4739                 }
4740                 if (lock != KEG_LOCKPTR(keg, slab->us_domain)) {
4741                         if (lock != NULL)
4742                                 mtx_unlock(lock);
4743                         lock = KEG_LOCK(keg, slab->us_domain);
4744                 }
4745                 slab_free_item(zone, slab, item);
4746         }
4747         if (lock != NULL)
4748                 mtx_unlock(lock);
4749 }
4750
4751 /*
4752  * Frees a single item to any zone.
4753  *
4754  * Arguments:
4755  *      zone   The zone to free to
4756  *      item   The item we're freeing
4757  *      udata  User supplied data for the dtor
4758  *      skip   Skip dtors and finis
4759  */
4760 static __noinline void
4761 zone_free_item(uma_zone_t zone, void *item, void *udata, enum zfreeskip skip)
4762 {
4763
4764         /*
4765          * If a free is sent directly to an SMR zone we have to
4766          * synchronize immediately because the item can instantly
4767          * be reallocated. This should only happen in degenerate
4768          * cases when no memory is available for per-cpu caches.
4769          */
4770         if ((zone->uz_flags & UMA_ZONE_SMR) != 0 && skip == SKIP_NONE)
4771                 smr_synchronize(zone->uz_smr);
4772
4773         item_dtor(zone, item, zone->uz_size, udata, skip);
4774
4775         if (skip < SKIP_FINI && zone->uz_fini) {
4776                 kasan_mark_item_valid(zone, item);
4777                 zone->uz_fini(item, zone->uz_size);
4778                 kasan_mark_item_invalid(zone, item);
4779         }
4780
4781         zone->uz_release(zone->uz_arg, &item, 1);
4782
4783         if (skip & SKIP_CNT)
4784                 return;
4785
4786         counter_u64_add(zone->uz_frees, 1);
4787
4788         if (zone->uz_max_items > 0)
4789                 zone_free_limit(zone, 1);
4790 }
4791
4792 /* See uma.h */
4793 int
4794 uma_zone_set_max(uma_zone_t zone, int nitems)
4795 {
4796
4797         /*
4798          * If the limit is small, we may need to constrain the maximum per-CPU
4799          * cache size, or disable caching entirely.
4800          */
4801         uma_zone_set_maxcache(zone, nitems);
4802
4803         /*
4804          * XXX This can misbehave if the zone has any allocations with
4805          * no limit and a limit is imposed.  There is currently no
4806          * way to clear a limit.
4807          */
4808         ZONE_LOCK(zone);
4809         zone->uz_max_items = nitems;
4810         zone->uz_flags |= UMA_ZFLAG_LIMIT;
4811         zone_update_caches(zone);
4812         /* We may need to wake waiters. */
4813         wakeup(&zone->uz_max_items);
4814         ZONE_UNLOCK(zone);
4815
4816         return (nitems);
4817 }
4818
4819 /* See uma.h */
4820 void
4821 uma_zone_set_maxcache(uma_zone_t zone, int nitems)
4822 {
4823         int bpcpu, bpdom, bsize, nb;
4824
4825         ZONE_LOCK(zone);
4826
4827         /*
4828          * Compute a lower bound on the number of items that may be cached in
4829          * the zone.  Each CPU gets at least two buckets, and for cross-domain
4830          * frees we use an additional bucket per CPU and per domain.  Select the
4831          * largest bucket size that does not exceed half of the requested limit,
4832          * with the left over space given to the full bucket cache.
4833          */
4834         bpdom = 0;
4835         bpcpu = 2;
4836 #ifdef NUMA
4837         if ((zone->uz_flags & UMA_ZONE_FIRSTTOUCH) != 0 && vm_ndomains > 1) {
4838                 bpcpu++;
4839                 bpdom++;
4840         }
4841 #endif
4842         nb = bpcpu * mp_ncpus + bpdom * vm_ndomains;
4843         bsize = nitems / nb / 2;
4844         if (bsize > BUCKET_MAX)
4845                 bsize = BUCKET_MAX;
4846         else if (bsize == 0 && nitems / nb > 0)
4847                 bsize = 1;
4848         zone->uz_bucket_size_max = zone->uz_bucket_size = bsize;
4849         if (zone->uz_bucket_size_min > zone->uz_bucket_size_max)
4850                 zone->uz_bucket_size_min = zone->uz_bucket_size_max;
4851         zone->uz_bucket_max = nitems - nb * bsize;
4852         ZONE_UNLOCK(zone);
4853 }
4854
4855 /* See uma.h */
4856 int
4857 uma_zone_get_max(uma_zone_t zone)
4858 {
4859         int nitems;
4860
4861         nitems = atomic_load_64(&zone->uz_max_items);
4862
4863         return (nitems);
4864 }
4865
4866 /* See uma.h */
4867 void
4868 uma_zone_set_warning(uma_zone_t zone, const char *warning)
4869 {
4870
4871         ZONE_ASSERT_COLD(zone);
4872         zone->uz_warning = warning;
4873 }
4874
4875 /* See uma.h */
4876 void
4877 uma_zone_set_maxaction(uma_zone_t zone, uma_maxaction_t maxaction)
4878 {
4879
4880         ZONE_ASSERT_COLD(zone);
4881         TASK_INIT(&zone->uz_maxaction, 0, (task_fn_t *)maxaction, zone);
4882 }
4883
4884 /* See uma.h */
4885 int
4886 uma_zone_get_cur(uma_zone_t zone)
4887 {
4888         int64_t nitems;
4889         u_int i;
4890
4891         nitems = 0;
4892         if (zone->uz_allocs != EARLY_COUNTER && zone->uz_frees != EARLY_COUNTER)
4893                 nitems = counter_u64_fetch(zone->uz_allocs) -
4894                     counter_u64_fetch(zone->uz_frees);
4895         CPU_FOREACH(i)
4896                 nitems += atomic_load_64(&zone->uz_cpu[i].uc_allocs) -
4897                     atomic_load_64(&zone->uz_cpu[i].uc_frees);
4898
4899         return (nitems < 0 ? 0 : nitems);
4900 }
4901
4902 static uint64_t
4903 uma_zone_get_allocs(uma_zone_t zone)
4904 {
4905         uint64_t nitems;
4906         u_int i;
4907
4908         nitems = 0;
4909         if (zone->uz_allocs != EARLY_COUNTER)
4910                 nitems = counter_u64_fetch(zone->uz_allocs);
4911         CPU_FOREACH(i)
4912                 nitems += atomic_load_64(&zone->uz_cpu[i].uc_allocs);
4913
4914         return (nitems);
4915 }
4916
4917 static uint64_t
4918 uma_zone_get_frees(uma_zone_t zone)
4919 {
4920         uint64_t nitems;
4921         u_int i;
4922
4923         nitems = 0;
4924         if (zone->uz_frees != EARLY_COUNTER)
4925                 nitems = counter_u64_fetch(zone->uz_frees);
4926         CPU_FOREACH(i)
4927                 nitems += atomic_load_64(&zone->uz_cpu[i].uc_frees);
4928
4929         return (nitems);
4930 }
4931
4932 #ifdef INVARIANTS
4933 /* Used only for KEG_ASSERT_COLD(). */
4934 static uint64_t
4935 uma_keg_get_allocs(uma_keg_t keg)
4936 {
4937         uma_zone_t z;
4938         uint64_t nitems;
4939
4940         nitems = 0;
4941         LIST_FOREACH(z, &keg->uk_zones, uz_link)
4942                 nitems += uma_zone_get_allocs(z);
4943
4944         return (nitems);
4945 }
4946 #endif
4947
4948 /* See uma.h */
4949 void
4950 uma_zone_set_init(uma_zone_t zone, uma_init uminit)
4951 {
4952         uma_keg_t keg;
4953
4954         KEG_GET(zone, keg);
4955         KEG_ASSERT_COLD(keg);
4956         keg->uk_init = uminit;
4957 }
4958
4959 /* See uma.h */
4960 void
4961 uma_zone_set_fini(uma_zone_t zone, uma_fini fini)
4962 {
4963         uma_keg_t keg;
4964
4965         KEG_GET(zone, keg);
4966         KEG_ASSERT_COLD(keg);
4967         keg->uk_fini = fini;
4968 }
4969
4970 /* See uma.h */
4971 void
4972 uma_zone_set_zinit(uma_zone_t zone, uma_init zinit)
4973 {
4974
4975         ZONE_ASSERT_COLD(zone);
4976         zone->uz_init = zinit;
4977 }
4978
4979 /* See uma.h */
4980 void
4981 uma_zone_set_zfini(uma_zone_t zone, uma_fini zfini)
4982 {
4983
4984         ZONE_ASSERT_COLD(zone);
4985         zone->uz_fini = zfini;
4986 }
4987
4988 /* See uma.h */
4989 void
4990 uma_zone_set_freef(uma_zone_t zone, uma_free freef)
4991 {
4992         uma_keg_t keg;
4993
4994         KEG_GET(zone, keg);
4995         KEG_ASSERT_COLD(keg);
4996         keg->uk_freef = freef;
4997 }
4998
4999 /* See uma.h */
5000 void
5001 uma_zone_set_allocf(uma_zone_t zone, uma_alloc allocf)
5002 {
5003         uma_keg_t keg;
5004
5005         KEG_GET(zone, keg);
5006         KEG_ASSERT_COLD(keg);
5007         keg->uk_allocf = allocf;
5008 }
5009
5010 /* See uma.h */
5011 void
5012 uma_zone_set_smr(uma_zone_t zone, smr_t smr)
5013 {
5014
5015         ZONE_ASSERT_COLD(zone);
5016
5017         KASSERT(smr != NULL, ("Got NULL smr"));
5018         KASSERT((zone->uz_flags & UMA_ZONE_SMR) == 0,
5019             ("zone %p (%s) already uses SMR", zone, zone->uz_name));
5020         zone->uz_flags |= UMA_ZONE_SMR;
5021         zone->uz_smr = smr;
5022         zone_update_caches(zone);
5023 }
5024
5025 smr_t
5026 uma_zone_get_smr(uma_zone_t zone)
5027 {
5028
5029         return (zone->uz_smr);
5030 }
5031
5032 /* See uma.h */
5033 void
5034 uma_zone_reserve(uma_zone_t zone, int items)
5035 {
5036         uma_keg_t keg;
5037
5038         KEG_GET(zone, keg);
5039         KEG_ASSERT_COLD(keg);
5040         keg->uk_reserve = items;
5041 }
5042
5043 /* See uma.h */
5044 int
5045 uma_zone_reserve_kva(uma_zone_t zone, int count)
5046 {
5047         uma_keg_t keg;
5048         vm_offset_t kva;
5049         u_int pages;
5050
5051         KEG_GET(zone, keg);
5052         KEG_ASSERT_COLD(keg);
5053         ZONE_ASSERT_COLD(zone);
5054
5055         pages = howmany(count, keg->uk_ipers) * keg->uk_ppera;
5056
5057 #ifdef UMA_MD_SMALL_ALLOC
5058         if (keg->uk_ppera > 1) {
5059 #else
5060         if (1) {
5061 #endif
5062                 kva = kva_alloc((vm_size_t)pages * PAGE_SIZE);
5063                 if (kva == 0)
5064                         return (0);
5065         } else
5066                 kva = 0;
5067
5068         MPASS(keg->uk_kva == 0);
5069         keg->uk_kva = kva;
5070         keg->uk_offset = 0;
5071         zone->uz_max_items = pages * keg->uk_ipers;
5072 #ifdef UMA_MD_SMALL_ALLOC
5073         keg->uk_allocf = (keg->uk_ppera > 1) ? noobj_alloc : uma_small_alloc;
5074 #else
5075         keg->uk_allocf = noobj_alloc;
5076 #endif
5077         keg->uk_flags |= UMA_ZFLAG_LIMIT | UMA_ZONE_NOFREE;
5078         zone->uz_flags |= UMA_ZFLAG_LIMIT | UMA_ZONE_NOFREE;
5079         zone_update_caches(zone);
5080
5081         return (1);
5082 }
5083
5084 /* See uma.h */
5085 void
5086 uma_prealloc(uma_zone_t zone, int items)
5087 {
5088         struct vm_domainset_iter di;
5089         uma_domain_t dom;
5090         uma_slab_t slab;
5091         uma_keg_t keg;
5092         int aflags, domain, slabs;
5093
5094         KEG_GET(zone, keg);
5095         slabs = howmany(items, keg->uk_ipers);
5096         while (slabs-- > 0) {
5097                 aflags = M_NOWAIT;
5098                 vm_domainset_iter_policy_ref_init(&di, &keg->uk_dr, &domain,
5099                     &aflags);
5100                 for (;;) {
5101                         slab = keg_alloc_slab(keg, zone, domain, M_WAITOK,
5102                             aflags);
5103                         if (slab != NULL) {
5104                                 dom = &keg->uk_domain[slab->us_domain];
5105                                 /*
5106                                  * keg_alloc_slab() always returns a slab on the
5107                                  * partial list.
5108                                  */
5109                                 LIST_REMOVE(slab, us_link);
5110                                 LIST_INSERT_HEAD(&dom->ud_free_slab, slab,
5111                                     us_link);
5112                                 dom->ud_free_slabs++;
5113                                 KEG_UNLOCK(keg, slab->us_domain);
5114                                 break;
5115                         }
5116                         if (vm_domainset_iter_policy(&di, &domain) != 0)
5117                                 vm_wait_doms(&keg->uk_dr.dr_policy->ds_mask, 0);
5118                 }
5119         }
5120 }
5121
5122 /*
5123  * Returns a snapshot of memory consumption in bytes.
5124  */
5125 size_t
5126 uma_zone_memory(uma_zone_t zone)
5127 {
5128         size_t sz;
5129         int i;
5130
5131         sz = 0;
5132         if (zone->uz_flags & UMA_ZFLAG_CACHE) {
5133                 for (i = 0; i < vm_ndomains; i++)
5134                         sz += ZDOM_GET(zone, i)->uzd_nitems;
5135                 return (sz * zone->uz_size);
5136         }
5137         for (i = 0; i < vm_ndomains; i++)
5138                 sz += zone->uz_keg->uk_domain[i].ud_pages;
5139
5140         return (sz * PAGE_SIZE);
5141 }
5142
5143 /* See uma.h */
5144 void
5145 uma_reclaim(int req)
5146 {
5147         uma_reclaim_domain(req, UMA_ANYDOMAIN);
5148 }
5149
5150 void
5151 uma_reclaim_domain(int req, int domain)
5152 {
5153         void *arg;
5154
5155         bucket_enable();
5156
5157         arg = (void *)(uintptr_t)domain;
5158         sx_slock(&uma_reclaim_lock);
5159         switch (req) {
5160         case UMA_RECLAIM_TRIM:
5161                 zone_foreach(zone_trim, arg);
5162                 break;
5163         case UMA_RECLAIM_DRAIN:
5164                 zone_foreach(zone_drain, arg);
5165                 break;
5166         case UMA_RECLAIM_DRAIN_CPU:
5167                 zone_foreach(zone_drain, arg);
5168                 pcpu_cache_drain_safe(NULL);
5169                 zone_foreach(zone_drain, arg);
5170                 break;
5171         default:
5172                 panic("unhandled reclamation request %d", req);
5173         }
5174
5175         /*
5176          * Some slabs may have been freed but this zone will be visited early
5177          * we visit again so that we can free pages that are empty once other
5178          * zones are drained.  We have to do the same for buckets.
5179          */
5180         zone_drain(slabzones[0], arg);
5181         zone_drain(slabzones[1], arg);
5182         bucket_zone_drain(domain);
5183         sx_sunlock(&uma_reclaim_lock);
5184 }
5185
5186 static volatile int uma_reclaim_needed;
5187
5188 void
5189 uma_reclaim_wakeup(void)
5190 {
5191
5192         if (atomic_fetchadd_int(&uma_reclaim_needed, 1) == 0)
5193                 wakeup(uma_reclaim);
5194 }
5195
5196 void
5197 uma_reclaim_worker(void *arg __unused)
5198 {
5199
5200         for (;;) {
5201                 sx_xlock(&uma_reclaim_lock);
5202                 while (atomic_load_int(&uma_reclaim_needed) == 0)
5203                         sx_sleep(uma_reclaim, &uma_reclaim_lock, PVM, "umarcl",
5204                             hz);
5205                 sx_xunlock(&uma_reclaim_lock);
5206                 EVENTHANDLER_INVOKE(vm_lowmem, VM_LOW_KMEM);
5207                 uma_reclaim(UMA_RECLAIM_DRAIN_CPU);
5208                 atomic_store_int(&uma_reclaim_needed, 0);
5209                 /* Don't fire more than once per-second. */
5210                 pause("umarclslp", hz);
5211         }
5212 }
5213
5214 /* See uma.h */
5215 void
5216 uma_zone_reclaim(uma_zone_t zone, int req)
5217 {
5218         uma_zone_reclaim_domain(zone, req, UMA_ANYDOMAIN);
5219 }
5220
5221 void
5222 uma_zone_reclaim_domain(uma_zone_t zone, int req, int domain)
5223 {
5224         void *arg;
5225
5226         arg = (void *)(uintptr_t)domain;
5227         switch (req) {
5228         case UMA_RECLAIM_TRIM:
5229                 zone_trim(zone, arg);
5230                 break;
5231         case UMA_RECLAIM_DRAIN:
5232                 zone_drain(zone, arg);
5233                 break;
5234         case UMA_RECLAIM_DRAIN_CPU:
5235                 pcpu_cache_drain_safe(zone);
5236                 zone_drain(zone, arg);
5237                 break;
5238         default:
5239                 panic("unhandled reclamation request %d", req);
5240         }
5241 }
5242
5243 /* See uma.h */
5244 int
5245 uma_zone_exhausted(uma_zone_t zone)
5246 {
5247
5248         return (atomic_load_32(&zone->uz_sleepers) > 0);
5249 }
5250
5251 unsigned long
5252 uma_limit(void)
5253 {
5254
5255         return (uma_kmem_limit);
5256 }
5257
5258 void
5259 uma_set_limit(unsigned long limit)
5260 {
5261
5262         uma_kmem_limit = limit;
5263 }
5264
5265 unsigned long
5266 uma_size(void)
5267 {
5268
5269         return (atomic_load_long(&uma_kmem_total));
5270 }
5271
5272 long
5273 uma_avail(void)
5274 {
5275
5276         return (uma_kmem_limit - uma_size());
5277 }
5278
5279 #ifdef DDB
5280 /*
5281  * Generate statistics across both the zone and its per-cpu cache's.  Return
5282  * desired statistics if the pointer is non-NULL for that statistic.
5283  *
5284  * Note: does not update the zone statistics, as it can't safely clear the
5285  * per-CPU cache statistic.
5286  *
5287  */
5288 static void
5289 uma_zone_sumstat(uma_zone_t z, long *cachefreep, uint64_t *allocsp,
5290     uint64_t *freesp, uint64_t *sleepsp, uint64_t *xdomainp)
5291 {
5292         uma_cache_t cache;
5293         uint64_t allocs, frees, sleeps, xdomain;
5294         int cachefree, cpu;
5295
5296         allocs = frees = sleeps = xdomain = 0;
5297         cachefree = 0;
5298         CPU_FOREACH(cpu) {
5299                 cache = &z->uz_cpu[cpu];
5300                 cachefree += cache->uc_allocbucket.ucb_cnt;
5301                 cachefree += cache->uc_freebucket.ucb_cnt;
5302                 xdomain += cache->uc_crossbucket.ucb_cnt;
5303                 cachefree += cache->uc_crossbucket.ucb_cnt;
5304                 allocs += cache->uc_allocs;
5305                 frees += cache->uc_frees;
5306         }
5307         allocs += counter_u64_fetch(z->uz_allocs);
5308         frees += counter_u64_fetch(z->uz_frees);
5309         xdomain += counter_u64_fetch(z->uz_xdomain);
5310         sleeps += z->uz_sleeps;
5311         if (cachefreep != NULL)
5312                 *cachefreep = cachefree;
5313         if (allocsp != NULL)
5314                 *allocsp = allocs;
5315         if (freesp != NULL)
5316                 *freesp = frees;
5317         if (sleepsp != NULL)
5318                 *sleepsp = sleeps;
5319         if (xdomainp != NULL)
5320                 *xdomainp = xdomain;
5321 }
5322 #endif /* DDB */
5323
5324 static int
5325 sysctl_vm_zone_count(SYSCTL_HANDLER_ARGS)
5326 {
5327         uma_keg_t kz;
5328         uma_zone_t z;
5329         int count;
5330
5331         count = 0;
5332         rw_rlock(&uma_rwlock);
5333         LIST_FOREACH(kz, &uma_kegs, uk_link) {
5334                 LIST_FOREACH(z, &kz->uk_zones, uz_link)
5335                         count++;
5336         }
5337         LIST_FOREACH(z, &uma_cachezones, uz_link)
5338                 count++;
5339
5340         rw_runlock(&uma_rwlock);
5341         return (sysctl_handle_int(oidp, &count, 0, req));
5342 }
5343
5344 static void
5345 uma_vm_zone_stats(struct uma_type_header *uth, uma_zone_t z, struct sbuf *sbuf,
5346     struct uma_percpu_stat *ups, bool internal)
5347 {
5348         uma_zone_domain_t zdom;
5349         uma_cache_t cache;
5350         int i;
5351
5352         for (i = 0; i < vm_ndomains; i++) {
5353                 zdom = ZDOM_GET(z, i);
5354                 uth->uth_zone_free += zdom->uzd_nitems;
5355         }
5356         uth->uth_allocs = counter_u64_fetch(z->uz_allocs);
5357         uth->uth_frees = counter_u64_fetch(z->uz_frees);
5358         uth->uth_fails = counter_u64_fetch(z->uz_fails);
5359         uth->uth_xdomain = counter_u64_fetch(z->uz_xdomain);
5360         uth->uth_sleeps = z->uz_sleeps;
5361
5362         for (i = 0; i < mp_maxid + 1; i++) {
5363                 bzero(&ups[i], sizeof(*ups));
5364                 if (internal || CPU_ABSENT(i))
5365                         continue;
5366                 cache = &z->uz_cpu[i];
5367                 ups[i].ups_cache_free += cache->uc_allocbucket.ucb_cnt;
5368                 ups[i].ups_cache_free += cache->uc_freebucket.ucb_cnt;
5369                 ups[i].ups_cache_free += cache->uc_crossbucket.ucb_cnt;
5370                 ups[i].ups_allocs = cache->uc_allocs;
5371                 ups[i].ups_frees = cache->uc_frees;
5372         }
5373 }
5374
5375 static int
5376 sysctl_vm_zone_stats(SYSCTL_HANDLER_ARGS)
5377 {
5378         struct uma_stream_header ush;
5379         struct uma_type_header uth;
5380         struct uma_percpu_stat *ups;
5381         struct sbuf sbuf;
5382         uma_keg_t kz;
5383         uma_zone_t z;
5384         uint64_t items;
5385         uint32_t kfree, pages;
5386         int count, error, i;
5387
5388         error = sysctl_wire_old_buffer(req, 0);
5389         if (error != 0)
5390                 return (error);
5391         sbuf_new_for_sysctl(&sbuf, NULL, 128, req);
5392         sbuf_clear_flags(&sbuf, SBUF_INCLUDENUL);
5393         ups = malloc((mp_maxid + 1) * sizeof(*ups), M_TEMP, M_WAITOK);
5394
5395         count = 0;
5396         rw_rlock(&uma_rwlock);
5397         LIST_FOREACH(kz, &uma_kegs, uk_link) {
5398                 LIST_FOREACH(z, &kz->uk_zones, uz_link)
5399                         count++;
5400         }
5401
5402         LIST_FOREACH(z, &uma_cachezones, uz_link)
5403                 count++;
5404
5405         /*
5406          * Insert stream header.
5407          */
5408         bzero(&ush, sizeof(ush));
5409         ush.ush_version = UMA_STREAM_VERSION;
5410         ush.ush_maxcpus = (mp_maxid + 1);
5411         ush.ush_count = count;
5412         (void)sbuf_bcat(&sbuf, &ush, sizeof(ush));
5413
5414         LIST_FOREACH(kz, &uma_kegs, uk_link) {
5415                 kfree = pages = 0;
5416                 for (i = 0; i < vm_ndomains; i++) {
5417                         kfree += kz->uk_domain[i].ud_free_items;
5418                         pages += kz->uk_domain[i].ud_pages;
5419                 }
5420                 LIST_FOREACH(z, &kz->uk_zones, uz_link) {
5421                         bzero(&uth, sizeof(uth));
5422                         strlcpy(uth.uth_name, z->uz_name, UTH_MAX_NAME);
5423                         uth.uth_align = kz->uk_align;
5424                         uth.uth_size = kz->uk_size;
5425                         uth.uth_rsize = kz->uk_rsize;
5426                         if (z->uz_max_items > 0) {
5427                                 items = UZ_ITEMS_COUNT(z->uz_items);
5428                                 uth.uth_pages = (items / kz->uk_ipers) *
5429                                         kz->uk_ppera;
5430                         } else
5431                                 uth.uth_pages = pages;
5432                         uth.uth_maxpages = (z->uz_max_items / kz->uk_ipers) *
5433                             kz->uk_ppera;
5434                         uth.uth_limit = z->uz_max_items;
5435                         uth.uth_keg_free = kfree;
5436
5437                         /*
5438                          * A zone is secondary is it is not the first entry
5439                          * on the keg's zone list.
5440                          */
5441                         if ((z->uz_flags & UMA_ZONE_SECONDARY) &&
5442                             (LIST_FIRST(&kz->uk_zones) != z))
5443                                 uth.uth_zone_flags = UTH_ZONE_SECONDARY;
5444                         uma_vm_zone_stats(&uth, z, &sbuf, ups,
5445                             kz->uk_flags & UMA_ZFLAG_INTERNAL);
5446                         (void)sbuf_bcat(&sbuf, &uth, sizeof(uth));
5447                         for (i = 0; i < mp_maxid + 1; i++)
5448                                 (void)sbuf_bcat(&sbuf, &ups[i], sizeof(ups[i]));
5449                 }
5450         }
5451         LIST_FOREACH(z, &uma_cachezones, uz_link) {
5452                 bzero(&uth, sizeof(uth));
5453                 strlcpy(uth.uth_name, z->uz_name, UTH_MAX_NAME);
5454                 uth.uth_size = z->uz_size;
5455                 uma_vm_zone_stats(&uth, z, &sbuf, ups, false);
5456                 (void)sbuf_bcat(&sbuf, &uth, sizeof(uth));
5457                 for (i = 0; i < mp_maxid + 1; i++)
5458                         (void)sbuf_bcat(&sbuf, &ups[i], sizeof(ups[i]));
5459         }
5460
5461         rw_runlock(&uma_rwlock);
5462         error = sbuf_finish(&sbuf);
5463         sbuf_delete(&sbuf);
5464         free(ups, M_TEMP);
5465         return (error);
5466 }
5467
5468 int
5469 sysctl_handle_uma_zone_max(SYSCTL_HANDLER_ARGS)
5470 {
5471         uma_zone_t zone = *(uma_zone_t *)arg1;
5472         int error, max;
5473
5474         max = uma_zone_get_max(zone);
5475         error = sysctl_handle_int(oidp, &max, 0, req);
5476         if (error || !req->newptr)
5477                 return (error);
5478
5479         uma_zone_set_max(zone, max);
5480
5481         return (0);
5482 }
5483
5484 int
5485 sysctl_handle_uma_zone_cur(SYSCTL_HANDLER_ARGS)
5486 {
5487         uma_zone_t zone;
5488         int cur;
5489
5490         /*
5491          * Some callers want to add sysctls for global zones that
5492          * may not yet exist so they pass a pointer to a pointer.
5493          */
5494         if (arg2 == 0)
5495                 zone = *(uma_zone_t *)arg1;
5496         else
5497                 zone = arg1;
5498         cur = uma_zone_get_cur(zone);
5499         return (sysctl_handle_int(oidp, &cur, 0, req));
5500 }
5501
5502 static int
5503 sysctl_handle_uma_zone_allocs(SYSCTL_HANDLER_ARGS)
5504 {
5505         uma_zone_t zone = arg1;
5506         uint64_t cur;
5507
5508         cur = uma_zone_get_allocs(zone);
5509         return (sysctl_handle_64(oidp, &cur, 0, req));
5510 }
5511
5512 static int
5513 sysctl_handle_uma_zone_frees(SYSCTL_HANDLER_ARGS)
5514 {
5515         uma_zone_t zone = arg1;
5516         uint64_t cur;
5517
5518         cur = uma_zone_get_frees(zone);
5519         return (sysctl_handle_64(oidp, &cur, 0, req));
5520 }
5521
5522 static int
5523 sysctl_handle_uma_zone_flags(SYSCTL_HANDLER_ARGS)
5524 {
5525         struct sbuf sbuf;
5526         uma_zone_t zone = arg1;
5527         int error;
5528
5529         sbuf_new_for_sysctl(&sbuf, NULL, 0, req);
5530         if (zone->uz_flags != 0)
5531                 sbuf_printf(&sbuf, "0x%b", zone->uz_flags, PRINT_UMA_ZFLAGS);
5532         else
5533                 sbuf_printf(&sbuf, "0");
5534         error = sbuf_finish(&sbuf);
5535         sbuf_delete(&sbuf);
5536
5537         return (error);
5538 }
5539
5540 static int
5541 sysctl_handle_uma_slab_efficiency(SYSCTL_HANDLER_ARGS)
5542 {
5543         uma_keg_t keg = arg1;
5544         int avail, effpct, total;
5545
5546         total = keg->uk_ppera * PAGE_SIZE;
5547         if ((keg->uk_flags & UMA_ZFLAG_OFFPAGE) != 0)
5548                 total += slabzone(keg->uk_ipers)->uz_keg->uk_rsize;
5549         /*
5550          * We consider the client's requested size and alignment here, not the
5551          * real size determination uk_rsize, because we also adjust the real
5552          * size for internal implementation reasons (max bitset size).
5553          */
5554         avail = keg->uk_ipers * roundup2(keg->uk_size, keg->uk_align + 1);
5555         if ((keg->uk_flags & UMA_ZONE_PCPU) != 0)
5556                 avail *= mp_maxid + 1;
5557         effpct = 100 * avail / total;
5558         return (sysctl_handle_int(oidp, &effpct, 0, req));
5559 }
5560
5561 static int
5562 sysctl_handle_uma_zone_items(SYSCTL_HANDLER_ARGS)
5563 {
5564         uma_zone_t zone = arg1;
5565         uint64_t cur;
5566
5567         cur = UZ_ITEMS_COUNT(atomic_load_64(&zone->uz_items));
5568         return (sysctl_handle_64(oidp, &cur, 0, req));
5569 }
5570
5571 #ifdef INVARIANTS
5572 static uma_slab_t
5573 uma_dbg_getslab(uma_zone_t zone, void *item)
5574 {
5575         uma_slab_t slab;
5576         uma_keg_t keg;
5577         uint8_t *mem;
5578
5579         /*
5580          * It is safe to return the slab here even though the
5581          * zone is unlocked because the item's allocation state
5582          * essentially holds a reference.
5583          */
5584         mem = (uint8_t *)((uintptr_t)item & (~UMA_SLAB_MASK));
5585         if ((zone->uz_flags & UMA_ZFLAG_CACHE) != 0)
5586                 return (NULL);
5587         if (zone->uz_flags & UMA_ZFLAG_VTOSLAB)
5588                 return (vtoslab((vm_offset_t)mem));
5589         keg = zone->uz_keg;
5590         if ((keg->uk_flags & UMA_ZFLAG_HASH) == 0)
5591                 return ((uma_slab_t)(mem + keg->uk_pgoff));
5592         KEG_LOCK(keg, 0);
5593         slab = hash_sfind(&keg->uk_hash, mem);
5594         KEG_UNLOCK(keg, 0);
5595
5596         return (slab);
5597 }
5598
5599 static bool
5600 uma_dbg_zskip(uma_zone_t zone, void *mem)
5601 {
5602
5603         if ((zone->uz_flags & UMA_ZFLAG_CACHE) != 0)
5604                 return (true);
5605
5606         return (uma_dbg_kskip(zone->uz_keg, mem));
5607 }
5608
5609 static bool
5610 uma_dbg_kskip(uma_keg_t keg, void *mem)
5611 {
5612         uintptr_t idx;
5613
5614         if (dbg_divisor == 0)
5615                 return (true);
5616
5617         if (dbg_divisor == 1)
5618                 return (false);
5619
5620         idx = (uintptr_t)mem >> PAGE_SHIFT;
5621         if (keg->uk_ipers > 1) {
5622                 idx *= keg->uk_ipers;
5623                 idx += ((uintptr_t)mem & PAGE_MASK) / keg->uk_rsize;
5624         }
5625
5626         if ((idx / dbg_divisor) * dbg_divisor != idx) {
5627                 counter_u64_add(uma_skip_cnt, 1);
5628                 return (true);
5629         }
5630         counter_u64_add(uma_dbg_cnt, 1);
5631
5632         return (false);
5633 }
5634
5635 /*
5636  * Set up the slab's freei data such that uma_dbg_free can function.
5637  *
5638  */
5639 static void
5640 uma_dbg_alloc(uma_zone_t zone, uma_slab_t slab, void *item)
5641 {
5642         uma_keg_t keg;
5643         int freei;
5644
5645         if (slab == NULL) {
5646                 slab = uma_dbg_getslab(zone, item);
5647                 if (slab == NULL)
5648                         panic("uma: item %p did not belong to zone %s",
5649                             item, zone->uz_name);
5650         }
5651         keg = zone->uz_keg;
5652         freei = slab_item_index(slab, keg, item);
5653
5654         if (BIT_TEST_SET_ATOMIC(keg->uk_ipers, freei,
5655             slab_dbg_bits(slab, keg)))
5656                 panic("Duplicate alloc of %p from zone %p(%s) slab %p(%d)",
5657                     item, zone, zone->uz_name, slab, freei);
5658 }
5659
5660 /*
5661  * Verifies freed addresses.  Checks for alignment, valid slab membership
5662  * and duplicate frees.
5663  *
5664  */
5665 static void
5666 uma_dbg_free(uma_zone_t zone, uma_slab_t slab, void *item)
5667 {
5668         uma_keg_t keg;
5669         int freei;
5670
5671         if (slab == NULL) {
5672                 slab = uma_dbg_getslab(zone, item);
5673                 if (slab == NULL)
5674                         panic("uma: Freed item %p did not belong to zone %s",
5675                             item, zone->uz_name);
5676         }
5677         keg = zone->uz_keg;
5678         freei = slab_item_index(slab, keg, item);
5679
5680         if (freei >= keg->uk_ipers)
5681                 panic("Invalid free of %p from zone %p(%s) slab %p(%d)",
5682                     item, zone, zone->uz_name, slab, freei);
5683
5684         if (slab_item(slab, keg, freei) != item)
5685                 panic("Unaligned free of %p from zone %p(%s) slab %p(%d)",
5686                     item, zone, zone->uz_name, slab, freei);
5687
5688         if (!BIT_TEST_CLR_ATOMIC(keg->uk_ipers, freei,
5689             slab_dbg_bits(slab, keg)))
5690                 panic("Duplicate free of %p from zone %p(%s) slab %p(%d)",
5691                     item, zone, zone->uz_name, slab, freei);
5692 }
5693 #endif /* INVARIANTS */
5694
5695 #ifdef DDB
5696 static int64_t
5697 get_uma_stats(uma_keg_t kz, uma_zone_t z, uint64_t *allocs, uint64_t *used,
5698     uint64_t *sleeps, long *cachefree, uint64_t *xdomain)
5699 {
5700         uint64_t frees;
5701         int i;
5702
5703         if (kz->uk_flags & UMA_ZFLAG_INTERNAL) {
5704                 *allocs = counter_u64_fetch(z->uz_allocs);
5705                 frees = counter_u64_fetch(z->uz_frees);
5706                 *sleeps = z->uz_sleeps;
5707                 *cachefree = 0;
5708                 *xdomain = 0;
5709         } else
5710                 uma_zone_sumstat(z, cachefree, allocs, &frees, sleeps,
5711                     xdomain);
5712         for (i = 0; i < vm_ndomains; i++) {
5713                 *cachefree += ZDOM_GET(z, i)->uzd_nitems;
5714                 if (!((z->uz_flags & UMA_ZONE_SECONDARY) &&
5715                     (LIST_FIRST(&kz->uk_zones) != z)))
5716                         *cachefree += kz->uk_domain[i].ud_free_items;
5717         }
5718         *used = *allocs - frees;
5719         return (((int64_t)*used + *cachefree) * kz->uk_size);
5720 }
5721
5722 DB_SHOW_COMMAND(uma, db_show_uma)
5723 {
5724         const char *fmt_hdr, *fmt_entry;
5725         uma_keg_t kz;
5726         uma_zone_t z;
5727         uint64_t allocs, used, sleeps, xdomain;
5728         long cachefree;
5729         /* variables for sorting */
5730         uma_keg_t cur_keg;
5731         uma_zone_t cur_zone, last_zone;
5732         int64_t cur_size, last_size, size;
5733         int ties;
5734
5735         /* /i option produces machine-parseable CSV output */
5736         if (modif[0] == 'i') {
5737                 fmt_hdr = "%s,%s,%s,%s,%s,%s,%s,%s,%s\n";
5738                 fmt_entry = "\"%s\",%ju,%jd,%ld,%ju,%ju,%u,%jd,%ju\n";
5739         } else {
5740                 fmt_hdr = "%18s %6s %7s %7s %11s %7s %7s %10s %8s\n";
5741                 fmt_entry = "%18s %6ju %7jd %7ld %11ju %7ju %7u %10jd %8ju\n";
5742         }
5743
5744         db_printf(fmt_hdr, "Zone", "Size", "Used", "Free", "Requests",
5745             "Sleeps", "Bucket", "Total Mem", "XFree");
5746
5747         /* Sort the zones with largest size first. */
5748         last_zone = NULL;
5749         last_size = INT64_MAX;
5750         for (;;) {
5751                 cur_zone = NULL;
5752                 cur_size = -1;
5753                 ties = 0;
5754                 LIST_FOREACH(kz, &uma_kegs, uk_link) {
5755                         LIST_FOREACH(z, &kz->uk_zones, uz_link) {
5756                                 /*
5757                                  * In the case of size ties, print out zones
5758                                  * in the order they are encountered.  That is,
5759                                  * when we encounter the most recently output
5760                                  * zone, we have already printed all preceding
5761                                  * ties, and we must print all following ties.
5762                                  */
5763                                 if (z == last_zone) {
5764                                         ties = 1;
5765                                         continue;
5766                                 }
5767                                 size = get_uma_stats(kz, z, &allocs, &used,
5768                                     &sleeps, &cachefree, &xdomain);
5769                                 if (size > cur_size && size < last_size + ties)
5770                                 {
5771                                         cur_size = size;
5772                                         cur_zone = z;
5773                                         cur_keg = kz;
5774                                 }
5775                         }
5776                 }
5777                 if (cur_zone == NULL)
5778                         break;
5779
5780                 size = get_uma_stats(cur_keg, cur_zone, &allocs, &used,
5781                     &sleeps, &cachefree, &xdomain);
5782                 db_printf(fmt_entry, cur_zone->uz_name,
5783                     (uintmax_t)cur_keg->uk_size, (intmax_t)used, cachefree,
5784                     (uintmax_t)allocs, (uintmax_t)sleeps,
5785                     (unsigned)cur_zone->uz_bucket_size, (intmax_t)size,
5786                     xdomain);
5787
5788                 if (db_pager_quit)
5789                         return;
5790                 last_zone = cur_zone;
5791                 last_size = cur_size;
5792         }
5793 }
5794
5795 DB_SHOW_COMMAND(umacache, db_show_umacache)
5796 {
5797         uma_zone_t z;
5798         uint64_t allocs, frees;
5799         long cachefree;
5800         int i;
5801
5802         db_printf("%18s %8s %8s %8s %12s %8s\n", "Zone", "Size", "Used", "Free",
5803             "Requests", "Bucket");
5804         LIST_FOREACH(z, &uma_cachezones, uz_link) {
5805                 uma_zone_sumstat(z, &cachefree, &allocs, &frees, NULL, NULL);
5806                 for (i = 0; i < vm_ndomains; i++)
5807                         cachefree += ZDOM_GET(z, i)->uzd_nitems;
5808                 db_printf("%18s %8ju %8jd %8ld %12ju %8u\n",
5809                     z->uz_name, (uintmax_t)z->uz_size,
5810                     (intmax_t)(allocs - frees), cachefree,
5811                     (uintmax_t)allocs, z->uz_bucket_size);
5812                 if (db_pager_quit)
5813                         return;
5814         }
5815 }
5816 #endif  /* DDB */