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

/*
 * Copyright 2019 - Francis Deslauriers <francis.deslauriers@efficios.com>
 * Copyright 2016 - Philippe Proulx <pproulx@efficios.com>
 * Copyright 2010-2011 - EfficiOS Inc. and Linux Foundation
 *
 * Some functions are based on older functions written by Mathieu Desnoyers.
 *
 * 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/META"
#include "logging/log.h"

#include <stdio.h>
#include <stdint.h>
#include <stdlib.h>
#include <stdbool.h>
#include <glib.h>
#include "compat/memstream.h"
#include <babeltrace2/babeltrace.h>

#include "metadata.h"
#include "../common/metadata/decoder.h"

#define TSDL_MAGIC	0x75d11d57

struct packet_header {
	uint32_t magic;
	uint8_t  uuid[16];
	uint32_t checksum;
	uint32_t content_size;
	uint32_t packet_size;
	uint8_t  compression_scheme;
	uint8_t  encryption_scheme;
	uint8_t  checksum_scheme;
	uint8_t  major;
	uint8_t  minor;
} __attribute__((__packed__));


static
bool stream_classes_all_have_default_clock_class(bt_trace_class *tc,
		bt_logging_level log_level)
{
	uint64_t i, sc_count;
	const bt_clock_class *cc = NULL;
	const bt_stream_class *sc;
	bool ret = true;

	sc_count = bt_trace_class_get_stream_class_count(tc);
	for (i = 0; i < sc_count; i++) {
		sc = bt_trace_class_borrow_stream_class_by_index_const(tc, i);

		BT_ASSERT(sc);

		cc = bt_stream_class_borrow_default_clock_class_const(sc);
		if (!cc) {
			ret = false;
			BT_LOGE("Stream class doesn't have a default clock class: "
				"sc-id=%" PRIu64 ", sc-name=\"%s\"",
				bt_stream_class_get_id(sc),
				bt_stream_class_get_name(sc));
			goto end;
		}
	}

end:
	return ret;
}
/*
 * Iterate over the stream classes and returns the first clock class
 * encountered. This is useful to create message iterator inactivity message as
 * we don't need a particular clock class.
 */
static
const bt_clock_class *borrow_any_clock_class(bt_trace_class *tc)
{
	uint64_t i, sc_count;
	const bt_clock_class *cc = NULL;
	const bt_stream_class *sc;

	sc_count = bt_trace_class_get_stream_class_count(tc);
	for (i = 0; i < sc_count; i++) {
		sc = bt_trace_class_borrow_stream_class_by_index_const(tc, i);
		BT_ASSERT(sc);

		cc = bt_stream_class_borrow_default_clock_class_const(sc);
		if (cc) {
			goto end;
		}
	}
end:
	BT_ASSERT(cc);
	return cc;
}

BT_HIDDEN
enum lttng_live_iterator_status lttng_live_metadata_update(
		struct lttng_live_trace *trace)
{
	struct lttng_live_session *session = trace->session;
	struct lttng_live_metadata *metadata = trace->metadata;
	struct lttng_live_component *lttng_live =
		session->lttng_live_msg_iter->lttng_live_comp;
	ssize_t ret = 0;
	size_t size, len_read = 0;
	char *metadata_buf = NULL;
	FILE *fp = NULL;
	enum ctf_metadata_decoder_status decoder_status;
	enum lttng_live_iterator_status status =
		LTTNG_LIVE_ITERATOR_STATUS_OK;
	bt_logging_level log_level = trace->log_level;

	/* No metadata stream yet. */
	if (!metadata) {
		if (session->new_streams_needed) {
			status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN;
		} else {
			session->new_streams_needed = true;
			status = LTTNG_LIVE_ITERATOR_STATUS_CONTINUE;
		}
		goto end;
	}

	if (!metadata->trace) {
		trace->new_metadata_needed = false;
	}

	if (!trace->new_metadata_needed) {
		goto end;
	}

	/* Open for writing */
	fp = bt_open_memstream(&metadata_buf, &size);
	if (!fp) {
		BT_LOGE("Metadata open_memstream: %s", strerror(errno));
		goto error;
	}

