[lttng-tools.git] / src / common / sessiond-comm / relayd.h

/*
 * Copyright (C) 2012 - David Goulet <dgoulet@efficios.com>
 *                      Julien Desfossez <julien.desfossez@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.
 */

#ifndef _RELAYD_COMM
#define _RELAYD_COMM

#include <limits.h>
#include <stdint.h>

#include <lttng/lttng.h>
#include <common/defaults.h>
#include <common/index/ctf-index.h>
#include <common/macros.h>
#include <common/uuid.h>
#include <common/optional.h>

#define RELAYD_VERSION_COMM_MAJOR             VERSION_MAJOR
#define RELAYD_VERSION_COMM_MINOR             VERSION_MINOR

#define RELAYD_COMM_LTTNG_HOST_NAME_MAX_2_4	64
#define RELAYD_COMM_LTTNG_NAME_MAX_2_4	255
#define RELAYD_COMM_LTTNG_PATH_MAX	4096
#define RELAYD_COMM_DEFAULT_STREAM_NAME_LEN	264 /* 256 + 8 */

/*
 * lttng-relayd communication header.
 */
struct lttcomm_relayd_hdr {
	/* Circuit ID not used for now so always ignored */
	uint64_t circuit_id;
	uint64_t data_size;		/* data size following this header */
	uint32_t cmd;			/* enum lttcomm_relayd_command */
	uint32_t cmd_version;	/* command version */
} LTTNG_PACKED;

/*
 * lttng-relayd data header.
 */
struct lttcomm_relayd_data_hdr {
	/* Circuit ID not used for now so always ignored */
	uint64_t circuit_id;
	uint64_t stream_id;     /* Stream ID known by the relayd */
	uint64_t net_seq_num;   /* Network sequence number, per stream. */
	uint32_t data_size;     /* data size following this header */
	uint32_t padding_size;  /* Size of 0 padding the data */
} LTTNG_PACKED;

/*
 * Reply from a create session command.
 */
struct lttcomm_relayd_status_session {
	uint64_t session_id;
	uint32_t ret_code;
} LTTNG_PACKED;

/*
 * Used to add a stream on the relay daemon.
 */
struct lttcomm_relayd_add_stream {
	char channel_name[RELAYD_COMM_DEFAULT_STREAM_NAME_LEN];
	char pathname[RELAYD_COMM_LTTNG_PATH_MAX];
} LTTNG_PACKED;

/*
 * Used to add a stream on the relay daemon.
 * Protocol version 2.2
 */
struct lttcomm_relayd_add_stream_2_2 {
	char channel_name[RELAYD_COMM_DEFAULT_STREAM_NAME_LEN];
	char pathname[RELAYD_COMM_LTTNG_PATH_MAX];
	uint64_t tracefile_size;
	uint64_t tracefile_count;
} LTTNG_PACKED;

struct lttcomm_relayd_add_stream_2_11 {
	uint32_t channel_name_len;
	uint32_t pathname_len;
	uint64_t tracefile_size;
	uint64_t tracefile_count;
	uint64_t trace_chunk_id;
	char names[];
} LTTNG_PACKED;

/*
 * Answer from an add stream command.
 */
struct lttcomm_relayd_status_stream {
	uint64_t handle;
	uint32_t ret_code;
} LTTNG_PACKED;

/*
 * Used to return command code for command not needing special data.
 */
struct lttcomm_relayd_generic_reply {
	uint32_t ret_code;
} LTTNG_PACKED;

/*
 * Version command.
 */
struct lttcomm_relayd_version {
	uint32_t major;
	uint32_t minor;
} LTTNG_PACKED;

/*
 * Metadata payload used when metadata command is sent.
 */
struct lttcomm_relayd_metadata_payload {
	uint64_t stream_id;
	uint32_t padding_size;
	char payload[];
} LTTNG_PACKED;

/*
 * Used to indicate that a specific stream id can now be closed.
 */
struct lttcomm_relayd_close_stream {
	uint64_t stream_id;
	uint64_t last_net_seq_num;	/* sequence number of last packet */
} LTTNG_PACKED;

/*
 * Used to test if for a given stream id the data is pending on the relayd side
 * for reading.
 */
