[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"

#define TSDL_MAGIC	0x75d11d57

extern
int yydebug;

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 (BT_LOG_ON_TRACE) {
		yydebug = 1;
	}

	/* 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:
	yydebug = 0;

	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"
1e649dff	36
1e649dff PP	37	#define TSDL_MAGIC 0x75d11d57
1e649dff PP	38
61d6f9b1	39	extern
f73367f8 PP	40	int yydebug;
f73367f8 PP	41
1e649dff	42	struct ctf_metadata_decoder {
06be9946 PP	43	struct ctf_scanner *scanner;
06be9946 PP	44	GString *text;
1e649dff	45	struct ctf_visitor_generate_ir *visitor;
6162e6b7	46	bt_uuid_t uuid;
1e649dff PP	47	bool is_uuid_set;
1e649dff PP	48	int bo;
a2a54545	49	struct ctf_metadata_decoder_config config;
06be9946	50	struct meta_log_config log_cfg;
1e649dff PP	51	};
	52
	53	struct packet_header {
	54	uint32_t magic;
6162e6b7	55	bt_uuid_t uuid;
1e649dff PP	56	uint32_t checksum;
	57	uint32_t content_size;
	58	uint32_t packet_size;
	59	uint8_t compression_scheme;
	60	uint8_t encryption_scheme;
	61	uint8_t checksum_scheme;
	62	uint8_t major;
	63	uint8_t minor;
	64	} __attribute__((__packed__));
	65
	66	BT_HIDDEN
06be9946 PP	67	int ctf_metadata_decoder_packetized_file_stream_to_buf(FILE *fp,
	68	char *buf, int byte_order, bool is_uuid_set,
	69	uint8_t *uuid, bt_logging_level log_level,
	70	bt_self_component *self_comp);
	71
	72	BT_HIDDEN
	73	int ctf_metadata_decoder_is_packetized(FILE fp, bool is_packetized,
	74	int *byte_order, bt_logging_level log_level,
	75	bt_self_component *self_comp)
1e649dff PP	76	{
	77	uint32_t magic;
	78	size_t len;
	79	int ret = 0;
	80
06be9946	81	*is_packetized = false;
1e649dff PP	82	len = fread(&magic, sizeof(magic), 1, fp);
1e649dff PP	83	if (len != 1) {
f7b785ac	84	BT_COMP_LOG_CUR_LVL(BT_LOG_INFO, log_level, self_comp,
0746848c	85	"Cannot read first metadata packet header: assuming the stream is not packetized.");
06be9946	86	ret = -1;
1e649dff PP	87	goto end;
	88	}
	89
	90	if (byte_order) {
	91	if (magic == TSDL_MAGIC) {
06be9946	92	*is_packetized = true;
1e649dff PP	93	*byte_order = BYTE_ORDER;
1e649dff PP	94	} else if (magic == GUINT32_SWAP_LE_BE(TSDL_MAGIC)) {
06be9946	95	*is_packetized = true;
1e649dff PP	96	*byte_order = BYTE_ORDER == BIG_ENDIAN ?
	97	LITTLE_ENDIAN : BIG_ENDIAN;
	98	}
	99	}
	100
	101	end:
	102	rewind(fp);
	103
	104	return ret;
	105	}
	106
1e649dff	107	BT_HIDDEN
55314f2a	108	struct ctf_metadata_decoder *ctf_metadata_decoder_create(
862ca4ed	109	const struct ctf_metadata_decoder_config *config)
1e649dff PP	110	{
	111	struct ctf_metadata_decoder *mdec =
	112	g_new0(struct ctf_metadata_decoder, 1);
a2a54545	113
f7b785ac PP	114	BT_ASSERT(config);
	115	BT_COMP_LOG_CUR_LVL(BT_LOG_DEBUG, config->log_level, config->self_comp,
	116	"Creating CTF metadata decoder: "
a2a54545	117	"clock-class-offset-s=%" PRId64 ", "
862ca4ed PP	118	"clock-class-offset-ns=%" PRId64,
862ca4ed PP	119	config->clock_class_offset_s, config->clock_class_offset_ns);
d6e20753	120
1e649dff	121	if (!mdec) {
f7b785ac PP	122	BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR, config->log_level,
	123	config->self_comp,
	124	"Failed to allocate one CTF metadata decoder.");
1e649dff PP	125	goto end;
	126	}
	127
06be9946 PP	128	mdec->log_cfg.log_level = config->log_level;
	129	mdec->log_cfg.self_comp = config->self_comp;
	130	mdec->scanner = ctf_scanner_alloc();
	131	if (!mdec->scanner) {
	132	BT_COMP_LOGE("Cannot allocate a metadata lexical scanner: "
	133	"mdec-addr=%p", mdec);
	134	goto error;
	135	}
	136
	137	mdec->text = g_string_new(NULL);
	138	if (!mdec->text) {
	139	BT_COMP_LOGE("Failed to allocate one GString: "
	140	"mdec-addr=%p", mdec);
	141	goto error;
	142	}
	143
	144	mdec->bo = -1;
a2a54545	145	mdec->config = *config;
f7b785ac	146	mdec->visitor = ctf_visitor_generate_ir_create(config);
1e649dff	147	if (!mdec->visitor) {
f7b785ac	148	BT_COMP_LOGE("Failed to create a CTF IR metadata AST visitor: "
d6e20753	149	"mdec-addr=%p", mdec);
06be9946	150	goto error;
1e649dff PP	151	}
1e649dff PP	152
f7b785ac	153	BT_COMP_LOGD("Creating CTF metadata decoder: "
a2a54545	154	"clock-class-offset-s=%" PRId64 ", "
862ca4ed	155	"clock-class-offset-ns=%" PRId64 ", addr=%p",
a2a54545	156	config->clock_class_offset_s, config->clock_class_offset_ns,
862ca4ed	157	mdec);
06be9946 PP	158	goto end;
	159
	160	error:
	161	ctf_metadata_decoder_destroy(mdec);
	162	mdec = NULL;
d6e20753	163
1e649dff PP	164	end:
	165	return mdec;
	166	}
	167
	168	BT_HIDDEN
	169	void ctf_metadata_decoder_destroy(struct ctf_metadata_decoder *mdec)
	170	{
	171	if (!mdec) {
	172	return;
	173	}
	174
06be9946 PP	175	if (mdec->scanner) {
	176	ctf_scanner_free(mdec->scanner);
	177	}
	178
	179	if (mdec->text) {
	180	g_string_free(mdec->text, TRUE);
	181	}
	182
f7b785ac	183	BT_COMP_LOGD("Destroying CTF metadata decoder: addr=%p", mdec);
1e649dff PP	184	ctf_visitor_generate_ir_destroy(mdec->visitor);
	185	g_free(mdec);
	186	}
	187
	188	BT_HIDDEN
06be9946	189	enum ctf_metadata_decoder_status ctf_metadata_decoder_append_content(
1e649dff PP	190	struct ctf_metadata_decoder mdec, FILE fp)
	191	{
	192	enum ctf_metadata_decoder_status status =
	193	CTF_METADATA_DECODER_STATUS_OK;
	194	int ret;
1e649dff PP	195	char *buf = NULL;
1e649dff PP	196	bool close_fp = false;
06be9946 PP	197	long start_pos = -1;
06be9946 PP	198	bool is_packetized;
1e649dff	199
f6ccaed9	200	BT_ASSERT(mdec);
06be9946 PP	201	ret = ctf_metadata_decoder_is_packetized(fp, &is_packetized, &mdec->bo,
	202	mdec->config.log_level, mdec->config.self_comp);
	203	if (ret) {
	204	status = CTF_METADATA_DECODER_STATUS_ERROR;
	205	goto end;
	206	}
1e649dff	207
06be9946	208	if (is_packetized) {
f7b785ac	209	BT_COMP_LOGI("Metadata stream is packetized: mdec-addr=%p", mdec);
3c8252a5 PP	210	ret = ctf_metadata_decoder_packetized_file_stream_to_buf(fp,
	211	&buf, mdec->bo, &mdec->is_uuid_set,
	212	mdec->uuid, mdec->config.log_level,
f7b785ac	213	mdec->config.self_comp);
1e649dff	214	if (ret) {
f7b785ac	215	BT_COMP_LOGE("Cannot decode packetized metadata packets to metadata text: "
d6e20753	216	"mdec-addr=%p, ret=%d", mdec, ret);
1e649dff PP	217	status = CTF_METADATA_DECODER_STATUS_ERROR;
	218	goto end;
	219	}
	220
7cdc2bab MD	221	if (strlen(buf) == 0) {
	222	/* An empty metadata packet is OK. */
	223	goto end;
	224	}
	225
