Commit | Line | Data |
---|---|---|
97d06609 CL |
1 | #ifndef MM_SLAB_H |
2 | #define MM_SLAB_H | |
3 | /* | |
4 | * Internal slab definitions | |
5 | */ | |
6 | ||
07f361b2 JK |
7 | #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 | */ | |
19 | struct 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 | ||
97d06609 CL |
42 | /* |
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 | */ | |
50 | enum slab_state { | |
51 | DOWN, /* No slab functionality yet */ | |
52 | PARTIAL, /* SLUB: kmem_cache_node available */ | |
ce8eb6c4 | 53 | PARTIAL_NODE, /* SLAB: kmalloc size for node struct available */ |
97d06609 CL |
54 | UP, /* Slab caches usable but not all extras yet */ |
55 | FULL /* Everything is working */ | |
56 | }; | |
57 | ||
58 | extern enum slab_state slab_state; | |
59 | ||
18004c5d CL |
60 | /* The slab cache mutex protects the management structures during changes */ |
61 | extern struct mutex slab_mutex; | |
9b030cb8 CL |
62 | |
63 | /* The list of all slab caches on the system */ | |
18004c5d CL |
64 | extern struct list_head slab_caches; |
65 | ||
9b030cb8 CL |
66 | /* The slab cache that manages slab cache information */ |
67 | extern struct kmem_cache *kmem_cache; | |
68 | ||
45906855 CL |
69 | unsigned long calculate_alignment(unsigned long flags, |
70 | unsigned long align, unsigned long size); | |
71 | ||
f97d5f63 CL |
72 | #ifndef CONFIG_SLOB |
73 | /* Kmalloc array related functions */ | |
34cc6990 | 74 | void setup_kmalloc_cache_index_table(void); |
f97d5f63 | 75 | void create_kmalloc_caches(unsigned long); |
2c59dd65 CL |
76 | |
77 | /* Find the kmalloc slab corresponding for a certain size */ | |
78 | struct kmem_cache *kmalloc_slab(size_t, gfp_t); | |
f97d5f63 CL |
79 | #endif |
80 | ||
81 | ||
9b030cb8 | 82 | /* Functions provided by the slab allocators */ |
8a13a4cc | 83 | extern int __kmem_cache_create(struct kmem_cache *, unsigned long flags); |
97d06609 | 84 | |
45530c44 CL |
85 | extern struct kmem_cache *create_kmalloc_cache(const char *name, size_t size, |
86 | unsigned long flags); | |
87 | extern void create_boot_cache(struct kmem_cache *, const char *name, | |
88 | size_t size, unsigned long flags); | |
89 | ||
423c929c JK |
90 | int slab_unmergeable(struct kmem_cache *s); |
91 | struct kmem_cache *find_mergeable(size_t size, size_t align, | |
92 | unsigned long flags, const char *name, void (*ctor)(void *)); | |
12220dea | 93 | #ifndef CONFIG_SLOB |
2633d7a0 | 94 | struct kmem_cache * |
a44cb944 VD |
95 | __kmem_cache_alias(const char *name, size_t size, size_t align, |
96 | unsigned long flags, void (*ctor)(void *)); | |
423c929c JK |
97 | |
98 | unsigned long kmem_cache_flags(unsigned long object_size, | |
99 | unsigned long flags, const char *name, | |
100 | void (*ctor)(void *)); | |
cbb79694 | 101 | #else |
2633d7a0 | 102 | static inline struct kmem_cache * |
a44cb944 VD |
103 | __kmem_cache_alias(const char *name, size_t size, size_t align, |
104 | unsigned long flags, void (*ctor)(void *)) | |
cbb79694 | 105 | { return NULL; } |
423c929c JK |
106 | |
107 | static inline unsigned long kmem_cache_flags(unsigned long object_size, | |
108 | unsigned long flags, const char *name, | |
109 | void (*ctor)(void *)) | |
110 | { | |
111 | return flags; | |
112 | } | |
cbb79694 CL |
113 | #endif |
114 | ||
115 | ||
d8843922 GC |
116 | /* Legal flag mask for kmem_cache_create(), for various configurations */ |
117 | #define SLAB_CORE_FLAGS (SLAB_HWCACHE_ALIGN | SLAB_CACHE_DMA | SLAB_PANIC | \ | |
118 | SLAB_DESTROY_BY_RCU | SLAB_DEBUG_OBJECTS ) | |
119 | ||
120 | #if defined(CONFIG_DEBUG_SLAB) | |
121 | #define SLAB_DEBUG_FLAGS (SLAB_RED_ZONE | SLAB_POISON | SLAB_STORE_USER) | |
122 | #elif defined(CONFIG_SLUB_DEBUG) | |
123 | #define SLAB_DEBUG_FLAGS (SLAB_RED_ZONE | SLAB_POISON | SLAB_STORE_USER | \ | |
124 | SLAB_TRACE | SLAB_DEBUG_FREE) | |
125 | #else | |
126 | #define SLAB_DEBUG_FLAGS (0) | |
127 | #endif | |
128 | ||
129 | #if defined(CONFIG_SLAB) | |
130 | #define SLAB_CACHE_FLAGS (SLAB_MEM_SPREAD | SLAB_NOLEAKTRACE | \ | |
131 | SLAB_RECLAIM_ACCOUNT | SLAB_TEMPORARY | SLAB_NOTRACK) | |
132 | #elif defined(CONFIG_SLUB) | |
133 | #define SLAB_CACHE_FLAGS (SLAB_NOLEAKTRACE | SLAB_RECLAIM_ACCOUNT | \ | |
134 | SLAB_TEMPORARY | SLAB_NOTRACK) | |
135 | #else | |
136 | #define SLAB_CACHE_FLAGS (0) | |
137 | #endif | |
138 | ||
139 | #define CACHE_CREATE_MASK (SLAB_CORE_FLAGS | SLAB_DEBUG_FLAGS | SLAB_CACHE_FLAGS) | |
140 | ||
945cf2b6 | 141 | int __kmem_cache_shutdown(struct kmem_cache *); |
d6e0b7fa | 142 | int __kmem_cache_shrink(struct kmem_cache *, bool); |
41a21285 | 143 | void slab_kmem_cache_release(struct kmem_cache *); |
945cf2b6 | 144 | |
b7454ad3 GC |
145 | struct seq_file; |
146 | struct file; | |
b7454ad3 | 147 | |
0d7561c6 GC |
148 | struct slabinfo { |
149 | unsigned long active_objs; | |
150 | unsigned long num_objs; | |
151 | unsigned long active_slabs; | |
152 | unsigned long num_slabs; | |
153 | unsigned long shared_avail; | |
154 | unsigned int limit; | |
155 | unsigned int batchcount; | |
156 | unsigned int shared; | |
157 | unsigned int objects_per_slab; | |
158 | unsigned int cache_order; | |
159 | }; | |
160 | ||
161 | void get_slabinfo(struct kmem_cache *s, struct slabinfo *sinfo); | |
162 | void slabinfo_show_stats(struct seq_file *m, struct kmem_cache *s); | |
b7454ad3 GC |
163 | ssize_t slabinfo_write(struct file *file, const char __user *buffer, |
164 | size_t count, loff_t *ppos); | |
ba6c496e | 165 | |
484748f0 CL |
166 | /* |
167 | * Generic implementation of bulk operations | |
168 | * These are useful for situations in which the allocator cannot | |
169 | * perform optimizations. In that case segments of the objecct listed | |
170 | * may be allocated or freed using these operations. | |
171 | */ | |
172 | void __kmem_cache_free_bulk(struct kmem_cache *, size_t, void **); | |
173 | bool __kmem_cache_alloc_bulk(struct kmem_cache *, gfp_t, size_t, void **); | |
174 | ||
ba6c496e | 175 | #ifdef CONFIG_MEMCG_KMEM |
426589f5 VD |
176 | /* |
177 | * Iterate over all memcg caches of the given root cache. The caller must hold | |
178 | * slab_mutex. | |
179 | */ | |
180 | #define for_each_memcg_cache(iter, root) \ | |
181 | list_for_each_entry(iter, &(root)->memcg_params.list, \ | |
182 | memcg_params.list) | |
183 | ||
ba6c496e GC |
184 | static inline bool is_root_cache(struct kmem_cache *s) |
185 | { | |
f7ce3190 | 186 | return s->memcg_params.is_root_cache; |
ba6c496e | 187 | } |
2633d7a0 | 188 | |
b9ce5ef4 | 189 | static inline bool slab_equal_or_root(struct kmem_cache *s, |
f7ce3190 | 190 | struct kmem_cache *p) |
b9ce5ef4 | 191 | { |
f7ce3190 | 192 | return p == s || p == s->memcg_params.root_cache; |
b9ce5ef4 | 193 | } |
749c5415 GC |
194 | |
195 | /* | |
196 | * We use suffixes to the name in memcg because we can't have caches | |
197 | * created in the system with the same name. But when we print them | |
198 | * locally, better refer to them with the base name | |
199 | */ | |
200 | static inline const char *cache_name(struct kmem_cache *s) | |
201 | { | |
202 | if (!is_root_cache(s)) | |
f7ce3190 | 203 | s = s->memcg_params.root_cache; |
749c5415 GC |
204 | return s->name; |
205 | } | |
206 | ||
f8570263 VD |
207 | /* |
208 | * Note, we protect with RCU only the memcg_caches array, not per-memcg caches. | |
f7ce3190 VD |
209 | * That said the caller must assure the memcg's cache won't go away by either |
210 | * taking a css reference to the owner cgroup, or holding the slab_mutex. | |
f8570263 | 211 | */ |
2ade4de8 QH |
212 | static inline struct kmem_cache * |
213 | cache_from_memcg_idx(struct kmem_cache *s, int idx) | |
749c5415 | 214 | { |
959c8963 | 215 | struct kmem_cache *cachep; |
f7ce3190 | 216 | struct memcg_cache_array *arr; |
f8570263 VD |
217 | |
218 | rcu_read_lock(); | |
f7ce3190 | 219 | arr = rcu_dereference(s->memcg_params.memcg_caches); |
959c8963 VD |
220 | |
221 | /* | |
222 | * Make sure we will access the up-to-date value. The code updating | |
223 | * memcg_caches issues a write barrier to match this (see | |
f7ce3190 | 224 | * memcg_create_kmem_cache()). |
959c8963 | 225 | */ |
f7ce3190 | 226 | cachep = lockless_dereference(arr->entries[idx]); |
8df0c2dc PK |
227 | rcu_read_unlock(); |
228 | ||
959c8963 | 229 | return cachep; |
749c5415 | 230 | } |
943a451a GC |
231 | |
232 | static inline struct kmem_cache *memcg_root_cache(struct kmem_cache *s) | |
233 | { | |
234 | if (is_root_cache(s)) | |
235 | return s; | |
f7ce3190 | 236 | return s->memcg_params.root_cache; |
943a451a | 237 | } |
5dfb4175 VD |
238 | |
239 | static __always_inline int memcg_charge_slab(struct kmem_cache *s, | |
240 | gfp_t gfp, int order) | |
241 | { | |
242 | if (!memcg_kmem_enabled()) | |
243 | return 0; | |
244 | if (is_root_cache(s)) | |
245 | return 0; | |
f7ce3190 | 246 | return memcg_charge_kmem(s->memcg_params.memcg, gfp, 1 << order); |
5dfb4175 VD |
247 | } |
248 | ||
249 | static __always_inline void memcg_uncharge_slab(struct kmem_cache *s, int order) | |
250 | { | |
251 | if (!memcg_kmem_enabled()) | |
252 | return; | |
253 | if (is_root_cache(s)) | |
254 | return; | |
f7ce3190 | 255 | memcg_uncharge_kmem(s->memcg_params.memcg, 1 << order); |
5dfb4175 | 256 | } |
f7ce3190 VD |
257 | |
258 | extern void slab_init_memcg_params(struct kmem_cache *); | |
259 | ||
260 | #else /* !CONFIG_MEMCG_KMEM */ | |
261 | ||
426589f5 VD |
262 | #define for_each_memcg_cache(iter, root) \ |
263 | for ((void)(iter), (void)(root); 0; ) | |
426589f5 | 264 | |
ba6c496e GC |
265 | static inline bool is_root_cache(struct kmem_cache *s) |
266 | { | |
267 | return true; | |
268 | } | |
269 | ||
b9ce5ef4 GC |
270 | static inline bool slab_equal_or_root(struct kmem_cache *s, |
271 | struct kmem_cache *p) | |
272 | { | |
273 | return true; | |
274 | } | |
749c5415 GC |
275 | |
276 | static inline const char *cache_name(struct kmem_cache *s) | |
277 | { | |
278 | return s->name; | |
279 | } | |
280 | ||
2ade4de8 QH |
281 | static inline struct kmem_cache * |
282 | cache_from_memcg_idx(struct kmem_cache *s, int idx) | |
749c5415 GC |
283 | { |
284 | return NULL; | |
285 | } | |
943a451a GC |
286 | |
287 | static inline struct kmem_cache *memcg_root_cache(struct kmem_cache *s) | |
288 | { | |
289 | return s; | |
290 | } | |
5dfb4175 VD |
291 | |
292 | static inline int memcg_charge_slab(struct kmem_cache *s, gfp_t gfp, int order) | |
293 | { | |
294 | return 0; | |
295 | } | |
296 | ||
297 | static inline void memcg_uncharge_slab(struct kmem_cache *s, int order) | |
298 | { | |
299 | } | |
f7ce3190 VD |
300 | |
301 | static inline void slab_init_memcg_params(struct kmem_cache *s) | |
302 | { | |
303 | } | |
304 | #endif /* CONFIG_MEMCG_KMEM */ | |
b9ce5ef4 GC |
305 | |
306 | static inline struct kmem_cache *cache_from_obj(struct kmem_cache *s, void *x) | |
307 | { | |
308 | struct kmem_cache *cachep; | |
309 | struct page *page; | |
310 | ||
311 | /* | |
312 | * When kmemcg is not being used, both assignments should return the | |
313 | * same value. but we don't want to pay the assignment price in that | |
314 | * case. If it is not compiled in, the compiler should be smart enough | |
315 | * to not do even the assignment. In that case, slab_equal_or_root | |
316 | * will also be a constant. | |
317 | */ | |
318 | if (!memcg_kmem_enabled() && !unlikely(s->flags & SLAB_DEBUG_FREE)) | |
319 | return s; | |
320 | ||
321 | page = virt_to_head_page(x); | |
322 | cachep = page->slab_cache; | |
323 | if (slab_equal_or_root(cachep, s)) | |
324 | return cachep; | |
325 | ||
326 | pr_err("%s: Wrong slab cache. %s but object is from %s\n", | |
2d16e0fd | 327 | __func__, s->name, cachep->name); |
b9ce5ef4 GC |
328 | WARN_ON_ONCE(1); |
329 | return s; | |
330 | } | |
ca34956b | 331 | |
44c5356f | 332 | #ifndef CONFIG_SLOB |
ca34956b CL |
333 | /* |
334 | * The slab lists for all objects. | |
335 | */ | |
336 | struct kmem_cache_node { | |
337 | spinlock_t list_lock; | |
338 | ||
339 | #ifdef CONFIG_SLAB | |
340 | struct list_head slabs_partial; /* partial list first, better asm code */ | |
341 | struct list_head slabs_full; | |
342 | struct list_head slabs_free; | |
343 | unsigned long free_objects; | |
344 | unsigned int free_limit; | |
345 | unsigned int colour_next; /* Per-node cache coloring */ | |
346 | struct array_cache *shared; /* shared per node */ | |
c8522a3a | 347 | struct alien_cache **alien; /* on other nodes */ |
ca34956b CL |
348 | unsigned long next_reap; /* updated without locking */ |
349 | int free_touched; /* updated without locking */ | |
350 | #endif | |
351 | ||
352 | #ifdef CONFIG_SLUB | |
353 | unsigned long nr_partial; | |
354 | struct list_head partial; | |
355 | #ifdef CONFIG_SLUB_DEBUG | |
356 | atomic_long_t nr_slabs; | |
357 | atomic_long_t total_objects; | |
358 | struct list_head full; | |
359 | #endif | |
360 | #endif | |
361 | ||
362 | }; | |
e25839f6 | 363 | |
44c5356f CL |
364 | static inline struct kmem_cache_node *get_node(struct kmem_cache *s, int node) |
365 | { | |
366 | return s->node[node]; | |
367 | } | |
368 | ||
369 | /* | |
370 | * Iterator over all nodes. The body will be executed for each node that has | |
371 | * a kmem_cache_node structure allocated (which is true for all online nodes) | |
372 | */ | |
373 | #define for_each_kmem_cache_node(__s, __node, __n) \ | |
9163582c MP |
374 | for (__node = 0; __node < nr_node_ids; __node++) \ |
375 | if ((__n = get_node(__s, __node))) | |
44c5356f CL |
376 | |
377 | #endif | |
378 | ||
1df3b26f | 379 | void *slab_start(struct seq_file *m, loff_t *pos); |
276a2439 WL |
380 | void *slab_next(struct seq_file *m, void *p, loff_t *pos); |
381 | void slab_stop(struct seq_file *m, void *p); | |
b047501c | 382 | int memcg_slab_show(struct seq_file *m, void *p); |
5240ab40 AR |
383 | |
384 | #endif /* MM_SLAB_H */ |