[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 as published by the Free
 * Software Foundation; only version 2 of the License.
 * 
 * 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., 59 Temple
 * Place - Suite 330, Boston, MA 02111-1307, 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>

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

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

/*
 * lttcomm error code.
 */
enum lttcomm_return_code {
	LTTCOMM_OK = 1000,				/* Ok */
	LTTCOMM_ERR,					/* Unknown Error */
	LTTCOMM_UND,					/* Undefine command */
	LTTCOMM_NOT_IMPLEMENTED,        /* Command not implemented */
	LTTCOMM_UNKNOWN_DOMAIN,         /* Tracing domain not known */
	LTTCOMM_ALLOC_FAIL,				/* Trace allocation fail */
	LTTCOMM_NO_SESSION,				/* No session found */
	LTTCOMM_CREATE_DIR_FAIL,        /* Create directory fail */
	LTTCOMM_SESSION_FAIL,			/* Create session fail */
	LTTCOMM_START_FAIL,				/* Start tracing fail */
	LTTCOMM_STOP_FAIL,				/* Stop tracing fail */
	LTTCOMM_LIST_FAIL,				/* Listing apps fail */
	LTTCOMM_NO_APPS,				/* No traceable application */
	LTTCOMM_SESS_NOT_FOUND,			/* Session name not found */
	LTTCOMM_NO_TRACE,				/* No trace exist */
	LTTCOMM_FATAL,					/* Session daemon had a fatal error */
	LTTCOMM_NO_TRACEABLE,			/* Error for non traceable app */
	LTTCOMM_SELECT_SESS,			/* Must select a session */
	LTTCOMM_EXIST_SESS,				/* Session name already exist */
	LTTCOMM_NO_EVENT,				/* No event found */
	LTTCOMM_CONNECT_FAIL,           /* Unable to connect to unix socket */
	LTTCOMM_APP_NOT_FOUND,          /* App not found in traceable app list */
	LTTCOMM_EPERM,			/* Permission denied */
	LTTCOMM_KERN_NA,				/* Kernel tracer unavalable */
	LTTCOMM_KERN_VERSION,           /* Kernel tracer version is not compatible */
	LTTCOMM_KERN_EVENT_EXIST,       /* Kernel event already exists */
	LTTCOMM_KERN_SESS_FAIL,			/* Kernel create session failed */
	LTTCOMM_KERN_CHAN_FAIL,			/* Kernel create channel failed */
	LTTCOMM_KERN_CHAN_NOT_FOUND,	/* Kernel channel not found */
	LTTCOMM_KERN_CHAN_DISABLE_FAIL, /* Kernel disable channel failed */
	LTTCOMM_KERN_CHAN_ENABLE_FAIL,  /* Kernel enable channel failed */
	LTTCOMM_KERN_CONTEXT_FAIL,      /* Kernel add context failed */
	LTTCOMM_KERN_ENABLE_FAIL,		/* Kernel enable event failed */
	LTTCOMM_KERN_DISABLE_FAIL,		/* Kernel disable event failed */
	LTTCOMM_KERN_META_FAIL,			/* Kernel open metadata failed */
	LTTCOMM_KERN_START_FAIL,		/* Kernel start trace failed */
	LTTCOMM_KERN_STOP_FAIL,			/* Kernel stop trace failed */
	LTTCOMM_KERN_CONSUMER_FAIL,		/* Kernel consumer start failed */
	LTTCOMM_KERN_STREAM_FAIL,		/* Kernel create stream failed */
	LTTCOMM_KERN_DIR_FAIL,			/* Kernel trace directory creation failed */
	LTTCOMM_KERN_DIR_EXIST,			/* Kernel trace directory exist */
	LTTCOMM_KERN_NO_SESSION,		/* No kernel session found */
	LTTCOMM_KERN_LIST_FAIL,			/* Kernel listing events failed */
	LTTCOMM_UST_CALIBRATE_FAIL,     /* UST calibration failed */
	LTTCOMM_UST_VERSION,            /* UST tracer version is not compatible */
	LTTCOMM_UST_SESS_FAIL,			/* UST create session failed */
	LTTCOMM_UST_CHAN_EXIST,         /* UST channel already exist */
	LTTCOMM_UST_CHAN_FAIL,			/* UST create channel failed */
	LTTCOMM_UST_CHAN_NOT_FOUND,     /* UST channel not found */
	LTTCOMM_UST_CHAN_DISABLE_FAIL, /* UST disable channel failed */
	LTTCOMM_UST_CHAN_ENABLE_FAIL,  /* UST enable channel failed */
	LTTCOMM_UST_CONTEXT_FAIL,      /* UST add context failed */
	LTTCOMM_UST_ENABLE_FAIL,		/* UST enable event failed */
	LTTCOMM_UST_DISABLE_FAIL,		/* UST disable event failed */
	LTTCOMM_UST_META_FAIL,			/* UST open metadata failed */
	LTTCOMM_UST_START_FAIL,		/* UST start trace failed */
	LTTCOMM_UST_STOP_FAIL,			/* UST stop trace failed */
	LTTCOMM_UST_CONSUMER64_FAIL,		/* 64-bit UST consumer start failed */
	LTTCOMM_UST_CONSUMER32_FAIL,		/* 32-bit UST consumer start failed */
	LTTCOMM_UST_STREAM_FAIL,		/* UST create stream failed */
	LTTCOMM_UST_DIR_FAIL,			/* UST trace directory creation failed */
	LTTCOMM_UST_DIR_EXIST,			/* UST trace directory exist */
	LTTCOMM_UST_NO_SESSION,		/* No UST session found */
	LTTCOMM_UST_LIST_FAIL,			/* UST listing events failed */
	LTTCOMM_UST_EVENT_EXIST,        /* UST event exist */
	LTTCOMM_UST_EVENT_NOT_FOUND,    /* UST event not found */
	LTTCOMM_UST_CONTEXT_EXIST,      /* UST context exist */
	LTTCOMM_UST_CONTEXT_INVAL,      /* UST context invalid */

	CONSUMERD_COMMAND_SOCK_READY,		/* when consumerd command socket ready */
	CONSUMERD_SUCCESS_RECV_FD,		/* success on receiving fds */
	CONSUMERD_ERROR_RECV_FD,		/* error on receiving fds */
	CONSUMERD_ERROR_RECV_CMD,		/* error on receiving command */
	CONSUMERD_POLL_ERROR,			/* Error in polling thread in kconsumerd */
	CONSUMERD_POLL_NVAL,			/* Poll on closed fd */
	CONSUMERD_POLL_HUP,			/* All fds have hungup */
	CONSUMERD_EXIT_SUCCESS,			/* kconsumerd exiting normally */
	CONSUMERD_EXIT_FAILURE,			/* kconsumerd exiting on error */
	CONSUMERD_OUTFD_ERROR,			/* error opening the tracefile */
	CONSUMERD_SPLICE_EBADF,			/* EBADF from splice(2) */
	CONSUMERD_SPLICE_EINVAL,		/* EINVAL from splice(2) */
	CONSUMERD_SPLICE_ENOMEM,		/* ENOMEM from splice(2) */
	CONSUMERD_SPLICE_ESPIPE,		/* ESPIPE from splice(2) */
	/* MUST be last element */
	LTTCOMM_NR,						/* Last element */
};

/*
 * 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[NAME_MAX];
			char name[NAME_MAX];
		} disable;
		/* Event data */
		struct {
			char channel_name[NAME_MAX];
			struct lttng_event event;
		} enable;
		/* Create channel */
		struct {
			struct lttng_channel chan;
		} channel;
		/* Context */
		struct {
			char channel_name[NAME_MAX];
			char event_name[NAME_MAX];
			struct lttng_event_context ctx;
		} context;
		/* Use by register_consumer */
		struct {
			char path[PATH_MAX];
		} reg;
		/* List */
		struct {
			char channel_name[NAME_MAX];
		} list;
		struct lttng_calibrate calibrate;
	} u;
};

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

