src/lib/graph/component-source.c

   1 /*
   2  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
   3  * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy
   6  * of this software and associated documentation files (the "Software"), to deal
   7  * in the Software without restriction, including without limitation the rights
   8  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   9  * copies of the Software, and to permit persons to whom the Software is
  10  * furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in
  13  * all copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  21  * SOFTWARE.
  22  */
  23
  24 #define BT_LOG_TAG "LIB/COMPONENT-SOURCE"
  25 #include "lib/logging.h"
  26
  27 #include "common/assert.h"
  28 #include "lib/assert-pre.h"
  29 #include "compat/compiler.h"
  30 #include <babeltrace2/graph/self-component-source.h>
  31 #include <babeltrace2/graph/component-source-const.h>
  32 #include <babeltrace2/graph/graph.h>
  33
  34 #include "component-source.h"
  35 #include "component.h"
  36 #include "port.h"
  37 #include "message/iterator.h"
  38 #include "lib/func-status.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                 const struct bt_component_class *class)
  48 {
  49         struct bt_component_source *source = NULL;
  50
  51         source = g_new0(struct bt_component_source, 1);
  52         if (!source) {
  53                 BT_LIB_LOGE_APPEND_CAUSE(
  54                         "Failed to allocate one source component.");
  55                 goto end;
  56         }
  57
  58 end:
  59         return (void *) source;
  60 }
  61
  62 const bt_component_class_source *
  63 bt_component_source_borrow_class_const(
  64                 const bt_component_source *component)
  65 {
  66         struct bt_component_class *cls;
  67
  68         BT_ASSERT_PRE_DEV_NON_NULL(component, "Component");
  69
  70         cls = component->parent.class;
  71
  72         BT_ASSERT_DBG(cls);
  73         BT_ASSERT_DBG(cls->type == BT_COMPONENT_CLASS_TYPE_SOURCE);
  74
  75         return (bt_component_class_source *) cls;
  76 }
  77
  78 uint64_t bt_component_source_get_output_port_count(
  79                 const struct bt_component_source *comp)
  80 {
  81         return bt_component_get_output_port_count((void *) comp);
  82 }
  83
  84 const struct bt_port_output *
  85 bt_component_source_borrow_output_port_by_name_const(
  86                 const struct bt_component_source *comp, const char *name)
  87 {
  88         return bt_component_borrow_output_port_by_name((void *) comp, name);
  89 }
  90
  91 struct bt_self_component_port_output *
  92 bt_self_component_source_borrow_output_port_by_name(
  93                 struct bt_self_component_source *comp, const char *name)
  94 {
  95         return (void *) bt_component_borrow_output_port_by_name(
  96                 (void *) comp, name);
  97 }
  98
  99 const struct bt_port_output *
 100 bt_component_source_borrow_output_port_by_index_const(
 101                 const struct bt_component_source *comp, uint64_t index)
 102 {
 103         return bt_component_borrow_output_port_by_index((void *) comp, index);
 104 }
 105
 106 struct bt_self_component_port_output *
 107 bt_self_component_source_borrow_output_port_by_index(
 108                 struct bt_self_component_source *comp, uint64_t index)
 109 {
 110         return (void *) bt_component_borrow_output_port_by_index(
 111                 (void *) comp, index);
 112 }
 113
 114 enum bt_self_component_add_port_status bt_self_component_source_add_output_port(
 115                 struct bt_self_component_source *self_comp,
 116                 const char *name, void *user_data,
 117                 struct bt_self_component_port_output **self_port)
 118 {
 119         struct bt_component *comp = (void *) self_comp;
 120         enum bt_self_component_add_port_status status;
 121         struct bt_port *port = NULL;
 122
 123         /* bt_component_add_output_port() logs details and errors */
 124         status = bt_component_add_output_port(comp, name, user_data, &port);
 125         if (status != BT_FUNC_STATUS_OK) {
 126                 goto end;
 127         }
 128
 129         if (self_port) {
 130                 /* Move reference to user */
 131                 *self_port = (void *) port;
 132                 port = NULL;
 133         }
 134
 135 end:
 136         bt_object_put_ref(port);
 137         return status;
 138 }
 139
 140 void bt_component_source_get_ref(
 141                 const struct bt_component_source *component_source)
 142 {
 143         bt_object_get_ref(component_source);
 144 }
 145
 146 void bt_component_source_put_ref(
 147                 const struct bt_component_source *component_source)
 148 {
 149         bt_object_put_ref(component_source);
 150 }