xref: /freebsd/sys/vm/uma.h (revision 54c5ae804ff56bcf3307c9c285f245468b5b799b)
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_* */
438355f576SJeff Roberson 
442db63c5eSGiorgos Keramidas /* User visible parameters */
458355f576SJeff Roberson #define UMA_SMALLEST_UNIT       (PAGE_SIZE / 256) /* Smallest item allocated */
468355f576SJeff Roberson 
478355f576SJeff Roberson /* Types and type defs */
488355f576SJeff Roberson 
498355f576SJeff Roberson struct uma_zone;
508355f576SJeff Roberson /* Opaque type used as a handle to the zone */
518355f576SJeff Roberson typedef struct uma_zone * uma_zone_t;
528355f576SJeff Roberson 
538355f576SJeff Roberson /*
548355f576SJeff Roberson  * Item constructor
558355f576SJeff Roberson  *
568355f576SJeff Roberson  * Arguments:
578355f576SJeff Roberson  *	item  A pointer to the memory which has been allocated.
588355f576SJeff Roberson  *	arg   The arg field passed to uma_zalloc_arg
598355f576SJeff Roberson  *	size  The size of the allocated item
60b23f72e9SBrian Feldman  *	flags See zalloc flags
618355f576SJeff Roberson  *
628355f576SJeff Roberson  * Returns:
63b23f72e9SBrian Feldman  *	0      on success
64b23f72e9SBrian Feldman  *      errno  on failure
658355f576SJeff Roberson  *
668355f576SJeff Roberson  * Discussion:
678355f576SJeff Roberson  *	The constructor is called just before the memory is returned
6829b4d526SSheldon Hearn  *	to the user. It may block if necessary.
698355f576SJeff Roberson  */
70b23f72e9SBrian Feldman typedef int (*uma_ctor)(void *mem, int size, void *arg, int flags);
718355f576SJeff Roberson 
728355f576SJeff Roberson /*
738355f576SJeff Roberson  * Item destructor
748355f576SJeff Roberson  *
758355f576SJeff Roberson  * Arguments:
768355f576SJeff Roberson  *	item  A pointer to the memory which has been allocated.
778355f576SJeff Roberson  *	size  The size of the item being destructed.
788355f576SJeff Roberson  *	arg   Argument passed through uma_zfree_arg
798355f576SJeff Roberson  *
808355f576SJeff Roberson  * Returns:
818355f576SJeff Roberson  *	Nothing
828355f576SJeff Roberson  *
838355f576SJeff Roberson  * Discussion:
848355f576SJeff Roberson  *	The destructor may perform operations that differ from those performed
858355f576SJeff Roberson  *	by the initializer, but it must leave the object in the same state.
868355f576SJeff Roberson  *	This IS type stable storage.  This is called after EVERY zfree call.
878355f576SJeff Roberson  */
888355f576SJeff Roberson typedef void (*uma_dtor)(void *mem, int size, void *arg);
898355f576SJeff Roberson 
908355f576SJeff Roberson /*
918355f576SJeff Roberson  * Item initializer
928355f576SJeff Roberson  *
938355f576SJeff Roberson  * Arguments:
948355f576SJeff Roberson  *	item  A pointer to the memory which has been allocated.
958355f576SJeff Roberson  *	size  The size of the item being initialized.
96b23f72e9SBrian Feldman  *	flags See zalloc flags
978355f576SJeff Roberson  *
988355f576SJeff Roberson  * Returns:
99b23f72e9SBrian Feldman  *	0      on success
100b23f72e9SBrian Feldman  *      errno  on failure
1018355f576SJeff Roberson  *
1028355f576SJeff Roberson  * Discussion:
1038355f576SJeff Roberson  *	The initializer is called when the memory is cached in the uma zone.
1042db63c5eSGiorgos Keramidas  *	The initializer and the destructor should leave the object in the same
1052db63c5eSGiorgos Keramidas  *	state.
1068355f576SJeff Roberson  */
107b23f72e9SBrian Feldman typedef int (*uma_init)(void *mem, int size, int flags);
1088355f576SJeff Roberson 
1098355f576SJeff Roberson /*
1108355f576SJeff Roberson  * Item discard function
1118355f576SJeff Roberson  *
1128355f576SJeff Roberson  * Arguments:
1138355f576SJeff Roberson  *	item  A pointer to memory which has been 'freed' but has not left the
1148355f576SJeff Roberson  *	      zone's cache.
1158355f576SJeff Roberson  *	size  The size of the item being discarded.
1168355f576SJeff Roberson  *
1178355f576SJeff Roberson  * Returns:
1188355f576SJeff Roberson  *	Nothing
1198355f576SJeff Roberson  *
1208355f576SJeff Roberson  * Discussion:
1218355f576SJeff Roberson  *	This routine is called when memory leaves a zone and is returned to the
1222db63c5eSGiorgos Keramidas  *	system for other uses.  It is the counter-part to the init function.
1238355f576SJeff Roberson  */
1248355f576SJeff Roberson typedef void (*uma_fini)(void *mem, int size);
1258355f576SJeff Roberson 
1268355f576SJeff Roberson /*
1270095a784SJeff Roberson  * Import new memory into a cache zone.
1280095a784SJeff Roberson  */
129ab3185d1SJeff Roberson typedef int (*uma_import)(void *arg, void **store, int count, int domain,
130ab3185d1SJeff Roberson     int flags);
1310095a784SJeff Roberson 
1320095a784SJeff Roberson /*
1330095a784SJeff Roberson  * Free memory from a cache zone.
1340095a784SJeff Roberson  */
1350095a784SJeff Roberson typedef void (*uma_release)(void *arg, void **store, int count);
1360095a784SJeff Roberson 
1370095a784SJeff Roberson /*
1388355f576SJeff Roberson  * What's the difference between initializing and constructing?
1398355f576SJeff Roberson  *
1408355f576SJeff Roberson  * The item is initialized when it is cached, and this is the state that the
1418355f576SJeff Roberson  * object should be in when returned to the allocator. The purpose of this is
1428355f576SJeff Roberson  * to remove some code which would otherwise be called on each allocation by
1438355f576SJeff Roberson  * utilizing a known, stable state.  This differs from the constructor which
1448355f576SJeff Roberson  * will be called on EVERY allocation.
1458355f576SJeff Roberson  *
1462db63c5eSGiorgos Keramidas  * For example, in the initializer you may want to initialize embedded locks,
1478355f576SJeff Roberson  * NULL list pointers, set up initial states, magic numbers, etc.  This way if
14829b4d526SSheldon Hearn  * the object is held in the allocator and re-used it won't be necessary to
1498355f576SJeff Roberson  * re-initialize it.
1508355f576SJeff Roberson  *
1518355f576SJeff Roberson  * The constructor may be used to lock a data structure, link it on to lists,
1528355f576SJeff Roberson  * bump reference counts or total counts of outstanding structures, etc.
1538355f576SJeff Roberson  *
1548355f576SJeff Roberson  */
1558355f576SJeff Roberson 
1568355f576SJeff Roberson 
1578355f576SJeff Roberson /* Function proto types */
1588355f576SJeff Roberson 
1598355f576SJeff Roberson /*
1608355f576SJeff Roberson  * Create a new uma zone
1618355f576SJeff Roberson  *
1628355f576SJeff Roberson  * Arguments:
1632db63c5eSGiorgos Keramidas  *	name  The text name of the zone for debugging and stats. This memory
1648355f576SJeff Roberson  *		should not be freed until the zone has been deallocated.
1658355f576SJeff Roberson  *	size  The size of the object that is being created.
1662db63c5eSGiorgos Keramidas  *	ctor  The constructor that is called when the object is allocated.
1678355f576SJeff Roberson  *	dtor  The destructor that is called when the object is freed.
1688355f576SJeff Roberson  *	init  An initializer that sets up the initial state of the memory.
1698355f576SJeff Roberson  *	fini  A discard function that undoes initialization done by init.
1708355f576SJeff Roberson  *		ctor/dtor/init/fini may all be null, see notes above.
1712db63c5eSGiorgos Keramidas  *	align A bitmask that corresponds to the requested alignment
1728355f576SJeff Roberson  *		eg 4 would be 0x3
1732db63c5eSGiorgos Keramidas  *	flags A set of parameters that control the behavior of the zone.
1748355f576SJeff Roberson  *
1758355f576SJeff Roberson  * Returns:
1768355f576SJeff Roberson  *	A pointer to a structure which is intended to be opaque to users of
1778355f576SJeff Roberson  *	the interface.  The value may be null if the wait flag is not set.
1788355f576SJeff Roberson  */
179bb196eb4SMatthew D Fleming uma_zone_t uma_zcreate(const char *name, size_t size, uma_ctor ctor,
180bb196eb4SMatthew D Fleming 		    uma_dtor dtor, uma_init uminit, uma_fini fini,
18185dcf349SGleb Smirnoff 		    int align, uint32_t flags);
1828355f576SJeff Roberson 
183b60f5b79SJeff Roberson /*
184099a0e58SBosko Milekic  * Create a secondary uma zone
185099a0e58SBosko Milekic  *
186099a0e58SBosko Milekic  * Arguments:
1872db63c5eSGiorgos Keramidas  *	name  The text name of the zone for debugging and stats. This memory
188099a0e58SBosko Milekic  *		should not be freed until the zone has been deallocated.
1892db63c5eSGiorgos Keramidas  *	ctor  The constructor that is called when the object is allocated.
190099a0e58SBosko Milekic  *	dtor  The destructor that is called when the object is freed.
191099a0e58SBosko Milekic  *	zinit  An initializer that sets up the initial state of the memory
192099a0e58SBosko Milekic  *		as the object passes from the Keg's slab to the Zone's cache.
193099a0e58SBosko Milekic  *	zfini  A discard function that undoes initialization done by init
194099a0e58SBosko Milekic  *		as the object passes from the Zone's cache to the Keg's slab.
195099a0e58SBosko Milekic  *
196099a0e58SBosko Milekic  *		ctor/dtor/zinit/zfini may all be null, see notes above.
197099a0e58SBosko Milekic  *		Note that the zinit and zfini specified here are NOT
198099a0e58SBosko Milekic  *		exactly the same as the init/fini specified to uma_zcreate()
199099a0e58SBosko Milekic  *		when creating a master zone.  These zinit/zfini are called
200099a0e58SBosko Milekic  *		on the TRANSITION from keg to zone (and vice-versa). Once
201099a0e58SBosko Milekic  *		these are set, the primary zone may alter its init/fini
202099a0e58SBosko Milekic  *		(which are called when the object passes from VM to keg)
203099a0e58SBosko Milekic  *		using uma_zone_set_init/fini()) as well as its own
204099a0e58SBosko Milekic  *		zinit/zfini (unset by default for master zone) with
205099a0e58SBosko Milekic  *		uma_zone_set_zinit/zfini() (note subtle 'z' prefix).
206099a0e58SBosko Milekic  *
207b83e441bSBosko Milekic  *	master  A reference to this zone's Master Zone (Primary Zone),
208b83e441bSBosko Milekic  *		which contains the backing Keg for the Secondary Zone
209b83e441bSBosko Milekic  *		being added.
210099a0e58SBosko Milekic  *
211099a0e58SBosko Milekic  * Returns:
212099a0e58SBosko Milekic  *	A pointer to a structure which is intended to be opaque to users of
213099a0e58SBosko Milekic  *	the interface.  The value may be null if the wait flag is not set.
214099a0e58SBosko Milekic  */
215099a0e58SBosko Milekic uma_zone_t uma_zsecond_create(char *name, uma_ctor ctor, uma_dtor dtor,
216099a0e58SBosko Milekic 		    uma_init zinit, uma_fini zfini, uma_zone_t master);
217099a0e58SBosko Milekic 
218099a0e58SBosko Milekic /*
2190095a784SJeff Roberson  * Create cache-only zones.
2200095a784SJeff Roberson  *
2210095a784SJeff Roberson  * This allows uma's per-cpu cache facilities to handle arbitrary
2220095a784SJeff Roberson  * pointers.  Consumers must specify the import and release functions to
2230095a784SJeff Roberson  * fill and destroy caches.  UMA does not allocate any memory for these
2240095a784SJeff Roberson  * zones.  The 'arg' parameter is passed to import/release and is caller
2250095a784SJeff Roberson  * specific.
2260095a784SJeff Roberson  */
227af526374SJeff Roberson uma_zone_t uma_zcache_create(char *name, int size, uma_ctor ctor, uma_dtor dtor,
2280095a784SJeff Roberson 		    uma_init zinit, uma_fini zfini, uma_import zimport,
2290095a784SJeff Roberson 		    uma_release zrelease, void *arg, int flags);
2300095a784SJeff Roberson 
2310095a784SJeff Roberson /*
232b60f5b79SJeff Roberson  * Definitions for uma_zcreate flags
233b60f5b79SJeff Roberson  *
234b60f5b79SJeff Roberson  * These flags share space with UMA_ZFLAGs in uma_int.h.  Be careful not to
235*54c5ae80SRyan Libby  * overlap when adding new features.
236b60f5b79SJeff Roberson  */
2378355f576SJeff Roberson #define UMA_ZONE_ZINIT		0x0002	/* Initialize with zeros */
238*54c5ae80SRyan Libby #define UMA_ZONE_NOTOUCH	0x0008	/* UMA may not access the memory */
2398355f576SJeff Roberson #define UMA_ZONE_MALLOC		0x0010	/* For use by malloc(9) only! */
2408355f576SJeff Roberson #define UMA_ZONE_NOFREE		0x0020	/* Do not free slabs of this type! */
24128bc4419SJeff Roberson #define UMA_ZONE_MTXCLASS	0x0040	/* Create a new lock class */
24299571dc3SJeff Roberson #define	UMA_ZONE_VM		0x0080	/*
24399571dc3SJeff Roberson 					 * Used for internal vm datastructures
24499571dc3SJeff Roberson 					 * only.
24599571dc3SJeff Roberson 					 */
246*54c5ae80SRyan Libby #define	UMA_ZONE_NOTPAGE	0x0100	/* allocf memory not vm pages */
247099a0e58SBosko Milekic #define	UMA_ZONE_SECONDARY	0x0200	/* Zone is a Secondary Zone */
2487e28037aSMark Johnston #define	UMA_ZONE_NOBUCKET	0x0400	/* Do not use buckets. */
2497e28037aSMark Johnston #define	UMA_ZONE_MAXBUCKET	0x0800	/* Use largest buckets. */
250*54c5ae80SRyan Libby #define	UMA_ZONE_MINBUCKET	0x1000	/* Use smallest buckets. */
251*54c5ae80SRyan Libby #define	UMA_ZONE_CACHESPREAD	0x2000	/*
252e20a199fSJeff Roberson 					 * Spread memory start locations across
253e20a199fSJeff Roberson 					 * all possible cache lines.  May
254e20a199fSJeff Roberson 					 * require many virtually contiguous
255e20a199fSJeff Roberson 					 * backend pages and can fail early.
256e20a199fSJeff Roberson 					 */
257263811f7SKip Macy #define	UMA_ZONE_NODUMP		0x4000	/*
258263811f7SKip Macy 					 * Zone's pages will not be included in
259263811f7SKip Macy 					 * mini-dumps.
260263811f7SKip Macy 					 */
261ad97af7eSGleb Smirnoff #define	UMA_ZONE_PCPU		0x8000	/*
262ab3059a8SMatt Macy 					 * Allocates mp_maxid + 1 slabs of PAGE_SIZE
263ad97af7eSGleb Smirnoff 					 */
264*54c5ae80SRyan Libby #define	UMA_ZONE_FIRSTTOUCH	0x10000	/* First touch NUMA policy */
265*54c5ae80SRyan Libby #define	UMA_ZONE_ROUNDROBIN	0x20000	/* Round-robin NUMA policy. */
266*54c5ae80SRyan Libby /* In use by UMA_ZFLAGs:	0xffe00000 */
267e20a199fSJeff Roberson 
268e20a199fSJeff Roberson /*
269e20a199fSJeff Roberson  * These flags are shared between the keg and zone.  In zones wishing to add
270e20a199fSJeff Roberson  * new kegs these flags must be compatible.  Some are determined based on
271e20a199fSJeff Roberson  * physical parameters of the request and may not be provided by the consumer.
272e20a199fSJeff Roberson  */
273e20a199fSJeff Roberson #define	UMA_ZONE_INHERIT						\
274*54c5ae80SRyan Libby     (UMA_ZONE_NOTOUCH | UMA_ZONE_MALLOC | UMA_ZONE_NOFREE |		\
275*54c5ae80SRyan Libby      UMA_ZONE_NOTPAGE | UMA_ZONE_PCPU | UMA_ZONE_FIRSTTOUCH |		\
276*54c5ae80SRyan Libby      UMA_ZONE_ROUNDROBIN)
2778355f576SJeff Roberson 
2788355f576SJeff Roberson /* Definitions for align */
2798355f576SJeff Roberson #define UMA_ALIGN_PTR	(sizeof(void *) - 1)	/* Alignment fit for ptr */
2808355f576SJeff Roberson #define UMA_ALIGN_LONG	(sizeof(long) - 1)	/* "" long */
2818355f576SJeff Roberson #define UMA_ALIGN_INT	(sizeof(int) - 1)	/* "" int */
2828355f576SJeff Roberson #define UMA_ALIGN_SHORT	(sizeof(short) - 1)	/* "" short */
2838355f576SJeff Roberson #define UMA_ALIGN_CHAR	(sizeof(char) - 1)	/* "" char */
2841e319f6dSRobert Watson #define UMA_ALIGN_CACHE	(0 - 1)			/* Cache line size align */
28514c510c0SJohn Baldwin #define	UMA_ALIGNOF(type) (_Alignof(type) - 1)	/* Alignment fit for 'type' */
2868355f576SJeff Roberson 
287b48d4efeSMark Johnston #define	UMA_ANYDOMAIN	-1	/* Special value for domain search. */
288b48d4efeSMark Johnston 
2898355f576SJeff Roberson /*
2909c2cd7e5SJeff Roberson  * Destroys an empty uma zone.  If the zone is not empty uma complains loudly.
2918355f576SJeff Roberson  *
2928355f576SJeff Roberson  * Arguments:
2938355f576SJeff Roberson  *	zone  The zone we want to destroy.
2948355f576SJeff Roberson  *
2958355f576SJeff Roberson  */
2969c2cd7e5SJeff Roberson void uma_zdestroy(uma_zone_t zone);
2978355f576SJeff Roberson 
2988355f576SJeff Roberson /*
2998355f576SJeff Roberson  * Allocates an item out of a zone
3008355f576SJeff Roberson  *
3018355f576SJeff Roberson  * Arguments:
3028355f576SJeff Roberson  *	zone  The zone we are allocating from
3038355f576SJeff Roberson  *	arg   This data is passed to the ctor function
3042cc35ff9SJeff Roberson  *	flags See sys/malloc.h for available flags.
3058355f576SJeff Roberson  *
3068355f576SJeff Roberson  * Returns:
3072db63c5eSGiorgos Keramidas  *	A non-null pointer to an initialized element from the zone is
3082db63c5eSGiorgos Keramidas  *	guaranteed if the wait flag is M_WAITOK.  Otherwise a null pointer
3092db63c5eSGiorgos Keramidas  *	may be returned if the zone is empty or the ctor failed.
3108355f576SJeff Roberson  */
3118355f576SJeff Roberson 
3122cc35ff9SJeff Roberson void *uma_zalloc_arg(uma_zone_t zone, void *arg, int flags);
3134e180881SMateusz Guzik void *uma_zalloc_pcpu_arg(uma_zone_t zone, void *arg, int flags);
3148355f576SJeff Roberson 
3158355f576SJeff Roberson /*
316ab3185d1SJeff Roberson  * Allocate an item from a specific NUMA domain.  This uses a slow path in
317ab3185d1SJeff Roberson  * the allocator but is guaranteed to allocate memory from the requested
318ab3185d1SJeff Roberson  * domain if M_WAITOK is set.
319ab3185d1SJeff Roberson  *
320ab3185d1SJeff Roberson  * Arguments:
321ab3185d1SJeff Roberson  *	zone  The zone we are allocating from
322ab3185d1SJeff Roberson  *	arg   This data is passed to the ctor function
323ab3185d1SJeff Roberson  *	domain The domain to allocate from.
324ab3185d1SJeff Roberson  *	flags See sys/malloc.h for available flags.
325ab3185d1SJeff Roberson  */
326ab3185d1SJeff Roberson void *uma_zalloc_domain(uma_zone_t zone, void *arg, int domain, int flags);
327ab3185d1SJeff Roberson 
328ab3185d1SJeff Roberson /*
3298355f576SJeff Roberson  * Allocates an item out of a zone without supplying an argument
3308355f576SJeff Roberson  *
3318355f576SJeff Roberson  * This is just a wrapper for uma_zalloc_arg for convenience.
3328355f576SJeff Roberson  *
3338355f576SJeff Roberson  */
3342cc35ff9SJeff Roberson static __inline void *uma_zalloc(uma_zone_t zone, int flags);
3354e180881SMateusz Guzik static __inline void *uma_zalloc_pcpu(uma_zone_t zone, int flags);
3368355f576SJeff Roberson 
3378355f576SJeff Roberson static __inline void *
3382cc35ff9SJeff Roberson uma_zalloc(uma_zone_t zone, int flags)
3398355f576SJeff Roberson {
3402cc35ff9SJeff Roberson 	return uma_zalloc_arg(zone, NULL, flags);
3418355f576SJeff Roberson }
3428355f576SJeff Roberson 
3434e180881SMateusz Guzik static __inline void *
3444e180881SMateusz Guzik uma_zalloc_pcpu(uma_zone_t zone, int flags)
3454e180881SMateusz Guzik {
3464e180881SMateusz Guzik 	return uma_zalloc_pcpu_arg(zone, NULL, flags);
3474e180881SMateusz Guzik }
3484e180881SMateusz Guzik 
3498355f576SJeff Roberson /*
3508355f576SJeff Roberson  * Frees an item back into the specified zone.
3518355f576SJeff Roberson  *
3528355f576SJeff Roberson  * Arguments:
3538355f576SJeff Roberson  *	zone  The zone the item was originally allocated out of.
3548355f576SJeff Roberson  *	item  The memory to be freed.
3558355f576SJeff Roberson  *	arg   Argument passed to the destructor
3568355f576SJeff Roberson  *
3578355f576SJeff Roberson  * Returns:
3588355f576SJeff Roberson  *	Nothing.
3598355f576SJeff Roberson  */
3608355f576SJeff Roberson 
3618355f576SJeff Roberson void uma_zfree_arg(uma_zone_t zone, void *item, void *arg);
3624e180881SMateusz Guzik void uma_zfree_pcpu_arg(uma_zone_t zone, void *item, void *arg);
3638355f576SJeff Roberson 
3648355f576SJeff Roberson /*
365ab3185d1SJeff Roberson  * Frees an item back to the specified zone's domain specific pool.
366ab3185d1SJeff Roberson  *
367ab3185d1SJeff Roberson  * Arguments:
368ab3185d1SJeff Roberson  *	zone  The zone the item was originally allocated out of.
369ab3185d1SJeff Roberson  *	item  The memory to be freed.
370ab3185d1SJeff Roberson  *	arg   Argument passed to the destructor
371ab3185d1SJeff Roberson  */
372ab3185d1SJeff Roberson void uma_zfree_domain(uma_zone_t zone, void *item, void *arg);
373ab3185d1SJeff Roberson 
374ab3185d1SJeff Roberson /*
3758355f576SJeff Roberson  * Frees an item back to a zone without supplying an argument
3768355f576SJeff Roberson  *
3778355f576SJeff Roberson  * This is just a wrapper for uma_zfree_arg for convenience.
3788355f576SJeff Roberson  *
3798355f576SJeff Roberson  */
3808355f576SJeff Roberson static __inline void uma_zfree(uma_zone_t zone, void *item);
3814e180881SMateusz Guzik static __inline void uma_zfree_pcpu(uma_zone_t zone, void *item);
3828355f576SJeff Roberson 
3838355f576SJeff Roberson static __inline void
3848355f576SJeff Roberson uma_zfree(uma_zone_t zone, void *item)
3858355f576SJeff Roberson {
386f6e34b82SMark Murray 	uma_zfree_arg(zone, item, NULL);
3878355f576SJeff Roberson }
3888355f576SJeff Roberson 
3894e180881SMateusz Guzik static __inline void
3904e180881SMateusz Guzik uma_zfree_pcpu(uma_zone_t zone, void *item)
3914e180881SMateusz Guzik {
3924e180881SMateusz Guzik 	uma_zfree_pcpu_arg(zone, item, NULL);
3934e180881SMateusz Guzik }
3944e180881SMateusz Guzik 
3958355f576SJeff Roberson /*
3968d6fbbb8SJeff Roberson  * Wait until the specified zone can allocate an item.
3978d6fbbb8SJeff Roberson  */
3988d6fbbb8SJeff Roberson void uma_zwait(uma_zone_t zone);
3998d6fbbb8SJeff Roberson 
4008d6fbbb8SJeff Roberson /*
4018355f576SJeff Roberson  * Backend page supplier routines
4028355f576SJeff Roberson  *
4038355f576SJeff Roberson  * Arguments:
4042db63c5eSGiorgos Keramidas  *	zone  The zone that is requesting pages.
4052db63c5eSGiorgos Keramidas  *	size  The number of bytes being requested.
4068355f576SJeff Roberson  *	pflag Flags for these memory pages, see below.
407ab3185d1SJeff Roberson  *	domain The NUMA domain that we prefer for this allocation.
4088355f576SJeff Roberson  *	wait  Indicates our willingness to block.
4098355f576SJeff Roberson  *
4108355f576SJeff Roberson  * Returns:
4112db63c5eSGiorgos Keramidas  *	A pointer to the allocated memory or NULL on failure.
4128355f576SJeff Roberson  */
4138355f576SJeff Roberson 
414ab3185d1SJeff Roberson typedef void *(*uma_alloc)(uma_zone_t zone, vm_size_t size, int domain,
415ab3185d1SJeff Roberson     uint8_t *pflag, int wait);
4168355f576SJeff Roberson 
4178355f576SJeff Roberson /*
4188355f576SJeff Roberson  * Backend page free routines
4198355f576SJeff Roberson  *
4208355f576SJeff Roberson  * Arguments:
4212db63c5eSGiorgos Keramidas  *	item  A pointer to the previously allocated pages.
4222db63c5eSGiorgos Keramidas  *	size  The original size of the allocation.
4232db63c5eSGiorgos Keramidas  *	pflag The flags for the slab.  See UMA_SLAB_* below.
4248355f576SJeff Roberson  *
4258355f576SJeff Roberson  * Returns:
4268355f576SJeff Roberson  *	None
4278355f576SJeff Roberson  */
428f2c2231eSRyan Stone typedef void (*uma_free)(void *item, vm_size_t size, uint8_t pflag);
4298355f576SJeff Roberson 
4308355f576SJeff Roberson /*
43108cfa56eSMark Johnston  * Reclaims unused memory
4328355f576SJeff Roberson  *
4338355f576SJeff Roberson  * Arguments:
43408cfa56eSMark Johnston  *	req  Reclamation request type.
4358355f576SJeff Roberson  * Returns:
4368355f576SJeff Roberson  *	None
4378355f576SJeff Roberson  */
43808cfa56eSMark Johnston #define	UMA_RECLAIM_DRAIN	1	/* release bucket cache */
43908cfa56eSMark Johnston #define	UMA_RECLAIM_DRAIN_CPU	2	/* release bucket and per-CPU caches */
44008cfa56eSMark Johnston #define	UMA_RECLAIM_TRIM	3	/* trim bucket cache to WSS */
44108cfa56eSMark Johnston void uma_reclaim(int req);
44208cfa56eSMark Johnston void uma_zone_reclaim(uma_zone_t, int req);
4438355f576SJeff Roberson 
4448355f576SJeff Roberson /*
4451e319f6dSRobert Watson  * Sets the alignment mask to be used for all zones requesting cache
4461e319f6dSRobert Watson  * alignment.  Should be called by MD boot code prior to starting VM/UMA.
4471e319f6dSRobert Watson  *
4481e319f6dSRobert Watson  * Arguments:
4491e319f6dSRobert Watson  *	align The alignment mask
4501e319f6dSRobert Watson  *
4511e319f6dSRobert Watson  * Returns:
4521e319f6dSRobert Watson  *	Nothing
4531e319f6dSRobert Watson  */
4541e319f6dSRobert Watson void uma_set_align(int align);
4551e319f6dSRobert Watson 
4561e319f6dSRobert Watson /*
4576fd34d6fSJeff Roberson  * Set a reserved number of items to hold for M_USE_RESERVE allocations.  All
4586fd34d6fSJeff Roberson  * other requests must allocate new backing pages.
4596fd34d6fSJeff Roberson  */
4606fd34d6fSJeff Roberson void uma_zone_reserve(uma_zone_t zone, int nitems);
4616fd34d6fSJeff Roberson 
4626fd34d6fSJeff Roberson /*
463a4915c21SAttilio Rao  * Reserves the maximum KVA space required by the zone and configures the zone
464a4915c21SAttilio Rao  * to use a VM_ALLOC_NOOBJ-based backend allocator.
4658355f576SJeff Roberson  *
4668355f576SJeff Roberson  * Arguments:
4672db63c5eSGiorgos Keramidas  *	zone  The zone to update.
468a4915c21SAttilio Rao  *	nitems  The upper limit on the number of items that can be allocated.
4698355f576SJeff Roberson  *
4708355f576SJeff Roberson  * Returns:
471a4915c21SAttilio Rao  *	0  if KVA space can not be allocated
4728355f576SJeff Roberson  *	1  if successful
4738355f576SJeff Roberson  *
4748355f576SJeff Roberson  * Discussion:
475a4915c21SAttilio Rao  *	When the machine supports a direct map and the zone's items are smaller
476a4915c21SAttilio Rao  *	than a page, the zone will use the direct map instead of allocating KVA
477a4915c21SAttilio Rao  *	space.
4788355f576SJeff Roberson  */
479a4915c21SAttilio Rao int uma_zone_reserve_kva(uma_zone_t zone, int nitems);
4808355f576SJeff Roberson 
481736ee590SJeff Roberson /*
482736ee590SJeff Roberson  * Sets a high limit on the number of items allowed in a zone
483736ee590SJeff Roberson  *
484736ee590SJeff Roberson  * Arguments:
485736ee590SJeff Roberson  *	zone  The zone to limit
4861c6cae97SLawrence Stewart  *	nitems  The requested upper limit on the number of items allowed
487736ee590SJeff Roberson  *
488736ee590SJeff Roberson  * Returns:
489003cf08bSMark Johnston  *	int  The effective value of nitems
490736ee590SJeff Roberson  */
4911c6cae97SLawrence Stewart int uma_zone_set_max(uma_zone_t zone, int nitems);
4928355f576SJeff Roberson 
4938355f576SJeff Roberson /*
494bb15d1c7SGleb Smirnoff  * Sets a high limit on the number of items allowed in zone's bucket cache
495bb15d1c7SGleb Smirnoff  *
496bb15d1c7SGleb Smirnoff  * Arguments:
497bb15d1c7SGleb Smirnoff  *      zone  The zone to limit
498bb15d1c7SGleb Smirnoff  *      nitems  The requested upper limit on the number of items allowed
499bb15d1c7SGleb Smirnoff  */
500003cf08bSMark Johnston void uma_zone_set_maxcache(uma_zone_t zone, int nitems);
501bb15d1c7SGleb Smirnoff 
502bb15d1c7SGleb Smirnoff /*
503e49471b0SAndre Oppermann  * Obtains the effective limit on the number of items in a zone
504e49471b0SAndre Oppermann  *
505e49471b0SAndre Oppermann  * Arguments:
506e49471b0SAndre Oppermann  *	zone  The zone to obtain the effective limit from
507e49471b0SAndre Oppermann  *
508e49471b0SAndre Oppermann  * Return:
509e49471b0SAndre Oppermann  *	0  No limit
510e49471b0SAndre Oppermann  *	int  The effective limit of the zone
511e49471b0SAndre Oppermann  */
512e49471b0SAndre Oppermann int uma_zone_get_max(uma_zone_t zone);
513e49471b0SAndre Oppermann 
514e49471b0SAndre Oppermann /*
5152f891cd5SPawel Jakub Dawidek  * Sets a warning to be printed when limit is reached
5162f891cd5SPawel Jakub Dawidek  *
5172f891cd5SPawel Jakub Dawidek  * Arguments:
5182f891cd5SPawel Jakub Dawidek  *	zone  The zone we will warn about
5192f891cd5SPawel Jakub Dawidek  *	warning  Warning content
5202f891cd5SPawel Jakub Dawidek  *
5212f891cd5SPawel Jakub Dawidek  * Returns:
5222f891cd5SPawel Jakub Dawidek  *	Nothing
5232f891cd5SPawel Jakub Dawidek  */
5242f891cd5SPawel Jakub Dawidek void uma_zone_set_warning(uma_zone_t zone, const char *warning);
5252f891cd5SPawel Jakub Dawidek 
5262f891cd5SPawel Jakub Dawidek /*
52754503a13SJonathan T. Looney  * Sets a function to run when limit is reached
52854503a13SJonathan T. Looney  *
52954503a13SJonathan T. Looney  * Arguments:
53054503a13SJonathan T. Looney  *	zone  The zone to which this applies
53154503a13SJonathan T. Looney  *	fx  The function ro run
53254503a13SJonathan T. Looney  *
53354503a13SJonathan T. Looney  * Returns:
53454503a13SJonathan T. Looney  *	Nothing
53554503a13SJonathan T. Looney  */
536e60b2fcbSGleb Smirnoff typedef void (*uma_maxaction_t)(uma_zone_t, int);
53754503a13SJonathan T. Looney void uma_zone_set_maxaction(uma_zone_t zone, uma_maxaction_t);
53854503a13SJonathan T. Looney 
53954503a13SJonathan T. Looney /*
540c4ae7908SLawrence Stewart  * Obtains the approximate current number of items allocated from a zone
541c4ae7908SLawrence Stewart  *
542c4ae7908SLawrence Stewart  * Arguments:
543c4ae7908SLawrence Stewart  *	zone  The zone to obtain the current allocation count from
544c4ae7908SLawrence Stewart  *
545c4ae7908SLawrence Stewart  * Return:
546c4ae7908SLawrence Stewart  *	int  The approximate current number of items allocated from the zone
547c4ae7908SLawrence Stewart  */
548c4ae7908SLawrence Stewart int uma_zone_get_cur(uma_zone_t zone);
549c4ae7908SLawrence Stewart 
550c4ae7908SLawrence Stewart /*
551099a0e58SBosko Milekic  * The following two routines (uma_zone_set_init/fini)
552099a0e58SBosko Milekic  * are used to set the backend init/fini pair which acts on an
553099a0e58SBosko Milekic  * object as it becomes allocated and is placed in a slab within
554099a0e58SBosko Milekic  * the specified zone's backing keg.  These should probably not
5552db63c5eSGiorgos Keramidas  * be changed once allocations have already begun, but only be set
556099a0e58SBosko Milekic  * immediately upon zone creation.
557099a0e58SBosko Milekic  */
558099a0e58SBosko Milekic void uma_zone_set_init(uma_zone_t zone, uma_init uminit);
559099a0e58SBosko Milekic void uma_zone_set_fini(uma_zone_t zone, uma_fini fini);
560099a0e58SBosko Milekic 
561099a0e58SBosko Milekic /*
562099a0e58SBosko Milekic  * The following two routines (uma_zone_set_zinit/zfini) are
563099a0e58SBosko Milekic  * used to set the zinit/zfini pair which acts on an object as
564099a0e58SBosko Milekic  * it passes from the backing Keg's slab cache to the
565099a0e58SBosko Milekic  * specified Zone's bucket cache.  These should probably not
5662db63c5eSGiorgos Keramidas  * be changed once allocations have already begun, but only be set
5672db63c5eSGiorgos Keramidas  * immediately upon zone creation.
568099a0e58SBosko Milekic  */
569099a0e58SBosko Milekic void uma_zone_set_zinit(uma_zone_t zone, uma_init zinit);
570099a0e58SBosko Milekic void uma_zone_set_zfini(uma_zone_t zone, uma_fini zfini);
571099a0e58SBosko Milekic 
572099a0e58SBosko Milekic /*
573a4915c21SAttilio Rao  * Replaces the standard backend allocator for this zone.
5748355f576SJeff Roberson  *
5758355f576SJeff Roberson  * Arguments:
5762db63c5eSGiorgos Keramidas  *	zone   The zone whose backend allocator is being changed.
5778355f576SJeff Roberson  *	allocf A pointer to the allocation function
5788355f576SJeff Roberson  *
5798355f576SJeff Roberson  * Returns:
5808355f576SJeff Roberson  *	Nothing
5818355f576SJeff Roberson  *
5828355f576SJeff Roberson  * Discussion:
5838355f576SJeff Roberson  *	This could be used to implement pageable allocation, or perhaps
5848355f576SJeff Roberson  *	even DMA allocators if used in conjunction with the OFFPAGE
5858355f576SJeff Roberson  *	zone flag.
5868355f576SJeff Roberson  */
5878355f576SJeff Roberson 
5888355f576SJeff Roberson void uma_zone_set_allocf(uma_zone_t zone, uma_alloc allocf);
5898355f576SJeff Roberson 
5908355f576SJeff Roberson /*
5918355f576SJeff Roberson  * Used for freeing memory provided by the allocf above
5928355f576SJeff Roberson  *
5938355f576SJeff Roberson  * Arguments:
5948355f576SJeff Roberson  *	zone  The zone that intends to use this free routine.
5958355f576SJeff Roberson  *	freef The page freeing routine.
5968355f576SJeff Roberson  *
5978355f576SJeff Roberson  * Returns:
5988355f576SJeff Roberson  *	Nothing
5998355f576SJeff Roberson  */
6008355f576SJeff Roberson 
6018355f576SJeff Roberson void uma_zone_set_freef(uma_zone_t zone, uma_free freef);
6028355f576SJeff Roberson 
6038355f576SJeff Roberson /*
6042db63c5eSGiorgos Keramidas  * These flags are setable in the allocf and visible in the freef.
6058355f576SJeff Roberson  */
6068355f576SJeff Roberson #define UMA_SLAB_BOOT	0x01		/* Slab alloced from boot pages */
60749bfa624SAlan Cox #define UMA_SLAB_KERNEL	0x04		/* Slab alloced from kmem */
6088355f576SJeff Roberson #define UMA_SLAB_PRIV	0x08		/* Slab alloced from priv allocator */
609c235bfa5SJeff Roberson #define UMA_SLAB_OFFP	0x10		/* Slab is managed separately  */
61049bfa624SAlan Cox /* 0x02, 0x40, and 0x80 are available */
6118355f576SJeff Roberson 
6128355f576SJeff Roberson /*
6138355f576SJeff Roberson  * Used to pre-fill a zone with some number of items
6148355f576SJeff Roberson  *
6158355f576SJeff Roberson  * Arguments:
6168355f576SJeff Roberson  *	zone    The zone to fill
6178355f576SJeff Roberson  *	itemcnt The number of items to reserve
6188355f576SJeff Roberson  *
6198355f576SJeff Roberson  * Returns:
6208355f576SJeff Roberson  *	Nothing
6218355f576SJeff Roberson  *
6228355f576SJeff Roberson  * NOTE: This is blocking and should only be done at startup
6238355f576SJeff Roberson  */
6248355f576SJeff Roberson void uma_prealloc(uma_zone_t zone, int itemcnt);
6258355f576SJeff Roberson 
626099a0e58SBosko Milekic /*
627663b416fSJohn Baldwin  * Used to determine if a fixed-size zone is exhausted.
628663b416fSJohn Baldwin  *
629663b416fSJohn Baldwin  * Arguments:
630663b416fSJohn Baldwin  *	zone    The zone to check
631663b416fSJohn Baldwin  *
632663b416fSJohn Baldwin  * Returns:
633663b416fSJohn Baldwin  *	Non-zero if zone is exhausted.
634663b416fSJohn Baldwin  */
635663b416fSJohn Baldwin int uma_zone_exhausted(uma_zone_t zone);
636663b416fSJohn Baldwin 
637663b416fSJohn Baldwin /*
63849fef6a2SGleb Smirnoff  * Common UMA_ZONE_PCPU zones.
63949fef6a2SGleb Smirnoff  */
640a8c8e44bSMateusz Guzik extern uma_zone_t pcpu_zone_int;
64149fef6a2SGleb Smirnoff extern uma_zone_t pcpu_zone_64;
64249fef6a2SGleb Smirnoff 
64349fef6a2SGleb Smirnoff /*
6447a52a97eSRobert Watson  * Exported statistics structures to be used by user space monitoring tools.
6452db63c5eSGiorgos Keramidas  * Statistics stream consists of a uma_stream_header, followed by a series of
6462db63c5eSGiorgos Keramidas  * alternative uma_type_header and uma_type_stat structures.
6477a52a97eSRobert Watson  */
6487a52a97eSRobert Watson #define	UMA_STREAM_VERSION	0x00000001
6497a52a97eSRobert Watson struct uma_stream_header {
65085dcf349SGleb Smirnoff 	uint32_t	ush_version;	/* Stream format version. */
65185dcf349SGleb Smirnoff 	uint32_t	ush_maxcpus;	/* Value of MAXCPU for stream. */
65285dcf349SGleb Smirnoff 	uint32_t	ush_count;	/* Number of records. */
65385dcf349SGleb Smirnoff 	uint32_t	_ush_pad;	/* Pad/reserved field. */
6547a52a97eSRobert Watson };
6557a52a97eSRobert Watson 
656cbbb4a00SRobert Watson #define	UTH_MAX_NAME	32
657cbbb4a00SRobert Watson #define	UTH_ZONE_SECONDARY	0x00000001
6587a52a97eSRobert Watson struct uma_type_header {
6597a52a97eSRobert Watson 	/*
6607a52a97eSRobert Watson 	 * Static per-zone data, some extracted from the supporting keg.
6617a52a97eSRobert Watson 	 */
662cbbb4a00SRobert Watson 	char		uth_name[UTH_MAX_NAME];
66385dcf349SGleb Smirnoff 	uint32_t	uth_align;	/* Keg: alignment. */
66485dcf349SGleb Smirnoff 	uint32_t	uth_size;	/* Keg: requested size of item. */
66585dcf349SGleb Smirnoff 	uint32_t	uth_rsize;	/* Keg: real size of item. */
66685dcf349SGleb Smirnoff 	uint32_t	uth_maxpages;	/* Keg: maximum number of pages. */
66785dcf349SGleb Smirnoff 	uint32_t	uth_limit;	/* Keg: max items to allocate. */
6687a52a97eSRobert Watson 
6697a52a97eSRobert Watson 	/*
6707a52a97eSRobert Watson 	 * Current dynamic zone/keg-derived statistics.
6717a52a97eSRobert Watson 	 */
67285dcf349SGleb Smirnoff 	uint32_t	uth_pages;	/* Keg: pages allocated. */
67385dcf349SGleb Smirnoff 	uint32_t	uth_keg_free;	/* Keg: items free. */
67485dcf349SGleb Smirnoff 	uint32_t	uth_zone_free;	/* Zone: items free. */
67585dcf349SGleb Smirnoff 	uint32_t	uth_bucketsize;	/* Zone: desired bucket size. */
67685dcf349SGleb Smirnoff 	uint32_t	uth_zone_flags;	/* Zone: flags. */
67785dcf349SGleb Smirnoff 	uint64_t	uth_allocs;	/* Zone: number of allocations. */
67885dcf349SGleb Smirnoff 	uint64_t	uth_frees;	/* Zone: number of frees. */
67985dcf349SGleb Smirnoff 	uint64_t	uth_fails;	/* Zone: number of alloc failures. */
68085dcf349SGleb Smirnoff 	uint64_t	uth_sleeps;	/* Zone: number of alloc sleeps. */
681c1685086SJeff Roberson 	uint64_t	uth_xdomain;	/* Zone: Number of cross domain frees. */
682c1685086SJeff Roberson 	uint64_t	_uth_reserved1[1];	/* Reserved. */
6837a52a97eSRobert Watson };
6847a52a97eSRobert Watson 
6857a52a97eSRobert Watson struct uma_percpu_stat {
68685dcf349SGleb Smirnoff 	uint64_t	ups_allocs;	/* Cache: number of allocations. */
68785dcf349SGleb Smirnoff 	uint64_t	ups_frees;	/* Cache: number of frees. */
68885dcf349SGleb Smirnoff 	uint64_t	ups_cache_free;	/* Cache: free items in cache. */
68985dcf349SGleb Smirnoff 	uint64_t	_ups_reserved[5];	/* Reserved. */
6907a52a97eSRobert Watson };
6917a52a97eSRobert Watson 
69244ec2b63SKonstantin Belousov void uma_reclaim_wakeup(void);
69344ec2b63SKonstantin Belousov void uma_reclaim_worker(void *);
69444ec2b63SKonstantin Belousov 
695ad5b0f5bSJeff Roberson unsigned long uma_limit(void);
696ad5b0f5bSJeff Roberson 
697ad5b0f5bSJeff Roberson /* Return the amount of memory managed by UMA. */
698ad5b0f5bSJeff Roberson unsigned long uma_size(void);
699ad5b0f5bSJeff Roberson 
700ad5b0f5bSJeff Roberson /* Return the amount of memory remaining.  May be negative. */
701ad5b0f5bSJeff Roberson long uma_avail(void);
702ad5b0f5bSJeff Roberson 
703f947570eSGleb Smirnoff #endif	/* _VM_UMA_H_ */
704