[babeltrace.git] / src / plugins / ctf / lttng-live / data-stream.c

/*
 * Copyright 2019 Francis Deslauriers <francis.deslauriers@efficios.com>
 * Copyright 2016 - Philippe Proulx <pproulx@efficios.com>
 * Copyright 2016 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
 * Copyright 2010-2011 - EfficiOS Inc. and Linux Foundation
 *
 * 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.
 */

#define BT_LOG_OUTPUT_LEVEL log_level
#define BT_LOG_TAG "PLUGIN/SRC.CTF.LTTNG-LIVE/DS"
#include "logging/log.h"

#include <stdio.h>
#include <stdint.h>
#include <stdlib.h>
#include <stdbool.h>
#include <glib.h>
#include <inttypes.h>
#include "compat/mman.h"
#include <babeltrace2/babeltrace.h>
#include "../common/msg-iter/msg-iter.h"
#include "common/assert.h"

#include "data-stream.h"

#define STREAM_NAME_PREFIX	"stream-"

static
enum bt_msg_iter_medium_status medop_request_bytes(
		size_t request_sz, uint8_t **buffer_addr,
		size_t *buffer_sz, void *data)
{
	enum bt_msg_iter_medium_status status =
		BT_MSG_ITER_MEDIUM_STATUS_OK;
	struct lttng_live_stream_iterator *stream = data;
	struct lttng_live_trace *trace = stream->trace;
	struct lttng_live_session *session = trace->session;
	struct lttng_live_msg_iter *live_msg_iter = session->lttng_live_msg_iter;
	uint64_t recv_len = 0;
	uint64_t len_left;
	uint64_t read_len;

	len_left = stream->base_offset + stream->len - stream->offset;
	if (!len_left) {
		stream->state = LTTNG_LIVE_STREAM_ACTIVE_NO_DATA;
		status = BT_MSG_ITER_MEDIUM_STATUS_AGAIN;
		return status;
	}
	read_len = MIN(request_sz, stream->buflen);
	read_len = MIN(read_len, len_left);
	status = lttng_live_get_stream_bytes(live_msg_iter,
			stream, stream->buf, stream->offset,
			read_len, &recv_len);
	*buffer_addr = stream->buf;
	*buffer_sz = recv_len;
	stream->offset += recv_len;
	return status;
}

static
bt_stream *medop_borrow_stream(bt_stream_class *stream_class,
		int64_t stream_id, void *data)
{
	struct lttng_live_stream_iterator *lttng_live_stream = data;
	bt_logging_level log_level = lttng_live_stream->log_level;

	if (!lttng_live_stream->stream) {
		uint64_t stream_class_id = bt_stream_class_get_id(stream_class);

		BT_LOGI("Creating stream %s (ID: %" PRIu64 ") out of stream "
			"class %" PRId64, lttng_live_stream->name->str,
			stream_id, stream_class_id);

		if (stream_id < 0) {
			/*
			 * No stream instance ID in the stream. It's possible
			 * to encounter this situation with older version of
			 * LTTng. In these cases, use the viewer_stream_id that
			 * is unique for a live viewer session.
			 */
			lttng_live_stream->stream = bt_stream_create_with_id(
				stream_class, lttng_live_stream->trace->trace,
				lttng_live_stream->viewer_stream_id);
		} else {
			lttng_live_stream->stream = bt_stream_create_with_id(
				stream_class, lttng_live_stream->trace->trace,
				(uint64_t) stream_id);
		}

		if (!lttng_live_stream->stream) {
			BT_LOGE("Cannot create stream %s (stream class ID "
				"%" PRId64 ", stream ID %" PRIu64 ")",
				lttng_live_stream->name->str,
				stream_class_id, stream_id);
		}
		bt_stream_set_name(lttng_live_stream->stream,
			lttng_live_stream->name->str);
	}

	return lttng_live_stream->stream;
}

static struct bt_msg_iter_medium_ops medops = {
	.request_bytes = medop_request_bytes,
	.seek = NULL,
	.borrow_stream = medop_borrow_stream,
};

BT_HIDDEN
enum lttng_live_iterator_status lttng_live_lazy_msg_init(
		struct lttng_live_session *session)
{
	struct lttng_live_component *lttng_live =
		session->lttng_live_msg_iter->lttng_live_comp;
	uint64_t trace_idx, stream_iter_idx;
	bt_logging_level log_level = session->log_level;

	if (!session->lazy_stream_msg_init) {
		return LTTNG_LIVE_ITERATOR_STATUS_OK;
	}

