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

/*
 * Protect against multiple inclusion of structure declarations, but run the
 * stages below each time.
 */
#ifndef _LTTNG_PROBES_LTTNG_TYPES_H
#define _LTTNG_PROBES_LTTNG_TYPES_H

#include <linux/seq_file.h>
#include <lttng.h>

#ifdef __KERNEL__
# include <asm/byteorder.h>
# ifdef __BIG_ENDIAN
#  define __BYTE_ORDER __BIG_ENDIAN
# elif defined(__LITTLE_ENDIAN)
#  define __BYTE_ORDER __LITTLE_ENDIAN
# else
#  error "unknown endianness"
# endif
#ifndef __BIG_ENDIAN
# define __BIG_ENDIAN 4321
#endif
#ifndef __LITTLE_ENDIAN
# define __LITTLE_ENDIAN 1234
#endif
#else
# include <endian.h>
#endif

/* Update the astract_types name table in lttng-types.c along with this enum */
enum abstract_types {
	atype_integer,
	atype_enum,
	atype_array,
	atype_sequence,
	atype_string,
	NR_ABSTRACT_TYPES,
};

/* Update the string_encodings name table in lttng-types.c along with this enum */
enum lttng_string_encodings {
	lttng_encode_UTF8 = 0,
	lttng_encode_ASCII = 1,
	NR_STRING_ENCODINGS,
};

struct lttng_enum_entry {
	unsigned long long start, end;	/* start and end are inclusive */
	const char *string;
};

struct lttng_enum {
	const struct lttng_enum_entry *entries;
	unsigned int len;
};

struct lttng_type {
	enum abstract_types atype;
	const char *name;
	union {
		struct {
			unsigned int size;		/* in bits */
			unsigned short alignment;	/* in bits */
			unsigned int signedness:1;
			unsigned int reverse_byte_order:1;
		} integer;
		struct {
			const char *parent_type;
			const struct lttng_enum def;
		} enumeration;
		struct {
			const char *elem_type;
			unsigned int length;		/* num. elems. */
		} array;
		struct {
			const char *elem_type;
			const char *length_type;
		} sequence;
		struct {
			enum lttng_string_encodings encoding;
		} string;
	} u;
} __attribute__((packed));

void lttng_print_event_type(struct seq_file *m, unsigned int indent,
			    const struct lttng_type *type);

#endif /* _LTTNG_PROBES_LTTNG_TYPES_H */


/* Export enumerations */

#ifdef STAGE_EXPORT_ENUMS

#undef TRACE_EVENT_TYPE
#define TRACE_EVENT_TYPE(_name, _abstract_type, args...)

#undef TRACE_EVENT_ENUM
#define TRACE_EVENT_ENUM(_name, _entries...)				\
	const struct lttng_enum_entry __trace_event_enum_##_name[] = {	\
		PARAMS(_entries)					\
	};

/* Enumeration entry (single value) */
#undef V
#define V(_string)		{ _string, _string, #_string}

