[lttng-ust.git] / include / lttng / ust-abi.h

// SPDX-FileCopyrightText: 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
//
// SPDX-License-Identifier: MIT

/*
 * LTTng-UST ABI header
 */

#ifndef _LTTNG_UST_ABI_H
#define _LTTNG_UST_ABI_H

#include <stdint.h>
#include <lttng/ust-compiler.h>

#define LTTNG_UST_ABI_SYM_NAME_LEN			256
#define LTTNG_UST_ABI_PROCNAME_LEN		16

/* UST comm magic number, used to validate protocol and endianness. */
#define LTTNG_UST_ABI_COMM_MAGIC			0xC57C57C5

/* Version for ABI between liblttng-ust, sessiond, consumerd */
#define LTTNG_UST_ABI_MAJOR_VERSION			10
#define LTTNG_UST_ABI_MAJOR_VERSION_OLDEST_COMPATIBLE	8
#define LTTNG_UST_ABI_MINOR_VERSION		0

enum lttng_ust_abi_instrumentation {
	LTTNG_UST_ABI_TRACEPOINT	= 0,
	LTTNG_UST_ABI_PROBE		= 1,
	LTTNG_UST_ABI_FUNCTION		= 2,
};

enum lttng_ust_abi_loglevel_type {
	LTTNG_UST_ABI_LOGLEVEL_ALL	= 0,
	LTTNG_UST_ABI_LOGLEVEL_RANGE	= 1,
	LTTNG_UST_ABI_LOGLEVEL_SINGLE	= 2,
};

enum lttng_ust_abi_output {
	LTTNG_UST_ABI_MMAP		= 0,
};

enum lttng_ust_abi_chan_type {
	LTTNG_UST_ABI_CHAN_PER_CPU = 0,
	LTTNG_UST_ABI_CHAN_METADATA = 1,
};

struct lttng_ust_abi_tracer_version {
	uint32_t major;
	uint32_t minor;
	uint32_t patchlevel;
} __attribute__((packed));

#define LTTNG_UST_ABI_CHANNEL_PADDING	(LTTNG_UST_ABI_SYM_NAME_LEN + 32)
/*
 * Given that the consumerd is limited to 64k file descriptors, we
 * cannot expect much more than 1MB channel structure size. This size is
 * depends on the number of streams within a channel, which depends on
 * the number of possible CPUs on the system.
 */
#define LTTNG_UST_ABI_CHANNEL_DATA_MAX_LEN	1048576U
struct lttng_ust_abi_channel {
	uint64_t len;
	int32_t type;	/* enum lttng_ust_abi_chan_type */
	char padding[LTTNG_UST_ABI_CHANNEL_PADDING];
	char data[];	/* variable sized data */
} __attribute__((packed));

#define LTTNG_UST_ABI_STREAM_PADDING1	(LTTNG_UST_ABI_SYM_NAME_LEN + 32)
struct lttng_ust_abi_stream {
	uint64_t len;		/* shm len */
	uint32_t stream_nr;	/* stream number */
	char padding[LTTNG_UST_ABI_STREAM_PADDING1];
	/*
	 * shm_fd and wakeup_fd are send over unix socket as file
	 * descriptors after this structure.
	 */
} __attribute__((packed));

#define LTTNG_UST_ABI_COUNTER_DIMENSION_MAX 4

enum lttng_ust_abi_counter_arithmetic {
	LTTNG_UST_ABI_COUNTER_ARITHMETIC_MODULAR = 0,
	LTTNG_UST_ABI_COUNTER_ARITHMETIC_SATURATION = 1,
};

enum lttng_ust_abi_counter_bitness {
	LTTNG_UST_ABI_COUNTER_BITNESS_32 = 0,
	LTTNG_UST_ABI_COUNTER_BITNESS_64 = 1,
};

struct lttng_ust_abi_counter_dimension {
	uint64_t size;
	uint64_t underflow_index;
	uint64_t overflow_index;
	uint8_t has_underflow;
	uint8_t has_overflow;
} __attribute__((packed));

#define LTTNG_UST_ABI_COUNTER_CONF_PADDING1 67
struct lttng_ust_abi_counter_conf {
	uint32_t arithmetic;	/* enum lttng_ust_abi_counter_arithmetic */
	uint32_t bitness;	/* enum lttng_ust_abi_counter_bitness */
	uint32_t number_dimensions;
	int64_t global_sum_step;
	struct lttng_ust_abi_counter_dimension dimensions[LTTNG_UST_ABI_COUNTER_DIMENSION_MAX];
	uint8_t coalesce_hits;
	char padding[LTTNG_UST_ABI_COUNTER_CONF_PADDING1];
} __attribute__((packed));

struct lttng_ust_abi_counter_value {
	uint32_t number_dimensions;
	uint64_t dimension_indexes[LTTNG_UST_ABI_COUNTER_DIMENSION_MAX];
	int64_t value;
} __attribute__((packed));

#define LTTNG_UST_ABI_EVENT_PADDING1	8
#define LTTNG_UST_ABI_EVENT_PADDING2	(LTTNG_UST_ABI_SYM_NAME_LEN + 32)
struct lttng_ust_abi_event {
	int32_t instrumentation; 		/* enum lttng_ust_abi_instrumentation */
	char name[LTTNG_UST_ABI_SYM_NAME_LEN];	/* event name */

	int32_t loglevel_type;			/* enum lttng_ust_abi_loglevel_type */
	int32_t loglevel;			/* value, -1: all */
	uint64_t token;				/* User-provided token */
	char padding[LTTNG_UST_ABI_EVENT_PADDING1];

	/* Per instrumentation type configuration */
	union {
		char padding[LTTNG_UST_ABI_EVENT_PADDING2];
	} u;
} __attribute__((packed));

#define LTTNG_UST_ABI_EVENT_NOTIFIER_PADDING	32
struct lttng_ust_abi_event_notifier {
	struct lttng_ust_abi_event event;
	uint64_t error_counter_index;
	char padding[LTTNG_UST_ABI_EVENT_NOTIFIER_PADDING];
} __attribute__((packed));

