Commit | Line | Data |
---|---|---|
1ca80abd PP |
1 | #ifndef BABELTRACE_GRAPH_GRAPH_H |
2 | #define BABELTRACE_GRAPH_GRAPH_H | |
c0418dd9 JG |
3 | |
4 | /* | |
f60c8b34 | 5 | * BabelTrace - Babeltrace Graph Interface |
c0418dd9 | 6 | * |
f60c8b34 | 7 | * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
c0418dd9 JG |
8 | * |
9 | * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
10 | * | |
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: | |
17 | * | |
18 | * The above copyright notice and this permission notice shall be included in | |
19 | * all copies or substantial portions of the Software. | |
20 | * | |
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 | |
27 | * SOFTWARE. | |
28 | */ | |
29 | ||
e0831b38 | 30 | /* For bt_bool */ |
202a3a13 | 31 | #include <babeltrace/types.h> |
c0418dd9 JG |
32 | |
33 | #ifdef __cplusplus | |
34 | extern "C" { | |
35 | #endif | |
36 | ||
f60c8b34 JG |
37 | struct bt_port; |
38 | struct bt_connection; | |
e0831b38 PP |
39 | struct bt_component; |
40 | struct bt_component_class; | |
f7c3ac09 | 41 | struct bt_value; |
c0418dd9 | 42 | |
f60c8b34 | 43 | enum bt_graph_status { |
a256a42d | 44 | BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION = 111, |
4a6b963e PP |
45 | /** Canceled. */ |
46 | BT_GRAPH_STATUS_CANCELED = 125, | |
72b913fb | 47 | /** No sink can consume at the moment. */ |
fe8ad2b6 | 48 | BT_GRAPH_STATUS_AGAIN = 11, |
f60c8b34 JG |
49 | /** Downstream component does not support multiple inputs. */ |
50 | BT_GRAPH_STATUS_END = 1, | |
51 | BT_GRAPH_STATUS_OK = 0, | |
f60c8b34 | 52 | /** Invalid arguments. */ |
fe8ad2b6 | 53 | BT_GRAPH_STATUS_INVALID = -22, |
f60c8b34 | 54 | /** No sink in graph. */ |
fe8ad2b6 | 55 | BT_GRAPH_STATUS_NO_SINK = -6, |
f60c8b34 | 56 | /** General error. */ |
fe8ad2b6 | 57 | BT_GRAPH_STATUS_ERROR = -1, |
9ef22b36 | 58 | BT_GRAPH_STATUS_CANNOT_CONSUME = -2, |
a256a42d | 59 | BT_GRAPH_STATUS_NOMEM = -12, |
f60c8b34 | 60 | }; |
c0418dd9 | 61 | |
1bf957a0 PP |
62 | typedef void (*bt_graph_port_added_listener)(struct bt_port *port, |
63 | void *data); | |
64 | typedef void (*bt_graph_port_removed_listener)(struct bt_component *component, | |
65 | struct bt_port *port, void *data); | |
f345f8bb PP |
66 | typedef void (*bt_graph_ports_connected_listener)(struct bt_port *upstream_port, |
67 | struct bt_port *downstream_port, void *data); | |
68 | typedef void (*bt_graph_ports_disconnected_listener)( | |
69 | struct bt_component *upstream_component, | |
70 | struct bt_component *downstream_component, | |
71 | struct bt_port *upstream_port, struct bt_port *downstream_port, | |
1bf957a0 | 72 | void *data); |
eb87cce7 | 73 | typedef void (* bt_graph_listener_removed)(void *data); |
1bf957a0 | 74 | |
f60c8b34 | 75 | extern struct bt_graph *bt_graph_create(void); |
c0418dd9 | 76 | |
36712f1d PP |
77 | extern enum bt_graph_status bt_graph_add_component( |
78 | struct bt_graph *graph, | |
79 | struct bt_component_class *component_class, | |
80 | const char *name, struct bt_value *params, | |
81 | struct bt_component **component); | |
82 | ||
83 | extern enum bt_graph_status bt_graph_add_component_with_init_method_data( | |
84 | struct bt_graph *graph, | |
85 | struct bt_component_class *component_class, | |
86 | const char *name, struct bt_value *params, | |
87 | void *init_method_data, | |
88 | struct bt_component **component); | |
89 | ||
c0418dd9 | 90 | /** |
f60c8b34 JG |
91 | * Creates a connection between two components using the two ports specified |
92 | * and adds the connection and components (if not already added) to the graph. | |
c0418dd9 | 93 | */ |
a256a42d PP |
94 | extern enum bt_graph_status bt_graph_connect_ports(struct bt_graph *graph, |
95 | struct bt_port *upstream, struct bt_port *downstream, | |
96 | struct bt_connection **connection); | |
c0418dd9 | 97 | |
c0418dd9 | 98 | /** |
f60c8b34 JG |
99 | * Run graph to completion or until a single sink is left and "AGAIN" is received. |
100 | * | |
c0418dd9 | 101 | * Runs "bt_component_sink_consume()" on all sinks in round-robin until they all |
f60c8b34 JG |
102 | * indicate that the end is reached or that an error occured. |
103 | */ | |
72b913fb | 104 | extern enum bt_graph_status bt_graph_run(struct bt_graph *graph); |
f60c8b34 JG |
105 | |
106 | /** | |
107 | * Runs "bt_component_sink_consume()" on the graph's sinks. Each invokation will | |
108 | * invoke "bt_component_sink_consume()" on the next sink, in round-robin, until | |
109 | * they all indicated that the end is reached. | |
c0418dd9 | 110 | */ |
72b913fb | 111 | extern enum bt_graph_status bt_graph_consume(struct bt_graph *graph); |
c0418dd9 | 112 | |
0d107cdd | 113 | extern int bt_graph_add_port_added_listener(struct bt_graph *graph, |
eb87cce7 PP |
114 | bt_graph_port_added_listener listener, |
115 | bt_graph_listener_removed listener_removed, void *data); | |
1bf957a0 | 116 | |
0d107cdd | 117 | extern int bt_graph_add_port_removed_listener(struct bt_graph *graph, |
eb87cce7 PP |
118 | bt_graph_port_removed_listener listener, |
119 | bt_graph_listener_removed listener_removed, void *data); | |
1bf957a0 | 120 | |
0d107cdd | 121 | extern int bt_graph_add_ports_connected_listener(struct bt_graph *graph, |
eb87cce7 PP |
122 | bt_graph_ports_connected_listener listener, |
123 | bt_graph_listener_removed listener_removed, void *data); | |
1bf957a0 | 124 | |
0d107cdd | 125 | extern int bt_graph_add_ports_disconnected_listener(struct bt_graph *graph, |
eb87cce7 PP |
126 | bt_graph_ports_disconnected_listener listener, |
127 | bt_graph_listener_removed listener_removed, void *data); | |
1bf957a0 | 128 | |
202a3a13 PP |
129 | extern enum bt_graph_status bt_graph_cancel(struct bt_graph *graph); |
130 | extern bt_bool bt_graph_is_canceled(struct bt_graph *graph); | |
131 | ||
c0418dd9 JG |
132 | #ifdef __cplusplus |
133 | } | |
134 | #endif | |
135 | ||
1ca80abd | 136 | #endif /* BABELTRACE_GRAPH_GRAPH_H */ |