[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),		\
	},

#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),		\
	},

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

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

#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, __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, __alignof__(_type)); \
	__event_len += sizeof(_type) * (_length);

#undef __dynamic_array
#define __dynamic_array(_type, _item, _length)				       \
	__event_len += lib_ring_buffer_align(__event_len, __alignof__(u32));   \
	__event_len += sizeof(u32);					       \
	__event_len += lib_ring_buffer_align(__event_len, __alignof__(_type)); \
	__event_len += sizeof(_type) * (_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, __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, __alignof__(_type));

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

#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 __dynamic_array
#define __dynamic_array(_type, _item, _length)	_type	_item;

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