]>
Commit | Line | Data |
---|---|---|
97f20251 SR |
1 | #ifndef _LINUX_FTRACE_EVENT_H |
2 | #define _LINUX_FTRACE_EVENT_H | |
3 | ||
97f20251 | 4 | #include <linux/ring_buffer.h> |
16bb8eb1 | 5 | #include <linux/trace_seq.h> |
be74b73a | 6 | #include <linux/percpu.h> |
20ab4425 | 7 | #include <linux/hardirq.h> |
430ad5a6 | 8 | #include <linux/perf_event.h> |
97f20251 SR |
9 | |
10 | struct trace_array; | |
12883efb | 11 | struct trace_buffer; |
97f20251 | 12 | struct tracer; |
6d723736 | 13 | struct dentry; |
97f20251 | 14 | |
be74b73a SR |
15 | struct trace_print_flags { |
16 | unsigned long mask; | |
17 | const char *name; | |
18 | }; | |
19 | ||
2fc1b6f0 | 20 | struct trace_print_flags_u64 { |
21 | unsigned long long mask; | |
22 | const char *name; | |
23 | }; | |
24 | ||
be74b73a SR |
25 | const char *ftrace_print_flags_seq(struct trace_seq *p, const char *delim, |
26 | unsigned long flags, | |
27 | const struct trace_print_flags *flag_array); | |
28 | ||
0f4fc29d SR |
29 | const char *ftrace_print_symbols_seq(struct trace_seq *p, unsigned long val, |
30 | const struct trace_print_flags *symbol_array); | |
31 | ||
2fc1b6f0 | 32 | #if BITS_PER_LONG == 32 |
33 | const char *ftrace_print_symbols_seq_u64(struct trace_seq *p, | |
34 | unsigned long long val, | |
35 | const struct trace_print_flags_u64 | |
36 | *symbol_array); | |
37 | #endif | |
38 | ||
5a2e3995 KT |
39 | const char *ftrace_print_hex_seq(struct trace_seq *p, |
40 | const unsigned char *buf, int len); | |
41 | ||
f71130de LZ |
42 | struct trace_iterator; |
43 | struct trace_event; | |
44 | ||
45 | int ftrace_raw_output_prep(struct trace_iterator *iter, | |
46 | struct trace_event *event); | |
47 | ||
97f20251 SR |
48 | /* |
49 | * The trace entry - the most basic unit of tracing. This is what | |
50 | * is printed in the end as a single line in the trace output, such as: | |
51 | * | |
52 | * bash-15816 [01] 235.197585: idle_cpu <- irq_enter | |
53 | */ | |
54 | struct trace_entry { | |
89ec0dee | 55 | unsigned short type; |
97f20251 SR |
56 | unsigned char flags; |
57 | unsigned char preempt_count; | |
58 | int pid; | |
97f20251 SR |
59 | }; |
60 | ||
89ec0dee SR |
61 | #define FTRACE_MAX_EVENT \ |
62 | ((1 << (sizeof(((struct trace_entry *)0)->type) * 8)) - 1) | |
63 | ||
97f20251 SR |
64 | /* |
65 | * Trace iterator - used by printout routines who present trace | |
66 | * results to users and which routines might sleep, etc: | |
67 | */ | |
68 | struct trace_iterator { | |
69 | struct trace_array *tr; | |
70 | struct tracer *trace; | |
12883efb | 71 | struct trace_buffer *trace_buffer; |
97f20251 SR |
72 | void *private; |
73 | int cpu_file; | |
74 | struct mutex mutex; | |
6d158a81 | 75 | struct ring_buffer_iter **buffer_iter; |
112f38a7 | 76 | unsigned long iter_flags; |
97f20251 | 77 | |
bc289ae9 LJ |
78 | /* trace_seq for __print_flags() and __print_symbolic() etc. */ |
79 | struct trace_seq tmp_seq; | |
80 | ||
97f20251 SR |
81 | /* The below is zeroed out in pipe_read */ |
82 | struct trace_seq seq; | |
83 | struct trace_entry *ent; | |
bc21b478 | 84 | unsigned long lost_events; |
a63ce5b3 | 85 | int leftover; |
4a9bd3f1 | 86 | int ent_size; |
97f20251 SR |
87 | int cpu; |
88 | u64 ts; | |
89 | ||
97f20251 SR |
90 | loff_t pos; |
91 | long idx; | |
92 | ||
93 | cpumask_var_t started; | |
debdd57f HT |
94 | |
95 | /* it's true when current open file is snapshot */ | |
96 | bool snapshot; | |
97f20251 SR |
97 | }; |
98 | ||
8be0709f DS |
99 | enum trace_iter_flags { |
100 | TRACE_FILE_LAT_FMT = 1, | |
101 | TRACE_FILE_ANNOTATE = 2, | |
102 | TRACE_FILE_TIME_IN_NS = 4, | |
103 | }; | |
104 | ||
97f20251 SR |
105 | |
106 | typedef enum print_line_t (*trace_print_func)(struct trace_iterator *iter, | |
a9a57763 SR |
107 | int flags, struct trace_event *event); |
108 | ||
109 | struct trace_event_functions { | |
97f20251 SR |
110 | trace_print_func trace; |
111 | trace_print_func raw; | |
112 | trace_print_func hex; | |
113 | trace_print_func binary; | |
114 | }; | |
115 | ||
a9a57763 SR |
116 | struct trace_event { |
117 | struct hlist_node node; | |
118 | struct list_head list; | |
119 | int type; | |
120 | struct trace_event_functions *funcs; | |
121 | }; | |
122 | ||
97f20251 SR |
123 | extern int register_ftrace_event(struct trace_event *event); |
124 | extern int unregister_ftrace_event(struct trace_event *event); | |
125 | ||
126 | /* Return values for print_line callback */ | |
127 | enum print_line_t { | |
128 | TRACE_TYPE_PARTIAL_LINE = 0, /* Retry after flushing the seq */ | |
129 | TRACE_TYPE_HANDLED = 1, | |
130 | TRACE_TYPE_UNHANDLED = 2, /* Relay to other output functions */ | |
131 | TRACE_TYPE_NO_CONSUME = 3 /* Handled but ask to not consume */ | |
132 | }; | |
133 | ||
f413cdb8 FW |
134 | void tracing_generic_entry_update(struct trace_entry *entry, |
135 | unsigned long flags, | |
136 | int pc); | |
ccb469a1 SR |
137 | struct ftrace_event_file; |
138 | ||
139 | struct ring_buffer_event * | |
140 | trace_event_buffer_lock_reserve(struct ring_buffer **current_buffer, | |
141 | struct ftrace_event_file *ftrace_file, | |
142 | int type, unsigned long len, | |
143 | unsigned long flags, int pc); | |
97f20251 | 144 | struct ring_buffer_event * |
e77405ad SR |
145 | trace_current_buffer_lock_reserve(struct ring_buffer **current_buffer, |
146 | int type, unsigned long len, | |
97f20251 | 147 | unsigned long flags, int pc); |
e77405ad SR |
148 | void trace_current_buffer_unlock_commit(struct ring_buffer *buffer, |
149 | struct ring_buffer_event *event, | |
97f20251 | 150 | unsigned long flags, int pc); |
0d5c6e1c SR |
151 | void trace_buffer_unlock_commit(struct ring_buffer *buffer, |
152 | struct ring_buffer_event *event, | |
153 | unsigned long flags, int pc); | |
154 | void trace_buffer_unlock_commit_regs(struct ring_buffer *buffer, | |
155 | struct ring_buffer_event *event, | |
156 | unsigned long flags, int pc, | |
157 | struct pt_regs *regs); | |
e77405ad SR |
158 | void trace_current_buffer_discard_commit(struct ring_buffer *buffer, |
159 | struct ring_buffer_event *event); | |
97f20251 SR |
160 | |
161 | void tracing_record_cmdline(struct task_struct *tsk); | |
162 | ||
1f9963cb LZ |
163 | struct event_filter; |
164 | ||
2239291a SR |
165 | enum trace_reg { |
166 | TRACE_REG_REGISTER, | |
167 | TRACE_REG_UNREGISTER, | |
37d73998 | 168 | #ifdef CONFIG_PERF_EVENTS |
2239291a SR |
169 | TRACE_REG_PERF_REGISTER, |
170 | TRACE_REG_PERF_UNREGISTER, | |
ceec0b6f JO |
171 | TRACE_REG_PERF_OPEN, |
172 | TRACE_REG_PERF_CLOSE, | |
489c75c3 JO |
173 | TRACE_REG_PERF_ADD, |
174 | TRACE_REG_PERF_DEL, | |
37d73998 | 175 | #endif |
2239291a SR |
176 | }; |
177 | ||
178 | struct ftrace_event_call; | |
179 | ||
8f082018 SR |
180 | struct ftrace_event_class { |
181 | char *system; | |
2239291a SR |
182 | void *probe; |
183 | #ifdef CONFIG_PERF_EVENTS | |
184 | void *perf_probe; | |
185 | #endif | |
186 | int (*reg)(struct ftrace_event_call *event, | |
ceec0b6f | 187 | enum trace_reg type, void *data); |
2e33af02 SR |
188 | int (*define_fields)(struct ftrace_event_call *); |
189 | struct list_head *(*get_fields)(struct ftrace_event_call *); | |
190 | struct list_head fields; | |
0405ab80 | 191 | int (*raw_init)(struct ftrace_event_call *); |
8f082018 SR |
192 | }; |
193 | ||
a1d0ce82 | 194 | extern int ftrace_event_reg(struct ftrace_event_call *event, |
ceec0b6f | 195 | enum trace_reg type, void *data); |
a1d0ce82 | 196 | |
553552ce | 197 | enum { |
553552ce | 198 | TRACE_EVENT_FL_FILTERED_BIT, |
61c32659 | 199 | TRACE_EVENT_FL_CAP_ANY_BIT, |
27b14b56 | 200 | TRACE_EVENT_FL_NO_SET_FILTER_BIT, |
9b63776f | 201 | TRACE_EVENT_FL_IGNORE_ENABLE_BIT, |
575380da | 202 | TRACE_EVENT_FL_WAS_ENABLED_BIT, |
553552ce SR |
203 | }; |
204 | ||
ae63b31e SR |
205 | /* |
206 | * Event flags: | |
207 | * FILTERED - The event has a filter attached | |
208 | * CAP_ANY - Any user can enable for perf | |
209 | * NO_SET_FILTER - Set when filter has error and is to be ignored | |
2a30c11f | 210 | * IGNORE_ENABLE - For ftrace internal events, do not enable with debugfs file |
575380da SRRH |
211 | * WAS_ENABLED - Set and stays set when an event was ever enabled |
212 | * (used for module unloading, if a module event is enabled, | |
213 | * it is best to clear the buffers that used it). | |
ae63b31e | 214 | */ |
553552ce | 215 | enum { |
e870e9a1 | 216 | TRACE_EVENT_FL_FILTERED = (1 << TRACE_EVENT_FL_FILTERED_BIT), |
61c32659 | 217 | TRACE_EVENT_FL_CAP_ANY = (1 << TRACE_EVENT_FL_CAP_ANY_BIT), |
27b14b56 | 218 | TRACE_EVENT_FL_NO_SET_FILTER = (1 << TRACE_EVENT_FL_NO_SET_FILTER_BIT), |
9b63776f | 219 | TRACE_EVENT_FL_IGNORE_ENABLE = (1 << TRACE_EVENT_FL_IGNORE_ENABLE_BIT), |
575380da | 220 | TRACE_EVENT_FL_WAS_ENABLED = (1 << TRACE_EVENT_FL_WAS_ENABLED_BIT), |
553552ce SR |
221 | }; |
222 | ||
97f20251 | 223 | struct ftrace_event_call { |
a59fd602 | 224 | struct list_head list; |
8f082018 | 225 | struct ftrace_event_class *class; |
97f20251 | 226 | char *name; |
80decc70 | 227 | struct trace_event event; |
509e760c | 228 | const char *print_fmt; |
1f9963cb | 229 | struct event_filter *filter; |
ae63b31e | 230 | struct list_head *files; |
6d723736 | 231 | void *mod; |
69fd4f0e | 232 | void *data; |
57d01ad0 SRRH |
233 | /* |
234 | * bit 0: filter_active | |
235 | * bit 1: allow trace by non root (cap any) | |
236 | * bit 2: failed to apply filter | |
237 | * bit 3: ftrace internal event (do not enable) | |
238 | * bit 4: Event was enabled by module | |
239 | */ | |
ae63b31e SR |
240 | int flags; /* static flags of different events */ |
241 | ||
242 | #ifdef CONFIG_PERF_EVENTS | |
243 | int perf_refcount; | |
244 | struct hlist_head __percpu *perf_events; | |
245 | #endif | |
246 | }; | |
247 | ||
248 | struct trace_array; | |
249 | struct ftrace_subsystem_dir; | |
250 | ||
251 | enum { | |
252 | FTRACE_EVENT_FL_ENABLED_BIT, | |
253 | FTRACE_EVENT_FL_RECORDED_CMD_BIT, | |
417944c4 SRRH |
254 | FTRACE_EVENT_FL_SOFT_MODE_BIT, |
255 | FTRACE_EVENT_FL_SOFT_DISABLED_BIT, | |
ae63b31e SR |
256 | }; |
257 | ||
258 | /* | |
259 | * Ftrace event file flags: | |
57d01ad0 | 260 | * ENABLED - The event is enabled |
ae63b31e | 261 | * RECORDED_CMD - The comms should be recorded at sched_switch |
417944c4 SRRH |
262 | * SOFT_MODE - The event is enabled/disabled by SOFT_DISABLED |
263 | * SOFT_DISABLED - When set, do not trace the event (even though its | |
264 | * tracepoint may be enabled) | |
ae63b31e SR |
265 | */ |
266 | enum { | |
267 | FTRACE_EVENT_FL_ENABLED = (1 << FTRACE_EVENT_FL_ENABLED_BIT), | |
268 | FTRACE_EVENT_FL_RECORDED_CMD = (1 << FTRACE_EVENT_FL_RECORDED_CMD_BIT), | |
417944c4 SRRH |
269 | FTRACE_EVENT_FL_SOFT_MODE = (1 << FTRACE_EVENT_FL_SOFT_MODE_BIT), |
270 | FTRACE_EVENT_FL_SOFT_DISABLED = (1 << FTRACE_EVENT_FL_SOFT_DISABLED_BIT), | |
ae63b31e SR |
271 | }; |
272 | ||
273 | struct ftrace_event_file { | |
274 | struct list_head list; | |
275 | struct ftrace_event_call *event_call; | |
276 | struct dentry *dir; | |
277 | struct trace_array *tr; | |
278 | struct ftrace_subsystem_dir *system; | |
97f20251 | 279 | |
553552ce SR |
280 | /* |
281 | * 32 bit flags: | |
57d01ad0 SRRH |
282 | * bit 0: enabled |
283 | * bit 1: enabled cmd record | |
417944c4 SRRH |
284 | * bit 2: enable/disable with the soft disable bit |
285 | * bit 3: soft disabled | |
553552ce | 286 | * |
417944c4 SRRH |
287 | * Note: The bits must be set atomically to prevent races |
288 | * from other writers. Reads of flags do not need to be in | |
289 | * sync as they occur in critical sections. But the way flags | |
ae63b31e | 290 | * is currently used, these changes do not affect the code |
1eaa4787 SR |
291 | * except that when a change is made, it may have a slight |
292 | * delay in propagating the changes to other CPUs due to | |
417944c4 | 293 | * caching and such. Which is mostly OK ;-) |
553552ce | 294 | */ |
417944c4 | 295 | unsigned long flags; |
97f20251 SR |
296 | }; |
297 | ||
53cf810b FW |
298 | #define __TRACE_EVENT_FLAGS(name, value) \ |
299 | static int __init trace_init_flags_##name(void) \ | |
300 | { \ | |
301 | event_##name.flags = value; \ | |
302 | return 0; \ | |
303 | } \ | |
304 | early_initcall(trace_init_flags_##name); | |
305 | ||
97d5a220 | 306 | #define PERF_MAX_TRACE_SIZE 2048 |
20ab4425 | 307 | |
16bb8eb1 | 308 | #define MAX_FILTER_STR_VAL 256 /* Should handle KSYM_SYMBOL_LEN */ |
97f20251 | 309 | |
2df75e41 | 310 | extern void destroy_preds(struct ftrace_event_call *call); |
6fb2915d | 311 | extern int filter_match_preds(struct event_filter *filter, void *rec); |
e77405ad SR |
312 | extern int filter_current_check_discard(struct ring_buffer *buffer, |
313 | struct ftrace_event_call *call, | |
97f20251 SR |
314 | void *rec, |
315 | struct ring_buffer_event *event); | |
316 | ||
43b51ead LZ |
317 | enum { |
318 | FILTER_OTHER = 0, | |
319 | FILTER_STATIC_STRING, | |
320 | FILTER_DYN_STRING, | |
87a342f5 | 321 | FILTER_PTR_STRING, |
02aa3162 | 322 | FILTER_TRACE_FN, |
43b51ead LZ |
323 | }; |
324 | ||
04295780 SR |
325 | #define EVENT_STORAGE_SIZE 128 |
326 | extern struct mutex event_storage_mutex; | |
327 | extern char event_storage[EVENT_STORAGE_SIZE]; | |
328 | ||
87d9b4e1 | 329 | extern int trace_event_raw_init(struct ftrace_event_call *call); |
aeaeae11 FW |
330 | extern int trace_define_field(struct ftrace_event_call *call, const char *type, |
331 | const char *name, int offset, int size, | |
332 | int is_signed, int filter_type); | |
bd1a5c84 MH |
333 | extern int trace_add_event_call(struct ftrace_event_call *call); |
334 | extern void trace_remove_event_call(struct ftrace_event_call *call); | |
97f20251 | 335 | |
418c59e4 | 336 | #define is_signed_type(type) (((type)(-1)) < (type)0) |
97f20251 | 337 | |
4671c794 SR |
338 | int trace_set_clr_event(const char *system, const char *event, int set); |
339 | ||
97f20251 SR |
340 | /* |
341 | * The double __builtin_constant_p is because gcc will give us an error | |
342 | * if we try to allocate the static variable to fmt if it is not a | |
343 | * constant. Even with the outer if statement optimizing out. | |
344 | */ | |
345 | #define event_trace_printk(ip, fmt, args...) \ | |
346 | do { \ | |
347 | __trace_printk_check_format(fmt, ##args); \ | |
348 | tracing_record_cmdline(current); \ | |
349 | if (__builtin_constant_p(fmt)) { \ | |
350 | static const char *trace_printk_fmt \ | |
351 | __attribute__((section("__trace_printk_fmt"))) = \ | |
352 | __builtin_constant_p(fmt) ? fmt : NULL; \ | |
353 | \ | |
354 | __trace_bprintk(ip, trace_printk_fmt, ##args); \ | |
355 | } else \ | |
356 | __trace_printk(ip, fmt, ##args); \ | |
357 | } while (0) | |
358 | ||
07b139c8 | 359 | #ifdef CONFIG_PERF_EVENTS |
6fb2915d | 360 | struct perf_event; |
c530665c FW |
361 | |
362 | DECLARE_PER_CPU(struct pt_regs, perf_trace_regs); | |
363 | ||
1c024eca PZ |
364 | extern int perf_trace_init(struct perf_event *event); |
365 | extern void perf_trace_destroy(struct perf_event *event); | |
a4eaf7f1 PZ |
366 | extern int perf_trace_add(struct perf_event *event, int flags); |
367 | extern void perf_trace_del(struct perf_event *event, int flags); | |
1c024eca | 368 | extern int ftrace_profile_set_filter(struct perf_event *event, int event_id, |
6fb2915d LZ |
369 | char *filter_str); |
370 | extern void ftrace_profile_free_filter(struct perf_event *event); | |
b7e2ecef PZ |
371 | extern void *perf_trace_buf_prepare(int size, unsigned short type, |
372 | struct pt_regs *regs, int *rctxp); | |
430ad5a6 XG |
373 | |
374 | static inline void | |
97d5a220 | 375 | perf_trace_buf_submit(void *raw_data, int size, int rctx, u64 addr, |
e6dab5ff AV |
376 | u64 count, struct pt_regs *regs, void *head, |
377 | struct task_struct *task) | |
430ad5a6 | 378 | { |
e6dab5ff | 379 | perf_tp_event(addr, count, raw_data, size, regs, head, rctx, task); |
430ad5a6 | 380 | } |
6fb2915d LZ |
381 | #endif |
382 | ||
97f20251 | 383 | #endif /* _LINUX_FTRACE_EVENT_H */ |