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 ftrace_raw_##template *field; \
269 struct trace_entry *entry; \
270 struct trace_seq *p = &iter->tmp_seq; \
274 if (entry->type != event_##call.event.type) { \
276 return TRACE_TYPE_UNHANDLED; \
279 field = (typeof(field))entry; \
282 return ftrace_output_call(iter, #call, print); \
284 static struct trace_event_functions ftrace_event_type_funcs_##call = { \
285 .trace = ftrace_raw_output_##call, \
288 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
291 #define __field_ext(type, item, filter_type) \
292 ret = trace_define_field(event_call, #type, #item, \
293 offsetof(typeof(field), item), \
294 sizeof(field.item), \
295 is_signed_type(type), filter_type); \
300 #define __field(type, item) __field_ext(type, item, FILTER_OTHER)
303 #define __array(type, item, len) \
305 mutex_lock(&event_storage_mutex); \
306 BUILD_BUG_ON(len > MAX_FILTER_STR_VAL); \
307 snprintf(event_storage, sizeof(event_storage), \
308 "%s[%d]", #type, len); \
309 ret = trace_define_field(event_call, event_storage, #item, \
310 offsetof(typeof(field), item), \
311 sizeof(field.item), \
312 is_signed_type(type), FILTER_OTHER); \
313 mutex_unlock(&event_storage_mutex); \
318 #undef __dynamic_array
319 #define __dynamic_array(type, item, len) \
320 ret = trace_define_field(event_call, "__data_loc " #type "[]", #item, \
321 offsetof(typeof(field), __data_loc_##item), \
322 sizeof(field.__data_loc_##item), \
323 is_signed_type(type), FILTER_OTHER);
326 #define __string(item, src) __dynamic_array(char, item, -1)
328 #undef DECLARE_EVENT_CLASS
329 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, func, print) \
330 static int notrace __init \
331 ftrace_define_fields_##call(struct ftrace_event_call *event_call) \
333 struct ftrace_raw_##call field; \
342 #define DEFINE_EVENT(template, name, proto, args)
344 #undef DEFINE_EVENT_PRINT
345 #define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
346 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
348 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
351 * remember the offset of each array from the beginning of the event.
355 #define __entry entry
358 #define __field(type, item)
361 #define __field_ext(type, item, filter_type)
364 #define __array(type, item, len)
366 #undef __dynamic_array
367 #define __dynamic_array(type, item, len) \
368 __item_length = (len) * sizeof(type); \
369 __data_offsets->item = __data_size + \
370 offsetof(typeof(*entry), __data); \
371 __data_offsets->item |= __item_length << 16; \
372 __data_size += __item_length;
375 #define __string(item, src) __dynamic_array(char, item, \
376 strlen((src) ? (const char *)(src) : "(null)") + 1)
378 #undef DECLARE_EVENT_CLASS
379 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
380 static inline notrace int ftrace_get_offsets_##call( \
381 struct ftrace_data_offsets_##call *__data_offsets, proto) \
383 int __data_size = 0; \
384 int __maybe_unused __item_length; \
385 struct ftrace_raw_##call __maybe_unused *entry; \
389 return __data_size; \
393 #define DEFINE_EVENT(template, name, proto, args)
395 #undef DEFINE_EVENT_PRINT
396 #define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
397 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
399 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
402 * Stage 4 of the trace events.
404 * Override the macros in <trace/trace_events.h> to include the following:
406 * For those macros defined with TRACE_EVENT:
408 * static struct ftrace_event_call event_<call>;
410 * static void ftrace_raw_event_<call>(void *__data, proto)
412 * struct ftrace_event_file *ftrace_file = __data;
413 * struct ftrace_event_call *event_call = ftrace_file->event_call;
414 * struct ftrace_data_offsets_<call> __maybe_unused __data_offsets;
415 * unsigned long eflags = ftrace_file->flags;
416 * enum event_trigger_type __tt = ETT_NONE;
417 * struct ring_buffer_event *event;
418 * struct ftrace_raw_<call> *entry; <-- defined in stage 1
419 * struct ring_buffer *buffer;
420 * unsigned long irq_flags;
424 * if (!(eflags & FTRACE_EVENT_FL_TRIGGER_COND)) {
425 * if (eflags & FTRACE_EVENT_FL_TRIGGER_MODE)
426 * event_triggers_call(ftrace_file, NULL);
427 * if (eflags & FTRACE_EVENT_FL_SOFT_DISABLED)
431 * local_save_flags(irq_flags);
432 * pc = preempt_count();
434 * __data_size = ftrace_get_offsets_<call>(&__data_offsets, args);
436 * event = trace_event_buffer_lock_reserve(&buffer, ftrace_file,
437 * event_<call>->event.type,
438 * sizeof(*entry) + __data_size,
442 * entry = ring_buffer_event_data(event);
444 * { <assign>; } <-- Here we assign the entries by the __field and
447 * if (eflags & FTRACE_EVENT_FL_TRIGGER_COND)
448 * __tt = event_triggers_call(ftrace_file, entry);
450 * if (test_bit(FTRACE_EVENT_FL_SOFT_DISABLED_BIT,
451 * &ftrace_file->flags))
452 * ring_buffer_discard_commit(buffer, event);
453 * else if (!filter_check_discard(ftrace_file, entry, buffer, event))
454 * trace_buffer_unlock_commit(buffer, event, irq_flags, pc);
457 * event_triggers_post_call(ftrace_file, __tt);
460 * static struct trace_event ftrace_event_type_<call> = {
461 * .trace = ftrace_raw_output_<call>, <-- stage 2
464 * static const char print_fmt_<call>[] = <TP_printk>;
466 * static struct ftrace_event_class __used event_class_<template> = {
467 * .system = "<system>",
468 * .define_fields = ftrace_define_fields_<call>,
469 * .fields = LIST_HEAD_INIT(event_class_##call.fields),
470 * .raw_init = trace_event_raw_init,
471 * .probe = ftrace_raw_event_##call,
472 * .reg = ftrace_event_reg,
475 * static struct ftrace_event_call event_<call> = {
477 * .class = event_class_<template>,
478 * .event = &ftrace_event_type_<call>,
479 * .print_fmt = print_fmt_<call>,
481 * // its only safe to use pointers when doing linker tricks to
482 * // create an array.
483 * static struct ftrace_event_call __used
484 * __attribute__((section("_ftrace_events"))) *__event_<call> = &event_<call>;
488 #ifdef CONFIG_PERF_EVENTS
490 #define _TRACE_PERF_PROTO(call, proto) \
491 static notrace void \
492 perf_trace_##call(void *__data, proto);
494 #define _TRACE_PERF_INIT(call) \
495 .perf_probe = perf_trace_##call,
498 #define _TRACE_PERF_PROTO(call, proto)
499 #define _TRACE_PERF_INIT(call)
500 #endif /* CONFIG_PERF_EVENTS */
503 #define __entry entry
506 #define __field(type, item)
509 #define __array(type, item, len)
511 #undef __dynamic_array
512 #define __dynamic_array(type, item, len) \
513 __entry->__data_loc_##item = __data_offsets.item;
516 #define __string(item, src) __dynamic_array(char, item, -1) \
519 #define __assign_str(dst, src) \
520 strcpy(__get_str(dst), (src) ? (const char *)(src) : "(null)");
522 #undef TP_fast_assign
523 #define TP_fast_assign(args...) args
526 #define __perf_addr(a) (a)
529 #define __perf_count(c) (c)
532 #define __perf_task(t) (t)
534 #undef DECLARE_EVENT_CLASS
535 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
537 static notrace void \
538 ftrace_raw_event_##call(void *__data, proto) \
540 struct ftrace_event_file *ftrace_file = __data; \
541 struct ftrace_data_offsets_##call __maybe_unused __data_offsets;\
542 struct ftrace_event_buffer fbuffer; \
543 struct ftrace_raw_##call *entry; \
546 if (ftrace_trigger_soft_disabled(ftrace_file)) \
549 __data_size = ftrace_get_offsets_##call(&__data_offsets, args); \
551 entry = ftrace_event_buffer_reserve(&fbuffer, ftrace_file, \
552 sizeof(*entry) + __data_size); \
561 ftrace_event_buffer_commit(&fbuffer); \
564 * The ftrace_test_probe is compiled out, it is only here as a build time check
565 * to make sure that if the tracepoint handling changes, the ftrace probe will
566 * fail to compile unless it too is updated.
570 #define DEFINE_EVENT(template, call, proto, args) \
571 static inline void ftrace_test_probe_##call(void) \
573 check_trace_callback_type_##call(ftrace_raw_event_##template); \
576 #undef DEFINE_EVENT_PRINT
577 #define DEFINE_EVENT_PRINT(template, name, proto, args, print)
579 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
585 #undef __print_symbolic
587 #undef __get_dynamic_array
591 #define TP_printk(fmt, args...) "\"" fmt "\", " __stringify(args)
593 #undef DECLARE_EVENT_CLASS
594 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
595 _TRACE_PERF_PROTO(call, PARAMS(proto)); \
596 static const char print_fmt_##call[] = print; \
597 static struct ftrace_event_class __used __refdata event_class_##call = { \
598 .system = __stringify(TRACE_SYSTEM), \
599 .define_fields = ftrace_define_fields_##call, \
600 .fields = LIST_HEAD_INIT(event_class_##call.fields),\
601 .raw_init = trace_event_raw_init, \
602 .probe = ftrace_raw_event_##call, \
603 .reg = ftrace_event_reg, \
604 _TRACE_PERF_INIT(call) \
608 #define DEFINE_EVENT(template, call, proto, args) \
610 static struct ftrace_event_call __used event_##call = { \
612 .class = &event_class_##template, \
613 .event.funcs = &ftrace_event_type_funcs_##template, \
614 .print_fmt = print_fmt_##template, \
616 static struct ftrace_event_call __used \
617 __attribute__((section("_ftrace_events"))) *__event_##call = &event_##call
619 #undef DEFINE_EVENT_PRINT
620 #define DEFINE_EVENT_PRINT(template, call, proto, args, print) \
622 static const char print_fmt_##call[] = print; \
624 static struct ftrace_event_call __used event_##call = { \
626 .class = &event_class_##template, \
627 .event.funcs = &ftrace_event_type_funcs_##call, \
628 .print_fmt = print_fmt_##call, \
630 static struct ftrace_event_call __used \
631 __attribute__((section("_ftrace_events"))) *__event_##call = &event_##call
633 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
636 #ifdef CONFIG_PERF_EVENTS
639 #define __entry entry
641 #undef __get_dynamic_array
642 #define __get_dynamic_array(field) \
643 ((void *)__entry + (__entry->__data_loc_##field & 0xffff))
646 #define __get_str(field) (char *)__get_dynamic_array(field)
649 #define __perf_addr(a) (__addr = (a))
652 #define __perf_count(c) (__count = (c))
655 #define __perf_task(t) (__task = (t))
657 #undef DECLARE_EVENT_CLASS
658 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
659 static notrace void \
660 perf_trace_##call(void *__data, proto) \
662 struct ftrace_event_call *event_call = __data; \
663 struct ftrace_data_offsets_##call __maybe_unused __data_offsets;\
664 struct ftrace_raw_##call *entry; \
665 struct pt_regs __regs; \
666 u64 __addr = 0, __count = 1; \
667 struct task_struct *__task = NULL; \
668 struct hlist_head *head; \
673 __data_size = ftrace_get_offsets_##call(&__data_offsets, args); \
675 head = this_cpu_ptr(event_call->perf_events); \
676 if (__builtin_constant_p(!__task) && !__task && \
680 __entry_size = ALIGN(__data_size + sizeof(*entry) + sizeof(u32),\
682 __entry_size -= sizeof(u32); \
684 perf_fetch_caller_regs(&__regs); \
685 entry = perf_trace_buf_prepare(__entry_size, \
686 event_call->event.type, &__regs, &rctx); \
694 perf_trace_buf_submit(entry, __entry_size, rctx, __addr, \
695 __count, &__regs, head, __task); \
699 * This part is compiled out, it is only here as a build time check
700 * to make sure that if the tracepoint handling changes, the
701 * perf probe will fail to compile unless it too is updated.
704 #define DEFINE_EVENT(template, call, proto, args) \
705 static inline void perf_test_probe_##call(void) \
707 check_trace_callback_type_##call(perf_trace_##template); \
711 #undef DEFINE_EVENT_PRINT
712 #define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
713 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
715 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
716 #endif /* CONFIG_PERF_EVENTS */