xref: /linux/mm/slab.h (revision 6cd6d33ca41ff4af21bc25c331ab34b50b4a9c8c)
1b2441318SGreg Kroah-Hartman /* SPDX-License-Identifier: GPL-2.0 */
297d06609SChristoph Lameter #ifndef MM_SLAB_H
397d06609SChristoph Lameter #define MM_SLAB_H
497d06609SChristoph Lameter /*
597d06609SChristoph Lameter  * Internal slab definitions
697d06609SChristoph Lameter  */
797d06609SChristoph Lameter 
8d122019bSMatthew Wilcox (Oracle) /* Reuses the bits in struct page */
9d122019bSMatthew Wilcox (Oracle) struct slab {
10d122019bSMatthew Wilcox (Oracle) 	unsigned long __page_flags;
11401fb12cSVlastimil Babka 
12401fb12cSVlastimil Babka #if defined(CONFIG_SLAB)
13401fb12cSVlastimil Babka 
14d122019bSMatthew Wilcox (Oracle) 	union {
15d122019bSMatthew Wilcox (Oracle) 		struct list_head slab_list;
16401fb12cSVlastimil Babka 		struct rcu_head rcu_head;
17401fb12cSVlastimil Babka 	};
18401fb12cSVlastimil Babka 	struct kmem_cache *slab_cache;
19401fb12cSVlastimil Babka 	void *freelist;	/* array of free object indexes */
20401fb12cSVlastimil Babka 	void *s_mem;	/* first object */
21401fb12cSVlastimil Babka 	unsigned int active;
22401fb12cSVlastimil Babka 
23401fb12cSVlastimil Babka #elif defined(CONFIG_SLUB)
24401fb12cSVlastimil Babka 
25401fb12cSVlastimil Babka 	union {
26401fb12cSVlastimil Babka 		struct list_head slab_list;
27401fb12cSVlastimil Babka 		struct rcu_head rcu_head;
289c01e9afSVlastimil Babka #ifdef CONFIG_SLUB_CPU_PARTIAL
29401fb12cSVlastimil Babka 		struct {
30d122019bSMatthew Wilcox (Oracle) 			struct slab *next;
31d122019bSMatthew Wilcox (Oracle) 			int slabs;	/* Nr of slabs left */
32d122019bSMatthew Wilcox (Oracle) 		};
339c01e9afSVlastimil Babka #endif
34d122019bSMatthew Wilcox (Oracle) 	};
35401fb12cSVlastimil Babka 	struct kmem_cache *slab_cache;
36d122019bSMatthew Wilcox (Oracle) 	/* Double-word boundary */
37d122019bSMatthew Wilcox (Oracle) 	void *freelist;		/* first free object */
38d122019bSMatthew Wilcox (Oracle) 	union {
39401fb12cSVlastimil Babka 		unsigned long counters;
40401fb12cSVlastimil Babka 		struct {
41d122019bSMatthew Wilcox (Oracle) 			unsigned inuse:16;
42d122019bSMatthew Wilcox (Oracle) 			unsigned objects:15;
43d122019bSMatthew Wilcox (Oracle) 			unsigned frozen:1;
44d122019bSMatthew Wilcox (Oracle) 		};
45d122019bSMatthew Wilcox (Oracle) 	};
46401fb12cSVlastimil Babka 	unsigned int __unused;
47d122019bSMatthew Wilcox (Oracle) 
48401fb12cSVlastimil Babka #elif defined(CONFIG_SLOB)
49401fb12cSVlastimil Babka 
50401fb12cSVlastimil Babka 	struct list_head slab_list;
51401fb12cSVlastimil Babka 	void *__unused_1;
52401fb12cSVlastimil Babka 	void *freelist;		/* first free block */
53b01af5c0SHyeonggon Yoo 	long units;
54b01af5c0SHyeonggon Yoo 	unsigned int __unused_2;
55401fb12cSVlastimil Babka 
56401fb12cSVlastimil Babka #else
57401fb12cSVlastimil Babka #error "Unexpected slab allocator configured"
58401fb12cSVlastimil Babka #endif
59401fb12cSVlastimil Babka 
60d122019bSMatthew Wilcox (Oracle) 	atomic_t __page_refcount;
61d122019bSMatthew Wilcox (Oracle) #ifdef CONFIG_MEMCG
62d122019bSMatthew Wilcox (Oracle) 	unsigned long memcg_data;
63d122019bSMatthew Wilcox (Oracle) #endif
64d122019bSMatthew Wilcox (Oracle) };
65d122019bSMatthew Wilcox (Oracle) 
66d122019bSMatthew Wilcox (Oracle) #define SLAB_MATCH(pg, sl)						\
67d122019bSMatthew Wilcox (Oracle) 	static_assert(offsetof(struct page, pg) == offsetof(struct slab, sl))
68d122019bSMatthew Wilcox (Oracle) SLAB_MATCH(flags, __page_flags);
69d122019bSMatthew Wilcox (Oracle) SLAB_MATCH(compound_head, slab_list);	/* Ensure bit 0 is clear */
70401fb12cSVlastimil Babka #ifndef CONFIG_SLOB
71d122019bSMatthew Wilcox (Oracle) SLAB_MATCH(rcu_head, rcu_head);
72401fb12cSVlastimil Babka #endif
73d122019bSMatthew Wilcox (Oracle) SLAB_MATCH(_refcount, __page_refcount);
74d122019bSMatthew Wilcox (Oracle) #ifdef CONFIG_MEMCG
75d122019bSMatthew Wilcox (Oracle) SLAB_MATCH(memcg_data, memcg_data);
76d122019bSMatthew Wilcox (Oracle) #endif
77d122019bSMatthew Wilcox (Oracle) #undef SLAB_MATCH
78d122019bSMatthew Wilcox (Oracle) static_assert(sizeof(struct slab) <= sizeof(struct page));
79d122019bSMatthew Wilcox (Oracle) 
80d122019bSMatthew Wilcox (Oracle) /**
81d122019bSMatthew Wilcox (Oracle)  * folio_slab - Converts from folio to slab.
82d122019bSMatthew Wilcox (Oracle)  * @folio: The folio.
83d122019bSMatthew Wilcox (Oracle)  *
84d122019bSMatthew Wilcox (Oracle)  * Currently struct slab is a different representation of a folio where
85d122019bSMatthew Wilcox (Oracle)  * folio_test_slab() is true.
86d122019bSMatthew Wilcox (Oracle)  *
87d122019bSMatthew Wilcox (Oracle)  * Return: The slab which contains this folio.
88d122019bSMatthew Wilcox (Oracle)  */
89d122019bSMatthew Wilcox (Oracle) #define folio_slab(folio)	(_Generic((folio),			\
90d122019bSMatthew Wilcox (Oracle) 	const struct folio *:	(const struct slab *)(folio),		\
91d122019bSMatthew Wilcox (Oracle) 	struct folio *:		(struct slab *)(folio)))
92d122019bSMatthew Wilcox (Oracle) 
93d122019bSMatthew Wilcox (Oracle) /**
94d122019bSMatthew Wilcox (Oracle)  * slab_folio - The folio allocated for a slab
95d122019bSMatthew Wilcox (Oracle)  * @slab: The slab.
96d122019bSMatthew Wilcox (Oracle)  *
97d122019bSMatthew Wilcox (Oracle)  * Slabs are allocated as folios that contain the individual objects and are
98d122019bSMatthew Wilcox (Oracle)  * using some fields in the first struct page of the folio - those fields are
99d122019bSMatthew Wilcox (Oracle)  * now accessed by struct slab. It is occasionally necessary to convert back to
100d122019bSMatthew Wilcox (Oracle)  * a folio in order to communicate with the rest of the mm.  Please use this
101d122019bSMatthew Wilcox (Oracle)  * helper function instead of casting yourself, as the implementation may change
102d122019bSMatthew Wilcox (Oracle)  * in the future.
103d122019bSMatthew Wilcox (Oracle)  */
104d122019bSMatthew Wilcox (Oracle) #define slab_folio(s)		(_Generic((s),				\
105d122019bSMatthew Wilcox (Oracle) 	const struct slab *:	(const struct folio *)s,		\
106d122019bSMatthew Wilcox (Oracle) 	struct slab *:		(struct folio *)s))
107d122019bSMatthew Wilcox (Oracle) 
108d122019bSMatthew Wilcox (Oracle) /**
109d122019bSMatthew Wilcox (Oracle)  * page_slab - Converts from first struct page to slab.
110d122019bSMatthew Wilcox (Oracle)  * @p: The first (either head of compound or single) page of slab.
111d122019bSMatthew Wilcox (Oracle)  *
112d122019bSMatthew Wilcox (Oracle)  * A temporary wrapper to convert struct page to struct slab in situations where
113d122019bSMatthew Wilcox (Oracle)  * we know the page is the compound head, or single order-0 page.
114d122019bSMatthew Wilcox (Oracle)  *
115d122019bSMatthew Wilcox (Oracle)  * Long-term ideally everything would work with struct slab directly or go
116d122019bSMatthew Wilcox (Oracle)  * through folio to struct slab.
117d122019bSMatthew Wilcox (Oracle)  *
118d122019bSMatthew Wilcox (Oracle)  * Return: The slab which contains this page
119d122019bSMatthew Wilcox (Oracle)  */
120d122019bSMatthew Wilcox (Oracle) #define page_slab(p)		(_Generic((p),				\
121d122019bSMatthew Wilcox (Oracle) 	const struct page *:	(const struct slab *)(p),		\
122d122019bSMatthew Wilcox (Oracle) 	struct page *:		(struct slab *)(p)))
123d122019bSMatthew Wilcox (Oracle) 
124d122019bSMatthew Wilcox (Oracle) /**
125d122019bSMatthew Wilcox (Oracle)  * slab_page - The first struct page allocated for a slab
126d122019bSMatthew Wilcox (Oracle)  * @slab: The slab.
127d122019bSMatthew Wilcox (Oracle)  *
128d122019bSMatthew Wilcox (Oracle)  * A convenience wrapper for converting slab to the first struct page of the
129d122019bSMatthew Wilcox (Oracle)  * underlying folio, to communicate with code not yet converted to folio or
130d122019bSMatthew Wilcox (Oracle)  * struct slab.
131d122019bSMatthew Wilcox (Oracle)  */
132d122019bSMatthew Wilcox (Oracle) #define slab_page(s) folio_page(slab_folio(s), 0)
133d122019bSMatthew Wilcox (Oracle) 
134d122019bSMatthew Wilcox (Oracle) /*
135d122019bSMatthew Wilcox (Oracle)  * If network-based swap is enabled, sl*b must keep track of whether pages
136d122019bSMatthew Wilcox (Oracle)  * were allocated from pfmemalloc reserves.
137d122019bSMatthew Wilcox (Oracle)  */
138d122019bSMatthew Wilcox (Oracle) static inline bool slab_test_pfmemalloc(const struct slab *slab)
139d122019bSMatthew Wilcox (Oracle) {
140d122019bSMatthew Wilcox (Oracle) 	return folio_test_active((struct folio *)slab_folio(slab));
141d122019bSMatthew Wilcox (Oracle) }
142d122019bSMatthew Wilcox (Oracle) 
143d122019bSMatthew Wilcox (Oracle) static inline void slab_set_pfmemalloc(struct slab *slab)
144d122019bSMatthew Wilcox (Oracle) {
145d122019bSMatthew Wilcox (Oracle) 	folio_set_active(slab_folio(slab));
146d122019bSMatthew Wilcox (Oracle) }
147d122019bSMatthew Wilcox (Oracle) 
148d122019bSMatthew Wilcox (Oracle) static inline void slab_clear_pfmemalloc(struct slab *slab)
149d122019bSMatthew Wilcox (Oracle) {
150d122019bSMatthew Wilcox (Oracle) 	folio_clear_active(slab_folio(slab));
151d122019bSMatthew Wilcox (Oracle) }
152d122019bSMatthew Wilcox (Oracle) 
153d122019bSMatthew Wilcox (Oracle) static inline void __slab_clear_pfmemalloc(struct slab *slab)
154d122019bSMatthew Wilcox (Oracle) {
155d122019bSMatthew Wilcox (Oracle) 	__folio_clear_active(slab_folio(slab));
156d122019bSMatthew Wilcox (Oracle) }
157d122019bSMatthew Wilcox (Oracle) 
158d122019bSMatthew Wilcox (Oracle) static inline void *slab_address(const struct slab *slab)
159d122019bSMatthew Wilcox (Oracle) {
160d122019bSMatthew Wilcox (Oracle) 	return folio_address(slab_folio(slab));
161d122019bSMatthew Wilcox (Oracle) }
162d122019bSMatthew Wilcox (Oracle) 
163d122019bSMatthew Wilcox (Oracle) static inline int slab_nid(const struct slab *slab)
164d122019bSMatthew Wilcox (Oracle) {
165d122019bSMatthew Wilcox (Oracle) 	return folio_nid(slab_folio(slab));
166d122019bSMatthew Wilcox (Oracle) }
167d122019bSMatthew Wilcox (Oracle) 
168d122019bSMatthew Wilcox (Oracle) static inline pg_data_t *slab_pgdat(const struct slab *slab)
169d122019bSMatthew Wilcox (Oracle) {
170d122019bSMatthew Wilcox (Oracle) 	return folio_pgdat(slab_folio(slab));
171d122019bSMatthew Wilcox (Oracle) }
172d122019bSMatthew Wilcox (Oracle) 
173d122019bSMatthew Wilcox (Oracle) static inline struct slab *virt_to_slab(const void *addr)
174d122019bSMatthew Wilcox (Oracle) {
175d122019bSMatthew Wilcox (Oracle) 	struct folio *folio = virt_to_folio(addr);
176d122019bSMatthew Wilcox (Oracle) 
177d122019bSMatthew Wilcox (Oracle) 	if (!folio_test_slab(folio))
178d122019bSMatthew Wilcox (Oracle) 		return NULL;
179d122019bSMatthew Wilcox (Oracle) 
180d122019bSMatthew Wilcox (Oracle) 	return folio_slab(folio);
181d122019bSMatthew Wilcox (Oracle) }
182d122019bSMatthew Wilcox (Oracle) 
183d122019bSMatthew Wilcox (Oracle) static inline int slab_order(const struct slab *slab)
184d122019bSMatthew Wilcox (Oracle) {
185d122019bSMatthew Wilcox (Oracle) 	return folio_order((struct folio *)slab_folio(slab));
186d122019bSMatthew Wilcox (Oracle) }
187d122019bSMatthew Wilcox (Oracle) 
188d122019bSMatthew Wilcox (Oracle) static inline size_t slab_size(const struct slab *slab)
189d122019bSMatthew Wilcox (Oracle) {
190d122019bSMatthew Wilcox (Oracle) 	return PAGE_SIZE << slab_order(slab);
191d122019bSMatthew Wilcox (Oracle) }
192d122019bSMatthew Wilcox (Oracle) 
19307f361b2SJoonsoo Kim #ifdef CONFIG_SLOB
19407f361b2SJoonsoo Kim /*
19507f361b2SJoonsoo Kim  * Common fields provided in kmem_cache by all slab allocators
19607f361b2SJoonsoo Kim  * This struct is either used directly by the allocator (SLOB)
19707f361b2SJoonsoo Kim  * or the allocator must include definitions for all fields
19807f361b2SJoonsoo Kim  * provided in kmem_cache_common in their definition of kmem_cache.
19907f361b2SJoonsoo Kim  *
20007f361b2SJoonsoo Kim  * Once we can do anonymous structs (C11 standard) we could put a
20107f361b2SJoonsoo Kim  * anonymous struct definition in these allocators so that the
20207f361b2SJoonsoo Kim  * separate allocations in the kmem_cache structure of SLAB and
20307f361b2SJoonsoo Kim  * SLUB is no longer needed.
20407f361b2SJoonsoo Kim  */
20507f361b2SJoonsoo Kim struct kmem_cache {
20607f361b2SJoonsoo Kim 	unsigned int object_size;/* The original size of the object */
20707f361b2SJoonsoo Kim 	unsigned int size;	/* The aligned/padded/added on size  */
20807f361b2SJoonsoo Kim 	unsigned int align;	/* Alignment as calculated */
209d50112edSAlexey Dobriyan 	slab_flags_t flags;	/* Active flags on the slab */
2107bbdb81eSAlexey Dobriyan 	unsigned int useroffset;/* Usercopy region offset */
2117bbdb81eSAlexey Dobriyan 	unsigned int usersize;	/* Usercopy region size */
21207f361b2SJoonsoo Kim 	const char *name;	/* Slab name for sysfs */
21307f361b2SJoonsoo Kim 	int refcount;		/* Use counter */
21407f361b2SJoonsoo Kim 	void (*ctor)(void *);	/* Called on object slot creation */
21507f361b2SJoonsoo Kim 	struct list_head list;	/* List of all slab caches on the system */
21607f361b2SJoonsoo Kim };
21707f361b2SJoonsoo Kim 
21807f361b2SJoonsoo Kim #endif /* CONFIG_SLOB */
21907f361b2SJoonsoo Kim 
22007f361b2SJoonsoo Kim #ifdef CONFIG_SLAB
22107f361b2SJoonsoo Kim #include <linux/slab_def.h>
22207f361b2SJoonsoo Kim #endif
22307f361b2SJoonsoo Kim 
22407f361b2SJoonsoo Kim #ifdef CONFIG_SLUB
22507f361b2SJoonsoo Kim #include <linux/slub_def.h>
22607f361b2SJoonsoo Kim #endif
22707f361b2SJoonsoo Kim 
22807f361b2SJoonsoo Kim #include <linux/memcontrol.h>
22911c7aec2SJesper Dangaard Brouer #include <linux/fault-inject.h>
23011c7aec2SJesper Dangaard Brouer #include <linux/kasan.h>
23111c7aec2SJesper Dangaard Brouer #include <linux/kmemleak.h>
2327c00fce9SThomas Garnier #include <linux/random.h>
233d92a8cfcSPeter Zijlstra #include <linux/sched/mm.h>
23488f2ef73SMuchun Song #include <linux/list_lru.h>
23507f361b2SJoonsoo Kim 
23697d06609SChristoph Lameter /*
23797d06609SChristoph Lameter  * State of the slab allocator.
23897d06609SChristoph Lameter  *
23997d06609SChristoph Lameter  * This is used to describe the states of the allocator during bootup.
24097d06609SChristoph Lameter  * Allocators use this to gradually bootstrap themselves. Most allocators
24197d06609SChristoph Lameter  * have the problem that the structures used for managing slab caches are
24297d06609SChristoph Lameter  * allocated from slab caches themselves.
24397d06609SChristoph Lameter  */
24497d06609SChristoph Lameter enum slab_state {
24597d06609SChristoph Lameter 	DOWN,			/* No slab functionality yet */
24697d06609SChristoph Lameter 	PARTIAL,		/* SLUB: kmem_cache_node available */
247ce8eb6c4SChristoph Lameter 	PARTIAL_NODE,		/* SLAB: kmalloc size for node struct available */
24897d06609SChristoph Lameter 	UP,			/* Slab caches usable but not all extras yet */
24997d06609SChristoph Lameter 	FULL			/* Everything is working */
25097d06609SChristoph Lameter };
25197d06609SChristoph Lameter 
25297d06609SChristoph Lameter extern enum slab_state slab_state;
25397d06609SChristoph Lameter 
25418004c5dSChristoph Lameter /* The slab cache mutex protects the management structures during changes */
25518004c5dSChristoph Lameter extern struct mutex slab_mutex;
2569b030cb8SChristoph Lameter 
2579b030cb8SChristoph Lameter /* The list of all slab caches on the system */
25818004c5dSChristoph Lameter extern struct list_head slab_caches;
25918004c5dSChristoph Lameter 
2609b030cb8SChristoph Lameter /* The slab cache that manages slab cache information */
2619b030cb8SChristoph Lameter extern struct kmem_cache *kmem_cache;
2629b030cb8SChristoph Lameter 
263af3b5f87SVlastimil Babka /* A table of kmalloc cache names and sizes */
264af3b5f87SVlastimil Babka extern const struct kmalloc_info_struct {
265cb5d9fb3SPengfei Li 	const char *name[NR_KMALLOC_TYPES];
26655de8b9cSAlexey Dobriyan 	unsigned int size;
267af3b5f87SVlastimil Babka } kmalloc_info[];
268af3b5f87SVlastimil Babka 
269f97d5f63SChristoph Lameter #ifndef CONFIG_SLOB
270f97d5f63SChristoph Lameter /* Kmalloc array related functions */
27134cc6990SDaniel Sanders void setup_kmalloc_cache_index_table(void);
272d50112edSAlexey Dobriyan void create_kmalloc_caches(slab_flags_t);
2732c59dd65SChristoph Lameter 
2742c59dd65SChristoph Lameter /* Find the kmalloc slab corresponding for a certain size */
2752c59dd65SChristoph Lameter struct kmem_cache *kmalloc_slab(size_t, gfp_t);
276ed4cd17eSHyeonggon Yoo 
277ed4cd17eSHyeonggon Yoo void *__kmem_cache_alloc_node(struct kmem_cache *s, gfp_t gfpflags,
278ed4cd17eSHyeonggon Yoo 			      int node, size_t orig_size,
279ed4cd17eSHyeonggon Yoo 			      unsigned long caller);
280ed4cd17eSHyeonggon Yoo void __kmem_cache_free(struct kmem_cache *s, void *x, unsigned long caller);
281f97d5f63SChristoph Lameter #endif
282f97d5f63SChristoph Lameter 
28344405099SLong Li gfp_t kmalloc_fix_flags(gfp_t flags);
284f97d5f63SChristoph Lameter 
2859b030cb8SChristoph Lameter /* Functions provided by the slab allocators */
286d50112edSAlexey Dobriyan int __kmem_cache_create(struct kmem_cache *, slab_flags_t flags);
28797d06609SChristoph Lameter 
28855de8b9cSAlexey Dobriyan struct kmem_cache *create_kmalloc_cache(const char *name, unsigned int size,
28955de8b9cSAlexey Dobriyan 			slab_flags_t flags, unsigned int useroffset,
29055de8b9cSAlexey Dobriyan 			unsigned int usersize);
29145530c44SChristoph Lameter extern void create_boot_cache(struct kmem_cache *, const char *name,
292361d575eSAlexey Dobriyan 			unsigned int size, slab_flags_t flags,
293361d575eSAlexey Dobriyan 			unsigned int useroffset, unsigned int usersize);
29445530c44SChristoph Lameter 
295423c929cSJoonsoo Kim int slab_unmergeable(struct kmem_cache *s);
296f4957d5bSAlexey Dobriyan struct kmem_cache *find_mergeable(unsigned size, unsigned align,
297d50112edSAlexey Dobriyan 		slab_flags_t flags, const char *name, void (*ctor)(void *));
29812220deaSJoonsoo Kim #ifndef CONFIG_SLOB
2992633d7a0SGlauber Costa struct kmem_cache *
300f4957d5bSAlexey Dobriyan __kmem_cache_alias(const char *name, unsigned int size, unsigned int align,
301d50112edSAlexey Dobriyan 		   slab_flags_t flags, void (*ctor)(void *));
302423c929cSJoonsoo Kim 
3030293d1fdSAlexey Dobriyan slab_flags_t kmem_cache_flags(unsigned int object_size,
30437540008SNikolay Borisov 	slab_flags_t flags, const char *name);
305cbb79694SChristoph Lameter #else
3062633d7a0SGlauber Costa static inline struct kmem_cache *
307f4957d5bSAlexey Dobriyan __kmem_cache_alias(const char *name, unsigned int size, unsigned int align,
308d50112edSAlexey Dobriyan 		   slab_flags_t flags, void (*ctor)(void *))
309cbb79694SChristoph Lameter { return NULL; }
310423c929cSJoonsoo Kim 
3110293d1fdSAlexey Dobriyan static inline slab_flags_t kmem_cache_flags(unsigned int object_size,
31237540008SNikolay Borisov 	slab_flags_t flags, const char *name)
313423c929cSJoonsoo Kim {
314423c929cSJoonsoo Kim 	return flags;
315423c929cSJoonsoo Kim }
316cbb79694SChristoph Lameter #endif
317cbb79694SChristoph Lameter 
318cbb79694SChristoph Lameter 
319d8843922SGlauber Costa /* Legal flag mask for kmem_cache_create(), for various configurations */
3206d6ea1e9SNicolas Boichat #define SLAB_CORE_FLAGS (SLAB_HWCACHE_ALIGN | SLAB_CACHE_DMA | \
3216d6ea1e9SNicolas Boichat 			 SLAB_CACHE_DMA32 | SLAB_PANIC | \
3225f0d5a3aSPaul E. McKenney 			 SLAB_TYPESAFE_BY_RCU | SLAB_DEBUG_OBJECTS )
323d8843922SGlauber Costa 
324d8843922SGlauber Costa #if defined(CONFIG_DEBUG_SLAB)
325d8843922SGlauber Costa #define SLAB_DEBUG_FLAGS (SLAB_RED_ZONE | SLAB_POISON | SLAB_STORE_USER)
326d8843922SGlauber Costa #elif defined(CONFIG_SLUB_DEBUG)
327d8843922SGlauber Costa #define SLAB_DEBUG_FLAGS (SLAB_RED_ZONE | SLAB_POISON | SLAB_STORE_USER | \
328becfda68SLaura Abbott 			  SLAB_TRACE | SLAB_CONSISTENCY_CHECKS)
329d8843922SGlauber Costa #else
330d8843922SGlauber Costa #define SLAB_DEBUG_FLAGS (0)
331d8843922SGlauber Costa #endif
332d8843922SGlauber Costa 
333d8843922SGlauber Costa #if defined(CONFIG_SLAB)
334d8843922SGlauber Costa #define SLAB_CACHE_FLAGS (SLAB_MEM_SPREAD | SLAB_NOLEAKTRACE | \
335230e9fc2SVladimir Davydov 			  SLAB_RECLAIM_ACCOUNT | SLAB_TEMPORARY | \
33675f296d9SLevin, Alexander (Sasha Levin) 			  SLAB_ACCOUNT)
337d8843922SGlauber Costa #elif defined(CONFIG_SLUB)
338d8843922SGlauber Costa #define SLAB_CACHE_FLAGS (SLAB_NOLEAKTRACE | SLAB_RECLAIM_ACCOUNT | \
339*6cd6d33cSFeng Tang 			  SLAB_TEMPORARY | SLAB_ACCOUNT | \
340*6cd6d33cSFeng Tang 			  SLAB_NO_USER_FLAGS | SLAB_KMALLOC)
341d8843922SGlauber Costa #else
34234dbc3aaSRustam Kovhaev #define SLAB_CACHE_FLAGS (SLAB_NOLEAKTRACE)
343d8843922SGlauber Costa #endif
344d8843922SGlauber Costa 
345e70954fdSThomas Garnier /* Common flags available with current configuration */
346d8843922SGlauber Costa #define CACHE_CREATE_MASK (SLAB_CORE_FLAGS | SLAB_DEBUG_FLAGS | SLAB_CACHE_FLAGS)
347d8843922SGlauber Costa 
348e70954fdSThomas Garnier /* Common flags permitted for kmem_cache_create */
349e70954fdSThomas Garnier #define SLAB_FLAGS_PERMITTED (SLAB_CORE_FLAGS | \
350e70954fdSThomas Garnier 			      SLAB_RED_ZONE | \
351e70954fdSThomas Garnier 			      SLAB_POISON | \
352e70954fdSThomas Garnier 			      SLAB_STORE_USER | \
353e70954fdSThomas Garnier 			      SLAB_TRACE | \
354e70954fdSThomas Garnier 			      SLAB_CONSISTENCY_CHECKS | \
355e70954fdSThomas Garnier 			      SLAB_MEM_SPREAD | \
356e70954fdSThomas Garnier 			      SLAB_NOLEAKTRACE | \
357e70954fdSThomas Garnier 			      SLAB_RECLAIM_ACCOUNT | \
358e70954fdSThomas Garnier 			      SLAB_TEMPORARY | \
359a285909fSHyeonggon Yoo 			      SLAB_ACCOUNT | \
360*6cd6d33cSFeng Tang 			      SLAB_KMALLOC | \
361a285909fSHyeonggon Yoo 			      SLAB_NO_USER_FLAGS)
362e70954fdSThomas Garnier 
363f9e13c0aSShakeel Butt bool __kmem_cache_empty(struct kmem_cache *);
364945cf2b6SChristoph Lameter int __kmem_cache_shutdown(struct kmem_cache *);
36552b4b950SDmitry Safonov void __kmem_cache_release(struct kmem_cache *);
366c9fc5864STejun Heo int __kmem_cache_shrink(struct kmem_cache *);
36741a21285SChristoph Lameter void slab_kmem_cache_release(struct kmem_cache *);
368945cf2b6SChristoph Lameter 
369b7454ad3SGlauber Costa struct seq_file;
370b7454ad3SGlauber Costa struct file;
371b7454ad3SGlauber Costa 
3720d7561c6SGlauber Costa struct slabinfo {
3730d7561c6SGlauber Costa 	unsigned long active_objs;
3740d7561c6SGlauber Costa 	unsigned long num_objs;
3750d7561c6SGlauber Costa 	unsigned long active_slabs;
3760d7561c6SGlauber Costa 	unsigned long num_slabs;
3770d7561c6SGlauber Costa 	unsigned long shared_avail;
3780d7561c6SGlauber Costa 	unsigned int limit;
3790d7561c6SGlauber Costa 	unsigned int batchcount;
3800d7561c6SGlauber Costa 	unsigned int shared;
3810d7561c6SGlauber Costa 	unsigned int objects_per_slab;
3820d7561c6SGlauber Costa 	unsigned int cache_order;
3830d7561c6SGlauber Costa };
3840d7561c6SGlauber Costa 
3850d7561c6SGlauber Costa void get_slabinfo(struct kmem_cache *s, struct slabinfo *sinfo);
3860d7561c6SGlauber Costa void slabinfo_show_stats(struct seq_file *m, struct kmem_cache *s);
387b7454ad3SGlauber Costa ssize_t slabinfo_write(struct file *file, const char __user *buffer,
388b7454ad3SGlauber Costa 		       size_t count, loff_t *ppos);
389ba6c496eSGlauber Costa 
3901a984c4eSMuchun Song static inline enum node_stat_item cache_vmstat_idx(struct kmem_cache *s)
3916cea1d56SRoman Gushchin {
3926cea1d56SRoman Gushchin 	return (s->flags & SLAB_RECLAIM_ACCOUNT) ?
393d42f3245SRoman Gushchin 		NR_SLAB_RECLAIMABLE_B : NR_SLAB_UNRECLAIMABLE_B;
3946cea1d56SRoman Gushchin }
3956cea1d56SRoman Gushchin 
396e42f174eSVlastimil Babka #ifdef CONFIG_SLUB_DEBUG
397e42f174eSVlastimil Babka #ifdef CONFIG_SLUB_DEBUG_ON
398e42f174eSVlastimil Babka DECLARE_STATIC_KEY_TRUE(slub_debug_enabled);
399e42f174eSVlastimil Babka #else
400e42f174eSVlastimil Babka DECLARE_STATIC_KEY_FALSE(slub_debug_enabled);
401e42f174eSVlastimil Babka #endif
402e42f174eSVlastimil Babka extern void print_tracking(struct kmem_cache *s, void *object);
4031f9f78b1SOliver Glitta long validate_slab_cache(struct kmem_cache *s);
4040d4a062aSMarco Elver static inline bool __slub_debug_enabled(void)
4050d4a062aSMarco Elver {
4060d4a062aSMarco Elver 	return static_branch_unlikely(&slub_debug_enabled);
4070d4a062aSMarco Elver }
408e42f174eSVlastimil Babka #else
409e42f174eSVlastimil Babka static inline void print_tracking(struct kmem_cache *s, void *object)
410e42f174eSVlastimil Babka {
411e42f174eSVlastimil Babka }
4120d4a062aSMarco Elver static inline bool __slub_debug_enabled(void)
4130d4a062aSMarco Elver {
4140d4a062aSMarco Elver 	return false;
4150d4a062aSMarco Elver }
416e42f174eSVlastimil Babka #endif
417e42f174eSVlastimil Babka 
418e42f174eSVlastimil Babka /*
419e42f174eSVlastimil Babka  * Returns true if any of the specified slub_debug flags is enabled for the
420e42f174eSVlastimil Babka  * cache. Use only for flags parsed by setup_slub_debug() as it also enables
421e42f174eSVlastimil Babka  * the static key.
422e42f174eSVlastimil Babka  */
423e42f174eSVlastimil Babka static inline bool kmem_cache_debug_flags(struct kmem_cache *s, slab_flags_t flags)
424e42f174eSVlastimil Babka {
4250d4a062aSMarco Elver 	if (IS_ENABLED(CONFIG_SLUB_DEBUG))
426e42f174eSVlastimil Babka 		VM_WARN_ON_ONCE(!(flags & SLAB_DEBUG_FLAGS));
4270d4a062aSMarco Elver 	if (__slub_debug_enabled())
428e42f174eSVlastimil Babka 		return s->flags & flags;
429e42f174eSVlastimil Babka 	return false;
430e42f174eSVlastimil Babka }
431e42f174eSVlastimil Babka 
43284c07d11SKirill Tkhai #ifdef CONFIG_MEMCG_KMEM
4334b5f8d9aSVlastimil Babka /*
4344b5f8d9aSVlastimil Babka  * slab_objcgs - get the object cgroups vector associated with a slab
4354b5f8d9aSVlastimil Babka  * @slab: a pointer to the slab struct
4364b5f8d9aSVlastimil Babka  *
4374b5f8d9aSVlastimil Babka  * Returns a pointer to the object cgroups vector associated with the slab,
4384b5f8d9aSVlastimil Babka  * or NULL if no such vector has been associated yet.
4394b5f8d9aSVlastimil Babka  */
4404b5f8d9aSVlastimil Babka static inline struct obj_cgroup **slab_objcgs(struct slab *slab)
4414b5f8d9aSVlastimil Babka {
4424b5f8d9aSVlastimil Babka 	unsigned long memcg_data = READ_ONCE(slab->memcg_data);
4434b5f8d9aSVlastimil Babka 
4444b5f8d9aSVlastimil Babka 	VM_BUG_ON_PAGE(memcg_data && !(memcg_data & MEMCG_DATA_OBJCGS),
4454b5f8d9aSVlastimil Babka 							slab_page(slab));
4464b5f8d9aSVlastimil Babka 	VM_BUG_ON_PAGE(memcg_data & MEMCG_DATA_KMEM, slab_page(slab));
4474b5f8d9aSVlastimil Babka 
4484b5f8d9aSVlastimil Babka 	return (struct obj_cgroup **)(memcg_data & ~MEMCG_DATA_FLAGS_MASK);
4494b5f8d9aSVlastimil Babka }
4504b5f8d9aSVlastimil Babka 
4514b5f8d9aSVlastimil Babka int memcg_alloc_slab_cgroups(struct slab *slab, struct kmem_cache *s,
4524b5f8d9aSVlastimil Babka 				 gfp_t gfp, bool new_slab);
453fdbcb2a6SWaiman Long void mod_objcg_state(struct obj_cgroup *objcg, struct pglist_data *pgdat,
454fdbcb2a6SWaiman Long 		     enum node_stat_item idx, int nr);
455286e04b8SRoman Gushchin 
4564b5f8d9aSVlastimil Babka static inline void memcg_free_slab_cgroups(struct slab *slab)
457286e04b8SRoman Gushchin {
4584b5f8d9aSVlastimil Babka 	kfree(slab_objcgs(slab));
4594b5f8d9aSVlastimil Babka 	slab->memcg_data = 0;
460286e04b8SRoman Gushchin }
461286e04b8SRoman Gushchin 
462f2fe7b09SRoman Gushchin static inline size_t obj_full_size(struct kmem_cache *s)
463f2fe7b09SRoman Gushchin {
464f2fe7b09SRoman Gushchin 	/*
465f2fe7b09SRoman Gushchin 	 * For each accounted object there is an extra space which is used
466f2fe7b09SRoman Gushchin 	 * to store obj_cgroup membership. Charge it too.
467f2fe7b09SRoman Gushchin 	 */
468f2fe7b09SRoman Gushchin 	return s->size + sizeof(struct obj_cgroup *);
469f2fe7b09SRoman Gushchin }
470f2fe7b09SRoman Gushchin 
471becaba65SRoman Gushchin /*
472becaba65SRoman Gushchin  * Returns false if the allocation should fail.
473becaba65SRoman Gushchin  */
474becaba65SRoman Gushchin static inline bool memcg_slab_pre_alloc_hook(struct kmem_cache *s,
47588f2ef73SMuchun Song 					     struct list_lru *lru,
476becaba65SRoman Gushchin 					     struct obj_cgroup **objcgp,
477becaba65SRoman Gushchin 					     size_t objects, gfp_t flags)
478f2fe7b09SRoman Gushchin {
4799855609bSRoman Gushchin 	struct obj_cgroup *objcg;
480f2fe7b09SRoman Gushchin 
481becaba65SRoman Gushchin 	if (!memcg_kmem_enabled())
482becaba65SRoman Gushchin 		return true;
483becaba65SRoman Gushchin 
484becaba65SRoman Gushchin 	if (!(flags & __GFP_ACCOUNT) && !(s->flags & SLAB_ACCOUNT))
485becaba65SRoman Gushchin 		return true;
486becaba65SRoman Gushchin 
4879855609bSRoman Gushchin 	objcg = get_obj_cgroup_from_current();
4889855609bSRoman Gushchin 	if (!objcg)
489becaba65SRoman Gushchin 		return true;
4909855609bSRoman Gushchin 
49188f2ef73SMuchun Song 	if (lru) {
49288f2ef73SMuchun Song 		int ret;
49388f2ef73SMuchun Song 		struct mem_cgroup *memcg;
49488f2ef73SMuchun Song 
49588f2ef73SMuchun Song 		memcg = get_mem_cgroup_from_objcg(objcg);
49688f2ef73SMuchun Song 		ret = memcg_list_lru_alloc(memcg, lru, flags);
49788f2ef73SMuchun Song 		css_put(&memcg->css);
49888f2ef73SMuchun Song 
49988f2ef73SMuchun Song 		if (ret)
50088f2ef73SMuchun Song 			goto out;
501f2fe7b09SRoman Gushchin 	}
502f2fe7b09SRoman Gushchin 
50388f2ef73SMuchun Song 	if (obj_cgroup_charge(objcg, flags, objects * obj_full_size(s)))
50488f2ef73SMuchun Song 		goto out;
50588f2ef73SMuchun Song 
506becaba65SRoman Gushchin 	*objcgp = objcg;
507becaba65SRoman Gushchin 	return true;
50888f2ef73SMuchun Song out:
50988f2ef73SMuchun Song 	obj_cgroup_put(objcg);
51088f2ef73SMuchun Song 	return false;
511f2fe7b09SRoman Gushchin }
512f2fe7b09SRoman Gushchin 
513964d4bd3SRoman Gushchin static inline void memcg_slab_post_alloc_hook(struct kmem_cache *s,
514964d4bd3SRoman Gushchin 					      struct obj_cgroup *objcg,
51510befea9SRoman Gushchin 					      gfp_t flags, size_t size,
51610befea9SRoman Gushchin 					      void **p)
517964d4bd3SRoman Gushchin {
5184b5f8d9aSVlastimil Babka 	struct slab *slab;
519964d4bd3SRoman Gushchin 	unsigned long off;
520964d4bd3SRoman Gushchin 	size_t i;
521964d4bd3SRoman Gushchin 
522becaba65SRoman Gushchin 	if (!memcg_kmem_enabled() || !objcg)
52310befea9SRoman Gushchin 		return;
52410befea9SRoman Gushchin 
525964d4bd3SRoman Gushchin 	for (i = 0; i < size; i++) {
526964d4bd3SRoman Gushchin 		if (likely(p[i])) {
5274b5f8d9aSVlastimil Babka 			slab = virt_to_slab(p[i]);
52810befea9SRoman Gushchin 
5294b5f8d9aSVlastimil Babka 			if (!slab_objcgs(slab) &&
5304b5f8d9aSVlastimil Babka 			    memcg_alloc_slab_cgroups(slab, s, flags,
5312e9bd483SRoman Gushchin 							 false)) {
53210befea9SRoman Gushchin 				obj_cgroup_uncharge(objcg, obj_full_size(s));
53310befea9SRoman Gushchin 				continue;
53410befea9SRoman Gushchin 			}
53510befea9SRoman Gushchin 
5364b5f8d9aSVlastimil Babka 			off = obj_to_index(s, slab, p[i]);
537964d4bd3SRoman Gushchin 			obj_cgroup_get(objcg);
5384b5f8d9aSVlastimil Babka 			slab_objcgs(slab)[off] = objcg;
5394b5f8d9aSVlastimil Babka 			mod_objcg_state(objcg, slab_pgdat(slab),
540f2fe7b09SRoman Gushchin 					cache_vmstat_idx(s), obj_full_size(s));
541f2fe7b09SRoman Gushchin 		} else {
542f2fe7b09SRoman Gushchin 			obj_cgroup_uncharge(objcg, obj_full_size(s));
543964d4bd3SRoman Gushchin 		}
544964d4bd3SRoman Gushchin 	}
545964d4bd3SRoman Gushchin 	obj_cgroup_put(objcg);
546964d4bd3SRoman Gushchin }
547964d4bd3SRoman Gushchin 
548b77d5b1bSMuchun Song static inline void memcg_slab_free_hook(struct kmem_cache *s, struct slab *slab,
549d1b2cf6cSBharata B Rao 					void **p, int objects)
550964d4bd3SRoman Gushchin {
551270c6a71SRoman Gushchin 	struct obj_cgroup **objcgs;
552d1b2cf6cSBharata B Rao 	int i;
553964d4bd3SRoman Gushchin 
55410befea9SRoman Gushchin 	if (!memcg_kmem_enabled())
55510befea9SRoman Gushchin 		return;
55610befea9SRoman Gushchin 
5574b5f8d9aSVlastimil Babka 	objcgs = slab_objcgs(slab);
558270c6a71SRoman Gushchin 	if (!objcgs)
559b77d5b1bSMuchun Song 		return;
560964d4bd3SRoman Gushchin 
561b77d5b1bSMuchun Song 	for (i = 0; i < objects; i++) {
562b77d5b1bSMuchun Song 		struct obj_cgroup *objcg;
563b77d5b1bSMuchun Song 		unsigned int off;
564d1b2cf6cSBharata B Rao 
5654b5f8d9aSVlastimil Babka 		off = obj_to_index(s, slab, p[i]);
566270c6a71SRoman Gushchin 		objcg = objcgs[off];
56710befea9SRoman Gushchin 		if (!objcg)
568d1b2cf6cSBharata B Rao 			continue;
56910befea9SRoman Gushchin 
570270c6a71SRoman Gushchin 		objcgs[off] = NULL;
571f2fe7b09SRoman Gushchin 		obj_cgroup_uncharge(objcg, obj_full_size(s));
5724b5f8d9aSVlastimil Babka 		mod_objcg_state(objcg, slab_pgdat(slab), cache_vmstat_idx(s),
573f2fe7b09SRoman Gushchin 				-obj_full_size(s));
574964d4bd3SRoman Gushchin 		obj_cgroup_put(objcg);
575964d4bd3SRoman Gushchin 	}
576d1b2cf6cSBharata B Rao }
577964d4bd3SRoman Gushchin 
57884c07d11SKirill Tkhai #else /* CONFIG_MEMCG_KMEM */
5794b5f8d9aSVlastimil Babka static inline struct obj_cgroup **slab_objcgs(struct slab *slab)
5804b5f8d9aSVlastimil Babka {
5814b5f8d9aSVlastimil Babka 	return NULL;
5824b5f8d9aSVlastimil Babka }
5834b5f8d9aSVlastimil Babka 
5849855609bSRoman Gushchin static inline struct mem_cgroup *memcg_from_slab_obj(void *ptr)
5854d96ba35SRoman Gushchin {
5864d96ba35SRoman Gushchin 	return NULL;
5874d96ba35SRoman Gushchin }
5884d96ba35SRoman Gushchin 
5894b5f8d9aSVlastimil Babka static inline int memcg_alloc_slab_cgroups(struct slab *slab,
5902e9bd483SRoman Gushchin 					       struct kmem_cache *s, gfp_t gfp,
5914b5f8d9aSVlastimil Babka 					       bool new_slab)
592286e04b8SRoman Gushchin {
593286e04b8SRoman Gushchin 	return 0;
594286e04b8SRoman Gushchin }
595286e04b8SRoman Gushchin 
5964b5f8d9aSVlastimil Babka static inline void memcg_free_slab_cgroups(struct slab *slab)
597286e04b8SRoman Gushchin {
598286e04b8SRoman Gushchin }
599286e04b8SRoman Gushchin 
600becaba65SRoman Gushchin static inline bool memcg_slab_pre_alloc_hook(struct kmem_cache *s,
60188f2ef73SMuchun Song 					     struct list_lru *lru,
602becaba65SRoman Gushchin 					     struct obj_cgroup **objcgp,
603becaba65SRoman Gushchin 					     size_t objects, gfp_t flags)
604f2fe7b09SRoman Gushchin {
605becaba65SRoman Gushchin 	return true;
606f2fe7b09SRoman Gushchin }
607f2fe7b09SRoman Gushchin 
608964d4bd3SRoman Gushchin static inline void memcg_slab_post_alloc_hook(struct kmem_cache *s,
609964d4bd3SRoman Gushchin 					      struct obj_cgroup *objcg,
61010befea9SRoman Gushchin 					      gfp_t flags, size_t size,
61110befea9SRoman Gushchin 					      void **p)
612964d4bd3SRoman Gushchin {
613964d4bd3SRoman Gushchin }
614964d4bd3SRoman Gushchin 
615b77d5b1bSMuchun Song static inline void memcg_slab_free_hook(struct kmem_cache *s, struct slab *slab,
616d1b2cf6cSBharata B Rao 					void **p, int objects)
617964d4bd3SRoman Gushchin {
618964d4bd3SRoman Gushchin }
61984c07d11SKirill Tkhai #endif /* CONFIG_MEMCG_KMEM */
620b9ce5ef4SGlauber Costa 
621401fb12cSVlastimil Babka #ifndef CONFIG_SLOB
622a64b5378SKees Cook static inline struct kmem_cache *virt_to_cache(const void *obj)
623a64b5378SKees Cook {
62482c1775dSMatthew Wilcox (Oracle) 	struct slab *slab;
625a64b5378SKees Cook 
62682c1775dSMatthew Wilcox (Oracle) 	slab = virt_to_slab(obj);
62782c1775dSMatthew Wilcox (Oracle) 	if (WARN_ONCE(!slab, "%s: Object is not a Slab page!\n",
628a64b5378SKees Cook 					__func__))
629a64b5378SKees Cook 		return NULL;
63082c1775dSMatthew Wilcox (Oracle) 	return slab->slab_cache;
631a64b5378SKees Cook }
632a64b5378SKees Cook 
633b918653bSMatthew Wilcox (Oracle) static __always_inline void account_slab(struct slab *slab, int order,
634b918653bSMatthew Wilcox (Oracle) 					 struct kmem_cache *s, gfp_t gfp)
6356cea1d56SRoman Gushchin {
6362e9bd483SRoman Gushchin 	if (memcg_kmem_enabled() && (s->flags & SLAB_ACCOUNT))
6374b5f8d9aSVlastimil Babka 		memcg_alloc_slab_cgroups(slab, s, gfp, true);
6382e9bd483SRoman Gushchin 
639b918653bSMatthew Wilcox (Oracle) 	mod_node_page_state(slab_pgdat(slab), cache_vmstat_idx(s),
640f2fe7b09SRoman Gushchin 			    PAGE_SIZE << order);
6416cea1d56SRoman Gushchin }
6426cea1d56SRoman Gushchin 
643b918653bSMatthew Wilcox (Oracle) static __always_inline void unaccount_slab(struct slab *slab, int order,
6446cea1d56SRoman Gushchin 					   struct kmem_cache *s)
6456cea1d56SRoman Gushchin {
64610befea9SRoman Gushchin 	if (memcg_kmem_enabled())
6474b5f8d9aSVlastimil Babka 		memcg_free_slab_cgroups(slab);
6489855609bSRoman Gushchin 
649b918653bSMatthew Wilcox (Oracle) 	mod_node_page_state(slab_pgdat(slab), cache_vmstat_idx(s),
650d42f3245SRoman Gushchin 			    -(PAGE_SIZE << order));
6516cea1d56SRoman Gushchin }
6526cea1d56SRoman Gushchin 
653e42f174eSVlastimil Babka static inline struct kmem_cache *cache_from_obj(struct kmem_cache *s, void *x)
654e42f174eSVlastimil Babka {
655e42f174eSVlastimil Babka 	struct kmem_cache *cachep;
656e42f174eSVlastimil Babka 
657e42f174eSVlastimil Babka 	if (!IS_ENABLED(CONFIG_SLAB_FREELIST_HARDENED) &&
658e42f174eSVlastimil Babka 	    !kmem_cache_debug_flags(s, SLAB_CONSISTENCY_CHECKS))
659e42f174eSVlastimil Babka 		return s;
660e42f174eSVlastimil Babka 
661e42f174eSVlastimil Babka 	cachep = virt_to_cache(x);
66210befea9SRoman Gushchin 	if (WARN(cachep && cachep != s,
663e42f174eSVlastimil Babka 		  "%s: Wrong slab cache. %s but object is from %s\n",
664e42f174eSVlastimil Babka 		  __func__, s->name, cachep->name))
665e42f174eSVlastimil Babka 		print_tracking(cachep, x);
666e42f174eSVlastimil Babka 	return cachep;
667e42f174eSVlastimil Babka }
668d6a71648SHyeonggon Yoo 
669d6a71648SHyeonggon Yoo void free_large_kmalloc(struct folio *folio, void *object);
670d6a71648SHyeonggon Yoo 
671401fb12cSVlastimil Babka #endif /* CONFIG_SLOB */
672e42f174eSVlastimil Babka 
6738dfa9d55SHyeonggon Yoo size_t __ksize(const void *objp);
6748dfa9d55SHyeonggon Yoo 
67511c7aec2SJesper Dangaard Brouer static inline size_t slab_ksize(const struct kmem_cache *s)
67611c7aec2SJesper Dangaard Brouer {
67711c7aec2SJesper Dangaard Brouer #ifndef CONFIG_SLUB
67811c7aec2SJesper Dangaard Brouer 	return s->object_size;
67911c7aec2SJesper Dangaard Brouer 
68011c7aec2SJesper Dangaard Brouer #else /* CONFIG_SLUB */
68111c7aec2SJesper Dangaard Brouer # ifdef CONFIG_SLUB_DEBUG
68211c7aec2SJesper Dangaard Brouer 	/*
68311c7aec2SJesper Dangaard Brouer 	 * Debugging requires use of the padding between object
68411c7aec2SJesper Dangaard Brouer 	 * and whatever may come after it.
68511c7aec2SJesper Dangaard Brouer 	 */
68611c7aec2SJesper Dangaard Brouer 	if (s->flags & (SLAB_RED_ZONE | SLAB_POISON))
68711c7aec2SJesper Dangaard Brouer 		return s->object_size;
68811c7aec2SJesper Dangaard Brouer # endif
68980a9201aSAlexander Potapenko 	if (s->flags & SLAB_KASAN)
69080a9201aSAlexander Potapenko 		return s->object_size;
69111c7aec2SJesper Dangaard Brouer 	/*
69211c7aec2SJesper Dangaard Brouer 	 * If we have the need to store the freelist pointer
69311c7aec2SJesper Dangaard Brouer 	 * back there or track user information then we can
69411c7aec2SJesper Dangaard Brouer 	 * only use the space before that information.
69511c7aec2SJesper Dangaard Brouer 	 */
6965f0d5a3aSPaul E. McKenney 	if (s->flags & (SLAB_TYPESAFE_BY_RCU | SLAB_STORE_USER))
69711c7aec2SJesper Dangaard Brouer 		return s->inuse;
69811c7aec2SJesper Dangaard Brouer 	/*
69911c7aec2SJesper Dangaard Brouer 	 * Else we can use all the padding etc for the allocation
70011c7aec2SJesper Dangaard Brouer 	 */
70111c7aec2SJesper Dangaard Brouer 	return s->size;
70211c7aec2SJesper Dangaard Brouer #endif
70311c7aec2SJesper Dangaard Brouer }
70411c7aec2SJesper Dangaard Brouer 
70511c7aec2SJesper Dangaard Brouer static inline struct kmem_cache *slab_pre_alloc_hook(struct kmem_cache *s,
70688f2ef73SMuchun Song 						     struct list_lru *lru,
707964d4bd3SRoman Gushchin 						     struct obj_cgroup **objcgp,
708964d4bd3SRoman Gushchin 						     size_t size, gfp_t flags)
70911c7aec2SJesper Dangaard Brouer {
71011c7aec2SJesper Dangaard Brouer 	flags &= gfp_allowed_mask;
711d92a8cfcSPeter Zijlstra 
71295d6c701SDaniel Vetter 	might_alloc(flags);
71311c7aec2SJesper Dangaard Brouer 
714fab9963aSJesper Dangaard Brouer 	if (should_failslab(s, flags))
71511c7aec2SJesper Dangaard Brouer 		return NULL;
71611c7aec2SJesper Dangaard Brouer 
71788f2ef73SMuchun Song 	if (!memcg_slab_pre_alloc_hook(s, lru, objcgp, size, flags))
718becaba65SRoman Gushchin 		return NULL;
71945264778SVladimir Davydov 
72045264778SVladimir Davydov 	return s;
72111c7aec2SJesper Dangaard Brouer }
72211c7aec2SJesper Dangaard Brouer 
723964d4bd3SRoman Gushchin static inline void slab_post_alloc_hook(struct kmem_cache *s,
724da844b78SAndrey Konovalov 					struct obj_cgroup *objcg, gfp_t flags,
7259ce67395SFeng Tang 					size_t size, void **p, bool init,
7269ce67395SFeng Tang 					unsigned int orig_size)
72711c7aec2SJesper Dangaard Brouer {
7289ce67395SFeng Tang 	unsigned int zero_size = s->object_size;
72911c7aec2SJesper Dangaard Brouer 	size_t i;
73011c7aec2SJesper Dangaard Brouer 
73111c7aec2SJesper Dangaard Brouer 	flags &= gfp_allowed_mask;
732da844b78SAndrey Konovalov 
733da844b78SAndrey Konovalov 	/*
7349ce67395SFeng Tang 	 * For kmalloc object, the allocated memory size(object_size) is likely
7359ce67395SFeng Tang 	 * larger than the requested size(orig_size). If redzone check is
7369ce67395SFeng Tang 	 * enabled for the extra space, don't zero it, as it will be redzoned
7379ce67395SFeng Tang 	 * soon. The redzone operation for this extra space could be seen as a
7389ce67395SFeng Tang 	 * replacement of current poisoning under certain debug option, and
7399ce67395SFeng Tang 	 * won't break other sanity checks.
7409ce67395SFeng Tang 	 */
7419ce67395SFeng Tang 	if (kmem_cache_debug_flags(s, SLAB_STORE_USER | SLAB_RED_ZONE) &&
7429ce67395SFeng Tang 	    (s->flags & SLAB_KMALLOC))
7439ce67395SFeng Tang 		zero_size = orig_size;
7449ce67395SFeng Tang 
7459ce67395SFeng Tang 	/*
746da844b78SAndrey Konovalov 	 * As memory initialization might be integrated into KASAN,
747da844b78SAndrey Konovalov 	 * kasan_slab_alloc and initialization memset must be
748da844b78SAndrey Konovalov 	 * kept together to avoid discrepancies in behavior.
749da844b78SAndrey Konovalov 	 *
750da844b78SAndrey Konovalov 	 * As p[i] might get tagged, memset and kmemleak hook come after KASAN.
751da844b78SAndrey Konovalov 	 */
75211c7aec2SJesper Dangaard Brouer 	for (i = 0; i < size; i++) {
753da844b78SAndrey Konovalov 		p[i] = kasan_slab_alloc(s, p[i], flags, init);
754da844b78SAndrey Konovalov 		if (p[i] && init && !kasan_has_integrated_init())
7559ce67395SFeng Tang 			memset(p[i], 0, zero_size);
75653128245SAndrey Konovalov 		kmemleak_alloc_recursive(p[i], s->object_size, 1,
75711c7aec2SJesper Dangaard Brouer 					 s->flags, flags);
75868ef169aSAlexander Potapenko 		kmsan_slab_alloc(s, p[i], flags);
75911c7aec2SJesper Dangaard Brouer 	}
76045264778SVladimir Davydov 
76110befea9SRoman Gushchin 	memcg_slab_post_alloc_hook(s, objcg, flags, size, p);
76211c7aec2SJesper Dangaard Brouer }
76311c7aec2SJesper Dangaard Brouer 
76444c5356fSChristoph Lameter #ifndef CONFIG_SLOB
765ca34956bSChristoph Lameter /*
766ca34956bSChristoph Lameter  * The slab lists for all objects.
767ca34956bSChristoph Lameter  */
768ca34956bSChristoph Lameter struct kmem_cache_node {
769ca34956bSChristoph Lameter 	spinlock_t list_lock;
770ca34956bSChristoph Lameter 
771ca34956bSChristoph Lameter #ifdef CONFIG_SLAB
772ca34956bSChristoph Lameter 	struct list_head slabs_partial;	/* partial list first, better asm code */
773ca34956bSChristoph Lameter 	struct list_head slabs_full;
774ca34956bSChristoph Lameter 	struct list_head slabs_free;
775bf00bd34SDavid Rientjes 	unsigned long total_slabs;	/* length of all slab lists */
776bf00bd34SDavid Rientjes 	unsigned long free_slabs;	/* length of free slab list only */
777ca34956bSChristoph Lameter 	unsigned long free_objects;
778ca34956bSChristoph Lameter 	unsigned int free_limit;
779ca34956bSChristoph Lameter 	unsigned int colour_next;	/* Per-node cache coloring */
780ca34956bSChristoph Lameter 	struct array_cache *shared;	/* shared per node */
781c8522a3aSJoonsoo Kim 	struct alien_cache **alien;	/* on other nodes */
782ca34956bSChristoph Lameter 	unsigned long next_reap;	/* updated without locking */
783ca34956bSChristoph Lameter 	int free_touched;		/* updated without locking */
784ca34956bSChristoph Lameter #endif
785ca34956bSChristoph Lameter 
786ca34956bSChristoph Lameter #ifdef CONFIG_SLUB
787ca34956bSChristoph Lameter 	unsigned long nr_partial;
788ca34956bSChristoph Lameter 	struct list_head partial;
789ca34956bSChristoph Lameter #ifdef CONFIG_SLUB_DEBUG
790ca34956bSChristoph Lameter 	atomic_long_t nr_slabs;
791ca34956bSChristoph Lameter 	atomic_long_t total_objects;
792ca34956bSChristoph Lameter 	struct list_head full;
793ca34956bSChristoph Lameter #endif
794ca34956bSChristoph Lameter #endif
795ca34956bSChristoph Lameter 
796ca34956bSChristoph Lameter };
797e25839f6SWanpeng Li 
79844c5356fSChristoph Lameter static inline struct kmem_cache_node *get_node(struct kmem_cache *s, int node)
79944c5356fSChristoph Lameter {
80044c5356fSChristoph Lameter 	return s->node[node];
80144c5356fSChristoph Lameter }
80244c5356fSChristoph Lameter 
80344c5356fSChristoph Lameter /*
80444c5356fSChristoph Lameter  * Iterator over all nodes. The body will be executed for each node that has
80544c5356fSChristoph Lameter  * a kmem_cache_node structure allocated (which is true for all online nodes)
80644c5356fSChristoph Lameter  */
80744c5356fSChristoph Lameter #define for_each_kmem_cache_node(__s, __node, __n) \
8089163582cSMikulas Patocka 	for (__node = 0; __node < nr_node_ids; __node++) \
8099163582cSMikulas Patocka 		 if ((__n = get_node(__s, __node)))
81044c5356fSChristoph Lameter 
81144c5356fSChristoph Lameter #endif
81244c5356fSChristoph Lameter 
813852d8be0SYang Shi #if defined(CONFIG_SLAB) || defined(CONFIG_SLUB_DEBUG)
814852d8be0SYang Shi void dump_unreclaimable_slab(void);
815852d8be0SYang Shi #else
816852d8be0SYang Shi static inline void dump_unreclaimable_slab(void)
817852d8be0SYang Shi {
818852d8be0SYang Shi }
819852d8be0SYang Shi #endif
820852d8be0SYang Shi 
82155834c59SAlexander Potapenko void ___cache_free(struct kmem_cache *cache, void *x, unsigned long addr);
82255834c59SAlexander Potapenko 
8237c00fce9SThomas Garnier #ifdef CONFIG_SLAB_FREELIST_RANDOM
8247c00fce9SThomas Garnier int cache_random_seq_create(struct kmem_cache *cachep, unsigned int count,
8257c00fce9SThomas Garnier 			gfp_t gfp);
8267c00fce9SThomas Garnier void cache_random_seq_destroy(struct kmem_cache *cachep);
8277c00fce9SThomas Garnier #else
8287c00fce9SThomas Garnier static inline int cache_random_seq_create(struct kmem_cache *cachep,
8297c00fce9SThomas Garnier 					unsigned int count, gfp_t gfp)
8307c00fce9SThomas Garnier {
8317c00fce9SThomas Garnier 	return 0;
8327c00fce9SThomas Garnier }
8337c00fce9SThomas Garnier static inline void cache_random_seq_destroy(struct kmem_cache *cachep) { }
8347c00fce9SThomas Garnier #endif /* CONFIG_SLAB_FREELIST_RANDOM */
8357c00fce9SThomas Garnier 
8366471384aSAlexander Potapenko static inline bool slab_want_init_on_alloc(gfp_t flags, struct kmem_cache *c)
8376471384aSAlexander Potapenko {
83851cba1ebSKees Cook 	if (static_branch_maybe(CONFIG_INIT_ON_ALLOC_DEFAULT_ON,
83951cba1ebSKees Cook 				&init_on_alloc)) {
8406471384aSAlexander Potapenko 		if (c->ctor)
8416471384aSAlexander Potapenko 			return false;
8426471384aSAlexander Potapenko 		if (c->flags & (SLAB_TYPESAFE_BY_RCU | SLAB_POISON))
8436471384aSAlexander Potapenko 			return flags & __GFP_ZERO;
8446471384aSAlexander Potapenko 		return true;
8456471384aSAlexander Potapenko 	}
8466471384aSAlexander Potapenko 	return flags & __GFP_ZERO;
8476471384aSAlexander Potapenko }
8486471384aSAlexander Potapenko 
8496471384aSAlexander Potapenko static inline bool slab_want_init_on_free(struct kmem_cache *c)
8506471384aSAlexander Potapenko {
85151cba1ebSKees Cook 	if (static_branch_maybe(CONFIG_INIT_ON_FREE_DEFAULT_ON,
85251cba1ebSKees Cook 				&init_on_free))
8536471384aSAlexander Potapenko 		return !(c->ctor ||
8546471384aSAlexander Potapenko 			 (c->flags & (SLAB_TYPESAFE_BY_RCU | SLAB_POISON)));
8556471384aSAlexander Potapenko 	return false;
8566471384aSAlexander Potapenko }
8576471384aSAlexander Potapenko 
85864dd6849SFaiyaz Mohammed #if defined(CONFIG_DEBUG_FS) && defined(CONFIG_SLUB_DEBUG)
85964dd6849SFaiyaz Mohammed void debugfs_slab_release(struct kmem_cache *);
86064dd6849SFaiyaz Mohammed #else
86164dd6849SFaiyaz Mohammed static inline void debugfs_slab_release(struct kmem_cache *s) { }
86264dd6849SFaiyaz Mohammed #endif
86364dd6849SFaiyaz Mohammed 
8645bb1bb35SPaul E. McKenney #ifdef CONFIG_PRINTK
8658e7f37f2SPaul E. McKenney #define KS_ADDRS_COUNT 16
8668e7f37f2SPaul E. McKenney struct kmem_obj_info {
8678e7f37f2SPaul E. McKenney 	void *kp_ptr;
8687213230aSMatthew Wilcox (Oracle) 	struct slab *kp_slab;
8698e7f37f2SPaul E. McKenney 	void *kp_objp;
8708e7f37f2SPaul E. McKenney 	unsigned long kp_data_offset;
8718e7f37f2SPaul E. McKenney 	struct kmem_cache *kp_slab_cache;
8728e7f37f2SPaul E. McKenney 	void *kp_ret;
8738e7f37f2SPaul E. McKenney 	void *kp_stack[KS_ADDRS_COUNT];
874e548eaa1SManinder Singh 	void *kp_free_stack[KS_ADDRS_COUNT];
8758e7f37f2SPaul E. McKenney };
8762dfe63e6SMarco Elver void __kmem_obj_info(struct kmem_obj_info *kpp, void *object, struct slab *slab);
8775bb1bb35SPaul E. McKenney #endif
8788e7f37f2SPaul E. McKenney 
8790b3eb091SMatthew Wilcox (Oracle) #ifdef CONFIG_HAVE_HARDENED_USERCOPY_ALLOCATOR
8800b3eb091SMatthew Wilcox (Oracle) void __check_heap_object(const void *ptr, unsigned long n,
8810b3eb091SMatthew Wilcox (Oracle) 			 const struct slab *slab, bool to_user);
8820b3eb091SMatthew Wilcox (Oracle) #else
8830b3eb091SMatthew Wilcox (Oracle) static inline
8840b3eb091SMatthew Wilcox (Oracle) void __check_heap_object(const void *ptr, unsigned long n,
8850b3eb091SMatthew Wilcox (Oracle) 			 const struct slab *slab, bool to_user)
8860b3eb091SMatthew Wilcox (Oracle) {
8870b3eb091SMatthew Wilcox (Oracle) }
8880b3eb091SMatthew Wilcox (Oracle) #endif
8890b3eb091SMatthew Wilcox (Oracle) 
890946fa0dbSFeng Tang #ifdef CONFIG_SLUB_DEBUG
891946fa0dbSFeng Tang void skip_orig_size_check(struct kmem_cache *s, const void *object);
892946fa0dbSFeng Tang #endif
893946fa0dbSFeng Tang 
8945240ab40SAndrey Ryabinin #endif /* MM_SLAB_H */
895