#define LTTNG_UST_ABI_EVENT_NOTIFIER_NOTIFICATION_PADDING 32
struct lttng_ust_abi_event_notifier_notification {
	uint64_t token;
	uint16_t capture_buf_size;
	char padding[LTTNG_UST_ABI_EVENT_NOTIFIER_NOTIFICATION_PADDING];
} __attribute__((packed));

#define LTTNG_UST_ABI_COUNTER_PADDING1		(LTTNG_UST_ABI_SYM_NAME_LEN + 32)
#define LTTNG_UST_ABI_COUNTER_DATA_MAX_LEN	4096U
struct lttng_ust_abi_counter {
	uint64_t len;
	char padding[LTTNG_UST_ABI_COUNTER_PADDING1];
	char data[];	/* variable sized data */
} __attribute__((packed));

#define LTTNG_UST_ABI_COUNTER_GLOBAL_PADDING1	(LTTNG_UST_ABI_SYM_NAME_LEN + 32)
struct lttng_ust_abi_counter_global {
	uint64_t len;		/* shm len */
	char padding[LTTNG_UST_ABI_COUNTER_GLOBAL_PADDING1];
} __attribute__((packed));

#define LTTNG_UST_ABI_COUNTER_CPU_PADDING1	(LTTNG_UST_ABI_SYM_NAME_LEN + 32)
struct lttng_ust_abi_counter_cpu {
	uint64_t len;		/* shm len */
	uint32_t cpu_nr;
	char padding[LTTNG_UST_ABI_COUNTER_CPU_PADDING1];
} __attribute__((packed));

enum lttng_ust_abi_field_type {
	LTTNG_UST_ABI_FIELD_OTHER			= 0,
	LTTNG_UST_ABI_FIELD_INTEGER			= 1,
	LTTNG_UST_ABI_FIELD_ENUM			= 2,
	LTTNG_UST_ABI_FIELD_FLOAT			= 3,
	LTTNG_UST_ABI_FIELD_STRING			= 4,
};

#define LTTNG_UST_ABI_FIELD_ITER_PADDING	(LTTNG_UST_ABI_SYM_NAME_LEN + 28)
struct lttng_ust_abi_field_iter {
	char event_name[LTTNG_UST_ABI_SYM_NAME_LEN];
	char field_name[LTTNG_UST_ABI_SYM_NAME_LEN];
	int32_t type;				/* enum lttng_ust_abi_field_type */
	int loglevel;				/* event loglevel */
	int nowrite;
	char padding[LTTNG_UST_ABI_FIELD_ITER_PADDING];
} __attribute__((packed));

enum lttng_ust_abi_context_type {
	LTTNG_UST_ABI_CONTEXT_VTID			= 0,
	LTTNG_UST_ABI_CONTEXT_VPID			= 1,
	LTTNG_UST_ABI_CONTEXT_PTHREAD_ID		= 2,
	LTTNG_UST_ABI_CONTEXT_PROCNAME			= 3,
	LTTNG_UST_ABI_CONTEXT_IP			= 4,
	LTTNG_UST_ABI_CONTEXT_PERF_THREAD_COUNTER	= 5,
	LTTNG_UST_ABI_CONTEXT_CPU_ID			= 6,
	LTTNG_UST_ABI_CONTEXT_APP_CONTEXT		= 7,
	LTTNG_UST_ABI_CONTEXT_CGROUP_NS			= 8,
	LTTNG_UST_ABI_CONTEXT_IPC_NS			= 9,
	LTTNG_UST_ABI_CONTEXT_MNT_NS			= 10,
	LTTNG_UST_ABI_CONTEXT_NET_NS			= 11,
	LTTNG_UST_ABI_CONTEXT_PID_NS			= 12,
	LTTNG_UST_ABI_CONTEXT_USER_NS			= 13,
	LTTNG_UST_ABI_CONTEXT_UTS_NS			= 14,
	LTTNG_UST_ABI_CONTEXT_VUID			= 15,
	LTTNG_UST_ABI_CONTEXT_VEUID			= 16,
	LTTNG_UST_ABI_CONTEXT_VSUID			= 17,
	LTTNG_UST_ABI_CONTEXT_VGID			= 18,
	LTTNG_UST_ABI_CONTEXT_VEGID			= 19,
	LTTNG_UST_ABI_CONTEXT_VSGID			= 20,
	LTTNG_UST_ABI_CONTEXT_TIME_NS			= 21,
};

struct lttng_ust_abi_perf_counter_ctx {
	uint32_t type;
	uint64_t config;
	char name[LTTNG_UST_ABI_SYM_NAME_LEN];
} __attribute__((packed));

#define LTTNG_UST_ABI_CONTEXT_PADDING1	16
#define LTTNG_UST_ABI_CONTEXT_PADDING2	(LTTNG_UST_ABI_SYM_NAME_LEN + 32)
struct lttng_ust_abi_context {
	int32_t ctx;	 /* enum lttng_ust_abi_context_type */
	char padding[LTTNG_UST_ABI_CONTEXT_PADDING1];

	union {
		struct lttng_ust_abi_perf_counter_ctx perf_counter;
		struct {
			/* Includes trailing '\0'. */
			uint32_t provider_name_len;
			uint32_t ctx_name_len;
		} app_ctx;
		char padding[LTTNG_UST_ABI_CONTEXT_PADDING2];
	} u;
} __attribute__((packed));

/*
 * Tracer channel attributes.
 */
#define LTTNG_UST_ABI_CHANNEL_ATTR_PADDING	(LTTNG_UST_ABI_SYM_NAME_LEN + 32)
struct lttng_ust_abi_channel_attr {
	uint64_t subbuf_size;			/* bytes */
	uint64_t num_subbuf;			/* power of 2 */
	int overwrite;				/* 1: overwrite, 0: discard */
	unsigned int switch_timer_interval;	/* usec */
	unsigned int read_timer_interval;	/* usec */
	int32_t output;				/* enum lttng_ust_abi_output */
	union {
		struct {
			int64_t blocking_timeout;	/* Blocking timeout (usec) */
		} s;
		char padding[LTTNG_UST_ABI_CHANNEL_ATTR_PADDING];
	} u;
} __attribute__((packed));

