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