1
2#ifndef MM_SLAB_H
3#define MM_SLAB_H
4
5
6
7
8#ifdef CONFIG_SLOB
9
10
11
12
13
14
15
16
17
18
19
20struct kmem_cache {
21 unsigned int object_size;
22 unsigned int size;
23 unsigned int align;
24 slab_flags_t flags;
25 unsigned int useroffset;
26 unsigned int usersize;
27 const char *name;
28 int refcount;
29 void (*ctor)(void *);
30 struct list_head list;
31};
32
33#endif
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
52
53
54
55
56
57
58enum slab_state {
59 DOWN,
60 PARTIAL,
61 PARTIAL_NODE,
62 UP,
63 FULL
64};
65
66extern enum slab_state slab_state;
67
68
69extern struct mutex slab_mutex;
70
71
72extern struct list_head slab_caches;
73
74
75extern struct kmem_cache *kmem_cache;
76
77
78extern const struct kmalloc_info_struct {
79 const char *name;
80 unsigned int size;
81} kmalloc_info[];
82
83#ifndef CONFIG_SLOB
84
85void setup_kmalloc_cache_index_table(void);
86void create_kmalloc_caches(slab_flags_t);
87
88
89struct kmem_cache *kmalloc_slab(size_t, gfp_t);
90#endif
91
92
93
94int __kmem_cache_create(struct kmem_cache *, slab_flags_t flags);
95
96struct kmem_cache *create_kmalloc_cache(const char *name, unsigned int size,
97 slab_flags_t flags, unsigned int useroffset,
98 unsigned int usersize);
99extern 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
103int slab_unmergeable(struct kmem_cache *s);
104struct kmem_cache *find_mergeable(unsigned size, unsigned align,
105 slab_flags_t flags, const char *name, void (*ctor)(void *));
106#ifndef CONFIG_SLOB
107struct kmem_cache *
108__kmem_cache_alias(const char *name, unsigned int size, unsigned int align,
109 slab_flags_t flags, void (*ctor)(void *));
110
111slab_flags_t kmem_cache_flags(unsigned int object_size,
112 slab_flags_t flags, const char *name,
113 void (*ctor)(void *));
114#else
115static 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
120static 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
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
155#define CACHE_CREATE_MASK (SLAB_CORE_FLAGS | SLAB_DEBUG_FLAGS | SLAB_CACHE_FLAGS)
156
157
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
170bool __kmem_cache_empty(struct kmem_cache *);
171int __kmem_cache_shutdown(struct kmem_cache *);
172void __kmem_cache_release(struct kmem_cache *);
173int __kmem_cache_shrink(struct kmem_cache *);
174void __kmemcg_cache_deactivate(struct kmem_cache *s);
175void __kmemcg_cache_deactivate_after_rcu(struct kmem_cache *s);
176void slab_kmem_cache_release(struct kmem_cache *);
177
178struct seq_file;
179struct file;
180
181struct slabinfo {
182 unsigned long active_objs;
183 unsigned long num_objs;
184 unsigned long active_slabs;
185 unsigned long num_slabs;
186 unsigned long shared_avail;
187 unsigned int limit;
188 unsigned int batchcount;
189 unsigned int shared;
190 unsigned int objects_per_slab;
191 unsigned int cache_order;
192};
193
194void get_slabinfo(struct kmem_cache *s, struct slabinfo *sinfo);
195void slabinfo_show_stats(struct seq_file *m, struct kmem_cache *s);
196ssize_t slabinfo_write(struct file *file, const char __user *buffer,
197 size_t count, loff_t *ppos);
198
199
200
201
202
203
204
205void __kmem_cache_free_bulk(struct kmem_cache *, size_t, void **);
206int __kmem_cache_alloc_bulk(struct kmem_cache *, gfp_t, size_t, void **);
207
208static inline int cache_vmstat_idx(struct kmem_cache *s)
209{
210 return (s->flags & SLAB_RECLAIM_ACCOUNT) ?
211 NR_SLAB_RECLAIMABLE : NR_SLAB_UNRECLAIMABLE;
212}
213
214#ifdef CONFIG_MEMCG_KMEM
215
216
217extern struct list_head slab_root_caches;
218#define root_caches_node memcg_params.__root_caches_node
219
220
221
222
223
224#define for_each_memcg_cache(iter, root) \
225 list_for_each_entry(iter, &(root)->memcg_params.children, \
226 memcg_params.children_node)
227
228static inline bool is_root_cache(struct kmem_cache *s)
229{
230 return !s->memcg_params.root_cache;
231}
232
233static inline bool slab_equal_or_root(struct kmem_cache *s,
234 struct kmem_cache *p)
235{
236 return p == s || p == s->memcg_params.root_cache;
237}
238
239
240
241
242
243
244static inline const char *cache_name(struct kmem_cache *s)
245{
246 if (!is_root_cache(s))
247 s = s->memcg_params.root_cache;
248 return s->name;
249}
250
251static inline struct kmem_cache *memcg_root_cache(struct kmem_cache *s)
252{
253 if (is_root_cache(s))
254 return s;
255 return s->memcg_params.root_cache;
256}
257
258
259
260
261
262
263
264
265
266
267
268static inline struct mem_cgroup *memcg_from_slab_page(struct page *page)
269{
270 struct kmem_cache *s;
271
272 s = READ_ONCE(page->slab_cache);
273 if (s && !is_root_cache(s))
274 return READ_ONCE(s->memcg_params.memcg);
275
276 return NULL;
277}
278
279
280
281
282
283static __always_inline int memcg_charge_slab(struct page *page,
284 gfp_t gfp, int order,
285 struct kmem_cache *s)
286{
287 struct mem_cgroup *memcg;
288 struct lruvec *lruvec;
289 int ret;
290
291 rcu_read_lock();
292 memcg = READ_ONCE(s->memcg_params.memcg);
293 while (memcg && !css_tryget_online(&memcg->css))
294 memcg = parent_mem_cgroup(memcg);
295 rcu_read_unlock();
296
297 if (unlikely(!memcg || mem_cgroup_is_root(memcg))) {
298 mod_node_page_state(page_pgdat(page), cache_vmstat_idx(s),
299 (1 << order));
300 percpu_ref_get_many(&s->memcg_params.refcnt, 1 << order);
301 return 0;
302 }
303
304 ret = memcg_kmem_charge_memcg(page, gfp, order, memcg);
305 if (ret)
306 goto out;
307
308 lruvec = mem_cgroup_lruvec(page_pgdat(page), memcg);
309 mod_lruvec_state(lruvec, cache_vmstat_idx(s), 1 << order);
310
311
312 percpu_ref_get_many(&s->memcg_params.refcnt, 1 << order);
313 css_put_many(&memcg->css, 1 << order);
314out:
315 css_put(&memcg->css);
316 return ret;
317}
318
319
320
321
322
323static __always_inline void memcg_uncharge_slab(struct page *page, int order,
324 struct kmem_cache *s)
325{
326 struct mem_cgroup *memcg;
327 struct lruvec *lruvec;
328
329 rcu_read_lock();
330 memcg = READ_ONCE(s->memcg_params.memcg);
331 if (likely(!mem_cgroup_is_root(memcg))) {
332 lruvec = mem_cgroup_lruvec(page_pgdat(page), memcg);
333 mod_lruvec_state(lruvec, cache_vmstat_idx(s), -(1 << order));
334 memcg_kmem_uncharge_memcg(page, order, memcg);
335 } else {
336 mod_node_page_state(page_pgdat(page), cache_vmstat_idx(s),
337 -(1 << order));
338 }
339 rcu_read_unlock();
340
341 percpu_ref_put_many(&s->memcg_params.refcnt, 1 << order);
342}
343
344extern void slab_init_memcg_params(struct kmem_cache *);
345extern void memcg_link_cache(struct kmem_cache *s, struct mem_cgroup *memcg);
346
347#else
348
349
350#define slab_root_caches slab_caches
351#define root_caches_node list
352
353#define for_each_memcg_cache(iter, root) \
354 for ((void)(iter), (void)(root); 0; )
355
356static inline bool is_root_cache(struct kmem_cache *s)
357{
358 return true;
359}
360
361static inline bool slab_equal_or_root(struct kmem_cache *s,
362 struct kmem_cache *p)
363{
364 return s == p;
365}
366
367static inline const char *cache_name(struct kmem_cache *s)
368{
369 return s->name;
370}
371
372static inline struct kmem_cache *memcg_root_cache(struct kmem_cache *s)
373{
374 return s;
375}
376
377static inline struct mem_cgroup *memcg_from_slab_page(struct page *page)
378{
379 return NULL;
380}
381
382static inline int memcg_charge_slab(struct page *page, gfp_t gfp, int order,
383 struct kmem_cache *s)
384{
385 return 0;
386}
387
388static inline void memcg_uncharge_slab(struct page *page, int order,
389 struct kmem_cache *s)
390{
391}
392
393static inline void slab_init_memcg_params(struct kmem_cache *s)
394{
395}
396
397static inline void memcg_link_cache(struct kmem_cache *s,
398 struct mem_cgroup *memcg)
399{
400}
401
402#endif
403
404static inline struct kmem_cache *virt_to_cache(const void *obj)
405{
406 struct page *page;
407
408 page = virt_to_head_page(obj);
409 if (WARN_ONCE(!PageSlab(page), "%s: Object is not a Slab page!\n",
410 __func__))
411 return NULL;
412 return page->slab_cache;
413}
414
415static __always_inline int charge_slab_page(struct page *page,
416 gfp_t gfp, int order,
417 struct kmem_cache *s)
418{
419 if (is_root_cache(s)) {
420 mod_node_page_state(page_pgdat(page), cache_vmstat_idx(s),
421 1 << order);
422 return 0;
423 }
424
425 return memcg_charge_slab(page, gfp, order, s);
426}
427
428static __always_inline void uncharge_slab_page(struct page *page, int order,
429 struct kmem_cache *s)
430{
431 if (is_root_cache(s)) {
432 mod_node_page_state(page_pgdat(page), cache_vmstat_idx(s),
433 -(1 << order));
434 return;
435 }
436
437 memcg_uncharge_slab(page, order, s);
438}
439
440static inline struct kmem_cache *cache_from_obj(struct kmem_cache *s, void *x)
441{
442 struct kmem_cache *cachep;
443
444
445
446
447
448
449
450
451 if (!memcg_kmem_enabled() &&
452 !IS_ENABLED(CONFIG_SLAB_FREELIST_HARDENED) &&
453 !unlikely(s->flags & SLAB_CONSISTENCY_CHECKS))
454 return s;
455
456 cachep = virt_to_cache(x);
457 WARN_ONCE(cachep && !slab_equal_or_root(cachep, s),
458 "%s: Wrong slab cache. %s but object is from %s\n",
459 __func__, s->name, cachep->name);
460 return cachep;
461}
462
463static inline size_t slab_ksize(const struct kmem_cache *s)
464{
465#ifndef CONFIG_SLUB
466 return s->object_size;
467
468#else
469# ifdef CONFIG_SLUB_DEBUG
470
471
472
473
474 if (s->flags & (SLAB_RED_ZONE | SLAB_POISON))
475 return s->object_size;
476# endif
477 if (s->flags & SLAB_KASAN)
478 return s->object_size;
479
480
481
482
483
484 if (s->flags & (SLAB_TYPESAFE_BY_RCU | SLAB_STORE_USER))
485 return s->inuse;
486
487
488
489 return s->size;
490#endif
491}
492
493static inline struct kmem_cache *slab_pre_alloc_hook(struct kmem_cache *s,
494 gfp_t flags)
495{
496 flags &= gfp_allowed_mask;
497
498 fs_reclaim_acquire(flags);
499 fs_reclaim_release(flags);
500
501 might_sleep_if(gfpflags_allow_blocking(flags));
502
503 if (should_failslab(s, flags))
504 return NULL;
505
506 if (memcg_kmem_enabled() &&
507 ((flags & __GFP_ACCOUNT) || (s->flags & SLAB_ACCOUNT)))
508 return memcg_kmem_get_cache(s);
509
510 return s;
511}
512
513static inline void slab_post_alloc_hook(struct kmem_cache *s, gfp_t flags,
514 size_t size, void **p)
515{
516 size_t i;
517
518 flags &= gfp_allowed_mask;
519 for (i = 0; i < size; i++) {
520 p[i] = kasan_slab_alloc(s, p[i], flags);
521
522 kmemleak_alloc_recursive(p[i], s->object_size, 1,
523 s->flags, flags);
524 }
525
526 if (memcg_kmem_enabled())
527 memcg_kmem_put_cache(s);
528}
529
530#ifndef CONFIG_SLOB
531
532
533
534struct kmem_cache_node {
535 spinlock_t list_lock;
536
537#ifdef CONFIG_SLAB
538 struct list_head slabs_partial;
539 struct list_head slabs_full;
540 struct list_head slabs_free;
541 unsigned long total_slabs;
542 unsigned long free_slabs;
543 unsigned long free_objects;
544 unsigned int free_limit;
545 unsigned int colour_next;
546 struct array_cache *shared;
547 struct alien_cache **alien;
548 unsigned long next_reap;
549 int free_touched;
550#endif
551
552#ifdef CONFIG_SLUB
553 unsigned long nr_partial;
554 struct list_head partial;
555#ifdef CONFIG_SLUB_DEBUG
556 atomic_long_t nr_slabs;
557 atomic_long_t total_objects;
558 struct list_head full;
559#endif
560#endif
561
562};
563
564static inline struct kmem_cache_node *get_node(struct kmem_cache *s, int node)
565{
566 return s->node[node];
567}
568
569
570
571
572
573#define for_each_kmem_cache_node(__s, __node, __n) \
574 for (__node = 0; __node < nr_node_ids; __node++) \
575 if ((__n = get_node(__s, __node)))
576
577#endif
578
579void *slab_start(struct seq_file *m, loff_t *pos);
580void *slab_next(struct seq_file *m, void *p, loff_t *pos);
581void slab_stop(struct seq_file *m, void *p);
582void *memcg_slab_start(struct seq_file *m, loff_t *pos);
583void *memcg_slab_next(struct seq_file *m, void *p, loff_t *pos);
584void memcg_slab_stop(struct seq_file *m, void *p);
585int memcg_slab_show(struct seq_file *m, void *p);
586
587#if defined(CONFIG_SLAB) || defined(CONFIG_SLUB_DEBUG)
588void dump_unreclaimable_slab(void);
589#else
590static inline void dump_unreclaimable_slab(void)
591{
592}
593#endif
594
595void ___cache_free(struct kmem_cache *cache, void *x, unsigned long addr);
596
597#ifdef CONFIG_SLAB_FREELIST_RANDOM
598int cache_random_seq_create(struct kmem_cache *cachep, unsigned int count,
599 gfp_t gfp);
600void cache_random_seq_destroy(struct kmem_cache *cachep);
601#else
602static inline int cache_random_seq_create(struct kmem_cache *cachep,
603 unsigned int count, gfp_t gfp)
604{
605 return 0;
606}
607static inline void cache_random_seq_destroy(struct kmem_cache *cachep) { }
608#endif
609
610static inline bool slab_want_init_on_alloc(gfp_t flags, struct kmem_cache *c)
611{
612 if (static_branch_unlikely(&init_on_alloc)) {
613 if (c->ctor)
614 return false;
615 if (c->flags & (SLAB_TYPESAFE_BY_RCU | SLAB_POISON))
616 return flags & __GFP_ZERO;
617 return true;
618 }
619 return flags & __GFP_ZERO;
620}
621
622static inline bool slab_want_init_on_free(struct kmem_cache *c)
623{
624 if (static_branch_unlikely(&init_on_free))
625 return !(c->ctor ||
626 (c->flags & (SLAB_TYPESAFE_BY_RCU | SLAB_POISON)));
627 return false;
628}
629
630#endif
631