[lttng-modules.git] / probes / lttng-events.h

#include <linux/debugfs.h>
#include "lttng.h"
#include "lttng-types.h"
#include "../wrapper/vmalloc.h"	/* for wrapper_vmalloc_sync_all() */
#include "../wrapper/ringbuffer/frontend_types.h"
#include "../ltt-events.h"
#include "../ltt-tracer-core.h"

/*
 * Macro declarations used for all stages.
 */

/*
 * 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))

#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 LTTng. */
#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))		\

/*
 * Stage 1 of the trace events.
 *
 * Create dummy trace calls for each events, verifying that the LTTng module
 * TRACE_EVENT headers match the kernel arguments. Will be optimized out by the
 * compiler.
 */

#include "lttng-events-reset.h"	/* Reset all macros within TRACE_EVENT */

#undef TP_PROTO
#define TP_PROTO(args...) args

#undef TP_ARGS
#define TP_ARGS(args...) args

#undef DEFINE_EVENT
#define DEFINE_EVENT(_template, _name, _proto, _args)			\
void trace_##_name(_proto);

#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

/*
 * Stage 2 of the trace events.
 *
 * Create event field type metadata section.
 * Each event produce an array of fields.
 */

#include "lttng-events-reset.h"	/* Reset all macros within TRACE_EVENT */

/* Named field types must be defined in lttng-types.h */

#undef __field
#define __field(_type, _item)					\
	{							\
	  .name = #_item,					\
	  .type = __type_integer(_type, __BYTE_ORDER, 10, none),\
	},

#undef __field_ext
#define __field_ext(_type, _item, _filter_type)		__field(_type, _item)

#undef __field_network
#define __field_network(_type, _item)				\
	{							\
	  .name = #_item,					\
	  .type = __type_integer(_type, __BIG_ENDIAN, 10, none),\
	},

#undef __array_enc
#define __array_enc(_type, _item, _length, _encoding)		\
	{							\
	  .name = #_item,					\
	  .type =						\
		{						\
		  .atype = atype_array,				\
		  .u.array =					\
			{					\
			    .length = _length,			\
			    .elem_type = __type_integer(_type, __BYTE_ORDER, 10, _encoding), \
			},					\
		},						\
	},

#undef __array
#define __array(_type, _item, _length)				\
	__array_enc(_type, _item, _length, none)

#undef __array_text
#define __array_text(_type, _item, _length)			\
	__array_enc(_type, _item, _length, UTF8)

#undef __dynamic_array_enc
#define __dynamic_array_enc(_type, _item, _length, _encoding)	\
	{							\
	  .name = #_item,					\
	  .type =						\
		{						\
		  .atype = atype_sequence,			\
		  .u.sequence =					\
			{					\
			    .length_type = __type_integer(u32, __BYTE_ORDER, 10, none), \
			    .elem_type = __type_integer(_type, __BYTE_ORDER, 10, _encoding), \
			},					\
		},						\
	},

#undef __dynamic_array
#define __dynamic_array(_type, _item, _length)			\
	__dynamic_array_enc(_type, _item, _length, none)

#undef __dynamic_array_text
#define __dynamic_array_text(_type, _item, _length)		\
	__dynamic_array_enc(_type, _item, _length, UTF8)

#undef __string
#define __string(_item, _src)					\
	{							\
	  .name = #_item,					\
	  .type =						\
		{						\
		  .atype = atype_string,			\
		  .u.basic.string.encoding = lttng_encode_UTF8,	\
		},						\
	},

#undef TP_STRUCT__entry
#define TP_STRUCT__entry(args...) args	/* Only one used in this phase */

#undef DECLARE_EVENT_CLASS
#define DECLARE_EVENT_CLASS(_name, _proto, _args, _tstruct, _assign, _print) \
	static const struct lttng_event_field __event_fields___##_name[] = { \
		_tstruct						     \
	};

#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

#undef __type_integer

/*
 * Stage 3 of the trace events.
 *
 * Create probe callback prototypes.
 */

#include "lttng-events-reset.h"	/* Reset all macros within TRACE_EVENT */

#undef TP_PROTO
#define TP_PROTO(args...) args

#undef DECLARE_EVENT_CLASS
#define DECLARE_EVENT_CLASS(_name, _proto, _args, _tstruct, _assign, _print)  \
static void __event_probe__##_name(void *__data, _proto);

#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

/*
 * Stage 4 of the trace events.
 *
 * Create an array of events.
 */

/* Named field types must be defined in lttng-types.h */

#include "lttng-events-reset.h"	/* Reset all macros within TRACE_EVENT */

