tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
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};
63
64/* Perf probe probing argument field chain */
65struct perf_probe_arg_field {
66 struct perf_probe_arg_field *next; /* Next field */
67 char *name; /* Name of the field */
68 long index; /* Array index number */
69 bool ref; /* Referencing flag */
70};
71
72/* Perf probe probing argument */
73struct perf_probe_arg {
74 char *name; /* Argument name */
75 char *var; /* Variable name */
76 char *type; /* Type name */
77 struct perf_probe_arg_field *field; /* Structure fields */
78};
79
80/* Perf probe probing event (point + arg) */
81struct perf_probe_event {
82 char *event; /* Event name */
83 char *group; /* Group name */
84 struct perf_probe_point point; /* Probe point */
85 int nargs; /* Number of arguments */
86 bool uprobes; /* Uprobe event flag */
87 char *target; /* Target binary */
88 struct perf_probe_arg *args; /* Arguments */
89};
90
91/* Line range */
92struct line_range {
93 char *file; /* File name */
94 char *function; /* Function name */
95 int start; /* Start line number */
96 int end; /* End line number */
97 int offset; /* Start line offset */
98 char *path; /* Real path name */
99 char *comp_dir; /* Compile directory */
100 struct intlist *line_list; /* Visible lines */
101};
102
103/* List of variables */
104struct variable_list {
105 struct probe_trace_point point; /* Actual probepoint */
106 struct strlist *vars; /* Available variables */
107};
108
109/* Command string to events */
110extern int parse_perf_probe_command(const char *cmd,
111 struct perf_probe_event *pev);
112
113/* Events to command string */
114extern char *synthesize_perf_probe_command(struct perf_probe_event *pev);
115extern char *synthesize_probe_trace_command(struct probe_trace_event *tev);
116extern int synthesize_perf_probe_arg(struct perf_probe_arg *pa, char *buf,
117 size_t len);
118
119/* Check the perf_probe_event needs debuginfo */
120extern bool perf_probe_event_need_dwarf(struct perf_probe_event *pev);
121
122/* Release event contents */
123extern void clear_perf_probe_event(struct perf_probe_event *pev);
124
125/* Command string to line-range */
126extern int parse_line_range_desc(const char *cmd, struct line_range *lr);
127
128/* Release line range members */
129extern void line_range__clear(struct line_range *lr);
130
131/* Initialize line range */
132extern int line_range__init(struct line_range *lr);
133
134extern int add_perf_probe_events(struct perf_probe_event *pevs, int npevs);
135extern int del_perf_probe_events(struct strfilter *filter);
136extern int show_perf_probe_events(struct strfilter *filter);
137extern int show_line_range(struct line_range *lr, const char *module,
138 bool user);
139extern int show_available_vars(struct perf_probe_event *pevs, int npevs,
140 struct strfilter *filter);
141extern int show_available_funcs(const char *module, struct strfilter *filter,
142 bool user);
143bool arch__prefers_symtab(void);
144void arch__fix_tev_from_maps(struct perf_probe_event *pev,
145 struct probe_trace_event *tev, struct map *map);
146
147/* Maximum index number of event-name postfix */
148#define MAX_EVENT_INDEX 1024
149
150#endif /*_PROBE_EVENT_H */