Commit | Line | Data |
---|---|---|
1da177e4 | 1 | /* |
2e892f43 CL |
2 | * Written by Mark Hemment, 1996 (markhe@nextd.demon.co.uk). |
3 | * | |
4 | * (C) SGI 2006, Christoph Lameter <clameter@sgi.com> | |
5 | * Cleaned up and restructured to ease the addition of alternative | |
6 | * implementations of SLAB allocators. | |
1da177e4 LT |
7 | */ |
8 | ||
9 | #ifndef _LINUX_SLAB_H | |
10 | #define _LINUX_SLAB_H | |
11 | ||
1b1cec4b | 12 | #ifdef __KERNEL__ |
1da177e4 | 13 | |
1b1cec4b | 14 | #include <linux/gfp.h> |
1b1cec4b | 15 | #include <linux/types.h> |
1da177e4 | 16 | |
2e892f43 CL |
17 | /* |
18 | * Flags to pass to kmem_cache_create(). | |
19 | * The ones marked DEBUG are only valid if CONFIG_SLAB_DEBUG is set. | |
1da177e4 | 20 | */ |
55935a34 | 21 | #define SLAB_DEBUG_FREE 0x00000100UL /* DEBUG: Perform (expensive) checks on free */ |
55935a34 CL |
22 | #define SLAB_RED_ZONE 0x00000400UL /* DEBUG: Red zone objs in a cache */ |
23 | #define SLAB_POISON 0x00000800UL /* DEBUG: Poison objects */ | |
24 | #define SLAB_HWCACHE_ALIGN 0x00002000UL /* Align objs on cache lines */ | |
2e892f43 | 25 | #define SLAB_CACHE_DMA 0x00004000UL /* Use GFP_DMA memory */ |
2e892f43 CL |
26 | #define SLAB_STORE_USER 0x00010000UL /* DEBUG: Store the last owner for bug hunting */ |
27 | #define SLAB_RECLAIM_ACCOUNT 0x00020000UL /* Objects are reclaimable */ | |
28 | #define SLAB_PANIC 0x00040000UL /* Panic if kmem_cache_create() fails */ | |
29 | #define SLAB_DESTROY_BY_RCU 0x00080000UL /* Defer freeing slabs to RCU */ | |
101a5001 | 30 | #define SLAB_MEM_SPREAD 0x00100000UL /* Spread some memory over cpuset */ |
81819f0f | 31 | #define SLAB_TRACE 0x00200000UL /* Trace allocations and frees */ |
1da177e4 | 32 | |
6cb8f913 CL |
33 | /* |
34 | * ZERO_SIZE_PTR will be returned for zero sized kmalloc requests. | |
35 | * | |
36 | * Dereferencing ZERO_SIZE_PTR will lead to a distinct access fault. | |
37 | * | |
38 | * ZERO_SIZE_PTR can be passed to kfree though in the same way that NULL can. | |
39 | * Both make kfree a no-op. | |
40 | */ | |
41 | #define ZERO_SIZE_PTR ((void *)16) | |
42 | ||
43 | #define ZERO_OR_NULL_PTR(x) ((unsigned long)(x) < \ | |
44 | (unsigned long)ZERO_SIZE_PTR) | |
45 | ||
2e892f43 CL |
46 | /* |
47 | * struct kmem_cache related prototypes | |
48 | */ | |
49 | void __init kmem_cache_init(void); | |
81819f0f | 50 | int slab_is_available(void); |
1da177e4 | 51 | |
2e892f43 | 52 | struct kmem_cache *kmem_cache_create(const char *, size_t, size_t, |
ebe29738 CL |
53 | unsigned long, |
54 | void (*)(void *, struct kmem_cache *, unsigned long), | |
55 | void (*)(void *, struct kmem_cache *, unsigned long)); | |
2e892f43 CL |
56 | void kmem_cache_destroy(struct kmem_cache *); |
57 | int kmem_cache_shrink(struct kmem_cache *); | |
2e892f43 CL |
58 | void kmem_cache_free(struct kmem_cache *, void *); |
59 | unsigned int kmem_cache_size(struct kmem_cache *); | |
60 | const char *kmem_cache_name(struct kmem_cache *); | |
55935a34 | 61 | int kmem_ptr_validate(struct kmem_cache *cachep, const void *ptr); |
2e892f43 | 62 | |
0a31bd5f CL |
63 | /* |
64 | * Please use this macro to create slab caches. Simply specify the | |
65 | * name of the structure and maybe some flags that are listed above. | |
66 | * | |
67 | * The alignment of the struct determines object alignment. If you | |
68 | * f.e. add ____cacheline_aligned_in_smp to the struct declaration | |
69 | * then the objects will be properly aligned in SMP configurations. | |
70 | */ | |
71 | #define KMEM_CACHE(__struct, __flags) kmem_cache_create(#__struct,\ | |
72 | sizeof(struct __struct), __alignof__(struct __struct),\ | |
73 | (__flags), NULL, NULL) | |
74 | ||
0aa817f0 CL |
75 | /* |
76 | * The largest kmalloc size supported by the slab allocators is | |
77 | * 32 megabyte (2^25) or the maximum allocatable page order if that is | |
78 | * less than 32 MB. | |
79 | * | |
80 | * WARNING: Its not easy to increase this value since the allocators have | |
81 | * to do various tricks to work around compiler limitations in order to | |
82 | * ensure proper constant folding. | |
83 | */ | |
debee076 CL |
84 | #define KMALLOC_SHIFT_HIGH ((MAX_ORDER + PAGE_SHIFT - 1) <= 25 ? \ |
85 | (MAX_ORDER + PAGE_SHIFT - 1) : 25) | |
0aa817f0 CL |
86 | |
87 | #define KMALLOC_MAX_SIZE (1UL << KMALLOC_SHIFT_HIGH) | |
88 | #define KMALLOC_MAX_ORDER (KMALLOC_SHIFT_HIGH - PAGE_SHIFT) | |
89 | ||
2e892f43 CL |
90 | /* |
91 | * Common kmalloc functions provided by all allocators | |
92 | */ | |
fd76bab2 | 93 | void * __must_check krealloc(const void *, size_t, gfp_t); |
2e892f43 | 94 | void kfree(const void *); |
fd76bab2 | 95 | size_t ksize(const void *); |
2e892f43 | 96 | |
81cda662 CL |
97 | /* |
98 | * Allocator specific definitions. These are mainly used to establish optimized | |
99 | * ways to convert kmalloc() calls to kmem_cache_alloc() invocations by | |
100 | * selecting the appropriate general cache at compile time. | |
101 | * | |
102 | * Allocators must define at least: | |
103 | * | |
104 | * kmem_cache_alloc() | |
105 | * __kmalloc() | |
106 | * kmalloc() | |
107 | * | |
108 | * Those wishing to support NUMA must also define: | |
109 | * | |
110 | * kmem_cache_alloc_node() | |
111 | * kmalloc_node() | |
112 | * | |
113 | * See each allocator definition file for additional comments and | |
114 | * implementation notes. | |
115 | */ | |
116 | #ifdef CONFIG_SLUB | |
117 | #include <linux/slub_def.h> | |
118 | #elif defined(CONFIG_SLOB) | |
119 | #include <linux/slob_def.h> | |
120 | #else | |
121 | #include <linux/slab_def.h> | |
122 | #endif | |
123 | ||
2e892f43 CL |
124 | /** |
125 | * kcalloc - allocate memory for an array. The memory is set to zero. | |
126 | * @n: number of elements. | |
127 | * @size: element size. | |
128 | * @flags: the type of memory to allocate. | |
800590f5 PD |
129 | * |
130 | * The @flags argument may be one of: | |
131 | * | |
132 | * %GFP_USER - Allocate memory on behalf of user. May sleep. | |
133 | * | |
134 | * %GFP_KERNEL - Allocate normal kernel ram. May sleep. | |
135 | * | |
6193a2ff | 136 | * %GFP_ATOMIC - Allocation will not sleep. May use emergency pools. |
800590f5 PD |
137 | * For example, use this inside interrupt handlers. |
138 | * | |
139 | * %GFP_HIGHUSER - Allocate pages from high memory. | |
140 | * | |
141 | * %GFP_NOIO - Do not do any I/O at all while trying to get memory. | |
142 | * | |
143 | * %GFP_NOFS - Do not make any fs calls while trying to get memory. | |
144 | * | |
6193a2ff PM |
145 | * %GFP_NOWAIT - Allocation will not sleep. |
146 | * | |
147 | * %GFP_THISNODE - Allocate node-local memory only. | |
148 | * | |
149 | * %GFP_DMA - Allocation suitable for DMA. | |
150 | * Should only be used for kmalloc() caches. Otherwise, use a | |
151 | * slab created with SLAB_DMA. | |
152 | * | |
800590f5 PD |
153 | * Also it is possible to set different flags by OR'ing |
154 | * in one or more of the following additional @flags: | |
155 | * | |
156 | * %__GFP_COLD - Request cache-cold pages instead of | |
157 | * trying to return cache-warm pages. | |
158 | * | |
800590f5 PD |
159 | * %__GFP_HIGH - This allocation has high priority and may use emergency pools. |
160 | * | |
800590f5 PD |
161 | * %__GFP_NOFAIL - Indicate that this allocation is in no way allowed to fail |
162 | * (think twice before using). | |
163 | * | |
164 | * %__GFP_NORETRY - If memory is not immediately available, | |
165 | * then give up at once. | |
166 | * | |
167 | * %__GFP_NOWARN - If allocation fails, don't issue any warnings. | |
168 | * | |
169 | * %__GFP_REPEAT - If allocation fails initially, try once more before failing. | |
6193a2ff PM |
170 | * |
171 | * There are other flags available as well, but these are not intended | |
172 | * for general use, and so are not documented here. For a full list of | |
173 | * potential flags, always refer to linux/gfp.h. | |
800590f5 | 174 | */ |
6193a2ff | 175 | static inline void *kcalloc(size_t n, size_t size, gfp_t flags) |
1da177e4 | 176 | { |
6193a2ff PM |
177 | if (n != 0 && size > ULONG_MAX / n) |
178 | return NULL; | |
81cda662 | 179 | return __kmalloc(n * size, flags | __GFP_ZERO); |
1da177e4 LT |
180 | } |
181 | ||
6193a2ff PM |
182 | #if !defined(CONFIG_NUMA) && !defined(CONFIG_SLOB) |
183 | /** | |
184 | * kmalloc_node - allocate memory from a specific node | |
185 | * @size: how many bytes of memory are required. | |
186 | * @flags: the type of memory to allocate (see kcalloc). | |
187 | * @node: node to allocate from. | |
188 | * | |
189 | * kmalloc() for non-local nodes, used to allocate from a specific node | |
190 | * if available. Equivalent to kmalloc() in the non-NUMA single-node | |
191 | * case. | |
192 | */ | |
55935a34 CL |
193 | static inline void *kmalloc_node(size_t size, gfp_t flags, int node) |
194 | { | |
195 | return kmalloc(size, flags); | |
196 | } | |
197 | ||
198 | static inline void *__kmalloc_node(size_t size, gfp_t flags, int node) | |
199 | { | |
200 | return __kmalloc(size, flags); | |
201 | } | |
6193a2ff PM |
202 | |
203 | void *kmem_cache_alloc(struct kmem_cache *, gfp_t); | |
204 | ||
205 | static inline void *kmem_cache_alloc_node(struct kmem_cache *cachep, | |
206 | gfp_t flags, int node) | |
207 | { | |
208 | return kmem_cache_alloc(cachep, flags); | |
209 | } | |
210 | #endif /* !CONFIG_NUMA && !CONFIG_SLOB */ | |
55935a34 | 211 | |
1d2c8eea CH |
212 | /* |
213 | * kmalloc_track_caller is a special version of kmalloc that records the | |
214 | * calling function of the routine calling it for slab leak tracking instead | |
215 | * of just the calling function (confusing, eh?). | |
216 | * It's useful when the call to kmalloc comes from a widely-used standard | |
217 | * allocator where we care about the real place the memory allocation | |
218 | * request comes from. | |
219 | */ | |
81819f0f | 220 | #if defined(CONFIG_DEBUG_SLAB) || defined(CONFIG_SLUB) |
1d2c8eea CH |
221 | extern void *__kmalloc_track_caller(size_t, gfp_t, void*); |
222 | #define kmalloc_track_caller(size, flags) \ | |
223 | __kmalloc_track_caller(size, flags, __builtin_return_address(0)) | |
2e892f43 CL |
224 | #else |
225 | #define kmalloc_track_caller(size, flags) \ | |
226 | __kmalloc(size, flags) | |
227 | #endif /* DEBUG_SLAB */ | |
1da177e4 | 228 | |
97e2bde4 | 229 | #ifdef CONFIG_NUMA |
8b98c169 CH |
230 | /* |
231 | * kmalloc_node_track_caller is a special version of kmalloc_node that | |
232 | * records the calling function of the routine calling it for slab leak | |
233 | * tracking instead of just the calling function (confusing, eh?). | |
234 | * It's useful when the call to kmalloc_node comes from a widely-used | |
235 | * standard allocator where we care about the real place the memory | |
236 | * allocation request comes from. | |
237 | */ | |
81819f0f | 238 | #if defined(CONFIG_DEBUG_SLAB) || defined(CONFIG_SLUB) |
8b98c169 CH |
239 | extern void *__kmalloc_node_track_caller(size_t, gfp_t, int, void *); |
240 | #define kmalloc_node_track_caller(size, flags, node) \ | |
241 | __kmalloc_node_track_caller(size, flags, node, \ | |
242 | __builtin_return_address(0)) | |
2e892f43 CL |
243 | #else |
244 | #define kmalloc_node_track_caller(size, flags, node) \ | |
245 | __kmalloc_node(size, flags, node) | |
8b98c169 | 246 | #endif |
2e892f43 | 247 | |
8b98c169 | 248 | #else /* CONFIG_NUMA */ |
8b98c169 CH |
249 | |
250 | #define kmalloc_node_track_caller(size, flags, node) \ | |
251 | kmalloc_track_caller(size, flags) | |
97e2bde4 | 252 | |
55935a34 | 253 | #endif /* DEBUG_SLAB */ |
10cef602 | 254 | |
81cda662 CL |
255 | /* |
256 | * Shortcuts | |
257 | */ | |
258 | static inline void *kmem_cache_zalloc(struct kmem_cache *k, gfp_t flags) | |
259 | { | |
260 | return kmem_cache_alloc(k, flags | __GFP_ZERO); | |
261 | } | |
262 | ||
263 | /** | |
264 | * kzalloc - allocate memory. The memory is set to zero. | |
265 | * @size: how many bytes of memory are required. | |
266 | * @flags: the type of memory to allocate (see kmalloc). | |
267 | */ | |
268 | static inline void *kzalloc(size_t size, gfp_t flags) | |
269 | { | |
270 | return kmalloc(size, flags | __GFP_ZERO); | |
271 | } | |
272 | ||
1da177e4 | 273 | #endif /* __KERNEL__ */ |
1da177e4 | 274 | #endif /* _LINUX_SLAB_H */ |