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