[lttng-tools.git] / src / common / sessiond-comm / sessiond-comm.h

/*
 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
 *                      Julien Desfossez <julien.desfossez@polymtl.ca>
 *                      Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License, version 2 only,
 * as published by the Free Software Foundation.
 * 
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 * 
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

/*
 * This header is meant for liblttng and libust internal use ONLY. These
 * declarations should NOT be considered stable API.
 */

#ifndef _LTTNG_SESSIOND_COMM_H
#define _LTTNG_SESSIOND_COMM_H

#define _GNU_SOURCE
#include <limits.h>
#include <lttng/lttng.h>
#include <common/compat/socket.h>
#include <common/uri.h>
#include <common/defaults.h>
#include <common/compat/uuid.h>

#include <arpa/inet.h>
#include <netinet/in.h>
#include <sys/un.h>

#include "inet.h"
#include "inet6.h"
#include "unix.h"

/* Queue size of listen(2) */
#define LTTNG_SESSIOND_COMM_MAX_LISTEN 64

/* Maximum number of FDs that can be sent over a Unix socket */
#define LTTCOMM_MAX_SEND_FDS           4

/*
 * Get the error code index from 0 since LTTCOMM_OK start at 1000
 */
#define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_CONSUMERD_COMMAND_SOCK_READY)

enum lttcomm_sessiond_command {
	/* Tracer command */
	LTTNG_ADD_CONTEXT                   = 0,
	LTTNG_CALIBRATE                     = 1,
	LTTNG_DISABLE_CHANNEL               = 2,
	LTTNG_DISABLE_EVENT                 = 3,
	LTTNG_DISABLE_ALL_EVENT             = 4,
	LTTNG_ENABLE_CHANNEL                = 5,
	LTTNG_ENABLE_EVENT                  = 6,
	LTTNG_ENABLE_ALL_EVENT              = 7,
	/* Session daemon command */
	LTTNG_CREATE_SESSION                = 8,
	LTTNG_DESTROY_SESSION               = 9,
	LTTNG_LIST_CHANNELS                 = 10,
	LTTNG_LIST_DOMAINS                  = 11,
	LTTNG_LIST_EVENTS                   = 12,
	LTTNG_LIST_SESSIONS                 = 13,
	LTTNG_LIST_TRACEPOINTS              = 14,
	LTTNG_REGISTER_CONSUMER             = 15,
	LTTNG_START_TRACE                   = 16,
	LTTNG_STOP_TRACE                    = 17,
	LTTNG_LIST_TRACEPOINT_FIELDS        = 18,

	/* Consumer */
	LTTNG_DISABLE_CONSUMER              = 19,
	LTTNG_ENABLE_CONSUMER               = 20,
	LTTNG_SET_CONSUMER_URI              = 21,
	LTTNG_ENABLE_EVENT_WITH_FILTER      = 22,
	LTTNG_HEALTH_CHECK                  = 23,
	LTTNG_DATA_PENDING                  = 24,
};

enum lttcomm_relayd_command {
	RELAYD_ADD_STREAM                   = 1,
	RELAYD_CREATE_SESSION               = 2,
	RELAYD_START_DATA                   = 3,
	RELAYD_UPDATE_SYNC_INFO             = 4,
	RELAYD_VERSION                      = 5,
	RELAYD_SEND_METADATA                = 6,
	RELAYD_CLOSE_STREAM                 = 7,
	RELAYD_DATA_PENDING                 = 8,
	RELAYD_QUIESCENT_CONTROL            = 9,
	RELAYD_BEGIN_DATA_PENDING           = 10,
	RELAYD_END_DATA_PENDING             = 11,
};

/*
 * lttcomm error code.
 */
