c3c5aaaae53affdd98483def3fbabee5672b5814
[safe/jmp/linux-2.6] / include / linux / ftrace_event.h
1 #ifndef _LINUX_FTRACE_EVENT_H
2 #define _LINUX_FTRACE_EVENT_H
3
4 #include <linux/ring_buffer.h>
5 #include <linux/trace_seq.h>
6 #include <linux/percpu.h>
7 #include <linux/hardirq.h>
8 #include <linux/perf_event.h>
9
10 struct trace_array;
11 struct tracer;
12 struct dentry;
13
14 DECLARE_PER_CPU(struct trace_seq, ftrace_event_seq);
15
16 struct trace_print_flags {
17         unsigned long           mask;
18         const char              *name;
19 };
20
21 const char *ftrace_print_flags_seq(struct trace_seq *p, const char *delim,
22                                    unsigned long flags,
23                                    const struct trace_print_flags *flag_array);
24
25 const char *ftrace_print_symbols_seq(struct trace_seq *p, unsigned long val,
26                                      const struct trace_print_flags *symbol_array);
27
28 const char *ftrace_print_hex_seq(struct trace_seq *p,
29                                  const unsigned char *buf, int len);
30
31 /*
32  * The trace entry - the most basic unit of tracing. This is what
33  * is printed in the end as a single line in the trace output, such as:
34  *
35  *     bash-15816 [01]   235.197585: idle_cpu <- irq_enter
36  */
37 struct trace_entry {
38         unsigned short          type;
39         unsigned char           flags;
40         unsigned char           preempt_count;
41         int                     pid;
42         int                     lock_depth;
43 };
44
45 #define FTRACE_MAX_EVENT                                                \
46         ((1 << (sizeof(((struct trace_entry *)0)->type) * 8)) - 1)
47
48 /*
49  * Trace iterator - used by printout routines who present trace
50  * results to users and which routines might sleep, etc:
51  */
52 struct trace_iterator {
53         struct trace_array      *tr;
54         struct tracer           *trace;
55         void                    *private;
56         int                     cpu_file;
57         struct mutex            mutex;
58         struct ring_buffer_iter *buffer_iter[NR_CPUS];
59         unsigned long           iter_flags;
60
61         /* The below is zeroed out in pipe_read */
62         struct trace_seq        seq;
63         struct trace_entry      *ent;
64         int                     leftover;
65         int                     cpu;
66         u64                     ts;
67
68         loff_t                  pos;
69         long                    idx;
70
71         cpumask_var_t           started;
72 };
73
74
75 typedef enum print_line_t (*trace_print_func)(struct trace_iterator *iter,
76                                               int flags);
77 struct trace_event {
78         struct hlist_node       node;
79         struct list_head        list;
80         int                     type;
81         trace_print_func        trace;
82         trace_print_func        raw;
83         trace_print_func        hex;
84         trace_print_func        binary;
85 };
86
87 extern int register_ftrace_event(struct trace_event *event);
88 extern int unregister_ftrace_event(struct trace_event *event);
89
90 /* Return values for print_line callback */
91 enum print_line_t {
92         TRACE_TYPE_PARTIAL_LINE = 0,    /* Retry after flushing the seq */
93         TRACE_TYPE_HANDLED      = 1,
94         TRACE_TYPE_UNHANDLED    = 2,    /* Relay to other output functions */
95         TRACE_TYPE_NO_CONSUME   = 3     /* Handled but ask to not consume */
96 };
97
98 void tracing_generic_entry_update(struct trace_entry *entry,
99                                   unsigned long flags,
100                                   int pc);
101 struct ring_buffer_event *
102 trace_current_buffer_lock_reserve(struct ring_buffer **current_buffer,
103                                   int type, unsigned long len,
104                                   unsigned long flags, int pc);
105 void trace_current_buffer_unlock_commit(struct ring_buffer *buffer,
106                                         struct ring_buffer_event *event,
107                                         unsigned long flags, int pc);
108 void trace_nowake_buffer_unlock_commit(struct ring_buffer *buffer,
109                                        struct ring_buffer_event *event,
110                                         unsigned long flags, int pc);
111 void trace_current_buffer_discard_commit(struct ring_buffer *buffer,
112                                          struct ring_buffer_event *event);
113
114 void tracing_record_cmdline(struct task_struct *tsk);
115
116 struct event_filter;
117
118 struct ftrace_event_call {
119         struct list_head        list;
120         char                    *name;
121         char                    *system;
122         struct dentry           *dir;
123         struct trace_event      *event;
124         int                     enabled;
125         int                     (*regfunc)(struct ftrace_event_call *);
126         void                    (*unregfunc)(struct ftrace_event_call *);
127         int                     id;
128         const char              *print_fmt;
129         int                     (*raw_init)(struct ftrace_event_call *);
130         int                     (*define_fields)(struct ftrace_event_call *);
131         struct list_head        fields;
132         int                     filter_active;
133         struct event_filter     *filter;
134         void                    *mod;
135         void                    *data;
136
137         int                     perf_refcount;
138         int                     (*perf_event_enable)(struct ftrace_event_call *);
139         void                    (*perf_event_disable)(struct ftrace_event_call *);
140 };
141
142 #define PERF_MAX_TRACE_SIZE     2048
143
144 #define MAX_FILTER_PRED         32
145 #define MAX_FILTER_STR_VAL      256     /* Should handle KSYM_SYMBOL_LEN */
146
147 extern void destroy_preds(struct ftrace_event_call *call);
148 extern int filter_match_preds(struct event_filter *filter, void *rec);
149 extern int filter_current_check_discard(struct ring_buffer *buffer,
150                                         struct ftrace_event_call *call,
151                                         void *rec,
152                                         struct ring_buffer_event *event);
153
154 enum {
155         FILTER_OTHER = 0,
156         FILTER_STATIC_STRING,
157         FILTER_DYN_STRING,
158         FILTER_PTR_STRING,
159 };
160
161 extern int trace_event_raw_init(struct ftrace_event_call *call);
162 extern int trace_define_field(struct ftrace_event_call *call, const char *type,
163                               const char *name, int offset, int size,
164                               int is_signed, int filter_type);
165 extern int trace_add_event_call(struct ftrace_event_call *call);
166 extern void trace_remove_event_call(struct ftrace_event_call *call);
167
168 #define is_signed_type(type)    (((type)(-1)) < 0)
169
170 int trace_set_clr_event(const char *system, const char *event, int set);
171
172 /*
173  * The double __builtin_constant_p is because gcc will give us an error
174  * if we try to allocate the static variable to fmt if it is not a
175  * constant. Even with the outer if statement optimizing out.
176  */
177 #define event_trace_printk(ip, fmt, args...)                            \
178 do {                                                                    \
179         __trace_printk_check_format(fmt, ##args);                       \
180         tracing_record_cmdline(current);                                \
181         if (__builtin_constant_p(fmt)) {                                \
182                 static const char *trace_printk_fmt                     \
183                   __attribute__((section("__trace_printk_fmt"))) =      \
184                         __builtin_constant_p(fmt) ? fmt : NULL;         \
185                                                                         \
186                 __trace_bprintk(ip, trace_printk_fmt, ##args);          \
187         } else                                                          \
188                 __trace_printk(ip, fmt, ##args);                        \
189 } while (0)
190
191 #ifdef CONFIG_PERF_EVENTS
192 struct perf_event;
193
194 DECLARE_PER_CPU(struct pt_regs, perf_trace_regs);
195
196 extern int perf_trace_enable(int event_id);
197 extern void perf_trace_disable(int event_id);
198 extern int ftrace_profile_set_filter(struct perf_event *event, int event_id,
199                                      char *filter_str);
200 extern void ftrace_profile_free_filter(struct perf_event *event);
201 extern void *
202 perf_trace_buf_prepare(int size, unsigned short type, int *rctxp,
203                          unsigned long *irq_flags);
204
205 static inline void
206 perf_trace_buf_submit(void *raw_data, int size, int rctx, u64 addr,
207                        u64 count, unsigned long irq_flags, struct pt_regs *regs)
208 {
209         struct trace_entry *entry = raw_data;
210
211         perf_tp_event(entry->type, addr, count, raw_data, size, regs);
212         perf_swevent_put_recursion_context(rctx);
213         local_irq_restore(irq_flags);
214 }
215 #endif
216
217 #endif /* _LINUX_FTRACE_EVENT_H */