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

#ifndef _LTTNG_UST_ABI_H
#define _LTTNG_UST_ABI_H

/*
 * lttng/ust-abi.h
 *
 * LTTng-UST ABI header
 *
 * Copyright 2010-2012 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#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_SYM_NAME_LEN			256
#define LTTNG_UST_ABI_PROCNAME_LEN		16

/* UST comm magic number, used to validate protocol and endianness. */
#define LTTNG_UST_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_instrumentation {
	LTTNG_UST_TRACEPOINT		= 0,
	LTTNG_UST_PROBE			= 1,
	LTTNG_UST_FUNCTION		= 2,
};

enum lttng_ust_loglevel_type {
	LTTNG_UST_LOGLEVEL_ALL		= 0,
	LTTNG_UST_LOGLEVEL_RANGE	= 1,
	LTTNG_UST_LOGLEVEL_SINGLE	= 2,
};

enum lttng_ust_output {
	LTTNG_UST_MMAP		= 0,
};

enum lttng_ust_chan_type {
	LTTNG_UST_CHAN_PER_CPU = 0,
	LTTNG_UST_CHAN_METADATA = 1,
};

struct lttng_ust_tracer_version {
	uint32_t major;
	uint32_t minor;
	uint32_t patchlevel;
} LTTNG_PACKED;

#define LTTNG_UST_CHANNEL_PADDING	(LTTNG_UST_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_CHANNEL_DATA_MAX_LEN	1048576U
struct lttng_ust_channel {
	uint64_t len;
	enum lttng_ust_chan_type type;
	char padding[LTTNG_UST_CHANNEL_PADDING];
	char data[];	/* variable sized data */
} LTTNG_PACKED;

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

#define LTTNG_UST_EVENT_PADDING1	16
#define LTTNG_UST_EVENT_PADDING2	(LTTNG_UST_SYM_NAME_LEN + 32)
struct lttng_ust_event {
	enum lttng_ust_instrumentation instrumentation;
	char name[LTTNG_UST_SYM_NAME_LEN];	/* event name */

	enum lttng_ust_loglevel_type loglevel_type;
	int loglevel;	/* value, -1: all */
	char padding[LTTNG_UST_EVENT_PADDING1];

	/* Per instrumentation type configuration */
	union {
		char padding[LTTNG_UST_EVENT_PADDING2];
	} u;
} LTTNG_PACKED;

enum lttng_ust_field_type {
	LTTNG_UST_FIELD_OTHER			= 0,
	LTTNG_UST_FIELD_INTEGER			= 1,
	LTTNG_UST_FIELD_ENUM			= 2,
	LTTNG_UST_FIELD_FLOAT			= 3,
	LTTNG_UST_FIELD_STRING			= 4,
};

#define LTTNG_UST_FIELD_ITER_PADDING	(LTTNG_UST_SYM_NAME_LEN + 28)
struct lttng_ust_field_iter {
	char event_name[LTTNG_UST_SYM_NAME_LEN];
	char field_name[LTTNG_UST_SYM_NAME_LEN];
	enum lttng_ust_field_type type;
	int loglevel;				/* event loglevel */
	int nowrite;
	char padding[LTTNG_UST_FIELD_ITER_PADDING];
} LTTNG_PACKED;

enum lttng_ust_context_type {
	LTTNG_UST_CONTEXT_VTID			= 0,
	LTTNG_UST_CONTEXT_VPID			= 1,
	LTTNG_UST_CONTEXT_PTHREAD_ID		= 2,
	LTTNG_UST_CONTEXT_PROCNAME		= 3,
	LTTNG_UST_CONTEXT_IP			= 4,
	LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER	= 5,
	LTTNG_UST_CONTEXT_CPU_ID		= 6,
	LTTNG_UST_CONTEXT_APP_CONTEXT		= 7,
	LTTNG_UST_CONTEXT_CGROUP_NS		= 8,
	LTTNG_UST_CONTEXT_IPC_NS		= 9,
	LTTNG_UST_CONTEXT_MNT_NS		= 10,
	LTTNG_UST_CONTEXT_NET_NS		= 11,
	LTTNG_UST_CONTEXT_PID_NS		= 12,
	LTTNG_UST_CONTEXT_USER_NS		= 13,
	LTTNG_UST_CONTEXT_UTS_NS		= 14,
	LTTNG_UST_CONTEXT_VUID			= 15,
	LTTNG_UST_CONTEXT_VEUID			= 16,
	LTTNG_UST_CONTEXT_VSUID			= 17,
	LTTNG_UST_CONTEXT_VGID			= 18,
	LTTNG_UST_CONTEXT_VEGID			= 19,
	LTTNG_UST_CONTEXT_VSGID			= 20,
	LTTNG_UST_CONTEXT_TIME_NS		= 21,
};

