plugins/writer/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-macros.h>
  31 #include <babeltrace/plugin/component.h>
  32 #include <babeltrace/plugin/sink.h>
  33 #include <babeltrace/plugin/notification/notification.h>
  34 #include <babeltrace/plugin/notification/iterator.h>
  35 #include <babeltrace/plugin/notification/event.h>
  36 #include <babeltrace/plugin/notification/packet.h>
  37 #include <stdio.h>
  38 #include <stdbool.h>
  39 #include <glib.h>
  40 #include "writer.h"
  41
  42 static
  43 void destroy_writer_component_data(struct writer_component *writer_component)
  44 {
  45         g_hash_table_destroy(writer_component->stream_map);
  46         g_hash_table_destroy(writer_component->stream_class_map);
  47         g_hash_table_destroy(writer_component->trace_map);
  48 }
  49
  50 static
  51 void destroy_writer_component(struct bt_component *component)
  52 {
  53         struct writer_component *writer_component = (struct writer_component *)
  54                 bt_component_get_private_data(component);
  55
  56         destroy_writer_component_data(writer_component);
  57         g_free(writer_component);
  58 }
  59
  60 static
  61 void unref_stream_class(struct bt_ctf_stream_class *writer_stream_class)
  62 {
  63         BT_PUT(writer_stream_class);
  64         g_free(writer_stream_class);
  65 }
  66
  67 static
  68 void unref_stream(struct bt_ctf_stream_class *writer_stream)
  69 {
  70         BT_PUT(writer_stream);
  71         g_free(writer_stream);
  72 }
  73
  74 static
  75 void unref_trace(struct bt_ctf_writer *writer)
  76 {
  77         BT_PUT(writer);
  78         g_free(writer);
  79 }
  80
  81 static
  82 struct writer_component *create_writer_component(void)
  83 {
  84         struct writer_component *writer_component;
  85
  86         writer_component = g_new0(struct writer_component, 1);
  87         if (!writer_component) {
  88                 goto end;
  89         }
  90
  91         writer_component->err = stderr;
  92         writer_component->trace_id = 0;
  93         snprintf(writer_component->trace_name_base, NAME_MAX, "trace");
  94
  95         /*
  96          * Reader to writer corresponding structures.
  97          */
  98         writer_component->trace_map = g_hash_table_new_full(g_direct_hash,
  99                         g_direct_equal, NULL, (GDestroyNotify) unref_trace);
 100         writer_component->stream_class_map = g_hash_table_new_full(g_direct_hash,
 101                         g_direct_equal, NULL, (GDestroyNotify) unref_stream_class);
 102         writer_component->stream_map = g_hash_table_new_full(g_direct_hash,
 103                         g_direct_equal, NULL, (GDestroyNotify) unref_stream);
 104
 105 end:
 106         return writer_component;
 107 }
 108
 109 static
 110 enum bt_component_status handle_notification(
 111                 struct writer_component *writer_component,
 112                 struct bt_notification *notification)
 113 {
 114         enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
 115
 116         if (!writer_component) {
 117                 ret = BT_COMPONENT_STATUS_ERROR;
 118                 goto end;
 119         }
 120
 121         switch (bt_notification_get_type(notification)) {
 122         case BT_NOTIFICATION_TYPE_PACKET_START:
 123         {
 124                 struct bt_ctf_packet *packet =
 125                         bt_notification_packet_start_get_packet(notification);
 126
 127                 if (!packet) {
 128                         ret = BT_COMPONENT_STATUS_ERROR;
 129                         goto end;
 130                 }
 131
 132                 ret = writer_new_packet(writer_component, packet);
 133                 bt_put(packet);
 134                 break;
 135         }
 136         case BT_NOTIFICATION_TYPE_PACKET_END:
 137         {
 138                 struct bt_ctf_packet *packet =
 139                         bt_notification_packet_start_get_packet(notification);
 140
 141                 if (!packet) {
 142                         ret = BT_COMPONENT_STATUS_ERROR;
 143                         goto end;
 144                 }
 145                 ret = writer_close_packet(writer_component, packet);
 146                 bt_put(packet);
 147                 break;
 148         }
 149         case BT_NOTIFICATION_TYPE_EVENT:
 150         {
 151                 struct bt_ctf_event *event = bt_notification_event_get_event(
 152                                 notification);
 153
 154                 if (!event) {
 155                         ret = BT_COMPONENT_STATUS_ERROR;
 156                         goto end;
 157                 }
 158                 ret = BT_COMPONENT_STATUS_OK;
 159                 ret = writer_output_event(writer_component, event);
 160                 bt_put(event);
 161                 if (ret != BT_COMPONENT_STATUS_OK) {
 162                         goto end;
 163                 }
 164                 break;
 165         }
 166         case BT_NOTIFICATION_TYPE_STREAM_END:
 167                 break;
 168         default:
 169                 puts("Unhandled notification type");
 170         }
 171 end:
 172         return ret;
 173 }
 174
 175 static
 176 enum bt_component_status run(struct bt_component *component)
 177 {
 178         enum bt_component_status ret;
 179         struct bt_notification *notification = NULL;
 180         struct bt_notification_iterator *it;
 181         struct writer_component *writer_component =
 182                 bt_component_get_private_data(component);
 183
 184         ret = bt_component_sink_get_input_iterator(component, 0, &it);
 185         if (ret != BT_COMPONENT_STATUS_OK) {
 186                 goto end;
 187         }
 188
 189         ret = bt_notification_iterator_next(it);
 190         if (ret != BT_COMPONENT_STATUS_OK) {
 191                 goto end;
 192         }
 193
 194         notification = bt_notification_iterator_get_notification(it);
 195         if (!notification) {
 196                 ret = BT_COMPONENT_STATUS_ERROR;
 197                 goto end;
 198         }
 199
 200         ret = handle_notification(writer_component, notification);
 201 end:
 202         bt_put(it);
 203         bt_put(notification);
 204         return ret;
 205 }
 206
 207 static
 208 enum bt_component_status writer_component_init(
 209         struct bt_component *component, struct bt_value *params)
 210 {
 211         enum bt_component_status ret;
 212         enum bt_value_status value_ret;
 213         struct writer_component *writer_component = create_writer_component();
 214         struct bt_value *value = NULL;
 215         const char *path;
 216
 217         if (!writer_component) {
 218                 ret = BT_COMPONENT_STATUS_NOMEM;
 219                 goto end;
 220         }
 221
 222         value = bt_value_map_get(params, "path");
 223         if (!value || bt_value_is_null(value) || !bt_value_is_string(value)) {
 224                 fprintf(writer_component->err,
 225                                 "[error] output path parameter required\n");
 226                 ret = BT_COMPONENT_STATUS_INVALID;
 227                 goto error;
 228         }
 229
 230         value_ret = bt_value_string_get(value, &path);
 231         if (value_ret != BT_VALUE_STATUS_OK) {
 232                 ret = BT_COMPONENT_STATUS_INVALID;
 233                 goto error;
 234         }
 235
 236         strncpy(writer_component->base_path, path, PATH_MAX);
 237
 238         ret = bt_component_set_destroy_cb(component,
 239                         destroy_writer_component);
 240         if (ret != BT_COMPONENT_STATUS_OK) {
 241                 goto error;
 242         }
 243
 244         ret = bt_component_set_private_data(component, writer_component);
 245         if (ret != BT_COMPONENT_STATUS_OK) {
 246                 goto error;
 247         }
 248
 249         ret = bt_component_sink_set_consume_cb(component,
 250                         run);
 251         if (ret != BT_COMPONENT_STATUS_OK) {
 252                 goto error;
 253         }
 254
 255 end:
 256         return ret;
 257 error:
 258         destroy_writer_component_data(writer_component);
 259         return ret;
 260 }
 261
 262 /* Initialize plug-in entry points. */
 263 BT_PLUGIN_NAME("writer");
 264 BT_PLUGIN_DESCRIPTION("Babeltrace CTF-Writer output plug-in.");
 265 BT_PLUGIN_AUTHOR("Jérémie Galarneau");
 266 BT_PLUGIN_LICENSE("MIT");
 267
 268 BT_PLUGIN_COMPONENT_CLASSES_BEGIN
 269 BT_PLUGIN_SINK_COMPONENT_CLASS_ENTRY("writer",
 270                 "Formats CTF-IR to CTF.",
 271                 writer_component_init)
 272 BT_PLUGIN_COMPONENT_CLASSES_END