[lttng-tools.git] / src / common / sessiond-comm / 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, version 2 only,
 * as published by the Free Software Foundation.
 * 
 * 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.,
 * 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.
 */

#ifndef _LTTNG_SESSIOND_COMM_H
#define _LTTNG_SESSIOND_COMM_H

#define _GNU_SOURCE
#include <limits.h>
#include <lttng/lttng.h>
#include <common/compat/socket.h>

#include <arpa/inet.h>
#include <netinet/in.h>
#include <sys/un.h>

#include "inet.h"
#include "inet6.h"
#include "unix.h"

/* Queue size of listen(2) */
#define LTTNG_SESSIOND_COMM_MAX_LISTEN 64

/* Maximum number of FDs that can be sent over a Unix socket */
#define LTTCOMM_MAX_SEND_FDS           4

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

enum lttcomm_sessiond_command {
	/* Tracer command */
	LTTNG_ADD_CONTEXT,
	LTTNG_CALIBRATE,
	LTTNG_DISABLE_CHANNEL,
	LTTNG_DISABLE_EVENT,
	LTTNG_DISABLE_ALL_EVENT,
	LTTNG_ENABLE_CHANNEL,
	LTTNG_ENABLE_EVENT,
	LTTNG_ENABLE_ALL_EVENT,
	/* Session daemon command */
	LTTNG_CREATE_SESSION,
	LTTNG_CREATE_SESSION_URI,
	LTTNG_DESTROY_SESSION,
	LTTNG_LIST_CHANNELS,
	LTTNG_LIST_DOMAINS,
	LTTNG_LIST_EVENTS,
	LTTNG_LIST_SESSIONS,
	LTTNG_LIST_TRACEPOINTS,
	LTTNG_REGISTER_CONSUMER,
	LTTNG_START_TRACE,
	LTTNG_STOP_TRACE,
	LTTNG_LIST_TRACEPOINT_FIELDS,

	/* Consumer */
	LTTNG_DISABLE_CONSUMER,
	LTTNG_ENABLE_CONSUMER,
	LTTNG_SET_CONSUMER_URI,
	/* Relay daemon */
	RELAYD_ADD_STREAM,
	RELAYD_CREATE_SESSION,
	RELAYD_START_DATA,
	RELAYD_UPDATE_SYNC_INFO,
	RELAYD_VERSION,
	RELAYD_SEND_METADATA,
	RELAYD_CLOSE_STREAM,
	LTTNG_SET_FILTER,
	LTTNG_HEALTH_CHECK,
};

/*
 * lttcomm error code.
 */
enum lttcomm_return_code {
	LTTCOMM_OK = 10,				/* 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_DIR_FAIL,        /* Create directory 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_CONNECT_FAIL,           /* Unable to connect to unix socket */
	LTTCOMM_APP_NOT_FOUND,          /* App not found in traceable app list */
	LTTCOMM_EPERM,			/* Permission denied */
	LTTCOMM_KERN_NA,				/* Kernel tracer unavalable */
	LTTCOMM_KERN_VERSION,           /* Kernel tracer version is not compatible */
	LTTCOMM_KERN_EVENT_EXIST,       /* Kernel event already exists */
	LTTCOMM_KERN_SESS_FAIL,			/* Kernel create session failed */
	LTTCOMM_KERN_CHAN_EXIST,        /* Kernel channel already exists */
	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 */
	LTTCOMM_UST_CALIBRATE_FAIL,     /* UST calibration failed */
	LTTCOMM_UST_VERSION,            /* UST tracer version is not compatible */
	LTTCOMM_UST_SESS_FAIL,			/* UST create session failed */
	LTTCOMM_UST_CHAN_EXIST,         /* UST channel already exist */
	LTTCOMM_UST_CHAN_FAIL,			/* UST create channel failed */
	LTTCOMM_UST_CHAN_NOT_FOUND,     /* UST channel not found */
	LTTCOMM_UST_CHAN_DISABLE_FAIL, /* UST disable channel failed */
	LTTCOMM_UST_CHAN_ENABLE_FAIL,  /* UST enable channel failed */
	LTTCOMM_UST_CONTEXT_FAIL,      /* UST add context failed */
	LTTCOMM_UST_ENABLE_FAIL,		/* UST enable event failed */
	LTTCOMM_UST_DISABLE_FAIL,		/* UST disable event failed */
	LTTCOMM_UST_META_FAIL,			/* UST open metadata failed */
	LTTCOMM_UST_START_FAIL,		/* UST start trace failed */
	LTTCOMM_UST_STOP_FAIL,			/* UST stop trace failed */
	LTTCOMM_UST_CONSUMER64_FAIL,		/* 64-bit UST consumer start failed */
	LTTCOMM_UST_CONSUMER32_FAIL,		/* 32-bit UST consumer start failed */
	LTTCOMM_UST_STREAM_FAIL,		/* UST create stream failed */
	LTTCOMM_UST_DIR_FAIL,			/* UST trace directory creation failed */
	LTTCOMM_UST_DIR_EXIST,			/* UST trace directory exist */
	LTTCOMM_UST_NO_SESSION,		/* No UST session found */
	LTTCOMM_UST_LIST_FAIL,			/* UST listing events failed */
	LTTCOMM_UST_EVENT_EXIST,        /* UST event exist */
	LTTCOMM_UST_EVENT_NOT_FOUND,    /* UST event not found */
	LTTCOMM_UST_CONTEXT_EXIST,      /* UST context exist */
	LTTCOMM_UST_CONTEXT_INVAL,      /* UST context invalid */
	LTTCOMM_NEED_ROOT_SESSIOND,		/* root sessiond is needed */
	LTTCOMM_TRACE_ALREADY_STARTED,  /* Tracing already started */
	LTTCOMM_TRACE_ALREADY_STOPPED,  /* Tracing already stopped */
	LTTCOMM_KERN_EVENT_ENOSYS,      /* Kernel event type not supported */

