[lttng-ust.git] / include / lttng / ust-tracepoint-event.h

/*
 * Copyright (c) 2011-2012 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 */

#include <stdio.h>
#include <urcu/compiler.h>
#include <lttng/ust-events.h>
#include <lttng/ringbuffer-config.h>
#include <string.h>

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

#undef ctf_integer
#define ctf_integer(_type, _item, _src)				\
	ctf_integer_ext(_type, _item, _src, BYTE_ORDER, 10)

#undef ctf_integer_hex
#define ctf_integer_hex(_type, _item, _src)			\
	ctf_integer_ext(_type, _item, _src, BYTE_ORDER, 16)

#undef ctf_integer_network
#define ctf_integer_network(_type, _item, _src)			\
	ctf_integer_ext(_type, _item, _src, BIG_ENDIAN, 10)

#undef ctf_integer_network_hex
#define ctf_integer_network_hex(_type, _item, _src)		\
	ctf_integer_ext(_type, _item, _src, BIG_ENDIAN, 16)

/* ctf_float is redefined at each step */

#undef ctf_array
#define ctf_array(_type, _item, _src, _length)			\
	ctf_array_encoded(_type, _item, _src, _length, none)

#undef ctf_array_text
#define ctf_array_text(_type, _item, _src, _length)		\
	ctf_array_encoded(_type, _item, _src, _length, UTF8)

#undef ctf_sequence
#define ctf_sequence(_type, _item, _src, _length_type, _src_length)	\
	ctf_sequence_encoded(_type, _item, _src,			\
			_length_type, _src_length, none)

#undef ctf_sequence_text
#define ctf_sequence_text(_type, _item, _src, _length_type, _src_length) \
	ctf_sequence_encoded(_type, _item, _src,			 \
			_length_type, _src_length, UTF8)

/* ctf_string is redefined at each step */

/*
 * TRACEPOINT_EVENT_CLASS declares a class of tracepoints receiving the
 * same arguments and having the same field layout.
 *
 * TRACEPOINT_EVENT_INSTANCE declares an instance of a tracepoint, with
 * its own provider and name. It refers to a class (template).
 *
 * TRACEPOINT_EVENT declared both a class and an instance and does a
 * direct mapping from the instance to the class.
 */

#undef TRACEPOINT_EVENT
#define TRACEPOINT_EVENT(_provider, _name, _args, _fields)	\
	TRACEPOINT_EVENT_CLASS(_provider, _name,		\
			 _TP_PARAMS(_args),			\
			 _TP_PARAMS(_fields))			\
	TRACEPOINT_EVENT_INSTANCE(_provider, _name, _name,	\
			 _TP_PARAMS(_args))

/* Helpers */
#define _TP_ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]))

#define _tp_max_t(type, x, y)				\
	({						\
		type __max1 = (x);              	\
		type __max2 = (y);              	\
		__max1 > __max2 ? __max1: __max2;	\
	})

/*
 * Stage 0 of tracepoint event generation.
 *
 * Check that each TRACEPOINT_EVENT provider argument match the
 * TRACEPOINT_PROVIDER by creating dummy callbacks.
 */

/* Reset all macros within TRACEPOINT_EVENT */
#include <lttng/ust-tracepoint-event-reset.h>

static inline
void _TP_COMBINE_TOKENS(__tracepoint_provider_mismatch_, TRACEPOINT_PROVIDER)(void)
{
}

#undef TRACEPOINT_EVENT_CLASS
#define TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) 	\
	__tracepoint_provider_mismatch_##_provider();

#undef TRACEPOINT_EVENT_INSTANCE
#define TRACEPOINT_EVENT_INSTANCE(_provider, _template, _name, _args)	\
	__tracepoint_provider_mismatch_##_provider();

static __attribute__((unused))
void _TP_COMBINE_TOKENS(__tracepoint_provider_check_, TRACEPOINT_PROVIDER)(void)
{
#include TRACEPOINT_INCLUDE
}

/*
 * Stage 0.1 of tracepoint event generation.
 *
 * Check that each TRACEPOINT_EVENT provider:name does not exceed the
 * tracepoint name length limit.
 */

/* Reset all macros within TRACEPOINT_EVENT */
#include <lttng/ust-tracepoint-event-reset.h>

#undef TRACEPOINT_EVENT_INSTANCE
#define TRACEPOINT_EVENT_INSTANCE(_provider, _template, _name, _args)	\
static const char							\
	__tp_name_len_check##_provider##___##_name[LTTNG_UST_SYM_NAME_LEN] \
	__attribute__((unused)) =					\
		#_provider ":" #_name;

#include TRACEPOINT_INCLUDE

/*
 * Stage 1 of tracepoint event generation.
 *
 * Create event field type metadata section.
 * Each event produce an array of fields.
 */

/* Reset all macros within TRACEPOINT_EVENT */
#include <lttng/ust-tracepoint-event-reset.h>

#undef ctf_integer_ext
#define ctf_integer_ext(_type, _item, _src, _byte_order, _base)	\
	{							\
	  .name = #_item,					\
	  .type = __type_integer(_type, _byte_order, _base, none),\
	},

#undef ctf_float
#define ctf_float(_type, _item, _src)				\
	{							\
	  .name = #_item,					\
	  .type = __type_float(_type),				\
	},

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

#undef ctf_sequence_encoded
#define ctf_sequence_encoded(_type, _item, _src,	\
			_length_type, _src_length, _encoding)	\
	{							\
	  .name = #_item,					\
	  .type =						\
		{						\
		  .atype = atype_sequence,			\
		  .u.sequence =					\
			{					\
			    .length_type = __type_integer(_length_type, BYTE_ORDER, 10, none), \
			    .elem_type = __type_integer(_type, BYTE_ORDER, 10, _encoding), \
			},					\
		},						\
	},

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

