[babeltrace.git] / src / plugins / ctf / common / metadata / decoder.c

/*
 * SPDX-License-Identifier: MIT
 *
 * Copyright 2016-2017 Philippe Proulx <pproulx@efficios.com>
 */

#define BT_COMP_LOG_SELF_COMP (mdec->config.self_comp)
#define BT_LOG_OUTPUT_LEVEL (mdec->config.log_level)
#define BT_LOG_TAG "PLUGIN/CTF/META/DECODER"
#include "logging/comp-logging.h"

#include <stdio.h>
#include <stdbool.h>
#include <stdint.h>
#include <stdlib.h>
#include <inttypes.h>
#include "common/assert.h"
#include "common/uuid.h"
#include "compat/memstream.h"
#include <babeltrace2/babeltrace.h>
#include <glib.h>
#include <string.h>

#include "ast.h"
#include "decoder.h"
#include "scanner.h"
#include "logging.h"
#include "parser-wrap.h"

#define TSDL_MAGIC	0x75d11d57

struct ctf_metadata_decoder {
	struct ctf_scanner *scanner;
	GString *text;
	struct ctf_visitor_generate_ir *visitor;
	bt_uuid_t uuid;
	bool is_uuid_set;
	int bo;
	struct ctf_metadata_decoder_config config;
	struct meta_log_config log_cfg;
};

struct packet_header {
	uint32_t magic;
	bt_uuid_t  uuid;
	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__));

BT_HIDDEN
int ctf_metadata_decoder_packetized_file_stream_to_buf(FILE *fp,
		char **buf, int byte_order, bool *is_uuid_set,
		uint8_t *uuid, bt_logging_level log_level,
		bt_self_component *self_comp);

BT_HIDDEN
int ctf_metadata_decoder_is_packetized(FILE *fp, bool *is_packetized,
		int *byte_order, bt_logging_level log_level,
		bt_self_component *self_comp)
{
	uint32_t magic;
	size_t len;
	int ret = 0;

	*is_packetized = false;
	len = fread(&magic, sizeof(magic), 1, fp);
	if (len != 1) {
		BT_COMP_LOG_CUR_LVL(BT_LOG_INFO, log_level, self_comp,
			"Cannot read first metadata packet header: assuming the stream is not packetized.");
		ret = -1;
		goto end;
	}

	if (byte_order) {
		if (magic == TSDL_MAGIC) {
			*is_packetized = true;
			*byte_order = BYTE_ORDER;
		} else if (magic == GUINT32_SWAP_LE_BE(TSDL_MAGIC)) {
			*is_packetized = true;
			*byte_order = BYTE_ORDER == BIG_ENDIAN ?
				LITTLE_ENDIAN : BIG_ENDIAN;
		}
	}

end:
	rewind(fp);

	return ret;
}

BT_HIDDEN
struct ctf_metadata_decoder *ctf_metadata_decoder_create(
		const struct ctf_metadata_decoder_config *config)
{
	struct ctf_metadata_decoder *mdec =
		g_new0(struct ctf_metadata_decoder, 1);

	BT_ASSERT(config);
	BT_COMP_LOG_CUR_LVL(BT_LOG_DEBUG, config->log_level, config->self_comp,
		"Creating CTF metadata decoder: "
		"clock-class-offset-s=%" PRId64 ", "
		"clock-class-offset-ns=%" PRId64,
		config->clock_class_offset_s, config->clock_class_offset_ns);

	if (!mdec) {
		BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR, config->log_level,
			config->self_comp,
			"Failed to allocate one CTF metadata decoder.");
		goto end;
	}

	mdec->log_cfg.log_level = config->log_level;
	mdec->log_cfg.self_comp = config->self_comp;
	mdec->scanner = ctf_scanner_alloc();
	if (!mdec->scanner) {
		BT_COMP_LOGE("Cannot allocate a metadata lexical scanner: "
			"mdec-addr=%p", mdec);
		goto error;
	}

	mdec->text = g_string_new(NULL);
	if (!mdec->text) {
		BT_COMP_LOGE("Failed to allocate one GString: "
			"mdec-addr=%p", mdec);
		goto error;
	}

	mdec->bo = -1;
	mdec->config = *config;
	mdec->visitor = ctf_visitor_generate_ir_create(config);
	if (!mdec->visitor) {
		BT_COMP_LOGE("Failed to create a CTF IR metadata AST visitor: "
			"mdec-addr=%p", mdec);
		goto error;
	}

	BT_COMP_LOGD("Creating CTF metadata decoder: "
		"clock-class-offset-s=%" PRId64 ", "
		"clock-class-offset-ns=%" PRId64 ", addr=%p",
		config->clock_class_offset_s, config->clock_class_offset_ns,
		mdec);
	goto end;

