[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.
 */

#include <limits.h>
#include <lttng/lttng.h>
#include <lttng-ust.h>

#define LTTNG_RUNDIR                        "/var/run/lttng"

/* Default unix socket path */
#define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK     LTTNG_RUNDIR "/client-ltt-sessiond"
#define DEFAULT_GLOBAL_APPS_UNIX_SOCK       LTTNG_RUNDIR "/apps-ltt-sessiond"
#define DEFAULT_HOME_APPS_UNIX_SOCK         "%s/.apps-ltt-sessiond"
#define DEFAULT_HOME_CLIENT_UNIX_SOCK       "%s/.client-ltt-sessiond"

/* Queue size of listen(2) */
#define 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_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 */
	KCONSUMERD_COMMAND_SOCK_READY,	/* when kconsumerd command socket ready */
	KCONSUMERD_SUCCESS_RECV_FD,		/* success on receiving fds */
	KCONSUMERD_ERROR_RECV_FD,		/* error on receiving fds */
	KCONSUMERD_POLL_ERROR,			/* Error in polling thread in kconsumerd */
	KCONSUMERD_POLL_NVAL,			/* Poll on closed fd */
	KCONSUMERD_POLL_HUP,			/* All fds have hungup */
	KCONSUMERD_EXIT_SUCCESS,		/* kconsumerd exiting normally */
	KCONSUMERD_EXIT_FAILURE,		/* kconsumerd exiting on error */
	KCONSUMERD_OUTFD_ERROR,			/* error opening the tracefile */
	KCONSUMERD_SPLICE_EBADF,		/* EBADF from splice(2) */
	KCONSUMERD_SPLICE_EINVAL,		/* EINVAL from splice(2) */
	KCONSUMERD_SPLICE_ENOMEM,		/* ENOMEM from splice(2) */
	KCONSUMERD_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[];
};

/*
 * Data structures for the kconsumerd communications
 *
 * The header structure is sent to the kconsumerd daemon to inform
 * how many lttcomm_kconsumerd_msg it is about to receive
 */
struct lttcomm_kconsumerd_header {
	uint32_t payload_size;
	uint32_t cmd_type;	/* enum kconsumerd_command */
};

/* lttcomm_kconsumerd_msg represents a file descriptor to consume the
 * data and a path name to write it
 */
struct lttcomm_kconsumerd_msg {
	char path_name[PATH_MAX];
	int fd;
	uint32_t state;    /* enum lttcomm_kconsumerd_fd_state */
	unsigned long max_sb_size; /* the subbuffer size for this channel */
	enum lttng_event_output output; /* use splice or mmap to consume this fd */
};

/*
 * Data structure for the commands sent from sessiond to UST.
 */
struct lttcomm_ust_msg {
	uint32_t handle;
	uint32_t cmd;
	union {
		struct lttng_ust_tracer_version version;
		struct lttng_ust_channel channel;
		struct lttng_ust_event event;
		struct lttng_ust_context context;
	} 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 {
	} u;
};

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 fd(s) over a unix socket. */
extern ssize_t lttcomm_send_fds_unix_sock(int sock, void *buf, int *fds,
		size_t nb_fd, size_t len);
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 const char *lttcomm_get_readable_code(enum lttcomm_return_code code);

