Commit | Line | Data |
---|---|---|
784cdc68 JG |
1 | #ifndef BABELTRACE_COMPONENT_CONNECTION_INTERNAL_H |
2 | #define BABELTRACE_COMPONENT_CONNECTION_INTERNAL_H | |
3 | ||
4 | /* | |
5 | * BabelTrace - Component Connection Internal | |
6 | * | |
7 | * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
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/connection.h> |
73d5c1ad | 31 | #include <babeltrace/graph/notification-iterator.h> |
90157d89 | 32 | #include <babeltrace/graph/notification-iterator-internal.h> |
b2e0c907 | 33 | #include <babeltrace/graph/private-connection.h> |
784cdc68 | 34 | #include <babeltrace/object-internal.h> |
f6ccaed9 | 35 | #include <babeltrace/assert-internal.h> |
c42ea0af | 36 | #include <stdbool.h> |
784cdc68 JG |
37 | |
38 | struct bt_graph; | |
39 | ||
40 | struct bt_connection { | |
41 | /* | |
42 | * The graph is a connection's parent and the connection is the parent | |
43 | * of all iterators it has created. | |
44 | */ | |
45 | struct bt_object base; | |
46 | /* | |
47 | * Weak references are held to both ports. Their existence is guaranteed | |
48 | * by the existence of the graph and thus, of their respective | |
49 | * components. | |
50 | */ | |
51 | /* Downstream port. */ | |
72b913fb | 52 | struct bt_port *downstream_port; |
784cdc68 | 53 | /* Upstream port. */ |
72b913fb | 54 | struct bt_port *upstream_port; |
bd14d768 PP |
55 | |
56 | /* | |
57 | * Weak references to all the notification iterators that were | |
58 | * created on this connection. | |
59 | */ | |
60 | GPtrArray *iterators; | |
784cdc68 JG |
61 | }; |
62 | ||
890882ef | 63 | static inline |
6d137876 | 64 | struct bt_connection *bt_connection_borrow_from_private( |
890882ef PP |
65 | struct bt_private_connection *private_connection) |
66 | { | |
67 | return (void *) private_connection; | |
68 | } | |
69 | ||
70 | static inline | |
71 | struct bt_private_connection *bt_private_connection_from_connection( | |
72 | struct bt_connection *connection) | |
73 | { | |
74 | return (void *) connection; | |
75 | } | |
76 | ||
784cdc68 JG |
77 | BT_HIDDEN |
78 | struct bt_connection *bt_connection_create(struct bt_graph *graph, | |
72b913fb PP |
79 | struct bt_port *upstream_port, |
80 | struct bt_port *downstream_port); | |
81 | ||
82 | BT_HIDDEN | |
c42ea0af | 83 | void bt_connection_end(struct bt_connection *conn, bool try_remove_from_graph); |
784cdc68 | 84 | |
bd14d768 PP |
85 | BT_HIDDEN |
86 | void bt_connection_remove_iterator(struct bt_connection *conn, | |
90157d89 | 87 | struct bt_notification_iterator_private_connection *iterator); |
bd14d768 | 88 | |
c28d097c PP |
89 | static inline |
90 | struct bt_graph *bt_connection_borrow_graph(struct bt_connection *conn) | |
91 | { | |
f6ccaed9 | 92 | BT_ASSERT(conn); |
c28d097c PP |
93 | return (void *) conn->base.parent; |
94 | } | |
95 | ||
73d5c1ad PP |
96 | static inline |
97 | enum bt_connection_status | |
98 | bt_connection_status_from_notification_iterator_status( | |
99 | enum bt_notification_iterator_status iter_status) | |
100 | { | |
101 | switch (iter_status) { | |
102 | case BT_NOTIFICATION_ITERATOR_STATUS_CANCELED: | |
103 | return BT_CONNECTION_STATUS_ERROR; | |
104 | case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN: | |
105 | return BT_CONNECTION_STATUS_ERROR; | |
106 | case BT_NOTIFICATION_ITERATOR_STATUS_END: | |
107 | return BT_CONNECTION_STATUS_ERROR; | |
108 | case BT_NOTIFICATION_ITERATOR_STATUS_OK: | |
109 | return BT_CONNECTION_STATUS_OK; | |
110 | case BT_NOTIFICATION_ITERATOR_STATUS_INVALID: | |
111 | return BT_CONNECTION_STATUS_INVALID; | |
112 | case BT_NOTIFICATION_ITERATOR_STATUS_ERROR: | |
113 | return BT_CONNECTION_STATUS_ERROR; | |
114 | case BT_NOTIFICATION_ITERATOR_STATUS_NOMEM: | |
115 | return BT_CONNECTION_STATUS_NOMEM; | |
116 | case BT_NOTIFICATION_ITERATOR_STATUS_UNSUPPORTED: | |
117 | return BT_CONNECTION_STATUS_ERROR; | |
118 | default: | |
119 | #ifdef BT_LOGF | |
120 | BT_LOGF("Unknown notification iterator status: status=%d", | |
121 | iter_status); | |
122 | #endif | |
123 | abort(); | |
124 | } | |
125 | } | |
126 | ||
fed72692 PP |
127 | static inline |
128 | const char *bt_connection_status_string(enum bt_connection_status status) | |
129 | { | |
130 | switch (status) { | |
131 | case BT_CONNECTION_STATUS_GRAPH_IS_CANCELED: | |
132 | return "BT_CONNECTION_STATUS_GRAPH_IS_CANCELED"; | |
133 | case BT_CONNECTION_STATUS_OK: | |
134 | return "BT_CONNECTION_STATUS_OK"; | |
135 | case BT_CONNECTION_STATUS_INVALID: | |
136 | return "BT_CONNECTION_STATUS_INVALID"; | |
137 | case BT_CONNECTION_STATUS_ERROR: | |
138 | return "BT_CONNECTION_STATUS_ERROR"; | |
139 | case BT_CONNECTION_STATUS_NOMEM: | |
140 | return "BT_CONNECTION_STATUS_NOMEM"; | |
141 | case BT_CONNECTION_STATUS_IS_ENDED: | |
142 | return "BT_CONNECTION_STATUS_IS_ENDED"; | |
143 | default: | |
144 | return "(unknown)"; | |
145 | } | |
146 | } | |
147 | ||
784cdc68 | 148 | #endif /* BABELTRACE_COMPONENT_CONNECTION_INTERNAL_H */ |