error:
	ctf_metadata_decoder_destroy(mdec);
	mdec = NULL;

end:
	return mdec;
}

BT_HIDDEN
void ctf_metadata_decoder_destroy(struct ctf_metadata_decoder *mdec)
{
	if (!mdec) {
		return;
	}

	if (mdec->scanner) {
		ctf_scanner_free(mdec->scanner);
	}

	if (mdec->text) {
		g_string_free(mdec->text, TRUE);
	}

	BT_COMP_LOGD("Destroying CTF metadata decoder: addr=%p", mdec);
	ctf_visitor_generate_ir_destroy(mdec->visitor);
	g_free(mdec);
}

BT_HIDDEN
enum ctf_metadata_decoder_status ctf_metadata_decoder_append_content(
		struct ctf_metadata_decoder *mdec, FILE *fp)
{
	enum ctf_metadata_decoder_status status =
		CTF_METADATA_DECODER_STATUS_OK;
	int ret;
	char *buf = NULL;
	bool close_fp = false;
	long start_pos = -1;
	bool is_packetized;

	BT_ASSERT(mdec);
	ret = ctf_metadata_decoder_is_packetized(fp, &is_packetized, &mdec->bo,
			mdec->config.log_level, mdec->config.self_comp);
	if (ret) {
		status = CTF_METADATA_DECODER_STATUS_ERROR;
		goto end;
	}

	if (is_packetized) {
		BT_COMP_LOGI("Metadata stream is packetized: mdec-addr=%p", mdec);
		ret = ctf_metadata_decoder_packetized_file_stream_to_buf(fp,
			&buf, mdec->bo, &mdec->is_uuid_set,
			mdec->uuid, mdec->config.log_level,
			mdec->config.self_comp);
		if (ret) {
			BT_COMP_LOGE("Cannot decode packetized metadata packets to metadata text: "
				"mdec-addr=%p, ret=%d", mdec, ret);
			status = CTF_METADATA_DECODER_STATUS_ERROR;
			goto end;
		}

		if (strlen(buf) == 0) {
			/* An empty metadata packet is OK. */
			goto end;
		}

		/* Convert the real file pointer to a memory file pointer */
		fp = bt_fmemopen(buf, strlen(buf), "rb");
		close_fp = true;
		if (!fp) {
			BT_COMP_LOGE("Cannot memory-open metadata buffer: %s: "
				"mdec-addr=%p", strerror(errno), mdec);
			status = CTF_METADATA_DECODER_STATUS_ERROR;
			goto end;
		}
	} else {
		unsigned int major, minor;
		ssize_t nr_items;
		const long init_pos = ftell(fp);

		BT_COMP_LOGI("Metadata stream is plain text: mdec-addr=%p", mdec);

		if (init_pos < 0) {
			BT_COMP_LOGE_ERRNO("Failed to get current file position", ".");
			status = CTF_METADATA_DECODER_STATUS_ERROR;
			goto end;
		}

		/* Check text-only metadata header and version */
		nr_items = fscanf(fp, "/* CTF %10u.%10u", &major, &minor);
		if (nr_items < 2) {
			BT_COMP_LOGW("Missing \"/* CTF major.minor\" signature in plain text metadata file stream: "
				"mdec-addr=%p", mdec);
		}

		BT_COMP_LOGI("Found metadata stream version in signature: version=%u.%u", major, minor);

		if (!ctf_metadata_decoder_is_packet_version_valid(major,
				minor)) {
			BT_COMP_LOGE("Invalid metadata version found in plain text signature: "
				"version=%u.%u, mdec-addr=%p", major, minor,
				mdec);
			status = CTF_METADATA_DECODER_STATUS_INVAL_VERSION;
			goto end;
		}

		if (fseek(fp, init_pos, SEEK_SET)) {
			BT_COMP_LOGE("Cannot seek metadata file stream to initial position: %s: "
				"mdec-addr=%p", strerror(errno), mdec);
			status = CTF_METADATA_DECODER_STATUS_ERROR;
			goto end;
		}
	}

#if YYDEBUG
	if (BT_LOG_ON_TRACE) {
		yydebug = 1;
	}
#endif

	/* Save the file's position: we'll seek back to append the plain text */
	BT_ASSERT(fp);

	if (mdec->config.keep_plain_text) {
		start_pos = ftell(fp);
	}

	/* Append the metadata text content */
	ret = ctf_scanner_append_ast(mdec->scanner, fp);
	if (ret) {
		BT_COMP_LOGE("Cannot create the metadata AST out of the metadata text: "
			"mdec-addr=%p", mdec);
		status = CTF_METADATA_DECODER_STATUS_INCOMPLETE;
		goto end;
	}

