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