	for (trace_idx = 0; trace_idx < session->traces->len; trace_idx++) {
		struct lttng_live_trace *trace =
			g_ptr_array_index(session->traces, trace_idx);

		for (stream_iter_idx = 0;
				stream_iter_idx < trace->stream_iterators->len;
				stream_iter_idx++) {
			struct ctf_trace_class *ctf_tc;
			struct lttng_live_stream_iterator *stream_iter =
				g_ptr_array_index(trace->stream_iterators,
						stream_iter_idx);

			if (stream_iter->msg_iter) {
				continue;
			}
			ctf_tc = ctf_metadata_decoder_borrow_ctf_trace_class(
						trace->metadata->decoder);
			stream_iter->msg_iter = bt_msg_iter_create(ctf_tc,
					lttng_live->max_query_size, medops,
					stream_iter, log_level, NULL);
			if (!stream_iter->msg_iter) {
				goto error;
			}
		}
	}

	session->lazy_stream_msg_init = false;

	return LTTNG_LIVE_ITERATOR_STATUS_OK;

error:
	return LTTNG_LIVE_ITERATOR_STATUS_ERROR;
}

BT_HIDDEN
struct lttng_live_stream_iterator *lttng_live_stream_iterator_create(
		struct lttng_live_session *session,
		uint64_t ctf_trace_id,
		uint64_t stream_id)
{
	struct lttng_live_stream_iterator *stream_iter;
	struct lttng_live_component *lttng_live;
	struct lttng_live_trace *trace;
	bt_logging_level log_level;

	BT_ASSERT(session);
	BT_ASSERT(session->lttng_live_msg_iter);
	BT_ASSERT(session->lttng_live_msg_iter->lttng_live_comp);
	log_level = session->log_level;

	lttng_live = session->lttng_live_msg_iter->lttng_live_comp;

	stream_iter = g_new0(struct lttng_live_stream_iterator, 1);
	if (!stream_iter) {
		goto error;
	}

	stream_iter->log_level = log_level;
	trace = lttng_live_borrow_trace(session, ctf_trace_id);
	if (!trace) {
		goto error;
	}

	stream_iter->trace = trace;
	stream_iter->state = LTTNG_LIVE_STREAM_ACTIVE_NO_DATA;
	stream_iter->viewer_stream_id = stream_id;
	stream_iter->ctf_stream_class_id = -1ULL;
	stream_iter->last_inactivity_ts = INT64_MIN;

	if (trace->trace) {
		struct ctf_trace_class *ctf_tc =
			ctf_metadata_decoder_borrow_ctf_trace_class(
					trace->metadata->decoder);
		BT_ASSERT(!stream_iter->msg_iter);
		stream_iter->msg_iter = bt_msg_iter_create(ctf_tc,
				lttng_live->max_query_size, medops,
				stream_iter, log_level, NULL);
		if (!stream_iter->msg_iter) {
			goto error;
		}
	}
	stream_iter->buf = g_new0(uint8_t, lttng_live->max_query_size);
	if (!stream_iter->buf) {
		goto error;
	}

	stream_iter->buflen = lttng_live->max_query_size;
	stream_iter->name = g_string_new(NULL);
	if (!stream_iter->name) {
		goto error;
	}

	g_string_printf(stream_iter->name, STREAM_NAME_PREFIX "%" PRIu64,
			stream_iter->viewer_stream_id);
	g_ptr_array_add(trace->stream_iterators, stream_iter);

	/* Track the number of active stream iterator. */
	session->lttng_live_msg_iter->active_stream_iter++;

	goto end;
error:
	lttng_live_stream_iterator_destroy(stream_iter);
	stream_iter = NULL;
end:
	return stream_iter;
}

BT_HIDDEN
void lttng_live_stream_iterator_destroy(
		struct lttng_live_stream_iterator *stream_iter)
{
	if (!stream_iter) {
		return;
	}

	if (stream_iter->stream) {
		BT_STREAM_PUT_REF_AND_RESET(stream_iter->stream);
	}

	if (stream_iter->msg_iter) {
		bt_msg_iter_destroy(stream_iter->msg_iter);
	}
	if (stream_iter->buf) {
		g_free(stream_iter->buf);
	}
	if (stream_iter->name) {
		g_string_free(stream_iter->name, TRUE);
	}

	bt_message_put_ref(stream_iter->current_msg);

	/* Track the number of active stream iterator. */
	stream_iter->trace->session->lttng_live_msg_iter->active_stream_iter--;

