Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1#ifndef _LINUX_DEBUGOBJECTS_H
2#define _LINUX_DEBUGOBJECTS_H
3
4#include <linux/list.h>
5#include <linux/spinlock.h>
6
7enum 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
17struct 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 */
27struct 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 * @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
46 * fails
47 * @fixup_destroy: fixup function, which is called when the destroy check
48 * fails
49 * @fixup_free: fixup function, which is called when the free check
50 * fails
51 * @fixup_assert_init: fixup function, which is called when the assert_init
52 * check fails
53 */
54struct debug_obj_descr {
55 const char *name;
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);
63};
64
65#ifdef CONFIG_DEBUG_OBJECTS
66extern void debug_object_init (void *addr, struct debug_obj_descr *descr);
67extern void
68debug_object_init_on_stack(void *addr, struct debug_obj_descr *descr);
69extern int debug_object_activate (void *addr, struct debug_obj_descr *descr);
70extern void debug_object_deactivate(void *addr, struct debug_obj_descr *descr);
71extern void debug_object_destroy (void *addr, struct debug_obj_descr *descr);
72extern void debug_object_free (void *addr, struct debug_obj_descr *descr);
73extern void debug_object_assert_init(void *addr, struct debug_obj_descr *descr);
74
75/*
76 * Active state:
77 * - Set at 0 upon initialization.
78 * - Must return to 0 before deactivation.
79 */
80extern void
81debug_object_active_state(void *addr, struct debug_obj_descr *descr,
82 unsigned int expect, unsigned int next);
83
84extern void debug_objects_early_init(void);
85extern void debug_objects_mem_init(void);
86#else
87static inline void
88debug_object_init (void *addr, struct debug_obj_descr *descr) { }
89static inline void
90debug_object_init_on_stack(void *addr, struct debug_obj_descr *descr) { }
91static inline int
92debug_object_activate (void *addr, struct debug_obj_descr *descr) { return 0; }
93static inline void
94debug_object_deactivate(void *addr, struct debug_obj_descr *descr) { }
95static inline void
96debug_object_destroy (void *addr, struct debug_obj_descr *descr) { }
97static inline void
98debug_object_free (void *addr, struct debug_obj_descr *descr) { }
99static inline void
100debug_object_assert_init(void *addr, struct debug_obj_descr *descr) { }
101
102static inline void debug_objects_early_init(void) { }
103static inline void debug_objects_mem_init(void) { }
104#endif
105
106#ifdef CONFIG_DEBUG_OBJECTS_FREE
107extern void debug_check_no_obj_freed(const void *address, unsigned long size);
108#else
109static inline void
110debug_check_no_obj_freed(const void *address, unsigned long size) { }
111#endif
112
113#endif