]>
git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/blob - include/trace/ftrace.h
2 * Stage 1 of the trace events.
4 * Override the macros in <trace/trace_events.h> to include the following:
6 * struct ftrace_raw_<call> {
7 * struct trace_entry ent;
9 * <type2> <item2>[<len>];
13 * The <type> <item> is created by the __field(type, item) macro or
14 * the __array(type2, item2, len) macro.
15 * We simply do "type item;", and that will create the fields
19 #include <linux/ftrace_event.h>
22 * DECLARE_EVENT_CLASS can be used to add a generic function
23 * handlers for events. That is, if all events have the same
24 * parameters and just have distinct trace points.
25 * Each tracepoint can be defined with DEFINE_EVENT and that
26 * will map the DECLARE_EVENT_CLASS to the tracepoint.
28 * TRACE_EVENT is a one to one mapping between tracepoint and template.
31 #define TRACE_EVENT(name, proto, args, tstruct, assign, print) \
32 DECLARE_EVENT_CLASS(name, \
38 DEFINE_EVENT(name, name, PARAMS(proto), PARAMS(args));
42 #define __field(type, item) type item;
45 #define __field_ext(type, item, filter_type) type item;
48 #define __field_struct(type, item) type item;
50 #undef __field_struct_ext
51 #define __field_struct_ext(type, item, filter_type) type item;
54 #define __array(type, item, len) type item[len];
56 #undef __dynamic_array
57 #define __dynamic_array(type, item, len) u32 __data_loc_##item;
60 #define __string(item, src) __dynamic_array(char, item, -1)
63 #define __bitmask(item, nr_bits) __dynamic_array(char, item, -1)
65 #undef TP_STRUCT__entry
66 #define TP_STRUCT__entry(args...) args
68 #undef DECLARE_EVENT_CLASS
69 #define DECLARE_EVENT_CLASS(name, proto, args, tstruct, assign, print) \
70 struct ftrace_raw_##name { \
71 struct trace_entry ent; \
76 static struct ftrace_event_class event_class_##name;
79 #define DEFINE_EVENT(template, name, proto, args) \
80 static struct ftrace_event_call __used \
81 __attribute__((__aligned__(4))) event_##name
83 #undef DEFINE_EVENT_FN
84 #define DEFINE_EVENT_FN(template, name, proto, args, reg, unreg) \
85 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
87 #undef DEFINE_EVENT_PRINT
88 #define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
89 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
91 /* Callbacks are meaningless to ftrace. */
93 #define TRACE_EVENT_FN(name, proto, args, tstruct, \
94 assign, print, reg, unreg) \
95 TRACE_EVENT(name, PARAMS(proto), PARAMS(args), \
96 PARAMS(tstruct), PARAMS(assign), PARAMS(print)) \
98 #undef TRACE_EVENT_FLAGS
99 #define TRACE_EVENT_FLAGS(name, value) \
100 __TRACE_EVENT_FLAGS(name, value)
102 #undef TRACE_EVENT_PERF_PERM
103 #define TRACE_EVENT_PERF_PERM(name, expr...) \
104 __TRACE_EVENT_PERF_PERM(name, expr)
106 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
110 * Stage 2 of the trace events.
112 * Include the following:
114 * struct ftrace_data_offsets_<call> {
120 * The __dynamic_array() macro will create each u32 <item>, this is
121 * to keep the offset of each array from the beginning of the event.
122 * The size of an array is also encoded, in the higher 16 bits of <item>.
126 #define __field(type, item)
129 #define __field_ext(type, item, filter_type)
131 #undef __field_struct
132 #define __field_struct(type, item)
134 #undef __field_struct_ext
135 #define __field_struct_ext(type, item, filter_type)
138 #define __array(type, item, len)
140 #undef __dynamic_array
141 #define __dynamic_array(type, item, len) u32 item;
144 #define __string(item, src) __dynamic_array(char, item, -1)
147 #define __bitmask(item, nr_bits) __dynamic_array(unsigned long, item, -1)
149 #undef DECLARE_EVENT_CLASS
150 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
151 struct ftrace_data_offsets_##call { \
156 #define DEFINE_EVENT(template, name, proto, args)
158 #undef DEFINE_EVENT_PRINT
159 #define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
160 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
162 #undef TRACE_EVENT_FLAGS
163 #define TRACE_EVENT_FLAGS(event, flag)
165 #undef TRACE_EVENT_PERF_PERM
166 #define TRACE_EVENT_PERF_PERM(event, expr...)
168 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
171 * Stage 3 of the trace events.
173 * Override the macros in <trace/trace_events.h> to include the following:
176 * ftrace_raw_output_<call>(struct trace_iterator *iter, int flags)
178 * struct trace_seq *s = &iter->seq;
179 * struct ftrace_raw_<call> *field; <-- defined in stage 1
180 * struct trace_entry *entry;
181 * struct trace_seq *p = &iter->tmp_seq;
186 * if (entry->type != event_<call>->event.type) {
188 * return TRACE_TYPE_UNHANDLED;
191 * field = (typeof(field))entry;
194 * ret = trace_seq_printf(s, "%s: ", <call>);
196 * ret = trace_seq_printf(s, <TP_printk> "\n");
198 * return TRACE_TYPE_PARTIAL_LINE;
200 * return TRACE_TYPE_HANDLED;
203 * This is the method used to print the raw event to the trace
204 * output format. Note, this is not needed if the data is read
209 #define __entry field
212 #define TP_printk(fmt, args...) fmt "\n", args
214 #undef __get_dynamic_array
215 #define __get_dynamic_array(field) \
216 ((void *)__entry + (__entry->__data_loc_##field & 0xffff))
218 #undef __get_dynamic_array_len
219 #define __get_dynamic_array_len(field) \
220 ((__entry->__data_loc_##field >> 16) & 0xffff)
223 #define __get_str(field) (char *)__get_dynamic_array(field)
226 #define __get_bitmask(field) \
228 void *__bitmask = __get_dynamic_array(field); \
229 unsigned int __bitmask_size; \
230 __bitmask_size = __get_dynamic_array_len(field); \
231 ftrace_print_bitmask_seq(p, __bitmask, __bitmask_size); \
235 #define __print_flags(flag, delim, flag_array...) \
237 static const struct trace_print_flags __flags[] = \
238 { flag_array, { -1, NULL }}; \
239 ftrace_print_flags_seq(p, delim, flag, __flags); \
242 #undef __print_symbolic
243 #define __print_symbolic(value, symbol_array...) \
245 static const struct trace_print_flags symbols[] = \
246 { symbol_array, { -1, NULL }}; \
247 ftrace_print_symbols_seq(p, value, symbols); \
250 #undef __print_symbolic_u64
251 #if BITS_PER_LONG == 32
252 #define __print_symbolic_u64(value, symbol_array...) \
254 static const struct trace_print_flags_u64 symbols[] = \
255 { symbol_array, { -1, NULL } }; \
256 ftrace_print_symbols_seq_u64(p, value, symbols); \
259 #define __print_symbolic_u64(value, symbol_array...) \
260 __print_symbolic(value, symbol_array)
264 #define __print_hex(buf, buf_len) ftrace_print_hex_seq(p, buf, buf_len)
266 #undef DECLARE_EVENT_CLASS
267 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
268 static notrace enum print_line_t \
269 ftrace_raw_output_##call(struct trace_iterator *iter, int flags, \
270 struct trace_event *trace_event) \
272 struct trace_seq *s = &iter->seq; \
273 struct trace_seq __maybe_unused *p = &iter->tmp_seq; \
274 struct ftrace_raw_##call *field; \
277 field = (typeof(field))iter->ent; \
279 ret = ftrace_raw_output_prep(iter, trace_event); \
280 if (ret != TRACE_TYPE_HANDLED) \
283 trace_seq_printf(s, print); \
285 return trace_handle_return(s); \
287 static struct trace_event_functions ftrace_event_type_funcs_##call = { \
288 .trace = ftrace_raw_output_##call, \
291 #undef DEFINE_EVENT_PRINT
292 #define DEFINE_EVENT_PRINT(template, call, proto, args, print) \
293 static notrace enum print_line_t \
294 ftrace_raw_output_##call(struct trace_iterator *iter, int flags, \
295 struct trace_event *event) \
297 struct ftrace_raw_##template *field; \
298 struct trace_entry *entry; \
299 struct trace_seq *p = &iter->tmp_seq; \
303 if (entry->type != event_##call.event.type) { \
305 return TRACE_TYPE_UNHANDLED; \
308 field = (typeof(field))entry; \
311 return ftrace_output_call(iter, #call, print); \
313 static struct trace_event_functions ftrace_event_type_funcs_##call = { \
314 .trace = ftrace_raw_output_##call, \
317 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
320 #define __field_ext(type, item, filter_type) \
321 ret = trace_define_field(event_call, #type, #item, \
322 offsetof(typeof(field), item), \
323 sizeof(field.item), \
324 is_signed_type(type), filter_type); \
328 #undef __field_struct_ext
329 #define __field_struct_ext(type, item, filter_type) \
330 ret = trace_define_field(event_call, #type, #item, \
331 offsetof(typeof(field), item), \
332 sizeof(field.item), \
338 #define __field(type, item) __field_ext(type, item, FILTER_OTHER)
340 #undef __field_struct
341 #define __field_struct(type, item) __field_struct_ext(type, item, FILTER_OTHER)
344 #define __array(type, item, len) \
346 char *type_str = #type"["__stringify(len)"]"; \
347 BUILD_BUG_ON(len > MAX_FILTER_STR_VAL); \
348 ret = trace_define_field(event_call, type_str, #item, \
349 offsetof(typeof(field), item), \
350 sizeof(field.item), \
351 is_signed_type(type), FILTER_OTHER); \
356 #undef __dynamic_array
357 #define __dynamic_array(type, item, len) \
358 ret = trace_define_field(event_call, "__data_loc " #type "[]", #item, \
359 offsetof(typeof(field), __data_loc_##item), \
360 sizeof(field.__data_loc_##item), \
361 is_signed_type(type), FILTER_OTHER);
364 #define __string(item, src) __dynamic_array(char, item, -1)
367 #define __bitmask(item, nr_bits) __dynamic_array(unsigned long, item, -1)
369 #undef DECLARE_EVENT_CLASS
370 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, func, print) \
371 static int notrace __init \
372 ftrace_define_fields_##call(struct ftrace_event_call *event_call) \
374 struct ftrace_raw_##call field; \
383 #define DEFINE_EVENT(template, name, proto, args)
385 #undef DEFINE_EVENT_PRINT
386 #define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
387 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
389 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
392 * remember the offset of each array from the beginning of the event.
396 #define __entry entry
399 #define __field(type, item)
402 #define __field_ext(type, item, filter_type)
404 #undef __field_struct
405 #define __field_struct(type, item)
407 #undef __field_struct_ext
408 #define __field_struct_ext(type, item, filter_type)
411 #define __array(type, item, len)
413 #undef __dynamic_array
414 #define __dynamic_array(type, item, len) \
415 __item_length = (len) * sizeof(type); \
416 __data_offsets->item = __data_size + \
417 offsetof(typeof(*entry), __data); \
418 __data_offsets->item |= __item_length << 16; \
419 __data_size += __item_length;
422 #define __string(item, src) __dynamic_array(char, item, \
423 strlen((src) ? (const char *)(src) : "(null)") + 1)
426 * __bitmask_size_in_bytes_raw is the number of bytes needed to hold
427 * num_possible_cpus().
429 #define __bitmask_size_in_bytes_raw(nr_bits) \
430 (((nr_bits) + 7) / 8)
432 #define __bitmask_size_in_longs(nr_bits) \
433 ((__bitmask_size_in_bytes_raw(nr_bits) + \
434 ((BITS_PER_LONG / 8) - 1)) / (BITS_PER_LONG / 8))
437 * __bitmask_size_in_bytes is the number of bytes needed to hold
438 * num_possible_cpus() padded out to the nearest long. This is what
439 * is saved in the buffer, just to be consistent.
441 #define __bitmask_size_in_bytes(nr_bits) \
442 (__bitmask_size_in_longs(nr_bits) * (BITS_PER_LONG / 8))
445 #define __bitmask(item, nr_bits) __dynamic_array(unsigned long, item, \
446 __bitmask_size_in_longs(nr_bits))
448 #undef DECLARE_EVENT_CLASS
449 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
450 static inline notrace int ftrace_get_offsets_##call( \
451 struct ftrace_data_offsets_##call *__data_offsets, proto) \
453 int __data_size = 0; \
454 int __maybe_unused __item_length; \
455 struct ftrace_raw_##call __maybe_unused *entry; \
459 return __data_size; \
463 #define DEFINE_EVENT(template, name, proto, args)
465 #undef DEFINE_EVENT_PRINT
466 #define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
467 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
469 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
472 * Stage 4 of the trace events.
474 * Override the macros in <trace/trace_events.h> to include the following:
476 * For those macros defined with TRACE_EVENT:
478 * static struct ftrace_event_call event_<call>;
480 * static void ftrace_raw_event_<call>(void *__data, proto)
482 * struct ftrace_event_file *ftrace_file = __data;
483 * struct ftrace_event_call *event_call = ftrace_file->event_call;
484 * struct ftrace_data_offsets_<call> __maybe_unused __data_offsets;
485 * unsigned long eflags = ftrace_file->flags;
486 * enum event_trigger_type __tt = ETT_NONE;
487 * struct ring_buffer_event *event;
488 * struct ftrace_raw_<call> *entry; <-- defined in stage 1
489 * struct ring_buffer *buffer;
490 * unsigned long irq_flags;
494 * if (!(eflags & FTRACE_EVENT_FL_TRIGGER_COND)) {
495 * if (eflags & FTRACE_EVENT_FL_TRIGGER_MODE)
496 * event_triggers_call(ftrace_file, NULL);
497 * if (eflags & FTRACE_EVENT_FL_SOFT_DISABLED)
501 * local_save_flags(irq_flags);
502 * pc = preempt_count();
504 * __data_size = ftrace_get_offsets_<call>(&__data_offsets, args);
506 * event = trace_event_buffer_lock_reserve(&buffer, ftrace_file,
507 * event_<call>->event.type,
508 * sizeof(*entry) + __data_size,
512 * entry = ring_buffer_event_data(event);
514 * { <assign>; } <-- Here we assign the entries by the __field and
517 * if (eflags & FTRACE_EVENT_FL_TRIGGER_COND)
518 * __tt = event_triggers_call(ftrace_file, entry);
520 * if (test_bit(FTRACE_EVENT_FL_SOFT_DISABLED_BIT,
521 * &ftrace_file->flags))
522 * ring_buffer_discard_commit(buffer, event);
523 * else if (!filter_check_discard(ftrace_file, entry, buffer, event))
524 * trace_buffer_unlock_commit(buffer, event, irq_flags, pc);
527 * event_triggers_post_call(ftrace_file, __tt);
530 * static struct trace_event ftrace_event_type_<call> = {
531 * .trace = ftrace_raw_output_<call>, <-- stage 2
534 * static const char print_fmt_<call>[] = <TP_printk>;
536 * static struct ftrace_event_class __used event_class_<template> = {
537 * .system = "<system>",
538 * .define_fields = ftrace_define_fields_<call>,
539 * .fields = LIST_HEAD_INIT(event_class_##call.fields),
540 * .raw_init = trace_event_raw_init,
541 * .probe = ftrace_raw_event_##call,
542 * .reg = ftrace_event_reg,
545 * static struct ftrace_event_call event_<call> = {
546 * .class = event_class_<template>,
548 * .tp = &__tracepoint_<call>,
550 * .event = &ftrace_event_type_<call>,
551 * .print_fmt = print_fmt_<call>,
552 * .flags = TRACE_EVENT_FL_TRACEPOINT,
554 * // its only safe to use pointers when doing linker tricks to
555 * // create an array.
556 * static struct ftrace_event_call __used
557 * __attribute__((section("_ftrace_events"))) *__event_<call> = &event_<call>;
561 #ifdef CONFIG_PERF_EVENTS
563 #define _TRACE_PERF_PROTO(call, proto) \
564 static notrace void \
565 perf_trace_##call(void *__data, proto);
567 #define _TRACE_PERF_INIT(call) \
568 .perf_probe = perf_trace_##call,
571 #define _TRACE_PERF_PROTO(call, proto)
572 #define _TRACE_PERF_INIT(call)
573 #endif /* CONFIG_PERF_EVENTS */
576 #define __entry entry
579 #define __field(type, item)
581 #undef __field_struct
582 #define __field_struct(type, item)
585 #define __array(type, item, len)
587 #undef __dynamic_array
588 #define __dynamic_array(type, item, len) \
589 __entry->__data_loc_##item = __data_offsets.item;
592 #define __string(item, src) __dynamic_array(char, item, -1)
595 #define __assign_str(dst, src) \
596 strcpy(__get_str(dst), (src) ? (const char *)(src) : "(null)");
599 #define __bitmask(item, nr_bits) __dynamic_array(unsigned long, item, -1)
602 #define __get_bitmask(field) (char *)__get_dynamic_array(field)
604 #undef __assign_bitmask
605 #define __assign_bitmask(dst, src, nr_bits) \
606 memcpy(__get_bitmask(dst), (src), __bitmask_size_in_bytes(nr_bits))
608 #undef TP_fast_assign
609 #define TP_fast_assign(args...) args
612 #define __perf_addr(a) (a)
615 #define __perf_count(c) (c)
618 #define __perf_task(t) (t)
620 #undef DECLARE_EVENT_CLASS
621 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
623 static notrace void \
624 ftrace_raw_event_##call(void *__data, proto) \
626 struct ftrace_event_file *ftrace_file = __data; \
627 struct ftrace_data_offsets_##call __maybe_unused __data_offsets;\
628 struct ftrace_event_buffer fbuffer; \
629 struct ftrace_raw_##call *entry; \
632 if (ftrace_trigger_soft_disabled(ftrace_file)) \
635 __data_size = ftrace_get_offsets_##call(&__data_offsets, args); \
637 entry = ftrace_event_buffer_reserve(&fbuffer, ftrace_file, \
638 sizeof(*entry) + __data_size); \
647 ftrace_event_buffer_commit(&fbuffer); \
650 * The ftrace_test_probe is compiled out, it is only here as a build time check
651 * to make sure that if the tracepoint handling changes, the ftrace probe will
652 * fail to compile unless it too is updated.
656 #define DEFINE_EVENT(template, call, proto, args) \
657 static inline void ftrace_test_probe_##call(void) \
659 check_trace_callback_type_##call(ftrace_raw_event_##template); \
662 #undef DEFINE_EVENT_PRINT
663 #define DEFINE_EVENT_PRINT(template, name, proto, args, print)
665 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
671 #undef __print_symbolic
673 #undef __get_dynamic_array
674 #undef __get_dynamic_array_len
679 #define TP_printk(fmt, args...) "\"" fmt "\", " __stringify(args)
681 #undef DECLARE_EVENT_CLASS
682 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
683 _TRACE_PERF_PROTO(call, PARAMS(proto)); \
684 static const char print_fmt_##call[] = print; \
685 static struct ftrace_event_class __used __refdata event_class_##call = { \
686 .system = __stringify(TRACE_SYSTEM), \
687 .define_fields = ftrace_define_fields_##call, \
688 .fields = LIST_HEAD_INIT(event_class_##call.fields),\
689 .raw_init = trace_event_raw_init, \
690 .probe = ftrace_raw_event_##call, \
691 .reg = ftrace_event_reg, \
692 _TRACE_PERF_INIT(call) \
696 #define DEFINE_EVENT(template, call, proto, args) \
698 static struct ftrace_event_call __used event_##call = { \
699 .class = &event_class_##template, \
701 .tp = &__tracepoint_##call, \
703 .event.funcs = &ftrace_event_type_funcs_##template, \
704 .print_fmt = print_fmt_##template, \
705 .flags = TRACE_EVENT_FL_TRACEPOINT, \
707 static struct ftrace_event_call __used \
708 __attribute__((section("_ftrace_events"))) *__event_##call = &event_##call
710 #undef DEFINE_EVENT_PRINT
711 #define DEFINE_EVENT_PRINT(template, call, proto, args, print) \
713 static const char print_fmt_##call[] = print; \
715 static struct ftrace_event_call __used event_##call = { \
716 .class = &event_class_##template, \
718 .tp = &__tracepoint_##call, \
720 .event.funcs = &ftrace_event_type_funcs_##call, \
721 .print_fmt = print_fmt_##call, \
722 .flags = TRACE_EVENT_FL_TRACEPOINT, \
724 static struct ftrace_event_call __used \
725 __attribute__((section("_ftrace_events"))) *__event_##call = &event_##call
727 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
730 #ifdef CONFIG_PERF_EVENTS
733 #define __entry entry
735 #undef __get_dynamic_array
736 #define __get_dynamic_array(field) \
737 ((void *)__entry + (__entry->__data_loc_##field & 0xffff))
739 #undef __get_dynamic_array_len
740 #define __get_dynamic_array_len(field) \
741 ((__entry->__data_loc_##field >> 16) & 0xffff)
744 #define __get_str(field) (char *)__get_dynamic_array(field)
747 #define __get_bitmask(field) (char *)__get_dynamic_array(field)
750 #define __perf_addr(a) (__addr = (a))
753 #define __perf_count(c) (__count = (c))
756 #define __perf_task(t) (__task = (t))
758 #undef DECLARE_EVENT_CLASS
759 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
760 static notrace void \
761 perf_trace_##call(void *__data, proto) \
763 struct ftrace_event_call *event_call = __data; \
764 struct ftrace_data_offsets_##call __maybe_unused __data_offsets;\
765 struct ftrace_raw_##call *entry; \
766 struct pt_regs __regs; \
767 u64 __addr = 0, __count = 1; \
768 struct task_struct *__task = NULL; \
769 struct hlist_head *head; \
774 __data_size = ftrace_get_offsets_##call(&__data_offsets, args); \
776 head = this_cpu_ptr(event_call->perf_events); \
777 if (__builtin_constant_p(!__task) && !__task && \
781 __entry_size = ALIGN(__data_size + sizeof(*entry) + sizeof(u32),\
783 __entry_size -= sizeof(u32); \
785 perf_fetch_caller_regs(&__regs); \
786 entry = perf_trace_buf_prepare(__entry_size, \
787 event_call->event.type, &__regs, &rctx); \
795 perf_trace_buf_submit(entry, __entry_size, rctx, __addr, \
796 __count, &__regs, head, __task); \
800 * This part is compiled out, it is only here as a build time check
801 * to make sure that if the tracepoint handling changes, the
802 * perf probe will fail to compile unless it too is updated.
805 #define DEFINE_EVENT(template, call, proto, args) \
806 static inline void perf_test_probe_##call(void) \
808 check_trace_callback_type_##call(perf_trace_##template); \
812 #undef DEFINE_EVENT_PRINT
813 #define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
814 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
816 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
817 #endif /* CONFIG_PERF_EVENTS */