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 */
10struct 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};
17extern struct probe_conf probe_conf;
18extern bool probe_event_dry_run;
19
20/* kprobe-tracer and uprobe-tracer tracing point */
21struct 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 */
31struct 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 */
37struct 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) */
45struct 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 */
55struct 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 */
66struct 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 */
74struct 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) */
82struct 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	struct probe_trace_event *tevs;
91	int			ntevs;
92};
93
94/* Line range */
95struct line_range {
96	char			*file;		/* File name */
97	char			*function;	/* Function name */
98	int			start;		/* Start line number */
99	int			end;		/* End line number */
100	int			offset;		/* Start line offset */
101	char			*path;		/* Real path name */
102	char			*comp_dir;	/* Compile directory */
103	struct intlist		*line_list;	/* Visible lines */
104};
105
106/* List of variables */
107struct variable_list {
108	struct probe_trace_point	point;	/* Actual probepoint */
109	struct strlist			*vars;	/* Available variables */
110};
111
112struct map;
113int init_probe_symbol_maps(bool user_only);
114void exit_probe_symbol_maps(void);
115
116/* Command string to events */
117extern int parse_perf_probe_command(const char *cmd,
118				    struct perf_probe_event *pev);
119extern int parse_probe_trace_command(const char *cmd,
120				     struct probe_trace_event *tev);
121
122/* Events to command string */
123extern char *synthesize_perf_probe_command(struct perf_probe_event *pev);
124extern char *synthesize_probe_trace_command(struct probe_trace_event *tev);
125extern int synthesize_perf_probe_arg(struct perf_probe_arg *pa, char *buf,
126				     size_t len);
127
128/* Check the perf_probe_event needs debuginfo */
129extern bool perf_probe_event_need_dwarf(struct perf_probe_event *pev);
130
131/* Release event contents */
132extern void clear_perf_probe_event(struct perf_probe_event *pev);
133extern void clear_probe_trace_event(struct probe_trace_event *tev);
134
135/* Command string to line-range */
136extern int parse_line_range_desc(const char *cmd, struct line_range *lr);
137
138/* Release line range members */
139extern void line_range__clear(struct line_range *lr);
140
141/* Initialize line range */
142extern int line_range__init(struct line_range *lr);
143
144extern int add_perf_probe_events(struct perf_probe_event *pevs, int npevs);
145extern int convert_perf_probe_events(struct perf_probe_event *pevs, int npevs);
146extern int apply_perf_probe_events(struct perf_probe_event *pevs, int npevs);
147extern void cleanup_perf_probe_events(struct perf_probe_event *pevs, int npevs);
148extern int del_perf_probe_events(struct strfilter *filter);
149
150extern int show_perf_probe_event(const char *group, const char *event,
151				 struct perf_probe_event *pev,
152				 const char *module, bool use_stdout);
153extern int show_perf_probe_events(struct strfilter *filter);
154extern int show_line_range(struct line_range *lr, const char *module,
155			   bool user);
156extern int show_available_vars(struct perf_probe_event *pevs, int npevs,
157			       struct strfilter *filter);
158extern int show_available_funcs(const char *module, struct strfilter *filter,
159				bool user);
160bool arch__prefers_symtab(void);
161void arch__fix_tev_from_maps(struct perf_probe_event *pev,
162			     struct probe_trace_event *tev, struct map *map);
163
164/* If there is no space to write, returns -E2BIG. */
165int e_snprintf(char *str, size_t size, const char *format, ...)
166	__attribute__((format(printf, 3, 4)));
167
168/* Maximum index number of event-name postfix */
169#define MAX_EVENT_INDEX	1024
170
171int copy_to_probe_trace_arg(struct probe_trace_arg *tvar,
172			    struct perf_probe_arg *pvar);
173
174#endif /*_PROBE_EVENT_H */
175