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_LOG_OUTPUT_LEVEL log_level
  27 #define BT_LOG_TAG "PLUGIN/SRC.CTF.FS/META"
  28 #include "logging/log.h"
  29
  30 #include <stdio.h>
  31 #include <stdint.h>
  32 #include <stdlib.h>
  33 #include <stdbool.h>
  34 #include "common/assert.h"
  35 #include <glib.h>
  36 #include "compat/uuid.h"
  37 #include "compat/memstream.h"
  38 #include <babeltrace2/babeltrace.h>
  39
  40 #include "fs.h"
  41 #include "file.h"
  42 #include "metadata.h"
  43 #include "../common/metadata/decoder.h"
  44
  45 BT_HIDDEN
  46 FILE *ctf_fs_metadata_open_file(const char *trace_path)
  47 {
  48         GString *metadata_path;
  49         FILE *fp = NULL;
  50
  51         metadata_path = g_string_new(trace_path);
  52         if (!metadata_path) {
  53                 goto end;
  54         }
  55
  56         g_string_append(metadata_path, G_DIR_SEPARATOR_S CTF_FS_METADATA_FILENAME);
  57         fp = fopen(metadata_path->str, "rb");
  58         g_string_free(metadata_path, TRUE);
  59 end:
  60         return fp;
  61 }
  62
  63 static struct ctf_fs_file *get_file(const char *trace_path,
  64                 bt_logging_level log_level)
  65 {
  66         struct ctf_fs_file *file = ctf_fs_file_create(log_level);
  67
  68         if (!file) {
  69                 goto error;
  70         }
  71
  72         g_string_append(file->path, trace_path);
  73         g_string_append(file->path, G_DIR_SEPARATOR_S CTF_FS_METADATA_FILENAME);
  74
  75         if (ctf_fs_file_open(file, "rb")) {
  76                 goto error;
  77         }
  78
  79         goto end;
  80
  81 error:
  82         if (file) {
  83                 ctf_fs_file_destroy(file);
  84                 file = NULL;
  85         }
  86
  87 end:
  88         return file;
  89 }
  90
  91 BT_HIDDEN
  92 int ctf_fs_metadata_set_trace_class(
  93                 bt_self_component_source *self_comp,
  94                 struct ctf_fs_trace *ctf_fs_trace,
  95                 struct ctf_fs_metadata_config *config)
  96 {
  97         int ret = 0;
  98         struct ctf_fs_file *file = NULL;
  99         struct ctf_metadata_decoder_config decoder_config = {
 100                 .log_level = ctf_fs_trace->log_level,
 101                 .self_comp = bt_self_component_source_as_self_component(self_comp),
 102                 .clock_class_offset_s = config ? config->clock_class_offset_s : 0,
 103                 .clock_class_offset_ns = config ? config->clock_class_offset_ns : 0,
 104         };
 105         bt_logging_level log_level = ctf_fs_trace->log_level;
 106
 107         file = get_file(ctf_fs_trace->path->str, log_level);
 108         if (!file) {
 109                 BT_LOGE("Cannot create metadata file object");
 110                 ret = -1;
 111                 goto end;
 112         }
 113
 114         ctf_fs_trace->metadata->decoder = ctf_metadata_decoder_create(
 115                 &decoder_config);
 116         if (!ctf_fs_trace->metadata->decoder) {
 117                 BT_LOGE("Cannot create metadata decoder object");
 118                 ret = -1;
 119                 goto end;
 120         }
 121
 122         ret = ctf_metadata_decoder_decode(ctf_fs_trace->metadata->decoder,
 123                 file->fp);
 124         if (ret) {
 125                 BT_LOGE("Cannot decode metadata file");
 126                 goto end;
 127         }
 128
 129         ctf_fs_trace->metadata->trace_class =
 130                 ctf_metadata_decoder_get_ir_trace_class(
 131                         ctf_fs_trace->metadata->decoder);
 132         BT_ASSERT(!self_comp || ctf_fs_trace->metadata->trace_class);
 133         ctf_fs_trace->metadata->tc =
 134                 ctf_metadata_decoder_borrow_ctf_trace_class(
 135                         ctf_fs_trace->metadata->decoder);
 136         BT_ASSERT(ctf_fs_trace->metadata->tc);
 137
 138 end:
 139         ctf_fs_file_destroy(file);
 140         return ret;
 141 }
 142
 143 BT_HIDDEN
 144 int ctf_fs_metadata_init(struct ctf_fs_metadata *metadata)
 145 {
 146         /* Nothing to initialize for the moment. */
 147         return 0;
 148 }
 149
 150 BT_HIDDEN
 151 void ctf_fs_metadata_fini(struct ctf_fs_metadata *metadata)
 152 {
 153         if (metadata->text) {
 154                 free(metadata->text);
 155         }
 156
 157         if (metadata->trace_class) {
 158                 BT_TRACE_CLASS_PUT_REF_AND_RESET(metadata->trace_class);
 159         }
 160
 161         if (metadata->decoder) {
 162                 ctf_metadata_decoder_destroy(metadata->decoder);
 163         }
 164 }