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_current_check_discard(buffer, event_call, entry, event))
441 * trace_nowake_buffer_unlock_commit(buffer,
442 * event, irq_flags, pc);
445 * static struct trace_event ftrace_event_type_<call> = {
446 * .trace = ftrace_raw_output_<call>, <-- stage 2
449 * static const char print_fmt_<call>[] = <TP_printk>;
451 * static struct ftrace_event_class __used event_class_<template> = {
452 * .system = "<system>",
453 * .define_fields = ftrace_define_fields_<call>,
454 * .fields = LIST_HEAD_INIT(event_class_##call.fields),
455 * .raw_init = trace_event_raw_init,
456 * .probe = ftrace_raw_event_##call,
457 * .reg = ftrace_event_reg,
460 * static struct ftrace_event_call event_<call> = {
462 * .class = event_class_<template>,
463 * .event = &ftrace_event_type_<call>,
464 * .print_fmt = print_fmt_<call>,
466 * // its only safe to use pointers when doing linker tricks to
467 * // create an array.
468 * static struct ftrace_event_call __used
469 * __attribute__((section("_ftrace_events"))) *__event_<call> = &event_<call>;
473 #ifdef CONFIG_PERF_EVENTS
475 #define _TRACE_PERF_PROTO(call, proto) \
476 static notrace void \
477 perf_trace_##call(void *__data, proto);
479 #define _TRACE_PERF_INIT(call) \
480 .perf_probe = perf_trace_##call,
483 #define _TRACE_PERF_PROTO(call, proto)
484 #define _TRACE_PERF_INIT(call)
485 #endif /* CONFIG_PERF_EVENTS */
488 #define __entry entry
491 #define __field(type, item)
494 #define __array(type, item, len)
496 #undef __dynamic_array
497 #define __dynamic_array(type, item, len) \
498 __entry->__data_loc_##item = __data_offsets.item;
501 #define __string(item, src) __dynamic_array(char, item, -1) \
504 #define __assign_str(dst, src) \
505 strcpy(__get_str(dst), src);
507 #undef TP_fast_assign
508 #define TP_fast_assign(args...) args
511 #define __perf_addr(a) (a)
514 #define __perf_count(c) (c)
517 #define __perf_task(t) (t)
519 #undef DECLARE_EVENT_CLASS
520 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
522 static notrace void \
523 ftrace_raw_event_##call(void *__data, proto) \
525 struct ftrace_event_file *ftrace_file = __data; \
526 struct ftrace_event_call *event_call = ftrace_file->event_call; \
527 struct ftrace_data_offsets_##call __maybe_unused __data_offsets;\
528 struct ring_buffer_event *event; \
529 struct ftrace_raw_##call *entry; \
530 struct ring_buffer *buffer; \
531 unsigned long irq_flags; \
535 if (test_bit(FTRACE_EVENT_FL_SOFT_DISABLED_BIT, \
536 &ftrace_file->flags)) \
539 local_save_flags(irq_flags); \
540 pc = preempt_count(); \
542 __data_size = ftrace_get_offsets_##call(&__data_offsets, args); \
544 event = trace_event_buffer_lock_reserve(&buffer, ftrace_file, \
545 event_call->event.type, \
546 sizeof(*entry) + __data_size, \
550 entry = ring_buffer_event_data(event); \
556 if (!filter_current_check_discard(buffer, event_call, entry, event)) \
557 trace_buffer_unlock_commit(buffer, event, irq_flags, pc); \
560 * The ftrace_test_probe is compiled out, it is only here as a build time check
561 * to make sure that if the tracepoint handling changes, the ftrace probe will
562 * fail to compile unless it too is updated.
566 #define DEFINE_EVENT(template, call, proto, args) \
567 static inline void ftrace_test_probe_##call(void) \
569 check_trace_callback_type_##call(ftrace_raw_event_##template); \
572 #undef DEFINE_EVENT_PRINT
573 #define DEFINE_EVENT_PRINT(template, name, proto, args, print)
575 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
581 #undef __print_symbolic
583 #undef __get_dynamic_array
587 #define TP_printk(fmt, args...) "\"" fmt "\", " __stringify(args)
589 #undef DECLARE_EVENT_CLASS
590 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
591 _TRACE_PERF_PROTO(call, PARAMS(proto)); \
592 static const char print_fmt_##call[] = print; \
593 static struct ftrace_event_class __used __refdata event_class_##call = { \
594 .system = __stringify(TRACE_SYSTEM), \
595 .define_fields = ftrace_define_fields_##call, \
596 .fields = LIST_HEAD_INIT(event_class_##call.fields),\
597 .raw_init = trace_event_raw_init, \
598 .probe = ftrace_raw_event_##call, \
599 .reg = ftrace_event_reg, \
600 _TRACE_PERF_INIT(call) \
604 #define DEFINE_EVENT(template, call, proto, args) \
606 static struct ftrace_event_call __used event_##call = { \
608 .class = &event_class_##template, \
609 .event.funcs = &ftrace_event_type_funcs_##template, \
610 .print_fmt = print_fmt_##template, \
612 static struct ftrace_event_call __used \
613 __attribute__((section("_ftrace_events"))) *__event_##call = &event_##call
615 #undef DEFINE_EVENT_PRINT
616 #define DEFINE_EVENT_PRINT(template, call, proto, args, print) \
618 static const char print_fmt_##call[] = print; \
620 static struct ftrace_event_call __used event_##call = { \
622 .class = &event_class_##template, \
623 .event.funcs = &ftrace_event_type_funcs_##call, \
624 .print_fmt = print_fmt_##call, \
626 static struct ftrace_event_call __used \
627 __attribute__((section("_ftrace_events"))) *__event_##call = &event_##call
629 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
632 #ifdef CONFIG_PERF_EVENTS
635 #define __entry entry
637 #undef __get_dynamic_array
638 #define __get_dynamic_array(field) \
639 ((void *)__entry + (__entry->__data_loc_##field & 0xffff))
642 #define __get_str(field) (char *)__get_dynamic_array(field)
645 #define __perf_addr(a) (__addr = (a))
648 #define __perf_count(c) (__count = (c))
651 #define __perf_task(t) (__task = (t))
653 #undef DECLARE_EVENT_CLASS
654 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
655 static notrace void \
656 perf_trace_##call(void *__data, proto) \
658 struct ftrace_event_call *event_call = __data; \
659 struct ftrace_data_offsets_##call __maybe_unused __data_offsets;\
660 struct ftrace_raw_##call *entry; \
661 struct pt_regs __regs; \
662 u64 __addr = 0, __count = 1; \
663 struct task_struct *__task = NULL; \
664 struct hlist_head *head; \
669 __data_size = ftrace_get_offsets_##call(&__data_offsets, args); \
671 head = this_cpu_ptr(event_call->perf_events); \
672 if (__builtin_constant_p(!__task) && !__task && \
676 __entry_size = ALIGN(__data_size + sizeof(*entry) + sizeof(u32),\
678 __entry_size -= sizeof(u32); \
680 perf_fetch_caller_regs(&__regs); \
681 entry = perf_trace_buf_prepare(__entry_size, \
682 event_call->event.type, &__regs, &rctx); \
690 perf_trace_buf_submit(entry, __entry_size, rctx, __addr, \
691 __count, &__regs, head, __task); \
695 * This part is compiled out, it is only here as a build time check
696 * to make sure that if the tracepoint handling changes, the
697 * perf probe will fail to compile unless it too is updated.
700 #define DEFINE_EVENT(template, call, proto, args) \
701 static inline void perf_test_probe_##call(void) \
703 check_trace_callback_type_##call(perf_trace_##template); \
707 #undef DEFINE_EVENT_PRINT
708 #define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
709 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
711 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
712 #endif /* CONFIG_PERF_EVENTS */
This page took 0.044053 seconds and 5 git commands to generate.