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;
55 #define FTRACE_MAX_EVENT \
56 ((1 << (sizeof(((struct trace_entry *)0)->type) * 8)) - 1)
59 * Trace iterator - used by printout routines who present trace
60 * results to users and which routines might sleep, etc:
62 struct trace_iterator {
63 struct trace_array *tr;
68 struct ring_buffer_iter *buffer_iter[NR_CPUS];
69 unsigned long iter_flags;
71 /* trace_seq for __print_flags() and __print_symbolic() etc. */
72 struct trace_seq tmp_seq;
74 /* The below is zeroed out in pipe_read */
76 struct trace_entry *ent;
77 unsigned long lost_events;
85 cpumask_var_t started;
91 typedef enum print_line_t (*trace_print_func)(struct trace_iterator *iter,
92 int flags, struct trace_event *event);
94 struct trace_event_functions {
95 trace_print_func trace;
98 trace_print_func binary;
102 struct hlist_node node;
103 struct list_head list;
105 struct trace_event_functions *funcs;
108 extern int register_ftrace_event(struct trace_event *event);
109 extern int unregister_ftrace_event(struct trace_event *event);
111 /* Return values for print_line callback */
113 TRACE_TYPE_PARTIAL_LINE = 0, /* Retry after flushing the seq */
114 TRACE_TYPE_HANDLED = 1,
115 TRACE_TYPE_UNHANDLED = 2, /* Relay to other output functions */
116 TRACE_TYPE_NO_CONSUME = 3 /* Handled but ask to not consume */
119 void tracing_generic_entry_update(struct trace_entry *entry,
122 struct ring_buffer_event *
123 trace_current_buffer_lock_reserve(struct ring_buffer **current_buffer,
124 int type, unsigned long len,
125 unsigned long flags, int pc);
126 void trace_current_buffer_unlock_commit(struct ring_buffer *buffer,
127 struct ring_buffer_event *event,
128 unsigned long flags, int pc);
129 void trace_nowake_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_regs(struct ring_buffer *buffer,
133 struct ring_buffer_event *event,
134 unsigned long flags, int pc,
135 struct pt_regs *regs);
136 void trace_current_buffer_discard_commit(struct ring_buffer *buffer,
137 struct ring_buffer_event *event);
139 void tracing_record_cmdline(struct task_struct *tsk);
145 TRACE_REG_UNREGISTER,
146 TRACE_REG_PERF_REGISTER,
147 TRACE_REG_PERF_UNREGISTER,
150 struct ftrace_event_call;
152 struct ftrace_event_class {
155 #ifdef CONFIG_PERF_EVENTS
158 int (*reg)(struct ftrace_event_call *event,
159 enum trace_reg type);
160 int (*define_fields)(struct ftrace_event_call *);
161 struct list_head *(*get_fields)(struct ftrace_event_call *);
162 struct list_head fields;
163 int (*raw_init)(struct ftrace_event_call *);
166 extern int ftrace_event_reg(struct ftrace_event_call *event,
167 enum trace_reg type);
170 TRACE_EVENT_FL_ENABLED_BIT,
171 TRACE_EVENT_FL_FILTERED_BIT,
172 TRACE_EVENT_FL_RECORDED_CMD_BIT,
173 TRACE_EVENT_FL_CAP_ANY_BIT,
177 TRACE_EVENT_FL_ENABLED = (1 << TRACE_EVENT_FL_ENABLED_BIT),
178 TRACE_EVENT_FL_FILTERED = (1 << TRACE_EVENT_FL_FILTERED_BIT),
179 TRACE_EVENT_FL_RECORDED_CMD = (1 << TRACE_EVENT_FL_RECORDED_CMD_BIT),
180 TRACE_EVENT_FL_CAP_ANY = (1 << TRACE_EVENT_FL_CAP_ANY_BIT),
183 struct ftrace_event_call {
184 struct list_head list;
185 struct ftrace_event_class *class;
188 struct trace_event event;
189 const char *print_fmt;
190 struct event_filter *filter;
197 * bit 2: filter_active
198 * bit 3: enabled cmd record
200 * Changes to flags must hold the event_mutex.
202 * Note: Reads of flags do not hold the event_mutex since
203 * they occur in critical sections. But the way flags
204 * is currently used, these changes do no affect the code
205 * except that when a change is made, it may have a slight
206 * delay in propagating the changes to other CPUs due to
211 #ifdef CONFIG_PERF_EVENTS
213 struct hlist_head __percpu *perf_events;
217 #define __TRACE_EVENT_FLAGS(name, value) \
218 static int __init trace_init_flags_##name(void) \
220 event_##name.flags = value; \
223 early_initcall(trace_init_flags_##name);
225 #define PERF_MAX_TRACE_SIZE 2048
227 #define MAX_FILTER_STR_VAL 256 /* Should handle KSYM_SYMBOL_LEN */
229 extern void destroy_preds(struct ftrace_event_call *call);
230 extern int filter_match_preds(struct event_filter *filter, void *rec);
231 extern int filter_current_check_discard(struct ring_buffer *buffer,
232 struct ftrace_event_call *call,
234 struct ring_buffer_event *event);
238 FILTER_STATIC_STRING,
243 #define EVENT_STORAGE_SIZE 128
244 extern struct mutex event_storage_mutex;
245 extern char event_storage[EVENT_STORAGE_SIZE];
247 extern int trace_event_raw_init(struct ftrace_event_call *call);
248 extern int trace_define_field(struct ftrace_event_call *call, const char *type,
249 const char *name, int offset, int size,
250 int is_signed, int filter_type);
251 extern int trace_add_event_call(struct ftrace_event_call *call);
252 extern void trace_remove_event_call(struct ftrace_event_call *call);
254 #define is_signed_type(type) (((type)(-1)) < 0)
256 int trace_set_clr_event(const char *system, const char *event, int set);
259 * The double __builtin_constant_p is because gcc will give us an error
260 * if we try to allocate the static variable to fmt if it is not a
261 * constant. Even with the outer if statement optimizing out.
263 #define event_trace_printk(ip, fmt, args...) \
265 __trace_printk_check_format(fmt, ##args); \
266 tracing_record_cmdline(current); \
267 if (__builtin_constant_p(fmt)) { \
268 static const char *trace_printk_fmt \
269 __attribute__((section("__trace_printk_fmt"))) = \
270 __builtin_constant_p(fmt) ? fmt : NULL; \
272 __trace_bprintk(ip, trace_printk_fmt, ##args); \
274 __trace_printk(ip, fmt, ##args); \
277 #ifdef CONFIG_PERF_EVENTS
280 DECLARE_PER_CPU(struct pt_regs, perf_trace_regs);
282 extern int perf_trace_init(struct perf_event *event);
283 extern void perf_trace_destroy(struct perf_event *event);
284 extern int perf_trace_add(struct perf_event *event, int flags);
285 extern void perf_trace_del(struct perf_event *event, int flags);
286 extern int ftrace_profile_set_filter(struct perf_event *event, int event_id,
288 extern void ftrace_profile_free_filter(struct perf_event *event);
289 extern void *perf_trace_buf_prepare(int size, unsigned short type,
290 struct pt_regs *regs, int *rctxp);
293 perf_trace_buf_submit(void *raw_data, int size, int rctx, u64 addr,
294 u64 count, struct pt_regs *regs, void *head)
296 perf_tp_event(addr, count, raw_data, size, regs, head, rctx);
300 #endif /* _LINUX_FTRACE_EVENT_H */