1bcea3f96SSteven Rostedt (VMware) // SPDX-License-Identifier: GPL-2.0
28ab83f56SSrikar Dronamraju /*
38ab83f56SSrikar Dronamraju * Common header file for probe-based Dynamic events.
48ab83f56SSrikar Dronamraju *
58ab83f56SSrikar Dronamraju * This code was copied from kernel/trace/trace_kprobe.h written by
68ab83f56SSrikar Dronamraju * Masami Hiramatsu <masami.hiramatsu.pt@hitachi.com>
78ab83f56SSrikar Dronamraju *
88ab83f56SSrikar Dronamraju * Updates to make this generic:
98ab83f56SSrikar Dronamraju * Copyright (C) IBM Corporation, 2010-2011
108ab83f56SSrikar Dronamraju * Author: Srikar Dronamraju
118ab83f56SSrikar Dronamraju */
128ab83f56SSrikar Dronamraju
138ab83f56SSrikar Dronamraju #include <linux/seq_file.h>
148ab83f56SSrikar Dronamraju #include <linux/slab.h>
158ab83f56SSrikar Dronamraju #include <linux/smp.h>
168434dc93SSteven Rostedt (Red Hat) #include <linux/tracefs.h>
178ab83f56SSrikar Dronamraju #include <linux/types.h>
188ab83f56SSrikar Dronamraju #include <linux/string.h>
198ab83f56SSrikar Dronamraju #include <linux/ptrace.h>
208ab83f56SSrikar Dronamraju #include <linux/perf_event.h>
218ab83f56SSrikar Dronamraju #include <linux/kprobes.h>
228ab83f56SSrikar Dronamraju #include <linux/stringify.h>
238ab83f56SSrikar Dronamraju #include <linux/limits.h>
248ab83f56SSrikar Dronamraju #include <linux/uaccess.h>
25a1303af5SMasami Hiramatsu #include <linux/bitops.h>
26b576e097SMasami Hiramatsu (Google) #include <linux/btf.h>
278ab83f56SSrikar Dronamraju #include <asm/bitsperlong.h>
288ab83f56SSrikar Dronamraju
298ab83f56SSrikar Dronamraju #include "trace.h"
308ab83f56SSrikar Dronamraju #include "trace_output.h"
318ab83f56SSrikar Dronamraju
328ab83f56SSrikar Dronamraju #define MAX_TRACE_ARGS 128
338ab83f56SSrikar Dronamraju #define MAX_ARGSTR_LEN 63
3440b53b77SMasami Hiramatsu #define MAX_ARRAY_LEN 64
35b4443c17SMasami Hiramatsu #define MAX_ARG_NAME_LEN 32
3618b1e870SMasami Hiramatsu (Google) #define MAX_BTF_ARGS_LEN 128
378ab83f56SSrikar Dronamraju #define MAX_STRING_SIZE PATH_MAX
3818b1e870SMasami Hiramatsu (Google) #define MAX_ARG_BUF_LEN (MAX_TRACE_ARGS * MAX_ARG_NAME_LEN)
398ab83f56SSrikar Dronamraju
408ab83f56SSrikar Dronamraju /* Reserved field names */
418ab83f56SSrikar Dronamraju #define FIELD_STRING_IP "__probe_ip"
428ab83f56SSrikar Dronamraju #define FIELD_STRING_RETIP "__probe_ret_ip"
438ab83f56SSrikar Dronamraju #define FIELD_STRING_FUNC "__probe_func"
448ab83f56SSrikar Dronamraju
458ab83f56SSrikar Dronamraju #undef DEFINE_FIELD
468ab83f56SSrikar Dronamraju #define DEFINE_FIELD(type, item, name, is_signed) \
478ab83f56SSrikar Dronamraju do { \
488ab83f56SSrikar Dronamraju ret = trace_define_field(event_call, #type, name, \
498ab83f56SSrikar Dronamraju offsetof(typeof(field), item), \
508ab83f56SSrikar Dronamraju sizeof(field.item), is_signed, \
518ab83f56SSrikar Dronamraju FILTER_OTHER); \
528ab83f56SSrikar Dronamraju if (ret) \
538ab83f56SSrikar Dronamraju return ret; \
548ab83f56SSrikar Dronamraju } while (0)
558ab83f56SSrikar Dronamraju
568ab83f56SSrikar Dronamraju
578ab83f56SSrikar Dronamraju /* Flags for trace_probe */
588ab83f56SSrikar Dronamraju #define TP_FLAG_TRACE 1
598ab83f56SSrikar Dronamraju #define TP_FLAG_PROFILE 2
608ab83f56SSrikar Dronamraju
619178412dSMasami Hiramatsu /* data_loc: data location, compatible with u32 */
629178412dSMasami Hiramatsu #define make_data_loc(len, offs) \
639178412dSMasami Hiramatsu (((u32)(len) << 16) | ((u32)(offs) & 0xffff))
649178412dSMasami Hiramatsu #define get_loc_len(dl) ((u32)(dl) >> 16)
659178412dSMasami Hiramatsu #define get_loc_offs(dl) ((u32)(dl) & 0xffff)
668ab83f56SSrikar Dronamraju
get_loc_data(u32 * dl,void * ent)673da0f180SMasami Hiramatsu static nokprobe_inline void *get_loc_data(u32 *dl, void *ent)
68b26c74e1SNamhyung Kim {
699178412dSMasami Hiramatsu return (u8 *)ent + get_loc_offs(*dl);
70b26c74e1SNamhyung Kim }
71b26c74e1SNamhyung Kim
update_data_loc(u32 loc,int consumed)7240b53b77SMasami Hiramatsu static nokprobe_inline u32 update_data_loc(u32 loc, int consumed)
7340b53b77SMasami Hiramatsu {
7440b53b77SMasami Hiramatsu u32 maxlen = get_loc_len(loc);
7540b53b77SMasami Hiramatsu u32 offset = get_loc_offs(loc);
7640b53b77SMasami Hiramatsu
7740b53b77SMasami Hiramatsu return make_data_loc(maxlen - consumed, offset + consumed);
7840b53b77SMasami Hiramatsu }
7940b53b77SMasami Hiramatsu
808ab83f56SSrikar Dronamraju /* Printing function type */
8156de7630SMasami Hiramatsu typedef int (*print_type_func_t)(struct trace_seq *, void *, void *);
828ab83f56SSrikar Dronamraju
8353305928SMasami Hiramatsu enum fetch_op {
8453305928SMasami Hiramatsu FETCH_OP_NOP = 0,
8553305928SMasami Hiramatsu // Stage 1 (load) ops
8653305928SMasami Hiramatsu FETCH_OP_REG, /* Register : .param = offset */
8753305928SMasami Hiramatsu FETCH_OP_STACK, /* Stack : .param = index */
8853305928SMasami Hiramatsu FETCH_OP_STACKP, /* Stack pointer */
8953305928SMasami Hiramatsu FETCH_OP_RETVAL, /* Return value */
9053305928SMasami Hiramatsu FETCH_OP_IMM, /* Immediate : .immediate */
9153305928SMasami Hiramatsu FETCH_OP_COMM, /* Current comm */
92a1303af5SMasami Hiramatsu FETCH_OP_ARG, /* Function argument : .param */
9353305928SMasami Hiramatsu FETCH_OP_FOFFS, /* File offset: .immediate */
94a42e3c4dSMasami Hiramatsu FETCH_OP_DATA, /* Allocated data: .data */
9553305928SMasami Hiramatsu // Stage 2 (dereference) op
9653305928SMasami Hiramatsu FETCH_OP_DEREF, /* Dereference: .offset */
97e65f7ae7SMasami Hiramatsu FETCH_OP_UDEREF, /* User-space Dereference: .offset */
9853305928SMasami Hiramatsu // Stage 3 (store) ops
9953305928SMasami Hiramatsu FETCH_OP_ST_RAW, /* Raw: .size */
10053305928SMasami Hiramatsu FETCH_OP_ST_MEM, /* Mem: .offset, .size */
101e65f7ae7SMasami Hiramatsu FETCH_OP_ST_UMEM, /* Mem: .offset, .size */
10253305928SMasami Hiramatsu FETCH_OP_ST_STRING, /* String: .offset, .size */
10388903c46SMasami Hiramatsu FETCH_OP_ST_USTRING, /* User String: .offset, .size */
104b26a124cSMasami Hiramatsu (Google) FETCH_OP_ST_SYMSTR, /* Kernel Symbol String: .offset, .size */
10553305928SMasami Hiramatsu // Stage 4 (modify) op
10653305928SMasami Hiramatsu FETCH_OP_MOD_BF, /* Bitfield: .basesize, .lshift, .rshift */
10740b53b77SMasami Hiramatsu // Stage 5 (loop) op
10840b53b77SMasami Hiramatsu FETCH_OP_LP_ARRAY, /* Array: .param = loop count */
1097491e2c4STzvetomir Stoyanov (VMware) FETCH_OP_TP_ARG, /* Trace Point argument */
11053305928SMasami Hiramatsu FETCH_OP_END,
111a6682814SMasami Hiramatsu FETCH_NOP_SYMBOL, /* Unresolved Symbol holder */
1128ab83f56SSrikar Dronamraju };
1138ab83f56SSrikar Dronamraju
11453305928SMasami Hiramatsu struct fetch_insn {
11553305928SMasami Hiramatsu enum fetch_op op;
11653305928SMasami Hiramatsu union {
11753305928SMasami Hiramatsu unsigned int param;
11853305928SMasami Hiramatsu struct {
11953305928SMasami Hiramatsu unsigned int size;
12053305928SMasami Hiramatsu int offset;
12153305928SMasami Hiramatsu };
12253305928SMasami Hiramatsu struct {
12353305928SMasami Hiramatsu unsigned char basesize;
12453305928SMasami Hiramatsu unsigned char lshift;
12553305928SMasami Hiramatsu unsigned char rshift;
12653305928SMasami Hiramatsu };
12753305928SMasami Hiramatsu unsigned long immediate;
128a6682814SMasami Hiramatsu void *data;
12953305928SMasami Hiramatsu };
13053305928SMasami Hiramatsu };
13153305928SMasami Hiramatsu
13253305928SMasami Hiramatsu /* fetch + deref*N + store + mod + end <= 16, this allows N=12, enough */
13353305928SMasami Hiramatsu #define FETCH_INSN_MAX 16
1344dd537acSMasami Hiramatsu #define FETCH_TOKEN_COMM (-ECOMM)
13553305928SMasami Hiramatsu
1368ab83f56SSrikar Dronamraju /* Fetch type information table */
1378ab83f56SSrikar Dronamraju struct fetch_type {
1388ab83f56SSrikar Dronamraju const char *name; /* Name of type */
1398ab83f56SSrikar Dronamraju size_t size; /* Byte size of type */
140b26a124cSMasami Hiramatsu (Google) bool is_signed; /* Signed flag */
141b26a124cSMasami Hiramatsu (Google) bool is_string; /* String flag */
1428ab83f56SSrikar Dronamraju print_type_func_t print; /* Print functions */
143f2cc020dSIngo Molnar const char *fmt; /* Format string */
1448ab83f56SSrikar Dronamraju const char *fmttype; /* Name in format file */
1458ab83f56SSrikar Dronamraju };
1468ab83f56SSrikar Dronamraju
14734fee3a1SNamhyung Kim /* For defining macros, define string/string_size types */
14834fee3a1SNamhyung Kim typedef u32 string;
14934fee3a1SNamhyung Kim typedef u32 string_size;
15034fee3a1SNamhyung Kim
151b26c74e1SNamhyung Kim #define PRINT_TYPE_FUNC_NAME(type) print_type_##type
152b26c74e1SNamhyung Kim #define PRINT_TYPE_FMT_NAME(type) print_type_format_##type
153b26c74e1SNamhyung Kim
154b26c74e1SNamhyung Kim /* Printing in basic type function template */
155b26c74e1SNamhyung Kim #define DECLARE_BASIC_PRINT_TYPE_FUNC(type) \
15656de7630SMasami Hiramatsu int PRINT_TYPE_FUNC_NAME(type)(struct trace_seq *s, void *data, void *ent);\
157b26c74e1SNamhyung Kim extern const char PRINT_TYPE_FMT_NAME(type)[]
158b26c74e1SNamhyung Kim
159b26c74e1SNamhyung Kim DECLARE_BASIC_PRINT_TYPE_FUNC(u8);
160b26c74e1SNamhyung Kim DECLARE_BASIC_PRINT_TYPE_FUNC(u16);
161b26c74e1SNamhyung Kim DECLARE_BASIC_PRINT_TYPE_FUNC(u32);
162b26c74e1SNamhyung Kim DECLARE_BASIC_PRINT_TYPE_FUNC(u64);
163b26c74e1SNamhyung Kim DECLARE_BASIC_PRINT_TYPE_FUNC(s8);
164b26c74e1SNamhyung Kim DECLARE_BASIC_PRINT_TYPE_FUNC(s16);
165b26c74e1SNamhyung Kim DECLARE_BASIC_PRINT_TYPE_FUNC(s32);
166b26c74e1SNamhyung Kim DECLARE_BASIC_PRINT_TYPE_FUNC(s64);
16717ce3dc7SMasami Hiramatsu DECLARE_BASIC_PRINT_TYPE_FUNC(x8);
16817ce3dc7SMasami Hiramatsu DECLARE_BASIC_PRINT_TYPE_FUNC(x16);
16917ce3dc7SMasami Hiramatsu DECLARE_BASIC_PRINT_TYPE_FUNC(x32);
17017ce3dc7SMasami Hiramatsu DECLARE_BASIC_PRINT_TYPE_FUNC(x64);
17117ce3dc7SMasami Hiramatsu
1728478cca1SDonglin Peng DECLARE_BASIC_PRINT_TYPE_FUNC(char);
173b26c74e1SNamhyung Kim DECLARE_BASIC_PRINT_TYPE_FUNC(string);
17460c2e0ceSMasami Hiramatsu DECLARE_BASIC_PRINT_TYPE_FUNC(symbol);
175b26c74e1SNamhyung Kim
176b26c74e1SNamhyung Kim /* Default (unsigned long) fetch type */
177bdca79c2SMasami Hiramatsu #define __DEFAULT_FETCH_TYPE(t) x##t
178b26c74e1SNamhyung Kim #define _DEFAULT_FETCH_TYPE(t) __DEFAULT_FETCH_TYPE(t)
179b26c74e1SNamhyung Kim #define DEFAULT_FETCH_TYPE _DEFAULT_FETCH_TYPE(BITS_PER_LONG)
180b26c74e1SNamhyung Kim #define DEFAULT_FETCH_TYPE_STR __stringify(DEFAULT_FETCH_TYPE)
181b26c74e1SNamhyung Kim
18260c2e0ceSMasami Hiramatsu #define __ADDR_FETCH_TYPE(t) u##t
18360c2e0ceSMasami Hiramatsu #define _ADDR_FETCH_TYPE(t) __ADDR_FETCH_TYPE(t)
18460c2e0ceSMasami Hiramatsu #define ADDR_FETCH_TYPE _ADDR_FETCH_TYPE(BITS_PER_LONG)
18560c2e0ceSMasami Hiramatsu
186b26a124cSMasami Hiramatsu (Google) #define __ASSIGN_FETCH_TYPE(_name, ptype, ftype, _size, sign, str, _fmttype) \
187b26c74e1SNamhyung Kim {.name = _name, \
188b26c74e1SNamhyung Kim .size = _size, \
189b26a124cSMasami Hiramatsu (Google) .is_signed = (bool)sign, \
190b26a124cSMasami Hiramatsu (Google) .is_string = (bool)str, \
191b26c74e1SNamhyung Kim .print = PRINT_TYPE_FUNC_NAME(ptype), \
192b26c74e1SNamhyung Kim .fmt = PRINT_TYPE_FMT_NAME(ptype), \
193b26c74e1SNamhyung Kim .fmttype = _fmttype, \
194b26c74e1SNamhyung Kim }
195b26a124cSMasami Hiramatsu (Google)
196b26a124cSMasami Hiramatsu (Google) /* Non string types can use these macros */
19760c2e0ceSMasami Hiramatsu #define _ASSIGN_FETCH_TYPE(_name, ptype, ftype, _size, sign, _fmttype) \
198b26a124cSMasami Hiramatsu (Google) __ASSIGN_FETCH_TYPE(_name, ptype, ftype, _size, sign, 0, #_fmttype)
199b26c74e1SNamhyung Kim #define ASSIGN_FETCH_TYPE(ptype, ftype, sign) \
20060c2e0ceSMasami Hiramatsu _ASSIGN_FETCH_TYPE(#ptype, ptype, ftype, sizeof(ftype), sign, ptype)
201b26c74e1SNamhyung Kim
20217ce3dc7SMasami Hiramatsu /* If ptype is an alias of atype, use this macro (show atype in format) */
20317ce3dc7SMasami Hiramatsu #define ASSIGN_FETCH_TYPE_ALIAS(ptype, atype, ftype, sign) \
20460c2e0ceSMasami Hiramatsu _ASSIGN_FETCH_TYPE(#ptype, ptype, ftype, sizeof(ftype), sign, atype)
20517ce3dc7SMasami Hiramatsu
20634fee3a1SNamhyung Kim #define ASSIGN_FETCH_TYPE_END {}
20740b53b77SMasami Hiramatsu #define MAX_ARRAY_LEN 64
20834fee3a1SNamhyung Kim
2096b0b7551SAnton Blanchard #ifdef CONFIG_KPROBE_EVENTS
210b4da3340SMasami Hiramatsu bool trace_kprobe_on_func_entry(struct trace_event_call *call);
211b4da3340SMasami Hiramatsu bool trace_kprobe_error_injectable(struct trace_event_call *call);
2121301a44eSNamhyung Kim #else
trace_kprobe_on_func_entry(struct trace_event_call * call)213b4da3340SMasami Hiramatsu static inline bool trace_kprobe_on_func_entry(struct trace_event_call *call)
2149802d865SJosef Bacik {
215b4da3340SMasami Hiramatsu return false;
2169802d865SJosef Bacik }
2179802d865SJosef Bacik
trace_kprobe_error_injectable(struct trace_event_call * call)218b4da3340SMasami Hiramatsu static inline bool trace_kprobe_error_injectable(struct trace_event_call *call)
2199802d865SJosef Bacik {
220b4da3340SMasami Hiramatsu return false;
2219802d865SJosef Bacik }
2226b0b7551SAnton Blanchard #endif /* CONFIG_KPROBE_EVENTS */
2231301a44eSNamhyung Kim
2248ab83f56SSrikar Dronamraju struct probe_arg {
22553305928SMasami Hiramatsu struct fetch_insn *code;
22653305928SMasami Hiramatsu bool dynamic;/* Dynamic array (string) is used */
2278ab83f56SSrikar Dronamraju unsigned int offset; /* Offset from argument entry */
22840b53b77SMasami Hiramatsu unsigned int count; /* Array count */
2298ab83f56SSrikar Dronamraju const char *name; /* Name of this argument */
2308ab83f56SSrikar Dronamraju const char *comm; /* Command of this argument */
23140b53b77SMasami Hiramatsu char *fmt; /* Format string if needed */
2328ab83f56SSrikar Dronamraju const struct fetch_type *type; /* Type of this argument */
2338ab83f56SSrikar Dronamraju };
2348ab83f56SSrikar Dronamraju
235b61387cbSMasami Hiramatsu struct trace_uprobe_filter {
236b61387cbSMasami Hiramatsu rwlock_t rwlock;
237b61387cbSMasami Hiramatsu int nr_systemwide;
238b61387cbSMasami Hiramatsu struct list_head perf_events;
239b61387cbSMasami Hiramatsu };
240b61387cbSMasami Hiramatsu
24160d53e2cSMasami Hiramatsu /* Event call and class holder */
24260d53e2cSMasami Hiramatsu struct trace_probe_event {
243c31ffb3fSNamhyung Kim unsigned int flags; /* For TP_FLAG_* */
2442425bcb9SSteven Rostedt (Red Hat) struct trace_event_class class;
2452425bcb9SSteven Rostedt (Red Hat) struct trace_event_call call;
246c31ffb3fSNamhyung Kim struct list_head files;
24760d53e2cSMasami Hiramatsu struct list_head probes;
2487fac96f2SGustavo A. R. Silva struct trace_uprobe_filter filter[];
24960d53e2cSMasami Hiramatsu };
25060d53e2cSMasami Hiramatsu
25160d53e2cSMasami Hiramatsu struct trace_probe {
25260d53e2cSMasami Hiramatsu struct list_head list;
25360d53e2cSMasami Hiramatsu struct trace_probe_event *event;
254c31ffb3fSNamhyung Kim ssize_t size; /* trace entry size */
255c31ffb3fSNamhyung Kim unsigned int nr_args;
256c31ffb3fSNamhyung Kim struct probe_arg args[];
257c31ffb3fSNamhyung Kim };
258c31ffb3fSNamhyung Kim
25970ed91c6Szhangwei(Jovi) struct event_file_link {
2607f1d2f82SSteven Rostedt (Red Hat) struct trace_event_file *file;
26170ed91c6Szhangwei(Jovi) struct list_head list;
26270ed91c6Szhangwei(Jovi) };
26370ed91c6Szhangwei(Jovi)
trace_probe_test_flag(struct trace_probe * tp,unsigned int flag)264747774d6SMasami Hiramatsu static inline bool trace_probe_test_flag(struct trace_probe *tp,
265747774d6SMasami Hiramatsu unsigned int flag)
266747774d6SMasami Hiramatsu {
26760d53e2cSMasami Hiramatsu return !!(tp->event->flags & flag);
268747774d6SMasami Hiramatsu }
269747774d6SMasami Hiramatsu
trace_probe_set_flag(struct trace_probe * tp,unsigned int flag)270747774d6SMasami Hiramatsu static inline void trace_probe_set_flag(struct trace_probe *tp,
271747774d6SMasami Hiramatsu unsigned int flag)
272747774d6SMasami Hiramatsu {
27360d53e2cSMasami Hiramatsu tp->event->flags |= flag;
274747774d6SMasami Hiramatsu }
275747774d6SMasami Hiramatsu
trace_probe_clear_flag(struct trace_probe * tp,unsigned int flag)276747774d6SMasami Hiramatsu static inline void trace_probe_clear_flag(struct trace_probe *tp,
277747774d6SMasami Hiramatsu unsigned int flag)
278747774d6SMasami Hiramatsu {
27960d53e2cSMasami Hiramatsu tp->event->flags &= ~flag;
280747774d6SMasami Hiramatsu }
281747774d6SMasami Hiramatsu
trace_probe_is_enabled(struct trace_probe * tp)282c31ffb3fSNamhyung Kim static inline bool trace_probe_is_enabled(struct trace_probe *tp)
283c31ffb3fSNamhyung Kim {
284747774d6SMasami Hiramatsu return trace_probe_test_flag(tp, TP_FLAG_TRACE | TP_FLAG_PROFILE);
285c31ffb3fSNamhyung Kim }
286c31ffb3fSNamhyung Kim
trace_probe_name(struct trace_probe * tp)287b55ce203SMasami Hiramatsu static inline const char *trace_probe_name(struct trace_probe *tp)
288b55ce203SMasami Hiramatsu {
28960d53e2cSMasami Hiramatsu return trace_event_name(&tp->event->call);
290b55ce203SMasami Hiramatsu }
291b55ce203SMasami Hiramatsu
trace_probe_group_name(struct trace_probe * tp)292b55ce203SMasami Hiramatsu static inline const char *trace_probe_group_name(struct trace_probe *tp)
293b55ce203SMasami Hiramatsu {
29460d53e2cSMasami Hiramatsu return tp->event->call.class->system;
295b55ce203SMasami Hiramatsu }
296b55ce203SMasami Hiramatsu
297e3dc9f89SMasami Hiramatsu static inline struct trace_event_call *
trace_probe_event_call(struct trace_probe * tp)298e3dc9f89SMasami Hiramatsu trace_probe_event_call(struct trace_probe *tp)
299e3dc9f89SMasami Hiramatsu {
30060d53e2cSMasami Hiramatsu return &tp->event->call;
30160d53e2cSMasami Hiramatsu }
30260d53e2cSMasami Hiramatsu
30360d53e2cSMasami Hiramatsu static inline struct trace_probe_event *
trace_probe_event_from_call(struct trace_event_call * event_call)30460d53e2cSMasami Hiramatsu trace_probe_event_from_call(struct trace_event_call *event_call)
30560d53e2cSMasami Hiramatsu {
30660d53e2cSMasami Hiramatsu return container_of(event_call, struct trace_probe_event, call);
30760d53e2cSMasami Hiramatsu }
30860d53e2cSMasami Hiramatsu
30960d53e2cSMasami Hiramatsu static inline struct trace_probe *
trace_probe_primary_from_call(struct trace_event_call * call)31060d53e2cSMasami Hiramatsu trace_probe_primary_from_call(struct trace_event_call *call)
31160d53e2cSMasami Hiramatsu {
31260d53e2cSMasami Hiramatsu struct trace_probe_event *tpe = trace_probe_event_from_call(call);
31360d53e2cSMasami Hiramatsu
31481d0fa4cSPietro Borrello return list_first_entry_or_null(&tpe->probes, struct trace_probe, list);
31560d53e2cSMasami Hiramatsu }
31660d53e2cSMasami Hiramatsu
trace_probe_probe_list(struct trace_probe * tp)31760d53e2cSMasami Hiramatsu static inline struct list_head *trace_probe_probe_list(struct trace_probe *tp)
31860d53e2cSMasami Hiramatsu {
31960d53e2cSMasami Hiramatsu return &tp->event->probes;
320e3dc9f89SMasami Hiramatsu }
321e3dc9f89SMasami Hiramatsu
trace_probe_has_sibling(struct trace_probe * tp)322ca89bc07SMasami Hiramatsu static inline bool trace_probe_has_sibling(struct trace_probe *tp)
323ca89bc07SMasami Hiramatsu {
324ca89bc07SMasami Hiramatsu struct list_head *list = trace_probe_probe_list(tp);
325ca89bc07SMasami Hiramatsu
326ca89bc07SMasami Hiramatsu return !list_empty(list) && !list_is_singular(list);
327ca89bc07SMasami Hiramatsu }
328ca89bc07SMasami Hiramatsu
trace_probe_unregister_event_call(struct trace_probe * tp)32946e5376dSMasami Hiramatsu static inline int trace_probe_unregister_event_call(struct trace_probe *tp)
33046e5376dSMasami Hiramatsu {
33146e5376dSMasami Hiramatsu /* tp->event is unregistered in trace_remove_event_call() */
33260d53e2cSMasami Hiramatsu return trace_remove_event_call(&tp->event->call);
33346e5376dSMasami Hiramatsu }
334455b2899SMasami Hiramatsu
trace_probe_has_single_file(struct trace_probe * tp)335b5f935eeSMasami Hiramatsu static inline bool trace_probe_has_single_file(struct trace_probe *tp)
336b5f935eeSMasami Hiramatsu {
33760d53e2cSMasami Hiramatsu return !!list_is_singular(&tp->event->files);
338b5f935eeSMasami Hiramatsu }
339b5f935eeSMasami Hiramatsu
340b5f935eeSMasami Hiramatsu int trace_probe_init(struct trace_probe *tp, const char *event,
341b61387cbSMasami Hiramatsu const char *group, bool alloc_filter);
342b5f935eeSMasami Hiramatsu void trace_probe_cleanup(struct trace_probe *tp);
343ca89bc07SMasami Hiramatsu int trace_probe_append(struct trace_probe *tp, struct trace_probe *to);
344ca89bc07SMasami Hiramatsu void trace_probe_unlink(struct trace_probe *tp);
345b5f935eeSMasami Hiramatsu int trace_probe_register_event_call(struct trace_probe *tp);
346b5f935eeSMasami Hiramatsu int trace_probe_add_file(struct trace_probe *tp, struct trace_event_file *file);
347b5f935eeSMasami Hiramatsu int trace_probe_remove_file(struct trace_probe *tp,
348b5f935eeSMasami Hiramatsu struct trace_event_file *file);
349b5f935eeSMasami Hiramatsu struct event_file_link *trace_probe_get_file_link(struct trace_probe *tp,
350b5f935eeSMasami Hiramatsu struct trace_event_file *file);
351ca89bc07SMasami Hiramatsu int trace_probe_compare_arg_type(struct trace_probe *a, struct trace_probe *b);
352eb5bf813SMasami Hiramatsu bool trace_probe_match_command_args(struct trace_probe *tp,
353eb5bf813SMasami Hiramatsu int argc, const char **argv);
354d262271dSMasami Hiramatsu int trace_probe_create(const char *raw_command, int (*createfn)(int, const char **));
355196b6389SSong Chen int trace_probe_print_args(struct trace_seq *s, struct probe_arg *args, int nr_args,
356196b6389SSong Chen u8 *data, void *field);
357b5f935eeSMasami Hiramatsu
358b5f935eeSMasami Hiramatsu #define trace_probe_for_each_link(pos, tp) \
35960d53e2cSMasami Hiramatsu list_for_each_entry(pos, &(tp)->event->files, list)
360b5f935eeSMasami Hiramatsu #define trace_probe_for_each_link_rcu(pos, tp) \
36160d53e2cSMasami Hiramatsu list_for_each_entry_rcu(pos, &(tp)->event->files, list)
362b5f935eeSMasami Hiramatsu
36330460c21SMasami Hiramatsu (Google) /*
36430460c21SMasami Hiramatsu (Google) * The flags used for parsing trace_probe arguments.
365e2d0d7b2SMasami Hiramatsu (Google) * TPARG_FL_RETURN, TPARG_FL_FENTRY and TPARG_FL_TEVENT are mutually exclusive.
36630460c21SMasami Hiramatsu (Google) * TPARG_FL_KERNEL and TPARG_FL_USER are also mutually exclusive.
367e2d0d7b2SMasami Hiramatsu (Google) * TPARG_FL_FPROBE and TPARG_FL_TPOINT are optional but it should be with
368e2d0d7b2SMasami Hiramatsu (Google) * TPARG_FL_KERNEL.
36930460c21SMasami Hiramatsu (Google) */
370a1303af5SMasami Hiramatsu #define TPARG_FL_RETURN BIT(0)
371a1303af5SMasami Hiramatsu #define TPARG_FL_KERNEL BIT(1)
372a1303af5SMasami Hiramatsu #define TPARG_FL_FENTRY BIT(2)
373e2d0d7b2SMasami Hiramatsu (Google) #define TPARG_FL_TEVENT BIT(3)
374d4505aa6SMasami Hiramatsu (Google) #define TPARG_FL_USER BIT(4)
375334e5519SMasami Hiramatsu (Google) #define TPARG_FL_FPROBE BIT(5)
376e2d0d7b2SMasami Hiramatsu (Google) #define TPARG_FL_TPOINT BIT(6)
377e2d0d7b2SMasami Hiramatsu (Google) #define TPARG_FL_LOC_MASK GENMASK(4, 0)
378e2d0d7b2SMasami Hiramatsu (Google)
tparg_is_function_entry(unsigned int flags)379e2d0d7b2SMasami Hiramatsu (Google) static inline bool tparg_is_function_entry(unsigned int flags)
380e2d0d7b2SMasami Hiramatsu (Google) {
381e2d0d7b2SMasami Hiramatsu (Google) return (flags & TPARG_FL_LOC_MASK) == (TPARG_FL_KERNEL | TPARG_FL_FENTRY);
382e2d0d7b2SMasami Hiramatsu (Google) }
383a1303af5SMasami Hiramatsu
3841b8b0cd7SMasami Hiramatsu (Google) struct traceprobe_parse_context {
3851b8b0cd7SMasami Hiramatsu (Google) struct trace_event_call *event;
386b1d1e904SMasami Hiramatsu (Google) /* BTF related parameters */
387b1d1e904SMasami Hiramatsu (Google) const char *funcname; /* Function name in BTF */
388d157d769SMasami Hiramatsu (Google) const struct btf_type *proto; /* Prototype of the function */
389b1d1e904SMasami Hiramatsu (Google) const struct btf_param *params; /* Parameter of the function */
390b1d1e904SMasami Hiramatsu (Google) s32 nr_params; /* The number of the parameters */
391b1d1e904SMasami Hiramatsu (Google) struct btf *btf; /* The BTF to be used */
392c440adfbSMasami Hiramatsu (Google) const struct btf_type *last_type; /* Saved type */
393c440adfbSMasami Hiramatsu (Google) u32 last_bitoffs; /* Saved bitoffs */
394c440adfbSMasami Hiramatsu (Google) u32 last_bitsize; /* Saved bitsize */
3951b8b0cd7SMasami Hiramatsu (Google) unsigned int flags;
3961b8b0cd7SMasami Hiramatsu (Google) int offset;
3971b8b0cd7SMasami Hiramatsu (Google) };
3981b8b0cd7SMasami Hiramatsu (Google)
399d00bbea9SMasami Hiramatsu extern int traceprobe_parse_probe_arg(struct trace_probe *tp, int i,
4001b8b0cd7SMasami Hiramatsu (Google) const char *argv,
4011b8b0cd7SMasami Hiramatsu (Google) struct traceprobe_parse_context *ctx);
40218b1e870SMasami Hiramatsu (Google) const char **traceprobe_expand_meta_args(int argc, const char *argv[],
40318b1e870SMasami Hiramatsu (Google) int *new_argc, char *buf, int bufsize,
40418b1e870SMasami Hiramatsu (Google) struct traceprobe_parse_context *ctx);
4058ab83f56SSrikar Dronamraju
406a6682814SMasami Hiramatsu extern int traceprobe_update_arg(struct probe_arg *arg);
4078ab83f56SSrikar Dronamraju extern void traceprobe_free_probe_arg(struct probe_arg *arg);
4088ab83f56SSrikar Dronamraju
409b1d1e904SMasami Hiramatsu (Google) /*
410b1d1e904SMasami Hiramatsu (Google) * If either traceprobe_parse_probe_arg() or traceprobe_expand_meta_args() is called,
411b1d1e904SMasami Hiramatsu (Google) * this MUST be called for clean up the context and return a resource.
412b1d1e904SMasami Hiramatsu (Google) */
413b1d1e904SMasami Hiramatsu (Google) void traceprobe_finish_parse(struct traceprobe_parse_context *ctx);
414b1d1e904SMasami Hiramatsu (Google)
415c5d343b6SMasami Hiramatsu extern int traceprobe_split_symbol_offset(char *symbol, long *offset);
416ab105a4fSMasami Hiramatsu int traceprobe_parse_event_name(const char **pevent, const char **pgroup,
417ab105a4fSMasami Hiramatsu char *buf, int offset);
4188ab83f56SSrikar Dronamraju
419007517a0SSteven Rostedt (VMware) enum probe_print_type {
420007517a0SSteven Rostedt (VMware) PROBE_PRINT_NORMAL,
421007517a0SSteven Rostedt (VMware) PROBE_PRINT_RETURN,
4227491e2c4STzvetomir Stoyanov (VMware) PROBE_PRINT_EVENT,
423007517a0SSteven Rostedt (VMware) };
424007517a0SSteven Rostedt (VMware)
425007517a0SSteven Rostedt (VMware) extern int traceprobe_set_print_fmt(struct trace_probe *tp, enum probe_print_type ptype);
426e12f03d7SSong Liu
427e12f03d7SSong Liu #ifdef CONFIG_PERF_EVENTS
428e12f03d7SSong Liu extern struct trace_event_call *
429e12f03d7SSong Liu create_local_trace_kprobe(char *func, void *addr, unsigned long offs,
430e12f03d7SSong Liu bool is_return);
431e12f03d7SSong Liu extern void destroy_local_trace_kprobe(struct trace_event_call *event_call);
43233ea4b24SSong Liu
43333ea4b24SSong Liu extern struct trace_event_call *
434a6ca88b2SSong Liu create_local_trace_uprobe(char *name, unsigned long offs,
435a6ca88b2SSong Liu unsigned long ref_ctr_offset, bool is_return);
43633ea4b24SSong Liu extern void destroy_local_trace_uprobe(struct trace_event_call *event_call);
437e12f03d7SSong Liu #endif
438eeb07b06SMasami Hiramatsu extern int traceprobe_define_arg_fields(struct trace_event_call *event_call,
439eeb07b06SMasami Hiramatsu size_t offset, struct trace_probe *tp);
440ab105a4fSMasami Hiramatsu
441ab105a4fSMasami Hiramatsu #undef ERRORS
442ab105a4fSMasami Hiramatsu #define ERRORS \
443ab105a4fSMasami Hiramatsu C(FILE_NOT_FOUND, "Failed to find the given file"), \
444ab105a4fSMasami Hiramatsu C(NO_REGULAR_FILE, "Not a regular file"), \
445ab105a4fSMasami Hiramatsu C(BAD_REFCNT, "Invalid reference counter offset"), \
446ab105a4fSMasami Hiramatsu C(REFCNT_OPEN_BRACE, "Reference counter brace is not closed"), \
447ab105a4fSMasami Hiramatsu C(BAD_REFCNT_SUFFIX, "Reference counter has wrong suffix"), \
448ab105a4fSMasami Hiramatsu C(BAD_UPROBE_OFFS, "Invalid uprobe offset"), \
449334e5519SMasami Hiramatsu (Google) C(BAD_MAXACT_TYPE, "Maxactive is only for function exit"), \
450ab105a4fSMasami Hiramatsu C(BAD_MAXACT, "Invalid maxactive number"), \
451ab105a4fSMasami Hiramatsu C(MAXACT_TOO_BIG, "Maxactive is too big"), \
452ab105a4fSMasami Hiramatsu C(BAD_PROBE_ADDR, "Invalid probed address or symbol"), \
453b022f0c7SFrancis Laniel C(NON_UNIQ_SYMBOL, "The symbol is not unique"), \
454ab105a4fSMasami Hiramatsu C(BAD_RETPROBE, "Retprobe address must be an function entry"), \
455e2d0d7b2SMasami Hiramatsu (Google) C(NO_TRACEPOINT, "Tracepoint is not found"), \
4564725cd89SMasami Hiramatsu C(BAD_ADDR_SUFFIX, "Invalid probed address suffix"), \
457ab105a4fSMasami Hiramatsu C(NO_GROUP_NAME, "Group name is not specified"), \
458ab105a4fSMasami Hiramatsu C(GROUP_TOO_LONG, "Group name is too long"), \
459ab105a4fSMasami Hiramatsu C(BAD_GROUP_NAME, "Group name must follow the same rules as C identifiers"), \
460ab105a4fSMasami Hiramatsu C(NO_EVENT_NAME, "Event name is not specified"), \
461ab105a4fSMasami Hiramatsu C(EVENT_TOO_LONG, "Event name is too long"), \
462ab105a4fSMasami Hiramatsu C(BAD_EVENT_NAME, "Event name must follow the same rules as C identifiers"), \
4638e242060SMasami Hiramatsu C(EVENT_EXIST, "Given group/event name is already used by another event"), \
464ab105a4fSMasami Hiramatsu C(RETVAL_ON_PROBE, "$retval is not available on probe"), \
465fd26290eSMasami Hiramatsu (Google) C(NO_RETVAL, "This function returns 'void' type"), \
466ab105a4fSMasami Hiramatsu C(BAD_STACK_NUM, "Invalid stack number"), \
467ab105a4fSMasami Hiramatsu C(BAD_ARG_NUM, "Invalid argument number"), \
468ab105a4fSMasami Hiramatsu C(BAD_VAR, "Invalid $-valiable specified"), \
469ab105a4fSMasami Hiramatsu C(BAD_REG_NAME, "Invalid register name"), \
470ab105a4fSMasami Hiramatsu C(BAD_MEM_ADDR, "Invalid memory address"), \
4716218bf9fSMasami Hiramatsu C(BAD_IMM, "Invalid immediate value"), \
472a42e3c4dSMasami Hiramatsu C(IMMSTR_NO_CLOSE, "String is not closed with '\"'"), \
473ab105a4fSMasami Hiramatsu C(FILE_ON_KPROBE, "File offset is not available with kprobe"), \
474ab105a4fSMasami Hiramatsu C(BAD_FILE_OFFS, "Invalid file offset value"), \
475ab105a4fSMasami Hiramatsu C(SYM_ON_UPROBE, "Symbol is not available with uprobe"), \
476ab105a4fSMasami Hiramatsu C(TOO_MANY_OPS, "Dereference is too much nested"), \
477ab105a4fSMasami Hiramatsu C(DEREF_NEED_BRACE, "Dereference needs a brace"), \
478ab105a4fSMasami Hiramatsu C(BAD_DEREF_OFFS, "Invalid dereference offset"), \
479ab105a4fSMasami Hiramatsu C(DEREF_OPEN_BRACE, "Dereference brace is not closed"), \
480ab105a4fSMasami Hiramatsu C(COMM_CANT_DEREF, "$comm can not be dereferenced"), \
481ab105a4fSMasami Hiramatsu C(BAD_FETCH_ARG, "Invalid fetch argument"), \
482ab105a4fSMasami Hiramatsu C(ARRAY_NO_CLOSE, "Array is not closed"), \
483ab105a4fSMasami Hiramatsu C(BAD_ARRAY_SUFFIX, "Array has wrong suffix"), \
484ab105a4fSMasami Hiramatsu C(BAD_ARRAY_NUM, "Invalid array size"), \
485ab105a4fSMasami Hiramatsu C(ARRAY_TOO_BIG, "Array number is too big"), \
486ab105a4fSMasami Hiramatsu C(BAD_TYPE, "Unknown type is specified"), \
487ab105a4fSMasami Hiramatsu C(BAD_STRING, "String accepts only memory argument"), \
488b26a124cSMasami Hiramatsu (Google) C(BAD_SYMSTRING, "Symbol String doesn't accept data/userdata"), \
489ab105a4fSMasami Hiramatsu C(BAD_BITFIELD, "Invalid bitfield"), \
490ab105a4fSMasami Hiramatsu C(ARG_NAME_TOO_LONG, "Argument name is too long"), \
491ab105a4fSMasami Hiramatsu C(NO_ARG_NAME, "Argument name is not specified"), \
492ab105a4fSMasami Hiramatsu C(BAD_ARG_NAME, "Argument name must follow the same rules as C identifiers"), \
493ab105a4fSMasami Hiramatsu C(USED_ARG_NAME, "This argument name is already used"), \
494ab105a4fSMasami Hiramatsu C(ARG_TOO_LONG, "Argument expression is too long"), \
495ab105a4fSMasami Hiramatsu C(NO_ARG_BODY, "No argument expression"), \
496ab105a4fSMasami Hiramatsu C(BAD_INSN_BNDRY, "Probe point is not an instruction boundary"),\
497ca89bc07SMasami Hiramatsu C(FAIL_REG_PROBE, "Failed to register probe event"),\
498ca89bc07SMasami Hiramatsu C(DIFF_PROBE_TYPE, "Probe type is different from existing probe"),\
499fe60b0ceSMasami Hiramatsu C(DIFF_ARG_TYPE, "Argument type or name is different from existing probe"),\
5002f63e5d2SMasami Hiramatsu (Google) C(SAME_PROBE, "There is already the exact same probe event"),\
5012f63e5d2SMasami Hiramatsu (Google) C(NO_EVENT_INFO, "This requires both group and event name to attach"),\
5022f63e5d2SMasami Hiramatsu (Google) C(BAD_ATTACH_EVENT, "Attached event does not exist"),\
503752be5c5SMasami Hiramatsu (Google) C(BAD_ATTACH_ARG, "Attached event does not have this field"),\
504b576e097SMasami Hiramatsu (Google) C(NO_EP_FILTER, "No filter rule after 'if'"), \
505b576e097SMasami Hiramatsu (Google) C(NOSUP_BTFARG, "BTF is not available or not supported"), \
506b576e097SMasami Hiramatsu (Google) C(NO_BTFARG, "This variable is not found at this probe point"),\
50718b1e870SMasami Hiramatsu (Google) C(NO_BTF_ENTRY, "No BTF entry for this probe point"), \
50818b1e870SMasami Hiramatsu (Google) C(BAD_VAR_ARGS, "$arg* must be an independent parameter without name etc."),\
50918b1e870SMasami Hiramatsu (Google) C(NOFENTRY_ARGS, "$arg* can be used only on function entry"), \
51018b1e870SMasami Hiramatsu (Google) C(DOUBLE_ARGS, "$arg* can be used only once in the parameters"), \
511c440adfbSMasami Hiramatsu (Google) C(ARGS_2LONG, "$arg* failed because the argument list is too long"), \
512c440adfbSMasami Hiramatsu (Google) C(ARGIDX_2BIG, "$argN index is too big"), \
513c440adfbSMasami Hiramatsu (Google) C(NO_PTR_STRCT, "This is not a pointer to union/structure."), \
514c440adfbSMasami Hiramatsu (Google) C(NOSUP_DAT_ARG, "Non pointer structure/union argument is not supported."),\
515c440adfbSMasami Hiramatsu (Google) C(BAD_HYPHEN, "Failed to parse single hyphen. Forgot '>'?"), \
516c440adfbSMasami Hiramatsu (Google) C(NO_BTF_FIELD, "This field is not found."), \
51727973e5cSMasami Hiramatsu (Google) C(BAD_BTF_TID, "Failed to get BTF type info."),\
518*d5889a68SMasami Hiramatsu (Google) C(BAD_TYPE4STR, "This type does not fit for string."),\
519*d5889a68SMasami Hiramatsu (Google) C(NEED_STRING_TYPE, "$comm and immediate-string only accepts string type"),
520ab105a4fSMasami Hiramatsu
521ab105a4fSMasami Hiramatsu #undef C
522ab105a4fSMasami Hiramatsu #define C(a, b) TP_ERR_##a
523ab105a4fSMasami Hiramatsu
524ab105a4fSMasami Hiramatsu /* Define TP_ERR_ */
525ab105a4fSMasami Hiramatsu enum { ERRORS };
526ab105a4fSMasami Hiramatsu
527ab105a4fSMasami Hiramatsu /* Error text is defined in trace_probe.c */
528ab105a4fSMasami Hiramatsu
529ab105a4fSMasami Hiramatsu struct trace_probe_log {
530ab105a4fSMasami Hiramatsu const char *subsystem;
531ab105a4fSMasami Hiramatsu const char **argv;
532ab105a4fSMasami Hiramatsu int argc;
533ab105a4fSMasami Hiramatsu int index;
534ab105a4fSMasami Hiramatsu };
535ab105a4fSMasami Hiramatsu
536ab105a4fSMasami Hiramatsu void trace_probe_log_init(const char *subsystem, int argc, const char **argv);
537ab105a4fSMasami Hiramatsu void trace_probe_log_set_index(int index);
538ab105a4fSMasami Hiramatsu void trace_probe_log_clear(void);
539ab105a4fSMasami Hiramatsu void __trace_probe_log_err(int offset, int err);
540ab105a4fSMasami Hiramatsu
541ab105a4fSMasami Hiramatsu #define trace_probe_log_err(offs, err) \
542ab105a4fSMasami Hiramatsu __trace_probe_log_err(offs, TP_ERR_##err)
543a3c485a5SJiri Olsa
544a3c485a5SJiri Olsa struct uprobe_dispatch_data {
545a3c485a5SJiri Olsa struct trace_uprobe *tu;
546a3c485a5SJiri Olsa unsigned long bp_addr;
547a3c485a5SJiri Olsa };
548