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" |
43c59509 | 28 | #include <babeltrace2/graph/component.h> |
d24d5663 | 29 | #include <babeltrace2/graph/component-class.h> |
578e048b | 30 | #include "lib/object.h" |
3fadfbc0 | 31 | #include <babeltrace2/types.h> |
e874da19 | 32 | #include <babeltrace2/logging.h> |
578e048b | 33 | #include "common/assert.h" |
0db5ca2c | 34 | #include <glib.h> |
c4f23e30 | 35 | #include <stdbool.h> |
38d02a17 | 36 | #include <stdio.h> |
90354d3a | 37 | |
578e048b MJ |
38 | #include "component-class.h" |
39 | #include "port.h" | |
40 | ||
3230ee6b PP |
41 | typedef void (*bt_component_destroy_listener_func)( |
42 | struct bt_component *class, void *data); | |
43 | ||
44 | struct bt_component_destroy_listener { | |
45 | bt_component_destroy_listener_func func; | |
46 | void *data; | |
47 | }; | |
48 | ||
e5be10ef PP |
49 | struct bt_graph; |
50 | ||
633edee0 | 51 | struct bt_component { |
b8a06801 | 52 | struct bt_object base; |
fb2dcc52 | 53 | struct bt_component_class *class; |
0db5ca2c | 54 | GString *name; |
e874da19 | 55 | bt_logging_level log_level; |
584e4e78 | 56 | |
72b913fb | 57 | /* |
d3e4dcd8 PP |
58 | * Internal destroy function specific to a source, filter, or |
59 | * sink component object. | |
60 | */ | |
890882ef | 61 | void (*destroy)(struct bt_component *); |
d3e4dcd8 | 62 | |
72b913fb | 63 | /* User-defined data */ |
0777b693 | 64 | void *user_data; |
fec2a9f2 | 65 | |
72b913fb PP |
66 | /* Input and output ports (weak references) */ |
67 | GPtrArray *input_ports; | |
68 | GPtrArray *output_ports; | |
3230ee6b PP |
69 | |
70 | /* Array of struct bt_component_destroy_listener */ | |
71 | GArray *destroy_listeners; | |
36712f1d PP |
72 | |
73 | bool initialized; | |
72b913fb | 74 | }; |
38b48196 | 75 | |
e5be10ef PP |
76 | static inline |
77 | struct bt_graph *bt_component_borrow_graph(struct bt_component *comp) | |
78 | { | |
98b15851 | 79 | BT_ASSERT_DBG(comp); |
e5be10ef PP |
80 | return (void *) bt_object_borrow_parent(&comp->base); |
81 | } | |
82 | ||
36712f1d | 83 | BT_HIDDEN |
d94d92ac | 84 | int bt_component_create(struct bt_component_class *component_class, |
e874da19 PP |
85 | const char *name, bt_logging_level log_level, |
86 | struct bt_component **component); | |
36712f1d | 87 | |
0d8b4d8e | 88 | BT_HIDDEN |
d24d5663 PP |
89 | enum bt_component_class_port_connected_method_status |
90 | bt_component_port_connected( | |
bf55043c | 91 | struct bt_component *comp, |
0d8b4d8e PP |
92 | struct bt_port *self_port, struct bt_port *other_port); |
93 | ||
366e034f | 94 | BT_HIDDEN |
f60c8b34 | 95 | void bt_component_set_graph(struct bt_component *component, |
366e034f JG |
96 | struct bt_graph *graph); |
97 | ||
98 | BT_HIDDEN | |
0d72b8c3 | 99 | uint64_t bt_component_get_input_port_count(const struct bt_component *comp); |
366e034f JG |
100 | |
101 | BT_HIDDEN | |
0d72b8c3 | 102 | uint64_t bt_component_get_output_port_count(const struct bt_component *comp); |
366e034f JG |
103 | |
104 | BT_HIDDEN | |
d94d92ac PP |
105 | struct bt_port_input *bt_component_borrow_input_port_by_index( |
106 | struct bt_component *comp, uint64_t index); | |
366e034f JG |
107 | |
108 | BT_HIDDEN | |
d94d92ac PP |
109 | struct bt_port_output *bt_component_borrow_output_port_by_index( |
110 | struct bt_component *comp, uint64_t index); | |
366e034f JG |
111 | |
112 | BT_HIDDEN | |
d94d92ac PP |
113 | struct bt_port_input *bt_component_borrow_input_port_by_name( |
114 | struct bt_component *comp, const char *name); | |
366e034f JG |
115 | |
116 | BT_HIDDEN | |
d94d92ac PP |
117 | struct bt_port_output *bt_component_borrow_output_port_by_name( |
118 | struct bt_component *comp, const char *name); | |
366e034f | 119 | |
72b913fb | 120 | BT_HIDDEN |
d24d5663 | 121 | enum bt_self_component_add_port_status bt_component_add_input_port( |
3e9b0023 | 122 | struct bt_component *component, const char *name, |
8cc56726 | 123 | void *user_data, struct bt_port **port); |
72b913fb PP |
124 | |
125 | BT_HIDDEN | |
d24d5663 | 126 | enum bt_self_component_add_port_status bt_component_add_output_port( |
3e9b0023 | 127 | struct bt_component *component, const char *name, |
8cc56726 | 128 | void *user_data, struct bt_port **port); |
72b913fb PP |
129 | |
130 | BT_HIDDEN | |
d94d92ac PP |
131 | void bt_component_remove_port(struct bt_component *component, |
132 | struct bt_port *port); | |
72b913fb | 133 | |
3230ee6b PP |
134 | BT_HIDDEN |
135 | void bt_component_add_destroy_listener(struct bt_component *component, | |
136 | bt_component_destroy_listener_func func, void *data); | |
137 | ||
138 | BT_HIDDEN | |
139 | void bt_component_remove_destroy_listener(struct bt_component *component, | |
140 | bt_component_destroy_listener_func func, void *data); | |
141 | ||
6ac74c0c | 142 | #endif /* BABELTRACE_GRAPH_COMPONENT_INTERNAL_H */ |