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 extern bool probe_event_dry_run;
  10
  11 /* kprobe-tracer and uprobe-tracer tracing point */
  12 struct probe_trace_point {
  13         char            *symbol;        /* Base symbol */
  14         char            *module;        /* Module name */
  15         unsigned long   offset;         /* Offset from symbol */
  16         unsigned long   address;        /* Actual address of the trace point */
  17         bool            retprobe;       /* Return probe flag */
  18 };
  19
  20 /* probe-tracer tracing argument referencing offset */
  21 struct probe_trace_arg_ref {
  22         struct probe_trace_arg_ref      *next;  /* Next reference */
  23         long                            offset; /* Offset value */
  24 };
  25
  26 /* kprobe-tracer and uprobe-tracer tracing argument */
  27 struct probe_trace_arg {
  28         char                            *name;  /* Argument name */
  29         char                            *value; /* Base value */
  30         char                            *type;  /* Type name */
  31         struct probe_trace_arg_ref      *ref;   /* Referencing offset */
  32 };
  33
  34 /* kprobe-tracer and uprobe-tracer tracing event (point + arg) */
  35 struct probe_trace_event {
  36         char                            *event; /* Event name */
  37         char                            *group; /* Group name */
  38         struct probe_trace_point        point;  /* Trace point */
  39         int                             nargs;  /* Number of args */
  40         bool                            uprobes;        /* uprobes only */
  41         struct probe_trace_arg          *args;  /* Arguments */
  42 };
  43
  44 /* Perf probe probing point */
  45 struct perf_probe_point {
  46         char            *file;          /* File path */
  47         char            *function;      /* Function name */
  48         int             line;           /* Line number */
  49         bool            retprobe;       /* Return probe flag */
  50         char            *lazy_line;     /* Lazy matching pattern */
  51         unsigned long   offset;         /* Offset from function entry */
  52 };
  53
  54 /* Perf probe probing argument field chain */
  55 struct perf_probe_arg_field {
  56         struct perf_probe_arg_field     *next;  /* Next field */
  57         char                            *name;  /* Name of the field */
  58         long                            index;  /* Array index number */
  59         bool                            ref;    /* Referencing flag */
  60 };
  61
  62 /* Perf probe probing argument */
  63 struct perf_probe_arg {
  64         char                            *name;  /* Argument name */
  65         char                            *var;   /* Variable name */
  66         char                            *type;  /* Type name */
  67         struct perf_probe_arg_field     *field; /* Structure fields */
  68 };
  69
  70 /* Perf probe probing event (point + arg) */
  71 struct perf_probe_event {
  72         char                    *event; /* Event name */
  73         char                    *group; /* Group name */
  74         struct perf_probe_point point;  /* Probe point */
  75         int                     nargs;  /* Number of arguments */
  76         bool                    uprobes;        /* Uprobe event flag */
  77         char                    *target;        /* Target binary */
  78         struct perf_probe_arg   *args;  /* Arguments */
  79 };
  80
  81 /* Line range */
  82 struct line_range {
  83         char                    *file;          /* File name */
  84         char                    *function;      /* Function name */
  85         int                     start;          /* Start line number */
  86         int                     end;            /* End line number */
  87         int                     offset;         /* Start line offset */
  88         char                    *path;          /* Real path name */
  89         char                    *comp_dir;      /* Compile directory */
  90         struct intlist          *line_list;     /* Visible lines */
  91 };
  92
  93 /* List of variables */
  94 struct variable_list {
  95         struct probe_trace_point        point;  /* Actual probepoint */
  96         struct strlist                  *vars;  /* Available variables */
  97 };
  98
  99 /* Command string to events */
 100 extern int parse_perf_probe_command(const char *cmd,
 101                                     struct perf_probe_event *pev);
 102
 103 /* Events to command string */
 104 extern char *synthesize_perf_probe_command(struct perf_probe_event *pev);
 105 extern char *synthesize_probe_trace_command(struct probe_trace_event *tev);
 106 extern int synthesize_perf_probe_arg(struct perf_probe_arg *pa, char *buf,
 107                                      size_t len);
 108
 109 /* Check the perf_probe_event needs debuginfo */
 110 extern bool perf_probe_event_need_dwarf(struct perf_probe_event *pev);
 111
 112 /* Release event contents */
 113 extern void clear_perf_probe_event(struct perf_probe_event *pev);
 114
 115 /* Command string to line-range */
 116 extern int parse_line_range_desc(const char *cmd, struct line_range *lr);
 117
 118 /* Release line range members */
 119 extern void line_range__clear(struct line_range *lr);
 120
 121 /* Initialize line range */
 122 extern int line_range__init(struct line_range *lr);
 123
 124 /* Internal use: Return kernel/module path */
 125 extern const char *kernel_get_module_path(const char *module);
 126
 127 extern int add_perf_probe_events(struct perf_probe_event *pevs, int npevs,
 128                                  int max_probe_points, bool force_add);
 129 extern int del_perf_probe_events(struct strlist *dellist);
 130 extern int show_perf_probe_events(void);
 131 extern int show_line_range(struct line_range *lr, const char *module,
 132                            bool user);
 133 extern int show_available_vars(struct perf_probe_event *pevs, int npevs,
 134                                int max_probe_points, const char *module,
 135                                struct strfilter *filter, bool externs);
 136 extern int show_available_funcs(const char *module, struct strfilter *filter,
 137                                 bool user);
 138
 139 /* Maximum index number of event-name postfix */
 140 #define MAX_EVENT_INDEX 1024
 141
 142 #endif /*_PROBE_EVENT_H */