blob: 0440bea8f6bb678e620faa922ee43afa598d35ec [file] [log] [blame]
Steven Rostedt97f20252009-04-13 11:20:49 -04001#ifndef _LINUX_FTRACE_EVENT_H
2#define _LINUX_FTRACE_EVENT_H
3
4#include <linux/trace_seq.h>
5#include <linux/ring_buffer.h>
Steven Rostedtbe74b732009-05-26 20:25:22 +02006#include <linux/percpu.h>
Steven Rostedt97f20252009-04-13 11:20:49 -04007
8struct trace_array;
9struct tracer;
Steven Rostedt6d723732009-04-10 14:53:50 -040010struct dentry;
Steven Rostedt97f20252009-04-13 11:20:49 -040011
Steven Rostedtbe74b732009-05-26 20:25:22 +020012DECLARE_PER_CPU(struct trace_seq, ftrace_event_seq);
13
14struct 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
Steven Rostedt97f20252009-04-13 11:20:49 -040026/*
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 */
32struct trace_entry {
Steven Rostedt89ec0de2009-03-26 11:03:29 -040033 unsigned short type;
Steven Rostedt97f20252009-04-13 11:20:49 -040034 unsigned char flags;
35 unsigned char preempt_count;
36 int pid;
37 int tgid;
38};
39
Steven Rostedt89ec0de2009-03-26 11:03:29 -040040#define FTRACE_MAX_EVENT \
41 ((1 << (sizeof(((struct trace_entry *)0)->type) * 8)) - 1)
42
Steven Rostedt97f20252009-04-13 11:20:49 -040043/*
44 * Trace iterator - used by printout routines who present trace
45 * results to users and which routines might sleep, etc:
46 */
47struct 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];
Steven Rostedt112f38a72009-06-01 15:16:05 -040054 unsigned long iter_flags;
Steven Rostedt97f20252009-04-13 11:20:49 -040055
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
Steven Rostedt97f20252009-04-13 11:20:49 -040062 loff_t pos;
63 long idx;
64
65 cpumask_var_t started;
66};
67
68
69typedef enum print_line_t (*trace_print_func)(struct trace_iterator *iter,
70 int flags);
71struct trace_event {
72 struct hlist_node node;
Steven Rostedt060fa5c82009-04-24 12:20:52 -040073 struct list_head list;
Steven Rostedt97f20252009-04-13 11:20:49 -040074 int type;
75 trace_print_func trace;
76 trace_print_func raw;
77 trace_print_func hex;
78 trace_print_func binary;
79};
80
81extern int register_ftrace_event(struct trace_event *event);
82extern int unregister_ftrace_event(struct trace_event *event);
83
84/* Return values for print_line callback */
85enum 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
Frederic Weisbeckerf413cdb2009-08-07 01:25:54 +020092void tracing_generic_entry_update(struct trace_entry *entry,
93 unsigned long flags,
94 int pc);
Steven Rostedt97f20252009-04-13 11:20:49 -040095struct ring_buffer_event *
Li Zefan7a4f4532009-04-22 16:53:34 +080096trace_current_buffer_lock_reserve(int type, unsigned long len,
Steven Rostedt97f20252009-04-13 11:20:49 -040097 unsigned long flags, int pc);
98void trace_current_buffer_unlock_commit(struct ring_buffer_event *event,
99 unsigned long flags, int pc);
100void trace_nowake_buffer_unlock_commit(struct ring_buffer_event *event,
101 unsigned long flags, int pc);
102void trace_current_buffer_discard_commit(struct ring_buffer_event *event);
103
104void tracing_record_cmdline(struct task_struct *tsk);
105
Li Zefan1f9963c2009-07-20 10:20:53 +0800106struct event_filter;
107
Steven Rostedt97f20252009-04-13 11:20:49 -0400108struct ftrace_event_call {
Steven Rostedta59fd602009-04-10 13:52:20 -0400109 struct list_head list;
Steven Rostedt97f20252009-04-13 11:20:49 -0400110 char *name;
111 char *system;
112 struct dentry *dir;
Steven Rostedt6d723732009-04-10 14:53:50 -0400113 struct trace_event *event;
Steven Rostedt97f20252009-04-13 11:20:49 -0400114 int enabled;
Jason Baron69fd4f02009-08-10 16:52:44 -0400115 int (*regfunc)(void *);
116 void (*unregfunc)(void *);
Steven Rostedt97f20252009-04-13 11:20:49 -0400117 int id;
118 int (*raw_init)(void);
Frederic Weisbeckere8f9f4d2009-08-11 17:42:52 +0200119 int (*show_format)(struct ftrace_event_call *call,
120 struct trace_seq *s);
Li Zefan14be96c2009-08-19 15:53:52 +0800121 int (*define_fields)(struct ftrace_event_call *);
Steven Rostedt97f20252009-04-13 11:20:49 -0400122 struct list_head fields;
Tom Zanussi30e673b2009-04-28 03:04:47 -0500123 int filter_active;
Li Zefan1f9963c2009-07-20 10:20:53 +0800124 struct event_filter *filter;
Steven Rostedt6d723732009-04-10 14:53:50 -0400125 void *mod;
Jason Baron69fd4f02009-08-10 16:52:44 -0400126 void *data;
Steven Rostedt97f20252009-04-13 11:20:49 -0400127
Peter Zijlstraaf6af302009-08-05 20:41:04 +0200128 atomic_t profile_count;
129 int (*profile_enable)(struct ftrace_event_call *);
130 void (*profile_disable)(struct ftrace_event_call *);
Steven Rostedt97f20252009-04-13 11:20:49 -0400131};
132
Tom Zanussi8b372562009-04-28 03:04:59 -0500133#define MAX_FILTER_PRED 32
Steven Rostedt97f20252009-04-13 11:20:49 -0400134#define MAX_FILTER_STR_VAL 128
135
136extern int init_preds(struct ftrace_event_call *call);
Li Zefan2df75e42009-05-06 10:33:04 +0800137extern void destroy_preds(struct ftrace_event_call *call);
Steven Rostedt97f20252009-04-13 11:20:49 -0400138extern int filter_match_preds(struct ftrace_event_call *call, void *rec);
139extern int filter_current_check_discard(struct ftrace_event_call *call,
140 void *rec,
141 struct ring_buffer_event *event);
142
Li Zefan43b51ea2009-08-07 10:33:22 +0800143enum {
144 FILTER_OTHER = 0,
145 FILTER_STATIC_STRING,
146 FILTER_DYN_STRING,
147};
148
Li Zefan540b7b82009-08-19 15:54:51 +0800149extern int trace_define_field(struct ftrace_event_call *call,
150 const char *type, const char *name,
Li Zefan43b51ea2009-08-07 10:33:22 +0800151 int offset, int size, int is_signed,
152 int filter_type);
Li Zefane647d6b2009-08-19 15:54:32 +0800153extern int trace_define_common_fields(struct ftrace_event_call *call);
Steven Rostedt97f20252009-04-13 11:20:49 -0400154
Tom Zanussia118e4d2009-04-28 03:04:53 -0500155#define is_signed_type(type) (((type)(-1)) < 0)
Steven Rostedt97f20252009-04-13 11:20:49 -0400156
Steven Rostedt4671c792009-05-08 16:27:41 -0400157int trace_set_clr_event(const char *system, const char *event, int set);
158
Steven Rostedt97f20252009-04-13 11:20:49 -0400159/*
160 * The double __builtin_constant_p is because gcc will give us an error
161 * if we try to allocate the static variable to fmt if it is not a
162 * constant. Even with the outer if statement optimizing out.
163 */
164#define event_trace_printk(ip, fmt, args...) \
165do { \
166 __trace_printk_check_format(fmt, ##args); \
167 tracing_record_cmdline(current); \
168 if (__builtin_constant_p(fmt)) { \
169 static const char *trace_printk_fmt \
170 __attribute__((section("__trace_printk_fmt"))) = \
171 __builtin_constant_p(fmt) ? fmt : NULL; \
172 \
173 __trace_bprintk(ip, trace_printk_fmt, ##args); \
174 } else \
175 __trace_printk(ip, fmt, ##args); \
176} while (0)
177
Steven Rostedt97f20252009-04-13 11:20:49 -0400178#endif /* _LINUX_FTRACE_EVENT_H */