[babeltrace.git] / 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_TAG "PLUGIN-CTF-LTTNG-LIVE-SRC-DS"
#include "logging.h"

#include <stdio.h>
#include <stdint.h>
#include <stdlib.h>
#include <stdbool.h>
#include <glib.h>
#include <inttypes.h>
#include <babeltrace/compat/mman-internal.h>
#include <babeltrace/babeltrace.h>
#include "../common/msg-iter/msg-iter.h"
#include <babeltrace/assert-internal.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;

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

		BT_LOGD("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;

	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);
			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_ASSERT(session);
	BT_ASSERT(session->lttng_live_msg_iter);
	BT_ASSERT(session->lttng_live_msg_iter->lttng_live_comp);

	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;
	}

	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);
		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	/*
bb18709b	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
020bc26f PP	26	#define BT_LOG_TAG "PLUGIN-CTF-LTTNG-LIVE-SRC-DS"
	27	#include "logging.h"
	28
7cdc2bab MD	29	#include <stdio.h>
	30	#include <stdint.h>
	31	#include <stdlib.h>
	32	#include <stdbool.h>
	33	#include <glib.h>
	34	#include <inttypes.h>
8f76831a	35	#include <babeltrace/compat/mman-internal.h>
e0831b38	36	#include <babeltrace/babeltrace.h>
b09a5592	37	#include "../common/msg-iter/msg-iter.h"
8b45963b	38	#include <babeltrace/assert-internal.h>
7cdc2bab	39
087bc060	40	#include "data-stream.h"
7cdc2bab	41
bb18709b FD	42	#define STREAM_NAME_PREFIX "stream-"
bb18709b FD	43
7cdc2bab	44	static
b09a5592	45	enum bt_msg_iter_medium_status medop_request_bytes(
7cdc2bab MD	46	size_t request_sz, uint8_t **buffer_addr,
	47	size_t buffer_sz, void data)
	48	{
b09a5592 PP	49	enum bt_msg_iter_medium_status status =
b09a5592 PP	50	BT_MSG_ITER_MEDIUM_STATUS_OK;
7cdc2bab MD	51	struct lttng_live_stream_iterator *stream = data;
	52	struct lttng_live_trace *trace = stream->trace;
	53	struct lttng_live_session *session = trace->session;
bb18709b	54	struct lttng_live_msg_iter *live_msg_iter = session->lttng_live_msg_iter;
7cdc2bab MD	55	uint64_t recv_len = 0;
	56	uint64_t len_left;
	57	uint64_t read_len;
7cdc2bab MD	58
	59	len_left = stream->base_offset + stream->len - stream->offset;
	60	if (!len_left) {
	61	stream->state = LTTNG_LIVE_STREAM_ACTIVE_NO_DATA;
b09a5592	62	status = BT_MSG_ITER_MEDIUM_STATUS_AGAIN;
7cdc2bab MD	63	return status;
	64	}
	65	read_len = MIN(request_sz, stream->buflen);
	66	read_len = MIN(read_len, len_left);
bb18709b	67	status = lttng_live_get_stream_bytes(live_msg_iter,
7cdc2bab MD	68	stream, stream->buf, stream->offset,
7cdc2bab MD	69	read_len, &recv_len);
7cdc2bab MD	70	*buffer_addr = stream->buf;
	71	*buffer_sz = recv_len;
	72	stream->offset += recv_len;
	73	return status;
	74	}
	75
	76	static
bb18709b FD	77	bt_stream medop_borrow_stream(bt_stream_class stream_class,
bb18709b FD	78	int64_t stream_id, void *data)
7cdc2bab MD	79	{
7cdc2bab MD	80	struct lttng_live_stream_iterator *lttng_live_stream = data;
7cdc2bab MD	81
7cdc2bab MD	82	if (!lttng_live_stream->stream) {
bb18709b	83	uint64_t stream_class_id = bt_stream_class_get_id(stream_class);
0659c536	84
bb18709b FD	85	BT_LOGD("Creating stream %s (ID: %" PRIu64 ") out of stream "
	86	"class %" PRId64, lttng_live_stream->name->str,
	87	stream_id, stream_class_id);
0659c536	88
bb18709b FD	89	if (stream_id < 0) {
	90	/*
	91	* No stream instance ID in the stream. It's possible
	92	* to encounter this situation with older version of
	93	* LTTng. In these cases, use the viewer_stream_id that
	94	* is unique for a live viewer session.
	95	*/
	96	lttng_live_stream->stream = bt_stream_create_with_id(
	97	stream_class, lttng_live_stream->trace->trace,
	98	lttng_live_stream->viewer_stream_id);
