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

   1 /*
   2  * Copyright 2016 - Philippe Proulx <pproulx@efficios.com>
   3  * Copyright 2010-2011 - EfficiOS Inc. and Linux Foundation
   4  *
   5  * Some functions are based on older functions written by Mathieu Desnoyers.
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a copy
   8  * of this software and associated documentation files (the "Software"), to deal
   9  * in the Software without restriction, including without limitation the rights
  10  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11  * copies of the Software, and to permit persons to whom the Software is
  12  * furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included in
  15  * all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  20  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  23  * SOFTWARE.
  24  */
  25
  26 #define BT_COMP_LOG_SELF_COMP self_comp
  27 #define BT_LOG_OUTPUT_LEVEL log_level
  28 #define BT_LOG_TAG "PLUGIN/SRC.CTF.FS/META"
  29 #include "logging/comp-logging.h"
  30
  31 #include <stdio.h>
  32 #include <stdint.h>
  33 #include <stdlib.h>
  34 #include <stdbool.h>
  35 #include "common/assert.h"
  36 #include <glib.h>
  37 #include "common/uuid.h"
  38 #include "compat/memstream.h"
  39 #include <babeltrace2/babeltrace.h>
  40
  41 #include "fs.h"
  42 #include "file.h"
  43 #include "metadata.h"
  44 #include "../common/metadata/decoder.h"
  45
  46 BT_HIDDEN
  47 FILE *ctf_fs_metadata_open_file(const char *trace_path)
  48 {
  49         GString *metadata_path;
  50         FILE *fp = NULL;
  51
  52         metadata_path = g_string_new(trace_path);
  53         if (!metadata_path) {
  54                 goto end;
  55         }
  56
  57         g_string_append(metadata_path, G_DIR_SEPARATOR_S CTF_FS_METADATA_FILENAME);
  58         fp = fopen(metadata_path->str, "rb");
  59         g_string_free(metadata_path, TRUE);
  60 end:
  61         return fp;
  62 }
  63
  64 static struct ctf_fs_file *get_file(const char *trace_path,
  65                 bt_logging_level log_level, bt_self_component *self_comp)
  66 {
  67         struct ctf_fs_file *file = ctf_fs_file_create(log_level, self_comp);
  68
  69         if (!file) {
  70                 goto error;
  71         }
  72
  73         g_string_append(file->path, trace_path);
  74         g_string_append(file->path, G_DIR_SEPARATOR_S CTF_FS_METADATA_FILENAME);
  75
  76         if (ctf_fs_file_open(file, "rb")) {
  77                 goto error;
  78         }
  79
  80         goto end;
  81
  82 error:
  83         if (file) {
  84                 ctf_fs_file_destroy(file);
  85                 file = NULL;
  86         }
  87
  88 end:
  89         return file;
  90 }
  91
  92 BT_HIDDEN
  93 int ctf_fs_metadata_set_trace_class(
  94                 bt_self_component *self_comp,
  95                 struct ctf_fs_trace *ctf_fs_trace,
  96                 struct ctf_fs_metadata_config *config)
  97 {
  98         int ret = 0;
  99         struct ctf_fs_file *file = NULL;
 100         struct ctf_metadata_decoder_config decoder_config = {
 101                 .log_level = ctf_fs_trace->log_level,
 102                 .self_comp = self_comp,
 103                 .clock_class_offset_s = config ? config->clock_class_offset_s : 0,
 104                 .clock_class_offset_ns = config ? config->clock_class_offset_ns : 0,
 105                 .force_clock_class_origin_unix_epoch =
 106                         config ? config->force_clock_class_origin_unix_epoch : false,
 107                 .create_trace_class = true,
 108         };
 109         bt_logging_level log_level = ctf_fs_trace->log_level;
 110
 111         file = get_file(ctf_fs_trace->path->str, log_level, self_comp);
 112         if (!file) {
 113                 BT_COMP_LOGE("Cannot create metadata file object.");
 114                 ret = -1;
 115                 goto end;
 116         }
 117
 118         ctf_fs_trace->metadata->decoder = ctf_metadata_decoder_create(
 119                 &decoder_config);
 120         if (!ctf_fs_trace->metadata->decoder) {
 121                 BT_COMP_LOGE("Cannot create metadata decoder object.");
 122                 ret = -1;
 123                 goto end;
 124         }
 125
 126         ret = ctf_metadata_decoder_append_content(
 127                 ctf_fs_trace->metadata->decoder, file->fp);
 128         if (ret) {
 129                 BT_COMP_LOGE("Cannot update metadata decoder's content.");
 130                 goto end;
 131         }
 132
 133         ctf_fs_trace->metadata->trace_class =
 134                 ctf_metadata_decoder_get_ir_trace_class(
 135                         ctf_fs_trace->metadata->decoder);
 136         BT_ASSERT(!self_comp || ctf_fs_trace->metadata->trace_class);
 137         ctf_fs_trace->metadata->tc =
 138                 ctf_metadata_decoder_borrow_ctf_trace_class(
 139                         ctf_fs_trace->metadata->decoder);
 140         BT_ASSERT(ctf_fs_trace->metadata->tc);
 141
 142 end:
 143         ctf_fs_file_destroy(file);
 144         return ret;
 145 }
 146
 147 BT_HIDDEN
 148 int ctf_fs_metadata_init(struct ctf_fs_metadata *metadata)
 149 {
 150         /* Nothing to initialize for the moment. */
 151         return 0;
 152 }
 153
 154 BT_HIDDEN
 155 void ctf_fs_metadata_fini(struct ctf_fs_metadata *metadata)
 156 {
 157         free(metadata->text);
 158
 159         if (metadata->trace_class) {
 160                 BT_TRACE_CLASS_PUT_REF_AND_RESET(metadata->trace_class);
 161         }
 162
 163         if (metadata->decoder) {
 164                 ctf_metadata_decoder_destroy(metadata->decoder);
 165         }
 166 }