1 #ifndef BABELTRACE_GRAPH_GRAPH_H
2 #define BABELTRACE_GRAPH_GRAPH_H
5 * BabelTrace - Babeltrace Graph Interface
7 * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
9 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
11 * Permission is hereby granted, free of charge, to any person obtaining a copy
12 * of this software and associated documentation files (the "Software"), to deal
13 * in the Software without restriction, including without limitation the rights
14 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15 * copies of the Software, and to permit persons to whom the Software is
16 * furnished to do so, subject to the following conditions:
18 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
31 #include <babeltrace/types.h>
40 struct bt_component_class
;
42 enum bt_graph_status
{
43 BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION
= 111,
45 BT_GRAPH_STATUS_CANCELED
= 125,
46 /** No sink can consume at the moment. */
47 BT_GRAPH_STATUS_AGAIN
= 11,
48 /** Downstream component does not support multiple inputs. */
49 BT_GRAPH_STATUS_END
= 1,
50 BT_GRAPH_STATUS_OK
= 0,
51 /** Invalid arguments. */
52 BT_GRAPH_STATUS_INVALID
= -22,
53 /** No sink in graph. */
54 BT_GRAPH_STATUS_NO_SINK
= -6,
56 BT_GRAPH_STATUS_ERROR
= -1,
57 BT_GRAPH_STATUS_CANNOT_CONSUME
= -2,
58 BT_GRAPH_STATUS_NOMEM
= -12,
61 typedef void (*bt_graph_port_added_listener
)(struct bt_port
*port
,
63 typedef void (*bt_graph_port_removed_listener
)(struct bt_component
*component
,
64 struct bt_port
*port
, void *data
);
65 typedef void (*bt_graph_ports_connected_listener
)(struct bt_port
*upstream_port
,
66 struct bt_port
*downstream_port
, void *data
);
67 typedef void (*bt_graph_ports_disconnected_listener
)(
68 struct bt_component
*upstream_component
,
69 struct bt_component
*downstream_component
,
70 struct bt_port
*upstream_port
, struct bt_port
*downstream_port
,
72 typedef void (* bt_graph_listener_removed
)(void *data
);
74 extern struct bt_graph
*bt_graph_create(void);
76 extern enum bt_graph_status
bt_graph_add_component(
77 struct bt_graph
*graph
,
78 struct bt_component_class
*component_class
,
79 const char *name
, struct bt_value
*params
,
80 struct bt_component
**component
);
82 extern enum bt_graph_status
bt_graph_add_component_with_init_method_data(
83 struct bt_graph
*graph
,
84 struct bt_component_class
*component_class
,
85 const char *name
, struct bt_value
*params
,
86 void *init_method_data
,
87 struct bt_component
**component
);
90 * Creates a connection between two components using the two ports specified
91 * and adds the connection and components (if not already added) to the graph.
93 extern enum bt_graph_status
bt_graph_connect_ports(struct bt_graph
*graph
,
94 struct bt_port
*upstream
, struct bt_port
*downstream
,
95 struct bt_connection
**connection
);
98 * Run graph to completion or until a single sink is left and "AGAIN" is received.
100 * Runs "bt_component_sink_consume()" on all sinks in round-robin until they all
101 * indicate that the end is reached or that an error occured.
103 extern enum bt_graph_status
bt_graph_run(struct bt_graph
*graph
);
106 * Runs "bt_component_sink_consume()" on the graph's sinks. Each invokation will
107 * invoke "bt_component_sink_consume()" on the next sink, in round-robin, until
108 * they all indicated that the end is reached.
110 extern enum bt_graph_status
bt_graph_consume(struct bt_graph
*graph
);
112 extern int bt_graph_add_port_added_listener(struct bt_graph
*graph
,
113 bt_graph_port_added_listener listener
,
114 bt_graph_listener_removed listener_removed
, void *data
);
116 extern int bt_graph_add_port_removed_listener(struct bt_graph
*graph
,
117 bt_graph_port_removed_listener listener
,
118 bt_graph_listener_removed listener_removed
, void *data
);
120 extern int bt_graph_add_ports_connected_listener(struct bt_graph
*graph
,
121 bt_graph_ports_connected_listener listener
,
122 bt_graph_listener_removed listener_removed
, void *data
);
124 extern int bt_graph_add_ports_disconnected_listener(struct bt_graph
*graph
,
125 bt_graph_ports_disconnected_listener listener
,
126 bt_graph_listener_removed listener_removed
, void *data
);
128 extern enum bt_graph_status
bt_graph_cancel(struct bt_graph
*graph
);
129 extern bt_bool
bt_graph_is_canceled(struct bt_graph
*graph
);
135 #endif /* BABELTRACE_GRAPH_GRAPH_H */