2 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
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:
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
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
23 #define BT_LOG_TAG "COLANDER"
24 #include <babeltrace/lib-logging-internal.h>
26 #include <babeltrace/assert-internal.h>
27 #include <babeltrace/assert-pre-internal.h>
28 #include <babeltrace/object-internal.h>
29 #include <babeltrace/graph/component-class-sink.h>
30 #include <babeltrace/graph/self-component-sink.h>
31 #include <babeltrace/graph/self-component-port.h>
32 #include <babeltrace/graph/self-component-port-input-message-iterator.h>
33 #include <babeltrace/graph/self-component.h>
34 #include <babeltrace/graph/component-class-sink-colander-internal.h>
38 struct bt_component_class_sink
*colander_comp_cls
;
41 enum bt_self_component_status
colander_init(
42 struct bt_self_component_sink
*self_comp
,
43 const struct bt_value
*params
, void *init_method_data
)
45 enum bt_self_component_status status
= BT_SELF_COMPONENT_STATUS_OK
;
46 struct bt_component_class_sink_colander_priv_data
*colander_data
= NULL
;
47 struct bt_component_class_sink_colander_data
*user_provided_data
=
50 if (!init_method_data
) {
51 BT_LOGW_STR("Component initialization method data is NULL.");
52 status
= BT_SELF_COMPONENT_STATUS_ERROR
;
56 colander_data
= g_new0(
57 struct bt_component_class_sink_colander_priv_data
, 1);
59 BT_LOGE_STR("Failed to allocate colander data.");
60 status
= BT_SELF_COMPONENT_STATUS_NOMEM
;
64 colander_data
->msgs
= user_provided_data
->msgs
;
65 colander_data
->count_addr
= user_provided_data
->count_addr
;
66 status
= bt_self_component_sink_add_input_port(self_comp
, "in",
68 if (status
!= BT_SELF_COMPONENT_STATUS_OK
) {
69 BT_LOGE_STR("Cannot add input port.");
73 bt_self_component_set_data(
74 bt_self_component_sink_as_self_component(self_comp
),
82 void colander_finalize(struct bt_self_component_sink
*self_comp
)
84 struct bt_component_class_sink_colander_priv_data
*colander_data
=
85 bt_self_component_get_data(
86 bt_self_component_sink_as_self_component(self_comp
));
92 BT_OBJECT_PUT_REF_AND_RESET(colander_data
->msg_iter
);
93 g_free(colander_data
);
97 enum bt_self_component_status
colander_input_port_connected(
98 struct bt_self_component_sink
*self_comp
,
99 struct bt_self_component_port_input
*self_port
,
100 const struct bt_port_output
*other_port
)
102 enum bt_self_component_status status
= BT_SELF_COMPONENT_STATUS_OK
;
103 struct bt_component_class_sink_colander_priv_data
*colander_data
=
104 bt_self_component_get_data(
105 bt_self_component_sink_as_self_component(self_comp
));
107 BT_ASSERT(colander_data
);
108 BT_OBJECT_PUT_REF_AND_RESET(colander_data
->msg_iter
);
109 colander_data
->msg_iter
=
110 bt_self_component_port_input_message_iterator_create(
112 if (!colander_data
->msg_iter
) {
113 BT_LIB_LOGE("Cannot create message iterator on "
114 "self component input port: %![port-]+p",
116 status
= BT_SELF_COMPONENT_STATUS_NOMEM
;
125 enum bt_self_component_status
colander_consume(
126 struct bt_self_component_sink
*self_comp
)
128 enum bt_self_component_status status
= BT_SELF_COMPONENT_STATUS_OK
;
129 enum bt_message_iterator_status msg_iter_status
;
130 struct bt_component_class_sink_colander_priv_data
*colander_data
=
131 bt_self_component_get_data(
132 bt_self_component_sink_as_self_component(self_comp
));
133 bt_message_array_const msgs
;
135 BT_ASSERT(colander_data
);
137 if (!colander_data
->msg_iter
) {
138 BT_LIB_LOGW("Trying to consume without an "
139 "upstream message iterator: %![comp-]+c",
145 bt_self_component_port_input_message_iterator_next(
146 colander_data
->msg_iter
, &msgs
,
147 colander_data
->count_addr
);
148 switch (msg_iter_status
) {
149 case BT_MESSAGE_ITERATOR_STATUS_AGAIN
:
150 status
= BT_SELF_COMPONENT_STATUS_AGAIN
;
152 case BT_MESSAGE_ITERATOR_STATUS_END
:
153 status
= BT_SELF_COMPONENT_STATUS_END
;
155 case BT_MESSAGE_ITERATOR_STATUS_OK
:
156 /* Move messages to user (count already set) */
157 memcpy(colander_data
->msgs
, msgs
,
158 sizeof(*msgs
) * *colander_data
->count_addr
);
161 status
= BT_SELF_COMPONENT_STATUS_ERROR
;
169 struct bt_component_class_sink
*bt_component_class_sink_colander_get(void)
171 if (colander_comp_cls
) {
175 colander_comp_cls
= bt_component_class_sink_create("colander",
177 if (!colander_comp_cls
) {
178 BT_LOGE_STR("Cannot create sink colander component class.");
182 (void) bt_component_class_sink_set_init_method(
183 colander_comp_cls
, colander_init
);
184 (void) bt_component_class_sink_set_finalize_method(
185 colander_comp_cls
, colander_finalize
);
186 (void) bt_component_class_sink_set_input_port_connected_method(
187 colander_comp_cls
, colander_input_port_connected
);
190 bt_object_get_ref(colander_comp_cls
);
191 return (void *) colander_comp_cls
;
194 __attribute__((destructor
)) static
195 void put_colander(void) {
196 BT_OBJECT_PUT_REF_AND_RESET(colander_comp_cls
);