| 1 | #ifndef BABELTRACE_COMPONENT_COMPONENT_GRAPH_INTERNAL_H |
| 2 | #define BABELTRACE_COMPONENT_COMPONENT_GRAPH_INTERNAL_H |
| 3 | |
| 4 | /* |
| 5 | * BabelTrace - Component Graph Internal |
| 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/graph.h> |
| 31 | #include <babeltrace/graph/component-status.h> |
| 32 | #include <babeltrace/babeltrace-internal.h> |
| 33 | #include <babeltrace/object-internal.h> |
| 34 | #include <stdlib.h> |
| 35 | #include <glib.h> |
| 36 | |
| 37 | struct bt_component; |
| 38 | struct bt_port; |
| 39 | |
| 40 | struct bt_graph { |
| 41 | /** |
| 42 | * A component graph contains components and point-to-point connection |
| 43 | * between these components. |
| 44 | * |
| 45 | * In terms of ownership: |
| 46 | * 1) The graph is the components' parent, |
| 47 | * 2) The graph is the connnections' parent, |
| 48 | * 3) Components share the ownership of their connections, |
| 49 | * 4) A connection holds weak references to its two component endpoints. |
| 50 | */ |
| 51 | struct bt_object base; |
| 52 | |
| 53 | /* Array of pointers to bt_connection. */ |
| 54 | GPtrArray *connections; |
| 55 | /* Array of pointers to bt_component. */ |
| 56 | GPtrArray *components; |
| 57 | /* Queue of pointers (weak references) to sink bt_components. */ |
| 58 | GQueue *sinks_to_consume; |
| 59 | |
| 60 | bt_bool canceled; |
| 61 | bt_bool in_remove_listener; |
| 62 | |
| 63 | struct { |
| 64 | GArray *port_added; |
| 65 | GArray *port_removed; |
| 66 | GArray *ports_connected; |
| 67 | GArray *ports_disconnected; |
| 68 | } listeners; |
| 69 | }; |
| 70 | |
| 71 | BT_HIDDEN |
| 72 | void bt_graph_notify_port_added(struct bt_graph *graph, struct bt_port *port); |
| 73 | |
| 74 | BT_HIDDEN |
| 75 | void bt_graph_notify_port_removed(struct bt_graph *graph, |
| 76 | struct bt_component *comp, struct bt_port *port); |
| 77 | |
| 78 | BT_HIDDEN |
| 79 | void bt_graph_notify_ports_connected(struct bt_graph *graph, |
| 80 | struct bt_port *upstream_port, struct bt_port *downstream_port); |
| 81 | |
| 82 | BT_HIDDEN |
| 83 | void bt_graph_notify_ports_disconnected(struct bt_graph *graph, |
| 84 | struct bt_component *upstream_comp, |
| 85 | struct bt_component *downstream_comp, |
| 86 | struct bt_port *upstream_port, |
| 87 | struct bt_port *downstream_port); |
| 88 | |
| 89 | BT_HIDDEN |
| 90 | void bt_graph_remove_connection(struct bt_graph *graph, |
| 91 | struct bt_connection *connection); |
| 92 | |
| 93 | static inline |
| 94 | const char *bt_graph_status_string(enum bt_graph_status status) |
| 95 | { |
| 96 | switch (status) { |
| 97 | case BT_GRAPH_STATUS_CANCELED: |
| 98 | return "BT_GRAPH_STATUS_CANCELED"; |
| 99 | case BT_GRAPH_STATUS_AGAIN: |
| 100 | return "BT_GRAPH_STATUS_AGAIN"; |
| 101 | case BT_GRAPH_STATUS_END: |
| 102 | return "BT_GRAPH_STATUS_END"; |
| 103 | case BT_GRAPH_STATUS_OK: |
| 104 | return "BT_GRAPH_STATUS_OK"; |
| 105 | case BT_GRAPH_STATUS_INVALID: |
| 106 | return "BT_GRAPH_STATUS_INVALID"; |
| 107 | case BT_GRAPH_STATUS_NO_SINK: |
| 108 | return "BT_GRAPH_STATUS_NO_SINK"; |
| 109 | case BT_GRAPH_STATUS_ERROR: |
| 110 | return "BT_GRAPH_STATUS_ERROR"; |
| 111 | case BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION: |
| 112 | return "BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION"; |
| 113 | case BT_GRAPH_STATUS_NOMEM: |
| 114 | return "BT_GRAPH_STATUS_NOMEM"; |
| 115 | default: |
| 116 | return "(unknown)"; |
| 117 | } |
| 118 | } |
| 119 | |
| 120 | static inline |
| 121 | enum bt_graph_status bt_graph_status_from_component_status( |
| 122 | enum bt_component_status comp_status) |
| 123 | { |
| 124 | switch (comp_status) { |
| 125 | case BT_COMPONENT_STATUS_OK: |
| 126 | return BT_GRAPH_STATUS_OK; |
| 127 | case BT_COMPONENT_STATUS_END: |
| 128 | return BT_GRAPH_STATUS_END; |
| 129 | case BT_COMPONENT_STATUS_AGAIN: |
| 130 | return BT_GRAPH_STATUS_AGAIN; |
| 131 | case BT_COMPONENT_STATUS_REFUSE_PORT_CONNECTION: |
| 132 | return BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION; |
| 133 | case BT_COMPONENT_STATUS_ERROR: |
| 134 | return BT_GRAPH_STATUS_ERROR; |
| 135 | case BT_COMPONENT_STATUS_UNSUPPORTED: |
| 136 | return BT_GRAPH_STATUS_ERROR; |
| 137 | case BT_COMPONENT_STATUS_INVALID: |
| 138 | return BT_GRAPH_STATUS_INVALID; |
| 139 | case BT_COMPONENT_STATUS_NOMEM: |
| 140 | return BT_GRAPH_STATUS_NOMEM; |
| 141 | case BT_COMPONENT_STATUS_NOT_FOUND: |
| 142 | return BT_GRAPH_STATUS_ERROR; |
| 143 | default: |
| 144 | #ifdef BT_LOGF |
| 145 | BT_LOGF("Unknown component status: status=%d", comp_status); |
| 146 | #endif |
| 147 | abort(); |
| 148 | } |
| 149 | } |
| 150 | |
| 151 | #endif /* BABELTRACE_COMPONENT_COMPONENT_GRAPH_INTERNAL_H */ |