	/* Grab all available metadata. */
	do {
		/*
		 * get_one_metadata_packet returns the number of bytes
		 * received, 0 when we have received everything, a
		 * negative value on error.
		 */
		ret = lttng_live_get_one_metadata_packet(trace, fp);
		if (ret > 0) {
			len_read += ret;
		}
	} while (ret > 0);

	/*
	 * Consider metadata closed as soon as we get an error reading
	 * it (e.g. cannot be found).
	 */
	if (ret < 0) {
		if (!metadata->closed) {
			metadata->closed = true;
			/*
			 * Release our reference on the trace as soon as
			 * we know the metadata stream is not available
			 * anymore. This won't necessarily teardown the
			 * metadata objects immediately, but only when
			 * the data streams are done.
			 */
			metadata->trace = NULL;
		}
		if (errno == EINTR) {
			if (lttng_live_graph_is_canceled(lttng_live)) {
				status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN;
				goto end;
			}
		}
	}

	if (bt_close_memstream(&metadata_buf, &size, fp)) {
		BT_LOGE("bt_close_memstream: %s", strerror(errno));
	}
	ret = 0;
	fp = NULL;

	if (len_read == 0) {
		if (!trace->trace) {
			status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN;
			goto end;
		}
		trace->new_metadata_needed = false;
		goto end;
	}

	fp = bt_fmemopen(metadata_buf, len_read, "rb");
	if (!fp) {
		BT_LOGE("Cannot memory-open metadata buffer: %s",
			strerror(errno));
		goto error;
	}

	/*
	 * The call to ctf_metadata_decoder_decode will append new metadata to
	 * our current trace class.
	 */
	decoder_status = ctf_metadata_decoder_decode(metadata->decoder, fp);
	switch (decoder_status) {
	case CTF_METADATA_DECODER_STATUS_OK:
		if (!trace->trace_class) {
			trace->trace_class =
				ctf_metadata_decoder_get_ir_trace_class(
						metadata->decoder);
			trace->trace = bt_trace_create(trace->trace_class);
			if (!stream_classes_all_have_default_clock_class(
					trace->trace_class, log_level)) {
				/* Error logged in function. */
				goto error;
			}
			trace->clock_class =
				borrow_any_clock_class(trace->trace_class);
		}
		trace->new_metadata_needed = false;

		break;
	case CTF_METADATA_DECODER_STATUS_INCOMPLETE:
		status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN;
		break;
	case CTF_METADATA_DECODER_STATUS_ERROR:
	case CTF_METADATA_DECODER_STATUS_INVAL_VERSION:
	case CTF_METADATA_DECODER_STATUS_IR_VISITOR_ERROR:
		goto error;
	}

	goto end;
error:
	status = LTTNG_LIVE_ITERATOR_STATUS_ERROR;
end:
	if (fp) {
		int closeret;

		closeret = fclose(fp);
		if (closeret) {
			BT_LOGE("Error on fclose");
		}
	}
	free(metadata_buf);
	return status;
}

BT_HIDDEN
int lttng_live_metadata_create_stream(struct lttng_live_session *session,
		uint64_t ctf_trace_id,
		uint64_t stream_id,
		const char *trace_name)
{
	struct lttng_live_component *lttng_live =
		session->lttng_live_msg_iter->lttng_live_comp;
	struct lttng_live_metadata *metadata = NULL;
	struct lttng_live_trace *trace;
	const char *match;
	struct ctf_metadata_decoder_config cfg = {
		.log_level = session->log_level,
		.clock_class_offset_s = 0,
		.clock_class_offset_ns = 0,
	};

	metadata = g_new0(struct lttng_live_metadata, 1);
	if (!metadata) {
		return -1;
	}
	metadata->log_level = session->log_level;
	metadata->stream_id = stream_id;

	match = strstr(trace_name, session->session_name->str);
	if (!match) {
		goto error;
	}

	metadata->decoder = ctf_metadata_decoder_create(
				lttng_live->self_comp, &cfg);
	if (!metadata->decoder) {
		goto error;
	}
	trace = lttng_live_borrow_trace(session, ctf_trace_id);
	if (!trace) {
		goto error;
	}
	metadata->trace = trace;
	trace->metadata = metadata;
	return 0;

error:
	ctf_metadata_decoder_destroy(metadata->decoder);
	g_free(metadata);
	return -1;
}

