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

#ifndef _LTTNG_SESSIOND_COMM_H
#define _LTTNG_SESSIOND_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>

#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

#define LTTNG_UST_COMM_VERSION_MAJOR		0
#define LTTNG_UST_COMM_VERSION_MINOR		1

/* 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 {
	LTTNG_UST_CREATE_SESSION,
	LTTNG_UST_RELEASE_SESSION,
	LTTNG_UST_VERSION,
	LTTNG_UST_LIST_TRACEPOINTS,
	LTTNG_UST_WAIT_QUIESCENT,
	LTTNG_UST_CALIBRATE,

	/* Apply on session handle */
	LTTNG_UST_METADATA,	/* release with LTTNG_UST_RELEASE_CHANNEL */
	LTTNG_UST_CHANNEL,
	LTTNG_UST_RELEASE_CHANNEL,
	LTTNG_UST_SESSION_START,
	LTTNG_UST_SESSION_STOP,

	/* Apply on channel handle */
	LTTNG_UST_STREAM,
	LTTNG_UST_RELEASE_STREAM,
	LTTNG_UST_EVENT,
	LTTNG_UST_RELEASE_EVENT,

	/* Apply on event and channel handle */
	LTTNG_UST_CONTEXT,
	LTTNG_UST_RELEASE_CONTEXT,

	/* Apply on event, channel and session handle */
	LTTNG_UST_ENABLE,
	LTTNG_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 */
};

#define LTTNG_SYM_NAME_LEN	128

enum lttng_ust_instrumentation {
	LTTNG_UST_TRACEPOINT	= 0,
	LTTNG_UST_PROBE		= 1,
	LTTNG_UST_FUNCTION	= 2,
};

enum lttng_ust_output {
	LTTNG_UST_MMAP		= 0,
};

struct lttng_ust_tracer_version {
	uint32_t version;
	uint32_t patchlevel;
	uint32_t sublevel;
};

struct lttng_ust_channel {
	int overwrite;				/* 1: overwrite, 0: discard */
	uint64_t subbuf_size;			/* in bytes */
	uint64_t num_subbuf;
	unsigned int switch_timer_interval;	/* usecs */
	unsigned int read_timer_interval;	/* usecs */
	enum lttng_ust_output output;		/* output mode */
};

struct lttng_ust_event {
	char name[LTTNG_SYM_NAME_LEN];	/* event name */
	enum lttng_ust_instrumentation instrumentation;
	/* Per instrumentation type configuration */
	union {
	} u;
};

enum lttng_ust_context_type {
	LTTNG_KERNEL_CONTEXT_VTID		= 0,
};

struct lttng_ust_context {
	enum lttng_ust_context_type ctx;
	union {
	} u;
};

/*
 * 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_SESSIOND_COMM_H */
Commit	Line	Data
67c5b804 MD	1	#ifndef _LTTNG_SESSIOND_COMM_H
	2	#define _LTTNG_SESSIOND_COMM_H
	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>
	31
	32	#define LTTNG_RUNDIR "/var/run/lttng"
	33
	34	/* Default unix socket path */
	35	#define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK LTTNG_RUNDIR "/client-ltt-sessiond"
	36	#define DEFAULT_GLOBAL_APPS_UNIX_SOCK LTTNG_RUNDIR "/apps-ltt-sessiond"
	37	#define DEFAULT_HOME_APPS_UNIX_SOCK "%s/.apps-ltt-sessiond"
	38	#define DEFAULT_HOME_CLIENT_UNIX_SOCK "%s/.client-ltt-sessiond"
	39
	40	/* Queue size of listen(2) */
	41	#define MAX_LISTEN 10
	42
e44418f3 MD	43	#define LTTNG_UST_COMM_VERSION_MAJOR 0
	44	#define LTTNG_UST_COMM_VERSION_MINOR 1
	45
67c5b804 MD	46	/* Get the error code index from 0 since
	47	* LTTCOMM_OK start at 1000
	48	*/
	49	#define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_OK)
	50
