[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

#define _GNU_SOURCE

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

#include <lttng/lttng.h>

#define RELAYD_VERSION_COMM_MAJOR             2
#define RELAYD_VERSION_COMM_MINOR             1

/*
 * 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_sessiond_command */
	uint32_t cmd_version;	/* command version */
} __attribute__ ((__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 */
} __attribute__ ((__packed__));

/*
 * Used to add a stream on the relay daemon.
 */
struct lttcomm_relayd_add_stream {
	char channel_name[LTTNG_SYMBOL_NAME_LEN];
	char pathname[PATH_MAX];
} __attribute__ ((__packed__));

/*
 * Answer from an add stream command.
 */
struct lttcomm_relayd_status_stream {
	uint64_t handle;
	uint32_t ret_code;
} __attribute__ ((__packed__));

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

/*
 * Used to update synchronization information.
 */
struct lttcomm_relayd_update_sync_info {
	/* TODO: fill the structure. Feature not implemented yet */
} __attribute__ ((__packed__));

/*
 * Version command.
 */
struct lttcomm_relayd_version {
	uint32_t major;
	uint32_t minor;
} __attribute__ ((__packed__));

/*
 * Metadata payload used when metadata command is sent.
 */
struct lttcomm_relayd_metadata_payload {
	uint64_t stream_id;
	char payload[];
} __attribute__ ((__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 */
} __attribute__ ((__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	#define _GNU_SOURCE
	23
	24	#include <limits.h>
	25	#include <stdint.h>
	26
	27	#include <lttng/lttng.h>
	28
	29	#define RELAYD_VERSION_COMM_MAJOR 2
	30	#define RELAYD_VERSION_COMM_MINOR 1
	31
	32	/*
	33	* lttng-relayd communication header.
	34	*/
	35	struct lttcomm_relayd_hdr {
	36	/* Circuit ID not used for now so always ignored */
	37	uint64_t circuit_id;
	38	uint64_t data_size; /* data size following this header */
	39	uint32_t cmd; /* enum lttcomm_sessiond_command */
	40	uint32_t cmd_version; /* command version */
	41	} __attribute__ ((__packed__));
	42
	43	/*
	44	* lttng-relayd data header.
	45	*/
	46	struct lttcomm_relayd_data_hdr {
	47	/* Circuit ID not used for now so always ignored */
	48	uint64_t circuit_id;
	49	uint64_t stream_id; /* Stream ID known by the relayd */
	50	uint64_t net_seq_num; /* Network sequence number, per stream. */
	51	uint32_t data_size; /* data size following this header */
	52	} __attribute__ ((__packed__));
	53
	54	/*
	55	* Used to add a stream on the relay daemon.
	56	*/
	57	struct lttcomm_relayd_add_stream {
	58	char channel_name[LTTNG_SYMBOL_NAME_LEN];
	59	char pathname[PATH_MAX];
	60	} __attribute__ ((__packed__));
	61
	62	/*
	63	* Answer from an add stream command.
	64	*/
	65	struct lttcomm_relayd_status_stream {
	66	uint64_t handle;
	67	uint32_t ret_code;
	68	} __attribute__ ((__packed__));
	69
	70	/*
	71	* Used to return command code for command not needing special data.
	72	*/
	73	struct lttcomm_relayd_generic_reply {
	74	uint32_t ret_code;
	75	} __attribute__ ((__packed__));
	76
	77	/*
	78	* Used to update synchronization information.
	79	*/
	80	struct lttcomm_relayd_update_sync_info {
	81	/* TODO: fill the structure. Feature not implemented yet */
	82	} __attribute__ ((__packed__));
	83
	84	/*
	85	* Version command.
	86	*/
	87	struct lttcomm_relayd_version {
	88	uint32_t major;
	89	uint32_t minor;
	90	} __attribute__ ((__packed__));
	91
	92	/*
	93	* Metadata payload used when metadata command is sent.
	94	*/
	95	struct lttcomm_relayd_metadata_payload {
	96	uint64_t stream_id;
	97	char payload[];
	98	} __attribute__ ((__packed__));
	99
	100	/*
	101	* Used to indicate that a specific stream id can now be closed.
	102	*/
	103	struct lttcomm_relayd_close_stream {
	104	uint64_t stream_id;
	105	uint64_t last_net_seq_num; /* sequence number of last packet */
	106	} __attribute__ ((__packed__));
	107
	108	#endif /* _RELAYD_COMM */