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

   1 #ifndef BABELTRACE_COMPONENT_NOTIFICATION_ITERATOR_INTERNAL_H
   2 #define BABELTRACE_COMPONENT_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/ref-internal.h>
  32 #include <babeltrace/graph/connection.h>
  33 #include <babeltrace/graph/notification.h>
  34 #include <babeltrace/graph/notification-iterator.h>
  35 #include <babeltrace/graph/private-connection-private-notification-iterator.h>
  36 #include <babeltrace/types.h>
  37 #include <stdbool.h>
  38 #include <assert.h>
  39
  40 struct bt_port;
  41 struct bt_graph;
  42
  43 enum bt_notification_iterator_type {
  44         BT_NOTIFICATION_ITERATOR_TYPE_PRIVATE_CONNECTION,
  45         BT_NOTIFICATION_ITERATOR_TYPE_OUTPUT_PORT,
  46 };
  47
  48 enum bt_private_connection_notification_iterator_notif_type {
  49         BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_EVENT =                  (1U << 0),
  50         BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_INACTIVITY =             (1U << 1),
  51         BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_STREAM_BEGIN =           (1U << 2),
  52         BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_STREAM_END =             (1U << 3),
  53         BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_PACKET_BEGIN =           (1U << 4),
  54         BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_PACKET_END =             (1U << 5),
  55         BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_DISCARDED_EVENTS =       (1U << 6),
  56         BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_NOTIF_TYPE_DISCARDED_PACKETS =      (1U << 7),
  57 };
  58
  59 enum bt_private_connection_notification_iterator_state {
  60         /* Iterator is not initialized. */
  61         BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_NON_INITIALIZED,
  62
  63         /* Iterator is active, not at the end yet, and not finalized. */
  64         BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_ACTIVE,
  65
  66         /*
  67          * Iterator is ended, not finalized yet: the "next" method
  68          * returns BT_NOTIFICATION_ITERATOR_STATUS_END.
  69          */
  70         BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_ENDED,
  71
  72         /*
  73          * Iterator is finalized, but not at the end yet. This means
  74          * that the "next" method can still return queued notifications
  75          * before returning the BT_NOTIFICATION_ITERATOR_STATUS_CANCELED
  76          * status.
  77          */
  78         BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_FINALIZED,
  79
  80         /*
  81          * Iterator is finalized and ended: the "next" method always
  82          * returns BT_NOTIFICATION_ITERATOR_STATUS_CANCELED.
  83          */
  84         BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_FINALIZED_AND_ENDED,
  85 };
  86
  87 struct bt_notification_iterator {
  88         struct bt_object base;
  89         enum bt_notification_iterator_type type;
  90         struct bt_notification *current_notification; /* owned by this */
  91 };
  92
  93 struct bt_notification_iterator_private_connection {
  94         struct bt_notification_iterator base;
  95         struct bt_component *upstream_component; /* Weak */
  96         struct bt_port *upstream_port; /* Weak */
  97         struct bt_connection *connection; /* Weak */
  98         GQueue *queue; /* struct bt_notification * (owned by this) */
  99
 100         /*
 101          * This hash table keeps the state of a stream as viewed by
 102          * this notification iterator. This is used to:
 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
 110          *   a "stream end" notification for a given stream, that no
 111          *   other notifications which refer to this stream can be
 112          *   delivered 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         /*
 120          * This is an array of actions which can be rolled back. It's
 121          * similar to the memento pattern, but it's not exactly that. It
 122          * is allocated once and reset for each notification to process.
 123          * More details near the implementation.
 124          */
 125         GArray *actions;
 126
 127         /*
 128          * This is a mask of notifications to which the user of this
 129          * iterator is subscribed
 130          * (see enum bt_private_connection_notification_iterator_notif_type
 131          * above).
 132          */
 133         uint32_t subscription_mask;
 134
 135         enum bt_private_connection_notification_iterator_state state;
 136         void *user_data;
 137 };
 138
 139 struct bt_notification_iterator_output_port {
 140         struct bt_notification_iterator base;
 141         struct bt_graph *graph; /* Owned by this */
 142         struct bt_component *colander; /* Owned by this */
 143         struct bt_port *output_port; /* Owned by this */
 144 };
 145
 146 static inline
 147 struct bt_notification *bt_notification_iterator_borrow_current_notification(
 148                 struct bt_notification_iterator *iterator)
 149 {
 150         assert(iterator);
 151         return iterator->current_notification;
 152 }
 153
 154 static inline
 155 void bt_notification_iterator_replace_current_notification(
 156                 struct bt_notification_iterator *iterator,
 157                 struct bt_notification *notification)
 158 {
 159         assert(iterator);
 160         bt_put(iterator->current_notification);
 161         iterator->current_notification = bt_get(notification);
 162 }
 163
 164 static inline
 165 struct bt_notification_iterator_private_connection *
 166 bt_private_connection_notification_iterator_borrow_from_private(
 167                 struct bt_private_connection_private_notification_iterator *private_notification_iterator)
 168 {
 169         return (void *) private_notification_iterator;
 170 }
 171
 172 static inline
 173 struct bt_private_connection_private_notification_iterator *
 174 bt_private_connection_private_notification_iterator_from_notification_iterator(
 175                 struct bt_notification_iterator_private_connection *iterator)
 176 {
 177         return (void *) iterator;
 178 }
 179
 180 BT_HIDDEN
 181 enum bt_connection_status bt_private_connection_notification_iterator_create(
 182                 struct bt_component *upstream_comp,
 183                 struct bt_port *upstream_port,
 184                 const enum bt_notification_type *notification_types,
 185                 struct bt_connection *connection,
 186                 struct bt_notification_iterator_private_connection **iterator);
 187
 188 BT_HIDDEN
 189 void bt_private_connection_notification_iterator_finalize(
 190                 struct bt_notification_iterator_private_connection *iterator);
 191
 192 BT_HIDDEN
 193 void bt_private_connection_notification_iterator_set_connection(
 194                 struct bt_notification_iterator_private_connection *iterator,
 195                 struct bt_connection *connection);
 196
 197 static inline
 198 const char *bt_notification_iterator_status_string(
 199                 enum bt_notification_iterator_status status)
 200 {
 201         switch (status) {
 202         case BT_NOTIFICATION_ITERATOR_STATUS_CANCELED:
 203                 return "BT_NOTIFICATION_ITERATOR_STATUS_CANCELED";
 204         case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN:
 205                 return "BT_NOTIFICATION_ITERATOR_STATUS_AGAIN";
 206         case BT_NOTIFICATION_ITERATOR_STATUS_END:
 207                 return "BT_NOTIFICATION_ITERATOR_STATUS_END";
 208         case BT_NOTIFICATION_ITERATOR_STATUS_OK:
 209                 return "BT_NOTIFICATION_ITERATOR_STATUS_OK";
 210         case BT_NOTIFICATION_ITERATOR_STATUS_INVALID:
 211                 return "BT_NOTIFICATION_ITERATOR_STATUS_INVALID";
 212         case BT_NOTIFICATION_ITERATOR_STATUS_ERROR:
 213                 return "BT_NOTIFICATION_ITERATOR_STATUS_ERROR";
 214         case BT_NOTIFICATION_ITERATOR_STATUS_NOMEM:
 215                 return "BT_NOTIFICATION_ITERATOR_STATUS_NOMEM";
 216         case BT_NOTIFICATION_ITERATOR_STATUS_UNSUPPORTED:
 217                 return "BT_NOTIFICATION_ITERATOR_STATUS_UNSUPPORTED";
 218         default:
 219                 return "(unknown)";
 220         }
 221 };
 222
 223 static inline
 224 const char *bt_private_connection_notification_iterator_state_string(
 225                 enum bt_private_connection_notification_iterator_state state)
 226 {
 227         switch (state) {
 228         case BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_ACTIVE:
 229                 return "BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_ACTIVE";
 230         case BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_ENDED:
 231                 return "BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_ENDED";
 232         case BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_FINALIZED:
 233                 return "BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_FINALIZED";
 234         case BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_FINALIZED_AND_ENDED:
 235                 return "BT_PRIVATE_CONNECTION_NOTIFICATION_ITERATOR_STATE_FINALIZED_AND_ENDED";
 236         default:
 237                 return "(unknown)";
 238         }
 239 };
 240
 241 #endif /* BABELTRACE_COMPONENT_NOTIFICATION_ITERATOR_INTERNAL_H */