Commit | Line | Data |
---|---|---|
8b285017 | 1 | /* |
7d55361f | 2 | * port.c |
8b285017 JG |
3 | * |
4 | * Babeltrace Port | |
5 | * | |
6 | * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
7 | * | |
8 | * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
9 | * | |
10 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
11 | * of this software and associated documentation files (the "Software"), to deal | |
12 | * in the Software without restriction, including without limitation the rights | |
13 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
14 | * copies of the Software, and to permit persons to whom the Software is | |
15 | * furnished to do so, subject to the following conditions: | |
16 | * | |
17 | * The above copyright notice and this permission notice shall be included in | |
18 | * all copies or substantial portions of the Software. | |
19 | * | |
20 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
21 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
22 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
23 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
24 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
25 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
26 | * SOFTWARE. | |
27 | */ | |
28 | ||
f3034355 PP |
29 | #define BT_LOG_TAG "PORT" |
30 | #include <babeltrace/lib-logging-internal.h> | |
31 | ||
b65cfd0f | 32 | #include <babeltrace/graph/port.h> |
b2e0c907 PP |
33 | #include <babeltrace/graph/component-internal.h> |
34 | #include <babeltrace/graph/port-internal.h> | |
35 | #include <babeltrace/graph/connection-internal.h> | |
8b285017 | 36 | #include <babeltrace/object-internal.h> |
3d9990ac | 37 | #include <babeltrace/compiler-internal.h> |
8b285017 JG |
38 | |
39 | static | |
40 | void bt_port_destroy(struct bt_object *obj) | |
41 | { | |
42 | struct bt_port *port = container_of(obj, struct bt_port, base); | |
43 | ||
f3034355 PP |
44 | BT_LOGD("Destroying port: addr=%p, name=\"%s\", comp-addr=%p", |
45 | port, bt_port_get_name(port), obj->parent); | |
46 | ||
8b285017 JG |
47 | if (port->name) { |
48 | g_string_free(port->name, TRUE); | |
49 | } | |
f3034355 | 50 | |
8b285017 JG |
51 | g_free(port); |
52 | } | |
53 | ||
41765449 | 54 | struct bt_port *bt_port_from_private( |
890882ef PP |
55 | struct bt_private_port *private_port) |
56 | { | |
41765449 | 57 | return bt_get(bt_port_borrow_from_private(private_port)); |
890882ef PP |
58 | } |
59 | ||
8b285017 JG |
60 | BT_HIDDEN |
61 | struct bt_port *bt_port_create(struct bt_component *parent_component, | |
3e9b0023 | 62 | enum bt_port_type type, const char *name, void *user_data) |
8b285017 | 63 | { |
72b913fb | 64 | struct bt_port *port = NULL; |
8b285017 JG |
65 | |
66 | assert(name); | |
67 | assert(parent_component); | |
68 | assert(type == BT_PORT_TYPE_INPUT || type == BT_PORT_TYPE_OUTPUT); | |
69 | ||
72b913fb | 70 | if (strlen(name) == 0) { |
f3034355 | 71 | BT_LOGW_STR("Invalid parameter: name is an empty string."); |
8b285017 JG |
72 | goto end; |
73 | } | |
74 | ||
75 | port = g_new0(struct bt_port, 1); | |
76 | if (!port) { | |
f3034355 | 77 | BT_LOGE_STR("Failed to allocate one port."); |
8b285017 JG |
78 | goto end; |
79 | } | |
80 | ||
f3034355 PP |
81 | BT_LOGD("Creating port for component: " |
82 | "comp-addr=%p, comp-name=\"%s\", port-type=%s, " | |
83 | "port-name=\"%s\"", | |
84 | parent_component, bt_component_get_name(parent_component), | |
85 | bt_port_type_string(type), name); | |
86 | ||
8b285017 JG |
87 | bt_object_init(port, bt_port_destroy); |
88 | port->name = g_string_new(name); | |
89 | if (!port->name) { | |
f3034355 | 90 | BT_LOGE_STR("Failed to allocate one GString."); |
8b285017 JG |
91 | BT_PUT(port); |
92 | goto end; | |
93 | } | |
94 | ||
95 | port->type = type; | |
3e9b0023 | 96 | port->user_data = user_data; |
8b285017 | 97 | bt_object_set_parent(port, &parent_component->base); |
f3034355 PP |
98 | BT_LOGD("Created port for component: " |
99 | "comp-addr=%p, comp-name=\"%s\", port-type=%s, " | |
100 | "port-name=\"%s\", port-addr=%p", | |
101 | parent_component, bt_component_get_name(parent_component), | |
102 | bt_port_type_string(type), name, port); | |
103 | ||
8b285017 JG |
104 | end: |
105 | return port; | |
106 | } | |
107 | ||
108 | const char *bt_port_get_name(struct bt_port *port) | |
109 | { | |
110 | return port ? port->name->str : NULL; | |
111 | } | |
112 | ||
113 | enum bt_port_type bt_port_get_type(struct bt_port *port) | |
114 | { | |
115 | return port ? port->type : BT_PORT_TYPE_UNKOWN; | |
116 | } | |
117 | ||
72b913fb | 118 | struct bt_connection *bt_port_get_connection(struct bt_port *port) |
8b285017 | 119 | { |
72b913fb | 120 | struct bt_connection *connection = NULL; |
8b285017 | 121 | |
f3034355 PP |
122 | if (!port) { |
123 | BT_LOGW_STR("Invalid parameter: port is NULL."); | |
124 | goto end; | |
125 | } | |
126 | ||
127 | if (!port->connection) { | |
128 | /* Not an error: means disconnected */ | |
8b285017 JG |
129 | goto end; |
130 | } | |
131 | ||
72b913fb | 132 | connection = bt_get(port->connection); |
f3034355 | 133 | |
8b285017 JG |
134 | end: |
135 | return connection; | |
136 | } | |
137 | ||
138 | struct bt_component *bt_port_get_component(struct bt_port *port) | |
139 | { | |
140 | return (struct bt_component *) bt_object_get_parent(port); | |
141 | } | |
142 | ||
890882ef PP |
143 | struct bt_private_connection *bt_private_port_get_private_connection( |
144 | struct bt_private_port *private_port) | |
145 | { | |
146 | return bt_private_connection_from_connection(bt_port_get_connection( | |
41765449 | 147 | bt_port_borrow_from_private(private_port))); |
890882ef PP |
148 | } |
149 | ||
150 | struct bt_private_component *bt_private_port_get_private_component( | |
151 | struct bt_private_port *private_port) | |
152 | { | |
153 | return bt_private_component_from_component(bt_port_get_component( | |
41765449 | 154 | bt_port_borrow_from_private(private_port))); |
890882ef PP |
155 | } |
156 | ||
8b285017 | 157 | BT_HIDDEN |
72b913fb | 158 | void bt_port_set_connection(struct bt_port *port, |
8b285017 | 159 | struct bt_connection *connection) |
72b913fb PP |
160 | { |
161 | /* | |
162 | * Don't take a reference on connection as its existence is | |
163 | * guaranteed by the existence of the graph in which the | |
164 | * connection exists. | |
165 | */ | |
166 | port->connection = connection; | |
f3034355 PP |
167 | BT_LOGV("Set port's connection: " |
168 | "port-addr=%p, port-name=\"%s\", conn-addr=%p", | |
169 | port, bt_port_get_name(port), connection); | |
72b913fb PP |
170 | } |
171 | ||
a5fb1227 | 172 | enum bt_port_status bt_private_port_remove_from_component( |
890882ef | 173 | struct bt_private_port *private_port) |
8b285017 | 174 | { |
a5fb1227 | 175 | enum bt_port_status status = BT_PORT_STATUS_OK; |
41765449 | 176 | struct bt_port *port = bt_port_borrow_from_private(private_port); |
72b913fb | 177 | struct bt_component *comp = NULL; |
a5fb1227 | 178 | enum bt_component_status comp_status; |
8b285017 | 179 | |
72b913fb | 180 | if (!port) { |
f3034355 | 181 | BT_LOGW_STR("Invalid parameter: private port is NULL."); |
a5fb1227 | 182 | status = BT_PORT_STATUS_INVALID; |
8b285017 JG |
183 | goto end; |
184 | } | |
185 | ||
72b913fb | 186 | comp = (void *) bt_object_get_parent(port); |
a5fb1227 PP |
187 | if (!comp) { |
188 | BT_LOGV("Port already removed from its component: " | |
189 | "port-addr=%p, port-name=\"%s\", ", | |
190 | port, bt_port_get_name(port)); | |
191 | goto end; | |
192 | } | |
f3034355 PP |
193 | |
194 | /* bt_component_remove_port() logs details */ | |
a5fb1227 PP |
195 | comp_status = bt_component_remove_port(comp, port); |
196 | assert(comp_status != BT_COMPONENT_STATUS_INVALID); | |
197 | if (comp_status < 0) { | |
198 | status = BT_PORT_STATUS_ERROR; | |
199 | goto end; | |
200 | } | |
72b913fb | 201 | |
8b285017 | 202 | end: |
72b913fb | 203 | bt_put(comp); |
a5fb1227 | 204 | return status; |
8b285017 JG |
205 | } |
206 | ||
a5fb1227 | 207 | enum bt_port_status bt_port_disconnect(struct bt_port *port) |
8b285017 | 208 | { |
a5fb1227 | 209 | enum bt_port_status status = BT_PORT_STATUS_OK; |
8b285017 | 210 | |
72b913fb | 211 | if (!port) { |
f3034355 | 212 | BT_LOGW_STR("Invalid parameter: port is NULL."); |
a5fb1227 | 213 | status = BT_PORT_STATUS_INVALID; |
8b285017 JG |
214 | goto end; |
215 | } | |
216 | ||
72b913fb | 217 | if (port->connection) { |
c42ea0af | 218 | bt_connection_end(port->connection, true); |
f3034355 PP |
219 | BT_LOGV("Disconnected port: " |
220 | "port-addr=%p, port-name=\"%s\"", | |
221 | port, bt_port_get_name(port)); | |
72b913fb PP |
222 | } |
223 | ||
8b285017 | 224 | end: |
a5fb1227 | 225 | return status; |
8b285017 JG |
226 | } |
227 | ||
b65cfd0f | 228 | bt_bool bt_port_is_connected(struct bt_port *port) |
8b285017 | 229 | { |
72b913fb | 230 | int ret; |
8b285017 | 231 | |
72b913fb | 232 | if (!port) { |
f3034355 | 233 | BT_LOGW_STR("Invalid parameter: port is NULL."); |
72b913fb | 234 | ret = -1; |
8b285017 JG |
235 | goto end; |
236 | } | |
237 | ||
72b913fb PP |
238 | ret = port->connection ? 1 : 0; |
239 | ||
8b285017 | 240 | end: |
72b913fb | 241 | return ret; |
8b285017 | 242 | } |
a45a0b60 | 243 | |
a45a0b60 PP |
244 | void *bt_private_port_get_user_data( |
245 | struct bt_private_port *private_port) | |
246 | { | |
247 | return private_port ? | |
41765449 | 248 | bt_port_borrow_from_private(private_port)->user_data : NULL; |
a45a0b60 | 249 | } |