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 #define BT_LOG_TAG "COMP-SOURCE"
  30 #include <babeltrace/lib-logging-internal.h>
  31
  32 #include <babeltrace/ref.h>
  33 #include <babeltrace/compiler-internal.h>
  34 #include <babeltrace/graph/component-source-internal.h>
  35 #include <babeltrace/graph/component-internal.h>
  36 #include <babeltrace/graph/port-internal.h>
  37 #include <babeltrace/graph/notification-iterator.h>
  38 #include <babeltrace/graph/notification-iterator-internal.h>
  39
  40 BT_HIDDEN
  41 void bt_component_source_destroy(struct bt_component *component)
  42 {
  43 }
  44
  45 BT_HIDDEN
  46 struct bt_component *bt_component_source_create(
  47                 struct bt_component_class *class, struct bt_value *params)
  48 {
  49         struct bt_component_source *source = NULL;
  50
  51         source = g_new0(struct bt_component_source, 1);
  52         if (!source) {
  53                 BT_LOGE_STR("Failed to allocate one source component.");
  54                 goto end;
  55         }
  56
  57 end:
  58         return source ? &source->parent : NULL;
  59 }
  60
  61 int64_t bt_component_source_get_output_port_count(
  62                 struct bt_component *component)
  63 {
  64         int64_t ret;
  65
  66         if (!component) {
  67                 BT_LOGW_STR("Invalid parameter: component is NULL.");
  68                 ret = (int64_t) -1;
  69                 goto end;
  70         }
  71
  72         if (component->class->type != BT_COMPONENT_CLASS_TYPE_SOURCE) {
  73                 BT_LOGW("Invalid parameter: component's class is not a source component class: "
  74                         "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
  75                         component, bt_component_get_name(component),
  76                         bt_component_class_type_string(component->class->type));
  77                 ret = (int64_t) -1;
  78                 goto end;
  79         }
  80
  81         /* bt_component_get_output_port_count() logs details/errors */
  82         ret = bt_component_get_output_port_count(component);
  83
  84 end:
  85         return ret;
  86 }
  87
  88 struct bt_port *bt_component_source_get_output_port_by_name(
  89                 struct bt_component *component, const char *name)
  90 {
  91         struct bt_port *port = NULL;
  92
  93         if (!component) {
  94                 BT_LOGW_STR("Invalid parameter: component is NULL.");
  95                 goto end;
  96         }
  97
  98         if (!name) {
  99                 BT_LOGW_STR("Invalid parameter: name is NULL.");
 100                 goto end;
 101         }
 102
 103         if (component->class->type != BT_COMPONENT_CLASS_TYPE_SOURCE) {
 104                 BT_LOGW("Invalid parameter: component's class is not a source component class: "
 105                         "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
 106                         component, bt_component_get_name(component),
 107                         bt_component_class_type_string(component->class->type));
 108                 goto end;
 109         }
 110
 111         /* bt_component_get_output_port_by_name() logs details/errors */
 112         port = bt_component_get_output_port_by_name(component, name);
 113
 114 end:
 115         return port;
 116 }
 117
 118 struct bt_port *bt_component_source_get_output_port_by_index(
 119                 struct bt_component *component, uint64_t index)
 120 {
 121         struct bt_port *port = NULL;
 122
 123         if (!component) {
 124                 BT_LOGW_STR("Invalid parameter: component is NULL.");
 125                 goto end;
 126         }
 127
 128         if (component->class->type != BT_COMPONENT_CLASS_TYPE_SOURCE) {
 129                 BT_LOGW("Invalid parameter: component's class is not a source component class: "
 130                         "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
 131                         component, bt_component_get_name(component),
 132                         bt_component_class_type_string(component->class->type));
 133                 goto end;
 134         }
 135
 136         /* bt_component_get_output_port_by_index() logs details/errors */
 137         port = bt_component_get_output_port_by_index(component, index);
 138
 139 end:
 140         return port;
 141 }
 142
 143 struct bt_private_port *
 144 bt_private_component_source_get_output_private_port_by_name(
 145                 struct bt_private_component *private_component,
 146                 const char *name)
 147 {
 148         /* bt_component_source_get_output_port_by_name() logs details/errors */
 149         return bt_private_port_from_port(
 150                 bt_component_source_get_output_port_by_name(
 151                         bt_component_from_private(private_component), name));
 152 }
 153
 154 struct bt_private_port *
 155 bt_private_component_source_get_output_private_port_by_index(
 156                 struct bt_private_component *private_component, uint64_t index)
 157 {
 158         /* bt_component_source_get_output_port_by_index() logs details/errors */
 159         return bt_private_port_from_port(
 160                 bt_component_source_get_output_port_by_index(
 161                         bt_component_from_private(private_component), index));
 162 }
 163
 164 enum bt_component_status bt_private_component_source_add_output_private_port(
 165                 struct bt_private_component *private_component,
 166                 const char *name, void *user_data,
 167                 struct bt_private_port **user_priv_port)
 168 {
 169         enum bt_component_status status = BT_COMPONENT_STATUS_OK;
 170         struct bt_port *port = NULL;
 171         struct bt_component *component =
 172                 bt_component_from_private(private_component);
 173
 174         if (!component) {
 175                 BT_LOGW_STR("Invalid parameter: component is NULL.");
 176                 status = BT_COMPONENT_STATUS_INVALID;
 177                 goto end;
 178         }
 179
 180         if (component->class->type != BT_COMPONENT_CLASS_TYPE_SOURCE) {
 181                 BT_LOGW("Invalid parameter: component's class is not a source component class: "
 182                         "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
 183                         component, bt_component_get_name(component),
 184                         bt_component_class_type_string(component->class->type));
 185                 status = BT_COMPONENT_STATUS_INVALID;
 186                 goto end;
 187         }
 188
 189         /* bt_component_add_output_port() logs details and errors */
 190         port = bt_component_add_output_port(component, name, user_data);
 191         if (!port) {
 192                 status = BT_COMPONENT_STATUS_NOMEM;
 193                 goto end;
 194         }
 195
 196         if (user_priv_port) {
 197                 /* Move reference to user */
 198                 *user_priv_port = bt_private_port_from_port(port);
 199                 port = NULL;
 200         }
 201
 202 end:
 203         bt_put(port);
 204         return status;
 205 }