src/plugins/ctf/fs-src/metadata.cpp

   1 /*
   2  * SPDX-License-Identifier: MIT
   3  *
   4  * Copyright 2016 Philippe Proulx <pproulx@efficios.com>
   5  * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
   6  */
   7
   8 #include <glib.h>
   9 #include <stdint.h>
  10 #include <stdio.h>
  11 #include <stdlib.h>
  12
  13 #include <babeltrace2/babeltrace.h>
  14
  15 #define BT_COMP_LOG_SELF_COMP self_comp
  16 #define BT_LOG_OUTPUT_LEVEL   log_level
  17 #define BT_LOG_TAG            "PLUGIN/SRC.CTF.FS/META"
  18 #include "logging/comp-logging.h"
  19
  20 #include "common/assert.h"
  21 #include "common/uuid.h"
  22 #include "compat/memstream.h"
  23
  24 #include "../common/metadata/decoder.hpp"
  25 #include "file.hpp"
  26 #include "fs.hpp"
  27 #include "metadata.hpp"
  28
  29 FILE *ctf_fs_metadata_open_file(const char *trace_path, bt_logging_level log_level,
  30                                 bt_self_component_class *comp_class)
  31 {
  32     GString *metadata_path;
  33     FILE *fp = NULL;
  34
  35     metadata_path = g_string_new(trace_path);
  36     if (!metadata_path) {
  37         goto end;
  38     }
  39
  40     g_string_append(metadata_path, G_DIR_SEPARATOR_S CTF_FS_METADATA_FILENAME);
  41     fp = fopen(metadata_path->str, "rb");
  42     if (!fp) {
  43         BT_COMP_CLASS_LOGE_APPEND_CAUSE_ERRNO(comp_class, "Failed to open metadata file",
  44                                               ": path=\"%s\"", metadata_path->str);
  45     }
  46
  47     g_string_free(metadata_path, TRUE);
  48
  49 end:
  50     return fp;
  51 }
  52
  53 static struct ctf_fs_file *get_file(const char *trace_path, bt_logging_level log_level,
  54                                     bt_self_component *self_comp)
  55 {
  56     struct ctf_fs_file *file = ctf_fs_file_create(log_level, self_comp);
  57
  58     if (!file) {
  59         goto error;
  60     }
  61
  62     g_string_append(file->path, trace_path);
  63     g_string_append(file->path, G_DIR_SEPARATOR_S CTF_FS_METADATA_FILENAME);
  64
  65     if (ctf_fs_file_open(file, "rb")) {
  66         goto error;
  67     }
  68
  69     goto end;
  70
  71 error:
  72     if (file) {
  73         ctf_fs_file_destroy(file);
  74         file = NULL;
  75     }
  76
  77 end:
  78     return file;
  79 }
  80
  81 int ctf_fs_metadata_set_trace_class(bt_self_component *self_comp, struct ctf_fs_trace *ctf_fs_trace,
  82                                     struct ctf_fs_metadata_config *config)
  83 {
  84     int ret = 0;
  85     struct ctf_fs_file *file = NULL;
  86     bt_logging_level log_level = ctf_fs_trace->log_level;
  87
  88     ctf_metadata_decoder_config decoder_config {};
  89     decoder_config.log_level = ctf_fs_trace->log_level, decoder_config.self_comp = self_comp,
  90     decoder_config.clock_class_offset_s = config ? config->clock_class_offset_s : 0,
  91     decoder_config.clock_class_offset_ns = config ? config->clock_class_offset_ns : 0,
  92     decoder_config.force_clock_class_origin_unix_epoch =
  93         config ? config->force_clock_class_origin_unix_epoch : false,
  94     decoder_config.create_trace_class = true,
  95
  96     file = get_file(ctf_fs_trace->path->str, log_level, self_comp);
  97     if (!file) {
  98         BT_COMP_LOGE("Cannot create metadata file object.");
  99         ret = -1;
 100         goto end;
 101     }
 102
 103     ctf_fs_trace->metadata->decoder = ctf_metadata_decoder_create(&decoder_config);
 104     if (!ctf_fs_trace->metadata->decoder) {
 105         BT_COMP_LOGE("Cannot create metadata decoder object.");
 106         ret = -1;
 107         goto end;
 108     }
 109
 110     ret = ctf_metadata_decoder_append_content(ctf_fs_trace->metadata->decoder, file->fp);
 111     if (ret) {
 112         BT_COMP_LOGE("Cannot update metadata decoder's content.");
 113         goto end;
 114     }
 115
 116     ctf_fs_trace->metadata->trace_class =
 117         ctf_metadata_decoder_get_ir_trace_class(ctf_fs_trace->metadata->decoder);
 118     BT_ASSERT(!self_comp || ctf_fs_trace->metadata->trace_class);
 119     ctf_fs_trace->metadata->tc =
 120         ctf_metadata_decoder_borrow_ctf_trace_class(ctf_fs_trace->metadata->decoder);
 121     BT_ASSERT(ctf_fs_trace->metadata->tc);
 122
 123 end:
 124     ctf_fs_file_destroy(file);
 125     return ret;
 126 }
 127
 128 int ctf_fs_metadata_init(struct ctf_fs_metadata *)
 129 {
 130     /* Nothing to initialize for the moment. */
 131     return 0;
 132 }
 133
 134 void ctf_fs_metadata_fini(struct ctf_fs_metadata *metadata)
 135 {
 136     free(metadata->text);
 137
 138     if (metadata->trace_class) {
 139         BT_TRACE_CLASS_PUT_REF_AND_RESET(metadata->trace_class);
 140     }
 141
 142     if (metadata->decoder) {
 143         ctf_metadata_decoder_destroy(metadata->decoder);
 144     }
 145 }