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 __array(type, item, len) type item[len];
50 #undef __dynamic_array
51 #define __dynamic_array(type, item, len) u32 __data_loc_##item;
54 #define __string(item, src) __dynamic_array(char, item, -1)
56 #undef TP_STRUCT__entry
57 #define TP_STRUCT__entry(args...) args
59 #undef DECLARE_EVENT_CLASS
60 #define DECLARE_EVENT_CLASS(name, proto, args, tstruct, assign, print) \
61 struct ftrace_raw_##name { \
62 struct trace_entry ent; \
67 static struct ftrace_event_class event_class_##name;
70 #define DEFINE_EVENT(template, name, proto, args) \
71 static struct ftrace_event_call __used \
72 __attribute__((__aligned__(4))) event_##name
74 #undef DEFINE_EVENT_FN
75 #define DEFINE_EVENT_FN(template, name, proto, args, reg, unreg) \
76 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
78 #undef DEFINE_EVENT_PRINT
79 #define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
80 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
82 /* Callbacks are meaningless to ftrace. */
84 #define TRACE_EVENT_FN(name, proto, args, tstruct, \
85 assign, print, reg, unreg) \
86 TRACE_EVENT(name, PARAMS(proto), PARAMS(args), \
87 PARAMS(tstruct), PARAMS(assign), PARAMS(print)) \
89 #undef TRACE_EVENT_FLAGS
90 #define TRACE_EVENT_FLAGS(name, value) \
91 __TRACE_EVENT_FLAGS(name, value)
93 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
97 * Stage 2 of the trace events.
99 * Include the following:
101 * struct ftrace_data_offsets_<call> {
107 * The __dynamic_array() macro will create each u32 <item>, this is
108 * to keep the offset of each array from the beginning of the event.
109 * The size of an array is also encoded, in the higher 16 bits of <item>.
113 #define __field(type, item)
116 #define __field_ext(type, item, filter_type)
119 #define __array(type, item, len)
121 #undef __dynamic_array
122 #define __dynamic_array(type, item, len) u32 item;
125 #define __string(item, src) __dynamic_array(char, item, -1)
127 #undef DECLARE_EVENT_CLASS
128 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
129 struct ftrace_data_offsets_##call { \
134 #define DEFINE_EVENT(template, name, proto, args)
136 #undef DEFINE_EVENT_PRINT
137 #define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
138 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
140 #undef TRACE_EVENT_FLAGS
141 #define TRACE_EVENT_FLAGS(event, flag)
143 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
146 * Stage 3 of the trace events.
148 * Override the macros in <trace/trace_events.h> to include the following:
151 * ftrace_raw_output_<call>(struct trace_iterator *iter, int flags)
153 * struct trace_seq *s = &iter->seq;
154 * struct ftrace_raw_<call> *field; <-- defined in stage 1
155 * struct trace_entry *entry;
156 * struct trace_seq *p = &iter->tmp_seq;
161 * if (entry->type != event_<call>->event.type) {
163 * return TRACE_TYPE_UNHANDLED;
166 * field = (typeof(field))entry;
169 * ret = trace_seq_printf(s, "%s: ", <call>);
171 * ret = trace_seq_printf(s, <TP_printk> "\n");
173 * return TRACE_TYPE_PARTIAL_LINE;
175 * return TRACE_TYPE_HANDLED;
178 * This is the method used to print the raw event to the trace
179 * output format. Note, this is not needed if the data is read
184 #define __entry field
187 #define TP_printk(fmt, args...) fmt "\n", args
189 #undef __get_dynamic_array
190 #define __get_dynamic_array(field) \
191 ((void *)__entry + (__entry->__data_loc_##field & 0xffff))
194 #define __get_str(field) (char *)__get_dynamic_array(field)
197 #define __print_flags(flag, delim, flag_array...) \
199 static const struct trace_print_flags __flags[] = \
200 { flag_array, { -1, NULL }}; \
201 ftrace_print_flags_seq(p, delim, flag, __flags); \
204 #undef __print_symbolic
205 #define __print_symbolic(value, symbol_array...) \
207 static const struct trace_print_flags symbols[] = \
208 { symbol_array, { -1, NULL }}; \
209 ftrace_print_symbols_seq(p, value, symbols); \
212 #undef __print_symbolic_u64
213 #if BITS_PER_LONG == 32
214 #define __print_symbolic_u64(value, symbol_array...) \
216 static const struct trace_print_flags_u64 symbols[] = \
217 { symbol_array, { -1, NULL } }; \
218 ftrace_print_symbols_seq_u64(p, value, symbols); \
221 #define __print_symbolic_u64(value, symbol_array...) \
222 __print_symbolic(value, symbol_array)
226 #define __print_hex(buf, buf_len) ftrace_print_hex_seq(p, buf, buf_len)
228 #undef DECLARE_EVENT_CLASS
229 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
230 static notrace enum print_line_t \
231 ftrace_raw_output_##call(struct trace_iterator *iter, int flags, \
232 struct trace_event *trace_event) \
234 struct trace_seq *s = &iter->seq; \
235 struct trace_seq __maybe_unused *p = &iter->tmp_seq; \
236 struct ftrace_raw_##call *field; \
239 field = (typeof(field))iter->ent; \
241 ret = ftrace_raw_output_prep(iter, trace_event); \
245 ret = trace_seq_printf(s, print); \
247 return TRACE_TYPE_PARTIAL_LINE; \
249 return TRACE_TYPE_HANDLED; \
251 static struct trace_event_functions ftrace_event_type_funcs_##call = { \
252 .trace = ftrace_raw_output_##call, \
255 #undef DEFINE_EVENT_PRINT
256 #define DEFINE_EVENT_PRINT(template, call, proto, args, print) \
257 static notrace enum print_line_t \
258 ftrace_raw_output_##call(struct trace_iterator *iter, int flags, \
259 struct trace_event *event) \
261 struct trace_seq *s = &iter->seq; \
262 struct ftrace_raw_##template *field; \
263 struct trace_entry *entry; \
264 struct trace_seq *p = &iter->tmp_seq; \
269 if (entry->type != event_##call.event.type) { \
271 return TRACE_TYPE_UNHANDLED; \
274 field = (typeof(field))entry; \
277 ret = trace_seq_printf(s, "%s: ", #call); \
279 ret = trace_seq_printf(s, print); \
281 return TRACE_TYPE_PARTIAL_LINE; \
283 return TRACE_TYPE_HANDLED; \
285 static struct trace_event_functions ftrace_event_type_funcs_##call = { \
286 .trace = ftrace_raw_output_##call, \
289 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
292 #define __field_ext(type, item, filter_type) \
293 ret = trace_define_field(event_call, #type, #item, \
294 offsetof(typeof(field), item), \
295 sizeof(field.item), \
296 is_signed_type(type), filter_type); \
301 #define __field(type, item) __field_ext(type, item, FILTER_OTHER)
304 #define __array(type, item, len) \
306 mutex_lock(&event_storage_mutex); \
307 BUILD_BUG_ON(len > MAX_FILTER_STR_VAL); \
308 snprintf(event_storage, sizeof(event_storage), \
309 "%s[%d]", #type, len); \
310 ret = trace_define_field(event_call, event_storage, #item, \
311 offsetof(typeof(field), item), \
312 sizeof(field.item), \
313 is_signed_type(type), FILTER_OTHER); \
314 mutex_unlock(&event_storage_mutex); \
319 #undef __dynamic_array
320 #define __dynamic_array(type, item, len) \
321 ret = trace_define_field(event_call, "__data_loc " #type "[]", #item, \
322 offsetof(typeof(field), __data_loc_##item), \
323 sizeof(field.__data_loc_##item), \
324 is_signed_type(type), FILTER_OTHER);
327 #define __string(item, src) __dynamic_array(char, item, -1)
329 #undef DECLARE_EVENT_CLASS
330 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, func, print) \
331 static int notrace __init \
332 ftrace_define_fields_##call(struct ftrace_event_call *event_call) \
334 struct ftrace_raw_##call field; \
343 #define DEFINE_EVENT(template, name, proto, args)
345 #undef DEFINE_EVENT_PRINT
346 #define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
347 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
349 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
352 * remember the offset of each array from the beginning of the event.
356 #define __entry entry
359 #define __field(type, item)
362 #define __field_ext(type, item, filter_type)
365 #define __array(type, item, len)
367 #undef __dynamic_array
368 #define __dynamic_array(type, item, len) \
369 __data_offsets->item = __data_size + \
370 offsetof(typeof(*entry), __data); \
371 __data_offsets->item |= (len * sizeof(type)) << 16; \
372 __data_size += (len) * sizeof(type);
375 #define __string(item, src) __dynamic_array(char, item, strlen(src) + 1)
377 #undef DECLARE_EVENT_CLASS
378 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
379 static inline notrace int ftrace_get_offsets_##call( \
380 struct ftrace_data_offsets_##call *__data_offsets, proto) \
382 int __data_size = 0; \
383 struct ftrace_raw_##call __maybe_unused *entry; \
387 return __data_size; \
391 #define DEFINE_EVENT(template, name, proto, args)
393 #undef DEFINE_EVENT_PRINT
394 #define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
395 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
397 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
400 * Stage 4 of the trace events.
402 * Override the macros in <trace/trace_events.h> to include the following:
404 * For those macros defined with TRACE_EVENT:
406 * static struct ftrace_event_call event_<call>;
408 * static void ftrace_raw_event_<call>(void *__data, proto)
410 * struct ftrace_event_file *ftrace_file = __data;
411 * struct ftrace_event_call *event_call = ftrace_file->event_call;
412 * struct ftrace_data_offsets_<call> __maybe_unused __data_offsets;
413 * struct ring_buffer_event *event;
414 * struct ftrace_raw_<call> *entry; <-- defined in stage 1
415 * struct ring_buffer *buffer;
416 * unsigned long irq_flags;
420 * if (test_bit(FTRACE_EVENT_FL_SOFT_DISABLED_BIT,
421 * &ftrace_file->flags))
424 * local_save_flags(irq_flags);
425 * pc = preempt_count();
427 * __data_size = ftrace_get_offsets_<call>(&__data_offsets, args);
429 * event = trace_event_buffer_lock_reserve(&buffer, ftrace_file,
430 * event_<call>->event.type,
431 * sizeof(*entry) + __data_size,
435 * entry = ring_buffer_event_data(event);
437 * { <assign>; } <-- Here we assign the entries by the __field and
440 * if (!filter_check_discard(ftrace_file, entry, buffer, event))
441 * trace_buffer_unlock_commit(buffer, event, irq_flags, pc);
444 * static struct trace_event ftrace_event_type_<call> = {
445 * .trace = ftrace_raw_output_<call>, <-- stage 2
448 * static const char print_fmt_<call>[] = <TP_printk>;
450 * static struct ftrace_event_class __used event_class_<template> = {
451 * .system = "<system>",
452 * .define_fields = ftrace_define_fields_<call>,
453 * .fields = LIST_HEAD_INIT(event_class_##call.fields),
454 * .raw_init = trace_event_raw_init,
455 * .probe = ftrace_raw_event_##call,
456 * .reg = ftrace_event_reg,
459 * static struct ftrace_event_call event_<call> = {
461 * .class = event_class_<template>,
462 * .event = &ftrace_event_type_<call>,
463 * .print_fmt = print_fmt_<call>,
465 * // its only safe to use pointers when doing linker tricks to
466 * // create an array.
467 * static struct ftrace_event_call __used
468 * __attribute__((section("_ftrace_events"))) *__event_<call> = &event_<call>;
472 #ifdef CONFIG_PERF_EVENTS
474 #define _TRACE_PERF_PROTO(call, proto) \
475 static notrace void \
476 perf_trace_##call(void *__data, proto);
478 #define _TRACE_PERF_INIT(call) \
479 .perf_probe = perf_trace_##call,
482 #define _TRACE_PERF_PROTO(call, proto)
483 #define _TRACE_PERF_INIT(call)
484 #endif /* CONFIG_PERF_EVENTS */
487 #define __entry entry
490 #define __field(type, item)
493 #define __array(type, item, len)
495 #undef __dynamic_array
496 #define __dynamic_array(type, item, len) \
497 __entry->__data_loc_##item = __data_offsets.item;
500 #define __string(item, src) __dynamic_array(char, item, -1) \
503 #define __assign_str(dst, src) \
504 strcpy(__get_str(dst), src);
506 #undef TP_fast_assign
507 #define TP_fast_assign(args...) args
510 #define __perf_addr(a) (a)
513 #define __perf_count(c) (c)
516 #define __perf_task(t) (t)
518 #undef DECLARE_EVENT_CLASS
519 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
521 static notrace void \
522 ftrace_raw_event_##call(void *__data, proto) \
524 struct ftrace_event_file *ftrace_file = __data; \
525 struct ftrace_event_call *event_call = ftrace_file->event_call; \
526 struct ftrace_data_offsets_##call __maybe_unused __data_offsets;\
527 struct ring_buffer_event *event; \
528 struct ftrace_raw_##call *entry; \
529 struct ring_buffer *buffer; \
530 unsigned long irq_flags; \
534 if (test_bit(FTRACE_EVENT_FL_SOFT_DISABLED_BIT, \
535 &ftrace_file->flags)) \
538 local_save_flags(irq_flags); \
539 pc = preempt_count(); \
541 __data_size = ftrace_get_offsets_##call(&__data_offsets, args); \
543 event = trace_event_buffer_lock_reserve(&buffer, ftrace_file, \
544 event_call->event.type, \
545 sizeof(*entry) + __data_size, \
549 entry = ring_buffer_event_data(event); \
555 if (!filter_check_discard(ftrace_file, entry, buffer, event)) \
556 trace_buffer_unlock_commit(buffer, event, irq_flags, pc); \
559 * The ftrace_test_probe is compiled out, it is only here as a build time check
560 * to make sure that if the tracepoint handling changes, the ftrace probe will
561 * fail to compile unless it too is updated.
565 #define DEFINE_EVENT(template, call, proto, args) \
566 static inline void ftrace_test_probe_##call(void) \
568 check_trace_callback_type_##call(ftrace_raw_event_##template); \
571 #undef DEFINE_EVENT_PRINT
572 #define DEFINE_EVENT_PRINT(template, name, proto, args, print)
574 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
580 #undef __print_symbolic
582 #undef __get_dynamic_array
586 #define TP_printk(fmt, args...) "\"" fmt "\", " __stringify(args)
588 #undef DECLARE_EVENT_CLASS
589 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
590 _TRACE_PERF_PROTO(call, PARAMS(proto)); \
591 static const char print_fmt_##call[] = print; \
592 static struct ftrace_event_class __used __refdata event_class_##call = { \
593 .system = __stringify(TRACE_SYSTEM), \
594 .define_fields = ftrace_define_fields_##call, \
595 .fields = LIST_HEAD_INIT(event_class_##call.fields),\
596 .raw_init = trace_event_raw_init, \
597 .probe = ftrace_raw_event_##call, \
598 .reg = ftrace_event_reg, \
599 _TRACE_PERF_INIT(call) \
603 #define DEFINE_EVENT(template, call, proto, args) \
605 static struct ftrace_event_call __used event_##call = { \
607 .class = &event_class_##template, \
608 .event.funcs = &ftrace_event_type_funcs_##template, \
609 .print_fmt = print_fmt_##template, \
611 static struct ftrace_event_call __used \
612 __attribute__((section("_ftrace_events"))) *__event_##call = &event_##call
614 #undef DEFINE_EVENT_PRINT
615 #define DEFINE_EVENT_PRINT(template, call, proto, args, print) \
617 static const char print_fmt_##call[] = print; \
619 static struct ftrace_event_call __used event_##call = { \
621 .class = &event_class_##template, \
622 .event.funcs = &ftrace_event_type_funcs_##call, \
623 .print_fmt = print_fmt_##call, \
625 static struct ftrace_event_call __used \
626 __attribute__((section("_ftrace_events"))) *__event_##call = &event_##call
628 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
631 #ifdef CONFIG_PERF_EVENTS
634 #define __entry entry
636 #undef __get_dynamic_array
637 #define __get_dynamic_array(field) \
638 ((void *)__entry + (__entry->__data_loc_##field & 0xffff))
641 #define __get_str(field) (char *)__get_dynamic_array(field)
644 #define __perf_addr(a) (__addr = (a))
647 #define __perf_count(c) (__count = (c))
650 #define __perf_task(t) (__task = (t))
652 #undef DECLARE_EVENT_CLASS
653 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
654 static notrace void \
655 perf_trace_##call(void *__data, proto) \
657 struct ftrace_event_call *event_call = __data; \
658 struct ftrace_data_offsets_##call __maybe_unused __data_offsets;\
659 struct ftrace_raw_##call *entry; \
660 struct pt_regs __regs; \
661 u64 __addr = 0, __count = 1; \
662 struct task_struct *__task = NULL; \
663 struct hlist_head *head; \
668 __data_size = ftrace_get_offsets_##call(&__data_offsets, args); \
670 head = this_cpu_ptr(event_call->perf_events); \
671 if (__builtin_constant_p(!__task) && !__task && \
675 __entry_size = ALIGN(__data_size + sizeof(*entry) + sizeof(u32),\
677 __entry_size -= sizeof(u32); \
679 perf_fetch_caller_regs(&__regs); \
680 entry = perf_trace_buf_prepare(__entry_size, \
681 event_call->event.type, &__regs, &rctx); \
689 perf_trace_buf_submit(entry, __entry_size, rctx, __addr, \
690 __count, &__regs, head, __task); \
694 * This part is compiled out, it is only here as a build time check
695 * to make sure that if the tracepoint handling changes, the
696 * perf probe will fail to compile unless it too is updated.
699 #define DEFINE_EVENT(template, call, proto, args) \
700 static inline void perf_test_probe_##call(void) \
702 check_trace_callback_type_##call(perf_trace_##template); \
706 #undef DEFINE_EVENT_PRINT
707 #define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
708 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
710 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
711 #endif /* CONFIG_PERF_EVENTS */