struct lttcomm_relayd_data_pending {
	uint64_t stream_id;
	uint64_t last_net_seq_num; /* Sequence number of the last packet */
} LTTNG_PACKED;

struct lttcomm_relayd_begin_data_pending {
	uint64_t session_id;
} LTTNG_PACKED;

struct lttcomm_relayd_end_data_pending {
	uint64_t session_id;
} LTTNG_PACKED;

struct lttcomm_relayd_quiescent_control {
	uint64_t stream_id;
} LTTNG_PACKED;

/*
 * Index data.
 */
struct lttcomm_relayd_index {
	uint64_t relay_stream_id;
	uint64_t net_seq_num;
	uint64_t packet_size;
	uint64_t content_size;
	uint64_t timestamp_begin;
	uint64_t timestamp_end;
	uint64_t events_discarded;
	uint64_t stream_id;
	/* 2.8+ */
	uint64_t stream_instance_id;
	uint64_t packet_seq_num;
} LTTNG_PACKED;

static inline size_t lttcomm_relayd_index_len(uint32_t major, uint32_t minor)
{
	if (major == 1) {
		switch (minor) {
		case 0:
			return offsetof(struct lttcomm_relayd_index, stream_id)
				+ member_sizeof(struct lttcomm_relayd_index,
						stream_id);
		case 1:
			return offsetof(struct lttcomm_relayd_index, packet_seq_num)
				+ member_sizeof(struct lttcomm_relayd_index,
						packet_seq_num);
		default:
			abort();
		}
	}
	abort();
}

/*
 * Create session in 2.4 adds additionnal parameters for live reading.
 */
struct lttcomm_relayd_create_session_2_4 {
	char session_name[RELAYD_COMM_LTTNG_NAME_MAX_2_4];
	char hostname[RELAYD_COMM_LTTNG_HOST_NAME_MAX_2_4];
	uint32_t live_timer;
	uint32_t snapshot;
} LTTNG_PACKED;

struct lttcomm_relayd_create_session_2_11 {
	uint32_t session_name_len;
	uint32_t hostname_len;
	/* Optional, set to 0 to indicate it is not user-specified. */
	uint32_t base_path_len;
	uint32_t live_timer;
	uint8_t snapshot;
	uint8_t session_name_contains_creation_time;
	/* Sessiond instance UUID */
	lttng_uuid sessiond_uuid;
	/* Sessiond session id */
        uint64_t session_id;
	/* Session creation time, in seconds since UNIX Epoch. */
	uint64_t creation_time;
	LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED current_chunk_id;
	/* Contains the session_name, hostname, base_path. */
	char names[];
} LTTNG_PACKED;

struct lttcomm_relayd_create_session_reply_2_11 {
	struct lttcomm_relayd_status_session generic;
	/* Includes the '\0' terminator. */
	uint32_t output_path_length;
	char output_path[];
} LTTNG_PACKED;

/*
 * Used to ask the relay to reset the metadata trace file (regeneration).
 * Send the new version of the metadata (starts at 0).
 */
struct lttcomm_relayd_reset_metadata {
	uint64_t stream_id;
	uint64_t version;
} LTTNG_PACKED;

struct lttcomm_relayd_stream_rotation_position {
	uint64_t stream_id;
	/*
	 * Sequence number of the first packet belonging to the new
	 * "destination" trace chunk to which the stream is rotating.
	 *
	 * Ignored for metadata streams.
	 */
	uint64_t rotate_at_seq_num;
} LTTNG_PACKED;

struct lttcomm_relayd_rotate_streams {
	uint32_t stream_count;
	/*
	 * Streams can be rotated outside of a chunk but not be parented to
	 * a new chunk.
	 */
	LTTNG_OPTIONAL_COMM(uint64_t) new_chunk_id;
	/* `stream_count` positions follow. */
	struct lttcomm_relayd_stream_rotation_position rotation_positions[];
} LTTNG_PACKED;

struct lttcomm_relayd_create_trace_chunk {
	uint64_t chunk_id;
	/* Seconds since EPOCH. */
	uint64_t creation_timestamp;
	/* Includes trailing NULL. */
	uint32_t override_name_length;
	char override_name[];
} LTTNG_PACKED;

