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