e7723462	51	enum lttcomm_ust_command {
1ece9766 MD	52	LTTNG_UST_CREATE_SESSION,
	53	LTTNG_UST_RELEASE_SESSION,
	54	LTTNG_UST_VERSION,
	55	LTTNG_UST_LIST_TRACEPOINTS,
	56	LTTNG_UST_WAIT_QUIESCENT,
	57	LTTNG_UST_CALIBRATE,
	58
	59	/* Apply on session handle */
	60	LTTNG_UST_METADATA, /* release with LTTNG_UST_RELEASE_CHANNEL */
	61	LTTNG_UST_CHANNEL,
	62	LTTNG_UST_RELEASE_CHANNEL,
	63	LTTNG_UST_SESSION_START,
	64	LTTNG_UST_SESSION_STOP,
	65
	66	/* Apply on channel handle */
	67	LTTNG_UST_STREAM,
	68	LTTNG_UST_RELEASE_STREAM,
	69	LTTNG_UST_EVENT,
	70	LTTNG_UST_RELEASE_EVENT,
	71
	72	/* Apply on event and channel handle */
	73	LTTNG_UST_CONTEXT,
	74	LTTNG_UST_RELEASE_CONTEXT,
	75
	76	/* Apply on event, channel and session handle */
	77	LTTNG_UST_ENABLE,
	78	LTTNG_UST_DISABLE,
67c5b804 MD	79	};
	80
	81	/*
	82	* lttcomm error code.
	83	*/
	84	enum lttcomm_return_code {
	85	LTTCOMM_OK = 1000, /* Ok */
	86	LTTCOMM_ERR, /* Unknown Error */
	87	LTTCOMM_UND, /* Undefine command */
	88	LTTCOMM_NOT_IMPLEMENTED, /* Command not implemented */
	89	LTTCOMM_UNKNOWN_DOMAIN, /* Tracing domain not known */
	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_SESS_NOT_FOUND, /* Session name not found */
	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_EVENT_EXIST, /* Kernel event already exists */
	107	LTTCOMM_KERN_SESS_FAIL, /* Kernel create session failed */
	108	LTTCOMM_KERN_CHAN_FAIL, /* Kernel create channel failed */
	109	LTTCOMM_KERN_CHAN_NOT_FOUND, /* Kernel channel not found */
	110	LTTCOMM_KERN_CHAN_DISABLE_FAIL, /* Kernel disable channel failed */
	111	LTTCOMM_KERN_CHAN_ENABLE_FAIL, /* Kernel enable channel failed */
	112	LTTCOMM_KERN_CONTEXT_FAIL, /* Kernel add context failed */
	113	LTTCOMM_KERN_ENABLE_FAIL, /* Kernel enable event failed */
	114	LTTCOMM_KERN_DISABLE_FAIL, /* Kernel disable event failed */
	115	LTTCOMM_KERN_META_FAIL, /* Kernel open metadata failed */
	116	LTTCOMM_KERN_START_FAIL, /* Kernel start trace failed */
	117	LTTCOMM_KERN_STOP_FAIL, /* Kernel stop trace failed */
	118	LTTCOMM_KERN_CONSUMER_FAIL, /* Kernel consumer start failed */
	119	LTTCOMM_KERN_STREAM_FAIL, /* Kernel create stream failed */
	120	LTTCOMM_KERN_DIR_FAIL, /* Kernel trace directory creation failed */
	121	LTTCOMM_KERN_DIR_EXIST, /* Kernel trace directory exist */
	122	LTTCOMM_KERN_NO_SESSION, /* No kernel session found */
	123	LTTCOMM_KERN_LIST_FAIL, /* Kernel listing events failed */
	124	KCONSUMERD_COMMAND_SOCK_READY, /* when kconsumerd command socket ready */
	125	KCONSUMERD_SUCCESS_RECV_FD, /* success on receiving fds */
	126	KCONSUMERD_ERROR_RECV_FD, /* error on receiving fds */
	127	KCONSUMERD_POLL_ERROR, /* Error in polling thread in kconsumerd */
	128	KCONSUMERD_POLL_NVAL, /* Poll on closed fd */
	129	KCONSUMERD_POLL_HUP, /* All fds have hungup */
	130	KCONSUMERD_EXIT_SUCCESS, /* kconsumerd exiting normally */
	131	KCONSUMERD_EXIT_FAILURE, /* kconsumerd exiting on error */
	132	KCONSUMERD_OUTFD_ERROR, /* error opening the tracefile */
	133	KCONSUMERD_SPLICE_EBADF, /* EBADF from splice(2) */
	134	KCONSUMERD_SPLICE_EINVAL, /* EINVAL from splice(2) */
	135	KCONSUMERD_SPLICE_ENOMEM, /* ENOMEM from splice(2) */
	136	KCONSUMERD_SPLICE_ESPIPE, /* ESPIPE from splice(2) */
	137	/* MUST be last element */
	138	LTTCOMM_NR, /* Last element */
	139	};
	140
