lib/component/sink.c

   1 /*
   2  * sink.c
   3  *
   4  * Babeltrace Sink Component
   5  *
   6  * Copyright 2015 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/compiler.h>
  30 #include <babeltrace/values.h>
  31 #include <babeltrace/component/component-sink-internal.h>
  32 #include <babeltrace/component/component-internal.h>
  33 #include <babeltrace/component/notification/notification.h>
  34
  35 BT_HIDDEN
  36 enum bt_component_status bt_component_sink_validate(
  37                 struct bt_component *component)
  38 {
  39         enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
  40
  41         if (!component) {
  42                 ret = BT_COMPONENT_STATUS_INVALID;
  43                 goto end;
  44         }
  45
  46         if (!component->class) {
  47                 ret = BT_COMPONENT_STATUS_INVALID;
  48                 goto end;
  49         }
  50
  51         if (component->class->type != BT_COMPONENT_CLASS_TYPE_SINK) {
  52                 ret = BT_COMPONENT_STATUS_INVALID;
  53                 goto end;
  54         }
  55 end:
  56         return ret;
  57 }
  58
  59 static
  60 void bt_component_sink_destroy(struct bt_component *component)
  61 {
  62         struct bt_component_sink *sink = container_of(component,
  63                         struct bt_component_sink, parent);
  64
  65         if (sink->input_ports) {
  66                 g_ptr_array_free(sink->input_ports, TRUE);
  67         }
  68 }
  69
  70 BT_HIDDEN
  71 struct bt_component *bt_component_sink_create(
  72                 struct bt_component_class *class, struct bt_value *params)
  73 {
  74         struct bt_component_sink *sink = NULL;
  75         enum bt_component_status ret;
  76
  77         sink = g_new0(struct bt_component_sink, 1);
  78         if (!sink) {
  79                 goto end;
  80         }
  81
  82         sink->parent.class = bt_get(class);
  83         ret = bt_component_init(&sink->parent, bt_component_sink_destroy);
  84         if (ret != BT_COMPONENT_STATUS_OK) {
  85                 goto error;
  86         }
  87
  88 /*
  89         ret = bt_component_sink_register_notification_type(&sink->parent,
  90                 BT_NOTIFICATION_TYPE_EVENT);
  91         if (ret != BT_COMPONENT_STATUS_OK) {
  92                 goto error;
  93         }
  94 */
  95         ret = bt_component_init_input_ports(&sink->parent,
  96                         &sink->input_ports);
  97         if (ret) {
  98                 goto error;
  99         }
 100
 101 end:
 102         return sink ? &sink->parent : NULL;
 103 error:
 104         BT_PUT(sink);
 105         return NULL;
 106 }
 107
 108 BT_HIDDEN
 109 enum bt_component_status bt_component_sink_consume(
 110                 struct bt_component *component)
 111 {
 112         enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
 113         struct bt_component_class_sink *sink_class = NULL;
 114
 115         if (!component) {
 116                 ret = BT_COMPONENT_STATUS_INVALID;
 117                 goto end;
 118         }
 119
 120         if (bt_component_get_class_type(component) != BT_COMPONENT_CLASS_TYPE_SINK) {
 121                 ret = BT_COMPONENT_STATUS_UNSUPPORTED;
 122                 goto end;
 123         }
 124
 125         sink_class = container_of(component->class, struct bt_component_class_sink, parent);
 126         assert(sink_class->methods.consume);
 127         ret = sink_class->methods.consume(component);
 128 end:
 129         return ret;
 130 }
 131 /*
 132 static
 133 enum bt_component_status bt_component_sink_register_notification_type(
 134                 struct bt_component *component, enum bt_notification_type type)
 135 {
 136         enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
 137         struct bt_component_sink *sink = NULL;
 138
 139         if (!component) {
 140                 ret = BT_COMPONENT_STATUS_INVALID;
 141                 goto end;
 142         }
 143
 144         if (bt_component_get_class_type(component) != BT_COMPONENT_CLASS_TYPE_SINK) {
 145                 ret = BT_COMPONENT_STATUS_UNSUPPORTED;
 146                 goto end;
 147         }
 148
 149         if (type <= BT_NOTIFICATION_TYPE_UNKNOWN ||
 150                 type >= BT_NOTIFICATION_TYPE_NR) {
 151                 ret = BT_COMPONENT_STATUS_INVALID;
 152                 goto end;
 153         }
 154         sink = container_of(component, struct bt_component_sink, parent);
 155         if (type == BT_NOTIFICATION_TYPE_ALL) {
 156                 sink->registered_notifications_mask = ~(notification_mask_t) 0;
 157         } else {
 158                 sink->registered_notifications_mask |=
 159                         (notification_mask_t) 1 << type;
 160         }
 161 end:
 162         return ret;
 163 }
 164 */
 165
 166 enum bt_component_status bt_component_sink_get_input_port_count(
 167                 struct bt_component *component, uint64_t *count)
 168 {
 169         enum bt_component_status status = BT_COMPONENT_STATUS_OK;
 170         struct bt_component_sink *sink;
 171
 172         if (!component || !count) {
 173                 status = BT_COMPONENT_STATUS_INVALID;
 174                 goto end;
 175         }
 176
 177         if (component->class->type != BT_COMPONENT_CLASS_TYPE_SINK) {
 178                 status = BT_COMPONENT_STATUS_INVALID;
 179                 goto end;
 180         }
 181
 182         sink = container_of(component, struct bt_component_sink, parent);
 183         *count = (uint64_t) sink->input_ports->len;
 184 end:
 185         return status;
 186 }
 187
 188 struct bt_port *bt_component_sink_get_input_port(
 189                 struct bt_component *component, const char *name)
 190 {
 191         struct bt_component_sink *sink;
 192         struct bt_port *ret_port = NULL;
 193
 194         if (!component || !name ||
 195                         component->class->type != BT_COMPONENT_CLASS_TYPE_SINK) {
 196                 goto end;
 197         }
 198
 199         sink = container_of(component, struct bt_component_sink, parent);
 200         ret_port = bt_component_get_port(sink->input_ports, name);
 201 end:
 202         return ret_port;
 203 }
 204
 205 struct bt_port *bt_component_sink_get_input_port_at_index(
 206                 struct bt_component *component, int index)
 207 {
 208         struct bt_port *port = NULL;
 209         struct bt_component_sink *sink;
 210
 211         if (!component ||
 212                         component->class->type != BT_COMPONENT_CLASS_TYPE_SINK) {
 213                 goto end;
 214         }
 215
 216         sink = container_of(component, struct bt_component_sink, parent);
 217         port = bt_component_get_port_at_index(sink->input_ports, index);
 218 end:
 219         return port;
 220 }
 221
 222 struct bt_port *bt_component_sink_get_default_input_port(
 223                 struct bt_component *component)
 224 {
 225         return bt_component_sink_get_input_port(component,
 226                         DEFAULT_INPUT_PORT_NAME);
 227 }
 228
 229 struct bt_port *bt_component_sink_add_input_port(
 230                 struct bt_component *component, const char *name)
 231 {
 232         struct bt_port *port;
 233         struct bt_component_sink *sink;
 234
 235         if (!component ||
 236                         component->class->type != BT_COMPONENT_CLASS_TYPE_SINK) {
 237                 port = NULL;
 238                 goto end;
 239         }
 240
 241         sink = container_of(component, struct bt_component_sink, parent);
 242         port = bt_component_add_port(component, sink->input_ports,
 243                         BT_PORT_TYPE_INPUT, name);
 244 end:
 245         return port;
 246 }
 247
 248 enum bt_component_status bt_component_sink_remove_input_port(
 249                 struct bt_component *component, const char *name)
 250 {
 251         enum bt_component_status status;
 252         struct bt_component_sink *sink;
 253
 254         if (!component ||
 255                         component->class->type != BT_COMPONENT_CLASS_TYPE_SINK) {
 256                 status = BT_COMPONENT_STATUS_INVALID;
 257                 goto end;
 258         }
 259
 260         sink = container_of(component, struct bt_component_sink, parent);
 261         status = bt_component_remove_port(component, sink->input_ports,
 262                         name);
 263 end:
 264         return status;
 265 }