Commit | Line | Data |
---|---|---|
6ac74c0c PP |
1 | #ifndef BABELTRACE_GRAPH_COMPONENT_INTERNAL_H |
2 | #define BABELTRACE_GRAPH_COMPONENT_INTERNAL_H | |
90354d3a JG |
3 | |
4 | /* | |
e2f7325d | 5 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> |
90354d3a JG |
6 | * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
7 | * | |
90354d3a JG |
8 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
9 | * of this software and associated documentation files (the "Software"), to deal | |
10 | * in the Software without restriction, including without limitation the rights | |
11 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
12 | * copies of the Software, and to permit persons to whom the Software is | |
13 | * furnished to do so, subject to the following conditions: | |
14 | * | |
15 | * The above copyright notice and this permission notice shall be included in | |
16 | * all copies or substantial portions of the Software. | |
17 | * | |
18 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
19 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
20 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
21 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
22 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
23 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
24 | * SOFTWARE. | |
25 | */ | |
26 | ||
91d81473 | 27 | #include "common/macros.h" |
3fadfbc0 | 28 | #include <babeltrace2/graph/component-const.h> |
578e048b | 29 | #include "lib/object.h" |
3fadfbc0 | 30 | #include <babeltrace2/types.h> |
e874da19 | 31 | #include <babeltrace2/logging.h> |
578e048b | 32 | #include "common/assert.h" |
0db5ca2c | 33 | #include <glib.h> |
38d02a17 | 34 | #include <stdio.h> |
90354d3a | 35 | |
578e048b MJ |
36 | #include "component-class.h" |
37 | #include "port.h" | |
38 | ||
3230ee6b PP |
39 | typedef void (*bt_component_destroy_listener_func)( |
40 | struct bt_component *class, void *data); | |
41 | ||
42 | struct bt_component_destroy_listener { | |
43 | bt_component_destroy_listener_func func; | |
44 | void *data; | |
45 | }; | |
46 | ||
e5be10ef PP |
47 | struct bt_graph; |
48 | ||
633edee0 | 49 | struct bt_component { |
b8a06801 | 50 | struct bt_object base; |
fb2dcc52 | 51 | struct bt_component_class *class; |
0db5ca2c | 52 | GString *name; |
e874da19 | 53 | bt_logging_level log_level; |
584e4e78 | 54 | |
72b913fb | 55 | /* |
d3e4dcd8 PP |
56 | * Internal destroy function specific to a source, filter, or |
57 | * sink component object. | |
58 | */ | |
890882ef | 59 | void (*destroy)(struct bt_component *); |
d3e4dcd8 | 60 | |
72b913fb | 61 | /* User-defined data */ |
0777b693 | 62 | void *user_data; |
fec2a9f2 | 63 | |
72b913fb PP |
64 | /* Input and output ports (weak references) */ |
65 | GPtrArray *input_ports; | |
66 | GPtrArray *output_ports; | |
3230ee6b PP |
67 | |
68 | /* Array of struct bt_component_destroy_listener */ | |
69 | GArray *destroy_listeners; | |
36712f1d PP |
70 | |
71 | bool initialized; | |
72b913fb | 72 | }; |
38b48196 | 73 | |
e5be10ef PP |
74 | static inline |
75 | struct bt_graph *bt_component_borrow_graph(struct bt_component *comp) | |
76 | { | |
77 | BT_ASSERT(comp); | |
78 | return (void *) bt_object_borrow_parent(&comp->base); | |
79 | } | |
80 | ||
36712f1d | 81 | BT_HIDDEN |
d94d92ac | 82 | int bt_component_create(struct bt_component_class *component_class, |
e874da19 PP |
83 | const char *name, bt_logging_level log_level, |
84 | struct bt_component **component); | |
36712f1d | 85 | |
0d8b4d8e | 86 | BT_HIDDEN |
d94d92ac | 87 | enum bt_self_component_status bt_component_port_connected( |
bf55043c | 88 | struct bt_component *comp, |
0d8b4d8e PP |
89 | struct bt_port *self_port, struct bt_port *other_port); |
90 | ||
366e034f | 91 | BT_HIDDEN |
f60c8b34 | 92 | void bt_component_set_graph(struct bt_component *component, |
366e034f JG |
93 | struct bt_graph *graph); |
94 | ||
95 | BT_HIDDEN | |
0d72b8c3 | 96 | uint64_t bt_component_get_input_port_count(const struct bt_component *comp); |
366e034f JG |
97 | |
98 | BT_HIDDEN | |
0d72b8c3 | 99 | uint64_t bt_component_get_output_port_count(const struct bt_component *comp); |
366e034f JG |
100 | |
101 | BT_HIDDEN | |
d94d92ac PP |
102 | struct bt_port_input *bt_component_borrow_input_port_by_index( |
103 | struct bt_component *comp, uint64_t index); | |
366e034f JG |
104 | |
105 | BT_HIDDEN | |
d94d92ac PP |
106 | struct bt_port_output *bt_component_borrow_output_port_by_index( |
107 | struct bt_component *comp, uint64_t index); | |
366e034f JG |
108 | |
109 | BT_HIDDEN | |
d94d92ac PP |
110 | struct bt_port_input *bt_component_borrow_input_port_by_name( |
111 | struct bt_component *comp, const char *name); | |
366e034f JG |
112 | |
113 | BT_HIDDEN | |
d94d92ac PP |
114 | struct bt_port_output *bt_component_borrow_output_port_by_name( |
115 | struct bt_component *comp, const char *name); | |
366e034f | 116 | |
72b913fb | 117 | BT_HIDDEN |
8cc56726 | 118 | enum bt_self_component_status bt_component_add_input_port( |
3e9b0023 | 119 | struct bt_component *component, const char *name, |
8cc56726 | 120 | void *user_data, struct bt_port **port); |
72b913fb PP |
121 | |
122 | BT_HIDDEN | |
8cc56726 | 123 | enum bt_self_component_status bt_component_add_output_port( |
3e9b0023 | 124 | struct bt_component *component, const char *name, |
8cc56726 | 125 | void *user_data, struct bt_port **port); |
72b913fb PP |
126 | |
127 | BT_HIDDEN | |
d94d92ac PP |
128 | void bt_component_remove_port(struct bt_component *component, |
129 | struct bt_port *port); | |
72b913fb | 130 | |
3230ee6b PP |
131 | BT_HIDDEN |
132 | void bt_component_add_destroy_listener(struct bt_component *component, | |
133 | bt_component_destroy_listener_func func, void *data); | |
134 | ||
135 | BT_HIDDEN | |
136 | void bt_component_remove_destroy_listener(struct bt_component *component, | |
137 | bt_component_destroy_listener_func func, void *data); | |
138 | ||
6ac74c0c | 139 | #endif /* BABELTRACE_GRAPH_COMPONENT_INTERNAL_H */ |