724d7de19f2b12bba3a5d0f304904fa17ae8d65e
[babeltrace.git] / lib / graph / component-class-sink-colander.c
1 /*
2 * Copyright 2017 Philippe Proulx <pproulx@efficios.com>
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
26 #include <babeltrace/object.h>
27 #include <babeltrace/graph/connection.h>
28 #include <babeltrace/graph/private-component-class-sink.h>
29 #include <babeltrace/graph/self-component-sink.h>
30 #include <babeltrace/graph/self-component-port.h>
31 #include <babeltrace/graph/self-component-port-input-notification-iterator.h>
32 #include <babeltrace/graph/self-component.h>
33 #include <babeltrace/graph/component-class-sink-colander-internal.h>
34 #include <babeltrace/assert-internal.h>
35 #include <glib.h>
36
37 static
38 struct bt_private_component_class_sink *colander_comp_cls;
39
40 struct colander_data {
41 bt_notification_array notifs;
42 uint64_t *count_addr;
43 struct bt_self_component_port_input_notification_iterator *notif_iter;
44 };
45
46 static
47 enum bt_self_component_status colander_init(
48 struct bt_self_component_sink *self_comp,
49 struct bt_value *params, void *init_method_data)
50 {
51 enum bt_self_component_status status = BT_SELF_COMPONENT_STATUS_OK;
52 struct colander_data *colander_data = NULL;
53 struct bt_component_class_sink_colander_data *user_provided_data =
54 init_method_data;
55
56 if (!init_method_data) {
57 BT_LOGW_STR("Component initialization method data is NULL.");
58 status = BT_SELF_COMPONENT_STATUS_ERROR;
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.");
65 status = BT_SELF_COMPONENT_STATUS_NOMEM;
66 goto end;
67 }
68
69 colander_data->notifs = user_provided_data->notifs;
70 colander_data->count_addr = user_provided_data->count_addr;
71 status = bt_self_component_sink_add_input_port(self_comp, "in",
72 NULL, NULL);
73 if (status != BT_SELF_COMPONENT_STATUS_OK) {
74 BT_LOGE_STR("Cannot add input port.");
75 goto end;
76 }
77
78 bt_self_component_set_data(
79 bt_self_component_sink_as_self_component(self_comp),
80 colander_data);
81
82 end:
83 return status;
84 }
85
86 static
87 void colander_finalize(struct bt_self_component_sink *self_comp)
88 {
89 struct colander_data *colander_data =
90 bt_self_component_get_data(
91 bt_self_component_sink_as_self_component(self_comp));
92
93 if (!colander_data) {
94 return;
95 }
96
97 BT_OBJECT_PUT_REF_AND_RESET(colander_data->notif_iter);
98 g_free(colander_data);
99 }
100
101 static
102 enum 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,
105 struct bt_port_output *other_port)
106 {
107 enum bt_self_component_status status = BT_SELF_COMPONENT_STATUS_OK;
108 struct colander_data *colander_data =
109 bt_self_component_get_data(
110 bt_self_component_sink_as_self_component(self_comp));
111
112 BT_ASSERT(colander_data);
113 BT_OBJECT_PUT_REF_AND_RESET(colander_data->notif_iter);
114 colander_data->notif_iter =
115 bt_self_component_port_input_notification_iterator_create(
116 self_port);
117 if (!colander_data->notif_iter) {
118 BT_LIB_LOGE("Cannot create notification iterator on "
119 "self component input port: %![port-]+p",
120 self_port);
121 status = BT_SELF_COMPONENT_STATUS_NOMEM;
122 goto end;
123 }
124
125 end:
126 return status;
127 }
128
129 static
130 enum bt_self_component_status colander_consume(
131 struct bt_self_component_sink *self_comp)
132 {
133 enum bt_self_component_status status = BT_SELF_COMPONENT_STATUS_OK;
134 enum bt_notification_iterator_status notif_iter_status;
135 struct colander_data *colander_data =
136 bt_self_component_get_data(
137 bt_self_component_sink_as_self_component(self_comp));
138 bt_notification_array notifs;
139
140 BT_ASSERT(colander_data);
141
142 if (!colander_data->notif_iter) {
143 BT_LIB_LOGW("Trying to consume without an "
144 "upstream notification iterator: %![comp-]+c",
145 self_comp);
146 goto end;
147 }
148
149 notif_iter_status =
150 bt_self_component_port_input_notification_iterator_next(
151 colander_data->notif_iter, &notifs,
152 colander_data->count_addr);
153 switch (notif_iter_status) {
154 case BT_NOTIFICATION_ITERATOR_STATUS_CANCELED:
155 status = BT_SELF_COMPONENT_STATUS_OK;
156 goto end;
157 case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN:
158 status = BT_SELF_COMPONENT_STATUS_AGAIN;
159 goto end;
160 case BT_NOTIFICATION_ITERATOR_STATUS_END:
161 status = BT_SELF_COMPONENT_STATUS_END;
162 goto end;
163 case BT_NOTIFICATION_ITERATOR_STATUS_OK:
164 /* Move notifications to user (count already set) */
165 memcpy(colander_data->notifs, notifs,
166 sizeof(*notifs) * *colander_data->count_addr);
167 break;
168 default:
169 status = BT_SELF_COMPONENT_STATUS_ERROR;
170 goto end;
171 }
172
173 end:
174 return status;
175 }
176
177 struct bt_component_class_sink *bt_component_class_sink_colander_get(void)
178 {
179 if (colander_comp_cls) {
180 goto end;
181 }
182
183 colander_comp_cls = bt_private_component_class_sink_create(
184 "colander", colander_consume);
185 if (!colander_comp_cls) {
186 BT_LOGE_STR("Cannot create sink colander component class.");
187 goto end;
188 }
189
190 (void) bt_private_component_class_sink_set_init_method(
191 colander_comp_cls, colander_init);
192 (void) bt_private_component_class_sink_set_finalize_method(
193 colander_comp_cls, colander_finalize);
194 (void) bt_private_component_class_sink_set_input_port_connected_method(
195 colander_comp_cls, colander_input_port_connected);
196
197 end:
198 bt_object_get_ref(colander_comp_cls);
199 return (void *) colander_comp_cls;
200 }
201
202 __attribute__((destructor)) static
203 void put_colander(void) {
204 BT_OBJECT_PUT_REF_AND_RESET(colander_comp_cls);
205 }
This page took 0.032933 seconds and 3 git commands to generate.