]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blob - include/trace/ftrace.h
projects / mirror_ubuntu-jammy-kernel.git / blob
? search:


73523151a731f61598702d7ccd2ab51fefb39aa7
[mirror_ubuntu-jammy-kernel.git] / include / trace / ftrace.h
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
21 /*
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.
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) \
32 DECLARE_EVENT_CLASS(name, \
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
41 #undef __field
42 #define __field(type, item) type item;
43
44 #undef __field_ext
45 #define __field_ext(type, item, filter_type) type item;
46
47 #undef __array
48 #define __array(type, item, len) type item[len];
49
50 #undef __dynamic_array
51 #define __dynamic_array(type, item, len) u32 __data_loc_##item;
52
53 #undef __string
54 #define __string(item, src) __dynamic_array(char, item, -1)
55
56 #undef TP_STRUCT__entry
57 #define TP_STRUCT__entry(args...) args
58
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; \
63 tstruct \
64 char __data[0]; \
65 };
66 #undef DEFINE_EVENT
67 #define DEFINE_EVENT(template, name, proto, args) \
68 static struct ftrace_event_call event_##name
69
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
74 #undef __cpparg
75 #define __cpparg(arg...) arg
76
77 /* Callbacks are meaningless to ftrace. */
78 #undef TRACE_EVENT_FN
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)) \
83
84 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
85
86
87 /*
88 * Stage 2 of the trace events.
89 *
90 * Include the following:
91 *
92 * struct ftrace_data_offsets_<call> {
93 * u32 <item1>;
94 * u32 <item2>;
95 * [...]
96 * };
97 *
98 * The __dynamic_array() macro will create each u32 <item>, this is
99 * to keep the offset of each array from the beginning of the event.
100 * The size of an array is also encoded, in the higher 16 bits of <item>.
101 */
102
103 #undef __field
104 #define __field(type, item)
105
106 #undef __field_ext
107 #define __field_ext(type, item, filter_type)
108
109 #undef __array
110 #define __array(type, item, len)
111
112 #undef __dynamic_array
113 #define __dynamic_array(type, item, len) u32 item;
114
115 #undef __string
116 #define __string(item, src) __dynamic_array(char, item, -1)
117
118 #undef DECLARE_EVENT_CLASS
119 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
120 struct ftrace_data_offsets_##call { \
121 tstruct; \
122 };
123
124 #undef DEFINE_EVENT
125 #define DEFINE_EVENT(template, name, proto, args)
126
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
131 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
132
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" \
156 "offset:%u;\tsize:%u;\tsigned:%u;\n", \
157 (unsigned int)offsetof(typeof(field), item), \
158 (unsigned int)sizeof(field.item), \
159 (unsigned int)is_signed_type(type)); \
160 if (!ret) \
161 return 0;
162
163 #undef __field_ext
164 #define __field_ext(type, item, filter_type) __field(type, item)
165
166 #undef __array
167 #define __array(type, item, len) \
168 ret = trace_seq_printf(s, "\tfield:" #type " " #item "[" #len "];\t" \
169 "offset:%u;\tsize:%u;\tsigned:%u;\n", \
170 (unsigned int)offsetof(typeof(field), item), \
171 (unsigned int)sizeof(field.item), \
172 (unsigned int)is_signed_type(type)); \
173 if (!ret) \
174 return 0;
175
176 #undef __dynamic_array
177 #define __dynamic_array(type, item, len) \
178 ret = trace_seq_printf(s, "\tfield:__data_loc " #type "[] " #item ";\t"\
179 "offset:%u;\tsize:%u;\tsigned:%u;\n", \
180 (unsigned int)offsetof(typeof(field), \
181 __data_loc_##item), \
182 (unsigned int)sizeof(field.__data_loc_##item), \
183 (unsigned int)is_signed_type(type)); \
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
198 #define TP_printk(fmt, args...) "\"%s\", %s\n", fmt, __stringify(args)
199
200 #undef TP_fast_assign
201 #define TP_fast_assign(args...) args
202
203 #undef TP_perf_assign
204 #define TP_perf_assign(args...)
205
206 #undef DECLARE_EVENT_CLASS
207 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, func, print) \
208 static int \
209 ftrace_format_setup_##call(struct ftrace_event_call *unused, \
210 struct trace_seq *s) \
211 { \
212 struct ftrace_raw_##call field __attribute__((unused)); \
213 int ret = 0; \
214 \
215 tstruct; \
216 \
217 return ret; \
218 } \
219 \
220 static int \
221 ftrace_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); \
231 \
232 return ret; \
233 }
234
235 #undef DEFINE_EVENT
236 #define DEFINE_EVENT(template, name, proto, args)
237
238 #undef DEFINE_EVENT_PRINT
239 #define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
240 static int \
241 ftrace_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 \
250 trace_seq_printf(s, "\nprint fmt: " print); \
251 \
252 return ret; \
253 }
254
255 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
256
257 /*
258 * Stage 3 of the trace events.
259 *
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;
268 * struct trace_seq *p;
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 *
280 * p = get_cpu_var(ftrace_event_seq);
281 * trace_seq_init(p);
282 * ret = trace_seq_printf(s, <TP_printk> "\n");
283 * put_cpu();
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
301 #undef __get_dynamic_array
302 #define __get_dynamic_array(field) \
303 ((void *)__entry + (__entry->__data_loc_##field & 0xffff))
304
305 #undef __get_str
306 #define __get_str(field) (char *)__get_dynamic_array(field)
307
308 #undef __print_flags
309 #define __print_flags(flag, delim, flag_array...) \
310 ({ \
311 static const struct trace_print_flags __flags[] = \
312 { flag_array, { -1, NULL }}; \
313 ftrace_print_flags_seq(p, delim, flag, __flags); \
314 })
315
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
324 #undef DECLARE_EVENT_CLASS
325 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
326 static enum print_line_t \
327 ftrace_raw_output_id_##call(int event_id, const char *name, \
328 struct trace_iterator *iter, int flags) \
329 { \
330 struct trace_seq *s = &iter->seq; \
331 struct ftrace_raw_##call *field; \
332 struct trace_entry *entry; \
333 struct trace_seq *p; \
334 int ret; \
335 \
336 entry = iter->ent; \
337 \
338 if (entry->type != event_id) { \
339 WARN_ON_ONCE(1); \
340 return TRACE_TYPE_UNHANDLED; \
341 } \
342 \
343 field = (typeof(field))entry; \
344 \
345 p = &get_cpu_var(ftrace_event_seq); \
346 trace_seq_init(p); \
347 ret = trace_seq_printf(s, "%s: ", name); \
348 if (ret) \
349 ret = trace_seq_printf(s, print); \
350 put_cpu(); \
351 if (!ret) \
352 return TRACE_TYPE_PARTIAL_LINE; \
353 \
354 return TRACE_TYPE_HANDLED; \
355 }
356
357 #undef DEFINE_EVENT
358 #define DEFINE_EVENT(template, name, proto, args) \
359 static enum print_line_t \
360 ftrace_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
366 #undef DEFINE_EVENT_PRINT
367 #define DEFINE_EVENT_PRINT(template, call, proto, args, print) \
368 static enum print_line_t \
369 ftrace_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; \
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 \
386 p = &get_cpu_var(ftrace_event_seq); \
387 trace_seq_init(p); \
388 ret = trace_seq_printf(s, "%s: ", #call); \
389 if (ret) \
390 ret = trace_seq_printf(s, print); \
391 put_cpu(); \
392 if (!ret) \
393 return TRACE_TYPE_PARTIAL_LINE; \
394 \
395 return TRACE_TYPE_HANDLED; \
396 }
397
398 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
399
400 #undef __field_ext
401 #define __field_ext(type, item, filter_type) \
402 ret = trace_define_field(event_call, #type, #item, \
403 offsetof(typeof(field), item), \
404 sizeof(field.item), \
405 is_signed_type(type), filter_type); \
406 if (ret) \
407 return ret;
408
409 #undef __field
410 #define __field(type, item) __field_ext(type, item, FILTER_OTHER)
411
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), \
417 sizeof(field.item), 0, FILTER_OTHER); \
418 if (ret) \
419 return ret;
420
421 #undef __dynamic_array
422 #define __dynamic_array(type, item, len) \
423 ret = trace_define_field(event_call, "__data_loc " #type "[]", #item, \
424 offsetof(typeof(field), __data_loc_##item), \
425 sizeof(field.__data_loc_##item), 0, \
426 FILTER_OTHER);
427
428 #undef __string
429 #define __string(item, src) __dynamic_array(char, item, -1)
430
431 #undef DECLARE_EVENT_CLASS
432 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, func, print) \
433 static int \
434 ftrace_define_fields_##call(struct ftrace_event_call *event_call) \
435 { \
436 struct ftrace_raw_##call field; \
437 int ret; \
438 \
439 tstruct; \
440 \
441 return ret; \
442 }
443
444 #undef DEFINE_EVENT
445 #define DEFINE_EVENT(template, name, proto, args)
446
447 #undef DEFINE_EVENT_PRINT
448 #define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
449 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
450
451 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
452
453 /*
454 * remember the offset of each array from the beginning of the event.
455 */
456
457 #undef __entry
458 #define __entry entry
459
460 #undef __field
461 #define __field(type, item)
462
463 #undef __field_ext
464 #define __field_ext(type, item, filter_type)
465
466 #undef __array
467 #define __array(type, item, len)
468
469 #undef __dynamic_array
470 #define __dynamic_array(type, item, len) \
471 __data_offsets->item = __data_size + \
472 offsetof(typeof(*entry), __data); \
473 __data_offsets->item |= (len * sizeof(type)) << 16; \
474 __data_size += (len) * sizeof(type);
475
476 #undef __string
477 #define __string(item, src) __dynamic_array(char, item, strlen(src) + 1)
478
479 #undef DECLARE_EVENT_CLASS
480 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
481 static inline int ftrace_get_offsets_##call( \
482 struct ftrace_data_offsets_##call *__data_offsets, proto) \
483 { \
484 int __data_size = 0; \
485 struct ftrace_raw_##call __maybe_unused *entry; \
486 \
487 tstruct; \
488 \
489 return __data_size; \
490 }
491
492 #undef DEFINE_EVENT
493 #define DEFINE_EVENT(template, name, proto, args)
494
495 #undef DEFINE_EVENT_PRINT
496 #define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
497 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
498
499 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
500
501 #ifdef CONFIG_EVENT_PROFILE
502
503 /*
504 * Generate the functions needed for tracepoint perf_event support.
505 *
506 * NOTE: The insertion profile callback (ftrace_profile_<call>) is defined later
507 *
508 * static int ftrace_profile_enable_<call>(void)
509 * {
510 * return register_trace_<call>(ftrace_profile_<call>);
511 * }
512 *
513 * static void ftrace_profile_disable_<call>(void)
514 * {
515 * unregister_trace_<call>(ftrace_profile_<call>);
516 * }
517 *
518 */
519
520 #undef DECLARE_EVENT_CLASS
521 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print)
522
523 #undef DEFINE_EVENT
524 #define DEFINE_EVENT(template, name, proto, args) \
525 \
526 static void ftrace_profile_##name(proto); \
527 \
528 static int ftrace_profile_enable_##name(struct ftrace_event_call *unused)\
529 { \
530 return register_trace_##name(ftrace_profile_##name); \
531 } \
532 \
533 static void ftrace_profile_disable_##name(struct ftrace_event_call *unused)\
534 { \
535 unregister_trace_##name(ftrace_profile_##name); \
536 }
537
538 #undef DEFINE_EVENT_PRINT
539 #define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
540 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
541
542 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
543
544 #endif
545
546 /*
547 * Stage 4 of the trace events.
548 *
549 * Override the macros in <trace/trace_events.h> to include the following:
550 *
551 * static void ftrace_event_<call>(proto)
552 * {
553 * event_trace_printk(_RET_IP_, "<call>: " <fmt>);
554 * }
555 *
556 * static int ftrace_reg_event_<call>(struct ftrace_event_call *unused)
557 * {
558 * return register_trace_<call>(ftrace_event_<call>);
559 * }
560 *
561 * static void ftrace_unreg_event_<call>(struct ftrace_event_call *unused)
562 * {
563 * unregister_trace_<call>(ftrace_event_<call>);
564 * }
565 *
566 *
567 * For those macros defined with TRACE_EVENT:
568 *
569 * static struct ftrace_event_call event_<call>;
570 *
571 * static void ftrace_raw_event_<call>(proto)
572 * {
573 * struct ring_buffer_event *event;
574 * struct ftrace_raw_<call> *entry; <-- defined in stage 1
575 * struct ring_buffer *buffer;
576 * unsigned long irq_flags;
577 * int pc;
578 *
579 * local_save_flags(irq_flags);
580 * pc = preempt_count();
581 *
582 * event = trace_current_buffer_lock_reserve(&buffer,
583 * event_<call>.id,
584 * sizeof(struct ftrace_raw_<call>),
585 * irq_flags, pc);
586 * if (!event)
587 * return;
588 * entry = ring_buffer_event_data(event);
589 *
590 * <assign>; <-- Here we assign the entries by the __field and
591 * __array macros.
592 *
593 * trace_current_buffer_unlock_commit(buffer, event, irq_flags, pc);
594 * }
595 *
596 * static int ftrace_raw_reg_event_<call>(struct ftrace_event_call *unused)
597 * {
598 * int ret;
599 *
600 * ret = register_trace_<call>(ftrace_raw_event_<call>);
601 * if (!ret)
602 * pr_info("event trace: Could not activate trace point "
603 * "probe to <call>");
604 * return ret;
605 * }
606 *
607 * static void ftrace_unreg_event_<call>(struct ftrace_event_call *unused)
608 * {
609 * unregister_trace_<call>(ftrace_raw_event_<call>);
610 * }
611 *
612 * static struct trace_event ftrace_event_type_<call> = {
613 * .trace = ftrace_raw_output_<call>, <-- stage 2
614 * };
615 *
616 * static struct ftrace_event_call __used
617 * __attribute__((__aligned__(4)))
618 * __attribute__((section("_ftrace_events"))) event_<call> = {
619 * .name = "<call>",
620 * .system = "<system>",
621 * .raw_init = trace_event_raw_init,
622 * .regfunc = ftrace_reg_event_<call>,
623 * .unregfunc = ftrace_unreg_event_<call>,
624 * .show_format = ftrace_format_<call>,
625 * }
626 *
627 */
628
629 #ifdef CONFIG_EVENT_PROFILE
630
631 #define _TRACE_PROFILE_INIT(call) \
632 .profile_enable = ftrace_profile_enable_##call, \
633 .profile_disable = ftrace_profile_disable_##call,
634
635 #else
636 #define _TRACE_PROFILE_INIT(call)
637 #endif
638
639 #undef __entry
640 #define __entry entry
641
642 #undef __field
643 #define __field(type, item)
644
645 #undef __array
646 #define __array(type, item, len)
647
648 #undef __dynamic_array
649 #define __dynamic_array(type, item, len) \
650 __entry->__data_loc_##item = __data_offsets.item;
651
652 #undef __string
653 #define __string(item, src) __dynamic_array(char, item, -1) \
654
655 #undef __assign_str
656 #define __assign_str(dst, src) \
657 strcpy(__get_str(dst), src);
658
659 #undef DECLARE_EVENT_CLASS
660 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
661 \
662 static void ftrace_raw_event_id_##call(struct ftrace_event_call *event_call, \
663 proto) \
664 { \
665 struct ftrace_data_offsets_##call __maybe_unused __data_offsets;\
666 struct ring_buffer_event *event; \
667 struct ftrace_raw_##call *entry; \
668 struct ring_buffer *buffer; \
669 unsigned long irq_flags; \
670 int __data_size; \
671 int pc; \
672 \
673 local_save_flags(irq_flags); \
674 pc = preempt_count(); \
675 \
676 __data_size = ftrace_get_offsets_##call(&__data_offsets, args); \
677 \
678 event = trace_current_buffer_lock_reserve(&buffer, \
679 event_call->id, \
680 sizeof(*entry) + __data_size, \
681 irq_flags, pc); \
682 if (!event) \
683 return; \
684 entry = ring_buffer_event_data(event); \
685 \
686 \
687 tstruct \
688 \
689 { assign; } \
690 \
691 if (!filter_current_check_discard(buffer, event_call, entry, event)) \
692 trace_nowake_buffer_unlock_commit(buffer, \
693 event, irq_flags, pc); \
694 }
695
696 #undef DEFINE_EVENT
697 #define DEFINE_EVENT(template, call, proto, args) \
698 \
699 static void ftrace_raw_event_##call(proto) \
700 { \
701 ftrace_raw_event_id_##template(&event_##call, args); \
702 } \
703 \
704 static int ftrace_raw_reg_event_##call(struct ftrace_event_call *unused)\
705 { \
706 return register_trace_##call(ftrace_raw_event_##call); \
707 } \
708 \
709 static void ftrace_raw_unreg_event_##call(struct ftrace_event_call *unused)\
710 { \
711 unregister_trace_##call(ftrace_raw_event_##call); \
712 } \
713 \
714 static struct trace_event ftrace_event_type_##call = { \
715 .trace = ftrace_raw_output_##call, \
716 };
717
718 #undef DEFINE_EVENT_PRINT
719 #define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
720 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
721
722 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
723
724 #undef DECLARE_EVENT_CLASS
725 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print)
726
727 #undef DEFINE_EVENT
728 #define DEFINE_EVENT(template, call, proto, args) \
729 \
730 static struct ftrace_event_call __used \
731 __attribute__((__aligned__(4))) \
732 __attribute__((section("_ftrace_events"))) event_##call = { \
733 .name = #call, \
734 .system = __stringify(TRACE_SYSTEM), \
735 .event = &ftrace_event_type_##call, \
736 .raw_init = trace_event_raw_init, \
737 .regfunc = ftrace_raw_reg_event_##call, \
738 .unregfunc = ftrace_raw_unreg_event_##call, \
739 .show_format = ftrace_format_##template, \
740 .define_fields = ftrace_define_fields_##template, \
741 _TRACE_PROFILE_INIT(call) \
742 }
743
744 #undef DEFINE_EVENT_PRINT
745 #define DEFINE_EVENT_PRINT(template, call, proto, args, print) \
746 \
747 static struct ftrace_event_call __used \
748 __attribute__((__aligned__(4))) \
749 __attribute__((section("_ftrace_events"))) event_##call = { \
750 .name = #call, \
751 .system = __stringify(TRACE_SYSTEM), \
752 .event = &ftrace_event_type_##call, \
753 .raw_init = trace_event_raw_init, \
754 .regfunc = ftrace_raw_reg_event_##call, \
755 .unregfunc = ftrace_raw_unreg_event_##call, \
756 .show_format = ftrace_format_##call, \
757 .define_fields = ftrace_define_fields_##template, \
758 _TRACE_PROFILE_INIT(call) \
759 }
760
761 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
762
763 /*
764 * Define the insertion callback to profile events
765 *
766 * The job is very similar to ftrace_raw_event_<call> except that we don't
767 * insert in the ring buffer but in a perf counter.
768 *
769 * static void ftrace_profile_<call>(proto)
770 * {
771 * struct ftrace_data_offsets_<call> __maybe_unused __data_offsets;
772 * struct ftrace_event_call *event_call = &event_<call>;
773 * extern void perf_tp_event(int, u64, u64, void *, int);
774 * struct ftrace_raw_##call *entry;
775 * struct perf_trace_buf *trace_buf;
776 * u64 __addr = 0, __count = 1;
777 * unsigned long irq_flags;
778 * struct trace_entry *ent;
779 * int __entry_size;
780 * int __data_size;
781 * int __cpu
782 * int pc;
783 *
784 * pc = preempt_count();
785 *
786 * __data_size = ftrace_get_offsets_<call>(&__data_offsets, args);
787 *
788 * // Below we want to get the aligned size by taking into account
789 * // the u32 field that will later store the buffer size
790 * __entry_size = ALIGN(__data_size + sizeof(*entry) + sizeof(u32),
791 * sizeof(u64));
792 * __entry_size -= sizeof(u32);
793 *
794 * // Protect the non nmi buffer
795 * // This also protects the rcu read side
796 * local_irq_save(irq_flags);
797 * __cpu = smp_processor_id();
798 *
799 * if (in_nmi())
800 * trace_buf = rcu_dereference(perf_trace_buf_nmi);
801 * else
802 * trace_buf = rcu_dereference(perf_trace_buf);
803 *
804 * if (!trace_buf)
805 * goto end;
806 *
807 * trace_buf = per_cpu_ptr(trace_buf, __cpu);
808 *
809 * // Avoid recursion from perf that could mess up the buffer
810 * if (trace_buf->recursion++)
811 * goto end_recursion;
812 *
813 * raw_data = trace_buf->buf;
814 *
815 * // Make recursion update visible before entering perf_tp_event
816 * // so that we protect from perf recursions.
817 *
818 * barrier();
819 *
820 * //zero dead bytes from alignment to avoid stack leak to userspace:
821 * *(u64 *)(&raw_data[__entry_size - sizeof(u64)]) = 0ULL;
822 * entry = (struct ftrace_raw_<call> *)raw_data;
823 * ent = &entry->ent;
824 * tracing_generic_entry_update(ent, irq_flags, pc);
825 * ent->type = event_call->id;
826 *
827 * <tstruct> <- do some jobs with dynamic arrays
828 *
829 * <assign> <- affect our values
830 *
831 * perf_tp_event(event_call->id, __addr, __count, entry,
832 * __entry_size); <- submit them to perf counter
833 *
834 * }
835 */
836
837 #ifdef CONFIG_EVENT_PROFILE
838
839 #undef __perf_addr
840 #define __perf_addr(a) __addr = (a)
841
842 #undef __perf_count
843 #define __perf_count(c) __count = (c)
844
845 #undef DECLARE_EVENT_CLASS
846 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
847 static void \
848 ftrace_profile_templ_##call(struct ftrace_event_call *event_call, \
849 proto) \
850 { \
851 struct ftrace_data_offsets_##call __maybe_unused __data_offsets;\
852 extern int perf_swevent_get_recursion_context(void); \
853 extern void perf_swevent_put_recursion_context(int rctx); \
854 extern void perf_tp_event(int, u64, u64, void *, int); \
855 struct ftrace_raw_##call *entry; \
856 u64 __addr = 0, __count = 1; \
857 unsigned long irq_flags; \
858 struct trace_entry *ent; \
859 int __entry_size; \
860 int __data_size; \
861 char *trace_buf; \
862 char *raw_data; \
863 int __cpu; \
864 int rctx; \
865 int pc; \
866 \
867 pc = preempt_count(); \
868 \
869 __data_size = ftrace_get_offsets_##call(&__data_offsets, args); \
870 __entry_size = ALIGN(__data_size + sizeof(*entry) + sizeof(u32),\
871 sizeof(u64)); \
872 __entry_size -= sizeof(u32); \
873 \
874 if (WARN_ONCE(__entry_size > FTRACE_MAX_PROFILE_SIZE, \
875 "profile buffer not large enough")) \
876 return; \
877 \
878 local_irq_save(irq_flags); \
879 \
880 rctx = perf_swevent_get_recursion_context(); \
881 if (rctx < 0) \
882 goto end_recursion; \
883 \
884 __cpu = smp_processor_id(); \
885 \
886 if (in_nmi()) \
887 trace_buf = rcu_dereference(perf_trace_buf_nmi); \
888 else \
889 trace_buf = rcu_dereference(perf_trace_buf); \
890 \
891 if (!trace_buf) \
892 goto end; \
893 \
894 raw_data = per_cpu_ptr(trace_buf, __cpu); \
895 \
896 *(u64 *)(&raw_data[__entry_size - sizeof(u64)]) = 0ULL; \
897 entry = (struct ftrace_raw_##call *)raw_data; \
898 ent = &entry->ent; \
899 tracing_generic_entry_update(ent, irq_flags, pc); \
900 ent->type = event_call->id; \
901 \
902 tstruct \
903 \
904 { assign; } \
905 \
906 perf_tp_event(event_call->id, __addr, __count, entry, \
907 __entry_size); \
908 \
909 end: \
910 perf_swevent_put_recursion_context(rctx); \
911 end_recursion: \
912 local_irq_restore(irq_flags); \
913 }
914
915 #undef DEFINE_EVENT
916 #define DEFINE_EVENT(template, call, proto, args) \
917 static void ftrace_profile_##call(proto) \
918 { \
919 struct ftrace_event_call *event_call = &event_##call; \
920 \
921 ftrace_profile_templ_##template(event_call, args); \
922 }
923
924 #undef DEFINE_EVENT_PRINT
925 #define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
926 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
927
928 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
929 #endif /* CONFIG_EVENT_PROFILE */
930
931 #undef _TRACE_PROFILE_INIT
932
Ubuntu Jammy Linux kernel mirror