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 ring_buffer_event *
132 trace_current_buffer_lock_reserve(struct ring_buffer **current_buffer,
133 int type, unsigned long len,
134 unsigned long flags, int pc);
135 void trace_current_buffer_unlock_commit(struct ring_buffer *buffer,
136 struct ring_buffer_event *event,
137 unsigned long flags, int pc);
138 void trace_buffer_unlock_commit(struct ring_buffer *buffer,
139 struct ring_buffer_event *event,
140 unsigned long flags, int pc);
141 void trace_buffer_unlock_commit_regs(struct ring_buffer *buffer,
142 struct ring_buffer_event *event,
143 unsigned long flags, int pc,
144 struct pt_regs *regs);
145 void trace_current_buffer_discard_commit(struct ring_buffer *buffer,
146 struct ring_buffer_event *event);
148 void tracing_record_cmdline(struct task_struct *tsk);
154 TRACE_REG_UNREGISTER,
155 #ifdef CONFIG_PERF_EVENTS
156 TRACE_REG_PERF_REGISTER,
157 TRACE_REG_PERF_UNREGISTER,
159 TRACE_REG_PERF_CLOSE,
165 struct ftrace_event_call;
167 struct ftrace_event_class {
170 #ifdef CONFIG_PERF_EVENTS
173 int (*reg)(struct ftrace_event_call *event,
174 enum trace_reg type, void *data);
175 int (*define_fields)(struct ftrace_event_call *);
176 struct list_head *(*get_fields)(struct ftrace_event_call *);
177 struct list_head fields;
178 int (*raw_init)(struct ftrace_event_call *);
181 extern int ftrace_event_reg(struct ftrace_event_call *event,
182 enum trace_reg type, void *data);
185 TRACE_EVENT_FL_FILTERED_BIT,
186 TRACE_EVENT_FL_CAP_ANY_BIT,
187 TRACE_EVENT_FL_NO_SET_FILTER_BIT,
188 TRACE_EVENT_FL_IGNORE_ENABLE_BIT,
193 * FILTERED - The event has a filter attached
194 * CAP_ANY - Any user can enable for perf
195 * NO_SET_FILTER - Set when filter has error and is to be ignored
198 TRACE_EVENT_FL_FILTERED = (1 << TRACE_EVENT_FL_FILTERED_BIT),
199 TRACE_EVENT_FL_CAP_ANY = (1 << TRACE_EVENT_FL_CAP_ANY_BIT),
200 TRACE_EVENT_FL_NO_SET_FILTER = (1 << TRACE_EVENT_FL_NO_SET_FILTER_BIT),
201 TRACE_EVENT_FL_IGNORE_ENABLE = (1 << TRACE_EVENT_FL_IGNORE_ENABLE_BIT),
204 struct ftrace_event_call {
205 struct list_head list;
206 struct ftrace_event_class *class;
208 struct trace_event event;
209 const char *print_fmt;
210 struct event_filter *filter;
211 struct list_head *files;
214 int flags; /* static flags of different events */
216 #ifdef CONFIG_PERF_EVENTS
218 struct hlist_head __percpu *perf_events;
223 struct ftrace_subsystem_dir;
226 FTRACE_EVENT_FL_ENABLED_BIT,
227 FTRACE_EVENT_FL_RECORDED_CMD_BIT,
231 * Ftrace event file flags:
232 * ENABELD - The event is enabled
233 * RECORDED_CMD - The comms should be recorded at sched_switch
236 FTRACE_EVENT_FL_ENABLED = (1 << FTRACE_EVENT_FL_ENABLED_BIT),
237 FTRACE_EVENT_FL_RECORDED_CMD = (1 << FTRACE_EVENT_FL_RECORDED_CMD_BIT),
240 struct ftrace_event_file {
241 struct list_head list;
242 struct ftrace_event_call *event_call;
244 struct trace_array *tr;
245 struct ftrace_subsystem_dir *system;
250 * bit 2: filter_active
251 * bit 3: enabled cmd record
252 * bit 4: allow trace by non root (cap any)
253 * bit 5: failed to apply filter
254 * bit 6: ftrace internal event (do not enable)
256 * Changes to flags must hold the event_mutex.
258 * Note: Reads of flags do not hold the event_mutex since
259 * they occur in critical sections. But the way flags
260 * is currently used, these changes do not affect the code
261 * except that when a change is made, it may have a slight
262 * delay in propagating the changes to other CPUs due to
268 #define __TRACE_EVENT_FLAGS(name, value) \
269 static int __init trace_init_flags_##name(void) \
271 event_##name.flags = value; \
274 early_initcall(trace_init_flags_##name);
276 #define PERF_MAX_TRACE_SIZE 2048
278 #define MAX_FILTER_STR_VAL 256 /* Should handle KSYM_SYMBOL_LEN */
280 extern void destroy_preds(struct ftrace_event_call *call);
281 extern int filter_match_preds(struct event_filter *filter, void *rec);
282 extern int filter_current_check_discard(struct ring_buffer *buffer,
283 struct ftrace_event_call *call,
285 struct ring_buffer_event *event);
289 FILTER_STATIC_STRING,
295 #define EVENT_STORAGE_SIZE 128
296 extern struct mutex event_storage_mutex;
297 extern char event_storage[EVENT_STORAGE_SIZE];
299 extern int trace_event_raw_init(struct ftrace_event_call *call);
300 extern int trace_define_field(struct ftrace_event_call *call, const char *type,
301 const char *name, int offset, int size,
302 int is_signed, int filter_type);
303 extern int trace_add_event_call(struct ftrace_event_call *call);
304 extern void trace_remove_event_call(struct ftrace_event_call *call);
306 #define is_signed_type(type) (((type)(-1)) < (type)0)
308 int trace_set_clr_event(const char *system, const char *event, int set);
311 * The double __builtin_constant_p is because gcc will give us an error
312 * if we try to allocate the static variable to fmt if it is not a
313 * constant. Even with the outer if statement optimizing out.
315 #define event_trace_printk(ip, fmt, args...) \
317 __trace_printk_check_format(fmt, ##args); \
318 tracing_record_cmdline(current); \
319 if (__builtin_constant_p(fmt)) { \
320 static const char *trace_printk_fmt \
321 __attribute__((section("__trace_printk_fmt"))) = \
322 __builtin_constant_p(fmt) ? fmt : NULL; \
324 __trace_bprintk(ip, trace_printk_fmt, ##args); \
326 __trace_printk(ip, fmt, ##args); \
329 #ifdef CONFIG_PERF_EVENTS
332 DECLARE_PER_CPU(struct pt_regs, perf_trace_regs);
334 extern int perf_trace_init(struct perf_event *event);
335 extern void perf_trace_destroy(struct perf_event *event);
336 extern int perf_trace_add(struct perf_event *event, int flags);
337 extern void perf_trace_del(struct perf_event *event, int flags);
338 extern int ftrace_profile_set_filter(struct perf_event *event, int event_id,
340 extern void ftrace_profile_free_filter(struct perf_event *event);
341 extern void *perf_trace_buf_prepare(int size, unsigned short type,
342 struct pt_regs *regs, int *rctxp);
345 perf_trace_buf_submit(void *raw_data, int size, int rctx, u64 addr,
346 u64 count, struct pt_regs *regs, void *head,
347 struct task_struct *task)
349 perf_tp_event(addr, count, raw_data, size, regs, head, rctx, task);
353 #endif /* _LINUX_FTRACE_EVENT_H */