	/* We know it's complete: append plain text */
	if (mdec->config.keep_plain_text) {
		BT_ASSERT(start_pos != -1);
		ret = fseek(fp, start_pos, SEEK_SET);
		if (ret) {
			BT_COMP_LOGE("Failed to seek file: ret=%d, mdec-addr=%p",
				ret, mdec);
			status = CTF_METADATA_DECODER_STATUS_ERROR;
			goto end;
		}

		ret = bt_common_append_file_content_to_g_string(mdec->text, fp);
		if (ret) {
			BT_COMP_LOGE("Failed to append to current plain text: "
				"ret=%d, mdec-addr=%p", ret, mdec);
			status = CTF_METADATA_DECODER_STATUS_ERROR;
			goto end;
		}
	}

	ret = ctf_visitor_semantic_check(0, &mdec->scanner->ast->root,
		&mdec->log_cfg);
	if (ret) {
		BT_COMP_LOGE("Validation of the metadata semantics failed: "
			"mdec-addr=%p", mdec);
		status = CTF_METADATA_DECODER_STATUS_ERROR;
		goto end;
	}

	if (mdec->config.create_trace_class) {
		ret = ctf_visitor_generate_ir_visit_node(mdec->visitor,
			&mdec->scanner->ast->root);
		switch (ret) {
		case 0:
			/* Success */
			break;
		case -EINCOMPLETE:
			BT_COMP_LOGD("While visiting metadata AST: incomplete data: "
				"mdec-addr=%p", mdec);
			status = CTF_METADATA_DECODER_STATUS_INCOMPLETE;
			goto end;
		default:
			BT_COMP_LOGE("Failed to visit AST node to create CTF IR objects: "
				"mdec-addr=%p, ret=%d", mdec, ret);
			status = CTF_METADATA_DECODER_STATUS_IR_VISITOR_ERROR;
			goto end;
		}
	}

end:
#if YYDEBUG
	yydebug = 0;
#endif

	if (fp && close_fp) {
		if (fclose(fp)) {
			BT_COMP_LOGE("Cannot close metadata file stream: "
				"mdec-addr=%p", mdec);
		}
	}

	free(buf);

	return status;
}

BT_HIDDEN
bt_trace_class *ctf_metadata_decoder_get_ir_trace_class(
		struct ctf_metadata_decoder *mdec)
{
	BT_ASSERT_DBG(mdec);
	BT_ASSERT_DBG(mdec->config.create_trace_class);
	return ctf_visitor_generate_ir_get_ir_trace_class(mdec->visitor);
}

BT_HIDDEN
struct ctf_trace_class *ctf_metadata_decoder_borrow_ctf_trace_class(
		struct ctf_metadata_decoder *mdec)
{
	BT_ASSERT_DBG(mdec);
	BT_ASSERT_DBG(mdec->config.create_trace_class);
	return ctf_visitor_generate_ir_borrow_ctf_trace_class(mdec->visitor);
}

BT_HIDDEN
const char *ctf_metadata_decoder_get_text(struct ctf_metadata_decoder *mdec)
{
	BT_ASSERT_DBG(mdec);
	BT_ASSERT_DBG(mdec->config.keep_plain_text);
	return mdec->text->str;
}

BT_HIDDEN
int ctf_metadata_decoder_get_byte_order(struct ctf_metadata_decoder *mdec)
{
	BT_ASSERT_DBG(mdec);
	return mdec->bo;
}

BT_HIDDEN
int ctf_metadata_decoder_get_uuid(struct ctf_metadata_decoder *mdec,
		bt_uuid_t uuid)
{
	int ret = 0;

	BT_ASSERT_DBG(mdec);

	if (!mdec->is_uuid_set) {
		ret = -1;
		goto end;
	}

	bt_uuid_copy(uuid, mdec->uuid);

end:
	return ret;
}