struct lttcomm_relayd_close_trace_chunk {
	uint64_t chunk_id;
	/* Seconds since EPOCH. */
	uint64_t close_timestamp;
	/* enum lttng_trace_chunk_command_type */
	LTTNG_OPTIONAL_COMM(uint32_t) LTTNG_PACKED close_command;
} LTTNG_PACKED;

struct lttcomm_relayd_close_trace_chunk_reply {
	struct lttcomm_relayd_generic_reply generic;
	/* Includes trailing NULL. */
	uint32_t path_length;
	char path[];
} LTTNG_PACKED;

struct lttcomm_relayd_trace_chunk_exists {
	uint64_t chunk_id;
} LTTNG_PACKED;

struct lttcomm_relayd_trace_chunk_exists_reply {
	struct lttcomm_relayd_generic_reply generic;
	uint8_t trace_chunk_exists;
} LTTNG_PACKED;

#endif	/* _RELAYD_COMM */
Commit	Line	Data
	1	/*
	2	* Copyright (C) 2012 - David Goulet <dgoulet@efficios.com>
	3	* Julien Desfossez <julien.desfossez@efficios.com>
	4	*
	5	* This program is free software; you can redistribute it and/or modify
	6	* it under the terms of the GNU General Public License, version 2 only,
	7	* as published by the Free Software Foundation.
	8	*
	9	* This program is distributed in the hope that it will be useful, but WITHOUT
	10	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	11	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
	12	* more details.
	13	*
	14	* You should have received a copy of the GNU General Public License along
	15	* with this program; if not, write to the Free Software Foundation, Inc.,
	16	* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
	17	*/
	18
	19	#ifndef _RELAYD_COMM
	20	#define _RELAYD_COMM
	21
	22	#include <limits.h>
	23	#include <stdint.h>
	24
	25	#include <lttng/lttng.h>
	26	#include <common/defaults.h>
	27	#include <common/index/ctf-index.h>
	28	#include <common/macros.h>
	29	#include <common/uuid.h>
	30	#include <common/optional.h>
	31
	32	#define RELAYD_VERSION_COMM_MAJOR VERSION_MAJOR
	33	#define RELAYD_VERSION_COMM_MINOR VERSION_MINOR
	34
	35	#define RELAYD_COMM_LTTNG_HOST_NAME_MAX_2_4 64
	36	#define RELAYD_COMM_LTTNG_NAME_MAX_2_4 255
	37	#define RELAYD_COMM_LTTNG_PATH_MAX 4096
	38	#define RELAYD_COMM_DEFAULT_STREAM_NAME_LEN 264 /* 256 + 8 */
	39
	40	/*
	41	* lttng-relayd communication header.
	42	*/
	43	struct lttcomm_relayd_hdr {
	44	/* Circuit ID not used for now so always ignored */
	45	uint64_t circuit_id;
	46	uint64_t data_size; /* data size following this header */
	47	uint32_t cmd; /* enum lttcomm_relayd_command */
	48	uint32_t cmd_version; /* command version */
	49	} LTTNG_PACKED;
	50
	51	/*
	52	* lttng-relayd data header.
	53	*/
	54	struct lttcomm_relayd_data_hdr {
	55	/* Circuit ID not used for now so always ignored */
	56	uint64_t circuit_id;
	57	uint64_t stream_id; /* Stream ID known by the relayd */
	58	uint64_t net_seq_num; /* Network sequence number, per stream. */
	59	uint32_t data_size; /* data size following this header */
	60	uint32_t padding_size; /* Size of 0 padding the data */
	61	} LTTNG_PACKED;
	62
	63	/*
	64	* Reply from a create session command.
	65	*/
	66	struct lttcomm_relayd_status_session {
	67	uint64_t session_id;
	68	uint32_t ret_code;
	69	} LTTNG_PACKED;
	70
	71	/*
	72	* Used to add a stream on the relay daemon.
	73	*/
	74	struct lttcomm_relayd_add_stream {
	75	char channel_name[RELAYD_COMM_DEFAULT_STREAM_NAME_LEN];
	76	char pathname[RELAYD_COMM_LTTNG_PATH_MAX];
	77	} LTTNG_PACKED;
	78
	79	/*
	80	* Used to add a stream on the relay daemon.
	81	* Protocol version 2.2
	82	*/
	83	struct lttcomm_relayd_add_stream_2_2 {
	84	char channel_name[RELAYD_COMM_DEFAULT_STREAM_NAME_LEN];
	85	char pathname[RELAYD_COMM_LTTNG_PATH_MAX];
	86	uint64_t tracefile_size;
	87	uint64_t tracefile_count;
	88	} LTTNG_PACKED;
	89
	90	struct lttcomm_relayd_add_stream_2_11 {
	91	uint32_t channel_name_len;
	92	uint32_t pathname_len;
	93	uint64_t tracefile_size;
	94	uint64_t tracefile_count;
	95	uint64_t trace_chunk_id;
	96	char names[];
	97	} LTTNG_PACKED;
	98
	99	/*
	100	* Answer from an add stream command.
	101	*/
	102	struct lttcomm_relayd_status_stream {
	103	uint64_t handle;
	104	uint32_t ret_code;
	105	} LTTNG_PACKED;
	106
	107	/*
	108	* Used to return command code for command not needing special data.
	109	*/
	110	struct lttcomm_relayd_generic_reply {
	111	uint32_t ret_code;
	112	} LTTNG_PACKED;
	113
	114	/*
	115	* Version command.
	116	*/
	117	struct lttcomm_relayd_version {
	118	uint32_t major;
	119	uint32_t minor;
	120	} LTTNG_PACKED;
	121
	122	/*
	123	* Metadata payload used when metadata command is sent.
	124	*/
	125	struct lttcomm_relayd_metadata_payload {
	126	uint64_t stream_id;
	127	uint32_t padding_size;
	128	char payload[];
	129	} LTTNG_PACKED;
	130
	131	/*
	132	* Used to indicate that a specific stream id can now be closed.
	133	*/
	134	struct lttcomm_relayd_close_stream {
	135	uint64_t stream_id;
	136	uint64_t last_net_seq_num; /* sequence number of last packet */
	137	} LTTNG_PACKED;
	138
	139	/*
	140	* Used to test if for a given stream id the data is pending on the relayd side
	141	* for reading.
	142	*/
	143	struct lttcomm_relayd_data_pending {
	144	uint64_t stream_id;
	145	uint64_t last_net_seq_num; /* Sequence number of the last packet */
	146	} LTTNG_PACKED;
	147
	148	struct lttcomm_relayd_begin_data_pending {
	149	uint64_t session_id;
	150	} LTTNG_PACKED;
	151
	152	struct lttcomm_relayd_end_data_pending {
	153	uint64_t session_id;
	154	} LTTNG_PACKED;
	155
	156	struct lttcomm_relayd_quiescent_control {
	157	uint64_t stream_id;
	158	} LTTNG_PACKED;
	159
	160	/*
	161	* Index data.
	162	*/
	163	struct lttcomm_relayd_index {
	164	uint64_t relay_stream_id;
	165	uint64_t net_seq_num;
	166	uint64_t packet_size;
	167	uint64_t content_size;
	168	uint64_t timestamp_begin;
	169	uint64_t timestamp_end;
	170	uint64_t events_discarded;
	171	uint64_t stream_id;
	172	/* 2.8+ */
	173	uint64_t stream_instance_id;
	174	uint64_t packet_seq_num;
	175	} LTTNG_PACKED;
	176
	177	static inline size_t lttcomm_relayd_index_len(uint32_t major, uint32_t minor)
	178	{
	179	if (major == 1) {
	180	switch (minor) {
	181	case 0:
	182	return offsetof(struct lttcomm_relayd_index, stream_id)
	183	+ member_sizeof(struct lttcomm_relayd_index,
	184	stream_id);
	185	case 1:
	186	return offsetof(struct lttcomm_relayd_index, packet_seq_num)
	187	+ member_sizeof(struct lttcomm_relayd_index,
	188	packet_seq_num);
	189	default:
	190	abort();
	191	}
	192	}
	193	abort();
	194	}
	195
	196	/*
	197	* Create session in 2.4 adds additionnal parameters for live reading.
	198	*/
	199	struct lttcomm_relayd_create_session_2_4 {
	200	char session_name[RELAYD_COMM_LTTNG_NAME_MAX_2_4];
	201	char hostname[RELAYD_COMM_LTTNG_HOST_NAME_MAX_2_4];
	202	uint32_t live_timer;
	203	uint32_t snapshot;
	204	} LTTNG_PACKED;
	205
	206	struct lttcomm_relayd_create_session_2_11 {
	207	uint32_t session_name_len;
	208	uint32_t hostname_len;
	209	/* Optional, set to 0 to indicate it is not user-specified. */
	210	uint32_t base_path_len;
	211	uint32_t live_timer;
	212	uint8_t snapshot;
	213	uint8_t session_name_contains_creation_time;
	214	/* Sessiond instance UUID */
	215	lttng_uuid sessiond_uuid;
	216	/* Sessiond session id */
	217	uint64_t session_id;
	218	/* Session creation time, in seconds since UNIX Epoch. */
	219	uint64_t creation_time;
	220	LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED current_chunk_id;
	221	/* Contains the session_name, hostname, base_path. */
	222	char names[];
	223	} LTTNG_PACKED;
	224
	225	struct lttcomm_relayd_create_session_reply_2_11 {
	226	struct lttcomm_relayd_status_session generic;
	227	/* Includes the '\0' terminator. */
	228	uint32_t output_path_length;
	229	char output_path[];
	230	} LTTNG_PACKED;
	231
	232	/*
	233	* Used to ask the relay to reset the metadata trace file (regeneration).
	234	* Send the new version of the metadata (starts at 0).
	235	*/
	236	struct lttcomm_relayd_reset_metadata {
	237	uint64_t stream_id;
	238	uint64_t version;
	239	} LTTNG_PACKED;
	240
	241	struct lttcomm_relayd_stream_rotation_position {
	242	uint64_t stream_id;
	243	/*
	244	* Sequence number of the first packet belonging to the new
	245	* "destination" trace chunk to which the stream is rotating.
	246	*
	247	* Ignored for metadata streams.
	248	*/
	249	uint64_t rotate_at_seq_num;
	250	} LTTNG_PACKED;
	251
	252	struct lttcomm_relayd_rotate_streams {
	253	uint32_t stream_count;
	254	/*
	255	* Streams can be rotated outside of a chunk but not be parented to
	256	* a new chunk.
	257	*/
	258	LTTNG_OPTIONAL_COMM(uint64_t) new_chunk_id;
	259	/* `stream_count` positions follow. */
	260	struct lttcomm_relayd_stream_rotation_position rotation_positions[];
	261	} LTTNG_PACKED;
	262
	263	struct lttcomm_relayd_create_trace_chunk {
	264	uint64_t chunk_id;
	265	/* Seconds since EPOCH. */
	266	uint64_t creation_timestamp;
	267	/* Includes trailing NULL. */
	268	uint32_t override_name_length;
	269	char override_name[];
	270	} LTTNG_PACKED;
	271
	272	struct lttcomm_relayd_close_trace_chunk {
	273	uint64_t chunk_id;
	274	/* Seconds since EPOCH. */
	275	uint64_t close_timestamp;
	276	/* enum lttng_trace_chunk_command_type */
	277	LTTNG_OPTIONAL_COMM(uint32_t) LTTNG_PACKED close_command;
	278	} LTTNG_PACKED;
	279
	280	struct lttcomm_relayd_close_trace_chunk_reply {
	281	struct lttcomm_relayd_generic_reply generic;
	282	/* Includes trailing NULL. */
	283	uint32_t path_length;
	284	char path[];
	285	} LTTNG_PACKED;
	286
	287	struct lttcomm_relayd_trace_chunk_exists {
	288	uint64_t chunk_id;
	289	} LTTNG_PACKED;
	290
	291	struct lttcomm_relayd_trace_chunk_exists_reply {
	292	struct lttcomm_relayd_generic_reply generic;
	293	uint8_t trace_chunk_exists;
	294	} LTTNG_PACKED;
	295
	296	#endif /* _RELAYD_COMM */