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