1e649dff PP	226	/* Convert the real file pointer to a memory file pointer */
	227	fp = bt_fmemopen(buf, strlen(buf), "rb");
	228	close_fp = true;
	229	if (!fp) {
f7b785ac	230	BT_COMP_LOGE("Cannot memory-open metadata buffer: %s: "
d6e20753	231	"mdec-addr=%p", strerror(errno), mdec);
1e649dff PP	232	status = CTF_METADATA_DECODER_STATUS_ERROR;
	233	goto end;
	234	}
	235	} else {
	236	unsigned int major, minor;
	237	ssize_t nr_items;
	238	const long init_pos = ftell(fp);
	239
f7b785ac	240	BT_COMP_LOGI("Metadata stream is plain text: mdec-addr=%p", mdec);
1e649dff	241
1e95e5e8	242	if (init_pos < 0) {
f7b785ac	243	BT_COMP_LOGE_ERRNO("Failed to get current file position", ".");
1e95e5e8 MD	244	status = CTF_METADATA_DECODER_STATUS_ERROR;
	245	goto end;
	246	}
	247
1e649dff PP	248	/* Check text-only metadata header and version */
	249	nr_items = fscanf(fp, "/* CTF %10u.%10u", &major, &minor);
	250	if (nr_items < 2) {
f7b785ac	251	BT_COMP_LOGW("Missing \"/* CTF major.minor\" signature in plain text metadata file stream: "
d6e20753	252	"mdec-addr=%p", mdec);
1e649dff PP	253	}
1e649dff PP	254
f7b785ac	255	BT_COMP_LOGI("Found metadata stream version in signature: version=%u.%u", major, minor);
1e649dff	256
3c8252a5 PP	257	if (!ctf_metadata_decoder_is_packet_version_valid(major,
3c8252a5 PP	258	minor)) {
f7b785ac	259	BT_COMP_LOGE("Invalid metadata version found in plain text signature: "
d6e20753 PP	260	"version=%u.%u, mdec-addr=%p", major, minor,
d6e20753 PP	261	mdec);
1e649dff PP	262	status = CTF_METADATA_DECODER_STATUS_INVAL_VERSION;
	263	goto end;
	264	}
	265
	266	if (fseek(fp, init_pos, SEEK_SET)) {
f7b785ac	267	BT_COMP_LOGE("Cannot seek metadata file stream to initial position: %s: "
d6e20753	268	"mdec-addr=%p", strerror(errno), mdec);
1e649dff PP	269	status = CTF_METADATA_DECODER_STATUS_ERROR;
	270	goto end;
	271	}
	272	}
	273
