Loading...
1/* SPDX-License-Identifier: GPL-2.0 */
2/*
3 * Stage 1 of the trace events.
4 *
5 * Override the macros in the event tracepoint header <trace/events/XXX.h>
6 * to include the following:
7 *
8 * struct trace_event_raw_<call> {
9 * struct trace_entry ent;
10 * <type> <item>;
11 * <type2> <item2>[<len>];
12 * [...]
13 * };
14 *
15 * The <type> <item> is created by the __field(type, item) macro or
16 * the __array(type2, item2, len) macro.
17 * We simply do "type item;", and that will create the fields
18 * in the structure.
19 */
20
21#include <linux/trace_events.h>
22
23#ifndef TRACE_SYSTEM_VAR
24#define TRACE_SYSTEM_VAR TRACE_SYSTEM
25#endif
26
27#include "stages/init.h"
28
29/*
30 * DECLARE_EVENT_CLASS can be used to add a generic function
31 * handlers for events. That is, if all events have the same
32 * parameters and just have distinct trace points.
33 * Each tracepoint can be defined with DEFINE_EVENT and that
34 * will map the DECLARE_EVENT_CLASS to the tracepoint.
35 *
36 * TRACE_EVENT is a one to one mapping between tracepoint and template.
37 */
38#undef TRACE_EVENT
39#define TRACE_EVENT(name, proto, args, tstruct, assign, print) \
40 DECLARE_EVENT_CLASS(name, \
41 PARAMS(proto), \
42 PARAMS(args), \
43 PARAMS(tstruct), \
44 PARAMS(assign), \
45 PARAMS(print)); \
46 DEFINE_EVENT(name, name, PARAMS(proto), PARAMS(args));
47
48#undef TRACE_EVENT_SYSCALL
49#define TRACE_EVENT_SYSCALL(name, proto, args, tstruct, assign, print, reg, unreg) \
50 DECLARE_EVENT_SYSCALL_CLASS(name, \
51 PARAMS(proto), \
52 PARAMS(args), \
53 PARAMS(tstruct), \
54 PARAMS(assign), \
55 PARAMS(print)); \
56 DEFINE_EVENT(name, name, PARAMS(proto), PARAMS(args));
57
58#include "stages/stage1_struct_define.h"
59
60#undef DECLARE_EVENT_CLASS
61#define DECLARE_EVENT_CLASS(name, proto, args, tstruct, assign, print) \
62 struct trace_event_raw_##name { \
63 struct trace_entry ent; \
64 tstruct \
65 char __data[]; \
66 }; \
67 \
68 static struct trace_event_class event_class_##name;
69
70#undef DECLARE_EVENT_SYSCALL_CLASS
71#define DECLARE_EVENT_SYSCALL_CLASS DECLARE_EVENT_CLASS
72
73#undef DEFINE_EVENT
74#define DEFINE_EVENT(template, name, proto, args) \
75 static struct trace_event_call __used \
76 __attribute__((__aligned__(4))) event_##name
77
78#undef DEFINE_EVENT_FN
79#define DEFINE_EVENT_FN(template, name, proto, args, reg, unreg) \
80 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
81
82#undef DEFINE_EVENT_PRINT
83#define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
84 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
85
86/* Callbacks are meaningless to ftrace. */
87#undef TRACE_EVENT_FN
88#define TRACE_EVENT_FN(name, proto, args, tstruct, \
89 assign, print, reg, unreg) \
90 TRACE_EVENT(name, PARAMS(proto), PARAMS(args), \
91 PARAMS(tstruct), PARAMS(assign), PARAMS(print)) \
92
93#undef TRACE_EVENT_FN_COND
94#define TRACE_EVENT_FN_COND(name, proto, args, cond, tstruct, \
95 assign, print, reg, unreg) \
96 TRACE_EVENT_CONDITION(name, PARAMS(proto), PARAMS(args), PARAMS(cond), \
97 PARAMS(tstruct), PARAMS(assign), PARAMS(print)) \
98
99#undef TRACE_EVENT_FLAGS
100#define TRACE_EVENT_FLAGS(name, value) \
101 __TRACE_EVENT_FLAGS(name, value)
102
103#undef TRACE_EVENT_PERF_PERM
104#define TRACE_EVENT_PERF_PERM(name, expr...) \
105 __TRACE_EVENT_PERF_PERM(name, expr)
106
107#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
108
109/*
110 * Stage 2 of the trace events.
111 *
112 * Include the following:
113 *
114 * struct trace_event_data_offsets_<call> {
115 * u32 <item1>;
116 * u32 <item2>;
117 * [...]
118 * };
119 *
120 * The __dynamic_array() macro will create each u32 <item>, this is
121 * to keep the offset of each array from the beginning of the event.
122 * The size of an array is also encoded, in the higher 16 bits of <item>.
123 */
124
125#include "stages/stage2_data_offsets.h"
126
127#undef DECLARE_EVENT_CLASS
128#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
129 struct trace_event_data_offsets_##call { \
130 tstruct; \
131 };
132
133#undef DECLARE_EVENT_SYSCALL_CLASS
134#define DECLARE_EVENT_SYSCALL_CLASS DECLARE_EVENT_CLASS
135
136#undef DEFINE_EVENT
137#define DEFINE_EVENT(template, name, proto, args)
138
139#undef DEFINE_EVENT_PRINT
140#define DEFINE_EVENT_PRINT(template, name, proto, args, print)
141
142#undef TRACE_EVENT_FLAGS
143#define TRACE_EVENT_FLAGS(event, flag)
144
145#undef TRACE_EVENT_PERF_PERM
146#define TRACE_EVENT_PERF_PERM(event, expr...)
147
148#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
149
150/*
151 * Stage 3 of the trace events.
152 *
153 * Override the macros in the event tracepoint header <trace/events/XXX.h>
154 * to include the following:
155 *
156 * enum print_line_t
157 * trace_raw_output_<call>(struct trace_iterator *iter, int flags)
158 * {
159 * struct trace_seq *s = &iter->seq;
160 * struct trace_event_raw_<call> *field; <-- defined in stage 1
161 * struct trace_seq *p = &iter->tmp_seq;
162 *
163 * -------(for event)-------
164 *
165 * struct trace_entry *entry;
166 *
167 * entry = iter->ent;
168 *
169 * if (entry->type != event_<call>->event.type) {
170 * WARN_ON_ONCE(1);
171 * return TRACE_TYPE_UNHANDLED;
172 * }
173 *
174 * field = (typeof(field))entry;
175 *
176 * trace_seq_init(p);
177 * return trace_output_call(iter, <call>, <TP_printk> "\n");
178 *
179 * ------(or, for event class)------
180 *
181 * int ret;
182 *
183 * field = (typeof(field))iter->ent;
184 *
185 * ret = trace_raw_output_prep(iter, trace_event);
186 * if (ret != TRACE_TYPE_HANDLED)
187 * return ret;
188 *
189 * trace_event_printf(iter, <TP_printk> "\n");
190 *
191 * return trace_handle_return(s);
192 * -------
193 * }
194 *
195 * This is the method used to print the raw event to the trace
196 * output format. Note, this is not needed if the data is read
197 * in binary.
198 */
199
200#include "stages/stage3_trace_output.h"
201
202#undef DECLARE_EVENT_CLASS
203#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
204static notrace enum print_line_t \
205trace_raw_output_##call(struct trace_iterator *iter, int flags, \
206 struct trace_event *trace_event) \
207{ \
208 struct trace_seq *s = &iter->seq; \
209 struct trace_seq __maybe_unused *p = &iter->tmp_seq; \
210 struct trace_event_raw_##call *field; \
211 int ret; \
212 \
213 field = (typeof(field))iter->ent; \
214 \
215 ret = trace_raw_output_prep(iter, trace_event); \
216 if (ret != TRACE_TYPE_HANDLED) \
217 return ret; \
218 \
219 trace_event_printf(iter, print); \
220 \
221 return trace_handle_return(s); \
222} \
223static struct trace_event_functions trace_event_type_funcs_##call = { \
224 .trace = trace_raw_output_##call, \
225};
226
227#undef DECLARE_EVENT_SYSCALL_CLASS
228#define DECLARE_EVENT_SYSCALL_CLASS DECLARE_EVENT_CLASS
229
230#undef DEFINE_EVENT_PRINT
231#define DEFINE_EVENT_PRINT(template, call, proto, args, print) \
232static notrace enum print_line_t \
233trace_raw_output_##call(struct trace_iterator *iter, int flags, \
234 struct trace_event *event) \
235{ \
236 struct trace_event_raw_##template *field; \
237 struct trace_entry *entry; \
238 struct trace_seq *p = &iter->tmp_seq; \
239 \
240 entry = iter->ent; \
241 \
242 if (entry->type != event_##call.event.type) { \
243 WARN_ON_ONCE(1); \
244 return TRACE_TYPE_UNHANDLED; \
245 } \
246 \
247 field = (typeof(field))entry; \
248 \
249 trace_seq_init(p); \
250 return trace_output_call(iter, #call, print); \
251} \
252static struct trace_event_functions trace_event_type_funcs_##call = { \
253 .trace = trace_raw_output_##call, \
254};
255
256#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
257
258#include "stages/stage4_event_fields.h"
259
260#undef DECLARE_EVENT_CLASS
261#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, func, print) \
262static struct trace_event_fields trace_event_fields_##call[] = { \
263 tstruct \
264 {} };
265
266#undef DECLARE_EVENT_SYSCALL_CLASS
267#define DECLARE_EVENT_SYSCALL_CLASS DECLARE_EVENT_CLASS
268
269#undef DEFINE_EVENT_PRINT
270#define DEFINE_EVENT_PRINT(template, name, proto, args, print)
271
272#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
273
274#include "stages/stage5_get_offsets.h"
275
276#undef DECLARE_EVENT_CLASS
277#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
278static inline notrace int trace_event_get_offsets_##call( \
279 struct trace_event_data_offsets_##call *__data_offsets, proto) \
280{ \
281 int __data_size = 0; \
282 int __maybe_unused __item_length; \
283 struct trace_event_raw_##call __maybe_unused *entry; \
284 \
285 tstruct; \
286 \
287 return __data_size; \
288}
289
290#undef DECLARE_EVENT_SYSCALL_CLASS
291#define DECLARE_EVENT_SYSCALL_CLASS DECLARE_EVENT_CLASS
292
293#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
294
295/*
296 * Stage 4 of the trace events.
297 *
298 * Override the macros in the event tracepoint header <trace/events/XXX.h>
299 * to include the following:
300 *
301 * For those macros defined with TRACE_EVENT:
302 *
303 * static struct trace_event_call event_<call>;
304 *
305 * static void trace_event_raw_event_<call>(void *__data, proto)
306 * {
307 * struct trace_event_file *trace_file = __data;
308 * struct trace_event_call *event_call = trace_file->event_call;
309 * struct trace_event_data_offsets_<call> __maybe_unused __data_offsets;
310 * unsigned long eflags = trace_file->flags;
311 * enum event_trigger_type __tt = ETT_NONE;
312 * struct ring_buffer_event *event;
313 * struct trace_event_raw_<call> *entry; <-- defined in stage 1
314 * struct trace_buffer *buffer;
315 * unsigned long irq_flags;
316 * int __data_size;
317 * int pc;
318 *
319 * if (!(eflags & EVENT_FILE_FL_TRIGGER_COND)) {
320 * if (eflags & EVENT_FILE_FL_TRIGGER_MODE)
321 * event_triggers_call(trace_file, NULL);
322 * if (eflags & EVENT_FILE_FL_SOFT_DISABLED)
323 * return;
324 * }
325 *
326 * local_save_flags(irq_flags);
327 * pc = preempt_count();
328 *
329 * __data_size = trace_event_get_offsets_<call>(&__data_offsets, args);
330 *
331 * event = trace_event_buffer_lock_reserve(&buffer, trace_file,
332 * event_<call>->event.type,
333 * sizeof(*entry) + __data_size,
334 * irq_flags, pc);
335 * if (!event)
336 * return;
337 * entry = ring_buffer_event_data(event);
338 *
339 * { <assign>; } <-- Here we assign the entries by the __field and
340 * __array macros.
341 *
342 * if (eflags & EVENT_FILE_FL_TRIGGER_COND)
343 * __tt = event_triggers_call(trace_file, entry);
344 *
345 * if (test_bit(EVENT_FILE_FL_SOFT_DISABLED_BIT,
346 * &trace_file->flags))
347 * ring_buffer_discard_commit(buffer, event);
348 * else if (!filter_check_discard(trace_file, entry, buffer, event))
349 * trace_buffer_unlock_commit(buffer, event, irq_flags, pc);
350 *
351 * if (__tt)
352 * event_triggers_post_call(trace_file, __tt);
353 * }
354 *
355 * static struct trace_event ftrace_event_type_<call> = {
356 * .trace = trace_raw_output_<call>, <-- stage 2
357 * };
358 *
359 * static char print_fmt_<call>[] = <TP_printk>;
360 *
361 * static struct trace_event_class __used event_class_<template> = {
362 * .system = "<system>",
363 * .fields_array = trace_event_fields_<call>,
364 * .fields = LIST_HEAD_INIT(event_class_##call.fields),
365 * .raw_init = trace_event_raw_init,
366 * .probe = trace_event_raw_event_##call,
367 * .reg = trace_event_reg,
368 * };
369 *
370 * static struct trace_event_call event_<call> = {
371 * .class = event_class_<template>,
372 * {
373 * .tp = &__tracepoint_<call>,
374 * },
375 * .event = &ftrace_event_type_<call>,
376 * .print_fmt = print_fmt_<call>,
377 * .flags = TRACE_EVENT_FL_TRACEPOINT,
378 * };
379 * // its only safe to use pointers when doing linker tricks to
380 * // create an array.
381 * static struct trace_event_call __used
382 * __section("_ftrace_events") *__event_<call> = &event_<call>;
383 *
384 */
385
386#ifdef CONFIG_PERF_EVENTS
387
388#define _TRACE_PERF_PROTO(call, proto) \
389 static notrace void \
390 perf_trace_##call(void *__data, proto);
391
392#define _TRACE_PERF_INIT(call) \
393 .perf_probe = perf_trace_##call,
394
395#else
396#define _TRACE_PERF_PROTO(call, proto)
397#define _TRACE_PERF_INIT(call)
398#endif /* CONFIG_PERF_EVENTS */
399
400#include "stages/stage6_event_callback.h"
401
402
403#undef __DECLARE_EVENT_CLASS
404#define __DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
405static notrace void \
406do_trace_event_raw_event_##call(void *__data, proto) \
407{ \
408 struct trace_event_file *trace_file = __data; \
409 struct trace_event_data_offsets_##call __maybe_unused __data_offsets;\
410 struct trace_event_buffer fbuffer; \
411 struct trace_event_raw_##call *entry; \
412 int __data_size; \
413 \
414 if (trace_trigger_soft_disabled(trace_file)) \
415 return; \
416 \
417 __data_size = trace_event_get_offsets_##call(&__data_offsets, args); \
418 \
419 entry = trace_event_buffer_reserve(&fbuffer, trace_file, \
420 sizeof(*entry) + __data_size); \
421 \
422 if (!entry) \
423 return; \
424 \
425 tstruct \
426 \
427 { assign; } \
428 \
429 trace_event_buffer_commit(&fbuffer); \
430}
431
432#undef DECLARE_EVENT_CLASS
433#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
434__DECLARE_EVENT_CLASS(call, PARAMS(proto), PARAMS(args), PARAMS(tstruct), \
435 PARAMS(assign), PARAMS(print)) \
436static notrace void \
437trace_event_raw_event_##call(void *__data, proto) \
438{ \
439 do_trace_event_raw_event_##call(__data, args); \
440}
441
442#undef DECLARE_EVENT_SYSCALL_CLASS
443#define DECLARE_EVENT_SYSCALL_CLASS(call, proto, args, tstruct, assign, print) \
444__DECLARE_EVENT_CLASS(call, PARAMS(proto), PARAMS(args), PARAMS(tstruct), \
445 PARAMS(assign), PARAMS(print)) \
446static notrace void \
447trace_event_raw_event_##call(void *__data, proto) \
448{ \
449 might_fault(); \
450 preempt_disable_notrace(); \
451 do_trace_event_raw_event_##call(__data, args); \
452 preempt_enable_notrace(); \
453}
454
455/*
456 * The ftrace_test_probe is compiled out, it is only here as a build time check
457 * to make sure that if the tracepoint handling changes, the ftrace probe will
458 * fail to compile unless it too is updated.
459 */
460
461#undef DEFINE_EVENT
462#define DEFINE_EVENT(template, call, proto, args) \
463static inline void ftrace_test_probe_##call(void) \
464{ \
465 check_trace_callback_type_##call(trace_event_raw_event_##template); \
466}
467
468#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
469
470#undef __DECLARE_EVENT_CLASS
471
472#include "stages/stage7_class_define.h"
473
474#undef DECLARE_EVENT_CLASS
475#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
476_TRACE_PERF_PROTO(call, PARAMS(proto)); \
477static char print_fmt_##call[] = print; \
478static struct trace_event_class __used __refdata event_class_##call = { \
479 .system = TRACE_SYSTEM_STRING, \
480 .fields_array = trace_event_fields_##call, \
481 .fields = LIST_HEAD_INIT(event_class_##call.fields),\
482 .raw_init = trace_event_raw_init, \
483 .probe = trace_event_raw_event_##call, \
484 .reg = trace_event_reg, \
485 _TRACE_PERF_INIT(call) \
486};
487
488#undef DECLARE_EVENT_SYSCALL_CLASS
489#define DECLARE_EVENT_SYSCALL_CLASS DECLARE_EVENT_CLASS
490
491#undef DEFINE_EVENT
492#define DEFINE_EVENT(template, call, proto, args) \
493 \
494static struct trace_event_call __used event_##call = { \
495 .class = &event_class_##template, \
496 { \
497 .tp = &__tracepoint_##call, \
498 }, \
499 .event.funcs = &trace_event_type_funcs_##template, \
500 .print_fmt = print_fmt_##template, \
501 .flags = TRACE_EVENT_FL_TRACEPOINT, \
502}; \
503static struct trace_event_call __used \
504__section("_ftrace_events") *__event_##call = &event_##call
505
506#undef DEFINE_EVENT_PRINT
507#define DEFINE_EVENT_PRINT(template, call, proto, args, print) \
508 \
509static char print_fmt_##call[] = print; \
510 \
511static struct trace_event_call __used event_##call = { \
512 .class = &event_class_##template, \
513 { \
514 .tp = &__tracepoint_##call, \
515 }, \
516 .event.funcs = &trace_event_type_funcs_##call, \
517 .print_fmt = print_fmt_##call, \
518 .flags = TRACE_EVENT_FL_TRACEPOINT, \
519}; \
520static struct trace_event_call __used \
521__section("_ftrace_events") *__event_##call = &event_##call
522
523#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
1/* SPDX-License-Identifier: GPL-2.0 */
2/*
3 * Stage 1 of the trace events.
4 *
5 * Override the macros in the event tracepoint header <trace/events/XXX.h>
6 * to include the following:
7 *
8 * struct trace_event_raw_<call> {
9 * struct trace_entry ent;
10 * <type> <item>;
11 * <type2> <item2>[<len>];
12 * [...]
13 * };
14 *
15 * The <type> <item> is created by the __field(type, item) macro or
16 * the __array(type2, item2, len) macro.
17 * We simply do "type item;", and that will create the fields
18 * in the structure.
19 */
20
21#include <linux/trace_events.h>
22
23#ifndef TRACE_SYSTEM_VAR
24#define TRACE_SYSTEM_VAR TRACE_SYSTEM
25#endif
26
27#define __app__(x, y) str__##x##y
28#define __app(x, y) __app__(x, y)
29
30#define TRACE_SYSTEM_STRING __app(TRACE_SYSTEM_VAR,__trace_system_name)
31
32#define TRACE_MAKE_SYSTEM_STR() \
33 static const char TRACE_SYSTEM_STRING[] = \
34 __stringify(TRACE_SYSTEM)
35
36TRACE_MAKE_SYSTEM_STR();
37
38#undef TRACE_DEFINE_ENUM
39#define TRACE_DEFINE_ENUM(a) \
40 static struct trace_eval_map __used __initdata \
41 __##TRACE_SYSTEM##_##a = \
42 { \
43 .system = TRACE_SYSTEM_STRING, \
44 .eval_string = #a, \
45 .eval_value = a \
46 }; \
47 static struct trace_eval_map __used \
48 __attribute__((section("_ftrace_eval_map"))) \
49 *TRACE_SYSTEM##_##a = &__##TRACE_SYSTEM##_##a
50
51#undef TRACE_DEFINE_SIZEOF
52#define TRACE_DEFINE_SIZEOF(a) \
53 static struct trace_eval_map __used __initdata \
54 __##TRACE_SYSTEM##_##a = \
55 { \
56 .system = TRACE_SYSTEM_STRING, \
57 .eval_string = "sizeof(" #a ")", \
58 .eval_value = sizeof(a) \
59 }; \
60 static struct trace_eval_map __used \
61 __attribute__((section("_ftrace_eval_map"))) \
62 *TRACE_SYSTEM##_##a = &__##TRACE_SYSTEM##_##a
63
64/*
65 * DECLARE_EVENT_CLASS can be used to add a generic function
66 * handlers for events. That is, if all events have the same
67 * parameters and just have distinct trace points.
68 * Each tracepoint can be defined with DEFINE_EVENT and that
69 * will map the DECLARE_EVENT_CLASS to the tracepoint.
70 *
71 * TRACE_EVENT is a one to one mapping between tracepoint and template.
72 */
73#undef TRACE_EVENT
74#define TRACE_EVENT(name, proto, args, tstruct, assign, print) \
75 DECLARE_EVENT_CLASS(name, \
76 PARAMS(proto), \
77 PARAMS(args), \
78 PARAMS(tstruct), \
79 PARAMS(assign), \
80 PARAMS(print)); \
81 DEFINE_EVENT(name, name, PARAMS(proto), PARAMS(args));
82
83
84#undef __field
85#define __field(type, item) type item;
86
87#undef __field_ext
88#define __field_ext(type, item, filter_type) type item;
89
90#undef __field_struct
91#define __field_struct(type, item) type item;
92
93#undef __field_struct_ext
94#define __field_struct_ext(type, item, filter_type) type item;
95
96#undef __array
97#define __array(type, item, len) type item[len];
98
99#undef __dynamic_array
100#define __dynamic_array(type, item, len) u32 __data_loc_##item;
101
102#undef __string
103#define __string(item, src) __dynamic_array(char, item, -1)
104
105#undef __bitmask
106#define __bitmask(item, nr_bits) __dynamic_array(char, item, -1)
107
108#undef TP_STRUCT__entry
109#define TP_STRUCT__entry(args...) args
110
111#undef DECLARE_EVENT_CLASS
112#define DECLARE_EVENT_CLASS(name, proto, args, tstruct, assign, print) \
113 struct trace_event_raw_##name { \
114 struct trace_entry ent; \
115 tstruct \
116 char __data[0]; \
117 }; \
118 \
119 static struct trace_event_class event_class_##name;
120
121#undef DEFINE_EVENT
122#define DEFINE_EVENT(template, name, proto, args) \
123 static struct trace_event_call __used \
124 __attribute__((__aligned__(4))) event_##name
125
126#undef DEFINE_EVENT_FN
127#define DEFINE_EVENT_FN(template, name, proto, args, reg, unreg) \
128 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
129
130#undef DEFINE_EVENT_PRINT
131#define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
132 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
133
134/* Callbacks are meaningless to ftrace. */
135#undef TRACE_EVENT_FN
136#define TRACE_EVENT_FN(name, proto, args, tstruct, \
137 assign, print, reg, unreg) \
138 TRACE_EVENT(name, PARAMS(proto), PARAMS(args), \
139 PARAMS(tstruct), PARAMS(assign), PARAMS(print)) \
140
141#undef TRACE_EVENT_FN_COND
142#define TRACE_EVENT_FN_COND(name, proto, args, cond, tstruct, \
143 assign, print, reg, unreg) \
144 TRACE_EVENT_CONDITION(name, PARAMS(proto), PARAMS(args), PARAMS(cond), \
145 PARAMS(tstruct), PARAMS(assign), PARAMS(print)) \
146
147#undef TRACE_EVENT_FLAGS
148#define TRACE_EVENT_FLAGS(name, value) \
149 __TRACE_EVENT_FLAGS(name, value)
150
151#undef TRACE_EVENT_PERF_PERM
152#define TRACE_EVENT_PERF_PERM(name, expr...) \
153 __TRACE_EVENT_PERF_PERM(name, expr)
154
155#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
156
157/*
158 * Stage 2 of the trace events.
159 *
160 * Include the following:
161 *
162 * struct trace_event_data_offsets_<call> {
163 * u32 <item1>;
164 * u32 <item2>;
165 * [...]
166 * };
167 *
168 * The __dynamic_array() macro will create each u32 <item>, this is
169 * to keep the offset of each array from the beginning of the event.
170 * The size of an array is also encoded, in the higher 16 bits of <item>.
171 */
172
173#undef TRACE_DEFINE_ENUM
174#define TRACE_DEFINE_ENUM(a)
175
176#undef TRACE_DEFINE_SIZEOF
177#define TRACE_DEFINE_SIZEOF(a)
178
179#undef __field
180#define __field(type, item)
181
182#undef __field_ext
183#define __field_ext(type, item, filter_type)
184
185#undef __field_struct
186#define __field_struct(type, item)
187
188#undef __field_struct_ext
189#define __field_struct_ext(type, item, filter_type)
190
191#undef __array
192#define __array(type, item, len)
193
194#undef __dynamic_array
195#define __dynamic_array(type, item, len) u32 item;
196
197#undef __string
198#define __string(item, src) __dynamic_array(char, item, -1)
199
200#undef __bitmask
201#define __bitmask(item, nr_bits) __dynamic_array(unsigned long, item, -1)
202
203#undef DECLARE_EVENT_CLASS
204#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
205 struct trace_event_data_offsets_##call { \
206 tstruct; \
207 };
208
209#undef DEFINE_EVENT
210#define DEFINE_EVENT(template, name, proto, args)
211
212#undef DEFINE_EVENT_PRINT
213#define DEFINE_EVENT_PRINT(template, name, proto, args, print)
214
215#undef TRACE_EVENT_FLAGS
216#define TRACE_EVENT_FLAGS(event, flag)
217
218#undef TRACE_EVENT_PERF_PERM
219#define TRACE_EVENT_PERF_PERM(event, expr...)
220
221#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
222
223/*
224 * Stage 3 of the trace events.
225 *
226 * Override the macros in the event tracepoint header <trace/events/XXX.h>
227 * to include the following:
228 *
229 * enum print_line_t
230 * trace_raw_output_<call>(struct trace_iterator *iter, int flags)
231 * {
232 * struct trace_seq *s = &iter->seq;
233 * struct trace_event_raw_<call> *field; <-- defined in stage 1
234 * struct trace_entry *entry;
235 * struct trace_seq *p = &iter->tmp_seq;
236 * int ret;
237 *
238 * entry = iter->ent;
239 *
240 * if (entry->type != event_<call>->event.type) {
241 * WARN_ON_ONCE(1);
242 * return TRACE_TYPE_UNHANDLED;
243 * }
244 *
245 * field = (typeof(field))entry;
246 *
247 * trace_seq_init(p);
248 * ret = trace_seq_printf(s, "%s: ", <call>);
249 * if (ret)
250 * ret = trace_seq_printf(s, <TP_printk> "\n");
251 * if (!ret)
252 * return TRACE_TYPE_PARTIAL_LINE;
253 *
254 * return TRACE_TYPE_HANDLED;
255 * }
256 *
257 * This is the method used to print the raw event to the trace
258 * output format. Note, this is not needed if the data is read
259 * in binary.
260 */
261
262#undef __entry
263#define __entry field
264
265#undef TP_printk
266#define TP_printk(fmt, args...) fmt "\n", args
267
268#undef __get_dynamic_array
269#define __get_dynamic_array(field) \
270 ((void *)__entry + (__entry->__data_loc_##field & 0xffff))
271
272#undef __get_dynamic_array_len
273#define __get_dynamic_array_len(field) \
274 ((__entry->__data_loc_##field >> 16) & 0xffff)
275
276#undef __get_str
277#define __get_str(field) ((char *)__get_dynamic_array(field))
278
279#undef __get_bitmask
280#define __get_bitmask(field) \
281 ({ \
282 void *__bitmask = __get_dynamic_array(field); \
283 unsigned int __bitmask_size; \
284 __bitmask_size = __get_dynamic_array_len(field); \
285 trace_print_bitmask_seq(p, __bitmask, __bitmask_size); \
286 })
287
288#undef __print_flags
289#define __print_flags(flag, delim, flag_array...) \
290 ({ \
291 static const struct trace_print_flags __flags[] = \
292 { flag_array, { -1, NULL }}; \
293 trace_print_flags_seq(p, delim, flag, __flags); \
294 })
295
296#undef __print_symbolic
297#define __print_symbolic(value, symbol_array...) \
298 ({ \
299 static const struct trace_print_flags symbols[] = \
300 { symbol_array, { -1, NULL }}; \
301 trace_print_symbols_seq(p, value, symbols); \
302 })
303
304#undef __print_flags_u64
305#undef __print_symbolic_u64
306#if BITS_PER_LONG == 32
307#define __print_flags_u64(flag, delim, flag_array...) \
308 ({ \
309 static const struct trace_print_flags_u64 __flags[] = \
310 { flag_array, { -1, NULL } }; \
311 trace_print_flags_seq_u64(p, delim, flag, __flags); \
312 })
313
314#define __print_symbolic_u64(value, symbol_array...) \
315 ({ \
316 static const struct trace_print_flags_u64 symbols[] = \
317 { symbol_array, { -1, NULL } }; \
318 trace_print_symbols_seq_u64(p, value, symbols); \
319 })
320#else
321#define __print_flags_u64(flag, delim, flag_array...) \
322 __print_flags(flag, delim, flag_array)
323
324#define __print_symbolic_u64(value, symbol_array...) \
325 __print_symbolic(value, symbol_array)
326#endif
327
328#undef __print_hex
329#define __print_hex(buf, buf_len) \
330 trace_print_hex_seq(p, buf, buf_len, false)
331
332#undef __print_hex_str
333#define __print_hex_str(buf, buf_len) \
334 trace_print_hex_seq(p, buf, buf_len, true)
335
336#undef __print_array
337#define __print_array(array, count, el_size) \
338 ({ \
339 BUILD_BUG_ON(el_size != 1 && el_size != 2 && \
340 el_size != 4 && el_size != 8); \
341 trace_print_array_seq(p, array, count, el_size); \
342 })
343
344#undef __print_hex_dump
345#define __print_hex_dump(prefix_str, prefix_type, \
346 rowsize, groupsize, buf, len, ascii) \
347 trace_print_hex_dump_seq(p, prefix_str, prefix_type, \
348 rowsize, groupsize, buf, len, ascii)
349
350#undef DECLARE_EVENT_CLASS
351#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
352static notrace enum print_line_t \
353trace_raw_output_##call(struct trace_iterator *iter, int flags, \
354 struct trace_event *trace_event) \
355{ \
356 struct trace_seq *s = &iter->seq; \
357 struct trace_seq __maybe_unused *p = &iter->tmp_seq; \
358 struct trace_event_raw_##call *field; \
359 int ret; \
360 \
361 field = (typeof(field))iter->ent; \
362 \
363 ret = trace_raw_output_prep(iter, trace_event); \
364 if (ret != TRACE_TYPE_HANDLED) \
365 return ret; \
366 \
367 trace_seq_printf(s, print); \
368 \
369 return trace_handle_return(s); \
370} \
371static struct trace_event_functions trace_event_type_funcs_##call = { \
372 .trace = trace_raw_output_##call, \
373};
374
375#undef DEFINE_EVENT_PRINT
376#define DEFINE_EVENT_PRINT(template, call, proto, args, print) \
377static notrace enum print_line_t \
378trace_raw_output_##call(struct trace_iterator *iter, int flags, \
379 struct trace_event *event) \
380{ \
381 struct trace_event_raw_##template *field; \
382 struct trace_entry *entry; \
383 struct trace_seq *p = &iter->tmp_seq; \
384 \
385 entry = iter->ent; \
386 \
387 if (entry->type != event_##call.event.type) { \
388 WARN_ON_ONCE(1); \
389 return TRACE_TYPE_UNHANDLED; \
390 } \
391 \
392 field = (typeof(field))entry; \
393 \
394 trace_seq_init(p); \
395 return trace_output_call(iter, #call, print); \
396} \
397static struct trace_event_functions trace_event_type_funcs_##call = { \
398 .trace = trace_raw_output_##call, \
399};
400
401#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
402
403#undef __field_ext
404#define __field_ext(_type, _item, _filter_type) { \
405 .type = #_type, .name = #_item, \
406 .size = sizeof(_type), .align = __alignof__(_type), \
407 .is_signed = is_signed_type(_type), .filter_type = _filter_type },
408
409#undef __field_struct_ext
410#define __field_struct_ext(_type, _item, _filter_type) { \
411 .type = #_type, .name = #_item, \
412 .size = sizeof(_type), .align = __alignof__(_type), \
413 0, .filter_type = _filter_type },
414
415#undef __field
416#define __field(type, item) __field_ext(type, item, FILTER_OTHER)
417
418#undef __field_struct
419#define __field_struct(type, item) __field_struct_ext(type, item, FILTER_OTHER)
420
421#undef __array
422#define __array(_type, _item, _len) { \
423 .type = #_type"["__stringify(_len)"]", .name = #_item, \
424 .size = sizeof(_type[_len]), .align = __alignof__(_type), \
425 .is_signed = is_signed_type(_type), .filter_type = FILTER_OTHER },
426
427#undef __dynamic_array
428#define __dynamic_array(_type, _item, _len) { \
429 .type = "__data_loc " #_type "[]", .name = #_item, \
430 .size = 4, .align = 4, \
431 .is_signed = is_signed_type(_type), .filter_type = FILTER_OTHER },
432
433#undef __string
434#define __string(item, src) __dynamic_array(char, item, -1)
435
436#undef __bitmask
437#define __bitmask(item, nr_bits) __dynamic_array(unsigned long, item, -1)
438
439#undef DECLARE_EVENT_CLASS
440#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, func, print) \
441static struct trace_event_fields trace_event_fields_##call[] = { \
442 tstruct \
443 {} };
444
445#undef DEFINE_EVENT_PRINT
446#define DEFINE_EVENT_PRINT(template, name, proto, args, print)
447
448#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
449
450/*
451 * remember the offset of each array from the beginning of the event.
452 */
453
454#undef __entry
455#define __entry entry
456
457#undef __field
458#define __field(type, item)
459
460#undef __field_ext
461#define __field_ext(type, item, filter_type)
462
463#undef __field_struct
464#define __field_struct(type, item)
465
466#undef __field_struct_ext
467#define __field_struct_ext(type, item, filter_type)
468
469#undef __array
470#define __array(type, item, len)
471
472#undef __dynamic_array
473#define __dynamic_array(type, item, len) \
474 __item_length = (len) * sizeof(type); \
475 __data_offsets->item = __data_size + \
476 offsetof(typeof(*entry), __data); \
477 __data_offsets->item |= __item_length << 16; \
478 __data_size += __item_length;
479
480#undef __string
481#define __string(item, src) __dynamic_array(char, item, \
482 strlen((src) ? (const char *)(src) : "(null)") + 1)
483
484/*
485 * __bitmask_size_in_bytes_raw is the number of bytes needed to hold
486 * num_possible_cpus().
487 */
488#define __bitmask_size_in_bytes_raw(nr_bits) \
489 (((nr_bits) + 7) / 8)
490
491#define __bitmask_size_in_longs(nr_bits) \
492 ((__bitmask_size_in_bytes_raw(nr_bits) + \
493 ((BITS_PER_LONG / 8) - 1)) / (BITS_PER_LONG / 8))
494
495/*
496 * __bitmask_size_in_bytes is the number of bytes needed to hold
497 * num_possible_cpus() padded out to the nearest long. This is what
498 * is saved in the buffer, just to be consistent.
499 */
500#define __bitmask_size_in_bytes(nr_bits) \
501 (__bitmask_size_in_longs(nr_bits) * (BITS_PER_LONG / 8))
502
503#undef __bitmask
504#define __bitmask(item, nr_bits) __dynamic_array(unsigned long, item, \
505 __bitmask_size_in_longs(nr_bits))
506
507#undef DECLARE_EVENT_CLASS
508#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
509static inline notrace int trace_event_get_offsets_##call( \
510 struct trace_event_data_offsets_##call *__data_offsets, proto) \
511{ \
512 int __data_size = 0; \
513 int __maybe_unused __item_length; \
514 struct trace_event_raw_##call __maybe_unused *entry; \
515 \
516 tstruct; \
517 \
518 return __data_size; \
519}
520
521#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
522
523/*
524 * Stage 4 of the trace events.
525 *
526 * Override the macros in the event tracepoint header <trace/events/XXX.h>
527 * to include the following:
528 *
529 * For those macros defined with TRACE_EVENT:
530 *
531 * static struct trace_event_call event_<call>;
532 *
533 * static void trace_event_raw_event_<call>(void *__data, proto)
534 * {
535 * struct trace_event_file *trace_file = __data;
536 * struct trace_event_call *event_call = trace_file->event_call;
537 * struct trace_event_data_offsets_<call> __maybe_unused __data_offsets;
538 * unsigned long eflags = trace_file->flags;
539 * enum event_trigger_type __tt = ETT_NONE;
540 * struct ring_buffer_event *event;
541 * struct trace_event_raw_<call> *entry; <-- defined in stage 1
542 * struct trace_buffer *buffer;
543 * unsigned long irq_flags;
544 * int __data_size;
545 * int pc;
546 *
547 * if (!(eflags & EVENT_FILE_FL_TRIGGER_COND)) {
548 * if (eflags & EVENT_FILE_FL_TRIGGER_MODE)
549 * event_triggers_call(trace_file, NULL);
550 * if (eflags & EVENT_FILE_FL_SOFT_DISABLED)
551 * return;
552 * }
553 *
554 * local_save_flags(irq_flags);
555 * pc = preempt_count();
556 *
557 * __data_size = trace_event_get_offsets_<call>(&__data_offsets, args);
558 *
559 * event = trace_event_buffer_lock_reserve(&buffer, trace_file,
560 * event_<call>->event.type,
561 * sizeof(*entry) + __data_size,
562 * irq_flags, pc);
563 * if (!event)
564 * return;
565 * entry = ring_buffer_event_data(event);
566 *
567 * { <assign>; } <-- Here we assign the entries by the __field and
568 * __array macros.
569 *
570 * if (eflags & EVENT_FILE_FL_TRIGGER_COND)
571 * __tt = event_triggers_call(trace_file, entry);
572 *
573 * if (test_bit(EVENT_FILE_FL_SOFT_DISABLED_BIT,
574 * &trace_file->flags))
575 * ring_buffer_discard_commit(buffer, event);
576 * else if (!filter_check_discard(trace_file, entry, buffer, event))
577 * trace_buffer_unlock_commit(buffer, event, irq_flags, pc);
578 *
579 * if (__tt)
580 * event_triggers_post_call(trace_file, __tt);
581 * }
582 *
583 * static struct trace_event ftrace_event_type_<call> = {
584 * .trace = trace_raw_output_<call>, <-- stage 2
585 * };
586 *
587 * static char print_fmt_<call>[] = <TP_printk>;
588 *
589 * static struct trace_event_class __used event_class_<template> = {
590 * .system = "<system>",
591 * .fields_array = trace_event_fields_<call>,
592 * .fields = LIST_HEAD_INIT(event_class_##call.fields),
593 * .raw_init = trace_event_raw_init,
594 * .probe = trace_event_raw_event_##call,
595 * .reg = trace_event_reg,
596 * };
597 *
598 * static struct trace_event_call event_<call> = {
599 * .class = event_class_<template>,
600 * {
601 * .tp = &__tracepoint_<call>,
602 * },
603 * .event = &ftrace_event_type_<call>,
604 * .print_fmt = print_fmt_<call>,
605 * .flags = TRACE_EVENT_FL_TRACEPOINT,
606 * };
607 * // its only safe to use pointers when doing linker tricks to
608 * // create an array.
609 * static struct trace_event_call __used
610 * __attribute__((section("_ftrace_events"))) *__event_<call> = &event_<call>;
611 *
612 */
613
614#ifdef CONFIG_PERF_EVENTS
615
616#define _TRACE_PERF_PROTO(call, proto) \
617 static notrace void \
618 perf_trace_##call(void *__data, proto);
619
620#define _TRACE_PERF_INIT(call) \
621 .perf_probe = perf_trace_##call,
622
623#else
624#define _TRACE_PERF_PROTO(call, proto)
625#define _TRACE_PERF_INIT(call)
626#endif /* CONFIG_PERF_EVENTS */
627
628#undef __entry
629#define __entry entry
630
631#undef __field
632#define __field(type, item)
633
634#undef __field_struct
635#define __field_struct(type, item)
636
637#undef __array
638#define __array(type, item, len)
639
640#undef __dynamic_array
641#define __dynamic_array(type, item, len) \
642 __entry->__data_loc_##item = __data_offsets.item;
643
644#undef __string
645#define __string(item, src) __dynamic_array(char, item, -1)
646
647#undef __assign_str
648#define __assign_str(dst, src) \
649 strcpy(__get_str(dst), (src) ? (const char *)(src) : "(null)");
650
651#undef __bitmask
652#define __bitmask(item, nr_bits) __dynamic_array(unsigned long, item, -1)
653
654#undef __get_bitmask
655#define __get_bitmask(field) (char *)__get_dynamic_array(field)
656
657#undef __assign_bitmask
658#define __assign_bitmask(dst, src, nr_bits) \
659 memcpy(__get_bitmask(dst), (src), __bitmask_size_in_bytes(nr_bits))
660
661#undef TP_fast_assign
662#define TP_fast_assign(args...) args
663
664#undef __perf_count
665#define __perf_count(c) (c)
666
667#undef __perf_task
668#define __perf_task(t) (t)
669
670#undef DECLARE_EVENT_CLASS
671#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
672 \
673static notrace void \
674trace_event_raw_event_##call(void *__data, proto) \
675{ \
676 struct trace_event_file *trace_file = __data; \
677 struct trace_event_data_offsets_##call __maybe_unused __data_offsets;\
678 struct trace_event_buffer fbuffer; \
679 struct trace_event_raw_##call *entry; \
680 int __data_size; \
681 \
682 if (trace_trigger_soft_disabled(trace_file)) \
683 return; \
684 \
685 __data_size = trace_event_get_offsets_##call(&__data_offsets, args); \
686 \
687 entry = trace_event_buffer_reserve(&fbuffer, trace_file, \
688 sizeof(*entry) + __data_size); \
689 \
690 if (!entry) \
691 return; \
692 \
693 tstruct \
694 \
695 { assign; } \
696 \
697 trace_event_buffer_commit(&fbuffer); \
698}
699/*
700 * The ftrace_test_probe is compiled out, it is only here as a build time check
701 * to make sure that if the tracepoint handling changes, the ftrace probe will
702 * fail to compile unless it too is updated.
703 */
704
705#undef DEFINE_EVENT
706#define DEFINE_EVENT(template, call, proto, args) \
707static inline void ftrace_test_probe_##call(void) \
708{ \
709 check_trace_callback_type_##call(trace_event_raw_event_##template); \
710}
711
712#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
713
714#undef __entry
715#define __entry REC
716
717#undef __print_flags
718#undef __print_symbolic
719#undef __print_hex
720#undef __print_hex_str
721#undef __get_dynamic_array
722#undef __get_dynamic_array_len
723#undef __get_str
724#undef __get_bitmask
725#undef __print_array
726#undef __print_hex_dump
727
728#undef TP_printk
729#define TP_printk(fmt, args...) "\"" fmt "\", " __stringify(args)
730
731#undef DECLARE_EVENT_CLASS
732#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
733_TRACE_PERF_PROTO(call, PARAMS(proto)); \
734static char print_fmt_##call[] = print; \
735static struct trace_event_class __used __refdata event_class_##call = { \
736 .system = TRACE_SYSTEM_STRING, \
737 .fields_array = trace_event_fields_##call, \
738 .fields = LIST_HEAD_INIT(event_class_##call.fields),\
739 .raw_init = trace_event_raw_init, \
740 .probe = trace_event_raw_event_##call, \
741 .reg = trace_event_reg, \
742 _TRACE_PERF_INIT(call) \
743};
744
745#undef DEFINE_EVENT
746#define DEFINE_EVENT(template, call, proto, args) \
747 \
748static struct trace_event_call __used event_##call = { \
749 .class = &event_class_##template, \
750 { \
751 .tp = &__tracepoint_##call, \
752 }, \
753 .event.funcs = &trace_event_type_funcs_##template, \
754 .print_fmt = print_fmt_##template, \
755 .flags = TRACE_EVENT_FL_TRACEPOINT, \
756}; \
757static struct trace_event_call __used \
758__attribute__((section("_ftrace_events"))) *__event_##call = &event_##call
759
760#undef DEFINE_EVENT_PRINT
761#define DEFINE_EVENT_PRINT(template, call, proto, args, print) \
762 \
763static char print_fmt_##call[] = print; \
764 \
765static struct trace_event_call __used event_##call = { \
766 .class = &event_class_##template, \
767 { \
768 .tp = &__tracepoint_##call, \
769 }, \
770 .event.funcs = &trace_event_type_funcs_##call, \
771 .print_fmt = print_fmt_##call, \
772 .flags = TRACE_EVENT_FL_TRACEPOINT, \
773}; \
774static struct trace_event_call __used \
775__attribute__((section("_ftrace_events"))) *__event_##call = &event_##call
776
777#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)