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