[babeltrace.git] / 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_LOG_TAG "PLUGIN-CTF-METADATA-DECODER"
#include "logging.h"

#include <stdio.h>
#include <stdbool.h>
#include <stdint.h>
#include <stdlib.h>
#include <inttypes.h>
#include <babeltrace/assert-internal.h>
#include <babeltrace/compat/uuid-internal.h>
#include <babeltrace/compat/memstream-internal.h>
#include <babeltrace/babeltrace.h>
#include <glib.h>
#include <string.h>

#include "ast.h"
#include "decoder.h"
#include "scanner.h"

#define TSDL_MAGIC	0x75d11d57

extern
int yydebug;

struct ctf_metadata_decoder {
	struct ctf_visitor_generate_ir *visitor;
	uint8_t uuid[16];
	bool is_uuid_set;
	int bo;
	struct ctf_metadata_decoder_config config;
};

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__));

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

	len = fread(&magic, sizeof(magic), 1, fp);
	if (len != 1) {
		BT_LOGD_STR("Cannot reade first metadata packet header: assuming the stream is not packetized.");
		goto end;
	}

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

end:
	rewind(fp);

	return ret;
}

static
bool is_version_valid(unsigned int major, unsigned int minor)
{
	return major == 1 && minor == 8;
}

static
int decode_packet(struct ctf_metadata_decoder *mdec, FILE *in_fp, FILE *out_fp,
		int byte_order)
{
	struct packet_header header;
	size_t readlen, writelen, toread;
	uint8_t buf[512 + 1];	/* + 1 for debug-mode \0 */
	int ret = 0;
	const long offset = ftell(in_fp);

	if (offset < 0) {
		BT_LOGE_ERRNO("Failed to get current metadata file position",
			".");
		goto error;
	}
	BT_LOGV("Decoding metadata packet: mdec-addr=%p, offset=%ld",
		mdec, offset);
	readlen = fread(&header, sizeof(header), 1, in_fp);
	if (feof(in_fp) != 0) {
		BT_LOGV("Reached end of file: offset=%ld", ftell(in_fp));
		goto end;
	}
	if (readlen < 1) {
		BT_LOGV("Cannot decode metadata packet: offset=%ld", offset);
		goto error;
	}

	if (byte_order != BYTE_ORDER) {
		header.magic = GUINT32_SWAP_LE_BE(header.magic);
		header.checksum = GUINT32_SWAP_LE_BE(header.checksum);
		header.content_size = GUINT32_SWAP_LE_BE(header.content_size);
		header.packet_size = GUINT32_SWAP_LE_BE(header.packet_size);
	}

	if (header.compression_scheme) {
		BT_LOGE("Metadata packet compression is not supported as of this version: "
			"compression-scheme=%u, offset=%ld",
			(unsigned int) header.compression_scheme, offset);
		goto error;
	}

	if (header.encryption_scheme) {
		BT_LOGE("Metadata packet encryption is not supported as of this version: "
			"encryption-scheme=%u, offset=%ld",
			(unsigned int) header.encryption_scheme, offset);
		goto error;
	}

	if (header.checksum || header.checksum_scheme) {
		BT_LOGE("Metadata packet checksum verification is not supported as of this version: "
			"checksum-scheme=%u, checksum=%x, offset=%ld",
			(unsigned int) header.checksum_scheme, header.checksum,
			offset);
		goto error;
	}

	if (!is_version_valid(header.major, header.minor)) {
		BT_LOGE("Invalid metadata packet version: "
			"version=%u.%u, offset=%ld",
			header.major, header.minor, offset);
		goto error;
	}

	/* Set expected trace UUID if not set; otherwise validate it */
	if (mdec) {
		if (!mdec->is_uuid_set) {
			memcpy(mdec->uuid, header.uuid, sizeof(header.uuid));
			mdec->is_uuid_set = true;
		} else if (bt_uuid_compare(header.uuid, mdec->uuid)) {
			BT_LOGE("Metadata UUID mismatch between packets of the same stream: "
				"packet-uuid=\"%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x\", "
				"expected-uuid=\"%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x\", "
				"offset=%ld",
				(unsigned int) header.uuid[0],
				(unsigned int) header.uuid[1],
				(unsigned int) header.uuid[2],
				(unsigned int) header.uuid[3],
				(unsigned int) header.uuid[4],
				(unsigned int) header.uuid[5],
				(unsigned int) header.uuid[6],
				(unsigned int) header.uuid[7],
				(unsigned int) header.uuid[8],
				(unsigned int) header.uuid[9],
				(unsigned int) header.uuid[10],
				(unsigned int) header.uuid[11],
				(unsigned int) header.uuid[12],
				(unsigned int) header.uuid[13],
				(unsigned int) header.uuid[14],
				(unsigned int) header.uuid[15],
				(unsigned int) mdec->uuid[0],
				(unsigned int) mdec->uuid[1],
				(unsigned int) mdec->uuid[2],
				(unsigned int) mdec->uuid[3],
				(unsigned int) mdec->uuid[4],
				(unsigned int) mdec->uuid[5],
				(unsigned int) mdec->uuid[6],
				(unsigned int) mdec->uuid[7],
				(unsigned int) mdec->uuid[8],
				(unsigned int) mdec->uuid[9],
				(unsigned int) mdec->uuid[10],
				(unsigned int) mdec->uuid[11],
				(unsigned int) mdec->uuid[12],
				(unsigned int) mdec->uuid[13],
				(unsigned int) mdec->uuid[14],
				(unsigned int) mdec->uuid[15],
				offset);
			goto error;
		}
	}

	if ((header.content_size / CHAR_BIT) < sizeof(header)) {
		BT_LOGE("Bad metadata packet content size: content-size=%u, "
			"offset=%ld", header.content_size, offset);
		goto error;
	}

	toread = header.content_size / CHAR_BIT - sizeof(header);

	for (;;) {
		size_t loop_read;

		loop_read = MIN(sizeof(buf) - 1, toread);
		readlen = fread(buf, sizeof(uint8_t), loop_read, in_fp);
		if (ferror(in_fp)) {
			BT_LOGE("Cannot read metadata packet buffer: "
				"offset=%ld, read-size=%zu",
				ftell(in_fp), loop_read);
			goto error;
		}
		if (readlen > loop_read) {
			BT_LOGE("fread returned more byte than expected: "
				"read-size-asked=%zu, read-size-returned=%zu",
				loop_read, readlen);
			goto error;
		}

		writelen = fwrite(buf, sizeof(uint8_t), readlen, out_fp);
		if (writelen < readlen || ferror(out_fp)) {
			BT_LOGE("Cannot write decoded metadata text to buffer: "
				"read-offset=%ld, write-size=%zu",
				ftell(in_fp), readlen);
			goto error;
		}

		toread -= readlen;
		if (toread == 0) {
			int fseek_ret;

			/* Read leftover padding */
			toread = (header.packet_size - header.content_size) /
				CHAR_BIT;
			fseek_ret = fseek(in_fp, toread, SEEK_CUR);
			if (fseek_ret < 0) {
				BT_LOGW_STR("Missing padding at the end of the metadata stream.");
			}
			break;
		}
	}

	goto end;

error:
	ret = -1;

end:
	return ret;
}

