[lttng-tools.git] / src / bin / lttng-sessiond / ust-abi-internal.hpp

/*
 * Copyright 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *
 * SPDX-License-Identifier: MIT
 *
 * Copied from LTTng-UST lttng/ust-abi.h
 *
 * LTTng-UST ABI header
 *
 */

#ifndef LTTNG_UST_ABI_INTERNAL_H
#define LTTNG_UST_ABI_INTERNAL_H

#include <common/macros.hpp>

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