perf probe: Support argument name
[linux-2.6.git] / tools / perf / util / probe-event.h
1 #ifndef _PROBE_EVENT_H
2 #define _PROBE_EVENT_H
3
4 #include <stdbool.h>
5 #include "strlist.h"
6
7 extern bool probe_event_dry_run;
8
9 /* kprobe-tracer tracing point */
10 struct kprobe_trace_point {
11         char            *symbol;        /* Base symbol */
12         unsigned long   offset;         /* Offset from symbol */
13         bool            retprobe;       /* Return probe flag */
14 };
15
16 /* kprobe-tracer tracing argument referencing offset */
17 struct kprobe_trace_arg_ref {
18         struct kprobe_trace_arg_ref     *next;  /* Next reference */
19         long                            offset; /* Offset value */
20 };
21
22 /* kprobe-tracer tracing argument */
23 struct kprobe_trace_arg {
24         char                            *name;  /* Argument name */
25         char                            *value; /* Base value */
26         struct kprobe_trace_arg_ref     *ref;   /* Referencing offset */
27 };
28
29 /* kprobe-tracer tracing event (point + arg) */
30 struct kprobe_trace_event {
31         char                            *event; /* Event name */
32         char                            *group; /* Group name */
33         struct kprobe_trace_point       point;  /* Trace point */
34         int                             nargs;  /* Number of args */
35         struct kprobe_trace_arg         *args;  /* Arguments */
36 };
37
38 /* Perf probe probing point */
39 struct perf_probe_point {
40         char            *file;          /* File path */
41         char            *function;      /* Function name */
42         int             line;           /* Line number */
43         bool            retprobe;       /* Return probe flag */
44         char            *lazy_line;     /* Lazy matching pattern */
45         unsigned long   offset;         /* Offset from function entry */
46 };
47
48 /* Perf probe probing argument field chain */
49 struct perf_probe_arg_field {
50         struct perf_probe_arg_field     *next;  /* Next field */
51         char                            *name;  /* Name of the field */
52         bool                            ref;    /* Referencing flag */
53 };
54
55 /* Perf probe probing argument */
56 struct perf_probe_arg {
57         char                            *name;  /* Argument name */
58         char                            *var;   /* Variable name */
59         struct perf_probe_arg_field     *field; /* Structure fields */
60 };
61
62 /* Perf probe probing event (point + arg) */
63 struct perf_probe_event {
64         char                    *event; /* Event name */
65         char                    *group; /* Group name */
66         struct perf_probe_point point;  /* Probe point */
67         int                     nargs;  /* Number of arguments */
68         struct perf_probe_arg   *args;  /* Arguments */
69 };
70
71
72 /* Line number container */
73 struct line_node {
74         struct list_head        list;
75         unsigned int            line;
76 };
77
78 /* Line range */
79 struct line_range {
80         char                    *file;          /* File name */
81         char                    *function;      /* Function name */
82         unsigned int            start;          /* Start line number */
83         unsigned int            end;            /* End line number */
84         int                     offset;         /* Start line offset */
85         char                    *path;          /* Real path name */
86         struct list_head        line_list;      /* Visible lines */
87 };
88
89 /* Command string to events */
90 extern void parse_perf_probe_command(const char *cmd,
91                                      struct perf_probe_event *pev);
92 extern void parse_kprobe_trace_command(const char *cmd,
93                                        struct kprobe_trace_event *tev);
94
95 /* Events to command string */
96 extern char *synthesize_perf_probe_command(struct perf_probe_event *pev);
97 extern char *synthesize_kprobe_trace_command(struct kprobe_trace_event *tev);
98 extern int synthesize_perf_probe_arg(struct perf_probe_arg *pa, char *buf,
99                                      size_t len);
100
101 /* Check the perf_probe_event needs debuginfo */
102 extern bool perf_probe_event_need_dwarf(struct perf_probe_event *pev);
103
104 /* Convert from kprobe_trace_event to perf_probe_event */
105 extern void convert_to_perf_probe_event(struct kprobe_trace_event *tev,
106                                         struct perf_probe_event *pev);
107
108 /* Release event contents */
109 extern void clear_perf_probe_event(struct perf_probe_event *pev);
110 extern void clear_kprobe_trace_event(struct kprobe_trace_event *tev);
111
112 /* Command string to line-range */
113 extern void parse_line_range_desc(const char *cmd, struct line_range *lr);
114
115
116 extern void add_perf_probe_events(struct perf_probe_event *pevs, int ntevs,
117                                   bool force_add);
118 extern void del_perf_probe_events(struct strlist *dellist);
119 extern void show_perf_probe_events(void);
120 extern void show_line_range(struct line_range *lr);
121
122
123 /* Maximum index number of event-name postfix */
124 #define MAX_EVENT_INDEX 1024
125
126 #endif /*_PROBE_EVENT_H */