Commit | Line | Data |
---|---|---|
bcea3f96 | 1 | // SPDX-License-Identifier: GPL-2.0 |
8ab83f56 SD |
2 | /* |
3 | * Common header file for probe-based Dynamic events. | |
4 | * | |
8ab83f56 SD |
5 | * This code was copied from kernel/trace/trace_kprobe.h written by |
6 | * Masami Hiramatsu <masami.hiramatsu.pt@hitachi.com> | |
7 | * | |
8 | * Updates to make this generic: | |
9 | * Copyright (C) IBM Corporation, 2010-2011 | |
10 | * Author: Srikar Dronamraju | |
11 | */ | |
12 | ||
13 | #include <linux/seq_file.h> | |
14 | #include <linux/slab.h> | |
15 | #include <linux/smp.h> | |
8434dc93 | 16 | #include <linux/tracefs.h> |
8ab83f56 SD |
17 | #include <linux/types.h> |
18 | #include <linux/string.h> | |
8ab83f56 SD |
19 | #include <linux/ptrace.h> |
20 | #include <linux/perf_event.h> | |
21 | #include <linux/kprobes.h> | |
22 | #include <linux/stringify.h> | |
23 | #include <linux/limits.h> | |
24 | #include <linux/uaccess.h> | |
a1303af5 | 25 | #include <linux/bitops.h> |
b576e097 | 26 | #include <linux/btf.h> |
8ab83f56 SD |
27 | #include <asm/bitsperlong.h> |
28 | ||
29 | #include "trace.h" | |
30 | #include "trace_output.h" | |
31 | ||
32 | #define MAX_TRACE_ARGS 128 | |
33 | #define MAX_ARGSTR_LEN 63 | |
40b53b77 | 34 | #define MAX_ARRAY_LEN 64 |
b4443c17 | 35 | #define MAX_ARG_NAME_LEN 32 |
18b1e870 | 36 | #define MAX_BTF_ARGS_LEN 128 |
d9b15224 | 37 | #define MAX_DENTRY_ARGS_LEN 256 |
8ab83f56 | 38 | #define MAX_STRING_SIZE PATH_MAX |
18b1e870 | 39 | #define MAX_ARG_BUF_LEN (MAX_TRACE_ARGS * MAX_ARG_NAME_LEN) |
8ab83f56 SD |
40 | |
41 | /* Reserved field names */ | |
42 | #define FIELD_STRING_IP "__probe_ip" | |
43 | #define FIELD_STRING_RETIP "__probe_ret_ip" | |
44 | #define FIELD_STRING_FUNC "__probe_func" | |
45 | ||
46 | #undef DEFINE_FIELD | |
47 | #define DEFINE_FIELD(type, item, name, is_signed) \ | |
48 | do { \ | |
49 | ret = trace_define_field(event_call, #type, name, \ | |
50 | offsetof(typeof(field), item), \ | |
51 | sizeof(field.item), is_signed, \ | |
52 | FILTER_OTHER); \ | |
53 | if (ret) \ | |
54 | return ret; \ | |
55 | } while (0) | |
56 | ||
57 | ||
58 | /* Flags for trace_probe */ | |
59 | #define TP_FLAG_TRACE 1 | |
60 | #define TP_FLAG_PROFILE 2 | |
8ab83f56 | 61 | |
9178412d MH |
62 | /* data_loc: data location, compatible with u32 */ |
63 | #define make_data_loc(len, offs) \ | |
64 | (((u32)(len) << 16) | ((u32)(offs) & 0xffff)) | |
65 | #define get_loc_len(dl) ((u32)(dl) >> 16) | |
66 | #define get_loc_offs(dl) ((u32)(dl) & 0xffff) | |
8ab83f56 | 67 | |
3da0f180 | 68 | static nokprobe_inline void *get_loc_data(u32 *dl, void *ent) |
b26c74e1 | 69 | { |
9178412d | 70 | return (u8 *)ent + get_loc_offs(*dl); |
b26c74e1 NK |
71 | } |
72 | ||
40b53b77 MH |
73 | static nokprobe_inline u32 update_data_loc(u32 loc, int consumed) |
74 | { | |
75 | u32 maxlen = get_loc_len(loc); | |
76 | u32 offset = get_loc_offs(loc); | |
77 | ||
78 | return make_data_loc(maxlen - consumed, offset + consumed); | |
79 | } | |
80 | ||
8ab83f56 | 81 | /* Printing function type */ |
56de7630 | 82 | typedef int (*print_type_func_t)(struct trace_seq *, void *, void *); |
8ab83f56 | 83 | |
53305928 MH |
84 | enum fetch_op { |
85 | FETCH_OP_NOP = 0, | |
86 | // Stage 1 (load) ops | |
87 | FETCH_OP_REG, /* Register : .param = offset */ | |
88 | FETCH_OP_STACK, /* Stack : .param = index */ | |
89 | FETCH_OP_STACKP, /* Stack pointer */ | |
90 | FETCH_OP_RETVAL, /* Return value */ | |
91 | FETCH_OP_IMM, /* Immediate : .immediate */ | |
92 | FETCH_OP_COMM, /* Current comm */ | |
a1303af5 | 93 | FETCH_OP_ARG, /* Function argument : .param */ |
53305928 | 94 | FETCH_OP_FOFFS, /* File offset: .immediate */ |
a42e3c4d | 95 | FETCH_OP_DATA, /* Allocated data: .data */ |
25f00e40 | 96 | FETCH_OP_EDATA, /* Entry data: .offset */ |
53305928 MH |
97 | // Stage 2 (dereference) op |
98 | FETCH_OP_DEREF, /* Dereference: .offset */ | |
e65f7ae7 | 99 | FETCH_OP_UDEREF, /* User-space Dereference: .offset */ |
53305928 MH |
100 | // Stage 3 (store) ops |
101 | FETCH_OP_ST_RAW, /* Raw: .size */ | |
102 | FETCH_OP_ST_MEM, /* Mem: .offset, .size */ | |
e65f7ae7 | 103 | FETCH_OP_ST_UMEM, /* Mem: .offset, .size */ |
53305928 | 104 | FETCH_OP_ST_STRING, /* String: .offset, .size */ |
88903c46 | 105 | FETCH_OP_ST_USTRING, /* User String: .offset, .size */ |
b26a124c | 106 | FETCH_OP_ST_SYMSTR, /* Kernel Symbol String: .offset, .size */ |
25f00e40 | 107 | FETCH_OP_ST_EDATA, /* Store Entry Data: .offset */ |
53305928 MH |
108 | // Stage 4 (modify) op |
109 | FETCH_OP_MOD_BF, /* Bitfield: .basesize, .lshift, .rshift */ | |
40b53b77 MH |
110 | // Stage 5 (loop) op |
111 | FETCH_OP_LP_ARRAY, /* Array: .param = loop count */ | |
7491e2c4 | 112 | FETCH_OP_TP_ARG, /* Trace Point argument */ |
53305928 | 113 | FETCH_OP_END, |
a6682814 | 114 | FETCH_NOP_SYMBOL, /* Unresolved Symbol holder */ |
8ab83f56 SD |
115 | }; |
116 | ||
53305928 MH |
117 | struct fetch_insn { |
118 | enum fetch_op op; | |
119 | union { | |
120 | unsigned int param; | |
121 | struct { | |
122 | unsigned int size; | |
123 | int offset; | |
124 | }; | |
125 | struct { | |
126 | unsigned char basesize; | |
127 | unsigned char lshift; | |
128 | unsigned char rshift; | |
129 | }; | |
130 | unsigned long immediate; | |
a6682814 | 131 | void *data; |
53305928 MH |
132 | }; |
133 | }; | |
134 | ||
135 | /* fetch + deref*N + store + mod + end <= 16, this allows N=12, enough */ | |
136 | #define FETCH_INSN_MAX 16 | |
4dd537ac | 137 | #define FETCH_TOKEN_COMM (-ECOMM) |
53305928 | 138 | |
8ab83f56 SD |
139 | /* Fetch type information table */ |
140 | struct fetch_type { | |
141 | const char *name; /* Name of type */ | |
142 | size_t size; /* Byte size of type */ | |
b26a124c MHG |
143 | bool is_signed; /* Signed flag */ |
144 | bool is_string; /* String flag */ | |
8ab83f56 | 145 | print_type_func_t print; /* Print functions */ |
f2cc020d | 146 | const char *fmt; /* Format string */ |
8ab83f56 | 147 | const char *fmttype; /* Name in format file */ |
8ab83f56 SD |
148 | }; |
149 | ||
34fee3a1 NK |
150 | /* For defining macros, define string/string_size types */ |
151 | typedef u32 string; | |
152 | typedef u32 string_size; | |
153 | ||
b26c74e1 NK |
154 | #define PRINT_TYPE_FUNC_NAME(type) print_type_##type |
155 | #define PRINT_TYPE_FMT_NAME(type) print_type_format_##type | |
156 | ||
157 | /* Printing in basic type function template */ | |
158 | #define DECLARE_BASIC_PRINT_TYPE_FUNC(type) \ | |
56de7630 | 159 | int PRINT_TYPE_FUNC_NAME(type)(struct trace_seq *s, void *data, void *ent);\ |
b26c74e1 NK |
160 | extern const char PRINT_TYPE_FMT_NAME(type)[] |
161 | ||
162 | DECLARE_BASIC_PRINT_TYPE_FUNC(u8); | |
163 | DECLARE_BASIC_PRINT_TYPE_FUNC(u16); | |
164 | DECLARE_BASIC_PRINT_TYPE_FUNC(u32); | |
165 | DECLARE_BASIC_PRINT_TYPE_FUNC(u64); | |
166 | DECLARE_BASIC_PRINT_TYPE_FUNC(s8); | |
167 | DECLARE_BASIC_PRINT_TYPE_FUNC(s16); | |
168 | DECLARE_BASIC_PRINT_TYPE_FUNC(s32); | |
169 | DECLARE_BASIC_PRINT_TYPE_FUNC(s64); | |
17ce3dc7 MH |
170 | DECLARE_BASIC_PRINT_TYPE_FUNC(x8); |
171 | DECLARE_BASIC_PRINT_TYPE_FUNC(x16); | |
172 | DECLARE_BASIC_PRINT_TYPE_FUNC(x32); | |
173 | DECLARE_BASIC_PRINT_TYPE_FUNC(x64); | |
174 | ||
8478cca1 | 175 | DECLARE_BASIC_PRINT_TYPE_FUNC(char); |
b26c74e1 | 176 | DECLARE_BASIC_PRINT_TYPE_FUNC(string); |
60c2e0ce | 177 | DECLARE_BASIC_PRINT_TYPE_FUNC(symbol); |
b26c74e1 NK |
178 | |
179 | /* Default (unsigned long) fetch type */ | |
bdca79c2 | 180 | #define __DEFAULT_FETCH_TYPE(t) x##t |
b26c74e1 NK |
181 | #define _DEFAULT_FETCH_TYPE(t) __DEFAULT_FETCH_TYPE(t) |
182 | #define DEFAULT_FETCH_TYPE _DEFAULT_FETCH_TYPE(BITS_PER_LONG) | |
183 | #define DEFAULT_FETCH_TYPE_STR __stringify(DEFAULT_FETCH_TYPE) | |
184 | ||
60c2e0ce MH |
185 | #define __ADDR_FETCH_TYPE(t) u##t |
186 | #define _ADDR_FETCH_TYPE(t) __ADDR_FETCH_TYPE(t) | |
187 | #define ADDR_FETCH_TYPE _ADDR_FETCH_TYPE(BITS_PER_LONG) | |
188 | ||
b26a124c MHG |
189 | #define __ASSIGN_FETCH_TYPE(_name, ptype, ftype, _size, sign, str, _fmttype) \ |
190 | {.name = _name, \ | |
b26c74e1 | 191 | .size = _size, \ |
b26a124c MHG |
192 | .is_signed = (bool)sign, \ |
193 | .is_string = (bool)str, \ | |
b26c74e1 NK |
194 | .print = PRINT_TYPE_FUNC_NAME(ptype), \ |
195 | .fmt = PRINT_TYPE_FMT_NAME(ptype), \ | |
196 | .fmttype = _fmttype, \ | |
b26c74e1 | 197 | } |
b26a124c MHG |
198 | |
199 | /* Non string types can use these macros */ | |
60c2e0ce | 200 | #define _ASSIGN_FETCH_TYPE(_name, ptype, ftype, _size, sign, _fmttype) \ |
b26a124c | 201 | __ASSIGN_FETCH_TYPE(_name, ptype, ftype, _size, sign, 0, #_fmttype) |
b26c74e1 | 202 | #define ASSIGN_FETCH_TYPE(ptype, ftype, sign) \ |
60c2e0ce | 203 | _ASSIGN_FETCH_TYPE(#ptype, ptype, ftype, sizeof(ftype), sign, ptype) |
b26c74e1 | 204 | |
17ce3dc7 MH |
205 | /* If ptype is an alias of atype, use this macro (show atype in format) */ |
206 | #define ASSIGN_FETCH_TYPE_ALIAS(ptype, atype, ftype, sign) \ | |
60c2e0ce | 207 | _ASSIGN_FETCH_TYPE(#ptype, ptype, ftype, sizeof(ftype), sign, atype) |
17ce3dc7 | 208 | |
34fee3a1 | 209 | #define ASSIGN_FETCH_TYPE_END {} |
40b53b77 | 210 | #define MAX_ARRAY_LEN 64 |
34fee3a1 | 211 | |
6b0b7551 | 212 | #ifdef CONFIG_KPROBE_EVENTS |
b4da3340 MH |
213 | bool trace_kprobe_on_func_entry(struct trace_event_call *call); |
214 | bool trace_kprobe_error_injectable(struct trace_event_call *call); | |
1301a44e | 215 | #else |
b4da3340 | 216 | static inline bool trace_kprobe_on_func_entry(struct trace_event_call *call) |
9802d865 | 217 | { |
b4da3340 | 218 | return false; |
9802d865 JB |
219 | } |
220 | ||
b4da3340 | 221 | static inline bool trace_kprobe_error_injectable(struct trace_event_call *call) |
9802d865 | 222 | { |
b4da3340 | 223 | return false; |
9802d865 | 224 | } |
6b0b7551 | 225 | #endif /* CONFIG_KPROBE_EVENTS */ |
1301a44e | 226 | |
8ab83f56 | 227 | struct probe_arg { |
53305928 MH |
228 | struct fetch_insn *code; |
229 | bool dynamic;/* Dynamic array (string) is used */ | |
8ab83f56 | 230 | unsigned int offset; /* Offset from argument entry */ |
40b53b77 | 231 | unsigned int count; /* Array count */ |
8ab83f56 SD |
232 | const char *name; /* Name of this argument */ |
233 | const char *comm; /* Command of this argument */ | |
40b53b77 | 234 | char *fmt; /* Format string if needed */ |
8ab83f56 SD |
235 | const struct fetch_type *type; /* Type of this argument */ |
236 | }; | |
237 | ||
25f00e40 MHG |
238 | struct probe_entry_arg { |
239 | struct fetch_insn *code; | |
240 | unsigned int size; /* The entry data size */ | |
241 | }; | |
242 | ||
b61387cb MH |
243 | struct trace_uprobe_filter { |
244 | rwlock_t rwlock; | |
245 | int nr_systemwide; | |
246 | struct list_head perf_events; | |
247 | }; | |
248 | ||
60d53e2c MH |
249 | /* Event call and class holder */ |
250 | struct trace_probe_event { | |
c31ffb3f | 251 | unsigned int flags; /* For TP_FLAG_* */ |
2425bcb9 SRRH |
252 | struct trace_event_class class; |
253 | struct trace_event_call call; | |
c31ffb3f | 254 | struct list_head files; |
60d53e2c | 255 | struct list_head probes; |
7fac96f2 | 256 | struct trace_uprobe_filter filter[]; |
60d53e2c MH |
257 | }; |
258 | ||
259 | struct trace_probe { | |
260 | struct list_head list; | |
261 | struct trace_probe_event *event; | |
c31ffb3f NK |
262 | ssize_t size; /* trace entry size */ |
263 | unsigned int nr_args; | |
25f00e40 | 264 | struct probe_entry_arg *entry_arg; /* This is only for return probe */ |
c31ffb3f NK |
265 | struct probe_arg args[]; |
266 | }; | |
267 | ||
70ed91c6 | 268 | struct event_file_link { |
7f1d2f82 | 269 | struct trace_event_file *file; |
70ed91c6 J |
270 | struct list_head list; |
271 | }; | |
272 | ||
747774d6 MH |
273 | static inline bool trace_probe_test_flag(struct trace_probe *tp, |
274 | unsigned int flag) | |
275 | { | |
60d53e2c | 276 | return !!(tp->event->flags & flag); |
747774d6 MH |
277 | } |
278 | ||
279 | static inline void trace_probe_set_flag(struct trace_probe *tp, | |
280 | unsigned int flag) | |
281 | { | |
60d53e2c | 282 | tp->event->flags |= flag; |
747774d6 MH |
283 | } |
284 | ||
285 | static inline void trace_probe_clear_flag(struct trace_probe *tp, | |
286 | unsigned int flag) | |
287 | { | |
60d53e2c | 288 | tp->event->flags &= ~flag; |
747774d6 MH |
289 | } |
290 | ||
c31ffb3f NK |
291 | static inline bool trace_probe_is_enabled(struct trace_probe *tp) |
292 | { | |
747774d6 | 293 | return trace_probe_test_flag(tp, TP_FLAG_TRACE | TP_FLAG_PROFILE); |
c31ffb3f NK |
294 | } |
295 | ||
b55ce203 MH |
296 | static inline const char *trace_probe_name(struct trace_probe *tp) |
297 | { | |
60d53e2c | 298 | return trace_event_name(&tp->event->call); |
b55ce203 MH |
299 | } |
300 | ||
301 | static inline const char *trace_probe_group_name(struct trace_probe *tp) | |
302 | { | |
60d53e2c | 303 | return tp->event->call.class->system; |
b55ce203 MH |
304 | } |
305 | ||
e3dc9f89 MH |
306 | static inline struct trace_event_call * |
307 | trace_probe_event_call(struct trace_probe *tp) | |
308 | { | |
60d53e2c MH |
309 | return &tp->event->call; |
310 | } | |
311 | ||
312 | static inline struct trace_probe_event * | |
313 | trace_probe_event_from_call(struct trace_event_call *event_call) | |
314 | { | |
315 | return container_of(event_call, struct trace_probe_event, call); | |
316 | } | |
317 | ||
318 | static inline struct trace_probe * | |
319 | trace_probe_primary_from_call(struct trace_event_call *call) | |
320 | { | |
321 | struct trace_probe_event *tpe = trace_probe_event_from_call(call); | |
322 | ||
81d0fa4c | 323 | return list_first_entry_or_null(&tpe->probes, struct trace_probe, list); |
60d53e2c MH |
324 | } |
325 | ||
326 | static inline struct list_head *trace_probe_probe_list(struct trace_probe *tp) | |
327 | { | |
328 | return &tp->event->probes; | |
e3dc9f89 MH |
329 | } |
330 | ||
ca89bc07 MH |
331 | static inline bool trace_probe_has_sibling(struct trace_probe *tp) |
332 | { | |
333 | struct list_head *list = trace_probe_probe_list(tp); | |
334 | ||
335 | return !list_empty(list) && !list_is_singular(list); | |
336 | } | |
337 | ||
46e5376d MH |
338 | static inline int trace_probe_unregister_event_call(struct trace_probe *tp) |
339 | { | |
340 | /* tp->event is unregistered in trace_remove_event_call() */ | |
60d53e2c | 341 | return trace_remove_event_call(&tp->event->call); |
46e5376d | 342 | } |
455b2899 | 343 | |
b5f935ee MH |
344 | static inline bool trace_probe_has_single_file(struct trace_probe *tp) |
345 | { | |
60d53e2c | 346 | return !!list_is_singular(&tp->event->files); |
b5f935ee MH |
347 | } |
348 | ||
349 | int trace_probe_init(struct trace_probe *tp, const char *event, | |
035ba760 | 350 | const char *group, bool alloc_filter, int nargs); |
b5f935ee | 351 | void trace_probe_cleanup(struct trace_probe *tp); |
ca89bc07 MH |
352 | int trace_probe_append(struct trace_probe *tp, struct trace_probe *to); |
353 | void trace_probe_unlink(struct trace_probe *tp); | |
b5f935ee MH |
354 | int trace_probe_register_event_call(struct trace_probe *tp); |
355 | int trace_probe_add_file(struct trace_probe *tp, struct trace_event_file *file); | |
356 | int trace_probe_remove_file(struct trace_probe *tp, | |
357 | struct trace_event_file *file); | |
358 | struct event_file_link *trace_probe_get_file_link(struct trace_probe *tp, | |
359 | struct trace_event_file *file); | |
ca89bc07 | 360 | int trace_probe_compare_arg_type(struct trace_probe *a, struct trace_probe *b); |
eb5bf813 MH |
361 | bool trace_probe_match_command_args(struct trace_probe *tp, |
362 | int argc, const char **argv); | |
d262271d | 363 | int trace_probe_create(const char *raw_command, int (*createfn)(int, const char **)); |
196b6389 SC |
364 | int trace_probe_print_args(struct trace_seq *s, struct probe_arg *args, int nr_args, |
365 | u8 *data, void *field); | |
b5f935ee | 366 | |
25f00e40 MHG |
367 | #ifdef CONFIG_HAVE_FUNCTION_ARG_ACCESS_API |
368 | int traceprobe_get_entry_data_size(struct trace_probe *tp); | |
369 | /* This is a runtime function to store entry data */ | |
370 | void store_trace_entry_data(void *edata, struct trace_probe *tp, struct pt_regs *regs); | |
371 | #else /* !CONFIG_HAVE_FUNCTION_ARG_ACCESS_API */ | |
372 | static inline int traceprobe_get_entry_data_size(struct trace_probe *tp) | |
373 | { | |
374 | return 0; | |
375 | } | |
376 | #define store_trace_entry_data(edata, tp, regs) do { } while (0) | |
377 | #endif | |
378 | ||
b5f935ee | 379 | #define trace_probe_for_each_link(pos, tp) \ |
60d53e2c | 380 | list_for_each_entry(pos, &(tp)->event->files, list) |
b5f935ee | 381 | #define trace_probe_for_each_link_rcu(pos, tp) \ |
60d53e2c | 382 | list_for_each_entry_rcu(pos, &(tp)->event->files, list) |
b5f935ee | 383 | |
30460c21 MHG |
384 | /* |
385 | * The flags used for parsing trace_probe arguments. | |
e2d0d7b2 | 386 | * TPARG_FL_RETURN, TPARG_FL_FENTRY and TPARG_FL_TEVENT are mutually exclusive. |
30460c21 | 387 | * TPARG_FL_KERNEL and TPARG_FL_USER are also mutually exclusive. |
e2d0d7b2 MHG |
388 | * TPARG_FL_FPROBE and TPARG_FL_TPOINT are optional but it should be with |
389 | * TPARG_FL_KERNEL. | |
30460c21 | 390 | */ |
a1303af5 MH |
391 | #define TPARG_FL_RETURN BIT(0) |
392 | #define TPARG_FL_KERNEL BIT(1) | |
393 | #define TPARG_FL_FENTRY BIT(2) | |
e2d0d7b2 | 394 | #define TPARG_FL_TEVENT BIT(3) |
d4505aa6 | 395 | #define TPARG_FL_USER BIT(4) |
334e5519 | 396 | #define TPARG_FL_FPROBE BIT(5) |
e2d0d7b2 MHG |
397 | #define TPARG_FL_TPOINT BIT(6) |
398 | #define TPARG_FL_LOC_MASK GENMASK(4, 0) | |
399 | ||
400 | static inline bool tparg_is_function_entry(unsigned int flags) | |
401 | { | |
402 | return (flags & TPARG_FL_LOC_MASK) == (TPARG_FL_KERNEL | TPARG_FL_FENTRY); | |
403 | } | |
a1303af5 | 404 | |
25f00e40 MHG |
405 | static inline bool tparg_is_function_return(unsigned int flags) |
406 | { | |
407 | return (flags & TPARG_FL_LOC_MASK) == (TPARG_FL_KERNEL | TPARG_FL_RETURN); | |
408 | } | |
409 | ||
1b8b0cd7 MHG |
410 | struct traceprobe_parse_context { |
411 | struct trace_event_call *event; | |
b1d1e904 MHG |
412 | /* BTF related parameters */ |
413 | const char *funcname; /* Function name in BTF */ | |
d157d769 | 414 | const struct btf_type *proto; /* Prototype of the function */ |
b1d1e904 MHG |
415 | const struct btf_param *params; /* Parameter of the function */ |
416 | s32 nr_params; /* The number of the parameters */ | |
417 | struct btf *btf; /* The BTF to be used */ | |
c440adfb MHG |
418 | const struct btf_type *last_type; /* Saved type */ |
419 | u32 last_bitoffs; /* Saved bitoffs */ | |
420 | u32 last_bitsize; /* Saved bitsize */ | |
25f00e40 | 421 | struct trace_probe *tp; |
1b8b0cd7 MHG |
422 | unsigned int flags; |
423 | int offset; | |
424 | }; | |
425 | ||
d00bbea9 | 426 | extern int traceprobe_parse_probe_arg(struct trace_probe *tp, int i, |
1b8b0cd7 MHG |
427 | const char *argv, |
428 | struct traceprobe_parse_context *ctx); | |
18b1e870 MHG |
429 | const char **traceprobe_expand_meta_args(int argc, const char *argv[], |
430 | int *new_argc, char *buf, int bufsize, | |
431 | struct traceprobe_parse_context *ctx); | |
d9b15224 | 432 | extern int traceprobe_expand_dentry_args(int argc, const char *argv[], char **buf); |
8ab83f56 | 433 | |
a6682814 | 434 | extern int traceprobe_update_arg(struct probe_arg *arg); |
8ab83f56 SD |
435 | extern void traceprobe_free_probe_arg(struct probe_arg *arg); |
436 | ||
b1d1e904 MHG |
437 | /* |
438 | * If either traceprobe_parse_probe_arg() or traceprobe_expand_meta_args() is called, | |
439 | * this MUST be called for clean up the context and return a resource. | |
440 | */ | |
441 | void traceprobe_finish_parse(struct traceprobe_parse_context *ctx); | |
442 | ||
c5d343b6 | 443 | extern int traceprobe_split_symbol_offset(char *symbol, long *offset); |
ab105a4f MH |
444 | int traceprobe_parse_event_name(const char **pevent, const char **pgroup, |
445 | char *buf, int offset); | |
8ab83f56 | 446 | |
007517a0 SRV |
447 | enum probe_print_type { |
448 | PROBE_PRINT_NORMAL, | |
449 | PROBE_PRINT_RETURN, | |
7491e2c4 | 450 | PROBE_PRINT_EVENT, |
007517a0 SRV |
451 | }; |
452 | ||
453 | extern int traceprobe_set_print_fmt(struct trace_probe *tp, enum probe_print_type ptype); | |
e12f03d7 SL |
454 | |
455 | #ifdef CONFIG_PERF_EVENTS | |
456 | extern struct trace_event_call * | |
457 | create_local_trace_kprobe(char *func, void *addr, unsigned long offs, | |
458 | bool is_return); | |
459 | extern void destroy_local_trace_kprobe(struct trace_event_call *event_call); | |
33ea4b24 SL |
460 | |
461 | extern struct trace_event_call * | |
a6ca88b2 SL |
462 | create_local_trace_uprobe(char *name, unsigned long offs, |
463 | unsigned long ref_ctr_offset, bool is_return); | |
33ea4b24 | 464 | extern void destroy_local_trace_uprobe(struct trace_event_call *event_call); |
e12f03d7 | 465 | #endif |
eeb07b06 MH |
466 | extern int traceprobe_define_arg_fields(struct trace_event_call *event_call, |
467 | size_t offset, struct trace_probe *tp); | |
ab105a4f MH |
468 | |
469 | #undef ERRORS | |
470 | #define ERRORS \ | |
471 | C(FILE_NOT_FOUND, "Failed to find the given file"), \ | |
472 | C(NO_REGULAR_FILE, "Not a regular file"), \ | |
473 | C(BAD_REFCNT, "Invalid reference counter offset"), \ | |
474 | C(REFCNT_OPEN_BRACE, "Reference counter brace is not closed"), \ | |
475 | C(BAD_REFCNT_SUFFIX, "Reference counter has wrong suffix"), \ | |
476 | C(BAD_UPROBE_OFFS, "Invalid uprobe offset"), \ | |
334e5519 | 477 | C(BAD_MAXACT_TYPE, "Maxactive is only for function exit"), \ |
ab105a4f MH |
478 | C(BAD_MAXACT, "Invalid maxactive number"), \ |
479 | C(MAXACT_TOO_BIG, "Maxactive is too big"), \ | |
480 | C(BAD_PROBE_ADDR, "Invalid probed address or symbol"), \ | |
b022f0c7 | 481 | C(NON_UNIQ_SYMBOL, "The symbol is not unique"), \ |
ab105a4f | 482 | C(BAD_RETPROBE, "Retprobe address must be an function entry"), \ |
e2d0d7b2 | 483 | C(NO_TRACEPOINT, "Tracepoint is not found"), \ |
4725cd89 | 484 | C(BAD_ADDR_SUFFIX, "Invalid probed address suffix"), \ |
ab105a4f MH |
485 | C(NO_GROUP_NAME, "Group name is not specified"), \ |
486 | C(GROUP_TOO_LONG, "Group name is too long"), \ | |
487 | C(BAD_GROUP_NAME, "Group name must follow the same rules as C identifiers"), \ | |
488 | C(NO_EVENT_NAME, "Event name is not specified"), \ | |
489 | C(EVENT_TOO_LONG, "Event name is too long"), \ | |
490 | C(BAD_EVENT_NAME, "Event name must follow the same rules as C identifiers"), \ | |
8e242060 | 491 | C(EVENT_EXIST, "Given group/event name is already used by another event"), \ |
ab105a4f | 492 | C(RETVAL_ON_PROBE, "$retval is not available on probe"), \ |
fd26290e | 493 | C(NO_RETVAL, "This function returns 'void' type"), \ |
ab105a4f MH |
494 | C(BAD_STACK_NUM, "Invalid stack number"), \ |
495 | C(BAD_ARG_NUM, "Invalid argument number"), \ | |
496 | C(BAD_VAR, "Invalid $-valiable specified"), \ | |
497 | C(BAD_REG_NAME, "Invalid register name"), \ | |
498 | C(BAD_MEM_ADDR, "Invalid memory address"), \ | |
6218bf9f | 499 | C(BAD_IMM, "Invalid immediate value"), \ |
a42e3c4d | 500 | C(IMMSTR_NO_CLOSE, "String is not closed with '\"'"), \ |
ab105a4f MH |
501 | C(FILE_ON_KPROBE, "File offset is not available with kprobe"), \ |
502 | C(BAD_FILE_OFFS, "Invalid file offset value"), \ | |
503 | C(SYM_ON_UPROBE, "Symbol is not available with uprobe"), \ | |
504 | C(TOO_MANY_OPS, "Dereference is too much nested"), \ | |
505 | C(DEREF_NEED_BRACE, "Dereference needs a brace"), \ | |
506 | C(BAD_DEREF_OFFS, "Invalid dereference offset"), \ | |
507 | C(DEREF_OPEN_BRACE, "Dereference brace is not closed"), \ | |
508 | C(COMM_CANT_DEREF, "$comm can not be dereferenced"), \ | |
509 | C(BAD_FETCH_ARG, "Invalid fetch argument"), \ | |
510 | C(ARRAY_NO_CLOSE, "Array is not closed"), \ | |
511 | C(BAD_ARRAY_SUFFIX, "Array has wrong suffix"), \ | |
512 | C(BAD_ARRAY_NUM, "Invalid array size"), \ | |
513 | C(ARRAY_TOO_BIG, "Array number is too big"), \ | |
514 | C(BAD_TYPE, "Unknown type is specified"), \ | |
515 | C(BAD_STRING, "String accepts only memory argument"), \ | |
b26a124c | 516 | C(BAD_SYMSTRING, "Symbol String doesn't accept data/userdata"), \ |
ab105a4f MH |
517 | C(BAD_BITFIELD, "Invalid bitfield"), \ |
518 | C(ARG_NAME_TOO_LONG, "Argument name is too long"), \ | |
519 | C(NO_ARG_NAME, "Argument name is not specified"), \ | |
520 | C(BAD_ARG_NAME, "Argument name must follow the same rules as C identifiers"), \ | |
521 | C(USED_ARG_NAME, "This argument name is already used"), \ | |
522 | C(ARG_TOO_LONG, "Argument expression is too long"), \ | |
523 | C(NO_ARG_BODY, "No argument expression"), \ | |
524 | C(BAD_INSN_BNDRY, "Probe point is not an instruction boundary"),\ | |
ca89bc07 MH |
525 | C(FAIL_REG_PROBE, "Failed to register probe event"),\ |
526 | C(DIFF_PROBE_TYPE, "Probe type is different from existing probe"),\ | |
fe60b0ce | 527 | C(DIFF_ARG_TYPE, "Argument type or name is different from existing probe"),\ |
2f63e5d2 MHG |
528 | C(SAME_PROBE, "There is already the exact same probe event"),\ |
529 | C(NO_EVENT_INFO, "This requires both group and event name to attach"),\ | |
530 | C(BAD_ATTACH_EVENT, "Attached event does not exist"),\ | |
752be5c5 | 531 | C(BAD_ATTACH_ARG, "Attached event does not have this field"),\ |
b576e097 MHG |
532 | C(NO_EP_FILTER, "No filter rule after 'if'"), \ |
533 | C(NOSUP_BTFARG, "BTF is not available or not supported"), \ | |
534 | C(NO_BTFARG, "This variable is not found at this probe point"),\ | |
18b1e870 MHG |
535 | C(NO_BTF_ENTRY, "No BTF entry for this probe point"), \ |
536 | C(BAD_VAR_ARGS, "$arg* must be an independent parameter without name etc."),\ | |
25f00e40 | 537 | C(NOFENTRY_ARGS, "$arg* can be used only on function entry or exit"), \ |
18b1e870 | 538 | C(DOUBLE_ARGS, "$arg* can be used only once in the parameters"), \ |
c440adfb MHG |
539 | C(ARGS_2LONG, "$arg* failed because the argument list is too long"), \ |
540 | C(ARGIDX_2BIG, "$argN index is too big"), \ | |
541 | C(NO_PTR_STRCT, "This is not a pointer to union/structure."), \ | |
542 | C(NOSUP_DAT_ARG, "Non pointer structure/union argument is not supported."),\ | |
543 | C(BAD_HYPHEN, "Failed to parse single hyphen. Forgot '>'?"), \ | |
544 | C(NO_BTF_FIELD, "This field is not found."), \ | |
27973e5c | 545 | C(BAD_BTF_TID, "Failed to get BTF type info."),\ |
8c427cc2 MHG |
546 | C(BAD_TYPE4STR, "This type does not fit for string."),\ |
547 | C(NEED_STRING_TYPE, "$comm and immediate-string only accepts string type"), | |
ab105a4f MH |
548 | |
549 | #undef C | |
550 | #define C(a, b) TP_ERR_##a | |
551 | ||
552 | /* Define TP_ERR_ */ | |
553 | enum { ERRORS }; | |
554 | ||
555 | /* Error text is defined in trace_probe.c */ | |
556 | ||
557 | struct trace_probe_log { | |
558 | const char *subsystem; | |
559 | const char **argv; | |
560 | int argc; | |
561 | int index; | |
562 | }; | |
563 | ||
564 | void trace_probe_log_init(const char *subsystem, int argc, const char **argv); | |
565 | void trace_probe_log_set_index(int index); | |
566 | void trace_probe_log_clear(void); | |
567 | void __trace_probe_log_err(int offset, int err); | |
568 | ||
569 | #define trace_probe_log_err(offs, err) \ | |
570 | __trace_probe_log_err(offs, TP_ERR_##err) | |
a3c485a5 JO |
571 | |
572 | struct uprobe_dispatch_data { | |
573 | struct trace_uprobe *tu; | |
574 | unsigned long bp_addr; | |
575 | }; |