[babeltrace.git] / plugins / ctf / lttng-live / lttng-live-internal.h

#ifndef BABELTRACE_PLUGIN_CTF_LTTNG_LIVE_INTERNAL_H
#define BABELTRACE_PLUGIN_CTF_LTTNG_LIVE_INTERNAL_H

/*
 * BabelTrace - LTTng-live client Component
 *
 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 * Copyright 2016 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *
 * Author: Jérémie Galarneau <jeremie.galarneau@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 <stdbool.h>

#include <babeltrace/babeltrace-internal.h>
#include <babeltrace/graph/component.h>
#include <babeltrace/graph/notification-iterator.h>
#include <babeltrace/graph/clock-class-priority-map.h>
#include "viewer-connection.h"

//TODO: this should not be used by plugins. Should copy code into plugin
//instead.
#include "babeltrace/object-internal.h"
#include "babeltrace/list-internal.h"
#include "../common/metadata/decoder.h"

#define STREAM_NAME_PREFIX	"stream-"
/* Account for u64 max string length. */
#define U64_STR_MAX_LEN		20
#define STREAM_NAME_MAX_LEN	(sizeof(STREAM_NAME_PREFIX) + U64_STR_MAX_LEN)

struct lttng_live_component;
struct lttng_live_session;

enum lttng_live_stream_state {
	LTTNG_LIVE_STREAM_ACTIVE_NO_DATA,
	LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA,
	LTTNG_LIVE_STREAM_QUIESCENT,
	LTTNG_LIVE_STREAM_ACTIVE_DATA,
	LTTNG_LIVE_STREAM_EOF,
};

enum live_stream_type {
	LIVE_STREAM_TYPE_NO_STREAM,
	LIVE_STREAM_TYPE_STREAM,
};

struct lttng_live_stream_iterator_generic {
	enum live_stream_type type;
};

/* Iterator over a live stream. */
struct lttng_live_stream_iterator {
	struct lttng_live_stream_iterator_generic p;

	struct bt_ctf_stream *stream;
	struct lttng_live_trace *trace;
	struct bt_private_port *port;

	/* Node of stream list within the trace. */
	struct bt_list_head node;

	/*
	 * Since only a single iterator per viewer connection, we have
	 * only a single notification iterator per stream.
	 */
	struct bt_ctf_notif_iter *notif_iter;

	uint64_t viewer_stream_id;

	uint64_t ctf_stream_class_id;
	uint64_t base_offset;		/* base offset in current index. */
	uint64_t len;			/* len to read in current index. */
	uint64_t offset;		/* offset in current index. */

	int64_t last_returned_inactivity_timestamp;
	int64_t current_inactivity_timestamp;

	enum lttng_live_stream_state state;

	uint64_t current_packet_end_timestamp;
	struct bt_notification *packet_end_notif_queue;

	uint8_t *buf;
	size_t buflen;

	char name[STREAM_NAME_MAX_LEN];
};

struct lttng_live_no_stream_iterator {
	struct lttng_live_stream_iterator_generic p;

	struct lttng_live_component *lttng_live;
	struct bt_private_port *port;
};

struct lttng_live_component_options {
	bool opt_dummy : 1;
};

struct lttng_live_metadata {
	struct lttng_live_trace *trace;
	uint64_t stream_id;
	uint8_t uuid[16];
	bool is_uuid_set;
	int bo;
	char *text;

	struct ctf_metadata_decoder *decoder;

	bool closed;
};

struct lttng_live_trace {
	struct bt_object obj;

	/* Node of trace list within the session. */
	struct bt_list_head node;

	/* Back reference to session. */
	struct lttng_live_session *session;

	uint64_t id;	/* ctf trace ID within the session. */

	struct bt_ctf_trace *trace;

	struct lttng_live_metadata *metadata;
	struct bt_clock_class_priority_map *cc_prio_map;

	/* List of struct lttng_live_stream_iterator */
	struct bt_list_head streams;

	bool new_metadata_needed;
};

struct lttng_live_session {
	/* Node of session list within the component. */
	struct bt_list_head node;

	struct lttng_live_component *lttng_live;

	GString *hostname;
	GString *session_name;

	uint64_t id;

	/* List of struct lttng_live_trace */
	struct bt_list_head traces;

	bool attached;
	bool new_streams_needed;
	bool lazy_stream_notif_init;
	bool closed;
};

/*
 * A component instance is an iterator on a single session.
 */
struct lttng_live_component {
	struct bt_object obj;
	struct bt_private_component *private_component;	/* weak */
	struct bt_live_viewer_connection *viewer_connection;

	/* List of struct lttng_live_session */
	struct bt_list_head sessions;

