plugins/ctf/fs/fs.c

   1 /*
   2  * fs.c
   3  *
   4  * Babeltrace CTF file system Reader Component
   5  *
   6  * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   7  *
   8  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
   9  *
  10  * Permission is hereby granted, free of charge, to any person obtaining a copy
  11  * of this software and associated documentation files (the "Software"), to deal
  12  * in the Software without restriction, including without limitation the rights
  13  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  14  * copies of the Software, and to permit persons to whom the Software is
  15  * furnished to do so, subject to the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be included in
  18  * all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  21  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  23  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  24  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  25  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  26  * SOFTWARE.
  27  */
  28
  29 #include <babeltrace/plugin/plugin-system.h>
  30 #include <babeltrace/plugin/notification/iterator.h>
  31 #include <glib.h>
  32 #include <assert.h>
  33 #include <unistd.h>
  34 #include "fs.h"
  35 #include "metadata.h"
  36 #include "data-stream.h"
  37
  38 static bool ctf_fs_debug;
  39
  40 static
  41 struct bt_notification *ctf_fs_iterator_get(
  42                 struct bt_notification_iterator *iterator)
  43 {
  44         return NULL;
  45 }
  46
  47 static
  48 enum bt_notification_iterator_status ctf_fs_iterator_next(
  49                 struct bt_notification_iterator *iterator)
  50 {
  51         return BT_NOTIFICATION_ITERATOR_STATUS_UNSUPPORTED;
  52 }
  53
  54 static
  55 void ctf_fs_iterator_destroy_data(struct ctf_fs_iterator *ctf_it)
  56 {
  57         g_free(ctf_it);
  58 }
  59
  60 static
  61 void ctf_fs_iterator_destroy(struct bt_notification_iterator *it)
  62 {
  63         void *data = bt_notification_iterator_get_private_data(it);
  64
  65         ctf_fs_iterator_destroy_data(data);
  66 }
  67
  68 static
  69 enum bt_component_status ctf_fs_iterator_init(struct bt_component *source,
  70                 struct bt_notification_iterator *it)
  71 {
  72         struct ctf_fs_iterator *ctf_it;
  73         enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
  74
  75         assert(source && it);
  76         ctf_it = g_new0(struct ctf_fs_iterator, 1);
  77         if (!ctf_it) {
  78                 ret = BT_COMPONENT_STATUS_NOMEM;
  79                 goto end;
  80         }
  81
  82         ret = bt_notification_iterator_set_get_cb(it, ctf_fs_iterator_get);
  83         if (ret) {
  84                 goto error;
  85         }
  86
  87         ret = bt_notification_iterator_set_next_cb(it, ctf_fs_iterator_next);
  88         if (ret) {
  89                 goto error;
  90         }
  91
  92         ret = bt_notification_iterator_set_destroy_cb(it,
  93                         ctf_fs_iterator_destroy);
  94         if (ret) {
  95                 goto error;
  96         }
  97
  98         ret = bt_notification_iterator_set_private_data(it, ctf_it);
  99         if (ret) {
 100                 goto error;
 101         }
 102 end:
 103         return ret;
 104 error:
 105         (void) bt_notification_iterator_set_private_data(it, NULL);
 106         ctf_fs_iterator_destroy_data(ctf_it);
 107         return ret;
 108 }
 109
 110 static
 111 void ctf_fs_destroy_data(struct ctf_fs_component *component)
 112 {
 113         if (component->trace_path) {
 114                 g_string_free(component->trace_path, TRUE);
 115         }
 116
 117         ctf_fs_metadata_fini(&component->metadata);
 118         ctf_fs_data_stream_fini(&component->data_stream);
 119         g_free(component);
 120 }
 121
 122 static
 123 void ctf_fs_destroy(struct bt_component *component)
 124 {
 125         void *data = bt_component_get_private_data(component);
 126
 127         ctf_fs_destroy_data(data);
 128 }
 129
 130 static
 131 struct ctf_fs_component *ctf_fs_create(struct bt_value *params)
 132 {
 133         struct ctf_fs_component *ctf_fs;
 134         struct bt_value *value;
 135         const char *path;
 136         enum bt_value_status ret;
 137
 138         ctf_fs = g_new0(struct ctf_fs_component, 1);
 139         if (!ctf_fs) {
 140                 goto end;
 141         }
 142
 143         /* FIXME: should probably look for a source URI */
 144         value = bt_value_map_get(params, "path");
 145         if (!value || bt_value_is_null(value) || !bt_value_is_string(value)) {
 146                 goto error;
 147         }
 148
 149         ret = bt_value_string_get(value, &path);
 150         if (ret != BT_VALUE_STATUS_OK) {
 151                 goto error;
 152         }
 153
 154         ctf_fs->trace_path = g_string_new(path);
 155         if (!ctf_fs->trace_path) {
 156                 goto error;
 157         }
 158
 159         ctf_fs->error_fp = stderr;
 160         ctf_fs->page_size = (size_t) getpagesize();
 161         ctf_fs_data_stream_init(ctf_fs, &ctf_fs->data_stream);
 162         ctf_fs_metadata_set_trace(ctf_fs);
 163         ctf_fs_data_stream_open_streams(ctf_fs);
 164 end:
 165         return ctf_fs;
 166 error:
 167         ctf_fs_destroy_data(ctf_fs);
 168         return ctf_fs;
 169 }
 170
 171 BT_HIDDEN
 172 enum bt_component_status ctf_fs_init(struct bt_component *source,
 173                 struct bt_value *params)
 174 {
 175         struct ctf_fs_component *ctf_fs;
 176         enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
 177
 178         assert(source);
 179         ctf_fs_debug = g_strcmp0(getenv("CTF_FS_DEBUG"), "1") == 0;
 180         ctf_fs = ctf_fs_create(params);
 181         if (!ctf_fs) {
 182                 ret = BT_COMPONENT_STATUS_NOMEM;
 183                 goto end;
 184         }
 185
 186         ret = bt_component_set_destroy_cb(source, ctf_fs_destroy);
 187         if (ret != BT_COMPONENT_STATUS_OK) {
 188                 goto error;
 189         }
 190
 191         ret = bt_component_set_private_data(source, ctf_fs);
 192         if (ret != BT_COMPONENT_STATUS_OK) {
 193                 goto error;
 194         }
 195
 196         ret = bt_component_source_set_iterator_init_cb(source,
 197                         ctf_fs_iterator_init);
 198         if (ret != BT_COMPONENT_STATUS_OK) {
 199                 goto error;
 200         }
 201
 202 end:
 203         return ret;
 204 error:
 205         (void) bt_component_set_private_data(source, NULL);
 206         ctf_fs_destroy_data(ctf_fs);
 207         return ret;
 208 }