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

#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_archive_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;
	uint32_t live_timer;
	uint8_t snapshot;
	/* Contains the session_name and hostname */
	char names[];
} 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_rotate_stream {
	uint64_t stream_id;
	/* Ignored for metadata streams. */
	uint64_t rotate_at_seq_num;
	uint64_t new_chunk_id;
	/* Includes trailing NULL. */
	uint32_t pathname_length;
	/* Must be the last member of this structure. */
	char new_pathname[];
} LTTNG_PACKED;

struct lttcomm_relayd_rotate_rename {
	uint32_t old_path_length;
	uint32_t new_path_length;
	/* Concatenation of the old and new paths, separated by \0. */
	char paths[];
} LTTNG_PACKED;

struct lttcomm_relayd_rotate_pending {
	uint64_t chunk_id;
} LTTNG_PACKED;

struct lttcomm_relayd_rotate_pending_reply {
	struct lttcomm_relayd_generic_reply generic;
	/* Valid values are [0, 1]. */
	uint8_t is_pending;
} LTTNG_PACKED;

struct lttcomm_relayd_mkdir {
	/* Includes trailing NULL */
	uint32_t length;
	char path[];
} LTTNG_PACKED;

#endif	/* _RELAYD_COMM */
Commit	Line	Data
b8aa1682 JD	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
b8aa1682 JD	22	#include <limits.h>
	23	#include <stdint.h>
	24
	25	#include <lttng/lttng.h>
ce2a9e76	26	#include <common/defaults.h>
50adc264	27	#include <common/index/ctf-index.h>
b8aa1682	28
6947778e MD	29	#define RELAYD_VERSION_COMM_MAJOR VERSION_MAJOR
6947778e MD	30	#define RELAYD_VERSION_COMM_MINOR VERSION_MINOR
0a6b5085	31
1c17e424 JR	32	#define RELAYD_COMM_LTTNG_HOST_NAME_MAX_2_4 64
	33	#define RELAYD_COMM_LTTNG_NAME_MAX_2_4 255
	34	#define RELAYD_COMM_LTTNG_PATH_MAX 4096
	35	#define RELAYD_COMM_DEFAULT_STREAM_NAME_LEN 264 /* 256 + 8 */
	36
b8aa1682 JD	37	/*
	38	* lttng-relayd communication header.
	39	*/
	40	struct lttcomm_relayd_hdr {
	41	/* Circuit ID not used for now so always ignored */
	42	uint64_t circuit_id;
	43	uint64_t data_size; /* data size following this header */
7c9534d6	44	uint32_t cmd; /* enum lttcomm_relayd_command */
b8aa1682	45	uint32_t cmd_version; /* command version */
a9e87764	46	} LTTNG_PACKED;
b8aa1682 JD	47
	48	/*
	49	* lttng-relayd data header.
	50	*/
	51	struct lttcomm_relayd_data_hdr {
	52	/* Circuit ID not used for now so always ignored */
	53	uint64_t circuit_id;
	54	uint64_t stream_id; /* Stream ID known by the relayd */
173af62f	55	uint64_t net_seq_num; /* Network sequence number, per stream. */
b8aa1682	56	uint32_t data_size; /* data size following this header */
1d4dfdef	57	uint32_t padding_size; /* Size of 0 padding the data */
a9e87764	58	} LTTNG_PACKED;
b8aa1682	59
c5b6f4f0 DG	60	/*
	61	* Reply from a create session command.
	62	*/
	63	struct lttcomm_relayd_status_session {
	64	uint64_t session_id;
	65	uint32_t ret_code;
a9e87764	66	} LTTNG_PACKED;
c5b6f4f0	67
b8aa1682 JD	68	/*
	69	* Used to add a stream on the relay daemon.
	70	*/
	71	struct lttcomm_relayd_add_stream {
1c17e424 JR	72	char channel_name[RELAYD_COMM_DEFAULT_STREAM_NAME_LEN];
1c17e424 JR	73	char pathname[RELAYD_COMM_LTTNG_PATH_MAX];
a9e87764	74	} LTTNG_PACKED;
b8aa1682	75
0f907de1 JD	76	/*
	77	* Used to add a stream on the relay daemon.
	78	* Protocol version 2.2
	79	*/
	80	struct lttcomm_relayd_add_stream_2_2 {
1c17e424 JR	81	char channel_name[RELAYD_COMM_DEFAULT_STREAM_NAME_LEN];
1c17e424 JR	82	char pathname[RELAYD_COMM_LTTNG_PATH_MAX];
0f907de1 JD	83	uint64_t tracefile_size;
	84	uint64_t tracefile_count;
	85	} LTTNG_PACKED;
	86
