[lttng-tools.git] / include / lttng-sessiond-comm.h

#ifndef _LTTNG_SESSIOND_COMM_H
#define _LTTNG_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.
 */

#define _GNU_SOURCE
#include <limits.h>
#include <lttng/lttng.h>
#include <sys/socket.h>

#define LTTNG_RUNDIR                        "/var/run/lttng"
#define LTTNG_HOME_RUNDIR                   "%s/.lttng"

/* Default unix socket path */
#define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK     LTTNG_RUNDIR "/client-lttng-sessiond"
#define DEFAULT_GLOBAL_APPS_UNIX_SOCK       LTTNG_RUNDIR "/apps-lttng-sessiond"
#define DEFAULT_HOME_APPS_UNIX_SOCK         LTTNG_HOME_RUNDIR "/apps-lttng-sessiond"
#define DEFAULT_HOME_CLIENT_UNIX_SOCK       LTTNG_HOME_RUNDIR "/client-lttng-sessiond"

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

/*
 * 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_FAIL,			/* Create trace 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_KERN_NA,				/* Kernel tracer unavalable */
	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_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 */

	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;
			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);

#define LTTCOMM_MAX_SEND_FDS	4
/* 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,
		struct ucred *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
773168b7 MD	1	#ifndef _LTTNG_SESSIOND_COMM_H
	2	#define _LTTNG_SESSIOND_COMM_H
	3
6e3805e2 DG	4	/*
	5	* Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
	6	* Julien Desfossez <julien.desfossez@polymtl.ca>
773168b7	7	* Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
fac6795d DG	8	*
	9	* This program is free software; you can redistribute it and/or
	10	* modify it under the terms of the GNU General Public License
82a3637f DG	11	* as published by the Free Software Foundation; only version 2
82a3637f DG	12	* of the License.
fac6795d DG	13	*
	14	* This program is distributed in the hope that it will be useful,
	15	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	16	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	17	* GNU General Public License for more details.
	18	*
	19	* You should have received a copy of the GNU General Public License
	20	* along with this program; if not, write to the Free Software
	21	* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
fac6795d DG	22	*/
fac6795d DG	23
773168b7 MD	24	/*
	25	* This header is meant for liblttng and libust internal use ONLY.
	26	* These declarations should NOT be considered stable API.
	27	*/
