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.h>
  31 #include <babeltrace2/graph/component.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         BT_ASSERT_PRE_NO_ERROR();
  52
  53         source = g_new0(struct bt_component_source, 1);
  54         if (!source) {
  55                 BT_LIB_LOGE_APPEND_CAUSE(
  56                         "Failed to allocate one source component.");
  57                 goto end;
  58         }
  59
  60 end:
  61         return (void *) source;
  62 }
  63
  64 const bt_component_class_source *
  65 bt_component_source_borrow_class_const(
  66                 const bt_component_source *component)
  67 {
  68         struct bt_component_class *cls;
  69
  70         BT_ASSERT_PRE_DEV_NON_NULL(component, "Component");
  71
  72         cls = component->parent.class;
  73
  74         BT_ASSERT_DBG(cls);
  75         BT_ASSERT_DBG(cls->type == BT_COMPONENT_CLASS_TYPE_SOURCE);
  76
  77         return (bt_component_class_source *) cls;
  78 }
  79
  80 uint64_t bt_component_source_get_output_port_count(
  81                 const struct bt_component_source *comp)
  82 {
  83         return bt_component_get_output_port_count((void *) comp);
  84 }
  85
  86 const struct bt_port_output *
  87 bt_component_source_borrow_output_port_by_name_const(
  88                 const struct bt_component_source *comp, const char *name)
  89 {
  90         return bt_component_borrow_output_port_by_name((void *) comp, name);
  91 }
  92
  93 struct bt_self_component_port_output *
  94 bt_self_component_source_borrow_output_port_by_name(
  95                 struct bt_self_component_source *comp, const char *name)
  96 {
  97         return (void *) bt_component_borrow_output_port_by_name(
  98                 (void *) comp, name);
  99 }
 100
 101 const struct bt_port_output *
 102 bt_component_source_borrow_output_port_by_index_const(
 103                 const struct bt_component_source *comp, uint64_t index)
 104 {
 105         return bt_component_borrow_output_port_by_index((void *) comp, index);
 106 }
 107
 108 struct bt_self_component_port_output *
 109 bt_self_component_source_borrow_output_port_by_index(
 110                 struct bt_self_component_source *comp, uint64_t index)
 111 {
 112         return (void *) bt_component_borrow_output_port_by_index(
 113                 (void *) comp, index);
 114 }
 115
 116 enum bt_self_component_add_port_status bt_self_component_source_add_output_port(
 117                 struct bt_self_component_source *self_comp,
 118                 const char *name, void *user_data,
 119                 struct bt_self_component_port_output **self_port)
 120 {
 121         struct bt_component *comp = (void *) self_comp;
 122         enum bt_self_component_add_port_status status;
 123         struct bt_port *port = NULL;
 124
 125         BT_ASSERT_PRE_NO_ERROR();
 126
 127         /* bt_component_add_output_port() logs details and errors */
 128         status = bt_component_add_output_port(comp, name, user_data, &port);
 129         if (status != BT_FUNC_STATUS_OK) {
 130                 goto end;
 131         }
 132
 133         if (self_port) {
 134                 /* Move reference to user */
 135                 *self_port = (void *) port;
 136         }
 137
 138 end:
 139         bt_object_put_ref(port);
 140         return status;
 141 }
 142
 143 void bt_component_source_get_ref(
 144                 const struct bt_component_source *component_source)
 145 {
 146         bt_object_get_ref(component_source);
 147 }
 148
 149 void bt_component_source_put_ref(
 150                 const struct bt_component_source *component_source)
 151 {
 152         bt_object_put_ref(component_source);
 153 }