[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_TRIGGER_PADDING1	16
#define LTTNG_UST_TRIGGER_PADDING2	(LTTNG_UST_SYM_NAME_LEN + 32)
struct lttng_ust_trigger {
	uint64_t id;
	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_TRIGGER_PADDING1];

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

#define LTTNG_TRIGGER_NOTIFICATION_PADDING 32
struct lttng_ust_trigger_notification {
	uint64_t id;
	uint16_t capture_buf_size;
	char padding[LTTNG_TRIGGER_NOTIFICATION_PADDING];
} 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,
};

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,
	LTTNG_UST_OBJECT_TYPE_TRIGGER_GROUP = 4,
	LTTNG_UST_OBJECT_TYPE_TRIGGER = 5,
};

#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 CAPTURE_BYTECODE_MAX_LEN	65536
#define LTTNG_UST_CAPTURE_PADDING	32
struct lttng_ust_capture_bytecode {
	uint32_t len;
	uint32_t reloc_offset;
	uint64_t seqnum;
	char padding[LTTNG_UST_CAPTURE_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)

/* Trigger commands */
#define LTTNG_UST_TRIGGER_GROUP_CREATE		_UST_CMD(0xB0)
#define LTTNG_UST_TRIGGER_CREATE		\
	_UST_CMDW(0xB1, struct lttng_ust_trigger)
#define LTTNG_UST_CAPTURE			_UST_CMD(0xB2)

#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 {
		int trigger_notif_fd;
	} trigger_handle;
};

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
db56acaf MD	33	#ifndef LTTNG_PACKED
	34	#error "LTTNG_PACKED should be defined"
	35	#endif
	36
32ce8569 MD	37	#ifndef __ust_stringify
	38	#define __ust_stringify1(x) #x
	39	#define __ust_stringify(x) __ust_stringify1(x)
	40	#endif /* __ust_stringify */
9f3fdbc6	41
32ce8569 MD	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
b35d179d	47
0f4eaec3	48	/* Version for ABI between liblttng-ust, sessiond, consumerd */
6a359b8a MD	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
0f4eaec3	52
9f3fdbc6	53	enum lttng_ust_instrumentation {
df854e41 MD	54	LTTNG_UST_TRACEPOINT = 0,
	55	LTTNG_UST_PROBE = 1,
	56	LTTNG_UST_FUNCTION = 2,
6b0e60f1 MD	57	};
	58
	59	enum lttng_ust_loglevel_type {
882a56d7 MD	60	LTTNG_UST_LOGLEVEL_ALL = 0,
	61	LTTNG_UST_LOGLEVEL_RANGE = 1,
	62	LTTNG_UST_LOGLEVEL_SINGLE = 2,
9f3fdbc6 MD	63	};
9f3fdbc6 MD	64
9f3fdbc6	65	enum lttng_ust_output {
b35d179d	66	LTTNG_UST_MMAP = 0,
9f3fdbc6 MD	67	};
9f3fdbc6 MD	68
74d81a6c MD	69	enum lttng_ust_chan_type {
	70	LTTNG_UST_CHAN_PER_CPU = 0,
	71	LTTNG_UST_CHAN_METADATA = 1,
	72	};
	73
