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         struct bt_notification *notification = NULL;
  45         struct ctf_fs_component *ctf_fs;
  46         struct bt_component *component = bt_notification_iterator_get_component(
  47                         iterator);
  48
  49         if (!component) {
  50                 goto end;
  51         }
  52
  53         ctf_fs = bt_component_get_private_data(component);
  54         if (!ctf_fs) {
  55                 goto end;
  56         }
  57
  58         notification = bt_get(ctf_fs->current_notification);
  59 end:
  60         BT_PUT(component);
  61         return notification;
  62 }
  63
  64 static
  65 enum bt_notification_iterator_status ctf_fs_iterator_next(
  66                 struct bt_notification_iterator *iterator)
  67 {
  68         enum bt_notification_iterator_status ret;
  69         struct bt_notification *notification = NULL;
  70         struct ctf_fs_component *ctf_fs;
  71         struct bt_component *component = bt_notification_iterator_get_component(
  72                         iterator);
  73
  74         if (!component) {
  75                 ret = BT_NOTIFICATION_ITERATOR_STATUS_ERROR;
  76                 goto end;
  77         }
  78
  79         ctf_fs = bt_component_get_private_data(component);
  80         assert(ctf_fs);
  81
  82         ret = ctf_fs_data_stream_get_next_notification(ctf_fs, &notification);
  83         if (ret || !notification) {
  84                 goto end;
  85         }
  86
  87         bt_put(ctf_fs->current_notification);
  88         ctf_fs->current_notification = notification;
  89 end:
  90         BT_PUT(component);
  91         return ret;
  92 }
  93
  94 static
  95 void ctf_fs_iterator_destroy_data(struct ctf_fs_iterator *ctf_it)
  96 {
  97         g_free(ctf_it);
  98 }
  99
 100 static
 101 void ctf_fs_iterator_destroy(struct bt_notification_iterator *it)
 102 {
 103         void *data = bt_notification_iterator_get_private_data(it);
 104
 105         ctf_fs_iterator_destroy_data(data);
 106 }
 107
 108 static
 109 enum bt_component_status ctf_fs_iterator_init(struct bt_component *source,
 110                 struct bt_notification_iterator *it)
 111 {
 112         struct ctf_fs_iterator *ctf_it;
 113         enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
 114
 115         assert(source && it);
 116         ctf_it = g_new0(struct ctf_fs_iterator, 1);
 117         if (!ctf_it) {
 118                 ret = BT_COMPONENT_STATUS_NOMEM;
 119                 goto end;
 120         }
 121
 122         ret = bt_notification_iterator_set_get_cb(it, ctf_fs_iterator_get);
 123         if (ret) {
 124                 goto error;
 125         }
 126
 127         ret = bt_notification_iterator_set_next_cb(it, ctf_fs_iterator_next);
 128         if (ret) {
 129                 goto error;
 130         }
 131
 132         ret = bt_notification_iterator_set_destroy_cb(it,
 133                         ctf_fs_iterator_destroy);
 134         if (ret) {
 135                 goto error;
 136         }
 137
 138         ret = bt_notification_iterator_set_private_data(it, ctf_it);
 139         if (ret) {
 140                 goto error;
 141         }
 142 end:
 143         return ret;
 144 error:
 145         (void) bt_notification_iterator_set_private_data(it, NULL);
 146         ctf_fs_iterator_destroy_data(ctf_it);
 147         return ret;
 148 }
 149
 150 static
 151 void ctf_fs_destroy_data(struct ctf_fs_component *component)
 152 {
 153         if (component->trace_path) {
 154                 g_string_free(component->trace_path, TRUE);
 155         }
 156
 157         ctf_fs_metadata_fini(&component->metadata);
 158         ctf_fs_data_stream_fini(&component->data_stream);
 159         BT_PUT(component->current_notification);
 160         g_free(component);
 161 }
 162
 163 static
 164 void ctf_fs_destroy(struct bt_component *component)
 165 {
 166         void *data = bt_component_get_private_data(component);
 167
 168         ctf_fs_destroy_data(data);
 169 }
 170
 171 static
 172 struct ctf_fs_component *ctf_fs_create(struct bt_value *params)
 173 {
 174         struct ctf_fs_component *ctf_fs;
 175         struct bt_value *value = NULL;
 176         const char *path;
 177         enum bt_value_status ret;
 178
 179         ctf_fs = g_new0(struct ctf_fs_component, 1);
 180         if (!ctf_fs) {
 181                 goto end;
 182         }
 183
 184         /* FIXME: should probably look for a source URI */
 185         value = bt_value_map_get(params, "path");
 186         if (!value || bt_value_is_null(value) || !bt_value_is_string(value)) {
 187                 goto error;
 188         }
 189
 190         ret = bt_value_string_get(value, &path);
 191         if (ret != BT_VALUE_STATUS_OK) {
 192                 goto error;
 193         }
 194
 195         ctf_fs->trace_path = g_string_new(path);
 196         if (!ctf_fs->trace_path) {
 197                 goto error;
 198         }
 199
 200         ctf_fs->error_fp = stderr;
 201         ctf_fs->page_size = (size_t) getpagesize();
 202         ctf_fs_data_stream_init(ctf_fs, &ctf_fs->data_stream);
 203         ctf_fs_metadata_set_trace(ctf_fs);
 204         ctf_fs_data_stream_open_streams(ctf_fs);
 205         goto end;
 206
 207 error:
 208         ctf_fs_destroy_data(ctf_fs);
 209 end:
 210         BT_PUT(value);
 211         return ctf_fs;
 212 }
 213
 214 BT_HIDDEN
 215 enum bt_component_status ctf_fs_init(struct bt_component *source,
 216                 struct bt_value *params)
 217 {
 218         struct ctf_fs_component *ctf_fs;
 219         enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
 220
 221         assert(source);
 222         ctf_fs_debug = g_strcmp0(getenv("CTF_FS_DEBUG"), "1") == 0;
 223         ctf_fs = ctf_fs_create(params);
 224         if (!ctf_fs) {
 225                 ret = BT_COMPONENT_STATUS_NOMEM;
 226                 goto end;
 227         }
 228
 229         ret = bt_component_set_destroy_cb(source, ctf_fs_destroy);
 230         if (ret != BT_COMPONENT_STATUS_OK) {
 231                 goto error;
 232         }
 233
 234         ret = bt_component_set_private_data(source, ctf_fs);
 235         if (ret != BT_COMPONENT_STATUS_OK) {
 236                 goto error;
 237         }
 238
 239         ret = bt_component_source_set_iterator_init_cb(source,
 240                         ctf_fs_iterator_init);
 241         if (ret != BT_COMPONENT_STATUS_OK) {
 242                 goto error;
 243         }
 244 end:
 245         return ret;
 246 error:
 247         (void) bt_component_set_private_data(source, NULL);
 248         ctf_fs_destroy_data(ctf_fs);
 249         return ret;
 250 }