blob: 5fff40c9ff59cae47083d9b265a87efc4df42bde [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>
6
7
8struct trace_array;
9struct tracer;
Steven Rostedt6d723732009-04-10 14:53:50 -040010struct dentry;
Steven Rostedt97f20252009-04-13 11:20:49 -040011
12/*
13 * The trace entry - the most basic unit of tracing. This is what
14 * is printed in the end as a single line in the trace output, such as:
15 *
16 * bash-15816 [01] 235.197585: idle_cpu <- irq_enter
17 */
18struct trace_entry {
Steven Rostedt89ec0de2009-03-26 11:03:29 -040019 unsigned short type;
Steven Rostedt97f20252009-04-13 11:20:49 -040020 unsigned char flags;
21 unsigned char preempt_count;
22 int pid;
23 int tgid;
24};
25
Steven Rostedt89ec0de2009-03-26 11:03:29 -040026#define FTRACE_MAX_EVENT \
27 ((1 << (sizeof(((struct trace_entry *)0)->type) * 8)) - 1)
28
Steven Rostedt97f20252009-04-13 11:20:49 -040029/*
30 * Trace iterator - used by printout routines who present trace
31 * results to users and which routines might sleep, etc:
32 */
33struct trace_iterator {
34 struct trace_array *tr;
35 struct tracer *trace;
36 void *private;
37 int cpu_file;
38 struct mutex mutex;
39 struct ring_buffer_iter *buffer_iter[NR_CPUS];
40
41 /* The below is zeroed out in pipe_read */
42 struct trace_seq seq;
43 struct trace_entry *ent;
44 int cpu;
45 u64 ts;
46
47 unsigned long iter_flags;
48 loff_t pos;
49 long idx;
50
51 cpumask_var_t started;
52};
53
54
55typedef enum print_line_t (*trace_print_func)(struct trace_iterator *iter,
56 int flags);
57struct trace_event {
58 struct hlist_node node;
Steven Rostedt060fa5c82009-04-24 12:20:52 -040059 struct list_head list;
Steven Rostedt97f20252009-04-13 11:20:49 -040060 int type;
61 trace_print_func trace;
62 trace_print_func raw;
63 trace_print_func hex;
64 trace_print_func binary;
65};
66
67extern int register_ftrace_event(struct trace_event *event);
68extern int unregister_ftrace_event(struct trace_event *event);
69
70/* Return values for print_line callback */
71enum print_line_t {
72 TRACE_TYPE_PARTIAL_LINE = 0, /* Retry after flushing the seq */
73 TRACE_TYPE_HANDLED = 1,
74 TRACE_TYPE_UNHANDLED = 2, /* Relay to other output functions */
75 TRACE_TYPE_NO_CONSUME = 3 /* Handled but ask to not consume */
76};
77
78
79struct ring_buffer_event *
Li Zefan7a4f4532009-04-22 16:53:34 +080080trace_current_buffer_lock_reserve(int type, unsigned long len,
Steven Rostedt97f20252009-04-13 11:20:49 -040081 unsigned long flags, int pc);
82void trace_current_buffer_unlock_commit(struct ring_buffer_event *event,
83 unsigned long flags, int pc);
84void trace_nowake_buffer_unlock_commit(struct ring_buffer_event *event,
85 unsigned long flags, int pc);
86void trace_current_buffer_discard_commit(struct ring_buffer_event *event);
87
88void tracing_record_cmdline(struct task_struct *tsk);
89
90struct ftrace_event_call {
Steven Rostedta59fd602009-04-10 13:52:20 -040091 struct list_head list;
Steven Rostedt97f20252009-04-13 11:20:49 -040092 char *name;
93 char *system;
94 struct dentry *dir;
Steven Rostedt6d723732009-04-10 14:53:50 -040095 struct trace_event *event;
Steven Rostedt97f20252009-04-13 11:20:49 -040096 int enabled;
97 int (*regfunc)(void);
98 void (*unregfunc)(void);
99 int id;
100 int (*raw_init)(void);
101 int (*show_format)(struct trace_seq *s);
102 int (*define_fields)(void);
103 struct list_head fields;
Tom Zanussi30e673b2009-04-28 03:04:47 -0500104 int filter_active;
105 void *filter;
Steven Rostedt6d723732009-04-10 14:53:50 -0400106 void *mod;
Steven Rostedt97f20252009-04-13 11:20:49 -0400107
108#ifdef CONFIG_EVENT_PROFILE
109 atomic_t profile_count;
110 int (*profile_enable)(struct ftrace_event_call *);
111 void (*profile_disable)(struct ftrace_event_call *);
112#endif
113};
114
Tom Zanussi8b372562009-04-28 03:04:59 -0500115#define MAX_FILTER_PRED 32
Steven Rostedt97f20252009-04-13 11:20:49 -0400116#define MAX_FILTER_STR_VAL 128
117
118extern int init_preds(struct ftrace_event_call *call);
119extern int filter_match_preds(struct ftrace_event_call *call, void *rec);
120extern int filter_current_check_discard(struct ftrace_event_call *call,
121 void *rec,
122 struct ring_buffer_event *event);
123
124extern int trace_define_field(struct ftrace_event_call *call, char *type,
Tom Zanussia118e4d2009-04-28 03:04:53 -0500125 char *name, int offset, int size, int is_signed);
Steven Rostedt97f20252009-04-13 11:20:49 -0400126
Tom Zanussia118e4d2009-04-28 03:04:53 -0500127#define is_signed_type(type) (((type)(-1)) < 0)
Steven Rostedt97f20252009-04-13 11:20:49 -0400128
129/*
130 * The double __builtin_constant_p is because gcc will give us an error
131 * if we try to allocate the static variable to fmt if it is not a
132 * constant. Even with the outer if statement optimizing out.
133 */
134#define event_trace_printk(ip, fmt, args...) \
135do { \
136 __trace_printk_check_format(fmt, ##args); \
137 tracing_record_cmdline(current); \
138 if (__builtin_constant_p(fmt)) { \
139 static const char *trace_printk_fmt \
140 __attribute__((section("__trace_printk_fmt"))) = \
141 __builtin_constant_p(fmt) ? fmt : NULL; \
142 \
143 __trace_bprintk(ip, trace_printk_fmt, ##args); \
144 } else \
145 __trace_printk(ip, fmt, ##args); \
146} while (0)
147
Tom Zanussia118e4d2009-04-28 03:04:53 -0500148#define __common_field(type, item, is_signed) \
Steven Rostedt97f20252009-04-13 11:20:49 -0400149 ret = trace_define_field(event_call, #type, "common_" #item, \
150 offsetof(typeof(field.ent), item), \
Tom Zanussia118e4d2009-04-28 03:04:53 -0500151 sizeof(field.ent.item), is_signed); \
Steven Rostedt97f20252009-04-13 11:20:49 -0400152 if (ret) \
153 return ret;
154
155#endif /* _LINUX_FTRACE_EVENT_H */