static
int ctf_metadata_decoder_packetized_file_stream_to_buf_with_mdec(
		struct ctf_metadata_decoder *mdec, FILE *fp,
		char **buf, int byte_order)
{
	FILE *out_fp;
	size_t size;
	int ret = 0;
	int tret;
	size_t packet_index = 0;

	out_fp = bt_open_memstream(buf, &size);
	if (out_fp == NULL) {
		BT_LOGE("Cannot open memory stream: %s: mdec-addr=%p",
			strerror(errno), mdec);
		goto error;
	}

	for (;;) {
		if (feof(fp) != 0) {
			break;
		}

		tret = decode_packet(mdec, fp, out_fp, byte_order);
		if (tret) {
			BT_LOGE("Cannot decode packet: index=%zu, mdec-addr=%p",
				packet_index, mdec);
			goto error;
		}

		packet_index++;
	}

	/* Make sure the whole string ends with a null character */
	tret = fputc('\0', out_fp);
	if (tret == EOF) {
		BT_LOGE("Cannot append '\\0' to the decoded metadata buffer: "
			"mdec-addr=%p", mdec);
		goto error;
	}

	/* Close stream, which also flushes the buffer */
	ret = bt_close_memstream(buf, &size, out_fp);
	/*
	 * See fclose(3). Further access to out_fp after both success
	 * and error, even through another bt_close_memstream(), results
	 * in undefined behavior. Nullify out_fp to ensure we don't
	 * fclose it twice on error.
	 */
	out_fp = NULL;
	if (ret < 0) {
		BT_LOGE("Cannot close memory stream: %s: mdec-addr=%p",
			strerror(errno), mdec);
		goto error;
	}

	goto end;

error:
	ret = -1;

	if (out_fp) {
		if (bt_close_memstream(buf, &size, out_fp)) {
			BT_LOGE("Cannot close memory stream: %s: mdec-addr=%p",
				strerror(errno), mdec);
		}
	}

	if (*buf) {
		free(*buf);
		*buf = NULL;
	}

end:
	return ret;
}

BT_HIDDEN
int ctf_metadata_decoder_packetized_file_stream_to_buf(
		FILE *fp, char **buf, int byte_order)
{
	return ctf_metadata_decoder_packetized_file_stream_to_buf_with_mdec(
		NULL, fp, buf, byte_order);
}