static
enum ctf_metadata_decoder_status find_uuid_in_trace_decl(
		struct ctf_metadata_decoder *mdec, struct ctf_node *trace_node,
		bt_uuid_t uuid)
{
	enum ctf_metadata_decoder_status status =
		CTF_METADATA_DECODER_STATUS_OK;
	struct ctf_node *entry_node;
	struct bt_list_head *decl_list = &trace_node->u.trace.declaration_list;
	char *left = NULL;

	bt_list_for_each_entry(entry_node, decl_list, siblings) {
		if (entry_node->type == NODE_CTF_EXPRESSION) {
			int ret;

			left = ctf_ast_concatenate_unary_strings(
				&entry_node->u.ctf_expression.left);
			if (!left) {
				BT_COMP_LOGE("Cannot concatenate unary strings.");
				status = CTF_METADATA_DECODER_STATUS_ERROR;
				goto end;
			}

			if (strcmp(left, "uuid") == 0) {
				ret = ctf_ast_get_unary_uuid(
					&entry_node->u.ctf_expression.right,
					uuid, mdec->config.log_level,
					mdec->config.self_comp);
				if (ret) {
					BT_COMP_LOGE("Invalid trace's `uuid` attribute.");
					status = CTF_METADATA_DECODER_STATUS_ERROR;
					goto end;
				}

				goto end;
			}

			g_free(left);
			left = NULL;
		}
	}

	status = CTF_METADATA_DECODER_STATUS_NONE;

end:
	g_free(left);
	return status;
}

BT_HIDDEN
enum ctf_metadata_decoder_status ctf_metadata_decoder_get_trace_class_uuid(
		struct ctf_metadata_decoder *mdec, bt_uuid_t uuid)
{
	enum ctf_metadata_decoder_status status =
		CTF_METADATA_DECODER_STATUS_INCOMPLETE;
	struct ctf_node *root_node = &mdec->scanner->ast->root;
	struct ctf_node *trace_node;

	if (!root_node) {
		status = CTF_METADATA_DECODER_STATUS_INCOMPLETE;
		goto end;
	}

	trace_node =
		bt_list_entry(root_node->u.root.trace.next,
			struct ctf_node, siblings);
	if (!trace_node) {
		status = CTF_METADATA_DECODER_STATUS_INCOMPLETE;
		goto end;
	}

	status = find_uuid_in_trace_decl(mdec, trace_node, uuid);

end:
	return status;
}
Commit	Line	Data
1e649dff	1	/*
0235b0db	2	* SPDX-License-Identifier: MIT
1e649dff	3	*
0235b0db	4	* Copyright 2016-2017 Philippe Proulx <pproulx@efficios.com>
1e649dff PP	5	*/
1e649dff PP	6
f7b785ac	7	#define BT_COMP_LOG_SELF_COMP (mdec->config.self_comp)
0746848c	8	#define BT_LOG_OUTPUT_LEVEL (mdec->config.log_level)
350ad6c1	9	#define BT_LOG_TAG "PLUGIN/CTF/META/DECODER"
d9c39b0a	10	#include "logging/comp-logging.h"
d6e20753	11
1e649dff PP	12	#include <stdio.h>
	13	#include <stdbool.h>
	14	#include <stdint.h>
	15	#include <stdlib.h>
d6e20753	16	#include <inttypes.h>
578e048b	17	#include "common/assert.h"
6162e6b7	18	#include "common/uuid.h"
578e048b	19	#include "compat/memstream.h"
3fadfbc0	20	#include <babeltrace2/babeltrace.h>
1e649dff	21	#include <glib.h>
e9383dfd	22	#include <string.h>
1e649dff PP	23
	24	#include "ast.h"
	25	#include "decoder.h"
	26	#include "scanner.h"
f7b785ac	27	#include "logging.h"
9103e903	28	#include "parser-wrap.h"
1e649dff	29
1e649dff PP	30	#define TSDL_MAGIC 0x75d11d57
	31
	32	struct ctf_metadata_decoder {
06be9946 PP	33	struct ctf_scanner *scanner;
06be9946 PP	34	GString *text;
1e649dff	35	struct ctf_visitor_generate_ir *visitor;
6162e6b7	36	bt_uuid_t uuid;
1e649dff PP	37	bool is_uuid_set;
1e649dff PP	38	int bo;
a2a54545	39	struct ctf_metadata_decoder_config config;
06be9946	40	struct meta_log_config log_cfg;
1e649dff PP	41	};
	42
	43	struct packet_header {
	44	uint32_t magic;
6162e6b7	45	bt_uuid_t uuid;
1e649dff PP	46	uint32_t checksum;
	47	uint32_t content_size;
	48	uint32_t packet_size;
	49	uint8_t compression_scheme;
	50	uint8_t encryption_scheme;
	51	uint8_t checksum_scheme;
	52	uint8_t major;
	53	uint8_t minor;
	54	} __attribute__((__packed__));
	55
	56	BT_HIDDEN
06be9946 PP	57	int ctf_metadata_decoder_packetized_file_stream_to_buf(FILE *fp,
	58	char *buf, int byte_order, bool is_uuid_set,
	59	uint8_t *uuid, bt_logging_level log_level,
	60	bt_self_component *self_comp);
	61
	62	BT_HIDDEN
	63	int ctf_metadata_decoder_is_packetized(FILE fp, bool is_packetized,
	64	int *byte_order, bt_logging_level log_level,
	65	bt_self_component *self_comp)
