`ctf` plugin: metadata: use BT_COMP_LOG*() instead of BT_LOG*()
[babeltrace.git] / src / plugins / ctf / common / metadata / decoder.c
index 5f20eae8945cb3f21608c34128ae9ab60535aed2..188faebe77932275d5058ad9a8de20b44d3f4d6a 100644 (file)
  * all copies or substantial portions of the Software.
  */
 
+#define BT_COMP_LOG_SELF_COMP (mdec->config.self_comp)
 #define BT_LOG_OUTPUT_LEVEL (mdec->config.log_level)
 #define BT_LOG_TAG "PLUGIN/CTF/META/DECODER"
-#include "logging/log.h"
+#include "plugins/comp-logging.h"
 
 #include <stdio.h>
 #include <stdbool.h>
@@ -31,6 +32,7 @@
 #include "ast.h"
 #include "decoder.h"
 #include "scanner.h"
+#include "logging.h"
 
 #define TSDL_MAGIC     0x75d11d57
 
@@ -60,7 +62,7 @@ struct packet_header {
 
 BT_HIDDEN
 bool ctf_metadata_decoder_is_packetized(FILE *fp, int *byte_order,
-               bt_logging_level log_level)
+               bt_logging_level log_level, bt_self_component *self_comp)
 {
        uint32_t magic;
        size_t len;
@@ -68,7 +70,7 @@ bool ctf_metadata_decoder_is_packetized(FILE *fp, int *byte_order,
 
        len = fread(&magic, sizeof(magic), 1, fp);
        if (len != 1) {
-               BT_LOG_WRITE_CUR_LVL(BT_LOG_INFO, log_level, BT_LOG_TAG,
+               BT_COMP_LOG_CUR_LVL(BT_LOG_INFO, log_level, self_comp,
                        "Cannot read first metadata packet header: assuming the stream is not packetized.");
                goto end;
        }
@@ -107,19 +109,19 @@ int decode_packet(struct ctf_metadata_decoder *mdec, FILE *in_fp, FILE *out_fp,
        const long offset = ftell(in_fp);
 
        if (offset < 0) {
-               BT_LOGE_ERRNO("Failed to get current metadata file position",
+               BT_COMP_LOGE_ERRNO("Failed to get current metadata file position",
                        ".");
                goto error;
        }
-       BT_LOGD("Decoding metadata packet: mdec-addr=%p, offset=%ld",
+       BT_COMP_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));
+               BT_COMP_LOGI("Reached end of file: offset=%ld", ftell(in_fp));
                goto end;
        }
        if (readlen < 1) {
-               BT_LOGE("Cannot decode metadata packet: offset=%ld", offset);
+               BT_COMP_LOGE("Cannot decode metadata packet: offset=%ld", offset);
                goto error;
        }
 
@@ -131,21 +133,21 @@ int decode_packet(struct ctf_metadata_decoder *mdec, FILE *in_fp, FILE *out_fp,
        }
 
        if (header.compression_scheme) {
-               BT_LOGE("Metadata packet compression is not supported as of this version: "
+               BT_COMP_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: "
+               BT_COMP_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: "
+               BT_COMP_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);
@@ -153,7 +155,7 @@ int decode_packet(struct ctf_metadata_decoder *mdec, FILE *in_fp, FILE *out_fp,
        }
 
        if (!is_version_valid(header.major, header.minor)) {
-               BT_LOGE("Invalid metadata packet version: "
+               BT_COMP_LOGE("Invalid metadata packet version: "
                        "version=%u.%u, offset=%ld",
                        header.major, header.minor, offset);
                goto error;
@@ -165,7 +167,7 @@ int decode_packet(struct ctf_metadata_decoder *mdec, FILE *in_fp, FILE *out_fp,
                        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: "
+                       BT_COMP_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",
@@ -207,7 +209,7 @@ int decode_packet(struct ctf_metadata_decoder *mdec, FILE *in_fp, FILE *out_fp,
        }
 
        if ((header.content_size / CHAR_BIT) < sizeof(header)) {
-               BT_LOGE("Bad metadata packet content size: content-size=%u, "
+               BT_COMP_LOGE("Bad metadata packet content size: content-size=%u, "
                        "offset=%ld", header.content_size, offset);
                goto error;
        }
@@ -220,13 +222,13 @@ int decode_packet(struct ctf_metadata_decoder *mdec, FILE *in_fp, FILE *out_fp,
                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: "
+                       BT_COMP_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: "
+                       BT_COMP_LOGE("fread returned more byte than expected: "
                                "read-size-asked=%zu, read-size-returned=%zu",
                                loop_read, readlen);
                        goto error;
@@ -234,7 +236,7 @@ int decode_packet(struct ctf_metadata_decoder *mdec, FILE *in_fp, FILE *out_fp,
 
                writelen = fwrite(buf, sizeof(uint8_t), readlen, out_fp);
                if (writelen < readlen || ferror(out_fp)) {
-                       BT_LOGE("Cannot write decoded metadata text to buffer: "
+                       BT_COMP_LOGE("Cannot write decoded metadata text to buffer: "
                                "read-offset=%ld, write-size=%zu",
                                ftell(in_fp), readlen);
                        goto error;
@@ -249,7 +251,7 @@ int decode_packet(struct ctf_metadata_decoder *mdec, FILE *in_fp, FILE *out_fp,
                                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.");
+                               BT_COMP_LOGW_STR("Missing padding at the end of the metadata stream.");
                        }
                        break;
                }
@@ -267,7 +269,8 @@ end:
 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)
+               char **buf, int byte_order, bt_logging_level log_level,
+               bt_self_component *self_comp)
 {
        FILE *out_fp;
        size_t size;
@@ -277,7 +280,7 @@ int ctf_metadata_decoder_packetized_file_stream_to_buf_with_mdec(
 
        out_fp = bt_open_memstream(buf, &size);
        if (out_fp == NULL) {
-               BT_LOG_WRITE_CUR_LVL(BT_LOG_ERROR, log_level, BT_LOG_TAG,
+               BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR, log_level, self_comp,
                        "Cannot open memory stream: %s: mdec-addr=%p",
                        strerror(errno), mdec);
                goto error;
@@ -290,7 +293,7 @@ int ctf_metadata_decoder_packetized_file_stream_to_buf_with_mdec(
 
                tret = decode_packet(mdec, fp, out_fp, byte_order);
                if (tret) {
-                       BT_LOG_WRITE_CUR_LVL(BT_LOG_ERROR, log_level, BT_LOG_TAG,
+                       BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR, log_level, self_comp,
                                "Cannot decode packet: index=%zu, mdec-addr=%p",
                                packet_index, mdec);
                        goto error;
@@ -302,7 +305,7 @@ int ctf_metadata_decoder_packetized_file_stream_to_buf_with_mdec(
        /* 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,
+               BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR, log_level, self_comp,
                        "Cannot append '\\0' to the decoded metadata buffer: "
                        "mdec-addr=%p", mdec);
                goto error;
@@ -318,7 +321,7 @@ int ctf_metadata_decoder_packetized_file_stream_to_buf_with_mdec(
         */
        out_fp = NULL;
        if (ret < 0) {
-               BT_LOG_WRITE_ERRNO_CUR_LVL(BT_LOG_ERROR, log_level, BT_LOG_TAG,
+               BT_COMP_LOG_ERRNO_CUR_LVL(BT_LOG_ERROR, log_level, self_comp,
                        "Cannot close memory stream", ": mdec-addr=%p", mdec);
                goto error;
        }
@@ -330,9 +333,9 @@ error:
 
        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);
+                       BT_COMP_LOG_ERRNO_CUR_LVL(BT_LOG_ERROR, log_level,
+                               self_comp, "Cannot close memory stream",
+                               ": mdec-addr=%p", mdec);
                }
        }
 
@@ -348,49 +351,45 @@ end:
 BT_HIDDEN
 int ctf_metadata_decoder_packetized_file_stream_to_buf(
                FILE *fp, char **buf, int byte_order,
-               bt_logging_level log_level)
+               bt_logging_level log_level,
+               bt_self_component *self_comp)
 {
        return ctf_metadata_decoder_packetized_file_stream_to_buf_with_mdec(
-               NULL, fp, buf, byte_order, log_level);
+               NULL, fp, buf, byte_order, log_level, self_comp);
 }
 
 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: "
+       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_LOGE_STR("Failed to allocate one CTF metadata decoder.");
+               BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR, config->log_level,
+                       config->self_comp,
+                       "Failed to allocate one CTF metadata decoder.");
                goto end;
        }
 
        mdec->config = *config;
-       mdec->visitor = ctf_visitor_generate_ir_create(self_comp, config);
+       mdec->visitor = ctf_visitor_generate_ir_create(config);
        if (!mdec->visitor) {
-               BT_LOGE("Failed to create a CTF IR metadata AST visitor: "
+               BT_COMP_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: "
+       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,
@@ -407,7 +406,7 @@ void ctf_metadata_decoder_destroy(struct ctf_metadata_decoder *mdec)
                return;
        }
 
-       BT_LOGD("Destroying CTF metadata decoder: addr=%p", mdec);
+       BT_COMP_LOGD("Destroying CTF metadata decoder: addr=%p", mdec);
        ctf_visitor_generate_ir_destroy(mdec->visitor);
        g_free(mdec);
 }
@@ -422,16 +421,20 @@ enum ctf_metadata_decoder_status ctf_metadata_decoder_decode(
        struct ctf_scanner *scanner = NULL;
        char *buf = NULL;
        bool close_fp = false;
+       struct meta_log_config log_cfg;
 
        BT_ASSERT(mdec);
+       log_cfg.log_level = mdec->config.log_level;
+       log_cfg.self_comp = mdec->config.self_comp;
 
        if (ctf_metadata_decoder_is_packetized(fp, &mdec->bo,
-                       BT_LOG_OUTPUT_LEVEL)) {
-               BT_LOGI("Metadata stream is packetized: mdec-addr=%p", mdec);
+                       mdec->config.log_level, mdec->config.self_comp)) {
+               BT_COMP_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);
+                       mdec, fp, &buf, mdec->bo, mdec->config.log_level,
+                       mdec->config.self_comp);
                if (ret) {
-                       BT_LOGE("Cannot decode packetized metadata packets to metadata text: "
+                       BT_COMP_LOGE("Cannot decode packetized metadata packets to metadata text: "
                                "mdec-addr=%p, ret=%d", mdec, ret);
                        status = CTF_METADATA_DECODER_STATUS_ERROR;
                        goto end;
@@ -446,7 +449,7 @@ enum ctf_metadata_decoder_status ctf_metadata_decoder_decode(
                fp = bt_fmemopen(buf, strlen(buf), "rb");
                close_fp = true;
                if (!fp) {
-                       BT_LOGE("Cannot memory-open metadata buffer: %s: "
+                       BT_COMP_LOGE("Cannot memory-open metadata buffer: %s: "
                                "mdec-addr=%p", strerror(errno), mdec);
                        status = CTF_METADATA_DECODER_STATUS_ERROR;
                        goto end;
@@ -456,10 +459,10 @@ enum ctf_metadata_decoder_status ctf_metadata_decoder_decode(
                ssize_t nr_items;
                const long init_pos = ftell(fp);
 
-               BT_LOGI("Metadata stream is plain text: mdec-addr=%p", mdec);
+               BT_COMP_LOGI("Metadata stream is plain text: mdec-addr=%p", mdec);
 
                if (init_pos < 0) {
-                       BT_LOGE_ERRNO("Failed to get current file position", ".");
+                       BT_COMP_LOGE_ERRNO("Failed to get current file position", ".");
                        status = CTF_METADATA_DECODER_STATUS_ERROR;
                        goto end;
                }
@@ -467,14 +470,14 @@ enum ctf_metadata_decoder_status ctf_metadata_decoder_decode(
                /* 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: "
+                       BT_COMP_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);
+               BT_COMP_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: "
+                       BT_COMP_LOGE("Invalid metadata version found in plain text signature: "
                                "version=%u.%u, mdec-addr=%p", major, minor,
                                mdec);
                        status = CTF_METADATA_DECODER_STATUS_INVAL_VERSION;
@@ -482,7 +485,7 @@ enum ctf_metadata_decoder_status ctf_metadata_decoder_decode(
                }
 
                if (fseek(fp, init_pos, SEEK_SET)) {
-                       BT_LOGE("Cannot seek metadata file stream to initial position: %s: "
+                       BT_COMP_LOGE("Cannot seek metadata file stream to initial position: %s: "
                                "mdec-addr=%p", strerror(errno), mdec);
                        status = CTF_METADATA_DECODER_STATUS_ERROR;
                        goto end;
@@ -496,7 +499,7 @@ enum ctf_metadata_decoder_status ctf_metadata_decoder_decode(
        /* Allocate a scanner and append the metadata text content */
        scanner = ctf_scanner_alloc();
        if (!scanner) {
-               BT_LOGE("Cannot allocate a metadata lexical scanner: "
+               BT_COMP_LOGE("Cannot allocate a metadata lexical scanner: "
                        "mdec-addr=%p", mdec);
                status = CTF_METADATA_DECODER_STATUS_ERROR;
                goto end;
@@ -505,16 +508,15 @@ enum ctf_metadata_decoder_status ctf_metadata_decoder_decode(
        BT_ASSERT(fp);
        ret = ctf_scanner_append_ast(scanner, fp);
        if (ret) {
-               BT_LOGE("Cannot create the metadata AST out of the metadata text: "
+               BT_COMP_LOGE("Cannot create the metadata AST out of the metadata text: "
                        "mdec-addr=%p", mdec);
                status = CTF_METADATA_DECODER_STATUS_INCOMPLETE;
                goto end;
        }
 
-       ret = ctf_visitor_semantic_check(0, &scanner->ast->root,
-               mdec->config.log_level);
+       ret = ctf_visitor_semantic_check(0, &scanner->ast->root, &log_cfg);
        if (ret) {
-               BT_LOGE("Validation of the metadata semantics failed: "
+               BT_COMP_LOGE("Validation of the metadata semantics failed: "
                        "mdec-addr=%p", mdec);
                status = CTF_METADATA_DECODER_STATUS_ERROR;
                goto end;
@@ -527,12 +529,12 @@ enum ctf_metadata_decoder_status ctf_metadata_decoder_decode(
                /* Success */
                break;
        case -EINCOMPLETE:
-               BT_LOGD("While visiting metadata AST: incomplete data: "
+               BT_COMP_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: "
+               BT_COMP_LOGE("Failed to visit AST node to create CTF IR objects: "
                        "mdec-addr=%p, ret=%d", mdec, ret);
                status = CTF_METADATA_DECODER_STATUS_IR_VISITOR_ERROR;
                goto end;
@@ -547,7 +549,7 @@ end:
 
        if (fp && close_fp) {
                if (fclose(fp)) {
-                       BT_LOGE("Cannot close metadata file stream: "
+                       BT_COMP_LOGE("Cannot close metadata file stream: "
                                "mdec-addr=%p", mdec);
                }
        }
This page took 0.030993 seconds and 4 git commands to generate.