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 #undef TRACE_EVENT_PERF_PERM
94 #define TRACE_EVENT_PERF_PERM(name, expr...) \
95 __TRACE_EVENT_PERF_PERM(name, expr)
97 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
101 * Stage 2 of the trace events.
103 * Include the following:
105 * struct ftrace_data_offsets_<call> {
111 * The __dynamic_array() macro will create each u32 <item>, this is
112 * to keep the offset of each array from the beginning of the event.
113 * The size of an array is also encoded, in the higher 16 bits of <item>.
117 #define __field(type, item)
120 #define __field_ext(type, item, filter_type)
123 #define __array(type, item, len)
125 #undef __dynamic_array
126 #define __dynamic_array(type, item, len) u32 item;
129 #define __string(item, src) __dynamic_array(char, item, -1)
131 #undef DECLARE_EVENT_CLASS
132 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
133 struct ftrace_data_offsets_##call { \
138 #define DEFINE_EVENT(template, name, proto, args)
140 #undef DEFINE_EVENT_PRINT
141 #define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
142 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
144 #undef TRACE_EVENT_FLAGS
145 #define TRACE_EVENT_FLAGS(event, flag)
147 #undef TRACE_EVENT_PERF_PERM
148 #define TRACE_EVENT_PERF_PERM(event, expr...)
150 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
153 * Stage 3 of the trace events.
155 * Override the macros in <trace/trace_events.h> to include the following:
158 * ftrace_raw_output_<call>(struct trace_iterator *iter, int flags)
160 * struct trace_seq *s = &iter->seq;
161 * struct ftrace_raw_<call> *field; <-- defined in stage 1
162 * struct trace_entry *entry;
163 * struct trace_seq *p = &iter->tmp_seq;
168 * if (entry->type != event_<call>->event.type) {
170 * return TRACE_TYPE_UNHANDLED;
173 * field = (typeof(field))entry;
176 * ret = trace_seq_printf(s, "%s: ", <call>);
178 * ret = trace_seq_printf(s, <TP_printk> "\n");
180 * return TRACE_TYPE_PARTIAL_LINE;
182 * return TRACE_TYPE_HANDLED;
185 * This is the method used to print the raw event to the trace
186 * output format. Note, this is not needed if the data is read
191 #define __entry field
194 #define TP_printk(fmt, args...) fmt "\n", args
196 #undef __get_dynamic_array
197 #define __get_dynamic_array(field) \
198 ((void *)__entry + (__entry->__data_loc_##field & 0xffff))
201 #define __get_str(field) (char *)__get_dynamic_array(field)
204 #define __print_flags(flag, delim, flag_array...) \
206 static const struct trace_print_flags __flags[] = \
207 { flag_array, { -1, NULL }}; \
208 ftrace_print_flags_seq(p, delim, flag, __flags); \
211 #undef __print_symbolic
212 #define __print_symbolic(value, symbol_array...) \
214 static const struct trace_print_flags symbols[] = \
215 { symbol_array, { -1, NULL }}; \
216 ftrace_print_symbols_seq(p, value, symbols); \
219 #undef __print_symbolic_u64
220 #if BITS_PER_LONG == 32
221 #define __print_symbolic_u64(value, symbol_array...) \
223 static const struct trace_print_flags_u64 symbols[] = \
224 { symbol_array, { -1, NULL } }; \
225 ftrace_print_symbols_seq_u64(p, value, symbols); \
228 #define __print_symbolic_u64(value, symbol_array...) \
229 __print_symbolic(value, symbol_array)
233 #define __print_hex(buf, buf_len) ftrace_print_hex_seq(p, buf, buf_len)
235 #undef DECLARE_EVENT_CLASS
236 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
237 static notrace enum print_line_t \
238 ftrace_raw_output_##call(struct trace_iterator *iter, int flags, \
239 struct trace_event *trace_event) \
241 struct trace_seq *s = &iter->seq; \
242 struct trace_seq __maybe_unused *p = &iter->tmp_seq; \
243 struct ftrace_raw_##call *field; \
246 field = (typeof(field))iter->ent; \
248 ret = ftrace_raw_output_prep(iter, trace_event); \
252 ret = trace_seq_printf(s, print); \
254 return TRACE_TYPE_PARTIAL_LINE; \
256 return TRACE_TYPE_HANDLED; \
258 static struct trace_event_functions ftrace_event_type_funcs_##call = { \
259 .trace = ftrace_raw_output_##call, \
262 #undef DEFINE_EVENT_PRINT
263 #define DEFINE_EVENT_PRINT(template, call, proto, args, print) \
264 static notrace enum print_line_t \
265 ftrace_raw_output_##call(struct trace_iterator *iter, int flags, \
266 struct trace_event *event) \
268 struct trace_seq *s = &iter->seq; \
269 struct ftrace_raw_##template *field; \
270 struct trace_entry *entry; \
271 struct trace_seq *p = &iter->tmp_seq; \
276 if (entry->type != event_##call.event.type) { \
278 return TRACE_TYPE_UNHANDLED; \
281 field = (typeof(field))entry; \
284 ret = trace_seq_printf(s, "%s: ", #call); \
286 ret = trace_seq_printf(s, print); \
288 return TRACE_TYPE_PARTIAL_LINE; \
290 return TRACE_TYPE_HANDLED; \
292 static struct trace_event_functions ftrace_event_type_funcs_##call = { \
293 .trace = ftrace_raw_output_##call, \
296 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
299 #define __field_ext(type, item, filter_type) \
300 ret = trace_define_field(event_call, #type, #item, \
301 offsetof(typeof(field), item), \
302 sizeof(field.item), \
303 is_signed_type(type), filter_type); \
308 #define __field(type, item) __field_ext(type, item, FILTER_OTHER)
311 #define __array(type, item, len) \
313 mutex_lock(&event_storage_mutex); \
314 BUILD_BUG_ON(len > MAX_FILTER_STR_VAL); \
315 snprintf(event_storage, sizeof(event_storage), \
316 "%s[%d]", #type, len); \
317 ret = trace_define_field(event_call, event_storage, #item, \
318 offsetof(typeof(field), item), \
319 sizeof(field.item), \
320 is_signed_type(type), FILTER_OTHER); \
321 mutex_unlock(&event_storage_mutex); \
326 #undef __dynamic_array
327 #define __dynamic_array(type, item, len) \
328 ret = trace_define_field(event_call, "__data_loc " #type "[]", #item, \
329 offsetof(typeof(field), __data_loc_##item), \
330 sizeof(field.__data_loc_##item), \
331 is_signed_type(type), FILTER_OTHER);
334 #define __string(item, src) __dynamic_array(char, item, -1)
336 #undef DECLARE_EVENT_CLASS
337 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, func, print) \
338 static int notrace __init \
339 ftrace_define_fields_##call(struct ftrace_event_call *event_call) \
341 struct ftrace_raw_##call field; \
350 #define DEFINE_EVENT(template, name, proto, args)
352 #undef DEFINE_EVENT_PRINT
353 #define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
354 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
356 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
359 * remember the offset of each array from the beginning of the event.
363 #define __entry entry
366 #define __field(type, item)
369 #define __field_ext(type, item, filter_type)
372 #define __array(type, item, len)
374 #undef __dynamic_array
375 #define __dynamic_array(type, item, len) \
376 __data_offsets->item = __data_size + \
377 offsetof(typeof(*entry), __data); \
378 __data_offsets->item |= (len * sizeof(type)) << 16; \
379 __data_size += (len) * sizeof(type);
382 #define __string(item, src) __dynamic_array(char, item, \
383 strlen((src) ? (const char *)(src) : "(null)") + 1)
385 #undef DECLARE_EVENT_CLASS
386 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
387 static inline notrace int ftrace_get_offsets_##call( \
388 struct ftrace_data_offsets_##call *__data_offsets, proto) \
390 int __data_size = 0; \
391 struct ftrace_raw_##call __maybe_unused *entry; \
395 return __data_size; \
399 #define DEFINE_EVENT(template, name, proto, args)
401 #undef DEFINE_EVENT_PRINT
402 #define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
403 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
405 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
408 * Stage 4 of the trace events.
410 * Override the macros in <trace/trace_events.h> to include the following:
412 * For those macros defined with TRACE_EVENT:
414 * static struct ftrace_event_call event_<call>;
416 * static void ftrace_raw_event_<call>(void *__data, proto)
418 * struct ftrace_event_file *ftrace_file = __data;
419 * struct ftrace_event_call *event_call = ftrace_file->event_call;
420 * struct ftrace_data_offsets_<call> __maybe_unused __data_offsets;
421 * struct ring_buffer_event *event;
422 * struct ftrace_raw_<call> *entry; <-- defined in stage 1
423 * struct ring_buffer *buffer;
424 * unsigned long irq_flags;
428 * if (test_bit(FTRACE_EVENT_FL_SOFT_DISABLED_BIT,
429 * &ftrace_file->flags))
432 * local_save_flags(irq_flags);
433 * pc = preempt_count();
435 * __data_size = ftrace_get_offsets_<call>(&__data_offsets, args);
437 * event = trace_event_buffer_lock_reserve(&buffer, ftrace_file,
438 * event_<call>->event.type,
439 * sizeof(*entry) + __data_size,
443 * entry = ring_buffer_event_data(event);
445 * { <assign>; } <-- Here we assign the entries by the __field and
448 * if (!filter_check_discard(ftrace_file, entry, buffer, event))
449 * trace_buffer_unlock_commit(buffer, event, irq_flags, pc);
452 * static struct trace_event ftrace_event_type_<call> = {
453 * .trace = ftrace_raw_output_<call>, <-- stage 2
456 * static const char print_fmt_<call>[] = <TP_printk>;
458 * static struct ftrace_event_class __used event_class_<template> = {
459 * .system = "<system>",
460 * .define_fields = ftrace_define_fields_<call>,
461 * .fields = LIST_HEAD_INIT(event_class_##call.fields),
462 * .raw_init = trace_event_raw_init,
463 * .probe = ftrace_raw_event_##call,
464 * .reg = ftrace_event_reg,
467 * static struct ftrace_event_call event_<call> = {
469 * .class = event_class_<template>,
470 * .event = &ftrace_event_type_<call>,
471 * .print_fmt = print_fmt_<call>,
473 * // its only safe to use pointers when doing linker tricks to
474 * // create an array.
475 * static struct ftrace_event_call __used
476 * __attribute__((section("_ftrace_events"))) *__event_<call> = &event_<call>;
480 #ifdef CONFIG_PERF_EVENTS
482 #define _TRACE_PERF_PROTO(call, proto) \
483 static notrace void \
484 perf_trace_##call(void *__data, proto);
486 #define _TRACE_PERF_INIT(call) \
487 .perf_probe = perf_trace_##call,
490 #define _TRACE_PERF_PROTO(call, proto)
491 #define _TRACE_PERF_INIT(call)
492 #endif /* CONFIG_PERF_EVENTS */
495 #define __entry entry
498 #define __field(type, item)
501 #define __array(type, item, len)
503 #undef __dynamic_array
504 #define __dynamic_array(type, item, len) \
505 __entry->__data_loc_##item = __data_offsets.item;
508 #define __string(item, src) __dynamic_array(char, item, -1) \
511 #define __assign_str(dst, src) \
512 strcpy(__get_str(dst), (src) ? (const char *)(src) : "(null)");
514 #undef TP_fast_assign
515 #define TP_fast_assign(args...) args
518 #define __perf_addr(a) (a)
521 #define __perf_count(c) (c)
524 #define __perf_task(t) (t)
526 #undef DECLARE_EVENT_CLASS
527 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
529 static notrace void \
530 ftrace_raw_event_##call(void *__data, proto) \
532 struct ftrace_event_file *ftrace_file = __data; \
533 struct ftrace_event_call *event_call = ftrace_file->event_call; \
534 struct ftrace_data_offsets_##call __maybe_unused __data_offsets;\
535 struct ring_buffer_event *event; \
536 struct ftrace_raw_##call *entry; \
537 struct ring_buffer *buffer; \
538 unsigned long irq_flags; \
542 if (test_bit(FTRACE_EVENT_FL_SOFT_DISABLED_BIT, \
543 &ftrace_file->flags)) \
546 local_save_flags(irq_flags); \
547 pc = preempt_count(); \
549 __data_size = ftrace_get_offsets_##call(&__data_offsets, args); \
551 event = trace_event_buffer_lock_reserve(&buffer, ftrace_file, \
552 event_call->event.type, \
553 sizeof(*entry) + __data_size, \
557 entry = ring_buffer_event_data(event); \
563 if (!filter_check_discard(ftrace_file, entry, buffer, event)) \
564 trace_buffer_unlock_commit(buffer, event, irq_flags, pc); \
567 * The ftrace_test_probe is compiled out, it is only here as a build time check
568 * to make sure that if the tracepoint handling changes, the ftrace probe will
569 * fail to compile unless it too is updated.
573 #define DEFINE_EVENT(template, call, proto, args) \
574 static inline void ftrace_test_probe_##call(void) \
576 check_trace_callback_type_##call(ftrace_raw_event_##template); \
579 #undef DEFINE_EVENT_PRINT
580 #define DEFINE_EVENT_PRINT(template, name, proto, args, print)
582 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
588 #undef __print_symbolic
590 #undef __get_dynamic_array
594 #define TP_printk(fmt, args...) "\"" fmt "\", " __stringify(args)
596 #undef DECLARE_EVENT_CLASS
597 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
598 _TRACE_PERF_PROTO(call, PARAMS(proto)); \
599 static const char print_fmt_##call[] = print; \
600 static struct ftrace_event_class __used __refdata event_class_##call = { \
601 .system = __stringify(TRACE_SYSTEM), \
602 .define_fields = ftrace_define_fields_##call, \
603 .fields = LIST_HEAD_INIT(event_class_##call.fields),\
604 .raw_init = trace_event_raw_init, \
605 .probe = ftrace_raw_event_##call, \
606 .reg = ftrace_event_reg, \
607 _TRACE_PERF_INIT(call) \
611 #define DEFINE_EVENT(template, call, proto, args) \
613 static struct ftrace_event_call __used event_##call = { \
615 .class = &event_class_##template, \
616 .event.funcs = &ftrace_event_type_funcs_##template, \
617 .print_fmt = print_fmt_##template, \
619 static struct ftrace_event_call __used \
620 __attribute__((section("_ftrace_events"))) *__event_##call = &event_##call
622 #undef DEFINE_EVENT_PRINT
623 #define DEFINE_EVENT_PRINT(template, call, proto, args, print) \
625 static const char print_fmt_##call[] = print; \
627 static struct ftrace_event_call __used event_##call = { \
629 .class = &event_class_##template, \
630 .event.funcs = &ftrace_event_type_funcs_##call, \
631 .print_fmt = print_fmt_##call, \
633 static struct ftrace_event_call __used \
634 __attribute__((section("_ftrace_events"))) *__event_##call = &event_##call
636 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
639 #ifdef CONFIG_PERF_EVENTS
642 #define __entry entry
644 #undef __get_dynamic_array
645 #define __get_dynamic_array(field) \
646 ((void *)__entry + (__entry->__data_loc_##field & 0xffff))
649 #define __get_str(field) (char *)__get_dynamic_array(field)
652 #define __perf_addr(a) (__addr = (a))
655 #define __perf_count(c) (__count = (c))
658 #define __perf_task(t) (__task = (t))
660 #undef DECLARE_EVENT_CLASS
661 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
662 static notrace void \
663 perf_trace_##call(void *__data, proto) \
665 struct ftrace_event_call *event_call = __data; \
666 struct ftrace_data_offsets_##call __maybe_unused __data_offsets;\
667 struct ftrace_raw_##call *entry; \
668 struct pt_regs __regs; \
669 u64 __addr = 0, __count = 1; \
670 struct task_struct *__task = NULL; \
671 struct hlist_head *head; \
676 __data_size = ftrace_get_offsets_##call(&__data_offsets, args); \
678 head = this_cpu_ptr(event_call->perf_events); \
679 if (__builtin_constant_p(!__task) && !__task && \
683 __entry_size = ALIGN(__data_size + sizeof(*entry) + sizeof(u32),\
685 __entry_size -= sizeof(u32); \
687 perf_fetch_caller_regs(&__regs); \
688 entry = perf_trace_buf_prepare(__entry_size, \
689 event_call->event.type, &__regs, &rctx); \
697 perf_trace_buf_submit(entry, __entry_size, rctx, __addr, \
698 __count, &__regs, head, __task); \
702 * This part is compiled out, it is only here as a build time check
703 * to make sure that if the tracepoint handling changes, the
704 * perf probe will fail to compile unless it too is updated.
707 #define DEFINE_EVENT(template, call, proto, args) \
708 static inline void perf_test_probe_##call(void) \
710 check_trace_callback_type_##call(perf_trace_##template); \
714 #undef DEFINE_EVENT_PRINT
715 #define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
716 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
718 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
719 #endif /* CONFIG_PERF_EVENTS */