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 "common/assert.h"
   9
  10 #include "../common/src/metadata/tsdl/decoder.hpp"
  11 #include "file.hpp"
  12 #include "fs.hpp"
  13 #include "metadata.hpp"
  14
  15 FILE *ctf_fs_metadata_open_file(const char *trace_path, const bt2c::Logger& logger)
  16 {
  17     GString *metadata_path;
  18     FILE *fp = NULL;
  19
  20     metadata_path = g_string_new(trace_path);
  21     if (!metadata_path) {
  22         goto end;
  23     }
  24
  25     g_string_append(metadata_path, G_DIR_SEPARATOR_S CTF_FS_METADATA_FILENAME);
  26     fp = fopen(metadata_path->str, "rb");
  27     if (!fp) {
  28         BT_CPPLOGE_ERRNO_APPEND_CAUSE_SPEC(logger, "Failed to open metadata file", ": path=\"{}\"",
  29                                            metadata_path->str);
  30     }
  31
  32     g_string_free(metadata_path, TRUE);
  33
  34 end:
  35     return fp;
  36 }
  37
  38 static ctf_fs_file::UP get_file(const char *trace_path, const bt2c::Logger& logger)
  39 {
  40     auto file = ctf_fs_file_create(logger);
  41
  42     if (!file) {
  43         goto error;
  44     }
  45
  46     g_string_append(file->path, trace_path);
  47     g_string_append(file->path, G_DIR_SEPARATOR_S CTF_FS_METADATA_FILENAME);
  48
  49     if (ctf_fs_file_open(file.get(), "rb")) {
  50         goto error;
  51     }
  52
  53     goto end;
  54
  55 error:
  56     file.reset();
  57
  58 end:
  59     return file;
  60 }
  61
  62 int ctf_fs_metadata_set_trace_class(bt_self_component *self_comp, struct ctf_fs_trace *ctf_fs_trace,
  63                                     const ctf::src::ClkClsCfg& clkClsCfg)
  64 {
  65     int ret = 0;
  66     ctf_metadata_decoder_config decoder_config {ctf_fs_trace->logger};
  67
  68     decoder_config.self_comp = self_comp;
  69     decoder_config.clkClsCfg = clkClsCfg;
  70     decoder_config.create_trace_class = true;
  71
  72     const auto file = get_file(ctf_fs_trace->path->str, ctf_fs_trace->logger);
  73     if (!file) {
  74         BT_CPPLOGE_SPEC(ctf_fs_trace->logger, "Cannot create metadata file object.");
  75         ret = -1;
  76         goto end;
  77     }
  78
  79     ctf_fs_trace->metadata->decoder = ctf_metadata_decoder_create(&decoder_config);
  80     if (!ctf_fs_trace->metadata->decoder) {
  81         BT_CPPLOGE_SPEC(ctf_fs_trace->logger, "Cannot create metadata decoder object.");
  82         ret = -1;
  83         goto end;
  84     }
  85
  86     ret =
  87         ctf_metadata_decoder_append_content(ctf_fs_trace->metadata->decoder.get(), file->fp.get());
  88     if (ret) {
  89         BT_CPPLOGE_SPEC(ctf_fs_trace->logger, "Cannot update metadata decoder's content.");
  90         goto end;
  91     }
  92
  93     ctf_fs_trace->metadata->trace_class =
  94         ctf_metadata_decoder_get_ir_trace_class(ctf_fs_trace->metadata->decoder.get());
  95     BT_ASSERT(!self_comp || ctf_fs_trace->metadata->trace_class);
  96     ctf_fs_trace->metadata->tc =
  97         ctf_metadata_decoder_borrow_ctf_trace_class(ctf_fs_trace->metadata->decoder.get());
  98     BT_ASSERT(ctf_fs_trace->metadata->tc);
  99
 100 end:
 101     return ret;
 102 }
 103
 104 int ctf_fs_metadata_init(struct ctf_fs_metadata *)
 105 {
 106     /* Nothing to initialize for the moment. */
 107     return 0;
 108 }
 109
 110 void ctf_fs_metadata_fini(struct ctf_fs_metadata *metadata)
 111 {
 112     free(metadata->text);
 113
 114     if (metadata->trace_class) {
 115         BT_TRACE_CLASS_PUT_REF_AND_RESET(metadata->trace_class);
 116     }
 117
 118     metadata->decoder.reset();
 119 }