1 /* SPDX-License-Identifier: GPL-2.0 */ 1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* 2 /*
3 * Written by Mark Hemment, 1996 (markhe@nextd 3 * Written by Mark Hemment, 1996 (markhe@nextd.demon.co.uk).
4 * 4 *
5 * (C) SGI 2006, Christoph Lameter 5 * (C) SGI 2006, Christoph Lameter
6 * Cleaned up and restructured to ease th 6 * Cleaned up and restructured to ease the addition of alternative
7 * implementations of SLAB allocators. 7 * implementations of SLAB allocators.
8 * (C) Linux Foundation 2008-2013 8 * (C) Linux Foundation 2008-2013
9 * Unified interface for all slab allocat 9 * Unified interface for all slab allocators
10 */ 10 */
11 11
12 #ifndef _LINUX_SLAB_H 12 #ifndef _LINUX_SLAB_H
13 #define _LINUX_SLAB_H 13 #define _LINUX_SLAB_H
14 14
15 #include <linux/cache.h> 15 #include <linux/cache.h>
16 #include <linux/gfp.h> 16 #include <linux/gfp.h>
17 #include <linux/overflow.h> 17 #include <linux/overflow.h>
18 #include <linux/types.h> 18 #include <linux/types.h>
19 #include <linux/workqueue.h> 19 #include <linux/workqueue.h>
20 #include <linux/percpu-refcount.h> 20 #include <linux/percpu-refcount.h>
21 #include <linux/cleanup.h> 21 #include <linux/cleanup.h>
22 #include <linux/hash.h> 22 #include <linux/hash.h>
23 23
24 enum _slab_flag_bits { <<
25 _SLAB_CONSISTENCY_CHECKS, <<
26 _SLAB_RED_ZONE, <<
27 _SLAB_POISON, <<
28 _SLAB_KMALLOC, <<
29 _SLAB_HWCACHE_ALIGN, <<
30 _SLAB_CACHE_DMA, <<
31 _SLAB_CACHE_DMA32, <<
32 _SLAB_STORE_USER, <<
33 _SLAB_PANIC, <<
34 _SLAB_TYPESAFE_BY_RCU, <<
35 _SLAB_TRACE, <<
36 #ifdef CONFIG_DEBUG_OBJECTS <<
37 _SLAB_DEBUG_OBJECTS, <<
38 #endif <<
39 _SLAB_NOLEAKTRACE, <<
40 _SLAB_NO_MERGE, <<
41 #ifdef CONFIG_FAILSLAB <<
42 _SLAB_FAILSLAB, <<
43 #endif <<
44 #ifdef CONFIG_MEMCG <<
45 _SLAB_ACCOUNT, <<
46 #endif <<
47 #ifdef CONFIG_KASAN_GENERIC <<
48 _SLAB_KASAN, <<
49 #endif <<
50 _SLAB_NO_USER_FLAGS, <<
51 #ifdef CONFIG_KFENCE <<
52 _SLAB_SKIP_KFENCE, <<
53 #endif <<
54 #ifndef CONFIG_SLUB_TINY <<
55 _SLAB_RECLAIM_ACCOUNT, <<
56 #endif <<
57 _SLAB_OBJECT_POISON, <<
58 _SLAB_CMPXCHG_DOUBLE, <<
59 #ifdef CONFIG_SLAB_OBJ_EXT <<
60 _SLAB_NO_OBJ_EXT, <<
61 #endif <<
62 _SLAB_FLAGS_LAST_BIT <<
63 }; <<
64 <<
65 #define __SLAB_FLAG_BIT(nr) ((slab_flags_t <<
66 #define __SLAB_FLAG_UNUSED ((slab_flags_t <<
67 24
68 /* 25 /*
69 * Flags to pass to kmem_cache_create(). 26 * Flags to pass to kmem_cache_create().
70 * The ones marked DEBUG need CONFIG_SLUB_DEBU 27 * The ones marked DEBUG need CONFIG_SLUB_DEBUG enabled, otherwise are no-op
71 */ 28 */
72 /* DEBUG: Perform (expensive) checks on alloc/ 29 /* DEBUG: Perform (expensive) checks on alloc/free */
73 #define SLAB_CONSISTENCY_CHECKS __SLAB_FLAG_BI !! 30 #define SLAB_CONSISTENCY_CHECKS ((slab_flags_t __force)0x00000100U)
74 /* DEBUG: Red zone objs in a cache */ 31 /* DEBUG: Red zone objs in a cache */
75 #define SLAB_RED_ZONE __SLAB_FLAG_BI !! 32 #define SLAB_RED_ZONE ((slab_flags_t __force)0x00000400U)
76 /* DEBUG: Poison objects */ 33 /* DEBUG: Poison objects */
77 #define SLAB_POISON __SLAB_FLAG_BI !! 34 #define SLAB_POISON ((slab_flags_t __force)0x00000800U)
78 /* Indicate a kmalloc slab */ 35 /* Indicate a kmalloc slab */
79 #define SLAB_KMALLOC __SLAB_FLAG_BI !! 36 #define SLAB_KMALLOC ((slab_flags_t __force)0x00001000U)
80 /* Align objs on cache lines */ 37 /* Align objs on cache lines */
81 #define SLAB_HWCACHE_ALIGN __SLAB_FLAG_BI !! 38 #define SLAB_HWCACHE_ALIGN ((slab_flags_t __force)0x00002000U)
82 /* Use GFP_DMA memory */ 39 /* Use GFP_DMA memory */
83 #define SLAB_CACHE_DMA __SLAB_FLAG_BI !! 40 #define SLAB_CACHE_DMA ((slab_flags_t __force)0x00004000U)
84 /* Use GFP_DMA32 memory */ 41 /* Use GFP_DMA32 memory */
85 #define SLAB_CACHE_DMA32 __SLAB_FLAG_BI !! 42 #define SLAB_CACHE_DMA32 ((slab_flags_t __force)0x00008000U)
86 /* DEBUG: Store the last owner for bug hunting 43 /* DEBUG: Store the last owner for bug hunting */
87 #define SLAB_STORE_USER __SLAB_FLAG_BI !! 44 #define SLAB_STORE_USER ((slab_flags_t __force)0x00010000U)
88 /* Panic if kmem_cache_create() fails */ 45 /* Panic if kmem_cache_create() fails */
89 #define SLAB_PANIC __SLAB_FLAG_BI !! 46 #define SLAB_PANIC ((slab_flags_t __force)0x00040000U)
90 /* 47 /*
91 * SLAB_TYPESAFE_BY_RCU - **WARNING** READ THI 48 * SLAB_TYPESAFE_BY_RCU - **WARNING** READ THIS!
92 * 49 *
93 * This delays freeing the SLAB page by a grac 50 * This delays freeing the SLAB page by a grace period, it does _NOT_
94 * delay object freeing. This means that if yo 51 * delay object freeing. This means that if you do kmem_cache_free()
95 * that memory location is free to be reused a 52 * that memory location is free to be reused at any time. Thus it may
96 * be possible to see another object there in 53 * be possible to see another object there in the same RCU grace period.
97 * 54 *
98 * This feature only ensures the memory locati 55 * This feature only ensures the memory location backing the object
99 * stays valid, the trick to using this is rel 56 * stays valid, the trick to using this is relying on an independent
100 * object validation pass. Something like: 57 * object validation pass. Something like:
101 * 58 *
102 * begin: 59 * begin:
103 * rcu_read_lock(); 60 * rcu_read_lock();
104 * obj = lockless_lookup(key); 61 * obj = lockless_lookup(key);
105 * if (obj) { 62 * if (obj) {
106 * if (!try_get_ref(obj)) // might fail for 63 * if (!try_get_ref(obj)) // might fail for free objects
107 * rcu_read_unlock(); 64 * rcu_read_unlock();
108 * goto begin; 65 * goto begin;
109 * 66 *
110 * if (obj->key != key) { // not the object 67 * if (obj->key != key) { // not the object we expected
111 * put_ref(obj); 68 * put_ref(obj);
112 * rcu_read_unlock(); 69 * rcu_read_unlock();
113 * goto begin; 70 * goto begin;
114 * } 71 * }
115 * } 72 * }
116 * rcu_read_unlock(); 73 * rcu_read_unlock();
117 * 74 *
118 * This is useful if we need to approach a ker 75 * This is useful if we need to approach a kernel structure obliquely,
119 * from its address obtained without the usual 76 * from its address obtained without the usual locking. We can lock
120 * the structure to stabilize it and check it' 77 * the structure to stabilize it and check it's still at the given address,
121 * only if we can be sure that the memory has 78 * only if we can be sure that the memory has not been meanwhile reused
122 * for some other kind of object (which our su 79 * for some other kind of object (which our subsystem's lock might corrupt).
123 * 80 *
124 * rcu_read_lock before reading the address, t 81 * rcu_read_lock before reading the address, then rcu_read_unlock after
125 * taking the spinlock within the structure ex 82 * taking the spinlock within the structure expected at that address.
126 * 83 *
127 * Note that it is not possible to acquire a l 84 * Note that it is not possible to acquire a lock within a structure
128 * allocated with SLAB_TYPESAFE_BY_RCU without 85 * allocated with SLAB_TYPESAFE_BY_RCU without first acquiring a reference
129 * as described above. The reason is that SLA 86 * as described above. The reason is that SLAB_TYPESAFE_BY_RCU pages
130 * are not zeroed before being given to the sl 87 * are not zeroed before being given to the slab, which means that any
131 * locks must be initialized after each and ev 88 * locks must be initialized after each and every kmem_struct_alloc().
132 * Alternatively, make the ctor passed to kmem 89 * Alternatively, make the ctor passed to kmem_cache_create() initialize
133 * the locks at page-allocation time, as is do 90 * the locks at page-allocation time, as is done in __i915_request_ctor(),
134 * sighand_ctor(), and anon_vma_ctor(). Such 91 * sighand_ctor(), and anon_vma_ctor(). Such a ctor permits readers
135 * to safely acquire those ctor-initialized lo 92 * to safely acquire those ctor-initialized locks under rcu_read_lock()
136 * protection. 93 * protection.
137 * 94 *
138 * Note that SLAB_TYPESAFE_BY_RCU was original 95 * Note that SLAB_TYPESAFE_BY_RCU was originally named SLAB_DESTROY_BY_RCU.
139 */ 96 */
140 /* Defer freeing slabs to RCU */ 97 /* Defer freeing slabs to RCU */
141 #define SLAB_TYPESAFE_BY_RCU __SLAB_FLAG_BI !! 98 #define SLAB_TYPESAFE_BY_RCU ((slab_flags_t __force)0x00080000U)
>> 99 /* Spread some memory over cpuset */
>> 100 #define SLAB_MEM_SPREAD ((slab_flags_t __force)0x00100000U)
142 /* Trace allocations and frees */ 101 /* Trace allocations and frees */
143 #define SLAB_TRACE __SLAB_FLAG_BI !! 102 #define SLAB_TRACE ((slab_flags_t __force)0x00200000U)
144 103
145 /* Flag to prevent checks on free */ 104 /* Flag to prevent checks on free */
146 #ifdef CONFIG_DEBUG_OBJECTS 105 #ifdef CONFIG_DEBUG_OBJECTS
147 # define SLAB_DEBUG_OBJECTS __SLAB_FLAG_BI !! 106 # define SLAB_DEBUG_OBJECTS ((slab_flags_t __force)0x00400000U)
148 #else 107 #else
149 # define SLAB_DEBUG_OBJECTS __SLAB_FLAG_UN !! 108 # define SLAB_DEBUG_OBJECTS 0
150 #endif 109 #endif
151 110
152 /* Avoid kmemleak tracing */ 111 /* Avoid kmemleak tracing */
153 #define SLAB_NOLEAKTRACE __SLAB_FLAG_BI !! 112 #define SLAB_NOLEAKTRACE ((slab_flags_t __force)0x00800000U)
154 113
155 /* 114 /*
156 * Prevent merging with compatible kmem caches 115 * Prevent merging with compatible kmem caches. This flag should be used
157 * cautiously. Valid use cases: 116 * cautiously. Valid use cases:
158 * 117 *
159 * - caches created for self-tests (e.g. kunit 118 * - caches created for self-tests (e.g. kunit)
160 * - general caches created and used by a subs 119 * - general caches created and used by a subsystem, only when a
161 * (subsystem-specific) debug option is enab 120 * (subsystem-specific) debug option is enabled
162 * - performance critical caches, should be ve 121 * - performance critical caches, should be very rare and consulted with slab
163 * maintainers, and not used together with C 122 * maintainers, and not used together with CONFIG_SLUB_TINY
164 */ 123 */
165 #define SLAB_NO_MERGE __SLAB_FLAG_BI !! 124 #define SLAB_NO_MERGE ((slab_flags_t __force)0x01000000U)
166 125
167 /* Fault injection mark */ 126 /* Fault injection mark */
168 #ifdef CONFIG_FAILSLAB 127 #ifdef CONFIG_FAILSLAB
169 # define SLAB_FAILSLAB __SLAB_FLAG_BI !! 128 # define SLAB_FAILSLAB ((slab_flags_t __force)0x02000000U)
170 #else 129 #else
171 # define SLAB_FAILSLAB __SLAB_FLAG_UN !! 130 # define SLAB_FAILSLAB 0
172 #endif 131 #endif
173 /* Account to memcg */ 132 /* Account to memcg */
174 #ifdef CONFIG_MEMCG !! 133 #ifdef CONFIG_MEMCG_KMEM
175 # define SLAB_ACCOUNT __SLAB_FLAG_BI !! 134 # define SLAB_ACCOUNT ((slab_flags_t __force)0x04000000U)
176 #else 135 #else
177 # define SLAB_ACCOUNT __SLAB_FLAG_UN !! 136 # define SLAB_ACCOUNT 0
178 #endif 137 #endif
179 138
180 #ifdef CONFIG_KASAN_GENERIC 139 #ifdef CONFIG_KASAN_GENERIC
181 #define SLAB_KASAN __SLAB_FLAG_BI !! 140 #define SLAB_KASAN ((slab_flags_t __force)0x08000000U)
182 #else 141 #else
183 #define SLAB_KASAN __SLAB_FLAG_UN !! 142 #define SLAB_KASAN 0
184 #endif 143 #endif
185 144
186 /* 145 /*
187 * Ignore user specified debugging flags. 146 * Ignore user specified debugging flags.
188 * Intended for caches created for self-tests 147 * Intended for caches created for self-tests so they have only flags
189 * specified in the code and other flags are i 148 * specified in the code and other flags are ignored.
190 */ 149 */
191 #define SLAB_NO_USER_FLAGS __SLAB_FLAG_BI !! 150 #define SLAB_NO_USER_FLAGS ((slab_flags_t __force)0x10000000U)
192 151
193 #ifdef CONFIG_KFENCE 152 #ifdef CONFIG_KFENCE
194 #define SLAB_SKIP_KFENCE __SLAB_FLAG_BI !! 153 #define SLAB_SKIP_KFENCE ((slab_flags_t __force)0x20000000U)
195 #else 154 #else
196 #define SLAB_SKIP_KFENCE __SLAB_FLAG_UN !! 155 #define SLAB_SKIP_KFENCE 0
197 #endif 156 #endif
198 157
199 /* The following flags affect the page allocat 158 /* The following flags affect the page allocator grouping pages by mobility */
200 /* Objects are reclaimable */ 159 /* Objects are reclaimable */
201 #ifndef CONFIG_SLUB_TINY 160 #ifndef CONFIG_SLUB_TINY
202 #define SLAB_RECLAIM_ACCOUNT __SLAB_FLAG_BI !! 161 #define SLAB_RECLAIM_ACCOUNT ((slab_flags_t __force)0x00020000U)
203 #else 162 #else
204 #define SLAB_RECLAIM_ACCOUNT __SLAB_FLAG_UN !! 163 #define SLAB_RECLAIM_ACCOUNT ((slab_flags_t __force)0)
205 #endif 164 #endif
206 #define SLAB_TEMPORARY SLAB_RECLAIM_A 165 #define SLAB_TEMPORARY SLAB_RECLAIM_ACCOUNT /* Objects are short-lived */
207 166
208 /* Slab created using create_boot_cache */ <<
209 #ifdef CONFIG_SLAB_OBJ_EXT <<
210 #define SLAB_NO_OBJ_EXT __SLAB_FLAG_BI <<
211 #else <<
212 #define SLAB_NO_OBJ_EXT __SLAB_FLAG_UN <<
213 #endif <<
214 <<
215 /* <<
216 * freeptr_t represents a SLUB freelist pointe <<
217 * and not dereferenceable if CONFIG_SLAB_FREE <<
218 */ <<
219 typedef struct { unsigned long v; } freeptr_t; <<
220 <<
221 /* 167 /*
222 * ZERO_SIZE_PTR will be returned for zero siz 168 * ZERO_SIZE_PTR will be returned for zero sized kmalloc requests.
223 * 169 *
224 * Dereferencing ZERO_SIZE_PTR will lead to a 170 * Dereferencing ZERO_SIZE_PTR will lead to a distinct access fault.
225 * 171 *
226 * ZERO_SIZE_PTR can be passed to kfree though 172 * ZERO_SIZE_PTR can be passed to kfree though in the same way that NULL can.
227 * Both make kfree a no-op. 173 * Both make kfree a no-op.
228 */ 174 */
229 #define ZERO_SIZE_PTR ((void *)16) 175 #define ZERO_SIZE_PTR ((void *)16)
230 176
231 #define ZERO_OR_NULL_PTR(x) ((unsigned long)(x 177 #define ZERO_OR_NULL_PTR(x) ((unsigned long)(x) <= \
232 (unsigned long 178 (unsigned long)ZERO_SIZE_PTR)
233 179
234 #include <linux/kasan.h> 180 #include <linux/kasan.h>
235 181
236 struct list_lru; 182 struct list_lru;
237 struct mem_cgroup; 183 struct mem_cgroup;
238 /* 184 /*
239 * struct kmem_cache related prototypes 185 * struct kmem_cache related prototypes
240 */ 186 */
241 bool slab_is_available(void); 187 bool slab_is_available(void);
242 188
243 /** !! 189 struct kmem_cache *kmem_cache_create(const char *name, unsigned int size,
244 * struct kmem_cache_args - Less common argume !! 190 unsigned int align, slab_flags_t flags,
245 * !! 191 void (*ctor)(void *));
246 * Any uninitialized fields of the structure a !! 192 struct kmem_cache *kmem_cache_create_usercopy(const char *name,
247 * exception is @freeptr_offset where %0 is a !! 193 unsigned int size, unsigned int align,
248 * @use_freeptr_offset must be also set to %tr !! 194 slab_flags_t flags,
249 * as used. For @useroffset %0 is also valid, !! 195 unsigned int useroffset, unsigned int usersize,
250 * @usersize. !! 196 void (*ctor)(void *));
251 * <<
252 * When %NULL args is passed to kmem_cache_cre <<
253 * fields unused. <<
254 */ <<
255 struct kmem_cache_args { <<
256 /** <<
257 * @align: The required alignment for <<
258 * <<
259 * %0 means no specific alignment is r <<
260 */ <<
261 unsigned int align; <<
262 /** <<
263 * @useroffset: Usercopy region offset <<
264 * <<
265 * %0 is a valid offset, when @usersiz <<
266 */ <<
267 unsigned int useroffset; <<
268 /** <<
269 * @usersize: Usercopy region size. <<
270 * <<
271 * %0 means no usercopy region is spec <<
272 */ <<
273 unsigned int usersize; <<
274 /** <<
275 * @freeptr_offset: Custom offset for <<
276 * in &SLAB_TYPESAFE_BY_RCU caches <<
277 * <<
278 * By default &SLAB_TYPESAFE_BY_RCU ca <<
279 * outside of the object. This might c <<
280 * Cache creators that have a reason t <<
281 * free pointer offset in their struct <<
282 * placed. <<
283 * <<
284 * Note that placing the free pointer <<
285 * caller to ensure that no fields are <<
286 * guard against object recycling (See <<
287 * details). <<
288 * <<
289 * Using %0 as a value for @freeptr_of <<
290 * is specified, %use_freeptr_offset m <<
291 * <<
292 * Note that @ctor currently isn't sup <<
293 * as a @ctor requires an external fre <<
294 */ <<
295 unsigned int freeptr_offset; <<
296 /** <<
297 * @use_freeptr_offset: Whether a @fre <<
298 */ <<
299 bool use_freeptr_offset; <<
300 /** <<
301 * @ctor: A constructor for the object <<
302 * <<
303 * The constructor is invoked for each <<
304 * page. It is the cache user's respon <<
305 * same state as after calling the con <<
306 * with any differences between a fres <<
307 * object. <<
308 * <<
309 * %NULL means no constructor. <<
310 */ <<
311 void (*ctor)(void *); <<
312 }; <<
313 <<
314 struct kmem_cache *__kmem_cache_create_args(co <<
315 un <<
316 st <<
317 sl <<
318 static inline struct kmem_cache * <<
319 __kmem_cache_create(const char *name, unsigned <<
320 slab_flags_t flags, void ( <<
321 { <<
322 struct kmem_cache_args kmem_args = { <<
323 .align = align, <<
324 .ctor = ctor, <<
325 }; <<
326 <<
327 return __kmem_cache_create_args(name, <<
328 } <<
329 <<
330 /** <<
331 * kmem_cache_create_usercopy - Create a kmem <<
332 * for copying to userspace. <<
333 * @name: A string which is used in /proc/slab <<
334 * @size: The size of objects to be created in <<
335 * @align: The required alignment for the obje <<
336 * @flags: SLAB flags <<
337 * @useroffset: Usercopy region offset <<
338 * @usersize: Usercopy region size <<
339 * @ctor: A constructor for the objects, or %N <<
340 * <<
341 * This is a legacy wrapper, new code should u <<
342 * if whitelisting a single field is sufficien <<
343 * the necessary parameters passed via the arg <<
344 * &struct kmem_cache_args) <<
345 * <<
346 * Return: a pointer to the cache on success, <<
347 */ <<
348 static inline struct kmem_cache * <<
349 kmem_cache_create_usercopy(const char *name, u <<
350 unsigned int align, <<
351 unsigned int userof <<
352 void (*ctor)(void * <<
353 { <<
354 struct kmem_cache_args kmem_args = { <<
355 .align = align, <<
356 .ctor = ctor, <<
357 .useroffset = useroffset, <<
358 .usersize = usersize, <<
359 }; <<
360 <<
361 return __kmem_cache_create_args(name, <<
362 } <<
363 <<
364 /* If NULL is passed for @args, use this varia <<
365 static inline struct kmem_cache * <<
366 __kmem_cache_default_args(const char *name, un <<
367 struct kmem_cache_ar <<
368 slab_flags_t flags) <<
369 { <<
370 struct kmem_cache_args kmem_default_ar <<
371 <<
372 /* Make sure we don't get passed garba <<
373 if (WARN_ON_ONCE(args)) <<
374 return ERR_PTR(-EINVAL); <<
375 <<
376 return __kmem_cache_create_args(name, <<
377 } <<
378 <<
379 /** <<
380 * kmem_cache_create - Create a kmem cache. <<
381 * @__name: A string which is used in /proc/sl <<
382 * @__object_size: The size of objects to be c <<
383 * @__args: Optional arguments, see &struct km <<
384 * means defaults will be used for al <<
385 * <<
386 * This is currently implemented as a macro us <<
387 * either the new variant of the function, or <<
388 * <<
389 * The new variant has 4 parameters: <<
390 * ``kmem_cache_create(name, object_size, args <<
391 * <<
392 * See __kmem_cache_create_args() which implem <<
393 * <<
394 * The legacy variant has 5 parameters: <<
395 * ``kmem_cache_create(name, object_size, alig <<
396 * <<
397 * The align and ctor parameters map to the re <<
398 * &struct kmem_cache_args <<
399 * <<
400 * Context: Cannot be called within a interrup <<
401 * <<
402 * Return: a pointer to the cache on success, <<
403 */ <<
404 #define kmem_cache_create(__name, __object_siz <<
405 _Generic((__args), <<
406 struct kmem_cache_args *: __km <<
407 void *: __kmem_cache_default_a <<
408 default: __kmem_cache_create)( <<
409 <<
410 void kmem_cache_destroy(struct kmem_cache *s); 197 void kmem_cache_destroy(struct kmem_cache *s);
411 int kmem_cache_shrink(struct kmem_cache *s); 198 int kmem_cache_shrink(struct kmem_cache *s);
412 199
413 /* 200 /*
414 * Please use this macro to create slab caches 201 * Please use this macro to create slab caches. Simply specify the
415 * name of the structure and maybe some flags 202 * name of the structure and maybe some flags that are listed above.
416 * 203 *
417 * The alignment of the struct determines obje 204 * The alignment of the struct determines object alignment. If you
418 * f.e. add ____cacheline_aligned_in_smp to th 205 * f.e. add ____cacheline_aligned_in_smp to the struct declaration
419 * then the objects will be properly aligned i 206 * then the objects will be properly aligned in SMP configurations.
420 */ 207 */
421 #define KMEM_CACHE(__struct, __flags) !! 208 #define KMEM_CACHE(__struct, __flags) \
422 __kmem_cache_create_args(#__struct, si !! 209 kmem_cache_create(#__struct, sizeof(struct __struct), \
423 &(struct kmem_cache_ar !! 210 __alignof__(struct __struct), (__flags), NULL)
424 .align = __al <<
425 }, (__flags)) <<
426 211
427 /* 212 /*
428 * To whitelist a single field for copying to/ 213 * To whitelist a single field for copying to/from usercopy, use this
429 * macro instead for KMEM_CACHE() above. 214 * macro instead for KMEM_CACHE() above.
430 */ 215 */
431 #define KMEM_CACHE_USERCOPY(__struct, __flags, !! 216 #define KMEM_CACHE_USERCOPY(__struct, __flags, __field) \
432 __kmem_cache_create_args(#__struct, si !! 217 kmem_cache_create_usercopy(#__struct, \
433 &(struct kmem_cache_ar !! 218 sizeof(struct __struct), \
434 .align !! 219 __alignof__(struct __struct), (__flags), \
435 .useroffset !! 220 offsetof(struct __struct, __field), \
436 .usersize !! 221 sizeof_field(struct __struct, __field), NULL)
437 }, (__flags)) <<
438 222
439 /* 223 /*
440 * Common kmalloc functions provided by all al 224 * Common kmalloc functions provided by all allocators
441 */ 225 */
442 void * __must_check krealloc_noprof(const void !! 226 void * __must_check krealloc(const void *objp, size_t new_size, gfp_t flags) __realloc_size(2);
443 gfp_t flag <<
444 #define krealloc(...) <<
445 <<
446 void kfree(const void *objp); 227 void kfree(const void *objp);
447 void kfree_sensitive(const void *objp); 228 void kfree_sensitive(const void *objp);
448 size_t __ksize(const void *objp); 229 size_t __ksize(const void *objp);
449 230
450 DEFINE_FREE(kfree, void *, if (!IS_ERR_OR_NULL 231 DEFINE_FREE(kfree, void *, if (!IS_ERR_OR_NULL(_T)) kfree(_T))
451 232
452 /** 233 /**
453 * ksize - Report actual allocation size of as 234 * ksize - Report actual allocation size of associated object
454 * 235 *
455 * @objp: Pointer returned from a prior kmallo 236 * @objp: Pointer returned from a prior kmalloc()-family allocation.
456 * 237 *
457 * This should not be used for writing beyond 238 * This should not be used for writing beyond the originally requested
458 * allocation size. Either use krealloc() or r 239 * allocation size. Either use krealloc() or round up the allocation size
459 * with kmalloc_size_roundup() prior to alloca 240 * with kmalloc_size_roundup() prior to allocation. If this is used to
460 * access beyond the originally requested allo 241 * access beyond the originally requested allocation size, UBSAN_BOUNDS
461 * and/or FORTIFY_SOURCE may trip, since they 242 * and/or FORTIFY_SOURCE may trip, since they only know about the
462 * originally allocated size via the __alloc_s 243 * originally allocated size via the __alloc_size attribute.
463 */ 244 */
464 size_t ksize(const void *objp); 245 size_t ksize(const void *objp);
465 246
466 #ifdef CONFIG_PRINTK 247 #ifdef CONFIG_PRINTK
467 bool kmem_dump_obj(void *object); 248 bool kmem_dump_obj(void *object);
468 #else 249 #else
469 static inline bool kmem_dump_obj(void *object) 250 static inline bool kmem_dump_obj(void *object) { return false; }
470 #endif 251 #endif
471 252
472 /* 253 /*
473 * Some archs want to perform DMA into kmalloc 254 * Some archs want to perform DMA into kmalloc caches and need a guaranteed
474 * alignment larger than the alignment of a 64 255 * alignment larger than the alignment of a 64-bit integer.
475 * Setting ARCH_DMA_MINALIGN in arch headers a 256 * Setting ARCH_DMA_MINALIGN in arch headers allows that.
476 */ 257 */
477 #ifdef ARCH_HAS_DMA_MINALIGN 258 #ifdef ARCH_HAS_DMA_MINALIGN
478 #if ARCH_DMA_MINALIGN > 8 && !defined(ARCH_KMA 259 #if ARCH_DMA_MINALIGN > 8 && !defined(ARCH_KMALLOC_MINALIGN)
479 #define ARCH_KMALLOC_MINALIGN ARCH_DMA_MINALIG 260 #define ARCH_KMALLOC_MINALIGN ARCH_DMA_MINALIGN
480 #endif 261 #endif
481 #endif 262 #endif
482 263
483 #ifndef ARCH_KMALLOC_MINALIGN 264 #ifndef ARCH_KMALLOC_MINALIGN
484 #define ARCH_KMALLOC_MINALIGN __alignof__(unsi 265 #define ARCH_KMALLOC_MINALIGN __alignof__(unsigned long long)
485 #elif ARCH_KMALLOC_MINALIGN > 8 266 #elif ARCH_KMALLOC_MINALIGN > 8
486 #define KMALLOC_MIN_SIZE ARCH_KMALLOC_MINALIGN 267 #define KMALLOC_MIN_SIZE ARCH_KMALLOC_MINALIGN
487 #define KMALLOC_SHIFT_LOW ilog2(KMALLOC_MIN_SI 268 #define KMALLOC_SHIFT_LOW ilog2(KMALLOC_MIN_SIZE)
488 #endif 269 #endif
489 270
490 /* 271 /*
491 * Setting ARCH_SLAB_MINALIGN in arch headers 272 * Setting ARCH_SLAB_MINALIGN in arch headers allows a different alignment.
492 * Intended for arches that get misalignment f 273 * Intended for arches that get misalignment faults even for 64 bit integer
493 * aligned buffers. 274 * aligned buffers.
494 */ 275 */
495 #ifndef ARCH_SLAB_MINALIGN 276 #ifndef ARCH_SLAB_MINALIGN
496 #define ARCH_SLAB_MINALIGN __alignof__(unsigne 277 #define ARCH_SLAB_MINALIGN __alignof__(unsigned long long)
497 #endif 278 #endif
498 279
499 /* 280 /*
500 * Arches can define this function if they wan 281 * Arches can define this function if they want to decide the minimum slab
501 * alignment at runtime. The value returned by 282 * alignment at runtime. The value returned by the function must be a power
502 * of two and >= ARCH_SLAB_MINALIGN. 283 * of two and >= ARCH_SLAB_MINALIGN.
503 */ 284 */
504 #ifndef arch_slab_minalign 285 #ifndef arch_slab_minalign
505 static inline unsigned int arch_slab_minalign( 286 static inline unsigned int arch_slab_minalign(void)
506 { 287 {
507 return ARCH_SLAB_MINALIGN; 288 return ARCH_SLAB_MINALIGN;
508 } 289 }
509 #endif 290 #endif
510 291
511 /* 292 /*
512 * kmem_cache_alloc and friends return pointer 293 * kmem_cache_alloc and friends return pointers aligned to ARCH_SLAB_MINALIGN.
513 * kmalloc and friends return pointers aligned 294 * kmalloc and friends return pointers aligned to both ARCH_KMALLOC_MINALIGN
514 * and ARCH_SLAB_MINALIGN, but here we only as 295 * and ARCH_SLAB_MINALIGN, but here we only assume the former alignment.
515 */ 296 */
516 #define __assume_kmalloc_alignment __assume_al 297 #define __assume_kmalloc_alignment __assume_aligned(ARCH_KMALLOC_MINALIGN)
517 #define __assume_slab_alignment __assume_align 298 #define __assume_slab_alignment __assume_aligned(ARCH_SLAB_MINALIGN)
518 #define __assume_page_alignment __assume_align 299 #define __assume_page_alignment __assume_aligned(PAGE_SIZE)
519 300
520 /* 301 /*
521 * Kmalloc array related definitions 302 * Kmalloc array related definitions
522 */ 303 */
523 304
524 /* 305 /*
525 * SLUB directly allocates requests fitting in 306 * SLUB directly allocates requests fitting in to an order-1 page
526 * (PAGE_SIZE*2). Larger requests are passed 307 * (PAGE_SIZE*2). Larger requests are passed to the page allocator.
527 */ 308 */
528 #define KMALLOC_SHIFT_HIGH (PAGE_SHIFT + 309 #define KMALLOC_SHIFT_HIGH (PAGE_SHIFT + 1)
529 #define KMALLOC_SHIFT_MAX (MAX_PAGE_ORDE 310 #define KMALLOC_SHIFT_MAX (MAX_PAGE_ORDER + PAGE_SHIFT)
530 #ifndef KMALLOC_SHIFT_LOW 311 #ifndef KMALLOC_SHIFT_LOW
531 #define KMALLOC_SHIFT_LOW 3 312 #define KMALLOC_SHIFT_LOW 3
532 #endif 313 #endif
533 314
534 /* Maximum allocatable size */ 315 /* Maximum allocatable size */
535 #define KMALLOC_MAX_SIZE (1UL << KMALLO 316 #define KMALLOC_MAX_SIZE (1UL << KMALLOC_SHIFT_MAX)
536 /* Maximum size for which we actually use a sl 317 /* Maximum size for which we actually use a slab cache */
537 #define KMALLOC_MAX_CACHE_SIZE (1UL << KMALLO 318 #define KMALLOC_MAX_CACHE_SIZE (1UL << KMALLOC_SHIFT_HIGH)
538 /* Maximum order allocatable via the slab allo 319 /* Maximum order allocatable via the slab allocator */
539 #define KMALLOC_MAX_ORDER (KMALLOC_SHIFT 320 #define KMALLOC_MAX_ORDER (KMALLOC_SHIFT_MAX - PAGE_SHIFT)
540 321
541 /* 322 /*
542 * Kmalloc subsystem. 323 * Kmalloc subsystem.
543 */ 324 */
544 #ifndef KMALLOC_MIN_SIZE 325 #ifndef KMALLOC_MIN_SIZE
545 #define KMALLOC_MIN_SIZE (1 << KMALLOC_SHIFT_L 326 #define KMALLOC_MIN_SIZE (1 << KMALLOC_SHIFT_LOW)
546 #endif 327 #endif
547 328
548 /* 329 /*
549 * This restriction comes from byte sized inde 330 * This restriction comes from byte sized index implementation.
550 * Page size is normally 2^12 bytes and, in th 331 * Page size is normally 2^12 bytes and, in this case, if we want to use
551 * byte sized index which can represent 2^8 en 332 * byte sized index which can represent 2^8 entries, the size of the object
552 * should be equal or greater to 2^12 / 2^8 = 333 * should be equal or greater to 2^12 / 2^8 = 2^4 = 16.
553 * If minimum size of kmalloc is less than 16, 334 * If minimum size of kmalloc is less than 16, we use it as minimum object
554 * size and give up to use byte sized index. 335 * size and give up to use byte sized index.
555 */ 336 */
556 #define SLAB_OBJ_MIN_SIZE (KMALLOC_MIN_SI 337 #define SLAB_OBJ_MIN_SIZE (KMALLOC_MIN_SIZE < 16 ? \
557 (KMALLOC_MIN_SI 338 (KMALLOC_MIN_SIZE) : 16)
558 339
559 #ifdef CONFIG_RANDOM_KMALLOC_CACHES 340 #ifdef CONFIG_RANDOM_KMALLOC_CACHES
560 #define RANDOM_KMALLOC_CACHES_NR 15 // 341 #define RANDOM_KMALLOC_CACHES_NR 15 // # of cache copies
561 #else 342 #else
562 #define RANDOM_KMALLOC_CACHES_NR 0 343 #define RANDOM_KMALLOC_CACHES_NR 0
563 #endif 344 #endif
564 345
565 /* 346 /*
566 * Whenever changing this, take care of that k 347 * Whenever changing this, take care of that kmalloc_type() and
567 * create_kmalloc_caches() still work as inten 348 * create_kmalloc_caches() still work as intended.
568 * 349 *
569 * KMALLOC_NORMAL can contain only unaccounted 350 * KMALLOC_NORMAL can contain only unaccounted objects whereas KMALLOC_CGROUP
570 * is for accounted but unreclaimable and non- 351 * is for accounted but unreclaimable and non-dma objects. All the other
571 * kmem caches can have both accounted and una 352 * kmem caches can have both accounted and unaccounted objects.
572 */ 353 */
573 enum kmalloc_cache_type { 354 enum kmalloc_cache_type {
574 KMALLOC_NORMAL = 0, 355 KMALLOC_NORMAL = 0,
575 #ifndef CONFIG_ZONE_DMA 356 #ifndef CONFIG_ZONE_DMA
576 KMALLOC_DMA = KMALLOC_NORMAL, 357 KMALLOC_DMA = KMALLOC_NORMAL,
577 #endif 358 #endif
578 #ifndef CONFIG_MEMCG !! 359 #ifndef CONFIG_MEMCG_KMEM
579 KMALLOC_CGROUP = KMALLOC_NORMAL, 360 KMALLOC_CGROUP = KMALLOC_NORMAL,
580 #endif 361 #endif
581 KMALLOC_RANDOM_START = KMALLOC_NORMAL, 362 KMALLOC_RANDOM_START = KMALLOC_NORMAL,
582 KMALLOC_RANDOM_END = KMALLOC_RANDOM_ST 363 KMALLOC_RANDOM_END = KMALLOC_RANDOM_START + RANDOM_KMALLOC_CACHES_NR,
583 #ifdef CONFIG_SLUB_TINY 364 #ifdef CONFIG_SLUB_TINY
584 KMALLOC_RECLAIM = KMALLOC_NORMAL, 365 KMALLOC_RECLAIM = KMALLOC_NORMAL,
585 #else 366 #else
586 KMALLOC_RECLAIM, 367 KMALLOC_RECLAIM,
587 #endif 368 #endif
588 #ifdef CONFIG_ZONE_DMA 369 #ifdef CONFIG_ZONE_DMA
589 KMALLOC_DMA, 370 KMALLOC_DMA,
590 #endif 371 #endif
591 #ifdef CONFIG_MEMCG !! 372 #ifdef CONFIG_MEMCG_KMEM
592 KMALLOC_CGROUP, 373 KMALLOC_CGROUP,
593 #endif 374 #endif
594 NR_KMALLOC_TYPES 375 NR_KMALLOC_TYPES
595 }; 376 };
596 377
597 typedef struct kmem_cache * kmem_buckets[KMALL !! 378 extern struct kmem_cache *
598 !! 379 kmalloc_caches[NR_KMALLOC_TYPES][KMALLOC_SHIFT_HIGH + 1];
599 extern kmem_buckets kmalloc_caches[NR_KMALLOC_ <<
600 380
601 /* 381 /*
602 * Define gfp bits that should not be set for 382 * Define gfp bits that should not be set for KMALLOC_NORMAL.
603 */ 383 */
604 #define KMALLOC_NOT_NORMAL_BITS 384 #define KMALLOC_NOT_NORMAL_BITS \
605 (__GFP_RECLAIMABLE | 385 (__GFP_RECLAIMABLE | \
606 (IS_ENABLED(CONFIG_ZONE_DMA) ? __GFP 386 (IS_ENABLED(CONFIG_ZONE_DMA) ? __GFP_DMA : 0) | \
607 (IS_ENABLED(CONFIG_MEMCG) ? __GFP_ACCO !! 387 (IS_ENABLED(CONFIG_MEMCG_KMEM) ? __GFP_ACCOUNT : 0))
608 388
609 extern unsigned long random_kmalloc_seed; 389 extern unsigned long random_kmalloc_seed;
610 390
611 static __always_inline enum kmalloc_cache_type 391 static __always_inline enum kmalloc_cache_type kmalloc_type(gfp_t flags, unsigned long caller)
612 { 392 {
613 /* 393 /*
614 * The most common case is KMALLOC_NOR 394 * The most common case is KMALLOC_NORMAL, so test for it
615 * with a single branch for all the re 395 * with a single branch for all the relevant flags.
616 */ 396 */
617 if (likely((flags & KMALLOC_NOT_NORMAL 397 if (likely((flags & KMALLOC_NOT_NORMAL_BITS) == 0))
618 #ifdef CONFIG_RANDOM_KMALLOC_CACHES 398 #ifdef CONFIG_RANDOM_KMALLOC_CACHES
619 /* RANDOM_KMALLOC_CACHES_NR (= 399 /* RANDOM_KMALLOC_CACHES_NR (=15) copies + the KMALLOC_NORMAL */
620 return KMALLOC_RANDOM_START + 400 return KMALLOC_RANDOM_START + hash_64(caller ^ random_kmalloc_seed,
621 401 ilog2(RANDOM_KMALLOC_CACHES_NR + 1));
622 #else 402 #else
623 return KMALLOC_NORMAL; 403 return KMALLOC_NORMAL;
624 #endif 404 #endif
625 405
626 /* 406 /*
627 * At least one of the flags has to be 407 * At least one of the flags has to be set. Their priorities in
628 * decreasing order are: 408 * decreasing order are:
629 * 1) __GFP_DMA 409 * 1) __GFP_DMA
630 * 2) __GFP_RECLAIMABLE 410 * 2) __GFP_RECLAIMABLE
631 * 3) __GFP_ACCOUNT 411 * 3) __GFP_ACCOUNT
632 */ 412 */
633 if (IS_ENABLED(CONFIG_ZONE_DMA) && (fl 413 if (IS_ENABLED(CONFIG_ZONE_DMA) && (flags & __GFP_DMA))
634 return KMALLOC_DMA; 414 return KMALLOC_DMA;
635 if (!IS_ENABLED(CONFIG_MEMCG) || (flag !! 415 if (!IS_ENABLED(CONFIG_MEMCG_KMEM) || (flags & __GFP_RECLAIMABLE))
636 return KMALLOC_RECLAIM; 416 return KMALLOC_RECLAIM;
637 else 417 else
638 return KMALLOC_CGROUP; 418 return KMALLOC_CGROUP;
639 } 419 }
640 420
641 /* 421 /*
642 * Figure out which kmalloc slab an allocation 422 * Figure out which kmalloc slab an allocation of a certain size
643 * belongs to. 423 * belongs to.
644 * 0 = zero alloc 424 * 0 = zero alloc
645 * 1 = 65 .. 96 bytes 425 * 1 = 65 .. 96 bytes
646 * 2 = 129 .. 192 bytes 426 * 2 = 129 .. 192 bytes
647 * n = 2^(n-1)+1 .. 2^n 427 * n = 2^(n-1)+1 .. 2^n
648 * 428 *
649 * Note: __kmalloc_index() is compile-time opt 429 * Note: __kmalloc_index() is compile-time optimized, and not runtime optimized;
650 * typical usage is via kmalloc_index() and th 430 * typical usage is via kmalloc_index() and therefore evaluated at compile-time.
651 * Callers where !size_is_constant should only 431 * Callers where !size_is_constant should only be test modules, where runtime
652 * overheads of __kmalloc_index() can be toler 432 * overheads of __kmalloc_index() can be tolerated. Also see kmalloc_slab().
653 */ 433 */
654 static __always_inline unsigned int __kmalloc_ 434 static __always_inline unsigned int __kmalloc_index(size_t size,
655 435 bool size_is_constant)
656 { 436 {
657 if (!size) 437 if (!size)
658 return 0; 438 return 0;
659 439
660 if (size <= KMALLOC_MIN_SIZE) 440 if (size <= KMALLOC_MIN_SIZE)
661 return KMALLOC_SHIFT_LOW; 441 return KMALLOC_SHIFT_LOW;
662 442
663 if (KMALLOC_MIN_SIZE <= 32 && size > 6 443 if (KMALLOC_MIN_SIZE <= 32 && size > 64 && size <= 96)
664 return 1; 444 return 1;
665 if (KMALLOC_MIN_SIZE <= 64 && size > 1 445 if (KMALLOC_MIN_SIZE <= 64 && size > 128 && size <= 192)
666 return 2; 446 return 2;
667 if (size <= 8) return 3; 447 if (size <= 8) return 3;
668 if (size <= 16) return 4; 448 if (size <= 16) return 4;
669 if (size <= 32) return 5; 449 if (size <= 32) return 5;
670 if (size <= 64) return 6; 450 if (size <= 64) return 6;
671 if (size <= 128) return 7; 451 if (size <= 128) return 7;
672 if (size <= 256) return 8; 452 if (size <= 256) return 8;
673 if (size <= 512) return 9; 453 if (size <= 512) return 9;
674 if (size <= 1024) return 10; 454 if (size <= 1024) return 10;
675 if (size <= 2 * 1024) return 11; 455 if (size <= 2 * 1024) return 11;
676 if (size <= 4 * 1024) return 12; 456 if (size <= 4 * 1024) return 12;
677 if (size <= 8 * 1024) return 13; 457 if (size <= 8 * 1024) return 13;
678 if (size <= 16 * 1024) return 14; 458 if (size <= 16 * 1024) return 14;
679 if (size <= 32 * 1024) return 15; 459 if (size <= 32 * 1024) return 15;
680 if (size <= 64 * 1024) return 16; 460 if (size <= 64 * 1024) return 16;
681 if (size <= 128 * 1024) return 17; 461 if (size <= 128 * 1024) return 17;
682 if (size <= 256 * 1024) return 18; 462 if (size <= 256 * 1024) return 18;
683 if (size <= 512 * 1024) return 19; 463 if (size <= 512 * 1024) return 19;
684 if (size <= 1024 * 1024) return 20; 464 if (size <= 1024 * 1024) return 20;
685 if (size <= 2 * 1024 * 1024) return 2 465 if (size <= 2 * 1024 * 1024) return 21;
686 466
687 if (!IS_ENABLED(CONFIG_PROFILE_ALL_BRA 467 if (!IS_ENABLED(CONFIG_PROFILE_ALL_BRANCHES) && size_is_constant)
688 BUILD_BUG_ON_MSG(1, "unexpecte 468 BUILD_BUG_ON_MSG(1, "unexpected size in kmalloc_index()");
689 else 469 else
690 BUG(); 470 BUG();
691 471
692 /* Will never be reached. Needed becau 472 /* Will never be reached. Needed because the compiler may complain */
693 return -1; 473 return -1;
694 } 474 }
695 static_assert(PAGE_SHIFT <= 20); 475 static_assert(PAGE_SHIFT <= 20);
696 #define kmalloc_index(s) __kmalloc_index(s, tr 476 #define kmalloc_index(s) __kmalloc_index(s, true)
697 477
698 #include <linux/alloc_tag.h> !! 478 void *__kmalloc(size_t size, gfp_t flags) __assume_kmalloc_alignment __alloc_size(1);
699 479
700 /** 480 /**
701 * kmem_cache_alloc - Allocate an object 481 * kmem_cache_alloc - Allocate an object
702 * @cachep: The cache to allocate from. 482 * @cachep: The cache to allocate from.
703 * @flags: See kmalloc(). 483 * @flags: See kmalloc().
704 * 484 *
705 * Allocate an object from this cache. 485 * Allocate an object from this cache.
706 * See kmem_cache_zalloc() for a shortcut of a 486 * See kmem_cache_zalloc() for a shortcut of adding __GFP_ZERO to flags.
707 * 487 *
708 * Return: pointer to the new object or %NULL 488 * Return: pointer to the new object or %NULL in case of error
709 */ 489 */
710 void *kmem_cache_alloc_noprof(struct kmem_cach !! 490 void *kmem_cache_alloc(struct kmem_cache *cachep, gfp_t flags) __assume_slab_alignment __malloc;
711 gfp_t flags) __a !! 491 void *kmem_cache_alloc_lru(struct kmem_cache *s, struct list_lru *lru,
712 #define kmem_cache_alloc(...) !! 492 gfp_t gfpflags) __assume_slab_alignment __malloc;
713 <<
714 void *kmem_cache_alloc_lru_noprof(struct kmem_ <<
715 gfp_t gfpflags) __ <<
716 #define kmem_cache_alloc_lru(...) alloc_ <<
717 <<
718 /** <<
719 * kmem_cache_charge - memcg charge an already <<
720 * @objp: address of the slab object to memcg <<
721 * @gfpflags: describe the allocation context <<
722 * <<
723 * kmem_cache_charge allows charging a slab ob <<
724 * primarily in cases where charging at alloca <<
725 * because the target memcg is not known (i.e. <<
726 * <<
727 * The objp should be pointer returned by the <<
728 * kmalloc (with __GFP_ACCOUNT in flags) or km <<
729 * behavior can be controlled through gfpflags <<
730 * necessary internal metadata can be allocate <<
731 * that overcharging is requested instead of f <<
732 * internal metadata allocation. <<
733 * <<
734 * There are several cases where it will retur <<
735 * not done: <<
736 * More specifically: <<
737 * <<
738 * 1. For !CONFIG_MEMCG or cgroup_disable=memo <<
739 * 2. Already charged slab objects. <<
740 * 3. For slab objects from KMALLOC_NORMAL cac <<
741 * without __GFP_ACCOUNT <<
742 * 4. Allocating internal metadata has failed <<
743 * <<
744 * Return: true if charge was successful other <<
745 */ <<
746 bool kmem_cache_charge(void *objp, gfp_t gfpfl <<
747 void kmem_cache_free(struct kmem_cache *s, voi 493 void kmem_cache_free(struct kmem_cache *s, void *objp);
748 494
749 kmem_buckets *kmem_buckets_create(const char * <<
750 unsigned int <<
751 void (*ctor) <<
752 <<
753 /* 495 /*
754 * Bulk allocation and freeing operations. The 496 * Bulk allocation and freeing operations. These are accelerated in an
755 * allocator specific way to avoid taking lock 497 * allocator specific way to avoid taking locks repeatedly or building
756 * metadata structures unnecessarily. 498 * metadata structures unnecessarily.
757 * 499 *
758 * Note that interrupts must be enabled when c 500 * Note that interrupts must be enabled when calling these functions.
759 */ 501 */
760 void kmem_cache_free_bulk(struct kmem_cache *s 502 void kmem_cache_free_bulk(struct kmem_cache *s, size_t size, void **p);
761 !! 503 int kmem_cache_alloc_bulk(struct kmem_cache *s, gfp_t flags, size_t size, void **p);
762 int kmem_cache_alloc_bulk_noprof(struct kmem_c <<
763 #define kmem_cache_alloc_bulk(...) alloc_ <<
764 504
765 static __always_inline void kfree_bulk(size_t 505 static __always_inline void kfree_bulk(size_t size, void **p)
766 { 506 {
767 kmem_cache_free_bulk(NULL, size, p); 507 kmem_cache_free_bulk(NULL, size, p);
768 } 508 }
769 509
770 void *kmem_cache_alloc_node_noprof(struct kmem !! 510 void *__kmalloc_node(size_t size, gfp_t flags, int node) __assume_kmalloc_alignment
771 int node) _ !! 511 __alloc_size(1);
772 #define kmem_cache_alloc_node(...) alloc_ !! 512 void *kmem_cache_alloc_node(struct kmem_cache *s, gfp_t flags, int node) __assume_slab_alignment
>> 513 __malloc;
>> 514
>> 515 void *kmalloc_trace(struct kmem_cache *s, gfp_t flags, size_t size)
>> 516 __assume_kmalloc_alignment __alloc_size(3);
>> 517
>> 518 void *kmalloc_node_trace(struct kmem_cache *s, gfp_t gfpflags,
>> 519 int node, size_t size) __assume_kmalloc_alignment
>> 520 __alloc_size(4);
>> 521 void *kmalloc_large(size_t size, gfp_t flags) __assume_page_alignment
>> 522 __alloc_size(1);
773 523
774 /* !! 524 void *kmalloc_large_node(size_t size, gfp_t flags, int node) __assume_page_alignment
775 * These macros allow declaring a kmem_buckets !! 525 __alloc_size(1);
776 * can be compiled out with CONFIG_SLAB_BUCKET <<
777 * sites don't have to pass NULL. <<
778 */ <<
779 #ifdef CONFIG_SLAB_BUCKETS <<
780 #define DECL_BUCKET_PARAMS(_size, _b) size_t <<
781 #define PASS_BUCKET_PARAMS(_size, _b) (_size <<
782 #define PASS_BUCKET_PARAM(_b) (_b) <<
783 #else <<
784 #define DECL_BUCKET_PARAMS(_size, _b) size_t <<
785 #define PASS_BUCKET_PARAMS(_size, _b) (_size <<
786 #define PASS_BUCKET_PARAM(_b) NULL <<
787 #endif <<
788 <<
789 /* <<
790 * The following functions are not to be used <<
791 * for internal use from kmalloc() and kmalloc <<
792 * with the exception of kunit tests <<
793 */ <<
794 <<
795 void *__kmalloc_noprof(size_t size, gfp_t flag <<
796 __assume_kmall <<
797 <<
798 void *__kmalloc_node_noprof(DECL_BUCKET_PARAMS <<
799 __assume_kmall <<
800 <<
801 void *__kmalloc_cache_noprof(struct kmem_cache <<
802 __assume_kmall <<
803 <<
804 void *__kmalloc_cache_node_noprof(struct kmem_ <<
805 int node, si <<
806 __assume_kmall <<
807 <<
808 void *__kmalloc_large_noprof(size_t size, gfp_ <<
809 __assume_page_ <<
810 <<
811 void *__kmalloc_large_node_noprof(size_t size, <<
812 __assume_page_ <<
813 526
814 /** 527 /**
815 * kmalloc - allocate kernel memory 528 * kmalloc - allocate kernel memory
816 * @size: how many bytes of memory are require 529 * @size: how many bytes of memory are required.
817 * @flags: describe the allocation context 530 * @flags: describe the allocation context
818 * 531 *
819 * kmalloc is the normal method of allocating 532 * kmalloc is the normal method of allocating memory
820 * for objects smaller than page size in the k 533 * for objects smaller than page size in the kernel.
821 * 534 *
822 * The allocated object address is aligned to 535 * The allocated object address is aligned to at least ARCH_KMALLOC_MINALIGN
823 * bytes. For @size of power of two bytes, the 536 * bytes. For @size of power of two bytes, the alignment is also guaranteed
824 * to be at least to the size. For other sizes !! 537 * to be at least to the size.
825 * be at least the largest power-of-two diviso <<
826 * 538 *
827 * The @flags argument may be one of the GFP f 539 * The @flags argument may be one of the GFP flags defined at
828 * include/linux/gfp_types.h and described at 540 * include/linux/gfp_types.h and described at
829 * :ref:`Documentation/core-api/mm-api.rst <mm 541 * :ref:`Documentation/core-api/mm-api.rst <mm-api-gfp-flags>`
830 * 542 *
831 * The recommended usage of the @flags is desc 543 * The recommended usage of the @flags is described at
832 * :ref:`Documentation/core-api/memory-allocat 544 * :ref:`Documentation/core-api/memory-allocation.rst <memory_allocation>`
833 * 545 *
834 * Below is a brief outline of the most useful 546 * Below is a brief outline of the most useful GFP flags
835 * 547 *
836 * %GFP_KERNEL 548 * %GFP_KERNEL
837 * Allocate normal kernel ram. May sleep. 549 * Allocate normal kernel ram. May sleep.
838 * 550 *
839 * %GFP_NOWAIT 551 * %GFP_NOWAIT
840 * Allocation will not sleep. 552 * Allocation will not sleep.
841 * 553 *
842 * %GFP_ATOMIC 554 * %GFP_ATOMIC
843 * Allocation will not sleep. May use em 555 * Allocation will not sleep. May use emergency pools.
844 * 556 *
845 * Also it is possible to set different flags 557 * Also it is possible to set different flags by OR'ing
846 * in one or more of the following additional 558 * in one or more of the following additional @flags:
847 * 559 *
848 * %__GFP_ZERO 560 * %__GFP_ZERO
849 * Zero the allocated memory before retur 561 * Zero the allocated memory before returning. Also see kzalloc().
850 * 562 *
851 * %__GFP_HIGH 563 * %__GFP_HIGH
852 * This allocation has high priority and 564 * This allocation has high priority and may use emergency pools.
853 * 565 *
854 * %__GFP_NOFAIL 566 * %__GFP_NOFAIL
855 * Indicate that this allocation is in no 567 * Indicate that this allocation is in no way allowed to fail
856 * (think twice before using). 568 * (think twice before using).
857 * 569 *
858 * %__GFP_NORETRY 570 * %__GFP_NORETRY
859 * If memory is not immediately available 571 * If memory is not immediately available,
860 * then give up at once. 572 * then give up at once.
861 * 573 *
862 * %__GFP_NOWARN 574 * %__GFP_NOWARN
863 * If allocation fails, don't issue any w 575 * If allocation fails, don't issue any warnings.
864 * 576 *
865 * %__GFP_RETRY_MAYFAIL 577 * %__GFP_RETRY_MAYFAIL
866 * Try really hard to succeed the allocat 578 * Try really hard to succeed the allocation but fail
867 * eventually. 579 * eventually.
868 */ 580 */
869 static __always_inline __alloc_size(1) void *k !! 581 static __always_inline __alloc_size(1) void *kmalloc(size_t size, gfp_t flags)
870 { 582 {
871 if (__builtin_constant_p(size) && size 583 if (__builtin_constant_p(size) && size) {
872 unsigned int index; 584 unsigned int index;
873 585
874 if (size > KMALLOC_MAX_CACHE_S 586 if (size > KMALLOC_MAX_CACHE_SIZE)
875 return __kmalloc_large !! 587 return kmalloc_large(size, flags);
876 588
877 index = kmalloc_index(size); 589 index = kmalloc_index(size);
878 return __kmalloc_cache_noprof( !! 590 return kmalloc_trace(
879 kmalloc_caches 591 kmalloc_caches[kmalloc_type(flags, _RET_IP_)][index],
880 flags, size); 592 flags, size);
881 } 593 }
882 return __kmalloc_noprof(size, flags); !! 594 return __kmalloc(size, flags);
883 } 595 }
884 #define kmalloc(...) <<
885 <<
886 #define kmem_buckets_alloc(_b, _size, _flags) <<
887 alloc_hooks(__kmalloc_node_noprof(PASS <<
888 596
889 #define kmem_buckets_alloc_track_caller(_b, _s !! 597 static __always_inline __alloc_size(1) void *kmalloc_node(size_t size, gfp_t flags, int node)
890 alloc_hooks(__kmalloc_node_track_calle <<
891 <<
892 static __always_inline __alloc_size(1) void *k <<
893 { 598 {
894 if (__builtin_constant_p(size) && size 599 if (__builtin_constant_p(size) && size) {
895 unsigned int index; 600 unsigned int index;
896 601
897 if (size > KMALLOC_MAX_CACHE_S 602 if (size > KMALLOC_MAX_CACHE_SIZE)
898 return __kmalloc_large !! 603 return kmalloc_large_node(size, flags, node);
899 604
900 index = kmalloc_index(size); 605 index = kmalloc_index(size);
901 return __kmalloc_cache_node_no !! 606 return kmalloc_node_trace(
902 kmalloc_caches 607 kmalloc_caches[kmalloc_type(flags, _RET_IP_)][index],
903 flags, node, s 608 flags, node, size);
904 } 609 }
905 return __kmalloc_node_noprof(PASS_BUCK !! 610 return __kmalloc_node(size, flags, node);
906 } 611 }
907 #define kmalloc_node(...) <<
908 612
909 /** 613 /**
910 * kmalloc_array - allocate memory for an arra 614 * kmalloc_array - allocate memory for an array.
911 * @n: number of elements. 615 * @n: number of elements.
912 * @size: element size. 616 * @size: element size.
913 * @flags: the type of memory to allocate (see 617 * @flags: the type of memory to allocate (see kmalloc).
914 */ 618 */
915 static inline __alloc_size(1, 2) void *kmalloc !! 619 static inline __alloc_size(1, 2) void *kmalloc_array(size_t n, size_t size, gfp_t flags)
916 { 620 {
917 size_t bytes; 621 size_t bytes;
918 622
919 if (unlikely(check_mul_overflow(n, siz 623 if (unlikely(check_mul_overflow(n, size, &bytes)))
920 return NULL; 624 return NULL;
921 if (__builtin_constant_p(n) && __built 625 if (__builtin_constant_p(n) && __builtin_constant_p(size))
922 return kmalloc_noprof(bytes, f !! 626 return kmalloc(bytes, flags);
923 return kmalloc_noprof(bytes, flags); !! 627 return __kmalloc(bytes, flags);
924 } 628 }
925 #define kmalloc_array(...) <<
926 629
927 /** 630 /**
928 * krealloc_array - reallocate memory for an a 631 * krealloc_array - reallocate memory for an array.
929 * @p: pointer to the memory chunk to realloca 632 * @p: pointer to the memory chunk to reallocate
930 * @new_n: new number of elements to alloc 633 * @new_n: new number of elements to alloc
931 * @new_size: new size of a single member of t 634 * @new_size: new size of a single member of the array
932 * @flags: the type of memory to allocate (see 635 * @flags: the type of memory to allocate (see kmalloc)
933 * !! 636 */
934 * If __GFP_ZERO logic is requested, callers m !! 637 static inline __realloc_size(2, 3) void * __must_check krealloc_array(void *p,
935 * initial memory allocation, every subsequent !! 638 size_t new_n,
936 * memory allocation is flagged with __GFP_ZER !! 639 size_t new_size,
937 * __GFP_ZERO is not fully honored by this API !! 640 gfp_t flags)
938 * <<
939 * See krealloc_noprof() for further details. <<
940 * <<
941 * In any case, the contents of the object poi <<
942 * lesser of the new and old sizes. <<
943 */ <<
944 static inline __realloc_size(2, 3) void * __mu <<
945 <<
946 <<
947 <<
948 { 641 {
949 size_t bytes; 642 size_t bytes;
950 643
951 if (unlikely(check_mul_overflow(new_n, 644 if (unlikely(check_mul_overflow(new_n, new_size, &bytes)))
952 return NULL; 645 return NULL;
953 646
954 return krealloc_noprof(p, bytes, flags !! 647 return krealloc(p, bytes, flags);
955 } 648 }
956 #define krealloc_array(...) <<
957 649
958 /** 650 /**
959 * kcalloc - allocate memory for an array. The 651 * kcalloc - allocate memory for an array. The memory is set to zero.
960 * @n: number of elements. 652 * @n: number of elements.
961 * @size: element size. 653 * @size: element size.
962 * @flags: the type of memory to allocate (see 654 * @flags: the type of memory to allocate (see kmalloc).
963 */ 655 */
964 #define kcalloc(n, size, flags) kmallo !! 656 static inline __alloc_size(1, 2) void *kcalloc(size_t n, size_t size, gfp_t flags)
>> 657 {
>> 658 return kmalloc_array(n, size, flags | __GFP_ZERO);
>> 659 }
965 660
966 void *__kmalloc_node_track_caller_noprof(DECL_ !! 661 void *__kmalloc_node_track_caller(size_t size, gfp_t flags, int node,
967 unsig !! 662 unsigned long caller) __alloc_size(1);
968 #define kmalloc_node_track_caller_noprof(size, !! 663 #define kmalloc_node_track_caller(size, flags, node) \
969 __kmalloc_node_track_caller_noprof(PAS !! 664 __kmalloc_node_track_caller(size, flags, node, \
970 #define kmalloc_node_track_caller(...) !! 665 _RET_IP_)
971 alloc_hooks(kmalloc_node_track_caller_ <<
972 666
973 /* 667 /*
974 * kmalloc_track_caller is a special version o 668 * kmalloc_track_caller is a special version of kmalloc that records the
975 * calling function of the routine calling it 669 * calling function of the routine calling it for slab leak tracking instead
976 * of just the calling function (confusing, eh 670 * of just the calling function (confusing, eh?).
977 * It's useful when the call to kmalloc comes 671 * It's useful when the call to kmalloc comes from a widely-used standard
978 * allocator where we care about the real plac 672 * allocator where we care about the real place the memory allocation
979 * request comes from. 673 * request comes from.
980 */ 674 */
981 #define kmalloc_track_caller(...) !! 675 #define kmalloc_track_caller(size, flags) \
982 !! 676 __kmalloc_node_track_caller(size, flags, \
983 #define kmalloc_track_caller_noprof(...) !! 677 NUMA_NO_NODE, _RET_IP_)
984 kmalloc_node_track_caller_nopr <<
985 678
986 static inline __alloc_size(1, 2) void *kmalloc !! 679 static inline __alloc_size(1, 2) void *kmalloc_array_node(size_t n, size_t size, gfp_t flags,
987 680 int node)
988 { 681 {
989 size_t bytes; 682 size_t bytes;
990 683
991 if (unlikely(check_mul_overflow(n, siz 684 if (unlikely(check_mul_overflow(n, size, &bytes)))
992 return NULL; 685 return NULL;
993 if (__builtin_constant_p(n) && __built 686 if (__builtin_constant_p(n) && __builtin_constant_p(size))
994 return kmalloc_node_noprof(byt !! 687 return kmalloc_node(bytes, flags, node);
995 return __kmalloc_node_noprof(PASS_BUCK !! 688 return __kmalloc_node(bytes, flags, node);
996 } 689 }
997 #define kmalloc_array_node(...) <<
998 690
999 #define kcalloc_node(_n, _size, _flags, _node) !! 691 static inline __alloc_size(1, 2) void *kcalloc_node(size_t n, size_t size, gfp_t flags, int node)
1000 kmalloc_array_node(_n, _size, (_flags !! 692 {
>> 693 return kmalloc_array_node(n, size, flags | __GFP_ZERO, node);
>> 694 }
1001 695
1002 /* 696 /*
1003 * Shortcuts 697 * Shortcuts
1004 */ 698 */
1005 #define kmem_cache_zalloc(_k, _flags) !! 699 static inline void *kmem_cache_zalloc(struct kmem_cache *k, gfp_t flags)
>> 700 {
>> 701 return kmem_cache_alloc(k, flags | __GFP_ZERO);
>> 702 }
1006 703
1007 /** 704 /**
1008 * kzalloc - allocate memory. The memory is s 705 * kzalloc - allocate memory. The memory is set to zero.
1009 * @size: how many bytes of memory are requir 706 * @size: how many bytes of memory are required.
1010 * @flags: the type of memory to allocate (se 707 * @flags: the type of memory to allocate (see kmalloc).
1011 */ 708 */
1012 static inline __alloc_size(1) void *kzalloc_n !! 709 static inline __alloc_size(1) void *kzalloc(size_t size, gfp_t flags)
1013 { 710 {
1014 return kmalloc_noprof(size, flags | _ !! 711 return kmalloc(size, flags | __GFP_ZERO);
1015 } 712 }
1016 #define kzalloc(...) <<
1017 #define kzalloc_node(_size, _flags, _node) <<
1018 713
1019 void *__kvmalloc_node_noprof(DECL_BUCKET_PARA !! 714 /**
1020 #define kvmalloc_node_noprof(size, flags, nod !! 715 * kzalloc_node - allocate zeroed memory from a particular memory node.
1021 __kvmalloc_node_noprof(PASS_BUCKET_PA !! 716 * @size: how many bytes of memory are required.
1022 #define kvmalloc_node(...) !! 717 * @flags: the type of memory to allocate (see kmalloc).
1023 !! 718 * @node: memory node from which to allocate
1024 #define kvmalloc(_size, _flags) !! 719 */
1025 #define kvmalloc_noprof(_size, _flags) !! 720 static inline __alloc_size(1) void *kzalloc_node(size_t size, gfp_t flags, int node)
1026 #define kvzalloc(_size, _flags) !! 721 {
1027 !! 722 return kmalloc_node(size, flags | __GFP_ZERO, node);
1028 #define kvzalloc_node(_size, _flags, _node) !! 723 }
1029 #define kmem_buckets_valloc(_b, _size, _flags !! 724
1030 alloc_hooks(__kvmalloc_node_noprof(PA !! 725 extern void *kvmalloc_node(size_t size, gfp_t flags, int node) __alloc_size(1);
>> 726 static inline __alloc_size(1) void *kvmalloc(size_t size, gfp_t flags)
>> 727 {
>> 728 return kvmalloc_node(size, flags, NUMA_NO_NODE);
>> 729 }
>> 730 static inline __alloc_size(1) void *kvzalloc_node(size_t size, gfp_t flags, int node)
>> 731 {
>> 732 return kvmalloc_node(size, flags | __GFP_ZERO, node);
>> 733 }
>> 734 static inline __alloc_size(1) void *kvzalloc(size_t size, gfp_t flags)
>> 735 {
>> 736 return kvmalloc(size, flags | __GFP_ZERO);
>> 737 }
1031 738
1032 static inline __alloc_size(1, 2) void * !! 739 static inline __alloc_size(1, 2) void *kvmalloc_array(size_t n, size_t size, gfp_t flags)
1033 kvmalloc_array_node_noprof(size_t n, size_t s <<
1034 { 740 {
1035 size_t bytes; 741 size_t bytes;
1036 742
1037 if (unlikely(check_mul_overflow(n, si 743 if (unlikely(check_mul_overflow(n, size, &bytes)))
1038 return NULL; 744 return NULL;
1039 745
1040 return kvmalloc_node_noprof(bytes, fl !! 746 return kvmalloc(bytes, flags);
1041 } 747 }
1042 748
1043 #define kvmalloc_array_noprof(...) !! 749 static inline __alloc_size(1, 2) void *kvcalloc(size_t n, size_t size, gfp_t flags)
1044 #define kvcalloc_node_noprof(_n,_s,_f,_node) !! 750 {
1045 #define kvcalloc_noprof(...) !! 751 return kvmalloc_array(n, size, flags | __GFP_ZERO);
1046 !! 752 }
1047 #define kvmalloc_array(...) <<
1048 #define kvcalloc_node(...) <<
1049 #define kvcalloc(...) <<
1050 <<
1051 void *kvrealloc_noprof(const void *p, size_t <<
1052 __realloc_size(2); <<
1053 #define kvrealloc(...) <<
1054 753
>> 754 extern void *kvrealloc(const void *p, size_t oldsize, size_t newsize, gfp_t flags)
>> 755 __realloc_size(3);
1055 extern void kvfree(const void *addr); 756 extern void kvfree(const void *addr);
1056 DEFINE_FREE(kvfree, void *, if (!IS_ERR_OR_NU 757 DEFINE_FREE(kvfree, void *, if (!IS_ERR_OR_NULL(_T)) kvfree(_T))
1057 758
1058 extern void kvfree_sensitive(const void *addr 759 extern void kvfree_sensitive(const void *addr, size_t len);
1059 760
1060 unsigned int kmem_cache_size(struct kmem_cach 761 unsigned int kmem_cache_size(struct kmem_cache *s);
1061 762
1062 /** 763 /**
1063 * kmalloc_size_roundup - Report allocation b 764 * kmalloc_size_roundup - Report allocation bucket size for the given size
1064 * 765 *
1065 * @size: Number of bytes to round up from. 766 * @size: Number of bytes to round up from.
1066 * 767 *
1067 * This returns the number of bytes that woul 768 * This returns the number of bytes that would be available in a kmalloc()
1068 * allocation of @size bytes. For example, a 769 * allocation of @size bytes. For example, a 126 byte request would be
1069 * rounded up to the next sized kmalloc bucke 770 * rounded up to the next sized kmalloc bucket, 128 bytes. (This is strictly
1070 * for the general-purpose kmalloc()-based al 771 * for the general-purpose kmalloc()-based allocations, and is not for the
1071 * pre-sized kmem_cache_alloc()-based allocat 772 * pre-sized kmem_cache_alloc()-based allocations.)
1072 * 773 *
1073 * Use this to kmalloc() the full bucket size 774 * Use this to kmalloc() the full bucket size ahead of time instead of using
1074 * ksize() to query the size after an allocat 775 * ksize() to query the size after an allocation.
1075 */ 776 */
1076 size_t kmalloc_size_roundup(size_t size); 777 size_t kmalloc_size_roundup(size_t size);
1077 778
1078 void __init kmem_cache_init_late(void); 779 void __init kmem_cache_init_late(void);
1079 780
1080 #endif /* _LINUX_SLAB_H */ 781 #endif /* _LINUX_SLAB_H */
1081 782
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.