	CONSUMERD_COMMAND_SOCK_READY,		/* when consumerd command socket ready */
	CONSUMERD_SUCCESS_RECV_FD,		/* success on receiving fds */
	CONSUMERD_ERROR_RECV_FD,		/* error on receiving fds */
	CONSUMERD_ERROR_RECV_CMD,		/* error on receiving command */
	CONSUMERD_POLL_ERROR,			/* Error in polling thread in kconsumerd */
	CONSUMERD_POLL_NVAL,			/* Poll on closed fd */
	CONSUMERD_POLL_HUP,			/* All fds have hungup */
	CONSUMERD_EXIT_SUCCESS,			/* kconsumerd exiting normally */
	CONSUMERD_EXIT_FAILURE,			/* kconsumerd exiting on error */
	CONSUMERD_OUTFD_ERROR,			/* error opening the tracefile */
	CONSUMERD_SPLICE_EBADF,			/* EBADF from splice(2) */
	CONSUMERD_SPLICE_EINVAL,		/* EINVAL from splice(2) */
	CONSUMERD_SPLICE_ENOMEM,		/* ENOMEM from splice(2) */
	CONSUMERD_SPLICE_ESPIPE,		/* ESPIPE from splice(2) */
	LTTCOMM_INVALID,			/* Invalid parameter */
	LTTCOMM_NO_USTCONSUMERD,        /* No UST consumer detected */
	LTTCOMM_NO_KERNCONSUMERD,       /* No Kernel consumer detected */
	LTTCOMM_EVENT_EXIST_LOGLEVEL,   /* Event already enabled with different loglevel */
	LTTCOMM_URI_DATA_MISS,          /* Missing network data URI */
	LTTCOMM_URI_CTRL_MISS,          /* Missing network control URI */
	LTTCOMM_ENABLE_CONSUMER_FAIL,   /* Enabling consumer failed */
	LTTCOMM_RELAYD_SESSION_FAIL,    /* lttng-relayd create session failed */
	LTTCOMM_RELAYD_VERSION_FAIL,    /* lttng-relayd not compatible */
	LTTCOMM_FILTER_INVAL,		/* Invalid filter bytecode */
	LTTCOMM_FILTER_NOMEM,		/* Lack of memory for filter bytecode */
	LTTCOMM_FILTER_EXIST,		/* Filter already exist */

	/* MUST be last element */
	LTTCOMM_NR,						/* Last element */
};

/* lttng socket protocol. */
enum lttcomm_sock_proto {
	LTTCOMM_SOCK_UDP,
	LTTCOMM_SOCK_TCP,
};

/*
 * Index in the net_families array below. Please keep in sync!
 */
enum lttcomm_sock_domain {
	LTTCOMM_INET      = 0,
	LTTCOMM_INET6     = 1,
};

struct lttcomm_sockaddr {
	enum lttcomm_sock_domain type;
	union {
		struct sockaddr_in sin;
		struct sockaddr_in6 sin6;
	} addr;
};

struct lttcomm_sock {
	int fd;
	enum lttcomm_sock_proto proto;
	struct lttcomm_sockaddr sockaddr;
	const struct lttcomm_proto_ops *ops;
};

struct lttcomm_net_family {
	int family;
	int (*create) (struct lttcomm_sock *sock, int type, int proto);
};

struct lttcomm_proto_ops {
	int (*bind) (struct lttcomm_sock *sock);
	int (*close) (struct lttcomm_sock *sock);
	int (*connect) (struct lttcomm_sock *sock);
	struct lttcomm_sock *(*accept) (struct lttcomm_sock *sock);
	int (*listen) (struct lttcomm_sock *sock, int backlog);
	ssize_t (*recvmsg) (struct lttcomm_sock *sock, void *buf, size_t len,
			int flags);
	ssize_t (*sendmsg) (struct lttcomm_sock *sock, void *buf, size_t len,
			int flags);
};

