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

/*
 * lttng-events.h
 *
 * Copyright (C) 2009 Steven Rostedt <rostedt@goodmis.org>
 * Copyright (C) 2010-2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *
 * Dual LGPL v2.1/GPL v2 license.
 */

#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_full
#define __field_full(_type, _item, _order, _base)		\
	{							\
	  .name = #_item,					\
	  .type = __type_integer(_type, _order, _base, none),	\
	},

#undef __field
#define __field(_type, _item)					\
	__field_full(_type, _item, __BYTE_ORDER, 10)

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

#undef __field_network
#define __field_network(_type, _item)				\
	__field_full(_type, _item, __BIG_ENDIAN, 10)

#undef __field_network_hex
#define __field_network_hex(_type, _item)				\
	__field_full(_type, _item, __BIG_ENDIAN, 16)

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

#undef __array
#define __array(_type, _item, _length)				\
	__array_enc_ext(_type, _item, _length, __BYTE_ORDER, 10, none)

#undef __array_text
#define __array_text(_type, _item, _length)			\
	__array_enc_ext(_type, _item, _length, __BYTE_ORDER, 10, UTF8)

#undef __array_hex
#define __array_hex(_type, _item, _length)			\
	__array_enc_ext(_type, _item, _length, __BYTE_ORDER, 16, none)

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

#undef __dynamic_array
#define __dynamic_array(_type, _item, _length)			\
	__dynamic_array_enc_ext(_type, _item, _length, __BYTE_ORDER, 10, none)

#undef __dynamic_array_text
#define __dynamic_array_text(_type, _item, _length)		\
	__dynamic_array_enc_ext(_type, _item, _length, __BYTE_ORDER, 10, UTF8)

#undef __dynamic_array_hex
#define __dynamic_array_hex(_type, _item, _length)		\
	__dynamic_array_enc_ext(_type, _item, _length, __BYTE_ORDER, 16, none)

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

#ifndef TP_PROBE_CB
#define TP_PROBE_CB(_template)	&__event_probe__##_template
#endif

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

#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_full
#define __field_full(_type, _item, _order, _base)			       \
	__event_len += lib_ring_buffer_align(__event_len, ltt_alignof(_type)); \
	__event_len += sizeof(_type);

#undef __array_enc_ext
#define __array_enc_ext(_type, _item, _length, _order, _base, _encoding)       \
	__event_len += lib_ring_buffer_align(__event_len, ltt_alignof(_type)); \
	__event_len += sizeof(_type) * (_length);

#undef __dynamic_array_enc_ext
#define __dynamic_array_enc_ext(_type, _item, _length, _order, _base, _encoding)\
	__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)); \
	__dynamic_len[__dynamic_len_idx] = (_length);			       \
	__event_len += sizeof(_type) * __dynamic_len[__dynamic_len_idx];       \
	__dynamic_len_idx++;

#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_full
#define __field_full(_type, _item, _order, _base)			  \
	__event_align = max_t(size_t, __event_align, ltt_alignof(_type));

#undef __array_enc_ext
#define __array_enc_ext(_type, _item, _length, _order, _base, _encoding)  \
	__event_align = max_t(size_t, __event_align, ltt_alignof(_type));

#undef __dynamic_array_enc_ext
#define __dynamic_array_enc_ext(_type, _item, _length, _order, _base, _encoding)\
	__event_align = max_t(size_t, __event_align, ltt_alignof(u32));	  \
	__event_align = max_t(size_t, __event_align, ltt_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_full
#define __field_full(_type, _item, _order, _base)	_type	_item;

#undef __array_enc_ext
#define __array_enc_ext(_type, _item, _length, _order, _base, _encoding)  \
	_type	_item;

#undef __dynamic_array_enc_ext
#define __dynamic_array_enc_ext(_type, _item, _length, _order, _base, _encoding)\
	_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_full
#define __field_full(_type, _item, _order, _base)			\
	goto __assign_##_item;						\
__end_field_##_item:

#undef __array_enc_ext
#define __array_enc_ext(_type, _item, _length, _order, _base, _encoding)\
	goto __assign_##_item;						\
__end_field_##_item:

#undef __dynamic_array_enc_ext
#define __dynamic_array_enc_ext(_type, _item, _length, _order, _base, _encoding)\
	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, 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)					\
__assign_##dest##_1:							\
	{								\
		u32 __tmpl = __dynamic_len[__dynamic_len_idx];		\
		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,				\
		sizeof(__typemap.dest) * __get_dynamic_array_len(dest));\
	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 (unlikely(!ACCESS_ONCE(__chan->session->active)))		      \
		return;							      \
	if (unlikely(!ACCESS_ONCE(__chan->enabled)))			      \
		return;							      \
	if (unlikely(!ACCESS_ONCE(__event->enabled)))			      \
		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, __event, __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 */

/* Override for syscall tracing */
#ifndef TP_REGISTER_OVERRIDE
#define TP_REGISTER_OVERRIDE	ltt_probe_register
#endif

#ifndef TP_UNREGISTER_OVERRIDE
#define TP_UNREGISTER_OVERRIDE	ltt_probe_unregister
#endif

#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 TP_REGISTER_OVERRIDE(&TP_ID(__probe_desc___, TRACE_SYSTEM));
}

module_init_eval(__lttng_events_init__, TRACE_SYSTEM);

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