1 // SPDX-License-Identifier: GPL-2.0
4 * Written by Mark Hemment, 1996/97.
5 * (markhe@nextd.demon.co.uk)
7 * kmem_cache_destroy() + some cleanup - 1999 Andrea Arcangeli
9 * Major cleanup, different bufctl logic, per-cpu arrays
10 * (c) 2000 Manfred Spraul
12 * Cleanup, make the head arrays unconditional, preparation for NUMA
13 * (c) 2002 Manfred Spraul
15 * An implementation of the Slab Allocator as described in outline in;
16 * UNIX Internals: The New Frontiers by Uresh Vahalia
17 * Pub: Prentice Hall ISBN 0-13-101908-2
18 * or with a little more detail in;
19 * The Slab Allocator: An Object-Caching Kernel Memory Allocator
20 * Jeff Bonwick (Sun Microsystems).
21 * Presented at: USENIX Summer 1994 Technical Conference
23 * The memory is organized in caches, one cache for each object type.
24 * (e.g. inode_cache, dentry_cache, buffer_head, vm_area_struct)
25 * Each cache consists out of many slabs (they are small (usually one
26 * page long) and always contiguous), and each slab contains multiple
27 * initialized objects.
29 * This means, that your constructor is used only for newly allocated
30 * slabs and you must pass objects with the same initializations to
33 * Each cache can only support one memory type (GFP_DMA, GFP_HIGHMEM,
34 * normal). If you need a special memory type, then must create a new
35 * cache for that memory type.
37 * In order to reduce fragmentation, the slabs are sorted in 3 groups:
38 * full slabs with 0 free objects
40 * empty slabs with no allocated objects
42 * If partial slabs exist, then new allocations come from these slabs,
43 * otherwise from empty slabs or new slabs are allocated.
45 * kmem_cache_destroy() CAN CRASH if you try to allocate from the cache
46 * during kmem_cache_destroy(). The caller must prevent concurrent allocs.
48 * Each cache has a short per-cpu head array, most allocs
49 * and frees go into that array, and if that array overflows, then 1/2
50 * of the entries in the array are given back into the global cache.
51 * The head array is strictly LIFO and should improve the cache hit rates.
52 * On SMP, it additionally reduces the spinlock operations.
54 * The c_cpuarray may not be read with enabled local interrupts -
55 * it's changed with a smp_call_function().
57 * SMP synchronization:
58 * constructors and destructors are called without any locking.
59 * Several members in struct kmem_cache and struct slab never change, they
60 * are accessed without any locking.
61 * The per-cpu arrays are never accessed from the wrong cpu, no locking,
62 * and local interrupts are disabled so slab code is preempt-safe.
63 * The non-constant members are protected with a per-cache irq spinlock.
65 * Many thanks to Mark Hemment, who wrote another per-cpu slab patch
66 * in 2000 - many ideas in the current implementation are derived from
69 * Further notes from the original documentation:
71 * 11 April '97. Started multi-threading - markhe
72 * The global cache-chain is protected by the mutex 'slab_mutex'.
73 * The sem is only needed when accessing/extending the cache-chain, which
74 * can never happen inside an interrupt (kmem_cache_create(),
75 * kmem_cache_shrink() and kmem_cache_reap()).
77 * At present, each engine can be growing a cache. This should be blocked.
79 * 15 March 2005. NUMA slab allocator.
80 * Shai Fultheim <shai@scalex86.org>.
81 * Shobhit Dayal <shobhit@calsoftinc.com>
82 * Alok N Kataria <alokk@calsoftinc.com>
83 * Christoph Lameter <christoph@lameter.com>
85 * Modified the slab allocator to be node aware on NUMA systems.
86 * Each node has its own list of partial, free and full slabs.
87 * All object allocations for a node occur from node specific slab lists.
90 #include <linux/slab.h>
92 #include <linux/poison.h>
93 #include <linux/swap.h>
94 #include <linux/cache.h>
95 #include <linux/interrupt.h>
96 #include <linux/init.h>
97 #include <linux/compiler.h>
98 #include <linux/cpuset.h>
99 #include <linux/proc_fs.h>
100 #include <linux/seq_file.h>
101 #include <linux/notifier.h>
102 #include <linux/kallsyms.h>
103 #include <linux/cpu.h>
104 #include <linux/sysctl.h>
105 #include <linux/module.h>
106 #include <linux/rcupdate.h>
107 #include <linux/string.h>
108 #include <linux/uaccess.h>
109 #include <linux/nodemask.h>
110 #include <linux/kmemleak.h>
111 #include <linux/mempolicy.h>
112 #include <linux/mutex.h>
113 #include <linux/fault-inject.h>
114 #include <linux/rtmutex.h>
115 #include <linux/reciprocal_div.h>
116 #include <linux/debugobjects.h>
117 #include <linux/memory.h>
118 #include <linux/prefetch.h>
119 #include <linux/sched/task_stack.h>
121 #include <net/sock.h>
123 #include <asm/cacheflush.h>
124 #include <asm/tlbflush.h>
125 #include <asm/page.h>
127 #include <trace/events/kmem.h>
129 #include "internal.h"
134 * DEBUG - 1 for kmem_cache_create() to honour; SLAB_RED_ZONE & SLAB_POISON.
135 * 0 for faster, smaller code (especially in the critical paths).
137 * STATS - 1 to collect stats for /proc/slabinfo.
138 * 0 for faster, smaller code (especially in the critical paths).
140 * FORCED_DEBUG - 1 enables SLAB_RED_ZONE and SLAB_POISON (if possible)
143 #ifdef CONFIG_DEBUG_SLAB
146 #define FORCED_DEBUG 1
150 #define FORCED_DEBUG 0
153 /* Shouldn't this be in a header file somewhere? */
154 #define BYTES_PER_WORD sizeof(void *)
155 #define REDZONE_ALIGN max(BYTES_PER_WORD, __alignof__(unsigned long long))
157 #ifndef ARCH_KMALLOC_FLAGS
158 #define ARCH_KMALLOC_FLAGS SLAB_HWCACHE_ALIGN
161 #define FREELIST_BYTE_INDEX (((PAGE_SIZE >> BITS_PER_BYTE) \
162 <= SLAB_OBJ_MIN_SIZE) ? 1 : 0)
164 #if FREELIST_BYTE_INDEX
165 typedef unsigned char freelist_idx_t;
167 typedef unsigned short freelist_idx_t;
170 #define SLAB_OBJ_MAX_NUM ((1 << sizeof(freelist_idx_t) * BITS_PER_BYTE) - 1)
176 * - LIFO ordering, to hand out cache-warm objects from _alloc
177 * - reduce the number of linked list operations
178 * - reduce spinlock operations
180 * The limit is stored in the per-cpu structure to reduce the data cache
187 unsigned int batchcount;
188 unsigned int touched;
190 * Must have this definition in here for the proper
191 * alignment of array_cache. Also simplifies accessing
198 struct array_cache ac;
202 * Need this for bootstrapping a per node allocator.
204 #define NUM_INIT_LISTS (2 * MAX_NUMNODES)
205 static struct kmem_cache_node __initdata init_kmem_cache_node[NUM_INIT_LISTS];
206 #define CACHE_CACHE 0
207 #define SIZE_NODE (MAX_NUMNODES)
209 static int drain_freelist(struct kmem_cache *cache,
210 struct kmem_cache_node *n, int tofree);
211 static void free_block(struct kmem_cache *cachep, void **objpp, int len,
212 int node, struct list_head *list);
213 static void slabs_destroy(struct kmem_cache *cachep, struct list_head *list);
214 static int enable_cpucache(struct kmem_cache *cachep, gfp_t gfp);
215 static void cache_reap(struct work_struct *unused);
217 static inline void fixup_objfreelist_debug(struct kmem_cache *cachep,
219 static inline void fixup_slab_list(struct kmem_cache *cachep,
220 struct kmem_cache_node *n, struct page *page,
222 static int slab_early_init = 1;
224 #define INDEX_NODE kmalloc_index(sizeof(struct kmem_cache_node))
226 static void kmem_cache_node_init(struct kmem_cache_node *parent)
228 INIT_LIST_HEAD(&parent->slabs_full);
229 INIT_LIST_HEAD(&parent->slabs_partial);
230 INIT_LIST_HEAD(&parent->slabs_free);
231 parent->total_slabs = 0;
232 parent->free_slabs = 0;
233 parent->shared = NULL;
234 parent->alien = NULL;
235 parent->colour_next = 0;
236 spin_lock_init(&parent->list_lock);
237 parent->free_objects = 0;
238 parent->free_touched = 0;
241 #define MAKE_LIST(cachep, listp, slab, nodeid) \
243 INIT_LIST_HEAD(listp); \
244 list_splice(&get_node(cachep, nodeid)->slab, listp); \
247 #define MAKE_ALL_LISTS(cachep, ptr, nodeid) \
249 MAKE_LIST((cachep), (&(ptr)->slabs_full), slabs_full, nodeid); \
250 MAKE_LIST((cachep), (&(ptr)->slabs_partial), slabs_partial, nodeid); \
251 MAKE_LIST((cachep), (&(ptr)->slabs_free), slabs_free, nodeid); \
254 #define CFLGS_OBJFREELIST_SLAB ((slab_flags_t __force)0x40000000U)
255 #define CFLGS_OFF_SLAB ((slab_flags_t __force)0x80000000U)
256 #define OBJFREELIST_SLAB(x) ((x)->flags & CFLGS_OBJFREELIST_SLAB)
257 #define OFF_SLAB(x) ((x)->flags & CFLGS_OFF_SLAB)
259 #define BATCHREFILL_LIMIT 16
261 * Optimization question: fewer reaps means less probability for unnessary
262 * cpucache drain/refill cycles.
264 * OTOH the cpuarrays can contain lots of objects,
265 * which could lock up otherwise freeable slabs.
267 #define REAPTIMEOUT_AC (2*HZ)
268 #define REAPTIMEOUT_NODE (4*HZ)
271 #define STATS_INC_ACTIVE(x) ((x)->num_active++)
272 #define STATS_DEC_ACTIVE(x) ((x)->num_active--)
273 #define STATS_INC_ALLOCED(x) ((x)->num_allocations++)
274 #define STATS_INC_GROWN(x) ((x)->grown++)
275 #define STATS_ADD_REAPED(x,y) ((x)->reaped += (y))
276 #define STATS_SET_HIGH(x) \
278 if ((x)->num_active > (x)->high_mark) \
279 (x)->high_mark = (x)->num_active; \
281 #define STATS_INC_ERR(x) ((x)->errors++)
282 #define STATS_INC_NODEALLOCS(x) ((x)->node_allocs++)
283 #define STATS_INC_NODEFREES(x) ((x)->node_frees++)
284 #define STATS_INC_ACOVERFLOW(x) ((x)->node_overflow++)
285 #define STATS_SET_FREEABLE(x, i) \
287 if ((x)->max_freeable < i) \
288 (x)->max_freeable = i; \
290 #define STATS_INC_ALLOCHIT(x) atomic_inc(&(x)->allochit)
291 #define STATS_INC_ALLOCMISS(x) atomic_inc(&(x)->allocmiss)
292 #define STATS_INC_FREEHIT(x) atomic_inc(&(x)->freehit)
293 #define STATS_INC_FREEMISS(x) atomic_inc(&(x)->freemiss)
295 #define STATS_INC_ACTIVE(x) do { } while (0)
296 #define STATS_DEC_ACTIVE(x) do { } while (0)
297 #define STATS_INC_ALLOCED(x) do { } while (0)
298 #define STATS_INC_GROWN(x) do { } while (0)
299 #define STATS_ADD_REAPED(x,y) do { (void)(y); } while (0)
300 #define STATS_SET_HIGH(x) do { } while (0)
301 #define STATS_INC_ERR(x) do { } while (0)
302 #define STATS_INC_NODEALLOCS(x) do { } while (0)
303 #define STATS_INC_NODEFREES(x) do { } while (0)
304 #define STATS_INC_ACOVERFLOW(x) do { } while (0)
305 #define STATS_SET_FREEABLE(x, i) do { } while (0)
306 #define STATS_INC_ALLOCHIT(x) do { } while (0)
307 #define STATS_INC_ALLOCMISS(x) do { } while (0)
308 #define STATS_INC_FREEHIT(x) do { } while (0)
309 #define STATS_INC_FREEMISS(x) do { } while (0)
315 * memory layout of objects:
317 * 0 .. cachep->obj_offset - BYTES_PER_WORD - 1: padding. This ensures that
318 * the end of an object is aligned with the end of the real
319 * allocation. Catches writes behind the end of the allocation.
320 * cachep->obj_offset - BYTES_PER_WORD .. cachep->obj_offset - 1:
322 * cachep->obj_offset: The real object.
323 * cachep->size - 2* BYTES_PER_WORD: redzone word [BYTES_PER_WORD long]
324 * cachep->size - 1* BYTES_PER_WORD: last caller address
325 * [BYTES_PER_WORD long]
327 static int obj_offset(struct kmem_cache *cachep)
329 return cachep->obj_offset;
332 static unsigned long long *dbg_redzone1(struct kmem_cache *cachep, void *objp)
334 BUG_ON(!(cachep->flags & SLAB_RED_ZONE));
335 return (unsigned long long*) (objp + obj_offset(cachep) -
336 sizeof(unsigned long long));
339 static unsigned long long *dbg_redzone2(struct kmem_cache *cachep, void *objp)
341 BUG_ON(!(cachep->flags & SLAB_RED_ZONE));
342 if (cachep->flags & SLAB_STORE_USER)
343 return (unsigned long long *)(objp + cachep->size -
344 sizeof(unsigned long long) -
346 return (unsigned long long *) (objp + cachep->size -
347 sizeof(unsigned long long));
350 static void **dbg_userword(struct kmem_cache *cachep, void *objp)
352 BUG_ON(!(cachep->flags & SLAB_STORE_USER));
353 return (void **)(objp + cachep->size - BYTES_PER_WORD);
358 #define obj_offset(x) 0
359 #define dbg_redzone1(cachep, objp) ({BUG(); (unsigned long long *)NULL;})
360 #define dbg_redzone2(cachep, objp) ({BUG(); (unsigned long long *)NULL;})
361 #define dbg_userword(cachep, objp) ({BUG(); (void **)NULL;})
365 #ifdef CONFIG_DEBUG_SLAB_LEAK
367 static inline bool is_store_user_clean(struct kmem_cache *cachep)
369 return atomic_read(&cachep->store_user_clean) == 1;
372 static inline void set_store_user_clean(struct kmem_cache *cachep)
374 atomic_set(&cachep->store_user_clean, 1);
377 static inline void set_store_user_dirty(struct kmem_cache *cachep)
379 if (is_store_user_clean(cachep))
380 atomic_set(&cachep->store_user_clean, 0);
384 static inline void set_store_user_dirty(struct kmem_cache *cachep) {}
389 * Do not go above this order unless 0 objects fit into the slab or
390 * overridden on the command line.
392 #define SLAB_MAX_ORDER_HI 1
393 #define SLAB_MAX_ORDER_LO 0
394 static int slab_max_order = SLAB_MAX_ORDER_LO;
395 static bool slab_max_order_set __initdata;
397 static inline struct kmem_cache *virt_to_cache(const void *obj)
399 struct page *page = virt_to_head_page(obj);
400 return page->slab_cache;
403 static inline void *index_to_obj(struct kmem_cache *cache, struct page *page,
406 return page->s_mem + cache->size * idx;
410 * We want to avoid an expensive divide : (offset / cache->size)
411 * Using the fact that size is a constant for a particular cache,
412 * we can replace (offset / cache->size) by
413 * reciprocal_divide(offset, cache->reciprocal_buffer_size)
415 static inline unsigned int obj_to_index(const struct kmem_cache *cache,
416 const struct page *page, void *obj)
418 u32 offset = (obj - page->s_mem);
419 return reciprocal_divide(offset, cache->reciprocal_buffer_size);
422 #define BOOT_CPUCACHE_ENTRIES 1
423 /* internal cache of cache description objs */
424 static struct kmem_cache kmem_cache_boot = {
426 .limit = BOOT_CPUCACHE_ENTRIES,
428 .size = sizeof(struct kmem_cache),
429 .name = "kmem_cache",
432 static DEFINE_PER_CPU(struct delayed_work, slab_reap_work);
434 static inline struct array_cache *cpu_cache_get(struct kmem_cache *cachep)
436 return this_cpu_ptr(cachep->cpu_cache);
440 * Calculate the number of objects and left-over bytes for a given buffer size.
442 static unsigned int cache_estimate(unsigned long gfporder, size_t buffer_size,
443 slab_flags_t flags, size_t *left_over)
446 size_t slab_size = PAGE_SIZE << gfporder;
449 * The slab management structure can be either off the slab or
450 * on it. For the latter case, the memory allocated for a
453 * - @buffer_size bytes for each object
454 * - One freelist_idx_t for each object
456 * We don't need to consider alignment of freelist because
457 * freelist will be at the end of slab page. The objects will be
458 * at the correct alignment.
460 * If the slab management structure is off the slab, then the
461 * alignment will already be calculated into the size. Because
462 * the slabs are all pages aligned, the objects will be at the
463 * correct alignment when allocated.
465 if (flags & (CFLGS_OBJFREELIST_SLAB | CFLGS_OFF_SLAB)) {
466 num = slab_size / buffer_size;
467 *left_over = slab_size % buffer_size;
469 num = slab_size / (buffer_size + sizeof(freelist_idx_t));
470 *left_over = slab_size %
471 (buffer_size + sizeof(freelist_idx_t));
478 #define slab_error(cachep, msg) __slab_error(__func__, cachep, msg)
480 static void __slab_error(const char *function, struct kmem_cache *cachep,
483 pr_err("slab error in %s(): cache `%s': %s\n",
484 function, cachep->name, msg);
486 add_taint(TAINT_BAD_PAGE, LOCKDEP_NOW_UNRELIABLE);
491 * By default on NUMA we use alien caches to stage the freeing of
492 * objects allocated from other nodes. This causes massive memory
493 * inefficiencies when using fake NUMA setup to split memory into a
494 * large number of small nodes, so it can be disabled on the command
498 static int use_alien_caches __read_mostly = 1;
499 static int __init noaliencache_setup(char *s)
501 use_alien_caches = 0;
504 __setup("noaliencache", noaliencache_setup);
506 static int __init slab_max_order_setup(char *str)
508 get_option(&str, &slab_max_order);
509 slab_max_order = slab_max_order < 0 ? 0 :
510 min(slab_max_order, MAX_ORDER - 1);
511 slab_max_order_set = true;
515 __setup("slab_max_order=", slab_max_order_setup);
519 * Special reaping functions for NUMA systems called from cache_reap().
520 * These take care of doing round robin flushing of alien caches (containing
521 * objects freed on different nodes from which they were allocated) and the
522 * flushing of remote pcps by calling drain_node_pages.
524 static DEFINE_PER_CPU(unsigned long, slab_reap_node);
526 static void init_reap_node(int cpu)
528 per_cpu(slab_reap_node, cpu) = next_node_in(cpu_to_mem(cpu),
532 static void next_reap_node(void)
534 int node = __this_cpu_read(slab_reap_node);
536 node = next_node_in(node, node_online_map);
537 __this_cpu_write(slab_reap_node, node);
541 #define init_reap_node(cpu) do { } while (0)
542 #define next_reap_node(void) do { } while (0)
546 * Initiate the reap timer running on the target CPU. We run at around 1 to 2Hz
547 * via the workqueue/eventd.
548 * Add the CPU number into the expiration time to minimize the possibility of
549 * the CPUs getting into lockstep and contending for the global cache chain
552 static void start_cpu_timer(int cpu)
554 struct delayed_work *reap_work = &per_cpu(slab_reap_work, cpu);
556 if (reap_work->work.func == NULL) {
558 INIT_DEFERRABLE_WORK(reap_work, cache_reap);
559 schedule_delayed_work_on(cpu, reap_work,
560 __round_jiffies_relative(HZ, cpu));
564 static void init_arraycache(struct array_cache *ac, int limit, int batch)
567 * The array_cache structures contain pointers to free object.
568 * However, when such objects are allocated or transferred to another
569 * cache the pointers are not cleared and they could be counted as
570 * valid references during a kmemleak scan. Therefore, kmemleak must
571 * not scan such objects.
573 kmemleak_no_scan(ac);
577 ac->batchcount = batch;
582 static struct array_cache *alloc_arraycache(int node, int entries,
583 int batchcount, gfp_t gfp)
585 size_t memsize = sizeof(void *) * entries + sizeof(struct array_cache);
586 struct array_cache *ac = NULL;
588 ac = kmalloc_node(memsize, gfp, node);
589 init_arraycache(ac, entries, batchcount);
593 static noinline void cache_free_pfmemalloc(struct kmem_cache *cachep,
594 struct page *page, void *objp)
596 struct kmem_cache_node *n;
600 page_node = page_to_nid(page);
601 n = get_node(cachep, page_node);
603 spin_lock(&n->list_lock);
604 free_block(cachep, &objp, 1, page_node, &list);
605 spin_unlock(&n->list_lock);
607 slabs_destroy(cachep, &list);
611 * Transfer objects in one arraycache to another.
612 * Locking must be handled by the caller.
614 * Return the number of entries transferred.
616 static int transfer_objects(struct array_cache *to,
617 struct array_cache *from, unsigned int max)
619 /* Figure out how many entries to transfer */
620 int nr = min3(from->avail, max, to->limit - to->avail);
625 memcpy(to->entry + to->avail, from->entry + from->avail -nr,
635 #define drain_alien_cache(cachep, alien) do { } while (0)
636 #define reap_alien(cachep, n) do { } while (0)
638 static inline struct alien_cache **alloc_alien_cache(int node,
639 int limit, gfp_t gfp)
644 static inline void free_alien_cache(struct alien_cache **ac_ptr)
648 static inline int cache_free_alien(struct kmem_cache *cachep, void *objp)
653 static inline void *alternate_node_alloc(struct kmem_cache *cachep,
659 static inline void *____cache_alloc_node(struct kmem_cache *cachep,
660 gfp_t flags, int nodeid)
665 static inline gfp_t gfp_exact_node(gfp_t flags)
667 return flags & ~__GFP_NOFAIL;
670 #else /* CONFIG_NUMA */
672 static void *____cache_alloc_node(struct kmem_cache *, gfp_t, int);
673 static void *alternate_node_alloc(struct kmem_cache *, gfp_t);
675 static struct alien_cache *__alloc_alien_cache(int node, int entries,
676 int batch, gfp_t gfp)
678 size_t memsize = sizeof(void *) * entries + sizeof(struct alien_cache);
679 struct alien_cache *alc = NULL;
681 alc = kmalloc_node(memsize, gfp, node);
682 init_arraycache(&alc->ac, entries, batch);
683 spin_lock_init(&alc->lock);
687 static struct alien_cache **alloc_alien_cache(int node, int limit, gfp_t gfp)
689 struct alien_cache **alc_ptr;
690 size_t memsize = sizeof(void *) * nr_node_ids;
695 alc_ptr = kzalloc_node(memsize, gfp, node);
700 if (i == node || !node_online(i))
702 alc_ptr[i] = __alloc_alien_cache(node, limit, 0xbaadf00d, gfp);
704 for (i--; i >= 0; i--)
713 static void free_alien_cache(struct alien_cache **alc_ptr)
724 static void __drain_alien_cache(struct kmem_cache *cachep,
725 struct array_cache *ac, int node,
726 struct list_head *list)
728 struct kmem_cache_node *n = get_node(cachep, node);
731 spin_lock(&n->list_lock);
733 * Stuff objects into the remote nodes shared array first.
734 * That way we could avoid the overhead of putting the objects
735 * into the free lists and getting them back later.
738 transfer_objects(n->shared, ac, ac->limit);
740 free_block(cachep, ac->entry, ac->avail, node, list);
742 spin_unlock(&n->list_lock);
747 * Called from cache_reap() to regularly drain alien caches round robin.
749 static void reap_alien(struct kmem_cache *cachep, struct kmem_cache_node *n)
751 int node = __this_cpu_read(slab_reap_node);
754 struct alien_cache *alc = n->alien[node];
755 struct array_cache *ac;
759 if (ac->avail && spin_trylock_irq(&alc->lock)) {
762 __drain_alien_cache(cachep, ac, node, &list);
763 spin_unlock_irq(&alc->lock);
764 slabs_destroy(cachep, &list);
770 static void drain_alien_cache(struct kmem_cache *cachep,
771 struct alien_cache **alien)
774 struct alien_cache *alc;
775 struct array_cache *ac;
778 for_each_online_node(i) {
784 spin_lock_irqsave(&alc->lock, flags);
785 __drain_alien_cache(cachep, ac, i, &list);
786 spin_unlock_irqrestore(&alc->lock, flags);
787 slabs_destroy(cachep, &list);
792 static int __cache_free_alien(struct kmem_cache *cachep, void *objp,
793 int node, int page_node)
795 struct kmem_cache_node *n;
796 struct alien_cache *alien = NULL;
797 struct array_cache *ac;
800 n = get_node(cachep, node);
801 STATS_INC_NODEFREES(cachep);
802 if (n->alien && n->alien[page_node]) {
803 alien = n->alien[page_node];
805 spin_lock(&alien->lock);
806 if (unlikely(ac->avail == ac->limit)) {
807 STATS_INC_ACOVERFLOW(cachep);
808 __drain_alien_cache(cachep, ac, page_node, &list);
810 ac->entry[ac->avail++] = objp;
811 spin_unlock(&alien->lock);
812 slabs_destroy(cachep, &list);
814 n = get_node(cachep, page_node);
815 spin_lock(&n->list_lock);
816 free_block(cachep, &objp, 1, page_node, &list);
817 spin_unlock(&n->list_lock);
818 slabs_destroy(cachep, &list);
823 static inline int cache_free_alien(struct kmem_cache *cachep, void *objp)
825 int page_node = page_to_nid(virt_to_page(objp));
826 int node = numa_mem_id();
828 * Make sure we are not freeing a object from another node to the array
831 if (likely(node == page_node))
834 return __cache_free_alien(cachep, objp, node, page_node);
838 * Construct gfp mask to allocate from a specific node but do not reclaim or
839 * warn about failures.
841 static inline gfp_t gfp_exact_node(gfp_t flags)
843 return (flags | __GFP_THISNODE | __GFP_NOWARN) & ~(__GFP_RECLAIM|__GFP_NOFAIL);
847 static int init_cache_node(struct kmem_cache *cachep, int node, gfp_t gfp)
849 struct kmem_cache_node *n;
852 * Set up the kmem_cache_node for cpu before we can
853 * begin anything. Make sure some other cpu on this
854 * node has not already allocated this
856 n = get_node(cachep, node);
858 spin_lock_irq(&n->list_lock);
859 n->free_limit = (1 + nr_cpus_node(node)) * cachep->batchcount +
861 spin_unlock_irq(&n->list_lock);
866 n = kmalloc_node(sizeof(struct kmem_cache_node), gfp, node);
870 kmem_cache_node_init(n);
871 n->next_reap = jiffies + REAPTIMEOUT_NODE +
872 ((unsigned long)cachep) % REAPTIMEOUT_NODE;
875 (1 + nr_cpus_node(node)) * cachep->batchcount + cachep->num;
878 * The kmem_cache_nodes don't come and go as CPUs
879 * come and go. slab_mutex is sufficient
882 cachep->node[node] = n;
887 #if (defined(CONFIG_NUMA) && defined(CONFIG_MEMORY_HOTPLUG)) || defined(CONFIG_SMP)
889 * Allocates and initializes node for a node on each slab cache, used for
890 * either memory or cpu hotplug. If memory is being hot-added, the kmem_cache_node
891 * will be allocated off-node since memory is not yet online for the new node.
892 * When hotplugging memory or a cpu, existing node are not replaced if
895 * Must hold slab_mutex.
897 static int init_cache_node_node(int node)
900 struct kmem_cache *cachep;
902 list_for_each_entry(cachep, &slab_caches, list) {
903 ret = init_cache_node(cachep, node, GFP_KERNEL);
912 static int setup_kmem_cache_node(struct kmem_cache *cachep,
913 int node, gfp_t gfp, bool force_change)
916 struct kmem_cache_node *n;
917 struct array_cache *old_shared = NULL;
918 struct array_cache *new_shared = NULL;
919 struct alien_cache **new_alien = NULL;
922 if (use_alien_caches) {
923 new_alien = alloc_alien_cache(node, cachep->limit, gfp);
928 if (cachep->shared) {
929 new_shared = alloc_arraycache(node,
930 cachep->shared * cachep->batchcount, 0xbaadf00d, gfp);
935 ret = init_cache_node(cachep, node, gfp);
939 n = get_node(cachep, node);
940 spin_lock_irq(&n->list_lock);
941 if (n->shared && force_change) {
942 free_block(cachep, n->shared->entry,
943 n->shared->avail, node, &list);
944 n->shared->avail = 0;
947 if (!n->shared || force_change) {
948 old_shared = n->shared;
949 n->shared = new_shared;
954 n->alien = new_alien;
958 spin_unlock_irq(&n->list_lock);
959 slabs_destroy(cachep, &list);
962 * To protect lockless access to n->shared during irq disabled context.
963 * If n->shared isn't NULL in irq disabled context, accessing to it is
964 * guaranteed to be valid until irq is re-enabled, because it will be
965 * freed after synchronize_sched().
967 if (old_shared && force_change)
973 free_alien_cache(new_alien);
980 static void cpuup_canceled(long cpu)
982 struct kmem_cache *cachep;
983 struct kmem_cache_node *n = NULL;
984 int node = cpu_to_mem(cpu);
985 const struct cpumask *mask = cpumask_of_node(node);
987 list_for_each_entry(cachep, &slab_caches, list) {
988 struct array_cache *nc;
989 struct array_cache *shared;
990 struct alien_cache **alien;
993 n = get_node(cachep, node);
997 spin_lock_irq(&n->list_lock);
999 /* Free limit for this kmem_cache_node */
1000 n->free_limit -= cachep->batchcount;
1002 /* cpu is dead; no one can alloc from it. */
1003 nc = per_cpu_ptr(cachep->cpu_cache, cpu);
1005 free_block(cachep, nc->entry, nc->avail, node, &list);
1009 if (!cpumask_empty(mask)) {
1010 spin_unlock_irq(&n->list_lock);
1016 free_block(cachep, shared->entry,
1017 shared->avail, node, &list);
1024 spin_unlock_irq(&n->list_lock);
1028 drain_alien_cache(cachep, alien);
1029 free_alien_cache(alien);
1033 slabs_destroy(cachep, &list);
1036 * In the previous loop, all the objects were freed to
1037 * the respective cache's slabs, now we can go ahead and
1038 * shrink each nodelist to its limit.
1040 list_for_each_entry(cachep, &slab_caches, list) {
1041 n = get_node(cachep, node);
1044 drain_freelist(cachep, n, INT_MAX);
1048 static int cpuup_prepare(long cpu)
1050 struct kmem_cache *cachep;
1051 int node = cpu_to_mem(cpu);
1055 * We need to do this right in the beginning since
1056 * alloc_arraycache's are going to use this list.
1057 * kmalloc_node allows us to add the slab to the right
1058 * kmem_cache_node and not this cpu's kmem_cache_node
1060 err = init_cache_node_node(node);
1065 * Now we can go ahead with allocating the shared arrays and
1068 list_for_each_entry(cachep, &slab_caches, list) {
1069 err = setup_kmem_cache_node(cachep, node, GFP_KERNEL, false);
1076 cpuup_canceled(cpu);
1080 int slab_prepare_cpu(unsigned int cpu)
1084 mutex_lock(&slab_mutex);
1085 err = cpuup_prepare(cpu);
1086 mutex_unlock(&slab_mutex);
1091 * This is called for a failed online attempt and for a successful
1094 * Even if all the cpus of a node are down, we don't free the
1095 * kmem_list3 of any cache. This to avoid a race between cpu_down, and
1096 * a kmalloc allocation from another cpu for memory from the node of
1097 * the cpu going down. The list3 structure is usually allocated from
1098 * kmem_cache_create() and gets destroyed at kmem_cache_destroy().
1100 int slab_dead_cpu(unsigned int cpu)
1102 mutex_lock(&slab_mutex);
1103 cpuup_canceled(cpu);
1104 mutex_unlock(&slab_mutex);
1109 static int slab_online_cpu(unsigned int cpu)
1111 start_cpu_timer(cpu);
1115 static int slab_offline_cpu(unsigned int cpu)
1118 * Shutdown cache reaper. Note that the slab_mutex is held so
1119 * that if cache_reap() is invoked it cannot do anything
1120 * expensive but will only modify reap_work and reschedule the
1123 cancel_delayed_work_sync(&per_cpu(slab_reap_work, cpu));
1124 /* Now the cache_reaper is guaranteed to be not running. */
1125 per_cpu(slab_reap_work, cpu).work.func = NULL;
1129 #if defined(CONFIG_NUMA) && defined(CONFIG_MEMORY_HOTPLUG)
1131 * Drains freelist for a node on each slab cache, used for memory hot-remove.
1132 * Returns -EBUSY if all objects cannot be drained so that the node is not
1135 * Must hold slab_mutex.
1137 static int __meminit drain_cache_node_node(int node)
1139 struct kmem_cache *cachep;
1142 list_for_each_entry(cachep, &slab_caches, list) {
1143 struct kmem_cache_node *n;
1145 n = get_node(cachep, node);
1149 drain_freelist(cachep, n, INT_MAX);
1151 if (!list_empty(&n->slabs_full) ||
1152 !list_empty(&n->slabs_partial)) {
1160 static int __meminit slab_memory_callback(struct notifier_block *self,
1161 unsigned long action, void *arg)
1163 struct memory_notify *mnb = arg;
1167 nid = mnb->status_change_nid;
1172 case MEM_GOING_ONLINE:
1173 mutex_lock(&slab_mutex);
1174 ret = init_cache_node_node(nid);
1175 mutex_unlock(&slab_mutex);
1177 case MEM_GOING_OFFLINE:
1178 mutex_lock(&slab_mutex);
1179 ret = drain_cache_node_node(nid);
1180 mutex_unlock(&slab_mutex);
1184 case MEM_CANCEL_ONLINE:
1185 case MEM_CANCEL_OFFLINE:
1189 return notifier_from_errno(ret);
1191 #endif /* CONFIG_NUMA && CONFIG_MEMORY_HOTPLUG */
1194 * swap the static kmem_cache_node with kmalloced memory
1196 static void __init init_list(struct kmem_cache *cachep, struct kmem_cache_node *list,
1199 struct kmem_cache_node *ptr;
1201 ptr = kmalloc_node(sizeof(struct kmem_cache_node), GFP_NOWAIT, nodeid);
1204 memcpy(ptr, list, sizeof(struct kmem_cache_node));
1206 * Do not assume that spinlocks can be initialized via memcpy:
1208 spin_lock_init(&ptr->list_lock);
1210 MAKE_ALL_LISTS(cachep, ptr, nodeid);
1211 cachep->node[nodeid] = ptr;
1215 * For setting up all the kmem_cache_node for cache whose buffer_size is same as
1216 * size of kmem_cache_node.
1218 static void __init set_up_node(struct kmem_cache *cachep, int index)
1222 for_each_online_node(node) {
1223 cachep->node[node] = &init_kmem_cache_node[index + node];
1224 cachep->node[node]->next_reap = jiffies +
1226 ((unsigned long)cachep) % REAPTIMEOUT_NODE;
1231 * Initialisation. Called after the page allocator have been initialised and
1232 * before smp_init().
1234 void __init kmem_cache_init(void)
1238 kmem_cache = &kmem_cache_boot;
1240 if (!IS_ENABLED(CONFIG_NUMA) || num_possible_nodes() == 1)
1241 use_alien_caches = 0;
1243 for (i = 0; i < NUM_INIT_LISTS; i++)
1244 kmem_cache_node_init(&init_kmem_cache_node[i]);
1247 * Fragmentation resistance on low memory - only use bigger
1248 * page orders on machines with more than 32MB of memory if
1249 * not overridden on the command line.
1251 if (!slab_max_order_set && totalram_pages > (32 << 20) >> PAGE_SHIFT)
1252 slab_max_order = SLAB_MAX_ORDER_HI;
1254 /* Bootstrap is tricky, because several objects are allocated
1255 * from caches that do not exist yet:
1256 * 1) initialize the kmem_cache cache: it contains the struct
1257 * kmem_cache structures of all caches, except kmem_cache itself:
1258 * kmem_cache is statically allocated.
1259 * Initially an __init data area is used for the head array and the
1260 * kmem_cache_node structures, it's replaced with a kmalloc allocated
1261 * array at the end of the bootstrap.
1262 * 2) Create the first kmalloc cache.
1263 * The struct kmem_cache for the new cache is allocated normally.
1264 * An __init data area is used for the head array.
1265 * 3) Create the remaining kmalloc caches, with minimally sized
1267 * 4) Replace the __init data head arrays for kmem_cache and the first
1268 * kmalloc cache with kmalloc allocated arrays.
1269 * 5) Replace the __init data for kmem_cache_node for kmem_cache and
1270 * the other cache's with kmalloc allocated memory.
1271 * 6) Resize the head arrays of the kmalloc caches to their final sizes.
1274 /* 1) create the kmem_cache */
1277 * struct kmem_cache size depends on nr_node_ids & nr_cpu_ids
1279 create_boot_cache(kmem_cache, "kmem_cache",
1280 offsetof(struct kmem_cache, node) +
1281 nr_node_ids * sizeof(struct kmem_cache_node *),
1282 SLAB_HWCACHE_ALIGN, 0, 0);
1283 list_add(&kmem_cache->list, &slab_caches);
1284 memcg_link_cache(kmem_cache);
1285 slab_state = PARTIAL;
1288 * Initialize the caches that provide memory for the kmem_cache_node
1289 * structures first. Without this, further allocations will bug.
1291 kmalloc_caches[INDEX_NODE] = create_kmalloc_cache(
1292 kmalloc_info[INDEX_NODE].name,
1293 kmalloc_size(INDEX_NODE), ARCH_KMALLOC_FLAGS,
1294 0, kmalloc_size(INDEX_NODE));
1295 slab_state = PARTIAL_NODE;
1296 setup_kmalloc_cache_index_table();
1298 slab_early_init = 0;
1300 /* 5) Replace the bootstrap kmem_cache_node */
1304 for_each_online_node(nid) {
1305 init_list(kmem_cache, &init_kmem_cache_node[CACHE_CACHE + nid], nid);
1307 init_list(kmalloc_caches[INDEX_NODE],
1308 &init_kmem_cache_node[SIZE_NODE + nid], nid);
1312 create_kmalloc_caches(ARCH_KMALLOC_FLAGS);
1315 void __init kmem_cache_init_late(void)
1317 struct kmem_cache *cachep;
1319 /* 6) resize the head arrays to their final sizes */
1320 mutex_lock(&slab_mutex);
1321 list_for_each_entry(cachep, &slab_caches, list)
1322 if (enable_cpucache(cachep, GFP_NOWAIT))
1324 mutex_unlock(&slab_mutex);
1331 * Register a memory hotplug callback that initializes and frees
1334 hotplug_memory_notifier(slab_memory_callback, SLAB_CALLBACK_PRI);
1338 * The reap timers are started later, with a module init call: That part
1339 * of the kernel is not yet operational.
1343 static int __init cpucache_init(void)
1348 * Register the timers that return unneeded pages to the page allocator
1350 ret = cpuhp_setup_state(CPUHP_AP_ONLINE_DYN, "SLAB online",
1351 slab_online_cpu, slab_offline_cpu);
1356 __initcall(cpucache_init);
1358 static noinline void
1359 slab_out_of_memory(struct kmem_cache *cachep, gfp_t gfpflags, int nodeid)
1362 struct kmem_cache_node *n;
1363 unsigned long flags;
1365 static DEFINE_RATELIMIT_STATE(slab_oom_rs, DEFAULT_RATELIMIT_INTERVAL,
1366 DEFAULT_RATELIMIT_BURST);
1368 if ((gfpflags & __GFP_NOWARN) || !__ratelimit(&slab_oom_rs))
1371 pr_warn("SLAB: Unable to allocate memory on node %d, gfp=%#x(%pGg)\n",
1372 nodeid, gfpflags, &gfpflags);
1373 pr_warn(" cache: %s, object size: %d, order: %d\n",
1374 cachep->name, cachep->size, cachep->gfporder);
1376 for_each_kmem_cache_node(cachep, node, n) {
1377 unsigned long total_slabs, free_slabs, free_objs;
1379 spin_lock_irqsave(&n->list_lock, flags);
1380 total_slabs = n->total_slabs;
1381 free_slabs = n->free_slabs;
1382 free_objs = n->free_objects;
1383 spin_unlock_irqrestore(&n->list_lock, flags);
1385 pr_warn(" node %d: slabs: %ld/%ld, objs: %ld/%ld\n",
1386 node, total_slabs - free_slabs, total_slabs,
1387 (total_slabs * cachep->num) - free_objs,
1388 total_slabs * cachep->num);
1394 * Interface to system's page allocator. No need to hold the
1395 * kmem_cache_node ->list_lock.
1397 * If we requested dmaable memory, we will get it. Even if we
1398 * did not request dmaable memory, we might get it, but that
1399 * would be relatively rare and ignorable.
1401 static struct page *kmem_getpages(struct kmem_cache *cachep, gfp_t flags,
1407 flags |= cachep->allocflags;
1409 page = __alloc_pages_node(nodeid, flags, cachep->gfporder);
1411 slab_out_of_memory(cachep, flags, nodeid);
1415 if (memcg_charge_slab(page, flags, cachep->gfporder, cachep)) {
1416 __free_pages(page, cachep->gfporder);
1420 nr_pages = (1 << cachep->gfporder);
1421 if (cachep->flags & SLAB_RECLAIM_ACCOUNT)
1422 mod_lruvec_page_state(page, NR_SLAB_RECLAIMABLE, nr_pages);
1424 mod_lruvec_page_state(page, NR_SLAB_UNRECLAIMABLE, nr_pages);
1426 __SetPageSlab(page);
1427 /* Record if ALLOC_NO_WATERMARKS was set when allocating the slab */
1428 if (sk_memalloc_socks() && page_is_pfmemalloc(page))
1429 SetPageSlabPfmemalloc(page);
1435 * Interface to system's page release.
1437 static void kmem_freepages(struct kmem_cache *cachep, struct page *page)
1439 int order = cachep->gfporder;
1440 unsigned long nr_freed = (1 << order);
1442 if (cachep->flags & SLAB_RECLAIM_ACCOUNT)
1443 mod_lruvec_page_state(page, NR_SLAB_RECLAIMABLE, -nr_freed);
1445 mod_lruvec_page_state(page, NR_SLAB_UNRECLAIMABLE, -nr_freed);
1447 BUG_ON(!PageSlab(page));
1448 __ClearPageSlabPfmemalloc(page);
1449 __ClearPageSlab(page);
1450 page_mapcount_reset(page);
1451 page->mapping = NULL;
1453 if (current->reclaim_state)
1454 current->reclaim_state->reclaimed_slab += nr_freed;
1455 memcg_uncharge_slab(page, order, cachep);
1456 __free_pages(page, order);
1459 static void kmem_rcu_free(struct rcu_head *head)
1461 struct kmem_cache *cachep;
1464 page = container_of(head, struct page, rcu_head);
1465 cachep = page->slab_cache;
1467 kmem_freepages(cachep, page);
1471 static bool is_debug_pagealloc_cache(struct kmem_cache *cachep)
1473 if (debug_pagealloc_enabled() && OFF_SLAB(cachep) &&
1474 (cachep->size % PAGE_SIZE) == 0)
1480 #ifdef CONFIG_DEBUG_PAGEALLOC
1481 static void store_stackinfo(struct kmem_cache *cachep, unsigned long *addr,
1482 unsigned long caller)
1484 int size = cachep->object_size;
1486 addr = (unsigned long *)&((char *)addr)[obj_offset(cachep)];
1488 if (size < 5 * sizeof(unsigned long))
1491 *addr++ = 0x12345678;
1493 *addr++ = smp_processor_id();
1494 size -= 3 * sizeof(unsigned long);
1496 unsigned long *sptr = &caller;
1497 unsigned long svalue;
1499 while (!kstack_end(sptr)) {
1501 if (kernel_text_address(svalue)) {
1503 size -= sizeof(unsigned long);
1504 if (size <= sizeof(unsigned long))
1510 *addr++ = 0x87654321;
1513 static void slab_kernel_map(struct kmem_cache *cachep, void *objp,
1514 int map, unsigned long caller)
1516 if (!is_debug_pagealloc_cache(cachep))
1520 store_stackinfo(cachep, objp, caller);
1522 kernel_map_pages(virt_to_page(objp), cachep->size / PAGE_SIZE, map);
1526 static inline void slab_kernel_map(struct kmem_cache *cachep, void *objp,
1527 int map, unsigned long caller) {}
1531 static void poison_obj(struct kmem_cache *cachep, void *addr, unsigned char val)
1533 int size = cachep->object_size;
1534 addr = &((char *)addr)[obj_offset(cachep)];
1536 memset(addr, val, size);
1537 *(unsigned char *)(addr + size - 1) = POISON_END;
1540 static void dump_line(char *data, int offset, int limit)
1543 unsigned char error = 0;
1546 pr_err("%03x: ", offset);
1547 for (i = 0; i < limit; i++) {
1548 if (data[offset + i] != POISON_FREE) {
1549 error = data[offset + i];
1553 print_hex_dump(KERN_CONT, "", 0, 16, 1,
1554 &data[offset], limit, 1);
1556 if (bad_count == 1) {
1557 error ^= POISON_FREE;
1558 if (!(error & (error - 1))) {
1559 pr_err("Single bit error detected. Probably bad RAM.\n");
1561 pr_err("Run memtest86+ or a similar memory test tool.\n");
1563 pr_err("Run a memory test tool.\n");
1572 static void print_objinfo(struct kmem_cache *cachep, void *objp, int lines)
1577 if (cachep->flags & SLAB_RED_ZONE) {
1578 pr_err("Redzone: 0x%llx/0x%llx\n",
1579 *dbg_redzone1(cachep, objp),
1580 *dbg_redzone2(cachep, objp));
1583 if (cachep->flags & SLAB_STORE_USER)
1584 pr_err("Last user: (%pSR)\n", *dbg_userword(cachep, objp));
1585 realobj = (char *)objp + obj_offset(cachep);
1586 size = cachep->object_size;
1587 for (i = 0; i < size && lines; i += 16, lines--) {
1590 if (i + limit > size)
1592 dump_line(realobj, i, limit);
1596 static void check_poison_obj(struct kmem_cache *cachep, void *objp)
1602 if (is_debug_pagealloc_cache(cachep))
1605 realobj = (char *)objp + obj_offset(cachep);
1606 size = cachep->object_size;
1608 for (i = 0; i < size; i++) {
1609 char exp = POISON_FREE;
1612 if (realobj[i] != exp) {
1617 pr_err("Slab corruption (%s): %s start=%px, len=%d\n",
1618 print_tainted(), cachep->name,
1620 print_objinfo(cachep, objp, 0);
1622 /* Hexdump the affected line */
1625 if (i + limit > size)
1627 dump_line(realobj, i, limit);
1630 /* Limit to 5 lines */
1636 /* Print some data about the neighboring objects, if they
1639 struct page *page = virt_to_head_page(objp);
1642 objnr = obj_to_index(cachep, page, objp);
1644 objp = index_to_obj(cachep, page, objnr - 1);
1645 realobj = (char *)objp + obj_offset(cachep);
1646 pr_err("Prev obj: start=%px, len=%d\n", realobj, size);
1647 print_objinfo(cachep, objp, 2);
1649 if (objnr + 1 < cachep->num) {
1650 objp = index_to_obj(cachep, page, objnr + 1);
1651 realobj = (char *)objp + obj_offset(cachep);
1652 pr_err("Next obj: start=%px, len=%d\n", realobj, size);
1653 print_objinfo(cachep, objp, 2);
1660 static void slab_destroy_debugcheck(struct kmem_cache *cachep,
1665 if (OBJFREELIST_SLAB(cachep) && cachep->flags & SLAB_POISON) {
1666 poison_obj(cachep, page->freelist - obj_offset(cachep),
1670 for (i = 0; i < cachep->num; i++) {
1671 void *objp = index_to_obj(cachep, page, i);
1673 if (cachep->flags & SLAB_POISON) {
1674 check_poison_obj(cachep, objp);
1675 slab_kernel_map(cachep, objp, 1, 0);
1677 if (cachep->flags & SLAB_RED_ZONE) {
1678 if (*dbg_redzone1(cachep, objp) != RED_INACTIVE)
1679 slab_error(cachep, "start of a freed object was overwritten");
1680 if (*dbg_redzone2(cachep, objp) != RED_INACTIVE)
1681 slab_error(cachep, "end of a freed object was overwritten");
1686 static void slab_destroy_debugcheck(struct kmem_cache *cachep,
1693 * slab_destroy - destroy and release all objects in a slab
1694 * @cachep: cache pointer being destroyed
1695 * @page: page pointer being destroyed
1697 * Destroy all the objs in a slab page, and release the mem back to the system.
1698 * Before calling the slab page must have been unlinked from the cache. The
1699 * kmem_cache_node ->list_lock is not held/needed.
1701 static void slab_destroy(struct kmem_cache *cachep, struct page *page)
1705 freelist = page->freelist;
1706 slab_destroy_debugcheck(cachep, page);
1707 if (unlikely(cachep->flags & SLAB_TYPESAFE_BY_RCU))
1708 call_rcu(&page->rcu_head, kmem_rcu_free);
1710 kmem_freepages(cachep, page);
1713 * From now on, we don't use freelist
1714 * although actual page can be freed in rcu context
1716 if (OFF_SLAB(cachep))
1717 kmem_cache_free(cachep->freelist_cache, freelist);
1720 static void slabs_destroy(struct kmem_cache *cachep, struct list_head *list)
1722 struct page *page, *n;
1724 list_for_each_entry_safe(page, n, list, lru) {
1725 list_del(&page->lru);
1726 slab_destroy(cachep, page);
1731 * calculate_slab_order - calculate size (page order) of slabs
1732 * @cachep: pointer to the cache that is being created
1733 * @size: size of objects to be created in this cache.
1734 * @flags: slab allocation flags
1736 * Also calculates the number of objects per slab.
1738 * This could be made much more intelligent. For now, try to avoid using
1739 * high order pages for slabs. When the gfp() functions are more friendly
1740 * towards high-order requests, this should be changed.
1742 static size_t calculate_slab_order(struct kmem_cache *cachep,
1743 size_t size, slab_flags_t flags)
1745 size_t left_over = 0;
1748 for (gfporder = 0; gfporder <= KMALLOC_MAX_ORDER; gfporder++) {
1752 num = cache_estimate(gfporder, size, flags, &remainder);
1756 /* Can't handle number of objects more than SLAB_OBJ_MAX_NUM */
1757 if (num > SLAB_OBJ_MAX_NUM)
1760 if (flags & CFLGS_OFF_SLAB) {
1761 struct kmem_cache *freelist_cache;
1762 size_t freelist_size;
1764 freelist_size = num * sizeof(freelist_idx_t);
1765 freelist_cache = kmalloc_slab(freelist_size, 0u);
1766 if (!freelist_cache)
1770 * Needed to avoid possible looping condition
1771 * in cache_grow_begin()
1773 if (OFF_SLAB(freelist_cache))
1776 /* check if off slab has enough benefit */
1777 if (freelist_cache->size > cachep->size / 2)
1781 /* Found something acceptable - save it away */
1783 cachep->gfporder = gfporder;
1784 left_over = remainder;
1787 * A VFS-reclaimable slab tends to have most allocations
1788 * as GFP_NOFS and we really don't want to have to be allocating
1789 * higher-order pages when we are unable to shrink dcache.
1791 if (flags & SLAB_RECLAIM_ACCOUNT)
1795 * Large number of objects is good, but very large slabs are
1796 * currently bad for the gfp()s.
1798 if (gfporder >= slab_max_order)
1802 * Acceptable internal fragmentation?
1804 if (left_over * 8 <= (PAGE_SIZE << gfporder))
1810 static struct array_cache __percpu *alloc_kmem_cache_cpus(
1811 struct kmem_cache *cachep, int entries, int batchcount)
1815 struct array_cache __percpu *cpu_cache;
1817 size = sizeof(void *) * entries + sizeof(struct array_cache);
1818 cpu_cache = __alloc_percpu(size, sizeof(void *));
1823 for_each_possible_cpu(cpu) {
1824 init_arraycache(per_cpu_ptr(cpu_cache, cpu),
1825 entries, batchcount);
1831 static int __ref setup_cpu_cache(struct kmem_cache *cachep, gfp_t gfp)
1833 if (slab_state >= FULL)
1834 return enable_cpucache(cachep, gfp);
1836 cachep->cpu_cache = alloc_kmem_cache_cpus(cachep, 1, 1);
1837 if (!cachep->cpu_cache)
1840 if (slab_state == DOWN) {
1841 /* Creation of first cache (kmem_cache). */
1842 set_up_node(kmem_cache, CACHE_CACHE);
1843 } else if (slab_state == PARTIAL) {
1844 /* For kmem_cache_node */
1845 set_up_node(cachep, SIZE_NODE);
1849 for_each_online_node(node) {
1850 cachep->node[node] = kmalloc_node(
1851 sizeof(struct kmem_cache_node), gfp, node);
1852 BUG_ON(!cachep->node[node]);
1853 kmem_cache_node_init(cachep->node[node]);
1857 cachep->node[numa_mem_id()]->next_reap =
1858 jiffies + REAPTIMEOUT_NODE +
1859 ((unsigned long)cachep) % REAPTIMEOUT_NODE;
1861 cpu_cache_get(cachep)->avail = 0;
1862 cpu_cache_get(cachep)->limit = BOOT_CPUCACHE_ENTRIES;
1863 cpu_cache_get(cachep)->batchcount = 1;
1864 cpu_cache_get(cachep)->touched = 0;
1865 cachep->batchcount = 1;
1866 cachep->limit = BOOT_CPUCACHE_ENTRIES;
1870 slab_flags_t kmem_cache_flags(unsigned int object_size,
1871 slab_flags_t flags, const char *name,
1872 void (*ctor)(void *))
1878 __kmem_cache_alias(const char *name, unsigned int size, unsigned int align,
1879 slab_flags_t flags, void (*ctor)(void *))
1881 struct kmem_cache *cachep;
1883 cachep = find_mergeable(size, align, flags, name, ctor);
1888 * Adjust the object sizes so that we clear
1889 * the complete object on kzalloc.
1891 cachep->object_size = max_t(int, cachep->object_size, size);
1896 static bool set_objfreelist_slab_cache(struct kmem_cache *cachep,
1897 size_t size, slab_flags_t flags)
1903 if (cachep->ctor || flags & SLAB_TYPESAFE_BY_RCU)
1906 left = calculate_slab_order(cachep, size,
1907 flags | CFLGS_OBJFREELIST_SLAB);
1911 if (cachep->num * sizeof(freelist_idx_t) > cachep->object_size)
1914 cachep->colour = left / cachep->colour_off;
1919 static bool set_off_slab_cache(struct kmem_cache *cachep,
1920 size_t size, slab_flags_t flags)
1927 * Always use on-slab management when SLAB_NOLEAKTRACE
1928 * to avoid recursive calls into kmemleak.
1930 if (flags & SLAB_NOLEAKTRACE)
1934 * Size is large, assume best to place the slab management obj
1935 * off-slab (should allow better packing of objs).
1937 left = calculate_slab_order(cachep, size, flags | CFLGS_OFF_SLAB);
1942 * If the slab has been placed off-slab, and we have enough space then
1943 * move it on-slab. This is at the expense of any extra colouring.
1945 if (left >= cachep->num * sizeof(freelist_idx_t))
1948 cachep->colour = left / cachep->colour_off;
1953 static bool set_on_slab_cache(struct kmem_cache *cachep,
1954 size_t size, slab_flags_t flags)
1960 left = calculate_slab_order(cachep, size, flags);
1964 cachep->colour = left / cachep->colour_off;
1970 * __kmem_cache_create - Create a cache.
1971 * @cachep: cache management descriptor
1972 * @flags: SLAB flags
1974 * Returns a ptr to the cache on success, NULL on failure.
1975 * Cannot be called within a int, but can be interrupted.
1976 * The @ctor is run when new pages are allocated by the cache.
1980 * %SLAB_POISON - Poison the slab with a known test pattern (a5a5a5a5)
1981 * to catch references to uninitialised memory.
1983 * %SLAB_RED_ZONE - Insert `Red' zones around the allocated memory to check
1984 * for buffer overruns.
1986 * %SLAB_HWCACHE_ALIGN - Align the objects in this cache to a hardware
1987 * cacheline. This can be beneficial if you're counting cycles as closely
1990 int __kmem_cache_create(struct kmem_cache *cachep, slab_flags_t flags)
1992 size_t ralign = BYTES_PER_WORD;
1995 unsigned int size = cachep->size;
2000 * Enable redzoning and last user accounting, except for caches with
2001 * large objects, if the increased size would increase the object size
2002 * above the next power of two: caches with object sizes just above a
2003 * power of two have a significant amount of internal fragmentation.
2005 if (size < 4096 || fls(size - 1) == fls(size-1 + REDZONE_ALIGN +
2006 2 * sizeof(unsigned long long)))
2007 flags |= SLAB_RED_ZONE | SLAB_STORE_USER;
2008 if (!(flags & SLAB_TYPESAFE_BY_RCU))
2009 flags |= SLAB_POISON;
2014 * Check that size is in terms of words. This is needed to avoid
2015 * unaligned accesses for some archs when redzoning is used, and makes
2016 * sure any on-slab bufctl's are also correctly aligned.
2018 size = ALIGN(size, BYTES_PER_WORD);
2020 if (flags & SLAB_RED_ZONE) {
2021 ralign = REDZONE_ALIGN;
2022 /* If redzoning, ensure that the second redzone is suitably
2023 * aligned, by adjusting the object size accordingly. */
2024 size = ALIGN(size, REDZONE_ALIGN);
2027 /* 3) caller mandated alignment */
2028 if (ralign < cachep->align) {
2029 ralign = cachep->align;
2031 /* disable debug if necessary */
2032 if (ralign > __alignof__(unsigned long long))
2033 flags &= ~(SLAB_RED_ZONE | SLAB_STORE_USER);
2037 cachep->align = ralign;
2038 cachep->colour_off = cache_line_size();
2039 /* Offset must be a multiple of the alignment. */
2040 if (cachep->colour_off < cachep->align)
2041 cachep->colour_off = cachep->align;
2043 if (slab_is_available())
2051 * Both debugging options require word-alignment which is calculated
2054 if (flags & SLAB_RED_ZONE) {
2055 /* add space for red zone words */
2056 cachep->obj_offset += sizeof(unsigned long long);
2057 size += 2 * sizeof(unsigned long long);
2059 if (flags & SLAB_STORE_USER) {
2060 /* user store requires one word storage behind the end of
2061 * the real object. But if the second red zone needs to be
2062 * aligned to 64 bits, we must allow that much space.
2064 if (flags & SLAB_RED_ZONE)
2065 size += REDZONE_ALIGN;
2067 size += BYTES_PER_WORD;
2071 kasan_cache_create(cachep, &size, &flags);
2073 size = ALIGN(size, cachep->align);
2075 * We should restrict the number of objects in a slab to implement
2076 * byte sized index. Refer comment on SLAB_OBJ_MIN_SIZE definition.
2078 if (FREELIST_BYTE_INDEX && size < SLAB_OBJ_MIN_SIZE)
2079 size = ALIGN(SLAB_OBJ_MIN_SIZE, cachep->align);
2083 * To activate debug pagealloc, off-slab management is necessary
2084 * requirement. In early phase of initialization, small sized slab
2085 * doesn't get initialized so it would not be possible. So, we need
2086 * to check size >= 256. It guarantees that all necessary small
2087 * sized slab is initialized in current slab initialization sequence.
2089 if (debug_pagealloc_enabled() && (flags & SLAB_POISON) &&
2090 size >= 256 && cachep->object_size > cache_line_size()) {
2091 if (size < PAGE_SIZE || size % PAGE_SIZE == 0) {
2092 size_t tmp_size = ALIGN(size, PAGE_SIZE);
2094 if (set_off_slab_cache(cachep, tmp_size, flags)) {
2095 flags |= CFLGS_OFF_SLAB;
2096 cachep->obj_offset += tmp_size - size;
2104 if (set_objfreelist_slab_cache(cachep, size, flags)) {
2105 flags |= CFLGS_OBJFREELIST_SLAB;
2109 if (set_off_slab_cache(cachep, size, flags)) {
2110 flags |= CFLGS_OFF_SLAB;
2114 if (set_on_slab_cache(cachep, size, flags))
2120 cachep->freelist_size = cachep->num * sizeof(freelist_idx_t);
2121 cachep->flags = flags;
2122 cachep->allocflags = __GFP_COMP;
2123 if (flags & SLAB_CACHE_DMA)
2124 cachep->allocflags |= GFP_DMA;
2125 if (flags & SLAB_RECLAIM_ACCOUNT)
2126 cachep->allocflags |= __GFP_RECLAIMABLE;
2127 cachep->size = size;
2128 cachep->reciprocal_buffer_size = reciprocal_value(size);
2132 * If we're going to use the generic kernel_map_pages()
2133 * poisoning, then it's going to smash the contents of
2134 * the redzone and userword anyhow, so switch them off.
2136 if (IS_ENABLED(CONFIG_PAGE_POISONING) &&
2137 (cachep->flags & SLAB_POISON) &&
2138 is_debug_pagealloc_cache(cachep))
2139 cachep->flags &= ~(SLAB_RED_ZONE | SLAB_STORE_USER);
2142 if (OFF_SLAB(cachep)) {
2143 cachep->freelist_cache =
2144 kmalloc_slab(cachep->freelist_size, 0u);
2147 err = setup_cpu_cache(cachep, gfp);
2149 __kmem_cache_release(cachep);
2157 static void check_irq_off(void)
2159 BUG_ON(!irqs_disabled());
2162 static void check_irq_on(void)
2164 BUG_ON(irqs_disabled());
2167 static void check_mutex_acquired(void)
2169 BUG_ON(!mutex_is_locked(&slab_mutex));
2172 static void check_spinlock_acquired(struct kmem_cache *cachep)
2176 assert_spin_locked(&get_node(cachep, numa_mem_id())->list_lock);
2180 static void check_spinlock_acquired_node(struct kmem_cache *cachep, int node)
2184 assert_spin_locked(&get_node(cachep, node)->list_lock);
2189 #define check_irq_off() do { } while(0)
2190 #define check_irq_on() do { } while(0)
2191 #define check_mutex_acquired() do { } while(0)
2192 #define check_spinlock_acquired(x) do { } while(0)
2193 #define check_spinlock_acquired_node(x, y) do { } while(0)
2196 static void drain_array_locked(struct kmem_cache *cachep, struct array_cache *ac,
2197 int node, bool free_all, struct list_head *list)
2201 if (!ac || !ac->avail)
2204 tofree = free_all ? ac->avail : (ac->limit + 4) / 5;
2205 if (tofree > ac->avail)
2206 tofree = (ac->avail + 1) / 2;
2208 free_block(cachep, ac->entry, tofree, node, list);
2209 ac->avail -= tofree;
2210 memmove(ac->entry, &(ac->entry[tofree]), sizeof(void *) * ac->avail);
2213 static void do_drain(void *arg)
2215 struct kmem_cache *cachep = arg;
2216 struct array_cache *ac;
2217 int node = numa_mem_id();
2218 struct kmem_cache_node *n;
2222 ac = cpu_cache_get(cachep);
2223 n = get_node(cachep, node);
2224 spin_lock(&n->list_lock);
2225 free_block(cachep, ac->entry, ac->avail, node, &list);
2226 spin_unlock(&n->list_lock);
2227 slabs_destroy(cachep, &list);
2231 static void drain_cpu_caches(struct kmem_cache *cachep)
2233 struct kmem_cache_node *n;
2237 on_each_cpu(do_drain, cachep, 1);
2239 for_each_kmem_cache_node(cachep, node, n)
2241 drain_alien_cache(cachep, n->alien);
2243 for_each_kmem_cache_node(cachep, node, n) {
2244 spin_lock_irq(&n->list_lock);
2245 drain_array_locked(cachep, n->shared, node, true, &list);
2246 spin_unlock_irq(&n->list_lock);
2248 slabs_destroy(cachep, &list);
2253 * Remove slabs from the list of free slabs.
2254 * Specify the number of slabs to drain in tofree.
2256 * Returns the actual number of slabs released.
2258 static int drain_freelist(struct kmem_cache *cache,
2259 struct kmem_cache_node *n, int tofree)
2261 struct list_head *p;
2266 while (nr_freed < tofree && !list_empty(&n->slabs_free)) {
2268 spin_lock_irq(&n->list_lock);
2269 p = n->slabs_free.prev;
2270 if (p == &n->slabs_free) {
2271 spin_unlock_irq(&n->list_lock);
2275 page = list_entry(p, struct page, lru);
2276 list_del(&page->lru);
2280 * Safe to drop the lock. The slab is no longer linked
2283 n->free_objects -= cache->num;
2284 spin_unlock_irq(&n->list_lock);
2285 slab_destroy(cache, page);
2292 bool __kmem_cache_empty(struct kmem_cache *s)
2295 struct kmem_cache_node *n;
2297 for_each_kmem_cache_node(s, node, n)
2298 if (!list_empty(&n->slabs_full) ||
2299 !list_empty(&n->slabs_partial))
2304 int __kmem_cache_shrink(struct kmem_cache *cachep)
2308 struct kmem_cache_node *n;
2310 drain_cpu_caches(cachep);
2313 for_each_kmem_cache_node(cachep, node, n) {
2314 drain_freelist(cachep, n, INT_MAX);
2316 ret += !list_empty(&n->slabs_full) ||
2317 !list_empty(&n->slabs_partial);
2319 return (ret ? 1 : 0);
2323 void __kmemcg_cache_deactivate(struct kmem_cache *cachep)
2325 __kmem_cache_shrink(cachep);
2329 int __kmem_cache_shutdown(struct kmem_cache *cachep)
2331 return __kmem_cache_shrink(cachep);
2334 void __kmem_cache_release(struct kmem_cache *cachep)
2337 struct kmem_cache_node *n;
2339 cache_random_seq_destroy(cachep);
2341 free_percpu(cachep->cpu_cache);
2343 /* NUMA: free the node structures */
2344 for_each_kmem_cache_node(cachep, i, n) {
2346 free_alien_cache(n->alien);
2348 cachep->node[i] = NULL;
2353 * Get the memory for a slab management obj.
2355 * For a slab cache when the slab descriptor is off-slab, the
2356 * slab descriptor can't come from the same cache which is being created,
2357 * Because if it is the case, that means we defer the creation of
2358 * the kmalloc_{dma,}_cache of size sizeof(slab descriptor) to this point.
2359 * And we eventually call down to __kmem_cache_create(), which
2360 * in turn looks up in the kmalloc_{dma,}_caches for the disired-size one.
2361 * This is a "chicken-and-egg" problem.
2363 * So the off-slab slab descriptor shall come from the kmalloc_{dma,}_caches,
2364 * which are all initialized during kmem_cache_init().
2366 static void *alloc_slabmgmt(struct kmem_cache *cachep,
2367 struct page *page, int colour_off,
2368 gfp_t local_flags, int nodeid)
2371 void *addr = page_address(page);
2373 page->s_mem = addr + colour_off;
2376 if (OBJFREELIST_SLAB(cachep))
2378 else if (OFF_SLAB(cachep)) {
2379 /* Slab management obj is off-slab. */
2380 freelist = kmem_cache_alloc_node(cachep->freelist_cache,
2381 local_flags, nodeid);
2385 /* We will use last bytes at the slab for freelist */
2386 freelist = addr + (PAGE_SIZE << cachep->gfporder) -
2387 cachep->freelist_size;
2393 static inline freelist_idx_t get_free_obj(struct page *page, unsigned int idx)
2395 return ((freelist_idx_t *)page->freelist)[idx];
2398 static inline void set_free_obj(struct page *page,
2399 unsigned int idx, freelist_idx_t val)
2401 ((freelist_idx_t *)(page->freelist))[idx] = val;
2404 static void cache_init_objs_debug(struct kmem_cache *cachep, struct page *page)
2409 for (i = 0; i < cachep->num; i++) {
2410 void *objp = index_to_obj(cachep, page, i);
2412 if (cachep->flags & SLAB_STORE_USER)
2413 *dbg_userword(cachep, objp) = NULL;
2415 if (cachep->flags & SLAB_RED_ZONE) {
2416 *dbg_redzone1(cachep, objp) = RED_INACTIVE;
2417 *dbg_redzone2(cachep, objp) = RED_INACTIVE;
2420 * Constructors are not allowed to allocate memory from the same
2421 * cache which they are a constructor for. Otherwise, deadlock.
2422 * They must also be threaded.
2424 if (cachep->ctor && !(cachep->flags & SLAB_POISON)) {
2425 kasan_unpoison_object_data(cachep,
2426 objp + obj_offset(cachep));
2427 cachep->ctor(objp + obj_offset(cachep));
2428 kasan_poison_object_data(
2429 cachep, objp + obj_offset(cachep));
2432 if (cachep->flags & SLAB_RED_ZONE) {
2433 if (*dbg_redzone2(cachep, objp) != RED_INACTIVE)
2434 slab_error(cachep, "constructor overwrote the end of an object");
2435 if (*dbg_redzone1(cachep, objp) != RED_INACTIVE)
2436 slab_error(cachep, "constructor overwrote the start of an object");
2438 /* need to poison the objs? */
2439 if (cachep->flags & SLAB_POISON) {
2440 poison_obj(cachep, objp, POISON_FREE);
2441 slab_kernel_map(cachep, objp, 0, 0);
2447 #ifdef CONFIG_SLAB_FREELIST_RANDOM
2448 /* Hold information during a freelist initialization */
2449 union freelist_init_state {
2455 struct rnd_state rnd_state;
2459 * Initialize the state based on the randomization methode available.
2460 * return true if the pre-computed list is available, false otherwize.
2462 static bool freelist_state_initialize(union freelist_init_state *state,
2463 struct kmem_cache *cachep,
2469 /* Use best entropy available to define a random shift */
2470 rand = get_random_int();
2472 /* Use a random state if the pre-computed list is not available */
2473 if (!cachep->random_seq) {
2474 prandom_seed_state(&state->rnd_state, rand);
2477 state->list = cachep->random_seq;
2478 state->count = count;
2479 state->pos = rand % count;
2485 /* Get the next entry on the list and randomize it using a random shift */
2486 static freelist_idx_t next_random_slot(union freelist_init_state *state)
2488 if (state->pos >= state->count)
2490 return state->list[state->pos++];
2493 /* Swap two freelist entries */
2494 static void swap_free_obj(struct page *page, unsigned int a, unsigned int b)
2496 swap(((freelist_idx_t *)page->freelist)[a],
2497 ((freelist_idx_t *)page->freelist)[b]);
2501 * Shuffle the freelist initialization state based on pre-computed lists.
2502 * return true if the list was successfully shuffled, false otherwise.
2504 static bool shuffle_freelist(struct kmem_cache *cachep, struct page *page)
2506 unsigned int objfreelist = 0, i, rand, count = cachep->num;
2507 union freelist_init_state state;
2513 precomputed = freelist_state_initialize(&state, cachep, count);
2515 /* Take a random entry as the objfreelist */
2516 if (OBJFREELIST_SLAB(cachep)) {
2518 objfreelist = count - 1;
2520 objfreelist = next_random_slot(&state);
2521 page->freelist = index_to_obj(cachep, page, objfreelist) +
2527 * On early boot, generate the list dynamically.
2528 * Later use a pre-computed list for speed.
2531 for (i = 0; i < count; i++)
2532 set_free_obj(page, i, i);
2534 /* Fisher-Yates shuffle */
2535 for (i = count - 1; i > 0; i--) {
2536 rand = prandom_u32_state(&state.rnd_state);
2538 swap_free_obj(page, i, rand);
2541 for (i = 0; i < count; i++)
2542 set_free_obj(page, i, next_random_slot(&state));
2545 if (OBJFREELIST_SLAB(cachep))
2546 set_free_obj(page, cachep->num - 1, objfreelist);
2551 static inline bool shuffle_freelist(struct kmem_cache *cachep,
2556 #endif /* CONFIG_SLAB_FREELIST_RANDOM */
2558 static void cache_init_objs(struct kmem_cache *cachep,
2565 cache_init_objs_debug(cachep, page);
2567 /* Try to randomize the freelist if enabled */
2568 shuffled = shuffle_freelist(cachep, page);
2570 if (!shuffled && OBJFREELIST_SLAB(cachep)) {
2571 page->freelist = index_to_obj(cachep, page, cachep->num - 1) +
2575 for (i = 0; i < cachep->num; i++) {
2576 objp = index_to_obj(cachep, page, i);
2577 kasan_init_slab_obj(cachep, objp);
2579 /* constructor could break poison info */
2580 if (DEBUG == 0 && cachep->ctor) {
2581 kasan_unpoison_object_data(cachep, objp);
2583 kasan_poison_object_data(cachep, objp);
2587 set_free_obj(page, i, i);
2591 static void *slab_get_obj(struct kmem_cache *cachep, struct page *page)
2595 objp = index_to_obj(cachep, page, get_free_obj(page, page->active));
2599 if (cachep->flags & SLAB_STORE_USER)
2600 set_store_user_dirty(cachep);
2606 static void slab_put_obj(struct kmem_cache *cachep,
2607 struct page *page, void *objp)
2609 unsigned int objnr = obj_to_index(cachep, page, objp);
2613 /* Verify double free bug */
2614 for (i = page->active; i < cachep->num; i++) {
2615 if (get_free_obj(page, i) == objnr) {
2616 pr_err("slab: double free detected in cache '%s', objp %px\n",
2617 cachep->name, objp);
2623 if (!page->freelist)
2624 page->freelist = objp + obj_offset(cachep);
2626 set_free_obj(page, page->active, objnr);
2630 * Map pages beginning at addr to the given cache and slab. This is required
2631 * for the slab allocator to be able to lookup the cache and slab of a
2632 * virtual address for kfree, ksize, and slab debugging.
2634 static void slab_map_pages(struct kmem_cache *cache, struct page *page,
2637 page->slab_cache = cache;
2638 page->freelist = freelist;
2642 * Grow (by 1) the number of slabs within a cache. This is called by
2643 * kmem_cache_alloc() when there are no active objs left in a cache.
2645 static struct page *cache_grow_begin(struct kmem_cache *cachep,
2646 gfp_t flags, int nodeid)
2652 struct kmem_cache_node *n;
2656 * Be lazy and only check for valid flags here, keeping it out of the
2657 * critical path in kmem_cache_alloc().
2659 if (unlikely(flags & GFP_SLAB_BUG_MASK)) {
2660 gfp_t invalid_mask = flags & GFP_SLAB_BUG_MASK;
2661 flags &= ~GFP_SLAB_BUG_MASK;
2662 pr_warn("Unexpected gfp: %#x (%pGg). Fixing up to gfp: %#x (%pGg). Fix your code!\n",
2663 invalid_mask, &invalid_mask, flags, &flags);
2666 WARN_ON_ONCE(cachep->ctor && (flags & __GFP_ZERO));
2667 local_flags = flags & (GFP_CONSTRAINT_MASK|GFP_RECLAIM_MASK);
2670 if (gfpflags_allow_blocking(local_flags))
2674 * Get mem for the objs. Attempt to allocate a physical page from
2677 page = kmem_getpages(cachep, local_flags, nodeid);
2681 page_node = page_to_nid(page);
2682 n = get_node(cachep, page_node);
2684 /* Get colour for the slab, and cal the next value. */
2686 if (n->colour_next >= cachep->colour)
2689 offset = n->colour_next;
2690 if (offset >= cachep->colour)
2693 offset *= cachep->colour_off;
2695 /* Get slab management. */
2696 freelist = alloc_slabmgmt(cachep, page, offset,
2697 local_flags & ~GFP_CONSTRAINT_MASK, page_node);
2698 if (OFF_SLAB(cachep) && !freelist)
2701 slab_map_pages(cachep, page, freelist);
2703 kasan_poison_slab(page);
2704 cache_init_objs(cachep, page);
2706 if (gfpflags_allow_blocking(local_flags))
2707 local_irq_disable();
2712 kmem_freepages(cachep, page);
2714 if (gfpflags_allow_blocking(local_flags))
2715 local_irq_disable();
2719 static void cache_grow_end(struct kmem_cache *cachep, struct page *page)
2721 struct kmem_cache_node *n;
2729 INIT_LIST_HEAD(&page->lru);
2730 n = get_node(cachep, page_to_nid(page));
2732 spin_lock(&n->list_lock);
2734 if (!page->active) {
2735 list_add_tail(&page->lru, &(n->slabs_free));
2738 fixup_slab_list(cachep, n, page, &list);
2740 STATS_INC_GROWN(cachep);
2741 n->free_objects += cachep->num - page->active;
2742 spin_unlock(&n->list_lock);
2744 fixup_objfreelist_debug(cachep, &list);
2750 * Perform extra freeing checks:
2751 * - detect bad pointers.
2752 * - POISON/RED_ZONE checking
2754 static void kfree_debugcheck(const void *objp)
2756 if (!virt_addr_valid(objp)) {
2757 pr_err("kfree_debugcheck: out of range ptr %lxh\n",
2758 (unsigned long)objp);
2763 static inline void verify_redzone_free(struct kmem_cache *cache, void *obj)
2765 unsigned long long redzone1, redzone2;
2767 redzone1 = *dbg_redzone1(cache, obj);
2768 redzone2 = *dbg_redzone2(cache, obj);
2773 if (redzone1 == RED_ACTIVE && redzone2 == RED_ACTIVE)
2776 if (redzone1 == RED_INACTIVE && redzone2 == RED_INACTIVE)
2777 slab_error(cache, "double free detected");
2779 slab_error(cache, "memory outside object was overwritten");
2781 pr_err("%px: redzone 1:0x%llx, redzone 2:0x%llx\n",
2782 obj, redzone1, redzone2);
2785 static void *cache_free_debugcheck(struct kmem_cache *cachep, void *objp,
2786 unsigned long caller)
2791 BUG_ON(virt_to_cache(objp) != cachep);
2793 objp -= obj_offset(cachep);
2794 kfree_debugcheck(objp);
2795 page = virt_to_head_page(objp);
2797 if (cachep->flags & SLAB_RED_ZONE) {
2798 verify_redzone_free(cachep, objp);
2799 *dbg_redzone1(cachep, objp) = RED_INACTIVE;
2800 *dbg_redzone2(cachep, objp) = RED_INACTIVE;
2802 if (cachep->flags & SLAB_STORE_USER) {
2803 set_store_user_dirty(cachep);
2804 *dbg_userword(cachep, objp) = (void *)caller;
2807 objnr = obj_to_index(cachep, page, objp);
2809 BUG_ON(objnr >= cachep->num);
2810 BUG_ON(objp != index_to_obj(cachep, page, objnr));
2812 if (cachep->flags & SLAB_POISON) {
2813 poison_obj(cachep, objp, POISON_FREE);
2814 slab_kernel_map(cachep, objp, 0, caller);
2820 #define kfree_debugcheck(x) do { } while(0)
2821 #define cache_free_debugcheck(x,objp,z) (objp)
2824 static inline void fixup_objfreelist_debug(struct kmem_cache *cachep,
2832 objp = next - obj_offset(cachep);
2833 next = *(void **)next;
2834 poison_obj(cachep, objp, POISON_FREE);
2839 static inline void fixup_slab_list(struct kmem_cache *cachep,
2840 struct kmem_cache_node *n, struct page *page,
2843 /* move slabp to correct slabp list: */
2844 list_del(&page->lru);
2845 if (page->active == cachep->num) {
2846 list_add(&page->lru, &n->slabs_full);
2847 if (OBJFREELIST_SLAB(cachep)) {
2849 /* Poisoning will be done without holding the lock */
2850 if (cachep->flags & SLAB_POISON) {
2851 void **objp = page->freelist;
2857 page->freelist = NULL;
2860 list_add(&page->lru, &n->slabs_partial);
2863 /* Try to find non-pfmemalloc slab if needed */
2864 static noinline struct page *get_valid_first_slab(struct kmem_cache_node *n,
2865 struct page *page, bool pfmemalloc)
2873 if (!PageSlabPfmemalloc(page))
2876 /* No need to keep pfmemalloc slab if we have enough free objects */
2877 if (n->free_objects > n->free_limit) {
2878 ClearPageSlabPfmemalloc(page);
2882 /* Move pfmemalloc slab to the end of list to speed up next search */
2883 list_del(&page->lru);
2884 if (!page->active) {
2885 list_add_tail(&page->lru, &n->slabs_free);
2888 list_add_tail(&page->lru, &n->slabs_partial);
2890 list_for_each_entry(page, &n->slabs_partial, lru) {
2891 if (!PageSlabPfmemalloc(page))
2895 n->free_touched = 1;
2896 list_for_each_entry(page, &n->slabs_free, lru) {
2897 if (!PageSlabPfmemalloc(page)) {
2906 static struct page *get_first_slab(struct kmem_cache_node *n, bool pfmemalloc)
2910 assert_spin_locked(&n->list_lock);
2911 page = list_first_entry_or_null(&n->slabs_partial, struct page, lru);
2913 n->free_touched = 1;
2914 page = list_first_entry_or_null(&n->slabs_free, struct page,
2920 if (sk_memalloc_socks())
2921 page = get_valid_first_slab(n, page, pfmemalloc);
2926 static noinline void *cache_alloc_pfmemalloc(struct kmem_cache *cachep,
2927 struct kmem_cache_node *n, gfp_t flags)
2933 if (!gfp_pfmemalloc_allowed(flags))
2936 spin_lock(&n->list_lock);
2937 page = get_first_slab(n, true);
2939 spin_unlock(&n->list_lock);
2943 obj = slab_get_obj(cachep, page);
2946 fixup_slab_list(cachep, n, page, &list);
2948 spin_unlock(&n->list_lock);
2949 fixup_objfreelist_debug(cachep, &list);
2955 * Slab list should be fixed up by fixup_slab_list() for existing slab
2956 * or cache_grow_end() for new slab
2958 static __always_inline int alloc_block(struct kmem_cache *cachep,
2959 struct array_cache *ac, struct page *page, int batchcount)
2962 * There must be at least one object available for
2965 BUG_ON(page->active >= cachep->num);
2967 while (page->active < cachep->num && batchcount--) {
2968 STATS_INC_ALLOCED(cachep);
2969 STATS_INC_ACTIVE(cachep);
2970 STATS_SET_HIGH(cachep);
2972 ac->entry[ac->avail++] = slab_get_obj(cachep, page);
2978 static void *cache_alloc_refill(struct kmem_cache *cachep, gfp_t flags)
2981 struct kmem_cache_node *n;
2982 struct array_cache *ac, *shared;
2988 node = numa_mem_id();
2990 ac = cpu_cache_get(cachep);
2991 batchcount = ac->batchcount;
2992 if (!ac->touched && batchcount > BATCHREFILL_LIMIT) {
2994 * If there was little recent activity on this cache, then
2995 * perform only a partial refill. Otherwise we could generate
2998 batchcount = BATCHREFILL_LIMIT;
3000 n = get_node(cachep, node);
3002 BUG_ON(ac->avail > 0 || !n);
3003 shared = READ_ONCE(n->shared);
3004 if (!n->free_objects && (!shared || !shared->avail))
3007 spin_lock(&n->list_lock);
3008 shared = READ_ONCE(n->shared);
3010 /* See if we can refill from the shared array */
3011 if (shared && transfer_objects(ac, shared, batchcount)) {
3012 shared->touched = 1;
3016 while (batchcount > 0) {
3017 /* Get slab alloc is to come from. */
3018 page = get_first_slab(n, false);
3022 check_spinlock_acquired(cachep);
3024 batchcount = alloc_block(cachep, ac, page, batchcount);
3025 fixup_slab_list(cachep, n, page, &list);
3029 n->free_objects -= ac->avail;
3031 spin_unlock(&n->list_lock);
3032 fixup_objfreelist_debug(cachep, &list);
3035 if (unlikely(!ac->avail)) {
3036 /* Check if we can use obj in pfmemalloc slab */
3037 if (sk_memalloc_socks()) {
3038 void *obj = cache_alloc_pfmemalloc(cachep, n, flags);
3044 page = cache_grow_begin(cachep, gfp_exact_node(flags), node);
3047 * cache_grow_begin() can reenable interrupts,
3048 * then ac could change.
3050 ac = cpu_cache_get(cachep);
3051 if (!ac->avail && page)
3052 alloc_block(cachep, ac, page, batchcount);
3053 cache_grow_end(cachep, page);
3060 return ac->entry[--ac->avail];
3063 static inline void cache_alloc_debugcheck_before(struct kmem_cache *cachep,
3066 might_sleep_if(gfpflags_allow_blocking(flags));
3070 static void *cache_alloc_debugcheck_after(struct kmem_cache *cachep,
3071 gfp_t flags, void *objp, unsigned long caller)
3073 WARN_ON_ONCE(cachep->ctor && (flags & __GFP_ZERO));
3076 if (cachep->flags & SLAB_POISON) {
3077 check_poison_obj(cachep, objp);
3078 slab_kernel_map(cachep, objp, 1, 0);
3079 poison_obj(cachep, objp, POISON_INUSE);
3081 if (cachep->flags & SLAB_STORE_USER)
3082 *dbg_userword(cachep, objp) = (void *)caller;
3084 if (cachep->flags & SLAB_RED_ZONE) {
3085 if (*dbg_redzone1(cachep, objp) != RED_INACTIVE ||
3086 *dbg_redzone2(cachep, objp) != RED_INACTIVE) {
3087 slab_error(cachep, "double free, or memory outside object was overwritten");
3088 pr_err("%px: redzone 1:0x%llx, redzone 2:0x%llx\n",
3089 objp, *dbg_redzone1(cachep, objp),
3090 *dbg_redzone2(cachep, objp));
3092 *dbg_redzone1(cachep, objp) = RED_ACTIVE;
3093 *dbg_redzone2(cachep, objp) = RED_ACTIVE;
3096 objp += obj_offset(cachep);
3097 if (cachep->ctor && cachep->flags & SLAB_POISON)
3099 if (ARCH_SLAB_MINALIGN &&
3100 ((unsigned long)objp & (ARCH_SLAB_MINALIGN-1))) {
3101 pr_err("0x%px: not aligned to ARCH_SLAB_MINALIGN=%d\n",
3102 objp, (int)ARCH_SLAB_MINALIGN);
3107 #define cache_alloc_debugcheck_after(a,b,objp,d) (objp)
3110 static inline void *____cache_alloc(struct kmem_cache *cachep, gfp_t flags)
3113 struct array_cache *ac;
3117 ac = cpu_cache_get(cachep);
3118 if (likely(ac->avail)) {
3120 objp = ac->entry[--ac->avail];
3122 STATS_INC_ALLOCHIT(cachep);
3126 STATS_INC_ALLOCMISS(cachep);
3127 objp = cache_alloc_refill(cachep, flags);
3129 * the 'ac' may be updated by cache_alloc_refill(),
3130 * and kmemleak_erase() requires its correct value.
3132 ac = cpu_cache_get(cachep);
3136 * To avoid a false negative, if an object that is in one of the
3137 * per-CPU caches is leaked, we need to make sure kmemleak doesn't
3138 * treat the array pointers as a reference to the object.
3141 kmemleak_erase(&ac->entry[ac->avail]);
3147 * Try allocating on another node if PFA_SPREAD_SLAB is a mempolicy is set.
3149 * If we are in_interrupt, then process context, including cpusets and
3150 * mempolicy, may not apply and should not be used for allocation policy.
3152 static void *alternate_node_alloc(struct kmem_cache *cachep, gfp_t flags)
3154 int nid_alloc, nid_here;
3156 if (in_interrupt() || (flags & __GFP_THISNODE))
3158 nid_alloc = nid_here = numa_mem_id();
3159 if (cpuset_do_slab_mem_spread() && (cachep->flags & SLAB_MEM_SPREAD))
3160 nid_alloc = cpuset_slab_spread_node();
3161 else if (current->mempolicy)
3162 nid_alloc = mempolicy_slab_node();
3163 if (nid_alloc != nid_here)
3164 return ____cache_alloc_node(cachep, flags, nid_alloc);
3169 * Fallback function if there was no memory available and no objects on a
3170 * certain node and fall back is permitted. First we scan all the
3171 * available node for available objects. If that fails then we
3172 * perform an allocation without specifying a node. This allows the page
3173 * allocator to do its reclaim / fallback magic. We then insert the
3174 * slab into the proper nodelist and then allocate from it.
3176 static void *fallback_alloc(struct kmem_cache *cache, gfp_t flags)
3178 struct zonelist *zonelist;
3181 enum zone_type high_zoneidx = gfp_zone(flags);
3185 unsigned int cpuset_mems_cookie;
3187 if (flags & __GFP_THISNODE)
3191 cpuset_mems_cookie = read_mems_allowed_begin();
3192 zonelist = node_zonelist(mempolicy_slab_node(), flags);
3196 * Look through allowed nodes for objects available
3197 * from existing per node queues.
3199 for_each_zone_zonelist(zone, z, zonelist, high_zoneidx) {
3200 nid = zone_to_nid(zone);
3202 if (cpuset_zone_allowed(zone, flags) &&
3203 get_node(cache, nid) &&
3204 get_node(cache, nid)->free_objects) {
3205 obj = ____cache_alloc_node(cache,
3206 gfp_exact_node(flags), nid);
3214 * This allocation will be performed within the constraints
3215 * of the current cpuset / memory policy requirements.
3216 * We may trigger various forms of reclaim on the allowed
3217 * set and go into memory reserves if necessary.
3219 page = cache_grow_begin(cache, flags, numa_mem_id());
3220 cache_grow_end(cache, page);
3222 nid = page_to_nid(page);
3223 obj = ____cache_alloc_node(cache,
3224 gfp_exact_node(flags), nid);
3227 * Another processor may allocate the objects in
3228 * the slab since we are not holding any locks.
3235 if (unlikely(!obj && read_mems_allowed_retry(cpuset_mems_cookie)))
3241 * A interface to enable slab creation on nodeid
3243 static void *____cache_alloc_node(struct kmem_cache *cachep, gfp_t flags,
3247 struct kmem_cache_node *n;
3251 VM_BUG_ON(nodeid < 0 || nodeid >= MAX_NUMNODES);
3252 n = get_node(cachep, nodeid);
3256 spin_lock(&n->list_lock);
3257 page = get_first_slab(n, false);
3261 check_spinlock_acquired_node(cachep, nodeid);
3263 STATS_INC_NODEALLOCS(cachep);
3264 STATS_INC_ACTIVE(cachep);
3265 STATS_SET_HIGH(cachep);
3267 BUG_ON(page->active == cachep->num);
3269 obj = slab_get_obj(cachep, page);
3272 fixup_slab_list(cachep, n, page, &list);
3274 spin_unlock(&n->list_lock);
3275 fixup_objfreelist_debug(cachep, &list);
3279 spin_unlock(&n->list_lock);
3280 page = cache_grow_begin(cachep, gfp_exact_node(flags), nodeid);
3282 /* This slab isn't counted yet so don't update free_objects */
3283 obj = slab_get_obj(cachep, page);
3285 cache_grow_end(cachep, page);
3287 return obj ? obj : fallback_alloc(cachep, flags);
3290 static __always_inline void *
3291 slab_alloc_node(struct kmem_cache *cachep, gfp_t flags, int nodeid,
3292 unsigned long caller)
3294 unsigned long save_flags;
3296 int slab_node = numa_mem_id();
3298 flags &= gfp_allowed_mask;
3299 cachep = slab_pre_alloc_hook(cachep, flags);
3300 if (unlikely(!cachep))
3303 cache_alloc_debugcheck_before(cachep, flags);
3304 local_irq_save(save_flags);
3306 if (nodeid == NUMA_NO_NODE)
3309 if (unlikely(!get_node(cachep, nodeid))) {
3310 /* Node not bootstrapped yet */
3311 ptr = fallback_alloc(cachep, flags);
3315 if (nodeid == slab_node) {
3317 * Use the locally cached objects if possible.
3318 * However ____cache_alloc does not allow fallback
3319 * to other nodes. It may fail while we still have
3320 * objects on other nodes available.
3322 ptr = ____cache_alloc(cachep, flags);
3326 /* ___cache_alloc_node can fall back to other nodes */
3327 ptr = ____cache_alloc_node(cachep, flags, nodeid);
3329 local_irq_restore(save_flags);
3330 ptr = cache_alloc_debugcheck_after(cachep, flags, ptr, caller);
3332 if (unlikely(flags & __GFP_ZERO) && ptr)
3333 memset(ptr, 0, cachep->object_size);
3335 slab_post_alloc_hook(cachep, flags, 1, &ptr);
3339 static __always_inline void *
3340 __do_cache_alloc(struct kmem_cache *cache, gfp_t flags)
3344 if (current->mempolicy || cpuset_do_slab_mem_spread()) {
3345 objp = alternate_node_alloc(cache, flags);
3349 objp = ____cache_alloc(cache, flags);
3352 * We may just have run out of memory on the local node.
3353 * ____cache_alloc_node() knows how to locate memory on other nodes
3356 objp = ____cache_alloc_node(cache, flags, numa_mem_id());
3363 static __always_inline void *
3364 __do_cache_alloc(struct kmem_cache *cachep, gfp_t flags)
3366 return ____cache_alloc(cachep, flags);
3369 #endif /* CONFIG_NUMA */
3371 static __always_inline void *
3372 slab_alloc(struct kmem_cache *cachep, gfp_t flags, unsigned long caller)
3374 unsigned long save_flags;
3377 flags &= gfp_allowed_mask;
3378 cachep = slab_pre_alloc_hook(cachep, flags);
3379 if (unlikely(!cachep))
3382 cache_alloc_debugcheck_before(cachep, flags);
3383 local_irq_save(save_flags);
3384 objp = __do_cache_alloc(cachep, flags);
3385 local_irq_restore(save_flags);
3386 objp = cache_alloc_debugcheck_after(cachep, flags, objp, caller);
3389 if (unlikely(flags & __GFP_ZERO) && objp)
3390 memset(objp, 0, cachep->object_size);
3392 slab_post_alloc_hook(cachep, flags, 1, &objp);
3397 * Caller needs to acquire correct kmem_cache_node's list_lock
3398 * @list: List of detached free slabs should be freed by caller
3400 static void free_block(struct kmem_cache *cachep, void **objpp,
3401 int nr_objects, int node, struct list_head *list)
3404 struct kmem_cache_node *n = get_node(cachep, node);
3407 n->free_objects += nr_objects;
3409 for (i = 0; i < nr_objects; i++) {
3415 page = virt_to_head_page(objp);
3416 list_del(&page->lru);
3417 check_spinlock_acquired_node(cachep, node);
3418 slab_put_obj(cachep, page, objp);
3419 STATS_DEC_ACTIVE(cachep);
3421 /* fixup slab chains */
3422 if (page->active == 0) {
3423 list_add(&page->lru, &n->slabs_free);
3426 /* Unconditionally move a slab to the end of the
3427 * partial list on free - maximum time for the
3428 * other objects to be freed, too.
3430 list_add_tail(&page->lru, &n->slabs_partial);
3434 while (n->free_objects > n->free_limit && !list_empty(&n->slabs_free)) {
3435 n->free_objects -= cachep->num;
3437 page = list_last_entry(&n->slabs_free, struct page, lru);
3438 list_move(&page->lru, list);
3444 static void cache_flusharray(struct kmem_cache *cachep, struct array_cache *ac)
3447 struct kmem_cache_node *n;
3448 int node = numa_mem_id();
3451 batchcount = ac->batchcount;
3454 n = get_node(cachep, node);
3455 spin_lock(&n->list_lock);
3457 struct array_cache *shared_array = n->shared;
3458 int max = shared_array->limit - shared_array->avail;
3460 if (batchcount > max)
3462 memcpy(&(shared_array->entry[shared_array->avail]),
3463 ac->entry, sizeof(void *) * batchcount);
3464 shared_array->avail += batchcount;
3469 free_block(cachep, ac->entry, batchcount, node, &list);
3476 list_for_each_entry(page, &n->slabs_free, lru) {
3477 BUG_ON(page->active);
3481 STATS_SET_FREEABLE(cachep, i);
3484 spin_unlock(&n->list_lock);
3485 slabs_destroy(cachep, &list);
3486 ac->avail -= batchcount;
3487 memmove(ac->entry, &(ac->entry[batchcount]), sizeof(void *)*ac->avail);
3491 * Release an obj back to its cache. If the obj has a constructed state, it must
3492 * be in this state _before_ it is released. Called with disabled ints.
3494 static __always_inline void __cache_free(struct kmem_cache *cachep, void *objp,
3495 unsigned long caller)
3497 /* Put the object into the quarantine, don't touch it for now. */
3498 if (kasan_slab_free(cachep, objp, _RET_IP_))
3501 ___cache_free(cachep, objp, caller);
3504 void ___cache_free(struct kmem_cache *cachep, void *objp,
3505 unsigned long caller)
3507 struct array_cache *ac = cpu_cache_get(cachep);
3510 kmemleak_free_recursive(objp, cachep->flags);
3511 objp = cache_free_debugcheck(cachep, objp, caller);
3514 * Skip calling cache_free_alien() when the platform is not numa.
3515 * This will avoid cache misses that happen while accessing slabp (which
3516 * is per page memory reference) to get nodeid. Instead use a global
3517 * variable to skip the call, which is mostly likely to be present in
3520 if (nr_online_nodes > 1 && cache_free_alien(cachep, objp))
3523 if (ac->avail < ac->limit) {
3524 STATS_INC_FREEHIT(cachep);
3526 STATS_INC_FREEMISS(cachep);
3527 cache_flusharray(cachep, ac);
3530 if (sk_memalloc_socks()) {
3531 struct page *page = virt_to_head_page(objp);
3533 if (unlikely(PageSlabPfmemalloc(page))) {
3534 cache_free_pfmemalloc(cachep, page, objp);
3539 ac->entry[ac->avail++] = objp;
3543 * kmem_cache_alloc - Allocate an object
3544 * @cachep: The cache to allocate from.
3545 * @flags: See kmalloc().
3547 * Allocate an object from this cache. The flags are only relevant
3548 * if the cache has no available objects.
3550 void *kmem_cache_alloc(struct kmem_cache *cachep, gfp_t flags)
3552 void *ret = slab_alloc(cachep, flags, _RET_IP_);
3554 kasan_slab_alloc(cachep, ret, flags);
3555 trace_kmem_cache_alloc(_RET_IP_, ret,
3556 cachep->object_size, cachep->size, flags);
3560 EXPORT_SYMBOL(kmem_cache_alloc);
3562 static __always_inline void
3563 cache_alloc_debugcheck_after_bulk(struct kmem_cache *s, gfp_t flags,
3564 size_t size, void **p, unsigned long caller)
3568 for (i = 0; i < size; i++)
3569 p[i] = cache_alloc_debugcheck_after(s, flags, p[i], caller);
3572 int kmem_cache_alloc_bulk(struct kmem_cache *s, gfp_t flags, size_t size,
3577 s = slab_pre_alloc_hook(s, flags);
3581 cache_alloc_debugcheck_before(s, flags);
3583 local_irq_disable();
3584 for (i = 0; i < size; i++) {
3585 void *objp = __do_cache_alloc(s, flags);
3587 if (unlikely(!objp))
3593 cache_alloc_debugcheck_after_bulk(s, flags, size, p, _RET_IP_);
3595 /* Clear memory outside IRQ disabled section */
3596 if (unlikely(flags & __GFP_ZERO))
3597 for (i = 0; i < size; i++)
3598 memset(p[i], 0, s->object_size);
3600 slab_post_alloc_hook(s, flags, size, p);
3601 /* FIXME: Trace call missing. Christoph would like a bulk variant */
3605 cache_alloc_debugcheck_after_bulk(s, flags, i, p, _RET_IP_);
3606 slab_post_alloc_hook(s, flags, i, p);
3607 __kmem_cache_free_bulk(s, i, p);
3610 EXPORT_SYMBOL(kmem_cache_alloc_bulk);
3612 #ifdef CONFIG_TRACING
3614 kmem_cache_alloc_trace(struct kmem_cache *cachep, gfp_t flags, size_t size)
3618 ret = slab_alloc(cachep, flags, _RET_IP_);
3620 kasan_kmalloc(cachep, ret, size, flags);
3621 trace_kmalloc(_RET_IP_, ret,
3622 size, cachep->size, flags);
3625 EXPORT_SYMBOL(kmem_cache_alloc_trace);
3630 * kmem_cache_alloc_node - Allocate an object on the specified node
3631 * @cachep: The cache to allocate from.
3632 * @flags: See kmalloc().
3633 * @nodeid: node number of the target node.
3635 * Identical to kmem_cache_alloc but it will allocate memory on the given
3636 * node, which can improve the performance for cpu bound structures.
3638 * Fallback to other node is possible if __GFP_THISNODE is not set.
3640 void *kmem_cache_alloc_node(struct kmem_cache *cachep, gfp_t flags, int nodeid)
3642 void *ret = slab_alloc_node(cachep, flags, nodeid, _RET_IP_);
3644 kasan_slab_alloc(cachep, ret, flags);
3645 trace_kmem_cache_alloc_node(_RET_IP_, ret,
3646 cachep->object_size, cachep->size,
3651 EXPORT_SYMBOL(kmem_cache_alloc_node);
3653 #ifdef CONFIG_TRACING
3654 void *kmem_cache_alloc_node_trace(struct kmem_cache *cachep,
3661 ret = slab_alloc_node(cachep, flags, nodeid, _RET_IP_);
3663 kasan_kmalloc(cachep, ret, size, flags);
3664 trace_kmalloc_node(_RET_IP_, ret,
3669 EXPORT_SYMBOL(kmem_cache_alloc_node_trace);
3672 static __always_inline void *
3673 __do_kmalloc_node(size_t size, gfp_t flags, int node, unsigned long caller)
3675 struct kmem_cache *cachep;
3678 cachep = kmalloc_slab(size, flags);
3679 if (unlikely(ZERO_OR_NULL_PTR(cachep)))
3681 ret = kmem_cache_alloc_node_trace(cachep, flags, node, size);
3682 kasan_kmalloc(cachep, ret, size, flags);
3687 void *__kmalloc_node(size_t size, gfp_t flags, int node)
3689 return __do_kmalloc_node(size, flags, node, _RET_IP_);
3691 EXPORT_SYMBOL(__kmalloc_node);
3693 void *__kmalloc_node_track_caller(size_t size, gfp_t flags,
3694 int node, unsigned long caller)
3696 return __do_kmalloc_node(size, flags, node, caller);
3698 EXPORT_SYMBOL(__kmalloc_node_track_caller);
3699 #endif /* CONFIG_NUMA */
3702 * __do_kmalloc - allocate memory
3703 * @size: how many bytes of memory are required.
3704 * @flags: the type of memory to allocate (see kmalloc).
3705 * @caller: function caller for debug tracking of the caller
3707 static __always_inline void *__do_kmalloc(size_t size, gfp_t flags,
3708 unsigned long caller)
3710 struct kmem_cache *cachep;
3713 cachep = kmalloc_slab(size, flags);
3714 if (unlikely(ZERO_OR_NULL_PTR(cachep)))
3716 ret = slab_alloc(cachep, flags, caller);
3718 kasan_kmalloc(cachep, ret, size, flags);
3719 trace_kmalloc(caller, ret,
3720 size, cachep->size, flags);
3725 void *__kmalloc(size_t size, gfp_t flags)
3727 return __do_kmalloc(size, flags, _RET_IP_);
3729 EXPORT_SYMBOL(__kmalloc);
3731 void *__kmalloc_track_caller(size_t size, gfp_t flags, unsigned long caller)
3733 return __do_kmalloc(size, flags, caller);
3735 EXPORT_SYMBOL(__kmalloc_track_caller);
3738 * kmem_cache_free - Deallocate an object
3739 * @cachep: The cache the allocation was from.
3740 * @objp: The previously allocated object.
3742 * Free an object which was previously allocated from this
3745 void kmem_cache_free(struct kmem_cache *cachep, void *objp)
3747 unsigned long flags;
3748 cachep = cache_from_obj(cachep, objp);
3752 local_irq_save(flags);
3753 debug_check_no_locks_freed(objp, cachep->object_size);
3754 if (!(cachep->flags & SLAB_DEBUG_OBJECTS))
3755 debug_check_no_obj_freed(objp, cachep->object_size);
3756 __cache_free(cachep, objp, _RET_IP_);
3757 local_irq_restore(flags);
3759 trace_kmem_cache_free(_RET_IP_, objp);
3761 EXPORT_SYMBOL(kmem_cache_free);
3763 void kmem_cache_free_bulk(struct kmem_cache *orig_s, size_t size, void **p)
3765 struct kmem_cache *s;
3768 local_irq_disable();
3769 for (i = 0; i < size; i++) {
3772 if (!orig_s) /* called via kfree_bulk */
3773 s = virt_to_cache(objp);
3775 s = cache_from_obj(orig_s, objp);
3777 debug_check_no_locks_freed(objp, s->object_size);
3778 if (!(s->flags & SLAB_DEBUG_OBJECTS))
3779 debug_check_no_obj_freed(objp, s->object_size);
3781 __cache_free(s, objp, _RET_IP_);
3785 /* FIXME: add tracing */
3787 EXPORT_SYMBOL(kmem_cache_free_bulk);
3790 * kfree - free previously allocated memory
3791 * @objp: pointer returned by kmalloc.
3793 * If @objp is NULL, no operation is performed.
3795 * Don't free memory not originally allocated by kmalloc()
3796 * or you will run into trouble.
3798 void kfree(const void *objp)
3800 struct kmem_cache *c;
3801 unsigned long flags;
3803 trace_kfree(_RET_IP_, objp);
3805 if (unlikely(ZERO_OR_NULL_PTR(objp)))
3807 local_irq_save(flags);
3808 kfree_debugcheck(objp);
3809 c = virt_to_cache(objp);
3810 debug_check_no_locks_freed(objp, c->object_size);
3812 debug_check_no_obj_freed(objp, c->object_size);
3813 __cache_free(c, (void *)objp, _RET_IP_);
3814 local_irq_restore(flags);
3816 EXPORT_SYMBOL(kfree);
3819 * This initializes kmem_cache_node or resizes various caches for all nodes.
3821 static int setup_kmem_cache_nodes(struct kmem_cache *cachep, gfp_t gfp)
3825 struct kmem_cache_node *n;
3827 for_each_online_node(node) {
3828 ret = setup_kmem_cache_node(cachep, node, gfp, true);
3837 if (!cachep->list.next) {
3838 /* Cache is not active yet. Roll back what we did */
3841 n = get_node(cachep, node);
3844 free_alien_cache(n->alien);
3846 cachep->node[node] = NULL;
3854 /* Always called with the slab_mutex held */
3855 static int __do_tune_cpucache(struct kmem_cache *cachep, int limit,
3856 int batchcount, int shared, gfp_t gfp)
3858 struct array_cache __percpu *cpu_cache, *prev;
3861 cpu_cache = alloc_kmem_cache_cpus(cachep, limit, batchcount);
3865 prev = cachep->cpu_cache;
3866 cachep->cpu_cache = cpu_cache;
3868 * Without a previous cpu_cache there's no need to synchronize remote
3869 * cpus, so skip the IPIs.
3872 kick_all_cpus_sync();
3875 cachep->batchcount = batchcount;
3876 cachep->limit = limit;
3877 cachep->shared = shared;
3882 for_each_online_cpu(cpu) {
3885 struct kmem_cache_node *n;
3886 struct array_cache *ac = per_cpu_ptr(prev, cpu);
3888 node = cpu_to_mem(cpu);
3889 n = get_node(cachep, node);
3890 spin_lock_irq(&n->list_lock);
3891 free_block(cachep, ac->entry, ac->avail, node, &list);
3892 spin_unlock_irq(&n->list_lock);
3893 slabs_destroy(cachep, &list);
3898 return setup_kmem_cache_nodes(cachep, gfp);
3901 static int do_tune_cpucache(struct kmem_cache *cachep, int limit,
3902 int batchcount, int shared, gfp_t gfp)
3905 struct kmem_cache *c;
3907 ret = __do_tune_cpucache(cachep, limit, batchcount, shared, gfp);
3909 if (slab_state < FULL)
3912 if ((ret < 0) || !is_root_cache(cachep))
3915 lockdep_assert_held(&slab_mutex);
3916 for_each_memcg_cache(c, cachep) {
3917 /* return value determined by the root cache only */
3918 __do_tune_cpucache(c, limit, batchcount, shared, gfp);
3924 /* Called with slab_mutex held always */
3925 static int enable_cpucache(struct kmem_cache *cachep, gfp_t gfp)
3932 err = cache_random_seq_create(cachep, cachep->num, gfp);
3936 if (!is_root_cache(cachep)) {
3937 struct kmem_cache *root = memcg_root_cache(cachep);
3938 limit = root->limit;
3939 shared = root->shared;
3940 batchcount = root->batchcount;
3943 if (limit && shared && batchcount)
3946 * The head array serves three purposes:
3947 * - create a LIFO ordering, i.e. return objects that are cache-warm
3948 * - reduce the number of spinlock operations.
3949 * - reduce the number of linked list operations on the slab and
3950 * bufctl chains: array operations are cheaper.
3951 * The numbers are guessed, we should auto-tune as described by
3954 if (cachep->size > 131072)
3956 else if (cachep->size > PAGE_SIZE)
3958 else if (cachep->size > 1024)
3960 else if (cachep->size > 256)
3966 * CPU bound tasks (e.g. network routing) can exhibit cpu bound
3967 * allocation behaviour: Most allocs on one cpu, most free operations
3968 * on another cpu. For these cases, an efficient object passing between
3969 * cpus is necessary. This is provided by a shared array. The array
3970 * replaces Bonwick's magazine layer.
3971 * On uniprocessor, it's functionally equivalent (but less efficient)
3972 * to a larger limit. Thus disabled by default.
3975 if (cachep->size <= PAGE_SIZE && num_possible_cpus() > 1)
3980 * With debugging enabled, large batchcount lead to excessively long
3981 * periods with disabled local interrupts. Limit the batchcount
3986 batchcount = (limit + 1) / 2;
3988 err = do_tune_cpucache(cachep, limit, batchcount, shared, gfp);
3991 pr_err("enable_cpucache failed for %s, error %d\n",
3992 cachep->name, -err);
3997 * Drain an array if it contains any elements taking the node lock only if
3998 * necessary. Note that the node listlock also protects the array_cache
3999 * if drain_array() is used on the shared array.
4001 static void drain_array(struct kmem_cache *cachep, struct kmem_cache_node *n,
4002 struct array_cache *ac, int node)
4006 /* ac from n->shared can be freed if we don't hold the slab_mutex. */
4007 check_mutex_acquired();
4009 if (!ac || !ac->avail)
4017 spin_lock_irq(&n->list_lock);
4018 drain_array_locked(cachep, ac, node, false, &list);
4019 spin_unlock_irq(&n->list_lock);
4021 slabs_destroy(cachep, &list);
4025 * cache_reap - Reclaim memory from caches.
4026 * @w: work descriptor
4028 * Called from workqueue/eventd every few seconds.
4030 * - clear the per-cpu caches for this CPU.
4031 * - return freeable pages to the main free memory pool.
4033 * If we cannot acquire the cache chain mutex then just give up - we'll try
4034 * again on the next iteration.
4036 static void cache_reap(struct work_struct *w)
4038 struct kmem_cache *searchp;
4039 struct kmem_cache_node *n;
4040 int node = numa_mem_id();
4041 struct delayed_work *work = to_delayed_work(w);
4043 if (!mutex_trylock(&slab_mutex))
4044 /* Give up. Setup the next iteration. */
4047 list_for_each_entry(searchp, &slab_caches, list) {
4051 * We only take the node lock if absolutely necessary and we
4052 * have established with reasonable certainty that
4053 * we can do some work if the lock was obtained.
4055 n = get_node(searchp, node);
4057 reap_alien(searchp, n);
4059 drain_array(searchp, n, cpu_cache_get(searchp), node);
4062 * These are racy checks but it does not matter
4063 * if we skip one check or scan twice.
4065 if (time_after(n->next_reap, jiffies))
4068 n->next_reap = jiffies + REAPTIMEOUT_NODE;
4070 drain_array(searchp, n, n->shared, node);
4072 if (n->free_touched)
4073 n->free_touched = 0;
4077 freed = drain_freelist(searchp, n, (n->free_limit +
4078 5 * searchp->num - 1) / (5 * searchp->num));
4079 STATS_ADD_REAPED(searchp, freed);
4085 mutex_unlock(&slab_mutex);
4088 /* Set up the next iteration */
4089 schedule_delayed_work_on(smp_processor_id(), work,
4090 round_jiffies_relative(REAPTIMEOUT_AC));
4093 void get_slabinfo(struct kmem_cache *cachep, struct slabinfo *sinfo)
4095 unsigned long active_objs, num_objs, active_slabs;
4096 unsigned long total_slabs = 0, free_objs = 0, shared_avail = 0;
4097 unsigned long free_slabs = 0;
4099 struct kmem_cache_node *n;
4101 for_each_kmem_cache_node(cachep, node, n) {
4103 spin_lock_irq(&n->list_lock);
4105 total_slabs += n->total_slabs;
4106 free_slabs += n->free_slabs;
4107 free_objs += n->free_objects;
4110 shared_avail += n->shared->avail;
4112 spin_unlock_irq(&n->list_lock);
4114 num_objs = total_slabs * cachep->num;
4115 active_slabs = total_slabs - free_slabs;
4116 active_objs = num_objs - free_objs;
4118 sinfo->active_objs = active_objs;
4119 sinfo->num_objs = num_objs;
4120 sinfo->active_slabs = active_slabs;
4121 sinfo->num_slabs = total_slabs;
4122 sinfo->shared_avail = shared_avail;
4123 sinfo->limit = cachep->limit;
4124 sinfo->batchcount = cachep->batchcount;
4125 sinfo->shared = cachep->shared;
4126 sinfo->objects_per_slab = cachep->num;
4127 sinfo->cache_order = cachep->gfporder;
4130 void slabinfo_show_stats(struct seq_file *m, struct kmem_cache *cachep)
4134 unsigned long high = cachep->high_mark;
4135 unsigned long allocs = cachep->num_allocations;
4136 unsigned long grown = cachep->grown;
4137 unsigned long reaped = cachep->reaped;
4138 unsigned long errors = cachep->errors;
4139 unsigned long max_freeable = cachep->max_freeable;
4140 unsigned long node_allocs = cachep->node_allocs;
4141 unsigned long node_frees = cachep->node_frees;
4142 unsigned long overflows = cachep->node_overflow;
4144 seq_printf(m, " : globalstat %7lu %6lu %5lu %4lu %4lu %4lu %4lu %4lu %4lu",
4145 allocs, high, grown,
4146 reaped, errors, max_freeable, node_allocs,
4147 node_frees, overflows);
4151 unsigned long allochit = atomic_read(&cachep->allochit);
4152 unsigned long allocmiss = atomic_read(&cachep->allocmiss);
4153 unsigned long freehit = atomic_read(&cachep->freehit);
4154 unsigned long freemiss = atomic_read(&cachep->freemiss);
4156 seq_printf(m, " : cpustat %6lu %6lu %6lu %6lu",
4157 allochit, allocmiss, freehit, freemiss);
4162 #define MAX_SLABINFO_WRITE 128
4164 * slabinfo_write - Tuning for the slab allocator
4166 * @buffer: user buffer
4167 * @count: data length
4170 ssize_t slabinfo_write(struct file *file, const char __user *buffer,
4171 size_t count, loff_t *ppos)
4173 char kbuf[MAX_SLABINFO_WRITE + 1], *tmp;
4174 int limit, batchcount, shared, res;
4175 struct kmem_cache *cachep;
4177 if (count > MAX_SLABINFO_WRITE)
4179 if (copy_from_user(&kbuf, buffer, count))
4181 kbuf[MAX_SLABINFO_WRITE] = '\0';
4183 tmp = strchr(kbuf, ' ');
4188 if (sscanf(tmp, " %d %d %d", &limit, &batchcount, &shared) != 3)
4191 /* Find the cache in the chain of caches. */
4192 mutex_lock(&slab_mutex);
4194 list_for_each_entry(cachep, &slab_caches, list) {
4195 if (!strcmp(cachep->name, kbuf)) {
4196 if (limit < 1 || batchcount < 1 ||
4197 batchcount > limit || shared < 0) {
4200 res = do_tune_cpucache(cachep, limit,
4207 mutex_unlock(&slab_mutex);
4213 #ifdef CONFIG_DEBUG_SLAB_LEAK
4215 static inline int add_caller(unsigned long *n, unsigned long v)
4225 unsigned long *q = p + 2 * i;
4239 memmove(p + 2, p, n[1] * 2 * sizeof(unsigned long) - ((void *)p - (void *)n));
4245 static void handle_slab(unsigned long *n, struct kmem_cache *c,
4254 for (i = 0, p = page->s_mem; i < c->num; i++, p += c->size) {
4257 for (j = page->active; j < c->num; j++) {
4258 if (get_free_obj(page, j) == i) {
4268 * probe_kernel_read() is used for DEBUG_PAGEALLOC. page table
4269 * mapping is established when actual object allocation and
4270 * we could mistakenly access the unmapped object in the cpu
4273 if (probe_kernel_read(&v, dbg_userword(c, p), sizeof(v)))
4276 if (!add_caller(n, v))
4281 static void show_symbol(struct seq_file *m, unsigned long address)
4283 #ifdef CONFIG_KALLSYMS
4284 unsigned long offset, size;
4285 char modname[MODULE_NAME_LEN], name[KSYM_NAME_LEN];
4287 if (lookup_symbol_attrs(address, &size, &offset, modname, name) == 0) {
4288 seq_printf(m, "%s+%#lx/%#lx", name, offset, size);
4290 seq_printf(m, " [%s]", modname);
4294 seq_printf(m, "%px", (void *)address);
4297 static int leaks_show(struct seq_file *m, void *p)
4299 struct kmem_cache *cachep = list_entry(p, struct kmem_cache, list);
4301 struct kmem_cache_node *n;
4303 unsigned long *x = m->private;
4307 if (!(cachep->flags & SLAB_STORE_USER))
4309 if (!(cachep->flags & SLAB_RED_ZONE))
4313 * Set store_user_clean and start to grab stored user information
4314 * for all objects on this cache. If some alloc/free requests comes
4315 * during the processing, information would be wrong so restart
4319 set_store_user_clean(cachep);
4320 drain_cpu_caches(cachep);
4324 for_each_kmem_cache_node(cachep, node, n) {
4327 spin_lock_irq(&n->list_lock);
4329 list_for_each_entry(page, &n->slabs_full, lru)
4330 handle_slab(x, cachep, page);
4331 list_for_each_entry(page, &n->slabs_partial, lru)
4332 handle_slab(x, cachep, page);
4333 spin_unlock_irq(&n->list_lock);
4335 } while (!is_store_user_clean(cachep));
4337 name = cachep->name;
4339 /* Increase the buffer size */
4340 mutex_unlock(&slab_mutex);
4341 m->private = kcalloc(x[0] * 4, sizeof(unsigned long),
4344 /* Too bad, we are really out */
4346 mutex_lock(&slab_mutex);
4349 *(unsigned long *)m->private = x[0] * 2;
4351 mutex_lock(&slab_mutex);
4352 /* Now make sure this entry will be retried */
4356 for (i = 0; i < x[1]; i++) {
4357 seq_printf(m, "%s: %lu ", name, x[2*i+3]);
4358 show_symbol(m, x[2*i+2]);
4365 static const struct seq_operations slabstats_op = {
4366 .start = slab_start,
4372 static int slabstats_open(struct inode *inode, struct file *file)
4376 n = __seq_open_private(file, &slabstats_op, PAGE_SIZE);
4380 *n = PAGE_SIZE / (2 * sizeof(unsigned long));
4385 static const struct file_operations proc_slabstats_operations = {
4386 .open = slabstats_open,
4388 .llseek = seq_lseek,
4389 .release = seq_release_private,
4393 static int __init slab_proc_init(void)
4395 #ifdef CONFIG_DEBUG_SLAB_LEAK
4396 proc_create("slab_allocators", 0, NULL, &proc_slabstats_operations);
4400 module_init(slab_proc_init);
4402 #ifdef CONFIG_HARDENED_USERCOPY
4404 * Rejects incorrectly sized objects and objects that are to be copied
4405 * to/from userspace but do not fall entirely within the containing slab
4406 * cache's usercopy region.
4408 * Returns NULL if check passes, otherwise const char * to name of cache
4409 * to indicate an error.
4411 void __check_heap_object(const void *ptr, unsigned long n, struct page *page,
4414 struct kmem_cache *cachep;
4416 unsigned long offset;
4418 /* Find and validate object. */
4419 cachep = page->slab_cache;
4420 objnr = obj_to_index(cachep, page, (void *)ptr);
4421 BUG_ON(objnr >= cachep->num);
4423 /* Find offset within object. */
4424 offset = ptr - index_to_obj(cachep, page, objnr) - obj_offset(cachep);
4426 /* Allow address range falling entirely within usercopy region. */
4427 if (offset >= cachep->useroffset &&
4428 offset - cachep->useroffset <= cachep->usersize &&
4429 n <= cachep->useroffset - offset + cachep->usersize)
4433 * If the copy is still within the allocated object, produce
4434 * a warning instead of rejecting the copy. This is intended
4435 * to be a temporary method to find any missing usercopy
4438 if (usercopy_fallback &&
4439 offset <= cachep->object_size &&
4440 n <= cachep->object_size - offset) {
4441 usercopy_warn("SLAB object", cachep->name, to_user, offset, n);
4445 usercopy_abort("SLAB object", cachep->name, to_user, offset, n);
4447 #endif /* CONFIG_HARDENED_USERCOPY */
4450 * ksize - get the actual amount of memory allocated for a given object
4451 * @objp: Pointer to the object
4453 * kmalloc may internally round up allocations and return more memory
4454 * than requested. ksize() can be used to determine the actual amount of
4455 * memory allocated. The caller may use this additional memory, even though
4456 * a smaller amount of memory was initially specified with the kmalloc call.
4457 * The caller must guarantee that objp points to a valid object previously
4458 * allocated with either kmalloc() or kmem_cache_alloc(). The object
4459 * must not be freed during the duration of the call.
4461 size_t ksize(const void *objp)
4466 if (unlikely(objp == ZERO_SIZE_PTR))
4469 size = virt_to_cache(objp)->object_size;
4470 /* We assume that ksize callers could use the whole allocated area,
4471 * so we need to unpoison this area.
4473 kasan_unpoison_shadow(objp, size);
4477 EXPORT_SYMBOL(ksize);