b35d179d	74	struct lttng_ust_tracer_version {
b728d87e MD	75	uint32_t major;
b728d87e MD	76	uint32_t minor;
b35d179d	77	uint32_t patchlevel;
b3f60bbf	78	} LTTNG_PACKED;
9f3fdbc6	79
74d81a6c MD	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
9f3fdbc6	88	struct lttng_ust_channel {
74d81a6c MD	89	uint64_t len;
74d81a6c MD	90	enum lttng_ust_chan_type type;
1332bb04	91	char padding[LTTNG_UST_CHANNEL_PADDING];
74d81a6c	92	char data[]; /* variable sized data */
b3f60bbf	93	} LTTNG_PACKED;
9f3fdbc6	94
74d81a6c	95	#define LTTNG_UST_STREAM_PADDING1 (LTTNG_UST_SYM_NAME_LEN + 32)
381c0f1e	96	struct lttng_ust_stream {
74d81a6c MD	97	uint64_t len; /* shm len */
74d81a6c MD	98	uint32_t stream_nr; /* stream number */
1332bb04	99	char padding[LTTNG_UST_STREAM_PADDING1];
74d81a6c MD	100	/*
	101	* shm_fd and wakeup_fd are send over unix socket as file
	102	* descriptors after this structure.
	103	*/
b3f60bbf	104	} LTTNG_PACKED;
381c0f1e	105
cb11f03a FD	106	#define LTTNG_UST_TRIGGER_PADDING1 16
	107	#define LTTNG_UST_TRIGGER_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
	108	struct lttng_ust_trigger {
	109	uint64_t id;
	110	enum lttng_ust_instrumentation instrumentation;
	111	char name[LTTNG_UST_SYM_NAME_LEN]; /* event name */
	112
	113	enum lttng_ust_loglevel_type loglevel_type;
	114	int loglevel; /* value, -1: all */
	115	char padding[LTTNG_UST_TRIGGER_PADDING1];
	116
	117	/* Per instrumentation type configuration */
	118	union {
	119	char padding[LTTNG_UST_TRIGGER_PADDING2];
	120	} u;
	121	} LTTNG_PACKED;
	122
	123	#define LTTNG_TRIGGER_NOTIFICATION_PADDING 32
	124	struct lttng_ust_trigger_notification {
	125	uint64_t id;
	126	uint16_t capture_buf_size;
	127	char padding[LTTNG_TRIGGER_NOTIFICATION_PADDING];
	128	} LTTNG_PACKED;
	129
89f26d57	130	#define LTTNG_UST_EVENT_PADDING1 16
74d81a6c	131	#define LTTNG_UST_EVENT_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
9f3fdbc6	132	struct lttng_ust_event {
9f3fdbc6	133	enum lttng_ust_instrumentation instrumentation;
6b0e60f1 MD	134	char name[LTTNG_UST_SYM_NAME_LEN]; /* event name */
	135
	136	enum lttng_ust_loglevel_type loglevel_type;
882a56d7	137	int loglevel; /* value, -1: all */
1332bb04	138	char padding[LTTNG_UST_EVENT_PADDING1];
6b0e60f1	139
9f3fdbc6 MD	140	/* Per instrumentation type configuration */
9f3fdbc6 MD	141	union {
1332bb04	142	char padding[LTTNG_UST_EVENT_PADDING2];
9f3fdbc6	143	} u;
b3f60bbf	144	} LTTNG_PACKED;
9f3fdbc6	145
06d4f27e MD	146	enum lttng_ust_field_type {
	147	LTTNG_UST_FIELD_OTHER = 0,
	148	LTTNG_UST_FIELD_INTEGER = 1,
	149	LTTNG_UST_FIELD_ENUM = 2,
	150	LTTNG_UST_FIELD_FLOAT = 3,
	151	LTTNG_UST_FIELD_STRING = 4,
	152	};
	153
74d81a6c	154	#define LTTNG_UST_FIELD_ITER_PADDING (LTTNG_UST_SYM_NAME_LEN + 28)
06d4f27e MD	155	struct lttng_ust_field_iter {
	156	char event_name[LTTNG_UST_SYM_NAME_LEN];
	157	char field_name[LTTNG_UST_SYM_NAME_LEN];
	158	enum lttng_ust_field_type type;
	159	int loglevel; /* event loglevel */
180901e6	160	int nowrite;
06d4f27e	161	char padding[LTTNG_UST_FIELD_ITER_PADDING];
b3f60bbf	162	} LTTNG_PACKED;
06d4f27e	163
9f3fdbc6	164	enum lttng_ust_context_type {
3b402b40	165	LTTNG_UST_CONTEXT_VTID = 0,
c1ef86f0 MD	166	LTTNG_UST_CONTEXT_VPID = 1,
c1ef86f0 MD	167	LTTNG_UST_CONTEXT_PTHREAD_ID = 2,
4847e9bb	168	LTTNG_UST_CONTEXT_PROCNAME = 3,
96f85541	169	LTTNG_UST_CONTEXT_IP = 4,
d58d1454	170	LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER = 5,
c7ea8487	171	LTTNG_UST_CONTEXT_CPU_ID = 6,
53f0df51	172	LTTNG_UST_CONTEXT_APP_CONTEXT = 7,
735bef47 MJ	173	LTTNG_UST_CONTEXT_CGROUP_NS = 8,
	174	LTTNG_UST_CONTEXT_IPC_NS = 9,
	175	LTTNG_UST_CONTEXT_MNT_NS = 10,
	176	LTTNG_UST_CONTEXT_NET_NS = 11,
	177	LTTNG_UST_CONTEXT_PID_NS = 12,
	178	LTTNG_UST_CONTEXT_USER_NS = 13,
	179	LTTNG_UST_CONTEXT_UTS_NS = 14,
fca2f191 MJ	180	LTTNG_UST_CONTEXT_VUID = 15,
	181	LTTNG_UST_CONTEXT_VEUID = 16,
	182	LTTNG_UST_CONTEXT_VSUID = 17,
	183	LTTNG_UST_CONTEXT_VGID = 18,
	184	LTTNG_UST_CONTEXT_VEGID = 19,
	185	LTTNG_UST_CONTEXT_VSGID = 20,
9f3fdbc6 MD	186	};
9f3fdbc6 MD	187
d58d1454 MD	188	struct lttng_ust_perf_counter_ctx {
	189	uint32_t type;
	190	uint64_t config;
	191	char name[LTTNG_UST_SYM_NAME_LEN];
	192	} LTTNG_PACKED;
	193
