include/babeltrace/graph/graph-internal.h

   1 #ifndef BABELTRACE_GRAPH_GRAPH_INTERNAL_H
   2 #define BABELTRACE_GRAPH_GRAPH_INTERNAL_H
   3
   4 /*
   5  * BabelTrace - Component Graph 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/graph.h>
  31 #include <babeltrace/graph/component-status.h>
  32 #include <babeltrace/graph/notification.h>
  33 #include <babeltrace/babeltrace-internal.h>
  34 #include <babeltrace/object-internal.h>
  35 #include <babeltrace/object-pool-internal.h>
  36 #include <babeltrace/assert-internal.h>
  37 #include <stdlib.h>
  38 #include <glib.h>
  39
  40 struct bt_component;
  41 struct bt_port;
  42
  43 struct bt_graph {
  44         /**
  45          * A component graph contains components and point-to-point connection
  46          * between these components.
  47          *
  48          * In terms of ownership:
  49          * 1) The graph is the components' parent,
  50          * 2) The graph is the connnections' parent,
  51          * 3) Components share the ownership of their connections,
  52          * 4) A connection holds weak references to its two component endpoints.
  53          */
  54         struct bt_object base;
  55
  56         /* Array of pointers to bt_connection. */
  57         GPtrArray *connections;
  58         /* Array of pointers to bt_component. */
  59         GPtrArray *components;
  60         /* Queue of pointers (weak references) to sink bt_components. */
  61         GQueue *sinks_to_consume;
  62
  63         bt_bool canceled;
  64         bt_bool in_remove_listener;
  65         bt_bool has_sink;
  66
  67         /*
  68          * If this is BT_FALSE, then the public API's consuming
  69          * functions (bt_graph_consume() and bt_graph_run()) return
  70          * BT_GRAPH_STATUS_CANNOT_CONSUME. The internal "no check"
  71          * functions always work.
  72          *
  73          * In bt_output_port_notification_iterator_create(), on success,
  74          * this flag is cleared so that the iterator remains the only
  75          * consumer for the graph's lifetime.
  76          */
  77         bt_bool can_consume;
  78
  79         struct {
  80                 GArray *port_added;
  81                 GArray *port_removed;
  82                 GArray *ports_connected;
  83                 GArray *ports_disconnected;
  84         } listeners;
  85
  86         /* Pool of `struct bt_notification_event *` */
  87         struct bt_object_pool event_notif_pool;
  88
  89         /* Pool of `struct bt_notification_packet_begin *` */
  90         struct bt_object_pool packet_begin_notif_pool;
  91
  92         /* Pool of `struct bt_notification_packet_end *` */
  93         struct bt_object_pool packet_end_notif_pool;
  94
  95         /*
  96          * Array of `struct bt_notification *` (weak).
  97          *
  98          * This is an array of all the notifications ever created from
  99          * this graph. Some of them can be in one of the pools above,
 100          * some of them can be at large. Because each notification has a
 101          * weak pointer to the graph containing its pool, we need to
 102          * notify each notification that the graph is gone on graph
 103          * destruction.
 104          *
 105          * TODO: When we support a maximum size for object pools,
 106          * add a way for a notification to remove itself from this
 107          * array (on destruction).
 108          */
 109         GPtrArray *notifications;
 110 };
 111
 112 static inline
 113 void bt_graph_set_can_consume(struct bt_graph *graph, bt_bool can_consume)
 114 {
 115         BT_ASSERT(graph);
 116         graph->can_consume = can_consume;
 117 }
 118
 119 BT_HIDDEN
 120 enum bt_graph_status bt_graph_consume_no_check(struct bt_graph *graph);
 121
 122 BT_HIDDEN
 123 enum bt_graph_status bt_graph_consume_sink_no_check(struct bt_graph *graph,
 124                 struct bt_component *sink);
 125
 126 BT_HIDDEN
 127 void bt_graph_notify_port_added(struct bt_graph *graph, struct bt_port *port);
 128
 129 BT_HIDDEN
 130 void bt_graph_notify_port_removed(struct bt_graph *graph,
 131                 struct bt_component *comp, struct bt_port *port);
 132
 133 BT_HIDDEN
 134 void bt_graph_notify_ports_connected(struct bt_graph *graph,
 135                 struct bt_port *upstream_port, struct bt_port *downstream_port);
 136
 137 BT_HIDDEN
 138 void bt_graph_notify_ports_disconnected(struct bt_graph *graph,
 139                 struct bt_component *upstream_comp,
 140                 struct bt_component *downstream_comp,
 141                 struct bt_port *upstream_port,
 142                 struct bt_port *downstream_port);
 143
 144 BT_HIDDEN
 145 void bt_graph_remove_connection(struct bt_graph *graph,
 146                 struct bt_connection *connection);
 147
 148 /*
 149  * This only works with a component which is not connected at this
 150  * point.
 151  *
 152  * Also the reference count of `component` should be 0 when you call
 153  * this function, which means only `graph` owns the component, so it
 154  * is safe to destroy.
 155  */
 156 BT_HIDDEN
 157 int bt_graph_remove_unconnected_component(struct bt_graph *graph,
 158                 struct bt_component *component);
 159
 160 BT_HIDDEN
 161 void bt_graph_add_notification(struct bt_graph *graph,
 162                 struct bt_notification *notif);
 163
 164 static inline
 165 const char *bt_graph_status_string(enum bt_graph_status status)
 166 {
 167         switch (status) {
 168         case BT_GRAPH_STATUS_CANCELED:
 169                 return "BT_GRAPH_STATUS_CANCELED";
 170         case BT_GRAPH_STATUS_AGAIN:
 171                 return "BT_GRAPH_STATUS_AGAIN";
 172         case BT_GRAPH_STATUS_END:
 173                 return "BT_GRAPH_STATUS_END";
 174         case BT_GRAPH_STATUS_OK:
 175                 return "BT_GRAPH_STATUS_OK";
 176         case BT_GRAPH_STATUS_INVALID:
 177                 return "BT_GRAPH_STATUS_INVALID";
 178         case BT_GRAPH_STATUS_NO_SINK:
 179                 return "BT_GRAPH_STATUS_NO_SINK";
 180         case BT_GRAPH_STATUS_ERROR:
 181                 return "BT_GRAPH_STATUS_ERROR";
 182         case BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION:
 183                 return "BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION";
 184         case BT_GRAPH_STATUS_NOMEM:
 185                 return "BT_GRAPH_STATUS_NOMEM";
 186         case BT_GRAPH_STATUS_CANNOT_CONSUME:
 187                 return "BT_GRAPH_STATUS_CANNOT_CONSUME";
 188         default:
 189                 return "(unknown)";
 190         }
 191 }
 192
 193 static inline
 194 enum bt_graph_status bt_graph_status_from_component_status(
 195                 enum bt_component_status comp_status)
 196 {
 197         switch (comp_status) {
 198         case BT_COMPONENT_STATUS_OK:
 199                 return BT_GRAPH_STATUS_OK;
 200         case BT_COMPONENT_STATUS_END:
 201                 return BT_GRAPH_STATUS_END;
 202         case BT_COMPONENT_STATUS_AGAIN:
 203                 return BT_GRAPH_STATUS_AGAIN;
 204         case BT_COMPONENT_STATUS_REFUSE_PORT_CONNECTION:
 205                 return BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION;
 206         case BT_COMPONENT_STATUS_ERROR:
 207                 return BT_GRAPH_STATUS_ERROR;
 208         case BT_COMPONENT_STATUS_UNSUPPORTED:
 209                 return BT_GRAPH_STATUS_ERROR;
 210         case BT_COMPONENT_STATUS_INVALID:
 211                 return BT_GRAPH_STATUS_INVALID;
 212         case BT_COMPONENT_STATUS_NOMEM:
 213                 return BT_GRAPH_STATUS_NOMEM;
 214         case BT_COMPONENT_STATUS_NOT_FOUND:
 215                 return BT_GRAPH_STATUS_ERROR;
 216         default:
 217 #ifdef BT_LOGF
 218                 BT_LOGF("Unknown component status: status=%d", comp_status);
 219 #endif
 220                 abort();
 221         }
 222 }
 223
 224 #endif /* BABELTRACE_GRAPH_GRAPH_INTERNAL_H */