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

/*
 * SPDX-License-Identifier: MIT
 *
 * Copyright 2016-2017 Philippe Proulx <pproulx@efficios.com>
 */

#define BT_COMP_LOG_SELF_COMP       (mdec->config.self_comp)
#define BT_COMP_LOG_SELF_COMP_CLASS (mdec->config.self_comp_class)
#define BT_LOG_OUTPUT_LEVEL         (mdec->config.log_level)
#define BT_LOG_TAG                  "PLUGIN/CTF/META/DECODER"
#include "logging/comp-logging.h"

#include <stdio.h>
#include <stdbool.h>
#include <stdint.h>
#include <stdlib.h>
#include <inttypes.h>
#include "common/assert.h"
#include "common/uuid.h"
#include "compat/memstream.h"
#include <babeltrace2/babeltrace.h>
#include <glib.h>
#include <string.h>

#include "ast.hpp"
#include "decoder.hpp"
#include "scanner.hpp"
#include "logging.hpp"
#include "parser-wrap.hpp"
#include "decoder-packetized-file-stream-to-buf.hpp"

#define TSDL_MAGIC 0x75d11d57

struct ctf_metadata_decoder
{
    struct ctf_scanner *scanner;
    GString *text;
    struct ctf_visitor_generate_ir *visitor;
    bt_uuid_t uuid;
    bool is_uuid_set;
    int bo;
    struct ctf_metadata_decoder_config config;
    struct meta_log_config log_cfg;
};

struct packet_header
{
    uint32_t magic;
    bt_uuid_t uuid;
    uint32_t checksum;
    uint32_t content_size;
    uint32_t packet_size;
    uint8_t compression_scheme;
    uint8_t encryption_scheme;
    uint8_t checksum_scheme;
    uint8_t major;
    uint8_t minor;
} __attribute__((__packed__));

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

    *is_packetized = false;
    len = fread(&magic, sizeof(magic), 1, fp);
    if (len != 1) {
        BT_COMP_LOG_CUR_LVL(
            BT_LOG_INFO, log_level, self_comp,
            "Cannot read first metadata packet header: assuming the stream is not packetized.");
        ret = -1;
        goto end;
    }

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

end:
    rewind(fp);

    return ret;
}

BT_HIDDEN
struct ctf_metadata_decoder *
ctf_metadata_decoder_create(const struct ctf_metadata_decoder_config *config)
{
    struct ctf_metadata_decoder *mdec = g_new0(struct ctf_metadata_decoder, 1);

    BT_ASSERT(config);
    BT_COMP_LOG_CUR_LVL(BT_LOG_DEBUG, config->log_level, config->self_comp,
                        "Creating CTF metadata decoder: "
                        "clock-class-offset-s=%" PRId64 ", "
                        "clock-class-offset-ns=%" PRId64,
                        config->clock_class_offset_s, config->clock_class_offset_ns);

    if (!mdec) {
        BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR, config->log_level, config->self_comp,
                            "Failed to allocate one CTF metadata decoder.");
        goto end;
    }

    mdec->log_cfg.log_level = config->log_level;
    mdec->log_cfg.self_comp = config->self_comp;
    mdec->log_cfg.self_comp_class = config->self_comp_class;
    mdec->scanner = ctf_scanner_alloc();
    if (!mdec->scanner) {
        _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Cannot allocate a metadata lexical scanner: "
                                                 "mdec-addr=%p",
                                                 mdec);
        goto error;
    }

    mdec->text = g_string_new(NULL);
    if (!mdec->text) {
        _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Failed to allocate one GString: "
                                                 "mdec-addr=%p",
                                                 mdec);
        goto error;
    }

    mdec->bo = -1;
    mdec->config = *config;
    mdec->visitor = ctf_visitor_generate_ir_create(config);
    if (!mdec->visitor) {
        _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Failed to create a CTF IR metadata AST visitor: "
                                                 "mdec-addr=%p",
                                                 mdec);
        goto error;
    }

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

error:
    ctf_metadata_decoder_destroy(mdec);
    mdec = NULL;

end:
    return mdec;
}

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

    if (mdec->scanner) {
        ctf_scanner_free(mdec->scanner);
    }

    if (mdec->text) {
        g_string_free(mdec->text, TRUE);
    }

    BT_COMP_LOGD("Destroying CTF metadata decoder: addr=%p", mdec);
    ctf_visitor_generate_ir_destroy(mdec->visitor);
    g_free(mdec);
}