1e649dff PP	66	{
	67	uint32_t magic;
	68	size_t len;
	69	int ret = 0;
	70
06be9946	71	*is_packetized = false;
1e649dff PP	72	len = fread(&magic, sizeof(magic), 1, fp);
1e649dff PP	73	if (len != 1) {
f7b785ac	74	BT_COMP_LOG_CUR_LVL(BT_LOG_INFO, log_level, self_comp,
0746848c	75	"Cannot read first metadata packet header: assuming the stream is not packetized.");
06be9946	76	ret = -1;
1e649dff PP	77	goto end;
	78	}
	79
	80	if (byte_order) {
	81	if (magic == TSDL_MAGIC) {
06be9946	82	*is_packetized = true;
1e649dff PP	83	*byte_order = BYTE_ORDER;
1e649dff PP	84	} else if (magic == GUINT32_SWAP_LE_BE(TSDL_MAGIC)) {
06be9946	85	*is_packetized = true;
1e649dff PP	86	*byte_order = BYTE_ORDER == BIG_ENDIAN ?
	87	LITTLE_ENDIAN : BIG_ENDIAN;
	88	}
	89	}
	90
	91	end:
	92	rewind(fp);
	93
	94	return ret;
	95	}
	96
1e649dff	97	BT_HIDDEN
55314f2a	98	struct ctf_metadata_decoder *ctf_metadata_decoder_create(
862ca4ed	99	const struct ctf_metadata_decoder_config *config)
1e649dff PP	100	{
	101	struct ctf_metadata_decoder *mdec =
	102	g_new0(struct ctf_metadata_decoder, 1);
a2a54545	103
f7b785ac PP	104	BT_ASSERT(config);
	105	BT_COMP_LOG_CUR_LVL(BT_LOG_DEBUG, config->log_level, config->self_comp,
	106	"Creating CTF metadata decoder: "
a2a54545	107	"clock-class-offset-s=%" PRId64 ", "
862ca4ed PP	108	"clock-class-offset-ns=%" PRId64,
862ca4ed PP	109	config->clock_class_offset_s, config->clock_class_offset_ns);
d6e20753	110
1e649dff	111	if (!mdec) {
f7b785ac PP	112	BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR, config->log_level,
	113	config->self_comp,
	114	"Failed to allocate one CTF metadata decoder.");
1e649dff PP	115	goto end;
	116	}
	117
06be9946 PP	118	mdec->log_cfg.log_level = config->log_level;
	119	mdec->log_cfg.self_comp = config->self_comp;
	120	mdec->scanner = ctf_scanner_alloc();
	121	if (!mdec->scanner) {
	122	BT_COMP_LOGE("Cannot allocate a metadata lexical scanner: "
	123	"mdec-addr=%p", mdec);
	124	goto error;
	125	}
	126
	127	mdec->text = g_string_new(NULL);
	128	if (!mdec->text) {
	129	BT_COMP_LOGE("Failed to allocate one GString: "
	130	"mdec-addr=%p", mdec);
	131	goto error;
	132	}
	133
	134	mdec->bo = -1;
a2a54545	135	mdec->config = *config;
f7b785ac	136	mdec->visitor = ctf_visitor_generate_ir_create(config);
1e649dff	137	if (!mdec->visitor) {
f7b785ac	138	BT_COMP_LOGE("Failed to create a CTF IR metadata AST visitor: "
d6e20753	139	"mdec-addr=%p", mdec);
06be9946	140	goto error;
1e649dff PP	141	}
1e649dff PP	142
f7b785ac	143	BT_COMP_LOGD("Creating CTF metadata decoder: "
a2a54545	144	"clock-class-offset-s=%" PRId64 ", "
862ca4ed	145	"clock-class-offset-ns=%" PRId64 ", addr=%p",
a2a54545	146	config->clock_class_offset_s, config->clock_class_offset_ns,
862ca4ed	147	mdec);
06be9946 PP	148	goto end;
	149
	150	error:
	151	ctf_metadata_decoder_destroy(mdec);
	152	mdec = NULL;
d6e20753	153
1e649dff PP	154	end:
	155	return mdec;
	156	}
	157
	158	BT_HIDDEN
	159	void ctf_metadata_decoder_destroy(struct ctf_metadata_decoder *mdec)
	160	{
	161	if (!mdec) {
	162	return;
	163	}
	164
06be9946 PP	165	if (mdec->scanner) {
	166	ctf_scanner_free(mdec->scanner);
	167	}
	168
	169	if (mdec->text) {
	170	g_string_free(mdec->text, TRUE);
	171	}
	172
f7b785ac	173	BT_COMP_LOGD("Destroying CTF metadata decoder: addr=%p", mdec);
1e649dff PP	174	ctf_visitor_generate_ir_destroy(mdec->visitor);
	175	g_free(mdec);
	176	}
	177
	178	BT_HIDDEN