2f21a469 JR	87	struct lttcomm_relayd_add_stream_2_11 {
	88	uint32_t channel_name_len;
	89	uint32_t pathname_len;
	90	uint64_t tracefile_size;
	91	uint64_t tracefile_count;
0b50e4b3	92	uint64_t trace_archive_id;
2f21a469 JR	93	char names[];
	94	} LTTNG_PACKED;
	95
b8aa1682 JD	96	/*
	97	* Answer from an add stream command.
	98	*/
	99	struct lttcomm_relayd_status_stream {
	100	uint64_t handle;
	101	uint32_t ret_code;
a9e87764	102	} LTTNG_PACKED;
b8aa1682 JD	103
	104	/*
	105	* Used to return command code for command not needing special data.
	106	*/
	107	struct lttcomm_relayd_generic_reply {
	108	uint32_t ret_code;
a9e87764	109	} LTTNG_PACKED;
b8aa1682	110
b8aa1682 JD	111	/*
	112	* Version command.
	113	*/
	114	struct lttcomm_relayd_version {
	115	uint32_t major;
	116	uint32_t minor;
a9e87764	117	} LTTNG_PACKED;
b8aa1682 JD	118
	119	/*
	120	* Metadata payload used when metadata command is sent.
	121	*/
	122	struct lttcomm_relayd_metadata_payload {
	123	uint64_t stream_id;
1d4dfdef	124	uint32_t padding_size;
b8aa1682	125	char payload[];
a9e87764	126	} LTTNG_PACKED;
b8aa1682	127
173af62f DG	128	/*
	129	* Used to indicate that a specific stream id can now be closed.
	130	*/
	131	struct lttcomm_relayd_close_stream {
	132	uint64_t stream_id;
	133	uint64_t last_net_seq_num; /* sequence number of last packet */
a9e87764	134	} LTTNG_PACKED;
173af62f	135
c8f59ee5	136	/*
6d805429 DG	137	* Used to test if for a given stream id the data is pending on the relayd side
6d805429 DG	138	* for reading.
c8f59ee5	139	*/
6d805429	140	struct lttcomm_relayd_data_pending {
c8f59ee5 DG	141	uint64_t stream_id;
c8f59ee5 DG	142	uint64_t last_net_seq_num; /* Sequence number of the last packet */
a9e87764	143	} LTTNG_PACKED;
c8f59ee5	144
f7079f67 DG	145	struct lttcomm_relayd_begin_data_pending {
f7079f67 DG	146	uint64_t session_id;
a9e87764	147	} LTTNG_PACKED;
f7079f67 DG	148
	149	struct lttcomm_relayd_end_data_pending {
	150	uint64_t session_id;
a9e87764	151	} LTTNG_PACKED;
f7079f67	152
ad7051c0 DG	153	struct lttcomm_relayd_quiescent_control {
	154	uint64_t stream_id;
	155	} LTTNG_PACKED;
	156
