[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_channel;
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,
};

enum channel_type {
	PER_CPU_CHANNEL,
	METADATA_CHANNEL,
};

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 **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 **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 **entries;
	unsigned int nr_entries;
};

/* 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_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;
	void (*probe_callback)(void);
	const struct lttng_kernel_event_field **fields;	/* event payload */
	unsigned int nr_fields;
	struct module *owner;
};

struct lttng_kernel_probe_desc {
	const char *provider_name;
	const struct lttng_kernel_event_desc **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_channel *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);
	void (*event_write_from_user)(struct lttng_kernel_ring_buffer_ctx *ctx,
				      const void *src, size_t len);
	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);
};

struct lttng_channel {
	unsigned int id;
	struct channel *chan;		/* Channel buffers */
	int enabled;
	struct lttng_kernel_ctx *ctx;
	/* Event ID management */
	struct lttng_kernel_session *session;
	struct file *file;		/* File associated to channel */
	unsigned int free_event_id;	/* Next event ID to allocate */
	struct list_head list;		/* Channel list */
	struct lttng_kernel_channel_buffer_ops *ops;
	struct lttng_transport *transport;
	struct hlist_head *sc_table;	/* for syscall tracing */
	struct hlist_head *compat_sc_table;
	struct hlist_head *sc_exit_table;	/* for syscall exit tracing */
	struct hlist_head *compat_sc_exit_table;
	struct hlist_head sc_unknown;	/* for unknown syscalls */
	struct hlist_head sc_compat_unknown;
	struct hlist_head sc_exit_unknown;
	struct hlist_head compat_sc_exit_unknown;
	struct lttng_syscall_filter *sc_filter;
	int header_type;		/* 0: unset, 1: compact, 2: large */
	enum channel_type channel_type;
	int syscall_all_entry;
	int syscall_all_exit;
	unsigned int metadata_dumped:1,
		sys_enter_registered:1,
		sys_exit_registered:1,
		tstate:1;		/* Transient enable state */
};

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