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); \
208 #undef __print_symbolic_u64
209 #if BITS_PER_LONG == 32
210 #define __print_symbolic_u64(value, symbol_array...) \
212 static const struct trace_print_flags_u64 symbols[] = \
213 { symbol_array, { -1, NULL } }; \
214 ftrace_print_symbols_seq_u64(p, value, symbols); \
217 #define __print_symbolic_u64(value, symbol_array...) \
218 __print_symbolic(value, symbol_array)
222 #define __print_hex(buf, buf_len) ftrace_print_hex_seq(p, buf, buf_len)
224 #undef DECLARE_EVENT_CLASS
225 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
226 static notrace enum print_line_t \
227 ftrace_raw_output_##call(struct trace_iterator *iter, int flags, \
228 struct trace_event *trace_event) \
230 struct trace_seq *s = &iter->seq; \
231 struct trace_seq __maybe_unused *p = &iter->tmp_seq; \
232 struct ftrace_raw_##call *field; \
235 field = (typeof(field))iter->ent; \
237 ret = ftrace_raw_output_prep(iter, trace_event); \
241 ret = trace_seq_printf(s, print); \
243 return TRACE_TYPE_PARTIAL_LINE; \
245 return TRACE_TYPE_HANDLED; \
247 static struct trace_event_functions ftrace_event_type_funcs_##call = { \
248 .trace = ftrace_raw_output_##call, \
251 #undef DEFINE_EVENT_PRINT
252 #define DEFINE_EVENT_PRINT(template, call, proto, args, print) \
253 static notrace enum print_line_t \
254 ftrace_raw_output_##call(struct trace_iterator *iter, int flags, \
255 struct trace_event *event) \
257 struct trace_seq *s = &iter->seq; \
258 struct ftrace_raw_##template *field; \
259 struct trace_entry *entry; \
260 struct trace_seq *p = &iter->tmp_seq; \
265 if (entry->type != event_##call.event.type) { \
267 return TRACE_TYPE_UNHANDLED; \
270 field = (typeof(field))entry; \
273 ret = trace_seq_printf(s, "%s: ", #call); \
275 ret = trace_seq_printf(s, print); \
277 return TRACE_TYPE_PARTIAL_LINE; \
279 return TRACE_TYPE_HANDLED; \
281 static struct trace_event_functions ftrace_event_type_funcs_##call = { \
282 .trace = ftrace_raw_output_##call, \
285 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
288 #define __field_ext(type, item, filter_type) \
289 ret = trace_define_field(event_call, #type, #item, \
290 offsetof(typeof(field), item), \
291 sizeof(field.item), \
292 is_signed_type(type), filter_type); \
297 #define __field(type, item) __field_ext(type, item, FILTER_OTHER)
300 #define __array(type, item, len) \
302 char *type_str = #type"["__stringify(len)"]"; \
303 BUILD_BUG_ON(len > MAX_FILTER_STR_VAL); \
304 ret = trace_define_field(event_call, type_str, #item, \
305 offsetof(typeof(field), item), \
306 sizeof(field.item), \
307 is_signed_type(type), FILTER_OTHER); \
312 #undef __dynamic_array
313 #define __dynamic_array(type, item, len) \
314 ret = trace_define_field(event_call, "__data_loc " #type "[]", #item, \
315 offsetof(typeof(field), __data_loc_##item), \
316 sizeof(field.__data_loc_##item), \
317 is_signed_type(type), FILTER_OTHER);
320 #define __string(item, src) __dynamic_array(char, item, -1)
322 #undef DECLARE_EVENT_CLASS
323 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, func, print) \
324 static int notrace __init \
325 ftrace_define_fields_##call(struct ftrace_event_call *event_call) \
327 struct ftrace_raw_##call field; \
336 #define DEFINE_EVENT(template, name, proto, args)
338 #undef DEFINE_EVENT_PRINT
339 #define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
340 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
342 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
345 * remember the offset of each array from the beginning of the event.
349 #define __entry entry
352 #define __field(type, item)
355 #define __field_ext(type, item, filter_type)
358 #define __array(type, item, len)
360 #undef __dynamic_array
361 #define __dynamic_array(type, item, len) \
362 __data_offsets->item = __data_size + \
363 offsetof(typeof(*entry), __data); \
364 __data_offsets->item |= (len * sizeof(type)) << 16; \
365 __data_size += (len) * sizeof(type);
368 #define __string(item, src) __dynamic_array(char, item, \
369 strlen((src) ? (const char *)(src) : "(null)") + 1)
371 #undef DECLARE_EVENT_CLASS
372 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
373 static inline notrace int ftrace_get_offsets_##call( \
374 struct ftrace_data_offsets_##call *__data_offsets, proto) \
376 int __data_size = 0; \
377 struct ftrace_raw_##call __maybe_unused *entry; \
381 return __data_size; \
385 #define DEFINE_EVENT(template, name, proto, args)
387 #undef DEFINE_EVENT_PRINT
388 #define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
389 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
391 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
394 * Stage 4 of the trace events.
396 * Override the macros in <trace/trace_events.h> to include the following:
398 * For those macros defined with TRACE_EVENT:
400 * static struct ftrace_event_call event_<call>;
402 * static void ftrace_raw_event_<call>(void *__data, proto)
404 * struct ftrace_event_file *ftrace_file = __data;
405 * struct ftrace_event_call *event_call = ftrace_file->event_call;
406 * struct ftrace_data_offsets_<call> __maybe_unused __data_offsets;
407 * struct ring_buffer_event *event;
408 * struct ftrace_raw_<call> *entry; <-- defined in stage 1
409 * struct ring_buffer *buffer;
410 * unsigned long irq_flags;
414 * if (test_bit(FTRACE_EVENT_FL_SOFT_DISABLED_BIT,
415 * &ftrace_file->flags))
418 * local_save_flags(irq_flags);
419 * pc = preempt_count();
421 * __data_size = ftrace_get_offsets_<call>(&__data_offsets, args);
423 * event = trace_event_buffer_lock_reserve(&buffer, ftrace_file,
424 * event_<call>->event.type,
425 * sizeof(*entry) + __data_size,
429 * entry = ring_buffer_event_data(event);
431 * { <assign>; } <-- Here we assign the entries by the __field and
434 * if (!filter_current_check_discard(buffer, event_call, entry, event))
435 * trace_nowake_buffer_unlock_commit(buffer,
436 * event, irq_flags, pc);
439 * static struct trace_event ftrace_event_type_<call> = {
440 * .trace = ftrace_raw_output_<call>, <-- stage 2
443 * static const char print_fmt_<call>[] = <TP_printk>;
445 * static struct ftrace_event_class __used event_class_<template> = {
446 * .system = "<system>",
447 * .define_fields = ftrace_define_fields_<call>,
448 * .fields = LIST_HEAD_INIT(event_class_##call.fields),
449 * .raw_init = trace_event_raw_init,
450 * .probe = ftrace_raw_event_##call,
451 * .reg = ftrace_event_reg,
454 * static struct ftrace_event_call event_<call> = {
456 * .class = event_class_<template>,
457 * .event = &ftrace_event_type_<call>,
458 * .print_fmt = print_fmt_<call>,
460 * // its only safe to use pointers when doing linker tricks to
461 * // create an array.
462 * static struct ftrace_event_call __used
463 * __attribute__((section("_ftrace_events"))) *__event_<call> = &event_<call>;
467 #ifdef CONFIG_PERF_EVENTS
469 #define _TRACE_PERF_PROTO(call, proto) \
470 static notrace void \
471 perf_trace_##call(void *__data, proto);
473 #define _TRACE_PERF_INIT(call) \
474 .perf_probe = perf_trace_##call,
477 #define _TRACE_PERF_PROTO(call, proto)
478 #define _TRACE_PERF_INIT(call)
479 #endif /* CONFIG_PERF_EVENTS */
482 #define __entry entry
485 #define __field(type, item)
488 #define __array(type, item, len)
490 #undef __dynamic_array
491 #define __dynamic_array(type, item, len) \
492 __entry->__data_loc_##item = __data_offsets.item;
495 #define __string(item, src) __dynamic_array(char, item, -1) \
498 #define __assign_str(dst, src) \
499 strcpy(__get_str(dst), (src) ? (const char *)(src) : "(null)");
501 #undef TP_fast_assign
502 #define TP_fast_assign(args...) args
504 #undef TP_perf_assign
505 #define TP_perf_assign(args...)
507 #undef DECLARE_EVENT_CLASS
508 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
510 static notrace void \
511 ftrace_raw_event_##call(void *__data, proto) \
513 struct ftrace_event_file *ftrace_file = __data; \
514 struct ftrace_event_call *event_call = ftrace_file->event_call; \
515 struct ftrace_data_offsets_##call __maybe_unused __data_offsets;\
516 struct ring_buffer_event *event; \
517 struct ftrace_raw_##call *entry; \
518 struct ring_buffer *buffer; \
519 unsigned long irq_flags; \
523 if (test_bit(FTRACE_EVENT_FL_SOFT_DISABLED_BIT, \
524 &ftrace_file->flags)) \
527 local_save_flags(irq_flags); \
528 pc = preempt_count(); \
530 __data_size = ftrace_get_offsets_##call(&__data_offsets, args); \
532 event = trace_event_buffer_lock_reserve(&buffer, ftrace_file, \
533 event_call->event.type, \
534 sizeof(*entry) + __data_size, \
538 entry = ring_buffer_event_data(event); \
544 if (!filter_current_check_discard(buffer, event_call, entry, event)) \
545 trace_buffer_unlock_commit(buffer, event, irq_flags, pc); \
548 * The ftrace_test_probe is compiled out, it is only here as a build time check
549 * to make sure that if the tracepoint handling changes, the ftrace probe will
550 * fail to compile unless it too is updated.
554 #define DEFINE_EVENT(template, call, proto, args) \
555 static inline void ftrace_test_probe_##call(void) \
557 check_trace_callback_type_##call(ftrace_raw_event_##template); \
560 #undef DEFINE_EVENT_PRINT
561 #define DEFINE_EVENT_PRINT(template, name, proto, args, print)
563 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
569 #undef __print_symbolic
571 #undef __get_dynamic_array
575 #define TP_printk(fmt, args...) "\"" fmt "\", " __stringify(args)
577 #undef DECLARE_EVENT_CLASS
578 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
579 _TRACE_PERF_PROTO(call, PARAMS(proto)); \
580 static const char print_fmt_##call[] = print; \
581 static struct ftrace_event_class __used __refdata event_class_##call = { \
582 .system = __stringify(TRACE_SYSTEM), \
583 .define_fields = ftrace_define_fields_##call, \
584 .fields = LIST_HEAD_INIT(event_class_##call.fields),\
585 .raw_init = trace_event_raw_init, \
586 .probe = ftrace_raw_event_##call, \
587 .reg = ftrace_event_reg, \
588 _TRACE_PERF_INIT(call) \
592 #define DEFINE_EVENT(template, call, proto, args) \
594 static struct ftrace_event_call __used event_##call = { \
596 .class = &event_class_##template, \
597 .event.funcs = &ftrace_event_type_funcs_##template, \
598 .print_fmt = print_fmt_##template, \
600 static struct ftrace_event_call __used \
601 __attribute__((section("_ftrace_events"))) *__event_##call = &event_##call
603 #undef DEFINE_EVENT_PRINT
604 #define DEFINE_EVENT_PRINT(template, call, proto, args, print) \
606 static const char print_fmt_##call[] = print; \
608 static struct ftrace_event_call __used event_##call = { \
610 .class = &event_class_##template, \
611 .event.funcs = &ftrace_event_type_funcs_##call, \
612 .print_fmt = print_fmt_##call, \
614 static struct ftrace_event_call __used \
615 __attribute__((section("_ftrace_events"))) *__event_##call = &event_##call
617 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
620 #ifdef CONFIG_PERF_EVENTS
623 #define __entry entry
625 #undef __get_dynamic_array
626 #define __get_dynamic_array(field) \
627 ((void *)__entry + (__entry->__data_loc_##field & 0xffff))
630 #define __get_str(field) (char *)__get_dynamic_array(field)
633 #define __perf_addr(a) __addr = (a)
636 #define __perf_count(c) __count = (c)
639 #define __perf_task(t) __task = (t)
641 #undef TP_perf_assign
642 #define TP_perf_assign(args...) args
644 #undef DECLARE_EVENT_CLASS
645 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
646 static notrace void \
647 perf_trace_##call(void *__data, proto) \
649 struct ftrace_event_call *event_call = __data; \
650 struct ftrace_data_offsets_##call __maybe_unused __data_offsets;\
651 struct ftrace_raw_##call *entry; \
652 struct pt_regs __regs; \
653 u64 __addr = 0, __count = 1; \
654 struct task_struct *__task = NULL; \
655 struct hlist_head *head; \
660 perf_fetch_caller_regs(&__regs); \
662 __data_size = ftrace_get_offsets_##call(&__data_offsets, args); \
663 __entry_size = ALIGN(__data_size + sizeof(*entry) + sizeof(u32),\
665 __entry_size -= sizeof(u32); \
667 if (WARN_ONCE(__entry_size > PERF_MAX_TRACE_SIZE, \
668 "profile buffer not large enough")) \
671 entry = (struct ftrace_raw_##call *)perf_trace_buf_prepare( \
672 __entry_size, event_call->event.type, &__regs, &rctx); \
680 head = this_cpu_ptr(event_call->perf_events); \
681 perf_trace_buf_submit(entry, __entry_size, rctx, __addr, \
682 __count, &__regs, head, __task); \
686 * This part is compiled out, it is only here as a build time check
687 * to make sure that if the tracepoint handling changes, the
688 * perf probe will fail to compile unless it too is updated.
691 #define DEFINE_EVENT(template, call, proto, args) \
692 static inline void perf_test_probe_##call(void) \
694 check_trace_callback_type_##call(perf_trace_##template); \
698 #undef DEFINE_EVENT_PRINT
699 #define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
700 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
702 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
703 #endif /* CONFIG_PERF_EVENTS */