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