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 "LIB/COLANDER"
24 #include "lib/logging.h"
26 #include "common/assert.h"
27 #include "lib/assert-pre.h"
28 #include "lib/object.h"
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>
36 #include "component-class-sink-colander.h"
37 #include "lib/func-status.h"
40 struct bt_component_class_sink
*colander_comp_cls
;
43 enum bt_component_class_init_method_status
colander_init(
44 struct bt_self_component_sink
*self_comp
,
45 const struct bt_value
*params
, void *init_method_data
)
47 int status
= BT_FUNC_STATUS_OK
;
48 struct bt_component_class_sink_colander_priv_data
*colander_data
= NULL
;
49 struct bt_component_class_sink_colander_data
*user_provided_data
=
52 BT_ASSERT(init_method_data
);
53 colander_data
= g_new0(
54 struct bt_component_class_sink_colander_priv_data
, 1);
56 BT_LIB_LOGE_APPEND_CAUSE(
57 "Failed to allocate colander sink data.");
58 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
62 colander_data
->msgs
= user_provided_data
->msgs
;
63 colander_data
->count_addr
= user_provided_data
->count_addr
;
64 status
= bt_self_component_sink_add_input_port(self_comp
, "in",
66 if (status
!= BT_FUNC_STATUS_OK
) {
67 BT_LIB_LOGE_APPEND_CAUSE(
68 "Cannot add input port to colander sink.");
72 bt_self_component_set_data(
73 bt_self_component_sink_as_self_component(self_comp
),
81 void colander_finalize(struct bt_self_component_sink
*self_comp
)
83 struct bt_component_class_sink_colander_priv_data
*colander_data
=
84 bt_self_component_get_data(
85 bt_self_component_sink_as_self_component(self_comp
));
91 BT_OBJECT_PUT_REF_AND_RESET(colander_data
->msg_iter
);
92 g_free(colander_data
);
96 enum bt_component_class_sink_graph_is_configured_method_status
97 colander_graph_is_configured(
98 bt_self_component_sink
*self_comp
)
100 enum bt_component_class_sink_graph_is_configured_method_status status
=
102 struct bt_component_class_sink_colander_priv_data
*colander_data
=
103 bt_self_component_get_data(
104 bt_self_component_sink_as_self_component(self_comp
));
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
);
110 BT_ASSERT(colander_data
);
111 BT_OBJECT_PUT_REF_AND_RESET(colander_data
->msg_iter
);
112 colander_data
->msg_iter
=
113 bt_self_component_port_input_message_iterator_create_from_sink_component(
114 self_comp
, self_port
);
115 if (!colander_data
->msg_iter
) {
116 BT_LIB_LOGE_APPEND_CAUSE("Cannot create message iterator on "
117 "self component input port: %![port-]+p",
119 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
128 enum bt_component_class_sink_consume_method_status
colander_consume(
129 struct bt_self_component_sink
*self_comp
)
131 enum bt_component_class_sink_consume_method_status status
=
133 enum bt_message_iterator_next_status next_status
;
134 struct bt_component_class_sink_colander_priv_data
*colander_data
=
135 bt_self_component_get_data(
136 bt_self_component_sink_as_self_component(self_comp
));
137 bt_message_array_const msgs
;
139 BT_ASSERT(colander_data
);
140 BT_ASSERT(colander_data
->msg_iter
);
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
;
148 case BT_FUNC_STATUS_END
:
149 status
= BT_FUNC_STATUS_END
;
151 case BT_FUNC_STATUS_OK
:
152 /* Move messages to user (count already set) */
153 memcpy(colander_data
->msgs
, msgs
,
154 sizeof(*msgs
) * *colander_data
->count_addr
);
157 status
= BT_FUNC_STATUS_ERROR
;
165 struct bt_component_class_sink
*bt_component_class_sink_colander_get(void)
167 if (colander_comp_cls
) {
171 colander_comp_cls
= bt_component_class_sink_create("colander",
173 if (!colander_comp_cls
) {
174 BT_LIB_LOGE_APPEND_CAUSE(
175 "Cannot create sink colander component class.");
179 (void) bt_component_class_sink_set_init_method(
180 colander_comp_cls
, colander_init
);
181 (void) bt_component_class_sink_set_finalize_method(
182 colander_comp_cls
, colander_finalize
);
183 (void) bt_component_class_sink_set_graph_is_configured_method(
184 colander_comp_cls
, colander_graph_is_configured
);
187 bt_object_get_ref(colander_comp_cls
);
188 return colander_comp_cls
;
191 __attribute__((destructor
)) static
192 void put_colander(void) {
193 BT_OBJECT_PUT_REF_AND_RESET(colander_comp_cls
);