/*
 * Data structure received from lttng client to session daemon.
 */
struct lttcomm_session_msg {
	uint32_t cmd_type;    /* enum lttcomm_sessiond_command */
	struct lttng_session session;
	struct lttng_domain domain;
	union {
		struct {
			char channel_name[NAME_MAX];
			char name[NAME_MAX];
		} disable;
		/* Event data */
		struct {
			char channel_name[NAME_MAX];
			struct lttng_event event;
		} enable;
		/* Create channel */
		struct {
			struct lttng_channel chan;
		} channel;
		/* Context */
		struct {
			char channel_name[NAME_MAX];
			char event_name[NAME_MAX];
			struct lttng_event_context ctx;
		} context;
		/* Use by register_consumer */
		struct {
			char path[PATH_MAX];
		} reg;
		/* List */
		struct {
			char channel_name[NAME_MAX];
		} list;
		struct lttng_calibrate calibrate;
		/* Used by the set_consumer_uri call */
		struct lttng_uri uri;
		struct {
			uint32_t enable_consumer;
			struct lttng_uri ctrl_uri;
			struct lttng_uri data_uri;
		} create_uri;
		struct {
			char channel_name[NAME_MAX];
			char event_name[NAME_MAX];
			/* Length of following bytecode */
			uint32_t bytecode_len;
		} filter;
	} u;
};

#define LTTNG_FILTER_MAX_LEN	65336

/*
 * Filter bytecode data. The reloc table is located at the end of the
 * bytecode. It is made of tuples: (uint16_t, var. len. string). It
 * starts at reloc_table_offset.
 */
struct lttng_filter_bytecode {
	uint16_t len;	/* len of data */
	uint16_t reloc_table_offset;
	char data[0];
};

/*
 * Data structure for the response from sessiond to the lttng client.
 */
struct lttcomm_lttng_msg {
	uint32_t cmd_type;   /* enum lttcomm_sessiond_command */
	uint32_t ret_code;   /* enum lttcomm_return_code */
	uint32_t pid;        /* pid_t */
	uint32_t data_size;
	/* Contains: trace_name + data */
	char payload[];
};

struct lttcomm_health_msg {
	uint32_t component;
	uint32_t cmd;
};

struct lttcomm_health_data {
	uint32_t ret_code;
};

/*
 * lttcomm_consumer_msg is the message sent from sessiond to consumerd
 * to either add a channel, add a stream, update a stream, or stop
 * operation.
 */
struct lttcomm_consumer_msg {
	uint32_t cmd_type;	/* enum consumerd_command */
	union {
		struct {
			int channel_key;
			uint64_t max_sb_size; /* the subbuffer size for this channel */
			/* shm_fd and wait_fd are sent as ancillary data */
			uint64_t mmap_len;
			char name[LTTNG_SYMBOL_NAME_LEN];
		} channel;
		struct {
			int channel_key;
			int stream_key;
			/* shm_fd and wait_fd are sent as ancillary data */
			uint32_t state;    /* enum lttcomm_consumer_fd_state */
			enum lttng_event_output output; /* use splice or mmap to consume this fd */
			uint64_t mmap_len;
			uid_t uid;         /* User ID owning the session */
			gid_t gid;         /* Group ID owning the session */
			char path_name[PATH_MAX];
			int net_index;
			unsigned int metadata_flag;
			char name[LTTNG_SYMBOL_NAME_LEN];  /* Name string of the stream */
		} stream;
		struct {
			int net_index;
			enum lttng_stream_type type;
			/* Open socket to the relayd */
			struct lttcomm_sock sock;
		} relayd_sock;
		struct {
			uint64_t net_seq_idx;
		} destroy_relayd;
	} u;
};

#ifdef HAVE_LIBLTTNG_UST_CTL

#include <lttng/ust-abi.h>

/*
 * Data structure for the commands sent from sessiond to UST.
 */
struct lttcomm_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;
	} 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 lttcomm_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;
	} u;
};

#endif /* HAVE_LIBLTTNG_UST_CTL */

extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);

extern int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr *sockaddr,
		const char *ip, unsigned int port);
extern int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr *sockaddr,
		const char *ip, unsigned int port);

extern struct lttcomm_sock *lttcomm_alloc_sock(enum lttcomm_sock_proto proto);
extern int lttcomm_create_sock(struct lttcomm_sock *sock);
extern struct lttcomm_sock *lttcomm_alloc_sock_from_uri(struct lttng_uri *uri);
extern void lttcomm_destroy_sock(struct lttcomm_sock *sock);
extern struct lttcomm_sock *lttcomm_alloc_copy_sock(struct lttcomm_sock *src);
extern void lttcomm_copy_sock(struct lttcomm_sock *dst,
		struct lttcomm_sock *src);

