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

#ifndef BABELTRACE_PLUGIN_CTF_LTTNG_LIVE_H
#define BABELTRACE_PLUGIN_CTF_LTTNG_LIVE_H

/*
 * BabelTrace - LTTng-live client Component
 *
 * Copyright 2019 Francis Deslauriers <francis.deslauriers@efficios.com>
 * 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 "common/macros.h"
#include <babeltrace2/babeltrace.h>

#include "../common/metadata/decoder.h"
#include "../common/msg-iter/msg-iter.h"

#include "viewer-connection.h"

struct lttng_live_component;
struct lttng_live_session;
struct lttng_live_msg_iter;

enum lttng_live_stream_state {
	/* This stream won't have data until some known time in the future. */
	LTTNG_LIVE_STREAM_QUIESCENT,
	/*
	 * This stream won't have data until some known time in the future and
	 * the message iterator inactivity message was already sent downstream.
	 */
	LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA, /* */
	/* This stream has data ready to be consumed. */
	LTTNG_LIVE_STREAM_ACTIVE_DATA,
	/*
	 * This stream has no data left to consume. We should asked the relay
	 * for more.
	 */
	LTTNG_LIVE_STREAM_ACTIVE_NO_DATA,
	/* This stream won't have anymore data, ever. */
	LTTNG_LIVE_STREAM_EOF,
};

/* Iterator over a live stream. */
struct lttng_live_stream_iterator {
	bt_logging_level log_level;
	bt_self_component *self_comp;

	/* Owned by this. */
	bt_stream *stream;

	/* Weak reference. */
	struct lttng_live_trace *trace;

	/*
	 * Since only a single iterator per viewer connection, we have
	 * only a single message iterator per stream.
	 */
	struct bt_msg_iter *msg_iter;

	uint64_t viewer_stream_id;

	uint64_t ctf_stream_class_id;

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

	/*
	 * Clock Snapshot value of the last message iterator inactivity message
	 * sent downstream.
	 */
	uint64_t last_inactivity_ts;

	/*
	 * Clock Snapshot value of the current message iterator inactivity
	 * message we might want to send downstream.
	 */
	uint64_t current_inactivity_ts;

	enum lttng_live_stream_state state;

	/*
	 * The current message produced by this live stream iterator. Owned by
	 * this.
	 */
	bt_message *current_msg;

	/* Timestamp in nanoseconds of the current message (current_msg). */
	int64_t current_msg_ts_ns;

	/* Owned by this. */
	uint8_t *buf;
	size_t buflen;

	/* Owned by this. */
	GString *name;

	bool has_stream_hung_up;
};

struct lttng_live_metadata {
	bt_logging_level log_level;
	bt_self_component *self_comp;

	/* Weak reference. */
	struct lttng_live_trace *trace;

	uint64_t stream_id;
	/* Weak reference. */
	struct ctf_metadata_decoder *decoder;

	bool closed;
};

struct lttng_live_trace {
	bt_logging_level log_level;
	bt_self_component *self_comp;

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

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

	/* Owned by this. */
	bt_trace *trace;

	/* Weak reference. */
	bt_trace_class *trace_class;

	struct lttng_live_metadata *metadata;

	const bt_clock_class *clock_class;

	/* Array of pointers to struct lttng_live_stream_iterator. */
	/* Owned by this. */
	GPtrArray *stream_iterators;

	bool new_metadata_needed;
};

struct lttng_live_session {
	bt_logging_level log_level;
	bt_self_component *self_comp;

	/* Weak reference. */
	struct lttng_live_msg_iter *lttng_live_msg_iter;

	/* Owned by this. */
	GString *hostname;

	/* Owned by this. */
	GString *session_name;

	uint64_t id;

	/* Array of pointers to struct lttng_live_trace. */
	GPtrArray *traces;

	bool attached;
	bool new_streams_needed;
	bool lazy_stream_msg_init;
	bool closed;
};

enum session_not_found_action {
	SESSION_NOT_FOUND_ACTION_UNKNOWN,
	SESSION_NOT_FOUND_ACTION_CONTINUE,
	SESSION_NOT_FOUND_ACTION_FAIL,
	SESSION_NOT_FOUND_ACTION_END,
};

/*
 * A component instance is an iterator on a single session.
 */
struct lttng_live_component {
	bt_logging_level log_level;

	/* Weak reference. */
	bt_self_component *self_comp;