enum lttcomm_return_code {
	LTTCOMM_CONSUMERD_COMMAND_SOCK_READY = 1,   /* Command socket ready */
	LTTCOMM_CONSUMERD_SUCCESS_RECV_FD,          /* Success on receiving fds */
	LTTCOMM_CONSUMERD_ERROR_RECV_FD,            /* Error on receiving fds */
	LTTCOMM_CONSUMERD_ERROR_RECV_CMD,           /* Error on receiving command */
	LTTCOMM_CONSUMERD_POLL_ERROR,               /* Error in polling thread */
	LTTCOMM_CONSUMERD_POLL_NVAL,                /* Poll on closed fd */
	LTTCOMM_CONSUMERD_POLL_HUP,                 /* All fds have hungup */
	LTTCOMM_CONSUMERD_EXIT_SUCCESS,             /* Consumerd exiting normally */
	LTTCOMM_CONSUMERD_EXIT_FAILURE,             /* Consumerd exiting on error */
	LTTCOMM_CONSUMERD_OUTFD_ERROR,              /* Error opening the tracefile */
	LTTCOMM_CONSUMERD_SPLICE_EBADF,             /* EBADF from splice(2) */
	LTTCOMM_CONSUMERD_SPLICE_EINVAL,            /* EINVAL from splice(2) */
	LTTCOMM_CONSUMERD_SPLICE_ENOMEM,            /* ENOMEM from splice(2) */
	LTTCOMM_CONSUMERD_SPLICE_ESPIPE,            /* ESPIPE from splice(2) */
	LTTCOMM_CONSUMERD_ENOMEM,                   /* Consumer is out of memory */

	/* MUST be last element */
	LTTCOMM_NR,						/* Last element */
};

/* lttng socket protocol. */
enum lttcomm_sock_proto {
	LTTCOMM_SOCK_UDP,
	LTTCOMM_SOCK_TCP,
};

/*
 * Index in the net_families array below. Please keep in sync!
 */
enum lttcomm_sock_domain {
	LTTCOMM_INET      = 0,
	LTTCOMM_INET6     = 1,
};

struct lttcomm_sockaddr {
	enum lttcomm_sock_domain type;
	union {
		struct sockaddr_in sin;
		struct sockaddr_in6 sin6;
	} addr;
} LTTNG_PACKED;

struct lttcomm_sock {
	int fd;
	enum lttcomm_sock_proto proto;
	struct lttcomm_sockaddr sockaddr;
	const struct lttcomm_proto_ops *ops;
} LTTNG_PACKED;

struct lttcomm_net_family {
	int family;
	int (*create) (struct lttcomm_sock *sock, int type, int proto);
};

struct lttcomm_proto_ops {
	int (*bind) (struct lttcomm_sock *sock);
	int (*close) (struct lttcomm_sock *sock);
	int (*connect) (struct lttcomm_sock *sock);
	struct lttcomm_sock *(*accept) (struct lttcomm_sock *sock);
	int (*listen) (struct lttcomm_sock *sock, int backlog);
	ssize_t (*recvmsg) (struct lttcomm_sock *sock, void *buf, size_t len,
			int flags);
	ssize_t (*sendmsg) (struct lttcomm_sock *sock, void *buf, size_t len,
			int flags);
};

/*
 * Data structure received from lttng client to session daemon.
 */
struct lttcomm_session_msg {
	uint32_t cmd_type;	/* enum lttcomm_sessiond_command */
	struct lttng_session session;
	struct lttng_domain domain;
	union {
		struct {
			char channel_name[LTTNG_SYMBOL_NAME_LEN];
			char name[NAME_MAX];
		} LTTNG_PACKED disable;
		/* Event data */
		struct {
			char channel_name[LTTNG_SYMBOL_NAME_LEN];
			struct lttng_event event;
			/* Length of following bytecode for filter. */
			uint32_t bytecode_len;
		} LTTNG_PACKED enable;
		/* Create channel */
		struct {
			struct lttng_channel chan;
		} LTTNG_PACKED channel;
		/* Context */
		struct {
			char channel_name[LTTNG_SYMBOL_NAME_LEN];
			struct lttng_event_context ctx;
		} LTTNG_PACKED context;
		/* Use by register_consumer */
		struct {
			char path[PATH_MAX];
		} LTTNG_PACKED reg;
		/* List */
		struct {
			char channel_name[LTTNG_SYMBOL_NAME_LEN];
		} LTTNG_PACKED list;
		struct lttng_calibrate calibrate;
		/* Used by the set_consumer_url and used by create_session also call */
		struct {
			/* Number of lttng_uri following */
			uint32_t size;
		} LTTNG_PACKED uri;
	} u;
} LTTNG_PACKED;

#define LTTNG_FILTER_MAX_LEN	65536

