[lttng-tools.git] / liblttsessiondcomm / liblttsessiondcomm.h

/*
 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
 *                      Julien Desfossez <julien.desfossez@polymtl.ca>
 *
 * 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.
 * 
 */

#ifndef _LIBLTTSESSIONDCOMM_H
#define _LIBLTTSESSIONDCOMM_H

#include <limits.h>

#include <lttng/lttng.h>
#include "lttng-share.h"

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

/* 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 context command */
	LTTNG_KERNEL_ADD_CONTEXT,
	LTTNG_KERNEL_DISABLE_CHANNEL,
	LTTNG_KERNEL_DISABLE_EVENT,
	LTTNG_KERNEL_DISABLE_ALL_EVENT,
	LTTNG_KERNEL_ENABLE_CHANNEL,
	LTTNG_KERNEL_ENABLE_EVENT,
	LTTNG_KERNEL_ENABLE_ALL_EVENT,
	LTTNG_KERNEL_LIST_EVENTS,
	/* Session daemon context command */
	LTTNG_CREATE_SESSION,
	LTTNG_DESTROY_SESSION,
	LTTNG_LIST_SESSIONS,
	LTTNG_LIST_TRACES,
	LTTNG_LIST_EVENTS,
	LTTNG_LIST_TRACEABLE_APPS,
	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_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 */
	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 {
	u32 cmd_type;    /* enum lttcomm_sessiond_command */
	char session_name[NAME_MAX];
	char path[PATH_MAX];
	pid_t pid;
	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;
	} u;
};

/*
 * Data structure for the response from sessiond to the lttng client.
 */
struct lttcomm_lttng_msg {
	u32 cmd_type;   /* enum lttcomm_sessiond_command */
	u32 ret_code;   /* enum lttcomm_return_code */
	u32 pid;        /* pid_t */
	u32 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 {
	u32 payload_size;
	u32 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;
	u32 state;    /* enum lttcomm_kconsumerd_fd_state */
	unsigned long max_sb_size; /* the subbuffer size for this channel */
};

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);
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	/* _LIBLTTSESSIONDCOMM_H */
Commit	Line	Data
6e3805e2 DG	1	/*
	2	* Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
	3	* Julien Desfossez <julien.desfossez@polymtl.ca>
fac6795d DG	4	*
	5	* This program is free software; you can redistribute it and/or
	6	* modify it under the terms of the GNU General Public License
82a3637f DG	7	* as published by the Free Software Foundation; only version 2
82a3637f DG	8	* of the License.
fac6795d DG	9	*
	10	* This program is distributed in the hope that it will be useful,
	11	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	12	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	13	* GNU General Public License for more details.
	14	*
	15	* You should have received a copy of the GNU General Public License
	16	* along with this program; if not, write to the Free Software
	17	* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
	18	*
	19	*/
	20
	21	#ifndef _LIBLTTSESSIONDCOMM_H
	22	#define _LIBLTTSESSIONDCOMM_H
	23
	24	#include <limits.h>
fac6795d	25
f3ed775e	26	#include <lttng/lttng.h>
9bda164d	27	#include "lttng-share.h"
5e16da05	28
fac6795d	29	/* Default unix socket path */
d6f42150 DG	30	#define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK LTTNG_RUNDIR "/client-ltt-sessiond"
d6f42150 DG	31	#define DEFAULT_GLOBAL_APPS_UNIX_SOCK LTTNG_RUNDIR "/apps-ltt-sessiond"
fac6795d DG	32	#define DEFAULT_HOME_APPS_UNIX_SOCK "%s/.apps-ltt-sessiond"
	33	#define DEFAULT_HOME_CLIENT_UNIX_SOCK "%s/.client-ltt-sessiond"
	34
	35	/* Queue size of listen(2) */
	36	#define MAX_LISTEN 10
	37
fac6795d DG	38	/* Get the error code index from 0 since
	39	* LTTCOMM_OK start at 1000
	40	*/
