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 * @fixup_init: fixup function, which is called when the init check
42 * fails
43 * @fixup_activate: fixup function, which is called when the activate check
44 * fails
45 * @fixup_destroy: fixup function, which is called when the destroy check
46 * fails
47 * @fixup_free: fixup function, which is called when the free check
48 * fails
49 */
50struct debug_obj_descr {
51 const char *name;
52 void *(*debug_hint) (void *addr);
53 int (*fixup_init) (void *addr, enum debug_obj_state state);
54 int (*fixup_activate) (void *addr, enum debug_obj_state state);
55 int (*fixup_destroy) (void *addr, enum debug_obj_state state);
56 int (*fixup_free) (void *addr, enum debug_obj_state state);
57};
58
59#ifdef CONFIG_DEBUG_OBJECTS
60extern void debug_object_init (void *addr, struct debug_obj_descr *descr);
61extern void
62debug_object_init_on_stack(void *addr, struct debug_obj_descr *descr);
63extern void debug_object_activate (void *addr, struct debug_obj_descr *descr);
64extern void debug_object_deactivate(void *addr, struct debug_obj_descr *descr);
65extern void debug_object_destroy (void *addr, struct debug_obj_descr *descr);
66extern void debug_object_free (void *addr, struct debug_obj_descr *descr);
67
68/*
69 * Active state:
70 * - Set at 0 upon initialization.
71 * - Must return to 0 before deactivation.
72 */
73extern void
74debug_object_active_state(void *addr, struct debug_obj_descr *descr,
75 unsigned int expect, unsigned int next);
76
77extern void debug_objects_early_init(void);
78extern void debug_objects_mem_init(void);
79#else
80static inline void
81debug_object_init (void *addr, struct debug_obj_descr *descr) { }
82static inline void
83debug_object_init_on_stack(void *addr, struct debug_obj_descr *descr) { }
84static inline void
85debug_object_activate (void *addr, struct debug_obj_descr *descr) { }
86static inline void
87debug_object_deactivate(void *addr, struct debug_obj_descr *descr) { }
88static inline void
89debug_object_destroy (void *addr, struct debug_obj_descr *descr) { }
90static inline void
91debug_object_free (void *addr, struct debug_obj_descr *descr) { }
92
93static inline void debug_objects_early_init(void) { }
94static inline void debug_objects_mem_init(void) { }
95#endif
96
97#ifdef CONFIG_DEBUG_OBJECTS_FREE
98extern void debug_check_no_obj_freed(const void *address, unsigned long size);
99#else
100static inline void
101debug_check_no_obj_freed(const void *address, unsigned long size) { }
102#endif
103
104#endif