Commit | Line | Data |
---|---|---|
33b34c43 PP |
1 | #ifndef BABELTRACE_COMPONENT_COMPONENT_INTERNAL_H |
2 | #define BABELTRACE_COMPONENT_COMPONENT_INTERNAL_H | |
90354d3a JG |
3 | |
4 | /* | |
633edee0 | 5 | * BabelTrace - Component internal |
90354d3a JG |
6 | * |
7 | * Copyright 2015 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 | ||
0db5ca2c | 30 | #include <babeltrace/babeltrace-internal.h> |
b2e0c907 PP |
31 | #include <babeltrace/graph/component.h> |
32 | #include <babeltrace/graph/component-class-internal.h> | |
33 | #include <babeltrace/graph/port-internal.h> | |
b8a06801 | 34 | #include <babeltrace/object-internal.h> |
c55a9f58 | 35 | #include <babeltrace/types.h> |
0db5ca2c | 36 | #include <glib.h> |
38d02a17 | 37 | #include <stdio.h> |
90354d3a | 38 | |
3230ee6b PP |
39 | typedef void (*bt_component_destroy_listener_func)( |
40 | struct bt_component *class, void *data); | |
41 | ||
42 | struct bt_component_destroy_listener { | |
43 | bt_component_destroy_listener_func func; | |
44 | void *data; | |
45 | }; | |
46 | ||
633edee0 | 47 | struct bt_component { |
b8a06801 | 48 | struct bt_object base; |
fb2dcc52 | 49 | struct bt_component_class *class; |
0db5ca2c | 50 | GString *name; |
584e4e78 | 51 | |
72b913fb | 52 | /* |
d3e4dcd8 PP |
53 | * Internal destroy function specific to a source, filter, or |
54 | * sink component object. | |
55 | */ | |
890882ef | 56 | void (*destroy)(struct bt_component *); |
d3e4dcd8 | 57 | |
72b913fb | 58 | /* User-defined data */ |
0777b693 | 59 | void *user_data; |
fec2a9f2 | 60 | |
72b913fb PP |
61 | /* Input and output ports (weak references) */ |
62 | GPtrArray *input_ports; | |
63 | GPtrArray *output_ports; | |
3230ee6b PP |
64 | |
65 | /* Array of struct bt_component_destroy_listener */ | |
66 | GArray *destroy_listeners; | |
36712f1d PP |
67 | |
68 | bool initialized; | |
72b913fb | 69 | }; |
38b48196 | 70 | |
890882ef PP |
71 | static inline |
72 | struct bt_component *bt_component_from_private( | |
73 | struct bt_private_component *private_component) | |
74 | { | |
75 | return (void *) private_component; | |
76 | } | |
77 | ||
78 | static inline | |
79 | struct bt_private_component *bt_private_component_from_component( | |
80 | struct bt_component *component) | |
81 | { | |
82 | return (void *) component; | |
83 | } | |
5645cd95 | 84 | |
4dc8c91f PP |
85 | static inline |
86 | struct bt_graph *bt_component_borrow_graph(struct bt_component *comp) | |
87 | { | |
88 | assert(comp); | |
89 | return (void *) comp->base.parent; | |
90 | } | |
91 | ||
36712f1d PP |
92 | BT_HIDDEN |
93 | enum bt_component_status bt_component_create( | |
94 | struct bt_component_class *component_class, | |
95 | const char *name, struct bt_component **component); | |
96 | ||
2d41b99e | 97 | BT_HIDDEN |
72b913fb | 98 | enum bt_component_status bt_component_accept_port_connection( |
8f4799f7 PP |
99 | struct bt_component *component, struct bt_port *self_port, |
100 | struct bt_port *other_port); | |
72b913fb | 101 | |
0d8b4d8e PP |
102 | BT_HIDDEN |
103 | void bt_component_port_connected(struct bt_component *comp, | |
104 | struct bt_port *self_port, struct bt_port *other_port); | |
105 | ||
72b913fb PP |
106 | BT_HIDDEN |
107 | void bt_component_port_disconnected(struct bt_component *comp, | |
108 | struct bt_port *port); | |
2d41b99e | 109 | |
366e034f | 110 | BT_HIDDEN |
f60c8b34 | 111 | void bt_component_set_graph(struct bt_component *component, |
366e034f JG |
112 | struct bt_graph *graph); |
113 | ||
114 | BT_HIDDEN | |
544d0515 | 115 | int64_t bt_component_get_input_port_count(struct bt_component *comp); |
366e034f JG |
116 | |
117 | BT_HIDDEN | |
544d0515 | 118 | int64_t bt_component_get_output_port_count(struct bt_component *comp); |
366e034f JG |
119 | |
120 | BT_HIDDEN | |
9ac68eb1 PP |
121 | struct bt_port *bt_component_get_input_port_by_index(struct bt_component *comp, |
122 | uint64_t index); | |
366e034f JG |
123 | |
124 | BT_HIDDEN | |
9ac68eb1 PP |
125 | struct bt_port *bt_component_get_output_port_by_index(struct bt_component *comp, |
126 | uint64_t index); | |
366e034f JG |
127 | |
128 | BT_HIDDEN | |
9ac68eb1 | 129 | struct bt_port *bt_component_get_input_port_by_name(struct bt_component *comp, |
72b913fb | 130 | const char *name); |
366e034f JG |
131 | |
132 | BT_HIDDEN | |
9ac68eb1 | 133 | struct bt_port *bt_component_get_output_port_by_name(struct bt_component *comp, |
366e034f JG |
134 | const char *name); |
135 | ||
72b913fb PP |
136 | BT_HIDDEN |
137 | struct bt_port *bt_component_add_input_port( | |
3e9b0023 PP |
138 | struct bt_component *component, const char *name, |
139 | void *user_data); | |
72b913fb PP |
140 | |
141 | BT_HIDDEN | |
142 | struct bt_port *bt_component_add_output_port( | |
3e9b0023 PP |
143 | struct bt_component *component, const char *name, |
144 | void *user_data); | |
72b913fb PP |
145 | |
146 | BT_HIDDEN | |
147 | enum bt_component_status bt_component_remove_port( | |
148 | struct bt_component *component, struct bt_port *port); | |
149 | ||
3230ee6b PP |
150 | BT_HIDDEN |
151 | void bt_component_add_destroy_listener(struct bt_component *component, | |
152 | bt_component_destroy_listener_func func, void *data); | |
153 | ||
154 | BT_HIDDEN | |
155 | void bt_component_remove_destroy_listener(struct bt_component *component, | |
156 | bt_component_destroy_listener_func func, void *data); | |
157 | ||
262e5473 PP |
158 | static inline |
159 | const char *bt_component_status_string(enum bt_component_status status) | |
160 | { | |
161 | switch (status) { | |
162 | case BT_COMPONENT_STATUS_OK: | |
163 | return "BT_COMPONENT_STATUS_OK"; | |
164 | case BT_COMPONENT_STATUS_END: | |
165 | return "BT_COMPONENT_STATUS_END"; | |
166 | case BT_COMPONENT_STATUS_AGAIN: | |
167 | return "BT_COMPONENT_STATUS_AGAIN"; | |
168 | case BT_COMPONENT_STATUS_REFUSE_PORT_CONNECTION: | |
169 | return "BT_COMPONENT_STATUS_REFUSE_PORT_CONNECTION"; | |
170 | case BT_COMPONENT_STATUS_ERROR: | |
171 | return "BT_COMPONENT_STATUS_ERROR"; | |
172 | case BT_COMPONENT_STATUS_UNSUPPORTED: | |
173 | return "BT_COMPONENT_STATUS_UNSUPPORTED"; | |
174 | case BT_COMPONENT_STATUS_INVALID: | |
175 | return "BT_COMPONENT_STATUS_INVALID"; | |
176 | case BT_COMPONENT_STATUS_NOMEM: | |
177 | return "BT_COMPONENT_STATUS_NOMEM"; | |
178 | case BT_COMPONENT_STATUS_NOT_FOUND: | |
179 | return "BT_COMPONENT_STATUS_NOT_FOUND"; | |
bd7cc15b PP |
180 | case BT_COMPONENT_STATUS_GRAPH_IS_CANCELED: |
181 | return "BT_COMPONENT_STATUS_GRAPH_IS_CANCELED"; | |
262e5473 PP |
182 | default: |
183 | return "(unknown)"; | |
184 | } | |
185 | } | |
186 | ||
33b34c43 | 187 | #endif /* BABELTRACE_COMPONENT_COMPONENT_INTERNAL_H */ |