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 #include <babeltrace/compiler.h>
30 #include <babeltrace/values.h>
31 #include <babeltrace/component/component-filter-internal.h>
32 #include <babeltrace/component/component-internal.h>
33 #include <babeltrace/component/component-class-internal.h>
34 #include <babeltrace/component/notification/notification.h>
35 #include <babeltrace/component/notification/iterator-internal.h>
38 struct bt_notification_iterator
*bt_component_filter_create_notification_iterator(
39 struct bt_component
*component
)
41 return bt_component_create_iterator(component
, NULL
);
45 struct bt_notification_iterator
*bt_component_filter_create_notification_iterator_with_init_method_data(
46 struct bt_component
*component
, void *init_method_data
)
48 return bt_component_create_iterator(component
, init_method_data
);
52 void bt_component_filter_destroy(struct bt_component
*component
)
54 struct bt_component_filter
*filter
= container_of(component
,
55 struct bt_component_filter
, parent
);
57 if (filter
->input_ports
) {
58 g_ptr_array_free(filter
->input_ports
, TRUE
);
61 if (filter
->output_ports
) {
62 g_ptr_array_free(filter
->output_ports
, TRUE
);
67 struct bt_component
*bt_component_filter_create(
68 struct bt_component_class
*class, struct bt_value
*params
)
71 struct bt_component_filter
*filter
= NULL
;
72 enum bt_component_status status
;
74 filter
= g_new0(struct bt_component_filter
, 1);
79 filter
->parent
.class = bt_get(class);
80 status
= bt_component_init(&filter
->parent
, bt_component_filter_destroy
);
81 if (status
!= BT_COMPONENT_STATUS_OK
) {
85 ret
= bt_component_init_input_ports(&filter
->parent
,
86 &filter
->input_ports
);
91 ret
= bt_component_init_output_ports(&filter
->parent
,
92 &filter
->output_ports
);
98 return filter
? &filter
->parent
: NULL
;
105 enum bt_component_status
bt_component_filter_validate(
106 struct bt_component
*component
)
108 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
111 ret
= BT_COMPONENT_STATUS_INVALID
;
115 if (!component
->class) {
116 ret
= BT_COMPONENT_STATUS_INVALID
;
120 if (component
->class->type
!= BT_COMPONENT_CLASS_TYPE_FILTER
) {
121 ret
= BT_COMPONENT_STATUS_INVALID
;
125 /* Enforce iterator limits. */
130 enum bt_component_status
bt_component_filter_get_input_port_count(
131 struct bt_component
*component
, uint64_t *count
)
133 enum bt_component_status status
= BT_COMPONENT_STATUS_OK
;
134 struct bt_component_filter
*filter
;
136 if (!component
|| !count
) {
137 status
= BT_COMPONENT_STATUS_INVALID
;
141 if (component
->class->type
!= BT_COMPONENT_CLASS_TYPE_FILTER
) {
142 status
= BT_COMPONENT_STATUS_INVALID
;
146 filter
= container_of(component
, struct bt_component_filter
, parent
);
147 *count
= (uint64_t) filter
->input_ports
->len
;
152 struct bt_port
*bt_component_filter_get_input_port(
153 struct bt_component
*component
, const char *name
)
155 struct bt_component_filter
*filter
;
156 struct bt_port
*ret_port
= NULL
;
158 if (!component
|| !name
||
159 component
->class->type
!= BT_COMPONENT_CLASS_TYPE_FILTER
) {
163 filter
= container_of(component
, struct bt_component_filter
, parent
);
164 ret_port
= bt_component_get_port(filter
->input_ports
, name
);
169 struct bt_port
*bt_component_filter_get_input_port_at_index(
170 struct bt_component
*component
, int index
)
172 struct bt_port
*port
= NULL
;
173 struct bt_component_filter
*filter
;
176 component
->class->type
!= BT_COMPONENT_CLASS_TYPE_FILTER
) {
180 filter
= container_of(component
, struct bt_component_filter
, parent
);
181 port
= bt_component_get_port_at_index(filter
->input_ports
, index
);
186 struct bt_port
*bt_component_filter_get_default_input_port(
187 struct bt_component
*component
)
189 return bt_component_filter_get_input_port(component
,
190 DEFAULT_INPUT_PORT_NAME
);
193 struct bt_port
*bt_component_filter_add_input_port(
194 struct bt_component
*component
, const char *name
)
196 struct bt_port
*port
;
197 struct bt_component_filter
*filter
;
200 component
->class->type
!= BT_COMPONENT_CLASS_TYPE_FILTER
) {
205 filter
= container_of(component
, struct bt_component_filter
, parent
);
206 port
= bt_component_add_port(component
, filter
->input_ports
,
207 BT_PORT_TYPE_INPUT
, name
);
212 enum bt_component_status
bt_component_filter_remove_input_port(
213 struct bt_component
*component
, const char *name
)
215 enum bt_component_status status
;
216 struct bt_component_filter
*filter
;
219 component
->class->type
!= BT_COMPONENT_CLASS_TYPE_FILTER
) {
220 status
= BT_COMPONENT_STATUS_INVALID
;
224 filter
= container_of(component
, struct bt_component_filter
, parent
);
225 status
= bt_component_remove_port(component
, filter
->input_ports
,
231 enum bt_component_status
bt_component_filter_get_output_port_count(
232 struct bt_component
*component
, uint64_t *count
)
234 enum bt_component_status status
= BT_COMPONENT_STATUS_OK
;
235 struct bt_component_filter
*filter
;
237 if (!component
|| !count
) {
238 status
= BT_COMPONENT_STATUS_INVALID
;
242 if (component
->class->type
!= BT_COMPONENT_CLASS_TYPE_FILTER
) {
243 status
= BT_COMPONENT_STATUS_INVALID
;
247 filter
= container_of(component
, struct bt_component_filter
, parent
);
248 *count
= (uint64_t) filter
->output_ports
->len
;
253 struct bt_port
*bt_component_filter_get_output_port(
254 struct bt_component
*component
, const char *name
)
256 struct bt_component_filter
*filter
;
257 struct bt_port
*ret_port
= NULL
;
259 if (!component
|| !name
||
260 component
->class->type
!= BT_COMPONENT_CLASS_TYPE_FILTER
) {
264 filter
= container_of(component
, struct bt_component_filter
, parent
);
265 ret_port
= bt_component_get_port(filter
->output_ports
, name
);
270 struct bt_port
*bt_component_filter_get_output_port_at_index(
271 struct bt_component
*component
, int index
)
273 struct bt_port
*port
= NULL
;
274 struct bt_component_filter
*filter
;
277 component
->class->type
!= BT_COMPONENT_CLASS_TYPE_FILTER
) {
281 filter
= container_of(component
, struct bt_component_filter
, parent
);
282 port
= bt_component_get_port_at_index(filter
->output_ports
, index
);
287 struct bt_port
*bt_component_filter_get_default_output_port(
288 struct bt_component
*component
)
290 return bt_component_filter_get_output_port(component
,
291 DEFAULT_OUTPUT_PORT_NAME
);
294 struct bt_port
*bt_component_filter_add_output_port(
295 struct bt_component
*component
, const char *name
)
297 struct bt_port
*port
;
298 struct bt_component_filter
*filter
;
301 component
->class->type
!= BT_COMPONENT_CLASS_TYPE_FILTER
) {
306 filter
= container_of(component
, struct bt_component_filter
, parent
);
307 port
= bt_component_add_port(component
, filter
->output_ports
,
308 BT_PORT_TYPE_OUTPUT
, name
);
313 enum bt_component_status
bt_component_filter_remove_output_port(
314 struct bt_component
*component
, const char *name
)
316 enum bt_component_status status
;
317 struct bt_component_filter
*filter
;
320 component
->class->type
!= BT_COMPONENT_CLASS_TYPE_FILTER
) {
321 status
= BT_COMPONENT_STATUS_INVALID
;
325 filter
= container_of(component
, struct bt_component_filter
, parent
);
326 status
= bt_component_remove_port(component
, filter
->output_ports
,