	struct {
		GString *url;
		enum session_not_found_action sess_not_found_act;
	} params;

	size_t max_query_size;

	/*
	 * Keeps track of whether the downstream component already has a
	 * message iterator on this component.
	 */
	bool has_msg_iter;
};

struct lttng_live_msg_iter {
	bt_logging_level log_level;
	bt_self_component *self_comp;

	/* Weak reference. */
	struct lttng_live_component *lttng_live_comp;

	/* Weak reference. */
	bt_self_message_iterator *self_msg_iter;

	/* Owned by this. */
	struct live_viewer_connection *viewer_connection;

	/* Array of pointers to struct lttng_live_session. */
	GPtrArray *sessions;

	/* Number of live stream iterator this message iterator has.*/
	uint64_t active_stream_iter;

	/* Timestamp in nanosecond of the last message sent downstream. */
	int64_t last_msg_ts_ns;
};

enum lttng_live_iterator_status {
	/** Iterator state has progressed. Continue iteration immediately. */
	LTTNG_LIVE_ITERATOR_STATUS_CONTINUE = 3,
	/** No message available for now. Try again later. */
	LTTNG_LIVE_ITERATOR_STATUS_AGAIN = 2,
	/** No more CTF_LTTNG_LIVEs to be delivered. */
	LTTNG_LIVE_ITERATOR_STATUS_END = 1,
	/** No error, okay. */
	LTTNG_LIVE_ITERATOR_STATUS_OK = 0,
	/** Invalid arguments. */
	LTTNG_LIVE_ITERATOR_STATUS_INVAL = -1,
	/** General error. */
	LTTNG_LIVE_ITERATOR_STATUS_ERROR = -2,
	/** Out of memory. */
	LTTNG_LIVE_ITERATOR_STATUS_NOMEM = -3,
	/** Unsupported iterator feature. */
	LTTNG_LIVE_ITERATOR_STATUS_UNSUPPORTED = -4,
};

bt_component_class_init_method_status lttng_live_component_init(
		bt_self_component_source *self_comp,
		bt_self_component_source_configuration *config,
		const bt_value *params, void *init_method_data);

bt_component_class_query_method_status lttng_live_query(
		bt_self_component_class_source *comp_class,
		bt_private_query_executor *priv_query_exec,
		const char *object, const bt_value *params,
		void *method_data, const bt_value **result);

void lttng_live_component_finalize(bt_self_component_source *component);

bt_component_class_message_iterator_next_method_status lttng_live_msg_iter_next(
		bt_self_message_iterator *iterator,
		bt_message_array_const msgs, uint64_t capacity,
		uint64_t *count);

bt_component_class_message_iterator_init_method_status lttng_live_msg_iter_init(
		bt_self_message_iterator *self_msg_it,
		bt_self_message_iterator_configuration *config,
		bt_self_component_source *self_comp,
		bt_self_component_port_output *self_port);

void lttng_live_msg_iter_finalize(bt_self_message_iterator *it);

int lttng_live_create_viewer_session(struct lttng_live_msg_iter *lttng_live_msg_iter);
int lttng_live_attach_session(struct lttng_live_session *session);
int lttng_live_detach_session(struct lttng_live_session *session);
enum lttng_live_iterator_status lttng_live_get_new_streams(
		struct lttng_live_session *session);