06be9946	179	enum ctf_metadata_decoder_status ctf_metadata_decoder_append_content(
1e649dff PP	180	struct ctf_metadata_decoder mdec, FILE fp)
	181	{
	182	enum ctf_metadata_decoder_status status =
	183	CTF_METADATA_DECODER_STATUS_OK;
	184	int ret;
1e649dff PP	185	char *buf = NULL;
1e649dff PP	186	bool close_fp = false;
06be9946 PP	187	long start_pos = -1;
06be9946 PP	188	bool is_packetized;
1e649dff	189
f6ccaed9	190	BT_ASSERT(mdec);
06be9946 PP	191	ret = ctf_metadata_decoder_is_packetized(fp, &is_packetized, &mdec->bo,
	192	mdec->config.log_level, mdec->config.self_comp);
	193	if (ret) {
	194	status = CTF_METADATA_DECODER_STATUS_ERROR;
	195	goto end;
	196	}
1e649dff	197
06be9946	198	if (is_packetized) {
f7b785ac	199	BT_COMP_LOGI("Metadata stream is packetized: mdec-addr=%p", mdec);
3c8252a5 PP	200	ret = ctf_metadata_decoder_packetized_file_stream_to_buf(fp,
	201	&buf, mdec->bo, &mdec->is_uuid_set,
	202	mdec->uuid, mdec->config.log_level,
f7b785ac	203	mdec->config.self_comp);
1e649dff	204	if (ret) {
f7b785ac	205	BT_COMP_LOGE("Cannot decode packetized metadata packets to metadata text: "
d6e20753	206	"mdec-addr=%p, ret=%d", mdec, ret);
1e649dff PP	207	status = CTF_METADATA_DECODER_STATUS_ERROR;
	208	goto end;
	209	}
	210
7cdc2bab MD	211	if (strlen(buf) == 0) {
	212	/* An empty metadata packet is OK. */
	213	goto end;
	214	}
	215
1e649dff PP	216	/* Convert the real file pointer to a memory file pointer */
	217	fp = bt_fmemopen(buf, strlen(buf), "rb");
	218	close_fp = true;
	219	if (!fp) {
f7b785ac	220	BT_COMP_LOGE("Cannot memory-open metadata buffer: %s: "
d6e20753	221	"mdec-addr=%p", strerror(errno), mdec);
1e649dff PP	222	status = CTF_METADATA_DECODER_STATUS_ERROR;
	223	goto end;
	224	}
	225	} else {
	226	unsigned int major, minor;
	227	ssize_t nr_items;
	228	const long init_pos = ftell(fp);
	229
f7b785ac	230	BT_COMP_LOGI("Metadata stream is plain text: mdec-addr=%p", mdec);
1e649dff	231
1e95e5e8	232	if (init_pos < 0) {
f7b785ac	233	BT_COMP_LOGE_ERRNO("Failed to get current file position", ".");
1e95e5e8 MD	234	status = CTF_METADATA_DECODER_STATUS_ERROR;
	235	goto end;
	236	}
	237
1e649dff PP	238	/* Check text-only metadata header and version */
	239	nr_items = fscanf(fp, "/* CTF %10u.%10u", &major, &minor);
	240	if (nr_items < 2) {
f7b785ac	241	BT_COMP_LOGW("Missing \"/* CTF major.minor\" signature in plain text metadata file stream: "
d6e20753	242	"mdec-addr=%p", mdec);
1e649dff PP	243	}
1e649dff PP	244
f7b785ac	245	BT_COMP_LOGI("Found metadata stream version in signature: version=%u.%u", major, minor);
1e649dff	246
3c8252a5 PP	247	if (!ctf_metadata_decoder_is_packet_version_valid(major,
3c8252a5 PP	248	minor)) {
f7b785ac	249	BT_COMP_LOGE("Invalid metadata version found in plain text signature: "
d6e20753 PP	250	"version=%u.%u, mdec-addr=%p", major, minor,
d6e20753 PP	251	mdec);
1e649dff PP	252	status = CTF_METADATA_DECODER_STATUS_INVAL_VERSION;
	253	goto end;
	254	}
	255
	256	if (fseek(fp, init_pos, SEEK_SET)) {
f7b785ac	257	BT_COMP_LOGE("Cannot seek metadata file stream to initial position: %s: "
d6e20753	258	"mdec-addr=%p", strerror(errno), mdec);
1e649dff PP	259	status = CTF_METADATA_DECODER_STATUS_ERROR;
	260	goto end;
	261	}
	262	}
	263
9103e903	264	#if YYDEBUG
ef267d12	265	if (BT_LOG_ON_TRACE) {
f73367f8 PP	266	yydebug = 1;
f73367f8 PP	267	}
9103e903	268	#endif
f73367f8	269
06be9946 PP	270	/* Save the file's position: we'll seek back to append the plain text */
	271	BT_ASSERT(fp);
	272
	273	if (mdec->config.keep_plain_text) {
	274	start_pos = ftell(fp);
1e649dff PP	275	}
1e649dff PP	276
06be9946 PP	277	/* Append the metadata text content */
06be9946 PP	278	ret = ctf_scanner_append_ast(mdec->scanner, fp);
1e649dff	279	if (ret) {
f7b785ac	280	BT_COMP_LOGE("Cannot create the metadata AST out of the metadata text: "
d6e20753	281	"mdec-addr=%p", mdec);
1e649dff PP	282	status = CTF_METADATA_DECODER_STATUS_INCOMPLETE;
	283	goto end;
	284	}
	285
06be9946 PP	286	/* We know it's complete: append plain text */
	287	if (mdec->config.keep_plain_text) {
	288	BT_ASSERT(start_pos != -1);
	289	ret = fseek(fp, start_pos, SEEK_SET);
	290	if (ret) {
	291	BT_COMP_LOGE("Failed to seek file: ret=%d, mdec-addr=%p",
	292	ret, mdec);
	293	status = CTF_METADATA_DECODER_STATUS_ERROR;
	294	goto end;
	295	}
	296
	297	ret = bt_common_append_file_content_to_g_string(mdec->text, fp);
	298	if (ret) {
	299	BT_COMP_LOGE("Failed to append to current plain text: "
	300	"ret=%d, mdec-addr=%p", ret, mdec);
	301	status = CTF_METADATA_DECODER_STATUS_ERROR;
	302	goto end;
	303	}
	304	}
	305
	306	ret = ctf_visitor_semantic_check(0, &mdec->scanner->ast->root,
	307	&mdec->log_cfg);
1e649dff	308	if (ret) {
f7b785ac	309	BT_COMP_LOGE("Validation of the metadata semantics failed: "
d6e20753	310	"mdec-addr=%p", mdec);
1e649dff PP	311	status = CTF_METADATA_DECODER_STATUS_ERROR;
	312	goto end;
	313	}
	314
06be9946 PP	315	if (mdec->config.create_trace_class) {
	316	ret = ctf_visitor_generate_ir_visit_node(mdec->visitor,
	317	&mdec->scanner->ast->root);
	318	switch (ret) {
	319	case 0:
	320	/* Success */
	321	break;
	322	case -EINCOMPLETE:
	323	BT_COMP_LOGD("While visiting metadata AST: incomplete data: "
	324	"mdec-addr=%p", mdec);
	325	status = CTF_METADATA_DECODER_STATUS_INCOMPLETE;
	326	goto end;
	327	default:
	328	BT_COMP_LOGE("Failed to visit AST node to create CTF IR objects: "
	329	"mdec-addr=%p, ret=%d", mdec, ret);
	330	status = CTF_METADATA_DECODER_STATUS_IR_VISITOR_ERROR;
	331	goto end;
	332	}
1e649dff PP	333	}
	334
	335	end:
9103e903	336	#if YYDEBUG
f73367f8	337	yydebug = 0;
9103e903	338	#endif
f73367f8	339
1e649dff PP	340	if (fp && close_fp) {
1e649dff PP	341	if (fclose(fp)) {
f7b785ac	342	BT_COMP_LOGE("Cannot close metadata file stream: "
d6e20753	343	"mdec-addr=%p", mdec);
1e649dff PP	344	}
	345	}
	346
6b934a94	347	free(buf);
1e649dff PP	348
	349	return status;
	350	}
	351
	352	BT_HIDDEN