0659c536	99	} else {
bb18709b FD	100	lttng_live_stream->stream = bt_stream_create_with_id(
	101	stream_class, lttng_live_stream->trace->trace,
	102	(uint64_t) stream_id);
0659c536	103	}
7cdc2bab	104
7cdc2bab	105	if (!lttng_live_stream->stream) {
bb18709b FD	106	BT_LOGE("Cannot create stream %s (stream class ID "
	107	"%" PRId64 ", stream ID %" PRIu64 ")",
	108	lttng_live_stream->name->str,
	109	stream_class_id, stream_id);
7cdc2bab	110	}
bb18709b FD	111	bt_stream_set_name(lttng_live_stream->stream,
bb18709b FD	112	lttng_live_stream->name->str);
7cdc2bab MD	113	}
	114
	115	return lttng_live_stream->stream;
	116	}
	117
b09a5592	118	static struct bt_msg_iter_medium_ops medops = {
7cdc2bab	119	.request_bytes = medop_request_bytes,
bb18709b FD	120	.seek = NULL,
bb18709b FD	121	.borrow_stream = medop_borrow_stream,
7cdc2bab MD	122	};
	123
	124	BT_HIDDEN
bb18709b	125	enum lttng_live_iterator_status lttng_live_lazy_msg_init(
7cdc2bab MD	126	struct lttng_live_session *session)
7cdc2bab MD	127	{
bb18709b FD	128	struct lttng_live_component *lttng_live =
	129	session->lttng_live_msg_iter->lttng_live_comp;
	130	uint64_t trace_idx, stream_iter_idx;
7cdc2bab	131
b09a5592	132	if (!session->lazy_stream_msg_init) {
bb18709b	133	return LTTNG_LIVE_ITERATOR_STATUS_OK;
7cdc2bab MD	134	}
7cdc2bab MD	135
bb18709b FD	136	for (trace_idx = 0; trace_idx < session->traces->len; trace_idx++) {
	137	struct lttng_live_trace *trace =
	138	g_ptr_array_index(session->traces, trace_idx);
	139
	140	for (stream_iter_idx = 0;
	141	stream_iter_idx < trace->stream_iterators->len;
	142	stream_iter_idx++) {
	143	struct ctf_trace_class *ctf_tc;
	144	struct lttng_live_stream_iterator *stream_iter =
	145	g_ptr_array_index(trace->stream_iterators,
	146	stream_iter_idx);
7cdc2bab	147
bb18709b	148	if (stream_iter->msg_iter) {
7cdc2bab MD	149	continue;
7cdc2bab MD	150	}
bb18709b FD	151	ctf_tc = ctf_metadata_decoder_borrow_ctf_trace_class(
	152	trace->metadata->decoder);
	153	stream_iter->msg_iter = bt_msg_iter_create(ctf_tc,
7cdc2bab	154	lttng_live->max_query_size, medops,
bb18709b FD	155	stream_iter);
bb18709b FD	156	if (!stream_iter->msg_iter) {
7cdc2bab MD	157	goto error;
	158	}
	159	}
	160	}
	161
b09a5592	162	session->lazy_stream_msg_init = false;
7cdc2bab	163
bb18709b	164	return LTTNG_LIVE_ITERATOR_STATUS_OK;
7cdc2bab MD	165
7cdc2bab MD	166	error:
bb18709b	167	return LTTNG_LIVE_ITERATOR_STATUS_ERROR;
7cdc2bab MD	168	}
	169
	170	BT_HIDDEN
	171	struct lttng_live_stream_iterator *lttng_live_stream_iterator_create(
	172	struct lttng_live_session *session,
	173	uint64_t ctf_trace_id,
	174	uint64_t stream_id)
	175	{
bb18709b FD	176	struct lttng_live_stream_iterator *stream_iter;
bb18709b FD	177	struct lttng_live_component *lttng_live;
7cdc2bab	178	struct lttng_live_trace *trace;
7cdc2bab	179
bb18709b FD	180	BT_ASSERT(session);
	181	BT_ASSERT(session->lttng_live_msg_iter);
	182	BT_ASSERT(session->lttng_live_msg_iter->lttng_live_comp);
	183
	184	lttng_live = session->lttng_live_msg_iter->lttng_live_comp;
	185
	186	stream_iter = g_new0(struct lttng_live_stream_iterator, 1);
	187	if (!stream_iter) {
	188	goto error;
	189	}
	190
	191	trace = lttng_live_borrow_trace(session, ctf_trace_id);
7cdc2bab MD	192	if (!trace) {
	193	goto error;
	194	}
	195
bb18709b FD	196	stream_iter->trace = trace;
	197	stream_iter->state = LTTNG_LIVE_STREAM_ACTIVE_NO_DATA;
	198	stream_iter->viewer_stream_id = stream_id;
	199	stream_iter->ctf_stream_class_id = -1ULL;
	200	stream_iter->last_inactivity_ts = INT64_MIN;
7cdc2bab MD	201
7cdc2bab MD	202	if (trace->trace) {
bb18709b FD	203	struct ctf_trace_class *ctf_tc =
	204	ctf_metadata_decoder_borrow_ctf_trace_class(
	205	trace->metadata->decoder);
	206	BT_ASSERT(!stream_iter->msg_iter);
	207	stream_iter->msg_iter = bt_msg_iter_create(ctf_tc,
7cdc2bab	208	lttng_live->max_query_size, medops,
bb18709b FD	209	stream_iter);
bb18709b FD	210	if (!stream_iter->msg_iter) {
7cdc2bab MD	211	goto error;
	212	}
	213	}
bb18709b FD	214	stream_iter->buf = g_new0(uint8_t, lttng_live->max_query_size);
	215	if (!stream_iter->buf) {
	216	goto error;
	217	}
7cdc2bab	218
bb18709b FD	219	stream_iter->buflen = lttng_live->max_query_size;
	220	stream_iter->name = g_string_new(NULL);
	221	if (!stream_iter->name) {
	222	goto error;
	223	}
	224
	225	g_string_printf(stream_iter->name, STREAM_NAME_PREFIX "%" PRIu64,
	226	stream_iter->viewer_stream_id);
	227	g_ptr_array_add(trace->stream_iterators, stream_iter);
7cdc2bab	228
bb18709b FD	229	/* Track the number of active stream iterator. */
bb18709b FD	230	session->lttng_live_msg_iter->active_stream_iter++;
7cdc2bab MD	231
	232	goto end;
	233	error:
bb18709b FD	234	lttng_live_stream_iterator_destroy(stream_iter);
bb18709b FD	235	stream_iter = NULL;
7cdc2bab	236	end:
bb18709b	237	return stream_iter;
7cdc2bab MD	238	}
	239
	240	BT_HIDDEN
