blob: 96efa6794ea5293a59f40638d344005b2497f0bc [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>
Xiao Guangrong430ad5a2010-01-28 09:32:29 +08008#include <linux/perf_event.h>
Steven Rostedt97f20252009-04-13 11:20:49 -04009
10struct trace_array;
11struct tracer;
Steven Rostedt6d723732009-04-10 14:53:50 -040012struct dentry;
Steven Rostedt97f20252009-04-13 11:20:49 -040013
Steven Rostedtbe74b732009-05-26 20:25:22 +020014struct trace_print_flags {
15 unsigned long mask;
16 const char *name;
17};
18
liubo2fc1b6f2011-04-19 09:35:28 +080019struct trace_print_flags_u64 {
20 unsigned long long mask;
21 const char *name;
22};
23
Steven Rostedtbe74b732009-05-26 20:25:22 +020024const char *ftrace_print_flags_seq(struct trace_seq *p, const char *delim,
25 unsigned long flags,
26 const struct trace_print_flags *flag_array);
27
Steven Rostedt0f4fc292009-05-20 19:21:47 -040028const char *ftrace_print_symbols_seq(struct trace_seq *p, unsigned long val,
29 const struct trace_print_flags *symbol_array);
30
liubo2fc1b6f2011-04-19 09:35:28 +080031#if BITS_PER_LONG == 32
32const char *ftrace_print_symbols_seq_u64(struct trace_seq *p,
33 unsigned long long val,
34 const struct trace_print_flags_u64
35 *symbol_array);
36#endif
37
Kei Tokunaga5a2e3992010-04-01 20:40:58 +090038const char *ftrace_print_hex_seq(struct trace_seq *p,
39 const unsigned char *buf, int len);
40
Steven Rostedt97f20252009-04-13 11:20:49 -040041/*
42 * The trace entry - the most basic unit of tracing. This is what
43 * is printed in the end as a single line in the trace output, such as:
44 *
45 * bash-15816 [01] 235.197585: idle_cpu <- irq_enter
46 */
47struct trace_entry {
Steven Rostedt89ec0de2009-03-26 11:03:29 -040048 unsigned short type;
Steven Rostedt97f20252009-04-13 11:20:49 -040049 unsigned char flags;
50 unsigned char preempt_count;
51 int pid;
Arjan van de Vena3a4a5a2011-05-05 23:55:18 -040052 int padding;
Steven Rostedt97f20252009-04-13 11:20:49 -040053};
54
Steven Rostedt89ec0de2009-03-26 11:03:29 -040055#define FTRACE_MAX_EVENT \
56 ((1 << (sizeof(((struct trace_entry *)0)->type) * 8)) - 1)
57
Steven Rostedt97f20252009-04-13 11:20:49 -040058/*
59 * Trace iterator - used by printout routines who present trace
60 * results to users and which routines might sleep, etc:
61 */
62struct trace_iterator {
63 struct trace_array *tr;
64 struct tracer *trace;
65 void *private;
66 int cpu_file;
67 struct mutex mutex;
68 struct ring_buffer_iter *buffer_iter[NR_CPUS];
Steven Rostedt112f38a72009-06-01 15:16:05 -040069 unsigned long iter_flags;
Steven Rostedt97f20252009-04-13 11:20:49 -040070
Lai Jiangshanbc289ae2010-06-03 18:26:24 +080071 /* trace_seq for __print_flags() and __print_symbolic() etc. */
72 struct trace_seq tmp_seq;
73
Steven Rostedt97f20252009-04-13 11:20:49 -040074 /* The below is zeroed out in pipe_read */
75 struct trace_seq seq;
76 struct trace_entry *ent;
Steven Rostedtbc21b472010-03-31 19:49:26 -040077 unsigned long lost_events;
Steven Rostedta63ce5b2009-12-07 09:11:39 -050078 int leftover;
Steven Rostedt4a9bd3f2011-07-14 16:36:53 -040079 int ent_size;
Steven Rostedt97f20252009-04-13 11:20:49 -040080 int cpu;
81 u64 ts;
82
Steven Rostedt97f20252009-04-13 11:20:49 -040083 loff_t pos;
84 long idx;
85
86 cpumask_var_t started;
87};
88
89
Steven Rostedta9a57762010-04-22 18:46:14 -040090struct trace_event;
91
Steven Rostedt97f20252009-04-13 11:20:49 -040092typedef enum print_line_t (*trace_print_func)(struct trace_iterator *iter,
Steven Rostedta9a57762010-04-22 18:46:14 -040093 int flags, struct trace_event *event);
94
95struct trace_event_functions {
Steven Rostedt97f20252009-04-13 11:20:49 -040096 trace_print_func trace;
97 trace_print_func raw;
98 trace_print_func hex;
99 trace_print_func binary;
100};
101
Steven Rostedta9a57762010-04-22 18:46:14 -0400102struct trace_event {
103 struct hlist_node node;
104 struct list_head list;
105 int type;
106 struct trace_event_functions *funcs;
107};
108
Steven Rostedt97f20252009-04-13 11:20:49 -0400109extern int register_ftrace_event(struct trace_event *event);
110extern int unregister_ftrace_event(struct trace_event *event);
111
112/* Return values for print_line callback */
113enum print_line_t {
114 TRACE_TYPE_PARTIAL_LINE = 0, /* Retry after flushing the seq */
115 TRACE_TYPE_HANDLED = 1,
116 TRACE_TYPE_UNHANDLED = 2, /* Relay to other output functions */
117 TRACE_TYPE_NO_CONSUME = 3 /* Handled but ask to not consume */
118};
119
Frederic Weisbeckerf413cdb2009-08-07 01:25:54 +0200120void tracing_generic_entry_update(struct trace_entry *entry,
121 unsigned long flags,
122 int pc);
Steven Rostedt97f20252009-04-13 11:20:49 -0400123struct ring_buffer_event *
Steven Rostedte77405a2009-09-02 14:17:06 -0400124trace_current_buffer_lock_reserve(struct ring_buffer **current_buffer,
125 int type, unsigned long len,
Steven Rostedt97f20252009-04-13 11:20:49 -0400126 unsigned long flags, int pc);
Steven Rostedte77405a2009-09-02 14:17:06 -0400127void trace_current_buffer_unlock_commit(struct ring_buffer *buffer,
128 struct ring_buffer_event *event,
Steven Rostedt97f20252009-04-13 11:20:49 -0400129 unsigned long flags, int pc);
Steven Rostedte77405a2009-09-02 14:17:06 -0400130void trace_nowake_buffer_unlock_commit(struct ring_buffer *buffer,
131 struct ring_buffer_event *event,
Steven Rostedt97f20252009-04-13 11:20:49 -0400132 unsigned long flags, int pc);
Masami Hiramatsu1fd8df22011-06-08 16:09:34 +0900133void trace_nowake_buffer_unlock_commit_regs(struct ring_buffer *buffer,
134 struct ring_buffer_event *event,
135 unsigned long flags, int pc,
136 struct pt_regs *regs);
Steven Rostedte77405a2009-09-02 14:17:06 -0400137void trace_current_buffer_discard_commit(struct ring_buffer *buffer,
138 struct ring_buffer_event *event);
Steven Rostedt97f20252009-04-13 11:20:49 -0400139
140void tracing_record_cmdline(struct task_struct *tsk);
141
Li Zefan1f9963c2009-07-20 10:20:53 +0800142struct event_filter;
143
Steven Rostedt22392912010-04-21 12:27:06 -0400144enum trace_reg {
145 TRACE_REG_REGISTER,
146 TRACE_REG_UNREGISTER,
147 TRACE_REG_PERF_REGISTER,
148 TRACE_REG_PERF_UNREGISTER,
149};
150
151struct ftrace_event_call;
152
Steven Rostedt8f082012010-04-20 10:47:33 -0400153struct ftrace_event_class {
154 char *system;
Steven Rostedt22392912010-04-21 12:27:06 -0400155 void *probe;
156#ifdef CONFIG_PERF_EVENTS
157 void *perf_probe;
158#endif
159 int (*reg)(struct ftrace_event_call *event,
160 enum trace_reg type);
Steven Rostedt2e33af02010-04-22 10:35:55 -0400161 int (*define_fields)(struct ftrace_event_call *);
162 struct list_head *(*get_fields)(struct ftrace_event_call *);
163 struct list_head fields;
Steven Rostedt0405ab82010-04-22 11:46:44 -0400164 int (*raw_init)(struct ftrace_event_call *);
Steven Rostedt8f082012010-04-20 10:47:33 -0400165};
166
Steven Rostedta1d0ce82010-06-08 11:22:06 -0400167extern int ftrace_event_reg(struct ftrace_event_call *event,
168 enum trace_reg type);
169
Steven Rostedt553552c2010-04-23 11:12:36 -0400170enum {
171 TRACE_EVENT_FL_ENABLED_BIT,
172 TRACE_EVENT_FL_FILTERED_BIT,
Li Zefane870e9a2010-07-02 11:07:32 +0800173 TRACE_EVENT_FL_RECORDED_CMD_BIT,
Frederic Weisbecker61c32652010-11-18 01:39:17 +0100174 TRACE_EVENT_FL_CAP_ANY_BIT,
Steven Rostedt553552c2010-04-23 11:12:36 -0400175};
176
177enum {
Li Zefane870e9a2010-07-02 11:07:32 +0800178 TRACE_EVENT_FL_ENABLED = (1 << TRACE_EVENT_FL_ENABLED_BIT),
179 TRACE_EVENT_FL_FILTERED = (1 << TRACE_EVENT_FL_FILTERED_BIT),
180 TRACE_EVENT_FL_RECORDED_CMD = (1 << TRACE_EVENT_FL_RECORDED_CMD_BIT),
Frederic Weisbecker61c32652010-11-18 01:39:17 +0100181 TRACE_EVENT_FL_CAP_ANY = (1 << TRACE_EVENT_FL_CAP_ANY_BIT),
Steven Rostedt553552c2010-04-23 11:12:36 -0400182};
183
Steven Rostedt97f20252009-04-13 11:20:49 -0400184struct ftrace_event_call {
Steven Rostedta59fd602009-04-10 13:52:20 -0400185 struct list_head list;
Steven Rostedt8f082012010-04-20 10:47:33 -0400186 struct ftrace_event_class *class;
Steven Rostedt97f20252009-04-13 11:20:49 -0400187 char *name;
Steven Rostedt97f20252009-04-13 11:20:49 -0400188 struct dentry *dir;
Steven Rostedt80decc72010-04-23 10:00:22 -0400189 struct trace_event event;
Lai Jiangshan509e7602009-12-15 15:39:42 +0800190 const char *print_fmt;
Li Zefan1f9963c2009-07-20 10:20:53 +0800191 struct event_filter *filter;
Steven Rostedt6d723732009-04-10 14:53:50 -0400192 void *mod;
Jason Baron69fd4f02009-08-10 16:52:44 -0400193 void *data;
Steven Rostedt97f20252009-04-13 11:20:49 -0400194
Steven Rostedt553552c2010-04-23 11:12:36 -0400195 /*
196 * 32 bit flags:
197 * bit 1: enabled
198 * bit 2: filter_active
Li Zefane870e9a2010-07-02 11:07:32 +0800199 * bit 3: enabled cmd record
Steven Rostedt553552c2010-04-23 11:12:36 -0400200 *
Steven Rostedt1eaa4782010-05-14 10:19:13 -0400201 * Changes to flags must hold the event_mutex.
202 *
203 * Note: Reads of flags do not hold the event_mutex since
204 * they occur in critical sections. But the way flags
205 * is currently used, these changes do no affect the code
206 * except that when a change is made, it may have a slight
207 * delay in propagating the changes to other CPUs due to
208 * caching and such.
Steven Rostedt553552c2010-04-23 11:12:36 -0400209 */
210 unsigned int flags;
211
Steven Rostedtff5f1492010-05-21 11:49:57 -0400212#ifdef CONFIG_PERF_EVENTS
Namhyung Kim6016ee12010-08-11 12:47:59 +0900213 int perf_refcount;
214 struct hlist_head __percpu *perf_events;
Steven Rostedtff5f1492010-05-21 11:49:57 -0400215#endif
Steven Rostedt97f20252009-04-13 11:20:49 -0400216};
217
Frederic Weisbecker53cf810b2010-11-18 02:11:42 +0100218#define __TRACE_EVENT_FLAGS(name, value) \
219 static int __init trace_init_flags_##name(void) \
220 { \
221 event_##name.flags = value; \
222 return 0; \
223 } \
224 early_initcall(trace_init_flags_##name);
225
Frederic Weisbecker97d5a222010-03-05 05:35:37 +0100226#define PERF_MAX_TRACE_SIZE 2048
Frederic Weisbecker20ab4422009-09-18 06:10:28 +0200227
Steven Rostedt16bb8eb2009-09-12 19:04:54 -0400228#define MAX_FILTER_STR_VAL 256 /* Should handle KSYM_SYMBOL_LEN */
Steven Rostedt97f20252009-04-13 11:20:49 -0400229
Li Zefan2df75e42009-05-06 10:33:04 +0800230extern void destroy_preds(struct ftrace_event_call *call);
Li Zefan6fb29152009-10-15 11:21:42 +0800231extern int filter_match_preds(struct event_filter *filter, void *rec);
Steven Rostedte77405a2009-09-02 14:17:06 -0400232extern int filter_current_check_discard(struct ring_buffer *buffer,
233 struct ftrace_event_call *call,
Steven Rostedt97f20252009-04-13 11:20:49 -0400234 void *rec,
235 struct ring_buffer_event *event);
236
Li Zefan43b51ea2009-08-07 10:33:22 +0800237enum {
238 FILTER_OTHER = 0,
239 FILTER_STATIC_STRING,
240 FILTER_DYN_STRING,
Li Zefan87a342f2009-08-07 10:33:43 +0800241 FILTER_PTR_STRING,
Li Zefan43b51ea2009-08-07 10:33:22 +0800242};
243
Steven Rostedt04295782010-11-12 22:32:11 -0500244#define EVENT_STORAGE_SIZE 128
245extern struct mutex event_storage_mutex;
246extern char event_storage[EVENT_STORAGE_SIZE];
247
Li Zefan87d9b4e2009-12-08 11:14:20 +0800248extern int trace_event_raw_init(struct ftrace_event_call *call);
Frederic Weisbeckeraeaeae12009-08-27 05:09:51 +0200249extern int trace_define_field(struct ftrace_event_call *call, const char *type,
250 const char *name, int offset, int size,
251 int is_signed, int filter_type);
Masami Hiramatsubd1a5c82009-08-13 16:34:53 -0400252extern int trace_add_event_call(struct ftrace_event_call *call);
253extern void trace_remove_event_call(struct ftrace_event_call *call);
Steven Rostedt97f20252009-04-13 11:20:49 -0400254
Tom Zanussia118e4d2009-04-28 03:04:53 -0500255#define is_signed_type(type) (((type)(-1)) < 0)
Steven Rostedt97f20252009-04-13 11:20:49 -0400256
Steven Rostedt4671c792009-05-08 16:27:41 -0400257int trace_set_clr_event(const char *system, const char *event, int set);
258
Steven Rostedt97f20252009-04-13 11:20:49 -0400259/*
260 * The double __builtin_constant_p is because gcc will give us an error
261 * if we try to allocate the static variable to fmt if it is not a
262 * constant. Even with the outer if statement optimizing out.
263 */
264#define event_trace_printk(ip, fmt, args...) \
265do { \
266 __trace_printk_check_format(fmt, ##args); \
267 tracing_record_cmdline(current); \
268 if (__builtin_constant_p(fmt)) { \
269 static const char *trace_printk_fmt \
270 __attribute__((section("__trace_printk_fmt"))) = \
271 __builtin_constant_p(fmt) ? fmt : NULL; \
272 \
273 __trace_bprintk(ip, trace_printk_fmt, ##args); \
274 } else \
275 __trace_printk(ip, fmt, ##args); \
276} while (0)
277
Li Zefan07b139c2009-12-21 14:27:35 +0800278#ifdef CONFIG_PERF_EVENTS
Li Zefan6fb29152009-10-15 11:21:42 +0800279struct perf_event;
Frederic Weisbeckerc5306652010-03-03 07:16:16 +0100280
281DECLARE_PER_CPU(struct pt_regs, perf_trace_regs);
282
Peter Zijlstra1c024eca2010-05-19 14:02:22 +0200283extern int perf_trace_init(struct perf_event *event);
284extern void perf_trace_destroy(struct perf_event *event);
Peter Zijlstraa4eaf7f2010-06-16 14:37:10 +0200285extern int perf_trace_add(struct perf_event *event, int flags);
286extern void perf_trace_del(struct perf_event *event, int flags);
Peter Zijlstra1c024eca2010-05-19 14:02:22 +0200287extern int ftrace_profile_set_filter(struct perf_event *event, int event_id,
Li Zefan6fb29152009-10-15 11:21:42 +0800288 char *filter_str);
289extern void ftrace_profile_free_filter(struct perf_event *event);
Peter Zijlstrab7e2ece2010-05-19 10:52:27 +0200290extern void *perf_trace_buf_prepare(int size, unsigned short type,
291 struct pt_regs *regs, int *rctxp);
Xiao Guangrong430ad5a2010-01-28 09:32:29 +0800292
293static inline void
Frederic Weisbecker97d5a222010-03-05 05:35:37 +0100294perf_trace_buf_submit(void *raw_data, int size, int rctx, u64 addr,
Peter Zijlstra1c024eca2010-05-19 14:02:22 +0200295 u64 count, struct pt_regs *regs, void *head)
Xiao Guangrong430ad5a2010-01-28 09:32:29 +0800296{
Peter Zijlstraecc55f82010-05-21 15:11:34 +0200297 perf_tp_event(addr, count, raw_data, size, regs, head, rctx);
Xiao Guangrong430ad5a2010-01-28 09:32:29 +0800298}
Li Zefan6fb29152009-10-15 11:21:42 +0800299#endif
300
Steven Rostedt97f20252009-04-13 11:20:49 -0400301#endif /* _LINUX_FTRACE_EVENT_H */