2 * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
4 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
25 #define BT_LOG_TAG "PORT"
26 #include <babeltrace/lib-logging-internal.h>
28 #include <babeltrace/graph/port-const.h>
29 #include <babeltrace/graph/port-input-const.h>
30 #include <babeltrace/graph/port-output-const.h>
31 #include <babeltrace/graph/self-component-port.h>
32 #include <babeltrace/graph/self-component-port-input.h>
33 #include <babeltrace/graph/self-component-port-output.h>
34 #include <babeltrace/graph/component-internal.h>
35 #include <babeltrace/graph/port-internal.h>
36 #include <babeltrace/graph/connection-internal.h>
37 #include <babeltrace/object-internal.h>
38 #include <babeltrace/object.h>
39 #include <babeltrace/compiler-internal.h>
40 #include <babeltrace/assert-internal.h>
41 #include <babeltrace/assert-pre-internal.h>
44 void destroy_port(struct bt_object
*obj
)
46 struct bt_port
*port
= (void *) obj
;
48 BT_LIB_LOGD("Destroying port: %!+p", port
);
51 g_string_free(port
->name
, TRUE
);
59 struct bt_port
*bt_port_create(struct bt_component
*parent_component
,
60 enum bt_port_type type
, const char *name
, void *user_data
)
62 struct bt_port
*port
= NULL
;
65 BT_ASSERT(parent_component
);
66 BT_ASSERT(type
== BT_PORT_TYPE_INPUT
|| type
== BT_PORT_TYPE_OUTPUT
);
67 BT_ASSERT(strlen(name
) > 0);
68 port
= g_new0(struct bt_port
, 1);
70 BT_LOGE_STR("Failed to allocate one port.");
74 BT_LIB_LOGD("Creating port for component: %![comp-]+c, port-type=%s, "
75 "port-name=\"%s\"", parent_component
, bt_port_type_string(type
),
77 bt_object_init_shared_with_parent(&port
->base
, destroy_port
);
78 port
->name
= g_string_new(name
);
80 BT_LOGE_STR("Failed to allocate one GString.");
81 BT_OBJECT_PUT_REF_AND_RESET(port
);
86 port
->user_data
= user_data
;
87 bt_object_set_parent(&port
->base
, &parent_component
->base
);
88 BT_LIB_LOGD("Created port for component: "
89 "%![comp-]+c, %![port-]+p", parent_component
, port
);
95 const char *bt_port_get_name(const struct bt_port
*port
)
97 BT_ASSERT_PRE_NON_NULL(port
, "Port");
98 return port
->name
->str
;
101 enum bt_port_type
bt_port_get_type(const struct bt_port
*port
)
103 BT_ASSERT_PRE_NON_NULL(port
, "Port");
107 const struct bt_connection
*bt_port_borrow_connection_const(
108 const struct bt_port
*port
)
110 BT_ASSERT_PRE_NON_NULL(port
, "Port");
111 return port
->connection
;
114 const struct bt_component
*bt_port_borrow_component_const(
115 const struct bt_port
*port
)
117 BT_ASSERT_PRE_NON_NULL(port
, "Port");
118 return bt_port_borrow_component_inline(port
);
121 struct bt_self_component
*bt_self_component_port_borrow_component(
122 struct bt_self_component_port
*port
)
124 BT_ASSERT_PRE_NON_NULL(port
, "Port");
125 return (void *) bt_object_borrow_parent((void *) port
);
129 void bt_port_set_connection(struct bt_port
*port
,
130 struct bt_connection
*connection
)
133 * Don't take a reference on connection as its existence is
134 * guaranteed by the existence of the graph in which the
137 port
->connection
= connection
;
138 BT_LIB_LOGV("Set port's connection: %![port-]+p, %![conn-]+x", port
,
142 enum bt_self_component_port_status
bt_self_component_port_remove_from_component(
143 struct bt_self_component_port
*self_port
)
145 struct bt_port
*port
= (void *) self_port
;
146 struct bt_component
*comp
= NULL
;
148 BT_ASSERT_PRE_NON_NULL(port
, "Port");
150 comp
= (void *) bt_object_borrow_parent(&port
->base
);
152 BT_LIB_LOGV("Port already removed from its component: %!+p",
157 /* bt_component_remove_port() logs details */
158 bt_component_remove_port(comp
, port
);
161 return BT_SELF_PORT_STATUS_OK
;
164 bt_bool
bt_port_is_connected(const struct bt_port
*port
)
166 BT_ASSERT_PRE_NON_NULL(port
, "Port");
167 return port
->connection
? BT_TRUE
: BT_FALSE
;
170 void *bt_self_component_port_get_data(const struct bt_self_component_port
*port
)
172 BT_ASSERT_PRE_NON_NULL(port
, "Port");
173 return ((struct bt_port
*) port
)->user_data
;