include/babeltrace/graph/connection-internal.h

   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
  35 struct bt_graph;
  36
  37 struct bt_connection {
  38         /*
  39          * The graph is a connection's parent and the connection is the parent
  40          * of all iterators it has created.
  41          */
  42         struct bt_object base;
  43         /*
  44          * Weak references are held to both ports. Their existence is guaranteed
  45          * by the existence of the graph and thus, of their respective
  46          * components.
  47          */
  48         /* Downstream port. */
  49         struct bt_port *downstream_port;
  50         /* Upstream port. */
  51         struct bt_port *upstream_port;
  52
  53         /*
  54          * Weak references to all the notification iterators that were
  55          * created on this connection.
  56          */
  57         GPtrArray *iterators;
  58 };
  59
  60 static inline
  61 struct bt_connection *bt_connection_from_private(
  62                 struct bt_private_connection *private_connection)
  63 {
  64         return (void *) private_connection;
  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_disconnect_ports(struct bt_connection *conn);
  81
  82 BT_HIDDEN
  83 void bt_connection_remove_iterator(struct bt_connection *conn,
  84                 struct bt_notification_iterator *iterator);
  85
  86 static inline
  87 enum bt_connection_status
  88 bt_connection_status_from_notification_iterator_status(
  89                 enum bt_notification_iterator_status iter_status)
  90 {
  91         switch (iter_status) {
  92         case BT_NOTIFICATION_ITERATOR_STATUS_CANCELED:
  93                 return BT_CONNECTION_STATUS_ERROR;
  94         case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN:
  95                 return BT_CONNECTION_STATUS_ERROR;
  96         case BT_NOTIFICATION_ITERATOR_STATUS_END:
  97                 return BT_CONNECTION_STATUS_ERROR;
  98         case BT_NOTIFICATION_ITERATOR_STATUS_OK:
  99                 return BT_CONNECTION_STATUS_OK;
 100         case BT_NOTIFICATION_ITERATOR_STATUS_INVALID:
 101                 return BT_CONNECTION_STATUS_INVALID;
 102         case BT_NOTIFICATION_ITERATOR_STATUS_ERROR:
 103                 return BT_CONNECTION_STATUS_ERROR;
 104         case BT_NOTIFICATION_ITERATOR_STATUS_NOMEM:
 105                 return BT_CONNECTION_STATUS_NOMEM;
 106         case BT_NOTIFICATION_ITERATOR_STATUS_UNSUPPORTED:
 107                 return BT_CONNECTION_STATUS_ERROR;
 108         default:
 109 #ifdef BT_LOGF
 110                 BT_LOGF("Unknown notification iterator status: status=%d",
 111                         iter_status);
 112 #endif
 113                 abort();
 114         }
 115 }
 116
 117 #endif /* BABELTRACE_COMPONENT_CONNECTION_INTERNAL_H */