[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 <common/uri.h>
#include <common/defaults.h>
#include <common/compat/uuid.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_CONSUMERD_COMMAND_SOCK_READY)

enum lttcomm_sessiond_command {
	/* Tracer command */
	LTTNG_ADD_CONTEXT                   = 0,
	LTTNG_CALIBRATE                     = 1,
	LTTNG_DISABLE_CHANNEL               = 2,
	LTTNG_DISABLE_EVENT                 = 3,
	LTTNG_DISABLE_ALL_EVENT             = 4,
	LTTNG_ENABLE_CHANNEL                = 5,
	LTTNG_ENABLE_EVENT                  = 6,
	LTTNG_ENABLE_ALL_EVENT              = 7,
	/* Session daemon command */
	LTTNG_CREATE_SESSION                = 8,
	LTTNG_DESTROY_SESSION               = 9,
	LTTNG_LIST_CHANNELS                 = 10,
	LTTNG_LIST_DOMAINS                  = 11,
	LTTNG_LIST_EVENTS                   = 12,
	LTTNG_LIST_SESSIONS                 = 13,
	LTTNG_LIST_TRACEPOINTS              = 14,
	LTTNG_REGISTER_CONSUMER             = 15,
	LTTNG_START_TRACE                   = 16,
	LTTNG_STOP_TRACE                    = 17,
	LTTNG_LIST_TRACEPOINT_FIELDS        = 18,

	/* Consumer */
	LTTNG_DISABLE_CONSUMER              = 19,
	LTTNG_ENABLE_CONSUMER               = 20,
	LTTNG_SET_CONSUMER_URI              = 21,
	LTTNG_ENABLE_EVENT_WITH_FILTER      = 22,
	LTTNG_HEALTH_CHECK                  = 23,
	LTTNG_DATA_PENDING                  = 24,
};

enum lttcomm_relayd_command {
	RELAYD_ADD_STREAM                   = 1,
	RELAYD_CREATE_SESSION               = 2,
	RELAYD_START_DATA                   = 3,
	RELAYD_UPDATE_SYNC_INFO             = 4,
	RELAYD_VERSION                      = 5,
	RELAYD_SEND_METADATA                = 6,
	RELAYD_CLOSE_STREAM                 = 7,
	RELAYD_DATA_PENDING                 = 8,
	RELAYD_QUIESCENT_CONTROL            = 9,
	RELAYD_BEGIN_DATA_PENDING           = 10,
	RELAYD_END_DATA_PENDING             = 11,
};

/*
 * lttcomm error code.
 */
enum lttcomm_return_code {
	LTTCOMM_CONSUMERD_COMMAND_SOCK_READY = 1,   /* Command socket ready */
	LTTCOMM_CONSUMERD_SUCCESS_RECV_FD,          /* Success on receiving fds */
	LTTCOMM_CONSUMERD_ERROR_RECV_FD,            /* Error on receiving fds */
	LTTCOMM_CONSUMERD_ERROR_RECV_CMD,           /* Error on receiving command */
	LTTCOMM_CONSUMERD_POLL_ERROR,               /* Error in polling thread */
	LTTCOMM_CONSUMERD_POLL_NVAL,                /* Poll on closed fd */
	LTTCOMM_CONSUMERD_POLL_HUP,                 /* All fds have hungup */
	LTTCOMM_CONSUMERD_EXIT_SUCCESS,             /* Consumerd exiting normally */
	LTTCOMM_CONSUMERD_EXIT_FAILURE,             /* Consumerd exiting on error */
	LTTCOMM_CONSUMERD_OUTFD_ERROR,              /* Error opening the tracefile */
	LTTCOMM_CONSUMERD_SPLICE_EBADF,             /* EBADF from splice(2) */
	LTTCOMM_CONSUMERD_SPLICE_EINVAL,            /* EINVAL from splice(2) */
	LTTCOMM_CONSUMERD_SPLICE_ENOMEM,            /* ENOMEM from splice(2) */
	LTTCOMM_CONSUMERD_SPLICE_ESPIPE,            /* ESPIPE from splice(2) */
	LTTCOMM_CONSUMERD_ENOMEM,                   /* Consumer is out of memory */
	LTTCOMM_CONSUMERD_ERROR_METADATA,           /* Error with metadata. */
	LTTCOMM_CONSUMERD_FATAL,                    /* Fatal error. */
	LTTCOMM_CONSUMERD_RELAYD_FAIL,              /* Error on remote relayd */
	LTTCOMM_CONSUMERD_CHANNEL_FAIL,             /* Channel creation failed. */

	/* 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,
};

enum lttcomm_metadata_command {
	LTTCOMM_METADATA_REQUEST = 1,
};

/*
 * Commands sent from the consumerd to the sessiond to request if new metadata
 * is available. This message is used to find the per UID _or_ per PID registry
 * for the channel key. For per UID lookup, the triplet
 * bits_per_long/uid/session_id is used. On lookup failure, we search for the
 * per PID registry indexed by session id ignoring the other values.
 */
struct lttcomm_metadata_request_msg {
	uint64_t session_id; /* Tracing session id */
	uint64_t session_id_per_pid; /* Tracing session id for per-pid */
	uint32_t bits_per_long; /* Consumer ABI */
	uint32_t uid;
	uint64_t key; /* Metadata channel key. */
} LTTNG_PACKED;

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

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

/*
 * Relayd sock. Adds the protocol version to use for the communications with
 * the relayd.
 */
struct lttcomm_relayd_sock {
	struct lttcomm_sock sock;
	uint32_t major;
	uint32_t minor;
} LTTNG_PACKED;

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[LTTNG_SYMBOL_NAME_LEN];
			char name[NAME_MAX];
		} LTTNG_PACKED disable;
		/* Event data */
		struct {
			char channel_name[LTTNG_SYMBOL_NAME_LEN];
			struct lttng_event event;
			/* Length of following bytecode for filter. */
			uint32_t bytecode_len;
		} LTTNG_PACKED enable;
		/* Create channel */
		struct {
			struct lttng_channel chan;
		} LTTNG_PACKED channel;
		/* Context */
		struct {
			char channel_name[LTTNG_SYMBOL_NAME_LEN];
			struct lttng_event_context ctx;
		} LTTNG_PACKED context;
		/* Use by register_consumer */
		struct {
			char path[PATH_MAX];
		} LTTNG_PACKED reg;
		/* List */
		struct {
			char channel_name[LTTNG_SYMBOL_NAME_LEN];
		} LTTNG_PACKED list;
		struct lttng_calibrate calibrate;
		/* Used by the set_consumer_url and used by create_session also call */
		struct {
			/* Number of lttng_uri following */
			uint32_t size;
		} LTTNG_PACKED uri;
	} u;
} LTTNG_PACKED;