BT_HIDDEN
enum ctf_metadata_decoder_status
ctf_metadata_decoder_append_content(struct ctf_metadata_decoder *mdec, FILE *fp)
{
    enum ctf_metadata_decoder_status status = CTF_METADATA_DECODER_STATUS_OK;
    int ret;
    char *buf = NULL;
    bool close_fp = false;
    long start_pos = -1;
    bool is_packetized;

    BT_ASSERT(mdec);
    ret = ctf_metadata_decoder_is_packetized(fp, &is_packetized, &mdec->bo, mdec->config.log_level,
                                             mdec->config.self_comp);
    if (ret) {
        status = CTF_METADATA_DECODER_STATUS_ERROR;
        goto end;
    }

    if (is_packetized) {
        BT_COMP_LOGI("Metadata stream is packetized: mdec-addr=%p", mdec);
        ret = ctf_metadata_decoder_packetized_file_stream_to_buf(
            fp, &buf, mdec->bo, &mdec->is_uuid_set, mdec->uuid, mdec->config.log_level,
            mdec->config.self_comp, mdec->config.self_comp_class);
        if (ret) {
            _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
                "Cannot decode packetized metadata packets to metadata text: "
                "mdec-addr=%p, ret=%d",
                mdec, ret);
            status = CTF_METADATA_DECODER_STATUS_ERROR;
            goto end;
        }

        if (strlen(buf) == 0) {
            /* An empty metadata packet is OK. */
            goto end;
        }

        /* Convert the real file pointer to a memory file pointer */
        fp = bt_fmemopen(buf, strlen(buf), "rb");
        close_fp = true;
        if (!fp) {
            _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Cannot memory-open metadata buffer: %s: "
                                                     "mdec-addr=%p",
                                                     strerror(errno), mdec);
            status = CTF_METADATA_DECODER_STATUS_ERROR;
            goto end;
        }
    } else {
        unsigned int major, minor;
        ssize_t nr_items;
        const long init_pos = ftell(fp);

        BT_COMP_LOGI("Metadata stream is plain text: mdec-addr=%p", mdec);

        if (init_pos < 0) {
            BT_COMP_LOGE_APPEND_CAUSE_ERRNO(BT_COMP_LOG_SELF_COMP,
                                            "Failed to get current file position", ".");
            status = CTF_METADATA_DECODER_STATUS_ERROR;
            goto end;
        }

        /* Check text-only metadata header and version */
        nr_items = fscanf(fp, "/* CTF %10u.%10u", &major, &minor);
        if (nr_items < 2) {
            BT_COMP_LOGW(
                "Missing \"/* CTF major.minor\" signature in plain text metadata file stream: "
                "mdec-addr=%p",
                mdec);
        }

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

        if (!ctf_metadata_decoder_is_packet_version_valid(major, minor)) {
            _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
                "Invalid metadata version found in plain text signature: "
                "version=%u.%u, mdec-addr=%p",
                major, minor, mdec);
            status = CTF_METADATA_DECODER_STATUS_INVAL_VERSION;
            goto end;
        }

        if (fseek(fp, init_pos, SEEK_SET)) {
            _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
                "Cannot seek metadata file stream to initial position: %s: "
                "mdec-addr=%p",
                strerror(errno), mdec);
            status = CTF_METADATA_DECODER_STATUS_ERROR;
            goto end;
        }
    }

#if YYDEBUG
    if (BT_LOG_ON_TRACE) {
        yydebug = 1;
    }
#endif

    /* Save the file's position: we'll seek back to append the plain text */
    BT_ASSERT(fp);

    if (mdec->config.keep_plain_text) {
        start_pos = ftell(fp);
    }

    /* Append the metadata text content */
    ret = ctf_scanner_append_ast(mdec->scanner, fp);
    if (ret) {
        _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
            "Cannot create the metadata AST out of the metadata text: "
            "mdec-addr=%p",
            mdec);
        status = CTF_METADATA_DECODER_STATUS_INCOMPLETE;
        goto end;
    }

    /* We know it's complete: append plain text */
    if (mdec->config.keep_plain_text) {
        BT_ASSERT(start_pos != -1);
        ret = fseek(fp, start_pos, SEEK_SET);
        if (ret) {
            _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Failed to seek file: ret=%d, mdec-addr=%p",
                                                     ret, mdec);
            status = CTF_METADATA_DECODER_STATUS_ERROR;
            goto end;
        }

        ret = bt_common_append_file_content_to_g_string(mdec->text, fp);
        if (ret) {
            _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Failed to append to current plain text: "
                                                     "ret=%d, mdec-addr=%p",
                                                     ret, mdec);
            status = CTF_METADATA_DECODER_STATUS_ERROR;
            goto end;
        }
    }

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

    if (mdec->config.create_trace_class) {
        ret = ctf_visitor_generate_ir_visit_node(mdec->visitor, &mdec->scanner->ast->root);
        switch (ret) {
        case 0:
            /* Success */
            break;
        case -EINCOMPLETE:
            BT_COMP_LOGD("While visiting metadata AST: incomplete data: "
                         "mdec-addr=%p",
                         mdec);
            status = CTF_METADATA_DECODER_STATUS_INCOMPLETE;
            goto end;
        default:
            _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
                "Failed to visit AST node to create CTF IR objects: "
                "mdec-addr=%p, ret=%d",
                mdec, ret);
            status = CTF_METADATA_DECODER_STATUS_IR_VISITOR_ERROR;
            goto end;
        }
    }