BT_HIDDEN
void lttng_live_metadata_fini(struct lttng_live_trace *trace)
{
	struct lttng_live_metadata *metadata = trace->metadata;

	if (!metadata) {
		return;
	}
	ctf_metadata_decoder_destroy(metadata->decoder);
	trace->metadata = NULL;
	g_free(metadata);
}
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 2010-2011 - EfficiOS Inc. and Linux Foundation
	5	*
	6	* Some functions are based on older functions written by Mathieu Desnoyers.
	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
c01594de	27	#define BT_LOG_OUTPUT_LEVEL log_level
350ad6c1	28	#define BT_LOG_TAG "PLUGIN/SRC.CTF.LTTNG-LIVE/META"
c01594de	29	#include "logging/log.h"
020bc26f	30
7cdc2bab MD	31	#include <stdio.h>
	32	#include <stdint.h>
	33	#include <stdlib.h>
	34	#include <stdbool.h>
	35	#include <glib.h>
578e048b	36	#include "compat/memstream.h"
3fadfbc0	37	#include <babeltrace2/babeltrace.h>
7cdc2bab	38
7cdc2bab MD	39	#include "metadata.h"
	40	#include "../common/metadata/decoder.h"
	41
	42	#define TSDL_MAGIC 0x75d11d57
	43
	44	struct packet_header {
	45	uint32_t magic;
	46	uint8_t uuid[16];
	47	uint32_t checksum;
	48	uint32_t content_size;
	49	uint32_t packet_size;
	50	uint8_t compression_scheme;
	51	uint8_t encryption_scheme;
	52	uint8_t checksum_scheme;
	53	uint8_t major;
	54	uint8_t minor;
	55	} __attribute__((__packed__));
	56
14f28187	57
7cdc2bab	58	static
c01594de PP	59	bool stream_classes_all_have_default_clock_class(bt_trace_class *tc,
c01594de PP	60	bt_logging_level log_level)
7cdc2bab	61	{
14f28187 FD	62	uint64_t i, sc_count;
	63	const bt_clock_class *cc = NULL;
	64	const bt_stream_class *sc;
	65	bool ret = true;
7cdc2bab	66
14f28187 FD	67	sc_count = bt_trace_class_get_stream_class_count(tc);
	68	for (i = 0; i < sc_count; i++) {
	69	sc = bt_trace_class_borrow_stream_class_by_index_const(tc, i);
7cdc2bab	70
14f28187	71	BT_ASSERT(sc);
7cdc2bab	72
14f28187 FD	73	cc = bt_stream_class_borrow_default_clock_class_const(sc);
	74	if (!cc) {
	75	ret = false;
	76	BT_LOGE("Stream class doesn't have a default clock class: "
	77	"sc-id=%" PRIu64 ", sc-name=\"%s\"",
	78	bt_stream_class_get_id(sc),
	79	bt_stream_class_get_name(sc));
	80	goto end;
7cdc2bab MD	81	}
	82	}
	83
7cdc2bab	84	end:
14f28187 FD	85	return ret;
	86	}
	87	/*
	88	* Iterate over the stream classes and returns the first clock class
	89	* encountered. This is useful to create message iterator inactivity message as
	90	* we don't need a particular clock class.
	91	*/
	92	static
	93	const bt_clock_class borrow_any_clock_class(bt_trace_class tc)
	94	{
	95	uint64_t i, sc_count;
	96	const bt_clock_class *cc = NULL;
	97	const bt_stream_class *sc;
	98
	99	sc_count = bt_trace_class_get_stream_class_count(tc);
	100	for (i = 0; i < sc_count; i++) {
	101	sc = bt_trace_class_borrow_stream_class_by_index_const(tc, i);
	102	BT_ASSERT(sc);
	103
	104	cc = bt_stream_class_borrow_default_clock_class_const(sc);
	105	if (cc) {
	106	goto end;
	107	}
	108	}
	109	end:
	110	BT_ASSERT(cc);
	111	return cc;
7cdc2bab MD	112	}
	113
	114	BT_HIDDEN