#endif	/* _LTTNG_SESSIOND_COMM_H */
Commit	Line	Data
	1	#ifndef _LTTNG_SESSIOND_COMM_H
	2	#define _LTTNG_SESSIOND_COMM_H
	3
	4	/*
	5	* Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
	6	* Julien Desfossez <julien.desfossez@polymtl.ca>
	7	* Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	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
	11	* as published by the Free Software Foundation; only version 2
	12	* of the License.
	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.
	22	*/
	23
	24	/*
	25	* This header is meant for liblttng and libust internal use ONLY.
	26	* These declarations should NOT be considered stable API.
	27	*/
	28
	29	#include <limits.h>
	30	#include <lttng/lttng.h>
	31	#include <lttng-ust.h>
	32
	33	#define LTTNG_RUNDIR "/var/run/lttng"
	34
	35	/* Default unix socket path */
	36	#define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK LTTNG_RUNDIR "/client-ltt-sessiond"
	37	#define DEFAULT_GLOBAL_APPS_UNIX_SOCK LTTNG_RUNDIR "/apps-ltt-sessiond"
	38	#define DEFAULT_HOME_APPS_UNIX_SOCK "%s/.apps-ltt-sessiond"
	39	#define DEFAULT_HOME_CLIENT_UNIX_SOCK "%s/.client-ltt-sessiond"
	40
	41	/* Queue size of listen(2) */
	42	#define MAX_LISTEN 64
	43
	44	/*
	45	* Get the error code index from 0 since LTTCOMM_OK start at 1000
	46	*/
	47	#define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_OK)
	48
	49	enum lttcomm_sessiond_command {
	50	/* Tracer command */
	51	LTTNG_ADD_CONTEXT,
	52	LTTNG_CALIBRATE,
	53	LTTNG_DISABLE_CHANNEL,
	54	LTTNG_DISABLE_EVENT,
	55	LTTNG_DISABLE_ALL_EVENT,
	56	LTTNG_ENABLE_CHANNEL,
	57	LTTNG_ENABLE_EVENT,
	58	LTTNG_ENABLE_ALL_EVENT,
	59	/* Session daemon command */
	60	LTTNG_CREATE_SESSION,
	61	LTTNG_DESTROY_SESSION,
	62	LTTNG_LIST_CHANNELS,
	63	LTTNG_LIST_DOMAINS,
	64	LTTNG_LIST_EVENTS,
	65	LTTNG_LIST_SESSIONS,
	66	LTTNG_LIST_TRACEPOINTS,
	67	LTTNG_REGISTER_CONSUMER,
	68	LTTNG_START_TRACE,
	69	LTTNG_STOP_TRACE,
	70	};
	71
	72	/*
	73	* lttcomm error code.
	74	*/
	75	enum lttcomm_return_code {
	76	LTTCOMM_OK = 1000, /* Ok */
	77	LTTCOMM_ERR, /* Unknown Error */
	78	LTTCOMM_UND, /* Undefine command */
	79	LTTCOMM_NOT_IMPLEMENTED, /* Command not implemented */
	80	LTTCOMM_UNKNOWN_DOMAIN, /* Tracing domain not known */
	81	LTTCOMM_ALLOC_FAIL, /* Trace allocation fail */
	82	LTTCOMM_NO_SESSION, /* No session found */
	83	LTTCOMM_CREATE_FAIL, /* Create trace fail */
	84	LTTCOMM_SESSION_FAIL, /* Create session fail */
	85	LTTCOMM_START_FAIL, /* Start tracing fail */
	86	LTTCOMM_STOP_FAIL, /* Stop tracing fail */
	87	LTTCOMM_LIST_FAIL, /* Listing apps fail */
	88	LTTCOMM_NO_APPS, /* No traceable application */
	89	LTTCOMM_SESS_NOT_FOUND, /* Session name not found */
	90	LTTCOMM_NO_TRACE, /* No trace exist */
	91	LTTCOMM_FATAL, /* Session daemon had a fatal error */
	92	LTTCOMM_NO_TRACEABLE, /* Error for non traceable app */
	93	LTTCOMM_SELECT_SESS, /* Must select a session */
	94	LTTCOMM_EXIST_SESS, /* Session name already exist */
	95	LTTCOMM_NO_EVENT, /* No event found */
	96	LTTCOMM_CONNECT_FAIL, /* Unable to connect to unix socket */
	97	LTTCOMM_KERN_NA, /* Kernel tracer unavalable */
	98	LTTCOMM_KERN_EVENT_EXIST, /* Kernel event already exists */
	99	LTTCOMM_KERN_SESS_FAIL, /* Kernel create session failed */
	100	LTTCOMM_KERN_CHAN_FAIL, /* Kernel create channel failed */
	101	LTTCOMM_KERN_CHAN_NOT_FOUND, /* Kernel channel not found */
	102	LTTCOMM_KERN_CHAN_DISABLE_FAIL, /* Kernel disable channel failed */
	103	LTTCOMM_KERN_CHAN_ENABLE_FAIL, /* Kernel enable channel failed */
	104	LTTCOMM_KERN_CONTEXT_FAIL, /* Kernel add context failed */
	105	LTTCOMM_KERN_ENABLE_FAIL, /* Kernel enable event failed */
	106	LTTCOMM_KERN_DISABLE_FAIL, /* Kernel disable event failed */
	107	LTTCOMM_KERN_META_FAIL, /* Kernel open metadata failed */
	108	LTTCOMM_KERN_START_FAIL, /* Kernel start trace failed */
	109	LTTCOMM_KERN_STOP_FAIL, /* Kernel stop trace failed */
	110	LTTCOMM_KERN_CONSUMER_FAIL, /* Kernel consumer start failed */
	111	LTTCOMM_KERN_STREAM_FAIL, /* Kernel create stream failed */
	112	LTTCOMM_KERN_DIR_FAIL, /* Kernel trace directory creation failed */
	113	LTTCOMM_KERN_DIR_EXIST, /* Kernel trace directory exist */
	114	LTTCOMM_KERN_NO_SESSION, /* No kernel session found */
	115	LTTCOMM_KERN_LIST_FAIL, /* Kernel listing events failed */
	116	LTTCOMM_UST_SESS_FAIL, /* UST create session failed */
	117	KCONSUMERD_COMMAND_SOCK_READY, /* when kconsumerd command socket ready */
	118	KCONSUMERD_SUCCESS_RECV_FD, /* success on receiving fds */
	119	KCONSUMERD_ERROR_RECV_FD, /* error on receiving fds */
	120	KCONSUMERD_POLL_ERROR, /* Error in polling thread in kconsumerd */
	121	KCONSUMERD_POLL_NVAL, /* Poll on closed fd */
	122	KCONSUMERD_POLL_HUP, /* All fds have hungup */
	123	KCONSUMERD_EXIT_SUCCESS, /* kconsumerd exiting normally */
	124	KCONSUMERD_EXIT_FAILURE, /* kconsumerd exiting on error */
	125	KCONSUMERD_OUTFD_ERROR, /* error opening the tracefile */
	126	KCONSUMERD_SPLICE_EBADF, /* EBADF from splice(2) */
	127	KCONSUMERD_SPLICE_EINVAL, /* EINVAL from splice(2) */
	128	KCONSUMERD_SPLICE_ENOMEM, /* ENOMEM from splice(2) */
	129	KCONSUMERD_SPLICE_ESPIPE, /* ESPIPE from splice(2) */
	130	/* MUST be last element */
	131	LTTCOMM_NR, /* Last element */
	132	};
	133
	134	/*
	135	* Data structure received from lttng client to session daemon.
	136	*/
	137	struct lttcomm_session_msg {
	138	uint32_t cmd_type; /* enum lttcomm_sessiond_command */
	139	struct lttng_session session;
	140	struct lttng_domain domain;
	141	union {
	142	struct {
	143	char channel_name[NAME_MAX];
	144	char name[NAME_MAX];
	145	} disable;
	146	/* Event data */
	147	struct {
	148	char channel_name[NAME_MAX];
	149	struct lttng_event event;
	150	} enable;
	151	/* Create channel */
	152	struct {
	153	struct lttng_channel chan;
	154	} channel;
	155	/* Context */
	156	struct {
	157	char channel_name[NAME_MAX];
	158	char event_name[NAME_MAX];
	159	struct lttng_event_context ctx;
	160	} context;
	161	/* Use by register_consumer */
	162	struct {
	163	char path[PATH_MAX];
	164	} reg;
	165	/* List */
	166	struct {
	167	char channel_name[NAME_MAX];
	168	} list;
	169	struct lttng_calibrate calibrate;
	170	} u;
	171	};
	172
	173	/*
	174	* Data structure for the response from sessiond to the lttng client.
	175	*/
	176	struct lttcomm_lttng_msg {
	177	uint32_t cmd_type; /* enum lttcomm_sessiond_command */
	178	uint32_t ret_code; /* enum lttcomm_return_code */
	179	uint32_t pid; /* pid_t */
	180	uint32_t data_size;
	181	/* Contains: trace_name + data */
	182	char payload[];
	183	};
	184
	185	/*
	186	* Data structures for the kconsumerd communications
	187	*
	188	* The header structure is sent to the kconsumerd daemon to inform
	189	* how many lttcomm_kconsumerd_msg it is about to receive
	190	*/
	191	struct lttcomm_kconsumerd_header {
	192	uint32_t payload_size;
	193	uint32_t cmd_type; /* enum kconsumerd_command */
	194	};
	195
	196	/* lttcomm_kconsumerd_msg represents a file descriptor to consume the
	197	* data and a path name to write it
	198	*/
	199	struct lttcomm_kconsumerd_msg {
	200	char path_name[PATH_MAX];
	201	int fd;
	202	uint32_t state; /* enum lttcomm_kconsumerd_fd_state */
	203	unsigned long max_sb_size; /* the subbuffer size for this channel */
	204	enum lttng_event_output output; /* use splice or mmap to consume this fd */
	205	};
	206
	207	/*
	208	* Data structure for the commands sent from sessiond to UST.
	209	*/
	210	struct lttcomm_ust_msg {
	211	uint32_t handle;
	212	uint32_t cmd;
	213	union {
	214	struct lttng_ust_tracer_version version;
	215	struct lttng_ust_channel channel;
	216	struct lttng_ust_event event;
	217	struct lttng_ust_context context;
	218	} u;
	219	};
	220
	221	/*
	222	* Data structure for the response from UST to the session daemon.
	223	* cmd_type is sent back in the reply for validation.
	224	*/
	225	struct lttcomm_ust_reply {
	226	uint32_t handle;
	227	uint32_t cmd;
	228	uint32_t ret_code; /* enum lttcomm_return_code */
	229	uint32_t ret_val; /* return value */
	230	union {
	231	} u;
	232	};
	233
	234	extern int lttcomm_create_unix_sock(const char *pathname);
	235	extern int lttcomm_connect_unix_sock(const char *pathname);
	236	extern int lttcomm_accept_unix_sock(int sock);
	237	extern int lttcomm_listen_unix_sock(int sock);
	238	extern int lttcomm_close_unix_sock(int sock);
	239	/* Send fd(s) over a unix socket. */
	240	extern ssize_t lttcomm_send_fds_unix_sock(int sock, void buf, int fds,
	241	size_t nb_fd, size_t len);
	242	extern ssize_t lttcomm_recv_unix_sock(int sock, void *buf, size_t len);
	243	extern ssize_t lttcomm_send_unix_sock(int sock, void *buf, size_t len);
	244	extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
	245
	246	#endif /* _LTTNG_SESSIOND_COMM_H */