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

/*
 * Copyright 2016-2017 - Philippe Proulx <pproulx@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.
 */

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