#undef DEFINE_EVENT
#define DEFINE_EVENT(_template, _name, _proto, _args)			       \
		{							       \
			.fields = __event_fields___##_template,		       \
			.name = #_name,					       \
			.probe_callback = (void *) &__event_probe__##_template,\
			.nr_fields = ARRAY_SIZE(__event_fields___##_template), \
		},

#define TP_ID1(_token, _system)	_token##_system
#define TP_ID(_token, _system)	TP_ID1(_token, _system)

static const struct lttng_event_desc TP_ID(__event_desc___, TRACE_SYSTEM)[] = {
#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
};

#undef TP_ID1
#undef TP_ID


/*
 * Stage 5 of the trace events.
 *
 * Create a toplevel descriptor for the whole probe.
 */

#define TP_ID1(_token, _system)	_token##_system
#define TP_ID(_token, _system)	TP_ID1(_token, _system)

/* non-const because list head will be modified when registered. */
static struct lttng_probe_desc TP_ID(__probe_desc___, TRACE_SYSTEM) = {
	.event_desc = TP_ID(__event_desc___, TRACE_SYSTEM),
	.nr_events = ARRAY_SIZE(TP_ID(__event_desc___, TRACE_SYSTEM)),
};

#undef TP_ID1
#undef TP_ID

/*
 * Stage 6 of the trace events.
 *
 * Create static inline function that calculates event size.
 */

#include "lttng-events-reset.h"	/* Reset all macros within TRACE_EVENT */

/* Named field types must be defined in lttng-types.h */

#undef __field
#define __field(_type, _item)						       \
	__event_len += lib_ring_buffer_align(__event_len, ltt_alignof(_type)); \
	__event_len += sizeof(_type);

#undef __field_ext
#define __field_ext(_type, _item, _filter_type)	__field(_type, _item)

#undef __array
#define __array(_type, _item, _length)					       \
	__event_len += lib_ring_buffer_align(__event_len, ltt_alignof(_type)); \
	__event_len += sizeof(_type) * (_length);

#undef __array_text
#define __array_text(_type, _item, _length)				       \
	__array(_type, _item, _length)

#undef __dynamic_array
#define __dynamic_array(_type, _item, _length)				       \
	__event_len += lib_ring_buffer_align(__event_len, ltt_alignof(u32));   \
	__event_len += sizeof(u32);					       \
	__event_len += lib_ring_buffer_align(__event_len, ltt_alignof(_type)); \
	__event_len += sizeof(_type) * (_length);

#undef __dynamic_array_text
#define __dynamic_array_text(_type, _item, _length)			       \
	__dynamic_array(_type, _item, _length)

#undef __string
#define __string(_item, _src)						       \
	__event_len += __dynamic_len[__dynamic_len_idx++] = strlen(_src) + 1;

#undef TP_PROTO
#define TP_PROTO(args...) args

#undef TP_STRUCT__entry
#define TP_STRUCT__entry(args...) args

#undef DECLARE_EVENT_CLASS
#define DECLARE_EVENT_CLASS(_name, _proto, _args, _tstruct, _assign, _print)  \
static inline size_t __event_get_size__##_name(size_t *__dynamic_len, _proto) \
{									      \
	size_t __event_len = 0;						      \
	unsigned int __dynamic_len_idx = 0;				      \
									      \
	if (0)								      \
		(void) __dynamic_len_idx;	/* don't warn if unused */    \
	_tstruct							      \
	return __event_len;						      \
}

#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

/*
 * Stage 7 of the trace events.
 *
 * Create static inline function that calculates event payload alignment.
 */

#include "lttng-events-reset.h"	/* Reset all macros within TRACE_EVENT */

/* Named field types must be defined in lttng-types.h */

#undef __field
#define __field(_type, _item)						  \
	__event_align = max_t(size_t, __event_align, ltt_alignof(_type));

#undef __field_ext
#define __field_ext(_type, _item, _filter_type)	__field(_type, _item)

#undef __array
#define __array(_type, _item, _length)					  \
	__event_align = max_t(size_t, __event_align, ltt_alignof(_type));

#undef __array_text
#define __array_text(_type, _item, _length)				  \
	__array(_type, _item, _length)

#undef __dynamic_array
#define __dynamic_array(_type, _item, _length)				  \
	__event_align = max_t(size_t, __event_align, ltt_alignof(u32));	  \
	__event_align = max_t(size_t, __event_align, ltt_alignof(_type));

#undef __dynamic_array_text
#define __dynamic_array_text(_type, _item, _length)			  \
	__dynamic_array(_type, _item, _length)

#undef __string
#define __string(_item, _src)

#undef TP_PROTO
#define TP_PROTO(args...) args

#undef TP_STRUCT__entry
#define TP_STRUCT__entry(args...) args

#undef DECLARE_EVENT_CLASS
#define DECLARE_EVENT_CLASS(_name, _proto, _args, _tstruct, _assign, _print)  \
static inline size_t __event_get_align__##_name(_proto)			      \
{									      \
	size_t __event_align = 1;					      \
	_tstruct							      \
	return __event_align;						      \
}

#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)


/*
 * Stage 8 of the trace events.
 *
 * Create structure declaration that allows the "assign" macros to access the
 * field types.
 */

#include "lttng-events-reset.h"	/* Reset all macros within TRACE_EVENT */

/* Named field types must be defined in lttng-types.h */

#undef __field
#define __field(_type, _item)	_type	_item;

#undef __field_ext
#define __field_ext(_type, _item, _filter_type)	__field(_type, _item)

#undef __array
#define __array(_type, _item, _length)	_type	_item;

#undef __array_text
#define __array_text(_type, _item, _length)				  \
	__array(_type, _item, _length)

#undef __dynamic_array
#define __dynamic_array(_type, _item, _length)	_type	_item;

#undef __dynamic_array_text
#define __dynamic_array_text(_type, _item, _length)			  \
	__dynamic_array(_type, _item, _length)

#undef __string
#define __string(_item, _src)	char _item;

#undef TP_STRUCT__entry
#define TP_STRUCT__entry(args...) args

#undef DECLARE_EVENT_CLASS
#define DECLARE_EVENT_CLASS(_name, _proto, _args, _tstruct, _assign, _print)  \
struct __event_typemap__##_name {					      \
	_tstruct							      \
};

