1/*
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.
7 */
8
9#ifndef _LINUX_SLAB_H
10#define	_LINUX_SLAB_H
11
12#ifdef __KERNEL__
13
14#include <linux/gfp.h>
15#include <linux/types.h>
16
17typedef struct kmem_cache kmem_cache_t __deprecated;
18
19/*
20 * Flags to pass to kmem_cache_create().
21 * The ones marked DEBUG are only valid if CONFIG_SLAB_DEBUG is set.
22 */
23#define SLAB_DEBUG_FREE		0x00000100UL	/* DEBUG: Perform (expensive) checks on free */
24#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 */
27#define SLAB_CACHE_DMA		0x00004000UL	/* Use GFP_DMA memory */
28#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 */
32#define SLAB_MEM_SPREAD		0x00100000UL	/* Spread some memory over cpuset */
33#define SLAB_TRACE		0x00200000UL	/* Trace allocations and frees */
34
35/*
36 * struct kmem_cache related prototypes
37 */
38void __init kmem_cache_init(void);
39int slab_is_available(void);
40
41struct kmem_cache *kmem_cache_create(const char *, size_t, size_t,
42			unsigned long,
43			void (*)(void *, struct kmem_cache *, unsigned long),
44			void (*)(void *, struct kmem_cache *, unsigned long));
45void 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 *);
52int kmem_ptr_validate(struct kmem_cache *cachep, const void *ptr);
53
54/*
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
66#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
75
76#define KMALLOC_SHIFT_HIGH	((MAX_ORDER + PAGE_SHIFT - 1) <= 25 ? \
77				(MAX_ORDER + PAGE_SHIFT - 1) : 25)
78
79#define KMALLOC_MAX_SIZE	(1UL << KMALLOC_SHIFT_HIGH)
80#define KMALLOC_MAX_ORDER	(KMALLOC_SHIFT_HIGH - PAGE_SHIFT)
81
82/*
83 * Common kmalloc functions provided by all allocators
84 */
85void *__kmalloc(size_t, gfp_t);
86void *__kzalloc(size_t, gfp_t);
87void * __must_check krealloc(const void *, size_t, gfp_t);
88void kfree(const void *);
89size_t ksize(const void *);
90
91/**
92 * kcalloc - allocate memory for an array. The memory is set to zero.
93 * @n: number of elements.
94 * @size: element size.
95 * @flags: the type of memory to allocate.
96 */
97static inline void *kcalloc(size_t n, size_t size, gfp_t flags)
98{
99	if (n != 0 && size > ULONG_MAX / n)
100		return NULL;
101	return __kzalloc(n * size, flags);
102}
103
104/*
105 * Allocator specific definitions. These are mainly used to establish optimized
106 * ways to convert kmalloc() calls to kmem_cache_alloc() invocations by selecting
107 * the appropriate general cache at compile time.
108 */
109
110#if defined(CONFIG_SLAB) || defined(CONFIG_SLUB)
111#ifdef CONFIG_SLUB
112#include <linux/slub_def.h>
113#else
114#include <linux/slab_def.h>
115#endif /* !CONFIG_SLUB */
116#else
117
118/*
119 * Fallback definitions for an allocator not wanting to provide
120 * its own optimized kmalloc definitions (like SLOB).
121 */
122
123/**
124 * kmalloc - allocate memory
125 * @size: how many bytes of memory are required.
126 * @flags: the type of memory to allocate.
127 *
128 * kmalloc is the normal method of allocating memory
129 * in the kernel.
130 *
131 * The @flags argument may be one of:
132 *
133 * %GFP_USER - Allocate memory on behalf of user.  May sleep.
134 *
135 * %GFP_KERNEL - Allocate normal kernel ram.  May sleep.
136 *
137 * %GFP_ATOMIC - Allocation will not sleep.
138 *   For example, use this inside interrupt handlers.
139 *
140 * %GFP_HIGHUSER - Allocate pages from high memory.
141 *
142 * %GFP_NOIO - Do not do any I/O at all while trying to get memory.
143 *
144 * %GFP_NOFS - Do not make any fs calls while trying to get memory.
145 *
146 * Also it is possible to set different flags by OR'ing
147 * in one or more of the following additional @flags:
148 *
149 * %__GFP_COLD - Request cache-cold pages instead of
150 *   trying to return cache-warm pages.
151 *
152 * %__GFP_DMA - Request memory from the DMA-capable zone.
153 *
154 * %__GFP_HIGH - This allocation has high priority and may use emergency pools.
155 *
156 * %__GFP_HIGHMEM - Allocated memory may be from highmem.
157 *
158 * %__GFP_NOFAIL - Indicate that this allocation is in no way allowed to fail
159 *   (think twice before using).
160 *
161 * %__GFP_NORETRY - If memory is not immediately available,
162 *   then give up at once.
163 *
164 * %__GFP_NOWARN - If allocation fails, don't issue any warnings.
165 *
166 * %__GFP_REPEAT - If allocation fails initially, try once more before failing.
167 */
168static inline void *kmalloc(size_t size, gfp_t flags)
169{
170	return __kmalloc(size, flags);
171}
172
173/**
174 * kzalloc - allocate memory. The memory is set to zero.
175 * @size: how many bytes of memory are required.
176 * @flags: the type of memory to allocate (see kmalloc).
177 */
178static inline void *kzalloc(size_t size, gfp_t flags)
179{
180	return __kzalloc(size, flags);
181}
182#endif
183
184#ifndef CONFIG_NUMA
185static inline void *kmalloc_node(size_t size, gfp_t flags, int node)
186{
187	return kmalloc(size, flags);
188}
189
190static inline void *__kmalloc_node(size_t size, gfp_t flags, int node)
191{
192	return __kmalloc(size, flags);
193}
194#endif /* !CONFIG_NUMA */
195
196/*
197 * kmalloc_track_caller is a special version of kmalloc that records the
198 * calling function of the routine calling it for slab leak tracking instead
199 * of just the calling function (confusing, eh?).
200 * It's useful when the call to kmalloc comes from a widely-used standard
201 * allocator where we care about the real place the memory allocation
202 * request comes from.
203 */
204#if defined(CONFIG_DEBUG_SLAB) || defined(CONFIG_SLUB)
205extern void *__kmalloc_track_caller(size_t, gfp_t, void*);
206#define kmalloc_track_caller(size, flags) \
207	__kmalloc_track_caller(size, flags, __builtin_return_address(0))
208#else
209#define kmalloc_track_caller(size, flags) \
210	__kmalloc(size, flags)
211#endif /* DEBUG_SLAB */
212
213#ifdef CONFIG_NUMA
214/*
215 * kmalloc_node_track_caller is a special version of kmalloc_node that
216 * records the calling function of the routine calling it for slab leak
217 * tracking instead of just the calling function (confusing, eh?).
218 * It's useful when the call to kmalloc_node comes from a widely-used
219 * standard allocator where we care about the real place the memory
220 * allocation request comes from.
221 */
222#if defined(CONFIG_DEBUG_SLAB) || defined(CONFIG_SLUB)
223extern void *__kmalloc_node_track_caller(size_t, gfp_t, int, void *);
224#define kmalloc_node_track_caller(size, flags, node) \
225	__kmalloc_node_track_caller(size, flags, node, \
226			__builtin_return_address(0))
227#else
228#define kmalloc_node_track_caller(size, flags, node) \
229	__kmalloc_node(size, flags, node)
230#endif
231
232#else /* CONFIG_NUMA */
233
234#define kmalloc_node_track_caller(size, flags, node) \
235	kmalloc_track_caller(size, flags)
236
237#endif /* DEBUG_SLAB */
238
239#endif	/* __KERNEL__ */
240#endif	/* _LINUX_SLAB_H */
241