include/babeltrace/graph/notification-iterator-internal.h

   1 #ifndef BABELTRACE_GRAPH_NOTIFICATION_ITERATOR_INTERNAL_H
   2 #define BABELTRACE_GRAPH_NOTIFICATION_ITERATOR_INTERNAL_H
   3
   4 /*
   5  * BabelTrace - Notification Iterator Internal
   6  *
   7  * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   8  * Copyright 2017 Philippe Proulx <pproulx@efficios.com>
   9  *
  10  * Permission is hereby granted, free of charge, to any person obtaining a copy
  11  * of this software and associated documentation files (the "Software"), to deal
  12  * in the Software without restriction, including without limitation the rights
  13  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  14  * copies of the Software, and to permit persons to whom the Software is
  15  * furnished to do so, subject to the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be included in
  18  * all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  21  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  23  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  24  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  25  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  26  * SOFTWARE.
  27  */
  28
  29 #include <babeltrace/babeltrace-internal.h>
  30 #include <babeltrace/object-internal.h>
  31 #include <babeltrace/graph/connection.h>
  32 #include <babeltrace/graph/notification.h>
  33 #include <babeltrace/graph/notification-iterator.h>
  34 #include <babeltrace/graph/private-connection-private-notification-iterator.h>
  35 #include <babeltrace/types.h>
  36 #include <babeltrace/assert-internal.h>
  37 #include <stdbool.h>
  38
  39 struct bt_port;
  40 struct bt_graph;
  41
  42 enum bt_notification_iterator_type {
  43         BT_NOTIFICATION_ITERATOR_TYPE_PRIVATE_CONNECTION,
  44         BT_NOTIFICATION_ITERATOR_TYPE_OUTPUT_PORT,
  45 };
  46
  47 enum bt_private_connection_notification_iterator_notif_type {
  48         BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_EVENT =                  (1U << 0),
  49         BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_INACTIVITY =             (1U << 1),
  50         BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_STREAM_BEGIN =           (1U << 2),
  51         BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_STREAM_END =             (1U << 3),
  52         BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_PACKET_BEGIN =           (1U << 4),
  53         BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_PACKET_END =             (1U << 5),
  54         BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_DISCARDED_EVENTS =       (1U << 6),
  55         BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_DISCARDED_PACKETS =      (1U << 7),
  56 };
  57
  58 enum bt_private_connection_notification_iterator_state {
  59         /* Iterator is not initialized. */
  60         BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_NON_INITIALIZED,
  61
  62         /* Iterator is active, not at the end yet, and not finalized. */
  63         BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_ACTIVE,
  64
  65         /*
  66          * Iterator is ended, not finalized yet: the "next" method
  67          * returns BT_NOTIFICATION_ITERATOR_STATUS_END.
  68          */
  69         BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_ENDED,
  70
  71         /*
  72          * Iterator is finalized, but not at the end yet. This means
  73          * that the "next" method can still return queued notifications
  74          * before returning the BT_NOTIFICATION_ITERATOR_STATUS_CANCELED
  75          * status.
  76          */
  77         BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_FINALIZED,
  78
  79         /*
  80          * Iterator is finalized and ended: the "next" method always
  81          * returns BT_NOTIFICATION_ITERATOR_STATUS_CANCELED.
  82          */
  83         BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_FINALIZED_AND_ENDED,
  84 };
  85
  86 struct bt_notification_iterator {
  87         struct bt_object base;
  88         enum bt_notification_iterator_type type;
  89         GPtrArray *notifs;
  90 };
  91
  92 struct bt_notification_iterator_private_connection {
  93         struct bt_notification_iterator base;
  94         struct bt_component *upstream_component; /* Weak */
  95         struct bt_port *upstream_port; /* Weak */
  96         struct bt_connection *connection; /* Weak */
  97         struct bt_graph *graph; /* Weak */
  98
  99         /*
 100          * This hash table keeps the state of a stream as viewed by
 101          * this notification iterator. This is used to, in developer
 102          * mode:
 103          *
 104          * * Automatically enqueue "stream begin", "packet begin",
 105          *   "packet end", and "stream end" notifications depending
 106          *   on the stream's state and on the next notification returned
 107          *   by the upstream component.
 108          *
 109          * * Make sure that, once the notification iterator has seen a
 110          *   "stream end" notification for a given stream, no other
 111          *   notifications which refer to this stream can be delivered
 112          *   by this iterator.
 113          *
 114          * The key (struct bt_stream *) is not owned by this. The
 115          * value is an allocated state structure.
 116          */
 117         GHashTable *stream_states;
 118
 119         enum bt_private_connection_notification_iterator_state state;
 120         void *user_data;
 121 };
 122
 123 struct bt_notification_iterator_output_port {
 124         struct bt_notification_iterator base;
 125         struct bt_graph *graph; /* Owned by this */
 126         struct bt_component *colander; /* Owned by this */
 127
 128         /*
 129          * Only used temporarily as a bridge between a colander sink and
 130          * the user.
 131          */
 132         uint64_t count;
 133 };
 134
 135 static inline
 136 struct bt_private_connection_private_notification_iterator *
 137 bt_private_connection_private_notification_iterator_from_notification_iterator(
 138                 struct bt_notification_iterator_private_connection *iterator)
 139 {
 140         return (void *) iterator;
 141 }
 142
 143 BT_HIDDEN
 144 enum bt_connection_status bt_private_connection_notification_iterator_create(
 145                 struct bt_component *upstream_comp,
 146                 struct bt_port *upstream_port,
 147                 struct bt_connection *connection,
 148                 struct bt_notification_iterator_private_connection **iterator);
 149
 150 BT_HIDDEN
 151 void bt_private_connection_notification_iterator_finalize(
 152                 struct bt_notification_iterator_private_connection *iterator);
 153
 154 BT_HIDDEN
 155 void bt_private_connection_notification_iterator_set_connection(
 156                 struct bt_notification_iterator_private_connection *iterator,
 157                 struct bt_connection *connection);
 158
 159 static inline
 160 const char *bt_notification_iterator_status_string(
 161                 enum bt_notification_iterator_status status)
 162 {
 163         switch (status) {
 164         case BT_NOTIFICATION_ITERATOR_STATUS_CANCELED:
 165                 return "BT_NOTIFICATION_ITERATOR_STATUS_CANCELED";
 166         case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN:
 167                 return "BT_NOTIFICATION_ITERATOR_STATUS_AGAIN";
 168         case BT_NOTIFICATION_ITERATOR_STATUS_END:
 169                 return "BT_NOTIFICATION_ITERATOR_STATUS_END";
 170         case BT_NOTIFICATION_ITERATOR_STATUS_OK:
 171                 return "BT_NOTIFICATION_ITERATOR_STATUS_OK";
 172         case BT_NOTIFICATION_ITERATOR_STATUS_INVALID:
 173                 return "BT_NOTIFICATION_ITERATOR_STATUS_INVALID";
 174         case BT_NOTIFICATION_ITERATOR_STATUS_ERROR:
 175                 return "BT_NOTIFICATION_ITERATOR_STATUS_ERROR";
 176         case BT_NOTIFICATION_ITERATOR_STATUS_NOMEM:
 177                 return "BT_NOTIFICATION_ITERATOR_STATUS_NOMEM";
 178         case BT_NOTIFICATION_ITERATOR_STATUS_UNSUPPORTED:
 179                 return "BT_NOTIFICATION_ITERATOR_STATUS_UNSUPPORTED";
 180         default:
 181                 return "(unknown)";
 182         }
 183 };
 184
 185 static inline
 186 const char *bt_private_connection_notification_iterator_state_string(
 187                 enum bt_private_connection_notification_iterator_state state)
 188 {
 189         switch (state) {
 190         case BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_ACTIVE:
 191                 return "BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_ACTIVE";
 192         case BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_ENDED:
 193                 return "BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_ENDED";
 194         case BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_FINALIZED:
 195                 return "BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_FINALIZED";
 196         case BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_FINALIZED_AND_ENDED:
 197                 return "BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_FINALIZED_AND_ENDED";
 198         default:
 199                 return "(unknown)";
 200         }
 201 };
 202
 203 #endif /* BABELTRACE_GRAPH_NOTIFICATION_ITERATOR_INTERNAL_H */