[linux-block.git] / include / trace / trace_events.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * Stage 1 of the trace events.
 *
 * Override the macros in the event tracepoint header <trace/events/XXX.h>
 * to include the following:
 *
 * struct trace_event_raw_<call> {
 *	struct trace_entry		ent;
 *	<type>				<item>;
 *	<type2>				<item2>[<len>];
 *	[...]
 * };
 *
 * The <type> <item> is created by the __field(type, item) macro or
 * the __array(type2, item2, len) macro.
 * We simply do "type item;", and that will create the fields
 * in the structure.
 */

#include <linux/trace_events.h>

#ifndef TRACE_SYSTEM_VAR
#define TRACE_SYSTEM_VAR TRACE_SYSTEM
#endif

#include "stages/init.h"

/*
 * DECLARE_EVENT_CLASS can be used to add a generic function
 * handlers for events. That is, if all events have the same
 * parameters and just have distinct trace points.
 * Each tracepoint can be defined with DEFINE_EVENT and that
 * will map the DECLARE_EVENT_CLASS to the tracepoint.
 *
 * TRACE_EVENT is a one to one mapping between tracepoint and template.
 */
#undef TRACE_EVENT
#define TRACE_EVENT(name, proto, args, tstruct, assign, print) \
	DECLARE_EVENT_CLASS(name,			       \
			     PARAMS(proto),		       \
			     PARAMS(args),		       \
			     PARAMS(tstruct),		       \
			     PARAMS(assign),		       \
			     PARAMS(print));		       \
	DEFINE_EVENT(name, name, PARAMS(proto), PARAMS(args));

#include "stages/stage1_struct_define.h"

#undef DECLARE_EVENT_CLASS
#define DECLARE_EVENT_CLASS(name, proto, args, tstruct, assign, print)	\
	struct trace_event_raw_##name {					\
		struct trace_entry	ent;				\
		tstruct							\
		char			__data[];			\
	};								\
									\
	static struct trace_event_class event_class_##name;

#undef DEFINE_EVENT
#define DEFINE_EVENT(template, name, proto, args)	\
	static struct trace_event_call	__used		\
	__attribute__((__aligned__(4))) event_##name

#undef DEFINE_EVENT_FN
#define DEFINE_EVENT_FN(template, name, proto, args, reg, unreg)	\
	DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))

#undef DEFINE_EVENT_PRINT
#define DEFINE_EVENT_PRINT(template, name, proto, args, print)	\
	DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))

/* Callbacks are meaningless to ftrace. */
#undef TRACE_EVENT_FN
#define TRACE_EVENT_FN(name, proto, args, tstruct,			\
		assign, print, reg, unreg)				\
	TRACE_EVENT(name, PARAMS(proto), PARAMS(args),			\
		PARAMS(tstruct), PARAMS(assign), PARAMS(print))		\

#undef TRACE_EVENT_FN_COND
#define TRACE_EVENT_FN_COND(name, proto, args, cond, tstruct,	\
		assign, print, reg, unreg)				\
	TRACE_EVENT_CONDITION(name, PARAMS(proto), PARAMS(args), PARAMS(cond),		\
		PARAMS(tstruct), PARAMS(assign), PARAMS(print))		\

#undef TRACE_EVENT_FLAGS
#define TRACE_EVENT_FLAGS(name, value)					\
	__TRACE_EVENT_FLAGS(name, value)

#undef TRACE_EVENT_PERF_PERM
#define TRACE_EVENT_PERF_PERM(name, expr...)				\
	__TRACE_EVENT_PERF_PERM(name, expr)

#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

/*
 * Stage 2 of the trace events.
 *
 * Include the following:
 *
 * struct trace_event_data_offsets_<call> {
 *	u32				<item1>;
 *	u32				<item2>;
 *	[...]
 * };
 *
 * The __dynamic_array() macro will create each u32 <item>, this is
 * to keep the offset of each array from the beginning of the event.
 * The size of an array is also encoded, in the higher 16 bits of <item>.
 */

#include "stages/stage2_data_offsets.h"

#undef DECLARE_EVENT_CLASS
#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print)	\
	struct trace_event_data_offsets_##call {			\
		tstruct;						\
	};

#undef DEFINE_EVENT
#define DEFINE_EVENT(template, name, proto, args)

#undef DEFINE_EVENT_PRINT
#define DEFINE_EVENT_PRINT(template, name, proto, args, print)

#undef TRACE_EVENT_FLAGS
#define TRACE_EVENT_FLAGS(event, flag)

#undef TRACE_EVENT_PERF_PERM
#define TRACE_EVENT_PERF_PERM(event, expr...)

