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

/* SPDX-License-Identifier: (GPL-2.0-only or LGPL-2.1-only)
 *
 * lttng/events.h
 *
 * Holds LTTng per-session event registry.
 *
 * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 */

#ifndef _LTTNG_EVENTS_H
#define _LTTNG_EVENTS_H

#include <lttng/kernel-version.h>
#include <linux/list.h>
#include <linux/kprobes.h>
#include <linux/kref.h>
#include <linux/uuid.h>
#include <linux/irq_work.h>
#include <wrapper/uprobes.h>
#include <lttng/cpuhotplug.h>
#include <lttng/tracer.h>
#include <lttng/abi.h>
#include <lttng/abi-old.h>
#include <lttng/endian.h>

#define lttng_is_signed_type(type)	(((type) -1) < (type) 1)

struct lttng_kernel_channel_buffer;
struct lttng_kernel_session;
struct lttng_kernel_ring_buffer_ctx;

/* Type description */

enum lttng_kernel_type {
	lttng_kernel_type_integer,
	lttng_kernel_type_string,
	lttng_kernel_type_enum,
	lttng_kernel_type_array,
	lttng_kernel_type_sequence,
	lttng_kernel_type_struct,
	lttng_kernel_type_variant,
	NR_LTTNG_KERNEL_TYPES,
};

enum lttng_kernel_string_encoding {
	lttng_kernel_string_encoding_none = 0,
	lttng_kernel_string_encoding_UTF8 = 1,
	lttng_kernel_string_encoding_ASCII = 2,
	NR_LTTNG_KERNEL_STRING_ENCODING,
};

struct lttng_kernel_enum_value {
	unsigned long long value;
	unsigned int signedness:1;
};

struct lttng_kernel_enum_entry {
	struct lttng_kernel_enum_value start, end;	/* start and end are inclusive */
	const char *string;
	struct {
		unsigned int is_auto:1;
	} options;
};

/*
 * struct lttng_kernel_type_common is fixed-size. Its children inherits
 * from it by embedding struct lttng_kernel_type_common as its first field.
 */
struct lttng_kernel_type_common {
	enum lttng_kernel_type type;
};

struct lttng_kernel_type_integer {
	struct lttng_kernel_type_common parent;
	unsigned int size;		/* in bits */
	unsigned short alignment;	/* in bits */
	unsigned int signedness:1,
		reverse_byte_order:1;
	unsigned int base;		/* 2, 8, 10, 16, for pretty print */
};

struct lttng_kernel_type_string {
	struct lttng_kernel_type_common parent;
	enum lttng_kernel_string_encoding encoding;
};

struct lttng_kernel_type_enum {
	struct lttng_kernel_type_common parent;
	const struct lttng_kernel_enum_desc *desc;	/* Enumeration mapping */
	const struct lttng_kernel_type_common *container_type;
};

struct lttng_kernel_type_array {
	struct lttng_kernel_type_common parent;
	const struct lttng_kernel_type_common *elem_type;
	unsigned int length;			/* Num. elems. */
	unsigned int alignment;
	enum lttng_kernel_string_encoding encoding;
};

struct lttng_kernel_type_sequence {
	struct lttng_kernel_type_common parent;
	const char *length_name;	/* Length field name. If NULL, use previous field. */
	const struct lttng_kernel_type_common *elem_type;
	unsigned int alignment;		/* Alignment before elements. */
	enum lttng_kernel_string_encoding encoding;
};

struct lttng_kernel_type_struct {
	struct lttng_kernel_type_common parent;
	unsigned int nr_fields;
	const struct lttng_kernel_event_field * const *fields;	/* Array of pointers to fields. */
	unsigned int alignment;
};

struct lttng_kernel_type_variant {
	struct lttng_kernel_type_common parent;
	const char *tag_name;		/* Tag field name. If NULL, use previous field. */
	const struct lttng_kernel_event_field * const *choices; /* Array of pointers to fields. */
	unsigned int nr_choices;
	unsigned int alignment;
};

struct lttng_kernel_enum_desc {
	const char *name;
	const struct lttng_kernel_enum_entry * const *entries;
	unsigned int nr_entries;
	const struct lttng_kernel_probe_desc *probe_desc;
};

/* Event field description */

struct lttng_kernel_event_field {
	const char *name;
	const struct lttng_kernel_type_common *type;
	unsigned int nowrite:1,		/* do not write into trace */
			user:1,		/* fetch from user-space */
			nofilter:1;	/* do not consider for filter */
};

#ifndef PARAMS
#define PARAMS(args...)	args
#endif

#define lttng_kernel_static_type_integer(_size, _alignment, _signedness, _byte_order, _base)		\
	((const struct lttng_kernel_type_common *) __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_type_integer, { \
		.parent = {										\
			.type = lttng_kernel_type_integer,							\
		},											\
		.size = (_size),									\
		.alignment = (_alignment),								\
		.signedness = (_signedness),								\
		.reverse_byte_order = (_byte_order) != __BYTE_ORDER,					\
		.base = (_base),									\
	}))

