probe-event.h 6.07 KB
Newer Older
1 2 3
#ifndef _PROBE_EVENT_H
#define _PROBE_EVENT_H

4
#include <linux/compiler.h>
5
#include <stdbool.h>
6
#include "intlist.h"
7
#include "namespaces.h"
8

9 10 11
/* Probe related configurations */
struct probe_conf {
	bool	show_ext_vars;
12
	bool	show_location_range;
13
	bool	force_add;
14
	bool	no_inlines;
15
	bool	cache;
16 17 18
	int	max_probes;
};
extern struct probe_conf probe_conf;
19 20
extern bool probe_event_dry_run;

21 22
struct symbol;

23
/* kprobe-tracer and uprobe-tracer tracing point */
24
struct probe_trace_point {
25
	char		*realname;	/* function real name (if needed) */
26
	char		*symbol;	/* Base symbol */
27
	char		*module;	/* Module name */
28
	unsigned long	offset;		/* Offset from symbol */
29
	unsigned long	address;	/* Actual address of the trace point */
30 31 32
	bool		retprobe;	/* Return probe flag */
};

33 34 35
/* probe-tracer tracing argument referencing offset */
struct probe_trace_arg_ref {
	struct probe_trace_arg_ref	*next;	/* Next reference */
36 37 38
	long				offset;	/* Offset value */
};

39
/* kprobe-tracer and uprobe-tracer tracing argument */
40
struct probe_trace_arg {
41 42
	char				*name;	/* Argument name */
	char				*value;	/* Base value */
43
	char				*type;	/* Type name */
44
	struct probe_trace_arg_ref	*ref;	/* Referencing offset */
45 46
};

47
/* kprobe-tracer and uprobe-tracer tracing event (point + arg) */
48
struct probe_trace_event {
49 50
	char				*event;	/* Event name */
	char				*group;	/* Group name */
51
	struct probe_trace_point	point;	/* Trace point */
52
	int				nargs;	/* Number of args */
53
	bool				uprobes;	/* uprobes only */
54
	struct probe_trace_arg		*args;	/* Arguments */
55 56 57 58 59 60 61
};

/* Perf probe probing point */
struct perf_probe_point {
	char		*file;		/* File path */
	char		*function;	/* Function name */
	int		line;		/* Line number */
62
	bool		retprobe;	/* Return probe flag */
63 64
	char		*lazy_line;	/* Lazy matching pattern */
	unsigned long	offset;		/* Offset from function entry */
65
	unsigned long	abs_address;	/* Absolute address of the point */
66 67
};

68 69 70 71
/* Perf probe probing argument field chain */
struct perf_probe_arg_field {
	struct perf_probe_arg_field	*next;	/* Next field */
	char				*name;	/* Name of the field */
72
	long				index;	/* Array index number */
73 74 75
	bool				ref;	/* Referencing flag */
};

76 77
/* Perf probe probing argument */
struct perf_probe_arg {
78
	char				*name;	/* Argument name */
79
	char				*var;	/* Variable name */
80
	char				*type;	/* Type name */
81
	struct perf_probe_arg_field	*field;	/* Structure fields */
82 83 84 85 86 87 88 89
};

/* Perf probe probing event (point + arg) */
struct perf_probe_event {
	char			*event;	/* Event name */
	char			*group;	/* Group name */
	struct perf_probe_point	point;	/* Probe point */
	int			nargs;	/* Number of arguments */
90
	bool			sdt;	/* SDT/cached event flag */
91 92
	bool			uprobes;	/* Uprobe event flag */
	char			*target;	/* Target binary */
93
	struct perf_probe_arg	*args;	/* Arguments */
94 95
	struct probe_trace_event *tevs;
	int			ntevs;
96
	struct nsinfo		*nsi;	/* Target namespace */
97 98 99 100 101 102
};