	GString *url;
	size_t max_query_size;
	struct lttng_live_component_options options;

	struct bt_private_port *no_stream_port;
	struct lttng_live_no_stream_iterator *no_stream_iter;

	struct bt_component *downstream_component;
	struct bt_graph *graph;	 /* weak */
};

enum bt_ctf_lttng_live_iterator_status {
	/** Iterator state has progressed. Continue iteration immediately. */
	BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_CONTINUE = 3,
	/** No notification available for now. Try again later. */
	BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_AGAIN = 2,
	/** No more CTF_LTTNG_LIVEs to be delivered. */
	BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_END = 1,
	/** No error, okay. */
	BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_OK = 0,
	/** Invalid arguments. */
	BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_INVAL = -1,
	/** General error. */
	BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_ERROR = -2,
	/** Out of memory. */
	BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_NOMEM = -3,
	/** Unsupported iterator feature. */
	BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_UNSUPPORTED = -4,
};

enum bt_component_status lttng_live_component_init(struct bt_private_component *source,
		struct bt_value *params, void *init_method_data);

struct bt_value *lttng_live_query(struct bt_component_class *comp_class,
		const char *object, struct bt_value *params);

void lttng_live_component_finalize(struct bt_private_component *component);

struct bt_notification_iterator_next_return lttng_live_iterator_next(
        struct bt_private_notification_iterator *iterator);

enum bt_component_status lttng_live_accept_port_connection(
		struct bt_private_component *private_component,
		struct bt_private_port *self_private_port,
		struct bt_port *other_port);

enum bt_notification_iterator_status lttng_live_iterator_init(
		struct bt_private_notification_iterator *it,
		struct bt_private_port *port);

void lttng_live_iterator_finalize(struct bt_private_notification_iterator *it);

int lttng_live_create_viewer_session(struct lttng_live_component *lttng_live);
int lttng_live_attach_session(struct lttng_live_session *session);
int lttng_live_detach_session(struct lttng_live_session *session);
enum bt_ctf_lttng_live_iterator_status lttng_live_get_new_streams(
		struct lttng_live_session *session);

int lttng_live_add_session(struct lttng_live_component *lttng_live,
		uint64_t session_id,
		const char *hostname,
		const char *session_name);

ssize_t lttng_live_get_one_metadata_packet(struct lttng_live_trace *trace,
		FILE *fp);
enum bt_ctf_lttng_live_iterator_status lttng_live_get_next_index(
		struct lttng_live_component *lttng_live,
		struct lttng_live_stream_iterator *stream,
		struct packet_index *index);
enum bt_ctf_notif_iter_medium_status lttng_live_get_stream_bytes(
		struct lttng_live_component *lttng_live,
		struct lttng_live_stream_iterator *stream, uint8_t *buf, uint64_t offset,
		uint64_t req_len, uint64_t *recv_len);

int lttng_live_add_port(struct lttng_live_component *lttng_live,
		struct lttng_live_stream_iterator *stream_iter);
int lttng_live_remove_port(struct lttng_live_component *lttng_live,
		struct bt_private_port *port);

struct lttng_live_trace *lttng_live_ref_trace(
		struct lttng_live_session *session, uint64_t trace_id);
void lttng_live_unref_trace(struct lttng_live_trace *trace);
void lttng_live_need_new_streams(struct lttng_live_component *lttng_live);

#endif /* BABELTRACE_PLUGIN_CTF_LTTNG_LIVE_INTERNAL_H */
Commit	Line	Data
f3bc2010 JG	1	#ifndef BABELTRACE_PLUGIN_CTF_LTTNG_LIVE_INTERNAL_H
	2	#define BABELTRACE_PLUGIN_CTF_LTTNG_LIVE_INTERNAL_H
	3
	4	/*
	5	* BabelTrace - LTTng-live client Component
	6	*
	7	* Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7cdc2bab	8	* Copyright 2016 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
f3bc2010 JG	9	*
	10	* Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
	11	*
	12	* Permission is hereby granted, free of charge, to any person obtaining a copy
	13	* of this software and associated documentation files (the "Software"), to deal
	14	* in the Software without restriction, including without limitation the rights
	15	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	16	* copies of the Software, and to permit persons to whom the Software is
	17	* furnished to do so, subject to the following conditions:
	18	*
	19	* The above copyright notice and this permission notice shall be included in
	20	* all copies or substantial portions of the Software.
	21	*
	22	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	23	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	24	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	25	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	26	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	27	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	28	* SOFTWARE.
	29	*/
	30