	/*
	 * Ensure we poke the trace metadata in the future, which is
	 * required to release the metadata reference on the trace.
	 */
	stream_iter->trace->new_metadata_needed = true;
	g_free(stream_iter);
}
Commit	Line	Data
7cdc2bab	1	/*
14f28187	2	* Copyright 2019 Francis Deslauriers <francis.deslauriers@efficios.com>
7cdc2bab MD	3	* Copyright 2016 - Philippe Proulx <pproulx@efficios.com>
	4	* Copyright 2016 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
	5	* Copyright 2010-2011 - EfficiOS Inc. and Linux Foundation
	6	*
	7	* Permission is hereby granted, free of charge, to any person obtaining a copy
	8	* of this software and associated documentation files (the "Software"), to deal
	9	* in the Software without restriction, including without limitation the rights
	10	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	11	* copies of the Software, and to permit persons to whom the Software is
	12	* furnished to do so, subject to the following conditions:
	13	*
	14	* The above copyright notice and this permission notice shall be included in
	15	* all copies or substantial portions of the Software.
	16	*
	17	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	18	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	19	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	20	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	21	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	22	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	23	* SOFTWARE.
	24	*/
	25
c01594de	26	#define BT_LOG_OUTPUT_LEVEL log_level
350ad6c1	27	#define BT_LOG_TAG "PLUGIN/SRC.CTF.LTTNG-LIVE/DS"
c01594de	28	#include "logging/log.h"
020bc26f	29
7cdc2bab MD	30	#include <stdio.h>
	31	#include <stdint.h>
	32	#include <stdlib.h>
	33	#include <stdbool.h>
	34	#include <glib.h>
	35	#include <inttypes.h>
578e048b	36	#include "compat/mman.h"
3fadfbc0	37	#include <babeltrace2/babeltrace.h>
d6e69534	38	#include "../common/msg-iter/msg-iter.h"
578e048b	39	#include "common/assert.h"
7cdc2bab	40
087bc060	41	#include "data-stream.h"
7cdc2bab	42
14f28187 FD	43	#define STREAM_NAME_PREFIX "stream-"
14f28187 FD	44
7cdc2bab	45	static
d6e69534	46	enum bt_msg_iter_medium_status medop_request_bytes(
7cdc2bab MD	47	size_t request_sz, uint8_t **buffer_addr,
	48	size_t buffer_sz, void data)
	49	{
d6e69534 PP	50	enum bt_msg_iter_medium_status status =
d6e69534 PP	51	BT_MSG_ITER_MEDIUM_STATUS_OK;
7cdc2bab MD	52	struct lttng_live_stream_iterator *stream = data;
	53	struct lttng_live_trace *trace = stream->trace;
	54	struct lttng_live_session *session = trace->session;
14f28187	55	struct lttng_live_msg_iter *live_msg_iter = session->lttng_live_msg_iter;
7cdc2bab MD	56	uint64_t recv_len = 0;
	57	uint64_t len_left;
	58	uint64_t read_len;
7cdc2bab MD	59
	60	len_left = stream->base_offset + stream->len - stream->offset;
	61	if (!len_left) {
	62	stream->state = LTTNG_LIVE_STREAM_ACTIVE_NO_DATA;
d6e69534	63	status = BT_MSG_ITER_MEDIUM_STATUS_AGAIN;
7cdc2bab MD	64	return status;
	65	}
	66	read_len = MIN(request_sz, stream->buflen);
	67	read_len = MIN(read_len, len_left);
14f28187	68	status = lttng_live_get_stream_bytes(live_msg_iter,
7cdc2bab MD	69	stream, stream->buf, stream->offset,
7cdc2bab MD	70	read_len, &recv_len);
7cdc2bab MD	71	*buffer_addr = stream->buf;
	72	*buffer_sz = recv_len;
	73	stream->offset += recv_len;
	74	return status;
	75	}
	76
	77	static
