Make bt_graph_connect_ports() return a status code
[babeltrace.git] / include / babeltrace / graph / graph-internal.h
CommitLineData
33b34c43
PP
1#ifndef BABELTRACE_COMPONENT_COMPONENT_GRAPH_INTERNAL_H
2#define BABELTRACE_COMPONENT_COMPONENT_GRAPH_INTERNAL_H
c0418dd9
JG
3
4/*
5 * BabelTrace - Component Graph Internal
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
b2e0c907 30#include <babeltrace/graph/graph.h>
a256a42d 31#include <babeltrace/graph/component-status.h>
c0418dd9
JG
32#include <babeltrace/babeltrace-internal.h>
33#include <babeltrace/object-internal.h>
a256a42d 34#include <stdlib.h>
c0418dd9
JG
35#include <glib.h>
36
1bf957a0
PP
37struct bt_component;
38struct bt_port;
39
f60c8b34
JG
40struct bt_graph {
41 /**
42 * A component graph contains components and point-to-point connection
43 * between these components.
c0418dd9 44 *
f60c8b34
JG
45 * In terms of ownership:
46 * 1) The graph is the components' parent,
47 * 2) The graph is the connnections' parent,
48 * 3) Components share the ownership of their connections,
49 * 4) A connection holds weak references to its two component endpoints.
c0418dd9 50 */
f60c8b34
JG
51 struct bt_object base;
52
53 /* Array of pointers to bt_connection. */
54 GPtrArray *connections;
55 /* Array of pointers to bt_component. */
56 GPtrArray *components;
57 /* Queue of pointers (weak references) to sink bt_components. */
58 GQueue *sinks_to_consume;
1bf957a0 59
202a3a13
PP
60 bt_bool canceled;
61
1bf957a0
PP
62 struct {
63 GArray *port_added;
64 GArray *port_removed;
f345f8bb
PP
65 GArray *ports_connected;
66 GArray *ports_disconnected;
1bf957a0 67 } listeners;
c0418dd9
JG
68};
69
1bf957a0
PP
70BT_HIDDEN
71void bt_graph_notify_port_added(struct bt_graph *graph, struct bt_port *port);
72
73BT_HIDDEN
74void bt_graph_notify_port_removed(struct bt_graph *graph,
75 struct bt_component *comp, struct bt_port *port);
76
77BT_HIDDEN
f345f8bb
PP
78void bt_graph_notify_ports_connected(struct bt_graph *graph,
79 struct bt_port *upstream_port, struct bt_port *downstream_port);
1bf957a0
PP
80
81BT_HIDDEN
f345f8bb
PP
82void bt_graph_notify_ports_disconnected(struct bt_graph *graph,
83 struct bt_component *upstream_comp,
84 struct bt_component *downstream_comp,
85 struct bt_port *upstream_port,
86 struct bt_port *downstream_port);
1bf957a0 87
f167d3c0
PP
88BT_HIDDEN
89void bt_graph_remove_connection(struct bt_graph *graph,
90 struct bt_connection *connection);
91
262e5473
PP
92static inline
93const char *bt_graph_status_string(enum bt_graph_status status)
94{
95 switch (status) {
96 case BT_GRAPH_STATUS_CANCELED:
97 return "BT_GRAPH_STATUS_CANCELED";
98 case BT_GRAPH_STATUS_AGAIN:
99 return "BT_GRAPH_STATUS_AGAIN";
100 case BT_GRAPH_STATUS_END:
101 return "BT_GRAPH_STATUS_END";
102 case BT_GRAPH_STATUS_OK:
103 return "BT_GRAPH_STATUS_OK";
104 case BT_GRAPH_STATUS_ALREADY_IN_A_GRAPH:
105 return "BT_GRAPH_STATUS_ALREADY_IN_A_GRAPH";
106 case BT_GRAPH_STATUS_INVALID:
107 return "BT_GRAPH_STATUS_INVALID";
108 case BT_GRAPH_STATUS_NO_SINK:
109 return "BT_GRAPH_STATUS_NO_SINK";
110 case BT_GRAPH_STATUS_ERROR:
111 return "BT_GRAPH_STATUS_ERROR";
a256a42d
PP
112 case BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION:
113 return "BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION";
114 case BT_GRAPH_STATUS_NOMEM:
115 return "BT_GRAPH_STATUS_NOMEM";
262e5473
PP
116 default:
117 return "(unknown)";
118 }
119}
120
a256a42d
PP
121static inline
122enum bt_graph_status bt_graph_status_from_component_status(
123 enum bt_component_status comp_status)
124{
125 switch (comp_status) {
126 case BT_COMPONENT_STATUS_OK:
127 return BT_GRAPH_STATUS_OK;
128 case BT_COMPONENT_STATUS_END:
129 return BT_GRAPH_STATUS_END;
130 case BT_COMPONENT_STATUS_AGAIN:
131 return BT_GRAPH_STATUS_AGAIN;
132 case BT_COMPONENT_STATUS_REFUSE_PORT_CONNECTION:
133 return BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION;
134 case BT_COMPONENT_STATUS_ERROR:
135 return BT_GRAPH_STATUS_ERROR;
136 case BT_COMPONENT_STATUS_UNSUPPORTED:
137 return BT_GRAPH_STATUS_ERROR;
138 case BT_COMPONENT_STATUS_INVALID:
139 return BT_GRAPH_STATUS_INVALID;
140 case BT_COMPONENT_STATUS_NOMEM:
141 return BT_GRAPH_STATUS_NOMEM;
142 case BT_COMPONENT_STATUS_NOT_FOUND:
143 return BT_GRAPH_STATUS_ERROR;
144 default:
145#ifdef BT_LOGF
146 BT_LOGF("Unknown component status: status=%d", comp_status);
147#endif
148 abort();
149 }
150}
151
33b34c43 152#endif /* BABELTRACE_COMPONENT_COMPONENT_GRAPH_INTERNAL_H */
This page took 0.03635 seconds and 4 git commands to generate.