fac6795d	28
d19d9ada	29	#define _GNU_SOURCE
fac6795d	30	#include <limits.h>
f3ed775e	31	#include <lttng/lttng.h>
d19d9ada	32	#include <sys/socket.h>
5e16da05	33
f4688807	34	#define LTTNG_RUNDIR "/var/run/lttng"
67e40797	35	#define LTTNG_HOME_RUNDIR "%s/.lttng"
1526bda7	36
fac6795d	37	/* Default unix socket path */
32258573 DG	38	#define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK LTTNG_RUNDIR "/client-lttng-sessiond"
32258573 DG	39	#define DEFAULT_GLOBAL_APPS_UNIX_SOCK LTTNG_RUNDIR "/apps-lttng-sessiond"
67e40797 DG	40	#define DEFAULT_HOME_APPS_UNIX_SOCK LTTNG_HOME_RUNDIR "/apps-lttng-sessiond"
67e40797 DG	41	#define DEFAULT_HOME_CLIENT_UNIX_SOCK LTTNG_HOME_RUNDIR "/client-lttng-sessiond"
fac6795d DG	42
fac6795d DG	43	/* Queue size of listen(2) */
f158a754	44	#define LTTNG_SESSIOND_COMM_MAX_LISTEN 64
fac6795d	45
3817e7df DG	46	/*
3817e7df DG	47	* Get the error code index from 0 since LTTCOMM_OK start at 1000
fac6795d	48	*/
686204ab	49	#define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_OK)
fac6795d	50
6abb15de	51	enum lttcomm_sessiond_command {
0d0c377a	52	/* Tracer command */
b579acd9	53	LTTNG_ADD_CONTEXT,
f4688807	54	LTTNG_CALIBRATE,
0b97ec54	55	LTTNG_DISABLE_CHANNEL,
f5177a38 DG	56	LTTNG_DISABLE_EVENT,
f5177a38 DG	57	LTTNG_DISABLE_ALL_EVENT,
0d0c377a DG	58	LTTNG_ENABLE_CHANNEL,
	59	LTTNG_ENABLE_EVENT,
	60	LTTNG_ENABLE_ALL_EVENT,
	61	/* Session daemon command */
fac6795d DG	62	LTTNG_CREATE_SESSION,
fac6795d DG	63	LTTNG_DESTROY_SESSION,
9f19cc17 DG	64	LTTNG_LIST_CHANNELS,
9f19cc17 DG	65	LTTNG_LIST_DOMAINS,
f3ed775e	66	LTTNG_LIST_EVENTS,
9f19cc17	67	LTTNG_LIST_SESSIONS,
052da939	68	LTTNG_LIST_TRACEPOINTS,
d9800920	69	LTTNG_REGISTER_CONSUMER,
f3ed775e DG	70	LTTNG_START_TRACE,
f3ed775e DG	71	LTTNG_STOP_TRACE,
fac6795d DG	72	};
	73
	74	/*
	75	* lttcomm error code.
	76	*/
	77	enum lttcomm_return_code {
20fe2104 DG	78	LTTCOMM_OK = 1000, /* Ok */
	79	LTTCOMM_ERR, /* Unknown Error */
	80	LTTCOMM_UND, /* Undefine command */
7d29a247 DG	81	LTTCOMM_NOT_IMPLEMENTED, /* Command not implemented */
7d29a247 DG	82	LTTCOMM_UNKNOWN_DOMAIN, /* Tracing domain not known */
20fe2104 DG	83	LTTCOMM_ALLOC_FAIL, /* Trace allocation fail */
	84	LTTCOMM_NO_SESSION, /* No session found */
	85	LTTCOMM_CREATE_FAIL, /* Create trace fail */
	86	LTTCOMM_SESSION_FAIL, /* Create session fail */
	87	LTTCOMM_START_FAIL, /* Start tracing fail */
	88	LTTCOMM_STOP_FAIL, /* Stop tracing fail */
	89	LTTCOMM_LIST_FAIL, /* Listing apps fail */
	90	LTTCOMM_NO_APPS, /* No traceable application */
f3ed775e	91	LTTCOMM_SESS_NOT_FOUND, /* Session name not found */
20fe2104 DG	92	LTTCOMM_NO_TRACE, /* No trace exist */
	93	LTTCOMM_FATAL, /* Session daemon had a fatal error */
	94	LTTCOMM_NO_TRACEABLE, /* Error for non traceable app */
	95	LTTCOMM_SELECT_SESS, /* Must select a session */
	96	LTTCOMM_EXIST_SESS, /* Session name already exist */
	97	LTTCOMM_NO_EVENT, /* No event found */
d9800920	98	LTTCOMM_CONNECT_FAIL, /* Unable to connect to unix socket */
2b0bf864	99	LTTCOMM_APP_NOT_FOUND, /* App not found in traceable app list */
20fe2104	100	LTTCOMM_KERN_NA, /* Kernel tracer unavalable */
7d29a247	101	LTTCOMM_KERN_EVENT_EXIST, /* Kernel event already exists */
20fe2104 DG	102	LTTCOMM_KERN_SESS_FAIL, /* Kernel create session failed */
20fe2104 DG	103	LTTCOMM_KERN_CHAN_FAIL, /* Kernel create channel failed */
f3ed775e	104	LTTCOMM_KERN_CHAN_NOT_FOUND, /* Kernel channel not found */
26cc6b4e	105	LTTCOMM_KERN_CHAN_DISABLE_FAIL, /* Kernel disable channel failed */
d36b8583	106	LTTCOMM_KERN_CHAN_ENABLE_FAIL, /* Kernel enable channel failed */
d65106b1	107	LTTCOMM_KERN_CONTEXT_FAIL, /* Kernel add context failed */
f34daff7 DG	108	LTTCOMM_KERN_ENABLE_FAIL, /* Kernel enable event failed */
f34daff7 DG	109	LTTCOMM_KERN_DISABLE_FAIL, /* Kernel disable event failed */
aaf26714	110	LTTCOMM_KERN_META_FAIL, /* Kernel open metadata failed */
8c0faa1d DG	111	LTTCOMM_KERN_START_FAIL, /* Kernel start trace failed */
	112	LTTCOMM_KERN_STOP_FAIL, /* Kernel stop trace failed */
	113	LTTCOMM_KERN_CONSUMER_FAIL, /* Kernel consumer start failed */
	114	LTTCOMM_KERN_STREAM_FAIL, /* Kernel create stream failed */
	115	LTTCOMM_KERN_DIR_FAIL, /* Kernel trace directory creation failed */
84291629 DG	116	LTTCOMM_KERN_DIR_EXIST, /* Kernel trace directory exist */
84291629 DG	117	LTTCOMM_KERN_NO_SESSION, /* No kernel session found */
2ef84c95	118	LTTCOMM_KERN_LIST_FAIL, /* Kernel listing events failed */
0177d773	119	LTTCOMM_UST_SESS_FAIL, /* UST create session failed */
f6a9efaa	120	LTTCOMM_UST_CHAN_EXIST, /* UST channel already exist */
2bdd86d4	121	LTTCOMM_UST_CHAN_FAIL, /* UST create channel failed */
2b0bf864	122	LTTCOMM_UST_CHAN_NOT_FOUND, /* UST channel not found */
2bdd86d4 MD	123	LTTCOMM_UST_CHAN_DISABLE_FAIL, /* UST disable channel failed */
	124	LTTCOMM_UST_CHAN_ENABLE_FAIL, /* UST enable channel failed */
	125	LTTCOMM_UST_CONTEXT_FAIL, /* UST add context failed */
	126	LTTCOMM_UST_ENABLE_FAIL, /* UST enable event failed */
	127	LTTCOMM_UST_DISABLE_FAIL, /* UST disable event failed */
	128	LTTCOMM_UST_META_FAIL, /* UST open metadata failed */
	129	LTTCOMM_UST_START_FAIL, /* UST start trace failed */
	130	LTTCOMM_UST_STOP_FAIL, /* UST stop trace failed */
7753dea8 MD	131	LTTCOMM_UST_CONSUMER64_FAIL, /* 64-bit UST consumer start failed */
7753dea8 MD	132	LTTCOMM_UST_CONSUMER32_FAIL, /* 32-bit UST consumer start failed */
2bdd86d4 MD	133	LTTCOMM_UST_STREAM_FAIL, /* UST create stream failed */
	134	LTTCOMM_UST_DIR_FAIL, /* UST trace directory creation failed */
	135	LTTCOMM_UST_DIR_EXIST, /* UST trace directory exist */
	136	LTTCOMM_UST_NO_SESSION, /* No UST session found */
	137	LTTCOMM_UST_LIST_FAIL, /* UST listing events failed */
3b25d04d	138	LTTCOMM_UST_EVENT_EXIST, /* UST event exist */
be4f0921	139	LTTCOMM_UST_EVENT_NOT_FOUND, /* UST event not found */
ae357384	140	LTTCOMM_UST_CONTEXT_EXIST, /* UST context exist */
2bdd86d4	141
3bd1e081 MD	142	CONSUMERD_COMMAND_SOCK_READY, /* when consumerd command socket ready */
	143	CONSUMERD_SUCCESS_RECV_FD, /* success on receiving fds */
	144	CONSUMERD_ERROR_RECV_FD, /* error on receiving fds */
f2fc6720	145	CONSUMERD_ERROR_RECV_CMD, /* error on receiving command */
3bd1e081 MD	146	CONSUMERD_POLL_ERROR, /* Error in polling thread in kconsumerd */
	147	CONSUMERD_POLL_NVAL, /* Poll on closed fd */
	148	CONSUMERD_POLL_HUP, /* All fds have hungup */
	149	CONSUMERD_EXIT_SUCCESS, /* kconsumerd exiting normally */
	150	CONSUMERD_EXIT_FAILURE, /* kconsumerd exiting on error */
	151	CONSUMERD_OUTFD_ERROR, /* error opening the tracefile */
	152	CONSUMERD_SPLICE_EBADF, /* EBADF from splice(2) */
	153	CONSUMERD_SPLICE_EINVAL, /* EINVAL from splice(2) */
	154	CONSUMERD_SPLICE_ENOMEM, /* ENOMEM from splice(2) */
	155	CONSUMERD_SPLICE_ESPIPE, /* ESPIPE from splice(2) */
20fe2104 DG	156	/* MUST be last element */
20fe2104 DG	157	LTTCOMM_NR, /* Last element */
fac6795d DG	158	};
	159
	160	/*
9bda164d	161	* Data structure received from lttng client to session daemon.
fac6795d DG	162	*/
fac6795d DG	163	struct lttcomm_session_msg {
773168b7	164	uint32_t cmd_type; /* enum lttcomm_sessiond_command */
42abccdb	165	struct lttng_session session;
9f19cc17	166	struct lttng_domain domain;
fac6795d DG	167	union {
fac6795d DG	168	struct {
f3ed775e DG	169	char channel_name[NAME_MAX];
	170	char name[NAME_MAX];
	171	} disable;
	172	/* Event data */
fac6795d	173	struct {
f3ed775e DG	174	char channel_name[NAME_MAX];
	175	struct lttng_event event;
	176	} enable;
	177	/* Create channel */
	178	struct {
	179	struct lttng_channel chan;
	180	} channel;
d65106b1 DG	181	/* Context */
	182	struct {
	183	char channel_name[NAME_MAX];
	184	char event_name[NAME_MAX];
7d29a247	185	struct lttng_event_context ctx;
d65106b1	186	} context;
d9800920 DG	187	/* Use by register_consumer */
	188	struct {
	189	char path[PATH_MAX];
	190	} reg;
9f19cc17 DG	191	/* List */
	192	struct {
	193	char channel_name[NAME_MAX];
	194	} list;
d0254c7c	195	struct lttng_calibrate calibrate;
fac6795d DG	196	} u;
	197	};
	198
	199	/*
5e16da05	200	* Data structure for the response from sessiond to the lttng client.
fac6795d	201	*/
5461b305	202	struct lttcomm_lttng_msg {
773168b7 MD	203	uint32_t cmd_type; /* enum lttcomm_sessiond_command */
	204	uint32_t ret_code; /* enum lttcomm_return_code */
	205	uint32_t pid; /* pid_t */
	206	uint32_t data_size;
5461b305 DG	207	/* Contains: trace_name + data */
5461b305 DG	208	char payload[];
fac6795d DG	209	};
fac6795d DG	210
6e3805e2	211	/*
3bd1e081 MD	212	* lttcomm_consumer_msg is the message sent from sessiond to consumerd
	213	* to either add a channel, add a stream, update a stream, or stop
	214	* operation.
6e3805e2	215	*/
3bd1e081 MD	216	struct lttcomm_consumer_msg {
	217	uint32_t cmd_type; /* enum consumerd_command */
	218	union {
	219	struct {
	220	int channel_key;
	221	uint64_t max_sb_size; /* the subbuffer size for this channel */
	222	/* shm_fd and wait_fd are sent as ancillary data */
	223	uint64_t mmap_len;
	224	} channel;
	225	struct {
	226	int channel_key;
	227	int stream_key;
	228	/* shm_fd and wait_fd are sent as ancillary data */
	229	uint32_t state; /* enum lttcomm_consumer_fd_state */
	230	enum lttng_event_output output; /* use splice or mmap to consume this fd */
	231	uint64_t mmap_len;
	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 MD	283
	284	#define LTTCOMM_MAX_SEND_FDS 4
	285	/* Send a message accompanied by fd(s) over a unix socket. */
	286	extern ssize_t lttcomm_send_fds_unix_sock(int sock, int *fds, size_t nb_fd);
	287	/* Recv a message accompanied by fd(s) from a unix socket */
	288	extern ssize_t lttcomm_recv_fds_unix_sock(int sock, int *fds, size_t nb_fd);
	289
fac6795d DG	290	extern ssize_t lttcomm_recv_unix_sock(int sock, void *buf, size_t len);
fac6795d DG	291	extern ssize_t lttcomm_send_unix_sock(int sock, void *buf, size_t len);
d19d9ada DG	292
	293	extern ssize_t lttcomm_send_creds_unix_sock(int sock, void *buf, size_t len);
	294	extern ssize_t lttcomm_recv_creds_unix_sock(int sock, void *buf, size_t len,
	295	struct ucred *creds);
	296
fac6795d	297	extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
d19d9ada	298	extern int lttcomm_setsockopt_creds_unix_sock(int sock);
fac6795d	299
773168b7	300	#endif /* _LTTNG_SESSIOND_COMM_H */