/* Line range */
struct line_range {
	char			*file;		/* File name */
	char			*function;	/* Function name */
103 104
	int			start;		/* Start line number */
	int			end;		/* End line number */
105 106
	int			offset;		/* Start line offset */
	char			*path;		/* Real path name */
107
	char			*comp_dir;	/* Compile directory */
108
	struct intlist		*line_list;	/* Visible lines */
109 110
};

111 112
struct strlist;

113 114 115 116 117 118
/* List of variables */
struct variable_list {
	struct probe_trace_point	point;	/* Actual probepoint */
	struct strlist			*vars;	/* Available variables */
};

119
struct map;
120 121
int init_probe_symbol_maps(bool user_only);
void exit_probe_symbol_maps(void);
122

123
/* Command string to events */
124 125
int parse_perf_probe_command(const char *cmd, struct perf_probe_event *pev);
int parse_probe_trace_command(const char *cmd, struct probe_trace_event *tev);
126 127

/* Events to command string */
128 129
char *synthesize_perf_probe_command(struct perf_probe_event *pev);
char *synthesize_probe_trace_command(struct probe_trace_event *tev);
130
char *synthesize_perf_probe_arg(struct perf_probe_arg *pa);
131
char *synthesize_perf_probe_point(struct perf_probe_point *pp);
132

133 134 135
int perf_probe_event__copy(struct perf_probe_event *dst,
			   struct perf_probe_event *src);

136 137
bool perf_probe_with_var(struct perf_probe_event *pev);

138
/* Check the perf_probe_event needs debuginfo */
139
bool perf_probe_event_need_dwarf(struct perf_probe_event *pev);
140 141

/* Release event contents */
142 143
void clear_perf_probe_event(struct perf_probe_event *pev);
void clear_probe_trace_event(struct probe_trace_event *tev);
144 145

/* Command string to line-range */
146
int parse_line_range_desc(const char *cmd, struct line_range *lr);
147

148
/* Release line range members */
149
void line_range__clear(struct line_range *lr);
150 151

/* Initialize line range */
152 153 154 155 156
int line_range__init(struct line_range *lr);

int add_perf_probe_events(struct perf_probe_event *pevs, int npevs);
int convert_perf_probe_events(struct perf_probe_event *pevs, int npevs);
int apply_perf_probe_events(struct perf_probe_event *pevs, int npevs);
157
int show_probe_trace_events(struct perf_probe_event *pevs, int npevs);
158
void cleanup_perf_probe_events(struct perf_probe_event *pevs, int npevs);
159 160 161

struct strfilter;

162 163 164 165 166 167
int del_perf_probe_events(struct strfilter *filter);

int show_perf_probe_event(const char *group, const char *event,
			  struct perf_probe_event *pev,
			  const char *module, bool use_stdout);
int show_perf_probe_events(struct strfilter *filter);
168 169
int show_line_range(struct line_range *lr, const char *module,
		    struct nsinfo *nsi, bool user);
170 171
int show_available_vars(struct perf_probe_event *pevs, int npevs,
			struct strfilter *filter);
172 173
int show_available_funcs(const char *module, struct nsinfo *nsi,
			 struct strfilter *filter, bool user);
174
void arch__fix_tev_from_maps(struct perf_probe_event *pev,
175 176
			     struct probe_trace_event *tev, struct map *map,
			     struct symbol *sym);
177

178
/* If there is no space to write, returns -E2BIG. */
179
int e_snprintf(char *str, size_t size, const char *format, ...) __printf(3, 4);
180

181 182 183
/* Maximum index number of event-name postfix */
#define MAX_EVENT_INDEX	1024

184 185 186
int copy_to_probe_trace_arg(struct probe_trace_arg *tvar,
			    struct perf_probe_arg *pvar);

187
struct map *get_target_map(const char *target, struct nsinfo *nsi, bool user);
188 189 190 191

void arch__post_process_probe_trace_events(struct perf_probe_event *pev,
					   int ntevs);

192
#endif /*_PROBE_EVENT_H */