blob: 8beabb958f61d5147c8893f1e780415a91fcb2e6 [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 Weisbecker20ab44252009-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
19const 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
Steven Rostedt0f4fc292009-05-20 19:21:47 -040023const char *ftrace_print_symbols_seq(struct trace_seq *p, unsigned long val,
24 const struct trace_print_flags *symbol_array);
25
Kei Tokunaga5a2e3992010-04-01 20:40:58 +090026const char *ftrace_print_hex_seq(struct trace_seq *p,
27 const unsigned char *buf, int len);
28
Steven Rostedt97f20252009-04-13 11:20:49 -040029/*
30 * The trace entry - the most basic unit of tracing. This is what
31 * is printed in the end as a single line in the trace output, such as:
32 *
33 * bash-15816 [01] 235.197585: idle_cpu <- irq_enter
34 */
35struct trace_entry {
Steven Rostedt89ec0de2009-03-26 11:03:29 -040036 unsigned short type;
Steven Rostedt97f20252009-04-13 11:20:49 -040037 unsigned char flags;
38 unsigned char preempt_count;
39 int pid;
Steven Rostedt637e7e82009-09-11 13:55:35 -040040 int lock_depth;
Steven Rostedt97f20252009-04-13 11:20:49 -040041};
42
Steven Rostedt89ec0de2009-03-26 11:03:29 -040043#define FTRACE_MAX_EVENT \
44 ((1 << (sizeof(((struct trace_entry *)0)->type) * 8)) - 1)
45
Steven Rostedt97f20252009-04-13 11:20:49 -040046/*
47 * Trace iterator - used by printout routines who present trace
48 * results to users and which routines might sleep, etc:
49 */
50struct trace_iterator {
51 struct trace_array *tr;
52 struct tracer *trace;
53 void *private;
54 int cpu_file;
55 struct mutex mutex;
56 struct ring_buffer_iter *buffer_iter[NR_CPUS];
Steven Rostedt112f38a72009-06-01 15:16:05 -040057 unsigned long iter_flags;
Steven Rostedt97f20252009-04-13 11:20:49 -040058
Lai Jiangshanbc289ae2010-06-03 18:26:24 +080059 /* trace_seq for __print_flags() and __print_symbolic() etc. */
60 struct trace_seq tmp_seq;
61
Steven Rostedt97f20252009-04-13 11:20:49 -040062 /* The below is zeroed out in pipe_read */
63 struct trace_seq seq;
64 struct trace_entry *ent;
Steven Rostedtbc21b472010-03-31 19:49:26 -040065 unsigned long lost_events;
Steven Rostedta63ce5b2009-12-07 09:11:39 -050066 int leftover;
Steven Rostedt97f20252009-04-13 11:20:49 -040067 int cpu;
68 u64 ts;
69
Steven Rostedt97f20252009-04-13 11:20:49 -040070 loff_t pos;
71 long idx;
72
73 cpumask_var_t started;
74};
75
76
Steven Rostedta9a57762010-04-22 18:46:14 -040077struct trace_event;
78
Steven Rostedt97f20252009-04-13 11:20:49 -040079typedef enum print_line_t (*trace_print_func)(struct trace_iterator *iter,
Steven Rostedta9a57762010-04-22 18:46:14 -040080 int flags, struct trace_event *event);
81
82struct trace_event_functions {
Steven Rostedt97f20252009-04-13 11:20:49 -040083 trace_print_func trace;
84 trace_print_func raw;
85 trace_print_func hex;
86 trace_print_func binary;
87};
88
Steven Rostedta9a57762010-04-22 18:46:14 -040089struct trace_event {
90 struct hlist_node node;
91 struct list_head list;
92 int type;
93 struct trace_event_functions *funcs;
94};
95
Steven Rostedt97f20252009-04-13 11:20:49 -040096extern int register_ftrace_event(struct trace_event *event);
97extern int unregister_ftrace_event(struct trace_event *event);
98
99/* Return values for print_line callback */
100enum print_line_t {
101 TRACE_TYPE_PARTIAL_LINE = 0, /* Retry after flushing the seq */
102 TRACE_TYPE_HANDLED = 1,
103 TRACE_TYPE_UNHANDLED = 2, /* Relay to other output functions */
104 TRACE_TYPE_NO_CONSUME = 3 /* Handled but ask to not consume */
105};
106
Frederic Weisbeckerf413cdb2009-08-07 01:25:54 +0200107void tracing_generic_entry_update(struct trace_entry *entry,
108 unsigned long flags,
109 int pc);
Steven Rostedt97f20252009-04-13 11:20:49 -0400110struct ring_buffer_event *
Steven Rostedte77405a2009-09-02 14:17:06 -0400111trace_current_buffer_lock_reserve(struct ring_buffer **current_buffer,
112 int type, unsigned long len,
Steven Rostedt97f20252009-04-13 11:20:49 -0400113 unsigned long flags, int pc);
Steven Rostedte77405a2009-09-02 14:17:06 -0400114void trace_current_buffer_unlock_commit(struct ring_buffer *buffer,
115 struct ring_buffer_event *event,
Steven Rostedt97f20252009-04-13 11:20:49 -0400116 unsigned long flags, int pc);
Steven Rostedte77405a2009-09-02 14:17:06 -0400117void trace_nowake_buffer_unlock_commit(struct ring_buffer *buffer,
118 struct ring_buffer_event *event,
Steven Rostedt97f20252009-04-13 11:20:49 -0400119 unsigned long flags, int pc);
Steven Rostedte77405a2009-09-02 14:17:06 -0400120void trace_current_buffer_discard_commit(struct ring_buffer *buffer,
121 struct ring_buffer_event *event);
Steven Rostedt97f20252009-04-13 11:20:49 -0400122
123void tracing_record_cmdline(struct task_struct *tsk);
124
Li Zefan1f9963c2009-07-20 10:20:53 +0800125struct event_filter;
126
Steven Rostedt22392912010-04-21 12:27:06 -0400127enum trace_reg {
128 TRACE_REG_REGISTER,
129 TRACE_REG_UNREGISTER,
130 TRACE_REG_PERF_REGISTER,
131 TRACE_REG_PERF_UNREGISTER,
132};
133
134struct ftrace_event_call;
135
Steven Rostedt8f082012010-04-20 10:47:33 -0400136struct ftrace_event_class {
137 char *system;
Steven Rostedt22392912010-04-21 12:27:06 -0400138 void *probe;
139#ifdef CONFIG_PERF_EVENTS
140 void *perf_probe;
141#endif
142 int (*reg)(struct ftrace_event_call *event,
143 enum trace_reg type);
Steven Rostedt2e33af02010-04-22 10:35:55 -0400144 int (*define_fields)(struct ftrace_event_call *);
145 struct list_head *(*get_fields)(struct ftrace_event_call *);
146 struct list_head fields;
Steven Rostedt0405ab82010-04-22 11:46:44 -0400147 int (*raw_init)(struct ftrace_event_call *);
Steven Rostedt8f082012010-04-20 10:47:33 -0400148};
149
Steven Rostedta1d0ce82010-06-08 11:22:06 -0400150extern int ftrace_event_reg(struct ftrace_event_call *event,
151 enum trace_reg type);
152
Steven Rostedt553552c2010-04-23 11:12:36 -0400153enum {
154 TRACE_EVENT_FL_ENABLED_BIT,
155 TRACE_EVENT_FL_FILTERED_BIT,
Li Zefane870e9a2010-07-02 11:07:32 +0800156 TRACE_EVENT_FL_RECORDED_CMD_BIT,
Steven Rostedt553552c2010-04-23 11:12:36 -0400157};
158
159enum {
Li Zefane870e9a2010-07-02 11:07:32 +0800160 TRACE_EVENT_FL_ENABLED = (1 << TRACE_EVENT_FL_ENABLED_BIT),
161 TRACE_EVENT_FL_FILTERED = (1 << TRACE_EVENT_FL_FILTERED_BIT),
162 TRACE_EVENT_FL_RECORDED_CMD = (1 << TRACE_EVENT_FL_RECORDED_CMD_BIT),
Steven Rostedt553552c2010-04-23 11:12:36 -0400163};
164
Steven Rostedt97f20252009-04-13 11:20:49 -0400165struct ftrace_event_call {
Steven Rostedta59fd602009-04-10 13:52:20 -0400166 struct list_head list;
Steven Rostedt8f082012010-04-20 10:47:33 -0400167 struct ftrace_event_class *class;
Steven Rostedt97f20252009-04-13 11:20:49 -0400168 char *name;
Steven Rostedt97f20252009-04-13 11:20:49 -0400169 struct dentry *dir;
Steven Rostedt80decc72010-04-23 10:00:22 -0400170 struct trace_event event;
Lai Jiangshan509e7602009-12-15 15:39:42 +0800171 const char *print_fmt;
Li Zefan1f9963c2009-07-20 10:20:53 +0800172 struct event_filter *filter;
Steven Rostedt6d723732009-04-10 14:53:50 -0400173 void *mod;
Jason Baron69fd4f02009-08-10 16:52:44 -0400174 void *data;
Steven Rostedt97f20252009-04-13 11:20:49 -0400175
Steven Rostedt553552c2010-04-23 11:12:36 -0400176 /*
177 * 32 bit flags:
178 * bit 1: enabled
179 * bit 2: filter_active
Li Zefane870e9a2010-07-02 11:07:32 +0800180 * bit 3: enabled cmd record
Steven Rostedt553552c2010-04-23 11:12:36 -0400181 *
Steven Rostedt1eaa4782010-05-14 10:19:13 -0400182 * Changes to flags must hold the event_mutex.
183 *
184 * Note: Reads of flags do not hold the event_mutex since
185 * they occur in critical sections. But the way flags
186 * is currently used, these changes do no affect the code
187 * except that when a change is made, it may have a slight
188 * delay in propagating the changes to other CPUs due to
189 * caching and such.
Steven Rostedt553552c2010-04-23 11:12:36 -0400190 */
191 unsigned int flags;
192
Steven Rostedtff5f1492010-05-21 11:49:57 -0400193#ifdef CONFIG_PERF_EVENTS
Namhyung Kim6016ee12010-08-11 12:47:59 +0900194 int perf_refcount;
195 struct hlist_head __percpu *perf_events;
Steven Rostedtff5f1492010-05-21 11:49:57 -0400196#endif
Steven Rostedt97f20252009-04-13 11:20:49 -0400197};
198
Frederic Weisbecker97d5a222010-03-05 05:35:37 +0100199#define PERF_MAX_TRACE_SIZE 2048
Frederic Weisbecker20ab44252009-09-18 06:10:28 +0200200
Tom Zanussi8b372562009-04-28 03:04:59 -0500201#define MAX_FILTER_PRED 32
Steven Rostedt16bb8eb2009-09-12 19:04:54 -0400202#define MAX_FILTER_STR_VAL 256 /* Should handle KSYM_SYMBOL_LEN */
Steven Rostedt97f20252009-04-13 11:20:49 -0400203
Li Zefan2df75e42009-05-06 10:33:04 +0800204extern void destroy_preds(struct ftrace_event_call *call);
Li Zefan6fb29152009-10-15 11:21:42 +0800205extern int filter_match_preds(struct event_filter *filter, void *rec);
Steven Rostedte77405a2009-09-02 14:17:06 -0400206extern int filter_current_check_discard(struct ring_buffer *buffer,
207 struct ftrace_event_call *call,
Steven Rostedt97f20252009-04-13 11:20:49 -0400208 void *rec,
209 struct ring_buffer_event *event);
210
Li Zefan43b51ea2009-08-07 10:33:22 +0800211enum {
212 FILTER_OTHER = 0,
213 FILTER_STATIC_STRING,
214 FILTER_DYN_STRING,
Li Zefan87a342f2009-08-07 10:33:43 +0800215 FILTER_PTR_STRING,
Li Zefan43b51ea2009-08-07 10:33:22 +0800216};
217
Li Zefan87d9b4e2009-12-08 11:14:20 +0800218extern int trace_event_raw_init(struct ftrace_event_call *call);
Frederic Weisbeckeraeaeae12009-08-27 05:09:51 +0200219extern int trace_define_field(struct ftrace_event_call *call, const char *type,
220 const char *name, int offset, int size,
221 int is_signed, int filter_type);
Masami Hiramatsubd1a5c82009-08-13 16:34:53 -0400222extern int trace_add_event_call(struct ftrace_event_call *call);
223extern void trace_remove_event_call(struct ftrace_event_call *call);
Steven Rostedt97f20252009-04-13 11:20:49 -0400224
Tom Zanussia118e4d2009-04-28 03:04:53 -0500225#define is_signed_type(type) (((type)(-1)) < 0)
Steven Rostedt97f20252009-04-13 11:20:49 -0400226
Steven Rostedt4671c792009-05-08 16:27:41 -0400227int trace_set_clr_event(const char *system, const char *event, int set);
228
Steven Rostedt97f20252009-04-13 11:20:49 -0400229/*
230 * The double __builtin_constant_p is because gcc will give us an error
231 * if we try to allocate the static variable to fmt if it is not a
232 * constant. Even with the outer if statement optimizing out.
233 */
234#define event_trace_printk(ip, fmt, args...) \
235do { \
236 __trace_printk_check_format(fmt, ##args); \
237 tracing_record_cmdline(current); \
238 if (__builtin_constant_p(fmt)) { \
239 static const char *trace_printk_fmt \
240 __attribute__((section("__trace_printk_fmt"))) = \
241 __builtin_constant_p(fmt) ? fmt : NULL; \
242 \
243 __trace_bprintk(ip, trace_printk_fmt, ##args); \
244 } else \
245 __trace_printk(ip, fmt, ##args); \
246} while (0)
247
Li Zefan07b139c2009-12-21 14:27:35 +0800248#ifdef CONFIG_PERF_EVENTS
Li Zefan6fb29152009-10-15 11:21:42 +0800249struct perf_event;
Frederic Weisbeckerc5306652010-03-03 07:16:16 +0100250
251DECLARE_PER_CPU(struct pt_regs, perf_trace_regs);
252
Peter Zijlstra1c024eca2010-05-19 14:02:22 +0200253extern int perf_trace_init(struct perf_event *event);
254extern void perf_trace_destroy(struct perf_event *event);
Peter Zijlstraa4eaf7f2010-06-16 14:37:10 +0200255extern int perf_trace_add(struct perf_event *event, int flags);
256extern void perf_trace_del(struct perf_event *event, int flags);
Peter Zijlstra1c024eca2010-05-19 14:02:22 +0200257extern int ftrace_profile_set_filter(struct perf_event *event, int event_id,
Li Zefan6fb29152009-10-15 11:21:42 +0800258 char *filter_str);
259extern void ftrace_profile_free_filter(struct perf_event *event);
Peter Zijlstrab7e2ece2010-05-19 10:52:27 +0200260extern void *perf_trace_buf_prepare(int size, unsigned short type,
261 struct pt_regs *regs, int *rctxp);
Xiao Guangrong430ad5a2010-01-28 09:32:29 +0800262
263static inline void
Frederic Weisbecker97d5a222010-03-05 05:35:37 +0100264perf_trace_buf_submit(void *raw_data, int size, int rctx, u64 addr,
Peter Zijlstra1c024eca2010-05-19 14:02:22 +0200265 u64 count, struct pt_regs *regs, void *head)
Xiao Guangrong430ad5a2010-01-28 09:32:29 +0800266{
Peter Zijlstraecc55f82010-05-21 15:11:34 +0200267 perf_tp_event(addr, count, raw_data, size, regs, head, rctx);
Xiao Guangrong430ad5a2010-01-28 09:32:29 +0800268}
Li Zefan6fb29152009-10-15 11:21:42 +0800269#endif
270
Steven Rostedt97f20252009-04-13 11:20:49 -0400271#endif /* _LINUX_FTRACE_EVENT_H */