mm/slub, kunit: add a KUnit test for SLUB debugging functionality
[platform/kernel/linux-starfive.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[NR_KMALLOC_TYPES];
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 gfp_t kmalloc_fix_flags(gfp_t flags);
93
94 /* Functions provided by the slab allocators */
95 int __kmem_cache_create(struct kmem_cache *, slab_flags_t flags);
96
97 struct kmem_cache *create_kmalloc_cache(const char *name, unsigned int size,
98                         slab_flags_t flags, unsigned int useroffset,
99                         unsigned int usersize);
100 extern void create_boot_cache(struct kmem_cache *, const char *name,
101                         unsigned int size, slab_flags_t flags,
102                         unsigned int useroffset, unsigned int usersize);
103
104 int slab_unmergeable(struct kmem_cache *s);
105 struct kmem_cache *find_mergeable(unsigned size, unsigned align,
106                 slab_flags_t flags, const char *name, void (*ctor)(void *));
107 #ifndef CONFIG_SLOB
108 struct kmem_cache *
109 __kmem_cache_alias(const char *name, unsigned int size, unsigned int align,
110                    slab_flags_t flags, void (*ctor)(void *));
111
112 slab_flags_t kmem_cache_flags(unsigned int object_size,
113         slab_flags_t flags, const char *name);
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 {
123         return flags;
124 }
125 #endif
126
127
128 /* Legal flag mask for kmem_cache_create(), for various configurations */
129 #define SLAB_CORE_FLAGS (SLAB_HWCACHE_ALIGN | SLAB_CACHE_DMA | \
130                          SLAB_CACHE_DMA32 | SLAB_PANIC | \
131                          SLAB_TYPESAFE_BY_RCU | SLAB_DEBUG_OBJECTS )
132
133 #if defined(CONFIG_DEBUG_SLAB)
134 #define SLAB_DEBUG_FLAGS (SLAB_RED_ZONE | SLAB_POISON | SLAB_STORE_USER)
135 #elif defined(CONFIG_SLUB_DEBUG)
136 #define SLAB_DEBUG_FLAGS (SLAB_RED_ZONE | SLAB_POISON | SLAB_STORE_USER | \
137                           SLAB_TRACE | SLAB_CONSISTENCY_CHECKS)
138 #else
139 #define SLAB_DEBUG_FLAGS (0)
140 #endif
141
142 #if defined(CONFIG_SLAB)
143 #define SLAB_CACHE_FLAGS (SLAB_MEM_SPREAD | SLAB_NOLEAKTRACE | \
144                           SLAB_RECLAIM_ACCOUNT | SLAB_TEMPORARY | \
145                           SLAB_ACCOUNT)
146 #elif defined(CONFIG_SLUB)
147 #define SLAB_CACHE_FLAGS (SLAB_NOLEAKTRACE | SLAB_RECLAIM_ACCOUNT | \
148                           SLAB_TEMPORARY | SLAB_ACCOUNT)
149 #else
150 #define SLAB_CACHE_FLAGS (0)
151 #endif
152
153 /* Common flags available with current configuration */
154 #define CACHE_CREATE_MASK (SLAB_CORE_FLAGS | SLAB_DEBUG_FLAGS | SLAB_CACHE_FLAGS)
155
156 /* Common flags permitted for kmem_cache_create */
157 #define SLAB_FLAGS_PERMITTED (SLAB_CORE_FLAGS | \
158                               SLAB_RED_ZONE | \
159                               SLAB_POISON | \
160                               SLAB_STORE_USER | \
161                               SLAB_TRACE | \
162                               SLAB_CONSISTENCY_CHECKS | \
163                               SLAB_MEM_SPREAD | \
164                               SLAB_NOLEAKTRACE | \
165                               SLAB_RECLAIM_ACCOUNT | \
166                               SLAB_TEMPORARY | \
167                               SLAB_ACCOUNT)
168
169 bool __kmem_cache_empty(struct kmem_cache *);
170 int __kmem_cache_shutdown(struct kmem_cache *);
171 void __kmem_cache_release(struct kmem_cache *);
172 int __kmem_cache_shrink(struct kmem_cache *);
173 void slab_kmem_cache_release(struct kmem_cache *);
174
175 struct seq_file;
176 struct file;
177
178 struct slabinfo {
179         unsigned long active_objs;
180         unsigned long num_objs;
181         unsigned long active_slabs;
182         unsigned long num_slabs;
183         unsigned long shared_avail;
184         unsigned int limit;
185         unsigned int batchcount;
186         unsigned int shared;
187         unsigned int objects_per_slab;
188         unsigned int cache_order;
189 };
190
191 void get_slabinfo(struct kmem_cache *s, struct slabinfo *sinfo);
192 void slabinfo_show_stats(struct seq_file *m, struct kmem_cache *s);
193 ssize_t slabinfo_write(struct file *file, const char __user *buffer,
194                        size_t count, loff_t *ppos);
195
196 /*
197  * Generic implementation of bulk operations
198  * These are useful for situations in which the allocator cannot
199  * perform optimizations. In that case segments of the object listed
200  * may be allocated or freed using these operations.
201  */
202 void __kmem_cache_free_bulk(struct kmem_cache *, size_t, void **);
203 int __kmem_cache_alloc_bulk(struct kmem_cache *, gfp_t, size_t, void **);
204
205 static inline enum node_stat_item cache_vmstat_idx(struct kmem_cache *s)
206 {
207         return (s->flags & SLAB_RECLAIM_ACCOUNT) ?
208                 NR_SLAB_RECLAIMABLE_B : NR_SLAB_UNRECLAIMABLE_B;
209 }
210
211 #ifdef CONFIG_SLUB_DEBUG
212 #ifdef CONFIG_SLUB_DEBUG_ON
213 DECLARE_STATIC_KEY_TRUE(slub_debug_enabled);
214 #else
215 DECLARE_STATIC_KEY_FALSE(slub_debug_enabled);
216 #endif
217 extern void print_tracking(struct kmem_cache *s, void *object);
218 long validate_slab_cache(struct kmem_cache *s);
219 #else
220 static inline void print_tracking(struct kmem_cache *s, void *object)
221 {
222 }
223 #endif
224
225 /*
226  * Returns true if any of the specified slub_debug flags is enabled for the
227  * cache. Use only for flags parsed by setup_slub_debug() as it also enables
228  * the static key.
229  */
230 static inline bool kmem_cache_debug_flags(struct kmem_cache *s, slab_flags_t flags)
231 {
232 #ifdef CONFIG_SLUB_DEBUG
233         VM_WARN_ON_ONCE(!(flags & SLAB_DEBUG_FLAGS));
234         if (static_branch_unlikely(&slub_debug_enabled))
235                 return s->flags & flags;
236 #endif
237         return false;
238 }
239
240 #ifdef CONFIG_MEMCG_KMEM
241 int memcg_alloc_page_obj_cgroups(struct page *page, struct kmem_cache *s,
242                                  gfp_t gfp, bool new_page);
243
244 static inline void memcg_free_page_obj_cgroups(struct page *page)
245 {
246         kfree(page_objcgs(page));
247         page->memcg_data = 0;
248 }
249
250 static inline size_t obj_full_size(struct kmem_cache *s)
251 {
252         /*
253          * For each accounted object there is an extra space which is used
254          * to store obj_cgroup membership. Charge it too.
255          */
256         return s->size + sizeof(struct obj_cgroup *);
257 }
258
259 /*
260  * Returns false if the allocation should fail.
261  */
262 static inline bool memcg_slab_pre_alloc_hook(struct kmem_cache *s,
263                                              struct obj_cgroup **objcgp,
264                                              size_t objects, gfp_t flags)
265 {
266         struct obj_cgroup *objcg;
267
268         if (!memcg_kmem_enabled())
269                 return true;
270
271         if (!(flags & __GFP_ACCOUNT) && !(s->flags & SLAB_ACCOUNT))
272                 return true;
273
274         objcg = get_obj_cgroup_from_current();
275         if (!objcg)
276                 return true;
277
278         if (obj_cgroup_charge(objcg, flags, objects * obj_full_size(s))) {
279                 obj_cgroup_put(objcg);
280                 return false;
281         }
282
283         *objcgp = objcg;
284         return true;
285 }
286
287 static inline void mod_objcg_state(struct obj_cgroup *objcg,
288                                    struct pglist_data *pgdat,
289                                    enum node_stat_item idx, int nr)
290 {
291         struct mem_cgroup *memcg;
292         struct lruvec *lruvec;
293
294         rcu_read_lock();
295         memcg = obj_cgroup_memcg(objcg);
296         lruvec = mem_cgroup_lruvec(memcg, pgdat);
297         mod_memcg_lruvec_state(lruvec, idx, nr);
298         rcu_read_unlock();
299 }
300
301 static inline void memcg_slab_post_alloc_hook(struct kmem_cache *s,
302                                               struct obj_cgroup *objcg,
303                                               gfp_t flags, size_t size,
304                                               void **p)
305 {
306         struct page *page;
307         unsigned long off;
308         size_t i;
309
310         if (!memcg_kmem_enabled() || !objcg)
311                 return;
312
313         flags &= ~__GFP_ACCOUNT;
314         for (i = 0; i < size; i++) {
315                 if (likely(p[i])) {
316                         page = virt_to_head_page(p[i]);
317
318                         if (!page_objcgs(page) &&
319                             memcg_alloc_page_obj_cgroups(page, s, flags,
320                                                          false)) {
321                                 obj_cgroup_uncharge(objcg, obj_full_size(s));
322                                 continue;
323                         }
324
325                         off = obj_to_index(s, page, p[i]);
326                         obj_cgroup_get(objcg);
327                         page_objcgs(page)[off] = objcg;
328                         mod_objcg_state(objcg, page_pgdat(page),
329                                         cache_vmstat_idx(s), obj_full_size(s));
330                 } else {
331                         obj_cgroup_uncharge(objcg, obj_full_size(s));
332                 }
333         }
334         obj_cgroup_put(objcg);
335 }
336
337 static inline void memcg_slab_free_hook(struct kmem_cache *s_orig,
338                                         void **p, int objects)
339 {
340         struct kmem_cache *s;
341         struct obj_cgroup **objcgs;
342         struct obj_cgroup *objcg;
343         struct page *page;
344         unsigned int off;
345         int i;
346
347         if (!memcg_kmem_enabled())
348                 return;
349
350         for (i = 0; i < objects; i++) {
351                 if (unlikely(!p[i]))
352                         continue;
353
354                 page = virt_to_head_page(p[i]);
355                 objcgs = page_objcgs(page);
356                 if (!objcgs)
357                         continue;
358
359                 if (!s_orig)
360                         s = page->slab_cache;
361                 else
362                         s = s_orig;
363
364                 off = obj_to_index(s, page, p[i]);
365                 objcg = objcgs[off];
366                 if (!objcg)
367                         continue;
368
369                 objcgs[off] = NULL;
370                 obj_cgroup_uncharge(objcg, obj_full_size(s));
371                 mod_objcg_state(objcg, page_pgdat(page), cache_vmstat_idx(s),
372                                 -obj_full_size(s));
373                 obj_cgroup_put(objcg);
374         }
375 }
376
377 #else /* CONFIG_MEMCG_KMEM */
378 static inline struct mem_cgroup *memcg_from_slab_obj(void *ptr)
379 {
380         return NULL;
381 }
382
383 static inline int memcg_alloc_page_obj_cgroups(struct page *page,
384                                                struct kmem_cache *s, gfp_t gfp,
385                                                bool new_page)
386 {
387         return 0;
388 }
389
390 static inline void memcg_free_page_obj_cgroups(struct page *page)
391 {
392 }
393
394 static inline bool memcg_slab_pre_alloc_hook(struct kmem_cache *s,
395                                              struct obj_cgroup **objcgp,
396                                              size_t objects, gfp_t flags)
397 {
398         return true;
399 }
400
401 static inline void memcg_slab_post_alloc_hook(struct kmem_cache *s,
402                                               struct obj_cgroup *objcg,
403                                               gfp_t flags, size_t size,
404                                               void **p)
405 {
406 }
407
408 static inline void memcg_slab_free_hook(struct kmem_cache *s,
409                                         void **p, int objects)
410 {
411 }
412 #endif /* CONFIG_MEMCG_KMEM */
413
414 static inline struct kmem_cache *virt_to_cache(const void *obj)
415 {
416         struct page *page;
417
418         page = virt_to_head_page(obj);
419         if (WARN_ONCE(!PageSlab(page), "%s: Object is not a Slab page!\n",
420                                         __func__))
421                 return NULL;
422         return page->slab_cache;
423 }
424
425 static __always_inline void account_slab_page(struct page *page, int order,
426                                               struct kmem_cache *s,
427                                               gfp_t gfp)
428 {
429         if (memcg_kmem_enabled() && (s->flags & SLAB_ACCOUNT))
430                 memcg_alloc_page_obj_cgroups(page, s, gfp, true);
431
432         mod_node_page_state(page_pgdat(page), cache_vmstat_idx(s),
433                             PAGE_SIZE << order);
434 }
435
436 static __always_inline void unaccount_slab_page(struct page *page, int order,
437                                                 struct kmem_cache *s)
438 {
439         if (memcg_kmem_enabled())
440                 memcg_free_page_obj_cgroups(page);
441
442         mod_node_page_state(page_pgdat(page), cache_vmstat_idx(s),
443                             -(PAGE_SIZE << order));
444 }
445
446 static inline struct kmem_cache *cache_from_obj(struct kmem_cache *s, void *x)
447 {
448         struct kmem_cache *cachep;
449
450         if (!IS_ENABLED(CONFIG_SLAB_FREELIST_HARDENED) &&
451             !kmem_cache_debug_flags(s, SLAB_CONSISTENCY_CHECKS))
452                 return s;
453
454         cachep = virt_to_cache(x);
455         if (WARN(cachep && cachep != s,
456                   "%s: Wrong slab cache. %s but object is from %s\n",
457                   __func__, s->name, cachep->name))
458                 print_tracking(cachep, x);
459         return cachep;
460 }
461
462 static inline size_t slab_ksize(const struct kmem_cache *s)
463 {
464 #ifndef CONFIG_SLUB
465         return s->object_size;
466
467 #else /* CONFIG_SLUB */
468 # ifdef CONFIG_SLUB_DEBUG
469         /*
470          * Debugging requires use of the padding between object
471          * and whatever may come after it.
472          */
473         if (s->flags & (SLAB_RED_ZONE | SLAB_POISON))
474                 return s->object_size;
475 # endif
476         if (s->flags & SLAB_KASAN)
477                 return s->object_size;
478         /*
479          * If we have the need to store the freelist pointer
480          * back there or track user information then we can
481          * only use the space before that information.
482          */
483         if (s->flags & (SLAB_TYPESAFE_BY_RCU | SLAB_STORE_USER))
484                 return s->inuse;
485         /*
486          * Else we can use all the padding etc for the allocation
487          */
488         return s->size;
489 #endif
490 }
491
492 static inline struct kmem_cache *slab_pre_alloc_hook(struct kmem_cache *s,
493                                                      struct obj_cgroup **objcgp,
494                                                      size_t size, gfp_t flags)
495 {
496         flags &= gfp_allowed_mask;
497
498         might_alloc(flags);
499
500         if (should_failslab(s, flags))
501                 return NULL;
502
503         if (!memcg_slab_pre_alloc_hook(s, objcgp, size, flags))
504                 return NULL;
505
506         return s;
507 }
508
509 static inline void slab_post_alloc_hook(struct kmem_cache *s,
510                                         struct obj_cgroup *objcg, gfp_t flags,
511                                         size_t size, void **p, bool init)
512 {
513         size_t i;
514
515         flags &= gfp_allowed_mask;
516
517         /*
518          * As memory initialization might be integrated into KASAN,
519          * kasan_slab_alloc and initialization memset must be
520          * kept together to avoid discrepancies in behavior.
521          *
522          * As p[i] might get tagged, memset and kmemleak hook come after KASAN.
523          */
524         for (i = 0; i < size; i++) {
525                 p[i] = kasan_slab_alloc(s, p[i], flags, init);
526                 if (p[i] && init && !kasan_has_integrated_init())
527                         memset(p[i], 0, s->object_size);
528                 kmemleak_alloc_recursive(p[i], s->object_size, 1,
529                                          s->flags, flags);
530         }
531
532         memcg_slab_post_alloc_hook(s, objcg, flags, size, p);
533 }
534
535 #ifndef CONFIG_SLOB
536 /*
537  * The slab lists for all objects.
538  */
539 struct kmem_cache_node {
540         spinlock_t list_lock;
541
542 #ifdef CONFIG_SLAB
543         struct list_head slabs_partial; /* partial list first, better asm code */
544         struct list_head slabs_full;
545         struct list_head slabs_free;
546         unsigned long total_slabs;      /* length of all slab lists */
547         unsigned long free_slabs;       /* length of free slab list only */
548         unsigned long free_objects;
549         unsigned int free_limit;
550         unsigned int colour_next;       /* Per-node cache coloring */
551         struct array_cache *shared;     /* shared per node */
552         struct alien_cache **alien;     /* on other nodes */
553         unsigned long next_reap;        /* updated without locking */
554         int free_touched;               /* updated without locking */
555 #endif
556
557 #ifdef CONFIG_SLUB
558         unsigned long nr_partial;
559         struct list_head partial;
560 #ifdef CONFIG_SLUB_DEBUG
561         atomic_long_t nr_slabs;
562         atomic_long_t total_objects;
563         struct list_head full;
564 #endif
565 #endif
566
567 };
568
569 static inline struct kmem_cache_node *get_node(struct kmem_cache *s, int node)
570 {
571         return s->node[node];
572 }
573
574 /*
575  * Iterator over all nodes. The body will be executed for each node that has
576  * a kmem_cache_node structure allocated (which is true for all online nodes)
577  */
578 #define for_each_kmem_cache_node(__s, __node, __n) \
579         for (__node = 0; __node < nr_node_ids; __node++) \
580                  if ((__n = get_node(__s, __node)))
581
582 #endif
583
584 void *slab_start(struct seq_file *m, loff_t *pos);
585 void *slab_next(struct seq_file *m, void *p, loff_t *pos);
586 void slab_stop(struct seq_file *m, void *p);
587 int memcg_slab_show(struct seq_file *m, void *p);
588
589 #if defined(CONFIG_SLAB) || defined(CONFIG_SLUB_DEBUG)
590 void dump_unreclaimable_slab(void);
591 #else
592 static inline void dump_unreclaimable_slab(void)
593 {
594 }
595 #endif
596
597 void ___cache_free(struct kmem_cache *cache, void *x, unsigned long addr);
598
599 #ifdef CONFIG_SLAB_FREELIST_RANDOM
600 int cache_random_seq_create(struct kmem_cache *cachep, unsigned int count,
601                         gfp_t gfp);
602 void cache_random_seq_destroy(struct kmem_cache *cachep);
603 #else
604 static inline int cache_random_seq_create(struct kmem_cache *cachep,
605                                         unsigned int count, gfp_t gfp)
606 {
607         return 0;
608 }
609 static inline void cache_random_seq_destroy(struct kmem_cache *cachep) { }
610 #endif /* CONFIG_SLAB_FREELIST_RANDOM */
611
612 static inline bool slab_want_init_on_alloc(gfp_t flags, struct kmem_cache *c)
613 {
614         if (static_branch_maybe(CONFIG_INIT_ON_ALLOC_DEFAULT_ON,
615                                 &init_on_alloc)) {
616                 if (c->ctor)
617                         return false;
618                 if (c->flags & (SLAB_TYPESAFE_BY_RCU | SLAB_POISON))
619                         return flags & __GFP_ZERO;
620                 return true;
621         }
622         return flags & __GFP_ZERO;
623 }
624
625 static inline bool slab_want_init_on_free(struct kmem_cache *c)
626 {
627         if (static_branch_maybe(CONFIG_INIT_ON_FREE_DEFAULT_ON,
628                                 &init_on_free))
629                 return !(c->ctor ||
630                          (c->flags & (SLAB_TYPESAFE_BY_RCU | SLAB_POISON)));
631         return false;
632 }
633
634 #ifdef CONFIG_PRINTK
635 #define KS_ADDRS_COUNT 16
636 struct kmem_obj_info {
637         void *kp_ptr;
638         struct page *kp_page;
639         void *kp_objp;
640         unsigned long kp_data_offset;
641         struct kmem_cache *kp_slab_cache;
642         void *kp_ret;
643         void *kp_stack[KS_ADDRS_COUNT];
644 };
645 void kmem_obj_info(struct kmem_obj_info *kpp, void *object, struct page *page);
646 #endif
647
648 #endif /* MM_SLAB_H */