#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

/*
 * Stage 3 of the trace events.
 *
 * Override the macros in the event tracepoint header <trace/events/XXX.h>
 * to include the following:
 *
 * enum print_line_t
 * trace_raw_output_<call>(struct trace_iterator *iter, int flags)
 * {
 *	struct trace_seq *s = &iter->seq;
 *	struct trace_event_raw_<call> *field; <-- defined in stage 1
 *	struct trace_seq *p = &iter->tmp_seq;
 *
 * -------(for event)-------
 *
 *	struct trace_entry *entry;
 *
 *	entry = iter->ent;
 *
 *	if (entry->type != event_<call>->event.type) {
 *		WARN_ON_ONCE(1);
 *		return TRACE_TYPE_UNHANDLED;
 *	}
 *
 *	field = (typeof(field))entry;
 *
 *	trace_seq_init(p);
 *	return trace_output_call(iter, <call>, <TP_printk> "\n");
 *
 * ------(or, for event class)------
 *
 *	int ret;
 *
 *	field = (typeof(field))iter->ent;
 *
 *	ret = trace_raw_output_prep(iter, trace_event);
 *	if (ret != TRACE_TYPE_HANDLED)
 *		return ret;
 *
 *	trace_event_printf(iter, <TP_printk> "\n");
 *
 *	return trace_handle_return(s);
 * -------
 *  }
 *
 * This is the method used to print the raw event to the trace
 * output format. Note, this is not needed if the data is read
 * in binary.
 */

#include "stages/stage3_trace_output.h"

#undef DECLARE_EVENT_CLASS
#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print)	\
static notrace enum print_line_t					\
trace_raw_output_##call(struct trace_iterator *iter, int flags,		\
			struct trace_event *trace_event)		\
{									\
	struct trace_seq *s = &iter->seq;				\
	struct trace_seq __maybe_unused *p = &iter->tmp_seq;		\
	struct trace_event_raw_##call *field;				\
	int ret;							\
									\
	field = (typeof(field))iter->ent;				\
									\
	ret = trace_raw_output_prep(iter, trace_event);			\
	if (ret != TRACE_TYPE_HANDLED)					\
		return ret;						\
									\
	trace_event_printf(iter, print);				\
									\
	return trace_handle_return(s);					\
}									\
static struct trace_event_functions trace_event_type_funcs_##call = {	\
	.trace			= trace_raw_output_##call,		\
};

#undef DEFINE_EVENT_PRINT
#define DEFINE_EVENT_PRINT(template, call, proto, args, print)		\
static notrace enum print_line_t					\
trace_raw_output_##call(struct trace_iterator *iter, int flags,		\
			 struct trace_event *event)			\
{									\
	struct trace_event_raw_##template *field;			\
	struct trace_entry *entry;					\
	struct trace_seq *p = &iter->tmp_seq;				\
									\
	entry = iter->ent;						\
									\
	if (entry->type != event_##call.event.type) {			\
		WARN_ON_ONCE(1);					\
		return TRACE_TYPE_UNHANDLED;				\
	}								\
									\
	field = (typeof(field))entry;					\
									\
	trace_seq_init(p);						\
	return trace_output_call(iter, #call, print);			\
}									\
static struct trace_event_functions trace_event_type_funcs_##call = {	\
	.trace			= trace_raw_output_##call,		\
};

#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

#include "stages/stage4_event_fields.h"

#undef DECLARE_EVENT_CLASS
#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, func, print)	\
static struct trace_event_fields trace_event_fields_##call[] = {	\
	tstruct								\
	{} };

#undef DEFINE_EVENT_PRINT
#define DEFINE_EVENT_PRINT(template, name, proto, args, print)

#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

#include "stages/stage5_get_offsets.h"

#undef DECLARE_EVENT_CLASS
#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print)	\
static inline notrace int trace_event_get_offsets_##call(		\
	struct trace_event_data_offsets_##call *__data_offsets, proto)	\
{									\
	int __data_size = 0;						\
	int __maybe_unused __item_length;				\
	struct trace_event_raw_##call __maybe_unused *entry;		\
									\
	tstruct;							\
									\
	return __data_size;						\
}

#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