#define lttng_kernel_static_type_integer_from_type(_type, _byte_order, _base)				\
	lttng_kernel_static_type_integer(sizeof(_type) * CHAR_BIT,					\
			lttng_alignof(_type) * CHAR_BIT,						\
			lttng_is_signed_type(_type),							\
			_byte_order,									\
			_base)

#define lttng_kernel_static_type_enum(_desc, _container_type)						\
	((const struct lttng_kernel_type_common *) __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_type_enum, { \
		.parent = {										\
			.type = lttng_kernel_type_enum,							\
		},											\
		.desc = (_desc),									\
		.container_type = (_container_type),							\
	}))

#define lttng_kernel_static_type_array(_length, _elem_type, _alignment, _encoding)			\
	((const struct lttng_kernel_type_common *) __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_type_array, { \
		.parent = {										\
			.type = lttng_kernel_type_array,						\
		},											\
		.length = (_length),									\
		.alignment = (_alignment),								\
		.encoding = lttng_kernel_string_encoding_##_encoding,					\
		.elem_type = (_elem_type),								\
	}))

#define lttng_kernel_static_type_array_text(_length)							\
	lttng_kernel_static_type_array(_length,								\
		lttng_kernel_static_type_integer(sizeof(char) * CHAR_BIT,				\
				lttng_alignof(char) * CHAR_BIT, lttng_is_signed_type(char),		\
				__BYTE_ORDER, 10),							\
		0, UTF8)

#define lttng_kernel_static_type_sequence(_length_name, _elem_type, _alignment, _encoding)			\
	((const struct lttng_kernel_type_common *) __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_type_sequence, { \
		.parent = {										\
			.type = lttng_kernel_type_sequence,						\
		},											\
		.length_name = (_length_name),								\
		.alignment = (_alignment),								\
		.encoding = lttng_kernel_string_encoding_##_encoding,					\
		.elem_type = (_elem_type),								\
	}))

#define lttng_kernel_static_type_string(_encoding)							\
	((const struct lttng_kernel_type_common *) __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_type_string, { \
		.parent = {										\
			.type = lttng_kernel_type_string,						\
		},											\
		.encoding = lttng_kernel_string_encoding_##_encoding,					\
	}))

#define lttng_kernel_static_type_struct_init(_nr_fields, _fields, _alignment)				\
	{												\
		.parent = {										\
			.type = lttng_kernel_type_struct,						\
		},											\
		.nr_fields = (_nr_fields),								\
		.fields = _fields,									\
		.alignment = (_alignment),								\
	}

#define lttng_kernel_static_type_struct(_nr_fields, _fields, _alignment)				\
	((const struct lttng_kernel_type_common *) __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_type_struct, \
		lttng_kernel_static_type_struct_init(_nr_fields, PARAMS(_fields), _alignment)			\
	))

#define lttng_kernel_static_type_variant(_nr_choices, _choices, _tag_name, _alignment)			\
	((const struct lttng_kernel_type_common *) __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_type_variant, { \
		.parent = {										\
			.type = lttng_kernel_type_variant,						\
		},											\
		.tag_name = (_tag_name),								\
		.choices = _choices,									\
		.nr_choices = (_nr_choices),								\
		.alignment = (_alignment),								\
	}))

#define lttng_kernel_static_event_field(_name, _type, _nowrite, _user, _nofilter)			\
	__LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_event_field, {				\
		.name = (_name),									\
		.type = (_type),									\
		.nowrite = (_nowrite),									\
		.user = (_user),									\
		.nofilter = (_nofilter),								\
	})

#define lttng_kernel_static_event_field_array(_fields...)						\
	__LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_event_field *,				\
		_fields											\
	)

#define lttng_kernel_static_enum_entry_value(_string, _value)						\
	__LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_enum_entry, {				\
		.start = {										\
			.signedness = lttng_is_signed_type(__typeof__(_value)),				\
			.value = lttng_is_signed_type(__typeof__(_value)) ?				\
				(long long) (_value) : (_value),					\
		},											\
		.end = {										\
			.signedness = lttng_is_signed_type(__typeof__(_value)),				\
			.value = lttng_is_signed_type(__typeof__(_value)) ?				\
				(long long) (_value) : (_value),					\
		},											\
		.string = (_string),									\
	}),

#define lttng_kernel_static_enum_entry_range(_string, _range_start, _range_end)				\
	__LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_enum_entry, {				\
		.start = {										\
			.signedness = lttng_is_signed_type(__typeof__(_range_start)),			\
			.value = lttng_is_signed_type(__typeof__(_range_start)) ?			\
				(long long) (_range_start) : (_range_start),				\
		},											\
		.end = {										\
			.signedness = lttng_is_signed_type(__typeof__(_range_end)),			\
			.value = lttng_is_signed_type(__typeof__(_range_end)) ?				\
				(long long) (_range_end) : (_range_end),				\
		},											\
		.string = (_string),									\
	}),

