[deliverable/lttng-ust.git] / include / lttng-ust-comm.h

#ifndef _LTTNG_UST_COMM_H
#define _LTTNG_UST_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 <ust/lttng-ust-abi.h>

/*
 * Default timeout the application waits for the sessiond to send its
 * "register done" command. Can be overridden with the environment
 * variable "UST_REGISTER_TIMEOUT". Note that if the sessiond is not
 * found, the application proceeds directly without any delay.
 */
#define LTTNG_UST_DEFAULT_CONSTRUCTOR_TIMEOUT_MS	3000

#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 10

/* Get the error code index from 0 since
 * LTTCOMM_OK start at 1000
 */
#define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_OK)

/*
 * 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 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 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_UST_COMM_H */
Commit	Line	Data
b35d179d MD	1	#ifndef _LTTNG_UST_COMM_H
b35d179d MD	2	#define _LTTNG_UST_COMM_H
67c5b804 MD	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>
b35d179d	31	#include <ust/lttng-ust-abi.h>
67c5b804	32
11ff9c7d	33	/*
cf12a773 MD	34	* Default timeout the application waits for the sessiond to send its
	35	* "register done" command. Can be overridden with the environment
	36	* variable "UST_REGISTER_TIMEOUT". Note that if the sessiond is not
	37	* found, the application proceeds directly without any delay.
11ff9c7d	38	*/
cf12a773	39	#define LTTNG_UST_DEFAULT_CONSTRUCTOR_TIMEOUT_MS 3000
11ff9c7d	40
67c5b804 MD	41	#define LTTNG_RUNDIR "/var/run/lttng"
	42
	43	/* Default unix socket path */
	44	#define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK LTTNG_RUNDIR "/client-ltt-sessiond"
	45	#define DEFAULT_GLOBAL_APPS_UNIX_SOCK LTTNG_RUNDIR "/apps-ltt-sessiond"
	46	#define DEFAULT_HOME_APPS_UNIX_SOCK "%s/.apps-ltt-sessiond"
	47	#define DEFAULT_HOME_CLIENT_UNIX_SOCK "%s/.client-ltt-sessiond"
	48
	49	/* Queue size of listen(2) */
	50	#define MAX_LISTEN 10
	51
	52	/* Get the error code index from 0 since
	53	* LTTCOMM_OK start at 1000
	54	*/
	55	#define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_OK)
	56
