[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 <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,
	LTTNG_CALIBRATE,
	LTTNG_DISABLE_CHANNEL,
	LTTNG_DISABLE_EVENT,
	LTTNG_DISABLE_ALL_EVENT,
	LTTNG_ENABLE_CHANNEL,
	LTTNG_ENABLE_EVENT,
	LTTNG_ENABLE_ALL_EVENT,
	/* Session daemon command */
	LTTNG_CREATE_SESSION,
	LTTNG_DESTROY_SESSION,
	LTTNG_LIST_CHANNELS,
	LTTNG_LIST_DOMAINS,
	LTTNG_LIST_EVENTS,
	LTTNG_LIST_SESSIONS,
	LTTNG_LIST_TRACEPOINTS,
	LTTNG_REGISTER_CONSUMER,
	LTTNG_START_TRACE,
	LTTNG_STOP_TRACE,
	LTTNG_LIST_TRACEPOINT_FIELDS,

	/* Consumer */
	LTTNG_DISABLE_CONSUMER,
	LTTNG_ENABLE_CONSUMER,
	LTTNG_SET_CONSUMER_URI,
	/* Relay daemon */
	RELAYD_ADD_STREAM,
	RELAYD_CREATE_SESSION,
	RELAYD_START_DATA,
	RELAYD_UPDATE_SYNC_INFO,
	RELAYD_VERSION,
	RELAYD_SEND_METADATA,
	RELAYD_CLOSE_STREAM,
	RELAYD_DATA_PENDING,
	RELAYD_QUIESCENT_CONTROL,
	LTTNG_SET_FILTER,
	LTTNG_HEALTH_CHECK,
	LTTNG_DATA_PENDING,
};

/*
 * 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) */

	/* 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;
};

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

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];
		} disable;
		/* Event data */
		struct {
			char channel_name[LTTNG_SYMBOL_NAME_LEN];
			struct lttng_event event;
		} enable;
		/* Create channel */
		struct {
			struct lttng_channel chan;
		} channel;
		/* Context */
		struct {
			char channel_name[LTTNG_SYMBOL_NAME_LEN];
			char event_name[LTTNG_SYMBOL_NAME_LEN];
			struct lttng_event_context ctx;
		} context;
		/* Use by register_consumer */
		struct {
			char path[PATH_MAX];
		} reg;
		/* List */
		struct {
			char channel_name[LTTNG_SYMBOL_NAME_LEN];
		} 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;
		} uri;
		struct {
			char channel_name[LTTNG_SYMBOL_NAME_LEN];
			char event_name[LTTNG_SYMBOL_NAME_LEN];
			/* Length of following bytecode */
			uint32_t bytecode_len;
		} filter;
	} u;
};

#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.
 */
struct lttng_filter_bytecode {
	uint32_t len;	/* len of data */
	uint32_t reloc_table_offset;
	char data[0];
};

/*
 * 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[];
};

struct lttcomm_health_msg {
	uint32_t component;
	uint32_t cmd;
};

struct lttcomm_health_data {
	uint32_t ret_code;
};

/*
 * 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 max_sb_size; /* the subbuffer size for this channel */
			/* shm_fd and wait_fd are sent as ancillary data */
			uint64_t mmap_len;
			/* nb_init_streams is the number of streams open initially. */
			unsigned int nb_init_streams;
			char name[LTTNG_SYMBOL_NAME_LEN];
		} channel;
		struct {
			int channel_key;
			int stream_key;
			/* shm_fd and wait_fd are sent as ancillary data */
			uint32_t state;    /* enum lttcomm_consumer_fd_state */
			enum lttng_event_output output; /* use splice or mmap to consume this fd */
			uint64_t mmap_len;
			uid_t uid;         /* User ID owning the session */
			gid_t gid;         /* Group ID owning the session */
			char path_name[PATH_MAX];
			int net_index;
			unsigned int metadata_flag;
			char name[LTTNG_SYMBOL_NAME_LEN];  /* Name string of the stream */
			uint64_t session_id;   /* Tracing session id of the stream */
		} stream;
		struct {
			int net_index;
			enum lttng_stream_type type;
			/* Open socket to the relayd */
			struct lttcomm_sock sock;
		} relayd_sock;
		struct {
			uint64_t net_seq_idx;
		} destroy_relayd;
		struct {
			uint64_t session_id;
		} data_pending;
	} u;
};

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