/*
 * Filter bytecode data. The reloc table is located at the end of the
 * bytecode. It is made of tuples: (uint16_t, var. len. string). It
 * starts at reloc_table_offset.
 */
#define LTTNG_FILTER_PADDING	32
struct lttng_filter_bytecode {
	uint32_t len;	/* len of data */
	uint32_t reloc_table_offset;
	uint64_t seqnum;
	char padding[LTTNG_FILTER_PADDING];
	char data[0];
} LTTNG_PACKED;

/*
 * Data structure for the response from sessiond to the lttng client.
 */
struct lttcomm_lttng_msg {
	uint32_t cmd_type;	/* enum lttcomm_sessiond_command */
	uint32_t ret_code;	/* enum lttcomm_return_code */
	uint32_t pid;		/* pid_t */
	uint32_t data_size;
	/* Contains: trace_name + data */
	char payload[];
} LTTNG_PACKED;

struct lttcomm_health_msg {
	uint32_t component;
	uint32_t cmd;
} LTTNG_PACKED;

struct lttcomm_health_data {
	uint32_t ret_code;
} LTTNG_PACKED;

/*
 * lttcomm_consumer_msg is the message sent from sessiond to consumerd
 * to either add a channel, add a stream, update a stream, or stop
 * operation.
 */
struct lttcomm_consumer_msg {
	uint32_t cmd_type;	/* enum consumerd_command */
	union {
		struct {
			int channel_key;
			uint64_t session_id;
			char pathname[PATH_MAX];
			uid_t uid;
			gid_t gid;
			int relayd_id;
			/* nb_init_streams is the number of streams open initially. */
			unsigned int nb_init_streams;
			char name[LTTNG_SYMBOL_NAME_LEN];
			/* Use splice or mmap to consume this fd */
			enum lttng_event_output output;
			int type; /* Per cpu or metadata. */
		} LTTNG_PACKED channel; /* Only used by Kernel. */
		struct {
			int stream_key;
			int channel_key;
			int cpu;	/* On which CPU this stream is assigned. */
		} LTTNG_PACKED stream;	/* Only used by Kernel. */
		struct {
			int net_index;
			enum lttng_stream_type type;
			/* Open socket to the relayd */
			struct lttcomm_sock sock;
			/* Tracing session id associated to the relayd. */
			uint64_t session_id;
		} LTTNG_PACKED relayd_sock;
		struct {
			uint64_t net_seq_idx;
		} LTTNG_PACKED destroy_relayd;
		struct {
			uint64_t session_id;
		} LTTNG_PACKED data_pending;
		struct {
			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 */
			int output;				/* splice, mmap */
			int type;				/* metadata or per_cpu */
			uint64_t session_id;			/* Tracing session id */
			char pathname[PATH_MAX];		/* Channel file path. */
			char name[LTTNG_SYMBOL_NAME_LEN];	/* Channel name. */
			uid_t uid;				/* User ID of the session */
			gid_t gid;				/* Group ID ot the session */
			int relayd_id;				/* Relayd id if apply. */
			unsigned long key;					/* Unique channel key. */
			unsigned char uuid[UUID_STR_LEN];	/* uuid for ust tracer. */
		} LTTNG_PACKED ask_channel;
		struct {
			unsigned long key;
		} LTTNG_PACKED get_channel;
		struct {
			unsigned long key;
		} LTTNG_PACKED destroy_channel;
	} u;
} LTTNG_PACKED;

/*
 * Status message returned to the sessiond after a received command.
 */
struct lttcomm_consumer_status_msg {
	enum lttng_error_code ret_code;
} LTTNG_PACKED;

struct lttcomm_consumer_status_channel {
	enum lttng_error_code ret_code;
	unsigned long key;
	unsigned int stream_count;
} LTTNG_PACKED;

#ifdef HAVE_LIBLTTNG_UST_CTL

#include <lttng/ust-abi.h>

/*
 * Data structure for the commands sent from sessiond to UST.
 */
struct lttcomm_ust_msg {
	uint32_t handle;
	uint32_t cmd;
	union {
		struct lttng_ust_channel channel;
		struct lttng_ust_stream stream;
		struct lttng_ust_event event;
		struct lttng_ust_context context;
		struct lttng_ust_tracer_version version;
	} u;
} LTTNG_PACKED;