#define LTTNG_UST_ABI_TRACEPOINT_ITER_PADDING	16
struct lttng_ust_abi_tracepoint_iter {
	char name[LTTNG_UST_ABI_SYM_NAME_LEN];	/* provider:name */
	int loglevel;
	char padding[LTTNG_UST_ABI_TRACEPOINT_ITER_PADDING];
} __attribute__((packed));

enum lttng_ust_abi_object_type {
	LTTNG_UST_ABI_OBJECT_TYPE_UNKNOWN = -1,
	LTTNG_UST_ABI_OBJECT_TYPE_CHANNEL = 0,
	LTTNG_UST_ABI_OBJECT_TYPE_STREAM = 1,
	LTTNG_UST_ABI_OBJECT_TYPE_EVENT = 2,
	LTTNG_UST_ABI_OBJECT_TYPE_CONTEXT = 3,
	LTTNG_UST_ABI_OBJECT_TYPE_EVENT_NOTIFIER_GROUP = 4,
	LTTNG_UST_ABI_OBJECT_TYPE_EVENT_NOTIFIER = 5,
	LTTNG_UST_ABI_OBJECT_TYPE_COUNTER = 6,
	LTTNG_UST_ABI_OBJECT_TYPE_COUNTER_GLOBAL = 7,
	LTTNG_UST_ABI_OBJECT_TYPE_COUNTER_CPU = 8,
};

#define LTTNG_UST_ABI_OBJECT_DATA_PADDING1	32
#define LTTNG_UST_ABI_OBJECT_DATA_PADDING2	(LTTNG_UST_ABI_SYM_NAME_LEN + 32)

struct lttng_ust_abi_object_data {
	int32_t type;	/* enum lttng_ust_abi_object_type */
	int handle;
	uint64_t size;
	char padding1[LTTNG_UST_ABI_OBJECT_DATA_PADDING1];
	union {
		struct {
			void *data;
			int32_t type;	/* enum lttng_ust_abi_chan_type */
			int wakeup_fd;
		} channel;
		struct {
			int shm_fd;
			int wakeup_fd;
			uint32_t stream_nr;
		} stream;
		struct {
			void *data;
		} counter;
		struct {
			int shm_fd;
		} counter_global;
		struct {
			int shm_fd;
			uint32_t cpu_nr;
		} counter_cpu;
		char padding2[LTTNG_UST_ABI_OBJECT_DATA_PADDING2];
	} u;
} __attribute__((packed));

enum lttng_ust_abi_calibrate_type {
	LTTNG_UST_ABI_CALIBRATE_TRACEPOINT,
};

#define LTTNG_UST_ABI_CALIBRATE_PADDING1	16
#define LTTNG_UST_ABI_CALIBRATE_PADDING2	(LTTNG_UST_ABI_SYM_NAME_LEN + 32)
struct lttng_ust_abi_calibrate {
	enum lttng_ust_abi_calibrate_type type;		/* type (input) */
	char padding[LTTNG_UST_ABI_CALIBRATE_PADDING1];

	union {
		char padding[LTTNG_UST_ABI_CALIBRATE_PADDING2];
	} u;
} __attribute__((packed));

#define LTTNG_UST_ABI_FILTER_BYTECODE_MAX_LEN	65536
#define LTTNG_UST_ABI_FILTER_PADDING		32
struct lttng_ust_abi_filter_bytecode {
	uint32_t len;
	uint32_t reloc_offset;
	uint64_t seqnum;
	char padding[LTTNG_UST_ABI_FILTER_PADDING];
	char data[0];
} __attribute__((packed));

#define LTTNG_UST_ABI_CAPTURE_BYTECODE_MAX_LEN	65536
#define LTTNG_UST_ABI_CAPTURE_PADDING		32
struct lttng_ust_abi_capture_bytecode {
	uint32_t len;
	uint32_t reloc_offset;
	uint64_t seqnum;
	char padding[LTTNG_UST_ABI_CAPTURE_PADDING];
	char data[0];
} __attribute__((packed));

#define LTTNG_UST_ABI_EXCLUSION_PADDING	32
struct lttng_ust_abi_event_exclusion {
	uint32_t count;
	char padding[LTTNG_UST_ABI_EXCLUSION_PADDING];
	char names[LTTNG_UST_ABI_SYM_NAME_LEN][0];
} __attribute__((packed));

#define LTTNG_UST_ABI_CMD(minor)		(minor)
#define LTTNG_UST_ABI_CMDR(minor, type)		(minor)
#define LTTNG_UST_ABI_CMDW(minor, type)		(minor)

/* Handled by object descriptor */
#define LTTNG_UST_ABI_RELEASE			LTTNG_UST_ABI_CMD(0x1)

/* Handled by object cmd */

/* LTTng-UST commands */
#define LTTNG_UST_ABI_SESSION			LTTNG_UST_ABI_CMD(0x40)
#define LTTNG_UST_ABI_TRACER_VERSION		\
	LTTNG_UST_ABI_CMDR(0x41, struct lttng_ust_abi_tracer_version)
#define LTTNG_UST_ABI_TRACEPOINT_LIST		LTTNG_UST_ABI_CMD(0x42)
#define LTTNG_UST_ABI_WAIT_QUIESCENT		LTTNG_UST_ABI_CMD(0x43)
#define LTTNG_UST_ABI_REGISTER_DONE		LTTNG_UST_ABI_CMD(0x44)
#define LTTNG_UST_ABI_TRACEPOINT_FIELD_LIST	LTTNG_UST_ABI_CMD(0x45)
#define LTTNG_UST_ABI_EVENT_NOTIFIER_GROUP_CREATE \
	LTTNG_UST_ABI_CMD(0x46)

/* Session commands */
#define LTTNG_UST_ABI_CHANNEL			\
	LTTNG_UST_ABI_CMDW(0x51, struct lttng_ust_abi_channel)
#define LTTNG_UST_ABI_SESSION_START		LTTNG_UST_ABI_CMD(0x52)
#define LTTNG_UST_ABI_SESSION_STOP		LTTNG_UST_ABI_CMD(0x53)
#define LTTNG_UST_ABI_SESSION_STATEDUMP		LTTNG_UST_ABI_CMD(0x54)