#undef TP_FIELDS
#define TP_FIELDS(...) __VA_ARGS__	/* Only one used in this phase */

#undef TRACEPOINT_EVENT_CLASS
#define TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields)		   	     \
	static const struct lttng_event_field __event_fields___##_provider##___##_name[] = { \
		_fields									     \
	};

#include TRACEPOINT_INCLUDE

/*
 * Stage 2 of tracepoint event generation.
 *
 * Create probe callback prototypes.
 */

/* Reset all macros within TRACEPOINT_EVENT */
#include <lttng/ust-tracepoint-event-reset.h>

#undef TP_ARGS
#define TP_ARGS(...) __VA_ARGS__

#undef TRACEPOINT_EVENT_CLASS
#define TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields)		\
static void __event_probe__##_provider##___##_name(_TP_ARGS_DATA_PROTO(_args));

#include TRACEPOINT_INCLUDE

/*
 * Stage 3 of tracepoint event generation.
 *
 * Create static inline function that calculates event size.
 */

/* Reset all macros within TRACEPOINT_EVENT */
#include <lttng/ust-tracepoint-event-reset.h>

#undef ctf_integer_ext
#define ctf_integer_ext(_type, _item, _src, _byte_order, _base)		       \
	__event_len += lib_ring_buffer_align(__event_len, lttng_alignof(_type)); \
	__event_len += sizeof(_type);

#undef ctf_float
#define ctf_float(_type, _item, _src)		      			       \
	__event_len += lib_ring_buffer_align(__event_len, lttng_alignof(_type)); \
	__event_len += sizeof(_type);

#undef ctf_array_encoded
#define ctf_array_encoded(_type, _item, _src, _length, _encoding)	       \
	__event_len += lib_ring_buffer_align(__event_len, lttng_alignof(_type)); \
	__event_len += sizeof(_type) * (_length);

#undef ctf_sequence_encoded
#define ctf_sequence_encoded(_type, _item, _src, _length_type,	\
			_src_length, _encoding)			\
	__event_len += lib_ring_buffer_align(__event_len, lttng_alignof(_length_type));   \
	__event_len += sizeof(_length_type);				       \
	__event_len += lib_ring_buffer_align(__event_len, lttng_alignof(_type)); \
	__dynamic_len[__dynamic_len_idx] = (_src_length);		       \
	__event_len += sizeof(_type) * __dynamic_len[__dynamic_len_idx];       \
	__dynamic_len_idx++;

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

#undef TP_ARGS
#define TP_ARGS(...) __VA_ARGS__

#undef TP_FIELDS
#define TP_FIELDS(...) __VA_ARGS__

#undef TRACEPOINT_EVENT_CLASS
#define TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields)      \
static inline size_t __event_get_size__##_provider##___##_name(size_t *__dynamic_len, _TP_ARGS_DATA_PROTO(_args)) \
{									      \
	size_t __event_len = 0;						      \
	unsigned int __dynamic_len_idx = 0;				      \
									      \
	if (0)								      \
		(void) __dynamic_len_idx;	/* don't warn if unused */    \
	_fields								      \
	return __event_len;						      \
}

#include TRACEPOINT_INCLUDE

/*
 * Stage 4 of tracepoint event generation.
 *
 * Create static inline function that calculates event payload alignment.
 */

/* Reset all macros within TRACEPOINT_EVENT */
#include <lttng/ust-tracepoint-event-reset.h>

#undef ctf_integer_ext
#define ctf_integer_ext(_type, _item, _src, _byte_order, _base)		       \
	__event_align = _tp_max_t(size_t, __event_align, lttng_alignof(_type));

#undef ctf_float
#define ctf_float(_type, _item, _src)					       \
	__event_align = _tp_max_t(size_t, __event_align, lttng_alignof(_type));

#undef ctf_array_encoded
#define ctf_array_encoded(_type, _item, _src, _length, _encoding)	       \
	__event_align = _tp_max_t(size_t, __event_align, lttng_alignof(_type));

#undef ctf_sequence_encoded
#define ctf_sequence_encoded(_type, _item, _src, _length_type,	\
			_src_length, _encoding)			\
	__event_align = _tp_max_t(size_t, __event_align, lttng_alignof(_length_type));	  \
	__event_align = _tp_max_t(size_t, __event_align, lttng_alignof(_type));

#undef ctf_string
#define ctf_string(_item, _src)

#undef TP_ARGS
#define TP_ARGS(...) __VA_ARGS__

#undef TP_FIELDS
#define TP_FIELDS(...) __VA_ARGS__

#undef TRACEPOINT_EVENT_CLASS
#define TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields)	      \
static inline								      \
size_t __event_get_align__##_provider##___##_name(_TP_ARGS_PROTO(_args))      \
{									      \
	size_t __event_align = 1;					      \
	_fields								      \
	return __event_align;						      \
}

#include TRACEPOINT_INCLUDE


/*
 * Stage 5 of tracepoint event generation.
 *
 * Create the probe function. This function calls event size calculation
 * and writes event data into the buffer.
 */

/* Reset all macros within TRACEPOINT_EVENT */
#include <lttng/ust-tracepoint-event-reset.h>

#undef ctf_integer_ext
#define ctf_integer_ext(_type, _item, _src, _byte_order, _base)	        \
	{								\
		_type __tmp = (_src);					\
		lib_ring_buffer_align_ctx(&__ctx, lttng_alignof(__tmp));\
		__chan->ops->event_write(&__ctx, &__tmp, sizeof(__tmp));\
	}

#undef ctf_float
#define ctf_float(_type, _item, _src)				        \
	{								\
		_type __tmp = (_src);					\
		lib_ring_buffer_align_ctx(&__ctx, lttng_alignof(__tmp));\
		__chan->ops->event_write(&__ctx, &__tmp, sizeof(__tmp));\
	}

