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>
41 void bt_component_filter_destroy(struct bt_component
*component
)
46 struct bt_component
*bt_component_filter_create(
47 struct bt_component_class
*class, struct bt_value
*params
)
49 struct bt_component_filter
*filter
= NULL
;
51 filter
= g_new0(struct bt_component_filter
, 1);
53 BT_LOGE_STR("Failed to allocate one filter component.");
58 return filter
? &filter
->parent
: NULL
;
61 int64_t bt_component_filter_get_input_port_count(
62 struct bt_component
*component
)
67 BT_LOGW_STR("Invalid parameter: component is NULL.");
72 if (component
->class->type
!= BT_COMPONENT_CLASS_TYPE_FILTER
) {
73 BT_LOGW("Invalid parameter: component's class is not a filter component class: "
74 "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
75 component
, bt_component_get_name(component
),
76 bt_component_class_type_string(component
->class->type
));
81 ret
= (int64_t) bt_component_get_input_port_count(component
);
87 struct bt_port
*bt_component_filter_get_input_port_by_name(
88 struct bt_component
*component
, const char *name
)
90 struct bt_port
*port
= NULL
;
93 BT_LOGW_STR("Invalid parameter: component is NULL.");
98 BT_LOGW_STR("Invalid parameter: name is NULL.");
102 if (component
->class->type
!= BT_COMPONENT_CLASS_TYPE_FILTER
) {
103 BT_LOGW("Invalid parameter: component's class is not a filter component class: "
104 "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
105 component
, bt_component_get_name(component
),
106 bt_component_class_type_string(component
->class->type
));
110 /* bt_component_get_input_port_by_name() logs details/errors */
111 port
= bt_component_get_input_port_by_name(component
, name
);
117 struct bt_port
*bt_component_filter_get_input_port_by_index(
118 struct bt_component
*component
, uint64_t index
)
120 struct bt_port
*port
= NULL
;
123 BT_LOGW_STR("Invalid parameter: component is NULL.");
127 if (component
->class->type
!= BT_COMPONENT_CLASS_TYPE_FILTER
) {
128 BT_LOGW("Invalid parameter: component's class is not a filter component class: "
129 "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
130 component
, bt_component_get_name(component
),
131 bt_component_class_type_string(component
->class->type
));
135 /* bt_component_get_input_port_by_index() logs details/errors */
136 port
= bt_component_get_input_port_by_index(component
, index
);
142 int64_t bt_component_filter_get_output_port_count(
143 struct bt_component
*component
)
148 BT_LOGW_STR("Invalid parameter: component is NULL.");
153 if (component
->class->type
!= BT_COMPONENT_CLASS_TYPE_FILTER
) {
154 BT_LOGW("Invalid parameter: component's class is not a filter component class: "
155 "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
156 component
, bt_component_get_name(component
),
157 bt_component_class_type_string(component
->class->type
));
162 /* bt_component_get_output_port_count() logs details/errors */
163 ret
= bt_component_get_output_port_count(component
);
169 struct bt_port
*bt_component_filter_get_output_port_by_name(
170 struct bt_component
*component
, const char *name
)
172 struct bt_port
*port
= NULL
;
175 BT_LOGW_STR("Invalid parameter: component is NULL.");
180 BT_LOGW_STR("Invalid parameter: name is NULL.");
184 if (component
->class->type
!= BT_COMPONENT_CLASS_TYPE_FILTER
) {
185 BT_LOGW("Invalid parameter: component's class is not a filter component class: "
186 "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
187 component
, bt_component_get_name(component
),
188 bt_component_class_type_string(component
->class->type
));
192 /* bt_component_get_output_port_by_name() logs details/errors */
193 port
= bt_component_get_output_port_by_name(component
, name
);
199 struct bt_port
*bt_component_filter_get_output_port_by_index(
200 struct bt_component
*component
, uint64_t index
)
202 struct bt_port
*port
= NULL
;
205 BT_LOGW_STR("Invalid parameter: component is NULL.");
209 if (component
->class->type
!= BT_COMPONENT_CLASS_TYPE_FILTER
) {
210 BT_LOGW("Invalid parameter: component's class is not a filter component class: "
211 "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
212 component
, bt_component_get_name(component
),
213 bt_component_class_type_string(component
->class->type
));
217 /* bt_component_get_output_port_by_index() logs details/errors */
218 port
= bt_component_get_output_port_by_index(component
, index
);
224 struct bt_private_port
*
225 bt_private_component_filter_get_input_private_port_by_index(
226 struct bt_private_component
*private_component
, uint64_t index
)
228 /* bt_component_filter_get_input_port_by_index() logs details/errors */
229 return bt_private_port_from_port(
230 bt_component_filter_get_input_port_by_index(
231 bt_component_from_private(private_component
), index
));
234 struct bt_private_port
*
235 bt_private_component_filter_get_input_private_port_by_name(
236 struct bt_private_component
*private_component
,
239 /* bt_component_filter_get_input_port_by_name() logs details/errors */
240 return bt_private_port_from_port(
241 bt_component_filter_get_input_port_by_name(
242 bt_component_from_private(private_component
), name
));
245 enum bt_component_status
bt_private_component_filter_add_input_private_port(
246 struct bt_private_component
*private_component
,
247 const char *name
, void *user_data
,
248 struct bt_private_port
**user_priv_port
)
250 enum bt_component_status status
= BT_COMPONENT_STATUS_OK
;
251 struct bt_port
*port
= NULL
;
252 struct bt_component
*component
=
253 bt_component_from_private(private_component
);
256 BT_LOGW_STR("Invalid parameter: component is NULL.");
257 status
= BT_COMPONENT_STATUS_INVALID
;
261 if (component
->class->type
!= BT_COMPONENT_CLASS_TYPE_FILTER
) {
262 BT_LOGW("Invalid parameter: component's class is not a filter component class: "
263 "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
264 component
, bt_component_get_name(component
),
265 bt_component_class_type_string(component
->class->type
));
266 status
= BT_COMPONENT_STATUS_INVALID
;
270 /* bt_component_add_input_port() logs details/errors */
271 port
= bt_component_add_input_port(component
, name
, user_data
);
273 status
= BT_COMPONENT_STATUS_NOMEM
;
277 if (user_priv_port
) {
278 /* Move reference to user */
279 *user_priv_port
= bt_private_port_from_port(port
);
288 struct bt_private_port
*
289 bt_private_component_filter_get_output_private_port_by_index(
290 struct bt_private_component
*private_component
, uint64_t index
)
292 /* bt_component_filter_get_output_port_by_index() logs details/errors */
293 return bt_private_port_from_port(
294 bt_component_filter_get_output_port_by_index(
295 bt_component_from_private(private_component
), index
));
298 struct bt_private_port
*
299 bt_private_component_filter_get_output_private_port_by_name(
300 struct bt_private_component
*private_component
,
303 /* bt_component_filter_get_output_port_by_name() logs details/errors */
304 return bt_private_port_from_port(
305 bt_component_filter_get_output_port_by_name(
306 bt_component_from_private(private_component
), name
));
309 enum bt_component_status
bt_private_component_filter_add_output_private_port(
310 struct bt_private_component
*private_component
,
311 const char *name
, void *user_data
,
312 struct bt_private_port
**user_priv_port
)
314 enum bt_component_status status
= BT_COMPONENT_STATUS_OK
;
315 struct bt_port
*port
= NULL
;
316 struct bt_component
*component
=
317 bt_component_from_private(private_component
);
320 BT_LOGW_STR("Invalid parameter: component is NULL.");
321 status
= BT_COMPONENT_STATUS_INVALID
;
325 if (component
->class->type
!= BT_COMPONENT_CLASS_TYPE_FILTER
) {
326 BT_LOGW("Invalid parameter: component's class is not a filter component class: "
327 "comp-addr=%p, comp-name=\"%s\", comp-class-type=%s",
328 component
, bt_component_get_name(component
),
329 bt_component_class_type_string(component
->class->type
));
330 status
= BT_COMPONENT_STATUS_INVALID
;
334 /* bt_component_add_output_port() logs details/errors */
335 port
= bt_component_add_output_port(component
, name
, user_data
);
337 status
= BT_COMPONENT_STATUS_NOMEM
;
341 if (user_priv_port
) {
342 /* Move reference to user */
343 *user_priv_port
= bt_private_port_from_port(port
);