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/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 BT_HIDDEN
  63 void bt_component_source_destroy(struct bt_component *component)
  64 {
  65 }
  66
  67 BT_HIDDEN
  68 struct bt_component *bt_component_source_create(
  69                 struct bt_component_class *class, struct bt_value *params)
  70 {
  71         struct bt_component_source *source = NULL;
  72
  73         source = g_new0(struct bt_component_source, 1);
  74         if (!source) {
  75                 goto end;
  76         }
  77
  78 end:
  79         return source ? &source->parent : NULL;
  80 }
  81
  82 BT_HIDDEN
  83 struct bt_notification_iterator *bt_component_source_create_notification_iterator(
  84                 struct bt_component *component)
  85 {
  86         return bt_component_create_iterator(component, NULL);
  87 }
  88
  89 BT_HIDDEN
  90 struct bt_notification_iterator *bt_component_source_create_notification_iterator_with_init_method_data(
  91                 struct bt_component *component, void *init_method_data)
  92 {
  93         return bt_component_create_iterator(component, init_method_data);
  94 }
  95
  96 enum bt_component_status bt_component_source_get_output_port_count(
  97                 struct bt_component *component, uint64_t *count)
  98 {
  99         enum bt_component_status status = BT_COMPONENT_STATUS_OK;
 100
 101         if (!component || !count ||
 102                         component->class->type != BT_COMPONENT_CLASS_TYPE_SOURCE) {
 103                 status = BT_COMPONENT_STATUS_INVALID;
 104                 goto end;
 105         }
 106
 107         *count = bt_component_get_output_port_count(component);
 108 end:
 109         return status;
 110 }
 111
 112 struct bt_port *bt_component_source_get_output_port(
 113                 struct bt_component *component, const char *name)
 114 {
 115         struct bt_port *port = NULL;
 116
 117         if (!component || !name ||
 118                         component->class->type != BT_COMPONENT_CLASS_TYPE_SOURCE) {
 119                 goto end;
 120         }
 121
 122         port = bt_component_get_output_port(component, name);
 123 end:
 124         return port;
 125 }
 126
 127 struct bt_port *bt_component_source_get_output_port_at_index(
 128                 struct bt_component *component, int index)
 129 {
 130         struct bt_port *port = NULL;
 131
 132         if (!component ||
 133                         component->class->type != BT_COMPONENT_CLASS_TYPE_SOURCE) {
 134                 goto end;
 135         }
 136
 137         port = bt_component_get_output_port_at_index(component, index);
 138 end:
 139         return port;
 140 }
 141
 142 struct bt_port *bt_component_source_get_default_output_port(
 143                 struct bt_component *component)
 144 {
 145         return bt_component_source_get_output_port(component,
 146                         DEFAULT_OUTPUT_PORT_NAME);
 147 }
 148
 149 struct bt_port *bt_component_source_add_output_port(
 150                 struct bt_component *component, const char *name)
 151 {
 152         struct bt_port *port = NULL;
 153
 154         if (!component ||
 155                         component->class->type != BT_COMPONENT_CLASS_TYPE_SOURCE) {
 156                 goto end;
 157         }
 158
 159         port = bt_component_add_output_port(component, name);
 160 end:
 161         return port;
 162 }