/*
 * Stage 4 of the trace events.
 *
 * Override the macros in the event tracepoint header <trace/events/XXX.h>
 * to include the following:
 *
 * For those macros defined with TRACE_EVENT:
 *
 * static struct trace_event_call event_<call>;
 *
 * static void trace_event_raw_event_<call>(void *__data, proto)
 * {
 *	struct trace_event_file *trace_file = __data;
 *	struct trace_event_call *event_call = trace_file->event_call;
 *	struct trace_event_data_offsets_<call> __maybe_unused __data_offsets;
 *	unsigned long eflags = trace_file->flags;
 *	enum event_trigger_type __tt = ETT_NONE;
 *	struct ring_buffer_event *event;
 *	struct trace_event_raw_<call> *entry; <-- defined in stage 1
 *	struct trace_buffer *buffer;
 *	unsigned long irq_flags;
 *	int __data_size;
 *	int pc;
 *
 *	if (!(eflags & EVENT_FILE_FL_TRIGGER_COND)) {
 *		if (eflags & EVENT_FILE_FL_TRIGGER_MODE)
 *			event_triggers_call(trace_file, NULL);
 *		if (eflags & EVENT_FILE_FL_SOFT_DISABLED)
 *			return;
 *	}
 *
 *	local_save_flags(irq_flags);
 *	pc = preempt_count();
 *
 *	__data_size = trace_event_get_offsets_<call>(&__data_offsets, args);
 *
 *	event = trace_event_buffer_lock_reserve(&buffer, trace_file,
 *				  event_<call>->event.type,
 *				  sizeof(*entry) + __data_size,
 *				  irq_flags, pc);
 *	if (!event)
 *		return;
 *	entry	= ring_buffer_event_data(event);
 *
 *	{ <assign>; }  <-- Here we assign the entries by the __field and
 *			   __array macros.
 *
 *	if (eflags & EVENT_FILE_FL_TRIGGER_COND)
 *		__tt = event_triggers_call(trace_file, entry);
 *
 *	if (test_bit(EVENT_FILE_FL_SOFT_DISABLED_BIT,
 *		     &trace_file->flags))
 *		ring_buffer_discard_commit(buffer, event);
 *	else if (!filter_check_discard(trace_file, entry, buffer, event))
 *		trace_buffer_unlock_commit(buffer, event, irq_flags, pc);
 *
 *	if (__tt)
 *		event_triggers_post_call(trace_file, __tt);
 * }
 *
 * static struct trace_event ftrace_event_type_<call> = {
 *	.trace			= trace_raw_output_<call>, <-- stage 2
 * };
 *
 * static char print_fmt_<call>[] = <TP_printk>;
 *
 * static struct trace_event_class __used event_class_<template> = {
 *	.system			= "<system>",
 *	.fields_array		= trace_event_fields_<call>,
 *	.fields			= LIST_HEAD_INIT(event_class_##call.fields),
 *	.raw_init		= trace_event_raw_init,
 *	.probe			= trace_event_raw_event_##call,
 *	.reg			= trace_event_reg,
 * };
 *
 * static struct trace_event_call event_<call> = {
 *	.class			= event_class_<template>,
 *	{
 *		.tp			= &__tracepoint_<call>,
 *	},
 *	.event			= &ftrace_event_type_<call>,
 *	.print_fmt		= print_fmt_<call>,
 *	.flags			= TRACE_EVENT_FL_TRACEPOINT,
 * };
 * // its only safe to use pointers when doing linker tricks to
 * // create an array.
 * static struct trace_event_call __used
 * __section("_ftrace_events") *__event_<call> = &event_<call>;
 *
 */

#ifdef CONFIG_PERF_EVENTS

#define _TRACE_PERF_PROTO(call, proto)					\
	static notrace void						\
	perf_trace_##call(void *__data, proto);

#define _TRACE_PERF_INIT(call)						\
	.perf_probe		= perf_trace_##call,

#else
#define _TRACE_PERF_PROTO(call, proto)
#define _TRACE_PERF_INIT(call)
#endif /* CONFIG_PERF_EVENTS */

#include "stages/stage6_event_callback.h"

#undef DECLARE_EVENT_CLASS
#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print)	\
									\
static notrace void							\
trace_event_raw_event_##call(void *__data, proto)			\
{									\
	struct trace_event_file *trace_file = __data;			\
	struct trace_event_data_offsets_##call __maybe_unused __data_offsets;\
	struct trace_event_buffer fbuffer;				\
	struct trace_event_raw_##call *entry;				\
	int __data_size;						\
									\
	if (trace_trigger_soft_disabled(trace_file))			\
		return;							\
									\
	__data_size = trace_event_get_offsets_##call(&__data_offsets, args); \
									\
	entry = trace_event_buffer_reserve(&fbuffer, trace_file,	\
				 sizeof(*entry) + __data_size);		\
									\
	if (!entry)							\
		return;							\
									\
	tstruct								\
									\
	{ assign; }							\
									\
	trace_event_buffer_commit(&fbuffer);				\
}
/*
 * The ftrace_test_probe is compiled out, it is only here as a build time check
 * to make sure that if the tracepoint handling changes, the ftrace probe will
 * fail to compile unless it too is updated.
 */

