1 // SPDX-License-Identifier: GPL-2.0
3 * Generic infrastructure for lifetime debugging of objects.
8 #define pr_fmt(fmt) "ODEBUG: " fmt
10 #include <linux/debugobjects.h>
11 #include <linux/interrupt.h>
12 #include <linux/sched.h>
13 #include <linux/sched/task_stack.h>
14 #include <linux/seq_file.h>
15 #include <linux/debugfs.h>
16 #include <linux/slab.h>
17 #include <linux/hash.h>
18 #include <linux/kmemleak.h>
19 #include <linux/cpu.h>
21 #define ODEBUG_HASH_BITS 14
22 #define ODEBUG_HASH_SIZE (1 << ODEBUG_HASH_BITS)
24 #define ODEBUG_POOL_SIZE 1024
25 #define ODEBUG_POOL_MIN_LEVEL 256
26 #define ODEBUG_POOL_PERCPU_SIZE 64
27 #define ODEBUG_BATCH_SIZE 16
29 #define ODEBUG_CHUNK_SHIFT PAGE_SHIFT
30 #define ODEBUG_CHUNK_SIZE (1 << ODEBUG_CHUNK_SHIFT)
31 #define ODEBUG_CHUNK_MASK (~(ODEBUG_CHUNK_SIZE - 1))
34 * We limit the freeing of debug objects via workqueue at a maximum
35 * frequency of 10Hz and about 1024 objects for each freeing operation.
36 * So it is freeing at most 10k debug objects per second.
38 #define ODEBUG_FREE_WORK_MAX 1024
39 #define ODEBUG_FREE_WORK_DELAY DIV_ROUND_UP(HZ, 10)
42 struct hlist_head list;
47 * Debug object percpu free list
48 * Access is protected by disabling irq
50 struct debug_percpu_free {
51 struct hlist_head free_objs;
55 static DEFINE_PER_CPU(struct debug_percpu_free, percpu_obj_pool);
57 static struct debug_bucket obj_hash[ODEBUG_HASH_SIZE];
59 static struct debug_obj obj_static_pool[ODEBUG_POOL_SIZE] __initdata;
61 static DEFINE_RAW_SPINLOCK(pool_lock);
63 static HLIST_HEAD(obj_pool);
64 static HLIST_HEAD(obj_to_free);
67 * Because of the presence of percpu free pools, obj_pool_free will
68 * under-count those in the percpu free pools. Similarly, obj_pool_used
69 * will over-count those in the percpu free pools. Adjustments will be
70 * made at debug_stats_show(). Both obj_pool_min_free and obj_pool_max_used
73 static int obj_pool_min_free = ODEBUG_POOL_SIZE;
74 static int obj_pool_free = ODEBUG_POOL_SIZE;
75 static int obj_pool_used;
76 static int obj_pool_max_used;
77 static bool obj_freeing;
78 /* The number of objs on the global free list */
79 static int obj_nr_tofree;
81 static int debug_objects_maxchain __read_mostly;
82 static int __maybe_unused debug_objects_maxchecked __read_mostly;
83 static int debug_objects_fixups __read_mostly;
84 static int debug_objects_warnings __read_mostly;
85 static int debug_objects_enabled __read_mostly
86 = CONFIG_DEBUG_OBJECTS_ENABLE_DEFAULT;
87 static int debug_objects_pool_size __read_mostly
89 static int debug_objects_pool_min_level __read_mostly
90 = ODEBUG_POOL_MIN_LEVEL;
91 static const struct debug_obj_descr *descr_test __read_mostly;
92 static struct kmem_cache *obj_cache __read_mostly;
95 * Track numbers of kmem_cache_alloc()/free() calls done.
97 static int debug_objects_allocated;
98 static int debug_objects_freed;
100 static void free_obj_work(struct work_struct *work);
101 static DECLARE_DELAYED_WORK(debug_obj_work, free_obj_work);
103 static int __init enable_object_debug(char *str)
105 debug_objects_enabled = 1;
109 static int __init disable_object_debug(char *str)
111 debug_objects_enabled = 0;
115 early_param("debug_objects", enable_object_debug);
116 early_param("no_debug_objects", disable_object_debug);
118 static const char *obj_states[ODEBUG_STATE_MAX] = {
119 [ODEBUG_STATE_NONE] = "none",
120 [ODEBUG_STATE_INIT] = "initialized",
121 [ODEBUG_STATE_INACTIVE] = "inactive",
122 [ODEBUG_STATE_ACTIVE] = "active",
123 [ODEBUG_STATE_DESTROYED] = "destroyed",
124 [ODEBUG_STATE_NOTAVAILABLE] = "not available",
127 static void fill_pool(void)
129 gfp_t gfp = __GFP_HIGH | __GFP_NOWARN;
130 struct debug_obj *obj;
133 if (likely(READ_ONCE(obj_pool_free) >= debug_objects_pool_min_level))
137 * Reuse objs from the global free list; they will be reinitialized
140 * Both obj_nr_tofree and obj_pool_free are checked locklessly; the
141 * READ_ONCE()s pair with the WRITE_ONCE()s in pool_lock critical
144 while (READ_ONCE(obj_nr_tofree) && (READ_ONCE(obj_pool_free) < obj_pool_min_free)) {
145 raw_spin_lock_irqsave(&pool_lock, flags);
147 * Recheck with the lock held as the worker thread might have
148 * won the race and freed the global free list already.
150 while (obj_nr_tofree && (obj_pool_free < obj_pool_min_free)) {
151 obj = hlist_entry(obj_to_free.first, typeof(*obj), node);
152 hlist_del(&obj->node);
153 WRITE_ONCE(obj_nr_tofree, obj_nr_tofree - 1);
154 hlist_add_head(&obj->node, &obj_pool);
155 WRITE_ONCE(obj_pool_free, obj_pool_free + 1);
157 raw_spin_unlock_irqrestore(&pool_lock, flags);
160 if (unlikely(!obj_cache))
163 while (READ_ONCE(obj_pool_free) < debug_objects_pool_min_level) {
164 struct debug_obj *new[ODEBUG_BATCH_SIZE];
167 for (cnt = 0; cnt < ODEBUG_BATCH_SIZE; cnt++) {
168 new[cnt] = kmem_cache_zalloc(obj_cache, gfp);
175 raw_spin_lock_irqsave(&pool_lock, flags);
177 hlist_add_head(&new[--cnt]->node, &obj_pool);
178 debug_objects_allocated++;
179 WRITE_ONCE(obj_pool_free, obj_pool_free + 1);
181 raw_spin_unlock_irqrestore(&pool_lock, flags);
186 * Lookup an object in the hash bucket.
188 static struct debug_obj *lookup_object(void *addr, struct debug_bucket *b)
190 struct debug_obj *obj;
193 hlist_for_each_entry(obj, &b->list, node) {
195 if (obj->object == addr)
198 if (cnt > debug_objects_maxchain)
199 debug_objects_maxchain = cnt;
205 * Allocate a new object from the hlist
207 static struct debug_obj *__alloc_object(struct hlist_head *list)
209 struct debug_obj *obj = NULL;
212 obj = hlist_entry(list->first, typeof(*obj), node);
213 hlist_del(&obj->node);
219 static struct debug_obj *
220 alloc_object(void *addr, struct debug_bucket *b, const struct debug_obj_descr *descr)
222 struct debug_percpu_free *percpu_pool = this_cpu_ptr(&percpu_obj_pool);
223 struct debug_obj *obj;
225 if (likely(obj_cache)) {
226 obj = __alloc_object(&percpu_pool->free_objs);
228 percpu_pool->obj_free--;
233 raw_spin_lock(&pool_lock);
234 obj = __alloc_object(&obj_pool);
237 WRITE_ONCE(obj_pool_free, obj_pool_free - 1);
240 * Looking ahead, allocate one batch of debug objects and
241 * put them into the percpu free pool.
243 if (likely(obj_cache)) {
246 for (i = 0; i < ODEBUG_BATCH_SIZE; i++) {
247 struct debug_obj *obj2;
249 obj2 = __alloc_object(&obj_pool);
252 hlist_add_head(&obj2->node,
253 &percpu_pool->free_objs);
254 percpu_pool->obj_free++;
256 WRITE_ONCE(obj_pool_free, obj_pool_free - 1);
260 if (obj_pool_used > obj_pool_max_used)
261 obj_pool_max_used = obj_pool_used;
263 if (obj_pool_free < obj_pool_min_free)
264 obj_pool_min_free = obj_pool_free;
266 raw_spin_unlock(&pool_lock);
272 obj->state = ODEBUG_STATE_NONE;
274 hlist_add_head(&obj->node, &b->list);
280 * workqueue function to free objects.
282 * To reduce contention on the global pool_lock, the actual freeing of
283 * debug objects will be delayed if the pool_lock is busy.
285 static void free_obj_work(struct work_struct *work)
287 struct hlist_node *tmp;
288 struct debug_obj *obj;
292 WRITE_ONCE(obj_freeing, false);
293 if (!raw_spin_trylock_irqsave(&pool_lock, flags))
296 if (obj_pool_free >= debug_objects_pool_size)
300 * The objs on the pool list might be allocated before the work is
301 * run, so recheck if pool list it full or not, if not fill pool
302 * list from the global free list. As it is likely that a workload
303 * may be gearing up to use more and more objects, don't free any
304 * of them until the next round.
306 while (obj_nr_tofree && obj_pool_free < debug_objects_pool_size) {
307 obj = hlist_entry(obj_to_free.first, typeof(*obj), node);
308 hlist_del(&obj->node);
309 hlist_add_head(&obj->node, &obj_pool);
310 WRITE_ONCE(obj_pool_free, obj_pool_free + 1);
311 WRITE_ONCE(obj_nr_tofree, obj_nr_tofree - 1);
313 raw_spin_unlock_irqrestore(&pool_lock, flags);
318 * Pool list is already full and there are still objs on the free
319 * list. Move remaining free objs to a temporary list to free the
320 * memory outside the pool_lock held region.
323 hlist_move_list(&obj_to_free, &tofree);
324 debug_objects_freed += obj_nr_tofree;
325 WRITE_ONCE(obj_nr_tofree, 0);
327 raw_spin_unlock_irqrestore(&pool_lock, flags);
329 hlist_for_each_entry_safe(obj, tmp, &tofree, node) {
330 hlist_del(&obj->node);
331 kmem_cache_free(obj_cache, obj);
335 static void __free_object(struct debug_obj *obj)
337 struct debug_obj *objs[ODEBUG_BATCH_SIZE];
338 struct debug_percpu_free *percpu_pool;
339 int lookahead_count = 0;
343 local_irq_save(flags);
345 goto free_to_obj_pool;
348 * Try to free it into the percpu pool first.
350 percpu_pool = this_cpu_ptr(&percpu_obj_pool);
351 if (percpu_pool->obj_free < ODEBUG_POOL_PERCPU_SIZE) {
352 hlist_add_head(&obj->node, &percpu_pool->free_objs);
353 percpu_pool->obj_free++;
354 local_irq_restore(flags);
359 * As the percpu pool is full, look ahead and pull out a batch
360 * of objects from the percpu pool and free them as well.
362 for (; lookahead_count < ODEBUG_BATCH_SIZE; lookahead_count++) {
363 objs[lookahead_count] = __alloc_object(&percpu_pool->free_objs);
364 if (!objs[lookahead_count])
366 percpu_pool->obj_free--;
370 raw_spin_lock(&pool_lock);
371 work = (obj_pool_free > debug_objects_pool_size) && obj_cache &&
372 (obj_nr_tofree < ODEBUG_FREE_WORK_MAX);
376 WRITE_ONCE(obj_nr_tofree, obj_nr_tofree + 1);
377 hlist_add_head(&obj->node, &obj_to_free);
378 if (lookahead_count) {
379 WRITE_ONCE(obj_nr_tofree, obj_nr_tofree + lookahead_count);
380 obj_pool_used -= lookahead_count;
381 while (lookahead_count) {
382 hlist_add_head(&objs[--lookahead_count]->node,
387 if ((obj_pool_free > debug_objects_pool_size) &&
388 (obj_nr_tofree < ODEBUG_FREE_WORK_MAX)) {
392 * Free one more batch of objects from obj_pool.
394 for (i = 0; i < ODEBUG_BATCH_SIZE; i++) {
395 obj = __alloc_object(&obj_pool);
396 hlist_add_head(&obj->node, &obj_to_free);
397 WRITE_ONCE(obj_pool_free, obj_pool_free - 1);
398 WRITE_ONCE(obj_nr_tofree, obj_nr_tofree + 1);
402 WRITE_ONCE(obj_pool_free, obj_pool_free + 1);
403 hlist_add_head(&obj->node, &obj_pool);
404 if (lookahead_count) {
405 WRITE_ONCE(obj_pool_free, obj_pool_free + lookahead_count);
406 obj_pool_used -= lookahead_count;
407 while (lookahead_count) {
408 hlist_add_head(&objs[--lookahead_count]->node,
413 raw_spin_unlock(&pool_lock);
414 local_irq_restore(flags);
418 * Put the object back into the pool and schedule work to free objects
421 static void free_object(struct debug_obj *obj)
424 if (!READ_ONCE(obj_freeing) && READ_ONCE(obj_nr_tofree)) {
425 WRITE_ONCE(obj_freeing, true);
426 schedule_delayed_work(&debug_obj_work, ODEBUG_FREE_WORK_DELAY);
430 #ifdef CONFIG_HOTPLUG_CPU
431 static int object_cpu_offline(unsigned int cpu)
433 struct debug_percpu_free *percpu_pool;
434 struct hlist_node *tmp;
435 struct debug_obj *obj;
438 /* Remote access is safe as the CPU is dead already */
439 percpu_pool = per_cpu_ptr(&percpu_obj_pool, cpu);
440 hlist_for_each_entry_safe(obj, tmp, &percpu_pool->free_objs, node) {
441 hlist_del(&obj->node);
442 kmem_cache_free(obj_cache, obj);
445 raw_spin_lock_irqsave(&pool_lock, flags);
446 obj_pool_used -= percpu_pool->obj_free;
447 debug_objects_freed += percpu_pool->obj_free;
448 raw_spin_unlock_irqrestore(&pool_lock, flags);
450 percpu_pool->obj_free = 0;
457 * We run out of memory. That means we probably have tons of objects
460 static void debug_objects_oom(void)
462 struct debug_bucket *db = obj_hash;
463 struct hlist_node *tmp;
464 HLIST_HEAD(freelist);
465 struct debug_obj *obj;
469 pr_warn("Out of memory. ODEBUG disabled\n");
471 for (i = 0; i < ODEBUG_HASH_SIZE; i++, db++) {
472 raw_spin_lock_irqsave(&db->lock, flags);
473 hlist_move_list(&db->list, &freelist);
474 raw_spin_unlock_irqrestore(&db->lock, flags);
477 hlist_for_each_entry_safe(obj, tmp, &freelist, node) {
478 hlist_del(&obj->node);
485 * We use the pfn of the address for the hash. That way we can check
486 * for freed objects simply by checking the affected bucket.
488 static struct debug_bucket *get_bucket(unsigned long addr)
492 hash = hash_long((addr >> ODEBUG_CHUNK_SHIFT), ODEBUG_HASH_BITS);
493 return &obj_hash[hash];
496 static void debug_print_object(struct debug_obj *obj, char *msg)
498 const struct debug_obj_descr *descr = obj->descr;
501 if (limit < 5 && descr != descr_test) {
502 void *hint = descr->debug_hint ?
503 descr->debug_hint(obj->object) : NULL;
505 WARN(1, KERN_ERR "ODEBUG: %s %s (active state %u) "
506 "object: %p object type: %s hint: %pS\n",
507 msg, obj_states[obj->state], obj->astate,
508 obj->object, descr->name, hint);
510 debug_objects_warnings++;
514 * Try to repair the damage, so we have a better chance to get useful
518 debug_object_fixup(bool (*fixup)(void *addr, enum debug_obj_state state),
519 void * addr, enum debug_obj_state state)
521 if (fixup && fixup(addr, state)) {
522 debug_objects_fixups++;
528 static void debug_object_is_on_stack(void *addr, int onstack)
536 is_on_stack = object_is_on_stack(addr);
537 if (is_on_stack == onstack)
542 pr_warn("object %p is on stack %p, but NOT annotated.\n", addr,
543 task_stack_page(current));
545 pr_warn("object %p is NOT on stack %p, but annotated.\n", addr,
546 task_stack_page(current));
551 static struct debug_obj *lookup_object_or_alloc(void *addr, struct debug_bucket *b,
552 const struct debug_obj_descr *descr,
553 bool onstack, bool alloc_ifstatic)
555 struct debug_obj *obj = lookup_object(addr, b);
556 enum debug_obj_state state = ODEBUG_STATE_NONE;
562 * debug_object_init() unconditionally allocates untracked
563 * objects. It does not matter whether it is a static object or
566 * debug_object_assert_init() and debug_object_activate() allow
567 * allocation only if the descriptor callback confirms that the
568 * object is static and considered initialized. For non-static
569 * objects the allocation needs to be done from the fixup callback.
571 if (unlikely(alloc_ifstatic)) {
572 if (!descr->is_static_object || !descr->is_static_object(addr))
573 return ERR_PTR(-ENOENT);
574 /* Statically allocated objects are considered initialized */
575 state = ODEBUG_STATE_INIT;
578 obj = alloc_object(addr, b, descr);
581 debug_object_is_on_stack(addr, onstack);
585 /* Out of memory. Do the cleanup outside of the locked region */
586 debug_objects_enabled = 0;
590 static void debug_objects_fill_pool(void)
593 * On RT enabled kernels the pool refill must happen in preemptible
594 * context -- for !RT kernels we rely on the fact that spinlock_t and
595 * raw_spinlock_t are basically the same type and this lock-type
596 * inversion works just fine.
598 if (!IS_ENABLED(CONFIG_PREEMPT_RT) || preemptible()) {
600 * Annotate away the spinlock_t inside raw_spinlock_t warning
601 * by temporarily raising the wait-type to WAIT_SLEEP, matching
602 * the preemptible() condition above.
604 static DEFINE_WAIT_OVERRIDE_MAP(fill_pool_map, LD_WAIT_SLEEP);
605 lock_map_acquire_try(&fill_pool_map);
607 lock_map_release(&fill_pool_map);
612 __debug_object_init(void *addr, const struct debug_obj_descr *descr, int onstack)
614 enum debug_obj_state state;
615 struct debug_bucket *db;
616 struct debug_obj *obj;
619 debug_objects_fill_pool();
621 db = get_bucket((unsigned long) addr);
623 raw_spin_lock_irqsave(&db->lock, flags);
625 obj = lookup_object_or_alloc(addr, db, descr, onstack, false);
626 if (unlikely(!obj)) {
627 raw_spin_unlock_irqrestore(&db->lock, flags);
632 switch (obj->state) {
633 case ODEBUG_STATE_NONE:
634 case ODEBUG_STATE_INIT:
635 case ODEBUG_STATE_INACTIVE:
636 obj->state = ODEBUG_STATE_INIT;
639 case ODEBUG_STATE_ACTIVE:
641 raw_spin_unlock_irqrestore(&db->lock, flags);
642 debug_print_object(obj, "init");
643 debug_object_fixup(descr->fixup_init, addr, state);
646 case ODEBUG_STATE_DESTROYED:
647 raw_spin_unlock_irqrestore(&db->lock, flags);
648 debug_print_object(obj, "init");
654 raw_spin_unlock_irqrestore(&db->lock, flags);
658 * debug_object_init - debug checks when an object is initialized
659 * @addr: address of the object
660 * @descr: pointer to an object specific debug description structure
662 void debug_object_init(void *addr, const struct debug_obj_descr *descr)
664 if (!debug_objects_enabled)
667 __debug_object_init(addr, descr, 0);
669 EXPORT_SYMBOL_GPL(debug_object_init);
672 * debug_object_init_on_stack - debug checks when an object on stack is
674 * @addr: address of the object
675 * @descr: pointer to an object specific debug description structure
677 void debug_object_init_on_stack(void *addr, const struct debug_obj_descr *descr)
679 if (!debug_objects_enabled)
682 __debug_object_init(addr, descr, 1);
684 EXPORT_SYMBOL_GPL(debug_object_init_on_stack);
687 * debug_object_activate - debug checks when an object is activated
688 * @addr: address of the object
689 * @descr: pointer to an object specific debug description structure
690 * Returns 0 for success, -EINVAL for check failed.
692 int debug_object_activate(void *addr, const struct debug_obj_descr *descr)
694 struct debug_obj o = { .object = addr, .state = ODEBUG_STATE_NOTAVAILABLE, .descr = descr };
695 enum debug_obj_state state;
696 struct debug_bucket *db;
697 struct debug_obj *obj;
701 if (!debug_objects_enabled)
704 debug_objects_fill_pool();
706 db = get_bucket((unsigned long) addr);
708 raw_spin_lock_irqsave(&db->lock, flags);
710 obj = lookup_object_or_alloc(addr, db, descr, false, true);
711 if (likely(!IS_ERR_OR_NULL(obj))) {
712 bool print_object = false;
714 switch (obj->state) {
715 case ODEBUG_STATE_INIT:
716 case ODEBUG_STATE_INACTIVE:
717 obj->state = ODEBUG_STATE_ACTIVE;
721 case ODEBUG_STATE_ACTIVE:
723 raw_spin_unlock_irqrestore(&db->lock, flags);
724 debug_print_object(obj, "activate");
725 ret = debug_object_fixup(descr->fixup_activate, addr, state);
726 return ret ? 0 : -EINVAL;
728 case ODEBUG_STATE_DESTROYED:
736 raw_spin_unlock_irqrestore(&db->lock, flags);
738 debug_print_object(obj, "activate");
742 raw_spin_unlock_irqrestore(&db->lock, flags);
744 /* If NULL the allocation has hit OOM */
750 /* Object is neither static nor tracked. It's not initialized */
751 debug_print_object(&o, "activate");
752 ret = debug_object_fixup(descr->fixup_activate, addr, ODEBUG_STATE_NOTAVAILABLE);
753 return ret ? 0 : -EINVAL;
755 EXPORT_SYMBOL_GPL(debug_object_activate);
758 * debug_object_deactivate - debug checks when an object is deactivated
759 * @addr: address of the object
760 * @descr: pointer to an object specific debug description structure
762 void debug_object_deactivate(void *addr, const struct debug_obj_descr *descr)
764 struct debug_bucket *db;
765 struct debug_obj *obj;
767 bool print_object = false;
769 if (!debug_objects_enabled)
772 db = get_bucket((unsigned long) addr);
774 raw_spin_lock_irqsave(&db->lock, flags);
776 obj = lookup_object(addr, db);
778 switch (obj->state) {
779 case ODEBUG_STATE_INIT:
780 case ODEBUG_STATE_INACTIVE:
781 case ODEBUG_STATE_ACTIVE:
783 obj->state = ODEBUG_STATE_INACTIVE;
788 case ODEBUG_STATE_DESTROYED:
796 raw_spin_unlock_irqrestore(&db->lock, flags);
798 struct debug_obj o = { .object = addr,
799 .state = ODEBUG_STATE_NOTAVAILABLE,
802 debug_print_object(&o, "deactivate");
803 } else if (print_object) {
804 debug_print_object(obj, "deactivate");
807 EXPORT_SYMBOL_GPL(debug_object_deactivate);
810 * debug_object_destroy - debug checks when an object is destroyed
811 * @addr: address of the object
812 * @descr: pointer to an object specific debug description structure
814 void debug_object_destroy(void *addr, const struct debug_obj_descr *descr)
816 enum debug_obj_state state;
817 struct debug_bucket *db;
818 struct debug_obj *obj;
820 bool print_object = false;
822 if (!debug_objects_enabled)
825 db = get_bucket((unsigned long) addr);
827 raw_spin_lock_irqsave(&db->lock, flags);
829 obj = lookup_object(addr, db);
833 switch (obj->state) {
834 case ODEBUG_STATE_NONE:
835 case ODEBUG_STATE_INIT:
836 case ODEBUG_STATE_INACTIVE:
837 obj->state = ODEBUG_STATE_DESTROYED;
839 case ODEBUG_STATE_ACTIVE:
841 raw_spin_unlock_irqrestore(&db->lock, flags);
842 debug_print_object(obj, "destroy");
843 debug_object_fixup(descr->fixup_destroy, addr, state);
846 case ODEBUG_STATE_DESTROYED:
853 raw_spin_unlock_irqrestore(&db->lock, flags);
855 debug_print_object(obj, "destroy");
857 EXPORT_SYMBOL_GPL(debug_object_destroy);
860 * debug_object_free - debug checks when an object is freed
861 * @addr: address of the object
862 * @descr: pointer to an object specific debug description structure
864 void debug_object_free(void *addr, const struct debug_obj_descr *descr)
866 enum debug_obj_state state;
867 struct debug_bucket *db;
868 struct debug_obj *obj;
871 if (!debug_objects_enabled)
874 db = get_bucket((unsigned long) addr);
876 raw_spin_lock_irqsave(&db->lock, flags);
878 obj = lookup_object(addr, db);
882 switch (obj->state) {
883 case ODEBUG_STATE_ACTIVE:
885 raw_spin_unlock_irqrestore(&db->lock, flags);
886 debug_print_object(obj, "free");
887 debug_object_fixup(descr->fixup_free, addr, state);
890 hlist_del(&obj->node);
891 raw_spin_unlock_irqrestore(&db->lock, flags);
896 raw_spin_unlock_irqrestore(&db->lock, flags);
898 EXPORT_SYMBOL_GPL(debug_object_free);
901 * debug_object_assert_init - debug checks when object should be init-ed
902 * @addr: address of the object
903 * @descr: pointer to an object specific debug description structure
905 void debug_object_assert_init(void *addr, const struct debug_obj_descr *descr)
907 struct debug_obj o = { .object = addr, .state = ODEBUG_STATE_NOTAVAILABLE, .descr = descr };
908 struct debug_bucket *db;
909 struct debug_obj *obj;
912 if (!debug_objects_enabled)
915 debug_objects_fill_pool();
917 db = get_bucket((unsigned long) addr);
919 raw_spin_lock_irqsave(&db->lock, flags);
920 obj = lookup_object_or_alloc(addr, db, descr, false, true);
921 raw_spin_unlock_irqrestore(&db->lock, flags);
922 if (likely(!IS_ERR_OR_NULL(obj)))
925 /* If NULL the allocation has hit OOM */
931 /* Object is neither tracked nor static. It's not initialized. */
932 debug_print_object(&o, "assert_init");
933 debug_object_fixup(descr->fixup_assert_init, addr, ODEBUG_STATE_NOTAVAILABLE);
935 EXPORT_SYMBOL_GPL(debug_object_assert_init);
938 * debug_object_active_state - debug checks object usage state machine
939 * @addr: address of the object
940 * @descr: pointer to an object specific debug description structure
941 * @expect: expected state
942 * @next: state to move to if expected state is found
945 debug_object_active_state(void *addr, const struct debug_obj_descr *descr,
946 unsigned int expect, unsigned int next)
948 struct debug_bucket *db;
949 struct debug_obj *obj;
951 bool print_object = false;
953 if (!debug_objects_enabled)
956 db = get_bucket((unsigned long) addr);
958 raw_spin_lock_irqsave(&db->lock, flags);
960 obj = lookup_object(addr, db);
962 switch (obj->state) {
963 case ODEBUG_STATE_ACTIVE:
964 if (obj->astate == expect)
976 raw_spin_unlock_irqrestore(&db->lock, flags);
978 struct debug_obj o = { .object = addr,
979 .state = ODEBUG_STATE_NOTAVAILABLE,
982 debug_print_object(&o, "active_state");
983 } else if (print_object) {
984 debug_print_object(obj, "active_state");
987 EXPORT_SYMBOL_GPL(debug_object_active_state);
989 #ifdef CONFIG_DEBUG_OBJECTS_FREE
990 static void __debug_check_no_obj_freed(const void *address, unsigned long size)
992 unsigned long flags, oaddr, saddr, eaddr, paddr, chunks;
993 const struct debug_obj_descr *descr;
994 enum debug_obj_state state;
995 struct debug_bucket *db;
996 struct hlist_node *tmp;
997 struct debug_obj *obj;
998 int cnt, objs_checked = 0;
1000 saddr = (unsigned long) address;
1001 eaddr = saddr + size;
1002 paddr = saddr & ODEBUG_CHUNK_MASK;
1003 chunks = ((eaddr - paddr) + (ODEBUG_CHUNK_SIZE - 1));
1004 chunks >>= ODEBUG_CHUNK_SHIFT;
1006 for (;chunks > 0; chunks--, paddr += ODEBUG_CHUNK_SIZE) {
1007 db = get_bucket(paddr);
1011 raw_spin_lock_irqsave(&db->lock, flags);
1012 hlist_for_each_entry_safe(obj, tmp, &db->list, node) {
1014 oaddr = (unsigned long) obj->object;
1015 if (oaddr < saddr || oaddr >= eaddr)
1018 switch (obj->state) {
1019 case ODEBUG_STATE_ACTIVE:
1022 raw_spin_unlock_irqrestore(&db->lock, flags);
1023 debug_print_object(obj, "free");
1024 debug_object_fixup(descr->fixup_free,
1025 (void *) oaddr, state);
1028 hlist_del(&obj->node);
1033 raw_spin_unlock_irqrestore(&db->lock, flags);
1035 if (cnt > debug_objects_maxchain)
1036 debug_objects_maxchain = cnt;
1038 objs_checked += cnt;
1041 if (objs_checked > debug_objects_maxchecked)
1042 debug_objects_maxchecked = objs_checked;
1044 /* Schedule work to actually kmem_cache_free() objects */
1045 if (!READ_ONCE(obj_freeing) && READ_ONCE(obj_nr_tofree)) {
1046 WRITE_ONCE(obj_freeing, true);
1047 schedule_delayed_work(&debug_obj_work, ODEBUG_FREE_WORK_DELAY);
1051 void debug_check_no_obj_freed(const void *address, unsigned long size)
1053 if (debug_objects_enabled)
1054 __debug_check_no_obj_freed(address, size);
1058 #ifdef CONFIG_DEBUG_FS
1060 static int debug_stats_show(struct seq_file *m, void *v)
1062 int cpu, obj_percpu_free = 0;
1064 for_each_possible_cpu(cpu)
1065 obj_percpu_free += per_cpu(percpu_obj_pool.obj_free, cpu);
1067 seq_printf(m, "max_chain :%d\n", debug_objects_maxchain);
1068 seq_printf(m, "max_checked :%d\n", debug_objects_maxchecked);
1069 seq_printf(m, "warnings :%d\n", debug_objects_warnings);
1070 seq_printf(m, "fixups :%d\n", debug_objects_fixups);
1071 seq_printf(m, "pool_free :%d\n", READ_ONCE(obj_pool_free) + obj_percpu_free);
1072 seq_printf(m, "pool_pcp_free :%d\n", obj_percpu_free);
1073 seq_printf(m, "pool_min_free :%d\n", obj_pool_min_free);
1074 seq_printf(m, "pool_used :%d\n", obj_pool_used - obj_percpu_free);
1075 seq_printf(m, "pool_max_used :%d\n", obj_pool_max_used);
1076 seq_printf(m, "on_free_list :%d\n", READ_ONCE(obj_nr_tofree));
1077 seq_printf(m, "objs_allocated:%d\n", debug_objects_allocated);
1078 seq_printf(m, "objs_freed :%d\n", debug_objects_freed);
1081 DEFINE_SHOW_ATTRIBUTE(debug_stats);
1083 static int __init debug_objects_init_debugfs(void)
1085 struct dentry *dbgdir;
1087 if (!debug_objects_enabled)
1090 dbgdir = debugfs_create_dir("debug_objects", NULL);
1092 debugfs_create_file("stats", 0444, dbgdir, NULL, &debug_stats_fops);
1096 __initcall(debug_objects_init_debugfs);
1099 static inline void debug_objects_init_debugfs(void) { }
1102 #ifdef CONFIG_DEBUG_OBJECTS_SELFTEST
1104 /* Random data structure for the self test */
1106 unsigned long dummy1[6];
1108 unsigned long dummy2[3];
1111 static __initconst const struct debug_obj_descr descr_type_test;
1113 static bool __init is_static_object(void *addr)
1115 struct self_test *obj = addr;
1117 return obj->static_init;
1121 * fixup_init is called when:
1122 * - an active object is initialized
1124 static bool __init fixup_init(void *addr, enum debug_obj_state state)
1126 struct self_test *obj = addr;
1129 case ODEBUG_STATE_ACTIVE:
1130 debug_object_deactivate(obj, &descr_type_test);
1131 debug_object_init(obj, &descr_type_test);
1139 * fixup_activate is called when:
1140 * - an active object is activated
1141 * - an unknown non-static object is activated
1143 static bool __init fixup_activate(void *addr, enum debug_obj_state state)
1145 struct self_test *obj = addr;
1148 case ODEBUG_STATE_NOTAVAILABLE:
1150 case ODEBUG_STATE_ACTIVE:
1151 debug_object_deactivate(obj, &descr_type_test);
1152 debug_object_activate(obj, &descr_type_test);
1161 * fixup_destroy is called when:
1162 * - an active object is destroyed
1164 static bool __init fixup_destroy(void *addr, enum debug_obj_state state)
1166 struct self_test *obj = addr;
1169 case ODEBUG_STATE_ACTIVE:
1170 debug_object_deactivate(obj, &descr_type_test);
1171 debug_object_destroy(obj, &descr_type_test);
1179 * fixup_free is called when:
1180 * - an active object is freed
1182 static bool __init fixup_free(void *addr, enum debug_obj_state state)
1184 struct self_test *obj = addr;
1187 case ODEBUG_STATE_ACTIVE:
1188 debug_object_deactivate(obj, &descr_type_test);
1189 debug_object_free(obj, &descr_type_test);
1197 check_results(void *addr, enum debug_obj_state state, int fixups, int warnings)
1199 struct debug_bucket *db;
1200 struct debug_obj *obj;
1201 unsigned long flags;
1204 db = get_bucket((unsigned long) addr);
1206 raw_spin_lock_irqsave(&db->lock, flags);
1208 obj = lookup_object(addr, db);
1209 if (!obj && state != ODEBUG_STATE_NONE) {
1210 WARN(1, KERN_ERR "ODEBUG: selftest object not found\n");
1213 if (obj && obj->state != state) {
1214 WARN(1, KERN_ERR "ODEBUG: selftest wrong state: %d != %d\n",
1218 if (fixups != debug_objects_fixups) {
1219 WARN(1, KERN_ERR "ODEBUG: selftest fixups failed %d != %d\n",
1220 fixups, debug_objects_fixups);
1223 if (warnings != debug_objects_warnings) {
1224 WARN(1, KERN_ERR "ODEBUG: selftest warnings failed %d != %d\n",
1225 warnings, debug_objects_warnings);
1230 raw_spin_unlock_irqrestore(&db->lock, flags);
1232 debug_objects_enabled = 0;
1236 static __initconst const struct debug_obj_descr descr_type_test = {
1238 .is_static_object = is_static_object,
1239 .fixup_init = fixup_init,
1240 .fixup_activate = fixup_activate,
1241 .fixup_destroy = fixup_destroy,
1242 .fixup_free = fixup_free,
1245 static __initdata struct self_test obj = { .static_init = 0 };
1247 static void __init debug_objects_selftest(void)
1249 int fixups, oldfixups, warnings, oldwarnings;
1250 unsigned long flags;
1252 local_irq_save(flags);
1254 fixups = oldfixups = debug_objects_fixups;
1255 warnings = oldwarnings = debug_objects_warnings;
1256 descr_test = &descr_type_test;
1258 debug_object_init(&obj, &descr_type_test);
1259 if (check_results(&obj, ODEBUG_STATE_INIT, fixups, warnings))
1261 debug_object_activate(&obj, &descr_type_test);
1262 if (check_results(&obj, ODEBUG_STATE_ACTIVE, fixups, warnings))
1264 debug_object_activate(&obj, &descr_type_test);
1265 if (check_results(&obj, ODEBUG_STATE_ACTIVE, ++fixups, ++warnings))
1267 debug_object_deactivate(&obj, &descr_type_test);
1268 if (check_results(&obj, ODEBUG_STATE_INACTIVE, fixups, warnings))
1270 debug_object_destroy(&obj, &descr_type_test);
1271 if (check_results(&obj, ODEBUG_STATE_DESTROYED, fixups, warnings))
1273 debug_object_init(&obj, &descr_type_test);
1274 if (check_results(&obj, ODEBUG_STATE_DESTROYED, fixups, ++warnings))
1276 debug_object_activate(&obj, &descr_type_test);
1277 if (check_results(&obj, ODEBUG_STATE_DESTROYED, fixups, ++warnings))
1279 debug_object_deactivate(&obj, &descr_type_test);
1280 if (check_results(&obj, ODEBUG_STATE_DESTROYED, fixups, ++warnings))
1282 debug_object_free(&obj, &descr_type_test);
1283 if (check_results(&obj, ODEBUG_STATE_NONE, fixups, warnings))
1286 obj.static_init = 1;
1287 debug_object_activate(&obj, &descr_type_test);
1288 if (check_results(&obj, ODEBUG_STATE_ACTIVE, fixups, warnings))
1290 debug_object_init(&obj, &descr_type_test);
1291 if (check_results(&obj, ODEBUG_STATE_INIT, ++fixups, ++warnings))
1293 debug_object_free(&obj, &descr_type_test);
1294 if (check_results(&obj, ODEBUG_STATE_NONE, fixups, warnings))
1297 #ifdef CONFIG_DEBUG_OBJECTS_FREE
1298 debug_object_init(&obj, &descr_type_test);
1299 if (check_results(&obj, ODEBUG_STATE_INIT, fixups, warnings))
1301 debug_object_activate(&obj, &descr_type_test);
1302 if (check_results(&obj, ODEBUG_STATE_ACTIVE, fixups, warnings))
1304 __debug_check_no_obj_freed(&obj, sizeof(obj));
1305 if (check_results(&obj, ODEBUG_STATE_NONE, ++fixups, ++warnings))
1308 pr_info("selftest passed\n");
1311 debug_objects_fixups = oldfixups;
1312 debug_objects_warnings = oldwarnings;
1315 local_irq_restore(flags);
1318 static inline void debug_objects_selftest(void) { }
1322 * Called during early boot to initialize the hash buckets and link
1323 * the static object pool objects into the poll list. After this call
1324 * the object tracker is fully operational.
1326 void __init debug_objects_early_init(void)
1330 for (i = 0; i < ODEBUG_HASH_SIZE; i++)
1331 raw_spin_lock_init(&obj_hash[i].lock);
1333 for (i = 0; i < ODEBUG_POOL_SIZE; i++)
1334 hlist_add_head(&obj_static_pool[i].node, &obj_pool);
1338 * Convert the statically allocated objects to dynamic ones:
1340 static int __init debug_objects_replace_static_objects(void)
1342 struct debug_bucket *db = obj_hash;
1343 struct hlist_node *tmp;
1344 struct debug_obj *obj, *new;
1345 HLIST_HEAD(objects);
1348 for (i = 0; i < ODEBUG_POOL_SIZE; i++) {
1349 obj = kmem_cache_zalloc(obj_cache, GFP_KERNEL);
1352 hlist_add_head(&obj->node, &objects);
1355 debug_objects_allocated += i;
1358 * debug_objects_mem_init() is now called early that only one CPU is up
1359 * and interrupts have been disabled, so it is safe to replace the
1360 * active object references.
1363 /* Remove the statically allocated objects from the pool */
1364 hlist_for_each_entry_safe(obj, tmp, &obj_pool, node)
1365 hlist_del(&obj->node);
1366 /* Move the allocated objects to the pool */
1367 hlist_move_list(&objects, &obj_pool);
1369 /* Replace the active object references */
1370 for (i = 0; i < ODEBUG_HASH_SIZE; i++, db++) {
1371 hlist_move_list(&db->list, &objects);
1373 hlist_for_each_entry(obj, &objects, node) {
1374 new = hlist_entry(obj_pool.first, typeof(*obj), node);
1375 hlist_del(&new->node);
1376 /* copy object data */
1378 hlist_add_head(&new->node, &db->list);
1383 pr_debug("%d of %d active objects replaced\n",
1384 cnt, obj_pool_used);
1387 hlist_for_each_entry_safe(obj, tmp, &objects, node) {
1388 hlist_del(&obj->node);
1389 kmem_cache_free(obj_cache, obj);
1395 * Called after the kmem_caches are functional to setup a dedicated
1396 * cache pool, which has the SLAB_DEBUG_OBJECTS flag set. This flag
1397 * prevents that the debug code is called on kmem_cache_free() for the
1398 * debug tracker objects to avoid recursive calls.
1400 void __init debug_objects_mem_init(void)
1404 if (!debug_objects_enabled)
1408 * Initialize the percpu object pools
1410 * Initialization is not strictly necessary, but was done for
1413 for_each_possible_cpu(cpu)
1414 INIT_HLIST_HEAD(&per_cpu(percpu_obj_pool.free_objs, cpu));
1416 obj_cache = kmem_cache_create("debug_objects_cache",
1417 sizeof (struct debug_obj), 0,
1418 SLAB_DEBUG_OBJECTS | SLAB_NOLEAKTRACE,
1421 if (!obj_cache || debug_objects_replace_static_objects()) {
1422 debug_objects_enabled = 0;
1423 kmem_cache_destroy(obj_cache);
1424 pr_warn("out of memory.\n");
1427 debug_objects_selftest();
1429 #ifdef CONFIG_HOTPLUG_CPU
1430 cpuhp_setup_state_nocalls(CPUHP_DEBUG_OBJ_DEAD, "object:offline", NULL,
1431 object_cpu_offline);
1435 * Increase the thresholds for allocating and freeing objects
1436 * according to the number of possible CPUs available in the system.
1438 extras = num_possible_cpus() * ODEBUG_BATCH_SIZE;
1439 debug_objects_pool_size += extras;
1440 debug_objects_pool_min_level += extras;