#undef ctf_array_encoded
#define ctf_array_encoded(_type, _item, _src, _length, _encoding)       \
	lib_ring_buffer_align_ctx(&__ctx, lttng_alignof(_type));	\
	__chan->ops->event_write(&__ctx, _src, sizeof(_type) * (_length));

#undef ctf_sequence_encoded
#define ctf_sequence_encoded(_type, _item, _src, _length_type,		\
			_src_length, _encoding)			\
	{								\
		_length_type __tmpl = __stackvar.__dynamic_len[__dynamic_len_idx]; \
		lib_ring_buffer_align_ctx(&__ctx, lttng_alignof(_length_type));\
		__chan->ops->event_write(&__ctx, &__tmpl, sizeof(_length_type));\
	}								\
	lib_ring_buffer_align_ctx(&__ctx, lttng_alignof(_type));	\
	__chan->ops->event_write(&__ctx, _src,				\
		sizeof(_type) * __get_dynamic_len(dest));

#undef ctf_string
#define ctf_string(_item, _src)					        \
	lib_ring_buffer_align_ctx(&__ctx, lttng_alignof(*(_src)));	\
	__chan->ops->event_write(&__ctx, _src, __get_dynamic_len(dest));

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

#undef TP_ARGS
#define TP_ARGS(...) __VA_ARGS__

#undef TP_FIELDS
#define TP_FIELDS(...) __VA_ARGS__