#define lttng_kernel_static_enum_entry_auto(_string)							\
	__LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_enum_entry, {				\
		.start = {										\
			.signedness = -1,								\
			.value = -1,									\
		},											\
		.end = {										\
			.signedness = -1, 								\
			.value = -1,									\
		},											\
		.string = (_string),									\
		.options = {										\
			.is_auto = 1,									\
		}											\
	}),

struct lttng_kernel_probe_ctx {
	struct lttng_kernel_event_common *event;
	uint8_t interruptible;
};

struct lttng_kernel_tracepoint_class {
	void (*probe_callback)(void);
	const struct lttng_kernel_event_field * const *fields;	/* event payload */
	unsigned int nr_fields;
	const struct lttng_kernel_probe_desc *probe_desc;
};

struct lttng_kernel_event_desc {
	const char *event_name;		/* lttng-modules name */
	const char *event_kname;	/* Linux kernel name (tracepoints) */
	const struct lttng_kernel_probe_desc *probe_desc;
	const struct lttng_kernel_tracepoint_class *tp_class;
	struct module *owner;
};

struct lttng_kernel_probe_desc {
	const char *provider_name;
	const struct lttng_kernel_event_desc * const *event_desc;
	unsigned int nr_events;
	struct list_head head;			/* chain registered probes */
	struct list_head lazy_init_head;
	int lazy;				/* lazy registration */
};

/*
 * Result of the run_filter() callback.
 */
enum lttng_kernel_event_filter_result {
	LTTNG_KERNEL_EVENT_FILTER_ACCEPT = 0,
	LTTNG_KERNEL_EVENT_FILTER_REJECT = 1,
};

struct lttng_kernel_event_common_private;

enum lttng_kernel_event_type {
	LTTNG_KERNEL_EVENT_TYPE_RECORDER = 0,
	LTTNG_KERNEL_EVENT_TYPE_NOTIFIER = 1,
};

struct lttng_kernel_event_common {
	struct lttng_kernel_event_common_private *priv;	/* Private event interface */

	enum lttng_kernel_event_type type;
	/* Get child with container_of(). */

	int enabled;
	int eval_filter;				/* Need to evaluate filters */
	int (*run_filter)(const struct lttng_kernel_event_common *event,
		const char *stack_data,
		struct lttng_kernel_probe_ctx *probe_ctx,
		void *filter_ctx);
};

struct lttng_kernel_event_recorder_private;

struct lttng_kernel_event_recorder {
	struct lttng_kernel_event_common parent;
	struct lttng_kernel_event_recorder_private *priv;	/* Private event record interface */

	struct lttng_kernel_channel_buffer *chan;
};

struct lttng_kernel_notification_ctx {
	int eval_capture;					/* Capture evaluation available. */
};

struct lttng_kernel_event_notifier_private;

struct lttng_kernel_event_notifier {
	struct lttng_kernel_event_common parent;
	struct lttng_kernel_event_notifier_private *priv;	/* Private event notifier interface */

	int eval_capture;				/* Need to evaluate capture */
	void (*notification_send)(struct lttng_kernel_event_notifier *event_notifier,
		const char *stack_data,
		struct lttng_kernel_probe_ctx *probe_ctx,
		struct lttng_kernel_notification_ctx *notif_ctx);
};

struct lttng_kernel_channel_buffer_ops {
	struct lttng_kernel_channel_buffer_ops_private *priv;	/* Private channel buffer ops interface. */

	int (*event_reserve)(struct lttng_kernel_ring_buffer_ctx *ctx);
	void (*event_commit)(struct lttng_kernel_ring_buffer_ctx *ctx);
	void (*event_write)(struct lttng_kernel_ring_buffer_ctx *ctx, const void *src,
			    size_t len, size_t alignment);
	void (*event_write_from_user)(struct lttng_kernel_ring_buffer_ctx *ctx,
				      const void *src, size_t len, size_t alignment);
	void (*event_memset)(struct lttng_kernel_ring_buffer_ctx *ctx,
			     int c, size_t len);
	void (*event_strcpy)(struct lttng_kernel_ring_buffer_ctx *ctx, const char *src,
			     size_t len);
	void (*event_strcpy_from_user)(struct lttng_kernel_ring_buffer_ctx *ctx,
				       const char __user *src, size_t len);
	void (*lost_event_too_big)(struct lttng_kernel_channel_buffer *lttng_channel);
};

enum lttng_kernel_channel_type {
	LTTNG_KERNEL_CHANNEL_TYPE_BUFFER = 0,
};

struct lttng_kernel_channel_common_private;

/* Use container_of() to get child. */
struct lttng_kernel_channel_common {
	struct lttng_kernel_channel_common_private *priv;	/* Private channel interface. */

	enum lttng_kernel_channel_type type;

	int enabled;
	struct lttng_kernel_session *session;
};

struct lttng_kernel_channel_buffer_private;

