1 // SPDX-License-Identifier: GPL-2.0
3 * Slab allocator functions that are independent of the allocator strategy
5 * (C) 2012 Christoph Lameter <cl@linux.com>
7 #include <linux/slab.h>
10 #include <linux/poison.h>
11 #include <linux/interrupt.h>
12 #include <linux/memory.h>
13 #include <linux/cache.h>
14 #include <linux/compiler.h>
15 #include <linux/kfence.h>
16 #include <linux/module.h>
17 #include <linux/cpu.h>
18 #include <linux/uaccess.h>
19 #include <linux/seq_file.h>
20 #include <linux/proc_fs.h>
21 #include <linux/debugfs.h>
22 #include <linux/kasan.h>
23 #include <asm/cacheflush.h>
24 #include <asm/tlbflush.h>
26 #include <linux/memcontrol.h>
27 #include <linux/stackdepot.h>
32 #define CREATE_TRACE_POINTS
33 #include <trace/events/kmem.h>
35 enum slab_state slab_state;
36 LIST_HEAD(slab_caches);
37 DEFINE_MUTEX(slab_mutex);
38 struct kmem_cache *kmem_cache;
40 static LIST_HEAD(slab_caches_to_rcu_destroy);
41 static void slab_caches_to_rcu_destroy_workfn(struct work_struct *work);
42 static DECLARE_WORK(slab_caches_to_rcu_destroy_work,
43 slab_caches_to_rcu_destroy_workfn);
46 * Set of flags that will prevent slab merging
48 #define SLAB_NEVER_MERGE (SLAB_RED_ZONE | SLAB_POISON | SLAB_STORE_USER | \
49 SLAB_TRACE | SLAB_TYPESAFE_BY_RCU | SLAB_NOLEAKTRACE | \
50 SLAB_FAILSLAB | kasan_never_merge())
52 #define SLAB_MERGE_SAME (SLAB_RECLAIM_ACCOUNT | SLAB_CACHE_DMA | \
53 SLAB_CACHE_DMA32 | SLAB_ACCOUNT)
56 * Merge control. If this is set then no merging of slab caches will occur.
58 static bool slab_nomerge = !IS_ENABLED(CONFIG_SLAB_MERGE_DEFAULT);
60 static int __init setup_slab_nomerge(char *str)
66 static int __init setup_slab_merge(char *str)
73 __setup_param("slub_nomerge", slub_nomerge, setup_slab_nomerge, 0);
74 __setup_param("slub_merge", slub_merge, setup_slab_merge, 0);
77 __setup("slab_nomerge", setup_slab_nomerge);
78 __setup("slab_merge", setup_slab_merge);
81 * Determine the size of a slab object
83 unsigned int kmem_cache_size(struct kmem_cache *s)
85 return s->object_size;
87 EXPORT_SYMBOL(kmem_cache_size);
89 #ifdef CONFIG_DEBUG_VM
90 static int kmem_cache_sanity_check(const char *name, unsigned int size)
92 if (!name || in_interrupt() || size > KMALLOC_MAX_SIZE) {
93 pr_err("kmem_cache_create(%s) integrity check failed\n", name);
97 WARN_ON(strchr(name, ' ')); /* It confuses parsers */
101 static inline int kmem_cache_sanity_check(const char *name, unsigned int size)
108 * Figure out what the alignment of the objects will be given a set of
109 * flags, a user specified alignment and the size of the objects.
111 static unsigned int calculate_alignment(slab_flags_t flags,
112 unsigned int align, unsigned int size)
115 * If the user wants hardware cache aligned objects then follow that
116 * suggestion if the object is sufficiently large.
118 * The hardware cache alignment cannot override the specified
119 * alignment though. If that is greater then use it.
121 if (flags & SLAB_HWCACHE_ALIGN) {
124 ralign = cache_line_size();
125 while (size <= ralign / 2)
127 align = max(align, ralign);
130 align = max(align, arch_slab_minalign());
132 return ALIGN(align, sizeof(void *));
136 * Find a mergeable slab cache
138 int slab_unmergeable(struct kmem_cache *s)
140 if (slab_nomerge || (s->flags & SLAB_NEVER_MERGE))
146 #ifdef CONFIG_HARDENED_USERCOPY
152 * We may have set a slab to be unmergeable during bootstrap.
160 struct kmem_cache *find_mergeable(unsigned int size, unsigned int align,
161 slab_flags_t flags, const char *name, void (*ctor)(void *))
163 struct kmem_cache *s;
171 size = ALIGN(size, sizeof(void *));
172 align = calculate_alignment(flags, align, size);
173 size = ALIGN(size, align);
174 flags = kmem_cache_flags(size, flags, name);
176 if (flags & SLAB_NEVER_MERGE)
179 list_for_each_entry_reverse(s, &slab_caches, list) {
180 if (slab_unmergeable(s))
186 if ((flags & SLAB_MERGE_SAME) != (s->flags & SLAB_MERGE_SAME))
189 * Check if alignment is compatible.
190 * Courtesy of Adrian Drzewiecki
192 if ((s->size & ~(align - 1)) != s->size)
195 if (s->size - size >= sizeof(void *))
198 if (IS_ENABLED(CONFIG_SLAB) && align &&
199 (align > s->align || s->align % align))
207 static struct kmem_cache *create_cache(const char *name,
208 unsigned int object_size, unsigned int align,
209 slab_flags_t flags, unsigned int useroffset,
210 unsigned int usersize, void (*ctor)(void *),
211 struct kmem_cache *root_cache)
213 struct kmem_cache *s;
216 if (WARN_ON(useroffset + usersize > object_size))
217 useroffset = usersize = 0;
220 s = kmem_cache_zalloc(kmem_cache, GFP_KERNEL);
225 s->size = s->object_size = object_size;
228 #ifdef CONFIG_HARDENED_USERCOPY
229 s->useroffset = useroffset;
230 s->usersize = usersize;
233 err = __kmem_cache_create(s, flags);
238 list_add(&s->list, &slab_caches);
245 kmem_cache_free(kmem_cache, s);
250 * kmem_cache_create_usercopy - Create a cache with a region suitable
251 * for copying to userspace
252 * @name: A string which is used in /proc/slabinfo to identify this cache.
253 * @size: The size of objects to be created in this cache.
254 * @align: The required alignment for the objects.
256 * @useroffset: Usercopy region offset
257 * @usersize: Usercopy region size
258 * @ctor: A constructor for the objects.
260 * Cannot be called within a interrupt, but can be interrupted.
261 * The @ctor is run when new pages are allocated by the cache.
265 * %SLAB_POISON - Poison the slab with a known test pattern (a5a5a5a5)
266 * to catch references to uninitialised memory.
268 * %SLAB_RED_ZONE - Insert `Red` zones around the allocated memory to check
269 * for buffer overruns.
271 * %SLAB_HWCACHE_ALIGN - Align the objects in this cache to a hardware
272 * cacheline. This can be beneficial if you're counting cycles as closely
275 * Return: a pointer to the cache on success, NULL on failure.
278 kmem_cache_create_usercopy(const char *name,
279 unsigned int size, unsigned int align,
281 unsigned int useroffset, unsigned int usersize,
282 void (*ctor)(void *))
284 struct kmem_cache *s = NULL;
285 const char *cache_name;
288 #ifdef CONFIG_SLUB_DEBUG
290 * If no slub_debug was enabled globally, the static key is not yet
291 * enabled by setup_slub_debug(). Enable it if the cache is being
292 * created with any of the debugging flags passed explicitly.
293 * It's also possible that this is the first cache created with
294 * SLAB_STORE_USER and we should init stack_depot for it.
296 if (flags & SLAB_DEBUG_FLAGS)
297 static_branch_enable(&slub_debug_enabled);
298 if (flags & SLAB_STORE_USER)
302 mutex_lock(&slab_mutex);
304 err = kmem_cache_sanity_check(name, size);
309 /* Refuse requests with allocator specific flags */
310 if (flags & ~SLAB_FLAGS_PERMITTED) {
316 * Some allocators will constraint the set of valid flags to a subset
317 * of all flags. We expect them to define CACHE_CREATE_MASK in this
318 * case, and we'll just provide them with a sanitized version of the
321 flags &= CACHE_CREATE_MASK;
323 /* Fail closed on bad usersize of useroffset values. */
324 if (!IS_ENABLED(CONFIG_HARDENED_USERCOPY) ||
325 WARN_ON(!usersize && useroffset) ||
326 WARN_ON(size < usersize || size - usersize < useroffset))
327 usersize = useroffset = 0;
330 s = __kmem_cache_alias(name, size, align, flags, ctor);
334 cache_name = kstrdup_const(name, GFP_KERNEL);
340 s = create_cache(cache_name, size,
341 calculate_alignment(flags, align, size),
342 flags, useroffset, usersize, ctor, NULL);
345 kfree_const(cache_name);
349 mutex_unlock(&slab_mutex);
352 if (flags & SLAB_PANIC)
353 panic("%s: Failed to create slab '%s'. Error %d\n",
354 __func__, name, err);
356 pr_warn("%s(%s) failed with error %d\n",
357 __func__, name, err);
364 EXPORT_SYMBOL(kmem_cache_create_usercopy);
367 * kmem_cache_create - Create a cache.
368 * @name: A string which is used in /proc/slabinfo to identify this cache.
369 * @size: The size of objects to be created in this cache.
370 * @align: The required alignment for the objects.
372 * @ctor: A constructor for the objects.
374 * Cannot be called within a interrupt, but can be interrupted.
375 * The @ctor is run when new pages are allocated by the cache.
379 * %SLAB_POISON - Poison the slab with a known test pattern (a5a5a5a5)
380 * to catch references to uninitialised memory.
382 * %SLAB_RED_ZONE - Insert `Red` zones around the allocated memory to check
383 * for buffer overruns.
385 * %SLAB_HWCACHE_ALIGN - Align the objects in this cache to a hardware
386 * cacheline. This can be beneficial if you're counting cycles as closely
389 * Return: a pointer to the cache on success, NULL on failure.
392 kmem_cache_create(const char *name, unsigned int size, unsigned int align,
393 slab_flags_t flags, void (*ctor)(void *))
395 return kmem_cache_create_usercopy(name, size, align, flags, 0, 0,
398 EXPORT_SYMBOL(kmem_cache_create);
400 #ifdef SLAB_SUPPORTS_SYSFS
402 * For a given kmem_cache, kmem_cache_destroy() should only be called
403 * once or there will be a use-after-free problem. The actual deletion
404 * and release of the kobject does not need slab_mutex or cpu_hotplug_lock
405 * protection. So they are now done without holding those locks.
407 * Note that there will be a slight delay in the deletion of sysfs files
408 * if kmem_cache_release() is called indrectly from a work function.
410 static void kmem_cache_release(struct kmem_cache *s)
412 sysfs_slab_unlink(s);
413 sysfs_slab_release(s);
416 static void kmem_cache_release(struct kmem_cache *s)
418 slab_kmem_cache_release(s);
422 static void slab_caches_to_rcu_destroy_workfn(struct work_struct *work)
424 LIST_HEAD(to_destroy);
425 struct kmem_cache *s, *s2;
428 * On destruction, SLAB_TYPESAFE_BY_RCU kmem_caches are put on the
429 * @slab_caches_to_rcu_destroy list. The slab pages are freed
430 * through RCU and the associated kmem_cache are dereferenced
431 * while freeing the pages, so the kmem_caches should be freed only
432 * after the pending RCU operations are finished. As rcu_barrier()
433 * is a pretty slow operation, we batch all pending destructions
436 mutex_lock(&slab_mutex);
437 list_splice_init(&slab_caches_to_rcu_destroy, &to_destroy);
438 mutex_unlock(&slab_mutex);
440 if (list_empty(&to_destroy))
445 list_for_each_entry_safe(s, s2, &to_destroy, list) {
446 debugfs_slab_release(s);
447 kfence_shutdown_cache(s);
448 kmem_cache_release(s);
452 static int shutdown_cache(struct kmem_cache *s)
454 /* free asan quarantined objects */
455 kasan_cache_shutdown(s);
457 if (__kmem_cache_shutdown(s) != 0)
462 if (s->flags & SLAB_TYPESAFE_BY_RCU) {
463 list_add_tail(&s->list, &slab_caches_to_rcu_destroy);
464 schedule_work(&slab_caches_to_rcu_destroy_work);
466 kfence_shutdown_cache(s);
467 debugfs_slab_release(s);
473 void slab_kmem_cache_release(struct kmem_cache *s)
475 __kmem_cache_release(s);
476 kfree_const(s->name);
477 kmem_cache_free(kmem_cache, s);
480 void kmem_cache_destroy(struct kmem_cache *s)
485 if (unlikely(!s) || !kasan_check_byte(s))
489 mutex_lock(&slab_mutex);
491 rcu_set = s->flags & SLAB_TYPESAFE_BY_RCU;
493 refcnt = --s->refcount;
497 WARN(shutdown_cache(s),
498 "%s %s: Slab cache still has objects when called from %pS",
499 __func__, s->name, (void *)_RET_IP_);
501 mutex_unlock(&slab_mutex);
503 if (!refcnt && !rcu_set)
504 kmem_cache_release(s);
506 EXPORT_SYMBOL(kmem_cache_destroy);
509 * kmem_cache_shrink - Shrink a cache.
510 * @cachep: The cache to shrink.
512 * Releases as many slabs as possible for a cache.
513 * To help debugging, a zero exit status indicates all slabs were released.
515 * Return: %0 if all slabs were released, non-zero otherwise
517 int kmem_cache_shrink(struct kmem_cache *cachep)
519 kasan_cache_shrink(cachep);
521 return __kmem_cache_shrink(cachep);
523 EXPORT_SYMBOL(kmem_cache_shrink);
525 bool slab_is_available(void)
527 return slab_state >= UP;
532 * kmem_valid_obj - does the pointer reference a valid slab object?
533 * @object: pointer to query.
535 * Return: %true if the pointer is to a not-yet-freed object from
536 * kmalloc() or kmem_cache_alloc(), either %true or %false if the pointer
537 * is to an already-freed object, and %false otherwise.
539 bool kmem_valid_obj(void *object)
543 /* Some arches consider ZERO_SIZE_PTR to be a valid address. */
544 if (object < (void *)PAGE_SIZE || !virt_addr_valid(object))
546 folio = virt_to_folio(object);
547 return folio_test_slab(folio);
549 EXPORT_SYMBOL_GPL(kmem_valid_obj);
551 static void kmem_obj_info(struct kmem_obj_info *kpp, void *object, struct slab *slab)
553 if (__kfence_obj_info(kpp, object, slab))
555 __kmem_obj_info(kpp, object, slab);
559 * kmem_dump_obj - Print available slab provenance information
560 * @object: slab object for which to find provenance information.
562 * This function uses pr_cont(), so that the caller is expected to have
563 * printed out whatever preamble is appropriate. The provenance information
564 * depends on the type of object and on how much debugging is enabled.
565 * For a slab-cache object, the fact that it is a slab object is printed,
566 * and, if available, the slab name, return address, and stack trace from
567 * the allocation and last free path of that object.
569 * This function will splat if passed a pointer to a non-slab object.
570 * If you are not sure what type of object you have, you should instead
571 * use mem_dump_obj().
573 void kmem_dump_obj(void *object)
575 char *cp = IS_ENABLED(CONFIG_MMU) ? "" : "/vmalloc";
578 unsigned long ptroffset;
579 struct kmem_obj_info kp = { };
581 if (WARN_ON_ONCE(!virt_addr_valid(object)))
583 slab = virt_to_slab(object);
584 if (WARN_ON_ONCE(!slab)) {
585 pr_cont(" non-slab memory.\n");
588 kmem_obj_info(&kp, object, slab);
589 if (kp.kp_slab_cache)
590 pr_cont(" slab%s %s", cp, kp.kp_slab_cache->name);
592 pr_cont(" slab%s", cp);
593 if (is_kfence_address(object))
594 pr_cont(" (kfence)");
596 pr_cont(" start %px", kp.kp_objp);
597 if (kp.kp_data_offset)
598 pr_cont(" data offset %lu", kp.kp_data_offset);
600 ptroffset = ((char *)object - (char *)kp.kp_objp) - kp.kp_data_offset;
601 pr_cont(" pointer offset %lu", ptroffset);
603 if (kp.kp_slab_cache && kp.kp_slab_cache->object_size)
604 pr_cont(" size %u", kp.kp_slab_cache->object_size);
606 pr_cont(" allocated at %pS\n", kp.kp_ret);
609 for (i = 0; i < ARRAY_SIZE(kp.kp_stack); i++) {
612 pr_info(" %pS\n", kp.kp_stack[i]);
615 if (kp.kp_free_stack[0])
616 pr_cont(" Free path:\n");
618 for (i = 0; i < ARRAY_SIZE(kp.kp_free_stack); i++) {
619 if (!kp.kp_free_stack[i])
621 pr_info(" %pS\n", kp.kp_free_stack[i]);
625 EXPORT_SYMBOL_GPL(kmem_dump_obj);
629 /* Create a cache during boot when no slab services are available yet */
630 void __init create_boot_cache(struct kmem_cache *s, const char *name,
631 unsigned int size, slab_flags_t flags,
632 unsigned int useroffset, unsigned int usersize)
635 unsigned int align = ARCH_KMALLOC_MINALIGN;
638 s->size = s->object_size = size;
641 * For power of two sizes, guarantee natural alignment for kmalloc
642 * caches, regardless of SL*B debugging options.
644 if (is_power_of_2(size))
645 align = max(align, size);
646 s->align = calculate_alignment(flags, align, size);
648 #ifdef CONFIG_HARDENED_USERCOPY
649 s->useroffset = useroffset;
650 s->usersize = usersize;
653 err = __kmem_cache_create(s, flags);
656 panic("Creation of kmalloc slab %s size=%u failed. Reason %d\n",
659 s->refcount = -1; /* Exempt from merging for now */
662 struct kmem_cache *__init create_kmalloc_cache(const char *name,
663 unsigned int size, slab_flags_t flags,
664 unsigned int useroffset, unsigned int usersize)
666 struct kmem_cache *s = kmem_cache_zalloc(kmem_cache, GFP_NOWAIT);
669 panic("Out of memory when creating slab %s\n", name);
671 create_boot_cache(s, name, size, flags | SLAB_KMALLOC, useroffset,
673 kasan_cache_create_kmalloc(s);
674 list_add(&s->list, &slab_caches);
680 kmalloc_caches[NR_KMALLOC_TYPES][KMALLOC_SHIFT_HIGH + 1] __ro_after_init =
681 { /* initialization for https://bugs.llvm.org/show_bug.cgi?id=42570 */ };
682 EXPORT_SYMBOL(kmalloc_caches);
685 * Conversion table for small slabs sizes / 8 to the index in the
686 * kmalloc array. This is necessary for slabs < 192 since we have non power
687 * of two cache sizes there. The size of larger slabs can be determined using
690 static u8 size_index[24] __ro_after_init = {
717 static inline unsigned int size_index_elem(unsigned int bytes)
719 return (bytes - 1) / 8;
723 * Find the kmem_cache structure that serves a given size of
726 struct kmem_cache *kmalloc_slab(size_t size, gfp_t flags)
732 return ZERO_SIZE_PTR;
734 index = size_index[size_index_elem(size)];
736 if (WARN_ON_ONCE(size > KMALLOC_MAX_CACHE_SIZE))
738 index = fls(size - 1);
741 return kmalloc_caches[kmalloc_type(flags)][index];
744 size_t kmalloc_size_roundup(size_t size)
746 struct kmem_cache *c;
748 /* Short-circuit the 0 size case. */
749 if (unlikely(size == 0))
751 /* Short-circuit saturated "too-large" case. */
752 if (unlikely(size == SIZE_MAX))
754 /* Above the smaller buckets, size is a multiple of page size. */
755 if (size > KMALLOC_MAX_CACHE_SIZE)
756 return PAGE_SIZE << get_order(size);
758 /* The flags don't matter since size_index is common to all. */
759 c = kmalloc_slab(size, GFP_KERNEL);
760 return c ? c->object_size : 0;
762 EXPORT_SYMBOL(kmalloc_size_roundup);
764 #ifdef CONFIG_ZONE_DMA
765 #define KMALLOC_DMA_NAME(sz) .name[KMALLOC_DMA] = "dma-kmalloc-" #sz,
767 #define KMALLOC_DMA_NAME(sz)
770 #ifdef CONFIG_MEMCG_KMEM
771 #define KMALLOC_CGROUP_NAME(sz) .name[KMALLOC_CGROUP] = "kmalloc-cg-" #sz,
773 #define KMALLOC_CGROUP_NAME(sz)
776 #ifndef CONFIG_SLUB_TINY
777 #define KMALLOC_RCL_NAME(sz) .name[KMALLOC_RECLAIM] = "kmalloc-rcl-" #sz,
779 #define KMALLOC_RCL_NAME(sz)
782 #define INIT_KMALLOC_INFO(__size, __short_size) \
784 .name[KMALLOC_NORMAL] = "kmalloc-" #__short_size, \
785 KMALLOC_RCL_NAME(__short_size) \
786 KMALLOC_CGROUP_NAME(__short_size) \
787 KMALLOC_DMA_NAME(__short_size) \
792 * kmalloc_info[] is to make slub_debug=,kmalloc-xx option work at boot time.
793 * kmalloc_index() supports up to 2^21=2MB, so the final entry of the table is
796 const struct kmalloc_info_struct kmalloc_info[] __initconst = {
797 INIT_KMALLOC_INFO(0, 0),
798 INIT_KMALLOC_INFO(96, 96),
799 INIT_KMALLOC_INFO(192, 192),
800 INIT_KMALLOC_INFO(8, 8),
801 INIT_KMALLOC_INFO(16, 16),
802 INIT_KMALLOC_INFO(32, 32),
803 INIT_KMALLOC_INFO(64, 64),
804 INIT_KMALLOC_INFO(128, 128),
805 INIT_KMALLOC_INFO(256, 256),
806 INIT_KMALLOC_INFO(512, 512),
807 INIT_KMALLOC_INFO(1024, 1k),
808 INIT_KMALLOC_INFO(2048, 2k),
809 INIT_KMALLOC_INFO(4096, 4k),
810 INIT_KMALLOC_INFO(8192, 8k),
811 INIT_KMALLOC_INFO(16384, 16k),
812 INIT_KMALLOC_INFO(32768, 32k),
813 INIT_KMALLOC_INFO(65536, 64k),
814 INIT_KMALLOC_INFO(131072, 128k),
815 INIT_KMALLOC_INFO(262144, 256k),
816 INIT_KMALLOC_INFO(524288, 512k),
817 INIT_KMALLOC_INFO(1048576, 1M),
818 INIT_KMALLOC_INFO(2097152, 2M)
822 * Patch up the size_index table if we have strange large alignment
823 * requirements for the kmalloc array. This is only the case for
824 * MIPS it seems. The standard arches will not generate any code here.
826 * Largest permitted alignment is 256 bytes due to the way we
827 * handle the index determination for the smaller caches.
829 * Make sure that nothing crazy happens if someone starts tinkering
830 * around with ARCH_KMALLOC_MINALIGN
832 void __init setup_kmalloc_cache_index_table(void)
836 BUILD_BUG_ON(KMALLOC_MIN_SIZE > 256 ||
837 !is_power_of_2(KMALLOC_MIN_SIZE));
839 for (i = 8; i < KMALLOC_MIN_SIZE; i += 8) {
840 unsigned int elem = size_index_elem(i);
842 if (elem >= ARRAY_SIZE(size_index))
844 size_index[elem] = KMALLOC_SHIFT_LOW;
847 if (KMALLOC_MIN_SIZE >= 64) {
849 * The 96 byte sized cache is not used if the alignment
852 for (i = 64 + 8; i <= 96; i += 8)
853 size_index[size_index_elem(i)] = 7;
857 if (KMALLOC_MIN_SIZE >= 128) {
859 * The 192 byte sized cache is not used if the alignment
860 * is 128 byte. Redirect kmalloc to use the 256 byte cache
863 for (i = 128 + 8; i <= 192; i += 8)
864 size_index[size_index_elem(i)] = 8;
869 new_kmalloc_cache(int idx, enum kmalloc_cache_type type, slab_flags_t flags)
871 if ((KMALLOC_RECLAIM != KMALLOC_NORMAL) && (type == KMALLOC_RECLAIM)) {
872 flags |= SLAB_RECLAIM_ACCOUNT;
873 } else if (IS_ENABLED(CONFIG_MEMCG_KMEM) && (type == KMALLOC_CGROUP)) {
874 if (mem_cgroup_kmem_disabled()) {
875 kmalloc_caches[type][idx] = kmalloc_caches[KMALLOC_NORMAL][idx];
878 flags |= SLAB_ACCOUNT;
879 } else if (IS_ENABLED(CONFIG_ZONE_DMA) && (type == KMALLOC_DMA)) {
880 flags |= SLAB_CACHE_DMA;
883 kmalloc_caches[type][idx] = create_kmalloc_cache(
884 kmalloc_info[idx].name[type],
885 kmalloc_info[idx].size, flags, 0,
886 kmalloc_info[idx].size);
889 * If CONFIG_MEMCG_KMEM is enabled, disable cache merging for
890 * KMALLOC_NORMAL caches.
892 if (IS_ENABLED(CONFIG_MEMCG_KMEM) && (type == KMALLOC_NORMAL))
893 kmalloc_caches[type][idx]->refcount = -1;
897 * Create the kmalloc array. Some of the regular kmalloc arrays
898 * may already have been created because they were needed to
899 * enable allocations for slab creation.
901 void __init create_kmalloc_caches(slab_flags_t flags)
904 enum kmalloc_cache_type type;
907 * Including KMALLOC_CGROUP if CONFIG_MEMCG_KMEM defined
909 for (type = KMALLOC_NORMAL; type < NR_KMALLOC_TYPES; type++) {
910 for (i = KMALLOC_SHIFT_LOW; i <= KMALLOC_SHIFT_HIGH; i++) {
911 if (!kmalloc_caches[type][i])
912 new_kmalloc_cache(i, type, flags);
915 * Caches that are not of the two-to-the-power-of size.
916 * These have to be created immediately after the
917 * earlier power of two caches
919 if (KMALLOC_MIN_SIZE <= 32 && i == 6 &&
920 !kmalloc_caches[type][1])
921 new_kmalloc_cache(1, type, flags);
922 if (KMALLOC_MIN_SIZE <= 64 && i == 7 &&
923 !kmalloc_caches[type][2])
924 new_kmalloc_cache(2, type, flags);
928 /* Kmalloc array is now usable */
932 void free_large_kmalloc(struct folio *folio, void *object)
934 unsigned int order = folio_order(folio);
936 if (WARN_ON_ONCE(order == 0))
937 pr_warn_once("object pointer: 0x%p\n", object);
939 kmemleak_free(object);
940 kasan_kfree_large(object);
941 kmsan_kfree_large(object);
943 mod_lruvec_page_state(folio_page(folio, 0), NR_SLAB_UNRECLAIMABLE_B,
944 -(PAGE_SIZE << order));
945 __free_pages(folio_page(folio, 0), order);
948 static void *__kmalloc_large_node(size_t size, gfp_t flags, int node);
949 static __always_inline
950 void *__do_kmalloc_node(size_t size, gfp_t flags, int node, unsigned long caller)
952 struct kmem_cache *s;
955 if (unlikely(size > KMALLOC_MAX_CACHE_SIZE)) {
956 ret = __kmalloc_large_node(size, flags, node);
957 trace_kmalloc(caller, ret, size,
958 PAGE_SIZE << get_order(size), flags, node);
962 s = kmalloc_slab(size, flags);
964 if (unlikely(ZERO_OR_NULL_PTR(s)))
967 ret = __kmem_cache_alloc_node(s, flags, node, size, caller);
968 ret = kasan_kmalloc(s, ret, size, flags);
969 trace_kmalloc(caller, ret, size, s->size, flags, node);
973 void *__kmalloc_node(size_t size, gfp_t flags, int node)
975 return __do_kmalloc_node(size, flags, node, _RET_IP_);
977 EXPORT_SYMBOL(__kmalloc_node);
979 void *__kmalloc(size_t size, gfp_t flags)
981 return __do_kmalloc_node(size, flags, NUMA_NO_NODE, _RET_IP_);
983 EXPORT_SYMBOL(__kmalloc);
985 void *__kmalloc_node_track_caller(size_t size, gfp_t flags,
986 int node, unsigned long caller)
988 return __do_kmalloc_node(size, flags, node, caller);
990 EXPORT_SYMBOL(__kmalloc_node_track_caller);
993 * kfree - free previously allocated memory
994 * @object: pointer returned by kmalloc.
996 * If @object is NULL, no operation is performed.
998 * Don't free memory not originally allocated by kmalloc()
999 * or you will run into trouble.
1001 void kfree(const void *object)
1003 struct folio *folio;
1005 struct kmem_cache *s;
1007 trace_kfree(_RET_IP_, object);
1009 if (unlikely(ZERO_OR_NULL_PTR(object)))
1012 folio = virt_to_folio(object);
1013 if (unlikely(!folio_test_slab(folio))) {
1014 free_large_kmalloc(folio, (void *)object);
1018 slab = folio_slab(folio);
1019 s = slab->slab_cache;
1020 __kmem_cache_free(s, (void *)object, _RET_IP_);
1022 EXPORT_SYMBOL(kfree);
1025 * __ksize -- Report full size of underlying allocation
1026 * @object: pointer to the object
1028 * This should only be used internally to query the true size of allocations.
1029 * It is not meant to be a way to discover the usable size of an allocation
1030 * after the fact. Instead, use kmalloc_size_roundup(). Using memory beyond
1031 * the originally requested allocation size may trigger KASAN, UBSAN_BOUNDS,
1032 * and/or FORTIFY_SOURCE.
1034 * Return: size of the actual memory used by @object in bytes
1036 size_t __ksize(const void *object)
1038 struct folio *folio;
1040 if (unlikely(object == ZERO_SIZE_PTR))
1043 folio = virt_to_folio(object);
1045 if (unlikely(!folio_test_slab(folio))) {
1046 if (WARN_ON(folio_size(folio) <= KMALLOC_MAX_CACHE_SIZE))
1048 if (WARN_ON(object != folio_address(folio)))
1050 return folio_size(folio);
1053 #ifdef CONFIG_SLUB_DEBUG
1054 skip_orig_size_check(folio_slab(folio)->slab_cache, object);
1057 return slab_ksize(folio_slab(folio)->slab_cache);
1060 void *kmalloc_trace(struct kmem_cache *s, gfp_t gfpflags, size_t size)
1062 void *ret = __kmem_cache_alloc_node(s, gfpflags, NUMA_NO_NODE,
1065 trace_kmalloc(_RET_IP_, ret, size, s->size, gfpflags, NUMA_NO_NODE);
1067 ret = kasan_kmalloc(s, ret, size, gfpflags);
1070 EXPORT_SYMBOL(kmalloc_trace);
1072 void *kmalloc_node_trace(struct kmem_cache *s, gfp_t gfpflags,
1073 int node, size_t size)
1075 void *ret = __kmem_cache_alloc_node(s, gfpflags, node, size, _RET_IP_);
1077 trace_kmalloc(_RET_IP_, ret, size, s->size, gfpflags, node);
1079 ret = kasan_kmalloc(s, ret, size, gfpflags);
1082 EXPORT_SYMBOL(kmalloc_node_trace);
1083 #endif /* !CONFIG_SLOB */
1085 gfp_t kmalloc_fix_flags(gfp_t flags)
1087 gfp_t invalid_mask = flags & GFP_SLAB_BUG_MASK;
1089 flags &= ~GFP_SLAB_BUG_MASK;
1090 pr_warn("Unexpected gfp: %#x (%pGg). Fixing up to gfp: %#x (%pGg). Fix your code!\n",
1091 invalid_mask, &invalid_mask, flags, &flags);
1098 * To avoid unnecessary overhead, we pass through large allocation requests
1099 * directly to the page allocator. We use __GFP_COMP, because we will need to
1100 * know the allocation order to free the pages properly in kfree.
1103 static void *__kmalloc_large_node(size_t size, gfp_t flags, int node)
1107 unsigned int order = get_order(size);
1109 if (unlikely(flags & GFP_SLAB_BUG_MASK))
1110 flags = kmalloc_fix_flags(flags);
1112 flags |= __GFP_COMP;
1113 page = alloc_pages_node(node, flags, order);
1115 ptr = page_address(page);
1116 mod_lruvec_page_state(page, NR_SLAB_UNRECLAIMABLE_B,
1117 PAGE_SIZE << order);
1120 ptr = kasan_kmalloc_large(ptr, size, flags);
1121 /* As ptr might get tagged, call kmemleak hook after KASAN. */
1122 kmemleak_alloc(ptr, size, 1, flags);
1123 kmsan_kmalloc_large(ptr, size, flags);
1128 void *kmalloc_large(size_t size, gfp_t flags)
1130 void *ret = __kmalloc_large_node(size, flags, NUMA_NO_NODE);
1132 trace_kmalloc(_RET_IP_, ret, size, PAGE_SIZE << get_order(size),
1133 flags, NUMA_NO_NODE);
1136 EXPORT_SYMBOL(kmalloc_large);
1138 void *kmalloc_large_node(size_t size, gfp_t flags, int node)
1140 void *ret = __kmalloc_large_node(size, flags, node);
1142 trace_kmalloc(_RET_IP_, ret, size, PAGE_SIZE << get_order(size),
1146 EXPORT_SYMBOL(kmalloc_large_node);
1148 #ifdef CONFIG_SLAB_FREELIST_RANDOM
1149 /* Randomize a generic freelist */
1150 static void freelist_randomize(struct rnd_state *state, unsigned int *list,
1156 for (i = 0; i < count; i++)
1159 /* Fisher-Yates shuffle */
1160 for (i = count - 1; i > 0; i--) {
1161 rand = prandom_u32_state(state);
1163 swap(list[i], list[rand]);
1167 /* Create a random sequence per cache */
1168 int cache_random_seq_create(struct kmem_cache *cachep, unsigned int count,
1171 struct rnd_state state;
1173 if (count < 2 || cachep->random_seq)
1176 cachep->random_seq = kcalloc(count, sizeof(unsigned int), gfp);
1177 if (!cachep->random_seq)
1180 /* Get best entropy at this stage of boot */
1181 prandom_seed_state(&state, get_random_long());
1183 freelist_randomize(&state, cachep->random_seq, count);
1187 /* Destroy the per-cache random freelist sequence */
1188 void cache_random_seq_destroy(struct kmem_cache *cachep)
1190 kfree(cachep->random_seq);
1191 cachep->random_seq = NULL;
1193 #endif /* CONFIG_SLAB_FREELIST_RANDOM */
1195 #if defined(CONFIG_SLAB) || defined(CONFIG_SLUB_DEBUG)
1197 #define SLABINFO_RIGHTS (0600)
1199 #define SLABINFO_RIGHTS (0400)
1202 static void print_slabinfo_header(struct seq_file *m)
1205 * Output format version, so at least we can change it
1206 * without _too_ many complaints.
1208 #ifdef CONFIG_DEBUG_SLAB
1209 seq_puts(m, "slabinfo - version: 2.1 (statistics)\n");
1211 seq_puts(m, "slabinfo - version: 2.1\n");
1213 seq_puts(m, "# name <active_objs> <num_objs> <objsize> <objperslab> <pagesperslab>");
1214 seq_puts(m, " : tunables <limit> <batchcount> <sharedfactor>");
1215 seq_puts(m, " : slabdata <active_slabs> <num_slabs> <sharedavail>");
1216 #ifdef CONFIG_DEBUG_SLAB
1217 seq_puts(m, " : globalstat <listallocs> <maxobjs> <grown> <reaped> <error> <maxfreeable> <nodeallocs> <remotefrees> <alienoverflow>");
1218 seq_puts(m, " : cpustat <allochit> <allocmiss> <freehit> <freemiss>");
1223 static void *slab_start(struct seq_file *m, loff_t *pos)
1225 mutex_lock(&slab_mutex);
1226 return seq_list_start(&slab_caches, *pos);
1229 static void *slab_next(struct seq_file *m, void *p, loff_t *pos)
1231 return seq_list_next(p, &slab_caches, pos);
1234 static void slab_stop(struct seq_file *m, void *p)
1236 mutex_unlock(&slab_mutex);
1239 static void cache_show(struct kmem_cache *s, struct seq_file *m)
1241 struct slabinfo sinfo;
1243 memset(&sinfo, 0, sizeof(sinfo));
1244 get_slabinfo(s, &sinfo);
1246 seq_printf(m, "%-17s %6lu %6lu %6u %4u %4d",
1247 s->name, sinfo.active_objs, sinfo.num_objs, s->size,
1248 sinfo.objects_per_slab, (1 << sinfo.cache_order));
1250 seq_printf(m, " : tunables %4u %4u %4u",
1251 sinfo.limit, sinfo.batchcount, sinfo.shared);
1252 seq_printf(m, " : slabdata %6lu %6lu %6lu",
1253 sinfo.active_slabs, sinfo.num_slabs, sinfo.shared_avail);
1254 slabinfo_show_stats(m, s);
1258 static int slab_show(struct seq_file *m, void *p)
1260 struct kmem_cache *s = list_entry(p, struct kmem_cache, list);
1262 if (p == slab_caches.next)
1263 print_slabinfo_header(m);
1268 void dump_unreclaimable_slab(void)
1270 struct kmem_cache *s;
1271 struct slabinfo sinfo;
1274 * Here acquiring slab_mutex is risky since we don't prefer to get
1275 * sleep in oom path. But, without mutex hold, it may introduce a
1277 * Use mutex_trylock to protect the list traverse, dump nothing
1278 * without acquiring the mutex.
1280 if (!mutex_trylock(&slab_mutex)) {
1281 pr_warn("excessive unreclaimable slab but cannot dump stats\n");
1285 pr_info("Unreclaimable slab info:\n");
1286 pr_info("Name Used Total\n");
1288 list_for_each_entry(s, &slab_caches, list) {
1289 if (s->flags & SLAB_RECLAIM_ACCOUNT)
1292 get_slabinfo(s, &sinfo);
1294 if (sinfo.num_objs > 0)
1295 pr_info("%-17s %10luKB %10luKB\n", s->name,
1296 (sinfo.active_objs * s->size) / 1024,
1297 (sinfo.num_objs * s->size) / 1024);
1299 mutex_unlock(&slab_mutex);
1303 * slabinfo_op - iterator that generates /proc/slabinfo
1312 * num-pages-per-slab
1313 * + further values on SMP and with statistics enabled
1315 static const struct seq_operations slabinfo_op = {
1316 .start = slab_start,
1322 static int slabinfo_open(struct inode *inode, struct file *file)
1324 return seq_open(file, &slabinfo_op);
1327 static const struct proc_ops slabinfo_proc_ops = {
1328 .proc_flags = PROC_ENTRY_PERMANENT,
1329 .proc_open = slabinfo_open,
1330 .proc_read = seq_read,
1331 .proc_write = slabinfo_write,
1332 .proc_lseek = seq_lseek,
1333 .proc_release = seq_release,
1336 static int __init slab_proc_init(void)
1338 proc_create("slabinfo", SLABINFO_RIGHTS, NULL, &slabinfo_proc_ops);
1341 module_init(slab_proc_init);
1343 #endif /* CONFIG_SLAB || CONFIG_SLUB_DEBUG */
1345 static __always_inline __realloc_size(2) void *
1346 __do_krealloc(const void *p, size_t new_size, gfp_t flags)
1351 /* Check for double-free before calling ksize. */
1352 if (likely(!ZERO_OR_NULL_PTR(p))) {
1353 if (!kasan_check_byte(p))
1359 /* If the object still fits, repoison it precisely. */
1360 if (ks >= new_size) {
1361 p = kasan_krealloc((void *)p, new_size, flags);
1365 ret = kmalloc_track_caller(new_size, flags);
1367 /* Disable KASAN checks as the object's redzone is accessed. */
1368 kasan_disable_current();
1369 memcpy(ret, kasan_reset_tag(p), ks);
1370 kasan_enable_current();
1377 * krealloc - reallocate memory. The contents will remain unchanged.
1378 * @p: object to reallocate memory for.
1379 * @new_size: how many bytes of memory are required.
1380 * @flags: the type of memory to allocate.
1382 * The contents of the object pointed to are preserved up to the
1383 * lesser of the new and old sizes (__GFP_ZERO flag is effectively ignored).
1384 * If @p is %NULL, krealloc() behaves exactly like kmalloc(). If @new_size
1385 * is 0 and @p is not a %NULL pointer, the object pointed to is freed.
1387 * Return: pointer to the allocated memory or %NULL in case of error
1389 void *krealloc(const void *p, size_t new_size, gfp_t flags)
1393 if (unlikely(!new_size)) {
1395 return ZERO_SIZE_PTR;
1398 ret = __do_krealloc(p, new_size, flags);
1399 if (ret && kasan_reset_tag(p) != kasan_reset_tag(ret))
1404 EXPORT_SYMBOL(krealloc);
1407 * kfree_sensitive - Clear sensitive information in memory before freeing
1408 * @p: object to free memory of
1410 * The memory of the object @p points to is zeroed before freed.
1411 * If @p is %NULL, kfree_sensitive() does nothing.
1413 * Note: this function zeroes the whole allocated buffer which can be a good
1414 * deal bigger than the requested buffer size passed to kmalloc(). So be
1415 * careful when using this function in performance sensitive code.
1417 void kfree_sensitive(const void *p)
1420 void *mem = (void *)p;
1424 kasan_unpoison_range(mem, ks);
1425 memzero_explicit(mem, ks);
1429 EXPORT_SYMBOL(kfree_sensitive);
1431 size_t ksize(const void *objp)
1434 * We need to first check that the pointer to the object is valid.
1435 * The KASAN report printed from ksize() is more useful, then when
1436 * it's printed later when the behaviour could be undefined due to
1437 * a potential use-after-free or double-free.
1439 * We use kasan_check_byte(), which is supported for the hardware
1440 * tag-based KASAN mode, unlike kasan_check_read/write().
1442 * If the pointed to memory is invalid, we return 0 to avoid users of
1443 * ksize() writing to and potentially corrupting the memory region.
1445 * We want to perform the check before __ksize(), to avoid potentially
1446 * crashing in __ksize() due to accessing invalid metadata.
1448 if (unlikely(ZERO_OR_NULL_PTR(objp)) || !kasan_check_byte(objp))
1451 return kfence_ksize(objp) ?: __ksize(objp);
1453 EXPORT_SYMBOL(ksize);
1455 /* Tracepoints definitions. */
1456 EXPORT_TRACEPOINT_SYMBOL(kmalloc);
1457 EXPORT_TRACEPOINT_SYMBOL(kmem_cache_alloc);
1458 EXPORT_TRACEPOINT_SYMBOL(kfree);
1459 EXPORT_TRACEPOINT_SYMBOL(kmem_cache_free);
1461 int should_failslab(struct kmem_cache *s, gfp_t gfpflags)
1463 if (__should_failslab(s, gfpflags))
1467 ALLOW_ERROR_INJECTION(should_failslab, ERRNO);