#define LTTNG_FILTER_MAX_LEN	65536

/*
 * 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.
 */
#define LTTNG_FILTER_PADDING	32
struct lttng_filter_bytecode {
	uint32_t len;	/* len of data */
	uint32_t reloc_table_offset;
	uint64_t seqnum;
	char padding[LTTNG_FILTER_PADDING];
	char data[0];
} LTTNG_PACKED;

/*
 * 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[];
} LTTNG_PACKED;

struct lttcomm_health_msg {
	uint32_t component;
	uint32_t cmd;
} LTTNG_PACKED;

struct lttcomm_health_data {
	uint32_t ret_code;
} LTTNG_PACKED;

/*
 * 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 {
			uint64_t channel_key;
			uint64_t session_id;
			char pathname[PATH_MAX];
			uint32_t uid;
			uint32_t gid;
			uint64_t relayd_id;
			/* nb_init_streams is the number of streams open initially. */
			uint32_t nb_init_streams;
			char name[LTTNG_SYMBOL_NAME_LEN];
			/* Use splice or mmap to consume this fd */
			enum lttng_event_output output;
			int type; /* Per cpu or metadata. */
			uint64_t tracefile_size; /* bytes */
			uint32_t tracefile_count; /* number of tracefiles */
		} LTTNG_PACKED channel; /* Only used by Kernel. */
		struct {
			uint64_t stream_key;
			uint64_t channel_key;
			int32_t cpu;	/* On which CPU this stream is assigned. */
		} LTTNG_PACKED stream;	/* Only used by Kernel. */
		struct {
			uint64_t net_index;
			enum lttng_stream_type type;
			/* Open socket to the relayd */
			struct lttcomm_relayd_sock sock;
			/* Tracing session id associated to the relayd. */
			uint64_t session_id;
		} LTTNG_PACKED relayd_sock;
		struct {
			uint64_t net_seq_idx;
		} LTTNG_PACKED destroy_relayd;
		struct {
			uint64_t session_id;
		} LTTNG_PACKED data_pending;
		struct {
			uint64_t subbuf_size;			/* bytes */
			uint64_t num_subbuf;			/* power of 2 */
			int32_t overwrite;			/* 1: overwrite, 0: discard */
			uint32_t switch_timer_interval;		/* usec */
			uint32_t read_timer_interval;		/* usec */
			int32_t output;				/* splice, mmap */
			int32_t type;				/* metadata or per_cpu */
			uint64_t session_id;			/* Tracing session id */
			char pathname[PATH_MAX];		/* Channel file path. */
			char name[LTTNG_SYMBOL_NAME_LEN];	/* Channel name. */
			uint32_t uid;				/* User ID of the session */
			uint32_t gid;				/* Group ID ot the session */
			uint64_t relayd_id;			/* Relayd id if apply. */
			uint64_t key;				/* Unique channel key. */
			unsigned char uuid[UUID_LEN];	/* uuid for ust tracer. */
			uint32_t chan_id;			/* Channel ID on the tracer side. */
			uint64_t tracefile_size;	/* bytes */
			uint32_t tracefile_count;	/* number of tracefiles */
			uint64_t session_id_per_pid;	/* Per-pid session ID. */
		} LTTNG_PACKED ask_channel;
		struct {
			uint64_t key;
		} LTTNG_PACKED get_channel;
		struct {
			uint64_t key;
		} LTTNG_PACKED destroy_channel;
		struct {
			uint64_t key;	/* Metadata channel key. */
			uint64_t target_offset;	/* Offset in the consumer */
			uint64_t len;	/* Length of metadata to be received. */
		} LTTNG_PACKED push_metadata;
		struct {
			uint64_t key;	/* Metadata channel key. */
		} LTTNG_PACKED close_metadata;
		struct {
			uint64_t key;	/* Metadata channel key. */
		} LTTNG_PACKED setup_metadata;
		struct {
			uint64_t key;	/* Channel key. */
		} LTTNG_PACKED flush_channel;
	} u;
} LTTNG_PACKED;

