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