tools/perf/util/probe-event.h

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