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_ctf_notif_iter_notif *notification;
  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         switch (notification->type) {
  88         case BT_CTF_NOTIF_ITER_NOTIF_NEW_PACKET:
  89         {
  90                 struct bt_ctf_notif_iter_notif_new_packet *notif =
  91                         (struct bt_ctf_notif_iter_notif_new_packet *) notification;
  92                 puts("<packet>");
  93                 break;
  94         }
  95         case BT_CTF_NOTIF_ITER_NOTIF_EVENT:
  96         {
  97                 struct bt_ctf_notif_iter_notif_event *notif =
  98                         (struct bt_ctf_notif_iter_notif_event *) notification;
  99                 puts("\tevent");
 100                 break;
 101         }
 102         case BT_CTF_NOTIF_ITER_NOTIF_END_OF_PACKET:
 103         {
 104                 struct bt_ctf_notif_iter_notif_end_of_packet *notif =
 105                         (struct bt_ctf_notif_iter_notif_end_of_packet *) notification;
 106                 puts("</packet>");
 107                 break;
 108         }
 109         default:
 110                 break;
 111         }
 112
 113         bt_ctf_notif_iter_notif_destroy(notification);
 114 end:
 115         return BT_NOTIFICATION_ITERATOR_STATUS_OK;
 116 }
 117
 118 static
 119 void ctf_fs_iterator_destroy_data(struct ctf_fs_iterator *ctf_it)
 120 {
 121         g_free(ctf_it);
 122 }
 123
 124 static
 125 void ctf_fs_iterator_destroy(struct bt_notification_iterator *it)
 126 {
 127         void *data = bt_notification_iterator_get_private_data(it);
 128
 129         ctf_fs_iterator_destroy_data(data);
 130 }
 131
 132 static
 133 enum bt_component_status ctf_fs_iterator_init(struct bt_component *source,
 134                 struct bt_notification_iterator *it)
 135 {
 136         struct ctf_fs_iterator *ctf_it;
 137         enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
 138
 139         assert(source && it);
 140         ctf_it = g_new0(struct ctf_fs_iterator, 1);
 141         if (!ctf_it) {
 142                 ret = BT_COMPONENT_STATUS_NOMEM;
 143                 goto end;
 144         }
 145
 146         ret = bt_notification_iterator_set_get_cb(it, ctf_fs_iterator_get);
 147         if (ret) {
 148                 goto error;
 149         }
 150
 151         ret = bt_notification_iterator_set_next_cb(it, ctf_fs_iterator_next);
 152         if (ret) {
 153                 goto error;
 154         }
 155
 156         ret = bt_notification_iterator_set_destroy_cb(it,
 157                         ctf_fs_iterator_destroy);
 158         if (ret) {
 159                 goto error;
 160         }
 161
 162         ret = bt_notification_iterator_set_private_data(it, ctf_it);
 163         if (ret) {
 164                 goto error;
 165         }
 166 end:
 167         return ret;
 168 error:
 169         (void) bt_notification_iterator_set_private_data(it, NULL);
 170         ctf_fs_iterator_destroy_data(ctf_it);
 171         return ret;
 172 }
 173
 174 static
 175 void ctf_fs_destroy_data(struct ctf_fs_component *component)
 176 {
 177         if (component->trace_path) {
 178                 g_string_free(component->trace_path, TRUE);
 179         }
 180
 181         ctf_fs_metadata_fini(&component->metadata);
 182         ctf_fs_data_stream_fini(&component->data_stream);
 183         BT_PUT(component->current_notification);
 184         g_free(component);
 185 }
 186
 187 static
 188 void ctf_fs_destroy(struct bt_component *component)
 189 {
 190         void *data = bt_component_get_private_data(component);
 191
 192         ctf_fs_destroy_data(data);
 193 }
 194
 195 static
 196 struct ctf_fs_component *ctf_fs_create(struct bt_value *params)
 197 {
 198         struct ctf_fs_component *ctf_fs;
 199         struct bt_value *value = NULL;
 200         const char *path;
 201         enum bt_value_status ret;
 202
 203         ctf_fs = g_new0(struct ctf_fs_component, 1);
 204         if (!ctf_fs) {
 205                 goto end;
 206         }
 207
 208         /* FIXME: should probably look for a source URI */
 209         value = bt_value_map_get(params, "path");
 210         if (!value || bt_value_is_null(value) || !bt_value_is_string(value)) {
 211                 goto error;
 212         }
 213
 214         ret = bt_value_string_get(value, &path);
 215         if (ret != BT_VALUE_STATUS_OK) {
 216                 goto error;
 217         }
 218
 219         ctf_fs->trace_path = g_string_new(path);
 220         if (!ctf_fs->trace_path) {
 221                 goto error;
 222         }
 223
 224         ctf_fs->error_fp = stderr;
 225         ctf_fs->page_size = (size_t) getpagesize();
 226         ctf_fs_data_stream_init(ctf_fs, &ctf_fs->data_stream);
 227         ctf_fs_metadata_set_trace(ctf_fs);
 228         ctf_fs_data_stream_open_streams(ctf_fs);
 229         goto end;
 230
 231 error:
 232         ctf_fs_destroy_data(ctf_fs);
 233 end:
 234         BT_PUT(value);
 235         return ctf_fs;
 236 }
 237
 238 BT_HIDDEN
 239 enum bt_component_status ctf_fs_init(struct bt_component *source,
 240                 struct bt_value *params)
 241 {
 242         struct ctf_fs_component *ctf_fs;
 243         enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
 244
 245         assert(source);
 246         ctf_fs_debug = g_strcmp0(getenv("CTF_FS_DEBUG"), "1") == 0;
 247         ctf_fs = ctf_fs_create(params);
 248         if (!ctf_fs) {
 249                 ret = BT_COMPONENT_STATUS_NOMEM;
 250                 goto end;
 251         }
 252
 253         ret = bt_component_set_destroy_cb(source, ctf_fs_destroy);
 254         if (ret != BT_COMPONENT_STATUS_OK) {
 255                 goto error;
 256         }
 257
 258         ret = bt_component_set_private_data(source, ctf_fs);
 259         if (ret != BT_COMPONENT_STATUS_OK) {
 260                 goto error;
 261         }
 262
 263         ret = bt_component_source_set_iterator_init_cb(source,
 264                         ctf_fs_iterator_init);
 265         if (ret != BT_COMPONENT_STATUS_OK) {
 266                 goto error;
 267         }
 268
 269 end:
 270         return ret;
 271 error:
 272         (void) bt_component_set_private_data(source, NULL);
 273         ctf_fs_destroy_data(ctf_fs);
 274         return ret;
 275 }