end:
#if YYDEBUG
    yydebug = 0;
#endif

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

    free(buf);

    return status;
}

BT_HIDDEN
bt_trace_class *ctf_metadata_decoder_get_ir_trace_class(struct ctf_metadata_decoder *mdec)
{
    BT_ASSERT_DBG(mdec);
    BT_ASSERT_DBG(mdec->config.create_trace_class);
    return ctf_visitor_generate_ir_get_ir_trace_class(mdec->visitor);
}

BT_HIDDEN
struct ctf_trace_class *
ctf_metadata_decoder_borrow_ctf_trace_class(struct ctf_metadata_decoder *mdec)
{
    BT_ASSERT_DBG(mdec);
    BT_ASSERT_DBG(mdec->config.create_trace_class);
    return ctf_visitor_generate_ir_borrow_ctf_trace_class(mdec->visitor);
}

BT_HIDDEN
const char *ctf_metadata_decoder_get_text(struct ctf_metadata_decoder *mdec)
{
    BT_ASSERT_DBG(mdec);
    BT_ASSERT_DBG(mdec->config.keep_plain_text);
    return mdec->text->str;
}

BT_HIDDEN
int ctf_metadata_decoder_get_byte_order(struct ctf_metadata_decoder *mdec)
{
    BT_ASSERT_DBG(mdec);
    return mdec->bo;
}

BT_HIDDEN
int ctf_metadata_decoder_get_uuid(struct ctf_metadata_decoder *mdec, bt_uuid_t uuid)
{
    int ret = 0;

    BT_ASSERT_DBG(mdec);

    if (!mdec->is_uuid_set) {
        ret = -1;
        goto end;
    }

    bt_uuid_copy(uuid, mdec->uuid);

end:
    return ret;
}

static enum ctf_metadata_decoder_status find_uuid_in_trace_decl(struct ctf_metadata_decoder *mdec,
                                                                struct ctf_node *trace_node,
                                                                bt_uuid_t uuid)
{
    enum ctf_metadata_decoder_status status = CTF_METADATA_DECODER_STATUS_OK;
    struct ctf_node *entry_node;
    struct bt_list_head *decl_list = &trace_node->u.trace.declaration_list;
    char *left = NULL;

    bt_list_for_each_entry (entry_node, decl_list, siblings) {
        if (entry_node->type == NODE_CTF_EXPRESSION) {
            int ret;

            left = ctf_ast_concatenate_unary_strings(&entry_node->u.ctf_expression.left);
            if (!left) {
                _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Cannot concatenate unary strings.");
                status = CTF_METADATA_DECODER_STATUS_ERROR;
                goto end;
            }

            if (strcmp(left, "uuid") == 0) {
                ret = ctf_ast_get_unary_uuid(&entry_node->u.ctf_expression.right, uuid,
                                             mdec->config.log_level, mdec->config.self_comp);
                if (ret) {
                    _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Invalid trace's `uuid` attribute.");
                    status = CTF_METADATA_DECODER_STATUS_ERROR;
                    goto end;
                }

                goto end;
            }

            g_free(left);
            left = NULL;
        }
    }

    status = CTF_METADATA_DECODER_STATUS_NONE;

end:
    g_free(left);
    return status;
}

BT_HIDDEN
enum ctf_metadata_decoder_status
ctf_metadata_decoder_get_trace_class_uuid(struct ctf_metadata_decoder *mdec, bt_uuid_t uuid)
{
    enum ctf_metadata_decoder_status status = CTF_METADATA_DECODER_STATUS_INCOMPLETE;
    struct ctf_node *root_node = &mdec->scanner->ast->root;
    struct ctf_node *trace_node;

    if (!root_node) {
        status = CTF_METADATA_DECODER_STATUS_INCOMPLETE;
        goto end;
    }

    trace_node = bt_list_entry(root_node->u.root.trace.next, struct ctf_node, siblings);
    if (!trace_node) {
        status = CTF_METADATA_DECODER_STATUS_INCOMPLETE;
        goto end;
    }

    status = find_uuid_in_trace_decl(mdec, trace_node, uuid);

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