/* Channel commands */
#define LTTNG_UST_ABI_STREAM			LTTNG_UST_ABI_CMD(0x60)
#define LTTNG_UST_ABI_EVENT			\
	LTTNG_UST_ABI_CMDW(0x61, struct lttng_ust_abi_event)

/* Event and channel commands */
#define LTTNG_UST_ABI_CONTEXT			\
	LTTNG_UST_ABI_CMDW(0x70, struct lttng_ust_abi_context)
#define LTTNG_UST_ABI_FLUSH_BUFFER		\
	LTTNG_UST_ABI_CMD(0x71)

/* Event, event notifier, channel and session commands */
#define LTTNG_UST_ABI_ENABLE			LTTNG_UST_ABI_CMD(0x80)
#define LTTNG_UST_ABI_DISABLE			LTTNG_UST_ABI_CMD(0x81)

/* Tracepoint list commands */
#define LTTNG_UST_ABI_TRACEPOINT_LIST_GET	LTTNG_UST_ABI_CMD(0x90)
#define LTTNG_UST_ABI_TRACEPOINT_FIELD_LIST_GET	LTTNG_UST_ABI_CMD(0x91)

/* Event and event notifier commands */
#define LTTNG_UST_ABI_FILTER			LTTNG_UST_ABI_CMD(0xA0)
#define LTTNG_UST_ABI_EXCLUSION			LTTNG_UST_ABI_CMD(0xA1)

/* Event notifier group commands */
#define LTTNG_UST_ABI_EVENT_NOTIFIER_CREATE	\
	LTTNG_UST_ABI_CMDW(0xB0, struct lttng_ust_abi_event_notifier)

/* Event notifier commands */
#define LTTNG_UST_ABI_CAPTURE			LTTNG_UST_ABI_CMD(0xB6)

/* Session and event notifier group commands */
#define LTTNG_UST_ABI_COUNTER			\
	LTTNG_UST_ABI_CMDW(0xC0, struct lttng_ust_abi_counter)

/* Counter commands */
#define LTTNG_UST_ABI_COUNTER_GLOBAL		\
	LTTNG_UST_ABI_CMDW(0xD0, struct lttng_ust_abi_counter_global)
#define LTTNG_UST_ABI_COUNTER_CPU		\
	LTTNG_UST_ABI_CMDW(0xD1, struct lttng_ust_abi_counter_cpu)

#define LTTNG_UST_ABI_ROOT_HANDLE	0

#endif /* _LTTNG_UST_ABI_H */
Commit	Line	Data
1c196845 MJ	1	// SPDX-FileCopyrightText: 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	2	//
	3	// SPDX-License-Identifier: MIT
	4
9f3fdbc6	5	/*
c0c0989a	6	* LTTng-UST ABI header
9f3fdbc6 MD	7	*/
9f3fdbc6 MD	8
c0c0989a MJ	9	#ifndef _LTTNG_UST_ABI_H
	10	#define _LTTNG_UST_ABI_H
	11
0a42beb6	12	#include <stdint.h>
b3f60bbf	13	#include <lttng/ust-compiler.h>
0a42beb6	14
fd17d7ce	15	#define LTTNG_UST_ABI_SYM_NAME_LEN 256
32ce8569 MD	16	#define LTTNG_UST_ABI_PROCNAME_LEN 16
	17
	18	/* UST comm magic number, used to validate protocol and endianness. */
fd17d7ce	19	#define LTTNG_UST_ABI_COMM_MAGIC 0xC57C57C5
b35d179d	20
0f4eaec3	21	/* Version for ABI between liblttng-ust, sessiond, consumerd */
f63969cc	22	#define LTTNG_UST_ABI_MAJOR_VERSION 10
6a359b8a MD	23	#define LTTNG_UST_ABI_MAJOR_VERSION_OLDEST_COMPATIBLE 8
6a359b8a MD	24	#define LTTNG_UST_ABI_MINOR_VERSION 0
0f4eaec3	25
fd17d7ce MD	26	enum lttng_ust_abi_instrumentation {
	27	LTTNG_UST_ABI_TRACEPOINT = 0,
	28	LTTNG_UST_ABI_PROBE = 1,
	29	LTTNG_UST_ABI_FUNCTION = 2,
6b0e60f1 MD	30	};
6b0e60f1 MD	31
fd17d7ce MD	32	enum lttng_ust_abi_loglevel_type {
	33	LTTNG_UST_ABI_LOGLEVEL_ALL = 0,
	34	LTTNG_UST_ABI_LOGLEVEL_RANGE = 1,
	35	LTTNG_UST_ABI_LOGLEVEL_SINGLE = 2,
9f3fdbc6 MD	36	};
9f3fdbc6 MD	37
fd17d7ce MD	38	enum lttng_ust_abi_output {
fd17d7ce MD	39	LTTNG_UST_ABI_MMAP = 0,
9f3fdbc6 MD	40	};
9f3fdbc6 MD	41
fd17d7ce MD	42	enum lttng_ust_abi_chan_type {
	43	LTTNG_UST_ABI_CHAN_PER_CPU = 0,
	44	LTTNG_UST_ABI_CHAN_METADATA = 1,
74d81a6c MD	45	};
74d81a6c MD	46
fd17d7ce	47	struct lttng_ust_abi_tracer_version {
b728d87e MD	48	uint32_t major;
b728d87e MD	49	uint32_t minor;
b35d179d	50	uint32_t patchlevel;
9f5ade14	51	} __attribute__((packed));
9f3fdbc6	52
fd17d7ce	53	#define LTTNG_UST_ABI_CHANNEL_PADDING (LTTNG_UST_ABI_SYM_NAME_LEN + 32)
74d81a6c MD	54	/*
	55	* Given that the consumerd is limited to 64k file descriptors, we
	56	* cannot expect much more than 1MB channel structure size. This size is
	57	* depends on the number of streams within a channel, which depends on
	58	* the number of possible CPUs on the system.
	59	*/
