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 /* Protection: this file uses BT_LIB_LOG*() macros directly */
  28 #ifndef BT_LIB_LOG_SUPPORTED
  29 # error Please include "lib/logging.h" before including this file.
  30 #endif
  31
  32 #include <babeltrace2/graph/graph.h>
  33 #include <babeltrace2/graph/message-const.h>
  34 #include "common/macros.h"
  35 #include "lib/object.h"
  36 #include "lib/object-pool.h"
  37 #include "common/assert.h"
  38 #include "common/common.h"
  39 #include <stdlib.h>
  40 #include <glib.h>
  41
  42 #include "component.h"
  43 #include "component-sink.h"
  44 #include "connection.h"
  45 #include "lib/func-status.h"
  46
  47 /* Protection: this file uses BT_LIB_LOG*() macros directly */
  48 #ifndef BT_LIB_LOG_SUPPORTED
  49 # error Please include "lib/logging.h" before including this file.
  50 #endif
  51
  52 /* Protection: this file uses BT_ASSERT_PRE*() macros directly */
  53 #ifndef BT_ASSERT_PRE_SUPPORTED
  54 # error Please include "lib/assert-pre.h" before including this file.
  55 #endif
  56
  57 /* Protection: this file uses BT_ASSERT_POST*() macros directly */
  58 #ifndef BT_ASSERT_POST_SUPPORTED
  59 # error Please include "lib/assert-post.h" before including this file.
  60 #endif
  61
  62 struct bt_component;
  63 struct bt_port;
  64
  65 enum bt_graph_configuration_state {
  66         BT_GRAPH_CONFIGURATION_STATE_CONFIGURING,
  67         BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED,
  68         BT_GRAPH_CONFIGURATION_STATE_CONFIGURED,
  69         BT_GRAPH_CONFIGURATION_STATE_FAULTY,
  70         BT_GRAPH_CONFIGURATION_STATE_DESTROYING,
  71 };
  72
  73 struct bt_graph {
  74         /**
  75          * A component graph contains components and point-to-point connection
  76          * between these components.
  77          *
  78          * In terms of ownership:
  79          * 1) The graph is the components' parent,
  80          * 2) The graph is the connnections' parent,
  81          * 3) Components share the ownership of their connections,
  82          * 4) A connection holds weak references to its two component endpoints.
  83          */
  84         struct bt_object base;
  85
  86         /* Array of pointers to bt_connection. */
  87         GPtrArray *connections;
  88         /* Array of pointers to bt_component. */
  89         GPtrArray *components;
  90         /* Queue of pointers (weak references) to sink bt_components. */
  91         GQueue *sinks_to_consume;
  92
  93         uint64_t mip_version;
  94
  95         /*
  96          * Array of `struct bt_interrupter *`, each one owned by this.
  97          * If any interrupter is set, then this graph is deemed
  98          * interrupted.
  99          */
 100         GPtrArray *interrupters;
 101
 102         /*
 103          * Default interrupter to support bt_graph_interrupt(); owned
 104          * by this.
 105          */
 106         struct bt_interrupter *default_interrupter;
 107
 108         bool in_remove_listener;
 109         bool has_sink;
 110
 111         /*
 112          * If this is false, then the public API's consuming
 113          * functions (bt_graph_consume() and bt_graph_run()) return
 114          * BT_FUNC_STATUS_CANNOT_CONSUME. The internal "no check"
 115          * functions always work.
 116          *
 117          * In bt_port_output_message_iterator_create(), on success,
 118          * this flag is cleared so that the iterator remains the only
 119          * consumer for the graph's lifetime.
 120          */
 121         bool can_consume;
 122
 123         enum bt_graph_configuration_state config_state;
 124
 125         struct {
 126                 GArray *source_output_port_added;
 127                 GArray *filter_output_port_added;
 128                 GArray *filter_input_port_added;
 129                 GArray *sink_input_port_added;
 130                 GArray *source_filter_ports_connected;
 131                 GArray *source_sink_ports_connected;
 132                 GArray *filter_filter_ports_connected;
 133                 GArray *filter_sink_ports_connected;
 134         } listeners;
 135
 136         /* Pool of `struct bt_message_event *` */
 137         struct bt_object_pool event_msg_pool;
 138
 139         /* Pool of `struct bt_message_packet_beginning *` */
 140         struct bt_object_pool packet_begin_msg_pool;
 141
 142         /* Pool of `struct bt_message_packet_end *` */
 143         struct bt_object_pool packet_end_msg_pool;
 144
 145         /*
 146          * Array of `struct bt_message *` (weak).
 147          *
 148          * This is an array of all the messages ever created from
 149          * this graph. Some of them can be in one of the pools above,
 150          * some of them can be at large. Because each message has a
 151          * weak pointer to the graph containing its pool, we need to
 152          * notify each message that the graph is gone on graph
 153          * destruction.
 154          *
 155          * TODO: When we support a maximum size for object pools,
 156          * add a way for a message to remove itself from this
 157          * array (on destruction).
 158          */
 159         GPtrArray *messages;
 160 };
 161
 162 static inline
 163 void bt_graph_set_can_consume(struct bt_graph *graph, bool can_consume)
 164 {
 165         BT_ASSERT_DBG(graph);
 166         graph->can_consume = can_consume;
 167 }
 168
 169 BT_HIDDEN
 170 int bt_graph_consume_sink_no_check(struct bt_graph *graph,
 171                 struct bt_component_sink *sink);
 172
 173 BT_HIDDEN
 174 enum bt_graph_listener_func_status bt_graph_notify_port_added(struct bt_graph *graph,
 175                 struct bt_port *port);
 176
 177 BT_HIDDEN
 178 enum bt_graph_listener_func_status bt_graph_notify_ports_connected(
 179                 struct bt_graph *graph, struct bt_port *upstream_port,
 180                 struct bt_port *downstream_port);
 181
 182 BT_HIDDEN
 183 void bt_graph_remove_connection(struct bt_graph *graph,
 184                 struct bt_connection *connection);
 185
 186 /*
 187  * This only works with a component which is not connected at this
 188  * point.
 189  *
 190  * Also the reference count of `component` should be 0 when you call
 191  * this function, which means only `graph` owns the component, so it
 192  * is safe to destroy.
 193  */
 194 BT_HIDDEN
 195 int bt_graph_remove_unconnected_component(struct bt_graph *graph,
 196                 struct bt_component *component);
 197
 198 BT_HIDDEN
 199 void bt_graph_add_message(struct bt_graph *graph,
 200                 struct bt_message *msg);
 201
 202 BT_HIDDEN
 203 bool bt_graph_is_interrupted(const struct bt_graph *graph);
 204
 205 static inline
 206 const char *bt_graph_configuration_state_string(
 207                 enum bt_graph_configuration_state state)
 208 {
 209         switch (state) {
 210         case BT_GRAPH_CONFIGURATION_STATE_CONFIGURING:
 211                 return "CONFIGURING";
 212         case BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED:
 213                 return "PARTIALLY_CONFIGURED";
 214         case BT_GRAPH_CONFIGURATION_STATE_CONFIGURED:
 215                 return "CONFIGURED";
 216         case BT_GRAPH_CONFIGURATION_STATE_FAULTY:
 217                 return "FAULTY";
 218         case BT_GRAPH_CONFIGURATION_STATE_DESTROYING:
 219                 return "DESTROYING";
 220         default:
 221                 return "(unknown)";
 222         }
 223 }
 224
 225 static inline
 226 int bt_graph_configure(struct bt_graph *graph)
 227 {
 228         int status = BT_FUNC_STATUS_OK;
 229         uint64_t i;
 230
 231         BT_ASSERT_DBG(graph->config_state !=
 232                 BT_GRAPH_CONFIGURATION_STATE_FAULTY);
 233
 234         if (G_LIKELY(graph->config_state ==
 235                         BT_GRAPH_CONFIGURATION_STATE_CONFIGURED)) {
 236                 goto end;
 237         }
 238
 239         BT_ASSERT_PRE(graph->has_sink, "Graph has no sink component: %!+g", graph);
 240         graph->config_state = BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED;
 241
 242         for (i = 0; i < graph->components->len; i++) {
 243                 struct bt_component *comp = graph->components->pdata[i];
 244                 struct bt_component_sink *comp_sink = (void *) comp;
 245                 struct bt_component_class_sink *comp_cls_sink =
 246                         (void *) comp->class;
 247
 248                 if (comp->class->type != BT_COMPONENT_CLASS_TYPE_SINK) {
 249                         continue;
 250                 }
 251
 252                 if (comp_sink->graph_is_configured_method_called) {
 253                         continue;
 254                 }
 255
 256                 if (comp_cls_sink->methods.graph_is_configured) {
 257                         enum bt_component_class_sink_graph_is_configured_method_status comp_status;
 258
 259                         BT_LIB_LOGD("Calling user's \"graph is configured\" method: "
 260                                 "%![graph-]+g, %![comp-]+c",
 261                                 graph, comp);
 262                         comp_status = comp_cls_sink->methods.graph_is_configured(
 263                                 (void *) comp_sink);
 264                         BT_LIB_LOGD("User method returned: status=%s",
 265                                 bt_common_func_status_string(comp_status));
 266                         BT_ASSERT_POST(comp_status == BT_FUNC_STATUS_OK ||
 267                                 comp_status == BT_FUNC_STATUS_ERROR ||
 268                                 comp_status == BT_FUNC_STATUS_MEMORY_ERROR,
 269                                 "Unexpected returned status: status=%s",
 270                                 bt_common_func_status_string(comp_status));
 271                         if (comp_status != BT_FUNC_STATUS_OK) {
 272                                 if (comp_status < 0) {
 273                                         BT_LIB_LOGW_APPEND_CAUSE(
 274                                                 "Component's \"graph is configured\" method failed: "
 275                                                 "%![comp-]+c, status=%s",
 276                                                 comp,
 277                                                 bt_common_func_status_string(
 278                                                         comp_status));
 279                                 }
 280
 281                                 status = comp_status;
 282                                 goto end;
 283                         }
 284                 }
 285
 286                 comp_sink->graph_is_configured_method_called = true;
 287         }
 288
 289         graph->config_state = BT_GRAPH_CONFIGURATION_STATE_CONFIGURED;
 290
 291 end:
 292         return status;
 293 }
 294
 295 static inline
 296 void bt_graph_make_faulty(struct bt_graph *graph)
 297 {
 298         graph->config_state = BT_GRAPH_CONFIGURATION_STATE_FAULTY;
 299         BT_LIB_LOGI("Set graph's state to faulty: %![graph-]+g", graph);
 300 }
 301
 302 #endif /* BABELTRACE_GRAPH_GRAPH_INTERNAL_H */