1c20f0e2 JD	157	/*
	158	* Index data.
	159	*/
	160	struct lttcomm_relayd_index {
	161	uint64_t relay_stream_id;
	162	uint64_t net_seq_num;
	163	uint64_t packet_size;
	164	uint64_t content_size;
	165	uint64_t timestamp_begin;
	166	uint64_t timestamp_end;
	167	uint64_t events_discarded;
	168	uint64_t stream_id;
f8f3885c	169	/* 2.8+ */
234cd636 JD	170	uint64_t stream_instance_id;
234cd636 JD	171	uint64_t packet_seq_num;
1c20f0e2 JD	172	} LTTNG_PACKED;
1c20f0e2 JD	173
f8f3885c MD	174	static inline size_t lttcomm_relayd_index_len(uint32_t major, uint32_t minor)
	175	{
	176	if (major == 1) {
	177	switch (minor) {
	178	case 0:
	179	return offsetof(struct lttcomm_relayd_index, stream_id)
	180	+ member_sizeof(struct lttcomm_relayd_index,
	181	stream_id);
	182	case 1:
	183	return offsetof(struct lttcomm_relayd_index, packet_seq_num)
	184	+ member_sizeof(struct lttcomm_relayd_index,
	185	packet_seq_num);
	186	default:
	187	abort();
	188	}
	189	}
	190	abort();
	191	}
	192
d3e2ba59 JD	193	/*
	194	* Create session in 2.4 adds additionnal parameters for live reading.
	195	*/
	196	struct lttcomm_relayd_create_session_2_4 {
1c17e424 JR	197	char session_name[RELAYD_COMM_LTTNG_NAME_MAX_2_4];
1c17e424 JR	198	char hostname[RELAYD_COMM_LTTNG_HOST_NAME_MAX_2_4];
d3e2ba59	199	uint32_t live_timer;
7d2f7452	200	uint32_t snapshot;
d3e2ba59 JD	201	} LTTNG_PACKED;
d3e2ba59 JD	202
f86f6389 JR	203	struct lttcomm_relayd_create_session_2_11 {
	204	uint32_t session_name_len;
	205	uint32_t hostname_len;
	206	uint32_t live_timer;
	207	uint8_t snapshot;
	208	/* Contains the session_name and hostname */
	209	char names[];
	210	} LTTNG_PACKED;
	211
93ec662e JD	212	/*
	213	* Used to ask the relay to reset the metadata trace file (regeneration).
	214	* Send the new version of the metadata (starts at 0).
	215	*/
	216	struct lttcomm_relayd_reset_metadata {
	217	uint64_t stream_id;
	218	uint64_t version;
	219	} LTTNG_PACKED;
	220
d3ecc550 JD	221	struct lttcomm_relayd_rotate_stream {
d3ecc550 JD	222	uint64_t stream_id;
d73bf3d7	223	/* Ignored for metadata streams. */
d3ecc550 JD	224	uint64_t rotate_at_seq_num;
	225	uint64_t new_chunk_id;
	226	/* Includes trailing NULL. */
	227	uint32_t pathname_length;
	228	/* Must be the last member of this structure. */
	229	char new_pathname[];
	230	} LTTNG_PACKED;
	231
00fb02ac JD	232	struct lttcomm_relayd_rotate_rename {
	233	uint32_t old_path_length;
	234	uint32_t new_path_length;
	235	/* Concatenation of the old and new paths, separated by \0. */
	236	char paths[];
	237	} LTTNG_PACKED;
	238
e2acc8d2 JD	239	struct lttcomm_relayd_rotate_pending {
	240	uint64_t chunk_id;
	241	} LTTNG_PACKED;
	242
d88744a4 JD	243	struct lttcomm_relayd_rotate_pending_reply {
	244	struct lttcomm_relayd_generic_reply generic;
	245	/* Valid values are [0, 1]. */
	246	uint8_t is_pending;
	247	} LTTNG_PACKED;
	248
a1ae2ea5 JD	249	struct lttcomm_relayd_mkdir {
	250	/* Includes trailing NULL */
	251	uint32_t length;
	252	char path[];
	253	} LTTNG_PACKED;
	254
b8aa1682	255	#endif /* _RELAYD_COMM */