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