xref: /linux/mm/slab.h (revision 9c01e9af171f13cf6573f404ecaf96dfa48233ab)
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;
28*9c01e9afSVlastimil 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) 		};
33*9c01e9afSVlastimil 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 */
53401fb12cSVlastimil Babka 	void *__unused_2;
54401fb12cSVlastimil Babka 	int units;
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 */
70d122019bSMatthew Wilcox (Oracle) SLAB_MATCH(slab_list, slab_list);
71401fb12cSVlastimil Babka #ifndef CONFIG_SLOB
72d122019bSMatthew Wilcox (Oracle) SLAB_MATCH(rcu_head, rcu_head);
73d122019bSMatthew Wilcox (Oracle) SLAB_MATCH(slab_cache, slab_cache);
74401fb12cSVlastimil Babka #endif
75401fb12cSVlastimil Babka #ifdef CONFIG_SLAB
76d122019bSMatthew Wilcox (Oracle) SLAB_MATCH(s_mem, s_mem);
77d122019bSMatthew Wilcox (Oracle) SLAB_MATCH(active, active);
78401fb12cSVlastimil Babka #endif
79d122019bSMatthew Wilcox (Oracle) SLAB_MATCH(_refcount, __page_refcount);
80d122019bSMatthew Wilcox (Oracle) #ifdef CONFIG_MEMCG
81d122019bSMatthew Wilcox (Oracle) SLAB_MATCH(memcg_data, memcg_data);
82d122019bSMatthew Wilcox (Oracle) #endif
83d122019bSMatthew Wilcox (Oracle) #undef SLAB_MATCH
84d122019bSMatthew Wilcox (Oracle) static_assert(sizeof(struct slab) <= sizeof(struct page));
85d122019bSMatthew Wilcox (Oracle) 
86d122019bSMatthew Wilcox (Oracle) /**
87d122019bSMatthew Wilcox (Oracle)  * folio_slab - Converts from folio to slab.
88d122019bSMatthew Wilcox (Oracle)  * @folio: The folio.
89d122019bSMatthew Wilcox (Oracle)  *
90d122019bSMatthew Wilcox (Oracle)  * Currently struct slab is a different representation of a folio where
91d122019bSMatthew Wilcox (Oracle)  * folio_test_slab() is true.
92d122019bSMatthew Wilcox (Oracle)  *
93d122019bSMatthew Wilcox (Oracle)  * Return: The slab which contains this folio.
94d122019bSMatthew Wilcox (Oracle)  */
95d122019bSMatthew Wilcox (Oracle) #define folio_slab(folio)	(_Generic((folio),			\
96d122019bSMatthew Wilcox (Oracle) 	const struct folio *:	(const struct slab *)(folio),		\
97d122019bSMatthew Wilcox (Oracle) 	struct folio *:		(struct slab *)(folio)))
98d122019bSMatthew Wilcox (Oracle) 
99d122019bSMatthew Wilcox (Oracle) /**
100d122019bSMatthew Wilcox (Oracle)  * slab_folio - The folio allocated for a slab
101d122019bSMatthew Wilcox (Oracle)  * @slab: The slab.
102d122019bSMatthew Wilcox (Oracle)  *
103d122019bSMatthew Wilcox (Oracle)  * Slabs are allocated as folios that contain the individual objects and are
104d122019bSMatthew Wilcox (Oracle)  * using some fields in the first struct page of the folio - those fields are
105d122019bSMatthew Wilcox (Oracle)  * now accessed by struct slab. It is occasionally necessary to convert back to
106d122019bSMatthew Wilcox (Oracle)  * a folio in order to communicate with the rest of the mm.  Please use this
107d122019bSMatthew Wilcox (Oracle)  * helper function instead of casting yourself, as the implementation may change
108d122019bSMatthew Wilcox (Oracle)  * in the future.
109d122019bSMatthew Wilcox (Oracle)  */
110d122019bSMatthew Wilcox (Oracle) #define slab_folio(s)		(_Generic((s),				\
111d122019bSMatthew Wilcox (Oracle) 	const struct slab *:	(const struct folio *)s,		\
112d122019bSMatthew Wilcox (Oracle) 	struct slab *:		(struct folio *)s))
113d122019bSMatthew Wilcox (Oracle) 
114d122019bSMatthew Wilcox (Oracle) /**
115d122019bSMatthew Wilcox (Oracle)  * page_slab - Converts from first struct page to slab.
116d122019bSMatthew Wilcox (Oracle)  * @p: The first (either head of compound or single) page of slab.
117d122019bSMatthew Wilcox (Oracle)  *
118d122019bSMatthew Wilcox (Oracle)  * A temporary wrapper to convert struct page to struct slab in situations where
119d122019bSMatthew Wilcox (Oracle)  * we know the page is the compound head, or single order-0 page.
120d122019bSMatthew Wilcox (Oracle)  *
121d122019bSMatthew Wilcox (Oracle)  * Long-term ideally everything would work with struct slab directly or go
122d122019bSMatthew Wilcox (Oracle)  * through folio to struct slab.
123d122019bSMatthew Wilcox (Oracle)  *
124d122019bSMatthew Wilcox (Oracle)  * Return: The slab which contains this page
125d122019bSMatthew Wilcox (Oracle)  */
126d122019bSMatthew Wilcox (Oracle) #define page_slab(p)		(_Generic((p),				\
127d122019bSMatthew Wilcox (Oracle) 	const struct page *:	(const struct slab *)(p),		\
128d122019bSMatthew Wilcox (Oracle) 	struct page *:		(struct slab *)(p)))
129d122019bSMatthew Wilcox (Oracle) 
130d122019bSMatthew Wilcox (Oracle) /**
131d122019bSMatthew Wilcox (Oracle)  * slab_page - The first struct page allocated for a slab
132d122019bSMatthew Wilcox (Oracle)  * @slab: The slab.
133d122019bSMatthew Wilcox (Oracle)  *
134d122019bSMatthew Wilcox (Oracle)  * A convenience wrapper for converting slab to the first struct page of the
135d122019bSMatthew Wilcox (Oracle)  * underlying folio, to communicate with code not yet converted to folio or
136d122019bSMatthew Wilcox (Oracle)  * struct slab.
137d122019bSMatthew Wilcox (Oracle)  */
138d122019bSMatthew Wilcox (Oracle) #define slab_page(s) folio_page(slab_folio(s), 0)
139d122019bSMatthew Wilcox (Oracle) 
140d122019bSMatthew Wilcox (Oracle) /*
141d122019bSMatthew Wilcox (Oracle)  * If network-based swap is enabled, sl*b must keep track of whether pages
142d122019bSMatthew Wilcox (Oracle)  * were allocated from pfmemalloc reserves.
143d122019bSMatthew Wilcox (Oracle)  */
144d122019bSMatthew Wilcox (Oracle) static inline bool slab_test_pfmemalloc(const struct slab *slab)
145d122019bSMatthew Wilcox (Oracle) {
146d122019bSMatthew Wilcox (Oracle) 	return folio_test_active((struct folio *)slab_folio(slab));
147d122019bSMatthew Wilcox (Oracle) }
148d122019bSMatthew Wilcox (Oracle) 
149d122019bSMatthew Wilcox (Oracle) static inline void slab_set_pfmemalloc(struct slab *slab)
150d122019bSMatthew Wilcox (Oracle) {
151d122019bSMatthew Wilcox (Oracle) 	folio_set_active(slab_folio(slab));
152d122019bSMatthew Wilcox (Oracle) }
153d122019bSMatthew Wilcox (Oracle) 
154d122019bSMatthew Wilcox (Oracle) static inline void slab_clear_pfmemalloc(struct slab *slab)
155d122019bSMatthew Wilcox (Oracle) {
156d122019bSMatthew Wilcox (Oracle) 	folio_clear_active(slab_folio(slab));
157d122019bSMatthew Wilcox (Oracle) }
158d122019bSMatthew Wilcox (Oracle) 
159d122019bSMatthew Wilcox (Oracle) static inline void __slab_clear_pfmemalloc(struct slab *slab)
160d122019bSMatthew Wilcox (Oracle) {
161d122019bSMatthew Wilcox (Oracle) 	__folio_clear_active(slab_folio(slab));
162d122019bSMatthew Wilcox (Oracle) }
163d122019bSMatthew Wilcox (Oracle) 
164d122019bSMatthew Wilcox (Oracle) static inline void *slab_address(const struct slab *slab)
165d122019bSMatthew Wilcox (Oracle) {
166d122019bSMatthew Wilcox (Oracle) 	return folio_address(slab_folio(slab));
167d122019bSMatthew Wilcox (Oracle) }
168d122019bSMatthew Wilcox (Oracle) 
169d122019bSMatthew Wilcox (Oracle) static inline int slab_nid(const struct slab *slab)
170d122019bSMatthew Wilcox (Oracle) {
171d122019bSMatthew Wilcox (Oracle) 	return folio_nid(slab_folio(slab));
172d122019bSMatthew Wilcox (Oracle) }
173d122019bSMatthew Wilcox (Oracle) 
174d122019bSMatthew Wilcox (Oracle) static inline pg_data_t *slab_pgdat(const struct slab *slab)
175d122019bSMatthew Wilcox (Oracle) {
176d122019bSMatthew Wilcox (Oracle) 	return folio_pgdat(slab_folio(slab));
177d122019bSMatthew Wilcox (Oracle) }
178d122019bSMatthew Wilcox (Oracle) 
179d122019bSMatthew Wilcox (Oracle) static inline struct slab *virt_to_slab(const void *addr)
180d122019bSMatthew Wilcox (Oracle) {
181d122019bSMatthew Wilcox (Oracle) 	struct folio *folio = virt_to_folio(addr);
182d122019bSMatthew Wilcox (Oracle) 
183d122019bSMatthew Wilcox (Oracle) 	if (!folio_test_slab(folio))
184d122019bSMatthew Wilcox (Oracle) 		return NULL;
185d122019bSMatthew Wilcox (Oracle) 
186d122019bSMatthew Wilcox (Oracle) 	return folio_slab(folio);
187d122019bSMatthew Wilcox (Oracle) }
188d122019bSMatthew Wilcox (Oracle) 
189d122019bSMatthew Wilcox (Oracle) static inline int slab_order(const struct slab *slab)
190d122019bSMatthew Wilcox (Oracle) {
191d122019bSMatthew Wilcox (Oracle) 	return folio_order((struct folio *)slab_folio(slab));
192d122019bSMatthew Wilcox (Oracle) }
193d122019bSMatthew Wilcox (Oracle) 
194d122019bSMatthew Wilcox (Oracle) static inline size_t slab_size(const struct slab *slab)
195d122019bSMatthew Wilcox (Oracle) {
196d122019bSMatthew Wilcox (Oracle) 	return PAGE_SIZE << slab_order(slab);
197d122019bSMatthew Wilcox (Oracle) }
198d122019bSMatthew Wilcox (Oracle) 
19907f361b2SJoonsoo Kim #ifdef CONFIG_SLOB
20007f361b2SJoonsoo Kim /*
20107f361b2SJoonsoo Kim  * Common fields provided in kmem_cache by all slab allocators
20207f361b2SJoonsoo Kim  * This struct is either used directly by the allocator (SLOB)
20307f361b2SJoonsoo Kim  * or the allocator must include definitions for all fields
20407f361b2SJoonsoo Kim  * provided in kmem_cache_common in their definition of kmem_cache.
20507f361b2SJoonsoo Kim  *
20607f361b2SJoonsoo Kim  * Once we can do anonymous structs (C11 standard) we could put a
20707f361b2SJoonsoo Kim  * anonymous struct definition in these allocators so that the
20807f361b2SJoonsoo Kim  * separate allocations in the kmem_cache structure of SLAB and
20907f361b2SJoonsoo Kim  * SLUB is no longer needed.
21007f361b2SJoonsoo Kim  */
21107f361b2SJoonsoo Kim struct kmem_cache {
21207f361b2SJoonsoo Kim 	unsigned int object_size;/* The original size of the object */
21307f361b2SJoonsoo Kim 	unsigned int size;	/* The aligned/padded/added on size  */
21407f361b2SJoonsoo Kim 	unsigned int align;	/* Alignment as calculated */
215d50112edSAlexey Dobriyan 	slab_flags_t flags;	/* Active flags on the slab */
2167bbdb81eSAlexey Dobriyan 	unsigned int useroffset;/* Usercopy region offset */
2177bbdb81eSAlexey Dobriyan 	unsigned int usersize;	/* Usercopy region size */
21807f361b2SJoonsoo Kim 	const char *name;	/* Slab name for sysfs */
21907f361b2SJoonsoo Kim 	int refcount;		/* Use counter */
22007f361b2SJoonsoo Kim 	void (*ctor)(void *);	/* Called on object slot creation */
22107f361b2SJoonsoo Kim 	struct list_head list;	/* List of all slab caches on the system */
22207f361b2SJoonsoo Kim };
22307f361b2SJoonsoo Kim 
22407f361b2SJoonsoo Kim #endif /* CONFIG_SLOB */
22507f361b2SJoonsoo Kim 
22607f361b2SJoonsoo Kim #ifdef CONFIG_SLAB
22707f361b2SJoonsoo Kim #include <linux/slab_def.h>
22807f361b2SJoonsoo Kim #endif
22907f361b2SJoonsoo Kim 
23007f361b2SJoonsoo Kim #ifdef CONFIG_SLUB
23107f361b2SJoonsoo Kim #include <linux/slub_def.h>
23207f361b2SJoonsoo Kim #endif
23307f361b2SJoonsoo Kim 
23407f361b2SJoonsoo Kim #include <linux/memcontrol.h>
23511c7aec2SJesper Dangaard Brouer #include <linux/fault-inject.h>
23611c7aec2SJesper Dangaard Brouer #include <linux/kasan.h>
23711c7aec2SJesper Dangaard Brouer #include <linux/kmemleak.h>
2387c00fce9SThomas Garnier #include <linux/random.h>
239d92a8cfcSPeter Zijlstra #include <linux/sched/mm.h>
24007f361b2SJoonsoo Kim 
24197d06609SChristoph Lameter /*
24297d06609SChristoph Lameter  * State of the slab allocator.
24397d06609SChristoph Lameter  *
24497d06609SChristoph Lameter  * This is used to describe the states of the allocator during bootup.
24597d06609SChristoph Lameter  * Allocators use this to gradually bootstrap themselves. Most allocators
24697d06609SChristoph Lameter  * have the problem that the structures used for managing slab caches are
24797d06609SChristoph Lameter  * allocated from slab caches themselves.
24897d06609SChristoph Lameter  */
24997d06609SChristoph Lameter enum slab_state {
25097d06609SChristoph Lameter 	DOWN,			/* No slab functionality yet */
25197d06609SChristoph Lameter 	PARTIAL,		/* SLUB: kmem_cache_node available */
252ce8eb6c4SChristoph Lameter 	PARTIAL_NODE,		/* SLAB: kmalloc size for node struct available */
25397d06609SChristoph Lameter 	UP,			/* Slab caches usable but not all extras yet */
25497d06609SChristoph Lameter 	FULL			/* Everything is working */
25597d06609SChristoph Lameter };
25697d06609SChristoph Lameter 
25797d06609SChristoph Lameter extern enum slab_state slab_state;
25897d06609SChristoph Lameter 
25918004c5dSChristoph Lameter /* The slab cache mutex protects the management structures during changes */
26018004c5dSChristoph Lameter extern struct mutex slab_mutex;
2619b030cb8SChristoph Lameter 
2629b030cb8SChristoph Lameter /* The list of all slab caches on the system */
26318004c5dSChristoph Lameter extern struct list_head slab_caches;
26418004c5dSChristoph Lameter 
2659b030cb8SChristoph Lameter /* The slab cache that manages slab cache information */
2669b030cb8SChristoph Lameter extern struct kmem_cache *kmem_cache;
2679b030cb8SChristoph Lameter 
268af3b5f87SVlastimil Babka /* A table of kmalloc cache names and sizes */
269af3b5f87SVlastimil Babka extern const struct kmalloc_info_struct {
270cb5d9fb3SPengfei Li 	const char *name[NR_KMALLOC_TYPES];
27155de8b9cSAlexey Dobriyan 	unsigned int size;
272af3b5f87SVlastimil Babka } kmalloc_info[];
273af3b5f87SVlastimil Babka 
274f97d5f63SChristoph Lameter #ifndef CONFIG_SLOB
275f97d5f63SChristoph Lameter /* Kmalloc array related functions */
27634cc6990SDaniel Sanders void setup_kmalloc_cache_index_table(void);
277d50112edSAlexey Dobriyan void create_kmalloc_caches(slab_flags_t);
2782c59dd65SChristoph Lameter 
2792c59dd65SChristoph Lameter /* Find the kmalloc slab corresponding for a certain size */
2802c59dd65SChristoph Lameter struct kmem_cache *kmalloc_slab(size_t, gfp_t);
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 | \
33975f296d9SLevin, Alexander (Sasha Levin) 			  SLAB_TEMPORARY | SLAB_ACCOUNT)
340d8843922SGlauber Costa #else
34134dbc3aaSRustam Kovhaev #define SLAB_CACHE_FLAGS (SLAB_NOLEAKTRACE)
342d8843922SGlauber Costa #endif
343d8843922SGlauber Costa 
344e70954fdSThomas Garnier /* Common flags available with current configuration */
345d8843922SGlauber Costa #define CACHE_CREATE_MASK (SLAB_CORE_FLAGS | SLAB_DEBUG_FLAGS | SLAB_CACHE_FLAGS)
346d8843922SGlauber Costa 
347e70954fdSThomas Garnier /* Common flags permitted for kmem_cache_create */
348e70954fdSThomas Garnier #define SLAB_FLAGS_PERMITTED (SLAB_CORE_FLAGS | \
349e70954fdSThomas Garnier 			      SLAB_RED_ZONE | \
350e70954fdSThomas Garnier 			      SLAB_POISON | \
351e70954fdSThomas Garnier 			      SLAB_STORE_USER | \
352e70954fdSThomas Garnier 			      SLAB_TRACE | \
353e70954fdSThomas Garnier 			      SLAB_CONSISTENCY_CHECKS | \
354e70954fdSThomas Garnier 			      SLAB_MEM_SPREAD | \
355e70954fdSThomas Garnier 			      SLAB_NOLEAKTRACE | \
356e70954fdSThomas Garnier 			      SLAB_RECLAIM_ACCOUNT | \
357e70954fdSThomas Garnier 			      SLAB_TEMPORARY | \
358e70954fdSThomas Garnier 			      SLAB_ACCOUNT)
359e70954fdSThomas Garnier 
360f9e13c0aSShakeel Butt bool __kmem_cache_empty(struct kmem_cache *);
361945cf2b6SChristoph Lameter int __kmem_cache_shutdown(struct kmem_cache *);
36252b4b950SDmitry Safonov void __kmem_cache_release(struct kmem_cache *);
363c9fc5864STejun Heo int __kmem_cache_shrink(struct kmem_cache *);
36441a21285SChristoph Lameter void slab_kmem_cache_release(struct kmem_cache *);
365945cf2b6SChristoph Lameter 
366b7454ad3SGlauber Costa struct seq_file;
367b7454ad3SGlauber Costa struct file;
368b7454ad3SGlauber Costa 
3690d7561c6SGlauber Costa struct slabinfo {
3700d7561c6SGlauber Costa 	unsigned long active_objs;
3710d7561c6SGlauber Costa 	unsigned long num_objs;
3720d7561c6SGlauber Costa 	unsigned long active_slabs;
3730d7561c6SGlauber Costa 	unsigned long num_slabs;
3740d7561c6SGlauber Costa 	unsigned long shared_avail;
3750d7561c6SGlauber Costa 	unsigned int limit;
3760d7561c6SGlauber Costa 	unsigned int batchcount;
3770d7561c6SGlauber Costa 	unsigned int shared;
3780d7561c6SGlauber Costa 	unsigned int objects_per_slab;
3790d7561c6SGlauber Costa 	unsigned int cache_order;
3800d7561c6SGlauber Costa };
3810d7561c6SGlauber Costa 
3820d7561c6SGlauber Costa void get_slabinfo(struct kmem_cache *s, struct slabinfo *sinfo);
3830d7561c6SGlauber Costa void slabinfo_show_stats(struct seq_file *m, struct kmem_cache *s);
384b7454ad3SGlauber Costa ssize_t slabinfo_write(struct file *file, const char __user *buffer,
385b7454ad3SGlauber Costa 		       size_t count, loff_t *ppos);
386ba6c496eSGlauber Costa 
387484748f0SChristoph Lameter /*
388484748f0SChristoph Lameter  * Generic implementation of bulk operations
389484748f0SChristoph Lameter  * These are useful for situations in which the allocator cannot
3909f706d68SJesper Dangaard Brouer  * perform optimizations. In that case segments of the object listed
391484748f0SChristoph Lameter  * may be allocated or freed using these operations.
392484748f0SChristoph Lameter  */
393484748f0SChristoph Lameter void __kmem_cache_free_bulk(struct kmem_cache *, size_t, void **);
394865762a8SJesper Dangaard Brouer int __kmem_cache_alloc_bulk(struct kmem_cache *, gfp_t, size_t, void **);
395484748f0SChristoph Lameter 
3961a984c4eSMuchun Song static inline enum node_stat_item cache_vmstat_idx(struct kmem_cache *s)
3976cea1d56SRoman Gushchin {
3986cea1d56SRoman Gushchin 	return (s->flags & SLAB_RECLAIM_ACCOUNT) ?
399d42f3245SRoman Gushchin 		NR_SLAB_RECLAIMABLE_B : NR_SLAB_UNRECLAIMABLE_B;
4006cea1d56SRoman Gushchin }
4016cea1d56SRoman Gushchin 
402e42f174eSVlastimil Babka #ifdef CONFIG_SLUB_DEBUG
403e42f174eSVlastimil Babka #ifdef CONFIG_SLUB_DEBUG_ON
404e42f174eSVlastimil Babka DECLARE_STATIC_KEY_TRUE(slub_debug_enabled);
405e42f174eSVlastimil Babka #else
406e42f174eSVlastimil Babka DECLARE_STATIC_KEY_FALSE(slub_debug_enabled);
407e42f174eSVlastimil Babka #endif
408e42f174eSVlastimil Babka extern void print_tracking(struct kmem_cache *s, void *object);
4091f9f78b1SOliver Glitta long validate_slab_cache(struct kmem_cache *s);
4100d4a062aSMarco Elver static inline bool __slub_debug_enabled(void)
4110d4a062aSMarco Elver {
4120d4a062aSMarco Elver 	return static_branch_unlikely(&slub_debug_enabled);
4130d4a062aSMarco Elver }
414e42f174eSVlastimil Babka #else
415e42f174eSVlastimil Babka static inline void print_tracking(struct kmem_cache *s, void *object)
416e42f174eSVlastimil Babka {
417e42f174eSVlastimil Babka }
4180d4a062aSMarco Elver static inline bool __slub_debug_enabled(void)
4190d4a062aSMarco Elver {
4200d4a062aSMarco Elver 	return false;
4210d4a062aSMarco Elver }
422e42f174eSVlastimil Babka #endif
423e42f174eSVlastimil Babka 
424e42f174eSVlastimil Babka /*
425e42f174eSVlastimil Babka  * Returns true if any of the specified slub_debug flags is enabled for the
426e42f174eSVlastimil Babka  * cache. Use only for flags parsed by setup_slub_debug() as it also enables
427e42f174eSVlastimil Babka  * the static key.
428e42f174eSVlastimil Babka  */
429e42f174eSVlastimil Babka static inline bool kmem_cache_debug_flags(struct kmem_cache *s, slab_flags_t flags)
430e42f174eSVlastimil Babka {
4310d4a062aSMarco Elver 	if (IS_ENABLED(CONFIG_SLUB_DEBUG))
432e42f174eSVlastimil Babka 		VM_WARN_ON_ONCE(!(flags & SLAB_DEBUG_FLAGS));
4330d4a062aSMarco Elver 	if (__slub_debug_enabled())
434e42f174eSVlastimil Babka 		return s->flags & flags;
435e42f174eSVlastimil Babka 	return false;
436e42f174eSVlastimil Babka }
437e42f174eSVlastimil Babka 
43884c07d11SKirill Tkhai #ifdef CONFIG_MEMCG_KMEM
4394b5f8d9aSVlastimil Babka /*
4404b5f8d9aSVlastimil Babka  * slab_objcgs - get the object cgroups vector associated with a slab
4414b5f8d9aSVlastimil Babka  * @slab: a pointer to the slab struct
4424b5f8d9aSVlastimil Babka  *
4434b5f8d9aSVlastimil Babka  * Returns a pointer to the object cgroups vector associated with the slab,
4444b5f8d9aSVlastimil Babka  * or NULL if no such vector has been associated yet.
4454b5f8d9aSVlastimil Babka  */
4464b5f8d9aSVlastimil Babka static inline struct obj_cgroup **slab_objcgs(struct slab *slab)
4474b5f8d9aSVlastimil Babka {
4484b5f8d9aSVlastimil Babka 	unsigned long memcg_data = READ_ONCE(slab->memcg_data);
4494b5f8d9aSVlastimil Babka 
4504b5f8d9aSVlastimil Babka 	VM_BUG_ON_PAGE(memcg_data && !(memcg_data & MEMCG_DATA_OBJCGS),
4514b5f8d9aSVlastimil Babka 							slab_page(slab));
4524b5f8d9aSVlastimil Babka 	VM_BUG_ON_PAGE(memcg_data & MEMCG_DATA_KMEM, slab_page(slab));
4534b5f8d9aSVlastimil Babka 
4544b5f8d9aSVlastimil Babka 	return (struct obj_cgroup **)(memcg_data & ~MEMCG_DATA_FLAGS_MASK);
4554b5f8d9aSVlastimil Babka }
4564b5f8d9aSVlastimil Babka 
4574b5f8d9aSVlastimil Babka int memcg_alloc_slab_cgroups(struct slab *slab, struct kmem_cache *s,
4584b5f8d9aSVlastimil Babka 				 gfp_t gfp, bool new_slab);
459fdbcb2a6SWaiman Long void mod_objcg_state(struct obj_cgroup *objcg, struct pglist_data *pgdat,
460fdbcb2a6SWaiman Long 		     enum node_stat_item idx, int nr);
461286e04b8SRoman Gushchin 
4624b5f8d9aSVlastimil Babka static inline void memcg_free_slab_cgroups(struct slab *slab)
463286e04b8SRoman Gushchin {
4644b5f8d9aSVlastimil Babka 	kfree(slab_objcgs(slab));
4654b5f8d9aSVlastimil Babka 	slab->memcg_data = 0;
466286e04b8SRoman Gushchin }
467286e04b8SRoman Gushchin 
468f2fe7b09SRoman Gushchin static inline size_t obj_full_size(struct kmem_cache *s)
469f2fe7b09SRoman Gushchin {
470f2fe7b09SRoman Gushchin 	/*
471f2fe7b09SRoman Gushchin 	 * For each accounted object there is an extra space which is used
472f2fe7b09SRoman Gushchin 	 * to store obj_cgroup membership. Charge it too.
473f2fe7b09SRoman Gushchin 	 */
474f2fe7b09SRoman Gushchin 	return s->size + sizeof(struct obj_cgroup *);
475f2fe7b09SRoman Gushchin }
476f2fe7b09SRoman Gushchin 
477becaba65SRoman Gushchin /*
478becaba65SRoman Gushchin  * Returns false if the allocation should fail.
479becaba65SRoman Gushchin  */
480becaba65SRoman Gushchin static inline bool memcg_slab_pre_alloc_hook(struct kmem_cache *s,
481becaba65SRoman Gushchin 					     struct obj_cgroup **objcgp,
482becaba65SRoman Gushchin 					     size_t objects, gfp_t flags)
483f2fe7b09SRoman Gushchin {
4849855609bSRoman Gushchin 	struct obj_cgroup *objcg;
485f2fe7b09SRoman Gushchin 
486becaba65SRoman Gushchin 	if (!memcg_kmem_enabled())
487becaba65SRoman Gushchin 		return true;
488becaba65SRoman Gushchin 
489becaba65SRoman Gushchin 	if (!(flags & __GFP_ACCOUNT) && !(s->flags & SLAB_ACCOUNT))
490becaba65SRoman Gushchin 		return true;
491becaba65SRoman Gushchin 
4929855609bSRoman Gushchin 	objcg = get_obj_cgroup_from_current();
4939855609bSRoman Gushchin 	if (!objcg)
494becaba65SRoman Gushchin 		return true;
4959855609bSRoman Gushchin 
4969855609bSRoman Gushchin 	if (obj_cgroup_charge(objcg, flags, objects * obj_full_size(s))) {
4979855609bSRoman Gushchin 		obj_cgroup_put(objcg);
498becaba65SRoman Gushchin 		return false;
499f2fe7b09SRoman Gushchin 	}
500f2fe7b09SRoman Gushchin 
501becaba65SRoman Gushchin 	*objcgp = objcg;
502becaba65SRoman Gushchin 	return true;
503f2fe7b09SRoman Gushchin }
504f2fe7b09SRoman Gushchin 
505964d4bd3SRoman Gushchin static inline void memcg_slab_post_alloc_hook(struct kmem_cache *s,
506964d4bd3SRoman Gushchin 					      struct obj_cgroup *objcg,
50710befea9SRoman Gushchin 					      gfp_t flags, size_t size,
50810befea9SRoman Gushchin 					      void **p)
509964d4bd3SRoman Gushchin {
5104b5f8d9aSVlastimil Babka 	struct slab *slab;
511964d4bd3SRoman Gushchin 	unsigned long off;
512964d4bd3SRoman Gushchin 	size_t i;
513964d4bd3SRoman Gushchin 
514becaba65SRoman Gushchin 	if (!memcg_kmem_enabled() || !objcg)
51510befea9SRoman Gushchin 		return;
51610befea9SRoman Gushchin 
517964d4bd3SRoman Gushchin 	for (i = 0; i < size; i++) {
518964d4bd3SRoman Gushchin 		if (likely(p[i])) {
5194b5f8d9aSVlastimil Babka 			slab = virt_to_slab(p[i]);
52010befea9SRoman Gushchin 
5214b5f8d9aSVlastimil Babka 			if (!slab_objcgs(slab) &&
5224b5f8d9aSVlastimil Babka 			    memcg_alloc_slab_cgroups(slab, s, flags,
5232e9bd483SRoman Gushchin 							 false)) {
52410befea9SRoman Gushchin 				obj_cgroup_uncharge(objcg, obj_full_size(s));
52510befea9SRoman Gushchin 				continue;
52610befea9SRoman Gushchin 			}
52710befea9SRoman Gushchin 
5284b5f8d9aSVlastimil Babka 			off = obj_to_index(s, slab, p[i]);
529964d4bd3SRoman Gushchin 			obj_cgroup_get(objcg);
5304b5f8d9aSVlastimil Babka 			slab_objcgs(slab)[off] = objcg;
5314b5f8d9aSVlastimil Babka 			mod_objcg_state(objcg, slab_pgdat(slab),
532f2fe7b09SRoman Gushchin 					cache_vmstat_idx(s), obj_full_size(s));
533f2fe7b09SRoman Gushchin 		} else {
534f2fe7b09SRoman Gushchin 			obj_cgroup_uncharge(objcg, obj_full_size(s));
535964d4bd3SRoman Gushchin 		}
536964d4bd3SRoman Gushchin 	}
537964d4bd3SRoman Gushchin 	obj_cgroup_put(objcg);
538964d4bd3SRoman Gushchin }
539964d4bd3SRoman Gushchin 
540d1b2cf6cSBharata B Rao static inline void memcg_slab_free_hook(struct kmem_cache *s_orig,
541d1b2cf6cSBharata B Rao 					void **p, int objects)
542964d4bd3SRoman Gushchin {
543d1b2cf6cSBharata B Rao 	struct kmem_cache *s;
544270c6a71SRoman Gushchin 	struct obj_cgroup **objcgs;
545964d4bd3SRoman Gushchin 	struct obj_cgroup *objcg;
5464b5f8d9aSVlastimil Babka 	struct slab *slab;
547964d4bd3SRoman Gushchin 	unsigned int off;
548d1b2cf6cSBharata B Rao 	int i;
549964d4bd3SRoman Gushchin 
55010befea9SRoman Gushchin 	if (!memcg_kmem_enabled())
55110befea9SRoman Gushchin 		return;
55210befea9SRoman Gushchin 
553d1b2cf6cSBharata B Rao 	for (i = 0; i < objects; i++) {
554d1b2cf6cSBharata B Rao 		if (unlikely(!p[i]))
555d1b2cf6cSBharata B Rao 			continue;
556d1b2cf6cSBharata B Rao 
5574b5f8d9aSVlastimil Babka 		slab = virt_to_slab(p[i]);
5584b5f8d9aSVlastimil Babka 		/* we could be given a kmalloc_large() object, skip those */
5594b5f8d9aSVlastimil Babka 		if (!slab)
5604b5f8d9aSVlastimil Babka 			continue;
5614b5f8d9aSVlastimil Babka 
5624b5f8d9aSVlastimil Babka 		objcgs = slab_objcgs(slab);
563270c6a71SRoman Gushchin 		if (!objcgs)
564d1b2cf6cSBharata B Rao 			continue;
565964d4bd3SRoman Gushchin 
566d1b2cf6cSBharata B Rao 		if (!s_orig)
5674b5f8d9aSVlastimil Babka 			s = slab->slab_cache;
568d1b2cf6cSBharata B Rao 		else
569d1b2cf6cSBharata B Rao 			s = s_orig;
570d1b2cf6cSBharata B Rao 
5714b5f8d9aSVlastimil Babka 		off = obj_to_index(s, slab, p[i]);
572270c6a71SRoman Gushchin 		objcg = objcgs[off];
57310befea9SRoman Gushchin 		if (!objcg)
574d1b2cf6cSBharata B Rao 			continue;
57510befea9SRoman Gushchin 
576270c6a71SRoman Gushchin 		objcgs[off] = NULL;
577f2fe7b09SRoman Gushchin 		obj_cgroup_uncharge(objcg, obj_full_size(s));
5784b5f8d9aSVlastimil Babka 		mod_objcg_state(objcg, slab_pgdat(slab), cache_vmstat_idx(s),
579f2fe7b09SRoman Gushchin 				-obj_full_size(s));
580964d4bd3SRoman Gushchin 		obj_cgroup_put(objcg);
581964d4bd3SRoman Gushchin 	}
582d1b2cf6cSBharata B Rao }
583964d4bd3SRoman Gushchin 
58484c07d11SKirill Tkhai #else /* CONFIG_MEMCG_KMEM */
5854b5f8d9aSVlastimil Babka static inline struct obj_cgroup **slab_objcgs(struct slab *slab)
5864b5f8d9aSVlastimil Babka {
5874b5f8d9aSVlastimil Babka 	return NULL;
5884b5f8d9aSVlastimil Babka }
5894b5f8d9aSVlastimil Babka 
5909855609bSRoman Gushchin static inline struct mem_cgroup *memcg_from_slab_obj(void *ptr)
5914d96ba35SRoman Gushchin {
5924d96ba35SRoman Gushchin 	return NULL;
5934d96ba35SRoman Gushchin }
5944d96ba35SRoman Gushchin 
5954b5f8d9aSVlastimil Babka static inline int memcg_alloc_slab_cgroups(struct slab *slab,
5962e9bd483SRoman Gushchin 					       struct kmem_cache *s, gfp_t gfp,
5974b5f8d9aSVlastimil Babka 					       bool new_slab)
598286e04b8SRoman Gushchin {
599286e04b8SRoman Gushchin 	return 0;
600286e04b8SRoman Gushchin }
601286e04b8SRoman Gushchin 
6024b5f8d9aSVlastimil Babka static inline void memcg_free_slab_cgroups(struct slab *slab)
603286e04b8SRoman Gushchin {
604286e04b8SRoman Gushchin }
605286e04b8SRoman Gushchin 
606becaba65SRoman Gushchin static inline bool memcg_slab_pre_alloc_hook(struct kmem_cache *s,
607becaba65SRoman Gushchin 					     struct obj_cgroup **objcgp,
608becaba65SRoman Gushchin 					     size_t objects, gfp_t flags)
609f2fe7b09SRoman Gushchin {
610becaba65SRoman Gushchin 	return true;
611f2fe7b09SRoman Gushchin }
612f2fe7b09SRoman Gushchin 
613964d4bd3SRoman Gushchin static inline void memcg_slab_post_alloc_hook(struct kmem_cache *s,
614964d4bd3SRoman Gushchin 					      struct obj_cgroup *objcg,
61510befea9SRoman Gushchin 					      gfp_t flags, size_t size,
61610befea9SRoman Gushchin 					      void **p)
617964d4bd3SRoman Gushchin {
618964d4bd3SRoman Gushchin }
619964d4bd3SRoman Gushchin 
620d1b2cf6cSBharata B Rao static inline void memcg_slab_free_hook(struct kmem_cache *s,
621d1b2cf6cSBharata B Rao 					void **p, int objects)
622964d4bd3SRoman Gushchin {
623964d4bd3SRoman Gushchin }
62484c07d11SKirill Tkhai #endif /* CONFIG_MEMCG_KMEM */
625b9ce5ef4SGlauber Costa 
626401fb12cSVlastimil Babka #ifndef CONFIG_SLOB
627a64b5378SKees Cook static inline struct kmem_cache *virt_to_cache(const void *obj)
628a64b5378SKees Cook {
62982c1775dSMatthew Wilcox (Oracle) 	struct slab *slab;
630a64b5378SKees Cook 
63182c1775dSMatthew Wilcox (Oracle) 	slab = virt_to_slab(obj);
63282c1775dSMatthew Wilcox (Oracle) 	if (WARN_ONCE(!slab, "%s: Object is not a Slab page!\n",
633a64b5378SKees Cook 					__func__))
634a64b5378SKees Cook 		return NULL;
63582c1775dSMatthew Wilcox (Oracle) 	return slab->slab_cache;
636a64b5378SKees Cook }
637a64b5378SKees Cook 
638b918653bSMatthew Wilcox (Oracle) static __always_inline void account_slab(struct slab *slab, int order,
639b918653bSMatthew Wilcox (Oracle) 					 struct kmem_cache *s, gfp_t gfp)
6406cea1d56SRoman Gushchin {
6412e9bd483SRoman Gushchin 	if (memcg_kmem_enabled() && (s->flags & SLAB_ACCOUNT))
6424b5f8d9aSVlastimil Babka 		memcg_alloc_slab_cgroups(slab, s, gfp, true);
6432e9bd483SRoman Gushchin 
644b918653bSMatthew Wilcox (Oracle) 	mod_node_page_state(slab_pgdat(slab), cache_vmstat_idx(s),
645f2fe7b09SRoman Gushchin 			    PAGE_SIZE << order);
6466cea1d56SRoman Gushchin }
6476cea1d56SRoman Gushchin 
648b918653bSMatthew Wilcox (Oracle) static __always_inline void unaccount_slab(struct slab *slab, int order,
6496cea1d56SRoman Gushchin 					   struct kmem_cache *s)
6506cea1d56SRoman Gushchin {
65110befea9SRoman Gushchin 	if (memcg_kmem_enabled())
6524b5f8d9aSVlastimil Babka 		memcg_free_slab_cgroups(slab);
6539855609bSRoman Gushchin 
654b918653bSMatthew Wilcox (Oracle) 	mod_node_page_state(slab_pgdat(slab), cache_vmstat_idx(s),
655d42f3245SRoman Gushchin 			    -(PAGE_SIZE << order));
6566cea1d56SRoman Gushchin }
6576cea1d56SRoman Gushchin 
658e42f174eSVlastimil Babka static inline struct kmem_cache *cache_from_obj(struct kmem_cache *s, void *x)
659e42f174eSVlastimil Babka {
660e42f174eSVlastimil Babka 	struct kmem_cache *cachep;
661e42f174eSVlastimil Babka 
662e42f174eSVlastimil Babka 	if (!IS_ENABLED(CONFIG_SLAB_FREELIST_HARDENED) &&
663e42f174eSVlastimil Babka 	    !kmem_cache_debug_flags(s, SLAB_CONSISTENCY_CHECKS))
664e42f174eSVlastimil Babka 		return s;
665e42f174eSVlastimil Babka 
666e42f174eSVlastimil Babka 	cachep = virt_to_cache(x);
66710befea9SRoman Gushchin 	if (WARN(cachep && cachep != s,
668e42f174eSVlastimil Babka 		  "%s: Wrong slab cache. %s but object is from %s\n",
669e42f174eSVlastimil Babka 		  __func__, s->name, cachep->name))
670e42f174eSVlastimil Babka 		print_tracking(cachep, x);
671e42f174eSVlastimil Babka 	return cachep;
672e42f174eSVlastimil Babka }
673401fb12cSVlastimil Babka #endif /* CONFIG_SLOB */
674e42f174eSVlastimil Babka 
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,
706964d4bd3SRoman Gushchin 						     struct obj_cgroup **objcgp,
707964d4bd3SRoman Gushchin 						     size_t size, gfp_t flags)
70811c7aec2SJesper Dangaard Brouer {
70911c7aec2SJesper Dangaard Brouer 	flags &= gfp_allowed_mask;
710d92a8cfcSPeter Zijlstra 
71195d6c701SDaniel Vetter 	might_alloc(flags);
71211c7aec2SJesper Dangaard Brouer 
713fab9963aSJesper Dangaard Brouer 	if (should_failslab(s, flags))
71411c7aec2SJesper Dangaard Brouer 		return NULL;
71511c7aec2SJesper Dangaard Brouer 
716becaba65SRoman Gushchin 	if (!memcg_slab_pre_alloc_hook(s, objcgp, size, flags))
717becaba65SRoman Gushchin 		return NULL;
71845264778SVladimir Davydov 
71945264778SVladimir Davydov 	return s;
72011c7aec2SJesper Dangaard Brouer }
72111c7aec2SJesper Dangaard Brouer 
722964d4bd3SRoman Gushchin static inline void slab_post_alloc_hook(struct kmem_cache *s,
723da844b78SAndrey Konovalov 					struct obj_cgroup *objcg, gfp_t flags,
724da844b78SAndrey Konovalov 					size_t size, void **p, bool init)
72511c7aec2SJesper Dangaard Brouer {
72611c7aec2SJesper Dangaard Brouer 	size_t i;
72711c7aec2SJesper Dangaard Brouer 
72811c7aec2SJesper Dangaard Brouer 	flags &= gfp_allowed_mask;
729da844b78SAndrey Konovalov 
730da844b78SAndrey Konovalov 	/*
731da844b78SAndrey Konovalov 	 * As memory initialization might be integrated into KASAN,
732da844b78SAndrey Konovalov 	 * kasan_slab_alloc and initialization memset must be
733da844b78SAndrey Konovalov 	 * kept together to avoid discrepancies in behavior.
734da844b78SAndrey Konovalov 	 *
735da844b78SAndrey Konovalov 	 * As p[i] might get tagged, memset and kmemleak hook come after KASAN.
736da844b78SAndrey Konovalov 	 */
73711c7aec2SJesper Dangaard Brouer 	for (i = 0; i < size; i++) {
738da844b78SAndrey Konovalov 		p[i] = kasan_slab_alloc(s, p[i], flags, init);
739da844b78SAndrey Konovalov 		if (p[i] && init && !kasan_has_integrated_init())
740da844b78SAndrey Konovalov 			memset(p[i], 0, s->object_size);
74153128245SAndrey Konovalov 		kmemleak_alloc_recursive(p[i], s->object_size, 1,
74211c7aec2SJesper Dangaard Brouer 					 s->flags, flags);
74311c7aec2SJesper Dangaard Brouer 	}
74445264778SVladimir Davydov 
74510befea9SRoman Gushchin 	memcg_slab_post_alloc_hook(s, objcg, flags, size, p);
74611c7aec2SJesper Dangaard Brouer }
74711c7aec2SJesper Dangaard Brouer 
74844c5356fSChristoph Lameter #ifndef CONFIG_SLOB
749ca34956bSChristoph Lameter /*
750ca34956bSChristoph Lameter  * The slab lists for all objects.
751ca34956bSChristoph Lameter  */
752ca34956bSChristoph Lameter struct kmem_cache_node {
753ca34956bSChristoph Lameter 	spinlock_t list_lock;
754ca34956bSChristoph Lameter 
755ca34956bSChristoph Lameter #ifdef CONFIG_SLAB
756ca34956bSChristoph Lameter 	struct list_head slabs_partial;	/* partial list first, better asm code */
757ca34956bSChristoph Lameter 	struct list_head slabs_full;
758ca34956bSChristoph Lameter 	struct list_head slabs_free;
759bf00bd34SDavid Rientjes 	unsigned long total_slabs;	/* length of all slab lists */
760bf00bd34SDavid Rientjes 	unsigned long free_slabs;	/* length of free slab list only */
761ca34956bSChristoph Lameter 	unsigned long free_objects;
762ca34956bSChristoph Lameter 	unsigned int free_limit;
763ca34956bSChristoph Lameter 	unsigned int colour_next;	/* Per-node cache coloring */
764ca34956bSChristoph Lameter 	struct array_cache *shared;	/* shared per node */
765c8522a3aSJoonsoo Kim 	struct alien_cache **alien;	/* on other nodes */
766ca34956bSChristoph Lameter 	unsigned long next_reap;	/* updated without locking */
767ca34956bSChristoph Lameter 	int free_touched;		/* updated without locking */
768ca34956bSChristoph Lameter #endif
769ca34956bSChristoph Lameter 
770ca34956bSChristoph Lameter #ifdef CONFIG_SLUB
771ca34956bSChristoph Lameter 	unsigned long nr_partial;
772ca34956bSChristoph Lameter 	struct list_head partial;
773ca34956bSChristoph Lameter #ifdef CONFIG_SLUB_DEBUG
774ca34956bSChristoph Lameter 	atomic_long_t nr_slabs;
775ca34956bSChristoph Lameter 	atomic_long_t total_objects;
776ca34956bSChristoph Lameter 	struct list_head full;
777ca34956bSChristoph Lameter #endif
778ca34956bSChristoph Lameter #endif
779ca34956bSChristoph Lameter 
780ca34956bSChristoph Lameter };
781e25839f6SWanpeng Li 
78244c5356fSChristoph Lameter static inline struct kmem_cache_node *get_node(struct kmem_cache *s, int node)
78344c5356fSChristoph Lameter {
78444c5356fSChristoph Lameter 	return s->node[node];
78544c5356fSChristoph Lameter }
78644c5356fSChristoph Lameter 
78744c5356fSChristoph Lameter /*
78844c5356fSChristoph Lameter  * Iterator over all nodes. The body will be executed for each node that has
78944c5356fSChristoph Lameter  * a kmem_cache_node structure allocated (which is true for all online nodes)
79044c5356fSChristoph Lameter  */
79144c5356fSChristoph Lameter #define for_each_kmem_cache_node(__s, __node, __n) \
7929163582cSMikulas Patocka 	for (__node = 0; __node < nr_node_ids; __node++) \
7939163582cSMikulas Patocka 		 if ((__n = get_node(__s, __node)))
79444c5356fSChristoph Lameter 
79544c5356fSChristoph Lameter #endif
79644c5356fSChristoph Lameter 
7971df3b26fSVladimir Davydov void *slab_start(struct seq_file *m, loff_t *pos);
798276a2439SWanpeng Li void *slab_next(struct seq_file *m, void *p, loff_t *pos);
799276a2439SWanpeng Li void slab_stop(struct seq_file *m, void *p);
800b047501cSVladimir Davydov int memcg_slab_show(struct seq_file *m, void *p);
8015240ab40SAndrey Ryabinin 
802852d8be0SYang Shi #if defined(CONFIG_SLAB) || defined(CONFIG_SLUB_DEBUG)
803852d8be0SYang Shi void dump_unreclaimable_slab(void);
804852d8be0SYang Shi #else
805852d8be0SYang Shi static inline void dump_unreclaimable_slab(void)
806852d8be0SYang Shi {
807852d8be0SYang Shi }
808852d8be0SYang Shi #endif
809852d8be0SYang Shi 
81055834c59SAlexander Potapenko void ___cache_free(struct kmem_cache *cache, void *x, unsigned long addr);
81155834c59SAlexander Potapenko 
8127c00fce9SThomas Garnier #ifdef CONFIG_SLAB_FREELIST_RANDOM
8137c00fce9SThomas Garnier int cache_random_seq_create(struct kmem_cache *cachep, unsigned int count,
8147c00fce9SThomas Garnier 			gfp_t gfp);
8157c00fce9SThomas Garnier void cache_random_seq_destroy(struct kmem_cache *cachep);
8167c00fce9SThomas Garnier #else
8177c00fce9SThomas Garnier static inline int cache_random_seq_create(struct kmem_cache *cachep,
8187c00fce9SThomas Garnier 					unsigned int count, gfp_t gfp)
8197c00fce9SThomas Garnier {
8207c00fce9SThomas Garnier 	return 0;
8217c00fce9SThomas Garnier }
8227c00fce9SThomas Garnier static inline void cache_random_seq_destroy(struct kmem_cache *cachep) { }
8237c00fce9SThomas Garnier #endif /* CONFIG_SLAB_FREELIST_RANDOM */
8247c00fce9SThomas Garnier 
8256471384aSAlexander Potapenko static inline bool slab_want_init_on_alloc(gfp_t flags, struct kmem_cache *c)
8266471384aSAlexander Potapenko {
82751cba1ebSKees Cook 	if (static_branch_maybe(CONFIG_INIT_ON_ALLOC_DEFAULT_ON,
82851cba1ebSKees Cook 				&init_on_alloc)) {
8296471384aSAlexander Potapenko 		if (c->ctor)
8306471384aSAlexander Potapenko 			return false;
8316471384aSAlexander Potapenko 		if (c->flags & (SLAB_TYPESAFE_BY_RCU | SLAB_POISON))
8326471384aSAlexander Potapenko 			return flags & __GFP_ZERO;
8336471384aSAlexander Potapenko 		return true;
8346471384aSAlexander Potapenko 	}
8356471384aSAlexander Potapenko 	return flags & __GFP_ZERO;
8366471384aSAlexander Potapenko }
8376471384aSAlexander Potapenko 
8386471384aSAlexander Potapenko static inline bool slab_want_init_on_free(struct kmem_cache *c)
8396471384aSAlexander Potapenko {
84051cba1ebSKees Cook 	if (static_branch_maybe(CONFIG_INIT_ON_FREE_DEFAULT_ON,
84151cba1ebSKees Cook 				&init_on_free))
8426471384aSAlexander Potapenko 		return !(c->ctor ||
8436471384aSAlexander Potapenko 			 (c->flags & (SLAB_TYPESAFE_BY_RCU | SLAB_POISON)));
8446471384aSAlexander Potapenko 	return false;
8456471384aSAlexander Potapenko }
8466471384aSAlexander Potapenko 
84764dd6849SFaiyaz Mohammed #if defined(CONFIG_DEBUG_FS) && defined(CONFIG_SLUB_DEBUG)
84864dd6849SFaiyaz Mohammed void debugfs_slab_release(struct kmem_cache *);
84964dd6849SFaiyaz Mohammed #else
85064dd6849SFaiyaz Mohammed static inline void debugfs_slab_release(struct kmem_cache *s) { }
85164dd6849SFaiyaz Mohammed #endif
85264dd6849SFaiyaz Mohammed 
8535bb1bb35SPaul E. McKenney #ifdef CONFIG_PRINTK
8548e7f37f2SPaul E. McKenney #define KS_ADDRS_COUNT 16
8558e7f37f2SPaul E. McKenney struct kmem_obj_info {
8568e7f37f2SPaul E. McKenney 	void *kp_ptr;
8577213230aSMatthew Wilcox (Oracle) 	struct slab *kp_slab;
8588e7f37f2SPaul E. McKenney 	void *kp_objp;
8598e7f37f2SPaul E. McKenney 	unsigned long kp_data_offset;
8608e7f37f2SPaul E. McKenney 	struct kmem_cache *kp_slab_cache;
8618e7f37f2SPaul E. McKenney 	void *kp_ret;
8628e7f37f2SPaul E. McKenney 	void *kp_stack[KS_ADDRS_COUNT];
863e548eaa1SManinder Singh 	void *kp_free_stack[KS_ADDRS_COUNT];
8648e7f37f2SPaul E. McKenney };
8657213230aSMatthew Wilcox (Oracle) void kmem_obj_info(struct kmem_obj_info *kpp, void *object, struct slab *slab);
8665bb1bb35SPaul E. McKenney #endif
8678e7f37f2SPaul E. McKenney 
8680b3eb091SMatthew Wilcox (Oracle) #ifdef CONFIG_HAVE_HARDENED_USERCOPY_ALLOCATOR
8690b3eb091SMatthew Wilcox (Oracle) void __check_heap_object(const void *ptr, unsigned long n,
8700b3eb091SMatthew Wilcox (Oracle) 			 const struct slab *slab, bool to_user);
8710b3eb091SMatthew Wilcox (Oracle) #else
8720b3eb091SMatthew Wilcox (Oracle) static inline
8730b3eb091SMatthew Wilcox (Oracle) void __check_heap_object(const void *ptr, unsigned long n,
8740b3eb091SMatthew Wilcox (Oracle) 			 const struct slab *slab, bool to_user)
8750b3eb091SMatthew Wilcox (Oracle) {
8760b3eb091SMatthew Wilcox (Oracle) }
8770b3eb091SMatthew Wilcox (Oracle) #endif
8780b3eb091SMatthew Wilcox (Oracle) 
8795240ab40SAndrey Ryabinin #endif /* MM_SLAB_H */
880