2 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
3 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 * Permission is hereby granted, free of charge, to any person obtaining a copy
6 * of this software and associated documentation files (the "Software"), to deal
7 * in the Software without restriction, including without limitation the rights
8 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 * copies of the Software, and to permit persons to whom the Software is
10 * furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24 #define BT_LOG_TAG "LIB/COMPONENT-FILTER"
25 #include "lib/logging.h"
27 #include "common/assert.h"
28 #include "lib/assert-pre.h"
29 #include "compat/compiler.h"
30 #include <babeltrace2/value.h>
31 #include <babeltrace2/graph/self-component.h>
32 #include <babeltrace2/graph/component.h>
33 #include <babeltrace2/graph/graph.h>
35 #include "component-filter.h"
36 #include "component.h"
37 #include "component-class.h"
38 #include "lib/func-status.h"
41 void bt_component_filter_destroy(struct bt_component
*component
)
46 struct bt_component
*bt_component_filter_create(
47 const struct bt_component_class
*class)
49 struct bt_component_filter
*filter
= NULL
;
51 BT_ASSERT_PRE_NO_ERROR();
53 filter
= g_new0(struct bt_component_filter
, 1);
55 BT_LIB_LOGE_APPEND_CAUSE(
56 "Failed to allocate one filter component.");
61 return (void *) filter
;
64 const bt_component_class_filter
*
65 bt_component_filter_borrow_class_const(
66 const bt_component_filter
*component
)
68 struct bt_component_class
*cls
;
70 BT_ASSERT_PRE_DEV_NON_NULL(component
, "Component");
72 cls
= component
->parent
.class;
75 BT_ASSERT_DBG(cls
->type
== BT_COMPONENT_CLASS_TYPE_FILTER
);
77 return (bt_component_class_filter
*) cls
;
80 uint64_t bt_component_filter_get_output_port_count(
81 const struct bt_component_filter
*comp
)
83 return bt_component_get_output_port_count((void *) comp
);
86 const struct bt_port_output
*
87 bt_component_filter_borrow_output_port_by_name_const(
88 const struct bt_component_filter
*comp
, const char *name
)
90 return bt_component_borrow_output_port_by_name(
94 struct bt_self_component_port_output
*
95 bt_self_component_filter_borrow_output_port_by_name(
96 struct bt_self_component_filter
*comp
, const char *name
)
98 return (void *) bt_component_borrow_output_port_by_name(
102 const struct bt_port_output
*
103 bt_component_filter_borrow_output_port_by_index_const(
104 const struct bt_component_filter
*comp
, uint64_t index
)
106 return bt_component_borrow_output_port_by_index(
107 (void *) comp
, index
);
110 struct bt_self_component_port_output
*
111 bt_self_component_filter_borrow_output_port_by_index(
112 struct bt_self_component_filter
*comp
, uint64_t index
)
114 return (void *) bt_component_borrow_output_port_by_index(
115 (void *) comp
, index
);
118 enum bt_self_component_add_port_status
bt_self_component_filter_add_output_port(
119 struct bt_self_component_filter
*self_comp
,
120 const char *name
, void *user_data
,
121 struct bt_self_component_port_output
**self_port
)
123 struct bt_component
*comp
= (void *) self_comp
;
124 enum bt_self_component_add_port_status status
;
125 struct bt_port
*port
= NULL
;
127 BT_ASSERT_PRE_NO_ERROR();
129 /* bt_component_add_output_port() logs details and errors */
130 status
= bt_component_add_output_port(comp
, name
, user_data
, &port
);
131 if (status
!= BT_FUNC_STATUS_OK
) {
136 /* Move reference to user */
137 *self_port
= (void *) port
;
141 bt_object_put_ref(port
);
145 uint64_t bt_component_filter_get_input_port_count(
146 const struct bt_component_filter
*component
)
148 /* bt_component_get_input_port_count() logs details/errors */
149 return bt_component_get_input_port_count((void *) component
);
152 const struct bt_port_input
*bt_component_filter_borrow_input_port_by_name_const(
153 const struct bt_component_filter
*component
, const char *name
)
155 /* bt_component_borrow_input_port_by_name() logs details/errors */
156 return bt_component_borrow_input_port_by_name(
157 (void *) component
, name
);
160 struct bt_self_component_port_input
*
161 bt_self_component_filter_borrow_input_port_by_name(
162 struct bt_self_component_filter
*component
, const char *name
)
164 /* bt_component_borrow_input_port_by_name() logs details/errors */
165 return (void *) bt_component_borrow_input_port_by_name(
166 (void *) component
, name
);
169 const struct bt_port_input
*
170 bt_component_filter_borrow_input_port_by_index_const(
171 const struct bt_component_filter
*component
, uint64_t index
)
173 /* bt_component_borrow_input_port_by_index() logs details/errors */
174 return bt_component_borrow_input_port_by_index(
175 (void *) component
, index
);
178 struct bt_self_component_port_input
*
179 bt_self_component_filter_borrow_input_port_by_index(
180 struct bt_self_component_filter
*component
, uint64_t index
)
182 /* bt_component_borrow_input_port_by_index() logs details/errors */
183 return (void *) bt_component_borrow_input_port_by_index(
184 (void *) component
, index
);
187 enum bt_self_component_add_port_status
bt_self_component_filter_add_input_port(
188 struct bt_self_component_filter
*self_comp
,
189 const char *name
, void *user_data
,
190 struct bt_self_component_port_input
**self_port
)
192 enum bt_self_component_add_port_status status
;
193 struct bt_port
*port
= NULL
;
194 struct bt_component
*comp
= (void *) self_comp
;
196 BT_ASSERT_PRE_NO_ERROR();
198 /* bt_component_add_input_port() logs details/errors */
199 status
= bt_component_add_input_port(comp
, name
, user_data
, &port
);
200 if (status
!= BT_FUNC_STATUS_OK
) {
205 /* Move reference to user */
206 *self_port
= (void *) port
;
210 bt_object_put_ref(port
);
214 void bt_component_filter_get_ref(
215 const struct bt_component_filter
*component_filter
)
217 bt_object_get_ref(component_filter
);
220 void bt_component_filter_put_ref(
221 const struct bt_component_filter
*component_filter
)
223 bt_object_put_ref(component_filter
);