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 enum bt_component_status bt_component_sink_consume(
 109                 struct bt_component *component)
 110 {
 111         enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
 112         struct bt_component_class_sink *sink_class = NULL;
 113
 114         if (!component) {
 115                 ret = BT_COMPONENT_STATUS_INVALID;
 116                 goto end;
 117         }
 118
 119         if (bt_component_get_class_type(component) != BT_COMPONENT_CLASS_TYPE_SINK) {
 120                 ret = BT_COMPONENT_STATUS_UNSUPPORTED;
 121                 goto end;
 122         }
 123
 124         sink_class = container_of(component->class, struct bt_component_class_sink, parent);
 125         assert(sink_class->methods.consume);
 126         ret = sink_class->methods.consume(component);
 127 end:
 128         return ret;
 129 }
 130 /*
 131 static
 132 enum bt_component_status bt_component_sink_register_notification_type(
 133                 struct bt_component *component, enum bt_notification_type type)
 134 {
 135         enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
 136         struct bt_component_sink *sink = NULL;
 137
 138         if (!component) {
 139                 ret = BT_COMPONENT_STATUS_INVALID;
 140                 goto end;
 141         }
 142
 143         if (bt_component_get_class_type(component) != BT_COMPONENT_CLASS_TYPE_SINK) {
 144                 ret = BT_COMPONENT_STATUS_UNSUPPORTED;
 145                 goto end;
 146         }
 147
 148         if (type <= BT_NOTIFICATION_TYPE_UNKNOWN ||
 149                 type >= BT_NOTIFICATION_TYPE_NR) {
 150                 ret = BT_COMPONENT_STATUS_INVALID;
 151                 goto end;
 152         }
 153         sink = container_of(component, struct bt_component_sink, parent);
 154         if (type == BT_NOTIFICATION_TYPE_ALL) {
 155                 sink->registered_notifications_mask = ~(notification_mask_t) 0;
 156         } else {
 157                 sink->registered_notifications_mask |=
 158                         (notification_mask_t) 1 << type;
 159         }
 160 end:
 161         return ret;
 162 }
 163 */
 164
 165 int bt_component_sink_get_input_port_count(struct bt_component *component)
 166 {
 167         int ret;
 168         struct bt_component_sink *sink;
 169
 170         if (!component) {
 171                 ret = -1;
 172                 goto end;
 173         }
 174
 175         if (component->class->type != BT_COMPONENT_CLASS_TYPE_SINK) {
 176                 ret = -1;
 177                 goto end;
 178         }
 179
 180         sink = container_of(component, struct bt_component_sink, parent);
 181         ret = sink->input_ports->len;
 182 end:
 183         return ret;
 184 }
 185
 186 struct bt_port *bt_component_sink_get_input_port(
 187                 struct bt_component *component, const char *name)
 188 {
 189         struct bt_component_sink *sink;
 190         struct bt_port *ret_port = NULL;
 191
 192         if (!component || !name ||
 193                         component->class->type != BT_COMPONENT_CLASS_TYPE_SINK) {
 194                 goto end;
 195         }
 196
 197         sink = container_of(component, struct bt_component_sink, parent);
 198         ret_port = bt_component_get_port(sink->input_ports, name);
 199 end:
 200         return ret_port;
 201 }
 202
 203 struct bt_port *bt_component_sink_get_input_port_at_index(
 204                 struct bt_component *component, int index)
 205 {
 206         struct bt_port *port = NULL;
 207         struct bt_component_sink *sink;
 208
 209         if (!component ||
 210                         component->class->type != BT_COMPONENT_CLASS_TYPE_SINK) {
 211                 goto end;
 212         }
 213
 214         sink = container_of(component, struct bt_component_sink, parent);
 215         port = bt_component_get_port_at_index(sink->input_ports, index);
 216 end:
 217         return port;
 218 }
 219
 220 struct bt_port *bt_component_sink_get_default_input_port(
 221                 struct bt_component *component)
 222 {
 223         return bt_component_sink_get_input_port(component,
 224                         DEFAULT_INPUT_PORT_NAME);
 225 }
 226
 227 struct bt_port *bt_component_sink_add_input_port(
 228                 struct bt_component *component, const char *name)
 229 {
 230         struct bt_port *port;
 231         struct bt_component_sink *sink;
 232
 233         if (!component ||
 234                         component->class->type != BT_COMPONENT_CLASS_TYPE_SINK) {
 235                 port = NULL;
 236                 goto end;
 237         }
 238
 239         sink = container_of(component, struct bt_component_sink, parent);
 240         port = bt_component_add_port(component, sink->input_ports,
 241                         BT_PORT_TYPE_INPUT, name);
 242 end:
 243         return port;
 244 }
 245
 246 enum bt_component_status bt_component_sink_remove_input_port(
 247                 struct bt_component *component, const char *name)
 248 {
 249         enum bt_component_status status;
 250         struct bt_component_sink *sink;
 251
 252         if (!component ||
 253                         component->class->type != BT_COMPONENT_CLASS_TYPE_SINK) {
 254                 status = BT_COMPONENT_STATUS_INVALID;
 255                 goto end;
 256         }
 257
 258         sink = container_of(component, struct bt_component_sink, parent);
 259         status = bt_component_remove_port(component, sink->input_ports,
 260                         name);
 261 end:
 262         return status;
 263 }