1 #ifndef _LINUX_DEBUGOBJECTS_H
2 #define _LINUX_DEBUGOBJECTS_H
4 #include <linux/list.h>
5 #include <linux/spinlock.h>
10 ODEBUG_STATE_INACTIVE,
12 ODEBUG_STATE_DESTROYED,
13 ODEBUG_STATE_NOTAVAILABLE,
17 struct debug_obj_descr;
20 * struct debug_obj - representaion of an tracked object
21 * @node: hlist node to link the object into the tracker list
22 * @state: tracked object state
23 * @astate: current active state
24 * @object: pointer to the real object
25 * @descr: pointer to an object type specific debug description structure
28 struct hlist_node node;
29 enum debug_obj_state state;
32 struct debug_obj_descr *descr;
36 * struct debug_obj_descr - object type specific debug description structure
38 * @name: name of the object typee
39 * @debug_hint: function returning address, which have associated
40 * kernel symbol, to allow identify the object
41 * @is_static_object: return true if the obj is static, otherwise return false
42 * @fixup_init: fixup function, which is called when the init check
43 * fails. All fixup functions must return true if fixup
44 * was successful, otherwise return false
45 * @fixup_activate: fixup function, which is called when the activate check
47 * @fixup_destroy: fixup function, which is called when the destroy check
49 * @fixup_free: fixup function, which is called when the free check
51 * @fixup_assert_init: fixup function, which is called when the assert_init
54 struct debug_obj_descr {
56 void *(*debug_hint)(void *addr);
57 bool (*is_static_object)(void *addr);
58 bool (*fixup_init)(void *addr, enum debug_obj_state state);
59 bool (*fixup_activate)(void *addr, enum debug_obj_state state);
60 bool (*fixup_destroy)(void *addr, enum debug_obj_state state);
61 bool (*fixup_free)(void *addr, enum debug_obj_state state);
62 bool (*fixup_assert_init)(void *addr, enum debug_obj_state state);
65 #ifdef CONFIG_DEBUG_OBJECTS
66 extern void debug_object_init (void *addr, struct debug_obj_descr *descr);
68 debug_object_init_on_stack(void *addr, struct debug_obj_descr *descr);
69 extern int debug_object_activate (void *addr, struct debug_obj_descr *descr);
70 extern void debug_object_deactivate(void *addr, struct debug_obj_descr *descr);
71 extern void debug_object_destroy (void *addr, struct debug_obj_descr *descr);
72 extern void debug_object_free (void *addr, struct debug_obj_descr *descr);
73 extern void debug_object_assert_init(void *addr, struct debug_obj_descr *descr);
77 * - Set at 0 upon initialization.
78 * - Must return to 0 before deactivation.
81 debug_object_active_state(void *addr, struct debug_obj_descr *descr,
82 unsigned int expect, unsigned int next);
84 extern void debug_objects_early_init(void);
85 extern void debug_objects_mem_init(void);
88 debug_object_init (void *addr, struct debug_obj_descr *descr) { }
90 debug_object_init_on_stack(void *addr, struct debug_obj_descr *descr) { }
92 debug_object_activate (void *addr, struct debug_obj_descr *descr) { return 0; }
94 debug_object_deactivate(void *addr, struct debug_obj_descr *descr) { }
96 debug_object_destroy (void *addr, struct debug_obj_descr *descr) { }
98 debug_object_free (void *addr, struct debug_obj_descr *descr) { }
100 debug_object_assert_init(void *addr, struct debug_obj_descr *descr) { }
102 static inline void debug_objects_early_init(void) { }
103 static inline void debug_objects_mem_init(void) { }
106 #ifdef CONFIG_DEBUG_OBJECTS_FREE
107 extern void debug_check_no_obj_freed(const void *address, unsigned long size);
110 debug_check_no_obj_freed(const void *address, unsigned long size) { }