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