struct lttng_ust_perf_counter_ctx {
	uint32_t type;
	uint64_t config;
	char name[LTTNG_UST_SYM_NAME_LEN];
} LTTNG_PACKED;

#define LTTNG_UST_CONTEXT_PADDING1	16
#define LTTNG_UST_CONTEXT_PADDING2	(LTTNG_UST_SYM_NAME_LEN + 32)
struct lttng_ust_context {
	enum lttng_ust_context_type ctx;
	char padding[LTTNG_UST_CONTEXT_PADDING1];

	union {
		struct lttng_ust_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_CONTEXT_PADDING2];
	} u;
} LTTNG_PACKED;

/*
 * Tracer channel attributes.
 */
#define LTTNG_UST_CHANNEL_ATTR_PADDING	(LTTNG_UST_SYM_NAME_LEN + 32)
struct lttng_ust_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 */
	enum lttng_ust_output output;		/* splice, mmap */
	union {
		struct {
			int64_t blocking_timeout;	/* Blocking timeout (usec) */
		} s;
		char padding[LTTNG_UST_CHANNEL_ATTR_PADDING];
	} u;
} LTTNG_PACKED;

#define LTTNG_UST_TRACEPOINT_ITER_PADDING	16
struct lttng_ust_tracepoint_iter {
	char name[LTTNG_UST_SYM_NAME_LEN];	/* provider:name */
	int loglevel;
	char padding[LTTNG_UST_TRACEPOINT_ITER_PADDING];
} LTTNG_PACKED;

enum lttng_ust_object_type {
	LTTNG_UST_OBJECT_TYPE_UNKNOWN = -1,
	LTTNG_UST_OBJECT_TYPE_CHANNEL = 0,
	LTTNG_UST_OBJECT_TYPE_STREAM = 1,
	LTTNG_UST_OBJECT_TYPE_EVENT = 2,
	LTTNG_UST_OBJECT_TYPE_CONTEXT = 3,
};

#define LTTNG_UST_OBJECT_DATA_PADDING1	32
#define LTTNG_UST_OBJECT_DATA_PADDING2	(LTTNG_UST_SYM_NAME_LEN + 32)

struct lttng_ust_object_data {
	enum lttng_ust_object_type type;
	int handle;
	uint64_t size;
	char padding1[LTTNG_UST_OBJECT_DATA_PADDING1];
	union {
		struct {
			void *data;
			enum lttng_ust_chan_type type;
			int wakeup_fd;
		} channel;
		struct {
			int shm_fd;
			int wakeup_fd;
			uint32_t stream_nr;
		} stream;
		char padding2[LTTNG_UST_OBJECT_DATA_PADDING2];
	} u;
} LTTNG_PACKED;

enum lttng_ust_calibrate_type {
	LTTNG_UST_CALIBRATE_TRACEPOINT,
};

#define LTTNG_UST_CALIBRATE_PADDING1	16
#define LTTNG_UST_CALIBRATE_PADDING2	(LTTNG_UST_SYM_NAME_LEN + 32)
struct lttng_ust_calibrate {
	enum lttng_ust_calibrate_type type;	/* type (input) */
	char padding[LTTNG_UST_CALIBRATE_PADDING1];

	union {
		char padding[LTTNG_UST_CALIBRATE_PADDING2];
	} u;
} LTTNG_PACKED;

