lib: rename `bt_object_{get,put}_no` -> `bt_object_{get,put}_ref_no`
[babeltrace.git] / src / lib / graph / component.c
1 /*
2 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
3 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
4 *
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
24 #define BT_LOG_TAG "LIB/COMPONENT"
25 #include "lib/logging.h"
26
27 #include "common/common.h"
28 #include "common/assert.h"
29 #include "lib/assert-pre.h"
30 #include "lib/assert-post.h"
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>
36 #include <babeltrace2/graph/graph-const.h>
37 #include "common/macros.h"
38 #include "compat/compiler.h"
39 #include <babeltrace2/types.h>
40 #include <babeltrace2/value.h>
41 #include "lib/value.h"
42 #include <stdint.h>
43 #include <inttypes.h>
44
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"
54 #include "lib/func-status.h"
55
56 static
57 struct bt_component * (* const component_create_funcs[])(
58 const struct bt_component_class *) = {
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,
62 };
63
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
71 static
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) {
107 BT_LIB_LOGI("Calling user's component finalization method: "
108 "%![comp-]+c", comp);
109 method(comp);
110 }
111 }
112
113 static
114 void destroy_component(struct bt_object *obj)
115 {
116 struct bt_component *component = NULL;
117 int i;
118
119 if (!obj) {
120 return;
121 }
122
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
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.
132 */
133 obj->ref_count++;
134 component = container_of(obj, struct bt_component, base);
135 BT_LIB_LOGI("Destroying component: %![comp-]+c, %![graph-]+g",
136 component, bt_component_borrow_graph(component));
137
138 /* Call destroy listeners in reverse registration order */
139 BT_LOGD_STR("Calling destroy listeners.");
140
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
149 /*
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.
153 */
154 if (component->initialized) {
155 finalize_component(component);
156 }
157
158 if (component->destroy) {
159 BT_LOGD_STR("Destroying type-specific data.");
160 component->destroy(component);
161 }
162
163 if (component->input_ports) {
164 BT_LOGD_STR("Destroying input ports.");
165 g_ptr_array_free(component->input_ports, TRUE);
166 component->input_ports = NULL;
167 }
168
169 if (component->output_ports) {
170 BT_LOGD_STR("Destroying output ports.");
171 g_ptr_array_free(component->output_ports, TRUE);
172 component->output_ports = NULL;
173 }
174
175 if (component->destroy_listeners) {
176 g_array_free(component->destroy_listeners, TRUE);
177 component->destroy_listeners = NULL;
178 }
179
180 if (component->name) {
181 g_string_free(component->name, TRUE);
182 component->name = NULL;
183 }
184
185 BT_LOGD_STR("Putting component class.");
186 BT_OBJECT_PUT_REF_AND_RESET(component->class);
187 g_free(component);
188 }
189
190 enum bt_component_class_type bt_component_get_class_type(
191 const struct bt_component *component)
192 {
193 BT_ASSERT_PRE_DEV_NON_NULL(component, "Component");
194 return component->class->type;
195 }
196
197 static
198 enum bt_self_component_add_port_status add_port(
199 struct bt_component *component, GPtrArray *ports,
200 enum bt_port_type port_type, const char *name, void *user_data,
201 struct bt_port **port)
202 {
203 struct bt_port *new_port = NULL;
204 struct bt_graph *graph = NULL;
205 enum bt_self_component_add_port_status status;
206
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(
212 graph->config_state == BT_GRAPH_CONFIGURATION_STATE_CONFIGURING,
213 "Component's graph is already configured: "
214 "%![comp-]+c, %![graph-]+g", component, graph);
215
216 // TODO: Validate that the name is not already used.
217
218 BT_LIB_LOGI("Adding port to component: %![comp-]+c, "
219 "port-type=%s, port-name=\"%s\"", component,
220 bt_port_type_string(port_type), name);
221
222 new_port = bt_port_create(component, port_type, name, user_data);
223 if (!new_port) {
224 BT_LIB_LOGE_APPEND_CAUSE("Cannot create port object.");
225 status = BT_FUNC_STATUS_MEMORY_ERROR;
226 goto error;
227 }
228
229 /*
230 * No name clash, add the port.
231 * The component is now the port's parent; it should _not_
232 * hold a reference to the port since the port's lifetime
233 * is now protected by the component's own lifetime.
234 */
235 g_ptr_array_add(ports, new_port);
236
237 /*
238 * Notify the graph's creator that a new port was added.
239 */
240 graph = bt_component_borrow_graph(component);
241 if (graph) {
242 enum bt_graph_listener_func_status listener_status;
243
244 listener_status = bt_graph_notify_port_added(graph, new_port);
245 if (listener_status != BT_FUNC_STATUS_OK) {
246 bt_graph_make_faulty(graph);
247 status = (int) listener_status;
248 goto error;
249 }
250 }
251
252 BT_LIB_LOGI("Created and added port to component: "
253 "%![comp-]+c, %![port-]+p", component, new_port);
254
255 *port = new_port;
256 status = BT_FUNC_STATUS_OK;
257
258 goto end;
259 error:
260 /*
261 * We need to release the reference that we would otherwise have
262 * returned to the caller.
263 */
264 BT_PORT_PUT_REF_AND_RESET(new_port);
265
266 end:
267 return status;
268 }
269
270 BT_HIDDEN
271 uint64_t bt_component_get_input_port_count(const struct bt_component *comp)
272 {
273 BT_ASSERT_PRE_DEV_NON_NULL(comp, "Component");
274 return (uint64_t) comp->input_ports->len;
275 }
276
277 BT_HIDDEN
278 uint64_t bt_component_get_output_port_count(const struct bt_component *comp)
279 {
280 BT_ASSERT_PRE_DEV_NON_NULL(comp, "Component");
281 return (uint64_t) comp->output_ports->len;
282 }
283
284 BT_HIDDEN
285 int bt_component_create(struct bt_component_class *component_class,
286 const char *name, bt_logging_level log_level,
287 struct bt_component **user_component)
288 {
289 int ret = 0;
290 struct bt_component *component = NULL;
291 enum bt_component_class_type type;
292
293 BT_ASSERT(user_component);
294 BT_ASSERT(component_class);
295 BT_ASSERT(name);
296 type = bt_component_class_get_type(component_class);
297 BT_LIB_LOGI("Creating empty component from component class: %![cc-]+C, "
298 "comp-name=\"%s\", log-level=%s", component_class, name,
299 bt_common_logging_level_string(log_level));
300 component = component_create_funcs[type](component_class);
301 if (!component) {
302 BT_LIB_LOGE_APPEND_CAUSE(
303 "Cannot create specific component object.");
304 ret = -1;
305 goto end;
306 }
307
308 bt_object_init_shared_with_parent(&component->base, destroy_component);
309 component->class = component_class;
310 bt_object_get_ref_no_null_check(component->class);
311 component->destroy = component_destroy_funcs[type];
312 component->name = g_string_new(name);
313 if (!component->name) {
314 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GString.");
315 ret = -1;
316 goto end;
317 }
318
319 component->log_level = log_level;
320 component->input_ports = g_ptr_array_new_with_free_func(
321 (GDestroyNotify) bt_object_try_spec_release);
322 if (!component->input_ports) {
323 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GPtrArray.");
324 ret = -1;
325 goto end;
326 }
327
328 component->output_ports = g_ptr_array_new_with_free_func(
329 (GDestroyNotify) bt_object_try_spec_release);
330 if (!component->output_ports) {
331 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GPtrArray.");
332 ret = -1;
333 goto end;
334 }
335
336 component->destroy_listeners = g_array_new(FALSE, TRUE,
337 sizeof(struct bt_component_destroy_listener));
338 if (!component->destroy_listeners) {
339 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GArray.");
340 ret = -1;
341 goto end;
342 }
343
344 BT_LIB_LOGI("Created empty component from component class: "
345 "%![cc-]+C, %![comp-]+c", component_class, component);
346 BT_OBJECT_MOVE_REF(*user_component, component);
347
348 end:
349 bt_object_put_ref(component);
350 return ret;
351 }
352
353 const char *bt_component_get_name(const struct bt_component *component)
354 {
355 BT_ASSERT_PRE_DEV_NON_NULL(component, "Component");
356 return component->name->str;
357 }
358
359 const struct bt_component_class *bt_component_borrow_class_const(
360 const struct bt_component *component)
361 {
362 BT_ASSERT_PRE_DEV_NON_NULL(component, "Component");
363 return component->class;
364 }
365
366 void *bt_self_component_get_data(const struct bt_self_component *self_comp)
367 {
368 struct bt_component *component = (void *) self_comp;
369
370 BT_ASSERT_PRE_DEV_NON_NULL(component, "Component");
371 return component->user_data;
372 }
373
374 void bt_self_component_set_data(struct bt_self_component *self_comp,
375 void *data)
376 {
377 struct bt_component *component = (void *) self_comp;
378
379 BT_ASSERT_PRE_DEV_NON_NULL(component, "Component");
380 component->user_data = data;
381 BT_LIB_LOGD("Set component's user data: %!+c", component);
382 }
383
384 BT_HIDDEN
385 void bt_component_set_graph(struct bt_component *component,
386 struct bt_graph *graph)
387 {
388 bt_object_set_parent(&component->base,
389 graph ? &graph->base : NULL);
390 }
391
392 static
393 struct bt_port *borrow_port_by_name(GPtrArray *ports,
394 const char *name)
395 {
396 uint64_t i;
397 struct bt_port *ret_port = NULL;
398
399 BT_ASSERT(name);
400
401 for (i = 0; i < ports->len; i++) {
402 struct bt_port *port = g_ptr_array_index(ports, i);
403
404 if (strcmp(name, port->name->str) == 0) {
405 ret_port = port;
406 break;
407 }
408 }
409
410 return ret_port;
411 }
412
413 BT_HIDDEN
414 struct bt_port_input *bt_component_borrow_input_port_by_name(
415 struct bt_component *comp, const char *name)
416 {
417 BT_ASSERT(comp);
418 return (void *) borrow_port_by_name(comp->input_ports, name);
419 }
420
421 BT_HIDDEN
422 struct bt_port_output *bt_component_borrow_output_port_by_name(
423 struct bt_component *comp, const char *name)
424 {
425 BT_ASSERT_PRE_DEV_NON_NULL(comp, "Component");
426 return (void *)
427 borrow_port_by_name(comp->output_ports, name);
428 }
429
430 static
431 struct bt_port *borrow_port_by_index(GPtrArray *ports, uint64_t index)
432 {
433 BT_ASSERT(index < ports->len);
434 return g_ptr_array_index(ports, index);
435 }
436
437 BT_HIDDEN
438 struct bt_port_input *bt_component_borrow_input_port_by_index(
439 struct bt_component *comp, uint64_t index)
440 {
441 BT_ASSERT_PRE_DEV_NON_NULL(comp, "Component");
442 BT_ASSERT_PRE_DEV_VALID_INDEX(index, comp->input_ports->len);
443 return (void *)
444 borrow_port_by_index(comp->input_ports, index);
445 }
446
447 BT_HIDDEN
448 struct bt_port_output *bt_component_borrow_output_port_by_index(
449 struct bt_component *comp, uint64_t index)
450 {
451 BT_ASSERT_PRE_DEV_NON_NULL(comp, "Component");
452 BT_ASSERT_PRE_DEV_VALID_INDEX(index, comp->output_ports->len);
453 return (void *)
454 borrow_port_by_index(comp->output_ports, index);
455 }
456
457 BT_HIDDEN
458 enum bt_self_component_add_port_status bt_component_add_input_port(
459 struct bt_component *component, const char *name,
460 void *user_data, struct bt_port **port)
461 {
462 /* add_port() logs details */
463 return add_port(component, component->input_ports,
464 BT_PORT_TYPE_INPUT, name, user_data, port);
465 }
466
467 BT_HIDDEN
468 enum bt_self_component_add_port_status bt_component_add_output_port(
469 struct bt_component *component, const char *name,
470 void *user_data, struct bt_port **port)
471 {
472 /* add_port() logs details */
473 return add_port(component, component->output_ports,
474 BT_PORT_TYPE_OUTPUT, name, user_data, port);
475 }
476
477 BT_HIDDEN
478 enum bt_component_class_port_connected_method_status
479 bt_component_port_connected(
480 struct bt_component *comp, struct bt_port *self_port,
481 struct bt_port *other_port)
482 {
483 typedef enum bt_component_class_port_connected_method_status (*method_t)(
484 void *, void *, const void *);
485
486 enum bt_component_class_port_connected_method_status status =
487 BT_FUNC_STATUS_OK;
488 method_t method = NULL;
489
490 BT_ASSERT(comp);
491 BT_ASSERT(self_port);
492 BT_ASSERT(other_port);
493
494 switch (comp->class->type) {
495 case BT_COMPONENT_CLASS_TYPE_SOURCE:
496 {
497 struct bt_component_class_source *src_cc = (void *) comp->class;
498
499 switch (self_port->type) {
500 case BT_PORT_TYPE_OUTPUT:
501 method = (method_t) src_cc->methods.output_port_connected;
502 break;
503 default:
504 abort();
505 }
506
507 break;
508 }
509 case BT_COMPONENT_CLASS_TYPE_FILTER:
510 {
511 struct bt_component_class_filter *flt_cc = (void *) comp->class;
512
513 switch (self_port->type) {
514 case BT_PORT_TYPE_INPUT:
515 method = (method_t) flt_cc->methods.input_port_connected;
516 break;
517 case BT_PORT_TYPE_OUTPUT:
518 method = (method_t) flt_cc->methods.output_port_connected;
519 break;
520 default:
521 abort();
522 }
523
524 break;
525 }
526 case BT_COMPONENT_CLASS_TYPE_SINK:
527 {
528 struct bt_component_class_sink *sink_cc = (void *) comp->class;
529
530 switch (self_port->type) {
531 case BT_PORT_TYPE_INPUT:
532 method = (method_t) sink_cc->methods.input_port_connected;
533 break;
534 default:
535 abort();
536 }
537
538 break;
539 }
540 default:
541 abort();
542 }
543
544 if (method) {
545 BT_LIB_LOGD("Calling user's \"port connected\" method: "
546 "%![comp-]+c, %![self-port-]+p, %![other-port-]+p",
547 comp, self_port, other_port);
548 status = (int) method(comp, self_port, (void *) other_port);
549 BT_LOGD("User method returned: status=%s",
550 bt_common_func_status_string(status));
551 BT_ASSERT_POST(status == BT_FUNC_STATUS_OK ||
552 status == BT_FUNC_STATUS_ERROR ||
553 status == BT_FUNC_STATUS_MEMORY_ERROR,
554 "Unexpected returned component status: status=%s",
555 bt_common_func_status_string(status));
556 }
557
558 return status;
559 }
560
561 BT_HIDDEN
562 void bt_component_add_destroy_listener(struct bt_component *component,
563 bt_component_destroy_listener_func func, void *data)
564 {
565 struct bt_component_destroy_listener listener;
566
567 BT_ASSERT(component);
568 BT_ASSERT(func);
569 listener.func = func;
570 listener.data = data;
571 g_array_append_val(component->destroy_listeners, listener);
572 BT_LIB_LOGD("Added destroy listener: %![comp-]+c, "
573 "func-addr=%p, data-addr=%p",
574 component, func, data);
575 }
576
577 BT_HIDDEN
578 void bt_component_remove_destroy_listener(struct bt_component *component,
579 bt_component_destroy_listener_func func, void *data)
580 {
581 uint64_t i;
582
583 BT_ASSERT(component);
584 BT_ASSERT(func);
585
586 for (i = 0; i < component->destroy_listeners->len; i++) {
587 struct bt_component_destroy_listener *listener =
588 &g_array_index(component->destroy_listeners,
589 struct bt_component_destroy_listener, i);
590
591 if (listener->func == func && listener->data == data) {
592 g_array_remove_index(component->destroy_listeners, i);
593 i--;
594 BT_LIB_LOGD("Removed destroy listener: %![comp-]+c, "
595 "func-addr=%p, data-addr=%p",
596 component, func, data);
597 }
598 }
599 }
600
601 bt_logging_level bt_component_get_logging_level(
602 const struct bt_component *component)
603 {
604 BT_ASSERT_PRE_DEV_NON_NULL(component, "Component");
605 return component->log_level;
606 }
607
608 uint64_t bt_self_component_get_graph_mip_version(
609 bt_self_component *self_component)
610 {
611 struct bt_component *comp = (void *) self_component;
612
613 BT_ASSERT_PRE_NON_NULL(self_component, "Component");
614 return bt_component_borrow_graph(comp)->mip_version;
615 }
616
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 }
This page took 0.046988 seconds and 4 git commands to generate.