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