Commit | Line | Data |
---|---|---|
de713ce0 | 1 | /* |
e2f7325d | 2 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> |
de713ce0 JG |
3 | * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
4 | * | |
de713ce0 JG |
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 | ||
350ad6c1 | 24 | #define BT_LOG_TAG "LIB/COMPONENT" |
c2d9d9cf | 25 | #include "lib/logging.h" |
ab0d387b | 26 | |
e874da19 | 27 | #include "common/common.h" |
578e048b MJ |
28 | #include "common/assert.h" |
29 | #include "lib/assert-pre.h" | |
f6f301d7 | 30 | #include "lib/assert-post.h" |
3fadfbc0 MJ |
31 | #include <babeltrace2/graph/self-component.h> |
32 | #include <babeltrace2/graph/component-const.h> | |
33 | #include <babeltrace2/graph/component-source-const.h> | |
34 | #include <babeltrace2/graph/component-filter-const.h> | |
35 | #include <babeltrace2/graph/component-sink-const.h> | |
d24d5663 | 36 | #include <babeltrace2/graph/graph-const.h> |
91d81473 | 37 | #include "common/macros.h" |
578e048b | 38 | #include "compat/compiler.h" |
3fadfbc0 MJ |
39 | #include <babeltrace2/types.h> |
40 | #include <babeltrace2/value.h> | |
578e048b | 41 | #include "lib/value.h" |
9ac68eb1 | 42 | #include <stdint.h> |
ab0d387b | 43 | #include <inttypes.h> |
de713ce0 | 44 | |
578e048b MJ |
45 | #include "component.h" |
46 | #include "component-class.h" | |
47 | #include "component-source.h" | |
48 | #include "component-filter.h" | |
49 | #include "component-sink.h" | |
50 | #include "connection.h" | |
51 | #include "graph.h" | |
52 | #include "message/iterator.h" | |
53 | #include "port.h" | |
d24d5663 | 54 | #include "lib/func-status.h" |
578e048b | 55 | |
7c7c0433 JG |
56 | static |
57 | struct bt_component * (* const component_create_funcs[])( | |
0d72b8c3 | 58 | const struct bt_component_class *) = { |
d3e4dcd8 PP |
59 | [BT_COMPONENT_CLASS_TYPE_SOURCE] = bt_component_source_create, |
60 | [BT_COMPONENT_CLASS_TYPE_SINK] = bt_component_sink_create, | |
61 | [BT_COMPONENT_CLASS_TYPE_FILTER] = bt_component_filter_create, | |
7c7c0433 JG |
62 | }; |
63 | ||
72b913fb PP |
64 | static |
65 | void (*component_destroy_funcs[])(struct bt_component *) = { | |
66 | [BT_COMPONENT_CLASS_TYPE_SOURCE] = bt_component_source_destroy, | |
67 | [BT_COMPONENT_CLASS_TYPE_SINK] = bt_component_sink_destroy, | |
68 | [BT_COMPONENT_CLASS_TYPE_FILTER] = bt_component_filter_destroy, | |
69 | }; | |
70 | ||
b8a06801 | 71 | static |
d94d92ac PP |
72 | void finalize_component(struct bt_component *comp) |
73 | { | |
74 | typedef void (*method_t)(void *); | |
75 | ||
76 | method_t method = NULL; | |
77 | ||
78 | BT_ASSERT(comp); | |
79 | ||
80 | switch (comp->class->type) { | |
81 | case BT_COMPONENT_CLASS_TYPE_SOURCE: | |
82 | { | |
83 | struct bt_component_class_source *src_cc = (void *) comp->class; | |
84 | ||
85 | method = (method_t) src_cc->methods.finalize; | |
86 | break; | |
87 | } | |
88 | case BT_COMPONENT_CLASS_TYPE_FILTER: | |
89 | { | |
90 | struct bt_component_class_filter *flt_cc = (void *) comp->class; | |
91 | ||
92 | method = (method_t) flt_cc->methods.finalize; | |
93 | break; | |
94 | } | |
95 | case BT_COMPONENT_CLASS_TYPE_SINK: | |
96 | { | |
97 | struct bt_component_class_sink *sink_cc = (void *) comp->class; | |
98 | ||
99 | method = (method_t) sink_cc->methods.finalize; | |
100 | break; | |
101 | } | |
102 | default: | |
103 | abort(); | |
104 | } | |
105 | ||
106 | if (method) { | |
3f7d4d90 | 107 | BT_LIB_LOGI("Calling user's component finalization method: " |
d94d92ac PP |
108 | "%![comp-]+c", comp); |
109 | method(comp); | |
110 | } | |
111 | } | |
112 | ||
113 | static | |
114 | void destroy_component(struct bt_object *obj) | |
b8a06801 JG |
115 | { |
116 | struct bt_component *component = NULL; | |
3230ee6b | 117 | int i; |
b8a06801 JG |
118 | |
119 | if (!obj) { | |
120 | return; | |
121 | } | |
122 | ||
bd14d768 PP |
123 | /* |
124 | * The component's reference count is 0 if we're here. Increment | |
125 | * it to avoid a double-destroy (possibly infinitely recursive). | |
126 | * This could happen for example if the component's finalization | |
d94d92ac PP |
127 | * function does bt_object_get_ref() (or anything that causes |
128 | * bt_object_get_ref() to be called) on itself (ref. count goes | |
129 | * from 0 to 1), and then bt_object_put_ref(): the reference | |
130 | * count would go from 1 to 0 again and this function would be | |
131 | * called again. | |
bd14d768 | 132 | */ |
3fea54f6 | 133 | obj->ref_count++; |
b8a06801 | 134 | component = container_of(obj, struct bt_component, base); |
3f7d4d90 | 135 | BT_LIB_LOGI("Destroying component: %![comp-]+c, %![graph-]+g", |
d94d92ac | 136 | component, bt_component_borrow_graph(component)); |
3230ee6b PP |
137 | |
138 | /* Call destroy listeners in reverse registration order */ | |
ab0d387b PP |
139 | BT_LOGD_STR("Calling destroy listeners."); |
140 | ||
3230ee6b PP |
141 | for (i = component->destroy_listeners->len - 1; i >= 0; i--) { |
142 | struct bt_component_destroy_listener *listener = | |
143 | &g_array_index(component->destroy_listeners, | |
144 | struct bt_component_destroy_listener, i); | |
145 | ||
146 | listener->func(component, listener->data); | |
147 | } | |
148 | ||
7c7c0433 | 149 | /* |
36712f1d PP |
150 | * User data is destroyed first, followed by the concrete |
151 | * component instance. Do not finalize if the component's user | |
152 | * initialization method failed in the first place. | |
b8a06801 | 153 | */ |
d94d92ac PP |
154 | if (component->initialized) { |
155 | finalize_component(component); | |
7c7c0433 | 156 | } |
b8a06801 | 157 | |
ab09f844 | 158 | if (component->destroy) { |
ab0d387b | 159 | BT_LOGD_STR("Destroying type-specific data."); |
ab09f844 JG |
160 | component->destroy(component); |
161 | } | |
162 | ||
72b913fb | 163 | if (component->input_ports) { |
ab0d387b | 164 | BT_LOGD_STR("Destroying input ports."); |
72b913fb | 165 | g_ptr_array_free(component->input_ports, TRUE); |
d94d92ac | 166 | component->input_ports = NULL; |
72b913fb | 167 | } |
b8a06801 | 168 | |
72b913fb | 169 | if (component->output_ports) { |
ab0d387b | 170 | BT_LOGD_STR("Destroying output ports."); |
72b913fb | 171 | g_ptr_array_free(component->output_ports, TRUE); |
d94d92ac | 172 | component->output_ports = NULL; |
b8a06801 JG |
173 | } |
174 | ||
3230ee6b PP |
175 | if (component->destroy_listeners) { |
176 | g_array_free(component->destroy_listeners, TRUE); | |
d94d92ac | 177 | component->destroy_listeners = NULL; |
3230ee6b PP |
178 | } |
179 | ||
ab0d387b PP |
180 | if (component->name) { |
181 | g_string_free(component->name, TRUE); | |
d94d92ac | 182 | component->name = NULL; |
ab0d387b PP |
183 | } |
184 | ||
d94d92ac PP |
185 | BT_LOGD_STR("Putting component class."); |
186 | BT_OBJECT_PUT_REF_AND_RESET(component->class); | |
72b913fb | 187 | g_free(component); |
b8a06801 | 188 | } |
de713ce0 | 189 | |
890882ef | 190 | enum bt_component_class_type bt_component_get_class_type( |
0d72b8c3 | 191 | const struct bt_component *component) |
5645cd95 | 192 | { |
d94d92ac PP |
193 | BT_ASSERT_PRE_NON_NULL(component, "Component"); |
194 | return component->class->type; | |
5645cd95 JG |
195 | } |
196 | ||
72b913fb | 197 | static |
d24d5663 | 198 | enum bt_self_component_add_port_status add_port( |
72b913fb | 199 | struct bt_component *component, GPtrArray *ports, |
8cc56726 SM |
200 | enum bt_port_type port_type, const char *name, void *user_data, |
201 | struct bt_port **port) | |
72b913fb | 202 | { |
72b913fb | 203 | struct bt_port *new_port = NULL; |
1bf957a0 | 204 | struct bt_graph *graph = NULL; |
d24d5663 | 205 | enum bt_self_component_add_port_status status; |
72b913fb | 206 | |
d94d92ac PP |
207 | BT_ASSERT_PRE_NON_NULL(component, "Component"); |
208 | BT_ASSERT_PRE_NON_NULL(name, "Name"); | |
209 | BT_ASSERT_PRE(strlen(name) > 0, "Name is empty"); | |
210 | graph = bt_component_borrow_graph(component); | |
211 | BT_ASSERT_PRE(graph && !bt_graph_is_canceled(graph), | |
212 | "Component's graph is canceled: %![comp-]+c, %![graph-]+g", | |
213 | component, graph); | |
5badd463 PP |
214 | BT_ASSERT_PRE( |
215 | graph->config_state == BT_GRAPH_CONFIGURATION_STATE_CONFIGURING, | |
4725a201 PP |
216 | "Component's graph is already configured: " |
217 | "%![comp-]+c, %![graph-]+g", component, graph); | |
72b913fb | 218 | |
d94d92ac | 219 | // TODO: Validate that the name is not already used. |
ab0d387b | 220 | |
3f7d4d90 | 221 | BT_LIB_LOGI("Adding port to component: %![comp-]+c, " |
ab0d387b | 222 | "port-type=%s, port-name=\"%s\"", component, |
ab0d387b PP |
223 | bt_port_type_string(port_type), name); |
224 | ||
3e9b0023 | 225 | new_port = bt_port_create(component, port_type, name, user_data); |
72b913fb | 226 | if (!new_port) { |
870631a2 | 227 | BT_LIB_LOGE_APPEND_CAUSE("Cannot create port object."); |
d24d5663 | 228 | status = BT_FUNC_STATUS_MEMORY_ERROR; |
8cc56726 | 229 | goto error; |
72b913fb PP |
230 | } |
231 | ||
232 | /* | |
233 | * No name clash, add the port. | |
234 | * The component is now the port's parent; it should _not_ | |
235 | * hold a reference to the port since the port's lifetime | |
236 | * is now protected by the component's own lifetime. | |
237 | */ | |
238 | g_ptr_array_add(ports, new_port); | |
1bf957a0 PP |
239 | |
240 | /* | |
241 | * Notify the graph's creator that a new port was added. | |
242 | */ | |
398454ed | 243 | graph = bt_component_borrow_graph(component); |
1bf957a0 | 244 | if (graph) { |
d24d5663 | 245 | enum bt_graph_listener_func_status listener_status; |
8cc56726 SM |
246 | |
247 | listener_status = bt_graph_notify_port_added(graph, new_port); | |
d24d5663 | 248 | if (listener_status != BT_FUNC_STATUS_OK) { |
8cc56726 | 249 | bt_graph_make_faulty(graph); |
d24d5663 | 250 | status = (int) listener_status; |
8cc56726 SM |
251 | goto error; |
252 | } | |
1bf957a0 PP |
253 | } |
254 | ||
3f7d4d90 | 255 | BT_LIB_LOGI("Created and added port to component: " |
d94d92ac | 256 | "%![comp-]+c, %![port-]+p", component, new_port); |
ab0d387b | 257 | |
8cc56726 | 258 | *port = new_port; |
d24d5663 | 259 | status = BT_FUNC_STATUS_OK; |
8cc56726 SM |
260 | |
261 | goto end; | |
262 | error: | |
263 | /* | |
264 | * We need to release the reference that we would otherwise have | |
265 | * returned to the caller. | |
266 | */ | |
267 | BT_PORT_PUT_REF_AND_RESET(new_port); | |
268 | ||
72b913fb | 269 | end: |
8cc56726 | 270 | return status; |
72b913fb PP |
271 | } |
272 | ||
273 | BT_HIDDEN | |
0d72b8c3 | 274 | uint64_t bt_component_get_input_port_count(const struct bt_component *comp) |
72b913fb | 275 | { |
d94d92ac PP |
276 | BT_ASSERT_PRE_NON_NULL(comp, "Component"); |
277 | return (uint64_t) comp->input_ports->len; | |
72b913fb PP |
278 | } |
279 | ||
280 | BT_HIDDEN | |
0d72b8c3 | 281 | uint64_t bt_component_get_output_port_count(const struct bt_component *comp) |
72b913fb | 282 | { |
d94d92ac PP |
283 | BT_ASSERT_PRE_NON_NULL(comp, "Component"); |
284 | return (uint64_t) comp->output_ports->len; | |
72b913fb PP |
285 | } |
286 | ||
dd8a4547 | 287 | BT_HIDDEN |
d94d92ac | 288 | int bt_component_create(struct bt_component_class *component_class, |
e874da19 PP |
289 | const char *name, bt_logging_level log_level, |
290 | struct bt_component **user_component) | |
38b48196 | 291 | { |
d94d92ac | 292 | int ret = 0; |
38b48196 | 293 | struct bt_component *component = NULL; |
d3e4dcd8 | 294 | enum bt_component_class_type type; |
38b48196 | 295 | |
f6ccaed9 PP |
296 | BT_ASSERT(user_component); |
297 | BT_ASSERT(component_class); | |
298 | BT_ASSERT(name); | |
7c7c0433 | 299 | type = bt_component_class_get_type(component_class); |
3f7d4d90 | 300 | BT_LIB_LOGI("Creating empty component from component class: %![cc-]+C, " |
e874da19 PP |
301 | "comp-name=\"%s\", log-level=%s", component_class, name, |
302 | bt_common_logging_level_string(log_level)); | |
36712f1d | 303 | component = component_create_funcs[type](component_class); |
7c7c0433 | 304 | if (!component) { |
870631a2 PP |
305 | BT_LIB_LOGE_APPEND_CAUSE( |
306 | "Cannot create specific component object."); | |
d94d92ac | 307 | ret = -1; |
7c7c0433 JG |
308 | goto end; |
309 | } | |
310 | ||
d0fea130 | 311 | bt_object_init_shared_with_parent(&component->base, destroy_component); |
398454ed PP |
312 | component->class = component_class; |
313 | bt_object_get_no_null_check(component->class); | |
72b913fb | 314 | component->destroy = component_destroy_funcs[type]; |
7c7c0433 | 315 | component->name = g_string_new(name); |
4b70dd83 | 316 | if (!component->name) { |
870631a2 | 317 | BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GString."); |
d94d92ac | 318 | ret = -1; |
7c7c0433 JG |
319 | goto end; |
320 | } | |
321 | ||
e874da19 | 322 | component->log_level = log_level; |
72b913fb | 323 | component->input_ports = g_ptr_array_new_with_free_func( |
3fea54f6 | 324 | (GDestroyNotify) bt_object_try_spec_release); |
72b913fb | 325 | if (!component->input_ports) { |
870631a2 | 326 | BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GPtrArray."); |
d94d92ac | 327 | ret = -1; |
72b913fb PP |
328 | goto end; |
329 | } | |
330 | ||
331 | component->output_ports = g_ptr_array_new_with_free_func( | |
3fea54f6 | 332 | (GDestroyNotify) bt_object_try_spec_release); |
72b913fb | 333 | if (!component->output_ports) { |
870631a2 | 334 | BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GPtrArray."); |
d94d92ac | 335 | ret = -1; |
72b913fb PP |
336 | goto end; |
337 | } | |
338 | ||
3230ee6b PP |
339 | component->destroy_listeners = g_array_new(FALSE, TRUE, |
340 | sizeof(struct bt_component_destroy_listener)); | |
341 | if (!component->destroy_listeners) { | |
870631a2 | 342 | BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GArray."); |
d94d92ac | 343 | ret = -1; |
3230ee6b PP |
344 | goto end; |
345 | } | |
346 | ||
3f7d4d90 | 347 | BT_LIB_LOGI("Created empty component from component class: " |
d94d92ac | 348 | "%![cc-]+C, %![comp-]+c", component_class, component); |
65300d60 | 349 | BT_OBJECT_MOVE_REF(*user_component, component); |
ab0d387b | 350 | |
38b48196 | 351 | end: |
65300d60 | 352 | bt_object_put_ref(component); |
d94d92ac | 353 | return ret; |
6358c163 PP |
354 | } |
355 | ||
0d72b8c3 | 356 | const char *bt_component_get_name(const struct bt_component *component) |
de713ce0 | 357 | { |
d94d92ac PP |
358 | BT_ASSERT_PRE_NON_NULL(component, "Component"); |
359 | return component->name->str; | |
de713ce0 JG |
360 | } |
361 | ||
1de6a2b0 | 362 | const struct bt_component_class *bt_component_borrow_class_const( |
0d72b8c3 | 363 | const struct bt_component *component) |
de713ce0 | 364 | { |
d94d92ac PP |
365 | BT_ASSERT_PRE_NON_NULL(component, "Component"); |
366 | return component->class; | |
de713ce0 JG |
367 | } |
368 | ||
0d72b8c3 | 369 | void *bt_self_component_get_data(const struct bt_self_component *self_comp) |
de713ce0 | 370 | { |
d94d92ac | 371 | struct bt_component *component = (void *) self_comp; |
890882ef | 372 | |
d94d92ac PP |
373 | BT_ASSERT_PRE_NON_NULL(component, "Component"); |
374 | return component->user_data; | |
de713ce0 JG |
375 | } |
376 | ||
d94d92ac | 377 | void bt_self_component_set_data(struct bt_self_component *self_comp, |
de713ce0 JG |
378 | void *data) |
379 | { | |
d94d92ac | 380 | struct bt_component *component = (void *) self_comp; |
ab0d387b | 381 | |
d94d92ac | 382 | BT_ASSERT_PRE_NON_NULL(component, "Component"); |
de713ce0 | 383 | component->user_data = data; |
3f7d4d90 | 384 | BT_LIB_LOGD("Set component's user data: %!+c", component); |
de713ce0 | 385 | } |
366e034f JG |
386 | |
387 | BT_HIDDEN | |
f60c8b34 | 388 | void bt_component_set_graph(struct bt_component *component, |
366e034f JG |
389 | struct bt_graph *graph) |
390 | { | |
3fea54f6 PP |
391 | bt_object_set_parent(&component->base, |
392 | graph ? &graph->base : NULL); | |
366e034f JG |
393 | } |
394 | ||
0d72b8c3 | 395 | bt_bool bt_component_graph_is_canceled(const struct bt_component *component) |
366e034f | 396 | { |
e5be10ef PP |
397 | return bt_graph_is_canceled( |
398 | (void *) bt_object_borrow_parent(&component->base)); | |
366e034f JG |
399 | } |
400 | ||
72b913fb | 401 | static |
d94d92ac | 402 | struct bt_port *borrow_port_by_name(GPtrArray *ports, |
9ac68eb1 | 403 | const char *name) |
366e034f | 404 | { |
d94d92ac | 405 | uint64_t i; |
366e034f JG |
406 | struct bt_port *ret_port = NULL; |
407 | ||
f6ccaed9 | 408 | BT_ASSERT(name); |
72b913fb | 409 | |
366e034f JG |
410 | for (i = 0; i < ports->len; i++) { |
411 | struct bt_port *port = g_ptr_array_index(ports, i); | |
366e034f | 412 | |
d94d92ac PP |
413 | if (!strcmp(name, port->name->str)) { |
414 | ret_port = port; | |
366e034f JG |
415 | break; |
416 | } | |
417 | } | |
418 | ||
419 | return ret_port; | |
420 | } | |
421 | ||
422 | BT_HIDDEN | |
d94d92ac PP |
423 | struct bt_port_input *bt_component_borrow_input_port_by_name( |
424 | struct bt_component *comp, const char *name) | |
72b913fb | 425 | { |
f6ccaed9 | 426 | BT_ASSERT(comp); |
d94d92ac | 427 | return (void *) borrow_port_by_name(comp->input_ports, name); |
72b913fb PP |
428 | } |
429 | ||
430 | BT_HIDDEN | |
d94d92ac PP |
431 | struct bt_port_output *bt_component_borrow_output_port_by_name( |
432 | struct bt_component *comp, const char *name) | |
72b913fb | 433 | { |
d94d92ac PP |
434 | BT_ASSERT_PRE_NON_NULL(comp, "Component"); |
435 | return (void *) | |
436 | borrow_port_by_name(comp->output_ports, name); | |
72b913fb PP |
437 | } |
438 | ||
439 | static | |
d94d92ac | 440 | struct bt_port *borrow_port_by_index(GPtrArray *ports, uint64_t index) |
366e034f | 441 | { |
d94d92ac PP |
442 | BT_ASSERT(index < ports->len); |
443 | return g_ptr_array_index(ports, index); | |
366e034f JG |
444 | } |
445 | ||
446 | BT_HIDDEN | |
d94d92ac PP |
447 | struct bt_port_input *bt_component_borrow_input_port_by_index( |
448 | struct bt_component *comp, uint64_t index) | |
366e034f | 449 | { |
d94d92ac PP |
450 | BT_ASSERT_PRE_NON_NULL(comp, "Component"); |
451 | BT_ASSERT_PRE_VALID_INDEX(index, comp->input_ports->len); | |
452 | return (void *) | |
453 | borrow_port_by_index(comp->input_ports, index); | |
72b913fb | 454 | } |
366e034f | 455 | |
72b913fb | 456 | BT_HIDDEN |
d94d92ac PP |
457 | struct bt_port_output *bt_component_borrow_output_port_by_index( |
458 | struct bt_component *comp, uint64_t index) | |
72b913fb | 459 | { |
d94d92ac PP |
460 | BT_ASSERT_PRE_NON_NULL(comp, "Component"); |
461 | BT_ASSERT_PRE_VALID_INDEX(index, comp->output_ports->len); | |
462 | return (void *) | |
463 | borrow_port_by_index(comp->output_ports, index); | |
72b913fb | 464 | } |
366e034f | 465 | |
72b913fb | 466 | BT_HIDDEN |
d24d5663 | 467 | enum bt_self_component_add_port_status bt_component_add_input_port( |
3e9b0023 | 468 | struct bt_component *component, const char *name, |
8cc56726 | 469 | void *user_data, struct bt_port **port) |
72b913fb | 470 | { |
d94d92ac | 471 | /* add_port() logs details */ |
8cc56726 SM |
472 | return add_port(component, component->input_ports, |
473 | BT_PORT_TYPE_INPUT, name, user_data, port); | |
72b913fb | 474 | } |
366e034f | 475 | |
72b913fb | 476 | BT_HIDDEN |
d24d5663 | 477 | enum bt_self_component_add_port_status bt_component_add_output_port( |
3e9b0023 | 478 | struct bt_component *component, const char *name, |
8cc56726 | 479 | void *user_data, struct bt_port **port) |
72b913fb | 480 | { |
d94d92ac | 481 | /* add_port() logs details */ |
8cc56726 SM |
482 | return add_port(component, component->output_ports, |
483 | BT_PORT_TYPE_OUTPUT, name, user_data, port); | |
72b913fb PP |
484 | } |
485 | ||
0d8b4d8e | 486 | BT_HIDDEN |
d24d5663 PP |
487 | enum bt_component_class_port_connected_method_status |
488 | bt_component_port_connected( | |
d94d92ac PP |
489 | struct bt_component *comp, struct bt_port *self_port, |
490 | struct bt_port *other_port) | |
0d8b4d8e | 491 | { |
d24d5663 | 492 | typedef enum bt_component_class_port_connected_method_status (*method_t)( |
0d72b8c3 | 493 | void *, void *, const void *); |
d94d92ac | 494 | |
9275bef4 | 495 | enum bt_component_class_port_connected_method_status status = |
d24d5663 | 496 | BT_FUNC_STATUS_OK; |
d94d92ac | 497 | method_t method = NULL; |
bf55043c | 498 | |
f6ccaed9 PP |
499 | BT_ASSERT(comp); |
500 | BT_ASSERT(self_port); | |
501 | BT_ASSERT(other_port); | |
0d8b4d8e | 502 | |
d94d92ac PP |
503 | switch (comp->class->type) { |
504 | case BT_COMPONENT_CLASS_TYPE_SOURCE: | |
505 | { | |
506 | struct bt_component_class_source *src_cc = (void *) comp->class; | |
507 | ||
508 | switch (self_port->type) { | |
509 | case BT_PORT_TYPE_OUTPUT: | |
510 | method = (method_t) src_cc->methods.output_port_connected; | |
511 | break; | |
512 | default: | |
513 | abort(); | |
514 | } | |
515 | ||
516 | break; | |
517 | } | |
518 | case BT_COMPONENT_CLASS_TYPE_FILTER: | |
519 | { | |
520 | struct bt_component_class_filter *flt_cc = (void *) comp->class; | |
521 | ||
522 | switch (self_port->type) { | |
523 | case BT_PORT_TYPE_INPUT: | |
524 | method = (method_t) flt_cc->methods.input_port_connected; | |
525 | break; | |
526 | case BT_PORT_TYPE_OUTPUT: | |
527 | method = (method_t) flt_cc->methods.output_port_connected; | |
528 | break; | |
529 | default: | |
530 | abort(); | |
531 | } | |
532 | ||
533 | break; | |
534 | } | |
535 | case BT_COMPONENT_CLASS_TYPE_SINK: | |
536 | { | |
537 | struct bt_component_class_sink *sink_cc = (void *) comp->class; | |
538 | ||
539 | switch (self_port->type) { | |
540 | case BT_PORT_TYPE_INPUT: | |
541 | method = (method_t) sink_cc->methods.input_port_connected; | |
542 | break; | |
543 | default: | |
544 | abort(); | |
545 | } | |
546 | ||
547 | break; | |
548 | } | |
549 | default: | |
550 | abort(); | |
551 | } | |
552 | ||
553 | if (method) { | |
554 | BT_LIB_LOGD("Calling user's \"port connected\" method: " | |
555 | "%![comp-]+c, %![self-port-]+p, %![other-port-]+p", | |
556 | comp, self_port, other_port); | |
d24d5663 | 557 | status = (int) method(comp, self_port, (void *) other_port); |
d94d92ac | 558 | BT_LOGD("User method returned: status=%s", |
d24d5663 PP |
559 | bt_common_func_status_string(status)); |
560 | BT_ASSERT_POST(status == BT_FUNC_STATUS_OK || | |
561 | status == BT_FUNC_STATUS_ERROR || | |
562 | status == BT_FUNC_STATUS_MEMORY_ERROR, | |
4725a201 | 563 | "Unexpected returned component status: status=%s", |
d24d5663 | 564 | bt_common_func_status_string(status)); |
0d8b4d8e | 565 | } |
bf55043c PP |
566 | |
567 | return status; | |
0d8b4d8e PP |
568 | } |
569 | ||
3230ee6b PP |
570 | BT_HIDDEN |
571 | void bt_component_add_destroy_listener(struct bt_component *component, | |
572 | bt_component_destroy_listener_func func, void *data) | |
573 | { | |
574 | struct bt_component_destroy_listener listener; | |
575 | ||
f6ccaed9 PP |
576 | BT_ASSERT(component); |
577 | BT_ASSERT(func); | |
3230ee6b PP |
578 | listener.func = func; |
579 | listener.data = data; | |
580 | g_array_append_val(component->destroy_listeners, listener); | |
3f7d4d90 | 581 | BT_LIB_LOGD("Added destroy listener: %![comp-]+c, " |
ab0d387b | 582 | "func-addr=%p, data-addr=%p", |
d94d92ac | 583 | component, func, data); |
3230ee6b PP |
584 | } |
585 | ||
586 | BT_HIDDEN | |
587 | void bt_component_remove_destroy_listener(struct bt_component *component, | |
588 | bt_component_destroy_listener_func func, void *data) | |
589 | { | |
d94d92ac | 590 | uint64_t i; |
3230ee6b | 591 | |
f6ccaed9 PP |
592 | BT_ASSERT(component); |
593 | BT_ASSERT(func); | |
3230ee6b PP |
594 | |
595 | for (i = 0; i < component->destroy_listeners->len; i++) { | |
596 | struct bt_component_destroy_listener *listener = | |
597 | &g_array_index(component->destroy_listeners, | |
598 | struct bt_component_destroy_listener, i); | |
599 | ||
600 | if (listener->func == func && listener->data == data) { | |
601 | g_array_remove_index(component->destroy_listeners, i); | |
602 | i--; | |
3f7d4d90 | 603 | BT_LIB_LOGD("Removed destroy listener: %![comp-]+c, " |
ab0d387b | 604 | "func-addr=%p, data-addr=%p", |
d94d92ac | 605 | component, func, data); |
3230ee6b PP |
606 | } |
607 | } | |
608 | } | |
c5b9b441 | 609 | |
e874da19 PP |
610 | bt_logging_level bt_component_get_logging_level( |
611 | const struct bt_component *component) | |
612 | { | |
613 | BT_ASSERT_PRE_NON_NULL(component, "Component"); | |
614 | return component->log_level; | |
615 | } | |
616 | ||
c5b9b441 PP |
617 | void bt_component_get_ref(const struct bt_component *component) |
618 | { | |
619 | bt_object_get_ref(component); | |
620 | } | |
621 | ||
622 | void bt_component_put_ref(const struct bt_component *component) | |
623 | { | |
624 | bt_object_put_ref(component); | |
625 | } |