struct lttng_kernel_channel_buffer {
	struct lttng_kernel_channel_common parent;
	struct lttng_kernel_channel_buffer_private *priv;

	struct lttng_kernel_channel_buffer_ops *ops;
};

#define LTTNG_DYNAMIC_LEN_STACK_SIZE	128

struct lttng_dynamic_len_stack {
	size_t stack[LTTNG_DYNAMIC_LEN_STACK_SIZE];
	size_t offset;
};

DECLARE_PER_CPU(struct lttng_dynamic_len_stack, lttng_dynamic_len_stack);

/*
 * struct lttng_kernel_id_tracker declared in header due to deferencing of *v
 * in RCU_INITIALIZER(v).
 */
#define LTTNG_ID_HASH_BITS	6
#define LTTNG_ID_TABLE_SIZE	(1 << LTTNG_ID_HASH_BITS)

struct lttng_kernel_id_tracker_rcu {
	struct hlist_head id_hash[LTTNG_ID_TABLE_SIZE];
};

struct lttng_kernel_id_tracker {
	struct lttng_kernel_id_tracker_private *priv;	/* Private API */

	struct lttng_kernel_id_tracker_rcu *p;	/* RCU dereferenced. */
};

struct lttng_kernel_session_private;

struct lttng_kernel_session {
	struct lttng_kernel_session_private *priv;	/* Private session interface */

	int active;			/* Is trace session active ? */

	struct lttng_kernel_id_tracker pid_tracker;
	struct lttng_kernel_id_tracker vpid_tracker;
	struct lttng_kernel_id_tracker uid_tracker;
	struct lttng_kernel_id_tracker vuid_tracker;
	struct lttng_kernel_id_tracker gid_tracker;
	struct lttng_kernel_id_tracker vgid_tracker;
};

int lttng_kernel_probe_register(struct lttng_kernel_probe_desc *desc);
void lttng_kernel_probe_unregister(struct lttng_kernel_probe_desc *desc);

bool lttng_id_tracker_lookup(struct lttng_kernel_id_tracker_rcu *p, int id);

#endif /* _LTTNG_EVENTS_H */
Commit	Line	Data
b7cdc182	1	/* SPDX-License-Identifier: (GPL-2.0-only or LGPL-2.1-only)
9f36eaed	2	*
2df37e95	3	* lttng/events.h
4e3c1b9b	4	*
4e3c1b9b	5	* Holds LTTng per-session event registry.
17baffe2	6	*
886d51a3	7	* Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4e3c1b9b MD	8	*/
4e3c1b9b MD	9
9f36eaed MJ	10	#ifndef _LTTNG_EVENTS_H
	11	#define _LTTNG_EVENTS_H
	12
5f4c791e	13	#include <lttng/kernel-version.h>
4e3c1b9b	14	#include <linux/list.h>
d6d808f3	15	#include <linux/kprobes.h>
d83004aa	16	#include <linux/kref.h>
41f229dc	17	#include <linux/uuid.h>
754d534a	18	#include <linux/irq_work.h>
149b9a9d	19	#include <wrapper/uprobes.h>
2df37e95 MD	20	#include <lttng/cpuhotplug.h>
	21	#include <lttng/tracer.h>
	22	#include <lttng/abi.h>
	23	#include <lttng/abi-old.h>
	24	#include <lttng/endian.h>
4e3c1b9b	25
e97dc605	26	#define lttng_is_signed_type(type) (((type) -1) < (type) 1)
9e7e4892	27
f7d06400	28	struct lttng_kernel_channel_buffer;
8cdc1a81	29	struct lttng_kernel_session;
8a57ec02	30	struct lttng_kernel_ring_buffer_ctx;
4e3c1b9b	31
c0edae1d MD	32	/* Type description */
c0edae1d MD	33
12bb2edb MD	34	enum lttng_kernel_type {
	35	lttng_kernel_type_integer,
	36	lttng_kernel_type_string,
437d5aa5 MD	37	lttng_kernel_type_enum,
	38	lttng_kernel_type_array,
	39	lttng_kernel_type_sequence,
	40	lttng_kernel_type_struct,
	41	lttng_kernel_type_variant,
12bb2edb	42	NR_LTTNG_KERNEL_TYPES,
c0edae1d MD	43	};
c0edae1d MD	44
28cbcb59 MD	45	enum lttng_kernel_string_encoding {
	46	lttng_kernel_string_encoding_none = 0,
	47	lttng_kernel_string_encoding_UTF8 = 1,
	48	lttng_kernel_string_encoding_ASCII = 2,
	49	NR_LTTNG_KERNEL_STRING_ENCODING,
c0edae1d MD	50	};
c0edae1d MD	51
a28cc520	52	struct lttng_kernel_enum_value {
141ddf28 MD	53	unsigned long long value;
	54	unsigned int signedness:1;
	55	};
	56