1ece9766 MD	141	#define LTTNG_SYM_NAME_LEN 128
	142
	143	enum lttng_ust_instrumentation {
	144	LTTNG_UST_TRACEPOINT = 0,
	145	LTTNG_UST_PROBE = 1,
	146	LTTNG_UST_FUNCTION = 2,
	147	};
	148
	149	enum lttng_ust_output {
	150	LTTNG_UST_MMAP = 0,
	151	};
	152
	153	struct lttng_ust_tracer_version {
	154	uint32_t version;
	155	uint32_t patchlevel;
	156	uint32_t sublevel;
	157	};
	158
	159	struct lttng_ust_channel {
	160	int overwrite; /* 1: overwrite, 0: discard */
	161	uint64_t subbuf_size; /* in bytes */
	162	uint64_t num_subbuf;
	163	unsigned int switch_timer_interval; /* usecs */
	164	unsigned int read_timer_interval; /* usecs */
	165	enum lttng_ust_output output; /* output mode */
	166	};
	167
	168	struct lttng_ust_event {
	169	char name[LTTNG_SYM_NAME_LEN]; /* event name */
	170	enum lttng_ust_instrumentation instrumentation;
	171	/* Per instrumentation type configuration */
	172	union {
	173	} u;
	174	};
	175
	176	enum lttng_ust_context_type {
	177	LTTNG_KERNEL_CONTEXT_VTID = 0,
	178	};
	179
	180	struct lttng_ust_context {
	181	enum lttng_ust_context_type ctx;
	182	union {
	183	} u;
	184	};
	185
67c5b804	186	/*
e7723462	187	* Data structure for the commands sent from sessiond to UST.
67c5b804	188	*/
e7723462 MD	189	struct lttcomm_ust_msg {
e7723462 MD	190	uint32_t cmd_type; /* enum lttcomm_ust_command */
1ece9766	191	uint32_t handle;
67c5b804	192	union {
1ece9766 MD	193	struct lttng_ust_tracer_version version;
	194	struct lttng_ust_channel channel;
	195	struct lttng_ust_event event;
	196	struct lttng_ust_context context;
67c5b804 MD	197	} u;
	198	};
	199
9eb62b9c MD	200	/*
	201	* Data structure for the response from UST to the session daemon.
	202	* cmd_type is sent back in the reply for validation.
	203	*/
e7723462	204	struct lttcomm_ust_reply {
9eb62b9c MD	205	uint32_t cmd_type; /* enum lttcomm_sessiond_command */
9eb62b9c MD	206	uint32_t ret_code; /* enum enum lttcomm_return_code */
1ece9766	207	uint32_t ret_val; /* return value */
9eb62b9c	208	union {
9eb62b9c MD	209	} u;
	210	};
	211
67c5b804 MD	212	extern int lttcomm_create_unix_sock(const char *pathname);
	213	extern int lttcomm_connect_unix_sock(const char *pathname);
	214	extern int lttcomm_accept_unix_sock(int sock);
	215	extern int lttcomm_listen_unix_sock(int sock);
	216	extern int lttcomm_close_unix_sock(int sock);
	217	/* Send fd(s) over a unix socket. */
	218	extern ssize_t lttcomm_send_fds_unix_sock(int sock, void buf, int fds,
	219	size_t nb_fd, size_t len);
	220	extern ssize_t lttcomm_recv_unix_sock(int sock, void *buf, size_t len);
	221	extern ssize_t lttcomm_send_unix_sock(int sock, void *buf, size_t len);
	222	extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
	223
	224	#endif /* _LTTNG_SESSIOND_COMM_H */