b19ff26f	353	bt_trace_class *ctf_metadata_decoder_get_ir_trace_class(
44c440bc PP	354	struct ctf_metadata_decoder *mdec)
44c440bc PP	355	{
98b15851 PP	356	BT_ASSERT_DBG(mdec);
98b15851 PP	357	BT_ASSERT_DBG(mdec->config.create_trace_class);
862ca4ed	358	return ctf_visitor_generate_ir_get_ir_trace_class(mdec->visitor);
44c440bc PP	359	}
	360
	361	BT_HIDDEN
	362	struct ctf_trace_class *ctf_metadata_decoder_borrow_ctf_trace_class(
1e649dff PP	363	struct ctf_metadata_decoder *mdec)
1e649dff PP	364	{
98b15851 PP	365	BT_ASSERT_DBG(mdec);
98b15851 PP	366	BT_ASSERT_DBG(mdec->config.create_trace_class);
44c440bc	367	return ctf_visitor_generate_ir_borrow_ctf_trace_class(mdec->visitor);
1e649dff	368	}
06be9946 PP	369
	370	BT_HIDDEN
	371	const char ctf_metadata_decoder_get_text(struct ctf_metadata_decoder mdec)
	372	{
98b15851 PP	373	BT_ASSERT_DBG(mdec);
98b15851 PP	374	BT_ASSERT_DBG(mdec->config.keep_plain_text);
06be9946 PP	375	return mdec->text->str;
	376	}
	377
	378	BT_HIDDEN
	379	int ctf_metadata_decoder_get_byte_order(struct ctf_metadata_decoder *mdec)
	380	{
98b15851	381	BT_ASSERT_DBG(mdec);
06be9946 PP	382	return mdec->bo;
	383	}
	384
	385	BT_HIDDEN
	386	int ctf_metadata_decoder_get_uuid(struct ctf_metadata_decoder *mdec,
	387	bt_uuid_t uuid)
	388	{
	389	int ret = 0;
	390
98b15851	391	BT_ASSERT_DBG(mdec);
06be9946 PP	392
	393	if (!mdec->is_uuid_set) {
	394	ret = -1;
	395	goto end;
	396	}
	397
	398	bt_uuid_copy(uuid, mdec->uuid);
	399
	400	end:
	401	return ret;
	402	}
