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 __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 __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_seq *p = &iter->tmp_seq;
235 *
236 * -------(for event)-------
237 *
238 * struct trace_entry *entry;
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>, <TP_printk> "\n");
251 *
252 * ------(or, for event class)------
253 *
254 * int ret;
255 *
256 * field = (typeof(field))iter->ent;
257 *
258 * ret = trace_raw_output_prep(iter, trace_event);
259 * if (ret != TRACE_TYPE_HANDLED)
260 * return ret;
261 *
262 * trace_event_printf(iter, <TP_printk> "\n");
263 *
264 * return trace_handle_return(s);
265 * -------
266 * }
267 *
268 * This is the method used to print the raw event to the trace
269 * output format. Note, this is not needed if the data is read
270 * in binary.
271 */
272
273#undef __entry
274#define __entry field
275
276#undef TP_printk
277#define TP_printk(fmt, args...) fmt "\n", args
278
279#undef __get_dynamic_array
280#define __get_dynamic_array(field) \
281 ((void *)__entry + (__entry->__data_loc_##field & 0xffff))
282
283#undef __get_dynamic_array_len
284#define __get_dynamic_array_len(field) \
285 ((__entry->__data_loc_##field >> 16) & 0xffff)
286
287#undef __get_str
288#define __get_str(field) ((char *)__get_dynamic_array(field))
289
290#undef __get_bitmask
291#define __get_bitmask(field) \
292 ({ \
293 void *__bitmask = __get_dynamic_array(field); \
294 unsigned int __bitmask_size; \
295 __bitmask_size = __get_dynamic_array_len(field); \
296 trace_print_bitmask_seq(p, __bitmask, __bitmask_size); \
297 })
298
299#undef __print_flags
300#define __print_flags(flag, delim, flag_array...) \
301 ({ \
302 static const struct trace_print_flags __flags[] = \
303 { flag_array, { -1, NULL }}; \
304 trace_print_flags_seq(p, delim, flag, __flags); \
305 })
306
307#undef __print_symbolic
308#define __print_symbolic(value, symbol_array...) \
309 ({ \
310 static const struct trace_print_flags symbols[] = \
311 { symbol_array, { -1, NULL }}; \
312 trace_print_symbols_seq(p, value, symbols); \
313 })
314
315#undef __print_flags_u64
316#undef __print_symbolic_u64
317#if BITS_PER_LONG == 32
318#define __print_flags_u64(flag, delim, flag_array...) \
319 ({ \
320 static const struct trace_print_flags_u64 __flags[] = \
321 { flag_array, { -1, NULL } }; \
322 trace_print_flags_seq_u64(p, delim, flag, __flags); \
323 })
324
325#define __print_symbolic_u64(value, symbol_array...) \
326 ({ \
327 static const struct trace_print_flags_u64 symbols[] = \
328 { symbol_array, { -1, NULL } }; \
329 trace_print_symbols_seq_u64(p, value, symbols); \
330 })
331#else
332#define __print_flags_u64(flag, delim, flag_array...) \
333 __print_flags(flag, delim, flag_array)
334
335#define __print_symbolic_u64(value, symbol_array...) \
336 __print_symbolic(value, symbol_array)
337#endif
338
339#undef __print_hex
340#define __print_hex(buf, buf_len) \
341 trace_print_hex_seq(p, buf, buf_len, false)
342
343#undef __print_hex_str
344#define __print_hex_str(buf, buf_len) \
345 trace_print_hex_seq(p, buf, buf_len, true)
346
347#undef __print_array
348#define __print_array(array, count, el_size) \
349 ({ \
350 BUILD_BUG_ON(el_size != 1 && el_size != 2 && \
351 el_size != 4 && el_size != 8); \
352 trace_print_array_seq(p, array, count, el_size); \
353 })
354
355#undef __print_hex_dump
356#define __print_hex_dump(prefix_str, prefix_type, \
357 rowsize, groupsize, buf, len, ascii) \
358 trace_print_hex_dump_seq(p, prefix_str, prefix_type, \
359 rowsize, groupsize, buf, len, ascii)
360
361#undef __print_ns_to_secs
362#define __print_ns_to_secs(value) \
363 ({ \
364 u64 ____val = (u64)(value); \
365 do_div(____val, NSEC_PER_SEC); \
366 ____val; \
367 })
368
369#undef __print_ns_without_secs
370#define __print_ns_without_secs(value) \
371 ({ \
372 u64 ____val = (u64)(value); \
373 (u32) do_div(____val, NSEC_PER_SEC); \
374 })
375
376#undef DECLARE_EVENT_CLASS
377#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
378static notrace enum print_line_t \
379trace_raw_output_##call(struct trace_iterator *iter, int flags, \
380 struct trace_event *trace_event) \
381{ \
382 struct trace_seq *s = &iter->seq; \
383 struct trace_seq __maybe_unused *p = &iter->tmp_seq; \
384 struct trace_event_raw_##call *field; \
385 int ret; \
386 \
387 field = (typeof(field))iter->ent; \
388 \
389 ret = trace_raw_output_prep(iter, trace_event); \
390 if (ret != TRACE_TYPE_HANDLED) \
391 return ret; \
392 \
393 trace_event_printf(iter, print); \
394 \
395 return trace_handle_return(s); \
396} \
397static struct trace_event_functions trace_event_type_funcs_##call = { \
398 .trace = trace_raw_output_##call, \
399};
400
401#undef DEFINE_EVENT_PRINT
402#define DEFINE_EVENT_PRINT(template, call, proto, args, print) \
403static notrace enum print_line_t \
404trace_raw_output_##call(struct trace_iterator *iter, int flags, \
405 struct trace_event *event) \
406{ \
407 struct trace_event_raw_##template *field; \
408 struct trace_entry *entry; \
409 struct trace_seq *p = &iter->tmp_seq; \
410 \
411 entry = iter->ent; \
412 \
413 if (entry->type != event_##call.event.type) { \
414 WARN_ON_ONCE(1); \
415 return TRACE_TYPE_UNHANDLED; \
416 } \
417 \
418 field = (typeof(field))entry; \
419 \
420 trace_seq_init(p); \
421 return trace_output_call(iter, #call, print); \
422} \
423static struct trace_event_functions trace_event_type_funcs_##call = { \
424 .trace = trace_raw_output_##call, \
425};
426
427#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
428
429#undef __field_ext
430#define __field_ext(_type, _item, _filter_type) { \
431 .type = #_type, .name = #_item, \
432 .size = sizeof(_type), .align = __alignof__(_type), \
433 .is_signed = is_signed_type(_type), .filter_type = _filter_type },
434
435#undef __field_struct_ext
436#define __field_struct_ext(_type, _item, _filter_type) { \
437 .type = #_type, .name = #_item, \
438 .size = sizeof(_type), .align = __alignof__(_type), \
439 0, .filter_type = _filter_type },
440
441#undef __field
442#define __field(type, item) __field_ext(type, item, FILTER_OTHER)
443
444#undef __field_struct
445#define __field_struct(type, item) __field_struct_ext(type, item, FILTER_OTHER)
446
447#undef __array
448#define __array(_type, _item, _len) { \
449 .type = #_type"["__stringify(_len)"]", .name = #_item, \
450 .size = sizeof(_type[_len]), .align = __alignof__(_type), \
451 .is_signed = is_signed_type(_type), .filter_type = FILTER_OTHER },
452
453#undef __dynamic_array
454#define __dynamic_array(_type, _item, _len) { \
455 .type = "__data_loc " #_type "[]", .name = #_item, \
456 .size = 4, .align = 4, \
457 .is_signed = is_signed_type(_type), .filter_type = FILTER_OTHER },
458
459#undef __string
460#define __string(item, src) __dynamic_array(char, item, -1)
461
462#undef __bitmask
463#define __bitmask(item, nr_bits) __dynamic_array(unsigned long, item, -1)
464
465#undef DECLARE_EVENT_CLASS
466#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, func, print) \
467static struct trace_event_fields trace_event_fields_##call[] = { \
468 tstruct \
469 {} };
470
471#undef DEFINE_EVENT_PRINT
472#define DEFINE_EVENT_PRINT(template, name, proto, args, print)
473
474#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
475
476/*
477 * remember the offset of each array from the beginning of the event.
478 */
479
480#undef __entry
481#define __entry entry
482
483#undef __field
484#define __field(type, item)
485
486#undef __field_ext
487#define __field_ext(type, item, filter_type)
488
489#undef __field_struct
490#define __field_struct(type, item)
491
492#undef __field_struct_ext
493#define __field_struct_ext(type, item, filter_type)
494
495#undef __array
496#define __array(type, item, len)
497
498#undef __dynamic_array
499#define __dynamic_array(type, item, len) \
500 __item_length = (len) * sizeof(type); \
501 __data_offsets->item = __data_size + \
502 offsetof(typeof(*entry), __data); \
503 __data_offsets->item |= __item_length << 16; \
504 __data_size += __item_length;
505
506#undef __string
507#define __string(item, src) __dynamic_array(char, item, \
508 strlen((src) ? (const char *)(src) : "(null)") + 1)
509
510/*
511 * __bitmask_size_in_bytes_raw is the number of bytes needed to hold
512 * num_possible_cpus().
513 */
514#define __bitmask_size_in_bytes_raw(nr_bits) \
515 (((nr_bits) + 7) / 8)
516
517#define __bitmask_size_in_longs(nr_bits) \
518 ((__bitmask_size_in_bytes_raw(nr_bits) + \
519 ((BITS_PER_LONG / 8) - 1)) / (BITS_PER_LONG / 8))
520
521/*
522 * __bitmask_size_in_bytes is the number of bytes needed to hold
523 * num_possible_cpus() padded out to the nearest long. This is what
524 * is saved in the buffer, just to be consistent.
525 */
526#define __bitmask_size_in_bytes(nr_bits) \
527 (__bitmask_size_in_longs(nr_bits) * (BITS_PER_LONG / 8))
528
529#undef __bitmask
530#define __bitmask(item, nr_bits) __dynamic_array(unsigned long, item, \
531 __bitmask_size_in_longs(nr_bits))
532
533#undef DECLARE_EVENT_CLASS
534#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
535static inline notrace int trace_event_get_offsets_##call( \
536 struct trace_event_data_offsets_##call *__data_offsets, proto) \
537{ \
538 int __data_size = 0; \
539 int __maybe_unused __item_length; \
540 struct trace_event_raw_##call __maybe_unused *entry; \
541 \
542 tstruct; \
543 \
544 return __data_size; \
545}
546
547#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
548
549/*
550 * Stage 4 of the trace events.
551 *
552 * Override the macros in the event tracepoint header <trace/events/XXX.h>
553 * to include the following:
554 *
555 * For those macros defined with TRACE_EVENT:
556 *
557 * static struct trace_event_call event_<call>;
558 *
559 * static void trace_event_raw_event_<call>(void *__data, proto)
560 * {
561 * struct trace_event_file *trace_file = __data;
562 * struct trace_event_call *event_call = trace_file->event_call;
563 * struct trace_event_data_offsets_<call> __maybe_unused __data_offsets;
564 * unsigned long eflags = trace_file->flags;
565 * enum event_trigger_type __tt = ETT_NONE;
566 * struct ring_buffer_event *event;
567 * struct trace_event_raw_<call> *entry; <-- defined in stage 1
568 * struct trace_buffer *buffer;
569 * unsigned long irq_flags;
570 * int __data_size;
571 * int pc;
572 *
573 * if (!(eflags & EVENT_FILE_FL_TRIGGER_COND)) {
574 * if (eflags & EVENT_FILE_FL_TRIGGER_MODE)
575 * event_triggers_call(trace_file, NULL);
576 * if (eflags & EVENT_FILE_FL_SOFT_DISABLED)
577 * return;
578 * }
579 *
580 * local_save_flags(irq_flags);
581 * pc = preempt_count();
582 *
583 * __data_size = trace_event_get_offsets_<call>(&__data_offsets, args);
584 *
585 * event = trace_event_buffer_lock_reserve(&buffer, trace_file,
586 * event_<call>->event.type,
587 * sizeof(*entry) + __data_size,
588 * irq_flags, pc);
589 * if (!event)
590 * return;
591 * entry = ring_buffer_event_data(event);
592 *
593 * { <assign>; } <-- Here we assign the entries by the __field and
594 * __array macros.
595 *
596 * if (eflags & EVENT_FILE_FL_TRIGGER_COND)
597 * __tt = event_triggers_call(trace_file, entry);
598 *
599 * if (test_bit(EVENT_FILE_FL_SOFT_DISABLED_BIT,
600 * &trace_file->flags))
601 * ring_buffer_discard_commit(buffer, event);
602 * else if (!filter_check_discard(trace_file, entry, buffer, event))
603 * trace_buffer_unlock_commit(buffer, event, irq_flags, pc);
604 *
605 * if (__tt)
606 * event_triggers_post_call(trace_file, __tt);
607 * }
608 *
609 * static struct trace_event ftrace_event_type_<call> = {
610 * .trace = trace_raw_output_<call>, <-- stage 2
611 * };
612 *
613 * static char print_fmt_<call>[] = <TP_printk>;
614 *
615 * static struct trace_event_class __used event_class_<template> = {
616 * .system = "<system>",
617 * .fields_array = trace_event_fields_<call>,
618 * .fields = LIST_HEAD_INIT(event_class_##call.fields),
619 * .raw_init = trace_event_raw_init,
620 * .probe = trace_event_raw_event_##call,
621 * .reg = trace_event_reg,
622 * };
623 *
624 * static struct trace_event_call event_<call> = {
625 * .class = event_class_<template>,
626 * {
627 * .tp = &__tracepoint_<call>,
628 * },
629 * .event = &ftrace_event_type_<call>,
630 * .print_fmt = print_fmt_<call>,
631 * .flags = TRACE_EVENT_FL_TRACEPOINT,
632 * };
633 * // its only safe to use pointers when doing linker tricks to
634 * // create an array.
635 * static struct trace_event_call __used
636 * __section("_ftrace_events") *__event_<call> = &event_<call>;
637 *
638 */
639
640#ifdef CONFIG_PERF_EVENTS
641
642#define _TRACE_PERF_PROTO(call, proto) \
643 static notrace void \
644 perf_trace_##call(void *__data, proto);
645
646#define _TRACE_PERF_INIT(call) \
647 .perf_probe = perf_trace_##call,
648
649#else
650#define _TRACE_PERF_PROTO(call, proto)
651#define _TRACE_PERF_INIT(call)
652#endif /* CONFIG_PERF_EVENTS */
653
654#undef __entry
655#define __entry entry
656
657#undef __field
658#define __field(type, item)
659
660#undef __field_struct
661#define __field_struct(type, item)
662
663#undef __array
664#define __array(type, item, len)
665
666#undef __dynamic_array
667#define __dynamic_array(type, item, len) \
668 __entry->__data_loc_##item = __data_offsets.item;
669
670#undef __string
671#define __string(item, src) __dynamic_array(char, item, -1)
672
673#undef __assign_str
674#define __assign_str(dst, src) \
675 strcpy(__get_str(dst), (src) ? (const char *)(src) : "(null)");
676
677#undef __bitmask
678#define __bitmask(item, nr_bits) __dynamic_array(unsigned long, item, -1)
679
680#undef __get_bitmask
681#define __get_bitmask(field) (char *)__get_dynamic_array(field)
682
683#undef __assign_bitmask
684#define __assign_bitmask(dst, src, nr_bits) \
685 memcpy(__get_bitmask(dst), (src), __bitmask_size_in_bytes(nr_bits))
686
687#undef TP_fast_assign
688#define TP_fast_assign(args...) args
689
690#undef __perf_count
691#define __perf_count(c) (c)
692
693#undef __perf_task
694#define __perf_task(t) (t)
695
696#undef DECLARE_EVENT_CLASS
697#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
698 \
699static notrace void \
700trace_event_raw_event_##call(void *__data, proto) \
701{ \
702 struct trace_event_file *trace_file = __data; \
703 struct trace_event_data_offsets_##call __maybe_unused __data_offsets;\
704 struct trace_event_buffer fbuffer; \
705 struct trace_event_raw_##call *entry; \
706 int __data_size; \
707 \
708 if (trace_trigger_soft_disabled(trace_file)) \
709 return; \
710 \
711 __data_size = trace_event_get_offsets_##call(&__data_offsets, args); \
712 \
713 entry = trace_event_buffer_reserve(&fbuffer, trace_file, \
714 sizeof(*entry) + __data_size); \
715 \
716 if (!entry) \
717 return; \
718 \
719 tstruct \
720 \
721 { assign; } \
722 \
723 trace_event_buffer_commit(&fbuffer); \
724}
725/*
726 * The ftrace_test_probe is compiled out, it is only here as a build time check
727 * to make sure that if the tracepoint handling changes, the ftrace probe will
728 * fail to compile unless it too is updated.
729 */
730
731#undef DEFINE_EVENT
732#define DEFINE_EVENT(template, call, proto, args) \
733static inline void ftrace_test_probe_##call(void) \
734{ \
735 check_trace_callback_type_##call(trace_event_raw_event_##template); \
736}
737
738#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
739
740#undef __entry
741#define __entry REC
742
743#undef __print_flags
744#undef __print_symbolic
745#undef __print_hex
746#undef __print_hex_str
747#undef __get_dynamic_array
748#undef __get_dynamic_array_len
749#undef __get_str
750#undef __get_bitmask
751#undef __print_array
752#undef __print_hex_dump
753
754/*
755 * The below is not executed in the kernel. It is only what is
756 * displayed in the print format for userspace to parse.
757 */
758#undef __print_ns_to_secs
759#define __print_ns_to_secs(val) (val) / 1000000000UL
760
761#undef __print_ns_without_secs
762#define __print_ns_without_secs(val) (val) % 1000000000UL
763
764#undef TP_printk
765#define TP_printk(fmt, args...) "\"" fmt "\", " __stringify(args)
766
767#undef DECLARE_EVENT_CLASS
768#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
769_TRACE_PERF_PROTO(call, PARAMS(proto)); \
770static char print_fmt_##call[] = print; \
771static struct trace_event_class __used __refdata event_class_##call = { \
772 .system = TRACE_SYSTEM_STRING, \
773 .fields_array = trace_event_fields_##call, \
774 .fields = LIST_HEAD_INIT(event_class_##call.fields),\
775 .raw_init = trace_event_raw_init, \
776 .probe = trace_event_raw_event_##call, \
777 .reg = trace_event_reg, \
778 _TRACE_PERF_INIT(call) \
779};
780
781#undef DEFINE_EVENT
782#define DEFINE_EVENT(template, call, proto, args) \
783 \
784static struct trace_event_call __used event_##call = { \
785 .class = &event_class_##template, \
786 { \
787 .tp = &__tracepoint_##call, \
788 }, \
789 .event.funcs = &trace_event_type_funcs_##template, \
790 .print_fmt = print_fmt_##template, \
791 .flags = TRACE_EVENT_FL_TRACEPOINT, \
792}; \
793static struct trace_event_call __used \
794__section("_ftrace_events") *__event_##call = &event_##call
795
796#undef DEFINE_EVENT_PRINT
797#define DEFINE_EVENT_PRINT(template, call, proto, args, print) \
798 \
799static char print_fmt_##call[] = print; \
800 \
801static struct trace_event_call __used event_##call = { \
802 .class = &event_class_##template, \
803 { \
804 .tp = &__tracepoint_##call, \
805 }, \
806 .event.funcs = &trace_event_type_funcs_##call, \
807 .print_fmt = print_fmt_##call, \
808 .flags = TRACE_EVENT_FL_TRACEPOINT, \
809}; \
810static struct trace_event_call __used \
811__section("_ftrace_events") *__event_##call = &event_##call
812
813#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)