cli, tests: rename "leftover" terms to "non-option"
[babeltrace.git] / src / lib / graph / component-class-sink-colander.c
CommitLineData
706a18f9 1/*
e2f7325d 2 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
706a18f9
PP
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to deal
6 * in the Software without restriction, including without limitation the rights
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 * copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
13 *
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20 * SOFTWARE.
21 */
22
350ad6c1 23#define BT_LOG_TAG "LIB/COLANDER"
c2d9d9cf 24#include "lib/logging.h"
706a18f9 25
578e048b
MJ
26#include "common/assert.h"
27#include "lib/assert-pre.h"
28#include "lib/object.h"
3fadfbc0
MJ
29#include <babeltrace2/graph/component-class-sink.h>
30#include <babeltrace2/graph/self-component-sink.h>
31#include <babeltrace2/graph/self-component-port.h>
32#include <babeltrace2/graph/self-component-port-input-message-iterator.h>
33#include <babeltrace2/graph/self-component.h>
706a18f9 34#include <glib.h>
706a18f9 35
578e048b 36#include "component-class-sink-colander.h"
d24d5663 37#include "lib/func-status.h"
578e048b 38
706a18f9 39static
0d72b8c3 40struct bt_component_class_sink *colander_comp_cls;
706a18f9 41
706a18f9 42static
d24d5663 43enum bt_component_class_init_method_status colander_init(
d94d92ac 44 struct bt_self_component_sink *self_comp,
05e21286 45 const struct bt_value *params, void *init_method_data)
706a18f9 46{
9275bef4 47 int status = BT_FUNC_STATUS_OK;
7474e7d3 48 struct bt_component_class_sink_colander_priv_data *colander_data = NULL;
8ed535b5
PP
49 struct bt_component_class_sink_colander_data *user_provided_data =
50 init_method_data;
706a18f9 51
3f7d4d90 52 BT_ASSERT(init_method_data);
7474e7d3
PP
53 colander_data = g_new0(
54 struct bt_component_class_sink_colander_priv_data, 1);
706a18f9 55 if (!colander_data) {
870631a2
PP
56 BT_LIB_LOGE_APPEND_CAUSE(
57 "Failed to allocate colander sink data.");
d24d5663 58 status = BT_FUNC_STATUS_MEMORY_ERROR;
706a18f9
PP
59 goto end;
60 }
61
d6e69534 62 colander_data->msgs = user_provided_data->msgs;
d4393e08 63 colander_data->count_addr = user_provided_data->count_addr;
d94d92ac
PP
64 status = bt_self_component_sink_add_input_port(self_comp, "in",
65 NULL, NULL);
d24d5663 66 if (status != BT_FUNC_STATUS_OK) {
870631a2
PP
67 BT_LIB_LOGE_APPEND_CAUSE(
68 "Cannot add input port to colander sink.");
706a18f9
PP
69 goto end;
70 }
71
d94d92ac 72 bt_self_component_set_data(
707b7d35 73 bt_self_component_sink_as_self_component(self_comp),
d94d92ac 74 colander_data);
706a18f9
PP
75
76end:
77 return status;
78}
79
80static
d94d92ac 81void colander_finalize(struct bt_self_component_sink *self_comp)
706a18f9 82{
7474e7d3 83 struct bt_component_class_sink_colander_priv_data *colander_data =
d94d92ac 84 bt_self_component_get_data(
707b7d35 85 bt_self_component_sink_as_self_component(self_comp));
706a18f9
PP
86
87 if (!colander_data) {
88 return;
89 }
90
d6e69534 91 BT_OBJECT_PUT_REF_AND_RESET(colander_data->msg_iter);
706a18f9
PP
92 g_free(colander_data);
93}
94
95static
d24d5663
PP
96enum bt_component_class_sink_graph_is_configured_method_status
97colander_graph_is_configured(
36d1acad 98 bt_self_component_sink *self_comp)
706a18f9 99{
d24d5663
PP
100 enum bt_component_class_sink_graph_is_configured_method_status status =
101 BT_FUNC_STATUS_OK;
7474e7d3 102 struct bt_component_class_sink_colander_priv_data *colander_data =
d94d92ac 103 bt_self_component_get_data(
707b7d35 104 bt_self_component_sink_as_self_component(self_comp));
706a18f9 105
36d1acad
SM
106 struct bt_self_component_port_input *self_port =
107 bt_self_component_sink_borrow_input_port_by_name(self_comp, "in");
108 BT_ASSERT(self_port);
109
f6ccaed9 110 BT_ASSERT(colander_data);
d6e69534
PP
111 BT_OBJECT_PUT_REF_AND_RESET(colander_data->msg_iter);
112 colander_data->msg_iter =
ca02df0a
PP
113 bt_self_component_port_input_message_iterator_create_from_sink_component(
114 self_comp, self_port);
d6e69534 115 if (!colander_data->msg_iter) {
870631a2 116 BT_LIB_LOGE_APPEND_CAUSE("Cannot create message iterator on "
d94d92ac
PP
117 "self component input port: %![port-]+p",
118 self_port);
d24d5663 119 status = BT_FUNC_STATUS_MEMORY_ERROR;
706a18f9
PP
120 goto end;
121 }
122
123end:
bf55043c 124 return status;
706a18f9
PP
125}
126
127static
d24d5663 128enum bt_component_class_sink_consume_method_status colander_consume(
d94d92ac 129 struct bt_self_component_sink *self_comp)
706a18f9 130{
d24d5663
PP
131 enum bt_component_class_sink_consume_method_status status =
132 BT_FUNC_STATUS_OK;
133 enum bt_message_iterator_next_status next_status;
7474e7d3 134 struct bt_component_class_sink_colander_priv_data *colander_data =
d94d92ac 135 bt_self_component_get_data(
707b7d35 136 bt_self_component_sink_as_self_component(self_comp));
d6e69534 137 bt_message_array_const msgs;
706a18f9 138
f6ccaed9 139 BT_ASSERT(colander_data);
3f7d4d90 140 BT_ASSERT(colander_data->msg_iter);
d24d5663
PP
141 next_status = bt_self_component_port_input_message_iterator_next(
142 colander_data->msg_iter, &msgs,
143 colander_data->count_addr);
144 switch (next_status) {
145 case BT_FUNC_STATUS_AGAIN:
146 status = BT_FUNC_STATUS_AGAIN;
706a18f9 147 goto end;
d24d5663
PP
148 case BT_FUNC_STATUS_END:
149 status = BT_FUNC_STATUS_END;
706a18f9 150 goto end;
d24d5663 151 case BT_FUNC_STATUS_OK:
d6e69534
PP
152 /* Move messages to user (count already set) */
153 memcpy(colander_data->msgs, msgs,
154 sizeof(*msgs) * *colander_data->count_addr);
706a18f9
PP
155 break;
156 default:
d24d5663 157 status = BT_FUNC_STATUS_ERROR;
706a18f9
PP
158 goto end;
159 }
160
706a18f9 161end:
706a18f9
PP
162 return status;
163}
164
d94d92ac 165struct bt_component_class_sink *bt_component_class_sink_colander_get(void)
706a18f9
PP
166{
167 if (colander_comp_cls) {
168 goto end;
169 }
170
0d72b8c3
PP
171 colander_comp_cls = bt_component_class_sink_create("colander",
172 colander_consume);
706a18f9 173 if (!colander_comp_cls) {
870631a2
PP
174 BT_LIB_LOGE_APPEND_CAUSE(
175 "Cannot create sink colander component class.");
706a18f9
PP
176 goto end;
177 }
178
0d72b8c3 179 (void) bt_component_class_sink_set_init_method(
d94d92ac 180 colander_comp_cls, colander_init);
0d72b8c3 181 (void) bt_component_class_sink_set_finalize_method(
d94d92ac 182 colander_comp_cls, colander_finalize);
36d1acad
SM
183 (void) bt_component_class_sink_set_graph_is_configured_method(
184 colander_comp_cls, colander_graph_is_configured);
706a18f9
PP
185
186end:
398454ed 187 bt_object_get_ref(colander_comp_cls);
5a2b6475 188 return colander_comp_cls;
706a18f9
PP
189}
190
191__attribute__((destructor)) static
192void put_colander(void) {
65300d60 193 BT_OBJECT_PUT_REF_AND_RESET(colander_comp_cls);
706a18f9 194}
This page took 0.0568 seconds and 4 git commands to generate.