Deleted Added
sdiff udiff text old ( 177921 ) new ( 184546 )
full compact
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:

--- 10 unchanged lines hidden (view full) ---

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 177921 2008-04-04 18:41:12Z alc $
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 visable 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

--- 45 unchanged lines hidden (view full) ---

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 * this should be the same state that the destructor leaves the object in.
105 */
106typedef int (*uma_init)(void *mem, int size, int flags);
107
108/*
109 * Item discard function
110 *
111 * Arguments:
112 * item A pointer to memory which has been 'freed' but has not left the
113 * zone's cache.
114 * size The size of the item being discarded.
115 *
116 * Returns:
117 * Nothing
118 *
119 * Discussion:
120 * This routine is called when memory leaves a zone and is returned to the
121 * system for other uses. It is the counter part to the init function.
122 */
123typedef void (*uma_fini)(void *mem, int size);
124
125/*
126 * What's the difference between initializing and constructing?
127 *
128 * The item is initialized when it is cached, and this is the state that the
129 * object should be in when returned to the allocator. The purpose of this is
130 * to remove some code which would otherwise be called on each allocation by
131 * utilizing a known, stable state. This differs from the constructor which
132 * will be called on EVERY allocation.
133 *
134 * For example, in the initializer you may want to initialize embeded locks,
135 * NULL list pointers, set up initial states, magic numbers, etc. This way if
136 * the object is held in the allocator and re-used it won't be necessary to
137 * re-initialize it.
138 *
139 * The constructor may be used to lock a data structure, link it on to lists,
140 * bump reference counts or total counts of outstanding structures, etc.
141 *
142 */
143
144
145/* Function proto types */
146
147/*
148 * Create a new uma zone
149 *
150 * Arguments:
151 * name The text name of the zone for debugging and stats, this memory
152 * should not be freed until the zone has been deallocated.
153 * size The size of the object that is being created.
154 * ctor The constructor that is called when the object is allocated
155 * dtor The destructor that is called when the object is freed.
156 * init An initializer that sets up the initial state of the memory.
157 * fini A discard function that undoes initialization done by init.
158 * ctor/dtor/init/fini may all be null, see notes above.
159 * align A bitmask that corisponds to the requested alignment
160 * eg 4 would be 0x3
161 * flags A set of parameters that control the behavior of the zone
162 *
163 * Returns:
164 * A pointer to a structure which is intended to be opaque to users of
165 * the interface. The value may be null if the wait flag is not set.
166 */
167uma_zone_t uma_zcreate(char *name, size_t size, uma_ctor ctor, uma_dtor dtor,
168 uma_init uminit, uma_fini fini, int align,
169 u_int32_t flags);
170
171/*
172 * Create a secondary uma zone
173 *
174 * Arguments:
175 * name The text name of the zone for debugging and stats, this memory
176 * should not be freed until the zone has been deallocated.
177 * ctor The constructor that is called when the object is allocated
178 * dtor The destructor that is called when the object is freed.
179 * zinit An initializer that sets up the initial state of the memory
180 * as the object passes from the Keg's slab to the Zone's cache.
181 * zfini A discard function that undoes initialization done by init
182 * as the object passes from the Zone's cache to the Keg's slab.
183 *
184 * ctor/dtor/zinit/zfini may all be null, see notes above.
185 * Note that the zinit and zfini specified here are NOT

--- 21 unchanged lines hidden (view full) ---

207 * Definitions for uma_zcreate flags
208 *
209 * These flags share space with UMA_ZFLAGs in uma_int.h. Be careful not to
210 * overlap when adding new features. 0xf0000000 is in use by uma_int.h.
211 */
212#define UMA_ZONE_PAGEABLE 0x0001 /* Return items not fully backed by
213 physical memory XXX Not yet */
214#define UMA_ZONE_ZINIT 0x0002 /* Initialize with zeros */
215#define UMA_ZONE_STATIC 0x0004 /* Staticly sized zone */
216#define UMA_ZONE_OFFPAGE 0x0008 /* Force the slab structure allocation
217 off of the real memory */
218#define UMA_ZONE_MALLOC 0x0010 /* For use by malloc(9) only! */
219#define UMA_ZONE_NOFREE 0x0020 /* Do not free slabs of this type! */
220#define UMA_ZONE_MTXCLASS 0x0040 /* Create a new lock class */
221#define UMA_ZONE_VM 0x0080 /*
222 * Used for internal vm datastructures
223 * only.

--- 27 unchanged lines hidden (view full) ---

251 * Allocates an item out of a zone
252 *
253 * Arguments:
254 * zone The zone we are allocating from
255 * arg This data is passed to the ctor function
256 * flags See sys/malloc.h for available flags.
257 *
258 * Returns:
259 * A non null pointer to an initialized element from the zone is
260 * garanteed if the wait flag is M_WAITOK, otherwise a null pointer may be
261 * returned if the zone is empty or the ctor failed.
262 */
263
264void *uma_zalloc_arg(uma_zone_t zone, void *arg, int flags);
265
266/*
267 * Allocates an item out of a zone without supplying an argument
268 *
269 * This is just a wrapper for uma_zalloc_arg for convenience.

--- 39 unchanged lines hidden (view full) ---

309 * XXX The rest of the prototypes in this header are h0h0 magic for the VM.
310 * If you think you need to use it for a normal zone you're probably incorrect.
311 */
312
313/*
314 * Backend page supplier routines
315 *
316 * Arguments:
317 * zone The zone that is requesting pages
318 * size The number of bytes being requested
319 * pflag Flags for these memory pages, see below.
320 * wait Indicates our willingness to block.
321 *
322 * Returns:
323 * A pointer to the alloced memory or NULL on failure.
324 */
325
326typedef void *(*uma_alloc)(uma_zone_t zone, int size, u_int8_t *pflag, int wait);
327
328/*
329 * Backend page free routines
330 *
331 * Arguments:
332 * item A pointer to the previously allocated pages
333 * size The original size of the allocation
334 * pflag The flags for the slab. See UMA_SLAB_* below
335 *
336 * Returns:
337 * None
338 */
339typedef void (*uma_free)(void *item, int size, u_int8_t pflag);
340
341
342