#define FILTER_BYTECODE_MAX_LEN		65536
#define LTTNG_UST_FILTER_PADDING	32
struct lttng_ust_filter_bytecode {
	uint32_t len;
	uint32_t reloc_offset;
	uint64_t seqnum;
	char padding[LTTNG_UST_FILTER_PADDING];
	char data[0];
} LTTNG_PACKED;

#define LTTNG_UST_EXCLUSION_PADDING	32
struct lttng_ust_event_exclusion {
	uint32_t count;
	char padding[LTTNG_UST_EXCLUSION_PADDING];
	char names[LTTNG_UST_SYM_NAME_LEN][0];
} LTTNG_PACKED;

#define _UST_CMD(minor)				(minor)
#define _UST_CMDR(minor, type)			(minor)
#define _UST_CMDW(minor, type)			(minor)

/* Handled by object descriptor */
#define LTTNG_UST_RELEASE			_UST_CMD(0x1)

/* Handled by object cmd */

/* LTTng-UST commands */
#define LTTNG_UST_SESSION			_UST_CMD(0x40)
#define LTTNG_UST_TRACER_VERSION		\
	_UST_CMDR(0x41, struct lttng_ust_tracer_version)
#define LTTNG_UST_TRACEPOINT_LIST		_UST_CMD(0x42)
#define LTTNG_UST_WAIT_QUIESCENT		_UST_CMD(0x43)
#define LTTNG_UST_REGISTER_DONE			_UST_CMD(0x44)
#define LTTNG_UST_TRACEPOINT_FIELD_LIST		_UST_CMD(0x45)

/* Session FD commands */
#define LTTNG_UST_CHANNEL			\
	_UST_CMDW(0x51, struct lttng_ust_channel)
#define LTTNG_UST_SESSION_START			_UST_CMD(0x52)
#define LTTNG_UST_SESSION_STOP			_UST_CMD(0x53)
#define LTTNG_UST_SESSION_STATEDUMP		_UST_CMD(0x54)

/* Channel FD commands */
#define LTTNG_UST_STREAM			_UST_CMD(0x60)
#define LTTNG_UST_EVENT			\
	_UST_CMDW(0x61, struct lttng_ust_event)

/* Event and Channel FD commands */
#define LTTNG_UST_CONTEXT			\
	_UST_CMDW(0x70, struct lttng_ust_context)
#define LTTNG_UST_FLUSH_BUFFER			\
	_UST_CMD(0x71)

/* Event, Channel and Session commands */
#define LTTNG_UST_ENABLE			_UST_CMD(0x80)
#define LTTNG_UST_DISABLE			_UST_CMD(0x81)

/* Tracepoint list commands */
#define LTTNG_UST_TRACEPOINT_LIST_GET		_UST_CMD(0x90)
#define LTTNG_UST_TRACEPOINT_FIELD_LIST_GET	_UST_CMD(0x91)

/* Event FD commands */
#define LTTNG_UST_FILTER			_UST_CMD(0xA0)
#define LTTNG_UST_EXCLUSION			_UST_CMD(0xA1)

#define LTTNG_UST_ROOT_HANDLE	0

struct lttng_ust_obj;

union ust_args {
	struct {
		void *chan_data;
		int wakeup_fd;
	} channel;
	struct {
		int shm_fd;
		int wakeup_fd;
	} stream;
	struct {
		struct lttng_ust_field_iter entry;
	} field_list;
	struct {
		char *ctxname;
	} app_context;
};

struct lttng_ust_objd_ops {
	long (*cmd)(int objd, unsigned int cmd, unsigned long arg,
		union ust_args *args, void *owner);
	int (*release)(int objd);
};

/* Create root handle. Always ID 0. */
int lttng_abi_create_root_handle(void);

const struct lttng_ust_objd_ops *objd_ops(int id);
int lttng_ust_objd_unref(int id, int is_owner);

void lttng_ust_abi_exit(void);
void lttng_ust_events_exit(void);
void lttng_ust_objd_table_owner_cleanup(void *owner);

