2a7137043e91edeacade2f07c05cf7f3a80a4682
[muen/linux.git] / include / linux / slab.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * Written by Mark Hemment, 1996 (markhe@nextd.demon.co.uk).
4  *
5  * (C) SGI 2006, Christoph Lameter
6  *      Cleaned up and restructured to ease the addition of alternative
7  *      implementations of SLAB allocators.
8  * (C) Linux Foundation 2008-2013
9  *      Unified interface for all slab allocators
10  */
11
12 #ifndef _LINUX_SLAB_H
13 #define _LINUX_SLAB_H
14
15 #include <linux/gfp.h>
16 #include <linux/overflow.h>
17 #include <linux/types.h>
18 #include <linux/workqueue.h>
19
20
21 /*
22  * Flags to pass to kmem_cache_create().
23  * The ones marked DEBUG are only valid if CONFIG_DEBUG_SLAB is set.
24  */
25 /* DEBUG: Perform (expensive) checks on alloc/free */
26 #define SLAB_CONSISTENCY_CHECKS ((slab_flags_t __force)0x00000100U)
27 /* DEBUG: Red zone objs in a cache */
28 #define SLAB_RED_ZONE           ((slab_flags_t __force)0x00000400U)
29 /* DEBUG: Poison objects */
30 #define SLAB_POISON             ((slab_flags_t __force)0x00000800U)
31 /* Align objs on cache lines */
32 #define SLAB_HWCACHE_ALIGN      ((slab_flags_t __force)0x00002000U)
33 /* Use GFP_DMA memory */
34 #define SLAB_CACHE_DMA          ((slab_flags_t __force)0x00004000U)
35 /* DEBUG: Store the last owner for bug hunting */
36 #define SLAB_STORE_USER         ((slab_flags_t __force)0x00010000U)
37 /* Panic if kmem_cache_create() fails */
38 #define SLAB_PANIC              ((slab_flags_t __force)0x00040000U)
39 /*
40  * SLAB_TYPESAFE_BY_RCU - **WARNING** READ THIS!
41  *
42  * This delays freeing the SLAB page by a grace period, it does _NOT_
43  * delay object freeing. This means that if you do kmem_cache_free()
44  * that memory location is free to be reused at any time. Thus it may
45  * be possible to see another object there in the same RCU grace period.
46  *
47  * This feature only ensures the memory location backing the object
48  * stays valid, the trick to using this is relying on an independent
49  * object validation pass. Something like:
50  *
51  *  rcu_read_lock()
52  * again:
53  *  obj = lockless_lookup(key);
54  *  if (obj) {
55  *    if (!try_get_ref(obj)) // might fail for free objects
56  *      goto again;
57  *
58  *    if (obj->key != key) { // not the object we expected
59  *      put_ref(obj);
60  *      goto again;
61  *    }
62  *  }
63  *  rcu_read_unlock();
64  *
65  * This is useful if we need to approach a kernel structure obliquely,
66  * from its address obtained without the usual locking. We can lock
67  * the structure to stabilize it and check it's still at the given address,
68  * only if we can be sure that the memory has not been meanwhile reused
69  * for some other kind of object (which our subsystem's lock might corrupt).
70  *
71  * rcu_read_lock before reading the address, then rcu_read_unlock after
72  * taking the spinlock within the structure expected at that address.
73  *
74  * Note that SLAB_TYPESAFE_BY_RCU was originally named SLAB_DESTROY_BY_RCU.
75  */
76 /* Defer freeing slabs to RCU */
77 #define SLAB_TYPESAFE_BY_RCU    ((slab_flags_t __force)0x00080000U)
78 /* Spread some memory over cpuset */
79 #define SLAB_MEM_SPREAD         ((slab_flags_t __force)0x00100000U)
80 /* Trace allocations and frees */
81 #define SLAB_TRACE              ((slab_flags_t __force)0x00200000U)
82
83 /* Flag to prevent checks on free */
84 #ifdef CONFIG_DEBUG_OBJECTS
85 # define SLAB_DEBUG_OBJECTS     ((slab_flags_t __force)0x00400000U)
86 #else
87 # define SLAB_DEBUG_OBJECTS     0
88 #endif
89
90 /* Avoid kmemleak tracing */
91 #define SLAB_NOLEAKTRACE        ((slab_flags_t __force)0x00800000U)
92
93 /* Fault injection mark */
94 #ifdef CONFIG_FAILSLAB
95 # define SLAB_FAILSLAB          ((slab_flags_t __force)0x02000000U)
96 #else
97 # define SLAB_FAILSLAB          0
98 #endif
99 /* Account to memcg */
100 #ifdef CONFIG_MEMCG_KMEM
101 # define SLAB_ACCOUNT           ((slab_flags_t __force)0x04000000U)
102 #else
103 # define SLAB_ACCOUNT           0
104 #endif
105
106 #ifdef CONFIG_KASAN
107 #define SLAB_KASAN              ((slab_flags_t __force)0x08000000U)
108 #else
109 #define SLAB_KASAN              0
110 #endif
111
112 /* The following flags affect the page allocator grouping pages by mobility */
113 /* Objects are reclaimable */
114 #define SLAB_RECLAIM_ACCOUNT    ((slab_flags_t __force)0x00020000U)
115 #define SLAB_TEMPORARY          SLAB_RECLAIM_ACCOUNT    /* Objects are short-lived */
116 /*
117  * ZERO_SIZE_PTR will be returned for zero sized kmalloc requests.
118  *
119  * Dereferencing ZERO_SIZE_PTR will lead to a distinct access fault.
120  *
121  * ZERO_SIZE_PTR can be passed to kfree though in the same way that NULL can.
122  * Both make kfree a no-op.
123  */
124 #define ZERO_SIZE_PTR ((void *)16)
125
126 #define ZERO_OR_NULL_PTR(x) ((unsigned long)(x) <= \
127                                 (unsigned long)ZERO_SIZE_PTR)
128
129 #include <linux/kasan.h>
130
131 struct mem_cgroup;
132 /*
133  * struct kmem_cache related prototypes
134  */
135 void __init kmem_cache_init(void);
136 bool slab_is_available(void);
137
138 extern bool usercopy_fallback;
139
140 struct kmem_cache *kmem_cache_create(const char *name, unsigned int size,
141                         unsigned int align, slab_flags_t flags,
142                         void (*ctor)(void *));
143 struct kmem_cache *kmem_cache_create_usercopy(const char *name,
144                         unsigned int size, unsigned int align,
145                         slab_flags_t flags,
146                         unsigned int useroffset, unsigned int usersize,
147                         void (*ctor)(void *));
148 void kmem_cache_destroy(struct kmem_cache *);
149 int kmem_cache_shrink(struct kmem_cache *);
150
151 void memcg_create_kmem_cache(struct mem_cgroup *, struct kmem_cache *);
152 void memcg_deactivate_kmem_caches(struct mem_cgroup *);
153 void memcg_destroy_kmem_caches(struct mem_cgroup *);
154
155 /*
156  * Please use this macro to create slab caches. Simply specify the
157  * name of the structure and maybe some flags that are listed above.
158  *
159  * The alignment of the struct determines object alignment. If you
160  * f.e. add ____cacheline_aligned_in_smp to the struct declaration
161  * then the objects will be properly aligned in SMP configurations.
162  */
163 #define KMEM_CACHE(__struct, __flags)                                   \
164                 kmem_cache_create(#__struct, sizeof(struct __struct),   \
165                         __alignof__(struct __struct), (__flags), NULL)
166
167 /*
168  * To whitelist a single field for copying to/from usercopy, use this
169  * macro instead for KMEM_CACHE() above.
170  */
171 #define KMEM_CACHE_USERCOPY(__struct, __flags, __field)                 \
172                 kmem_cache_create_usercopy(#__struct,                   \
173                         sizeof(struct __struct),                        \
174                         __alignof__(struct __struct), (__flags),        \
175                         offsetof(struct __struct, __field),             \
176                         sizeof_field(struct __struct, __field), NULL)
177
178 /*
179  * Common kmalloc functions provided by all allocators
180  */
181 void * __must_check __krealloc(const void *, size_t, gfp_t);
182 void * __must_check krealloc(const void *, size_t, gfp_t);
183 void kfree(const void *);
184 void kzfree(const void *);
185 size_t ksize(const void *);
186
187 #ifdef CONFIG_HAVE_HARDENED_USERCOPY_ALLOCATOR
188 void __check_heap_object(const void *ptr, unsigned long n, struct page *page,
189                         bool to_user);
190 #else
191 static inline void __check_heap_object(const void *ptr, unsigned long n,
192                                        struct page *page, bool to_user) { }
193 #endif
194
195 /*
196  * Some archs want to perform DMA into kmalloc caches and need a guaranteed
197  * alignment larger than the alignment of a 64-bit integer.
198  * Setting ARCH_KMALLOC_MINALIGN in arch headers allows that.
199  */
200 #if defined(ARCH_DMA_MINALIGN) && ARCH_DMA_MINALIGN > 8
201 #define ARCH_KMALLOC_MINALIGN ARCH_DMA_MINALIGN
202 #define KMALLOC_MIN_SIZE ARCH_DMA_MINALIGN
203 #define KMALLOC_SHIFT_LOW ilog2(ARCH_DMA_MINALIGN)
204 #else
205 #define ARCH_KMALLOC_MINALIGN __alignof__(unsigned long long)
206 #endif
207
208 /*
209  * Setting ARCH_SLAB_MINALIGN in arch headers allows a different alignment.
210  * Intended for arches that get misalignment faults even for 64 bit integer
211  * aligned buffers.
212  */
213 #ifndef ARCH_SLAB_MINALIGN
214 #define ARCH_SLAB_MINALIGN __alignof__(unsigned long long)
215 #endif
216
217 /*
218  * kmalloc and friends return ARCH_KMALLOC_MINALIGN aligned
219  * pointers. kmem_cache_alloc and friends return ARCH_SLAB_MINALIGN
220  * aligned pointers.
221  */
222 #define __assume_kmalloc_alignment __assume_aligned(ARCH_KMALLOC_MINALIGN)
223 #define __assume_slab_alignment __assume_aligned(ARCH_SLAB_MINALIGN)
224 #define __assume_page_alignment __assume_aligned(PAGE_SIZE)
225
226 /*
227  * Kmalloc array related definitions
228  */
229
230 #ifdef CONFIG_SLAB
231 /*
232  * The largest kmalloc size supported by the SLAB allocators is
233  * 32 megabyte (2^25) or the maximum allocatable page order if that is
234  * less than 32 MB.
235  *
236  * WARNING: Its not easy to increase this value since the allocators have
237  * to do various tricks to work around compiler limitations in order to
238  * ensure proper constant folding.
239  */
240 #define KMALLOC_SHIFT_HIGH      ((MAX_ORDER + PAGE_SHIFT - 1) <= 25 ? \
241                                 (MAX_ORDER + PAGE_SHIFT - 1) : 25)
242 #define KMALLOC_SHIFT_MAX       KMALLOC_SHIFT_HIGH
243 #ifndef KMALLOC_SHIFT_LOW
244 #define KMALLOC_SHIFT_LOW       5
245 #endif
246 #endif
247
248 #ifdef CONFIG_SLUB
249 /*
250  * SLUB directly allocates requests fitting in to an order-1 page
251  * (PAGE_SIZE*2).  Larger requests are passed to the page allocator.
252  */
253 #define KMALLOC_SHIFT_HIGH      (PAGE_SHIFT + 1)
254 #define KMALLOC_SHIFT_MAX       (MAX_ORDER + PAGE_SHIFT - 1)
255 #ifndef KMALLOC_SHIFT_LOW
256 #define KMALLOC_SHIFT_LOW       3
257 #endif
258 #endif
259
260 #ifdef CONFIG_SLOB
261 /*
262  * SLOB passes all requests larger than one page to the page allocator.
263  * No kmalloc array is necessary since objects of different sizes can
264  * be allocated from the same page.
265  */
266 #define KMALLOC_SHIFT_HIGH      PAGE_SHIFT
267 #define KMALLOC_SHIFT_MAX       (MAX_ORDER + PAGE_SHIFT - 1)
268 #ifndef KMALLOC_SHIFT_LOW
269 #define KMALLOC_SHIFT_LOW       3
270 #endif
271 #endif
272
273 /* Maximum allocatable size */
274 #define KMALLOC_MAX_SIZE        (1UL << KMALLOC_SHIFT_MAX)
275 /* Maximum size for which we actually use a slab cache */
276 #define KMALLOC_MAX_CACHE_SIZE  (1UL << KMALLOC_SHIFT_HIGH)
277 /* Maximum order allocatable via the slab allocagtor */
278 #define KMALLOC_MAX_ORDER       (KMALLOC_SHIFT_MAX - PAGE_SHIFT)
279
280 /*
281  * Kmalloc subsystem.
282  */
283 #ifndef KMALLOC_MIN_SIZE
284 #define KMALLOC_MIN_SIZE (1 << KMALLOC_SHIFT_LOW)
285 #endif
286
287 /*
288  * This restriction comes from byte sized index implementation.
289  * Page size is normally 2^12 bytes and, in this case, if we want to use
290  * byte sized index which can represent 2^8 entries, the size of the object
291  * should be equal or greater to 2^12 / 2^8 = 2^4 = 16.
292  * If minimum size of kmalloc is less than 16, we use it as minimum object
293  * size and give up to use byte sized index.
294  */
295 #define SLAB_OBJ_MIN_SIZE      (KMALLOC_MIN_SIZE < 16 ? \
296                                (KMALLOC_MIN_SIZE) : 16)
297
298 enum kmalloc_cache_type {
299         KMALLOC_NORMAL = 0,
300 #ifdef CONFIG_ZONE_DMA
301         KMALLOC_DMA,
302 #endif
303         NR_KMALLOC_TYPES
304 };
305
306 #ifndef CONFIG_SLOB
307 extern struct kmem_cache *
308 kmalloc_caches[NR_KMALLOC_TYPES][KMALLOC_SHIFT_HIGH + 1];
309
310 static __always_inline enum kmalloc_cache_type kmalloc_type(gfp_t flags)
311 {
312         int is_dma = 0;
313
314 #ifdef CONFIG_ZONE_DMA
315         is_dma = !!(flags & __GFP_DMA);
316 #endif
317
318         return is_dma;
319 }
320
321 /*
322  * Figure out which kmalloc slab an allocation of a certain size
323  * belongs to.
324  * 0 = zero alloc
325  * 1 =  65 .. 96 bytes
326  * 2 = 129 .. 192 bytes
327  * n = 2^(n-1)+1 .. 2^n
328  */
329 static __always_inline unsigned int kmalloc_index(size_t size)
330 {
331         if (!size)
332                 return 0;
333
334         if (size <= KMALLOC_MIN_SIZE)
335                 return KMALLOC_SHIFT_LOW;
336
337         if (KMALLOC_MIN_SIZE <= 32 && size > 64 && size <= 96)
338                 return 1;
339         if (KMALLOC_MIN_SIZE <= 64 && size > 128 && size <= 192)
340                 return 2;
341         if (size <=          8) return 3;
342         if (size <=         16) return 4;
343         if (size <=         32) return 5;
344         if (size <=         64) return 6;
345         if (size <=        128) return 7;
346         if (size <=        256) return 8;
347         if (size <=        512) return 9;
348         if (size <=       1024) return 10;
349         if (size <=   2 * 1024) return 11;
350         if (size <=   4 * 1024) return 12;
351         if (size <=   8 * 1024) return 13;
352         if (size <=  16 * 1024) return 14;
353         if (size <=  32 * 1024) return 15;
354         if (size <=  64 * 1024) return 16;
355         if (size <= 128 * 1024) return 17;
356         if (size <= 256 * 1024) return 18;
357         if (size <= 512 * 1024) return 19;
358         if (size <= 1024 * 1024) return 20;
359         if (size <=  2 * 1024 * 1024) return 21;
360         if (size <=  4 * 1024 * 1024) return 22;
361         if (size <=  8 * 1024 * 1024) return 23;
362         if (size <=  16 * 1024 * 1024) return 24;
363         if (size <=  32 * 1024 * 1024) return 25;
364         if (size <=  64 * 1024 * 1024) return 26;
365         BUG();
366
367         /* Will never be reached. Needed because the compiler may complain */
368         return -1;
369 }
370 #endif /* !CONFIG_SLOB */
371
372 void *__kmalloc(size_t size, gfp_t flags) __assume_kmalloc_alignment __malloc;
373 void *kmem_cache_alloc(struct kmem_cache *, gfp_t flags) __assume_slab_alignment __malloc;
374 void kmem_cache_free(struct kmem_cache *, void *);
375
376 /*
377  * Bulk allocation and freeing operations. These are accelerated in an
378  * allocator specific way to avoid taking locks repeatedly or building
379  * metadata structures unnecessarily.
380  *
381  * Note that interrupts must be enabled when calling these functions.
382  */
383 void kmem_cache_free_bulk(struct kmem_cache *, size_t, void **);
384 int kmem_cache_alloc_bulk(struct kmem_cache *, gfp_t, size_t, void **);
385
386 /*
387  * Caller must not use kfree_bulk() on memory not originally allocated
388  * by kmalloc(), because the SLOB allocator cannot handle this.
389  */
390 static __always_inline void kfree_bulk(size_t size, void **p)
391 {
392         kmem_cache_free_bulk(NULL, size, p);
393 }
394
395 #ifdef CONFIG_NUMA
396 void *__kmalloc_node(size_t size, gfp_t flags, int node) __assume_kmalloc_alignment __malloc;
397 void *kmem_cache_alloc_node(struct kmem_cache *, gfp_t flags, int node) __assume_slab_alignment __malloc;
398 #else
399 static __always_inline void *__kmalloc_node(size_t size, gfp_t flags, int node)
400 {
401         return __kmalloc(size, flags);
402 }
403
404 static __always_inline void *kmem_cache_alloc_node(struct kmem_cache *s, gfp_t flags, int node)
405 {
406         return kmem_cache_alloc(s, flags);
407 }
408 #endif
409
410 #ifdef CONFIG_TRACING
411 extern void *kmem_cache_alloc_trace(struct kmem_cache *, gfp_t, size_t) __assume_slab_alignment __malloc;
412
413 #ifdef CONFIG_NUMA
414 extern void *kmem_cache_alloc_node_trace(struct kmem_cache *s,
415                                            gfp_t gfpflags,
416                                            int node, size_t size) __assume_slab_alignment __malloc;
417 #else
418 static __always_inline void *
419 kmem_cache_alloc_node_trace(struct kmem_cache *s,
420                               gfp_t gfpflags,
421                               int node, size_t size)
422 {
423         return kmem_cache_alloc_trace(s, gfpflags, size);
424 }
425 #endif /* CONFIG_NUMA */
426
427 #else /* CONFIG_TRACING */
428 static __always_inline void *kmem_cache_alloc_trace(struct kmem_cache *s,
429                 gfp_t flags, size_t size)
430 {
431         void *ret = kmem_cache_alloc(s, flags);
432
433         kasan_kmalloc(s, ret, size, flags);
434         return ret;
435 }
436
437 static __always_inline void *
438 kmem_cache_alloc_node_trace(struct kmem_cache *s,
439                               gfp_t gfpflags,
440                               int node, size_t size)
441 {
442         void *ret = kmem_cache_alloc_node(s, gfpflags, node);
443
444         kasan_kmalloc(s, ret, size, gfpflags);
445         return ret;
446 }
447 #endif /* CONFIG_TRACING */
448
449 extern void *kmalloc_order(size_t size, gfp_t flags, unsigned int order) __assume_page_alignment __malloc;
450
451 #ifdef CONFIG_TRACING
452 extern void *kmalloc_order_trace(size_t size, gfp_t flags, unsigned int order) __assume_page_alignment __malloc;
453 #else
454 static __always_inline void *
455 kmalloc_order_trace(size_t size, gfp_t flags, unsigned int order)
456 {
457         return kmalloc_order(size, flags, order);
458 }
459 #endif
460
461 static __always_inline void *kmalloc_large(size_t size, gfp_t flags)
462 {
463         unsigned int order = get_order(size);
464         return kmalloc_order_trace(size, flags, order);
465 }
466
467 /**
468  * kmalloc - allocate memory
469  * @size: how many bytes of memory are required.
470  * @flags: the type of memory to allocate.
471  *
472  * kmalloc is the normal method of allocating memory
473  * for objects smaller than page size in the kernel.
474  *
475  * The @flags argument may be one of:
476  *
477  * %GFP_USER - Allocate memory on behalf of user.  May sleep.
478  *
479  * %GFP_KERNEL - Allocate normal kernel ram.  May sleep.
480  *
481  * %GFP_ATOMIC - Allocation will not sleep.  May use emergency pools.
482  *   For example, use this inside interrupt handlers.
483  *
484  * %GFP_HIGHUSER - Allocate pages from high memory.
485  *
486  * %GFP_NOIO - Do not do any I/O at all while trying to get memory.
487  *
488  * %GFP_NOFS - Do not make any fs calls while trying to get memory.
489  *
490  * %GFP_NOWAIT - Allocation will not sleep.
491  *
492  * %__GFP_THISNODE - Allocate node-local memory only.
493  *
494  * %GFP_DMA - Allocation suitable for DMA.
495  *   Should only be used for kmalloc() caches. Otherwise, use a
496  *   slab created with SLAB_DMA.
497  *
498  * Also it is possible to set different flags by OR'ing
499  * in one or more of the following additional @flags:
500  *
501  * %__GFP_HIGH - This allocation has high priority and may use emergency pools.
502  *
503  * %__GFP_NOFAIL - Indicate that this allocation is in no way allowed to fail
504  *   (think twice before using).
505  *
506  * %__GFP_NORETRY - If memory is not immediately available,
507  *   then give up at once.
508  *
509  * %__GFP_NOWARN - If allocation fails, don't issue any warnings.
510  *
511  * %__GFP_RETRY_MAYFAIL - Try really hard to succeed the allocation but fail
512  *   eventually.
513  *
514  * There are other flags available as well, but these are not intended
515  * for general use, and so are not documented here. For a full list of
516  * potential flags, always refer to linux/gfp.h.
517  */
518 static __always_inline void *kmalloc(size_t size, gfp_t flags)
519 {
520         if (__builtin_constant_p(size)) {
521 #ifndef CONFIG_SLOB
522                 unsigned int index;
523 #endif
524                 if (size > KMALLOC_MAX_CACHE_SIZE)
525                         return kmalloc_large(size, flags);
526 #ifndef CONFIG_SLOB
527                 index = kmalloc_index(size);
528
529                 if (!index)
530                         return ZERO_SIZE_PTR;
531
532                 return kmem_cache_alloc_trace(
533                                 kmalloc_caches[kmalloc_type(flags)][index],
534                                 flags, size);
535 #endif
536         }
537         return __kmalloc(size, flags);
538 }
539
540 /*
541  * Determine size used for the nth kmalloc cache.
542  * return size or 0 if a kmalloc cache for that
543  * size does not exist
544  */
545 static __always_inline unsigned int kmalloc_size(unsigned int n)
546 {
547 #ifndef CONFIG_SLOB
548         if (n > 2)
549                 return 1U << n;
550
551         if (n == 1 && KMALLOC_MIN_SIZE <= 32)
552                 return 96;
553
554         if (n == 2 && KMALLOC_MIN_SIZE <= 64)
555                 return 192;
556 #endif
557         return 0;
558 }
559
560 static __always_inline void *kmalloc_node(size_t size, gfp_t flags, int node)
561 {
562 #ifndef CONFIG_SLOB
563         if (__builtin_constant_p(size) &&
564                 size <= KMALLOC_MAX_CACHE_SIZE) {
565                 unsigned int i = kmalloc_index(size);
566
567                 if (!i)
568                         return ZERO_SIZE_PTR;
569
570                 return kmem_cache_alloc_node_trace(
571                                 kmalloc_caches[kmalloc_type(flags)][i],
572                                                 flags, node, size);
573         }
574 #endif
575         return __kmalloc_node(size, flags, node);
576 }
577
578 struct memcg_cache_array {
579         struct rcu_head rcu;
580         struct kmem_cache *entries[0];
581 };
582
583 /*
584  * This is the main placeholder for memcg-related information in kmem caches.
585  * Both the root cache and the child caches will have it. For the root cache,
586  * this will hold a dynamically allocated array large enough to hold
587  * information about the currently limited memcgs in the system. To allow the
588  * array to be accessed without taking any locks, on relocation we free the old
589  * version only after a grace period.
590  *
591  * Root and child caches hold different metadata.
592  *
593  * @root_cache: Common to root and child caches.  NULL for root, pointer to
594  *              the root cache for children.
595  *
596  * The following fields are specific to root caches.
597  *
598  * @memcg_caches: kmemcg ID indexed table of child caches.  This table is
599  *              used to index child cachces during allocation and cleared
600  *              early during shutdown.
601  *
602  * @root_caches_node: List node for slab_root_caches list.
603  *
604  * @children:   List of all child caches.  While the child caches are also
605  *              reachable through @memcg_caches, a child cache remains on
606  *              this list until it is actually destroyed.
607  *
608  * The following fields are specific to child caches.
609  *
610  * @memcg:      Pointer to the memcg this cache belongs to.
611  *
612  * @children_node: List node for @root_cache->children list.
613  *
614  * @kmem_caches_node: List node for @memcg->kmem_caches list.
615  */
616 struct memcg_cache_params {
617         struct kmem_cache *root_cache;
618         union {
619                 struct {
620                         struct memcg_cache_array __rcu *memcg_caches;
621                         struct list_head __root_caches_node;
622                         struct list_head children;
623                         bool dying;
624                 };
625                 struct {
626                         struct mem_cgroup *memcg;
627                         struct list_head children_node;
628                         struct list_head kmem_caches_node;
629
630                         void (*deact_fn)(struct kmem_cache *);
631                         union {
632                                 struct rcu_head deact_rcu_head;
633                                 struct work_struct deact_work;
634                         };
635                 };
636         };
637 };
638
639 int memcg_update_all_caches(int num_memcgs);
640
641 /**
642  * kmalloc_array - allocate memory for an array.
643  * @n: number of elements.
644  * @size: element size.
645  * @flags: the type of memory to allocate (see kmalloc).
646  */
647 static inline void *kmalloc_array(size_t n, size_t size, gfp_t flags)
648 {
649         size_t bytes;
650
651         if (unlikely(check_mul_overflow(n, size, &bytes)))
652                 return NULL;
653         if (__builtin_constant_p(n) && __builtin_constant_p(size))
654                 return kmalloc(bytes, flags);
655         return __kmalloc(bytes, flags);
656 }
657
658 /**
659  * kcalloc - allocate memory for an array. The memory is set to zero.
660  * @n: number of elements.
661  * @size: element size.
662  * @flags: the type of memory to allocate (see kmalloc).
663  */
664 static inline void *kcalloc(size_t n, size_t size, gfp_t flags)
665 {
666         return kmalloc_array(n, size, flags | __GFP_ZERO);
667 }
668
669 /*
670  * kmalloc_track_caller is a special version of kmalloc that records the
671  * calling function of the routine calling it for slab leak tracking instead
672  * of just the calling function (confusing, eh?).
673  * It's useful when the call to kmalloc comes from a widely-used standard
674  * allocator where we care about the real place the memory allocation
675  * request comes from.
676  */
677 extern void *__kmalloc_track_caller(size_t, gfp_t, unsigned long);
678 #define kmalloc_track_caller(size, flags) \
679         __kmalloc_track_caller(size, flags, _RET_IP_)
680
681 static inline void *kmalloc_array_node(size_t n, size_t size, gfp_t flags,
682                                        int node)
683 {
684         size_t bytes;
685
686         if (unlikely(check_mul_overflow(n, size, &bytes)))
687                 return NULL;
688         if (__builtin_constant_p(n) && __builtin_constant_p(size))
689                 return kmalloc_node(bytes, flags, node);
690         return __kmalloc_node(bytes, flags, node);
691 }
692
693 static inline void *kcalloc_node(size_t n, size_t size, gfp_t flags, int node)
694 {
695         return kmalloc_array_node(n, size, flags | __GFP_ZERO, node);
696 }
697
698
699 #ifdef CONFIG_NUMA
700 extern void *__kmalloc_node_track_caller(size_t, gfp_t, int, unsigned long);
701 #define kmalloc_node_track_caller(size, flags, node) \
702         __kmalloc_node_track_caller(size, flags, node, \
703                         _RET_IP_)
704
705 #else /* CONFIG_NUMA */
706
707 #define kmalloc_node_track_caller(size, flags, node) \
708         kmalloc_track_caller(size, flags)
709
710 #endif /* CONFIG_NUMA */
711
712 /*
713  * Shortcuts
714  */
715 static inline void *kmem_cache_zalloc(struct kmem_cache *k, gfp_t flags)
716 {
717         return kmem_cache_alloc(k, flags | __GFP_ZERO);
718 }
719
720 /**
721  * kzalloc - allocate memory. The memory is set to zero.
722  * @size: how many bytes of memory are required.
723  * @flags: the type of memory to allocate (see kmalloc).
724  */
725 static inline void *kzalloc(size_t size, gfp_t flags)
726 {
727         return kmalloc(size, flags | __GFP_ZERO);
728 }
729
730 /**
731  * kzalloc_node - allocate zeroed memory from a particular memory node.
732  * @size: how many bytes of memory are required.
733  * @flags: the type of memory to allocate (see kmalloc).
734  * @node: memory node from which to allocate
735  */
736 static inline void *kzalloc_node(size_t size, gfp_t flags, int node)
737 {
738         return kmalloc_node(size, flags | __GFP_ZERO, node);
739 }
740
741 unsigned int kmem_cache_size(struct kmem_cache *s);
742 void __init kmem_cache_init_late(void);
743
744 #if defined(CONFIG_SMP) && defined(CONFIG_SLAB)
745 int slab_prepare_cpu(unsigned int cpu);
746 int slab_dead_cpu(unsigned int cpu);
747 #else
748 #define slab_prepare_cpu        NULL
749 #define slab_dead_cpu           NULL
750 #endif
751
752 #endif  /* _LINUX_SLAB_H */