Blame view
include/linux/slab.h
8.75 KB
1da177e4c
|
1 |
/* |
2e892f43c
|
2 3 4 5 6 |
* Written by Mark Hemment, 1996 (markhe@nextd.demon.co.uk). * * (C) SGI 2006, Christoph Lameter <clameter@sgi.com> * 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 |
#ifdef __KERNEL__ |
1da177e4c
|
12 |
|
1b1cec4bb
|
13 |
#include <linux/gfp.h> |
1b1cec4bb
|
14 |
#include <linux/types.h> |
1da177e4c
|
15 |
|
2e892f43c
|
16 17 18 |
/* * Flags to pass to kmem_cache_create(). * The ones marked DEBUG are only valid if CONFIG_SLAB_DEBUG is set. |
1da177e4c
|
19 |
*/ |
55935a34a
|
20 |
#define SLAB_DEBUG_FREE 0x00000100UL /* DEBUG: Perform (expensive) checks on free */ |
55935a34a
|
21 22 23 |
#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
|
24 |
#define SLAB_CACHE_DMA 0x00004000UL /* Use GFP_DMA memory */ |
2e892f43c
|
25 26 27 28 |
#define SLAB_STORE_USER 0x00010000UL /* DEBUG: Store the last owner for bug hunting */ #define SLAB_RECLAIM_ACCOUNT 0x00020000UL /* Objects are reclaimable */ #define SLAB_PANIC 0x00040000UL /* Panic if kmem_cache_create() fails */ #define SLAB_DESTROY_BY_RCU 0x00080000UL /* Defer freeing slabs to RCU */ |
101a50019
|
29 |
#define SLAB_MEM_SPREAD 0x00100000UL /* Spread some memory over cpuset */ |
81819f0fc
|
30 |
#define SLAB_TRACE 0x00200000UL /* Trace allocations and frees */ |
1da177e4c
|
31 |
|
2e892f43c
|
32 |
/* |
6cb8f9132
|
33 34 35 36 37 38 39 40 |
* 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
|
41 |
#define ZERO_OR_NULL_PTR(x) ((unsigned long)(x) <= \ |
6cb8f9132
|
42 43 44 |
(unsigned long)ZERO_SIZE_PTR) /* |
2e892f43c
|
45 46 47 |
* struct kmem_cache related prototypes */ void __init kmem_cache_init(void); |
81819f0fc
|
48 |
int slab_is_available(void); |
1da177e4c
|
49 |
|
2e892f43c
|
50 |
struct kmem_cache *kmem_cache_create(const char *, size_t, size_t, |
ebe29738f
|
51 |
unsigned long, |
ebe29738f
|
52 |
void (*)(void *, struct kmem_cache *, unsigned long)); |
2e892f43c
|
53 54 |
void kmem_cache_destroy(struct kmem_cache *); int kmem_cache_shrink(struct kmem_cache *); |
2e892f43c
|
55 56 57 |
void kmem_cache_free(struct kmem_cache *, void *); unsigned int kmem_cache_size(struct kmem_cache *); const char *kmem_cache_name(struct kmem_cache *); |
55935a34a
|
58 |
int kmem_ptr_validate(struct kmem_cache *cachep, const void *ptr); |
2e892f43c
|
59 |
|
0a31bd5f2
|
60 61 62 63 64 65 66 67 68 69 |
/* * 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
|
70 |
(__flags), NULL) |
0a31bd5f2
|
71 |
|
2e892f43c
|
72 |
/* |
0aa817f07
|
73 74 75 76 77 78 79 80 |
* 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
|
81 82 |
#define KMALLOC_SHIFT_HIGH ((MAX_ORDER + PAGE_SHIFT - 1) <= 25 ? \ (MAX_ORDER + PAGE_SHIFT - 1) : 25) |
0aa817f07
|
83 84 85 86 87 |
#define KMALLOC_MAX_SIZE (1UL << KMALLOC_SHIFT_HIGH) #define KMALLOC_MAX_ORDER (KMALLOC_SHIFT_HIGH - PAGE_SHIFT) /* |
2e892f43c
|
88 89 |
* Common kmalloc functions provided by all allocators */ |
fd76bab2f
|
90 |
void * __must_check krealloc(const void *, size_t, gfp_t); |
2e892f43c
|
91 |
void kfree(const void *); |
fd76bab2f
|
92 |
size_t ksize(const void *); |
2e892f43c
|
93 |
|
81cda6626
|
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 |
/* * 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
|
120 121 122 123 124 |
/** * 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
|
125 126 127 128 129 130 131 |
* * 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
|
132 |
* %GFP_ATOMIC - Allocation will not sleep. May use emergency pools. |
800590f52
|
133 134 135 136 137 138 139 140 |
* 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
|
141 142 143 144 145 146 147 148 |
* %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
|
149 150 151 152 153 154 |
* 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
|
155 156 |
* %__GFP_HIGH - This allocation has high priority and may use emergency pools. * |
800590f52
|
157 158 159 160 161 162 163 164 165 |
* %__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
|
166 167 168 169 |
* * 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
|
170 |
*/ |
6193a2ff1
|
171 |
static inline void *kcalloc(size_t n, size_t size, gfp_t flags) |
1da177e4c
|
172 |
{ |
6193a2ff1
|
173 174 |
if (n != 0 && size > ULONG_MAX / n) return NULL; |
81cda6626
|
175 |
return __kmalloc(n * size, flags | __GFP_ZERO); |
1da177e4c
|
176 |
} |
6193a2ff1
|
177 178 179 180 181 182 183 184 185 186 187 |
#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
|
188 189 190 191 192 193 194 195 196 |
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
|
197 198 199 200 201 202 203 204 205 |
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
|
206 |
|
1d2c8eea6
|
207 208 209 210 211 212 213 214 |
/* * 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. */ |
81819f0fc
|
215 |
#if defined(CONFIG_DEBUG_SLAB) || defined(CONFIG_SLUB) |
1d2c8eea6
|
216 217 218 |
extern void *__kmalloc_track_caller(size_t, gfp_t, void*); #define kmalloc_track_caller(size, flags) \ __kmalloc_track_caller(size, flags, __builtin_return_address(0)) |
2e892f43c
|
219 220 221 222 |
#else #define kmalloc_track_caller(size, flags) \ __kmalloc(size, flags) #endif /* DEBUG_SLAB */ |
1da177e4c
|
223 |
|
97e2bde47
|
224 |
#ifdef CONFIG_NUMA |
8b98c1699
|
225 226 227 228 229 230 231 232 |
/* * 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. */ |
81819f0fc
|
233 |
#if defined(CONFIG_DEBUG_SLAB) || defined(CONFIG_SLUB) |
8b98c1699
|
234 235 236 237 |
extern void *__kmalloc_node_track_caller(size_t, gfp_t, int, void *); #define kmalloc_node_track_caller(size, flags, node) \ __kmalloc_node_track_caller(size, flags, node, \ __builtin_return_address(0)) |
2e892f43c
|
238 239 240 |
#else #define kmalloc_node_track_caller(size, flags, node) \ __kmalloc_node(size, flags, node) |
8b98c1699
|
241 |
#endif |
2e892f43c
|
242 |
|
8b98c1699
|
243 |
#else /* CONFIG_NUMA */ |
8b98c1699
|
244 245 246 |
#define kmalloc_node_track_caller(size, flags, node) \ kmalloc_track_caller(size, flags) |
97e2bde47
|
247 |
|
55935a34a
|
248 |
#endif /* DEBUG_SLAB */ |
10cef6029
|
249 |
|
81cda6626
|
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 |
/* * 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); } |
1da177e4c
|
267 |
#endif /* __KERNEL__ */ |
1da177e4c
|
268 |
#endif /* _LINUX_SLAB_H */ |