BT_HIDDEN
struct ctf_metadata_decoder *ctf_metadata_decoder_create(
		const struct ctf_metadata_decoder_config *config,
		const char *name)
{
	struct ctf_metadata_decoder *mdec =
		g_new0(struct ctf_metadata_decoder, 1);
	struct ctf_metadata_decoder_config default_config = {
		.clock_class_offset_s = 0,
		.clock_class_offset_ns = 0,
	};

	if (!config) {
		config = &default_config;
	}

	BT_LOGD("Creating CTF metadata decoder: "
		"clock-class-offset-s=%" PRId64 ", "
		"clock-class-offset-ns=%" PRId64 ", name=\"%s\"",
		config->clock_class_offset_s, config->clock_class_offset_ns,
		name);

	if (!mdec) {
		BT_LOGE_STR("Failed to allocate one CTF metadata decoder.");
		goto end;
	}

	mdec->config = *config;
	mdec->visitor = ctf_visitor_generate_ir_create(config, name);
	if (!mdec->visitor) {
		BT_LOGE("Failed to create a CTF IR metadata AST visitor: "
			"mdec-addr=%p", mdec);
		ctf_metadata_decoder_destroy(mdec);
		mdec = NULL;
		goto end;
	}

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

end:
	return mdec;
}

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

	BT_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_decode(
		struct ctf_metadata_decoder *mdec, FILE *fp)
{
	enum ctf_metadata_decoder_status status =
		CTF_METADATA_DECODER_STATUS_OK;
	int ret;
	struct ctf_scanner *scanner = NULL;
	char *buf = NULL;
	bool close_fp = false;

	BT_ASSERT(mdec);

