[lttng-tools.git] / src / bin / lttng-relayd / lttng-viewer.h

/*
 * Copyright (C) 2013 - Julien Desfossez <jdesfossez@efficios.com>
 *                      Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *                      David Goulet <dgoulet@efficios.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#ifndef LTTNG_VIEWER_H
#define LTTNG_VIEWER_H

#include <limits.h>

#define LTTNG_VIEWER_PATH_MAX		4096
#define LTTNG_VIEWER_NAME_MAX		255
#define LTTNG_VIEWER_HOST_NAME_MAX	64

/* Flags in reply to get_next_index and get_packet. */
/* New metadata is required to read this packet. */
#define LTTNG_VIEWER_FLAG_NEW_METADATA	(1 << 0)
/* New stream got added to the trace */
#define LTTNG_VIEWER_FLAG_NEW_STREAM	(1 << 1)

enum lttng_viewer_command {
	VIEWER_CONNECT		= 1,
	VIEWER_LIST_SESSIONS	= 2,
	VIEWER_ATTACH_SESSION	= 3,
	VIEWER_GET_NEXT_INDEX	= 4,
	VIEWER_GET_PACKET	= 5,
	VIEWER_GET_METADATA	= 6,
};

enum lttng_viewer_attach_return_code {
	VIEWER_ATTACH_OK	= 1, /* If the attach command succeeded. */
	VIEWER_ATTACH_ALREADY	= 2, /* If a viewer is already attached. */
	VIEWER_ATTACH_UNK	= 3, /* If the session ID is unknown. */
	VIEWER_ATTACH_NOT_LIVE	= 4, /* If the session is not live. */
	VIEWER_ATTACH_SEEK_ERR	= 5, /* Seek error. */
};

enum lttng_viewer_next_index_return_code {
	VIEWER_INDEX_OK		= 1, /* Index is available. */
	VIEWER_INDEX_RETRY	= 2, /* Index not yet available. */
	VIEWER_INDEX_HUP	= 3, /* Index closed (trace destroyed). */
	VIEWER_INDEX_ERR	= 4, /* Unknow error. */
	VIEWER_INDEX_INACTIVE	= 5, /* Inactive stream beacon. */
};

enum lttng_viewer_get_packet_return_code {
	VIEWER_GET_PACKET_OK		= 1,
	VIEWER_GET_PACKET_RETRY		= 2,
	VIEWER_GET_PACKET_ERR		= 3,
};

enum lttng_viewer_get_metadata_return_code {
	VIEWER_METADATA_OK	= 1,
	VIEWER_NO_NEW_METADATA	= 2,
	VIEWER_METADATA_ERR	= 3,
};

enum lttng_viewer_connection_type {
	VIEWER_CLIENT_COMMAND		= 1,
	VIEWER_CLIENT_NOTIFICATION	= 2,
};

enum lttng_viewer_seek {
	VIEWER_SEEK_BEGINNING	= 1,	/* Receive the trace packets from the beginning. */
	VIEWER_SEEK_LAST	= 2,	/* Receive the trace packets from now. */
};

struct lttng_viewer_session {
	uint64_t id;
	char hostname[LTTNG_VIEWER_HOST_NAME_MAX];
	char session_name[LTTNG_VIEWER_NAME_MAX];
	uint32_t live_timer;
	uint32_t clients;
	uint32_t streams;
} __attribute__((__packed__));

struct lttng_viewer_stream {
	uint64_t id;
	uint64_t ctf_trace_id;
	char path_name[LTTNG_VIEWER_PATH_MAX];
	char channel_name[LTTNG_VIEWER_NAME_MAX];
	int metadata_flag;
} __attribute__((__packed__));

struct lttng_viewer_cmd {
	uint64_t data_size;	/* data size following this header */
	uint32_t cmd;		/* enum lttcomm_relayd_command */
	uint32_t cmd_version;	/* command version */
} __attribute__((__packed__));

/*
 * CONNECT payload.
 */
struct lttng_viewer_connect {
	uint32_t major;
	uint32_t minor;
	uint32_t type; /* enum lttng_viewer_connection_type */
	uint64_t viewer_session_id; /* session ID assigned by the relay for command connections */
} __attribute__((__packed__));

/*
 * VIEWER_LIST_SESSIONS payload.
 */
struct lttng_viewer_list_sessions {
	uint32_t sessions_count;
	char session_list[];		/* struct lttng_viewer_session */
} __attribute__((__packed__));

/*
 * VIEWER_ATTACH_SESSION payload.
 */
struct lttng_viewer_attach_session_request {
	uint64_t session_id;
	uint32_t seek;		/* enum lttng_viewer_seek */
	uint64_t offset;	/* unused for now */
} __attribute__((__packed__));

struct lttng_viewer_attach_session_response {
	uint32_t status;		/* enum lttng_viewer_attach_return_code */
	uint32_t streams_count;
	char stream_list[];		/* struct lttng_viewer_stream */
} __attribute__((__packed__));

