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