1 #ifndef _LINUX_FTRACE_EVENT_H
2 #define _LINUX_FTRACE_EVENT_H
3
4 #include <linux/ring_buffer.h>
5 #include <linux/trace_seq.h>
6 #include <linux/percpu.h>
7 #include <linux/hardirq.h>
8 #include <linux/perf_event.h>
9
10 struct trace_array;
11 struct tracer;
12 struct dentry;
13
14 struct trace_print_flags {
15 unsigned long mask;
16 const char *name;
17 };
18
19 struct trace_print_flags_u64 {
20 unsigned long long mask;
21 const char *name;
22 };
23
24 const 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
28 const char *ftrace_print_symbols_seq(struct trace_seq *p, unsigned long val,
29 const struct trace_print_flags *symbol_array);
30
31 #if BITS_PER_LONG == 32
32 const 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
38 const char *ftrace_print_hex_seq(struct trace_seq *p,
39 const unsigned char *buf, int len);
40
41 /*
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 */
47 struct trace_entry {
48 unsigned short type;
49 unsigned char flags;
50 unsigned char preempt_count;
51 int pid;
52 int padding;
53 };
54
55 #define FTRACE_MAX_EVENT \
56 ((1 << (sizeof(((struct trace_entry *)0)->type) * 8)) - 1)
57
58 /*
59 * Trace iterator - used by printout routines who present trace
60 * results to users and which routines might sleep, etc:
61 */
62 struct 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];
69 unsigned long iter_flags;
70
71 /* trace_seq for __print_flags() and __print_symbolic() etc. */
72 struct trace_seq tmp_seq;
73
74 cpumask_var_t started;
75
76 /* The below is zeroed out in pipe_read */
77 struct trace_seq seq;
78 struct trace_entry *ent;
79 unsigned long lost_events;
80 int leftover;
81 int ent_size;
82 int cpu;
83 u64 ts;
84
85 loff_t pos;
86 long idx;
87
88 /* All new field here will be zeroed out in pipe_read */
89 };
90
91
92 struct trace_event;
93
94 typedef enum print_line_t (*trace_print_func)(struct trace_iterator *iter,
95 int flags, struct trace_event *event);
96
97 struct trace_event_functions {
98 trace_print_func trace;
99 trace_print_func raw;
100 trace_print_func hex;
101 trace_print_func binary;
102 };
103
104 struct trace_event {
105 struct hlist_node node;
106 struct list_head list;
107 int type;
108 struct trace_event_functions *funcs;
109 };
110
111 extern int register_ftrace_event(struct trace_event *event);
112 extern int unregister_ftrace_event(struct trace_event *event);
113
114 /* Return values for print_line callback */
115 enum print_line_t {
116 TRACE_TYPE_PARTIAL_LINE = 0, /* Retry after flushing the seq */
117 TRACE_TYPE_HANDLED = 1,
118 TRACE_TYPE_UNHANDLED = 2, /* Relay to other output functions */
119 TRACE_TYPE_NO_CONSUME = 3 /* Handled but ask to not consume */
120 };
121
122 void tracing_generic_entry_update(struct trace_entry *entry,
123 unsigned long flags,
124 int pc);
125 struct ring_buffer_event *
126 trace_current_buffer_lock_reserve(struct ring_buffer **current_buffer,
127 int type, unsigned long len,
128 unsigned long flags, int pc);
129 void trace_current_buffer_unlock_commit(struct ring_buffer *buffer,
130 struct ring_buffer_event *event,
131 unsigned long flags, int pc);
132 void trace_nowake_buffer_unlock_commit(struct ring_buffer *buffer,
133 struct ring_buffer_event *event,
134 unsigned long flags, int pc);
135 void trace_nowake_buffer_unlock_commit_regs(struct ring_buffer *buffer,
136 struct ring_buffer_event *event,
137 unsigned long flags, int pc,
138 struct pt_regs *regs);
139 void trace_current_buffer_discard_commit(struct ring_buffer *buffer,
140 struct ring_buffer_event *event);
141
142 void tracing_record_cmdline(struct task_struct *tsk);
143
144 struct event_filter;
145
146 enum trace_reg {
147 TRACE_REG_REGISTER,
148 TRACE_REG_UNREGISTER,
149 #ifdef CONFIG_PERF_EVENTS
150 TRACE_REG_PERF_REGISTER,
151 TRACE_REG_PERF_UNREGISTER,
152 TRACE_REG_PERF_OPEN,
153 TRACE_REG_PERF_CLOSE,
154 TRACE_REG_PERF_ADD,
155 TRACE_REG_PERF_DEL,
156 #endif
157 };
158
159 struct ftrace_event_call;
160
161 struct ftrace_event_class {
162 char *system;
163 void *probe;
164 #ifdef CONFIG_PERF_EVENTS
165 void *perf_probe;
166 #endif
167 int (*reg)(struct ftrace_event_call *event,
168 enum trace_reg type, void *data);
169 int (*define_fields)(struct ftrace_event_call *);
170 struct list_head *(*get_fields)(struct ftrace_event_call *);
171 struct list_head fields;
172 int (*raw_init)(struct ftrace_event_call *);
173 };
174
175 extern int ftrace_event_reg(struct ftrace_event_call *event,
176 enum trace_reg type, void *data);
177
178 enum {
179 TRACE_EVENT_FL_ENABLED_BIT,
180 TRACE_EVENT_FL_FILTERED_BIT,
181 TRACE_EVENT_FL_RECORDED_CMD_BIT,
182 TRACE_EVENT_FL_CAP_ANY_BIT,
183 TRACE_EVENT_FL_NO_SET_FILTER_BIT,
184 TRACE_EVENT_FL_IGNORE_ENABLE_BIT,
185 };
186
187 enum {
188 TRACE_EVENT_FL_ENABLED = (1 << TRACE_EVENT_FL_ENABLED_BIT),
189 TRACE_EVENT_FL_FILTERED = (1 << TRACE_EVENT_FL_FILTERED_BIT),
190 TRACE_EVENT_FL_RECORDED_CMD = (1 << TRACE_EVENT_FL_RECORDED_CMD_BIT),
191 TRACE_EVENT_FL_CAP_ANY = (1 << TRACE_EVENT_FL_CAP_ANY_BIT),
192 TRACE_EVENT_FL_NO_SET_FILTER = (1 << TRACE_EVENT_FL_NO_SET_FILTER_BIT),
193 TRACE_EVENT_FL_IGNORE_ENABLE = (1 << TRACE_EVENT_FL_IGNORE_ENABLE_BIT),
194 };
195
196 struct ftrace_event_call {
197 struct list_head list;
198 struct ftrace_event_class *class;
199 char *name;
200 struct dentry *dir;
201 struct trace_event event;
202 const char *print_fmt;
203 struct event_filter *filter;
204 void *mod;
205 void *data;
206
207 /*
208 * 32 bit flags:
209 * bit 1: enabled
210 * bit 2: filter_active
211 * bit 3: enabled cmd record
212 *
213 * Changes to flags must hold the event_mutex.
214 *
215 * Note: Reads of flags do not hold the event_mutex since
216 * they occur in critical sections. But the way flags
217 * is currently used, these changes do no affect the code
218 * except that when a change is made, it may have a slight
219 * delay in propagating the changes to other CPUs due to
220 * caching and such.
221 */
222 unsigned int flags;
223
224 #ifdef CONFIG_PERF_EVENTS
225 int perf_refcount;
226 struct hlist_head __percpu *perf_events;
227 #endif
228 };
229
230 #define __TRACE_EVENT_FLAGS(name, value) \
231 static int __init trace_init_flags_##name(void) \
232 { \
233 event_##name.flags = value; \
234 return 0; \
235 } \
236 early_initcall(trace_init_flags_##name);
237
238 #define PERF_MAX_TRACE_SIZE 2048
239
240 #define MAX_FILTER_STR_VAL 256 /* Should handle KSYM_SYMBOL_LEN */
241
242 extern void destroy_preds(struct ftrace_event_call *call);
243 extern int filter_match_preds(struct event_filter *filter, void *rec);
244 extern int filter_current_check_discard(struct ring_buffer *buffer,
245 struct ftrace_event_call *call,
246 void *rec,
247 struct ring_buffer_event *event);
248
249 enum {
250 FILTER_OTHER = 0,
251 FILTER_STATIC_STRING,
252 FILTER_DYN_STRING,
253 FILTER_PTR_STRING,
254 FILTER_TRACE_FN,
255 };
256
257 #define EVENT_STORAGE_SIZE 128
258 extern struct mutex event_storage_mutex;
259 extern char event_storage[EVENT_STORAGE_SIZE];
260
261 extern int trace_event_raw_init(struct ftrace_event_call *call);
262 extern int trace_define_field(struct ftrace_event_call *call, const char *type,
263 const char *name, int offset, int size,
264 int is_signed, int filter_type);
265 extern int trace_add_event_call(struct ftrace_event_call *call);
266 extern void trace_remove_event_call(struct ftrace_event_call *call);
267
268 #define is_signed_type(type) (((type)(-1)) < 0)
269
270 int trace_set_clr_event(const char *system, const char *event, int set);
271
272 /*
273 * The double __builtin_constant_p is because gcc will give us an error
274 * if we try to allocate the static variable to fmt if it is not a
275 * constant. Even with the outer if statement optimizing out.
276 */
277 #define event_trace_printk(ip, fmt, args...) \
278 do { \
279 __trace_printk_check_format(fmt, ##args); \
280 tracing_record_cmdline(current); \
281 if (__builtin_constant_p(fmt)) { \
282 static const char *trace_printk_fmt \
283 __attribute__((section("__trace_printk_fmt"))) = \
284 __builtin_constant_p(fmt) ? fmt : NULL; \
285 \
286 __trace_bprintk(ip, trace_printk_fmt, ##args); \
287 } else \
288 __trace_printk(ip, fmt, ##args); \
289 } while (0)
290
291 #ifdef CONFIG_PERF_EVENTS
292 struct perf_event;
293
294 DECLARE_PER_CPU(struct pt_regs, perf_trace_regs);
295
296 extern int perf_trace_init(struct perf_event *event);
297 extern void perf_trace_destroy(struct perf_event *event);
298 extern int perf_trace_add(struct perf_event *event, int flags);
299 extern void perf_trace_del(struct perf_event *event, int flags);
300 extern int ftrace_profile_set_filter(struct perf_event *event, int event_id,
301 char *filter_str);
302 extern void ftrace_profile_free_filter(struct perf_event *event);
303 extern void *perf_trace_buf_prepare(int size, unsigned short type,
304 struct pt_regs *regs, int *rctxp);
305
306 static inline void
perf_trace_buf_submit(void * raw_data,int size,int rctx,u64 addr,u64 count,struct pt_regs * regs,void * head)307 perf_trace_buf_submit(void *raw_data, int size, int rctx, u64 addr,
308 u64 count, struct pt_regs *regs, void *head)
309 {
310 perf_tp_event(addr, count, raw_data, size, regs, head, rctx);
311 }
312 #endif
313
314 #endif /* _LINUX_FTRACE_EVENT_H */
315