1 // SPDX-License-Identifier: GPL-2.0
3 * Generic infrastructure for lifetime debugging of objects.
5 * Copyright (C) 2008, Thomas Gleixner <tglx@linutronix.de>
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_ATOMIC | __GFP_NORETRY | __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);
220 * Allocate a new object. If the pool is empty, switch off the debugger.
221 * Must be called with interrupts disabled.
223 static struct debug_obj *
224 alloc_object(void *addr, struct debug_bucket *b, const struct debug_obj_descr *descr)
226 struct debug_percpu_free *percpu_pool = this_cpu_ptr(&percpu_obj_pool);
227 struct debug_obj *obj;
229 if (likely(obj_cache)) {
230 obj = __alloc_object(&percpu_pool->free_objs);
232 percpu_pool->obj_free--;
237 raw_spin_lock(&pool_lock);
238 obj = __alloc_object(&obj_pool);
241 WRITE_ONCE(obj_pool_free, obj_pool_free - 1);
244 * Looking ahead, allocate one batch of debug objects and
245 * put them into the percpu free pool.
247 if (likely(obj_cache)) {
250 for (i = 0; i < ODEBUG_BATCH_SIZE; i++) {
251 struct debug_obj *obj2;
253 obj2 = __alloc_object(&obj_pool);
256 hlist_add_head(&obj2->node,
257 &percpu_pool->free_objs);
258 percpu_pool->obj_free++;
260 WRITE_ONCE(obj_pool_free, obj_pool_free - 1);
264 if (obj_pool_used > obj_pool_max_used)
265 obj_pool_max_used = obj_pool_used;
267 if (obj_pool_free < obj_pool_min_free)
268 obj_pool_min_free = obj_pool_free;
270 raw_spin_unlock(&pool_lock);
276 obj->state = ODEBUG_STATE_NONE;
278 hlist_add_head(&obj->node, &b->list);
284 * workqueue function to free objects.
286 * To reduce contention on the global pool_lock, the actual freeing of
287 * debug objects will be delayed if the pool_lock is busy.
289 static void free_obj_work(struct work_struct *work)
291 struct hlist_node *tmp;
292 struct debug_obj *obj;
296 WRITE_ONCE(obj_freeing, false);
297 if (!raw_spin_trylock_irqsave(&pool_lock, flags))
300 if (obj_pool_free >= debug_objects_pool_size)
304 * The objs on the pool list might be allocated before the work is
305 * run, so recheck if pool list it full or not, if not fill pool
306 * list from the global free list. As it is likely that a workload
307 * may be gearing up to use more and more objects, don't free any
308 * of them until the next round.
310 while (obj_nr_tofree && obj_pool_free < debug_objects_pool_size) {
311 obj = hlist_entry(obj_to_free.first, typeof(*obj), node);
312 hlist_del(&obj->node);
313 hlist_add_head(&obj->node, &obj_pool);
314 WRITE_ONCE(obj_pool_free, obj_pool_free + 1);
315 WRITE_ONCE(obj_nr_tofree, obj_nr_tofree - 1);
317 raw_spin_unlock_irqrestore(&pool_lock, flags);
322 * Pool list is already full and there are still objs on the free
323 * list. Move remaining free objs to a temporary list to free the
324 * memory outside the pool_lock held region.
327 hlist_move_list(&obj_to_free, &tofree);
328 debug_objects_freed += obj_nr_tofree;
329 WRITE_ONCE(obj_nr_tofree, 0);
331 raw_spin_unlock_irqrestore(&pool_lock, flags);
333 hlist_for_each_entry_safe(obj, tmp, &tofree, node) {
334 hlist_del(&obj->node);
335 kmem_cache_free(obj_cache, obj);
339 static void __free_object(struct debug_obj *obj)
341 struct debug_obj *objs[ODEBUG_BATCH_SIZE];
342 struct debug_percpu_free *percpu_pool;
343 int lookahead_count = 0;
347 local_irq_save(flags);
349 goto free_to_obj_pool;
352 * Try to free it into the percpu pool first.
354 percpu_pool = this_cpu_ptr(&percpu_obj_pool);
355 if (percpu_pool->obj_free < ODEBUG_POOL_PERCPU_SIZE) {
356 hlist_add_head(&obj->node, &percpu_pool->free_objs);
357 percpu_pool->obj_free++;
358 local_irq_restore(flags);
363 * As the percpu pool is full, look ahead and pull out a batch
364 * of objects from the percpu pool and free them as well.
366 for (; lookahead_count < ODEBUG_BATCH_SIZE; lookahead_count++) {
367 objs[lookahead_count] = __alloc_object(&percpu_pool->free_objs);
368 if (!objs[lookahead_count])
370 percpu_pool->obj_free--;
374 raw_spin_lock(&pool_lock);
375 work = (obj_pool_free > debug_objects_pool_size) && obj_cache &&
376 (obj_nr_tofree < ODEBUG_FREE_WORK_MAX);
380 WRITE_ONCE(obj_nr_tofree, obj_nr_tofree + 1);
381 hlist_add_head(&obj->node, &obj_to_free);
382 if (lookahead_count) {
383 WRITE_ONCE(obj_nr_tofree, obj_nr_tofree + lookahead_count);
384 obj_pool_used -= lookahead_count;
385 while (lookahead_count) {
386 hlist_add_head(&objs[--lookahead_count]->node,
391 if ((obj_pool_free > debug_objects_pool_size) &&
392 (obj_nr_tofree < ODEBUG_FREE_WORK_MAX)) {
396 * Free one more batch of objects from obj_pool.
398 for (i = 0; i < ODEBUG_BATCH_SIZE; i++) {
399 obj = __alloc_object(&obj_pool);
400 hlist_add_head(&obj->node, &obj_to_free);
401 WRITE_ONCE(obj_pool_free, obj_pool_free - 1);
402 WRITE_ONCE(obj_nr_tofree, obj_nr_tofree + 1);
406 WRITE_ONCE(obj_pool_free, obj_pool_free + 1);
407 hlist_add_head(&obj->node, &obj_pool);
408 if (lookahead_count) {
409 WRITE_ONCE(obj_pool_free, obj_pool_free + lookahead_count);
410 obj_pool_used -= lookahead_count;
411 while (lookahead_count) {
412 hlist_add_head(&objs[--lookahead_count]->node,
417 raw_spin_unlock(&pool_lock);
418 local_irq_restore(flags);
422 * Put the object back into the pool and schedule work to free objects
425 static void free_object(struct debug_obj *obj)
428 if (!READ_ONCE(obj_freeing) && READ_ONCE(obj_nr_tofree)) {
429 WRITE_ONCE(obj_freeing, true);
430 schedule_delayed_work(&debug_obj_work, ODEBUG_FREE_WORK_DELAY);
434 #ifdef CONFIG_HOTPLUG_CPU
435 static int object_cpu_offline(unsigned int cpu)
437 struct debug_percpu_free *percpu_pool;
438 struct hlist_node *tmp;
439 struct debug_obj *obj;
441 /* Remote access is safe as the CPU is dead already */
442 percpu_pool = per_cpu_ptr(&percpu_obj_pool, cpu);
443 hlist_for_each_entry_safe(obj, tmp, &percpu_pool->free_objs, node) {
444 hlist_del(&obj->node);
445 kmem_cache_free(obj_cache, obj);
447 percpu_pool->obj_free = 0;
454 * We run out of memory. That means we probably have tons of objects
457 static void debug_objects_oom(void)
459 struct debug_bucket *db = obj_hash;
460 struct hlist_node *tmp;
461 HLIST_HEAD(freelist);
462 struct debug_obj *obj;
466 pr_warn("Out of memory. ODEBUG disabled\n");
468 for (i = 0; i < ODEBUG_HASH_SIZE; i++, db++) {
469 raw_spin_lock_irqsave(&db->lock, flags);
470 hlist_move_list(&db->list, &freelist);
471 raw_spin_unlock_irqrestore(&db->lock, flags);
474 hlist_for_each_entry_safe(obj, tmp, &freelist, node) {
475 hlist_del(&obj->node);
482 * We use the pfn of the address for the hash. That way we can check
483 * for freed objects simply by checking the affected bucket.
485 static struct debug_bucket *get_bucket(unsigned long addr)
489 hash = hash_long((addr >> ODEBUG_CHUNK_SHIFT), ODEBUG_HASH_BITS);
490 return &obj_hash[hash];
493 static void debug_print_object(struct debug_obj *obj, char *msg)
495 const struct debug_obj_descr *descr = obj->descr;
498 if (limit < 5 && descr != descr_test) {
499 void *hint = descr->debug_hint ?
500 descr->debug_hint(obj->object) : NULL;
502 WARN(1, KERN_ERR "ODEBUG: %s %s (active state %u) "
503 "object type: %s hint: %pS\n",
504 msg, obj_states[obj->state], obj->astate,
507 debug_objects_warnings++;
511 * Try to repair the damage, so we have a better chance to get useful
515 debug_object_fixup(bool (*fixup)(void *addr, enum debug_obj_state state),
516 void * addr, enum debug_obj_state state)
518 if (fixup && fixup(addr, state)) {
519 debug_objects_fixups++;
525 static void debug_object_is_on_stack(void *addr, int onstack)
533 is_on_stack = object_is_on_stack(addr);
534 if (is_on_stack == onstack)
539 pr_warn("object %p is on stack %p, but NOT annotated.\n", addr,
540 task_stack_page(current));
542 pr_warn("object %p is NOT on stack %p, but annotated.\n", addr,
543 task_stack_page(current));
549 __debug_object_init(void *addr, const struct debug_obj_descr *descr, int onstack)
551 enum debug_obj_state state;
552 bool check_stack = false;
553 struct debug_bucket *db;
554 struct debug_obj *obj;
558 * On RT enabled kernels the pool refill must happen in preemptible
561 if (!IS_ENABLED(CONFIG_PREEMPT_RT) || preemptible())
564 db = get_bucket((unsigned long) addr);
566 raw_spin_lock_irqsave(&db->lock, flags);
568 obj = lookup_object(addr, db);
570 obj = alloc_object(addr, db, descr);
572 debug_objects_enabled = 0;
573 raw_spin_unlock_irqrestore(&db->lock, flags);
580 switch (obj->state) {
581 case ODEBUG_STATE_NONE:
582 case ODEBUG_STATE_INIT:
583 case ODEBUG_STATE_INACTIVE:
584 obj->state = ODEBUG_STATE_INIT;
587 case ODEBUG_STATE_ACTIVE:
589 raw_spin_unlock_irqrestore(&db->lock, flags);
590 debug_print_object(obj, "init");
591 debug_object_fixup(descr->fixup_init, addr, state);
594 case ODEBUG_STATE_DESTROYED:
595 raw_spin_unlock_irqrestore(&db->lock, flags);
596 debug_print_object(obj, "init");
602 raw_spin_unlock_irqrestore(&db->lock, flags);
604 debug_object_is_on_stack(addr, onstack);
608 * debug_object_init - debug checks when an object is initialized
609 * @addr: address of the object
610 * @descr: pointer to an object specific debug description structure
612 void debug_object_init(void *addr, const struct debug_obj_descr *descr)
614 if (!debug_objects_enabled)
617 __debug_object_init(addr, descr, 0);
619 EXPORT_SYMBOL_GPL(debug_object_init);
622 * debug_object_init_on_stack - debug checks when an object on stack is
624 * @addr: address of the object
625 * @descr: pointer to an object specific debug description structure
627 void debug_object_init_on_stack(void *addr, const struct debug_obj_descr *descr)
629 if (!debug_objects_enabled)
632 __debug_object_init(addr, descr, 1);
634 EXPORT_SYMBOL_GPL(debug_object_init_on_stack);
637 * debug_object_activate - debug checks when an object is activated
638 * @addr: address of the object
639 * @descr: pointer to an object specific debug description structure
640 * Returns 0 for success, -EINVAL for check failed.
642 int debug_object_activate(void *addr, const struct debug_obj_descr *descr)
644 enum debug_obj_state state;
645 struct debug_bucket *db;
646 struct debug_obj *obj;
649 struct debug_obj o = { .object = addr,
650 .state = ODEBUG_STATE_NOTAVAILABLE,
653 if (!debug_objects_enabled)
656 db = get_bucket((unsigned long) addr);
658 raw_spin_lock_irqsave(&db->lock, flags);
660 obj = lookup_object(addr, db);
662 bool print_object = false;
664 switch (obj->state) {
665 case ODEBUG_STATE_INIT:
666 case ODEBUG_STATE_INACTIVE:
667 obj->state = ODEBUG_STATE_ACTIVE;
671 case ODEBUG_STATE_ACTIVE:
673 raw_spin_unlock_irqrestore(&db->lock, flags);
674 debug_print_object(obj, "activate");
675 ret = debug_object_fixup(descr->fixup_activate, addr, state);
676 return ret ? 0 : -EINVAL;
678 case ODEBUG_STATE_DESTROYED:
686 raw_spin_unlock_irqrestore(&db->lock, flags);
688 debug_print_object(obj, "activate");
692 raw_spin_unlock_irqrestore(&db->lock, flags);
695 * We are here when a static object is activated. We
696 * let the type specific code confirm whether this is
697 * true or not. if true, we just make sure that the
698 * static object is tracked in the object tracker. If
699 * not, this must be a bug, so we try to fix it up.
701 if (descr->is_static_object && descr->is_static_object(addr)) {
702 /* track this static object */
703 debug_object_init(addr, descr);
704 debug_object_activate(addr, descr);
706 debug_print_object(&o, "activate");
707 ret = debug_object_fixup(descr->fixup_activate, addr,
708 ODEBUG_STATE_NOTAVAILABLE);
709 return ret ? 0 : -EINVAL;
713 EXPORT_SYMBOL_GPL(debug_object_activate);
716 * debug_object_deactivate - debug checks when an object is deactivated
717 * @addr: address of the object
718 * @descr: pointer to an object specific debug description structure
720 void debug_object_deactivate(void *addr, const struct debug_obj_descr *descr)
722 struct debug_bucket *db;
723 struct debug_obj *obj;
725 bool print_object = false;
727 if (!debug_objects_enabled)
730 db = get_bucket((unsigned long) addr);
732 raw_spin_lock_irqsave(&db->lock, flags);
734 obj = lookup_object(addr, db);
736 switch (obj->state) {
737 case ODEBUG_STATE_INIT:
738 case ODEBUG_STATE_INACTIVE:
739 case ODEBUG_STATE_ACTIVE:
741 obj->state = ODEBUG_STATE_INACTIVE;
746 case ODEBUG_STATE_DESTROYED:
754 raw_spin_unlock_irqrestore(&db->lock, flags);
756 struct debug_obj o = { .object = addr,
757 .state = ODEBUG_STATE_NOTAVAILABLE,
760 debug_print_object(&o, "deactivate");
761 } else if (print_object) {
762 debug_print_object(obj, "deactivate");
765 EXPORT_SYMBOL_GPL(debug_object_deactivate);
768 * debug_object_destroy - debug checks when an object is destroyed
769 * @addr: address of the object
770 * @descr: pointer to an object specific debug description structure
772 void debug_object_destroy(void *addr, const struct debug_obj_descr *descr)
774 enum debug_obj_state state;
775 struct debug_bucket *db;
776 struct debug_obj *obj;
778 bool print_object = false;
780 if (!debug_objects_enabled)
783 db = get_bucket((unsigned long) addr);
785 raw_spin_lock_irqsave(&db->lock, flags);
787 obj = lookup_object(addr, db);
791 switch (obj->state) {
792 case ODEBUG_STATE_NONE:
793 case ODEBUG_STATE_INIT:
794 case ODEBUG_STATE_INACTIVE:
795 obj->state = ODEBUG_STATE_DESTROYED;
797 case ODEBUG_STATE_ACTIVE:
799 raw_spin_unlock_irqrestore(&db->lock, flags);
800 debug_print_object(obj, "destroy");
801 debug_object_fixup(descr->fixup_destroy, addr, state);
804 case ODEBUG_STATE_DESTROYED:
811 raw_spin_unlock_irqrestore(&db->lock, flags);
813 debug_print_object(obj, "destroy");
815 EXPORT_SYMBOL_GPL(debug_object_destroy);
818 * debug_object_free - debug checks when an object is freed
819 * @addr: address of the object
820 * @descr: pointer to an object specific debug description structure
822 void debug_object_free(void *addr, const struct debug_obj_descr *descr)
824 enum debug_obj_state state;
825 struct debug_bucket *db;
826 struct debug_obj *obj;
829 if (!debug_objects_enabled)
832 db = get_bucket((unsigned long) addr);
834 raw_spin_lock_irqsave(&db->lock, flags);
836 obj = lookup_object(addr, db);
840 switch (obj->state) {
841 case ODEBUG_STATE_ACTIVE:
843 raw_spin_unlock_irqrestore(&db->lock, flags);
844 debug_print_object(obj, "free");
845 debug_object_fixup(descr->fixup_free, addr, state);
848 hlist_del(&obj->node);
849 raw_spin_unlock_irqrestore(&db->lock, flags);
854 raw_spin_unlock_irqrestore(&db->lock, flags);
856 EXPORT_SYMBOL_GPL(debug_object_free);
859 * debug_object_assert_init - debug checks when object should be init-ed
860 * @addr: address of the object
861 * @descr: pointer to an object specific debug description structure
863 void debug_object_assert_init(void *addr, const struct debug_obj_descr *descr)
865 struct debug_bucket *db;
866 struct debug_obj *obj;
869 if (!debug_objects_enabled)
872 db = get_bucket((unsigned long) addr);
874 raw_spin_lock_irqsave(&db->lock, flags);
876 obj = lookup_object(addr, db);
878 struct debug_obj o = { .object = addr,
879 .state = ODEBUG_STATE_NOTAVAILABLE,
882 raw_spin_unlock_irqrestore(&db->lock, flags);
884 * Maybe the object is static, and we let the type specific
885 * code confirm. Track this static object if true, else invoke
888 if (descr->is_static_object && descr->is_static_object(addr)) {
889 /* Track this static object */
890 debug_object_init(addr, descr);
892 debug_print_object(&o, "assert_init");
893 debug_object_fixup(descr->fixup_assert_init, addr,
894 ODEBUG_STATE_NOTAVAILABLE);
899 raw_spin_unlock_irqrestore(&db->lock, flags);
901 EXPORT_SYMBOL_GPL(debug_object_assert_init);
904 * debug_object_active_state - debug checks object usage state machine
905 * @addr: address of the object
906 * @descr: pointer to an object specific debug description structure
907 * @expect: expected state
908 * @next: state to move to if expected state is found
911 debug_object_active_state(void *addr, const struct debug_obj_descr *descr,
912 unsigned int expect, unsigned int next)
914 struct debug_bucket *db;
915 struct debug_obj *obj;
917 bool print_object = false;
919 if (!debug_objects_enabled)
922 db = get_bucket((unsigned long) addr);
924 raw_spin_lock_irqsave(&db->lock, flags);
926 obj = lookup_object(addr, db);
928 switch (obj->state) {
929 case ODEBUG_STATE_ACTIVE:
930 if (obj->astate == expect)
942 raw_spin_unlock_irqrestore(&db->lock, flags);
944 struct debug_obj o = { .object = addr,
945 .state = ODEBUG_STATE_NOTAVAILABLE,
948 debug_print_object(&o, "active_state");
949 } else if (print_object) {
950 debug_print_object(obj, "active_state");
953 EXPORT_SYMBOL_GPL(debug_object_active_state);
955 #ifdef CONFIG_DEBUG_OBJECTS_FREE
956 static void __debug_check_no_obj_freed(const void *address, unsigned long size)
958 unsigned long flags, oaddr, saddr, eaddr, paddr, chunks;
959 const struct debug_obj_descr *descr;
960 enum debug_obj_state state;
961 struct debug_bucket *db;
962 struct hlist_node *tmp;
963 struct debug_obj *obj;
964 int cnt, objs_checked = 0;
966 saddr = (unsigned long) address;
967 eaddr = saddr + size;
968 paddr = saddr & ODEBUG_CHUNK_MASK;
969 chunks = ((eaddr - paddr) + (ODEBUG_CHUNK_SIZE - 1));
970 chunks >>= ODEBUG_CHUNK_SHIFT;
972 for (;chunks > 0; chunks--, paddr += ODEBUG_CHUNK_SIZE) {
973 db = get_bucket(paddr);
977 raw_spin_lock_irqsave(&db->lock, flags);
978 hlist_for_each_entry_safe(obj, tmp, &db->list, node) {
980 oaddr = (unsigned long) obj->object;
981 if (oaddr < saddr || oaddr >= eaddr)
984 switch (obj->state) {
985 case ODEBUG_STATE_ACTIVE:
988 raw_spin_unlock_irqrestore(&db->lock, flags);
989 debug_print_object(obj, "free");
990 debug_object_fixup(descr->fixup_free,
991 (void *) oaddr, state);
994 hlist_del(&obj->node);
999 raw_spin_unlock_irqrestore(&db->lock, flags);
1001 if (cnt > debug_objects_maxchain)
1002 debug_objects_maxchain = cnt;
1004 objs_checked += cnt;
1007 if (objs_checked > debug_objects_maxchecked)
1008 debug_objects_maxchecked = objs_checked;
1010 /* Schedule work to actually kmem_cache_free() objects */
1011 if (!READ_ONCE(obj_freeing) && READ_ONCE(obj_nr_tofree)) {
1012 WRITE_ONCE(obj_freeing, true);
1013 schedule_delayed_work(&debug_obj_work, ODEBUG_FREE_WORK_DELAY);
1017 void debug_check_no_obj_freed(const void *address, unsigned long size)
1019 if (debug_objects_enabled)
1020 __debug_check_no_obj_freed(address, size);
1024 #ifdef CONFIG_DEBUG_FS
1026 static int debug_stats_show(struct seq_file *m, void *v)
1028 int cpu, obj_percpu_free = 0;
1030 for_each_possible_cpu(cpu)
1031 obj_percpu_free += per_cpu(percpu_obj_pool.obj_free, cpu);
1033 seq_printf(m, "max_chain :%d\n", debug_objects_maxchain);
1034 seq_printf(m, "max_checked :%d\n", debug_objects_maxchecked);
1035 seq_printf(m, "warnings :%d\n", debug_objects_warnings);
1036 seq_printf(m, "fixups :%d\n", debug_objects_fixups);
1037 seq_printf(m, "pool_free :%d\n", READ_ONCE(obj_pool_free) + obj_percpu_free);
1038 seq_printf(m, "pool_pcp_free :%d\n", obj_percpu_free);
1039 seq_printf(m, "pool_min_free :%d\n", obj_pool_min_free);
1040 seq_printf(m, "pool_used :%d\n", obj_pool_used - obj_percpu_free);
1041 seq_printf(m, "pool_max_used :%d\n", obj_pool_max_used);
1042 seq_printf(m, "on_free_list :%d\n", READ_ONCE(obj_nr_tofree));
1043 seq_printf(m, "objs_allocated:%d\n", debug_objects_allocated);
1044 seq_printf(m, "objs_freed :%d\n", debug_objects_freed);
1047 DEFINE_SHOW_ATTRIBUTE(debug_stats);
1049 static int __init debug_objects_init_debugfs(void)
1051 struct dentry *dbgdir;
1053 if (!debug_objects_enabled)
1056 dbgdir = debugfs_create_dir("debug_objects", NULL);
1058 debugfs_create_file("stats", 0444, dbgdir, NULL, &debug_stats_fops);
1062 __initcall(debug_objects_init_debugfs);
1065 static inline void debug_objects_init_debugfs(void) { }
1068 #ifdef CONFIG_DEBUG_OBJECTS_SELFTEST
1070 /* Random data structure for the self test */
1072 unsigned long dummy1[6];
1074 unsigned long dummy2[3];
1077 static __initconst const struct debug_obj_descr descr_type_test;
1079 static bool __init is_static_object(void *addr)
1081 struct self_test *obj = addr;
1083 return obj->static_init;
1087 * fixup_init is called when:
1088 * - an active object is initialized
1090 static bool __init fixup_init(void *addr, enum debug_obj_state state)
1092 struct self_test *obj = addr;
1095 case ODEBUG_STATE_ACTIVE:
1096 debug_object_deactivate(obj, &descr_type_test);
1097 debug_object_init(obj, &descr_type_test);
1105 * fixup_activate is called when:
1106 * - an active object is activated
1107 * - an unknown non-static object is activated
1109 static bool __init fixup_activate(void *addr, enum debug_obj_state state)
1111 struct self_test *obj = addr;
1114 case ODEBUG_STATE_NOTAVAILABLE:
1116 case ODEBUG_STATE_ACTIVE:
1117 debug_object_deactivate(obj, &descr_type_test);
1118 debug_object_activate(obj, &descr_type_test);
1127 * fixup_destroy is called when:
1128 * - an active object is destroyed
1130 static bool __init fixup_destroy(void *addr, enum debug_obj_state state)
1132 struct self_test *obj = addr;
1135 case ODEBUG_STATE_ACTIVE:
1136 debug_object_deactivate(obj, &descr_type_test);
1137 debug_object_destroy(obj, &descr_type_test);
1145 * fixup_free is called when:
1146 * - an active object is freed
1148 static bool __init fixup_free(void *addr, enum debug_obj_state state)
1150 struct self_test *obj = addr;
1153 case ODEBUG_STATE_ACTIVE:
1154 debug_object_deactivate(obj, &descr_type_test);
1155 debug_object_free(obj, &descr_type_test);
1163 check_results(void *addr, enum debug_obj_state state, int fixups, int warnings)
1165 struct debug_bucket *db;
1166 struct debug_obj *obj;
1167 unsigned long flags;
1170 db = get_bucket((unsigned long) addr);
1172 raw_spin_lock_irqsave(&db->lock, flags);
1174 obj = lookup_object(addr, db);
1175 if (!obj && state != ODEBUG_STATE_NONE) {
1176 WARN(1, KERN_ERR "ODEBUG: selftest object not found\n");
1179 if (obj && obj->state != state) {
1180 WARN(1, KERN_ERR "ODEBUG: selftest wrong state: %d != %d\n",
1184 if (fixups != debug_objects_fixups) {
1185 WARN(1, KERN_ERR "ODEBUG: selftest fixups failed %d != %d\n",
1186 fixups, debug_objects_fixups);
1189 if (warnings != debug_objects_warnings) {
1190 WARN(1, KERN_ERR "ODEBUG: selftest warnings failed %d != %d\n",
1191 warnings, debug_objects_warnings);
1196 raw_spin_unlock_irqrestore(&db->lock, flags);
1198 debug_objects_enabled = 0;
1202 static __initconst const struct debug_obj_descr descr_type_test = {
1204 .is_static_object = is_static_object,
1205 .fixup_init = fixup_init,
1206 .fixup_activate = fixup_activate,
1207 .fixup_destroy = fixup_destroy,
1208 .fixup_free = fixup_free,
1211 static __initdata struct self_test obj = { .static_init = 0 };
1213 static void __init debug_objects_selftest(void)
1215 int fixups, oldfixups, warnings, oldwarnings;
1216 unsigned long flags;
1218 local_irq_save(flags);
1220 fixups = oldfixups = debug_objects_fixups;
1221 warnings = oldwarnings = debug_objects_warnings;
1222 descr_test = &descr_type_test;
1224 debug_object_init(&obj, &descr_type_test);
1225 if (check_results(&obj, ODEBUG_STATE_INIT, fixups, warnings))
1227 debug_object_activate(&obj, &descr_type_test);
1228 if (check_results(&obj, ODEBUG_STATE_ACTIVE, fixups, warnings))
1230 debug_object_activate(&obj, &descr_type_test);
1231 if (check_results(&obj, ODEBUG_STATE_ACTIVE, ++fixups, ++warnings))
1233 debug_object_deactivate(&obj, &descr_type_test);
1234 if (check_results(&obj, ODEBUG_STATE_INACTIVE, fixups, warnings))
1236 debug_object_destroy(&obj, &descr_type_test);
1237 if (check_results(&obj, ODEBUG_STATE_DESTROYED, fixups, warnings))
1239 debug_object_init(&obj, &descr_type_test);
1240 if (check_results(&obj, ODEBUG_STATE_DESTROYED, fixups, ++warnings))
1242 debug_object_activate(&obj, &descr_type_test);
1243 if (check_results(&obj, ODEBUG_STATE_DESTROYED, fixups, ++warnings))
1245 debug_object_deactivate(&obj, &descr_type_test);
1246 if (check_results(&obj, ODEBUG_STATE_DESTROYED, fixups, ++warnings))
1248 debug_object_free(&obj, &descr_type_test);
1249 if (check_results(&obj, ODEBUG_STATE_NONE, fixups, warnings))
1252 obj.static_init = 1;
1253 debug_object_activate(&obj, &descr_type_test);
1254 if (check_results(&obj, ODEBUG_STATE_ACTIVE, fixups, warnings))
1256 debug_object_init(&obj, &descr_type_test);
1257 if (check_results(&obj, ODEBUG_STATE_INIT, ++fixups, ++warnings))
1259 debug_object_free(&obj, &descr_type_test);
1260 if (check_results(&obj, ODEBUG_STATE_NONE, fixups, warnings))
1263 #ifdef CONFIG_DEBUG_OBJECTS_FREE
1264 debug_object_init(&obj, &descr_type_test);
1265 if (check_results(&obj, ODEBUG_STATE_INIT, fixups, warnings))
1267 debug_object_activate(&obj, &descr_type_test);
1268 if (check_results(&obj, ODEBUG_STATE_ACTIVE, fixups, warnings))
1270 __debug_check_no_obj_freed(&obj, sizeof(obj));
1271 if (check_results(&obj, ODEBUG_STATE_NONE, ++fixups, ++warnings))
1274 pr_info("selftest passed\n");
1277 debug_objects_fixups = oldfixups;
1278 debug_objects_warnings = oldwarnings;
1281 local_irq_restore(flags);
1284 static inline void debug_objects_selftest(void) { }
1288 * Called during early boot to initialize the hash buckets and link
1289 * the static object pool objects into the poll list. After this call
1290 * the object tracker is fully operational.
1292 void __init debug_objects_early_init(void)
1296 for (i = 0; i < ODEBUG_HASH_SIZE; i++)
1297 raw_spin_lock_init(&obj_hash[i].lock);
1299 for (i = 0; i < ODEBUG_POOL_SIZE; i++)
1300 hlist_add_head(&obj_static_pool[i].node, &obj_pool);
1304 * Convert the statically allocated objects to dynamic ones:
1306 static int __init debug_objects_replace_static_objects(void)
1308 struct debug_bucket *db = obj_hash;
1309 struct hlist_node *tmp;
1310 struct debug_obj *obj, *new;
1311 HLIST_HEAD(objects);
1314 for (i = 0; i < ODEBUG_POOL_SIZE; i++) {
1315 obj = kmem_cache_zalloc(obj_cache, GFP_KERNEL);
1318 hlist_add_head(&obj->node, &objects);
1322 * debug_objects_mem_init() is now called early that only one CPU is up
1323 * and interrupts have been disabled, so it is safe to replace the
1324 * active object references.
1327 /* Remove the statically allocated objects from the pool */
1328 hlist_for_each_entry_safe(obj, tmp, &obj_pool, node)
1329 hlist_del(&obj->node);
1330 /* Move the allocated objects to the pool */
1331 hlist_move_list(&objects, &obj_pool);
1333 /* Replace the active object references */
1334 for (i = 0; i < ODEBUG_HASH_SIZE; i++, db++) {
1335 hlist_move_list(&db->list, &objects);
1337 hlist_for_each_entry(obj, &objects, node) {
1338 new = hlist_entry(obj_pool.first, typeof(*obj), node);
1339 hlist_del(&new->node);
1340 /* copy object data */
1342 hlist_add_head(&new->node, &db->list);
1347 pr_debug("%d of %d active objects replaced\n",
1348 cnt, obj_pool_used);
1351 hlist_for_each_entry_safe(obj, tmp, &objects, node) {
1352 hlist_del(&obj->node);
1353 kmem_cache_free(obj_cache, obj);
1359 * Called after the kmem_caches are functional to setup a dedicated
1360 * cache pool, which has the SLAB_DEBUG_OBJECTS flag set. This flag
1361 * prevents that the debug code is called on kmem_cache_free() for the
1362 * debug tracker objects to avoid recursive calls.
1364 void __init debug_objects_mem_init(void)
1368 if (!debug_objects_enabled)
1372 * Initialize the percpu object pools
1374 * Initialization is not strictly necessary, but was done for
1377 for_each_possible_cpu(cpu)
1378 INIT_HLIST_HEAD(&per_cpu(percpu_obj_pool.free_objs, cpu));
1380 obj_cache = kmem_cache_create("debug_objects_cache",
1381 sizeof (struct debug_obj), 0,
1382 SLAB_DEBUG_OBJECTS | SLAB_NOLEAKTRACE,
1385 if (!obj_cache || debug_objects_replace_static_objects()) {
1386 debug_objects_enabled = 0;
1387 kmem_cache_destroy(obj_cache);
1388 pr_warn("out of memory.\n");
1390 debug_objects_selftest();
1392 #ifdef CONFIG_HOTPLUG_CPU
1393 cpuhp_setup_state_nocalls(CPUHP_DEBUG_OBJ_DEAD, "object:offline", NULL,
1394 object_cpu_offline);
1398 * Increase the thresholds for allocating and freeing objects
1399 * according to the number of possible CPUs available in the system.
1401 extras = num_possible_cpus() * ODEBUG_BATCH_SIZE;
1402 debug_objects_pool_size += extras;
1403 debug_objects_pool_min_level += extras;