sys/kern/subr_vmem.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c)2006,2007,2008,2009 YAMAMOTO Takashi,
   5  * Copyright (c) 2013 EMC Corp.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  */
  29
  30 /*
  31  * From:
  32  *      $NetBSD: vmem_impl.h,v 1.2 2013/01/29 21:26:24 para Exp $
  33  *      $NetBSD: subr_vmem.c,v 1.83 2013/03/06 11:20:10 yamt Exp $
  34  */
  35
  36 /*
  37  * reference:
  38  * -    Magazines and Vmem: Extending the Slab Allocator
  39  *      to Many CPUs and Arbitrary Resources
  40  *      http://www.usenix.org/event/usenix01/bonwick.html
  41  */
  42
  43 #include <sys/cdefs.h>
  44 __FBSDID("$FreeBSD$");
  45
  46 #include "opt_ddb.h"
  47
  48 #include <sys/param.h>
  49 #include <sys/systm.h>
  50 #include <sys/kernel.h>
  51 #include <sys/queue.h>
  52 #include <sys/callout.h>
  53 #include <sys/hash.h>
  54 #include <sys/lock.h>
  55 #include <sys/malloc.h>
  56 #include <sys/mutex.h>
  57 #include <sys/smp.h>
  58 #include <sys/condvar.h>
  59 #include <sys/sysctl.h>
  60 #include <sys/taskqueue.h>
  61 #include <sys/vmem.h>
  62 #include <sys/vmmeter.h>
  63
  64 #include "opt_vm.h"
  65
  66 #include <vm/uma.h>
  67 #include <vm/vm.h>
  68 #include <vm/pmap.h>
  69 #include <vm/vm_map.h>
  70 #include <vm/vm_object.h>
  71 #include <vm/vm_kern.h>
  72 #include <vm/vm_extern.h>
  73 #include <vm/vm_param.h>
  74 #include <vm/vm_page.h>
  75 #include <vm/vm_pageout.h>
  76 #include <vm/vm_phys.h>
  77 #include <vm/vm_pagequeue.h>
  78 #include <vm/uma_int.h>
  79
  80 int     vmem_startup_count(void);
  81
  82 #define VMEM_OPTORDER           5
  83 #define VMEM_OPTVALUE           (1 << VMEM_OPTORDER)
  84 #define VMEM_MAXORDER                                           \
  85     (VMEM_OPTVALUE - 1 + sizeof(vmem_size_t) * NBBY - VMEM_OPTORDER)
  86
  87 #define VMEM_HASHSIZE_MIN       16
  88 #define VMEM_HASHSIZE_MAX       131072
  89
  90 #define VMEM_QCACHE_IDX_MAX     16
  91
  92 #define VMEM_FITMASK    (M_BESTFIT | M_FIRSTFIT | M_NEXTFIT)
  93
  94 #define VMEM_FLAGS      (M_NOWAIT | M_WAITOK | M_USE_RESERVE | M_NOVM | \
  95     M_BESTFIT | M_FIRSTFIT | M_NEXTFIT)
  96
  97 #define BT_FLAGS        (M_NOWAIT | M_WAITOK | M_USE_RESERVE | M_NOVM)
  98
  99 #define QC_NAME_MAX     16
 100
 101 /*
 102  * Data structures private to vmem.
 103  */
 104 MALLOC_DEFINE(M_VMEM, "vmem", "vmem internal structures");
 105
 106 typedef struct vmem_btag bt_t;
 107
 108 TAILQ_HEAD(vmem_seglist, vmem_btag);
 109 LIST_HEAD(vmem_freelist, vmem_btag);
 110 LIST_HEAD(vmem_hashlist, vmem_btag);
 111
 112 struct qcache {
 113         uma_zone_t      qc_cache;
 114         vmem_t          *qc_vmem;
 115         vmem_size_t     qc_size;
 116         char            qc_name[QC_NAME_MAX];
 117 };
 118 typedef struct qcache qcache_t;
 119 #define QC_POOL_TO_QCACHE(pool) ((qcache_t *)(pool->pr_qcache))
 120
 121 #define VMEM_NAME_MAX   16
 122
 123 /* boundary tag */
 124 struct vmem_btag {
 125         TAILQ_ENTRY(vmem_btag) bt_seglist;
 126         union {
 127                 LIST_ENTRY(vmem_btag) u_freelist; /* BT_TYPE_FREE */
 128                 LIST_ENTRY(vmem_btag) u_hashlist; /* BT_TYPE_BUSY */
 129         } bt_u;
 130 #define bt_hashlist     bt_u.u_hashlist
 131 #define bt_freelist     bt_u.u_freelist
 132         vmem_addr_t     bt_start;
 133         vmem_size_t     bt_size;
 134         int             bt_type;
 135 };
 136
 137 /* vmem arena */
 138 struct vmem {
 139         struct mtx_padalign     vm_lock;
 140         struct cv               vm_cv;
 141         char                    vm_name[VMEM_NAME_MAX+1];
 142         LIST_ENTRY(vmem)        vm_alllist;
 143         struct vmem_hashlist    vm_hash0[VMEM_HASHSIZE_MIN];
 144         struct vmem_freelist    vm_freelist[VMEM_MAXORDER];
 145         struct vmem_seglist     vm_seglist;
 146         struct vmem_hashlist    *vm_hashlist;
 147         vmem_size_t             vm_hashsize;
 148
 149         /* Constant after init */
 150         vmem_size_t             vm_qcache_max;
 151         vmem_size_t             vm_quantum_mask;
 152         vmem_size_t             vm_import_quantum;
 153         int                     vm_quantum_shift;
 154
 155         /* Written on alloc/free */
 156         LIST_HEAD(, vmem_btag)  vm_freetags;
 157         int                     vm_nfreetags;
 158         int                     vm_nbusytag;
 159         vmem_size_t             vm_inuse;
 160         vmem_size_t             vm_size;
 161         vmem_size_t             vm_limit;
 162         struct vmem_btag        vm_cursor;
 163
 164         /* Used on import. */
 165         vmem_import_t           *vm_importfn;
 166         vmem_release_t          *vm_releasefn;
 167         void                    *vm_arg;
 168
 169         /* Space exhaustion callback. */
 170         vmem_reclaim_t          *vm_reclaimfn;
 171
 172         /* quantum cache */
 173         qcache_t                vm_qcache[VMEM_QCACHE_IDX_MAX];
 174 };
 175
 176 #define BT_TYPE_SPAN            1       /* Allocated from importfn */
 177 #define BT_TYPE_SPAN_STATIC     2       /* vmem_add() or create. */
 178 #define BT_TYPE_FREE            3       /* Available space. */
 179 #define BT_TYPE_BUSY            4       /* Used space. */
 180 #define BT_TYPE_CURSOR          5       /* Cursor for nextfit allocations. */
 181 #define BT_ISSPAN_P(bt) ((bt)->bt_type <= BT_TYPE_SPAN_STATIC)
 182
 183 #define BT_END(bt)      ((bt)->bt_start + (bt)->bt_size - 1)
 184
 185 #if defined(DIAGNOSTIC)
 186 static int enable_vmem_check = 1;
 187 SYSCTL_INT(_debug, OID_AUTO, vmem_check, CTLFLAG_RWTUN,
 188     &enable_vmem_check, 0, "Enable vmem check");
 189 static void vmem_check(vmem_t *);
 190 #endif
 191
 192 static struct callout   vmem_periodic_ch;
 193 static int              vmem_periodic_interval;
 194 static struct task      vmem_periodic_wk;
 195
 196 static struct mtx_padalign __exclusive_cache_line vmem_list_lock;
 197 static LIST_HEAD(, vmem) vmem_list = LIST_HEAD_INITIALIZER(vmem_list);
 198 static uma_zone_t vmem_zone;
 199
 200 /* ---- misc */
 201 #define VMEM_CONDVAR_INIT(vm, wchan)    cv_init(&vm->vm_cv, wchan)
 202 #define VMEM_CONDVAR_DESTROY(vm)        cv_destroy(&vm->vm_cv)
 203 #define VMEM_CONDVAR_WAIT(vm)           cv_wait(&vm->vm_cv, &vm->vm_lock)
 204 #define VMEM_CONDVAR_BROADCAST(vm)      cv_broadcast(&vm->vm_cv)
 205
 206
 207 #define VMEM_LOCK(vm)           mtx_lock(&vm->vm_lock)
 208 #define VMEM_TRYLOCK(vm)        mtx_trylock(&vm->vm_lock)
 209 #define VMEM_UNLOCK(vm)         mtx_unlock(&vm->vm_lock)
 210 #define VMEM_LOCK_INIT(vm, name) mtx_init(&vm->vm_lock, (name), NULL, MTX_DEF)
 211 #define VMEM_LOCK_DESTROY(vm)   mtx_destroy(&vm->vm_lock)
 212 #define VMEM_ASSERT_LOCKED(vm)  mtx_assert(&vm->vm_lock, MA_OWNED);
 213
 214 #define VMEM_ALIGNUP(addr, align)       (-(-(addr) & -(align)))
 215
 216 #define VMEM_CROSS_P(addr1, addr2, boundary) \
 217         ((((addr1) ^ (addr2)) & -(boundary)) != 0)
 218
 219 #define ORDER2SIZE(order)       ((order) < VMEM_OPTVALUE ? ((order) + 1) : \
 220     (vmem_size_t)1 << ((order) - (VMEM_OPTVALUE - VMEM_OPTORDER - 1)))
 221 #define SIZE2ORDER(size)        ((size) <= VMEM_OPTVALUE ? ((size) - 1) : \
 222     (flsl(size) + (VMEM_OPTVALUE - VMEM_OPTORDER - 2)))
 223
 224 /*
 225  * Maximum number of boundary tags that may be required to satisfy an
 226  * allocation.  Two may be required to import.  Another two may be
 227  * required to clip edges.
 228  */
 229 #define BT_MAXALLOC     4
 230
 231 /*
 232  * Max free limits the number of locally cached boundary tags.  We
 233  * just want to avoid hitting the zone allocator for every call.
 234  */
 235 #define BT_MAXFREE      (BT_MAXALLOC * 8)
 236
 237 /* Allocator for boundary tags. */
 238 static uma_zone_t vmem_bt_zone;
 239
 240 /* boot time arena storage. */
 241 static struct vmem kernel_arena_storage;
 242 static struct vmem buffer_arena_storage;
 243 static struct vmem transient_arena_storage;
 244 /* kernel and kmem arenas are aliased for backwards KPI compat. */
 245 vmem_t *kernel_arena = &kernel_arena_storage;
 246 vmem_t *kmem_arena = &kernel_arena_storage;
 247 vmem_t *buffer_arena = &buffer_arena_storage;
 248 vmem_t *transient_arena = &transient_arena_storage;
 249
 250 #ifdef DEBUG_MEMGUARD
 251 static struct vmem memguard_arena_storage;
 252 vmem_t *memguard_arena = &memguard_arena_storage;
 253 #endif
 254
 255 /*
 256  * Fill the vmem's boundary tag cache.  We guarantee that boundary tag
 257  * allocation will not fail once bt_fill() passes.  To do so we cache
 258  * at least the maximum possible tag allocations in the arena.
 259  */
 260 static __noinline int
 261 _bt_fill(vmem_t *vm, int flags)
 262 {
 263         bt_t *bt;
 264
 265         VMEM_ASSERT_LOCKED(vm);
 266
 267         /*
 268          * Only allow the kernel arena and arenas derived from kernel arena to
 269          * dip into reserve tags.  They are where new tags come from.
 270          */
 271         flags &= BT_FLAGS;
 272         if (vm != kernel_arena && vm->vm_arg != kernel_arena)
 273                 flags &= ~M_USE_RESERVE;
 274
 275         /*
 276          * Loop until we meet the reserve.  To minimize the lock shuffle
 277          * and prevent simultaneous fills we first try a NOWAIT regardless
 278          * of the caller's flags.  Specify M_NOVM so we don't recurse while
 279          * holding a vmem lock.
 280          */
 281         while (vm->vm_nfreetags < BT_MAXALLOC) {
 282                 bt = uma_zalloc(vmem_bt_zone,
 283                     (flags & M_USE_RESERVE) | M_NOWAIT | M_NOVM);
 284                 if (bt == NULL) {
 285                         VMEM_UNLOCK(vm);
 286                         bt = uma_zalloc(vmem_bt_zone, flags);
 287                         VMEM_LOCK(vm);
 288                         if (bt == NULL)
 289                                 break;
 290                 }
 291                 LIST_INSERT_HEAD(&vm->vm_freetags, bt, bt_freelist);
 292                 vm->vm_nfreetags++;
 293         }
 294
 295         if (vm->vm_nfreetags < BT_MAXALLOC)
 296                 return ENOMEM;
 297
 298         return 0;
 299 }
 300
 301 static inline int
 302 bt_fill(vmem_t *vm, int flags)
 303 {
 304         if (vm->vm_nfreetags >= BT_MAXALLOC)
 305                 return (0);
 306         return (_bt_fill(vm, flags));
 307 }
 308
 309 /*
 310  * Pop a tag off of the freetag stack.
 311  */
 312 static bt_t *
 313 bt_alloc(vmem_t *vm)
 314 {
 315         bt_t *bt;
 316
 317         VMEM_ASSERT_LOCKED(vm);
 318         bt = LIST_FIRST(&vm->vm_freetags);
 319         MPASS(bt != NULL);
 320         LIST_REMOVE(bt, bt_freelist);
 321         vm->vm_nfreetags--;
 322
 323         return bt;
 324 }
 325
 326 /*
 327  * Trim the per-vmem free list.  Returns with the lock released to
 328  * avoid allocator recursions.
 329  */
 330 static void
 331 bt_freetrim(vmem_t *vm, int freelimit)
 332 {
 333         LIST_HEAD(, vmem_btag) freetags;
 334         bt_t *bt;
 335
 336         LIST_INIT(&freetags);
 337         VMEM_ASSERT_LOCKED(vm);
 338         while (vm->vm_nfreetags > freelimit) {
 339                 bt = LIST_FIRST(&vm->vm_freetags);
 340                 LIST_REMOVE(bt, bt_freelist);
 341                 vm->vm_nfreetags--;
 342                 LIST_INSERT_HEAD(&freetags, bt, bt_freelist);
 343         }
 344         VMEM_UNLOCK(vm);
 345         while ((bt = LIST_FIRST(&freetags)) != NULL) {
 346                 LIST_REMOVE(bt, bt_freelist);
 347                 uma_zfree(vmem_bt_zone, bt);
 348         }
 349 }
 350
 351 static inline void
 352 bt_free(vmem_t *vm, bt_t *bt)
 353 {
 354
 355         VMEM_ASSERT_LOCKED(vm);
 356         MPASS(LIST_FIRST(&vm->vm_freetags) != bt);
 357         LIST_INSERT_HEAD(&vm->vm_freetags, bt, bt_freelist);
 358         vm->vm_nfreetags++;
 359 }
 360
 361 /*
 362  * Hide MAXALLOC tags before dropping the arena lock to ensure that a
 363  * concurrent allocation attempt does not grab them.
 364  */
 365 static void
 366 bt_save(vmem_t *vm)
 367 {
 368         KASSERT(vm->vm_nfreetags >= BT_MAXALLOC,
 369             ("%s: insufficient free tags %d", __func__, vm->vm_nfreetags));
 370         vm->vm_nfreetags -= BT_MAXALLOC;
 371 }
 372
 373 static void
 374 bt_restore(vmem_t *vm)
 375 {
 376         vm->vm_nfreetags += BT_MAXALLOC;
 377 }
 378
 379 /*
 380  * freelist[0] ... [1, 1]
 381  * freelist[1] ... [2, 2]
 382  *  :
 383  * freelist[29] ... [30, 30]
 384  * freelist[30] ... [31, 31]
 385  * freelist[31] ... [32, 63]
 386  * freelist[33] ... [64, 127]
 387  *  :
 388  * freelist[n] ... [(1 << (n - 26)), (1 << (n - 25)) - 1]
 389  *  :
 390  */
 391
 392 static struct vmem_freelist *
 393 bt_freehead_tofree(vmem_t *vm, vmem_size_t size)
 394 {
 395         const vmem_size_t qsize = size >> vm->vm_quantum_shift;
 396         const int idx = SIZE2ORDER(qsize);
 397
 398         MPASS(size != 0 && qsize != 0);
 399         MPASS((size & vm->vm_quantum_mask) == 0);
 400         MPASS(idx >= 0);
 401         MPASS(idx < VMEM_MAXORDER);
 402
 403         return &vm->vm_freelist[idx];
 404 }
 405
 406 /*
 407  * bt_freehead_toalloc: return the freelist for the given size and allocation
 408  * strategy.
 409  *
 410  * For M_FIRSTFIT, return the list in which any blocks are large enough
 411  * for the requested size.  otherwise, return the list which can have blocks
 412  * large enough for the requested size.
 413  */
 414 static struct vmem_freelist *
 415 bt_freehead_toalloc(vmem_t *vm, vmem_size_t size, int strat)
 416 {
 417         const vmem_size_t qsize = size >> vm->vm_quantum_shift;
 418         int idx = SIZE2ORDER(qsize);
 419
 420         MPASS(size != 0 && qsize != 0);
 421         MPASS((size & vm->vm_quantum_mask) == 0);
 422
 423         if (strat == M_FIRSTFIT && ORDER2SIZE(idx) != qsize) {
 424                 idx++;
 425                 /* check too large request? */
 426         }
 427         MPASS(idx >= 0);
 428         MPASS(idx < VMEM_MAXORDER);
 429
 430         return &vm->vm_freelist[idx];
 431 }
 432
 433 /* ---- boundary tag hash */
 434
 435 static struct vmem_hashlist *
 436 bt_hashhead(vmem_t *vm, vmem_addr_t addr)
 437 {
 438         struct vmem_hashlist *list;
 439         unsigned int hash;
 440
 441         hash = hash32_buf(&addr, sizeof(addr), 0);
 442         list = &vm->vm_hashlist[hash % vm->vm_hashsize];
 443
 444         return list;
 445 }
 446
 447 static bt_t *
 448 bt_lookupbusy(vmem_t *vm, vmem_addr_t addr)
 449 {
 450         struct vmem_hashlist *list;
 451         bt_t *bt;
 452
 453         VMEM_ASSERT_LOCKED(vm);
 454         list = bt_hashhead(vm, addr);
 455         LIST_FOREACH(bt, list, bt_hashlist) {
 456                 if (bt->bt_start == addr) {
 457                         break;
 458                 }
 459         }
 460
 461         return bt;
 462 }
 463
 464 static void
 465 bt_rembusy(vmem_t *vm, bt_t *bt)
 466 {
 467
 468         VMEM_ASSERT_LOCKED(vm);
 469         MPASS(vm->vm_nbusytag > 0);
 470         vm->vm_inuse -= bt->bt_size;
 471         vm->vm_nbusytag--;
 472         LIST_REMOVE(bt, bt_hashlist);
 473 }
 474
 475 static void
 476 bt_insbusy(vmem_t *vm, bt_t *bt)
 477 {
 478         struct vmem_hashlist *list;
 479
 480         VMEM_ASSERT_LOCKED(vm);
 481         MPASS(bt->bt_type == BT_TYPE_BUSY);
 482
 483         list = bt_hashhead(vm, bt->bt_start);
 484         LIST_INSERT_HEAD(list, bt, bt_hashlist);
 485         vm->vm_nbusytag++;
 486         vm->vm_inuse += bt->bt_size;
 487 }
 488
 489 /* ---- boundary tag list */
 490
 491 static void
 492 bt_remseg(vmem_t *vm, bt_t *bt)
 493 {
 494
 495         MPASS(bt->bt_type != BT_TYPE_CURSOR);
 496         TAILQ_REMOVE(&vm->vm_seglist, bt, bt_seglist);
 497         bt_free(vm, bt);
 498 }
 499
 500 static void
 501 bt_insseg(vmem_t *vm, bt_t *bt, bt_t *prev)
 502 {
 503
 504         TAILQ_INSERT_AFTER(&vm->vm_seglist, prev, bt, bt_seglist);
 505 }
 506
 507 static void
 508 bt_insseg_tail(vmem_t *vm, bt_t *bt)
 509 {
 510
 511         TAILQ_INSERT_TAIL(&vm->vm_seglist, bt, bt_seglist);
 512 }
 513
 514 static void
 515 bt_remfree(vmem_t *vm, bt_t *bt)
 516 {
 517
 518         MPASS(bt->bt_type == BT_TYPE_FREE);
 519
 520         LIST_REMOVE(bt, bt_freelist);
 521 }
 522
 523 static void
 524 bt_insfree(vmem_t *vm, bt_t *bt)
 525 {
 526         struct vmem_freelist *list;
 527
 528         list = bt_freehead_tofree(vm, bt->bt_size);
 529         LIST_INSERT_HEAD(list, bt, bt_freelist);
 530 }
 531
 532 /* ---- vmem internal functions */
 533
 534 /*
 535  * Import from the arena into the quantum cache in UMA.
 536  *
 537  * We use VMEM_ADDR_QCACHE_MIN instead of 0: uma_zalloc() returns 0 to indicate
 538  * failure, so UMA can't be used to cache a resource with value 0.
 539  */
 540 static int
 541 qc_import(void *arg, void **store, int cnt, int domain, int flags)
 542 {
 543         qcache_t *qc;
 544         vmem_addr_t addr;
 545         int i;
 546
 547         KASSERT((flags & M_WAITOK) == 0, ("blocking allocation"));
 548
 549         qc = arg;
 550         for (i = 0; i < cnt; i++) {
 551                 if (vmem_xalloc(qc->qc_vmem, qc->qc_size, 0, 0, 0,
 552                     VMEM_ADDR_QCACHE_MIN, VMEM_ADDR_MAX, flags, &addr) != 0)
 553                         break;
 554                 store[i] = (void *)addr;
 555         }
 556         return (i);
 557 }
 558
 559 /*
 560  * Release memory from the UMA cache to the arena.
 561  */
 562 static void
 563 qc_release(void *arg, void **store, int cnt)
 564 {
 565         qcache_t *qc;
 566         int i;
 567
 568         qc = arg;
 569         for (i = 0; i < cnt; i++)
 570                 vmem_xfree(qc->qc_vmem, (vmem_addr_t)store[i], qc->qc_size);
 571 }
 572
 573 static void
 574 qc_init(vmem_t *vm, vmem_size_t qcache_max)
 575 {
 576         qcache_t *qc;
 577         vmem_size_t size;
 578         int qcache_idx_max;
 579         int i;
 580
 581         MPASS((qcache_max & vm->vm_quantum_mask) == 0);
 582         qcache_idx_max = MIN(qcache_max >> vm->vm_quantum_shift,
 583             VMEM_QCACHE_IDX_MAX);
 584         vm->vm_qcache_max = qcache_idx_max << vm->vm_quantum_shift;
 585         for (i = 0; i < qcache_idx_max; i++) {
 586                 qc = &vm->vm_qcache[i];
 587                 size = (i + 1) << vm->vm_quantum_shift;
 588                 snprintf(qc->qc_name, sizeof(qc->qc_name), "%s-%zu",
 589                     vm->vm_name, size);
 590                 qc->qc_vmem = vm;
 591                 qc->qc_size = size;
 592                 qc->qc_cache = uma_zcache_create(qc->qc_name, size,
 593                     NULL, NULL, NULL, NULL, qc_import, qc_release, qc,
 594                     UMA_ZONE_VM);
 595                 MPASS(qc->qc_cache);
 596         }
 597 }
 598
 599 static void
 600 qc_destroy(vmem_t *vm)
 601 {
 602         int qcache_idx_max;
 603         int i;
 604
 605         qcache_idx_max = vm->vm_qcache_max >> vm->vm_quantum_shift;
 606         for (i = 0; i < qcache_idx_max; i++)
 607                 uma_zdestroy(vm->vm_qcache[i].qc_cache);
 608 }
 609
 610 static void
 611 qc_drain(vmem_t *vm)
 612 {
 613         int qcache_idx_max;
 614         int i;
 615
 616         qcache_idx_max = vm->vm_qcache_max >> vm->vm_quantum_shift;
 617         for (i = 0; i < qcache_idx_max; i++)
 618                 zone_drain(vm->vm_qcache[i].qc_cache);
 619 }
 620
 621 #ifndef UMA_MD_SMALL_ALLOC
 622
 623 static struct mtx_padalign __exclusive_cache_line vmem_bt_lock;
 624
 625 /*
 626  * vmem_bt_alloc:  Allocate a new page of boundary tags.
 627  *
 628  * On architectures with uma_small_alloc there is no recursion; no address
 629  * space need be allocated to allocate boundary tags.  For the others, we
 630  * must handle recursion.  Boundary tags are necessary to allocate new
 631  * boundary tags.
 632  *
 633  * UMA guarantees that enough tags are held in reserve to allocate a new
 634  * page of kva.  We dip into this reserve by specifying M_USE_RESERVE only
 635  * when allocating the page to hold new boundary tags.  In this way the
 636  * reserve is automatically filled by the allocation that uses the reserve.
 637  *
 638  * We still have to guarantee that the new tags are allocated atomically since
 639  * many threads may try concurrently.  The bt_lock provides this guarantee.
 640  * We convert WAITOK allocations to NOWAIT and then handle the blocking here
 641  * on failure.  It's ok to return NULL for a WAITOK allocation as UMA will
 642  * loop again after checking to see if we lost the race to allocate.
 643  *
 644  * There is a small race between vmem_bt_alloc() returning the page and the
 645  * zone lock being acquired to add the page to the zone.  For WAITOK
 646  * allocations we just pause briefly.  NOWAIT may experience a transient
 647  * failure.  To alleviate this we permit a small number of simultaneous
 648  * fills to proceed concurrently so NOWAIT is less likely to fail unless
 649  * we are really out of KVA.
 650  */
 651 static void *
 652 vmem_bt_alloc(uma_zone_t zone, vm_size_t bytes, int domain, uint8_t *pflag,
 653     int wait)
 654 {
 655         vmem_addr_t addr;
 656
 657         *pflag = UMA_SLAB_KERNEL;
 658
 659         /*
 660          * Single thread boundary tag allocation so that the address space
 661          * and memory are added in one atomic operation.
 662          */
 663         mtx_lock(&vmem_bt_lock);
 664         if (vmem_xalloc(vm_dom[domain].vmd_kernel_arena, bytes, 0, 0, 0,
 665             VMEM_ADDR_MIN, VMEM_ADDR_MAX,
 666             M_NOWAIT | M_NOVM | M_USE_RESERVE | M_BESTFIT, &addr) == 0) {
 667                 if (kmem_back_domain(domain, kernel_object, addr, bytes,
 668                     M_NOWAIT | M_USE_RESERVE) == 0) {
 669                         mtx_unlock(&vmem_bt_lock);
 670                         return ((void *)addr);
 671                 }
 672                 vmem_xfree(vm_dom[domain].vmd_kernel_arena, addr, bytes);
 673                 mtx_unlock(&vmem_bt_lock);
 674                 /*
 675                  * Out of memory, not address space.  This may not even be
 676                  * possible due to M_USE_RESERVE page allocation.
 677                  */
 678                 if (wait & M_WAITOK)
 679                         vm_wait_domain(domain);
 680                 return (NULL);
 681         }
 682         mtx_unlock(&vmem_bt_lock);
 683         /*
 684          * We're either out of address space or lost a fill race.
 685          */
 686         if (wait & M_WAITOK)
 687                 pause("btalloc", 1);
 688
 689         return (NULL);
 690 }
 691
 692 /*
 693  * How many pages do we need to startup_alloc.
 694  */
 695 int
 696 vmem_startup_count(void)
 697 {
 698
 699         return (howmany(BT_MAXALLOC,
 700             UMA_SLAB_SPACE / sizeof(struct vmem_btag)));
 701 }
 702 #endif
 703
 704 void
 705 vmem_startup(void)
 706 {
 707
 708         mtx_init(&vmem_list_lock, "vmem list lock", NULL, MTX_DEF);
 709         vmem_zone = uma_zcreate("vmem",
 710             sizeof(struct vmem), NULL, NULL, NULL, NULL,
 711             UMA_ALIGN_PTR, UMA_ZONE_VM);
 712         vmem_bt_zone = uma_zcreate("vmem btag",
 713             sizeof(struct vmem_btag), NULL, NULL, NULL, NULL,
 714             UMA_ALIGN_PTR, UMA_ZONE_VM | UMA_ZONE_NOFREE);
 715 #ifndef UMA_MD_SMALL_ALLOC
 716         mtx_init(&vmem_bt_lock, "btag lock", NULL, MTX_DEF);
 717         uma_prealloc(vmem_bt_zone, BT_MAXALLOC);
 718         /*
 719          * Reserve enough tags to allocate new tags.  We allow multiple
 720          * CPUs to attempt to allocate new tags concurrently to limit
 721          * false restarts in UMA.  vmem_bt_alloc() allocates from a per-domain
 722          * arena, which may involve importing a range from the kernel arena,
 723          * so we need to keep at least 2 * BT_MAXALLOC tags reserved.
 724          */
 725         uma_zone_reserve(vmem_bt_zone, 2 * BT_MAXALLOC * mp_ncpus);
 726         uma_zone_set_allocf(vmem_bt_zone, vmem_bt_alloc);
 727 #endif
 728 }
 729
 730 /* ---- rehash */
 731
 732 static int
 733 vmem_rehash(vmem_t *vm, vmem_size_t newhashsize)
 734 {
 735         bt_t *bt;
 736         int i;
 737         struct vmem_hashlist *newhashlist;
 738         struct vmem_hashlist *oldhashlist;
 739         vmem_size_t oldhashsize;
 740
 741         MPASS(newhashsize > 0);
 742
 743         newhashlist = malloc(sizeof(struct vmem_hashlist) * newhashsize,
 744             M_VMEM, M_NOWAIT);
 745         if (newhashlist == NULL)
 746                 return ENOMEM;
 747         for (i = 0; i < newhashsize; i++) {
 748                 LIST_INIT(&newhashlist[i]);
 749         }
 750
 751         VMEM_LOCK(vm);
 752         oldhashlist = vm->vm_hashlist;
 753         oldhashsize = vm->vm_hashsize;
 754         vm->vm_hashlist = newhashlist;
 755         vm->vm_hashsize = newhashsize;
 756         if (oldhashlist == NULL) {
 757                 VMEM_UNLOCK(vm);
 758                 return 0;
 759         }
 760         for (i = 0; i < oldhashsize; i++) {
 761                 while ((bt = LIST_FIRST(&oldhashlist[i])) != NULL) {
 762                         bt_rembusy(vm, bt);
 763                         bt_insbusy(vm, bt);
 764                 }
 765         }
 766         VMEM_UNLOCK(vm);
 767
 768         if (oldhashlist != vm->vm_hash0) {
 769                 free(oldhashlist, M_VMEM);
 770         }
 771
 772         return 0;
 773 }
 774
 775 static void
 776 vmem_periodic_kick(void *dummy)
 777 {
 778
 779         taskqueue_enqueue(taskqueue_thread, &vmem_periodic_wk);
 780 }
 781
 782 static void
 783 vmem_periodic(void *unused, int pending)
 784 {
 785         vmem_t *vm;
 786         vmem_size_t desired;
 787         vmem_size_t current;
 788
 789         mtx_lock(&vmem_list_lock);
 790         LIST_FOREACH(vm, &vmem_list, vm_alllist) {
 791 #ifdef DIAGNOSTIC
 792                 /* Convenient time to verify vmem state. */
 793                 if (enable_vmem_check == 1) {
 794                         VMEM_LOCK(vm);
 795                         vmem_check(vm);
 796                         VMEM_UNLOCK(vm);
 797                 }
 798 #endif
 799                 desired = 1 << flsl(vm->vm_nbusytag);
 800                 desired = MIN(MAX(desired, VMEM_HASHSIZE_MIN),
 801                     VMEM_HASHSIZE_MAX);
 802                 current = vm->vm_hashsize;
 803
 804                 /* Grow in powers of two.  Shrink less aggressively. */
 805                 if (desired >= current * 2 || desired * 4 <= current)
 806                         vmem_rehash(vm, desired);
 807
 808                 /*
 809                  * Periodically wake up threads waiting for resources,
 810                  * so they could ask for reclamation again.
 811                  */
 812                 VMEM_CONDVAR_BROADCAST(vm);
 813         }
 814         mtx_unlock(&vmem_list_lock);
 815
 816         callout_reset(&vmem_periodic_ch, vmem_periodic_interval,
 817             vmem_periodic_kick, NULL);
 818 }
 819
 820 static void
 821 vmem_start_callout(void *unused)
 822 {
 823
 824         TASK_INIT(&vmem_periodic_wk, 0, vmem_periodic, NULL);
 825         vmem_periodic_interval = hz * 10;
 826         callout_init(&vmem_periodic_ch, 1);
 827         callout_reset(&vmem_periodic_ch, vmem_periodic_interval,
 828             vmem_periodic_kick, NULL);
 829 }
 830 SYSINIT(vfs, SI_SUB_CONFIGURE, SI_ORDER_ANY, vmem_start_callout, NULL);
 831
 832 static void
 833 vmem_add1(vmem_t *vm, vmem_addr_t addr, vmem_size_t size, int type)
 834 {
 835         bt_t *btspan;
 836         bt_t *btfree;
 837
 838         MPASS(type == BT_TYPE_SPAN || type == BT_TYPE_SPAN_STATIC);
 839         MPASS((size & vm->vm_quantum_mask) == 0);
 840
 841         btspan = bt_alloc(vm);
 842         btspan->bt_type = type;
 843         btspan->bt_start = addr;
 844         btspan->bt_size = size;
 845         bt_insseg_tail(vm, btspan);
 846
 847         btfree = bt_alloc(vm);
 848         btfree->bt_type = BT_TYPE_FREE;
 849         btfree->bt_start = addr;
 850         btfree->bt_size = size;
 851         bt_insseg(vm, btfree, btspan);
 852         bt_insfree(vm, btfree);
 853
 854         vm->vm_size += size;
 855 }
 856
 857 static void
 858 vmem_destroy1(vmem_t *vm)
 859 {
 860         bt_t *bt;
 861
 862         /*
 863          * Drain per-cpu quantum caches.
 864          */
 865         qc_destroy(vm);
 866
 867         /*
 868          * The vmem should now only contain empty segments.
 869          */
 870         VMEM_LOCK(vm);
 871         MPASS(vm->vm_nbusytag == 0);
 872
 873         TAILQ_REMOVE(&vm->vm_seglist, &vm->vm_cursor, bt_seglist);
 874         while ((bt = TAILQ_FIRST(&vm->vm_seglist)) != NULL)
 875                 bt_remseg(vm, bt);
 876
 877         if (vm->vm_hashlist != NULL && vm->vm_hashlist != vm->vm_hash0)
 878                 free(vm->vm_hashlist, M_VMEM);
 879
 880         bt_freetrim(vm, 0);
 881
 882         VMEM_CONDVAR_DESTROY(vm);
 883         VMEM_LOCK_DESTROY(vm);
 884         uma_zfree(vmem_zone, vm);
 885 }
 886
 887 static int
 888 vmem_import(vmem_t *vm, vmem_size_t size, vmem_size_t align, int flags)
 889 {
 890         vmem_addr_t addr;
 891         int error;
 892
 893         if (vm->vm_importfn == NULL)
 894                 return (EINVAL);
 895
 896         /*
 897          * To make sure we get a span that meets the alignment we double it
 898          * and add the size to the tail.  This slightly overestimates.
 899          */
 900         if (align != vm->vm_quantum_mask + 1)
 901                 size = (align * 2) + size;
 902         size = roundup(size, vm->vm_import_quantum);
 903
 904         if (vm->vm_limit != 0 && vm->vm_limit < vm->vm_size + size)
 905                 return (ENOMEM);
 906
 907         bt_save(vm);
 908         VMEM_UNLOCK(vm);
 909         error = (vm->vm_importfn)(vm->vm_arg, size, flags, &addr);
 910         VMEM_LOCK(vm);
 911         bt_restore(vm);
 912         if (error)
 913                 return (ENOMEM);
 914
 915         vmem_add1(vm, addr, size, BT_TYPE_SPAN);
 916
 917         return 0;
 918 }
 919
 920 /*
 921  * vmem_fit: check if a bt can satisfy the given restrictions.
 922  *
 923  * it's a caller's responsibility to ensure the region is big enough
 924  * before calling us.
 925  */
 926 static int
 927 vmem_fit(const bt_t *bt, vmem_size_t size, vmem_size_t align,
 928     vmem_size_t phase, vmem_size_t nocross, vmem_addr_t minaddr,
 929     vmem_addr_t maxaddr, vmem_addr_t *addrp)
 930 {
 931         vmem_addr_t start;
 932         vmem_addr_t end;
 933
 934         MPASS(size > 0);
 935         MPASS(bt->bt_size >= size); /* caller's responsibility */
 936
 937         /*
 938          * XXX assumption: vmem_addr_t and vmem_size_t are
 939          * unsigned integer of the same size.
 940          */
 941
 942         start = bt->bt_start;
 943         if (start < minaddr) {
 944                 start = minaddr;
 945         }
 946         end = BT_END(bt);
 947         if (end > maxaddr)
 948                 end = maxaddr;
 949         if (start > end)
 950                 return (ENOMEM);
 951
 952         start = VMEM_ALIGNUP(start - phase, align) + phase;
 953         if (start < bt->bt_start)
 954                 start += align;
 955         if (VMEM_CROSS_P(start, start + size - 1, nocross)) {
 956                 MPASS(align < nocross);
 957                 start = VMEM_ALIGNUP(start - phase, nocross) + phase;
 958         }
 959         if (start <= end && end - start >= size - 1) {
 960                 MPASS((start & (align - 1)) == phase);
 961                 MPASS(!VMEM_CROSS_P(start, start + size - 1, nocross));
 962                 MPASS(minaddr <= start);
 963                 MPASS(maxaddr == 0 || start + size - 1 <= maxaddr);
 964                 MPASS(bt->bt_start <= start);
 965                 MPASS(BT_END(bt) - start >= size - 1);
 966                 *addrp = start;
 967
 968                 return (0);
 969         }
 970         return (ENOMEM);
 971 }
 972
 973 /*
 974  * vmem_clip:  Trim the boundary tag edges to the requested start and size.
 975  */
 976 static void
 977 vmem_clip(vmem_t *vm, bt_t *bt, vmem_addr_t start, vmem_size_t size)
 978 {
 979         bt_t *btnew;
 980         bt_t *btprev;
 981
 982         VMEM_ASSERT_LOCKED(vm);
 983         MPASS(bt->bt_type == BT_TYPE_FREE);
 984         MPASS(bt->bt_size >= size);
 985         bt_remfree(vm, bt);
 986         if (bt->bt_start != start) {
 987                 btprev = bt_alloc(vm);
 988                 btprev->bt_type = BT_TYPE_FREE;
 989                 btprev->bt_start = bt->bt_start;
 990                 btprev->bt_size = start - bt->bt_start;
 991                 bt->bt_start = start;
 992                 bt->bt_size -= btprev->bt_size;
 993                 bt_insfree(vm, btprev);
 994                 bt_insseg(vm, btprev,
 995                     TAILQ_PREV(bt, vmem_seglist, bt_seglist));
 996         }
 997         MPASS(bt->bt_start == start);
 998         if (bt->bt_size != size && bt->bt_size - size > vm->vm_quantum_mask) {
 999                 /* split */
1000                 btnew = bt_alloc(vm);
1001                 btnew->bt_type = BT_TYPE_BUSY;
1002                 btnew->bt_start = bt->bt_start;
1003                 btnew->bt_size = size;
1004                 bt->bt_start = bt->bt_start + size;
1005                 bt->bt_size -= size;
1006                 bt_insfree(vm, bt);
1007                 bt_insseg(vm, btnew,
1008                     TAILQ_PREV(bt, vmem_seglist, bt_seglist));
1009                 bt_insbusy(vm, btnew);
1010                 bt = btnew;
1011         } else {
1012                 bt->bt_type = BT_TYPE_BUSY;
1013                 bt_insbusy(vm, bt);
1014         }
1015         MPASS(bt->bt_size >= size);
1016 }
1017
1018 static int
1019 vmem_try_fetch(vmem_t *vm, const vmem_size_t size, vmem_size_t align, int flags)
1020 {
1021         vmem_size_t avail;
1022
1023         VMEM_ASSERT_LOCKED(vm);
1024
1025         /*
1026          * XXX it is possible to fail to meet xalloc constraints with the
1027          * imported region.  It is up to the user to specify the
1028          * import quantum such that it can satisfy any allocation.
1029          */
1030         if (vmem_import(vm, size, align, flags) == 0)
1031                 return (1);
1032
1033         /*
1034          * Try to free some space from the quantum cache or reclaim
1035          * functions if available.
1036          */
1037         if (vm->vm_qcache_max != 0 || vm->vm_reclaimfn != NULL) {
1038                 avail = vm->vm_size - vm->vm_inuse;
1039                 bt_save(vm);
1040                 VMEM_UNLOCK(vm);
1041                 if (vm->vm_qcache_max != 0)
1042                         qc_drain(vm);
1043                 if (vm->vm_reclaimfn != NULL)
1044                         vm->vm_reclaimfn(vm, flags);
1045                 VMEM_LOCK(vm);
1046                 bt_restore(vm);
1047                 /* If we were successful retry even NOWAIT. */
1048                 if (vm->vm_size - vm->vm_inuse > avail)
1049                         return (1);
1050         }
1051         if ((flags & M_NOWAIT) != 0)
1052                 return (0);
1053         bt_save(vm);
1054         VMEM_CONDVAR_WAIT(vm);
1055         bt_restore(vm);
1056         return (1);
1057 }
1058
1059 static int
1060 vmem_try_release(vmem_t *vm, struct vmem_btag *bt, const bool remfree)
1061 {
1062         struct vmem_btag *prev;
1063
1064         MPASS(bt->bt_type == BT_TYPE_FREE);
1065
1066         if (vm->vm_releasefn == NULL)
1067                 return (0);
1068
1069         prev = TAILQ_PREV(bt, vmem_seglist, bt_seglist);
1070         MPASS(prev != NULL);
1071         MPASS(prev->bt_type != BT_TYPE_FREE);
1072
1073         if (prev->bt_type == BT_TYPE_SPAN && prev->bt_size == bt->bt_size) {
1074                 vmem_addr_t spanaddr;
1075                 vmem_size_t spansize;
1076
1077                 MPASS(prev->bt_start == bt->bt_start);
1078                 spanaddr = prev->bt_start;
1079                 spansize = prev->bt_size;
1080                 if (remfree)
1081                         bt_remfree(vm, bt);
1082                 bt_remseg(vm, bt);
1083                 bt_remseg(vm, prev);
1084                 vm->vm_size -= spansize;
1085                 VMEM_CONDVAR_BROADCAST(vm);
1086                 bt_freetrim(vm, BT_MAXFREE);
1087                 vm->vm_releasefn(vm->vm_arg, spanaddr, spansize);
1088                 return (1);
1089         }
1090         return (0);
1091 }
1092
1093 static int
1094 vmem_xalloc_nextfit(vmem_t *vm, const vmem_size_t size, vmem_size_t align,
1095     const vmem_size_t phase, const vmem_size_t nocross, int flags,
1096     vmem_addr_t *addrp)
1097 {
1098         struct vmem_btag *bt, *cursor, *next, *prev;
1099         int error;
1100
1101         error = ENOMEM;
1102         VMEM_LOCK(vm);
1103
1104         /*
1105          * Make sure we have enough tags to complete the operation.
1106          */
1107         if (bt_fill(vm, flags) != 0)
1108                 goto out;
1109
1110 retry:
1111         /*
1112          * Find the next free tag meeting our constraints.  If one is found,
1113          * perform the allocation.
1114          */
1115         for (cursor = &vm->vm_cursor, bt = TAILQ_NEXT(cursor, bt_seglist);
1116             bt != cursor; bt = TAILQ_NEXT(bt, bt_seglist)) {
1117                 if (bt == NULL)
1118                         bt = TAILQ_FIRST(&vm->vm_seglist);
1119                 if (bt->bt_type == BT_TYPE_FREE && bt->bt_size >= size &&
1120                     (error = vmem_fit(bt, size, align, phase, nocross,
1121                     VMEM_ADDR_MIN, VMEM_ADDR_MAX, addrp)) == 0) {
1122                         vmem_clip(vm, bt, *addrp, size);
1123                         break;
1124                 }
1125         }
1126
1127         /*
1128          * Try to coalesce free segments around the cursor.  If we succeed, and
1129          * have not yet satisfied the allocation request, try again with the
1130          * newly coalesced segment.
1131          */
1132         if ((next = TAILQ_NEXT(cursor, bt_seglist)) != NULL &&
1133             (prev = TAILQ_PREV(cursor, vmem_seglist, bt_seglist)) != NULL &&
1134             next->bt_type == BT_TYPE_FREE && prev->bt_type == BT_TYPE_FREE &&
1135             prev->bt_start + prev->bt_size == next->bt_start) {
1136                 prev->bt_size += next->bt_size;
1137                 bt_remfree(vm, next);
1138                 bt_remseg(vm, next);
1139
1140                 /*
1141                  * The coalesced segment might be able to satisfy our request.
1142                  * If not, we might need to release it from the arena.
1143                  */
1144                 if (error == ENOMEM && prev->bt_size >= size &&
1145                     (error = vmem_fit(prev, size, align, phase, nocross,
1146                     VMEM_ADDR_MIN, VMEM_ADDR_MAX, addrp)) == 0) {
1147                         vmem_clip(vm, prev, *addrp, size);
1148                         bt = prev;
1149                 } else
1150                         (void)vmem_try_release(vm, prev, true);
1151         }
1152
1153         /*
1154          * If the allocation was successful, advance the cursor.
1155          */
1156         if (error == 0) {
1157                 TAILQ_REMOVE(&vm->vm_seglist, cursor, bt_seglist);
1158                 for (; bt != NULL && bt->bt_start < *addrp + size;
1159                     bt = TAILQ_NEXT(bt, bt_seglist))
1160                         ;
1161                 if (bt != NULL)
1162                         TAILQ_INSERT_BEFORE(bt, cursor, bt_seglist);
1163                 else
1164                         TAILQ_INSERT_HEAD(&vm->vm_seglist, cursor, bt_seglist);
1165         }
1166
1167         /*
1168          * Attempt to bring additional resources into the arena.  If that fails
1169          * and M_WAITOK is specified, sleep waiting for resources to be freed.
1170          */
1171         if (error == ENOMEM && vmem_try_fetch(vm, size, align, flags))
1172                 goto retry;
1173
1174 out:
1175         VMEM_UNLOCK(vm);
1176         return (error);
1177 }
1178
1179 /* ---- vmem API */
1180
1181 void
1182 vmem_set_import(vmem_t *vm, vmem_import_t *importfn,
1183      vmem_release_t *releasefn, void *arg, vmem_size_t import_quantum)
1184 {
1185
1186         VMEM_LOCK(vm);
1187         vm->vm_importfn = importfn;
1188         vm->vm_releasefn = releasefn;
1189         vm->vm_arg = arg;
1190         vm->vm_import_quantum = import_quantum;
1191         VMEM_UNLOCK(vm);
1192 }
1193
1194 void
1195 vmem_set_limit(vmem_t *vm, vmem_size_t limit)
1196 {
1197
1198         VMEM_LOCK(vm);
1199         vm->vm_limit = limit;
1200         VMEM_UNLOCK(vm);
1201 }
1202
1203 void
1204 vmem_set_reclaim(vmem_t *vm, vmem_reclaim_t *reclaimfn)
1205 {
1206
1207         VMEM_LOCK(vm);
1208         vm->vm_reclaimfn = reclaimfn;
1209         VMEM_UNLOCK(vm);
1210 }
1211
1212 /*
1213  * vmem_init: Initializes vmem arena.
1214  */
1215 vmem_t *
1216 vmem_init(vmem_t *vm, const char *name, vmem_addr_t base, vmem_size_t size,
1217     vmem_size_t quantum, vmem_size_t qcache_max, int flags)
1218 {
1219         int i;
1220
1221         MPASS(quantum > 0);
1222         MPASS((quantum & (quantum - 1)) == 0);
1223
1224         bzero(vm, sizeof(*vm));
1225
1226         VMEM_CONDVAR_INIT(vm, name);
1227         VMEM_LOCK_INIT(vm, name);
1228         vm->vm_nfreetags = 0;
1229         LIST_INIT(&vm->vm_freetags);
1230         strlcpy(vm->vm_name, name, sizeof(vm->vm_name));
1231         vm->vm_quantum_mask = quantum - 1;
1232         vm->vm_quantum_shift = flsl(quantum) - 1;
1233         vm->vm_nbusytag = 0;
1234         vm->vm_size = 0;
1235         vm->vm_limit = 0;
1236         vm->vm_inuse = 0;
1237         qc_init(vm, qcache_max);
1238
1239         TAILQ_INIT(&vm->vm_seglist);
1240         vm->vm_cursor.bt_start = vm->vm_cursor.bt_size = 0;
1241         vm->vm_cursor.bt_type = BT_TYPE_CURSOR;
1242         TAILQ_INSERT_TAIL(&vm->vm_seglist, &vm->vm_cursor, bt_seglist);
1243
1244         for (i = 0; i < VMEM_MAXORDER; i++)
1245                 LIST_INIT(&vm->vm_freelist[i]);
1246
1247         memset(&vm->vm_hash0, 0, sizeof(vm->vm_hash0));
1248         vm->vm_hashsize = VMEM_HASHSIZE_MIN;
1249         vm->vm_hashlist = vm->vm_hash0;
1250
1251         if (size != 0) {
1252                 if (vmem_add(vm, base, size, flags) != 0) {
1253                         vmem_destroy1(vm);
1254                         return NULL;
1255                 }
1256         }
1257
1258         mtx_lock(&vmem_list_lock);
1259         LIST_INSERT_HEAD(&vmem_list, vm, vm_alllist);
1260         mtx_unlock(&vmem_list_lock);
1261
1262         return vm;
1263 }
1264
1265 /*
1266  * vmem_create: create an arena.
1267  */
1268 vmem_t *
1269 vmem_create(const char *name, vmem_addr_t base, vmem_size_t size,
1270     vmem_size_t quantum, vmem_size_t qcache_max, int flags)
1271 {
1272
1273         vmem_t *vm;
1274
1275         vm = uma_zalloc(vmem_zone, flags & (M_WAITOK|M_NOWAIT));
1276         if (vm == NULL)
1277                 return (NULL);
1278         if (vmem_init(vm, name, base, size, quantum, qcache_max,
1279             flags) == NULL)
1280                 return (NULL);
1281         return (vm);
1282 }
1283
1284 void
1285 vmem_destroy(vmem_t *vm)
1286 {
1287
1288         mtx_lock(&vmem_list_lock);
1289         LIST_REMOVE(vm, vm_alllist);
1290         mtx_unlock(&vmem_list_lock);
1291
1292         vmem_destroy1(vm);
1293 }
1294
1295 vmem_size_t
1296 vmem_roundup_size(vmem_t *vm, vmem_size_t size)
1297 {
1298
1299         return (size + vm->vm_quantum_mask) & ~vm->vm_quantum_mask;
1300 }
1301
1302 /*
1303  * vmem_alloc: allocate resource from the arena.
1304  */
1305 int
1306 vmem_alloc(vmem_t *vm, vmem_size_t size, int flags, vmem_addr_t *addrp)
1307 {
1308         const int strat __unused = flags & VMEM_FITMASK;
1309         qcache_t *qc;
1310
1311         flags &= VMEM_FLAGS;
1312         MPASS(size > 0);
1313         MPASS(strat == M_BESTFIT || strat == M_FIRSTFIT || strat == M_NEXTFIT);
1314         if ((flags & M_NOWAIT) == 0)
1315                 WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL, "vmem_alloc");
1316
1317         if (size <= vm->vm_qcache_max) {
1318                 /*
1319                  * Resource 0 cannot be cached, so avoid a blocking allocation
1320                  * in qc_import() and give the vmem_xalloc() call below a chance
1321                  * to return 0.
1322                  */
1323                 qc = &vm->vm_qcache[(size - 1) >> vm->vm_quantum_shift];
1324                 *addrp = (vmem_addr_t)uma_zalloc(qc->qc_cache,
1325                     (flags & ~M_WAITOK) | M_NOWAIT);
1326                 if (__predict_true(*addrp != 0))
1327                         return (0);
1328         }
1329
1330         return (vmem_xalloc(vm, size, 0, 0, 0, VMEM_ADDR_MIN, VMEM_ADDR_MAX,
1331             flags, addrp));
1332 }
1333
1334 int
1335 vmem_xalloc(vmem_t *vm, const vmem_size_t size0, vmem_size_t align,
1336     const vmem_size_t phase, const vmem_size_t nocross,
1337     const vmem_addr_t minaddr, const vmem_addr_t maxaddr, int flags,
1338     vmem_addr_t *addrp)
1339 {
1340         const vmem_size_t size = vmem_roundup_size(vm, size0);
1341         struct vmem_freelist *list;
1342         struct vmem_freelist *first;
1343         struct vmem_freelist *end;
1344         bt_t *bt;
1345         int error;
1346         int strat;
1347
1348         flags &= VMEM_FLAGS;
1349         strat = flags & VMEM_FITMASK;
1350         MPASS(size0 > 0);
1351         MPASS(size > 0);
1352         MPASS(strat == M_BESTFIT || strat == M_FIRSTFIT || strat == M_NEXTFIT);
1353         MPASS((flags & (M_NOWAIT|M_WAITOK)) != (M_NOWAIT|M_WAITOK));
1354         if ((flags & M_NOWAIT) == 0)
1355                 WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL, "vmem_xalloc");
1356         MPASS((align & vm->vm_quantum_mask) == 0);
1357         MPASS((align & (align - 1)) == 0);
1358         MPASS((phase & vm->vm_quantum_mask) == 0);
1359         MPASS((nocross & vm->vm_quantum_mask) == 0);
1360         MPASS((nocross & (nocross - 1)) == 0);
1361         MPASS((align == 0 && phase == 0) || phase < align);
1362         MPASS(nocross == 0 || nocross >= size);
1363         MPASS(minaddr <= maxaddr);
1364         MPASS(!VMEM_CROSS_P(phase, phase + size - 1, nocross));
1365         if (strat == M_NEXTFIT)
1366                 MPASS(minaddr == VMEM_ADDR_MIN && maxaddr == VMEM_ADDR_MAX);
1367
1368         if (align == 0)
1369                 align = vm->vm_quantum_mask + 1;
1370         *addrp = 0;
1371
1372         /*
1373          * Next-fit allocations don't use the freelists.
1374          */
1375         if (strat == M_NEXTFIT)
1376                 return (vmem_xalloc_nextfit(vm, size0, align, phase, nocross,
1377                     flags, addrp));
1378
1379         end = &vm->vm_freelist[VMEM_MAXORDER];
1380         /*
1381          * choose a free block from which we allocate.
1382          */
1383         first = bt_freehead_toalloc(vm, size, strat);
1384         VMEM_LOCK(vm);
1385
1386         /*
1387          * Make sure we have enough tags to complete the operation.
1388          */
1389         error = bt_fill(vm, flags);
1390         if (error != 0)
1391                 goto out;
1392         for (;;) {
1393                 /*
1394                  * Scan freelists looking for a tag that satisfies the
1395                  * allocation.  If we're doing BESTFIT we may encounter
1396                  * sizes below the request.  If we're doing FIRSTFIT we
1397                  * inspect only the first element from each list.
1398                  */
1399                 for (list = first; list < end; list++) {
1400                         LIST_FOREACH(bt, list, bt_freelist) {
1401                                 if (bt->bt_size >= size) {
1402                                         error = vmem_fit(bt, size, align, phase,
1403                                             nocross, minaddr, maxaddr, addrp);
1404                                         if (error == 0) {
1405                                                 vmem_clip(vm, bt, *addrp, size);
1406                                                 goto out;
1407                                         }
1408                                 }
1409                                 /* FIRST skips to the next list. */
1410                                 if (strat == M_FIRSTFIT)
1411                                         break;
1412                         }
1413                 }
1414
1415                 /*
1416                  * Retry if the fast algorithm failed.
1417                  */
1418                 if (strat == M_FIRSTFIT) {
1419                         strat = M_BESTFIT;
1420                         first = bt_freehead_toalloc(vm, size, strat);
1421                         continue;
1422                 }
1423
1424                 /*
1425                  * Try a few measures to bring additional resources into the
1426                  * arena.  If all else fails, we will sleep waiting for
1427                  * resources to be freed.
1428                  */
1429                 if (!vmem_try_fetch(vm, size, align, flags)) {
1430                         error = ENOMEM;
1431                         break;
1432                 }
1433         }
1434 out:
1435         VMEM_UNLOCK(vm);
1436         if (error != 0 && (flags & M_NOWAIT) == 0)
1437                 panic("failed to allocate waiting allocation\n");
1438
1439         return (error);
1440 }
1441
1442 /*
1443  * vmem_free: free the resource to the arena.
1444  */
1445 void
1446 vmem_free(vmem_t *vm, vmem_addr_t addr, vmem_size_t size)
1447 {
1448         qcache_t *qc;
1449         MPASS(size > 0);
1450
1451         if (size <= vm->vm_qcache_max &&
1452             __predict_true(addr >= VMEM_ADDR_QCACHE_MIN)) {
1453                 qc = &vm->vm_qcache[(size - 1) >> vm->vm_quantum_shift];
1454                 uma_zfree(qc->qc_cache, (void *)addr);
1455         } else
1456                 vmem_xfree(vm, addr, size);
1457 }
1458
1459 void
1460 vmem_xfree(vmem_t *vm, vmem_addr_t addr, vmem_size_t size)
1461 {
1462         bt_t *bt;
1463         bt_t *t;
1464
1465         MPASS(size > 0);
1466
1467         VMEM_LOCK(vm);
1468         bt = bt_lookupbusy(vm, addr);
1469         MPASS(bt != NULL);
1470         MPASS(bt->bt_start == addr);
1471         MPASS(bt->bt_size == vmem_roundup_size(vm, size) ||
1472             bt->bt_size - vmem_roundup_size(vm, size) <= vm->vm_quantum_mask);
1473         MPASS(bt->bt_type == BT_TYPE_BUSY);
1474         bt_rembusy(vm, bt);
1475         bt->bt_type = BT_TYPE_FREE;
1476
1477         /* coalesce */
1478         t = TAILQ_NEXT(bt, bt_seglist);
1479         if (t != NULL && t->bt_type == BT_TYPE_FREE) {
1480                 MPASS(BT_END(bt) < t->bt_start);        /* YYY */
1481                 bt->bt_size += t->bt_size;
1482                 bt_remfree(vm, t);
1483                 bt_remseg(vm, t);
1484         }
1485         t = TAILQ_PREV(bt, vmem_seglist, bt_seglist);
1486         if (t != NULL && t->bt_type == BT_TYPE_FREE) {
1487                 MPASS(BT_END(t) < bt->bt_start);        /* YYY */
1488                 bt->bt_size += t->bt_size;
1489                 bt->bt_start = t->bt_start;
1490                 bt_remfree(vm, t);
1491                 bt_remseg(vm, t);
1492         }
1493
1494         if (!vmem_try_release(vm, bt, false)) {
1495                 bt_insfree(vm, bt);
1496                 VMEM_CONDVAR_BROADCAST(vm);
1497                 bt_freetrim(vm, BT_MAXFREE);
1498         }
1499 }
1500
1501 /*
1502  * vmem_add:
1503  *
1504  */
1505 int
1506 vmem_add(vmem_t *vm, vmem_addr_t addr, vmem_size_t size, int flags)
1507 {
1508         int error;
1509
1510         flags &= VMEM_FLAGS;
1511
1512         VMEM_LOCK(vm);
1513         error = bt_fill(vm, flags);
1514         if (error == 0)
1515                 vmem_add1(vm, addr, size, BT_TYPE_SPAN_STATIC);
1516         VMEM_UNLOCK(vm);
1517
1518         return (error);
1519 }
1520
1521 /*
1522  * vmem_size: information about arenas size
1523  */
1524 vmem_size_t
1525 vmem_size(vmem_t *vm, int typemask)
1526 {
1527         int i;
1528
1529         switch (typemask) {
1530         case VMEM_ALLOC:
1531                 return vm->vm_inuse;
1532         case VMEM_FREE:
1533                 return vm->vm_size - vm->vm_inuse;
1534         case VMEM_FREE|VMEM_ALLOC:
1535                 return vm->vm_size;
1536         case VMEM_MAXFREE:
1537                 VMEM_LOCK(vm);
1538                 for (i = VMEM_MAXORDER - 1; i >= 0; i--) {
1539                         if (LIST_EMPTY(&vm->vm_freelist[i]))
1540                                 continue;
1541                         VMEM_UNLOCK(vm);
1542                         return ((vmem_size_t)ORDER2SIZE(i) <<
1543                             vm->vm_quantum_shift);
1544                 }
1545                 VMEM_UNLOCK(vm);
1546                 return (0);
1547         default:
1548                 panic("vmem_size");
1549         }
1550 }
1551
1552 /* ---- debug */
1553
1554 #if defined(DDB) || defined(DIAGNOSTIC)
1555
1556 static void bt_dump(const bt_t *, int (*)(const char *, ...)
1557     __printflike(1, 2));
1558
1559 static const char *
1560 bt_type_string(int type)
1561 {
1562
1563         switch (type) {
1564         case BT_TYPE_BUSY:
1565                 return "busy";
1566         case BT_TYPE_FREE:
1567                 return "free";
1568         case BT_TYPE_SPAN:
1569                 return "span";
1570         case BT_TYPE_SPAN_STATIC:
1571                 return "static span";
1572         case BT_TYPE_CURSOR:
1573                 return "cursor";
1574         default:
1575                 break;
1576         }
1577         return "BOGUS";
1578 }
1579
1580 static void
1581 bt_dump(const bt_t *bt, int (*pr)(const char *, ...))
1582 {
1583
1584         (*pr)("\t%p: %jx %jx, %d(%s)\n",
1585             bt, (intmax_t)bt->bt_start, (intmax_t)bt->bt_size,
1586             bt->bt_type, bt_type_string(bt->bt_type));
1587 }
1588
1589 static void
1590 vmem_dump(const vmem_t *vm , int (*pr)(const char *, ...) __printflike(1, 2))
1591 {
1592         const bt_t *bt;
1593         int i;
1594
1595         (*pr)("vmem %p '%s'\n", vm, vm->vm_name);
1596         TAILQ_FOREACH(bt, &vm->vm_seglist, bt_seglist) {
1597                 bt_dump(bt, pr);
1598         }
1599
1600         for (i = 0; i < VMEM_MAXORDER; i++) {
1601                 const struct vmem_freelist *fl = &vm->vm_freelist[i];
1602
1603                 if (LIST_EMPTY(fl)) {
1604                         continue;
1605                 }
1606
1607                 (*pr)("freelist[%d]\n", i);
1608                 LIST_FOREACH(bt, fl, bt_freelist) {
1609                         bt_dump(bt, pr);
1610                 }
1611         }
1612 }
1613
1614 #endif /* defined(DDB) || defined(DIAGNOSTIC) */
1615
1616 #if defined(DDB)
1617 #include <ddb/ddb.h>
1618
1619 static bt_t *
1620 vmem_whatis_lookup(vmem_t *vm, vmem_addr_t addr)
1621 {
1622         bt_t *bt;
1623
1624         TAILQ_FOREACH(bt, &vm->vm_seglist, bt_seglist) {
1625                 if (BT_ISSPAN_P(bt)) {
1626                         continue;
1627                 }
1628                 if (bt->bt_start <= addr && addr <= BT_END(bt)) {
1629                         return bt;
1630                 }
1631         }
1632
1633         return NULL;
1634 }
1635
1636 void
1637 vmem_whatis(vmem_addr_t addr, int (*pr)(const char *, ...))
1638 {
1639         vmem_t *vm;
1640
1641         LIST_FOREACH(vm, &vmem_list, vm_alllist) {
1642                 bt_t *bt;
1643
1644                 bt = vmem_whatis_lookup(vm, addr);
1645                 if (bt == NULL) {
1646                         continue;
1647                 }
1648                 (*pr)("%p is %p+%zu in VMEM '%s' (%s)\n",
1649                     (void *)addr, (void *)bt->bt_start,
1650                     (vmem_size_t)(addr - bt->bt_start), vm->vm_name,
1651                     (bt->bt_type == BT_TYPE_BUSY) ? "allocated" : "free");
1652         }
1653 }
1654
1655 void
1656 vmem_printall(const char *modif, int (*pr)(const char *, ...))
1657 {
1658         const vmem_t *vm;
1659
1660         LIST_FOREACH(vm, &vmem_list, vm_alllist) {
1661                 vmem_dump(vm, pr);
1662         }
1663 }
1664
1665 void
1666 vmem_print(vmem_addr_t addr, const char *modif, int (*pr)(const char *, ...))
1667 {
1668         const vmem_t *vm = (const void *)addr;
1669
1670         vmem_dump(vm, pr);
1671 }
1672
1673 DB_SHOW_COMMAND(vmemdump, vmemdump)
1674 {
1675
1676         if (!have_addr) {
1677                 db_printf("usage: show vmemdump <addr>\n");
1678                 return;
1679         }
1680
1681         vmem_dump((const vmem_t *)addr, db_printf);
1682 }
1683
1684 DB_SHOW_ALL_COMMAND(vmemdump, vmemdumpall)
1685 {
1686         const vmem_t *vm;
1687
1688         LIST_FOREACH(vm, &vmem_list, vm_alllist)
1689                 vmem_dump(vm, db_printf);
1690 }
1691
1692 DB_SHOW_COMMAND(vmem, vmem_summ)
1693 {
1694         const vmem_t *vm = (const void *)addr;
1695         const bt_t *bt;
1696         size_t ft[VMEM_MAXORDER], ut[VMEM_MAXORDER];
1697         size_t fs[VMEM_MAXORDER], us[VMEM_MAXORDER];
1698         int ord;
1699
1700         if (!have_addr) {
1701                 db_printf("usage: show vmem <addr>\n");
1702                 return;
1703         }
1704
1705         db_printf("vmem %p '%s'\n", vm, vm->vm_name);
1706         db_printf("\tquantum:\t%zu\n", vm->vm_quantum_mask + 1);
1707         db_printf("\tsize:\t%zu\n", vm->vm_size);
1708         db_printf("\tinuse:\t%zu\n", vm->vm_inuse);
1709         db_printf("\tfree:\t%zu\n", vm->vm_size - vm->vm_inuse);
1710         db_printf("\tbusy tags:\t%d\n", vm->vm_nbusytag);
1711         db_printf("\tfree tags:\t%d\n", vm->vm_nfreetags);
1712
1713         memset(&ft, 0, sizeof(ft));
1714         memset(&ut, 0, sizeof(ut));
1715         memset(&fs, 0, sizeof(fs));
1716         memset(&us, 0, sizeof(us));
1717         TAILQ_FOREACH(bt, &vm->vm_seglist, bt_seglist) {
1718                 ord = SIZE2ORDER(bt->bt_size >> vm->vm_quantum_shift);
1719                 if (bt->bt_type == BT_TYPE_BUSY) {
1720                         ut[ord]++;
1721                         us[ord] += bt->bt_size;
1722                 } else if (bt->bt_type == BT_TYPE_FREE) {
1723                         ft[ord]++;
1724                         fs[ord] += bt->bt_size;
1725                 }
1726         }
1727         db_printf("\t\t\tinuse\tsize\t\tfree\tsize\n");
1728         for (ord = 0; ord < VMEM_MAXORDER; ord++) {
1729                 if (ut[ord] == 0 && ft[ord] == 0)
1730                         continue;
1731                 db_printf("\t%-15zu %zu\t%-15zu %zu\t%-16zu\n",
1732                     ORDER2SIZE(ord) << vm->vm_quantum_shift,
1733                     ut[ord], us[ord], ft[ord], fs[ord]);
1734         }
1735 }
1736
1737 DB_SHOW_ALL_COMMAND(vmem, vmem_summall)
1738 {
1739         const vmem_t *vm;
1740
1741         LIST_FOREACH(vm, &vmem_list, vm_alllist)
1742                 vmem_summ((db_expr_t)vm, TRUE, count, modif);
1743 }
1744 #endif /* defined(DDB) */
1745
1746 #define vmem_printf printf
1747
1748 #if defined(DIAGNOSTIC)
1749
1750 static bool
1751 vmem_check_sanity(vmem_t *vm)
1752 {
1753         const bt_t *bt, *bt2;
1754
1755         MPASS(vm != NULL);
1756
1757         TAILQ_FOREACH(bt, &vm->vm_seglist, bt_seglist) {
1758                 if (bt->bt_start > BT_END(bt)) {
1759                         printf("corrupted tag\n");
1760                         bt_dump(bt, vmem_printf);
1761                         return false;
1762                 }
1763         }
1764         TAILQ_FOREACH(bt, &vm->vm_seglist, bt_seglist) {
1765                 if (bt->bt_type == BT_TYPE_CURSOR) {
1766                         if (bt->bt_start != 0 || bt->bt_size != 0) {
1767                                 printf("corrupted cursor\n");
1768                                 return false;
1769                         }
1770                         continue;
1771                 }
1772                 TAILQ_FOREACH(bt2, &vm->vm_seglist, bt_seglist) {
1773                         if (bt == bt2) {
1774                                 continue;
1775                         }
1776                         if (bt2->bt_type == BT_TYPE_CURSOR) {
1777                                 continue;
1778                         }
1779                         if (BT_ISSPAN_P(bt) != BT_ISSPAN_P(bt2)) {
1780                                 continue;
1781                         }
1782                         if (bt->bt_start <= BT_END(bt2) &&
1783                             bt2->bt_start <= BT_END(bt)) {
1784                                 printf("overwrapped tags\n");
1785                                 bt_dump(bt, vmem_printf);
1786                                 bt_dump(bt2, vmem_printf);
1787                                 return false;
1788                         }
1789                 }
1790         }
1791
1792         return true;
1793 }
1794
1795 static void
1796 vmem_check(vmem_t *vm)
1797 {
1798
1799         if (!vmem_check_sanity(vm)) {
1800                 panic("insanity vmem %p", vm);
1801         }
1802 }
1803
1804 #endif /* defined(DIAGNOSTIC) */