xref: /freebsd/sys/vm/uma.h (revision eac7052fdebb90caf2f653e06187bdbca837b9c7)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2002, 2003, 2004, 2005 Jeffrey Roberson <jeff@FreeBSD.org>
5  * Copyright (c) 2004, 2005 Bosko Milekic <bmilekic@FreeBSD.org>
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice unmodified, this list of conditions, and the following
13  *    disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  *
29  * $FreeBSD$
30  *
31  */
32 
33 /*
34  * uma.h - External definitions for the Universal Memory Allocator
35  *
36 */
37 
38 #ifndef _VM_UMA_H_
39 #define _VM_UMA_H_
40 
41 #include <sys/param.h>		/* For NULL */
42 #include <sys/malloc.h>		/* For M_* */
43 #include <sys/_smr.h>
44 
45 /* User visible parameters */
46 #define	UMA_SMALLEST_UNIT	8 /* Smallest item allocated */
47 
48 /* Types and type defs */
49 
50 struct uma_zone;
51 /* Opaque type used as a handle to the zone */
52 typedef struct uma_zone * uma_zone_t;
53 
54 /*
55  * Item constructor
56  *
57  * Arguments:
58  *	item  A pointer to the memory which has been allocated.
59  *	arg   The arg field passed to uma_zalloc_arg
60  *	size  The size of the allocated item
61  *	flags See zalloc flags
62  *
63  * Returns:
64  *	0      on success
65  *      errno  on failure
66  *
67  * Discussion:
68  *	The constructor is called just before the memory is returned
69  *	to the user. It may block if necessary.
70  */
71 typedef int (*uma_ctor)(void *mem, int size, void *arg, int flags);
72 
73 /*
74  * Item destructor
75  *
76  * Arguments:
77  *	item  A pointer to the memory which has been allocated.
78  *	size  The size of the item being destructed.
79  *	arg   Argument passed through uma_zfree_arg
80  *
81  * Returns:
82  *	Nothing
83  *
84  * Discussion:
85  *	The destructor may perform operations that differ from those performed
86  *	by the initializer, but it must leave the object in the same state.
87  *	This IS type stable storage.  This is called after EVERY zfree call.
88  */
89 typedef void (*uma_dtor)(void *mem, int size, void *arg);
90 
91 /*
92  * Item initializer
93  *
94  * Arguments:
95  *	item  A pointer to the memory which has been allocated.
96  *	size  The size of the item being initialized.
97  *	flags See zalloc flags
98  *
99  * Returns:
100  *	0      on success
101  *      errno  on failure
102  *
103  * Discussion:
104  *	The initializer is called when the memory is cached in the uma zone.
105  *	The initializer and the destructor should leave the object in the same
106  *	state.
107  */
108 typedef int (*uma_init)(void *mem, int size, int flags);
109 
110 /*
111  * Item discard function
112  *
113  * Arguments:
114  *	item  A pointer to memory which has been 'freed' but has not left the
115  *	      zone's cache.
116  *	size  The size of the item being discarded.
117  *
118  * Returns:
119  *	Nothing
120  *
121  * Discussion:
122  *	This routine is called when memory leaves a zone and is returned to the
123  *	system for other uses.  It is the counter-part to the init function.
124  */
125 typedef void (*uma_fini)(void *mem, int size);
126 
127 /*
128  * Import new memory into a cache zone.
129  */
130 typedef int (*uma_import)(void *arg, void **store, int count, int domain,
131     int flags);
132 
133 /*
134  * Free memory from a cache zone.
135  */
136 typedef void (*uma_release)(void *arg, void **store, int count);
137 
138 /*
139  * What's the difference between initializing and constructing?
140  *
141  * The item is initialized when it is cached, and this is the state that the
142  * object should be in when returned to the allocator. The purpose of this is
143  * to remove some code which would otherwise be called on each allocation by
144  * utilizing a known, stable state.  This differs from the constructor which
145  * will be called on EVERY allocation.
146  *
147  * For example, in the initializer you may want to initialize embedded locks,
148  * NULL list pointers, set up initial states, magic numbers, etc.  This way if
149  * the object is held in the allocator and re-used it won't be necessary to
150  * re-initialize it.
151  *
152  * The constructor may be used to lock a data structure, link it on to lists,
153  * bump reference counts or total counts of outstanding structures, etc.
154  *
155  */
156 
157 /* Function proto types */
158 
159 /*
160  * Create a new uma zone
161  *
162  * Arguments:
163  *	name  The text name of the zone for debugging and stats. This memory
164  *		should not be freed until the zone has been deallocated.
165  *	size  The size of the object that is being created.
166  *	ctor  The constructor that is called when the object is allocated.
167  *	dtor  The destructor that is called when the object is freed.
168  *	init  An initializer that sets up the initial state of the memory.
169  *	fini  A discard function that undoes initialization done by init.
170  *		ctor/dtor/init/fini may all be null, see notes above.
171  *	align A bitmask that corresponds to the requested alignment
172  *		eg 4 would be 0x3
173  *	flags A set of parameters that control the behavior of the zone.
174  *
175  * Returns:
176  *	A pointer to a structure which is intended to be opaque to users of
177  *	the interface.  The value may be null if the wait flag is not set.
178  */
179 uma_zone_t uma_zcreate(const char *name, size_t size, uma_ctor ctor,
180 		    uma_dtor dtor, uma_init uminit, uma_fini fini,
181 		    int align, uint32_t flags);
182 
183 /*
184  * Create a secondary uma zone
185  *
186  * Arguments:
187  *	name  The text name of the zone for debugging and stats. This memory
188  *		should not be freed until the zone has been deallocated.
189  *	ctor  The constructor that is called when the object is allocated.
190  *	dtor  The destructor that is called when the object is freed.
191  *	zinit  An initializer that sets up the initial state of the memory
192  *		as the object passes from the Keg's slab to the Zone's cache.
193  *	zfini  A discard function that undoes initialization done by init
194  *		as the object passes from the Zone's cache to the Keg's slab.
195  *
196  *		ctor/dtor/zinit/zfini may all be null, see notes above.
197  *		Note that the zinit and zfini specified here are NOT
198  *		exactly the same as the init/fini specified to uma_zcreate()
199  *		when creating a primary zone.  These zinit/zfini are called
200  *		on the TRANSITION from keg to zone (and vice-versa). Once
201  *		these are set, the primary zone may alter its init/fini
202  *		(which are called when the object passes from VM to keg)
203  *		using uma_zone_set_init/fini()) as well as its own
204  *		zinit/zfini (unset by default for primary zone) with
205  *		uma_zone_set_zinit/zfini() (note subtle 'z' prefix).
206  *
207  *	primary A reference to this zone's Primary Zone which contains the
208  *		backing Keg for the Secondary Zone being added.
209  *
210  * Returns:
211  *	A pointer to a structure which is intended to be opaque to users of
212  *	the interface.  The value may be null if the wait flag is not set.
213  */
214 uma_zone_t uma_zsecond_create(const char *name, uma_ctor ctor, uma_dtor dtor,
215     uma_init zinit, uma_fini zfini, uma_zone_t primary);
216 
217 /*
218  * Create cache-only zones.
219  *
220  * This allows uma's per-cpu cache facilities to handle arbitrary
221  * pointers.  Consumers must specify the import and release functions to
222  * fill and destroy caches.  UMA does not allocate any memory for these
223  * zones.  The 'arg' parameter is passed to import/release and is caller
224  * specific.
225  */
226 uma_zone_t uma_zcache_create(const char *name, int size, uma_ctor ctor,
227     uma_dtor dtor, uma_init zinit, uma_fini zfini, uma_import zimport,
228     uma_release zrelease, void *arg, int flags);
229 
230 /*
231  * Definitions for uma_zcreate flags
232  *
233  * These flags share space with UMA_ZFLAGs in uma_int.h.  Be careful not to
234  * overlap when adding new features.
235  */
236 #define UMA_ZONE_ZINIT		0x0002	/* Initialize with zeros */
237 #define UMA_ZONE_CONTIG		0x0004	/*
238 					 * Physical memory underlying an object
239 					 * must be contiguous.
240 					 */
241 #define UMA_ZONE_NOTOUCH	0x0008	/* UMA may not access the memory */
242 #define UMA_ZONE_MALLOC		0x0010	/* For use by malloc(9) only! */
243 #define UMA_ZONE_NOFREE		0x0020	/* Do not free slabs of this type! */
244 #define UMA_ZONE_MTXCLASS	0x0040	/* Create a new lock class */
245 #define	UMA_ZONE_VM		0x0080	/*
246 					 * Used for internal vm datastructures
247 					 * only.
248 					 */
249 #define	UMA_ZONE_NOTPAGE	0x0100	/* allocf memory not vm pages */
250 #define	UMA_ZONE_SECONDARY	0x0200	/* Zone is a Secondary Zone */
251 #define	UMA_ZONE_NOBUCKET	0x0400	/* Do not use buckets. */
252 #define	UMA_ZONE_MAXBUCKET	0x0800	/* Use largest buckets. */
253 #define	UMA_ZONE_MINBUCKET	0x1000	/* Use smallest buckets. */
254 #define	UMA_ZONE_CACHESPREAD	0x2000	/*
255 					 * Spread memory start locations across
256 					 * all possible cache lines.  May
257 					 * require many virtually contiguous
258 					 * backend pages and can fail early.
259 					 */
260 #define	UMA_ZONE_NODUMP		0x4000	/*
261 					 * Zone's pages will not be included in
262 					 * mini-dumps.
263 					 */
264 #define	UMA_ZONE_PCPU		0x8000	/*
265 					 * Allocates mp_maxid + 1 slabs of
266 					 * PAGE_SIZE
267 					 */
268 #define	UMA_ZONE_FIRSTTOUCH	0x10000	/* First touch NUMA policy */
269 #define	UMA_ZONE_ROUNDROBIN	0x20000	/* Round-robin NUMA policy. */
270 #define	UMA_ZONE_SMR		0x40000 /*
271 					 * Safe memory reclamation defers
272 					 * frees until all read sections
273 					 * have exited.  This flag creates
274 					 * a unique SMR context for this
275 					 * zone.  To share contexts see
276 					 * uma_zone_set_smr() below.
277 					 *
278 					 * See sys/smr.h for more details.
279 					 */
280 /* In use by UMA_ZFLAGs:	0xffe00000 */
281 
282 /*
283  * These flags are shared between the keg and zone.  Some are determined
284  * based on physical parameters of the request and may not be provided by
285  * the consumer.
286  */
287 #define	UMA_ZONE_INHERIT						\
288     (UMA_ZONE_NOTOUCH | UMA_ZONE_MALLOC | UMA_ZONE_NOFREE |		\
289      UMA_ZONE_VM | UMA_ZONE_NOTPAGE | UMA_ZONE_PCPU |			\
290      UMA_ZONE_FIRSTTOUCH | UMA_ZONE_ROUNDROBIN)
291 
292 /* Definitions for align */
293 #define UMA_ALIGN_PTR	(sizeof(void *) - 1)	/* Alignment fit for ptr */
294 #define UMA_ALIGN_LONG	(sizeof(long) - 1)	/* "" long */
295 #define UMA_ALIGN_INT	(sizeof(int) - 1)	/* "" int */
296 #define UMA_ALIGN_SHORT	(sizeof(short) - 1)	/* "" short */
297 #define UMA_ALIGN_CHAR	(sizeof(char) - 1)	/* "" char */
298 #define UMA_ALIGN_CACHE	(0 - 1)			/* Cache line size align */
299 #define	UMA_ALIGNOF(type) (_Alignof(type) - 1)	/* Alignment fit for 'type' */
300 
301 #define	UMA_ANYDOMAIN	-1	/* Special value for domain search. */
302 
303 /*
304  * Destroys an empty uma zone.  If the zone is not empty uma complains loudly.
305  *
306  * Arguments:
307  *	zone  The zone we want to destroy.
308  *
309  */
310 void uma_zdestroy(uma_zone_t zone);
311 
312 /*
313  * Allocates an item out of a zone
314  *
315  * Arguments:
316  *	zone  The zone we are allocating from
317  *	arg   This data is passed to the ctor function
318  *	flags See sys/malloc.h for available flags.
319  *
320  * Returns:
321  *	A non-null pointer to an initialized element from the zone is
322  *	guaranteed if the wait flag is M_WAITOK.  Otherwise a null pointer
323  *	may be returned if the zone is empty or the ctor failed.
324  */
325 
326 void *uma_zalloc_arg(uma_zone_t zone, void *arg, int flags);
327 
328 /* Allocate per-cpu data.  Access the correct data with zpcpu_get(). */
329 void *uma_zalloc_pcpu_arg(uma_zone_t zone, void *arg, int flags);
330 
331 /* Use with SMR zones. */
332 void *uma_zalloc_smr(uma_zone_t zone, int flags);
333 
334 /*
335  * Allocate an item from a specific NUMA domain.  This uses a slow path in
336  * the allocator but is guaranteed to allocate memory from the requested
337  * domain if M_WAITOK is set.
338  *
339  * Arguments:
340  *	zone  The zone we are allocating from
341  *	arg   This data is passed to the ctor function
342  *	domain The domain to allocate from.
343  *	flags See sys/malloc.h for available flags.
344  */
345 void *uma_zalloc_domain(uma_zone_t zone, void *arg, int domain, int flags);
346 
347 /*
348  * Allocates an item out of a zone without supplying an argument
349  *
350  * This is just a wrapper for uma_zalloc_arg for convenience.
351  *
352  */
353 static __inline void *uma_zalloc(uma_zone_t zone, int flags);
354 static __inline void *uma_zalloc_pcpu(uma_zone_t zone, int flags);
355 
356 static __inline void *
357 uma_zalloc(uma_zone_t zone, int flags)
358 {
359 	return uma_zalloc_arg(zone, NULL, flags);
360 }
361 
362 static __inline void *
363 uma_zalloc_pcpu(uma_zone_t zone, int flags)
364 {
365 	return uma_zalloc_pcpu_arg(zone, NULL, flags);
366 }
367 
368 /*
369  * Frees an item back into the specified zone.
370  *
371  * Arguments:
372  *	zone  The zone the item was originally allocated out of.
373  *	item  The memory to be freed.
374  *	arg   Argument passed to the destructor
375  *
376  * Returns:
377  *	Nothing.
378  */
379 
380 void uma_zfree_arg(uma_zone_t zone, void *item, void *arg);
381 
382 /* Use with PCPU zones. */
383 void uma_zfree_pcpu_arg(uma_zone_t zone, void *item, void *arg);
384 
385 /* Use with SMR zones. */
386 void uma_zfree_smr(uma_zone_t zone, void *item);
387 
388 /*
389  * Frees an item back to a zone without supplying an argument
390  *
391  * This is just a wrapper for uma_zfree_arg for convenience.
392  *
393  */
394 static __inline void uma_zfree(uma_zone_t zone, void *item);
395 static __inline void uma_zfree_pcpu(uma_zone_t zone, void *item);
396 
397 static __inline void
398 uma_zfree(uma_zone_t zone, void *item)
399 {
400 	uma_zfree_arg(zone, item, NULL);
401 }
402 
403 static __inline void
404 uma_zfree_pcpu(uma_zone_t zone, void *item)
405 {
406 	uma_zfree_pcpu_arg(zone, item, NULL);
407 }
408 
409 /*
410  * Wait until the specified zone can allocate an item.
411  */
412 void uma_zwait(uma_zone_t zone);
413 
414 /*
415  * Backend page supplier routines
416  *
417  * Arguments:
418  *	zone  The zone that is requesting pages.
419  *	size  The number of bytes being requested.
420  *	pflag Flags for these memory pages, see below.
421  *	domain The NUMA domain that we prefer for this allocation.
422  *	wait  Indicates our willingness to block.
423  *
424  * Returns:
425  *	A pointer to the allocated memory or NULL on failure.
426  */
427 
428 typedef void *(*uma_alloc)(uma_zone_t zone, vm_size_t size, int domain,
429     uint8_t *pflag, int wait);
430 
431 /*
432  * Backend page free routines
433  *
434  * Arguments:
435  *	item  A pointer to the previously allocated pages.
436  *	size  The original size of the allocation.
437  *	pflag The flags for the slab.  See UMA_SLAB_* below.
438  *
439  * Returns:
440  *	None
441  */
442 typedef void (*uma_free)(void *item, vm_size_t size, uint8_t pflag);
443 
444 /*
445  * Reclaims unused memory
446  *
447  * Arguments:
448  *	req  Reclamation request type.
449  * Returns:
450  *	None
451  */
452 #define	UMA_RECLAIM_DRAIN	1	/* release bucket cache */
453 #define	UMA_RECLAIM_DRAIN_CPU	2	/* release bucket and per-CPU caches */
454 #define	UMA_RECLAIM_TRIM	3	/* trim bucket cache to WSS */
455 void uma_reclaim(int req);
456 void uma_zone_reclaim(uma_zone_t, int req);
457 
458 /*
459  * Sets the alignment mask to be used for all zones requesting cache
460  * alignment.  Should be called by MD boot code prior to starting VM/UMA.
461  *
462  * Arguments:
463  *	align The alignment mask
464  *
465  * Returns:
466  *	Nothing
467  */
468 void uma_set_align(int align);
469 
470 /*
471  * Set a reserved number of items to hold for M_USE_RESERVE allocations.  All
472  * other requests must allocate new backing pages.
473  */
474 void uma_zone_reserve(uma_zone_t zone, int nitems);
475 
476 /*
477  * Reserves the maximum KVA space required by the zone and configures the zone
478  * to use a VM_ALLOC_NOOBJ-based backend allocator.
479  *
480  * Arguments:
481  *	zone  The zone to update.
482  *	nitems  The upper limit on the number of items that can be allocated.
483  *
484  * Returns:
485  *	0  if KVA space can not be allocated
486  *	1  if successful
487  *
488  * Discussion:
489  *	When the machine supports a direct map and the zone's items are smaller
490  *	than a page, the zone will use the direct map instead of allocating KVA
491  *	space.
492  */
493 int uma_zone_reserve_kva(uma_zone_t zone, int nitems);
494 
495 /*
496  * Sets a high limit on the number of items allowed in a zone
497  *
498  * Arguments:
499  *	zone  The zone to limit
500  *	nitems  The requested upper limit on the number of items allowed
501  *
502  * Returns:
503  *	int  The effective value of nitems
504  */
505 int uma_zone_set_max(uma_zone_t zone, int nitems);
506 
507 /*
508  * Sets a high limit on the number of items allowed in zone's bucket cache
509  *
510  * Arguments:
511  *      zone  The zone to limit
512  *      nitems  The requested upper limit on the number of items allowed
513  */
514 void uma_zone_set_maxcache(uma_zone_t zone, int nitems);
515 
516 /*
517  * Obtains the effective limit on the number of items in a zone
518  *
519  * Arguments:
520  *	zone  The zone to obtain the effective limit from
521  *
522  * Return:
523  *	0  No limit
524  *	int  The effective limit of the zone
525  */
526 int uma_zone_get_max(uma_zone_t zone);
527 
528 /*
529  * Sets a warning to be printed when limit is reached
530  *
531  * Arguments:
532  *	zone  The zone we will warn about
533  *	warning  Warning content
534  *
535  * Returns:
536  *	Nothing
537  */
538 void uma_zone_set_warning(uma_zone_t zone, const char *warning);
539 
540 /*
541  * Sets a function to run when limit is reached
542  *
543  * Arguments:
544  *	zone  The zone to which this applies
545  *	fx  The function ro run
546  *
547  * Returns:
548  *	Nothing
549  */
550 typedef void (*uma_maxaction_t)(uma_zone_t, int);
551 void uma_zone_set_maxaction(uma_zone_t zone, uma_maxaction_t);
552 
553 /*
554  * Obtains the approximate current number of items allocated from a zone
555  *
556  * Arguments:
557  *	zone  The zone to obtain the current allocation count from
558  *
559  * Return:
560  *	int  The approximate current number of items allocated from the zone
561  */
562 int uma_zone_get_cur(uma_zone_t zone);
563 
564 /*
565  * The following two routines (uma_zone_set_init/fini)
566  * are used to set the backend init/fini pair which acts on an
567  * object as it becomes allocated and is placed in a slab within
568  * the specified zone's backing keg.  These should probably not
569  * be changed once allocations have already begun, but only be set
570  * immediately upon zone creation.
571  */
572 void uma_zone_set_init(uma_zone_t zone, uma_init uminit);
573 void uma_zone_set_fini(uma_zone_t zone, uma_fini fini);
574 
575 /*
576  * The following two routines (uma_zone_set_zinit/zfini) are
577  * used to set the zinit/zfini pair which acts on an object as
578  * it passes from the backing Keg's slab cache to the
579  * specified Zone's bucket cache.  These should probably not
580  * be changed once allocations have already begun, but only be set
581  * immediately upon zone creation.
582  */
583 void uma_zone_set_zinit(uma_zone_t zone, uma_init zinit);
584 void uma_zone_set_zfini(uma_zone_t zone, uma_fini zfini);
585 
586 /*
587  * Replaces the standard backend allocator for this zone.
588  *
589  * Arguments:
590  *	zone   The zone whose backend allocator is being changed.
591  *	allocf A pointer to the allocation function
592  *
593  * Returns:
594  *	Nothing
595  *
596  * Discussion:
597  *	This could be used to implement pageable allocation, or perhaps
598  *	even DMA allocators if used in conjunction with the OFFPAGE
599  *	zone flag.
600  */
601 
602 void uma_zone_set_allocf(uma_zone_t zone, uma_alloc allocf);
603 
604 /*
605  * Used for freeing memory provided by the allocf above
606  *
607  * Arguments:
608  *	zone  The zone that intends to use this free routine.
609  *	freef The page freeing routine.
610  *
611  * Returns:
612  *	Nothing
613  */
614 
615 void uma_zone_set_freef(uma_zone_t zone, uma_free freef);
616 
617 /*
618  * Associate a zone with a smr context that is allocated after creation
619  * so that multiple zones may share the same context.
620  */
621 void uma_zone_set_smr(uma_zone_t zone, smr_t smr);
622 
623 /*
624  * Fetch the smr context that was set or made in uma_zcreate().
625  */
626 smr_t uma_zone_get_smr(uma_zone_t zone);
627 
628 /*
629  * These flags are setable in the allocf and visible in the freef.
630  */
631 #define UMA_SLAB_BOOT	0x01		/* Slab alloced from boot pages */
632 #define UMA_SLAB_KERNEL	0x04		/* Slab alloced from kmem */
633 #define UMA_SLAB_PRIV	0x08		/* Slab alloced from priv allocator */
634 /* 0x02, 0x10, 0x40, and 0x80 are available */
635 
636 /*
637  * Used to pre-fill a zone with some number of items
638  *
639  * Arguments:
640  *	zone    The zone to fill
641  *	itemcnt The number of items to reserve
642  *
643  * Returns:
644  *	Nothing
645  *
646  * NOTE: This is blocking and should only be done at startup
647  */
648 void uma_prealloc(uma_zone_t zone, int itemcnt);
649 
650 /*
651  * Used to determine if a fixed-size zone is exhausted.
652  *
653  * Arguments:
654  *	zone    The zone to check
655  *
656  * Returns:
657  *	Non-zero if zone is exhausted.
658  */
659 int uma_zone_exhausted(uma_zone_t zone);
660 
661 /*
662  * Returns the bytes of memory consumed by the zone.
663  */
664 size_t uma_zone_memory(uma_zone_t zone);
665 
666 /*
667  * Common UMA_ZONE_PCPU zones.
668  */
669 extern uma_zone_t pcpu_zone_int;
670 extern uma_zone_t pcpu_zone_64;
671 
672 /*
673  * Exported statistics structures to be used by user space monitoring tools.
674  * Statistics stream consists of a uma_stream_header, followed by a series of
675  * alternative uma_type_header and uma_type_stat structures.
676  */
677 #define	UMA_STREAM_VERSION	0x00000001
678 struct uma_stream_header {
679 	uint32_t	ush_version;	/* Stream format version. */
680 	uint32_t	ush_maxcpus;	/* Value of MAXCPU for stream. */
681 	uint32_t	ush_count;	/* Number of records. */
682 	uint32_t	_ush_pad;	/* Pad/reserved field. */
683 };
684 
685 #define	UTH_MAX_NAME	32
686 #define	UTH_ZONE_SECONDARY	0x00000001
687 struct uma_type_header {
688 	/*
689 	 * Static per-zone data, some extracted from the supporting keg.
690 	 */
691 	char		uth_name[UTH_MAX_NAME];
692 	uint32_t	uth_align;	/* Keg: alignment. */
693 	uint32_t	uth_size;	/* Keg: requested size of item. */
694 	uint32_t	uth_rsize;	/* Keg: real size of item. */
695 	uint32_t	uth_maxpages;	/* Keg: maximum number of pages. */
696 	uint32_t	uth_limit;	/* Keg: max items to allocate. */
697 
698 	/*
699 	 * Current dynamic zone/keg-derived statistics.
700 	 */
701 	uint32_t	uth_pages;	/* Keg: pages allocated. */
702 	uint32_t	uth_keg_free;	/* Keg: items free. */
703 	uint32_t	uth_zone_free;	/* Zone: items free. */
704 	uint32_t	uth_bucketsize;	/* Zone: desired bucket size. */
705 	uint32_t	uth_zone_flags;	/* Zone: flags. */
706 	uint64_t	uth_allocs;	/* Zone: number of allocations. */
707 	uint64_t	uth_frees;	/* Zone: number of frees. */
708 	uint64_t	uth_fails;	/* Zone: number of alloc failures. */
709 	uint64_t	uth_sleeps;	/* Zone: number of alloc sleeps. */
710 	uint64_t	uth_xdomain;	/* Zone: Number of cross domain frees. */
711 	uint64_t	_uth_reserved1[1];	/* Reserved. */
712 };
713 
714 struct uma_percpu_stat {
715 	uint64_t	ups_allocs;	/* Cache: number of allocations. */
716 	uint64_t	ups_frees;	/* Cache: number of frees. */
717 	uint64_t	ups_cache_free;	/* Cache: free items in cache. */
718 	uint64_t	_ups_reserved[5];	/* Reserved. */
719 };
720 
721 void uma_reclaim_wakeup(void);
722 void uma_reclaim_worker(void *);
723 
724 unsigned long uma_limit(void);
725 
726 /* Return the amount of memory managed by UMA. */
727 unsigned long uma_size(void);
728 
729 /* Return the amount of memory remaining.  May be negative. */
730 long uma_avail(void);
731 
732 #endif	/* _VM_UMA_H_ */
733