#undef DEFINE_EVENT
#define DEFINE_EVENT(template, call, proto, args)			\
static inline void ftrace_test_probe_##call(void)			\
{									\
	check_trace_callback_type_##call(trace_event_raw_event_##template); \
}

#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

#include "stages/stage7_class_define.h"

#undef DECLARE_EVENT_CLASS
#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print)	\
_TRACE_PERF_PROTO(call, PARAMS(proto));					\
static char print_fmt_##call[] = print;					\
static struct trace_event_class __used __refdata event_class_##call = { \
	.system			= TRACE_SYSTEM_STRING,			\
	.fields_array		= trace_event_fields_##call,		\
	.fields			= LIST_HEAD_INIT(event_class_##call.fields),\
	.raw_init		= trace_event_raw_init,			\
	.probe			= trace_event_raw_event_##call,		\
	.reg			= trace_event_reg,			\
	_TRACE_PERF_INIT(call)						\
};

#undef DEFINE_EVENT
#define DEFINE_EVENT(template, call, proto, args)			\
									\
static struct trace_event_call __used event_##call = {			\
	.class			= &event_class_##template,		\
	{								\
		.tp			= &__tracepoint_##call,		\
	},								\
	.event.funcs		= &trace_event_type_funcs_##template,	\
	.print_fmt		= print_fmt_##template,			\
	.flags			= TRACE_EVENT_FL_TRACEPOINT,		\
};									\
static struct trace_event_call __used					\
__section("_ftrace_events") *__event_##call = &event_##call

#undef DEFINE_EVENT_PRINT
#define DEFINE_EVENT_PRINT(template, call, proto, args, print)		\
									\
static char print_fmt_##call[] = print;					\
									\
static struct trace_event_call __used event_##call = {			\
	.class			= &event_class_##template,		\
	{								\
		.tp			= &__tracepoint_##call,		\
	},								\
	.event.funcs		= &trace_event_type_funcs_##call,	\
	.print_fmt		= print_fmt_##call,			\
	.flags			= TRACE_EVENT_FL_TRACEPOINT,		\
};									\
static struct trace_event_call __used					\
__section("_ftrace_events") *__event_##call = &event_##call

#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
f42c85e7 SR	2	/*
	3	* Stage 1 of the trace events.
	4	*
eba12ab7 HP	5	* Override the macros in the event tracepoint header <trace/events/XXX.h>
eba12ab7 HP	6	* to include the following:
f42c85e7	7	*
a7237765	8	* struct trace_event_raw_<call> {
f42c85e7 SR	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
af658dca	21	#include <linux/trace_events.h>
f42c85e7	22
acd388fd SRRH	23	#ifndef TRACE_SYSTEM_VAR
	24	#define TRACE_SYSTEM_VAR TRACE_SYSTEM
	25	#endif
	26
af6b9668	27	#include "stages/init.h"
4f0dfd76	28
ff038f5c	29	/*
091ad365	30	* DECLARE_EVENT_CLASS can be used to add a generic function
ff038f5c SR	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
091ad365	34	* will map the DECLARE_EVENT_CLASS to the tracepoint.
ff038f5c SR	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) \
091ad365	40	DECLARE_EVENT_CLASS(name, \
ff038f5c SR	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
84055411	48	#include "stages/stage1_struct_define.h"
f42c85e7	49
091ad365 IM	50	#undef DECLARE_EVENT_CLASS
091ad365 IM	51	#define DECLARE_EVENT_CLASS(name, proto, args, tstruct, assign, print) \
a7237765	52	struct trace_event_raw_##name { \
ff038f5c SR	53	struct trace_entry ent; \
ff038f5c SR	54	tstruct \
c6d777ac	55	char __data[]; \
8f082018 SR	56	}; \
8f082018 SR	57	\
2425bcb9	58	static struct trace_event_class event_class_##name;
8f082018	59
ff038f5c SR	60	#undef DEFINE_EVENT
ff038f5c SR	61	#define DEFINE_EVENT(template, name, proto, args) \
2425bcb9	62	static struct trace_event_call __used \
86c38a31	63	__attribute__((__aligned__(4))) event_##name
f42c85e7	64
f5abaa1b SR	65	#undef DEFINE_EVENT_FN
	66	#define DEFINE_EVENT_FN(template, name, proto, args, reg, unreg) \
	67	DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
	68
e5bc9721 SR	69	#undef DEFINE_EVENT_PRINT
	70	#define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
	71	DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
	72
97419875 JS	73	/* Callbacks are meaningless to ftrace. */
97419875 JS	74	#undef TRACE_EVENT_FN
0dd7b747 FW	75	#define TRACE_EVENT_FN(name, proto, args, tstruct, \
0dd7b747 FW	76	assign, print, reg, unreg) \
819ce45a FW	77	TRACE_EVENT(name, PARAMS(proto), PARAMS(args), \
819ce45a FW	78	PARAMS(tstruct), PARAMS(assign), PARAMS(print)) \
2701121b DK	79
	80	#undef TRACE_EVENT_FN_COND
	81	#define TRACE_EVENT_FN_COND(name, proto, args, cond, tstruct, \
	82	assign, print, reg, unreg) \
	83	TRACE_EVENT_CONDITION(name, PARAMS(proto), PARAMS(args), PARAMS(cond), \
	84	PARAMS(tstruct), PARAMS(assign), PARAMS(print)) \
