]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - include/trace/ftrace.h
perf: Fix inconsistency between IP and callchain sampling
[mirror_ubuntu-artful-kernel.git] / include / trace / ftrace.h
CommitLineData
f42c85e7
SR
1/*
2 * Stage 1 of the trace events.
3 *
4 * Override the macros in <trace/trace_events.h> to include the following:
5 *
6 * struct ftrace_raw_<call> {
7 * struct trace_entry ent;
8 * <type> <item>;
9 * <type2> <item2>[<len>];
10 * [...]
11 * };
12 *
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
16 * in the structure.
17 */
18
19#include <linux/ftrace_event.h>
20
ff038f5c 21/*
091ad365 22 * DECLARE_EVENT_CLASS can be used to add a generic function
ff038f5c
SR
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
091ad365 26 * will map the DECLARE_EVENT_CLASS to the tracepoint.
ff038f5c
SR
27 *
28 * TRACE_EVENT is a one to one mapping between tracepoint and template.
29 */
30#undef TRACE_EVENT
31#define TRACE_EVENT(name, proto, args, tstruct, assign, print) \
091ad365 32 DECLARE_EVENT_CLASS(name, \
ff038f5c
SR
33 PARAMS(proto), \
34 PARAMS(args), \
35 PARAMS(tstruct), \
36 PARAMS(assign), \
37 PARAMS(print)); \
38 DEFINE_EVENT(name, name, PARAMS(proto), PARAMS(args));
39
40
7fcb7c47
LZ
41#undef __field
42#define __field(type, item) type item;
43
43b51ead
LZ
44#undef __field_ext
45#define __field_ext(type, item, filter_type) type item;
46
f42c85e7
SR
47#undef __array
48#define __array(type, item, len) type item[len];
49
7fcb7c47 50#undef __dynamic_array
7d536cb3 51#define __dynamic_array(type, item, len) u32 __data_loc_##item;
f42c85e7 52
9cbf1176 53#undef __string
7fcb7c47 54#define __string(item, src) __dynamic_array(char, item, -1)
9cbf1176 55
f42c85e7
SR
56#undef TP_STRUCT__entry
57#define TP_STRUCT__entry(args...) args
58
091ad365
IM
59#undef DECLARE_EVENT_CLASS
60#define DECLARE_EVENT_CLASS(name, proto, args, tstruct, assign, print) \
ff038f5c
SR
61 struct ftrace_raw_##name { \
62 struct trace_entry ent; \
63 tstruct \
64 char __data[0]; \
65 };
66#undef DEFINE_EVENT
67#define DEFINE_EVENT(template, name, proto, args) \
f42c85e7
SR
68 static struct ftrace_event_call event_##name
69
e5bc9721
SR
70#undef DEFINE_EVENT_PRINT
71#define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
72 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
73
0dd7b747
FW
74#undef __cpparg
75#define __cpparg(arg...) arg
76
97419875
JS
77/* Callbacks are meaningless to ftrace. */
78#undef TRACE_EVENT_FN
0dd7b747
FW
79#define TRACE_EVENT_FN(name, proto, args, tstruct, \
80 assign, print, reg, unreg) \
81 TRACE_EVENT(name, __cpparg(proto), __cpparg(args), \
82 __cpparg(tstruct), __cpparg(assign), __cpparg(print)) \
97419875 83
f42c85e7
SR
84#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
85
9cbf1176 86
f42c85e7
SR
87/*
88 * Stage 2 of the trace events.
89 *
9cbf1176
FW
90 * Include the following:
91 *
7fcb7c47 92 * struct ftrace_data_offsets_<call> {
7d536cb3
LZ
93 * u32 <item1>;
94 * u32 <item2>;
9cbf1176
FW
95 * [...]
96 * };
97 *
7d536cb3 98 * The __dynamic_array() macro will create each u32 <item>, this is
7fcb7c47 99 * to keep the offset of each array from the beginning of the event.
7d536cb3 100 * The size of an array is also encoded, in the higher 16 bits of <item>.
9cbf1176
FW
101 */
102
7fcb7c47 103#undef __field
43b51ead
LZ
104#define __field(type, item)
105
106#undef __field_ext
107#define __field_ext(type, item, filter_type)
7fcb7c47 108
9cbf1176
FW
109#undef __array
110#define __array(type, item, len)
111
7fcb7c47 112#undef __dynamic_array
7d536cb3 113#define __dynamic_array(type, item, len) u32 item;
9cbf1176
FW
114
115#undef __string
7fcb7c47 116#define __string(item, src) __dynamic_array(char, item, -1)
9cbf1176 117
091ad365
IM
118#undef DECLARE_EVENT_CLASS
119#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
7fcb7c47 120 struct ftrace_data_offsets_##call { \
9cbf1176
FW
121 tstruct; \
122 };
123
ff038f5c
SR
124#undef DEFINE_EVENT
125#define DEFINE_EVENT(template, name, proto, args)
126
e5bc9721
SR
127#undef DEFINE_EVENT_PRINT
128#define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
129 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
130
9cbf1176
FW
131#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
132
6ff9a64d
SR
133/*
134 * Setup the showing format of trace point.
135 *
136 * int
137 * ftrace_format_##call(struct trace_seq *s)
138 * {
139 * struct ftrace_raw_##call field;
140 * int ret;
141 *
142 * ret = trace_seq_printf(s, #type " " #item ";"
143 * " offset:%u; size:%u;\n",
144 * offsetof(struct ftrace_raw_##call, item),
145 * sizeof(field.type));
146 *
147 * }
148 */
149
150#undef TP_STRUCT__entry
151#define TP_STRUCT__entry(args...) args
152
153#undef __field
154#define __field(type, item) \
155 ret = trace_seq_printf(s, "\tfield:" #type " " #item ";\t" \
26a50744 156 "offset:%u;\tsize:%u;\tsigned:%u;\n", \
6ff9a64d 157 (unsigned int)offsetof(typeof(field), item), \
26a50744
TZ
158 (unsigned int)sizeof(field.item), \
159 (unsigned int)is_signed_type(type)); \
6ff9a64d
SR
160 if (!ret) \
161 return 0;
162
43b51ead
LZ
163#undef __field_ext
164#define __field_ext(type, item, filter_type) __field(type, item)
165
6ff9a64d
SR
166#undef __array
167#define __array(type, item, len) \
168 ret = trace_seq_printf(s, "\tfield:" #type " " #item "[" #len "];\t" \
26a50744 169 "offset:%u;\tsize:%u;\tsigned:%u;\n", \
6ff9a64d 170 (unsigned int)offsetof(typeof(field), item), \
26a50744
TZ
171 (unsigned int)sizeof(field.item), \
172 (unsigned int)is_signed_type(type)); \
6ff9a64d
SR
173 if (!ret) \
174 return 0;
175
176#undef __dynamic_array
177#define __dynamic_array(type, item, len) \
68fd60a8 178 ret = trace_seq_printf(s, "\tfield:__data_loc " #type "[] " #item ";\t"\
26a50744 179 "offset:%u;\tsize:%u;\tsigned:%u;\n", \
6ff9a64d
SR
180 (unsigned int)offsetof(typeof(field), \
181 __data_loc_##item), \
26a50744
TZ
182 (unsigned int)sizeof(field.__data_loc_##item), \
183 (unsigned int)is_signed_type(type)); \
6ff9a64d
SR
184 if (!ret) \
185 return 0;
186
187#undef __string
188#define __string(item, src) __dynamic_array(char, item, -1)
189
190#undef __entry
191#define __entry REC
192
193#undef __print_symbolic
194#undef __get_dynamic_array
195#undef __get_str
196
197#undef TP_printk
811cb50b 198#define TP_printk(fmt, args...) "\"%s\", %s\n", fmt, __stringify(args)
6ff9a64d
SR
199
200#undef TP_fast_assign
201#define TP_fast_assign(args...) args
202
3a659305
PZ
203#undef TP_perf_assign
204#define TP_perf_assign(args...)
205
091ad365
IM
206#undef DECLARE_EVENT_CLASS
207#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, func, print) \
6ff9a64d 208static int \
e5bc9721
SR
209ftrace_format_setup_##call(struct ftrace_event_call *unused, \
210 struct trace_seq *s) \
6ff9a64d
SR
211{ \
212 struct ftrace_raw_##call field __attribute__((unused)); \
213 int ret = 0; \
214 \
215 tstruct; \
216 \
e5bc9721
SR
217 return ret; \
218} \
219 \
220static int \
221ftrace_format_##call(struct ftrace_event_call *unused, \
222 struct trace_seq *s) \
223{ \
224 int ret = 0; \
225 \
226 ret = ftrace_format_setup_##call(unused, s); \
227 if (!ret) \
228 return ret; \
229 \
230 ret = trace_seq_printf(s, "\nprint fmt: " print); \
6ff9a64d
SR
231 \
232 return ret; \
233}
234
ff038f5c
SR
235#undef DEFINE_EVENT
236#define DEFINE_EVENT(template, name, proto, args)
237
e5bc9721
SR
238#undef DEFINE_EVENT_PRINT
239#define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
240static int \
241ftrace_format_##name(struct ftrace_event_call *unused, \
242 struct trace_seq *s) \
243{ \
244 int ret = 0; \
245 \
246 ret = ftrace_format_setup_##template(unused, s); \
247 if (!ret) \
248 return ret; \
249 \
6ff9a64d
SR
250 trace_seq_printf(s, "\nprint fmt: " print); \
251 \
252 return ret; \
253}
254
255#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
256
9cbf1176
FW
257/*
258 * Stage 3 of the trace events.
259 *
f42c85e7
SR
260 * Override the macros in <trace/trace_events.h> to include the following:
261 *
262 * enum print_line_t
263 * ftrace_raw_output_<call>(struct trace_iterator *iter, int flags)
264 * {
265 * struct trace_seq *s = &iter->seq;
266 * struct ftrace_raw_<call> *field; <-- defined in stage 1
267 * struct trace_entry *entry;
be74b73a 268 * struct trace_seq *p;
f42c85e7
SR
269 * int ret;
270 *
271 * entry = iter->ent;
272 *
273 * if (entry->type != event_<call>.id) {
274 * WARN_ON_ONCE(1);
275 * return TRACE_TYPE_UNHANDLED;
276 * }
277 *
278 * field = (typeof(field))entry;
279 *
be74b73a 280 * p = get_cpu_var(ftrace_event_seq);
56d8bd3f 281 * trace_seq_init(p);
f42c85e7 282 * ret = trace_seq_printf(s, <TP_printk> "\n");
be74b73a 283 * put_cpu();
f42c85e7
SR
284 * if (!ret)
285 * return TRACE_TYPE_PARTIAL_LINE;
286 *
287 * return TRACE_TYPE_HANDLED;
288 * }
289 *
290 * This is the method used to print the raw event to the trace
291 * output format. Note, this is not needed if the data is read
292 * in binary.
293 */
294
295#undef __entry
296#define __entry field
297
298#undef TP_printk
299#define TP_printk(fmt, args...) fmt "\n", args
300
7fcb7c47
LZ
301#undef __get_dynamic_array
302#define __get_dynamic_array(field) \
7d536cb3 303 ((void *)__entry + (__entry->__data_loc_##field & 0xffff))
7fcb7c47 304
9cbf1176 305#undef __get_str
7fcb7c47 306#define __get_str(field) (char *)__get_dynamic_array(field)
9cbf1176 307
be74b73a
SR
308#undef __print_flags
309#define __print_flags(flag, delim, flag_array...) \
310 ({ \
a48f494e 311 static const struct trace_print_flags __flags[] = \
be74b73a 312 { flag_array, { -1, NULL }}; \
a48f494e 313 ftrace_print_flags_seq(p, delim, flag, __flags); \
be74b73a
SR
314 })
315
0f4fc29d
SR
316#undef __print_symbolic
317#define __print_symbolic(value, symbol_array...) \
318 ({ \
319 static const struct trace_print_flags symbols[] = \
320 { symbol_array, { -1, NULL }}; \
321 ftrace_print_symbols_seq(p, value, symbols); \
322 })
323
091ad365
IM
324#undef DECLARE_EVENT_CLASS
325#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
ec827c7e 326static enum print_line_t \
ff038f5c
SR
327ftrace_raw_output_id_##call(int event_id, const char *name, \
328 struct trace_iterator *iter, int flags) \
f42c85e7
SR
329{ \
330 struct trace_seq *s = &iter->seq; \
331 struct ftrace_raw_##call *field; \
332 struct trace_entry *entry; \
be74b73a 333 struct trace_seq *p; \
f42c85e7
SR
334 int ret; \
335 \
336 entry = iter->ent; \
337 \
ff038f5c 338 if (entry->type != event_id) { \
f42c85e7
SR
339 WARN_ON_ONCE(1); \
340 return TRACE_TYPE_UNHANDLED; \
341 } \
342 \
343 field = (typeof(field))entry; \
344 \
be74b73a 345 p = &get_cpu_var(ftrace_event_seq); \
56d8bd3f 346 trace_seq_init(p); \
ff038f5c
SR
347 ret = trace_seq_printf(s, "%s: ", name); \
348 if (ret) \
349 ret = trace_seq_printf(s, print); \
be74b73a 350 put_cpu(); \
f42c85e7
SR
351 if (!ret) \
352 return TRACE_TYPE_PARTIAL_LINE; \
353 \
354 return TRACE_TYPE_HANDLED; \
355}
ff038f5c
SR
356
357#undef DEFINE_EVENT
358#define DEFINE_EVENT(template, name, proto, args) \
359static enum print_line_t \
360ftrace_raw_output_##name(struct trace_iterator *iter, int flags) \
361{ \
362 return ftrace_raw_output_id_##template(event_##name.id, \
363 #name, iter, flags); \
364}
365
e5bc9721
SR
366#undef DEFINE_EVENT_PRINT
367#define DEFINE_EVENT_PRINT(template, call, proto, args, print) \
368static enum print_line_t \
369ftrace_raw_output_##call(struct trace_iterator *iter, int flags) \
370{ \
371 struct trace_seq *s = &iter->seq; \
372 struct ftrace_raw_##template *field; \
373 struct trace_entry *entry; \
374 struct trace_seq *p; \
f42c85e7
SR
375 int ret; \
376 \
377 entry = iter->ent; \
378 \
379 if (entry->type != event_##call.id) { \
380 WARN_ON_ONCE(1); \
381 return TRACE_TYPE_UNHANDLED; \
382 } \
383 \
384 field = (typeof(field))entry; \
385 \
be74b73a 386 p = &get_cpu_var(ftrace_event_seq); \
56d8bd3f 387 trace_seq_init(p); \
e5bc9721
SR
388 ret = trace_seq_printf(s, "%s: ", #call); \
389 if (ret) \
390 ret = trace_seq_printf(s, print); \
be74b73a 391 put_cpu(); \
f42c85e7
SR
392 if (!ret) \
393 return TRACE_TYPE_PARTIAL_LINE; \
394 \
395 return TRACE_TYPE_HANDLED; \
396}
e5bc9721 397
f42c85e7
SR
398#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
399
43b51ead
LZ
400#undef __field_ext
401#define __field_ext(type, item, filter_type) \
f42c85e7
SR
402 ret = trace_define_field(event_call, #type, #item, \
403 offsetof(typeof(field), item), \
43b51ead
LZ
404 sizeof(field.item), \
405 is_signed_type(type), filter_type); \
f42c85e7
SR
406 if (ret) \
407 return ret;
408
43b51ead
LZ
409#undef __field
410#define __field(type, item) __field_ext(type, item, FILTER_OTHER)
411
f42c85e7
SR
412#undef __array
413#define __array(type, item, len) \
414 BUILD_BUG_ON(len > MAX_FILTER_STR_VAL); \
415 ret = trace_define_field(event_call, #type "[" #len "]", #item, \
416 offsetof(typeof(field), item), \
fb7ae981
LJ
417 sizeof(field.item), \
418 is_signed_type(type), FILTER_OTHER); \
f42c85e7
SR
419 if (ret) \
420 return ret;
421
7fcb7c47
LZ
422#undef __dynamic_array
423#define __dynamic_array(type, item, len) \
68fd60a8 424 ret = trace_define_field(event_call, "__data_loc " #type "[]", #item, \
43b51ead 425 offsetof(typeof(field), __data_loc_##item), \
fb7ae981
LJ
426 sizeof(field.__data_loc_##item), \
427 is_signed_type(type), FILTER_OTHER);
7fcb7c47 428
9cbf1176 429#undef __string
7fcb7c47 430#define __string(item, src) __dynamic_array(char, item, -1)
9cbf1176 431
091ad365
IM
432#undef DECLARE_EVENT_CLASS
433#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, func, print) \
ec827c7e 434static int \
14be96c9 435ftrace_define_fields_##call(struct ftrace_event_call *event_call) \
f42c85e7
SR
436{ \
437 struct ftrace_raw_##call field; \
f42c85e7
SR
438 int ret; \
439 \
f42c85e7
SR
440 tstruct; \
441 \
442 return ret; \
443}
444
ff038f5c
SR
445#undef DEFINE_EVENT
446#define DEFINE_EVENT(template, name, proto, args)
447
e5bc9721
SR
448#undef DEFINE_EVENT_PRINT
449#define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
450 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
451
f42c85e7
SR
452#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
453
7fcb7c47
LZ
454/*
455 * remember the offset of each array from the beginning of the event.
456 */
457
458#undef __entry
459#define __entry entry
460
461#undef __field
462#define __field(type, item)
463
43b51ead
LZ
464#undef __field_ext
465#define __field_ext(type, item, filter_type)
466
7fcb7c47
LZ
467#undef __array
468#define __array(type, item, len)
469
470#undef __dynamic_array
471#define __dynamic_array(type, item, len) \
472 __data_offsets->item = __data_size + \
473 offsetof(typeof(*entry), __data); \
7d536cb3 474 __data_offsets->item |= (len * sizeof(type)) << 16; \
7fcb7c47
LZ
475 __data_size += (len) * sizeof(type);
476
477#undef __string
ff038f5c 478#define __string(item, src) __dynamic_array(char, item, strlen(src) + 1)
7fcb7c47 479
091ad365
IM
480#undef DECLARE_EVENT_CLASS
481#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
7fcb7c47
LZ
482static inline int ftrace_get_offsets_##call( \
483 struct ftrace_data_offsets_##call *__data_offsets, proto) \
484{ \
485 int __data_size = 0; \
486 struct ftrace_raw_##call __maybe_unused *entry; \
487 \
488 tstruct; \
489 \
490 return __data_size; \
491}
492
ff038f5c
SR
493#undef DEFINE_EVENT
494#define DEFINE_EVENT(template, name, proto, args)
495
e5bc9721
SR
496#undef DEFINE_EVENT_PRINT
497#define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
498 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
499
7fcb7c47
LZ
500#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
501
07b139c8 502#ifdef CONFIG_PERF_EVENTS
3a659305
PZ
503
504/*
cdd6c482 505 * Generate the functions needed for tracepoint perf_event support.
3a659305 506 *
f413cdb8 507 * NOTE: The insertion profile callback (ftrace_profile_<call>) is defined later
3a659305 508 *
e5e25cf4 509 * static int ftrace_profile_enable_<call>(void)
3a659305 510 * {
e5e25cf4 511 * return register_trace_<call>(ftrace_profile_<call>);
3a659305
PZ
512 * }
513 *
e5e25cf4 514 * static void ftrace_profile_disable_<call>(void)
3a659305 515 * {
e5e25cf4 516 * unregister_trace_<call>(ftrace_profile_<call>);
3a659305
PZ
517 * }
518 *
519 */
520
091ad365
IM
521#undef DECLARE_EVENT_CLASS
522#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print)
ff038f5c
SR
523
524#undef DEFINE_EVENT
525#define DEFINE_EVENT(template, name, proto, args) \
3a659305 526 \
ff038f5c 527static void ftrace_profile_##name(proto); \
3a659305 528 \
ff038f5c 529static int ftrace_profile_enable_##name(struct ftrace_event_call *unused)\
3a659305 530{ \
ff038f5c 531 return register_trace_##name(ftrace_profile_##name); \
3a659305
PZ
532} \
533 \
ff038f5c 534static void ftrace_profile_disable_##name(struct ftrace_event_call *unused)\
3a659305 535{ \
ff038f5c 536 unregister_trace_##name(ftrace_profile_##name); \
3a659305
PZ
537}
538
e5bc9721
SR
539#undef DEFINE_EVENT_PRINT
540#define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
541 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
542
3a659305
PZ
543#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
544
07b139c8 545#endif /* CONFIG_PERF_EVENTS */
3a659305 546
c32e827b 547/*
9cbf1176 548 * Stage 4 of the trace events.
c32e827b 549 *
ea20d929 550 * Override the macros in <trace/trace_events.h> to include the following:
c32e827b
SR
551 *
552 * static void ftrace_event_<call>(proto)
553 * {
ef18012b 554 * event_trace_printk(_RET_IP_, "<call>: " <fmt>);
c32e827b
SR
555 * }
556 *
bd1a5c84 557 * static int ftrace_reg_event_<call>(struct ftrace_event_call *unused)
c32e827b 558 * {
3b8e4273 559 * return register_trace_<call>(ftrace_event_<call>);
c32e827b
SR
560 * }
561 *
bd1a5c84 562 * static void ftrace_unreg_event_<call>(struct ftrace_event_call *unused)
c32e827b 563 * {
ef18012b 564 * unregister_trace_<call>(ftrace_event_<call>);
c32e827b
SR
565 * }
566 *
c32e827b 567 *
157587d7 568 * For those macros defined with TRACE_EVENT:
c32e827b
SR
569 *
570 * static struct ftrace_event_call event_<call>;
571 *
572 * static void ftrace_raw_event_<call>(proto)
573 * {
ef18012b
SR
574 * struct ring_buffer_event *event;
575 * struct ftrace_raw_<call> *entry; <-- defined in stage 1
e77405ad 576 * struct ring_buffer *buffer;
ef18012b
SR
577 * unsigned long irq_flags;
578 * int pc;
579 *
580 * local_save_flags(irq_flags);
581 * pc = preempt_count();
582 *
e77405ad
SR
583 * event = trace_current_buffer_lock_reserve(&buffer,
584 * event_<call>.id,
ef18012b
SR
585 * sizeof(struct ftrace_raw_<call>),
586 * irq_flags, pc);
587 * if (!event)
588 * return;
589 * entry = ring_buffer_event_data(event);
590 *
591 * <assign>; <-- Here we assign the entries by the __field and
0e3d0f05 592 * __array macros.
c32e827b 593 *
e77405ad 594 * trace_current_buffer_unlock_commit(buffer, event, irq_flags, pc);
c32e827b
SR
595 * }
596 *
bd1a5c84 597 * static int ftrace_raw_reg_event_<call>(struct ftrace_event_call *unused)
c32e827b 598 * {
ef18012b 599 * int ret;
c32e827b 600 *
ef18012b
SR
601 * ret = register_trace_<call>(ftrace_raw_event_<call>);
602 * if (!ret)
603 * pr_info("event trace: Could not activate trace point "
604 * "probe to <call>");
605 * return ret;
c32e827b
SR
606 * }
607 *
bd1a5c84 608 * static void ftrace_unreg_event_<call>(struct ftrace_event_call *unused)
c32e827b 609 * {
ef18012b 610 * unregister_trace_<call>(ftrace_raw_event_<call>);
c32e827b
SR
611 * }
612 *
613 * static struct trace_event ftrace_event_type_<call> = {
ef18012b 614 * .trace = ftrace_raw_output_<call>, <-- stage 2
c32e827b
SR
615 * };
616 *
c32e827b
SR
617 * static struct ftrace_event_call __used
618 * __attribute__((__aligned__(4)))
619 * __attribute__((section("_ftrace_events"))) event_<call> = {
ef18012b 620 * .name = "<call>",
0e3d0f05 621 * .system = "<system>",
87d9b4e1 622 * .raw_init = trace_event_raw_init,
ef18012b
SR
623 * .regfunc = ftrace_reg_event_<call>,
624 * .unregfunc = ftrace_unreg_event_<call>,
981d081e 625 * .show_format = ftrace_format_<call>,
c32e827b
SR
626 * }
627 *
628 */
629
07b139c8 630#ifdef CONFIG_PERF_EVENTS
ac199db0
PZ
631
632#define _TRACE_PROFILE_INIT(call) \
ac199db0
PZ
633 .profile_enable = ftrace_profile_enable_##call, \
634 .profile_disable = ftrace_profile_disable_##call,
635
636#else
ac199db0 637#define _TRACE_PROFILE_INIT(call)
07b139c8 638#endif /* CONFIG_PERF_EVENTS */
ac199db0 639
da4d0302
SR
640#undef __entry
641#define __entry entry
d20e3b03 642
9cbf1176
FW
643#undef __field
644#define __field(type, item)
645
646#undef __array
647#define __array(type, item, len)
648
7fcb7c47
LZ
649#undef __dynamic_array
650#define __dynamic_array(type, item, len) \
651 __entry->__data_loc_##item = __data_offsets.item;
652
9cbf1176 653#undef __string
7fcb7c47 654#define __string(item, src) __dynamic_array(char, item, -1) \
9cbf1176
FW
655
656#undef __assign_str
657#define __assign_str(dst, src) \
9cbf1176
FW
658 strcpy(__get_str(dst), src);
659
091ad365
IM
660#undef DECLARE_EVENT_CLASS
661#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
c32e827b 662 \
ff038f5c
SR
663static void ftrace_raw_event_id_##call(struct ftrace_event_call *event_call, \
664 proto) \
c32e827b 665{ \
7fcb7c47 666 struct ftrace_data_offsets_##call __maybe_unused __data_offsets;\
c32e827b
SR
667 struct ring_buffer_event *event; \
668 struct ftrace_raw_##call *entry; \
e77405ad 669 struct ring_buffer *buffer; \
c32e827b 670 unsigned long irq_flags; \
7fcb7c47 671 int __data_size; \
c32e827b
SR
672 int pc; \
673 \
674 local_save_flags(irq_flags); \
675 pc = preempt_count(); \
676 \
7fcb7c47 677 __data_size = ftrace_get_offsets_##call(&__data_offsets, args); \
9cbf1176 678 \
e77405ad 679 event = trace_current_buffer_lock_reserve(&buffer, \
ff038f5c 680 event_call->id, \
7fcb7c47 681 sizeof(*entry) + __data_size, \
9cbf1176 682 irq_flags, pc); \
c32e827b
SR
683 if (!event) \
684 return; \
685 entry = ring_buffer_event_data(event); \
686 \
7fcb7c47
LZ
687 \
688 tstruct \
689 \
a9c1c3ab 690 { assign; } \
c32e827b 691 \
e77405ad
SR
692 if (!filter_current_check_discard(buffer, event_call, entry, event)) \
693 trace_nowake_buffer_unlock_commit(buffer, \
694 event, irq_flags, pc); \
ff038f5c
SR
695}
696
697#undef DEFINE_EVENT
698#define DEFINE_EVENT(template, call, proto, args) \
699 \
700static void ftrace_raw_event_##call(proto) \
701{ \
702 ftrace_raw_event_id_##template(&event_##call, args); \
c32e827b
SR
703} \
704 \
bd1a5c84 705static int ftrace_raw_reg_event_##call(struct ftrace_event_call *unused)\
c32e827b 706{ \
3b8e4273 707 return register_trace_##call(ftrace_raw_event_##call); \
c32e827b
SR
708} \
709 \
bd1a5c84 710static void ftrace_raw_unreg_event_##call(struct ftrace_event_call *unused)\
c32e827b
SR
711{ \
712 unregister_trace_##call(ftrace_raw_event_##call); \
713} \
714 \
715static struct trace_event ftrace_event_type_##call = { \
716 .trace = ftrace_raw_output_##call, \
87d9b4e1 717};
e5bc9721
SR
718
719#undef DEFINE_EVENT_PRINT
720#define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
721 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
722
723#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
724
091ad365
IM
725#undef DECLARE_EVENT_CLASS
726#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print)
e5bc9721
SR
727
728#undef DEFINE_EVENT
729#define DEFINE_EVENT(template, call, proto, args) \
c32e827b
SR
730 \
731static struct ftrace_event_call __used \
732__attribute__((__aligned__(4))) \
733__attribute__((section("_ftrace_events"))) event_##call = { \
ef18012b 734 .name = #call, \
9cc26a26 735 .system = __stringify(TRACE_SYSTEM), \
6d723736 736 .event = &ftrace_event_type_##call, \
87d9b4e1 737 .raw_init = trace_event_raw_init, \
da4d0302
SR
738 .regfunc = ftrace_raw_reg_event_##call, \
739 .unregfunc = ftrace_raw_unreg_event_##call, \
ff038f5c
SR
740 .show_format = ftrace_format_##template, \
741 .define_fields = ftrace_define_fields_##template, \
ac199db0 742 _TRACE_PROFILE_INIT(call) \
c32e827b 743}
ac199db0 744
e5bc9721
SR
745#undef DEFINE_EVENT_PRINT
746#define DEFINE_EVENT_PRINT(template, call, proto, args, print) \
c32e827b
SR
747 \
748static struct ftrace_event_call __used \
749__attribute__((__aligned__(4))) \
750__attribute__((section("_ftrace_events"))) event_##call = { \
ef18012b 751 .name = #call, \
9cc26a26 752 .system = __stringify(TRACE_SYSTEM), \
6d723736 753 .event = &ftrace_event_type_##call, \
87d9b4e1 754 .raw_init = trace_event_raw_init, \
da4d0302
SR
755 .regfunc = ftrace_raw_reg_event_##call, \
756 .unregfunc = ftrace_raw_unreg_event_##call, \
981d081e 757 .show_format = ftrace_format_##call, \
e5bc9721 758 .define_fields = ftrace_define_fields_##template, \
ac199db0 759 _TRACE_PROFILE_INIT(call) \
c32e827b 760}
ac199db0 761
f42c85e7 762#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
ac199db0 763
f413cdb8
FW
764/*
765 * Define the insertion callback to profile events
766 *
767 * The job is very similar to ftrace_raw_event_<call> except that we don't
768 * insert in the ring buffer but in a perf counter.
769 *
770 * static void ftrace_profile_<call>(proto)
771 * {
772 * struct ftrace_data_offsets_<call> __maybe_unused __data_offsets;
773 * struct ftrace_event_call *event_call = &event_<call>;
cdd6c482 774 * extern void perf_tp_event(int, u64, u64, void *, int);
f413cdb8 775 * struct ftrace_raw_##call *entry;
444a2a3b 776 * struct perf_trace_buf *trace_buf;
f413cdb8
FW
777 * u64 __addr = 0, __count = 1;
778 * unsigned long irq_flags;
20ab4425 779 * struct trace_entry *ent;
f413cdb8
FW
780 * int __entry_size;
781 * int __data_size;
20ab4425 782 * int __cpu
f413cdb8
FW
783 * int pc;
784 *
f413cdb8
FW
785 * pc = preempt_count();
786 *
787 * __data_size = ftrace_get_offsets_<call>(&__data_offsets, args);
304703ab
FW
788 *
789 * // Below we want to get the aligned size by taking into account
790 * // the u32 field that will later store the buffer size
791 * __entry_size = ALIGN(__data_size + sizeof(*entry) + sizeof(u32),
792 * sizeof(u64));
793 * __entry_size -= sizeof(u32);
f413cdb8 794 *
20ab4425
FW
795 * // Protect the non nmi buffer
796 * // This also protects the rcu read side
797 * local_irq_save(irq_flags);
798 * __cpu = smp_processor_id();
799 *
800 * if (in_nmi())
444a2a3b 801 * trace_buf = rcu_dereference(perf_trace_buf_nmi);
20ab4425 802 * else
444a2a3b 803 * trace_buf = rcu_dereference(perf_trace_buf);
20ab4425 804 *
444a2a3b 805 * if (!trace_buf)
20ab4425 806 * goto end;
f413cdb8 807 *
444a2a3b
FW
808 * trace_buf = per_cpu_ptr(trace_buf, __cpu);
809 *
810 * // Avoid recursion from perf that could mess up the buffer
811 * if (trace_buf->recursion++)
812 * goto end_recursion;
813 *
814 * raw_data = trace_buf->buf;
815 *
816 * // Make recursion update visible before entering perf_tp_event
817 * // so that we protect from perf recursions.
818 *
819 * barrier();
1853db0e 820 *
20ab4425
FW
821 * //zero dead bytes from alignment to avoid stack leak to userspace:
822 * *(u64 *)(&raw_data[__entry_size - sizeof(u64)]) = 0ULL;
823 * entry = (struct ftrace_raw_<call> *)raw_data;
824 * ent = &entry->ent;
825 * tracing_generic_entry_update(ent, irq_flags, pc);
826 * ent->type = event_call->id;
f413cdb8 827 *
20ab4425 828 * <tstruct> <- do some jobs with dynamic arrays
f413cdb8 829 *
20ab4425 830 * <assign> <- affect our values
f413cdb8 831 *
43c1266c 832 * perf_tp_event(event_call->id, __addr, __count, entry,
20ab4425 833 * __entry_size); <- submit them to perf counter
f413cdb8
FW
834 *
835 * }
836 */
837
07b139c8 838#ifdef CONFIG_PERF_EVENTS
f413cdb8
FW
839
840#undef __perf_addr
841#define __perf_addr(a) __addr = (a)
842
843#undef __perf_count
844#define __perf_count(c) __count = (c)
845
091ad365
IM
846#undef DECLARE_EVENT_CLASS
847#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
ff038f5c
SR
848static void \
849ftrace_profile_templ_##call(struct ftrace_event_call *event_call, \
850 proto) \
f413cdb8
FW
851{ \
852 struct ftrace_data_offsets_##call __maybe_unused __data_offsets;\
4ed7c92d
PZ
853 extern int perf_swevent_get_recursion_context(void); \
854 extern void perf_swevent_put_recursion_context(int rctx); \
444a2a3b 855 extern void perf_tp_event(int, u64, u64, void *, int); \
f413cdb8
FW
856 struct ftrace_raw_##call *entry; \
857 u64 __addr = 0, __count = 1; \
858 unsigned long irq_flags; \
20ab4425 859 struct trace_entry *ent; \
f413cdb8
FW
860 int __entry_size; \
861 int __data_size; \
ce71b9df 862 char *trace_buf; \
20ab4425
FW
863 char *raw_data; \
864 int __cpu; \
4ed7c92d 865 int rctx; \
f413cdb8
FW
866 int pc; \
867 \
f413cdb8
FW
868 pc = preempt_count(); \
869 \
870 __data_size = ftrace_get_offsets_##call(&__data_offsets, args); \
a044560c
PZ
871 __entry_size = ALIGN(__data_size + sizeof(*entry) + sizeof(u32),\
872 sizeof(u64)); \
304703ab 873 __entry_size -= sizeof(u32); \
f413cdb8 874 \
20ab4425
FW
875 if (WARN_ONCE(__entry_size > FTRACE_MAX_PROFILE_SIZE, \
876 "profile buffer not large enough")) \
877 return; \
878 \
879 local_irq_save(irq_flags); \
ce71b9df 880 \
4ed7c92d
PZ
881 rctx = perf_swevent_get_recursion_context(); \
882 if (rctx < 0) \
883 goto end_recursion; \
ce71b9df 884 \
20ab4425 885 __cpu = smp_processor_id(); \
f413cdb8 886 \
20ab4425 887 if (in_nmi()) \
444a2a3b 888 trace_buf = rcu_dereference(perf_trace_buf_nmi); \
20ab4425 889 else \
444a2a3b 890 trace_buf = rcu_dereference(perf_trace_buf); \
f413cdb8 891 \
444a2a3b 892 if (!trace_buf) \
20ab4425 893 goto end; \
f413cdb8 894 \
ce71b9df 895 raw_data = per_cpu_ptr(trace_buf, __cpu); \
f413cdb8 896 \
20ab4425
FW
897 *(u64 *)(&raw_data[__entry_size - sizeof(u64)]) = 0ULL; \
898 entry = (struct ftrace_raw_##call *)raw_data; \
899 ent = &entry->ent; \
900 tracing_generic_entry_update(ent, irq_flags, pc); \
901 ent->type = event_call->id; \
902 \
903 tstruct \
904 \
905 { assign; } \
906 \
43c1266c 907 perf_tp_event(event_call->id, __addr, __count, entry, \
f413cdb8 908 __entry_size); \
20ab4425
FW
909 \
910end: \
4ed7c92d
PZ
911 perf_swevent_put_recursion_context(rctx); \
912end_recursion: \
20ab4425 913 local_irq_restore(irq_flags); \
f413cdb8
FW
914}
915
ff038f5c
SR
916#undef DEFINE_EVENT
917#define DEFINE_EVENT(template, call, proto, args) \
918static void ftrace_profile_##call(proto) \
919{ \
920 struct ftrace_event_call *event_call = &event_##call; \
921 \
922 ftrace_profile_templ_##template(event_call, args); \
923}
924
e5bc9721
SR
925#undef DEFINE_EVENT_PRINT
926#define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
927 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
928
f413cdb8 929#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
07b139c8 930#endif /* CONFIG_PERF_EVENTS */
f413cdb8 931
ac199db0
PZ
932#undef _TRACE_PROFILE_INIT
933