	if (ctf_metadata_decoder_is_packetized(fp, &mdec->bo)) {
		BT_LOGD("Metadata stream is packetized: mdec-addr=%p", mdec);
		ret = ctf_metadata_decoder_packetized_file_stream_to_buf_with_mdec(
			mdec, fp, &buf, mdec->bo);
		if (ret) {
			BT_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_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_LOGD("Metadata stream is plain text: mdec-addr=%p", mdec);

		if (init_pos < 0) {
			BT_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_LOGW("Missing \"/* CTF major.minor\" signature in plain text metadata file stream: "
				"mdec-addr=%p", mdec);
		}

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

		if (!is_version_valid(major, minor)) {
			BT_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_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_VERBOSE) {
		yydebug = 1;
	}

	/* Allocate a scanner and append the metadata text content */
	scanner = ctf_scanner_alloc();
	if (!scanner) {
		BT_LOGE("Cannot allocate a metadata lexical scanner: "
			"mdec-addr=%p", mdec);
		status = CTF_METADATA_DECODER_STATUS_ERROR;
		goto end;
	}

	BT_ASSERT(fp);
	ret = ctf_scanner_append_ast(scanner, fp);
	if (ret) {
		BT_LOGE("Cannot create the metadata AST out of the metadata text: "
			"mdec-addr=%p", mdec);
		status = CTF_METADATA_DECODER_STATUS_INCOMPLETE;
		goto end;
	}

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

	ret = ctf_visitor_generate_ir_visit_node(mdec->visitor,
		&scanner->ast->root);
	// TODO
	ret = -1;
	goto end;

	switch (ret) {
	case 0:
		/* Success */
		break;
	case -EINCOMPLETE:
		BT_LOGD("While visiting metadata AST: incomplete data: "
			"mdec-addr=%p", mdec);
		status = CTF_METADATA_DECODER_STATUS_INCOMPLETE;
		goto end;
	default:
		BT_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 (scanner) {
		ctf_scanner_free(scanner);
	}

	yydebug = 0;

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

	if (buf) {
		free(buf);
	}

	return status;
}

BT_HIDDEN
struct bt_trace *ctf_metadata_decoder_get_ir_trace(
		struct ctf_metadata_decoder *mdec)
{
	return ctf_visitor_generate_ir_get_ir_trace(mdec->visitor);
}

BT_HIDDEN
struct ctf_trace_class *ctf_metadata_decoder_borrow_ctf_trace_class(
		struct ctf_metadata_decoder *mdec)
{
	return ctf_visitor_generate_ir_borrow_ctf_trace_class(mdec->visitor);
}
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
d6e20753 PP	15	#define BT_LOG_TAG "PLUGIN-CTF-METADATA-DECODER"
	16	#include "logging.h"
	17
1e649dff PP	18	#include <stdio.h>
	19	#include <stdbool.h>
	20	#include <stdint.h>
	21	#include <stdlib.h>
d6e20753	22	#include <inttypes.h>
f6ccaed9	23	#include <babeltrace/assert-internal.h>
3d9990ac PP	24	#include <babeltrace/compat/uuid-internal.h>
3d9990ac PP	25	#include <babeltrace/compat/memstream-internal.h>
9d408fca	26	#include <babeltrace/babeltrace.h>
1e649dff	27	#include <glib.h>
e9383dfd	28	#include <string.h>
1e649dff PP	29
	30	#include "ast.h"
	31	#include "decoder.h"
	32	#include "scanner.h"
	33
1e649dff PP	34	#define TSDL_MAGIC 0x75d11d57
1e649dff PP	35
61d6f9b1	36	extern
f73367f8 PP	37	int yydebug;
f73367f8 PP	38
1e649dff PP	39	struct ctf_metadata_decoder {
1e649dff PP	40	struct ctf_visitor_generate_ir *visitor;
1e649dff PP	41	uint8_t uuid[16];
	42	bool is_uuid_set;
	43	int bo;
a2a54545	44	struct ctf_metadata_decoder_config config;
1e649dff PP	45	};
	46
	47	struct packet_header {
	48	uint32_t magic;
	49	uint8_t uuid[16];
	50	uint32_t checksum;
	51	uint32_t content_size;
	52	uint32_t packet_size;
	53	uint8_t compression_scheme;
	54	uint8_t encryption_scheme;
	55	uint8_t checksum_scheme;
	56	uint8_t major;
	57	uint8_t minor;
	58	} __attribute__((__packed__));
	59
	60	BT_HIDDEN
	61	bool ctf_metadata_decoder_is_packetized(FILE fp, int byte_order)
	62	{
	63	uint32_t magic;
	64	size_t len;
	65	int ret = 0;
	66
	67	len = fread(&magic, sizeof(magic), 1, fp);
	68	if (len != 1) {
d6e20753	69	BT_LOGD_STR("Cannot reade first metadata packet header: assuming the stream is not packetized.");
1e649dff PP	70	goto end;
	71	}
	72
	73	if (byte_order) {
	74	if (magic == TSDL_MAGIC) {
	75	ret = 1;
	76	*byte_order = BYTE_ORDER;
	77	} else if (magic == GUINT32_SWAP_LE_BE(TSDL_MAGIC)) {
	78	ret = 1;
	79	*byte_order = BYTE_ORDER == BIG_ENDIAN ?
	80	LITTLE_ENDIAN : BIG_ENDIAN;
	81	}
	82	}
	83
	84	end:
	85	rewind(fp);
	86
	87	return ret;
	88	}
	89
	90	static
	91	bool is_version_valid(unsigned int major, unsigned int minor)
	92	{
	93	return major == 1 && minor == 8;
	94	}
	95
	96	static
	97	int decode_packet(struct ctf_metadata_decoder mdec, FILE in_fp, FILE *out_fp,
	98	int byte_order)
	99	{
	100	struct packet_header header;
	101	size_t readlen, writelen, toread;
	102	uint8_t buf[512 + 1]; /* + 1 for debug-mode \0 */
	103	int ret = 0;
d6e20753	104	const long offset = ftell(in_fp);
1e649dff	105
9e254855 MD	106	if (offset < 0) {
	107	BT_LOGE_ERRNO("Failed to get current metadata file position",
	108	".");
	109	goto error;
	110	}
d6e20753 PP	111	BT_LOGV("Decoding metadata packet: mdec-addr=%p, offset=%ld",
d6e20753 PP	112	mdec, offset);
1e649dff PP	113	readlen = fread(&header, sizeof(header), 1, in_fp);
1e649dff PP	114	if (feof(in_fp) != 0) {
d6e20753	115	BT_LOGV("Reached end of file: offset=%ld", ftell(in_fp));
1e649dff PP	116	goto end;
	117	}
	118	if (readlen < 1) {
d6e20753	119	BT_LOGV("Cannot decode metadata packet: offset=%ld", offset);
1e649dff PP	120	goto error;
	121	}
	122
	123	if (byte_order != BYTE_ORDER) {
	124	header.magic = GUINT32_SWAP_LE_BE(header.magic);
	125	header.checksum = GUINT32_SWAP_LE_BE(header.checksum);
	126	header.content_size = GUINT32_SWAP_LE_BE(header.content_size);
	127	header.packet_size = GUINT32_SWAP_LE_BE(header.packet_size);
	128	}
	129
	130	if (header.compression_scheme) {
d6e20753 PP	131	BT_LOGE("Metadata packet compression is not supported as of this version: "
	132	"compression-scheme=%u, offset=%ld",
	133	(unsigned int) header.compression_scheme, offset);
1e649dff PP	134	goto error;
	135	}
	136
	137	if (header.encryption_scheme) {
d6e20753 PP	138	BT_LOGE("Metadata packet encryption is not supported as of this version: "
	139	"encryption-scheme=%u, offset=%ld",
	140	(unsigned int) header.encryption_scheme, offset);
1e649dff PP	141	goto error;
	142	}
	143
	144	if (header.checksum \|\| header.checksum_scheme) {
d6e20753 PP	145	BT_LOGE("Metadata packet checksum verification is not supported as of this version: "
	146	"checksum-scheme=%u, checksum=%x, offset=%ld",
	147	(unsigned int) header.checksum_scheme, header.checksum,
	148	offset);
1e649dff PP	149	goto error;
	150	}
	151
	152	if (!is_version_valid(header.major, header.minor)) {
d6e20753 PP	153	BT_LOGE("Invalid metadata packet version: "
	154	"version=%u.%u, offset=%ld",
	155	header.major, header.minor, offset);
1e649dff PP	156	goto error;
	157	}
	158
	159	/* Set expected trace UUID if not set; otherwise validate it */
	160	if (mdec) {
	161	if (!mdec->is_uuid_set) {
	162	memcpy(mdec->uuid, header.uuid, sizeof(header.uuid));
	163	mdec->is_uuid_set = true;
	164	} else if (bt_uuid_compare(header.uuid, mdec->uuid)) {
d6e20753 PP	165	BT_LOGE("Metadata UUID mismatch between packets of the same stream: "
	166	"packet-uuid=\"%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x\", "
	167	"expected-uuid=\"%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x\", "
	168	"offset=%ld",
	169	(unsigned int) header.uuid[0],
	170	(unsigned int) header.uuid[1],
	171	(unsigned int) header.uuid[2],
	172	(unsigned int) header.uuid[3],
	173	(unsigned int) header.uuid[4],
	174	(unsigned int) header.uuid[5],
	175	(unsigned int) header.uuid[6],
	176	(unsigned int) header.uuid[7],
	177	(unsigned int) header.uuid[8],
	178	(unsigned int) header.uuid[9],
	179	(unsigned int) header.uuid[10],
	180	(unsigned int) header.uuid[11],
	181	(unsigned int) header.uuid[12],
	182	(unsigned int) header.uuid[13],
	183	(unsigned int) header.uuid[14],
	184	(unsigned int) header.uuid[15],
	185	(unsigned int) mdec->uuid[0],
	186	(unsigned int) mdec->uuid[1],
	187	(unsigned int) mdec->uuid[2],
	188	(unsigned int) mdec->uuid[3],
	189	(unsigned int) mdec->uuid[4],
	190	(unsigned int) mdec->uuid[5],
	191	(unsigned int) mdec->uuid[6],
	192	(unsigned int) mdec->uuid[7],
	193	(unsigned int) mdec->uuid[8],
	194	(unsigned int) mdec->uuid[9],
	195	(unsigned int) mdec->uuid[10],
	196	(unsigned int) mdec->uuid[11],
	197	(unsigned int) mdec->uuid[12],
	198	(unsigned int) mdec->uuid[13],
	199	(unsigned int) mdec->uuid[14],
	200	(unsigned int) mdec->uuid[15],
	201	offset);
1e649dff PP	202	goto error;
	203	}
	204	}
	205
	206	if ((header.content_size / CHAR_BIT) < sizeof(header)) {
d6e20753 PP	207	BT_LOGE("Bad metadata packet content size: content-size=%u, "
d6e20753 PP	208	"offset=%ld", header.content_size, offset);
1e649dff PP	209	goto error;
	210	}
	211
	212	toread = header.content_size / CHAR_BIT - sizeof(header);
	213
	214	for (;;) {
9e254855 MD	215	size_t loop_read;
	216
	217	loop_read = MIN(sizeof(buf) - 1, toread);
	218	readlen = fread(buf, sizeof(uint8_t), loop_read, in_fp);
1e649dff	219	if (ferror(in_fp)) {
d6e20753	220	BT_LOGE("Cannot read metadata packet buffer: "
9e254855 MD	221	"offset=%ld, read-size=%zu",
	222	ftell(in_fp), loop_read);
	223	goto error;
	224	}
	225	if (readlen > loop_read) {
	226	BT_LOGE("fread returned more byte than expected: "
	227	"read-size-asked=%zu, read-size-returned=%zu",
	228	loop_read, readlen);
1e649dff PP	229	goto error;
	230	}
	231
	232	writelen = fwrite(buf, sizeof(uint8_t), readlen, out_fp);
	233	if (writelen < readlen \|\| ferror(out_fp)) {
d6e20753	234	BT_LOGE("Cannot write decoded metadata text to buffer: "
9e254855 MD	235	"read-offset=%ld, write-size=%zu",
9e254855 MD	236	ftell(in_fp), readlen);
1e649dff PP	237	goto error;
	238	}
	239
	240	toread -= readlen;
	241	if (toread == 0) {
	242	int fseek_ret;
	243
	244	/* Read leftover padding */
	245	toread = (header.packet_size - header.content_size) /
	246	CHAR_BIT;
	247	fseek_ret = fseek(in_fp, toread, SEEK_CUR);
	248	if (fseek_ret < 0) {
d6e20753	249	BT_LOGW_STR("Missing padding at the end of the metadata stream.");
1e649dff	250	}
1e649dff PP	251	break;
	252	}
	253	}
	254
	255	goto end;
	256
	257	error:
	258	ret = -1;
	259
	260	end:
	261	return ret;
	262	}
	263
	264	static
	265	int ctf_metadata_decoder_packetized_file_stream_to_buf_with_mdec(
	266	struct ctf_metadata_decoder mdec, FILE fp,
	267	char **buf, int byte_order)
	268	{
	269	FILE *out_fp;
	270	size_t size;
	271	int ret = 0;
	272	int tret;
	273	size_t packet_index = 0;
	274
	275	out_fp = bt_open_memstream(buf, &size);
	276	if (out_fp == NULL) {
d6e20753 PP	277	BT_LOGE("Cannot open memory stream: %s: mdec-addr=%p",
d6e20753 PP	278	strerror(errno), mdec);
1e649dff PP	279	goto error;
	280	}
	281
	282	for (;;) {
	283	if (feof(fp) != 0) {
	284	break;
	285	}
	286
	287	tret = decode_packet(mdec, fp, out_fp, byte_order);
	288	if (tret) {
d6e20753 PP	289	BT_LOGE("Cannot decode packet: index=%zu, mdec-addr=%p",
d6e20753 PP	290	packet_index, mdec);
1e649dff PP	291	goto error;
	292	}
	293
	294	packet_index++;
	295	}
	296
	297	/* Make sure the whole string ends with a null character */
	298	tret = fputc('\0', out_fp);
	299	if (tret == EOF) {
d6e20753 PP	300	BT_LOGE("Cannot append '\\0' to the decoded metadata buffer: "
d6e20753 PP	301	"mdec-addr=%p", mdec);
1e649dff PP	302	goto error;
	303	}
	304
	305	/* Close stream, which also flushes the buffer */
	306	ret = bt_close_memstream(buf, &size, out_fp);
47eba00a MD	307	/*
	308	* See fclose(3). Further access to out_fp after both success
	309	* and error, even through another bt_close_memstream(), results
	310	* in undefined behavior. Nullify out_fp to ensure we don't
	311	* fclose it twice on error.
	312	*/
	313	out_fp = NULL;
1e649dff	314	if (ret < 0) {
d6e20753 PP	315	BT_LOGE("Cannot close memory stream: %s: mdec-addr=%p",
d6e20753 PP	316	strerror(errno), mdec);
1e649dff PP	317	goto error;
	318	}
	319
	320	goto end;
	321
	322	error:
	323	ret = -1;
	324
	325	if (out_fp) {
d6e20753 PP	326	if (bt_close_memstream(buf, &size, out_fp)) {
	327	BT_LOGE("Cannot close memory stream: %s: mdec-addr=%p",
	328	strerror(errno), mdec);
	329	}
1e649dff PP	330	}
	331
	332	if (*buf) {
	333	free(*buf);
8318bbaa	334	*buf = NULL;
1e649dff PP	335	}
	336
	337	end:
	338	return ret;
	339	}
	340
	341	BT_HIDDEN
	342	int ctf_metadata_decoder_packetized_file_stream_to_buf(
	343	FILE fp, char *buf, int byte_order)
	344	{
	345	return ctf_metadata_decoder_packetized_file_stream_to_buf_with_mdec(
	346	NULL, fp, buf, byte_order);
	347	}
	348
	349	BT_HIDDEN
55314f2a	350	struct ctf_metadata_decoder *ctf_metadata_decoder_create(
a2a54545 PP	351	const struct ctf_metadata_decoder_config *config,
a2a54545 PP	352	const char *name)
1e649dff PP	353	{
	354	struct ctf_metadata_decoder *mdec =
	355	g_new0(struct ctf_metadata_decoder, 1);
a2a54545 PP	356	struct ctf_metadata_decoder_config default_config = {
	357	.clock_class_offset_s = 0,
	358	.clock_class_offset_ns = 0,
a2a54545 PP	359	};
	360
	361	if (!config) {
	362	config = &default_config;
	363	}
1e649dff	364
d6e20753	365	BT_LOGD("Creating CTF metadata decoder: "
a2a54545	366	"clock-class-offset-s=%" PRId64 ", "
7bf5af54	367	"clock-class-offset-ns=%" PRId64 ", name=\"%s\"",
a2a54545	368	config->clock_class_offset_s, config->clock_class_offset_ns,
7bf5af54	369	name);
d6e20753	370
1e649dff	371	if (!mdec) {
d6e20753	372	BT_LOGE_STR("Failed to allocate one CTF metadata decoder.");
1e649dff PP	373	goto end;
	374	}
	375
a2a54545 PP	376	mdec->config = *config;
a2a54545 PP	377	mdec->visitor = ctf_visitor_generate_ir_create(config, name);
1e649dff	378	if (!mdec->visitor) {
d6e20753 PP	379	BT_LOGE("Failed to create a CTF IR metadata AST visitor: "
d6e20753 PP	380	"mdec-addr=%p", mdec);
1e649dff PP	381	ctf_metadata_decoder_destroy(mdec);
	382	mdec = NULL;
	383	goto end;
	384	}
	385
a2a54545 PP	386	BT_LOGD("Creating CTF metadata decoder: "
	387	"clock-class-offset-s=%" PRId64 ", "
	388	"clock-class-offset-ns=%" PRId64 ", "
7bf5af54	389	"name=\"%s\", addr=%p",
a2a54545	390	config->clock_class_offset_s, config->clock_class_offset_ns,
7bf5af54	391	name, mdec);
d6e20753	392
1e649dff PP	393	end:
	394	return mdec;
	395	}
	396
	397	BT_HIDDEN
	398	void ctf_metadata_decoder_destroy(struct ctf_metadata_decoder *mdec)
	399	{
	400	if (!mdec) {
	401	return;
	402	}
	403
d6e20753	404	BT_LOGD("Destroying CTF metadata decoder: addr=%p", mdec);
1e649dff PP	405	ctf_visitor_generate_ir_destroy(mdec->visitor);
	406	g_free(mdec);
	407	}
	408
	409	BT_HIDDEN
	410	enum ctf_metadata_decoder_status ctf_metadata_decoder_decode(
	411	struct ctf_metadata_decoder mdec, FILE fp)
	412	{
	413	enum ctf_metadata_decoder_status status =
	414	CTF_METADATA_DECODER_STATUS_OK;
	415	int ret;
	416	struct ctf_scanner *scanner = NULL;
	417	char *buf = NULL;
	418	bool close_fp = false;
	419
f6ccaed9	420	BT_ASSERT(mdec);
1e649dff PP	421
1e649dff PP	422	if (ctf_metadata_decoder_is_packetized(fp, &mdec->bo)) {
d6e20753	423	BT_LOGD("Metadata stream is packetized: mdec-addr=%p", mdec);
1e649dff PP	424	ret = ctf_metadata_decoder_packetized_file_stream_to_buf_with_mdec(
	425	mdec, fp, &buf, mdec->bo);
	426	if (ret) {
d6e20753 PP	427	BT_LOGE("Cannot decode packetized metadata packets to metadata text: "
d6e20753 PP	428	"mdec-addr=%p, ret=%d", mdec, ret);
1e649dff PP	429	status = CTF_METADATA_DECODER_STATUS_ERROR;
	430	goto end;
	431	}
	432
7cdc2bab MD	433	if (strlen(buf) == 0) {
	434	/* An empty metadata packet is OK. */
	435	goto end;
	436	}
	437
1e649dff PP	438	/* Convert the real file pointer to a memory file pointer */
	439	fp = bt_fmemopen(buf, strlen(buf), "rb");
	440	close_fp = true;
	441	if (!fp) {
d6e20753 PP	442	BT_LOGE("Cannot memory-open metadata buffer: %s: "
d6e20753 PP	443	"mdec-addr=%p", strerror(errno), mdec);
1e649dff PP	444	status = CTF_METADATA_DECODER_STATUS_ERROR;
	445	goto end;
	446	}
	447	} else {
	448	unsigned int major, minor;
	449	ssize_t nr_items;
	450	const long init_pos = ftell(fp);
	451
d6e20753	452	BT_LOGD("Metadata stream is plain text: mdec-addr=%p", mdec);
1e649dff	453
1e95e5e8 MD	454	if (init_pos < 0) {
	455	BT_LOGE_ERRNO("Failed to get current file position", ".");
	456	status = CTF_METADATA_DECODER_STATUS_ERROR;
	457	goto end;
	458	}
	459
1e649dff PP	460	/* Check text-only metadata header and version */
	461	nr_items = fscanf(fp, "/* CTF %10u.%10u", &major, &minor);
	462	if (nr_items < 2) {
d6e20753 PP	463	BT_LOGW("Missing \"/* CTF major.minor\" signature in plain text metadata file stream: "
d6e20753 PP	464	"mdec-addr=%p", mdec);
1e649dff PP	465	}
1e649dff PP	466
d6e20753	467	BT_LOGD("Found metadata stream version in signature: version=%u.%u", major, minor);
1e649dff PP	468
1e649dff PP	469	if (!is_version_valid(major, minor)) {
d6e20753 PP	470	BT_LOGE("Invalid metadata version found in plain text signature: "
	471	"version=%u.%u, mdec-addr=%p", major, minor,
	472	mdec);
1e649dff PP	473	status = CTF_METADATA_DECODER_STATUS_INVAL_VERSION;
	474	goto end;
	475	}
	476
	477	if (fseek(fp, init_pos, SEEK_SET)) {
d6e20753 PP	478	BT_LOGE("Cannot seek metadata file stream to initial position: %s: "
d6e20753 PP	479	"mdec-addr=%p", strerror(errno), mdec);
1e649dff PP	480	status = CTF_METADATA_DECODER_STATUS_ERROR;
	481	goto end;
	482	}
	483	}
	484
f73367f8 PP	485	if (BT_LOG_ON_VERBOSE) {
	486	yydebug = 1;
	487	}
	488
1e649dff PP	489	/* Allocate a scanner and append the metadata text content */
	490	scanner = ctf_scanner_alloc();
	491	if (!scanner) {
d6e20753 PP	492	BT_LOGE("Cannot allocate a metadata lexical scanner: "
d6e20753 PP	493	"mdec-addr=%p", mdec);
1e649dff PP	494	status = CTF_METADATA_DECODER_STATUS_ERROR;
	495	goto end;
	496	}
	497
f6ccaed9	498	BT_ASSERT(fp);
1e649dff PP	499	ret = ctf_scanner_append_ast(scanner, fp);
1e649dff PP	500	if (ret) {
d6e20753 PP	501	BT_LOGE("Cannot create the metadata AST out of the metadata text: "
d6e20753 PP	502	"mdec-addr=%p", mdec);
1e649dff PP	503	status = CTF_METADATA_DECODER_STATUS_INCOMPLETE;
	504	goto end;
	505	}
	506
55314f2a	507	ret = ctf_visitor_semantic_check(0, &scanner->ast->root);
1e649dff	508	if (ret) {
d6e20753 PP	509	BT_LOGE("Validation of the metadata semantics failed: "
d6e20753 PP	510	"mdec-addr=%p", mdec);
1e649dff PP	511	status = CTF_METADATA_DECODER_STATUS_ERROR;
	512	goto end;
	513	}
	514
	515	ret = ctf_visitor_generate_ir_visit_node(mdec->visitor,
	516	&scanner->ast->root);
44c440bc PP	517	// TODO
	518	ret = -1;
	519	goto end;
	520
1e649dff PP	521	switch (ret) {
	522	case 0:
	523	/* Success */
	524	break;
	525	case -EINCOMPLETE:
d6e20753 PP	526	BT_LOGD("While visiting metadata AST: incomplete data: "
d6e20753 PP	527	"mdec-addr=%p", mdec);
1e649dff PP	528	status = CTF_METADATA_DECODER_STATUS_INCOMPLETE;
	529	goto end;
	530	default:
d6e20753 PP	531	BT_LOGE("Failed to visit AST node to create CTF IR objects: "
d6e20753 PP	532	"mdec-addr=%p, ret=%d", mdec, ret);
1e649dff PP	533	status = CTF_METADATA_DECODER_STATUS_IR_VISITOR_ERROR;
	534	goto end;
	535	}
	536
	537	end:
	538	if (scanner) {
	539	ctf_scanner_free(scanner);
	540	}
	541
f73367f8 PP	542	yydebug = 0;
f73367f8 PP	543
1e649dff PP	544	if (fp && close_fp) {
1e649dff PP	545	if (fclose(fp)) {
d6e20753 PP	546	BT_LOGE("Cannot close metadata file stream: "
d6e20753 PP	547	"mdec-addr=%p", mdec);
1e649dff PP	548	}
	549	}
	550
	551	if (buf) {
	552	free(buf);
	553	}
	554
	555	return status;
	556	}
	557
	558	BT_HIDDEN
44c440bc PP	559	struct bt_trace *ctf_metadata_decoder_get_ir_trace(
	560	struct ctf_metadata_decoder *mdec)
	561	{
	562	return ctf_visitor_generate_ir_get_ir_trace(mdec->visitor);
	563	}
	564
	565	BT_HIDDEN
	566	struct ctf_trace_class *ctf_metadata_decoder_borrow_ctf_trace_class(
1e649dff PP	567	struct ctf_metadata_decoder *mdec)
1e649dff PP	568	{
44c440bc	569	return ctf_visitor_generate_ir_borrow_ctf_trace_class(mdec->visitor);
1e649dff	570	}