bb18709b FD	241	void lttng_live_stream_iterator_destroy(
bb18709b FD	242	struct lttng_live_stream_iterator *stream_iter)
7cdc2bab	243	{
bb18709b	244	if (!stream_iter) {
7cdc2bab MD	245	return;
	246	}
	247
bb18709b FD	248	if (stream_iter->stream) {
bb18709b FD	249	BT_STREAM_PUT_REF_AND_RESET(stream_iter->stream);
7cdc2bab MD	250	}
7cdc2bab MD	251
bb18709b FD	252	if (stream_iter->msg_iter) {
bb18709b FD	253	bt_msg_iter_destroy(stream_iter->msg_iter);
7cdc2bab	254	}
bb18709b FD	255	if (stream_iter->buf) {
	256	g_free(stream_iter->buf);
	257	}
	258	if (stream_iter->name) {
	259	g_string_free(stream_iter->name, TRUE);
	260	}
	261
	262	bt_message_put_ref(stream_iter->current_msg);
	263
	264	/* Track the number of active stream iterator. */
	265	stream_iter->trace->session->lttng_live_msg_iter->active_stream_iter--;
	266
7cdc2bab MD	267	/*
	268	* Ensure we poke the trace metadata in the future, which is
	269	* required to release the metadata reference on the trace.
	270	*/
bb18709b FD	271	stream_iter->trace->new_metadata_needed = true;
bb18709b FD	272	g_free(stream_iter);
7cdc2bab	273	}