/*
 * Data structure for the response from UST to the session daemon.
 * cmd_type is sent back in the reply for validation.
 */
struct lttcomm_ust_reply {
	uint32_t handle;
	uint32_t cmd;
	uint32_t ret_code;	/* enum lttcomm_return_code */
	uint32_t ret_val;	/* return value */
	union {
		struct {
			uint64_t memory_map_size;
		} LTTNG_PACKED channel;
		struct {
			uint64_t memory_map_size;
		} LTTNG_PACKED stream;
		struct lttng_ust_tracer_version version;
	} u;
} LTTNG_PACKED;

#endif /* HAVE_LIBLTTNG_UST_CTL */

extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);

extern int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr *sockaddr,
		const char *ip, unsigned int port);
extern int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr *sockaddr,
		const char *ip, unsigned int port);

extern struct lttcomm_sock *lttcomm_alloc_sock(enum lttcomm_sock_proto proto);
extern int lttcomm_create_sock(struct lttcomm_sock *sock);
extern struct lttcomm_sock *lttcomm_alloc_sock_from_uri(struct lttng_uri *uri);
extern void lttcomm_destroy_sock(struct lttcomm_sock *sock);
extern struct lttcomm_sock *lttcomm_alloc_copy_sock(struct lttcomm_sock *src);
extern void lttcomm_copy_sock(struct lttcomm_sock *dst,
		struct lttcomm_sock *src);

#endif	/* _LTTNG_SESSIOND_COMM_H */
Commit	Line	Data
6e3805e2 DG	1	/*
	2	* Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
	3	* Julien Desfossez <julien.desfossez@polymtl.ca>
773168b7	4	* Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
fac6795d	5	*
d14d33bf AM	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License, version 2 only,
	8	* as published by the Free Software Foundation.
fac6795d	9	*
990570ed DG	10	* This program is distributed in the hope that it will be useful, but WITHOUT
990570ed DG	11	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
d14d33bf	12	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
990570ed	13	* more details.
fac6795d	14	*
d14d33bf AM	15	* You should have received a copy of the GNU General Public License along
	16	* with this program; if not, write to the Free Software Foundation, Inc.,
	17	* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
fac6795d DG	18	*/
fac6795d DG	19
773168b7	20	/*
990570ed DG	21	* This header is meant for liblttng and libust internal use ONLY. These
990570ed DG	22	* declarations should NOT be considered stable API.
773168b7	23	*/
fac6795d	24
990570ed DG	25	#ifndef _LTTNG_SESSIOND_COMM_H
	26	#define _LTTNG_SESSIOND_COMM_H
	27
d19d9ada	28	#define _GNU_SOURCE
fac6795d	29	#include <limits.h>
f3ed775e	30	#include <lttng/lttng.h>
b17231c6	31	#include <common/compat/socket.h>
a4b92340	32	#include <common/uri.h>
ce2a9e76	33	#include <common/defaults.h>
ffe60014	34	#include <common/compat/uuid.h>
5e16da05	35
6364a07a DG	36	#include <arpa/inet.h>
	37	#include <netinet/in.h>
	38	#include <sys/un.h>
	39
	40	#include "inet.h"
	41	#include "inet6.h"
0d37f2bc DG	42	#include "unix.h"
0d37f2bc DG	43
fac6795d	44	/* Queue size of listen(2) */
f158a754	45	#define LTTNG_SESSIOND_COMM_MAX_LISTEN 64
fac6795d	46
990570ed DG	47	/* Maximum number of FDs that can be sent over a Unix socket */
	48	#define LTTCOMM_MAX_SEND_FDS 4
	49
