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