c01780540054bb00c9a2eee68ba4a223990c947c
[firefly-linux-kernel-4.4.55.git] / include / linux / slab.h
1 /*
2  * Written by Mark Hemment, 1996 (markhe@nextd.demon.co.uk).
3  *
4  * (C) SGI 2006, Christoph Lameter
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 #include <linux/gfp.h>
13 #include <linux/types.h>
14 #include <linux/workqueue.h>
15
16
17 /*
18  * Flags to pass to kmem_cache_create().
19  * The ones marked DEBUG are only valid if CONFIG_SLAB_DEBUG is set.
20  */
21 #define SLAB_DEBUG_FREE         0x00000100UL    /* DEBUG: Perform (expensive) checks on free */
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 */
25 #define SLAB_CACHE_DMA          0x00004000UL    /* Use GFP_DMA memory */
26 #define SLAB_STORE_USER         0x00010000UL    /* DEBUG: Store the last owner for bug hunting */
27 #define SLAB_PANIC              0x00040000UL    /* Panic if kmem_cache_create() fails */
28 /*
29  * SLAB_DESTROY_BY_RCU - **WARNING** READ THIS!
30  *
31  * This delays freeing the SLAB page by a grace period, it does _NOT_
32  * delay object freeing. This means that if you do kmem_cache_free()
33  * that memory location is free to be reused at any time. Thus it may
34  * be possible to see another object there in the same RCU grace period.
35  *
36  * This feature only ensures the memory location backing the object
37  * stays valid, the trick to using this is relying on an independent
38  * object validation pass. Something like:
39  *
40  *  rcu_read_lock()
41  * again:
42  *  obj = lockless_lookup(key);
43  *  if (obj) {
44  *    if (!try_get_ref(obj)) // might fail for free objects
45  *      goto again;
46  *
47  *    if (obj->key != key) { // not the object we expected
48  *      put_ref(obj);
49  *      goto again;
50  *    }
51  *  }
52  *  rcu_read_unlock();
53  *
54  * See also the comment on struct slab_rcu in mm/slab.c.
55  */
56 #define SLAB_DESTROY_BY_RCU     0x00080000UL    /* Defer freeing slabs to RCU */
57 #define SLAB_MEM_SPREAD         0x00100000UL    /* Spread some memory over cpuset */
58 #define SLAB_TRACE              0x00200000UL    /* Trace allocations and frees */
59
60 /* Flag to prevent checks on free */
61 #ifdef CONFIG_DEBUG_OBJECTS
62 # define SLAB_DEBUG_OBJECTS     0x00400000UL
63 #else
64 # define SLAB_DEBUG_OBJECTS     0x00000000UL
65 #endif
66
67 #define SLAB_NOLEAKTRACE        0x00800000UL    /* Avoid kmemleak tracing */
68
69 /* Don't track use of uninitialized memory */
70 #ifdef CONFIG_KMEMCHECK
71 # define SLAB_NOTRACK           0x01000000UL
72 #else
73 # define SLAB_NOTRACK           0x00000000UL
74 #endif
75 #ifdef CONFIG_FAILSLAB
76 # define SLAB_FAILSLAB          0x02000000UL    /* Fault injection mark */
77 #else
78 # define SLAB_FAILSLAB          0x00000000UL
79 #endif
80
81 /* The following flags affect the page allocator grouping pages by mobility */
82 #define SLAB_RECLAIM_ACCOUNT    0x00020000UL            /* Objects are reclaimable */
83 #define SLAB_TEMPORARY          SLAB_RECLAIM_ACCOUNT    /* Objects are short-lived */
84 /*
85  * ZERO_SIZE_PTR will be returned for zero sized kmalloc requests.
86  *
87  * Dereferencing ZERO_SIZE_PTR will lead to a distinct access fault.
88  *
89  * ZERO_SIZE_PTR can be passed to kfree though in the same way that NULL can.
90  * Both make kfree a no-op.
91  */
92 #define ZERO_SIZE_PTR ((void *)16)
93
94 #define ZERO_OR_NULL_PTR(x) ((unsigned long)(x) <= \
95                                 (unsigned long)ZERO_SIZE_PTR)
96
97
98 struct mem_cgroup;
99 /*
100  * struct kmem_cache related prototypes
101  */
102 void __init kmem_cache_init(void);
103 int slab_is_available(void);
104
105 struct kmem_cache *kmem_cache_create(const char *, size_t, size_t,
106                         unsigned long,
107                         void (*)(void *));
108 struct kmem_cache *
109 kmem_cache_create_memcg(struct mem_cgroup *, const char *, size_t, size_t,
110                         unsigned long, void (*)(void *), struct kmem_cache *);
111 void kmem_cache_destroy(struct kmem_cache *);
112 int kmem_cache_shrink(struct kmem_cache *);
113 void kmem_cache_free(struct kmem_cache *, void *);
114
115 /*
116  * Please use this macro to create slab caches. Simply specify the
117  * name of the structure and maybe some flags that are listed above.
118  *
119  * The alignment of the struct determines object alignment. If you
120  * f.e. add ____cacheline_aligned_in_smp to the struct declaration
121  * then the objects will be properly aligned in SMP configurations.
122  */
123 #define KMEM_CACHE(__struct, __flags) kmem_cache_create(#__struct,\
124                 sizeof(struct __struct), __alignof__(struct __struct),\
125                 (__flags), NULL)
126
127 /*
128  * Common kmalloc functions provided by all allocators
129  */
130 void * __must_check __krealloc(const void *, size_t, gfp_t);
131 void * __must_check krealloc(const void *, size_t, gfp_t);
132 void kfree(const void *);
133 void kzfree(const void *);
134 size_t ksize(const void *);
135
136 #ifdef CONFIG_SLOB
137 /*
138  * Common fields provided in kmem_cache by all slab allocators
139  * This struct is either used directly by the allocator (SLOB)
140  * or the allocator must include definitions for all fields
141  * provided in kmem_cache_common in their definition of kmem_cache.
142  *
143  * Once we can do anonymous structs (C11 standard) we could put a
144  * anonymous struct definition in these allocators so that the
145  * separate allocations in the kmem_cache structure of SLAB and
146  * SLUB is no longer needed.
147  */
148 struct kmem_cache {
149         unsigned int object_size;/* The original size of the object */
150         unsigned int size;      /* The aligned/padded/added on size  */
151         unsigned int align;     /* Alignment as calculated */
152         unsigned long flags;    /* Active flags on the slab */
153         const char *name;       /* Slab name for sysfs */
154         int refcount;           /* Use counter */
155         void (*ctor)(void *);   /* Called on object slot creation */
156         struct list_head list;  /* List of all slab caches on the system */
157 };
158
159 #define KMALLOC_MAX_SIZE (1UL << 30)
160
161 #include <linux/slob_def.h>
162
163 #else /* CONFIG_SLOB */
164
165 /*
166  * Kmalloc array related definitions
167  */
168
169 #ifdef CONFIG_SLAB
170 /*
171  * The largest kmalloc size supported by the SLAB allocators is
172  * 32 megabyte (2^25) or the maximum allocatable page order if that is
173  * less than 32 MB.
174  *
175  * WARNING: Its not easy to increase this value since the allocators have
176  * to do various tricks to work around compiler limitations in order to
177  * ensure proper constant folding.
178  */
179 #define KMALLOC_SHIFT_HIGH      ((MAX_ORDER + PAGE_SHIFT - 1) <= 25 ? \
180                                 (MAX_ORDER + PAGE_SHIFT - 1) : 25)
181 #define KMALLOC_SHIFT_MAX       KMALLOC_SHIFT_HIGH
182 #define KMALLOC_SHIFT_LOW       5
183 #else
184 /*
185  * SLUB allocates up to order 2 pages directly and otherwise
186  * passes the request to the page allocator.
187  */
188 #define KMALLOC_SHIFT_HIGH      (PAGE_SHIFT + 1)
189 #define KMALLOC_SHIFT_MAX       (MAX_ORDER + PAGE_SHIFT)
190 #define KMALLOC_SHIFT_LOW       3
191 #endif
192
193 /* Maximum allocatable size */
194 #define KMALLOC_MAX_SIZE        (1UL << KMALLOC_SHIFT_MAX)
195 /* Maximum size for which we actually use a slab cache */
196 #define KMALLOC_MAX_CACHE_SIZE  (1UL << KMALLOC_SHIFT_HIGH)
197 /* Maximum order allocatable via the slab allocagtor */
198 #define KMALLOC_MAX_ORDER       (KMALLOC_SHIFT_MAX - PAGE_SHIFT)
199
200 /*
201  * Kmalloc subsystem.
202  */
203 #if defined(ARCH_DMA_MINALIGN) && ARCH_DMA_MINALIGN > 8
204 #define KMALLOC_MIN_SIZE ARCH_DMA_MINALIGN
205 #else
206 #define KMALLOC_MIN_SIZE (1 << KMALLOC_SHIFT_LOW)
207 #endif
208
209 /*
210  * Figure out which kmalloc slab an allocation of a certain size
211  * belongs to.
212  * 0 = zero alloc
213  * 1 =  65 .. 96 bytes
214  * 2 = 120 .. 192 bytes
215  * n = 2^(n-1) .. 2^n -1
216  */
217 static __always_inline int kmalloc_index(size_t size)
218 {
219         if (!size)
220                 return 0;
221
222         if (size <= KMALLOC_MIN_SIZE)
223                 return KMALLOC_SHIFT_LOW;
224
225         if (KMALLOC_MIN_SIZE <= 32 && size > 64 && size <= 96)
226                 return 1;
227         if (KMALLOC_MIN_SIZE <= 64 && size > 128 && size <= 192)
228                 return 2;
229         if (size <=          8) return 3;
230         if (size <=         16) return 4;
231         if (size <=         32) return 5;
232         if (size <=         64) return 6;
233         if (size <=        128) return 7;
234         if (size <=        256) return 8;
235         if (size <=        512) return 9;
236         if (size <=       1024) return 10;
237         if (size <=   2 * 1024) return 11;
238         if (size <=   4 * 1024) return 12;
239         if (size <=   8 * 1024) return 13;
240         if (size <=  16 * 1024) return 14;
241         if (size <=  32 * 1024) return 15;
242         if (size <=  64 * 1024) return 16;
243         if (size <= 128 * 1024) return 17;
244         if (size <= 256 * 1024) return 18;
245         if (size <= 512 * 1024) return 19;
246         if (size <= 1024 * 1024) return 20;
247         if (size <=  2 * 1024 * 1024) return 21;
248         if (size <=  4 * 1024 * 1024) return 22;
249         if (size <=  8 * 1024 * 1024) return 23;
250         if (size <=  16 * 1024 * 1024) return 24;
251         if (size <=  32 * 1024 * 1024) return 25;
252         if (size <=  64 * 1024 * 1024) return 26;
253         BUG();
254
255         /* Will never be reached. Needed because the compiler may complain */
256         return -1;
257 }
258
259 #ifdef CONFIG_SLAB
260 #include <linux/slab_def.h>
261 #elif defined(CONFIG_SLUB)
262 #include <linux/slub_def.h>
263 #else
264 #error "Unknown slab allocator"
265 #endif
266
267 /*
268  * Determine size used for the nth kmalloc cache.
269  * return size or 0 if a kmalloc cache for that
270  * size does not exist
271  */
272 static __always_inline int kmalloc_size(int n)
273 {
274         if (n > 2)
275                 return 1 << n;
276
277         if (n == 1 && KMALLOC_MIN_SIZE <= 32)
278                 return 96;
279
280         if (n == 2 && KMALLOC_MIN_SIZE <= 64)
281                 return 192;
282
283         return 0;
284 }
285 #endif /* !CONFIG_SLOB */
286
287 /*
288  * Some archs want to perform DMA into kmalloc caches and need a guaranteed
289  * alignment larger than the alignment of a 64-bit integer.
290  * Setting ARCH_KMALLOC_MINALIGN in arch headers allows that.
291  */
292 #ifdef ARCH_DMA_MINALIGN
293 #define ARCH_KMALLOC_MINALIGN ARCH_DMA_MINALIGN
294 #else
295 #define ARCH_KMALLOC_MINALIGN __alignof__(unsigned long long)
296 #endif
297
298 /*
299  * Setting ARCH_SLAB_MINALIGN in arch headers allows a different alignment.
300  * Intended for arches that get misalignment faults even for 64 bit integer
301  * aligned buffers.
302  */
303 #ifndef ARCH_SLAB_MINALIGN
304 #define ARCH_SLAB_MINALIGN __alignof__(unsigned long long)
305 #endif
306 /*
307  * This is the main placeholder for memcg-related information in kmem caches.
308  * struct kmem_cache will hold a pointer to it, so the memory cost while
309  * disabled is 1 pointer. The runtime cost while enabled, gets bigger than it
310  * would otherwise be if that would be bundled in kmem_cache: we'll need an
311  * extra pointer chase. But the trade off clearly lays in favor of not
312  * penalizing non-users.
313  *
314  * Both the root cache and the child caches will have it. For the root cache,
315  * this will hold a dynamically allocated array large enough to hold
316  * information about the currently limited memcgs in the system.
317  *
318  * Child caches will hold extra metadata needed for its operation. Fields are:
319  *
320  * @memcg: pointer to the memcg this cache belongs to
321  * @list: list_head for the list of all caches in this memcg
322  * @root_cache: pointer to the global, root cache, this cache was derived from
323  * @dead: set to true after the memcg dies; the cache may still be around.
324  * @nr_pages: number of pages that belongs to this cache.
325  * @destroy: worker to be called whenever we are ready, or believe we may be
326  *           ready, to destroy this cache.
327  */
328 struct memcg_cache_params {
329         bool is_root_cache;
330         union {
331                 struct kmem_cache *memcg_caches[0];
332                 struct {
333                         struct mem_cgroup *memcg;
334                         struct list_head list;
335                         struct kmem_cache *root_cache;
336                         bool dead;
337                         atomic_t nr_pages;
338                         struct work_struct destroy;
339                 };
340         };
341 };
342
343 int memcg_update_all_caches(int num_memcgs);
344
345 struct seq_file;
346 int cache_show(struct kmem_cache *s, struct seq_file *m);
347 void print_slabinfo_header(struct seq_file *m);
348
349 /**
350  * kmalloc_array - allocate memory for an array.
351  * @n: number of elements.
352  * @size: element size.
353  * @flags: the type of memory to allocate.
354  *
355  * The @flags argument may be one of:
356  *
357  * %GFP_USER - Allocate memory on behalf of user.  May sleep.
358  *
359  * %GFP_KERNEL - Allocate normal kernel ram.  May sleep.
360  *
361  * %GFP_ATOMIC - Allocation will not sleep.  May use emergency pools.
362  *   For example, use this inside interrupt handlers.
363  *
364  * %GFP_HIGHUSER - Allocate pages from high memory.
365  *
366  * %GFP_NOIO - Do not do any I/O at all while trying to get memory.
367  *
368  * %GFP_NOFS - Do not make any fs calls while trying to get memory.
369  *
370  * %GFP_NOWAIT - Allocation will not sleep.
371  *
372  * %GFP_THISNODE - Allocate node-local memory only.
373  *
374  * %GFP_DMA - Allocation suitable for DMA.
375  *   Should only be used for kmalloc() caches. Otherwise, use a
376  *   slab created with SLAB_DMA.
377  *
378  * Also it is possible to set different flags by OR'ing
379  * in one or more of the following additional @flags:
380  *
381  * %__GFP_COLD - Request cache-cold pages instead of
382  *   trying to return cache-warm pages.
383  *
384  * %__GFP_HIGH - This allocation has high priority and may use emergency pools.
385  *
386  * %__GFP_NOFAIL - Indicate that this allocation is in no way allowed to fail
387  *   (think twice before using).
388  *
389  * %__GFP_NORETRY - If memory is not immediately available,
390  *   then give up at once.
391  *
392  * %__GFP_NOWARN - If allocation fails, don't issue any warnings.
393  *
394  * %__GFP_REPEAT - If allocation fails initially, try once more before failing.
395  *
396  * There are other flags available as well, but these are not intended
397  * for general use, and so are not documented here. For a full list of
398  * potential flags, always refer to linux/gfp.h.
399  */
400 static inline void *kmalloc_array(size_t n, size_t size, gfp_t flags)
401 {
402         if (size != 0 && n > SIZE_MAX / size)
403                 return NULL;
404         return __kmalloc(n * size, flags);
405 }
406
407 /**
408  * kcalloc - allocate memory for an array. The memory is set to zero.
409  * @n: number of elements.
410  * @size: element size.
411  * @flags: the type of memory to allocate (see kmalloc).
412  */
413 static inline void *kcalloc(size_t n, size_t size, gfp_t flags)
414 {
415         return kmalloc_array(n, size, flags | __GFP_ZERO);
416 }
417
418 #if !defined(CONFIG_NUMA) && !defined(CONFIG_SLOB)
419 /**
420  * kmalloc_node - allocate memory from a specific node
421  * @size: how many bytes of memory are required.
422  * @flags: the type of memory to allocate (see kcalloc).
423  * @node: node to allocate from.
424  *
425  * kmalloc() for non-local nodes, used to allocate from a specific node
426  * if available. Equivalent to kmalloc() in the non-NUMA single-node
427  * case.
428  */
429 static inline void *kmalloc_node(size_t size, gfp_t flags, int node)
430 {
431         return kmalloc(size, flags);
432 }
433
434 static inline void *__kmalloc_node(size_t size, gfp_t flags, int node)
435 {
436         return __kmalloc(size, flags);
437 }
438
439 void *kmem_cache_alloc(struct kmem_cache *, gfp_t);
440
441 static inline void *kmem_cache_alloc_node(struct kmem_cache *cachep,
442                                         gfp_t flags, int node)
443 {
444         return kmem_cache_alloc(cachep, flags);
445 }
446 #endif /* !CONFIG_NUMA && !CONFIG_SLOB */
447
448 /*
449  * kmalloc_track_caller is a special version of kmalloc that records the
450  * calling function of the routine calling it for slab leak tracking instead
451  * of just the calling function (confusing, eh?).
452  * It's useful when the call to kmalloc comes from a widely-used standard
453  * allocator where we care about the real place the memory allocation
454  * request comes from.
455  */
456 #if defined(CONFIG_DEBUG_SLAB) || defined(CONFIG_SLUB) || \
457         (defined(CONFIG_SLAB) && defined(CONFIG_TRACING)) || \
458         (defined(CONFIG_SLOB) && defined(CONFIG_TRACING))
459 extern void *__kmalloc_track_caller(size_t, gfp_t, unsigned long);
460 #define kmalloc_track_caller(size, flags) \
461         __kmalloc_track_caller(size, flags, _RET_IP_)
462 #else
463 #define kmalloc_track_caller(size, flags) \
464         __kmalloc(size, flags)
465 #endif /* DEBUG_SLAB */
466
467 #ifdef CONFIG_NUMA
468 /*
469  * kmalloc_node_track_caller is a special version of kmalloc_node that
470  * records the calling function of the routine calling it for slab leak
471  * tracking instead of just the calling function (confusing, eh?).
472  * It's useful when the call to kmalloc_node comes from a widely-used
473  * standard allocator where we care about the real place the memory
474  * allocation request comes from.
475  */
476 #if defined(CONFIG_DEBUG_SLAB) || defined(CONFIG_SLUB) || \
477         (defined(CONFIG_SLAB) && defined(CONFIG_TRACING)) || \
478         (defined(CONFIG_SLOB) && defined(CONFIG_TRACING))
479 extern void *__kmalloc_node_track_caller(size_t, gfp_t, int, unsigned long);
480 #define kmalloc_node_track_caller(size, flags, node) \
481         __kmalloc_node_track_caller(size, flags, node, \
482                         _RET_IP_)
483 #else
484 #define kmalloc_node_track_caller(size, flags, node) \
485         __kmalloc_node(size, flags, node)
486 #endif
487
488 #else /* CONFIG_NUMA */
489
490 #define kmalloc_node_track_caller(size, flags, node) \
491         kmalloc_track_caller(size, flags)
492
493 #endif /* CONFIG_NUMA */
494
495 /*
496  * Shortcuts
497  */
498 static inline void *kmem_cache_zalloc(struct kmem_cache *k, gfp_t flags)
499 {
500         return kmem_cache_alloc(k, flags | __GFP_ZERO);
501 }
502
503 /**
504  * kzalloc - allocate memory. The memory is set to zero.
505  * @size: how many bytes of memory are required.
506  * @flags: the type of memory to allocate (see kmalloc).
507  */
508 static inline void *kzalloc(size_t size, gfp_t flags)
509 {
510         return kmalloc(size, flags | __GFP_ZERO);
511 }
512
513 /**
514  * kzalloc_node - allocate zeroed memory from a particular memory node.
515  * @size: how many bytes of memory are required.
516  * @flags: the type of memory to allocate (see kmalloc).
517  * @node: memory node from which to allocate
518  */
519 static inline void *kzalloc_node(size_t size, gfp_t flags, int node)
520 {
521         return kmalloc_node(size, flags | __GFP_ZERO, node);
522 }
523
524 /*
525  * Determine the size of a slab object
526  */
527 static inline unsigned int kmem_cache_size(struct kmem_cache *s)
528 {
529         return s->object_size;
530 }
531
532 void __init kmem_cache_init_late(void);
533
534 #endif  /* _LINUX_SLAB_H */