include/linux/slub_def.h

   1 #ifndef _LINUX_SLUB_DEF_H
   2 #define _LINUX_SLUB_DEF_H
   3
   4 /*
   5  * SLUB : A Slab allocator without object queues.
   6  *
   7  * (C) 2007 SGI, Christoph Lameter
   8  */
   9 #include <linux/types.h>
  10 #include <linux/gfp.h>
  11 #include <linux/bug.h>
  12 #include <linux/workqueue.h>
  13 #include <linux/kobject.h>
  14
  15 #include <linux/kmemleak.h>
  16
  17 enum stat_item {
  18         ALLOC_FASTPATH,         /* Allocation from cpu slab */
  19         ALLOC_SLOWPATH,         /* Allocation by getting a new cpu slab */
  20         FREE_FASTPATH,          /* Free to cpu slub */
  21         FREE_SLOWPATH,          /* Freeing not to cpu slab */
  22         FREE_FROZEN,            /* Freeing to frozen slab */
  23         FREE_ADD_PARTIAL,       /* Freeing moves slab to partial list */
  24         FREE_REMOVE_PARTIAL,    /* Freeing removes last object */
  25         ALLOC_FROM_PARTIAL,     /* Cpu slab acquired from node partial list */
  26         ALLOC_SLAB,             /* Cpu slab acquired from page allocator */
  27         ALLOC_REFILL,           /* Refill cpu slab from slab freelist */
  28         ALLOC_NODE_MISMATCH,    /* Switching cpu slab */
  29         FREE_SLAB,              /* Slab freed to the page allocator */
  30         CPUSLAB_FLUSH,          /* Abandoning of the cpu slab */
  31         DEACTIVATE_FULL,        /* Cpu slab was full when deactivated */
  32         DEACTIVATE_EMPTY,       /* Cpu slab was empty when deactivated */
  33         DEACTIVATE_TO_HEAD,     /* Cpu slab was moved to the head of partials */
  34         DEACTIVATE_TO_TAIL,     /* Cpu slab was moved to the tail of partials */
  35         DEACTIVATE_REMOTE_FREES,/* Slab contained remotely freed objects */
  36         DEACTIVATE_BYPASS,      /* Implicit deactivation */
  37         ORDER_FALLBACK,         /* Number of times fallback was necessary */
  38         CMPXCHG_DOUBLE_CPU_FAIL,/* Failure of this_cpu_cmpxchg_double */
  39         CMPXCHG_DOUBLE_FAIL,    /* Number of times that cmpxchg double did not match */
  40         CPU_PARTIAL_ALLOC,      /* Used cpu partial on alloc */
  41         CPU_PARTIAL_FREE,       /* Refill cpu partial on free */
  42         CPU_PARTIAL_NODE,       /* Refill cpu partial from node partial */
  43         CPU_PARTIAL_DRAIN,      /* Drain cpu partial to node partial */
  44         NR_SLUB_STAT_ITEMS };
  45
  46 struct kmem_cache_cpu {
  47         void **freelist;        /* Pointer to next available object */
  48         unsigned long tid;      /* Globally unique transaction id */
  49         struct page *page;      /* The slab from which we are allocating */
  50         struct page *partial;   /* Partially allocated frozen slabs */
  51 #ifdef CONFIG_SLUB_STATS
  52         unsigned stat[NR_SLUB_STAT_ITEMS];
  53 #endif
  54 };
  55
  56 struct kmem_cache_node {
  57         spinlock_t list_lock;   /* Protect partial list and nr_partial */
  58         unsigned long nr_partial;
  59         struct list_head partial;
  60 #ifdef CONFIG_SLUB_DEBUG
  61         atomic_long_t nr_slabs;
  62         atomic_long_t total_objects;
  63         struct list_head full;
  64 #endif
  65 };
  66
  67 /*
  68  * Word size structure that can be atomically updated or read and that
  69  * contains both the order and the number of objects that a slab of the
  70  * given order would contain.
  71  */
  72 struct kmem_cache_order_objects {
  73         unsigned long x;
  74 };
  75
  76 /*
  77  * Slab cache management.
  78  */
  79 struct kmem_cache {
  80         struct kmem_cache_cpu __percpu *cpu_slab;
  81         /* Used for retriving partial slabs etc */
  82         unsigned long flags;
  83         unsigned long min_partial;
  84         int size;               /* The size of an object including meta data */
  85         int object_size;        /* The size of an object without meta data */
  86         int offset;             /* Free pointer offset. */
  87         int cpu_partial;        /* Number of per cpu partial objects to keep around */
  88         struct kmem_cache_order_objects oo;
  89
  90         /* Allocation and freeing of slabs */
  91         struct kmem_cache_order_objects max;
  92         struct kmem_cache_order_objects min;
  93         gfp_t allocflags;       /* gfp flags to use on each alloc */
  94         int refcount;           /* Refcount for slab cache destroy */
  95         void (*ctor)(void *);
  96         int inuse;              /* Offset to metadata */
  97         int align;              /* Alignment */
  98         int reserved;           /* Reserved bytes at the end of slabs */
  99         const char *name;       /* Name (only for display!) */
 100         struct list_head list;  /* List of slab caches */
 101 #ifdef CONFIG_SYSFS
 102         struct kobject kobj;    /* For sysfs */
 103 #endif
 104 #ifdef CONFIG_MEMCG_KMEM
 105         struct memcg_cache_params *memcg_params;
 106 #endif
 107
 108 #ifdef CONFIG_NUMA
 109         /*
 110          * Defragmentation by allocating from a remote node.
 111          */
 112         int remote_node_defrag_ratio;
 113 #endif
 114         struct kmem_cache_node *node[MAX_NUMNODES];
 115 };
 116
 117 /*
 118  * Kmalloc subsystem.
 119  */
 120 #if defined(ARCH_DMA_MINALIGN) && ARCH_DMA_MINALIGN > 8
 121 #define KMALLOC_MIN_SIZE ARCH_DMA_MINALIGN
 122 #else
 123 #define KMALLOC_MIN_SIZE 8
 124 #endif
 125
 126 #define KMALLOC_SHIFT_LOW ilog2(KMALLOC_MIN_SIZE)
 127
 128 /*
 129  * Maximum kmalloc object size handled by SLUB. Larger object allocations
 130  * are passed through to the page allocator. The page allocator "fastpath"
 131  * is relatively slow so we need this value sufficiently high so that
 132  * performance critical objects are allocated through the SLUB fastpath.
 133  *
 134  * This should be dropped to PAGE_SIZE / 2 once the page allocator
 135  * "fastpath" becomes competitive with the slab allocator fastpaths.
 136  */
 137 #define SLUB_MAX_SIZE (2 * PAGE_SIZE)
 138
 139 #define SLUB_PAGE_SHIFT (PAGE_SHIFT + 2)
 140
 141 #ifdef CONFIG_ZONE_DMA
 142 #define SLUB_DMA __GFP_DMA
 143 #else
 144 /* Disable DMA functionality */
 145 #define SLUB_DMA (__force gfp_t)0
 146 #endif
 147
 148 /*
 149  * We keep the general caches in an array of slab caches that are used for
 150  * 2^x bytes of allocations.
 151  */
 152 extern struct kmem_cache *kmalloc_caches[SLUB_PAGE_SHIFT];
 153
 154 /*
 155  * Sorry that the following has to be that ugly but some versions of GCC
 156  * have trouble with constant propagation and loops.
 157  */
 158 static __always_inline int kmalloc_index(size_t size)
 159 {
 160         if (!size)
 161                 return 0;
 162
 163         if (size <= KMALLOC_MIN_SIZE)
 164                 return KMALLOC_SHIFT_LOW;
 165
 166         if (KMALLOC_MIN_SIZE <= 32 && size > 64 && size <= 96)
 167                 return 1;
 168         if (KMALLOC_MIN_SIZE <= 64 && size > 128 && size <= 192)
 169                 return 2;
 170         if (size <=          8) return 3;
 171         if (size <=         16) return 4;
 172         if (size <=         32) return 5;
 173         if (size <=         64) return 6;
 174         if (size <=        128) return 7;
 175         if (size <=        256) return 8;
 176         if (size <=        512) return 9;
 177         if (size <=       1024) return 10;
 178         if (size <=   2 * 1024) return 11;
 179         if (size <=   4 * 1024) return 12;
 180 /*
 181  * The following is only needed to support architectures with a larger page
 182  * size than 4k. We need to support 2 * PAGE_SIZE here. So for a 64k page
 183  * size we would have to go up to 128k.
 184  */
 185         if (size <=   8 * 1024) return 13;
 186         if (size <=  16 * 1024) return 14;
 187         if (size <=  32 * 1024) return 15;
 188         if (size <=  64 * 1024) return 16;
 189         if (size <= 128 * 1024) return 17;
 190         if (size <= 256 * 1024) return 18;
 191         if (size <= 512 * 1024) return 19;
 192         if (size <= 1024 * 1024) return 20;
 193         if (size <=  2 * 1024 * 1024) return 21;
 194         BUG();
 195         return -1; /* Will never be reached */
 196
 197 /*
 198  * What we really wanted to do and cannot do because of compiler issues is:
 199  *      int i;
 200  *      for (i = KMALLOC_SHIFT_LOW; i <= KMALLOC_SHIFT_HIGH; i++)
 201  *              if (size <= (1 << i))
 202  *                      return i;
 203  */
 204 }
 205
 206 /*
 207  * Find the slab cache for a given combination of allocation flags and size.
 208  *
 209  * This ought to end up with a global pointer to the right cache
 210  * in kmalloc_caches.
 211  */
 212 static __always_inline struct kmem_cache *kmalloc_slab(size_t size)
 213 {
 214         int index = kmalloc_index(size);
 215
 216         if (index == 0)
 217                 return NULL;
 218
 219         return kmalloc_caches[index];
 220 }
 221
 222 void *kmem_cache_alloc(struct kmem_cache *, gfp_t);
 223 void *__kmalloc(size_t size, gfp_t flags);
 224
 225 static __always_inline void *
 226 kmalloc_order(size_t size, gfp_t flags, unsigned int order)
 227 {
 228         void *ret = (void *) __get_free_pages(flags | __GFP_COMP, order);
 229         kmemleak_alloc(ret, size, 1, flags);
 230         return ret;
 231 }
 232
 233 /**
 234  * Calling this on allocated memory will check that the memory
 235  * is expected to be in use, and print warnings if not.
 236  */
 237 #ifdef CONFIG_SLUB_DEBUG
 238 extern bool verify_mem_not_deleted(const void *x);
 239 #else
 240 static inline bool verify_mem_not_deleted(const void *x)
 241 {
 242         return true;
 243 }
 244 #endif
 245
 246 #ifdef CONFIG_TRACING
 247 extern void *
 248 kmem_cache_alloc_trace(struct kmem_cache *s, gfp_t gfpflags, size_t size);
 249 extern void *kmalloc_order_trace(size_t size, gfp_t flags, unsigned int order);
 250 #else
 251 static __always_inline void *
 252 kmem_cache_alloc_trace(struct kmem_cache *s, gfp_t gfpflags, size_t size)
 253 {
 254         return kmem_cache_alloc(s, gfpflags);
 255 }
 256
 257 static __always_inline void *
 258 kmalloc_order_trace(size_t size, gfp_t flags, unsigned int order)
 259 {
 260         return kmalloc_order(size, flags, order);
 261 }
 262 #endif
 263
 264 static __always_inline void *kmalloc_large(size_t size, gfp_t flags)
 265 {
 266         unsigned int order = get_order(size);
 267         return kmalloc_order_trace(size, flags, order);
 268 }
 269
 270 static __always_inline void *kmalloc(size_t size, gfp_t flags)
 271 {
 272         if (__builtin_constant_p(size)) {
 273                 if (size > SLUB_MAX_SIZE)
 274                         return kmalloc_large(size, flags);
 275
 276                 if (!(flags & SLUB_DMA)) {
 277                         struct kmem_cache *s = kmalloc_slab(size);
 278
 279                         if (!s)
 280                                 return ZERO_SIZE_PTR;
 281
 282                         return kmem_cache_alloc_trace(s, flags, size);
 283                 }
 284         }
 285         return __kmalloc(size, flags);
 286 }
 287
 288 #ifdef CONFIG_NUMA
 289 void *__kmalloc_node(size_t size, gfp_t flags, int node);
 290 void *kmem_cache_alloc_node(struct kmem_cache *, gfp_t flags, int node);
 291
 292 #ifdef CONFIG_TRACING
 293 extern void *kmem_cache_alloc_node_trace(struct kmem_cache *s,
 294                                            gfp_t gfpflags,
 295                                            int node, size_t size);
 296 #else
 297 static __always_inline void *
 298 kmem_cache_alloc_node_trace(struct kmem_cache *s,
 299                               gfp_t gfpflags,
 300                               int node, size_t size)
 301 {
 302         return kmem_cache_alloc_node(s, gfpflags, node);
 303 }
 304 #endif
 305
 306 static __always_inline void *kmalloc_node(size_t size, gfp_t flags, int node)
 307 {
 308         if (__builtin_constant_p(size) &&
 309                 size <= SLUB_MAX_SIZE && !(flags & SLUB_DMA)) {
 310                         struct kmem_cache *s = kmalloc_slab(size);
 311
 312                 if (!s)
 313                         return ZERO_SIZE_PTR;
 314
 315                 return kmem_cache_alloc_node_trace(s, flags, node, size);
 316         }
 317         return __kmalloc_node(size, flags, node);
 318 }
 319 #endif
 320
 321 #endif /* _LINUX_SLUB_DEF_H */