97419875	85
1ed0c597 FW	86	#undef TRACE_EVENT_FLAGS
1ed0c597 FW	87	#define TRACE_EVENT_FLAGS(name, value) \
53cf810b	88	__TRACE_EVENT_FLAGS(name, value)
1ed0c597	89
d5b5f391 PZ	90	#undef TRACE_EVENT_PERF_PERM
	91	#define TRACE_EVENT_PERF_PERM(name, expr...) \
	92	__TRACE_EVENT_PERF_PERM(name, expr)
	93
f42c85e7 SR	94	#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
	95
	96	/*
	97	* Stage 2 of the trace events.
	98	*
9cbf1176 FW	99	* Include the following:
9cbf1176 FW	100	*
62323a14	101	* struct trace_event_data_offsets_<call> {
7d536cb3 LZ	102	* u32 <item1>;
7d536cb3 LZ	103	* u32 <item2>;
9cbf1176 FW	104	* [...]
	105	* };
	106	*
7d536cb3	107	* The __dynamic_array() macro will create each u32 <item>, this is
7fcb7c47	108	* to keep the offset of each array from the beginning of the event.
7d536cb3	109	* The size of an array is also encoded, in the higher 16 bits of <item>.
9cbf1176 FW	110	*/
9cbf1176 FW	111
84055411	112	#include "stages/stage2_data_offsets.h"
4449bf92	113
091ad365 IM	114	#undef DECLARE_EVENT_CLASS
091ad365 IM	115	#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
62323a14	116	struct trace_event_data_offsets_##call { \
9cbf1176 FW	117	tstruct; \
	118	};
	119
ff038f5c SR	120	#undef DEFINE_EVENT
	121	#define DEFINE_EVENT(template, name, proto, args)
	122
e5bc9721	123	#undef DEFINE_EVENT_PRINT
61df16fc	124	#define DEFINE_EVENT_PRINT(template, name, proto, args, print)
e5bc9721	125
1ed0c597 FW	126	#undef TRACE_EVENT_FLAGS
	127	#define TRACE_EVENT_FLAGS(event, flag)
	128
d5b5f391 PZ	129	#undef TRACE_EVENT_PERF_PERM
	130	#define TRACE_EVENT_PERF_PERM(event, expr...)
	131
9cbf1176 FW	132	#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
	133
	134	/*
	135	* Stage 3 of the trace events.
	136	*
eba12ab7 HP	137	* Override the macros in the event tracepoint header <trace/events/XXX.h>
eba12ab7 HP	138	* to include the following:
f42c85e7 SR	139	*
f42c85e7 SR	140	* enum print_line_t
892c505a	141	* trace_raw_output_<call>(struct trace_iterator *iter, int flags)
f42c85e7 SR	142	* {
f42c85e7 SR	143	* struct trace_seq *s = &iter->seq;
a7237765	144	* struct trace_event_raw_<call> *field; <-- defined in stage 1
bc289ae9	145	* struct trace_seq *p = &iter->tmp_seq;
1600cbcf MH	146	*
	147	* -------(for event)-------
	148	*
	149	* struct trace_entry *entry;
f42c85e7 SR	150	*
	151	* entry = iter->ent;
	152	*
32c0edae	153	* if (entry->type != event_<call>->event.type) {
f42c85e7 SR	154	* WARN_ON_ONCE(1);
	155	* return TRACE_TYPE_UNHANDLED;
	156	* }
	157	*
	158	* field = (typeof(field))entry;
	159	*
56d8bd3f	160	* trace_seq_init(p);
1600cbcf MH	161	* return trace_output_call(iter, <call>, <TP_printk> "\n");
	162	*
	163	* ------(or, for event class)------
	164	*
	165	* int ret;
	166	*
	167	* field = (typeof(field))iter->ent;
	168	*
	169	* ret = trace_raw_output_prep(iter, trace_event);
	170	* if (ret != TRACE_TYPE_HANDLED)
	171	* return ret;
	172	*
	173	* trace_event_printf(iter, <TP_printk> "\n");
f42c85e7	174	*
1600cbcf MH	175	* return trace_handle_return(s);
	176	* -------
	177	* }
f42c85e7 SR	178	*
	179	* This is the method used to print the raw event to the trace
	180	* output format. Note, this is not needed if the data is read
	181	* in binary.
	182	*/
	183