a28cc520 MD	57	struct lttng_kernel_enum_entry {
a28cc520 MD	58	struct lttng_kernel_enum_value start, end; /* start and end are inclusive */
c0edae1d	59	const char *string;
08ad1061 PP	60	struct {
	61	unsigned int is_auto:1;
	62	} options;
c0edae1d MD	63	};
c0edae1d MD	64
437d5aa5 MD	65	/*
	66	* struct lttng_kernel_type_common is fixed-size. Its children inherits
	67	* from it by embedding struct lttng_kernel_type_common as its first field.
	68	*/
	69	struct lttng_kernel_type_common {
	70	enum lttng_kernel_type type;
	71	};
	72
	73	struct lttng_kernel_type_integer {
	74	struct lttng_kernel_type_common parent;
c099397a MD	75	unsigned int size; /* in bits */
c099397a MD	76	unsigned short alignment; /* in bits */
9cccf98a MD	77	unsigned int signedness:1,
9cccf98a MD	78	reverse_byte_order:1;
e0a7a7c4	79	unsigned int base; /* 2, 8, 10, 16, for pretty print */
437d5aa5 MD	80	};
	81
	82	struct lttng_kernel_type_string {
	83	struct lttng_kernel_type_common parent;
28cbcb59	84	enum lttng_kernel_string_encoding encoding;
c099397a MD	85	};
c099397a MD	86
437d5aa5 MD	87	struct lttng_kernel_type_enum {
	88	struct lttng_kernel_type_common parent;
	89	const struct lttng_kernel_enum_desc desc; / Enumeration mapping */
	90	const struct lttng_kernel_type_common *container_type;
	91	};
	92
	93	struct lttng_kernel_type_array {
	94	struct lttng_kernel_type_common parent;
	95	const struct lttng_kernel_type_common *elem_type;
	96	unsigned int length; /* Num. elems. */
	97	unsigned int alignment;
	98	enum lttng_kernel_string_encoding encoding;
	99	};
	100
	101	struct lttng_kernel_type_sequence {
	102	struct lttng_kernel_type_common parent;
51ef4536	103	const char length_name; / Length field name. If NULL, use previous field. */
437d5aa5 MD	104	const struct lttng_kernel_type_common *elem_type;
	105	unsigned int alignment; /* Alignment before elements. */
	106	enum lttng_kernel_string_encoding encoding;
	107	};
	108
	109	struct lttng_kernel_type_struct {
	110	struct lttng_kernel_type_common parent;
	111	unsigned int nr_fields;
4f1d1ee5	112	const struct lttng_kernel_event_field * const fields; / Array of pointers to fields. */
437d5aa5 MD	113	unsigned int alignment;
	114	};
	115
	116	struct lttng_kernel_type_variant {
	117	struct lttng_kernel_type_common parent;
51ef4536	118	const char tag_name; / Tag field name. If NULL, use previous field. */
4f1d1ee5	119	const struct lttng_kernel_event_field * const choices; / Array of pointers to fields. */
437d5aa5 MD	120	unsigned int nr_choices;
437d5aa5 MD	121	unsigned int alignment;
c099397a MD	122	};
c099397a MD	123
d96a4a7a	124	struct lttng_kernel_enum_desc {
c099397a	125	const char *name;
4f1d1ee5	126	const struct lttng_kernel_enum_entry * const *entries;
141ddf28	127	unsigned int nr_entries;
6c8c025b	128	const struct lttng_kernel_probe_desc *probe_desc;
c099397a	129	};
c0edae1d MD	130
	131	/* Event field description */
	132
437d5aa5	133	struct lttng_kernel_event_field {
c0edae1d	134	const char *name;
437d5aa5	135	const struct lttng_kernel_type_common *type;
f127e61e	136	unsigned int nowrite:1, /* do not write into trace */
ceabb767 MD	137	user:1, /* fetch from user-space */
ceabb767 MD	138	nofilter:1; /* do not consider for filter */
c0edae1d MD	139	};
c0edae1d MD	140
9857164a FD	141	#ifndef PARAMS
	142	#define PARAMS(args...) args
	143	#endif
	144