/*
 * VIEWER_GET_NEXT_INDEX payload.
 */
struct lttng_viewer_get_next_index {
	uint64_t stream_id;
} __attribute__ ((__packed__));

struct lttng_viewer_index {
	uint32_t status;	/* enum lttng_viewer_next_index_return_code */
	uint64_t offset;
	uint64_t packet_size;
	uint64_t content_size;
	uint64_t timestamp_begin;
	uint64_t timestamp_end;
	uint64_t events_discarded;
	uint64_t stream_id;
	uint32_t flags;	/* LTTNG_VIEWER_FLAG_* */
} __attribute__ ((__packed__));

/*
 * VIEWER_GET_PACKET payload.
 */
struct lttng_viewer_get_packet {
	uint64_t stream_id;
	uint64_t offset;
	uint32_t len;
} __attribute__((__packed__));

struct lttng_viewer_trace_packet {
	uint32_t status;		/* enum lttng_viewer_get_packet_return_code */
	uint32_t len;
	uint32_t flags;	/* LTTNG_VIEWER_FLAG_* */
	char data[];
} __attribute__((__packed__));

/*
 * VIEWER_GET_METADATA payload.
 */
struct lttng_viewer_get_metadata {
	uint64_t stream_id;
} __attribute__((__packed__));

struct lttng_viewer_metadata_packet {
	uint32_t status;		/* enum lttng_viewer_get_metadata_return_code */
	uint64_t len;
	char data[];
} __attribute__((__packed__));

#endif /* LTTNG_VIEWER_H */
Commit	Line	Data
d3e2ba59 JD	1	/*
d3e2ba59 JD	2	* Copyright (C) 2013 - Julien Desfossez <jdesfossez@efficios.com>
c404302f	3	* Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
d3e2ba59 JD	4	* David Goulet <dgoulet@efficios.com>
d3e2ba59 JD	5	*
c404302f JD	6	* Permission is hereby granted, free of charge, to any person obtaining a copy
	7	* of this software and associated documentation files (the "Software"), to deal
	8	* in the Software without restriction, including without limitation the rights
	9	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	10	* copies of the Software, and to permit persons to whom the Software is
	11	* furnished to do so, subject to the following conditions:
d3e2ba59	12	*
c404302f JD	13	* The above copyright notice and this permission notice shall be included in
c404302f JD	14	* all copies or substantial portions of the Software.
d3e2ba59	15	*
c404302f JD	16	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	17	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	18	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	19	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	20	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	21	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	22	* SOFTWARE.
d3e2ba59 JD	23	*/
	24
	25	#ifndef LTTNG_VIEWER_H
	26	#define LTTNG_VIEWER_H
	27
	28	#include <limits.h>
	29
	30	#define LTTNG_VIEWER_PATH_MAX 4096
	31	#define LTTNG_VIEWER_NAME_MAX 255
	32	#define LTTNG_VIEWER_HOST_NAME_MAX 64
	33
	34	/* Flags in reply to get_next_index and get_packet. */
	35	/* New metadata is required to read this packet. */
	36	#define LTTNG_VIEWER_FLAG_NEW_METADATA (1 << 0)
	37	/* New stream got added to the trace */
	38	#define LTTNG_VIEWER_FLAG_NEW_STREAM (1 << 1)
	39
	40	enum lttng_viewer_command {
	41	VIEWER_CONNECT = 1,
	42	VIEWER_LIST_SESSIONS = 2,
	43	VIEWER_ATTACH_SESSION = 3,
	44	VIEWER_GET_NEXT_INDEX = 4,
	45	VIEWER_GET_PACKET = 5,
	46	VIEWER_GET_METADATA = 6,
	47	};
	48
	49	enum lttng_viewer_attach_return_code {
	50	VIEWER_ATTACH_OK = 1, /* If the attach command succeeded. */
	51	VIEWER_ATTACH_ALREADY = 2, /* If a viewer is already attached. */
	52	VIEWER_ATTACH_UNK = 3, /* If the session ID is unknown. */
	53	VIEWER_ATTACH_NOT_LIVE = 4, /* If the session is not live. */
	54	VIEWER_ATTACH_SEEK_ERR = 5, /* Seek error. */
	55	};
	56
	57	enum lttng_viewer_next_index_return_code {
	58	VIEWER_INDEX_OK = 1, /* Index is available. */
	59	VIEWER_INDEX_RETRY = 2, /* Index not yet available. */
	60	VIEWER_INDEX_HUP = 3, /* Index closed (trace destroyed). */
	61	VIEWER_INDEX_ERR = 4, /* Unknow error. */
	62	VIEWER_INDEX_INACTIVE = 5, /* Inactive stream beacon. */
	63	};
	64
	65	enum lttng_viewer_get_packet_return_code {
	66	VIEWER_GET_PACKET_OK = 1,
	67	VIEWER_GET_PACKET_RETRY = 2,
	68	VIEWER_GET_PACKET_ERR = 3,
	69	};
	70
	71	enum lttng_viewer_get_metadata_return_code {
	72	VIEWER_METADATA_OK = 1,
	73	VIEWER_NO_NEW_METADATA = 2,
	74	VIEWER_METADATA_ERR = 3,
	75	};
	76
	77	enum lttng_viewer_connection_type {
	78	VIEWER_CLIENT_COMMAND = 1,
	79	VIEWER_CLIENT_NOTIFICATION = 2,
	80	};
	81
	82	enum lttng_viewer_seek {
	83	VIEWER_SEEK_BEGINNING = 1, /* Receive the trace packets from the beginning. */
	84	VIEWER_SEEK_LAST = 2, /* Receive the trace packets from now. */
	85	};
	86
