2 * Stage 1 of the trace events.
4 * Override the macros in <trace/trace_events.h> to include the following:
6 * struct trace_event_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/trace_events.h>
21 #ifndef TRACE_SYSTEM_VAR
22 #define TRACE_SYSTEM_VAR TRACE_SYSTEM
25 #define __app__(x, y) str__##x##y
26 #define __app(x, y) __app__(x, y)
28 #define TRACE_SYSTEM_STRING __app(TRACE_SYSTEM_VAR,__trace_system_name)
30 #define TRACE_MAKE_SYSTEM_STR() \
31 static const char TRACE_SYSTEM_STRING[] = \
32 __stringify(TRACE_SYSTEM)
34 TRACE_MAKE_SYSTEM_STR();
36 #undef TRACE_DEFINE_ENUM
37 #define TRACE_DEFINE_ENUM(a) \
38 static struct trace_enum_map __used __initdata \
39 __##TRACE_SYSTEM##_##a = \
41 .system = TRACE_SYSTEM_STRING, \
45 static struct trace_enum_map __used \
46 __attribute__((section("_ftrace_enum_map"))) \
47 *TRACE_SYSTEM##_##a = &__##TRACE_SYSTEM##_##a
50 * DECLARE_EVENT_CLASS can be used to add a generic function
51 * handlers for events. That is, if all events have the same
52 * parameters and just have distinct trace points.
53 * Each tracepoint can be defined with DEFINE_EVENT and that
54 * will map the DECLARE_EVENT_CLASS to the tracepoint.
56 * TRACE_EVENT is a one to one mapping between tracepoint and template.
59 #define TRACE_EVENT(name, proto, args, tstruct, assign, print) \
60 DECLARE_EVENT_CLASS(name, \
66 DEFINE_EVENT(name, name, PARAMS(proto), PARAMS(args));
70 #define __field(type, item) type item;
73 #define __field_ext(type, item, filter_type) type item;
76 #define __field_struct(type, item) type item;
78 #undef __field_struct_ext
79 #define __field_struct_ext(type, item, filter_type) type item;
82 #define __array(type, item, len) type item[len];
84 #undef __dynamic_array
85 #define __dynamic_array(type, item, len) u32 __data_loc_##item;
88 #define __string(item, src) __dynamic_array(char, item, -1)
91 #define __bitmask(item, nr_bits) __dynamic_array(char, item, -1)
93 #undef TP_STRUCT__entry
94 #define TP_STRUCT__entry(args...) args
96 #undef DECLARE_EVENT_CLASS
97 #define DECLARE_EVENT_CLASS(name, proto, args, tstruct, assign, print) \
98 struct trace_event_raw_##name { \
99 struct trace_entry ent; \
104 static struct trace_event_class event_class_##name;
107 #define DEFINE_EVENT(template, name, proto, args) \
108 static struct trace_event_call __used \
109 __attribute__((__aligned__(4))) event_##name
111 #undef DEFINE_EVENT_FN
112 #define DEFINE_EVENT_FN(template, name, proto, args, reg, unreg) \
113 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
115 #undef DEFINE_EVENT_PRINT
116 #define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
117 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
119 /* Callbacks are meaningless to ftrace. */
120 #undef TRACE_EVENT_FN
121 #define TRACE_EVENT_FN(name, proto, args, tstruct, \
122 assign, print, reg, unreg) \
123 TRACE_EVENT(name, PARAMS(proto), PARAMS(args), \
124 PARAMS(tstruct), PARAMS(assign), PARAMS(print)) \
126 #undef TRACE_EVENT_FN_COND
127 #define TRACE_EVENT_FN_COND(name, proto, args, cond, tstruct, \
128 assign, print, reg, unreg) \
129 TRACE_EVENT_CONDITION(name, PARAMS(proto), PARAMS(args), PARAMS(cond), \
130 PARAMS(tstruct), PARAMS(assign), PARAMS(print)) \
132 #undef TRACE_EVENT_FLAGS
133 #define TRACE_EVENT_FLAGS(name, value) \
134 __TRACE_EVENT_FLAGS(name, value)
136 #undef TRACE_EVENT_PERF_PERM
137 #define TRACE_EVENT_PERF_PERM(name, expr...) \
138 __TRACE_EVENT_PERF_PERM(name, expr)
140 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
143 * Stage 2 of the trace events.
145 * Include the following:
147 * struct trace_event_data_offsets_<call> {
153 * The __dynamic_array() macro will create each u32 <item>, this is
154 * to keep the offset of each array from the beginning of the event.
155 * The size of an array is also encoded, in the higher 16 bits of <item>.
158 #undef TRACE_DEFINE_ENUM
159 #define TRACE_DEFINE_ENUM(a)
162 #define __field(type, item)
165 #define __field_ext(type, item, filter_type)
167 #undef __field_struct
168 #define __field_struct(type, item)
170 #undef __field_struct_ext
171 #define __field_struct_ext(type, item, filter_type)
174 #define __array(type, item, len)
176 #undef __dynamic_array
177 #define __dynamic_array(type, item, len) u32 item;
180 #define __string(item, src) __dynamic_array(char, item, -1)
183 #define __bitmask(item, nr_bits) __dynamic_array(unsigned long, item, -1)
185 #undef DECLARE_EVENT_CLASS
186 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
187 struct trace_event_data_offsets_##call { \
192 #define DEFINE_EVENT(template, name, proto, args)
194 #undef DEFINE_EVENT_PRINT
195 #define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
196 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
198 #undef TRACE_EVENT_FLAGS
199 #define TRACE_EVENT_FLAGS(event, flag)
201 #undef TRACE_EVENT_PERF_PERM
202 #define TRACE_EVENT_PERF_PERM(event, expr...)
204 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
207 * Stage 3 of the trace events.
209 * Override the macros in <trace/trace_events.h> to include the following:
212 * trace_raw_output_<call>(struct trace_iterator *iter, int flags)
214 * struct trace_seq *s = &iter->seq;
215 * struct trace_event_raw_<call> *field; <-- defined in stage 1
216 * struct trace_entry *entry;
217 * struct trace_seq *p = &iter->tmp_seq;
222 * if (entry->type != event_<call>->event.type) {
224 * return TRACE_TYPE_UNHANDLED;
227 * field = (typeof(field))entry;
230 * ret = trace_seq_printf(s, "%s: ", <call>);
232 * ret = trace_seq_printf(s, <TP_printk> "\n");
234 * return TRACE_TYPE_PARTIAL_LINE;
236 * return TRACE_TYPE_HANDLED;
239 * This is the method used to print the raw event to the trace
240 * output format. Note, this is not needed if the data is read
245 #define __entry field
248 #define TP_printk(fmt, args...) fmt "\n", args
250 #undef __get_dynamic_array
251 #define __get_dynamic_array(field) \
252 ((void *)__entry + (__entry->__data_loc_##field & 0xffff))
254 #undef __get_dynamic_array_len
255 #define __get_dynamic_array_len(field) \
256 ((__entry->__data_loc_##field >> 16) & 0xffff)
259 #define __get_str(field) (char *)__get_dynamic_array(field)
262 #define __get_bitmask(field) \
264 void *__bitmask = __get_dynamic_array(field); \
265 unsigned int __bitmask_size; \
266 __bitmask_size = __get_dynamic_array_len(field); \
267 trace_print_bitmask_seq(p, __bitmask, __bitmask_size); \
271 #define __print_flags(flag, delim, flag_array...) \
273 static const struct trace_print_flags __flags[] = \
274 { flag_array, { -1, NULL }}; \
275 trace_print_flags_seq(p, delim, flag, __flags); \
278 #undef __print_symbolic
279 #define __print_symbolic(value, symbol_array...) \
281 static const struct trace_print_flags symbols[] = \
282 { symbol_array, { -1, NULL }}; \
283 trace_print_symbols_seq(p, value, symbols); \
286 #undef __print_symbolic_u64
287 #if BITS_PER_LONG == 32
288 #define __print_symbolic_u64(value, symbol_array...) \
290 static const struct trace_print_flags_u64 symbols[] = \
291 { symbol_array, { -1, NULL } }; \
292 trace_print_symbols_seq_u64(p, value, symbols); \
295 #define __print_symbolic_u64(value, symbol_array...) \
296 __print_symbolic(value, symbol_array)
300 #define __print_hex(buf, buf_len) trace_print_hex_seq(p, buf, buf_len)
303 #define __print_array(array, count, el_size) \
305 BUILD_BUG_ON(el_size != 1 && el_size != 2 && \
306 el_size != 4 && el_size != 8); \
307 trace_print_array_seq(p, array, count, el_size); \
310 #undef DECLARE_EVENT_CLASS
311 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
312 static notrace enum print_line_t \
313 trace_raw_output_##call(struct trace_iterator *iter, int flags, \
314 struct trace_event *trace_event) \
316 struct trace_seq *s = &iter->seq; \
317 struct trace_seq __maybe_unused *p = &iter->tmp_seq; \
318 struct trace_event_raw_##call *field; \
321 field = (typeof(field))iter->ent; \
323 ret = trace_raw_output_prep(iter, trace_event); \
324 if (ret != TRACE_TYPE_HANDLED) \
327 trace_seq_printf(s, print); \
329 return trace_handle_return(s); \
331 static struct trace_event_functions trace_event_type_funcs_##call = { \
332 .trace = trace_raw_output_##call, \
335 #undef DEFINE_EVENT_PRINT
336 #define DEFINE_EVENT_PRINT(template, call, proto, args, print) \
337 static notrace enum print_line_t \
338 trace_raw_output_##call(struct trace_iterator *iter, int flags, \
339 struct trace_event *event) \
341 struct trace_event_raw_##template *field; \
342 struct trace_entry *entry; \
343 struct trace_seq *p = &iter->tmp_seq; \
347 if (entry->type != event_##call.event.type) { \
349 return TRACE_TYPE_UNHANDLED; \
352 field = (typeof(field))entry; \
355 return trace_output_call(iter, #call, print); \
357 static struct trace_event_functions trace_event_type_funcs_##call = { \
358 .trace = trace_raw_output_##call, \
361 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
364 #define __field_ext(type, item, filter_type) \
365 ret = trace_define_field(event_call, #type, #item, \
366 offsetof(typeof(field), item), \
367 sizeof(field.item), \
368 is_signed_type(type), filter_type); \
372 #undef __field_struct_ext
373 #define __field_struct_ext(type, item, filter_type) \
374 ret = trace_define_field(event_call, #type, #item, \
375 offsetof(typeof(field), item), \
376 sizeof(field.item), \
382 #define __field(type, item) __field_ext(type, item, FILTER_OTHER)
384 #undef __field_struct
385 #define __field_struct(type, item) __field_struct_ext(type, item, FILTER_OTHER)
388 #define __array(type, item, len) \
390 char *type_str = #type"["__stringify(len)"]"; \
391 BUILD_BUG_ON(len > MAX_FILTER_STR_VAL); \
392 ret = trace_define_field(event_call, type_str, #item, \
393 offsetof(typeof(field), item), \
394 sizeof(field.item), \
395 is_signed_type(type), FILTER_OTHER); \
400 #undef __dynamic_array
401 #define __dynamic_array(type, item, len) \
402 ret = trace_define_field(event_call, "__data_loc " #type "[]", #item, \
403 offsetof(typeof(field), __data_loc_##item), \
404 sizeof(field.__data_loc_##item), \
405 is_signed_type(type), FILTER_OTHER);
408 #define __string(item, src) __dynamic_array(char, item, -1)
411 #define __bitmask(item, nr_bits) __dynamic_array(unsigned long, item, -1)
413 #undef DECLARE_EVENT_CLASS
414 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, func, print) \
415 static int notrace __init \
416 trace_event_define_fields_##call(struct trace_event_call *event_call) \
418 struct trace_event_raw_##call field; \
427 #define DEFINE_EVENT(template, name, proto, args)
429 #undef DEFINE_EVENT_PRINT
430 #define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
431 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
433 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
436 * remember the offset of each array from the beginning of the event.
440 #define __entry entry
443 #define __field(type, item)
446 #define __field_ext(type, item, filter_type)
448 #undef __field_struct
449 #define __field_struct(type, item)
451 #undef __field_struct_ext
452 #define __field_struct_ext(type, item, filter_type)
455 #define __array(type, item, len)
457 #undef __dynamic_array
458 #define __dynamic_array(type, item, len) \
459 __item_length = (len) * sizeof(type); \
460 __data_offsets->item = __data_size + \
461 offsetof(typeof(*entry), __data); \
462 __data_offsets->item |= __item_length << 16; \
463 __data_size += __item_length;
466 #define __string(item, src) __dynamic_array(char, item, \
467 strlen((src) ? (const char *)(src) : "(null)") + 1)
470 * __bitmask_size_in_bytes_raw is the number of bytes needed to hold
471 * num_possible_cpus().
473 #define __bitmask_size_in_bytes_raw(nr_bits) \
474 (((nr_bits) + 7) / 8)
476 #define __bitmask_size_in_longs(nr_bits) \
477 ((__bitmask_size_in_bytes_raw(nr_bits) + \
478 ((BITS_PER_LONG / 8) - 1)) / (BITS_PER_LONG / 8))
481 * __bitmask_size_in_bytes is the number of bytes needed to hold
482 * num_possible_cpus() padded out to the nearest long. This is what
483 * is saved in the buffer, just to be consistent.
485 #define __bitmask_size_in_bytes(nr_bits) \
486 (__bitmask_size_in_longs(nr_bits) * (BITS_PER_LONG / 8))
489 #define __bitmask(item, nr_bits) __dynamic_array(unsigned long, item, \
490 __bitmask_size_in_longs(nr_bits))
492 #undef DECLARE_EVENT_CLASS
493 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
494 static inline notrace int trace_event_get_offsets_##call( \
495 struct trace_event_data_offsets_##call *__data_offsets, proto) \
497 int __data_size = 0; \
498 int __maybe_unused __item_length; \
499 struct trace_event_raw_##call __maybe_unused *entry; \
503 return __data_size; \
507 #define DEFINE_EVENT(template, name, proto, args)
509 #undef DEFINE_EVENT_PRINT
510 #define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
511 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
513 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
516 * Stage 4 of the trace events.
518 * Override the macros in <trace/trace_events.h> to include the following:
520 * For those macros defined with TRACE_EVENT:
522 * static struct trace_event_call event_<call>;
524 * static void trace_event_raw_event_<call>(void *__data, proto)
526 * struct trace_event_file *trace_file = __data;
527 * struct trace_event_call *event_call = trace_file->event_call;
528 * struct trace_event_data_offsets_<call> __maybe_unused __data_offsets;
529 * unsigned long eflags = trace_file->flags;
530 * enum event_trigger_type __tt = ETT_NONE;
531 * struct ring_buffer_event *event;
532 * struct trace_event_raw_<call> *entry; <-- defined in stage 1
533 * struct ring_buffer *buffer;
534 * unsigned long irq_flags;
538 * if (!(eflags & EVENT_FILE_FL_TRIGGER_COND)) {
539 * if (eflags & EVENT_FILE_FL_TRIGGER_MODE)
540 * event_triggers_call(trace_file, NULL);
541 * if (eflags & EVENT_FILE_FL_SOFT_DISABLED)
545 * local_save_flags(irq_flags);
546 * pc = preempt_count();
548 * __data_size = trace_event_get_offsets_<call>(&__data_offsets, args);
550 * event = trace_event_buffer_lock_reserve(&buffer, trace_file,
551 * event_<call>->event.type,
552 * sizeof(*entry) + __data_size,
556 * entry = ring_buffer_event_data(event);
558 * { <assign>; } <-- Here we assign the entries by the __field and
561 * if (eflags & EVENT_FILE_FL_TRIGGER_COND)
562 * __tt = event_triggers_call(trace_file, entry);
564 * if (test_bit(EVENT_FILE_FL_SOFT_DISABLED_BIT,
565 * &trace_file->flags))
566 * ring_buffer_discard_commit(buffer, event);
567 * else if (!filter_check_discard(trace_file, entry, buffer, event))
568 * trace_buffer_unlock_commit(buffer, event, irq_flags, pc);
571 * event_triggers_post_call(trace_file, __tt);
574 * static struct trace_event ftrace_event_type_<call> = {
575 * .trace = trace_raw_output_<call>, <-- stage 2
578 * static char print_fmt_<call>[] = <TP_printk>;
580 * static struct trace_event_class __used event_class_<template> = {
581 * .system = "<system>",
582 * .define_fields = trace_event_define_fields_<call>,
583 * .fields = LIST_HEAD_INIT(event_class_##call.fields),
584 * .raw_init = trace_event_raw_init,
585 * .probe = trace_event_raw_event_##call,
586 * .reg = trace_event_reg,
589 * static struct trace_event_call event_<call> = {
590 * .class = event_class_<template>,
592 * .tp = &__tracepoint_<call>,
594 * .event = &ftrace_event_type_<call>,
595 * .print_fmt = print_fmt_<call>,
596 * .flags = TRACE_EVENT_FL_TRACEPOINT,
598 * // its only safe to use pointers when doing linker tricks to
599 * // create an array.
600 * static struct trace_event_call __used
601 * __attribute__((section("_ftrace_events"))) *__event_<call> = &event_<call>;
605 #ifdef CONFIG_PERF_EVENTS
607 #define _TRACE_PERF_PROTO(call, proto) \
608 static notrace void \
609 perf_trace_##call(void *__data, proto);
611 #define _TRACE_PERF_INIT(call) \
612 .perf_probe = perf_trace_##call,
615 #define _TRACE_PERF_PROTO(call, proto)
616 #define _TRACE_PERF_INIT(call)
617 #endif /* CONFIG_PERF_EVENTS */
620 #define __entry entry
623 #define __field(type, item)
625 #undef __field_struct
626 #define __field_struct(type, item)
629 #define __array(type, item, len)
631 #undef __dynamic_array
632 #define __dynamic_array(type, item, len) \
633 __entry->__data_loc_##item = __data_offsets.item;
636 #define __string(item, src) __dynamic_array(char, item, -1)
639 #define __assign_str(dst, src) \
640 strcpy(__get_str(dst), (src) ? (const char *)(src) : "(null)");
643 #define __bitmask(item, nr_bits) __dynamic_array(unsigned long, item, -1)
646 #define __get_bitmask(field) (char *)__get_dynamic_array(field)
648 #undef __assign_bitmask
649 #define __assign_bitmask(dst, src, nr_bits) \
650 memcpy(__get_bitmask(dst), (src), __bitmask_size_in_bytes(nr_bits))
652 #undef TP_fast_assign
653 #define TP_fast_assign(args...) args
656 #define __perf_addr(a) (a)
659 #define __perf_count(c) (c)
662 #define __perf_task(t) (t)
664 #undef DECLARE_EVENT_CLASS
665 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
667 static notrace void \
668 trace_event_raw_event_##call(void *__data, proto) \
670 struct trace_event_file *trace_file = __data; \
671 struct trace_event_data_offsets_##call __maybe_unused __data_offsets;\
672 struct trace_event_buffer fbuffer; \
673 struct trace_event_raw_##call *entry; \
676 if (trace_trigger_soft_disabled(trace_file)) \
679 __data_size = trace_event_get_offsets_##call(&__data_offsets, args); \
681 entry = trace_event_buffer_reserve(&fbuffer, trace_file, \
682 sizeof(*entry) + __data_size); \
691 trace_event_buffer_commit(&fbuffer); \
694 * The ftrace_test_probe is compiled out, it is only here as a build time check
695 * to make sure that if the tracepoint handling changes, the ftrace probe will
696 * fail to compile unless it too is updated.
700 #define DEFINE_EVENT(template, call, proto, args) \
701 static inline void ftrace_test_probe_##call(void) \
703 check_trace_callback_type_##call(trace_event_raw_event_##template); \
706 #undef DEFINE_EVENT_PRINT
707 #define DEFINE_EVENT_PRINT(template, name, proto, args, print)
709 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
715 #undef __print_symbolic
717 #undef __get_dynamic_array
718 #undef __get_dynamic_array_len
724 #define TP_printk(fmt, args...) "\"" fmt "\", " __stringify(args)
726 #undef DECLARE_EVENT_CLASS
727 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
728 _TRACE_PERF_PROTO(call, PARAMS(proto)); \
729 static char print_fmt_##call[] = print; \
730 static struct trace_event_class __used __refdata event_class_##call = { \
731 .system = TRACE_SYSTEM_STRING, \
732 .define_fields = trace_event_define_fields_##call, \
733 .fields = LIST_HEAD_INIT(event_class_##call.fields),\
734 .raw_init = trace_event_raw_init, \
735 .probe = trace_event_raw_event_##call, \
736 .reg = trace_event_reg, \
737 _TRACE_PERF_INIT(call) \
741 #define DEFINE_EVENT(template, call, proto, args) \
743 static struct trace_event_call __used event_##call = { \
744 .class = &event_class_##template, \
746 .tp = &__tracepoint_##call, \
748 .event.funcs = &trace_event_type_funcs_##template, \
749 .print_fmt = print_fmt_##template, \
750 .flags = TRACE_EVENT_FL_TRACEPOINT, \
752 static struct trace_event_call __used \
753 __attribute__((section("_ftrace_events"))) *__event_##call = &event_##call
755 #undef DEFINE_EVENT_PRINT
756 #define DEFINE_EVENT_PRINT(template, call, proto, args, print) \
758 static char print_fmt_##call[] = print; \
760 static struct trace_event_call __used event_##call = { \
761 .class = &event_class_##template, \
763 .tp = &__tracepoint_##call, \
765 .event.funcs = &trace_event_type_funcs_##call, \
766 .print_fmt = print_fmt_##call, \
767 .flags = TRACE_EVENT_FL_TRACEPOINT, \
769 static struct trace_event_call __used \
770 __attribute__((section("_ftrace_events"))) *__event_##call = &event_##call
772 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)