include/babeltrace/graph/connection-internal.h

   1 #ifndef BABELTRACE_GRAPH_CONNECTION_INTERNAL_H
   2 #define BABELTRACE_GRAPH_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/notification-iterator-internal.h>
  33 #include <babeltrace/graph/private-connection.h>
  34 #include <babeltrace/object-internal.h>
  35 #include <babeltrace/assert-internal.h>
  36 #include <stdbool.h>
  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. */
  52         struct bt_port *downstream_port;
  53         /* Upstream port. */
  54         struct bt_port *upstream_port;
  55
  56         /*
  57          * Weak references to all the notification iterators that were
  58          * created on this connection.
  59          */
  60         GPtrArray *iterators;
  61
  62         bool notified_upstream_port_connected;
  63         bool notified_downstream_port_connected;
  64         bool notified_graph_ports_connected;
  65 };
  66
  67 static inline
  68 struct bt_private_connection *bt_private_connection_from_connection(
  69                 struct bt_connection *connection)
  70 {
  71         return (void *) connection;
  72 }
  73
  74 BT_HIDDEN
  75 struct bt_connection *bt_connection_create(struct bt_graph *graph,
  76                 struct bt_port *upstream_port,
  77                 struct bt_port *downstream_port);
  78
  79 BT_HIDDEN
  80 void bt_connection_end(struct bt_connection *conn, bool try_remove_from_graph);
  81
  82 BT_HIDDEN
  83 void bt_connection_remove_iterator(struct bt_connection *conn,
  84                 struct bt_notification_iterator_private_connection *iterator);
  85
  86 static inline
  87 struct bt_graph *bt_connection_borrow_graph(struct bt_connection *conn)
  88 {
  89         BT_ASSERT(conn);
  90         return (void *) conn->base.parent;
  91 }
  92
  93 static inline
  94 enum bt_connection_status
  95 bt_connection_status_from_notification_iterator_status(
  96                 enum bt_notification_iterator_status iter_status)
  97 {
  98         switch (iter_status) {
  99         case BT_NOTIFICATION_ITERATOR_STATUS_CANCELED:
 100                 return BT_CONNECTION_STATUS_ERROR;
 101         case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN:
 102                 return BT_CONNECTION_STATUS_ERROR;
 103         case BT_NOTIFICATION_ITERATOR_STATUS_END:
 104                 return BT_CONNECTION_STATUS_ERROR;
 105         case BT_NOTIFICATION_ITERATOR_STATUS_OK:
 106                 return BT_CONNECTION_STATUS_OK;
 107         case BT_NOTIFICATION_ITERATOR_STATUS_INVALID:
 108                 return BT_CONNECTION_STATUS_INVALID;
 109         case BT_NOTIFICATION_ITERATOR_STATUS_ERROR:
 110                 return BT_CONNECTION_STATUS_ERROR;
 111         case BT_NOTIFICATION_ITERATOR_STATUS_NOMEM:
 112                 return BT_CONNECTION_STATUS_NOMEM;
 113         case BT_NOTIFICATION_ITERATOR_STATUS_UNSUPPORTED:
 114                 return BT_CONNECTION_STATUS_ERROR;
 115         default:
 116 #ifdef BT_LOGF
 117                 BT_LOGF("Unknown notification iterator status: status=%d",
 118                         iter_status);
 119 #endif
 120                 abort();
 121         }
 122 }
 123
 124 static inline
 125 const char *bt_connection_status_string(enum bt_connection_status status)
 126 {
 127         switch (status) {
 128         case BT_CONNECTION_STATUS_GRAPH_IS_CANCELED:
 129                 return "BT_CONNECTION_STATUS_GRAPH_IS_CANCELED";
 130         case BT_CONNECTION_STATUS_OK:
 131                 return "BT_CONNECTION_STATUS_OK";
 132         case BT_CONNECTION_STATUS_INVALID:
 133                 return "BT_CONNECTION_STATUS_INVALID";
 134         case BT_CONNECTION_STATUS_ERROR:
 135                 return "BT_CONNECTION_STATUS_ERROR";
 136         case BT_CONNECTION_STATUS_NOMEM:
 137                 return "BT_CONNECTION_STATUS_NOMEM";
 138         case BT_CONNECTION_STATUS_IS_ENDED:
 139                 return "BT_CONNECTION_STATUS_IS_ENDED";
 140         default:
 141                 return "(unknown)";
 142         }
 143 }
 144
 145 #endif /* BABELTRACE_GRAPH_CONNECTION_INTERNAL_H */