3817e7df DG	50	/*
3817e7df DG	51	* Get the error code index from 0 since LTTCOMM_OK start at 1000
fac6795d	52	*/
f73fabfd	53	#define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_CONSUMERD_COMMAND_SOCK_READY)
fac6795d	54
6abb15de	55	enum lttcomm_sessiond_command {
0d0c377a	56	/* Tracer command */
7c9534d6 JD	57	LTTNG_ADD_CONTEXT = 0,
	58	LTTNG_CALIBRATE = 1,
	59	LTTNG_DISABLE_CHANNEL = 2,
	60	LTTNG_DISABLE_EVENT = 3,
	61	LTTNG_DISABLE_ALL_EVENT = 4,
	62	LTTNG_ENABLE_CHANNEL = 5,
	63	LTTNG_ENABLE_EVENT = 6,
	64	LTTNG_ENABLE_ALL_EVENT = 7,
0d0c377a	65	/* Session daemon command */
7c9534d6 JD	66	LTTNG_CREATE_SESSION = 8,
	67	LTTNG_DESTROY_SESSION = 9,
	68	LTTNG_LIST_CHANNELS = 10,
	69	LTTNG_LIST_DOMAINS = 11,
	70	LTTNG_LIST_EVENTS = 12,
	71	LTTNG_LIST_SESSIONS = 13,
	72	LTTNG_LIST_TRACEPOINTS = 14,
	73	LTTNG_REGISTER_CONSUMER = 15,
	74	LTTNG_START_TRACE = 16,
	75	LTTNG_STOP_TRACE = 17,
	76	LTTNG_LIST_TRACEPOINT_FIELDS = 18,
53a80697	77
de5e9086	78	/* Consumer */
7c9534d6 JD	79	LTTNG_DISABLE_CONSUMER = 19,
	80	LTTNG_ENABLE_CONSUMER = 20,
	81	LTTNG_SET_CONSUMER_URI = 21,
	82	LTTNG_ENABLE_EVENT_WITH_FILTER = 22,
	83	LTTNG_HEALTH_CHECK = 23,
	84	LTTNG_DATA_PENDING = 24,
	85	};
	86
	87	enum lttcomm_relayd_command {
	88	RELAYD_ADD_STREAM = 1,
	89	RELAYD_CREATE_SESSION = 2,
	90	RELAYD_START_DATA = 3,
	91	RELAYD_UPDATE_SYNC_INFO = 4,
	92	RELAYD_VERSION = 5,
	93	RELAYD_SEND_METADATA = 6,
	94	RELAYD_CLOSE_STREAM = 7,
	95	RELAYD_DATA_PENDING = 8,
	96	RELAYD_QUIESCENT_CONTROL = 9,
	97	RELAYD_BEGIN_DATA_PENDING = 10,
	98	RELAYD_END_DATA_PENDING = 11,
fac6795d DG	99	};
	100
	101	/*
	102	* lttcomm error code.
	103	*/
	104	enum lttcomm_return_code {
f73fabfd DG	105	LTTCOMM_CONSUMERD_COMMAND_SOCK_READY = 1, /* Command socket ready */
	106	LTTCOMM_CONSUMERD_SUCCESS_RECV_FD, /* Success on receiving fds */
	107	LTTCOMM_CONSUMERD_ERROR_RECV_FD, /* Error on receiving fds */
	108	LTTCOMM_CONSUMERD_ERROR_RECV_CMD, /* Error on receiving command */
	109	LTTCOMM_CONSUMERD_POLL_ERROR, /* Error in polling thread */
	110	LTTCOMM_CONSUMERD_POLL_NVAL, /* Poll on closed fd */
	111	LTTCOMM_CONSUMERD_POLL_HUP, /* All fds have hungup */
	112	LTTCOMM_CONSUMERD_EXIT_SUCCESS, /* Consumerd exiting normally */
	113	LTTCOMM_CONSUMERD_EXIT_FAILURE, /* Consumerd exiting on error */
	114	LTTCOMM_CONSUMERD_OUTFD_ERROR, /* Error opening the tracefile */
	115	LTTCOMM_CONSUMERD_SPLICE_EBADF, /* EBADF from splice(2) */
	116	LTTCOMM_CONSUMERD_SPLICE_EINVAL, /* EINVAL from splice(2) */
	117	LTTCOMM_CONSUMERD_SPLICE_ENOMEM, /* ENOMEM from splice(2) */
	118	LTTCOMM_CONSUMERD_SPLICE_ESPIPE, /* ESPIPE from splice(2) */
ffe60014	119	LTTCOMM_CONSUMERD_ENOMEM, /* Consumer is out of memory */
80e327fa	120
20fe2104 DG	121	/* MUST be last element */
20fe2104 DG	122	LTTCOMM_NR, /* Last element */
fac6795d DG	123	};
fac6795d DG	124
de5e9086 DG	125	/* lttng socket protocol. */
	126	enum lttcomm_sock_proto {
	127	LTTCOMM_SOCK_UDP,
	128	LTTCOMM_SOCK_TCP,
	129	};
	130
	131	/*
	132	* Index in the net_families array below. Please keep in sync!
	133	*/
	134	enum lttcomm_sock_domain {
01d0a631 CB	135	LTTCOMM_INET = 0,
01d0a631 CB	136	LTTCOMM_INET6 = 1,
de5e9086 DG	137	};
	138
	139	struct lttcomm_sockaddr {
	140	enum lttcomm_sock_domain type;
	141	union {
	142	struct sockaddr_in sin;
	143	struct sockaddr_in6 sin6;
	144	} addr;
fc5e05b7	145	} LTTNG_PACKED;
de5e9086 DG	146
	147	struct lttcomm_sock {
	148	int fd;
	149	enum lttcomm_sock_proto proto;
	150	struct lttcomm_sockaddr sockaddr;
	151	const struct lttcomm_proto_ops *ops;
fc5e05b7	152	} LTTNG_PACKED;
de5e9086 DG	153
	154	struct lttcomm_net_family {
	155	int family;
	156	int (create) (struct lttcomm_sock sock, int type, int proto);
	157	};
	158
	159	struct lttcomm_proto_ops {
	160	int (bind) (struct lttcomm_sock sock);
	161	int (close) (struct lttcomm_sock sock);
	162	int (connect) (struct lttcomm_sock sock);
	163	struct lttcomm_sock (accept) (struct lttcomm_sock *sock);
	164	int (listen) (struct lttcomm_sock sock, int backlog);
	165	ssize_t (recvmsg) (struct lttcomm_sock sock, void *buf, size_t len,
	166	int flags);
	167	ssize_t (sendmsg) (struct lttcomm_sock sock, void *buf, size_t len,
	168	int flags);
	169	};
	170