/*
 * 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;
		} channel;
		struct {
			uint64_t memory_map_size;
		} stream;
		struct lttng_ust_tracer_version version;
	} u;
};

#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>
5e16da05	33
6364a07a DG	34	#include <arpa/inet.h>
	35	#include <netinet/in.h>
	36	#include <sys/un.h>
	37
	38	#include "inet.h"
	39	#include "inet6.h"
0d37f2bc DG	40	#include "unix.h"
0d37f2bc DG	41
fac6795d	42	/* Queue size of listen(2) */
f158a754	43	#define LTTNG_SESSIOND_COMM_MAX_LISTEN 64
fac6795d	44
990570ed DG	45	/* Maximum number of FDs that can be sent over a Unix socket */
	46	#define LTTCOMM_MAX_SEND_FDS 4
	47
3817e7df DG	48	/*
3817e7df DG	49	* Get the error code index from 0 since LTTCOMM_OK start at 1000
fac6795d	50	*/
f73fabfd	51	#define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_CONSUMERD_COMMAND_SOCK_READY)
fac6795d	52
6abb15de	53	enum lttcomm_sessiond_command {
0d0c377a	54	/* Tracer command */
b579acd9	55	LTTNG_ADD_CONTEXT,
f4688807	56	LTTNG_CALIBRATE,
0b97ec54	57	LTTNG_DISABLE_CHANNEL,
f5177a38 DG	58	LTTNG_DISABLE_EVENT,
f5177a38 DG	59	LTTNG_DISABLE_ALL_EVENT,
0d0c377a DG	60	LTTNG_ENABLE_CHANNEL,
	61	LTTNG_ENABLE_EVENT,
	62	LTTNG_ENABLE_ALL_EVENT,
	63	/* Session daemon command */
fac6795d DG	64	LTTNG_CREATE_SESSION,
fac6795d DG	65	LTTNG_DESTROY_SESSION,
9f19cc17 DG	66	LTTNG_LIST_CHANNELS,
9f19cc17 DG	67	LTTNG_LIST_DOMAINS,
f3ed775e	68	LTTNG_LIST_EVENTS,
9f19cc17	69	LTTNG_LIST_SESSIONS,
052da939	70	LTTNG_LIST_TRACEPOINTS,
d9800920	71	LTTNG_REGISTER_CONSUMER,
f3ed775e DG	72	LTTNG_START_TRACE,
f3ed775e DG	73	LTTNG_STOP_TRACE,
f37d259d	74	LTTNG_LIST_TRACEPOINT_FIELDS,
53a80697	75
de5e9086 DG	76	/* Consumer */
	77	LTTNG_DISABLE_CONSUMER,
	78	LTTNG_ENABLE_CONSUMER,
	79	LTTNG_SET_CONSUMER_URI,
	80	/* Relay daemon */
	81	RELAYD_ADD_STREAM,
	82	RELAYD_CREATE_SESSION,
	83	RELAYD_START_DATA,
	84	RELAYD_UPDATE_SYNC_INFO,
	85	RELAYD_VERSION,
	86	RELAYD_SEND_METADATA,
173af62f	87	RELAYD_CLOSE_STREAM,
6d805429	88	RELAYD_DATA_PENDING,
c8f59ee5	89	RELAYD_QUIESCENT_CONTROL,
53a80697	90	LTTNG_SET_FILTER,
44a5e5eb	91	LTTNG_HEALTH_CHECK,
6d805429	92	LTTNG_DATA_PENDING,
fac6795d DG	93	};
	94
	95	/*
	96	* lttcomm error code.
	97	*/
	98	enum lttcomm_return_code {
f73fabfd DG	99	LTTCOMM_CONSUMERD_COMMAND_SOCK_READY = 1, /* Command socket ready */
	100	LTTCOMM_CONSUMERD_SUCCESS_RECV_FD, /* Success on receiving fds */
	101	LTTCOMM_CONSUMERD_ERROR_RECV_FD, /* Error on receiving fds */
	102	LTTCOMM_CONSUMERD_ERROR_RECV_CMD, /* Error on receiving command */
	103	LTTCOMM_CONSUMERD_POLL_ERROR, /* Error in polling thread */
	104	LTTCOMM_CONSUMERD_POLL_NVAL, /* Poll on closed fd */
	105	LTTCOMM_CONSUMERD_POLL_HUP, /* All fds have hungup */
	106	LTTCOMM_CONSUMERD_EXIT_SUCCESS, /* Consumerd exiting normally */
	107	LTTCOMM_CONSUMERD_EXIT_FAILURE, /* Consumerd exiting on error */
	108	LTTCOMM_CONSUMERD_OUTFD_ERROR, /* Error opening the tracefile */
	109	LTTCOMM_CONSUMERD_SPLICE_EBADF, /* EBADF from splice(2) */
	110	LTTCOMM_CONSUMERD_SPLICE_EINVAL, /* EINVAL from splice(2) */
	111	LTTCOMM_CONSUMERD_SPLICE_ENOMEM, /* ENOMEM from splice(2) */
	112	LTTCOMM_CONSUMERD_SPLICE_ESPIPE, /* ESPIPE from splice(2) */
80e327fa	113
20fe2104 DG	114	/* MUST be last element */
20fe2104 DG	115	LTTCOMM_NR, /* Last element */
fac6795d DG	116	};
fac6795d DG	117
de5e9086 DG	118	/* lttng socket protocol. */
	119	enum lttcomm_sock_proto {
	120	LTTCOMM_SOCK_UDP,
	121	LTTCOMM_SOCK_TCP,
	122	};
	123
	124	/*
	125	* Index in the net_families array below. Please keep in sync!
	126	*/
	127	enum lttcomm_sock_domain {
01d0a631 CB	128	LTTCOMM_INET = 0,
01d0a631 CB	129	LTTCOMM_INET6 = 1,
de5e9086 DG	130	};
	131
	132	struct lttcomm_sockaddr {
	133	enum lttcomm_sock_domain type;
	134	union {
	135	struct sockaddr_in sin;
	136	struct sockaddr_in6 sin6;
	137	} addr;
	138	};
	139
	140	struct lttcomm_sock {
	141	int fd;
	142	enum lttcomm_sock_proto proto;
	143	struct lttcomm_sockaddr sockaddr;
	144	const struct lttcomm_proto_ops *ops;
	145	};
	146
	147	struct lttcomm_net_family {
	148	int family;
	149	int (create) (struct lttcomm_sock sock, int type, int proto);
	150	};
	151
	152	struct lttcomm_proto_ops {
	153	int (bind) (struct lttcomm_sock sock);
	154	int (close) (struct lttcomm_sock sock);
	155	int (connect) (struct lttcomm_sock sock);
	156	struct lttcomm_sock (accept) (struct lttcomm_sock *sock);
	157	int (listen) (struct lttcomm_sock sock, int backlog);
	158	ssize_t (recvmsg) (struct lttcomm_sock sock, void *buf, size_t len,
	159	int flags);
	160	ssize_t (sendmsg) (struct lttcomm_sock sock, void *buf, size_t len,
	161	int flags);
	162	};
	163