67c5b804 MD	57	/*
	58	* lttcomm error code.
	59	*/
	60	enum lttcomm_return_code {
	61	LTTCOMM_OK = 1000, /* Ok */
	62	LTTCOMM_ERR, /* Unknown Error */
	63	LTTCOMM_UND, /* Undefine command */
	64	LTTCOMM_NOT_IMPLEMENTED, /* Command not implemented */
	65	LTTCOMM_UNKNOWN_DOMAIN, /* Tracing domain not known */
	66	LTTCOMM_ALLOC_FAIL, /* Trace allocation fail */
	67	LTTCOMM_NO_SESSION, /* No session found */
	68	LTTCOMM_CREATE_FAIL, /* Create trace fail */
	69	LTTCOMM_SESSION_FAIL, /* Create session fail */
	70	LTTCOMM_START_FAIL, /* Start tracing fail */
	71	LTTCOMM_STOP_FAIL, /* Stop tracing fail */
	72	LTTCOMM_LIST_FAIL, /* Listing apps fail */
	73	LTTCOMM_NO_APPS, /* No traceable application */
	74	LTTCOMM_SESS_NOT_FOUND, /* Session name not found */
	75	LTTCOMM_NO_TRACE, /* No trace exist */
	76	LTTCOMM_FATAL, /* Session daemon had a fatal error */
	77	LTTCOMM_NO_TRACEABLE, /* Error for non traceable app */
	78	LTTCOMM_SELECT_SESS, /* Must select a session */
	79	LTTCOMM_EXIST_SESS, /* Session name already exist */
	80	LTTCOMM_NO_EVENT, /* No event found */
	81	LTTCOMM_KERN_NA, /* Kernel tracer unavalable */
	82	LTTCOMM_KERN_EVENT_EXIST, /* Kernel event already exists */
	83	LTTCOMM_KERN_SESS_FAIL, /* Kernel create session failed */
	84	LTTCOMM_KERN_CHAN_FAIL, /* Kernel create channel failed */
	85	LTTCOMM_KERN_CHAN_NOT_FOUND, /* Kernel channel not found */
	86	LTTCOMM_KERN_CHAN_DISABLE_FAIL, /* Kernel disable channel failed */
	87	LTTCOMM_KERN_CHAN_ENABLE_FAIL, /* Kernel enable channel failed */
	88	LTTCOMM_KERN_CONTEXT_FAIL, /* Kernel add context failed */
	89	LTTCOMM_KERN_ENABLE_FAIL, /* Kernel enable event failed */
	90	LTTCOMM_KERN_DISABLE_FAIL, /* Kernel disable event failed */
	91	LTTCOMM_KERN_META_FAIL, /* Kernel open metadata failed */
	92	LTTCOMM_KERN_START_FAIL, /* Kernel start trace failed */
	93	LTTCOMM_KERN_STOP_FAIL, /* Kernel stop trace failed */
	94	LTTCOMM_KERN_CONSUMER_FAIL, /* Kernel consumer start failed */
	95	LTTCOMM_KERN_STREAM_FAIL, /* Kernel create stream failed */
	96	LTTCOMM_KERN_DIR_FAIL, /* Kernel trace directory creation failed */
	97	LTTCOMM_KERN_DIR_EXIST, /* Kernel trace directory exist */
	98	LTTCOMM_KERN_NO_SESSION, /* No kernel session found */
	99	LTTCOMM_KERN_LIST_FAIL, /* Kernel listing events failed */
	100	KCONSUMERD_COMMAND_SOCK_READY, /* when kconsumerd command socket ready */
	101	KCONSUMERD_SUCCESS_RECV_FD, /* success on receiving fds */
	102	KCONSUMERD_ERROR_RECV_FD, /* error on receiving fds */
	103	KCONSUMERD_POLL_ERROR, /* Error in polling thread in kconsumerd */
	104	KCONSUMERD_POLL_NVAL, /* Poll on closed fd */
	105	KCONSUMERD_POLL_HUP, /* All fds have hungup */
	106	KCONSUMERD_EXIT_SUCCESS, /* kconsumerd exiting normally */
	107	KCONSUMERD_EXIT_FAILURE, /* kconsumerd exiting on error */
	108	KCONSUMERD_OUTFD_ERROR, /* error opening the tracefile */
	109	KCONSUMERD_SPLICE_EBADF, /* EBADF from splice(2) */
	110	KCONSUMERD_SPLICE_EINVAL, /* EINVAL from splice(2) */
	111	KCONSUMERD_SPLICE_ENOMEM, /* ENOMEM from splice(2) */
	112	KCONSUMERD_SPLICE_ESPIPE, /* ESPIPE from splice(2) */
	113	/* MUST be last element */
	114	LTTCOMM_NR, /* Last element */
	115	};
	116
	117	/*
e7723462	118	* Data structure for the commands sent from sessiond to UST.
67c5b804	119	*/
e7723462	120	struct lttcomm_ust_msg {
1ece9766	121	uint32_t handle;
46050b1a	122	uint32_t cmd;
67c5b804	123	union {
1ece9766 MD	124	struct lttng_ust_tracer_version version;
	125	struct lttng_ust_channel channel;
	126	struct lttng_ust_event event;
	127	struct lttng_ust_context context;
67c5b804 MD	128	} u;
	129	};
	130
9eb62b9c MD	131	/*
	132	* Data structure for the response from UST to the session daemon.
	133	* cmd_type is sent back in the reply for validation.
	134	*/
e7723462	135	struct lttcomm_ust_reply {
46050b1a MD	136	uint32_t handle;
46050b1a MD	137	uint32_t cmd;
9eb62b9c	138	uint32_t ret_code; /* enum enum lttcomm_return_code */
1ece9766	139	uint32_t ret_val; /* return value */
9eb62b9c	140	union {
9eb62b9c MD	141	} u;
	142	};
	143
67c5b804 MD	144	extern int lttcomm_create_unix_sock(const char *pathname);
	145	extern int lttcomm_connect_unix_sock(const char *pathname);
	146	extern int lttcomm_accept_unix_sock(int sock);
	147	extern int lttcomm_listen_unix_sock(int sock);
	148	extern int lttcomm_close_unix_sock(int sock);
	149	/* Send fd(s) over a unix socket. */
	150	extern ssize_t lttcomm_send_fds_unix_sock(int sock, void buf, int fds,
	151	size_t nb_fd, size_t len);
	152	extern ssize_t lttcomm_recv_unix_sock(int sock, void *buf, size_t len);
	153	extern ssize_t lttcomm_send_unix_sock(int sock, void *buf, size_t len);
	154	extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
	155
b35d179d	156	#endif /* _LTTNG_UST_COMM_H */