#undef TRACEPOINT_EVENT_CLASS
#define TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields)	      \
static void __event_probe__##_provider##___##_name(_TP_ARGS_DATA_PROTO(_args))\
{									      \
	struct ltt_event *__event = __tp_data;				      \
	struct ltt_channel *__chan = __event->chan;			      \
	struct lttng_ust_lib_ring_buffer_ctx __ctx;			      \
	size_t __event_len, __event_align;				      \
	size_t __dynamic_len_idx = 0;					      \
	union {								      \
		size_t __dynamic_len[_TP_ARRAY_SIZE(__event_fields___##_provider##___##_name)];	      \
	} __stackvar;							      \
	int __ret;							      \
									      \
	if (0)								      \
		(void) __dynamic_len_idx;	/* don't warn if unused */    \
	if (caa_unlikely(!CMM_ACCESS_ONCE(__chan->session->active)))	      \
		return;							      \
	if (caa_unlikely(!CMM_ACCESS_ONCE(__chan->enabled)))		      \
		return;							      \
	if (caa_unlikely(!CMM_ACCESS_ONCE(__event->enabled)))		      \
		return;							      \
	__event_len = __event_get_size__##_provider##___##_name(__stackvar.__dynamic_len,\
		 _TP_ARGS_DATA_VAR(_args));				      \
	__event_align = __event_get_align__##_provider##___##_name(_TP_ARGS_VAR(_args)); \
	lib_ring_buffer_ctx_init(&__ctx, __chan->chan, __event, __event_len,  \
				 __event_align, -1, __chan->handle);	      \
	__ret = __chan->ops->event_reserve(&__ctx, __event->id);	      \
	if (__ret < 0)							      \
		return;							      \
	_fields								      \
	__chan->ops->event_commit(&__ctx);				      \
}

#include TRACEPOINT_INCLUDE

#undef __get_dynamic_len

/*
 * Stage 5.1 of tracepoint event generation.
 *
 * Create probe signature
 */

/* Reset all macros within TRACEPOINT_EVENT */
#include <lttng/ust-tracepoint-event-reset.h>

#undef TP_ARGS
#define TP_ARGS(...) __VA_ARGS__

#define _TP_EXTRACT_STRING2(...)	#__VA_ARGS__

#undef TRACEPOINT_EVENT_CLASS
#define TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields)	\
const char __tp_event_signature___##_provider##___##_name[] = 		\
		_TP_EXTRACT_STRING2(_args);

#include TRACEPOINT_INCLUDE

#undef _TP_EXTRACT_STRING2

/*
 * Stage 6 of tracepoint event generation.
 *
 * Tracepoint loglevel mapping definition generation. We generate a
 * symbol for each mapping for a provider/event to ensure at most a 1 to
 * 1 mapping between events and loglevels. If the symbol is repeated,
 * the compiler will complain.
 */

/* Reset all macros within TRACEPOINT_EVENT */
#include <lttng/ust-tracepoint-event-reset.h>

#undef TRACEPOINT_LOGLEVEL
#define TRACEPOINT_LOGLEVEL(__provider, __name, __loglevel)		   \
static const int _loglevel_value___##__provider##___##__name = __loglevel; \
static const int *_loglevel___##__provider##___##__name =		   \
		&_loglevel_value___##__provider##___##__name;

#include TRACEPOINT_INCLUDE

/*
 * Stage 7.1 of tracepoint event generation.
 *
 * Create events description structures. We use a weakref because
 * loglevels are optional. If not declared, the event will point to the
 * a loglevel that contains NULL.
 */

/* Reset all macros within TRACEPOINT_EVENT */
#include <lttng/ust-tracepoint-event-reset.h>

#undef TRACEPOINT_EVENT_INSTANCE
#define TRACEPOINT_EVENT_INSTANCE(_provider, _template, _name, _args)	       \
static const int *							       \
	__ref_loglevel___##_provider##___##_name			       \
	__attribute__((weakref ("_loglevel___" #_provider "___" #_name)));     \
const struct lttng_event_desc __event_desc___##_provider##_##_name = {	       \
	.fields = __event_fields___##_provider##___##_template,		       \
	.name = #_provider ":" #_name,					       \
	.probe_callback = (void (*)(void)) &__event_probe__##_provider##___##_template,\
	.nr_fields = _TP_ARRAY_SIZE(__event_fields___##_provider##___##_template), \
	.loglevel = &__ref_loglevel___##_provider##___##_name,		       \
	.signature = __tp_event_signature___##_provider##___##_template,       \
};

#include TRACEPOINT_INCLUDE

/*
 * Stage 7.2 of tracepoint event generation.
 *
 * Create array of events.
 */

/* Reset all macros within TRACEPOINT_EVENT */
#include <lttng/ust-tracepoint-event-reset.h>

#undef TRACEPOINT_EVENT_INSTANCE
#define TRACEPOINT_EVENT_INSTANCE(_provider, _template, _name, _args)	       \
	&__event_desc___##_provider##_##_name,

static const struct lttng_event_desc *_TP_COMBINE_TOKENS(__event_desc___, TRACEPOINT_PROVIDER)[] = {
#include TRACEPOINT_INCLUDE
};


/*
 * Stage 8 of tracepoint event generation.
 *
 * Create a toplevel descriptor for the whole probe.
 */

/* non-const because list head will be modified when registered. */
static struct lttng_probe_desc _TP_COMBINE_TOKENS(__probe_desc___, TRACEPOINT_PROVIDER) = {
	.provider = __tp_stringify(TRACEPOINT_PROVIDER),
	.event_desc = _TP_COMBINE_TOKENS(__event_desc___, TRACEPOINT_PROVIDER),
	.nr_events = _TP_ARRAY_SIZE(_TP_COMBINE_TOKENS(__event_desc___, TRACEPOINT_PROVIDER)),
};

/*
 * Stage 9 of tracepoint event generation.
 *
 * Register/unregister probes at module load/unload.
 *
 * Generate the constructor as an externally visible symbol for use when
 * linking the probe statically.
 */

/* Reset all macros within TRACEPOINT_EVENT */
#include <lttng/ust-tracepoint-event-reset.h>
static void __attribute__((constructor))
_TP_COMBINE_TOKENS(__lttng_events_init__, TRACEPOINT_PROVIDER)(void)
{
	int ret;

	ret = ltt_probe_register(&_TP_COMBINE_TOKENS(__probe_desc___, TRACEPOINT_PROVIDER));
	assert(!ret);
}

static void __attribute__((destructor))
_TP_COMBINE_TOKENS(__lttng_events_exit__, TRACEPOINT_PROVIDER)(void)
{
	ltt_probe_unregister(&_TP_COMBINE_TOKENS(__probe_desc___, TRACEPOINT_PROVIDER));
}

int _TP_COMBINE_TOKENS(__tracepoint_provider_, TRACEPOINT_PROVIDER);
Commit	Line	Data
1c324e59	1	/*
e92f3e28	2	* Copyright (c) 2011-2012 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
1c324e59	3	*
e92f3e28 MD	4	* Permission is hereby granted, free of charge, to any person obtaining a copy
	5	* of this software and associated documentation files (the "Software"), to deal
	6	* in the Software without restriction, including without limitation the rights
	7	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	8	* copies of the Software, and to permit persons to whom the Software is
	9	* furnished to do so, subject to the following conditions:
1c324e59	10	*
e92f3e28 MD	11	* The above copyright notice and this permission notice shall be included in
e92f3e28 MD	12	* all copies or substantial portions of the Software.
1c324e59 MD	13	*/
	14
	15	#include <stdio.h>
	16	#include <urcu/compiler.h>
	17	#include <lttng/ust-events.h>
1c324e59	18	#include <lttng/ringbuffer-config.h>
44c72f10	19	#include <string.h>
1c324e59 MD	20
	21	/*
	22	* Macro declarations used for all stages.
	23	*/
	24
	25	#undef ctf_integer
	26	#define ctf_integer(_type, _item, _src) \
	27	ctf_integer_ext(_type, _item, _src, BYTE_ORDER, 10)
	28
	29	#undef ctf_integer_hex
	30	#define ctf_integer_hex(_type, _item, _src) \
	31	ctf_integer_ext(_type, _item, _src, BYTE_ORDER, 16)
	32
	33	#undef ctf_integer_network
	34	#define ctf_integer_network(_type, _item, _src) \
	35	ctf_integer_ext(_type, _item, _src, BIG_ENDIAN, 10)
	36
	37	#undef ctf_integer_network_hex
	38	#define ctf_integer_network_hex(_type, _item, _src) \
	39	ctf_integer_ext(_type, _item, _src, BIG_ENDIAN, 16)
	40
	41	/* ctf_float is redefined at each step */
	42
	43	#undef ctf_array
	44	#define ctf_array(_type, _item, _src, _length) \
	45	ctf_array_encoded(_type, _item, _src, _length, none)
	46
	47	#undef ctf_array_text
	48	#define ctf_array_text(_type, _item, _src, _length) \
	49	ctf_array_encoded(_type, _item, _src, _length, UTF8)
	50
	51	#undef ctf_sequence
	52	#define ctf_sequence(_type, _item, _src, _length_type, _src_length) \
	53	ctf_sequence_encoded(_type, _item, _src, \
	54	_length_type, _src_length, none)
	55
	56	#undef ctf_sequence_text
	57	#define ctf_sequence_text(_type, _item, _src, _length_type, _src_length) \
	58	ctf_sequence_encoded(_type, _item, _src, \
	59	_length_type, _src_length, UTF8)
	60
	61	/* ctf_string is redefined at each step */
	62
	63	/*
	64	* TRACEPOINT_EVENT_CLASS declares a class of tracepoints receiving the
	65	* same arguments and having the same field layout.
	66	*
	67	* TRACEPOINT_EVENT_INSTANCE declares an instance of a tracepoint, with
	68	* its own provider and name. It refers to a class (template).
	69	*
	70	* TRACEPOINT_EVENT declared both a class and an instance and does a
	71	* direct mapping from the instance to the class.
	72	*/
	73
	74	#undef TRACEPOINT_EVENT
	75	#define TRACEPOINT_EVENT(_provider, _name, _args, _fields) \
	76	TRACEPOINT_EVENT_CLASS(_provider, _name, \
	77	_TP_PARAMS(_args), \
	78	_TP_PARAMS(_fields)) \
	79	TRACEPOINT_EVENT_INSTANCE(_provider, _name, _name, \
68755429	80	_TP_PARAMS(_args))
1c324e59 MD	81
	82	/* Helpers */
	83	#define _TP_ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]))
	84
	85	#define _tp_max_t(type, x, y) \
	86	({ \
	87	type __max1 = (x); \
	88	type __max2 = (y); \
	89	__max1 > __max2 ? __max1: __max2; \
	90	})
	91
	92	/*
	93	* Stage 0 of tracepoint event generation.
	94	*
	95	* Check that each TRACEPOINT_EVENT provider argument match the
	96	* TRACEPOINT_PROVIDER by creating dummy callbacks.
	97	*/
	98
	99	/* Reset all macros within TRACEPOINT_EVENT */
	100	#include <lttng/ust-tracepoint-event-reset.h>
	101
	102	static inline
	103	void _TP_COMBINE_TOKENS(__tracepoint_provider_mismatch_, TRACEPOINT_PROVIDER)(void)
	104	{
	105	}
	106
	107	#undef TRACEPOINT_EVENT_CLASS
	108	#define TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
	109	__tracepoint_provider_mismatch_##_provider();
	110
	111	#undef TRACEPOINT_EVENT_INSTANCE
	112	#define TRACEPOINT_EVENT_INSTANCE(_provider, _template, _name, _args) \
	113	__tracepoint_provider_mismatch_##_provider();
	114
	115	static __attribute__((unused))
	116	void _TP_COMBINE_TOKENS(__tracepoint_provider_check_, TRACEPOINT_PROVIDER)(void)
	117	{
	118	#include TRACEPOINT_INCLUDE
	119	}
	120
f56cd1d5 MD	121	/*
	122	* Stage 0.1 of tracepoint event generation.
	123	*
	124	* Check that each TRACEPOINT_EVENT provider:name does not exceed the
	125	* tracepoint name length limit.
	126	*/
	127
	128	/* Reset all macros within TRACEPOINT_EVENT */
	129	#include <lttng/ust-tracepoint-event-reset.h>
	130
	131	#undef TRACEPOINT_EVENT_INSTANCE
	132	#define TRACEPOINT_EVENT_INSTANCE(_provider, _template, _name, _args) \
	133	static const char \
	134	__tp_name_len_check##_provider##___##_name[LTTNG_UST_SYM_NAME_LEN] \
	135	__attribute__((unused)) = \
	136	#_provider ":" #_name;
	137
	138	#include TRACEPOINT_INCLUDE
	139
1c324e59 MD	140	/*
	141	* Stage 1 of tracepoint event generation.
	142	*
	143	* Create event field type metadata section.
	144	* Each event produce an array of fields.
	145	*/
	146
	147	/* Reset all macros within TRACEPOINT_EVENT */
	148	#include <lttng/ust-tracepoint-event-reset.h>
	149
	150	#undef ctf_integer_ext
	151	#define ctf_integer_ext(_type, _item, _src, _byte_order, _base) \
	152	{ \
	153	.name = #_item, \
	154	.type = __type_integer(_type, _byte_order, _base, none),\
	155	},
	156
	157	#undef ctf_float
	158	#define ctf_float(_type, _item, _src) \
	159	{ \
	160	.name = #_item, \
	161	.type = __type_float(_type), \
	162	},
	163
	164	#undef ctf_array_encoded
	165	#define ctf_array_encoded(_type, _item, _src, _length, _encoding) \
	166	{ \
	167	.name = #_item, \
	168	.type = \
	169	{ \
	170	.atype = atype_array, \
	171	.u.array = \
	172	{ \
	173	.length = _length, \
	174	.elem_type = __type_integer(_type, BYTE_ORDER, 10, _encoding), \
	175	}, \
	176	}, \
	177	},
	178
	179	#undef ctf_sequence_encoded
	180	#define ctf_sequence_encoded(_type, _item, _src, \
	181	_length_type, _src_length, _encoding) \
	182	{ \
	183	.name = #_item, \
	184	.type = \
	185	{ \
	186	.atype = atype_sequence, \
	187	.u.sequence = \
	188	{ \
	189	.length_type = __type_integer(_length_type, BYTE_ORDER, 10, none), \
	190	.elem_type = __type_integer(_type, BYTE_ORDER, 10, _encoding), \
	191	}, \
	192	}, \
	193	},
	194
	195	#undef ctf_string
	196	#define ctf_string(_item, _src) \
	197	{ \
	198	.name = #_item, \
	199	.type = \
	200	{ \
	201	.atype = atype_string, \
	202	.u.basic.string.encoding = lttng_encode_UTF8, \
	203	}, \
204	},
205
206	#undef TP_FIELDS
2eda209b	207	#define TP_FIELDS(...) __VA_ARGS__ /* Only one used in this phase */
1c324e59 MD	208
	209	#undef TRACEPOINT_EVENT_CLASS
	210	#define TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
	211	static const struct lttng_event_field __event_fields___##_provider##___##_name[] = { \
	212	_fields \
	213	};
	214
	215	#include TRACEPOINT_INCLUDE
	216
	217	/*
	218	* Stage 2 of tracepoint event generation.
	219	*
	220	* Create probe callback prototypes.
	221	*/
	222
	223	/* Reset all macros within TRACEPOINT_EVENT */
	224	#include <lttng/ust-tracepoint-event-reset.h>
	225
	226	#undef TP_ARGS
2eda209b	227	#define TP_ARGS(...) __VA_ARGS__
1c324e59 MD	228
	229	#undef TRACEPOINT_EVENT_CLASS
	230	#define TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
	231	static void __event_probe__##_provider##___##_name(_TP_ARGS_DATA_PROTO(_args));
	232
	233	#include TRACEPOINT_INCLUDE
	234
	235	/*
	236	* Stage 3 of tracepoint event generation.
	237	*
1c324e59 MD	238	* Create static inline function that calculates event size.
	239	*/
	240
	241	/* Reset all macros within TRACEPOINT_EVENT */
	242	#include <lttng/ust-tracepoint-event-reset.h>
	243
	244	#undef ctf_integer_ext
	245	#define ctf_integer_ext(_type, _item, _src, _byte_order, _base) \
	246	__event_len += lib_ring_buffer_align(__event_len, lttng_alignof(_type)); \
	247	__event_len += sizeof(_type);
	248
	249	#undef ctf_float
	250	#define ctf_float(_type, _item, _src) \
	251	__event_len += lib_ring_buffer_align(__event_len, lttng_alignof(_type)); \
	252	__event_len += sizeof(_type);
	253
	254	#undef ctf_array_encoded
	255	#define ctf_array_encoded(_type, _item, _src, _length, _encoding) \
	256	__event_len += lib_ring_buffer_align(__event_len, lttng_alignof(_type)); \
	257	__event_len += sizeof(_type) * (_length);
	258
	259	#undef ctf_sequence_encoded
	260	#define ctf_sequence_encoded(_type, _item, _src, _length_type, \
	261	_src_length, _encoding) \
	262	__event_len += lib_ring_buffer_align(__event_len, lttng_alignof(_length_type)); \
	263	__event_len += sizeof(_length_type); \
	264	__event_len += lib_ring_buffer_align(__event_len, lttng_alignof(_type)); \
	265	__dynamic_len[__dynamic_len_idx] = (_src_length); \
	266	__event_len += sizeof(_type) * __dynamic_len[__dynamic_len_idx]; \
	267	__dynamic_len_idx++;
	268
	269	#undef ctf_string
	270	#define ctf_string(_item, _src) \
	271	__event_len += __dynamic_len[__dynamic_len_idx++] = strlen(_src) + 1;
	272
	273	#undef TP_ARGS
2eda209b	274	#define TP_ARGS(...) __VA_ARGS__
1c324e59 MD	275
1c324e59 MD	276	#undef TP_FIELDS
2eda209b	277	#define TP_FIELDS(...) __VA_ARGS__
1c324e59 MD	278
	279	#undef TRACEPOINT_EVENT_CLASS
	280	#define TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
	281	static inline size_t __event_get_size__##_provider##___##_name(size_t *__dynamic_len, _TP_ARGS_DATA_PROTO(_args)) \
	282	{ \
	283	size_t __event_len = 0; \
	284	unsigned int __dynamic_len_idx = 0; \
	285	\
	286	if (0) \
	287	(void) __dynamic_len_idx; /* don't warn if unused */ \
	288	_fields \
	289	return __event_len; \
	290	}
	291
	292	#include TRACEPOINT_INCLUDE
	293
	294	/*
df854e41	295	* Stage 4 of tracepoint event generation.
1c324e59 MD	296	*
	297	* Create static inline function that calculates event payload alignment.
	298	*/
	299
	300	/* Reset all macros within TRACEPOINT_EVENT */
	301	#include <lttng/ust-tracepoint-event-reset.h>
	302
	303	#undef ctf_integer_ext
	304	#define ctf_integer_ext(_type, _item, _src, _byte_order, _base) \
	305	__event_align = _tp_max_t(size_t, __event_align, lttng_alignof(_type));
	306
	307	#undef ctf_float
	308	#define ctf_float(_type, _item, _src) \
	309	__event_align = _tp_max_t(size_t, __event_align, lttng_alignof(_type));
	310
	311	#undef ctf_array_encoded
	312	#define ctf_array_encoded(_type, _item, _src, _length, _encoding) \
	313	__event_align = _tp_max_t(size_t, __event_align, lttng_alignof(_type));
	314
	315	#undef ctf_sequence_encoded
	316	#define ctf_sequence_encoded(_type, _item, _src, _length_type, \
	317	_src_length, _encoding) \
	318	__event_align = _tp_max_t(size_t, __event_align, lttng_alignof(_length_type)); \
	319	__event_align = _tp_max_t(size_t, __event_align, lttng_alignof(_type));
	320
	321	#undef ctf_string
	322	#define ctf_string(_item, _src)
	323
	324	#undef TP_ARGS
