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/component.h>
  25 #include <babeltrace/graph/private-component.h>
  26 #include <babeltrace/graph/private-component-sink.h>
  27 #include <babeltrace/graph/private-port.h>
  28 #include <babeltrace/graph/port.h>
  29 #include <babeltrace/graph/private-connection.h>
  30 #include <babeltrace/graph/component-sink.h>
  31 #include <babeltrace/graph/notification-iterator.h>
  32 #include <babeltrace/graph/notification.h>
  33 #include <babeltrace/babeltrace-internal.h>
  34 #include <plugins-common.h>
  35 #include <assert.h>
  36 #include "dummy.h"
  37
  38 static
  39 void destroy_private_dummy_data(struct dummy *dummy)
  40 {
  41         if (dummy->iterators) {
  42                 g_ptr_array_free(dummy->iterators, TRUE);
  43         }
  44         g_free(dummy);
  45 }
  46
  47 void dummy_finalize(struct bt_private_component *component)
  48 {
  49         struct dummy *dummy;
  50
  51         assert(component);
  52         dummy = bt_private_component_get_user_data(component);
  53         assert(dummy);
  54         destroy_private_dummy_data(dummy);
  55 }
  56
  57 enum bt_component_status dummy_init(struct bt_private_component *component,
  58                 struct bt_value *params, UNUSED_VAR void *init_method_data)
  59 {
  60         enum bt_component_status ret;
  61         struct dummy *dummy = g_new0(struct dummy, 1);
  62         void *priv_port;
  63
  64         if (!dummy) {
  65                 ret = BT_COMPONENT_STATUS_NOMEM;
  66                 goto end;
  67         }
  68
  69         priv_port = bt_private_component_sink_add_input_private_port(component,
  70                 "in", NULL);
  71         if (!priv_port) {
  72                 ret = BT_COMPONENT_STATUS_NOMEM;
  73                 goto end;
  74         }
  75
  76         bt_put(priv_port);
  77         dummy->iterators = g_ptr_array_new_with_free_func(
  78                         (GDestroyNotify) bt_put);
  79         if (!dummy->iterators) {
  80                 ret = BT_COMPONENT_STATUS_NOMEM;
  81                 goto end;
  82         }
  83
  84         ret = bt_private_component_set_user_data(component, dummy);
  85         if (ret != BT_COMPONENT_STATUS_OK) {
  86                 goto error;
  87         }
  88 end:
  89         return ret;
  90 error:
  91         destroy_private_dummy_data(dummy);
  92         return ret;
  93 }
  94
  95 void dummy_port_connected(
  96                 struct bt_private_component *component,
  97                 struct bt_private_port *self_port,
  98                 struct bt_port *other_port)
  99 {
 100         struct dummy *dummy;
 101         struct bt_notification_iterator *iterator;
 102         struct bt_private_connection *connection;
 103
 104         dummy = bt_private_component_get_user_data(component);
 105         assert(dummy);
 106         connection = bt_private_port_get_private_connection(self_port);
 107         assert(connection);
 108         iterator = bt_private_connection_create_notification_iterator(
 109                 connection);
 110         if (!iterator) {
 111                 dummy->error = true;
 112                 goto end;
 113         }
 114
 115         g_ptr_array_add(dummy->iterators, iterator);
 116
 117 end:
 118         bt_put(connection);
 119 }
 120
 121 enum bt_component_status dummy_consume(struct bt_private_component *component)
 122 {
 123         enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
 124         struct bt_notification *notif = NULL;
 125         size_t i;
 126         struct dummy *dummy;
 127
 128         dummy = bt_private_component_get_user_data(component);
 129         assert(dummy);
 130
 131         if (unlikely(dummy->error)) {
 132                 ret = BT_COMPONENT_STATUS_ERROR;
 133                 goto end;
 134         }
 135
 136         /* Consume one notification from each iterator. */
 137         for (i = 0; i < dummy->iterators->len; i++) {
 138                 struct bt_notification_iterator *it;
 139                 enum bt_notification_iterator_status it_ret;
 140
 141                 it = g_ptr_array_index(dummy->iterators, i);
 142
 143                 it_ret = bt_notification_iterator_next(it);
 144                 switch (it_ret) {
 145                 case BT_NOTIFICATION_ITERATOR_STATUS_ERROR:
 146                         ret = BT_COMPONENT_STATUS_ERROR;
 147                         goto end;
 148                 case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN:
 149                         ret = BT_COMPONENT_STATUS_AGAIN;
 150                         goto end;
 151                 case BT_NOTIFICATION_ITERATOR_STATUS_END:
 152                         g_ptr_array_remove_index(dummy->iterators, i);
 153                         i--;
 154                         continue;
 155                 default:
 156                         break;
 157                 }
 158         }
 159
 160         if (dummy->iterators->len == 0) {
 161                 ret = BT_COMPONENT_STATUS_END;
 162         }
 163 end:
 164         bt_put(notif);
 165         return ret;
 166 }