blob: 027276fa87132728d2c914ccc38fc09bc7602395 [file] [log] [blame]
Christoph Lameter81819f02007-05-06 14:49:36 -07001#ifndef _LINUX_SLUB_DEF_H
2#define _LINUX_SLUB_DEF_H
3
4/*
5 * SLUB : A Slab allocator without object queues.
6 *
Christoph Lametercde53532008-07-04 09:59:22 -07007 * (C) 2007 SGI, Christoph Lameter
Christoph Lameter81819f02007-05-06 14:49:36 -07008 */
9#include <linux/types.h>
10#include <linux/gfp.h>
Paul Gortmaker187f1882011-11-23 20:12:59 -050011#include <linux/bug.h>
Christoph Lameter81819f02007-05-06 14:49:36 -070012#include <linux/workqueue.h>
13#include <linux/kobject.h>
14
Richard Kennedy4a923792010-10-21 10:29:19 +010015#include <linux/kmemleak.h>
Li Zefan039ca4e2010-05-26 17:22:17 +080016
Christoph Lameter8ff12cf2008-02-07 17:47:41 -080017enum 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 */
Alex Shi8028dce2012-02-03 23:34:56 +080025 ALLOC_FROM_PARTIAL, /* Cpu slab acquired from node partial list */
Christoph Lameter8ff12cf2008-02-07 17:47:41 -080026 ALLOC_SLAB, /* Cpu slab acquired from page allocator */
27 ALLOC_REFILL, /* Refill cpu slab from slab freelist */
Christoph Lametere36a2652011-06-01 12:25:57 -050028 ALLOC_NODE_MISMATCH, /* Switching cpu slab */
Christoph Lameter8ff12cf2008-02-07 17:47:41 -080029 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 */
Christoph Lameter03e404a2011-06-01 12:25:58 -050036 DEACTIVATE_BYPASS, /* Implicit deactivation */
Christoph Lameter65c33762008-04-14 19:11:40 +030037 ORDER_FALLBACK, /* Number of times fallback was necessary */
Christoph Lameter4fdccdf2011-03-22 13:35:00 -050038 CMPXCHG_DOUBLE_CPU_FAIL,/* Failure of this_cpu_cmpxchg_double */
Christoph Lameterb789ef52011-06-01 12:25:49 -050039 CMPXCHG_DOUBLE_FAIL, /* Number of times that cmpxchg double did not match */
Christoph Lameter49e22582011-08-09 16:12:27 -050040 CPU_PARTIAL_ALLOC, /* Used cpu partial on alloc */
Alex Shi8028dce2012-02-03 23:34:56 +080041 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 */
Christoph Lameter8ff12cf2008-02-07 17:47:41 -080044 NR_SLUB_STAT_ITEMS };
45
Christoph Lameterdfb4f092007-10-16 01:26:05 -070046struct kmem_cache_cpu {
Christoph Lameter8a5ec0b2011-02-25 11:38:54 -060047 void **freelist; /* Pointer to next available object */
Christoph Lameter8a5ec0b2011-02-25 11:38:54 -060048 unsigned long tid; /* Globally unique transaction id */
Christoph Lameterda89b792008-01-07 23:20:31 -080049 struct page *page; /* The slab from which we are allocating */
Christoph Lameter49e22582011-08-09 16:12:27 -050050 struct page *partial; /* Partially allocated frozen slabs */
Christoph Lameter8ff12cf2008-02-07 17:47:41 -080051#ifdef CONFIG_SLUB_STATS
52 unsigned stat[NR_SLUB_STAT_ITEMS];
53#endif
Christoph Lameter4c93c3552007-10-16 01:26:08 -070054};
Christoph Lameterdfb4f092007-10-16 01:26:05 -070055
Christoph Lameter81819f02007-05-06 14:49:36 -070056/*
Christoph Lameter834f3d12008-04-14 19:11:31 +030057 * Word size structure that can be atomically updated or read and that
58 * contains both the order and the number of objects that a slab of the
59 * given order would contain.
60 */
61struct kmem_cache_order_objects {
62 unsigned long x;
63};
64
65/*
Christoph Lameter81819f02007-05-06 14:49:36 -070066 * Slab cache management.
67 */
68struct kmem_cache {
Namhyung Kim1b5ad242010-08-07 14:29:22 +020069 struct kmem_cache_cpu __percpu *cpu_slab;
Christoph Lameter81819f02007-05-06 14:49:36 -070070 /* Used for retriving partial slabs etc */
71 unsigned long flags;
Christoph Lameter1a757fe2011-02-25 11:38:51 -060072 unsigned long min_partial;
Christoph Lameter81819f02007-05-06 14:49:36 -070073 int size; /* The size of an object including meta data */
Christoph Lameter3b0efdf2012-06-13 10:24:57 -050074 int object_size; /* The size of an object without meta data */
Christoph Lameter81819f02007-05-06 14:49:36 -070075 int offset; /* Free pointer offset. */
Alex Shi9f264902011-09-01 11:32:18 +080076 int cpu_partial; /* Number of per cpu partial objects to keep around */
Christoph Lameter834f3d12008-04-14 19:11:31 +030077 struct kmem_cache_order_objects oo;
Christoph Lameter81819f02007-05-06 14:49:36 -070078
Christoph Lameter81819f02007-05-06 14:49:36 -070079 /* Allocation and freeing of slabs */
Christoph Lameter205ab992008-04-14 19:11:40 +030080 struct kmem_cache_order_objects max;
Christoph Lameter65c33762008-04-14 19:11:40 +030081 struct kmem_cache_order_objects min;
Christoph Lameterb7a49f02008-02-14 14:21:32 -080082 gfp_t allocflags; /* gfp flags to use on each alloc */
Christoph Lameter81819f02007-05-06 14:49:36 -070083 int refcount; /* Refcount for slab cache destroy */
Alexey Dobriyan51cc5062008-07-25 19:45:34 -070084 void (*ctor)(void *);
Christoph Lameter81819f02007-05-06 14:49:36 -070085 int inuse; /* Offset to metadata */
86 int align; /* Alignment */
Lai Jiangshanab9a0f12011-03-10 15:21:48 +080087 int reserved; /* Reserved bytes at the end of slabs */
Christoph Lameter81819f02007-05-06 14:49:36 -070088 const char *name; /* Name (only for display!) */
89 struct list_head list; /* List of slab caches */
Christoph Lameterab4d5ed2010-10-05 13:57:26 -050090#ifdef CONFIG_SYSFS
Christoph Lameter81819f02007-05-06 14:49:36 -070091 struct kobject kobj; /* For sysfs */
Christoph Lameter0c710012007-07-17 04:03:24 -070092#endif
Glauber Costaba6c4962012-12-18 14:22:27 -080093#ifdef CONFIG_MEMCG_KMEM
94 struct memcg_cache_params *memcg_params;
Glauber Costa107dab52012-12-18 14:23:05 -080095 int max_attr_size; /* for propagation, maximum size of a stored attr */
Glauber Costaba6c4962012-12-18 14:22:27 -080096#endif
Christoph Lameter81819f02007-05-06 14:49:36 -070097
98#ifdef CONFIG_NUMA
Christoph Lameter98246012008-01-07 23:20:26 -080099 /*
100 * Defragmentation by allocating from a remote node.
101 */
102 int remote_node_defrag_ratio;
Christoph Lameter81819f02007-05-06 14:49:36 -0700103#endif
Christoph Lameter7340cc82010-09-28 08:10:26 -0500104 struct kmem_cache_node *node[MAX_NUMNODES];
Christoph Lameter81819f02007-05-06 14:49:36 -0700105};
106
Paul Mundt6193a2f2007-07-15 23:38:22 -0700107void *kmem_cache_alloc(struct kmem_cache *, gfp_t);
108void *__kmalloc(size_t size, gfp_t flags);
109
Richard Kennedy4a923792010-10-21 10:29:19 +0100110static __always_inline void *
111kmalloc_order(size_t size, gfp_t flags, unsigned int order)
112{
Glauber Costad79923f2012-12-18 14:22:48 -0800113 void *ret;
114
115 flags |= (__GFP_COMP | __GFP_KMEMCG);
116 ret = (void *) __get_free_pages(flags, order);
Richard Kennedy4a923792010-10-21 10:29:19 +0100117 kmemleak_alloc(ret, size, 1, flags);
118 return ret;
119}
120
Ben Greeard18a90d2011-07-07 11:36:37 -0700121/**
122 * Calling this on allocated memory will check that the memory
123 * is expected to be in use, and print warnings if not.
124 */
125#ifdef CONFIG_SLUB_DEBUG
126extern bool verify_mem_not_deleted(const void *x);
127#else
128static inline bool verify_mem_not_deleted(const void *x)
129{
130 return true;
131}
132#endif
133
Li Zefan0f24f122009-12-11 15:45:30 +0800134#ifdef CONFIG_TRACING
Richard Kennedy4a923792010-10-21 10:29:19 +0100135extern void *
136kmem_cache_alloc_trace(struct kmem_cache *s, gfp_t gfpflags, size_t size);
137extern void *kmalloc_order_trace(size_t size, gfp_t flags, unsigned int order);
Eduard - Gabriel Munteanu5b882be2008-08-19 20:43:26 +0300138#else
139static __always_inline void *
Richard Kennedy4a923792010-10-21 10:29:19 +0100140kmem_cache_alloc_trace(struct kmem_cache *s, gfp_t gfpflags, size_t size)
Eduard - Gabriel Munteanu5b882be2008-08-19 20:43:26 +0300141{
142 return kmem_cache_alloc(s, gfpflags);
143}
Richard Kennedy4a923792010-10-21 10:29:19 +0100144
145static __always_inline void *
146kmalloc_order_trace(size_t size, gfp_t flags, unsigned int order)
147{
148 return kmalloc_order(size, flags, order);
149}
Eduard - Gabriel Munteanu5b882be2008-08-19 20:43:26 +0300150#endif
151
Pekka Enbergeada35e2008-02-11 22:47:46 +0200152static __always_inline void *kmalloc_large(size_t size, gfp_t flags)
153{
Eduard - Gabriel Munteanu5b882be2008-08-19 20:43:26 +0300154 unsigned int order = get_order(size);
Richard Kennedy4a923792010-10-21 10:29:19 +0100155 return kmalloc_order_trace(size, flags, order);
Pekka Enbergeada35e2008-02-11 22:47:46 +0200156}
157
Christoph Lameteraa137f92007-08-31 00:48:45 -0700158static __always_inline void *kmalloc(size_t size, gfp_t flags)
Christoph Lameter81819f02007-05-06 14:49:36 -0700159{
Christoph Lameteraadb4bc2007-10-16 01:24:38 -0700160 if (__builtin_constant_p(size)) {
Christoph Lameter95a05b42013-01-10 19:14:19 +0000161 if (size > KMALLOC_MAX_CACHE_SIZE)
Pekka Enbergeada35e2008-02-11 22:47:46 +0200162 return kmalloc_large(size, flags);
Christoph Lameter81819f02007-05-06 14:49:36 -0700163
Christoph Lameter2c59dd62013-01-10 19:14:19 +0000164 if (!(flags & GFP_DMA)) {
165 int index = kmalloc_index(size);
Christoph Lameter81819f02007-05-06 14:49:36 -0700166
Christoph Lameter2c59dd62013-01-10 19:14:19 +0000167 if (!index)
Christoph Lameteraadb4bc2007-10-16 01:24:38 -0700168 return ZERO_SIZE_PTR;
169
Christoph Lameter2c59dd62013-01-10 19:14:19 +0000170 return kmem_cache_alloc_trace(kmalloc_caches[index],
171 flags, size);
Christoph Lameteraadb4bc2007-10-16 01:24:38 -0700172 }
173 }
174 return __kmalloc(size, flags);
Christoph Lameter81819f02007-05-06 14:49:36 -0700175}
176
Christoph Lameter81819f02007-05-06 14:49:36 -0700177#ifdef CONFIG_NUMA
Paul Mundt6193a2f2007-07-15 23:38:22 -0700178void *__kmalloc_node(size_t size, gfp_t flags, int node);
179void *kmem_cache_alloc_node(struct kmem_cache *, gfp_t flags, int node);
Christoph Lameter81819f02007-05-06 14:49:36 -0700180
Li Zefan0f24f122009-12-11 15:45:30 +0800181#ifdef CONFIG_TRACING
Richard Kennedy4a923792010-10-21 10:29:19 +0100182extern void *kmem_cache_alloc_node_trace(struct kmem_cache *s,
Eduard - Gabriel Munteanu5b882be2008-08-19 20:43:26 +0300183 gfp_t gfpflags,
Richard Kennedy4a923792010-10-21 10:29:19 +0100184 int node, size_t size);
Eduard - Gabriel Munteanu5b882be2008-08-19 20:43:26 +0300185#else
186static __always_inline void *
Richard Kennedy4a923792010-10-21 10:29:19 +0100187kmem_cache_alloc_node_trace(struct kmem_cache *s,
Eduard - Gabriel Munteanu5b882be2008-08-19 20:43:26 +0300188 gfp_t gfpflags,
Richard Kennedy4a923792010-10-21 10:29:19 +0100189 int node, size_t size)
Eduard - Gabriel Munteanu5b882be2008-08-19 20:43:26 +0300190{
191 return kmem_cache_alloc_node(s, gfpflags, node);
192}
193#endif
194
Christoph Lameteraa137f92007-08-31 00:48:45 -0700195static __always_inline void *kmalloc_node(size_t size, gfp_t flags, int node)
Christoph Lameter81819f02007-05-06 14:49:36 -0700196{
Christoph Lameteraadb4bc2007-10-16 01:24:38 -0700197 if (__builtin_constant_p(size) &&
Christoph Lameter2c59dd62013-01-10 19:14:19 +0000198 size <= KMALLOC_MAX_CACHE_SIZE && !(flags & GFP_DMA)) {
199 int index = kmalloc_index(size);
Christoph Lameter81819f02007-05-06 14:49:36 -0700200
Christoph Lameter2c59dd62013-01-10 19:14:19 +0000201 if (!index)
Christoph Lameter272c1d22007-06-08 13:46:49 -0700202 return ZERO_SIZE_PTR;
Christoph Lameter81819f02007-05-06 14:49:36 -0700203
Christoph Lameter2c59dd62013-01-10 19:14:19 +0000204 return kmem_cache_alloc_node_trace(kmalloc_caches[index],
205 flags, node, size);
Christoph Lameteraadb4bc2007-10-16 01:24:38 -0700206 }
207 return __kmalloc_node(size, flags, node);
Christoph Lameter81819f02007-05-06 14:49:36 -0700208}
209#endif
210
Christoph Lameter81819f02007-05-06 14:49:36 -0700211#endif /* _LINUX_SLUB_DEF_H */