xref: /linux-6.15/include/linux/hw_breakpoint.h (revision bcefe12e)
1 #ifndef _LINUX_HW_BREAKPOINT_H
2 #define _LINUX_HW_BREAKPOINT_H
3 
4 enum {
5 	HW_BREAKPOINT_LEN_1 = 1,
6 	HW_BREAKPOINT_LEN_2 = 2,
7 	HW_BREAKPOINT_LEN_4 = 4,
8 	HW_BREAKPOINT_LEN_8 = 8,
9 };
10 
11 enum {
12 	HW_BREAKPOINT_R = 1,
13 	HW_BREAKPOINT_W = 2,
14 	HW_BREAKPOINT_X = 4,
15 };
16 
17 #ifdef __KERNEL__
18 
19 #include <linux/perf_event.h>
20 
21 #ifdef CONFIG_HAVE_HW_BREAKPOINT
22 
23 /* As it's for in-kernel or ptrace use, we want it to be pinned */
24 #define DEFINE_BREAKPOINT_ATTR(name)	\
25 struct perf_event_attr name = {		\
26 	.type = PERF_TYPE_BREAKPOINT,	\
27 	.size = sizeof(name),		\
28 	.pinned = 1,			\
29 };
30 
31 static inline void hw_breakpoint_init(struct perf_event_attr *attr)
32 {
33 	attr->type = PERF_TYPE_BREAKPOINT;
34 	attr->size = sizeof(*attr);
35 	attr->pinned = 1;
36 }
37 
38 static inline unsigned long hw_breakpoint_addr(struct perf_event *bp)
39 {
40 	return bp->attr.bp_addr;
41 }
42 
43 static inline int hw_breakpoint_type(struct perf_event *bp)
44 {
45 	return bp->attr.bp_type;
46 }
47 
48 static inline int hw_breakpoint_len(struct perf_event *bp)
49 {
50 	return bp->attr.bp_len;
51 }
52 
53 extern struct perf_event *
54 register_user_hw_breakpoint(struct perf_event_attr *attr,
55 			    perf_callback_t triggered,
56 			    struct task_struct *tsk);
57 
58 /* FIXME: only change from the attr, and don't unregister */
59 extern struct perf_event *
60 modify_user_hw_breakpoint(struct perf_event *bp,
61 			  struct perf_event_attr *attr,
62 			  perf_callback_t triggered,
63 			  struct task_struct *tsk);
64 
65 /*
66  * Kernel breakpoints are not associated with any particular thread.
67  */
68 extern struct perf_event *
69 register_wide_hw_breakpoint_cpu(struct perf_event_attr *attr,
70 				perf_callback_t triggered,
71 				int cpu);
72 
73 extern struct perf_event **
74 register_wide_hw_breakpoint(struct perf_event_attr *attr,
75 			    perf_callback_t triggered);
76 
77 extern int register_perf_hw_breakpoint(struct perf_event *bp);
78 extern int __register_perf_hw_breakpoint(struct perf_event *bp);
79 extern void unregister_hw_breakpoint(struct perf_event *bp);
80 extern void unregister_wide_hw_breakpoint(struct perf_event **cpu_events);
81 
82 extern int reserve_bp_slot(struct perf_event *bp);
83 extern void release_bp_slot(struct perf_event *bp);
84 
85 extern void flush_ptrace_hw_breakpoint(struct task_struct *tsk);
86 
87 static inline struct arch_hw_breakpoint *counter_arch_bp(struct perf_event *bp)
88 {
89 	return &bp->hw.info;
90 }
91 
92 #else /* !CONFIG_HAVE_HW_BREAKPOINT */
93 
94 static inline struct perf_event *
95 register_user_hw_breakpoint(struct perf_event_attr *attr,
96 			    perf_callback_t triggered,
97 			    struct task_struct *tsk)	{ return NULL; }
98 static inline struct perf_event *
99 modify_user_hw_breakpoint(struct perf_event *bp,
100 			  struct perf_event_attr *attr,
101 			  perf_callback_t triggered,
102 			  struct task_struct *tsk)	{ return NULL; }
103 static inline struct perf_event *
104 register_wide_hw_breakpoint_cpu(struct perf_event_attr *attr,
105 				perf_callback_t triggered,
106 				int cpu)		{ return NULL; }
107 static inline struct perf_event **
108 register_wide_hw_breakpoint(struct perf_event_attr *attr,
109 			    perf_callback_t triggered)	{ return NULL; }
110 static inline int
111 register_perf_hw_breakpoint(struct perf_event *bp)	{ return -ENOSYS; }
112 static inline int
113 __register_perf_hw_breakpoint(struct perf_event *bp) 	{ return -ENOSYS; }
114 static inline void unregister_hw_breakpoint(struct perf_event *bp)	{ }
115 static inline void
116 unregister_wide_hw_breakpoint(struct perf_event **cpu_events)		{ }
117 static inline int
118 reserve_bp_slot(struct perf_event *bp)			{return -ENOSYS; }
119 static inline void release_bp_slot(struct perf_event *bp) 		{ }
120 
121 static inline void flush_ptrace_hw_breakpoint(struct task_struct *tsk)	{ }
122 
123 static inline struct arch_hw_breakpoint *counter_arch_bp(struct perf_event *bp)
124 {
125 	return NULL;
126 }
127 
128 #endif /* CONFIG_HAVE_HW_BREAKPOINT */
129 #endif /* __KERNEL__ */
130 
131 #endif /* _LINUX_HW_BREAKPOINT_H */
132