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

/* Copyright (C) 2011 - David Goulet <david.goulet@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>

/* Default unix socket path */
#define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK		"/tmp/client-ltt-sessiond"
#define DEFAULT_GLOBAL_APPS_UNIX_SOCK		"/tmp/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_command_type {
	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_NR,				/* Last element */
};

/*
 * Data structure for ltt-session received message
 */
struct lttcomm_session_msg {
	/* Common data to almost all command */
	enum lttcomm_command_type cmd_type;
	uuid_t session_id;
	char trace_name[NAME_MAX];
	char session_name[NAME_MAX];
	pid_t pid;
	union {
		struct {
			int auto_session;
		} create_session;
		/* Marker data */
		struct {
			char channel[NAME_MAX];
			char marker[NAME_MAX];
		} marker;
		/* SET_SOCK_PATH */
		struct {
			char sock_path[PATH_MAX];
		} sock_path;
		/* SET_SUBBUF_NUM */
		struct {
			unsigned int subbuf_num;
			char channel[NAME_MAX];
		} subbuf_num;
		/* SET_SUBBUF_SIZE */
		struct {
			unsigned int subbuf_size;
			char channel[NAME_MAX];
		} subbuf_size;
	} u;
};

/*
 * Data structure for the lttng client response.
 *
 * This data structure is the control struct use in
 * the header of the transmission. NEVER put variable
 * size data in here.
 */