ef267d12	274	if (BT_LOG_ON_TRACE) {
f73367f8 PP	275	yydebug = 1;
	276	}
	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:
f73367f8 PP	344	yydebug = 0;
f73367f8 PP	345
1e649dff PP	346	if (fp && close_fp) {
1e649dff PP	347	if (fclose(fp)) {
f7b785ac	348	BT_COMP_LOGE("Cannot close metadata file stream: "
d6e20753	349	"mdec-addr=%p", mdec);
1e649dff PP	350	}
	351	}
	352
6b934a94	353	free(buf);
1e649dff PP	354
	355	return status;
	356	}
	357
	358	BT_HIDDEN
b19ff26f	359	bt_trace_class *ctf_metadata_decoder_get_ir_trace_class(
44c440bc PP	360	struct ctf_metadata_decoder *mdec)
44c440bc PP	361	{
98b15851 PP	362	BT_ASSERT_DBG(mdec);
98b15851 PP	363	BT_ASSERT_DBG(mdec->config.create_trace_class);
862ca4ed	364	return ctf_visitor_generate_ir_get_ir_trace_class(mdec->visitor);
44c440bc PP	365	}
	366
	367	BT_HIDDEN
	368	struct ctf_trace_class *ctf_metadata_decoder_borrow_ctf_trace_class(
1e649dff PP	369	struct ctf_metadata_decoder *mdec)
1e649dff PP	370	{
98b15851 PP	371	BT_ASSERT_DBG(mdec);
98b15851 PP	372	BT_ASSERT_DBG(mdec->config.create_trace_class);
44c440bc	373	return ctf_visitor_generate_ir_borrow_ctf_trace_class(mdec->visitor);
1e649dff	374	}
06be9946 PP	375
	376	BT_HIDDEN
	377	const char ctf_metadata_decoder_get_text(struct ctf_metadata_decoder mdec)
	378	{
98b15851 PP	379	BT_ASSERT_DBG(mdec);
98b15851 PP	380	BT_ASSERT_DBG(mdec->config.keep_plain_text);
06be9946 PP	381	return mdec->text->str;
	382	}
	383
	384	BT_HIDDEN
	385	int ctf_metadata_decoder_get_byte_order(struct ctf_metadata_decoder *mdec)
	386	{
98b15851	387	BT_ASSERT_DBG(mdec);
06be9946 PP	388	return mdec->bo;
	389	}
	390
	391	BT_HIDDEN
	392	int ctf_metadata_decoder_get_uuid(struct ctf_metadata_decoder *mdec,
	393	bt_uuid_t uuid)
	394	{
	395	int ret = 0;
	396
98b15851	397	BT_ASSERT_DBG(mdec);
06be9946 PP	398
	399	if (!mdec->is_uuid_set) {
	400	ret = -1;
	401	goto end;
	402	}
	403
	404	bt_uuid_copy(uuid, mdec->uuid);
	405
	406	end:
	407	return ret;
	408	}
