plugins/utils/dummy/dummy.c

   1 /*
   2  * Copyright 2017 Philippe Proulx <pproulx@efficios.com>
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a copy
   5  * of this software and associated documentation files (the "Software"), to deal
   6  * in the Software without restriction, including without limitation the rights
   7  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   8  * copies of the Software, and to permit persons to whom the Software is
   9  * furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice shall be included in
  12  * all copies or substantial portions of the Software.
  13  *
  14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  19  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  20  * SOFTWARE.
  21  */
  22
  23 #include <babeltrace/plugin/plugin-dev.h>
  24 #include <babeltrace/graph/connection.h>
  25 #include <babeltrace/graph/component.h>
  26 #include <babeltrace/graph/private-component.h>
  27 #include <babeltrace/graph/private-component-sink.h>
  28 #include <babeltrace/graph/private-port.h>
  29 #include <babeltrace/graph/port.h>
  30 #include <babeltrace/graph/private-connection.h>
  31 #include <babeltrace/graph/component-sink.h>
  32 #include <babeltrace/graph/notification-iterator.h>
  33 #include <babeltrace/graph/notification.h>
  34 #include <babeltrace/babeltrace-internal.h>
  35 #include <plugins-common.h>
  36 #include <assert.h>
  37 #include "dummy.h"
  38
  39 void destroy_private_dummy_data(struct dummy *dummy)
  40 {
  41         bt_put(dummy->notif_iter);
  42         g_free(dummy);
  43 }
  44
  45 void dummy_finalize(struct bt_private_component *component)
  46 {
  47         struct dummy *dummy;
  48
  49         assert(component);
  50         dummy = bt_private_component_get_user_data(component);
  51         assert(dummy);
  52         destroy_private_dummy_data(dummy);
  53 }
  54
  55 enum bt_component_status dummy_init(struct bt_private_component *component,
  56                 struct bt_value *params, UNUSED_VAR void *init_method_data)
  57 {
  58         enum bt_component_status ret;
  59         struct dummy *dummy = g_new0(struct dummy, 1);
  60
  61         if (!dummy) {
  62                 ret = BT_COMPONENT_STATUS_NOMEM;
  63                 goto end;
  64         }
  65
  66         ret = bt_private_component_sink_add_input_private_port(component,
  67                 "in", NULL, NULL);
  68         if (ret != BT_COMPONENT_STATUS_OK) {
  69                 goto end;
  70         }
  71
  72         ret = bt_private_component_set_user_data(component, dummy);
  73         if (ret != BT_COMPONENT_STATUS_OK) {
  74                 goto error;
  75         }
  76
  77         goto end;
  78
  79 error:
  80         destroy_private_dummy_data(dummy);
  81
  82 end:
  83         return ret;
  84 }
  85
  86 void dummy_port_connected(
  87                 struct bt_private_component *component,
  88                 struct bt_private_port *self_port,
  89                 struct bt_port *other_port)
  90 {
  91         struct dummy *dummy;
  92         struct bt_notification_iterator *iterator;
  93         struct bt_private_connection *connection;
  94         enum bt_connection_status conn_status;
  95
  96         dummy = bt_private_component_get_user_data(component);
  97         assert(dummy);
  98         connection = bt_private_port_get_private_connection(self_port);
  99         assert(connection);
 100         conn_status = bt_private_connection_create_notification_iterator(
 101                 connection, NULL, &iterator);
 102         if (conn_status != BT_CONNECTION_STATUS_OK) {
 103                 dummy->error = true;
 104                 goto end;
 105         }
 106
 107         BT_MOVE(dummy->notif_iter, iterator);
 108
 109 end:
 110         bt_put(connection);
 111 }
 112
 113 enum bt_component_status dummy_consume(struct bt_private_component *component)
 114 {
 115         enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
 116         struct bt_notification *notif = NULL;
 117         struct dummy *dummy;
 118         enum bt_notification_iterator_status it_ret;
 119
 120         dummy = bt_private_component_get_user_data(component);
 121         assert(dummy);
 122
 123         if (unlikely(dummy->error)) {
 124                 ret = BT_COMPONENT_STATUS_ERROR;
 125                 goto end;
 126         }
 127
 128         if (unlikely(!dummy->notif_iter)) {
 129                 ret = BT_COMPONENT_STATUS_END;
 130                 goto end;
 131         }
 132
 133         /* Consume one notification  */
 134         it_ret = bt_notification_iterator_next(dummy->notif_iter);
 135         switch (it_ret) {
 136         case BT_NOTIFICATION_ITERATOR_STATUS_ERROR:
 137                 ret = BT_COMPONENT_STATUS_ERROR;
 138                 goto end;
 139         case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN:
 140                 ret = BT_COMPONENT_STATUS_AGAIN;
 141                 goto end;
 142         case BT_NOTIFICATION_ITERATOR_STATUS_END:
 143                 ret = BT_COMPONENT_STATUS_END;
 144                 goto end;
 145         default:
 146                 break;
 147         }
 148
 149 end:
 150         bt_put(notif);
 151         return ret;
 152 }