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 const char *ftrace_print_flags_seq(struct trace_seq *p, const char *delim,
21 const struct trace_print_flags *flag_array);
23 const char *ftrace_print_symbols_seq(struct trace_seq *p, unsigned long val,
24 const struct trace_print_flags *symbol_array);
26 const char *ftrace_print_hex_seq(struct trace_seq *p,
27 const unsigned char *buf, int len);
30 * The trace entry - the most basic unit of tracing. This is what
31 * is printed in the end as a single line in the trace output, such as:
33 * bash-15816 [01] 235.197585: idle_cpu <- irq_enter
38 unsigned char preempt_count;
42 #define FTRACE_MAX_EVENT \
43 ((1 << (sizeof(((struct trace_entry *)0)->type) * 8)) - 1)
46 * Trace iterator - used by printout routines who present trace
47 * results to users and which routines might sleep, etc:
49 struct trace_iterator {
50 struct trace_array *tr;
55 struct ring_buffer_iter *buffer_iter[NR_CPUS];
56 unsigned long iter_flags;
58 /* trace_seq for __print_flags() and __print_symbolic() etc. */
59 struct trace_seq tmp_seq;
61 /* The below is zeroed out in pipe_read */
63 struct trace_entry *ent;
64 unsigned long lost_events;
72 cpumask_var_t started;
78 typedef enum print_line_t (*trace_print_func)(struct trace_iterator *iter,
79 int flags, struct trace_event *event);
81 struct trace_event_functions {
82 trace_print_func trace;
85 trace_print_func binary;
89 struct hlist_node node;
90 struct list_head list;
92 struct trace_event_functions *funcs;
95 extern int register_ftrace_event(struct trace_event *event);
96 extern int unregister_ftrace_event(struct trace_event *event);
98 /* Return values for print_line callback */
100 TRACE_TYPE_PARTIAL_LINE = 0, /* Retry after flushing the seq */
101 TRACE_TYPE_HANDLED = 1,
102 TRACE_TYPE_UNHANDLED = 2, /* Relay to other output functions */
103 TRACE_TYPE_NO_CONSUME = 3 /* Handled but ask to not consume */
106 void tracing_generic_entry_update(struct trace_entry *entry,
109 struct ring_buffer_event *
110 trace_current_buffer_lock_reserve(struct ring_buffer **current_buffer,
111 int type, unsigned long len,
112 unsigned long flags, int pc);
113 void trace_current_buffer_unlock_commit(struct ring_buffer *buffer,
114 struct ring_buffer_event *event,
115 unsigned long flags, int pc);
116 void trace_nowake_buffer_unlock_commit(struct ring_buffer *buffer,
117 struct ring_buffer_event *event,
118 unsigned long flags, int pc);
119 void trace_current_buffer_discard_commit(struct ring_buffer *buffer,
120 struct ring_buffer_event *event);
122 void tracing_record_cmdline(struct task_struct *tsk);
128 TRACE_REG_UNREGISTER,
129 TRACE_REG_PERF_REGISTER,
130 TRACE_REG_PERF_UNREGISTER,
133 struct ftrace_event_call;
135 struct ftrace_event_class {
138 #ifdef CONFIG_PERF_EVENTS
141 int (*reg)(struct ftrace_event_call *event,
142 enum trace_reg type);
143 int (*define_fields)(struct ftrace_event_call *);
144 struct list_head *(*get_fields)(struct ftrace_event_call *);
145 struct list_head fields;
146 int (*raw_init)(struct ftrace_event_call *);
149 extern int ftrace_event_reg(struct ftrace_event_call *event,
150 enum trace_reg type);
153 TRACE_EVENT_FL_ENABLED_BIT,
154 TRACE_EVENT_FL_FILTERED_BIT,
155 TRACE_EVENT_FL_RECORDED_CMD_BIT,
156 TRACE_EVENT_FL_CAP_ANY_BIT,
160 TRACE_EVENT_FL_ENABLED = (1 << TRACE_EVENT_FL_ENABLED_BIT),
161 TRACE_EVENT_FL_FILTERED = (1 << TRACE_EVENT_FL_FILTERED_BIT),
162 TRACE_EVENT_FL_RECORDED_CMD = (1 << TRACE_EVENT_FL_RECORDED_CMD_BIT),
163 TRACE_EVENT_FL_CAP_ANY = (1 << TRACE_EVENT_FL_CAP_ANY_BIT),
166 struct ftrace_event_call {
167 struct list_head list;
168 struct ftrace_event_class *class;
171 struct trace_event event;
172 const char *print_fmt;
173 struct event_filter *filter;
180 * bit 2: filter_active
181 * bit 3: enabled cmd record
183 * Changes to flags must hold the event_mutex.
185 * Note: Reads of flags do not hold the event_mutex since
186 * they occur in critical sections. But the way flags
187 * is currently used, these changes do no affect the code
188 * except that when a change is made, it may have a slight
189 * delay in propagating the changes to other CPUs due to
194 #ifdef CONFIG_PERF_EVENTS
196 struct hlist_head __percpu *perf_events;
200 #define __TRACE_EVENT_FLAGS(name, value) \
201 static int __init trace_init_flags_##name(void) \
203 event_##name.flags = value; \
206 early_initcall(trace_init_flags_##name);
208 #define PERF_MAX_TRACE_SIZE 2048
210 #define MAX_FILTER_STR_VAL 256 /* Should handle KSYM_SYMBOL_LEN */
212 extern void destroy_preds(struct ftrace_event_call *call);
213 extern int filter_match_preds(struct event_filter *filter, void *rec);
214 extern int filter_current_check_discard(struct ring_buffer *buffer,
215 struct ftrace_event_call *call,
217 struct ring_buffer_event *event);
221 FILTER_STATIC_STRING,
226 #define EVENT_STORAGE_SIZE 128
227 extern struct mutex event_storage_mutex;
228 extern char event_storage[EVENT_STORAGE_SIZE];
230 extern int trace_event_raw_init(struct ftrace_event_call *call);
231 extern int trace_define_field(struct ftrace_event_call *call, const char *type,
232 const char *name, int offset, int size,
233 int is_signed, int filter_type);
234 extern int trace_add_event_call(struct ftrace_event_call *call);
235 extern void trace_remove_event_call(struct ftrace_event_call *call);
237 #define is_signed_type(type) (((type)(-1)) < 0)
239 int trace_set_clr_event(const char *system, const char *event, int set);
242 * The double __builtin_constant_p is because gcc will give us an error
243 * if we try to allocate the static variable to fmt if it is not a
244 * constant. Even with the outer if statement optimizing out.
246 #define event_trace_printk(ip, fmt, args...) \
248 __trace_printk_check_format(fmt, ##args); \
249 tracing_record_cmdline(current); \
250 if (__builtin_constant_p(fmt)) { \
251 static const char *trace_printk_fmt \
252 __attribute__((section("__trace_printk_fmt"))) = \
253 __builtin_constant_p(fmt) ? fmt : NULL; \
255 __trace_bprintk(ip, trace_printk_fmt, ##args); \
257 __trace_printk(ip, fmt, ##args); \
260 #ifdef CONFIG_PERF_EVENTS
263 DECLARE_PER_CPU(struct pt_regs, perf_trace_regs);
265 extern int perf_trace_init(struct perf_event *event);
266 extern void perf_trace_destroy(struct perf_event *event);
267 extern int perf_trace_add(struct perf_event *event, int flags);
268 extern void perf_trace_del(struct perf_event *event, int flags);
269 extern int ftrace_profile_set_filter(struct perf_event *event, int event_id,
271 extern void ftrace_profile_free_filter(struct perf_event *event);
272 extern void *perf_trace_buf_prepare(int size, unsigned short type,
273 struct pt_regs *regs, int *rctxp);
276 perf_trace_buf_submit(void *raw_data, int size, int rctx, u64 addr,
277 u64 count, struct pt_regs *regs, void *head)
279 perf_tp_event(addr, count, raw_data, size, regs, head, rctx);
283 #endif /* _LINUX_FTRACE_EVENT_H */