[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 __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		7
#define LTTNG_UST_ABI_MINOR_VERSION		2

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,
};

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 */
	char padding[LTTNG_UST_CHANNEL_ATTR_PADDING];
} 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
9f3fdbc6 MD	1	#ifndef _LTTNG_UST_ABI_H
	2	#define _LTTNG_UST_ABI_H
	3
	4	/*
4318ae1b	5	* lttng/ust-abi.h
9f3fdbc6	6	*
9f3fdbc6 MD	7	* LTTng-UST ABI header
9f3fdbc6 MD	8	*
e92f3e28 MD	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:
a60d70e6	17	*
e92f3e28 MD	18	* The above copyright notice and this permission notice shall be included in
e92f3e28 MD	19	* all copies or substantial portions of the Software.
d2428e87 MD	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.
9f3fdbc6 MD	28	*/
9f3fdbc6 MD	29
0a42beb6	30	#include <stdint.h>
b3f60bbf	31	#include <lttng/ust-compiler.h>
0a42beb6	32
32ce8569 MD	33	#ifndef __ust_stringify
	34	#define __ust_stringify1(x) #x
	35	#define __ust_stringify(x) __ust_stringify1(x)
	36	#endif /* __ust_stringify */
9f3fdbc6	37
32ce8569 MD	38	#define LTTNG_UST_SYM_NAME_LEN 256
	39	#define LTTNG_UST_ABI_PROCNAME_LEN 16
	40
	41	/* UST comm magic number, used to validate protocol and endianness. */
	42	#define LTTNG_UST_COMM_MAGIC 0xC57C57C5
b35d179d	43
0f4eaec3	44	/* Version for ABI between liblttng-ust, sessiond, consumerd */
3e762260	45	#define LTTNG_UST_ABI_MAJOR_VERSION 7
3151a51d	46	#define LTTNG_UST_ABI_MINOR_VERSION 2
0f4eaec3	47
9f3fdbc6	48	enum lttng_ust_instrumentation {
df854e41 MD	49	LTTNG_UST_TRACEPOINT = 0,
	50	LTTNG_UST_PROBE = 1,
	51	LTTNG_UST_FUNCTION = 2,
6b0e60f1 MD	52	};
	53
	54	enum lttng_ust_loglevel_type {
882a56d7 MD	55	LTTNG_UST_LOGLEVEL_ALL = 0,
	56	LTTNG_UST_LOGLEVEL_RANGE = 1,
	57	LTTNG_UST_LOGLEVEL_SINGLE = 2,
9f3fdbc6 MD	58	};
9f3fdbc6 MD	59
9f3fdbc6	60	enum lttng_ust_output {
b35d179d	61	LTTNG_UST_MMAP = 0,
9f3fdbc6 MD	62	};
9f3fdbc6 MD	63
74d81a6c MD	64	enum lttng_ust_chan_type {
	65	LTTNG_UST_CHAN_PER_CPU = 0,
	66	LTTNG_UST_CHAN_METADATA = 1,
	67	};
	68
b35d179d	69	struct lttng_ust_tracer_version {
b728d87e MD	70	uint32_t major;
b728d87e MD	71	uint32_t minor;
b35d179d	72	uint32_t patchlevel;
b3f60bbf	73	} LTTNG_PACKED;
9f3fdbc6	74
74d81a6c MD	75	#define LTTNG_UST_CHANNEL_PADDING (LTTNG_UST_SYM_NAME_LEN + 32)
	76	/*
	77	* Given that the consumerd is limited to 64k file descriptors, we
	78	* cannot expect much more than 1MB channel structure size. This size is
	79	* depends on the number of streams within a channel, which depends on
	80	* the number of possible CPUs on the system.
	81	*/
	82	#define LTTNG_UST_CHANNEL_DATA_MAX_LEN 1048576U