1a6da3f9 PP	403
	404	static
	405	enum ctf_metadata_decoder_status find_uuid_in_trace_decl(
	406	struct ctf_metadata_decoder mdec, struct ctf_node trace_node,
	407	bt_uuid_t uuid)
	408	{
	409	enum ctf_metadata_decoder_status status =
	410	CTF_METADATA_DECODER_STATUS_OK;
	411	struct ctf_node *entry_node;
	412	struct bt_list_head *decl_list = &trace_node->u.trace.declaration_list;
	413	char *left = NULL;
	414
	415	bt_list_for_each_entry(entry_node, decl_list, siblings) {
	416	if (entry_node->type == NODE_CTF_EXPRESSION) {
	417	int ret;
	418
	419	left = ctf_ast_concatenate_unary_strings(
	420	&entry_node->u.ctf_expression.left);
	421	if (!left) {
	422	BT_COMP_LOGE("Cannot concatenate unary strings.");
	423	status = CTF_METADATA_DECODER_STATUS_ERROR;
	424	goto end;
	425	}
	426
	427	if (strcmp(left, "uuid") == 0) {
	428	ret = ctf_ast_get_unary_uuid(
	429	&entry_node->u.ctf_expression.right,
	430	uuid, mdec->config.log_level,
	431	mdec->config.self_comp);
	432	if (ret) {
	433	BT_COMP_LOGE("Invalid trace's `uuid` attribute.");
	434	status = CTF_METADATA_DECODER_STATUS_ERROR;
	435	goto end;
	436	}
	437
	438	goto end;
	439	}
	440
	441	g_free(left);
	442	left = NULL;
	443	}
	444	}
	445
	446	status = CTF_METADATA_DECODER_STATUS_NONE;
	447
	448	end:
	449	g_free(left);
	450	return status;
	451	}
	452
	453	BT_HIDDEN
	454	enum ctf_metadata_decoder_status ctf_metadata_decoder_get_trace_class_uuid(
	455	struct ctf_metadata_decoder *mdec, bt_uuid_t uuid)
	456	{
	457	enum ctf_metadata_decoder_status status =
	458	CTF_METADATA_DECODER_STATUS_INCOMPLETE;
	459	struct ctf_node *root_node = &mdec->scanner->ast->root;
	460	struct ctf_node *trace_node;
	461
	462	if (!root_node) {
	463	status = CTF_METADATA_DECODER_STATUS_INCOMPLETE;
	464	goto end;
	465	}
	466
467	trace_node =
468	bt_list_entry(root_node->u.root.trace.next,
469	struct ctf_node, siblings);
470	if (!trace_node) {
471	status = CTF_METADATA_DECODER_STATUS_INCOMPLETE;
472	goto end;
473	}
474
475	status = find_uuid_in_trace_decl(mdec, trace_node, uuid);
476
477	end:
478	return status;
479	}