[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_LOG_OUTPUT_LEVEL (mdec->config.log_level)
#define BT_LOG_TAG "PLUGIN/CTF/META/DECODER"
#include "logging/log.h"

#include <stdio.h>
#include <stdbool.h>
#include <stdint.h>
#include <stdlib.h>
#include <inttypes.h>
#include "common/assert.h"
#include "compat/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"

#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,
		bt_logging_level log_level)
{
	uint32_t magic;
	size_t len;
	int ret = 0;

	len = fread(&magic, sizeof(magic), 1, fp);
	if (len != 1) {
		BT_LOG_WRITE_CUR_LVL(BT_LOG_INFO, log_level, BT_LOG_TAG,
			"Cannot read 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_LOGD("Decoding metadata packet: mdec-addr=%p, offset=%ld",
		mdec, offset);
	readlen = fread(&header, sizeof(header), 1, in_fp);
	if (feof(in_fp) != 0) {
		BT_LOGI("Reached end of file: offset=%ld", ftell(in_fp));
		goto end;
	}
	if (readlen < 1) {
		BT_LOGE("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, bt_logging_level log_level)
{
	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_LOG_WRITE_CUR_LVL(BT_LOG_ERROR, log_level, BT_LOG_TAG,
			"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_LOG_WRITE_CUR_LVL(BT_LOG_ERROR, log_level, BT_LOG_TAG,
				"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_LOG_WRITE_CUR_LVL(BT_LOG_ERROR, log_level, BT_LOG_TAG,
			"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_LOG_WRITE_ERRNO_CUR_LVL(BT_LOG_ERROR, log_level, BT_LOG_TAG,
			"Cannot close memory stream", ": mdec-addr=%p", mdec);
		goto error;
	}

	goto end;

error:
	ret = -1;

	if (out_fp) {
		if (bt_close_memstream(buf, &size, out_fp)) {
			BT_LOG_WRITE_CUR_LVL(BT_LOG_ERROR, log_level, BT_LOG_TAG,
				"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,
		bt_logging_level log_level)
{
	return ctf_metadata_decoder_packetized_file_stream_to_buf_with_mdec(
		NULL, fp, buf, byte_order, log_level);
}

BT_HIDDEN
struct ctf_metadata_decoder *ctf_metadata_decoder_create(
		bt_self_component_source *self_comp,
		const struct ctf_metadata_decoder_config *config)
{
	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,
		config->clock_class_offset_s, config->clock_class_offset_ns);

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

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