#endif	/* _LTTNG_SESSIOND_COMM_H */
Commit	Line	Data
6e3805e2 DG	1	/*
	2	* Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
	3	* Julien Desfossez <julien.desfossez@polymtl.ca>
773168b7	4	* Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
fac6795d	5	*
d14d33bf AM	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License, version 2 only,
	8	* as published by the Free Software Foundation.
fac6795d	9	*
990570ed DG	10	* This program is distributed in the hope that it will be useful, but WITHOUT
990570ed DG	11	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
d14d33bf	12	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
990570ed	13	* more details.
fac6795d	14	*
d14d33bf AM	15	* You should have received a copy of the GNU General Public License along
	16	* with this program; if not, write to the Free Software Foundation, Inc.,
	17	* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
fac6795d DG	18	*/
fac6795d DG	19
773168b7	20	/*
990570ed DG	21	* This header is meant for liblttng and libust internal use ONLY. These
990570ed DG	22	* declarations should NOT be considered stable API.
773168b7	23	*/
fac6795d	24
990570ed DG	25	#ifndef _LTTNG_SESSIOND_COMM_H
	26	#define _LTTNG_SESSIOND_COMM_H
	27
d19d9ada	28	#define _GNU_SOURCE
fac6795d	29	#include <limits.h>
f3ed775e	30	#include <lttng/lttng.h>
b17231c6	31	#include <common/compat/socket.h>
5e16da05	32
6364a07a DG	33	#include <arpa/inet.h>
	34	#include <netinet/in.h>
	35	#include <sys/un.h>
	36
	37	#include "inet.h"
	38	#include "inet6.h"
0d37f2bc DG	39	#include "unix.h"
0d37f2bc DG	40
fac6795d	41	/* Queue size of listen(2) */
f158a754	42	#define LTTNG_SESSIOND_COMM_MAX_LISTEN 64
fac6795d	43
990570ed DG	44	/* Maximum number of FDs that can be sent over a Unix socket */
	45	#define LTTCOMM_MAX_SEND_FDS 4
	46