fd17d7ce MD	60	#define LTTNG_UST_ABI_CHANNEL_DATA_MAX_LEN 1048576U
fd17d7ce MD	61	struct lttng_ust_abi_channel {
74d81a6c	62	uint64_t len;
fd17d7ce MD	63	int32_t type; /* enum lttng_ust_abi_chan_type */
fd17d7ce MD	64	char padding[LTTNG_UST_ABI_CHANNEL_PADDING];
74d81a6c	65	char data[]; /* variable sized data */
9f5ade14	66	} __attribute__((packed));
9f3fdbc6	67
fd17d7ce MD	68	#define LTTNG_UST_ABI_STREAM_PADDING1 (LTTNG_UST_ABI_SYM_NAME_LEN + 32)
fd17d7ce MD	69	struct lttng_ust_abi_stream {
74d81a6c MD	70	uint64_t len; /* shm len */
74d81a6c MD	71	uint32_t stream_nr; /* stream number */
fd17d7ce	72	char padding[LTTNG_UST_ABI_STREAM_PADDING1];
74d81a6c MD	73	/*
	74	* shm_fd and wakeup_fd are send over unix socket as file
	75	* descriptors after this structure.
	76	*/
9f5ade14	77	} __attribute__((packed));
381c0f1e	78
fd17d7ce	79	#define LTTNG_UST_ABI_COUNTER_DIMENSION_MAX 4
ebabbf58	80
fd17d7ce MD	81	enum lttng_ust_abi_counter_arithmetic {
	82	LTTNG_UST_ABI_COUNTER_ARITHMETIC_MODULAR = 0,
	83	LTTNG_UST_ABI_COUNTER_ARITHMETIC_SATURATION = 1,
ebabbf58 MD	84	};
ebabbf58 MD	85
fd17d7ce MD	86	enum lttng_ust_abi_counter_bitness {
	87	LTTNG_UST_ABI_COUNTER_BITNESS_32 = 0,
	88	LTTNG_UST_ABI_COUNTER_BITNESS_64 = 1,
ebabbf58 MD	89	};
ebabbf58 MD	90
fd17d7ce	91	struct lttng_ust_abi_counter_dimension {
ebabbf58 MD	92	uint64_t size;
	93	uint64_t underflow_index;
	94	uint64_t overflow_index;
	95	uint8_t has_underflow;
	96	uint8_t has_overflow;
9f5ade14	97	} __attribute__((packed));
ebabbf58	98
fd17d7ce MD	99	#define LTTNG_UST_ABI_COUNTER_CONF_PADDING1 67
fd17d7ce MD	100	struct lttng_ust_abi_counter_conf {
459cbee4 MD	101	uint32_t arithmetic; /* enum lttng_ust_abi_counter_arithmetic */
459cbee4 MD	102	uint32_t bitness; /* enum lttng_ust_abi_counter_bitness */
ebabbf58 MD	103	uint32_t number_dimensions;
ebabbf58 MD	104	int64_t global_sum_step;
fd17d7ce	105	struct lttng_ust_abi_counter_dimension dimensions[LTTNG_UST_ABI_COUNTER_DIMENSION_MAX];
81bc4972	106	uint8_t coalesce_hits;
fd17d7ce	107	char padding[LTTNG_UST_ABI_COUNTER_CONF_PADDING1];
9f5ade14	108	} __attribute__((packed));
ebabbf58	109
fd17d7ce	110	struct lttng_ust_abi_counter_value {
ebabbf58	111	uint32_t number_dimensions;
fd17d7ce	112	uint64_t dimension_indexes[LTTNG_UST_ABI_COUNTER_DIMENSION_MAX];
ebabbf58	113	int64_t value;
9f5ade14	114	} __attribute__((packed));
ebabbf58	115
fd17d7ce MD	116	#define LTTNG_UST_ABI_EVENT_PADDING1 8
	117	#define LTTNG_UST_ABI_EVENT_PADDING2 (LTTNG_UST_ABI_SYM_NAME_LEN + 32)
	118	struct lttng_ust_abi_event {
	119	int32_t instrumentation; /* enum lttng_ust_abi_instrumentation */
	120	char name[LTTNG_UST_ABI_SYM_NAME_LEN]; /* event name */
6b0e60f1	121
fd17d7ce MD	122	int32_t loglevel_type; /* enum lttng_ust_abi_loglevel_type */
fd17d7ce MD	123	int32_t loglevel; /* value, -1: all */
8968a99f	124	uint64_t token; /* User-provided token */
fd17d7ce	125	char padding[LTTNG_UST_ABI_EVENT_PADDING1];
6b0e60f1	126
9f3fdbc6 MD	127	/* Per instrumentation type configuration */
9f3fdbc6 MD	128	union {
fd17d7ce	129	char padding[LTTNG_UST_ABI_EVENT_PADDING2];
9f3fdbc6	130	} u;
9f5ade14	131	} __attribute__((packed));
9f3fdbc6	132
fd17d7ce MD	133	#define LTTNG_UST_ABI_EVENT_NOTIFIER_PADDING 32
	134	struct lttng_ust_abi_event_notifier {
	135	struct lttng_ust_abi_event event;
ebabbf58	136	uint64_t error_counter_index;
fd17d7ce	137	char padding[LTTNG_UST_ABI_EVENT_NOTIFIER_PADDING];
9f5ade14	138	} __attribute__((packed));
d8d2416d	139
fd17d7ce MD	140	#define LTTNG_UST_ABI_EVENT_NOTIFIER_NOTIFICATION_PADDING 32
fd17d7ce MD	141	struct lttng_ust_abi_event_notifier_notification {
d8d2416d	142	uint64_t token;
d37ecb3f	143	uint16_t capture_buf_size;
fd17d7ce	144	char padding[LTTNG_UST_ABI_EVENT_NOTIFIER_NOTIFICATION_PADDING];
9f5ade14	145	} __attribute__((packed));
d8d2416d	146
fd17d7ce MD	147	#define LTTNG_UST_ABI_COUNTER_PADDING1 (LTTNG_UST_ABI_SYM_NAME_LEN + 32)
	148	#define LTTNG_UST_ABI_COUNTER_DATA_MAX_LEN 4096U
	149	struct lttng_ust_abi_counter {
ebabbf58	150	uint64_t len;
fd17d7ce	151	char padding[LTTNG_UST_ABI_COUNTER_PADDING1];
ebabbf58	152	char data[]; /* variable sized data */
9f5ade14	153	} __attribute__((packed));
ebabbf58	154
fd17d7ce MD	155	#define LTTNG_UST_ABI_COUNTER_GLOBAL_PADDING1 (LTTNG_UST_ABI_SYM_NAME_LEN + 32)
fd17d7ce MD	156	struct lttng_ust_abi_counter_global {
ebabbf58	157	uint64_t len; /* shm len */
fd17d7ce	158	char padding[LTTNG_UST_ABI_COUNTER_GLOBAL_PADDING1];
9f5ade14	159	} __attribute__((packed));
ebabbf58	160
fd17d7ce MD	161	#define LTTNG_UST_ABI_COUNTER_CPU_PADDING1 (LTTNG_UST_ABI_SYM_NAME_LEN + 32)
fd17d7ce MD	162	struct lttng_ust_abi_counter_cpu {
ebabbf58 MD	163	uint64_t len; /* shm len */
ebabbf58 MD	164	uint32_t cpu_nr;
fd17d7ce	165	char padding[LTTNG_UST_ABI_COUNTER_CPU_PADDING1];
9f5ade14	166	} __attribute__((packed));
ebabbf58	167
fd17d7ce MD	168	enum lttng_ust_abi_field_type {
	169	LTTNG_UST_ABI_FIELD_OTHER = 0,
	170	LTTNG_UST_ABI_FIELD_INTEGER = 1,
	171	LTTNG_UST_ABI_FIELD_ENUM = 2,
	172	LTTNG_UST_ABI_FIELD_FLOAT = 3,
	173	LTTNG_UST_ABI_FIELD_STRING = 4,
06d4f27e MD	174	};
06d4f27e MD	175
fd17d7ce MD	176	#define LTTNG_UST_ABI_FIELD_ITER_PADDING (LTTNG_UST_ABI_SYM_NAME_LEN + 28)
	177	struct lttng_ust_abi_field_iter {
	178	char event_name[LTTNG_UST_ABI_SYM_NAME_LEN];
	179	char field_name[LTTNG_UST_ABI_SYM_NAME_LEN];
	180	int32_t type; /* enum lttng_ust_abi_field_type */
06d4f27e	181	int loglevel; /* event loglevel */
180901e6	182	int nowrite;
fd17d7ce	183	char padding[LTTNG_UST_ABI_FIELD_ITER_PADDING];
9f5ade14	184	} __attribute__((packed));
06d4f27e	185
fd17d7ce MD	186	enum lttng_ust_abi_context_type {
	187	LTTNG_UST_ABI_CONTEXT_VTID = 0,
	188	LTTNG_UST_ABI_CONTEXT_VPID = 1,
	189	LTTNG_UST_ABI_CONTEXT_PTHREAD_ID = 2,
	190	LTTNG_UST_ABI_CONTEXT_PROCNAME = 3,
	191	LTTNG_UST_ABI_CONTEXT_IP = 4,
	192	LTTNG_UST_ABI_CONTEXT_PERF_THREAD_COUNTER = 5,
	193	LTTNG_UST_ABI_CONTEXT_CPU_ID = 6,
	194	LTTNG_UST_ABI_CONTEXT_APP_CONTEXT = 7,
	195	LTTNG_UST_ABI_CONTEXT_CGROUP_NS = 8,
	196	LTTNG_UST_ABI_CONTEXT_IPC_NS = 9,
	197	LTTNG_UST_ABI_CONTEXT_MNT_NS = 10,
	198	LTTNG_UST_ABI_CONTEXT_NET_NS = 11,
	199	LTTNG_UST_ABI_CONTEXT_PID_NS = 12,
	200	LTTNG_UST_ABI_CONTEXT_USER_NS = 13,
	201	LTTNG_UST_ABI_CONTEXT_UTS_NS = 14,
	202	LTTNG_UST_ABI_CONTEXT_VUID = 15,
	203	LTTNG_UST_ABI_CONTEXT_VEUID = 16,
	204	LTTNG_UST_ABI_CONTEXT_VSUID = 17,
	205	LTTNG_UST_ABI_CONTEXT_VGID = 18,
	206	LTTNG_UST_ABI_CONTEXT_VEGID = 19,
	207	LTTNG_UST_ABI_CONTEXT_VSGID = 20,
	208	LTTNG_UST_ABI_CONTEXT_TIME_NS = 21,
9f3fdbc6 MD	209	};
9f3fdbc6 MD	210
fd17d7ce	211	struct lttng_ust_abi_perf_counter_ctx {
d58d1454 MD	212	uint32_t type;
d58d1454 MD	213	uint64_t config;
fd17d7ce	214	char name[LTTNG_UST_ABI_SYM_NAME_LEN];
9f5ade14	215	} __attribute__((packed));
d58d1454	216
fd17d7ce MD	217	#define LTTNG_UST_ABI_CONTEXT_PADDING1 16
	218	#define LTTNG_UST_ABI_CONTEXT_PADDING2 (LTTNG_UST_ABI_SYM_NAME_LEN + 32)
	219	struct lttng_ust_abi_context {
	220	int32_t ctx; /* enum lttng_ust_abi_context_type */
	221	char padding[LTTNG_UST_ABI_CONTEXT_PADDING1];
1332bb04	222
9f3fdbc6	223	union {
fd17d7ce	224	struct lttng_ust_abi_perf_counter_ctx perf_counter;
53f0df51 JG	225	struct {
	226	/* Includes trailing '\0'. */
	227	uint32_t provider_name_len;
	228	uint32_t ctx_name_len;
	229	} app_ctx;
fd17d7ce	230	char padding[LTTNG_UST_ABI_CONTEXT_PADDING2];
9f3fdbc6	231	} u;
9f5ade14	232	} __attribute__((packed));
9f3fdbc6	233
92462b01 MD	234	/*
	235	* Tracer channel attributes.
	236	*/
