sys/vm/uma.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2002, 2003, 2004, 2005 Jeffrey Roberson <jeff@FreeBSD.org>
   5  * Copyright (c) 2004, 2005 Bosko Milekic <bmilekic@FreeBSD.org>
   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 unmodified, this list of conditions, and the following
  13  *    disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  23  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  *
  29  * $FreeBSD$
  30  *
  31  */
  32
  33 /*
  34  * uma.h - External definitions for the Universal Memory Allocator
  35  *
  36 */
  37
  38 #ifndef _VM_UMA_H_
  39 #define _VM_UMA_H_
  40
  41 #include <sys/param.h>          /* For NULL */
  42 #include <sys/malloc.h>         /* For M_* */
  43
  44 /* User visible parameters */
  45 #define UMA_SMALLEST_UNIT       (PAGE_SIZE / 256) /* Smallest item allocated */
  46
  47 /* Types and type defs */
  48
  49 struct uma_zone;
  50 /* Opaque type used as a handle to the zone */
  51 typedef struct uma_zone * uma_zone_t;
  52
  53 void zone_drain(uma_zone_t);
  54
  55 /*
  56  * Item constructor
  57  *
  58  * Arguments:
  59  *      item  A pointer to the memory which has been allocated.
  60  *      arg   The arg field passed to uma_zalloc_arg
  61  *      size  The size of the allocated item
  62  *      flags See zalloc flags
  63  *
  64  * Returns:
  65  *      0      on success
  66  *      errno  on failure
  67  *
  68  * Discussion:
  69  *      The constructor is called just before the memory is returned
  70  *      to the user. It may block if necessary.
  71  */
  72 typedef int (*uma_ctor)(void *mem, int size, void *arg, int flags);
  73
  74 /*
  75  * Item destructor
  76  *
  77  * Arguments:
  78  *      item  A pointer to the memory which has been allocated.
  79  *      size  The size of the item being destructed.
  80  *      arg   Argument passed through uma_zfree_arg
  81  *
  82  * Returns:
  83  *      Nothing
  84  *
  85  * Discussion:
  86  *      The destructor may perform operations that differ from those performed
  87  *      by the initializer, but it must leave the object in the same state.
  88  *      This IS type stable storage.  This is called after EVERY zfree call.
  89  */
  90 typedef void (*uma_dtor)(void *mem, int size, void *arg);
  91
  92 /*
  93  * Item initializer
  94  *
  95  * Arguments:
  96  *      item  A pointer to the memory which has been allocated.
  97  *      size  The size of the item being initialized.
  98  *      flags See zalloc flags
  99  *
 100  * Returns:
 101  *      0      on success
 102  *      errno  on failure
 103  *
 104  * Discussion:
 105  *      The initializer is called when the memory is cached in the uma zone.
 106  *      The initializer and the destructor should leave the object in the same
 107  *      state.
 108  */
 109 typedef int (*uma_init)(void *mem, int size, int flags);
 110
 111 /*
 112  * Item discard function
 113  *
 114  * Arguments:
 115  *      item  A pointer to memory which has been 'freed' but has not left the
 116  *            zone's cache.
 117  *      size  The size of the item being discarded.
 118  *
 119  * Returns:
 120  *      Nothing
 121  *
 122  * Discussion:
 123  *      This routine is called when memory leaves a zone and is returned to the
 124  *      system for other uses.  It is the counter-part to the init function.
 125  */
 126 typedef void (*uma_fini)(void *mem, int size);
 127
 128 /*
 129  * Import new memory into a cache zone.
 130  */
 131 typedef int (*uma_import)(void *arg, void **store, int count, int domain,
 132     int flags);
 133
 134 /*
 135  * Free memory from a cache zone.
 136  */
 137 typedef void (*uma_release)(void *arg, void **store, int count);
 138
 139 /*
 140  * What's the difference between initializing and constructing?
 141  *
 142  * The item is initialized when it is cached, and this is the state that the
 143  * object should be in when returned to the allocator. The purpose of this is
 144  * to remove some code which would otherwise be called on each allocation by
 145  * utilizing a known, stable state.  This differs from the constructor which
 146  * will be called on EVERY allocation.
 147  *
 148  * For example, in the initializer you may want to initialize embedded locks,
 149  * NULL list pointers, set up initial states, magic numbers, etc.  This way if
 150  * the object is held in the allocator and re-used it won't be necessary to
 151  * re-initialize it.
 152  *
 153  * The constructor may be used to lock a data structure, link it on to lists,
 154  * bump reference counts or total counts of outstanding structures, etc.
 155  *
 156  */
 157
 158
 159 /* Function proto types */
 160
 161 /*
 162  * Create a new uma zone
 163  *
 164  * Arguments:
 165  *      name  The text name of the zone for debugging and stats. This memory
 166  *              should not be freed until the zone has been deallocated.
 167  *      size  The size of the object that is being created.
 168  *      ctor  The constructor that is called when the object is allocated.
 169  *      dtor  The destructor that is called when the object is freed.
 170  *      init  An initializer that sets up the initial state of the memory.
 171  *      fini  A discard function that undoes initialization done by init.
 172  *              ctor/dtor/init/fini may all be null, see notes above.
 173  *      align A bitmask that corresponds to the requested alignment
 174  *              eg 4 would be 0x3
 175  *      flags A set of parameters that control the behavior of the zone.
 176  *
 177  * Returns:
 178  *      A pointer to a structure which is intended to be opaque to users of
 179  *      the interface.  The value may be null if the wait flag is not set.
 180  */
 181 uma_zone_t uma_zcreate(const char *name, size_t size, uma_ctor ctor,
 182                     uma_dtor dtor, uma_init uminit, uma_fini fini,
 183                     int align, uint32_t flags);
 184
 185 /*
 186  * Create a secondary uma zone
 187  *
 188  * Arguments:
 189  *      name  The text name of the zone for debugging and stats. This memory
 190  *              should not be freed until the zone has been deallocated.
 191  *      ctor  The constructor that is called when the object is allocated.
 192  *      dtor  The destructor that is called when the object is freed.
 193  *      zinit  An initializer that sets up the initial state of the memory
 194  *              as the object passes from the Keg's slab to the Zone's cache.
 195  *      zfini  A discard function that undoes initialization done by init
 196  *              as the object passes from the Zone's cache to the Keg's slab.
 197  *
 198  *              ctor/dtor/zinit/zfini may all be null, see notes above.
 199  *              Note that the zinit and zfini specified here are NOT
 200  *              exactly the same as the init/fini specified to uma_zcreate()
 201  *              when creating a master zone.  These zinit/zfini are called
 202  *              on the TRANSITION from keg to zone (and vice-versa). Once
 203  *              these are set, the primary zone may alter its init/fini
 204  *              (which are called when the object passes from VM to keg)
 205  *              using uma_zone_set_init/fini()) as well as its own
 206  *              zinit/zfini (unset by default for master zone) with
 207  *              uma_zone_set_zinit/zfini() (note subtle 'z' prefix).
 208  *
 209  *      master  A reference to this zone's Master Zone (Primary Zone),
 210  *              which contains the backing Keg for the Secondary Zone
 211  *              being added.
 212  *
 213  * Returns:
 214  *      A pointer to a structure which is intended to be opaque to users of
 215  *      the interface.  The value may be null if the wait flag is not set.
 216  */
 217 uma_zone_t uma_zsecond_create(char *name, uma_ctor ctor, uma_dtor dtor,
 218                     uma_init zinit, uma_fini zfini, uma_zone_t master);
 219
 220 /*
 221  * Create cache-only zones.
 222  *
 223  * This allows uma's per-cpu cache facilities to handle arbitrary
 224  * pointers.  Consumers must specify the import and release functions to
 225  * fill and destroy caches.  UMA does not allocate any memory for these
 226  * zones.  The 'arg' parameter is passed to import/release and is caller
 227  * specific.
 228  */
 229 uma_zone_t uma_zcache_create(char *name, int size, uma_ctor ctor, uma_dtor dtor,
 230                     uma_init zinit, uma_fini zfini, uma_import zimport,
 231                     uma_release zrelease, void *arg, int flags);
 232
 233 /*
 234  * Definitions for uma_zcreate flags
 235  *
 236  * These flags share space with UMA_ZFLAGs in uma_int.h.  Be careful not to
 237  * overlap when adding new features.  0xff000000 is in use by uma_int.h.
 238  */
 239 #define UMA_ZONE_PAGEABLE       0x0001  /* Return items not fully backed by
 240                                            physical memory XXX Not yet */
 241 #define UMA_ZONE_ZINIT          0x0002  /* Initialize with zeros */
 242 #define UMA_ZONE_STATIC         0x0004  /* Statically sized zone */
 243 #define UMA_ZONE_OFFPAGE        0x0008  /* Force the slab structure allocation
 244                                            off of the real memory */
 245 #define UMA_ZONE_MALLOC         0x0010  /* For use by malloc(9) only! */
 246 #define UMA_ZONE_NOFREE         0x0020  /* Do not free slabs of this type! */
 247 #define UMA_ZONE_MTXCLASS       0x0040  /* Create a new lock class */
 248 #define UMA_ZONE_VM             0x0080  /*
 249                                          * Used for internal vm datastructures
 250                                          * only.
 251                                          */
 252 #define UMA_ZONE_HASH           0x0100  /*
 253                                          * Use a hash table instead of caching
 254                                          * information in the vm_page.
 255                                          */
 256 #define UMA_ZONE_SECONDARY      0x0200  /* Zone is a Secondary Zone */
 257 #define UMA_ZONE_NOBUCKET       0x0400  /* Do not use buckets. */
 258 #define UMA_ZONE_MAXBUCKET      0x0800  /* Use largest buckets. */
 259 #define UMA_ZONE_CACHESPREAD    0x1000  /*
 260                                          * Spread memory start locations across
 261                                          * all possible cache lines.  May
 262                                          * require many virtually contiguous
 263                                          * backend pages and can fail early.
 264                                          */
 265 #define UMA_ZONE_VTOSLAB        0x2000  /* Zone uses vtoslab for lookup. */
 266 #define UMA_ZONE_NODUMP         0x4000  /*
 267                                          * Zone's pages will not be included in
 268                                          * mini-dumps.
 269                                          */
 270 #define UMA_ZONE_PCPU           0x8000  /*
 271                                          * Allocates mp_maxid + 1 slabs of PAGE_SIZE
 272                                          */
 273 #define UMA_ZONE_NUMA           0x10000 /*
 274                                          * NUMA aware Zone.  Implements a best
 275                                          * effort first-touch policy.
 276                                          */
 277
 278 /*
 279  * These flags are shared between the keg and zone.  In zones wishing to add
 280  * new kegs these flags must be compatible.  Some are determined based on
 281  * physical parameters of the request and may not be provided by the consumer.
 282  */
 283 #define UMA_ZONE_INHERIT                                                \
 284     (UMA_ZONE_OFFPAGE | UMA_ZONE_MALLOC | UMA_ZONE_NOFREE |             \
 285     UMA_ZONE_HASH | UMA_ZONE_VTOSLAB | UMA_ZONE_PCPU)
 286
 287 /* Definitions for align */
 288 #define UMA_ALIGN_PTR   (sizeof(void *) - 1)    /* Alignment fit for ptr */
 289 #define UMA_ALIGN_LONG  (sizeof(long) - 1)      /* "" long */
 290 #define UMA_ALIGN_INT   (sizeof(int) - 1)       /* "" int */
 291 #define UMA_ALIGN_SHORT (sizeof(short) - 1)     /* "" short */
 292 #define UMA_ALIGN_CHAR  (sizeof(char) - 1)      /* "" char */
 293 #define UMA_ALIGN_CACHE (0 - 1)                 /* Cache line size align */
 294 #define UMA_ALIGNOF(type) (_Alignof(type) - 1)  /* Alignment fit for 'type' */
 295
 296 /*
 297  * Destroys an empty uma zone.  If the zone is not empty uma complains loudly.
 298  *
 299  * Arguments:
 300  *      zone  The zone we want to destroy.
 301  *
 302  */
 303 void uma_zdestroy(uma_zone_t zone);
 304
 305 /*
 306  * Allocates an item out of a zone
 307  *
 308  * Arguments:
 309  *      zone  The zone we are allocating from
 310  *      arg   This data is passed to the ctor function
 311  *      flags See sys/malloc.h for available flags.
 312  *
 313  * Returns:
 314  *      A non-null pointer to an initialized element from the zone is
 315  *      guaranteed if the wait flag is M_WAITOK.  Otherwise a null pointer
 316  *      may be returned if the zone is empty or the ctor failed.
 317  */
 318
 319 void *uma_zalloc_arg(uma_zone_t zone, void *arg, int flags);
 320 void *uma_zalloc_pcpu_arg(uma_zone_t zone, void *arg, int flags);
 321
 322 /*
 323  * Allocate an item from a specific NUMA domain.  This uses a slow path in
 324  * the allocator but is guaranteed to allocate memory from the requested
 325  * domain if M_WAITOK is set.
 326  *
 327  * Arguments:
 328  *      zone  The zone we are allocating from
 329  *      arg   This data is passed to the ctor function
 330  *      domain The domain to allocate from.
 331  *      flags See sys/malloc.h for available flags.
 332  */
 333 void *uma_zalloc_domain(uma_zone_t zone, void *arg, int domain, int flags);
 334
 335 /*
 336  * Allocates an item out of a zone without supplying an argument
 337  *
 338  * This is just a wrapper for uma_zalloc_arg for convenience.
 339  *
 340  */
 341 static __inline void *uma_zalloc(uma_zone_t zone, int flags);
 342 static __inline void *uma_zalloc_pcpu(uma_zone_t zone, int flags);
 343
 344 static __inline void *
 345 uma_zalloc(uma_zone_t zone, int flags)
 346 {
 347         return uma_zalloc_arg(zone, NULL, flags);
 348 }
 349
 350 static __inline void *
 351 uma_zalloc_pcpu(uma_zone_t zone, int flags)
 352 {
 353         return uma_zalloc_pcpu_arg(zone, NULL, flags);
 354 }
 355
 356 /*
 357  * Frees an item back into the specified zone.
 358  *
 359  * Arguments:
 360  *      zone  The zone the item was originally allocated out of.
 361  *      item  The memory to be freed.
 362  *      arg   Argument passed to the destructor
 363  *
 364  * Returns:
 365  *      Nothing.
 366  */
 367
 368 void uma_zfree_arg(uma_zone_t zone, void *item, void *arg);
 369 void uma_zfree_pcpu_arg(uma_zone_t zone, void *item, void *arg);
 370
 371 /*
 372  * Frees an item back to the specified zone's domain specific pool.
 373  *
 374  * Arguments:
 375  *      zone  The zone the item was originally allocated out of.
 376  *      item  The memory to be freed.
 377  *      arg   Argument passed to the destructor
 378  */
 379 void uma_zfree_domain(uma_zone_t zone, void *item, void *arg);
 380
 381 /*
 382  * Frees an item back to a zone without supplying an argument
 383  *
 384  * This is just a wrapper for uma_zfree_arg for convenience.
 385  *
 386  */
 387 static __inline void uma_zfree(uma_zone_t zone, void *item);
 388 static __inline void uma_zfree_pcpu(uma_zone_t zone, void *item);
 389
 390 static __inline void
 391 uma_zfree(uma_zone_t zone, void *item)
 392 {
 393         uma_zfree_arg(zone, item, NULL);
 394 }
 395
 396 static __inline void
 397 uma_zfree_pcpu(uma_zone_t zone, void *item)
 398 {
 399         uma_zfree_pcpu_arg(zone, item, NULL);
 400 }
 401
 402 /*
 403  * Wait until the specified zone can allocate an item.
 404  */
 405 void uma_zwait(uma_zone_t zone);
 406
 407 /*
 408  * Backend page supplier routines
 409  *
 410  * Arguments:
 411  *      zone  The zone that is requesting pages.
 412  *      size  The number of bytes being requested.
 413  *      pflag Flags for these memory pages, see below.
 414  *      domain The NUMA domain that we prefer for this allocation.
 415  *      wait  Indicates our willingness to block.
 416  *
 417  * Returns:
 418  *      A pointer to the allocated memory or NULL on failure.
 419  */
 420
 421 typedef void *(*uma_alloc)(uma_zone_t zone, vm_size_t size, int domain,
 422     uint8_t *pflag, int wait);
 423
 424 /*
 425  * Backend page free routines
 426  *
 427  * Arguments:
 428  *      item  A pointer to the previously allocated pages.
 429  *      size  The original size of the allocation.
 430  *      pflag The flags for the slab.  See UMA_SLAB_* below.
 431  *
 432  * Returns:
 433  *      None
 434  */
 435 typedef void (*uma_free)(void *item, vm_size_t size, uint8_t pflag);
 436
 437 /*
 438  * Reclaims unused memory for all zones
 439  *
 440  * Arguments:
 441  *      None
 442  * Returns:
 443  *      None
 444  *
 445  * This should only be called by the page out daemon.
 446  */
 447
 448 void uma_reclaim(void);
 449
 450 /*
 451  * Sets the alignment mask to be used for all zones requesting cache
 452  * alignment.  Should be called by MD boot code prior to starting VM/UMA.
 453  *
 454  * Arguments:
 455  *      align The alignment mask
 456  *
 457  * Returns:
 458  *      Nothing
 459  */
 460 void uma_set_align(int align);
 461
 462 /*
 463  * Set a reserved number of items to hold for M_USE_RESERVE allocations.  All
 464  * other requests must allocate new backing pages.
 465  */
 466 void uma_zone_reserve(uma_zone_t zone, int nitems);
 467
 468 /*
 469  * Reserves the maximum KVA space required by the zone and configures the zone
 470  * to use a VM_ALLOC_NOOBJ-based backend allocator.
 471  *
 472  * Arguments:
 473  *      zone  The zone to update.
 474  *      nitems  The upper limit on the number of items that can be allocated.
 475  *
 476  * Returns:
 477  *      0  if KVA space can not be allocated
 478  *      1  if successful
 479  *
 480  * Discussion:
 481  *      When the machine supports a direct map and the zone's items are smaller
 482  *      than a page, the zone will use the direct map instead of allocating KVA
 483  *      space.
 484  */
 485 int uma_zone_reserve_kva(uma_zone_t zone, int nitems);
 486
 487 /*
 488  * Sets a high limit on the number of items allowed in a zone
 489  *
 490  * Arguments:
 491  *      zone  The zone to limit
 492  *      nitems  The requested upper limit on the number of items allowed
 493  *
 494  * Returns:
 495  *      int  The effective value of nitems after rounding up based on page size
 496  */
 497 int uma_zone_set_max(uma_zone_t zone, int nitems);
 498
 499 /*
 500  * Sets a high limit on the number of items allowed in zone's bucket cache
 501  *
 502  * Arguments:
 503  *      zone  The zone to limit
 504  *      nitems  The requested upper limit on the number of items allowed
 505  *
 506  * Returns:
 507  *      int  The effective value of nitems set
 508  */
 509 int uma_zone_set_maxcache(uma_zone_t zone, int nitems);
 510
 511 /*
 512  * Obtains the effective limit on the number of items in a zone
 513  *
 514  * Arguments:
 515  *      zone  The zone to obtain the effective limit from
 516  *
 517  * Return:
 518  *      0  No limit
 519  *      int  The effective limit of the zone
 520  */
 521 int uma_zone_get_max(uma_zone_t zone);
 522
 523 /*
 524  * Sets a warning to be printed when limit is reached
 525  *
 526  * Arguments:
 527  *      zone  The zone we will warn about
 528  *      warning  Warning content
 529  *
 530  * Returns:
 531  *      Nothing
 532  */
 533 void uma_zone_set_warning(uma_zone_t zone, const char *warning);
 534
 535 /*
 536  * Sets a function to run when limit is reached
 537  *
 538  * Arguments:
 539  *      zone  The zone to which this applies
 540  *      fx  The function ro run
 541  *
 542  * Returns:
 543  *      Nothing
 544  */
 545 typedef void (*uma_maxaction_t)(uma_zone_t, int);
 546 void uma_zone_set_maxaction(uma_zone_t zone, uma_maxaction_t);
 547
 548 /*
 549  * Obtains the approximate current number of items allocated from a zone
 550  *
 551  * Arguments:
 552  *      zone  The zone to obtain the current allocation count from
 553  *
 554  * Return:
 555  *      int  The approximate current number of items allocated from the zone
 556  */
 557 int uma_zone_get_cur(uma_zone_t zone);
 558
 559 /*
 560  * The following two routines (uma_zone_set_init/fini)
 561  * are used to set the backend init/fini pair which acts on an
 562  * object as it becomes allocated and is placed in a slab within
 563  * the specified zone's backing keg.  These should probably not
 564  * be changed once allocations have already begun, but only be set
 565  * immediately upon zone creation.
 566  */
 567 void uma_zone_set_init(uma_zone_t zone, uma_init uminit);
 568 void uma_zone_set_fini(uma_zone_t zone, uma_fini fini);
 569
 570 /*
 571  * The following two routines (uma_zone_set_zinit/zfini) are
 572  * used to set the zinit/zfini pair which acts on an object as
 573  * it passes from the backing Keg's slab cache to the
 574  * specified Zone's bucket cache.  These should probably not
 575  * be changed once allocations have already begun, but only be set
 576  * immediately upon zone creation.
 577  */
 578 void uma_zone_set_zinit(uma_zone_t zone, uma_init zinit);
 579 void uma_zone_set_zfini(uma_zone_t zone, uma_fini zfini);
 580
 581 /*
 582  * Replaces the standard backend allocator for this zone.
 583  *
 584  * Arguments:
 585  *      zone   The zone whose backend allocator is being changed.
 586  *      allocf A pointer to the allocation function
 587  *
 588  * Returns:
 589  *      Nothing
 590  *
 591  * Discussion:
 592  *      This could be used to implement pageable allocation, or perhaps
 593  *      even DMA allocators if used in conjunction with the OFFPAGE
 594  *      zone flag.
 595  */
 596
 597 void uma_zone_set_allocf(uma_zone_t zone, uma_alloc allocf);
 598
 599 /*
 600  * Used for freeing memory provided by the allocf above
 601  *
 602  * Arguments:
 603  *      zone  The zone that intends to use this free routine.
 604  *      freef The page freeing routine.
 605  *
 606  * Returns:
 607  *      Nothing
 608  */
 609
 610 void uma_zone_set_freef(uma_zone_t zone, uma_free freef);
 611
 612 /*
 613  * These flags are setable in the allocf and visible in the freef.
 614  */
 615 #define UMA_SLAB_BOOT   0x01            /* Slab alloced from boot pages */
 616 #define UMA_SLAB_KERNEL 0x04            /* Slab alloced from kmem */
 617 #define UMA_SLAB_PRIV   0x08            /* Slab alloced from priv allocator */
 618 #define UMA_SLAB_OFFP   0x10            /* Slab is managed separately  */
 619 #define UMA_SLAB_MALLOC 0x20            /* Slab is a large malloc slab */
 620 /* 0x02, 0x40, and 0x80 are available */
 621
 622 /*
 623  * Used to pre-fill a zone with some number of items
 624  *
 625  * Arguments:
 626  *      zone    The zone to fill
 627  *      itemcnt The number of items to reserve
 628  *
 629  * Returns:
 630  *      Nothing
 631  *
 632  * NOTE: This is blocking and should only be done at startup
 633  */
 634 void uma_prealloc(uma_zone_t zone, int itemcnt);
 635
 636 /*
 637  * Used to determine if a fixed-size zone is exhausted.
 638  *
 639  * Arguments:
 640  *      zone    The zone to check
 641  *
 642  * Returns:
 643  *      Non-zero if zone is exhausted.
 644  */
 645 int uma_zone_exhausted(uma_zone_t zone);
 646 int uma_zone_exhausted_nolock(uma_zone_t zone);
 647
 648 /*
 649  * Common UMA_ZONE_PCPU zones.
 650  */
 651 extern uma_zone_t pcpu_zone_64;
 652 extern uma_zone_t pcpu_zone_ptr;
 653
 654 /*
 655  * Exported statistics structures to be used by user space monitoring tools.
 656  * Statistics stream consists of a uma_stream_header, followed by a series of
 657  * alternative uma_type_header and uma_type_stat structures.
 658  */
 659 #define UMA_STREAM_VERSION      0x00000001
 660 struct uma_stream_header {
 661         uint32_t        ush_version;    /* Stream format version. */
 662         uint32_t        ush_maxcpus;    /* Value of MAXCPU for stream. */
 663         uint32_t        ush_count;      /* Number of records. */
 664         uint32_t        _ush_pad;       /* Pad/reserved field. */
 665 };
 666
 667 #define UTH_MAX_NAME    32
 668 #define UTH_ZONE_SECONDARY      0x00000001
 669 struct uma_type_header {
 670         /*
 671          * Static per-zone data, some extracted from the supporting keg.
 672          */
 673         char            uth_name[UTH_MAX_NAME];
 674         uint32_t        uth_align;      /* Keg: alignment. */
 675         uint32_t        uth_size;       /* Keg: requested size of item. */
 676         uint32_t        uth_rsize;      /* Keg: real size of item. */
 677         uint32_t        uth_maxpages;   /* Keg: maximum number of pages. */
 678         uint32_t        uth_limit;      /* Keg: max items to allocate. */
 679
 680         /*
 681          * Current dynamic zone/keg-derived statistics.
 682          */
 683         uint32_t        uth_pages;      /* Keg: pages allocated. */
 684         uint32_t        uth_keg_free;   /* Keg: items free. */
 685         uint32_t        uth_zone_free;  /* Zone: items free. */
 686         uint32_t        uth_bucketsize; /* Zone: desired bucket size. */
 687         uint32_t        uth_zone_flags; /* Zone: flags. */
 688         uint64_t        uth_allocs;     /* Zone: number of allocations. */
 689         uint64_t        uth_frees;      /* Zone: number of frees. */
 690         uint64_t        uth_fails;      /* Zone: number of alloc failures. */
 691         uint64_t        uth_sleeps;     /* Zone: number of alloc sleeps. */
 692         uint64_t        _uth_reserved1[2];      /* Reserved. */
 693 };
 694
 695 struct uma_percpu_stat {
 696         uint64_t        ups_allocs;     /* Cache: number of allocations. */
 697         uint64_t        ups_frees;      /* Cache: number of frees. */
 698         uint64_t        ups_cache_free; /* Cache: free items in cache. */
 699         uint64_t        _ups_reserved[5];       /* Reserved. */
 700 };
 701
 702 void uma_reclaim_wakeup(void);
 703 void uma_reclaim_worker(void *);
 704
 705 unsigned long uma_limit(void);
 706
 707 /* Return the amount of memory managed by UMA. */
 708 unsigned long uma_size(void);
 709
 710 /* Return the amount of memory remaining.  May be negative. */
 711 long uma_avail(void);
 712
 713 #endif  /* _VM_UMA_H_ */