xref: /openbmc/linux/tools/perf/util/probe-event.h (revision 63dc02bd)
1 #ifndef _PROBE_EVENT_H
2 #define _PROBE_EVENT_H
3 
4 #include <stdbool.h>
5 #include "strlist.h"
6 #include "strfilter.h"
7 
8 extern bool probe_event_dry_run;
9 
10 /* kprobe-tracer tracing point */
11 struct probe_trace_point {
12 	char		*symbol;	/* Base symbol */
13 	char		*module;	/* Module name */
14 	unsigned long	offset;		/* Offset from symbol */
15 	bool		retprobe;	/* Return probe flag */
16 };
17 
18 /* probe-tracer tracing argument referencing offset */
19 struct probe_trace_arg_ref {
20 	struct probe_trace_arg_ref	*next;	/* Next reference */
21 	long				offset;	/* Offset value */
22 };
23 
24 /* kprobe-tracer tracing argument */
25 struct probe_trace_arg {
26 	char				*name;	/* Argument name */
27 	char				*value;	/* Base value */
28 	char				*type;	/* Type name */
29 	struct probe_trace_arg_ref	*ref;	/* Referencing offset */
30 };
31 
32 /* kprobe-tracer tracing event (point + arg) */
33 struct probe_trace_event {
34 	char				*event;	/* Event name */
35 	char				*group;	/* Group name */
36 	struct probe_trace_point	point;	/* Trace point */
37 	int				nargs;	/* Number of args */
38 	struct probe_trace_arg		*args;	/* Arguments */
39 };
40 
41 /* Perf probe probing point */
42 struct perf_probe_point {
43 	char		*file;		/* File path */
44 	char		*function;	/* Function name */
45 	int		line;		/* Line number */
46 	bool		retprobe;	/* Return probe flag */
47 	char		*lazy_line;	/* Lazy matching pattern */
48 	unsigned long	offset;		/* Offset from function entry */
49 };
50 
51 /* Perf probe probing argument field chain */
52 struct perf_probe_arg_field {
53 	struct perf_probe_arg_field	*next;	/* Next field */
54 	char				*name;	/* Name of the field */
55 	long				index;	/* Array index number */
56 	bool				ref;	/* Referencing flag */
57 };
58 
59 /* Perf probe probing argument */
60 struct perf_probe_arg {
61 	char				*name;	/* Argument name */
62 	char				*var;	/* Variable name */
63 	char				*type;	/* Type name */
64 	struct perf_probe_arg_field	*field;	/* Structure fields */
65 };
66 
67 /* Perf probe probing event (point + arg) */
68 struct perf_probe_event {
69 	char			*event;	/* Event name */
70 	char			*group;	/* Group name */
71 	struct perf_probe_point	point;	/* Probe point */
72 	int			nargs;	/* Number of arguments */
73 	struct perf_probe_arg	*args;	/* Arguments */
74 };
75 
76 
77 /* Line number container */
78 struct line_node {
79 	struct list_head	list;
80 	int			line;
81 };
82 
83 /* Line range */
84 struct line_range {
85 	char			*file;		/* File name */
86 	char			*function;	/* Function name */
87 	int			start;		/* Start line number */
88 	int			end;		/* End line number */
89 	int			offset;		/* Start line offset */
90 	char			*path;		/* Real path name */
91 	char			*comp_dir;	/* Compile directory */
92 	struct list_head	line_list;	/* Visible lines */
93 };
94 
95 /* List of variables */
96 struct variable_list {
97 	struct probe_trace_point	point;	/* Actual probepoint */
98 	struct strlist			*vars;	/* Available variables */
99 };
100 
101 /* Command string to events */
102 extern int parse_perf_probe_command(const char *cmd,
103 				    struct perf_probe_event *pev);
104 
105 /* Events to command string */
106 extern char *synthesize_perf_probe_command(struct perf_probe_event *pev);
107 extern char *synthesize_probe_trace_command(struct probe_trace_event *tev);
108 extern int synthesize_perf_probe_arg(struct perf_probe_arg *pa, char *buf,
109 				     size_t len);
110 
111 /* Check the perf_probe_event needs debuginfo */
112 extern bool perf_probe_event_need_dwarf(struct perf_probe_event *pev);
113 
114 /* Release event contents */
115 extern void clear_perf_probe_event(struct perf_probe_event *pev);
116 
117 /* Command string to line-range */
118 extern int parse_line_range_desc(const char *cmd, struct line_range *lr);
119 
120 /* Internal use: Return kernel/module path */
121 extern const char *kernel_get_module_path(const char *module);
122 
123 extern int add_perf_probe_events(struct perf_probe_event *pevs, int npevs,
124 				 int max_probe_points, const char *module,
125 				 bool force_add);
126 extern int del_perf_probe_events(struct strlist *dellist);
127 extern int show_perf_probe_events(void);
128 extern int show_line_range(struct line_range *lr, const char *module);
129 extern int show_available_vars(struct perf_probe_event *pevs, int npevs,
130 			       int max_probe_points, const char *module,
131 			       struct strfilter *filter, bool externs);
132 extern int show_available_funcs(const char *module, struct strfilter *filter);
133 
134 
135 /* Maximum index number of event-name postfix */
136 #define MAX_EVENT_INDEX	1024
137 
138 #endif /*_PROBE_EVENT_H */
139