Commit | Line | Data |
---|---|---|
bac5fb97 | 1 | |
97f20251 SR |
2 | #ifndef _LINUX_FTRACE_EVENT_H |
3 | #define _LINUX_FTRACE_EVENT_H | |
4 | ||
97f20251 | 5 | #include <linux/ring_buffer.h> |
16bb8eb1 | 6 | #include <linux/trace_seq.h> |
be74b73a | 7 | #include <linux/percpu.h> |
20ab4425 | 8 | #include <linux/hardirq.h> |
430ad5a6 | 9 | #include <linux/perf_event.h> |
97f20251 SR |
10 | |
11 | struct trace_array; | |
12883efb | 12 | struct trace_buffer; |
97f20251 | 13 | struct tracer; |
6d723736 | 14 | struct dentry; |
97f20251 | 15 | |
be74b73a SR |
16 | struct trace_print_flags { |
17 | unsigned long mask; | |
18 | const char *name; | |
19 | }; | |
20 | ||
2fc1b6f0 | 21 | struct trace_print_flags_u64 { |
22 | unsigned long long mask; | |
23 | const char *name; | |
24 | }; | |
25 | ||
be74b73a SR |
26 | const char *ftrace_print_flags_seq(struct trace_seq *p, const char *delim, |
27 | unsigned long flags, | |
28 | const struct trace_print_flags *flag_array); | |
29 | ||
0f4fc29d SR |
30 | const char *ftrace_print_symbols_seq(struct trace_seq *p, unsigned long val, |
31 | const struct trace_print_flags *symbol_array); | |
32 | ||
2fc1b6f0 | 33 | #if BITS_PER_LONG == 32 |
34 | const char *ftrace_print_symbols_seq_u64(struct trace_seq *p, | |
35 | unsigned long long val, | |
36 | const struct trace_print_flags_u64 | |
37 | *symbol_array); | |
38 | #endif | |
39 | ||
5a2e3995 KT |
40 | const char *ftrace_print_hex_seq(struct trace_seq *p, |
41 | const unsigned char *buf, int len); | |
42 | ||
f71130de LZ |
43 | struct trace_iterator; |
44 | struct trace_event; | |
45 | ||
46 | int ftrace_raw_output_prep(struct trace_iterator *iter, | |
47 | struct trace_event *event); | |
48 | ||
97f20251 SR |
49 | /* |
50 | * The trace entry - the most basic unit of tracing. This is what | |
51 | * is printed in the end as a single line in the trace output, such as: | |
52 | * | |
53 | * bash-15816 [01] 235.197585: idle_cpu <- irq_enter | |
54 | */ | |
55 | struct trace_entry { | |
89ec0dee | 56 | unsigned short type; |
97f20251 SR |
57 | unsigned char flags; |
58 | unsigned char preempt_count; | |
59 | int pid; | |
97f20251 SR |
60 | }; |
61 | ||
89ec0dee SR |
62 | #define FTRACE_MAX_EVENT \ |
63 | ((1 << (sizeof(((struct trace_entry *)0)->type) * 8)) - 1) | |
64 | ||
97f20251 SR |
65 | /* |
66 | * Trace iterator - used by printout routines who present trace | |
67 | * results to users and which routines might sleep, etc: | |
68 | */ | |
69 | struct trace_iterator { | |
70 | struct trace_array *tr; | |
71 | struct tracer *trace; | |
12883efb | 72 | struct trace_buffer *trace_buffer; |
97f20251 SR |
73 | void *private; |
74 | int cpu_file; | |
75 | struct mutex mutex; | |
6d158a81 | 76 | struct ring_buffer_iter **buffer_iter; |
112f38a7 | 77 | unsigned long iter_flags; |
97f20251 | 78 | |
bc289ae9 LJ |
79 | /* trace_seq for __print_flags() and __print_symbolic() etc. */ |
80 | struct trace_seq tmp_seq; | |
81 | ||
ed5467da AV |
82 | cpumask_var_t started; |
83 | ||
84 | /* it's true when current open file is snapshot */ | |
85 | bool snapshot; | |
86 | ||
97f20251 SR |
87 | /* The below is zeroed out in pipe_read */ |
88 | struct trace_seq seq; | |
89 | struct trace_entry *ent; | |
bc21b478 | 90 | unsigned long lost_events; |
a63ce5b3 | 91 | int leftover; |
4a9bd3f1 | 92 | int ent_size; |
97f20251 SR |
93 | int cpu; |
94 | u64 ts; | |
95 | ||
97f20251 SR |
96 | loff_t pos; |
97 | long idx; | |
98 | ||
ed5467da | 99 | /* All new field here will be zeroed out in pipe_read */ |
97f20251 SR |
100 | }; |
101 | ||
8be0709f DS |
102 | enum trace_iter_flags { |
103 | TRACE_FILE_LAT_FMT = 1, | |
104 | TRACE_FILE_ANNOTATE = 2, | |
105 | TRACE_FILE_TIME_IN_NS = 4, | |
106 | }; | |
107 | ||
97f20251 SR |
108 | |
109 | typedef enum print_line_t (*trace_print_func)(struct trace_iterator *iter, | |
a9a57763 SR |
110 | int flags, struct trace_event *event); |
111 | ||
112 | struct trace_event_functions { | |
97f20251 SR |
113 | trace_print_func trace; |
114 | trace_print_func raw; | |
115 | trace_print_func hex; | |
116 | trace_print_func binary; | |
117 | }; | |
118 | ||
a9a57763 SR |
119 | struct trace_event { |
120 | struct hlist_node node; | |
121 | struct list_head list; | |
122 | int type; | |
123 | struct trace_event_functions *funcs; | |
124 | }; | |
125 | ||
97f20251 SR |
126 | extern int register_ftrace_event(struct trace_event *event); |
127 | extern int unregister_ftrace_event(struct trace_event *event); | |
128 | ||
129 | /* Return values for print_line callback */ | |
130 | enum print_line_t { | |
131 | TRACE_TYPE_PARTIAL_LINE = 0, /* Retry after flushing the seq */ | |
132 | TRACE_TYPE_HANDLED = 1, | |
133 | TRACE_TYPE_UNHANDLED = 2, /* Relay to other output functions */ | |
134 | TRACE_TYPE_NO_CONSUME = 3 /* Handled but ask to not consume */ | |
135 | }; | |
136 | ||
f413cdb8 FW |
137 | void tracing_generic_entry_update(struct trace_entry *entry, |
138 | unsigned long flags, | |
139 | int pc); | |
ccb469a1 SR |
140 | struct ftrace_event_file; |
141 | ||
142 | struct ring_buffer_event * | |
143 | trace_event_buffer_lock_reserve(struct ring_buffer **current_buffer, | |
144 | struct ftrace_event_file *ftrace_file, | |
145 | int type, unsigned long len, | |
146 | unsigned long flags, int pc); | |
97f20251 | 147 | struct ring_buffer_event * |
e77405ad SR |
148 | trace_current_buffer_lock_reserve(struct ring_buffer **current_buffer, |
149 | int type, unsigned long len, | |
97f20251 | 150 | unsigned long flags, int pc); |
e77405ad SR |
151 | void trace_current_buffer_unlock_commit(struct ring_buffer *buffer, |
152 | struct ring_buffer_event *event, | |
97f20251 | 153 | unsigned long flags, int pc); |
0d5c6e1c SR |
154 | void trace_buffer_unlock_commit(struct ring_buffer *buffer, |
155 | struct ring_buffer_event *event, | |
156 | unsigned long flags, int pc); | |
157 | void trace_buffer_unlock_commit_regs(struct ring_buffer *buffer, | |
158 | struct ring_buffer_event *event, | |
159 | unsigned long flags, int pc, | |
160 | struct pt_regs *regs); | |
e77405ad SR |
161 | void trace_current_buffer_discard_commit(struct ring_buffer *buffer, |
162 | struct ring_buffer_event *event); | |
97f20251 SR |
163 | |
164 | void tracing_record_cmdline(struct task_struct *tsk); | |
165 | ||
1d6bae96 SR |
166 | int ftrace_output_call(struct trace_iterator *iter, char *name, char *fmt, ...); |
167 | ||
1f9963cb LZ |
168 | struct event_filter; |
169 | ||
2239291a SR |
170 | enum trace_reg { |
171 | TRACE_REG_REGISTER, | |
172 | TRACE_REG_UNREGISTER, | |
37d73998 | 173 | #ifdef CONFIG_PERF_EVENTS |
2239291a SR |
174 | TRACE_REG_PERF_REGISTER, |
175 | TRACE_REG_PERF_UNREGISTER, | |
ceec0b6f JO |
176 | TRACE_REG_PERF_OPEN, |
177 | TRACE_REG_PERF_CLOSE, | |
489c75c3 JO |
178 | TRACE_REG_PERF_ADD, |
179 | TRACE_REG_PERF_DEL, | |
37d73998 | 180 | #endif |
2239291a SR |
181 | }; |
182 | ||
183 | struct ftrace_event_call; | |
184 | ||
8f082018 SR |
185 | struct ftrace_event_class { |
186 | char *system; | |
2239291a SR |
187 | void *probe; |
188 | #ifdef CONFIG_PERF_EVENTS | |
189 | void *perf_probe; | |
190 | #endif | |
191 | int (*reg)(struct ftrace_event_call *event, | |
ceec0b6f | 192 | enum trace_reg type, void *data); |
2e33af02 SR |
193 | int (*define_fields)(struct ftrace_event_call *); |
194 | struct list_head *(*get_fields)(struct ftrace_event_call *); | |
195 | struct list_head fields; | |
0405ab80 | 196 | int (*raw_init)(struct ftrace_event_call *); |
8f082018 SR |
197 | }; |
198 | ||
a1d0ce82 | 199 | extern int ftrace_event_reg(struct ftrace_event_call *event, |
ceec0b6f | 200 | enum trace_reg type, void *data); |
a1d0ce82 | 201 | |
1d6bae96 SR |
202 | int ftrace_output_event(struct trace_iterator *iter, struct ftrace_event_call *event, |
203 | char *fmt, ...); | |
204 | ||
35bb4399 SR |
205 | int ftrace_event_define_field(struct ftrace_event_call *call, |
206 | char *type, int len, char *item, int offset, | |
207 | int field_size, int sign, int filter); | |
208 | ||
3fd40d1e SR |
209 | struct ftrace_event_buffer { |
210 | struct ring_buffer *buffer; | |
211 | struct ring_buffer_event *event; | |
212 | struct ftrace_event_file *ftrace_file; | |
213 | void *entry; | |
214 | unsigned long flags; | |
215 | int pc; | |
216 | }; | |
217 | ||
218 | void *ftrace_event_buffer_reserve(struct ftrace_event_buffer *fbuffer, | |
219 | struct ftrace_event_file *ftrace_file, | |
220 | unsigned long len); | |
221 | ||
222 | void ftrace_event_buffer_commit(struct ftrace_event_buffer *fbuffer); | |
223 | ||
bc4c426e SRRH |
224 | int ftrace_event_define_field(struct ftrace_event_call *call, |
225 | char *type, int len, char *item, int offset, | |
226 | int field_size, int sign, int filter); | |
227 | ||
553552ce | 228 | enum { |
553552ce | 229 | TRACE_EVENT_FL_FILTERED_BIT, |
61c32659 | 230 | TRACE_EVENT_FL_CAP_ANY_BIT, |
27b14b56 | 231 | TRACE_EVENT_FL_NO_SET_FILTER_BIT, |
9b63776f | 232 | TRACE_EVENT_FL_IGNORE_ENABLE_BIT, |
575380da | 233 | TRACE_EVENT_FL_WAS_ENABLED_BIT, |
f306cc82 | 234 | TRACE_EVENT_FL_USE_CALL_FILTER_BIT, |
553552ce SR |
235 | }; |
236 | ||
ae63b31e SR |
237 | /* |
238 | * Event flags: | |
239 | * FILTERED - The event has a filter attached | |
240 | * CAP_ANY - Any user can enable for perf | |
241 | * NO_SET_FILTER - Set when filter has error and is to be ignored | |
2a30c11f | 242 | * IGNORE_ENABLE - For ftrace internal events, do not enable with debugfs file |
575380da SRRH |
243 | * WAS_ENABLED - Set and stays set when an event was ever enabled |
244 | * (used for module unloading, if a module event is enabled, | |
245 | * it is best to clear the buffers that used it). | |
f306cc82 | 246 | * USE_CALL_FILTER - For ftrace internal events, don't use file filter |
ae63b31e | 247 | */ |
553552ce | 248 | enum { |
e870e9a1 | 249 | TRACE_EVENT_FL_FILTERED = (1 << TRACE_EVENT_FL_FILTERED_BIT), |
61c32659 | 250 | TRACE_EVENT_FL_CAP_ANY = (1 << TRACE_EVENT_FL_CAP_ANY_BIT), |
27b14b56 | 251 | TRACE_EVENT_FL_NO_SET_FILTER = (1 << TRACE_EVENT_FL_NO_SET_FILTER_BIT), |
9b63776f | 252 | TRACE_EVENT_FL_IGNORE_ENABLE = (1 << TRACE_EVENT_FL_IGNORE_ENABLE_BIT), |
575380da | 253 | TRACE_EVENT_FL_WAS_ENABLED = (1 << TRACE_EVENT_FL_WAS_ENABLED_BIT), |
f306cc82 | 254 | TRACE_EVENT_FL_USE_CALL_FILTER = (1 << TRACE_EVENT_FL_USE_CALL_FILTER_BIT), |
553552ce SR |
255 | }; |
256 | ||
97f20251 | 257 | struct ftrace_event_call { |
a59fd602 | 258 | struct list_head list; |
8f082018 | 259 | struct ftrace_event_class *class; |
97f20251 | 260 | char *name; |
80decc70 | 261 | struct trace_event event; |
509e760c | 262 | const char *print_fmt; |
1f9963cb | 263 | struct event_filter *filter; |
ae63b31e | 264 | struct list_head *files; |
6d723736 | 265 | void *mod; |
69fd4f0e | 266 | void *data; |
57d01ad0 SRRH |
267 | /* |
268 | * bit 0: filter_active | |
269 | * bit 1: allow trace by non root (cap any) | |
270 | * bit 2: failed to apply filter | |
271 | * bit 3: ftrace internal event (do not enable) | |
272 | * bit 4: Event was enabled by module | |
f306cc82 | 273 | * bit 5: use call filter rather than file filter |
57d01ad0 | 274 | */ |
ae63b31e SR |
275 | int flags; /* static flags of different events */ |
276 | ||
277 | #ifdef CONFIG_PERF_EVENTS | |
278 | int perf_refcount; | |
279 | struct hlist_head __percpu *perf_events; | |
d5b5f391 PZ |
280 | |
281 | int (*perf_perm)(struct ftrace_event_call *, | |
282 | struct perf_event *); | |
ae63b31e SR |
283 | #endif |
284 | }; | |
285 | ||
286 | struct trace_array; | |
287 | struct ftrace_subsystem_dir; | |
288 | ||
289 | enum { | |
290 | FTRACE_EVENT_FL_ENABLED_BIT, | |
291 | FTRACE_EVENT_FL_RECORDED_CMD_BIT, | |
f306cc82 TZ |
292 | FTRACE_EVENT_FL_FILTERED_BIT, |
293 | FTRACE_EVENT_FL_NO_SET_FILTER_BIT, | |
417944c4 SRRH |
294 | FTRACE_EVENT_FL_SOFT_MODE_BIT, |
295 | FTRACE_EVENT_FL_SOFT_DISABLED_BIT, | |
85f2b082 | 296 | FTRACE_EVENT_FL_TRIGGER_MODE_BIT, |
bac5fb97 | 297 | FTRACE_EVENT_FL_TRIGGER_COND_BIT, |
ae63b31e SR |
298 | }; |
299 | ||
300 | /* | |
301 | * Ftrace event file flags: | |
57d01ad0 | 302 | * ENABLED - The event is enabled |
ae63b31e | 303 | * RECORDED_CMD - The comms should be recorded at sched_switch |
f306cc82 TZ |
304 | * FILTERED - The event has a filter attached |
305 | * NO_SET_FILTER - Set when filter has error and is to be ignored | |
417944c4 SRRH |
306 | * SOFT_MODE - The event is enabled/disabled by SOFT_DISABLED |
307 | * SOFT_DISABLED - When set, do not trace the event (even though its | |
308 | * tracepoint may be enabled) | |
85f2b082 | 309 | * TRIGGER_MODE - When set, invoke the triggers associated with the event |
bac5fb97 | 310 | * TRIGGER_COND - When set, one or more triggers has an associated filter |
ae63b31e SR |
311 | */ |
312 | enum { | |
313 | FTRACE_EVENT_FL_ENABLED = (1 << FTRACE_EVENT_FL_ENABLED_BIT), | |
314 | FTRACE_EVENT_FL_RECORDED_CMD = (1 << FTRACE_EVENT_FL_RECORDED_CMD_BIT), | |
f306cc82 TZ |
315 | FTRACE_EVENT_FL_FILTERED = (1 << FTRACE_EVENT_FL_FILTERED_BIT), |
316 | FTRACE_EVENT_FL_NO_SET_FILTER = (1 << FTRACE_EVENT_FL_NO_SET_FILTER_BIT), | |
417944c4 SRRH |
317 | FTRACE_EVENT_FL_SOFT_MODE = (1 << FTRACE_EVENT_FL_SOFT_MODE_BIT), |
318 | FTRACE_EVENT_FL_SOFT_DISABLED = (1 << FTRACE_EVENT_FL_SOFT_DISABLED_BIT), | |
85f2b082 | 319 | FTRACE_EVENT_FL_TRIGGER_MODE = (1 << FTRACE_EVENT_FL_TRIGGER_MODE_BIT), |
bac5fb97 | 320 | FTRACE_EVENT_FL_TRIGGER_COND = (1 << FTRACE_EVENT_FL_TRIGGER_COND_BIT), |
ae63b31e SR |
321 | }; |
322 | ||
323 | struct ftrace_event_file { | |
324 | struct list_head list; | |
325 | struct ftrace_event_call *event_call; | |
f306cc82 | 326 | struct event_filter *filter; |
ae63b31e SR |
327 | struct dentry *dir; |
328 | struct trace_array *tr; | |
329 | struct ftrace_subsystem_dir *system; | |
85f2b082 | 330 | struct list_head triggers; |
97f20251 | 331 | |
553552ce SR |
332 | /* |
333 | * 32 bit flags: | |
57d01ad0 SRRH |
334 | * bit 0: enabled |
335 | * bit 1: enabled cmd record | |
417944c4 SRRH |
336 | * bit 2: enable/disable with the soft disable bit |
337 | * bit 3: soft disabled | |
85f2b082 | 338 | * bit 4: trigger enabled |
553552ce | 339 | * |
417944c4 SRRH |
340 | * Note: The bits must be set atomically to prevent races |
341 | * from other writers. Reads of flags do not need to be in | |
342 | * sync as they occur in critical sections. But the way flags | |
ae63b31e | 343 | * is currently used, these changes do not affect the code |
1eaa4787 SR |
344 | * except that when a change is made, it may have a slight |
345 | * delay in propagating the changes to other CPUs due to | |
417944c4 | 346 | * caching and such. Which is mostly OK ;-) |
553552ce | 347 | */ |
417944c4 | 348 | unsigned long flags; |
1cf4c073 | 349 | atomic_t sm_ref; /* soft-mode reference counter */ |
85f2b082 | 350 | atomic_t tm_ref; /* trigger-mode reference counter */ |
97f20251 SR |
351 | }; |
352 | ||
53cf810b FW |
353 | #define __TRACE_EVENT_FLAGS(name, value) \ |
354 | static int __init trace_init_flags_##name(void) \ | |
355 | { \ | |
356 | event_##name.flags = value; \ | |
357 | return 0; \ | |
358 | } \ | |
359 | early_initcall(trace_init_flags_##name); | |
360 | ||
d5b5f391 PZ |
361 | #define __TRACE_EVENT_PERF_PERM(name, expr...) \ |
362 | static int perf_perm_##name(struct ftrace_event_call *tp_event, \ | |
363 | struct perf_event *p_event) \ | |
364 | { \ | |
365 | return ({ expr; }); \ | |
366 | } \ | |
367 | static int __init trace_init_perf_perm_##name(void) \ | |
368 | { \ | |
369 | event_##name.perf_perm = &perf_perm_##name; \ | |
370 | return 0; \ | |
371 | } \ | |
372 | early_initcall(trace_init_perf_perm_##name); | |
373 | ||
97d5a220 | 374 | #define PERF_MAX_TRACE_SIZE 2048 |
20ab4425 | 375 | |
16bb8eb1 | 376 | #define MAX_FILTER_STR_VAL 256 /* Should handle KSYM_SYMBOL_LEN */ |
97f20251 | 377 | |
85f2b082 TZ |
378 | enum event_trigger_type { |
379 | ETT_NONE = (0), | |
2a2df321 | 380 | ETT_TRACE_ONOFF = (1 << 0), |
93e31ffb | 381 | ETT_SNAPSHOT = (1 << 1), |
f21ecbb3 | 382 | ETT_STACKTRACE = (1 << 2), |
7862ad18 | 383 | ETT_EVENT_ENABLE = (1 << 3), |
85f2b082 TZ |
384 | }; |
385 | ||
f306cc82 TZ |
386 | extern void destroy_preds(struct ftrace_event_file *file); |
387 | extern void destroy_call_preds(struct ftrace_event_call *call); | |
6fb2915d | 388 | extern int filter_match_preds(struct event_filter *filter, void *rec); |
f306cc82 TZ |
389 | |
390 | extern int filter_check_discard(struct ftrace_event_file *file, void *rec, | |
391 | struct ring_buffer *buffer, | |
392 | struct ring_buffer_event *event); | |
393 | extern int call_filter_check_discard(struct ftrace_event_call *call, void *rec, | |
394 | struct ring_buffer *buffer, | |
395 | struct ring_buffer_event *event); | |
bac5fb97 TZ |
396 | extern enum event_trigger_type event_triggers_call(struct ftrace_event_file *file, |
397 | void *rec); | |
398 | extern void event_triggers_post_call(struct ftrace_event_file *file, | |
399 | enum event_trigger_type tt); | |
97f20251 | 400 | |
13a1e4ae SRRH |
401 | /** |
402 | * ftrace_trigger_soft_disabled - do triggers and test if soft disabled | |
403 | * @file: The file pointer of the event to test | |
404 | * | |
405 | * If any triggers without filters are attached to this event, they | |
406 | * will be called here. If the event is soft disabled and has no | |
407 | * triggers that require testing the fields, it will return true, | |
408 | * otherwise false. | |
409 | */ | |
410 | static inline bool | |
411 | ftrace_trigger_soft_disabled(struct ftrace_event_file *file) | |
412 | { | |
413 | unsigned long eflags = file->flags; | |
414 | ||
415 | if (!(eflags & FTRACE_EVENT_FL_TRIGGER_COND)) { | |
416 | if (eflags & FTRACE_EVENT_FL_TRIGGER_MODE) | |
417 | event_triggers_call(file, NULL); | |
418 | if (eflags & FTRACE_EVENT_FL_SOFT_DISABLED) | |
419 | return true; | |
420 | } | |
421 | return false; | |
422 | } | |
423 | ||
424 | /* | |
425 | * Helper function for event_trigger_unlock_commit{_regs}(). | |
426 | * If there are event triggers attached to this event that requires | |
427 | * filtering against its fields, then they wil be called as the | |
428 | * entry already holds the field information of the current event. | |
429 | * | |
430 | * It also checks if the event should be discarded or not. | |
431 | * It is to be discarded if the event is soft disabled and the | |
432 | * event was only recorded to process triggers, or if the event | |
433 | * filter is active and this event did not match the filters. | |
434 | * | |
435 | * Returns true if the event is discarded, false otherwise. | |
436 | */ | |
437 | static inline bool | |
438 | __event_trigger_test_discard(struct ftrace_event_file *file, | |
439 | struct ring_buffer *buffer, | |
440 | struct ring_buffer_event *event, | |
441 | void *entry, | |
442 | enum event_trigger_type *tt) | |
443 | { | |
444 | unsigned long eflags = file->flags; | |
445 | ||
446 | if (eflags & FTRACE_EVENT_FL_TRIGGER_COND) | |
447 | *tt = event_triggers_call(file, entry); | |
448 | ||
449 | if (test_bit(FTRACE_EVENT_FL_SOFT_DISABLED_BIT, &file->flags)) | |
450 | ring_buffer_discard_commit(buffer, event); | |
451 | else if (!filter_check_discard(file, entry, buffer, event)) | |
452 | return false; | |
453 | ||
454 | return true; | |
455 | } | |
456 | ||
457 | /** | |
458 | * event_trigger_unlock_commit - handle triggers and finish event commit | |
459 | * @file: The file pointer assoctiated to the event | |
460 | * @buffer: The ring buffer that the event is being written to | |
461 | * @event: The event meta data in the ring buffer | |
462 | * @entry: The event itself | |
463 | * @irq_flags: The state of the interrupts at the start of the event | |
464 | * @pc: The state of the preempt count at the start of the event. | |
465 | * | |
466 | * This is a helper function to handle triggers that require data | |
467 | * from the event itself. It also tests the event against filters and | |
468 | * if the event is soft disabled and should be discarded. | |
469 | */ | |
470 | static inline void | |
471 | event_trigger_unlock_commit(struct ftrace_event_file *file, | |
472 | struct ring_buffer *buffer, | |
473 | struct ring_buffer_event *event, | |
474 | void *entry, unsigned long irq_flags, int pc) | |
475 | { | |
476 | enum event_trigger_type tt = ETT_NONE; | |
477 | ||
478 | if (!__event_trigger_test_discard(file, buffer, event, entry, &tt)) | |
479 | trace_buffer_unlock_commit(buffer, event, irq_flags, pc); | |
480 | ||
481 | if (tt) | |
482 | event_triggers_post_call(file, tt); | |
483 | } | |
484 | ||
485 | /** | |
486 | * event_trigger_unlock_commit_regs - handle triggers and finish event commit | |
487 | * @file: The file pointer assoctiated to the event | |
488 | * @buffer: The ring buffer that the event is being written to | |
489 | * @event: The event meta data in the ring buffer | |
490 | * @entry: The event itself | |
491 | * @irq_flags: The state of the interrupts at the start of the event | |
492 | * @pc: The state of the preempt count at the start of the event. | |
493 | * | |
494 | * This is a helper function to handle triggers that require data | |
495 | * from the event itself. It also tests the event against filters and | |
496 | * if the event is soft disabled and should be discarded. | |
497 | * | |
498 | * Same as event_trigger_unlock_commit() but calls | |
499 | * trace_buffer_unlock_commit_regs() instead of trace_buffer_unlock_commit(). | |
500 | */ | |
501 | static inline void | |
502 | event_trigger_unlock_commit_regs(struct ftrace_event_file *file, | |
503 | struct ring_buffer *buffer, | |
504 | struct ring_buffer_event *event, | |
505 | void *entry, unsigned long irq_flags, int pc, | |
506 | struct pt_regs *regs) | |
507 | { | |
508 | enum event_trigger_type tt = ETT_NONE; | |
509 | ||
510 | if (!__event_trigger_test_discard(file, buffer, event, entry, &tt)) | |
511 | trace_buffer_unlock_commit_regs(buffer, event, | |
512 | irq_flags, pc, regs); | |
513 | ||
514 | if (tt) | |
515 | event_triggers_post_call(file, tt); | |
516 | } | |
517 | ||
43b51ead LZ |
518 | enum { |
519 | FILTER_OTHER = 0, | |
520 | FILTER_STATIC_STRING, | |
521 | FILTER_DYN_STRING, | |
87a342f5 | 522 | FILTER_PTR_STRING, |
02aa3162 | 523 | FILTER_TRACE_FN, |
43b51ead LZ |
524 | }; |
525 | ||
87d9b4e1 | 526 | extern int trace_event_raw_init(struct ftrace_event_call *call); |
aeaeae11 FW |
527 | extern int trace_define_field(struct ftrace_event_call *call, const char *type, |
528 | const char *name, int offset, int size, | |
529 | int is_signed, int filter_type); | |
bd1a5c84 | 530 | extern int trace_add_event_call(struct ftrace_event_call *call); |
2816c551 | 531 | extern int trace_remove_event_call(struct ftrace_event_call *call); |
97f20251 | 532 | |
d2802d07 | 533 | #define is_signed_type(type) (((type)(-1)) < (type)1) |
97f20251 | 534 | |
4671c794 SR |
535 | int trace_set_clr_event(const char *system, const char *event, int set); |
536 | ||
97f20251 SR |
537 | /* |
538 | * The double __builtin_constant_p is because gcc will give us an error | |
539 | * if we try to allocate the static variable to fmt if it is not a | |
540 | * constant. Even with the outer if statement optimizing out. | |
541 | */ | |
542 | #define event_trace_printk(ip, fmt, args...) \ | |
543 | do { \ | |
544 | __trace_printk_check_format(fmt, ##args); \ | |
545 | tracing_record_cmdline(current); \ | |
546 | if (__builtin_constant_p(fmt)) { \ | |
547 | static const char *trace_printk_fmt \ | |
548 | __attribute__((section("__trace_printk_fmt"))) = \ | |
549 | __builtin_constant_p(fmt) ? fmt : NULL; \ | |
550 | \ | |
551 | __trace_bprintk(ip, trace_printk_fmt, ##args); \ | |
552 | } else \ | |
553 | __trace_printk(ip, fmt, ##args); \ | |
554 | } while (0) | |
555 | ||
102c9323 SRRH |
556 | /** |
557 | * tracepoint_string - register constant persistent string to trace system | |
558 | * @str - a constant persistent string that will be referenced in tracepoints | |
559 | * | |
560 | * If constant strings are being used in tracepoints, it is faster and | |
561 | * more efficient to just save the pointer to the string and reference | |
562 | * that with a printf "%s" instead of saving the string in the ring buffer | |
563 | * and wasting space and time. | |
564 | * | |
565 | * The problem with the above approach is that userspace tools that read | |
566 | * the binary output of the trace buffers do not have access to the string. | |
567 | * Instead they just show the address of the string which is not very | |
568 | * useful to users. | |
569 | * | |
570 | * With tracepoint_string(), the string will be registered to the tracing | |
571 | * system and exported to userspace via the debugfs/tracing/printk_formats | |
572 | * file that maps the string address to the string text. This way userspace | |
573 | * tools that read the binary buffers have a way to map the pointers to | |
574 | * the ASCII strings they represent. | |
575 | * | |
576 | * The @str used must be a constant string and persistent as it would not | |
577 | * make sense to show a string that no longer exists. But it is still fine | |
578 | * to be used with modules, because when modules are unloaded, if they | |
579 | * had tracepoints, the ring buffers are cleared too. As long as the string | |
580 | * does not change during the life of the module, it is fine to use | |
581 | * tracepoint_string() within a module. | |
582 | */ | |
583 | #define tracepoint_string(str) \ | |
584 | ({ \ | |
585 | static const char *___tp_str __tracepoint_string = str; \ | |
586 | ___tp_str; \ | |
587 | }) | |
588 | #define __tracepoint_string __attribute__((section("__tracepoint_str"))) | |
589 | ||
07b139c8 | 590 | #ifdef CONFIG_PERF_EVENTS |
6fb2915d | 591 | struct perf_event; |
c530665c FW |
592 | |
593 | DECLARE_PER_CPU(struct pt_regs, perf_trace_regs); | |
594 | ||
1c024eca PZ |
595 | extern int perf_trace_init(struct perf_event *event); |
596 | extern void perf_trace_destroy(struct perf_event *event); | |
a4eaf7f1 PZ |
597 | extern int perf_trace_add(struct perf_event *event, int flags); |
598 | extern void perf_trace_del(struct perf_event *event, int flags); | |
1c024eca | 599 | extern int ftrace_profile_set_filter(struct perf_event *event, int event_id, |
6fb2915d LZ |
600 | char *filter_str); |
601 | extern void ftrace_profile_free_filter(struct perf_event *event); | |
b7e2ecef PZ |
602 | extern void *perf_trace_buf_prepare(int size, unsigned short type, |
603 | struct pt_regs *regs, int *rctxp); | |
430ad5a6 XG |
604 | |
605 | static inline void | |
97d5a220 | 606 | perf_trace_buf_submit(void *raw_data, int size, int rctx, u64 addr, |
e6dab5ff AV |
607 | u64 count, struct pt_regs *regs, void *head, |
608 | struct task_struct *task) | |
430ad5a6 | 609 | { |
e6dab5ff | 610 | perf_tp_event(addr, count, raw_data, size, regs, head, rctx, task); |
430ad5a6 | 611 | } |
6fb2915d LZ |
612 | #endif |
613 | ||
97f20251 | 614 | #endif /* _LINUX_FTRACE_EVENT_H */ |