fd17d7ce MD	237	#define LTTNG_UST_ABI_CHANNEL_ATTR_PADDING (LTTNG_UST_ABI_SYM_NAME_LEN + 32)
fd17d7ce MD	238	struct lttng_ust_abi_channel_attr {
92462b01 MD	239	uint64_t subbuf_size; /* bytes */
92462b01 MD	240	uint64_t num_subbuf; /* power of 2 */
b3f60bbf	241	int overwrite; /* 1: overwrite, 0: discard */
92462b01 MD	242	unsigned int switch_timer_interval; /* usec */
92462b01 MD	243	unsigned int read_timer_interval; /* usec */
fd17d7ce	244	int32_t output; /* enum lttng_ust_abi_output */
b2c5f61a MD	245	union {
	246	struct {
	247	int64_t blocking_timeout; /* Blocking timeout (usec) */
	248	} s;
fd17d7ce	249	char padding[LTTNG_UST_ABI_CHANNEL_ATTR_PADDING];
b2c5f61a	250	} u;
9f5ade14	251	} __attribute__((packed));
92462b01	252
fd17d7ce MD	253	#define LTTNG_UST_ABI_TRACEPOINT_ITER_PADDING 16
	254	struct lttng_ust_abi_tracepoint_iter {
	255	char name[LTTNG_UST_ABI_SYM_NAME_LEN]; /* provider:name */
882a56d7	256	int loglevel;
fd17d7ce	257	char padding[LTTNG_UST_ABI_TRACEPOINT_ITER_PADDING];
9f5ade14	258	} __attribute__((packed));
cbef6901	259
fd17d7ce MD	260	enum lttng_ust_abi_object_type {
	261	LTTNG_UST_ABI_OBJECT_TYPE_UNKNOWN = -1,
	262	LTTNG_UST_ABI_OBJECT_TYPE_CHANNEL = 0,
	263	LTTNG_UST_ABI_OBJECT_TYPE_STREAM = 1,
	264	LTTNG_UST_ABI_OBJECT_TYPE_EVENT = 2,
	265	LTTNG_UST_ABI_OBJECT_TYPE_CONTEXT = 3,
	266	LTTNG_UST_ABI_OBJECT_TYPE_EVENT_NOTIFIER_GROUP = 4,
	267	LTTNG_UST_ABI_OBJECT_TYPE_EVENT_NOTIFIER = 5,
	268	LTTNG_UST_ABI_OBJECT_TYPE_COUNTER = 6,
	269	LTTNG_UST_ABI_OBJECT_TYPE_COUNTER_GLOBAL = 7,
	270	LTTNG_UST_ABI_OBJECT_TYPE_COUNTER_CPU = 8,
74d81a6c MD	271	};
74d81a6c MD	272
fd17d7ce MD	273	#define LTTNG_UST_ABI_OBJECT_DATA_PADDING1 32
fd17d7ce MD	274	#define LTTNG_UST_ABI_OBJECT_DATA_PADDING2 (LTTNG_UST_ABI_SYM_NAME_LEN + 32)
74d81a6c	275
fd17d7ce MD	276	struct lttng_ust_abi_object_data {
fd17d7ce MD	277	int32_t type; /* enum lttng_ust_abi_object_type */
92462b01	278	int handle;
74d81a6c	279	uint64_t size;
fd17d7ce	280	char padding1[LTTNG_UST_ABI_OBJECT_DATA_PADDING1];
74d81a6c MD	281	union {
	282	struct {
	283	void *data;
fd17d7ce	284	int32_t type; /* enum lttng_ust_abi_chan_type */
ff0f5728	285	int wakeup_fd;
74d81a6c MD	286	} channel;
	287	struct {
	288	int shm_fd;
	289	int wakeup_fd;
	290	uint32_t stream_nr;
	291	} stream;
ebabbf58 MD	292	struct {
	293	void *data;
	294	} counter;
	295	struct {
	296	int shm_fd;
	297	} counter_global;
	298	struct {
	299	int shm_fd;
	300	uint32_t cpu_nr;
	301	} counter_cpu;
fd17d7ce	302	char padding2[LTTNG_UST_ABI_OBJECT_DATA_PADDING2];
74d81a6c	303	} u;
9f5ade14	304	} __attribute__((packed));
92462b01	305
459cbee4	306	enum lttng_ust_abi_calibrate_type {
fd17d7ce	307	LTTNG_UST_ABI_CALIBRATE_TRACEPOINT,
d9a9a33b MD	308	};
d9a9a33b MD	309
fd17d7ce MD	310	#define LTTNG_UST_ABI_CALIBRATE_PADDING1 16
	311	#define LTTNG_UST_ABI_CALIBRATE_PADDING2 (LTTNG_UST_ABI_SYM_NAME_LEN + 32)
	312	struct lttng_ust_abi_calibrate {
459cbee4	313	enum lttng_ust_abi_calibrate_type type; /* type (input) */
fd17d7ce	314	char padding[LTTNG_UST_ABI_CALIBRATE_PADDING1];
1332bb04 MD	315
1332bb04 MD	316	union {
fd17d7ce	317	char padding[LTTNG_UST_ABI_CALIBRATE_PADDING2];
1332bb04	318	} u;
9f5ade14	319	} __attribute__((packed));
d9a9a33b	320
fd17d7ce MD	321	#define LTTNG_UST_ABI_FILTER_BYTECODE_MAX_LEN 65536
	322	#define LTTNG_UST_ABI_FILTER_PADDING 32
	323	struct lttng_ust_abi_filter_bytecode {
2734ca65 CB	324	uint32_t len;
2734ca65 CB	325	uint32_t reloc_offset;
3f6fd224	326	uint64_t seqnum;
fd17d7ce	327	char padding[LTTNG_UST_ABI_FILTER_PADDING];
2d78951a	328	char data[0];
9f5ade14	329	} __attribute__((packed));
2d78951a	330
fd17d7ce MD	331	#define LTTNG_UST_ABI_CAPTURE_BYTECODE_MAX_LEN 65536
	332	#define LTTNG_UST_ABI_CAPTURE_PADDING 32
	333	struct lttng_ust_abi_capture_bytecode {
d37ecb3f FD	334	uint32_t len;
	335	uint32_t reloc_offset;
	336	uint64_t seqnum;
fd17d7ce	337	char padding[LTTNG_UST_ABI_CAPTURE_PADDING];
d37ecb3f	338	char data[0];
9f5ade14	339	} __attribute__((packed));
d37ecb3f	340
fd17d7ce MD	341	#define LTTNG_UST_ABI_EXCLUSION_PADDING 32
fd17d7ce MD	342	struct lttng_ust_abi_event_exclusion {
86e0c24e	343	uint32_t count;
fd17d7ce MD	344	char padding[LTTNG_UST_ABI_EXCLUSION_PADDING];
fd17d7ce MD	345	char names[LTTNG_UST_ABI_SYM_NAME_LEN][0];
9f5ade14	346	} __attribute__((packed));
86e0c24e	347
fd17d7ce MD	348	#define LTTNG_UST_ABI_CMD(minor) (minor)
	349	#define LTTNG_UST_ABI_CMDR(minor, type) (minor)
	350	#define LTTNG_UST_ABI_CMDW(minor, type) (minor)