3817e7df DG	47	/*
3817e7df DG	48	* Get the error code index from 0 since LTTCOMM_OK start at 1000
fac6795d	49	*/
686204ab	50	#define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_OK)
fac6795d	51
6abb15de	52	enum lttcomm_sessiond_command {
0d0c377a	53	/* Tracer command */
b579acd9	54	LTTNG_ADD_CONTEXT,
f4688807	55	LTTNG_CALIBRATE,
0b97ec54	56	LTTNG_DISABLE_CHANNEL,
f5177a38 DG	57	LTTNG_DISABLE_EVENT,
f5177a38 DG	58	LTTNG_DISABLE_ALL_EVENT,
0d0c377a DG	59	LTTNG_ENABLE_CHANNEL,
	60	LTTNG_ENABLE_EVENT,
	61	LTTNG_ENABLE_ALL_EVENT,
	62	/* Session daemon command */
fac6795d	63	LTTNG_CREATE_SESSION,
de5e9086	64	LTTNG_CREATE_SESSION_URI,
fac6795d	65	LTTNG_DESTROY_SESSION,
9f19cc17 DG	66	LTTNG_LIST_CHANNELS,
9f19cc17 DG	67	LTTNG_LIST_DOMAINS,
f3ed775e	68	LTTNG_LIST_EVENTS,
9f19cc17	69	LTTNG_LIST_SESSIONS,
052da939	70	LTTNG_LIST_TRACEPOINTS,
d9800920	71	LTTNG_REGISTER_CONSUMER,
f3ed775e DG	72	LTTNG_START_TRACE,
f3ed775e DG	73	LTTNG_STOP_TRACE,
f37d259d	74	LTTNG_LIST_TRACEPOINT_FIELDS,
53a80697	75
de5e9086 DG	76	/* Consumer */
	77	LTTNG_DISABLE_CONSUMER,
	78	LTTNG_ENABLE_CONSUMER,
	79	LTTNG_SET_CONSUMER_URI,
	80	/* Relay daemon */
	81	RELAYD_ADD_STREAM,
	82	RELAYD_CREATE_SESSION,
	83	RELAYD_START_DATA,
	84	RELAYD_UPDATE_SYNC_INFO,
	85	RELAYD_VERSION,
	86	RELAYD_SEND_METADATA,
173af62f	87	RELAYD_CLOSE_STREAM,
53a80697	88	LTTNG_SET_FILTER,
44a5e5eb	89	LTTNG_HEALTH_CHECK,
fac6795d DG	90	};
	91
	92	/*
	93	* lttcomm error code.
	94	*/
	95	enum lttcomm_return_code {
42224349	96	LTTCOMM_OK = 10, /* Ok */
20fe2104 DG	97	LTTCOMM_ERR, /* Unknown Error */
20fe2104 DG	98	LTTCOMM_UND, /* Undefine command */
7d29a247 DG	99	LTTCOMM_NOT_IMPLEMENTED, /* Command not implemented */
7d29a247 DG	100	LTTCOMM_UNKNOWN_DOMAIN, /* Tracing domain not known */
20fe2104 DG	101	LTTCOMM_ALLOC_FAIL, /* Trace allocation fail */
20fe2104 DG	102	LTTCOMM_NO_SESSION, /* No session found */
ae856491	103	LTTCOMM_CREATE_DIR_FAIL, /* Create directory fail */
20fe2104 DG	104	LTTCOMM_SESSION_FAIL, /* Create session fail */
	105	LTTCOMM_START_FAIL, /* Start tracing fail */
	106	LTTCOMM_STOP_FAIL, /* Stop tracing fail */
	107	LTTCOMM_LIST_FAIL, /* Listing apps fail */
	108	LTTCOMM_NO_APPS, /* No traceable application */
f3ed775e	109	LTTCOMM_SESS_NOT_FOUND, /* Session name not found */
20fe2104 DG	110	LTTCOMM_NO_TRACE, /* No trace exist */
	111	LTTCOMM_FATAL, /* Session daemon had a fatal error */
	112	LTTCOMM_NO_TRACEABLE, /* Error for non traceable app */
	113	LTTCOMM_SELECT_SESS, /* Must select a session */
	114	LTTCOMM_EXIST_SESS, /* Session name already exist */
	115	LTTCOMM_NO_EVENT, /* No event found */
d9800920	116	LTTCOMM_CONNECT_FAIL, /* Unable to connect to unix socket */
2b0bf864	117	LTTCOMM_APP_NOT_FOUND, /* App not found in traceable app list */
8e0af1b4	118	LTTCOMM_EPERM, /* Permission denied */
20fe2104	119	LTTCOMM_KERN_NA, /* Kernel tracer unavalable */
394016d1	120	LTTCOMM_KERN_VERSION, /* Kernel tracer version is not compatible */
7d29a247	121	LTTCOMM_KERN_EVENT_EXIST, /* Kernel event already exists */
20fe2104	122	LTTCOMM_KERN_SESS_FAIL, /* Kernel create session failed */
42224349	123	LTTCOMM_KERN_CHAN_EXIST, /* Kernel channel already exists */
20fe2104	124	LTTCOMM_KERN_CHAN_FAIL, /* Kernel create channel failed */
f3ed775e	125	LTTCOMM_KERN_CHAN_NOT_FOUND, /* Kernel channel not found */
26cc6b4e	126	LTTCOMM_KERN_CHAN_DISABLE_FAIL, /* Kernel disable channel failed */
d36b8583	127	LTTCOMM_KERN_CHAN_ENABLE_FAIL, /* Kernel enable channel failed */
d65106b1	128	LTTCOMM_KERN_CONTEXT_FAIL, /* Kernel add context failed */
f34daff7 DG	129	LTTCOMM_KERN_ENABLE_FAIL, /* Kernel enable event failed */
f34daff7 DG	130	LTTCOMM_KERN_DISABLE_FAIL, /* Kernel disable event failed */
aaf26714	131	LTTCOMM_KERN_META_FAIL, /* Kernel open metadata failed */
8c0faa1d DG	132	LTTCOMM_KERN_START_FAIL, /* Kernel start trace failed */
	133	LTTCOMM_KERN_STOP_FAIL, /* Kernel stop trace failed */
	134	LTTCOMM_KERN_CONSUMER_FAIL, /* Kernel consumer start failed */
	135	LTTCOMM_KERN_STREAM_FAIL, /* Kernel create stream failed */
	136	LTTCOMM_KERN_DIR_FAIL, /* Kernel trace directory creation failed */
84291629 DG	137	LTTCOMM_KERN_DIR_EXIST, /* Kernel trace directory exist */
84291629 DG	138	LTTCOMM_KERN_NO_SESSION, /* No kernel session found */
2ef84c95	139	LTTCOMM_KERN_LIST_FAIL, /* Kernel listing events failed */
4466912f	140	LTTCOMM_UST_CALIBRATE_FAIL, /* UST calibration failed */
e0c7ec2b	141	LTTCOMM_UST_VERSION, /* UST tracer version is not compatible */
0177d773	142	LTTCOMM_UST_SESS_FAIL, /* UST create session failed */
f6a9efaa	143	LTTCOMM_UST_CHAN_EXIST, /* UST channel already exist */
2bdd86d4	144	LTTCOMM_UST_CHAN_FAIL, /* UST create channel failed */
2b0bf864	145	LTTCOMM_UST_CHAN_NOT_FOUND, /* UST channel not found */
2bdd86d4 MD	146	LTTCOMM_UST_CHAN_DISABLE_FAIL, /* UST disable channel failed */
	147	LTTCOMM_UST_CHAN_ENABLE_FAIL, /* UST enable channel failed */
	148	LTTCOMM_UST_CONTEXT_FAIL, /* UST add context failed */
	149	LTTCOMM_UST_ENABLE_FAIL, /* UST enable event failed */
	150	LTTCOMM_UST_DISABLE_FAIL, /* UST disable event failed */
	151	LTTCOMM_UST_META_FAIL, /* UST open metadata failed */
	152	LTTCOMM_UST_START_FAIL, /* UST start trace failed */
	153	LTTCOMM_UST_STOP_FAIL, /* UST stop trace failed */
7753dea8 MD	154	LTTCOMM_UST_CONSUMER64_FAIL, /* 64-bit UST consumer start failed */
7753dea8 MD	155	LTTCOMM_UST_CONSUMER32_FAIL, /* 32-bit UST consumer start failed */
2bdd86d4 MD	156	LTTCOMM_UST_STREAM_FAIL, /* UST create stream failed */
	157	LTTCOMM_UST_DIR_FAIL, /* UST trace directory creation failed */
	158	LTTCOMM_UST_DIR_EXIST, /* UST trace directory exist */
	159	LTTCOMM_UST_NO_SESSION, /* No UST session found */
	160	LTTCOMM_UST_LIST_FAIL, /* UST listing events failed */
3b25d04d	161	LTTCOMM_UST_EVENT_EXIST, /* UST event exist */
be4f0921	162	LTTCOMM_UST_EVENT_NOT_FOUND, /* UST event not found */
ae357384	163	LTTCOMM_UST_CONTEXT_EXIST, /* UST context exist */
ae856491	164	LTTCOMM_UST_CONTEXT_INVAL, /* UST context invalid */
80e327fa DG	165	LTTCOMM_NEED_ROOT_SESSIOND, /* root sessiond is needed */
	166	LTTCOMM_TRACE_ALREADY_STARTED, /* Tracing already started */
	167	LTTCOMM_TRACE_ALREADY_STOPPED, /* Tracing already stopped */
bd29c13d	168	LTTCOMM_KERN_EVENT_ENOSYS, /* Kernel event type not supported */
2bdd86d4	169
3bd1e081 MD	170	CONSUMERD_COMMAND_SOCK_READY, /* when consumerd command socket ready */
	171	CONSUMERD_SUCCESS_RECV_FD, /* success on receiving fds */
	172	CONSUMERD_ERROR_RECV_FD, /* error on receiving fds */
f2fc6720	173	CONSUMERD_ERROR_RECV_CMD, /* error on receiving command */
3bd1e081 MD	174	CONSUMERD_POLL_ERROR, /* Error in polling thread in kconsumerd */
	175	CONSUMERD_POLL_NVAL, /* Poll on closed fd */
	176	CONSUMERD_POLL_HUP, /* All fds have hungup */
	177	CONSUMERD_EXIT_SUCCESS, /* kconsumerd exiting normally */
	178	CONSUMERD_EXIT_FAILURE, /* kconsumerd exiting on error */
	179	CONSUMERD_OUTFD_ERROR, /* error opening the tracefile */
	180	CONSUMERD_SPLICE_EBADF, /* EBADF from splice(2) */
	181	CONSUMERD_SPLICE_EINVAL, /* EINVAL from splice(2) */
	182	CONSUMERD_SPLICE_ENOMEM, /* ENOMEM from splice(2) */
	183	CONSUMERD_SPLICE_ESPIPE, /* ESPIPE from splice(2) */
b024d072	184	LTTCOMM_INVALID, /* Invalid parameter */
5c827ce0 DG	185	LTTCOMM_NO_USTCONSUMERD, /* No UST consumer detected */
5c827ce0 DG	186	LTTCOMM_NO_KERNCONSUMERD, /* No Kernel consumer detected */
a027b2d2	187	LTTCOMM_EVENT_EXIST_LOGLEVEL, /* Event already enabled with different loglevel */
de5e9086 DG	188	LTTCOMM_URI_DATA_MISS, /* Missing network data URI */
	189	LTTCOMM_URI_CTRL_MISS, /* Missing network control URI */
	190	LTTCOMM_ENABLE_CONSUMER_FAIL, /* Enabling consumer failed */
	191	LTTCOMM_RELAYD_SESSION_FAIL, /* lttng-relayd create session failed */
	192	LTTCOMM_RELAYD_VERSION_FAIL, /* lttng-relayd not compatible */
53a80697 MD	193	LTTCOMM_FILTER_INVAL, /* Invalid filter bytecode */
	194	LTTCOMM_FILTER_NOMEM, /* Lack of memory for filter bytecode */
	195	LTTCOMM_FILTER_EXIST, /* Filter already exist */
80e327fa	196
20fe2104 DG	197	/* MUST be last element */
20fe2104 DG	198	LTTCOMM_NR, /* Last element */
fac6795d DG	199	};
fac6795d DG	200
de5e9086 DG	201	/* lttng socket protocol. */
	202	enum lttcomm_sock_proto {
	203	LTTCOMM_SOCK_UDP,
	204	LTTCOMM_SOCK_TCP,
	205	};
	206
	207	/*
	208	* Index in the net_families array below. Please keep in sync!
	209	*/
	210	enum lttcomm_sock_domain {
01d0a631 CB	211	LTTCOMM_INET = 0,
01d0a631 CB	212	LTTCOMM_INET6 = 1,
de5e9086 DG	213	};
	214
	215	struct lttcomm_sockaddr {
	216	enum lttcomm_sock_domain type;
	217	union {
	218	struct sockaddr_in sin;
	219	struct sockaddr_in6 sin6;
	220	} addr;
	221	};
	222
	223	struct lttcomm_sock {
	224	int fd;
	225	enum lttcomm_sock_proto proto;
	226	struct lttcomm_sockaddr sockaddr;
	227	const struct lttcomm_proto_ops *ops;
	228	};
	229
	230	struct lttcomm_net_family {
	231	int family;
	232	int (create) (struct lttcomm_sock sock, int type, int proto);
	233	};
	234
	235	struct lttcomm_proto_ops {
	236	int (bind) (struct lttcomm_sock sock);
	237	int (close) (struct lttcomm_sock sock);
	238	int (connect) (struct lttcomm_sock sock);
	239	struct lttcomm_sock (accept) (struct lttcomm_sock *sock);
	240	int (listen) (struct lttcomm_sock sock, int backlog);
	241	ssize_t (recvmsg) (struct lttcomm_sock sock, void *buf, size_t len,
	242	int flags);
	243	ssize_t (sendmsg) (struct lttcomm_sock sock, void *buf, size_t len,
	244	int flags);
	245	};
	246
