2 * Generic infrastructure for lifetime debugging of objects.
4 * Started by Thomas Gleixner
6 * Copyright (C) 2008, Thomas Gleixner <tglx@linutronix.de>
8 * For licencing details see kernel-base/COPYING
11 #define pr_fmt(fmt) "ODEBUG: " fmt
13 #include <linux/debugobjects.h>
14 #include <linux/interrupt.h>
15 #include <linux/sched.h>
16 #include <linux/sched/task_stack.h>
17 #include <linux/seq_file.h>
18 #include <linux/debugfs.h>
19 #include <linux/slab.h>
20 #include <linux/hash.h>
21 #include <linux/kmemleak.h>
23 #define ODEBUG_HASH_BITS 14
24 #define ODEBUG_HASH_SIZE (1 << ODEBUG_HASH_BITS)
26 #define ODEBUG_POOL_SIZE 1024
27 #define ODEBUG_POOL_MIN_LEVEL 256
28 #define ODEBUG_POOL_PERCPU_SIZE 64
29 #define ODEBUG_BATCH_SIZE 16
31 #define ODEBUG_CHUNK_SHIFT PAGE_SHIFT
32 #define ODEBUG_CHUNK_SIZE (1 << ODEBUG_CHUNK_SHIFT)
33 #define ODEBUG_CHUNK_MASK (~(ODEBUG_CHUNK_SIZE - 1))
36 * We limit the freeing of debug objects via workqueue at a maximum
37 * frequency of 10Hz and about 1024 objects for each freeing operation.
38 * So it is freeing at most 10k debug objects per second.
40 #define ODEBUG_FREE_WORK_MAX 1024
41 #define ODEBUG_FREE_WORK_DELAY DIV_ROUND_UP(HZ, 10)
44 struct hlist_head list;
49 * Debug object percpu free list
50 * Access is protected by disabling irq
52 struct debug_percpu_free {
53 struct hlist_head free_objs;
57 static DEFINE_PER_CPU(struct debug_percpu_free, percpu_obj_pool);
59 static struct debug_bucket obj_hash[ODEBUG_HASH_SIZE];
61 static struct debug_obj obj_static_pool[ODEBUG_POOL_SIZE] __initdata;
63 static DEFINE_RAW_SPINLOCK(pool_lock);
65 static HLIST_HEAD(obj_pool);
66 static HLIST_HEAD(obj_to_free);
69 * Because of the presence of percpu free pools, obj_pool_free will
70 * under-count those in the percpu free pools. Similarly, obj_pool_used
71 * will over-count those in the percpu free pools. Adjustments will be
72 * made at debug_stats_show(). Both obj_pool_min_free and obj_pool_max_used
75 static int obj_pool_min_free = ODEBUG_POOL_SIZE;
76 static int obj_pool_free = ODEBUG_POOL_SIZE;
77 static int obj_pool_used;
78 static int obj_pool_max_used;
79 static bool obj_freeing;
80 /* The number of objs on the global free list */
81 static int obj_nr_tofree;
83 static int debug_objects_maxchain __read_mostly;
84 static int __maybe_unused debug_objects_maxchecked __read_mostly;
85 static int debug_objects_fixups __read_mostly;
86 static int debug_objects_warnings __read_mostly;
87 static int debug_objects_enabled __read_mostly
88 = CONFIG_DEBUG_OBJECTS_ENABLE_DEFAULT;
89 static int debug_objects_pool_size __read_mostly
91 static int debug_objects_pool_min_level __read_mostly
92 = ODEBUG_POOL_MIN_LEVEL;
93 static struct debug_obj_descr *descr_test __read_mostly;
94 static struct kmem_cache *obj_cache __read_mostly;
97 * Track numbers of kmem_cache_alloc()/free() calls done.
99 static int debug_objects_allocated;
100 static int debug_objects_freed;
102 static void free_obj_work(struct work_struct *work);
103 static DECLARE_DELAYED_WORK(debug_obj_work, free_obj_work);
105 static int __init enable_object_debug(char *str)
107 debug_objects_enabled = 1;
111 static int __init disable_object_debug(char *str)
113 debug_objects_enabled = 0;
117 early_param("debug_objects", enable_object_debug);
118 early_param("no_debug_objects", disable_object_debug);
120 static const char *obj_states[ODEBUG_STATE_MAX] = {
121 [ODEBUG_STATE_NONE] = "none",
122 [ODEBUG_STATE_INIT] = "initialized",
123 [ODEBUG_STATE_INACTIVE] = "inactive",
124 [ODEBUG_STATE_ACTIVE] = "active",
125 [ODEBUG_STATE_DESTROYED] = "destroyed",
126 [ODEBUG_STATE_NOTAVAILABLE] = "not available",
129 static void fill_pool(void)
131 gfp_t gfp = GFP_ATOMIC | __GFP_NORETRY | __GFP_NOWARN;
132 struct debug_obj *obj;
135 if (likely(READ_ONCE(obj_pool_free) >= debug_objects_pool_min_level))
139 * Reuse objs from the global free list; they will be reinitialized
142 * Both obj_nr_tofree and obj_pool_free are checked locklessly; the
143 * READ_ONCE()s pair with the WRITE_ONCE()s in pool_lock critical
146 while (READ_ONCE(obj_nr_tofree) && (READ_ONCE(obj_pool_free) < obj_pool_min_free)) {
147 raw_spin_lock_irqsave(&pool_lock, flags);
149 * Recheck with the lock held as the worker thread might have
150 * won the race and freed the global free list already.
152 while (obj_nr_tofree && (obj_pool_free < obj_pool_min_free)) {
153 obj = hlist_entry(obj_to_free.first, typeof(*obj), node);
154 hlist_del(&obj->node);
155 WRITE_ONCE(obj_nr_tofree, obj_nr_tofree - 1);
156 hlist_add_head(&obj->node, &obj_pool);
157 WRITE_ONCE(obj_pool_free, obj_pool_free + 1);
159 raw_spin_unlock_irqrestore(&pool_lock, flags);
162 if (unlikely(!obj_cache))
165 while (READ_ONCE(obj_pool_free) < debug_objects_pool_min_level) {
166 struct debug_obj *new[ODEBUG_BATCH_SIZE];
169 for (cnt = 0; cnt < ODEBUG_BATCH_SIZE; cnt++) {
170 new[cnt] = kmem_cache_zalloc(obj_cache, gfp);
177 raw_spin_lock_irqsave(&pool_lock, flags);
179 hlist_add_head(&new[--cnt]->node, &obj_pool);
180 debug_objects_allocated++;
181 WRITE_ONCE(obj_pool_free, obj_pool_free + 1);
183 raw_spin_unlock_irqrestore(&pool_lock, flags);
188 * Lookup an object in the hash bucket.
190 static struct debug_obj *lookup_object(void *addr, struct debug_bucket *b)
192 struct debug_obj *obj;
195 hlist_for_each_entry(obj, &b->list, node) {
197 if (obj->object == addr)
200 if (cnt > debug_objects_maxchain)
201 debug_objects_maxchain = cnt;
207 * Allocate a new object from the hlist
209 static struct debug_obj *__alloc_object(struct hlist_head *list)
211 struct debug_obj *obj = NULL;
214 obj = hlist_entry(list->first, typeof(*obj), node);
215 hlist_del(&obj->node);
222 * Allocate a new object. If the pool is empty, switch off the debugger.
223 * Must be called with interrupts disabled.
225 static struct debug_obj *
226 alloc_object(void *addr, struct debug_bucket *b, struct debug_obj_descr *descr)
228 struct debug_percpu_free *percpu_pool = this_cpu_ptr(&percpu_obj_pool);
229 struct debug_obj *obj;
231 if (likely(obj_cache)) {
232 obj = __alloc_object(&percpu_pool->free_objs);
234 percpu_pool->obj_free--;
239 raw_spin_lock(&pool_lock);
240 obj = __alloc_object(&obj_pool);
243 WRITE_ONCE(obj_pool_free, obj_pool_free - 1);
246 * Looking ahead, allocate one batch of debug objects and
247 * put them into the percpu free pool.
249 if (likely(obj_cache)) {
252 for (i = 0; i < ODEBUG_BATCH_SIZE; i++) {
253 struct debug_obj *obj2;
255 obj2 = __alloc_object(&obj_pool);
258 hlist_add_head(&obj2->node,
259 &percpu_pool->free_objs);
260 percpu_pool->obj_free++;
262 WRITE_ONCE(obj_pool_free, obj_pool_free - 1);
266 if (obj_pool_used > obj_pool_max_used)
267 obj_pool_max_used = obj_pool_used;
269 if (obj_pool_free < obj_pool_min_free)
270 obj_pool_min_free = obj_pool_free;
272 raw_spin_unlock(&pool_lock);
278 obj->state = ODEBUG_STATE_NONE;
280 hlist_add_head(&obj->node, &b->list);
286 * workqueue function to free objects.
288 * To reduce contention on the global pool_lock, the actual freeing of
289 * debug objects will be delayed if the pool_lock is busy.
291 static void free_obj_work(struct work_struct *work)
293 struct hlist_node *tmp;
294 struct debug_obj *obj;
298 WRITE_ONCE(obj_freeing, false);
299 if (!raw_spin_trylock_irqsave(&pool_lock, flags))
302 if (obj_pool_free >= debug_objects_pool_size)
306 * The objs on the pool list might be allocated before the work is
307 * run, so recheck if pool list it full or not, if not fill pool
308 * list from the global free list. As it is likely that a workload
309 * may be gearing up to use more and more objects, don't free any
310 * of them until the next round.
312 while (obj_nr_tofree && obj_pool_free < debug_objects_pool_size) {
313 obj = hlist_entry(obj_to_free.first, typeof(*obj), node);
314 hlist_del(&obj->node);
315 hlist_add_head(&obj->node, &obj_pool);
316 WRITE_ONCE(obj_pool_free, obj_pool_free + 1);
317 WRITE_ONCE(obj_nr_tofree, obj_nr_tofree - 1);
319 raw_spin_unlock_irqrestore(&pool_lock, flags);
324 * Pool list is already full and there are still objs on the free
325 * list. Move remaining free objs to a temporary list to free the
326 * memory outside the pool_lock held region.
329 hlist_move_list(&obj_to_free, &tofree);
330 debug_objects_freed += obj_nr_tofree;
331 WRITE_ONCE(obj_nr_tofree, 0);
333 raw_spin_unlock_irqrestore(&pool_lock, flags);
335 hlist_for_each_entry_safe(obj, tmp, &tofree, node) {
336 hlist_del(&obj->node);
337 kmem_cache_free(obj_cache, obj);
341 static void __free_object(struct debug_obj *obj)
343 struct debug_obj *objs[ODEBUG_BATCH_SIZE];
344 struct debug_percpu_free *percpu_pool;
345 int lookahead_count = 0;
349 local_irq_save(flags);
351 goto free_to_obj_pool;
354 * Try to free it into the percpu pool first.
356 percpu_pool = this_cpu_ptr(&percpu_obj_pool);
357 if (percpu_pool->obj_free < ODEBUG_POOL_PERCPU_SIZE) {
358 hlist_add_head(&obj->node, &percpu_pool->free_objs);
359 percpu_pool->obj_free++;
360 local_irq_restore(flags);
365 * As the percpu pool is full, look ahead and pull out a batch
366 * of objects from the percpu pool and free them as well.
368 for (; lookahead_count < ODEBUG_BATCH_SIZE; lookahead_count++) {
369 objs[lookahead_count] = __alloc_object(&percpu_pool->free_objs);
370 if (!objs[lookahead_count])
372 percpu_pool->obj_free--;
376 raw_spin_lock(&pool_lock);
377 work = (obj_pool_free > debug_objects_pool_size) && obj_cache &&
378 (obj_nr_tofree < ODEBUG_FREE_WORK_MAX);
382 WRITE_ONCE(obj_nr_tofree, obj_nr_tofree + 1);
383 hlist_add_head(&obj->node, &obj_to_free);
384 if (lookahead_count) {
385 WRITE_ONCE(obj_nr_tofree, obj_nr_tofree + lookahead_count);
386 obj_pool_used -= lookahead_count;
387 while (lookahead_count) {
388 hlist_add_head(&objs[--lookahead_count]->node,
393 if ((obj_pool_free > debug_objects_pool_size) &&
394 (obj_nr_tofree < ODEBUG_FREE_WORK_MAX)) {
398 * Free one more batch of objects from obj_pool.
400 for (i = 0; i < ODEBUG_BATCH_SIZE; i++) {
401 obj = __alloc_object(&obj_pool);
402 hlist_add_head(&obj->node, &obj_to_free);
403 WRITE_ONCE(obj_pool_free, obj_pool_free - 1);
404 WRITE_ONCE(obj_nr_tofree, obj_nr_tofree + 1);
408 WRITE_ONCE(obj_pool_free, obj_pool_free + 1);
409 hlist_add_head(&obj->node, &obj_pool);
410 if (lookahead_count) {
411 WRITE_ONCE(obj_pool_free, obj_pool_free + lookahead_count);
412 obj_pool_used -= lookahead_count;
413 while (lookahead_count) {
414 hlist_add_head(&objs[--lookahead_count]->node,
419 raw_spin_unlock(&pool_lock);
420 local_irq_restore(flags);
424 * Put the object back into the pool and schedule work to free objects
427 static void free_object(struct debug_obj *obj)
430 if (!READ_ONCE(obj_freeing) && READ_ONCE(obj_nr_tofree)) {
431 WRITE_ONCE(obj_freeing, true);
432 schedule_delayed_work(&debug_obj_work, ODEBUG_FREE_WORK_DELAY);
437 * We run out of memory. That means we probably have tons of objects
440 static void debug_objects_oom(void)
442 struct debug_bucket *db = obj_hash;
443 struct hlist_node *tmp;
444 HLIST_HEAD(freelist);
445 struct debug_obj *obj;
449 pr_warn("Out of memory. ODEBUG disabled\n");
451 for (i = 0; i < ODEBUG_HASH_SIZE; i++, db++) {
452 raw_spin_lock_irqsave(&db->lock, flags);
453 hlist_move_list(&db->list, &freelist);
454 raw_spin_unlock_irqrestore(&db->lock, flags);
457 hlist_for_each_entry_safe(obj, tmp, &freelist, node) {
458 hlist_del(&obj->node);
465 * We use the pfn of the address for the hash. That way we can check
466 * for freed objects simply by checking the affected bucket.
468 static struct debug_bucket *get_bucket(unsigned long addr)
472 hash = hash_long((addr >> ODEBUG_CHUNK_SHIFT), ODEBUG_HASH_BITS);
473 return &obj_hash[hash];
476 static void debug_print_object(struct debug_obj *obj, char *msg)
478 struct debug_obj_descr *descr = obj->descr;
481 if (limit < 5 && descr != descr_test) {
482 void *hint = descr->debug_hint ?
483 descr->debug_hint(obj->object) : NULL;
485 WARN(1, KERN_ERR "ODEBUG: %s %s (active state %u) "
486 "object type: %s hint: %pS\n",
487 msg, obj_states[obj->state], obj->astate,
490 debug_objects_warnings++;
494 * Try to repair the damage, so we have a better chance to get useful
498 debug_object_fixup(bool (*fixup)(void *addr, enum debug_obj_state state),
499 void * addr, enum debug_obj_state state)
501 if (fixup && fixup(addr, state)) {
502 debug_objects_fixups++;
508 static void debug_object_is_on_stack(void *addr, int onstack)
516 is_on_stack = object_is_on_stack(addr);
517 if (is_on_stack == onstack)
522 pr_warn("object %p is on stack %p, but NOT annotated.\n", addr,
523 task_stack_page(current));
525 pr_warn("object %p is NOT on stack %p, but annotated.\n", addr,
526 task_stack_page(current));
532 __debug_object_init(void *addr, struct debug_obj_descr *descr, int onstack)
534 enum debug_obj_state state;
535 bool check_stack = false;
536 struct debug_bucket *db;
537 struct debug_obj *obj;
542 db = get_bucket((unsigned long) addr);
544 raw_spin_lock_irqsave(&db->lock, flags);
546 obj = lookup_object(addr, db);
548 obj = alloc_object(addr, db, descr);
550 debug_objects_enabled = 0;
551 raw_spin_unlock_irqrestore(&db->lock, flags);
558 switch (obj->state) {
559 case ODEBUG_STATE_NONE:
560 case ODEBUG_STATE_INIT:
561 case ODEBUG_STATE_INACTIVE:
562 obj->state = ODEBUG_STATE_INIT;
565 case ODEBUG_STATE_ACTIVE:
567 raw_spin_unlock_irqrestore(&db->lock, flags);
568 debug_print_object(obj, "init");
569 debug_object_fixup(descr->fixup_init, addr, state);
572 case ODEBUG_STATE_DESTROYED:
573 raw_spin_unlock_irqrestore(&db->lock, flags);
574 debug_print_object(obj, "init");
580 raw_spin_unlock_irqrestore(&db->lock, flags);
582 debug_object_is_on_stack(addr, onstack);
586 * debug_object_init - debug checks when an object is initialized
587 * @addr: address of the object
588 * @descr: pointer to an object specific debug description structure
590 void debug_object_init(void *addr, struct debug_obj_descr *descr)
592 if (!debug_objects_enabled)
595 __debug_object_init(addr, descr, 0);
597 EXPORT_SYMBOL_GPL(debug_object_init);
600 * debug_object_init_on_stack - debug checks when an object on stack is
602 * @addr: address of the object
603 * @descr: pointer to an object specific debug description structure
605 void debug_object_init_on_stack(void *addr, struct debug_obj_descr *descr)
607 if (!debug_objects_enabled)
610 __debug_object_init(addr, descr, 1);
612 EXPORT_SYMBOL_GPL(debug_object_init_on_stack);
615 * debug_object_activate - debug checks when an object is activated
616 * @addr: address of the object
617 * @descr: pointer to an object specific debug description structure
618 * Returns 0 for success, -EINVAL for check failed.
620 int debug_object_activate(void *addr, struct debug_obj_descr *descr)
622 enum debug_obj_state state;
623 struct debug_bucket *db;
624 struct debug_obj *obj;
627 struct debug_obj o = { .object = addr,
628 .state = ODEBUG_STATE_NOTAVAILABLE,
631 if (!debug_objects_enabled)
634 db = get_bucket((unsigned long) addr);
636 raw_spin_lock_irqsave(&db->lock, flags);
638 obj = lookup_object(addr, db);
640 bool print_object = false;
642 switch (obj->state) {
643 case ODEBUG_STATE_INIT:
644 case ODEBUG_STATE_INACTIVE:
645 obj->state = ODEBUG_STATE_ACTIVE;
649 case ODEBUG_STATE_ACTIVE:
651 raw_spin_unlock_irqrestore(&db->lock, flags);
652 debug_print_object(obj, "activate");
653 ret = debug_object_fixup(descr->fixup_activate, addr, state);
654 return ret ? 0 : -EINVAL;
656 case ODEBUG_STATE_DESTROYED:
664 raw_spin_unlock_irqrestore(&db->lock, flags);
666 debug_print_object(obj, "activate");
670 raw_spin_unlock_irqrestore(&db->lock, flags);
673 * We are here when a static object is activated. We
674 * let the type specific code confirm whether this is
675 * true or not. if true, we just make sure that the
676 * static object is tracked in the object tracker. If
677 * not, this must be a bug, so we try to fix it up.
679 if (descr->is_static_object && descr->is_static_object(addr)) {
680 /* track this static object */
681 debug_object_init(addr, descr);
682 debug_object_activate(addr, descr);
684 debug_print_object(&o, "activate");
685 ret = debug_object_fixup(descr->fixup_activate, addr,
686 ODEBUG_STATE_NOTAVAILABLE);
687 return ret ? 0 : -EINVAL;
691 EXPORT_SYMBOL_GPL(debug_object_activate);
694 * debug_object_deactivate - debug checks when an object is deactivated
695 * @addr: address of the object
696 * @descr: pointer to an object specific debug description structure
698 void debug_object_deactivate(void *addr, struct debug_obj_descr *descr)
700 struct debug_bucket *db;
701 struct debug_obj *obj;
703 bool print_object = false;
705 if (!debug_objects_enabled)
708 db = get_bucket((unsigned long) addr);
710 raw_spin_lock_irqsave(&db->lock, flags);
712 obj = lookup_object(addr, db);
714 switch (obj->state) {
715 case ODEBUG_STATE_INIT:
716 case ODEBUG_STATE_INACTIVE:
717 case ODEBUG_STATE_ACTIVE:
719 obj->state = ODEBUG_STATE_INACTIVE;
724 case ODEBUG_STATE_DESTROYED:
732 raw_spin_unlock_irqrestore(&db->lock, flags);
734 struct debug_obj o = { .object = addr,
735 .state = ODEBUG_STATE_NOTAVAILABLE,
738 debug_print_object(&o, "deactivate");
739 } else if (print_object) {
740 debug_print_object(obj, "deactivate");
743 EXPORT_SYMBOL_GPL(debug_object_deactivate);
746 * debug_object_destroy - debug checks when an object is destroyed
747 * @addr: address of the object
748 * @descr: pointer to an object specific debug description structure
750 void debug_object_destroy(void *addr, struct debug_obj_descr *descr)
752 enum debug_obj_state state;
753 struct debug_bucket *db;
754 struct debug_obj *obj;
756 bool print_object = false;
758 if (!debug_objects_enabled)
761 db = get_bucket((unsigned long) addr);
763 raw_spin_lock_irqsave(&db->lock, flags);
765 obj = lookup_object(addr, db);
769 switch (obj->state) {
770 case ODEBUG_STATE_NONE:
771 case ODEBUG_STATE_INIT:
772 case ODEBUG_STATE_INACTIVE:
773 obj->state = ODEBUG_STATE_DESTROYED;
775 case ODEBUG_STATE_ACTIVE:
777 raw_spin_unlock_irqrestore(&db->lock, flags);
778 debug_print_object(obj, "destroy");
779 debug_object_fixup(descr->fixup_destroy, addr, state);
782 case ODEBUG_STATE_DESTROYED:
789 raw_spin_unlock_irqrestore(&db->lock, flags);
791 debug_print_object(obj, "destroy");
793 EXPORT_SYMBOL_GPL(debug_object_destroy);
796 * debug_object_free - debug checks when an object is freed
797 * @addr: address of the object
798 * @descr: pointer to an object specific debug description structure
800 void debug_object_free(void *addr, struct debug_obj_descr *descr)
802 enum debug_obj_state state;
803 struct debug_bucket *db;
804 struct debug_obj *obj;
807 if (!debug_objects_enabled)
810 db = get_bucket((unsigned long) addr);
812 raw_spin_lock_irqsave(&db->lock, flags);
814 obj = lookup_object(addr, db);
818 switch (obj->state) {
819 case ODEBUG_STATE_ACTIVE:
821 raw_spin_unlock_irqrestore(&db->lock, flags);
822 debug_print_object(obj, "free");
823 debug_object_fixup(descr->fixup_free, addr, state);
826 hlist_del(&obj->node);
827 raw_spin_unlock_irqrestore(&db->lock, flags);
832 raw_spin_unlock_irqrestore(&db->lock, flags);
834 EXPORT_SYMBOL_GPL(debug_object_free);
837 * debug_object_assert_init - debug checks when object should be init-ed
838 * @addr: address of the object
839 * @descr: pointer to an object specific debug description structure
841 void debug_object_assert_init(void *addr, struct debug_obj_descr *descr)
843 struct debug_bucket *db;
844 struct debug_obj *obj;
847 if (!debug_objects_enabled)
850 db = get_bucket((unsigned long) addr);
852 raw_spin_lock_irqsave(&db->lock, flags);
854 obj = lookup_object(addr, db);
856 struct debug_obj o = { .object = addr,
857 .state = ODEBUG_STATE_NOTAVAILABLE,
860 raw_spin_unlock_irqrestore(&db->lock, flags);
862 * Maybe the object is static, and we let the type specific
863 * code confirm. Track this static object if true, else invoke
866 if (descr->is_static_object && descr->is_static_object(addr)) {
867 /* Track this static object */
868 debug_object_init(addr, descr);
870 debug_print_object(&o, "assert_init");
871 debug_object_fixup(descr->fixup_assert_init, addr,
872 ODEBUG_STATE_NOTAVAILABLE);
877 raw_spin_unlock_irqrestore(&db->lock, flags);
879 EXPORT_SYMBOL_GPL(debug_object_assert_init);
882 * debug_object_active_state - debug checks object usage state machine
883 * @addr: address of the object
884 * @descr: pointer to an object specific debug description structure
885 * @expect: expected state
886 * @next: state to move to if expected state is found
889 debug_object_active_state(void *addr, struct debug_obj_descr *descr,
890 unsigned int expect, unsigned int next)
892 struct debug_bucket *db;
893 struct debug_obj *obj;
895 bool print_object = false;
897 if (!debug_objects_enabled)
900 db = get_bucket((unsigned long) addr);
902 raw_spin_lock_irqsave(&db->lock, flags);
904 obj = lookup_object(addr, db);
906 switch (obj->state) {
907 case ODEBUG_STATE_ACTIVE:
908 if (obj->astate == expect)
920 raw_spin_unlock_irqrestore(&db->lock, flags);
922 struct debug_obj o = { .object = addr,
923 .state = ODEBUG_STATE_NOTAVAILABLE,
926 debug_print_object(&o, "active_state");
927 } else if (print_object) {
928 debug_print_object(obj, "active_state");
931 EXPORT_SYMBOL_GPL(debug_object_active_state);
933 #ifdef CONFIG_DEBUG_OBJECTS_FREE
934 static void __debug_check_no_obj_freed(const void *address, unsigned long size)
936 unsigned long flags, oaddr, saddr, eaddr, paddr, chunks;
937 struct debug_obj_descr *descr;
938 enum debug_obj_state state;
939 struct debug_bucket *db;
940 struct hlist_node *tmp;
941 struct debug_obj *obj;
942 int cnt, objs_checked = 0;
944 saddr = (unsigned long) address;
945 eaddr = saddr + size;
946 paddr = saddr & ODEBUG_CHUNK_MASK;
947 chunks = ((eaddr - paddr) + (ODEBUG_CHUNK_SIZE - 1));
948 chunks >>= ODEBUG_CHUNK_SHIFT;
950 for (;chunks > 0; chunks--, paddr += ODEBUG_CHUNK_SIZE) {
951 db = get_bucket(paddr);
955 raw_spin_lock_irqsave(&db->lock, flags);
956 hlist_for_each_entry_safe(obj, tmp, &db->list, node) {
958 oaddr = (unsigned long) obj->object;
959 if (oaddr < saddr || oaddr >= eaddr)
962 switch (obj->state) {
963 case ODEBUG_STATE_ACTIVE:
966 raw_spin_unlock_irqrestore(&db->lock, flags);
967 debug_print_object(obj, "free");
968 debug_object_fixup(descr->fixup_free,
969 (void *) oaddr, state);
972 hlist_del(&obj->node);
977 raw_spin_unlock_irqrestore(&db->lock, flags);
979 if (cnt > debug_objects_maxchain)
980 debug_objects_maxchain = cnt;
985 if (objs_checked > debug_objects_maxchecked)
986 debug_objects_maxchecked = objs_checked;
988 /* Schedule work to actually kmem_cache_free() objects */
989 if (!READ_ONCE(obj_freeing) && READ_ONCE(obj_nr_tofree)) {
990 WRITE_ONCE(obj_freeing, true);
991 schedule_delayed_work(&debug_obj_work, ODEBUG_FREE_WORK_DELAY);
995 void debug_check_no_obj_freed(const void *address, unsigned long size)
997 if (debug_objects_enabled)
998 __debug_check_no_obj_freed(address, size);
1002 #ifdef CONFIG_DEBUG_FS
1004 static int debug_stats_show(struct seq_file *m, void *v)
1006 int cpu, obj_percpu_free = 0;
1008 for_each_possible_cpu(cpu)
1009 obj_percpu_free += per_cpu(percpu_obj_pool.obj_free, cpu);
1011 seq_printf(m, "max_chain :%d\n", debug_objects_maxchain);
1012 seq_printf(m, "max_checked :%d\n", debug_objects_maxchecked);
1013 seq_printf(m, "warnings :%d\n", debug_objects_warnings);
1014 seq_printf(m, "fixups :%d\n", debug_objects_fixups);
1015 seq_printf(m, "pool_free :%d\n", READ_ONCE(obj_pool_free) + obj_percpu_free);
1016 seq_printf(m, "pool_pcp_free :%d\n", obj_percpu_free);
1017 seq_printf(m, "pool_min_free :%d\n", obj_pool_min_free);
1018 seq_printf(m, "pool_used :%d\n", obj_pool_used - obj_percpu_free);
1019 seq_printf(m, "pool_max_used :%d\n", obj_pool_max_used);
1020 seq_printf(m, "on_free_list :%d\n", READ_ONCE(obj_nr_tofree));
1021 seq_printf(m, "objs_allocated:%d\n", debug_objects_allocated);
1022 seq_printf(m, "objs_freed :%d\n", debug_objects_freed);
1026 static int debug_stats_open(struct inode *inode, struct file *filp)
1028 return single_open(filp, debug_stats_show, NULL);
1031 static const struct file_operations debug_stats_fops = {
1032 .open = debug_stats_open,
1034 .llseek = seq_lseek,
1035 .release = single_release,
1038 static int __init debug_objects_init_debugfs(void)
1040 struct dentry *dbgdir;
1042 if (!debug_objects_enabled)
1045 dbgdir = debugfs_create_dir("debug_objects", NULL);
1047 debugfs_create_file("stats", 0444, dbgdir, NULL, &debug_stats_fops);
1051 __initcall(debug_objects_init_debugfs);
1054 static inline void debug_objects_init_debugfs(void) { }
1057 #ifdef CONFIG_DEBUG_OBJECTS_SELFTEST
1059 /* Random data structure for the self test */
1061 unsigned long dummy1[6];
1063 unsigned long dummy2[3];
1066 static __initdata struct debug_obj_descr descr_type_test;
1068 static bool __init is_static_object(void *addr)
1070 struct self_test *obj = addr;
1072 return obj->static_init;
1076 * fixup_init is called when:
1077 * - an active object is initialized
1079 static bool __init fixup_init(void *addr, enum debug_obj_state state)
1081 struct self_test *obj = addr;
1084 case ODEBUG_STATE_ACTIVE:
1085 debug_object_deactivate(obj, &descr_type_test);
1086 debug_object_init(obj, &descr_type_test);
1094 * fixup_activate is called when:
1095 * - an active object is activated
1096 * - an unknown non-static object is activated
1098 static bool __init fixup_activate(void *addr, enum debug_obj_state state)
1100 struct self_test *obj = addr;
1103 case ODEBUG_STATE_NOTAVAILABLE:
1105 case ODEBUG_STATE_ACTIVE:
1106 debug_object_deactivate(obj, &descr_type_test);
1107 debug_object_activate(obj, &descr_type_test);
1116 * fixup_destroy is called when:
1117 * - an active object is destroyed
1119 static bool __init fixup_destroy(void *addr, enum debug_obj_state state)
1121 struct self_test *obj = addr;
1124 case ODEBUG_STATE_ACTIVE:
1125 debug_object_deactivate(obj, &descr_type_test);
1126 debug_object_destroy(obj, &descr_type_test);
1134 * fixup_free is called when:
1135 * - an active object is freed
1137 static bool __init fixup_free(void *addr, enum debug_obj_state state)
1139 struct self_test *obj = addr;
1142 case ODEBUG_STATE_ACTIVE:
1143 debug_object_deactivate(obj, &descr_type_test);
1144 debug_object_free(obj, &descr_type_test);
1152 check_results(void *addr, enum debug_obj_state state, int fixups, int warnings)
1154 struct debug_bucket *db;
1155 struct debug_obj *obj;
1156 unsigned long flags;
1159 db = get_bucket((unsigned long) addr);
1161 raw_spin_lock_irqsave(&db->lock, flags);
1163 obj = lookup_object(addr, db);
1164 if (!obj && state != ODEBUG_STATE_NONE) {
1165 WARN(1, KERN_ERR "ODEBUG: selftest object not found\n");
1168 if (obj && obj->state != state) {
1169 WARN(1, KERN_ERR "ODEBUG: selftest wrong state: %d != %d\n",
1173 if (fixups != debug_objects_fixups) {
1174 WARN(1, KERN_ERR "ODEBUG: selftest fixups failed %d != %d\n",
1175 fixups, debug_objects_fixups);
1178 if (warnings != debug_objects_warnings) {
1179 WARN(1, KERN_ERR "ODEBUG: selftest warnings failed %d != %d\n",
1180 warnings, debug_objects_warnings);
1185 raw_spin_unlock_irqrestore(&db->lock, flags);
1187 debug_objects_enabled = 0;
1191 static __initdata struct debug_obj_descr descr_type_test = {
1193 .is_static_object = is_static_object,
1194 .fixup_init = fixup_init,
1195 .fixup_activate = fixup_activate,
1196 .fixup_destroy = fixup_destroy,
1197 .fixup_free = fixup_free,
1200 static __initdata struct self_test obj = { .static_init = 0 };
1202 static void __init debug_objects_selftest(void)
1204 int fixups, oldfixups, warnings, oldwarnings;
1205 unsigned long flags;
1207 local_irq_save(flags);
1209 fixups = oldfixups = debug_objects_fixups;
1210 warnings = oldwarnings = debug_objects_warnings;
1211 descr_test = &descr_type_test;
1213 debug_object_init(&obj, &descr_type_test);
1214 if (check_results(&obj, ODEBUG_STATE_INIT, fixups, warnings))
1216 debug_object_activate(&obj, &descr_type_test);
1217 if (check_results(&obj, ODEBUG_STATE_ACTIVE, fixups, warnings))
1219 debug_object_activate(&obj, &descr_type_test);
1220 if (check_results(&obj, ODEBUG_STATE_ACTIVE, ++fixups, ++warnings))
1222 debug_object_deactivate(&obj, &descr_type_test);
1223 if (check_results(&obj, ODEBUG_STATE_INACTIVE, fixups, warnings))
1225 debug_object_destroy(&obj, &descr_type_test);
1226 if (check_results(&obj, ODEBUG_STATE_DESTROYED, fixups, warnings))
1228 debug_object_init(&obj, &descr_type_test);
1229 if (check_results(&obj, ODEBUG_STATE_DESTROYED, fixups, ++warnings))
1231 debug_object_activate(&obj, &descr_type_test);
1232 if (check_results(&obj, ODEBUG_STATE_DESTROYED, fixups, ++warnings))
1234 debug_object_deactivate(&obj, &descr_type_test);
1235 if (check_results(&obj, ODEBUG_STATE_DESTROYED, fixups, ++warnings))
1237 debug_object_free(&obj, &descr_type_test);
1238 if (check_results(&obj, ODEBUG_STATE_NONE, fixups, warnings))
1241 obj.static_init = 1;
1242 debug_object_activate(&obj, &descr_type_test);
1243 if (check_results(&obj, ODEBUG_STATE_ACTIVE, fixups, warnings))
1245 debug_object_init(&obj, &descr_type_test);
1246 if (check_results(&obj, ODEBUG_STATE_INIT, ++fixups, ++warnings))
1248 debug_object_free(&obj, &descr_type_test);
1249 if (check_results(&obj, ODEBUG_STATE_NONE, fixups, warnings))
1252 #ifdef CONFIG_DEBUG_OBJECTS_FREE
1253 debug_object_init(&obj, &descr_type_test);
1254 if (check_results(&obj, ODEBUG_STATE_INIT, fixups, warnings))
1256 debug_object_activate(&obj, &descr_type_test);
1257 if (check_results(&obj, ODEBUG_STATE_ACTIVE, fixups, warnings))
1259 __debug_check_no_obj_freed(&obj, sizeof(obj));
1260 if (check_results(&obj, ODEBUG_STATE_NONE, ++fixups, ++warnings))
1263 pr_info("selftest passed\n");
1266 debug_objects_fixups = oldfixups;
1267 debug_objects_warnings = oldwarnings;
1270 local_irq_restore(flags);
1273 static inline void debug_objects_selftest(void) { }
1277 * Called during early boot to initialize the hash buckets and link
1278 * the static object pool objects into the poll list. After this call
1279 * the object tracker is fully operational.
1281 void __init debug_objects_early_init(void)
1285 for (i = 0; i < ODEBUG_HASH_SIZE; i++)
1286 raw_spin_lock_init(&obj_hash[i].lock);
1288 for (i = 0; i < ODEBUG_POOL_SIZE; i++)
1289 hlist_add_head(&obj_static_pool[i].node, &obj_pool);
1293 * Convert the statically allocated objects to dynamic ones:
1295 static int __init debug_objects_replace_static_objects(void)
1297 struct debug_bucket *db = obj_hash;
1298 struct hlist_node *tmp;
1299 struct debug_obj *obj, *new;
1300 HLIST_HEAD(objects);
1303 for (i = 0; i < ODEBUG_POOL_SIZE; i++) {
1304 obj = kmem_cache_zalloc(obj_cache, GFP_KERNEL);
1307 hlist_add_head(&obj->node, &objects);
1311 * debug_objects_mem_init() is now called early that only one CPU is up
1312 * and interrupts have been disabled, so it is safe to replace the
1313 * active object references.
1316 /* Remove the statically allocated objects from the pool */
1317 hlist_for_each_entry_safe(obj, tmp, &obj_pool, node)
1318 hlist_del(&obj->node);
1319 /* Move the allocated objects to the pool */
1320 hlist_move_list(&objects, &obj_pool);
1322 /* Replace the active object references */
1323 for (i = 0; i < ODEBUG_HASH_SIZE; i++, db++) {
1324 hlist_move_list(&db->list, &objects);
1326 hlist_for_each_entry(obj, &objects, node) {
1327 new = hlist_entry(obj_pool.first, typeof(*obj), node);
1328 hlist_del(&new->node);
1329 /* copy object data */
1331 hlist_add_head(&new->node, &db->list);
1336 pr_debug("%d of %d active objects replaced\n",
1337 cnt, obj_pool_used);
1340 hlist_for_each_entry_safe(obj, tmp, &objects, node) {
1341 hlist_del(&obj->node);
1342 kmem_cache_free(obj_cache, obj);
1348 * Called after the kmem_caches are functional to setup a dedicated
1349 * cache pool, which has the SLAB_DEBUG_OBJECTS flag set. This flag
1350 * prevents that the debug code is called on kmem_cache_free() for the
1351 * debug tracker objects to avoid recursive calls.
1353 void __init debug_objects_mem_init(void)
1357 if (!debug_objects_enabled)
1361 * Initialize the percpu object pools
1363 * Initialization is not strictly necessary, but was done for
1366 for_each_possible_cpu(cpu)
1367 INIT_HLIST_HEAD(&per_cpu(percpu_obj_pool.free_objs, cpu));
1369 obj_cache = kmem_cache_create("debug_objects_cache",
1370 sizeof (struct debug_obj), 0,
1371 SLAB_DEBUG_OBJECTS | SLAB_NOLEAKTRACE,
1374 if (!obj_cache || debug_objects_replace_static_objects()) {
1375 debug_objects_enabled = 0;
1376 kmem_cache_destroy(obj_cache);
1377 pr_warn("out of memory.\n");
1379 debug_objects_selftest();
1382 * Increase the thresholds for allocating and freeing objects
1383 * according to the number of possible CPUs available in the system.
1385 extras = num_possible_cpus() * ODEBUG_BATCH_SIZE;
1386 debug_objects_pool_size += extras;
1387 debug_objects_pool_min_level += extras;