src/lib/graph/component-sink.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-SINK"
  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/value.h>
  31 #include <babeltrace2/graph/self-component-sink.h>
  32 #include <babeltrace2/graph/component-sink-const.h>
  33 #include <babeltrace2/graph/graph.h>
  34
  35 #include "component-sink.h"
  36 #include "component.h"
  37 #include "lib/func-status.h"
  38
  39 BT_HIDDEN
  40 void bt_component_sink_destroy(struct bt_component *component)
  41 {
  42 }
  43
  44 BT_HIDDEN
  45 struct bt_component *bt_component_sink_create(
  46                 const struct bt_component_class *class)
  47 {
  48         struct bt_component_sink *sink = NULL;
  49
  50         sink = g_new0(struct bt_component_sink, 1);
  51         if (!sink) {
  52                 BT_LIB_LOGE_APPEND_CAUSE(
  53                         "Failed to allocate one sink component.");
  54                 goto end;
  55         }
  56
  57 end:
  58         return (void *) sink;
  59 }
  60
  61 const bt_component_class_sink *
  62 bt_component_sink_borrow_class_const(
  63                 const bt_component_sink *component)
  64 {
  65         struct bt_component_class *cls;
  66
  67         BT_ASSERT_PRE_NON_NULL(component, "Component");
  68
  69         cls = component->parent.class;
  70
  71         BT_ASSERT(cls);
  72         BT_ASSERT(cls->type == BT_COMPONENT_CLASS_TYPE_SINK);
  73
  74         return (bt_component_class_sink *) cls;
  75 }
  76
  77 uint64_t bt_component_sink_get_input_port_count(
  78                 const struct bt_component_sink *component)
  79 {
  80         /* bt_component_get_input_port_count() logs details/errors */
  81         return bt_component_get_input_port_count((void *) component);
  82 }
  83
  84 const struct bt_port_input *
  85 bt_component_sink_borrow_input_port_by_name_const(
  86                 const struct bt_component_sink *component, const char *name)
  87 {
  88         /* bt_component_borrow_input_port_by_name() logs details/errors */
  89         return bt_component_borrow_input_port_by_name((void *) component, name);
  90 }
  91
  92 struct bt_self_component_port_input *
  93 bt_self_component_sink_borrow_input_port_by_name(
  94                 struct bt_self_component_sink *component, const char *name)
  95 {
  96         /* bt_component_borrow_input_port_by_name() logs details/errors */
  97         return (void *) bt_component_borrow_input_port_by_name(
  98                 (void *) component, name);
  99 }
 100
 101 const struct bt_port_input *bt_component_sink_borrow_input_port_by_index_const(
 102                 const struct bt_component_sink *component, uint64_t index)
 103 {
 104         /* bt_component_borrow_input_port_by_index() logs details/errors */
 105         return bt_component_borrow_input_port_by_index(
 106                 (void *) component, index);
 107 }
 108
 109 struct bt_self_component_port_input *
 110 bt_self_component_sink_borrow_input_port_by_index(
 111                 struct bt_self_component_sink *component, uint64_t index)
 112 {
 113         /* bt_component_borrow_input_port_by_index() logs details/errors */
 114         return (void *) bt_component_borrow_input_port_by_index(
 115                 (void *) component, index);
 116 }
 117
 118 enum bt_self_component_add_port_status bt_self_component_sink_add_input_port(
 119                 struct bt_self_component_sink *self_comp,
 120                 const char *name, void *user_data,
 121                 struct bt_self_component_port_input **self_port)
 122 {
 123         enum bt_self_component_add_port_status status;
 124         struct bt_port *port = NULL;
 125         struct bt_component *comp = (void *) self_comp;
 126
 127         /* bt_component_add_input_port() logs details/errors */
 128         status = bt_component_add_input_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                 port = NULL;
 137         }
 138
 139 end:
 140         bt_object_put_ref(port);
 141         return status;
 142 }
 143
 144 void bt_component_sink_get_ref(
 145                 const struct bt_component_sink *component_sink)
 146 {
 147         bt_object_get_ref(component_sink);
 148 }
 149
 150 void bt_component_sink_put_ref(
 151                 const struct bt_component_sink *component_sink)
 152 {
 153         bt_object_put_ref(component_sink);
 154 }