sys/vm/uma.h

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