7cdc2bab MD	31	#include <stdbool.h>
7cdc2bab MD	32
f3bc2010	33	#include <babeltrace/babeltrace-internal.h>
b2e0c907	34	#include <babeltrace/graph/component.h>
7cdc2bab MD	35	#include <babeltrace/graph/notification-iterator.h>
	36	#include <babeltrace/graph/clock-class-priority-map.h>
	37	#include "viewer-connection.h"
	38
	39	//TODO: this should not be used by plugins. Should copy code into plugin
	40	//instead.
	41	#include "babeltrace/object-internal.h"
	42	#include "babeltrace/list-internal.h"
	43	#include "../common/metadata/decoder.h"
	44
	45	#define STREAM_NAME_PREFIX "stream-"
	46	/* Account for u64 max string length. */
	47	#define U64_STR_MAX_LEN 20
	48	#define STREAM_NAME_MAX_LEN (sizeof(STREAM_NAME_PREFIX) + U64_STR_MAX_LEN)
	49
7cdc2bab MD	50	struct lttng_live_component;
	51	struct lttng_live_session;
	52
	53	enum lttng_live_stream_state {
	54	LTTNG_LIVE_STREAM_ACTIVE_NO_DATA,
	55	LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA,
	56	LTTNG_LIVE_STREAM_QUIESCENT,
	57	LTTNG_LIVE_STREAM_ACTIVE_DATA,
	58	LTTNG_LIVE_STREAM_EOF,
	59	};
	60
	61	enum live_stream_type {
	62	LIVE_STREAM_TYPE_NO_STREAM,
	63	LIVE_STREAM_TYPE_STREAM,
	64	};
	65
	66	struct lttng_live_stream_iterator_generic {
	67	enum live_stream_type type;
	68	};
	69
	70	/* Iterator over a live stream. */
	71	struct lttng_live_stream_iterator {
	72	struct lttng_live_stream_iterator_generic p;
	73
	74	struct bt_ctf_stream *stream;
	75	struct lttng_live_trace *trace;
	76	struct bt_private_port *port;
	77
	78	/* Node of stream list within the trace. */
	79	struct bt_list_head node;
	80
	81	/*
	82	* Since only a single iterator per viewer connection, we have
	83	* only a single notification iterator per stream.
	84	*/
	85	struct bt_ctf_notif_iter *notif_iter;
	86
	87	uint64_t viewer_stream_id;
	88
	89	uint64_t ctf_stream_class_id;
	90	uint64_t base_offset; /* base offset in current index. */
	91	uint64_t len; /* len to read in current index. */
	92	uint64_t offset; /* offset in current index. */
	93
	94	int64_t last_returned_inactivity_timestamp;
	95	int64_t current_inactivity_timestamp;
	96
	97	enum lttng_live_stream_state state;
	98
	99	uint64_t current_packet_end_timestamp;
	100	struct bt_notification *packet_end_notif_queue;
	101
	102	uint8_t *buf;
	103	size_t buflen;
	104
	105	char name[STREAM_NAME_MAX_LEN];
	106	};
	107
	108	struct lttng_live_no_stream_iterator {
	109	struct lttng_live_stream_iterator_generic p;
	110
	111	struct lttng_live_component *lttng_live;
	112	struct bt_private_port *port;
	113	};