fac6795d	164	/*
9bda164d	165	* Data structure received from lttng client to session daemon.
fac6795d DG	166	*/
fac6795d DG	167	struct lttcomm_session_msg {
773168b7	168	uint32_t cmd_type; /* enum lttcomm_sessiond_command */
42abccdb	169	struct lttng_session session;
9f19cc17	170	struct lttng_domain domain;
fac6795d DG	171	union {
fac6795d DG	172	struct {
db8870ed	173	char channel_name[LTTNG_SYMBOL_NAME_LEN];
f3ed775e DG	174	char name[NAME_MAX];
	175	} disable;
	176	/* Event data */
fac6795d	177	struct {
db8870ed	178	char channel_name[LTTNG_SYMBOL_NAME_LEN];
f3ed775e DG	179	struct lttng_event event;
	180	} enable;
	181	/* Create channel */
	182	struct {
	183	struct lttng_channel chan;
	184	} channel;
d65106b1 DG	185	/* Context */
d65106b1 DG	186	struct {
db8870ed MD	187	char channel_name[LTTNG_SYMBOL_NAME_LEN];
db8870ed MD	188	char event_name[LTTNG_SYMBOL_NAME_LEN];
7d29a247	189	struct lttng_event_context ctx;
d65106b1	190	} context;
d9800920 DG	191	/* Use by register_consumer */
	192	struct {
	193	char path[PATH_MAX];
	194	} reg;
9f19cc17 DG	195	/* List */
9f19cc17 DG	196	struct {
db8870ed	197	char channel_name[LTTNG_SYMBOL_NAME_LEN];
9f19cc17	198	} list;
d0254c7c	199	struct lttng_calibrate calibrate;
a4b92340	200	/* Used by the set_consumer_url and used by create_session also call */
de5e9086	201	struct {
a4b92340 DG	202	/* Number of lttng_uri following */
	203	uint32_t size;
	204	} uri;
53a80697	205	struct {
db8870ed MD	206	char channel_name[LTTNG_SYMBOL_NAME_LEN];
db8870ed MD	207	char event_name[LTTNG_SYMBOL_NAME_LEN];
53a80697 MD	208	/* Length of following bytecode */
	209	uint32_t bytecode_len;
	210	} filter;
fac6795d DG	211	} u;
	212	};
	213
