blob: 4c3ac12dd64405478b1b5bd24b7f5ff4f479c981 [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
Joonsoo Kim07f361b2014-10-09 15:26:00 -07007#ifdef CONFIG_SLOB
8/*
9 * Common fields provided in kmem_cache by all slab allocators
10 * This struct is either used directly by the allocator (SLOB)
11 * or the allocator must include definitions for all fields
12 * provided in kmem_cache_common in their definition of kmem_cache.
13 *
14 * Once we can do anonymous structs (C11 standard) we could put a
15 * anonymous struct definition in these allocators so that the
16 * separate allocations in the kmem_cache structure of SLAB and
17 * SLUB is no longer needed.
18 */
19struct kmem_cache {
20 unsigned int object_size;/* The original size of the object */
21 unsigned int size; /* The aligned/padded/added on size */
22 unsigned int align; /* Alignment as calculated */
23 unsigned long flags; /* Active flags on the slab */
24 const char *name; /* Slab name for sysfs */
25 int refcount; /* Use counter */
26 void (*ctor)(void *); /* Called on object slot creation */
27 struct list_head list; /* List of all slab caches on the system */
28};
29
30#endif /* CONFIG_SLOB */
31
32#ifdef CONFIG_SLAB
33#include <linux/slab_def.h>
34#endif
35
36#ifdef CONFIG_SLUB
37#include <linux/slub_def.h>
38#endif
39
40#include <linux/memcontrol.h>
41
Christoph Lameter97d06602012-07-06 15:25:11 -050042/*
43 * State of the slab allocator.
44 *
45 * This is used to describe the states of the allocator during bootup.
46 * Allocators use this to gradually bootstrap themselves. Most allocators
47 * have the problem that the structures used for managing slab caches are
48 * allocated from slab caches themselves.
49 */
50enum slab_state {
51 DOWN, /* No slab functionality yet */
52 PARTIAL, /* SLUB: kmem_cache_node available */
Christoph Lameterce8eb6c2013-01-10 19:14:19 +000053 PARTIAL_NODE, /* SLAB: kmalloc size for node struct available */
Christoph Lameter97d06602012-07-06 15:25:11 -050054 UP, /* Slab caches usable but not all extras yet */
55 FULL /* Everything is working */
56};
57
58extern enum slab_state slab_state;
59
Christoph Lameter18004c52012-07-06 15:25:12 -050060/* The slab cache mutex protects the management structures during changes */
61extern struct mutex slab_mutex;
Christoph Lameter9b030cb2012-09-05 00:20:33 +000062
63/* The list of all slab caches on the system */
Christoph Lameter18004c52012-07-06 15:25:12 -050064extern struct list_head slab_caches;
65
Christoph Lameter9b030cb2012-09-05 00:20:33 +000066/* The slab cache that manages slab cache information */
67extern struct kmem_cache *kmem_cache;
68
Christoph Lameter45906852012-11-28 16:23:16 +000069unsigned long calculate_alignment(unsigned long flags,
70 unsigned long align, unsigned long size);
71
Christoph Lameterf97d5f62013-01-10 19:12:17 +000072#ifndef CONFIG_SLOB
73/* Kmalloc array related functions */
74void create_kmalloc_caches(unsigned long);
Christoph Lameter2c59dd62013-01-10 19:14:19 +000075
76/* Find the kmalloc slab corresponding for a certain size */
77struct kmem_cache *kmalloc_slab(size_t, gfp_t);
Christoph Lameterf97d5f62013-01-10 19:12:17 +000078#endif
79
80
Christoph Lameter9b030cb2012-09-05 00:20:33 +000081/* Functions provided by the slab allocators */
Christoph Lameter8a13a4c2012-09-04 23:18:33 +000082extern int __kmem_cache_create(struct kmem_cache *, unsigned long flags);
Christoph Lameter97d06602012-07-06 15:25:11 -050083
Christoph Lameter45530c42012-11-28 16:23:07 +000084extern struct kmem_cache *create_kmalloc_cache(const char *name, size_t size,
85 unsigned long flags);
86extern void create_boot_cache(struct kmem_cache *, const char *name,
87 size_t size, unsigned long flags);
88
Joonsoo Kim423c9292014-10-09 15:26:22 -070089int slab_unmergeable(struct kmem_cache *s);
90struct kmem_cache *find_mergeable(size_t size, size_t align,
91 unsigned long flags, const char *name, void (*ctor)(void *));
Joonsoo Kim12220de2014-10-09 15:26:24 -070092#ifndef CONFIG_SLOB
Glauber Costa2633d7a2012-12-18 14:22:34 -080093struct kmem_cache *
Vladimir Davydova44cb942014-04-07 15:39:23 -070094__kmem_cache_alias(const char *name, size_t size, size_t align,
95 unsigned long flags, void (*ctor)(void *));
Joonsoo Kim423c9292014-10-09 15:26:22 -070096
97unsigned long kmem_cache_flags(unsigned long object_size,
98 unsigned long flags, const char *name,
99 void (*ctor)(void *));
Christoph Lametercbb79692012-09-05 00:18:32 +0000100#else
Glauber Costa2633d7a2012-12-18 14:22:34 -0800101static inline struct kmem_cache *
Vladimir Davydova44cb942014-04-07 15:39:23 -0700102__kmem_cache_alias(const char *name, size_t size, size_t align,
103 unsigned long flags, void (*ctor)(void *))
Christoph Lametercbb79692012-09-05 00:18:32 +0000104{ return NULL; }
Joonsoo Kim423c9292014-10-09 15:26:22 -0700105
106static inline unsigned long kmem_cache_flags(unsigned long object_size,
107 unsigned long flags, const char *name,
108 void (*ctor)(void *))
109{
110 return flags;
111}
Christoph Lametercbb79692012-09-05 00:18:32 +0000112#endif
113
114
Glauber Costad8843922012-10-17 15:36:51 +0400115/* Legal flag mask for kmem_cache_create(), for various configurations */
116#define SLAB_CORE_FLAGS (SLAB_HWCACHE_ALIGN | SLAB_CACHE_DMA | SLAB_PANIC | \
117 SLAB_DESTROY_BY_RCU | SLAB_DEBUG_OBJECTS )
118
119#if defined(CONFIG_DEBUG_SLAB)
120#define SLAB_DEBUG_FLAGS (SLAB_RED_ZONE | SLAB_POISON | SLAB_STORE_USER)
121#elif defined(CONFIG_SLUB_DEBUG)
122#define SLAB_DEBUG_FLAGS (SLAB_RED_ZONE | SLAB_POISON | SLAB_STORE_USER | \
123 SLAB_TRACE | SLAB_DEBUG_FREE)
124#else
125#define SLAB_DEBUG_FLAGS (0)
126#endif
127
128#if defined(CONFIG_SLAB)
129#define SLAB_CACHE_FLAGS (SLAB_MEM_SPREAD | SLAB_NOLEAKTRACE | \
130 SLAB_RECLAIM_ACCOUNT | SLAB_TEMPORARY | SLAB_NOTRACK)
131#elif defined(CONFIG_SLUB)
132#define SLAB_CACHE_FLAGS (SLAB_NOLEAKTRACE | SLAB_RECLAIM_ACCOUNT | \
133 SLAB_TEMPORARY | SLAB_NOTRACK)
134#else
135#define SLAB_CACHE_FLAGS (0)
136#endif
137
138#define CACHE_CREATE_MASK (SLAB_CORE_FLAGS | SLAB_DEBUG_FLAGS | SLAB_CACHE_FLAGS)
139
Christoph Lameter945cf2b2012-09-04 23:18:33 +0000140int __kmem_cache_shutdown(struct kmem_cache *);
Vladimir Davydovd6e0b7f2015-02-12 14:59:47 -0800141int __kmem_cache_shrink(struct kmem_cache *, bool);
Christoph Lameter41a21282014-05-06 12:50:08 -0700142void slab_kmem_cache_release(struct kmem_cache *);
Christoph Lameter945cf2b2012-09-04 23:18:33 +0000143
Glauber Costab7454ad2012-10-19 18:20:25 +0400144struct seq_file;
145struct file;
Glauber Costab7454ad2012-10-19 18:20:25 +0400146
Glauber Costa0d7561c2012-10-19 18:20:27 +0400147struct slabinfo {
148 unsigned long active_objs;
149 unsigned long num_objs;
150 unsigned long active_slabs;
151 unsigned long num_slabs;
152 unsigned long shared_avail;
153 unsigned int limit;
154 unsigned int batchcount;
155 unsigned int shared;
156 unsigned int objects_per_slab;
157 unsigned int cache_order;
158};
159
160void get_slabinfo(struct kmem_cache *s, struct slabinfo *sinfo);
161void slabinfo_show_stats(struct seq_file *m, struct kmem_cache *s);
Glauber Costab7454ad2012-10-19 18:20:25 +0400162ssize_t slabinfo_write(struct file *file, const char __user *buffer,
163 size_t count, loff_t *ppos);
Glauber Costaba6c4962012-12-18 14:22:27 -0800164
165#ifdef CONFIG_MEMCG_KMEM
Vladimir Davydov426589f2015-02-12 14:59:23 -0800166/*
167 * Iterate over all memcg caches of the given root cache. The caller must hold
168 * slab_mutex.
169 */
170#define for_each_memcg_cache(iter, root) \
171 list_for_each_entry(iter, &(root)->memcg_params.list, \
172 memcg_params.list)
173
174#define for_each_memcg_cache_safe(iter, tmp, root) \
175 list_for_each_entry_safe(iter, tmp, &(root)->memcg_params.list, \
176 memcg_params.list)
177
Glauber Costaba6c4962012-12-18 14:22:27 -0800178static inline bool is_root_cache(struct kmem_cache *s)
179{
Vladimir Davydovf7ce3192015-02-12 14:59:20 -0800180 return s->memcg_params.is_root_cache;
Glauber Costaba6c4962012-12-18 14:22:27 -0800181}
Glauber Costa2633d7a2012-12-18 14:22:34 -0800182
Glauber Costab9ce5ef2012-12-18 14:22:46 -0800183static inline bool slab_equal_or_root(struct kmem_cache *s,
Vladimir Davydovf7ce3192015-02-12 14:59:20 -0800184 struct kmem_cache *p)
Glauber Costab9ce5ef2012-12-18 14:22:46 -0800185{
Vladimir Davydovf7ce3192015-02-12 14:59:20 -0800186 return p == s || p == s->memcg_params.root_cache;
Glauber Costab9ce5ef2012-12-18 14:22:46 -0800187}
Glauber Costa749c5412012-12-18 14:23:01 -0800188
189/*
190 * We use suffixes to the name in memcg because we can't have caches
191 * created in the system with the same name. But when we print them
192 * locally, better refer to them with the base name
193 */
194static inline const char *cache_name(struct kmem_cache *s)
195{
196 if (!is_root_cache(s))
Vladimir Davydovf7ce3192015-02-12 14:59:20 -0800197 s = s->memcg_params.root_cache;
Glauber Costa749c5412012-12-18 14:23:01 -0800198 return s->name;
199}
200
Vladimir Davydovf8570262014-01-23 15:53:06 -0800201/*
202 * Note, we protect with RCU only the memcg_caches array, not per-memcg caches.
Vladimir Davydovf7ce3192015-02-12 14:59:20 -0800203 * That said the caller must assure the memcg's cache won't go away by either
204 * taking a css reference to the owner cgroup, or holding the slab_mutex.
Vladimir Davydovf8570262014-01-23 15:53:06 -0800205 */
Qiang Huang2ade4de2013-11-12 15:08:23 -0800206static inline struct kmem_cache *
207cache_from_memcg_idx(struct kmem_cache *s, int idx)
Glauber Costa749c5412012-12-18 14:23:01 -0800208{
Vladimir Davydov959c8962014-01-23 15:52:59 -0800209 struct kmem_cache *cachep;
Vladimir Davydovf7ce3192015-02-12 14:59:20 -0800210 struct memcg_cache_array *arr;
Vladimir Davydovf8570262014-01-23 15:53:06 -0800211
212 rcu_read_lock();
Vladimir Davydovf7ce3192015-02-12 14:59:20 -0800213 arr = rcu_dereference(s->memcg_params.memcg_caches);
Vladimir Davydov959c8962014-01-23 15:52:59 -0800214
215 /*
216 * Make sure we will access the up-to-date value. The code updating
217 * memcg_caches issues a write barrier to match this (see
Vladimir Davydovf7ce3192015-02-12 14:59:20 -0800218 * memcg_create_kmem_cache()).
Vladimir Davydov959c8962014-01-23 15:52:59 -0800219 */
Vladimir Davydovf7ce3192015-02-12 14:59:20 -0800220 cachep = lockless_dereference(arr->entries[idx]);
Pranith Kumar8df0c2d2014-12-10 15:42:28 -0800221 rcu_read_unlock();
222
Vladimir Davydov959c8962014-01-23 15:52:59 -0800223 return cachep;
Glauber Costa749c5412012-12-18 14:23:01 -0800224}
Glauber Costa943a4512012-12-18 14:23:03 -0800225
226static inline struct kmem_cache *memcg_root_cache(struct kmem_cache *s)
227{
228 if (is_root_cache(s))
229 return s;
Vladimir Davydovf7ce3192015-02-12 14:59:20 -0800230 return s->memcg_params.root_cache;
Glauber Costa943a4512012-12-18 14:23:03 -0800231}
Vladimir Davydov5dfb4172014-06-04 16:06:38 -0700232
233static __always_inline int memcg_charge_slab(struct kmem_cache *s,
234 gfp_t gfp, int order)
235{
236 if (!memcg_kmem_enabled())
237 return 0;
238 if (is_root_cache(s))
239 return 0;
Vladimir Davydovf7ce3192015-02-12 14:59:20 -0800240 return memcg_charge_kmem(s->memcg_params.memcg, gfp, 1 << order);
Vladimir Davydov5dfb4172014-06-04 16:06:38 -0700241}
242
243static __always_inline void memcg_uncharge_slab(struct kmem_cache *s, int order)
244{
245 if (!memcg_kmem_enabled())
246 return;
247 if (is_root_cache(s))
248 return;
Vladimir Davydovf7ce3192015-02-12 14:59:20 -0800249 memcg_uncharge_kmem(s->memcg_params.memcg, 1 << order);
Vladimir Davydov5dfb4172014-06-04 16:06:38 -0700250}
Vladimir Davydovf7ce3192015-02-12 14:59:20 -0800251
252extern void slab_init_memcg_params(struct kmem_cache *);
253
254#else /* !CONFIG_MEMCG_KMEM */
255
Vladimir Davydov426589f2015-02-12 14:59:23 -0800256#define for_each_memcg_cache(iter, root) \
257 for ((void)(iter), (void)(root); 0; )
258#define for_each_memcg_cache_safe(iter, tmp, root) \
259 for ((void)(iter), (void)(tmp), (void)(root); 0; )
260
Glauber Costaba6c4962012-12-18 14:22:27 -0800261static inline bool is_root_cache(struct kmem_cache *s)
262{
263 return true;
264}
265
Glauber Costab9ce5ef2012-12-18 14:22:46 -0800266static inline bool slab_equal_or_root(struct kmem_cache *s,
267 struct kmem_cache *p)
268{
269 return true;
270}
Glauber Costa749c5412012-12-18 14:23:01 -0800271
272static inline const char *cache_name(struct kmem_cache *s)
273{
274 return s->name;
275}
276
Qiang Huang2ade4de2013-11-12 15:08:23 -0800277static inline struct kmem_cache *
278cache_from_memcg_idx(struct kmem_cache *s, int idx)
Glauber Costa749c5412012-12-18 14:23:01 -0800279{
280 return NULL;
281}
Glauber Costa943a4512012-12-18 14:23:03 -0800282
283static inline struct kmem_cache *memcg_root_cache(struct kmem_cache *s)
284{
285 return s;
286}
Vladimir Davydov5dfb4172014-06-04 16:06:38 -0700287
288static inline int memcg_charge_slab(struct kmem_cache *s, gfp_t gfp, int order)
289{
290 return 0;
291}
292
293static inline void memcg_uncharge_slab(struct kmem_cache *s, int order)
294{
295}
Vladimir Davydovf7ce3192015-02-12 14:59:20 -0800296
297static inline void slab_init_memcg_params(struct kmem_cache *s)
298{
299}
300#endif /* CONFIG_MEMCG_KMEM */
Glauber Costab9ce5ef2012-12-18 14:22:46 -0800301
302static inline struct kmem_cache *cache_from_obj(struct kmem_cache *s, void *x)
303{
304 struct kmem_cache *cachep;
305 struct page *page;
306
307 /*
308 * When kmemcg is not being used, both assignments should return the
309 * same value. but we don't want to pay the assignment price in that
310 * case. If it is not compiled in, the compiler should be smart enough
311 * to not do even the assignment. In that case, slab_equal_or_root
312 * will also be a constant.
313 */
314 if (!memcg_kmem_enabled() && !unlikely(s->flags & SLAB_DEBUG_FREE))
315 return s;
316
317 page = virt_to_head_page(x);
318 cachep = page->slab_cache;
319 if (slab_equal_or_root(cachep, s))
320 return cachep;
321
322 pr_err("%s: Wrong slab cache. %s but object is from %s\n",
Joe Perchesc42e5712014-08-06 16:04:53 -0700323 __func__, cachep->name, s->name);
Glauber Costab9ce5ef2012-12-18 14:22:46 -0800324 WARN_ON_ONCE(1);
325 return s;
326}
Christoph Lameterca349562013-01-10 19:14:19 +0000327
Christoph Lameter44c53562014-08-06 16:04:07 -0700328#ifndef CONFIG_SLOB
Christoph Lameterca349562013-01-10 19:14:19 +0000329/*
330 * The slab lists for all objects.
331 */
332struct kmem_cache_node {
333 spinlock_t list_lock;
334
335#ifdef CONFIG_SLAB
336 struct list_head slabs_partial; /* partial list first, better asm code */
337 struct list_head slabs_full;
338 struct list_head slabs_free;
339 unsigned long free_objects;
340 unsigned int free_limit;
341 unsigned int colour_next; /* Per-node cache coloring */
342 struct array_cache *shared; /* shared per node */
Joonsoo Kimc8522a32014-08-06 16:04:29 -0700343 struct alien_cache **alien; /* on other nodes */
Christoph Lameterca349562013-01-10 19:14:19 +0000344 unsigned long next_reap; /* updated without locking */
345 int free_touched; /* updated without locking */
346#endif
347
348#ifdef CONFIG_SLUB
349 unsigned long nr_partial;
350 struct list_head partial;
351#ifdef CONFIG_SLUB_DEBUG
352 atomic_long_t nr_slabs;
353 atomic_long_t total_objects;
354 struct list_head full;
355#endif
356#endif
357
358};
Wanpeng Lie25839f2013-07-04 08:33:23 +0800359
Christoph Lameter44c53562014-08-06 16:04:07 -0700360static inline struct kmem_cache_node *get_node(struct kmem_cache *s, int node)
361{
362 return s->node[node];
363}
364
365/*
366 * Iterator over all nodes. The body will be executed for each node that has
367 * a kmem_cache_node structure allocated (which is true for all online nodes)
368 */
369#define for_each_kmem_cache_node(__s, __node, __n) \
Mikulas Patocka91635822014-10-09 15:26:20 -0700370 for (__node = 0; __node < nr_node_ids; __node++) \
371 if ((__n = get_node(__s, __node)))
Christoph Lameter44c53562014-08-06 16:04:07 -0700372
373#endif
374
Vladimir Davydov1df3b262014-12-10 15:42:16 -0800375void *slab_start(struct seq_file *m, loff_t *pos);
Wanpeng Li276a2432013-07-08 08:08:28 +0800376void *slab_next(struct seq_file *m, void *p, loff_t *pos);
377void slab_stop(struct seq_file *m, void *p);
Vladimir Davydovb0475012014-12-10 15:44:19 -0800378int memcg_slab_show(struct seq_file *m, void *p);
Andrey Ryabinin5240ab42014-08-06 16:04:14 -0700379
380#endif /* MM_SLAB_H */