686204ab	41	#define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_OK)
fac6795d	42
6abb15de	43	enum lttcomm_sessiond_command {
f3ed775e	44	/* Tracer context command */
d65106b1	45	LTTNG_KERNEL_ADD_CONTEXT,
f3ed775e DG	46	LTTNG_KERNEL_DISABLE_CHANNEL,
	47	LTTNG_KERNEL_DISABLE_EVENT,
	48	LTTNG_KERNEL_DISABLE_ALL_EVENT,
	49	LTTNG_KERNEL_ENABLE_CHANNEL,
	50	LTTNG_KERNEL_ENABLE_EVENT,
	51	LTTNG_KERNEL_ENABLE_ALL_EVENT,
	52	LTTNG_KERNEL_LIST_EVENTS,
	53	/* Session daemon context command */
fac6795d DG	54	LTTNG_CREATE_SESSION,
fac6795d DG	55	LTTNG_DESTROY_SESSION,
fac6795d	56	LTTNG_LIST_SESSIONS,
1657e9bb	57	LTTNG_LIST_TRACES,
f3ed775e DG	58	LTTNG_LIST_EVENTS,
	59	LTTNG_LIST_TRACEABLE_APPS,
	60	LTTNG_START_TRACE,
	61	LTTNG_STOP_TRACE,
fac6795d DG	62	};
	63
	64	/*
	65	* lttcomm error code.
	66	*/
	67	enum lttcomm_return_code {
20fe2104 DG	68	LTTCOMM_OK = 1000, /* Ok */
	69	LTTCOMM_ERR, /* Unknown Error */
	70	LTTCOMM_UND, /* Undefine command */
7d29a247 DG	71	LTTCOMM_NOT_IMPLEMENTED, /* Command not implemented */
7d29a247 DG	72	LTTCOMM_UNKNOWN_DOMAIN, /* Tracing domain not known */
20fe2104 DG	73	LTTCOMM_ALLOC_FAIL, /* Trace allocation fail */
	74	LTTCOMM_NO_SESSION, /* No session found */
	75	LTTCOMM_CREATE_FAIL, /* Create trace fail */
	76	LTTCOMM_SESSION_FAIL, /* Create session fail */
	77	LTTCOMM_START_FAIL, /* Start tracing fail */
	78	LTTCOMM_STOP_FAIL, /* Stop tracing fail */
	79	LTTCOMM_LIST_FAIL, /* Listing apps fail */
	80	LTTCOMM_NO_APPS, /* No traceable application */
f3ed775e	81	LTTCOMM_SESS_NOT_FOUND, /* Session name not found */
20fe2104 DG	82	LTTCOMM_NO_TRACE, /* No trace exist */
	83	LTTCOMM_FATAL, /* Session daemon had a fatal error */
	84	LTTCOMM_NO_TRACEABLE, /* Error for non traceable app */
	85	LTTCOMM_SELECT_SESS, /* Must select a session */
	86	LTTCOMM_EXIST_SESS, /* Session name already exist */
	87	LTTCOMM_NO_EVENT, /* No event found */
	88	LTTCOMM_KERN_NA, /* Kernel tracer unavalable */
7d29a247	89	LTTCOMM_KERN_EVENT_EXIST, /* Kernel event already exists */
20fe2104 DG	90	LTTCOMM_KERN_SESS_FAIL, /* Kernel create session failed */
20fe2104 DG	91	LTTCOMM_KERN_CHAN_FAIL, /* Kernel create channel failed */
f3ed775e	92	LTTCOMM_KERN_CHAN_NOT_FOUND, /* Kernel channel not found */
26cc6b4e	93	LTTCOMM_KERN_CHAN_DISABLE_FAIL, /* Kernel disable channel failed */
d36b8583	94	LTTCOMM_KERN_CHAN_ENABLE_FAIL, /* Kernel enable channel failed */
d65106b1	95	LTTCOMM_KERN_CONTEXT_FAIL, /* Kernel add context failed */
f34daff7 DG	96	LTTCOMM_KERN_ENABLE_FAIL, /* Kernel enable event failed */
f34daff7 DG	97	LTTCOMM_KERN_DISABLE_FAIL, /* Kernel disable event failed */
aaf26714	98	LTTCOMM_KERN_META_FAIL, /* Kernel open metadata failed */
8c0faa1d DG	99	LTTCOMM_KERN_START_FAIL, /* Kernel start trace failed */
	100	LTTCOMM_KERN_STOP_FAIL, /* Kernel stop trace failed */
	101	LTTCOMM_KERN_CONSUMER_FAIL, /* Kernel consumer start failed */
	102	LTTCOMM_KERN_STREAM_FAIL, /* Kernel create stream failed */
	103	LTTCOMM_KERN_DIR_FAIL, /* Kernel trace directory creation failed */
84291629 DG	104	LTTCOMM_KERN_DIR_EXIST, /* Kernel trace directory exist */
84291629 DG	105	LTTCOMM_KERN_NO_SESSION, /* No kernel session found */
2ef84c95	106	LTTCOMM_KERN_LIST_FAIL, /* Kernel listing events failed */
d4a1283e	107	KCONSUMERD_COMMAND_SOCK_READY, /* when kconsumerd command socket ready */
20fe2104 DG	108	KCONSUMERD_SUCCESS_RECV_FD, /* success on receiving fds */
	109	KCONSUMERD_ERROR_RECV_FD, /* error on receiving fds */
	110	KCONSUMERD_POLL_ERROR, /* Error in polling thread in kconsumerd */
	111	KCONSUMERD_POLL_NVAL, /* Poll on closed fd */
	112	KCONSUMERD_POLL_HUP, /* All fds have hungup */
	113	KCONSUMERD_EXIT_SUCCESS, /* kconsumerd exiting normally */
	114	KCONSUMERD_EXIT_FAILURE, /* kconsumerd exiting on error */
	115	KCONSUMERD_OUTFD_ERROR, /* error opening the tracefile */
0632499a JD	116	KCONSUMERD_SPLICE_EBADF, /* EBADF from splice(2) */
	117	KCONSUMERD_SPLICE_EINVAL, /* EINVAL from splice(2) */
	118	KCONSUMERD_SPLICE_ENOMEM, /* ENOMEM from splice(2) */
	119	KCONSUMERD_SPLICE_ESPIPE, /* ESPIPE from splice(2) */
20fe2104 DG	120	/* MUST be last element */
20fe2104 DG	121	LTTCOMM_NR, /* Last element */
fac6795d DG	122	};
	123
	124	/*
9bda164d	125	* Data structure received from lttng client to session daemon.
fac6795d DG	126	*/
fac6795d DG	127	struct lttcomm_session_msg {
9bda164d	128	u32 cmd_type; /* enum lttcomm_sessiond_command */
fac6795d	129	char session_name[NAME_MAX];
f3ed775e DG	130	char path[PATH_MAX];
f3ed775e DG	131	pid_t pid;
fac6795d DG	132	union {
fac6795d DG	133	struct {
f3ed775e DG	134	char channel_name[NAME_MAX];
	135	char name[NAME_MAX];
	136	} disable;
	137	/* Event data */
fac6795d	138	struct {
f3ed775e DG	139	char channel_name[NAME_MAX];
	140	struct lttng_event event;
	141	} enable;
	142	/* Create channel */
	143	struct {
	144	struct lttng_channel chan;
	145	} channel;
d65106b1 DG	146	/* Context */
	147	struct {
	148	char channel_name[NAME_MAX];
	149	char event_name[NAME_MAX];
7d29a247	150	struct lttng_event_context ctx;
d65106b1	151	} context;
fac6795d DG	152	} u;
	153	};
	154
	155	/*
5e16da05	156	* Data structure for the response from sessiond to the lttng client.
fac6795d	157	*/
5461b305	158	struct lttcomm_lttng_msg {
9bda164d DG	159	u32 cmd_type; /* enum lttcomm_sessiond_command */
	160	u32 ret_code; /* enum lttcomm_return_code */
	161	u32 pid; /* pid_t */
5461b305	162	u32 data_size;
5461b305 DG	163	/* Contains: trace_name + data */
5461b305 DG	164	char payload[];
fac6795d DG	165	};
fac6795d DG	166
6e3805e2 DG	167	/*
	168	* Data structures for the kconsumerd communications
	169	*
	170	* The header structure is sent to the kconsumerd daemon to inform
	171	* how many lttcomm_kconsumerd_msg it is about to receive
	172	*/
	173	struct lttcomm_kconsumerd_header {
9bda164d	174	u32 payload_size;
9d26659a	175	u32 cmd_type; /* enum kconsumerd_command */
6e3805e2 DG	176	};
	177
	178	/* lttcomm_kconsumerd_msg represents a file descriptor to consume the
	179	* data and a path name to write it
	180	*/
	181	struct lttcomm_kconsumerd_msg {
	182	char path_name[PATH_MAX];
	183	int fd;
9bda164d	184	u32 state; /* enum lttcomm_kconsumerd_fd_state */
d4a1283e	185	unsigned long max_sb_size; /* the subbuffer size for this channel */
6e3805e2 DG	186	};
6e3805e2 DG	187
fac6795d DG	188	extern int lttcomm_create_unix_sock(const char *pathname);
	189	extern int lttcomm_connect_unix_sock(const char *pathname);
	190	extern int lttcomm_accept_unix_sock(int sock);
	191	extern int lttcomm_listen_unix_sock(int sock);
87378cf5	192	extern int lttcomm_close_unix_sock(int sock);
8c0faa1d	193	extern ssize_t lttcomm_send_fds_unix_sock(int sock, void buf, int fds, size_t nb_fd, size_t len);
fac6795d DG	194	extern ssize_t lttcomm_recv_unix_sock(int sock, void *buf, size_t len);
	195	extern ssize_t lttcomm_send_unix_sock(int sock, void *buf, size_t len);
	196	extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
	197
	198	#endif /* _LIBLTTSESSIONDCOMM_H */