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