[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 <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					= 1,
	LTTNG_CALIBRATE						= 2,
	LTTNG_DISABLE_CHANNEL				= 3,
	LTTNG_DISABLE_EVENT					= 4,
	LTTNG_DISABLE_ALL_EVENT				= 5,
	LTTNG_ENABLE_CHANNEL				= 6,
	LTTNG_ENABLE_EVENT					= 7,
	LTTNG_ENABLE_ALL_EVENT				= 8,
	/* Session daemon command */
	LTTNG_CREATE_SESSION				= 9,
	LTTNG_DESTROY_SESSION				= 10,
	LTTNG_LIST_CHANNELS                 = 11,
	LTTNG_LIST_DOMAINS                  = 12,
	LTTNG_LIST_EVENTS                   = 13,
	LTTNG_LIST_SESSIONS                 = 14,
	LTTNG_LIST_TRACEPOINTS              = 15,
	LTTNG_REGISTER_CONSUMER             = 16,
	LTTNG_START_TRACE                   = 17,
	LTTNG_STOP_TRACE                    = 18,
	LTTNG_LIST_TRACEPOINT_FIELDS        = 19,

	/* Consumer */
	LTTNG_DISABLE_CONSUMER              = 20,
	LTTNG_ENABLE_CONSUMER               = 21,
	LTTNG_SET_CONSUMER_URI              = 22,
	/* Relay daemon */
	RELAYD_ADD_STREAM                   = 23,
	RELAYD_CREATE_SESSION               = 24,
	RELAYD_START_DATA                   = 25,
	RELAYD_UPDATE_SYNC_INFO             = 26,
	RELAYD_VERSION                      = 27,
	RELAYD_SEND_METADATA                = 28,
	RELAYD_CLOSE_STREAM                 = 29,
	RELAYD_DATA_PENDING                 = 30,
	RELAYD_QUIESCENT_CONTROL            = 31,
	LTTNG_ENABLE_EVENT_WITH_FILTER      = 32,
	LTTNG_HEALTH_CHECK                  = 33,
	LTTNG_DATA_PENDING                  = 34,
	RELAYD_BEGIN_DATA_PENDING           = 35,
	RELAYD_END_DATA_PENDING             = 36,
};

/*
 * 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;
			/* Length of following bytecode for filter. */
			uint32_t bytecode_len;
		} enable;
		/* Create channel */
		struct {
			struct lttng_channel chan;
		} channel;
		/* Context */
		struct {
			char channel_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;
	} 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.
 */
#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];
};

/*
 * 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[DEFAULT_STREAM_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;
			/* Tracing session id associated to the relayd. */
			uint64_t session_id;
		} relayd_sock;
		struct {
			uint64_t net_seq_idx;
		} destroy_relayd;
		struct {
			uint64_t session_id;
		} data_pending;
	} u;
};

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

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