lib: add aliases for Babeltrace enumeration types
[babeltrace.git] / lib / graph / port.c
CommitLineData
8b285017 1/*
e2f7325d 2 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
8b285017 3 * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8b285017
JG
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
f3034355
PP
24#define BT_LOG_TAG "PORT"
25#include <babeltrace/lib-logging-internal.h>
26
c5b9b441
PP
27#include <babeltrace/assert-internal.h>
28#include <babeltrace/assert-pre-internal.h>
0d72b8c3
PP
29#include <babeltrace/graph/port-const.h>
30#include <babeltrace/graph/port-input-const.h>
31#include <babeltrace/graph/port-output-const.h>
d94d92ac
PP
32#include <babeltrace/graph/self-component-port.h>
33#include <babeltrace/graph/self-component-port-input.h>
34#include <babeltrace/graph/self-component-port-output.h>
b2e0c907
PP
35#include <babeltrace/graph/component-internal.h>
36#include <babeltrace/graph/port-internal.h>
37#include <babeltrace/graph/connection-internal.h>
8b285017 38#include <babeltrace/object-internal.h>
3d9990ac 39#include <babeltrace/compiler-internal.h>
8b285017
JG
40
41static
d94d92ac 42void destroy_port(struct bt_object *obj)
8b285017 43{
d94d92ac 44 struct bt_port *port = (void *) obj;
8b285017 45
d94d92ac 46 BT_LIB_LOGD("Destroying port: %!+p", port);
f3034355 47
8b285017
JG
48 if (port->name) {
49 g_string_free(port->name, TRUE);
d94d92ac 50 port->name = NULL;
8b285017 51 }
f3034355 52
8b285017
JG
53 g_free(port);
54}
55
56BT_HIDDEN
57struct bt_port *bt_port_create(struct bt_component *parent_component,
3e9b0023 58 enum bt_port_type type, const char *name, void *user_data)
8b285017 59{
72b913fb 60 struct bt_port *port = NULL;
8b285017 61
f6ccaed9
PP
62 BT_ASSERT(name);
63 BT_ASSERT(parent_component);
64 BT_ASSERT(type == BT_PORT_TYPE_INPUT || type == BT_PORT_TYPE_OUTPUT);
d94d92ac 65 BT_ASSERT(strlen(name) > 0);
8b285017
JG
66 port = g_new0(struct bt_port, 1);
67 if (!port) {
f3034355 68 BT_LOGE_STR("Failed to allocate one port.");
8b285017
JG
69 goto end;
70 }
71
d94d92ac
PP
72 BT_LIB_LOGD("Creating port for component: %![comp-]+c, port-type=%s, "
73 "port-name=\"%s\"", parent_component, bt_port_type_string(type),
74 name);
75 bt_object_init_shared_with_parent(&port->base, destroy_port);
8b285017
JG
76 port->name = g_string_new(name);
77 if (!port->name) {
f3034355 78 BT_LOGE_STR("Failed to allocate one GString.");
65300d60 79 BT_OBJECT_PUT_REF_AND_RESET(port);
8b285017
JG
80 goto end;
81 }
82
83 port->type = type;
3e9b0023 84 port->user_data = user_data;
3fea54f6 85 bt_object_set_parent(&port->base, &parent_component->base);
d94d92ac
PP
86 BT_LIB_LOGD("Created port for component: "
87 "%![comp-]+c, %![port-]+p", parent_component, port);
f3034355 88
8b285017
JG
89end:
90 return port;
91}
92
0d72b8c3 93const char *bt_port_get_name(const struct bt_port *port)
8b285017 94{
d94d92ac
PP
95 BT_ASSERT_PRE_NON_NULL(port, "Port");
96 return port->name->str;
8b285017
JG
97}
98
0d72b8c3 99enum bt_port_type bt_port_get_type(const struct bt_port *port)
8b285017 100{
d94d92ac
PP
101 BT_ASSERT_PRE_NON_NULL(port, "Port");
102 return port->type;
8b285017
JG
103}
104
0d72b8c3
PP
105const struct bt_connection *bt_port_borrow_connection_const(
106 const struct bt_port *port)
8b285017 107{
d94d92ac
PP
108 BT_ASSERT_PRE_NON_NULL(port, "Port");
109 return port->connection;
8b285017
JG
110}
111
0d72b8c3
PP
112const struct bt_component *bt_port_borrow_component_const(
113 const struct bt_port *port)
890882ef 114{
d94d92ac 115 BT_ASSERT_PRE_NON_NULL(port, "Port");
0d72b8c3 116 return bt_port_borrow_component_inline(port);
890882ef
PP
117}
118
d94d92ac
PP
119struct bt_self_component *bt_self_component_port_borrow_component(
120 struct bt_self_component_port *port)
890882ef 121{
d94d92ac
PP
122 BT_ASSERT_PRE_NON_NULL(port, "Port");
123 return (void *) bt_object_borrow_parent((void *) port);
890882ef
PP
124}
125
8b285017 126BT_HIDDEN
72b913fb 127void bt_port_set_connection(struct bt_port *port,
8b285017 128 struct bt_connection *connection)
72b913fb
PP
129{
130 /*
131 * Don't take a reference on connection as its existence is
132 * guaranteed by the existence of the graph in which the
133 * connection exists.
134 */
135 port->connection = connection;
d94d92ac
PP
136 BT_LIB_LOGV("Set port's connection: %![port-]+p, %![conn-]+x", port,
137 connection);
72b913fb
PP
138}
139
d94d92ac
PP
140enum bt_self_component_port_status bt_self_component_port_remove_from_component(
141 struct bt_self_component_port *self_port)
8b285017 142{
d94d92ac 143 struct bt_port *port = (void *) self_port;
72b913fb 144 struct bt_component *comp = NULL;
8b285017 145
d94d92ac 146 BT_ASSERT_PRE_NON_NULL(port, "Port");
8b285017 147
d94d92ac 148 comp = (void *) bt_object_borrow_parent(&port->base);
7d62a2ab 149 if (!comp) {
d94d92ac
PP
150 BT_LIB_LOGV("Port already removed from its component: %!+p",
151 port);
7d62a2ab
PP
152 goto end;
153 }
f3034355
PP
154
155 /* bt_component_remove_port() logs details */
d94d92ac 156 bt_component_remove_port(comp, port);
72b913fb 157
8b285017 158end:
d94d92ac 159 return BT_SELF_PORT_STATUS_OK;
8b285017
JG
160}
161
0d72b8c3 162bt_bool bt_port_is_connected(const struct bt_port *port)
8b285017 163{
d94d92ac
PP
164 BT_ASSERT_PRE_NON_NULL(port, "Port");
165 return port->connection ? BT_TRUE : BT_FALSE;
8b285017 166}
a45a0b60 167
0d72b8c3 168void *bt_self_component_port_get_data(const struct bt_self_component_port *port)
a45a0b60 169{
d94d92ac
PP
170 BT_ASSERT_PRE_NON_NULL(port, "Port");
171 return ((struct bt_port *) port)->user_data;
a45a0b60 172}
c5b9b441
PP
173
174void bt_port_get_ref(const struct bt_port *port)
175{
176 bt_object_get_ref(port);
177}
178
179void bt_port_put_ref(const struct bt_port *port)
180{
181 bt_object_put_ref(port);
182}
183
184void bt_port_input_get_ref(const struct bt_port_input *port_input)
185{
186 bt_object_get_ref(port_input);
187}
188
189void bt_port_input_put_ref(const struct bt_port_input *port_input)
190{
191 bt_object_put_ref(port_input);
192}
193
194void bt_port_output_get_ref(const struct bt_port_output *port_output)
195{
196 bt_object_get_ref(port_output);
197}
198
199void bt_port_output_put_ref(const struct bt_port_output *port_output)
200{
201 bt_object_put_ref(port_output);
202}
This page took 0.050187 seconds and 4 git commands to generate.