src/lib/graph/graph.h

   1 #ifndef BABELTRACE_GRAPH_GRAPH_INTERNAL_H
   2 #define BABELTRACE_GRAPH_GRAPH_INTERNAL_H
   3
   4 /*
   5  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
   6  * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   7  *
   8  * Permission is hereby granted, free of charge, to any person obtaining a copy
   9  * of this software and associated documentation files (the "Software"), to deal
  10  * in the Software without restriction, including without limitation the rights
  11  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  12  * copies of the Software, and to permit persons to whom the Software is
  13  * furnished to do so, subject to the following conditions:
  14  *
  15  * The above copyright notice and this permission notice shall be included in
  16  * all copies or substantial portions of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  21  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  23  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  24  * SOFTWARE.
  25  */
  26
  27 #include <babeltrace2/graph/graph.h>
  28 #include <babeltrace2/graph/message-const.h>
  29 #include "common/macros.h"
  30 #include "lib/object.h"
  31 #include "lib/object-pool.h"
  32 #include "common/assert.h"
  33 #include "common/common.h"
  34 #include <stdlib.h>
  35 #include <glib.h>
  36
  37 #include "component.h"
  38 #include "component-sink.h"
  39 #include "connection.h"
  40
  41 struct bt_component;
  42 struct bt_port;
  43
  44 enum bt_graph_configuration_state {
  45         BT_GRAPH_CONFIGURATION_STATE_CONFIGURING,
  46         BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED,
  47         BT_GRAPH_CONFIGURATION_STATE_CONFIGURED,
  48         BT_GRAPH_CONFIGURATION_STATE_FAULTY,
  49 };
  50
  51 struct bt_graph {
  52         /**
  53          * A component graph contains components and point-to-point connection
  54          * between these components.
  55          *
  56          * In terms of ownership:
  57          * 1) The graph is the components' parent,
  58          * 2) The graph is the connnections' parent,
  59          * 3) Components share the ownership of their connections,
  60          * 4) A connection holds weak references to its two component endpoints.
  61          */
  62         struct bt_object base;
  63
  64         /* Array of pointers to bt_connection. */
  65         GPtrArray *connections;
  66         /* Array of pointers to bt_component. */
  67         GPtrArray *components;
  68         /* Queue of pointers (weak references) to sink bt_components. */
  69         GQueue *sinks_to_consume;
  70
  71         bool canceled;
  72         bool in_remove_listener;
  73         bool has_sink;
  74
  75         /*
  76          * If this is false, then the public API's consuming
  77          * functions (bt_graph_consume() and bt_graph_run()) return
  78          * BT_GRAPH_STATUS_CANNOT_CONSUME. The internal "no check"
  79          * functions always work.
  80          *
  81          * In bt_port_output_message_iterator_create(), on success,
  82          * this flag is cleared so that the iterator remains the only
  83          * consumer for the graph's lifetime.
  84          */
  85         bool can_consume;
  86
  87         enum bt_graph_configuration_state config_state;
  88
  89         struct {
  90                 GArray *source_output_port_added;
  91                 GArray *filter_output_port_added;
  92                 GArray *filter_input_port_added;
  93                 GArray *sink_input_port_added;
  94                 GArray *source_filter_ports_connected;
  95                 GArray *source_sink_ports_connected;
  96                 GArray *filter_filter_ports_connected;
  97                 GArray *filter_sink_ports_connected;
  98         } listeners;
  99
 100         /* Pool of `struct bt_message_event *` */
 101         struct bt_object_pool event_msg_pool;
 102
 103         /* Pool of `struct bt_message_packet_beginning *` */
 104         struct bt_object_pool packet_begin_msg_pool;
 105
 106         /* Pool of `struct bt_message_packet_end *` */
 107         struct bt_object_pool packet_end_msg_pool;
 108
 109         /*
 110          * Array of `struct bt_message *` (weak).
 111          *
 112          * This is an array of all the messages ever created from
 113          * this graph. Some of them can be in one of the pools above,
 114          * some of them can be at large. Because each message has a
 115          * weak pointer to the graph containing its pool, we need to
 116          * notify each message that the graph is gone on graph
 117          * destruction.
 118          *
 119          * TODO: When we support a maximum size for object pools,
 120          * add a way for a message to remove itself from this
 121          * array (on destruction).
 122          */
 123         GPtrArray *messages;
 124 };
 125
 126 static inline
 127 void _bt_graph_set_can_consume(struct bt_graph *graph, bool can_consume)
 128 {
 129         BT_ASSERT(graph);
 130         graph->can_consume = can_consume;
 131 }
 132
 133 #ifdef BT_DEV_MODE
 134 # define bt_graph_set_can_consume       _bt_graph_set_can_consume
 135 #else
 136 # define bt_graph_set_can_consume(_graph, _can_consume)
 137 #endif
 138
 139 BT_HIDDEN
 140 enum bt_graph_status bt_graph_consume_sink_no_check(struct bt_graph *graph,
 141                 struct bt_component_sink *sink);
 142
 143 BT_HIDDEN
 144 enum bt_graph_listener_status bt_graph_notify_port_added(struct bt_graph *graph,
 145                 struct bt_port *port);
 146
 147 BT_HIDDEN
 148 enum bt_graph_listener_status bt_graph_notify_ports_connected(
 149                 struct bt_graph *graph, struct bt_port *upstream_port,
 150                 struct bt_port *downstream_port);
 151
 152 BT_HIDDEN
 153 void bt_graph_remove_connection(struct bt_graph *graph,
 154                 struct bt_connection *connection);
 155
 156 /*
 157  * This only works with a component which is not connected at this
 158  * point.
 159  *
 160  * Also the reference count of `component` should be 0 when you call
 161  * this function, which means only `graph` owns the component, so it
 162  * is safe to destroy.
 163  */
 164 BT_HIDDEN
 165 int bt_graph_remove_unconnected_component(struct bt_graph *graph,
 166                 struct bt_component *component);
 167
 168 BT_HIDDEN
 169 void bt_graph_add_message(struct bt_graph *graph,
 170                 struct bt_message *msg);
 171
 172 static inline
 173 const char *bt_graph_status_string(enum bt_graph_status status)
 174 {
 175         switch (status) {
 176         case BT_GRAPH_STATUS_CANCELED:
 177                 return "BT_GRAPH_STATUS_CANCELED";
 178         case BT_GRAPH_STATUS_AGAIN:
 179                 return "BT_GRAPH_STATUS_AGAIN";
 180         case BT_GRAPH_STATUS_END:
 181                 return "BT_GRAPH_STATUS_END";
 182         case BT_GRAPH_STATUS_OK:
 183                 return "BT_GRAPH_STATUS_OK";
 184         case BT_GRAPH_STATUS_ERROR:
 185                 return "BT_GRAPH_STATUS_ERROR";
 186         case BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION:
 187                 return "BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION";
 188         case BT_GRAPH_STATUS_NOMEM:
 189                 return "BT_GRAPH_STATUS_NOMEM";
 190         default:
 191                 return "(unknown)";
 192         }
 193 }
 194
 195 static inline
 196 const char *bt_graph_configuration_state_string(
 197                 enum bt_graph_configuration_state state)
 198 {
 199         switch (state) {
 200         case BT_GRAPH_CONFIGURATION_STATE_CONFIGURING:
 201                 return "BT_GRAPH_CONFIGURATION_STATE_CONFIGURING";
 202         case BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED:
 203                 return "BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED";
 204         case BT_GRAPH_CONFIGURATION_STATE_CONFIGURED:
 205                 return "BT_GRAPH_CONFIGURATION_STATE_CONFIGURED";
 206         default:
 207                 return "(unknown)";
 208         }
 209 }
 210
 211 static inline
 212 enum bt_graph_status bt_graph_configure(struct bt_graph *graph)
 213 {
 214         enum bt_graph_status status = BT_GRAPH_STATUS_OK;
 215         uint64_t i;
 216
 217         BT_ASSERT(graph->config_state != BT_GRAPH_CONFIGURATION_STATE_FAULTY);
 218
 219         if (G_LIKELY(graph->config_state ==
 220                         BT_GRAPH_CONFIGURATION_STATE_CONFIGURED)) {
 221                 goto end;
 222         }
 223
 224 #ifdef BT_ASSERT_PRE
 225         BT_ASSERT_PRE(graph->has_sink, "Graph has no sink component: %!+g", graph);
 226 #endif
 227
 228         graph->config_state = BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED;
 229
 230         for (i = 0; i < graph->components->len; i++) {
 231                 struct bt_component *comp = graph->components->pdata[i];
 232                 struct bt_component_sink *comp_sink = (void *) comp;
 233                 struct bt_component_class_sink *comp_cls_sink =
 234                         (void *) comp->class;
 235
 236                 if (comp->class->type != BT_COMPONENT_CLASS_TYPE_SINK) {
 237                         continue;
 238                 }
 239
 240                 if (comp_sink->graph_is_configured_method_called) {
 241                         continue;
 242                 }
 243
 244                 if (comp_cls_sink->methods.graph_is_configured) {
 245                         enum bt_self_component_status comp_status;
 246
 247 #ifdef BT_LIB_LOGD
 248                         BT_LIB_LOGD("Calling user's \"graph is configured\" method: "
 249                                 "%![graph-]+g, %![comp-]+c",
 250                                 graph, comp);
 251 #endif
 252
 253                         comp_status = comp_cls_sink->methods.graph_is_configured(
 254                                 (void *) comp_sink);
 255
 256 #ifdef BT_LIB_LOGD
 257                         BT_LIB_LOGD("User method returned: status=%s",
 258                                 bt_self_component_status_string(comp_status));
 259 #endif
 260
 261 #ifdef BT_ASSERT_PRE
 262                         BT_ASSERT_PRE(comp_status == BT_SELF_COMPONENT_STATUS_OK ||
 263                                 comp_status == BT_SELF_COMPONENT_STATUS_ERROR ||
 264                                 comp_status == BT_SELF_COMPONENT_STATUS_NOMEM,
 265                                 "Unexpected returned status: status=%s",
 266                                 bt_self_component_status_string(comp_status));
 267 #endif
 268
 269                         if (comp_status != BT_SELF_COMPONENT_STATUS_OK) {
 270                                 status = BT_GRAPH_STATUS_ERROR;
 271 #ifdef BT_LIB_LOGW
 272                                 BT_LIB_LOGW("User's \"graph is configured\" method failed: "
 273                                         "%![comp-]+c, status=%s",
 274                                         comp,
 275                                         bt_self_component_status_string(
 276                                                 comp_status));
 277 #endif
 278
 279                                 goto end;
 280                         }
 281                 }
 282
 283                 comp_sink->graph_is_configured_method_called = true;
 284         }
 285
 286         graph->config_state = BT_GRAPH_CONFIGURATION_STATE_CONFIGURED;
 287
 288 end:
 289         return status;
 290 }
 291
 292 static inline
 293 void bt_graph_make_faulty(struct bt_graph *graph)
 294 {
 295         graph->config_state = BT_GRAPH_CONFIGURATION_STATE_FAULTY;
 296 #ifdef BT_LIB_LOGI
 297         BT_LIB_LOGI("Set graph's state to faulty: %![graph-]+g", graph);
 298 #endif
 299 }
 300
 301 #endif /* BABELTRACE_GRAPH_GRAPH_INTERNAL_H */