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