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