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