[lttng-ust.git] / include / 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 library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; only
 * version 2.1 of the License.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

/*
 * This header is meant for liblttng and libust internal use ONLY.
 * These declarations should NOT be considered stable API.
 */

#include <limits.h>
#include <unistd.h>
#include <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 "LTTNG_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"
#define LTTNG_HOME_RUNDIR                   "%s/.lttng"

/* Default unix socket path */
#define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK     LTTNG_RUNDIR "/client-lttng-sessiond"
#define DEFAULT_GLOBAL_APPS_UNIX_SOCK       LTTNG_RUNDIR "/apps-lttng-sessiond"
#define DEFAULT_HOME_APPS_UNIX_SOCK         LTTNG_HOME_RUNDIR "/apps-lttng-sessiond"
#define DEFAULT_HOME_CLIENT_UNIX_SOCK       LTTNG_HOME_RUNDIR "/client-lttng-sessiond"

#define DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH   "/lttng-ust-apps-wait"
#define DEFAULT_HOME_APPS_WAIT_SHM_PATH     "/lttng-ust-apps-wait-%u"

/* Queue size of listen(2) */
#define LTTNG_UST_COMM_MAX_LISTEN 10

/* Get the error code index from 0. USTCOMM_ERR starts at 1000.
 */
#define USTCOMM_ERR_INDEX(code) (code - USTCOMM_ERR)

/*
 * ustcomm error code.
 */
enum ustcomm_return_code {
	USTCOMM_OK = 0,					/* Ok */
	/* Range 1 to 999 used for standard error numbers (errno.h) */
	USTCOMM_ERR = 1000,				/* Unknown Error */
	USTCOMM_UND,					/* Undefine command */
	USTCOMM_NOT_IMPLEMENTED,        /* Command not implemented */
	USTCOMM_UNKNOWN_DOMAIN,         /* Tracing domain not known */
	USTCOMM_ALLOC_FAIL,				/* Trace allocation fail */
	USTCOMM_NO_SESSION,				/* No session found */
	USTCOMM_CREATE_FAIL,			/* Create trace fail */
	USTCOMM_SESSION_FAIL,			/* Create session fail */
	USTCOMM_START_FAIL,				/* Start tracing fail */
	USTCOMM_STOP_FAIL,				/* Stop tracing fail */
	USTCOMM_LIST_FAIL,				/* Listing apps fail */
	USTCOMM_NO_APPS,				/* No traceable application */
	USTCOMM_SESS_NOT_FOUND,			/* Session name not found */
	USTCOMM_NO_TRACE,				/* No trace exist */
	USTCOMM_FATAL,					/* Session daemon had a fatal error */
	USTCOMM_NO_TRACEABLE,			/* Error for non traceable app */
	USTCOMM_SELECT_SESS,			/* Must select a session */
	USTCOMM_EXIST_SESS,				/* Session name already exist */
	USTCOMM_NO_EVENT,				/* No event found */
	USTCOMM_KERN_NA,				/* Kernel tracer unavalable */
	USTCOMM_KERN_EVENT_EXIST,       /* Kernel event already exists */
	USTCOMM_KERN_SESS_FAIL,			/* Kernel create session failed */
	USTCOMM_KERN_CHAN_FAIL,			/* Kernel create channel failed */
	USTCOMM_KERN_CHAN_NOT_FOUND,	/* Kernel channel not found */
	USTCOMM_KERN_CHAN_DISABLE_FAIL, /* Kernel disable channel failed */
	USTCOMM_KERN_CHAN_ENABLE_FAIL,  /* Kernel enable channel failed */
	USTCOMM_KERN_CONTEXT_FAIL,      /* Kernel add context failed */
	USTCOMM_KERN_ENABLE_FAIL,		/* Kernel enable event failed */
	USTCOMM_KERN_DISABLE_FAIL,		/* Kernel disable event failed */
	USTCOMM_KERN_META_FAIL,			/* Kernel open metadata failed */
	USTCOMM_KERN_START_FAIL,		/* Kernel start trace failed */
	USTCOMM_KERN_STOP_FAIL,			/* Kernel stop trace failed */
	USTCOMM_KERN_CONSUMER_FAIL,		/* Kernel consumer start failed */
	USTCOMM_KERN_STREAM_FAIL,		/* Kernel create stream failed */
	USTCOMM_KERN_DIR_FAIL,			/* Kernel trace directory creation failed */
	USTCOMM_KERN_DIR_EXIST,			/* Kernel trace directory exist */
	USTCOMM_KERN_NO_SESSION,		/* No kernel session found */
	USTCOMM_KERN_LIST_FAIL,			/* Kernel listing events failed */
	USTCONSUMER_COMMAND_SOCK_READY,	/* when kconsumerd command socket ready */
	USTCONSUMER_SUCCESS_RECV_FD,		/* success on receiving fds */
	USTCONSUMER_ERROR_RECV_FD,		/* error on receiving fds */
	USTCONSUMER_POLL_ERROR,			/* Error in polling thread in kconsumerd */
	USTCONSUMER_POLL_NVAL,			/* Poll on closed fd */
	USTCONSUMER_POLL_HUP,			/* All fds have hungup */
	USTCONSUMER_EXIT_SUCCESS,		/* kconsumerd exiting normally */
	USTCONSUMER_EXIT_FAILURE,		/* kconsumerd exiting on error */
	USTCONSUMER_OUTFD_ERROR,			/* error opening the tracefile */
	USTCONSUMER_SPLICE_EBADF,		/* EBADF from splice(2) */
	USTCONSUMER_SPLICE_EINVAL,		/* EINVAL from splice(2) */
	USTCONSUMER_SPLICE_ENOMEM,		/* ENOMEM from splice(2) */
	USTCONSUMER_SPLICE_ESPIPE,		/* ESPIPE from splice(2) */
	/* MUST be last element */
	USTCOMM_NR,						/* Last element */
};

