blob: 8184a7cde272b8aa9d6e08e6407482ca5d7bd7df [file] [log] [blame]
Christoph Lameter97d06602012-07-06 15:25:11 -05001#ifndef MM_SLAB_H
2#define MM_SLAB_H
3/*
4 * Internal slab definitions
5 */
6
7/*
8 * State of the slab allocator.
9 *
10 * This is used to describe the states of the allocator during bootup.
11 * Allocators use this to gradually bootstrap themselves. Most allocators
12 * have the problem that the structures used for managing slab caches are
13 * allocated from slab caches themselves.
14 */
15enum slab_state {
16 DOWN, /* No slab functionality yet */
17 PARTIAL, /* SLUB: kmem_cache_node available */
18 PARTIAL_ARRAYCACHE, /* SLAB: kmalloc size for arraycache available */
Christoph Lameterce8eb6c2013-01-10 19:14:19 +000019 PARTIAL_NODE, /* SLAB: kmalloc size for node struct available */
Christoph Lameter97d06602012-07-06 15:25:11 -050020 UP, /* Slab caches usable but not all extras yet */
21 FULL /* Everything is working */
22};
23
24extern enum slab_state slab_state;
25
Christoph Lameter18004c52012-07-06 15:25:12 -050026/* The slab cache mutex protects the management structures during changes */
27extern struct mutex slab_mutex;
Christoph Lameter9b030cb2012-09-05 00:20:33 +000028
29/* The list of all slab caches on the system */
Christoph Lameter18004c52012-07-06 15:25:12 -050030extern struct list_head slab_caches;
31
Christoph Lameter9b030cb2012-09-05 00:20:33 +000032/* The slab cache that manages slab cache information */
33extern struct kmem_cache *kmem_cache;
34
Christoph Lameter45906852012-11-28 16:23:16 +000035unsigned long calculate_alignment(unsigned long flags,
36 unsigned long align, unsigned long size);
37
Christoph Lameterf97d5f62013-01-10 19:12:17 +000038#ifndef CONFIG_SLOB
39/* Kmalloc array related functions */
40void create_kmalloc_caches(unsigned long);
Christoph Lameter2c59dd62013-01-10 19:14:19 +000041
42/* Find the kmalloc slab corresponding for a certain size */
43struct kmem_cache *kmalloc_slab(size_t, gfp_t);
Christoph Lameterf97d5f62013-01-10 19:12:17 +000044#endif
45
46
Christoph Lameter9b030cb2012-09-05 00:20:33 +000047/* Functions provided by the slab allocators */
Christoph Lameter8a13a4c2012-09-04 23:18:33 +000048extern int __kmem_cache_create(struct kmem_cache *, unsigned long flags);
Christoph Lameter97d06602012-07-06 15:25:11 -050049
Christoph Lameter45530c42012-11-28 16:23:07 +000050extern struct kmem_cache *create_kmalloc_cache(const char *name, size_t size,
51 unsigned long flags);
52extern void create_boot_cache(struct kmem_cache *, const char *name,
53 size_t size, unsigned long flags);
54
Glauber Costa2633d7a2012-12-18 14:22:34 -080055struct mem_cgroup;
Christoph Lametercbb79692012-09-05 00:18:32 +000056#ifdef CONFIG_SLUB
Glauber Costa2633d7a2012-12-18 14:22:34 -080057struct kmem_cache *
58__kmem_cache_alias(struct mem_cgroup *memcg, const char *name, size_t size,
59 size_t align, unsigned long flags, void (*ctor)(void *));
Christoph Lametercbb79692012-09-05 00:18:32 +000060#else
Glauber Costa2633d7a2012-12-18 14:22:34 -080061static inline struct kmem_cache *
62__kmem_cache_alias(struct mem_cgroup *memcg, const char *name, size_t size,
63 size_t align, unsigned long flags, void (*ctor)(void *))
Christoph Lametercbb79692012-09-05 00:18:32 +000064{ return NULL; }
65#endif
66
67
Glauber Costad8843922012-10-17 15:36:51 +040068/* Legal flag mask for kmem_cache_create(), for various configurations */
69#define SLAB_CORE_FLAGS (SLAB_HWCACHE_ALIGN | SLAB_CACHE_DMA | SLAB_PANIC | \
70 SLAB_DESTROY_BY_RCU | SLAB_DEBUG_OBJECTS )
71
72#if defined(CONFIG_DEBUG_SLAB)
73#define SLAB_DEBUG_FLAGS (SLAB_RED_ZONE | SLAB_POISON | SLAB_STORE_USER)
74#elif defined(CONFIG_SLUB_DEBUG)
75#define SLAB_DEBUG_FLAGS (SLAB_RED_ZONE | SLAB_POISON | SLAB_STORE_USER | \
76 SLAB_TRACE | SLAB_DEBUG_FREE)
77#else
78#define SLAB_DEBUG_FLAGS (0)
79#endif
80
81#if defined(CONFIG_SLAB)
82#define SLAB_CACHE_FLAGS (SLAB_MEM_SPREAD | SLAB_NOLEAKTRACE | \
83 SLAB_RECLAIM_ACCOUNT | SLAB_TEMPORARY | SLAB_NOTRACK)
84#elif defined(CONFIG_SLUB)
85#define SLAB_CACHE_FLAGS (SLAB_NOLEAKTRACE | SLAB_RECLAIM_ACCOUNT | \
86 SLAB_TEMPORARY | SLAB_NOTRACK)
87#else
88#define SLAB_CACHE_FLAGS (0)
89#endif
90
91#define CACHE_CREATE_MASK (SLAB_CORE_FLAGS | SLAB_DEBUG_FLAGS | SLAB_CACHE_FLAGS)
92
Christoph Lameter945cf2b2012-09-04 23:18:33 +000093int __kmem_cache_shutdown(struct kmem_cache *);
Christoph Lameter945cf2b2012-09-04 23:18:33 +000094
Glauber Costab7454ad2012-10-19 18:20:25 +040095struct seq_file;
96struct file;
Glauber Costab7454ad2012-10-19 18:20:25 +040097
Glauber Costa0d7561c2012-10-19 18:20:27 +040098struct slabinfo {
99 unsigned long active_objs;
100 unsigned long num_objs;
101 unsigned long active_slabs;
102 unsigned long num_slabs;
103 unsigned long shared_avail;
104 unsigned int limit;
105 unsigned int batchcount;
106 unsigned int shared;
107 unsigned int objects_per_slab;
108 unsigned int cache_order;
109};
110
111void get_slabinfo(struct kmem_cache *s, struct slabinfo *sinfo);
112void slabinfo_show_stats(struct seq_file *m, struct kmem_cache *s);
Glauber Costab7454ad2012-10-19 18:20:25 +0400113ssize_t slabinfo_write(struct file *file, const char __user *buffer,
114 size_t count, loff_t *ppos);
Glauber Costaba6c4962012-12-18 14:22:27 -0800115
116#ifdef CONFIG_MEMCG_KMEM
117static inline bool is_root_cache(struct kmem_cache *s)
118{
119 return !s->memcg_params || s->memcg_params->is_root_cache;
120}
Glauber Costa2633d7a2012-12-18 14:22:34 -0800121
122static inline bool cache_match_memcg(struct kmem_cache *cachep,
123 struct mem_cgroup *memcg)
124{
125 return (is_root_cache(cachep) && !memcg) ||
126 (cachep->memcg_params->memcg == memcg);
127}
Glauber Costab9ce5ef2012-12-18 14:22:46 -0800128
Glauber Costa1f458cb2012-12-18 14:22:50 -0800129static inline void memcg_bind_pages(struct kmem_cache *s, int order)
130{
131 if (!is_root_cache(s))
132 atomic_add(1 << order, &s->memcg_params->nr_pages);
133}
134
135static inline void memcg_release_pages(struct kmem_cache *s, int order)
136{
137 if (is_root_cache(s))
138 return;
139
140 if (atomic_sub_and_test((1 << order), &s->memcg_params->nr_pages))
141 mem_cgroup_destroy_cache(s);
142}
143
Glauber Costab9ce5ef2012-12-18 14:22:46 -0800144static inline bool slab_equal_or_root(struct kmem_cache *s,
145 struct kmem_cache *p)
146{
147 return (p == s) ||
148 (s->memcg_params && (p == s->memcg_params->root_cache));
149}
Glauber Costa749c5412012-12-18 14:23:01 -0800150
151/*
152 * We use suffixes to the name in memcg because we can't have caches
153 * created in the system with the same name. But when we print them
154 * locally, better refer to them with the base name
155 */
156static inline const char *cache_name(struct kmem_cache *s)
157{
158 if (!is_root_cache(s))
159 return s->memcg_params->root_cache->name;
160 return s->name;
161}
162
Vladimir Davydovf8570262014-01-23 15:53:06 -0800163/*
164 * Note, we protect with RCU only the memcg_caches array, not per-memcg caches.
165 * That said the caller must assure the memcg's cache won't go away. Since once
166 * created a memcg's cache is destroyed only along with the root cache, it is
167 * true if we are going to allocate from the cache or hold a reference to the
168 * root cache by other means. Otherwise, we should hold either the slab_mutex
169 * or the memcg's slab_caches_mutex while calling this function and accessing
170 * the returned value.
171 */
Qiang Huang2ade4de2013-11-12 15:08:23 -0800172static inline struct kmem_cache *
173cache_from_memcg_idx(struct kmem_cache *s, int idx)
Glauber Costa749c5412012-12-18 14:23:01 -0800174{
Vladimir Davydov959c8962014-01-23 15:52:59 -0800175 struct kmem_cache *cachep;
Vladimir Davydovf8570262014-01-23 15:53:06 -0800176 struct memcg_cache_params *params;
Vladimir Davydov959c8962014-01-23 15:52:59 -0800177
Andrey Vagin6f6b8952013-08-28 16:35:20 -0700178 if (!s->memcg_params)
179 return NULL;
Vladimir Davydovf8570262014-01-23 15:53:06 -0800180
181 rcu_read_lock();
182 params = rcu_dereference(s->memcg_params);
183 cachep = params->memcg_caches[idx];
184 rcu_read_unlock();
Vladimir Davydov959c8962014-01-23 15:52:59 -0800185
186 /*
187 * Make sure we will access the up-to-date value. The code updating
188 * memcg_caches issues a write barrier to match this (see
189 * memcg_register_cache()).
190 */
191 smp_read_barrier_depends();
192 return cachep;
Glauber Costa749c5412012-12-18 14:23:01 -0800193}
Glauber Costa943a4512012-12-18 14:23:03 -0800194
195static inline struct kmem_cache *memcg_root_cache(struct kmem_cache *s)
196{
197 if (is_root_cache(s))
198 return s;
199 return s->memcg_params->root_cache;
200}
Glauber Costaba6c4962012-12-18 14:22:27 -0800201#else
202static inline bool is_root_cache(struct kmem_cache *s)
203{
204 return true;
205}
206
Glauber Costa2633d7a2012-12-18 14:22:34 -0800207static inline bool cache_match_memcg(struct kmem_cache *cachep,
208 struct mem_cgroup *memcg)
209{
210 return true;
211}
Glauber Costab9ce5ef2012-12-18 14:22:46 -0800212
Glauber Costa1f458cb2012-12-18 14:22:50 -0800213static inline void memcg_bind_pages(struct kmem_cache *s, int order)
214{
215}
216
217static inline void memcg_release_pages(struct kmem_cache *s, int order)
218{
219}
220
Glauber Costab9ce5ef2012-12-18 14:22:46 -0800221static inline bool slab_equal_or_root(struct kmem_cache *s,
222 struct kmem_cache *p)
223{
224 return true;
225}
Glauber Costa749c5412012-12-18 14:23:01 -0800226
227static inline const char *cache_name(struct kmem_cache *s)
228{
229 return s->name;
230}
231
Qiang Huang2ade4de2013-11-12 15:08:23 -0800232static inline struct kmem_cache *
233cache_from_memcg_idx(struct kmem_cache *s, int idx)
Glauber Costa749c5412012-12-18 14:23:01 -0800234{
235 return NULL;
236}
Glauber Costa943a4512012-12-18 14:23:03 -0800237
238static inline struct kmem_cache *memcg_root_cache(struct kmem_cache *s)
239{
240 return s;
241}
Glauber Costaba6c4962012-12-18 14:22:27 -0800242#endif
Glauber Costab9ce5ef2012-12-18 14:22:46 -0800243
244static inline struct kmem_cache *cache_from_obj(struct kmem_cache *s, void *x)
245{
246 struct kmem_cache *cachep;
247 struct page *page;
248
249 /*
250 * When kmemcg is not being used, both assignments should return the
251 * same value. but we don't want to pay the assignment price in that
252 * case. If it is not compiled in, the compiler should be smart enough
253 * to not do even the assignment. In that case, slab_equal_or_root
254 * will also be a constant.
255 */
256 if (!memcg_kmem_enabled() && !unlikely(s->flags & SLAB_DEBUG_FREE))
257 return s;
258
259 page = virt_to_head_page(x);
260 cachep = page->slab_cache;
261 if (slab_equal_or_root(cachep, s))
262 return cachep;
263
264 pr_err("%s: Wrong slab cache. %s but object is from %s\n",
265 __FUNCTION__, cachep->name, s->name);
266 WARN_ON_ONCE(1);
267 return s;
268}
Christoph Lameter97d06602012-07-06 15:25:11 -0500269#endif
Christoph Lameterca349562013-01-10 19:14:19 +0000270
271
272/*
273 * The slab lists for all objects.
274 */
275struct kmem_cache_node {
276 spinlock_t list_lock;
277
278#ifdef CONFIG_SLAB
279 struct list_head slabs_partial; /* partial list first, better asm code */
280 struct list_head slabs_full;
281 struct list_head slabs_free;
282 unsigned long free_objects;
283 unsigned int free_limit;
284 unsigned int colour_next; /* Per-node cache coloring */
285 struct array_cache *shared; /* shared per node */
286 struct array_cache **alien; /* on other nodes */
287 unsigned long next_reap; /* updated without locking */
288 int free_touched; /* updated without locking */
289#endif
290
291#ifdef CONFIG_SLUB
292 unsigned long nr_partial;
293 struct list_head partial;
294#ifdef CONFIG_SLUB_DEBUG
295 atomic_long_t nr_slabs;
296 atomic_long_t total_objects;
297 struct list_head full;
298#endif
299#endif
300
301};
Wanpeng Lie25839f2013-07-04 08:33:23 +0800302
Wanpeng Li276a2432013-07-08 08:08:28 +0800303void *slab_next(struct seq_file *m, void *p, loff_t *pos);
304void slab_stop(struct seq_file *m, void *p);