14f28187	115	enum lttng_live_iterator_status lttng_live_metadata_update(
7cdc2bab MD	116	struct lttng_live_trace *trace)
	117	{
	118	struct lttng_live_session *session = trace->session;
7cdc2bab	119	struct lttng_live_metadata *metadata = trace->metadata;
14f28187 FD	120	struct lttng_live_component *lttng_live =
14f28187 FD	121	session->lttng_live_msg_iter->lttng_live_comp;
7cdc2bab MD	122	ssize_t ret = 0;
	123	size_t size, len_read = 0;
	124	char *metadata_buf = NULL;
	125	FILE *fp = NULL;
	126	enum ctf_metadata_decoder_status decoder_status;
14f28187 FD	127	enum lttng_live_iterator_status status =
14f28187 FD	128	LTTNG_LIVE_ITERATOR_STATUS_OK;
c01594de	129	bt_logging_level log_level = trace->log_level;
7cdc2bab MD	130
	131	/* No metadata stream yet. */
	132	if (!metadata) {
	133	if (session->new_streams_needed) {
14f28187	134	status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN;
7cdc2bab MD	135	} else {
7cdc2bab MD	136	session->new_streams_needed = true;
14f28187	137	status = LTTNG_LIVE_ITERATOR_STATUS_CONTINUE;
7cdc2bab MD	138	}
	139	goto end;
	140	}
	141
6f79a7cf MD	142	if (!metadata->trace) {
	143	trace->new_metadata_needed = false;
	144	}
	145
7cdc2bab MD	146	if (!trace->new_metadata_needed) {
	147	goto end;
	148	}
	149
	150	/* Open for writing */
	151	fp = bt_open_memstream(&metadata_buf, &size);
	152	if (!fp) {
087bc060	153	BT_LOGE("Metadata open_memstream: %s", strerror(errno));
7cdc2bab MD	154	goto error;
	155	}
	156
	157	/* Grab all available metadata. */
	158	do {
	159	/*
	160	* get_one_metadata_packet returns the number of bytes
	161	* received, 0 when we have received everything, a
	162	* negative value on error.
	163	*/
	164	ret = lttng_live_get_one_metadata_packet(trace, fp);
	165	if (ret > 0) {
	166	len_read += ret;
	167	}
	168	} while (ret > 0);
	169
	170	/*
	171	* Consider metadata closed as soon as we get an error reading
	172	* it (e.g. cannot be found).
	173	*/
	174	if (ret < 0) {
	175	if (!metadata->closed) {
	176	metadata->closed = true;
	177	/*
	178	* Release our reference on the trace as soon as
	179	* we know the metadata stream is not available
	180	* anymore. This won't necessarily teardown the
	181	* metadata objects immediately, but only when
	182	* the data streams are done.
	183	*/
6f79a7cf	184	metadata->trace = NULL;
7cdc2bab	185	}
4c66436f	186	if (errno == EINTR) {
42521b69	187	if (lttng_live_graph_is_canceled(lttng_live)) {
14f28187	188	status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN;
4c66436f MD	189	goto end;
	190	}
	191	}
7cdc2bab MD	192	}
	193
	194	if (bt_close_memstream(&metadata_buf, &size, fp)) {
	195	BT_LOGE("bt_close_memstream: %s", strerror(errno));
	196	}
	197	ret = 0;
	198	fp = NULL;
	199
	200	if (len_read == 0) {
	201	if (!trace->trace) {
14f28187	202	status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN;
7cdc2bab MD	203	goto end;
	204	}
	205	trace->new_metadata_needed = false;
	206	goto end;
	207	}
	208
7cdc2bab MD	209	fp = bt_fmemopen(metadata_buf, len_read, "rb");
7cdc2bab MD	210	if (!fp) {
087bc060	211	BT_LOGE("Cannot memory-open metadata buffer: %s",
7cdc2bab MD	212	strerror(errno));
	213	goto error;
	214	}
	215
14f28187 FD	216	/*
	217	* The call to ctf_metadata_decoder_decode will append new metadata to
	218	* our current trace class.
	219	*/
7cdc2bab MD	220	decoder_status = ctf_metadata_decoder_decode(metadata->decoder, fp);
	221	switch (decoder_status) {
	222	case CTF_METADATA_DECODER_STATUS_OK:
14f28187 FD	223	if (!trace->trace_class) {
	224	trace->trace_class =
	225	ctf_metadata_decoder_get_ir_trace_class(
	226	metadata->decoder);
	227	trace->trace = bt_trace_create(trace->trace_class);
	228	if (!stream_classes_all_have_default_clock_class(
c01594de	229	trace->trace_class, log_level)) {
14f28187 FD	230	/* Error logged in function. */
	231	goto error;
	232	}
	233	trace->clock_class =
	234	borrow_any_clock_class(trace->trace_class);
7cdc2bab	235	}
14f28187 FD	236	trace->new_metadata_needed = false;
14f28187 FD	237
7cdc2bab MD	238	break;
7cdc2bab MD	239	case CTF_METADATA_DECODER_STATUS_INCOMPLETE:
14f28187	240	status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN;
7cdc2bab MD	241	break;
	242	case CTF_METADATA_DECODER_STATUS_ERROR:
	243	case CTF_METADATA_DECODER_STATUS_INVAL_VERSION:
	244	case CTF_METADATA_DECODER_STATUS_IR_VISITOR_ERROR:
	245	goto error;
	246	}
	247
	248	goto end;
	249	error:
14f28187	250	status = LTTNG_LIVE_ITERATOR_STATUS_ERROR;
7cdc2bab MD	251	end:
	252	if (fp) {
	253	int closeret;
	254
	255	closeret = fclose(fp);
	256	if (closeret) {
087bc060	257	BT_LOGE("Error on fclose");
7cdc2bab MD	258	}
7cdc2bab MD	259	}
6f79a7cf	260	free(metadata_buf);
7cdc2bab MD	261	return status;
	262	}
	263
	264	BT_HIDDEN
	265	int lttng_live_metadata_create_stream(struct lttng_live_session *session,
	266	uint64_t ctf_trace_id,
06994c71 MD	267	uint64_t stream_id,
06994c71 MD	268	const char *trace_name)
7cdc2bab	269	{
14f28187 FD	270	struct lttng_live_component *lttng_live =
14f28187 FD	271	session->lttng_live_msg_iter->lttng_live_comp;
7cdc2bab MD	272	struct lttng_live_metadata *metadata = NULL;
7cdc2bab MD	273	struct lttng_live_trace *trace;
06994c71	274	const char *match;
0746848c	275	struct ctf_metadata_decoder_config cfg = {
c01594de	276	.log_level = session->log_level,
0746848c PP	277	.clock_class_offset_s = 0,
	278	.clock_class_offset_ns = 0,
	279	};
7cdc2bab MD	280
	281	metadata = g_new0(struct lttng_live_metadata, 1);
	282	if (!metadata) {
	283	return -1;
	284	}
c01594de	285	metadata->log_level = session->log_level;
7cdc2bab	286	metadata->stream_id = stream_id;
14f28187	287
06994c71 MD	288	match = strstr(trace_name, session->session_name->str);
	289	if (!match) {
	290	goto error;
	291	}
14f28187 FD	292
14f28187 FD	293	metadata->decoder = ctf_metadata_decoder_create(
0746848c	294	lttng_live->self_comp, &cfg);
7cdc2bab MD	295	if (!metadata->decoder) {
	296	goto error;
	297	}
14f28187	298	trace = lttng_live_borrow_trace(session, ctf_trace_id);
7cdc2bab MD	299	if (!trace) {
	300	goto error;
	301	}
	302	metadata->trace = trace;
	303	trace->metadata = metadata;
	304	return 0;
	305
	306	error:
	307	ctf_metadata_decoder_destroy(metadata->decoder);
	308	g_free(metadata);
	309	return -1;
	310	}
	311
	312	BT_HIDDEN
	313	void lttng_live_metadata_fini(struct lttng_live_trace *trace)
	314	{
	315	struct lttng_live_metadata *metadata = trace->metadata;
	316
	317	if (!metadata) {
	318	return;
	319	}
7cdc2bab MD	320	ctf_metadata_decoder_destroy(metadata->decoder);
7cdc2bab MD	321	trace->metadata = NULL;
7cdc2bab MD	322	g_free(metadata);
7cdc2bab MD	323	}