Commit | Line | Data |
---|---|---|
abe30a8f PP |
1 | #ifndef BABELTRACE_GRAPH_COMPONENT_INTERNAL_H |
2 | #define BABELTRACE_GRAPH_COMPONENT_INTERNAL_H | |
90354d3a JG |
3 | |
4 | /* | |
f2b0325d | 5 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> |
90354d3a JG |
6 | * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
7 | * | |
90354d3a JG |
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 | ||
85e7137b | 27 | #include "common/macros.h" |
71c5da58 | 28 | #include <babeltrace2/graph/component-const.h> |
57952005 | 29 | #include "lib/object.h" |
71c5da58 | 30 | #include <babeltrace2/types.h> |
57952005 | 31 | #include "common/assert.h" |
0db5ca2c | 32 | #include <glib.h> |
38d02a17 | 33 | #include <stdio.h> |
90354d3a | 34 | |
57952005 MJ |
35 | #include "component-class.h" |
36 | #include "port.h" | |
37 | ||
3230ee6b PP |
38 | typedef void (*bt_component_destroy_listener_func)( |
39 | struct bt_component *class, void *data); | |
40 | ||
41 | struct bt_component_destroy_listener { | |
42 | bt_component_destroy_listener_func func; | |
43 | void *data; | |
44 | }; | |
45 | ||
9e550e5f PP |
46 | struct bt_graph; |
47 | ||
633edee0 | 48 | struct bt_component { |
b8a06801 | 49 | struct bt_object base; |
fb2dcc52 | 50 | struct bt_component_class *class; |
0db5ca2c | 51 | GString *name; |
584e4e78 | 52 | |
72b913fb | 53 | /* |
d3e4dcd8 PP |
54 | * Internal destroy function specific to a source, filter, or |
55 | * sink component object. | |
56 | */ | |
890882ef | 57 | void (*destroy)(struct bt_component *); |
d3e4dcd8 | 58 | |
72b913fb | 59 | /* User-defined data */ |
0777b693 | 60 | void *user_data; |
fec2a9f2 | 61 | |
72b913fb PP |
62 | /* Input and output ports (weak references) */ |
63 | GPtrArray *input_ports; | |
64 | GPtrArray *output_ports; | |
3230ee6b PP |
65 | |
66 | /* Array of struct bt_component_destroy_listener */ | |
67 | GArray *destroy_listeners; | |
36712f1d PP |
68 | |
69 | bool initialized; | |
72b913fb | 70 | }; |
38b48196 | 71 | |
9e550e5f PP |
72 | static inline |
73 | struct bt_graph *bt_component_borrow_graph(struct bt_component *comp) | |
74 | { | |
75 | BT_ASSERT(comp); | |
76 | return (void *) bt_object_borrow_parent(&comp->base); | |
77 | } | |
78 | ||
36712f1d | 79 | BT_HIDDEN |
834e9996 | 80 | int bt_component_create(struct bt_component_class *component_class, |
36712f1d PP |
81 | const char *name, struct bt_component **component); |
82 | ||
2d41b99e | 83 | BT_HIDDEN |
834e9996 | 84 | enum bt_self_component_status bt_component_accept_port_connection( |
8f4799f7 PP |
85 | struct bt_component *component, struct bt_port *self_port, |
86 | struct bt_port *other_port); | |
72b913fb | 87 | |
0d8b4d8e | 88 | BT_HIDDEN |
834e9996 | 89 | enum bt_self_component_status bt_component_port_connected( |
634f394c | 90 | struct bt_component *comp, |
0d8b4d8e PP |
91 | struct bt_port *self_port, struct bt_port *other_port); |
92 | ||
366e034f | 93 | BT_HIDDEN |
f60c8b34 | 94 | void bt_component_set_graph(struct bt_component *component, |
366e034f JG |
95 | struct bt_graph *graph); |
96 | ||
97 | BT_HIDDEN | |
7b53201c | 98 | uint64_t bt_component_get_input_port_count(const struct bt_component *comp); |
366e034f JG |
99 | |
100 | BT_HIDDEN | |
7b53201c | 101 | uint64_t bt_component_get_output_port_count(const struct bt_component *comp); |
366e034f JG |
102 | |
103 | BT_HIDDEN | |
834e9996 PP |
104 | struct bt_port_input *bt_component_borrow_input_port_by_index( |
105 | struct bt_component *comp, uint64_t index); | |
366e034f JG |
106 | |
107 | BT_HIDDEN | |
834e9996 PP |
108 | struct bt_port_output *bt_component_borrow_output_port_by_index( |
109 | struct bt_component *comp, uint64_t index); | |
366e034f JG |
110 | |
111 | BT_HIDDEN | |
834e9996 PP |
112 | struct bt_port_input *bt_component_borrow_input_port_by_name( |
113 | struct bt_component *comp, const char *name); | |
366e034f JG |
114 | |
115 | BT_HIDDEN | |
834e9996 PP |
116 | struct bt_port_output *bt_component_borrow_output_port_by_name( |
117 | struct bt_component *comp, const char *name); | |
366e034f | 118 | |
72b913fb | 119 | BT_HIDDEN |
e18f3e2b | 120 | enum bt_self_component_status bt_component_add_input_port( |
3e9b0023 | 121 | struct bt_component *component, const char *name, |
e18f3e2b | 122 | void *user_data, struct bt_port **port); |
72b913fb PP |
123 | |
124 | BT_HIDDEN | |
e18f3e2b | 125 | enum bt_self_component_status bt_component_add_output_port( |
3e9b0023 | 126 | struct bt_component *component, const char *name, |
e18f3e2b | 127 | void *user_data, struct bt_port **port); |
72b913fb PP |
128 | |
129 | BT_HIDDEN | |
834e9996 PP |
130 | void bt_component_remove_port(struct bt_component *component, |
131 | struct bt_port *port); | |
72b913fb | 132 | |
3230ee6b PP |
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 | ||
262e5473 | 141 | static inline |
834e9996 PP |
142 | const char *bt_self_component_status_string( |
143 | enum bt_self_component_status status) | |
262e5473 PP |
144 | { |
145 | switch (status) { | |
834e9996 PP |
146 | case BT_SELF_COMPONENT_STATUS_OK: |
147 | return "BT_SELF_COMPONENT_STATUS_OK"; | |
148 | case BT_SELF_COMPONENT_STATUS_END: | |
149 | return "BT_SELF_COMPONENT_STATUS_END"; | |
150 | case BT_SELF_COMPONENT_STATUS_AGAIN: | |
151 | return "BT_SELF_COMPONENT_STATUS_AGAIN"; | |
152 | case BT_SELF_COMPONENT_STATUS_REFUSE_PORT_CONNECTION: | |
153 | return "BT_SELF_COMPONENT_STATUS_REFUSE_PORT_CONNECTION"; | |
154 | case BT_SELF_COMPONENT_STATUS_ERROR: | |
155 | return "BT_SELF_COMPONENT_STATUS_ERROR"; | |
156 | case BT_SELF_COMPONENT_STATUS_NOMEM: | |
157 | return "BT_SELF_COMPONENT_STATUS_NOMEM"; | |
262e5473 PP |
158 | default: |
159 | return "(unknown)"; | |
160 | } | |
161 | } | |
162 | ||
abe30a8f | 163 | #endif /* BABELTRACE_GRAPH_COMPONENT_INTERNAL_H */ |