1 #ifndef BABELTRACE_GRAPH_GRAPH_H
2 #define BABELTRACE_GRAPH_GRAPH_H
5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
6 * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
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:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
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
28 * For bt_bool, bt_component, bt_component_class,
29 * bt_component_class_filter, bt_component_class_sink,
30 * bt_component_class_source, bt_component_filter, bt_component_sink,
31 * bt_component_source, bt_connection, bt_graph, bt_port_input,
32 * bt_port_output, bt_value
34 #include <babeltrace2/types.h>
36 /* For bt_graph_status */
37 #include <babeltrace2/graph/graph-const.h>
39 /* For bt_logging_level */
40 #include <babeltrace2/logging.h>
46 typedef enum bt_graph_listener_status
{
47 BT_GRAPH_LISTENER_STATUS_OK
= 0,
48 BT_GRAPH_LISTENER_STATUS_ERROR
= -1,
49 BT_GRAPH_LISTENER_STATUS_NOMEM
= -12,
50 } bt_graph_listener_status
;
52 typedef bt_graph_listener_status
53 (*bt_graph_filter_component_input_port_added_listener_func
)(
54 const bt_component_filter
*component
,
55 const bt_port_input
*port
, void *data
);
57 typedef bt_graph_listener_status
58 (*bt_graph_sink_component_input_port_added_listener_func
)(
59 const bt_component_sink
*component
,
60 const bt_port_input
*port
, void *data
);
62 typedef bt_graph_listener_status
63 (*bt_graph_source_component_output_port_added_listener_func
)(
64 const bt_component_source
*component
,
65 const bt_port_output
*port
, void *data
);
67 typedef bt_graph_listener_status
68 (*bt_graph_filter_component_output_port_added_listener_func
)(
69 const bt_component_filter
*component
,
70 const bt_port_output
*port
, void *data
);
72 typedef bt_graph_listener_status
73 (*bt_graph_source_filter_component_ports_connected_listener_func
)(
74 const bt_component_source
*source_component
,
75 const bt_component_filter
*filter_component
,
76 const bt_port_output
*upstream_port
,
77 const bt_port_input
*downstream_port
, void *data
);
79 typedef bt_graph_listener_status
80 (*bt_graph_source_sink_component_ports_connected_listener_func
)(
81 const bt_component_source
*source_component
,
82 const bt_component_sink
*sink_component
,
83 const bt_port_output
*upstream_port
,
84 const bt_port_input
*downstream_port
, void *data
);
86 typedef bt_graph_listener_status
87 (*bt_graph_filter_filter_component_ports_connected_listener_func
)(
88 const bt_component_filter
*filter_component_upstream
,
89 const bt_component_filter
*filter_component_downstream
,
90 const bt_port_output
*upstream_port
,
91 const bt_port_input
*downstream_port
,
94 typedef bt_graph_listener_status
95 (*bt_graph_filter_sink_component_ports_connected_listener_func
)(
96 const bt_component_filter
*filter_component
,
97 const bt_component_sink
*sink_component
,
98 const bt_port_output
*upstream_port
,
99 const bt_port_input
*downstream_port
, void *data
);
101 typedef void (* bt_graph_listener_removed_func
)(void *data
);
103 extern bt_graph
*bt_graph_create(void);
105 extern bt_graph_status
bt_graph_add_source_component(bt_graph
*graph
,
106 const bt_component_class_source
*component_class
,
107 const char *name
, const bt_value
*params
,
108 bt_logging_level log_level
, const bt_component_source
**component
);
110 extern bt_graph_status
bt_graph_add_source_component_with_init_method_data(
112 const bt_component_class_source
*component_class
,
113 const char *name
, const bt_value
*params
,
114 void *init_method_data
, bt_logging_level log_level
,
115 const bt_component_source
**component
);
117 extern bt_graph_status
bt_graph_add_filter_component(bt_graph
*graph
,
118 const bt_component_class_filter
*component_class
,
119 const char *name
, const bt_value
*params
,
120 bt_logging_level log_level
,
121 const bt_component_filter
**component
);
123 extern bt_graph_status
bt_graph_add_filter_component_with_init_method_data(
125 const bt_component_class_filter
*component_class
,
126 const char *name
, const bt_value
*params
,
127 void *init_method_data
, bt_logging_level log_level
,
128 const bt_component_filter
**component
);
130 extern bt_graph_status
bt_graph_add_sink_component(
131 bt_graph
*graph
, const bt_component_class_sink
*component_class
,
132 const char *name
, const bt_value
*params
,
133 bt_logging_level log_level
,
134 const bt_component_sink
**component
);
136 extern bt_graph_status
bt_graph_add_sink_component_with_init_method_data(
137 bt_graph
*graph
, const bt_component_class_sink
*component_class
,
138 const char *name
, const bt_value
*params
,
139 void *init_method_data
, bt_logging_level log_level
,
140 const bt_component_sink
**component
);
142 extern bt_graph_status
bt_graph_connect_ports(bt_graph
*graph
,
143 const bt_port_output
*upstream
,
144 const bt_port_input
*downstream
,
145 const bt_connection
**connection
);
147 extern bt_graph_status
bt_graph_run(bt_graph
*graph
);
149 extern bt_graph_status
bt_graph_consume(bt_graph
*graph
);
151 extern bt_graph_status
bt_graph_add_filter_component_input_port_added_listener(
153 bt_graph_filter_component_input_port_added_listener_func listener
,
154 bt_graph_listener_removed_func listener_removed
, void *data
,
157 extern bt_graph_status
bt_graph_add_sink_component_input_port_added_listener(
159 bt_graph_sink_component_input_port_added_listener_func listener
,
160 bt_graph_listener_removed_func listener_removed
, void *data
,
163 extern bt_graph_status
bt_graph_add_source_component_output_port_added_listener(
165 bt_graph_source_component_output_port_added_listener_func listener
,
166 bt_graph_listener_removed_func listener_removed
, void *data
,
169 extern bt_graph_status
bt_graph_add_filter_component_output_port_added_listener(
171 bt_graph_filter_component_output_port_added_listener_func listener
,
172 bt_graph_listener_removed_func listener_removed
, void *data
,
175 extern bt_graph_status
176 bt_graph_add_source_filter_component_ports_connected_listener(
178 bt_graph_source_filter_component_ports_connected_listener_func listener
,
179 bt_graph_listener_removed_func listener_removed
, void *data
,
182 extern bt_graph_status
183 bt_graph_add_filter_filter_component_ports_connected_listener(
185 bt_graph_filter_filter_component_ports_connected_listener_func listener
,
186 bt_graph_listener_removed_func listener_removed
, void *data
,
189 extern bt_graph_status
190 bt_graph_add_source_sink_component_ports_connected_listener(
192 bt_graph_source_sink_component_ports_connected_listener_func listener
,
193 bt_graph_listener_removed_func listener_removed
, void *data
,
196 extern bt_graph_status
197 bt_graph_add_filter_sink_component_ports_connected_listener(
199 bt_graph_filter_sink_component_ports_connected_listener_func listener
,
200 bt_graph_listener_removed_func listener_removed
, void *data
,
203 extern bt_graph_status
bt_graph_cancel(bt_graph
*graph
);
209 #endif /* BABELTRACE_GRAPH_GRAPH_H */