]> asedeno.scripts.mit.edu Git - linux.git/blob - mm/slab.h
mm, slab: extend slab/shrink to shrink all memcg caches
[linux.git] / mm / slab.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef MM_SLAB_H
3 #define MM_SLAB_H
4 /*
5  * Internal slab definitions
6  */
7
8 #ifdef CONFIG_SLOB
9 /*
10  * Common fields provided in kmem_cache by all slab allocators
11  * This struct is either used directly by the allocator (SLOB)
12  * or the allocator must include definitions for all fields
13  * provided in kmem_cache_common in their definition of kmem_cache.
14  *
15  * Once we can do anonymous structs (C11 standard) we could put a
16  * anonymous struct definition in these allocators so that the
17  * separate allocations in the kmem_cache structure of SLAB and
18  * SLUB is no longer needed.
19  */
20 struct kmem_cache {
21         unsigned int object_size;/* The original size of the object */
22         unsigned int size;      /* The aligned/padded/added on size  */
23         unsigned int align;     /* Alignment as calculated */
24         slab_flags_t flags;     /* Active flags on the slab */
25         unsigned int useroffset;/* Usercopy region offset */
26         unsigned int usersize;  /* Usercopy region size */
27         const char *name;       /* Slab name for sysfs */
28         int refcount;           /* Use counter */
29         void (*ctor)(void *);   /* Called on object slot creation */
30         struct list_head list;  /* List of all slab caches on the system */
31 };
32
33 #endif /* CONFIG_SLOB */
34
35 #ifdef CONFIG_SLAB
36 #include <linux/slab_def.h>
37 #endif
38
39 #ifdef CONFIG_SLUB
40 #include <linux/slub_def.h>
41 #endif
42
43 #include <linux/memcontrol.h>
44 #include <linux/fault-inject.h>
45 #include <linux/kasan.h>
46 #include <linux/kmemleak.h>
47 #include <linux/random.h>
48 #include <linux/sched/mm.h>
49
50 /*
51  * State of the slab allocator.
52  *
53  * This is used to describe the states of the allocator during bootup.
54  * Allocators use this to gradually bootstrap themselves. Most allocators
55  * have the problem that the structures used for managing slab caches are
56  * allocated from slab caches themselves.
57  */
58 enum slab_state {
59         DOWN,                   /* No slab functionality yet */
60         PARTIAL,                /* SLUB: kmem_cache_node available */
61         PARTIAL_NODE,           /* SLAB: kmalloc size for node struct available */
62         UP,                     /* Slab caches usable but not all extras yet */
63         FULL                    /* Everything is working */
64 };
65
66 extern enum slab_state slab_state;
67
68 /* The slab cache mutex protects the management structures during changes */
69 extern struct mutex slab_mutex;
70
71 /* The list of all slab caches on the system */
72 extern struct list_head slab_caches;
73
74 /* The slab cache that manages slab cache information */
75 extern struct kmem_cache *kmem_cache;
76
77 /* A table of kmalloc cache names and sizes */
78 extern const struct kmalloc_info_struct {
79         const char *name;
80         unsigned int size;
81 } kmalloc_info[];
82
83 #ifndef CONFIG_SLOB
84 /* Kmalloc array related functions */
85 void setup_kmalloc_cache_index_table(void);
86 void create_kmalloc_caches(slab_flags_t);
87
88 /* Find the kmalloc slab corresponding for a certain size */
89 struct kmem_cache *kmalloc_slab(size_t, gfp_t);
90 #endif
91
92
93 /* Functions provided by the slab allocators */
94 int __kmem_cache_create(struct kmem_cache *, slab_flags_t flags);
95
96 struct kmem_cache *create_kmalloc_cache(const char *name, unsigned int size,
97                         slab_flags_t flags, unsigned int useroffset,
98                         unsigned int usersize);
99 extern void create_boot_cache(struct kmem_cache *, const char *name,
100                         unsigned int size, slab_flags_t flags,
101                         unsigned int useroffset, unsigned int usersize);
102
103 int slab_unmergeable(struct kmem_cache *s);
104 struct kmem_cache *find_mergeable(unsigned size, unsigned align,
105                 slab_flags_t flags, const char *name, void (*ctor)(void *));
106 #ifndef CONFIG_SLOB
107 struct kmem_cache *
108 __kmem_cache_alias(const char *name, unsigned int size, unsigned int align,
109                    slab_flags_t flags, void (*ctor)(void *));
110
111 slab_flags_t kmem_cache_flags(unsigned int object_size,
112         slab_flags_t flags, const char *name,
113         void (*ctor)(void *));
114 #else
115 static inline struct kmem_cache *
116 __kmem_cache_alias(const char *name, unsigned int size, unsigned int align,
117                    slab_flags_t flags, void (*ctor)(void *))
118 { return NULL; }
119
120 static inline slab_flags_t kmem_cache_flags(unsigned int object_size,
121         slab_flags_t flags, const char *name,
122         void (*ctor)(void *))
123 {
124         return flags;
125 }
126 #endif
127
128
129 /* Legal flag mask for kmem_cache_create(), for various configurations */
130 #define SLAB_CORE_FLAGS (SLAB_HWCACHE_ALIGN | SLAB_CACHE_DMA | \
131                          SLAB_CACHE_DMA32 | SLAB_PANIC | \
132                          SLAB_TYPESAFE_BY_RCU | SLAB_DEBUG_OBJECTS )
133
134 #if defined(CONFIG_DEBUG_SLAB)
135 #define SLAB_DEBUG_FLAGS (SLAB_RED_ZONE | SLAB_POISON | SLAB_STORE_USER)
136 #elif defined(CONFIG_SLUB_DEBUG)
137 #define SLAB_DEBUG_FLAGS (SLAB_RED_ZONE | SLAB_POISON | SLAB_STORE_USER | \
138                           SLAB_TRACE | SLAB_CONSISTENCY_CHECKS)
139 #else
140 #define SLAB_DEBUG_FLAGS (0)
141 #endif
142
143 #if defined(CONFIG_SLAB)
144 #define SLAB_CACHE_FLAGS (SLAB_MEM_SPREAD | SLAB_NOLEAKTRACE | \
145                           SLAB_RECLAIM_ACCOUNT | SLAB_TEMPORARY | \
146                           SLAB_ACCOUNT)
147 #elif defined(CONFIG_SLUB)
148 #define SLAB_CACHE_FLAGS (SLAB_NOLEAKTRACE | SLAB_RECLAIM_ACCOUNT | \
149                           SLAB_TEMPORARY | SLAB_ACCOUNT)
150 #else
151 #define SLAB_CACHE_FLAGS (0)
152 #endif
153
154 /* Common flags available with current configuration */
155 #define CACHE_CREATE_MASK (SLAB_CORE_FLAGS | SLAB_DEBUG_FLAGS | SLAB_CACHE_FLAGS)
156
157 /* Common flags permitted for kmem_cache_create */
158 #define SLAB_FLAGS_PERMITTED (SLAB_CORE_FLAGS | \
159                               SLAB_RED_ZONE | \
160                               SLAB_POISON | \
161                               SLAB_STORE_USER | \
162                               SLAB_TRACE | \
163                               SLAB_CONSISTENCY_CHECKS | \
164                               SLAB_MEM_SPREAD | \
165                               SLAB_NOLEAKTRACE | \
166                               SLAB_RECLAIM_ACCOUNT | \
167                               SLAB_TEMPORARY | \
168                               SLAB_ACCOUNT)
169
170 bool __kmem_cache_empty(struct kmem_cache *);
171 int __kmem_cache_shutdown(struct kmem_cache *);
172 void __kmem_cache_release(struct kmem_cache *);
173 int __kmem_cache_shrink(struct kmem_cache *);
174 void __kmemcg_cache_deactivate(struct kmem_cache *s);
175 void __kmemcg_cache_deactivate_after_rcu(struct kmem_cache *s);
176 void slab_kmem_cache_release(struct kmem_cache *);
177 void kmem_cache_shrink_all(struct kmem_cache *s);
178
179 struct seq_file;
180 struct file;
181
182 struct slabinfo {
183         unsigned long active_objs;
184         unsigned long num_objs;
185         unsigned long active_slabs;
186         unsigned long num_slabs;
187         unsigned long shared_avail;
188         unsigned int limit;
189         unsigned int batchcount;
190         unsigned int shared;
191         unsigned int objects_per_slab;
192         unsigned int cache_order;
193 };
194
195 void get_slabinfo(struct kmem_cache *s, struct slabinfo *sinfo);
196 void slabinfo_show_stats(struct seq_file *m, struct kmem_cache *s);
197 ssize_t slabinfo_write(struct file *file, const char __user *buffer,
198                        size_t count, loff_t *ppos);
199
200 /*
201  * Generic implementation of bulk operations
202  * These are useful for situations in which the allocator cannot
203  * perform optimizations. In that case segments of the object listed
204  * may be allocated or freed using these operations.
205  */
206 void __kmem_cache_free_bulk(struct kmem_cache *, size_t, void **);
207 int __kmem_cache_alloc_bulk(struct kmem_cache *, gfp_t, size_t, void **);
208
209 static inline int cache_vmstat_idx(struct kmem_cache *s)
210 {
211         return (s->flags & SLAB_RECLAIM_ACCOUNT) ?
212                 NR_SLAB_RECLAIMABLE : NR_SLAB_UNRECLAIMABLE;
213 }
214
215 #ifdef CONFIG_MEMCG_KMEM
216
217 /* List of all root caches. */
218 extern struct list_head         slab_root_caches;
219 #define root_caches_node        memcg_params.__root_caches_node
220
221 /*
222  * Iterate over all memcg caches of the given root cache. The caller must hold
223  * slab_mutex.
224  */
225 #define for_each_memcg_cache(iter, root) \
226         list_for_each_entry(iter, &(root)->memcg_params.children, \
227                             memcg_params.children_node)
228
229 static inline bool is_root_cache(struct kmem_cache *s)
230 {
231         return !s->memcg_params.root_cache;
232 }
233
234 static inline bool slab_equal_or_root(struct kmem_cache *s,
235                                       struct kmem_cache *p)
236 {
237         return p == s || p == s->memcg_params.root_cache;
238 }
239
240 /*
241  * We use suffixes to the name in memcg because we can't have caches
242  * created in the system with the same name. But when we print them
243  * locally, better refer to them with the base name
244  */
245 static inline const char *cache_name(struct kmem_cache *s)
246 {
247         if (!is_root_cache(s))
248                 s = s->memcg_params.root_cache;
249         return s->name;
250 }
251
252 static inline struct kmem_cache *memcg_root_cache(struct kmem_cache *s)
253 {
254         if (is_root_cache(s))
255                 return s;
256         return s->memcg_params.root_cache;
257 }
258
259 /*
260  * Expects a pointer to a slab page. Please note, that PageSlab() check
261  * isn't sufficient, as it returns true also for tail compound slab pages,
262  * which do not have slab_cache pointer set.
263  * So this function assumes that the page can pass PageHead() and PageSlab()
264  * checks.
265  *
266  * The kmem_cache can be reparented asynchronously. The caller must ensure
267  * the memcg lifetime, e.g. by taking rcu_read_lock() or cgroup_mutex.
268  */
269 static inline struct mem_cgroup *memcg_from_slab_page(struct page *page)
270 {
271         struct kmem_cache *s;
272
273         s = READ_ONCE(page->slab_cache);
274         if (s && !is_root_cache(s))
275                 return READ_ONCE(s->memcg_params.memcg);
276
277         return NULL;
278 }
279
280 /*
281  * Charge the slab page belonging to the non-root kmem_cache.
282  * Can be called for non-root kmem_caches only.
283  */
284 static __always_inline int memcg_charge_slab(struct page *page,
285                                              gfp_t gfp, int order,
286                                              struct kmem_cache *s)
287 {
288         struct mem_cgroup *memcg;
289         struct lruvec *lruvec;
290         int ret;
291
292         rcu_read_lock();
293         memcg = READ_ONCE(s->memcg_params.memcg);
294         while (memcg && !css_tryget_online(&memcg->css))
295                 memcg = parent_mem_cgroup(memcg);
296         rcu_read_unlock();
297
298         if (unlikely(!memcg || mem_cgroup_is_root(memcg))) {
299                 mod_node_page_state(page_pgdat(page), cache_vmstat_idx(s),
300                                     (1 << order));
301                 percpu_ref_get_many(&s->memcg_params.refcnt, 1 << order);
302                 return 0;
303         }
304
305         ret = memcg_kmem_charge_memcg(page, gfp, order, memcg);
306         if (ret)
307                 goto out;
308
309         lruvec = mem_cgroup_lruvec(page_pgdat(page), memcg);
310         mod_lruvec_state(lruvec, cache_vmstat_idx(s), 1 << order);
311
312         /* transer try_charge() page references to kmem_cache */
313         percpu_ref_get_many(&s->memcg_params.refcnt, 1 << order);
314         css_put_many(&memcg->css, 1 << order);
315 out:
316         css_put(&memcg->css);
317         return ret;
318 }
319
320 /*
321  * Uncharge a slab page belonging to a non-root kmem_cache.
322  * Can be called for non-root kmem_caches only.
323  */
324 static __always_inline void memcg_uncharge_slab(struct page *page, int order,
325                                                 struct kmem_cache *s)
326 {
327         struct mem_cgroup *memcg;
328         struct lruvec *lruvec;
329
330         rcu_read_lock();
331         memcg = READ_ONCE(s->memcg_params.memcg);
332         if (likely(!mem_cgroup_is_root(memcg))) {
333                 lruvec = mem_cgroup_lruvec(page_pgdat(page), memcg);
334                 mod_lruvec_state(lruvec, cache_vmstat_idx(s), -(1 << order));
335                 memcg_kmem_uncharge_memcg(page, order, memcg);
336         } else {
337                 mod_node_page_state(page_pgdat(page), cache_vmstat_idx(s),
338                                     -(1 << order));
339         }
340         rcu_read_unlock();
341
342         percpu_ref_put_many(&s->memcg_params.refcnt, 1 << order);
343 }
344
345 extern void slab_init_memcg_params(struct kmem_cache *);
346 extern void memcg_link_cache(struct kmem_cache *s, struct mem_cgroup *memcg);
347
348 #else /* CONFIG_MEMCG_KMEM */
349
350 /* If !memcg, all caches are root. */
351 #define slab_root_caches        slab_caches
352 #define root_caches_node        list
353
354 #define for_each_memcg_cache(iter, root) \
355         for ((void)(iter), (void)(root); 0; )
356
357 static inline bool is_root_cache(struct kmem_cache *s)
358 {
359         return true;
360 }
361
362 static inline bool slab_equal_or_root(struct kmem_cache *s,
363                                       struct kmem_cache *p)
364 {
365         return s == p;
366 }
367
368 static inline const char *cache_name(struct kmem_cache *s)
369 {
370         return s->name;
371 }
372
373 static inline struct kmem_cache *memcg_root_cache(struct kmem_cache *s)
374 {
375         return s;
376 }
377
378 static inline struct mem_cgroup *memcg_from_slab_page(struct page *page)
379 {
380         return NULL;
381 }
382
383 static inline int memcg_charge_slab(struct page *page, gfp_t gfp, int order,
384                                     struct kmem_cache *s)
385 {
386         return 0;
387 }
388
389 static inline void memcg_uncharge_slab(struct page *page, int order,
390                                        struct kmem_cache *s)
391 {
392 }
393
394 static inline void slab_init_memcg_params(struct kmem_cache *s)
395 {
396 }
397
398 static inline void memcg_link_cache(struct kmem_cache *s,
399                                     struct mem_cgroup *memcg)
400 {
401 }
402
403 #endif /* CONFIG_MEMCG_KMEM */
404
405 static inline struct kmem_cache *virt_to_cache(const void *obj)
406 {
407         struct page *page;
408
409         page = virt_to_head_page(obj);
410         if (WARN_ONCE(!PageSlab(page), "%s: Object is not a Slab page!\n",
411                                         __func__))
412                 return NULL;
413         return page->slab_cache;
414 }
415
416 static __always_inline int charge_slab_page(struct page *page,
417                                             gfp_t gfp, int order,
418                                             struct kmem_cache *s)
419 {
420         if (is_root_cache(s)) {
421                 mod_node_page_state(page_pgdat(page), cache_vmstat_idx(s),
422                                     1 << order);
423                 return 0;
424         }
425
426         return memcg_charge_slab(page, gfp, order, s);
427 }
428
429 static __always_inline void uncharge_slab_page(struct page *page, int order,
430                                                struct kmem_cache *s)
431 {
432         if (is_root_cache(s)) {
433                 mod_node_page_state(page_pgdat(page), cache_vmstat_idx(s),
434                                     -(1 << order));
435                 return;
436         }
437
438         memcg_uncharge_slab(page, order, s);
439 }
440
441 static inline struct kmem_cache *cache_from_obj(struct kmem_cache *s, void *x)
442 {
443         struct kmem_cache *cachep;
444
445         /*
446          * When kmemcg is not being used, both assignments should return the
447          * same value. but we don't want to pay the assignment price in that
448          * case. If it is not compiled in, the compiler should be smart enough
449          * to not do even the assignment. In that case, slab_equal_or_root
450          * will also be a constant.
451          */
452         if (!memcg_kmem_enabled() &&
453             !IS_ENABLED(CONFIG_SLAB_FREELIST_HARDENED) &&
454             !unlikely(s->flags & SLAB_CONSISTENCY_CHECKS))
455                 return s;
456
457         cachep = virt_to_cache(x);
458         WARN_ONCE(cachep && !slab_equal_or_root(cachep, s),
459                   "%s: Wrong slab cache. %s but object is from %s\n",
460                   __func__, s->name, cachep->name);
461         return cachep;
462 }
463
464 static inline size_t slab_ksize(const struct kmem_cache *s)
465 {
466 #ifndef CONFIG_SLUB
467         return s->object_size;
468
469 #else /* CONFIG_SLUB */
470 # ifdef CONFIG_SLUB_DEBUG
471         /*
472          * Debugging requires use of the padding between object
473          * and whatever may come after it.
474          */
475         if (s->flags & (SLAB_RED_ZONE | SLAB_POISON))
476                 return s->object_size;
477 # endif
478         if (s->flags & SLAB_KASAN)
479                 return s->object_size;
480         /*
481          * If we have the need to store the freelist pointer
482          * back there or track user information then we can
483          * only use the space before that information.
484          */
485         if (s->flags & (SLAB_TYPESAFE_BY_RCU | SLAB_STORE_USER))
486                 return s->inuse;
487         /*
488          * Else we can use all the padding etc for the allocation
489          */
490         return s->size;
491 #endif
492 }
493
494 static inline struct kmem_cache *slab_pre_alloc_hook(struct kmem_cache *s,
495                                                      gfp_t flags)
496 {
497         flags &= gfp_allowed_mask;
498
499         fs_reclaim_acquire(flags);
500         fs_reclaim_release(flags);
501
502         might_sleep_if(gfpflags_allow_blocking(flags));
503
504         if (should_failslab(s, flags))
505                 return NULL;
506
507         if (memcg_kmem_enabled() &&
508             ((flags & __GFP_ACCOUNT) || (s->flags & SLAB_ACCOUNT)))
509                 return memcg_kmem_get_cache(s);
510
511         return s;
512 }
513
514 static inline void slab_post_alloc_hook(struct kmem_cache *s, gfp_t flags,
515                                         size_t size, void **p)
516 {
517         size_t i;
518
519         flags &= gfp_allowed_mask;
520         for (i = 0; i < size; i++) {
521                 p[i] = kasan_slab_alloc(s, p[i], flags);
522                 /* As p[i] might get tagged, call kmemleak hook after KASAN. */
523                 kmemleak_alloc_recursive(p[i], s->object_size, 1,
524                                          s->flags, flags);
525         }
526
527         if (memcg_kmem_enabled())
528                 memcg_kmem_put_cache(s);
529 }
530
531 #ifndef CONFIG_SLOB
532 /*
533  * The slab lists for all objects.
534  */
535 struct kmem_cache_node {
536         spinlock_t list_lock;
537
538 #ifdef CONFIG_SLAB
539         struct list_head slabs_partial; /* partial list first, better asm code */
540         struct list_head slabs_full;
541         struct list_head slabs_free;
542         unsigned long total_slabs;      /* length of all slab lists */
543         unsigned long free_slabs;       /* length of free slab list only */
544         unsigned long free_objects;
545         unsigned int free_limit;
546         unsigned int colour_next;       /* Per-node cache coloring */
547         struct array_cache *shared;     /* shared per node */
548         struct alien_cache **alien;     /* on other nodes */
549         unsigned long next_reap;        /* updated without locking */
550         int free_touched;               /* updated without locking */
551 #endif
552
553 #ifdef CONFIG_SLUB
554         unsigned long nr_partial;
555         struct list_head partial;
556 #ifdef CONFIG_SLUB_DEBUG
557         atomic_long_t nr_slabs;
558         atomic_long_t total_objects;
559         struct list_head full;
560 #endif
561 #endif
562
563 };
564
565 static inline struct kmem_cache_node *get_node(struct kmem_cache *s, int node)
566 {
567         return s->node[node];
568 }
569
570 /*
571  * Iterator over all nodes. The body will be executed for each node that has
572  * a kmem_cache_node structure allocated (which is true for all online nodes)
573  */
574 #define for_each_kmem_cache_node(__s, __node, __n) \
575         for (__node = 0; __node < nr_node_ids; __node++) \
576                  if ((__n = get_node(__s, __node)))
577
578 #endif
579
580 void *slab_start(struct seq_file *m, loff_t *pos);
581 void *slab_next(struct seq_file *m, void *p, loff_t *pos);
582 void slab_stop(struct seq_file *m, void *p);
583 void *memcg_slab_start(struct seq_file *m, loff_t *pos);
584 void *memcg_slab_next(struct seq_file *m, void *p, loff_t *pos);
585 void memcg_slab_stop(struct seq_file *m, void *p);
586 int memcg_slab_show(struct seq_file *m, void *p);
587
588 #if defined(CONFIG_SLAB) || defined(CONFIG_SLUB_DEBUG)
589 void dump_unreclaimable_slab(void);
590 #else
591 static inline void dump_unreclaimable_slab(void)
592 {
593 }
594 #endif
595
596 void ___cache_free(struct kmem_cache *cache, void *x, unsigned long addr);
597
598 #ifdef CONFIG_SLAB_FREELIST_RANDOM
599 int cache_random_seq_create(struct kmem_cache *cachep, unsigned int count,
600                         gfp_t gfp);
601 void cache_random_seq_destroy(struct kmem_cache *cachep);
602 #else
603 static inline int cache_random_seq_create(struct kmem_cache *cachep,
604                                         unsigned int count, gfp_t gfp)
605 {
606         return 0;
607 }
608 static inline void cache_random_seq_destroy(struct kmem_cache *cachep) { }
609 #endif /* CONFIG_SLAB_FREELIST_RANDOM */
610
611 static inline bool slab_want_init_on_alloc(gfp_t flags, struct kmem_cache *c)
612 {
613         if (static_branch_unlikely(&init_on_alloc)) {
614                 if (c->ctor)
615                         return false;
616                 if (c->flags & (SLAB_TYPESAFE_BY_RCU | SLAB_POISON))
617                         return flags & __GFP_ZERO;
618                 return true;
619         }
620         return flags & __GFP_ZERO;
621 }
622
623 static inline bool slab_want_init_on_free(struct kmem_cache *c)
624 {
625         if (static_branch_unlikely(&init_on_free))
626                 return !(c->ctor ||
627                          (c->flags & (SLAB_TYPESAFE_BY_RCU | SLAB_POISON)));
628         return false;
629 }
630
631 #endif /* MM_SLAB_H */