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/babeltrace.h>
  24 #include <babeltrace/babeltrace-internal.h>
  25 #include <plugins-common.h>
  26 #include <babeltrace/assert-internal.h>
  27 #include "dummy.h"
  28
  29 void destroy_private_dummy_data(struct dummy *dummy)
  30 {
  31         bt_object_put_ref(dummy->notif_iter);
  32         g_free(dummy);
  33 }
  34
  35 void dummy_finalize(struct bt_private_component *component)
  36 {
  37         struct dummy *dummy;
  38
  39         BT_ASSERT(component);
  40         dummy = bt_private_component_get_user_data(component);
  41         BT_ASSERT(dummy);
  42         destroy_private_dummy_data(dummy);
  43 }
  44
  45 enum bt_component_status dummy_init(struct bt_private_component *component,
  46                 struct bt_value *params, UNUSED_VAR void *init_method_data)
  47 {
  48         enum bt_component_status ret;
  49         struct dummy *dummy = g_new0(struct dummy, 1);
  50
  51         if (!dummy) {
  52                 ret = BT_COMPONENT_STATUS_NOMEM;
  53                 goto end;
  54         }
  55
  56         ret = bt_private_component_sink_add_input_private_port(component,
  57                 "in", NULL, NULL);
  58         if (ret != BT_COMPONENT_STATUS_OK) {
  59                 goto end;
  60         }
  61
  62         ret = bt_private_component_set_user_data(component, dummy);
  63         if (ret != BT_COMPONENT_STATUS_OK) {
  64                 goto error;
  65         }
  66
  67         goto end;
  68
  69 error:
  70         destroy_private_dummy_data(dummy);
  71
  72 end:
  73         return ret;
  74 }
  75
  76 enum bt_component_status dummy_port_connected(
  77                 struct bt_private_component *component,
  78                 struct bt_private_port *self_port,
  79                 struct bt_port *other_port)
  80 {
  81         enum bt_component_status status = BT_COMPONENT_STATUS_OK;
  82         struct dummy *dummy;
  83         struct bt_notification_iterator *iterator;
  84         struct bt_private_connection *connection;
  85         enum bt_connection_status conn_status;
  86
  87         dummy = bt_private_component_get_user_data(component);
  88         BT_ASSERT(dummy);
  89         connection = bt_private_port_get_private_connection(self_port);
  90         BT_ASSERT(connection);
  91         conn_status = bt_private_connection_create_notification_iterator(
  92                 connection, &iterator);
  93         if (conn_status != BT_CONNECTION_STATUS_OK) {
  94                 status = BT_COMPONENT_STATUS_ERROR;
  95                 goto end;
  96         }
  97
  98         BT_OBJECT_MOVE_REF(dummy->notif_iter, iterator);
  99
 100 end:
 101         bt_object_put_ref(connection);
 102         return status;
 103 }
 104
 105 enum bt_component_status dummy_consume(struct bt_private_component *component)
 106 {
 107         enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
 108         bt_notification_array notifs;
 109         uint64_t count;
 110         struct dummy *dummy;
 111         enum bt_notification_iterator_status it_ret;
 112         uint64_t i;
 113
 114         dummy = bt_private_component_get_user_data(component);
 115         BT_ASSERT(dummy);
 116
 117         if (unlikely(!dummy->notif_iter)) {
 118                 ret = BT_COMPONENT_STATUS_END;
 119                 goto end;
 120         }
 121
 122         /* Consume one notification  */
 123         it_ret = bt_private_connection_notification_iterator_next(
 124                 dummy->notif_iter, &notifs, &count);
 125         switch (it_ret) {
 126         case BT_NOTIFICATION_ITERATOR_STATUS_OK:
 127                 ret = BT_COMPONENT_STATUS_OK;
 128
 129                 for (i = 0; i < count; i++) {
 130                         bt_object_put_ref(notifs[i]);
 131                 }
 132
 133                 break;
 134         case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN:
 135                 ret = BT_COMPONENT_STATUS_AGAIN;
 136                 goto end;
 137         case BT_NOTIFICATION_ITERATOR_STATUS_END:
 138                 ret = BT_COMPONENT_STATUS_END;
 139                 goto end;
 140         case BT_NOTIFICATION_ITERATOR_STATUS_ERROR:
 141                 ret = BT_COMPONENT_STATUS_ERROR;
 142                 goto end;
 143         default:
 144                 break;
 145         }
 146
 147 end:
 148         return ret;
 149 }