lib/graph/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-internal.h>
  31 #include <babeltrace/graph/component-source-internal.h>
  32 #include <babeltrace/graph/component-internal.h>
  33 #include <babeltrace/graph/port-internal.h>
  34 #include <babeltrace/graph/notification-iterator.h>
  35 #include <babeltrace/graph/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 enum bt_component_status bt_component_source_get_output_port_count(
  83                 struct bt_component *component, uint64_t *count)
  84 {
  85         enum bt_component_status status = BT_COMPONENT_STATUS_OK;
  86
  87         if (!component || !count ||
  88                         component->class->type != BT_COMPONENT_CLASS_TYPE_SOURCE) {
  89                 status = BT_COMPONENT_STATUS_INVALID;
  90                 goto end;
  91         }
  92
  93         *count = bt_component_get_output_port_count(component);
  94 end:
  95         return status;
  96 }
  97
  98 struct bt_port *bt_component_source_get_output_port(
  99                 struct bt_component *component, const char *name)
 100 {
 101         struct bt_port *port = NULL;
 102
 103         if (!component || !name ||
 104                         component->class->type != BT_COMPONENT_CLASS_TYPE_SOURCE) {
 105                 goto end;
 106         }
 107
 108         port = bt_component_get_output_port(component, name);
 109 end:
 110         return port;
 111 }
 112
 113 struct bt_port *bt_component_source_get_output_port_at_index(
 114                 struct bt_component *component, int index)
 115 {
 116         struct bt_port *port = NULL;
 117
 118         if (!component ||
 119                         component->class->type != BT_COMPONENT_CLASS_TYPE_SOURCE) {
 120                 goto end;
 121         }
 122
 123         port = bt_component_get_output_port_at_index(component, index);
 124 end:
 125         return port;
 126 }
 127
 128 struct bt_port *bt_component_source_get_default_output_port(
 129                 struct bt_component *component)
 130 {
 131         return bt_component_source_get_output_port(component,
 132                         DEFAULT_OUTPUT_PORT_NAME);
 133 }
 134
 135 struct bt_private_port *bt_private_component_source_get_output_private_port(
 136                 struct bt_private_component *private_component,
 137                 const char *name)
 138 {
 139         return bt_private_port_from_port(bt_component_source_get_output_port(
 140                 bt_component_from_private(private_component), name));
 141 }
 142
 143 struct bt_private_port *
 144 bt_private_component_source_get_output_private_port_at_index(
 145                 struct bt_private_component *private_component, int index)
 146 {
 147         return bt_private_port_from_port(
 148                 bt_component_source_get_output_port_at_index(
 149                         bt_component_from_private(private_component), index));
 150 }
 151
 152 struct bt_private_port *bt_private_component_source_get_default_output_private_port(
 153                 struct bt_private_component *private_component)
 154 {
 155         return bt_private_port_from_port(
 156                 bt_component_source_get_default_output_port(
 157                         bt_component_from_private(private_component)));
 158 }
 159
 160 struct bt_private_port *bt_private_component_source_add_output_private_port(
 161                 struct bt_private_component *private_component,
 162                 const char *name)
 163 {
 164         struct bt_port *port = NULL;
 165         struct bt_component *component =
 166                 bt_component_from_private(private_component);
 167
 168         if (!component ||
 169                         component->class->type != BT_COMPONENT_CLASS_TYPE_SOURCE) {
 170                 goto end;
 171         }
 172
 173         port = bt_component_add_output_port(component, name);
 174 end:
 175         return bt_private_port_from_port(port);
 176 }