87	struct lttng_viewer_session {
88	uint64_t id;
89	char hostname[LTTNG_VIEWER_HOST_NAME_MAX];
90	char session_name[LTTNG_VIEWER_NAME_MAX];
91	uint32_t live_timer;
92	uint32_t clients;
87b576ec	93	uint32_t streams;
d3e2ba59 JD	94	} __attribute__((__packed__));
	95
	96	struct lttng_viewer_stream {
	97	uint64_t id;
	98	uint64_t ctf_trace_id;
	99	char path_name[LTTNG_VIEWER_PATH_MAX];
	100	char channel_name[LTTNG_VIEWER_NAME_MAX];
	101	int metadata_flag;
	102	} __attribute__((__packed__));
	103
	104	struct lttng_viewer_cmd {
	105	uint64_t data_size; /* data size following this header */
	106	uint32_t cmd; /* enum lttcomm_relayd_command */
	107	uint32_t cmd_version; /* command version */
	108	} __attribute__((__packed__));
	109
	110	/*
	111	* CONNECT payload.
	112	*/
	113	struct lttng_viewer_connect {
	114	uint32_t major;
	115	uint32_t minor;
	116	uint32_t type; /* enum lttng_viewer_connection_type */
	117	uint64_t viewer_session_id; /* session ID assigned by the relay for command connections */
	118	} __attribute__((__packed__));
	119
	120	/*
	121	* VIEWER_LIST_SESSIONS payload.
	122	*/
	123	struct lttng_viewer_list_sessions {
	124	uint32_t sessions_count;
	125	char session_list[]; /* struct lttng_viewer_session */
	126	} __attribute__((__packed__));
	127
	128	/*
	129	* VIEWER_ATTACH_SESSION payload.
	130	*/
	131	struct lttng_viewer_attach_session_request {
	132	uint64_t session_id;
	133	uint32_t seek; /* enum lttng_viewer_seek */
	134	uint64_t offset; /* unused for now */
	135	} __attribute__((__packed__));
	136
	137	struct lttng_viewer_attach_session_response {
	138	uint32_t status; /* enum lttng_viewer_attach_return_code */
	139	uint32_t streams_count;
	140	char stream_list[]; /* struct lttng_viewer_stream */
	141	} __attribute__((__packed__));
	142
	143	/*
	144	* VIEWER_GET_NEXT_INDEX payload.
	145	*/
	146	struct lttng_viewer_get_next_index {
	147	uint64_t stream_id;
	148	} __attribute__ ((__packed__));
	149
	150	struct lttng_viewer_index {
	151	uint32_t status; /* enum lttng_viewer_next_index_return_code */
	152	uint64_t offset;
	153	uint64_t packet_size;
	154	uint64_t content_size;
	155	uint64_t timestamp_begin;
	156	uint64_t timestamp_end;
	157	uint64_t events_discarded;
158	uint64_t stream_id;
159	uint32_t flags; /* LTTNG_VIEWER_FLAG_* */
160	} __attribute__ ((__packed__));
161
162	/*
163	* VIEWER_GET_PACKET payload.
164	*/
165	struct lttng_viewer_get_packet {
166	uint64_t stream_id;
167	uint64_t offset;
168	uint32_t len;
169	} __attribute__((__packed__));
170
171	struct lttng_viewer_trace_packet {
172	uint32_t status; /* enum lttng_viewer_get_packet_return_code */
173	uint32_t len;
174	uint32_t flags; /* LTTNG_VIEWER_FLAG_* */
175	char data[];
176	} __attribute__((__packed__));
177
178	/*
179	* VIEWER_GET_METADATA payload.
180	*/
181	struct lttng_viewer_get_metadata {
182	uint64_t stream_id;
183	} __attribute__((__packed__));
184
185	struct lttng_viewer_metadata_packet {
186	uint32_t status; /* enum lttng_viewer_get_metadata_return_code */
187	uint64_t len;
188	char data[];
189	} __attribute__((__packed__));
190
191	#endif /* LTTNG_VIEWER_H */