xref: /freebsd/sys/vm/uma.h (revision 7e28037a09bae935c1c2b086180d056d523f7584)
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 
536c125b8dSMohan Srinivasan void zone_drain(uma_zone_t);
546c125b8dSMohan Srinivasan 
558355f576SJeff Roberson /*
568355f576SJeff Roberson  * Item constructor
578355f576SJeff Roberson  *
588355f576SJeff Roberson  * Arguments:
598355f576SJeff Roberson  *	item  A pointer to the memory which has been allocated.
608355f576SJeff Roberson  *	arg   The arg field passed to uma_zalloc_arg
618355f576SJeff Roberson  *	size  The size of the allocated item
62b23f72e9SBrian Feldman  *	flags See zalloc flags
638355f576SJeff Roberson  *
648355f576SJeff Roberson  * Returns:
65b23f72e9SBrian Feldman  *	0      on success
66b23f72e9SBrian Feldman  *      errno  on failure
678355f576SJeff Roberson  *
688355f576SJeff Roberson  * Discussion:
698355f576SJeff Roberson  *	The constructor is called just before the memory is returned
7029b4d526SSheldon Hearn  *	to the user. It may block if necessary.
718355f576SJeff Roberson  */
72b23f72e9SBrian Feldman typedef int (*uma_ctor)(void *mem, int size, void *arg, int flags);
738355f576SJeff Roberson 
748355f576SJeff Roberson /*
758355f576SJeff Roberson  * Item destructor
768355f576SJeff Roberson  *
778355f576SJeff Roberson  * Arguments:
788355f576SJeff Roberson  *	item  A pointer to the memory which has been allocated.
798355f576SJeff Roberson  *	size  The size of the item being destructed.
808355f576SJeff Roberson  *	arg   Argument passed through uma_zfree_arg
818355f576SJeff Roberson  *
828355f576SJeff Roberson  * Returns:
838355f576SJeff Roberson  *	Nothing
848355f576SJeff Roberson  *
858355f576SJeff Roberson  * Discussion:
868355f576SJeff Roberson  *	The destructor may perform operations that differ from those performed
878355f576SJeff Roberson  *	by the initializer, but it must leave the object in the same state.
888355f576SJeff Roberson  *	This IS type stable storage.  This is called after EVERY zfree call.
898355f576SJeff Roberson  */
908355f576SJeff Roberson typedef void (*uma_dtor)(void *mem, int size, void *arg);
918355f576SJeff Roberson 
928355f576SJeff Roberson /*
938355f576SJeff Roberson  * Item initializer
948355f576SJeff Roberson  *
958355f576SJeff Roberson  * Arguments:
968355f576SJeff Roberson  *	item  A pointer to the memory which has been allocated.
978355f576SJeff Roberson  *	size  The size of the item being initialized.
98b23f72e9SBrian Feldman  *	flags See zalloc flags
998355f576SJeff Roberson  *
1008355f576SJeff Roberson  * Returns:
101b23f72e9SBrian Feldman  *	0      on success
102b23f72e9SBrian Feldman  *      errno  on failure
1038355f576SJeff Roberson  *
1048355f576SJeff Roberson  * Discussion:
1058355f576SJeff Roberson  *	The initializer is called when the memory is cached in the uma zone.
1062db63c5eSGiorgos Keramidas  *	The initializer and the destructor should leave the object in the same
1072db63c5eSGiorgos Keramidas  *	state.
1088355f576SJeff Roberson  */
109b23f72e9SBrian Feldman typedef int (*uma_init)(void *mem, int size, int flags);
1108355f576SJeff Roberson 
1118355f576SJeff Roberson /*
1128355f576SJeff Roberson  * Item discard function
1138355f576SJeff Roberson  *
1148355f576SJeff Roberson  * Arguments:
1158355f576SJeff Roberson  *	item  A pointer to memory which has been 'freed' but has not left the
1168355f576SJeff Roberson  *	      zone's cache.
1178355f576SJeff Roberson  *	size  The size of the item being discarded.
1188355f576SJeff Roberson  *
1198355f576SJeff Roberson  * Returns:
1208355f576SJeff Roberson  *	Nothing
1218355f576SJeff Roberson  *
1228355f576SJeff Roberson  * Discussion:
1238355f576SJeff Roberson  *	This routine is called when memory leaves a zone and is returned to the
1242db63c5eSGiorgos Keramidas  *	system for other uses.  It is the counter-part to the init function.
1258355f576SJeff Roberson  */
1268355f576SJeff Roberson typedef void (*uma_fini)(void *mem, int size);
1278355f576SJeff Roberson 
1288355f576SJeff Roberson /*
1290095a784SJeff Roberson  * Import new memory into a cache zone.
1300095a784SJeff Roberson  */
131ab3185d1SJeff Roberson typedef int (*uma_import)(void *arg, void **store, int count, int domain,
132ab3185d1SJeff Roberson     int flags);
1330095a784SJeff Roberson 
1340095a784SJeff Roberson /*
1350095a784SJeff Roberson  * Free memory from a cache zone.
1360095a784SJeff Roberson  */
1370095a784SJeff Roberson typedef void (*uma_release)(void *arg, void **store, int count);
1380095a784SJeff Roberson 
1390095a784SJeff Roberson /*
1408355f576SJeff Roberson  * What's the difference between initializing and constructing?
1418355f576SJeff Roberson  *
1428355f576SJeff Roberson  * The item is initialized when it is cached, and this is the state that the
1438355f576SJeff Roberson  * object should be in when returned to the allocator. The purpose of this is
1448355f576SJeff Roberson  * to remove some code which would otherwise be called on each allocation by
1458355f576SJeff Roberson  * utilizing a known, stable state.  This differs from the constructor which
1468355f576SJeff Roberson  * will be called on EVERY allocation.
1478355f576SJeff Roberson  *
1482db63c5eSGiorgos Keramidas  * For example, in the initializer you may want to initialize embedded locks,
1498355f576SJeff Roberson  * NULL list pointers, set up initial states, magic numbers, etc.  This way if
15029b4d526SSheldon Hearn  * the object is held in the allocator and re-used it won't be necessary to
1518355f576SJeff Roberson  * re-initialize it.
1528355f576SJeff Roberson  *
1538355f576SJeff Roberson  * The constructor may be used to lock a data structure, link it on to lists,
1548355f576SJeff Roberson  * bump reference counts or total counts of outstanding structures, etc.
1558355f576SJeff Roberson  *
1568355f576SJeff Roberson  */
1578355f576SJeff Roberson 
1588355f576SJeff Roberson 
1598355f576SJeff Roberson /* Function proto types */
1608355f576SJeff Roberson 
1618355f576SJeff Roberson /*
1628355f576SJeff Roberson  * Create a new uma zone
1638355f576SJeff Roberson  *
1648355f576SJeff Roberson  * Arguments:
1652db63c5eSGiorgos Keramidas  *	name  The text name of the zone for debugging and stats. This memory
1668355f576SJeff Roberson  *		should not be freed until the zone has been deallocated.
1678355f576SJeff Roberson  *	size  The size of the object that is being created.
1682db63c5eSGiorgos Keramidas  *	ctor  The constructor that is called when the object is allocated.
1698355f576SJeff Roberson  *	dtor  The destructor that is called when the object is freed.
1708355f576SJeff Roberson  *	init  An initializer that sets up the initial state of the memory.
1718355f576SJeff Roberson  *	fini  A discard function that undoes initialization done by init.
1728355f576SJeff Roberson  *		ctor/dtor/init/fini may all be null, see notes above.
1732db63c5eSGiorgos Keramidas  *	align A bitmask that corresponds to the requested alignment
1748355f576SJeff Roberson  *		eg 4 would be 0x3
1752db63c5eSGiorgos Keramidas  *	flags A set of parameters that control the behavior of the zone.
1768355f576SJeff Roberson  *
1778355f576SJeff Roberson  * Returns:
1788355f576SJeff Roberson  *	A pointer to a structure which is intended to be opaque to users of
1798355f576SJeff Roberson  *	the interface.  The value may be null if the wait flag is not set.
1808355f576SJeff Roberson  */
181bb196eb4SMatthew D Fleming uma_zone_t uma_zcreate(const char *name, size_t size, uma_ctor ctor,
182bb196eb4SMatthew D Fleming 		    uma_dtor dtor, uma_init uminit, uma_fini fini,
18385dcf349SGleb Smirnoff 		    int align, uint32_t flags);
1848355f576SJeff Roberson 
185b60f5b79SJeff Roberson /*
186099a0e58SBosko Milekic  * Create a secondary uma zone
187099a0e58SBosko Milekic  *
188099a0e58SBosko Milekic  * Arguments:
1892db63c5eSGiorgos Keramidas  *	name  The text name of the zone for debugging and stats. This memory
190099a0e58SBosko Milekic  *		should not be freed until the zone has been deallocated.
1912db63c5eSGiorgos Keramidas  *	ctor  The constructor that is called when the object is allocated.
192099a0e58SBosko Milekic  *	dtor  The destructor that is called when the object is freed.
193099a0e58SBosko Milekic  *	zinit  An initializer that sets up the initial state of the memory
194099a0e58SBosko Milekic  *		as the object passes from the Keg's slab to the Zone's cache.
195099a0e58SBosko Milekic  *	zfini  A discard function that undoes initialization done by init
196099a0e58SBosko Milekic  *		as the object passes from the Zone's cache to the Keg's slab.
197099a0e58SBosko Milekic  *
198099a0e58SBosko Milekic  *		ctor/dtor/zinit/zfini may all be null, see notes above.
199099a0e58SBosko Milekic  *		Note that the zinit and zfini specified here are NOT
200099a0e58SBosko Milekic  *		exactly the same as the init/fini specified to uma_zcreate()
201099a0e58SBosko Milekic  *		when creating a master zone.  These zinit/zfini are called
202099a0e58SBosko Milekic  *		on the TRANSITION from keg to zone (and vice-versa). Once
203099a0e58SBosko Milekic  *		these are set, the primary zone may alter its init/fini
204099a0e58SBosko Milekic  *		(which are called when the object passes from VM to keg)
205099a0e58SBosko Milekic  *		using uma_zone_set_init/fini()) as well as its own
206099a0e58SBosko Milekic  *		zinit/zfini (unset by default for master zone) with
207099a0e58SBosko Milekic  *		uma_zone_set_zinit/zfini() (note subtle 'z' prefix).
208099a0e58SBosko Milekic  *
209b83e441bSBosko Milekic  *	master  A reference to this zone's Master Zone (Primary Zone),
210b83e441bSBosko Milekic  *		which contains the backing Keg for the Secondary Zone
211b83e441bSBosko Milekic  *		being added.
212099a0e58SBosko Milekic  *
213099a0e58SBosko Milekic  * Returns:
214099a0e58SBosko Milekic  *	A pointer to a structure which is intended to be opaque to users of
215099a0e58SBosko Milekic  *	the interface.  The value may be null if the wait flag is not set.
216099a0e58SBosko Milekic  */
217099a0e58SBosko Milekic uma_zone_t uma_zsecond_create(char *name, uma_ctor ctor, uma_dtor dtor,
218099a0e58SBosko Milekic 		    uma_init zinit, uma_fini zfini, uma_zone_t master);
219099a0e58SBosko Milekic 
220099a0e58SBosko Milekic /*
221e20a199fSJeff Roberson  * Add a second master to a secondary zone.  This provides multiple data
222e20a199fSJeff Roberson  * backends for objects with the same size.  Both masters must have
223e20a199fSJeff Roberson  * compatible allocation flags.  Presently, UMA_ZONE_MALLOC type zones are
224e20a199fSJeff Roberson  * the only supported.
225e20a199fSJeff Roberson  *
226e20a199fSJeff Roberson  * Returns:
227e20a199fSJeff Roberson  *	Error on failure, 0 on success.
228e20a199fSJeff Roberson  */
229e20a199fSJeff Roberson int uma_zsecond_add(uma_zone_t zone, uma_zone_t master);
230e20a199fSJeff Roberson 
231e20a199fSJeff Roberson /*
2320095a784SJeff Roberson  * Create cache-only zones.
2330095a784SJeff Roberson  *
2340095a784SJeff Roberson  * This allows uma's per-cpu cache facilities to handle arbitrary
2350095a784SJeff Roberson  * pointers.  Consumers must specify the import and release functions to
2360095a784SJeff Roberson  * fill and destroy caches.  UMA does not allocate any memory for these
2370095a784SJeff Roberson  * zones.  The 'arg' parameter is passed to import/release and is caller
2380095a784SJeff Roberson  * specific.
2390095a784SJeff Roberson  */
240af526374SJeff Roberson uma_zone_t uma_zcache_create(char *name, int size, uma_ctor ctor, uma_dtor dtor,
2410095a784SJeff Roberson 		    uma_init zinit, uma_fini zfini, uma_import zimport,
2420095a784SJeff Roberson 		    uma_release zrelease, void *arg, int flags);
2430095a784SJeff Roberson 
2440095a784SJeff Roberson /*
245b60f5b79SJeff Roberson  * Definitions for uma_zcreate flags
246b60f5b79SJeff Roberson  *
247b60f5b79SJeff Roberson  * These flags share space with UMA_ZFLAGs in uma_int.h.  Be careful not to
248e20ff1a4SMark Johnston  * overlap when adding new features.  0xff000000 is in use by uma_int.h.
249b60f5b79SJeff Roberson  */
2508355f576SJeff Roberson #define UMA_ZONE_PAGEABLE	0x0001	/* Return items not fully backed by
2518355f576SJeff Roberson 					   physical memory XXX Not yet */
2528355f576SJeff Roberson #define UMA_ZONE_ZINIT		0x0002	/* Initialize with zeros */
2532db63c5eSGiorgos Keramidas #define UMA_ZONE_STATIC		0x0004	/* Statically sized zone */
2548355f576SJeff Roberson #define UMA_ZONE_OFFPAGE	0x0008	/* Force the slab structure allocation
2558355f576SJeff Roberson 					   off of the real memory */
2568355f576SJeff Roberson #define UMA_ZONE_MALLOC		0x0010	/* For use by malloc(9) only! */
2578355f576SJeff Roberson #define UMA_ZONE_NOFREE		0x0020	/* Do not free slabs of this type! */
25828bc4419SJeff Roberson #define UMA_ZONE_MTXCLASS	0x0040	/* Create a new lock class */
25999571dc3SJeff Roberson #define	UMA_ZONE_VM		0x0080	/*
26099571dc3SJeff Roberson 					 * Used for internal vm datastructures
26199571dc3SJeff Roberson 					 * only.
26299571dc3SJeff Roberson 					 */
26399571dc3SJeff Roberson #define	UMA_ZONE_HASH		0x0100	/*
26499571dc3SJeff Roberson 					 * Use a hash table instead of caching
26599571dc3SJeff Roberson 					 * information in the vm_page.
26699571dc3SJeff Roberson 					 */
267099a0e58SBosko Milekic #define	UMA_ZONE_SECONDARY	0x0200	/* Zone is a Secondary Zone */
268*7e28037aSMark Johnston #define	UMA_ZONE_NOBUCKET	0x0400	/* Do not use buckets. */
269*7e28037aSMark Johnston #define	UMA_ZONE_MAXBUCKET	0x0800	/* Use largest buckets. */
270e20a199fSJeff Roberson #define	UMA_ZONE_CACHESPREAD	0x1000	/*
271e20a199fSJeff Roberson 					 * Spread memory start locations across
272e20a199fSJeff Roberson 					 * all possible cache lines.  May
273e20a199fSJeff Roberson 					 * require many virtually contiguous
274e20a199fSJeff Roberson 					 * backend pages and can fail early.
275e20a199fSJeff Roberson 					 */
276e20a199fSJeff Roberson #define	UMA_ZONE_VTOSLAB	0x2000	/* Zone uses vtoslab for lookup. */
277263811f7SKip Macy #define	UMA_ZONE_NODUMP		0x4000	/*
278263811f7SKip Macy 					 * Zone's pages will not be included in
279263811f7SKip Macy 					 * mini-dumps.
280263811f7SKip Macy 					 */
281ad97af7eSGleb Smirnoff #define	UMA_ZONE_PCPU		0x8000	/*
28296c85efbSNathan Whitehorn 					 * Allocates mp_maxid + 1 slabs sized to
283ad97af7eSGleb Smirnoff 					 * sizeof(struct pcpu).
284ad97af7eSGleb Smirnoff 					 */
285ab3185d1SJeff Roberson #define	UMA_ZONE_NUMA		0x10000	/*
286ab3185d1SJeff Roberson 					 * NUMA aware Zone.  Implements a best
287ab3185d1SJeff Roberson 					 * effort first-touch policy.
288ab3185d1SJeff Roberson 					 */
289e8bb2dc7SJeff Roberson #define	UMA_ZONE_NOBUCKETCACHE	0x20000	/*
290e8bb2dc7SJeff Roberson 					 * Don't cache full buckets.  Limit
291e8bb2dc7SJeff Roberson 					 * UMA to per-cpu state.
292e8bb2dc7SJeff Roberson 					 */
293e20a199fSJeff Roberson 
294e20a199fSJeff Roberson /*
295e20a199fSJeff Roberson  * These flags are shared between the keg and zone.  In zones wishing to add
296e20a199fSJeff Roberson  * new kegs these flags must be compatible.  Some are determined based on
297e20a199fSJeff Roberson  * physical parameters of the request and may not be provided by the consumer.
298e20a199fSJeff Roberson  */
299e20a199fSJeff Roberson #define	UMA_ZONE_INHERIT						\
3008d689e04SGleb Smirnoff     (UMA_ZONE_OFFPAGE | UMA_ZONE_MALLOC | UMA_ZONE_NOFREE |		\
301cfcae3f8SGleb Smirnoff     UMA_ZONE_HASH | UMA_ZONE_VTOSLAB | UMA_ZONE_PCPU)
3028355f576SJeff Roberson 
3038355f576SJeff Roberson /* Definitions for align */
3048355f576SJeff Roberson #define UMA_ALIGN_PTR	(sizeof(void *) - 1)	/* Alignment fit for ptr */
3058355f576SJeff Roberson #define UMA_ALIGN_LONG	(sizeof(long) - 1)	/* "" long */
3068355f576SJeff Roberson #define UMA_ALIGN_INT	(sizeof(int) - 1)	/* "" int */
3078355f576SJeff Roberson #define UMA_ALIGN_SHORT	(sizeof(short) - 1)	/* "" short */
3088355f576SJeff Roberson #define UMA_ALIGN_CHAR	(sizeof(char) - 1)	/* "" char */
3091e319f6dSRobert Watson #define UMA_ALIGN_CACHE	(0 - 1)			/* Cache line size align */
31014c510c0SJohn Baldwin #define	UMA_ALIGNOF(type) (_Alignof(type) - 1)	/* Alignment fit for 'type' */
3118355f576SJeff Roberson 
3128355f576SJeff Roberson /*
3139c2cd7e5SJeff Roberson  * Destroys an empty uma zone.  If the zone is not empty uma complains loudly.
3148355f576SJeff Roberson  *
3158355f576SJeff Roberson  * Arguments:
3168355f576SJeff Roberson  *	zone  The zone we want to destroy.
3178355f576SJeff Roberson  *
3188355f576SJeff Roberson  */
3199c2cd7e5SJeff Roberson void uma_zdestroy(uma_zone_t zone);
3208355f576SJeff Roberson 
3218355f576SJeff Roberson /*
3228355f576SJeff Roberson  * Allocates an item out of a zone
3238355f576SJeff Roberson  *
3248355f576SJeff Roberson  * Arguments:
3258355f576SJeff Roberson  *	zone  The zone we are allocating from
3268355f576SJeff Roberson  *	arg   This data is passed to the ctor function
3272cc35ff9SJeff Roberson  *	flags See sys/malloc.h for available flags.
3288355f576SJeff Roberson  *
3298355f576SJeff Roberson  * Returns:
3302db63c5eSGiorgos Keramidas  *	A non-null pointer to an initialized element from the zone is
3312db63c5eSGiorgos Keramidas  *	guaranteed if the wait flag is M_WAITOK.  Otherwise a null pointer
3322db63c5eSGiorgos Keramidas  *	may be returned if the zone is empty or the ctor failed.
3338355f576SJeff Roberson  */
3348355f576SJeff Roberson 
3352cc35ff9SJeff Roberson void *uma_zalloc_arg(uma_zone_t zone, void *arg, int flags);
3368355f576SJeff Roberson 
3378355f576SJeff Roberson /*
338ab3185d1SJeff Roberson  * Allocate an item from a specific NUMA domain.  This uses a slow path in
339ab3185d1SJeff Roberson  * the allocator but is guaranteed to allocate memory from the requested
340ab3185d1SJeff Roberson  * domain if M_WAITOK is set.
341ab3185d1SJeff Roberson  *
342ab3185d1SJeff Roberson  * Arguments:
343ab3185d1SJeff Roberson  *	zone  The zone we are allocating from
344ab3185d1SJeff Roberson  *	arg   This data is passed to the ctor function
345ab3185d1SJeff Roberson  *	domain The domain to allocate from.
346ab3185d1SJeff Roberson  *	flags See sys/malloc.h for available flags.
347ab3185d1SJeff Roberson  */
348ab3185d1SJeff Roberson void *uma_zalloc_domain(uma_zone_t zone, void *arg, int domain, int flags);
349ab3185d1SJeff Roberson 
350ab3185d1SJeff Roberson /*
3518355f576SJeff Roberson  * Allocates an item out of a zone without supplying an argument
3528355f576SJeff Roberson  *
3538355f576SJeff Roberson  * This is just a wrapper for uma_zalloc_arg for convenience.
3548355f576SJeff Roberson  *
3558355f576SJeff Roberson  */
3562cc35ff9SJeff Roberson static __inline void *uma_zalloc(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 
3648355f576SJeff Roberson /*
3658355f576SJeff Roberson  * Frees an item back into the specified zone.
3668355f576SJeff Roberson  *
3678355f576SJeff Roberson  * Arguments:
3688355f576SJeff Roberson  *	zone  The zone the item was originally allocated out of.
3698355f576SJeff Roberson  *	item  The memory to be freed.
3708355f576SJeff Roberson  *	arg   Argument passed to the destructor
3718355f576SJeff Roberson  *
3728355f576SJeff Roberson  * Returns:
3738355f576SJeff Roberson  *	Nothing.
3748355f576SJeff Roberson  */
3758355f576SJeff Roberson 
3768355f576SJeff Roberson void uma_zfree_arg(uma_zone_t zone, void *item, void *arg);
3778355f576SJeff Roberson 
3788355f576SJeff Roberson /*
379ab3185d1SJeff Roberson  * Frees an item back to the specified zone's domain specific pool.
380ab3185d1SJeff Roberson  *
381ab3185d1SJeff Roberson  * Arguments:
382ab3185d1SJeff Roberson  *	zone  The zone the item was originally allocated out of.
383ab3185d1SJeff Roberson  *	item  The memory to be freed.
384ab3185d1SJeff Roberson  *	arg   Argument passed to the destructor
385ab3185d1SJeff Roberson  */
386ab3185d1SJeff Roberson void uma_zfree_domain(uma_zone_t zone, void *item, void *arg);
387ab3185d1SJeff Roberson 
388ab3185d1SJeff Roberson /*
3898355f576SJeff Roberson  * Frees an item back to a zone without supplying an argument
3908355f576SJeff Roberson  *
3918355f576SJeff Roberson  * This is just a wrapper for uma_zfree_arg for convenience.
3928355f576SJeff Roberson  *
3938355f576SJeff Roberson  */
3948355f576SJeff Roberson static __inline void uma_zfree(uma_zone_t zone, void *item);
3958355f576SJeff Roberson 
3968355f576SJeff Roberson static __inline void
3978355f576SJeff Roberson uma_zfree(uma_zone_t zone, void *item)
3988355f576SJeff Roberson {
399f6e34b82SMark Murray 	uma_zfree_arg(zone, item, NULL);
4008355f576SJeff Roberson }
4018355f576SJeff Roberson 
4028355f576SJeff Roberson /*
4038d6fbbb8SJeff Roberson  * Wait until the specified zone can allocate an item.
4048d6fbbb8SJeff Roberson  */
4058d6fbbb8SJeff Roberson void uma_zwait(uma_zone_t zone);
4068d6fbbb8SJeff Roberson 
4078d6fbbb8SJeff Roberson /*
4088355f576SJeff Roberson  * Backend page supplier routines
4098355f576SJeff Roberson  *
4108355f576SJeff Roberson  * Arguments:
4112db63c5eSGiorgos Keramidas  *	zone  The zone that is requesting pages.
4122db63c5eSGiorgos Keramidas  *	size  The number of bytes being requested.
4138355f576SJeff Roberson  *	pflag Flags for these memory pages, see below.
414ab3185d1SJeff Roberson  *	domain The NUMA domain that we prefer for this allocation.
4158355f576SJeff Roberson  *	wait  Indicates our willingness to block.
4168355f576SJeff Roberson  *
4178355f576SJeff Roberson  * Returns:
4182db63c5eSGiorgos Keramidas  *	A pointer to the allocated memory or NULL on failure.
4198355f576SJeff Roberson  */
4208355f576SJeff Roberson 
421ab3185d1SJeff Roberson typedef void *(*uma_alloc)(uma_zone_t zone, vm_size_t size, int domain,
422ab3185d1SJeff Roberson     uint8_t *pflag, int wait);
4238355f576SJeff Roberson 
4248355f576SJeff Roberson /*
4258355f576SJeff Roberson  * Backend page free routines
4268355f576SJeff Roberson  *
4278355f576SJeff Roberson  * Arguments:
4282db63c5eSGiorgos Keramidas  *	item  A pointer to the previously allocated pages.
4292db63c5eSGiorgos Keramidas  *	size  The original size of the allocation.
4302db63c5eSGiorgos Keramidas  *	pflag The flags for the slab.  See UMA_SLAB_* below.
4318355f576SJeff Roberson  *
4328355f576SJeff Roberson  * Returns:
4338355f576SJeff Roberson  *	None
4348355f576SJeff Roberson  */
435f2c2231eSRyan Stone typedef void (*uma_free)(void *item, vm_size_t size, uint8_t pflag);
4368355f576SJeff Roberson 
4378355f576SJeff Roberson /*
4388355f576SJeff Roberson  * Reclaims unused memory for all zones
4398355f576SJeff Roberson  *
4408355f576SJeff Roberson  * Arguments:
4418355f576SJeff Roberson  *	None
4428355f576SJeff Roberson  * Returns:
4438355f576SJeff Roberson  *	None
4448355f576SJeff Roberson  *
4458355f576SJeff Roberson  * This should only be called by the page out daemon.
4468355f576SJeff Roberson  */
4478355f576SJeff Roberson 
4488355f576SJeff Roberson void uma_reclaim(void);
4498355f576SJeff Roberson 
4508355f576SJeff Roberson /*
4511e319f6dSRobert Watson  * Sets the alignment mask to be used for all zones requesting cache
4521e319f6dSRobert Watson  * alignment.  Should be called by MD boot code prior to starting VM/UMA.
4531e319f6dSRobert Watson  *
4541e319f6dSRobert Watson  * Arguments:
4551e319f6dSRobert Watson  *	align The alignment mask
4561e319f6dSRobert Watson  *
4571e319f6dSRobert Watson  * Returns:
4581e319f6dSRobert Watson  *	Nothing
4591e319f6dSRobert Watson  */
4601e319f6dSRobert Watson void uma_set_align(int align);
4611e319f6dSRobert Watson 
4621e319f6dSRobert Watson /*
4636fd34d6fSJeff Roberson  * Set a reserved number of items to hold for M_USE_RESERVE allocations.  All
4646fd34d6fSJeff Roberson  * other requests must allocate new backing pages.
4656fd34d6fSJeff Roberson  */
4666fd34d6fSJeff Roberson void uma_zone_reserve(uma_zone_t zone, int nitems);
4676fd34d6fSJeff Roberson 
4686fd34d6fSJeff Roberson /*
469a4915c21SAttilio Rao  * Reserves the maximum KVA space required by the zone and configures the zone
470a4915c21SAttilio Rao  * to use a VM_ALLOC_NOOBJ-based backend allocator.
4718355f576SJeff Roberson  *
4728355f576SJeff Roberson  * Arguments:
4732db63c5eSGiorgos Keramidas  *	zone  The zone to update.
474a4915c21SAttilio Rao  *	nitems  The upper limit on the number of items that can be allocated.
4758355f576SJeff Roberson  *
4768355f576SJeff Roberson  * Returns:
477a4915c21SAttilio Rao  *	0  if KVA space can not be allocated
4788355f576SJeff Roberson  *	1  if successful
4798355f576SJeff Roberson  *
4808355f576SJeff Roberson  * Discussion:
481a4915c21SAttilio Rao  *	When the machine supports a direct map and the zone's items are smaller
482a4915c21SAttilio Rao  *	than a page, the zone will use the direct map instead of allocating KVA
483a4915c21SAttilio Rao  *	space.
4848355f576SJeff Roberson  */
485a4915c21SAttilio Rao int uma_zone_reserve_kva(uma_zone_t zone, int nitems);
4868355f576SJeff Roberson 
487736ee590SJeff Roberson /*
488736ee590SJeff Roberson  * Sets a high limit on the number of items allowed in a zone
489736ee590SJeff Roberson  *
490736ee590SJeff Roberson  * Arguments:
491736ee590SJeff Roberson  *	zone  The zone to limit
4921c6cae97SLawrence Stewart  *	nitems  The requested upper limit on the number of items allowed
493736ee590SJeff Roberson  *
494736ee590SJeff Roberson  * Returns:
4951c6cae97SLawrence Stewart  *	int  The effective value of nitems after rounding up based on page size
496736ee590SJeff Roberson  */
4971c6cae97SLawrence Stewart int uma_zone_set_max(uma_zone_t zone, int nitems);
4988355f576SJeff Roberson 
4998355f576SJeff Roberson /*
500e49471b0SAndre Oppermann  * Obtains the effective limit on the number of items in a zone
501e49471b0SAndre Oppermann  *
502e49471b0SAndre Oppermann  * Arguments:
503e49471b0SAndre Oppermann  *	zone  The zone to obtain the effective limit from
504e49471b0SAndre Oppermann  *
505e49471b0SAndre Oppermann  * Return:
506e49471b0SAndre Oppermann  *	0  No limit
507e49471b0SAndre Oppermann  *	int  The effective limit of the zone
508e49471b0SAndre Oppermann  */
509e49471b0SAndre Oppermann int uma_zone_get_max(uma_zone_t zone);
510e49471b0SAndre Oppermann 
511e49471b0SAndre Oppermann /*
5122f891cd5SPawel Jakub Dawidek  * Sets a warning to be printed when limit is reached
5132f891cd5SPawel Jakub Dawidek  *
5142f891cd5SPawel Jakub Dawidek  * Arguments:
5152f891cd5SPawel Jakub Dawidek  *	zone  The zone we will warn about
5162f891cd5SPawel Jakub Dawidek  *	warning  Warning content
5172f891cd5SPawel Jakub Dawidek  *
5182f891cd5SPawel Jakub Dawidek  * Returns:
5192f891cd5SPawel Jakub Dawidek  *	Nothing
5202f891cd5SPawel Jakub Dawidek  */
5212f891cd5SPawel Jakub Dawidek void uma_zone_set_warning(uma_zone_t zone, const char *warning);
5222f891cd5SPawel Jakub Dawidek 
5232f891cd5SPawel Jakub Dawidek /*
52454503a13SJonathan T. Looney  * Sets a function to run when limit is reached
52554503a13SJonathan T. Looney  *
52654503a13SJonathan T. Looney  * Arguments:
52754503a13SJonathan T. Looney  *	zone  The zone to which this applies
52854503a13SJonathan T. Looney  *	fx  The function ro run
52954503a13SJonathan T. Looney  *
53054503a13SJonathan T. Looney  * Returns:
53154503a13SJonathan T. Looney  *	Nothing
53254503a13SJonathan T. Looney  */
533e60b2fcbSGleb Smirnoff typedef void (*uma_maxaction_t)(uma_zone_t, int);
53454503a13SJonathan T. Looney void uma_zone_set_maxaction(uma_zone_t zone, uma_maxaction_t);
53554503a13SJonathan T. Looney 
53654503a13SJonathan T. Looney /*
537c4ae7908SLawrence Stewart  * Obtains the approximate current number of items allocated from a zone
538c4ae7908SLawrence Stewart  *
539c4ae7908SLawrence Stewart  * Arguments:
540c4ae7908SLawrence Stewart  *	zone  The zone to obtain the current allocation count from
541c4ae7908SLawrence Stewart  *
542c4ae7908SLawrence Stewart  * Return:
543c4ae7908SLawrence Stewart  *	int  The approximate current number of items allocated from the zone
544c4ae7908SLawrence Stewart  */
545c4ae7908SLawrence Stewart int uma_zone_get_cur(uma_zone_t zone);
546c4ae7908SLawrence Stewart 
547c4ae7908SLawrence Stewart /*
548099a0e58SBosko Milekic  * The following two routines (uma_zone_set_init/fini)
549099a0e58SBosko Milekic  * are used to set the backend init/fini pair which acts on an
550099a0e58SBosko Milekic  * object as it becomes allocated and is placed in a slab within
551099a0e58SBosko Milekic  * the specified zone's backing keg.  These should probably not
5522db63c5eSGiorgos Keramidas  * be changed once allocations have already begun, but only be set
553099a0e58SBosko Milekic  * immediately upon zone creation.
554099a0e58SBosko Milekic  */
555099a0e58SBosko Milekic void uma_zone_set_init(uma_zone_t zone, uma_init uminit);
556099a0e58SBosko Milekic void uma_zone_set_fini(uma_zone_t zone, uma_fini fini);
557099a0e58SBosko Milekic 
558099a0e58SBosko Milekic /*
559099a0e58SBosko Milekic  * The following two routines (uma_zone_set_zinit/zfini) are
560099a0e58SBosko Milekic  * used to set the zinit/zfini pair which acts on an object as
561099a0e58SBosko Milekic  * it passes from the backing Keg's slab cache to the
562099a0e58SBosko Milekic  * specified Zone's bucket cache.  These should probably not
5632db63c5eSGiorgos Keramidas  * be changed once allocations have already begun, but only be set
5642db63c5eSGiorgos Keramidas  * immediately upon zone creation.
565099a0e58SBosko Milekic  */
566099a0e58SBosko Milekic void uma_zone_set_zinit(uma_zone_t zone, uma_init zinit);
567099a0e58SBosko Milekic void uma_zone_set_zfini(uma_zone_t zone, uma_fini zfini);
568099a0e58SBosko Milekic 
569099a0e58SBosko Milekic /*
570a4915c21SAttilio Rao  * Replaces the standard backend allocator for this zone.
5718355f576SJeff Roberson  *
5728355f576SJeff Roberson  * Arguments:
5732db63c5eSGiorgos Keramidas  *	zone   The zone whose backend allocator is being changed.
5748355f576SJeff Roberson  *	allocf A pointer to the allocation function
5758355f576SJeff Roberson  *
5768355f576SJeff Roberson  * Returns:
5778355f576SJeff Roberson  *	Nothing
5788355f576SJeff Roberson  *
5798355f576SJeff Roberson  * Discussion:
5808355f576SJeff Roberson  *	This could be used to implement pageable allocation, or perhaps
5818355f576SJeff Roberson  *	even DMA allocators if used in conjunction with the OFFPAGE
5828355f576SJeff Roberson  *	zone flag.
5838355f576SJeff Roberson  */
5848355f576SJeff Roberson 
5858355f576SJeff Roberson void uma_zone_set_allocf(uma_zone_t zone, uma_alloc allocf);
5868355f576SJeff Roberson 
5878355f576SJeff Roberson /*
5888355f576SJeff Roberson  * Used for freeing memory provided by the allocf above
5898355f576SJeff Roberson  *
5908355f576SJeff Roberson  * Arguments:
5918355f576SJeff Roberson  *	zone  The zone that intends to use this free routine.
5928355f576SJeff Roberson  *	freef The page freeing routine.
5938355f576SJeff Roberson  *
5948355f576SJeff Roberson  * Returns:
5958355f576SJeff Roberson  *	Nothing
5968355f576SJeff Roberson  */
5978355f576SJeff Roberson 
5988355f576SJeff Roberson void uma_zone_set_freef(uma_zone_t zone, uma_free freef);
5998355f576SJeff Roberson 
6008355f576SJeff Roberson /*
6012db63c5eSGiorgos Keramidas  * These flags are setable in the allocf and visible in the freef.
6028355f576SJeff Roberson  */
6038355f576SJeff Roberson #define UMA_SLAB_BOOT	0x01		/* Slab alloced from boot pages */
6047630c265SAlan Cox #define UMA_SLAB_KERNEL	0x04		/* Slab alloced from kernel_map */
6058355f576SJeff Roberson #define UMA_SLAB_PRIV	0x08		/* Slab alloced from priv allocator */
606c235bfa5SJeff Roberson #define UMA_SLAB_OFFP	0x10		/* Slab is managed separately  */
6078355f576SJeff Roberson #define UMA_SLAB_MALLOC	0x20		/* Slab is a large malloc slab */
6082e47807cSJeff Roberson /* 0x02, 0x40 and 0x80 are available */
6098355f576SJeff Roberson 
6108355f576SJeff Roberson /*
6118355f576SJeff Roberson  * Used to pre-fill a zone with some number of items
6128355f576SJeff Roberson  *
6138355f576SJeff Roberson  * Arguments:
6148355f576SJeff Roberson  *	zone    The zone to fill
6158355f576SJeff Roberson  *	itemcnt The number of items to reserve
6168355f576SJeff Roberson  *
6178355f576SJeff Roberson  * Returns:
6188355f576SJeff Roberson  *	Nothing
6198355f576SJeff Roberson  *
6208355f576SJeff Roberson  * NOTE: This is blocking and should only be done at startup
6218355f576SJeff Roberson  */
6228355f576SJeff Roberson void uma_prealloc(uma_zone_t zone, int itemcnt);
6238355f576SJeff Roberson 
624099a0e58SBosko Milekic /*
625663b416fSJohn Baldwin  * Used to determine if a fixed-size zone is exhausted.
626663b416fSJohn Baldwin  *
627663b416fSJohn Baldwin  * Arguments:
628663b416fSJohn Baldwin  *	zone    The zone to check
629663b416fSJohn Baldwin  *
630663b416fSJohn Baldwin  * Returns:
631663b416fSJohn Baldwin  *	Non-zero if zone is exhausted.
632663b416fSJohn Baldwin  */
633663b416fSJohn Baldwin int uma_zone_exhausted(uma_zone_t zone);
6346c125b8dSMohan Srinivasan int uma_zone_exhausted_nolock(uma_zone_t zone);
635663b416fSJohn Baldwin 
636663b416fSJohn Baldwin /*
63749fef6a2SGleb Smirnoff  * Common UMA_ZONE_PCPU zones.
63849fef6a2SGleb Smirnoff  */
63949fef6a2SGleb Smirnoff extern uma_zone_t pcpu_zone_64;
64049fef6a2SGleb Smirnoff extern uma_zone_t pcpu_zone_ptr;
64149fef6a2SGleb Smirnoff 
64249fef6a2SGleb Smirnoff /*
6437a52a97eSRobert Watson  * Exported statistics structures to be used by user space monitoring tools.
6442db63c5eSGiorgos Keramidas  * Statistics stream consists of a uma_stream_header, followed by a series of
6452db63c5eSGiorgos Keramidas  * alternative uma_type_header and uma_type_stat structures.
6467a52a97eSRobert Watson  */
6477a52a97eSRobert Watson #define	UMA_STREAM_VERSION	0x00000001
6487a52a97eSRobert Watson struct uma_stream_header {
64985dcf349SGleb Smirnoff 	uint32_t	ush_version;	/* Stream format version. */
65085dcf349SGleb Smirnoff 	uint32_t	ush_maxcpus;	/* Value of MAXCPU for stream. */
65185dcf349SGleb Smirnoff 	uint32_t	ush_count;	/* Number of records. */
65285dcf349SGleb Smirnoff 	uint32_t	_ush_pad;	/* Pad/reserved field. */
6537a52a97eSRobert Watson };
6547a52a97eSRobert Watson 
655cbbb4a00SRobert Watson #define	UTH_MAX_NAME	32
656cbbb4a00SRobert Watson #define	UTH_ZONE_SECONDARY	0x00000001
6577a52a97eSRobert Watson struct uma_type_header {
6587a52a97eSRobert Watson 	/*
6597a52a97eSRobert Watson 	 * Static per-zone data, some extracted from the supporting keg.
6607a52a97eSRobert Watson 	 */
661cbbb4a00SRobert Watson 	char		uth_name[UTH_MAX_NAME];
66285dcf349SGleb Smirnoff 	uint32_t	uth_align;	/* Keg: alignment. */
66385dcf349SGleb Smirnoff 	uint32_t	uth_size;	/* Keg: requested size of item. */
66485dcf349SGleb Smirnoff 	uint32_t	uth_rsize;	/* Keg: real size of item. */
66585dcf349SGleb Smirnoff 	uint32_t	uth_maxpages;	/* Keg: maximum number of pages. */
66685dcf349SGleb Smirnoff 	uint32_t	uth_limit;	/* Keg: max items to allocate. */
6677a52a97eSRobert Watson 
6687a52a97eSRobert Watson 	/*
6697a52a97eSRobert Watson 	 * Current dynamic zone/keg-derived statistics.
6707a52a97eSRobert Watson 	 */
67185dcf349SGleb Smirnoff 	uint32_t	uth_pages;	/* Keg: pages allocated. */
67285dcf349SGleb Smirnoff 	uint32_t	uth_keg_free;	/* Keg: items free. */
67385dcf349SGleb Smirnoff 	uint32_t	uth_zone_free;	/* Zone: items free. */
67485dcf349SGleb Smirnoff 	uint32_t	uth_bucketsize;	/* Zone: desired bucket size. */
67585dcf349SGleb Smirnoff 	uint32_t	uth_zone_flags;	/* Zone: flags. */
67685dcf349SGleb Smirnoff 	uint64_t	uth_allocs;	/* Zone: number of allocations. */
67785dcf349SGleb Smirnoff 	uint64_t	uth_frees;	/* Zone: number of frees. */
67885dcf349SGleb Smirnoff 	uint64_t	uth_fails;	/* Zone: number of alloc failures. */
67985dcf349SGleb Smirnoff 	uint64_t	uth_sleeps;	/* Zone: number of alloc sleeps. */
68085dcf349SGleb Smirnoff 	uint64_t	_uth_reserved1[2];	/* Reserved. */
6817a52a97eSRobert Watson };
6827a52a97eSRobert Watson 
6837a52a97eSRobert Watson struct uma_percpu_stat {
68485dcf349SGleb Smirnoff 	uint64_t	ups_allocs;	/* Cache: number of allocations. */
68585dcf349SGleb Smirnoff 	uint64_t	ups_frees;	/* Cache: number of frees. */
68685dcf349SGleb Smirnoff 	uint64_t	ups_cache_free;	/* Cache: free items in cache. */
68785dcf349SGleb Smirnoff 	uint64_t	_ups_reserved[5];	/* Reserved. */
6887a52a97eSRobert Watson };
6897a52a97eSRobert Watson 
69044ec2b63SKonstantin Belousov void uma_reclaim_wakeup(void);
69144ec2b63SKonstantin Belousov void uma_reclaim_worker(void *);
69244ec2b63SKonstantin Belousov 
693ad5b0f5bSJeff Roberson unsigned long uma_limit(void);
694ad5b0f5bSJeff Roberson 
695ad5b0f5bSJeff Roberson /* Return the amount of memory managed by UMA. */
696ad5b0f5bSJeff Roberson unsigned long uma_size(void);
697ad5b0f5bSJeff Roberson 
698ad5b0f5bSJeff Roberson /* Return the amount of memory remaining.  May be negative. */
699ad5b0f5bSJeff Roberson long uma_avail(void);
700ad5b0f5bSJeff Roberson 
701f947570eSGleb Smirnoff #endif	/* _VM_UMA_H_ */
702