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