blob: ab019e63e3c204d13b36c3957957e4310587d18b [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
Glauber Costa2633d7a2012-12-18 14:22:34 -080089struct mem_cgroup;
Joonsoo Kim423c9292014-10-09 15:26:22 -070090
91int slab_unmergeable(struct kmem_cache *s);
92struct kmem_cache *find_mergeable(size_t size, size_t align,
93 unsigned long flags, const char *name, void (*ctor)(void *));
Joonsoo Kim12220de2014-10-09 15:26:24 -070094#ifndef CONFIG_SLOB
Glauber Costa2633d7a2012-12-18 14:22:34 -080095struct kmem_cache *
Vladimir Davydova44cb942014-04-07 15:39:23 -070096__kmem_cache_alias(const char *name, size_t size, size_t align,
97 unsigned long flags, void (*ctor)(void *));
Joonsoo Kim423c9292014-10-09 15:26:22 -070098
99unsigned long kmem_cache_flags(unsigned long object_size,
100 unsigned long flags, const char *name,
101 void (*ctor)(void *));
Christoph Lametercbb79692012-09-05 00:18:32 +0000102#else
Glauber Costa2633d7a2012-12-18 14:22:34 -0800103static inline struct kmem_cache *
Vladimir Davydova44cb942014-04-07 15:39:23 -0700104__kmem_cache_alias(const char *name, size_t size, size_t align,
105 unsigned long flags, void (*ctor)(void *))
Christoph Lametercbb79692012-09-05 00:18:32 +0000106{ return NULL; }
Joonsoo Kim423c9292014-10-09 15:26:22 -0700107
108static inline unsigned long kmem_cache_flags(unsigned long object_size,
109 unsigned long flags, const char *name,
110 void (*ctor)(void *))
111{
112 return flags;
113}
Christoph Lametercbb79692012-09-05 00:18:32 +0000114#endif
115
116
Glauber Costad8843922012-10-17 15:36:51 +0400117/* Legal flag mask for kmem_cache_create(), for various configurations */
118#define SLAB_CORE_FLAGS (SLAB_HWCACHE_ALIGN | SLAB_CACHE_DMA | SLAB_PANIC | \
119 SLAB_DESTROY_BY_RCU | SLAB_DEBUG_OBJECTS )
120
121#if defined(CONFIG_DEBUG_SLAB)
122#define SLAB_DEBUG_FLAGS (SLAB_RED_ZONE | SLAB_POISON | SLAB_STORE_USER)
123#elif defined(CONFIG_SLUB_DEBUG)
124#define SLAB_DEBUG_FLAGS (SLAB_RED_ZONE | SLAB_POISON | SLAB_STORE_USER | \
125 SLAB_TRACE | SLAB_DEBUG_FREE)
126#else
127#define SLAB_DEBUG_FLAGS (0)
128#endif
129
130#if defined(CONFIG_SLAB)
131#define SLAB_CACHE_FLAGS (SLAB_MEM_SPREAD | SLAB_NOLEAKTRACE | \
132 SLAB_RECLAIM_ACCOUNT | SLAB_TEMPORARY | SLAB_NOTRACK)
133#elif defined(CONFIG_SLUB)
134#define SLAB_CACHE_FLAGS (SLAB_NOLEAKTRACE | SLAB_RECLAIM_ACCOUNT | \
135 SLAB_TEMPORARY | SLAB_NOTRACK)
136#else
137#define SLAB_CACHE_FLAGS (0)
138#endif
139
140#define CACHE_CREATE_MASK (SLAB_CORE_FLAGS | SLAB_DEBUG_FLAGS | SLAB_CACHE_FLAGS)
141
Christoph Lameter945cf2b2012-09-04 23:18:33 +0000142int __kmem_cache_shutdown(struct kmem_cache *);
Vladimir Davydov03afc0e2014-06-04 16:07:20 -0700143int __kmem_cache_shrink(struct kmem_cache *);
Christoph Lameter41a21282014-05-06 12:50:08 -0700144void slab_kmem_cache_release(struct kmem_cache *);
Christoph Lameter945cf2b2012-09-04 23:18:33 +0000145
Glauber Costab7454ad2012-10-19 18:20:25 +0400146struct seq_file;
147struct file;
Glauber Costab7454ad2012-10-19 18:20:25 +0400148
Glauber Costa0d7561c2012-10-19 18:20:27 +0400149struct slabinfo {
150 unsigned long active_objs;
151 unsigned long num_objs;
152 unsigned long active_slabs;
153 unsigned long num_slabs;
154 unsigned long shared_avail;
155 unsigned int limit;
156 unsigned int batchcount;
157 unsigned int shared;
158 unsigned int objects_per_slab;
159 unsigned int cache_order;
160};
161
162void get_slabinfo(struct kmem_cache *s, struct slabinfo *sinfo);
163void slabinfo_show_stats(struct seq_file *m, struct kmem_cache *s);
Glauber Costab7454ad2012-10-19 18:20:25 +0400164ssize_t slabinfo_write(struct file *file, const char __user *buffer,
165 size_t count, loff_t *ppos);
Glauber Costaba6c4962012-12-18 14:22:27 -0800166
167#ifdef CONFIG_MEMCG_KMEM
168static inline bool is_root_cache(struct kmem_cache *s)
169{
170 return !s->memcg_params || s->memcg_params->is_root_cache;
171}
Glauber Costa2633d7a2012-12-18 14:22:34 -0800172
Glauber Costab9ce5ef2012-12-18 14:22:46 -0800173static inline bool slab_equal_or_root(struct kmem_cache *s,
174 struct kmem_cache *p)
175{
176 return (p == s) ||
177 (s->memcg_params && (p == s->memcg_params->root_cache));
178}
Glauber Costa749c5412012-12-18 14:23:01 -0800179
180/*
181 * We use suffixes to the name in memcg because we can't have caches
182 * created in the system with the same name. But when we print them
183 * locally, better refer to them with the base name
184 */
185static inline const char *cache_name(struct kmem_cache *s)
186{
187 if (!is_root_cache(s))
188 return s->memcg_params->root_cache->name;
189 return s->name;
190}
191
Vladimir Davydovf8570262014-01-23 15:53:06 -0800192/*
193 * Note, we protect with RCU only the memcg_caches array, not per-memcg caches.
194 * That said the caller must assure the memcg's cache won't go away. Since once
195 * created a memcg's cache is destroyed only along with the root cache, it is
196 * true if we are going to allocate from the cache or hold a reference to the
197 * root cache by other means. Otherwise, we should hold either the slab_mutex
198 * or the memcg's slab_caches_mutex while calling this function and accessing
199 * the returned value.
200 */
Qiang Huang2ade4de2013-11-12 15:08:23 -0800201static inline struct kmem_cache *
202cache_from_memcg_idx(struct kmem_cache *s, int idx)
Glauber Costa749c5412012-12-18 14:23:01 -0800203{
Vladimir Davydov959c8962014-01-23 15:52:59 -0800204 struct kmem_cache *cachep;
Vladimir Davydovf8570262014-01-23 15:53:06 -0800205 struct memcg_cache_params *params;
Vladimir Davydov959c8962014-01-23 15:52:59 -0800206
Andrey Vagin6f6b8952013-08-28 16:35:20 -0700207 if (!s->memcg_params)
208 return NULL;
Vladimir Davydovf8570262014-01-23 15:53:06 -0800209
210 rcu_read_lock();
211 params = rcu_dereference(s->memcg_params);
212 cachep = params->memcg_caches[idx];
213 rcu_read_unlock();
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
218 * memcg_register_cache()).
219 */
220 smp_read_barrier_depends();
221 return cachep;
Glauber Costa749c5412012-12-18 14:23:01 -0800222}
Glauber Costa943a4512012-12-18 14:23:03 -0800223
224static inline struct kmem_cache *memcg_root_cache(struct kmem_cache *s)
225{
226 if (is_root_cache(s))
227 return s;
228 return s->memcg_params->root_cache;
229}
Vladimir Davydov5dfb4172014-06-04 16:06:38 -0700230
231static __always_inline int memcg_charge_slab(struct kmem_cache *s,
232 gfp_t gfp, int order)
233{
234 if (!memcg_kmem_enabled())
235 return 0;
236 if (is_root_cache(s))
237 return 0;
Vladimir Davydovc67a8a62014-06-04 16:07:39 -0700238 return __memcg_charge_slab(s, gfp, order);
Vladimir Davydov5dfb4172014-06-04 16:06:38 -0700239}
240
241static __always_inline void memcg_uncharge_slab(struct kmem_cache *s, int order)
242{
243 if (!memcg_kmem_enabled())
244 return;
245 if (is_root_cache(s))
246 return;
Vladimir Davydovc67a8a62014-06-04 16:07:39 -0700247 __memcg_uncharge_slab(s, order);
Vladimir Davydov5dfb4172014-06-04 16:06:38 -0700248}
Glauber Costaba6c4962012-12-18 14:22:27 -0800249#else
250static inline bool is_root_cache(struct kmem_cache *s)
251{
252 return true;
253}
254
Glauber Costab9ce5ef2012-12-18 14:22:46 -0800255static inline bool slab_equal_or_root(struct kmem_cache *s,
256 struct kmem_cache *p)
257{
258 return true;
259}
Glauber Costa749c5412012-12-18 14:23:01 -0800260
261static inline const char *cache_name(struct kmem_cache *s)
262{
263 return s->name;
264}
265
Qiang Huang2ade4de2013-11-12 15:08:23 -0800266static inline struct kmem_cache *
267cache_from_memcg_idx(struct kmem_cache *s, int idx)
Glauber Costa749c5412012-12-18 14:23:01 -0800268{
269 return NULL;
270}
Glauber Costa943a4512012-12-18 14:23:03 -0800271
272static inline struct kmem_cache *memcg_root_cache(struct kmem_cache *s)
273{
274 return s;
275}
Vladimir Davydov5dfb4172014-06-04 16:06:38 -0700276
277static inline int memcg_charge_slab(struct kmem_cache *s, gfp_t gfp, int order)
278{
279 return 0;
280}
281
282static inline void memcg_uncharge_slab(struct kmem_cache *s, int order)
283{
284}
Glauber Costaba6c4962012-12-18 14:22:27 -0800285#endif
Glauber Costab9ce5ef2012-12-18 14:22:46 -0800286
287static inline struct kmem_cache *cache_from_obj(struct kmem_cache *s, void *x)
288{
289 struct kmem_cache *cachep;
290 struct page *page;
291
292 /*
293 * When kmemcg is not being used, both assignments should return the
294 * same value. but we don't want to pay the assignment price in that
295 * case. If it is not compiled in, the compiler should be smart enough
296 * to not do even the assignment. In that case, slab_equal_or_root
297 * will also be a constant.
298 */
299 if (!memcg_kmem_enabled() && !unlikely(s->flags & SLAB_DEBUG_FREE))
300 return s;
301
302 page = virt_to_head_page(x);
303 cachep = page->slab_cache;
304 if (slab_equal_or_root(cachep, s))
305 return cachep;
306
307 pr_err("%s: Wrong slab cache. %s but object is from %s\n",
Joe Perchesc42e5712014-08-06 16:04:53 -0700308 __func__, cachep->name, s->name);
Glauber Costab9ce5ef2012-12-18 14:22:46 -0800309 WARN_ON_ONCE(1);
310 return s;
311}
Christoph Lameterca349562013-01-10 19:14:19 +0000312
Christoph Lameter44c53562014-08-06 16:04:07 -0700313#ifndef CONFIG_SLOB
Christoph Lameterca349562013-01-10 19:14:19 +0000314/*
315 * The slab lists for all objects.
316 */
317struct kmem_cache_node {
318 spinlock_t list_lock;
319
320#ifdef CONFIG_SLAB
321 struct list_head slabs_partial; /* partial list first, better asm code */
322 struct list_head slabs_full;
323 struct list_head slabs_free;
324 unsigned long free_objects;
325 unsigned int free_limit;
326 unsigned int colour_next; /* Per-node cache coloring */
327 struct array_cache *shared; /* shared per node */
Joonsoo Kimc8522a32014-08-06 16:04:29 -0700328 struct alien_cache **alien; /* on other nodes */
Christoph Lameterca349562013-01-10 19:14:19 +0000329 unsigned long next_reap; /* updated without locking */
330 int free_touched; /* updated without locking */
331#endif
332
333#ifdef CONFIG_SLUB
334 unsigned long nr_partial;
335 struct list_head partial;
336#ifdef CONFIG_SLUB_DEBUG
337 atomic_long_t nr_slabs;
338 atomic_long_t total_objects;
339 struct list_head full;
340#endif
341#endif
342
343};
Wanpeng Lie25839f2013-07-04 08:33:23 +0800344
Christoph Lameter44c53562014-08-06 16:04:07 -0700345static inline struct kmem_cache_node *get_node(struct kmem_cache *s, int node)
346{
347 return s->node[node];
348}
349
350/*
351 * Iterator over all nodes. The body will be executed for each node that has
352 * a kmem_cache_node structure allocated (which is true for all online nodes)
353 */
354#define for_each_kmem_cache_node(__s, __node, __n) \
Mikulas Patocka91635822014-10-09 15:26:20 -0700355 for (__node = 0; __node < nr_node_ids; __node++) \
356 if ((__n = get_node(__s, __node)))
Christoph Lameter44c53562014-08-06 16:04:07 -0700357
358#endif
359
Wanpeng Li276a2432013-07-08 08:08:28 +0800360void *slab_next(struct seq_file *m, void *p, loff_t *pos);
361void slab_stop(struct seq_file *m, void *p);
Andrey Ryabinin5240ab42014-08-06 16:04:14 -0700362
363#endif /* MM_SLAB_H */