/* Enumeration entry (range) */
#undef R
#define R(_string, _range_start, _range_end)				\
	{ _range_start, _range_end, #_string }

#endif /* STAGE_EXPORT_ENUMS */


/* Export named types */

#ifdef STAGE_EXPORT_TYPES

#undef TRACE_EVENT_TYPE___integer_ext
#define TRACE_EVENT_TYPE___integer_ext(_name, _byte_order)	\
		{						\
		  .atype = atype_integer,			\
		  .name = #_name,				\
		  .u.integer.size = sizeof(_name) * 8,		\
		  .u.integer.alignment = __alignof__(_name) * 8,\
		  .u.integer.signedness = is_signed_type(_name),\
		  .u.integer.reverse_byte_order = ((_byte_order) != __BYTE_ORDER),\
		},

#undef TRACE_EVENT_TYPE___integer
#define TRACE_EVENT_TYPE___integer(_name, _unused)		\
		TRACE_EVENT_TYPE___integer_ext(_name, __BYTE_ORDER)

#undef TRACE_EVENT_TYPE___enum
#define TRACE_EVENT_TYPE___enum(_name, _parent_type)		\
		{						\
		  .atype = atype_enum,				\
		  .name = #_name,				\
		  .u.enumeration.parent_type = #_parent_type,	\
		  .u.enumeration.def.entries = __trace_event_enum_##_name, \
		  .u.enumeration.def.len = ARRAY_SIZE(__trace_event_enum_##_name), \
		},

#undef TRACE_EVENT_TYPE___array
#define TRACE_EVENT_TYPE___array(_name, _elem_type, _length)	\
		{						\
		  .atype = atype_array,				\
		  .name = #_name,				\
		  .u.array.elem_type = #_elem_type,		\
		  .u.array.length = _length,			\
		},

#undef TRACE_EVENT_TYPE___sequence
#define TRACE_EVENT_TYPE___sequence(_name, _elem_type, _length_type)	\
		{						\
		  .atype = atype_sequence,			\
		  .name = #_name,				\
		  .u.sequence.elem_type = #_elem_type,		\
		  .u.sequence.length_type = #_length_type,	\
		},

#undef TRACE_EVENT_TYPE___string
#define TRACE_EVENT_TYPE___string(_name, _encoding)		\
		{						\
		  .atype = atype_string,			\
		  .name = #_name,				\
		  .u.string.encoding = lttng_encode_##_encoding,\
		},


/* Local declaration */
#undef TRACE_EVENT_TYPE
#define TRACE_EVENT_TYPE(_name, _abstract_type, args...)	\
		TRACE_EVENT_TYPE___##_abstract_type(_name, args)

#undef TRACE_EVENT_ENUM
#define TRACE_EVENT_ENUM(_name, _entries...)

#endif /* STAGE_EXPORT_TYPES */
Commit	Line	Data
40652b65 MD	1	/*
	2	* Protect against multiple inclusion of structure declarations, but run the
	3	* stages below each time.
	4	*/
	5	#ifndef _LTTNG_PROBES_LTTNG_TYPES_H
	6	#define _LTTNG_PROBES_LTTNG_TYPES_H
	7
d0dd2ecb	8	#include <linux/seq_file.h>
40652b65 MD	9	#include <lttng.h>
40652b65 MD	10
1d12cebd MD	11	#ifdef __KERNEL__
	12	# include <asm/byteorder.h>
	13	# ifdef __BIG_ENDIAN
	14	# define __BYTE_ORDER __BIG_ENDIAN
	15	# elif defined(__LITTLE_ENDIAN)
	16	# define __BYTE_ORDER __LITTLE_ENDIAN
	17	# else
	18	# error "unknown endianness"
	19	# endif
	20	#ifndef __BIG_ENDIAN
	21	# define __BIG_ENDIAN 4321
	22	#endif
	23	#ifndef __LITTLE_ENDIAN
	24	# define __LITTLE_ENDIAN 1234
	25	#endif
	26	#else
	27	# include <endian.h>
	28	#endif
	29
	30	/* Update the astract_types name table in lttng-types.c along with this enum */
40652b65 MD	31	enum abstract_types {
	32	atype_integer,
	33	atype_enum,
	34	atype_array,
1d12cebd MD	35	atype_sequence,
1d12cebd MD	36	atype_string,
40652b65 MD	37	NR_ABSTRACT_TYPES,
	38	};
	39
1d12cebd MD	40	/* Update the string_encodings name table in lttng-types.c along with this enum */
	41	enum lttng_string_encodings {
	42	lttng_encode_UTF8 = 0,
	43	lttng_encode_ASCII = 1,
	44	NR_STRING_ENCODINGS,
	45	};
	46
40652b65 MD	47	struct lttng_enum_entry {
	48	unsigned long long start, end; /* start and end are inclusive */
	49	const char *string;
	50	};
	51
	52	struct lttng_enum {
	53	const struct lttng_enum_entry *entries;
	54	unsigned int len;
	55	};
	56
	57	struct lttng_type {
	58	enum abstract_types atype;
	59	const char *name;
	60	union {
	61	struct {
	62	unsigned int size; /* in bits */
	63	unsigned short alignment; /* in bits */
	64	unsigned int signedness:1;
1d12cebd	65	unsigned int reverse_byte_order:1;
40652b65 MD	66	} integer;
	67	struct {
	68	const char *parent_type;
	69	const struct lttng_enum def;
	70	} enumeration;
	71	struct {
	72	const char *elem_type;
	73	unsigned int length; /* num. elems. */
	74	} array;
1d12cebd MD	75	struct {
	76	const char *elem_type;
	77	const char *length_type;
	78	} sequence;
	79	struct {
	80	enum lttng_string_encodings encoding;
	81	} string;
40652b65 MD	82	} u;
	83	} __attribute__((packed));
	84
d0dd2ecb MD	85	void lttng_print_event_type(struct seq_file *m, unsigned int indent,
	86	const struct lttng_type *type);
	87
40652b65 MD	88	#endif /* _LTTNG_PROBES_LTTNG_TYPES_H */
	89
	90
	91	/* Export enumerations */
	92
	93	#ifdef STAGE_EXPORT_ENUMS
	94
	95	#undef TRACE_EVENT_TYPE
	96	#define TRACE_EVENT_TYPE(_name, _abstract_type, args...)
	97
	98	#undef TRACE_EVENT_ENUM
	99	#define TRACE_EVENT_ENUM(_name, _entries...) \
	100	const struct lttng_enum_entry __trace_event_enum_##_name[] = { \
	101	PARAMS(_entries) \
	102	};
	103
	104	/* Enumeration entry (single value) */
	105	#undef V
	106	#define V(_string) { _string, _string, #_string}
	107
	108	/* Enumeration entry (range) */
	109	#undef R
	110	#define R(_string, _range_start, _range_end) \
	111	{ _range_start, _range_end, #_string }
	112
	113	#endif /* STAGE_EXPORT_ENUMS */
	114
	115
	116	/* Export named types */
	117
	118	#ifdef STAGE_EXPORT_TYPES
	119
1d12cebd MD	120	#undef TRACE_EVENT_TYPE___integer_ext
1d12cebd MD	121	#define TRACE_EVENT_TYPE___integer_ext(_name, _byte_order) \
40652b65 MD	122	{ \
	123	.atype = atype_integer, \
	124	.name = #_name, \
	125	.u.integer.size = sizeof(_name) * 8, \
	126	.u.integer.alignment = __alignof__(_name) * 8,\
	127	.u.integer.signedness = is_signed_type(_name),\
1d12cebd	128	.u.integer.reverse_byte_order = ((_byte_order) != __BYTE_ORDER),\
40652b65 MD	129	},
40652b65 MD	130
1d12cebd MD	131	#undef TRACE_EVENT_TYPE___integer
	132	#define TRACE_EVENT_TYPE___integer(_name, _unused) \
	133	TRACE_EVENT_TYPE___integer_ext(_name, __BYTE_ORDER)
	134
40652b65 MD	135	#undef TRACE_EVENT_TYPE___enum
	136	#define TRACE_EVENT_TYPE___enum(_name, _parent_type) \
	137	{ \
	138	.atype = atype_enum, \
	139	.name = #_name, \
	140	.u.enumeration.parent_type = #_parent_type, \
	141	.u.enumeration.def.entries = __trace_event_enum_##_name, \
	142	.u.enumeration.def.len = ARRAY_SIZE(__trace_event_enum_##_name), \
	143	},
	144
	145	#undef TRACE_EVENT_TYPE___array
	146	#define TRACE_EVENT_TYPE___array(_name, _elem_type, _length) \
	147	{ \
	148	.atype = atype_array, \
	149	.name = #_name, \
	150	.u.array.elem_type = #_elem_type, \
	151	.u.array.length = _length, \
	152	},
	153
1d12cebd MD	154	#undef TRACE_EVENT_TYPE___sequence
	155	#define TRACE_EVENT_TYPE___sequence(_name, _elem_type, _length_type) \
	156	{ \
	157	.atype = atype_sequence, \
	158	.name = #_name, \
	159	.u.sequence.elem_type = #_elem_type, \
	160	.u.sequence.length_type = #_length_type, \
	161	},
	162
	163	#undef TRACE_EVENT_TYPE___string
	164	#define TRACE_EVENT_TYPE___string(_name, _encoding) \
	165	{ \
	166	.atype = atype_string, \
	167	.name = #_name, \
	168	.u.string.encoding = lttng_encode_##_encoding,\
	169	},
	170
	171
40652b65 MD	172	/* Local declaration */
	173	#undef TRACE_EVENT_TYPE
	174	#define TRACE_EVENT_TYPE(_name, _abstract_type, args...) \
	175	TRACE_EVENT_TYPE___##_abstract_type(_name, args)
	176
	177	#undef TRACE_EVENT_ENUM
	178	#define TRACE_EVENT_ENUM(_name, _entries...)
	179
	180	#endif /* STAGE_EXPORT_TYPES */