2 * Copyright 2017-2019 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 "LIB/COMPONENT-CLASS-SINK-SIMPLE"
24 #include "lib/logging.h"
26 #include "common/assert.h"
27 #include "common/common.h"
28 #include "lib/assert-pre.h"
29 #include "lib/object.h"
30 #include <babeltrace2/graph/component-class-sink.h>
31 #include <babeltrace2/graph/self-component-sink.h>
32 #include <babeltrace2/graph/self-component-port.h>
33 #include <babeltrace2/graph/self-component-port-input-message-iterator.h>
34 #include <babeltrace2/graph/self-component.h>
37 #include "component-class-sink-simple.h"
38 #include "lib/func-status.h"
41 * We keep a single simple sink component class reference. It's created
42 * the first time bt_component_class_sink_simple_borrow() is called and
43 * put by the put_simple_sink_component_class() library destructor.
46 struct bt_component_class_sink
*simple_comp_cls
;
48 struct simple_sink_data
{
49 bt_self_component_port_input_message_iterator
*msg_iter
;
50 struct simple_sink_init_method_data init_method_data
;
54 enum bt_component_class_init_method_status
simple_sink_init(
55 struct bt_self_component_sink
*self_comp
,
56 const struct bt_value
*params
, void *init_method_data
)
58 int status
= BT_FUNC_STATUS_OK
;
59 struct simple_sink_data
*data
= NULL
;
61 data
= g_new0(struct simple_sink_data
, 1);
63 BT_LIB_LOGE_APPEND_CAUSE(
64 "Failed to allocate simple sink component private data.");
65 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
69 BT_ASSERT(init_method_data
);
70 data
->init_method_data
=
71 *((struct simple_sink_init_method_data
*) init_method_data
);
74 status
= bt_self_component_sink_add_input_port(self_comp
, "in",
76 if (status
!= BT_FUNC_STATUS_OK
) {
77 BT_LIB_LOGE_APPEND_CAUSE(
78 "Cannot add input port to simple sink component.");
82 bt_self_component_set_data(
83 bt_self_component_sink_as_self_component(self_comp
), data
);
90 void simple_sink_finalize(struct bt_self_component_sink
*self_comp
)
92 struct simple_sink_data
*data
= bt_self_component_get_data(
93 bt_self_component_sink_as_self_component(self_comp
));
96 if (data
->init_method_data
.finalize_func
) {
97 /* Call user's finalization function */
98 data
->init_method_data
.finalize_func(
99 data
->init_method_data
.user_data
);
102 BT_OBJECT_PUT_REF_AND_RESET(data
->msg_iter
);
108 enum bt_component_class_sink_graph_is_configured_method_status
109 simple_sink_graph_is_configured(
110 bt_self_component_sink
*self_comp
)
112 bt_component_class_sink_graph_is_configured_method_status status
;
113 bt_self_component_port_input_message_iterator_create_from_sink_component_status
115 struct simple_sink_data
*data
= bt_self_component_get_data(
116 bt_self_component_sink_as_self_component(self_comp
));
118 struct bt_self_component_port_input
*self_port
=
119 bt_self_component_sink_borrow_input_port_by_name(self_comp
,
122 if (!bt_port_is_connected(bt_self_component_port_as_port(
123 bt_self_component_port_input_as_self_component_port(self_port
)))) {
124 BT_LIB_LOGE_APPEND_CAUSE(
125 "Simple sink component's input port is not connected: "
126 "%![comp-]+c, %![port-]+p", self_comp
, self_port
);
127 status
= BT_COMPONENT_CLASS_SINK_GRAPH_IS_CONFIGURED_METHOD_STATUS_ERROR
;
132 msg_iter_status
= bt_self_component_port_input_message_iterator_create_from_sink_component(
133 self_comp
, self_port
, &data
->msg_iter
);
134 if (msg_iter_status
!= BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_CREATE_FROM_SINK_COMPONENT_STATUS_OK
) {
135 BT_LIB_LOGE_APPEND_CAUSE(
136 "Cannot create input port message iterator: "
137 "%![comp-]+c, %![port-]+p", self_comp
, self_port
);
138 status
= (int) msg_iter_status
;
142 if (data
->init_method_data
.init_func
) {
143 bt_graph_simple_sink_component_init_func_status init_status
;
145 /* Call user's initialization function */
146 init_status
= data
->init_method_data
.init_func(data
->msg_iter
,
147 data
->init_method_data
.user_data
);
148 if (init_status
!= BT_GRAPH_SIMPLE_SINK_COMPONENT_INIT_FUNC_STATUS_OK
) {
149 BT_LIB_LOGW_APPEND_CAUSE(
150 "Simple sink component's user's initialization function failed: "
151 "status=%s, %![comp-]+c, %![port-]+p",
152 bt_common_func_status_string(init_status
),
153 self_comp
, self_port
);
154 status
= (int) init_status
;
159 status
= BT_COMPONENT_CLASS_SINK_GRAPH_IS_CONFIGURED_METHOD_STATUS_OK
;
166 enum bt_component_class_sink_consume_method_status
simple_sink_consume(
167 struct bt_self_component_sink
*self_comp
)
170 struct simple_sink_data
*data
= bt_self_component_get_data(
171 bt_self_component_sink_as_self_component(self_comp
));
174 BT_ASSERT(data
->init_method_data
.consume_func
);
175 BT_ASSERT(data
->msg_iter
);
177 /* Call user's "consume" function */
178 status
= data
->init_method_data
.consume_func(data
->msg_iter
,
179 data
->init_method_data
.user_data
);
180 if (status
!= BT_FUNC_STATUS_OK
) {
181 BT_LIB_LOGW_APPEND_CAUSE(
182 "Simple sink component's user's \"consume\" function failed: "
183 "status=%s, %![comp-]+c",
184 bt_common_func_status_string(status
), self_comp
);
190 struct bt_component_class_sink
*bt_component_class_sink_simple_borrow(void)
192 enum bt_component_class_set_method_status set_method_status
;
194 if (simple_comp_cls
) {
198 simple_comp_cls
= bt_component_class_sink_create("simple-sink",
199 simple_sink_consume
);
200 if (!simple_comp_cls
) {
201 BT_LIB_LOGE_APPEND_CAUSE(
202 "Cannot create simple sink component class.");
206 set_method_status
= bt_component_class_sink_set_init_method(
207 simple_comp_cls
, simple_sink_init
);
208 BT_ASSERT(set_method_status
== BT_FUNC_STATUS_OK
);
209 set_method_status
= bt_component_class_sink_set_finalize_method(
210 simple_comp_cls
, simple_sink_finalize
);
211 BT_ASSERT(set_method_status
== BT_FUNC_STATUS_OK
);
212 set_method_status
= bt_component_class_sink_set_graph_is_configured_method(
213 simple_comp_cls
, simple_sink_graph_is_configured
);
214 BT_ASSERT(set_method_status
== BT_FUNC_STATUS_OK
);
217 return simple_comp_cls
;
220 __attribute__((destructor
)) static
221 void put_simple_sink_component_class(void) {
222 BT_OBJECT_PUT_REF_AND_RESET(simple_comp_cls
);