/*
 * Status message returned to the sessiond after a received command.
 */
struct lttcomm_consumer_status_msg {
	enum lttng_error_code ret_code;
} LTTNG_PACKED;

struct lttcomm_consumer_status_channel {
	enum lttng_error_code ret_code;
	uint64_t key;
	unsigned int stream_count;
} LTTNG_PACKED;

#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;
} LTTNG_PACKED;

/*
 * 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;
		} LTTNG_PACKED channel;
		struct {
			uint64_t memory_map_size;
		} LTTNG_PACKED stream;
		struct lttng_ust_tracer_version version;
	} u;
} LTTNG_PACKED;

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

/* Relayd socket object. */
extern struct lttcomm_relayd_sock *lttcomm_alloc_relayd_sock(
		struct lttng_uri *uri, uint32_t major, uint32_t minor);

#endif	/* _LTTNG_SESSIOND_COMM_H */
Commit	Line	Data
	1	/*
	2	* Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
	3	* Julien Desfossez <julien.desfossez@polymtl.ca>
	4	* Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	5	*
	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.
	9	*
	10	* This program is distributed in the hope that it will be useful, but WITHOUT
	11	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	12	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
	13	* more details.
	14	*
	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.
	18	*/
	19
	20	/*
	21	* This header is meant for liblttng and libust internal use ONLY. These
	22	* declarations should NOT be considered stable API.
	23	*/
	24
	25	#ifndef _LTTNG_SESSIOND_COMM_H
	26	#define _LTTNG_SESSIOND_COMM_H
	27
	28	#define _GNU_SOURCE
	29	#include <limits.h>
	30	#include <lttng/lttng.h>
	31	#include <common/compat/socket.h>
	32	#include <common/uri.h>
	33	#include <common/defaults.h>
	34	#include <common/compat/uuid.h>
	35
	36	#include <arpa/inet.h>
	37	#include <netinet/in.h>
	38	#include <sys/un.h>
	39
	40	#include "inet.h"
	41	#include "inet6.h"
	42	#include "unix.h"
	43
	44	/* Queue size of listen(2) */
	45	#define LTTNG_SESSIOND_COMM_MAX_LISTEN 64
	46
	47	/* Maximum number of FDs that can be sent over a Unix socket */
	48	#define LTTCOMM_MAX_SEND_FDS 4
	49
	50	/*
	51	* Get the error code index from 0 since LTTCOMM_OK start at 1000
	52	*/
	53	#define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_CONSUMERD_COMMAND_SOCK_READY)
	54
	55	enum lttcomm_sessiond_command {
	56	/* Tracer command */
	57	LTTNG_ADD_CONTEXT = 0,
	58	LTTNG_CALIBRATE = 1,
	59	LTTNG_DISABLE_CHANNEL = 2,
	60	LTTNG_DISABLE_EVENT = 3,
	61	LTTNG_DISABLE_ALL_EVENT = 4,
	62	LTTNG_ENABLE_CHANNEL = 5,
	63	LTTNG_ENABLE_EVENT = 6,
	64	LTTNG_ENABLE_ALL_EVENT = 7,
	65	/* Session daemon command */
	66	LTTNG_CREATE_SESSION = 8,
	67	LTTNG_DESTROY_SESSION = 9,
	68	LTTNG_LIST_CHANNELS = 10,
	69	LTTNG_LIST_DOMAINS = 11,
	70	LTTNG_LIST_EVENTS = 12,
	71	LTTNG_LIST_SESSIONS = 13,
	72	LTTNG_LIST_TRACEPOINTS = 14,
	73	LTTNG_REGISTER_CONSUMER = 15,
	74	LTTNG_START_TRACE = 16,
	75	LTTNG_STOP_TRACE = 17,
	76	LTTNG_LIST_TRACEPOINT_FIELDS = 18,
	77
	78	/* Consumer */
	79	LTTNG_DISABLE_CONSUMER = 19,
	80	LTTNG_ENABLE_CONSUMER = 20,
	81	LTTNG_SET_CONSUMER_URI = 21,
	82	LTTNG_ENABLE_EVENT_WITH_FILTER = 22,
	83	LTTNG_HEALTH_CHECK = 23,
	84	LTTNG_DATA_PENDING = 24,
	85	};
	86
	87	enum lttcomm_relayd_command {
	88	RELAYD_ADD_STREAM = 1,
	89	RELAYD_CREATE_SESSION = 2,
	90	RELAYD_START_DATA = 3,
	91	RELAYD_UPDATE_SYNC_INFO = 4,
	92	RELAYD_VERSION = 5,
	93	RELAYD_SEND_METADATA = 6,
	94	RELAYD_CLOSE_STREAM = 7,
	95	RELAYD_DATA_PENDING = 8,
	96	RELAYD_QUIESCENT_CONTROL = 9,
	97	RELAYD_BEGIN_DATA_PENDING = 10,
	98	RELAYD_END_DATA_PENDING = 11,
	99	};
	100
	101	/*
	102	* lttcomm error code.
	103	*/
	104	enum lttcomm_return_code {
	105	LTTCOMM_CONSUMERD_COMMAND_SOCK_READY = 1, /* Command socket ready */
	106	LTTCOMM_CONSUMERD_SUCCESS_RECV_FD, /* Success on receiving fds */
	107	LTTCOMM_CONSUMERD_ERROR_RECV_FD, /* Error on receiving fds */
	108	LTTCOMM_CONSUMERD_ERROR_RECV_CMD, /* Error on receiving command */
	109	LTTCOMM_CONSUMERD_POLL_ERROR, /* Error in polling thread */
	110	LTTCOMM_CONSUMERD_POLL_NVAL, /* Poll on closed fd */
	111	LTTCOMM_CONSUMERD_POLL_HUP, /* All fds have hungup */
	112	LTTCOMM_CONSUMERD_EXIT_SUCCESS, /* Consumerd exiting normally */
	113	LTTCOMM_CONSUMERD_EXIT_FAILURE, /* Consumerd exiting on error */
	114	LTTCOMM_CONSUMERD_OUTFD_ERROR, /* Error opening the tracefile */
	115	LTTCOMM_CONSUMERD_SPLICE_EBADF, /* EBADF from splice(2) */
	116	LTTCOMM_CONSUMERD_SPLICE_EINVAL, /* EINVAL from splice(2) */
	117	LTTCOMM_CONSUMERD_SPLICE_ENOMEM, /* ENOMEM from splice(2) */
	118	LTTCOMM_CONSUMERD_SPLICE_ESPIPE, /* ESPIPE from splice(2) */
	119	LTTCOMM_CONSUMERD_ENOMEM, /* Consumer is out of memory */
	120	LTTCOMM_CONSUMERD_ERROR_METADATA, /* Error with metadata. */
	121	LTTCOMM_CONSUMERD_FATAL, /* Fatal error. */
	122	LTTCOMM_CONSUMERD_RELAYD_FAIL, /* Error on remote relayd */
	123	LTTCOMM_CONSUMERD_CHANNEL_FAIL, /* Channel creation failed. */
	124
	125	/* MUST be last element */
	126	LTTCOMM_NR, /* Last element */
	127	};
	128
	129	/* lttng socket protocol. */
	130	enum lttcomm_sock_proto {
	131	LTTCOMM_SOCK_UDP,
	132	LTTCOMM_SOCK_TCP,
	133	};
	134
	135	/*
	136	* Index in the net_families array below. Please keep in sync!
	137	*/
	138	enum lttcomm_sock_domain {
	139	LTTCOMM_INET = 0,
	140	LTTCOMM_INET6 = 1,
	141	};
	142
	143	enum lttcomm_metadata_command {
	144	LTTCOMM_METADATA_REQUEST = 1,
	145	};
	146
	147	/*
	148	* Commands sent from the consumerd to the sessiond to request if new metadata
	149	* is available. This message is used to find the per UID _or_ per PID registry
	150	* for the channel key. For per UID lookup, the triplet
	151	* bits_per_long/uid/session_id is used. On lookup failure, we search for the
	152	* per PID registry indexed by session id ignoring the other values.
	153	*/
	154	struct lttcomm_metadata_request_msg {
	155	uint64_t session_id; /* Tracing session id */
	156	uint64_t session_id_per_pid; /* Tracing session id for per-pid */
	157	uint32_t bits_per_long; /* Consumer ABI */
	158	uint32_t uid;
	159	uint64_t key; /* Metadata channel key. */
	160	} LTTNG_PACKED;
	161
	162	struct lttcomm_sockaddr {
	163	enum lttcomm_sock_domain type;
	164	union {
	165	struct sockaddr_in sin;
	166	struct sockaddr_in6 sin6;
	167	} addr;
	168	} LTTNG_PACKED;
	169
	170	struct lttcomm_sock {
	171	int32_t fd;
	172	enum lttcomm_sock_proto proto;
	173	struct lttcomm_sockaddr sockaddr;
	174	const struct lttcomm_proto_ops *ops;
	175	} LTTNG_PACKED;
	176
	177	/*
	178	* Relayd sock. Adds the protocol version to use for the communications with
	179	* the relayd.
	180	*/
	181	struct lttcomm_relayd_sock {
	182	struct lttcomm_sock sock;
	183	uint32_t major;
	184	uint32_t minor;
	185	} LTTNG_PACKED;
	186
	187	struct lttcomm_net_family {
	188	int family;
	189	int (create) (struct lttcomm_sock sock, int type, int proto);
	190	};
	191
	192	struct lttcomm_proto_ops {
	193	int (bind) (struct lttcomm_sock sock);
	194	int (close) (struct lttcomm_sock sock);
	195	int (connect) (struct lttcomm_sock sock);
	196	struct lttcomm_sock (accept) (struct lttcomm_sock *sock);
	197	int (listen) (struct lttcomm_sock sock, int backlog);
	198	ssize_t (recvmsg) (struct lttcomm_sock sock, void *buf, size_t len,
	199	int flags);
	200	ssize_t (sendmsg) (struct lttcomm_sock sock, void *buf, size_t len,
	201	int flags);
	202	};
	203
	204	/*
	205	* Data structure received from lttng client to session daemon.
	206	*/
	207	struct lttcomm_session_msg {
	208	uint32_t cmd_type; /* enum lttcomm_sessiond_command */
	209	struct lttng_session session;
	210	struct lttng_domain domain;
	211	union {
	212	struct {
	213	char channel_name[LTTNG_SYMBOL_NAME_LEN];
	214	char name[NAME_MAX];
	215	} LTTNG_PACKED disable;
	216	/* Event data */
	217	struct {
	218	char channel_name[LTTNG_SYMBOL_NAME_LEN];
	219	struct lttng_event event;
	220	/* Length of following bytecode for filter. */
	221	uint32_t bytecode_len;
	222	} LTTNG_PACKED enable;
	223	/* Create channel */
	224	struct {
	225	struct lttng_channel chan;
	226	} LTTNG_PACKED channel;
	227	/* Context */
	228	struct {
	229	char channel_name[LTTNG_SYMBOL_NAME_LEN];
	230	struct lttng_event_context ctx;
	231	} LTTNG_PACKED context;
	232	/* Use by register_consumer */
	233	struct {
	234	char path[PATH_MAX];
	235	} LTTNG_PACKED reg;
	236	/* List */
	237	struct {
	238	char channel_name[LTTNG_SYMBOL_NAME_LEN];
	239	} LTTNG_PACKED list;
	240	struct lttng_calibrate calibrate;
	241	/* Used by the set_consumer_url and used by create_session also call */
	242	struct {
	243	/* Number of lttng_uri following */
	244	uint32_t size;
	245	} LTTNG_PACKED uri;
	246	} u;
	247	} LTTNG_PACKED;
	248
	249	#define LTTNG_FILTER_MAX_LEN 65536
	250
	251	/*
	252	* Filter bytecode data. The reloc table is located at the end of the
	253	* bytecode. It is made of tuples: (uint16_t, var. len. string). It
	254	* starts at reloc_table_offset.
	255	*/
	256	#define LTTNG_FILTER_PADDING 32
	257	struct lttng_filter_bytecode {
	258	uint32_t len; /* len of data */
	259	uint32_t reloc_table_offset;
	260	uint64_t seqnum;
	261	char padding[LTTNG_FILTER_PADDING];
	262	char data[0];
	263	} LTTNG_PACKED;
	264
	265	/*
	266	* Data structure for the response from sessiond to the lttng client.
	267	*/
	268	struct lttcomm_lttng_msg {
	269	uint32_t cmd_type; /* enum lttcomm_sessiond_command */
	270	uint32_t ret_code; /* enum lttcomm_return_code */
	271	uint32_t pid; /* pid_t */
	272	uint32_t data_size;
	273	/* Contains: trace_name + data */
	274	char payload[];
	275	} LTTNG_PACKED;
	276
	277	struct lttcomm_health_msg {
	278	uint32_t component;
	279	uint32_t cmd;
	280	} LTTNG_PACKED;
	281
	282	struct lttcomm_health_data {
	283	uint32_t ret_code;
	284	} LTTNG_PACKED;
	285
	286	/*
	287	* lttcomm_consumer_msg is the message sent from sessiond to consumerd
	288	* to either add a channel, add a stream, update a stream, or stop
	289	* operation.
	290	*/
	291	struct lttcomm_consumer_msg {
	292	uint32_t cmd_type; /* enum consumerd_command */
	293	union {
	294	struct {
	295	uint64_t channel_key;
	296	uint64_t session_id;
	297	char pathname[PATH_MAX];
	298	uint32_t uid;
	299	uint32_t gid;
	300	uint64_t relayd_id;
	301	/* nb_init_streams is the number of streams open initially. */
	302	uint32_t nb_init_streams;
	303	char name[LTTNG_SYMBOL_NAME_LEN];
	304	/* Use splice or mmap to consume this fd */
	305	enum lttng_event_output output;
	306	int type; /* Per cpu or metadata. */
	307	uint64_t tracefile_size; /* bytes */
	308	uint32_t tracefile_count; /* number of tracefiles */
	309	} LTTNG_PACKED channel; /* Only used by Kernel. */
	310	struct {
	311	uint64_t stream_key;
	312	uint64_t channel_key;
	313	int32_t cpu; /* On which CPU this stream is assigned. */
	314	} LTTNG_PACKED stream; /* Only used by Kernel. */
	315	struct {
	316	uint64_t net_index;
	317	enum lttng_stream_type type;
	318	/* Open socket to the relayd */
	319	struct lttcomm_relayd_sock sock;
	320	/* Tracing session id associated to the relayd. */
	321	uint64_t session_id;
	322	} LTTNG_PACKED relayd_sock;
	323	struct {
	324	uint64_t net_seq_idx;
	325	} LTTNG_PACKED destroy_relayd;
	326	struct {
	327	uint64_t session_id;
	328	} LTTNG_PACKED data_pending;
	329	struct {
	330	uint64_t subbuf_size; /* bytes */
	331	uint64_t num_subbuf; /* power of 2 */
	332	int32_t overwrite; /* 1: overwrite, 0: discard */
	333	uint32_t switch_timer_interval; /* usec */
	334	uint32_t read_timer_interval; /* usec */
	335	int32_t output; /* splice, mmap */
	336	int32_t type; /* metadata or per_cpu */
	337	uint64_t session_id; /* Tracing session id */
	338	char pathname[PATH_MAX]; /* Channel file path. */
	339	char name[LTTNG_SYMBOL_NAME_LEN]; /* Channel name. */
	340	uint32_t uid; /* User ID of the session */
	341	uint32_t gid; /* Group ID ot the session */
	342	uint64_t relayd_id; /* Relayd id if apply. */
	343	uint64_t key; /* Unique channel key. */
	344	unsigned char uuid[UUID_LEN]; /* uuid for ust tracer. */
	345	uint32_t chan_id; /* Channel ID on the tracer side. */
	346	uint64_t tracefile_size; /* bytes */
	347	uint32_t tracefile_count; /* number of tracefiles */
	348	uint64_t session_id_per_pid; /* Per-pid session ID. */
	349	} LTTNG_PACKED ask_channel;
	350	struct {
	351	uint64_t key;
	352	} LTTNG_PACKED get_channel;
	353	struct {
	354	uint64_t key;
	355	} LTTNG_PACKED destroy_channel;
	356	struct {
	357	uint64_t key; /* Metadata channel key. */
	358	uint64_t target_offset; /* Offset in the consumer */
	359	uint64_t len; /* Length of metadata to be received. */
	360	} LTTNG_PACKED push_metadata;
	361	struct {
	362	uint64_t key; /* Metadata channel key. */
	363	} LTTNG_PACKED close_metadata;
	364	struct {
	365	uint64_t key; /* Metadata channel key. */
	366	} LTTNG_PACKED setup_metadata;
	367	struct {
	368	uint64_t key; /* Channel key. */
	369	} LTTNG_PACKED flush_channel;
	370	} u;
	371	} LTTNG_PACKED;
	372
	373	/*
	374	* Status message returned to the sessiond after a received command.
	375	*/
	376	struct lttcomm_consumer_status_msg {
	377	enum lttng_error_code ret_code;
	378	} LTTNG_PACKED;
	379
	380	struct lttcomm_consumer_status_channel {
	381	enum lttng_error_code ret_code;
	382	uint64_t key;
	383	unsigned int stream_count;
	384	} LTTNG_PACKED;
	385
	386	#ifdef HAVE_LIBLTTNG_UST_CTL
	387
	388	#include <lttng/ust-abi.h>
	389
	390	/*
	391	* Data structure for the commands sent from sessiond to UST.
	392	*/
	393	struct lttcomm_ust_msg {
	394	uint32_t handle;
	395	uint32_t cmd;
	396	union {
	397	struct lttng_ust_channel channel;
	398	struct lttng_ust_stream stream;
	399	struct lttng_ust_event event;
	400	struct lttng_ust_context context;
	401	struct lttng_ust_tracer_version version;
	402	} u;
	403	} LTTNG_PACKED;
	404
	405	/*
	406	* Data structure for the response from UST to the session daemon.
	407	* cmd_type is sent back in the reply for validation.
	408	*/
	409	struct lttcomm_ust_reply {
	410	uint32_t handle;
	411	uint32_t cmd;
	412	uint32_t ret_code; /* enum lttcomm_return_code */
	413	uint32_t ret_val; /* return value */
	414	union {
	415	struct {
	416	uint64_t memory_map_size;
	417	} LTTNG_PACKED channel;
	418	struct {
	419	uint64_t memory_map_size;
	420	} LTTNG_PACKED stream;
	421	struct lttng_ust_tracer_version version;
	422	} u;
	423	} LTTNG_PACKED;
	424
	425	#endif /* HAVE_LIBLTTNG_UST_CTL */
	426
	427	extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
	428
	429	extern int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr *sockaddr,
	430	const char *ip, unsigned int port);
	431	extern int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr *sockaddr,
	432	const char *ip, unsigned int port);
	433
	434	extern struct lttcomm_sock *lttcomm_alloc_sock(enum lttcomm_sock_proto proto);
	435	extern int lttcomm_create_sock(struct lttcomm_sock *sock);
	436	extern struct lttcomm_sock lttcomm_alloc_sock_from_uri(struct lttng_uri uri);
	437	extern void lttcomm_destroy_sock(struct lttcomm_sock *sock);
	438	extern struct lttcomm_sock lttcomm_alloc_copy_sock(struct lttcomm_sock src);
	439	extern void lttcomm_copy_sock(struct lttcomm_sock *dst,
	440	struct lttcomm_sock *src);
	441
	442	/* Relayd socket object. */
	443	extern struct lttcomm_relayd_sock *lttcomm_alloc_relayd_sock(
	444	struct lttng_uri *uri, uint32_t major, uint32_t minor);
	445
	446	#endif /* _LTTNG_SESSIOND_COMM_H */