/*
 * Data structure for the commands sent from sessiond to UST.
 */
struct ustcomm_ust_msg {
	uint32_t handle;
	uint32_t cmd;
	union {
		struct lttng_ust_channel channel;
		struct lttng_ust_stream stream;
		struct lttng_ust_event event;
		struct lttng_ust_context context;
		struct lttng_ust_tracer_version version;
		struct lttng_ust_tracepoint_iter tracepoint;
	} u;
};

/*
 * Data structure for the response from UST to the session daemon.
 * cmd_type is sent back in the reply for validation.
 */
struct ustcomm_ust_reply {
	uint32_t handle;
	uint32_t cmd;
	uint32_t ret_code;	/* enum enum ustcomm_return_code */
	uint32_t ret_val;	/* return value */
	union {
		struct {
			uint64_t memory_map_size;
		} channel;
		struct {
			uint64_t memory_map_size;
		} stream;
		struct lttng_ust_tracer_version version;
		struct lttng_ust_tracepoint_iter tracepoint;
	} u;
};

extern int ustcomm_create_unix_sock(const char *pathname);
extern int ustcomm_connect_unix_sock(const char *pathname);
extern int ustcomm_accept_unix_sock(int sock);
extern int ustcomm_listen_unix_sock(int sock);
extern int ustcomm_close_unix_sock(int sock);
/* Send fd(s) over a unix socket. */
extern ssize_t ustcomm_send_fds_unix_sock(int sock, void *buf, int *fds,
		size_t nb_fd, size_t len);
extern ssize_t ustcomm_recv_unix_sock(int sock, void *buf, size_t len);
extern ssize_t ustcomm_send_unix_sock(int sock, void *buf, size_t len);
extern const char *ustcomm_get_readable_code(int code);
extern int ustcomm_send_app_msg(int sock, struct ustcomm_ust_msg *lum);
extern int ustcomm_recv_app_reply(int sock, struct ustcomm_ust_reply *lur,
		uint32_t expected_handle, uint32_t expected_cmd);
extern int ustcomm_send_app_cmd(int sock,
		struct ustcomm_ust_msg *lum,
		struct ustcomm_ust_reply *lur);
int ustcomm_recv_fd(int sock);

#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	*
15f672f9 MD	9	* This library is free software; you can redistribute it and/or
	10	* modify it under the terms of the GNU Lesser General Public
	11	* License as published by the Free Software Foundation; only
	12	* version 2.1 of the License.
	13	*
	14	* This library is distributed in the hope that it will be useful,
67c5b804	15	* but WITHOUT ANY WARRANTY; without even the implied warranty of
15f672f9 MD	16	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	17	* Lesser General Public License for more details.
	18	*
	19	* You should have received a copy of the GNU Lesser General Public
	20	* License along with this library; if not, write to the Free Software
	21	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