fac6795d	247	/*
9bda164d	248	* Data structure received from lttng client to session daemon.
fac6795d DG	249	*/
fac6795d DG	250	struct lttcomm_session_msg {
773168b7	251	uint32_t cmd_type; /* enum lttcomm_sessiond_command */
42abccdb	252	struct lttng_session session;
9f19cc17	253	struct lttng_domain domain;
fac6795d DG	254	union {
fac6795d DG	255	struct {
f3ed775e DG	256	char channel_name[NAME_MAX];
	257	char name[NAME_MAX];
	258	} disable;
	259	/* Event data */
fac6795d	260	struct {
f3ed775e DG	261	char channel_name[NAME_MAX];
	262	struct lttng_event event;
	263	} enable;
	264	/* Create channel */
	265	struct {
	266	struct lttng_channel chan;
	267	} channel;
d65106b1 DG	268	/* Context */
	269	struct {
	270	char channel_name[NAME_MAX];
	271	char event_name[NAME_MAX];
7d29a247	272	struct lttng_event_context ctx;
d65106b1	273	} context;
d9800920 DG	274	/* Use by register_consumer */
	275	struct {
	276	char path[PATH_MAX];
	277	} reg;
9f19cc17 DG	278	/* List */
	279	struct {
	280	char channel_name[NAME_MAX];
	281	} list;
d0254c7c	282	struct lttng_calibrate calibrate;
de5e9086 DG	283	/* Used by the set_consumer_uri call */
	284	struct lttng_uri uri;
	285	struct {
	286	uint32_t enable_consumer;
	287	struct lttng_uri ctrl_uri;
	288	struct lttng_uri data_uri;
	289	} create_uri;
53a80697 MD	290	struct {
	291	char channel_name[NAME_MAX];
	292	char event_name[NAME_MAX];
	293	/* Length of following bytecode */
	294	uint32_t bytecode_len;
	295	} filter;
fac6795d DG	296	} u;
	297	};
	298
