xref: /linux/include/trace/trace_events.h (revision f3e4080edd2754abbdc3daf9881b1f6e168c6669)
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 
36 TRACE_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 __string_len
106 #define __string_len(item, src, len) __dynamic_array(char, item, -1)
107 
108 #undef __bitmask
109 #define __bitmask(item, nr_bits) __dynamic_array(char, item, -1)
110 
111 #undef __sockaddr
112 #define __sockaddr(field, len) __dynamic_array(u8, field, len)
113 
114 #undef __rel_dynamic_array
115 #define __rel_dynamic_array(type, item, len) u32 __rel_loc_##item;
116 
117 #undef __rel_string
118 #define __rel_string(item, src) __rel_dynamic_array(char, item, -1)
119 
120 #undef __rel_string_len
121 #define __rel_string_len(item, src, len) __rel_dynamic_array(char, item, -1)
122 
123 #undef __rel_bitmask
124 #define __rel_bitmask(item, nr_bits) __rel_dynamic_array(char, item, -1)
125 
126 #undef __rel_sockaddr
127 #define __rel_sockaddr(field, len) __rel_dynamic_array(u8, field, len)
128 
129 #undef TP_STRUCT__entry
130 #define TP_STRUCT__entry(args...) args
131 
132 #undef DECLARE_EVENT_CLASS
133 #define DECLARE_EVENT_CLASS(name, proto, args, tstruct, assign, print)	\
134 	struct trace_event_raw_##name {					\
135 		struct trace_entry	ent;				\
136 		tstruct							\
137 		char			__data[];			\
138 	};								\
139 									\
140 	static struct trace_event_class event_class_##name;
141 
142 #undef DEFINE_EVENT
143 #define DEFINE_EVENT(template, name, proto, args)	\
144 	static struct trace_event_call	__used		\
145 	__attribute__((__aligned__(4))) event_##name
146 
147 #undef DEFINE_EVENT_FN
148 #define DEFINE_EVENT_FN(template, name, proto, args, reg, unreg)	\
149 	DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
150 
151 #undef DEFINE_EVENT_PRINT
152 #define DEFINE_EVENT_PRINT(template, name, proto, args, print)	\
153 	DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
154 
155 /* Callbacks are meaningless to ftrace. */
156 #undef TRACE_EVENT_FN
157 #define TRACE_EVENT_FN(name, proto, args, tstruct,			\
158 		assign, print, reg, unreg)				\
159 	TRACE_EVENT(name, PARAMS(proto), PARAMS(args),			\
160 		PARAMS(tstruct), PARAMS(assign), PARAMS(print))		\
161 
162 #undef TRACE_EVENT_FN_COND
163 #define TRACE_EVENT_FN_COND(name, proto, args, cond, tstruct,	\
164 		assign, print, reg, unreg)				\
165 	TRACE_EVENT_CONDITION(name, PARAMS(proto), PARAMS(args), PARAMS(cond),		\
166 		PARAMS(tstruct), PARAMS(assign), PARAMS(print))		\
167 
168 #undef TRACE_EVENT_FLAGS
169 #define TRACE_EVENT_FLAGS(name, value)					\
170 	__TRACE_EVENT_FLAGS(name, value)
171 
172 #undef TRACE_EVENT_PERF_PERM
173 #define TRACE_EVENT_PERF_PERM(name, expr...)				\
174 	__TRACE_EVENT_PERF_PERM(name, expr)
175 
176 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
177 
178 /*
179  * Stage 2 of the trace events.
180  *
181  * Include the following:
182  *
183  * struct trace_event_data_offsets_<call> {
184  *	u32				<item1>;
185  *	u32				<item2>;
186  *	[...]
187  * };
188  *
189  * The __dynamic_array() macro will create each u32 <item>, this is
190  * to keep the offset of each array from the beginning of the event.
191  * The size of an array is also encoded, in the higher 16 bits of <item>.
192  */
193 
194 #undef TRACE_DEFINE_ENUM
195 #define TRACE_DEFINE_ENUM(a)
196 
197 #undef TRACE_DEFINE_SIZEOF
198 #define TRACE_DEFINE_SIZEOF(a)
199 
200 #undef __field
201 #define __field(type, item)
202 
203 #undef __field_ext
204 #define __field_ext(type, item, filter_type)
205 
206 #undef __field_struct
207 #define __field_struct(type, item)
208 
209 #undef __field_struct_ext
210 #define __field_struct_ext(type, item, filter_type)
211 
212 #undef __array
213 #define __array(type, item, len)
214 
215 #undef __dynamic_array
216 #define __dynamic_array(type, item, len)	u32 item;
217 
218 #undef __string
219 #define __string(item, src) __dynamic_array(char, item, -1)
220 
221 #undef __string_len
222 #define __string_len(item, src, len) __dynamic_array(char, item, -1)
223 
224 #undef __bitmask
225 #define __bitmask(item, nr_bits) __dynamic_array(unsigned long, item, -1)
226 
227 #undef __sockaddr
228 #define __sockaddr(field, len) __dynamic_array(u8, field, len)
229 
230 #undef __rel_dynamic_array
231 #define __rel_dynamic_array(type, item, len)	u32 item;
232 
233 #undef __rel_string
234 #define __rel_string(item, src) __rel_dynamic_array(char, item, -1)
235 
236 #undef __rel_string_len
237 #define __rel_string_len(item, src, len) __rel_dynamic_array(char, item, -1)
238 
239 #undef __rel_bitmask
240 #define __rel_bitmask(item, nr_bits) __rel_dynamic_array(unsigned long, item, -1)
241 
242 #undef __rel_sockaddr
243 #define __rel_sockaddr(field, len) __rel_dynamic_array(u8, field, len)
244 
245 #undef DECLARE_EVENT_CLASS
246 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print)	\
247 	struct trace_event_data_offsets_##call {			\
248 		tstruct;						\
249 	};
250 
251 #undef DEFINE_EVENT
252 #define DEFINE_EVENT(template, name, proto, args)
253 
254 #undef DEFINE_EVENT_PRINT
255 #define DEFINE_EVENT_PRINT(template, name, proto, args, print)
256 
257 #undef TRACE_EVENT_FLAGS
258 #define TRACE_EVENT_FLAGS(event, flag)
259 
260 #undef TRACE_EVENT_PERF_PERM
261 #define TRACE_EVENT_PERF_PERM(event, expr...)
262 
263 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
264 
265 /*
266  * Stage 3 of the trace events.
267  *
268  * Override the macros in the event tracepoint header <trace/events/XXX.h>
269  * to include the following:
270  *
271  * enum print_line_t
272  * trace_raw_output_<call>(struct trace_iterator *iter, int flags)
273  * {
274  *	struct trace_seq *s = &iter->seq;
275  *	struct trace_event_raw_<call> *field; <-- defined in stage 1
276  *	struct trace_seq *p = &iter->tmp_seq;
277  *
278  * -------(for event)-------
279  *
280  *	struct trace_entry *entry;
281  *
282  *	entry = iter->ent;
283  *
284  *	if (entry->type != event_<call>->event.type) {
285  *		WARN_ON_ONCE(1);
286  *		return TRACE_TYPE_UNHANDLED;
287  *	}
288  *
289  *	field = (typeof(field))entry;
290  *
291  *	trace_seq_init(p);
292  *	return trace_output_call(iter, <call>, <TP_printk> "\n");
293  *
294  * ------(or, for event class)------
295  *
296  *	int ret;
297  *
298  *	field = (typeof(field))iter->ent;
299  *
300  *	ret = trace_raw_output_prep(iter, trace_event);
301  *	if (ret != TRACE_TYPE_HANDLED)
302  *		return ret;
303  *
304  *	trace_event_printf(iter, <TP_printk> "\n");
305  *
306  *	return trace_handle_return(s);
307  * -------
308  *  }
309  *
310  * This is the method used to print the raw event to the trace
311  * output format. Note, this is not needed if the data is read
312  * in binary.
313  */
314 
315 #undef __entry
316 #define __entry field
317 
318 #undef TP_printk
319 #define TP_printk(fmt, args...) fmt "\n", args
320 
321 #undef __get_dynamic_array
322 #define __get_dynamic_array(field)	\
323 		((void *)__entry + (__entry->__data_loc_##field & 0xffff))
324 
325 #undef __get_dynamic_array_len
326 #define __get_dynamic_array_len(field)	\
327 		((__entry->__data_loc_##field >> 16) & 0xffff)
328 
329 #undef __get_str
330 #define __get_str(field) ((char *)__get_dynamic_array(field))
331 
332 #undef __get_rel_dynamic_array
333 #define __get_rel_dynamic_array(field)					\
334 		((void *)__entry + 					\
335 		 offsetof(typeof(*__entry), __rel_loc_##field) +	\
336 		 sizeof(__entry->__rel_loc_##field) +			\
337 		 (__entry->__rel_loc_##field & 0xffff))
338 
339 #undef __get_rel_dynamic_array_len
340 #define __get_rel_dynamic_array_len(field)	\
341 		((__entry->__rel_loc_##field >> 16) & 0xffff)
342 
343 #undef __get_rel_str
344 #define __get_rel_str(field) ((char *)__get_rel_dynamic_array(field))
345 
346 #undef __get_bitmask
347 #define __get_bitmask(field)						\
348 	({								\
349 		void *__bitmask = __get_dynamic_array(field);		\
350 		unsigned int __bitmask_size;				\
351 		__bitmask_size = __get_dynamic_array_len(field);	\
352 		trace_print_bitmask_seq(p, __bitmask, __bitmask_size);	\
353 	})
354 
355 #undef __get_rel_bitmask
356 #define __get_rel_bitmask(field)						\
357 	({								\
358 		void *__bitmask = __get_rel_dynamic_array(field);		\
359 		unsigned int __bitmask_size;				\
360 		__bitmask_size = __get_rel_dynamic_array_len(field);	\
361 		trace_print_bitmask_seq(p, __bitmask, __bitmask_size);	\
362 	})
363 
364 #undef __get_sockaddr
365 #define __get_sockaddr(field)	((struct sockaddr *)__get_dynamic_array(field))
366 
367 #undef __get_rel_sockaddr
368 #define __get_rel_sockaddr(field)	((struct sockaddr *)__get_rel_dynamic_array(field))
369 
370 #undef __print_flags
371 #define __print_flags(flag, delim, flag_array...)			\
372 	({								\
373 		static const struct trace_print_flags __flags[] =	\
374 			{ flag_array, { -1, NULL }};			\
375 		trace_print_flags_seq(p, delim, flag, __flags);	\
376 	})
377 
378 #undef __print_symbolic
379 #define __print_symbolic(value, symbol_array...)			\
380 	({								\
381 		static const struct trace_print_flags symbols[] =	\
382 			{ symbol_array, { -1, NULL }};			\
383 		trace_print_symbols_seq(p, value, symbols);		\
384 	})
385 
386 #undef __print_flags_u64
387 #undef __print_symbolic_u64
388 #if BITS_PER_LONG == 32
389 #define __print_flags_u64(flag, delim, flag_array...)			\
390 	({								\
391 		static const struct trace_print_flags_u64 __flags[] =	\
392 			{ flag_array, { -1, NULL } };			\
393 		trace_print_flags_seq_u64(p, delim, flag, __flags);	\
394 	})
395 
396 #define __print_symbolic_u64(value, symbol_array...)			\
397 	({								\
398 		static const struct trace_print_flags_u64 symbols[] =	\
399 			{ symbol_array, { -1, NULL } };			\
400 		trace_print_symbols_seq_u64(p, value, symbols);	\
401 	})
402 #else
403 #define __print_flags_u64(flag, delim, flag_array...)			\
404 			__print_flags(flag, delim, flag_array)
405 
406 #define __print_symbolic_u64(value, symbol_array...)			\
407 			__print_symbolic(value, symbol_array)
408 #endif
409 
410 #undef __print_hex
411 #define __print_hex(buf, buf_len)					\
412 	trace_print_hex_seq(p, buf, buf_len, false)
413 
414 #undef __print_hex_str
415 #define __print_hex_str(buf, buf_len)					\
416 	trace_print_hex_seq(p, buf, buf_len, true)
417 
418 #undef __print_array
419 #define __print_array(array, count, el_size)				\
420 	({								\
421 		BUILD_BUG_ON(el_size != 1 && el_size != 2 &&		\
422 			     el_size != 4 && el_size != 8);		\
423 		trace_print_array_seq(p, array, count, el_size);	\
424 	})
425 
426 #undef __print_hex_dump
427 #define __print_hex_dump(prefix_str, prefix_type,			\
428 			 rowsize, groupsize, buf, len, ascii)		\
429 	trace_print_hex_dump_seq(p, prefix_str, prefix_type,		\
430 				 rowsize, groupsize, buf, len, ascii)
431 
432 #undef __print_ns_to_secs
433 #define __print_ns_to_secs(value)			\
434 	({						\
435 		u64 ____val = (u64)(value);		\
436 		do_div(____val, NSEC_PER_SEC);		\
437 		____val;				\
438 	})
439 
440 #undef __print_ns_without_secs
441 #define __print_ns_without_secs(value)			\
442 	({						\
443 		u64 ____val = (u64)(value);		\
444 		(u32) do_div(____val, NSEC_PER_SEC);	\
445 	})
446 
447 #undef DECLARE_EVENT_CLASS
448 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print)	\
449 static notrace enum print_line_t					\
450 trace_raw_output_##call(struct trace_iterator *iter, int flags,		\
451 			struct trace_event *trace_event)		\
452 {									\
453 	struct trace_seq *s = &iter->seq;				\
454 	struct trace_seq __maybe_unused *p = &iter->tmp_seq;		\
455 	struct trace_event_raw_##call *field;				\
456 	int ret;							\
457 									\
458 	field = (typeof(field))iter->ent;				\
459 									\
460 	ret = trace_raw_output_prep(iter, trace_event);			\
461 	if (ret != TRACE_TYPE_HANDLED)					\
462 		return ret;						\
463 									\
464 	trace_event_printf(iter, print);				\
465 									\
466 	return trace_handle_return(s);					\
467 }									\
468 static struct trace_event_functions trace_event_type_funcs_##call = {	\
469 	.trace			= trace_raw_output_##call,		\
470 };
471 
472 #undef DEFINE_EVENT_PRINT
473 #define DEFINE_EVENT_PRINT(template, call, proto, args, print)		\
474 static notrace enum print_line_t					\
475 trace_raw_output_##call(struct trace_iterator *iter, int flags,		\
476 			 struct trace_event *event)			\
477 {									\
478 	struct trace_event_raw_##template *field;			\
479 	struct trace_entry *entry;					\
480 	struct trace_seq *p = &iter->tmp_seq;				\
481 									\
482 	entry = iter->ent;						\
483 									\
484 	if (entry->type != event_##call.event.type) {			\
485 		WARN_ON_ONCE(1);					\
486 		return TRACE_TYPE_UNHANDLED;				\
487 	}								\
488 									\
489 	field = (typeof(field))entry;					\
490 									\
491 	trace_seq_init(p);						\
492 	return trace_output_call(iter, #call, print);			\
493 }									\
494 static struct trace_event_functions trace_event_type_funcs_##call = {	\
495 	.trace			= trace_raw_output_##call,		\
496 };
497 
498 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
499 
500 #undef __field_ext
501 #define __field_ext(_type, _item, _filter_type) {			\
502 	.type = #_type, .name = #_item,					\
503 	.size = sizeof(_type), .align = __alignof__(_type),		\
504 	.is_signed = is_signed_type(_type), .filter_type = _filter_type },
505 
506 #undef __field_struct_ext
507 #define __field_struct_ext(_type, _item, _filter_type) {		\
508 	.type = #_type, .name = #_item,					\
509 	.size = sizeof(_type), .align = __alignof__(_type),		\
510 	0, .filter_type = _filter_type },
511 
512 #undef __field
513 #define __field(type, item)	__field_ext(type, item, FILTER_OTHER)
514 
515 #undef __field_struct
516 #define __field_struct(type, item) __field_struct_ext(type, item, FILTER_OTHER)
517 
518 #undef __array
519 #define __array(_type, _item, _len) {					\
520 	.type = #_type"["__stringify(_len)"]", .name = #_item,		\
521 	.size = sizeof(_type[_len]), .align = __alignof__(_type),	\
522 	.is_signed = is_signed_type(_type), .filter_type = FILTER_OTHER },
523 
524 #undef __dynamic_array
525 #define __dynamic_array(_type, _item, _len) {				\
526 	.type = "__data_loc " #_type "[]", .name = #_item,		\
527 	.size = 4, .align = 4,						\
528 	.is_signed = is_signed_type(_type), .filter_type = FILTER_OTHER },
529 
530 #undef __string
531 #define __string(item, src) __dynamic_array(char, item, -1)
532 
533 #undef __string_len
534 #define __string_len(item, src, len) __dynamic_array(char, item, -1)
535 
536 #undef __bitmask
537 #define __bitmask(item, nr_bits) __dynamic_array(unsigned long, item, -1)
538 
539 #undef __sockaddr
540 #define __sockaddr(field, len) __dynamic_array(u8, field, len)
541 
542 #undef __rel_dynamic_array
543 #define __rel_dynamic_array(_type, _item, _len) {			\
544 	.type = "__rel_loc " #_type "[]", .name = #_item,		\
545 	.size = 4, .align = 4,						\
546 	.is_signed = is_signed_type(_type), .filter_type = FILTER_OTHER },
547 
548 #undef __rel_string
549 #define __rel_string(item, src) __rel_dynamic_array(char, item, -1)
550 
551 #undef __rel_string_len
552 #define __rel_string_len(item, src, len) __rel_dynamic_array(char, item, -1)
553 
554 #undef __rel_bitmask
555 #define __rel_bitmask(item, nr_bits) __rel_dynamic_array(unsigned long, item, -1)
556 
557 #undef __rel_sockaddr
558 #define __rel_sockaddr(field, len) __rel_dynamic_array(u8, field, len)
559 
560 #undef DECLARE_EVENT_CLASS
561 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, func, print)	\
562 static struct trace_event_fields trace_event_fields_##call[] = {	\
563 	tstruct								\
564 	{} };
565 
566 #undef DEFINE_EVENT_PRINT
567 #define DEFINE_EVENT_PRINT(template, name, proto, args, print)
568 
569 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
570 
571 /*
572  * remember the offset of each array from the beginning of the event.
573  */
574 
575 #undef __entry
576 #define __entry entry
577 
578 #undef __field
579 #define __field(type, item)
580 
581 #undef __field_ext
582 #define __field_ext(type, item, filter_type)
583 
584 #undef __field_struct
585 #define __field_struct(type, item)
586 
587 #undef __field_struct_ext
588 #define __field_struct_ext(type, item, filter_type)
589 
590 #undef __array
591 #define __array(type, item, len)
592 
593 #undef __dynamic_array
594 #define __dynamic_array(type, item, len)				\
595 	__item_length = (len) * sizeof(type);				\
596 	__data_offsets->item = __data_size +				\
597 			       offsetof(typeof(*entry), __data);	\
598 	__data_offsets->item |= __item_length << 16;			\
599 	__data_size += __item_length;
600 
601 #undef __string
602 #define __string(item, src) __dynamic_array(char, item,			\
603 		    strlen((src) ? (const char *)(src) : "(null)") + 1)
604 
605 #undef __string_len
606 #define __string_len(item, src, len) __dynamic_array(char, item, (len) + 1)
607 
608 #undef __rel_dynamic_array
609 #define __rel_dynamic_array(type, item, len)				\
610 	__item_length = (len) * sizeof(type);				\
611 	__data_offsets->item = __data_size +				\
612 			       offsetof(typeof(*entry), __data) -	\
613 			       offsetof(typeof(*entry), __rel_loc_##item) -	\
614 			       sizeof(u32);				\
615 	__data_offsets->item |= __item_length << 16;			\
616 	__data_size += __item_length;
617 
618 #undef __rel_string
619 #define __rel_string(item, src) __rel_dynamic_array(char, item,			\
620 		    strlen((src) ? (const char *)(src) : "(null)") + 1)
621 
622 #undef __rel_string_len
623 #define __rel_string_len(item, src, len) __rel_dynamic_array(char, item, (len) + 1)
624 /*
625  * __bitmask_size_in_bytes_raw is the number of bytes needed to hold
626  * num_possible_cpus().
627  */
628 #define __bitmask_size_in_bytes_raw(nr_bits)	\
629 	(((nr_bits) + 7) / 8)
630 
631 #define __bitmask_size_in_longs(nr_bits)			\
632 	((__bitmask_size_in_bytes_raw(nr_bits) +		\
633 	  ((BITS_PER_LONG / 8) - 1)) / (BITS_PER_LONG / 8))
634 
635 /*
636  * __bitmask_size_in_bytes is the number of bytes needed to hold
637  * num_possible_cpus() padded out to the nearest long. This is what
638  * is saved in the buffer, just to be consistent.
639  */
640 #define __bitmask_size_in_bytes(nr_bits)				\
641 	(__bitmask_size_in_longs(nr_bits) * (BITS_PER_LONG / 8))
642 
643 #undef __bitmask
644 #define __bitmask(item, nr_bits) __dynamic_array(unsigned long, item,	\
645 					 __bitmask_size_in_longs(nr_bits))
646 
647 #undef __rel_bitmask
648 #define __rel_bitmask(item, nr_bits) __rel_dynamic_array(unsigned long, item,	\
649 					 __bitmask_size_in_longs(nr_bits))
650 
651 #undef __sockaddr
652 #define __sockaddr(field, len) __dynamic_array(u8, field, len)
653 
654 #undef __rel_sockaddr
655 #define __rel_sockaddr(field, len) __rel_dynamic_array(u8, field, len)
656 
657 #undef DECLARE_EVENT_CLASS
658 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print)	\
659 static inline notrace int trace_event_get_offsets_##call(		\
660 	struct trace_event_data_offsets_##call *__data_offsets, proto)	\
661 {									\
662 	int __data_size = 0;						\
663 	int __maybe_unused __item_length;				\
664 	struct trace_event_raw_##call __maybe_unused *entry;		\
665 									\
666 	tstruct;							\
667 									\
668 	return __data_size;						\
669 }
670 
671 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
672 
673 /*
674  * Stage 4 of the trace events.
675  *
676  * Override the macros in the event tracepoint header <trace/events/XXX.h>
677  * to include the following:
678  *
679  * For those macros defined with TRACE_EVENT:
680  *
681  * static struct trace_event_call event_<call>;
682  *
683  * static void trace_event_raw_event_<call>(void *__data, proto)
684  * {
685  *	struct trace_event_file *trace_file = __data;
686  *	struct trace_event_call *event_call = trace_file->event_call;
687  *	struct trace_event_data_offsets_<call> __maybe_unused __data_offsets;
688  *	unsigned long eflags = trace_file->flags;
689  *	enum event_trigger_type __tt = ETT_NONE;
690  *	struct ring_buffer_event *event;
691  *	struct trace_event_raw_<call> *entry; <-- defined in stage 1
692  *	struct trace_buffer *buffer;
693  *	unsigned long irq_flags;
694  *	int __data_size;
695  *	int pc;
696  *
697  *	if (!(eflags & EVENT_FILE_FL_TRIGGER_COND)) {
698  *		if (eflags & EVENT_FILE_FL_TRIGGER_MODE)
699  *			event_triggers_call(trace_file, NULL);
700  *		if (eflags & EVENT_FILE_FL_SOFT_DISABLED)
701  *			return;
702  *	}
703  *
704  *	local_save_flags(irq_flags);
705  *	pc = preempt_count();
706  *
707  *	__data_size = trace_event_get_offsets_<call>(&__data_offsets, args);
708  *
709  *	event = trace_event_buffer_lock_reserve(&buffer, trace_file,
710  *				  event_<call>->event.type,
711  *				  sizeof(*entry) + __data_size,
712  *				  irq_flags, pc);
713  *	if (!event)
714  *		return;
715  *	entry	= ring_buffer_event_data(event);
716  *
717  *	{ <assign>; }  <-- Here we assign the entries by the __field and
718  *			   __array macros.
719  *
720  *	if (eflags & EVENT_FILE_FL_TRIGGER_COND)
721  *		__tt = event_triggers_call(trace_file, entry);
722  *
723  *	if (test_bit(EVENT_FILE_FL_SOFT_DISABLED_BIT,
724  *		     &trace_file->flags))
725  *		ring_buffer_discard_commit(buffer, event);
726  *	else if (!filter_check_discard(trace_file, entry, buffer, event))
727  *		trace_buffer_unlock_commit(buffer, event, irq_flags, pc);
728  *
729  *	if (__tt)
730  *		event_triggers_post_call(trace_file, __tt);
731  * }
732  *
733  * static struct trace_event ftrace_event_type_<call> = {
734  *	.trace			= trace_raw_output_<call>, <-- stage 2
735  * };
736  *
737  * static char print_fmt_<call>[] = <TP_printk>;
738  *
739  * static struct trace_event_class __used event_class_<template> = {
740  *	.system			= "<system>",
741  *	.fields_array		= trace_event_fields_<call>,
742  *	.fields			= LIST_HEAD_INIT(event_class_##call.fields),
743  *	.raw_init		= trace_event_raw_init,
744  *	.probe			= trace_event_raw_event_##call,
745  *	.reg			= trace_event_reg,
746  * };
747  *
748  * static struct trace_event_call event_<call> = {
749  *	.class			= event_class_<template>,
750  *	{
751  *		.tp			= &__tracepoint_<call>,
752  *	},
753  *	.event			= &ftrace_event_type_<call>,
754  *	.print_fmt		= print_fmt_<call>,
755  *	.flags			= TRACE_EVENT_FL_TRACEPOINT,
756  * };
757  * // its only safe to use pointers when doing linker tricks to
758  * // create an array.
759  * static struct trace_event_call __used
760  * __section("_ftrace_events") *__event_<call> = &event_<call>;
761  *
762  */
763 
764 #ifdef CONFIG_PERF_EVENTS
765 
766 #define _TRACE_PERF_PROTO(call, proto)					\
767 	static notrace void						\
768 	perf_trace_##call(void *__data, proto);
769 
770 #define _TRACE_PERF_INIT(call)						\
771 	.perf_probe		= perf_trace_##call,
772 
773 #else
774 #define _TRACE_PERF_PROTO(call, proto)
775 #define _TRACE_PERF_INIT(call)
776 #endif /* CONFIG_PERF_EVENTS */
777 
778 #undef __entry
779 #define __entry entry
780 
781 #undef __field
782 #define __field(type, item)
783 
784 #undef __field_struct
785 #define __field_struct(type, item)
786 
787 #undef __array
788 #define __array(type, item, len)
789 
790 #undef __dynamic_array
791 #define __dynamic_array(type, item, len)				\
792 	__entry->__data_loc_##item = __data_offsets.item;
793 
794 #undef __string
795 #define __string(item, src) __dynamic_array(char, item, -1)
796 
797 #undef __string_len
798 #define __string_len(item, src, len) __dynamic_array(char, item, -1)
799 
800 #undef __assign_str
801 #define __assign_str(dst, src)						\
802 	strcpy(__get_str(dst), (src) ? (const char *)(src) : "(null)");
803 
804 #undef __assign_str_len
805 #define __assign_str_len(dst, src, len)					\
806 	do {								\
807 		memcpy(__get_str(dst), (src), (len));			\
808 		__get_str(dst)[len] = '\0';				\
809 	} while(0)
810 
811 #undef __bitmask
812 #define __bitmask(item, nr_bits) __dynamic_array(unsigned long, item, -1)
813 
814 #undef __get_bitmask
815 #define __get_bitmask(field) (char *)__get_dynamic_array(field)
816 
817 #undef __assign_bitmask
818 #define __assign_bitmask(dst, src, nr_bits)					\
819 	memcpy(__get_bitmask(dst), (src), __bitmask_size_in_bytes(nr_bits))
820 
821 #undef __sockaddr
822 #define __sockaddr(field, len) __dynamic_array(u8, field, len)
823 
824 #undef __get_sockaddr
825 #define __get_sockaddr(field)	((struct sockaddr *)__get_dynamic_array(field))
826 
827 #define __assign_sockaddr(dest, src, len)					\
828 	memcpy(__get_dynamic_array(dest), src, len)
829 
830 #undef __rel_dynamic_array
831 #define __rel_dynamic_array(type, item, len)				\
832 	__entry->__rel_loc_##item = __data_offsets.item;
833 
834 #undef __rel_string
835 #define __rel_string(item, src) __rel_dynamic_array(char, item, -1)
836 
837 #undef __rel_string_len
838 #define __rel_string_len(item, src, len) __rel_dynamic_array(char, item, -1)
839 
840 #undef __assign_rel_str
841 #define __assign_rel_str(dst, src)					\
842 	strcpy(__get_rel_str(dst), (src) ? (const char *)(src) : "(null)");
843 
844 #undef __assign_rel_str_len
845 #define __assign_rel_str_len(dst, src, len)				\
846 	do {								\
847 		memcpy(__get_rel_str(dst), (src), (len));		\
848 		__get_rel_str(dst)[len] = '\0';				\
849 	} while (0)
850 
851 #undef __rel_bitmask
852 #define __rel_bitmask(item, nr_bits) __rel_dynamic_array(unsigned long, item, -1)
853 
854 #undef __get_rel_bitmask
855 #define __get_rel_bitmask(field) (char *)__get_rel_dynamic_array(field)
856 
857 #undef __assign_rel_bitmask
858 #define __assign_rel_bitmask(dst, src, nr_bits)					\
859 	memcpy(__get_rel_bitmask(dst), (src), __bitmask_size_in_bytes(nr_bits))
860 
861 #undef __rel_sockaddr
862 #define __rel_sockaddr(field, len) __rel_dynamic_array(u8, field, len)
863 
864 #undef __get_rel_sockaddr
865 #define __get_rel_sockaddr(field)	((struct sockaddr *)__get_rel_dynamic_array(field))
866 
867 #define __assign_rel_sockaddr(dest, src, len)					\
868 	memcpy(__get_rel_dynamic_array(dest), src, len)
869 
870 
871 #undef TP_fast_assign
872 #define TP_fast_assign(args...) args
873 
874 #undef __perf_count
875 #define __perf_count(c)	(c)
876 
877 #undef __perf_task
878 #define __perf_task(t)	(t)
879 
880 #undef DECLARE_EVENT_CLASS
881 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print)	\
882 									\
883 static notrace void							\
884 trace_event_raw_event_##call(void *__data, proto)			\
885 {									\
886 	struct trace_event_file *trace_file = __data;			\
887 	struct trace_event_data_offsets_##call __maybe_unused __data_offsets;\
888 	struct trace_event_buffer fbuffer;				\
889 	struct trace_event_raw_##call *entry;				\
890 	int __data_size;						\
891 									\
892 	if (trace_trigger_soft_disabled(trace_file))			\
893 		return;							\
894 									\
895 	__data_size = trace_event_get_offsets_##call(&__data_offsets, args); \
896 									\
897 	entry = trace_event_buffer_reserve(&fbuffer, trace_file,	\
898 				 sizeof(*entry) + __data_size);		\
899 									\
900 	if (!entry)							\
901 		return;							\
902 									\
903 	tstruct								\
904 									\
905 	{ assign; }							\
906 									\
907 	trace_event_buffer_commit(&fbuffer);				\
908 }
909 /*
910  * The ftrace_test_probe is compiled out, it is only here as a build time check
911  * to make sure that if the tracepoint handling changes, the ftrace probe will
912  * fail to compile unless it too is updated.
913  */
914 
915 #undef DEFINE_EVENT
916 #define DEFINE_EVENT(template, call, proto, args)			\
917 static inline void ftrace_test_probe_##call(void)			\
918 {									\
919 	check_trace_callback_type_##call(trace_event_raw_event_##template); \
920 }
921 
922 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
923 
924 #undef __entry
925 #define __entry REC
926 
927 #undef __print_flags
928 #undef __print_symbolic
929 #undef __print_hex
930 #undef __print_hex_str
931 #undef __get_dynamic_array
932 #undef __get_dynamic_array_len
933 #undef __get_str
934 #undef __get_bitmask
935 #undef __get_sockaddr
936 #undef __get_rel_dynamic_array
937 #undef __get_rel_dynamic_array_len
938 #undef __get_rel_str
939 #undef __get_rel_bitmask
940 #undef __get_rel_sockaddr
941 #undef __print_array
942 #undef __print_hex_dump
943 
944 /*
945  * The below is not executed in the kernel. It is only what is
946  * displayed in the print format for userspace to parse.
947  */
948 #undef __print_ns_to_secs
949 #define __print_ns_to_secs(val) (val) / 1000000000UL
950 
951 #undef __print_ns_without_secs
952 #define __print_ns_without_secs(val) (val) % 1000000000UL
953 
954 #undef TP_printk
955 #define TP_printk(fmt, args...) "\"" fmt "\", "  __stringify(args)
956 
957 #undef DECLARE_EVENT_CLASS
958 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print)	\
959 _TRACE_PERF_PROTO(call, PARAMS(proto));					\
960 static char print_fmt_##call[] = print;					\
961 static struct trace_event_class __used __refdata event_class_##call = { \
962 	.system			= TRACE_SYSTEM_STRING,			\
963 	.fields_array		= trace_event_fields_##call,		\
964 	.fields			= LIST_HEAD_INIT(event_class_##call.fields),\
965 	.raw_init		= trace_event_raw_init,			\
966 	.probe			= trace_event_raw_event_##call,		\
967 	.reg			= trace_event_reg,			\
968 	_TRACE_PERF_INIT(call)						\
969 };
970 
971 #undef DEFINE_EVENT
972 #define DEFINE_EVENT(template, call, proto, args)			\
973 									\
974 static struct trace_event_call __used event_##call = {			\
975 	.class			= &event_class_##template,		\
976 	{								\
977 		.tp			= &__tracepoint_##call,		\
978 	},								\
979 	.event.funcs		= &trace_event_type_funcs_##template,	\
980 	.print_fmt		= print_fmt_##template,			\
981 	.flags			= TRACE_EVENT_FL_TRACEPOINT,		\
982 };									\
983 static struct trace_event_call __used					\
984 __section("_ftrace_events") *__event_##call = &event_##call
985 
986 #undef DEFINE_EVENT_PRINT
987 #define DEFINE_EVENT_PRINT(template, call, proto, args, print)		\
988 									\
989 static char print_fmt_##call[] = print;					\
990 									\
991 static struct trace_event_call __used event_##call = {			\
992 	.class			= &event_class_##template,		\
993 	{								\
994 		.tp			= &__tracepoint_##call,		\
995 	},								\
996 	.event.funcs		= &trace_event_type_funcs_##call,	\
997 	.print_fmt		= print_fmt_##call,			\
998 	.flags			= TRACE_EVENT_FL_TRACEPOINT,		\
999 };									\
1000 static struct trace_event_call __used					\
1001 __section("_ftrace_events") *__event_##call = &event_##call
1002 
1003 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
1004