2 * Written by Mark Hemment, 1996 (markhe@nextd.demon.co.uk).
4 * (C) SGI 2006, Christoph Lameter
5 * Cleaned up and restructured to ease the addition of alternative
6 * implementations of SLAB allocators.
12 #include <linux/gfp.h>
13 #include <linux/types.h>
16 * Flags to pass to kmem_cache_create().
17 * The ones marked DEBUG are only valid if CONFIG_SLAB_DEBUG is set.
19 #define SLAB_DEBUG_FREE 0x00000100UL /* DEBUG: Perform (expensive) checks on free */
20 #define SLAB_RED_ZONE 0x00000400UL /* DEBUG: Red zone objs in a cache */
21 #define SLAB_POISON 0x00000800UL /* DEBUG: Poison objects */
22 #define SLAB_HWCACHE_ALIGN 0x00002000UL /* Align objs on cache lines */
23 #define SLAB_CACHE_DMA 0x00004000UL /* Use GFP_DMA memory */
24 #define SLAB_STORE_USER 0x00010000UL /* DEBUG: Store the last owner for bug hunting */
25 #define SLAB_PANIC 0x00040000UL /* Panic if kmem_cache_create() fails */
27 * SLAB_DESTROY_BY_RCU - **WARNING** READ THIS!
29 * This delays freeing the SLAB page by a grace period, it does _NOT_
30 * delay object freeing. This means that if you do kmem_cache_free()
31 * that memory location is free to be reused at any time. Thus it may
32 * be possible to see another object there in the same RCU grace period.
34 * This feature only ensures the memory location backing the object
35 * stays valid, the trick to using this is relying on an independent
36 * object validation pass. Something like:
40 * obj = lockless_lookup(key);
42 * if (!try_get_ref(obj)) // might fail for free objects
45 * if (obj->key != key) { // not the object we expected
52 * See also the comment on struct slab_rcu in mm/slab.c.
54 #define SLAB_DESTROY_BY_RCU 0x00080000UL /* Defer freeing slabs to RCU */
55 #define SLAB_MEM_SPREAD 0x00100000UL /* Spread some memory over cpuset */
56 #define SLAB_TRACE 0x00200000UL /* Trace allocations and frees */
58 /* Flag to prevent checks on free */
59 #ifdef CONFIG_DEBUG_OBJECTS
60 # define SLAB_DEBUG_OBJECTS 0x00400000UL
62 # define SLAB_DEBUG_OBJECTS 0x00000000UL
65 #define SLAB_NOLEAKTRACE 0x00800000UL /* Avoid kmemleak tracing */
67 /* Don't track use of uninitialized memory */
68 #ifdef CONFIG_KMEMCHECK
69 # define SLAB_NOTRACK 0x01000000UL
71 # define SLAB_NOTRACK 0x00000000UL
73 #ifdef CONFIG_FAILSLAB
74 # define SLAB_FAILSLAB 0x02000000UL /* Fault injection mark */
76 # define SLAB_FAILSLAB 0x00000000UL
79 /* The following flags affect the page allocator grouping pages by mobility */
80 #define SLAB_RECLAIM_ACCOUNT 0x00020000UL /* Objects are reclaimable */
81 #define SLAB_TEMPORARY SLAB_RECLAIM_ACCOUNT /* Objects are short-lived */
83 * ZERO_SIZE_PTR will be returned for zero sized kmalloc requests.
85 * Dereferencing ZERO_SIZE_PTR will lead to a distinct access fault.
87 * ZERO_SIZE_PTR can be passed to kfree though in the same way that NULL can.
88 * Both make kfree a no-op.
90 #define ZERO_SIZE_PTR ((void *)16)
92 #define ZERO_OR_NULL_PTR(x) ((unsigned long)(x) <= \
93 (unsigned long)ZERO_SIZE_PTR)
96 * struct kmem_cache related prototypes
98 void __init
kmem_cache_init(void);
99 int slab_is_available(void);
101 struct kmem_cache
*kmem_cache_create(const char *, size_t, size_t,
104 void kmem_cache_destroy(struct kmem_cache
*);
105 int kmem_cache_shrink(struct kmem_cache
*);
106 void kmem_cache_free(struct kmem_cache
*, void *);
107 unsigned int kmem_cache_size(struct kmem_cache
*);
108 const char *kmem_cache_name(struct kmem_cache
*);
109 int kern_ptr_validate(const void *ptr
, unsigned long size
);
110 int kmem_ptr_validate(struct kmem_cache
*cachep
, const void *ptr
);
113 * Please use this macro to create slab caches. Simply specify the
114 * name of the structure and maybe some flags that are listed above.
116 * The alignment of the struct determines object alignment. If you
117 * f.e. add ____cacheline_aligned_in_smp to the struct declaration
118 * then the objects will be properly aligned in SMP configurations.
120 #define KMEM_CACHE(__struct, __flags) kmem_cache_create(#__struct,\
121 sizeof(struct __struct), __alignof__(struct __struct),\
125 * The largest kmalloc size supported by the slab allocators is
126 * 32 megabyte (2^25) or the maximum allocatable page order if that is
129 * WARNING: Its not easy to increase this value since the allocators have
130 * to do various tricks to work around compiler limitations in order to
131 * ensure proper constant folding.
133 #define KMALLOC_SHIFT_HIGH ((MAX_ORDER + PAGE_SHIFT - 1) <= 25 ? \
134 (MAX_ORDER + PAGE_SHIFT - 1) : 25)
136 #define KMALLOC_MAX_SIZE (1UL << KMALLOC_SHIFT_HIGH)
137 #define KMALLOC_MAX_ORDER (KMALLOC_SHIFT_HIGH - PAGE_SHIFT)
140 * Common kmalloc functions provided by all allocators
142 void * __must_check
__krealloc(const void *, size_t, gfp_t
);
143 void * __must_check
krealloc(const void *, size_t, gfp_t
);
144 void kfree(const void *);
145 void kzfree(const void *);
146 size_t ksize(const void *);
149 * Allocator specific definitions. These are mainly used to establish optimized
150 * ways to convert kmalloc() calls to kmem_cache_alloc() invocations by
151 * selecting the appropriate general cache at compile time.
153 * Allocators must define at least:
159 * Those wishing to support NUMA must also define:
161 * kmem_cache_alloc_node()
164 * See each allocator definition file for additional comments and
165 * implementation notes.
168 #include <linux/slub_def.h>
169 #elif defined(CONFIG_SLOB)
170 #include <linux/slob_def.h>
172 #include <linux/slab_def.h>
176 * kcalloc - allocate memory for an array. The memory is set to zero.
177 * @n: number of elements.
178 * @size: element size.
179 * @flags: the type of memory to allocate.
181 * The @flags argument may be one of:
183 * %GFP_USER - Allocate memory on behalf of user. May sleep.
185 * %GFP_KERNEL - Allocate normal kernel ram. May sleep.
187 * %GFP_ATOMIC - Allocation will not sleep. May use emergency pools.
188 * For example, use this inside interrupt handlers.
190 * %GFP_HIGHUSER - Allocate pages from high memory.
192 * %GFP_NOIO - Do not do any I/O at all while trying to get memory.
194 * %GFP_NOFS - Do not make any fs calls while trying to get memory.
196 * %GFP_NOWAIT - Allocation will not sleep.
198 * %GFP_THISNODE - Allocate node-local memory only.
200 * %GFP_DMA - Allocation suitable for DMA.
201 * Should only be used for kmalloc() caches. Otherwise, use a
202 * slab created with SLAB_DMA.
204 * Also it is possible to set different flags by OR'ing
205 * in one or more of the following additional @flags:
207 * %__GFP_COLD - Request cache-cold pages instead of
208 * trying to return cache-warm pages.
210 * %__GFP_HIGH - This allocation has high priority and may use emergency pools.
212 * %__GFP_NOFAIL - Indicate that this allocation is in no way allowed to fail
213 * (think twice before using).
215 * %__GFP_NORETRY - If memory is not immediately available,
216 * then give up at once.
218 * %__GFP_NOWARN - If allocation fails, don't issue any warnings.
220 * %__GFP_REPEAT - If allocation fails initially, try once more before failing.
222 * There are other flags available as well, but these are not intended
223 * for general use, and so are not documented here. For a full list of
224 * potential flags, always refer to linux/gfp.h.
226 static inline void *kcalloc(size_t n
, size_t size
, gfp_t flags
)
228 if (size
!= 0 && n
> ULONG_MAX
/ size
)
230 return __kmalloc(n
* size
, flags
| __GFP_ZERO
);
233 #if !defined(CONFIG_NUMA) && !defined(CONFIG_SLOB)
235 * kmalloc_node - allocate memory from a specific node
236 * @size: how many bytes of memory are required.
237 * @flags: the type of memory to allocate (see kcalloc).
238 * @node: node to allocate from.
240 * kmalloc() for non-local nodes, used to allocate from a specific node
241 * if available. Equivalent to kmalloc() in the non-NUMA single-node
244 static inline void *kmalloc_node(size_t size
, gfp_t flags
, int node
)
246 return kmalloc(size
, flags
);
249 static inline void *__kmalloc_node(size_t size
, gfp_t flags
, int node
)
251 return __kmalloc(size
, flags
);
254 void *kmem_cache_alloc(struct kmem_cache
*, gfp_t
);
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 #endif /* !CONFIG_NUMA && !CONFIG_SLOB */
264 * kmalloc_track_caller is a special version of kmalloc that records the
265 * calling function of the routine calling it for slab leak tracking instead
266 * of just the calling function (confusing, eh?).
267 * It's useful when the call to kmalloc comes from a widely-used standard
268 * allocator where we care about the real place the memory allocation
269 * request comes from.
271 #if defined(CONFIG_DEBUG_SLAB) || defined(CONFIG_SLUB)
272 extern void *__kmalloc_track_caller(size_t, gfp_t
, unsigned long);
273 #define kmalloc_track_caller(size, flags) \
274 __kmalloc_track_caller(size, flags, _RET_IP_)
276 #define kmalloc_track_caller(size, flags) \
277 __kmalloc(size, flags)
278 #endif /* DEBUG_SLAB */
282 * kmalloc_node_track_caller is a special version of kmalloc_node that
283 * records the calling function of the routine calling it for slab leak
284 * tracking instead of just the calling function (confusing, eh?).
285 * It's useful when the call to kmalloc_node comes from a widely-used
286 * standard allocator where we care about the real place the memory
287 * allocation request comes from.
289 #if defined(CONFIG_DEBUG_SLAB) || defined(CONFIG_SLUB)
290 extern void *__kmalloc_node_track_caller(size_t, gfp_t
, int, unsigned long);
291 #define kmalloc_node_track_caller(size, flags, node) \
292 __kmalloc_node_track_caller(size, flags, node, \
295 #define kmalloc_node_track_caller(size, flags, node) \
296 __kmalloc_node(size, flags, node)
299 #else /* CONFIG_NUMA */
301 #define kmalloc_node_track_caller(size, flags, node) \
302 kmalloc_track_caller(size, flags)
304 #endif /* CONFIG_NUMA */
309 static inline void *kmem_cache_zalloc(struct kmem_cache
*k
, gfp_t flags
)
311 return kmem_cache_alloc(k
, flags
| __GFP_ZERO
);
315 * kzalloc - allocate memory. The memory is set to zero.
316 * @size: how many bytes of memory are required.
317 * @flags: the type of memory to allocate (see kmalloc).
319 static inline void *kzalloc(size_t size
, gfp_t flags
)
321 return kmalloc(size
, flags
| __GFP_ZERO
);
325 * kzalloc_node - allocate zeroed memory from a particular memory node.
326 * @size: how many bytes of memory are required.
327 * @flags: the type of memory to allocate (see kmalloc).
328 * @node: memory node from which to allocate
330 static inline void *kzalloc_node(size_t size
, gfp_t flags
, int node
)
332 return kmalloc_node(size
, flags
| __GFP_ZERO
, node
);
335 void __init
kmem_cache_init_late(void);
337 #endif /* _LINUX_SLAB_H */
This page took 0.037104 seconds and 5 git commands to generate.