fac6795d	171	/*
9bda164d	172	* Data structure received from lttng client to session daemon.
fac6795d DG	173	*/
fac6795d DG	174	struct lttcomm_session_msg {
d0b96690	175	uint32_t cmd_type; /* enum lttcomm_sessiond_command */
42abccdb	176	struct lttng_session session;
9f19cc17	177	struct lttng_domain domain;
fac6795d DG	178	union {
fac6795d DG	179	struct {
db8870ed	180	char channel_name[LTTNG_SYMBOL_NAME_LEN];
f3ed775e	181	char name[NAME_MAX];
fc5e05b7	182	} LTTNG_PACKED disable;
f3ed775e	183	/* Event data */
fac6795d	184	struct {
db8870ed	185	char channel_name[LTTNG_SYMBOL_NAME_LEN];
f3ed775e	186	struct lttng_event event;
025faf73 DG	187	/* Length of following bytecode for filter. */
025faf73 DG	188	uint32_t bytecode_len;
fc5e05b7	189	} LTTNG_PACKED enable;
f3ed775e DG	190	/* Create channel */
	191	struct {
	192	struct lttng_channel chan;
fc5e05b7	193	} LTTNG_PACKED channel;
d65106b1 DG	194	/* Context */
d65106b1 DG	195	struct {
db8870ed	196	char channel_name[LTTNG_SYMBOL_NAME_LEN];
7d29a247	197	struct lttng_event_context ctx;
fc5e05b7	198	} LTTNG_PACKED context;
d9800920 DG	199	/* Use by register_consumer */
	200	struct {
	201	char path[PATH_MAX];
fc5e05b7	202	} LTTNG_PACKED reg;
9f19cc17 DG	203	/* List */
9f19cc17 DG	204	struct {
db8870ed	205	char channel_name[LTTNG_SYMBOL_NAME_LEN];
fc5e05b7	206	} LTTNG_PACKED list;
d0254c7c	207	struct lttng_calibrate calibrate;
a4b92340	208	/* Used by the set_consumer_url and used by create_session also call */
de5e9086	209	struct {
a4b92340 DG	210	/* Number of lttng_uri following */
a4b92340 DG	211	uint32_t size;
fc5e05b7	212	} LTTNG_PACKED uri;
fac6795d	213	} u;
fc5e05b7	214	} LTTNG_PACKED;
fac6795d	215
d93c4f1f	216	#define LTTNG_FILTER_MAX_LEN 65536
53a80697 MD	217
	218	/*
	219	* Filter bytecode data. The reloc table is located at the end of the
	220	* bytecode. It is made of tuples: (uint16_t, var. len. string). It
	221	* starts at reloc_table_offset.
	222	*/
