Commit | Line | Data |
---|---|---|
b2441318 | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
50656eec MH |
2 | #ifndef _PROBE_EVENT_H |
3 | #define _PROBE_EVENT_H | |
4 | ||
afaed6d3 | 5 | #include <linux/compiler.h> |
fac13fd5 | 6 | #include <stdbool.h> |
40f3b2d2 ACM |
7 | |
8 | struct intlist; | |
9 | struct nsinfo; | |
50656eec | 10 | |
ddb2f58f MH |
11 | /* Probe related configurations */ |
12 | struct probe_conf { | |
13 | bool show_ext_vars; | |
349e8d26 | 14 | bool show_location_range; |
ddb2f58f | 15 | bool force_add; |
6cfd1f68 | 16 | bool no_inlines; |
2fd457a3 | 17 | bool cache; |
45237f98 | 18 | bool bootconfig; |
ddb2f58f | 19 | int max_probes; |
cb402730 | 20 | unsigned long magic_num; |
ddb2f58f MH |
21 | }; |
22 | extern struct probe_conf probe_conf; | |
f4d7da49 MH |
23 | extern bool probe_event_dry_run; |
24 | ||
cb402730 MH |
25 | #define DEFAULT_PROBE_MAGIC_NUM 0xdeade12d /* u32: 3735937325 */ |
26 | ||
d6be1671 WN |
27 | struct symbol; |
28 | ||
225466f1 | 29 | /* kprobe-tracer and uprobe-tracer tracing point */ |
0e60836b | 30 | struct probe_trace_point { |
4c859351 | 31 | char *realname; /* function real name (if needed) */ |
4235b045 | 32 | char *symbol; /* Base symbol */ |
190b57fc | 33 | char *module; /* Module name */ |
4235b045 | 34 | unsigned long offset; /* Offset from symbol */ |
5a5e3d3c | 35 | unsigned long ref_ctr_offset; /* SDT reference counter offset */ |
22a66551 | 36 | u64 address; /* Actual address of the trace point */ |
4235b045 MH |
37 | bool retprobe; /* Return probe flag */ |
38 | }; | |
39 | ||
0e60836b SD |
40 | /* probe-tracer tracing argument referencing offset */ |
41 | struct probe_trace_arg_ref { | |
42 | struct probe_trace_arg_ref *next; /* Next reference */ | |
4235b045 | 43 | long offset; /* Offset value */ |
1e032f7c | 44 | bool user_access; /* User-memory access */ |
4235b045 MH |
45 | }; |
46 | ||
225466f1 | 47 | /* kprobe-tracer and uprobe-tracer tracing argument */ |
0e60836b | 48 | struct probe_trace_arg { |
4235b045 MH |
49 | char *name; /* Argument name */ |
50 | char *value; /* Base value */ | |
4984912e | 51 | char *type; /* Type name */ |
0e60836b | 52 | struct probe_trace_arg_ref *ref; /* Referencing offset */ |
4235b045 MH |
53 | }; |
54 | ||
225466f1 | 55 | /* kprobe-tracer and uprobe-tracer tracing event (point + arg) */ |
0e60836b | 56 | struct probe_trace_event { |
4235b045 MH |
57 | char *event; /* Event name */ |
58 | char *group; /* Group name */ | |
0e60836b | 59 | struct probe_trace_point point; /* Trace point */ |
4235b045 | 60 | int nargs; /* Number of args */ |
225466f1 | 61 | bool uprobes; /* uprobes only */ |
0e60836b | 62 | struct probe_trace_arg *args; /* Arguments */ |
4235b045 MH |
63 | }; |
64 | ||
65 | /* Perf probe probing point */ | |
66 | struct perf_probe_point { | |
67 | char *file; /* File path */ | |
68 | char *function; /* Function name */ | |
69 | int line; /* Line number */ | |
eed05fe7 | 70 | bool retprobe; /* Return probe flag */ |
4235b045 MH |
71 | char *lazy_line; /* Lazy matching pattern */ |
72 | unsigned long offset; /* Offset from function entry */ | |
22a66551 | 73 | u64 abs_address; /* Absolute address of the point */ |
4235b045 MH |
74 | }; |
75 | ||
7df2f329 MH |
76 | /* Perf probe probing argument field chain */ |
77 | struct perf_probe_arg_field { | |
78 | struct perf_probe_arg_field *next; /* Next field */ | |
79 | char *name; /* Name of the field */ | |
b2a3c12b | 80 | long index; /* Array index number */ |
7df2f329 MH |
81 | bool ref; /* Referencing flag */ |
82 | }; | |
83 | ||
4235b045 MH |
84 | /* Perf probe probing argument */ |
85 | struct perf_probe_arg { | |
7df2f329 | 86 | char *name; /* Argument name */ |
48481938 | 87 | char *var; /* Variable name */ |
11a1ca35 | 88 | char *type; /* Type name */ |
7df2f329 | 89 | struct perf_probe_arg_field *field; /* Structure fields */ |
1e032f7c | 90 | bool user_access; /* User-memory access */ |
4235b045 MH |
91 | }; |
92 | ||
93 | /* Perf probe probing event (point + arg) */ | |
94 | struct perf_probe_event { | |
95 | char *event; /* Event name */ | |
96 | char *group; /* Group name */ | |
97 | struct perf_probe_point point; /* Probe point */ | |
98 | int nargs; /* Number of arguments */ | |
36a009fe | 99 | bool sdt; /* SDT/cached event flag */ |
7afb3fab MH |
100 | bool uprobes; /* Uprobe event flag */ |
101 | char *target; /* Target binary */ | |
4235b045 | 102 | struct perf_probe_arg *args; /* Arguments */ |
12fae5ef WN |
103 | struct probe_trace_event *tevs; |
104 | int ntevs; | |
544abd44 | 105 | struct nsinfo *nsi; /* Target namespace */ |
4235b045 MH |
106 | }; |
107 | ||
4235b045 MH |
108 | /* Line range */ |
109 | struct line_range { | |
110 | char *file; /* File name */ | |
111 | char *function; /* Function name */ | |
d3b63d7a MH |
112 | int start; /* Start line number */ |
113 | int end; /* End line number */ | |
4235b045 MH |
114 | int offset; /* Start line offset */ |
115 | char *path; /* Real path name */ | |
6a330a3c | 116 | char *comp_dir; /* Compile directory */ |
5a62257a | 117 | struct intlist *line_list; /* Visible lines */ |
4235b045 MH |
118 | }; |
119 | ||
8ec20b17 ACM |
120 | struct strlist; |
121 | ||
cf6eb489 MH |
122 | /* List of variables */ |
123 | struct variable_list { | |
124 | struct probe_trace_point point; /* Actual probepoint */ | |
125 | struct strlist *vars; /* Available variables */ | |
126 | }; | |
127 | ||
5a023b57 | 128 | struct map; |
9bae1e8c NK |
129 | int init_probe_symbol_maps(bool user_only); |
130 | void exit_probe_symbol_maps(void); | |
5a023b57 | 131 | |
4235b045 | 132 | /* Command string to events */ |
3938bad4 ACM |
133 | int parse_perf_probe_command(const char *cmd, struct perf_probe_event *pev); |
134 | int parse_probe_trace_command(const char *cmd, struct probe_trace_event *tev); | |
4235b045 MH |
135 | |
136 | /* Events to command string */ | |
3938bad4 ACM |
137 | char *synthesize_perf_probe_command(struct perf_probe_event *pev); |
138 | char *synthesize_probe_trace_command(struct probe_trace_event *tev); | |
909b0360 | 139 | char *synthesize_perf_probe_arg(struct perf_probe_arg *pa); |
4235b045 | 140 | |
0542bb9c MH |
141 | int perf_probe_event__copy(struct perf_probe_event *dst, |
142 | struct perf_probe_event *src); | |
143 | ||
b3f33f93 RB |
144 | bool perf_probe_with_var(struct perf_probe_event *pev); |
145 | ||
4235b045 | 146 | /* Check the perf_probe_event needs debuginfo */ |
3938bad4 | 147 | bool perf_probe_event_need_dwarf(struct perf_probe_event *pev); |
4235b045 | 148 | |
4235b045 | 149 | /* Release event contents */ |
3938bad4 ACM |
150 | void clear_perf_probe_event(struct perf_probe_event *pev); |
151 | void clear_probe_trace_event(struct probe_trace_event *tev); | |
4235b045 MH |
152 | |
153 | /* Command string to line-range */ | |
3938bad4 | 154 | int parse_line_range_desc(const char *cmd, struct line_range *lr); |
4235b045 | 155 | |
e53b00d3 | 156 | /* Release line range members */ |
3938bad4 | 157 | void line_range__clear(struct line_range *lr); |
e53b00d3 MH |
158 | |
159 | /* Initialize line range */ | |
3938bad4 ACM |
160 | int line_range__init(struct line_range *lr); |
161 | ||
162 | int add_perf_probe_events(struct perf_probe_event *pevs, int npevs); | |
163 | int convert_perf_probe_events(struct perf_probe_event *pevs, int npevs); | |
164 | int apply_perf_probe_events(struct perf_probe_event *pevs, int npevs); | |
1c20b1d1 | 165 | int show_probe_trace_events(struct perf_probe_event *pevs, int npevs); |
45237f98 | 166 | int show_bootconfig_events(struct perf_probe_event *pevs, int npevs); |
3938bad4 | 167 | void cleanup_perf_probe_events(struct perf_probe_event *pevs, int npevs); |
8ec20b17 ACM |
168 | |
169 | struct strfilter; | |
170 | ||
3938bad4 ACM |
171 | int del_perf_probe_events(struct strfilter *filter); |
172 | ||
173 | int show_perf_probe_event(const char *group, const char *event, | |
174 | struct perf_probe_event *pev, | |
175 | const char *module, bool use_stdout); | |
176 | int show_perf_probe_events(struct strfilter *filter); | |
544abd44 KJ |
177 | int show_line_range(struct line_range *lr, const char *module, |
178 | struct nsinfo *nsi, bool user); | |
3938bad4 ACM |
179 | int show_available_vars(struct perf_probe_event *pevs, int npevs, |
180 | struct strfilter *filter); | |
544abd44 KJ |
181 | int show_available_funcs(const char *module, struct nsinfo *nsi, |
182 | struct strfilter *filter, bool user); | |
7b6ff0bd | 183 | void arch__fix_tev_from_maps(struct perf_probe_event *pev, |
0b3c2264 NR |
184 | struct probe_trace_event *tev, struct map *map, |
185 | struct symbol *sym); | |
4235b045 | 186 | |
92f6c72e | 187 | /* If there is no space to write, returns -E2BIG. */ |
afaed6d3 | 188 | int e_snprintf(char *str, size_t size, const char *format, ...) __printf(3, 4); |
92f6c72e | 189 | |
b498ce1f MH |
190 | /* Maximum index number of event-name postfix */ |
191 | #define MAX_EVENT_INDEX 1024 | |
192 | ||
da15bd9d WN |
193 | int copy_to_probe_trace_arg(struct probe_trace_arg *tvar, |
194 | struct perf_probe_arg *pvar); | |
195 | ||
544abd44 | 196 | struct map *get_target_map(const char *target, struct nsinfo *nsi, bool user); |
99e608b5 RB |
197 | |
198 | void arch__post_process_probe_trace_events(struct perf_probe_event *pev, | |
199 | int ntevs); | |
200 | ||
50656eec | 201 | #endif /*_PROBE_EVENT_H */ |