114
115	struct lttng_live_component_options {
116	bool opt_dummy : 1;
117	};
118
119	struct lttng_live_metadata {
120	struct lttng_live_trace *trace;
121	uint64_t stream_id;
122	uint8_t uuid[16];
123	bool is_uuid_set;
124	int bo;
125	char *text;
126
127	struct ctf_metadata_decoder *decoder;
128
129	bool closed;
130	};
131
132	struct lttng_live_trace {
133	struct bt_object obj;
134
135	/* Node of trace list within the session. */
136	struct bt_list_head node;
137
138	/* Back reference to session. */
139	struct lttng_live_session *session;
140
141	uint64_t id; /* ctf trace ID within the session. */
142
143	struct bt_ctf_trace *trace;
144
145	struct lttng_live_metadata *metadata;
146	struct bt_clock_class_priority_map *cc_prio_map;
147
148	/* List of struct lttng_live_stream_iterator */
149	struct bt_list_head streams;
150
151	bool new_metadata_needed;
152	};
153
154	struct lttng_live_session {
155	/* Node of session list within the component. */
156	struct bt_list_head node;
157
158	struct lttng_live_component *lttng_live;
159
06994c71 MD	160	GString *hostname;
	161	GString *session_name;
	162
7cdc2bab MD	163	uint64_t id;
	164
	165	/* List of struct lttng_live_trace */
	166	struct bt_list_head traces;
	167
	168	bool attached;
	169	bool new_streams_needed;
	170	bool lazy_stream_notif_init;
	171	bool closed;
	172	};
	173
	174	/*
	175	* A component instance is an iterator on a single session.
	176	*/
	177	struct lttng_live_component {
	178	struct bt_object obj;
	179	struct bt_private_component private_component; / weak */
	180	struct bt_live_viewer_connection *viewer_connection;
	181
	182	/* List of struct lttng_live_session */
	183	struct bt_list_head sessions;
	184
	185	GString *url;
7cdc2bab MD	186	size_t max_query_size;
	187	struct lttng_live_component_options options;
	188
	189	struct bt_private_port *no_stream_port;
	190	struct lttng_live_no_stream_iterator *no_stream_iter;
d85ef162 MD	191
d85ef162 MD	192	struct bt_component *downstream_component;
4c66436f	193	struct bt_graph graph; / weak */
7cdc2bab MD	194	};
	195
	196	enum bt_ctf_lttng_live_iterator_status {
	197	/** Iterator state has progressed. Continue iteration immediately. */
	198	BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_CONTINUE = 3,
	199	/** No notification available for now. Try again later. */
	200	BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_AGAIN = 2,
	201	/** No more CTF_LTTNG_LIVEs to be delivered. */
	202	BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_END = 1,
	203	/** No error, okay. */
	204	BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_OK = 0,
	205	/** Invalid arguments. */
	206	BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_INVAL = -1,
	207	/** General error. */
	208	BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_ERROR = -2,
	209	/** Out of memory. */
	210	BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_NOMEM = -3,
	211	/** Unsupported iterator feature. */
	212	BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_UNSUPPORTED = -4,
	213	};
f3bc2010	214
7cdc2bab	215	enum bt_component_status lttng_live_component_init(struct bt_private_component *source,
6358c163	216	struct bt_value params, void init_method_data);
f3bc2010	217
7cdc2bab MD	218	struct bt_value lttng_live_query(struct bt_component_class comp_class,
	219	const char object, struct bt_value params);
	220
	221	void lttng_live_component_finalize(struct bt_private_component *component);
	222
41a2b7ae	223	struct bt_notification_iterator_next_return lttng_live_iterator_next(
890882ef	224	struct bt_private_notification_iterator *iterator);
d3eb6e8f	225
d85ef162 MD	226	enum bt_component_status lttng_live_accept_port_connection(
	227	struct bt_private_component *private_component,
	228	struct bt_private_port *self_private_port,
	229	struct bt_port *other_port);
7cdc2bab MD	230
	231	enum bt_notification_iterator_status lttng_live_iterator_init(
	232	struct bt_private_notification_iterator *it,
	233	struct bt_private_port *port);
	234
	235	void lttng_live_iterator_finalize(struct bt_private_notification_iterator *it);
	236
	237	int lttng_live_create_viewer_session(struct lttng_live_component *lttng_live);
	238	int lttng_live_attach_session(struct lttng_live_session *session);
	239	int lttng_live_detach_session(struct lttng_live_session *session);
	240	enum bt_ctf_lttng_live_iterator_status lttng_live_get_new_streams(
	241	struct lttng_live_session *session);
	242
06994c71 MD	243	int lttng_live_add_session(struct lttng_live_component *lttng_live,
	244	uint64_t session_id,
	245	const char *hostname,
	246	const char *session_name);
7cdc2bab MD	247
	248	ssize_t lttng_live_get_one_metadata_packet(struct lttng_live_trace *trace,
	249	FILE *fp);
	250	enum bt_ctf_lttng_live_iterator_status lttng_live_get_next_index(
	251	struct lttng_live_component *lttng_live,
	252	struct lttng_live_stream_iterator *stream,
	253	struct packet_index *index);
	254	enum bt_ctf_notif_iter_medium_status lttng_live_get_stream_bytes(
	255	struct lttng_live_component *lttng_live,
	256	struct lttng_live_stream_iterator stream, uint8_t buf, uint64_t offset,
	257	uint64_t req_len, uint64_t *recv_len);
	258
	259	int lttng_live_add_port(struct lttng_live_component *lttng_live,
	260	struct lttng_live_stream_iterator *stream_iter);
	261	int lttng_live_remove_port(struct lttng_live_component *lttng_live,
	262	struct bt_private_port *port);
	263
	264	struct lttng_live_trace *lttng_live_ref_trace(
	265	struct lttng_live_session *session, uint64_t trace_id);
	266	void lttng_live_unref_trace(struct lttng_live_trace *trace);
	267	void lttng_live_need_new_streams(struct lttng_live_component *lttng_live);
	268
f3bc2010	269	#endif /* BABELTRACE_PLUGIN_CTF_LTTNG_LIVE_INTERNAL_H */