[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 LTTNG_PACKED
#error "LTTNG_PACKED should be defined"
#endif

#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;
} LTTNG_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 */
} LTTNG_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.
	 */
} LTTNG_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;
} LTTNG_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];
} LTTNG_PACKED;

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