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

/*
 * SPDX-License-Identifier: MIT
 *
 * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *
 * LTTng-UST ABI header
 */

#ifndef _LTTNG_UST_ABI_H
#define _LTTNG_UST_ABI_H

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

#ifndef __ust_stringify
#define __ust_stringify1(x)	#x
#define __ust_stringify(x)	__ust_stringify1(x)
#endif /* __ust_stringify */

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