53a80697 MD	299	#define LTTNG_FILTER_MAX_LEN 65336
	300
	301	/*
	302	* Filter bytecode data. The reloc table is located at the end of the
	303	* bytecode. It is made of tuples: (uint16_t, var. len. string). It
	304	* starts at reloc_table_offset.
	305	*/
	306	struct lttng_filter_bytecode {
	307	uint16_t len; /* len of data */
	308	uint16_t reloc_table_offset;
	309	char data[0];
	310	};
	311
fac6795d	312	/*
5e16da05	313	* Data structure for the response from sessiond to the lttng client.
fac6795d	314	*/
5461b305	315	struct lttcomm_lttng_msg {
773168b7 MD	316	uint32_t cmd_type; /* enum lttcomm_sessiond_command */
	317	uint32_t ret_code; /* enum lttcomm_return_code */
	318	uint32_t pid; /* pid_t */
	319	uint32_t data_size;
5461b305 DG	320	/* Contains: trace_name + data */
5461b305 DG	321	char payload[];
fac6795d DG	322	};
fac6795d DG	323
44a5e5eb DG	324	struct lttcomm_health_msg {
	325	uint32_t component;
	326	uint32_t cmd;
	327	};
	328
	329	struct lttcomm_health_data {
	330	uint32_t ret_code;
	331	};
	332
