include/babeltrace/graph/graph.h

   1 #ifndef BABELTRACE_GRAPH_GRAPH_H
   2 #define BABELTRACE_GRAPH_GRAPH_H
   3
   4 /*
   5  * BabelTrace - Babeltrace Graph Interface
   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/component.h>
  31 #include <babeltrace/types.h>
  32
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif
  36
  37 struct bt_port;
  38 struct bt_connection;
  39
  40 enum bt_graph_status {
  41         /** Canceled. */
  42         BT_GRAPH_STATUS_CANCELED = 125,
  43         /** No sink can consume at the moment. */
  44         BT_GRAPH_STATUS_AGAIN = 11,
  45         /** Downstream component does not support multiple inputs. */
  46         BT_GRAPH_STATUS_END = 1,
  47         BT_GRAPH_STATUS_OK = 0,
  48         /** Component is already part of another graph. */
  49         BT_GRAPH_STATUS_ALREADY_IN_A_GRAPH = -2,
  50         /** Invalid arguments. */
  51         BT_GRAPH_STATUS_INVALID = -22,
  52         /** No sink in graph. */
  53         BT_GRAPH_STATUS_NO_SINK = -6,
  54         /** General error. */
  55         BT_GRAPH_STATUS_ERROR = -1,
  56 };
  57
  58 typedef void (*bt_graph_port_added_listener)(struct bt_port *port,
  59                 void *data);
  60 typedef void (*bt_graph_port_removed_listener)(struct bt_component *component,
  61                 struct bt_port *port, void *data);
  62 typedef void (*bt_graph_ports_connected_listener)(struct bt_port *upstream_port,
  63                 struct bt_port *downstream_port, void *data);
  64 typedef void (*bt_graph_ports_disconnected_listener)(
  65                 struct bt_component *upstream_component,
  66                 struct bt_component *downstream_component,
  67                 struct bt_port *upstream_port, struct bt_port *downstream_port,
  68                 void *data);
  69
  70 extern struct bt_graph *bt_graph_create(void);
  71
  72 /**
  73  * Creates a connection between two components using the two ports specified
  74  * and adds the connection and components (if not already added) to the graph.
  75  */
  76 extern struct bt_connection *bt_graph_connect_ports(struct bt_graph *graph,
  77                 struct bt_port *upstream,
  78                 struct bt_port *downstream);
  79
  80 /**
  81  * Add a component as a "sibling" of the origin component. Sibling share
  82  * connections equivalent to each other at the time of connection (same
  83  * upstream and downstream ports).
  84  */
  85 extern enum bt_graph_status bt_graph_add_component_as_sibling(
  86                 struct bt_graph *graph, struct bt_component *origin,
  87                 struct bt_component *new_component);
  88
  89 /**
  90  * Run graph to completion or until a single sink is left and "AGAIN" is received.
  91  *
  92  * Runs "bt_component_sink_consume()" on all sinks in round-robin until they all
  93  * indicate that the end is reached or that an error occured.
  94  */
  95 extern enum bt_graph_status bt_graph_run(struct bt_graph *graph);
  96
  97 /**
  98  * Runs "bt_component_sink_consume()" on the graph's sinks. Each invokation will
  99  * invoke "bt_component_sink_consume()" on the next sink, in round-robin, until
 100  * they all indicated that the end is reached.
 101  */
 102 extern enum bt_graph_status bt_graph_consume(struct bt_graph *graph);
 103
 104 extern enum bt_graph_status bt_graph_add_port_added_listener(
 105                 struct bt_graph *graph,
 106                 bt_graph_port_added_listener listener, void *data);
 107
 108 extern enum bt_graph_status bt_graph_add_port_removed_listener(
 109                 struct bt_graph *graph,
 110                 bt_graph_port_removed_listener listener, void *data);
 111
 112 extern enum bt_graph_status bt_graph_add_ports_connected_listener(
 113                 struct bt_graph *graph,
 114                 bt_graph_ports_connected_listener listener, void *data);
 115
 116 extern enum bt_graph_status bt_graph_add_ports_disconnected_listener(
 117                 struct bt_graph *graph,
 118                 bt_graph_ports_disconnected_listener listener, void *data);
 119
 120 extern enum bt_graph_status bt_graph_cancel(struct bt_graph *graph);
 121 extern bt_bool bt_graph_is_canceled(struct bt_graph *graph);
 122
 123 #ifdef __cplusplus
 124 }
 125 #endif
 126
 127 #endif /* BABELTRACE_GRAPH_GRAPH_H */