1332bb04	194	#define LTTNG_UST_CONTEXT_PADDING1 16
74d81a6c	195	#define LTTNG_UST_CONTEXT_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
9f3fdbc6 MD	196	struct lttng_ust_context {
9f3fdbc6 MD	197	enum lttng_ust_context_type ctx;
1332bb04 MD	198	char padding[LTTNG_UST_CONTEXT_PADDING1];
1332bb04 MD	199
9f3fdbc6	200	union {
d58d1454	201	struct lttng_ust_perf_counter_ctx perf_counter;
53f0df51 JG	202	struct {
	203	/* Includes trailing '\0'. */
	204	uint32_t provider_name_len;
	205	uint32_t ctx_name_len;
	206	} app_ctx;
1332bb04	207	char padding[LTTNG_UST_CONTEXT_PADDING2];
9f3fdbc6	208	} u;
b3f60bbf	209	} LTTNG_PACKED;
9f3fdbc6	210
92462b01 MD	211	/*
	212	* Tracer channel attributes.
	213	*/
74d81a6c	214	#define LTTNG_UST_CHANNEL_ATTR_PADDING (LTTNG_UST_SYM_NAME_LEN + 32)
92462b01	215	struct lttng_ust_channel_attr {
92462b01 MD	216	uint64_t subbuf_size; /* bytes */
92462b01 MD	217	uint64_t num_subbuf; /* power of 2 */
b3f60bbf	218	int overwrite; /* 1: overwrite, 0: discard */
92462b01 MD	219	unsigned int switch_timer_interval; /* usec */
	220	unsigned int read_timer_interval; /* usec */
	221	enum lttng_ust_output output; /* splice, mmap */
b2c5f61a MD	222	union {
	223	struct {
	224	int64_t blocking_timeout; /* Blocking timeout (usec) */
	225	} s;
	226	char padding[LTTNG_UST_CHANNEL_ATTR_PADDING];
	227	} u;
b3f60bbf	228	} LTTNG_PACKED;
92462b01	229
1332bb04	230	#define LTTNG_UST_TRACEPOINT_ITER_PADDING 16
cbef6901 MD	231	struct lttng_ust_tracepoint_iter {
cbef6901 MD	232	char name[LTTNG_UST_SYM_NAME_LEN]; /* provider:name */
882a56d7	233	int loglevel;
1332bb04	234	char padding[LTTNG_UST_TRACEPOINT_ITER_PADDING];
b3f60bbf	235	} LTTNG_PACKED;
cbef6901	236
74d81a6c MD	237	enum lttng_ust_object_type {
	238	LTTNG_UST_OBJECT_TYPE_UNKNOWN = -1,
	239	LTTNG_UST_OBJECT_TYPE_CHANNEL = 0,
	240	LTTNG_UST_OBJECT_TYPE_STREAM = 1,
32ce8569 MD	241	LTTNG_UST_OBJECT_TYPE_EVENT = 2,
32ce8569 MD	242	LTTNG_UST_OBJECT_TYPE_CONTEXT = 3,
cb11f03a FD	243	LTTNG_UST_OBJECT_TYPE_TRIGGER_GROUP = 4,
cb11f03a FD	244	LTTNG_UST_OBJECT_TYPE_TRIGGER = 5,
74d81a6c MD	245	};
	246
	247	#define LTTNG_UST_OBJECT_DATA_PADDING1 32
	248	#define LTTNG_UST_OBJECT_DATA_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
	249