int lttng_live_add_session(struct lttng_live_msg_iter *lttng_live_msg_iter,
		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 lttng_live_iterator_status lttng_live_get_next_index(
		struct lttng_live_msg_iter *lttng_live_msg_iter,
		struct lttng_live_stream_iterator *stream,
		struct packet_index *index);

enum bt_msg_iter_medium_status lttng_live_get_stream_bytes(
		struct lttng_live_msg_iter *lttng_live_msg_iter,
		struct lttng_live_stream_iterator *stream, uint8_t *buf,
		uint64_t offset, uint64_t req_len, uint64_t *recv_len);
void lttng_live_add_stream_iterator(struct lttng_live_msg_iter *lttng_live_msg_iter,
		struct lttng_live_stream_iterator *stream_iter);
void lttng_live_remove_stream_iterator(struct lttng_live_msg_iter *lttng_live_msg_iter,
		struct lttng_live_stream_iterator *stream_iter);

struct lttng_live_trace *lttng_live_borrow_trace(
		struct lttng_live_session *session, uint64_t trace_id);
void lttng_live_need_new_streams(struct lttng_live_msg_iter *lttng_live_msg_iter);

bool lttng_live_graph_is_canceled(struct lttng_live_msg_iter *msg_iter);

#endif /* BABELTRACE_PLUGIN_CTF_LTTNG_LIVE_H */
Commit	Line	Data
14f28187 FD	1	#ifndef BABELTRACE_PLUGIN_CTF_LTTNG_LIVE_H
	2	#define BABELTRACE_PLUGIN_CTF_LTTNG_LIVE_H
	3
	4	/*
	5	* BabelTrace - LTTng-live client Component
	6	*
	7	* Copyright 2019 Francis Deslauriers <francis.deslauriers@efficios.com>
	8	* Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
	9	* Copyright 2016 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	10	*
	11	* Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
	12	*
	13	* Permission is hereby granted, free of charge, to any person obtaining a copy
	14	* of this software and associated documentation files (the "Software"), to deal
	15	* in the Software without restriction, including without limitation the rights
	16	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	17	* copies of the Software, and to permit persons to whom the Software is
	18	* furnished to do so, subject to the following conditions:
	19	*
	20	* The above copyright notice and this permission notice shall be included in
	21	* all copies or substantial portions of the Software.
	22	*
	23	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	24	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	25	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	26	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	27	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	28	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	29	* SOFTWARE.
	30	*/
	31
	32	#include <stdbool.h>
	33
91d81473	34	#include "common/macros.h"
3fadfbc0	35	#include <babeltrace2/babeltrace.h>
14f28187 FD	36
	37	#include "../common/metadata/decoder.h"
	38	#include "../common/msg-iter/msg-iter.h"
	39
	40	#include "viewer-connection.h"
	41
	42	struct lttng_live_component;
	43	struct lttng_live_session;
	44	struct lttng_live_msg_iter;
	45
	46	enum lttng_live_stream_state {
	47	/* This stream won't have data until some known time in the future. */
	48	LTTNG_LIVE_STREAM_QUIESCENT,
	49	/*
	50	* This stream won't have data until some known time in the future and
	51	* the message iterator inactivity message was already sent downstream.
	52	*/
	53	LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA, /* */
	54	/* This stream has data ready to be consumed. */
	55	LTTNG_LIVE_STREAM_ACTIVE_DATA,
	56	/*
	57	* This stream has no data left to consume. We should asked the relay
	58	* for more.
	59	*/
	60	LTTNG_LIVE_STREAM_ACTIVE_NO_DATA,
	61	/* This stream won't have anymore data, ever. */
	62	LTTNG_LIVE_STREAM_EOF,
	63	};
	64
	65	/* Iterator over a live stream. */
	66	struct lttng_live_stream_iterator {
c01594de	67	bt_logging_level log_level;
2ece7dd0	68	bt_self_component *self_comp;
c01594de	69
14f28187 FD	70	/* Owned by this. */
	71	bt_stream *stream;
	72
	73	/* Weak reference. */
	74	struct lttng_live_trace *trace;
	75
	76	/*
	77	* Since only a single iterator per viewer connection, we have
	78	* only a single message iterator per stream.
	79	*/
	80	struct bt_msg_iter *msg_iter;
	81
	82	uint64_t viewer_stream_id;
	83
	84	uint64_t ctf_stream_class_id;
	85
	86	/* base offset in current index. */
	87	uint64_t base_offset;
	88	/* len to read in current index. */
	89	uint64_t len;
	90	/* offset in current index. */
	91	uint64_t offset;
	92
	93	/*
	94	* Clock Snapshot value of the last message iterator inactivity message
	95	* sent downstream.
	96	*/
	97	uint64_t last_inactivity_ts;
	98
	99	/*
	100	* Clock Snapshot value of the current message iterator inactivity
	101	* message we might want to send downstream.
	102	*/
	103	uint64_t current_inactivity_ts;
	104
	105	enum lttng_live_stream_state state;
	106
	107	/*
	108	* The current message produced by this live stream iterator. Owned by
	109	* this.
	110	*/
	111	bt_message *current_msg;
	112
	113	/* Timestamp in nanoseconds of the current message (current_msg). */
	114	int64_t current_msg_ts_ns;
	115
	116	/* Owned by this. */
	117	uint8_t *buf;
	118	size_t buflen;
	119
	120	/* Owned by this. */
	121	GString *name;
4a39caef FD	122
4a39caef FD	123	bool has_stream_hung_up;
14f28187 FD	124	};
	125
	126	struct lttng_live_metadata {
c01594de	127	bt_logging_level log_level;
2ece7dd0	128	bt_self_component *self_comp;
c01594de	129
14f28187 FD	130	/* Weak reference. */
	131	struct lttng_live_trace *trace;
	132
	133	uint64_t stream_id;
	134	/* Weak reference. */
	135	struct ctf_metadata_decoder *decoder;
	136
	137	bool closed;
	138	};
	139
	140	struct lttng_live_trace {
c01594de	141	bt_logging_level log_level;
2ece7dd0	142	bt_self_component *self_comp;
c01594de	143
14f28187 FD	144	/* Back reference to session. */
	145	struct lttng_live_session *session;
	146
	147	/* ctf trace ID within the session. */
	148	uint64_t id;
	149
	150	/* Owned by this. */
	151	bt_trace *trace;
	152
	153	/* Weak reference. */
	154	bt_trace_class *trace_class;
	155
	156	struct lttng_live_metadata *metadata;
	157
	158	const bt_clock_class *clock_class;
	159
	160	/* Array of pointers to struct lttng_live_stream_iterator. */
	161	/* Owned by this. */
	162	GPtrArray *stream_iterators;
	163
	164	bool new_metadata_needed;
	165	};
	166
	167	struct lttng_live_session {
c01594de	168	bt_logging_level log_level;
2ece7dd0	169	bt_self_component *self_comp;
c01594de	170
14f28187 FD	171	/* Weak reference. */
	172	struct lttng_live_msg_iter *lttng_live_msg_iter;
	173
	174	/* Owned by this. */
	175	GString *hostname;
	176
	177	/* Owned by this. */
	178	GString *session_name;
	179
	180	uint64_t id;
	181
	182	/* Array of pointers to struct lttng_live_trace. */
	183	GPtrArray *traces;
	184
	185	bool attached;
	186	bool new_streams_needed;
	187	bool lazy_stream_msg_init;
	188	bool closed;
	189	};
	190
	191	enum session_not_found_action {
bce81ff2	192	SESSION_NOT_FOUND_ACTION_UNKNOWN,
14f28187 FD	193	SESSION_NOT_FOUND_ACTION_CONTINUE,
	194	SESSION_NOT_FOUND_ACTION_FAIL,
	195	SESSION_NOT_FOUND_ACTION_END,
	196	};
	197
	198	/*
	199	* A component instance is an iterator on a single session.
	200	*/
	201	struct lttng_live_component {
c01594de PP	202	bt_logging_level log_level;
c01594de PP	203
14f28187	204	/* Weak reference. */
2ece7dd0	205	bt_self_component *self_comp;
14f28187 FD	206
	207	struct {
	208	GString *url;
	209	enum session_not_found_action sess_not_found_act;
	210	} params;
	211
	212	size_t max_query_size;
	213
	214	/*
	215	* Keeps track of whether the downstream component already has a
	216	* message iterator on this component.
	217	*/
	218	bool has_msg_iter;
	219	};
	220
	221	struct lttng_live_msg_iter {
c01594de	222	bt_logging_level log_level;
2ece7dd0	223	bt_self_component *self_comp;
c01594de	224
14f28187 FD	225	/* Weak reference. */
	226	struct lttng_live_component *lttng_live_comp;
	227
	228	/* Weak reference. */
	229	bt_self_message_iterator *self_msg_iter;
	230
	231	/* Owned by this. */
	232	struct live_viewer_connection *viewer_connection;
	233
	234	/* Array of pointers to struct lttng_live_session. */
	235	GPtrArray *sessions;
	236
	237	/* Number of live stream iterator this message iterator has.*/
	238	uint64_t active_stream_iter;
	239
	240	/* Timestamp in nanosecond of the last message sent downstream. */
	241	int64_t last_msg_ts_ns;
	242	};
	243
	244	enum lttng_live_iterator_status {
	245	/** Iterator state has progressed. Continue iteration immediately. */
	246	LTTNG_LIVE_ITERATOR_STATUS_CONTINUE = 3,
	247	/** No message available for now. Try again later. */
	248	LTTNG_LIVE_ITERATOR_STATUS_AGAIN = 2,
	249	/** No more CTF_LTTNG_LIVEs to be delivered. */
	250	LTTNG_LIVE_ITERATOR_STATUS_END = 1,
	251	/** No error, okay. */
	252	LTTNG_LIVE_ITERATOR_STATUS_OK = 0,
	253	/** Invalid arguments. */
	254	LTTNG_LIVE_ITERATOR_STATUS_INVAL = -1,
	255	/** General error. */
	256	LTTNG_LIVE_ITERATOR_STATUS_ERROR = -2,
	257	/** Out of memory. */
	258	LTTNG_LIVE_ITERATOR_STATUS_NOMEM = -3,
	259	/** Unsupported iterator feature. */
	260	LTTNG_LIVE_ITERATOR_STATUS_UNSUPPORTED = -4,
	261	};
	262
d24d5663	263	bt_component_class_init_method_status lttng_live_component_init(
14f28187	264	bt_self_component_source *self_comp,
59225a3e	265	bt_self_component_source_configuration *config,
14f28187 FD	266	const bt_value params, void init_method_data);
14f28187 FD	267
d24d5663	268	bt_component_class_query_method_status lttng_live_query(
14f28187	269	bt_self_component_class_source *comp_class,
3c729b9a	270	bt_private_query_executor *priv_query_exec,
14f28187	271	const char object, const bt_value params,
7c14d641	272	void method_data, const bt_value *result);
14f28187 FD	273
	274	void lttng_live_component_finalize(bt_self_component_source *component);
	275
d24d5663	276	bt_component_class_message_iterator_next_method_status lttng_live_msg_iter_next(
14f28187 FD	277	bt_self_message_iterator *iterator,
	278	bt_message_array_const msgs, uint64_t capacity,
	279	uint64_t *count);
	280
d24d5663	281	bt_component_class_message_iterator_init_method_status lttng_live_msg_iter_init(
14f28187	282	bt_self_message_iterator *self_msg_it,
8d8b141d	283	bt_self_message_iterator_configuration *config,
14f28187 FD	284	bt_self_component_source *self_comp,
	285	bt_self_component_port_output *self_port);
	286
	287	void lttng_live_msg_iter_finalize(bt_self_message_iterator *it);
	288
	289	int lttng_live_create_viewer_session(struct lttng_live_msg_iter *lttng_live_msg_iter);
	290	int lttng_live_attach_session(struct lttng_live_session *session);
	291	int lttng_live_detach_session(struct lttng_live_session *session);
	292	enum lttng_live_iterator_status lttng_live_get_new_streams(
	293	struct lttng_live_session *session);
	294
	295	int lttng_live_add_session(struct lttng_live_msg_iter *lttng_live_msg_iter,
	296	uint64_t session_id,
	297	const char *hostname,
	298	const char *session_name);
	299
	300	ssize_t lttng_live_get_one_metadata_packet(struct lttng_live_trace *trace,
	301	FILE *fp);
	302	enum lttng_live_iterator_status lttng_live_get_next_index(
	303	struct lttng_live_msg_iter *lttng_live_msg_iter,
	304	struct lttng_live_stream_iterator *stream,
	305	struct packet_index *index);
	306
	307	enum bt_msg_iter_medium_status lttng_live_get_stream_bytes(
	308	struct lttng_live_msg_iter *lttng_live_msg_iter,
	309	struct lttng_live_stream_iterator stream, uint8_t buf,
	310	uint64_t offset, uint64_t req_len, uint64_t *recv_len);
	311	void lttng_live_add_stream_iterator(struct lttng_live_msg_iter *lttng_live_msg_iter,
	312	struct lttng_live_stream_iterator *stream_iter);
	313	void lttng_live_remove_stream_iterator(struct lttng_live_msg_iter *lttng_live_msg_iter,
	314	struct lttng_live_stream_iterator *stream_iter);
	315
	316	struct lttng_live_trace *lttng_live_borrow_trace(
	317	struct lttng_live_session *session, uint64_t trace_id);
	318	void lttng_live_need_new_streams(struct lttng_live_msg_iter *lttng_live_msg_iter);
	319
9b4f9b42	320	bool lttng_live_graph_is_canceled(struct lttng_live_msg_iter *msg_iter);
14f28187 FD	321
14f28187 FD	322	#endif /* BABELTRACE_PLUGIN_CTF_LTTNG_LIVE_H */