blob: 6fb2ae214152b5e8b733eaceb2748e4af79d807f [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Christoph Lameter2e892f42006-12-13 00:34:23 -08002 * 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.
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 */
8
9#ifndef _LINUX_SLAB_H
10#define _LINUX_SLAB_H
11
Andrew Morton1b1cec42006-12-06 20:33:22 -080012#ifdef __KERNEL__
13
14#include <linux/gfp.h>
Andrew Morton1b1cec42006-12-06 20:33:22 -080015#include <linux/types.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070016
Andrew Morton1b1cec42006-12-06 20:33:22 -080017typedef struct kmem_cache kmem_cache_t __deprecated;
Linus Torvalds1da177e2005-04-16 15:20:36 -070018
Christoph Lameter2e892f42006-12-13 00:34:23 -080019/*
20 * Flags to pass to kmem_cache_create().
21 * The ones marked DEBUG are only valid if CONFIG_SLAB_DEBUG is set.
Linus Torvalds1da177e2005-04-16 15:20:36 -070022 */
Christoph Lameter55935a32006-12-13 00:34:24 -080023#define SLAB_DEBUG_FREE 0x00000100UL /* DEBUG: Perform (expensive) checks on free */
Christoph Lameter55935a32006-12-13 00:34:24 -080024#define SLAB_RED_ZONE 0x00000400UL /* DEBUG: Red zone objs in a cache */
25#define SLAB_POISON 0x00000800UL /* DEBUG: Poison objects */
26#define SLAB_HWCACHE_ALIGN 0x00002000UL /* Align objs on cache lines */
Christoph Lameter2e892f42006-12-13 00:34:23 -080027#define SLAB_CACHE_DMA 0x00004000UL /* Use GFP_DMA memory */
Christoph Lameter2e892f42006-12-13 00:34:23 -080028#define SLAB_STORE_USER 0x00010000UL /* DEBUG: Store the last owner for bug hunting */
29#define SLAB_RECLAIM_ACCOUNT 0x00020000UL /* Objects are reclaimable */
30#define SLAB_PANIC 0x00040000UL /* Panic if kmem_cache_create() fails */
31#define SLAB_DESTROY_BY_RCU 0x00080000UL /* Defer freeing slabs to RCU */
Paul Jackson101a5002006-03-24 03:16:07 -080032#define SLAB_MEM_SPREAD 0x00100000UL /* Spread some memory over cpuset */
Christoph Lameter81819f02007-05-06 14:49:36 -070033#define SLAB_TRACE 0x00200000UL /* Trace allocations and frees */
Linus Torvalds1da177e2005-04-16 15:20:36 -070034
Christoph Lameter2e892f42006-12-13 00:34:23 -080035/*
36 * struct kmem_cache related prototypes
37 */
38void __init kmem_cache_init(void);
Christoph Lameter81819f02007-05-06 14:49:36 -070039int slab_is_available(void);
Matt Mackall10cef602006-01-08 01:01:45 -080040
Christoph Lameter2e892f42006-12-13 00:34:23 -080041struct kmem_cache *kmem_cache_create(const char *, size_t, size_t,
Christoph Lameterebe29732006-12-06 20:32:59 -080042 unsigned long,
43 void (*)(void *, struct kmem_cache *, unsigned long),
44 void (*)(void *, struct kmem_cache *, unsigned long));
Christoph Lameter2e892f42006-12-13 00:34:23 -080045void kmem_cache_destroy(struct kmem_cache *);
46int kmem_cache_shrink(struct kmem_cache *);
47void *kmem_cache_alloc(struct kmem_cache *, gfp_t);
48void *kmem_cache_zalloc(struct kmem_cache *, gfp_t);
49void kmem_cache_free(struct kmem_cache *, void *);
50unsigned int kmem_cache_size(struct kmem_cache *);
51const char *kmem_cache_name(struct kmem_cache *);
Christoph Lameter55935a32006-12-13 00:34:24 -080052int kmem_ptr_validate(struct kmem_cache *cachep, const void *ptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -070053
Christoph Lameter0a31bd52007-05-06 14:49:57 -070054/*
55 * Please use this macro to create slab caches. Simply specify the
56 * name of the structure and maybe some flags that are listed above.
57 *
58 * The alignment of the struct determines object alignment. If you
59 * f.e. add ____cacheline_aligned_in_smp to the struct declaration
60 * then the objects will be properly aligned in SMP configurations.
61 */
62#define KMEM_CACHE(__struct, __flags) kmem_cache_create(#__struct,\
63 sizeof(struct __struct), __alignof__(struct __struct),\
64 (__flags), NULL, NULL)
65
Christoph Lameter2e892f42006-12-13 00:34:23 -080066#ifdef CONFIG_NUMA
67extern void *kmem_cache_alloc_node(struct kmem_cache *, gfp_t flags, int node);
68#else
69static inline void *kmem_cache_alloc_node(struct kmem_cache *cachep,
70 gfp_t flags, int node)
71{
72 return kmem_cache_alloc(cachep, flags);
73}
74#endif
Pekka Enberg7fd6b142006-02-01 03:05:52 -080075
Christoph Lameter2e892f42006-12-13 00:34:23 -080076/*
77 * Common kmalloc functions provided by all allocators
78 */
79void *__kmalloc(size_t, gfp_t);
80void *__kzalloc(size_t, gfp_t);
Pekka Enbergfd76bab2007-05-06 14:48:40 -070081void * __must_check krealloc(const void *, size_t, gfp_t);
Christoph Lameter2e892f42006-12-13 00:34:23 -080082void kfree(const void *);
Pekka Enbergfd76bab2007-05-06 14:48:40 -070083size_t ksize(const void *);
Christoph Lameter2e892f42006-12-13 00:34:23 -080084
85/**
86 * kcalloc - allocate memory for an array. The memory is set to zero.
87 * @n: number of elements.
88 * @size: element size.
89 * @flags: the type of memory to allocate.
90 */
91static inline void *kcalloc(size_t n, size_t size, gfp_t flags)
92{
93 if (n != 0 && size > ULONG_MAX / n)
94 return NULL;
95 return __kzalloc(n * size, flags);
96}
97
98/*
99 * Allocator specific definitions. These are mainly used to establish optimized
100 * ways to convert kmalloc() calls to kmem_cache_alloc() invocations by selecting
101 * the appropriate general cache at compile time.
102 */
Christoph Lameter55935a32006-12-13 00:34:24 -0800103
Christoph Lameter81819f02007-05-06 14:49:36 -0700104#if defined(CONFIG_SLAB) || defined(CONFIG_SLUB)
105#ifdef CONFIG_SLUB
106#include <linux/slub_def.h>
Christoph Lameter2e892f42006-12-13 00:34:23 -0800107#else
Christoph Lameter81819f02007-05-06 14:49:36 -0700108#include <linux/slab_def.h>
109#endif /* !CONFIG_SLUB */
110#else
111
Christoph Lameter2e892f42006-12-13 00:34:23 -0800112/*
113 * Fallback definitions for an allocator not wanting to provide
114 * its own optimized kmalloc definitions (like SLOB).
115 */
116
Paul Drynoff800590f2006-06-23 02:03:48 -0700117/**
118 * kmalloc - allocate memory
119 * @size: how many bytes of memory are required.
120 * @flags: the type of memory to allocate.
121 *
122 * kmalloc is the normal method of allocating memory
123 * in the kernel.
124 *
125 * The @flags argument may be one of:
126 *
127 * %GFP_USER - Allocate memory on behalf of user. May sleep.
128 *
129 * %GFP_KERNEL - Allocate normal kernel ram. May sleep.
130 *
131 * %GFP_ATOMIC - Allocation will not sleep.
132 * For example, use this inside interrupt handlers.
133 *
134 * %GFP_HIGHUSER - Allocate pages from high memory.
135 *
136 * %GFP_NOIO - Do not do any I/O at all while trying to get memory.
137 *
138 * %GFP_NOFS - Do not make any fs calls while trying to get memory.
139 *
140 * Also it is possible to set different flags by OR'ing
141 * in one or more of the following additional @flags:
142 *
143 * %__GFP_COLD - Request cache-cold pages instead of
144 * trying to return cache-warm pages.
145 *
146 * %__GFP_DMA - Request memory from the DMA-capable zone.
147 *
148 * %__GFP_HIGH - This allocation has high priority and may use emergency pools.
149 *
150 * %__GFP_HIGHMEM - Allocated memory may be from highmem.
151 *
152 * %__GFP_NOFAIL - Indicate that this allocation is in no way allowed to fail
153 * (think twice before using).
154 *
155 * %__GFP_NORETRY - If memory is not immediately available,
156 * then give up at once.
157 *
158 * %__GFP_NOWARN - If allocation fails, don't issue any warnings.
159 *
160 * %__GFP_REPEAT - If allocation fails initially, try once more before failing.
161 */
Christoph Lameter55935a32006-12-13 00:34:24 -0800162static inline void *kmalloc(size_t size, gfp_t flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164 return __kmalloc(size, flags);
165}
166
Christoph Lameter2e892f42006-12-13 00:34:23 -0800167/**
168 * kzalloc - allocate memory. The memory is set to zero.
169 * @size: how many bytes of memory are required.
170 * @flags: the type of memory to allocate (see kmalloc).
171 */
Christoph Lameter55935a32006-12-13 00:34:24 -0800172static inline void *kzalloc(size_t size, gfp_t flags)
Christoph Lameter2e892f42006-12-13 00:34:23 -0800173{
174 return __kzalloc(size, flags);
175}
176#endif
177
Christoph Lameter55935a32006-12-13 00:34:24 -0800178#ifndef CONFIG_NUMA
179static inline void *kmalloc_node(size_t size, gfp_t flags, int node)
180{
181 return kmalloc(size, flags);
182}
183
184static inline void *__kmalloc_node(size_t size, gfp_t flags, int node)
185{
186 return __kmalloc(size, flags);
187}
188#endif /* !CONFIG_NUMA */
189
Christoph Hellwig1d2c8ee2006-10-04 02:15:25 -0700190/*
191 * kmalloc_track_caller is a special version of kmalloc that records the
192 * calling function of the routine calling it for slab leak tracking instead
193 * of just the calling function (confusing, eh?).
194 * It's useful when the call to kmalloc comes from a widely-used standard
195 * allocator where we care about the real place the memory allocation
196 * request comes from.
197 */
Christoph Lameter81819f02007-05-06 14:49:36 -0700198#if defined(CONFIG_DEBUG_SLAB) || defined(CONFIG_SLUB)
Christoph Hellwig1d2c8ee2006-10-04 02:15:25 -0700199extern void *__kmalloc_track_caller(size_t, gfp_t, void*);
200#define kmalloc_track_caller(size, flags) \
201 __kmalloc_track_caller(size, flags, __builtin_return_address(0))
Christoph Lameter2e892f42006-12-13 00:34:23 -0800202#else
203#define kmalloc_track_caller(size, flags) \
204 __kmalloc(size, flags)
205#endif /* DEBUG_SLAB */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206
Manfred Spraul97e2bde2005-05-01 08:58:38 -0700207#ifdef CONFIG_NUMA
Christoph Hellwig8b98c162006-12-06 20:32:30 -0800208/*
209 * kmalloc_node_track_caller is a special version of kmalloc_node that
210 * records the calling function of the routine calling it for slab leak
211 * tracking instead of just the calling function (confusing, eh?).
212 * It's useful when the call to kmalloc_node comes from a widely-used
213 * standard allocator where we care about the real place the memory
214 * allocation request comes from.
215 */
Christoph Lameter81819f02007-05-06 14:49:36 -0700216#if defined(CONFIG_DEBUG_SLAB) || defined(CONFIG_SLUB)
Christoph Hellwig8b98c162006-12-06 20:32:30 -0800217extern void *__kmalloc_node_track_caller(size_t, gfp_t, int, void *);
218#define kmalloc_node_track_caller(size, flags, node) \
219 __kmalloc_node_track_caller(size, flags, node, \
220 __builtin_return_address(0))
Christoph Lameter2e892f42006-12-13 00:34:23 -0800221#else
222#define kmalloc_node_track_caller(size, flags, node) \
223 __kmalloc_node(size, flags, node)
Christoph Hellwig8b98c162006-12-06 20:32:30 -0800224#endif
Christoph Lameter2e892f42006-12-13 00:34:23 -0800225
Christoph Hellwig8b98c162006-12-06 20:32:30 -0800226#else /* CONFIG_NUMA */
Christoph Lameter2e892f42006-12-13 00:34:23 -0800227
228#define kmalloc_node_track_caller(size, flags, node) \
229 kmalloc_track_caller(size, flags)
230
Christoph Lameter55935a32006-12-13 00:34:24 -0800231#endif /* DEBUG_SLAB */
Christoph Hellwig8b98c162006-12-06 20:32:30 -0800232
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233#endif /* __KERNEL__ */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234#endif /* _LINUX_SLAB_H */
Christoph Lameter2e892f42006-12-13 00:34:23 -0800235