92462b01	250	struct lttng_ust_object_data {
74d81a6c	251	enum lttng_ust_object_type type;
92462b01	252	int handle;
74d81a6c MD	253	uint64_t size;
	254	char padding1[LTTNG_UST_OBJECT_DATA_PADDING1];
	255	union {
	256	struct {
	257	void *data;
	258	enum lttng_ust_chan_type type;
ff0f5728	259	int wakeup_fd;
74d81a6c MD	260	} channel;
	261	struct {
	262	int shm_fd;
	263	int wakeup_fd;
	264	uint32_t stream_nr;
	265	} stream;
	266	char padding2[LTTNG_UST_OBJECT_DATA_PADDING2];
	267	} u;
b3f60bbf	268	} LTTNG_PACKED;
92462b01	269
d9a9a33b MD	270	enum lttng_ust_calibrate_type {
	271	LTTNG_UST_CALIBRATE_TRACEPOINT,
	272	};
	273
1332bb04	274	#define LTTNG_UST_CALIBRATE_PADDING1 16
74d81a6c	275	#define LTTNG_UST_CALIBRATE_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
d9a9a33b MD	276	struct lttng_ust_calibrate {
d9a9a33b MD	277	enum lttng_ust_calibrate_type type; /* type (input) */
1332bb04 MD	278	char padding[LTTNG_UST_CALIBRATE_PADDING1];
	279
	280	union {
	281	char padding[LTTNG_UST_CALIBRATE_PADDING2];
	282	} u;
b3f60bbf	283	} LTTNG_PACKED;
d9a9a33b	284
5b4839a8	285	#define FILTER_BYTECODE_MAX_LEN 65536
a5930599	286	#define LTTNG_UST_FILTER_PADDING 32
2d78951a	287	struct lttng_ust_filter_bytecode {
2734ca65 CB	288	uint32_t len;
2734ca65 CB	289	uint32_t reloc_offset;
3f6fd224	290	uint64_t seqnum;
a5930599	291	char padding[LTTNG_UST_FILTER_PADDING];
2d78951a	292	char data[0];
b3f60bbf	293	} LTTNG_PACKED;
2d78951a	294
cb11f03a FD	295	#define CAPTURE_BYTECODE_MAX_LEN 65536
	296	#define LTTNG_UST_CAPTURE_PADDING 32
	297	struct lttng_ust_capture_bytecode {
	298	uint32_t len;
	299	uint32_t reloc_offset;
	300	uint64_t seqnum;
	301	char padding[LTTNG_UST_CAPTURE_PADDING];
	302	char data[0];
	303	} LTTNG_PACKED;
	304
86e0c24e JI	305	#define LTTNG_UST_EXCLUSION_PADDING 32
	306	struct lttng_ust_event_exclusion {
	307	uint32_t count;
	308	char padding[LTTNG_UST_EXCLUSION_PADDING];
	309	char names[LTTNG_UST_SYM_NAME_LEN][0];
	310	} LTTNG_PACKED;
	311
9f3fdbc6 MD	312	#define _UST_CMD(minor) (minor)
	313	#define _UST_CMDR(minor, type) (minor)
	314	#define _UST_CMDW(minor, type) (minor)
	315
46050b1a MD	316	/* Handled by object descriptor */
	317	#define LTTNG_UST_RELEASE _UST_CMD(0x1)
	318
	319	/* Handled by object cmd */
	320
9f3fdbc6 MD	321	/* LTTng-UST commands */
	322	#define LTTNG_UST_SESSION _UST_CMD(0x40)
	323	#define LTTNG_UST_TRACER_VERSION \
	324	_UST_CMDR(0x41, struct lttng_ust_tracer_version)
	325	#define LTTNG_UST_TRACEPOINT_LIST _UST_CMD(0x42)
	326	#define LTTNG_UST_WAIT_QUIESCENT _UST_CMD(0x43)
