]>
git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blob - include/trace/ftrace.h
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 ftrace_event_call *event; \
231 struct trace_seq *s = &iter->seq; \
232 struct ftrace_raw_##call *field; \
233 struct trace_entry *entry; \
234 struct trace_seq *p = &iter->tmp_seq; \
237 event = container_of(trace_event, struct ftrace_event_call, \
242 if (entry->type != event->event.type) { \
244 return TRACE_TYPE_UNHANDLED; \
247 field = (typeof(field))entry; \
250 ret = trace_seq_printf(s, "%s: ", event->name); \
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) \
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, strlen(src) + 1)
384 #undef DECLARE_EVENT_CLASS
385 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
386 static inline notrace int ftrace_get_offsets_##call( \
387 struct ftrace_data_offsets_##call *__data_offsets, proto) \
389 int __data_size = 0; \
390 struct ftrace_raw_##call __maybe_unused *entry; \
394 return __data_size; \
398 #define DEFINE_EVENT(template, name, proto, args)
400 #undef DEFINE_EVENT_PRINT
401 #define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
402 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
404 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
407 * Stage 4 of the trace events.
409 * Override the macros in <trace/trace_events.h> to include the following:
411 * For those macros defined with TRACE_EVENT:
413 * static struct ftrace_event_call event_<call>;
415 * static void ftrace_raw_event_<call>(void *__data, proto)
417 * struct ftrace_event_call *event_call = __data;
418 * struct ftrace_data_offsets_<call> __maybe_unused __data_offsets;
419 * struct ring_buffer_event *event;
420 * struct ftrace_raw_<call> *entry; <-- defined in stage 1
421 * struct ring_buffer *buffer;
422 * unsigned long irq_flags;
426 * local_save_flags(irq_flags);
427 * pc = preempt_count();
429 * __data_size = ftrace_get_offsets_<call>(&__data_offsets, args);
431 * event = trace_current_buffer_lock_reserve(&buffer,
432 * event_<call>->event.type,
433 * sizeof(*entry) + __data_size,
437 * entry = ring_buffer_event_data(event);
439 * { <assign>; } <-- Here we assign the entries by the __field and
442 * if (!filter_current_check_discard(buffer, event_call, entry, event))
443 * trace_current_buffer_unlock_commit(buffer,
444 * event, irq_flags, pc);
447 * static struct trace_event ftrace_event_type_<call> = {
448 * .trace = ftrace_raw_output_<call>, <-- stage 2
451 * static const char print_fmt_<call>[] = <TP_printk>;
453 * static struct ftrace_event_class __used event_class_<template> = {
454 * .system = "<system>",
455 * .define_fields = ftrace_define_fields_<call>,
456 * .fields = LIST_HEAD_INIT(event_class_##call.fields),
457 * .raw_init = trace_event_raw_init,
458 * .probe = ftrace_raw_event_##call,
459 * .reg = ftrace_event_reg,
462 * static struct ftrace_event_call event_<call> = {
464 * .class = event_class_<template>,
465 * .event = &ftrace_event_type_<call>,
466 * .print_fmt = print_fmt_<call>,
468 * // its only safe to use pointers when doing linker tricks to
469 * // create an array.
470 * static struct ftrace_event_call __used
471 * __attribute__((section("_ftrace_events"))) *__event_<call> = &event_<call>;
475 #ifdef CONFIG_PERF_EVENTS
477 #define _TRACE_PERF_PROTO(call, proto) \
478 static notrace void \
479 perf_trace_##call(void *__data, proto);
481 #define _TRACE_PERF_INIT(call) \
482 .perf_probe = perf_trace_##call,
485 #define _TRACE_PERF_PROTO(call, proto)
486 #define _TRACE_PERF_INIT(call)
487 #endif /* CONFIG_PERF_EVENTS */
490 #define __entry entry
493 #define __field(type, item)
496 #define __array(type, item, len)
498 #undef __dynamic_array
499 #define __dynamic_array(type, item, len) \
500 __entry->__data_loc_##item = __data_offsets.item;
503 #define __string(item, src) __dynamic_array(char, item, -1) \
506 #define __assign_str(dst, src) \
507 strcpy(__get_str(dst), src);
509 #undef TP_fast_assign
510 #define TP_fast_assign(args...) args
512 #undef TP_perf_assign
513 #define TP_perf_assign(args...)
515 #undef DECLARE_EVENT_CLASS
516 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
518 static notrace void \
519 ftrace_raw_event_##call(void *__data, proto) \
521 struct ftrace_event_call *event_call = __data; \
522 struct ftrace_data_offsets_##call __maybe_unused __data_offsets;\
523 struct ring_buffer_event *event; \
524 struct ftrace_raw_##call *entry; \
525 struct ring_buffer *buffer; \
526 unsigned long irq_flags; \
530 local_save_flags(irq_flags); \
531 pc = preempt_count(); \
533 __data_size = ftrace_get_offsets_##call(&__data_offsets, args); \
535 event = trace_current_buffer_lock_reserve(&buffer, \
536 event_call->event.type, \
537 sizeof(*entry) + __data_size, \
541 entry = ring_buffer_event_data(event); \
547 if (!filter_current_check_discard(buffer, event_call, entry, event)) \
548 trace_nowake_buffer_unlock_commit(buffer, \
549 event, irq_flags, pc); \
552 * The ftrace_test_probe is compiled out, it is only here as a build time check
553 * to make sure that if the tracepoint handling changes, the ftrace probe will
554 * fail to compile unless it too is updated.
558 #define DEFINE_EVENT(template, call, proto, args) \
559 static inline void ftrace_test_probe_##call(void) \
561 check_trace_callback_type_##call(ftrace_raw_event_##template); \
564 #undef DEFINE_EVENT_PRINT
565 #define DEFINE_EVENT_PRINT(template, name, proto, args, print)
567 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
573 #undef __print_symbolic
574 #undef __get_dynamic_array
578 #define TP_printk(fmt, args...) "\"" fmt "\", " __stringify(args)
580 #undef DECLARE_EVENT_CLASS
581 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
582 _TRACE_PERF_PROTO(call, PARAMS(proto)); \
583 static const char print_fmt_##call[] = print; \
584 static struct ftrace_event_class __used event_class_##call = { \
585 .system = __stringify(TRACE_SYSTEM), \
586 .define_fields = ftrace_define_fields_##call, \
587 .fields = LIST_HEAD_INIT(event_class_##call.fields),\
588 .raw_init = trace_event_raw_init, \
589 .probe = ftrace_raw_event_##call, \
590 .reg = ftrace_event_reg, \
591 _TRACE_PERF_INIT(call) \
595 #define DEFINE_EVENT(template, call, proto, args) \
597 static struct ftrace_event_call __used event_##call = { \
599 .class = &event_class_##template, \
600 .event.funcs = &ftrace_event_type_funcs_##template, \
601 .print_fmt = print_fmt_##template, \
603 static struct ftrace_event_call __used \
604 __attribute__((section("_ftrace_events"))) *__event_##call = &event_##call
606 #undef DEFINE_EVENT_PRINT
607 #define DEFINE_EVENT_PRINT(template, call, proto, args, print) \
609 static const char print_fmt_##call[] = print; \
611 static struct ftrace_event_call __used event_##call = { \
613 .class = &event_class_##template, \
614 .event.funcs = &ftrace_event_type_funcs_##call, \
615 .print_fmt = print_fmt_##call, \
617 static struct ftrace_event_call __used \
618 __attribute__((section("_ftrace_events"))) *__event_##call = &event_##call
620 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
623 * Define the insertion callback to perf events
625 * The job is very similar to ftrace_raw_event_<call> except that we don't
626 * insert in the ring buffer but in a perf counter.
628 * static void ftrace_perf_<call>(proto)
630 * struct ftrace_data_offsets_<call> __maybe_unused __data_offsets;
631 * struct ftrace_event_call *event_call = &event_<call>;
632 * extern void perf_tp_event(int, u64, u64, void *, int);
633 * struct ftrace_raw_##call *entry;
634 * struct perf_trace_buf *trace_buf;
635 * u64 __addr = 0, __count = 1;
636 * unsigned long irq_flags;
637 * struct trace_entry *ent;
643 * pc = preempt_count();
645 * __data_size = ftrace_get_offsets_<call>(&__data_offsets, args);
647 * // Below we want to get the aligned size by taking into account
648 * // the u32 field that will later store the buffer size
649 * __entry_size = ALIGN(__data_size + sizeof(*entry) + sizeof(u32),
651 * __entry_size -= sizeof(u32);
653 * // Protect the non nmi buffer
654 * // This also protects the rcu read side
655 * local_irq_save(irq_flags);
656 * __cpu = smp_processor_id();
659 * trace_buf = rcu_dereference_sched(perf_trace_buf_nmi);
661 * trace_buf = rcu_dereference_sched(perf_trace_buf);
666 * trace_buf = per_cpu_ptr(trace_buf, __cpu);
668 * // Avoid recursion from perf that could mess up the buffer
669 * if (trace_buf->recursion++)
670 * goto end_recursion;
672 * raw_data = trace_buf->buf;
674 * // Make recursion update visible before entering perf_tp_event
675 * // so that we protect from perf recursions.
679 * //zero dead bytes from alignment to avoid stack leak to userspace:
680 * *(u64 *)(&raw_data[__entry_size - sizeof(u64)]) = 0ULL;
681 * entry = (struct ftrace_raw_<call> *)raw_data;
683 * tracing_generic_entry_update(ent, irq_flags, pc);
684 * ent->type = event_call->id;
686 * <tstruct> <- do some jobs with dynamic arrays
688 * <assign> <- affect our values
690 * perf_tp_event(event_call->id, __addr, __count, entry,
691 * __entry_size); <- submit them to perf counter
696 #ifdef CONFIG_PERF_EVENTS
699 #define __entry entry
701 #undef __get_dynamic_array
702 #define __get_dynamic_array(field) \
703 ((void *)__entry + (__entry->__data_loc_##field & 0xffff))
706 #define __get_str(field) (char *)__get_dynamic_array(field)
709 #define __perf_addr(a) __addr = (a)
712 #define __perf_count(c) __count = (c)
714 #undef TP_perf_assign
715 #define TP_perf_assign(args...) args
717 #undef DECLARE_EVENT_CLASS
718 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
719 static notrace void \
720 perf_trace_##call(void *__data, proto) \
722 struct ftrace_event_call *event_call = __data; \
723 struct ftrace_data_offsets_##call __maybe_unused __data_offsets;\
724 struct ftrace_raw_##call *entry; \
725 struct pt_regs __regs; \
726 u64 __addr = 0, __count = 1; \
727 struct hlist_head *head; \
732 perf_fetch_caller_regs(&__regs); \
734 __data_size = ftrace_get_offsets_##call(&__data_offsets, args); \
735 __entry_size = ALIGN(__data_size + sizeof(*entry) + sizeof(u32),\
737 __entry_size -= sizeof(u32); \
739 if (WARN_ONCE(__entry_size > PERF_MAX_TRACE_SIZE, \
740 "profile buffer not large enough")) \
743 entry = (struct ftrace_raw_##call *)perf_trace_buf_prepare( \
744 __entry_size, event_call->event.type, &__regs, &rctx); \
752 head = this_cpu_ptr(event_call->perf_events); \
753 perf_trace_buf_submit(entry, __entry_size, rctx, __addr, \
754 __count, &__regs, head); \
758 * This part is compiled out, it is only here as a build time check
759 * to make sure that if the tracepoint handling changes, the
760 * perf probe will fail to compile unless it too is updated.
763 #define DEFINE_EVENT(template, call, proto, args) \
764 static inline void perf_test_probe_##call(void) \
766 check_trace_callback_type_##call(perf_trace_##template); \
770 #undef DEFINE_EVENT_PRINT
771 #define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
772 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
774 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
775 #endif /* CONFIG_PERF_EVENTS */
777 #undef _TRACE_PROFILE_INIT