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_PRINT
75 #define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
76 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
78 /* Callbacks are meaningless to ftrace. */
80 #define TRACE_EVENT_FN(name, proto, args, tstruct, \
81 assign, print, reg, unreg) \
82 TRACE_EVENT(name, PARAMS(proto), PARAMS(args), \
83 PARAMS(tstruct), PARAMS(assign), PARAMS(print)) \
85 #undef TRACE_EVENT_FLAGS
86 #define TRACE_EVENT_FLAGS(name, value) \
87 __TRACE_EVENT_FLAGS(name, value)
89 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
93 * Stage 2 of the trace events.
95 * Include the following:
97 * struct ftrace_data_offsets_<call> {
103 * The __dynamic_array() macro will create each u32 <item>, this is
104 * to keep the offset of each array from the beginning of the event.
105 * The size of an array is also encoded, in the higher 16 bits of <item>.
109 #define __field(type, item)
112 #define __field_ext(type, item, filter_type)
115 #define __array(type, item, len)
117 #undef __dynamic_array
118 #define __dynamic_array(type, item, len) u32 item;
121 #define __string(item, src) __dynamic_array(char, item, -1)
123 #undef DECLARE_EVENT_CLASS
124 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
125 struct ftrace_data_offsets_##call { \
130 #define DEFINE_EVENT(template, name, proto, args)
132 #undef DEFINE_EVENT_PRINT
133 #define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
134 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
136 #undef TRACE_EVENT_FLAGS
137 #define TRACE_EVENT_FLAGS(event, flag)
139 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
142 * Stage 3 of the trace events.
144 * Override the macros in <trace/trace_events.h> to include the following:
147 * ftrace_raw_output_<call>(struct trace_iterator *iter, int flags)
149 * struct trace_seq *s = &iter->seq;
150 * struct ftrace_raw_<call> *field; <-- defined in stage 1
151 * struct trace_entry *entry;
152 * struct trace_seq *p = &iter->tmp_seq;
157 * if (entry->type != event_<call>->event.type) {
159 * return TRACE_TYPE_UNHANDLED;
162 * field = (typeof(field))entry;
165 * ret = trace_seq_printf(s, "%s: ", <call>);
167 * ret = trace_seq_printf(s, <TP_printk> "\n");
169 * return TRACE_TYPE_PARTIAL_LINE;
171 * return TRACE_TYPE_HANDLED;
174 * This is the method used to print the raw event to the trace
175 * output format. Note, this is not needed if the data is read
180 #define __entry field
183 #define TP_printk(fmt, args...) fmt "\n", args
185 #undef __get_dynamic_array
186 #define __get_dynamic_array(field) \
187 ((void *)__entry + (__entry->__data_loc_##field & 0xffff))
190 #define __get_str(field) (char *)__get_dynamic_array(field)
193 #define __print_flags(flag, delim, flag_array...) \
195 static const struct trace_print_flags __flags[] = \
196 { flag_array, { -1, NULL }}; \
197 ftrace_print_flags_seq(p, delim, flag, __flags); \
200 #undef __print_symbolic
201 #define __print_symbolic(value, symbol_array...) \
203 static const struct trace_print_flags symbols[] = \
204 { symbol_array, { -1, NULL }}; \
205 ftrace_print_symbols_seq(p, value, symbols); \
209 #define __print_hex(buf, buf_len) ftrace_print_hex_seq(p, buf, buf_len)
211 #undef DECLARE_EVENT_CLASS
212 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
213 static notrace enum print_line_t \
214 ftrace_raw_output_##call(struct trace_iterator *iter, int flags, \
215 struct trace_event *trace_event) \
217 struct ftrace_event_call *event; \
218 struct trace_seq *s = &iter->seq; \
219 struct ftrace_raw_##call *field; \
220 struct trace_entry *entry; \
221 struct trace_seq *p = &iter->tmp_seq; \
224 event = container_of(trace_event, struct ftrace_event_call, \
229 if (entry->type != event->event.type) { \
231 return TRACE_TYPE_UNHANDLED; \
234 field = (typeof(field))entry; \
237 ret = trace_seq_printf(s, "%s: ", event->name); \
239 ret = trace_seq_printf(s, print); \
241 return TRACE_TYPE_PARTIAL_LINE; \
243 return TRACE_TYPE_HANDLED; \
245 static struct trace_event_functions ftrace_event_type_funcs_##call = { \
246 .trace = ftrace_raw_output_##call, \
249 #undef DEFINE_EVENT_PRINT
250 #define DEFINE_EVENT_PRINT(template, call, proto, args, print) \
251 static notrace enum print_line_t \
252 ftrace_raw_output_##call(struct trace_iterator *iter, int flags, \
253 struct trace_event *event) \
255 struct trace_seq *s = &iter->seq; \
256 struct ftrace_raw_##template *field; \
257 struct trace_entry *entry; \
258 struct trace_seq *p = &iter->tmp_seq; \
263 if (entry->type != event_##call.event.type) { \
265 return TRACE_TYPE_UNHANDLED; \
268 field = (typeof(field))entry; \
271 ret = trace_seq_printf(s, "%s: ", #call); \
273 ret = trace_seq_printf(s, print); \
275 return TRACE_TYPE_PARTIAL_LINE; \
277 return TRACE_TYPE_HANDLED; \
279 static struct trace_event_functions ftrace_event_type_funcs_##call = { \
280 .trace = ftrace_raw_output_##call, \
283 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
286 #define __field_ext(type, item, filter_type) \
287 ret = trace_define_field(event_call, #type, #item, \
288 offsetof(typeof(field), item), \
289 sizeof(field.item), \
290 is_signed_type(type), filter_type); \
295 #define __field(type, item) __field_ext(type, item, FILTER_OTHER)
298 #define __array(type, item, len) \
299 BUILD_BUG_ON(len > MAX_FILTER_STR_VAL); \
300 ret = trace_define_field(event_call, #type "[" #len "]", #item, \
301 offsetof(typeof(field), item), \
302 sizeof(field.item), \
303 is_signed_type(type), FILTER_OTHER); \
307 #undef __dynamic_array
308 #define __dynamic_array(type, item, len) \
309 ret = trace_define_field(event_call, "__data_loc " #type "[]", #item, \
310 offsetof(typeof(field), __data_loc_##item), \
311 sizeof(field.__data_loc_##item), \
312 is_signed_type(type), FILTER_OTHER);
315 #define __string(item, src) __dynamic_array(char, item, -1)
317 #undef DECLARE_EVENT_CLASS
318 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, func, print) \
320 ftrace_define_fields_##call(struct ftrace_event_call *event_call) \
322 struct ftrace_raw_##call field; \
331 #define DEFINE_EVENT(template, name, proto, args)
333 #undef DEFINE_EVENT_PRINT
334 #define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
335 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
337 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
340 * remember the offset of each array from the beginning of the event.
344 #define __entry entry
347 #define __field(type, item)
350 #define __field_ext(type, item, filter_type)
353 #define __array(type, item, len)
355 #undef __dynamic_array
356 #define __dynamic_array(type, item, len) \
357 __data_offsets->item = __data_size + \
358 offsetof(typeof(*entry), __data); \
359 __data_offsets->item |= (len * sizeof(type)) << 16; \
360 __data_size += (len) * sizeof(type);
363 #define __string(item, src) __dynamic_array(char, item, strlen(src) + 1)
365 #undef DECLARE_EVENT_CLASS
366 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
367 static inline notrace int ftrace_get_offsets_##call( \
368 struct ftrace_data_offsets_##call *__data_offsets, proto) \
370 int __data_size = 0; \
371 struct ftrace_raw_##call __maybe_unused *entry; \
375 return __data_size; \
379 #define DEFINE_EVENT(template, name, proto, args)
381 #undef DEFINE_EVENT_PRINT
382 #define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
383 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
385 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
388 * Stage 4 of the trace events.
390 * Override the macros in <trace/trace_events.h> to include the following:
392 * For those macros defined with TRACE_EVENT:
394 * static struct ftrace_event_call event_<call>;
396 * static void ftrace_raw_event_<call>(void *__data, proto)
398 * struct ftrace_event_call *event_call = __data;
399 * struct ftrace_data_offsets_<call> __maybe_unused __data_offsets;
400 * struct ring_buffer_event *event;
401 * struct ftrace_raw_<call> *entry; <-- defined in stage 1
402 * struct ring_buffer *buffer;
403 * unsigned long irq_flags;
407 * local_save_flags(irq_flags);
408 * pc = preempt_count();
410 * __data_size = ftrace_get_offsets_<call>(&__data_offsets, args);
412 * event = trace_current_buffer_lock_reserve(&buffer,
413 * event_<call>->event.type,
414 * sizeof(*entry) + __data_size,
418 * entry = ring_buffer_event_data(event);
420 * { <assign>; } <-- Here we assign the entries by the __field and
423 * if (!filter_current_check_discard(buffer, event_call, entry, event))
424 * trace_current_buffer_unlock_commit(buffer,
425 * event, irq_flags, pc);
428 * static struct trace_event ftrace_event_type_<call> = {
429 * .trace = ftrace_raw_output_<call>, <-- stage 2
432 * static const char print_fmt_<call>[] = <TP_printk>;
434 * static struct ftrace_event_class __used event_class_<template> = {
435 * .system = "<system>",
436 * .define_fields = ftrace_define_fields_<call>,
437 * .fields = LIST_HEAD_INIT(event_class_##call.fields),
438 * .raw_init = trace_event_raw_init,
439 * .probe = ftrace_raw_event_##call,
440 * .reg = ftrace_event_reg,
443 * static struct ftrace_event_call __used
444 * __attribute__((__aligned__(4)))
445 * __attribute__((section("_ftrace_events"))) event_<call> = {
447 * .class = event_class_<template>,
448 * .event = &ftrace_event_type_<call>,
449 * .print_fmt = print_fmt_<call>,
454 #ifdef CONFIG_PERF_EVENTS
456 #define _TRACE_PERF_PROTO(call, proto) \
457 static notrace void \
458 perf_trace_##call(void *__data, proto);
460 #define _TRACE_PERF_INIT(call) \
461 .perf_probe = perf_trace_##call,
464 #define _TRACE_PERF_PROTO(call, proto)
465 #define _TRACE_PERF_INIT(call)
466 #endif /* CONFIG_PERF_EVENTS */
469 #define __entry entry
472 #define __field(type, item)
475 #define __array(type, item, len)
477 #undef __dynamic_array
478 #define __dynamic_array(type, item, len) \
479 __entry->__data_loc_##item = __data_offsets.item;
482 #define __string(item, src) __dynamic_array(char, item, -1) \
485 #define __assign_str(dst, src) \
486 strcpy(__get_str(dst), src);
488 #undef TP_fast_assign
489 #define TP_fast_assign(args...) args
491 #undef TP_perf_assign
492 #define TP_perf_assign(args...)
494 #undef DECLARE_EVENT_CLASS
495 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
497 static notrace void \
498 ftrace_raw_event_##call(void *__data, proto) \
500 struct ftrace_event_call *event_call = __data; \
501 struct ftrace_data_offsets_##call __maybe_unused __data_offsets;\
502 struct ring_buffer_event *event; \
503 struct ftrace_raw_##call *entry; \
504 struct ring_buffer *buffer; \
505 unsigned long irq_flags; \
509 local_save_flags(irq_flags); \
510 pc = preempt_count(); \
512 __data_size = ftrace_get_offsets_##call(&__data_offsets, args); \
514 event = trace_current_buffer_lock_reserve(&buffer, \
515 event_call->event.type, \
516 sizeof(*entry) + __data_size, \
520 entry = ring_buffer_event_data(event); \
526 if (!filter_current_check_discard(buffer, event_call, entry, event)) \
527 trace_nowake_buffer_unlock_commit(buffer, \
528 event, irq_flags, pc); \
531 * The ftrace_test_probe is compiled out, it is only here as a build time check
532 * to make sure that if the tracepoint handling changes, the ftrace probe will
533 * fail to compile unless it too is updated.
537 #define DEFINE_EVENT(template, call, proto, args) \
538 static inline void ftrace_test_probe_##call(void) \
540 check_trace_callback_type_##call(ftrace_raw_event_##template); \
543 #undef DEFINE_EVENT_PRINT
544 #define DEFINE_EVENT_PRINT(template, name, proto, args, print)
546 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
552 #undef __print_symbolic
553 #undef __get_dynamic_array
557 #define TP_printk(fmt, args...) "\"" fmt "\", " __stringify(args)
559 #undef DECLARE_EVENT_CLASS
560 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
561 _TRACE_PERF_PROTO(call, PARAMS(proto)); \
562 static const char print_fmt_##call[] = print; \
563 static struct ftrace_event_class __used event_class_##call = { \
564 .system = __stringify(TRACE_SYSTEM), \
565 .define_fields = ftrace_define_fields_##call, \
566 .fields = LIST_HEAD_INIT(event_class_##call.fields),\
567 .raw_init = trace_event_raw_init, \
568 .probe = ftrace_raw_event_##call, \
569 .reg = ftrace_event_reg, \
570 _TRACE_PERF_INIT(call) \
574 #define DEFINE_EVENT(template, call, proto, args) \
576 static struct ftrace_event_call __used \
577 __attribute__((__aligned__(4))) \
578 __attribute__((section("_ftrace_events"))) event_##call = { \
580 .class = &event_class_##template, \
581 .event.funcs = &ftrace_event_type_funcs_##template, \
582 .print_fmt = print_fmt_##template, \
585 #undef DEFINE_EVENT_PRINT
586 #define DEFINE_EVENT_PRINT(template, call, proto, args, print) \
588 static const char print_fmt_##call[] = print; \
590 static struct ftrace_event_call __used \
591 __attribute__((__aligned__(4))) \
592 __attribute__((section("_ftrace_events"))) event_##call = { \
594 .class = &event_class_##template, \
595 .event.funcs = &ftrace_event_type_funcs_##call, \
596 .print_fmt = print_fmt_##call, \
599 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
602 * Define the insertion callback to perf events
604 * The job is very similar to ftrace_raw_event_<call> except that we don't
605 * insert in the ring buffer but in a perf counter.
607 * static void ftrace_perf_<call>(proto)
609 * struct ftrace_data_offsets_<call> __maybe_unused __data_offsets;
610 * struct ftrace_event_call *event_call = &event_<call>;
611 * extern void perf_tp_event(int, u64, u64, void *, int);
612 * struct ftrace_raw_##call *entry;
613 * struct perf_trace_buf *trace_buf;
614 * u64 __addr = 0, __count = 1;
615 * unsigned long irq_flags;
616 * struct trace_entry *ent;
622 * pc = preempt_count();
624 * __data_size = ftrace_get_offsets_<call>(&__data_offsets, args);
626 * // Below we want to get the aligned size by taking into account
627 * // the u32 field that will later store the buffer size
628 * __entry_size = ALIGN(__data_size + sizeof(*entry) + sizeof(u32),
630 * __entry_size -= sizeof(u32);
632 * // Protect the non nmi buffer
633 * // This also protects the rcu read side
634 * local_irq_save(irq_flags);
635 * __cpu = smp_processor_id();
638 * trace_buf = rcu_dereference_sched(perf_trace_buf_nmi);
640 * trace_buf = rcu_dereference_sched(perf_trace_buf);
645 * trace_buf = per_cpu_ptr(trace_buf, __cpu);
647 * // Avoid recursion from perf that could mess up the buffer
648 * if (trace_buf->recursion++)
649 * goto end_recursion;
651 * raw_data = trace_buf->buf;
653 * // Make recursion update visible before entering perf_tp_event
654 * // so that we protect from perf recursions.
658 * //zero dead bytes from alignment to avoid stack leak to userspace:
659 * *(u64 *)(&raw_data[__entry_size - sizeof(u64)]) = 0ULL;
660 * entry = (struct ftrace_raw_<call> *)raw_data;
662 * tracing_generic_entry_update(ent, irq_flags, pc);
663 * ent->type = event_call->id;
665 * <tstruct> <- do some jobs with dynamic arrays
667 * <assign> <- affect our values
669 * perf_tp_event(event_call->id, __addr, __count, entry,
670 * __entry_size); <- submit them to perf counter
675 #ifdef CONFIG_PERF_EVENTS
678 #define __entry entry
680 #undef __get_dynamic_array
681 #define __get_dynamic_array(field) \
682 ((void *)__entry + (__entry->__data_loc_##field & 0xffff))
685 #define __get_str(field) (char *)__get_dynamic_array(field)
688 #define __perf_addr(a) __addr = (a)
691 #define __perf_count(c) __count = (c)
693 #undef DECLARE_EVENT_CLASS
694 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
695 static notrace void \
696 perf_trace_##call(void *__data, proto) \
698 struct ftrace_event_call *event_call = __data; \
699 struct ftrace_data_offsets_##call __maybe_unused __data_offsets;\
700 struct ftrace_raw_##call *entry; \
701 struct pt_regs __regs; \
702 u64 __addr = 0, __count = 1; \
703 struct hlist_head *head; \
708 perf_fetch_caller_regs(&__regs); \
710 __data_size = ftrace_get_offsets_##call(&__data_offsets, args); \
711 __entry_size = ALIGN(__data_size + sizeof(*entry) + sizeof(u32),\
713 __entry_size -= sizeof(u32); \
715 if (WARN_ONCE(__entry_size > PERF_MAX_TRACE_SIZE, \
716 "profile buffer not large enough")) \
719 entry = (struct ftrace_raw_##call *)perf_trace_buf_prepare( \
720 __entry_size, event_call->event.type, &__regs, &rctx); \
728 head = this_cpu_ptr(event_call->perf_events); \
729 perf_trace_buf_submit(entry, __entry_size, rctx, __addr, \
730 __count, &__regs, head); \
734 * This part is compiled out, it is only here as a build time check
735 * to make sure that if the tracepoint handling changes, the
736 * perf probe will fail to compile unless it too is updated.
739 #define DEFINE_EVENT(template, call, proto, args) \
740 static inline void perf_test_probe_##call(void) \
742 check_trace_callback_type_##call(perf_trace_##template); \
746 #undef DEFINE_EVENT_PRINT
747 #define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
748 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
750 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
751 #endif /* CONFIG_PERF_EVENTS */
753 #undef _TRACE_PROFILE_INIT