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