| 1 | #ifndef BABELTRACE_GRAPH_COMPONENT_INTERNAL_H |
| 2 | #define BABELTRACE_GRAPH_COMPONENT_INTERNAL_H |
| 3 | |
| 4 | /* |
| 5 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> |
| 6 | * Copyright 2015 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 "common/macros.h" |
| 28 | #include <babeltrace2/graph/component-const.h> |
| 29 | #include <babeltrace2/graph/component-class.h> |
| 30 | #include "lib/object.h" |
| 31 | #include <babeltrace2/types.h> |
| 32 | #include <babeltrace2/logging.h> |
| 33 | #include "common/assert.h" |
| 34 | #include <glib.h> |
| 35 | #include <stdio.h> |
| 36 | |
| 37 | #include "component-class.h" |
| 38 | #include "port.h" |
| 39 | |
| 40 | typedef void (*bt_component_destroy_listener_func)( |
| 41 | struct bt_component *class, void *data); |
| 42 | |
| 43 | struct bt_component_destroy_listener { |
| 44 | bt_component_destroy_listener_func func; |
| 45 | void *data; |
| 46 | }; |
| 47 | |
| 48 | struct bt_graph; |
| 49 | |
| 50 | struct bt_component { |
| 51 | struct bt_object base; |
| 52 | struct bt_component_class *class; |
| 53 | GString *name; |
| 54 | bt_logging_level log_level; |
| 55 | |
| 56 | /* |
| 57 | * Internal destroy function specific to a source, filter, or |
| 58 | * sink component object. |
| 59 | */ |
| 60 | void (*destroy)(struct bt_component *); |
| 61 | |
| 62 | /* User-defined data */ |
| 63 | void *user_data; |
| 64 | |
| 65 | /* Input and output ports (weak references) */ |
| 66 | GPtrArray *input_ports; |
| 67 | GPtrArray *output_ports; |
| 68 | |
| 69 | /* Array of struct bt_component_destroy_listener */ |
| 70 | GArray *destroy_listeners; |
| 71 | |
| 72 | bool initialized; |
| 73 | }; |
| 74 | |
| 75 | static inline |
| 76 | struct bt_graph *bt_component_borrow_graph(struct bt_component *comp) |
| 77 | { |
| 78 | BT_ASSERT(comp); |
| 79 | return (void *) bt_object_borrow_parent(&comp->base); |
| 80 | } |
| 81 | |
| 82 | BT_HIDDEN |
| 83 | int bt_component_create(struct bt_component_class *component_class, |
| 84 | const char *name, bt_logging_level log_level, |
| 85 | struct bt_component **component); |
| 86 | |
| 87 | BT_HIDDEN |
| 88 | enum bt_component_class_port_connected_method_status |
| 89 | bt_component_port_connected( |
| 90 | struct bt_component *comp, |
| 91 | struct bt_port *self_port, struct bt_port *other_port); |
| 92 | |
| 93 | BT_HIDDEN |
| 94 | void bt_component_set_graph(struct bt_component *component, |
| 95 | struct bt_graph *graph); |
| 96 | |
| 97 | BT_HIDDEN |
| 98 | uint64_t bt_component_get_input_port_count(const struct bt_component *comp); |
| 99 | |
| 100 | BT_HIDDEN |
| 101 | uint64_t bt_component_get_output_port_count(const struct bt_component *comp); |
| 102 | |
| 103 | BT_HIDDEN |
| 104 | struct bt_port_input *bt_component_borrow_input_port_by_index( |
| 105 | struct bt_component *comp, uint64_t index); |
| 106 | |
| 107 | BT_HIDDEN |
| 108 | struct bt_port_output *bt_component_borrow_output_port_by_index( |
| 109 | struct bt_component *comp, uint64_t index); |
| 110 | |
| 111 | BT_HIDDEN |
| 112 | struct bt_port_input *bt_component_borrow_input_port_by_name( |
| 113 | struct bt_component *comp, const char *name); |
| 114 | |
| 115 | BT_HIDDEN |
| 116 | struct bt_port_output *bt_component_borrow_output_port_by_name( |
| 117 | struct bt_component *comp, const char *name); |
| 118 | |
| 119 | BT_HIDDEN |
| 120 | enum bt_self_component_add_port_status bt_component_add_input_port( |
| 121 | struct bt_component *component, const char *name, |
| 122 | void *user_data, struct bt_port **port); |
| 123 | |
| 124 | BT_HIDDEN |
| 125 | enum bt_self_component_add_port_status bt_component_add_output_port( |
| 126 | struct bt_component *component, const char *name, |
| 127 | void *user_data, struct bt_port **port); |
| 128 | |
| 129 | BT_HIDDEN |
| 130 | void bt_component_remove_port(struct bt_component *component, |
| 131 | struct bt_port *port); |
| 132 | |
| 133 | BT_HIDDEN |
| 134 | void bt_component_add_destroy_listener(struct bt_component *component, |
| 135 | bt_component_destroy_listener_func func, void *data); |
| 136 | |
| 137 | BT_HIDDEN |
| 138 | void bt_component_remove_destroy_listener(struct bt_component *component, |
| 139 | bt_component_destroy_listener_func func, void *data); |
| 140 | |
| 141 | #endif /* BABELTRACE_GRAPH_COMPONENT_INTERNAL_H */ |