437d5aa5 MD	145	#define lttng_kernel_static_type_integer(_size, _alignment, _signedness, _byte_order, _base) \
	146	((const struct lttng_kernel_type_common *) __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_type_integer, { \
	147	.parent = { \
	148	.type = lttng_kernel_type_integer, \
	149	}, \
	150	.size = (_size), \
	151	.alignment = (_alignment), \
	152	.signedness = (_signedness), \
	153	.reverse_byte_order = (_byte_order) != __BYTE_ORDER, \
	154	.base = (_base), \
	155	}))
	156
	157	#define lttng_kernel_static_type_integer_from_type(_type, _byte_order, _base) \
	158	lttng_kernel_static_type_integer(sizeof(_type) * CHAR_BIT, \
	159	lttng_alignof(_type) * CHAR_BIT, \
	160	lttng_is_signed_type(_type), \
	161	_byte_order, \
	162	_base)
	163
	164	#define lttng_kernel_static_type_enum(_desc, _container_type) \
	165	((const struct lttng_kernel_type_common *) __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_type_enum, { \
	166	.parent = { \
	167	.type = lttng_kernel_type_enum, \
	168	}, \
	169	.desc = (_desc), \
	170	.container_type = (_container_type), \
	171	}))
	172
	173	#define lttng_kernel_static_type_array(_length, _elem_type, _alignment, _encoding) \
	174	((const struct lttng_kernel_type_common *) __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_type_array, { \
	175	.parent = { \
	176	.type = lttng_kernel_type_array, \
	177	}, \
	178	.length = (_length), \
	179	.alignment = (_alignment), \
	180	.encoding = lttng_kernel_string_encoding_##_encoding, \
	181	.elem_type = (_elem_type), \
	182	}))
	183
	184	#define lttng_kernel_static_type_array_text(_length) \
	185	lttng_kernel_static_type_array(_length, \
	186	lttng_kernel_static_type_integer(sizeof(char) * CHAR_BIT, \
	187	lttng_alignof(char) * CHAR_BIT, lttng_is_signed_type(char), \
	188	__BYTE_ORDER, 10), \
	189	0, UTF8)
	190
	191	#define lttng_kernel_static_type_sequence(_length_name, _elem_type, _alignment, _encoding) \
	192	((const struct lttng_kernel_type_common *) __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_type_sequence, { \
	193	.parent = { \
	194	.type = lttng_kernel_type_sequence, \
	195	}, \
	196	.length_name = (_length_name), \
	197	.alignment = (_alignment), \
	198	.encoding = lttng_kernel_string_encoding_##_encoding, \
	199	.elem_type = (_elem_type), \
	200	}))
	201
	202	#define lttng_kernel_static_type_string(_encoding) \
	203	((const struct lttng_kernel_type_common *) __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_type_string, { \
	204	.parent = { \
	205	.type = lttng_kernel_type_string, \
	206	}, \
	207	.encoding = lttng_kernel_string_encoding_##_encoding, \
	208	}))
209
9857164a FD	210	#define lttng_kernel_static_type_struct_init(_nr_fields, _fields, _alignment) \
9857164a FD	211	{ \
437d5aa5 MD	212	.parent = { \
	213	.type = lttng_kernel_type_struct, \
	214	}, \
	215	.nr_fields = (_nr_fields), \
	216	.fields = _fields, \
	217	.alignment = (_alignment), \
9857164a FD	218	}
	219
	220	#define lttng_kernel_static_type_struct(_nr_fields, _fields, _alignment) \
	221	((const struct lttng_kernel_type_common *) __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_type_struct, \
	222	lttng_kernel_static_type_struct_init(_nr_fields, PARAMS(_fields), _alignment) \
	223	))
437d5aa5 MD	224
	225	#define lttng_kernel_static_type_variant(_nr_choices, _choices, _tag_name, _alignment) \
	226	((const struct lttng_kernel_type_common *) __LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_type_variant, { \
	227	.parent = { \
	228	.type = lttng_kernel_type_variant, \
	229	}, \
	230	.tag_name = (_tag_name), \
	231	.choices = _choices, \
	232	.nr_choices = (_nr_choices), \
	233	.alignment = (_alignment), \
	234	}))
	235
	236	#define lttng_kernel_static_event_field(_name, _type, _nowrite, _user, _nofilter) \
	237	__LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_event_field, { \
	238	.name = (_name), \
	239	.type = (_type), \
	240	.nowrite = (_nowrite), \
	241	.user = (_user), \
	242	.nofilter = (_nofilter), \
	243	})
	244
	245	#define lttng_kernel_static_event_field_array(_fields...) \
	246	__LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_event_field *, \
	247	_fields \
	248	)
	249
437d5aa5 MD	250	#define lttng_kernel_static_enum_entry_value(_string, _value) \
	251	__LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_enum_entry, { \
	252	.start = { \
	253	.signedness = lttng_is_signed_type(__typeof__(_value)), \
	254	.value = lttng_is_signed_type(__typeof__(_value)) ? \
	255	(long long) (_value) : (_value), \
	256	}, \
	257	.end = { \
	258	.signedness = lttng_is_signed_type(__typeof__(_value)), \
	259	.value = lttng_is_signed_type(__typeof__(_value)) ? \
	260	(long long) (_value) : (_value), \
	261	}, \
	262	.string = (_string), \
	263	}),
	264
	265	#define lttng_kernel_static_enum_entry_range(_string, _range_start, _range_end) \
	266	__LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_enum_entry, { \
	267	.start = { \
	268	.signedness = lttng_is_signed_type(__typeof__(_range_start)), \
	269	.value = lttng_is_signed_type(__typeof__(_range_start)) ? \
	270	(long long) (_range_start) : (_range_start), \
	271	}, \
	272	.end = { \
	273	.signedness = lttng_is_signed_type(__typeof__(_range_end)), \
	274	.value = lttng_is_signed_type(__typeof__(_range_end)) ? \
	275	(long long) (_range_end) : (_range_end), \
	276	}, \
	277	.string = (_string), \
	278	}),
	279
	280	#define lttng_kernel_static_enum_entry_auto(_string) \
	281	__LTTNG_COMPOUND_LITERAL(const struct lttng_kernel_enum_entry, { \
	282	.start = { \
	283	.signedness = -1, \
	284	.value = -1, \
	285	}, \
	286	.end = { \
	287	.signedness = -1, \
	288	.value = -1, \
	289	}, \
	290	.string = (_string), \
	291	.options = { \
	292	.is_auto = 1, \
	293	} \
	294	}),
	295