84055411	184	#include "stages/stage3_trace_output.h"
62de4f29	185
091ad365 IM	186	#undef DECLARE_EVENT_CLASS
091ad365 IM	187	#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
83f0d539	188	static notrace enum print_line_t \
892c505a SRRH	189	trace_raw_output_##call(struct trace_iterator *iter, int flags, \
892c505a SRRH	190	struct trace_event *trace_event) \
f42c85e7 SR	191	{ \
f42c85e7 SR	192	struct trace_seq *s = &iter->seq; \
f71130de	193	struct trace_seq __maybe_unused *p = &iter->tmp_seq; \
a7237765	194	struct trace_event_raw_##call *field; \
f42c85e7 SR	195	int ret; \
f42c85e7 SR	196	\
f71130de	197	field = (typeof(field))iter->ent; \
80decc70	198	\
892c505a	199	ret = trace_raw_output_prep(iter, trace_event); \
8e2e095c	200	if (ret != TRACE_TYPE_HANDLED) \
f71130de LZ	201	return ret; \
f71130de LZ	202	\
efbbdaa2	203	trace_event_printf(iter, print); \
f42c85e7	204	\
19a7fe20	205	return trace_handle_return(s); \
80decc70	206	} \
3ad017ba	207	static struct trace_event_functions trace_event_type_funcs_##call = { \
892c505a	208	.trace = trace_raw_output_##call, \
80decc70	209	};
ff038f5c	210
e5bc9721 SR	211	#undef DEFINE_EVENT_PRINT
e5bc9721 SR	212	#define DEFINE_EVENT_PRINT(template, call, proto, args, print) \
83f0d539	213	static notrace enum print_line_t \
892c505a	214	trace_raw_output_##call(struct trace_iterator *iter, int flags, \
a9a57763	215	struct trace_event *event) \
e5bc9721	216	{ \
a7237765	217	struct trace_event_raw_##template *field; \
e5bc9721	218	struct trace_entry *entry; \
bc289ae9	219	struct trace_seq *p = &iter->tmp_seq; \
f42c85e7 SR	220	\
	221	entry = iter->ent; \
	222	\
32c0edae	223	if (entry->type != event_##call.event.type) { \
f42c85e7 SR	224	WARN_ON_ONCE(1); \
	225	return TRACE_TYPE_UNHANDLED; \
	226	} \
	227	\
	228	field = (typeof(field))entry; \
	229	\
56d8bd3f	230	trace_seq_init(p); \
892c505a	231	return trace_output_call(iter, #call, print); \
80decc70	232	} \
3ad017ba	233	static struct trace_event_functions trace_event_type_funcs_##call = { \
892c505a	234	.trace = trace_raw_output_##call, \
80decc70	235	};
e5bc9721	236
f42c85e7 SR	237	#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
f42c85e7 SR	238
84055411	239	#include "stages/stage4_event_fields.h"
55de2c0b	240
091ad365 IM	241	#undef DECLARE_EVENT_CLASS
091ad365 IM	242	#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, func, print) \
04ae87a5 PZ	243	static struct trace_event_fields trace_event_fields_##call[] = { \
	244	tstruct \
	245	{} };
f42c85e7	246
e5bc9721	247	#undef DEFINE_EVENT_PRINT
61df16fc	248	#define DEFINE_EVENT_PRINT(template, name, proto, args, print)
e5bc9721	249
f42c85e7 SR	250	#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
f42c85e7 SR	251
84055411	252	#include "stages/stage5_get_offsets.h"
55de2c0b	253
091ad365 IM	254	#undef DECLARE_EVENT_CLASS
091ad365 IM	255	#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
d0ee8f4a	256	static inline notrace int trace_event_get_offsets_##call( \
62323a14	257	struct trace_event_data_offsets_##call *__data_offsets, proto) \
7fcb7c47 LZ	258	{ \
7fcb7c47 LZ	259	int __data_size = 0; \
114e7b52	260	int __maybe_unused __item_length; \
a7237765	261	struct trace_event_raw_##call __maybe_unused *entry; \
7fcb7c47 LZ	262	\
	263	tstruct; \
	264	\
	265	return __data_size; \
	266	}
	267
	268	#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
	269