9f3fdbc6	351
46050b1a	352	/* Handled by object descriptor */
fd17d7ce	353	#define LTTNG_UST_ABI_RELEASE LTTNG_UST_ABI_CMD(0x1)
46050b1a MD	354
	355	/* Handled by object cmd */
	356
9f3fdbc6	357	/* LTTng-UST commands */
fd17d7ce MD	358	#define LTTNG_UST_ABI_SESSION LTTNG_UST_ABI_CMD(0x40)
	359	#define LTTNG_UST_ABI_TRACER_VERSION \
	360	LTTNG_UST_ABI_CMDR(0x41, struct lttng_ust_abi_tracer_version)
	361	#define LTTNG_UST_ABI_TRACEPOINT_LIST LTTNG_UST_ABI_CMD(0x42)
	362	#define LTTNG_UST_ABI_WAIT_QUIESCENT LTTNG_UST_ABI_CMD(0x43)
	363	#define LTTNG_UST_ABI_REGISTER_DONE LTTNG_UST_ABI_CMD(0x44)
	364	#define LTTNG_UST_ABI_TRACEPOINT_FIELD_LIST LTTNG_UST_ABI_CMD(0x45)
	365	#define LTTNG_UST_ABI_EVENT_NOTIFIER_GROUP_CREATE \
	366	LTTNG_UST_ABI_CMD(0x46)
