1 #ifndef _LINUX_DEBUGOBJECTS_H 2 #define _LINUX_DEBUGOBJECTS_H 3 4 #include <linux/list.h> 5 #include <linux/spinlock.h> 6 7 enum debug_obj_state { 8 ODEBUG_STATE_NONE, 9 ODEBUG_STATE_INIT, 10 ODEBUG_STATE_INACTIVE, 11 ODEBUG_STATE_ACTIVE, 12 ODEBUG_STATE_DESTROYED, 13 ODEBUG_STATE_NOTAVAILABLE, 14 ODEBUG_STATE_MAX, 15 }; 16 17 struct debug_obj_descr; 18 19 /** 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 26 */ 27 struct debug_obj { 28 struct hlist_node node; 29 enum debug_obj_state state; 30 unsigned int astate; 31 void *object; 32 struct debug_obj_descr *descr; 33 }; 34 35 /** 36 * struct debug_obj_descr - object type specific debug description structure 37 * 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 * @fixup_init: fixup function, which is called when the init check 42 * fails. All fixup functions must return true if fixup 43 * was successful, otherwise return false 44 * @fixup_activate: fixup function, which is called when the activate check 45 * fails 46 * @fixup_destroy: fixup function, which is called when the destroy check 47 * fails 48 * @fixup_free: fixup function, which is called when the free check 49 * fails 50 * @fixup_assert_init: fixup function, which is called when the assert_init 51 * check fails 52 */ 53 struct debug_obj_descr { 54 const char *name; 55 void *(*debug_hint)(void *addr); 56 bool (*fixup_init)(void *addr, enum debug_obj_state state); 57 bool (*fixup_activate)(void *addr, enum debug_obj_state state); 58 bool (*fixup_destroy)(void *addr, enum debug_obj_state state); 59 bool (*fixup_free)(void *addr, enum debug_obj_state state); 60 bool (*fixup_assert_init)(void *addr, enum debug_obj_state state); 61 }; 62 63 #ifdef CONFIG_DEBUG_OBJECTS 64 extern void debug_object_init (void *addr, struct debug_obj_descr *descr); 65 extern void 66 debug_object_init_on_stack(void *addr, struct debug_obj_descr *descr); 67 extern int debug_object_activate (void *addr, struct debug_obj_descr *descr); 68 extern void debug_object_deactivate(void *addr, struct debug_obj_descr *descr); 69 extern void debug_object_destroy (void *addr, struct debug_obj_descr *descr); 70 extern void debug_object_free (void *addr, struct debug_obj_descr *descr); 71 extern void debug_object_assert_init(void *addr, struct debug_obj_descr *descr); 72 73 /* 74 * Active state: 75 * - Set at 0 upon initialization. 76 * - Must return to 0 before deactivation. 77 */ 78 extern void 79 debug_object_active_state(void *addr, struct debug_obj_descr *descr, 80 unsigned int expect, unsigned int next); 81 82 extern void debug_objects_early_init(void); 83 extern void debug_objects_mem_init(void); 84 #else 85 static inline void 86 debug_object_init (void *addr, struct debug_obj_descr *descr) { } 87 static inline void 88 debug_object_init_on_stack(void *addr, struct debug_obj_descr *descr) { } 89 static inline int 90 debug_object_activate (void *addr, struct debug_obj_descr *descr) { return 0; } 91 static inline void 92 debug_object_deactivate(void *addr, struct debug_obj_descr *descr) { } 93 static inline void 94 debug_object_destroy (void *addr, struct debug_obj_descr *descr) { } 95 static inline void 96 debug_object_free (void *addr, struct debug_obj_descr *descr) { } 97 static inline void 98 debug_object_assert_init(void *addr, struct debug_obj_descr *descr) { } 99 100 static inline void debug_objects_early_init(void) { } 101 static inline void debug_objects_mem_init(void) { } 102 #endif 103 104 #ifdef CONFIG_DEBUG_OBJECTS_FREE 105 extern void debug_check_no_obj_freed(const void *address, unsigned long size); 106 #else 107 static inline void 108 debug_check_no_obj_freed(const void *address, unsigned long size) { } 109 #endif 110 111 #endif 112