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
48struct uma_zone;
49/* Opaque type used as a handle to the zone */
50typedef 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 */
69typedef 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 */
87typedef 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 */
106typedef 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 */
123typedef void (*uma_fini)(void *mem, int size);
124
125/*
126 * Import new memory into a cache zone.
127 */
128typedef int (*uma_import)(void *arg, void **store, int count, int domain,
129 int flags);
130
131/*
132 * Free memory from a cache zone.
133 */
134typedef 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 */
177uma_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 */
212uma_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 */
224uma_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_NOTRIM 0x1000 /* Don't trim this zone */
256#define UMA_ZONE_CACHESPREAD 0x2000 /*
257 * Spread memory start locations across
258 * all possible cache lines. May
259 * require many virtually contiguous
260 * backend pages and can fail early.
261 */
262#define UMA_ZONE_NODUMP 0x4000 /*
263 * Zone's pages will not be included in
264 * mini-dumps.
265 */
266#define UMA_ZONE_PCPU 0x8000 /*
267 * Allocates mp_maxid + 1 slabs of
268 * PAGE_SIZE
269 */
270#define UMA_ZONE_FIRSTTOUCH 0x10000 /* First touch NUMA policy */
271#define UMA_ZONE_ROUNDROBIN 0x20000 /* Round-robin NUMA policy. */
272#define UMA_ZONE_SMR 0x40000 /*
273 * Safe memory reclamation defers
274 * frees until all read sections
275 * have exited. This flag creates
276 * a unique SMR context for this
277 * zone. To share contexts see
278 * uma_zone_set_smr() below.
279 *
280 * See sys/smr.h for more details.
281 */
282#define UMA_ZONE_NOKASAN 0x80000 /*
283 * Disable KASAN verification. This is
284 * implied by NOFREE. Cache zones are
285 * not verified by default.
286 */
287/* In use by UMA_ZFLAGs: 0xffe00000 */
288
289/*
290 * These flags are shared between the keg and zone. Some are determined
291 * based on physical parameters of the request and may not be provided by
292 * the consumer.
293 */
294#define UMA_ZONE_INHERIT \
295 (UMA_ZONE_NOTOUCH | UMA_ZONE_MALLOC | UMA_ZONE_NOFREE | \
296 UMA_ZONE_VM | UMA_ZONE_NOTPAGE | UMA_ZONE_PCPU | \
297 UMA_ZONE_FIRSTTOUCH | UMA_ZONE_ROUNDROBIN | UMA_ZONE_NOKASAN)
298
299/* Definitions for align */
300#define UMA_ALIGN_PTR (sizeof(void *) - 1) /* Alignment fit for ptr */
301#define UMA_ALIGN_LONG (sizeof(long) - 1) /* "" long */
302#define UMA_ALIGN_INT (sizeof(int) - 1) /* "" int */
303#define UMA_ALIGN_SHORT (sizeof(short) - 1) /* "" short */
304#define UMA_ALIGN_CHAR (sizeof(char) - 1) /* "" char */
305#define UMA_ALIGN_CACHE (uma_get_cache_align_mask()) /* Cache line size align */
306/* Align both to cache line size and an explicit alignment (through mask). */
307#define UMA_ALIGN_CACHE_AND_MASK(mask) (uma_get_cache_align_mask() | (mask))
308#define UMA_ALIGNOF(type) (_Alignof(type) - 1) /* Alignment fit for 'type' */
309
310#define UMA_ANYDOMAIN -1 /* Special value for domain search. */
311
312/*
313 * Destroys an empty uma zone. If the zone is not empty uma complains loudly.
314 *
315 * Arguments:
316 * zone The zone we want to destroy.
317 *
318 */
319void uma_zdestroy(uma_zone_t zone);
320
321/*
322 * Allocates an item out of a zone
323 *
324 * Arguments:
325 * zone The zone we are allocating from
326 * arg This data is passed to the ctor function
327 * flags See sys/malloc.h for available flags.
328 *
329 * Returns:
330 * A non-null pointer to an initialized element from the zone is
331 * guaranteed if the wait flag is M_WAITOK. Otherwise a null pointer
332 * may be returned if the zone is empty or the ctor failed.
333 */
334
335void *uma_zalloc_arg(uma_zone_t zone, void *arg, int flags);
336
337/* Allocate per-cpu data. Access the correct data with zpcpu_get(). */
338void *uma_zalloc_pcpu_arg(uma_zone_t zone, void *arg, int flags);
339
340/* Use with SMR zones. */
341void *uma_zalloc_smr(uma_zone_t zone, int flags);
342
343/*
344 * Allocate an item from a specific NUMA domain. This uses a slow path in
345 * the allocator but is guaranteed to allocate memory from the requested
346 * domain if M_WAITOK is set.
347 *
348 * Arguments:
349 * zone The zone we are allocating from
350 * arg This data is passed to the ctor function
351 * domain The domain to allocate from.
352 * flags See sys/malloc.h for available flags.
353 */
354void *uma_zalloc_domain(uma_zone_t zone, void *arg, int domain, int flags);
355
356/*
357 * Allocates an item out of a zone without supplying an argument
358 *
359 * This is just a wrapper for uma_zalloc_arg for convenience.
360 *
361 */
362static __inline void *uma_zalloc(uma_zone_t zone, int flags);
363static __inline void *uma_zalloc_pcpu(uma_zone_t zone, int flags);
364
365static __inline void *
366uma_zalloc(uma_zone_t zone, int flags)
367{
368 return uma_zalloc_arg(zone, NULL, flags);
369}
370
371static __inline void *
372uma_zalloc_pcpu(uma_zone_t zone, int flags)
373{
374 return uma_zalloc_pcpu_arg(zone, NULL, flags);
375}
376
377/*
378 * Frees an item back into the specified zone.
379 *
380 * Arguments:
381 * zone The zone the item was originally allocated out of.
382 * item The memory to be freed.
383 * arg Argument passed to the destructor
384 *
385 * Returns:
386 * Nothing.
387 */
388
389void uma_zfree_arg(uma_zone_t zone, void *item, void *arg);
390
391/* Use with PCPU zones. */
392void uma_zfree_pcpu_arg(uma_zone_t zone, void *item, void *arg);
393
394/* Use with SMR zones. */
395void uma_zfree_smr(uma_zone_t zone, void *item);
396
397/*
398 * Frees an item back to a zone without supplying an argument
399 *
400 * This is just a wrapper for uma_zfree_arg for convenience.
401 *
402 */
403static __inline void uma_zfree(uma_zone_t zone, void *item);
404static __inline void uma_zfree_pcpu(uma_zone_t zone, void *item);
405
406static __inline void
407uma_zfree(uma_zone_t zone, void *item)
408{
409 uma_zfree_arg(zone, item, NULL);
410}
411
412static __inline void
413uma_zfree_pcpu(uma_zone_t zone, void *item)
414{
415 uma_zfree_pcpu_arg(zone, item, NULL);
416}
417
418/*
419 * Wait until the specified zone can allocate an item.
420 */
421void uma_zwait(uma_zone_t zone);
422
423/*
424 * Backend page supplier routines
425 *
426 * Arguments:
427 * zone The zone that is requesting pages.
428 * size The number of bytes being requested.
429 * pflag Flags for these memory pages, see below.
430 * domain The NUMA domain that we prefer for this allocation.
431 * wait Indicates our willingness to block.
432 *
433 * Returns:
434 * A pointer to the allocated memory or NULL on failure.
435 */
436
437typedef void *(*uma_alloc)(uma_zone_t zone, vm_size_t size, int domain,
438 uint8_t *pflag, int wait);
439
440/*
441 * Backend page free routines
442 *
443 * Arguments:
444 * item A pointer to the previously allocated pages.
445 * size The original size of the allocation.
446 * pflag The flags for the slab. See UMA_SLAB_* below.
447 *
448 * Returns:
449 * None
450 */
451typedef void (*uma_free)(void *item, vm_size_t size, uint8_t pflag);
452
453/*
454 * Reclaims unused memory. If no NUMA domain is specified, memory from all
455 * domains is reclaimed.
456 *
457 * Arguments:
458 * req Reclamation request type.
459 * domain The target NUMA domain.
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 */
466void uma_reclaim(int req);
467void uma_reclaim_domain(int req, int domain);
468void uma_zone_reclaim(uma_zone_t, int req);
469void uma_zone_reclaim_domain(uma_zone_t, int req, int domain);
470
471/*
472 * Sets the alignment mask to be used for all zones requesting cache
473 * alignment. Should be called by MD boot code prior to starting VM/UMA.
474 *
475 * Arguments:
476 * mask The alignment mask
477 *
478 * Returns:
479 * Nothing
480 */
481void uma_set_cache_align_mask(unsigned int mask);
482
483#include <vm/uma_align_mask.h>
484
485/*
486 * Set a reserved number of items to hold for M_USE_RESERVE allocations. All
487 * other requests must allocate new backing pages.
488 */
489void uma_zone_reserve(uma_zone_t zone, int nitems);
490
491/*
492 * Reserves the maximum KVA space required by the zone and configures the zone
493 * to use a backend that allocates physical memory and maps it using the
494 * reserved KVA.
495 *
496 * Arguments:
497 * zone The zone to update.
498 * nitems The upper limit on the number of items that can be allocated.
499 *
500 * Returns:
501 * 0 if KVA space can not be allocated
502 * 1 if successful
503 *
504 * Discussion:
505 * When the machine supports a direct map and the zone's items are smaller
506 * than a page, the zone will use the direct map instead of allocating KVA
507 * space.
508 */
509int uma_zone_reserve_kva(uma_zone_t zone, int nitems);
510
511/*
512 * Sets an upper limit on the number of items allocated from a zone
513 *
514 * Arguments:
515 * zone The zone to limit
516 * nitems The requested upper limit on the number of items allowed
517 *
518 * Returns:
519 * int The effective value of nitems
520 */
521int uma_zone_set_max(uma_zone_t zone, int nitems);
522
523/*
524 * Sets an upper limit on the number of items allowed in zone's caches
525 *
526 * Arguments:
527 * zone The zone to limit
528 * nitems The requested upper limit on the number of items allowed
529 */
530void uma_zone_set_maxcache(uma_zone_t zone, int nitems);
531
532/*
533 * Obtains the effective limit on the number of items in a zone
534 *
535 * Arguments:
536 * zone The zone to obtain the effective limit from
537 *
538 * Return:
539 * 0 No limit
540 * int The effective limit of the zone
541 */
542int uma_zone_get_max(uma_zone_t zone);
543
544/*
545 * Sets a warning to be printed when limit is reached
546 *
547 * Arguments:
548 * zone The zone we will warn about
549 * warning Warning content
550 *
551 * Returns:
552 * Nothing
553 */
554void uma_zone_set_warning(uma_zone_t zone, const char *warning);
555
556/*
557 * Sets a function to run when limit is reached
558 *
559 * Arguments:
560 * zone The zone to which this applies
561 * fx The function ro run
562 *
563 * Returns:
564 * Nothing
565 */
566typedef void (*uma_maxaction_t)(uma_zone_t, int);
567void uma_zone_set_maxaction(uma_zone_t zone, uma_maxaction_t);
568
569/*
570 * Obtains the approximate current number of items allocated from a zone
571 *
572 * Arguments:
573 * zone The zone to obtain the current allocation count from
574 *
575 * Return:
576 * int The approximate current number of items allocated from the zone
577 */
578int uma_zone_get_cur(uma_zone_t zone);
579
580/*
581 * The following two routines (uma_zone_set_init/fini)
582 * are used to set the backend init/fini pair which acts on an
583 * object as it becomes allocated and is placed in a slab within
584 * the specified zone's backing keg. These should probably not
585 * be changed once allocations have already begun, but only be set
586 * immediately upon zone creation.
587 */
588void uma_zone_set_init(uma_zone_t zone, uma_init uminit);
589void uma_zone_set_fini(uma_zone_t zone, uma_fini fini);
590
591/*
592 * The following two routines (uma_zone_set_zinit/zfini) are
593 * used to set the zinit/zfini pair which acts on an object as
594 * it passes from the backing Keg's slab cache to the
595 * specified Zone's bucket cache. These should probably not
596 * be changed once allocations have already begun, but only be set
597 * immediately upon zone creation.
598 */
599void uma_zone_set_zinit(uma_zone_t zone, uma_init zinit);
600void uma_zone_set_zfini(uma_zone_t zone, uma_fini zfini);
601
602/*
603 * Replaces the standard backend allocator for this zone.
604 *
605 * Arguments:
606 * zone The zone whose backend allocator is being changed.
607 * allocf A pointer to the allocation function
608 *
609 * Returns:
610 * Nothing
611 *
612 * Discussion:
613 * This could be used to implement pageable allocation, or perhaps
614 * even DMA allocators if used in conjunction with the OFFPAGE
615 * zone flag.
616 */
617
618void uma_zone_set_allocf(uma_zone_t zone, uma_alloc allocf);
619
620/*
621 * Used for freeing memory provided by the allocf above
622 *
623 * Arguments:
624 * zone The zone that intends to use this free routine.
625 * freef The page freeing routine.
626 *
627 * Returns:
628 * Nothing
629 */
630
631void uma_zone_set_freef(uma_zone_t zone, uma_free freef);
632
633/*
634 * Associate a zone with a smr context that is allocated after creation
635 * so that multiple zones may share the same context.
636 */
637void uma_zone_set_smr(uma_zone_t zone, smr_t smr);
638
639/*
640 * Fetch the smr context that was set or made in uma_zcreate().
641 */
642smr_t uma_zone_get_smr(uma_zone_t zone);
643
644/*
645 * These flags are settable in the allocf and visible in the freef.
646 */
647#define UMA_SLAB_BOOT 0x01 /* Slab alloced from boot pages */
648#define UMA_SLAB_KERNEL 0x04 /* Slab alloced from kmem */
649#define UMA_SLAB_PRIV 0x08 /* Slab alloced from priv allocator */
650/* 0x02, 0x10, 0x40, and 0x80 are available */
651
652/*
653 * Used to pre-fill a zone with some number of items
654 *
655 * Arguments:
656 * zone The zone to fill
657 * itemcnt The number of items to reserve
658 *
659 * Returns:
660 * Nothing
661 *
662 * NOTE: This is blocking and should only be done at startup
663 */
664void uma_prealloc(uma_zone_t zone, int itemcnt);
665
666/*
667 * Used to determine if a fixed-size zone is exhausted.
668 *
669 * Arguments:
670 * zone The zone to check
671 *
672 * Returns:
673 * Non-zero if zone is exhausted.
674 */
675int uma_zone_exhausted(uma_zone_t zone);
676
677/*
678 * Returns the bytes of memory consumed by the zone.
679 */
680size_t uma_zone_memory(uma_zone_t zone);
681
682/*
683 * Common UMA_ZONE_PCPU zones.
684 */
685extern uma_zone_t pcpu_zone_4;
686extern uma_zone_t pcpu_zone_8;
687extern uma_zone_t pcpu_zone_16;
688extern uma_zone_t pcpu_zone_32;
689extern uma_zone_t pcpu_zone_64;
690
691/*
692 * Exported statistics structures to be used by user space monitoring tools.
693 * Statistics stream consists of a uma_stream_header, followed by a series of
694 * alternative uma_type_header and uma_type_stat structures.
695 */
696#define UMA_STREAM_VERSION 0x00000001
697struct uma_stream_header {
698 uint32_t ush_version; /* Stream format version. */
699 uint32_t ush_maxcpus; /* Value of MAXCPU for stream. */
700 uint32_t ush_count; /* Number of records. */
701 uint32_t _ush_pad; /* Pad/reserved field. */
702};
703
704#define UTH_MAX_NAME 32
705#define UTH_ZONE_SECONDARY 0x00000001
706struct uma_type_header {
707 /*
708 * Static per-zone data, some extracted from the supporting keg.
709 */
710 char uth_name[UTH_MAX_NAME];
711 uint32_t uth_align; /* Keg: alignment. */
712 uint32_t uth_size; /* Keg: requested size of item. */
713 uint32_t uth_rsize; /* Keg: real size of item. */
714 uint32_t uth_maxpages; /* Keg: maximum number of pages. */
715 uint32_t uth_limit; /* Keg: max items to allocate. */
716
717 /*
718 * Current dynamic zone/keg-derived statistics.
719 */
720 uint32_t uth_pages; /* Keg: pages allocated. */
721 uint32_t uth_keg_free; /* Keg: items free. */
722 uint32_t uth_zone_free; /* Zone: items free. */
723 uint32_t uth_bucketsize; /* Zone: desired bucket size. */
724 uint32_t uth_zone_flags; /* Zone: flags. */
725 uint64_t uth_allocs; /* Zone: number of allocations. */
726 uint64_t uth_frees; /* Zone: number of frees. */
727 uint64_t uth_fails; /* Zone: number of alloc failures. */
728 uint64_t uth_sleeps; /* Zone: number of alloc sleeps. */
729 uint64_t uth_xdomain; /* Zone: Number of cross domain frees. */
730 uint64_t _uth_reserved1[1]; /* Reserved. */
731};
732
733struct uma_percpu_stat {
734 uint64_t ups_allocs; /* Cache: number of allocations. */
735 uint64_t ups_frees; /* Cache: number of frees. */
736 uint64_t ups_cache_free; /* Cache: free items in cache. */
737 uint64_t _ups_reserved[5]; /* Reserved. */
738};
739
740void uma_reclaim_wakeup(void);
741void uma_reclaim_worker(void *);
742
743unsigned long uma_limit(void);
744
745/* Return the amount of memory managed by UMA. */
746unsigned long uma_size(void);
747
748/* Return the amount of memory remaining. May be negative. */
749long uma_avail(void);
750
751#endif /* _VM_UMA_H_ */