9f3fdbc6	367
3c5d7582	368	/* Session commands */
fd17d7ce MD	369	#define LTTNG_UST_ABI_CHANNEL \
	370	LTTNG_UST_ABI_CMDW(0x51, struct lttng_ust_abi_channel)
	371	#define LTTNG_UST_ABI_SESSION_START LTTNG_UST_ABI_CMD(0x52)
	372	#define LTTNG_UST_ABI_SESSION_STOP LTTNG_UST_ABI_CMD(0x53)
	373	#define LTTNG_UST_ABI_SESSION_STATEDUMP LTTNG_UST_ABI_CMD(0x54)
9f3fdbc6	374
3c5d7582	375	/* Channel commands */
fd17d7ce MD	376	#define LTTNG_UST_ABI_STREAM LTTNG_UST_ABI_CMD(0x60)
	377	#define LTTNG_UST_ABI_EVENT \
	378	LTTNG_UST_ABI_CMDW(0x61, struct lttng_ust_abi_event)
9f3fdbc6	379
3c5d7582	380	/* Event and channel commands */
fd17d7ce MD	381	#define LTTNG_UST_ABI_CONTEXT \
	382	LTTNG_UST_ABI_CMDW(0x70, struct lttng_ust_abi_context)
	383	#define LTTNG_UST_ABI_FLUSH_BUFFER \
	384	LTTNG_UST_ABI_CMD(0x71)
9f3fdbc6	385
3c5d7582	386	/* Event, event notifier, channel and session commands */
fd17d7ce MD	387	#define LTTNG_UST_ABI_ENABLE LTTNG_UST_ABI_CMD(0x80)
fd17d7ce MD	388	#define LTTNG_UST_ABI_DISABLE LTTNG_UST_ABI_CMD(0x81)
9f3fdbc6	389
51489cad	390	/* Tracepoint list commands */
fd17d7ce MD	391	#define LTTNG_UST_ABI_TRACEPOINT_LIST_GET LTTNG_UST_ABI_CMD(0x90)
fd17d7ce MD	392	#define LTTNG_UST_ABI_TRACEPOINT_FIELD_LIST_GET LTTNG_UST_ABI_CMD(0x91)
51489cad	393
3c5d7582	394	/* Event and event notifier commands */
fd17d7ce MD	395	#define LTTNG_UST_ABI_FILTER LTTNG_UST_ABI_CMD(0xA0)
fd17d7ce MD	396	#define LTTNG_UST_ABI_EXCLUSION LTTNG_UST_ABI_CMD(0xA1)
2d78951a	397
d8d2416d	398	/* Event notifier group commands */
fd17d7ce MD	399	#define LTTNG_UST_ABI_EVENT_NOTIFIER_CREATE \
fd17d7ce MD	400	LTTNG_UST_ABI_CMDW(0xB0, struct lttng_ust_abi_event_notifier)
3c5d7582 MD	401
3c5d7582 MD	402	/* Event notifier commands */
fd17d7ce	403	#define LTTNG_UST_ABI_CAPTURE LTTNG_UST_ABI_CMD(0xB6)
d8d2416d	404
ebabbf58	405	/* Session and event notifier group commands */
fd17d7ce MD	406	#define LTTNG_UST_ABI_COUNTER \
fd17d7ce MD	407	LTTNG_UST_ABI_CMDW(0xC0, struct lttng_ust_abi_counter)
ebabbf58 MD	408
ebabbf58 MD	409	/* Counter commands */
fd17d7ce MD	410	#define LTTNG_UST_ABI_COUNTER_GLOBAL \
	411	LTTNG_UST_ABI_CMDW(0xD0, struct lttng_ust_abi_counter_global)
	412	#define LTTNG_UST_ABI_COUNTER_CPU \
	413	LTTNG_UST_ABI_CMDW(0xD1, struct lttng_ust_abi_counter_cpu)
46050b1a	414
fd17d7ce	415	#define LTTNG_UST_ABI_ROOT_HANDLE 0
b35d179d	416
9f3fdbc6	417	#endif /* _LTTNG_UST_ABI_H */