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 158 /* Function proto types */ 159 160 /* 161 * Create a new uma zone 162 * 163 * Arguments: 164 * name The text name of the zone for debugging and stats. This memory 165 * should not be freed until the zone has been deallocated. 166 * size The size of the object that is being created. 167 * ctor The constructor that is called when the object is allocated. 168 * dtor The destructor that is called when the object is freed. 169 * init An initializer that sets up the initial state of the memory. 170 * fini A discard function that undoes initialization done by init. 171 * ctor/dtor/init/fini may all be null, see notes above. 172 * align A bitmask that corresponds to the requested alignment 173 * eg 4 would be 0x3 174 * flags A set of parameters that control the behavior of the zone. 175 * 176 * Returns: 177 * A pointer to a structure which is intended to be opaque to users of 178 * the interface. The value may be null if the wait flag is not set. 179 */ 180 uma_zone_t uma_zcreate(const char *name, size_t size, uma_ctor ctor, 181 uma_dtor dtor, uma_init uminit, uma_fini fini, 182 int align, uint32_t flags); 183 184 /* 185 * Create a secondary uma zone 186 * 187 * Arguments: 188 * name The text name of the zone for debugging and stats. This memory 189 * should not be freed until the zone has been deallocated. 190 * ctor The constructor that is called when the object is allocated. 191 * dtor The destructor that is called when the object is freed. 192 * zinit An initializer that sets up the initial state of the memory 193 * as the object passes from the Keg's slab to the Zone's cache. 194 * zfini A discard function that undoes initialization done by init 195 * as the object passes from the Zone's cache to the Keg's slab. 196 * 197 * ctor/dtor/zinit/zfini may all be null, see notes above. 198 * Note that the zinit and zfini specified here are NOT 199 * exactly the same as the init/fini specified to uma_zcreate() 200 * when creating a primary zone. These zinit/zfini are called 201 * on the TRANSITION from keg to zone (and vice-versa). Once 202 * these are set, the primary zone may alter its init/fini 203 * (which are called when the object passes from VM to keg) 204 * using uma_zone_set_init/fini()) as well as its own 205 * zinit/zfini (unset by default for primary zone) with 206 * uma_zone_set_zinit/zfini() (note subtle 'z' prefix). 207 * 208 * primary A reference to this zone's Primary Zone which contains the 209 * backing Keg for the Secondary Zone being added. 210 * 211 * Returns: 212 * A pointer to a structure which is intended to be opaque to users of 213 * the interface. The value may be null if the wait flag is not set. 214 */ 215 uma_zone_t uma_zsecond_create(const char *name, uma_ctor ctor, uma_dtor dtor, 216 uma_init zinit, uma_fini zfini, uma_zone_t primary); 217 218 /* 219 * Create cache-only zones. 220 * 221 * This allows uma's per-cpu cache facilities to handle arbitrary 222 * pointers. Consumers must specify the import and release functions to 223 * fill and destroy caches. UMA does not allocate any memory for these 224 * zones. The 'arg' parameter is passed to import/release and is caller 225 * specific. 226 */ 227 uma_zone_t uma_zcache_create(const char *name, int size, uma_ctor ctor, 228 uma_dtor dtor, uma_init zinit, uma_fini zfini, uma_import zimport, 229 uma_release zrelease, void *arg, int flags); 230 231 /* 232 * Definitions for uma_zcreate flags 233 * 234 * These flags share space with UMA_ZFLAGs in uma_int.h. Be careful not to 235 * overlap when adding new features. 236 */ 237 #define UMA_ZONE_ZINIT 0x0002 /* Initialize with zeros */ 238 #define UMA_ZONE_CONTIG 0x0004 /* 239 * Physical memory underlying an object 240 * must be contiguous. 241 */ 242 #define UMA_ZONE_NOTOUCH 0x0008 /* UMA may not access the memory */ 243 #define UMA_ZONE_MALLOC 0x0010 /* For use by malloc(9) only! */ 244 #define UMA_ZONE_NOFREE 0x0020 /* Do not free slabs of this type! */ 245 #define UMA_ZONE_MTXCLASS 0x0040 /* Create a new lock class */ 246 #define UMA_ZONE_VM 0x0080 /* 247 * Used for internal vm datastructures 248 * only. 249 */ 250 #define UMA_ZONE_NOTPAGE 0x0100 /* allocf memory not vm pages */ 251 #define UMA_ZONE_SECONDARY 0x0200 /* Zone is a Secondary Zone */ 252 #define UMA_ZONE_NOBUCKET 0x0400 /* Do not use buckets. */ 253 #define UMA_ZONE_MAXBUCKET 0x0800 /* Use largest buckets. */ 254 #define UMA_ZONE_MINBUCKET 0x1000 /* Use smallest 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 /* In use by UMA_ZFLAGs: 0xffe00000 */ 282 283 /* 284 * These flags are shared between the keg and zone. Some are determined 285 * based on physical parameters of the request and may not be provided by 286 * the consumer. 287 */ 288 #define UMA_ZONE_INHERIT \ 289 (UMA_ZONE_NOTOUCH | UMA_ZONE_MALLOC | UMA_ZONE_NOFREE | \ 290 UMA_ZONE_VM | UMA_ZONE_NOTPAGE | UMA_ZONE_PCPU | \ 291 UMA_ZONE_FIRSTTOUCH | UMA_ZONE_ROUNDROBIN) 292 293 /* Definitions for align */ 294 #define UMA_ALIGN_PTR (sizeof(void *) - 1) /* Alignment fit for ptr */ 295 #define UMA_ALIGN_LONG (sizeof(long) - 1) /* "" long */ 296 #define UMA_ALIGN_INT (sizeof(int) - 1) /* "" int */ 297 #define UMA_ALIGN_SHORT (sizeof(short) - 1) /* "" short */ 298 #define UMA_ALIGN_CHAR (sizeof(char) - 1) /* "" char */ 299 #define UMA_ALIGN_CACHE (0 - 1) /* Cache line size align */ 300 #define UMA_ALIGNOF(type) (_Alignof(type) - 1) /* Alignment fit for 'type' */ 301 302 #define UMA_ANYDOMAIN -1 /* Special value for domain search. */ 303 304 /* 305 * Destroys an empty uma zone. If the zone is not empty uma complains loudly. 306 * 307 * Arguments: 308 * zone The zone we want to destroy. 309 * 310 */ 311 void uma_zdestroy(uma_zone_t zone); 312 313 /* 314 * Allocates an item out of a zone 315 * 316 * Arguments: 317 * zone The zone we are allocating from 318 * arg This data is passed to the ctor function 319 * flags See sys/malloc.h for available flags. 320 * 321 * Returns: 322 * A non-null pointer to an initialized element from the zone is 323 * guaranteed if the wait flag is M_WAITOK. Otherwise a null pointer 324 * may be returned if the zone is empty or the ctor failed. 325 */ 326 327 void *uma_zalloc_arg(uma_zone_t zone, void *arg, int flags); 328 329 /* Allocate per-cpu data. Access the correct data with zpcpu_get(). */ 330 void *uma_zalloc_pcpu_arg(uma_zone_t zone, void *arg, int flags); 331 332 /* Use with SMR zones. */ 333 void *uma_zalloc_smr(uma_zone_t zone, int flags); 334 335 /* 336 * Allocate an item from a specific NUMA domain. This uses a slow path in 337 * the allocator but is guaranteed to allocate memory from the requested 338 * domain if M_WAITOK is set. 339 * 340 * Arguments: 341 * zone The zone we are allocating from 342 * arg This data is passed to the ctor function 343 * domain The domain to allocate from. 344 * flags See sys/malloc.h for available flags. 345 */ 346 void *uma_zalloc_domain(uma_zone_t zone, void *arg, int domain, int flags); 347 348 /* 349 * Allocates an item out of a zone without supplying an argument 350 * 351 * This is just a wrapper for uma_zalloc_arg for convenience. 352 * 353 */ 354 static __inline void *uma_zalloc(uma_zone_t zone, int flags); 355 static __inline void *uma_zalloc_pcpu(uma_zone_t zone, int flags); 356 357 static __inline void * 358 uma_zalloc(uma_zone_t zone, int flags) 359 { 360 return uma_zalloc_arg(zone, NULL, flags); 361 } 362 363 static __inline void * 364 uma_zalloc_pcpu(uma_zone_t zone, int flags) 365 { 366 return uma_zalloc_pcpu_arg(zone, NULL, flags); 367 } 368 369 /* 370 * Frees an item back into the specified zone. 371 * 372 * Arguments: 373 * zone The zone the item was originally allocated out of. 374 * item The memory to be freed. 375 * arg Argument passed to the destructor 376 * 377 * Returns: 378 * Nothing. 379 */ 380 381 void uma_zfree_arg(uma_zone_t zone, void *item, void *arg); 382 383 /* Use with PCPU zones. */ 384 void uma_zfree_pcpu_arg(uma_zone_t zone, void *item, void *arg); 385 386 /* Use with SMR zones. */ 387 void uma_zfree_smr(uma_zone_t zone, void *item); 388 389 /* 390 * Frees an item back to the specified zone's domain specific pool. 391 * 392 * Arguments: 393 * zone The zone the item was originally allocated out of. 394 * item The memory to be freed. 395 * arg Argument passed to the destructor 396 */ 397 void uma_zfree_domain(uma_zone_t zone, void *item, void *arg); 398 399 /* 400 * Frees an item back to a zone without supplying an argument 401 * 402 * This is just a wrapper for uma_zfree_arg for convenience. 403 * 404 */ 405 static __inline void uma_zfree(uma_zone_t zone, void *item); 406 static __inline void uma_zfree_pcpu(uma_zone_t zone, void *item); 407 408 static __inline void 409 uma_zfree(uma_zone_t zone, void *item) 410 { 411 uma_zfree_arg(zone, item, NULL); 412 } 413 414 static __inline void 415 uma_zfree_pcpu(uma_zone_t zone, void *item) 416 { 417 uma_zfree_pcpu_arg(zone, item, NULL); 418 } 419 420 /* 421 * Wait until the specified zone can allocate an item. 422 */ 423 void uma_zwait(uma_zone_t zone); 424 425 /* 426 * Backend page supplier routines 427 * 428 * Arguments: 429 * zone The zone that is requesting pages. 430 * size The number of bytes being requested. 431 * pflag Flags for these memory pages, see below. 432 * domain The NUMA domain that we prefer for this allocation. 433 * wait Indicates our willingness to block. 434 * 435 * Returns: 436 * A pointer to the allocated memory or NULL on failure. 437 */ 438 439 typedef void *(*uma_alloc)(uma_zone_t zone, vm_size_t size, int domain, 440 uint8_t *pflag, int wait); 441 442 /* 443 * Backend page free routines 444 * 445 * Arguments: 446 * item A pointer to the previously allocated pages. 447 * size The original size of the allocation. 448 * pflag The flags for the slab. See UMA_SLAB_* below. 449 * 450 * Returns: 451 * None 452 */ 453 typedef void (*uma_free)(void *item, vm_size_t size, uint8_t pflag); 454 455 /* 456 * Reclaims unused memory 457 * 458 * Arguments: 459 * req Reclamation request type. 460 * Returns: 461 * None 462 */ 463 #define UMA_RECLAIM_DRAIN 1 /* release bucket cache */ 464 #define UMA_RECLAIM_DRAIN_CPU 2 /* release bucket and per-CPU caches */ 465 #define UMA_RECLAIM_TRIM 3 /* trim bucket cache to WSS */ 466 void uma_reclaim(int req); 467 void uma_zone_reclaim(uma_zone_t, int req); 468 469 /* 470 * Sets the alignment mask to be used for all zones requesting cache 471 * alignment. Should be called by MD boot code prior to starting VM/UMA. 472 * 473 * Arguments: 474 * align The alignment mask 475 * 476 * Returns: 477 * Nothing 478 */ 479 void uma_set_align(int align); 480 481 /* 482 * Set a reserved number of items to hold for M_USE_RESERVE allocations. All 483 * other requests must allocate new backing pages. 484 */ 485 void uma_zone_reserve(uma_zone_t zone, int nitems); 486 487 /* 488 * Reserves the maximum KVA space required by the zone and configures the zone 489 * to use a VM_ALLOC_NOOBJ-based backend allocator. 490 * 491 * Arguments: 492 * zone The zone to update. 493 * nitems The upper limit on the number of items that can be allocated. 494 * 495 * Returns: 496 * 0 if KVA space can not be allocated 497 * 1 if successful 498 * 499 * Discussion: 500 * When the machine supports a direct map and the zone's items are smaller 501 * than a page, the zone will use the direct map instead of allocating KVA 502 * space. 503 */ 504 int uma_zone_reserve_kva(uma_zone_t zone, int nitems); 505 506 /* 507 * Sets a high limit on the number of items allowed in a zone 508 * 509 * Arguments: 510 * zone The zone to limit 511 * nitems The requested upper limit on the number of items allowed 512 * 513 * Returns: 514 * int The effective value of nitems 515 */ 516 int uma_zone_set_max(uma_zone_t zone, int nitems); 517 518 /* 519 * Sets a high limit on the number of items allowed in zone's bucket cache 520 * 521 * Arguments: 522 * zone The zone to limit 523 * nitems The requested upper limit on the number of items allowed 524 */ 525 void uma_zone_set_maxcache(uma_zone_t zone, int nitems); 526 527 /* 528 * Obtains the effective limit on the number of items in a zone 529 * 530 * Arguments: 531 * zone The zone to obtain the effective limit from 532 * 533 * Return: 534 * 0 No limit 535 * int The effective limit of the zone 536 */ 537 int uma_zone_get_max(uma_zone_t zone); 538 539 /* 540 * Sets a warning to be printed when limit is reached 541 * 542 * Arguments: 543 * zone The zone we will warn about 544 * warning Warning content 545 * 546 * Returns: 547 * Nothing 548 */ 549 void uma_zone_set_warning(uma_zone_t zone, const char *warning); 550 551 /* 552 * Sets a function to run when limit is reached 553 * 554 * Arguments: 555 * zone The zone to which this applies 556 * fx The function ro run 557 * 558 * Returns: 559 * Nothing 560 */ 561 typedef void (*uma_maxaction_t)(uma_zone_t, int); 562 void uma_zone_set_maxaction(uma_zone_t zone, uma_maxaction_t); 563 564 /* 565 * Obtains the approximate current number of items allocated from a zone 566 * 567 * Arguments: 568 * zone The zone to obtain the current allocation count from 569 * 570 * Return: 571 * int The approximate current number of items allocated from the zone 572 */ 573 int uma_zone_get_cur(uma_zone_t zone); 574 575 /* 576 * The following two routines (uma_zone_set_init/fini) 577 * are used to set the backend init/fini pair which acts on an 578 * object as it becomes allocated and is placed in a slab within 579 * the specified zone's backing keg. These should probably not 580 * be changed once allocations have already begun, but only be set 581 * immediately upon zone creation. 582 */ 583 void uma_zone_set_init(uma_zone_t zone, uma_init uminit); 584 void uma_zone_set_fini(uma_zone_t zone, uma_fini fini); 585 586 /* 587 * The following two routines (uma_zone_set_zinit/zfini) are 588 * used to set the zinit/zfini pair which acts on an object as 589 * it passes from the backing Keg's slab cache to the 590 * specified Zone's bucket cache. These should probably not 591 * be changed once allocations have already begun, but only be set 592 * immediately upon zone creation. 593 */ 594 void uma_zone_set_zinit(uma_zone_t zone, uma_init zinit); 595 void uma_zone_set_zfini(uma_zone_t zone, uma_fini zfini); 596 597 /* 598 * Replaces the standard backend allocator for this zone. 599 * 600 * Arguments: 601 * zone The zone whose backend allocator is being changed. 602 * allocf A pointer to the allocation function 603 * 604 * Returns: 605 * Nothing 606 * 607 * Discussion: 608 * This could be used to implement pageable allocation, or perhaps 609 * even DMA allocators if used in conjunction with the OFFPAGE 610 * zone flag. 611 */ 612 613 void uma_zone_set_allocf(uma_zone_t zone, uma_alloc allocf); 614 615 /* 616 * Used for freeing memory provided by the allocf above 617 * 618 * Arguments: 619 * zone The zone that intends to use this free routine. 620 * freef The page freeing routine. 621 * 622 * Returns: 623 * Nothing 624 */ 625 626 void uma_zone_set_freef(uma_zone_t zone, uma_free freef); 627 628 /* 629 * Associate a zone with a smr context that is allocated after creation 630 * so that multiple zones may share the same context. 631 */ 632 void uma_zone_set_smr(uma_zone_t zone, smr_t smr); 633 634 /* 635 * Fetch the smr context that was set or made in uma_zcreate(). 636 */ 637 smr_t uma_zone_get_smr(uma_zone_t zone); 638 639 /* 640 * These flags are setable in the allocf and visible in the freef. 641 */ 642 #define UMA_SLAB_BOOT 0x01 /* Slab alloced from boot pages */ 643 #define UMA_SLAB_KERNEL 0x04 /* Slab alloced from kmem */ 644 #define UMA_SLAB_PRIV 0x08 /* Slab alloced from priv allocator */ 645 /* 0x02, 0x10, 0x40, and 0x80 are available */ 646 647 /* 648 * Used to pre-fill a zone with some number of items 649 * 650 * Arguments: 651 * zone The zone to fill 652 * itemcnt The number of items to reserve 653 * 654 * Returns: 655 * Nothing 656 * 657 * NOTE: This is blocking and should only be done at startup 658 */ 659 void uma_prealloc(uma_zone_t zone, int itemcnt); 660 661 /* 662 * Used to determine if a fixed-size zone is exhausted. 663 * 664 * Arguments: 665 * zone The zone to check 666 * 667 * Returns: 668 * Non-zero if zone is exhausted. 669 */ 670 int uma_zone_exhausted(uma_zone_t zone); 671 672 /* 673 * Returns the bytes of memory consumed by the zone. 674 */ 675 size_t uma_zone_memory(uma_zone_t zone); 676 677 /* 678 * Common UMA_ZONE_PCPU zones. 679 */ 680 extern uma_zone_t pcpu_zone_int; 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