b6bbed5f	223	#define LTTNG_FILTER_PADDING 32
53a80697	224	struct lttng_filter_bytecode {
d93c4f1f CB	225	uint32_t len; /* len of data */
d93c4f1f CB	226	uint32_t reloc_table_offset;
f3f0db50	227	uint64_t seqnum;
b6bbed5f	228	char padding[LTTNG_FILTER_PADDING];
53a80697	229	char data[0];
fc5e05b7	230	} LTTNG_PACKED;
53a80697	231
fac6795d	232	/*
5e16da05	233	* Data structure for the response from sessiond to the lttng client.
fac6795d	234	*/
5461b305	235	struct lttcomm_lttng_msg {
d0b96690 DG	236	uint32_t cmd_type; /* enum lttcomm_sessiond_command */
	237	uint32_t ret_code; /* enum lttcomm_return_code */
	238	uint32_t pid; /* pid_t */
773168b7	239	uint32_t data_size;
5461b305 DG	240	/* Contains: trace_name + data */
5461b305 DG	241	char payload[];
fc5e05b7	242	} LTTNG_PACKED;
fac6795d	243
44a5e5eb DG	244	struct lttcomm_health_msg {
	245	uint32_t component;
	246	uint32_t cmd;
fc5e05b7	247	} LTTNG_PACKED;
44a5e5eb DG	248
	249	struct lttcomm_health_data {
	250	uint32_t ret_code;
fc5e05b7	251	} LTTNG_PACKED;
44a5e5eb	252
6e3805e2	253	/*
3bd1e081 MD	254	* lttcomm_consumer_msg is the message sent from sessiond to consumerd
	255	* to either add a channel, add a stream, update a stream, or stop
	256	* operation.
6e3805e2	257	*/
3bd1e081 MD	258	struct lttcomm_consumer_msg {
	259	uint32_t cmd_type; /* enum consumerd_command */
	260	union {
	261	struct {
	262	int channel_key;
ffe60014 DG	263	uint64_t session_id;
	264	char pathname[PATH_MAX];
	265	uid_t uid;
	266	gid_t gid;
	267	int relayd_id;
c30aaa51 MD	268	/* nb_init_streams is the number of streams open initially. */
c30aaa51 MD	269	unsigned int nb_init_streams;
de5e9086	270	char name[LTTNG_SYMBOL_NAME_LEN];
ffe60014 DG	271	/* Use splice or mmap to consume this fd */
	272	enum lttng_event_output output;
	273	int type; /* Per cpu or metadata. */
	274	} LTTNG_PACKED channel; /* Only used by Kernel. */
3bd1e081	275	struct {
3bd1e081	276	int stream_key;
ffe60014 DG	277	int channel_key;
	278	int cpu; /* On which CPU this stream is assigned. */
	279	} LTTNG_PACKED stream; /* Only used by Kernel. */
de5e9086 DG	280	struct {
	281	int net_index;
	282	enum lttng_stream_type type;
	283	/* Open socket to the relayd */
	284	struct lttcomm_sock sock;
46e6455f DG	285	/* Tracing session id associated to the relayd. */
46e6455f DG	286	uint64_t session_id;
fc5e05b7	287	} LTTNG_PACKED relayd_sock;
173af62f DG	288	struct {
173af62f DG	289	uint64_t net_seq_idx;
fc5e05b7	290	} LTTNG_PACKED destroy_relayd;
53632229 DG	291	struct {
53632229 DG	292	uint64_t session_id;
fc5e05b7	293	} LTTNG_PACKED data_pending;
ffe60014	294	struct {
d0b96690 DG	295	uint64_t subbuf_size; /* bytes */
d0b96690 DG	296	uint64_t num_subbuf; /* power of 2 */
ffe60014 DG	297	int overwrite; /* 1: overwrite, 0: discard */
	298	unsigned int switch_timer_interval; /* usec */
	299	unsigned int read_timer_interval; /* usec */
d0b96690 DG	300	int output; /* splice, mmap */
	301	int type; /* metadata or per_cpu */
	302	uint64_t session_id; /* Tracing session id */
	303	char pathname[PATH_MAX]; /* Channel file path. */
ffe60014	304	char name[LTTNG_SYMBOL_NAME_LEN]; /* Channel name. */
d0b96690 DG	305	uid_t uid; /* User ID of the session */
	306	gid_t gid; /* Group ID ot the session */
	307	int relayd_id; /* Relayd id if apply. */
ffe60014 DG	308	unsigned long key; /* Unique channel key. */
	309	unsigned char uuid[UUID_STR_LEN]; /* uuid for ust tracer. */
	310	} LTTNG_PACKED ask_channel;
	311	struct {
	312	unsigned long key;
	313	} LTTNG_PACKED get_channel;
	314	struct {
	315	unsigned long key;
	316	} LTTNG_PACKED destroy_channel;
3bd1e081	317	} u;
fc5e05b7	318	} LTTNG_PACKED;
6e3805e2	319
f50f23d9 DG	320	/*
	321	* Status message returned to the sessiond after a received command.
	322	*/
	323	struct lttcomm_consumer_status_msg {
	324	enum lttng_error_code ret_code;
fc5e05b7	325	} LTTNG_PACKED;
f50f23d9	326
ffe60014 DG	327	struct lttcomm_consumer_status_channel {
	328	enum lttng_error_code ret_code;
	329	unsigned long key;
	330	unsigned int stream_count;
	331	} LTTNG_PACKED;
	332
