xref: /linux/tools/perf/util/probe-event.h (revision ca55b2fef3a9373fcfc30f82fd26bc7fccbda732)
1 #ifndef _PROBE_EVENT_H
2 #define _PROBE_EVENT_H
3 
4 #include <stdbool.h>
5 #include "intlist.h"
6 #include "strlist.h"
7 #include "strfilter.h"
8 
9 /* Probe related configurations */
10 struct probe_conf {
11 	bool	show_ext_vars;
12 	bool	show_location_range;
13 	bool	force_add;
14 	bool	no_inlines;
15 	int	max_probes;
16 };
17 extern struct probe_conf probe_conf;
18 extern bool probe_event_dry_run;
19 
20 /* kprobe-tracer and uprobe-tracer tracing point */
21 struct probe_trace_point {
22 	char		*realname;	/* function real name (if needed) */
23 	char		*symbol;	/* Base symbol */
24 	char		*module;	/* Module name */
25 	unsigned long	offset;		/* Offset from symbol */
26 	unsigned long	address;	/* Actual address of the trace point */
27 	bool		retprobe;	/* Return probe flag */
28 };
29 
30 /* probe-tracer tracing argument referencing offset */
31 struct probe_trace_arg_ref {
32 	struct probe_trace_arg_ref	*next;	/* Next reference */
33 	long				offset;	/* Offset value */
34 };
35 
36 /* kprobe-tracer and uprobe-tracer tracing argument */
37 struct probe_trace_arg {
38 	char				*name;	/* Argument name */
39 	char				*value;	/* Base value */
40 	char				*type;	/* Type name */
41 	struct probe_trace_arg_ref	*ref;	/* Referencing offset */
42 };
43 
44 /* kprobe-tracer and uprobe-tracer tracing event (point + arg) */
45 struct probe_trace_event {
46 	char				*event;	/* Event name */
47 	char				*group;	/* Group name */
48 	struct probe_trace_point	point;	/* Trace point */
49 	int				nargs;	/* Number of args */
50 	bool				uprobes;	/* uprobes only */
51 	struct probe_trace_arg		*args;	/* Arguments */
52 };
53 
54 /* Perf probe probing point */
55 struct perf_probe_point {
56 	char		*file;		/* File path */
57 	char		*function;	/* Function name */
58 	int		line;		/* Line number */
59 	bool		retprobe;	/* Return probe flag */
60 	char		*lazy_line;	/* Lazy matching pattern */
61 	unsigned long	offset;		/* Offset from function entry */
62 	unsigned long	abs_address;	/* Absolute address of the point */
63 };
64 
65 /* Perf probe probing argument field chain */
66 struct perf_probe_arg_field {
67 	struct perf_probe_arg_field	*next;	/* Next field */
68 	char				*name;	/* Name of the field */
69 	long				index;	/* Array index number */
70 	bool				ref;	/* Referencing flag */
71 };
72 
73 /* Perf probe probing argument */
74 struct perf_probe_arg {
75 	char				*name;	/* Argument name */
76 	char				*var;	/* Variable name */
77 	char				*type;	/* Type name */
78 	struct perf_probe_arg_field	*field;	/* Structure fields */
79 };
80 
81 /* Perf probe probing event (point + arg) */
82 struct perf_probe_event {
83 	char			*event;	/* Event name */
84 	char			*group;	/* Group name */
85 	struct perf_probe_point	point;	/* Probe point */
86 	int			nargs;	/* Number of arguments */
87 	bool			uprobes;	/* Uprobe event flag */
88 	char			*target;	/* Target binary */
89 	struct perf_probe_arg	*args;	/* Arguments */
90 };
91 
92 /* Line range */
93 struct line_range {
94 	char			*file;		/* File name */
95 	char			*function;	/* Function name */
96 	int			start;		/* Start line number */
97 	int			end;		/* End line number */
98 	int			offset;		/* Start line offset */
99 	char			*path;		/* Real path name */
100 	char			*comp_dir;	/* Compile directory */
101 	struct intlist		*line_list;	/* Visible lines */
102 };
103 
104 /* List of variables */
105 struct variable_list {
106 	struct probe_trace_point	point;	/* Actual probepoint */
107 	struct strlist			*vars;	/* Available variables */
108 };
109 
110 struct map;
111 
112 /* Command string to events */
113 extern int parse_perf_probe_command(const char *cmd,
114 				    struct perf_probe_event *pev);
115 extern int parse_probe_trace_command(const char *cmd,
116 				     struct probe_trace_event *tev);
117 
118 /* Events to command string */
119 extern char *synthesize_perf_probe_command(struct perf_probe_event *pev);
120 extern char *synthesize_probe_trace_command(struct probe_trace_event *tev);
121 extern int synthesize_perf_probe_arg(struct perf_probe_arg *pa, char *buf,
122 				     size_t len);
123 
124 /* Check the perf_probe_event needs debuginfo */
125 extern bool perf_probe_event_need_dwarf(struct perf_probe_event *pev);
126 
127 /* Release event contents */
128 extern void clear_perf_probe_event(struct perf_probe_event *pev);
129 extern void clear_probe_trace_event(struct probe_trace_event *tev);
130 
131 /* Command string to line-range */
132 extern int parse_line_range_desc(const char *cmd, struct line_range *lr);
133 
134 /* Release line range members */
135 extern void line_range__clear(struct line_range *lr);
136 
137 /* Initialize line range */
138 extern int line_range__init(struct line_range *lr);
139 
140 extern int add_perf_probe_events(struct perf_probe_event *pevs, int npevs);
141 extern int del_perf_probe_events(struct strfilter *filter);
142 extern int show_perf_probe_events(struct strfilter *filter);
143 extern int show_line_range(struct line_range *lr, const char *module,
144 			   bool user);
145 extern int show_available_vars(struct perf_probe_event *pevs, int npevs,
146 			       struct strfilter *filter);
147 extern int show_available_funcs(const char *module, struct strfilter *filter,
148 				bool user);
149 bool arch__prefers_symtab(void);
150 void arch__fix_tev_from_maps(struct perf_probe_event *pev,
151 			     struct probe_trace_event *tev, struct map *map);
152 
153 /* If there is no space to write, returns -E2BIG. */
154 int e_snprintf(char *str, size_t size, const char *format, ...)
155 	__attribute__((format(printf, 3, 4)));
156 
157 /* Maximum index number of event-name postfix */
158 #define MAX_EVENT_INDEX	1024
159 
160 int copy_to_probe_trace_arg(struct probe_trace_arg *tvar,
161 			    struct perf_probe_arg *pvar);
162 
163 #endif /*_PROBE_EVENT_H */
164