11ff9c7d	327	#define LTTNG_UST_REGISTER_DONE _UST_CMD(0x44)
06d4f27e	328	#define LTTNG_UST_TRACEPOINT_FIELD_LIST _UST_CMD(0x45)
9f3fdbc6	329
46050b1a	330	/* Session FD commands */
9f3fdbc6 MD	331	#define LTTNG_UST_CHANNEL \
	332	_UST_CMDW(0x51, struct lttng_ust_channel)
	333	#define LTTNG_UST_SESSION_START _UST_CMD(0x52)
	334	#define LTTNG_UST_SESSION_STOP _UST_CMD(0x53)
710b8ee3	335	#define LTTNG_UST_SESSION_STATEDUMP _UST_CMD(0x54)
9f3fdbc6	336
46050b1a	337	/* Channel FD commands */
9f3fdbc6 MD	338	#define LTTNG_UST_STREAM _UST_CMD(0x60)
	339	#define LTTNG_UST_EVENT \
	340	_UST_CMDW(0x61, struct lttng_ust_event)
	341
46050b1a	342	/* Event and Channel FD commands */
9f3fdbc6 MD	343	#define LTTNG_UST_CONTEXT \
9f3fdbc6 MD	344	_UST_CMDW(0x70, struct lttng_ust_context)
43d330a4	345	#define LTTNG_UST_FLUSH_BUFFER \
43861eab	346	_UST_CMD(0x71)
9f3fdbc6	347
46050b1a	348	/* Event, Channel and Session commands */
9f3fdbc6 MD	349	#define LTTNG_UST_ENABLE _UST_CMD(0x80)
	350	#define LTTNG_UST_DISABLE _UST_CMD(0x81)
	351
51489cad MD	352	/* Tracepoint list commands */
51489cad MD	353	#define LTTNG_UST_TRACEPOINT_LIST_GET _UST_CMD(0x90)
06d4f27e	354	#define LTTNG_UST_TRACEPOINT_FIELD_LIST_GET _UST_CMD(0x91)
51489cad	355
2d78951a MD	356	/* Event FD commands */
2d78951a MD	357	#define LTTNG_UST_FILTER _UST_CMD(0xA0)
75582b3a	358	#define LTTNG_UST_EXCLUSION _UST_CMD(0xA1)
2d78951a	359
cb11f03a FD	360	/* Trigger commands */
	361	#define LTTNG_UST_TRIGGER_GROUP_CREATE _UST_CMD(0xB0)
	362	#define LTTNG_UST_TRIGGER_CREATE \
	363	_UST_CMDW(0xB1, struct lttng_ust_trigger)
	364	#define LTTNG_UST_CAPTURE _UST_CMD(0xB2)
	365
46050b1a MD	366	#define LTTNG_UST_ROOT_HANDLE 0
46050b1a MD	367
b61ce3b2	368	struct lttng_ust_obj;
46050b1a	369
ef9ff354 MD	370	union ust_args {
ef9ff354 MD	371	struct {
74d81a6c	372	void *chan_data;
ff0f5728	373	int wakeup_fd;
ef9ff354 MD	374	} channel;
ef9ff354 MD	375	struct {
74d81a6c MD	376	int shm_fd;
74d81a6c MD	377	int wakeup_fd;
ef9ff354	378	} stream;
40003310 MD	379	struct {
	380	struct lttng_ust_field_iter entry;
	381	} field_list;
8e696cfa MD	382	struct {
	383	char *ctxname;
	384	} app_context;
cb11f03a FD	385	struct {
	386	int trigger_notif_fd;
	387	} trigger_handle;
ef9ff354 MD	388	};
ef9ff354 MD	389
b61ce3b2	390	struct lttng_ust_objd_ops {
ef9ff354	391	long (*cmd)(int objd, unsigned int cmd, unsigned long arg,
f59ed768	392	union ust_args args, void owner);
46050b1a MD	393	int (*release)(int objd);
	394	};
	395
	396	/* Create root handle. Always ID 0. */
	397	int lttng_abi_create_root_handle(void);
	398
b61ce3b2	399	const struct lttng_ust_objd_ops *objd_ops(int id);
1849ef7c	400	int lttng_ust_objd_unref(int id, int is_owner);
46050b1a MD	401
46050b1a MD	402	void lttng_ust_abi_exit(void);
003fedf4	403	void lttng_ust_events_exit(void);
f59ed768	404	void lttng_ust_objd_table_owner_cleanup(void *owner);
b35d179d	405
9f3fdbc6	406	#endif /* _LTTNG_UST_ABI_H */