14f28187 FD	78	bt_stream medop_borrow_stream(bt_stream_class stream_class,
14f28187 FD	79	int64_t stream_id, void *data)
7cdc2bab MD	80	{
7cdc2bab MD	81	struct lttng_live_stream_iterator *lttng_live_stream = data;
c01594de	82	bt_logging_level log_level = lttng_live_stream->log_level;
7cdc2bab MD	83
7cdc2bab MD	84	if (!lttng_live_stream->stream) {
14f28187	85	uint64_t stream_class_id = bt_stream_class_get_id(stream_class);
b92735af	86
3f7d4d90	87	BT_LOGI("Creating stream %s (ID: %" PRIu64 ") out of stream "
14f28187 FD	88	"class %" PRId64, lttng_live_stream->name->str,
14f28187 FD	89	stream_id, stream_class_id);
b92735af	90
14f28187 FD	91	if (stream_id < 0) {
	92	/*
	93	* No stream instance ID in the stream. It's possible
	94	* to encounter this situation with older version of
	95	* LTTng. In these cases, use the viewer_stream_id that
	96	* is unique for a live viewer session.
	97	*/
	98	lttng_live_stream->stream = bt_stream_create_with_id(
	99	stream_class, lttng_live_stream->trace->trace,
	100	lttng_live_stream->viewer_stream_id);
b92735af	101	} else {
14f28187 FD	102	lttng_live_stream->stream = bt_stream_create_with_id(
	103	stream_class, lttng_live_stream->trace->trace,
	104	(uint64_t) stream_id);
b92735af	105	}
7cdc2bab	106
7cdc2bab	107	if (!lttng_live_stream->stream) {
14f28187 FD	108	BT_LOGE("Cannot create stream %s (stream class ID "
	109	"%" PRId64 ", stream ID %" PRIu64 ")",
	110	lttng_live_stream->name->str,
	111	stream_class_id, stream_id);
7cdc2bab	112	}
14f28187 FD	113	bt_stream_set_name(lttng_live_stream->stream,
14f28187 FD	114	lttng_live_stream->name->str);
7cdc2bab MD	115	}
	116
	117	return lttng_live_stream->stream;
	118	}
	119
d6e69534	120	static struct bt_msg_iter_medium_ops medops = {
7cdc2bab	121	.request_bytes = medop_request_bytes,
14f28187 FD	122	.seek = NULL,
14f28187 FD	123	.borrow_stream = medop_borrow_stream,
7cdc2bab MD	124	};
	125
	126	BT_HIDDEN