/*
 * 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;
		} 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];
		} stream;
	} 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 int lttcomm_create_unix_sock(const char *pathname);
extern int lttcomm_connect_unix_sock(const char *pathname);
extern int lttcomm_accept_unix_sock(int sock);
extern int lttcomm_listen_unix_sock(int sock);
extern int lttcomm_close_unix_sock(int sock);

/* Send a message accompanied by fd(s) over a unix socket. */
extern ssize_t lttcomm_send_fds_unix_sock(int sock, int *fds, size_t nb_fd);
/* Recv a message accompanied by fd(s) from a unix socket */
extern ssize_t lttcomm_recv_fds_unix_sock(int sock, int *fds, size_t nb_fd);

extern ssize_t lttcomm_recv_unix_sock(int sock, void *buf, size_t len);
extern ssize_t lttcomm_send_unix_sock(int sock, void *buf, size_t len);

extern ssize_t lttcomm_send_creds_unix_sock(int sock, void *buf, size_t len);
extern ssize_t lttcomm_recv_creds_unix_sock(int sock, void *buf, size_t len,
		lttng_sock_cred *creds);

extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
extern int lttcomm_setsockopt_creds_unix_sock(int sock);

#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	*
990570ed DG	6	* This program is free software; you can redistribute it and/or modify it
	7	* under the terms of the GNU General Public License as published by the Free
	8	* Software Foundation; only version 2 of the License.
