Commit | Line | Data |
---|---|---|
90354d3a | 1 | /* |
0235b0db MJ |
2 | * SPDX-License-Identifier: MIT |
3 | * | |
e2f7325d | 4 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> |
90354d3a | 5 | * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
90354d3a JG |
6 | */ |
7 | ||
0235b0db MJ |
8 | #ifndef BABELTRACE_GRAPH_COMPONENT_INTERNAL_H |
9 | #define BABELTRACE_GRAPH_COMPONENT_INTERNAL_H | |
10 | ||
91d81473 | 11 | #include "common/macros.h" |
43c59509 | 12 | #include <babeltrace2/graph/component.h> |
d24d5663 | 13 | #include <babeltrace2/graph/component-class.h> |
578e048b | 14 | #include "lib/object.h" |
3fadfbc0 | 15 | #include <babeltrace2/types.h> |
e874da19 | 16 | #include <babeltrace2/logging.h> |
578e048b | 17 | #include "common/assert.h" |
0db5ca2c | 18 | #include <glib.h> |
c4f23e30 | 19 | #include <stdbool.h> |
38d02a17 | 20 | #include <stdio.h> |
90354d3a | 21 | |
578e048b MJ |
22 | #include "component-class.h" |
23 | #include "port.h" | |
24 | ||
157a98ed SM |
25 | #define BT_ASSERT_PRE_INPUT_PORT_NAME_UNIQUE(comp, name) \ |
26 | BT_ASSERT_PRE(bt_component_port_name_is_unique(comp->input_ports, name), \ | |
27 | "Input port name is not unique: name=\"%s\", %![comp-]c", name, comp); | |
28 | ||
29 | #define BT_ASSERT_PRE_OUTPUT_PORT_NAME_UNIQUE(comp, name) \ | |
30 | BT_ASSERT_PRE(bt_component_port_name_is_unique(comp->output_ports, name), \ | |
31 | "Output port name is not unique: name=\"%s\", %![comp-]c", name, comp); | |
32 | ||
3230ee6b PP |
33 | typedef void (*bt_component_destroy_listener_func)( |
34 | struct bt_component *class, void *data); | |
35 | ||
36 | struct bt_component_destroy_listener { | |
37 | bt_component_destroy_listener_func func; | |
38 | void *data; | |
39 | }; | |
40 | ||
e5be10ef PP |
41 | struct bt_graph; |
42 | ||
633edee0 | 43 | struct bt_component { |
b8a06801 | 44 | struct bt_object base; |
fb2dcc52 | 45 | struct bt_component_class *class; |
0db5ca2c | 46 | GString *name; |
e874da19 | 47 | bt_logging_level log_level; |
584e4e78 | 48 | |
72b913fb | 49 | /* |
d3e4dcd8 PP |
50 | * Internal destroy function specific to a source, filter, or |
51 | * sink component object. | |
52 | */ | |
890882ef | 53 | void (*destroy)(struct bt_component *); |
d3e4dcd8 | 54 | |
72b913fb | 55 | /* User-defined data */ |
0777b693 | 56 | void *user_data; |
fec2a9f2 | 57 | |
72b913fb PP |
58 | /* Input and output ports (weak references) */ |
59 | GPtrArray *input_ports; | |
60 | GPtrArray *output_ports; | |
3230ee6b PP |
61 | |
62 | /* Array of struct bt_component_destroy_listener */ | |
63 | GArray *destroy_listeners; | |
36712f1d PP |
64 | |
65 | bool initialized; | |
72b913fb | 66 | }; |
38b48196 | 67 | |
e5be10ef PP |
68 | static inline |
69 | struct bt_graph *bt_component_borrow_graph(struct bt_component *comp) | |
70 | { | |
98b15851 | 71 | BT_ASSERT_DBG(comp); |
e5be10ef PP |
72 | return (void *) bt_object_borrow_parent(&comp->base); |
73 | } | |
74 | ||
36712f1d | 75 | BT_HIDDEN |
d94d92ac | 76 | int bt_component_create(struct bt_component_class *component_class, |
e874da19 PP |
77 | const char *name, bt_logging_level log_level, |
78 | struct bt_component **component); | |
36712f1d | 79 | |
0d8b4d8e | 80 | BT_HIDDEN |
d24d5663 PP |
81 | enum bt_component_class_port_connected_method_status |
82 | bt_component_port_connected( | |
bf55043c | 83 | struct bt_component *comp, |
0d8b4d8e PP |
84 | struct bt_port *self_port, struct bt_port *other_port); |
85 | ||
366e034f | 86 | BT_HIDDEN |
f60c8b34 | 87 | void bt_component_set_graph(struct bt_component *component, |
366e034f JG |
88 | struct bt_graph *graph); |
89 | ||
90 | BT_HIDDEN | |
0d72b8c3 | 91 | uint64_t bt_component_get_input_port_count(const struct bt_component *comp); |
366e034f JG |
92 | |
93 | BT_HIDDEN | |
0d72b8c3 | 94 | uint64_t bt_component_get_output_port_count(const struct bt_component *comp); |
366e034f JG |
95 | |
96 | BT_HIDDEN | |
d94d92ac PP |
97 | struct bt_port_input *bt_component_borrow_input_port_by_index( |
98 | struct bt_component *comp, uint64_t index); | |
366e034f JG |
99 | |
100 | BT_HIDDEN | |
d94d92ac PP |
101 | struct bt_port_output *bt_component_borrow_output_port_by_index( |
102 | struct bt_component *comp, uint64_t index); | |
366e034f JG |
103 | |
104 | BT_HIDDEN | |
d94d92ac PP |
105 | struct bt_port_input *bt_component_borrow_input_port_by_name( |
106 | struct bt_component *comp, const char *name); | |
366e034f JG |
107 | |
108 | BT_HIDDEN | |
d94d92ac PP |
109 | struct bt_port_output *bt_component_borrow_output_port_by_name( |
110 | struct bt_component *comp, const char *name); | |
366e034f | 111 | |
72b913fb | 112 | BT_HIDDEN |
d24d5663 | 113 | enum bt_self_component_add_port_status bt_component_add_input_port( |
3e9b0023 | 114 | struct bt_component *component, const char *name, |
8cc56726 | 115 | void *user_data, struct bt_port **port); |
72b913fb PP |
116 | |
117 | BT_HIDDEN | |
d24d5663 | 118 | enum bt_self_component_add_port_status bt_component_add_output_port( |
3e9b0023 | 119 | struct bt_component *component, const char *name, |
8cc56726 | 120 | void *user_data, struct bt_port **port); |
72b913fb | 121 | |
157a98ed SM |
122 | BT_HIDDEN |
123 | bool bt_component_port_name_is_unique(GPtrArray *ports, const char *name); | |
124 | ||
72b913fb | 125 | BT_HIDDEN |
d94d92ac PP |
126 | void bt_component_remove_port(struct bt_component *component, |
127 | struct bt_port *port); | |
72b913fb | 128 | |
3230ee6b PP |
129 | BT_HIDDEN |
130 | void bt_component_add_destroy_listener(struct bt_component *component, | |
131 | bt_component_destroy_listener_func func, void *data); | |
132 | ||
133 | BT_HIDDEN | |
134 | void bt_component_remove_destroy_listener(struct bt_component *component, | |
135 | bt_component_destroy_listener_func func, void *data); | |
136 | ||
6ac74c0c | 137 | #endif /* BABELTRACE_GRAPH_COMPONENT_INTERNAL_H */ |