plugins/ctf/fs-sink/writer.c

   1 /*
   2  * writer.c
   3  *
   4  * Babeltrace CTF Writer Output Plugin
   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/ctf-ir/packet.h>
  30 #include <babeltrace/plugin/plugin-dev.h>
  31 #include <babeltrace/graph/connection.h>
  32 #include <babeltrace/graph/component.h>
  33 #include <babeltrace/graph/private-component.h>
  34 #include <babeltrace/graph/component-sink.h>
  35 #include <babeltrace/graph/private-component-sink.h>
  36 #include <babeltrace/graph/private-port.h>
  37 #include <babeltrace/graph/private-connection.h>
  38 #include <babeltrace/graph/notification.h>
  39 #include <babeltrace/graph/notification-iterator.h>
  40 #include <babeltrace/graph/notification-event.h>
  41 #include <babeltrace/graph/notification-packet.h>
  42 #include <babeltrace/graph/notification-stream.h>
  43 #include <plugins-common.h>
  44 #include <stdio.h>
  45 #include <stdbool.h>
  46 #include <glib.h>
  47 #include "writer.h"
  48 #include <assert.h>
  49
  50 static
  51 gboolean empty_trace_map(gpointer key, gpointer value, gpointer user_data)
  52 {
  53         struct fs_writer *fs_writer = value;
  54         struct writer_component *writer_component = user_data;
  55
  56         fs_writer->trace_static = 1;
  57         writer_close(writer_component, fs_writer);
  58
  59         return TRUE;
  60 }
  61
  62 static
  63 void destroy_writer_component_data(struct writer_component *writer_component)
  64 {
  65         bt_put(writer_component->input_iterator);
  66
  67         g_hash_table_foreach_remove(writer_component->trace_map,
  68                         empty_trace_map, writer_component);
  69         g_hash_table_destroy(writer_component->trace_map);
  70
  71         g_string_free(writer_component->base_path, true);
  72         g_string_free(writer_component->trace_name_base, true);
  73 }
  74
  75 BT_HIDDEN
  76 void writer_component_finalize(struct bt_private_component *component)
  77 {
  78         struct writer_component *writer_component = (struct writer_component *)
  79                 bt_private_component_get_user_data(component);
  80
  81         destroy_writer_component_data(writer_component);
  82         g_free(writer_component);
  83 }
  84
  85 static
  86 void free_fs_writer(struct fs_writer *fs_writer)
  87 {
  88         bt_put(fs_writer->writer);
  89         g_free(fs_writer);
  90 }
  91
  92 static
  93 struct writer_component *create_writer_component(void)
  94 {
  95         struct writer_component *writer_component;
  96
  97         writer_component = g_new0(struct writer_component, 1);
  98         if (!writer_component) {
  99                 goto end;
 100         }
 101
 102         writer_component->err = stderr;
 103         writer_component->trace_id = 0;
 104         writer_component->trace_name_base = g_string_new("trace");
 105         if (!writer_component->trace_name_base) {
 106                 g_free(writer_component);
 107                 writer_component = NULL;
 108                 goto end;
 109         }
 110
 111         /*
 112          * Reader to writer corresponding structures.
 113          */
 114         writer_component->trace_map = g_hash_table_new_full(g_direct_hash,
 115                         g_direct_equal, NULL, (GDestroyNotify) free_fs_writer);
 116
 117 end:
 118         return writer_component;
 119 }
 120
 121 static
 122 enum bt_component_status handle_notification(
 123                 struct writer_component *writer_component,
 124                 struct bt_notification *notification)
 125 {
 126         enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
 127
 128         if (!writer_component) {
 129                 ret = BT_COMPONENT_STATUS_ERROR;
 130                 goto end;
 131         }
 132
 133         switch (bt_notification_get_type(notification)) {
 134         case BT_NOTIFICATION_TYPE_PACKET_BEGIN:
 135         {
 136                 struct bt_ctf_packet *packet =
 137                         bt_notification_packet_begin_get_packet(notification);
 138
 139                 if (!packet) {
 140                         ret = BT_COMPONENT_STATUS_ERROR;
 141                         goto end;
 142                 }
 143
 144                 ret = writer_new_packet(writer_component, packet);
 145                 bt_put(packet);
 146                 break;
 147         }
 148         case BT_NOTIFICATION_TYPE_PACKET_END:
 149         {
 150                 struct bt_ctf_packet *packet =
 151                         bt_notification_packet_end_get_packet(notification);
 152
 153                 if (!packet) {
 154                         ret = BT_COMPONENT_STATUS_ERROR;
 155                         goto end;
 156                 }
 157                 ret = writer_close_packet(writer_component, packet);
 158                 bt_put(packet);
 159                 break;
 160         }
 161         case BT_NOTIFICATION_TYPE_EVENT:
 162         {
 163                 struct bt_ctf_event *event = bt_notification_event_get_event(
 164                                 notification);
 165
 166                 if (!event) {
 167                         ret = BT_COMPONENT_STATUS_ERROR;
 168                         goto end;
 169                 }
 170                 ret = writer_output_event(writer_component, event);
 171                 bt_put(event);
 172                 if (ret != BT_COMPONENT_STATUS_OK) {
 173                         goto end;
 174                 }
 175                 break;
 176         }
 177         case BT_NOTIFICATION_TYPE_STREAM_BEGIN:
 178         {
 179                 struct bt_ctf_stream *stream =
 180                         bt_notification_stream_begin_get_stream(notification);
 181
 182                 if (!stream) {
 183                         ret = BT_COMPONENT_STATUS_ERROR;
 184                         goto end;
 185                 }
 186                 ret = writer_stream_begin(writer_component, stream);
 187                 bt_put(stream);
 188                 break;
 189         }
 190         case BT_NOTIFICATION_TYPE_STREAM_END:
 191         {
 192                 struct bt_ctf_stream *stream =
 193                         bt_notification_stream_end_get_stream(notification);
 194
 195                 if (!stream) {
 196                         ret = BT_COMPONENT_STATUS_ERROR;
 197                         goto end;
 198                 }
 199                 ret = writer_stream_end(writer_component, stream);
 200                 bt_put(stream);
 201                 break;
 202         }
 203         default:
 204                 puts("Unhandled notification type");
 205         }
 206 end:
 207         return ret;
 208 }
 209
 210 BT_HIDDEN
 211 void writer_component_port_connected(
 212                 struct bt_private_component *component,
 213                 struct bt_private_port *self_port,
 214                 struct bt_port *other_port)
 215 {
 216         struct bt_private_connection *connection;
 217         struct writer_component *writer;
 218         enum bt_connection_status conn_status;
 219         static const enum bt_notification_type notif_types[] = {
 220                 BT_NOTIFICATION_TYPE_EVENT,
 221                 BT_NOTIFICATION_TYPE_PACKET_BEGIN,
 222                 BT_NOTIFICATION_TYPE_PACKET_END,
 223                 BT_NOTIFICATION_TYPE_STREAM_BEGIN,
 224                 BT_NOTIFICATION_TYPE_STREAM_END,
 225                 BT_NOTIFICATION_TYPE_SENTINEL,
 226         };
 227
 228         writer = bt_private_component_get_user_data(component);
 229         assert(writer);
 230         assert(!writer->input_iterator);
 231         connection = bt_private_port_get_private_connection(self_port);
 232         assert(connection);
 233         conn_status = bt_private_connection_create_notification_iterator(
 234                 connection, notif_types, &writer->input_iterator);
 235         if (conn_status != BT_CONNECTION_STATUS_OK) {
 236                 writer->error = true;
 237         }
 238
 239         bt_put(connection);
 240 }
 241
 242 BT_HIDDEN
 243 enum bt_component_status writer_run(struct bt_private_component *component)
 244 {
 245         enum bt_component_status ret;
 246         struct bt_notification *notification = NULL;
 247         struct bt_notification_iterator *it;
 248         struct writer_component *writer_component =
 249                 bt_private_component_get_user_data(component);
 250         enum bt_notification_iterator_status it_ret;
 251
 252         if (unlikely(writer_component->error)) {
 253                 ret = BT_COMPONENT_STATUS_ERROR;
 254                 goto end;
 255         }
 256
 257         it = writer_component->input_iterator;
 258         assert(it);
 259         it_ret = bt_notification_iterator_next(it);
 260
 261         switch (it_ret) {
 262         case BT_NOTIFICATION_ITERATOR_STATUS_END:
 263                 ret = BT_COMPONENT_STATUS_END;
 264                 BT_PUT(writer_component->input_iterator);
 265                 goto end;
 266         case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN:
 267                 ret = BT_COMPONENT_STATUS_AGAIN;
 268                 goto end;
 269         case BT_NOTIFICATION_ITERATOR_STATUS_OK:
 270                 break;
 271         default:
 272                 ret = BT_COMPONENT_STATUS_ERROR;
 273                 goto end;
 274         }
 275
 276         notification = bt_notification_iterator_get_notification(it);
 277         assert(notification);
 278         ret = handle_notification(writer_component, notification);
 279 end:
 280         bt_put(notification);
 281         return ret;
 282 }
 283
 284 static
 285 enum bt_component_status apply_one_bool(const char *key,
 286                 struct bt_value *params,
 287                 bool *option,
 288                 bool *found)
 289 {
 290         enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
 291         struct bt_value *value = NULL;
 292         enum bt_value_status status;
 293         bt_bool bool_val;
 294
 295         value = bt_value_map_get(params, key);
 296         if (!value) {
 297                 goto end;
 298         }
 299         status = bt_value_bool_get(value, &bool_val);
 300         switch (status) {
 301         case BT_VALUE_STATUS_OK:
 302                 break;
 303         default:
 304                 ret = BT_COMPONENT_STATUS_ERROR;
 305                 goto end;
 306         }
 307         *option = (bool) bool_val;
 308         if (found) {
 309                 *found = true;
 310         }
 311 end:
 312         bt_put(value);
 313         return ret;
 314 }
 315
 316 BT_HIDDEN
 317 enum bt_component_status writer_component_init(
 318         struct bt_private_component *component, struct bt_value *params,
 319         UNUSED_VAR void *init_method_data)
 320 {
 321         enum bt_component_status ret;
 322         enum bt_value_status value_ret;
 323         struct writer_component *writer_component = create_writer_component();
 324         struct bt_value *value = NULL;
 325         const char *path;
 326
 327         if (!writer_component) {
 328                 ret = BT_COMPONENT_STATUS_NOMEM;
 329                 goto end;
 330         }
 331
 332         ret = bt_private_component_sink_add_input_private_port(component,
 333                 "in", NULL, NULL);
 334         if (ret != BT_COMPONENT_STATUS_OK) {
 335                 goto end;
 336         }
 337
 338         value = bt_value_map_get(params, "path");
 339         if (!value || bt_value_is_null(value) || !bt_value_is_string(value)) {
 340                 fprintf(writer_component->err,
 341                                 "[error] output path parameter required\n");
 342                 ret = BT_COMPONENT_STATUS_INVALID;
 343                 goto error;
 344         }
 345
 346         value_ret = bt_value_string_get(value, &path);
 347         if (value_ret != BT_VALUE_STATUS_OK) {
 348                 ret = BT_COMPONENT_STATUS_INVALID;
 349                 goto error;
 350         }
 351         bt_put(value);
 352
 353         writer_component->base_path = g_string_new(path);
 354         if (!writer_component) {
 355                 ret = BT_COMPONENT_STATUS_ERROR;
 356                 goto error;
 357         }
 358
 359         writer_component->single_trace = false;
 360         ret = apply_one_bool("single-trace", params,
 361                         &writer_component->single_trace, NULL);
 362         if (ret != BT_COMPONENT_STATUS_OK) {
 363                 goto end;
 364         }
 365
 366         ret = bt_private_component_set_user_data(component, writer_component);
 367         if (ret != BT_COMPONENT_STATUS_OK) {
 368                 goto error;
 369         }
 370
 371 end:
 372         return ret;
 373 error:
 374         destroy_writer_component_data(writer_component);
 375         g_free(writer_component);
 376         return ret;
 377 }