[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; either version 2
 * of the License, or (at your option) any later version.
 * 
 * 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 <uuid/uuid.h>

#include "lttng-share.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"

/* Kernel consumer path */
#define KCONSUMERD_PATH						LTTNG_RUNDIR "/kconsumerd"
#define KCONSUMERD_CMD_SOCK_PATH			KCONSUMERD_PATH "/command"
#define KCONSUMERD_ERR_SOCK_PATH			KCONSUMERD_PATH "/error"

/* 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 {
	KERNEL_CREATE_CHANNEL,
	KERNEL_CREATE_SESSION,
	KERNEL_CREATE_STREAM,
	KERNEL_DISABLE_EVENT,
	KERNEL_ENABLE_EVENT,
	KERNEL_OPEN_METADATA,
	KERNEL_START_TRACE,
	KERNEL_STOP_TRACE,
	LTTNG_CREATE_SESSION,
	LTTNG_DESTROY_SESSION,
	LTTNG_FORCE_SUBBUF_SWITCH,
	LTTNG_GET_ALL_SESSION,
	LTTNG_GET_SOCK_PATH,
	LTTNG_GET_SUBBUF_NUM_SIZE,
	LTTNG_LIST_MARKERS,
	LTTNG_LIST_SESSIONS,
	LTTNG_LIST_TRACES,
	LTTNG_LIST_TRACE_EVENTS,
	LTTNG_SETUP_TRACE,
	LTTNG_SET_SOCK_PATH,
	LTTNG_SET_SUBBUF_NUM,
	LTTNG_SET_SUBBUF_SIZE,
	UST_ALLOC_TRACE,
	UST_CREATE_TRACE,
	UST_DESTROY_TRACE,
	UST_DISABLE_MARKER,
	UST_ENABLE_MARKER,
	UST_LIST_APPS,
	UST_START_TRACE,
	UST_STOP_TRACE,
};

/*
 * lttcomm error code.
 */
enum lttcomm_return_code {
	LTTCOMM_OK = 1000,				/* Ok */
	LTTCOMM_ERR,					/* Unknown Error */
	LTTCOMM_UND,					/* Undefine command */
	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_NO_SESS,				/* No sessions available */
	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_SESS_FAIL,			/* Kernel create session failed */
	LTTCOMM_KERN_CHAN_FAIL,			/* Kernel create channel 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 traec directory exist */
	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 */
};

/* commands for kconsumerd */
enum lttcomm_consumerd_command {
	LTTCOMM_ADD_STREAM = 1100,
	LTTCOMM_UPDATE_STREAM, /* pause, delete, start depending on fd state */
	LTTCOMM_STOP, /* delete all */
};

/* state of each fd in consumerd */
enum lttcomm_kconsumerd_fd_state {
	ACTIVE_FD,
	PAUSE_FD,
	DELETE_FD,
};

/*
 * Data structure received from lttng client to session daemon.
 */
struct lttcomm_session_msg {
	u32 cmd_type;    /* enum lttcomm_sessiond_command */
	uuid_t session_uuid;
	char trace_name[NAME_MAX];
	char session_name[NAME_MAX];
	u32 pid;    /* pid_t */
	union {
		struct {
			int auto_session;
		} create_session;
		/* Marker data */
		struct {
			char event_name[NAME_MAX];
		} event;
	} 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 trace_name_offset;
	u32 data_size;
	uuid_t session_uuid;
	/* 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 lttcomm_consumerd_command */
	u32 ret_code;	/* enum lttcomm_return_code */
};

/* 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
	7	* as published by the Free Software Foundation; either version 2
	8	* of the License, or (at your option) any later version.
	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>
	25	#include <uuid/uuid.h>
	26
9bda164d	27	#include "lttng-share.h"
5e16da05	28
d6f42150 DG	29	#define LTTNG_RUNDIR "/var/run/lttng"
d6f42150 DG	30
fac6795d	31	/* Default unix socket path */
d6f42150 DG	32	#define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK LTTNG_RUNDIR "/client-ltt-sessiond"
d6f42150 DG	33	#define DEFAULT_GLOBAL_APPS_UNIX_SOCK LTTNG_RUNDIR "/apps-ltt-sessiond"
fac6795d DG	34	#define DEFAULT_HOME_APPS_UNIX_SOCK "%s/.apps-ltt-sessiond"
	35	#define DEFAULT_HOME_CLIENT_UNIX_SOCK "%s/.client-ltt-sessiond"
	36
d6f42150 DG	37	/* Kernel consumer path */
	38	#define KCONSUMERD_PATH LTTNG_RUNDIR "/kconsumerd"
	39	#define KCONSUMERD_CMD_SOCK_PATH KCONSUMERD_PATH "/command"
	40	#define KCONSUMERD_ERR_SOCK_PATH KCONSUMERD_PATH "/error"
	41
fac6795d DG	42	/* Queue size of listen(2) */
	43	#define MAX_LISTEN 10
	44
fac6795d DG	45	/* Get the error code index from 0 since
	46	* LTTCOMM_OK start at 1000
	47	*/
686204ab	48	#define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_OK)
fac6795d	49
6abb15de	50	enum lttcomm_sessiond_command {
1df4dedd DG	51	KERNEL_CREATE_CHANNEL,
1df4dedd DG	52	KERNEL_CREATE_SESSION,
8c0faa1d	53	KERNEL_CREATE_STREAM,
1df4dedd DG	54	KERNEL_DISABLE_EVENT,
1df4dedd DG	55	KERNEL_ENABLE_EVENT,
aaf26714	56	KERNEL_OPEN_METADATA,
1df4dedd DG	57	KERNEL_START_TRACE,
1df4dedd DG	58	KERNEL_STOP_TRACE,
fac6795d DG	59	LTTNG_CREATE_SESSION,
	60	LTTNG_DESTROY_SESSION,
	61	LTTNG_FORCE_SUBBUF_SWITCH,
	62	LTTNG_GET_ALL_SESSION,
	63	LTTNG_GET_SOCK_PATH,
	64	LTTNG_GET_SUBBUF_NUM_SIZE,
	65	LTTNG_LIST_MARKERS,
	66	LTTNG_LIST_SESSIONS,
1657e9bb	67	LTTNG_LIST_TRACES,
fac6795d DG	68	LTTNG_LIST_TRACE_EVENTS,
	69	LTTNG_SETUP_TRACE,
	70	LTTNG_SET_SOCK_PATH,
	71	LTTNG_SET_SUBBUF_NUM,
	72	LTTNG_SET_SUBBUF_SIZE,
	73	UST_ALLOC_TRACE,
	74	UST_CREATE_TRACE,
	75	UST_DESTROY_TRACE,
	76	UST_DISABLE_MARKER,
	77	UST_ENABLE_MARKER,
	78	UST_LIST_APPS,
	79	UST_START_TRACE,
	80	UST_STOP_TRACE,
	81	};
	82
	83	/*
	84	* lttcomm error code.
	85	*/
	86	enum lttcomm_return_code {
20fe2104 DG	87	LTTCOMM_OK = 1000, /* Ok */
	88	LTTCOMM_ERR, /* Unknown Error */
	89	LTTCOMM_UND, /* Undefine command */
	90	LTTCOMM_ALLOC_FAIL, /* Trace allocation fail */
	91	LTTCOMM_NO_SESSION, /* No session found */
	92	LTTCOMM_CREATE_FAIL, /* Create trace fail */
	93	LTTCOMM_SESSION_FAIL, /* Create session fail */
	94	LTTCOMM_START_FAIL, /* Start tracing fail */
	95	LTTCOMM_STOP_FAIL, /* Stop tracing fail */
	96	LTTCOMM_LIST_FAIL, /* Listing apps fail */
	97	LTTCOMM_NO_APPS, /* No traceable application */
	98	LTTCOMM_NO_SESS, /* No sessions available */
	99	LTTCOMM_NO_TRACE, /* No trace exist */
	100	LTTCOMM_FATAL, /* Session daemon had a fatal error */
	101	LTTCOMM_NO_TRACEABLE, /* Error for non traceable app */
	102	LTTCOMM_SELECT_SESS, /* Must select a session */
	103	LTTCOMM_EXIST_SESS, /* Session name already exist */
	104	LTTCOMM_NO_EVENT, /* No event found */
	105	LTTCOMM_KERN_NA, /* Kernel tracer unavalable */
	106	LTTCOMM_KERN_SESS_FAIL, /* Kernel create session failed */
	107	LTTCOMM_KERN_CHAN_FAIL, /* Kernel create channel 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 */
	116	LTTCOMM_KERN_DIR_EXIST, /* Kernel traec directory exist */
d4a1283e	117	KCONSUMERD_COMMAND_SOCK_READY, /* when kconsumerd command socket ready */
20fe2104 DG	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 */
0632499a JD	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) */
20fe2104 DG	130	/* MUST be last element */
20fe2104 DG	131	LTTCOMM_NR, /* Last element */
fac6795d DG	132	};
fac6795d DG	133
6e3805e2 DG	134	/* commands for kconsumerd */
	135	enum lttcomm_consumerd_command {
	136	LTTCOMM_ADD_STREAM = 1100,
	137	LTTCOMM_UPDATE_STREAM, /* pause, delete, start depending on fd state */
	138	LTTCOMM_STOP, /* delete all */
	139	};
	140
	141	/* state of each fd in consumerd */
	142	enum lttcomm_kconsumerd_fd_state {
	143	ACTIVE_FD,
	144	PAUSE_FD,
	145	DELETE_FD,
	146	};
	147