#endif /* _LTTNG_UST_ABI_H */
Commit	Line	Data
	1	#ifndef _LTTNG_UST_ABI_H
	2	#define _LTTNG_UST_ABI_H
	3
	4	/*
	5	* lttng/ust-abi.h
	6	*
	7	* LTTng-UST ABI header
	8	*
	9	* Copyright 2010-2012 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	10	*
	11	* Permission is hereby granted, free of charge, to any person obtaining a copy
	12	* of this software and associated documentation files (the "Software"), to deal
	13	* in the Software without restriction, including without limitation the rights
	14	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	15	* copies of the Software, and to permit persons to whom the Software is
	16	* furnished to do so, subject to the following conditions:
	17	*
	18	* The above copyright notice and this permission notice shall be included in
	19	* all copies or substantial portions of the Software.
	20	*
	21	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	22	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	23	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	24	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	25	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	26	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	27	* SOFTWARE.
	28	*/
	29
	30	#include <stdint.h>
	31	#include <lttng/ust-compiler.h>
	32
	33	#ifndef LTTNG_PACKED
	34	#error "LTTNG_PACKED should be defined"
	35	#endif
	36
	37	#ifndef __ust_stringify
	38	#define __ust_stringify1(x) #x
	39	#define __ust_stringify(x) __ust_stringify1(x)
	40	#endif /* __ust_stringify */
	41
	42	#define LTTNG_UST_SYM_NAME_LEN 256
	43	#define LTTNG_UST_ABI_PROCNAME_LEN 16
	44
	45	/* UST comm magic number, used to validate protocol and endianness. */
	46	#define LTTNG_UST_COMM_MAGIC 0xC57C57C5
	47
	48	/* Version for ABI between liblttng-ust, sessiond, consumerd */
	49	#define LTTNG_UST_ABI_MAJOR_VERSION 9
	50	#define LTTNG_UST_ABI_MAJOR_VERSION_OLDEST_COMPATIBLE 8
	51	#define LTTNG_UST_ABI_MINOR_VERSION 0
	52
	53	enum lttng_ust_instrumentation {
	54	LTTNG_UST_TRACEPOINT = 0,
	55	LTTNG_UST_PROBE = 1,
	56	LTTNG_UST_FUNCTION = 2,
	57	};
	58
	59	enum lttng_ust_loglevel_type {
	60	LTTNG_UST_LOGLEVEL_ALL = 0,
	61	LTTNG_UST_LOGLEVEL_RANGE = 1,
	62	LTTNG_UST_LOGLEVEL_SINGLE = 2,
	63	};
	64
	65	enum lttng_ust_output {
	66	LTTNG_UST_MMAP = 0,
	67	};
	68
	69	enum lttng_ust_chan_type {
	70	LTTNG_UST_CHAN_PER_CPU = 0,
	71	LTTNG_UST_CHAN_METADATA = 1,
	72	};
	73
	74	struct lttng_ust_tracer_version {
	75	uint32_t major;
	76	uint32_t minor;
	77	uint32_t patchlevel;
	78	} LTTNG_PACKED;
	79
	80	#define LTTNG_UST_CHANNEL_PADDING (LTTNG_UST_SYM_NAME_LEN + 32)
	81	/*
	82	* Given that the consumerd is limited to 64k file descriptors, we
	83	* cannot expect much more than 1MB channel structure size. This size is
	84	* depends on the number of streams within a channel, which depends on
	85	* the number of possible CPUs on the system.
	86	*/
	87	#define LTTNG_UST_CHANNEL_DATA_MAX_LEN 1048576U
	88	struct lttng_ust_channel {
	89	uint64_t len;
	90	enum lttng_ust_chan_type type;
	91	char padding[LTTNG_UST_CHANNEL_PADDING];
	92	char data[]; /* variable sized data */
	93	} LTTNG_PACKED;
	94
	95	#define LTTNG_UST_STREAM_PADDING1 (LTTNG_UST_SYM_NAME_LEN + 32)
	96	struct lttng_ust_stream {
	97	uint64_t len; /* shm len */
	98	uint32_t stream_nr; /* stream number */
	99	char padding[LTTNG_UST_STREAM_PADDING1];
	100	/*
	101	* shm_fd and wakeup_fd are send over unix socket as file
	102	* descriptors after this structure.
	103	*/
	104	} LTTNG_PACKED;
	105
	106	#define LTTNG_UST_EVENT_PADDING1 16
	107	#define LTTNG_UST_EVENT_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
	108	struct lttng_ust_event {
	109	enum lttng_ust_instrumentation instrumentation;
	110	char name[LTTNG_UST_SYM_NAME_LEN]; /* event name */
	111
	112	enum lttng_ust_loglevel_type loglevel_type;
	113	int loglevel; /* value, -1: all */
	114	char padding[LTTNG_UST_EVENT_PADDING1];
	115
	116	/* Per instrumentation type configuration */
	117	union {
	118	char padding[LTTNG_UST_EVENT_PADDING2];
	119	} u;
	120	} LTTNG_PACKED;
	121
	122	enum lttng_ust_field_type {
	123	LTTNG_UST_FIELD_OTHER = 0,
	124	LTTNG_UST_FIELD_INTEGER = 1,
	125	LTTNG_UST_FIELD_ENUM = 2,
	126	LTTNG_UST_FIELD_FLOAT = 3,
	127	LTTNG_UST_FIELD_STRING = 4,
	128	};
	129
	130	#define LTTNG_UST_FIELD_ITER_PADDING (LTTNG_UST_SYM_NAME_LEN + 28)
	131	struct lttng_ust_field_iter {
	132	char event_name[LTTNG_UST_SYM_NAME_LEN];
	133	char field_name[LTTNG_UST_SYM_NAME_LEN];
	134	enum lttng_ust_field_type type;
	135	int loglevel; /* event loglevel */
	136	int nowrite;
	137	char padding[LTTNG_UST_FIELD_ITER_PADDING];
	138	} LTTNG_PACKED;
	139
	140	enum lttng_ust_context_type {
	141	LTTNG_UST_CONTEXT_VTID = 0,
	142	LTTNG_UST_CONTEXT_VPID = 1,
	143	LTTNG_UST_CONTEXT_PTHREAD_ID = 2,
	144	LTTNG_UST_CONTEXT_PROCNAME = 3,
	145	LTTNG_UST_CONTEXT_IP = 4,
	146	LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER = 5,
	147	LTTNG_UST_CONTEXT_CPU_ID = 6,
	148	LTTNG_UST_CONTEXT_APP_CONTEXT = 7,
	149	LTTNG_UST_CONTEXT_CGROUP_NS = 8,
	150	LTTNG_UST_CONTEXT_IPC_NS = 9,
	151	LTTNG_UST_CONTEXT_MNT_NS = 10,
	152	LTTNG_UST_CONTEXT_NET_NS = 11,
	153	LTTNG_UST_CONTEXT_PID_NS = 12,
	154	LTTNG_UST_CONTEXT_USER_NS = 13,
	155	LTTNG_UST_CONTEXT_UTS_NS = 14,
	156	LTTNG_UST_CONTEXT_VUID = 15,
	157	LTTNG_UST_CONTEXT_VEUID = 16,
	158	LTTNG_UST_CONTEXT_VSUID = 17,
	159	LTTNG_UST_CONTEXT_VGID = 18,
	160	LTTNG_UST_CONTEXT_VEGID = 19,
	161	LTTNG_UST_CONTEXT_VSGID = 20,
	162	LTTNG_UST_CONTEXT_TIME_NS = 21,
	163	};
	164
	165	struct lttng_ust_perf_counter_ctx {
	166	uint32_t type;
	167	uint64_t config;
	168	char name[LTTNG_UST_SYM_NAME_LEN];
	169	} LTTNG_PACKED;
	170
	171	#define LTTNG_UST_CONTEXT_PADDING1 16
	172	#define LTTNG_UST_CONTEXT_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
	173	struct lttng_ust_context {
	174	enum lttng_ust_context_type ctx;
	175	char padding[LTTNG_UST_CONTEXT_PADDING1];
	176
	177	union {
	178	struct lttng_ust_perf_counter_ctx perf_counter;
	179	struct {
	180	/* Includes trailing '\0'. */
	181	uint32_t provider_name_len;
	182	uint32_t ctx_name_len;
	183	} app_ctx;
	184	char padding[LTTNG_UST_CONTEXT_PADDING2];
	185	} u;
	186	} LTTNG_PACKED;
	187
	188	/*
	189	* Tracer channel attributes.
	190	*/
	191	#define LTTNG_UST_CHANNEL_ATTR_PADDING (LTTNG_UST_SYM_NAME_LEN + 32)
	192	struct lttng_ust_channel_attr {
	193	uint64_t subbuf_size; /* bytes */
	194	uint64_t num_subbuf; /* power of 2 */
	195	int overwrite; /* 1: overwrite, 0: discard */
	196	unsigned int switch_timer_interval; /* usec */
	197	unsigned int read_timer_interval; /* usec */
	198	enum lttng_ust_output output; /* splice, mmap */
	199	union {
	200	struct {
	201	int64_t blocking_timeout; /* Blocking timeout (usec) */
	202	} s;
	203	char padding[LTTNG_UST_CHANNEL_ATTR_PADDING];
	204	} u;
	205	} LTTNG_PACKED;
	206
	207	#define LTTNG_UST_TRACEPOINT_ITER_PADDING 16
	208	struct lttng_ust_tracepoint_iter {
	209	char name[LTTNG_UST_SYM_NAME_LEN]; /* provider:name */
	210	int loglevel;
	211	char padding[LTTNG_UST_TRACEPOINT_ITER_PADDING];
	212	} LTTNG_PACKED;
	213
	214	enum lttng_ust_object_type {
	215	LTTNG_UST_OBJECT_TYPE_UNKNOWN = -1,
	216	LTTNG_UST_OBJECT_TYPE_CHANNEL = 0,
	217	LTTNG_UST_OBJECT_TYPE_STREAM = 1,
	218	LTTNG_UST_OBJECT_TYPE_EVENT = 2,
	219	LTTNG_UST_OBJECT_TYPE_CONTEXT = 3,
	220	};
	221
	222	#define LTTNG_UST_OBJECT_DATA_PADDING1 32
	223	#define LTTNG_UST_OBJECT_DATA_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
	224
	225	struct lttng_ust_object_data {
	226	enum lttng_ust_object_type type;
	227	int handle;
	228	uint64_t size;
	229	char padding1[LTTNG_UST_OBJECT_DATA_PADDING1];
	230	union {
	231	struct {
	232	void *data;
	233	enum lttng_ust_chan_type type;
	234	int wakeup_fd;
	235	} channel;
	236	struct {
	237	int shm_fd;
	238	int wakeup_fd;
	239	uint32_t stream_nr;
	240	} stream;
	241	char padding2[LTTNG_UST_OBJECT_DATA_PADDING2];
	242	} u;
	243	} LTTNG_PACKED;
	244
	245	enum lttng_ust_calibrate_type {
	246	LTTNG_UST_CALIBRATE_TRACEPOINT,
	247	};
	248
	249	#define LTTNG_UST_CALIBRATE_PADDING1 16
	250	#define LTTNG_UST_CALIBRATE_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
	251	struct lttng_ust_calibrate {
	252	enum lttng_ust_calibrate_type type; /* type (input) */
	253	char padding[LTTNG_UST_CALIBRATE_PADDING1];
	254
	255	union {
	256	char padding[LTTNG_UST_CALIBRATE_PADDING2];
	257	} u;
	258	} LTTNG_PACKED;
	259
	260	#define FILTER_BYTECODE_MAX_LEN 65536
	261	#define LTTNG_UST_FILTER_PADDING 32
	262	struct lttng_ust_filter_bytecode {
	263	uint32_t len;
	264	uint32_t reloc_offset;
	265	uint64_t seqnum;
	266	char padding[LTTNG_UST_FILTER_PADDING];
	267	char data[0];
	268	} LTTNG_PACKED;
	269
	270	#define LTTNG_UST_EXCLUSION_PADDING 32
	271	struct lttng_ust_event_exclusion {
	272	uint32_t count;
	273	char padding[LTTNG_UST_EXCLUSION_PADDING];
	274	char names[LTTNG_UST_SYM_NAME_LEN][0];
	275	} LTTNG_PACKED;
	276
	277	#define _UST_CMD(minor) (minor)
	278	#define _UST_CMDR(minor, type) (minor)
	279	#define _UST_CMDW(minor, type) (minor)
	280
	281	/* Handled by object descriptor */
	282	#define LTTNG_UST_RELEASE _UST_CMD(0x1)
	283
	284	/* Handled by object cmd */
	285
	286	/* LTTng-UST commands */
	287	#define LTTNG_UST_SESSION _UST_CMD(0x40)
	288	#define LTTNG_UST_TRACER_VERSION \
	289	_UST_CMDR(0x41, struct lttng_ust_tracer_version)
	290	#define LTTNG_UST_TRACEPOINT_LIST _UST_CMD(0x42)
	291	#define LTTNG_UST_WAIT_QUIESCENT _UST_CMD(0x43)
	292	#define LTTNG_UST_REGISTER_DONE _UST_CMD(0x44)
	293	#define LTTNG_UST_TRACEPOINT_FIELD_LIST _UST_CMD(0x45)
	294
	295	/* Session FD commands */
	296	#define LTTNG_UST_CHANNEL \
	297	_UST_CMDW(0x51, struct lttng_ust_channel)
	298	#define LTTNG_UST_SESSION_START _UST_CMD(0x52)
	299	#define LTTNG_UST_SESSION_STOP _UST_CMD(0x53)
	300	#define LTTNG_UST_SESSION_STATEDUMP _UST_CMD(0x54)
	301
	302	/* Channel FD commands */
	303	#define LTTNG_UST_STREAM _UST_CMD(0x60)
	304	#define LTTNG_UST_EVENT \
	305	_UST_CMDW(0x61, struct lttng_ust_event)
	306
	307	/* Event and Channel FD commands */
	308	#define LTTNG_UST_CONTEXT \
	309	_UST_CMDW(0x70, struct lttng_ust_context)
	310	#define LTTNG_UST_FLUSH_BUFFER \
	311	_UST_CMD(0x71)
	312
	313	/* Event, Channel and Session commands */
	314	#define LTTNG_UST_ENABLE _UST_CMD(0x80)
	315	#define LTTNG_UST_DISABLE _UST_CMD(0x81)
	316
	317	/* Tracepoint list commands */
	318	#define LTTNG_UST_TRACEPOINT_LIST_GET _UST_CMD(0x90)
	319	#define LTTNG_UST_TRACEPOINT_FIELD_LIST_GET _UST_CMD(0x91)
	320
	321	/* Event FD commands */
	322	#define LTTNG_UST_FILTER _UST_CMD(0xA0)
	323	#define LTTNG_UST_EXCLUSION _UST_CMD(0xA1)
	324
	325	#define LTTNG_UST_ROOT_HANDLE 0
	326
	327	struct lttng_ust_obj;
	328
	329	union ust_args {
	330	struct {
	331	void *chan_data;
	332	int wakeup_fd;
	333	} channel;
	334	struct {
	335	int shm_fd;
	336	int wakeup_fd;
	337	} stream;
	338	struct {
	339	struct lttng_ust_field_iter entry;
	340	} field_list;
	341	struct {
	342	char *ctxname;
	343	} app_context;
	344	};
	345
	346	struct lttng_ust_objd_ops {
	347	long (*cmd)(int objd, unsigned int cmd, unsigned long arg,
	348	union ust_args args, void owner);
	349	int (*release)(int objd);
	350	};
	351
	352	/* Create root handle. Always ID 0. */
	353	int lttng_abi_create_root_handle(void);
	354
	355	const struct lttng_ust_objd_ops *objd_ops(int id);
	356	int lttng_ust_objd_unref(int id, int is_owner);
	357
	358	void lttng_ust_abi_exit(void);
	359	void lttng_ust_events_exit(void);
	360	void lttng_ust_objd_table_owner_cleanup(void *owner);
	361
	362	#endif /* _LTTNG_UST_ABI_H */