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