src/lib/graph/port.c

   1 /*
   2  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
   3  * Copyright 2017 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/PORT"
  25 #include "lib/logging.h"
  26
  27 #include "common/assert.h"
  28 #include "lib/assert-pre.h"
  29 #include <babeltrace2/graph/port.h>
  30 #include <babeltrace2/graph/self-component-port.h>
  31 #include "lib/object.h"
  32 #include "compat/compiler.h"
  33
  34 #include "component.h"
  35 #include "connection.h"
  36 #include "port.h"
  37
  38 static
  39 void destroy_port(struct bt_object *obj)
  40 {
  41         struct bt_port *port = (void *) obj;
  42
  43         BT_LIB_LOGI("Destroying port: %!+p", port);
  44
  45         if (port->name) {
  46                 g_string_free(port->name, TRUE);
  47                 port->name = NULL;
  48         }
  49
  50         g_free(port);
  51 }
  52
  53 BT_HIDDEN
  54 struct bt_port *bt_port_create(struct bt_component *parent_component,
  55                 enum bt_port_type type, const char *name, void *user_data)
  56 {
  57         struct bt_port *port = NULL;
  58
  59         BT_ASSERT(name);
  60         BT_ASSERT(parent_component);
  61         BT_ASSERT(type == BT_PORT_TYPE_INPUT || type == BT_PORT_TYPE_OUTPUT);
  62         BT_ASSERT(strlen(name) > 0);
  63         port = g_new0(struct bt_port, 1);
  64         if (!port) {
  65                 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one port.");
  66                 goto end;
  67         }
  68
  69         BT_LIB_LOGI("Creating port for component: %![comp-]+c, port-type=%s, "
  70                 "port-name=\"%s\"", parent_component, bt_port_type_string(type),
  71                 name);
  72         bt_object_init_shared_with_parent(&port->base, destroy_port);
  73         port->name = g_string_new(name);
  74         if (!port->name) {
  75                 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GString.");
  76                 BT_OBJECT_PUT_REF_AND_RESET(port);
  77                 goto end;
  78         }
  79
  80         port->type = type;
  81         port->user_data = user_data;
  82         bt_object_set_parent(&port->base, &parent_component->base);
  83         BT_LIB_LOGI("Created port for component: "
  84                 "%![comp-]+c, %![port-]+p", parent_component, port);
  85
  86 end:
  87         return port;
  88 }
  89
  90 const char *bt_port_get_name(const struct bt_port *port)
  91 {
  92         BT_ASSERT_PRE_DEV_NON_NULL(port, "Port");
  93         return port->name->str;
  94 }
  95
  96 enum bt_port_type bt_port_get_type(const struct bt_port *port)
  97 {
  98         BT_ASSERT_PRE_DEV_NON_NULL(port, "Port");
  99         return port->type;
 100 }
 101
 102 const struct bt_connection *bt_port_borrow_connection_const(
 103                 const struct bt_port *port)
 104 {
 105         BT_ASSERT_PRE_DEV_NON_NULL(port, "Port");
 106         return port->connection;
 107 }
 108
 109 const struct bt_component *bt_port_borrow_component_const(
 110                 const struct bt_port *port)
 111 {
 112         BT_ASSERT_PRE_DEV_NON_NULL(port, "Port");
 113         return bt_port_borrow_component_inline(port);
 114 }
 115
 116 struct bt_self_component *bt_self_component_port_borrow_component(
 117                 struct bt_self_component_port *port)
 118 {
 119         BT_ASSERT_PRE_DEV_NON_NULL(port, "Port");
 120         return (void *) bt_object_borrow_parent((void *) port);
 121 }
 122
 123 BT_HIDDEN
 124 void bt_port_set_connection(struct bt_port *port,
 125                 struct bt_connection *connection)
 126 {
 127         /*
 128          * Don't take a reference on connection as its existence is
 129          * guaranteed by the existence of the graph in which the
 130          * connection exists.
 131          */
 132         port->connection = connection;
 133         BT_LIB_LOGI("Set port's connection: %![port-]+p, %![conn-]+x", port,
 134                 connection);
 135 }
 136
 137 bt_bool bt_port_is_connected(const struct bt_port *port)
 138 {
 139         BT_ASSERT_PRE_DEV_NON_NULL(port, "Port");
 140         return port->connection ? BT_TRUE : BT_FALSE;
 141 }
 142
 143 void *bt_self_component_port_get_data(const struct bt_self_component_port *port)
 144 {
 145         BT_ASSERT_PRE_DEV_NON_NULL(port, "Port");
 146         return ((struct bt_port *) port)->user_data;
 147 }
 148
 149 void bt_port_get_ref(const struct bt_port *port)
 150 {
 151         bt_object_get_ref(port);
 152 }
 153
 154 void bt_port_put_ref(const struct bt_port *port)
 155 {
 156         bt_object_put_ref(port);
 157 }
 158
 159 void bt_port_input_get_ref(const struct bt_port_input *port_input)
 160 {
 161         bt_object_get_ref(port_input);
 162 }
 163
 164 void bt_port_input_put_ref(const struct bt_port_input *port_input)
 165 {
 166         bt_object_put_ref(port_input);
 167 }
 168
 169 void bt_port_output_get_ref(const struct bt_port_output *port_output)
 170 {
 171         bt_object_get_ref(port_output);
 172 }
 173
 174 void bt_port_output_put_ref(const struct bt_port_output *port_output)
 175 {
 176         bt_object_put_ref(port_output);
 177 }