[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>

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

enum lttcomm_ust_command {
	UST_CREATE_SESSION,
	UST_RELEASE_SESSION,
	UST_VERSION,
	UST_LIST_TRACEPOINTS,
	UST_WAIT_QUIESCENT,
	UST_CALIBRATE,

	/* Apply on session handle */
	UST_METADATA,	/* release with UST_RELEASE_CHANNEL */
	UST_CHANNEL,
	UST_RELEASE_CHANNEL,
	UST_SESSION_START,
	UST_SESSION_STOP,

	/* Apply on channel handle */
	UST_STREAM,
	UST_RELEASE_STREAM,
	UST_EVENT,
	UST_RELEASE_EVENT,

	/* Apply on event and channel handle */
	UST_CONTEXT,
	UST_RELEASE_CONTEXT,

	/* Apply on event, channel and session handle */
	UST_ENABLE,
	UST_DISABLE,
};

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