14f28187	127	enum lttng_live_iterator_status lttng_live_lazy_msg_init(
7cdc2bab MD	128	struct lttng_live_session *session)
7cdc2bab MD	129	{
14f28187 FD	130	struct lttng_live_component *lttng_live =
	131	session->lttng_live_msg_iter->lttng_live_comp;
	132	uint64_t trace_idx, stream_iter_idx;
c01594de	133	bt_logging_level log_level = session->log_level;
7cdc2bab	134
d6e69534	135	if (!session->lazy_stream_msg_init) {
14f28187	136	return LTTNG_LIVE_ITERATOR_STATUS_OK;
7cdc2bab MD	137	}
7cdc2bab MD	138
14f28187 FD	139	for (trace_idx = 0; trace_idx < session->traces->len; trace_idx++) {
	140	struct lttng_live_trace *trace =
	141	g_ptr_array_index(session->traces, trace_idx);
	142
	143	for (stream_iter_idx = 0;
	144	stream_iter_idx < trace->stream_iterators->len;
	145	stream_iter_idx++) {
	146	struct ctf_trace_class *ctf_tc;
	147	struct lttng_live_stream_iterator *stream_iter =
	148	g_ptr_array_index(trace->stream_iterators,
	149	stream_iter_idx);
7cdc2bab	150
14f28187	151	if (stream_iter->msg_iter) {
7cdc2bab MD	152	continue;
7cdc2bab MD	153	}
14f28187 FD	154	ctf_tc = ctf_metadata_decoder_borrow_ctf_trace_class(
	155	trace->metadata->decoder);
	156	stream_iter->msg_iter = bt_msg_iter_create(ctf_tc,
7cdc2bab	157	lttng_live->max_query_size, medops,
eb7f6c4f	158	stream_iter, log_level, NULL);
14f28187	159	if (!stream_iter->msg_iter) {
7cdc2bab MD	160	goto error;
	161	}
	162	}
	163	}
	164
d6e69534	165	session->lazy_stream_msg_init = false;
7cdc2bab	166
14f28187	167	return LTTNG_LIVE_ITERATOR_STATUS_OK;
7cdc2bab MD	168
7cdc2bab MD	169	error:
14f28187	170	return LTTNG_LIVE_ITERATOR_STATUS_ERROR;
7cdc2bab MD	171	}
	172
	173	BT_HIDDEN
	174	struct lttng_live_stream_iterator *lttng_live_stream_iterator_create(
	175	struct lttng_live_session *session,
	176	uint64_t ctf_trace_id,
	177	uint64_t stream_id)
	178	{
14f28187 FD	179	struct lttng_live_stream_iterator *stream_iter;
14f28187 FD	180	struct lttng_live_component *lttng_live;
7cdc2bab	181	struct lttng_live_trace *trace;
c01594de	182	bt_logging_level log_level;
7cdc2bab	183
14f28187 FD	184	BT_ASSERT(session);
	185	BT_ASSERT(session->lttng_live_msg_iter);
	186	BT_ASSERT(session->lttng_live_msg_iter->lttng_live_comp);
c01594de	187	log_level = session->log_level;
14f28187 FD	188
	189	lttng_live = session->lttng_live_msg_iter->lttng_live_comp;
	190
	191	stream_iter = g_new0(struct lttng_live_stream_iterator, 1);
	192	if (!stream_iter) {
	193	goto error;
	194	}
	195
c01594de	196	stream_iter->log_level = log_level;
14f28187	197	trace = lttng_live_borrow_trace(session, ctf_trace_id);
7cdc2bab MD	198	if (!trace) {
	199	goto error;
	200	}
	201
14f28187 FD	202	stream_iter->trace = trace;
	203	stream_iter->state = LTTNG_LIVE_STREAM_ACTIVE_NO_DATA;
	204	stream_iter->viewer_stream_id = stream_id;
	205	stream_iter->ctf_stream_class_id = -1ULL;
	206	stream_iter->last_inactivity_ts = INT64_MIN;
7cdc2bab MD	207
7cdc2bab MD	208	if (trace->trace) {
14f28187 FD	209	struct ctf_trace_class *ctf_tc =
	210	ctf_metadata_decoder_borrow_ctf_trace_class(
	211	trace->metadata->decoder);
	212	BT_ASSERT(!stream_iter->msg_iter);
	213	stream_iter->msg_iter = bt_msg_iter_create(ctf_tc,
7cdc2bab	214	lttng_live->max_query_size, medops,
eb7f6c4f	215	stream_iter, log_level, NULL);
14f28187	216	if (!stream_iter->msg_iter) {
7cdc2bab MD	217	goto error;
	218	}
	219	}
14f28187 FD	220	stream_iter->buf = g_new0(uint8_t, lttng_live->max_query_size);
	221	if (!stream_iter->buf) {
	222	goto error;
	223	}
7cdc2bab	224
14f28187 FD	225	stream_iter->buflen = lttng_live->max_query_size;
	226	stream_iter->name = g_string_new(NULL);
	227	if (!stream_iter->name) {
	228	goto error;
	229	}
	230
	231	g_string_printf(stream_iter->name, STREAM_NAME_PREFIX "%" PRIu64,
	232	stream_iter->viewer_stream_id);
	233	g_ptr_array_add(trace->stream_iterators, stream_iter);
7cdc2bab	234
14f28187 FD	235	/* Track the number of active stream iterator. */
14f28187 FD	236	session->lttng_live_msg_iter->active_stream_iter++;
7cdc2bab MD	237
	238	goto end;
	239	error:
14f28187 FD	240	lttng_live_stream_iterator_destroy(stream_iter);
14f28187 FD	241	stream_iter = NULL;
7cdc2bab	242	end:
14f28187	243	return stream_iter;
7cdc2bab MD	244	}
	245
	246	BT_HIDDEN
14f28187 FD	247	void lttng_live_stream_iterator_destroy(
14f28187 FD	248	struct lttng_live_stream_iterator *stream_iter)
7cdc2bab	249	{
14f28187	250	if (!stream_iter) {
7cdc2bab MD	251	return;
	252	}
	253
14f28187 FD	254	if (stream_iter->stream) {
14f28187 FD	255	BT_STREAM_PUT_REF_AND_RESET(stream_iter->stream);
7cdc2bab MD	256	}
7cdc2bab MD	257
14f28187 FD	258	if (stream_iter->msg_iter) {
14f28187 FD	259	bt_msg_iter_destroy(stream_iter->msg_iter);
7cdc2bab	260	}
14f28187 FD	261	if (stream_iter->buf) {
	262	g_free(stream_iter->buf);
	263	}
	264	if (stream_iter->name) {
	265	g_string_free(stream_iter->name, TRUE);
	266	}
	267
	268	bt_message_put_ref(stream_iter->current_msg);
	269
	270	/* Track the number of active stream iterator. */
	271	stream_iter->trace->session->lttng_live_msg_iter->active_stream_iter--;
	272
7cdc2bab MD	273	/*
	274	* Ensure we poke the trace metadata in the future, which is
	275	* required to release the metadata reference on the trace.
	276	*/
14f28187 FD	277	stream_iter->trace->new_metadata_needed = true;
14f28187 FD	278	g_free(stream_iter);
7cdc2bab	279	}