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;})
366 * Do not go above this order unless 0 objects fit into the slab or
367 * overridden on the command line.
369 #define SLAB_MAX_ORDER_HI 1
370 #define SLAB_MAX_ORDER_LO 0
371 static int slab_max_order = SLAB_MAX_ORDER_LO;
372 static bool slab_max_order_set __initdata;
374 static inline void *index_to_obj(struct kmem_cache *cache, struct page *page,
377 return page->s_mem + cache->size * idx;
380 #define BOOT_CPUCACHE_ENTRIES 1
381 /* internal cache of cache description objs */
382 static struct kmem_cache kmem_cache_boot = {
384 .limit = BOOT_CPUCACHE_ENTRIES,
386 .size = sizeof(struct kmem_cache),
387 .name = "kmem_cache",
390 static DEFINE_PER_CPU(struct delayed_work, slab_reap_work);
392 static inline struct array_cache *cpu_cache_get(struct kmem_cache *cachep)
394 return this_cpu_ptr(cachep->cpu_cache);
398 * Calculate the number of objects and left-over bytes for a given buffer size.
400 static unsigned int cache_estimate(unsigned long gfporder, size_t buffer_size,
401 slab_flags_t flags, size_t *left_over)
404 size_t slab_size = PAGE_SIZE << gfporder;
407 * The slab management structure can be either off the slab or
408 * on it. For the latter case, the memory allocated for a
411 * - @buffer_size bytes for each object
412 * - One freelist_idx_t for each object
414 * We don't need to consider alignment of freelist because
415 * freelist will be at the end of slab page. The objects will be
416 * at the correct alignment.
418 * If the slab management structure is off the slab, then the
419 * alignment will already be calculated into the size. Because
420 * the slabs are all pages aligned, the objects will be at the
421 * correct alignment when allocated.
423 if (flags & (CFLGS_OBJFREELIST_SLAB | CFLGS_OFF_SLAB)) {
424 num = slab_size / buffer_size;
425 *left_over = slab_size % buffer_size;
427 num = slab_size / (buffer_size + sizeof(freelist_idx_t));
428 *left_over = slab_size %
429 (buffer_size + sizeof(freelist_idx_t));
436 #define slab_error(cachep, msg) __slab_error(__func__, cachep, msg)
438 static void __slab_error(const char *function, struct kmem_cache *cachep,
441 pr_err("slab error in %s(): cache `%s': %s\n",
442 function, cachep->name, msg);
444 add_taint(TAINT_BAD_PAGE, LOCKDEP_NOW_UNRELIABLE);
449 * By default on NUMA we use alien caches to stage the freeing of
450 * objects allocated from other nodes. This causes massive memory
451 * inefficiencies when using fake NUMA setup to split memory into a
452 * large number of small nodes, so it can be disabled on the command
456 static int use_alien_caches __read_mostly = 1;
457 static int __init noaliencache_setup(char *s)
459 use_alien_caches = 0;
462 __setup("noaliencache", noaliencache_setup);
464 static int __init slab_max_order_setup(char *str)
466 get_option(&str, &slab_max_order);
467 slab_max_order = slab_max_order < 0 ? 0 :
468 min(slab_max_order, MAX_ORDER - 1);
469 slab_max_order_set = true;
473 __setup("slab_max_order=", slab_max_order_setup);
477 * Special reaping functions for NUMA systems called from cache_reap().
478 * These take care of doing round robin flushing of alien caches (containing
479 * objects freed on different nodes from which they were allocated) and the
480 * flushing of remote pcps by calling drain_node_pages.
482 static DEFINE_PER_CPU(unsigned long, slab_reap_node);
484 static void init_reap_node(int cpu)
486 per_cpu(slab_reap_node, cpu) = next_node_in(cpu_to_mem(cpu),
490 static void next_reap_node(void)
492 int node = __this_cpu_read(slab_reap_node);
494 node = next_node_in(node, node_online_map);
495 __this_cpu_write(slab_reap_node, node);
499 #define init_reap_node(cpu) do { } while (0)
500 #define next_reap_node(void) do { } while (0)
504 * Initiate the reap timer running on the target CPU. We run at around 1 to 2Hz
505 * via the workqueue/eventd.
506 * Add the CPU number into the expiration time to minimize the possibility of
507 * the CPUs getting into lockstep and contending for the global cache chain
510 static void start_cpu_timer(int cpu)
512 struct delayed_work *reap_work = &per_cpu(slab_reap_work, cpu);
514 if (reap_work->work.func == NULL) {
516 INIT_DEFERRABLE_WORK(reap_work, cache_reap);
517 schedule_delayed_work_on(cpu, reap_work,
518 __round_jiffies_relative(HZ, cpu));
522 static void init_arraycache(struct array_cache *ac, int limit, int batch)
527 ac->batchcount = batch;
532 static struct array_cache *alloc_arraycache(int node, int entries,
533 int batchcount, gfp_t gfp)
535 size_t memsize = sizeof(void *) * entries + sizeof(struct array_cache);
536 struct array_cache *ac = NULL;
538 ac = kmalloc_node(memsize, gfp, node);
540 * The array_cache structures contain pointers to free object.
541 * However, when such objects are allocated or transferred to another
542 * cache the pointers are not cleared and they could be counted as
543 * valid references during a kmemleak scan. Therefore, kmemleak must
544 * not scan such objects.
546 kmemleak_no_scan(ac);
547 init_arraycache(ac, entries, batchcount);
551 static noinline void cache_free_pfmemalloc(struct kmem_cache *cachep,
552 struct page *page, void *objp)
554 struct kmem_cache_node *n;
558 page_node = page_to_nid(page);
559 n = get_node(cachep, page_node);
561 spin_lock(&n->list_lock);
562 free_block(cachep, &objp, 1, page_node, &list);
563 spin_unlock(&n->list_lock);
565 slabs_destroy(cachep, &list);
569 * Transfer objects in one arraycache to another.
570 * Locking must be handled by the caller.
572 * Return the number of entries transferred.
574 static int transfer_objects(struct array_cache *to,
575 struct array_cache *from, unsigned int max)
577 /* Figure out how many entries to transfer */
578 int nr = min3(from->avail, max, to->limit - to->avail);
583 memcpy(to->entry + to->avail, from->entry + from->avail -nr,
593 #define drain_alien_cache(cachep, alien) do { } while (0)
594 #define reap_alien(cachep, n) do { } while (0)
596 static inline struct alien_cache **alloc_alien_cache(int node,
597 int limit, gfp_t gfp)
602 static inline void free_alien_cache(struct alien_cache **ac_ptr)
606 static inline int cache_free_alien(struct kmem_cache *cachep, void *objp)
611 static inline void *alternate_node_alloc(struct kmem_cache *cachep,
617 static inline void *____cache_alloc_node(struct kmem_cache *cachep,
618 gfp_t flags, int nodeid)
623 static inline gfp_t gfp_exact_node(gfp_t flags)
625 return flags & ~__GFP_NOFAIL;
628 #else /* CONFIG_NUMA */
630 static void *____cache_alloc_node(struct kmem_cache *, gfp_t, int);
631 static void *alternate_node_alloc(struct kmem_cache *, gfp_t);
633 static struct alien_cache *__alloc_alien_cache(int node, int entries,
634 int batch, gfp_t gfp)
636 size_t memsize = sizeof(void *) * entries + sizeof(struct alien_cache);
637 struct alien_cache *alc = NULL;
639 alc = kmalloc_node(memsize, gfp, node);
641 kmemleak_no_scan(alc);
642 init_arraycache(&alc->ac, entries, batch);
643 spin_lock_init(&alc->lock);
648 static struct alien_cache **alloc_alien_cache(int node, int limit, gfp_t gfp)
650 struct alien_cache **alc_ptr;
655 alc_ptr = kcalloc_node(nr_node_ids, sizeof(void *), gfp, node);
660 if (i == node || !node_online(i))
662 alc_ptr[i] = __alloc_alien_cache(node, limit, 0xbaadf00d, gfp);
664 for (i--; i >= 0; i--)
673 static void free_alien_cache(struct alien_cache **alc_ptr)
684 static void __drain_alien_cache(struct kmem_cache *cachep,
685 struct array_cache *ac, int node,
686 struct list_head *list)
688 struct kmem_cache_node *n = get_node(cachep, node);
691 spin_lock(&n->list_lock);
693 * Stuff objects into the remote nodes shared array first.
694 * That way we could avoid the overhead of putting the objects
695 * into the free lists and getting them back later.
698 transfer_objects(n->shared, ac, ac->limit);
700 free_block(cachep, ac->entry, ac->avail, node, list);
702 spin_unlock(&n->list_lock);
707 * Called from cache_reap() to regularly drain alien caches round robin.
709 static void reap_alien(struct kmem_cache *cachep, struct kmem_cache_node *n)
711 int node = __this_cpu_read(slab_reap_node);
714 struct alien_cache *alc = n->alien[node];
715 struct array_cache *ac;
719 if (ac->avail && spin_trylock_irq(&alc->lock)) {
722 __drain_alien_cache(cachep, ac, node, &list);
723 spin_unlock_irq(&alc->lock);
724 slabs_destroy(cachep, &list);
730 static void drain_alien_cache(struct kmem_cache *cachep,
731 struct alien_cache **alien)
734 struct alien_cache *alc;
735 struct array_cache *ac;
738 for_each_online_node(i) {
744 spin_lock_irqsave(&alc->lock, flags);
745 __drain_alien_cache(cachep, ac, i, &list);
746 spin_unlock_irqrestore(&alc->lock, flags);
747 slabs_destroy(cachep, &list);
752 static int __cache_free_alien(struct kmem_cache *cachep, void *objp,
753 int node, int page_node)
755 struct kmem_cache_node *n;
756 struct alien_cache *alien = NULL;
757 struct array_cache *ac;
760 n = get_node(cachep, node);
761 STATS_INC_NODEFREES(cachep);
762 if (n->alien && n->alien[page_node]) {
763 alien = n->alien[page_node];
765 spin_lock(&alien->lock);
766 if (unlikely(ac->avail == ac->limit)) {
767 STATS_INC_ACOVERFLOW(cachep);
768 __drain_alien_cache(cachep, ac, page_node, &list);
770 ac->entry[ac->avail++] = objp;
771 spin_unlock(&alien->lock);
772 slabs_destroy(cachep, &list);
774 n = get_node(cachep, page_node);
775 spin_lock(&n->list_lock);
776 free_block(cachep, &objp, 1, page_node, &list);
777 spin_unlock(&n->list_lock);
778 slabs_destroy(cachep, &list);
783 static inline int cache_free_alien(struct kmem_cache *cachep, void *objp)
785 int page_node = page_to_nid(virt_to_page(objp));
786 int node = numa_mem_id();
788 * Make sure we are not freeing a object from another node to the array
791 if (likely(node == page_node))
794 return __cache_free_alien(cachep, objp, node, page_node);
798 * Construct gfp mask to allocate from a specific node but do not reclaim or
799 * warn about failures.
801 static inline gfp_t gfp_exact_node(gfp_t flags)
803 return (flags | __GFP_THISNODE | __GFP_NOWARN) & ~(__GFP_RECLAIM|__GFP_NOFAIL);
807 static int init_cache_node(struct kmem_cache *cachep, int node, gfp_t gfp)
809 struct kmem_cache_node *n;
812 * Set up the kmem_cache_node for cpu before we can
813 * begin anything. Make sure some other cpu on this
814 * node has not already allocated this
816 n = get_node(cachep, node);
818 spin_lock_irq(&n->list_lock);
819 n->free_limit = (1 + nr_cpus_node(node)) * cachep->batchcount +
821 spin_unlock_irq(&n->list_lock);
826 n = kmalloc_node(sizeof(struct kmem_cache_node), gfp, node);
830 kmem_cache_node_init(n);
831 n->next_reap = jiffies + REAPTIMEOUT_NODE +
832 ((unsigned long)cachep) % REAPTIMEOUT_NODE;
835 (1 + nr_cpus_node(node)) * cachep->batchcount + cachep->num;
838 * The kmem_cache_nodes don't come and go as CPUs
839 * come and go. slab_mutex is sufficient
842 cachep->node[node] = n;
847 #if (defined(CONFIG_NUMA) && defined(CONFIG_MEMORY_HOTPLUG)) || defined(CONFIG_SMP)
849 * Allocates and initializes node for a node on each slab cache, used for
850 * either memory or cpu hotplug. If memory is being hot-added, the kmem_cache_node
851 * will be allocated off-node since memory is not yet online for the new node.
852 * When hotplugging memory or a cpu, existing node are not replaced if
855 * Must hold slab_mutex.
857 static int init_cache_node_node(int node)
860 struct kmem_cache *cachep;
862 list_for_each_entry(cachep, &slab_caches, list) {
863 ret = init_cache_node(cachep, node, GFP_KERNEL);
872 static int setup_kmem_cache_node(struct kmem_cache *cachep,
873 int node, gfp_t gfp, bool force_change)
876 struct kmem_cache_node *n;
877 struct array_cache *old_shared = NULL;
878 struct array_cache *new_shared = NULL;
879 struct alien_cache **new_alien = NULL;
882 if (use_alien_caches) {
883 new_alien = alloc_alien_cache(node, cachep->limit, gfp);
888 if (cachep->shared) {
889 new_shared = alloc_arraycache(node,
890 cachep->shared * cachep->batchcount, 0xbaadf00d, gfp);
895 ret = init_cache_node(cachep, node, gfp);
899 n = get_node(cachep, node);
900 spin_lock_irq(&n->list_lock);
901 if (n->shared && force_change) {
902 free_block(cachep, n->shared->entry,
903 n->shared->avail, node, &list);
904 n->shared->avail = 0;
907 if (!n->shared || force_change) {
908 old_shared = n->shared;
909 n->shared = new_shared;
914 n->alien = new_alien;
918 spin_unlock_irq(&n->list_lock);
919 slabs_destroy(cachep, &list);
922 * To protect lockless access to n->shared during irq disabled context.
923 * If n->shared isn't NULL in irq disabled context, accessing to it is
924 * guaranteed to be valid until irq is re-enabled, because it will be
925 * freed after synchronize_rcu().
927 if (old_shared && force_change)
933 free_alien_cache(new_alien);
940 static void cpuup_canceled(long cpu)
942 struct kmem_cache *cachep;
943 struct kmem_cache_node *n = NULL;
944 int node = cpu_to_mem(cpu);
945 const struct cpumask *mask = cpumask_of_node(node);
947 list_for_each_entry(cachep, &slab_caches, list) {
948 struct array_cache *nc;
949 struct array_cache *shared;
950 struct alien_cache **alien;
953 n = get_node(cachep, node);
957 spin_lock_irq(&n->list_lock);
959 /* Free limit for this kmem_cache_node */
960 n->free_limit -= cachep->batchcount;
962 /* cpu is dead; no one can alloc from it. */
963 nc = per_cpu_ptr(cachep->cpu_cache, cpu);
964 free_block(cachep, nc->entry, nc->avail, node, &list);
967 if (!cpumask_empty(mask)) {
968 spin_unlock_irq(&n->list_lock);
974 free_block(cachep, shared->entry,
975 shared->avail, node, &list);
982 spin_unlock_irq(&n->list_lock);
986 drain_alien_cache(cachep, alien);
987 free_alien_cache(alien);
991 slabs_destroy(cachep, &list);
994 * In the previous loop, all the objects were freed to
995 * the respective cache's slabs, now we can go ahead and
996 * shrink each nodelist to its limit.
998 list_for_each_entry(cachep, &slab_caches, list) {
999 n = get_node(cachep, node);
1002 drain_freelist(cachep, n, INT_MAX);
1006 static int cpuup_prepare(long cpu)
1008 struct kmem_cache *cachep;
1009 int node = cpu_to_mem(cpu);
1013 * We need to do this right in the beginning since
1014 * alloc_arraycache's are going to use this list.
1015 * kmalloc_node allows us to add the slab to the right
1016 * kmem_cache_node and not this cpu's kmem_cache_node
1018 err = init_cache_node_node(node);
1023 * Now we can go ahead with allocating the shared arrays and
1026 list_for_each_entry(cachep, &slab_caches, list) {
1027 err = setup_kmem_cache_node(cachep, node, GFP_KERNEL, false);
1034 cpuup_canceled(cpu);
1038 int slab_prepare_cpu(unsigned int cpu)
1042 mutex_lock(&slab_mutex);
1043 err = cpuup_prepare(cpu);
1044 mutex_unlock(&slab_mutex);
1049 * This is called for a failed online attempt and for a successful
1052 * Even if all the cpus of a node are down, we don't free the
1053 * kmem_list3 of any cache. This to avoid a race between cpu_down, and
1054 * a kmalloc allocation from another cpu for memory from the node of
1055 * the cpu going down. The list3 structure is usually allocated from
1056 * kmem_cache_create() and gets destroyed at kmem_cache_destroy().
1058 int slab_dead_cpu(unsigned int cpu)
1060 mutex_lock(&slab_mutex);
1061 cpuup_canceled(cpu);
1062 mutex_unlock(&slab_mutex);
1067 static int slab_online_cpu(unsigned int cpu)
1069 start_cpu_timer(cpu);
1073 static int slab_offline_cpu(unsigned int cpu)
1076 * Shutdown cache reaper. Note that the slab_mutex is held so
1077 * that if cache_reap() is invoked it cannot do anything
1078 * expensive but will only modify reap_work and reschedule the
1081 cancel_delayed_work_sync(&per_cpu(slab_reap_work, cpu));
1082 /* Now the cache_reaper is guaranteed to be not running. */
1083 per_cpu(slab_reap_work, cpu).work.func = NULL;
1087 #if defined(CONFIG_NUMA) && defined(CONFIG_MEMORY_HOTPLUG)
1089 * Drains freelist for a node on each slab cache, used for memory hot-remove.
1090 * Returns -EBUSY if all objects cannot be drained so that the node is not
1093 * Must hold slab_mutex.
1095 static int __meminit drain_cache_node_node(int node)
1097 struct kmem_cache *cachep;
1100 list_for_each_entry(cachep, &slab_caches, list) {
1101 struct kmem_cache_node *n;
1103 n = get_node(cachep, node);
1107 drain_freelist(cachep, n, INT_MAX);
1109 if (!list_empty(&n->slabs_full) ||
1110 !list_empty(&n->slabs_partial)) {
1118 static int __meminit slab_memory_callback(struct notifier_block *self,
1119 unsigned long action, void *arg)
1121 struct memory_notify *mnb = arg;
1125 nid = mnb->status_change_nid;
1130 case MEM_GOING_ONLINE:
1131 mutex_lock(&slab_mutex);
1132 ret = init_cache_node_node(nid);
1133 mutex_unlock(&slab_mutex);
1135 case MEM_GOING_OFFLINE:
1136 mutex_lock(&slab_mutex);
1137 ret = drain_cache_node_node(nid);
1138 mutex_unlock(&slab_mutex);
1142 case MEM_CANCEL_ONLINE:
1143 case MEM_CANCEL_OFFLINE:
1147 return notifier_from_errno(ret);
1149 #endif /* CONFIG_NUMA && CONFIG_MEMORY_HOTPLUG */
1152 * swap the static kmem_cache_node with kmalloced memory
1154 static void __init init_list(struct kmem_cache *cachep, struct kmem_cache_node *list,
1157 struct kmem_cache_node *ptr;
1159 ptr = kmalloc_node(sizeof(struct kmem_cache_node), GFP_NOWAIT, nodeid);
1162 memcpy(ptr, list, sizeof(struct kmem_cache_node));
1164 * Do not assume that spinlocks can be initialized via memcpy:
1166 spin_lock_init(&ptr->list_lock);
1168 MAKE_ALL_LISTS(cachep, ptr, nodeid);
1169 cachep->node[nodeid] = ptr;
1173 * For setting up all the kmem_cache_node for cache whose buffer_size is same as
1174 * size of kmem_cache_node.
1176 static void __init set_up_node(struct kmem_cache *cachep, int index)
1180 for_each_online_node(node) {
1181 cachep->node[node] = &init_kmem_cache_node[index + node];
1182 cachep->node[node]->next_reap = jiffies +
1184 ((unsigned long)cachep) % REAPTIMEOUT_NODE;
1189 * Initialisation. Called after the page allocator have been initialised and
1190 * before smp_init().
1192 void __init kmem_cache_init(void)
1196 kmem_cache = &kmem_cache_boot;
1198 if (!IS_ENABLED(CONFIG_NUMA) || num_possible_nodes() == 1)
1199 use_alien_caches = 0;
1201 for (i = 0; i < NUM_INIT_LISTS; i++)
1202 kmem_cache_node_init(&init_kmem_cache_node[i]);
1205 * Fragmentation resistance on low memory - only use bigger
1206 * page orders on machines with more than 32MB of memory if
1207 * not overridden on the command line.
1209 if (!slab_max_order_set && totalram_pages() > (32 << 20) >> PAGE_SHIFT)
1210 slab_max_order = SLAB_MAX_ORDER_HI;
1212 /* Bootstrap is tricky, because several objects are allocated
1213 * from caches that do not exist yet:
1214 * 1) initialize the kmem_cache cache: it contains the struct
1215 * kmem_cache structures of all caches, except kmem_cache itself:
1216 * kmem_cache is statically allocated.
1217 * Initially an __init data area is used for the head array and the
1218 * kmem_cache_node structures, it's replaced with a kmalloc allocated
1219 * array at the end of the bootstrap.
1220 * 2) Create the first kmalloc cache.
1221 * The struct kmem_cache for the new cache is allocated normally.
1222 * An __init data area is used for the head array.
1223 * 3) Create the remaining kmalloc caches, with minimally sized
1225 * 4) Replace the __init data head arrays for kmem_cache and the first
1226 * kmalloc cache with kmalloc allocated arrays.
1227 * 5) Replace the __init data for kmem_cache_node for kmem_cache and
1228 * the other cache's with kmalloc allocated memory.
1229 * 6) Resize the head arrays of the kmalloc caches to their final sizes.
1232 /* 1) create the kmem_cache */
1235 * struct kmem_cache size depends on nr_node_ids & nr_cpu_ids
1237 create_boot_cache(kmem_cache, "kmem_cache",
1238 offsetof(struct kmem_cache, node) +
1239 nr_node_ids * sizeof(struct kmem_cache_node *),
1240 SLAB_HWCACHE_ALIGN, 0, 0);
1241 list_add(&kmem_cache->list, &slab_caches);
1242 memcg_link_cache(kmem_cache, NULL);
1243 slab_state = PARTIAL;
1246 * Initialize the caches that provide memory for the kmem_cache_node
1247 * structures first. Without this, further allocations will bug.
1249 kmalloc_caches[KMALLOC_NORMAL][INDEX_NODE] = create_kmalloc_cache(
1250 kmalloc_info[INDEX_NODE].name,
1251 kmalloc_size(INDEX_NODE), ARCH_KMALLOC_FLAGS,
1252 0, kmalloc_size(INDEX_NODE));
1253 slab_state = PARTIAL_NODE;
1254 setup_kmalloc_cache_index_table();
1256 slab_early_init = 0;
1258 /* 5) Replace the bootstrap kmem_cache_node */
1262 for_each_online_node(nid) {
1263 init_list(kmem_cache, &init_kmem_cache_node[CACHE_CACHE + nid], nid);
1265 init_list(kmalloc_caches[KMALLOC_NORMAL][INDEX_NODE],
1266 &init_kmem_cache_node[SIZE_NODE + nid], nid);
1270 create_kmalloc_caches(ARCH_KMALLOC_FLAGS);
1273 void __init kmem_cache_init_late(void)
1275 struct kmem_cache *cachep;
1277 /* 6) resize the head arrays to their final sizes */
1278 mutex_lock(&slab_mutex);
1279 list_for_each_entry(cachep, &slab_caches, list)
1280 if (enable_cpucache(cachep, GFP_NOWAIT))
1282 mutex_unlock(&slab_mutex);
1289 * Register a memory hotplug callback that initializes and frees
1292 hotplug_memory_notifier(slab_memory_callback, SLAB_CALLBACK_PRI);
1296 * The reap timers are started later, with a module init call: That part
1297 * of the kernel is not yet operational.
1301 static int __init cpucache_init(void)
1306 * Register the timers that return unneeded pages to the page allocator
1308 ret = cpuhp_setup_state(CPUHP_AP_ONLINE_DYN, "SLAB online",
1309 slab_online_cpu, slab_offline_cpu);
1314 __initcall(cpucache_init);
1316 static noinline void
1317 slab_out_of_memory(struct kmem_cache *cachep, gfp_t gfpflags, int nodeid)
1320 struct kmem_cache_node *n;
1321 unsigned long flags;
1323 static DEFINE_RATELIMIT_STATE(slab_oom_rs, DEFAULT_RATELIMIT_INTERVAL,
1324 DEFAULT_RATELIMIT_BURST);
1326 if ((gfpflags & __GFP_NOWARN) || !__ratelimit(&slab_oom_rs))
1329 pr_warn("SLAB: Unable to allocate memory on node %d, gfp=%#x(%pGg)\n",
1330 nodeid, gfpflags, &gfpflags);
1331 pr_warn(" cache: %s, object size: %d, order: %d\n",
1332 cachep->name, cachep->size, cachep->gfporder);
1334 for_each_kmem_cache_node(cachep, node, n) {
1335 unsigned long total_slabs, free_slabs, free_objs;
1337 spin_lock_irqsave(&n->list_lock, flags);
1338 total_slabs = n->total_slabs;
1339 free_slabs = n->free_slabs;
1340 free_objs = n->free_objects;
1341 spin_unlock_irqrestore(&n->list_lock, flags);
1343 pr_warn(" node %d: slabs: %ld/%ld, objs: %ld/%ld\n",
1344 node, total_slabs - free_slabs, total_slabs,
1345 (total_slabs * cachep->num) - free_objs,
1346 total_slabs * cachep->num);
1352 * Interface to system's page allocator. No need to hold the
1353 * kmem_cache_node ->list_lock.
1355 * If we requested dmaable memory, we will get it. Even if we
1356 * did not request dmaable memory, we might get it, but that
1357 * would be relatively rare and ignorable.
1359 static struct page *kmem_getpages(struct kmem_cache *cachep, gfp_t flags,
1364 flags |= cachep->allocflags;
1366 page = __alloc_pages_node(nodeid, flags, cachep->gfporder);
1368 slab_out_of_memory(cachep, flags, nodeid);
1372 if (charge_slab_page(page, flags, cachep->gfporder, cachep)) {
1373 __free_pages(page, cachep->gfporder);
1377 __SetPageSlab(page);
1378 /* Record if ALLOC_NO_WATERMARKS was set when allocating the slab */
1379 if (sk_memalloc_socks() && page_is_pfmemalloc(page))
1380 SetPageSlabPfmemalloc(page);
1386 * Interface to system's page release.
1388 static void kmem_freepages(struct kmem_cache *cachep, struct page *page)
1390 int order = cachep->gfporder;
1392 BUG_ON(!PageSlab(page));
1393 __ClearPageSlabPfmemalloc(page);
1394 __ClearPageSlab(page);
1395 page_mapcount_reset(page);
1396 page->mapping = NULL;
1398 if (current->reclaim_state)
1399 current->reclaim_state->reclaimed_slab += 1 << order;
1400 uncharge_slab_page(page, order, cachep);
1401 __free_pages(page, order);
1404 static void kmem_rcu_free(struct rcu_head *head)
1406 struct kmem_cache *cachep;
1409 page = container_of(head, struct page, rcu_head);
1410 cachep = page->slab_cache;
1412 kmem_freepages(cachep, page);
1416 static bool is_debug_pagealloc_cache(struct kmem_cache *cachep)
1418 if (debug_pagealloc_enabled_static() && OFF_SLAB(cachep) &&
1419 (cachep->size % PAGE_SIZE) == 0)
1425 #ifdef CONFIG_DEBUG_PAGEALLOC
1426 static void slab_kernel_map(struct kmem_cache *cachep, void *objp, int map)
1428 if (!is_debug_pagealloc_cache(cachep))
1431 kernel_map_pages(virt_to_page(objp), cachep->size / PAGE_SIZE, map);
1435 static inline void slab_kernel_map(struct kmem_cache *cachep, void *objp,
1440 static void poison_obj(struct kmem_cache *cachep, void *addr, unsigned char val)
1442 int size = cachep->object_size;
1443 addr = &((char *)addr)[obj_offset(cachep)];
1445 memset(addr, val, size);
1446 *(unsigned char *)(addr + size - 1) = POISON_END;
1449 static void dump_line(char *data, int offset, int limit)
1452 unsigned char error = 0;
1455 pr_err("%03x: ", offset);
1456 for (i = 0; i < limit; i++) {
1457 if (data[offset + i] != POISON_FREE) {
1458 error = data[offset + i];
1462 print_hex_dump(KERN_CONT, "", 0, 16, 1,
1463 &data[offset], limit, 1);
1465 if (bad_count == 1) {
1466 error ^= POISON_FREE;
1467 if (!(error & (error - 1))) {
1468 pr_err("Single bit error detected. Probably bad RAM.\n");
1470 pr_err("Run memtest86+ or a similar memory test tool.\n");
1472 pr_err("Run a memory test tool.\n");
1481 static void print_objinfo(struct kmem_cache *cachep, void *objp, int lines)
1486 if (cachep->flags & SLAB_RED_ZONE) {
1487 pr_err("Redzone: 0x%llx/0x%llx\n",
1488 *dbg_redzone1(cachep, objp),
1489 *dbg_redzone2(cachep, objp));
1492 if (cachep->flags & SLAB_STORE_USER)
1493 pr_err("Last user: (%pSR)\n", *dbg_userword(cachep, objp));
1494 realobj = (char *)objp + obj_offset(cachep);
1495 size = cachep->object_size;
1496 for (i = 0; i < size && lines; i += 16, lines--) {
1499 if (i + limit > size)
1501 dump_line(realobj, i, limit);
1505 static void check_poison_obj(struct kmem_cache *cachep, void *objp)
1511 if (is_debug_pagealloc_cache(cachep))
1514 realobj = (char *)objp + obj_offset(cachep);
1515 size = cachep->object_size;
1517 for (i = 0; i < size; i++) {
1518 char exp = POISON_FREE;
1521 if (realobj[i] != exp) {
1526 pr_err("Slab corruption (%s): %s start=%px, len=%d\n",
1527 print_tainted(), cachep->name,
1529 print_objinfo(cachep, objp, 0);
1531 /* Hexdump the affected line */
1534 if (i + limit > size)
1536 dump_line(realobj, i, limit);
1539 /* Limit to 5 lines */
1545 /* Print some data about the neighboring objects, if they
1548 struct page *page = virt_to_head_page(objp);
1551 objnr = obj_to_index(cachep, page, objp);
1553 objp = index_to_obj(cachep, page, objnr - 1);
1554 realobj = (char *)objp + obj_offset(cachep);
1555 pr_err("Prev obj: start=%px, len=%d\n", realobj, size);
1556 print_objinfo(cachep, objp, 2);
1558 if (objnr + 1 < cachep->num) {
1559 objp = index_to_obj(cachep, page, objnr + 1);
1560 realobj = (char *)objp + obj_offset(cachep);
1561 pr_err("Next obj: start=%px, len=%d\n", realobj, size);
1562 print_objinfo(cachep, objp, 2);
1569 static void slab_destroy_debugcheck(struct kmem_cache *cachep,
1574 if (OBJFREELIST_SLAB(cachep) && cachep->flags & SLAB_POISON) {
1575 poison_obj(cachep, page->freelist - obj_offset(cachep),
1579 for (i = 0; i < cachep->num; i++) {
1580 void *objp = index_to_obj(cachep, page, i);
1582 if (cachep->flags & SLAB_POISON) {
1583 check_poison_obj(cachep, objp);
1584 slab_kernel_map(cachep, objp, 1);
1586 if (cachep->flags & SLAB_RED_ZONE) {
1587 if (*dbg_redzone1(cachep, objp) != RED_INACTIVE)
1588 slab_error(cachep, "start of a freed object was overwritten");
1589 if (*dbg_redzone2(cachep, objp) != RED_INACTIVE)
1590 slab_error(cachep, "end of a freed object was overwritten");
1595 static void slab_destroy_debugcheck(struct kmem_cache *cachep,
1602 * slab_destroy - destroy and release all objects in a slab
1603 * @cachep: cache pointer being destroyed
1604 * @page: page pointer being destroyed
1606 * Destroy all the objs in a slab page, and release the mem back to the system.
1607 * Before calling the slab page must have been unlinked from the cache. The
1608 * kmem_cache_node ->list_lock is not held/needed.
1610 static void slab_destroy(struct kmem_cache *cachep, struct page *page)
1614 freelist = page->freelist;
1615 slab_destroy_debugcheck(cachep, page);
1616 if (unlikely(cachep->flags & SLAB_TYPESAFE_BY_RCU))
1617 call_rcu(&page->rcu_head, kmem_rcu_free);
1619 kmem_freepages(cachep, page);
1622 * From now on, we don't use freelist
1623 * although actual page can be freed in rcu context
1625 if (OFF_SLAB(cachep))
1626 kmem_cache_free(cachep->freelist_cache, freelist);
1629 static void slabs_destroy(struct kmem_cache *cachep, struct list_head *list)
1631 struct page *page, *n;
1633 list_for_each_entry_safe(page, n, list, slab_list) {
1634 list_del(&page->slab_list);
1635 slab_destroy(cachep, page);
1640 * calculate_slab_order - calculate size (page order) of slabs
1641 * @cachep: pointer to the cache that is being created
1642 * @size: size of objects to be created in this cache.
1643 * @flags: slab allocation flags
1645 * Also calculates the number of objects per slab.
1647 * This could be made much more intelligent. For now, try to avoid using
1648 * high order pages for slabs. When the gfp() functions are more friendly
1649 * towards high-order requests, this should be changed.
1651 * Return: number of left-over bytes in a slab
1653 static size_t calculate_slab_order(struct kmem_cache *cachep,
1654 size_t size, slab_flags_t flags)
1656 size_t left_over = 0;
1659 for (gfporder = 0; gfporder <= KMALLOC_MAX_ORDER; gfporder++) {
1663 num = cache_estimate(gfporder, size, flags, &remainder);
1667 /* Can't handle number of objects more than SLAB_OBJ_MAX_NUM */
1668 if (num > SLAB_OBJ_MAX_NUM)
1671 if (flags & CFLGS_OFF_SLAB) {
1672 struct kmem_cache *freelist_cache;
1673 size_t freelist_size;
1675 freelist_size = num * sizeof(freelist_idx_t);
1676 freelist_cache = kmalloc_slab(freelist_size, 0u);
1677 if (!freelist_cache)
1681 * Needed to avoid possible looping condition
1682 * in cache_grow_begin()
1684 if (OFF_SLAB(freelist_cache))
1687 /* check if off slab has enough benefit */
1688 if (freelist_cache->size > cachep->size / 2)
1692 /* Found something acceptable - save it away */
1694 cachep->gfporder = gfporder;
1695 left_over = remainder;
1698 * A VFS-reclaimable slab tends to have most allocations
1699 * as GFP_NOFS and we really don't want to have to be allocating
1700 * higher-order pages when we are unable to shrink dcache.
1702 if (flags & SLAB_RECLAIM_ACCOUNT)
1706 * Large number of objects is good, but very large slabs are
1707 * currently bad for the gfp()s.
1709 if (gfporder >= slab_max_order)
1713 * Acceptable internal fragmentation?
1715 if (left_over * 8 <= (PAGE_SIZE << gfporder))
1721 static struct array_cache __percpu *alloc_kmem_cache_cpus(
1722 struct kmem_cache *cachep, int entries, int batchcount)
1726 struct array_cache __percpu *cpu_cache;
1728 size = sizeof(void *) * entries + sizeof(struct array_cache);
1729 cpu_cache = __alloc_percpu(size, sizeof(void *));
1734 for_each_possible_cpu(cpu) {
1735 init_arraycache(per_cpu_ptr(cpu_cache, cpu),
1736 entries, batchcount);
1742 static int __ref setup_cpu_cache(struct kmem_cache *cachep, gfp_t gfp)
1744 if (slab_state >= FULL)
1745 return enable_cpucache(cachep, gfp);
1747 cachep->cpu_cache = alloc_kmem_cache_cpus(cachep, 1, 1);
1748 if (!cachep->cpu_cache)
1751 if (slab_state == DOWN) {
1752 /* Creation of first cache (kmem_cache). */
1753 set_up_node(kmem_cache, CACHE_CACHE);
1754 } else if (slab_state == PARTIAL) {
1755 /* For kmem_cache_node */
1756 set_up_node(cachep, SIZE_NODE);
1760 for_each_online_node(node) {
1761 cachep->node[node] = kmalloc_node(
1762 sizeof(struct kmem_cache_node), gfp, node);
1763 BUG_ON(!cachep->node[node]);
1764 kmem_cache_node_init(cachep->node[node]);
1768 cachep->node[numa_mem_id()]->next_reap =
1769 jiffies + REAPTIMEOUT_NODE +
1770 ((unsigned long)cachep) % REAPTIMEOUT_NODE;
1772 cpu_cache_get(cachep)->avail = 0;
1773 cpu_cache_get(cachep)->limit = BOOT_CPUCACHE_ENTRIES;
1774 cpu_cache_get(cachep)->batchcount = 1;
1775 cpu_cache_get(cachep)->touched = 0;
1776 cachep->batchcount = 1;
1777 cachep->limit = BOOT_CPUCACHE_ENTRIES;
1781 slab_flags_t kmem_cache_flags(unsigned int object_size,
1782 slab_flags_t flags, const char *name,
1783 void (*ctor)(void *))
1789 __kmem_cache_alias(const char *name, unsigned int size, unsigned int align,
1790 slab_flags_t flags, void (*ctor)(void *))
1792 struct kmem_cache *cachep;
1794 cachep = find_mergeable(size, align, flags, name, ctor);
1799 * Adjust the object sizes so that we clear
1800 * the complete object on kzalloc.
1802 cachep->object_size = max_t(int, cachep->object_size, size);
1807 static bool set_objfreelist_slab_cache(struct kmem_cache *cachep,
1808 size_t size, slab_flags_t flags)
1815 * If slab auto-initialization on free is enabled, store the freelist
1816 * off-slab, so that its contents don't end up in one of the allocated
1819 if (unlikely(slab_want_init_on_free(cachep)))
1822 if (cachep->ctor || flags & SLAB_TYPESAFE_BY_RCU)
1825 left = calculate_slab_order(cachep, size,
1826 flags | CFLGS_OBJFREELIST_SLAB);
1830 if (cachep->num * sizeof(freelist_idx_t) > cachep->object_size)
1833 cachep->colour = left / cachep->colour_off;
1838 static bool set_off_slab_cache(struct kmem_cache *cachep,
1839 size_t size, slab_flags_t flags)
1846 * Always use on-slab management when SLAB_NOLEAKTRACE
1847 * to avoid recursive calls into kmemleak.
1849 if (flags & SLAB_NOLEAKTRACE)
1853 * Size is large, assume best to place the slab management obj
1854 * off-slab (should allow better packing of objs).
1856 left = calculate_slab_order(cachep, size, flags | CFLGS_OFF_SLAB);
1861 * If the slab has been placed off-slab, and we have enough space then
1862 * move it on-slab. This is at the expense of any extra colouring.
1864 if (left >= cachep->num * sizeof(freelist_idx_t))
1867 cachep->colour = left / cachep->colour_off;
1872 static bool set_on_slab_cache(struct kmem_cache *cachep,
1873 size_t size, slab_flags_t flags)
1879 left = calculate_slab_order(cachep, size, flags);
1883 cachep->colour = left / cachep->colour_off;
1889 * __kmem_cache_create - Create a cache.
1890 * @cachep: cache management descriptor
1891 * @flags: SLAB flags
1893 * Returns a ptr to the cache on success, NULL on failure.
1894 * Cannot be called within a int, but can be interrupted.
1895 * The @ctor is run when new pages are allocated by the cache.
1899 * %SLAB_POISON - Poison the slab with a known test pattern (a5a5a5a5)
1900 * to catch references to uninitialised memory.
1902 * %SLAB_RED_ZONE - Insert `Red' zones around the allocated memory to check
1903 * for buffer overruns.
1905 * %SLAB_HWCACHE_ALIGN - Align the objects in this cache to a hardware
1906 * cacheline. This can be beneficial if you're counting cycles as closely
1909 * Return: a pointer to the created cache or %NULL in case of error
1911 int __kmem_cache_create(struct kmem_cache *cachep, slab_flags_t flags)
1913 size_t ralign = BYTES_PER_WORD;
1916 unsigned int size = cachep->size;
1921 * Enable redzoning and last user accounting, except for caches with
1922 * large objects, if the increased size would increase the object size
1923 * above the next power of two: caches with object sizes just above a
1924 * power of two have a significant amount of internal fragmentation.
1926 if (size < 4096 || fls(size - 1) == fls(size-1 + REDZONE_ALIGN +
1927 2 * sizeof(unsigned long long)))
1928 flags |= SLAB_RED_ZONE | SLAB_STORE_USER;
1929 if (!(flags & SLAB_TYPESAFE_BY_RCU))
1930 flags |= SLAB_POISON;
1935 * Check that size is in terms of words. This is needed to avoid
1936 * unaligned accesses for some archs when redzoning is used, and makes
1937 * sure any on-slab bufctl's are also correctly aligned.
1939 size = ALIGN(size, BYTES_PER_WORD);
1941 if (flags & SLAB_RED_ZONE) {
1942 ralign = REDZONE_ALIGN;
1943 /* If redzoning, ensure that the second redzone is suitably
1944 * aligned, by adjusting the object size accordingly. */
1945 size = ALIGN(size, REDZONE_ALIGN);
1948 /* 3) caller mandated alignment */
1949 if (ralign < cachep->align) {
1950 ralign = cachep->align;
1952 /* disable debug if necessary */
1953 if (ralign > __alignof__(unsigned long long))
1954 flags &= ~(SLAB_RED_ZONE | SLAB_STORE_USER);
1958 cachep->align = ralign;
1959 cachep->colour_off = cache_line_size();
1960 /* Offset must be a multiple of the alignment. */
1961 if (cachep->colour_off < cachep->align)
1962 cachep->colour_off = cachep->align;
1964 if (slab_is_available())
1972 * Both debugging options require word-alignment which is calculated
1975 if (flags & SLAB_RED_ZONE) {
1976 /* add space for red zone words */
1977 cachep->obj_offset += sizeof(unsigned long long);
1978 size += 2 * sizeof(unsigned long long);
1980 if (flags & SLAB_STORE_USER) {
1981 /* user store requires one word storage behind the end of
1982 * the real object. But if the second red zone needs to be
1983 * aligned to 64 bits, we must allow that much space.
1985 if (flags & SLAB_RED_ZONE)
1986 size += REDZONE_ALIGN;
1988 size += BYTES_PER_WORD;
1992 kasan_cache_create(cachep, &size, &flags);
1994 size = ALIGN(size, cachep->align);
1996 * We should restrict the number of objects in a slab to implement
1997 * byte sized index. Refer comment on SLAB_OBJ_MIN_SIZE definition.
1999 if (FREELIST_BYTE_INDEX && size < SLAB_OBJ_MIN_SIZE)
2000 size = ALIGN(SLAB_OBJ_MIN_SIZE, cachep->align);
2004 * To activate debug pagealloc, off-slab management is necessary
2005 * requirement. In early phase of initialization, small sized slab
2006 * doesn't get initialized so it would not be possible. So, we need
2007 * to check size >= 256. It guarantees that all necessary small
2008 * sized slab is initialized in current slab initialization sequence.
2010 if (debug_pagealloc_enabled_static() && (flags & SLAB_POISON) &&
2011 size >= 256 && cachep->object_size > cache_line_size()) {
2012 if (size < PAGE_SIZE || size % PAGE_SIZE == 0) {
2013 size_t tmp_size = ALIGN(size, PAGE_SIZE);
2015 if (set_off_slab_cache(cachep, tmp_size, flags)) {
2016 flags |= CFLGS_OFF_SLAB;
2017 cachep->obj_offset += tmp_size - size;
2025 if (set_objfreelist_slab_cache(cachep, size, flags)) {
2026 flags |= CFLGS_OBJFREELIST_SLAB;
2030 if (set_off_slab_cache(cachep, size, flags)) {
2031 flags |= CFLGS_OFF_SLAB;
2035 if (set_on_slab_cache(cachep, size, flags))
2041 cachep->freelist_size = cachep->num * sizeof(freelist_idx_t);
2042 cachep->flags = flags;
2043 cachep->allocflags = __GFP_COMP;
2044 if (flags & SLAB_CACHE_DMA)
2045 cachep->allocflags |= GFP_DMA;
2046 if (flags & SLAB_CACHE_DMA32)
2047 cachep->allocflags |= GFP_DMA32;
2048 if (flags & SLAB_RECLAIM_ACCOUNT)
2049 cachep->allocflags |= __GFP_RECLAIMABLE;
2050 cachep->size = size;
2051 cachep->reciprocal_buffer_size = reciprocal_value(size);
2055 * If we're going to use the generic kernel_map_pages()
2056 * poisoning, then it's going to smash the contents of
2057 * the redzone and userword anyhow, so switch them off.
2059 if (IS_ENABLED(CONFIG_PAGE_POISONING) &&
2060 (cachep->flags & SLAB_POISON) &&
2061 is_debug_pagealloc_cache(cachep))
2062 cachep->flags &= ~(SLAB_RED_ZONE | SLAB_STORE_USER);
2065 if (OFF_SLAB(cachep)) {
2066 cachep->freelist_cache =
2067 kmalloc_slab(cachep->freelist_size, 0u);
2070 err = setup_cpu_cache(cachep, gfp);
2072 __kmem_cache_release(cachep);
2080 static void check_irq_off(void)
2082 BUG_ON(!irqs_disabled());
2085 static void check_irq_on(void)
2087 BUG_ON(irqs_disabled());
2090 static void check_mutex_acquired(void)
2092 BUG_ON(!mutex_is_locked(&slab_mutex));
2095 static void check_spinlock_acquired(struct kmem_cache *cachep)
2099 assert_spin_locked(&get_node(cachep, numa_mem_id())->list_lock);
2103 static void check_spinlock_acquired_node(struct kmem_cache *cachep, int node)
2107 assert_spin_locked(&get_node(cachep, node)->list_lock);
2112 #define check_irq_off() do { } while(0)
2113 #define check_irq_on() do { } while(0)
2114 #define check_mutex_acquired() do { } while(0)
2115 #define check_spinlock_acquired(x) do { } while(0)
2116 #define check_spinlock_acquired_node(x, y) do { } while(0)
2119 static void drain_array_locked(struct kmem_cache *cachep, struct array_cache *ac,
2120 int node, bool free_all, struct list_head *list)
2124 if (!ac || !ac->avail)
2127 tofree = free_all ? ac->avail : (ac->limit + 4) / 5;
2128 if (tofree > ac->avail)
2129 tofree = (ac->avail + 1) / 2;
2131 free_block(cachep, ac->entry, tofree, node, list);
2132 ac->avail -= tofree;
2133 memmove(ac->entry, &(ac->entry[tofree]), sizeof(void *) * ac->avail);
2136 static void do_drain(void *arg)
2138 struct kmem_cache *cachep = arg;
2139 struct array_cache *ac;
2140 int node = numa_mem_id();
2141 struct kmem_cache_node *n;
2145 ac = cpu_cache_get(cachep);
2146 n = get_node(cachep, node);
2147 spin_lock(&n->list_lock);
2148 free_block(cachep, ac->entry, ac->avail, node, &list);
2149 spin_unlock(&n->list_lock);
2150 slabs_destroy(cachep, &list);
2154 static void drain_cpu_caches(struct kmem_cache *cachep)
2156 struct kmem_cache_node *n;
2160 on_each_cpu(do_drain, cachep, 1);
2162 for_each_kmem_cache_node(cachep, node, n)
2164 drain_alien_cache(cachep, n->alien);
2166 for_each_kmem_cache_node(cachep, node, n) {
2167 spin_lock_irq(&n->list_lock);
2168 drain_array_locked(cachep, n->shared, node, true, &list);
2169 spin_unlock_irq(&n->list_lock);
2171 slabs_destroy(cachep, &list);
2176 * Remove slabs from the list of free slabs.
2177 * Specify the number of slabs to drain in tofree.
2179 * Returns the actual number of slabs released.
2181 static int drain_freelist(struct kmem_cache *cache,
2182 struct kmem_cache_node *n, int tofree)
2184 struct list_head *p;
2189 while (nr_freed < tofree && !list_empty(&n->slabs_free)) {
2191 spin_lock_irq(&n->list_lock);
2192 p = n->slabs_free.prev;
2193 if (p == &n->slabs_free) {
2194 spin_unlock_irq(&n->list_lock);
2198 page = list_entry(p, struct page, slab_list);
2199 list_del(&page->slab_list);
2203 * Safe to drop the lock. The slab is no longer linked
2206 n->free_objects -= cache->num;
2207 spin_unlock_irq(&n->list_lock);
2208 slab_destroy(cache, page);
2215 bool __kmem_cache_empty(struct kmem_cache *s)
2218 struct kmem_cache_node *n;
2220 for_each_kmem_cache_node(s, node, n)
2221 if (!list_empty(&n->slabs_full) ||
2222 !list_empty(&n->slabs_partial))
2227 int __kmem_cache_shrink(struct kmem_cache *cachep)
2231 struct kmem_cache_node *n;
2233 drain_cpu_caches(cachep);
2236 for_each_kmem_cache_node(cachep, node, n) {
2237 drain_freelist(cachep, n, INT_MAX);
2239 ret += !list_empty(&n->slabs_full) ||
2240 !list_empty(&n->slabs_partial);
2242 return (ret ? 1 : 0);
2246 void __kmemcg_cache_deactivate(struct kmem_cache *cachep)
2248 __kmem_cache_shrink(cachep);
2251 void __kmemcg_cache_deactivate_after_rcu(struct kmem_cache *s)
2256 int __kmem_cache_shutdown(struct kmem_cache *cachep)
2258 return __kmem_cache_shrink(cachep);
2261 void __kmem_cache_release(struct kmem_cache *cachep)
2264 struct kmem_cache_node *n;
2266 cache_random_seq_destroy(cachep);
2268 free_percpu(cachep->cpu_cache);
2270 /* NUMA: free the node structures */
2271 for_each_kmem_cache_node(cachep, i, n) {
2273 free_alien_cache(n->alien);
2275 cachep->node[i] = NULL;
2280 * Get the memory for a slab management obj.
2282 * For a slab cache when the slab descriptor is off-slab, the
2283 * slab descriptor can't come from the same cache which is being created,
2284 * Because if it is the case, that means we defer the creation of
2285 * the kmalloc_{dma,}_cache of size sizeof(slab descriptor) to this point.
2286 * And we eventually call down to __kmem_cache_create(), which
2287 * in turn looks up in the kmalloc_{dma,}_caches for the disired-size one.
2288 * This is a "chicken-and-egg" problem.
2290 * So the off-slab slab descriptor shall come from the kmalloc_{dma,}_caches,
2291 * which are all initialized during kmem_cache_init().
2293 static void *alloc_slabmgmt(struct kmem_cache *cachep,
2294 struct page *page, int colour_off,
2295 gfp_t local_flags, int nodeid)
2298 void *addr = page_address(page);
2300 page->s_mem = addr + colour_off;
2303 if (OBJFREELIST_SLAB(cachep))
2305 else if (OFF_SLAB(cachep)) {
2306 /* Slab management obj is off-slab. */
2307 freelist = kmem_cache_alloc_node(cachep->freelist_cache,
2308 local_flags, nodeid);
2312 /* We will use last bytes at the slab for freelist */
2313 freelist = addr + (PAGE_SIZE << cachep->gfporder) -
2314 cachep->freelist_size;
2320 static inline freelist_idx_t get_free_obj(struct page *page, unsigned int idx)
2322 return ((freelist_idx_t *)page->freelist)[idx];
2325 static inline void set_free_obj(struct page *page,
2326 unsigned int idx, freelist_idx_t val)
2328 ((freelist_idx_t *)(page->freelist))[idx] = val;
2331 static void cache_init_objs_debug(struct kmem_cache *cachep, struct page *page)
2336 for (i = 0; i < cachep->num; i++) {
2337 void *objp = index_to_obj(cachep, page, i);
2339 if (cachep->flags & SLAB_STORE_USER)
2340 *dbg_userword(cachep, objp) = NULL;
2342 if (cachep->flags & SLAB_RED_ZONE) {
2343 *dbg_redzone1(cachep, objp) = RED_INACTIVE;
2344 *dbg_redzone2(cachep, objp) = RED_INACTIVE;
2347 * Constructors are not allowed to allocate memory from the same
2348 * cache which they are a constructor for. Otherwise, deadlock.
2349 * They must also be threaded.
2351 if (cachep->ctor && !(cachep->flags & SLAB_POISON)) {
2352 kasan_unpoison_object_data(cachep,
2353 objp + obj_offset(cachep));
2354 cachep->ctor(objp + obj_offset(cachep));
2355 kasan_poison_object_data(
2356 cachep, objp + obj_offset(cachep));
2359 if (cachep->flags & SLAB_RED_ZONE) {
2360 if (*dbg_redzone2(cachep, objp) != RED_INACTIVE)
2361 slab_error(cachep, "constructor overwrote the end of an object");
2362 if (*dbg_redzone1(cachep, objp) != RED_INACTIVE)
2363 slab_error(cachep, "constructor overwrote the start of an object");
2365 /* need to poison the objs? */
2366 if (cachep->flags & SLAB_POISON) {
2367 poison_obj(cachep, objp, POISON_FREE);
2368 slab_kernel_map(cachep, objp, 0);
2374 #ifdef CONFIG_SLAB_FREELIST_RANDOM
2375 /* Hold information during a freelist initialization */
2376 union freelist_init_state {
2382 struct rnd_state rnd_state;
2386 * Initialize the state based on the randomization methode available.
2387 * return true if the pre-computed list is available, false otherwize.
2389 static bool freelist_state_initialize(union freelist_init_state *state,
2390 struct kmem_cache *cachep,
2396 /* Use best entropy available to define a random shift */
2397 rand = get_random_int();
2399 /* Use a random state if the pre-computed list is not available */
2400 if (!cachep->random_seq) {
2401 prandom_seed_state(&state->rnd_state, rand);
2404 state->list = cachep->random_seq;
2405 state->count = count;
2406 state->pos = rand % count;
2412 /* Get the next entry on the list and randomize it using a random shift */
2413 static freelist_idx_t next_random_slot(union freelist_init_state *state)
2415 if (state->pos >= state->count)
2417 return state->list[state->pos++];
2420 /* Swap two freelist entries */
2421 static void swap_free_obj(struct page *page, unsigned int a, unsigned int b)
2423 swap(((freelist_idx_t *)page->freelist)[a],
2424 ((freelist_idx_t *)page->freelist)[b]);
2428 * Shuffle the freelist initialization state based on pre-computed lists.
2429 * return true if the list was successfully shuffled, false otherwise.
2431 static bool shuffle_freelist(struct kmem_cache *cachep, struct page *page)
2433 unsigned int objfreelist = 0, i, rand, count = cachep->num;
2434 union freelist_init_state state;
2440 precomputed = freelist_state_initialize(&state, cachep, count);
2442 /* Take a random entry as the objfreelist */
2443 if (OBJFREELIST_SLAB(cachep)) {
2445 objfreelist = count - 1;
2447 objfreelist = next_random_slot(&state);
2448 page->freelist = index_to_obj(cachep, page, objfreelist) +
2454 * On early boot, generate the list dynamically.
2455 * Later use a pre-computed list for speed.
2458 for (i = 0; i < count; i++)
2459 set_free_obj(page, i, i);
2461 /* Fisher-Yates shuffle */
2462 for (i = count - 1; i > 0; i--) {
2463 rand = prandom_u32_state(&state.rnd_state);
2465 swap_free_obj(page, i, rand);
2468 for (i = 0; i < count; i++)
2469 set_free_obj(page, i, next_random_slot(&state));
2472 if (OBJFREELIST_SLAB(cachep))
2473 set_free_obj(page, cachep->num - 1, objfreelist);
2478 static inline bool shuffle_freelist(struct kmem_cache *cachep,
2483 #endif /* CONFIG_SLAB_FREELIST_RANDOM */
2485 static void cache_init_objs(struct kmem_cache *cachep,
2492 cache_init_objs_debug(cachep, page);
2494 /* Try to randomize the freelist if enabled */
2495 shuffled = shuffle_freelist(cachep, page);
2497 if (!shuffled && OBJFREELIST_SLAB(cachep)) {
2498 page->freelist = index_to_obj(cachep, page, cachep->num - 1) +
2502 for (i = 0; i < cachep->num; i++) {
2503 objp = index_to_obj(cachep, page, i);
2504 objp = kasan_init_slab_obj(cachep, objp);
2506 /* constructor could break poison info */
2507 if (DEBUG == 0 && cachep->ctor) {
2508 kasan_unpoison_object_data(cachep, objp);
2510 kasan_poison_object_data(cachep, objp);
2514 set_free_obj(page, i, i);
2518 static void *slab_get_obj(struct kmem_cache *cachep, struct page *page)
2522 objp = index_to_obj(cachep, page, get_free_obj(page, page->active));
2528 static void slab_put_obj(struct kmem_cache *cachep,
2529 struct page *page, void *objp)
2531 unsigned int objnr = obj_to_index(cachep, page, objp);
2535 /* Verify double free bug */
2536 for (i = page->active; i < cachep->num; i++) {
2537 if (get_free_obj(page, i) == objnr) {
2538 pr_err("slab: double free detected in cache '%s', objp %px\n",
2539 cachep->name, objp);
2545 if (!page->freelist)
2546 page->freelist = objp + obj_offset(cachep);
2548 set_free_obj(page, page->active, objnr);
2552 * Map pages beginning at addr to the given cache and slab. This is required
2553 * for the slab allocator to be able to lookup the cache and slab of a
2554 * virtual address for kfree, ksize, and slab debugging.
2556 static void slab_map_pages(struct kmem_cache *cache, struct page *page,
2559 page->slab_cache = cache;
2560 page->freelist = freelist;
2564 * Grow (by 1) the number of slabs within a cache. This is called by
2565 * kmem_cache_alloc() when there are no active objs left in a cache.
2567 static struct page *cache_grow_begin(struct kmem_cache *cachep,
2568 gfp_t flags, int nodeid)
2574 struct kmem_cache_node *n;
2578 * Be lazy and only check for valid flags here, keeping it out of the
2579 * critical path in kmem_cache_alloc().
2581 if (unlikely(flags & GFP_SLAB_BUG_MASK)) {
2582 gfp_t invalid_mask = flags & GFP_SLAB_BUG_MASK;
2583 flags &= ~GFP_SLAB_BUG_MASK;
2584 pr_warn("Unexpected gfp: %#x (%pGg). Fixing up to gfp: %#x (%pGg). Fix your code!\n",
2585 invalid_mask, &invalid_mask, flags, &flags);
2588 WARN_ON_ONCE(cachep->ctor && (flags & __GFP_ZERO));
2589 local_flags = flags & (GFP_CONSTRAINT_MASK|GFP_RECLAIM_MASK);
2592 if (gfpflags_allow_blocking(local_flags))
2596 * Get mem for the objs. Attempt to allocate a physical page from
2599 page = kmem_getpages(cachep, local_flags, nodeid);
2603 page_node = page_to_nid(page);
2604 n = get_node(cachep, page_node);
2606 /* Get colour for the slab, and cal the next value. */
2608 if (n->colour_next >= cachep->colour)
2611 offset = n->colour_next;
2612 if (offset >= cachep->colour)
2615 offset *= cachep->colour_off;
2618 * Call kasan_poison_slab() before calling alloc_slabmgmt(), so
2619 * page_address() in the latter returns a non-tagged pointer,
2620 * as it should be for slab pages.
2622 kasan_poison_slab(page);
2624 /* Get slab management. */
2625 freelist = alloc_slabmgmt(cachep, page, offset,
2626 local_flags & ~GFP_CONSTRAINT_MASK, page_node);
2627 if (OFF_SLAB(cachep) && !freelist)
2630 slab_map_pages(cachep, page, freelist);
2632 cache_init_objs(cachep, page);
2634 if (gfpflags_allow_blocking(local_flags))
2635 local_irq_disable();
2640 kmem_freepages(cachep, page);
2642 if (gfpflags_allow_blocking(local_flags))
2643 local_irq_disable();
2647 static void cache_grow_end(struct kmem_cache *cachep, struct page *page)
2649 struct kmem_cache_node *n;
2657 INIT_LIST_HEAD(&page->slab_list);
2658 n = get_node(cachep, page_to_nid(page));
2660 spin_lock(&n->list_lock);
2662 if (!page->active) {
2663 list_add_tail(&page->slab_list, &n->slabs_free);
2666 fixup_slab_list(cachep, n, page, &list);
2668 STATS_INC_GROWN(cachep);
2669 n->free_objects += cachep->num - page->active;
2670 spin_unlock(&n->list_lock);
2672 fixup_objfreelist_debug(cachep, &list);
2678 * Perform extra freeing checks:
2679 * - detect bad pointers.
2680 * - POISON/RED_ZONE checking
2682 static void kfree_debugcheck(const void *objp)
2684 if (!virt_addr_valid(objp)) {
2685 pr_err("kfree_debugcheck: out of range ptr %lxh\n",
2686 (unsigned long)objp);
2691 static inline void verify_redzone_free(struct kmem_cache *cache, void *obj)
2693 unsigned long long redzone1, redzone2;
2695 redzone1 = *dbg_redzone1(cache, obj);
2696 redzone2 = *dbg_redzone2(cache, obj);
2701 if (redzone1 == RED_ACTIVE && redzone2 == RED_ACTIVE)
2704 if (redzone1 == RED_INACTIVE && redzone2 == RED_INACTIVE)
2705 slab_error(cache, "double free detected");
2707 slab_error(cache, "memory outside object was overwritten");
2709 pr_err("%px: redzone 1:0x%llx, redzone 2:0x%llx\n",
2710 obj, redzone1, redzone2);
2713 static void *cache_free_debugcheck(struct kmem_cache *cachep, void *objp,
2714 unsigned long caller)
2719 BUG_ON(virt_to_cache(objp) != cachep);
2721 objp -= obj_offset(cachep);
2722 kfree_debugcheck(objp);
2723 page = virt_to_head_page(objp);
2725 if (cachep->flags & SLAB_RED_ZONE) {
2726 verify_redzone_free(cachep, objp);
2727 *dbg_redzone1(cachep, objp) = RED_INACTIVE;
2728 *dbg_redzone2(cachep, objp) = RED_INACTIVE;
2730 if (cachep->flags & SLAB_STORE_USER)
2731 *dbg_userword(cachep, objp) = (void *)caller;
2733 objnr = obj_to_index(cachep, page, objp);
2735 BUG_ON(objnr >= cachep->num);
2736 BUG_ON(objp != index_to_obj(cachep, page, objnr));
2738 if (cachep->flags & SLAB_POISON) {
2739 poison_obj(cachep, objp, POISON_FREE);
2740 slab_kernel_map(cachep, objp, 0);
2746 #define kfree_debugcheck(x) do { } while(0)
2747 #define cache_free_debugcheck(x,objp,z) (objp)
2750 static inline void fixup_objfreelist_debug(struct kmem_cache *cachep,
2758 objp = next - obj_offset(cachep);
2759 next = *(void **)next;
2760 poison_obj(cachep, objp, POISON_FREE);
2765 static inline void fixup_slab_list(struct kmem_cache *cachep,
2766 struct kmem_cache_node *n, struct page *page,
2769 /* move slabp to correct slabp list: */
2770 list_del(&page->slab_list);
2771 if (page->active == cachep->num) {
2772 list_add(&page->slab_list, &n->slabs_full);
2773 if (OBJFREELIST_SLAB(cachep)) {
2775 /* Poisoning will be done without holding the lock */
2776 if (cachep->flags & SLAB_POISON) {
2777 void **objp = page->freelist;
2783 page->freelist = NULL;
2786 list_add(&page->slab_list, &n->slabs_partial);
2789 /* Try to find non-pfmemalloc slab if needed */
2790 static noinline struct page *get_valid_first_slab(struct kmem_cache_node *n,
2791 struct page *page, bool pfmemalloc)
2799 if (!PageSlabPfmemalloc(page))
2802 /* No need to keep pfmemalloc slab if we have enough free objects */
2803 if (n->free_objects > n->free_limit) {
2804 ClearPageSlabPfmemalloc(page);
2808 /* Move pfmemalloc slab to the end of list to speed up next search */
2809 list_del(&page->slab_list);
2810 if (!page->active) {
2811 list_add_tail(&page->slab_list, &n->slabs_free);
2814 list_add_tail(&page->slab_list, &n->slabs_partial);
2816 list_for_each_entry(page, &n->slabs_partial, slab_list) {
2817 if (!PageSlabPfmemalloc(page))
2821 n->free_touched = 1;
2822 list_for_each_entry(page, &n->slabs_free, slab_list) {
2823 if (!PageSlabPfmemalloc(page)) {
2832 static struct page *get_first_slab(struct kmem_cache_node *n, bool pfmemalloc)
2836 assert_spin_locked(&n->list_lock);
2837 page = list_first_entry_or_null(&n->slabs_partial, struct page,
2840 n->free_touched = 1;
2841 page = list_first_entry_or_null(&n->slabs_free, struct page,
2847 if (sk_memalloc_socks())
2848 page = get_valid_first_slab(n, page, pfmemalloc);
2853 static noinline void *cache_alloc_pfmemalloc(struct kmem_cache *cachep,
2854 struct kmem_cache_node *n, gfp_t flags)
2860 if (!gfp_pfmemalloc_allowed(flags))
2863 spin_lock(&n->list_lock);
2864 page = get_first_slab(n, true);
2866 spin_unlock(&n->list_lock);
2870 obj = slab_get_obj(cachep, page);
2873 fixup_slab_list(cachep, n, page, &list);
2875 spin_unlock(&n->list_lock);
2876 fixup_objfreelist_debug(cachep, &list);
2882 * Slab list should be fixed up by fixup_slab_list() for existing slab
2883 * or cache_grow_end() for new slab
2885 static __always_inline int alloc_block(struct kmem_cache *cachep,
2886 struct array_cache *ac, struct page *page, int batchcount)
2889 * There must be at least one object available for
2892 BUG_ON(page->active >= cachep->num);
2894 while (page->active < cachep->num && batchcount--) {
2895 STATS_INC_ALLOCED(cachep);
2896 STATS_INC_ACTIVE(cachep);
2897 STATS_SET_HIGH(cachep);
2899 ac->entry[ac->avail++] = slab_get_obj(cachep, page);
2905 static void *cache_alloc_refill(struct kmem_cache *cachep, gfp_t flags)
2908 struct kmem_cache_node *n;
2909 struct array_cache *ac, *shared;
2915 node = numa_mem_id();
2917 ac = cpu_cache_get(cachep);
2918 batchcount = ac->batchcount;
2919 if (!ac->touched && batchcount > BATCHREFILL_LIMIT) {
2921 * If there was little recent activity on this cache, then
2922 * perform only a partial refill. Otherwise we could generate
2925 batchcount = BATCHREFILL_LIMIT;
2927 n = get_node(cachep, node);
2929 BUG_ON(ac->avail > 0 || !n);
2930 shared = READ_ONCE(n->shared);
2931 if (!n->free_objects && (!shared || !shared->avail))
2934 spin_lock(&n->list_lock);
2935 shared = READ_ONCE(n->shared);
2937 /* See if we can refill from the shared array */
2938 if (shared && transfer_objects(ac, shared, batchcount)) {
2939 shared->touched = 1;
2943 while (batchcount > 0) {
2944 /* Get slab alloc is to come from. */
2945 page = get_first_slab(n, false);
2949 check_spinlock_acquired(cachep);
2951 batchcount = alloc_block(cachep, ac, page, batchcount);
2952 fixup_slab_list(cachep, n, page, &list);
2956 n->free_objects -= ac->avail;
2958 spin_unlock(&n->list_lock);
2959 fixup_objfreelist_debug(cachep, &list);
2962 if (unlikely(!ac->avail)) {
2963 /* Check if we can use obj in pfmemalloc slab */
2964 if (sk_memalloc_socks()) {
2965 void *obj = cache_alloc_pfmemalloc(cachep, n, flags);
2971 page = cache_grow_begin(cachep, gfp_exact_node(flags), node);
2974 * cache_grow_begin() can reenable interrupts,
2975 * then ac could change.
2977 ac = cpu_cache_get(cachep);
2978 if (!ac->avail && page)
2979 alloc_block(cachep, ac, page, batchcount);
2980 cache_grow_end(cachep, page);
2987 return ac->entry[--ac->avail];
2990 static inline void cache_alloc_debugcheck_before(struct kmem_cache *cachep,
2993 might_sleep_if(gfpflags_allow_blocking(flags));
2997 static void *cache_alloc_debugcheck_after(struct kmem_cache *cachep,
2998 gfp_t flags, void *objp, unsigned long caller)
3000 WARN_ON_ONCE(cachep->ctor && (flags & __GFP_ZERO));
3003 if (cachep->flags & SLAB_POISON) {
3004 check_poison_obj(cachep, objp);
3005 slab_kernel_map(cachep, objp, 1);
3006 poison_obj(cachep, objp, POISON_INUSE);
3008 if (cachep->flags & SLAB_STORE_USER)
3009 *dbg_userword(cachep, objp) = (void *)caller;
3011 if (cachep->flags & SLAB_RED_ZONE) {
3012 if (*dbg_redzone1(cachep, objp) != RED_INACTIVE ||
3013 *dbg_redzone2(cachep, objp) != RED_INACTIVE) {
3014 slab_error(cachep, "double free, or memory outside object was overwritten");
3015 pr_err("%px: redzone 1:0x%llx, redzone 2:0x%llx\n",
3016 objp, *dbg_redzone1(cachep, objp),
3017 *dbg_redzone2(cachep, objp));
3019 *dbg_redzone1(cachep, objp) = RED_ACTIVE;
3020 *dbg_redzone2(cachep, objp) = RED_ACTIVE;
3023 objp += obj_offset(cachep);
3024 if (cachep->ctor && cachep->flags & SLAB_POISON)
3026 if (ARCH_SLAB_MINALIGN &&
3027 ((unsigned long)objp & (ARCH_SLAB_MINALIGN-1))) {
3028 pr_err("0x%px: not aligned to ARCH_SLAB_MINALIGN=%d\n",
3029 objp, (int)ARCH_SLAB_MINALIGN);
3034 #define cache_alloc_debugcheck_after(a,b,objp,d) (objp)
3037 static inline void *____cache_alloc(struct kmem_cache *cachep, gfp_t flags)
3040 struct array_cache *ac;
3044 ac = cpu_cache_get(cachep);
3045 if (likely(ac->avail)) {
3047 objp = ac->entry[--ac->avail];
3049 STATS_INC_ALLOCHIT(cachep);
3053 STATS_INC_ALLOCMISS(cachep);
3054 objp = cache_alloc_refill(cachep, flags);
3056 * the 'ac' may be updated by cache_alloc_refill(),
3057 * and kmemleak_erase() requires its correct value.
3059 ac = cpu_cache_get(cachep);
3063 * To avoid a false negative, if an object that is in one of the
3064 * per-CPU caches is leaked, we need to make sure kmemleak doesn't
3065 * treat the array pointers as a reference to the object.
3068 kmemleak_erase(&ac->entry[ac->avail]);
3074 * Try allocating on another node if PFA_SPREAD_SLAB is a mempolicy is set.
3076 * If we are in_interrupt, then process context, including cpusets and
3077 * mempolicy, may not apply and should not be used for allocation policy.
3079 static void *alternate_node_alloc(struct kmem_cache *cachep, gfp_t flags)
3081 int nid_alloc, nid_here;
3083 if (in_interrupt() || (flags & __GFP_THISNODE))
3085 nid_alloc = nid_here = numa_mem_id();
3086 if (cpuset_do_slab_mem_spread() && (cachep->flags & SLAB_MEM_SPREAD))
3087 nid_alloc = cpuset_slab_spread_node();
3088 else if (current->mempolicy)
3089 nid_alloc = mempolicy_slab_node();
3090 if (nid_alloc != nid_here)
3091 return ____cache_alloc_node(cachep, flags, nid_alloc);
3096 * Fallback function if there was no memory available and no objects on a
3097 * certain node and fall back is permitted. First we scan all the
3098 * available node for available objects. If that fails then we
3099 * perform an allocation without specifying a node. This allows the page
3100 * allocator to do its reclaim / fallback magic. We then insert the
3101 * slab into the proper nodelist and then allocate from it.
3103 static void *fallback_alloc(struct kmem_cache *cache, gfp_t flags)
3105 struct zonelist *zonelist;
3108 enum zone_type high_zoneidx = gfp_zone(flags);
3112 unsigned int cpuset_mems_cookie;
3114 if (flags & __GFP_THISNODE)
3118 cpuset_mems_cookie = read_mems_allowed_begin();
3119 zonelist = node_zonelist(mempolicy_slab_node(), flags);
3123 * Look through allowed nodes for objects available
3124 * from existing per node queues.
3126 for_each_zone_zonelist(zone, z, zonelist, high_zoneidx) {
3127 nid = zone_to_nid(zone);
3129 if (cpuset_zone_allowed(zone, flags) &&
3130 get_node(cache, nid) &&
3131 get_node(cache, nid)->free_objects) {
3132 obj = ____cache_alloc_node(cache,
3133 gfp_exact_node(flags), nid);
3141 * This allocation will be performed within the constraints
3142 * of the current cpuset / memory policy requirements.
3143 * We may trigger various forms of reclaim on the allowed
3144 * set and go into memory reserves if necessary.
3146 page = cache_grow_begin(cache, flags, numa_mem_id());
3147 cache_grow_end(cache, page);
3149 nid = page_to_nid(page);
3150 obj = ____cache_alloc_node(cache,
3151 gfp_exact_node(flags), nid);
3154 * Another processor may allocate the objects in
3155 * the slab since we are not holding any locks.
3162 if (unlikely(!obj && read_mems_allowed_retry(cpuset_mems_cookie)))
3168 * A interface to enable slab creation on nodeid
3170 static void *____cache_alloc_node(struct kmem_cache *cachep, gfp_t flags,
3174 struct kmem_cache_node *n;
3178 VM_BUG_ON(nodeid < 0 || nodeid >= MAX_NUMNODES);
3179 n = get_node(cachep, nodeid);
3183 spin_lock(&n->list_lock);
3184 page = get_first_slab(n, false);
3188 check_spinlock_acquired_node(cachep, nodeid);
3190 STATS_INC_NODEALLOCS(cachep);
3191 STATS_INC_ACTIVE(cachep);
3192 STATS_SET_HIGH(cachep);
3194 BUG_ON(page->active == cachep->num);
3196 obj = slab_get_obj(cachep, page);
3199 fixup_slab_list(cachep, n, page, &list);
3201 spin_unlock(&n->list_lock);
3202 fixup_objfreelist_debug(cachep, &list);
3206 spin_unlock(&n->list_lock);
3207 page = cache_grow_begin(cachep, gfp_exact_node(flags), nodeid);
3209 /* This slab isn't counted yet so don't update free_objects */
3210 obj = slab_get_obj(cachep, page);
3212 cache_grow_end(cachep, page);
3214 return obj ? obj : fallback_alloc(cachep, flags);
3217 static __always_inline void *
3218 slab_alloc_node(struct kmem_cache *cachep, gfp_t flags, int nodeid,
3219 unsigned long caller)
3221 unsigned long save_flags;
3223 int slab_node = numa_mem_id();
3225 flags &= gfp_allowed_mask;
3226 cachep = slab_pre_alloc_hook(cachep, flags);
3227 if (unlikely(!cachep))
3230 cache_alloc_debugcheck_before(cachep, flags);
3231 local_irq_save(save_flags);
3233 if (nodeid == NUMA_NO_NODE)
3236 if (unlikely(!get_node(cachep, nodeid))) {
3237 /* Node not bootstrapped yet */
3238 ptr = fallback_alloc(cachep, flags);
3242 if (nodeid == slab_node) {
3244 * Use the locally cached objects if possible.
3245 * However ____cache_alloc does not allow fallback
3246 * to other nodes. It may fail while we still have
3247 * objects on other nodes available.
3249 ptr = ____cache_alloc(cachep, flags);
3253 /* ___cache_alloc_node can fall back to other nodes */
3254 ptr = ____cache_alloc_node(cachep, flags, nodeid);
3256 local_irq_restore(save_flags);
3257 ptr = cache_alloc_debugcheck_after(cachep, flags, ptr, caller);
3259 if (unlikely(slab_want_init_on_alloc(flags, cachep)) && ptr)
3260 memset(ptr, 0, cachep->object_size);
3262 slab_post_alloc_hook(cachep, flags, 1, &ptr);
3266 static __always_inline void *
3267 __do_cache_alloc(struct kmem_cache *cache, gfp_t flags)
3271 if (current->mempolicy || cpuset_do_slab_mem_spread()) {
3272 objp = alternate_node_alloc(cache, flags);
3276 objp = ____cache_alloc(cache, flags);
3279 * We may just have run out of memory on the local node.
3280 * ____cache_alloc_node() knows how to locate memory on other nodes
3283 objp = ____cache_alloc_node(cache, flags, numa_mem_id());
3290 static __always_inline void *
3291 __do_cache_alloc(struct kmem_cache *cachep, gfp_t flags)
3293 return ____cache_alloc(cachep, flags);
3296 #endif /* CONFIG_NUMA */
3298 static __always_inline void *
3299 slab_alloc(struct kmem_cache *cachep, gfp_t flags, unsigned long caller)
3301 unsigned long save_flags;
3304 flags &= gfp_allowed_mask;
3305 cachep = slab_pre_alloc_hook(cachep, flags);
3306 if (unlikely(!cachep))
3309 cache_alloc_debugcheck_before(cachep, flags);
3310 local_irq_save(save_flags);
3311 objp = __do_cache_alloc(cachep, flags);
3312 local_irq_restore(save_flags);
3313 objp = cache_alloc_debugcheck_after(cachep, flags, objp, caller);
3316 if (unlikely(slab_want_init_on_alloc(flags, cachep)) && objp)
3317 memset(objp, 0, cachep->object_size);
3319 slab_post_alloc_hook(cachep, flags, 1, &objp);
3324 * Caller needs to acquire correct kmem_cache_node's list_lock
3325 * @list: List of detached free slabs should be freed by caller
3327 static void free_block(struct kmem_cache *cachep, void **objpp,
3328 int nr_objects, int node, struct list_head *list)
3331 struct kmem_cache_node *n = get_node(cachep, node);
3334 n->free_objects += nr_objects;
3336 for (i = 0; i < nr_objects; i++) {
3342 page = virt_to_head_page(objp);
3343 list_del(&page->slab_list);
3344 check_spinlock_acquired_node(cachep, node);
3345 slab_put_obj(cachep, page, objp);
3346 STATS_DEC_ACTIVE(cachep);
3348 /* fixup slab chains */
3349 if (page->active == 0) {
3350 list_add(&page->slab_list, &n->slabs_free);
3353 /* Unconditionally move a slab to the end of the
3354 * partial list on free - maximum time for the
3355 * other objects to be freed, too.
3357 list_add_tail(&page->slab_list, &n->slabs_partial);
3361 while (n->free_objects > n->free_limit && !list_empty(&n->slabs_free)) {
3362 n->free_objects -= cachep->num;
3364 page = list_last_entry(&n->slabs_free, struct page, slab_list);
3365 list_move(&page->slab_list, list);
3371 static void cache_flusharray(struct kmem_cache *cachep, struct array_cache *ac)
3374 struct kmem_cache_node *n;
3375 int node = numa_mem_id();
3378 batchcount = ac->batchcount;
3381 n = get_node(cachep, node);
3382 spin_lock(&n->list_lock);
3384 struct array_cache *shared_array = n->shared;
3385 int max = shared_array->limit - shared_array->avail;
3387 if (batchcount > max)
3389 memcpy(&(shared_array->entry[shared_array->avail]),
3390 ac->entry, sizeof(void *) * batchcount);
3391 shared_array->avail += batchcount;
3396 free_block(cachep, ac->entry, batchcount, node, &list);
3403 list_for_each_entry(page, &n->slabs_free, slab_list) {
3404 BUG_ON(page->active);
3408 STATS_SET_FREEABLE(cachep, i);
3411 spin_unlock(&n->list_lock);
3412 slabs_destroy(cachep, &list);
3413 ac->avail -= batchcount;
3414 memmove(ac->entry, &(ac->entry[batchcount]), sizeof(void *)*ac->avail);
3418 * Release an obj back to its cache. If the obj has a constructed state, it must
3419 * be in this state _before_ it is released. Called with disabled ints.
3421 static __always_inline void __cache_free(struct kmem_cache *cachep, void *objp,
3422 unsigned long caller)
3424 /* Put the object into the quarantine, don't touch it for now. */
3425 if (kasan_slab_free(cachep, objp, _RET_IP_))
3428 ___cache_free(cachep, objp, caller);
3431 void ___cache_free(struct kmem_cache *cachep, void *objp,
3432 unsigned long caller)
3434 struct array_cache *ac = cpu_cache_get(cachep);
3437 if (unlikely(slab_want_init_on_free(cachep)))
3438 memset(objp, 0, cachep->object_size);
3439 kmemleak_free_recursive(objp, cachep->flags);
3440 objp = cache_free_debugcheck(cachep, objp, caller);
3443 * Skip calling cache_free_alien() when the platform is not numa.
3444 * This will avoid cache misses that happen while accessing slabp (which
3445 * is per page memory reference) to get nodeid. Instead use a global
3446 * variable to skip the call, which is mostly likely to be present in
3449 if (nr_online_nodes > 1 && cache_free_alien(cachep, objp))
3452 if (ac->avail < ac->limit) {
3453 STATS_INC_FREEHIT(cachep);
3455 STATS_INC_FREEMISS(cachep);
3456 cache_flusharray(cachep, ac);
3459 if (sk_memalloc_socks()) {
3460 struct page *page = virt_to_head_page(objp);
3462 if (unlikely(PageSlabPfmemalloc(page))) {
3463 cache_free_pfmemalloc(cachep, page, objp);
3468 ac->entry[ac->avail++] = objp;
3472 * kmem_cache_alloc - Allocate an object
3473 * @cachep: The cache to allocate from.
3474 * @flags: See kmalloc().
3476 * Allocate an object from this cache. The flags are only relevant
3477 * if the cache has no available objects.
3479 * Return: pointer to the new object or %NULL in case of error
3481 void *kmem_cache_alloc(struct kmem_cache *cachep, gfp_t flags)
3483 void *ret = slab_alloc(cachep, flags, _RET_IP_);
3485 trace_kmem_cache_alloc(_RET_IP_, ret,
3486 cachep->object_size, cachep->size, flags);
3490 EXPORT_SYMBOL(kmem_cache_alloc);
3492 static __always_inline void
3493 cache_alloc_debugcheck_after_bulk(struct kmem_cache *s, gfp_t flags,
3494 size_t size, void **p, unsigned long caller)
3498 for (i = 0; i < size; i++)
3499 p[i] = cache_alloc_debugcheck_after(s, flags, p[i], caller);
3502 int kmem_cache_alloc_bulk(struct kmem_cache *s, gfp_t flags, size_t size,
3507 s = slab_pre_alloc_hook(s, flags);
3511 cache_alloc_debugcheck_before(s, flags);
3513 local_irq_disable();
3514 for (i = 0; i < size; i++) {
3515 void *objp = __do_cache_alloc(s, flags);
3517 if (unlikely(!objp))
3523 cache_alloc_debugcheck_after_bulk(s, flags, size, p, _RET_IP_);
3525 /* Clear memory outside IRQ disabled section */
3526 if (unlikely(slab_want_init_on_alloc(flags, s)))
3527 for (i = 0; i < size; i++)
3528 memset(p[i], 0, s->object_size);
3530 slab_post_alloc_hook(s, flags, size, p);
3531 /* FIXME: Trace call missing. Christoph would like a bulk variant */
3535 cache_alloc_debugcheck_after_bulk(s, flags, i, p, _RET_IP_);
3536 slab_post_alloc_hook(s, flags, i, p);
3537 __kmem_cache_free_bulk(s, i, p);
3540 EXPORT_SYMBOL(kmem_cache_alloc_bulk);
3542 #ifdef CONFIG_TRACING
3544 kmem_cache_alloc_trace(struct kmem_cache *cachep, gfp_t flags, size_t size)
3548 ret = slab_alloc(cachep, flags, _RET_IP_);
3550 ret = kasan_kmalloc(cachep, ret, size, flags);
3551 trace_kmalloc(_RET_IP_, ret,
3552 size, cachep->size, flags);
3555 EXPORT_SYMBOL(kmem_cache_alloc_trace);
3560 * kmem_cache_alloc_node - Allocate an object on the specified node
3561 * @cachep: The cache to allocate from.
3562 * @flags: See kmalloc().
3563 * @nodeid: node number of the target node.
3565 * Identical to kmem_cache_alloc but it will allocate memory on the given
3566 * node, which can improve the performance for cpu bound structures.
3568 * Fallback to other node is possible if __GFP_THISNODE is not set.
3570 * Return: pointer to the new object or %NULL in case of error
3572 void *kmem_cache_alloc_node(struct kmem_cache *cachep, gfp_t flags, int nodeid)
3574 void *ret = slab_alloc_node(cachep, flags, nodeid, _RET_IP_);
3576 trace_kmem_cache_alloc_node(_RET_IP_, ret,
3577 cachep->object_size, cachep->size,
3582 EXPORT_SYMBOL(kmem_cache_alloc_node);
3584 #ifdef CONFIG_TRACING
3585 void *kmem_cache_alloc_node_trace(struct kmem_cache *cachep,
3592 ret = slab_alloc_node(cachep, flags, nodeid, _RET_IP_);
3594 ret = kasan_kmalloc(cachep, ret, size, flags);
3595 trace_kmalloc_node(_RET_IP_, ret,
3600 EXPORT_SYMBOL(kmem_cache_alloc_node_trace);
3603 static __always_inline void *
3604 __do_kmalloc_node(size_t size, gfp_t flags, int node, unsigned long caller)
3606 struct kmem_cache *cachep;
3609 if (unlikely(size > KMALLOC_MAX_CACHE_SIZE))
3611 cachep = kmalloc_slab(size, flags);
3612 if (unlikely(ZERO_OR_NULL_PTR(cachep)))
3614 ret = kmem_cache_alloc_node_trace(cachep, flags, node, size);
3615 ret = kasan_kmalloc(cachep, ret, size, flags);
3620 void *__kmalloc_node(size_t size, gfp_t flags, int node)
3622 return __do_kmalloc_node(size, flags, node, _RET_IP_);
3624 EXPORT_SYMBOL(__kmalloc_node);
3626 void *__kmalloc_node_track_caller(size_t size, gfp_t flags,
3627 int node, unsigned long caller)
3629 return __do_kmalloc_node(size, flags, node, caller);
3631 EXPORT_SYMBOL(__kmalloc_node_track_caller);
3632 #endif /* CONFIG_NUMA */
3635 * __do_kmalloc - allocate memory
3636 * @size: how many bytes of memory are required.
3637 * @flags: the type of memory to allocate (see kmalloc).
3638 * @caller: function caller for debug tracking of the caller
3640 * Return: pointer to the allocated memory or %NULL in case of error
3642 static __always_inline void *__do_kmalloc(size_t size, gfp_t flags,
3643 unsigned long caller)
3645 struct kmem_cache *cachep;
3648 if (unlikely(size > KMALLOC_MAX_CACHE_SIZE))
3650 cachep = kmalloc_slab(size, flags);
3651 if (unlikely(ZERO_OR_NULL_PTR(cachep)))
3653 ret = slab_alloc(cachep, flags, caller);
3655 ret = kasan_kmalloc(cachep, ret, size, flags);
3656 trace_kmalloc(caller, ret,
3657 size, cachep->size, flags);
3662 void *__kmalloc(size_t size, gfp_t flags)
3664 return __do_kmalloc(size, flags, _RET_IP_);
3666 EXPORT_SYMBOL(__kmalloc);
3668 void *__kmalloc_track_caller(size_t size, gfp_t flags, unsigned long caller)
3670 return __do_kmalloc(size, flags, caller);
3672 EXPORT_SYMBOL(__kmalloc_track_caller);
3675 * kmem_cache_free - Deallocate an object
3676 * @cachep: The cache the allocation was from.
3677 * @objp: The previously allocated object.
3679 * Free an object which was previously allocated from this
3682 void kmem_cache_free(struct kmem_cache *cachep, void *objp)
3684 unsigned long flags;
3685 cachep = cache_from_obj(cachep, objp);
3689 local_irq_save(flags);
3690 debug_check_no_locks_freed(objp, cachep->object_size);
3691 if (!(cachep->flags & SLAB_DEBUG_OBJECTS))
3692 debug_check_no_obj_freed(objp, cachep->object_size);
3693 __cache_free(cachep, objp, _RET_IP_);
3694 local_irq_restore(flags);
3696 trace_kmem_cache_free(_RET_IP_, objp);
3698 EXPORT_SYMBOL(kmem_cache_free);
3700 void kmem_cache_free_bulk(struct kmem_cache *orig_s, size_t size, void **p)
3702 struct kmem_cache *s;
3705 local_irq_disable();
3706 for (i = 0; i < size; i++) {
3709 if (!orig_s) /* called via kfree_bulk */
3710 s = virt_to_cache(objp);
3712 s = cache_from_obj(orig_s, objp);
3716 debug_check_no_locks_freed(objp, s->object_size);
3717 if (!(s->flags & SLAB_DEBUG_OBJECTS))
3718 debug_check_no_obj_freed(objp, s->object_size);
3720 __cache_free(s, objp, _RET_IP_);
3724 /* FIXME: add tracing */
3726 EXPORT_SYMBOL(kmem_cache_free_bulk);
3729 * kfree - free previously allocated memory
3730 * @objp: pointer returned by kmalloc.
3732 * If @objp is NULL, no operation is performed.
3734 * Don't free memory not originally allocated by kmalloc()
3735 * or you will run into trouble.
3737 void kfree(const void *objp)
3739 struct kmem_cache *c;
3740 unsigned long flags;
3742 trace_kfree(_RET_IP_, objp);
3744 if (unlikely(ZERO_OR_NULL_PTR(objp)))
3746 local_irq_save(flags);
3747 kfree_debugcheck(objp);
3748 c = virt_to_cache(objp);
3750 local_irq_restore(flags);
3753 debug_check_no_locks_freed(objp, c->object_size);
3755 debug_check_no_obj_freed(objp, c->object_size);
3756 __cache_free(c, (void *)objp, _RET_IP_);
3757 local_irq_restore(flags);
3759 EXPORT_SYMBOL(kfree);
3762 * This initializes kmem_cache_node or resizes various caches for all nodes.
3764 static int setup_kmem_cache_nodes(struct kmem_cache *cachep, gfp_t gfp)
3768 struct kmem_cache_node *n;
3770 for_each_online_node(node) {
3771 ret = setup_kmem_cache_node(cachep, node, gfp, true);
3780 if (!cachep->list.next) {
3781 /* Cache is not active yet. Roll back what we did */
3784 n = get_node(cachep, node);
3787 free_alien_cache(n->alien);
3789 cachep->node[node] = NULL;
3797 /* Always called with the slab_mutex held */
3798 static int __do_tune_cpucache(struct kmem_cache *cachep, int limit,
3799 int batchcount, int shared, gfp_t gfp)
3801 struct array_cache __percpu *cpu_cache, *prev;
3804 cpu_cache = alloc_kmem_cache_cpus(cachep, limit, batchcount);
3808 prev = cachep->cpu_cache;
3809 cachep->cpu_cache = cpu_cache;
3811 * Without a previous cpu_cache there's no need to synchronize remote
3812 * cpus, so skip the IPIs.
3815 kick_all_cpus_sync();
3818 cachep->batchcount = batchcount;
3819 cachep->limit = limit;
3820 cachep->shared = shared;
3825 for_each_online_cpu(cpu) {
3828 struct kmem_cache_node *n;
3829 struct array_cache *ac = per_cpu_ptr(prev, cpu);
3831 node = cpu_to_mem(cpu);
3832 n = get_node(cachep, node);
3833 spin_lock_irq(&n->list_lock);
3834 free_block(cachep, ac->entry, ac->avail, node, &list);
3835 spin_unlock_irq(&n->list_lock);
3836 slabs_destroy(cachep, &list);
3841 return setup_kmem_cache_nodes(cachep, gfp);
3844 static int do_tune_cpucache(struct kmem_cache *cachep, int limit,
3845 int batchcount, int shared, gfp_t gfp)
3848 struct kmem_cache *c;
3850 ret = __do_tune_cpucache(cachep, limit, batchcount, shared, gfp);
3852 if (slab_state < FULL)
3855 if ((ret < 0) || !is_root_cache(cachep))
3858 lockdep_assert_held(&slab_mutex);
3859 for_each_memcg_cache(c, cachep) {
3860 /* return value determined by the root cache only */
3861 __do_tune_cpucache(c, limit, batchcount, shared, gfp);
3867 /* Called with slab_mutex held always */
3868 static int enable_cpucache(struct kmem_cache *cachep, gfp_t gfp)
3875 err = cache_random_seq_create(cachep, cachep->num, gfp);
3879 if (!is_root_cache(cachep)) {
3880 struct kmem_cache *root = memcg_root_cache(cachep);
3881 limit = root->limit;
3882 shared = root->shared;
3883 batchcount = root->batchcount;
3886 if (limit && shared && batchcount)
3889 * The head array serves three purposes:
3890 * - create a LIFO ordering, i.e. return objects that are cache-warm
3891 * - reduce the number of spinlock operations.
3892 * - reduce the number of linked list operations on the slab and
3893 * bufctl chains: array operations are cheaper.
3894 * The numbers are guessed, we should auto-tune as described by
3897 if (cachep->size > 131072)
3899 else if (cachep->size > PAGE_SIZE)
3901 else if (cachep->size > 1024)
3903 else if (cachep->size > 256)
3909 * CPU bound tasks (e.g. network routing) can exhibit cpu bound
3910 * allocation behaviour: Most allocs on one cpu, most free operations
3911 * on another cpu. For these cases, an efficient object passing between
3912 * cpus is necessary. This is provided by a shared array. The array
3913 * replaces Bonwick's magazine layer.
3914 * On uniprocessor, it's functionally equivalent (but less efficient)
3915 * to a larger limit. Thus disabled by default.
3918 if (cachep->size <= PAGE_SIZE && num_possible_cpus() > 1)
3923 * With debugging enabled, large batchcount lead to excessively long
3924 * periods with disabled local interrupts. Limit the batchcount
3929 batchcount = (limit + 1) / 2;
3931 err = do_tune_cpucache(cachep, limit, batchcount, shared, gfp);
3934 pr_err("enable_cpucache failed for %s, error %d\n",
3935 cachep->name, -err);
3940 * Drain an array if it contains any elements taking the node lock only if
3941 * necessary. Note that the node listlock also protects the array_cache
3942 * if drain_array() is used on the shared array.
3944 static void drain_array(struct kmem_cache *cachep, struct kmem_cache_node *n,
3945 struct array_cache *ac, int node)
3949 /* ac from n->shared can be freed if we don't hold the slab_mutex. */
3950 check_mutex_acquired();
3952 if (!ac || !ac->avail)
3960 spin_lock_irq(&n->list_lock);
3961 drain_array_locked(cachep, ac, node, false, &list);
3962 spin_unlock_irq(&n->list_lock);
3964 slabs_destroy(cachep, &list);
3968 * cache_reap - Reclaim memory from caches.
3969 * @w: work descriptor
3971 * Called from workqueue/eventd every few seconds.
3973 * - clear the per-cpu caches for this CPU.
3974 * - return freeable pages to the main free memory pool.
3976 * If we cannot acquire the cache chain mutex then just give up - we'll try
3977 * again on the next iteration.
3979 static void cache_reap(struct work_struct *w)
3981 struct kmem_cache *searchp;
3982 struct kmem_cache_node *n;
3983 int node = numa_mem_id();
3984 struct delayed_work *work = to_delayed_work(w);
3986 if (!mutex_trylock(&slab_mutex))
3987 /* Give up. Setup the next iteration. */
3990 list_for_each_entry(searchp, &slab_caches, list) {
3994 * We only take the node lock if absolutely necessary and we
3995 * have established with reasonable certainty that
3996 * we can do some work if the lock was obtained.
3998 n = get_node(searchp, node);
4000 reap_alien(searchp, n);
4002 drain_array(searchp, n, cpu_cache_get(searchp), node);
4005 * These are racy checks but it does not matter
4006 * if we skip one check or scan twice.
4008 if (time_after(n->next_reap, jiffies))
4011 n->next_reap = jiffies + REAPTIMEOUT_NODE;
4013 drain_array(searchp, n, n->shared, node);
4015 if (n->free_touched)
4016 n->free_touched = 0;
4020 freed = drain_freelist(searchp, n, (n->free_limit +
4021 5 * searchp->num - 1) / (5 * searchp->num));
4022 STATS_ADD_REAPED(searchp, freed);
4028 mutex_unlock(&slab_mutex);
4031 /* Set up the next iteration */
4032 schedule_delayed_work_on(smp_processor_id(), work,
4033 round_jiffies_relative(REAPTIMEOUT_AC));
4036 void get_slabinfo(struct kmem_cache *cachep, struct slabinfo *sinfo)
4038 unsigned long active_objs, num_objs, active_slabs;
4039 unsigned long total_slabs = 0, free_objs = 0, shared_avail = 0;
4040 unsigned long free_slabs = 0;
4042 struct kmem_cache_node *n;
4044 for_each_kmem_cache_node(cachep, node, n) {
4046 spin_lock_irq(&n->list_lock);
4048 total_slabs += n->total_slabs;
4049 free_slabs += n->free_slabs;
4050 free_objs += n->free_objects;
4053 shared_avail += n->shared->avail;
4055 spin_unlock_irq(&n->list_lock);
4057 num_objs = total_slabs * cachep->num;
4058 active_slabs = total_slabs - free_slabs;
4059 active_objs = num_objs - free_objs;
4061 sinfo->active_objs = active_objs;
4062 sinfo->num_objs = num_objs;
4063 sinfo->active_slabs = active_slabs;
4064 sinfo->num_slabs = total_slabs;
4065 sinfo->shared_avail = shared_avail;
4066 sinfo->limit = cachep->limit;
4067 sinfo->batchcount = cachep->batchcount;
4068 sinfo->shared = cachep->shared;
4069 sinfo->objects_per_slab = cachep->num;
4070 sinfo->cache_order = cachep->gfporder;
4073 void slabinfo_show_stats(struct seq_file *m, struct kmem_cache *cachep)
4077 unsigned long high = cachep->high_mark;
4078 unsigned long allocs = cachep->num_allocations;
4079 unsigned long grown = cachep->grown;
4080 unsigned long reaped = cachep->reaped;
4081 unsigned long errors = cachep->errors;
4082 unsigned long max_freeable = cachep->max_freeable;
4083 unsigned long node_allocs = cachep->node_allocs;
4084 unsigned long node_frees = cachep->node_frees;
4085 unsigned long overflows = cachep->node_overflow;
4087 seq_printf(m, " : globalstat %7lu %6lu %5lu %4lu %4lu %4lu %4lu %4lu %4lu",
4088 allocs, high, grown,
4089 reaped, errors, max_freeable, node_allocs,
4090 node_frees, overflows);
4094 unsigned long allochit = atomic_read(&cachep->allochit);
4095 unsigned long allocmiss = atomic_read(&cachep->allocmiss);
4096 unsigned long freehit = atomic_read(&cachep->freehit);
4097 unsigned long freemiss = atomic_read(&cachep->freemiss);
4099 seq_printf(m, " : cpustat %6lu %6lu %6lu %6lu",
4100 allochit, allocmiss, freehit, freemiss);
4105 #define MAX_SLABINFO_WRITE 128
4107 * slabinfo_write - Tuning for the slab allocator
4109 * @buffer: user buffer
4110 * @count: data length
4113 * Return: %0 on success, negative error code otherwise.
4115 ssize_t slabinfo_write(struct file *file, const char __user *buffer,
4116 size_t count, loff_t *ppos)
4118 char kbuf[MAX_SLABINFO_WRITE + 1], *tmp;
4119 int limit, batchcount, shared, res;
4120 struct kmem_cache *cachep;
4122 if (count > MAX_SLABINFO_WRITE)
4124 if (copy_from_user(&kbuf, buffer, count))
4126 kbuf[MAX_SLABINFO_WRITE] = '\0';
4128 tmp = strchr(kbuf, ' ');
4133 if (sscanf(tmp, " %d %d %d", &limit, &batchcount, &shared) != 3)
4136 /* Find the cache in the chain of caches. */
4137 mutex_lock(&slab_mutex);
4139 list_for_each_entry(cachep, &slab_caches, list) {
4140 if (!strcmp(cachep->name, kbuf)) {
4141 if (limit < 1 || batchcount < 1 ||
4142 batchcount > limit || shared < 0) {
4145 res = do_tune_cpucache(cachep, limit,
4152 mutex_unlock(&slab_mutex);
4158 #ifdef CONFIG_HARDENED_USERCOPY
4160 * Rejects incorrectly sized objects and objects that are to be copied
4161 * to/from userspace but do not fall entirely within the containing slab
4162 * cache's usercopy region.
4164 * Returns NULL if check passes, otherwise const char * to name of cache
4165 * to indicate an error.
4167 void __check_heap_object(const void *ptr, unsigned long n, struct page *page,
4170 struct kmem_cache *cachep;
4172 unsigned long offset;
4174 ptr = kasan_reset_tag(ptr);
4176 /* Find and validate object. */
4177 cachep = page->slab_cache;
4178 objnr = obj_to_index(cachep, page, (void *)ptr);
4179 BUG_ON(objnr >= cachep->num);
4181 /* Find offset within object. */
4182 offset = ptr - index_to_obj(cachep, page, objnr) - obj_offset(cachep);
4184 /* Allow address range falling entirely within usercopy region. */
4185 if (offset >= cachep->useroffset &&
4186 offset - cachep->useroffset <= cachep->usersize &&
4187 n <= cachep->useroffset - offset + cachep->usersize)
4191 * If the copy is still within the allocated object, produce
4192 * a warning instead of rejecting the copy. This is intended
4193 * to be a temporary method to find any missing usercopy
4196 if (usercopy_fallback &&
4197 offset <= cachep->object_size &&
4198 n <= cachep->object_size - offset) {
4199 usercopy_warn("SLAB object", cachep->name, to_user, offset, n);
4203 usercopy_abort("SLAB object", cachep->name, to_user, offset, n);
4205 #endif /* CONFIG_HARDENED_USERCOPY */
4208 * __ksize -- Uninstrumented ksize.
4209 * @objp: pointer to the object
4211 * Unlike ksize(), __ksize() is uninstrumented, and does not provide the same
4212 * safety checks as ksize() with KASAN instrumentation enabled.
4214 * Return: size of the actual memory used by @objp in bytes
4216 size_t __ksize(const void *objp)
4218 struct kmem_cache *c;
4222 if (unlikely(objp == ZERO_SIZE_PTR))
4225 c = virt_to_cache(objp);
4226 size = c ? c->object_size : 0;
4230 EXPORT_SYMBOL(__ksize);