67c5b804 MD	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>
57773204	30	#include <unistd.h>
4318ae1b	31	#include <lttng/ust-abi.h>
67c5b804	32
11ff9c7d	33	/*
cf12a773 MD	34	* Default timeout the application waits for the sessiond to send its
cf12a773 MD	35	* "register done" command. Can be overridden with the environment
69400ac4	36	* variable "LTTNG_UST_REGISTER_TIMEOUT". Note that if the sessiond is not
cf12a773	37	* found, the application proceeds directly without any delay.
11ff9c7d	38	*/
cf12a773	39	#define LTTNG_UST_DEFAULT_CONSTRUCTOR_TIMEOUT_MS 3000
11ff9c7d	40
67c5b804	41	#define LTTNG_RUNDIR "/var/run/lttng"
6a47c1fb	42	#define LTTNG_HOME_RUNDIR "%s/.lttng"
67c5b804 MD	43
67c5b804 MD	44	/* Default unix socket path */
8d1dae7c MD	45	#define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK LTTNG_RUNDIR "/client-lttng-sessiond"
8d1dae7c MD	46	#define DEFAULT_GLOBAL_APPS_UNIX_SOCK LTTNG_RUNDIR "/apps-lttng-sessiond"
6a47c1fb DG	47	#define DEFAULT_HOME_APPS_UNIX_SOCK LTTNG_HOME_RUNDIR "/apps-lttng-sessiond"
6a47c1fb DG	48	#define DEFAULT_HOME_CLIENT_UNIX_SOCK LTTNG_HOME_RUNDIR "/client-lttng-sessiond"
67c5b804	49
7fc90dca	50	#define DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH "/lttng-ust-apps-wait"
58d4b2a2	51	#define DEFAULT_HOME_APPS_WAIT_SHM_PATH "/lttng-ust-apps-wait-%u"
7fc90dca	52
67c5b804	53	/* Queue size of listen(2) */
e41474be	54	#define LTTNG_UST_COMM_MAX_LISTEN 10
67c5b804	55
57773204	56	/* Get the error code index from 0. USTCOMM_ERR starts at 1000.
67c5b804	57	*/
57773204	58	#define USTCOMM_ERR_INDEX(code) (code - USTCOMM_ERR)
67c5b804	59
67c5b804	60	/*
57773204	61	* ustcomm error code.
67c5b804	62	*/
57773204 MD	63	enum ustcomm_return_code {
	64	USTCOMM_OK = 0, /* Ok */
	65	/* Range 1 to 999 used for standard error numbers (errno.h) */
	66	USTCOMM_ERR = 1000, /* Unknown Error */
	67	USTCOMM_UND, /* Undefine command */
	68	USTCOMM_NOT_IMPLEMENTED, /* Command not implemented */
	69	USTCOMM_UNKNOWN_DOMAIN, /* Tracing domain not known */
	70	USTCOMM_ALLOC_FAIL, /* Trace allocation fail */
	71	USTCOMM_NO_SESSION, /* No session found */
	72	USTCOMM_CREATE_FAIL, /* Create trace fail */
	73	USTCOMM_SESSION_FAIL, /* Create session fail */
	74	USTCOMM_START_FAIL, /* Start tracing fail */
	75	USTCOMM_STOP_FAIL, /* Stop tracing fail */
	76	USTCOMM_LIST_FAIL, /* Listing apps fail */
	77	USTCOMM_NO_APPS, /* No traceable application */
	78	USTCOMM_SESS_NOT_FOUND, /* Session name not found */
	79	USTCOMM_NO_TRACE, /* No trace exist */
	80	USTCOMM_FATAL, /* Session daemon had a fatal error */
	81	USTCOMM_NO_TRACEABLE, /* Error for non traceable app */
	82	USTCOMM_SELECT_SESS, /* Must select a session */
	83	USTCOMM_EXIST_SESS, /* Session name already exist */
	84	USTCOMM_NO_EVENT, /* No event found */
	85	USTCOMM_KERN_NA, /* Kernel tracer unavalable */
	86	USTCOMM_KERN_EVENT_EXIST, /* Kernel event already exists */
	87	USTCOMM_KERN_SESS_FAIL, /* Kernel create session failed */
	88	USTCOMM_KERN_CHAN_FAIL, /* Kernel create channel failed */
	89	USTCOMM_KERN_CHAN_NOT_FOUND, /* Kernel channel not found */
	90	USTCOMM_KERN_CHAN_DISABLE_FAIL, /* Kernel disable channel failed */
	91	USTCOMM_KERN_CHAN_ENABLE_FAIL, /* Kernel enable channel failed */
	92	USTCOMM_KERN_CONTEXT_FAIL, /* Kernel add context failed */
	93	USTCOMM_KERN_ENABLE_FAIL, /* Kernel enable event failed */
	94	USTCOMM_KERN_DISABLE_FAIL, /* Kernel disable event failed */
	95	USTCOMM_KERN_META_FAIL, /* Kernel open metadata failed */
	96	USTCOMM_KERN_START_FAIL, /* Kernel start trace failed */
	97	USTCOMM_KERN_STOP_FAIL, /* Kernel stop trace failed */
	98	USTCOMM_KERN_CONSUMER_FAIL, /* Kernel consumer start failed */
	99	USTCOMM_KERN_STREAM_FAIL, /* Kernel create stream failed */
	100	USTCOMM_KERN_DIR_FAIL, /* Kernel trace directory creation failed */
	101	USTCOMM_KERN_DIR_EXIST, /* Kernel trace directory exist */
	102	USTCOMM_KERN_NO_SESSION, /* No kernel session found */
	103	USTCOMM_KERN_LIST_FAIL, /* Kernel listing events failed */
	104	USTCONSUMER_COMMAND_SOCK_READY, /* when kconsumerd command socket ready */
	105	USTCONSUMER_SUCCESS_RECV_FD, /* success on receiving fds */
	106	USTCONSUMER_ERROR_RECV_FD, /* error on receiving fds */
	107	USTCONSUMER_POLL_ERROR, /* Error in polling thread in kconsumerd */
	108	USTCONSUMER_POLL_NVAL, /* Poll on closed fd */
	109	USTCONSUMER_POLL_HUP, /* All fds have hungup */
	110	USTCONSUMER_EXIT_SUCCESS, /* kconsumerd exiting normally */
	111	USTCONSUMER_EXIT_FAILURE, /* kconsumerd exiting on error */
	112	USTCONSUMER_OUTFD_ERROR, /* error opening the tracefile */
	113	USTCONSUMER_SPLICE_EBADF, /* EBADF from splice(2) */
	114	USTCONSUMER_SPLICE_EINVAL, /* EINVAL from splice(2) */
	115	USTCONSUMER_SPLICE_ENOMEM, /* ENOMEM from splice(2) */
	116	USTCONSUMER_SPLICE_ESPIPE, /* ESPIPE from splice(2) */
67c5b804	117	/* MUST be last element */
57773204	118	USTCOMM_NR, /* Last element */
67c5b804 MD	119	};
	120
	121	/*
e7723462	122	* Data structure for the commands sent from sessiond to UST.
67c5b804	123	*/
57773204	124	struct ustcomm_ust_msg {
1ece9766	125	uint32_t handle;
46050b1a	126	uint32_t cmd;
67c5b804	127	union {
1ece9766	128	struct lttng_ust_channel channel;
381c0f1e	129	struct lttng_ust_stream stream;
1ece9766 MD	130	struct lttng_ust_event event;
1ece9766 MD	131	struct lttng_ust_context context;
57773204	132	struct lttng_ust_tracer_version version;
cbef6901	133	struct lttng_ust_tracepoint_iter tracepoint;
67c5b804 MD	134	} u;
	135	};
	136