fac6795d	148	/*
9bda164d	149	* Data structure received from lttng client to session daemon.
fac6795d DG	150	*/
fac6795d DG	151	struct lttcomm_session_msg {
9bda164d	152	u32 cmd_type; /* enum lttcomm_sessiond_command */
5461b305	153	uuid_t session_uuid;
fac6795d DG	154	char trace_name[NAME_MAX];
fac6795d DG	155	char session_name[NAME_MAX];
9bda164d	156	u32 pid; /* pid_t */
fac6795d DG	157	union {
	158	struct {
	159	int auto_session;
	160	} create_session;
	161	/* Marker data */
	162	struct {
1df4dedd DG	163	char event_name[NAME_MAX];
1df4dedd DG	164	} event;
fac6795d DG	165	} u;
	166	};
	167
	168	/*
5e16da05	169	* Data structure for the response from sessiond to the lttng client.
fac6795d	170	*/
5461b305	171	struct lttcomm_lttng_msg {
9bda164d DG	172	u32 cmd_type; /* enum lttcomm_sessiond_command */
	173	u32 ret_code; /* enum lttcomm_return_code */
	174	u32 pid; /* pid_t */
5461b305 DG	175	u32 trace_name_offset;
	176	u32 data_size;
	177	uuid_t session_uuid;
	178	/* Contains: trace_name + data */
	179	char payload[];
fac6795d DG	180	};
fac6795d DG	181
6e3805e2 DG	182	/*
	183	* Data structures for the kconsumerd communications
	184	*
	185	* The header structure is sent to the kconsumerd daemon to inform
	186	* how many lttcomm_kconsumerd_msg it is about to receive
	187	*/
	188	struct lttcomm_kconsumerd_header {
9bda164d DG	189	u32 payload_size;
	190	u32 cmd_type; /* enum lttcomm_consumerd_command */
	191	u32 ret_code; /* enum lttcomm_return_code */
6e3805e2 DG	192	};
	193
	194	/* lttcomm_kconsumerd_msg represents a file descriptor to consume the
	195	* data and a path name to write it
	196	*/
	197	struct lttcomm_kconsumerd_msg {
	198	char path_name[PATH_MAX];
	199	int fd;
9bda164d	200	u32 state; /* enum lttcomm_kconsumerd_fd_state */
d4a1283e	201	unsigned long max_sb_size; /* the subbuffer size for this channel */
6e3805e2 DG	202	};
6e3805e2 DG	203
fac6795d DG	204	extern int lttcomm_create_unix_sock(const char *pathname);
	205	extern int lttcomm_connect_unix_sock(const char *pathname);
	206	extern int lttcomm_accept_unix_sock(int sock);
	207	extern int lttcomm_listen_unix_sock(int sock);
87378cf5	208	extern int lttcomm_close_unix_sock(int sock);
8c0faa1d	209	extern ssize_t lttcomm_send_fds_unix_sock(int sock, void buf, int fds, size_t nb_fd, size_t len);
fac6795d DG	210	extern ssize_t lttcomm_recv_unix_sock(int sock, void *buf, size_t len);
	211	extern ssize_t lttcomm_send_unix_sock(int sock, void *buf, size_t len);
	212	extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
	213
	214	#endif /* _LIBLTTSESSIONDCOMM_H */