6e3805e2	333	/*
3bd1e081 MD	334	* lttcomm_consumer_msg is the message sent from sessiond to consumerd
	335	* to either add a channel, add a stream, update a stream, or stop
	336	* operation.
6e3805e2	337	*/
3bd1e081 MD	338	struct lttcomm_consumer_msg {
	339	uint32_t cmd_type; /* enum consumerd_command */
	340	union {
	341	struct {
	342	int channel_key;
	343	uint64_t max_sb_size; /* the subbuffer size for this channel */
	344	/* shm_fd and wait_fd are sent as ancillary data */
	345	uint64_t mmap_len;
de5e9086	346	char name[LTTNG_SYMBOL_NAME_LEN];
3bd1e081 MD	347	} channel;
	348	struct {
	349	int channel_key;
	350	int stream_key;
	351	/* shm_fd and wait_fd are sent as ancillary data */
	352	uint32_t state; /* enum lttcomm_consumer_fd_state */
	353	enum lttng_event_output output; /* use splice or mmap to consume this fd */
	354	uint64_t mmap_len;
6df2e2c9 MD	355	uid_t uid; /* User ID owning the session */
6df2e2c9 MD	356	gid_t gid; /* Group ID owning the session */
3bd1e081	357	char path_name[PATH_MAX];
de5e9086 DG	358	int net_index;
	359	unsigned int metadata_flag;
	360	char name[LTTNG_SYMBOL_NAME_LEN]; /* Name string of the stream */
3bd1e081	361	} stream;
de5e9086 DG	362	struct {
	363	int net_index;
	364	enum lttng_stream_type type;
	365	/* Open socket to the relayd */
	366	struct lttcomm_sock sock;
	367	} relayd_sock;
173af62f DG	368	struct {
	369	uint64_t net_seq_idx;
	370	} destroy_relayd;
3bd1e081	371	} u;
6e3805e2 DG	372	};
6e3805e2 DG	373
74d0b642	374	#ifdef HAVE_LIBLTTNG_UST_CTL
3bd1e081	375
9df8df5e	376	#include <lttng/ust-abi.h>
6e3805e2	377
3817e7df DG	378	/*
	379	* Data structure for the commands sent from sessiond to UST.
	380	*/
	381	struct lttcomm_ust_msg {
3817e7df DG	382	uint32_t handle;
	383	uint32_t cmd;
	384	union {
3817e7df	385	struct lttng_ust_channel channel;
00a17c97	386	struct lttng_ust_stream stream;
3817e7df DG	387	struct lttng_ust_event event;
3817e7df DG	388	struct lttng_ust_context context;
00a17c97	389	struct lttng_ust_tracer_version version;
3817e7df DG	390	} u;
	391	};
	392
	393	/*
	394	* Data structure for the response from UST to the session daemon.
	395	* cmd_type is sent back in the reply for validation.
	396	*/
	397	struct lttcomm_ust_reply {
	398	uint32_t handle;
	399	uint32_t cmd;
	400	uint32_t ret_code; /* enum lttcomm_return_code */
	401	uint32_t ret_val; /* return value */
	402	union {
2b0bf864 DG	403	struct {
	404	uint64_t memory_map_size;
	405	} channel;
	406	struct {
	407	uint64_t memory_map_size;
	408	} stream;
00a17c97	409	struct lttng_ust_tracer_version version;
3817e7df DG	410	} u;
	411	};
	412
74d0b642	413	#endif /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081	414
fac6795d DG	415	extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
fac6795d DG	416
6364a07a DG	417	extern int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr *sockaddr,
	418	const char *ip, unsigned int port);
	419	extern int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr *sockaddr,
	420	const char *ip, unsigned int port);
	421
de5e9086 DG	422	extern struct lttcomm_sock *lttcomm_alloc_sock(enum lttcomm_sock_proto proto);
	423	extern int lttcomm_create_sock(struct lttcomm_sock *sock);
	424	extern struct lttcomm_sock lttcomm_alloc_sock_from_uri(struct lttng_uri uri);
	425	extern void lttcomm_destroy_sock(struct lttcomm_sock *sock);
	426	extern struct lttcomm_sock lttcomm_alloc_copy_sock(struct lttcomm_sock src);
	427	extern void lttcomm_copy_sock(struct lttcomm_sock *dst,
	428	struct lttcomm_sock *src);
6364a07a	429
773168b7	430	#endif /* _LTTNG_SESSIOND_COMM_H */