[babeltrace.git] / formats / lttng-live / lttng-live.h

#ifndef _LTTNG_LIVE_H
#define _LTTNG_LIVE_H

/*
 * Copyright 2013 Julien Desfossez <julien.desfossez@efficios.com>
 *                Mathieu Desnoyers <mathieu.desnoyers@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.
 */

#include <stdint.h>
#include "lttng-viewer-abi.h"

#define LTTNG_DEFAULT_NETWORK_VIEWER_PORT	5344

#define LTTNG_LIVE_MAJOR			2
#define LTTNG_LIVE_MINOR			4

/*
 * The lttng-live output file pointer is currently hardcoded to stdout,
 * and is expected to be hardcoded to this by fflush() performed between
 * each packet.
 */
#define LTTNG_LIVE_OUTPUT_FP			stdout

struct lttng_live_ctx {
	char traced_hostname[MAXNAMLEN];
	char session_name[MAXNAMLEN];
	char relay_hostname[MAXNAMLEN];
	int control_sock;
	int port;
	/* Protocol version to use for this connection. */
	uint32_t major;
	uint32_t minor;
	struct lttng_live_session *session;
	struct bt_context *bt_ctx;
	GArray *session_ids;
};

struct lttng_live_viewer_stream {
	uint64_t id;
	uint64_t mmap_size;
	uint64_t ctf_stream_id;
	FILE *metadata_fp_write;
	ssize_t metadata_len;
	int metadata_flag;
	int data_pending;
	struct lttng_live_session *session;
	struct lttng_live_ctf_trace *ctf_trace;
	struct lttng_viewer_index current_index;
	char path[PATH_MAX];
};

struct lttng_live_session {
	uint64_t live_timer_interval;
	uint64_t stream_count;
	struct lttng_live_ctx *ctx;
	struct lttng_live_viewer_stream *streams;
	/* HashTable mapping trace_ids to ptrs to struct lttng_live_ctf_trace */
	GHashTable *ctf_traces;
};

struct lttng_live_ctf_trace {
	uint64_t ctf_trace_id;
	struct lttng_live_viewer_stream *metadata_stream;
	GPtrArray *streams;
	FILE *metadata_fp;
	struct bt_trace_handle *handle;
	int trace_id;
	int in_use;
};

/* Just used in listing. */
struct lttng_live_relay_session {
	uint32_t streams;
	uint32_t clients;
	uint32_t timer;
	char *name;
	char *hostname;
};

int lttng_live_connect_viewer(struct lttng_live_ctx *ctx);
int lttng_live_establish_connection(struct lttng_live_ctx *ctx);
int lttng_live_list_sessions(struct lttng_live_ctx *ctx, const char *path);
int lttng_live_attach_session(struct lttng_live_ctx *ctx, uint64_t id);
int lttng_live_read(struct lttng_live_ctx *ctx);
int lttng_live_get_new_streams(struct lttng_live_ctx *ctx, uint64_t id);
int lttng_live_should_quit(void);

#endif /* _LTTNG_LIVE_H */
Commit	Line	Data
c98627ca MD	1	#ifndef _LTTNG_LIVE_H
c98627ca MD	2	#define _LTTNG_LIVE_H
4a744367 JD	3
	4	/*
	5	* Copyright 2013 Julien Desfossez <julien.desfossez@efficios.com>
	6	* Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	7	*
	8	* Permission is hereby granted, free of charge, to any person obtaining a copy
	9	* of this software and associated documentation files (the "Software"), to deal
	10	* in the Software without restriction, including without limitation the rights
	11	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	12	* copies of the Software, and to permit persons to whom the Software is
	13	* furnished to do so, subject to the following conditions:
	14	*
	15	* The above copyright notice and this permission notice shall be included in
	16	* all copies or substantial portions of the Software.
	17	*
	18	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	19	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	20	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	21	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	22	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	23	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	24	* SOFTWARE.
	25	*/
	26
	27	#include <stdint.h>
5805251d	28	#include "lttng-viewer-abi.h"
4a744367	29
4a744367 JD	30	#define LTTNG_DEFAULT_NETWORK_VIEWER_PORT 5344
	31
	32	#define LTTNG_LIVE_MAJOR 2
	33	#define LTTNG_LIVE_MINOR 4
	34
220e0cbe MD	35	/*
	36	* The lttng-live output file pointer is currently hardcoded to stdout,
	37	* and is expected to be hardcoded to this by fflush() performed between
	38	* each packet.
	39	*/
	40	#define LTTNG_LIVE_OUTPUT_FP stdout
	41
4a744367	42	struct lttng_live_ctx {
c648b799 MJ	43	char traced_hostname[MAXNAMLEN];
	44	char session_name[MAXNAMLEN];
	45	char relay_hostname[MAXNAMLEN];
4a744367	46	int control_sock;
b5a1fa45	47	int port;
0dfc7b62 JD	48	/* Protocol version to use for this connection. */
	49	uint32_t major;
	50	uint32_t minor;
4a744367	51	struct lttng_live_session *session;
2acdc547	52	struct bt_context *bt_ctx;
b5a1fa45	53	GArray *session_ids;
4a744367 JD	54	};
	55
	56	struct lttng_live_viewer_stream {
	57	uint64_t id;
	58	uint64_t mmap_size;
5805251d	59	uint64_t ctf_stream_id;
af701dc4 JD	60	FILE *metadata_fp_write;
af701dc4 JD	61	ssize_t metadata_len;
4a744367	62	int metadata_flag;
5805251d	63	int data_pending;
4a744367 JD	64	struct lttng_live_session *session;
4a744367 JD	65	struct lttng_live_ctf_trace *ctf_trace;
5805251d	66	struct lttng_viewer_index current_index;
4a744367 JD	67	char path[PATH_MAX];
	68	};
	69
	70	struct lttng_live_session {
	71	uint64_t live_timer_interval;
	72	uint64_t stream_count;
	73	struct lttng_live_ctx *ctx;
	74	struct lttng_live_viewer_stream *streams;
705105fc	75	/* HashTable mapping trace_ids to ptrs to struct lttng_live_ctf_trace */
4a744367 JD	76	GHashTable *ctf_traces;
	77	};
	78
	79	struct lttng_live_ctf_trace {
	80	uint64_t ctf_trace_id;
	81	struct lttng_live_viewer_stream *metadata_stream;
	82	GPtrArray *streams;
	83	FILE *metadata_fp;
150595c4	84	struct bt_trace_handle *handle;
4a744367	85	int trace_id;
2acdc547	86	int in_use;
4a744367 JD	87	};
4a744367 JD	88
b5a1fa45 JD	89	/* Just used in listing. */
	90	struct lttng_live_relay_session {
	91	uint32_t streams;
	92	uint32_t clients;
	93	uint32_t timer;
	94	char *name;
	95	char *hostname;
	96	};
	97
	98	int lttng_live_connect_viewer(struct lttng_live_ctx *ctx);
4a744367 JD	99	int lttng_live_establish_connection(struct lttng_live_ctx *ctx);
	100	int lttng_live_list_sessions(struct lttng_live_ctx ctx, const char path);
	101	int lttng_live_attach_session(struct lttng_live_ctx *ctx, uint64_t id);
23285bf3	102	int lttng_live_read(struct lttng_live_ctx *ctx);
2acdc547	103	int lttng_live_get_new_streams(struct lttng_live_ctx *ctx, uint64_t id);
8ace20bf	104	int lttng_live_should_quit(void);
4a744367	105
c98627ca	106	#endif /* _LTTNG_LIVE_H */