9eb62b9c MD	137	/*
	138	* Data structure for the response from UST to the session daemon.
	139	* cmd_type is sent back in the reply for validation.
	140	*/
57773204	141	struct ustcomm_ust_reply {
46050b1a MD	142	uint32_t handle;
46050b1a MD	143	uint32_t cmd;
57773204	144	uint32_t ret_code; /* enum enum ustcomm_return_code */
1ece9766	145	uint32_t ret_val; /* return value */
9eb62b9c	146	union {
193183fb MD	147	struct {
	148	uint64_t memory_map_size;
	149	} channel;
381c0f1e MD	150	struct {
	151	uint64_t memory_map_size;
	152	} stream;
57773204	153	struct lttng_ust_tracer_version version;
cbef6901	154	struct lttng_ust_tracepoint_iter tracepoint;
9eb62b9c MD	155	} u;
	156	};
	157
57773204 MD	158	extern int ustcomm_create_unix_sock(const char *pathname);
	159	extern int ustcomm_connect_unix_sock(const char *pathname);
	160	extern int ustcomm_accept_unix_sock(int sock);
	161	extern int ustcomm_listen_unix_sock(int sock);
	162	extern int ustcomm_close_unix_sock(int sock);
67c5b804	163	/* Send fd(s) over a unix socket. */
57773204	164	extern ssize_t ustcomm_send_fds_unix_sock(int sock, void buf, int fds,
67c5b804	165	size_t nb_fd, size_t len);
57773204 MD	166	extern ssize_t ustcomm_recv_unix_sock(int sock, void *buf, size_t len);
	167	extern ssize_t ustcomm_send_unix_sock(int sock, void *buf, size_t len);
	168	extern const char *ustcomm_get_readable_code(int code);
	169	extern int ustcomm_send_app_msg(int sock, struct ustcomm_ust_msg *lum);
	170	extern int ustcomm_recv_app_reply(int sock, struct ustcomm_ust_reply *lur,
	171	uint32_t expected_handle, uint32_t expected_cmd);
	172	extern int ustcomm_send_app_cmd(int sock,
	173	struct ustcomm_ust_msg *lum,
	174	struct ustcomm_ust_reply *lur);
	175	int ustcomm_recv_fd(int sock);
67c5b804	176
b35d179d	177	#endif /* _LTTNG_UST_COMM_H */