1 // SPDX-License-Identifier: GPL-2.0
3 * SLUB: A slab allocator that limits cache line use instead of queuing
4 * objects in per cpu and per node lists.
6 * The allocator synchronizes using per slab locks or atomic operations
7 * and only uses a centralized lock to manage a pool of partial slabs.
9 * (C) 2007 SGI, Christoph Lameter
10 * (C) 2011 Linux Foundation, Christoph Lameter
14 #include <linux/swap.h> /* struct reclaim_state */
15 #include <linux/module.h>
16 #include <linux/bit_spinlock.h>
17 #include <linux/interrupt.h>
18 #include <linux/swab.h>
19 #include <linux/bitops.h>
20 #include <linux/slab.h>
22 #include <linux/proc_fs.h>
23 #include <linux/seq_file.h>
24 #include <linux/kasan.h>
25 #include <linux/kmsan.h>
26 #include <linux/cpu.h>
27 #include <linux/cpuset.h>
28 #include <linux/mempolicy.h>
29 #include <linux/ctype.h>
30 #include <linux/stackdepot.h>
31 #include <linux/debugobjects.h>
32 #include <linux/kallsyms.h>
33 #include <linux/kfence.h>
34 #include <linux/memory.h>
35 #include <linux/math64.h>
36 #include <linux/fault-inject.h>
37 #include <linux/stacktrace.h>
38 #include <linux/prefetch.h>
39 #include <linux/memcontrol.h>
40 #include <linux/random.h>
41 #include <kunit/test.h>
42 #include <kunit/test-bug.h>
43 #include <linux/sort.h>
45 #include <linux/debugfs.h>
46 #include <trace/events/kmem.h>
52 * 1. slab_mutex (Global Mutex)
53 * 2. node->list_lock (Spinlock)
54 * 3. kmem_cache->cpu_slab->lock (Local lock)
55 * 4. slab_lock(slab) (Only on some arches)
56 * 5. object_map_lock (Only for debugging)
60 * The role of the slab_mutex is to protect the list of all the slabs
61 * and to synchronize major metadata changes to slab cache structures.
62 * Also synchronizes memory hotplug callbacks.
66 * The slab_lock is a wrapper around the page lock, thus it is a bit
69 * The slab_lock is only used on arches that do not have the ability
70 * to do a cmpxchg_double. It only protects:
72 * A. slab->freelist -> List of free objects in a slab
73 * B. slab->inuse -> Number of objects in use
74 * C. slab->objects -> Number of objects in slab
75 * D. slab->frozen -> frozen state
79 * If a slab is frozen then it is exempt from list management. It is not
80 * on any list except per cpu partial list. The processor that froze the
81 * slab is the one who can perform list operations on the slab. Other
82 * processors may put objects onto the freelist but the processor that
83 * froze the slab is the only one that can retrieve the objects from the
88 * The list_lock protects the partial and full list on each node and
89 * the partial slab counter. If taken then no new slabs may be added or
90 * removed from the lists nor make the number of partial slabs be modified.
91 * (Note that the total number of slabs is an atomic value that may be
92 * modified without taking the list lock).
94 * The list_lock is a centralized lock and thus we avoid taking it as
95 * much as possible. As long as SLUB does not have to handle partial
96 * slabs, operations can continue without any centralized lock. F.e.
97 * allocating a long series of objects that fill up slabs does not require
100 * For debug caches, all allocations are forced to go through a list_lock
101 * protected region to serialize against concurrent validation.
103 * cpu_slab->lock local lock
105 * This locks protect slowpath manipulation of all kmem_cache_cpu fields
106 * except the stat counters. This is a percpu structure manipulated only by
107 * the local cpu, so the lock protects against being preempted or interrupted
108 * by an irq. Fast path operations rely on lockless operations instead.
110 * On PREEMPT_RT, the local lock neither disables interrupts nor preemption
111 * which means the lockless fastpath cannot be used as it might interfere with
112 * an in-progress slow path operations. In this case the local lock is always
113 * taken but it still utilizes the freelist for the common operations.
117 * The fast path allocation (slab_alloc_node()) and freeing (do_slab_free())
118 * are fully lockless when satisfied from the percpu slab (and when
119 * cmpxchg_double is possible to use, otherwise slab_lock is taken).
120 * They also don't disable preemption or migration or irqs. They rely on
121 * the transaction id (tid) field to detect being preempted or moved to
124 * irq, preemption, migration considerations
126 * Interrupts are disabled as part of list_lock or local_lock operations, or
127 * around the slab_lock operation, in order to make the slab allocator safe
128 * to use in the context of an irq.
130 * In addition, preemption (or migration on PREEMPT_RT) is disabled in the
131 * allocation slowpath, bulk allocation, and put_cpu_partial(), so that the
132 * local cpu doesn't change in the process and e.g. the kmem_cache_cpu pointer
133 * doesn't have to be revalidated in each section protected by the local lock.
135 * SLUB assigns one slab for allocation to each processor.
136 * Allocations only occur from these slabs called cpu slabs.
138 * Slabs with free elements are kept on a partial list and during regular
139 * operations no list for full slabs is used. If an object in a full slab is
140 * freed then the slab will show up again on the partial lists.
141 * We track full slabs for debugging purposes though because otherwise we
142 * cannot scan all objects.
144 * Slabs are freed when they become empty. Teardown and setup is
145 * minimal so we rely on the page allocators per cpu caches for
146 * fast frees and allocs.
148 * slab->frozen The slab is frozen and exempt from list processing.
149 * This means that the slab is dedicated to a purpose
150 * such as satisfying allocations for a specific
151 * processor. Objects may be freed in the slab while
152 * it is frozen but slab_free will then skip the usual
153 * list operations. It is up to the processor holding
154 * the slab to integrate the slab into the slab lists
155 * when the slab is no longer needed.
157 * One use of this flag is to mark slabs that are
158 * used for allocations. Then such a slab becomes a cpu
159 * slab. The cpu slab may be equipped with an additional
160 * freelist that allows lockless access to
161 * free objects in addition to the regular freelist
162 * that requires the slab lock.
164 * SLAB_DEBUG_FLAGS Slab requires special handling due to debug
165 * options set. This moves slab handling out of
166 * the fast path and disables lockless freelists.
170 * We could simply use migrate_disable()/enable() but as long as it's a
171 * function call even on !PREEMPT_RT, use inline preempt_disable() there.
173 #ifndef CONFIG_PREEMPT_RT
174 #define slub_get_cpu_ptr(var) get_cpu_ptr(var)
175 #define slub_put_cpu_ptr(var) put_cpu_ptr(var)
176 #define USE_LOCKLESS_FAST_PATH() (true)
178 #define slub_get_cpu_ptr(var) \
183 #define slub_put_cpu_ptr(var) \
188 #define USE_LOCKLESS_FAST_PATH() (false)
191 #ifndef CONFIG_SLUB_TINY
192 #define __fastpath_inline __always_inline
194 #define __fastpath_inline
197 #ifdef CONFIG_SLUB_DEBUG
198 #ifdef CONFIG_SLUB_DEBUG_ON
199 DEFINE_STATIC_KEY_TRUE(slub_debug_enabled);
201 DEFINE_STATIC_KEY_FALSE(slub_debug_enabled);
203 #endif /* CONFIG_SLUB_DEBUG */
205 /* Structure holding parameters for get_partial() call chain */
206 struct partial_context {
209 unsigned int orig_size;
212 static inline bool kmem_cache_debug(struct kmem_cache *s)
214 return kmem_cache_debug_flags(s, SLAB_DEBUG_FLAGS);
217 static inline bool slub_debug_orig_size(struct kmem_cache *s)
219 return (kmem_cache_debug_flags(s, SLAB_STORE_USER) &&
220 (s->flags & SLAB_KMALLOC));
223 void *fixup_red_left(struct kmem_cache *s, void *p)
225 if (kmem_cache_debug_flags(s, SLAB_RED_ZONE))
226 p += s->red_left_pad;
231 static inline bool kmem_cache_has_cpu_partial(struct kmem_cache *s)
233 #ifdef CONFIG_SLUB_CPU_PARTIAL
234 return !kmem_cache_debug(s);
241 * Issues still to be resolved:
243 * - Support PAGE_ALLOC_DEBUG. Should be easy to do.
245 * - Variable sizing of the per node arrays
248 /* Enable to log cmpxchg failures */
249 #undef SLUB_DEBUG_CMPXCHG
251 #ifndef CONFIG_SLUB_TINY
253 * Minimum number of partial slabs. These will be left on the partial
254 * lists even if they are empty. kmem_cache_shrink may reclaim them.
256 #define MIN_PARTIAL 5
259 * Maximum number of desirable partial slabs.
260 * The existence of more partial slabs makes kmem_cache_shrink
261 * sort the partial list by the number of objects in use.
263 #define MAX_PARTIAL 10
265 #define MIN_PARTIAL 0
266 #define MAX_PARTIAL 0
269 #define DEBUG_DEFAULT_FLAGS (SLAB_CONSISTENCY_CHECKS | SLAB_RED_ZONE | \
270 SLAB_POISON | SLAB_STORE_USER)
273 * These debug flags cannot use CMPXCHG because there might be consistency
274 * issues when checking or reading debug information
276 #define SLAB_NO_CMPXCHG (SLAB_CONSISTENCY_CHECKS | SLAB_STORE_USER | \
281 * Debugging flags that require metadata to be stored in the slab. These get
282 * disabled when slub_debug=O is used and a cache's min order increases with
285 #define DEBUG_METADATA_FLAGS (SLAB_RED_ZONE | SLAB_POISON | SLAB_STORE_USER)
288 #define OO_MASK ((1 << OO_SHIFT) - 1)
289 #define MAX_OBJS_PER_PAGE 32767 /* since slab.objects is u15 */
291 /* Internal SLUB flags */
293 #define __OBJECT_POISON ((slab_flags_t __force)0x80000000U)
294 /* Use cmpxchg_double */
295 #define __CMPXCHG_DOUBLE ((slab_flags_t __force)0x40000000U)
298 * Tracking user of a slab.
300 #define TRACK_ADDRS_COUNT 16
302 unsigned long addr; /* Called from address */
303 #ifdef CONFIG_STACKDEPOT
304 depot_stack_handle_t handle;
306 int cpu; /* Was running on cpu */
307 int pid; /* Pid context */
308 unsigned long when; /* When did the operation occur */
311 enum track_item { TRACK_ALLOC, TRACK_FREE };
313 #ifdef SLAB_SUPPORTS_SYSFS
314 static int sysfs_slab_add(struct kmem_cache *);
315 static int sysfs_slab_alias(struct kmem_cache *, const char *);
317 static inline int sysfs_slab_add(struct kmem_cache *s) { return 0; }
318 static inline int sysfs_slab_alias(struct kmem_cache *s, const char *p)
322 #if defined(CONFIG_DEBUG_FS) && defined(CONFIG_SLUB_DEBUG)
323 static void debugfs_slab_add(struct kmem_cache *);
325 static inline void debugfs_slab_add(struct kmem_cache *s) { }
328 static inline void stat(const struct kmem_cache *s, enum stat_item si)
330 #ifdef CONFIG_SLUB_STATS
332 * The rmw is racy on a preemptible kernel but this is acceptable, so
333 * avoid this_cpu_add()'s irq-disable overhead.
335 raw_cpu_inc(s->cpu_slab->stat[si]);
340 * Tracks for which NUMA nodes we have kmem_cache_nodes allocated.
341 * Corresponds to node_state[N_NORMAL_MEMORY], but can temporarily
342 * differ during memory hotplug/hotremove operations.
343 * Protected by slab_mutex.
345 static nodemask_t slab_nodes;
347 #ifndef CONFIG_SLUB_TINY
349 * Workqueue used for flush_cpu_slab().
351 static struct workqueue_struct *flushwq;
354 /********************************************************************
355 * Core slab cache functions
356 *******************************************************************/
359 * Returns freelist pointer (ptr). With hardening, this is obfuscated
360 * with an XOR of the address where the pointer is held and a per-cache
363 static inline void *freelist_ptr(const struct kmem_cache *s, void *ptr,
364 unsigned long ptr_addr)
366 #ifdef CONFIG_SLAB_FREELIST_HARDENED
368 * When CONFIG_KASAN_SW/HW_TAGS is enabled, ptr_addr might be tagged.
369 * Normally, this doesn't cause any issues, as both set_freepointer()
370 * and get_freepointer() are called with a pointer with the same tag.
371 * However, there are some issues with CONFIG_SLUB_DEBUG code. For
372 * example, when __free_slub() iterates over objects in a cache, it
373 * passes untagged pointers to check_object(). check_object() in turns
374 * calls get_freepointer() with an untagged pointer, which causes the
375 * freepointer to be restored incorrectly.
377 return (void *)((unsigned long)ptr ^ s->random ^
378 swab((unsigned long)kasan_reset_tag((void *)ptr_addr)));
384 /* Returns the freelist pointer recorded at location ptr_addr. */
385 static inline void *freelist_dereference(const struct kmem_cache *s,
388 return freelist_ptr(s, (void *)*(unsigned long *)(ptr_addr),
389 (unsigned long)ptr_addr);
392 static inline void *get_freepointer(struct kmem_cache *s, void *object)
394 object = kasan_reset_tag(object);
395 return freelist_dereference(s, object + s->offset);
398 #ifndef CONFIG_SLUB_TINY
399 static void prefetch_freepointer(const struct kmem_cache *s, void *object)
401 prefetchw(object + s->offset);
406 * When running under KMSAN, get_freepointer_safe() may return an uninitialized
407 * pointer value in the case the current thread loses the race for the next
408 * memory chunk in the freelist. In that case this_cpu_cmpxchg_double() in
409 * slab_alloc_node() will fail, so the uninitialized value won't be used, but
410 * KMSAN will still check all arguments of cmpxchg because of imperfect
411 * handling of inline assembly.
412 * To work around this problem, we apply __no_kmsan_checks to ensure that
413 * get_freepointer_safe() returns initialized memory.
416 static inline void *get_freepointer_safe(struct kmem_cache *s, void *object)
418 unsigned long freepointer_addr;
421 if (!debug_pagealloc_enabled_static())
422 return get_freepointer(s, object);
424 object = kasan_reset_tag(object);
425 freepointer_addr = (unsigned long)object + s->offset;
426 copy_from_kernel_nofault(&p, (void **)freepointer_addr, sizeof(p));
427 return freelist_ptr(s, p, freepointer_addr);
430 static inline void set_freepointer(struct kmem_cache *s, void *object, void *fp)
432 unsigned long freeptr_addr = (unsigned long)object + s->offset;
434 #ifdef CONFIG_SLAB_FREELIST_HARDENED
435 BUG_ON(object == fp); /* naive detection of double free or corruption */
438 freeptr_addr = (unsigned long)kasan_reset_tag((void *)freeptr_addr);
439 *(void **)freeptr_addr = freelist_ptr(s, fp, freeptr_addr);
442 /* Loop over all objects in a slab */
443 #define for_each_object(__p, __s, __addr, __objects) \
444 for (__p = fixup_red_left(__s, __addr); \
445 __p < (__addr) + (__objects) * (__s)->size; \
448 static inline unsigned int order_objects(unsigned int order, unsigned int size)
450 return ((unsigned int)PAGE_SIZE << order) / size;
453 static inline struct kmem_cache_order_objects oo_make(unsigned int order,
456 struct kmem_cache_order_objects x = {
457 (order << OO_SHIFT) + order_objects(order, size)
463 static inline unsigned int oo_order(struct kmem_cache_order_objects x)
465 return x.x >> OO_SHIFT;
468 static inline unsigned int oo_objects(struct kmem_cache_order_objects x)
470 return x.x & OO_MASK;
473 #ifdef CONFIG_SLUB_CPU_PARTIAL
474 static void slub_set_cpu_partial(struct kmem_cache *s, unsigned int nr_objects)
476 unsigned int nr_slabs;
478 s->cpu_partial = nr_objects;
481 * We take the number of objects but actually limit the number of
482 * slabs on the per cpu partial list, in order to limit excessive
483 * growth of the list. For simplicity we assume that the slabs will
486 nr_slabs = DIV_ROUND_UP(nr_objects * 2, oo_objects(s->oo));
487 s->cpu_partial_slabs = nr_slabs;
491 slub_set_cpu_partial(struct kmem_cache *s, unsigned int nr_objects)
494 #endif /* CONFIG_SLUB_CPU_PARTIAL */
497 * Per slab locking using the pagelock
499 static __always_inline void slab_lock(struct slab *slab)
501 struct page *page = slab_page(slab);
503 VM_BUG_ON_PAGE(PageTail(page), page);
504 bit_spin_lock(PG_locked, &page->flags);
507 static __always_inline void slab_unlock(struct slab *slab)
509 struct page *page = slab_page(slab);
511 VM_BUG_ON_PAGE(PageTail(page), page);
512 __bit_spin_unlock(PG_locked, &page->flags);
516 * Interrupts must be disabled (for the fallback code to work right), typically
517 * by an _irqsave() lock variant. On PREEMPT_RT the preempt_disable(), which is
518 * part of bit_spin_lock(), is sufficient because the policy is not to allow any
519 * allocation/ free operation in hardirq context. Therefore nothing can
520 * interrupt the operation.
522 static inline bool __cmpxchg_double_slab(struct kmem_cache *s, struct slab *slab,
523 void *freelist_old, unsigned long counters_old,
524 void *freelist_new, unsigned long counters_new,
527 if (USE_LOCKLESS_FAST_PATH())
528 lockdep_assert_irqs_disabled();
529 #if defined(CONFIG_HAVE_CMPXCHG_DOUBLE) && \
530 defined(CONFIG_HAVE_ALIGNED_STRUCT_PAGE)
531 if (s->flags & __CMPXCHG_DOUBLE) {
532 if (cmpxchg_double(&slab->freelist, &slab->counters,
533 freelist_old, counters_old,
534 freelist_new, counters_new))
540 if (slab->freelist == freelist_old &&
541 slab->counters == counters_old) {
542 slab->freelist = freelist_new;
543 slab->counters = counters_new;
551 stat(s, CMPXCHG_DOUBLE_FAIL);
553 #ifdef SLUB_DEBUG_CMPXCHG
554 pr_info("%s %s: cmpxchg double redo ", n, s->name);
560 static inline bool cmpxchg_double_slab(struct kmem_cache *s, struct slab *slab,
561 void *freelist_old, unsigned long counters_old,
562 void *freelist_new, unsigned long counters_new,
565 #if defined(CONFIG_HAVE_CMPXCHG_DOUBLE) && \
566 defined(CONFIG_HAVE_ALIGNED_STRUCT_PAGE)
567 if (s->flags & __CMPXCHG_DOUBLE) {
568 if (cmpxchg_double(&slab->freelist, &slab->counters,
569 freelist_old, counters_old,
570 freelist_new, counters_new))
577 local_irq_save(flags);
579 if (slab->freelist == freelist_old &&
580 slab->counters == counters_old) {
581 slab->freelist = freelist_new;
582 slab->counters = counters_new;
584 local_irq_restore(flags);
588 local_irq_restore(flags);
592 stat(s, CMPXCHG_DOUBLE_FAIL);
594 #ifdef SLUB_DEBUG_CMPXCHG
595 pr_info("%s %s: cmpxchg double redo ", n, s->name);
601 #ifdef CONFIG_SLUB_DEBUG
602 static unsigned long object_map[BITS_TO_LONGS(MAX_OBJS_PER_PAGE)];
603 static DEFINE_SPINLOCK(object_map_lock);
605 static void __fill_map(unsigned long *obj_map, struct kmem_cache *s,
608 void *addr = slab_address(slab);
611 bitmap_zero(obj_map, slab->objects);
613 for (p = slab->freelist; p; p = get_freepointer(s, p))
614 set_bit(__obj_to_index(s, addr, p), obj_map);
617 #if IS_ENABLED(CONFIG_KUNIT)
618 static bool slab_add_kunit_errors(void)
620 struct kunit_resource *resource;
622 if (!kunit_get_current_test())
625 resource = kunit_find_named_resource(current->kunit_test, "slab_errors");
629 (*(int *)resource->data)++;
630 kunit_put_resource(resource);
634 static inline bool slab_add_kunit_errors(void) { return false; }
637 static inline unsigned int size_from_object(struct kmem_cache *s)
639 if (s->flags & SLAB_RED_ZONE)
640 return s->size - s->red_left_pad;
645 static inline void *restore_red_left(struct kmem_cache *s, void *p)
647 if (s->flags & SLAB_RED_ZONE)
648 p -= s->red_left_pad;
656 #if defined(CONFIG_SLUB_DEBUG_ON)
657 static slab_flags_t slub_debug = DEBUG_DEFAULT_FLAGS;
659 static slab_flags_t slub_debug;
662 static char *slub_debug_string;
663 static int disable_higher_order_debug;
666 * slub is about to manipulate internal object metadata. This memory lies
667 * outside the range of the allocated object, so accessing it would normally
668 * be reported by kasan as a bounds error. metadata_access_enable() is used
669 * to tell kasan that these accesses are OK.
671 static inline void metadata_access_enable(void)
673 kasan_disable_current();
676 static inline void metadata_access_disable(void)
678 kasan_enable_current();
685 /* Verify that a pointer has an address that is valid within a slab page */
686 static inline int check_valid_pointer(struct kmem_cache *s,
687 struct slab *slab, void *object)
694 base = slab_address(slab);
695 object = kasan_reset_tag(object);
696 object = restore_red_left(s, object);
697 if (object < base || object >= base + slab->objects * s->size ||
698 (object - base) % s->size) {
705 static void print_section(char *level, char *text, u8 *addr,
708 metadata_access_enable();
709 print_hex_dump(level, text, DUMP_PREFIX_ADDRESS,
710 16, 1, kasan_reset_tag((void *)addr), length, 1);
711 metadata_access_disable();
715 * See comment in calculate_sizes().
717 static inline bool freeptr_outside_object(struct kmem_cache *s)
719 return s->offset >= s->inuse;
723 * Return offset of the end of info block which is inuse + free pointer if
724 * not overlapping with object.
726 static inline unsigned int get_info_end(struct kmem_cache *s)
728 if (freeptr_outside_object(s))
729 return s->inuse + sizeof(void *);
734 static struct track *get_track(struct kmem_cache *s, void *object,
735 enum track_item alloc)
739 p = object + get_info_end(s);
741 return kasan_reset_tag(p + alloc);
744 #ifdef CONFIG_STACKDEPOT
745 static noinline depot_stack_handle_t set_track_prepare(void)
747 depot_stack_handle_t handle;
748 unsigned long entries[TRACK_ADDRS_COUNT];
749 unsigned int nr_entries;
751 nr_entries = stack_trace_save(entries, ARRAY_SIZE(entries), 3);
752 handle = stack_depot_save(entries, nr_entries, GFP_NOWAIT);
757 static inline depot_stack_handle_t set_track_prepare(void)
763 static void set_track_update(struct kmem_cache *s, void *object,
764 enum track_item alloc, unsigned long addr,
765 depot_stack_handle_t handle)
767 struct track *p = get_track(s, object, alloc);
769 #ifdef CONFIG_STACKDEPOT
773 p->cpu = smp_processor_id();
774 p->pid = current->pid;
778 static __always_inline void set_track(struct kmem_cache *s, void *object,
779 enum track_item alloc, unsigned long addr)
781 depot_stack_handle_t handle = set_track_prepare();
783 set_track_update(s, object, alloc, addr, handle);
786 static void init_tracking(struct kmem_cache *s, void *object)
790 if (!(s->flags & SLAB_STORE_USER))
793 p = get_track(s, object, TRACK_ALLOC);
794 memset(p, 0, 2*sizeof(struct track));
797 static void print_track(const char *s, struct track *t, unsigned long pr_time)
799 depot_stack_handle_t handle __maybe_unused;
804 pr_err("%s in %pS age=%lu cpu=%u pid=%d\n",
805 s, (void *)t->addr, pr_time - t->when, t->cpu, t->pid);
806 #ifdef CONFIG_STACKDEPOT
807 handle = READ_ONCE(t->handle);
809 stack_depot_print(handle);
811 pr_err("object allocation/free stack trace missing\n");
815 void print_tracking(struct kmem_cache *s, void *object)
817 unsigned long pr_time = jiffies;
818 if (!(s->flags & SLAB_STORE_USER))
821 print_track("Allocated", get_track(s, object, TRACK_ALLOC), pr_time);
822 print_track("Freed", get_track(s, object, TRACK_FREE), pr_time);
825 static void print_slab_info(const struct slab *slab)
827 struct folio *folio = (struct folio *)slab_folio(slab);
829 pr_err("Slab 0x%p objects=%u used=%u fp=0x%p flags=%pGp\n",
830 slab, slab->objects, slab->inuse, slab->freelist,
831 folio_flags(folio, 0));
835 * kmalloc caches has fixed sizes (mostly power of 2), and kmalloc() API
836 * family will round up the real request size to these fixed ones, so
837 * there could be an extra area than what is requested. Save the original
838 * request size in the meta data area, for better debug and sanity check.
840 static inline void set_orig_size(struct kmem_cache *s,
841 void *object, unsigned int orig_size)
843 void *p = kasan_reset_tag(object);
845 if (!slub_debug_orig_size(s))
848 #ifdef CONFIG_KASAN_GENERIC
850 * KASAN could save its free meta data in object's data area at
851 * offset 0, if the size is larger than 'orig_size', it will
852 * overlap the data redzone in [orig_size+1, object_size], and
853 * the check should be skipped.
855 if (kasan_metadata_size(s, true) > orig_size)
856 orig_size = s->object_size;
859 p += get_info_end(s);
860 p += sizeof(struct track) * 2;
862 *(unsigned int *)p = orig_size;
865 static inline unsigned int get_orig_size(struct kmem_cache *s, void *object)
867 void *p = kasan_reset_tag(object);
869 if (!slub_debug_orig_size(s))
870 return s->object_size;
872 p += get_info_end(s);
873 p += sizeof(struct track) * 2;
875 return *(unsigned int *)p;
878 void skip_orig_size_check(struct kmem_cache *s, const void *object)
880 set_orig_size(s, (void *)object, s->object_size);
883 static void slab_bug(struct kmem_cache *s, char *fmt, ...)
885 struct va_format vaf;
891 pr_err("=============================================================================\n");
892 pr_err("BUG %s (%s): %pV\n", s->name, print_tainted(), &vaf);
893 pr_err("-----------------------------------------------------------------------------\n\n");
898 static void slab_fix(struct kmem_cache *s, char *fmt, ...)
900 struct va_format vaf;
903 if (slab_add_kunit_errors())
909 pr_err("FIX %s: %pV\n", s->name, &vaf);
913 static void print_trailer(struct kmem_cache *s, struct slab *slab, u8 *p)
915 unsigned int off; /* Offset of last byte */
916 u8 *addr = slab_address(slab);
918 print_tracking(s, p);
920 print_slab_info(slab);
922 pr_err("Object 0x%p @offset=%tu fp=0x%p\n\n",
923 p, p - addr, get_freepointer(s, p));
925 if (s->flags & SLAB_RED_ZONE)
926 print_section(KERN_ERR, "Redzone ", p - s->red_left_pad,
928 else if (p > addr + 16)
929 print_section(KERN_ERR, "Bytes b4 ", p - 16, 16);
931 print_section(KERN_ERR, "Object ", p,
932 min_t(unsigned int, s->object_size, PAGE_SIZE));
933 if (s->flags & SLAB_RED_ZONE)
934 print_section(KERN_ERR, "Redzone ", p + s->object_size,
935 s->inuse - s->object_size);
937 off = get_info_end(s);
939 if (s->flags & SLAB_STORE_USER)
940 off += 2 * sizeof(struct track);
942 if (slub_debug_orig_size(s))
943 off += sizeof(unsigned int);
945 off += kasan_metadata_size(s, false);
947 if (off != size_from_object(s))
948 /* Beginning of the filler is the free pointer */
949 print_section(KERN_ERR, "Padding ", p + off,
950 size_from_object(s) - off);
955 static void object_err(struct kmem_cache *s, struct slab *slab,
956 u8 *object, char *reason)
958 if (slab_add_kunit_errors())
961 slab_bug(s, "%s", reason);
962 print_trailer(s, slab, object);
963 add_taint(TAINT_BAD_PAGE, LOCKDEP_NOW_UNRELIABLE);
966 static bool freelist_corrupted(struct kmem_cache *s, struct slab *slab,
967 void **freelist, void *nextfree)
969 if ((s->flags & SLAB_CONSISTENCY_CHECKS) &&
970 !check_valid_pointer(s, slab, nextfree) && freelist) {
971 object_err(s, slab, *freelist, "Freechain corrupt");
973 slab_fix(s, "Isolate corrupted freechain");
980 static __printf(3, 4) void slab_err(struct kmem_cache *s, struct slab *slab,
981 const char *fmt, ...)
986 if (slab_add_kunit_errors())
990 vsnprintf(buf, sizeof(buf), fmt, args);
992 slab_bug(s, "%s", buf);
993 print_slab_info(slab);
995 add_taint(TAINT_BAD_PAGE, LOCKDEP_NOW_UNRELIABLE);
998 static void init_object(struct kmem_cache *s, void *object, u8 val)
1000 u8 *p = kasan_reset_tag(object);
1001 unsigned int poison_size = s->object_size;
1003 if (s->flags & SLAB_RED_ZONE) {
1004 memset(p - s->red_left_pad, val, s->red_left_pad);
1006 if (slub_debug_orig_size(s) && val == SLUB_RED_ACTIVE) {
1008 * Redzone the extra allocated space by kmalloc than
1009 * requested, and the poison size will be limited to
1010 * the original request size accordingly.
1012 poison_size = get_orig_size(s, object);
1016 if (s->flags & __OBJECT_POISON) {
1017 memset(p, POISON_FREE, poison_size - 1);
1018 p[poison_size - 1] = POISON_END;
1021 if (s->flags & SLAB_RED_ZONE)
1022 memset(p + poison_size, val, s->inuse - poison_size);
1025 static void restore_bytes(struct kmem_cache *s, char *message, u8 data,
1026 void *from, void *to)
1028 slab_fix(s, "Restoring %s 0x%p-0x%p=0x%x", message, from, to - 1, data);
1029 memset(from, data, to - from);
1032 static int check_bytes_and_report(struct kmem_cache *s, struct slab *slab,
1033 u8 *object, char *what,
1034 u8 *start, unsigned int value, unsigned int bytes)
1038 u8 *addr = slab_address(slab);
1040 metadata_access_enable();
1041 fault = memchr_inv(kasan_reset_tag(start), value, bytes);
1042 metadata_access_disable();
1046 end = start + bytes;
1047 while (end > fault && end[-1] == value)
1050 if (slab_add_kunit_errors())
1051 goto skip_bug_print;
1053 slab_bug(s, "%s overwritten", what);
1054 pr_err("0x%p-0x%p @offset=%tu. First byte 0x%x instead of 0x%x\n",
1055 fault, end - 1, fault - addr,
1057 print_trailer(s, slab, object);
1058 add_taint(TAINT_BAD_PAGE, LOCKDEP_NOW_UNRELIABLE);
1061 restore_bytes(s, what, value, fault, end);
1069 * Bytes of the object to be managed.
1070 * If the freepointer may overlay the object then the free
1071 * pointer is at the middle of the object.
1073 * Poisoning uses 0x6b (POISON_FREE) and the last byte is
1076 * object + s->object_size
1077 * Padding to reach word boundary. This is also used for Redzoning.
1078 * Padding is extended by another word if Redzoning is enabled and
1079 * object_size == inuse.
1081 * We fill with 0xbb (RED_INACTIVE) for inactive objects and with
1082 * 0xcc (RED_ACTIVE) for objects in use.
1085 * Meta data starts here.
1087 * A. Free pointer (if we cannot overwrite object on free)
1088 * B. Tracking data for SLAB_STORE_USER
1089 * C. Original request size for kmalloc object (SLAB_STORE_USER enabled)
1090 * D. Padding to reach required alignment boundary or at minimum
1091 * one word if debugging is on to be able to detect writes
1092 * before the word boundary.
1094 * Padding is done using 0x5a (POISON_INUSE)
1097 * Nothing is used beyond s->size.
1099 * If slabcaches are merged then the object_size and inuse boundaries are mostly
1100 * ignored. And therefore no slab options that rely on these boundaries
1101 * may be used with merged slabcaches.
1104 static int check_pad_bytes(struct kmem_cache *s, struct slab *slab, u8 *p)
1106 unsigned long off = get_info_end(s); /* The end of info */
1108 if (s->flags & SLAB_STORE_USER) {
1109 /* We also have user information there */
1110 off += 2 * sizeof(struct track);
1112 if (s->flags & SLAB_KMALLOC)
1113 off += sizeof(unsigned int);
1116 off += kasan_metadata_size(s, false);
1118 if (size_from_object(s) == off)
1121 return check_bytes_and_report(s, slab, p, "Object padding",
1122 p + off, POISON_INUSE, size_from_object(s) - off);
1125 /* Check the pad bytes at the end of a slab page */
1126 static void slab_pad_check(struct kmem_cache *s, struct slab *slab)
1135 if (!(s->flags & SLAB_POISON))
1138 start = slab_address(slab);
1139 length = slab_size(slab);
1140 end = start + length;
1141 remainder = length % s->size;
1145 pad = end - remainder;
1146 metadata_access_enable();
1147 fault = memchr_inv(kasan_reset_tag(pad), POISON_INUSE, remainder);
1148 metadata_access_disable();
1151 while (end > fault && end[-1] == POISON_INUSE)
1154 slab_err(s, slab, "Padding overwritten. 0x%p-0x%p @offset=%tu",
1155 fault, end - 1, fault - start);
1156 print_section(KERN_ERR, "Padding ", pad, remainder);
1158 restore_bytes(s, "slab padding", POISON_INUSE, fault, end);
1161 static int check_object(struct kmem_cache *s, struct slab *slab,
1162 void *object, u8 val)
1165 u8 *endobject = object + s->object_size;
1166 unsigned int orig_size;
1168 if (s->flags & SLAB_RED_ZONE) {
1169 if (!check_bytes_and_report(s, slab, object, "Left Redzone",
1170 object - s->red_left_pad, val, s->red_left_pad))
1173 if (!check_bytes_and_report(s, slab, object, "Right Redzone",
1174 endobject, val, s->inuse - s->object_size))
1177 if (slub_debug_orig_size(s) && val == SLUB_RED_ACTIVE) {
1178 orig_size = get_orig_size(s, object);
1180 if (s->object_size > orig_size &&
1181 !check_bytes_and_report(s, slab, object,
1182 "kmalloc Redzone", p + orig_size,
1183 val, s->object_size - orig_size)) {
1188 if ((s->flags & SLAB_POISON) && s->object_size < s->inuse) {
1189 check_bytes_and_report(s, slab, p, "Alignment padding",
1190 endobject, POISON_INUSE,
1191 s->inuse - s->object_size);
1195 if (s->flags & SLAB_POISON) {
1196 if (val != SLUB_RED_ACTIVE && (s->flags & __OBJECT_POISON) &&
1197 (!check_bytes_and_report(s, slab, p, "Poison", p,
1198 POISON_FREE, s->object_size - 1) ||
1199 !check_bytes_and_report(s, slab, p, "End Poison",
1200 p + s->object_size - 1, POISON_END, 1)))
1203 * check_pad_bytes cleans up on its own.
1205 check_pad_bytes(s, slab, p);
1208 if (!freeptr_outside_object(s) && val == SLUB_RED_ACTIVE)
1210 * Object and freepointer overlap. Cannot check
1211 * freepointer while object is allocated.
1215 /* Check free pointer validity */
1216 if (!check_valid_pointer(s, slab, get_freepointer(s, p))) {
1217 object_err(s, slab, p, "Freepointer corrupt");
1219 * No choice but to zap it and thus lose the remainder
1220 * of the free objects in this slab. May cause
1221 * another error because the object count is now wrong.
1223 set_freepointer(s, p, NULL);
1229 static int check_slab(struct kmem_cache *s, struct slab *slab)
1233 if (!folio_test_slab(slab_folio(slab))) {
1234 slab_err(s, slab, "Not a valid slab page");
1238 maxobj = order_objects(slab_order(slab), s->size);
1239 if (slab->objects > maxobj) {
1240 slab_err(s, slab, "objects %u > max %u",
1241 slab->objects, maxobj);
1244 if (slab->inuse > slab->objects) {
1245 slab_err(s, slab, "inuse %u > max %u",
1246 slab->inuse, slab->objects);
1249 /* Slab_pad_check fixes things up after itself */
1250 slab_pad_check(s, slab);
1255 * Determine if a certain object in a slab is on the freelist. Must hold the
1256 * slab lock to guarantee that the chains are in a consistent state.
1258 static int on_freelist(struct kmem_cache *s, struct slab *slab, void *search)
1262 void *object = NULL;
1265 fp = slab->freelist;
1266 while (fp && nr <= slab->objects) {
1269 if (!check_valid_pointer(s, slab, fp)) {
1271 object_err(s, slab, object,
1272 "Freechain corrupt");
1273 set_freepointer(s, object, NULL);
1275 slab_err(s, slab, "Freepointer corrupt");
1276 slab->freelist = NULL;
1277 slab->inuse = slab->objects;
1278 slab_fix(s, "Freelist cleared");
1284 fp = get_freepointer(s, object);
1288 max_objects = order_objects(slab_order(slab), s->size);
1289 if (max_objects > MAX_OBJS_PER_PAGE)
1290 max_objects = MAX_OBJS_PER_PAGE;
1292 if (slab->objects != max_objects) {
1293 slab_err(s, slab, "Wrong number of objects. Found %d but should be %d",
1294 slab->objects, max_objects);
1295 slab->objects = max_objects;
1296 slab_fix(s, "Number of objects adjusted");
1298 if (slab->inuse != slab->objects - nr) {
1299 slab_err(s, slab, "Wrong object count. Counter is %d but counted were %d",
1300 slab->inuse, slab->objects - nr);
1301 slab->inuse = slab->objects - nr;
1302 slab_fix(s, "Object count adjusted");
1304 return search == NULL;
1307 static void trace(struct kmem_cache *s, struct slab *slab, void *object,
1310 if (s->flags & SLAB_TRACE) {
1311 pr_info("TRACE %s %s 0x%p inuse=%d fp=0x%p\n",
1313 alloc ? "alloc" : "free",
1314 object, slab->inuse,
1318 print_section(KERN_INFO, "Object ", (void *)object,
1326 * Tracking of fully allocated slabs for debugging purposes.
1328 static void add_full(struct kmem_cache *s,
1329 struct kmem_cache_node *n, struct slab *slab)
1331 if (!(s->flags & SLAB_STORE_USER))
1334 lockdep_assert_held(&n->list_lock);
1335 list_add(&slab->slab_list, &n->full);
1338 static void remove_full(struct kmem_cache *s, struct kmem_cache_node *n, struct slab *slab)
1340 if (!(s->flags & SLAB_STORE_USER))
1343 lockdep_assert_held(&n->list_lock);
1344 list_del(&slab->slab_list);
1347 /* Tracking of the number of slabs for debugging purposes */
1348 static inline unsigned long slabs_node(struct kmem_cache *s, int node)
1350 struct kmem_cache_node *n = get_node(s, node);
1352 return atomic_long_read(&n->nr_slabs);
1355 static inline unsigned long node_nr_slabs(struct kmem_cache_node *n)
1357 return atomic_long_read(&n->nr_slabs);
1360 static inline void inc_slabs_node(struct kmem_cache *s, int node, int objects)
1362 struct kmem_cache_node *n = get_node(s, node);
1365 * May be called early in order to allocate a slab for the
1366 * kmem_cache_node structure. Solve the chicken-egg
1367 * dilemma by deferring the increment of the count during
1368 * bootstrap (see early_kmem_cache_node_alloc).
1371 atomic_long_inc(&n->nr_slabs);
1372 atomic_long_add(objects, &n->total_objects);
1375 static inline void dec_slabs_node(struct kmem_cache *s, int node, int objects)
1377 struct kmem_cache_node *n = get_node(s, node);
1379 atomic_long_dec(&n->nr_slabs);
1380 atomic_long_sub(objects, &n->total_objects);
1383 /* Object debug checks for alloc/free paths */
1384 static void setup_object_debug(struct kmem_cache *s, void *object)
1386 if (!kmem_cache_debug_flags(s, SLAB_STORE_USER|SLAB_RED_ZONE|__OBJECT_POISON))
1389 init_object(s, object, SLUB_RED_INACTIVE);
1390 init_tracking(s, object);
1394 void setup_slab_debug(struct kmem_cache *s, struct slab *slab, void *addr)
1396 if (!kmem_cache_debug_flags(s, SLAB_POISON))
1399 metadata_access_enable();
1400 memset(kasan_reset_tag(addr), POISON_INUSE, slab_size(slab));
1401 metadata_access_disable();
1404 static inline int alloc_consistency_checks(struct kmem_cache *s,
1405 struct slab *slab, void *object)
1407 if (!check_slab(s, slab))
1410 if (!check_valid_pointer(s, slab, object)) {
1411 object_err(s, slab, object, "Freelist Pointer check fails");
1415 if (!check_object(s, slab, object, SLUB_RED_INACTIVE))
1421 static noinline bool alloc_debug_processing(struct kmem_cache *s,
1422 struct slab *slab, void *object, int orig_size)
1424 if (s->flags & SLAB_CONSISTENCY_CHECKS) {
1425 if (!alloc_consistency_checks(s, slab, object))
1429 /* Success. Perform special debug activities for allocs */
1430 trace(s, slab, object, 1);
1431 set_orig_size(s, object, orig_size);
1432 init_object(s, object, SLUB_RED_ACTIVE);
1436 if (folio_test_slab(slab_folio(slab))) {
1438 * If this is a slab page then lets do the best we can
1439 * to avoid issues in the future. Marking all objects
1440 * as used avoids touching the remaining objects.
1442 slab_fix(s, "Marking all objects used");
1443 slab->inuse = slab->objects;
1444 slab->freelist = NULL;
1449 static inline int free_consistency_checks(struct kmem_cache *s,
1450 struct slab *slab, void *object, unsigned long addr)
1452 if (!check_valid_pointer(s, slab, object)) {
1453 slab_err(s, slab, "Invalid object pointer 0x%p", object);
1457 if (on_freelist(s, slab, object)) {
1458 object_err(s, slab, object, "Object already free");
1462 if (!check_object(s, slab, object, SLUB_RED_ACTIVE))
1465 if (unlikely(s != slab->slab_cache)) {
1466 if (!folio_test_slab(slab_folio(slab))) {
1467 slab_err(s, slab, "Attempt to free object(0x%p) outside of slab",
1469 } else if (!slab->slab_cache) {
1470 pr_err("SLUB <none>: no slab for object 0x%p.\n",
1474 object_err(s, slab, object,
1475 "page slab pointer corrupt.");
1482 * Parse a block of slub_debug options. Blocks are delimited by ';'
1484 * @str: start of block
1485 * @flags: returns parsed flags, or DEBUG_DEFAULT_FLAGS if none specified
1486 * @slabs: return start of list of slabs, or NULL when there's no list
1487 * @init: assume this is initial parsing and not per-kmem-create parsing
1489 * returns the start of next block if there's any, or NULL
1492 parse_slub_debug_flags(char *str, slab_flags_t *flags, char **slabs, bool init)
1494 bool higher_order_disable = false;
1496 /* Skip any completely empty blocks */
1497 while (*str && *str == ';')
1502 * No options but restriction on slabs. This means full
1503 * debugging for slabs matching a pattern.
1505 *flags = DEBUG_DEFAULT_FLAGS;
1510 /* Determine which debug features should be switched on */
1511 for (; *str && *str != ',' && *str != ';'; str++) {
1512 switch (tolower(*str)) {
1517 *flags |= SLAB_CONSISTENCY_CHECKS;
1520 *flags |= SLAB_RED_ZONE;
1523 *flags |= SLAB_POISON;
1526 *flags |= SLAB_STORE_USER;
1529 *flags |= SLAB_TRACE;
1532 *flags |= SLAB_FAILSLAB;
1536 * Avoid enabling debugging on caches if its minimum
1537 * order would increase as a result.
1539 higher_order_disable = true;
1543 pr_err("slub_debug option '%c' unknown. skipped\n", *str);
1552 /* Skip over the slab list */
1553 while (*str && *str != ';')
1556 /* Skip any completely empty blocks */
1557 while (*str && *str == ';')
1560 if (init && higher_order_disable)
1561 disable_higher_order_debug = 1;
1569 static int __init setup_slub_debug(char *str)
1572 slab_flags_t global_flags;
1575 bool global_slub_debug_changed = false;
1576 bool slab_list_specified = false;
1578 global_flags = DEBUG_DEFAULT_FLAGS;
1579 if (*str++ != '=' || !*str)
1581 * No options specified. Switch on full debugging.
1587 str = parse_slub_debug_flags(str, &flags, &slab_list, true);
1590 global_flags = flags;
1591 global_slub_debug_changed = true;
1593 slab_list_specified = true;
1594 if (flags & SLAB_STORE_USER)
1595 stack_depot_request_early_init();
1600 * For backwards compatibility, a single list of flags with list of
1601 * slabs means debugging is only changed for those slabs, so the global
1602 * slub_debug should be unchanged (0 or DEBUG_DEFAULT_FLAGS, depending
1603 * on CONFIG_SLUB_DEBUG_ON). We can extended that to multiple lists as
1604 * long as there is no option specifying flags without a slab list.
1606 if (slab_list_specified) {
1607 if (!global_slub_debug_changed)
1608 global_flags = slub_debug;
1609 slub_debug_string = saved_str;
1612 slub_debug = global_flags;
1613 if (slub_debug & SLAB_STORE_USER)
1614 stack_depot_request_early_init();
1615 if (slub_debug != 0 || slub_debug_string)
1616 static_branch_enable(&slub_debug_enabled);
1618 static_branch_disable(&slub_debug_enabled);
1619 if ((static_branch_unlikely(&init_on_alloc) ||
1620 static_branch_unlikely(&init_on_free)) &&
1621 (slub_debug & SLAB_POISON))
1622 pr_info("mem auto-init: SLAB_POISON will take precedence over init_on_alloc/init_on_free\n");
1626 __setup("slub_debug", setup_slub_debug);
1629 * kmem_cache_flags - apply debugging options to the cache
1630 * @object_size: the size of an object without meta data
1631 * @flags: flags to set
1632 * @name: name of the cache
1634 * Debug option(s) are applied to @flags. In addition to the debug
1635 * option(s), if a slab name (or multiple) is specified i.e.
1636 * slub_debug=<Debug-Options>,<slab name1>,<slab name2> ...
1637 * then only the select slabs will receive the debug option(s).
1639 slab_flags_t kmem_cache_flags(unsigned int object_size,
1640 slab_flags_t flags, const char *name)
1645 slab_flags_t block_flags;
1646 slab_flags_t slub_debug_local = slub_debug;
1648 if (flags & SLAB_NO_USER_FLAGS)
1652 * If the slab cache is for debugging (e.g. kmemleak) then
1653 * don't store user (stack trace) information by default,
1654 * but let the user enable it via the command line below.
1656 if (flags & SLAB_NOLEAKTRACE)
1657 slub_debug_local &= ~SLAB_STORE_USER;
1660 next_block = slub_debug_string;
1661 /* Go through all blocks of debug options, see if any matches our slab's name */
1662 while (next_block) {
1663 next_block = parse_slub_debug_flags(next_block, &block_flags, &iter, false);
1666 /* Found a block that has a slab list, search it */
1671 end = strchrnul(iter, ',');
1672 if (next_block && next_block < end)
1673 end = next_block - 1;
1675 glob = strnchr(iter, end - iter, '*');
1677 cmplen = glob - iter;
1679 cmplen = max_t(size_t, len, (end - iter));
1681 if (!strncmp(name, iter, cmplen)) {
1682 flags |= block_flags;
1686 if (!*end || *end == ';')
1692 return flags | slub_debug_local;
1694 #else /* !CONFIG_SLUB_DEBUG */
1695 static inline void setup_object_debug(struct kmem_cache *s, void *object) {}
1697 void setup_slab_debug(struct kmem_cache *s, struct slab *slab, void *addr) {}
1699 static inline bool alloc_debug_processing(struct kmem_cache *s,
1700 struct slab *slab, void *object, int orig_size) { return true; }
1702 static inline bool free_debug_processing(struct kmem_cache *s,
1703 struct slab *slab, void *head, void *tail, int *bulk_cnt,
1704 unsigned long addr, depot_stack_handle_t handle) { return true; }
1706 static inline void slab_pad_check(struct kmem_cache *s, struct slab *slab) {}
1707 static inline int check_object(struct kmem_cache *s, struct slab *slab,
1708 void *object, u8 val) { return 1; }
1709 static inline depot_stack_handle_t set_track_prepare(void) { return 0; }
1710 static inline void set_track(struct kmem_cache *s, void *object,
1711 enum track_item alloc, unsigned long addr) {}
1712 static inline void add_full(struct kmem_cache *s, struct kmem_cache_node *n,
1713 struct slab *slab) {}
1714 static inline void remove_full(struct kmem_cache *s, struct kmem_cache_node *n,
1715 struct slab *slab) {}
1716 slab_flags_t kmem_cache_flags(unsigned int object_size,
1717 slab_flags_t flags, const char *name)
1721 #define slub_debug 0
1723 #define disable_higher_order_debug 0
1725 static inline unsigned long slabs_node(struct kmem_cache *s, int node)
1727 static inline unsigned long node_nr_slabs(struct kmem_cache_node *n)
1729 static inline void inc_slabs_node(struct kmem_cache *s, int node,
1731 static inline void dec_slabs_node(struct kmem_cache *s, int node,
1734 #ifndef CONFIG_SLUB_TINY
1735 static bool freelist_corrupted(struct kmem_cache *s, struct slab *slab,
1736 void **freelist, void *nextfree)
1741 #endif /* CONFIG_SLUB_DEBUG */
1744 * Hooks for other subsystems that check memory allocations. In a typical
1745 * production configuration these hooks all should produce no code at all.
1747 static __always_inline bool slab_free_hook(struct kmem_cache *s,
1750 kmemleak_free_recursive(x, s->flags);
1751 kmsan_slab_free(s, x);
1753 debug_check_no_locks_freed(x, s->object_size);
1755 if (!(s->flags & SLAB_DEBUG_OBJECTS))
1756 debug_check_no_obj_freed(x, s->object_size);
1758 /* Use KCSAN to help debug racy use-after-free. */
1759 if (!(s->flags & SLAB_TYPESAFE_BY_RCU))
1760 __kcsan_check_access(x, s->object_size,
1761 KCSAN_ACCESS_WRITE | KCSAN_ACCESS_ASSERT);
1764 * As memory initialization might be integrated into KASAN,
1765 * kasan_slab_free and initialization memset's must be
1766 * kept together to avoid discrepancies in behavior.
1768 * The initialization memset's clear the object and the metadata,
1769 * but don't touch the SLAB redzone.
1774 if (!kasan_has_integrated_init())
1775 memset(kasan_reset_tag(x), 0, s->object_size);
1776 rsize = (s->flags & SLAB_RED_ZONE) ? s->red_left_pad : 0;
1777 memset((char *)kasan_reset_tag(x) + s->inuse, 0,
1778 s->size - s->inuse - rsize);
1780 /* KASAN might put x into memory quarantine, delaying its reuse. */
1781 return kasan_slab_free(s, x, init);
1784 static inline bool slab_free_freelist_hook(struct kmem_cache *s,
1785 void **head, void **tail,
1791 void *old_tail = *tail ? *tail : *head;
1793 if (is_kfence_address(next)) {
1794 slab_free_hook(s, next, false);
1798 /* Head and tail of the reconstructed freelist */
1804 next = get_freepointer(s, object);
1806 /* If object's reuse doesn't have to be delayed */
1807 if (!slab_free_hook(s, object, slab_want_init_on_free(s))) {
1808 /* Move object to the new freelist */
1809 set_freepointer(s, object, *head);
1815 * Adjust the reconstructed freelist depth
1816 * accordingly if object's reuse is delayed.
1820 } while (object != old_tail);
1825 return *head != NULL;
1828 static void *setup_object(struct kmem_cache *s, void *object)
1830 setup_object_debug(s, object);
1831 object = kasan_init_slab_obj(s, object);
1832 if (unlikely(s->ctor)) {
1833 kasan_unpoison_object_data(s, object);
1835 kasan_poison_object_data(s, object);
1841 * Slab allocation and freeing
1843 static inline struct slab *alloc_slab_page(gfp_t flags, int node,
1844 struct kmem_cache_order_objects oo)
1846 struct folio *folio;
1848 unsigned int order = oo_order(oo);
1850 if (node == NUMA_NO_NODE)
1851 folio = (struct folio *)alloc_pages(flags, order);
1853 folio = (struct folio *)__alloc_pages_node(node, flags, order);
1858 slab = folio_slab(folio);
1859 __folio_set_slab(folio);
1860 /* Make the flag visible before any changes to folio->mapping */
1862 if (folio_is_pfmemalloc(folio))
1863 slab_set_pfmemalloc(slab);
1868 #ifdef CONFIG_SLAB_FREELIST_RANDOM
1869 /* Pre-initialize the random sequence cache */
1870 static int init_cache_random_seq(struct kmem_cache *s)
1872 unsigned int count = oo_objects(s->oo);
1875 /* Bailout if already initialised */
1879 err = cache_random_seq_create(s, count, GFP_KERNEL);
1881 pr_err("SLUB: Unable to initialize free list for %s\n",
1886 /* Transform to an offset on the set of pages */
1887 if (s->random_seq) {
1890 for (i = 0; i < count; i++)
1891 s->random_seq[i] *= s->size;
1896 /* Initialize each random sequence freelist per cache */
1897 static void __init init_freelist_randomization(void)
1899 struct kmem_cache *s;
1901 mutex_lock(&slab_mutex);
1903 list_for_each_entry(s, &slab_caches, list)
1904 init_cache_random_seq(s);
1906 mutex_unlock(&slab_mutex);
1909 /* Get the next entry on the pre-computed freelist randomized */
1910 static void *next_freelist_entry(struct kmem_cache *s, struct slab *slab,
1911 unsigned long *pos, void *start,
1912 unsigned long page_limit,
1913 unsigned long freelist_count)
1918 * If the target page allocation failed, the number of objects on the
1919 * page might be smaller than the usual size defined by the cache.
1922 idx = s->random_seq[*pos];
1924 if (*pos >= freelist_count)
1926 } while (unlikely(idx >= page_limit));
1928 return (char *)start + idx;
1931 /* Shuffle the single linked freelist based on a random pre-computed sequence */
1932 static bool shuffle_freelist(struct kmem_cache *s, struct slab *slab)
1937 unsigned long idx, pos, page_limit, freelist_count;
1939 if (slab->objects < 2 || !s->random_seq)
1942 freelist_count = oo_objects(s->oo);
1943 pos = get_random_u32_below(freelist_count);
1945 page_limit = slab->objects * s->size;
1946 start = fixup_red_left(s, slab_address(slab));
1948 /* First entry is used as the base of the freelist */
1949 cur = next_freelist_entry(s, slab, &pos, start, page_limit,
1951 cur = setup_object(s, cur);
1952 slab->freelist = cur;
1954 for (idx = 1; idx < slab->objects; idx++) {
1955 next = next_freelist_entry(s, slab, &pos, start, page_limit,
1957 next = setup_object(s, next);
1958 set_freepointer(s, cur, next);
1961 set_freepointer(s, cur, NULL);
1966 static inline int init_cache_random_seq(struct kmem_cache *s)
1970 static inline void init_freelist_randomization(void) { }
1971 static inline bool shuffle_freelist(struct kmem_cache *s, struct slab *slab)
1975 #endif /* CONFIG_SLAB_FREELIST_RANDOM */
1977 static struct slab *allocate_slab(struct kmem_cache *s, gfp_t flags, int node)
1980 struct kmem_cache_order_objects oo = s->oo;
1982 void *start, *p, *next;
1986 flags &= gfp_allowed_mask;
1988 flags |= s->allocflags;
1991 * Let the initial higher-order allocation fail under memory pressure
1992 * so we fall-back to the minimum order allocation.
1994 alloc_gfp = (flags | __GFP_NOWARN | __GFP_NORETRY) & ~__GFP_NOFAIL;
1995 if ((alloc_gfp & __GFP_DIRECT_RECLAIM) && oo_order(oo) > oo_order(s->min))
1996 alloc_gfp = (alloc_gfp | __GFP_NOMEMALLOC) & ~__GFP_RECLAIM;
1998 slab = alloc_slab_page(alloc_gfp, node, oo);
1999 if (unlikely(!slab)) {
2003 * Allocation may have failed due to fragmentation.
2004 * Try a lower order alloc if possible
2006 slab = alloc_slab_page(alloc_gfp, node, oo);
2007 if (unlikely(!slab))
2009 stat(s, ORDER_FALLBACK);
2012 slab->objects = oo_objects(oo);
2016 account_slab(slab, oo_order(oo), s, flags);
2018 slab->slab_cache = s;
2020 kasan_poison_slab(slab);
2022 start = slab_address(slab);
2024 setup_slab_debug(s, slab, start);
2026 shuffle = shuffle_freelist(s, slab);
2029 start = fixup_red_left(s, start);
2030 start = setup_object(s, start);
2031 slab->freelist = start;
2032 for (idx = 0, p = start; idx < slab->objects - 1; idx++) {
2034 next = setup_object(s, next);
2035 set_freepointer(s, p, next);
2038 set_freepointer(s, p, NULL);
2044 static struct slab *new_slab(struct kmem_cache *s, gfp_t flags, int node)
2046 if (unlikely(flags & GFP_SLAB_BUG_MASK))
2047 flags = kmalloc_fix_flags(flags);
2049 WARN_ON_ONCE(s->ctor && (flags & __GFP_ZERO));
2051 return allocate_slab(s,
2052 flags & (GFP_RECLAIM_MASK | GFP_CONSTRAINT_MASK), node);
2055 static void __free_slab(struct kmem_cache *s, struct slab *slab)
2057 struct folio *folio = slab_folio(slab);
2058 int order = folio_order(folio);
2059 int pages = 1 << order;
2061 __slab_clear_pfmemalloc(slab);
2062 folio->mapping = NULL;
2063 /* Make the mapping reset visible before clearing the flag */
2065 __folio_clear_slab(folio);
2066 if (current->reclaim_state)
2067 current->reclaim_state->reclaimed_slab += pages;
2068 unaccount_slab(slab, order, s);
2069 __free_pages(&folio->page, order);
2072 static void rcu_free_slab(struct rcu_head *h)
2074 struct slab *slab = container_of(h, struct slab, rcu_head);
2076 __free_slab(slab->slab_cache, slab);
2079 static void free_slab(struct kmem_cache *s, struct slab *slab)
2081 if (kmem_cache_debug_flags(s, SLAB_CONSISTENCY_CHECKS)) {
2084 slab_pad_check(s, slab);
2085 for_each_object(p, s, slab_address(slab), slab->objects)
2086 check_object(s, slab, p, SLUB_RED_INACTIVE);
2089 if (unlikely(s->flags & SLAB_TYPESAFE_BY_RCU))
2090 call_rcu(&slab->rcu_head, rcu_free_slab);
2092 __free_slab(s, slab);
2095 static void discard_slab(struct kmem_cache *s, struct slab *slab)
2097 dec_slabs_node(s, slab_nid(slab), slab->objects);
2102 * Management of partially allocated slabs.
2105 __add_partial(struct kmem_cache_node *n, struct slab *slab, int tail)
2108 if (tail == DEACTIVATE_TO_TAIL)
2109 list_add_tail(&slab->slab_list, &n->partial);
2111 list_add(&slab->slab_list, &n->partial);
2114 static inline void add_partial(struct kmem_cache_node *n,
2115 struct slab *slab, int tail)
2117 lockdep_assert_held(&n->list_lock);
2118 __add_partial(n, slab, tail);
2121 static inline void remove_partial(struct kmem_cache_node *n,
2124 lockdep_assert_held(&n->list_lock);
2125 list_del(&slab->slab_list);
2130 * Called only for kmem_cache_debug() caches instead of acquire_slab(), with a
2131 * slab from the n->partial list. Remove only a single object from the slab, do
2132 * the alloc_debug_processing() checks and leave the slab on the list, or move
2133 * it to full list if it was the last free object.
2135 static void *alloc_single_from_partial(struct kmem_cache *s,
2136 struct kmem_cache_node *n, struct slab *slab, int orig_size)
2140 lockdep_assert_held(&n->list_lock);
2142 object = slab->freelist;
2143 slab->freelist = get_freepointer(s, object);
2146 if (!alloc_debug_processing(s, slab, object, orig_size)) {
2147 remove_partial(n, slab);
2151 if (slab->inuse == slab->objects) {
2152 remove_partial(n, slab);
2153 add_full(s, n, slab);
2160 * Called only for kmem_cache_debug() caches to allocate from a freshly
2161 * allocated slab. Allocate a single object instead of whole freelist
2162 * and put the slab to the partial (or full) list.
2164 static void *alloc_single_from_new_slab(struct kmem_cache *s,
2165 struct slab *slab, int orig_size)
2167 int nid = slab_nid(slab);
2168 struct kmem_cache_node *n = get_node(s, nid);
2169 unsigned long flags;
2173 object = slab->freelist;
2174 slab->freelist = get_freepointer(s, object);
2177 if (!alloc_debug_processing(s, slab, object, orig_size))
2179 * It's not really expected that this would fail on a
2180 * freshly allocated slab, but a concurrent memory
2181 * corruption in theory could cause that.
2185 spin_lock_irqsave(&n->list_lock, flags);
2187 if (slab->inuse == slab->objects)
2188 add_full(s, n, slab);
2190 add_partial(n, slab, DEACTIVATE_TO_HEAD);
2192 inc_slabs_node(s, nid, slab->objects);
2193 spin_unlock_irqrestore(&n->list_lock, flags);
2199 * Remove slab from the partial list, freeze it and
2200 * return the pointer to the freelist.
2202 * Returns a list of objects or NULL if it fails.
2204 static inline void *acquire_slab(struct kmem_cache *s,
2205 struct kmem_cache_node *n, struct slab *slab,
2209 unsigned long counters;
2212 lockdep_assert_held(&n->list_lock);
2215 * Zap the freelist and set the frozen bit.
2216 * The old freelist is the list of objects for the
2217 * per cpu allocation list.
2219 freelist = slab->freelist;
2220 counters = slab->counters;
2221 new.counters = counters;
2223 new.inuse = slab->objects;
2224 new.freelist = NULL;
2226 new.freelist = freelist;
2229 VM_BUG_ON(new.frozen);
2232 if (!__cmpxchg_double_slab(s, slab,
2234 new.freelist, new.counters,
2238 remove_partial(n, slab);
2243 #ifdef CONFIG_SLUB_CPU_PARTIAL
2244 static void put_cpu_partial(struct kmem_cache *s, struct slab *slab, int drain);
2246 static inline void put_cpu_partial(struct kmem_cache *s, struct slab *slab,
2249 static inline bool pfmemalloc_match(struct slab *slab, gfp_t gfpflags);
2252 * Try to allocate a partial slab from a specific node.
2254 static void *get_partial_node(struct kmem_cache *s, struct kmem_cache_node *n,
2255 struct partial_context *pc)
2257 struct slab *slab, *slab2;
2258 void *object = NULL;
2259 unsigned long flags;
2260 unsigned int partial_slabs = 0;
2263 * Racy check. If we mistakenly see no partial slabs then we
2264 * just allocate an empty slab. If we mistakenly try to get a
2265 * partial slab and there is none available then get_partial()
2268 if (!n || !n->nr_partial)
2271 spin_lock_irqsave(&n->list_lock, flags);
2272 list_for_each_entry_safe(slab, slab2, &n->partial, slab_list) {
2275 if (!pfmemalloc_match(slab, pc->flags))
2278 if (IS_ENABLED(CONFIG_SLUB_TINY) || kmem_cache_debug(s)) {
2279 object = alloc_single_from_partial(s, n, slab,
2286 t = acquire_slab(s, n, slab, object == NULL);
2292 stat(s, ALLOC_FROM_PARTIAL);
2295 put_cpu_partial(s, slab, 0);
2296 stat(s, CPU_PARTIAL_NODE);
2299 #ifdef CONFIG_SLUB_CPU_PARTIAL
2300 if (!kmem_cache_has_cpu_partial(s)
2301 || partial_slabs > s->cpu_partial_slabs / 2)
2308 spin_unlock_irqrestore(&n->list_lock, flags);
2313 * Get a slab from somewhere. Search in increasing NUMA distances.
2315 static void *get_any_partial(struct kmem_cache *s, struct partial_context *pc)
2318 struct zonelist *zonelist;
2321 enum zone_type highest_zoneidx = gfp_zone(pc->flags);
2323 unsigned int cpuset_mems_cookie;
2326 * The defrag ratio allows a configuration of the tradeoffs between
2327 * inter node defragmentation and node local allocations. A lower
2328 * defrag_ratio increases the tendency to do local allocations
2329 * instead of attempting to obtain partial slabs from other nodes.
2331 * If the defrag_ratio is set to 0 then kmalloc() always
2332 * returns node local objects. If the ratio is higher then kmalloc()
2333 * may return off node objects because partial slabs are obtained
2334 * from other nodes and filled up.
2336 * If /sys/kernel/slab/xx/remote_node_defrag_ratio is set to 100
2337 * (which makes defrag_ratio = 1000) then every (well almost)
2338 * allocation will first attempt to defrag slab caches on other nodes.
2339 * This means scanning over all nodes to look for partial slabs which
2340 * may be expensive if we do it every time we are trying to find a slab
2341 * with available objects.
2343 if (!s->remote_node_defrag_ratio ||
2344 get_cycles() % 1024 > s->remote_node_defrag_ratio)
2348 cpuset_mems_cookie = read_mems_allowed_begin();
2349 zonelist = node_zonelist(mempolicy_slab_node(), pc->flags);
2350 for_each_zone_zonelist(zone, z, zonelist, highest_zoneidx) {
2351 struct kmem_cache_node *n;
2353 n = get_node(s, zone_to_nid(zone));
2355 if (n && cpuset_zone_allowed(zone, pc->flags) &&
2356 n->nr_partial > s->min_partial) {
2357 object = get_partial_node(s, n, pc);
2360 * Don't check read_mems_allowed_retry()
2361 * here - if mems_allowed was updated in
2362 * parallel, that was a harmless race
2363 * between allocation and the cpuset
2370 } while (read_mems_allowed_retry(cpuset_mems_cookie));
2371 #endif /* CONFIG_NUMA */
2376 * Get a partial slab, lock it and return it.
2378 static void *get_partial(struct kmem_cache *s, int node, struct partial_context *pc)
2381 int searchnode = node;
2383 if (node == NUMA_NO_NODE)
2384 searchnode = numa_mem_id();
2386 object = get_partial_node(s, get_node(s, searchnode), pc);
2387 if (object || node != NUMA_NO_NODE)
2390 return get_any_partial(s, pc);
2393 #ifndef CONFIG_SLUB_TINY
2395 #ifdef CONFIG_PREEMPTION
2397 * Calculate the next globally unique transaction for disambiguation
2398 * during cmpxchg. The transactions start with the cpu number and are then
2399 * incremented by CONFIG_NR_CPUS.
2401 #define TID_STEP roundup_pow_of_two(CONFIG_NR_CPUS)
2404 * No preemption supported therefore also no need to check for
2408 #endif /* CONFIG_PREEMPTION */
2410 static inline unsigned long next_tid(unsigned long tid)
2412 return tid + TID_STEP;
2415 #ifdef SLUB_DEBUG_CMPXCHG
2416 static inline unsigned int tid_to_cpu(unsigned long tid)
2418 return tid % TID_STEP;
2421 static inline unsigned long tid_to_event(unsigned long tid)
2423 return tid / TID_STEP;
2427 static inline unsigned int init_tid(int cpu)
2432 static inline void note_cmpxchg_failure(const char *n,
2433 const struct kmem_cache *s, unsigned long tid)
2435 #ifdef SLUB_DEBUG_CMPXCHG
2436 unsigned long actual_tid = __this_cpu_read(s->cpu_slab->tid);
2438 pr_info("%s %s: cmpxchg redo ", n, s->name);
2440 #ifdef CONFIG_PREEMPTION
2441 if (tid_to_cpu(tid) != tid_to_cpu(actual_tid))
2442 pr_warn("due to cpu change %d -> %d\n",
2443 tid_to_cpu(tid), tid_to_cpu(actual_tid));
2446 if (tid_to_event(tid) != tid_to_event(actual_tid))
2447 pr_warn("due to cpu running other code. Event %ld->%ld\n",
2448 tid_to_event(tid), tid_to_event(actual_tid));
2450 pr_warn("for unknown reason: actual=%lx was=%lx target=%lx\n",
2451 actual_tid, tid, next_tid(tid));
2453 stat(s, CMPXCHG_DOUBLE_CPU_FAIL);
2456 static void init_kmem_cache_cpus(struct kmem_cache *s)
2459 struct kmem_cache_cpu *c;
2461 for_each_possible_cpu(cpu) {
2462 c = per_cpu_ptr(s->cpu_slab, cpu);
2463 local_lock_init(&c->lock);
2464 c->tid = init_tid(cpu);
2469 * Finishes removing the cpu slab. Merges cpu's freelist with slab's freelist,
2470 * unfreezes the slabs and puts it on the proper list.
2471 * Assumes the slab has been already safely taken away from kmem_cache_cpu
2474 static void deactivate_slab(struct kmem_cache *s, struct slab *slab,
2477 enum slab_modes { M_NONE, M_PARTIAL, M_FREE, M_FULL_NOLIST };
2478 struct kmem_cache_node *n = get_node(s, slab_nid(slab));
2480 enum slab_modes mode = M_NONE;
2481 void *nextfree, *freelist_iter, *freelist_tail;
2482 int tail = DEACTIVATE_TO_HEAD;
2483 unsigned long flags = 0;
2487 if (slab->freelist) {
2488 stat(s, DEACTIVATE_REMOTE_FREES);
2489 tail = DEACTIVATE_TO_TAIL;
2493 * Stage one: Count the objects on cpu's freelist as free_delta and
2494 * remember the last object in freelist_tail for later splicing.
2496 freelist_tail = NULL;
2497 freelist_iter = freelist;
2498 while (freelist_iter) {
2499 nextfree = get_freepointer(s, freelist_iter);
2502 * If 'nextfree' is invalid, it is possible that the object at
2503 * 'freelist_iter' is already corrupted. So isolate all objects
2504 * starting at 'freelist_iter' by skipping them.
2506 if (freelist_corrupted(s, slab, &freelist_iter, nextfree))
2509 freelist_tail = freelist_iter;
2512 freelist_iter = nextfree;
2516 * Stage two: Unfreeze the slab while splicing the per-cpu
2517 * freelist to the head of slab's freelist.
2519 * Ensure that the slab is unfrozen while the list presence
2520 * reflects the actual number of objects during unfreeze.
2522 * We first perform cmpxchg holding lock and insert to list
2523 * when it succeed. If there is mismatch then the slab is not
2524 * unfrozen and number of objects in the slab may have changed.
2525 * Then release lock and retry cmpxchg again.
2529 old.freelist = READ_ONCE(slab->freelist);
2530 old.counters = READ_ONCE(slab->counters);
2531 VM_BUG_ON(!old.frozen);
2533 /* Determine target state of the slab */
2534 new.counters = old.counters;
2535 if (freelist_tail) {
2536 new.inuse -= free_delta;
2537 set_freepointer(s, freelist_tail, old.freelist);
2538 new.freelist = freelist;
2540 new.freelist = old.freelist;
2544 if (!new.inuse && n->nr_partial >= s->min_partial) {
2546 } else if (new.freelist) {
2549 * Taking the spinlock removes the possibility that
2550 * acquire_slab() will see a slab that is frozen
2552 spin_lock_irqsave(&n->list_lock, flags);
2554 mode = M_FULL_NOLIST;
2558 if (!cmpxchg_double_slab(s, slab,
2559 old.freelist, old.counters,
2560 new.freelist, new.counters,
2561 "unfreezing slab")) {
2562 if (mode == M_PARTIAL)
2563 spin_unlock_irqrestore(&n->list_lock, flags);
2568 if (mode == M_PARTIAL) {
2569 add_partial(n, slab, tail);
2570 spin_unlock_irqrestore(&n->list_lock, flags);
2572 } else if (mode == M_FREE) {
2573 stat(s, DEACTIVATE_EMPTY);
2574 discard_slab(s, slab);
2576 } else if (mode == M_FULL_NOLIST) {
2577 stat(s, DEACTIVATE_FULL);
2581 #ifdef CONFIG_SLUB_CPU_PARTIAL
2582 static void __unfreeze_partials(struct kmem_cache *s, struct slab *partial_slab)
2584 struct kmem_cache_node *n = NULL, *n2 = NULL;
2585 struct slab *slab, *slab_to_discard = NULL;
2586 unsigned long flags = 0;
2588 while (partial_slab) {
2592 slab = partial_slab;
2593 partial_slab = slab->next;
2595 n2 = get_node(s, slab_nid(slab));
2598 spin_unlock_irqrestore(&n->list_lock, flags);
2601 spin_lock_irqsave(&n->list_lock, flags);
2606 old.freelist = slab->freelist;
2607 old.counters = slab->counters;
2608 VM_BUG_ON(!old.frozen);
2610 new.counters = old.counters;
2611 new.freelist = old.freelist;
2615 } while (!__cmpxchg_double_slab(s, slab,
2616 old.freelist, old.counters,
2617 new.freelist, new.counters,
2618 "unfreezing slab"));
2620 if (unlikely(!new.inuse && n->nr_partial >= s->min_partial)) {
2621 slab->next = slab_to_discard;
2622 slab_to_discard = slab;
2624 add_partial(n, slab, DEACTIVATE_TO_TAIL);
2625 stat(s, FREE_ADD_PARTIAL);
2630 spin_unlock_irqrestore(&n->list_lock, flags);
2632 while (slab_to_discard) {
2633 slab = slab_to_discard;
2634 slab_to_discard = slab_to_discard->next;
2636 stat(s, DEACTIVATE_EMPTY);
2637 discard_slab(s, slab);
2643 * Unfreeze all the cpu partial slabs.
2645 static void unfreeze_partials(struct kmem_cache *s)
2647 struct slab *partial_slab;
2648 unsigned long flags;
2650 local_lock_irqsave(&s->cpu_slab->lock, flags);
2651 partial_slab = this_cpu_read(s->cpu_slab->partial);
2652 this_cpu_write(s->cpu_slab->partial, NULL);
2653 local_unlock_irqrestore(&s->cpu_slab->lock, flags);
2656 __unfreeze_partials(s, partial_slab);
2659 static void unfreeze_partials_cpu(struct kmem_cache *s,
2660 struct kmem_cache_cpu *c)
2662 struct slab *partial_slab;
2664 partial_slab = slub_percpu_partial(c);
2668 __unfreeze_partials(s, partial_slab);
2672 * Put a slab that was just frozen (in __slab_free|get_partial_node) into a
2673 * partial slab slot if available.
2675 * If we did not find a slot then simply move all the partials to the
2676 * per node partial list.
2678 static void put_cpu_partial(struct kmem_cache *s, struct slab *slab, int drain)
2680 struct slab *oldslab;
2681 struct slab *slab_to_unfreeze = NULL;
2682 unsigned long flags;
2685 local_lock_irqsave(&s->cpu_slab->lock, flags);
2687 oldslab = this_cpu_read(s->cpu_slab->partial);
2690 if (drain && oldslab->slabs >= s->cpu_partial_slabs) {
2692 * Partial array is full. Move the existing set to the
2693 * per node partial list. Postpone the actual unfreezing
2694 * outside of the critical section.
2696 slab_to_unfreeze = oldslab;
2699 slabs = oldslab->slabs;
2705 slab->slabs = slabs;
2706 slab->next = oldslab;
2708 this_cpu_write(s->cpu_slab->partial, slab);
2710 local_unlock_irqrestore(&s->cpu_slab->lock, flags);
2712 if (slab_to_unfreeze) {
2713 __unfreeze_partials(s, slab_to_unfreeze);
2714 stat(s, CPU_PARTIAL_DRAIN);
2718 #else /* CONFIG_SLUB_CPU_PARTIAL */
2720 static inline void unfreeze_partials(struct kmem_cache *s) { }
2721 static inline void unfreeze_partials_cpu(struct kmem_cache *s,
2722 struct kmem_cache_cpu *c) { }
2724 #endif /* CONFIG_SLUB_CPU_PARTIAL */
2726 static inline void flush_slab(struct kmem_cache *s, struct kmem_cache_cpu *c)
2728 unsigned long flags;
2732 local_lock_irqsave(&s->cpu_slab->lock, flags);
2735 freelist = c->freelist;
2739 c->tid = next_tid(c->tid);
2741 local_unlock_irqrestore(&s->cpu_slab->lock, flags);
2744 deactivate_slab(s, slab, freelist);
2745 stat(s, CPUSLAB_FLUSH);
2749 static inline void __flush_cpu_slab(struct kmem_cache *s, int cpu)
2751 struct kmem_cache_cpu *c = per_cpu_ptr(s->cpu_slab, cpu);
2752 void *freelist = c->freelist;
2753 struct slab *slab = c->slab;
2757 c->tid = next_tid(c->tid);
2760 deactivate_slab(s, slab, freelist);
2761 stat(s, CPUSLAB_FLUSH);
2764 unfreeze_partials_cpu(s, c);
2767 struct slub_flush_work {
2768 struct work_struct work;
2769 struct kmem_cache *s;
2776 * Called from CPU work handler with migration disabled.
2778 static void flush_cpu_slab(struct work_struct *w)
2780 struct kmem_cache *s;
2781 struct kmem_cache_cpu *c;
2782 struct slub_flush_work *sfw;
2784 sfw = container_of(w, struct slub_flush_work, work);
2787 c = this_cpu_ptr(s->cpu_slab);
2792 unfreeze_partials(s);
2795 static bool has_cpu_slab(int cpu, struct kmem_cache *s)
2797 struct kmem_cache_cpu *c = per_cpu_ptr(s->cpu_slab, cpu);
2799 return c->slab || slub_percpu_partial(c);
2802 static DEFINE_MUTEX(flush_lock);
2803 static DEFINE_PER_CPU(struct slub_flush_work, slub_flush);
2805 static void flush_all_cpus_locked(struct kmem_cache *s)
2807 struct slub_flush_work *sfw;
2810 lockdep_assert_cpus_held();
2811 mutex_lock(&flush_lock);
2813 for_each_online_cpu(cpu) {
2814 sfw = &per_cpu(slub_flush, cpu);
2815 if (!has_cpu_slab(cpu, s)) {
2819 INIT_WORK(&sfw->work, flush_cpu_slab);
2822 queue_work_on(cpu, flushwq, &sfw->work);
2825 for_each_online_cpu(cpu) {
2826 sfw = &per_cpu(slub_flush, cpu);
2829 flush_work(&sfw->work);
2832 mutex_unlock(&flush_lock);
2835 static void flush_all(struct kmem_cache *s)
2838 flush_all_cpus_locked(s);
2843 * Use the cpu notifier to insure that the cpu slabs are flushed when
2846 static int slub_cpu_dead(unsigned int cpu)
2848 struct kmem_cache *s;
2850 mutex_lock(&slab_mutex);
2851 list_for_each_entry(s, &slab_caches, list)
2852 __flush_cpu_slab(s, cpu);
2853 mutex_unlock(&slab_mutex);
2857 #else /* CONFIG_SLUB_TINY */
2858 static inline void flush_all_cpus_locked(struct kmem_cache *s) { }
2859 static inline void flush_all(struct kmem_cache *s) { }
2860 static inline void __flush_cpu_slab(struct kmem_cache *s, int cpu) { }
2861 static inline int slub_cpu_dead(unsigned int cpu) { return 0; }
2862 #endif /* CONFIG_SLUB_TINY */
2865 * Check if the objects in a per cpu structure fit numa
2866 * locality expectations.
2868 static inline int node_match(struct slab *slab, int node)
2871 if (node != NUMA_NO_NODE && slab_nid(slab) != node)
2877 #ifdef CONFIG_SLUB_DEBUG
2878 static int count_free(struct slab *slab)
2880 return slab->objects - slab->inuse;
2883 static inline unsigned long node_nr_objs(struct kmem_cache_node *n)
2885 return atomic_long_read(&n->total_objects);
2888 /* Supports checking bulk free of a constructed freelist */
2889 static inline bool free_debug_processing(struct kmem_cache *s,
2890 struct slab *slab, void *head, void *tail, int *bulk_cnt,
2891 unsigned long addr, depot_stack_handle_t handle)
2893 bool checks_ok = false;
2894 void *object = head;
2897 if (s->flags & SLAB_CONSISTENCY_CHECKS) {
2898 if (!check_slab(s, slab))
2902 if (slab->inuse < *bulk_cnt) {
2903 slab_err(s, slab, "Slab has %d allocated objects but %d are to be freed\n",
2904 slab->inuse, *bulk_cnt);
2910 if (++cnt > *bulk_cnt)
2913 if (s->flags & SLAB_CONSISTENCY_CHECKS) {
2914 if (!free_consistency_checks(s, slab, object, addr))
2918 if (s->flags & SLAB_STORE_USER)
2919 set_track_update(s, object, TRACK_FREE, addr, handle);
2920 trace(s, slab, object, 0);
2921 /* Freepointer not overwritten by init_object(), SLAB_POISON moved it */
2922 init_object(s, object, SLUB_RED_INACTIVE);
2924 /* Reached end of constructed freelist yet? */
2925 if (object != tail) {
2926 object = get_freepointer(s, object);
2932 if (cnt != *bulk_cnt) {
2933 slab_err(s, slab, "Bulk free expected %d objects but found %d\n",
2941 slab_fix(s, "Object at 0x%p not freed", object);
2945 #endif /* CONFIG_SLUB_DEBUG */
2947 #if defined(CONFIG_SLUB_DEBUG) || defined(SLAB_SUPPORTS_SYSFS)
2948 static unsigned long count_partial(struct kmem_cache_node *n,
2949 int (*get_count)(struct slab *))
2951 unsigned long flags;
2952 unsigned long x = 0;
2955 spin_lock_irqsave(&n->list_lock, flags);
2956 list_for_each_entry(slab, &n->partial, slab_list)
2957 x += get_count(slab);
2958 spin_unlock_irqrestore(&n->list_lock, flags);
2961 #endif /* CONFIG_SLUB_DEBUG || SLAB_SUPPORTS_SYSFS */
2963 #ifdef CONFIG_SLUB_DEBUG
2964 static noinline void
2965 slab_out_of_memory(struct kmem_cache *s, gfp_t gfpflags, int nid)
2967 static DEFINE_RATELIMIT_STATE(slub_oom_rs, DEFAULT_RATELIMIT_INTERVAL,
2968 DEFAULT_RATELIMIT_BURST);
2970 struct kmem_cache_node *n;
2972 if ((gfpflags & __GFP_NOWARN) || !__ratelimit(&slub_oom_rs))
2975 pr_warn("SLUB: Unable to allocate memory on node %d, gfp=%#x(%pGg)\n",
2976 nid, gfpflags, &gfpflags);
2977 pr_warn(" cache: %s, object size: %u, buffer size: %u, default order: %u, min order: %u\n",
2978 s->name, s->object_size, s->size, oo_order(s->oo),
2981 if (oo_order(s->min) > get_order(s->object_size))
2982 pr_warn(" %s debugging increased min order, use slub_debug=O to disable.\n",
2985 for_each_kmem_cache_node(s, node, n) {
2986 unsigned long nr_slabs;
2987 unsigned long nr_objs;
2988 unsigned long nr_free;
2990 nr_free = count_partial(n, count_free);
2991 nr_slabs = node_nr_slabs(n);
2992 nr_objs = node_nr_objs(n);
2994 pr_warn(" node %d: slabs: %ld, objs: %ld, free: %ld\n",
2995 node, nr_slabs, nr_objs, nr_free);
2998 #else /* CONFIG_SLUB_DEBUG */
3000 slab_out_of_memory(struct kmem_cache *s, gfp_t gfpflags, int nid) { }
3003 static inline bool pfmemalloc_match(struct slab *slab, gfp_t gfpflags)
3005 if (unlikely(slab_test_pfmemalloc(slab)))
3006 return gfp_pfmemalloc_allowed(gfpflags);
3011 #ifndef CONFIG_SLUB_TINY
3013 * Check the slab->freelist and either transfer the freelist to the
3014 * per cpu freelist or deactivate the slab.
3016 * The slab is still frozen if the return value is not NULL.
3018 * If this function returns NULL then the slab has been unfrozen.
3020 static inline void *get_freelist(struct kmem_cache *s, struct slab *slab)
3023 unsigned long counters;
3026 lockdep_assert_held(this_cpu_ptr(&s->cpu_slab->lock));
3029 freelist = slab->freelist;
3030 counters = slab->counters;
3032 new.counters = counters;
3033 VM_BUG_ON(!new.frozen);
3035 new.inuse = slab->objects;
3036 new.frozen = freelist != NULL;
3038 } while (!__cmpxchg_double_slab(s, slab,
3047 * Slow path. The lockless freelist is empty or we need to perform
3050 * Processing is still very fast if new objects have been freed to the
3051 * regular freelist. In that case we simply take over the regular freelist
3052 * as the lockless freelist and zap the regular freelist.
3054 * If that is not working then we fall back to the partial lists. We take the
3055 * first element of the freelist as the object to allocate now and move the
3056 * rest of the freelist to the lockless freelist.
3058 * And if we were unable to get a new slab from the partial slab lists then
3059 * we need to allocate a new slab. This is the slowest path since it involves
3060 * a call to the page allocator and the setup of a new slab.
3062 * Version of __slab_alloc to use when we know that preemption is
3063 * already disabled (which is the case for bulk allocation).
3065 static void *___slab_alloc(struct kmem_cache *s, gfp_t gfpflags, int node,
3066 unsigned long addr, struct kmem_cache_cpu *c, unsigned int orig_size)
3070 unsigned long flags;
3071 struct partial_context pc;
3073 stat(s, ALLOC_SLOWPATH);
3077 slab = READ_ONCE(c->slab);
3080 * if the node is not online or has no normal memory, just
3081 * ignore the node constraint
3083 if (unlikely(node != NUMA_NO_NODE &&
3084 !node_isset(node, slab_nodes)))
3085 node = NUMA_NO_NODE;
3090 if (unlikely(!node_match(slab, node))) {
3092 * same as above but node_match() being false already
3093 * implies node != NUMA_NO_NODE
3095 if (!node_isset(node, slab_nodes)) {
3096 node = NUMA_NO_NODE;
3098 stat(s, ALLOC_NODE_MISMATCH);
3099 goto deactivate_slab;
3104 * By rights, we should be searching for a slab page that was
3105 * PFMEMALLOC but right now, we are losing the pfmemalloc
3106 * information when the page leaves the per-cpu allocator
3108 if (unlikely(!pfmemalloc_match(slab, gfpflags)))
3109 goto deactivate_slab;
3111 /* must check again c->slab in case we got preempted and it changed */
3112 local_lock_irqsave(&s->cpu_slab->lock, flags);
3113 if (unlikely(slab != c->slab)) {
3114 local_unlock_irqrestore(&s->cpu_slab->lock, flags);
3117 freelist = c->freelist;
3121 freelist = get_freelist(s, slab);
3125 c->tid = next_tid(c->tid);
3126 local_unlock_irqrestore(&s->cpu_slab->lock, flags);
3127 stat(s, DEACTIVATE_BYPASS);
3131 stat(s, ALLOC_REFILL);
3135 lockdep_assert_held(this_cpu_ptr(&s->cpu_slab->lock));
3138 * freelist is pointing to the list of objects to be used.
3139 * slab is pointing to the slab from which the objects are obtained.
3140 * That slab must be frozen for per cpu allocations to work.
3142 VM_BUG_ON(!c->slab->frozen);
3143 c->freelist = get_freepointer(s, freelist);
3144 c->tid = next_tid(c->tid);
3145 local_unlock_irqrestore(&s->cpu_slab->lock, flags);
3150 local_lock_irqsave(&s->cpu_slab->lock, flags);
3151 if (slab != c->slab) {
3152 local_unlock_irqrestore(&s->cpu_slab->lock, flags);
3155 freelist = c->freelist;
3158 c->tid = next_tid(c->tid);
3159 local_unlock_irqrestore(&s->cpu_slab->lock, flags);
3160 deactivate_slab(s, slab, freelist);
3164 if (slub_percpu_partial(c)) {
3165 local_lock_irqsave(&s->cpu_slab->lock, flags);
3166 if (unlikely(c->slab)) {
3167 local_unlock_irqrestore(&s->cpu_slab->lock, flags);
3170 if (unlikely(!slub_percpu_partial(c))) {
3171 local_unlock_irqrestore(&s->cpu_slab->lock, flags);
3172 /* we were preempted and partial list got empty */
3176 slab = c->slab = slub_percpu_partial(c);
3177 slub_set_percpu_partial(c, slab);
3178 local_unlock_irqrestore(&s->cpu_slab->lock, flags);
3179 stat(s, CPU_PARTIAL_ALLOC);
3185 pc.flags = gfpflags;
3187 pc.orig_size = orig_size;
3188 freelist = get_partial(s, node, &pc);
3190 goto check_new_slab;
3192 slub_put_cpu_ptr(s->cpu_slab);
3193 slab = new_slab(s, gfpflags, node);
3194 c = slub_get_cpu_ptr(s->cpu_slab);
3196 if (unlikely(!slab)) {
3197 slab_out_of_memory(s, gfpflags, node);
3201 stat(s, ALLOC_SLAB);
3203 if (kmem_cache_debug(s)) {
3204 freelist = alloc_single_from_new_slab(s, slab, orig_size);
3206 if (unlikely(!freelist))
3209 if (s->flags & SLAB_STORE_USER)
3210 set_track(s, freelist, TRACK_ALLOC, addr);
3216 * No other reference to the slab yet so we can
3217 * muck around with it freely without cmpxchg
3219 freelist = slab->freelist;
3220 slab->freelist = NULL;
3221 slab->inuse = slab->objects;
3224 inc_slabs_node(s, slab_nid(slab), slab->objects);
3228 if (kmem_cache_debug(s)) {
3230 * For debug caches here we had to go through
3231 * alloc_single_from_partial() so just store the tracking info
3232 * and return the object
3234 if (s->flags & SLAB_STORE_USER)
3235 set_track(s, freelist, TRACK_ALLOC, addr);
3240 if (unlikely(!pfmemalloc_match(slab, gfpflags))) {
3242 * For !pfmemalloc_match() case we don't load freelist so that
3243 * we don't make further mismatched allocations easier.
3245 deactivate_slab(s, slab, get_freepointer(s, freelist));
3251 local_lock_irqsave(&s->cpu_slab->lock, flags);
3252 if (unlikely(c->slab)) {
3253 void *flush_freelist = c->freelist;
3254 struct slab *flush_slab = c->slab;
3258 c->tid = next_tid(c->tid);
3260 local_unlock_irqrestore(&s->cpu_slab->lock, flags);
3262 deactivate_slab(s, flush_slab, flush_freelist);
3264 stat(s, CPUSLAB_FLUSH);
3266 goto retry_load_slab;
3274 * A wrapper for ___slab_alloc() for contexts where preemption is not yet
3275 * disabled. Compensates for possible cpu changes by refetching the per cpu area
3278 static void *__slab_alloc(struct kmem_cache *s, gfp_t gfpflags, int node,
3279 unsigned long addr, struct kmem_cache_cpu *c, unsigned int orig_size)
3283 #ifdef CONFIG_PREEMPT_COUNT
3285 * We may have been preempted and rescheduled on a different
3286 * cpu before disabling preemption. Need to reload cpu area
3289 c = slub_get_cpu_ptr(s->cpu_slab);
3292 p = ___slab_alloc(s, gfpflags, node, addr, c, orig_size);
3293 #ifdef CONFIG_PREEMPT_COUNT
3294 slub_put_cpu_ptr(s->cpu_slab);
3299 static __always_inline void *__slab_alloc_node(struct kmem_cache *s,
3300 gfp_t gfpflags, int node, unsigned long addr, size_t orig_size)
3302 struct kmem_cache_cpu *c;
3309 * Must read kmem_cache cpu data via this cpu ptr. Preemption is
3310 * enabled. We may switch back and forth between cpus while
3311 * reading from one cpu area. That does not matter as long
3312 * as we end up on the original cpu again when doing the cmpxchg.
3314 * We must guarantee that tid and kmem_cache_cpu are retrieved on the
3315 * same cpu. We read first the kmem_cache_cpu pointer and use it to read
3316 * the tid. If we are preempted and switched to another cpu between the
3317 * two reads, it's OK as the two are still associated with the same cpu
3318 * and cmpxchg later will validate the cpu.
3320 c = raw_cpu_ptr(s->cpu_slab);
3321 tid = READ_ONCE(c->tid);
3324 * Irqless object alloc/free algorithm used here depends on sequence
3325 * of fetching cpu_slab's data. tid should be fetched before anything
3326 * on c to guarantee that object and slab associated with previous tid
3327 * won't be used with current tid. If we fetch tid first, object and
3328 * slab could be one associated with next tid and our alloc/free
3329 * request will be failed. In this case, we will retry. So, no problem.
3334 * The transaction ids are globally unique per cpu and per operation on
3335 * a per cpu queue. Thus they can be guarantee that the cmpxchg_double
3336 * occurs on the right processor and that there was no operation on the
3337 * linked list in between.
3340 object = c->freelist;
3343 if (!USE_LOCKLESS_FAST_PATH() ||
3344 unlikely(!object || !slab || !node_match(slab, node))) {
3345 object = __slab_alloc(s, gfpflags, node, addr, c, orig_size);
3347 void *next_object = get_freepointer_safe(s, object);
3350 * The cmpxchg will only match if there was no additional
3351 * operation and if we are on the right processor.
3353 * The cmpxchg does the following atomically (without lock
3355 * 1. Relocate first pointer to the current per cpu area.
3356 * 2. Verify that tid and freelist have not been changed
3357 * 3. If they were not changed replace tid and freelist
3359 * Since this is without lock semantics the protection is only
3360 * against code executing on this cpu *not* from access by
3363 if (unlikely(!this_cpu_cmpxchg_double(
3364 s->cpu_slab->freelist, s->cpu_slab->tid,
3366 next_object, next_tid(tid)))) {
3368 note_cmpxchg_failure("slab_alloc", s, tid);
3371 prefetch_freepointer(s, next_object);
3372 stat(s, ALLOC_FASTPATH);
3377 #else /* CONFIG_SLUB_TINY */
3378 static void *__slab_alloc_node(struct kmem_cache *s,
3379 gfp_t gfpflags, int node, unsigned long addr, size_t orig_size)
3381 struct partial_context pc;
3385 pc.flags = gfpflags;
3387 pc.orig_size = orig_size;
3388 object = get_partial(s, node, &pc);
3393 slab = new_slab(s, gfpflags, node);
3394 if (unlikely(!slab)) {
3395 slab_out_of_memory(s, gfpflags, node);
3399 object = alloc_single_from_new_slab(s, slab, orig_size);
3403 #endif /* CONFIG_SLUB_TINY */
3406 * If the object has been wiped upon free, make sure it's fully initialized by
3407 * zeroing out freelist pointer.
3409 static __always_inline void maybe_wipe_obj_freeptr(struct kmem_cache *s,
3412 if (unlikely(slab_want_init_on_free(s)) && obj)
3413 memset((void *)((char *)kasan_reset_tag(obj) + s->offset),
3418 * Inlined fastpath so that allocation functions (kmalloc, kmem_cache_alloc)
3419 * have the fastpath folded into their functions. So no function call
3420 * overhead for requests that can be satisfied on the fastpath.
3422 * The fastpath works by first checking if the lockless freelist can be used.
3423 * If not then __slab_alloc is called for slow processing.
3425 * Otherwise we can simply pick the next object from the lockless free list.
3427 static __fastpath_inline void *slab_alloc_node(struct kmem_cache *s, struct list_lru *lru,
3428 gfp_t gfpflags, int node, unsigned long addr, size_t orig_size)
3431 struct obj_cgroup *objcg = NULL;
3434 s = slab_pre_alloc_hook(s, lru, &objcg, 1, gfpflags);
3438 object = kfence_alloc(s, orig_size, gfpflags);
3439 if (unlikely(object))
3442 object = __slab_alloc_node(s, gfpflags, node, addr, orig_size);
3444 maybe_wipe_obj_freeptr(s, object);
3445 init = slab_want_init_on_alloc(gfpflags, s);
3449 * When init equals 'true', like for kzalloc() family, only
3450 * @orig_size bytes might be zeroed instead of s->object_size
3452 slab_post_alloc_hook(s, objcg, gfpflags, 1, &object, init, orig_size);
3457 static __fastpath_inline void *slab_alloc(struct kmem_cache *s, struct list_lru *lru,
3458 gfp_t gfpflags, unsigned long addr, size_t orig_size)
3460 return slab_alloc_node(s, lru, gfpflags, NUMA_NO_NODE, addr, orig_size);
3463 static __fastpath_inline
3464 void *__kmem_cache_alloc_lru(struct kmem_cache *s, struct list_lru *lru,
3467 void *ret = slab_alloc(s, lru, gfpflags, _RET_IP_, s->object_size);
3469 trace_kmem_cache_alloc(_RET_IP_, ret, s, gfpflags, NUMA_NO_NODE);
3474 void *kmem_cache_alloc(struct kmem_cache *s, gfp_t gfpflags)
3476 return __kmem_cache_alloc_lru(s, NULL, gfpflags);
3478 EXPORT_SYMBOL(kmem_cache_alloc);
3480 void *kmem_cache_alloc_lru(struct kmem_cache *s, struct list_lru *lru,
3483 return __kmem_cache_alloc_lru(s, lru, gfpflags);
3485 EXPORT_SYMBOL(kmem_cache_alloc_lru);
3487 void *__kmem_cache_alloc_node(struct kmem_cache *s, gfp_t gfpflags,
3488 int node, size_t orig_size,
3489 unsigned long caller)
3491 return slab_alloc_node(s, NULL, gfpflags, node,
3495 void *kmem_cache_alloc_node(struct kmem_cache *s, gfp_t gfpflags, int node)
3497 void *ret = slab_alloc_node(s, NULL, gfpflags, node, _RET_IP_, s->object_size);
3499 trace_kmem_cache_alloc(_RET_IP_, ret, s, gfpflags, node);
3503 EXPORT_SYMBOL(kmem_cache_alloc_node);
3505 static noinline void free_to_partial_list(
3506 struct kmem_cache *s, struct slab *slab,
3507 void *head, void *tail, int bulk_cnt,
3510 struct kmem_cache_node *n = get_node(s, slab_nid(slab));
3511 struct slab *slab_free = NULL;
3513 unsigned long flags;
3514 depot_stack_handle_t handle = 0;
3516 if (s->flags & SLAB_STORE_USER)
3517 handle = set_track_prepare();
3519 spin_lock_irqsave(&n->list_lock, flags);
3521 if (free_debug_processing(s, slab, head, tail, &cnt, addr, handle)) {
3522 void *prior = slab->freelist;
3524 /* Perform the actual freeing while we still hold the locks */
3526 set_freepointer(s, tail, prior);
3527 slab->freelist = head;
3530 * If the slab is empty, and node's partial list is full,
3531 * it should be discarded anyway no matter it's on full or
3534 if (slab->inuse == 0 && n->nr_partial >= s->min_partial)
3538 /* was on full list */
3539 remove_full(s, n, slab);
3541 add_partial(n, slab, DEACTIVATE_TO_TAIL);
3542 stat(s, FREE_ADD_PARTIAL);
3544 } else if (slab_free) {
3545 remove_partial(n, slab);
3546 stat(s, FREE_REMOVE_PARTIAL);
3552 * Update the counters while still holding n->list_lock to
3553 * prevent spurious validation warnings
3555 dec_slabs_node(s, slab_nid(slab_free), slab_free->objects);
3558 spin_unlock_irqrestore(&n->list_lock, flags);
3562 free_slab(s, slab_free);
3567 * Slow path handling. This may still be called frequently since objects
3568 * have a longer lifetime than the cpu slabs in most processing loads.
3570 * So we still attempt to reduce cache line usage. Just take the slab
3571 * lock and free the item. If there is no additional partial slab
3572 * handling required then we can return immediately.
3574 static void __slab_free(struct kmem_cache *s, struct slab *slab,
3575 void *head, void *tail, int cnt,
3582 unsigned long counters;
3583 struct kmem_cache_node *n = NULL;
3584 unsigned long flags;
3586 stat(s, FREE_SLOWPATH);
3588 if (kfence_free(head))
3591 if (IS_ENABLED(CONFIG_SLUB_TINY) || kmem_cache_debug(s)) {
3592 free_to_partial_list(s, slab, head, tail, cnt, addr);
3598 spin_unlock_irqrestore(&n->list_lock, flags);
3601 prior = slab->freelist;
3602 counters = slab->counters;
3603 set_freepointer(s, tail, prior);
3604 new.counters = counters;
3605 was_frozen = new.frozen;
3607 if ((!new.inuse || !prior) && !was_frozen) {
3609 if (kmem_cache_has_cpu_partial(s) && !prior) {
3612 * Slab was on no list before and will be
3614 * We can defer the list move and instead
3619 } else { /* Needs to be taken off a list */
3621 n = get_node(s, slab_nid(slab));
3623 * Speculatively acquire the list_lock.
3624 * If the cmpxchg does not succeed then we may
3625 * drop the list_lock without any processing.
3627 * Otherwise the list_lock will synchronize with
3628 * other processors updating the list of slabs.
3630 spin_lock_irqsave(&n->list_lock, flags);
3635 } while (!cmpxchg_double_slab(s, slab,
3642 if (likely(was_frozen)) {
3644 * The list lock was not taken therefore no list
3645 * activity can be necessary.
3647 stat(s, FREE_FROZEN);
3648 } else if (new.frozen) {
3650 * If we just froze the slab then put it onto the
3651 * per cpu partial list.
3653 put_cpu_partial(s, slab, 1);
3654 stat(s, CPU_PARTIAL_FREE);
3660 if (unlikely(!new.inuse && n->nr_partial >= s->min_partial))
3664 * Objects left in the slab. If it was not on the partial list before
3667 if (!kmem_cache_has_cpu_partial(s) && unlikely(!prior)) {
3668 remove_full(s, n, slab);
3669 add_partial(n, slab, DEACTIVATE_TO_TAIL);
3670 stat(s, FREE_ADD_PARTIAL);
3672 spin_unlock_irqrestore(&n->list_lock, flags);
3678 * Slab on the partial list.
3680 remove_partial(n, slab);
3681 stat(s, FREE_REMOVE_PARTIAL);
3683 /* Slab must be on the full list */
3684 remove_full(s, n, slab);
3687 spin_unlock_irqrestore(&n->list_lock, flags);
3689 discard_slab(s, slab);
3692 #ifndef CONFIG_SLUB_TINY
3694 * Fastpath with forced inlining to produce a kfree and kmem_cache_free that
3695 * can perform fastpath freeing without additional function calls.
3697 * The fastpath is only possible if we are freeing to the current cpu slab
3698 * of this processor. This typically the case if we have just allocated
3701 * If fastpath is not possible then fall back to __slab_free where we deal
3702 * with all sorts of special processing.
3704 * Bulk free of a freelist with several objects (all pointing to the
3705 * same slab) possible by specifying head and tail ptr, plus objects
3706 * count (cnt). Bulk free indicated by tail pointer being set.
3708 static __always_inline void do_slab_free(struct kmem_cache *s,
3709 struct slab *slab, void *head, void *tail,
3710 int cnt, unsigned long addr)
3712 void *tail_obj = tail ? : head;
3713 struct kmem_cache_cpu *c;
3719 * Determine the currently cpus per cpu slab.
3720 * The cpu may change afterward. However that does not matter since
3721 * data is retrieved via this pointer. If we are on the same cpu
3722 * during the cmpxchg then the free will succeed.
3724 c = raw_cpu_ptr(s->cpu_slab);
3725 tid = READ_ONCE(c->tid);
3727 /* Same with comment on barrier() in slab_alloc_node() */
3730 if (unlikely(slab != c->slab)) {
3731 __slab_free(s, slab, head, tail_obj, cnt, addr);
3735 if (USE_LOCKLESS_FAST_PATH()) {
3736 freelist = READ_ONCE(c->freelist);
3738 set_freepointer(s, tail_obj, freelist);
3740 if (unlikely(!this_cpu_cmpxchg_double(
3741 s->cpu_slab->freelist, s->cpu_slab->tid,
3743 head, next_tid(tid)))) {
3745 note_cmpxchg_failure("slab_free", s, tid);
3749 /* Update the free list under the local lock */
3750 local_lock(&s->cpu_slab->lock);
3751 c = this_cpu_ptr(s->cpu_slab);
3752 if (unlikely(slab != c->slab)) {
3753 local_unlock(&s->cpu_slab->lock);
3757 freelist = c->freelist;
3759 set_freepointer(s, tail_obj, freelist);
3761 c->tid = next_tid(tid);
3763 local_unlock(&s->cpu_slab->lock);
3765 stat(s, FREE_FASTPATH);
3767 #else /* CONFIG_SLUB_TINY */
3768 static void do_slab_free(struct kmem_cache *s,
3769 struct slab *slab, void *head, void *tail,
3770 int cnt, unsigned long addr)
3772 void *tail_obj = tail ? : head;
3774 __slab_free(s, slab, head, tail_obj, cnt, addr);
3776 #endif /* CONFIG_SLUB_TINY */
3778 static __fastpath_inline void slab_free(struct kmem_cache *s, struct slab *slab,
3779 void *head, void *tail, void **p, int cnt,
3782 memcg_slab_free_hook(s, slab, p, cnt);
3784 * With KASAN enabled slab_free_freelist_hook modifies the freelist
3785 * to remove objects, whose reuse must be delayed.
3787 if (slab_free_freelist_hook(s, &head, &tail, &cnt))
3788 do_slab_free(s, slab, head, tail, cnt, addr);
3791 #ifdef CONFIG_KASAN_GENERIC
3792 void ___cache_free(struct kmem_cache *cache, void *x, unsigned long addr)
3794 do_slab_free(cache, virt_to_slab(x), x, NULL, 1, addr);
3798 void __kmem_cache_free(struct kmem_cache *s, void *x, unsigned long caller)
3800 slab_free(s, virt_to_slab(x), x, NULL, &x, 1, caller);
3803 void kmem_cache_free(struct kmem_cache *s, void *x)
3805 s = cache_from_obj(s, x);
3808 trace_kmem_cache_free(_RET_IP_, x, s);
3809 slab_free(s, virt_to_slab(x), x, NULL, &x, 1, _RET_IP_);
3811 EXPORT_SYMBOL(kmem_cache_free);
3813 struct detached_freelist {
3818 struct kmem_cache *s;
3822 * This function progressively scans the array with free objects (with
3823 * a limited look ahead) and extract objects belonging to the same
3824 * slab. It builds a detached freelist directly within the given
3825 * slab/objects. This can happen without any need for
3826 * synchronization, because the objects are owned by running process.
3827 * The freelist is build up as a single linked list in the objects.
3828 * The idea is, that this detached freelist can then be bulk
3829 * transferred to the real freelist(s), but only requiring a single
3830 * synchronization primitive. Look ahead in the array is limited due
3831 * to performance reasons.
3834 int build_detached_freelist(struct kmem_cache *s, size_t size,
3835 void **p, struct detached_freelist *df)
3839 struct folio *folio;
3843 folio = virt_to_folio(object);
3845 /* Handle kalloc'ed objects */
3846 if (unlikely(!folio_test_slab(folio))) {
3847 free_large_kmalloc(folio, object);
3851 /* Derive kmem_cache from object */
3852 df->slab = folio_slab(folio);
3853 df->s = df->slab->slab_cache;
3855 df->slab = folio_slab(folio);
3856 df->s = cache_from_obj(s, object); /* Support for memcg */
3859 /* Start new detached freelist */
3861 df->freelist = object;
3864 if (is_kfence_address(object))
3867 set_freepointer(df->s, object, NULL);
3872 /* df->slab is always set at this point */
3873 if (df->slab == virt_to_slab(object)) {
3874 /* Opportunity build freelist */
3875 set_freepointer(df->s, object, df->freelist);
3876 df->freelist = object;
3880 swap(p[size], p[same]);
3884 /* Limit look ahead search */
3892 /* Note that interrupts must be enabled when calling this function. */
3893 void kmem_cache_free_bulk(struct kmem_cache *s, size_t size, void **p)
3899 struct detached_freelist df;
3901 size = build_detached_freelist(s, size, p, &df);
3905 slab_free(df.s, df.slab, df.freelist, df.tail, &p[size], df.cnt,
3907 } while (likely(size));
3909 EXPORT_SYMBOL(kmem_cache_free_bulk);
3911 #ifndef CONFIG_SLUB_TINY
3912 static inline int __kmem_cache_alloc_bulk(struct kmem_cache *s, gfp_t flags,
3913 size_t size, void **p, struct obj_cgroup *objcg)
3915 struct kmem_cache_cpu *c;
3916 unsigned long irqflags;
3920 * Drain objects in the per cpu slab, while disabling local
3921 * IRQs, which protects against PREEMPT and interrupts
3922 * handlers invoking normal fastpath.
3924 c = slub_get_cpu_ptr(s->cpu_slab);
3925 local_lock_irqsave(&s->cpu_slab->lock, irqflags);
3927 for (i = 0; i < size; i++) {
3928 void *object = kfence_alloc(s, s->object_size, flags);
3930 if (unlikely(object)) {
3935 object = c->freelist;
3936 if (unlikely(!object)) {
3938 * We may have removed an object from c->freelist using
3939 * the fastpath in the previous iteration; in that case,
3940 * c->tid has not been bumped yet.
3941 * Since ___slab_alloc() may reenable interrupts while
3942 * allocating memory, we should bump c->tid now.
3944 c->tid = next_tid(c->tid);
3946 local_unlock_irqrestore(&s->cpu_slab->lock, irqflags);
3949 * Invoking slow path likely have side-effect
3950 * of re-populating per CPU c->freelist
3952 p[i] = ___slab_alloc(s, flags, NUMA_NO_NODE,
3953 _RET_IP_, c, s->object_size);
3954 if (unlikely(!p[i]))
3957 c = this_cpu_ptr(s->cpu_slab);
3958 maybe_wipe_obj_freeptr(s, p[i]);
3960 local_lock_irqsave(&s->cpu_slab->lock, irqflags);
3962 continue; /* goto for-loop */
3964 c->freelist = get_freepointer(s, object);
3966 maybe_wipe_obj_freeptr(s, p[i]);
3968 c->tid = next_tid(c->tid);
3969 local_unlock_irqrestore(&s->cpu_slab->lock, irqflags);
3970 slub_put_cpu_ptr(s->cpu_slab);
3975 slub_put_cpu_ptr(s->cpu_slab);
3976 slab_post_alloc_hook(s, objcg, flags, i, p, false, s->object_size);
3977 kmem_cache_free_bulk(s, i, p);
3981 #else /* CONFIG_SLUB_TINY */
3982 static int __kmem_cache_alloc_bulk(struct kmem_cache *s, gfp_t flags,
3983 size_t size, void **p, struct obj_cgroup *objcg)
3987 for (i = 0; i < size; i++) {
3988 void *object = kfence_alloc(s, s->object_size, flags);
3990 if (unlikely(object)) {
3995 p[i] = __slab_alloc_node(s, flags, NUMA_NO_NODE,
3996 _RET_IP_, s->object_size);
3997 if (unlikely(!p[i]))
4000 maybe_wipe_obj_freeptr(s, p[i]);
4006 slab_post_alloc_hook(s, objcg, flags, i, p, false, s->object_size);
4007 kmem_cache_free_bulk(s, i, p);
4010 #endif /* CONFIG_SLUB_TINY */
4012 /* Note that interrupts must be enabled when calling this function. */
4013 int kmem_cache_alloc_bulk(struct kmem_cache *s, gfp_t flags, size_t size,
4017 struct obj_cgroup *objcg = NULL;
4022 /* memcg and kmem_cache debug support */
4023 s = slab_pre_alloc_hook(s, NULL, &objcg, size, flags);
4027 i = __kmem_cache_alloc_bulk(s, flags, size, p, objcg);
4030 * memcg and kmem_cache debug support and memory initialization.
4031 * Done outside of the IRQ disabled fastpath loop.
4034 slab_post_alloc_hook(s, objcg, flags, size, p,
4035 slab_want_init_on_alloc(flags, s), s->object_size);
4038 EXPORT_SYMBOL(kmem_cache_alloc_bulk);
4042 * Object placement in a slab is made very easy because we always start at
4043 * offset 0. If we tune the size of the object to the alignment then we can
4044 * get the required alignment by putting one properly sized object after
4047 * Notice that the allocation order determines the sizes of the per cpu
4048 * caches. Each processor has always one slab available for allocations.
4049 * Increasing the allocation order reduces the number of times that slabs
4050 * must be moved on and off the partial lists and is therefore a factor in
4055 * Minimum / Maximum order of slab pages. This influences locking overhead
4056 * and slab fragmentation. A higher order reduces the number of partial slabs
4057 * and increases the number of allocations possible without having to
4058 * take the list_lock.
4060 static unsigned int slub_min_order;
4061 static unsigned int slub_max_order =
4062 IS_ENABLED(CONFIG_SLUB_TINY) ? 1 : PAGE_ALLOC_COSTLY_ORDER;
4063 static unsigned int slub_min_objects;
4066 * Calculate the order of allocation given an slab object size.
4068 * The order of allocation has significant impact on performance and other
4069 * system components. Generally order 0 allocations should be preferred since
4070 * order 0 does not cause fragmentation in the page allocator. Larger objects
4071 * be problematic to put into order 0 slabs because there may be too much
4072 * unused space left. We go to a higher order if more than 1/16th of the slab
4075 * In order to reach satisfactory performance we must ensure that a minimum
4076 * number of objects is in one slab. Otherwise we may generate too much
4077 * activity on the partial lists which requires taking the list_lock. This is
4078 * less a concern for large slabs though which are rarely used.
4080 * slub_max_order specifies the order where we begin to stop considering the
4081 * number of objects in a slab as critical. If we reach slub_max_order then
4082 * we try to keep the page order as low as possible. So we accept more waste
4083 * of space in favor of a small page order.
4085 * Higher order allocations also allow the placement of more objects in a
4086 * slab and thereby reduce object handling overhead. If the user has
4087 * requested a higher minimum order then we start with that one instead of
4088 * the smallest order which will fit the object.
4090 static inline unsigned int calc_slab_order(unsigned int size,
4091 unsigned int min_objects, unsigned int max_order,
4092 unsigned int fract_leftover)
4094 unsigned int min_order = slub_min_order;
4097 if (order_objects(min_order, size) > MAX_OBJS_PER_PAGE)
4098 return get_order(size * MAX_OBJS_PER_PAGE) - 1;
4100 for (order = max(min_order, (unsigned int)get_order(min_objects * size));
4101 order <= max_order; order++) {
4103 unsigned int slab_size = (unsigned int)PAGE_SIZE << order;
4106 rem = slab_size % size;
4108 if (rem <= slab_size / fract_leftover)
4115 static inline int calculate_order(unsigned int size)
4118 unsigned int min_objects;
4119 unsigned int max_objects;
4120 unsigned int nr_cpus;
4123 * Attempt to find best configuration for a slab. This
4124 * works by first attempting to generate a layout with
4125 * the best configuration and backing off gradually.
4127 * First we increase the acceptable waste in a slab. Then
4128 * we reduce the minimum objects required in a slab.
4130 min_objects = slub_min_objects;
4133 * Some architectures will only update present cpus when
4134 * onlining them, so don't trust the number if it's just 1. But
4135 * we also don't want to use nr_cpu_ids always, as on some other
4136 * architectures, there can be many possible cpus, but never
4137 * onlined. Here we compromise between trying to avoid too high
4138 * order on systems that appear larger than they are, and too
4139 * low order on systems that appear smaller than they are.
4141 nr_cpus = num_present_cpus();
4143 nr_cpus = nr_cpu_ids;
4144 min_objects = 4 * (fls(nr_cpus) + 1);
4146 max_objects = order_objects(slub_max_order, size);
4147 min_objects = min(min_objects, max_objects);
4149 while (min_objects > 1) {
4150 unsigned int fraction;
4153 while (fraction >= 4) {
4154 order = calc_slab_order(size, min_objects,
4155 slub_max_order, fraction);
4156 if (order <= slub_max_order)
4164 * We were unable to place multiple objects in a slab. Now
4165 * lets see if we can place a single object there.
4167 order = calc_slab_order(size, 1, slub_max_order, 1);
4168 if (order <= slub_max_order)
4172 * Doh this slab cannot be placed using slub_max_order.
4174 order = calc_slab_order(size, 1, MAX_ORDER, 1);
4175 if (order < MAX_ORDER)
4181 init_kmem_cache_node(struct kmem_cache_node *n)
4184 spin_lock_init(&n->list_lock);
4185 INIT_LIST_HEAD(&n->partial);
4186 #ifdef CONFIG_SLUB_DEBUG
4187 atomic_long_set(&n->nr_slabs, 0);
4188 atomic_long_set(&n->total_objects, 0);
4189 INIT_LIST_HEAD(&n->full);
4193 #ifndef CONFIG_SLUB_TINY
4194 static inline int alloc_kmem_cache_cpus(struct kmem_cache *s)
4196 BUILD_BUG_ON(PERCPU_DYNAMIC_EARLY_SIZE <
4197 NR_KMALLOC_TYPES * KMALLOC_SHIFT_HIGH *
4198 sizeof(struct kmem_cache_cpu));
4201 * Must align to double word boundary for the double cmpxchg
4202 * instructions to work; see __pcpu_double_call_return_bool().
4204 s->cpu_slab = __alloc_percpu(sizeof(struct kmem_cache_cpu),
4205 2 * sizeof(void *));
4210 init_kmem_cache_cpus(s);
4215 static inline int alloc_kmem_cache_cpus(struct kmem_cache *s)
4219 #endif /* CONFIG_SLUB_TINY */
4221 static struct kmem_cache *kmem_cache_node;
4224 * No kmalloc_node yet so do it by hand. We know that this is the first
4225 * slab on the node for this slabcache. There are no concurrent accesses
4228 * Note that this function only works on the kmem_cache_node
4229 * when allocating for the kmem_cache_node. This is used for bootstrapping
4230 * memory on a fresh node that has no slab structures yet.
4232 static void early_kmem_cache_node_alloc(int node)
4235 struct kmem_cache_node *n;
4237 BUG_ON(kmem_cache_node->size < sizeof(struct kmem_cache_node));
4239 slab = new_slab(kmem_cache_node, GFP_NOWAIT, node);
4242 inc_slabs_node(kmem_cache_node, slab_nid(slab), slab->objects);
4243 if (slab_nid(slab) != node) {
4244 pr_err("SLUB: Unable to allocate memory from node %d\n", node);
4245 pr_err("SLUB: Allocating a useless per node structure in order to be able to continue\n");
4250 #ifdef CONFIG_SLUB_DEBUG
4251 init_object(kmem_cache_node, n, SLUB_RED_ACTIVE);
4252 init_tracking(kmem_cache_node, n);
4254 n = kasan_slab_alloc(kmem_cache_node, n, GFP_KERNEL, false);
4255 slab->freelist = get_freepointer(kmem_cache_node, n);
4257 kmem_cache_node->node[node] = n;
4258 init_kmem_cache_node(n);
4259 inc_slabs_node(kmem_cache_node, node, slab->objects);
4262 * No locks need to be taken here as it has just been
4263 * initialized and there is no concurrent access.
4265 __add_partial(n, slab, DEACTIVATE_TO_HEAD);
4268 static void free_kmem_cache_nodes(struct kmem_cache *s)
4271 struct kmem_cache_node *n;
4273 for_each_kmem_cache_node(s, node, n) {
4274 s->node[node] = NULL;
4275 kmem_cache_free(kmem_cache_node, n);
4279 void __kmem_cache_release(struct kmem_cache *s)
4281 cache_random_seq_destroy(s);
4282 #ifndef CONFIG_SLUB_TINY
4283 free_percpu(s->cpu_slab);
4285 free_kmem_cache_nodes(s);
4288 static int init_kmem_cache_nodes(struct kmem_cache *s)
4292 for_each_node_mask(node, slab_nodes) {
4293 struct kmem_cache_node *n;
4295 if (slab_state == DOWN) {
4296 early_kmem_cache_node_alloc(node);
4299 n = kmem_cache_alloc_node(kmem_cache_node,
4303 free_kmem_cache_nodes(s);
4307 init_kmem_cache_node(n);
4313 static void set_cpu_partial(struct kmem_cache *s)
4315 #ifdef CONFIG_SLUB_CPU_PARTIAL
4316 unsigned int nr_objects;
4319 * cpu_partial determined the maximum number of objects kept in the
4320 * per cpu partial lists of a processor.
4322 * Per cpu partial lists mainly contain slabs that just have one
4323 * object freed. If they are used for allocation then they can be
4324 * filled up again with minimal effort. The slab will never hit the
4325 * per node partial lists and therefore no locking will be required.
4327 * For backwards compatibility reasons, this is determined as number
4328 * of objects, even though we now limit maximum number of pages, see
4329 * slub_set_cpu_partial()
4331 if (!kmem_cache_has_cpu_partial(s))
4333 else if (s->size >= PAGE_SIZE)
4335 else if (s->size >= 1024)
4337 else if (s->size >= 256)
4342 slub_set_cpu_partial(s, nr_objects);
4347 * calculate_sizes() determines the order and the distribution of data within
4350 static int calculate_sizes(struct kmem_cache *s)
4352 slab_flags_t flags = s->flags;
4353 unsigned int size = s->object_size;
4357 * Round up object size to the next word boundary. We can only
4358 * place the free pointer at word boundaries and this determines
4359 * the possible location of the free pointer.
4361 size = ALIGN(size, sizeof(void *));
4363 #ifdef CONFIG_SLUB_DEBUG
4365 * Determine if we can poison the object itself. If the user of
4366 * the slab may touch the object after free or before allocation
4367 * then we should never poison the object itself.
4369 if ((flags & SLAB_POISON) && !(flags & SLAB_TYPESAFE_BY_RCU) &&
4371 s->flags |= __OBJECT_POISON;
4373 s->flags &= ~__OBJECT_POISON;
4377 * If we are Redzoning then check if there is some space between the
4378 * end of the object and the free pointer. If not then add an
4379 * additional word to have some bytes to store Redzone information.
4381 if ((flags & SLAB_RED_ZONE) && size == s->object_size)
4382 size += sizeof(void *);
4386 * With that we have determined the number of bytes in actual use
4387 * by the object and redzoning.
4391 if (slub_debug_orig_size(s) ||
4392 (flags & (SLAB_TYPESAFE_BY_RCU | SLAB_POISON)) ||
4393 ((flags & SLAB_RED_ZONE) && s->object_size < sizeof(void *)) ||
4396 * Relocate free pointer after the object if it is not
4397 * permitted to overwrite the first word of the object on
4400 * This is the case if we do RCU, have a constructor or
4401 * destructor, are poisoning the objects, or are
4402 * redzoning an object smaller than sizeof(void *).
4404 * The assumption that s->offset >= s->inuse means free
4405 * pointer is outside of the object is used in the
4406 * freeptr_outside_object() function. If that is no
4407 * longer true, the function needs to be modified.
4410 size += sizeof(void *);
4413 * Store freelist pointer near middle of object to keep
4414 * it away from the edges of the object to avoid small
4415 * sized over/underflows from neighboring allocations.
4417 s->offset = ALIGN_DOWN(s->object_size / 2, sizeof(void *));
4420 #ifdef CONFIG_SLUB_DEBUG
4421 if (flags & SLAB_STORE_USER) {
4423 * Need to store information about allocs and frees after
4426 size += 2 * sizeof(struct track);
4428 /* Save the original kmalloc request size */
4429 if (flags & SLAB_KMALLOC)
4430 size += sizeof(unsigned int);
4434 kasan_cache_create(s, &size, &s->flags);
4435 #ifdef CONFIG_SLUB_DEBUG
4436 if (flags & SLAB_RED_ZONE) {
4438 * Add some empty padding so that we can catch
4439 * overwrites from earlier objects rather than let
4440 * tracking information or the free pointer be
4441 * corrupted if a user writes before the start
4444 size += sizeof(void *);
4446 s->red_left_pad = sizeof(void *);
4447 s->red_left_pad = ALIGN(s->red_left_pad, s->align);
4448 size += s->red_left_pad;
4453 * SLUB stores one object immediately after another beginning from
4454 * offset 0. In order to align the objects we have to simply size
4455 * each object to conform to the alignment.
4457 size = ALIGN(size, s->align);
4459 s->reciprocal_size = reciprocal_value(size);
4460 order = calculate_order(size);
4467 s->allocflags |= __GFP_COMP;
4469 if (s->flags & SLAB_CACHE_DMA)
4470 s->allocflags |= GFP_DMA;
4472 if (s->flags & SLAB_CACHE_DMA32)
4473 s->allocflags |= GFP_DMA32;
4475 if (s->flags & SLAB_RECLAIM_ACCOUNT)
4476 s->allocflags |= __GFP_RECLAIMABLE;
4479 * Determine the number of objects per slab
4481 s->oo = oo_make(order, size);
4482 s->min = oo_make(get_order(size), size);
4484 return !!oo_objects(s->oo);
4487 static int kmem_cache_open(struct kmem_cache *s, slab_flags_t flags)
4489 s->flags = kmem_cache_flags(s->size, flags, s->name);
4490 #ifdef CONFIG_SLAB_FREELIST_HARDENED
4491 s->random = get_random_long();
4494 if (!calculate_sizes(s))
4496 if (disable_higher_order_debug) {
4498 * Disable debugging flags that store metadata if the min slab
4501 if (get_order(s->size) > get_order(s->object_size)) {
4502 s->flags &= ~DEBUG_METADATA_FLAGS;
4504 if (!calculate_sizes(s))
4509 #if defined(CONFIG_HAVE_CMPXCHG_DOUBLE) && \
4510 defined(CONFIG_HAVE_ALIGNED_STRUCT_PAGE)
4511 if (system_has_cmpxchg_double() && (s->flags & SLAB_NO_CMPXCHG) == 0)
4512 /* Enable fast mode */
4513 s->flags |= __CMPXCHG_DOUBLE;
4517 * The larger the object size is, the more slabs we want on the partial
4518 * list to avoid pounding the page allocator excessively.
4520 s->min_partial = min_t(unsigned long, MAX_PARTIAL, ilog2(s->size) / 2);
4521 s->min_partial = max_t(unsigned long, MIN_PARTIAL, s->min_partial);
4526 s->remote_node_defrag_ratio = 1000;
4529 /* Initialize the pre-computed randomized freelist if slab is up */
4530 if (slab_state >= UP) {
4531 if (init_cache_random_seq(s))
4535 if (!init_kmem_cache_nodes(s))
4538 if (alloc_kmem_cache_cpus(s))
4542 __kmem_cache_release(s);
4546 static void list_slab_objects(struct kmem_cache *s, struct slab *slab,
4549 #ifdef CONFIG_SLUB_DEBUG
4550 void *addr = slab_address(slab);
4553 slab_err(s, slab, text, s->name);
4555 spin_lock(&object_map_lock);
4556 __fill_map(object_map, s, slab);
4558 for_each_object(p, s, addr, slab->objects) {
4560 if (!test_bit(__obj_to_index(s, addr, p), object_map)) {
4561 pr_err("Object 0x%p @offset=%tu\n", p, p - addr);
4562 print_tracking(s, p);
4565 spin_unlock(&object_map_lock);
4570 * Attempt to free all partial slabs on a node.
4571 * This is called from __kmem_cache_shutdown(). We must take list_lock
4572 * because sysfs file might still access partial list after the shutdowning.
4574 static void free_partial(struct kmem_cache *s, struct kmem_cache_node *n)
4577 struct slab *slab, *h;
4579 BUG_ON(irqs_disabled());
4580 spin_lock_irq(&n->list_lock);
4581 list_for_each_entry_safe(slab, h, &n->partial, slab_list) {
4583 remove_partial(n, slab);
4584 list_add(&slab->slab_list, &discard);
4586 list_slab_objects(s, slab,
4587 "Objects remaining in %s on __kmem_cache_shutdown()");
4590 spin_unlock_irq(&n->list_lock);
4592 list_for_each_entry_safe(slab, h, &discard, slab_list)
4593 discard_slab(s, slab);
4596 bool __kmem_cache_empty(struct kmem_cache *s)
4599 struct kmem_cache_node *n;
4601 for_each_kmem_cache_node(s, node, n)
4602 if (n->nr_partial || slabs_node(s, node))
4608 * Release all resources used by a slab cache.
4610 int __kmem_cache_shutdown(struct kmem_cache *s)
4613 struct kmem_cache_node *n;
4615 flush_all_cpus_locked(s);
4616 /* Attempt to free all objects */
4617 for_each_kmem_cache_node(s, node, n) {
4619 if (n->nr_partial || slabs_node(s, node))
4625 #ifdef CONFIG_PRINTK
4626 void __kmem_obj_info(struct kmem_obj_info *kpp, void *object, struct slab *slab)
4629 int __maybe_unused i;
4633 struct kmem_cache *s = slab->slab_cache;
4634 struct track __maybe_unused *trackp;
4636 kpp->kp_ptr = object;
4637 kpp->kp_slab = slab;
4638 kpp->kp_slab_cache = s;
4639 base = slab_address(slab);
4640 objp0 = kasan_reset_tag(object);
4641 #ifdef CONFIG_SLUB_DEBUG
4642 objp = restore_red_left(s, objp0);
4646 objnr = obj_to_index(s, slab, objp);
4647 kpp->kp_data_offset = (unsigned long)((char *)objp0 - (char *)objp);
4648 objp = base + s->size * objnr;
4649 kpp->kp_objp = objp;
4650 if (WARN_ON_ONCE(objp < base || objp >= base + slab->objects * s->size
4651 || (objp - base) % s->size) ||
4652 !(s->flags & SLAB_STORE_USER))
4654 #ifdef CONFIG_SLUB_DEBUG
4655 objp = fixup_red_left(s, objp);
4656 trackp = get_track(s, objp, TRACK_ALLOC);
4657 kpp->kp_ret = (void *)trackp->addr;
4658 #ifdef CONFIG_STACKDEPOT
4660 depot_stack_handle_t handle;
4661 unsigned long *entries;
4662 unsigned int nr_entries;
4664 handle = READ_ONCE(trackp->handle);
4666 nr_entries = stack_depot_fetch(handle, &entries);
4667 for (i = 0; i < KS_ADDRS_COUNT && i < nr_entries; i++)
4668 kpp->kp_stack[i] = (void *)entries[i];
4671 trackp = get_track(s, objp, TRACK_FREE);
4672 handle = READ_ONCE(trackp->handle);
4674 nr_entries = stack_depot_fetch(handle, &entries);
4675 for (i = 0; i < KS_ADDRS_COUNT && i < nr_entries; i++)
4676 kpp->kp_free_stack[i] = (void *)entries[i];
4684 /********************************************************************
4686 *******************************************************************/
4688 static int __init setup_slub_min_order(char *str)
4690 get_option(&str, (int *)&slub_min_order);
4695 __setup("slub_min_order=", setup_slub_min_order);
4697 static int __init setup_slub_max_order(char *str)
4699 get_option(&str, (int *)&slub_max_order);
4700 slub_max_order = min(slub_max_order, (unsigned int)MAX_ORDER - 1);
4705 __setup("slub_max_order=", setup_slub_max_order);
4707 static int __init setup_slub_min_objects(char *str)
4709 get_option(&str, (int *)&slub_min_objects);
4714 __setup("slub_min_objects=", setup_slub_min_objects);
4716 #ifdef CONFIG_HARDENED_USERCOPY
4718 * Rejects incorrectly sized objects and objects that are to be copied
4719 * to/from userspace but do not fall entirely within the containing slab
4720 * cache's usercopy region.
4722 * Returns NULL if check passes, otherwise const char * to name of cache
4723 * to indicate an error.
4725 void __check_heap_object(const void *ptr, unsigned long n,
4726 const struct slab *slab, bool to_user)
4728 struct kmem_cache *s;
4729 unsigned int offset;
4730 bool is_kfence = is_kfence_address(ptr);
4732 ptr = kasan_reset_tag(ptr);
4734 /* Find object and usable object size. */
4735 s = slab->slab_cache;
4737 /* Reject impossible pointers. */
4738 if (ptr < slab_address(slab))
4739 usercopy_abort("SLUB object not in SLUB page?!", NULL,
4742 /* Find offset within object. */
4744 offset = ptr - kfence_object_start(ptr);
4746 offset = (ptr - slab_address(slab)) % s->size;
4748 /* Adjust for redzone and reject if within the redzone. */
4749 if (!is_kfence && kmem_cache_debug_flags(s, SLAB_RED_ZONE)) {
4750 if (offset < s->red_left_pad)
4751 usercopy_abort("SLUB object in left red zone",
4752 s->name, to_user, offset, n);
4753 offset -= s->red_left_pad;
4756 /* Allow address range falling entirely within usercopy region. */
4757 if (offset >= s->useroffset &&
4758 offset - s->useroffset <= s->usersize &&
4759 n <= s->useroffset - offset + s->usersize)
4762 usercopy_abort("SLUB object", s->name, to_user, offset, n);
4764 #endif /* CONFIG_HARDENED_USERCOPY */
4766 #define SHRINK_PROMOTE_MAX 32
4769 * kmem_cache_shrink discards empty slabs and promotes the slabs filled
4770 * up most to the head of the partial lists. New allocations will then
4771 * fill those up and thus they can be removed from the partial lists.
4773 * The slabs with the least items are placed last. This results in them
4774 * being allocated from last increasing the chance that the last objects
4775 * are freed in them.
4777 static int __kmem_cache_do_shrink(struct kmem_cache *s)
4781 struct kmem_cache_node *n;
4784 struct list_head discard;
4785 struct list_head promote[SHRINK_PROMOTE_MAX];
4786 unsigned long flags;
4789 for_each_kmem_cache_node(s, node, n) {
4790 INIT_LIST_HEAD(&discard);
4791 for (i = 0; i < SHRINK_PROMOTE_MAX; i++)
4792 INIT_LIST_HEAD(promote + i);
4794 spin_lock_irqsave(&n->list_lock, flags);
4797 * Build lists of slabs to discard or promote.
4799 * Note that concurrent frees may occur while we hold the
4800 * list_lock. slab->inuse here is the upper limit.
4802 list_for_each_entry_safe(slab, t, &n->partial, slab_list) {
4803 int free = slab->objects - slab->inuse;
4805 /* Do not reread slab->inuse */
4808 /* We do not keep full slabs on the list */
4811 if (free == slab->objects) {
4812 list_move(&slab->slab_list, &discard);
4814 dec_slabs_node(s, node, slab->objects);
4815 } else if (free <= SHRINK_PROMOTE_MAX)
4816 list_move(&slab->slab_list, promote + free - 1);
4820 * Promote the slabs filled up most to the head of the
4823 for (i = SHRINK_PROMOTE_MAX - 1; i >= 0; i--)
4824 list_splice(promote + i, &n->partial);
4826 spin_unlock_irqrestore(&n->list_lock, flags);
4828 /* Release empty slabs */
4829 list_for_each_entry_safe(slab, t, &discard, slab_list)
4832 if (slabs_node(s, node))
4839 int __kmem_cache_shrink(struct kmem_cache *s)
4842 return __kmem_cache_do_shrink(s);
4845 static int slab_mem_going_offline_callback(void *arg)
4847 struct kmem_cache *s;
4849 mutex_lock(&slab_mutex);
4850 list_for_each_entry(s, &slab_caches, list) {
4851 flush_all_cpus_locked(s);
4852 __kmem_cache_do_shrink(s);
4854 mutex_unlock(&slab_mutex);
4859 static void slab_mem_offline_callback(void *arg)
4861 struct memory_notify *marg = arg;
4864 offline_node = marg->status_change_nid_normal;
4867 * If the node still has available memory. we need kmem_cache_node
4870 if (offline_node < 0)
4873 mutex_lock(&slab_mutex);
4874 node_clear(offline_node, slab_nodes);
4876 * We no longer free kmem_cache_node structures here, as it would be
4877 * racy with all get_node() users, and infeasible to protect them with
4880 mutex_unlock(&slab_mutex);
4883 static int slab_mem_going_online_callback(void *arg)
4885 struct kmem_cache_node *n;
4886 struct kmem_cache *s;
4887 struct memory_notify *marg = arg;
4888 int nid = marg->status_change_nid_normal;
4892 * If the node's memory is already available, then kmem_cache_node is
4893 * already created. Nothing to do.
4899 * We are bringing a node online. No memory is available yet. We must
4900 * allocate a kmem_cache_node structure in order to bring the node
4903 mutex_lock(&slab_mutex);
4904 list_for_each_entry(s, &slab_caches, list) {
4906 * The structure may already exist if the node was previously
4907 * onlined and offlined.
4909 if (get_node(s, nid))
4912 * XXX: kmem_cache_alloc_node will fallback to other nodes
4913 * since memory is not yet available from the node that
4916 n = kmem_cache_alloc(kmem_cache_node, GFP_KERNEL);
4921 init_kmem_cache_node(n);
4925 * Any cache created after this point will also have kmem_cache_node
4926 * initialized for the new node.
4928 node_set(nid, slab_nodes);
4930 mutex_unlock(&slab_mutex);
4934 static int slab_memory_callback(struct notifier_block *self,
4935 unsigned long action, void *arg)
4940 case MEM_GOING_ONLINE:
4941 ret = slab_mem_going_online_callback(arg);
4943 case MEM_GOING_OFFLINE:
4944 ret = slab_mem_going_offline_callback(arg);
4947 case MEM_CANCEL_ONLINE:
4948 slab_mem_offline_callback(arg);
4951 case MEM_CANCEL_OFFLINE:
4955 ret = notifier_from_errno(ret);
4961 /********************************************************************
4962 * Basic setup of slabs
4963 *******************************************************************/
4966 * Used for early kmem_cache structures that were allocated using
4967 * the page allocator. Allocate them properly then fix up the pointers
4968 * that may be pointing to the wrong kmem_cache structure.
4971 static struct kmem_cache * __init bootstrap(struct kmem_cache *static_cache)
4974 struct kmem_cache *s = kmem_cache_zalloc(kmem_cache, GFP_NOWAIT);
4975 struct kmem_cache_node *n;
4977 memcpy(s, static_cache, kmem_cache->object_size);
4980 * This runs very early, and only the boot processor is supposed to be
4981 * up. Even if it weren't true, IRQs are not up so we couldn't fire
4984 __flush_cpu_slab(s, smp_processor_id());
4985 for_each_kmem_cache_node(s, node, n) {
4988 list_for_each_entry(p, &n->partial, slab_list)
4991 #ifdef CONFIG_SLUB_DEBUG
4992 list_for_each_entry(p, &n->full, slab_list)
4996 list_add(&s->list, &slab_caches);
5000 void __init kmem_cache_init(void)
5002 static __initdata struct kmem_cache boot_kmem_cache,
5003 boot_kmem_cache_node;
5006 if (debug_guardpage_minorder())
5009 /* Print slub debugging pointers without hashing */
5010 if (__slub_debug_enabled())
5011 no_hash_pointers_enable(NULL);
5013 kmem_cache_node = &boot_kmem_cache_node;
5014 kmem_cache = &boot_kmem_cache;
5017 * Initialize the nodemask for which we will allocate per node
5018 * structures. Here we don't need taking slab_mutex yet.
5020 for_each_node_state(node, N_NORMAL_MEMORY)
5021 node_set(node, slab_nodes);
5023 create_boot_cache(kmem_cache_node, "kmem_cache_node",
5024 sizeof(struct kmem_cache_node), SLAB_HWCACHE_ALIGN, 0, 0);
5026 hotplug_memory_notifier(slab_memory_callback, SLAB_CALLBACK_PRI);
5028 /* Able to allocate the per node structures */
5029 slab_state = PARTIAL;
5031 create_boot_cache(kmem_cache, "kmem_cache",
5032 offsetof(struct kmem_cache, node) +
5033 nr_node_ids * sizeof(struct kmem_cache_node *),
5034 SLAB_HWCACHE_ALIGN, 0, 0);
5036 kmem_cache = bootstrap(&boot_kmem_cache);
5037 kmem_cache_node = bootstrap(&boot_kmem_cache_node);
5039 /* Now we can use the kmem_cache to allocate kmalloc slabs */
5040 setup_kmalloc_cache_index_table();
5041 create_kmalloc_caches(0);
5043 /* Setup random freelists for each cache */
5044 init_freelist_randomization();
5046 cpuhp_setup_state_nocalls(CPUHP_SLUB_DEAD, "slub:dead", NULL,
5049 pr_info("SLUB: HWalign=%d, Order=%u-%u, MinObjects=%u, CPUs=%u, Nodes=%u\n",
5051 slub_min_order, slub_max_order, slub_min_objects,
5052 nr_cpu_ids, nr_node_ids);
5055 void __init kmem_cache_init_late(void)
5057 #ifndef CONFIG_SLUB_TINY
5058 flushwq = alloc_workqueue("slub_flushwq", WQ_MEM_RECLAIM, 0);
5064 __kmem_cache_alias(const char *name, unsigned int size, unsigned int align,
5065 slab_flags_t flags, void (*ctor)(void *))
5067 struct kmem_cache *s;
5069 s = find_mergeable(size, align, flags, name, ctor);
5071 if (sysfs_slab_alias(s, name))
5077 * Adjust the object sizes so that we clear
5078 * the complete object on kzalloc.
5080 s->object_size = max(s->object_size, size);
5081 s->inuse = max(s->inuse, ALIGN(size, sizeof(void *)));
5087 int __kmem_cache_create(struct kmem_cache *s, slab_flags_t flags)
5091 err = kmem_cache_open(s, flags);
5095 /* Mutex is not taken during early boot */
5096 if (slab_state <= UP)
5099 err = sysfs_slab_add(s);
5101 __kmem_cache_release(s);
5105 if (s->flags & SLAB_STORE_USER)
5106 debugfs_slab_add(s);
5111 #ifdef SLAB_SUPPORTS_SYSFS
5112 static int count_inuse(struct slab *slab)
5117 static int count_total(struct slab *slab)
5119 return slab->objects;
5123 #ifdef CONFIG_SLUB_DEBUG
5124 static void validate_slab(struct kmem_cache *s, struct slab *slab,
5125 unsigned long *obj_map)
5128 void *addr = slab_address(slab);
5130 if (!check_slab(s, slab) || !on_freelist(s, slab, NULL))
5133 /* Now we know that a valid freelist exists */
5134 __fill_map(obj_map, s, slab);
5135 for_each_object(p, s, addr, slab->objects) {
5136 u8 val = test_bit(__obj_to_index(s, addr, p), obj_map) ?
5137 SLUB_RED_INACTIVE : SLUB_RED_ACTIVE;
5139 if (!check_object(s, slab, p, val))
5144 static int validate_slab_node(struct kmem_cache *s,
5145 struct kmem_cache_node *n, unsigned long *obj_map)
5147 unsigned long count = 0;
5149 unsigned long flags;
5151 spin_lock_irqsave(&n->list_lock, flags);
5153 list_for_each_entry(slab, &n->partial, slab_list) {
5154 validate_slab(s, slab, obj_map);
5157 if (count != n->nr_partial) {
5158 pr_err("SLUB %s: %ld partial slabs counted but counter=%ld\n",
5159 s->name, count, n->nr_partial);
5160 slab_add_kunit_errors();
5163 if (!(s->flags & SLAB_STORE_USER))
5166 list_for_each_entry(slab, &n->full, slab_list) {
5167 validate_slab(s, slab, obj_map);
5170 if (count != atomic_long_read(&n->nr_slabs)) {
5171 pr_err("SLUB: %s %ld slabs counted but counter=%ld\n",
5172 s->name, count, atomic_long_read(&n->nr_slabs));
5173 slab_add_kunit_errors();
5177 spin_unlock_irqrestore(&n->list_lock, flags);
5181 long validate_slab_cache(struct kmem_cache *s)
5184 unsigned long count = 0;
5185 struct kmem_cache_node *n;
5186 unsigned long *obj_map;
5188 obj_map = bitmap_alloc(oo_objects(s->oo), GFP_KERNEL);
5193 for_each_kmem_cache_node(s, node, n)
5194 count += validate_slab_node(s, n, obj_map);
5196 bitmap_free(obj_map);
5200 EXPORT_SYMBOL(validate_slab_cache);
5202 #ifdef CONFIG_DEBUG_FS
5204 * Generate lists of code addresses where slabcache objects are allocated
5209 depot_stack_handle_t handle;
5210 unsigned long count;
5212 unsigned long waste;
5218 DECLARE_BITMAP(cpus, NR_CPUS);
5224 unsigned long count;
5225 struct location *loc;
5229 static struct dentry *slab_debugfs_root;
5231 static void free_loc_track(struct loc_track *t)
5234 free_pages((unsigned long)t->loc,
5235 get_order(sizeof(struct location) * t->max));
5238 static int alloc_loc_track(struct loc_track *t, unsigned long max, gfp_t flags)
5243 order = get_order(sizeof(struct location) * max);
5245 l = (void *)__get_free_pages(flags, order);
5250 memcpy(l, t->loc, sizeof(struct location) * t->count);
5258 static int add_location(struct loc_track *t, struct kmem_cache *s,
5259 const struct track *track,
5260 unsigned int orig_size)
5262 long start, end, pos;
5264 unsigned long caddr, chandle, cwaste;
5265 unsigned long age = jiffies - track->when;
5266 depot_stack_handle_t handle = 0;
5267 unsigned int waste = s->object_size - orig_size;
5269 #ifdef CONFIG_STACKDEPOT
5270 handle = READ_ONCE(track->handle);
5276 pos = start + (end - start + 1) / 2;
5279 * There is nothing at "end". If we end up there
5280 * we need to add something to before end.
5287 chandle = l->handle;
5289 if ((track->addr == caddr) && (handle == chandle) &&
5290 (waste == cwaste)) {
5295 if (age < l->min_time)
5297 if (age > l->max_time)
5300 if (track->pid < l->min_pid)
5301 l->min_pid = track->pid;
5302 if (track->pid > l->max_pid)
5303 l->max_pid = track->pid;
5305 cpumask_set_cpu(track->cpu,
5306 to_cpumask(l->cpus));
5308 node_set(page_to_nid(virt_to_page(track)), l->nodes);
5312 if (track->addr < caddr)
5314 else if (track->addr == caddr && handle < chandle)
5316 else if (track->addr == caddr && handle == chandle &&
5324 * Not found. Insert new tracking element.
5326 if (t->count >= t->max && !alloc_loc_track(t, 2 * t->max, GFP_ATOMIC))
5332 (t->count - pos) * sizeof(struct location));
5335 l->addr = track->addr;
5339 l->min_pid = track->pid;
5340 l->max_pid = track->pid;
5343 cpumask_clear(to_cpumask(l->cpus));
5344 cpumask_set_cpu(track->cpu, to_cpumask(l->cpus));
5345 nodes_clear(l->nodes);
5346 node_set(page_to_nid(virt_to_page(track)), l->nodes);
5350 static void process_slab(struct loc_track *t, struct kmem_cache *s,
5351 struct slab *slab, enum track_item alloc,
5352 unsigned long *obj_map)
5354 void *addr = slab_address(slab);
5355 bool is_alloc = (alloc == TRACK_ALLOC);
5358 __fill_map(obj_map, s, slab);
5360 for_each_object(p, s, addr, slab->objects)
5361 if (!test_bit(__obj_to_index(s, addr, p), obj_map))
5362 add_location(t, s, get_track(s, p, alloc),
5363 is_alloc ? get_orig_size(s, p) :
5366 #endif /* CONFIG_DEBUG_FS */
5367 #endif /* CONFIG_SLUB_DEBUG */
5369 #ifdef SLAB_SUPPORTS_SYSFS
5370 enum slab_stat_type {
5371 SL_ALL, /* All slabs */
5372 SL_PARTIAL, /* Only partially allocated slabs */
5373 SL_CPU, /* Only slabs used for cpu caches */
5374 SL_OBJECTS, /* Determine allocated objects not slabs */
5375 SL_TOTAL /* Determine object capacity not slabs */
5378 #define SO_ALL (1 << SL_ALL)
5379 #define SO_PARTIAL (1 << SL_PARTIAL)
5380 #define SO_CPU (1 << SL_CPU)
5381 #define SO_OBJECTS (1 << SL_OBJECTS)
5382 #define SO_TOTAL (1 << SL_TOTAL)
5384 static ssize_t show_slab_objects(struct kmem_cache *s,
5385 char *buf, unsigned long flags)
5387 unsigned long total = 0;
5390 unsigned long *nodes;
5393 nodes = kcalloc(nr_node_ids, sizeof(unsigned long), GFP_KERNEL);
5397 if (flags & SO_CPU) {
5400 for_each_possible_cpu(cpu) {
5401 struct kmem_cache_cpu *c = per_cpu_ptr(s->cpu_slab,
5406 slab = READ_ONCE(c->slab);
5410 node = slab_nid(slab);
5411 if (flags & SO_TOTAL)
5413 else if (flags & SO_OBJECTS)
5421 #ifdef CONFIG_SLUB_CPU_PARTIAL
5422 slab = slub_percpu_partial_read_once(c);
5424 node = slab_nid(slab);
5425 if (flags & SO_TOTAL)
5427 else if (flags & SO_OBJECTS)
5439 * It is impossible to take "mem_hotplug_lock" here with "kernfs_mutex"
5440 * already held which will conflict with an existing lock order:
5442 * mem_hotplug_lock->slab_mutex->kernfs_mutex
5444 * We don't really need mem_hotplug_lock (to hold off
5445 * slab_mem_going_offline_callback) here because slab's memory hot
5446 * unplug code doesn't destroy the kmem_cache->node[] data.
5449 #ifdef CONFIG_SLUB_DEBUG
5450 if (flags & SO_ALL) {
5451 struct kmem_cache_node *n;
5453 for_each_kmem_cache_node(s, node, n) {
5455 if (flags & SO_TOTAL)
5456 x = atomic_long_read(&n->total_objects);
5457 else if (flags & SO_OBJECTS)
5458 x = atomic_long_read(&n->total_objects) -
5459 count_partial(n, count_free);
5461 x = atomic_long_read(&n->nr_slabs);
5468 if (flags & SO_PARTIAL) {
5469 struct kmem_cache_node *n;
5471 for_each_kmem_cache_node(s, node, n) {
5472 if (flags & SO_TOTAL)
5473 x = count_partial(n, count_total);
5474 else if (flags & SO_OBJECTS)
5475 x = count_partial(n, count_inuse);
5483 len += sysfs_emit_at(buf, len, "%lu", total);
5485 for (node = 0; node < nr_node_ids; node++) {
5487 len += sysfs_emit_at(buf, len, " N%d=%lu",
5491 len += sysfs_emit_at(buf, len, "\n");
5497 #define to_slab_attr(n) container_of(n, struct slab_attribute, attr)
5498 #define to_slab(n) container_of(n, struct kmem_cache, kobj)
5500 struct slab_attribute {
5501 struct attribute attr;
5502 ssize_t (*show)(struct kmem_cache *s, char *buf);
5503 ssize_t (*store)(struct kmem_cache *s, const char *x, size_t count);
5506 #define SLAB_ATTR_RO(_name) \
5507 static struct slab_attribute _name##_attr = __ATTR_RO_MODE(_name, 0400)
5509 #define SLAB_ATTR(_name) \
5510 static struct slab_attribute _name##_attr = __ATTR_RW_MODE(_name, 0600)
5512 static ssize_t slab_size_show(struct kmem_cache *s, char *buf)
5514 return sysfs_emit(buf, "%u\n", s->size);
5516 SLAB_ATTR_RO(slab_size);
5518 static ssize_t align_show(struct kmem_cache *s, char *buf)
5520 return sysfs_emit(buf, "%u\n", s->align);
5522 SLAB_ATTR_RO(align);
5524 static ssize_t object_size_show(struct kmem_cache *s, char *buf)
5526 return sysfs_emit(buf, "%u\n", s->object_size);
5528 SLAB_ATTR_RO(object_size);
5530 static ssize_t objs_per_slab_show(struct kmem_cache *s, char *buf)
5532 return sysfs_emit(buf, "%u\n", oo_objects(s->oo));
5534 SLAB_ATTR_RO(objs_per_slab);
5536 static ssize_t order_show(struct kmem_cache *s, char *buf)
5538 return sysfs_emit(buf, "%u\n", oo_order(s->oo));
5540 SLAB_ATTR_RO(order);
5542 static ssize_t min_partial_show(struct kmem_cache *s, char *buf)
5544 return sysfs_emit(buf, "%lu\n", s->min_partial);
5547 static ssize_t min_partial_store(struct kmem_cache *s, const char *buf,
5553 err = kstrtoul(buf, 10, &min);
5557 s->min_partial = min;
5560 SLAB_ATTR(min_partial);
5562 static ssize_t cpu_partial_show(struct kmem_cache *s, char *buf)
5564 unsigned int nr_partial = 0;
5565 #ifdef CONFIG_SLUB_CPU_PARTIAL
5566 nr_partial = s->cpu_partial;
5569 return sysfs_emit(buf, "%u\n", nr_partial);
5572 static ssize_t cpu_partial_store(struct kmem_cache *s, const char *buf,
5575 unsigned int objects;
5578 err = kstrtouint(buf, 10, &objects);
5581 if (objects && !kmem_cache_has_cpu_partial(s))
5584 slub_set_cpu_partial(s, objects);
5588 SLAB_ATTR(cpu_partial);
5590 static ssize_t ctor_show(struct kmem_cache *s, char *buf)
5594 return sysfs_emit(buf, "%pS\n", s->ctor);
5598 static ssize_t aliases_show(struct kmem_cache *s, char *buf)
5600 return sysfs_emit(buf, "%d\n", s->refcount < 0 ? 0 : s->refcount - 1);
5602 SLAB_ATTR_RO(aliases);
5604 static ssize_t partial_show(struct kmem_cache *s, char *buf)
5606 return show_slab_objects(s, buf, SO_PARTIAL);
5608 SLAB_ATTR_RO(partial);
5610 static ssize_t cpu_slabs_show(struct kmem_cache *s, char *buf)
5612 return show_slab_objects(s, buf, SO_CPU);
5614 SLAB_ATTR_RO(cpu_slabs);
5616 static ssize_t objects_show(struct kmem_cache *s, char *buf)
5618 return show_slab_objects(s, buf, SO_ALL|SO_OBJECTS);
5620 SLAB_ATTR_RO(objects);
5622 static ssize_t objects_partial_show(struct kmem_cache *s, char *buf)
5624 return show_slab_objects(s, buf, SO_PARTIAL|SO_OBJECTS);
5626 SLAB_ATTR_RO(objects_partial);
5628 static ssize_t slabs_cpu_partial_show(struct kmem_cache *s, char *buf)
5632 int cpu __maybe_unused;
5635 #ifdef CONFIG_SLUB_CPU_PARTIAL
5636 for_each_online_cpu(cpu) {
5639 slab = slub_percpu_partial(per_cpu_ptr(s->cpu_slab, cpu));
5642 slabs += slab->slabs;
5646 /* Approximate half-full slabs, see slub_set_cpu_partial() */
5647 objects = (slabs * oo_objects(s->oo)) / 2;
5648 len += sysfs_emit_at(buf, len, "%d(%d)", objects, slabs);
5650 #if defined(CONFIG_SLUB_CPU_PARTIAL) && defined(CONFIG_SMP)
5651 for_each_online_cpu(cpu) {
5654 slab = slub_percpu_partial(per_cpu_ptr(s->cpu_slab, cpu));
5656 slabs = READ_ONCE(slab->slabs);
5657 objects = (slabs * oo_objects(s->oo)) / 2;
5658 len += sysfs_emit_at(buf, len, " C%d=%d(%d)",
5659 cpu, objects, slabs);
5663 len += sysfs_emit_at(buf, len, "\n");
5667 SLAB_ATTR_RO(slabs_cpu_partial);
5669 static ssize_t reclaim_account_show(struct kmem_cache *s, char *buf)
5671 return sysfs_emit(buf, "%d\n", !!(s->flags & SLAB_RECLAIM_ACCOUNT));
5673 SLAB_ATTR_RO(reclaim_account);
5675 static ssize_t hwcache_align_show(struct kmem_cache *s, char *buf)
5677 return sysfs_emit(buf, "%d\n", !!(s->flags & SLAB_HWCACHE_ALIGN));
5679 SLAB_ATTR_RO(hwcache_align);
5681 #ifdef CONFIG_ZONE_DMA
5682 static ssize_t cache_dma_show(struct kmem_cache *s, char *buf)
5684 return sysfs_emit(buf, "%d\n", !!(s->flags & SLAB_CACHE_DMA));
5686 SLAB_ATTR_RO(cache_dma);
5689 #ifdef CONFIG_HARDENED_USERCOPY
5690 static ssize_t usersize_show(struct kmem_cache *s, char *buf)
5692 return sysfs_emit(buf, "%u\n", s->usersize);
5694 SLAB_ATTR_RO(usersize);
5697 static ssize_t destroy_by_rcu_show(struct kmem_cache *s, char *buf)
5699 return sysfs_emit(buf, "%d\n", !!(s->flags & SLAB_TYPESAFE_BY_RCU));
5701 SLAB_ATTR_RO(destroy_by_rcu);
5703 #ifdef CONFIG_SLUB_DEBUG
5704 static ssize_t slabs_show(struct kmem_cache *s, char *buf)
5706 return show_slab_objects(s, buf, SO_ALL);
5708 SLAB_ATTR_RO(slabs);
5710 static ssize_t total_objects_show(struct kmem_cache *s, char *buf)
5712 return show_slab_objects(s, buf, SO_ALL|SO_TOTAL);
5714 SLAB_ATTR_RO(total_objects);
5716 static ssize_t sanity_checks_show(struct kmem_cache *s, char *buf)
5718 return sysfs_emit(buf, "%d\n", !!(s->flags & SLAB_CONSISTENCY_CHECKS));
5720 SLAB_ATTR_RO(sanity_checks);
5722 static ssize_t trace_show(struct kmem_cache *s, char *buf)
5724 return sysfs_emit(buf, "%d\n", !!(s->flags & SLAB_TRACE));
5726 SLAB_ATTR_RO(trace);
5728 static ssize_t red_zone_show(struct kmem_cache *s, char *buf)
5730 return sysfs_emit(buf, "%d\n", !!(s->flags & SLAB_RED_ZONE));
5733 SLAB_ATTR_RO(red_zone);
5735 static ssize_t poison_show(struct kmem_cache *s, char *buf)
5737 return sysfs_emit(buf, "%d\n", !!(s->flags & SLAB_POISON));
5740 SLAB_ATTR_RO(poison);
5742 static ssize_t store_user_show(struct kmem_cache *s, char *buf)
5744 return sysfs_emit(buf, "%d\n", !!(s->flags & SLAB_STORE_USER));
5747 SLAB_ATTR_RO(store_user);
5749 static ssize_t validate_show(struct kmem_cache *s, char *buf)
5754 static ssize_t validate_store(struct kmem_cache *s,
5755 const char *buf, size_t length)
5759 if (buf[0] == '1' && kmem_cache_debug(s)) {
5760 ret = validate_slab_cache(s);
5766 SLAB_ATTR(validate);
5768 #endif /* CONFIG_SLUB_DEBUG */
5770 #ifdef CONFIG_FAILSLAB
5771 static ssize_t failslab_show(struct kmem_cache *s, char *buf)
5773 return sysfs_emit(buf, "%d\n", !!(s->flags & SLAB_FAILSLAB));
5776 static ssize_t failslab_store(struct kmem_cache *s, const char *buf,
5779 if (s->refcount > 1)
5783 WRITE_ONCE(s->flags, s->flags | SLAB_FAILSLAB);
5785 WRITE_ONCE(s->flags, s->flags & ~SLAB_FAILSLAB);
5789 SLAB_ATTR(failslab);
5792 static ssize_t shrink_show(struct kmem_cache *s, char *buf)
5797 static ssize_t shrink_store(struct kmem_cache *s,
5798 const char *buf, size_t length)
5801 kmem_cache_shrink(s);
5809 static ssize_t remote_node_defrag_ratio_show(struct kmem_cache *s, char *buf)
5811 return sysfs_emit(buf, "%u\n", s->remote_node_defrag_ratio / 10);
5814 static ssize_t remote_node_defrag_ratio_store(struct kmem_cache *s,
5815 const char *buf, size_t length)
5820 err = kstrtouint(buf, 10, &ratio);
5826 s->remote_node_defrag_ratio = ratio * 10;
5830 SLAB_ATTR(remote_node_defrag_ratio);
5833 #ifdef CONFIG_SLUB_STATS
5834 static int show_stat(struct kmem_cache *s, char *buf, enum stat_item si)
5836 unsigned long sum = 0;
5839 int *data = kmalloc_array(nr_cpu_ids, sizeof(int), GFP_KERNEL);
5844 for_each_online_cpu(cpu) {
5845 unsigned x = per_cpu_ptr(s->cpu_slab, cpu)->stat[si];
5851 len += sysfs_emit_at(buf, len, "%lu", sum);
5854 for_each_online_cpu(cpu) {
5856 len += sysfs_emit_at(buf, len, " C%d=%u",
5861 len += sysfs_emit_at(buf, len, "\n");
5866 static void clear_stat(struct kmem_cache *s, enum stat_item si)
5870 for_each_online_cpu(cpu)
5871 per_cpu_ptr(s->cpu_slab, cpu)->stat[si] = 0;
5874 #define STAT_ATTR(si, text) \
5875 static ssize_t text##_show(struct kmem_cache *s, char *buf) \
5877 return show_stat(s, buf, si); \
5879 static ssize_t text##_store(struct kmem_cache *s, \
5880 const char *buf, size_t length) \
5882 if (buf[0] != '0') \
5884 clear_stat(s, si); \
5889 STAT_ATTR(ALLOC_FASTPATH, alloc_fastpath);
5890 STAT_ATTR(ALLOC_SLOWPATH, alloc_slowpath);
5891 STAT_ATTR(FREE_FASTPATH, free_fastpath);
5892 STAT_ATTR(FREE_SLOWPATH, free_slowpath);
5893 STAT_ATTR(FREE_FROZEN, free_frozen);
5894 STAT_ATTR(FREE_ADD_PARTIAL, free_add_partial);
5895 STAT_ATTR(FREE_REMOVE_PARTIAL, free_remove_partial);
5896 STAT_ATTR(ALLOC_FROM_PARTIAL, alloc_from_partial);
5897 STAT_ATTR(ALLOC_SLAB, alloc_slab);
5898 STAT_ATTR(ALLOC_REFILL, alloc_refill);
5899 STAT_ATTR(ALLOC_NODE_MISMATCH, alloc_node_mismatch);
5900 STAT_ATTR(FREE_SLAB, free_slab);
5901 STAT_ATTR(CPUSLAB_FLUSH, cpuslab_flush);
5902 STAT_ATTR(DEACTIVATE_FULL, deactivate_full);
5903 STAT_ATTR(DEACTIVATE_EMPTY, deactivate_empty);
5904 STAT_ATTR(DEACTIVATE_TO_HEAD, deactivate_to_head);
5905 STAT_ATTR(DEACTIVATE_TO_TAIL, deactivate_to_tail);
5906 STAT_ATTR(DEACTIVATE_REMOTE_FREES, deactivate_remote_frees);
5907 STAT_ATTR(DEACTIVATE_BYPASS, deactivate_bypass);
5908 STAT_ATTR(ORDER_FALLBACK, order_fallback);
5909 STAT_ATTR(CMPXCHG_DOUBLE_CPU_FAIL, cmpxchg_double_cpu_fail);
5910 STAT_ATTR(CMPXCHG_DOUBLE_FAIL, cmpxchg_double_fail);
5911 STAT_ATTR(CPU_PARTIAL_ALLOC, cpu_partial_alloc);
5912 STAT_ATTR(CPU_PARTIAL_FREE, cpu_partial_free);
5913 STAT_ATTR(CPU_PARTIAL_NODE, cpu_partial_node);
5914 STAT_ATTR(CPU_PARTIAL_DRAIN, cpu_partial_drain);
5915 #endif /* CONFIG_SLUB_STATS */
5917 #ifdef CONFIG_KFENCE
5918 static ssize_t skip_kfence_show(struct kmem_cache *s, char *buf)
5920 return sysfs_emit(buf, "%d\n", !!(s->flags & SLAB_SKIP_KFENCE));
5923 static ssize_t skip_kfence_store(struct kmem_cache *s,
5924 const char *buf, size_t length)
5929 s->flags &= ~SLAB_SKIP_KFENCE;
5930 else if (buf[0] == '1')
5931 s->flags |= SLAB_SKIP_KFENCE;
5937 SLAB_ATTR(skip_kfence);
5940 static struct attribute *slab_attrs[] = {
5941 &slab_size_attr.attr,
5942 &object_size_attr.attr,
5943 &objs_per_slab_attr.attr,
5945 &min_partial_attr.attr,
5946 &cpu_partial_attr.attr,
5948 &objects_partial_attr.attr,
5950 &cpu_slabs_attr.attr,
5954 &hwcache_align_attr.attr,
5955 &reclaim_account_attr.attr,
5956 &destroy_by_rcu_attr.attr,
5958 &slabs_cpu_partial_attr.attr,
5959 #ifdef CONFIG_SLUB_DEBUG
5960 &total_objects_attr.attr,
5962 &sanity_checks_attr.attr,
5964 &red_zone_attr.attr,
5966 &store_user_attr.attr,
5967 &validate_attr.attr,
5969 #ifdef CONFIG_ZONE_DMA
5970 &cache_dma_attr.attr,
5973 &remote_node_defrag_ratio_attr.attr,
5975 #ifdef CONFIG_SLUB_STATS
5976 &alloc_fastpath_attr.attr,
5977 &alloc_slowpath_attr.attr,
5978 &free_fastpath_attr.attr,
5979 &free_slowpath_attr.attr,
5980 &free_frozen_attr.attr,
5981 &free_add_partial_attr.attr,
5982 &free_remove_partial_attr.attr,
5983 &alloc_from_partial_attr.attr,
5984 &alloc_slab_attr.attr,
5985 &alloc_refill_attr.attr,
5986 &alloc_node_mismatch_attr.attr,
5987 &free_slab_attr.attr,
5988 &cpuslab_flush_attr.attr,
5989 &deactivate_full_attr.attr,
5990 &deactivate_empty_attr.attr,
5991 &deactivate_to_head_attr.attr,
5992 &deactivate_to_tail_attr.attr,
5993 &deactivate_remote_frees_attr.attr,
5994 &deactivate_bypass_attr.attr,
5995 &order_fallback_attr.attr,
5996 &cmpxchg_double_fail_attr.attr,
5997 &cmpxchg_double_cpu_fail_attr.attr,
5998 &cpu_partial_alloc_attr.attr,
5999 &cpu_partial_free_attr.attr,
6000 &cpu_partial_node_attr.attr,
6001 &cpu_partial_drain_attr.attr,
6003 #ifdef CONFIG_FAILSLAB
6004 &failslab_attr.attr,
6006 #ifdef CONFIG_HARDENED_USERCOPY
6007 &usersize_attr.attr,
6009 #ifdef CONFIG_KFENCE
6010 &skip_kfence_attr.attr,
6016 static const struct attribute_group slab_attr_group = {
6017 .attrs = slab_attrs,
6020 static ssize_t slab_attr_show(struct kobject *kobj,
6021 struct attribute *attr,
6024 struct slab_attribute *attribute;
6025 struct kmem_cache *s;
6027 attribute = to_slab_attr(attr);
6030 if (!attribute->show)
6033 return attribute->show(s, buf);
6036 static ssize_t slab_attr_store(struct kobject *kobj,
6037 struct attribute *attr,
6038 const char *buf, size_t len)
6040 struct slab_attribute *attribute;
6041 struct kmem_cache *s;
6043 attribute = to_slab_attr(attr);
6046 if (!attribute->store)
6049 return attribute->store(s, buf, len);
6052 static void kmem_cache_release(struct kobject *k)
6054 slab_kmem_cache_release(to_slab(k));
6057 static const struct sysfs_ops slab_sysfs_ops = {
6058 .show = slab_attr_show,
6059 .store = slab_attr_store,
6062 static struct kobj_type slab_ktype = {
6063 .sysfs_ops = &slab_sysfs_ops,
6064 .release = kmem_cache_release,
6067 static struct kset *slab_kset;
6069 static inline struct kset *cache_kset(struct kmem_cache *s)
6074 #define ID_STR_LENGTH 32
6076 /* Create a unique string id for a slab cache:
6078 * Format :[flags-]size
6080 static char *create_unique_id(struct kmem_cache *s)
6082 char *name = kmalloc(ID_STR_LENGTH, GFP_KERNEL);
6086 return ERR_PTR(-ENOMEM);
6090 * First flags affecting slabcache operations. We will only
6091 * get here for aliasable slabs so we do not need to support
6092 * too many flags. The flags here must cover all flags that
6093 * are matched during merging to guarantee that the id is
6096 if (s->flags & SLAB_CACHE_DMA)
6098 if (s->flags & SLAB_CACHE_DMA32)
6100 if (s->flags & SLAB_RECLAIM_ACCOUNT)
6102 if (s->flags & SLAB_CONSISTENCY_CHECKS)
6104 if (s->flags & SLAB_ACCOUNT)
6108 p += snprintf(p, ID_STR_LENGTH - (p - name), "%07u", s->size);
6110 if (WARN_ON(p > name + ID_STR_LENGTH - 1)) {
6112 return ERR_PTR(-EINVAL);
6114 kmsan_unpoison_memory(name, p - name);
6118 static int sysfs_slab_add(struct kmem_cache *s)
6122 struct kset *kset = cache_kset(s);
6123 int unmergeable = slab_unmergeable(s);
6125 if (!unmergeable && disable_higher_order_debug &&
6126 (slub_debug & DEBUG_METADATA_FLAGS))
6131 * Slabcache can never be merged so we can use the name proper.
6132 * This is typically the case for debug situations. In that
6133 * case we can catch duplicate names easily.
6135 sysfs_remove_link(&slab_kset->kobj, s->name);
6139 * Create a unique name for the slab as a target
6142 name = create_unique_id(s);
6144 return PTR_ERR(name);
6147 s->kobj.kset = kset;
6148 err = kobject_init_and_add(&s->kobj, &slab_ktype, NULL, "%s", name);
6152 err = sysfs_create_group(&s->kobj, &slab_attr_group);
6157 /* Setup first alias */
6158 sysfs_slab_alias(s, s->name);
6165 kobject_del(&s->kobj);
6169 void sysfs_slab_unlink(struct kmem_cache *s)
6171 if (slab_state >= FULL)
6172 kobject_del(&s->kobj);
6175 void sysfs_slab_release(struct kmem_cache *s)
6177 if (slab_state >= FULL)
6178 kobject_put(&s->kobj);
6182 * Need to buffer aliases during bootup until sysfs becomes
6183 * available lest we lose that information.
6185 struct saved_alias {
6186 struct kmem_cache *s;
6188 struct saved_alias *next;
6191 static struct saved_alias *alias_list;
6193 static int sysfs_slab_alias(struct kmem_cache *s, const char *name)
6195 struct saved_alias *al;
6197 if (slab_state == FULL) {
6199 * If we have a leftover link then remove it.
6201 sysfs_remove_link(&slab_kset->kobj, name);
6202 return sysfs_create_link(&slab_kset->kobj, &s->kobj, name);
6205 al = kmalloc(sizeof(struct saved_alias), GFP_KERNEL);
6211 al->next = alias_list;
6213 kmsan_unpoison_memory(al, sizeof(*al));
6217 static int __init slab_sysfs_init(void)
6219 struct kmem_cache *s;
6222 mutex_lock(&slab_mutex);
6224 slab_kset = kset_create_and_add("slab", NULL, kernel_kobj);
6226 mutex_unlock(&slab_mutex);
6227 pr_err("Cannot register slab subsystem.\n");
6233 list_for_each_entry(s, &slab_caches, list) {
6234 err = sysfs_slab_add(s);
6236 pr_err("SLUB: Unable to add boot slab %s to sysfs\n",
6240 while (alias_list) {
6241 struct saved_alias *al = alias_list;
6243 alias_list = alias_list->next;
6244 err = sysfs_slab_alias(al->s, al->name);
6246 pr_err("SLUB: Unable to add boot slab alias %s to sysfs\n",
6251 mutex_unlock(&slab_mutex);
6254 late_initcall(slab_sysfs_init);
6255 #endif /* SLAB_SUPPORTS_SYSFS */
6257 #if defined(CONFIG_SLUB_DEBUG) && defined(CONFIG_DEBUG_FS)
6258 static int slab_debugfs_show(struct seq_file *seq, void *v)
6260 struct loc_track *t = seq->private;
6264 idx = (unsigned long) t->idx;
6265 if (idx < t->count) {
6268 seq_printf(seq, "%7ld ", l->count);
6271 seq_printf(seq, "%pS", (void *)l->addr);
6273 seq_puts(seq, "<not-available>");
6276 seq_printf(seq, " waste=%lu/%lu",
6277 l->count * l->waste, l->waste);
6279 if (l->sum_time != l->min_time) {
6280 seq_printf(seq, " age=%ld/%llu/%ld",
6281 l->min_time, div_u64(l->sum_time, l->count),
6284 seq_printf(seq, " age=%ld", l->min_time);
6286 if (l->min_pid != l->max_pid)
6287 seq_printf(seq, " pid=%ld-%ld", l->min_pid, l->max_pid);
6289 seq_printf(seq, " pid=%ld",
6292 if (num_online_cpus() > 1 && !cpumask_empty(to_cpumask(l->cpus)))
6293 seq_printf(seq, " cpus=%*pbl",
6294 cpumask_pr_args(to_cpumask(l->cpus)));
6296 if (nr_online_nodes > 1 && !nodes_empty(l->nodes))
6297 seq_printf(seq, " nodes=%*pbl",
6298 nodemask_pr_args(&l->nodes));
6300 #ifdef CONFIG_STACKDEPOT
6302 depot_stack_handle_t handle;
6303 unsigned long *entries;
6304 unsigned int nr_entries, j;
6306 handle = READ_ONCE(l->handle);
6308 nr_entries = stack_depot_fetch(handle, &entries);
6309 seq_puts(seq, "\n");
6310 for (j = 0; j < nr_entries; j++)
6311 seq_printf(seq, " %pS\n", (void *)entries[j]);
6315 seq_puts(seq, "\n");
6318 if (!idx && !t->count)
6319 seq_puts(seq, "No data\n");
6324 static void slab_debugfs_stop(struct seq_file *seq, void *v)
6328 static void *slab_debugfs_next(struct seq_file *seq, void *v, loff_t *ppos)
6330 struct loc_track *t = seq->private;
6333 if (*ppos <= t->count)
6339 static int cmp_loc_by_count(const void *a, const void *b, const void *data)
6341 struct location *loc1 = (struct location *)a;
6342 struct location *loc2 = (struct location *)b;
6344 if (loc1->count > loc2->count)
6350 static void *slab_debugfs_start(struct seq_file *seq, loff_t *ppos)
6352 struct loc_track *t = seq->private;
6358 static const struct seq_operations slab_debugfs_sops = {
6359 .start = slab_debugfs_start,
6360 .next = slab_debugfs_next,
6361 .stop = slab_debugfs_stop,
6362 .show = slab_debugfs_show,
6365 static int slab_debug_trace_open(struct inode *inode, struct file *filep)
6368 struct kmem_cache_node *n;
6369 enum track_item alloc;
6371 struct loc_track *t = __seq_open_private(filep, &slab_debugfs_sops,
6372 sizeof(struct loc_track));
6373 struct kmem_cache *s = file_inode(filep)->i_private;
6374 unsigned long *obj_map;
6379 obj_map = bitmap_alloc(oo_objects(s->oo), GFP_KERNEL);
6381 seq_release_private(inode, filep);
6385 if (strcmp(filep->f_path.dentry->d_name.name, "alloc_traces") == 0)
6386 alloc = TRACK_ALLOC;
6390 if (!alloc_loc_track(t, PAGE_SIZE / sizeof(struct location), GFP_KERNEL)) {
6391 bitmap_free(obj_map);
6392 seq_release_private(inode, filep);
6396 for_each_kmem_cache_node(s, node, n) {
6397 unsigned long flags;
6400 if (!atomic_long_read(&n->nr_slabs))
6403 spin_lock_irqsave(&n->list_lock, flags);
6404 list_for_each_entry(slab, &n->partial, slab_list)
6405 process_slab(t, s, slab, alloc, obj_map);
6406 list_for_each_entry(slab, &n->full, slab_list)
6407 process_slab(t, s, slab, alloc, obj_map);
6408 spin_unlock_irqrestore(&n->list_lock, flags);
6411 /* Sort locations by count */
6412 sort_r(t->loc, t->count, sizeof(struct location),
6413 cmp_loc_by_count, NULL, NULL);
6415 bitmap_free(obj_map);
6419 static int slab_debug_trace_release(struct inode *inode, struct file *file)
6421 struct seq_file *seq = file->private_data;
6422 struct loc_track *t = seq->private;
6425 return seq_release_private(inode, file);
6428 static const struct file_operations slab_debugfs_fops = {
6429 .open = slab_debug_trace_open,
6431 .llseek = seq_lseek,
6432 .release = slab_debug_trace_release,
6435 static void debugfs_slab_add(struct kmem_cache *s)
6437 struct dentry *slab_cache_dir;
6439 if (unlikely(!slab_debugfs_root))
6442 slab_cache_dir = debugfs_create_dir(s->name, slab_debugfs_root);
6444 debugfs_create_file("alloc_traces", 0400,
6445 slab_cache_dir, s, &slab_debugfs_fops);
6447 debugfs_create_file("free_traces", 0400,
6448 slab_cache_dir, s, &slab_debugfs_fops);
6451 void debugfs_slab_release(struct kmem_cache *s)
6453 debugfs_lookup_and_remove(s->name, slab_debugfs_root);
6456 static int __init slab_debugfs_init(void)
6458 struct kmem_cache *s;
6460 slab_debugfs_root = debugfs_create_dir("slab", NULL);
6462 list_for_each_entry(s, &slab_caches, list)
6463 if (s->flags & SLAB_STORE_USER)
6464 debugfs_slab_add(s);
6469 __initcall(slab_debugfs_init);
6472 * The /proc/slabinfo ABI
6474 #ifdef CONFIG_SLUB_DEBUG
6475 void get_slabinfo(struct kmem_cache *s, struct slabinfo *sinfo)
6477 unsigned long nr_slabs = 0;
6478 unsigned long nr_objs = 0;
6479 unsigned long nr_free = 0;
6481 struct kmem_cache_node *n;
6483 for_each_kmem_cache_node(s, node, n) {
6484 nr_slabs += node_nr_slabs(n);
6485 nr_objs += node_nr_objs(n);
6486 nr_free += count_partial(n, count_free);
6489 sinfo->active_objs = nr_objs - nr_free;
6490 sinfo->num_objs = nr_objs;
6491 sinfo->active_slabs = nr_slabs;
6492 sinfo->num_slabs = nr_slabs;
6493 sinfo->objects_per_slab = oo_objects(s->oo);
6494 sinfo->cache_order = oo_order(s->oo);
6497 void slabinfo_show_stats(struct seq_file *m, struct kmem_cache *s)
6501 ssize_t slabinfo_write(struct file *file, const char __user *buffer,
6502 size_t count, loff_t *ppos)
6506 #endif /* CONFIG_SLUB_DEBUG */