2eda209b	325	#define TP_ARGS(...) __VA_ARGS__
1c324e59 MD	326
1c324e59 MD	327	#undef TP_FIELDS
2eda209b	328	#define TP_FIELDS(...) __VA_ARGS__
1c324e59 MD	329
	330	#undef TRACEPOINT_EVENT_CLASS
	331	#define TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
	332	static inline \
	333	size_t __event_get_align__##_provider##___##_name(_TP_ARGS_PROTO(_args)) \
	334	{ \
	335	size_t __event_align = 1; \
	336	_fields \
	337	return __event_align; \
	338	}
	339
	340	#include TRACEPOINT_INCLUDE
	341
	342
	343	/*
df854e41	344	* Stage 5 of tracepoint event generation.
1c324e59 MD	345	*
	346	* Create the probe function. This function calls event size calculation
	347	* and writes event data into the buffer.
	348	*/
	349
	350	/* Reset all macros within TRACEPOINT_EVENT */
	351	#include <lttng/ust-tracepoint-event-reset.h>
	352
	353	#undef ctf_integer_ext
	354	#define ctf_integer_ext(_type, _item, _src, _byte_order, _base) \
	355	{ \
	356	_type __tmp = (_src); \
	357	lib_ring_buffer_align_ctx(&__ctx, lttng_alignof(__tmp));\
	358	__chan->ops->event_write(&__ctx, &__tmp, sizeof(__tmp));\
	359	}
	360
	361	#undef ctf_float
	362	#define ctf_float(_type, _item, _src) \
	363	{ \
	364	_type __tmp = (_src); \
	365	lib_ring_buffer_align_ctx(&__ctx, lttng_alignof(__tmp));\
	366	__chan->ops->event_write(&__ctx, &__tmp, sizeof(__tmp));\
	367	}
	368
	369	#undef ctf_array_encoded
	370	#define ctf_array_encoded(_type, _item, _src, _length, _encoding) \
	371	lib_ring_buffer_align_ctx(&__ctx, lttng_alignof(_type)); \
	372	__chan->ops->event_write(&__ctx, _src, sizeof(_type) * (_length));
	373
	374	#undef ctf_sequence_encoded
	375	#define ctf_sequence_encoded(_type, _item, _src, _length_type, \
	376	_src_length, _encoding) \
	377	{ \
d71b57b9	378	_length_type __tmpl = __stackvar.__dynamic_len[__dynamic_len_idx]; \
1c324e59 MD	379	lib_ring_buffer_align_ctx(&__ctx, lttng_alignof(_length_type));\
	380	__chan->ops->event_write(&__ctx, &__tmpl, sizeof(_length_type));\
	381	} \
	382	lib_ring_buffer_align_ctx(&__ctx, lttng_alignof(_type)); \
	383	__chan->ops->event_write(&__ctx, _src, \
	384	sizeof(_type) * __get_dynamic_len(dest));
	385
	386	#undef ctf_string
	387	#define ctf_string(_item, _src) \
	388	lib_ring_buffer_align_ctx(&__ctx, lttng_alignof(*(_src))); \
	389	__chan->ops->event_write(&__ctx, _src, __get_dynamic_len(dest));
	390
	391	/* Beware: this get len actually consumes the len value */
	392	#undef __get_dynamic_len
