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 cpumask_var_t started;
76 /* The below is zeroed out in pipe_read */
78 struct trace_entry *ent;
79 unsigned long lost_events;
88 /* All new field here will be zeroed out in pipe_read */
94 typedef enum print_line_t (*trace_print_func)(struct trace_iterator *iter,
95 int flags, struct trace_event *event);
97 struct trace_event_functions {
98 trace_print_func trace;
100 trace_print_func hex;
101 trace_print_func binary;
105 struct hlist_node node;
106 struct list_head list;
108 struct trace_event_functions *funcs;
111 extern int register_ftrace_event(struct trace_event *event);
112 extern int unregister_ftrace_event(struct trace_event *event);
114 /* Return values for print_line callback */
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 */
122 void tracing_generic_entry_update(struct trace_entry *entry,
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);
142 void tracing_record_cmdline(struct task_struct *tsk);
148 TRACE_REG_UNREGISTER,
149 TRACE_REG_PERF_REGISTER,
150 TRACE_REG_PERF_UNREGISTER,
153 struct ftrace_event_call;
155 struct ftrace_event_class {
158 #ifdef CONFIG_PERF_EVENTS
161 int (*reg)(struct ftrace_event_call *event,
162 enum trace_reg type);
163 int (*define_fields)(struct ftrace_event_call *);
164 struct list_head *(*get_fields)(struct ftrace_event_call *);
165 struct list_head fields;
166 int (*raw_init)(struct ftrace_event_call *);
169 extern int ftrace_event_reg(struct ftrace_event_call *event,
170 enum trace_reg type);
173 TRACE_EVENT_FL_ENABLED_BIT,
174 TRACE_EVENT_FL_FILTERED_BIT,
175 TRACE_EVENT_FL_RECORDED_CMD_BIT,
176 TRACE_EVENT_FL_CAP_ANY_BIT,
177 TRACE_EVENT_FL_NO_SET_FILTER_BIT,
181 TRACE_EVENT_FL_ENABLED = (1 << TRACE_EVENT_FL_ENABLED_BIT),
182 TRACE_EVENT_FL_FILTERED = (1 << TRACE_EVENT_FL_FILTERED_BIT),
183 TRACE_EVENT_FL_RECORDED_CMD = (1 << TRACE_EVENT_FL_RECORDED_CMD_BIT),
184 TRACE_EVENT_FL_CAP_ANY = (1 << TRACE_EVENT_FL_CAP_ANY_BIT),
185 TRACE_EVENT_FL_NO_SET_FILTER = (1 << TRACE_EVENT_FL_NO_SET_FILTER_BIT),
188 struct ftrace_event_call {
189 struct list_head list;
190 struct ftrace_event_class *class;
193 struct trace_event event;
194 const char *print_fmt;
195 struct event_filter *filter;
202 * bit 2: filter_active
203 * bit 3: enabled cmd record
205 * Changes to flags must hold the event_mutex.
207 * Note: Reads of flags do not hold the event_mutex since
208 * they occur in critical sections. But the way flags
209 * is currently used, these changes do no affect the code
210 * except that when a change is made, it may have a slight
211 * delay in propagating the changes to other CPUs due to
216 #ifdef CONFIG_PERF_EVENTS
218 struct hlist_head __percpu *perf_events;
222 #define __TRACE_EVENT_FLAGS(name, value) \
223 static int __init trace_init_flags_##name(void) \
225 event_##name.flags = value; \
228 early_initcall(trace_init_flags_##name);
230 #define PERF_MAX_TRACE_SIZE 2048
232 #define MAX_FILTER_STR_VAL 256 /* Should handle KSYM_SYMBOL_LEN */
234 extern void destroy_preds(struct ftrace_event_call *call);
235 extern int filter_match_preds(struct event_filter *filter, void *rec);
236 extern int filter_current_check_discard(struct ring_buffer *buffer,
237 struct ftrace_event_call *call,
239 struct ring_buffer_event *event);
243 FILTER_STATIC_STRING,
248 #define EVENT_STORAGE_SIZE 128
249 extern struct mutex event_storage_mutex;
250 extern char event_storage[EVENT_STORAGE_SIZE];
252 extern int trace_event_raw_init(struct ftrace_event_call *call);
253 extern int trace_define_field(struct ftrace_event_call *call, const char *type,
254 const char *name, int offset, int size,
255 int is_signed, int filter_type);
256 extern int trace_add_event_call(struct ftrace_event_call *call);
257 extern void trace_remove_event_call(struct ftrace_event_call *call);
259 #define is_signed_type(type) (((type)(-1)) < 0)
261 int trace_set_clr_event(const char *system, const char *event, int set);
264 * The double __builtin_constant_p is because gcc will give us an error
265 * if we try to allocate the static variable to fmt if it is not a
266 * constant. Even with the outer if statement optimizing out.
268 #define event_trace_printk(ip, fmt, args...) \
270 __trace_printk_check_format(fmt, ##args); \
271 tracing_record_cmdline(current); \
272 if (__builtin_constant_p(fmt)) { \
273 static const char *trace_printk_fmt \
274 __attribute__((section("__trace_printk_fmt"))) = \
275 __builtin_constant_p(fmt) ? fmt : NULL; \
277 __trace_bprintk(ip, trace_printk_fmt, ##args); \
279 __trace_printk(ip, fmt, ##args); \
282 #ifdef CONFIG_PERF_EVENTS
285 DECLARE_PER_CPU(struct pt_regs, perf_trace_regs);
287 extern int perf_trace_init(struct perf_event *event);
288 extern void perf_trace_destroy(struct perf_event *event);
289 extern int perf_trace_add(struct perf_event *event, int flags);
290 extern void perf_trace_del(struct perf_event *event, int flags);
291 extern int ftrace_profile_set_filter(struct perf_event *event, int event_id,
293 extern void ftrace_profile_free_filter(struct perf_event *event);
294 extern void *perf_trace_buf_prepare(int size, unsigned short type,
295 struct pt_regs *regs, int *rctxp);
298 perf_trace_buf_submit(void *raw_data, int size, int rctx, u64 addr,
299 u64 count, struct pt_regs *regs, void *head)
301 perf_tp_event(addr, count, raw_data, size, regs, head, rctx);
305 #endif /* _LINUX_FTRACE_EVENT_H */