Blame view
include/linux/slab.h
11.2 KB
1da177e4c Linux-2.6.12-rc2 |
1 |
/* |
2e892f43c [PATCH] Cleanup s... |
2 3 |
* Written by Mark Hemment, 1996 (markhe@nextd.demon.co.uk). * |
cde535359 Christoph has moved |
4 |
* (C) SGI 2006, Christoph Lameter |
2e892f43c [PATCH] Cleanup s... |
5 6 |
* Cleaned up and restructured to ease the addition of alternative * implementations of SLAB allocators. |
1da177e4c Linux-2.6.12-rc2 |
7 8 9 10 |
*/ #ifndef _LINUX_SLAB_H #define _LINUX_SLAB_H |
1b1cec4bb [PATCH] slab: dep... |
11 |
#include <linux/gfp.h> |
1b1cec4bb [PATCH] slab: dep... |
12 |
#include <linux/types.h> |
1da177e4c Linux-2.6.12-rc2 |
13 |
|
2e892f43c [PATCH] Cleanup s... |
14 15 16 |
/* * Flags to pass to kmem_cache_create(). * The ones marked DEBUG are only valid if CONFIG_SLAB_DEBUG is set. |
1da177e4c Linux-2.6.12-rc2 |
17 |
*/ |
55935a34a [PATCH] More slab... |
18 |
#define SLAB_DEBUG_FREE 0x00000100UL /* DEBUG: Perform (expensive) checks on free */ |
55935a34a [PATCH] More slab... |
19 20 21 |
#define SLAB_RED_ZONE 0x00000400UL /* DEBUG: Red zone objs in a cache */ #define SLAB_POISON 0x00000800UL /* DEBUG: Poison objects */ #define SLAB_HWCACHE_ALIGN 0x00002000UL /* Align objs on cache lines */ |
2e892f43c [PATCH] Cleanup s... |
22 |
#define SLAB_CACHE_DMA 0x00004000UL /* Use GFP_DMA memory */ |
2e892f43c [PATCH] Cleanup s... |
23 |
#define SLAB_STORE_USER 0x00010000UL /* DEBUG: Store the last owner for bug hunting */ |
2e892f43c [PATCH] Cleanup s... |
24 |
#define SLAB_PANIC 0x00040000UL /* Panic if kmem_cache_create() fails */ |
d7de4c1dc slab: document SL... |
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 |
/* * SLAB_DESTROY_BY_RCU - **WARNING** READ THIS! * * This delays freeing the SLAB page by a grace period, it does _NOT_ * delay object freeing. This means that if you do kmem_cache_free() * that memory location is free to be reused at any time. Thus it may * be possible to see another object there in the same RCU grace period. * * This feature only ensures the memory location backing the object * stays valid, the trick to using this is relying on an independent * object validation pass. Something like: * * rcu_read_lock() * again: * obj = lockless_lookup(key); * if (obj) { * if (!try_get_ref(obj)) // might fail for free objects * goto again; * * if (obj->key != key) { // not the object we expected * put_ref(obj); * goto again; * } * } * rcu_read_unlock(); * * See also the comment on struct slab_rcu in mm/slab.c. */ |
2e892f43c [PATCH] Cleanup s... |
53 |
#define SLAB_DESTROY_BY_RCU 0x00080000UL /* Defer freeing slabs to RCU */ |
101a50019 [PATCH] cpuset me... |
54 |
#define SLAB_MEM_SPREAD 0x00100000UL /* Spread some memory over cpuset */ |
81819f0fc SLUB core |
55 |
#define SLAB_TRACE 0x00200000UL /* Trace allocations and frees */ |
1da177e4c Linux-2.6.12-rc2 |
56 |
|
30327acf7 slab: add a flag ... |
57 58 59 60 61 62 |
/* Flag to prevent checks on free */ #ifdef CONFIG_DEBUG_OBJECTS # define SLAB_DEBUG_OBJECTS 0x00400000UL #else # define SLAB_DEBUG_OBJECTS 0x00000000UL #endif |
d5cff6352 kmemleak: Add the... |
63 |
#define SLAB_NOLEAKTRACE 0x00800000UL /* Avoid kmemleak tracing */ |
2dff44052 kmemcheck: add mm... |
64 65 66 67 68 69 |
/* Don't track use of uninitialized memory */ #ifdef CONFIG_KMEMCHECK # define SLAB_NOTRACK 0x01000000UL #else # define SLAB_NOTRACK 0x00000000UL #endif |
4c13dd3b4 failslab: add abi... |
70 71 72 73 74 |
#ifdef CONFIG_FAILSLAB # define SLAB_FAILSLAB 0x02000000UL /* Fault injection mark */ #else # define SLAB_FAILSLAB 0x00000000UL #endif |
2dff44052 kmemcheck: add mm... |
75 |
|
e12ba74d8 Group short-lived... |
76 77 78 |
/* The following flags affect the page allocator grouping pages by mobility */ #define SLAB_RECLAIM_ACCOUNT 0x00020000UL /* Objects are reclaimable */ #define SLAB_TEMPORARY SLAB_RECLAIM_ACCOUNT /* Objects are short-lived */ |
2e892f43c [PATCH] Cleanup s... |
79 |
/* |
6cb8f9132 Slab allocators: ... |
80 81 82 83 84 85 86 87 |
* ZERO_SIZE_PTR will be returned for zero sized kmalloc requests. * * Dereferencing ZERO_SIZE_PTR will lead to a distinct access fault. * * ZERO_SIZE_PTR can be passed to kfree though in the same way that NULL can. * Both make kfree a no-op. */ #define ZERO_SIZE_PTR ((void *)16) |
1d4ec7b1d Fix ZERO_OR_NULL_... |
88 |
#define ZERO_OR_NULL_PTR(x) ((unsigned long)(x) <= \ |
6cb8f9132 Slab allocators: ... |
89 90 91 |
(unsigned long)ZERO_SIZE_PTR) /* |
2e892f43c [PATCH] Cleanup s... |
92 93 94 |
* struct kmem_cache related prototypes */ void __init kmem_cache_init(void); |
81819f0fc SLUB core |
95 |
int slab_is_available(void); |
1da177e4c Linux-2.6.12-rc2 |
96 |
|
2e892f43c [PATCH] Cleanup s... |
97 |
struct kmem_cache *kmem_cache_create(const char *, size_t, size_t, |
ebe29738f [PATCH] Remove us... |
98 |
unsigned long, |
51cc50685 SL*B: drop kmem c... |
99 |
void (*)(void *)); |
2e892f43c [PATCH] Cleanup s... |
100 101 |
void kmem_cache_destroy(struct kmem_cache *); int kmem_cache_shrink(struct kmem_cache *); |
2e892f43c [PATCH] Cleanup s... |
102 103 |
void kmem_cache_free(struct kmem_cache *, void *); unsigned int kmem_cache_size(struct kmem_cache *); |
2e892f43c [PATCH] Cleanup s... |
104 |
|
0a31bd5f2 KMEM_CACHE(): sim... |
105 106 107 108 109 110 111 112 113 114 |
/* * Please use this macro to create slab caches. Simply specify the * name of the structure and maybe some flags that are listed above. * * The alignment of the struct determines object alignment. If you * f.e. add ____cacheline_aligned_in_smp to the struct declaration * then the objects will be properly aligned in SMP configurations. */ #define KMEM_CACHE(__struct, __flags) kmem_cache_create(#__struct,\ sizeof(struct __struct), __alignof__(struct __struct),\ |
20c2df83d mm: Remove slab d... |
115 |
(__flags), NULL) |
0a31bd5f2 KMEM_CACHE(): sim... |
116 |
|
2e892f43c [PATCH] Cleanup s... |
117 |
/* |
0aa817f07 Slab allocators: ... |
118 119 120 121 122 123 124 125 |
* The largest kmalloc size supported by the slab allocators is * 32 megabyte (2^25) or the maximum allocatable page order if that is * less than 32 MB. * * WARNING: Its not easy to increase this value since the allocators have * to do various tricks to work around compiler limitations in order to * ensure proper constant folding. */ |
debee0768 slab allocators: ... |
126 127 |
#define KMALLOC_SHIFT_HIGH ((MAX_ORDER + PAGE_SHIFT - 1) <= 25 ? \ (MAX_ORDER + PAGE_SHIFT - 1) : 25) |
0aa817f07 Slab allocators: ... |
128 129 130 |
#define KMALLOC_MAX_SIZE (1UL << KMALLOC_SHIFT_HIGH) #define KMALLOC_MAX_ORDER (KMALLOC_SHIFT_HIGH - PAGE_SHIFT) |
90810645f slab allocators: ... |
131 132 133 134 135 |
/* * Some archs want to perform DMA into kmalloc caches and need a guaranteed * alignment larger than the alignment of a 64-bit integer. * Setting ARCH_KMALLOC_MINALIGN in arch headers allows that. */ |
3192b920b slab, slub, slob:... |
136 137 138 139 140 |
#ifdef ARCH_DMA_MINALIGN #define ARCH_KMALLOC_MINALIGN ARCH_DMA_MINALIGN #else #define ARCH_KMALLOC_MINALIGN __alignof__(unsigned long long) #endif |
90810645f slab allocators: ... |
141 142 143 144 145 |
/* * Setting ARCH_SLAB_MINALIGN in arch headers allows a different alignment. * Intended for arches that get misalignment faults even for 64 bit integer * aligned buffers. */ |
3192b920b slab, slub, slob:... |
146 147 148 |
#ifndef ARCH_SLAB_MINALIGN #define ARCH_SLAB_MINALIGN __alignof__(unsigned long long) #endif |
0aa817f07 Slab allocators: ... |
149 |
/* |
2e892f43c [PATCH] Cleanup s... |
150 151 |
* Common kmalloc functions provided by all allocators */ |
93bc4e89c netfilter: fix do... |
152 |
void * __must_check __krealloc(const void *, size_t, gfp_t); |
fd76bab2f slab: introduce k... |
153 |
void * __must_check krealloc(const void *, size_t, gfp_t); |
2e892f43c [PATCH] Cleanup s... |
154 |
void kfree(const void *); |
3ef0e5ba4 slab: introduce k... |
155 |
void kzfree(const void *); |
fd76bab2f slab: introduce k... |
156 |
size_t ksize(const void *); |
2e892f43c [PATCH] Cleanup s... |
157 |
|
81cda6626 Slab allocators: ... |
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 |
/* * Allocator specific definitions. These are mainly used to establish optimized * ways to convert kmalloc() calls to kmem_cache_alloc() invocations by * selecting the appropriate general cache at compile time. * * Allocators must define at least: * * kmem_cache_alloc() * __kmalloc() * kmalloc() * * Those wishing to support NUMA must also define: * * kmem_cache_alloc_node() * kmalloc_node() * * See each allocator definition file for additional comments and * implementation notes. */ #ifdef CONFIG_SLUB #include <linux/slub_def.h> #elif defined(CONFIG_SLOB) #include <linux/slob_def.h> #else #include <linux/slab_def.h> #endif |
2e892f43c [PATCH] Cleanup s... |
184 185 186 187 188 |
/** * kcalloc - allocate memory for an array. The memory is set to zero. * @n: number of elements. * @size: element size. * @flags: the type of memory to allocate. |
800590f52 [PATCH] slab: kma... |
189 190 191 192 193 194 195 |
* * The @flags argument may be one of: * * %GFP_USER - Allocate memory on behalf of user. May sleep. * * %GFP_KERNEL - Allocate normal kernel ram. May sleep. * |
6193a2ff1 slob: initial NUM... |
196 |
* %GFP_ATOMIC - Allocation will not sleep. May use emergency pools. |
800590f52 [PATCH] slab: kma... |
197 198 199 200 201 202 203 204 |
* For example, use this inside interrupt handlers. * * %GFP_HIGHUSER - Allocate pages from high memory. * * %GFP_NOIO - Do not do any I/O at all while trying to get memory. * * %GFP_NOFS - Do not make any fs calls while trying to get memory. * |
6193a2ff1 slob: initial NUM... |
205 206 207 208 209 210 211 212 |
* %GFP_NOWAIT - Allocation will not sleep. * * %GFP_THISNODE - Allocate node-local memory only. * * %GFP_DMA - Allocation suitable for DMA. * Should only be used for kmalloc() caches. Otherwise, use a * slab created with SLAB_DMA. * |
800590f52 [PATCH] slab: kma... |
213 214 215 216 217 218 |
* Also it is possible to set different flags by OR'ing * in one or more of the following additional @flags: * * %__GFP_COLD - Request cache-cold pages instead of * trying to return cache-warm pages. * |
800590f52 [PATCH] slab: kma... |
219 220 |
* %__GFP_HIGH - This allocation has high priority and may use emergency pools. * |
800590f52 [PATCH] slab: kma... |
221 222 223 224 225 226 227 228 229 |
* %__GFP_NOFAIL - Indicate that this allocation is in no way allowed to fail * (think twice before using). * * %__GFP_NORETRY - If memory is not immediately available, * then give up at once. * * %__GFP_NOWARN - If allocation fails, don't issue any warnings. * * %__GFP_REPEAT - If allocation fails initially, try once more before failing. |
6193a2ff1 slob: initial NUM... |
230 231 232 233 |
* * There are other flags available as well, but these are not intended * for general use, and so are not documented here. For a full list of * potential flags, always refer to linux/gfp.h. |
800590f52 [PATCH] slab: kma... |
234 |
*/ |
6193a2ff1 slob: initial NUM... |
235 |
static inline void *kcalloc(size_t n, size_t size, gfp_t flags) |
1da177e4c Linux-2.6.12-rc2 |
236 |
{ |
9ca908f47 kcalloc: remove r... |
237 |
if (size != 0 && n > ULONG_MAX / size) |
6193a2ff1 slob: initial NUM... |
238 |
return NULL; |
81cda6626 Slab allocators: ... |
239 |
return __kmalloc(n * size, flags | __GFP_ZERO); |
1da177e4c Linux-2.6.12-rc2 |
240 |
} |
6193a2ff1 slob: initial NUM... |
241 242 243 244 245 246 247 248 249 250 251 |
#if !defined(CONFIG_NUMA) && !defined(CONFIG_SLOB) /** * kmalloc_node - allocate memory from a specific node * @size: how many bytes of memory are required. * @flags: the type of memory to allocate (see kcalloc). * @node: node to allocate from. * * kmalloc() for non-local nodes, used to allocate from a specific node * if available. Equivalent to kmalloc() in the non-NUMA single-node * case. */ |
55935a34a [PATCH] More slab... |
252 253 254 255 256 257 258 259 260 |
static inline void *kmalloc_node(size_t size, gfp_t flags, int node) { return kmalloc(size, flags); } static inline void *__kmalloc_node(size_t size, gfp_t flags, int node) { return __kmalloc(size, flags); } |
6193a2ff1 slob: initial NUM... |
261 262 263 264 265 266 267 268 269 |
void *kmem_cache_alloc(struct kmem_cache *, gfp_t); static inline void *kmem_cache_alloc_node(struct kmem_cache *cachep, gfp_t flags, int node) { return kmem_cache_alloc(cachep, flags); } #endif /* !CONFIG_NUMA && !CONFIG_SLOB */ |
55935a34a [PATCH] More slab... |
270 |
|
1d2c8eea6 [PATCH] slab: cle... |
271 272 273 274 275 276 277 278 |
/* * kmalloc_track_caller is a special version of kmalloc that records the * calling function of the routine calling it for slab leak tracking instead * of just the calling function (confusing, eh?). * It's useful when the call to kmalloc comes from a widely-used standard * allocator where we care about the real place the memory allocation * request comes from. */ |
7adde04a2 slab: fix caller ... |
279 280 |
#if defined(CONFIG_DEBUG_SLAB) || defined(CONFIG_SLUB) || \ (defined(CONFIG_SLAB) && defined(CONFIG_TRACING)) |
ce71e27c6 SLUB: Replace __b... |
281 |
extern void *__kmalloc_track_caller(size_t, gfp_t, unsigned long); |
1d2c8eea6 [PATCH] slab: cle... |
282 |
#define kmalloc_track_caller(size, flags) \ |
ce71e27c6 SLUB: Replace __b... |
283 |
__kmalloc_track_caller(size, flags, _RET_IP_) |
2e892f43c [PATCH] Cleanup s... |
284 285 286 287 |
#else #define kmalloc_track_caller(size, flags) \ __kmalloc(size, flags) #endif /* DEBUG_SLAB */ |
1da177e4c Linux-2.6.12-rc2 |
288 |
|
97e2bde47 [PATCH] add kmall... |
289 |
#ifdef CONFIG_NUMA |
8b98c1699 [PATCH] leak trac... |
290 291 292 293 294 295 296 297 |
/* * kmalloc_node_track_caller is a special version of kmalloc_node that * records the calling function of the routine calling it for slab leak * tracking instead of just the calling function (confusing, eh?). * It's useful when the call to kmalloc_node comes from a widely-used * standard allocator where we care about the real place the memory * allocation request comes from. */ |
7adde04a2 slab: fix caller ... |
298 299 |
#if defined(CONFIG_DEBUG_SLAB) || defined(CONFIG_SLUB) || \ (defined(CONFIG_SLAB) && defined(CONFIG_TRACING)) |
ce71e27c6 SLUB: Replace __b... |
300 |
extern void *__kmalloc_node_track_caller(size_t, gfp_t, int, unsigned long); |
8b98c1699 [PATCH] leak trac... |
301 302 |
#define kmalloc_node_track_caller(size, flags, node) \ __kmalloc_node_track_caller(size, flags, node, \ |
ce71e27c6 SLUB: Replace __b... |
303 |
_RET_IP_) |
2e892f43c [PATCH] Cleanup s... |
304 305 306 |
#else #define kmalloc_node_track_caller(size, flags, node) \ __kmalloc_node(size, flags, node) |
8b98c1699 [PATCH] leak trac... |
307 |
#endif |
2e892f43c [PATCH] Cleanup s... |
308 |
|
8b98c1699 [PATCH] leak trac... |
309 |
#else /* CONFIG_NUMA */ |
8b98c1699 [PATCH] leak trac... |
310 311 312 |
#define kmalloc_node_track_caller(size, flags, node) \ kmalloc_track_caller(size, flags) |
97e2bde47 [PATCH] add kmall... |
313 |
|
dfcd36102 slab: Fix comment... |
314 |
#endif /* CONFIG_NUMA */ |
10cef6029 [PATCH] slob: int... |
315 |
|
81cda6626 Slab allocators: ... |
316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 |
/* * Shortcuts */ static inline void *kmem_cache_zalloc(struct kmem_cache *k, gfp_t flags) { return kmem_cache_alloc(k, flags | __GFP_ZERO); } /** * kzalloc - allocate memory. The memory is set to zero. * @size: how many bytes of memory are required. * @flags: the type of memory to allocate (see kmalloc). */ static inline void *kzalloc(size_t size, gfp_t flags) { return kmalloc(size, flags | __GFP_ZERO); } |
979b0fea2 vm: add kzalloc_n... |
333 334 335 336 337 338 339 340 341 342 |
/** * kzalloc_node - allocate zeroed memory from a particular memory node. * @size: how many bytes of memory are required. * @flags: the type of memory to allocate (see kmalloc). * @node: memory node from which to allocate */ static inline void *kzalloc_node(size_t size, gfp_t flags, int node) { return kmalloc_node(size, flags | __GFP_ZERO, node); } |
7e85ee0c1 slab,slub: don't ... |
343 |
void __init kmem_cache_init_late(void); |
1da177e4c Linux-2.6.12-rc2 |
344 |
#endif /* _LINUX_SLAB_H */ |