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