Add bt_graph_add_component(), make bt_component_create() internal
[babeltrace.git] / lib / graph / filter.c
CommitLineData
34ac9eaf
JG
1/*
2 * filter.c
3 *
4 * Babeltrace Filter Component
5 *
6 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 *
8 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
9 *
10 * Permission is hereby granted, free of charge, to any person obtaining a copy
11 * of this software and associated documentation files (the "Software"), to deal
12 * in the Software without restriction, including without limitation the rights
13 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 * copies of the Software, and to permit persons to whom the Software is
15 * furnished to do so, subject to the following conditions:
16 *
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
19 *
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26 * SOFTWARE.
27 */
28
dc217684
PP
29#define BT_LOG_TAG "COMP-FILTER"
30#include <babeltrace/lib-logging-internal.h>
31
3d9990ac 32#include <babeltrace/compiler-internal.h>
34ac9eaf 33#include <babeltrace/values.h>
b2e0c907
PP
34#include <babeltrace/graph/component-filter-internal.h>
35#include <babeltrace/graph/component-internal.h>
36#include <babeltrace/graph/component-class-internal.h>
37#include <babeltrace/graph/notification.h>
38#include <babeltrace/graph/notification-iterator-internal.h>
bd7cc15b 39#include <babeltrace/graph/graph.h>
34ac9eaf 40
72b913fb 41BT_HIDDEN
366e034f
JG
42void bt_component_filter_destroy(struct bt_component *component)
43{
34a9ed19
JG
44}
45
366e034f
JG
46BT_HIDDEN
47struct bt_component *bt_component_filter_create(
36712f1d 48 struct bt_component_class *class)
34a9ed19 49{
366e034f 50 struct bt_component_filter *filter = NULL;
34a9ed19 51
366e034f
JG
52 filter = g_new0(struct bt_component_filter, 1);
53 if (!filter) {
dc217684 54 BT_LOGE_STR("Failed to allocate one filter component.");
34a9ed19
JG
55 goto end;
56 }
57
34a9ed19 58end:
366e034f 59 return filter ? &filter->parent : NULL;
34a9ed19
JG
60}
61
544d0515 62int64_t bt_component_filter_get_input_port_count(
9ac68eb1 63 struct bt_component *component)
34a9ed19 64{
544d0515 65 int64_t ret;
34a9ed19 66
dc217684
PP
67 if (!component) {
68 BT_LOGW_STR("Invalid parameter: component is NULL.");
69 ret = (int64_t) -1;
70 goto end;
71 }
72
73 if (component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
74 BT_LOGW("Invalid parameter: component's class is not a filter component class: "
75 "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
76 component, bt_component_get_name(component),
77 bt_component_class_type_string(component->class->type));
78 ret = (int64_t) -1;
34a9ed19
JG
79 goto end;
80 }
81
9ac68eb1 82 ret = (int64_t) bt_component_get_input_port_count(component);
dc217684 83
366e034f 84end:
544d0515 85 return ret;
366e034f
JG
86}
87
9ac68eb1 88struct bt_port *bt_component_filter_get_input_port_by_name(
366e034f
JG
89 struct bt_component *component, const char *name)
90{
72b913fb 91 struct bt_port *port = NULL;
366e034f 92
dc217684
PP
93 if (!component) {
94 BT_LOGW_STR("Invalid parameter: component is NULL.");
95 goto end;
96 }
97
98 if (!name) {
99 BT_LOGW_STR("Invalid parameter: name is NULL.");
100 goto end;
101 }
102
103 if (component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
104 BT_LOGW("Invalid parameter: component's class is not a filter component class: "
105 "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
106 component, bt_component_get_name(component),
107 bt_component_class_type_string(component->class->type));
34a9ed19
JG
108 goto end;
109 }
110
dc217684 111 /* bt_component_get_input_port_by_name() logs details/errors */
9ac68eb1 112 port = bt_component_get_input_port_by_name(component, name);
dc217684 113
366e034f 114end:
72b913fb 115 return port;
366e034f 116}
d3e4dcd8 117
9ac68eb1
PP
118struct bt_port *bt_component_filter_get_input_port_by_index(
119 struct bt_component *component, uint64_t index)
366e034f
JG
120{
121 struct bt_port *port = NULL;
366e034f 122
dc217684
PP
123 if (!component) {
124 BT_LOGW_STR("Invalid parameter: component is NULL.");
125 goto end;
126 }
127
128 if (component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
129 BT_LOGW("Invalid parameter: component's class is not a filter component class: "
130 "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
131 component, bt_component_get_name(component),
132 bt_component_class_type_string(component->class->type));
366e034f 133 goto end;
34a9ed19
JG
134 }
135
dc217684 136 /* bt_component_get_input_port_by_index() logs details/errors */
9ac68eb1 137 port = bt_component_get_input_port_by_index(component, index);
dc217684 138
34a9ed19 139end:
366e034f 140 return port;
34a9ed19
JG
141}
142
544d0515 143int64_t bt_component_filter_get_output_port_count(
9ac68eb1 144 struct bt_component *component)
526fc31a 145{
544d0515 146 int64_t ret;
526fc31a 147
dc217684
PP
148 if (!component) {
149 BT_LOGW_STR("Invalid parameter: component is NULL.");
150 ret = (int64_t) -1;
526fc31a
JG
151 goto end;
152 }
153
dc217684
PP
154 if (component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
155 BT_LOGW("Invalid parameter: component's class is not a filter component class: "
156 "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
157 component, bt_component_get_name(component),
158 bt_component_class_type_string(component->class->type));
159 ret = (int64_t) -1;
160 goto end;
161 }
162
163 /* bt_component_get_output_port_count() logs details/errors */
544d0515 164 ret = bt_component_get_output_port_count(component);
dc217684 165
526fc31a 166end:
544d0515 167 return ret;
526fc31a
JG
168}
169
9ac68eb1 170struct bt_port *bt_component_filter_get_output_port_by_name(
366e034f 171 struct bt_component *component, const char *name)
526fc31a 172{
72b913fb 173 struct bt_port *port = NULL;
526fc31a 174
dc217684
PP
175 if (!component) {
176 BT_LOGW_STR("Invalid parameter: component is NULL.");
526fc31a
JG
177 goto end;
178 }
179
dc217684
PP
180 if (!name) {
181 BT_LOGW_STR("Invalid parameter: name is NULL.");
182 goto end;
183 }
184
185 if (component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
186 BT_LOGW("Invalid parameter: component's class is not a filter component class: "
187 "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
188 component, bt_component_get_name(component),
189 bt_component_class_type_string(component->class->type));
190 goto end;
191 }
192
193 /* bt_component_get_output_port_by_name() logs details/errors */
9ac68eb1 194 port = bt_component_get_output_port_by_name(component, name);
dc217684 195
366e034f 196end:
72b913fb 197 return port;
366e034f
JG
198}
199
9ac68eb1
PP
200struct bt_port *bt_component_filter_get_output_port_by_index(
201 struct bt_component *component, uint64_t index)
366e034f
JG
202{
203 struct bt_port *port = NULL;
366e034f 204
dc217684
PP
205 if (!component) {
206 BT_LOGW_STR("Invalid parameter: component is NULL.");
207 goto end;
208 }
209
210 if (component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
211 BT_LOGW("Invalid parameter: component's class is not a filter component class: "
212 "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
213 component, bt_component_get_name(component),
214 bt_component_class_type_string(component->class->type));
526fc31a
JG
215 goto end;
216 }
217
dc217684 218 /* bt_component_get_output_port_by_index() logs details/errors */
9ac68eb1 219 port = bt_component_get_output_port_by_index(component, index);
dc217684 220
366e034f
JG
221end:
222 return port;
223}
224
890882ef 225struct bt_private_port *
9ac68eb1
PP
226bt_private_component_filter_get_input_private_port_by_index(
227 struct bt_private_component *private_component, uint64_t index)
890882ef 228{
dc217684 229 /* bt_component_filter_get_input_port_by_index() logs details/errors */
890882ef 230 return bt_private_port_from_port(
9ac68eb1 231 bt_component_filter_get_input_port_by_index(
890882ef
PP
232 bt_component_from_private(private_component), index));
233}
234
235struct bt_private_port *
b9d103be
PP
236bt_private_component_filter_get_input_private_port_by_name(
237 struct bt_private_component *private_component,
238 const char *name)
890882ef 239{
dc217684 240 /* bt_component_filter_get_input_port_by_name() logs details/errors */
890882ef 241 return bt_private_port_from_port(
b9d103be
PP
242 bt_component_filter_get_input_port_by_name(
243 bt_component_from_private(private_component), name));
890882ef
PP
244}
245
147337a3 246enum bt_component_status bt_private_component_filter_add_input_private_port(
890882ef 247 struct bt_private_component *private_component,
147337a3
PP
248 const char *name, void *user_data,
249 struct bt_private_port **user_priv_port)
890882ef 250{
147337a3 251 enum bt_component_status status = BT_COMPONENT_STATUS_OK;
890882ef
PP
252 struct bt_port *port = NULL;
253 struct bt_component *component =
254 bt_component_from_private(private_component);
bd7cc15b 255 struct bt_graph *graph;
890882ef 256
dc217684
PP
257 if (!component) {
258 BT_LOGW_STR("Invalid parameter: component is NULL.");
147337a3 259 status = BT_COMPONENT_STATUS_INVALID;
890882ef
PP
260 goto end;
261 }
262
dc217684
PP
263 if (component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
264 BT_LOGW("Invalid parameter: component's class is not a filter component class: "
265 "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
266 component, bt_component_get_name(component),
267 bt_component_class_type_string(component->class->type));
147337a3 268 status = BT_COMPONENT_STATUS_INVALID;
dc217684
PP
269 goto end;
270 }
271
bd7cc15b
PP
272 graph = bt_component_borrow_graph(component);
273
274 if (graph && bt_graph_is_canceled(graph)) {
43ca7dcc 275 BT_LOGW("Cannot add input port to filter component: graph is canceled: "
bd7cc15b
PP
276 "comp-addr=%p, comp-name=\"%s\", graph-addr=%p",
277 component, bt_component_get_name(component),
278 bt_component_borrow_graph(component));
279 status = BT_COMPONENT_STATUS_GRAPH_IS_CANCELED;
280 goto end;
281 }
282
dc217684 283 /* bt_component_add_input_port() logs details/errors */
3e9b0023 284 port = bt_component_add_input_port(component, name, user_data);
147337a3
PP
285 if (!port) {
286 status = BT_COMPONENT_STATUS_NOMEM;
287 goto end;
288 }
289
290 if (user_priv_port) {
291 /* Move reference to user */
292 *user_priv_port = bt_private_port_from_port(port);
293 port = NULL;
294 }
dc217684 295
890882ef 296end:
147337a3
PP
297 bt_put(port);
298 return status;
890882ef
PP
299}
300
301struct bt_private_port *
9ac68eb1
PP
302bt_private_component_filter_get_output_private_port_by_index(
303 struct bt_private_component *private_component, uint64_t index)
890882ef 304{
dc217684 305 /* bt_component_filter_get_output_port_by_index() logs details/errors */
890882ef 306 return bt_private_port_from_port(
9ac68eb1 307 bt_component_filter_get_output_port_by_index(
890882ef
PP
308 bt_component_from_private(private_component), index));
309}
310
311struct bt_private_port *
b9d103be
PP
312bt_private_component_filter_get_output_private_port_by_name(
313 struct bt_private_component *private_component,
314 const char *name)
890882ef 315{
dc217684 316 /* bt_component_filter_get_output_port_by_name() logs details/errors */
890882ef 317 return bt_private_port_from_port(
b9d103be
PP
318 bt_component_filter_get_output_port_by_name(
319 bt_component_from_private(private_component), name));
890882ef
PP
320}
321
147337a3 322enum bt_component_status bt_private_component_filter_add_output_private_port(
890882ef 323 struct bt_private_component *private_component,
147337a3
PP
324 const char *name, void *user_data,
325 struct bt_private_port **user_priv_port)
366e034f 326{
147337a3 327 enum bt_component_status status = BT_COMPONENT_STATUS_OK;
72b913fb 328 struct bt_port *port = NULL;
890882ef
PP
329 struct bt_component *component =
330 bt_component_from_private(private_component);
bd7cc15b 331 struct bt_graph *graph;
366e034f 332
dc217684
PP
333 if (!component) {
334 BT_LOGW_STR("Invalid parameter: component is NULL.");
147337a3 335 status = BT_COMPONENT_STATUS_INVALID;
526fc31a
JG
336 goto end;
337 }
338
dc217684
PP
339 if (component->class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
340 BT_LOGW("Invalid parameter: component's class is not a filter component class: "
341 "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
342 component, bt_component_get_name(component),
343 bt_component_class_type_string(component->class->type));
147337a3 344 status = BT_COMPONENT_STATUS_INVALID;
dc217684
PP
345 goto end;
346 }
347
bd7cc15b
PP
348 graph = bt_component_borrow_graph(component);
349
350 if (graph && bt_graph_is_canceled(graph)) {
351 BT_LOGW("Cannot add output port to filter component: graph is canceled: "
352 "comp-addr=%p, comp-name=\"%s\", graph-addr=%p",
353 component, bt_component_get_name(component),
354 bt_component_borrow_graph(component));
355 status = BT_COMPONENT_STATUS_GRAPH_IS_CANCELED;
356 goto end;
357 }
358
dc217684 359 /* bt_component_add_output_port() logs details/errors */
3e9b0023 360 port = bt_component_add_output_port(component, name, user_data);
147337a3
PP
361 if (!port) {
362 status = BT_COMPONENT_STATUS_NOMEM;
363 goto end;
364 }
365
366 if (user_priv_port) {
367 /* Move reference to user */
368 *user_priv_port = bt_private_port_from_port(port);
369 port = NULL;
370 }
dc217684 371
366e034f 372end:
147337a3
PP
373 bt_put(port);
374 return status;
366e034f 375}
This page took 0.048878 seconds and 4 git commands to generate.