[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/compat/uuid.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;
	/* Sessiond instance UUID */
	lttng_uuid sessiond_uuid;
	/* Sessiond session id */
        uint64_t session_id;
	/* 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;

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