Make bt_private_component_*_add_*_port() return a status code
[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>
34ac9eaf 39
72b913fb 40BT_HIDDEN
366e034f
JG
41void bt_component_filter_destroy(struct bt_component *component)
42{
34a9ed19
JG
43}
44
366e034f
JG
45BT_HIDDEN
46struct bt_component *bt_component_filter_create(
47 struct bt_component_class *class, struct bt_value *params)
34a9ed19 48{
366e034f 49 struct bt_component_filter *filter = NULL;
34a9ed19 50
366e034f
JG
51 filter = g_new0(struct bt_component_filter, 1);
52 if (!filter) {
dc217684 53 BT_LOGE_STR("Failed to allocate one filter component.");
34a9ed19
JG
54 goto end;
55 }
56
34a9ed19 57end:
366e034f 58 return filter ? &filter->parent : NULL;
34a9ed19
JG
59}
60
544d0515 61int64_t bt_component_filter_get_input_port_count(
9ac68eb1 62 struct bt_component *component)
34a9ed19 63{
544d0515 64 int64_t ret;
34a9ed19 65
dc217684
PP
66 if (!component) {
67 BT_LOGW_STR("Invalid parameter: component is NULL.");
68 ret = (int64_t) -1;
69 goto end;
70 }
71
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));
77 ret = (int64_t) -1;
34a9ed19
JG
78 goto end;
79 }
80
9ac68eb1 81 ret = (int64_t) bt_component_get_input_port_count(component);
dc217684 82
366e034f 83end:
544d0515 84 return ret;
366e034f
JG
85}
86
9ac68eb1 87struct bt_port *bt_component_filter_get_input_port_by_name(
366e034f
JG
88 struct bt_component *component, const char *name)
89{
72b913fb 90 struct bt_port *port = NULL;
366e034f 91
dc217684
PP
92 if (!component) {
93 BT_LOGW_STR("Invalid parameter: component is NULL.");
94 goto end;
95 }
96
97 if (!name) {
98 BT_LOGW_STR("Invalid parameter: name is NULL.");
99 goto end;
100 }
101
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));
34a9ed19
JG
107 goto end;
108 }
109
dc217684 110 /* bt_component_get_input_port_by_name() logs details/errors */
9ac68eb1 111 port = bt_component_get_input_port_by_name(component, name);
dc217684 112
366e034f 113end:
72b913fb 114 return port;
366e034f 115}
d3e4dcd8 116
9ac68eb1
PP
117struct bt_port *bt_component_filter_get_input_port_by_index(
118 struct bt_component *component, uint64_t index)
366e034f
JG
119{
120 struct bt_port *port = NULL;
366e034f 121
dc217684
PP
122 if (!component) {
123 BT_LOGW_STR("Invalid parameter: component is NULL.");
124 goto end;
125 }
126
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));
366e034f 132 goto end;
34a9ed19
JG
133 }
134
dc217684 135 /* bt_component_get_input_port_by_index() logs details/errors */
9ac68eb1 136 port = bt_component_get_input_port_by_index(component, index);
dc217684 137
34a9ed19 138end:
366e034f 139 return port;
34a9ed19
JG
140}
141
544d0515 142int64_t bt_component_filter_get_output_port_count(
9ac68eb1 143 struct bt_component *component)
526fc31a 144{
544d0515 145 int64_t ret;
526fc31a 146
dc217684
PP
147 if (!component) {
148 BT_LOGW_STR("Invalid parameter: component is NULL.");
149 ret = (int64_t) -1;
526fc31a
JG
150 goto end;
151 }
152
dc217684
PP
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));
158 ret = (int64_t) -1;
159 goto end;
160 }
161
162 /* bt_component_get_output_port_count() logs details/errors */
544d0515 163 ret = bt_component_get_output_port_count(component);
dc217684 164
526fc31a 165end:
544d0515 166 return ret;
526fc31a
JG
167}
168
9ac68eb1 169struct bt_port *bt_component_filter_get_output_port_by_name(
366e034f 170 struct bt_component *component, const char *name)
526fc31a 171{
72b913fb 172 struct bt_port *port = NULL;
526fc31a 173
dc217684
PP
174 if (!component) {
175 BT_LOGW_STR("Invalid parameter: component is NULL.");
526fc31a
JG
176 goto end;
177 }
178
dc217684
PP
179 if (!name) {
180 BT_LOGW_STR("Invalid parameter: name is NULL.");
181 goto end;
182 }
183
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));
189 goto end;
190 }
191
192 /* bt_component_get_output_port_by_name() logs details/errors */
9ac68eb1 193 port = bt_component_get_output_port_by_name(component, name);
dc217684 194
366e034f 195end:
72b913fb 196 return port;
366e034f
JG
197}
198
9ac68eb1
PP
199struct bt_port *bt_component_filter_get_output_port_by_index(
200 struct bt_component *component, uint64_t index)
366e034f
JG
201{
202 struct bt_port *port = NULL;
366e034f 203
dc217684
PP
204 if (!component) {
205 BT_LOGW_STR("Invalid parameter: component is NULL.");
206 goto end;
207 }
208
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));
526fc31a
JG
214 goto end;
215 }
216
dc217684 217 /* bt_component_get_output_port_by_index() logs details/errors */
9ac68eb1 218 port = bt_component_get_output_port_by_index(component, index);
dc217684 219
366e034f
JG
220end:
221 return port;
222}
223
890882ef 224struct bt_private_port *
9ac68eb1
PP
225bt_private_component_filter_get_input_private_port_by_index(
226 struct bt_private_component *private_component, uint64_t index)
890882ef 227{
dc217684 228 /* bt_component_filter_get_input_port_by_index() logs details/errors */
890882ef 229 return bt_private_port_from_port(
9ac68eb1 230 bt_component_filter_get_input_port_by_index(
890882ef
PP
231 bt_component_from_private(private_component), index));
232}
233
234struct bt_private_port *
b9d103be
PP
235bt_private_component_filter_get_input_private_port_by_name(
236 struct bt_private_component *private_component,
237 const char *name)
890882ef 238{
dc217684 239 /* bt_component_filter_get_input_port_by_name() logs details/errors */
890882ef 240 return bt_private_port_from_port(
b9d103be
PP
241 bt_component_filter_get_input_port_by_name(
242 bt_component_from_private(private_component), name));
890882ef
PP
243}
244
147337a3 245enum bt_component_status bt_private_component_filter_add_input_private_port(
890882ef 246 struct bt_private_component *private_component,
147337a3
PP
247 const char *name, void *user_data,
248 struct bt_private_port **user_priv_port)
890882ef 249{
147337a3 250 enum bt_component_status status = BT_COMPONENT_STATUS_OK;
890882ef
PP
251 struct bt_port *port = NULL;
252 struct bt_component *component =
253 bt_component_from_private(private_component);
254
dc217684
PP
255 if (!component) {
256 BT_LOGW_STR("Invalid parameter: component is NULL.");
147337a3 257 status = BT_COMPONENT_STATUS_INVALID;
890882ef
PP
258 goto end;
259 }
260
dc217684
PP
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));
147337a3 266 status = BT_COMPONENT_STATUS_INVALID;
dc217684
PP
267 goto end;
268 }
269
270 /* bt_component_add_input_port() logs details/errors */
3e9b0023 271 port = bt_component_add_input_port(component, name, user_data);
147337a3
PP
272 if (!port) {
273 status = BT_COMPONENT_STATUS_NOMEM;
274 goto end;
275 }
276
277 if (user_priv_port) {
278 /* Move reference to user */
279 *user_priv_port = bt_private_port_from_port(port);
280 port = NULL;
281 }
dc217684 282
890882ef 283end:
147337a3
PP
284 bt_put(port);
285 return status;
890882ef
PP
286}
287
288struct bt_private_port *
9ac68eb1
PP
289bt_private_component_filter_get_output_private_port_by_index(
290 struct bt_private_component *private_component, uint64_t index)
890882ef 291{
dc217684 292 /* bt_component_filter_get_output_port_by_index() logs details/errors */
890882ef 293 return bt_private_port_from_port(
9ac68eb1 294 bt_component_filter_get_output_port_by_index(
890882ef
PP
295 bt_component_from_private(private_component), index));
296}
297
298struct bt_private_port *
b9d103be
PP
299bt_private_component_filter_get_output_private_port_by_name(
300 struct bt_private_component *private_component,
301 const char *name)
890882ef 302{
dc217684 303 /* bt_component_filter_get_output_port_by_name() logs details/errors */
890882ef 304 return bt_private_port_from_port(
b9d103be
PP
305 bt_component_filter_get_output_port_by_name(
306 bt_component_from_private(private_component), name));
890882ef
PP
307}
308
147337a3 309enum bt_component_status bt_private_component_filter_add_output_private_port(
890882ef 310 struct bt_private_component *private_component,
147337a3
PP
311 const char *name, void *user_data,
312 struct bt_private_port **user_priv_port)
366e034f 313{
147337a3 314 enum bt_component_status status = BT_COMPONENT_STATUS_OK;
72b913fb 315 struct bt_port *port = NULL;
890882ef
PP
316 struct bt_component *component =
317 bt_component_from_private(private_component);
366e034f 318
dc217684
PP
319 if (!component) {
320 BT_LOGW_STR("Invalid parameter: component is NULL.");
147337a3 321 status = BT_COMPONENT_STATUS_INVALID;
526fc31a
JG
322 goto end;
323 }
324
dc217684
PP
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));
147337a3 330 status = BT_COMPONENT_STATUS_INVALID;
dc217684
PP
331 goto end;
332 }
333
334 /* bt_component_add_output_port() logs details/errors */
3e9b0023 335 port = bt_component_add_output_port(component, name, user_data);
147337a3
PP
336 if (!port) {
337 status = BT_COMPONENT_STATUS_NOMEM;
338 goto end;
339 }
340
341 if (user_priv_port) {
342 /* Move reference to user */
343 *user_priv_port = bt_private_port_from_port(port);
344 port = NULL;
345 }
dc217684 346
366e034f 347end:
147337a3
PP
348 bt_put(port);
349 return status;
366e034f 350}
This page took 0.045779 seconds and 4 git commands to generate.