fac6795d	9	*
990570ed DG	10	* This program is distributed in the hope that it will be useful, but WITHOUT
	11	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	12	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
	13	* more details.
fac6795d	14	*
990570ed DG	15	* You should have received a copy of the GNU General Public License along with
	16	* this program; if not, write to the Free Software Foundation, Inc., 59 Temple
	17	* Place - Suite 330, Boston, MA 02111-1307, 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>
ef50a575	31	#include <common/compat/socket.h>
5e16da05	32
fac6795d	33	/* Queue size of listen(2) */
f158a754	34	#define LTTNG_SESSIOND_COMM_MAX_LISTEN 64
fac6795d	35
990570ed DG	36	/* Maximum number of FDs that can be sent over a Unix socket */
	37	#define LTTCOMM_MAX_SEND_FDS 4
	38
3817e7df DG	39	/*
3817e7df DG	40	* Get the error code index from 0 since LTTCOMM_OK start at 1000
fac6795d	41	*/
686204ab	42	#define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_OK)
fac6795d	43
6abb15de	44	enum lttcomm_sessiond_command {
0d0c377a	45	/* Tracer command */
b579acd9	46	LTTNG_ADD_CONTEXT,
f4688807	47	LTTNG_CALIBRATE,
0b97ec54	48	LTTNG_DISABLE_CHANNEL,
f5177a38 DG	49	LTTNG_DISABLE_EVENT,
f5177a38 DG	50	LTTNG_DISABLE_ALL_EVENT,
0d0c377a DG	51	LTTNG_ENABLE_CHANNEL,
	52	LTTNG_ENABLE_EVENT,
	53	LTTNG_ENABLE_ALL_EVENT,
	54	/* Session daemon command */
fac6795d DG	55	LTTNG_CREATE_SESSION,
fac6795d DG	56	LTTNG_DESTROY_SESSION,
9f19cc17 DG	57	LTTNG_LIST_CHANNELS,
9f19cc17 DG	58	LTTNG_LIST_DOMAINS,
f3ed775e	59	LTTNG_LIST_EVENTS,
9f19cc17	60	LTTNG_LIST_SESSIONS,
052da939	61	LTTNG_LIST_TRACEPOINTS,
d9800920	62	LTTNG_REGISTER_CONSUMER,
f3ed775e DG	63	LTTNG_START_TRACE,
f3ed775e DG	64	LTTNG_STOP_TRACE,
fac6795d DG	65	};
	66
	67	/*
	68	* lttcomm error code.
	69	*/
	70	enum lttcomm_return_code {
20fe2104 DG	71	LTTCOMM_OK = 1000, /* Ok */
	72	LTTCOMM_ERR, /* Unknown Error */
	73	LTTCOMM_UND, /* Undefine command */
7d29a247 DG	74	LTTCOMM_NOT_IMPLEMENTED, /* Command not implemented */
7d29a247 DG	75	LTTCOMM_UNKNOWN_DOMAIN, /* Tracing domain not known */
20fe2104 DG	76	LTTCOMM_ALLOC_FAIL, /* Trace allocation fail */
20fe2104 DG	77	LTTCOMM_NO_SESSION, /* No session found */
ae856491	78	LTTCOMM_CREATE_DIR_FAIL, /* Create directory fail */
20fe2104 DG	79	LTTCOMM_SESSION_FAIL, /* Create session fail */
	80	LTTCOMM_START_FAIL, /* Start tracing fail */
	81	LTTCOMM_STOP_FAIL, /* Stop tracing fail */
	82	LTTCOMM_LIST_FAIL, /* Listing apps fail */
	83	LTTCOMM_NO_APPS, /* No traceable application */
f3ed775e	84	LTTCOMM_SESS_NOT_FOUND, /* Session name not found */
20fe2104 DG	85	LTTCOMM_NO_TRACE, /* No trace exist */
	86	LTTCOMM_FATAL, /* Session daemon had a fatal error */
	87	LTTCOMM_NO_TRACEABLE, /* Error for non traceable app */
	88	LTTCOMM_SELECT_SESS, /* Must select a session */
	89	LTTCOMM_EXIST_SESS, /* Session name already exist */
	90	LTTCOMM_NO_EVENT, /* No event found */
d9800920	91	LTTCOMM_CONNECT_FAIL, /* Unable to connect to unix socket */
2b0bf864	92	LTTCOMM_APP_NOT_FOUND, /* App not found in traceable app list */
8e0af1b4	93	LTTCOMM_EPERM, /* Permission denied */
20fe2104	94	LTTCOMM_KERN_NA, /* Kernel tracer unavalable */
394016d1	95	LTTCOMM_KERN_VERSION, /* Kernel tracer version is not compatible */
7d29a247	96	LTTCOMM_KERN_EVENT_EXIST, /* Kernel event already exists */
20fe2104 DG	97	LTTCOMM_KERN_SESS_FAIL, /* Kernel create session failed */
20fe2104 DG	98	LTTCOMM_KERN_CHAN_FAIL, /* Kernel create channel failed */
f3ed775e	99	LTTCOMM_KERN_CHAN_NOT_FOUND, /* Kernel channel not found */
26cc6b4e	100	LTTCOMM_KERN_CHAN_DISABLE_FAIL, /* Kernel disable channel failed */
d36b8583	101	LTTCOMM_KERN_CHAN_ENABLE_FAIL, /* Kernel enable channel failed */
d65106b1	102	LTTCOMM_KERN_CONTEXT_FAIL, /* Kernel add context failed */
f34daff7 DG	103	LTTCOMM_KERN_ENABLE_FAIL, /* Kernel enable event failed */
f34daff7 DG	104	LTTCOMM_KERN_DISABLE_FAIL, /* Kernel disable event failed */
aaf26714	105	LTTCOMM_KERN_META_FAIL, /* Kernel open metadata failed */
8c0faa1d DG	106	LTTCOMM_KERN_START_FAIL, /* Kernel start trace failed */
	107	LTTCOMM_KERN_STOP_FAIL, /* Kernel stop trace failed */
	108	LTTCOMM_KERN_CONSUMER_FAIL, /* Kernel consumer start failed */
	109	LTTCOMM_KERN_STREAM_FAIL, /* Kernel create stream failed */
	110	LTTCOMM_KERN_DIR_FAIL, /* Kernel trace directory creation failed */
84291629 DG	111	LTTCOMM_KERN_DIR_EXIST, /* Kernel trace directory exist */
84291629 DG	112	LTTCOMM_KERN_NO_SESSION, /* No kernel session found */
2ef84c95	113	LTTCOMM_KERN_LIST_FAIL, /* Kernel listing events failed */
4466912f	114	LTTCOMM_UST_CALIBRATE_FAIL, /* UST calibration failed */
e0c7ec2b	115	LTTCOMM_UST_VERSION, /* UST tracer version is not compatible */
0177d773	116	LTTCOMM_UST_SESS_FAIL, /* UST create session failed */
f6a9efaa	117	LTTCOMM_UST_CHAN_EXIST, /* UST channel already exist */
2bdd86d4	118	LTTCOMM_UST_CHAN_FAIL, /* UST create channel failed */
2b0bf864	119	LTTCOMM_UST_CHAN_NOT_FOUND, /* UST channel not found */
2bdd86d4 MD	120	LTTCOMM_UST_CHAN_DISABLE_FAIL, /* UST disable channel failed */
	121	LTTCOMM_UST_CHAN_ENABLE_FAIL, /* UST enable channel failed */
	122	LTTCOMM_UST_CONTEXT_FAIL, /* UST add context failed */
	123	LTTCOMM_UST_ENABLE_FAIL, /* UST enable event failed */
	124	LTTCOMM_UST_DISABLE_FAIL, /* UST disable event failed */
	125	LTTCOMM_UST_META_FAIL, /* UST open metadata failed */
	126	LTTCOMM_UST_START_FAIL, /* UST start trace failed */
	127	LTTCOMM_UST_STOP_FAIL, /* UST stop trace failed */
7753dea8 MD	128	LTTCOMM_UST_CONSUMER64_FAIL, /* 64-bit UST consumer start failed */
7753dea8 MD	129	LTTCOMM_UST_CONSUMER32_FAIL, /* 32-bit UST consumer start failed */
2bdd86d4 MD	130	LTTCOMM_UST_STREAM_FAIL, /* UST create stream failed */
	131	LTTCOMM_UST_DIR_FAIL, /* UST trace directory creation failed */
	132	LTTCOMM_UST_DIR_EXIST, /* UST trace directory exist */
	133	LTTCOMM_UST_NO_SESSION, /* No UST session found */
	134	LTTCOMM_UST_LIST_FAIL, /* UST listing events failed */
3b25d04d	135	LTTCOMM_UST_EVENT_EXIST, /* UST event exist */
be4f0921	136	LTTCOMM_UST_EVENT_NOT_FOUND, /* UST event not found */
ae357384	137	LTTCOMM_UST_CONTEXT_EXIST, /* UST context exist */
ae856491	138	LTTCOMM_UST_CONTEXT_INVAL, /* UST context invalid */
2bdd86d4	139
3bd1e081 MD	140	CONSUMERD_COMMAND_SOCK_READY, /* when consumerd command socket ready */
	141	CONSUMERD_SUCCESS_RECV_FD, /* success on receiving fds */
	142	CONSUMERD_ERROR_RECV_FD, /* error on receiving fds */
f2fc6720	143	CONSUMERD_ERROR_RECV_CMD, /* error on receiving command */
3bd1e081 MD	144	CONSUMERD_POLL_ERROR, /* Error in polling thread in kconsumerd */
	145	CONSUMERD_POLL_NVAL, /* Poll on closed fd */
	146	CONSUMERD_POLL_HUP, /* All fds have hungup */
	147	CONSUMERD_EXIT_SUCCESS, /* kconsumerd exiting normally */
	148	CONSUMERD_EXIT_FAILURE, /* kconsumerd exiting on error */
	149	CONSUMERD_OUTFD_ERROR, /* error opening the tracefile */
	150	CONSUMERD_SPLICE_EBADF, /* EBADF from splice(2) */
	151	CONSUMERD_SPLICE_EINVAL, /* EINVAL from splice(2) */
	152	CONSUMERD_SPLICE_ENOMEM, /* ENOMEM from splice(2) */
	153	CONSUMERD_SPLICE_ESPIPE, /* ESPIPE from splice(2) */
20fe2104 DG	154	/* MUST be last element */
20fe2104 DG	155	LTTCOMM_NR, /* Last element */
fac6795d DG	156	};
	157
	158	/*
9bda164d	159	* Data structure received from lttng client to session daemon.
fac6795d DG	160	*/
fac6795d DG	161	struct lttcomm_session_msg {
773168b7	162	uint32_t cmd_type; /* enum lttcomm_sessiond_command */
42abccdb	163	struct lttng_session session;
9f19cc17	164	struct lttng_domain domain;
fac6795d DG	165	union {
fac6795d DG	166	struct {
f3ed775e DG	167	char channel_name[NAME_MAX];
	168	char name[NAME_MAX];
	169	} disable;
	170	/* Event data */
fac6795d	171	struct {
f3ed775e DG	172	char channel_name[NAME_MAX];
	173	struct lttng_event event;
	174	} enable;
	175	/* Create channel */
	176	struct {
	177	struct lttng_channel chan;
	178	} channel;
d65106b1 DG	179	/* Context */
	180	struct {
	181	char channel_name[NAME_MAX];
	182	char event_name[NAME_MAX];
7d29a247	183	struct lttng_event_context ctx;
d65106b1	184	} context;
d9800920 DG	185	/* Use by register_consumer */
	186	struct {
	187	char path[PATH_MAX];
	188	} reg;
9f19cc17 DG	189	/* List */
	190	struct {
	191	char channel_name[NAME_MAX];
	192	} list;
d0254c7c	193	struct lttng_calibrate calibrate;
fac6795d DG	194	} u;
	195	};
	196
	197	/*
5e16da05	198	* Data structure for the response from sessiond to the lttng client.
fac6795d	199	*/
5461b305	200	struct lttcomm_lttng_msg {
773168b7 MD	201	uint32_t cmd_type; /* enum lttcomm_sessiond_command */
	202	uint32_t ret_code; /* enum lttcomm_return_code */
	203	uint32_t pid; /* pid_t */
	204	uint32_t data_size;
5461b305 DG	205	/* Contains: trace_name + data */
5461b305 DG	206	char payload[];
fac6795d DG	207	};
fac6795d DG	208
6e3805e2	209	/*
3bd1e081 MD	210	* lttcomm_consumer_msg is the message sent from sessiond to consumerd
	211	* to either add a channel, add a stream, update a stream, or stop
	212	* operation.
6e3805e2	213	*/
3bd1e081 MD	214	struct lttcomm_consumer_msg {
	215	uint32_t cmd_type; /* enum consumerd_command */
	216	union {
	217	struct {
	218	int channel_key;
	219	uint64_t max_sb_size; /* the subbuffer size for this channel */
	220	/* shm_fd and wait_fd are sent as ancillary data */
	221	uint64_t mmap_len;
	222	} channel;
	223	struct {
	224	int channel_key;
	225	int stream_key;
	226	/* shm_fd and wait_fd are sent as ancillary data */
	227	uint32_t state; /* enum lttcomm_consumer_fd_state */
	228	enum lttng_event_output output; /* use splice or mmap to consume this fd */
	229	uint64_t mmap_len;
6df2e2c9 MD	230	uid_t uid; /* User ID owning the session */
6df2e2c9 MD	231	gid_t gid; /* Group ID owning the session */
3bd1e081 MD	232	char path_name[PATH_MAX];
	233	} stream;
	234	} u;
6e3805e2 DG	235	};
6e3805e2 DG	236
74d0b642	237	#ifdef HAVE_LIBLTTNG_UST_CTL
3bd1e081	238
9df8df5e	239	#include <lttng/ust-abi.h>
6e3805e2	240
3817e7df DG	241	/*
	242	* Data structure for the commands sent from sessiond to UST.
	243	*/
	244	struct lttcomm_ust_msg {
3817e7df DG	245	uint32_t handle;
	246	uint32_t cmd;
	247	union {
3817e7df	248	struct lttng_ust_channel channel;
00a17c97	249	struct lttng_ust_stream stream;
3817e7df DG	250	struct lttng_ust_event event;
3817e7df DG	251	struct lttng_ust_context context;
00a17c97	252	struct lttng_ust_tracer_version version;
3817e7df DG	253	} u;
	254	};
	255
	256	/*
	257	* Data structure for the response from UST to the session daemon.
	258	* cmd_type is sent back in the reply for validation.
	259	*/
	260	struct lttcomm_ust_reply {
	261	uint32_t handle;
	262	uint32_t cmd;
	263	uint32_t ret_code; /* enum lttcomm_return_code */
	264	uint32_t ret_val; /* return value */
	265	union {
2b0bf864 DG	266	struct {
	267	uint64_t memory_map_size;
	268	} channel;
	269	struct {
	270	uint64_t memory_map_size;
	271	} stream;
00a17c97	272	struct lttng_ust_tracer_version version;
3817e7df DG	273	} u;
	274	};
	275