46ac5182 SRRH	270	/*
	271	* Stage 4 of the trace events.
	272	*
eba12ab7 HP	273	* Override the macros in the event tracepoint header <trace/events/XXX.h>
eba12ab7 HP	274	* to include the following:
46ac5182 SRRH	275	*
	276	* For those macros defined with TRACE_EVENT:
	277	*
	278	* static struct trace_event_call event_<call>;
	279	*
	280	* static void trace_event_raw_event_<call>(void *__data, proto)
	281	* {
	282	* struct trace_event_file *trace_file = __data;
	283	* struct trace_event_call *event_call = trace_file->event_call;
	284	* struct trace_event_data_offsets_<call> __maybe_unused __data_offsets;
	285	* unsigned long eflags = trace_file->flags;
	286	* enum event_trigger_type __tt = ETT_NONE;
	287	* struct ring_buffer_event *event;
	288	* struct trace_event_raw_<call> *entry; <-- defined in stage 1
13292494	289	* struct trace_buffer *buffer;
46ac5182 SRRH	290	* unsigned long irq_flags;
	291	* int __data_size;
	292	* int pc;
	293	*
	294	* if (!(eflags & EVENT_FILE_FL_TRIGGER_COND)) {
	295	* if (eflags & EVENT_FILE_FL_TRIGGER_MODE)
	296	* event_triggers_call(trace_file, NULL);
	297	* if (eflags & EVENT_FILE_FL_SOFT_DISABLED)
	298	* return;
	299	* }
	300	*
	301	* local_save_flags(irq_flags);
	302	* pc = preempt_count();
	303	*
	304	* __data_size = trace_event_get_offsets_<call>(&__data_offsets, args);
	305	*
	306	* event = trace_event_buffer_lock_reserve(&buffer, trace_file,
	307	* event_<call>->event.type,
	308	* sizeof(*entry) + __data_size,
	309	* irq_flags, pc);
	310	* if (!event)
	311	* return;
	312	* entry = ring_buffer_event_data(event);
	313	*
	314	* { <assign>; } <-- Here we assign the entries by the __field and
	315	* __array macros.
	316	*
	317	* if (eflags & EVENT_FILE_FL_TRIGGER_COND)
	318	* __tt = event_triggers_call(trace_file, entry);
	319	*
	320	* if (test_bit(EVENT_FILE_FL_SOFT_DISABLED_BIT,
	321	* &trace_file->flags))
	322	* ring_buffer_discard_commit(buffer, event);
	323	* else if (!filter_check_discard(trace_file, entry, buffer, event))
	324	* trace_buffer_unlock_commit(buffer, event, irq_flags, pc);
	325	*
	326	* if (__tt)
	327	* event_triggers_post_call(trace_file, __tt);
	328	* }
	329	*
	330	* static struct trace_event ftrace_event_type_<call> = {
	331	* .trace = trace_raw_output_<call>, <-- stage 2
	332	* };
	333	*
	334	* static char print_fmt_<call>[] = <TP_printk>;
	335	*
	336	* static struct trace_event_class __used event_class_<template> = {
	337	* .system = "<system>",
04ae87a5	338	* .fields_array = trace_event_fields_<call>,
46ac5182 SRRH	339	* .fields = LIST_HEAD_INIT(event_class_##call.fields),
	340	* .raw_init = trace_event_raw_init,
	341	* .probe = trace_event_raw_event_##call,
	342	* .reg = trace_event_reg,
	343	* };
	344	*
	345	* static struct trace_event_call event_<call> = {
	346	* .class = event_class_<template>,
	347	* {
	348	* .tp = &__tracepoint_<call>,
	349	* },
	350	* .event = &ftrace_event_type_<call>,
	351	* .print_fmt = print_fmt_<call>,
	352	* .flags = TRACE_EVENT_FL_TRACEPOINT,
	353	* };
	354	* // its only safe to use pointers when doing linker tricks to
	355	* // create an array.
	356	* static struct trace_event_call __used
33def849	357	* __section("_ftrace_events") *__event_<call> = &event_<call>;
46ac5182 SRRH	358	*
	359	*/
	360
	361	#ifdef CONFIG_PERF_EVENTS
	362
	363	#define _TRACE_PERF_PROTO(call, proto) \
	364	static notrace void \
	365	perf_trace_##call(void *__data, proto);
	366
	367	#define _TRACE_PERF_INIT(call) \
	368	.perf_probe = perf_trace_##call,
	369
	370	#else
	371	#define _TRACE_PERF_PROTO(call, proto)
	372	#define _TRACE_PERF_INIT(call)
	373	#endif /* CONFIG_PERF_EVENTS */
	374