9f3fdbc6	83	struct lttng_ust_channel {
74d81a6c MD	84	uint64_t len;
74d81a6c MD	85	enum lttng_ust_chan_type type;
1332bb04	86	char padding[LTTNG_UST_CHANNEL_PADDING];
74d81a6c	87	char data[]; /* variable sized data */
b3f60bbf	88	} LTTNG_PACKED;
9f3fdbc6	89
74d81a6c	90	#define LTTNG_UST_STREAM_PADDING1 (LTTNG_UST_SYM_NAME_LEN + 32)
381c0f1e	91	struct lttng_ust_stream {
74d81a6c MD	92	uint64_t len; /* shm len */
74d81a6c MD	93	uint32_t stream_nr; /* stream number */
1332bb04	94	char padding[LTTNG_UST_STREAM_PADDING1];
74d81a6c MD	95	/*
	96	* shm_fd and wakeup_fd are send over unix socket as file
	97	* descriptors after this structure.
	98	*/
b3f60bbf	99	} LTTNG_PACKED;
381c0f1e	100
89f26d57	101	#define LTTNG_UST_EVENT_PADDING1 16
74d81a6c	102	#define LTTNG_UST_EVENT_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
9f3fdbc6	103	struct lttng_ust_event {
9f3fdbc6	104	enum lttng_ust_instrumentation instrumentation;
6b0e60f1 MD	105	char name[LTTNG_UST_SYM_NAME_LEN]; /* event name */
	106
	107	enum lttng_ust_loglevel_type loglevel_type;
882a56d7	108	int loglevel; /* value, -1: all */
1332bb04	109	char padding[LTTNG_UST_EVENT_PADDING1];
6b0e60f1	110
9f3fdbc6 MD	111	/* Per instrumentation type configuration */
9f3fdbc6 MD	112	union {
1332bb04	113	char padding[LTTNG_UST_EVENT_PADDING2];
9f3fdbc6	114	} u;
b3f60bbf	115	} LTTNG_PACKED;
9f3fdbc6	116
06d4f27e MD	117	enum lttng_ust_field_type {
	118	LTTNG_UST_FIELD_OTHER = 0,
	119	LTTNG_UST_FIELD_INTEGER = 1,
	120	LTTNG_UST_FIELD_ENUM = 2,
	121	LTTNG_UST_FIELD_FLOAT = 3,
	122	LTTNG_UST_FIELD_STRING = 4,
	123	};
	124
74d81a6c	125	#define LTTNG_UST_FIELD_ITER_PADDING (LTTNG_UST_SYM_NAME_LEN + 28)
06d4f27e MD	126	struct lttng_ust_field_iter {
	127	char event_name[LTTNG_UST_SYM_NAME_LEN];
	128	char field_name[LTTNG_UST_SYM_NAME_LEN];
	129	enum lttng_ust_field_type type;
	130	int loglevel; /* event loglevel */
180901e6	131	int nowrite;
06d4f27e	132	char padding[LTTNG_UST_FIELD_ITER_PADDING];
b3f60bbf	133	} LTTNG_PACKED;
06d4f27e	134
9f3fdbc6	135	enum lttng_ust_context_type {
3b402b40	136	LTTNG_UST_CONTEXT_VTID = 0,
c1ef86f0 MD	137	LTTNG_UST_CONTEXT_VPID = 1,
c1ef86f0 MD	138	LTTNG_UST_CONTEXT_PTHREAD_ID = 2,
4847e9bb	139	LTTNG_UST_CONTEXT_PROCNAME = 3,
96f85541	140	LTTNG_UST_CONTEXT_IP = 4,
d58d1454	141	LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER = 5,
c7ea8487	142	LTTNG_UST_CONTEXT_CPU_ID = 6,
53f0df51	143	LTTNG_UST_CONTEXT_APP_CONTEXT = 7,
9f3fdbc6 MD	144	};
9f3fdbc6 MD	145
d58d1454 MD	146	struct lttng_ust_perf_counter_ctx {
	147	uint32_t type;
	148	uint64_t config;
	149	char name[LTTNG_UST_SYM_NAME_LEN];
	150	} LTTNG_PACKED;
	151
1332bb04	152	#define LTTNG_UST_CONTEXT_PADDING1 16
74d81a6c	153	#define LTTNG_UST_CONTEXT_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
9f3fdbc6 MD	154	struct lttng_ust_context {
9f3fdbc6 MD	155	enum lttng_ust_context_type ctx;
1332bb04 MD	156	char padding[LTTNG_UST_CONTEXT_PADDING1];
1332bb04 MD	157
9f3fdbc6	158	union {
d58d1454	159	struct lttng_ust_perf_counter_ctx perf_counter;
53f0df51 JG	160	struct {
	161	/* Includes trailing '\0'. */
	162	uint32_t provider_name_len;
	163	uint32_t ctx_name_len;
	164	} app_ctx;
1332bb04	165	char padding[LTTNG_UST_CONTEXT_PADDING2];
9f3fdbc6	166	} u;
b3f60bbf	167	} LTTNG_PACKED;
9f3fdbc6	168
92462b01 MD	169	/*
	170	* Tracer channel attributes.
	171	*/