74d0b642	276	#endif /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081	277
fac6795d DG	278	extern int lttcomm_create_unix_sock(const char *pathname);
	279	extern int lttcomm_connect_unix_sock(const char *pathname);
	280	extern int lttcomm_accept_unix_sock(int sock);
	281	extern int lttcomm_listen_unix_sock(int sock);
87378cf5	282	extern int lttcomm_close_unix_sock(int sock);
3bd1e081	283
3bd1e081 MD	284	/* Send a message accompanied by fd(s) over a unix socket. */
	285	extern ssize_t lttcomm_send_fds_unix_sock(int sock, int *fds, size_t nb_fd);
	286	/* Recv a message accompanied by fd(s) from a unix socket */
	287	extern ssize_t lttcomm_recv_fds_unix_sock(int sock, int *fds, size_t nb_fd);
	288
fac6795d DG	289	extern ssize_t lttcomm_recv_unix_sock(int sock, void *buf, size_t len);
fac6795d DG	290	extern ssize_t lttcomm_send_unix_sock(int sock, void *buf, size_t len);
d19d9ada DG	291
	292	extern ssize_t lttcomm_send_creds_unix_sock(int sock, void *buf, size_t len);
	293	extern ssize_t lttcomm_recv_creds_unix_sock(int sock, void *buf, size_t len,
ef50a575	294	lttng_sock_cred *creds);
d19d9ada	295
fac6795d	296	extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
d19d9ada	297	extern int lttcomm_setsockopt_creds_unix_sock(int sock);
fac6795d	298
773168b7	299	#endif /* _LTTNG_SESSIOND_COMM_H */