[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 <assert.h>
#include <babeltrace/compat/uuid-internal.h>
#include <babeltrace/compat/memstream-internal.h>
#include <babeltrace/ctf-ir/trace.h>
#include <glib.h>
#include <string.h>

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

#define TSDL_MAGIC	0x75d11d57

BT_HIDDEN
int yydebug;

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

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

	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 (;;) {
		readlen = fread(buf, sizeof(uint8_t),
			MIN(sizeof(buf) - 1, toread), in_fp);
		if (ferror(in_fp)) {
			BT_LOGE("Cannot read metadata packet buffer: "
				"offset=%ld, read-size=%u",
				ftell(in_fp), (unsigned int) 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=%u",
				ftell(in_fp), (unsigned int) 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);
	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(
		int64_t clock_class_offset_ns, const char *name)
{
	struct ctf_metadata_decoder *mdec =
		g_new0(struct ctf_metadata_decoder, 1);

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

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

	mdec->visitor = ctf_visitor_generate_ir_create(clock_class_offset_ns,
			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("Created CTF metadata decoder: "
		"clock-class-offset-ns=%" PRId64 ", name=\"%s\", addr=%p",
		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;

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

		/* 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;
	}

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