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