74d0b642	333	#ifdef HAVE_LIBLTTNG_UST_CTL
3bd1e081	334
9df8df5e	335	#include <lttng/ust-abi.h>
6e3805e2	336
3817e7df DG	337	/*
	338	* Data structure for the commands sent from sessiond to UST.
	339	*/
	340	struct lttcomm_ust_msg {
3817e7df DG	341	uint32_t handle;
	342	uint32_t cmd;
	343	union {
3817e7df	344	struct lttng_ust_channel channel;
00a17c97	345	struct lttng_ust_stream stream;
3817e7df DG	346	struct lttng_ust_event event;
3817e7df DG	347	struct lttng_ust_context context;
00a17c97	348	struct lttng_ust_tracer_version version;
3817e7df	349	} u;
fc5e05b7	350	} LTTNG_PACKED;
3817e7df DG	351
	352	/*
	353	* Data structure for the response from UST to the session daemon.
	354	* cmd_type is sent back in the reply for validation.
	355	*/
	356	struct lttcomm_ust_reply {
	357	uint32_t handle;
	358	uint32_t cmd;
	359	uint32_t ret_code; /* enum lttcomm_return_code */
	360	uint32_t ret_val; /* return value */
	361	union {
2b0bf864 DG	362	struct {
2b0bf864 DG	363	uint64_t memory_map_size;
fc5e05b7	364	} LTTNG_PACKED channel;
2b0bf864 DG	365	struct {
2b0bf864 DG	366	uint64_t memory_map_size;
fc5e05b7	367	} LTTNG_PACKED stream;
00a17c97	368	struct lttng_ust_tracer_version version;
3817e7df	369	} u;
fc5e05b7	370	} LTTNG_PACKED;
3817e7df	371
74d0b642	372	#endif /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081	373
fac6795d DG	374	extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
fac6795d DG	375
6364a07a DG	376	extern int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr *sockaddr,
	377	const char *ip, unsigned int port);
	378	extern int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr *sockaddr,
	379	const char *ip, unsigned int port);
	380
de5e9086 DG	381	extern struct lttcomm_sock *lttcomm_alloc_sock(enum lttcomm_sock_proto proto);
	382	extern int lttcomm_create_sock(struct lttcomm_sock *sock);
	383	extern struct lttcomm_sock lttcomm_alloc_sock_from_uri(struct lttng_uri uri);
	384	extern void lttcomm_destroy_sock(struct lttcomm_sock *sock);
	385	extern struct lttcomm_sock lttcomm_alloc_copy_sock(struct lttcomm_sock src);
	386	extern void lttcomm_copy_sock(struct lttcomm_sock *dst,
	387	struct lttcomm_sock *src);
6364a07a	388
773168b7	389	#endif /* _LTTNG_SESSIOND_COMM_H */