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