74d81a6c	172	#define LTTNG_UST_CHANNEL_ATTR_PADDING (LTTNG_UST_SYM_NAME_LEN + 32)
92462b01	173	struct lttng_ust_channel_attr {
92462b01 MD	174	uint64_t subbuf_size; /* bytes */
92462b01 MD	175	uint64_t num_subbuf; /* power of 2 */
b3f60bbf	176	int overwrite; /* 1: overwrite, 0: discard */
92462b01 MD	177	unsigned int switch_timer_interval; /* usec */
	178	unsigned int read_timer_interval; /* usec */
	179	enum lttng_ust_output output; /* splice, mmap */
1332bb04	180	char padding[LTTNG_UST_CHANNEL_ATTR_PADDING];
b3f60bbf	181	} LTTNG_PACKED;
92462b01	182
1332bb04	183	#define LTTNG_UST_TRACEPOINT_ITER_PADDING 16
cbef6901 MD	184	struct lttng_ust_tracepoint_iter {
cbef6901 MD	185	char name[LTTNG_UST_SYM_NAME_LEN]; /* provider:name */
882a56d7	186	int loglevel;
1332bb04	187	char padding[LTTNG_UST_TRACEPOINT_ITER_PADDING];
b3f60bbf	188	} LTTNG_PACKED;
cbef6901	189
74d81a6c MD	190	enum lttng_ust_object_type {
	191	LTTNG_UST_OBJECT_TYPE_UNKNOWN = -1,
	192	LTTNG_UST_OBJECT_TYPE_CHANNEL = 0,
	193	LTTNG_UST_OBJECT_TYPE_STREAM = 1,
32ce8569 MD	194	LTTNG_UST_OBJECT_TYPE_EVENT = 2,
32ce8569 MD	195	LTTNG_UST_OBJECT_TYPE_CONTEXT = 3,
74d81a6c MD	196	};
	197
	198	#define LTTNG_UST_OBJECT_DATA_PADDING1 32
	199	#define LTTNG_UST_OBJECT_DATA_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
	200
92462b01	201	struct lttng_ust_object_data {
74d81a6c	202	enum lttng_ust_object_type type;
92462b01	203	int handle;
74d81a6c MD	204	uint64_t size;
	205	char padding1[LTTNG_UST_OBJECT_DATA_PADDING1];
	206	union {
	207	struct {
	208	void *data;
	209	enum lttng_ust_chan_type type;
ff0f5728	210	int wakeup_fd;
74d81a6c MD	211	} channel;
	212	struct {
	213	int shm_fd;
	214	int wakeup_fd;
	215	uint32_t stream_nr;
	216	} stream;
	217	char padding2[LTTNG_UST_OBJECT_DATA_PADDING2];
	218	} u;
b3f60bbf	219	} LTTNG_PACKED;
92462b01	220
d9a9a33b MD	221	enum lttng_ust_calibrate_type {
	222	LTTNG_UST_CALIBRATE_TRACEPOINT,
	223	};
	224
1332bb04	225	#define LTTNG_UST_CALIBRATE_PADDING1 16
74d81a6c	226	#define LTTNG_UST_CALIBRATE_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
d9a9a33b MD	227	struct lttng_ust_calibrate {
d9a9a33b MD	228	enum lttng_ust_calibrate_type type; /* type (input) */
1332bb04 MD	229	char padding[LTTNG_UST_CALIBRATE_PADDING1];
	230
	231	union {
	232	char padding[LTTNG_UST_CALIBRATE_PADDING2];
	233	} u;
b3f60bbf	234	} LTTNG_PACKED;
d9a9a33b	235
5b4839a8	236	#define FILTER_BYTECODE_MAX_LEN 65536
a5930599	237	#define LTTNG_UST_FILTER_PADDING 32
2d78951a	238	struct lttng_ust_filter_bytecode {
2734ca65 CB	239	uint32_t len;
2734ca65 CB	240	uint32_t reloc_offset;
3f6fd224	241	uint64_t seqnum;
a5930599	242	char padding[LTTNG_UST_FILTER_PADDING];
2d78951a	243	char data[0];
b3f60bbf	244	} LTTNG_PACKED;
2d78951a	245
86e0c24e JI	246	#define LTTNG_UST_EXCLUSION_PADDING 32
	247	struct lttng_ust_event_exclusion {
	248	uint32_t count;
	249	char padding[LTTNG_UST_EXCLUSION_PADDING];
	250	char names[LTTNG_UST_SYM_NAME_LEN][0];
	251	} LTTNG_PACKED;
	252
9f3fdbc6 MD	253	#define _UST_CMD(minor) (minor)
	254	#define _UST_CMDR(minor, type) (minor)
	255	#define _UST_CMDW(minor, type) (minor)
	256
46050b1a MD	257	/* Handled by object descriptor */
	258	#define LTTNG_UST_RELEASE _UST_CMD(0x1)
	259
	260	/* Handled by object cmd */
	261
