• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * Written by Mark Hemment, 1996 (markhe@nextd.demon.co.uk).
4  *
5  * (C) SGI 2006, Christoph Lameter
6  * 	Cleaned up and restructured to ease the addition of alternative
7  * 	implementations of SLAB allocators.
8  * (C) Linux Foundation 2008-2013
9  *      Unified interface for all slab allocators
10  */
11 
12 #ifndef _LINUX_SLAB_H
13 #define	_LINUX_SLAB_H
14 
15 #include <linux/gfp.h>
16 #include <linux/overflow.h>
17 #include <linux/types.h>
18 #include <linux/workqueue.h>
19 #include <linux/percpu-refcount.h>
20 
21 
22 /*
23  * Flags to pass to kmem_cache_create().
24  * The ones marked DEBUG are only valid if CONFIG_DEBUG_SLAB is set.
25  */
26 /* DEBUG: Perform (expensive) checks on alloc/free */
27 #define SLAB_CONSISTENCY_CHECKS	((slab_flags_t __force)0x00000100U)
28 /* DEBUG: Red zone objs in a cache */
29 #define SLAB_RED_ZONE		((slab_flags_t __force)0x00000400U)
30 /* DEBUG: Poison objects */
31 #define SLAB_POISON		((slab_flags_t __force)0x00000800U)
32 /* Align objs on cache lines */
33 #define SLAB_HWCACHE_ALIGN	((slab_flags_t __force)0x00002000U)
34 /* Use GFP_DMA memory */
35 #define SLAB_CACHE_DMA		((slab_flags_t __force)0x00004000U)
36 /* Use GFP_DMA32 memory */
37 #define SLAB_CACHE_DMA32	((slab_flags_t __force)0x00008000U)
38 /* DEBUG: Store the last owner for bug hunting */
39 #define SLAB_STORE_USER		((slab_flags_t __force)0x00010000U)
40 /* Panic if kmem_cache_create() fails */
41 #define SLAB_PANIC		((slab_flags_t __force)0x00040000U)
42 /*
43  * SLAB_TYPESAFE_BY_RCU - **WARNING** READ THIS!
44  *
45  * This delays freeing the SLAB page by a grace period, it does _NOT_
46  * delay object freeing. This means that if you do kmem_cache_free()
47  * that memory location is free to be reused at any time. Thus it may
48  * be possible to see another object there in the same RCU grace period.
49  *
50  * This feature only ensures the memory location backing the object
51  * stays valid, the trick to using this is relying on an independent
52  * object validation pass. Something like:
53  *
54  *  rcu_read_lock()
55  * again:
56  *  obj = lockless_lookup(key);
57  *  if (obj) {
58  *    if (!try_get_ref(obj)) // might fail for free objects
59  *      goto again;
60  *
61  *    if (obj->key != key) { // not the object we expected
62  *      put_ref(obj);
63  *      goto again;
64  *    }
65  *  }
66  *  rcu_read_unlock();
67  *
68  * This is useful if we need to approach a kernel structure obliquely,
69  * from its address obtained without the usual locking. We can lock
70  * the structure to stabilize it and check it's still at the given address,
71  * only if we can be sure that the memory has not been meanwhile reused
72  * for some other kind of object (which our subsystem's lock might corrupt).
73  *
74  * rcu_read_lock before reading the address, then rcu_read_unlock after
75  * taking the spinlock within the structure expected at that address.
76  *
77  * Note that SLAB_TYPESAFE_BY_RCU was originally named SLAB_DESTROY_BY_RCU.
78  */
79 /* Defer freeing slabs to RCU */
80 #define SLAB_TYPESAFE_BY_RCU	((slab_flags_t __force)0x00080000U)
81 /* Spread some memory over cpuset */
82 #define SLAB_MEM_SPREAD		((slab_flags_t __force)0x00100000U)
83 /* Trace allocations and frees */
84 #define SLAB_TRACE		((slab_flags_t __force)0x00200000U)
85 
86 /* Flag to prevent checks on free */
87 #ifdef CONFIG_DEBUG_OBJECTS
88 # define SLAB_DEBUG_OBJECTS	((slab_flags_t __force)0x00400000U)
89 #else
90 # define SLAB_DEBUG_OBJECTS	0
91 #endif
92 
93 /* Avoid kmemleak tracing */
94 #define SLAB_NOLEAKTRACE	((slab_flags_t __force)0x00800000U)
95 
96 /* Fault injection mark */
97 #ifdef CONFIG_FAILSLAB
98 # define SLAB_FAILSLAB		((slab_flags_t __force)0x02000000U)
99 #else
100 # define SLAB_FAILSLAB		0
101 #endif
102 /* Account to memcg */
103 #ifdef CONFIG_MEMCG_KMEM
104 # define SLAB_ACCOUNT		((slab_flags_t __force)0x04000000U)
105 #else
106 # define SLAB_ACCOUNT		0
107 #endif
108 
109 #ifdef CONFIG_KASAN
110 #define SLAB_KASAN		((slab_flags_t __force)0x08000000U)
111 #else
112 #define SLAB_KASAN		0
113 #endif
114 
115 /* The following flags affect the page allocator grouping pages by mobility */
116 /* Objects are reclaimable */
117 #define SLAB_RECLAIM_ACCOUNT	((slab_flags_t __force)0x00020000U)
118 #define SLAB_TEMPORARY		SLAB_RECLAIM_ACCOUNT	/* Objects are short-lived */
119 
120 /* Slab deactivation flag */
121 #define SLAB_DEACTIVATED	((slab_flags_t __force)0x10000000U)
122 
123 /*
124  * ZERO_SIZE_PTR will be returned for zero sized kmalloc requests.
125  *
126  * Dereferencing ZERO_SIZE_PTR will lead to a distinct access fault.
127  *
128  * ZERO_SIZE_PTR can be passed to kfree though in the same way that NULL can.
129  * Both make kfree a no-op.
130  */
131 #define ZERO_SIZE_PTR ((void *)16)
132 
133 #define ZERO_OR_NULL_PTR(x) ((unsigned long)(x) <= \
134 				(unsigned long)ZERO_SIZE_PTR)
135 
136 #include <linux/kasan.h>
137 
138 struct mem_cgroup;
139 /*
140  * struct kmem_cache related prototypes
141  */
142 void __init kmem_cache_init(void);
143 bool slab_is_available(void);
144 
145 extern bool usercopy_fallback;
146 
147 struct kmem_cache *kmem_cache_create(const char *name, unsigned int size,
148 			unsigned int align, slab_flags_t flags,
149 			void (*ctor)(void *));
150 struct kmem_cache *kmem_cache_create_usercopy(const char *name,
151 			unsigned int size, unsigned int align,
152 			slab_flags_t flags,
153 			unsigned int useroffset, unsigned int usersize,
154 			void (*ctor)(void *));
155 void kmem_cache_destroy(struct kmem_cache *);
156 int kmem_cache_shrink(struct kmem_cache *);
157 
158 /*
159  * Please use this macro to create slab caches. Simply specify the
160  * name of the structure and maybe some flags that are listed above.
161  *
162  * The alignment of the struct determines object alignment. If you
163  * f.e. add ____cacheline_aligned_in_smp to the struct declaration
164  * then the objects will be properly aligned in SMP configurations.
165  */
166 #define KMEM_CACHE(__struct, __flags)					\
167 		kmem_cache_create(#__struct, sizeof(struct __struct),	\
168 			__alignof__(struct __struct), (__flags), NULL)
169 
170 /*
171  * To whitelist a single field for copying to/from usercopy, use this
172  * macro instead for KMEM_CACHE() above.
173  */
174 #define KMEM_CACHE_USERCOPY(__struct, __flags, __field)			\
175 		kmem_cache_create_usercopy(#__struct,			\
176 			sizeof(struct __struct),			\
177 			__alignof__(struct __struct), (__flags),	\
178 			offsetof(struct __struct, __field),		\
179 			sizeof_field(struct __struct, __field), NULL)
180 
181 /*
182  * Common kmalloc functions provided by all allocators
183  */
184 void * __must_check krealloc(const void *, size_t, gfp_t);
185 void kfree(const void *);
186 void kfree_sensitive(const void *);
187 size_t __ksize(const void *);
188 size_t ksize(const void *);
189 #ifdef CONFIG_PRINTK
190 bool kmem_valid_obj(void *object);
191 void kmem_dump_obj(void *object);
192 #endif
193 
194 #ifdef CONFIG_HAVE_HARDENED_USERCOPY_ALLOCATOR
195 void __check_heap_object(const void *ptr, unsigned long n, struct page *page,
196 			bool to_user);
197 #else
__check_heap_object(const void * ptr,unsigned long n,struct page * page,bool to_user)198 static inline void __check_heap_object(const void *ptr, unsigned long n,
199 				       struct page *page, bool to_user) { }
200 #endif
201 
202 /*
203  * Some archs want to perform DMA into kmalloc caches and need a guaranteed
204  * alignment larger than the alignment of a 64-bit integer.
205  * Setting ARCH_KMALLOC_MINALIGN in arch headers allows that.
206  */
207 #if defined(ARCH_DMA_MINALIGN) && ARCH_DMA_MINALIGN > 8
208 #define ARCH_KMALLOC_MINALIGN ARCH_DMA_MINALIGN
209 #define KMALLOC_MIN_SIZE ARCH_DMA_MINALIGN
210 #define KMALLOC_SHIFT_LOW ilog2(ARCH_DMA_MINALIGN)
211 #else
212 #define ARCH_KMALLOC_MINALIGN __alignof__(unsigned long long)
213 #endif
214 
215 /*
216  * Setting ARCH_SLAB_MINALIGN in arch headers allows a different alignment.
217  * Intended for arches that get misalignment faults even for 64 bit integer
218  * aligned buffers.
219  */
220 #ifndef ARCH_SLAB_MINALIGN
221 #define ARCH_SLAB_MINALIGN __alignof__(unsigned long long)
222 #endif
223 
224 /*
225  * Arches can define this function if they want to decide the minimum slab
226  * alignment at runtime. The value returned by the function must be a power
227  * of two and >= ARCH_SLAB_MINALIGN.
228  */
229 #ifndef arch_slab_minalign
arch_slab_minalign(void)230 static inline unsigned int arch_slab_minalign(void)
231 {
232 	return ARCH_SLAB_MINALIGN;
233 }
234 #endif
235 
236 /*
237  * kmalloc and friends return ARCH_KMALLOC_MINALIGN aligned
238  * pointers. kmem_cache_alloc and friends return ARCH_SLAB_MINALIGN
239  * aligned pointers.
240  */
241 #define __assume_kmalloc_alignment __assume_aligned(ARCH_KMALLOC_MINALIGN)
242 #define __assume_slab_alignment __assume_aligned(ARCH_SLAB_MINALIGN)
243 #define __assume_page_alignment __assume_aligned(PAGE_SIZE)
244 
245 /*
246  * Kmalloc array related definitions
247  */
248 
249 #ifdef CONFIG_SLAB
250 /*
251  * The largest kmalloc size supported by the SLAB allocators is
252  * 32 megabyte (2^25) or the maximum allocatable page order if that is
253  * less than 32 MB.
254  *
255  * WARNING: Its not easy to increase this value since the allocators have
256  * to do various tricks to work around compiler limitations in order to
257  * ensure proper constant folding.
258  */
259 #define KMALLOC_SHIFT_HIGH	((MAX_ORDER + PAGE_SHIFT - 1) <= 25 ? \
260 				(MAX_ORDER + PAGE_SHIFT - 1) : 25)
261 #define KMALLOC_SHIFT_MAX	KMALLOC_SHIFT_HIGH
262 #ifndef KMALLOC_SHIFT_LOW
263 #define KMALLOC_SHIFT_LOW	5
264 #endif
265 #endif
266 
267 #ifdef CONFIG_SLUB
268 /*
269  * SLUB directly allocates requests fitting in to an order-1 page
270  * (PAGE_SIZE*2).  Larger requests are passed to the page allocator.
271  */
272 #define KMALLOC_SHIFT_HIGH	(PAGE_SHIFT + 1)
273 #define KMALLOC_SHIFT_MAX	(MAX_ORDER + PAGE_SHIFT - 1)
274 #ifndef KMALLOC_SHIFT_LOW
275 #define KMALLOC_SHIFT_LOW	3
276 #endif
277 #endif
278 
279 #ifdef CONFIG_SLOB
280 /*
281  * SLOB passes all requests larger than one page to the page allocator.
282  * No kmalloc array is necessary since objects of different sizes can
283  * be allocated from the same page.
284  */
285 #define KMALLOC_SHIFT_HIGH	PAGE_SHIFT
286 #define KMALLOC_SHIFT_MAX	(MAX_ORDER + PAGE_SHIFT - 1)
287 #ifndef KMALLOC_SHIFT_LOW
288 #define KMALLOC_SHIFT_LOW	3
289 #endif
290 #endif
291 
292 /* Maximum allocatable size */
293 #define KMALLOC_MAX_SIZE	(1UL << KMALLOC_SHIFT_MAX)
294 /* Maximum size for which we actually use a slab cache */
295 #define KMALLOC_MAX_CACHE_SIZE	(1UL << KMALLOC_SHIFT_HIGH)
296 /* Maximum order allocatable via the slab allocator */
297 #define KMALLOC_MAX_ORDER	(KMALLOC_SHIFT_MAX - PAGE_SHIFT)
298 
299 /*
300  * Kmalloc subsystem.
301  */
302 #ifndef KMALLOC_MIN_SIZE
303 #define KMALLOC_MIN_SIZE (1 << KMALLOC_SHIFT_LOW)
304 #endif
305 
306 /*
307  * This restriction comes from byte sized index implementation.
308  * Page size is normally 2^12 bytes and, in this case, if we want to use
309  * byte sized index which can represent 2^8 entries, the size of the object
310  * should be equal or greater to 2^12 / 2^8 = 2^4 = 16.
311  * If minimum size of kmalloc is less than 16, we use it as minimum object
312  * size and give up to use byte sized index.
313  */
314 #define SLAB_OBJ_MIN_SIZE      (KMALLOC_MIN_SIZE < 16 ? \
315                                (KMALLOC_MIN_SIZE) : 16)
316 
317 /*
318  * Whenever changing this, take care of that kmalloc_type() and
319  * create_kmalloc_caches() still work as intended.
320  *
321  * KMALLOC_NORMAL can contain only unaccounted objects whereas KMALLOC_CGROUP
322  * is for accounted but unreclaimable and non-dma objects. All the other
323  * kmem caches can have both accounted and unaccounted objects.
324  */
325 enum kmalloc_cache_type {
326 	KMALLOC_NORMAL = 0,
327 #ifndef CONFIG_ZONE_DMA
328 	KMALLOC_DMA = KMALLOC_NORMAL,
329 #endif
330 #ifndef CONFIG_MEMCG_KMEM
331 	KMALLOC_CGROUP = KMALLOC_NORMAL,
332 #else
333 	KMALLOC_CGROUP,
334 #endif
335 	KMALLOC_RECLAIM,
336 #ifdef CONFIG_ZONE_DMA
337 	KMALLOC_DMA,
338 #endif
339 	NR_KMALLOC_TYPES
340 };
341 
342 #ifndef CONFIG_SLOB
343 extern struct kmem_cache *
344 kmalloc_caches[NR_KMALLOC_TYPES][KMALLOC_SHIFT_HIGH + 1];
345 
346 /*
347  * Define gfp bits that should not be set for KMALLOC_NORMAL.
348  */
349 #define KMALLOC_NOT_NORMAL_BITS					\
350 	(__GFP_RECLAIMABLE |					\
351 	(IS_ENABLED(CONFIG_ZONE_DMA)   ? __GFP_DMA : 0) |	\
352 	(IS_ENABLED(CONFIG_MEMCG_KMEM) ? __GFP_ACCOUNT : 0))
353 
kmalloc_type(gfp_t flags)354 static __always_inline enum kmalloc_cache_type kmalloc_type(gfp_t flags)
355 {
356 	/*
357 	 * The most common case is KMALLOC_NORMAL, so test for it
358 	 * with a single branch for all the relevant flags.
359 	 */
360 	if (likely((flags & KMALLOC_NOT_NORMAL_BITS) == 0))
361 		return KMALLOC_NORMAL;
362 
363 	/*
364 	 * At least one of the flags has to be set. Their priorities in
365 	 * decreasing order are:
366 	 *  1) __GFP_DMA
367 	 *  2) __GFP_RECLAIMABLE
368 	 *  3) __GFP_ACCOUNT
369 	 */
370 	if (IS_ENABLED(CONFIG_ZONE_DMA) && (flags & __GFP_DMA))
371 		return KMALLOC_DMA;
372 	if (!IS_ENABLED(CONFIG_MEMCG_KMEM) || (flags & __GFP_RECLAIMABLE))
373 		return KMALLOC_RECLAIM;
374 	else
375 		return KMALLOC_CGROUP;
376 }
377 
378 /*
379  * Figure out which kmalloc slab an allocation of a certain size
380  * belongs to.
381  * 0 = zero alloc
382  * 1 =  65 .. 96 bytes
383  * 2 = 129 .. 192 bytes
384  * n = 2^(n-1)+1 .. 2^n
385  *
386  * Note: __kmalloc_index() is compile-time optimized, and not runtime optimized;
387  * typical usage is via kmalloc_index() and therefore evaluated at compile-time.
388  * Callers where !size_is_constant should only be test modules, where runtime
389  * overheads of __kmalloc_index() can be tolerated.  Also see kmalloc_slab().
390  */
__kmalloc_index(size_t size,bool size_is_constant)391 static __always_inline unsigned int __kmalloc_index(size_t size,
392 						    bool size_is_constant)
393 {
394 	if (!size)
395 		return 0;
396 
397 	if (size <= KMALLOC_MIN_SIZE)
398 		return KMALLOC_SHIFT_LOW;
399 
400 	if (KMALLOC_MIN_SIZE <= 32 && size > 64 && size <= 96)
401 		return 1;
402 	if (KMALLOC_MIN_SIZE <= 64 && size > 128 && size <= 192)
403 		return 2;
404 	if (size <=          8) return 3;
405 	if (size <=         16) return 4;
406 	if (size <=         32) return 5;
407 	if (size <=         64) return 6;
408 	if (size <=        128) return 7;
409 	if (size <=        256) return 8;
410 	if (size <=        512) return 9;
411 	if (size <=       1024) return 10;
412 	if (size <=   2 * 1024) return 11;
413 	if (size <=   4 * 1024) return 12;
414 	if (size <=   8 * 1024) return 13;
415 	if (size <=  16 * 1024) return 14;
416 	if (size <=  32 * 1024) return 15;
417 	if (size <=  64 * 1024) return 16;
418 	if (size <= 128 * 1024) return 17;
419 	if (size <= 256 * 1024) return 18;
420 	if (size <= 512 * 1024) return 19;
421 	if (size <= 1024 * 1024) return 20;
422 	if (size <=  2 * 1024 * 1024) return 21;
423 	if (size <=  4 * 1024 * 1024) return 22;
424 	if (size <=  8 * 1024 * 1024) return 23;
425 	if (size <=  16 * 1024 * 1024) return 24;
426 	if (size <=  32 * 1024 * 1024) return 25;
427 
428 	if ((IS_ENABLED(CONFIG_CC_IS_GCC) || CONFIG_CLANG_VERSION >= 110000)
429 	    && !IS_ENABLED(CONFIG_PROFILE_ALL_BRANCHES) && size_is_constant)
430 		BUILD_BUG_ON_MSG(1, "unexpected size in kmalloc_index()");
431 	else
432 		BUG();
433 
434 	/* Will never be reached. Needed because the compiler may complain */
435 	return -1;
436 }
437 #define kmalloc_index(s) __kmalloc_index(s, true)
438 #endif /* !CONFIG_SLOB */
439 
440 void *__kmalloc(size_t size, gfp_t flags) __assume_kmalloc_alignment __malloc;
441 void *kmem_cache_alloc(struct kmem_cache *, gfp_t flags) __assume_slab_alignment __malloc;
442 void kmem_cache_free(struct kmem_cache *, void *);
443 
444 /*
445  * Bulk allocation and freeing operations. These are accelerated in an
446  * allocator specific way to avoid taking locks repeatedly or building
447  * metadata structures unnecessarily.
448  *
449  * Note that interrupts must be enabled when calling these functions.
450  */
451 void kmem_cache_free_bulk(struct kmem_cache *, size_t, void **);
452 int kmem_cache_alloc_bulk(struct kmem_cache *, gfp_t, size_t, void **);
453 
454 /*
455  * Caller must not use kfree_bulk() on memory not originally allocated
456  * by kmalloc(), because the SLOB allocator cannot handle this.
457  */
kfree_bulk(size_t size,void ** p)458 static __always_inline void kfree_bulk(size_t size, void **p)
459 {
460 	kmem_cache_free_bulk(NULL, size, p);
461 }
462 
463 #ifdef CONFIG_NUMA
464 void *__kmalloc_node(size_t size, gfp_t flags, int node) __assume_kmalloc_alignment __malloc;
465 void *kmem_cache_alloc_node(struct kmem_cache *, gfp_t flags, int node) __assume_slab_alignment __malloc;
466 #else
__kmalloc_node(size_t size,gfp_t flags,int node)467 static __always_inline void *__kmalloc_node(size_t size, gfp_t flags, int node)
468 {
469 	return __kmalloc(size, flags);
470 }
471 
kmem_cache_alloc_node(struct kmem_cache * s,gfp_t flags,int node)472 static __always_inline void *kmem_cache_alloc_node(struct kmem_cache *s, gfp_t flags, int node)
473 {
474 	return kmem_cache_alloc(s, flags);
475 }
476 #endif
477 
478 #ifdef CONFIG_TRACING
479 extern void *kmem_cache_alloc_trace(struct kmem_cache *, gfp_t, size_t) __assume_slab_alignment __malloc;
480 
481 #ifdef CONFIG_NUMA
482 extern void *kmem_cache_alloc_node_trace(struct kmem_cache *s,
483 					   gfp_t gfpflags,
484 					   int node, size_t size) __assume_slab_alignment __malloc;
485 #else
486 static __always_inline void *
kmem_cache_alloc_node_trace(struct kmem_cache * s,gfp_t gfpflags,int node,size_t size)487 kmem_cache_alloc_node_trace(struct kmem_cache *s,
488 			      gfp_t gfpflags,
489 			      int node, size_t size)
490 {
491 	return kmem_cache_alloc_trace(s, gfpflags, size);
492 }
493 #endif /* CONFIG_NUMA */
494 
495 #else /* CONFIG_TRACING */
kmem_cache_alloc_trace(struct kmem_cache * s,gfp_t flags,size_t size)496 static __always_inline void *kmem_cache_alloc_trace(struct kmem_cache *s,
497 		gfp_t flags, size_t size)
498 {
499 	void *ret = kmem_cache_alloc(s, flags);
500 
501 	ret = kasan_kmalloc(s, ret, size, flags);
502 	return ret;
503 }
504 
505 static __always_inline void *
kmem_cache_alloc_node_trace(struct kmem_cache * s,gfp_t gfpflags,int node,size_t size)506 kmem_cache_alloc_node_trace(struct kmem_cache *s,
507 			      gfp_t gfpflags,
508 			      int node, size_t size)
509 {
510 	void *ret = kmem_cache_alloc_node(s, gfpflags, node);
511 
512 	ret = kasan_kmalloc(s, ret, size, gfpflags);
513 	return ret;
514 }
515 #endif /* CONFIG_TRACING */
516 
517 extern void *kmalloc_order(size_t size, gfp_t flags, unsigned int order) __assume_page_alignment __malloc;
518 
519 #ifdef CONFIG_TRACING
520 extern void *kmalloc_order_trace(size_t size, gfp_t flags, unsigned int order) __assume_page_alignment __malloc;
521 #else
522 static __always_inline void *
kmalloc_order_trace(size_t size,gfp_t flags,unsigned int order)523 kmalloc_order_trace(size_t size, gfp_t flags, unsigned int order)
524 {
525 	return kmalloc_order(size, flags, order);
526 }
527 #endif
528 
kmalloc_large(size_t size,gfp_t flags)529 static __always_inline void *kmalloc_large(size_t size, gfp_t flags)
530 {
531 	unsigned int order = get_order(size);
532 	return kmalloc_order_trace(size, flags, order);
533 }
534 
535 /**
536  * kmalloc - allocate memory
537  * @size: how many bytes of memory are required.
538  * @flags: the type of memory to allocate.
539  *
540  * kmalloc is the normal method of allocating memory
541  * for objects smaller than page size in the kernel.
542  *
543  * The allocated object address is aligned to at least ARCH_KMALLOC_MINALIGN
544  * bytes. For @size of power of two bytes, the alignment is also guaranteed
545  * to be at least to the size.
546  *
547  * The @flags argument may be one of the GFP flags defined at
548  * include/linux/gfp.h and described at
549  * :ref:`Documentation/core-api/mm-api.rst <mm-api-gfp-flags>`
550  *
551  * The recommended usage of the @flags is described at
552  * :ref:`Documentation/core-api/memory-allocation.rst <memory_allocation>`
553  *
554  * Below is a brief outline of the most useful GFP flags
555  *
556  * %GFP_KERNEL
557  *	Allocate normal kernel ram. May sleep.
558  *
559  * %GFP_NOWAIT
560  *	Allocation will not sleep.
561  *
562  * %GFP_ATOMIC
563  *	Allocation will not sleep.  May use emergency pools.
564  *
565  * %GFP_HIGHUSER
566  *	Allocate memory from high memory on behalf of user.
567  *
568  * Also it is possible to set different flags by OR'ing
569  * in one or more of the following additional @flags:
570  *
571  * %__GFP_HIGH
572  *	This allocation has high priority and may use emergency pools.
573  *
574  * %__GFP_NOFAIL
575  *	Indicate that this allocation is in no way allowed to fail
576  *	(think twice before using).
577  *
578  * %__GFP_NORETRY
579  *	If memory is not immediately available,
580  *	then give up at once.
581  *
582  * %__GFP_NOWARN
583  *	If allocation fails, don't issue any warnings.
584  *
585  * %__GFP_RETRY_MAYFAIL
586  *	Try really hard to succeed the allocation but fail
587  *	eventually.
588  */
kmalloc(size_t size,gfp_t flags)589 static __always_inline void *kmalloc(size_t size, gfp_t flags)
590 {
591 	if (__builtin_constant_p(size)) {
592 #ifndef CONFIG_SLOB
593 		unsigned int index;
594 #endif
595 		if (size > KMALLOC_MAX_CACHE_SIZE)
596 			return kmalloc_large(size, flags);
597 #ifndef CONFIG_SLOB
598 		index = kmalloc_index(size);
599 
600 		if (!index)
601 			return ZERO_SIZE_PTR;
602 
603 		return kmem_cache_alloc_trace(
604 				kmalloc_caches[kmalloc_type(flags)][index],
605 				flags, size);
606 #endif
607 	}
608 	return __kmalloc(size, flags);
609 }
610 
kmalloc_node(size_t size,gfp_t flags,int node)611 static __always_inline void *kmalloc_node(size_t size, gfp_t flags, int node)
612 {
613 #ifndef CONFIG_SLOB
614 	if (__builtin_constant_p(size) &&
615 		size <= KMALLOC_MAX_CACHE_SIZE) {
616 		unsigned int i = kmalloc_index(size);
617 
618 		if (!i)
619 			return ZERO_SIZE_PTR;
620 
621 		return kmem_cache_alloc_node_trace(
622 				kmalloc_caches[kmalloc_type(flags)][i],
623 						flags, node, size);
624 	}
625 #endif
626 	return __kmalloc_node(size, flags, node);
627 }
628 
629 /**
630  * kmalloc_array - allocate memory for an array.
631  * @n: number of elements.
632  * @size: element size.
633  * @flags: the type of memory to allocate (see kmalloc).
634  */
kmalloc_array(size_t n,size_t size,gfp_t flags)635 static inline void *kmalloc_array(size_t n, size_t size, gfp_t flags)
636 {
637 	size_t bytes;
638 
639 	if (unlikely(check_mul_overflow(n, size, &bytes)))
640 		return NULL;
641 	if (__builtin_constant_p(n) && __builtin_constant_p(size))
642 		return kmalloc(bytes, flags);
643 	return __kmalloc(bytes, flags);
644 }
645 
646 /**
647  * krealloc_array - reallocate memory for an array.
648  * @p: pointer to the memory chunk to reallocate
649  * @new_n: new number of elements to alloc
650  * @new_size: new size of a single member of the array
651  * @flags: the type of memory to allocate (see kmalloc)
652  */
653 static __must_check inline void *
krealloc_array(void * p,size_t new_n,size_t new_size,gfp_t flags)654 krealloc_array(void *p, size_t new_n, size_t new_size, gfp_t flags)
655 {
656 	size_t bytes;
657 
658 	if (unlikely(check_mul_overflow(new_n, new_size, &bytes)))
659 		return NULL;
660 
661 	return krealloc(p, bytes, flags);
662 }
663 
664 /**
665  * kcalloc - allocate memory for an array. The memory is set to zero.
666  * @n: number of elements.
667  * @size: element size.
668  * @flags: the type of memory to allocate (see kmalloc).
669  */
kcalloc(size_t n,size_t size,gfp_t flags)670 static inline void *kcalloc(size_t n, size_t size, gfp_t flags)
671 {
672 	return kmalloc_array(n, size, flags | __GFP_ZERO);
673 }
674 
675 /*
676  * kmalloc_track_caller is a special version of kmalloc that records the
677  * calling function of the routine calling it for slab leak tracking instead
678  * of just the calling function (confusing, eh?).
679  * It's useful when the call to kmalloc comes from a widely-used standard
680  * allocator where we care about the real place the memory allocation
681  * request comes from.
682  */
683 extern void *__kmalloc_track_caller(size_t, gfp_t, unsigned long);
684 #define kmalloc_track_caller(size, flags) \
685 	__kmalloc_track_caller(size, flags, _RET_IP_)
686 
kmalloc_array_node(size_t n,size_t size,gfp_t flags,int node)687 static inline void *kmalloc_array_node(size_t n, size_t size, gfp_t flags,
688 				       int node)
689 {
690 	size_t bytes;
691 
692 	if (unlikely(check_mul_overflow(n, size, &bytes)))
693 		return NULL;
694 	if (__builtin_constant_p(n) && __builtin_constant_p(size))
695 		return kmalloc_node(bytes, flags, node);
696 	return __kmalloc_node(bytes, flags, node);
697 }
698 
kcalloc_node(size_t n,size_t size,gfp_t flags,int node)699 static inline void *kcalloc_node(size_t n, size_t size, gfp_t flags, int node)
700 {
701 	return kmalloc_array_node(n, size, flags | __GFP_ZERO, node);
702 }
703 
704 
705 #ifdef CONFIG_NUMA
706 extern void *__kmalloc_node_track_caller(size_t, gfp_t, int, unsigned long);
707 #define kmalloc_node_track_caller(size, flags, node) \
708 	__kmalloc_node_track_caller(size, flags, node, \
709 			_RET_IP_)
710 
711 #else /* CONFIG_NUMA */
712 
713 #define kmalloc_node_track_caller(size, flags, node) \
714 	kmalloc_track_caller(size, flags)
715 
716 #endif /* CONFIG_NUMA */
717 
718 /*
719  * Shortcuts
720  */
kmem_cache_zalloc(struct kmem_cache * k,gfp_t flags)721 static inline void *kmem_cache_zalloc(struct kmem_cache *k, gfp_t flags)
722 {
723 	return kmem_cache_alloc(k, flags | __GFP_ZERO);
724 }
725 
726 /**
727  * kzalloc - allocate memory. The memory is set to zero.
728  * @size: how many bytes of memory are required.
729  * @flags: the type of memory to allocate (see kmalloc).
730  */
kzalloc(size_t size,gfp_t flags)731 static inline void *kzalloc(size_t size, gfp_t flags)
732 {
733 	return kmalloc(size, flags | __GFP_ZERO);
734 }
735 
736 /**
737  * kzalloc_node - allocate zeroed memory from a particular memory node.
738  * @size: how many bytes of memory are required.
739  * @flags: the type of memory to allocate (see kmalloc).
740  * @node: memory node from which to allocate
741  */
kzalloc_node(size_t size,gfp_t flags,int node)742 static inline void *kzalloc_node(size_t size, gfp_t flags, int node)
743 {
744 	return kmalloc_node(size, flags | __GFP_ZERO, node);
745 }
746 
747 unsigned int kmem_cache_size(struct kmem_cache *s);
748 void __init kmem_cache_init_late(void);
749 
750 #if defined(CONFIG_SMP) && defined(CONFIG_SLAB)
751 int slab_prepare_cpu(unsigned int cpu);
752 int slab_dead_cpu(unsigned int cpu);
753 #else
754 #define slab_prepare_cpu	NULL
755 #define slab_dead_cpu		NULL
756 #endif
757 
758 #endif	/* _LINUX_SLAB_H */
759