d93c4f1f	214	#define LTTNG_FILTER_MAX_LEN 65536
53a80697 MD	215
	216	/*
	217	* Filter bytecode data. The reloc table is located at the end of the
	218	* bytecode. It is made of tuples: (uint16_t, var. len. string). It
	219	* starts at reloc_table_offset.
	220	*/
	221	struct lttng_filter_bytecode {
d93c4f1f CB	222	uint32_t len; /* len of data */
d93c4f1f CB	223	uint32_t reloc_table_offset;
53a80697 MD	224	char data[0];
	225	};
	226
fac6795d	227	/*
5e16da05	228	* Data structure for the response from sessiond to the lttng client.
fac6795d	229	*/
5461b305	230	struct lttcomm_lttng_msg {
773168b7 MD	231	uint32_t cmd_type; /* enum lttcomm_sessiond_command */
	232	uint32_t ret_code; /* enum lttcomm_return_code */
	233	uint32_t pid; /* pid_t */
	234	uint32_t data_size;
5461b305 DG	235	/* Contains: trace_name + data */
5461b305 DG	236	char payload[];
fac6795d DG	237	};
fac6795d DG	238
44a5e5eb DG	239	struct lttcomm_health_msg {
	240	uint32_t component;
	241	uint32_t cmd;
	242	};
	243
	244	struct lttcomm_health_data {
	245	uint32_t ret_code;
	246	};
	247
