4 * Babeltrace Filter Component
6 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
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:
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
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
29 #define BT_LOG_TAG "COMP-FILTER"
30 #include <babeltrace/lib-logging-internal.h>
32 #include <babeltrace/compiler-internal.h>
33 #include <babeltrace/values.h>
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>
39 #include <babeltrace/graph/graph.h>
42 void bt_component_filter_destroy(struct bt_component
*component
)
47 struct bt_component
*bt_component_filter_create(
48 struct bt_component_class
*class)
50 struct bt_component_filter
*filter
= NULL
;
52 filter
= g_new0(struct bt_component_filter
, 1);
54 BT_LOGE_STR("Failed to allocate one filter component.");
59 return filter
? &filter
->parent
: NULL
;
62 int64_t bt_component_filter_get_input_port_count(
63 struct bt_component
*component
)
68 BT_LOGW_STR("Invalid parameter: component is NULL.");
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
));
82 ret
= (int64_t) bt_component_get_input_port_count(component
);
88 struct bt_port
*bt_component_filter_get_input_port_by_name(
89 struct bt_component
*component
, const char *name
)
91 struct bt_port
*port
= NULL
;
94 BT_LOGW_STR("Invalid parameter: component is NULL.");
99 BT_LOGW_STR("Invalid parameter: name is NULL.");
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
));
111 /* bt_component_get_input_port_by_name() logs details/errors */
112 port
= bt_component_get_input_port_by_name(component
, name
);
118 struct bt_port
*bt_component_filter_get_input_port_by_index(
119 struct bt_component
*component
, uint64_t index
)
121 struct bt_port
*port
= NULL
;
124 BT_LOGW_STR("Invalid parameter: component is NULL.");
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
));
136 /* bt_component_get_input_port_by_index() logs details/errors */
137 port
= bt_component_get_input_port_by_index(component
, index
);
143 int64_t bt_component_filter_get_output_port_count(
144 struct bt_component
*component
)
149 BT_LOGW_STR("Invalid parameter: component is NULL.");
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
));
163 /* bt_component_get_output_port_count() logs details/errors */
164 ret
= bt_component_get_output_port_count(component
);
170 struct bt_port
*bt_component_filter_get_output_port_by_name(
171 struct bt_component
*component
, const char *name
)
173 struct bt_port
*port
= NULL
;
176 BT_LOGW_STR("Invalid parameter: component is NULL.");
181 BT_LOGW_STR("Invalid parameter: name is NULL.");
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
));
193 /* bt_component_get_output_port_by_name() logs details/errors */
194 port
= bt_component_get_output_port_by_name(component
, name
);
200 struct bt_port
*bt_component_filter_get_output_port_by_index(
201 struct bt_component
*component
, uint64_t index
)
203 struct bt_port
*port
= NULL
;
206 BT_LOGW_STR("Invalid parameter: component is NULL.");
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
));
218 /* bt_component_get_output_port_by_index() logs details/errors */
219 port
= bt_component_get_output_port_by_index(component
, index
);
225 struct bt_private_port
*
226 bt_private_component_filter_get_input_private_port_by_index(
227 struct bt_private_component
*private_component
, uint64_t index
)
229 /* bt_component_filter_get_input_port_by_index() logs details/errors */
230 return bt_private_port_from_port(
231 bt_component_filter_get_input_port_by_index(
232 bt_component_from_private(private_component
), index
));
235 struct bt_private_port
*
236 bt_private_component_filter_get_input_private_port_by_name(
237 struct bt_private_component
*private_component
,
240 /* bt_component_filter_get_input_port_by_name() logs details/errors */
241 return bt_private_port_from_port(
242 bt_component_filter_get_input_port_by_name(
243 bt_component_from_private(private_component
), name
));
246 enum bt_component_status
bt_private_component_filter_add_input_private_port(
247 struct bt_private_component
*private_component
,
248 const char *name
, void *user_data
,
249 struct bt_private_port
**user_priv_port
)
251 enum bt_component_status status
= BT_COMPONENT_STATUS_OK
;
252 struct bt_port
*port
= NULL
;
253 struct bt_component
*component
=
254 bt_component_from_private(private_component
);
255 struct bt_graph
*graph
;
258 BT_LOGW_STR("Invalid parameter: component is NULL.");
259 status
= BT_COMPONENT_STATUS_INVALID
;
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
));
268 status
= BT_COMPONENT_STATUS_INVALID
;
272 graph
= bt_component_borrow_graph(component
);
274 if (graph
&& bt_graph_is_canceled(graph
)) {
275 BT_LOGW("Cannot add input port to filter component: graph is canceled: "
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
;
283 /* bt_component_add_input_port() logs details/errors */
284 port
= bt_component_add_input_port(component
, name
, user_data
);
286 status
= BT_COMPONENT_STATUS_NOMEM
;
290 if (user_priv_port
) {
291 /* Move reference to user */
292 *user_priv_port
= bt_private_port_from_port(port
);
301 struct bt_private_port
*
302 bt_private_component_filter_get_output_private_port_by_index(
303 struct bt_private_component
*private_component
, uint64_t index
)
305 /* bt_component_filter_get_output_port_by_index() logs details/errors */
306 return bt_private_port_from_port(
307 bt_component_filter_get_output_port_by_index(
308 bt_component_from_private(private_component
), index
));
311 struct bt_private_port
*
312 bt_private_component_filter_get_output_private_port_by_name(
313 struct bt_private_component
*private_component
,
316 /* bt_component_filter_get_output_port_by_name() logs details/errors */
317 return bt_private_port_from_port(
318 bt_component_filter_get_output_port_by_name(
319 bt_component_from_private(private_component
), name
));
322 enum bt_component_status
bt_private_component_filter_add_output_private_port(
323 struct bt_private_component
*private_component
,
324 const char *name
, void *user_data
,
325 struct bt_private_port
**user_priv_port
)
327 enum bt_component_status status
= BT_COMPONENT_STATUS_OK
;
328 struct bt_port
*port
= NULL
;
329 struct bt_component
*component
=
330 bt_component_from_private(private_component
);
331 struct bt_graph
*graph
;
334 BT_LOGW_STR("Invalid parameter: component is NULL.");
335 status
= BT_COMPONENT_STATUS_INVALID
;
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
));
344 status
= BT_COMPONENT_STATUS_INVALID
;
348 graph
= bt_component_borrow_graph(component
);
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
;
359 /* bt_component_add_output_port() logs details/errors */
360 port
= bt_component_add_output_port(component
, name
, user_data
);
362 status
= BT_COMPONENT_STATUS_NOMEM
;
366 if (user_priv_port
) {
367 /* Move reference to user */
368 *user_priv_port
= bt_private_port_from_port(port
);