blob: 2233c98d80df5f473ba2f8616f8f3b55e6afd0a4 [file] [log] [blame]
Steven Rostedt97f20252009-04-13 11:20:49 -04001#ifndef _LINUX_FTRACE_EVENT_H
2#define _LINUX_FTRACE_EVENT_H
3
Steven Rostedt97f20252009-04-13 11:20:49 -04004#include <linux/ring_buffer.h>
Steven Rostedt16bb8eb2009-09-12 19:04:54 -04005#include <linux/trace_seq.h>
Steven Rostedtbe74b732009-05-26 20:25:22 +02006#include <linux/percpu.h>
Frederic Weisbecker20ab4422009-09-18 06:10:28 +02007#include <linux/hardirq.h>
Steven Rostedt97f20252009-04-13 11:20:49 -04008
9struct trace_array;
10struct tracer;
Steven Rostedt6d723732009-04-10 14:53:50 -040011struct dentry;
Steven Rostedt97f20252009-04-13 11:20:49 -040012
Steven Rostedtbe74b732009-05-26 20:25:22 +020013DECLARE_PER_CPU(struct trace_seq, ftrace_event_seq);
14
15struct trace_print_flags {
16 unsigned long mask;
17 const char *name;
18};
19
20const 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
Steven Rostedt0f4fc292009-05-20 19:21:47 -040024const char *ftrace_print_symbols_seq(struct trace_seq *p, unsigned long val,
25 const struct trace_print_flags *symbol_array);
26
Steven Rostedt97f20252009-04-13 11:20:49 -040027/*
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 */
33struct trace_entry {
Steven Rostedt89ec0de2009-03-26 11:03:29 -040034 unsigned short type;
Steven Rostedt97f20252009-04-13 11:20:49 -040035 unsigned char flags;
36 unsigned char preempt_count;
37 int pid;
Steven Rostedt637e7e82009-09-11 13:55:35 -040038 int lock_depth;
Steven Rostedt97f20252009-04-13 11:20:49 -040039};
40
Steven Rostedt89ec0de2009-03-26 11:03:29 -040041#define FTRACE_MAX_EVENT \
42 ((1 << (sizeof(((struct trace_entry *)0)->type) * 8)) - 1)
43
Steven Rostedt97f20252009-04-13 11:20:49 -040044/*
45 * Trace iterator - used by printout routines who present trace
46 * results to users and which routines might sleep, etc:
47 */
48struct 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];
Steven Rostedt112f38a72009-06-01 15:16:05 -040055 unsigned long iter_flags;
Steven Rostedt97f20252009-04-13 11:20:49 -040056
57 /* The below is zeroed out in pipe_read */
58 struct trace_seq seq;
59 struct trace_entry *ent;
Steven Rostedta63ce5b2009-12-07 09:11:39 -050060 int leftover;
Steven Rostedt97f20252009-04-13 11:20:49 -040061 int cpu;
62 u64 ts;
63
Steven Rostedt97f20252009-04-13 11:20:49 -040064 loff_t pos;
65 long idx;
66
67 cpumask_var_t started;
68};
69
70
71typedef enum print_line_t (*trace_print_func)(struct trace_iterator *iter,
72 int flags);
73struct trace_event {
74 struct hlist_node node;
Steven Rostedt060fa5c82009-04-24 12:20:52 -040075 struct list_head list;
Steven Rostedt97f20252009-04-13 11:20:49 -040076 int type;
77 trace_print_func trace;
78 trace_print_func raw;
79 trace_print_func hex;
80 trace_print_func binary;
81};
82
83extern int register_ftrace_event(struct trace_event *event);
84extern int unregister_ftrace_event(struct trace_event *event);
85
86/* Return values for print_line callback */
87enum 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
Frederic Weisbeckerf413cdb2009-08-07 01:25:54 +020094void tracing_generic_entry_update(struct trace_entry *entry,
95 unsigned long flags,
96 int pc);
Steven Rostedt97f20252009-04-13 11:20:49 -040097struct ring_buffer_event *
Steven Rostedte77405a2009-09-02 14:17:06 -040098trace_current_buffer_lock_reserve(struct ring_buffer **current_buffer,
99 int type, unsigned long len,
Steven Rostedt97f20252009-04-13 11:20:49 -0400100 unsigned long flags, int pc);
Steven Rostedte77405a2009-09-02 14:17:06 -0400101void trace_current_buffer_unlock_commit(struct ring_buffer *buffer,
102 struct ring_buffer_event *event,
Steven Rostedt97f20252009-04-13 11:20:49 -0400103 unsigned long flags, int pc);
Steven Rostedte77405a2009-09-02 14:17:06 -0400104void trace_nowake_buffer_unlock_commit(struct ring_buffer *buffer,
105 struct ring_buffer_event *event,
Steven Rostedt97f20252009-04-13 11:20:49 -0400106 unsigned long flags, int pc);
Steven Rostedte77405a2009-09-02 14:17:06 -0400107void trace_current_buffer_discard_commit(struct ring_buffer *buffer,
108 struct ring_buffer_event *event);
Steven Rostedt97f20252009-04-13 11:20:49 -0400109
110void tracing_record_cmdline(struct task_struct *tsk);
111
Li Zefan1f9963c2009-07-20 10:20:53 +0800112struct event_filter;
113
Steven Rostedt97f20252009-04-13 11:20:49 -0400114struct ftrace_event_call {
Steven Rostedta59fd602009-04-10 13:52:20 -0400115 struct list_head list;
Steven Rostedt97f20252009-04-13 11:20:49 -0400116 char *name;
117 char *system;
118 struct dentry *dir;
Steven Rostedt6d723732009-04-10 14:53:50 -0400119 struct trace_event *event;
Steven Rostedt97f20252009-04-13 11:20:49 -0400120 int enabled;
Masami Hiramatsubd1a5c82009-08-13 16:34:53 -0400121 int (*regfunc)(struct ftrace_event_call *);
122 void (*unregfunc)(struct ftrace_event_call *);
Steven Rostedt97f20252009-04-13 11:20:49 -0400123 int id;
Masami Hiramatsubd1a5c82009-08-13 16:34:53 -0400124 int (*raw_init)(struct ftrace_event_call *);
125 int (*show_format)(struct ftrace_event_call *,
126 struct trace_seq *);
Li Zefan14be96c2009-08-19 15:53:52 +0800127 int (*define_fields)(struct ftrace_event_call *);
Steven Rostedt97f20252009-04-13 11:20:49 -0400128 struct list_head fields;
Tom Zanussi30e673b2009-04-28 03:04:47 -0500129 int filter_active;
Li Zefan1f9963c2009-07-20 10:20:53 +0800130 struct event_filter *filter;
Steven Rostedt6d723732009-04-10 14:53:50 -0400131 void *mod;
Jason Baron69fd4f02009-08-10 16:52:44 -0400132 void *data;
Steven Rostedt97f20252009-04-13 11:20:49 -0400133
Li Zefane00bf2e2009-12-08 11:17:29 +0800134 int profile_count;
Peter Zijlstraaf6af302009-08-05 20:41:04 +0200135 int (*profile_enable)(struct ftrace_event_call *);
136 void (*profile_disable)(struct ftrace_event_call *);
Steven Rostedt97f20252009-04-13 11:20:49 -0400137};
138
Frederic Weisbecker20ab4422009-09-18 06:10:28 +0200139#define FTRACE_MAX_PROFILE_SIZE 2048
140
Frederic Weisbeckerce71b9d2009-11-22 05:26:55 +0100141extern char *perf_trace_buf;
142extern char *perf_trace_buf_nmi;
Frederic Weisbecker20ab4422009-09-18 06:10:28 +0200143
Tom Zanussi8b372562009-04-28 03:04:59 -0500144#define MAX_FILTER_PRED 32
Steven Rostedt16bb8eb2009-09-12 19:04:54 -0400145#define MAX_FILTER_STR_VAL 256 /* Should handle KSYM_SYMBOL_LEN */
Steven Rostedt97f20252009-04-13 11:20:49 -0400146
Li Zefan2df75e42009-05-06 10:33:04 +0800147extern void destroy_preds(struct ftrace_event_call *call);
Li Zefan6fb29152009-10-15 11:21:42 +0800148extern int filter_match_preds(struct event_filter *filter, void *rec);
Steven Rostedte77405a2009-09-02 14:17:06 -0400149extern int filter_current_check_discard(struct ring_buffer *buffer,
150 struct ftrace_event_call *call,
Steven Rostedt97f20252009-04-13 11:20:49 -0400151 void *rec,
152 struct ring_buffer_event *event);
153
Li Zefan43b51ea2009-08-07 10:33:22 +0800154enum {
155 FILTER_OTHER = 0,
156 FILTER_STATIC_STRING,
157 FILTER_DYN_STRING,
Li Zefan87a342f2009-08-07 10:33:43 +0800158 FILTER_PTR_STRING,
Li Zefan43b51ea2009-08-07 10:33:22 +0800159};
160
Li Zefan87d9b4e2009-12-08 11:14:20 +0800161extern int trace_event_raw_init(struct ftrace_event_call *call);
Frederic Weisbeckeraeaeae12009-08-27 05:09:51 +0200162extern 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);
Masami Hiramatsubd1a5c82009-08-13 16:34:53 -0400165extern int trace_add_event_call(struct ftrace_event_call *call);
166extern void trace_remove_event_call(struct ftrace_event_call *call);
Steven Rostedt97f20252009-04-13 11:20:49 -0400167
Tom Zanussia118e4d2009-04-28 03:04:53 -0500168#define is_signed_type(type) (((type)(-1)) < 0)
Steven Rostedt97f20252009-04-13 11:20:49 -0400169
Steven Rostedt4671c792009-05-08 16:27:41 -0400170int trace_set_clr_event(const char *system, const char *event, int set);
171
Steven Rostedt97f20252009-04-13 11:20:49 -0400172/*
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...) \
178do { \
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
Li Zefan6fb29152009-10-15 11:21:42 +0800191#ifdef CONFIG_EVENT_PROFILE
192struct perf_event;
193extern int ftrace_profile_enable(int event_id);
194extern void ftrace_profile_disable(int event_id);
195extern int ftrace_profile_set_filter(struct perf_event *event, int event_id,
196 char *filter_str);
197extern void ftrace_profile_free_filter(struct perf_event *event);
198#endif
199
Steven Rostedt97f20252009-04-13 11:20:49 -0400200#endif /* _LINUX_FTRACE_EVENT_H */