Commit | Line | Data |
---|---|---|
de713ce0 JG |
1 | /* |
2 | * component.c | |
3 | * | |
4 | * Babeltrace Plugin Component | |
5 | * | |
6 | * Copyright 2015 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 | ||
ab0d387b PP |
29 | #define BT_LOG_TAG "COMP" |
30 | #include <babeltrace/lib-logging-internal.h> | |
31 | ||
b2e0c907 PP |
32 | #include <babeltrace/graph/private-component.h> |
33 | #include <babeltrace/graph/component.h> | |
34 | #include <babeltrace/graph/component-internal.h> | |
35 | #include <babeltrace/graph/component-class-internal.h> | |
36 | #include <babeltrace/graph/component-source-internal.h> | |
37 | #include <babeltrace/graph/component-filter-internal.h> | |
38 | #include <babeltrace/graph/component-sink-internal.h> | |
39 | #include <babeltrace/graph/private-connection.h> | |
40 | #include <babeltrace/graph/connection-internal.h> | |
41 | #include <babeltrace/graph/graph-internal.h> | |
42 | #include <babeltrace/graph/notification-iterator-internal.h> | |
90157d89 | 43 | #include <babeltrace/graph/private-connection-private-notification-iterator.h> |
de713ce0 | 44 | #include <babeltrace/babeltrace-internal.h> |
3d9990ac | 45 | #include <babeltrace/compiler-internal.h> |
b8a06801 | 46 | #include <babeltrace/ref.h> |
c55a9f58 | 47 | #include <babeltrace/types.h> |
ab0d387b PP |
48 | #include <babeltrace/values.h> |
49 | #include <babeltrace/values-internal.h> | |
f6ccaed9 | 50 | #include <babeltrace/assert-internal.h> |
9ac68eb1 | 51 | #include <stdint.h> |
ab0d387b | 52 | #include <inttypes.h> |
de713ce0 | 53 | |
7c7c0433 JG |
54 | static |
55 | struct bt_component * (* const component_create_funcs[])( | |
36712f1d | 56 | struct bt_component_class *) = { |
d3e4dcd8 PP |
57 | [BT_COMPONENT_CLASS_TYPE_SOURCE] = bt_component_source_create, |
58 | [BT_COMPONENT_CLASS_TYPE_SINK] = bt_component_sink_create, | |
59 | [BT_COMPONENT_CLASS_TYPE_FILTER] = bt_component_filter_create, | |
7c7c0433 JG |
60 | }; |
61 | ||
72b913fb PP |
62 | static |
63 | void (*component_destroy_funcs[])(struct bt_component *) = { | |
64 | [BT_COMPONENT_CLASS_TYPE_SOURCE] = bt_component_source_destroy, | |
65 | [BT_COMPONENT_CLASS_TYPE_SINK] = bt_component_sink_destroy, | |
66 | [BT_COMPONENT_CLASS_TYPE_FILTER] = bt_component_filter_destroy, | |
67 | }; | |
68 | ||
b8a06801 JG |
69 | static |
70 | void bt_component_destroy(struct bt_object *obj) | |
71 | { | |
72 | struct bt_component *component = NULL; | |
73 | struct bt_component_class *component_class = NULL; | |
3230ee6b | 74 | int i; |
b8a06801 JG |
75 | |
76 | if (!obj) { | |
77 | return; | |
78 | } | |
79 | ||
bd14d768 PP |
80 | /* |
81 | * The component's reference count is 0 if we're here. Increment | |
82 | * it to avoid a double-destroy (possibly infinitely recursive). | |
83 | * This could happen for example if the component's finalization | |
84 | * function does bt_get() (or anything that causes bt_get() to | |
85 | * be called) on itself (ref. count goes from 0 to 1), and then | |
86 | * bt_put(): the reference count would go from 1 to 0 again and | |
87 | * this function would be called again. | |
88 | */ | |
89 | obj->ref_count.count++; | |
b8a06801 | 90 | component = container_of(obj, struct bt_component, base); |
ab0d387b PP |
91 | BT_LOGD("Destroying component: addr=%p, name=\"%s\", graph-addr=%p", |
92 | component, bt_component_get_name(component), | |
93 | obj->parent); | |
3230ee6b PP |
94 | |
95 | /* Call destroy listeners in reverse registration order */ | |
ab0d387b PP |
96 | BT_LOGD_STR("Calling destroy listeners."); |
97 | ||
3230ee6b PP |
98 | for (i = component->destroy_listeners->len - 1; i >= 0; i--) { |
99 | struct bt_component_destroy_listener *listener = | |
100 | &g_array_index(component->destroy_listeners, | |
101 | struct bt_component_destroy_listener, i); | |
102 | ||
103 | listener->func(component, listener->data); | |
104 | } | |
105 | ||
7c7c0433 JG |
106 | component_class = component->class; |
107 | ||
108 | /* | |
36712f1d PP |
109 | * User data is destroyed first, followed by the concrete |
110 | * component instance. Do not finalize if the component's user | |
111 | * initialization method failed in the first place. | |
b8a06801 | 112 | */ |
36712f1d | 113 | if (component->initialized && component->class->methods.finalize) { |
ab0d387b | 114 | BT_LOGD_STR("Calling user's finalization method."); |
64cadc66 | 115 | component->class->methods.finalize( |
890882ef | 116 | bt_private_component_from_component(component)); |
7c7c0433 | 117 | } |
b8a06801 | 118 | |
ab09f844 | 119 | if (component->destroy) { |
ab0d387b | 120 | BT_LOGD_STR("Destroying type-specific data."); |
ab09f844 JG |
121 | component->destroy(component); |
122 | } | |
123 | ||
72b913fb | 124 | if (component->input_ports) { |
ab0d387b | 125 | BT_LOGD_STR("Destroying input ports."); |
72b913fb PP |
126 | g_ptr_array_free(component->input_ports, TRUE); |
127 | } | |
b8a06801 | 128 | |
72b913fb | 129 | if (component->output_ports) { |
ab0d387b | 130 | BT_LOGD_STR("Destroying output ports."); |
72b913fb | 131 | g_ptr_array_free(component->output_ports, TRUE); |
b8a06801 JG |
132 | } |
133 | ||
3230ee6b PP |
134 | if (component->destroy_listeners) { |
135 | g_array_free(component->destroy_listeners, TRUE); | |
136 | } | |
137 | ||
ab0d387b PP |
138 | if (component->name) { |
139 | g_string_free(component->name, TRUE); | |
140 | } | |
141 | ||
142 | BT_LOGD("Putting component class."); | |
72b913fb PP |
143 | bt_put(component_class); |
144 | g_free(component); | |
b8a06801 | 145 | } |
de713ce0 | 146 | |
6d137876 | 147 | struct bt_component *bt_component_from_private( |
890882ef | 148 | struct bt_private_component *private_component) |
38b48196 | 149 | { |
6d137876 | 150 | return bt_get(bt_component_borrow_from_private(private_component)); |
38b48196 JG |
151 | } |
152 | ||
890882ef PP |
153 | enum bt_component_class_type bt_component_get_class_type( |
154 | struct bt_component *component) | |
5645cd95 | 155 | { |
890882ef | 156 | return component ? component->class->type : BT_COMPONENT_CLASS_TYPE_UNKNOWN; |
5645cd95 JG |
157 | } |
158 | ||
72b913fb PP |
159 | static |
160 | struct bt_port *bt_component_add_port( | |
161 | struct bt_component *component, GPtrArray *ports, | |
3e9b0023 | 162 | enum bt_port_type port_type, const char *name, void *user_data) |
72b913fb PP |
163 | { |
164 | size_t i; | |
165 | struct bt_port *new_port = NULL; | |
1bf957a0 | 166 | struct bt_graph *graph = NULL; |
72b913fb | 167 | |
ab0d387b PP |
168 | if (!name) { |
169 | BT_LOGW_STR("Invalid parameter: name is NULL."); | |
72b913fb PP |
170 | goto end; |
171 | } | |
172 | ||
ab0d387b PP |
173 | if (strlen(name) == 0) { |
174 | BT_LOGW_STR("Invalid parameter: name is an empty string."); | |
175 | goto end; | |
176 | } | |
177 | ||
178 | BT_LOGD("Adding port to component: comp-addr=%p, comp-name=\"%s\", " | |
179 | "port-type=%s, port-name=\"%s\"", component, | |
180 | bt_component_get_name(component), | |
181 | bt_port_type_string(port_type), name); | |
182 | ||
72b913fb PP |
183 | /* Look for a port having the same name. */ |
184 | for (i = 0; i < ports->len; i++) { | |
185 | const char *port_name; | |
ab0d387b | 186 | struct bt_port *port = g_ptr_array_index(ports, i); |
72b913fb PP |
187 | |
188 | port_name = bt_port_get_name(port); | |
f6ccaed9 | 189 | BT_ASSERT(port_name); |
72b913fb PP |
190 | |
191 | if (!strcmp(name, port_name)) { | |
192 | /* Port name clash, abort. */ | |
ab0d387b PP |
193 | BT_LOGW("Invalid parameter: another port with the same name already exists in the component: " |
194 | "other-port-addr=%p", port); | |
72b913fb PP |
195 | goto end; |
196 | } | |
197 | } | |
198 | ||
3e9b0023 | 199 | new_port = bt_port_create(component, port_type, name, user_data); |
72b913fb | 200 | if (!new_port) { |
ab0d387b | 201 | BT_LOGE("Cannot create port object."); |
72b913fb PP |
202 | goto end; |
203 | } | |
204 | ||
205 | /* | |
206 | * No name clash, add the port. | |
207 | * The component is now the port's parent; it should _not_ | |
208 | * hold a reference to the port since the port's lifetime | |
209 | * is now protected by the component's own lifetime. | |
210 | */ | |
211 | g_ptr_array_add(ports, new_port); | |
1bf957a0 PP |
212 | |
213 | /* | |
214 | * Notify the graph's creator that a new port was added. | |
215 | */ | |
216 | graph = bt_component_get_graph(component); | |
217 | if (graph) { | |
218 | bt_graph_notify_port_added(graph, new_port); | |
219 | BT_PUT(graph); | |
220 | } | |
221 | ||
ab0d387b PP |
222 | BT_LOGD("Created and added port to component: comp-addr=%p, comp-name=\"%s\", " |
223 | "port-type=%s, port-name=\"%s\", port-addr=%p", component, | |
224 | bt_component_get_name(component), | |
225 | bt_port_type_string(port_type), name, new_port); | |
226 | ||
72b913fb PP |
227 | end: |
228 | return new_port; | |
229 | } | |
230 | ||
231 | BT_HIDDEN | |
544d0515 | 232 | int64_t bt_component_get_input_port_count(struct bt_component *comp) |
72b913fb | 233 | { |
f6ccaed9 | 234 | BT_ASSERT(comp); |
9ac68eb1 | 235 | return (int64_t) comp->input_ports->len; |
72b913fb PP |
236 | } |
237 | ||
238 | BT_HIDDEN | |
544d0515 | 239 | int64_t bt_component_get_output_port_count(struct bt_component *comp) |
72b913fb | 240 | { |
f6ccaed9 | 241 | BT_ASSERT(comp); |
9ac68eb1 | 242 | return (int64_t) comp->output_ports->len; |
72b913fb PP |
243 | } |
244 | ||
dd8a4547 | 245 | BT_HIDDEN |
36712f1d PP |
246 | enum bt_component_status bt_component_create( |
247 | struct bt_component_class *component_class, | |
248 | const char *name, struct bt_component **user_component) | |
38b48196 | 249 | { |
36712f1d | 250 | enum bt_component_status status = BT_COMPONENT_STATUS_OK; |
38b48196 | 251 | struct bt_component *component = NULL; |
d3e4dcd8 | 252 | enum bt_component_class_type type; |
38b48196 | 253 | |
f6ccaed9 PP |
254 | BT_ASSERT(user_component); |
255 | BT_ASSERT(component_class); | |
256 | BT_ASSERT(name); | |
38b48196 | 257 | |
7c7c0433 | 258 | type = bt_component_class_get_type(component_class); |
36712f1d PP |
259 | BT_LOGD("Creating empty component from component class: " |
260 | "comp-cls-addr=%p, comp-cls-type=%s, name=\"%s\"", | |
261 | component_class, bt_component_class_type_string(type), name); | |
262 | component = component_create_funcs[type](component_class); | |
7c7c0433 | 263 | if (!component) { |
ab0d387b | 264 | BT_LOGE_STR("Cannot create specific component object."); |
36712f1d | 265 | status = BT_COMPONENT_STATUS_NOMEM; |
7c7c0433 JG |
266 | goto end; |
267 | } | |
268 | ||
269 | bt_object_init(component, bt_component_destroy); | |
72b913fb PP |
270 | component->class = bt_get(component_class); |
271 | component->destroy = component_destroy_funcs[type]; | |
7c7c0433 | 272 | component->name = g_string_new(name); |
4b70dd83 | 273 | if (!component->name) { |
ab0d387b | 274 | BT_LOGE_STR("Failed to allocate one GString."); |
36712f1d | 275 | status = BT_COMPONENT_STATUS_NOMEM; |
7c7c0433 JG |
276 | goto end; |
277 | } | |
278 | ||
72b913fb PP |
279 | component->input_ports = g_ptr_array_new_with_free_func( |
280 | bt_object_release); | |
281 | if (!component->input_ports) { | |
ab0d387b | 282 | BT_LOGE_STR("Failed to allocate one GPtrArray."); |
36712f1d | 283 | status = BT_COMPONENT_STATUS_NOMEM; |
72b913fb PP |
284 | goto end; |
285 | } | |
286 | ||
287 | component->output_ports = g_ptr_array_new_with_free_func( | |
288 | bt_object_release); | |
289 | if (!component->output_ports) { | |
ab0d387b | 290 | BT_LOGE_STR("Failed to allocate one GPtrArray."); |
36712f1d | 291 | status = BT_COMPONENT_STATUS_NOMEM; |
72b913fb PP |
292 | goto end; |
293 | } | |
294 | ||
3230ee6b PP |
295 | component->destroy_listeners = g_array_new(FALSE, TRUE, |
296 | sizeof(struct bt_component_destroy_listener)); | |
297 | if (!component->destroy_listeners) { | |
ab0d387b | 298 | BT_LOGE_STR("Failed to allocate one GArray."); |
36712f1d | 299 | status = BT_COMPONENT_STATUS_NOMEM; |
3230ee6b PP |
300 | goto end; |
301 | } | |
302 | ||
36712f1d PP |
303 | BT_LOGD("Created empty component from component class: " |
304 | "comp-cls-addr=%p, comp-cls-type=%s, name=\"%s\", comp-addr=%p", | |
305 | component_class, bt_component_class_type_string(type), name, | |
306 | component); | |
307 | BT_MOVE(*user_component, component); | |
ab0d387b | 308 | |
38b48196 | 309 | end: |
36712f1d PP |
310 | bt_put(component); |
311 | return status; | |
6358c163 PP |
312 | } |
313 | ||
de713ce0 JG |
314 | const char *bt_component_get_name(struct bt_component *component) |
315 | { | |
316 | const char *ret = NULL; | |
317 | ||
318 | if (!component) { | |
ab0d387b | 319 | BT_LOGW_STR("Invalid parameter: component is NULL."); |
de713ce0 JG |
320 | goto end; |
321 | } | |
322 | ||
f1222e7d | 323 | ret = component->name->len == 0 ? NULL : component->name->str; |
ab0d387b | 324 | |
de713ce0 JG |
325 | end: |
326 | return ret; | |
327 | } | |
328 | ||
38b48196 JG |
329 | struct bt_component_class *bt_component_get_class( |
330 | struct bt_component *component) | |
de713ce0 | 331 | { |
38b48196 | 332 | return component ? bt_get(component->class) : NULL; |
de713ce0 JG |
333 | } |
334 | ||
890882ef PP |
335 | void *bt_private_component_get_user_data( |
336 | struct bt_private_component *private_component) | |
de713ce0 | 337 | { |
890882ef | 338 | struct bt_component *component = |
6d137876 | 339 | bt_component_borrow_from_private(private_component); |
890882ef | 340 | |
38b48196 | 341 | return component ? component->user_data : NULL; |
de713ce0 JG |
342 | } |
343 | ||
890882ef PP |
344 | enum bt_component_status bt_private_component_set_user_data( |
345 | struct bt_private_component *private_component, | |
de713ce0 JG |
346 | void *data) |
347 | { | |
890882ef | 348 | struct bt_component *component = |
6d137876 | 349 | bt_component_borrow_from_private(private_component); |
de713ce0 JG |
350 | enum bt_component_status ret = BT_COMPONENT_STATUS_OK; |
351 | ||
ab0d387b PP |
352 | if (!component) { |
353 | BT_LOGW_STR("Invalid parameter: component is NULL."); | |
354 | ret = BT_COMPONENT_STATUS_INVALID; | |
355 | goto end; | |
356 | } | |
357 | ||
de713ce0 | 358 | component->user_data = data; |
ab0d387b PP |
359 | BT_LOGV("Set component's user data: " |
360 | "comp-addr=%p, comp-name=\"%s\", user-data-addr=%p", | |
361 | component, bt_component_get_name(component), data); | |
362 | ||
de713ce0 JG |
363 | end: |
364 | return ret; | |
365 | } | |
366e034f JG |
366 | |
367 | BT_HIDDEN | |
f60c8b34 | 368 | void bt_component_set_graph(struct bt_component *component, |
366e034f JG |
369 | struct bt_graph *graph) |
370 | { | |
36712f1d | 371 | bt_object_set_parent(component, graph ? &graph->base : NULL); |
366e034f JG |
372 | } |
373 | ||
374 | struct bt_graph *bt_component_get_graph( | |
375 | struct bt_component *component) | |
376 | { | |
377 | return (struct bt_graph *) bt_object_get_parent(&component->base); | |
378 | } | |
379 | ||
72b913fb | 380 | static |
9ac68eb1 PP |
381 | struct bt_port *bt_component_get_port_by_name(GPtrArray *ports, |
382 | const char *name) | |
366e034f JG |
383 | { |
384 | size_t i; | |
385 | struct bt_port *ret_port = NULL; | |
386 | ||
f6ccaed9 | 387 | BT_ASSERT(name); |
72b913fb | 388 | |
366e034f JG |
389 | for (i = 0; i < ports->len; i++) { |
390 | struct bt_port *port = g_ptr_array_index(ports, i); | |
391 | const char *port_name = bt_port_get_name(port); | |
392 | ||
393 | if (!port_name) { | |
394 | continue; | |
395 | } | |
396 | ||
397 | if (!strcmp(name, port_name)) { | |
398 | ret_port = bt_get(port); | |
399 | break; | |
400 | } | |
401 | } | |
402 | ||
403 | return ret_port; | |
404 | } | |
405 | ||
406 | BT_HIDDEN | |
9ac68eb1 | 407 | struct bt_port *bt_component_get_input_port_by_name(struct bt_component *comp, |
72b913fb PP |
408 | const char *name) |
409 | { | |
f6ccaed9 | 410 | BT_ASSERT(comp); |
72b913fb | 411 | |
9ac68eb1 | 412 | return bt_component_get_port_by_name(comp->input_ports, name); |
72b913fb PP |
413 | } |
414 | ||
415 | BT_HIDDEN | |
9ac68eb1 | 416 | struct bt_port *bt_component_get_output_port_by_name(struct bt_component *comp, |
72b913fb PP |
417 | const char *name) |
418 | { | |
f6ccaed9 | 419 | BT_ASSERT(comp); |
72b913fb | 420 | |
9ac68eb1 | 421 | return bt_component_get_port_by_name(comp->output_ports, name); |
72b913fb PP |
422 | } |
423 | ||
424 | static | |
9ac68eb1 | 425 | struct bt_port *bt_component_get_port_by_index(GPtrArray *ports, uint64_t index) |
366e034f JG |
426 | { |
427 | struct bt_port *port = NULL; | |
428 | ||
9ac68eb1 | 429 | if (index >= ports->len) { |
ab0d387b PP |
430 | BT_LOGW("Invalid parameter: index is out of bounds: " |
431 | "index=%" PRIu64 ", count=%u", | |
432 | index, ports->len); | |
366e034f JG |
433 | goto end; |
434 | } | |
435 | ||
436 | port = bt_get(g_ptr_array_index(ports, index)); | |
437 | end: | |
438 | return port; | |
439 | } | |
440 | ||
441 | BT_HIDDEN | |
9ac68eb1 PP |
442 | struct bt_port *bt_component_get_input_port_by_index(struct bt_component *comp, |
443 | uint64_t index) | |
366e034f | 444 | { |
f6ccaed9 | 445 | BT_ASSERT(comp); |
366e034f | 446 | |
9ac68eb1 | 447 | return bt_component_get_port_by_index(comp->input_ports, index); |
72b913fb | 448 | } |
366e034f | 449 | |
72b913fb | 450 | BT_HIDDEN |
9ac68eb1 PP |
451 | struct bt_port *bt_component_get_output_port_by_index(struct bt_component *comp, |
452 | uint64_t index) | |
72b913fb | 453 | { |
f6ccaed9 | 454 | BT_ASSERT(comp); |
366e034f | 455 | |
9ac68eb1 | 456 | return bt_component_get_port_by_index(comp->output_ports, index); |
72b913fb | 457 | } |
366e034f | 458 | |
72b913fb PP |
459 | BT_HIDDEN |
460 | struct bt_port *bt_component_add_input_port( | |
3e9b0023 PP |
461 | struct bt_component *component, const char *name, |
462 | void *user_data) | |
72b913fb | 463 | { |
ab0d387b | 464 | /* bt_component_add_port() logs details */ |
72b913fb | 465 | return bt_component_add_port(component, component->input_ports, |
3e9b0023 | 466 | BT_PORT_TYPE_INPUT, name, user_data); |
72b913fb | 467 | } |
366e034f | 468 | |
72b913fb PP |
469 | BT_HIDDEN |
470 | struct bt_port *bt_component_add_output_port( | |
3e9b0023 PP |
471 | struct bt_component *component, const char *name, |
472 | void *user_data) | |
72b913fb | 473 | { |
ab0d387b | 474 | /* bt_component_add_port() logs details */ |
72b913fb | 475 | return bt_component_add_port(component, component->output_ports, |
3e9b0023 | 476 | BT_PORT_TYPE_OUTPUT, name, user_data); |
72b913fb PP |
477 | } |
478 | ||
479 | static | |
9ac68eb1 | 480 | void bt_component_remove_port_by_index(struct bt_component *component, |
72b913fb PP |
481 | GPtrArray *ports, size_t index) |
482 | { | |
483 | struct bt_port *port; | |
1bf957a0 | 484 | struct bt_graph *graph; |
72b913fb | 485 | |
f6ccaed9 PP |
486 | BT_ASSERT(ports); |
487 | BT_ASSERT(index < ports->len); | |
72b913fb PP |
488 | port = g_ptr_array_index(ports, index); |
489 | ||
ab0d387b PP |
490 | BT_LOGD("Removing port from component: " |
491 | "comp-addr=%p, comp-name=\"%s\", " | |
492 | "port-addr=%p, port-name=\"%s\"", | |
493 | component, bt_component_get_name(component), | |
494 | port, bt_port_get_name(port)); | |
495 | ||
72b913fb PP |
496 | /* Disconnect both ports of this port's connection, if any */ |
497 | if (port->connection) { | |
c42ea0af | 498 | bt_connection_end(port->connection, true); |
f60c8b34 JG |
499 | } |
500 | ||
72b913fb PP |
501 | /* Remove from parent's array of ports (weak refs) */ |
502 | g_ptr_array_remove_index(ports, index); | |
503 | ||
504 | /* Detach port from its component parent */ | |
505 | BT_PUT(port->base.parent); | |
506 | ||
1bf957a0 PP |
507 | /* |
508 | * Notify the graph's creator that a port is removed. | |
509 | */ | |
510 | graph = bt_component_get_graph(component); | |
511 | if (graph) { | |
512 | bt_graph_notify_port_removed(graph, component, port); | |
513 | BT_PUT(graph); | |
514 | } | |
ab0d387b PP |
515 | |
516 | BT_LOGD("Removed port from component: " | |
517 | "comp-addr=%p, comp-name=\"%s\", " | |
518 | "port-addr=%p, port-name=\"%s\"", | |
519 | component, bt_component_get_name(component), | |
520 | port, bt_port_get_name(port)); | |
366e034f JG |
521 | } |
522 | ||
523 | BT_HIDDEN | |
524 | enum bt_component_status bt_component_remove_port( | |
72b913fb | 525 | struct bt_component *component, struct bt_port *port) |
366e034f JG |
526 | { |
527 | size_t i; | |
528 | enum bt_component_status status = BT_COMPONENT_STATUS_OK; | |
72b913fb | 529 | GPtrArray *ports = NULL; |
366e034f | 530 | |
ab0d387b PP |
531 | if (!component) { |
532 | BT_LOGW_STR("Invalid parameter: component is NULL."); | |
533 | status = BT_COMPONENT_STATUS_INVALID; | |
534 | goto end; | |
535 | } | |
536 | ||
537 | if (!port) { | |
538 | BT_LOGW_STR("Invalid parameter: port is NULL."); | |
366e034f JG |
539 | status = BT_COMPONENT_STATUS_INVALID; |
540 | goto end; | |
541 | } | |
542 | ||
72b913fb PP |
543 | if (bt_port_get_type(port) == BT_PORT_TYPE_INPUT) { |
544 | ports = component->input_ports; | |
545 | } else if (bt_port_get_type(port) == BT_PORT_TYPE_OUTPUT) { | |
546 | ports = component->output_ports; | |
547 | } | |
366e034f | 548 | |
f6ccaed9 | 549 | BT_ASSERT(ports); |
366e034f | 550 | |
72b913fb PP |
551 | for (i = 0; i < ports->len; i++) { |
552 | struct bt_port *cur_port = g_ptr_array_index(ports, i); | |
553 | ||
554 | if (cur_port == port) { | |
9ac68eb1 | 555 | bt_component_remove_port_by_index(component, |
72b913fb | 556 | ports, i); |
366e034f JG |
557 | goto end; |
558 | } | |
559 | } | |
72b913fb | 560 | |
366e034f | 561 | status = BT_COMPONENT_STATUS_NOT_FOUND; |
ab0d387b PP |
562 | BT_LOGW("Port to remove from component was not found: " |
563 | "comp-addr=%p, comp-name=\"%s\", " | |
564 | "port-addr=%p, port-name=\"%s\"", | |
565 | component, bt_component_get_name(component), | |
566 | port, bt_port_get_name(port)); | |
567 | ||
366e034f JG |
568 | end: |
569 | return status; | |
570 | } | |
f60c8b34 JG |
571 | |
572 | BT_HIDDEN | |
72b913fb | 573 | enum bt_component_status bt_component_accept_port_connection( |
8f4799f7 PP |
574 | struct bt_component *comp, struct bt_port *self_port, |
575 | struct bt_port *other_port) | |
f60c8b34 JG |
576 | { |
577 | enum bt_component_status status = BT_COMPONENT_STATUS_OK; | |
578 | ||
f6ccaed9 PP |
579 | BT_ASSERT(comp); |
580 | BT_ASSERT(self_port); | |
581 | BT_ASSERT(other_port); | |
72b913fb PP |
582 | |
583 | if (comp->class->methods.accept_port_connection) { | |
ab0d387b PP |
584 | BT_LOGD("Calling user's \"accept port connection\" method: " |
585 | "comp-addr=%p, comp-name=\"%s\", " | |
586 | "self-port-addr=%p, self-port-name=\"%s\", " | |
587 | "other-port-addr=%p, other-port-name=\"%s\"", | |
588 | comp, bt_component_get_name(comp), | |
589 | self_port, bt_port_get_name(self_port), | |
590 | other_port, bt_port_get_name(other_port)); | |
72b913fb | 591 | status = comp->class->methods.accept_port_connection( |
890882ef | 592 | bt_private_component_from_component(comp), |
8f4799f7 PP |
593 | bt_private_port_from_port(self_port), |
594 | other_port); | |
ab0d387b PP |
595 | BT_LOGD("User method returned: status=%s", |
596 | bt_component_status_string(status)); | |
f60c8b34 JG |
597 | } |
598 | ||
599 | return status; | |
600 | } | |
72b913fb | 601 | |
0d8b4d8e PP |
602 | BT_HIDDEN |
603 | void bt_component_port_connected(struct bt_component *comp, | |
604 | struct bt_port *self_port, struct bt_port *other_port) | |
605 | { | |
f6ccaed9 PP |
606 | BT_ASSERT(comp); |
607 | BT_ASSERT(self_port); | |
608 | BT_ASSERT(other_port); | |
0d8b4d8e PP |
609 | |
610 | if (comp->class->methods.port_connected) { | |
ab0d387b PP |
611 | BT_LOGD("Calling user's \"port connected\" method: " |
612 | "comp-addr=%p, comp-name=\"%s\", " | |
613 | "self-port-addr=%p, self-port-name=\"%s\", " | |
614 | "other-port-addr=%p, other-port-name=\"%s\"", | |
615 | comp, bt_component_get_name(comp), | |
616 | self_port, bt_port_get_name(self_port), | |
617 | other_port, bt_port_get_name(other_port)); | |
0d8b4d8e PP |
618 | comp->class->methods.port_connected( |
619 | bt_private_component_from_component(comp), | |
620 | bt_private_port_from_port(self_port), other_port); | |
621 | } | |
622 | } | |
623 | ||
72b913fb PP |
624 | BT_HIDDEN |
625 | void bt_component_port_disconnected(struct bt_component *comp, | |
626 | struct bt_port *port) | |
627 | { | |
f6ccaed9 PP |
628 | BT_ASSERT(comp); |
629 | BT_ASSERT(port); | |
72b913fb PP |
630 | |
631 | if (comp->class->methods.port_disconnected) { | |
ab0d387b PP |
632 | BT_LOGD("Calling user's \"port disconnected\" method: " |
633 | "comp-addr=%p, comp-name=\"%s\", " | |
634 | "port-addr=%p, port-name=\"%s\"", | |
635 | comp, bt_component_get_name(comp), | |
636 | port, bt_port_get_name(port)); | |
890882ef PP |
637 | comp->class->methods.port_disconnected( |
638 | bt_private_component_from_component(comp), | |
639 | bt_private_port_from_port(port)); | |
72b913fb PP |
640 | } |
641 | } | |
3230ee6b PP |
642 | |
643 | BT_HIDDEN | |
644 | void bt_component_add_destroy_listener(struct bt_component *component, | |
645 | bt_component_destroy_listener_func func, void *data) | |
646 | { | |
647 | struct bt_component_destroy_listener listener; | |
648 | ||
f6ccaed9 PP |
649 | BT_ASSERT(component); |
650 | BT_ASSERT(func); | |
3230ee6b PP |
651 | listener.func = func; |
652 | listener.data = data; | |
653 | g_array_append_val(component->destroy_listeners, listener); | |
ab0d387b PP |
654 | BT_LOGV("Added destroy listener: " |
655 | "comp-addr=%p, comp-name=\"%s\", " | |
656 | "func-addr=%p, data-addr=%p", | |
657 | component, bt_component_get_name(component), | |
658 | func, data); | |
3230ee6b PP |
659 | } |
660 | ||
661 | BT_HIDDEN | |
662 | void bt_component_remove_destroy_listener(struct bt_component *component, | |
663 | bt_component_destroy_listener_func func, void *data) | |
664 | { | |
665 | size_t i; | |
666 | ||
f6ccaed9 PP |
667 | BT_ASSERT(component); |
668 | BT_ASSERT(func); | |
3230ee6b PP |
669 | |
670 | for (i = 0; i < component->destroy_listeners->len; i++) { | |
671 | struct bt_component_destroy_listener *listener = | |
672 | &g_array_index(component->destroy_listeners, | |
673 | struct bt_component_destroy_listener, i); | |
674 | ||
675 | if (listener->func == func && listener->data == data) { | |
676 | g_array_remove_index(component->destroy_listeners, i); | |
677 | i--; | |
ab0d387b PP |
678 | BT_LOGV("Removed destroy listener: " |
679 | "comp-addr=%p, comp-name=\"%s\", " | |
680 | "func-addr=%p, data-addr=%p", | |
681 | component, bt_component_get_name(component), | |
682 | func, data); | |
3230ee6b PP |
683 | } |
684 | } | |
685 | } |