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