2 * linux/include/linux/slab.h
3 * Written by Mark Hemment, 1996.
4 * (markhe@nextd.demon.co.uk)
10 #if defined(__KERNEL__)
12 /* kmem_cache_t exists for legacy reasons and is not used by code in mm */
13 typedef struct kmem_cache kmem_cache_t;
15 #include <linux/gfp.h>
16 #include <linux/init.h>
17 #include <linux/types.h>
18 #include <asm/page.h> /* kmalloc_sizes.h needs PAGE_SIZE */
19 #include <asm/cache.h> /* kmalloc_sizes.h needs L1_CACHE_BYTES */
21 /* flags for kmem_cache_alloc() */
22 #define SLAB_NOFS GFP_NOFS
23 #define SLAB_NOIO GFP_NOIO
24 #define SLAB_ATOMIC GFP_ATOMIC
25 #define SLAB_USER GFP_USER
26 #define SLAB_KERNEL GFP_KERNEL
27 #define SLAB_DMA GFP_DMA
29 /* flags to pass to kmem_cache_create().
30 * The first 3 are only valid when the allocator as been build
33 #define SLAB_DEBUG_FREE 0x00000100UL /* Peform (expensive) checks on free */
34 #define SLAB_DEBUG_INITIAL 0x00000200UL /* Call constructor (as verifier) */
35 #define SLAB_RED_ZONE 0x00000400UL /* Red zone objs in a cache */
36 #define SLAB_POISON 0x00000800UL /* Poison objects */
37 #define SLAB_HWCACHE_ALIGN 0x00002000UL /* align objs on a h/w cache lines */
38 #define SLAB_CACHE_DMA 0x00004000UL /* use GFP_DMA memory */
39 #define SLAB_MUST_HWCACHE_ALIGN 0x00008000UL /* force alignment */
40 #define SLAB_STORE_USER 0x00010000UL /* store the last owner for bug hunting */
41 #define SLAB_RECLAIM_ACCOUNT 0x00020000UL /* track pages allocated to indicate
42 what is reclaimable later*/
43 #define SLAB_PANIC 0x00040000UL /* panic if kmem_cache_create() fails */
44 #define SLAB_DESTROY_BY_RCU 0x00080000UL /* defer freeing pages to RCU */
45 #define SLAB_MEM_SPREAD 0x00100000UL /* Spread some memory over cpuset */
47 /* flags passed to a constructor func */
48 #define SLAB_CTOR_CONSTRUCTOR 0x001UL /* if not set, then deconstructor */
49 #define SLAB_CTOR_ATOMIC 0x002UL /* tell constructor it can't sleep */
50 #define SLAB_CTOR_VERIFY 0x004UL /* tell constructor it's a verify call */
55 extern void __init kmem_cache_init(void);
57 extern struct kmem_cache *kmem_cache_create(const char *, size_t, size_t,
59 void (*)(void *, struct kmem_cache *, unsigned long),
60 void (*)(void *, struct kmem_cache *, unsigned long));
61 extern void kmem_cache_destroy(struct kmem_cache *);
62 extern int kmem_cache_shrink(struct kmem_cache *);
63 extern void *kmem_cache_alloc(struct kmem_cache *, gfp_t);
64 extern void *kmem_cache_zalloc(struct kmem_cache *, gfp_t);
65 extern void kmem_cache_free(struct kmem_cache *, void *);
66 extern unsigned int kmem_cache_size(struct kmem_cache *);
67 extern const char *kmem_cache_name(struct kmem_cache *);
69 /* Size description struct for general caches. */
72 struct kmem_cache *cs_cachep;
73 struct kmem_cache *cs_dmacachep;
75 extern struct cache_sizes malloc_sizes[];
77 extern void *__kmalloc(size_t, gfp_t);
80 * kmalloc - allocate memory
81 * @size: how many bytes of memory are required.
82 * @flags: the type of memory to allocate.
84 * kmalloc is the normal method of allocating memory
87 * The @flags argument may be one of:
89 * %GFP_USER - Allocate memory on behalf of user. May sleep.
91 * %GFP_KERNEL - Allocate normal kernel ram. May sleep.
93 * %GFP_ATOMIC - Allocation will not sleep.
94 * For example, use this inside interrupt handlers.
96 * %GFP_HIGHUSER - Allocate pages from high memory.
98 * %GFP_NOIO - Do not do any I/O at all while trying to get memory.
100 * %GFP_NOFS - Do not make any fs calls while trying to get memory.
102 * Also it is possible to set different flags by OR'ing
103 * in one or more of the following additional @flags:
105 * %__GFP_COLD - Request cache-cold pages instead of
106 * trying to return cache-warm pages.
108 * %__GFP_DMA - Request memory from the DMA-capable zone.
110 * %__GFP_HIGH - This allocation has high priority and may use emergency pools.
112 * %__GFP_HIGHMEM - Allocated memory may be from highmem.
114 * %__GFP_NOFAIL - Indicate that this allocation is in no way allowed to fail
115 * (think twice before using).
117 * %__GFP_NORETRY - If memory is not immediately available,
118 * then give up at once.
120 * %__GFP_NOWARN - If allocation fails, don't issue any warnings.
122 * %__GFP_REPEAT - If allocation fails initially, try once more before failing.
124 static inline void *kmalloc(size_t size, gfp_t flags)
126 if (__builtin_constant_p(size)) {
133 #include "kmalloc_sizes.h"
136 extern void __you_cannot_kmalloc_that_much(void);
137 __you_cannot_kmalloc_that_much();
140 return kmem_cache_alloc((flags & GFP_DMA) ?
141 malloc_sizes[i].cs_dmacachep :
142 malloc_sizes[i].cs_cachep, flags);
144 return __kmalloc(size, flags);
148 * kmalloc_track_caller is a special version of kmalloc that records the
149 * calling function of the routine calling it for slab leak tracking instead
150 * of just the calling function (confusing, eh?).
151 * It's useful when the call to kmalloc comes from a widely-used standard
152 * allocator where we care about the real place the memory allocation
153 * request comes from.
155 #ifndef CONFIG_DEBUG_SLAB
156 #define kmalloc_track_caller(size, flags) \
157 __kmalloc(size, flags)
159 extern void *__kmalloc_track_caller(size_t, gfp_t, void*);
160 #define kmalloc_track_caller(size, flags) \
161 __kmalloc_track_caller(size, flags, __builtin_return_address(0))
164 extern void *__kzalloc(size_t, gfp_t);
167 * kzalloc - allocate memory. The memory is set to zero.
168 * @size: how many bytes of memory are required.
169 * @flags: the type of memory to allocate (see kmalloc).
171 static inline void *kzalloc(size_t size, gfp_t flags)
173 if (__builtin_constant_p(size)) {
180 #include "kmalloc_sizes.h"
183 extern void __you_cannot_kzalloc_that_much(void);
184 __you_cannot_kzalloc_that_much();
187 return kmem_cache_zalloc((flags & GFP_DMA) ?
188 malloc_sizes[i].cs_dmacachep :
189 malloc_sizes[i].cs_cachep, flags);
191 return __kzalloc(size, flags);
195 * kcalloc - allocate memory for an array. The memory is set to zero.
196 * @n: number of elements.
197 * @size: element size.
198 * @flags: the type of memory to allocate.
200 static inline void *kcalloc(size_t n, size_t size, gfp_t flags)
202 if (n != 0 && size > ULONG_MAX / n)
204 return kzalloc(n * size, flags);
207 extern void kfree(const void *);
208 extern unsigned int ksize(const void *);
209 extern int slab_is_available(void);
212 extern void *kmem_cache_alloc_node(struct kmem_cache *, gfp_t flags, int node);
213 extern void *__kmalloc_node(size_t size, gfp_t flags, int node);
215 static inline void *kmalloc_node(size_t size, gfp_t flags, int node)
217 if (__builtin_constant_p(size)) {
224 #include "kmalloc_sizes.h"
227 extern void __you_cannot_kmalloc_that_much(void);
228 __you_cannot_kmalloc_that_much();
231 return kmem_cache_alloc_node((flags & GFP_DMA) ?
232 malloc_sizes[i].cs_dmacachep :
233 malloc_sizes[i].cs_cachep, flags, node);
235 return __kmalloc_node(size, flags, node);
239 * kmalloc_node_track_caller is a special version of kmalloc_node that
240 * records the calling function of the routine calling it for slab leak
241 * tracking instead of just the calling function (confusing, eh?).
242 * It's useful when the call to kmalloc_node comes from a widely-used
243 * standard allocator where we care about the real place the memory
244 * allocation request comes from.
246 #ifndef CONFIG_DEBUG_SLAB
247 #define kmalloc_node_track_caller(size, flags, node) \
248 __kmalloc_node(size, flags, node)
250 extern void *__kmalloc_node_track_caller(size_t, gfp_t, int, void *);
251 #define kmalloc_node_track_caller(size, flags, node) \
252 __kmalloc_node_track_caller(size, flags, node, \
253 __builtin_return_address(0))
255 #else /* CONFIG_NUMA */
256 static inline void *kmem_cache_alloc_node(struct kmem_cache *cachep,
257 gfp_t flags, int node)
259 return kmem_cache_alloc(cachep, flags);
261 static inline void *kmalloc_node(size_t size, gfp_t flags, int node)
263 return kmalloc(size, flags);
266 #define kmalloc_node_track_caller(size, flags, node) \
267 kmalloc_track_caller(size, flags)
270 extern int FASTCALL(kmem_cache_reap(int));
271 extern int FASTCALL(kmem_ptr_validate(struct kmem_cache *cachep, void *ptr));
273 #else /* CONFIG_SLOB */
275 /* SLOB allocator routines */
277 void kmem_cache_init(void);
278 struct kmem_cache *kmem_cache_create(const char *c, size_t, size_t,
280 void (*)(void *, struct kmem_cache *, unsigned long),
281 void (*)(void *, struct kmem_cache *, unsigned long));
282 void kmem_cache_destroy(struct kmem_cache *c);
283 void *kmem_cache_alloc(struct kmem_cache *c, gfp_t flags);
284 void *kmem_cache_zalloc(struct kmem_cache *, gfp_t);
285 void kmem_cache_free(struct kmem_cache *c, void *b);
286 const char *kmem_cache_name(struct kmem_cache *);
287 void *kmalloc(size_t size, gfp_t flags);
288 void *__kzalloc(size_t size, gfp_t flags);
289 void kfree(const void *m);
290 unsigned int ksize(const void *m);
291 unsigned int kmem_cache_size(struct kmem_cache *c);
293 static inline void *kcalloc(size_t n, size_t size, gfp_t flags)
295 return __kzalloc(n * size, flags);
298 #define kmem_cache_shrink(d) (0)
299 #define kmem_cache_reap(a)
300 #define kmem_ptr_validate(a, b) (0)
301 #define kmem_cache_alloc_node(c, f, n) kmem_cache_alloc(c, f)
302 #define kmalloc_node(s, f, n) kmalloc(s, f)
303 #define kzalloc(s, f) __kzalloc(s, f)
304 #define kmalloc_track_caller kmalloc
306 #define kmalloc_node_track_caller kmalloc_node
308 #endif /* CONFIG_SLOB */
310 #endif /* __KERNEL__ */
312 #endif /* _LINUX_SLAB_H */