struct lttcomm_lttng_msg {
	enum lttcomm_command_type cmd_type;
	enum lttcomm_return_code ret_code;
	uuid_t session_id;
	pid_t pid;
	char trace_name[NAME_MAX];
	unsigned int size_payload;
};

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_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
	1	/* Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
	2	*
	3	* This program is free software; you can redistribute it and/or
	4	* modify it under the terms of the GNU General Public License
	5	* as published by the Free Software Foundation; either version 2
	6	* of the License, or (at your option) any later version.
	7	*
	8	* This program is distributed in the hope that it will be useful,
	9	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	10	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	11	* GNU General Public License for more details.
	12	*
	13	* You should have received a copy of the GNU General Public License
	14	* along with this program; if not, write to the Free Software
	15	* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
	16	*
	17	*/
	18
	19	#ifndef _LIBLTTSESSIONDCOMM_H
	20	#define _LIBLTTSESSIONDCOMM_H
	21
	22	#include <limits.h>
	23	#include <uuid/uuid.h>
	24
	25	/* Default unix socket path */
	26	#define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK "/tmp/client-ltt-sessiond"
	27	#define DEFAULT_GLOBAL_APPS_UNIX_SOCK "/tmp/apps-ltt-sessiond"
	28	#define DEFAULT_HOME_APPS_UNIX_SOCK "%s/.apps-ltt-sessiond"
	29	#define DEFAULT_HOME_CLIENT_UNIX_SOCK "%s/.client-ltt-sessiond"
	30
	31	/* Queue size of listen(2) */
	32	#define MAX_LISTEN 10
	33
	34	/* Get the error code index from 0 since
	35	* LTTCOMM_OK start at 1000
	36	*/
	37	#define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_OK)
	38
	39	enum lttcomm_command_type {
	40	LTTNG_CREATE_SESSION,
	41	LTTNG_DESTROY_SESSION,
	42	LTTNG_FORCE_SUBBUF_SWITCH,
	43	LTTNG_GET_ALL_SESSION,
	44	LTTNG_GET_SOCK_PATH,
	45	LTTNG_GET_SUBBUF_NUM_SIZE,
	46	LTTNG_LIST_MARKERS,
	47	LTTNG_LIST_SESSIONS,
	48	LTTNG_LIST_TRACES,
	49	LTTNG_LIST_TRACE_EVENTS,
	50	LTTNG_SETUP_TRACE,
	51	LTTNG_SET_SOCK_PATH,
	52	LTTNG_SET_SUBBUF_NUM,
	53	LTTNG_SET_SUBBUF_SIZE,
	54	UST_ALLOC_TRACE,
	55	UST_CREATE_TRACE,
	56	UST_DESTROY_TRACE,
	57	UST_DISABLE_MARKER,
	58	UST_ENABLE_MARKER,
	59	UST_LIST_APPS,
	60	UST_START_TRACE,
	61	UST_STOP_TRACE,
	62	};
	63
	64	/*
	65	* lttcomm error code.
	66	*/
	67	enum lttcomm_return_code {
	68	LTTCOMM_OK = 1000, /* Ok */
	69	LTTCOMM_ERR, /* Unknown Error */
	70	LTTCOMM_UND, /* Undefine command */
	71	LTTCOMM_ALLOC_FAIL, /* Trace allocation fail */
	72	LTTCOMM_NO_SESSION, /* No session found */
	73	LTTCOMM_CREATE_FAIL, /* Create trace fail */
	74	LTTCOMM_SESSION_FAIL, /* Create session fail */
	75	LTTCOMM_START_FAIL, /* Start tracing fail */
	76	LTTCOMM_STOP_FAIL, /* Stop tracing fail */
	77	LTTCOMM_LIST_FAIL, /* Listing apps fail */
	78	LTTCOMM_NO_APPS, /* No traceable application */
	79	LTTCOMM_NO_SESS, /* No sessions available */
	80	LTTCOMM_NO_TRACE, /* No trace exist */
	81	LTTCOMM_FATAL, /* Session daemon had a fatal error */
	82	LTTCOMM_NO_TRACEABLE, /* Error for non traceable app */
	83	LTTCOMM_SELECT_SESS, /* Must select a session */
	84	LTTCOMM_EXIST_SESS, /* Session name already exist */
	85	LTTCOMM_NR, /* Last element */
	86	};
	87
	88	/*
	89	* Data structure for ltt-session received message
	90	*/
	91	struct lttcomm_session_msg {
	92	/* Common data to almost all command */
	93	enum lttcomm_command_type cmd_type;
	94	uuid_t session_id;
	95	char trace_name[NAME_MAX];
	96	char session_name[NAME_MAX];
	97	pid_t pid;
	98	union {
	99	struct {
	100	int auto_session;
	101	} create_session;
	102	/* Marker data */
	103	struct {
	104	char channel[NAME_MAX];
	105	char marker[NAME_MAX];
	106	} marker;
	107	/* SET_SOCK_PATH */
	108	struct {
	109	char sock_path[PATH_MAX];
	110	} sock_path;
	111	/* SET_SUBBUF_NUM */
	112	struct {
	113	unsigned int subbuf_num;
	114	char channel[NAME_MAX];
	115	} subbuf_num;
	116	/* SET_SUBBUF_SIZE */
	117	struct {
	118	unsigned int subbuf_size;
	119	char channel[NAME_MAX];
	120	} subbuf_size;
	121	} u;
	122	};
	123
	124	/*
	125	* Data structure for the lttng client response.
	126	*
	127	* This data structure is the control struct use in
	128	* the header of the transmission. NEVER put variable
	129	* size data in here.
	130	*/
	131	struct lttcomm_lttng_msg {
	132	enum lttcomm_command_type cmd_type;
	133	enum lttcomm_return_code ret_code;
	134	uuid_t session_id;
	135	pid_t pid;
	136	char trace_name[NAME_MAX];
	137	unsigned int size_payload;
	138	};
	139
	140	extern int lttcomm_create_unix_sock(const char *pathname);
	141	extern int lttcomm_connect_unix_sock(const char *pathname);
	142	extern int lttcomm_accept_unix_sock(int sock);
	143	extern int lttcomm_listen_unix_sock(int sock);
	144	extern int lttcomm_close_unix_sock(int sock);
	145	extern ssize_t lttcomm_recv_unix_sock(int sock, void *buf, size_t len);
	146	extern ssize_t lttcomm_send_unix_sock(int sock, void *buf, size_t len);
	147	extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
	148
	149	#endif /* _LIBLTTSESSIONDCOMM_H */