1 #ifndef BABELTRACE_COMPONENT_GRAPH_H
2 #define BABELTRACE_COMPONENT_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
30 #include <babeltrace/graph/component.h>
39 enum bt_graph_status
{
40 /** No sink can consume at the moment. */
41 BT_GRAPH_STATUS_AGAIN
= 11,
42 /** Downstream component does not support multiple inputs. */
43 BT_GRAPH_STATUS_END
= 1,
44 BT_GRAPH_STATUS_OK
= 0,
45 /** Component is already part of another graph. */
46 BT_GRAPH_STATUS_ALREADY_IN_A_GRAPH
= -2,
47 /** Invalid arguments. */
48 BT_GRAPH_STATUS_INVALID
= -22,
49 /** No sink in graph. */
50 BT_GRAPH_STATUS_NO_SINK
= -6,
52 BT_GRAPH_STATUS_ERROR
= -1,
55 typedef void (*bt_graph_port_added_listener
)(struct bt_port
*port
,
57 typedef void (*bt_graph_port_removed_listener
)(struct bt_component
*component
,
58 struct bt_port
*port
, void *data
);
59 typedef void (*bt_graph_ports_connected_listener
)(struct bt_port
*upstream_port
,
60 struct bt_port
*downstream_port
, void *data
);
61 typedef void (*bt_graph_ports_disconnected_listener
)(
62 struct bt_component
*upstream_component
,
63 struct bt_component
*downstream_component
,
64 struct bt_port
*upstream_port
, struct bt_port
*downstream_port
,
67 extern struct bt_graph
*bt_graph_create(void);
70 * Creates a connection between two components using the two ports specified
71 * and adds the connection and components (if not already added) to the graph.
73 extern struct bt_connection
*bt_graph_connect_ports(struct bt_graph
*graph
,
74 struct bt_port
*upstream
,
75 struct bt_port
*downstream
);
78 * Add a component as a "sibling" of the origin component. Sibling share
79 * connections equivalent to each other at the time of connection (same
80 * upstream and downstream ports).
82 extern enum bt_graph_status
bt_graph_add_component_as_sibling(
83 struct bt_graph
*graph
, struct bt_component
*origin
,
84 struct bt_component
*new_component
);
87 * Run graph to completion or until a single sink is left and "AGAIN" is received.
89 * Runs "bt_component_sink_consume()" on all sinks in round-robin until they all
90 * indicate that the end is reached or that an error occured.
92 extern enum bt_graph_status
bt_graph_run(struct bt_graph
*graph
);
95 * Runs "bt_component_sink_consume()" on the graph's sinks. Each invokation will
96 * invoke "bt_component_sink_consume()" on the next sink, in round-robin, until
97 * they all indicated that the end is reached.
99 extern enum bt_graph_status
bt_graph_consume(struct bt_graph
*graph
);
101 extern enum bt_graph_status
bt_graph_add_port_added_listener(
102 struct bt_graph
*graph
,
103 bt_graph_port_added_listener listener
, void *data
);
105 extern enum bt_graph_status
bt_graph_add_port_removed_listener(
106 struct bt_graph
*graph
,
107 bt_graph_port_removed_listener listener
, void *data
);
109 extern enum bt_graph_status
bt_graph_add_ports_connected_listener(
110 struct bt_graph
*graph
,
111 bt_graph_ports_connected_listener listener
, void *data
);
113 extern enum bt_graph_status
bt_graph_add_ports_disconnected_listener(
114 struct bt_graph
*graph
,
115 bt_graph_ports_disconnected_listener listener
, void *data
);
121 #endif /* BABELTRACE_COMPONENT_GRAPH_H */