a92e844e	296	struct lttng_kernel_probe_ctx {
e2d5dbc7	297	struct lttng_kernel_event_common *event;
79150a49 JD	298	uint8_t interruptible;
	299	};
	300
6c8c025b MD	301	struct lttng_kernel_tracepoint_class {
6c8c025b MD	302	void (*probe_callback)(void);
4f1d1ee5	303	const struct lttng_kernel_event_field * const fields; / event payload */
6c8c025b MD	304	unsigned int nr_fields;
	305	const struct lttng_kernel_probe_desc *probe_desc;
	306	};
	307
437d5aa5 MD	308	struct lttng_kernel_event_desc {
	309	const char event_name; / lttng-modules name */
	310	const char event_kname; / Linux kernel name (tracepoints) */
	311	const struct lttng_kernel_probe_desc *probe_desc;
6c8c025b	312	const struct lttng_kernel_tracepoint_class *tp_class;
dc7f600a	313	struct module *owner;
c0edae1d MD	314	};
c0edae1d MD	315
437d5aa5 MD	316	struct lttng_kernel_probe_desc {
437d5aa5 MD	317	const char *provider_name;
4f1d1ee5	318	const struct lttng_kernel_event_desc * const *event_desc;
85a9ca7f MD	319	unsigned int nr_events;
85a9ca7f MD	320	struct list_head head; /* chain registered probes */
3c997079 MD	321	struct list_head lazy_init_head;
3c997079 MD	322	int lazy; /* lazy registration */
85a9ca7f MD	323	};
85a9ca7f MD	324
8a445457 MD	325	/*
	326	* Result of the run_filter() callback.
	327	*/
	328	enum lttng_kernel_event_filter_result {
	329	LTTNG_KERNEL_EVENT_FILTER_ACCEPT = 0,
	330	LTTNG_KERNEL_EVENT_FILTER_REJECT = 1,
	331	};
	332
a67ba386 MD	333	struct lttng_kernel_event_common_private;
	334
	335	enum lttng_kernel_event_type {
	336	LTTNG_KERNEL_EVENT_TYPE_RECORDER = 0,
	337	LTTNG_KERNEL_EVENT_TYPE_NOTIFIER = 1,
	338	};
	339
	340	struct lttng_kernel_event_common {
	341	struct lttng_kernel_event_common_private priv; / Private event interface */
	342
	343	enum lttng_kernel_event_type type;
	344	/* Get child with container_of(). */
	345
e64957da	346	int enabled;
a67ba386	347	int eval_filter; /* Need to evaluate filters */
8a445457	348	int (run_filter)(const struct lttng_kernel_event_common event,
a67ba386	349	const char *stack_data,
a92e844e	350	struct lttng_kernel_probe_ctx *probe_ctx,
a67ba386	351	void *filter_ctx);
3c997079 MD	352	};
3c997079 MD	353
a67ba386 MD	354	struct lttng_kernel_event_recorder_private;
	355
	356	struct lttng_kernel_event_recorder {
	357	struct lttng_kernel_event_common parent;
	358	struct lttng_kernel_event_recorder_private priv; / Private event record interface */
	359
f7d06400	360	struct lttng_kernel_channel_buffer *chan;
c3eddb2e MD	361	};
c3eddb2e MD	362
a67ba386 MD	363	struct lttng_kernel_notification_ctx {
	364	int eval_capture; /* Capture evaluation available. */
	365	};