d71b57b9	393	#define __get_dynamic_len(field) __stackvar.__dynamic_len[__dynamic_len_idx++]
1c324e59 MD	394
1c324e59 MD	395	#undef TP_ARGS
2eda209b	396	#define TP_ARGS(...) __VA_ARGS__
1c324e59 MD	397
1c324e59 MD	398	#undef TP_FIELDS
2eda209b	399	#define TP_FIELDS(...) __VA_ARGS__
1c324e59 MD	400
	401	#undef TRACEPOINT_EVENT_CLASS
	402	#define TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
	403	static void __event_probe__##_provider##___##_name(_TP_ARGS_DATA_PROTO(_args))\
	404	{ \
f280cb51	405	struct ltt_event *__event = __tp_data; \
1c324e59	406	struct ltt_channel *__chan = __event->chan; \
f280cb51	407	struct lttng_ust_lib_ring_buffer_ctx __ctx; \
1c324e59 MD	408	size_t __event_len, __event_align; \
1c324e59 MD	409	size_t __dynamic_len_idx = 0; \
d71b57b9 MD	410	union { \
	411	size_t __dynamic_len[_TP_ARRAY_SIZE(__event_fields___##_provider##___##_name)]; \
	412	} __stackvar; \
1c324e59 MD	413	int __ret; \
	414	\
	415	if (0) \
	416	(void) __dynamic_len_idx; /* don't warn if unused */ \
	417	if (caa_unlikely(!CMM_ACCESS_ONCE(__chan->session->active))) \
	418	return; \
	419	if (caa_unlikely(!CMM_ACCESS_ONCE(__chan->enabled))) \
	420	return; \
	421	if (caa_unlikely(!CMM_ACCESS_ONCE(__event->enabled))) \
	422	return; \
d71b57b9	423	__event_len = __event_get_size__##_provider##___##_name(__stackvar.__dynamic_len,\
1c324e59 MD	424	_TP_ARGS_DATA_VAR(_args)); \
	425	__event_align = __event_get_align__##_provider##___##_name(_TP_ARGS_VAR(_args)); \
	426	lib_ring_buffer_ctx_init(&__ctx, __chan->chan, __event, __event_len, \
	427	__event_align, -1, __chan->handle); \
	428	__ret = __chan->ops->event_reserve(&__ctx, __event->id); \
	429	if (__ret < 0) \
	430	return; \
	431	_fields \
	432	__chan->ops->event_commit(&__ctx); \
	433	}
	434
	435	#include TRACEPOINT_INCLUDE
	436
	437	#undef __get_dynamic_len
	438
68755429 MD	439	/*
	440	* Stage 5.1 of tracepoint event generation.
	441	*
	442	* Create probe signature
	443	*/
	444
	445	/* Reset all macros within TRACEPOINT_EVENT */
	446	#include <lttng/ust-tracepoint-event-reset.h>
	447
	448	#undef TP_ARGS
2eda209b	449	#define TP_ARGS(...) __VA_ARGS__
9eb06182 MD	450
9eb06182 MD	451	#define _TP_EXTRACT_STRING2(...) #__VA_ARGS__
68755429 MD	452
	453	#undef TRACEPOINT_EVENT_CLASS
	454	#define TRACEPOINT_EVENT_CLASS(_provider, _name, _args, _fields) \
	455	const char __tp_event_signature___##_provider##___##_name[] = \
9eb06182	456	_TP_EXTRACT_STRING2(_args);
68755429 MD	457
	458	#include TRACEPOINT_INCLUDE
	459
9eb06182 MD	460	#undef _TP_EXTRACT_STRING2
9eb06182 MD	461
05ceaafd	462	/*
882a56d7	463	* Stage 6 of tracepoint event generation.
1c324e59	464	*
df854e41 MD	465	* Tracepoint loglevel mapping definition generation. We generate a
	466	* symbol for each mapping for a provider/event to ensure at most a 1 to
	467	* 1 mapping between events and loglevels. If the symbol is repeated,
	468	* the compiler will complain.
05ceaafd MD	469	*/
	470
	471	/* Reset all macros within TRACEPOINT_EVENT */
	472	#include <lttng/ust-tracepoint-event-reset.h>
	473
	474	#undef TRACEPOINT_LOGLEVEL
457a6b58 MD	475	#define TRACEPOINT_LOGLEVEL(__provider, __name, __loglevel) \
	476	static const int _loglevel_value___##__provider##___##__name = __loglevel; \
	477	static const int *_loglevel___##__provider##___##__name = \
	478	&_loglevel_value___##__provider##___##__name;
df854e41 MD	479
	480	#include TRACEPOINT_INCLUDE
	481
	482	/*
882a56d7	483	* Stage 7.1 of tracepoint event generation.
df854e41 MD	484	*
	485	* Create events description structures. We use a weakref because
	486	* loglevels are optional. If not declared, the event will point to the
	487	* a loglevel that contains NULL.
	488	*/
	489
	490	/* Reset all macros within TRACEPOINT_EVENT */
	491	#include <lttng/ust-tracepoint-event-reset.h>
	492
	493	#undef TRACEPOINT_EVENT_INSTANCE
	494	#define TRACEPOINT_EVENT_INSTANCE(_provider, _template, _name, _args) \
882a56d7 MD	495	static const int * \
	496	__ref_loglevel___##_provider##___##_name \
	497	__attribute__((weakref ("_loglevel___" #_provider "___" #_name))); \
df854e41 MD	498	const struct lttng_event_desc __event_desc___##_provider##_##_name = { \
	499	.fields = __event_fields___##_provider##___##_template, \
	500	.name = #_provider ":" #_name, \
fbdeb5ec	501	.probe_callback = (void (*)(void)) &__event_probe__##_provider##___##_template,\
df854e41	502	.nr_fields = _TP_ARRAY_SIZE(__event_fields___##_provider##___##_template), \
882a56d7	503	.loglevel = &__ref_loglevel___##_provider##___##_name, \
68755429	504	.signature = __tp_event_signature___##_provider##___##_template, \
df854e41 MD	505	};
	506
	507	#include TRACEPOINT_INCLUDE
05ceaafd	508
df854e41	509	/*
882a56d7	510	* Stage 7.2 of tracepoint event generation.
df854e41 MD	511	*
	512	* Create array of events.
	513	*/
	514
	515	/* Reset all macros within TRACEPOINT_EVENT */
	516	#include <lttng/ust-tracepoint-event-reset.h>
	517
	518	#undef TRACEPOINT_EVENT_INSTANCE
	519	#define TRACEPOINT_EVENT_INSTANCE(_provider, _template, _name, _args) \
	520	&__event_desc___##_provider##_##_name,
	521
	522	static const struct lttng_event_desc *_TP_COMBINE_TOKENS(__event_desc___, TRACEPOINT_PROVIDER)[] = {
05ceaafd MD	523	#include TRACEPOINT_INCLUDE
	524	};
	525
df854e41	526
05ceaafd	527	/*
882a56d7	528	* Stage 8 of tracepoint event generation.
05ceaafd MD	529	*
	530	* Create a toplevel descriptor for the whole probe.
	531	*/
	532
	533	/* non-const because list head will be modified when registered. */
	534	static struct lttng_probe_desc _TP_COMBINE_TOKENS(__probe_desc___, TRACEPOINT_PROVIDER) = {
df854e41	535	.provider = __tp_stringify(TRACEPOINT_PROVIDER),
05ceaafd MD	536	.event_desc = _TP_COMBINE_TOKENS(__event_desc___, TRACEPOINT_PROVIDER),
05ceaafd MD	537	.nr_events = _TP_ARRAY_SIZE(_TP_COMBINE_TOKENS(__event_desc___, TRACEPOINT_PROVIDER)),
05ceaafd MD	538	};
	539
	540	/*
882a56d7	541	* Stage 9 of tracepoint event generation.
05ceaafd	542	*
1c324e59	543	* Register/unregister probes at module load/unload.
628e1d81 MD	544	*
	545	* Generate the constructor as an externally visible symbol for use when
	546	* linking the probe statically.
1c324e59 MD	547	*/
	548
	549	/* Reset all macros within TRACEPOINT_EVENT */
	550	#include <lttng/ust-tracepoint-event-reset.h>
1c324e59 MD	551	static void __attribute__((constructor))
	552	_TP_COMBINE_TOKENS(__lttng_events_init__, TRACEPOINT_PROVIDER)(void)
	553	{
	554	int ret;
	555
	556	ret = ltt_probe_register(&_TP_COMBINE_TOKENS(__probe_desc___, TRACEPOINT_PROVIDER));
	557	assert(!ret);
	558	}
	559
	560	static void __attribute__((destructor))
	561	_TP_COMBINE_TOKENS(__lttng_events_exit__, TRACEPOINT_PROVIDER)(void)
	562	{
	563	ltt_probe_unregister(&_TP_COMBINE_TOKENS(__probe_desc___, TRACEPOINT_PROVIDER));
	564	}
628e1d81 MD	565
628e1d81 MD	566	int _TP_COMBINE_TOKENS(__tracepoint_provider_, TRACEPOINT_PROVIDER);