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         int max_attr_size; /* for propagation, maximum size of a stored attr */
 107 #endif
 108
 109 #ifdef CONFIG_NUMA
 110         /*
 111          * Defragmentation by allocating from a remote node.
 112          */
 113         int remote_node_defrag_ratio;
 114 #endif
 115         struct kmem_cache_node *node[MAX_NUMNODES];
 116 };
 117
 118 #ifdef CONFIG_ZONE_DMA
 119 #define SLUB_DMA __GFP_DMA
 120 #else
 121 /* Disable DMA functionality */
 122 #define SLUB_DMA (__force gfp_t)0
 123 #endif
 124
 125 /*
 126  * We keep the general caches in an array of slab caches that are used for
 127  * 2^x bytes of allocations.
 128  */
 129 extern struct kmem_cache *kmalloc_caches[KMALLOC_SHIFT_HIGH + 1];
 130
 131 /*
 132  * Find the slab cache for a given combination of allocation flags and size.
 133  *
 134  * This ought to end up with a global pointer to the right cache
 135  * in kmalloc_caches.
 136  */
 137 static __always_inline struct kmem_cache *kmalloc_slab(size_t size)
 138 {
 139         int index = kmalloc_index(size);
 140
 141         if (index == 0)
 142                 return NULL;
 143
 144         return kmalloc_caches[index];
 145 }
 146
 147 void *kmem_cache_alloc(struct kmem_cache *, gfp_t);
 148 void *__kmalloc(size_t size, gfp_t flags);
 149
 150 static __always_inline void *
 151 kmalloc_order(size_t size, gfp_t flags, unsigned int order)
 152 {
 153         void *ret;
 154
 155         flags |= (__GFP_COMP | __GFP_KMEMCG);
 156         ret = (void *) __get_free_pages(flags, order);
 157         kmemleak_alloc(ret, size, 1, flags);
 158         return ret;
 159 }
 160
 161 /**
 162  * Calling this on allocated memory will check that the memory
 163  * is expected to be in use, and print warnings if not.
 164  */
 165 #ifdef CONFIG_SLUB_DEBUG
 166 extern bool verify_mem_not_deleted(const void *x);
 167 #else
 168 static inline bool verify_mem_not_deleted(const void *x)
 169 {
 170         return true;
 171 }
 172 #endif
 173
 174 #ifdef CONFIG_TRACING
 175 extern void *
 176 kmem_cache_alloc_trace(struct kmem_cache *s, gfp_t gfpflags, size_t size);
 177 extern void *kmalloc_order_trace(size_t size, gfp_t flags, unsigned int order);
 178 #else
 179 static __always_inline void *
 180 kmem_cache_alloc_trace(struct kmem_cache *s, gfp_t gfpflags, size_t size)
 181 {
 182         return kmem_cache_alloc(s, gfpflags);
 183 }
 184
 185 static __always_inline void *
 186 kmalloc_order_trace(size_t size, gfp_t flags, unsigned int order)
 187 {
 188         return kmalloc_order(size, flags, order);
 189 }
 190 #endif
 191
 192 static __always_inline void *kmalloc_large(size_t size, gfp_t flags)
 193 {
 194         unsigned int order = get_order(size);
 195         return kmalloc_order_trace(size, flags, order);
 196 }
 197
 198 static __always_inline void *kmalloc(size_t size, gfp_t flags)
 199 {
 200         if (__builtin_constant_p(size)) {
 201                 if (size > KMALLOC_MAX_CACHE_SIZE)
 202                         return kmalloc_large(size, flags);
 203
 204                 if (!(flags & SLUB_DMA)) {
 205                         struct kmem_cache *s = kmalloc_slab(size);
 206
 207                         if (!s)
 208                                 return ZERO_SIZE_PTR;
 209
 210                         return kmem_cache_alloc_trace(s, flags, size);
 211                 }
 212         }
 213         return __kmalloc(size, flags);
 214 }
 215
 216 #ifdef CONFIG_NUMA
 217 void *__kmalloc_node(size_t size, gfp_t flags, int node);
 218 void *kmem_cache_alloc_node(struct kmem_cache *, gfp_t flags, int node);
 219
 220 #ifdef CONFIG_TRACING
 221 extern void *kmem_cache_alloc_node_trace(struct kmem_cache *s,
 222                                            gfp_t gfpflags,
 223                                            int node, size_t size);
 224 #else
 225 static __always_inline void *
 226 kmem_cache_alloc_node_trace(struct kmem_cache *s,
 227                               gfp_t gfpflags,
 228                               int node, size_t size)
 229 {
 230         return kmem_cache_alloc_node(s, gfpflags, node);
 231 }
 232 #endif
 233
 234 static __always_inline void *kmalloc_node(size_t size, gfp_t flags, int node)
 235 {
 236         if (__builtin_constant_p(size) &&
 237                 size <= KMALLOC_MAX_CACHE_SIZE && !(flags & SLUB_DMA)) {
 238                         struct kmem_cache *s = kmalloc_slab(size);
 239
 240                 if (!s)
 241                         return ZERO_SIZE_PTR;
 242
 243                 return kmem_cache_alloc_node_trace(s, flags, node, size);
 244         }
 245         return __kmalloc_node(size, flags, node);
 246 }
 247 #endif
 248
 249 #endif /* _LINUX_SLUB_DEF_H */