#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)


/*
 * Stage 9 of the trace events.
 *
 * Create the probe function : call even size calculation and write event data
 * into the buffer.
 *
 * We use both the field and assignment macros to write the fields in the order
 * defined in the field declaration. The field declarations control the
 * execution order, jumping to the appropriate assignment block.
 */

#include "lttng-events-reset.h"	/* Reset all macros within TRACE_EVENT */

#undef __field
#define __field(_type, _item)						\
	goto __assign_##_item;						\
__end_field_##_item:

#undef __field_ext
#define __field_ext(_type, _item, _filter_type)	__field(_type, _item)

#undef __array
#define __array(_type, _item, _length)					\
	goto __assign_##_item;						\
__end_field_##_item:

#undef __array_text
#define __array_text(_type, _item, _length)				\
	__array(_type, _item, _length)

#undef __dynamic_array
#define __dynamic_array(_type, _item, _length)				\
	goto __assign_##_item##_1;					\
__end_field_##_item##_1:						\
	goto __assign_##_item##_2;					\
__end_field_##_item##_2:

#undef __dynamic_array_text
#define __dynamic_array_text(_type, _item, _length)			\
	__dynamic_array(_type, _item, _length)

#undef __string
#define __string(_item, _src)						\
	goto __assign_##_item;						\
__end_field_##_item:

/*
 * Macros mapping tp_assign() to "=", tp_memcpy() to memcpy() and tp_strcpy() to
 * strcpy().
 */
#undef tp_assign
#define tp_assign(dest, src)						\
__assign_##dest:							\
	{								\
		__typeof__(__typemap.dest) __tmp = (src);		\
		lib_ring_buffer_align_ctx(&ctx, ltt_alignof(__tmp));	\
		__chan->ops->event_write(&ctx, &__tmp, sizeof(__tmp));	\
	}								\
	goto __end_field_##dest;

#undef tp_memcpy
#define tp_memcpy(dest, src, len)					\
__assign_##dest:							\
	if (0)								\
		(void) __typemap.dest;					\
	lib_ring_buffer_align_ctx(&ctx, ltt_alignof(__typemap.dest));	\
	__chan->ops->event_write(&ctx, src, len);			\
	goto __end_field_##dest;

#undef tp_memcpy_dyn
#define tp_memcpy_dyn(dest, src, len)					\
__assign_##dest##_1:							\
	{								\
		u32 __tmpl = (len);					\
		lib_ring_buffer_align_ctx(&ctx, ltt_alignof(u32));	\
		__chan->ops->event_write(&ctx, &__tmpl, sizeof(u32));	\
	}								\
	goto __end_field_##dest##_1;					\
__assign_##dest##_2:							\
	lib_ring_buffer_align_ctx(&ctx, ltt_alignof(__typemap.dest));	\
	__chan->ops->event_write(&ctx, src, len);			\
	goto __end_field_##dest##_2;

#undef tp_strcpy
#define tp_strcpy(dest, src)						\
	tp_memcpy(dest, src, __get_dynamic_array_len(dest))

/* Named field types must be defined in lttng-types.h */

#undef __get_str
#define __get_str(field)		field

#undef __get_dynamic_array
#define __get_dynamic_array(field)	field

/* Beware: this get len actually consumes the len value */
#undef __get_dynamic_array_len
#define __get_dynamic_array_len(field)	__dynamic_len[__dynamic_len_idx++]

#undef TP_PROTO
#define TP_PROTO(args...) args

#undef TP_ARGS
#define TP_ARGS(args...) args

#undef TP_STRUCT__entry
#define TP_STRUCT__entry(args...) args

#undef TP_fast_assign
#define TP_fast_assign(args...) args