9f3fdbc6 MD	262	/* LTTng-UST commands */
	263	#define LTTNG_UST_SESSION _UST_CMD(0x40)
	264	#define LTTNG_UST_TRACER_VERSION \
	265	_UST_CMDR(0x41, struct lttng_ust_tracer_version)
	266	#define LTTNG_UST_TRACEPOINT_LIST _UST_CMD(0x42)
	267	#define LTTNG_UST_WAIT_QUIESCENT _UST_CMD(0x43)
11ff9c7d	268	#define LTTNG_UST_REGISTER_DONE _UST_CMD(0x44)
06d4f27e	269	#define LTTNG_UST_TRACEPOINT_FIELD_LIST _UST_CMD(0x45)
9f3fdbc6	270
46050b1a	271	/* Session FD commands */
9f3fdbc6 MD	272	#define LTTNG_UST_CHANNEL \
	273	_UST_CMDW(0x51, struct lttng_ust_channel)
	274	#define LTTNG_UST_SESSION_START _UST_CMD(0x52)
	275	#define LTTNG_UST_SESSION_STOP _UST_CMD(0x53)
710b8ee3	276	#define LTTNG_UST_SESSION_STATEDUMP _UST_CMD(0x54)
9f3fdbc6	277
46050b1a	278	/* Channel FD commands */
9f3fdbc6 MD	279	#define LTTNG_UST_STREAM _UST_CMD(0x60)
	280	#define LTTNG_UST_EVENT \
	281	_UST_CMDW(0x61, struct lttng_ust_event)
	282
46050b1a	283	/* Event and Channel FD commands */
9f3fdbc6 MD	284	#define LTTNG_UST_CONTEXT \
9f3fdbc6 MD	285	_UST_CMDW(0x70, struct lttng_ust_context)
43d330a4	286	#define LTTNG_UST_FLUSH_BUFFER \
43861eab	287	_UST_CMD(0x71)
9f3fdbc6	288
46050b1a	289	/* Event, Channel and Session commands */
9f3fdbc6 MD	290	#define LTTNG_UST_ENABLE _UST_CMD(0x80)
	291	#define LTTNG_UST_DISABLE _UST_CMD(0x81)
	292
51489cad MD	293	/* Tracepoint list commands */
51489cad MD	294	#define LTTNG_UST_TRACEPOINT_LIST_GET _UST_CMD(0x90)
06d4f27e	295	#define LTTNG_UST_TRACEPOINT_FIELD_LIST_GET _UST_CMD(0x91)
51489cad	296
2d78951a MD	297	/* Event FD commands */
2d78951a MD	298	#define LTTNG_UST_FILTER _UST_CMD(0xA0)
75582b3a	299	#define LTTNG_UST_EXCLUSION _UST_CMD(0xA1)
2d78951a	300
46050b1a MD	301	#define LTTNG_UST_ROOT_HANDLE 0
46050b1a MD	302
b61ce3b2	303	struct lttng_ust_obj;
46050b1a	304
ef9ff354 MD	305	union ust_args {
ef9ff354 MD	306	struct {
74d81a6c	307	void *chan_data;
ff0f5728	308	int wakeup_fd;
ef9ff354 MD	309	} channel;
ef9ff354 MD	310	struct {
74d81a6c MD	311	int shm_fd;
74d81a6c MD	312	int wakeup_fd;
ef9ff354	313	} stream;
40003310 MD	314	struct {
	315	struct lttng_ust_field_iter entry;
	316	} field_list;
8e696cfa MD	317	struct {
	318	char *ctxname;
	319	} app_context;
ef9ff354 MD	320	};
ef9ff354 MD	321
b61ce3b2	322	struct lttng_ust_objd_ops {
ef9ff354	323	long (*cmd)(int objd, unsigned int cmd, unsigned long arg,
f59ed768	324	union ust_args args, void owner);
46050b1a MD	325	int (*release)(int objd);
	326	};
	327
	328	/* Create root handle. Always ID 0. */
	329	int lttng_abi_create_root_handle(void);
	330
b61ce3b2	331	const struct lttng_ust_objd_ops *objd_ops(int id);
1849ef7c	332	int lttng_ust_objd_unref(int id, int is_owner);
46050b1a MD	333
46050b1a MD	334	void lttng_ust_abi_exit(void);
003fedf4	335	void lttng_ust_events_exit(void);
f59ed768	336	void lttng_ust_objd_table_owner_cleanup(void *owner);
b35d179d	337
9f3fdbc6	338	#endif /* _LTTNG_UST_ABI_H */