1a6da3f9 PP	409
	410	static
	411	enum ctf_metadata_decoder_status find_uuid_in_trace_decl(
	412	struct ctf_metadata_decoder mdec, struct ctf_node trace_node,
	413	bt_uuid_t uuid)
	414	{
	415	enum ctf_metadata_decoder_status status =
	416	CTF_METADATA_DECODER_STATUS_OK;
	417	struct ctf_node *entry_node;
	418	struct bt_list_head *decl_list = &trace_node->u.trace.declaration_list;
	419	char *left = NULL;
	420
	421	bt_list_for_each_entry(entry_node, decl_list, siblings) {
	422	if (entry_node->type == NODE_CTF_EXPRESSION) {
	423	int ret;
	424
	425	left = ctf_ast_concatenate_unary_strings(
	426	&entry_node->u.ctf_expression.left);
	427	if (!left) {
	428	BT_COMP_LOGE("Cannot concatenate unary strings.");
	429	status = CTF_METADATA_DECODER_STATUS_ERROR;
	430	goto end;
	431	}
	432
	433	if (strcmp(left, "uuid") == 0) {
	434	ret = ctf_ast_get_unary_uuid(
	435	&entry_node->u.ctf_expression.right,
	436	uuid, mdec->config.log_level,
	437	mdec->config.self_comp);
	438	if (ret) {
	439	BT_COMP_LOGE("Invalid trace's `uuid` attribute.");
	440	status = CTF_METADATA_DECODER_STATUS_ERROR;
	441	goto end;
	442	}
	443
	444	goto end;
	445	}
	446
	447	g_free(left);
	448	left = NULL;
	449	}
	450	}
	451
	452	status = CTF_METADATA_DECODER_STATUS_NONE;
	453
	454	end:
	455	g_free(left);
	456	return status;
	457	}
	458
	459	BT_HIDDEN
	460	enum ctf_metadata_decoder_status ctf_metadata_decoder_get_trace_class_uuid(
	461	struct ctf_metadata_decoder *mdec, bt_uuid_t uuid)
	462	{
	463	enum ctf_metadata_decoder_status status =
	464	CTF_METADATA_DECODER_STATUS_INCOMPLETE;
	465	struct ctf_node *root_node = &mdec->scanner->ast->root;
	466	struct ctf_node *trace_node;
	467
	468	if (!root_node) {
	469	status = CTF_METADATA_DECODER_STATUS_INCOMPLETE;
	470	goto end;
	471	}
	472
473	trace_node =
474	bt_list_entry(root_node->u.root.trace.next,
475	struct ctf_node, siblings);
476	if (!trace_node) {
477	status = CTF_METADATA_DECODER_STATUS_INCOMPLETE;
478	goto end;
479	}
480
481	status = find_uuid_in_trace_decl(mdec, trace_node, uuid);
482
483	end:
484	return status;
485	}