--- 55 unchanged lines hidden (view full) ---

398 * Nothing
399 */
400void uma_set_align(int align);
401
402/*
403 * Switches the backing object of a zone
404 *
405 * Arguments:
406 * zone The zone to update
407 * obj The obj to use for future allocations
408 * size The size of the object to allocate
409 *
410 * Returns:
411 * 0 if kva space can not be allocated
412 * 1 if successful
413 *
414 * Discussion:
415 * A NULL object can be used and uma will allocate one for you. Setting
416 * the size will limit the amount of memory allocated to this zone.

--- 13 unchanged lines hidden (view full) ---

430 */
431void uma_zone_set_max(uma_zone_t zone, int nitems);
432
433/*
434 * The following two routines (uma_zone_set_init/fini)
435 * are used to set the backend init/fini pair which acts on an
436 * object as it becomes allocated and is placed in a slab within
437 * the specified zone's backing keg. These should probably not
438 * be changed once allocations have already begun and only
439 * immediately upon zone creation.
440 */
441void uma_zone_set_init(uma_zone_t zone, uma_init uminit);
442void uma_zone_set_fini(uma_zone_t zone, uma_fini fini);
443
444/*
445 * The following two routines (uma_zone_set_zinit/zfini) are
446 * used to set the zinit/zfini pair which acts on an object as
447 * it passes from the backing Keg's slab cache to the
448 * specified Zone's bucket cache. These should probably not
449 * be changed once allocations have already begun and
450 * only immediately upon zone creation.
451 */
452void uma_zone_set_zinit(uma_zone_t zone, uma_init zinit);
453void uma_zone_set_zfini(uma_zone_t zone, uma_fini zfini);
454
455/*
456 * Replaces the standard page_alloc or obj_alloc functions for this zone
457 *
458 * Arguments:
459 * zone The zone whos back end allocator is being changed.
460 * allocf A pointer to the allocation function
461 *
462 * Returns:
463 * Nothing
464 *
465 * Discussion:
466 * This could be used to implement pageable allocation, or perhaps
467 * even DMA allocators if used in conjunction with the OFFPAGE

--- 11 unchanged lines hidden (view full) ---

479 *
480 * Returns:
481 * Nothing
482 */
483
484void uma_zone_set_freef(uma_zone_t zone, uma_free freef);
485
486/*
487 * These flags are setable in the allocf and visable in the freef.
488 */
489#define UMA_SLAB_BOOT 0x01 /* Slab alloced from boot pages */
490#define UMA_SLAB_KMEM 0x02 /* Slab alloced from kmem_map */
491#define UMA_SLAB_KERNEL 0x04 /* Slab alloced from kernel_map */
492#define UMA_SLAB_PRIV 0x08 /* Slab alloced from priv allocator */
493#define UMA_SLAB_OFFP 0x10 /* Slab is managed separately */
494#define UMA_SLAB_MALLOC 0x20 /* Slab is a large malloc slab */
495/* 0x40 and 0x80 are available */

--- 36 unchanged lines hidden (view full) ---

532 * Returns:
533 * Non-zero if zone is exhausted.
534 */
535int uma_zone_exhausted(uma_zone_t zone);
536int uma_zone_exhausted_nolock(uma_zone_t zone);
537
538/*
539 * Exported statistics structures to be used by user space monitoring tools.
540 * Statistics stream consusts of a uma_stream_header, followed by a series of
541 * alternative uma_type_header and uma_type_stat structures. Statistics
542 * structures
543 */
544#define UMA_STREAM_VERSION 0x00000001
545struct uma_stream_header {
546 u_int32_t ush_version; /* Stream format version. */
547 u_int32_t ush_maxcpus; /* Value of MAXCPU for stream. */
548 u_int32_t ush_count; /* Number of records. */
549 u_int32_t _ush_pad; /* Pad/reserved field. */
550};

--- 21 unchanged lines hidden (view full) ---

572 u_int32_t uth_zone_flags; /* Zone: flags. */
573 u_int64_t uth_allocs; /* Zone: number of allocations. */
574 u_int64_t uth_frees; /* Zone: number of frees. */
575 u_int64_t uth_fails; /* Zone: number of alloc failures. */
576 u_int64_t _uth_reserved1[3]; /* Reserved. */
577};
578
579struct uma_percpu_stat {
580 u_int64_t ups_allocs; /* Cache: number of alloctions. */
581 u_int64_t ups_frees; /* Cache: number of frees. */
582 u_int64_t ups_cache_free; /* Cache: free items in cache. */
583 u_int64_t _ups_reserved[5]; /* Reserved. */
584};
585
586#endif