#undef DECLARE_EVENT_CLASS
#define DECLARE_EVENT_CLASS(_name, _proto, _args, _tstruct, _assign, _print)  \
static void __event_probe__##_name(void *__data, _proto)		      \
{									      \
	struct ltt_event *__event = __data;				      \
	struct ltt_channel *__chan = __event->chan;			      \
	struct lib_ring_buffer_ctx ctx;					      \
	size_t __event_len, __event_align;				      \
	size_t __dynamic_len_idx = 0;					      \
	size_t __dynamic_len[ARRAY_SIZE(__event_fields___##_name)];	      \
	struct __event_typemap__##_name __typemap;			      \
	int __ret;							      \
									      \
	if (0)								      \
		(void) __dynamic_len_idx;	/* don't warn if unused */    \
	if (!ACCESS_ONCE(__chan->session->active))			      \
		return;							      \
	__event_len = __event_get_size__##_name(__dynamic_len, _args);	      \
	__event_align = __event_get_align__##_name(_args);		      \
	lib_ring_buffer_ctx_init(&ctx, __chan->chan, NULL, __event_len,	      \
				 __event_align, -1);			      \
	__ret = __chan->ops->event_reserve(&ctx, __event->id);		      \
	if (__ret < 0)							      \
		return;							      \
	/* Control code (field ordering) */				      \
	_tstruct							      \
	__chan->ops->event_commit(&ctx);				      \
	return;								      \
	/* Copy code, steered by control code */			      \
	_assign								      \
}

#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

/*
 * Stage 10 of the trace events.
 *
 * Register/unregister probes at module load/unload.
 */

#include "lttng-events-reset.h"	/* Reset all macros within TRACE_EVENT */

#define TP_ID1(_token, _system)	_token##_system
#define TP_ID(_token, _system)	TP_ID1(_token, _system)
#define module_init_eval1(_token, _system)	module_init(_token##_system)
#define module_init_eval(_token, _system)	module_init_eval1(_token, _system)
#define module_exit_eval1(_token, _system)	module_exit(_token##_system)
#define module_exit_eval(_token, _system)	module_exit_eval1(_token, _system)

static int TP_ID(__lttng_events_init__, TRACE_SYSTEM)(void)
{
	wrapper_vmalloc_sync_all();
	return ltt_probe_register(&TP_ID(__probe_desc___, TRACE_SYSTEM));
}

module_init_eval(__lttng_events_init__, TRACE_SYSTEM);

static void TP_ID(__lttng_events_exit__, TRACE_SYSTEM)(void)
{
	ltt_probe_unregister(&TP_ID(__probe_desc___, TRACE_SYSTEM));
}

module_exit_eval(__lttng_events_exit__, TRACE_SYSTEM);

#undef module_init_eval
#undef module_exit_eval
#undef TP_ID1
#undef TP_ID
Commit	Line	Data
	1	#include <linux/debugfs.h>
	2	#include "lttng.h"
	3	#include "lttng-types.h"
	4	#include "../wrapper/vmalloc.h" /* for wrapper_vmalloc_sync_all() */
	5	#include "../wrapper/ringbuffer/frontend_types.h"
	6	#include "../ltt-events.h"
	7	#include "../ltt-tracer-core.h"
	8
	9	/*
	10	* Macro declarations used for all stages.
	11	*/
	12
	13	/*
	14	* DECLARE_EVENT_CLASS can be used to add a generic function
	15	* handlers for events. That is, if all events have the same
	16	* parameters and just have distinct trace points.
	17	* Each tracepoint can be defined with DEFINE_EVENT and that
	18	* will map the DECLARE_EVENT_CLASS to the tracepoint.
	19	*
	20	* TRACE_EVENT is a one to one mapping between tracepoint and template.
	21	*/
	22
	23	#undef TRACE_EVENT
	24	#define TRACE_EVENT(name, proto, args, tstruct, assign, print) \
	25	DECLARE_EVENT_CLASS(name, \
	26	PARAMS(proto), \
	27	PARAMS(args), \
	28	PARAMS(tstruct), \
	29	PARAMS(assign), \
	30	PARAMS(print)) \
	31	DEFINE_EVENT(name, name, PARAMS(proto), PARAMS(args))
	32
	33	#undef DEFINE_EVENT_PRINT
	34	#define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
	35	DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
	36
	37	/* Callbacks are meaningless to LTTng. */
	38	#undef TRACE_EVENT_FN
	39	#define TRACE_EVENT_FN(name, proto, args, tstruct, \
	40	assign, print, reg, unreg) \
	41	TRACE_EVENT(name, PARAMS(proto), PARAMS(args), \
	42	PARAMS(tstruct), PARAMS(assign), PARAMS(print)) \
	43
	44	/*
	45	* Stage 1 of the trace events.
	46	*
	47	* Create dummy trace calls for each events, verifying that the LTTng module
	48	* TRACE_EVENT headers match the kernel arguments. Will be optimized out by the
	49	* compiler.
	50	*/
	51
	52	#include "lttng-events-reset.h" /* Reset all macros within TRACE_EVENT */
	53
	54	#undef TP_PROTO
	55	#define TP_PROTO(args...) args
	56
	57	#undef TP_ARGS
	58	#define TP_ARGS(args...) args
	59
	60	#undef DEFINE_EVENT
	61	#define DEFINE_EVENT(_template, _name, _proto, _args) \
	62	void trace_##_name(_proto);
	63
	64	#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
	65
	66	/*
	67	* Stage 2 of the trace events.
	68	*
	69	* Create event field type metadata section.
	70	* Each event produce an array of fields.
	71	*/
	72
	73	#include "lttng-events-reset.h" /* Reset all macros within TRACE_EVENT */
	74
	75	/* Named field types must be defined in lttng-types.h */
	76
	77	#undef __field
	78	#define __field(_type, _item) \
	79	{ \
	80	.name = #_item, \
	81	.type = __type_integer(_type, __BYTE_ORDER, 10, none),\
	82	},
	83
	84	#undef __field_ext
	85	#define __field_ext(_type, _item, _filter_type) __field(_type, _item)
	86
	87	#undef __field_network
	88	#define __field_network(_type, _item) \
	89	{ \
	90	.name = #_item, \
	91	.type = __type_integer(_type, __BIG_ENDIAN, 10, none),\
	92	},
	93
	94	#undef __array_enc
	95	#define __array_enc(_type, _item, _length, _encoding) \
	96	{ \
	97	.name = #_item, \
	98	.type = \
	99	{ \
	100	.atype = atype_array, \
	101	.u.array = \
	102	{ \
	103	.length = _length, \
	104	.elem_type = __type_integer(_type, __BYTE_ORDER, 10, _encoding), \
	105	}, \
	106	}, \
	107	},
	108
	109	#undef __array
	110	#define __array(_type, _item, _length) \
	111	__array_enc(_type, _item, _length, none)
	112
	113	#undef __array_text
	114	#define __array_text(_type, _item, _length) \
	115	__array_enc(_type, _item, _length, UTF8)
	116
	117	#undef __dynamic_array_enc
	118	#define __dynamic_array_enc(_type, _item, _length, _encoding) \
	119	{ \
	120	.name = #_item, \
	121	.type = \
	122	{ \
	123	.atype = atype_sequence, \
	124	.u.sequence = \
	125	{ \
	126	.length_type = __type_integer(u32, __BYTE_ORDER, 10, none), \
	127	.elem_type = __type_integer(_type, __BYTE_ORDER, 10, _encoding), \
	128	}, \
	129	}, \
	130	},
	131
	132	#undef __dynamic_array
	133	#define __dynamic_array(_type, _item, _length) \
	134	__dynamic_array_enc(_type, _item, _length, none)
	135
	136	#undef __dynamic_array_text
	137	#define __dynamic_array_text(_type, _item, _length) \
	138	__dynamic_array_enc(_type, _item, _length, UTF8)
	139
	140	#undef __string
	141	#define __string(_item, _src) \
	142	{ \
	143	.name = #_item, \
	144	.type = \
	145	{ \
	146	.atype = atype_string, \
	147	.u.basic.string.encoding = lttng_encode_UTF8, \
	148	}, \
	149	},
	150
	151	#undef TP_STRUCT__entry
	152	#define TP_STRUCT__entry(args...) args /* Only one used in this phase */
	153
	154	#undef DECLARE_EVENT_CLASS
	155	#define DECLARE_EVENT_CLASS(_name, _proto, _args, _tstruct, _assign, _print) \
	156	static const struct lttng_event_field __event_fields___##_name[] = { \
	157	_tstruct \
	158	};
	159
	160	#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
	161
	162	#undef __type_integer
	163
	164	/*
	165	* Stage 3 of the trace events.
	166	*
	167	* Create probe callback prototypes.
	168	*/
	169
	170	#include "lttng-events-reset.h" /* Reset all macros within TRACE_EVENT */
	171
	172	#undef TP_PROTO
	173	#define TP_PROTO(args...) args
	174
	175	#undef DECLARE_EVENT_CLASS
	176	#define DECLARE_EVENT_CLASS(_name, _proto, _args, _tstruct, _assign, _print) \
	177	static void __event_probe__##_name(void *__data, _proto);
	178
	179	#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
	180
	181	/*
	182	* Stage 4 of the trace events.
	183	*
	184	* Create an array of events.
	185	*/
	186
	187	/* Named field types must be defined in lttng-types.h */
	188
	189	#include "lttng-events-reset.h" /* Reset all macros within TRACE_EVENT */
	190
	191	#undef DEFINE_EVENT
	192	#define DEFINE_EVENT(_template, _name, _proto, _args) \
	193	{ \
	194	.fields = __event_fields___##_template, \
	195	.name = #_name, \
	196	.probe_callback = (void *) &__event_probe__##_template,\
	197	.nr_fields = ARRAY_SIZE(__event_fields___##_template), \
	198	},
	199
	200	#define TP_ID1(_token, _system) _token##_system
	201	#define TP_ID(_token, _system) TP_ID1(_token, _system)
	202
	203	static const struct lttng_event_desc TP_ID(__event_desc___, TRACE_SYSTEM)[] = {
	204	#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
	205	};
	206
	207	#undef TP_ID1
	208	#undef TP_ID
	209
	210
	211	/*
	212	* Stage 5 of the trace events.
	213	*
	214	* Create a toplevel descriptor for the whole probe.
	215	*/
	216
	217	#define TP_ID1(_token, _system) _token##_system
	218	#define TP_ID(_token, _system) TP_ID1(_token, _system)
	219
	220	/* non-const because list head will be modified when registered. */
	221	static struct lttng_probe_desc TP_ID(__probe_desc___, TRACE_SYSTEM) = {
	222	.event_desc = TP_ID(__event_desc___, TRACE_SYSTEM),
	223	.nr_events = ARRAY_SIZE(TP_ID(__event_desc___, TRACE_SYSTEM)),
	224	};
	225
	226	#undef TP_ID1
	227	#undef TP_ID
	228
	229	/*
	230	* Stage 6 of the trace events.
	231	*
	232	* Create static inline function that calculates event size.
	233	*/
	234
	235	#include "lttng-events-reset.h" /* Reset all macros within TRACE_EVENT */
	236
	237	/* Named field types must be defined in lttng-types.h */
	238
	239	#undef __field
	240	#define __field(_type, _item) \
	241	__event_len += lib_ring_buffer_align(__event_len, ltt_alignof(_type)); \
	242	__event_len += sizeof(_type);
	243
	244	#undef __field_ext
	245	#define __field_ext(_type, _item, _filter_type) __field(_type, _item)
	246
	247	#undef __array
	248	#define __array(_type, _item, _length) \
	249	__event_len += lib_ring_buffer_align(__event_len, ltt_alignof(_type)); \
	250	__event_len += sizeof(_type) * (_length);
	251
	252	#undef __array_text
	253	#define __array_text(_type, _item, _length) \
	254	__array(_type, _item, _length)
	255
	256	#undef __dynamic_array
	257	#define __dynamic_array(_type, _item, _length) \
	258	__event_len += lib_ring_buffer_align(__event_len, ltt_alignof(u32)); \
	259	__event_len += sizeof(u32); \
	260	__event_len += lib_ring_buffer_align(__event_len, ltt_alignof(_type)); \
	261	__event_len += sizeof(_type) * (_length);
	262
	263	#undef __dynamic_array_text
	264	#define __dynamic_array_text(_type, _item, _length) \
	265	__dynamic_array(_type, _item, _length)
	266
	267	#undef __string
	268	#define __string(_item, _src) \
	269	__event_len += __dynamic_len[__dynamic_len_idx++] = strlen(_src) + 1;
	270
	271	#undef TP_PROTO
	272	#define TP_PROTO(args...) args
	273
	274	#undef TP_STRUCT__entry
	275	#define TP_STRUCT__entry(args...) args
	276
	277	#undef DECLARE_EVENT_CLASS
	278	#define DECLARE_EVENT_CLASS(_name, _proto, _args, _tstruct, _assign, _print) \
	279	static inline size_t __event_get_size__##_name(size_t *__dynamic_len, _proto) \
	280	{ \
	281	size_t __event_len = 0; \
	282	unsigned int __dynamic_len_idx = 0; \
	283	\
	284	if (0) \
	285	(void) __dynamic_len_idx; /* don't warn if unused */ \
	286	_tstruct \
	287	return __event_len; \
	288	}
	289
	290	#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
	291
	292	/*
	293	* Stage 7 of the trace events.
	294	*
	295	* Create static inline function that calculates event payload alignment.
	296	*/
	297
	298	#include "lttng-events-reset.h" /* Reset all macros within TRACE_EVENT */
	299
	300	/* Named field types must be defined in lttng-types.h */
	301
	302	#undef __field
	303	#define __field(_type, _item) \
	304	__event_align = max_t(size_t, __event_align, ltt_alignof(_type));
	305
	306	#undef __field_ext
	307	#define __field_ext(_type, _item, _filter_type) __field(_type, _item)
	308
	309	#undef __array
	310	#define __array(_type, _item, _length) \
	311	__event_align = max_t(size_t, __event_align, ltt_alignof(_type));
	312
	313	#undef __array_text
	314	#define __array_text(_type, _item, _length) \
	315	__array(_type, _item, _length)
	316
	317	#undef __dynamic_array
	318	#define __dynamic_array(_type, _item, _length) \
	319	__event_align = max_t(size_t, __event_align, ltt_alignof(u32)); \
	320	__event_align = max_t(size_t, __event_align, ltt_alignof(_type));
	321
	322	#undef __dynamic_array_text
	323	#define __dynamic_array_text(_type, _item, _length) \
	324	__dynamic_array(_type, _item, _length)
	325
	326	#undef __string
	327	#define __string(_item, _src)
	328
	329	#undef TP_PROTO
	330	#define TP_PROTO(args...) args
	331
	332	#undef TP_STRUCT__entry
	333	#define TP_STRUCT__entry(args...) args
	334
	335	#undef DECLARE_EVENT_CLASS
	336	#define DECLARE_EVENT_CLASS(_name, _proto, _args, _tstruct, _assign, _print) \
	337	static inline size_t __event_get_align__##_name(_proto) \
	338	{ \
	339	size_t __event_align = 1; \
	340	_tstruct \
	341	return __event_align; \
	342	}
	343
	344	#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
	345
	346
	347	/*
	348	* Stage 8 of the trace events.
	349	*
	350	* Create structure declaration that allows the "assign" macros to access the
	351	* field types.
	352	*/
	353
	354	#include "lttng-events-reset.h" /* Reset all macros within TRACE_EVENT */
	355
	356	/* Named field types must be defined in lttng-types.h */
	357
	358	#undef __field
	359	#define __field(_type, _item) _type _item;
	360
	361	#undef __field_ext
	362	#define __field_ext(_type, _item, _filter_type) __field(_type, _item)
	363
	364	#undef __array
	365	#define __array(_type, _item, _length) _type _item;
	366
	367	#undef __array_text
	368	#define __array_text(_type, _item, _length) \
	369	__array(_type, _item, _length)
	370
	371	#undef __dynamic_array
	372	#define __dynamic_array(_type, _item, _length) _type _item;
	373
	374	#undef __dynamic_array_text
	375	#define __dynamic_array_text(_type, _item, _length) \
	376	__dynamic_array(_type, _item, _length)
	377
	378	#undef __string
	379	#define __string(_item, _src) char _item;
	380
	381	#undef TP_STRUCT__entry
	382	#define TP_STRUCT__entry(args...) args
	383
	384	#undef DECLARE_EVENT_CLASS
	385	#define DECLARE_EVENT_CLASS(_name, _proto, _args, _tstruct, _assign, _print) \
	386	struct __event_typemap__##_name { \
	387	_tstruct \
	388	};
	389
	390	#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
	391
	392
	393	/*
	394	* Stage 9 of the trace events.
	395	*
	396	* Create the probe function : call even size calculation and write event data
	397	* into the buffer.
	398	*
	399	* We use both the field and assignment macros to write the fields in the order
	400	* defined in the field declaration. The field declarations control the
	401	* execution order, jumping to the appropriate assignment block.
	402	*/
	403
	404	#include "lttng-events-reset.h" /* Reset all macros within TRACE_EVENT */
	405
	406	#undef __field
	407	#define __field(_type, _item) \
	408	goto __assign_##_item; \
	409	__end_field_##_item:
	410
	411	#undef __field_ext
	412	#define __field_ext(_type, _item, _filter_type) __field(_type, _item)
	413
	414	#undef __array
	415	#define __array(_type, _item, _length) \
	416	goto __assign_##_item; \
	417	__end_field_##_item:
	418
	419	#undef __array_text
	420	#define __array_text(_type, _item, _length) \
	421	__array(_type, _item, _length)
	422
	423	#undef __dynamic_array
	424	#define __dynamic_array(_type, _item, _length) \
	425	goto __assign_##_item##_1; \
	426	__end_field_##_item##_1: \
	427	goto __assign_##_item##_2; \
	428	__end_field_##_item##_2:
	429
	430	#undef __dynamic_array_text
	431	#define __dynamic_array_text(_type, _item, _length) \
	432	__dynamic_array(_type, _item, _length)
	433
	434	#undef __string
	435	#define __string(_item, _src) \
	436	goto __assign_##_item; \
	437	__end_field_##_item:
	438
	439	/*
	440	* Macros mapping tp_assign() to "=", tp_memcpy() to memcpy() and tp_strcpy() to
	441	* strcpy().
	442	*/
	443	#undef tp_assign
	444	#define tp_assign(dest, src) \
	445	__assign_##dest: \
	446	{ \
	447	__typeof__(__typemap.dest) __tmp = (src); \
	448	lib_ring_buffer_align_ctx(&ctx, ltt_alignof(__tmp)); \
	449	__chan->ops->event_write(&ctx, &__tmp, sizeof(__tmp)); \
	450	} \
	451	goto __end_field_##dest;
	452
	453	#undef tp_memcpy
	454	#define tp_memcpy(dest, src, len) \
	455	__assign_##dest: \
	456	if (0) \
	457	(void) __typemap.dest; \
	458	lib_ring_buffer_align_ctx(&ctx, ltt_alignof(__typemap.dest)); \
	459	__chan->ops->event_write(&ctx, src, len); \
	460	goto __end_field_##dest;
	461
	462	#undef tp_memcpy_dyn
	463	#define tp_memcpy_dyn(dest, src, len) \
	464	__assign_##dest##_1: \
	465	{ \
	466	u32 __tmpl = (len); \
	467	lib_ring_buffer_align_ctx(&ctx, ltt_alignof(u32)); \
	468	__chan->ops->event_write(&ctx, &__tmpl, sizeof(u32)); \
	469	} \
	470	goto __end_field_##dest##_1; \
	471	__assign_##dest##_2: \
	472	lib_ring_buffer_align_ctx(&ctx, ltt_alignof(__typemap.dest)); \
	473	__chan->ops->event_write(&ctx, src, len); \
	474	goto __end_field_##dest##_2;
	475
	476	#undef tp_strcpy
	477	#define tp_strcpy(dest, src) \
	478	tp_memcpy(dest, src, __get_dynamic_array_len(dest))
	479
	480	/* Named field types must be defined in lttng-types.h */
	481
	482	#undef __get_str
	483	#define __get_str(field) field
	484
	485	#undef __get_dynamic_array
	486	#define __get_dynamic_array(field) field
	487
	488	/* Beware: this get len actually consumes the len value */
	489	#undef __get_dynamic_array_len
	490	#define __get_dynamic_array_len(field) __dynamic_len[__dynamic_len_idx++]
	491
	492	#undef TP_PROTO
	493	#define TP_PROTO(args...) args
	494
	495	#undef TP_ARGS
	496	#define TP_ARGS(args...) args
	497
	498	#undef TP_STRUCT__entry
	499	#define TP_STRUCT__entry(args...) args
	500
	501	#undef TP_fast_assign
	502	#define TP_fast_assign(args...) args
	503
	504	#undef DECLARE_EVENT_CLASS
	505	#define DECLARE_EVENT_CLASS(_name, _proto, _args, _tstruct, _assign, _print) \
	506	static void __event_probe__##_name(void *__data, _proto) \
	507	{ \
	508	struct ltt_event *__event = __data; \
	509	struct ltt_channel *__chan = __event->chan; \
	510	struct lib_ring_buffer_ctx ctx; \
	511	size_t __event_len, __event_align; \
	512	size_t __dynamic_len_idx = 0; \
	513	size_t __dynamic_len[ARRAY_SIZE(__event_fields___##_name)]; \
	514	struct __event_typemap__##_name __typemap; \
	515	int __ret; \
	516	\
	517	if (0) \
	518	(void) __dynamic_len_idx; /* don't warn if unused */ \
	519	if (!ACCESS_ONCE(__chan->session->active)) \
	520	return; \
	521	__event_len = __event_get_size__##_name(__dynamic_len, _args); \
	522	__event_align = __event_get_align__##_name(_args); \
	523	lib_ring_buffer_ctx_init(&ctx, __chan->chan, NULL, __event_len, \
	524	__event_align, -1); \
	525	__ret = __chan->ops->event_reserve(&ctx, __event->id); \
	526	if (__ret < 0) \
	527	return; \
	528	/* Control code (field ordering) */ \
	529	_tstruct \
	530	__chan->ops->event_commit(&ctx); \
	531	return; \
	532	/* Copy code, steered by control code */ \
	533	_assign \
	534	}
	535
	536	#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
	537
	538	/*
	539	* Stage 10 of the trace events.
	540	*
	541	* Register/unregister probes at module load/unload.
	542	*/
	543
	544	#include "lttng-events-reset.h" /* Reset all macros within TRACE_EVENT */
	545
	546	#define TP_ID1(_token, _system) _token##_system
	547	#define TP_ID(_token, _system) TP_ID1(_token, _system)
	548	#define module_init_eval1(_token, _system) module_init(_token##_system)
	549	#define module_init_eval(_token, _system) module_init_eval1(_token, _system)
	550	#define module_exit_eval1(_token, _system) module_exit(_token##_system)
	551	#define module_exit_eval(_token, _system) module_exit_eval1(_token, _system)
	552
	553	static int TP_ID(__lttng_events_init__, TRACE_SYSTEM)(void)
	554	{
	555	wrapper_vmalloc_sync_all();
	556	return ltt_probe_register(&TP_ID(__probe_desc___, TRACE_SYSTEM));
	557	}
	558
	559	module_init_eval(__lttng_events_init__, TRACE_SYSTEM);
	560
	561	static void TP_ID(__lttng_events_exit__, TRACE_SYSTEM)(void)
	562	{
	563	ltt_probe_unregister(&TP_ID(__probe_desc___, TRACE_SYSTEM));
	564	}
	565
	566	module_exit_eval(__lttng_events_exit__, TRACE_SYSTEM);
	567
	568	#undef module_init_eval
	569	#undef module_exit_eval
	570	#undef TP_ID1
	571	#undef TP_ID