84055411	375	#include "stages/stage6_event_callback.h"
46ac5182 SRRH	376
	377	#undef DECLARE_EVENT_CLASS
	378	#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
	379	\
	380	static notrace void \
	381	trace_event_raw_event_##call(void *__data, proto) \
	382	{ \
	383	struct trace_event_file *trace_file = __data; \
	384	struct trace_event_data_offsets_##call __maybe_unused __data_offsets;\
	385	struct trace_event_buffer fbuffer; \
	386	struct trace_event_raw_##call *entry; \
	387	int __data_size; \
	388	\
	389	if (trace_trigger_soft_disabled(trace_file)) \
	390	return; \
	391	\
	392	__data_size = trace_event_get_offsets_##call(&__data_offsets, args); \
	393	\
	394	entry = trace_event_buffer_reserve(&fbuffer, trace_file, \
	395	sizeof(*entry) + __data_size); \
	396	\
	397	if (!entry) \
	398	return; \
	399	\
	400	tstruct \
	401	\
	402	{ assign; } \
	403	\
	404	trace_event_buffer_commit(&fbuffer); \
	405	}
	406	/*
	407	* The ftrace_test_probe is compiled out, it is only here as a build time check
	408	* to make sure that if the tracepoint handling changes, the ftrace probe will
	409	* fail to compile unless it too is updated.
	410	*/
	411
	412	#undef DEFINE_EVENT
	413	#define DEFINE_EVENT(template, call, proto, args) \
	414	static inline void ftrace_test_probe_##call(void) \
	415	{ \
	416	check_trace_callback_type_##call(trace_event_raw_event_##template); \
	417	}
	418
46ac5182 SRRH	419	#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
46ac5182 SRRH	420
84055411	421	#include "stages/stage7_class_define.h"
46ac5182 SRRH	422
	423	#undef DECLARE_EVENT_CLASS
	424	#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
	425	_TRACE_PERF_PROTO(call, PARAMS(proto)); \
	426	static char print_fmt_##call[] = print; \
	427	static struct trace_event_class __used __refdata event_class_##call = { \
	428	.system = TRACE_SYSTEM_STRING, \
04ae87a5	429	.fields_array = trace_event_fields_##call, \
46ac5182 SRRH	430	.fields = LIST_HEAD_INIT(event_class_##call.fields),\
	431	.raw_init = trace_event_raw_init, \
	432	.probe = trace_event_raw_event_##call, \
	433	.reg = trace_event_reg, \
	434	_TRACE_PERF_INIT(call) \
	435	};
	436
	437	#undef DEFINE_EVENT
	438	#define DEFINE_EVENT(template, call, proto, args) \
	439	\
	440	static struct trace_event_call __used event_##call = { \
	441	.class = &event_class_##template, \
	442	{ \
	443	.tp = &__tracepoint_##call, \
	444	}, \
	445	.event.funcs = &trace_event_type_funcs_##template, \
	446	.print_fmt = print_fmt_##template, \
	447	.flags = TRACE_EVENT_FL_TRACEPOINT, \
	448	}; \
	449	static struct trace_event_call __used \
33def849	450	__section("_ftrace_events") *__event_##call = &event_##call
46ac5182 SRRH	451
	452	#undef DEFINE_EVENT_PRINT
	453	#define DEFINE_EVENT_PRINT(template, call, proto, args, print) \
	454	\
	455	static char print_fmt_##call[] = print; \
	456	\
	457	static struct trace_event_call __used event_##call = { \
	458	.class = &event_class_##template, \
	459	{ \
	460	.tp = &__tracepoint_##call, \
	461	}, \
	462	.event.funcs = &trace_event_type_funcs_##call, \
	463	.print_fmt = print_fmt_##call, \
	464	.flags = TRACE_EVENT_FL_TRACEPOINT, \
	465	}; \
	466	static struct trace_event_call __used \
33def849	467	__section("_ftrace_events") *__event_##call = &event_##call
46ac5182 SRRH	468
46ac5182 SRRH	469	#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)