xref: /freebsd/sys/vm/uma.h (revision 0464f16e91d6f654e853004fd8949849c7459dc7)
160727d8bSWarner Losh /*-
2fe267a55SPedro F. Giffuni  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3fe267a55SPedro F. Giffuni  *
408ecce74SRobert Watson  * Copyright (c) 2002, 2003, 2004, 2005 Jeffrey Roberson <jeff@FreeBSD.org>
508ecce74SRobert Watson  * Copyright (c) 2004, 2005 Bosko Milekic <bmilekic@FreeBSD.org>
608ecce74SRobert Watson  * All rights reserved.
78355f576SJeff Roberson  *
88355f576SJeff Roberson  * Redistribution and use in source and binary forms, with or without
98355f576SJeff Roberson  * modification, are permitted provided that the following conditions
108355f576SJeff Roberson  * are met:
118355f576SJeff Roberson  * 1. Redistributions of source code must retain the above copyright
128355f576SJeff Roberson  *    notice unmodified, this list of conditions, and the following
138355f576SJeff Roberson  *    disclaimer.
148355f576SJeff Roberson  * 2. Redistributions in binary form must reproduce the above copyright
158355f576SJeff Roberson  *    notice, this list of conditions and the following disclaimer in the
168355f576SJeff Roberson  *    documentation and/or other materials provided with the distribution.
178355f576SJeff Roberson  *
188355f576SJeff Roberson  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
198355f576SJeff Roberson  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
208355f576SJeff Roberson  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
218355f576SJeff Roberson  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
228355f576SJeff Roberson  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
238355f576SJeff Roberson  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
248355f576SJeff Roberson  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
258355f576SJeff Roberson  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
268355f576SJeff Roberson  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
278355f576SJeff Roberson  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
288355f576SJeff Roberson  *
298355f576SJeff Roberson  * $FreeBSD$
308355f576SJeff Roberson  *
318355f576SJeff Roberson  */
328355f576SJeff Roberson 
338355f576SJeff Roberson /*
348355f576SJeff Roberson  * uma.h - External definitions for the Universal Memory Allocator
358355f576SJeff Roberson  *
368355f576SJeff Roberson */
378355f576SJeff Roberson 
38f947570eSGleb Smirnoff #ifndef _VM_UMA_H_
39f947570eSGleb Smirnoff #define _VM_UMA_H_
408355f576SJeff Roberson 
418355f576SJeff Roberson #include <sys/param.h>		/* For NULL */
428355f576SJeff Roberson #include <sys/malloc.h>		/* For M_* */
43d4665eaaSJeff Roberson #include <sys/_smr.h>
448355f576SJeff Roberson 
452db63c5eSGiorgos Keramidas /* User visible parameters */
469b8db4d0SRyan Libby #define	UMA_SMALLEST_UNIT	8 /* Smallest item allocated */
478355f576SJeff Roberson 
488355f576SJeff Roberson /* Types and type defs */
498355f576SJeff Roberson 
508355f576SJeff Roberson struct uma_zone;
518355f576SJeff Roberson /* Opaque type used as a handle to the zone */
528355f576SJeff Roberson typedef struct uma_zone * uma_zone_t;
538355f576SJeff Roberson 
548355f576SJeff Roberson /*
558355f576SJeff Roberson  * Item constructor
568355f576SJeff Roberson  *
578355f576SJeff Roberson  * Arguments:
588355f576SJeff Roberson  *	item  A pointer to the memory which has been allocated.
598355f576SJeff Roberson  *	arg   The arg field passed to uma_zalloc_arg
608355f576SJeff Roberson  *	size  The size of the allocated item
61b23f72e9SBrian Feldman  *	flags See zalloc flags
628355f576SJeff Roberson  *
638355f576SJeff Roberson  * Returns:
64b23f72e9SBrian Feldman  *	0      on success
65b23f72e9SBrian Feldman  *      errno  on failure
668355f576SJeff Roberson  *
678355f576SJeff Roberson  * Discussion:
688355f576SJeff Roberson  *	The constructor is called just before the memory is returned
6929b4d526SSheldon Hearn  *	to the user. It may block if necessary.
708355f576SJeff Roberson  */
71b23f72e9SBrian Feldman typedef int (*uma_ctor)(void *mem, int size, void *arg, int flags);
728355f576SJeff Roberson 
738355f576SJeff Roberson /*
748355f576SJeff Roberson  * Item destructor
758355f576SJeff Roberson  *
768355f576SJeff Roberson  * Arguments:
778355f576SJeff Roberson  *	item  A pointer to the memory which has been allocated.
788355f576SJeff Roberson  *	size  The size of the item being destructed.
798355f576SJeff Roberson  *	arg   Argument passed through uma_zfree_arg
808355f576SJeff Roberson  *
818355f576SJeff Roberson  * Returns:
828355f576SJeff Roberson  *	Nothing
838355f576SJeff Roberson  *
848355f576SJeff Roberson  * Discussion:
858355f576SJeff Roberson  *	The destructor may perform operations that differ from those performed
868355f576SJeff Roberson  *	by the initializer, but it must leave the object in the same state.
878355f576SJeff Roberson  *	This IS type stable storage.  This is called after EVERY zfree call.
888355f576SJeff Roberson  */
898355f576SJeff Roberson typedef void (*uma_dtor)(void *mem, int size, void *arg);
908355f576SJeff Roberson 
918355f576SJeff Roberson /*
928355f576SJeff Roberson  * Item initializer
938355f576SJeff Roberson  *
948355f576SJeff Roberson  * Arguments:
958355f576SJeff Roberson  *	item  A pointer to the memory which has been allocated.
968355f576SJeff Roberson  *	size  The size of the item being initialized.
97b23f72e9SBrian Feldman  *	flags See zalloc flags
988355f576SJeff Roberson  *
998355f576SJeff Roberson  * Returns:
100b23f72e9SBrian Feldman  *	0      on success
101b23f72e9SBrian Feldman  *      errno  on failure
1028355f576SJeff Roberson  *
1038355f576SJeff Roberson  * Discussion:
1048355f576SJeff Roberson  *	The initializer is called when the memory is cached in the uma zone.
1052db63c5eSGiorgos Keramidas  *	The initializer and the destructor should leave the object in the same
1062db63c5eSGiorgos Keramidas  *	state.
1078355f576SJeff Roberson  */
108b23f72e9SBrian Feldman typedef int (*uma_init)(void *mem, int size, int flags);
1098355f576SJeff Roberson 
1108355f576SJeff Roberson /*
1118355f576SJeff Roberson  * Item discard function
1128355f576SJeff Roberson  *
1138355f576SJeff Roberson  * Arguments:
1148355f576SJeff Roberson  *	item  A pointer to memory which has been 'freed' but has not left the
1158355f576SJeff Roberson  *	      zone's cache.
1168355f576SJeff Roberson  *	size  The size of the item being discarded.
1178355f576SJeff Roberson  *
1188355f576SJeff Roberson  * Returns:
1198355f576SJeff Roberson  *	Nothing
1208355f576SJeff Roberson  *
1218355f576SJeff Roberson  * Discussion:
1228355f576SJeff Roberson  *	This routine is called when memory leaves a zone and is returned to the
1232db63c5eSGiorgos Keramidas  *	system for other uses.  It is the counter-part to the init function.
1248355f576SJeff Roberson  */
1258355f576SJeff Roberson typedef void (*uma_fini)(void *mem, int size);
1268355f576SJeff Roberson 
1278355f576SJeff Roberson /*
1280095a784SJeff Roberson  * Import new memory into a cache zone.
1290095a784SJeff Roberson  */
130ab3185d1SJeff Roberson typedef int (*uma_import)(void *arg, void **store, int count, int domain,
131ab3185d1SJeff Roberson     int flags);
1320095a784SJeff Roberson 
1330095a784SJeff Roberson /*
1340095a784SJeff Roberson  * Free memory from a cache zone.
1350095a784SJeff Roberson  */
1360095a784SJeff Roberson typedef void (*uma_release)(void *arg, void **store, int count);
1370095a784SJeff Roberson 
1380095a784SJeff Roberson /*
1398355f576SJeff Roberson  * What's the difference between initializing and constructing?
1408355f576SJeff Roberson  *
1418355f576SJeff Roberson  * The item is initialized when it is cached, and this is the state that the
1428355f576SJeff Roberson  * object should be in when returned to the allocator. The purpose of this is
1438355f576SJeff Roberson  * to remove some code which would otherwise be called on each allocation by
1448355f576SJeff Roberson  * utilizing a known, stable state.  This differs from the constructor which
1458355f576SJeff Roberson  * will be called on EVERY allocation.
1468355f576SJeff Roberson  *
1472db63c5eSGiorgos Keramidas  * For example, in the initializer you may want to initialize embedded locks,
1488355f576SJeff Roberson  * NULL list pointers, set up initial states, magic numbers, etc.  This way if
14929b4d526SSheldon Hearn  * the object is held in the allocator and re-used it won't be necessary to
1508355f576SJeff Roberson  * re-initialize it.
1518355f576SJeff Roberson  *
1528355f576SJeff Roberson  * The constructor may be used to lock a data structure, link it on to lists,
1538355f576SJeff Roberson  * bump reference counts or total counts of outstanding structures, etc.
1548355f576SJeff Roberson  *
1558355f576SJeff Roberson  */
1568355f576SJeff Roberson 
1578355f576SJeff Roberson 
1588355f576SJeff Roberson /* Function proto types */
1598355f576SJeff Roberson 
1608355f576SJeff Roberson /*
1618355f576SJeff Roberson  * Create a new uma zone
1628355f576SJeff Roberson  *
1638355f576SJeff Roberson  * Arguments:
1642db63c5eSGiorgos Keramidas  *	name  The text name of the zone for debugging and stats. This memory
1658355f576SJeff Roberson  *		should not be freed until the zone has been deallocated.
1668355f576SJeff Roberson  *	size  The size of the object that is being created.
1672db63c5eSGiorgos Keramidas  *	ctor  The constructor that is called when the object is allocated.
1688355f576SJeff Roberson  *	dtor  The destructor that is called when the object is freed.
1698355f576SJeff Roberson  *	init  An initializer that sets up the initial state of the memory.
1708355f576SJeff Roberson  *	fini  A discard function that undoes initialization done by init.
1718355f576SJeff Roberson  *		ctor/dtor/init/fini may all be null, see notes above.
1722db63c5eSGiorgos Keramidas  *	align A bitmask that corresponds to the requested alignment
1738355f576SJeff Roberson  *		eg 4 would be 0x3
1742db63c5eSGiorgos Keramidas  *	flags A set of parameters that control the behavior of the zone.
1758355f576SJeff Roberson  *
1768355f576SJeff Roberson  * Returns:
1778355f576SJeff Roberson  *	A pointer to a structure which is intended to be opaque to users of
1788355f576SJeff Roberson  *	the interface.  The value may be null if the wait flag is not set.
1798355f576SJeff Roberson  */
180bb196eb4SMatthew D Fleming uma_zone_t uma_zcreate(const char *name, size_t size, uma_ctor ctor,
181bb196eb4SMatthew D Fleming 		    uma_dtor dtor, uma_init uminit, uma_fini fini,
18285dcf349SGleb Smirnoff 		    int align, uint32_t flags);
1838355f576SJeff Roberson 
184b60f5b79SJeff Roberson /*
185099a0e58SBosko Milekic  * Create a secondary uma zone
186099a0e58SBosko Milekic  *
187099a0e58SBosko Milekic  * Arguments:
1882db63c5eSGiorgos Keramidas  *	name  The text name of the zone for debugging and stats. This memory
189099a0e58SBosko Milekic  *		should not be freed until the zone has been deallocated.
1902db63c5eSGiorgos Keramidas  *	ctor  The constructor that is called when the object is allocated.
191099a0e58SBosko Milekic  *	dtor  The destructor that is called when the object is freed.
192099a0e58SBosko Milekic  *	zinit  An initializer that sets up the initial state of the memory
193099a0e58SBosko Milekic  *		as the object passes from the Keg's slab to the Zone's cache.
194099a0e58SBosko Milekic  *	zfini  A discard function that undoes initialization done by init
195099a0e58SBosko Milekic  *		as the object passes from the Zone's cache to the Keg's slab.
196099a0e58SBosko Milekic  *
197099a0e58SBosko Milekic  *		ctor/dtor/zinit/zfini may all be null, see notes above.
198099a0e58SBosko Milekic  *		Note that the zinit and zfini specified here are NOT
199099a0e58SBosko Milekic  *		exactly the same as the init/fini specified to uma_zcreate()
200099a0e58SBosko Milekic  *		when creating a master zone.  These zinit/zfini are called
201099a0e58SBosko Milekic  *		on the TRANSITION from keg to zone (and vice-versa). Once
202099a0e58SBosko Milekic  *		these are set, the primary zone may alter its init/fini
203099a0e58SBosko Milekic  *		(which are called when the object passes from VM to keg)
204099a0e58SBosko Milekic  *		using uma_zone_set_init/fini()) as well as its own
205099a0e58SBosko Milekic  *		zinit/zfini (unset by default for master zone) with
206099a0e58SBosko Milekic  *		uma_zone_set_zinit/zfini() (note subtle 'z' prefix).
207099a0e58SBosko Milekic  *
208b83e441bSBosko Milekic  *	master  A reference to this zone's Master Zone (Primary Zone),
209b83e441bSBosko Milekic  *		which contains the backing Keg for the Secondary Zone
210b83e441bSBosko Milekic  *		being added.
211099a0e58SBosko Milekic  *
212099a0e58SBosko Milekic  * Returns:
213099a0e58SBosko Milekic  *	A pointer to a structure which is intended to be opaque to users of
214099a0e58SBosko Milekic  *	the interface.  The value may be null if the wait flag is not set.
215099a0e58SBosko Milekic  */
216*0464f16eSMark Johnston uma_zone_t uma_zsecond_create(const char *name, uma_ctor ctor, uma_dtor dtor,
217099a0e58SBosko Milekic     uma_init zinit, uma_fini zfini, uma_zone_t master);
218099a0e58SBosko Milekic 
219099a0e58SBosko Milekic /*
2200095a784SJeff Roberson  * Create cache-only zones.
2210095a784SJeff Roberson  *
2220095a784SJeff Roberson  * This allows uma's per-cpu cache facilities to handle arbitrary
2230095a784SJeff Roberson  * pointers.  Consumers must specify the import and release functions to
2240095a784SJeff Roberson  * fill and destroy caches.  UMA does not allocate any memory for these
2250095a784SJeff Roberson  * zones.  The 'arg' parameter is passed to import/release and is caller
2260095a784SJeff Roberson  * specific.
2270095a784SJeff Roberson  */
228*0464f16eSMark Johnston uma_zone_t uma_zcache_create(const char *name, int size, uma_ctor ctor,
229*0464f16eSMark Johnston     uma_dtor dtor, uma_init zinit, uma_fini zfini, uma_import zimport,
2300095a784SJeff Roberson     uma_release zrelease, void *arg, int flags);
2310095a784SJeff Roberson 
2320095a784SJeff Roberson /*
233b60f5b79SJeff Roberson  * Definitions for uma_zcreate flags
234b60f5b79SJeff Roberson  *
235b60f5b79SJeff Roberson  * These flags share space with UMA_ZFLAGs in uma_int.h.  Be careful not to
23654c5ae80SRyan Libby  * overlap when adding new features.
237b60f5b79SJeff Roberson  */
2388355f576SJeff Roberson #define UMA_ZONE_ZINIT		0x0002	/* Initialize with zeros */
239ec0d8280SRyan Libby #define UMA_ZONE_CONTIG		0x0004	/*
240ec0d8280SRyan Libby 					 * Physical memory underlying an object
241ec0d8280SRyan Libby 					 * must be contiguous.
242ec0d8280SRyan Libby 					 */
24354c5ae80SRyan Libby #define UMA_ZONE_NOTOUCH	0x0008	/* UMA may not access the memory */
2448355f576SJeff Roberson #define UMA_ZONE_MALLOC		0x0010	/* For use by malloc(9) only! */
2458355f576SJeff Roberson #define UMA_ZONE_NOFREE		0x0020	/* Do not free slabs of this type! */
24628bc4419SJeff Roberson #define UMA_ZONE_MTXCLASS	0x0040	/* Create a new lock class */
24799571dc3SJeff Roberson #define	UMA_ZONE_VM		0x0080	/*
24899571dc3SJeff Roberson 					 * Used for internal vm datastructures
24999571dc3SJeff Roberson 					 * only.
25099571dc3SJeff Roberson 					 */
25154c5ae80SRyan Libby #define	UMA_ZONE_NOTPAGE	0x0100	/* allocf memory not vm pages */
252099a0e58SBosko Milekic #define	UMA_ZONE_SECONDARY	0x0200	/* Zone is a Secondary Zone */
2537e28037aSMark Johnston #define	UMA_ZONE_NOBUCKET	0x0400	/* Do not use buckets. */
2547e28037aSMark Johnston #define	UMA_ZONE_MAXBUCKET	0x0800	/* Use largest buckets. */
25554c5ae80SRyan Libby #define	UMA_ZONE_MINBUCKET	0x1000	/* Use smallest buckets. */
25654c5ae80SRyan Libby #define	UMA_ZONE_CACHESPREAD	0x2000	/*
257e20a199fSJeff Roberson 					 * Spread memory start locations across
258e20a199fSJeff Roberson 					 * all possible cache lines.  May
259e20a199fSJeff Roberson 					 * require many virtually contiguous
260e20a199fSJeff Roberson 					 * backend pages and can fail early.
261e20a199fSJeff Roberson 					 */
262263811f7SKip Macy #define	UMA_ZONE_NODUMP		0x4000	/*
263263811f7SKip Macy 					 * Zone's pages will not be included in
264263811f7SKip Macy 					 * mini-dumps.
265263811f7SKip Macy 					 */
266ad97af7eSGleb Smirnoff #define	UMA_ZONE_PCPU		0x8000	/*
267d4665eaaSJeff Roberson 					 * Allocates mp_maxid + 1 slabs of
268d4665eaaSJeff Roberson 					 * PAGE_SIZE
269ad97af7eSGleb Smirnoff 					 */
27054c5ae80SRyan Libby #define	UMA_ZONE_FIRSTTOUCH	0x10000	/* First touch NUMA policy */
27154c5ae80SRyan Libby #define	UMA_ZONE_ROUNDROBIN	0x20000	/* Round-robin NUMA policy. */
272d4665eaaSJeff Roberson #define	UMA_ZONE_SMR		0x40000 /*
273d4665eaaSJeff Roberson 					 * Safe memory reclamation defers
274d4665eaaSJeff Roberson 					 * frees until all read sections
275d4665eaaSJeff Roberson 					 * have exited.  This flag creates
276d4665eaaSJeff Roberson 					 * a unique SMR context for this
277d4665eaaSJeff Roberson 					 * zone.  To share contexts see
278d4665eaaSJeff Roberson 					 * uma_zone_set_smr() below.
279d4665eaaSJeff Roberson 					 *
280d4665eaaSJeff Roberson 					 * See sys/smr.h for more details.
281d4665eaaSJeff Roberson 					 */
28254c5ae80SRyan Libby /* In use by UMA_ZFLAGs:	0xffe00000 */
283e20a199fSJeff Roberson 
284e20a199fSJeff Roberson /*
285d4665eaaSJeff Roberson  * These flags are shared between the keg and zone.  Some are determined
286d4665eaaSJeff Roberson  * based on physical parameters of the request and may not be provided by
287d4665eaaSJeff Roberson  * the consumer.
288e20a199fSJeff Roberson  */
289e20a199fSJeff Roberson #define	UMA_ZONE_INHERIT						\
29054c5ae80SRyan Libby     (UMA_ZONE_NOTOUCH | UMA_ZONE_MALLOC | UMA_ZONE_NOFREE |		\
291bae55c4aSRyan Libby      UMA_ZONE_VM | UMA_ZONE_NOTPAGE | UMA_ZONE_PCPU |			\
292bae55c4aSRyan Libby      UMA_ZONE_FIRSTTOUCH | UMA_ZONE_ROUNDROBIN)
2938355f576SJeff Roberson 
2948355f576SJeff Roberson /* Definitions for align */
2958355f576SJeff Roberson #define UMA_ALIGN_PTR	(sizeof(void *) - 1)	/* Alignment fit for ptr */
2968355f576SJeff Roberson #define UMA_ALIGN_LONG	(sizeof(long) - 1)	/* "" long */
2978355f576SJeff Roberson #define UMA_ALIGN_INT	(sizeof(int) - 1)	/* "" int */
2988355f576SJeff Roberson #define UMA_ALIGN_SHORT	(sizeof(short) - 1)	/* "" short */
2998355f576SJeff Roberson #define UMA_ALIGN_CHAR	(sizeof(char) - 1)	/* "" char */
3001e319f6dSRobert Watson #define UMA_ALIGN_CACHE	(0 - 1)			/* Cache line size align */
30114c510c0SJohn Baldwin #define	UMA_ALIGNOF(type) (_Alignof(type) - 1)	/* Alignment fit for 'type' */
3028355f576SJeff Roberson 
303b48d4efeSMark Johnston #define	UMA_ANYDOMAIN	-1	/* Special value for domain search. */
304b48d4efeSMark Johnston 
3058355f576SJeff Roberson /*
3069c2cd7e5SJeff Roberson  * Destroys an empty uma zone.  If the zone is not empty uma complains loudly.
3078355f576SJeff Roberson  *
3088355f576SJeff Roberson  * Arguments:
3098355f576SJeff Roberson  *	zone  The zone we want to destroy.
3108355f576SJeff Roberson  *
3118355f576SJeff Roberson  */
3129c2cd7e5SJeff Roberson void uma_zdestroy(uma_zone_t zone);
3138355f576SJeff Roberson 
3148355f576SJeff Roberson /*
3158355f576SJeff Roberson  * Allocates an item out of a zone
3168355f576SJeff Roberson  *
3178355f576SJeff Roberson  * Arguments:
3188355f576SJeff Roberson  *	zone  The zone we are allocating from
3198355f576SJeff Roberson  *	arg   This data is passed to the ctor function
3202cc35ff9SJeff Roberson  *	flags See sys/malloc.h for available flags.
3218355f576SJeff Roberson  *
3228355f576SJeff Roberson  * Returns:
3232db63c5eSGiorgos Keramidas  *	A non-null pointer to an initialized element from the zone is
3242db63c5eSGiorgos Keramidas  *	guaranteed if the wait flag is M_WAITOK.  Otherwise a null pointer
3252db63c5eSGiorgos Keramidas  *	may be returned if the zone is empty or the ctor failed.
3268355f576SJeff Roberson  */
3278355f576SJeff Roberson 
3282cc35ff9SJeff Roberson void *uma_zalloc_arg(uma_zone_t zone, void *arg, int flags);
329d4665eaaSJeff Roberson 
330d4665eaaSJeff Roberson /* Allocate per-cpu data.  Access the correct data with zpcpu_get(). */
3314e180881SMateusz Guzik void *uma_zalloc_pcpu_arg(uma_zone_t zone, void *arg, int flags);
3328355f576SJeff Roberson 
333d4665eaaSJeff Roberson /* Use with SMR zones. */
334d4665eaaSJeff Roberson void *uma_zalloc_smr(uma_zone_t zone, int flags);
335d4665eaaSJeff Roberson 
3368355f576SJeff Roberson /*
337ab3185d1SJeff Roberson  * Allocate an item from a specific NUMA domain.  This uses a slow path in
338ab3185d1SJeff Roberson  * the allocator but is guaranteed to allocate memory from the requested
339ab3185d1SJeff Roberson  * domain if M_WAITOK is set.
340ab3185d1SJeff Roberson  *
341ab3185d1SJeff Roberson  * Arguments:
342ab3185d1SJeff Roberson  *	zone  The zone we are allocating from
343ab3185d1SJeff Roberson  *	arg   This data is passed to the ctor function
344ab3185d1SJeff Roberson  *	domain The domain to allocate from.
345ab3185d1SJeff Roberson  *	flags See sys/malloc.h for available flags.
346ab3185d1SJeff Roberson  */
347ab3185d1SJeff Roberson void *uma_zalloc_domain(uma_zone_t zone, void *arg, int domain, int flags);
348ab3185d1SJeff Roberson 
349ab3185d1SJeff Roberson /*
3508355f576SJeff Roberson  * Allocates an item out of a zone without supplying an argument
3518355f576SJeff Roberson  *
3528355f576SJeff Roberson  * This is just a wrapper for uma_zalloc_arg for convenience.
3538355f576SJeff Roberson  *
3548355f576SJeff Roberson  */
3552cc35ff9SJeff Roberson static __inline void *uma_zalloc(uma_zone_t zone, int flags);
3564e180881SMateusz Guzik static __inline void *uma_zalloc_pcpu(uma_zone_t zone, int flags);
3578355f576SJeff Roberson 
3588355f576SJeff Roberson static __inline void *
3592cc35ff9SJeff Roberson uma_zalloc(uma_zone_t zone, int flags)
3608355f576SJeff Roberson {
3612cc35ff9SJeff Roberson 	return uma_zalloc_arg(zone, NULL, flags);
3628355f576SJeff Roberson }
3638355f576SJeff Roberson 
3644e180881SMateusz Guzik static __inline void *
3654e180881SMateusz Guzik uma_zalloc_pcpu(uma_zone_t zone, int flags)
3664e180881SMateusz Guzik {
3674e180881SMateusz Guzik 	return uma_zalloc_pcpu_arg(zone, NULL, flags);
3684e180881SMateusz Guzik }
3694e180881SMateusz Guzik 
3708355f576SJeff Roberson /*
3718355f576SJeff Roberson  * Frees an item back into the specified zone.
3728355f576SJeff Roberson  *
3738355f576SJeff Roberson  * Arguments:
3748355f576SJeff Roberson  *	zone  The zone the item was originally allocated out of.
3758355f576SJeff Roberson  *	item  The memory to be freed.
3768355f576SJeff Roberson  *	arg   Argument passed to the destructor
3778355f576SJeff Roberson  *
3788355f576SJeff Roberson  * Returns:
3798355f576SJeff Roberson  *	Nothing.
3808355f576SJeff Roberson  */
3818355f576SJeff Roberson 
3828355f576SJeff Roberson void uma_zfree_arg(uma_zone_t zone, void *item, void *arg);
383d4665eaaSJeff Roberson 
384d4665eaaSJeff Roberson /* Use with PCPU zones. */
3854e180881SMateusz Guzik void uma_zfree_pcpu_arg(uma_zone_t zone, void *item, void *arg);
3868355f576SJeff Roberson 
387d4665eaaSJeff Roberson /* Use with SMR zones. */
388d4665eaaSJeff Roberson void uma_zfree_smr(uma_zone_t zone, void *item);
389d4665eaaSJeff Roberson 
3908355f576SJeff Roberson /*
391ab3185d1SJeff Roberson  * Frees an item back to the specified zone's domain specific pool.
392ab3185d1SJeff Roberson  *
393ab3185d1SJeff Roberson  * Arguments:
394ab3185d1SJeff Roberson  *	zone  The zone the item was originally allocated out of.
395ab3185d1SJeff Roberson  *	item  The memory to be freed.
396ab3185d1SJeff Roberson  *	arg   Argument passed to the destructor
397ab3185d1SJeff Roberson  */
398ab3185d1SJeff Roberson void uma_zfree_domain(uma_zone_t zone, void *item, void *arg);
399ab3185d1SJeff Roberson 
400ab3185d1SJeff Roberson /*
4018355f576SJeff Roberson  * Frees an item back to a zone without supplying an argument
4028355f576SJeff Roberson  *
4038355f576SJeff Roberson  * This is just a wrapper for uma_zfree_arg for convenience.
4048355f576SJeff Roberson  *
4058355f576SJeff Roberson  */
4068355f576SJeff Roberson static __inline void uma_zfree(uma_zone_t zone, void *item);
4074e180881SMateusz Guzik static __inline void uma_zfree_pcpu(uma_zone_t zone, void *item);
4088355f576SJeff Roberson 
4098355f576SJeff Roberson static __inline void
4108355f576SJeff Roberson uma_zfree(uma_zone_t zone, void *item)
4118355f576SJeff Roberson {
412f6e34b82SMark Murray 	uma_zfree_arg(zone, item, NULL);
4138355f576SJeff Roberson }
4148355f576SJeff Roberson 
4154e180881SMateusz Guzik static __inline void
4164e180881SMateusz Guzik uma_zfree_pcpu(uma_zone_t zone, void *item)
4174e180881SMateusz Guzik {
4184e180881SMateusz Guzik 	uma_zfree_pcpu_arg(zone, item, NULL);
4194e180881SMateusz Guzik }
4204e180881SMateusz Guzik 
4218355f576SJeff Roberson /*
4228d6fbbb8SJeff Roberson  * Wait until the specified zone can allocate an item.
4238d6fbbb8SJeff Roberson  */
4248d6fbbb8SJeff Roberson void uma_zwait(uma_zone_t zone);
4258d6fbbb8SJeff Roberson 
4268d6fbbb8SJeff Roberson /*
4278355f576SJeff Roberson  * Backend page supplier routines
4288355f576SJeff Roberson  *
4298355f576SJeff Roberson  * Arguments:
4302db63c5eSGiorgos Keramidas  *	zone  The zone that is requesting pages.
4312db63c5eSGiorgos Keramidas  *	size  The number of bytes being requested.
4328355f576SJeff Roberson  *	pflag Flags for these memory pages, see below.
433ab3185d1SJeff Roberson  *	domain The NUMA domain that we prefer for this allocation.
4348355f576SJeff Roberson  *	wait  Indicates our willingness to block.
4358355f576SJeff Roberson  *
4368355f576SJeff Roberson  * Returns:
4372db63c5eSGiorgos Keramidas  *	A pointer to the allocated memory or NULL on failure.
4388355f576SJeff Roberson  */
4398355f576SJeff Roberson 
440ab3185d1SJeff Roberson typedef void *(*uma_alloc)(uma_zone_t zone, vm_size_t size, int domain,
441ab3185d1SJeff Roberson     uint8_t *pflag, int wait);
4428355f576SJeff Roberson 
4438355f576SJeff Roberson /*
4448355f576SJeff Roberson  * Backend page free routines
4458355f576SJeff Roberson  *
4468355f576SJeff Roberson  * Arguments:
4472db63c5eSGiorgos Keramidas  *	item  A pointer to the previously allocated pages.
4482db63c5eSGiorgos Keramidas  *	size  The original size of the allocation.
4492db63c5eSGiorgos Keramidas  *	pflag The flags for the slab.  See UMA_SLAB_* below.
4508355f576SJeff Roberson  *
4518355f576SJeff Roberson  * Returns:
4528355f576SJeff Roberson  *	None
4538355f576SJeff Roberson  */
454f2c2231eSRyan Stone typedef void (*uma_free)(void *item, vm_size_t size, uint8_t pflag);
4558355f576SJeff Roberson 
4568355f576SJeff Roberson /*
45708cfa56eSMark Johnston  * Reclaims unused memory
4588355f576SJeff Roberson  *
4598355f576SJeff Roberson  * Arguments:
46008cfa56eSMark Johnston  *	req  Reclamation request type.
4618355f576SJeff Roberson  * Returns:
4628355f576SJeff Roberson  *	None
4638355f576SJeff Roberson  */
46408cfa56eSMark Johnston #define	UMA_RECLAIM_DRAIN	1	/* release bucket cache */
46508cfa56eSMark Johnston #define	UMA_RECLAIM_DRAIN_CPU	2	/* release bucket and per-CPU caches */
46608cfa56eSMark Johnston #define	UMA_RECLAIM_TRIM	3	/* trim bucket cache to WSS */
46708cfa56eSMark Johnston void uma_reclaim(int req);
46808cfa56eSMark Johnston void uma_zone_reclaim(uma_zone_t, int req);
4698355f576SJeff Roberson 
4708355f576SJeff Roberson /*
4711e319f6dSRobert Watson  * Sets the alignment mask to be used for all zones requesting cache
4721e319f6dSRobert Watson  * alignment.  Should be called by MD boot code prior to starting VM/UMA.
4731e319f6dSRobert Watson  *
4741e319f6dSRobert Watson  * Arguments:
4751e319f6dSRobert Watson  *	align The alignment mask
4761e319f6dSRobert Watson  *
4771e319f6dSRobert Watson  * Returns:
4781e319f6dSRobert Watson  *	Nothing
4791e319f6dSRobert Watson  */
4801e319f6dSRobert Watson void uma_set_align(int align);
4811e319f6dSRobert Watson 
4821e319f6dSRobert Watson /*
4836fd34d6fSJeff Roberson  * Set a reserved number of items to hold for M_USE_RESERVE allocations.  All
4846fd34d6fSJeff Roberson  * other requests must allocate new backing pages.
4856fd34d6fSJeff Roberson  */
4866fd34d6fSJeff Roberson void uma_zone_reserve(uma_zone_t zone, int nitems);
4876fd34d6fSJeff Roberson 
4886fd34d6fSJeff Roberson /*
489a4915c21SAttilio Rao  * Reserves the maximum KVA space required by the zone and configures the zone
490a4915c21SAttilio Rao  * to use a VM_ALLOC_NOOBJ-based backend allocator.
4918355f576SJeff Roberson  *
4928355f576SJeff Roberson  * Arguments:
4932db63c5eSGiorgos Keramidas  *	zone  The zone to update.
494a4915c21SAttilio Rao  *	nitems  The upper limit on the number of items that can be allocated.
4958355f576SJeff Roberson  *
4968355f576SJeff Roberson  * Returns:
497a4915c21SAttilio Rao  *	0  if KVA space can not be allocated
4988355f576SJeff Roberson  *	1  if successful
4998355f576SJeff Roberson  *
5008355f576SJeff Roberson  * Discussion:
501a4915c21SAttilio Rao  *	When the machine supports a direct map and the zone's items are smaller
502a4915c21SAttilio Rao  *	than a page, the zone will use the direct map instead of allocating KVA
503a4915c21SAttilio Rao  *	space.
5048355f576SJeff Roberson  */
505a4915c21SAttilio Rao int uma_zone_reserve_kva(uma_zone_t zone, int nitems);
5068355f576SJeff Roberson 
507736ee590SJeff Roberson /*
508736ee590SJeff Roberson  * Sets a high limit on the number of items allowed in a zone
509736ee590SJeff Roberson  *
510736ee590SJeff Roberson  * Arguments:
511736ee590SJeff Roberson  *	zone  The zone to limit
5121c6cae97SLawrence Stewart  *	nitems  The requested upper limit on the number of items allowed
513736ee590SJeff Roberson  *
514736ee590SJeff Roberson  * Returns:
515003cf08bSMark Johnston  *	int  The effective value of nitems
516736ee590SJeff Roberson  */
5171c6cae97SLawrence Stewart int uma_zone_set_max(uma_zone_t zone, int nitems);
5188355f576SJeff Roberson 
5198355f576SJeff Roberson /*
520bb15d1c7SGleb Smirnoff  * Sets a high limit on the number of items allowed in zone's bucket cache
521bb15d1c7SGleb Smirnoff  *
522bb15d1c7SGleb Smirnoff  * Arguments:
523bb15d1c7SGleb Smirnoff  *      zone  The zone to limit
524bb15d1c7SGleb Smirnoff  *      nitems  The requested upper limit on the number of items allowed
525bb15d1c7SGleb Smirnoff  */
526003cf08bSMark Johnston void uma_zone_set_maxcache(uma_zone_t zone, int nitems);
527bb15d1c7SGleb Smirnoff 
528bb15d1c7SGleb Smirnoff /*
529e49471b0SAndre Oppermann  * Obtains the effective limit on the number of items in a zone
530e49471b0SAndre Oppermann  *
531e49471b0SAndre Oppermann  * Arguments:
532e49471b0SAndre Oppermann  *	zone  The zone to obtain the effective limit from
533e49471b0SAndre Oppermann  *
534e49471b0SAndre Oppermann  * Return:
535e49471b0SAndre Oppermann  *	0  No limit
536e49471b0SAndre Oppermann  *	int  The effective limit of the zone
537e49471b0SAndre Oppermann  */
538e49471b0SAndre Oppermann int uma_zone_get_max(uma_zone_t zone);
539e49471b0SAndre Oppermann 
540e49471b0SAndre Oppermann /*
5412f891cd5SPawel Jakub Dawidek  * Sets a warning to be printed when limit is reached
5422f891cd5SPawel Jakub Dawidek  *
5432f891cd5SPawel Jakub Dawidek  * Arguments:
5442f891cd5SPawel Jakub Dawidek  *	zone  The zone we will warn about
5452f891cd5SPawel Jakub Dawidek  *	warning  Warning content
5462f891cd5SPawel Jakub Dawidek  *
5472f891cd5SPawel Jakub Dawidek  * Returns:
5482f891cd5SPawel Jakub Dawidek  *	Nothing
5492f891cd5SPawel Jakub Dawidek  */
5502f891cd5SPawel Jakub Dawidek void uma_zone_set_warning(uma_zone_t zone, const char *warning);
5512f891cd5SPawel Jakub Dawidek 
5522f891cd5SPawel Jakub Dawidek /*
55354503a13SJonathan T. Looney  * Sets a function to run when limit is reached
55454503a13SJonathan T. Looney  *
55554503a13SJonathan T. Looney  * Arguments:
55654503a13SJonathan T. Looney  *	zone  The zone to which this applies
55754503a13SJonathan T. Looney  *	fx  The function ro run
55854503a13SJonathan T. Looney  *
55954503a13SJonathan T. Looney  * Returns:
56054503a13SJonathan T. Looney  *	Nothing
56154503a13SJonathan T. Looney  */
562e60b2fcbSGleb Smirnoff typedef void (*uma_maxaction_t)(uma_zone_t, int);
56354503a13SJonathan T. Looney void uma_zone_set_maxaction(uma_zone_t zone, uma_maxaction_t);
56454503a13SJonathan T. Looney 
56554503a13SJonathan T. Looney /*
566c4ae7908SLawrence Stewart  * Obtains the approximate current number of items allocated from a zone
567c4ae7908SLawrence Stewart  *
568c4ae7908SLawrence Stewart  * Arguments:
569c4ae7908SLawrence Stewart  *	zone  The zone to obtain the current allocation count from
570c4ae7908SLawrence Stewart  *
571c4ae7908SLawrence Stewart  * Return:
572c4ae7908SLawrence Stewart  *	int  The approximate current number of items allocated from the zone
573c4ae7908SLawrence Stewart  */
574c4ae7908SLawrence Stewart int uma_zone_get_cur(uma_zone_t zone);
575c4ae7908SLawrence Stewart 
576c4ae7908SLawrence Stewart /*
577099a0e58SBosko Milekic  * The following two routines (uma_zone_set_init/fini)
578099a0e58SBosko Milekic  * are used to set the backend init/fini pair which acts on an
579099a0e58SBosko Milekic  * object as it becomes allocated and is placed in a slab within
580099a0e58SBosko Milekic  * the specified zone's backing keg.  These should probably not
5812db63c5eSGiorgos Keramidas  * be changed once allocations have already begun, but only be set
582099a0e58SBosko Milekic  * immediately upon zone creation.
583099a0e58SBosko Milekic  */
584099a0e58SBosko Milekic void uma_zone_set_init(uma_zone_t zone, uma_init uminit);
585099a0e58SBosko Milekic void uma_zone_set_fini(uma_zone_t zone, uma_fini fini);
586099a0e58SBosko Milekic 
587099a0e58SBosko Milekic /*
588099a0e58SBosko Milekic  * The following two routines (uma_zone_set_zinit/zfini) are
589099a0e58SBosko Milekic  * used to set the zinit/zfini pair which acts on an object as
590099a0e58SBosko Milekic  * it passes from the backing Keg's slab cache to the
591099a0e58SBosko Milekic  * specified Zone's bucket cache.  These should probably not
5922db63c5eSGiorgos Keramidas  * be changed once allocations have already begun, but only be set
5932db63c5eSGiorgos Keramidas  * immediately upon zone creation.
594099a0e58SBosko Milekic  */
595099a0e58SBosko Milekic void uma_zone_set_zinit(uma_zone_t zone, uma_init zinit);
596099a0e58SBosko Milekic void uma_zone_set_zfini(uma_zone_t zone, uma_fini zfini);
597099a0e58SBosko Milekic 
598099a0e58SBosko Milekic /*
599a4915c21SAttilio Rao  * Replaces the standard backend allocator for this zone.
6008355f576SJeff Roberson  *
6018355f576SJeff Roberson  * Arguments:
6022db63c5eSGiorgos Keramidas  *	zone   The zone whose backend allocator is being changed.
6038355f576SJeff Roberson  *	allocf A pointer to the allocation function
6048355f576SJeff Roberson  *
6058355f576SJeff Roberson  * Returns:
6068355f576SJeff Roberson  *	Nothing
6078355f576SJeff Roberson  *
6088355f576SJeff Roberson  * Discussion:
6098355f576SJeff Roberson  *	This could be used to implement pageable allocation, or perhaps
6108355f576SJeff Roberson  *	even DMA allocators if used in conjunction with the OFFPAGE
6118355f576SJeff Roberson  *	zone flag.
6128355f576SJeff Roberson  */
6138355f576SJeff Roberson 
6148355f576SJeff Roberson void uma_zone_set_allocf(uma_zone_t zone, uma_alloc allocf);
6158355f576SJeff Roberson 
6168355f576SJeff Roberson /*
6178355f576SJeff Roberson  * Used for freeing memory provided by the allocf above
6188355f576SJeff Roberson  *
6198355f576SJeff Roberson  * Arguments:
6208355f576SJeff Roberson  *	zone  The zone that intends to use this free routine.
6218355f576SJeff Roberson  *	freef The page freeing routine.
6228355f576SJeff Roberson  *
6238355f576SJeff Roberson  * Returns:
6248355f576SJeff Roberson  *	Nothing
6258355f576SJeff Roberson  */
6268355f576SJeff Roberson 
6278355f576SJeff Roberson void uma_zone_set_freef(uma_zone_t zone, uma_free freef);
6288355f576SJeff Roberson 
6298355f576SJeff Roberson /*
630d4665eaaSJeff Roberson  * Associate a zone with a smr context that is allocated after creation
631d4665eaaSJeff Roberson  * so that multiple zones may share the same context.
632d4665eaaSJeff Roberson  */
633d4665eaaSJeff Roberson void uma_zone_set_smr(uma_zone_t zone, smr_t smr);
634d4665eaaSJeff Roberson 
635d4665eaaSJeff Roberson /*
636d4665eaaSJeff Roberson  * Fetch the smr context that was set or made in uma_zcreate().
637d4665eaaSJeff Roberson  */
638d4665eaaSJeff Roberson smr_t uma_zone_get_smr(uma_zone_t zone);
639d4665eaaSJeff Roberson 
640d4665eaaSJeff Roberson /*
6412db63c5eSGiorgos Keramidas  * These flags are setable in the allocf and visible in the freef.
6428355f576SJeff Roberson  */
6438355f576SJeff Roberson #define UMA_SLAB_BOOT	0x01		/* Slab alloced from boot pages */
64449bfa624SAlan Cox #define UMA_SLAB_KERNEL	0x04		/* Slab alloced from kmem */
6458355f576SJeff Roberson #define UMA_SLAB_PRIV	0x08		/* Slab alloced from priv allocator */
646ec0d8280SRyan Libby /* 0x02, 0x10, 0x40, and 0x80 are available */
6478355f576SJeff Roberson 
6488355f576SJeff Roberson /*
6498355f576SJeff Roberson  * Used to pre-fill a zone with some number of items
6508355f576SJeff Roberson  *
6518355f576SJeff Roberson  * Arguments:
6528355f576SJeff Roberson  *	zone    The zone to fill
6538355f576SJeff Roberson  *	itemcnt The number of items to reserve
6548355f576SJeff Roberson  *
6558355f576SJeff Roberson  * Returns:
6568355f576SJeff Roberson  *	Nothing
6578355f576SJeff Roberson  *
6588355f576SJeff Roberson  * NOTE: This is blocking and should only be done at startup
6598355f576SJeff Roberson  */
6608355f576SJeff Roberson void uma_prealloc(uma_zone_t zone, int itemcnt);
6618355f576SJeff Roberson 
662099a0e58SBosko Milekic /*
663663b416fSJohn Baldwin  * Used to determine if a fixed-size zone is exhausted.
664663b416fSJohn Baldwin  *
665663b416fSJohn Baldwin  * Arguments:
666663b416fSJohn Baldwin  *	zone    The zone to check
667663b416fSJohn Baldwin  *
668663b416fSJohn Baldwin  * Returns:
669663b416fSJohn Baldwin  *	Non-zero if zone is exhausted.
670663b416fSJohn Baldwin  */
671663b416fSJohn Baldwin int uma_zone_exhausted(uma_zone_t zone);
672663b416fSJohn Baldwin 
673663b416fSJohn Baldwin /*
674ed581bf6SJeff Roberson  * Returns the bytes of memory consumed by the zone.
675ed581bf6SJeff Roberson  */
676ed581bf6SJeff Roberson size_t uma_zone_memory(uma_zone_t zone);
677ed581bf6SJeff Roberson 
678ed581bf6SJeff Roberson /*
67949fef6a2SGleb Smirnoff  * Common UMA_ZONE_PCPU zones.
68049fef6a2SGleb Smirnoff  */
681a8c8e44bSMateusz Guzik extern uma_zone_t pcpu_zone_int;
68249fef6a2SGleb Smirnoff extern uma_zone_t pcpu_zone_64;
68349fef6a2SGleb Smirnoff 
68449fef6a2SGleb Smirnoff /*
6857a52a97eSRobert Watson  * Exported statistics structures to be used by user space monitoring tools.
6862db63c5eSGiorgos Keramidas  * Statistics stream consists of a uma_stream_header, followed by a series of
6872db63c5eSGiorgos Keramidas  * alternative uma_type_header and uma_type_stat structures.
6887a52a97eSRobert Watson  */
6897a52a97eSRobert Watson #define	UMA_STREAM_VERSION	0x00000001
6907a52a97eSRobert Watson struct uma_stream_header {
69185dcf349SGleb Smirnoff 	uint32_t	ush_version;	/* Stream format version. */
69285dcf349SGleb Smirnoff 	uint32_t	ush_maxcpus;	/* Value of MAXCPU for stream. */
69385dcf349SGleb Smirnoff 	uint32_t	ush_count;	/* Number of records. */
69485dcf349SGleb Smirnoff 	uint32_t	_ush_pad;	/* Pad/reserved field. */
6957a52a97eSRobert Watson };
6967a52a97eSRobert Watson 
697cbbb4a00SRobert Watson #define	UTH_MAX_NAME	32
698cbbb4a00SRobert Watson #define	UTH_ZONE_SECONDARY	0x00000001
6997a52a97eSRobert Watson struct uma_type_header {
7007a52a97eSRobert Watson 	/*
7017a52a97eSRobert Watson 	 * Static per-zone data, some extracted from the supporting keg.
7027a52a97eSRobert Watson 	 */
703cbbb4a00SRobert Watson 	char		uth_name[UTH_MAX_NAME];
70485dcf349SGleb Smirnoff 	uint32_t	uth_align;	/* Keg: alignment. */
70585dcf349SGleb Smirnoff 	uint32_t	uth_size;	/* Keg: requested size of item. */
70685dcf349SGleb Smirnoff 	uint32_t	uth_rsize;	/* Keg: real size of item. */
70785dcf349SGleb Smirnoff 	uint32_t	uth_maxpages;	/* Keg: maximum number of pages. */
70885dcf349SGleb Smirnoff 	uint32_t	uth_limit;	/* Keg: max items to allocate. */
7097a52a97eSRobert Watson 
7107a52a97eSRobert Watson 	/*
7117a52a97eSRobert Watson 	 * Current dynamic zone/keg-derived statistics.
7127a52a97eSRobert Watson 	 */
71385dcf349SGleb Smirnoff 	uint32_t	uth_pages;	/* Keg: pages allocated. */
71485dcf349SGleb Smirnoff 	uint32_t	uth_keg_free;	/* Keg: items free. */
71585dcf349SGleb Smirnoff 	uint32_t	uth_zone_free;	/* Zone: items free. */
71685dcf349SGleb Smirnoff 	uint32_t	uth_bucketsize;	/* Zone: desired bucket size. */
71785dcf349SGleb Smirnoff 	uint32_t	uth_zone_flags;	/* Zone: flags. */
71885dcf349SGleb Smirnoff 	uint64_t	uth_allocs;	/* Zone: number of allocations. */
71985dcf349SGleb Smirnoff 	uint64_t	uth_frees;	/* Zone: number of frees. */
72085dcf349SGleb Smirnoff 	uint64_t	uth_fails;	/* Zone: number of alloc failures. */
72185dcf349SGleb Smirnoff 	uint64_t	uth_sleeps;	/* Zone: number of alloc sleeps. */
722c1685086SJeff Roberson 	uint64_t	uth_xdomain;	/* Zone: Number of cross domain frees. */
723c1685086SJeff Roberson 	uint64_t	_uth_reserved1[1];	/* Reserved. */
7247a52a97eSRobert Watson };
7257a52a97eSRobert Watson 
7267a52a97eSRobert Watson struct uma_percpu_stat {
72785dcf349SGleb Smirnoff 	uint64_t	ups_allocs;	/* Cache: number of allocations. */
72885dcf349SGleb Smirnoff 	uint64_t	ups_frees;	/* Cache: number of frees. */
72985dcf349SGleb Smirnoff 	uint64_t	ups_cache_free;	/* Cache: free items in cache. */
73085dcf349SGleb Smirnoff 	uint64_t	_ups_reserved[5];	/* Reserved. */
7317a52a97eSRobert Watson };
7327a52a97eSRobert Watson 
73344ec2b63SKonstantin Belousov void uma_reclaim_wakeup(void);
73444ec2b63SKonstantin Belousov void uma_reclaim_worker(void *);
73544ec2b63SKonstantin Belousov 
736ad5b0f5bSJeff Roberson unsigned long uma_limit(void);
737ad5b0f5bSJeff Roberson 
738ad5b0f5bSJeff Roberson /* Return the amount of memory managed by UMA. */
739ad5b0f5bSJeff Roberson unsigned long uma_size(void);
740ad5b0f5bSJeff Roberson 
741ad5b0f5bSJeff Roberson /* Return the amount of memory remaining.  May be negative. */
742ad5b0f5bSJeff Roberson long uma_avail(void);
743ad5b0f5bSJeff Roberson 
744f947570eSGleb Smirnoff #endif	/* _VM_UMA_H_ */
745