dffef45d	366
a67ba386	367	struct lttng_kernel_event_notifier_private;
8a8ac9a8	368
a67ba386 MD	369	struct lttng_kernel_event_notifier {
	370	struct lttng_kernel_event_common parent;
	371	struct lttng_kernel_event_notifier_private priv; / Private event notifier interface */
dffef45d	372
a67ba386 MD	373	int eval_capture; /* Need to evaluate capture */
a67ba386 MD	374	void (notification_send)(struct lttng_kernel_event_notifier event_notifier,
a67ba386	375	const char *stack_data,
a92e844e	376	struct lttng_kernel_probe_ctx *probe_ctx,
a67ba386	377	struct lttng_kernel_notification_ctx *notif_ctx);
dffef45d FD	378	};
dffef45d FD	379
4a399b76 MD	380	struct lttng_kernel_channel_buffer_ops {
	381	struct lttng_kernel_channel_buffer_ops_private priv; / Private channel buffer ops interface. */
	382
8a57ec02 MD	383	int (event_reserve)(struct lttng_kernel_ring_buffer_ctx ctx);
	384	void (event_commit)(struct lttng_kernel_ring_buffer_ctx ctx);
	385	void (event_write)(struct lttng_kernel_ring_buffer_ctx ctx, const void *src,
f5ffbd77	386	size_t len, size_t alignment);
8a57ec02	387	void (event_write_from_user)(struct lttng_kernel_ring_buffer_ctx ctx,
f5ffbd77	388	const void *src, size_t len, size_t alignment);
8a57ec02	389	void (event_memset)(struct lttng_kernel_ring_buffer_ctx ctx,
58aa5d24	390	int c, size_t len);
8a57ec02	391	void (event_strcpy)(struct lttng_kernel_ring_buffer_ctx ctx, const char *src,
16f78f3a	392	size_t len);
8a57ec02	393	void (event_strcpy_from_user)(struct lttng_kernel_ring_buffer_ctx ctx,
16f78f3a	394	const char __user *src, size_t len);
f7d06400 MD	395	void (lost_event_too_big)(struct lttng_kernel_channel_buffer lttng_channel);
	396	};
	397
	398	enum lttng_kernel_channel_type {
	399	LTTNG_KERNEL_CHANNEL_TYPE_BUFFER = 0,
85a9ca7f MD	400	};
85a9ca7f MD	401
f7d06400 MD	402	struct lttng_kernel_channel_common_private;
	403
	404	/* Use container_of() to get child. */
	405	struct lttng_kernel_channel_common {
	406	struct lttng_kernel_channel_common_private priv; / Private channel interface. */
	407
	408	enum lttng_kernel_channel_type type;
	409
e64957da	410	int enabled;
8cdc1a81	411	struct lttng_kernel_session *session;
f7d06400 MD	412	};
	413
	414	struct lttng_kernel_channel_buffer_private;
	415
	416	struct lttng_kernel_channel_buffer {
	417	struct lttng_kernel_channel_common parent;
	418	struct lttng_kernel_channel_buffer_private *priv;
	419
4a399b76	420	struct lttng_kernel_channel_buffer_ops *ops;
85a9ca7f MD	421	};
85a9ca7f MD	422
114667d5 MD	423	#define LTTNG_DYNAMIC_LEN_STACK_SIZE 128
	424
	425	struct lttng_dynamic_len_stack {
	426	size_t stack[LTTNG_DYNAMIC_LEN_STACK_SIZE];
	427	size_t offset;
	428	};
	429
	430	DECLARE_PER_CPU(struct lttng_dynamic_len_stack, lttng_dynamic_len_stack);
e0130fab MD	431
e0130fab MD	432	/*
8c0393c3	433	* struct lttng_kernel_id_tracker declared in header due to deferencing of *v
e0130fab MD	434	* in RCU_INITIALIZER(v).
e0130fab MD	435	*/
d1f652f8 MD	436	#define LTTNG_ID_HASH_BITS 6
d1f652f8 MD	437	#define LTTNG_ID_TABLE_SIZE (1 << LTTNG_ID_HASH_BITS)
e0130fab	438
8c0393c3	439	struct lttng_kernel_id_tracker_rcu {
d1f652f8 MD	440	struct hlist_head id_hash[LTTNG_ID_TABLE_SIZE];
	441	};
	442
8c0393c3 MD	443	struct lttng_kernel_id_tracker {
	444	struct lttng_kernel_id_tracker_private priv; / Private API */
	445
	446	struct lttng_kernel_id_tracker_rcu p; / RCU dereferenced. */
e0130fab MD	447	};
e0130fab MD	448
8cdc1a81 MD	449	struct lttng_kernel_session_private;
	450
	451	struct lttng_kernel_session {
	452	struct lttng_kernel_session_private priv; / Private session interface */
	453
85a9ca7f	454	int active; /* Is trace session active ? */
8cdc1a81	455
8c0393c3 MD	456	struct lttng_kernel_id_tracker pid_tracker;
	457	struct lttng_kernel_id_tracker vpid_tracker;
	458	struct lttng_kernel_id_tracker uid_tracker;
	459	struct lttng_kernel_id_tracker vuid_tracker;
	460	struct lttng_kernel_id_tracker gid_tracker;
	461	struct lttng_kernel_id_tracker vgid_tracker;
85a9ca7f MD	462	};
85a9ca7f MD	463
d1769981 MD	464	int lttng_kernel_probe_register(struct lttng_kernel_probe_desc *desc);
d1769981 MD	465	void lttng_kernel_probe_unregister(struct lttng_kernel_probe_desc *desc);
d83004aa	466
8c0393c3	467	bool lttng_id_tracker_lookup(struct lttng_kernel_id_tracker_rcu *p, int id);
271b6681	468
a90917c3	469	#endif /* _LTTNG_EVENTS_H */