Blame view
include/linux/slab.h
10.8 KB
1da177e4c
|
1 |
/* |
2e892f43c
|
2 3 |
* Written by Mark Hemment, 1996 (markhe@nextd.demon.co.uk). * |
cde535359
|
4 |
* (C) SGI 2006, Christoph Lameter |
2e892f43c
|
5 6 |
* Cleaned up and restructured to ease the addition of alternative * implementations of SLAB allocators. |
1da177e4c
|
7 8 9 10 |
*/ #ifndef _LINUX_SLAB_H #define _LINUX_SLAB_H |
1b1cec4bb
|
11 |
#include <linux/gfp.h> |
1b1cec4bb
|
12 |
#include <linux/types.h> |
1da177e4c
|
13 |
|
2e892f43c
|
14 15 16 |
/* * Flags to pass to kmem_cache_create(). * The ones marked DEBUG are only valid if CONFIG_SLAB_DEBUG is set. |
1da177e4c
|
17 |
*/ |
55935a34a
|
18 |
#define SLAB_DEBUG_FREE 0x00000100UL /* DEBUG: Perform (expensive) checks on free */ |
55935a34a
|
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
|
22 |
#define SLAB_CACHE_DMA 0x00004000UL /* Use GFP_DMA memory */ |
2e892f43c
|
23 |
#define SLAB_STORE_USER 0x00010000UL /* DEBUG: Store the last owner for bug hunting */ |
2e892f43c
|
24 |
#define SLAB_PANIC 0x00040000UL /* Panic if kmem_cache_create() fails */ |
d7de4c1dc
|
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
|
53 |
#define SLAB_DESTROY_BY_RCU 0x00080000UL /* Defer freeing slabs to RCU */ |
101a50019
|
54 |
#define SLAB_MEM_SPREAD 0x00100000UL /* Spread some memory over cpuset */ |
81819f0fc
|
55 |
#define SLAB_TRACE 0x00200000UL /* Trace allocations and frees */ |
1da177e4c
|
56 |
|
30327acf7
|
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
|
63 |
#define SLAB_NOLEAKTRACE 0x00800000UL /* Avoid kmemleak tracing */ |
2dff44052
|
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
|
70 71 72 73 74 |
#ifdef CONFIG_FAILSLAB # define SLAB_FAILSLAB 0x02000000UL /* Fault injection mark */ #else # define SLAB_FAILSLAB 0x00000000UL #endif |
2dff44052
|
75 |
|
e12ba74d8
|
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
|
79 |
/* |
6cb8f9132
|
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
|
88 |
#define ZERO_OR_NULL_PTR(x) ((unsigned long)(x) <= \ |
6cb8f9132
|
89 90 91 |
(unsigned long)ZERO_SIZE_PTR) /* |
2e892f43c
|
92 93 94 |
* struct kmem_cache related prototypes */ void __init kmem_cache_init(void); |
81819f0fc
|
95 |
int slab_is_available(void); |
1da177e4c
|
96 |
|
2e892f43c
|
97 |
struct kmem_cache *kmem_cache_create(const char *, size_t, size_t, |
ebe29738f
|
98 |
unsigned long, |
51cc50685
|
99 |
void (*)(void *)); |
2e892f43c
|
100 101 |
void kmem_cache_destroy(struct kmem_cache *); int kmem_cache_shrink(struct kmem_cache *); |
2e892f43c
|
102 103 104 |
void kmem_cache_free(struct kmem_cache *, void *); unsigned int kmem_cache_size(struct kmem_cache *); const char *kmem_cache_name(struct kmem_cache *); |
fc1c18335
|
105 |
int kern_ptr_validate(const void *ptr, unsigned long size); |
55935a34a
|
106 |
int kmem_ptr_validate(struct kmem_cache *cachep, const void *ptr); |
2e892f43c
|
107 |
|
0a31bd5f2
|
108 109 110 111 112 113 114 115 116 117 |
/* * 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
|
118 |
(__flags), NULL) |
0a31bd5f2
|
119 |
|
2e892f43c
|
120 |
/* |
0aa817f07
|
121 122 123 124 125 126 127 128 |
* 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
|
129 130 |
#define KMALLOC_SHIFT_HIGH ((MAX_ORDER + PAGE_SHIFT - 1) <= 25 ? \ (MAX_ORDER + PAGE_SHIFT - 1) : 25) |
0aa817f07
|
131 132 133 134 135 |
#define KMALLOC_MAX_SIZE (1UL << KMALLOC_SHIFT_HIGH) #define KMALLOC_MAX_ORDER (KMALLOC_SHIFT_HIGH - PAGE_SHIFT) /* |
2e892f43c
|
136 137 |
* Common kmalloc functions provided by all allocators */ |
93bc4e89c
|
138 |
void * __must_check __krealloc(const void *, size_t, gfp_t); |
fd76bab2f
|
139 |
void * __must_check krealloc(const void *, size_t, gfp_t); |
2e892f43c
|
140 |
void kfree(const void *); |
3ef0e5ba4
|
141 |
void kzfree(const void *); |
fd76bab2f
|
142 |
size_t ksize(const void *); |
2e892f43c
|
143 |
|
81cda6626
|
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 |
/* * 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
|
170 171 172 173 174 |
/** * 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
|
175 176 177 178 179 180 181 |
* * 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
|
182 |
* %GFP_ATOMIC - Allocation will not sleep. May use emergency pools. |
800590f52
|
183 184 185 186 187 188 189 190 |
* 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
|
191 192 193 194 195 196 197 198 |
* %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
|
199 200 201 202 203 204 |
* 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
|
205 206 |
* %__GFP_HIGH - This allocation has high priority and may use emergency pools. * |
800590f52
|
207 208 209 210 211 212 213 214 215 |
* %__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
|
216 217 218 219 |
* * 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
|
220 |
*/ |
6193a2ff1
|
221 |
static inline void *kcalloc(size_t n, size_t size, gfp_t flags) |
1da177e4c
|
222 |
{ |
9ca908f47
|
223 |
if (size != 0 && n > ULONG_MAX / size) |
6193a2ff1
|
224 |
return NULL; |
81cda6626
|
225 |
return __kmalloc(n * size, flags | __GFP_ZERO); |
1da177e4c
|
226 |
} |
6193a2ff1
|
227 228 229 230 231 232 233 234 235 236 237 |
#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
|
238 239 240 241 242 243 244 245 246 |
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
|
247 248 249 250 251 252 253 254 255 |
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
|
256 |
|
1d2c8eea6
|
257 258 259 260 261 262 263 264 |
/* * 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
|
265 266 |
#if defined(CONFIG_DEBUG_SLAB) || defined(CONFIG_SLUB) || \ (defined(CONFIG_SLAB) && defined(CONFIG_TRACING)) |
ce71e27c6
|
267 |
extern void *__kmalloc_track_caller(size_t, gfp_t, unsigned long); |
1d2c8eea6
|
268 |
#define kmalloc_track_caller(size, flags) \ |
ce71e27c6
|
269 |
__kmalloc_track_caller(size, flags, _RET_IP_) |
2e892f43c
|
270 271 272 273 |
#else #define kmalloc_track_caller(size, flags) \ __kmalloc(size, flags) #endif /* DEBUG_SLAB */ |
1da177e4c
|
274 |
|
97e2bde47
|
275 |
#ifdef CONFIG_NUMA |
8b98c1699
|
276 277 278 279 280 281 282 283 |
/* * 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
|
284 285 |
#if defined(CONFIG_DEBUG_SLAB) || defined(CONFIG_SLUB) || \ (defined(CONFIG_SLAB) && defined(CONFIG_TRACING)) |
ce71e27c6
|
286 |
extern void *__kmalloc_node_track_caller(size_t, gfp_t, int, unsigned long); |
8b98c1699
|
287 288 |
#define kmalloc_node_track_caller(size, flags, node) \ __kmalloc_node_track_caller(size, flags, node, \ |
ce71e27c6
|
289 |
_RET_IP_) |
2e892f43c
|
290 291 292 |
#else #define kmalloc_node_track_caller(size, flags, node) \ __kmalloc_node(size, flags, node) |
8b98c1699
|
293 |
#endif |
2e892f43c
|
294 |
|
8b98c1699
|
295 |
#else /* CONFIG_NUMA */ |
8b98c1699
|
296 297 298 |
#define kmalloc_node_track_caller(size, flags, node) \ kmalloc_track_caller(size, flags) |
97e2bde47
|
299 |
|
dfcd36102
|
300 |
#endif /* CONFIG_NUMA */ |
10cef6029
|
301 |
|
81cda6626
|
302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 |
/* * 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
|
319 320 321 322 323 324 325 326 327 328 |
/** * 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
|
329 |
void __init kmem_cache_init_late(void); |
1da177e4c
|
330 |
#endif /* _LINUX_SLAB_H */ |