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/component.h>
  32 #include <babeltrace/graph/private-component.h>
  33 #include <babeltrace/graph/component-sink.h>
  34 #include <babeltrace/graph/private-component-sink.h>
  35 #include <babeltrace/graph/private-port.h>
  36 #include <babeltrace/graph/private-connection.h>
  37 #include <babeltrace/graph/notification.h>
  38 #include <babeltrace/graph/notification-iterator.h>
  39 #include <babeltrace/graph/notification-event.h>
  40 #include <babeltrace/graph/notification-packet.h>
  41 #include <plugins-common.h>
  42 #include <stdio.h>
  43 #include <stdbool.h>
  44 #include <glib.h>
  45 #include "writer.h"
  46 #include <assert.h>
  47
  48 static
  49 void destroy_writer_component_data(struct writer_component *writer_component)
  50 {
  51         bt_put(writer_component->input_iterator);
  52         g_hash_table_destroy(writer_component->stream_map);
  53         g_hash_table_destroy(writer_component->stream_class_map);
  54         g_hash_table_destroy(writer_component->trace_map);
  55         g_string_free(writer_component->base_path, true);
  56         g_string_free(writer_component->trace_name_base, true);
  57 }
  58
  59 BT_HIDDEN
  60 void writer_component_finalize(struct bt_private_component *component)
  61 {
  62         struct writer_component *writer_component = (struct writer_component *)
  63                 bt_private_component_get_user_data(component);
  64
  65         destroy_writer_component_data(writer_component);
  66         g_free(writer_component);
  67 }
  68
  69 static
  70 void unref_stream_class(struct bt_ctf_stream_class *writer_stream_class)
  71 {
  72         bt_put(writer_stream_class);
  73 }
  74
  75 static
  76 void unref_stream(struct bt_ctf_stream_class *writer_stream)
  77 {
  78         bt_put(writer_stream);
  79 }
  80
  81 static
  82 void unref_trace(struct bt_ctf_writer *writer)
  83 {
  84         bt_put(writer);
  85 }
  86
  87 static
  88 struct writer_component *create_writer_component(void)
  89 {
  90         struct writer_component *writer_component;
  91
  92         writer_component = g_new0(struct writer_component, 1);
  93         if (!writer_component) {
  94                 goto end;
  95         }
  96
  97         writer_component->err = stderr;
  98         writer_component->trace_id = 0;
  99         writer_component->trace_name_base = g_string_new("trace");
 100         writer_component->processed_first_event = false;
 101         if (!writer_component->trace_name_base) {
 102                 g_free(writer_component);
 103                 writer_component = NULL;
 104                 goto end;
 105         }
 106
 107         /*
 108          * Reader to writer corresponding structures.
 109          */
 110         writer_component->trace_map = g_hash_table_new_full(g_direct_hash,
 111                         g_direct_equal, NULL, (GDestroyNotify) unref_trace);
 112         writer_component->stream_class_map = g_hash_table_new_full(g_direct_hash,
 113                         g_direct_equal, NULL, (GDestroyNotify) unref_stream_class);
 114         writer_component->stream_map = g_hash_table_new_full(g_direct_hash,
 115                         g_direct_equal, NULL, (GDestroyNotify) unref_stream);
 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 = BT_COMPONENT_STATUS_OK;
 171                 ret = writer_output_event(writer_component, event);
 172                 bt_put(event);
 173                 if (ret != BT_COMPONENT_STATUS_OK) {
 174                         goto end;
 175                 }
 176                 break;
 177         }
 178         case BT_NOTIFICATION_TYPE_STREAM_END:
 179                 break;
 180         default:
 181                 puts("Unhandled notification type");
 182         }
 183 end:
 184         return ret;
 185 }
 186
 187 BT_HIDDEN
 188 void writer_component_port_connected(
 189                 struct bt_private_component *component,
 190                 struct bt_private_port *self_port,
 191                 struct bt_port *other_port)
 192 {
 193         struct bt_private_connection *connection;
 194         struct writer_component *writer;
 195
 196         writer = bt_private_component_get_user_data(component);
 197         assert(writer);
 198         assert(!writer->input_iterator);
 199         connection = bt_private_port_get_private_connection(self_port);
 200         assert(connection);
 201         writer->input_iterator =
 202                 bt_private_connection_create_notification_iterator(connection,
 203                         NULL);
 204
 205         if (!writer->input_iterator) {
 206                 writer->error = true;
 207         }
 208
 209         bt_put(connection);
 210 }
 211
 212 BT_HIDDEN
 213 enum bt_component_status writer_run(struct bt_private_component *component)
 214 {
 215         enum bt_component_status ret;
 216         struct bt_notification *notification = NULL;
 217         struct bt_notification_iterator *it;
 218         struct writer_component *writer_component =
 219                 bt_private_component_get_user_data(component);
 220         enum bt_notification_iterator_status it_ret;
 221
 222         if (unlikely(writer_component->error)) {
 223                 ret = BT_COMPONENT_STATUS_ERROR;
 224                 goto end;
 225         }
 226
 227         it = writer_component->input_iterator;
 228         assert(it);
 229         it_ret = bt_notification_iterator_next(it);
 230
 231         switch (it_ret) {
 232         case BT_NOTIFICATION_ITERATOR_STATUS_END:
 233                 ret = BT_COMPONENT_STATUS_END;
 234                 BT_PUT(writer_component->input_iterator);
 235                 goto end;
 236         case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN:
 237                 ret = BT_COMPONENT_STATUS_AGAIN;
 238                 goto end;
 239         case BT_NOTIFICATION_ITERATOR_STATUS_OK:
 240                 break;
 241         default:
 242                 ret = BT_COMPONENT_STATUS_ERROR;
 243                 goto end;
 244         }
 245
 246         notification = bt_notification_iterator_get_notification(it);
 247         assert(notification);
 248         ret = handle_notification(writer_component, notification);
 249 end:
 250         bt_put(notification);
 251         return ret;
 252 }
 253
 254 BT_HIDDEN
 255 enum bt_component_status writer_component_init(
 256         struct bt_private_component *component, struct bt_value *params,
 257         UNUSED_VAR void *init_method_data)
 258 {
 259         enum bt_component_status ret;
 260         enum bt_value_status value_ret;
 261         struct writer_component *writer_component = create_writer_component();
 262         struct bt_value *value = NULL;
 263         const char *path;
 264         void *priv_port;
 265
 266         if (!writer_component) {
 267                 ret = BT_COMPONENT_STATUS_NOMEM;
 268                 goto end;
 269         }
 270
 271         priv_port = bt_private_component_sink_add_input_private_port(component,
 272                 "in", NULL);
 273         if (!priv_port) {
 274                 ret = BT_COMPONENT_STATUS_NOMEM;
 275                 goto end;
 276         }
 277
 278         bt_put(priv_port);
 279
 280         value = bt_value_map_get(params, "path");
 281         if (!value || bt_value_is_null(value) || !bt_value_is_string(value)) {
 282                 fprintf(writer_component->err,
 283                                 "[error] output path parameter required\n");
 284                 ret = BT_COMPONENT_STATUS_INVALID;
 285                 goto error;
 286         }
 287
 288         value_ret = bt_value_string_get(value, &path);
 289         if (value_ret != BT_VALUE_STATUS_OK) {
 290                 ret = BT_COMPONENT_STATUS_INVALID;
 291                 goto error;
 292         }
 293         bt_put(value);
 294
 295         writer_component->base_path = g_string_new(path);
 296         if (!writer_component) {
 297                 ret = BT_COMPONENT_STATUS_ERROR;
 298                 goto error;
 299         }
 300
 301         ret = bt_private_component_set_user_data(component, writer_component);
 302         if (ret != BT_COMPONENT_STATUS_OK) {
 303                 goto error;
 304         }
 305
 306 end:
 307         return ret;
 308 error:
 309         destroy_writer_component_data(writer_component);
 310         g_free(writer_component);
 311         return ret;
 312 }