lib: rename "notification" -> "message"
[babeltrace.git] / 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
23#define BT_LOG_TAG "COLANDER"
24#include <babeltrace/lib-logging-internal.h>
25
c5b9b441
PP
26#include <babeltrace/assert-internal.h>
27#include <babeltrace/assert-pre-internal.h>
28#include <babeltrace/object-internal.h>
0d72b8c3 29#include <babeltrace/graph/component-class-sink.h>
d94d92ac
PP
30#include <babeltrace/graph/self-component-sink.h>
31#include <babeltrace/graph/self-component-port.h>
d6e69534 32#include <babeltrace/graph/self-component-port-input-message-iterator.h>
d94d92ac 33#include <babeltrace/graph/self-component.h>
8ed535b5 34#include <babeltrace/graph/component-class-sink-colander-internal.h>
706a18f9 35#include <glib.h>
706a18f9
PP
36
37static
0d72b8c3 38struct bt_component_class_sink *colander_comp_cls;
706a18f9
PP
39
40struct colander_data {
d6e69534 41 bt_message_array_const msgs;
d4393e08 42 uint64_t *count_addr;
d6e69534 43 struct bt_self_component_port_input_message_iterator *msg_iter;
706a18f9
PP
44};
45
46static
d94d92ac
PP
47enum bt_self_component_status colander_init(
48 struct bt_self_component_sink *self_comp,
05e21286 49 const struct bt_value *params, void *init_method_data)
706a18f9 50{
d94d92ac 51 enum bt_self_component_status status = BT_SELF_COMPONENT_STATUS_OK;
706a18f9 52 struct colander_data *colander_data = NULL;
8ed535b5
PP
53 struct bt_component_class_sink_colander_data *user_provided_data =
54 init_method_data;
706a18f9
PP
55
56 if (!init_method_data) {
57 BT_LOGW_STR("Component initialization method data is NULL.");
d94d92ac 58 status = BT_SELF_COMPONENT_STATUS_ERROR;
706a18f9
PP
59 goto end;
60 }
61
62 colander_data = g_new0(struct colander_data, 1);
63 if (!colander_data) {
64 BT_LOGE_STR("Failed to allocate colander data.");
d94d92ac 65 status = BT_SELF_COMPONENT_STATUS_NOMEM;
706a18f9
PP
66 goto end;
67 }
68
d6e69534 69 colander_data->msgs = user_provided_data->msgs;
d4393e08 70 colander_data->count_addr = user_provided_data->count_addr;
d94d92ac
PP
71 status = bt_self_component_sink_add_input_port(self_comp, "in",
72 NULL, NULL);
73 if (status != BT_SELF_COMPONENT_STATUS_OK) {
706a18f9
PP
74 BT_LOGE_STR("Cannot add input port.");
75 goto end;
76 }
77
d94d92ac 78 bt_self_component_set_data(
707b7d35 79 bt_self_component_sink_as_self_component(self_comp),
d94d92ac 80 colander_data);
706a18f9
PP
81
82end:
83 return status;
84}
85
86static
d94d92ac 87void colander_finalize(struct bt_self_component_sink *self_comp)
706a18f9
PP
88{
89 struct colander_data *colander_data =
d94d92ac 90 bt_self_component_get_data(
707b7d35 91 bt_self_component_sink_as_self_component(self_comp));
706a18f9
PP
92
93 if (!colander_data) {
94 return;
95 }
96
d6e69534 97 BT_OBJECT_PUT_REF_AND_RESET(colander_data->msg_iter);
706a18f9
PP
98 g_free(colander_data);
99}
100
101static
d94d92ac
PP
102enum bt_self_component_status colander_input_port_connected(
103 struct bt_self_component_sink *self_comp,
104 struct bt_self_component_port_input *self_port,
0d72b8c3 105 const struct bt_port_output *other_port)
706a18f9 106{
d94d92ac 107 enum bt_self_component_status status = BT_SELF_COMPONENT_STATUS_OK;
706a18f9 108 struct colander_data *colander_data =
d94d92ac 109 bt_self_component_get_data(
707b7d35 110 bt_self_component_sink_as_self_component(self_comp));
706a18f9 111
f6ccaed9 112 BT_ASSERT(colander_data);
d6e69534
PP
113 BT_OBJECT_PUT_REF_AND_RESET(colander_data->msg_iter);
114 colander_data->msg_iter =
115 bt_self_component_port_input_message_iterator_create(
d94d92ac 116 self_port);
d6e69534
PP
117 if (!colander_data->msg_iter) {
118 BT_LIB_LOGE("Cannot create message iterator on "
d94d92ac
PP
119 "self component input port: %![port-]+p",
120 self_port);
121 status = BT_SELF_COMPONENT_STATUS_NOMEM;
706a18f9
PP
122 goto end;
123 }
124
125end:
bf55043c 126 return status;
706a18f9
PP
127}
128
129static
d94d92ac
PP
130enum bt_self_component_status colander_consume(
131 struct bt_self_component_sink *self_comp)
706a18f9 132{
d94d92ac 133 enum bt_self_component_status status = BT_SELF_COMPONENT_STATUS_OK;
d6e69534 134 enum bt_message_iterator_status msg_iter_status;
706a18f9 135 struct colander_data *colander_data =
d94d92ac 136 bt_self_component_get_data(
707b7d35 137 bt_self_component_sink_as_self_component(self_comp));
d6e69534 138 bt_message_array_const msgs;
706a18f9 139
f6ccaed9 140 BT_ASSERT(colander_data);
706a18f9 141
d6e69534 142 if (!colander_data->msg_iter) {
d94d92ac 143 BT_LIB_LOGW("Trying to consume without an "
d6e69534 144 "upstream message iterator: %![comp-]+c",
d94d92ac 145 self_comp);
706a18f9
PP
146 goto end;
147 }
148
d6e69534
PP
149 msg_iter_status =
150 bt_self_component_port_input_message_iterator_next(
151 colander_data->msg_iter, &msgs,
d94d92ac 152 colander_data->count_addr);
d6e69534
PP
153 switch (msg_iter_status) {
154 case BT_MESSAGE_ITERATOR_STATUS_CANCELED:
d94d92ac 155 status = BT_SELF_COMPONENT_STATUS_OK;
706a18f9 156 goto end;
d6e69534 157 case BT_MESSAGE_ITERATOR_STATUS_AGAIN:
d94d92ac 158 status = BT_SELF_COMPONENT_STATUS_AGAIN;
706a18f9 159 goto end;
d6e69534 160 case BT_MESSAGE_ITERATOR_STATUS_END:
d94d92ac 161 status = BT_SELF_COMPONENT_STATUS_END;
706a18f9 162 goto end;
d6e69534
PP
163 case BT_MESSAGE_ITERATOR_STATUS_OK:
164 /* Move messages to user (count already set) */
165 memcpy(colander_data->msgs, msgs,
166 sizeof(*msgs) * *colander_data->count_addr);
706a18f9
PP
167 break;
168 default:
d94d92ac 169 status = BT_SELF_COMPONENT_STATUS_ERROR;
706a18f9
PP
170 goto end;
171 }
172
706a18f9 173end:
706a18f9
PP
174 return status;
175}
176
d94d92ac 177struct bt_component_class_sink *bt_component_class_sink_colander_get(void)
706a18f9
PP
178{
179 if (colander_comp_cls) {
180 goto end;
181 }
182
0d72b8c3
PP
183 colander_comp_cls = bt_component_class_sink_create("colander",
184 colander_consume);
706a18f9
PP
185 if (!colander_comp_cls) {
186 BT_LOGE_STR("Cannot create sink colander component class.");
187 goto end;
188 }
189
0d72b8c3 190 (void) bt_component_class_sink_set_init_method(
d94d92ac 191 colander_comp_cls, colander_init);
0d72b8c3 192 (void) bt_component_class_sink_set_finalize_method(
d94d92ac 193 colander_comp_cls, colander_finalize);
0d72b8c3 194 (void) bt_component_class_sink_set_input_port_connected_method(
d94d92ac 195 colander_comp_cls, colander_input_port_connected);
706a18f9
PP
196
197end:
398454ed
PP
198 bt_object_get_ref(colander_comp_cls);
199 return (void *) colander_comp_cls;
706a18f9
PP
200}
201
202__attribute__((destructor)) static
203void put_colander(void) {
65300d60 204 BT_OBJECT_PUT_REF_AND_RESET(colander_comp_cls);
706a18f9 205}
This page took 0.037763 seconds and 4 git commands to generate.