lib/component/source.c

   1 /*
   2  * source.c
   3  *
   4  * Babeltrace Source 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/ref.h>
  30 #include <babeltrace/compiler.h>
  31 #include <babeltrace/component/component-source-internal.h>
  32 #include <babeltrace/component/component-internal.h>
  33 #include <babeltrace/component/component-port-internal.h>
  34 #include <babeltrace/component/notification/iterator.h>
  35 #include <babeltrace/component/notification/iterator-internal.h>
  36
  37 BT_HIDDEN
  38 enum bt_component_status bt_component_source_validate(
  39                 struct bt_component *component)
  40 {
  41         enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
  42
  43         if (!component) {
  44                 ret = BT_COMPONENT_STATUS_INVALID;
  45                 goto end;
  46         }
  47
  48         if (!component->class) {
  49                 ret = BT_COMPONENT_STATUS_INVALID;
  50                 goto end;
  51         }
  52
  53         if (component->class->type != BT_COMPONENT_CLASS_TYPE_SOURCE) {
  54                 ret = BT_COMPONENT_STATUS_INVALID;
  55                 goto end;
  56         }
  57
  58 end:
  59         return ret;
  60 }
  61
  62 static
  63 void bt_component_source_destroy(struct bt_component *component)
  64 {
  65         struct bt_component_source *source = container_of(component,
  66                         struct bt_component_source, parent);
  67
  68         if (source->output_ports) {
  69                 g_ptr_array_free(source->output_ports, TRUE);
  70         }
  71 }
  72
  73
  74 BT_HIDDEN
  75 struct bt_component *bt_component_source_create(
  76                 struct bt_component_class *class, struct bt_value *params)
  77 {
  78         int ret;
  79         struct bt_component_source *source = NULL;
  80         enum bt_component_status status;
  81
  82         source = g_new0(struct bt_component_source, 1);
  83         if (!source) {
  84                 goto end;
  85         }
  86
  87         source->parent.class = bt_get(class);
  88         status = bt_component_init(&source->parent, bt_component_source_destroy);
  89         if (status != BT_COMPONENT_STATUS_OK) {
  90                 goto error;
  91         }
  92
  93         ret = bt_component_init_output_ports(&source->parent, &source->output_ports);
  94         if (ret) {
  95                 goto error;
  96         }
  97
  98 end:
  99         return source ? &source->parent : NULL;
 100 error:
 101         BT_PUT(source);
 102         goto end;
 103 }
 104
 105 struct bt_notification_iterator *bt_component_source_create_notification_iterator(
 106                 struct bt_component *component)
 107 {
 108         return bt_component_create_iterator(component, NULL);
 109 }
 110
 111 struct bt_notification_iterator *bt_component_source_create_notification_iterator_with_init_method_data(
 112                 struct bt_component *component, void *init_method_data)
 113 {
 114         return bt_component_create_iterator(component, init_method_data);
 115 }
 116
 117 int bt_component_source_get_output_port_count(struct bt_component *component)
 118 {
 119         int ret;
 120         struct bt_component_source *source;
 121
 122         if (!component) {
 123                 ret = -1;
 124                 goto end;
 125         }
 126
 127         if (component->class->type != BT_COMPONENT_CLASS_TYPE_SOURCE) {
 128                 ret = -1;
 129                 goto end;
 130         }
 131
 132         source = container_of(component, struct bt_component_source, parent);
 133         ret = source->output_ports->len;
 134 end:
 135         return ret;
 136 }
 137
 138 struct bt_port *bt_component_source_get_output_port(
 139                 struct bt_component *component, const char *name)
 140 {
 141         struct bt_component_source *source;
 142         struct bt_port *ret_port = NULL;
 143
 144         if (!component || !name ||
 145                         component->class->type != BT_COMPONENT_CLASS_TYPE_SOURCE) {
 146                 goto end;
 147         }
 148
 149         source = container_of(component, struct bt_component_source, parent);
 150         ret_port = bt_component_get_port(source->output_ports, name);
 151 end:
 152         return ret_port;
 153 }
 154
 155 struct bt_port *bt_component_source_get_output_port_at_index(
 156                 struct bt_component *component, int index)
 157 {
 158         struct bt_port *port = NULL;
 159         struct bt_component_source *source;
 160
 161         if (!component ||
 162                         component->class->type != BT_COMPONENT_CLASS_TYPE_SOURCE) {
 163                 goto end;
 164         }
 165
 166         source = container_of(component, struct bt_component_source, parent);
 167         port = bt_component_get_port_at_index(source->output_ports, index);
 168 end:
 169         return port;
 170 }
 171
 172 struct bt_port *bt_component_source_get_default_output_port(
 173                 struct bt_component *component)
 174 {
 175         return bt_component_source_get_output_port(component,
 176                         DEFAULT_OUTPUT_PORT_NAME);
 177 }
 178
 179 struct bt_port *bt_component_source_add_output_port(
 180                 struct bt_component *component, const char *name)
 181 {
 182         struct bt_port *port;
 183         struct bt_component_source *source;
 184
 185         if (!component ||
 186                         component->class->type != BT_COMPONENT_CLASS_TYPE_SOURCE) {
 187                 port = NULL;
 188                 goto end;
 189         }
 190
 191         source = container_of(component, struct bt_component_source, parent);
 192         port = bt_component_add_port(component, source->output_ports,
 193                         BT_PORT_TYPE_OUTPUT, name);
 194 end:
 195         return port;
 196 }
 197
 198 enum bt_component_status bt_component_source_remove_output_port(
 199                 struct bt_component *component, const char *name)
 200 {
 201         enum bt_component_status status;
 202         struct bt_component_source *source;
 203
 204         if (!component ||
 205                         component->class->type != BT_COMPONENT_CLASS_TYPE_SOURCE) {
 206                 status = BT_COMPONENT_STATUS_INVALID;
 207                 goto end;
 208         }
 209
 210         source = container_of(component, struct bt_component_source, parent);
 211         status = bt_component_remove_port(component, source->output_ports,
 212                         name);
 213 end:
 214         return status;
 215 }