6e3805e2	248	/*
3bd1e081 MD	249	* lttcomm_consumer_msg is the message sent from sessiond to consumerd
	250	* to either add a channel, add a stream, update a stream, or stop
	251	* operation.
6e3805e2	252	*/
3bd1e081 MD	253	struct lttcomm_consumer_msg {
	254	uint32_t cmd_type; /* enum consumerd_command */
	255	union {
	256	struct {
	257	int channel_key;
	258	uint64_t max_sb_size; /* the subbuffer size for this channel */
	259	/* shm_fd and wait_fd are sent as ancillary data */
	260	uint64_t mmap_len;
c30aaa51 MD	261	/* nb_init_streams is the number of streams open initially. */
c30aaa51 MD	262	unsigned int nb_init_streams;
de5e9086	263	char name[LTTNG_SYMBOL_NAME_LEN];
3bd1e081 MD	264	} channel;
	265	struct {
	266	int channel_key;
	267	int stream_key;
	268	/* shm_fd and wait_fd are sent as ancillary data */
	269	uint32_t state; /* enum lttcomm_consumer_fd_state */
	270	enum lttng_event_output output; /* use splice or mmap to consume this fd */
	271	uint64_t mmap_len;
6df2e2c9 MD	272	uid_t uid; /* User ID owning the session */
6df2e2c9 MD	273	gid_t gid; /* Group ID owning the session */
3bd1e081	274	char path_name[PATH_MAX];
de5e9086 DG	275	int net_index;
	276	unsigned int metadata_flag;
	277	char name[LTTNG_SYMBOL_NAME_LEN]; /* Name string of the stream */
53632229	278	uint64_t session_id; /* Tracing session id of the stream */
3bd1e081	279	} stream;
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;
	285	} relayd_sock;
173af62f DG	286	struct {
	287	uint64_t net_seq_idx;
	288	} destroy_relayd;
53632229 DG	289	struct {
53632229 DG	290	uint64_t session_id;
6d805429	291	} data_pending;
3bd1e081	292	} u;
6e3805e2 DG	293	};
6e3805e2 DG	294
74d0b642	295	#ifdef HAVE_LIBLTTNG_UST_CTL
3bd1e081	296
9df8df5e	297	#include <lttng/ust-abi.h>
6e3805e2	298
3817e7df DG	299	/*
	300	* Data structure for the commands sent from sessiond to UST.
	301	*/
	302	struct lttcomm_ust_msg {
3817e7df DG	303	uint32_t handle;
	304	uint32_t cmd;
	305	union {
3817e7df	306	struct lttng_ust_channel channel;
00a17c97	307	struct lttng_ust_stream stream;
3817e7df DG	308	struct lttng_ust_event event;
3817e7df DG	309	struct lttng_ust_context context;
00a17c97	310	struct lttng_ust_tracer_version version;
3817e7df DG	311	} u;
	312	};
	313
	314	/*
	315	* Data structure for the response from UST to the session daemon.
	316	* cmd_type is sent back in the reply for validation.
	317	*/
	318	struct lttcomm_ust_reply {
	319	uint32_t handle;
	320	uint32_t cmd;
	321	uint32_t ret_code; /* enum lttcomm_return_code */
	322	uint32_t ret_val; /* return value */
	323	union {
2b0bf864 DG	324	struct {
	325	uint64_t memory_map_size;
	326	} channel;
	327	struct {
	328	uint64_t memory_map_size;
	329	} stream;
00a17c97	330	struct lttng_ust_tracer_version version;
3817e7df DG	331	} u;
	332	};
	333
74d0b642	334	#endif /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081	335
fac6795d DG	336	extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
fac6795d DG	337
6364a07a DG	338	extern int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr *sockaddr,
	339	const char *ip, unsigned int port);
	340	extern int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr *sockaddr,
	341	const char *ip, unsigned int port);
	342
de5e9086 DG	343	extern struct lttcomm_sock *lttcomm_alloc_sock(enum lttcomm_sock_proto proto);
	344	extern int lttcomm_create_sock(struct lttcomm_sock *sock);
	345	extern struct lttcomm_sock lttcomm_alloc_sock_from_uri(struct lttng_uri uri);
	346	extern void lttcomm_destroy_sock(struct lttcomm_sock *sock);
	347	extern struct lttcomm_sock lttcomm_alloc_copy_sock(struct lttcomm_sock src);
	348	extern void lttcomm_copy_sock(struct lttcomm_sock *dst,
	349	struct lttcomm_sock *src);
6364a07a	350
773168b7	351	#endif /* _LTTNG_SESSIOND_COMM_H */