1 #ifndef _LINUX_FTRACE_EVENT_H
2 #define _LINUX_FTRACE_EVENT_H
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>
14 struct trace_print_flags {
19 struct trace_print_flags_u64 {
20 unsigned long long mask;
24 const char *ftrace_print_flags_seq(struct trace_seq *p, const char *delim,
26 const struct trace_print_flags *flag_array);
28 const char *ftrace_print_symbols_seq(struct trace_seq *p, unsigned long val,
29 const struct trace_print_flags *symbol_array);
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
38 const char *ftrace_print_hex_seq(struct trace_seq *p,
39 const unsigned char *buf, int len);
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:
45 * bash-15816 [01] 235.197585: idle_cpu <- irq_enter
50 unsigned char preempt_count;
54 #define FTRACE_MAX_EVENT \
55 ((1 << (sizeof(((struct trace_entry *)0)->type) * 8)) - 1)
58 * Trace iterator - used by printout routines who present trace
59 * results to users and which routines might sleep, etc:
61 struct trace_iterator {
62 struct trace_array *tr;
67 struct ring_buffer_iter **buffer_iter;
68 unsigned long iter_flags;
70 /* trace_seq for __print_flags() and __print_symbolic() etc. */
71 struct trace_seq tmp_seq;
73 /* The below is zeroed out in pipe_read */
75 struct trace_entry *ent;
76 unsigned long lost_events;
85 cpumask_var_t started;
87 /* it's true when current open file is snapshot */
91 enum trace_iter_flags {
92 TRACE_FILE_LAT_FMT = 1,
93 TRACE_FILE_ANNOTATE = 2,
94 TRACE_FILE_TIME_IN_NS = 4,
100 typedef enum print_line_t (*trace_print_func)(struct trace_iterator *iter,
101 int flags, struct trace_event *event);
103 struct trace_event_functions {
104 trace_print_func trace;
105 trace_print_func raw;
106 trace_print_func hex;
107 trace_print_func binary;
111 struct hlist_node node;
112 struct list_head list;
114 struct trace_event_functions *funcs;
117 extern int register_ftrace_event(struct trace_event *event);
118 extern int unregister_ftrace_event(struct trace_event *event);
120 /* Return values for print_line callback */
122 TRACE_TYPE_PARTIAL_LINE = 0, /* Retry after flushing the seq */
123 TRACE_TYPE_HANDLED = 1,
124 TRACE_TYPE_UNHANDLED = 2, /* Relay to other output functions */
125 TRACE_TYPE_NO_CONSUME = 3 /* Handled but ask to not consume */
128 void tracing_generic_entry_update(struct trace_entry *entry,
131 struct ftrace_event_file;
133 struct ring_buffer_event *
134 trace_event_buffer_lock_reserve(struct ring_buffer **current_buffer,
135 struct ftrace_event_file *ftrace_file,
136 int type, unsigned long len,
137 unsigned long flags, int pc);
138 struct ring_buffer_event *
139 trace_current_buffer_lock_reserve(struct ring_buffer **current_buffer,
140 int type, unsigned long len,
141 unsigned long flags, int pc);
142 void trace_current_buffer_unlock_commit(struct ring_buffer *buffer,
143 struct ring_buffer_event *event,
144 unsigned long flags, int pc);
145 void trace_buffer_unlock_commit(struct ring_buffer *buffer,
146 struct ring_buffer_event *event,
147 unsigned long flags, int pc);
148 void trace_buffer_unlock_commit_regs(struct ring_buffer *buffer,
149 struct ring_buffer_event *event,
150 unsigned long flags, int pc,
151 struct pt_regs *regs);
152 void trace_current_buffer_discard_commit(struct ring_buffer *buffer,
153 struct ring_buffer_event *event);
155 void tracing_record_cmdline(struct task_struct *tsk);
161 TRACE_REG_UNREGISTER,
162 #ifdef CONFIG_PERF_EVENTS
163 TRACE_REG_PERF_REGISTER,
164 TRACE_REG_PERF_UNREGISTER,
166 TRACE_REG_PERF_CLOSE,
172 struct ftrace_event_call;
174 struct ftrace_event_class {
177 #ifdef CONFIG_PERF_EVENTS
180 int (*reg)(struct ftrace_event_call *event,
181 enum trace_reg type, void *data);
182 int (*define_fields)(struct ftrace_event_call *);
183 struct list_head *(*get_fields)(struct ftrace_event_call *);
184 struct list_head fields;
185 int (*raw_init)(struct ftrace_event_call *);
188 extern int ftrace_event_reg(struct ftrace_event_call *event,
189 enum trace_reg type, void *data);
192 TRACE_EVENT_FL_FILTERED_BIT,
193 TRACE_EVENT_FL_CAP_ANY_BIT,
194 TRACE_EVENT_FL_NO_SET_FILTER_BIT,
195 TRACE_EVENT_FL_IGNORE_ENABLE_BIT,
200 * FILTERED - The event has a filter attached
201 * CAP_ANY - Any user can enable for perf
202 * NO_SET_FILTER - Set when filter has error and is to be ignored
205 TRACE_EVENT_FL_FILTERED = (1 << TRACE_EVENT_FL_FILTERED_BIT),
206 TRACE_EVENT_FL_CAP_ANY = (1 << TRACE_EVENT_FL_CAP_ANY_BIT),
207 TRACE_EVENT_FL_NO_SET_FILTER = (1 << TRACE_EVENT_FL_NO_SET_FILTER_BIT),
208 TRACE_EVENT_FL_IGNORE_ENABLE = (1 << TRACE_EVENT_FL_IGNORE_ENABLE_BIT),
211 struct ftrace_event_call {
212 struct list_head list;
213 struct ftrace_event_class *class;
215 struct trace_event event;
216 const char *print_fmt;
217 struct event_filter *filter;
218 struct list_head *files;
221 int flags; /* static flags of different events */
223 #ifdef CONFIG_PERF_EVENTS
225 struct hlist_head __percpu *perf_events;
230 struct ftrace_subsystem_dir;
233 FTRACE_EVENT_FL_ENABLED_BIT,
234 FTRACE_EVENT_FL_RECORDED_CMD_BIT,
238 * Ftrace event file flags:
239 * ENABELD - The event is enabled
240 * RECORDED_CMD - The comms should be recorded at sched_switch
243 FTRACE_EVENT_FL_ENABLED = (1 << FTRACE_EVENT_FL_ENABLED_BIT),
244 FTRACE_EVENT_FL_RECORDED_CMD = (1 << FTRACE_EVENT_FL_RECORDED_CMD_BIT),
247 struct ftrace_event_file {
248 struct list_head list;
249 struct ftrace_event_call *event_call;
251 struct trace_array *tr;
252 struct ftrace_subsystem_dir *system;
257 * bit 2: filter_active
258 * bit 3: enabled cmd record
259 * bit 4: allow trace by non root (cap any)
260 * bit 5: failed to apply filter
261 * bit 6: ftrace internal event (do not enable)
263 * Changes to flags must hold the event_mutex.
265 * Note: Reads of flags do not hold the event_mutex since
266 * they occur in critical sections. But the way flags
267 * is currently used, these changes do not affect the code
268 * except that when a change is made, it may have a slight
269 * delay in propagating the changes to other CPUs due to
275 #define __TRACE_EVENT_FLAGS(name, value) \
276 static int __init trace_init_flags_##name(void) \
278 event_##name.flags = value; \
281 early_initcall(trace_init_flags_##name);
283 #define PERF_MAX_TRACE_SIZE 2048
285 #define MAX_FILTER_STR_VAL 256 /* Should handle KSYM_SYMBOL_LEN */
287 extern void destroy_preds(struct ftrace_event_call *call);
288 extern int filter_match_preds(struct event_filter *filter, void *rec);
289 extern int filter_current_check_discard(struct ring_buffer *buffer,
290 struct ftrace_event_call *call,
292 struct ring_buffer_event *event);
296 FILTER_STATIC_STRING,
302 #define EVENT_STORAGE_SIZE 128
303 extern struct mutex event_storage_mutex;
304 extern char event_storage[EVENT_STORAGE_SIZE];
306 extern int trace_event_raw_init(struct ftrace_event_call *call);
307 extern int trace_define_field(struct ftrace_event_call *call, const char *type,
308 const char *name, int offset, int size,
309 int is_signed, int filter_type);
310 extern int trace_add_event_call(struct ftrace_event_call *call);
311 extern void trace_remove_event_call(struct ftrace_event_call *call);
313 #define is_signed_type(type) (((type)(-1)) < (type)0)
315 int trace_set_clr_event(const char *system, const char *event, int set);
318 * The double __builtin_constant_p is because gcc will give us an error
319 * if we try to allocate the static variable to fmt if it is not a
320 * constant. Even with the outer if statement optimizing out.
322 #define event_trace_printk(ip, fmt, args...) \
324 __trace_printk_check_format(fmt, ##args); \
325 tracing_record_cmdline(current); \
326 if (__builtin_constant_p(fmt)) { \
327 static const char *trace_printk_fmt \
328 __attribute__((section("__trace_printk_fmt"))) = \
329 __builtin_constant_p(fmt) ? fmt : NULL; \
331 __trace_bprintk(ip, trace_printk_fmt, ##args); \
333 __trace_printk(ip, fmt, ##args); \
336 #ifdef CONFIG_PERF_EVENTS
339 DECLARE_PER_CPU(struct pt_regs, perf_trace_regs);
341 extern int perf_trace_init(struct perf_event *event);
342 extern void perf_trace_destroy(struct perf_event *event);
343 extern int perf_trace_add(struct perf_event *event, int flags);
344 extern void perf_trace_del(struct perf_event *event, int flags);
345 extern int ftrace_profile_set_filter(struct perf_event *event, int event_id,
347 extern void ftrace_profile_free_filter(struct perf_event *event);
348 extern void *perf_trace_buf_prepare(int size, unsigned short type,
349 struct pt_regs *regs, int *rctxp);
352 perf_trace_buf_submit(void *raw_data, int size, int rctx, u64 addr,
353 u64 count, struct pt_regs *regs, void *head,
354 struct task_struct *task)
356 perf_tp_event(addr, count, raw_data, size, regs, head, rctx, task);
360 #endif /* _LINUX_FTRACE_EVENT_H */