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/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"
39 struct bt_component_class_sink
*colander_comp_cls
;
42 enum bt_self_component_status
colander_init(
43 struct bt_self_component_sink
*self_comp
,
44 const struct bt_value
*params
, void *init_method_data
)
46 enum bt_self_component_status status
= BT_SELF_COMPONENT_STATUS_OK
;
47 struct bt_component_class_sink_colander_priv_data
*colander_data
= NULL
;
48 struct bt_component_class_sink_colander_data
*user_provided_data
=
51 BT_ASSERT(init_method_data
);
52 colander_data
= g_new0(
53 struct bt_component_class_sink_colander_priv_data
, 1);
55 BT_LOGE_STR("Failed to allocate colander data.");
56 status
= BT_SELF_COMPONENT_STATUS_NOMEM
;
60 colander_data
->msgs
= user_provided_data
->msgs
;
61 colander_data
->count_addr
= user_provided_data
->count_addr
;
62 status
= bt_self_component_sink_add_input_port(self_comp
, "in",
64 if (status
!= BT_SELF_COMPONENT_STATUS_OK
) {
65 BT_LOGE_STR("Cannot add input port.");
69 bt_self_component_set_data(
70 bt_self_component_sink_as_self_component(self_comp
),
78 void colander_finalize(struct bt_self_component_sink
*self_comp
)
80 struct bt_component_class_sink_colander_priv_data
*colander_data
=
81 bt_self_component_get_data(
82 bt_self_component_sink_as_self_component(self_comp
));
88 BT_OBJECT_PUT_REF_AND_RESET(colander_data
->msg_iter
);
89 g_free(colander_data
);
93 enum bt_self_component_status
colander_graph_is_configured(
94 bt_self_component_sink
*self_comp
)
96 enum bt_self_component_status status
= BT_SELF_COMPONENT_STATUS_OK
;
97 struct bt_component_class_sink_colander_priv_data
*colander_data
=
98 bt_self_component_get_data(
99 bt_self_component_sink_as_self_component(self_comp
));
101 struct bt_self_component_port_input
*self_port
=
102 bt_self_component_sink_borrow_input_port_by_name(self_comp
, "in");
103 BT_ASSERT(self_port
);
105 BT_ASSERT(colander_data
);
106 BT_OBJECT_PUT_REF_AND_RESET(colander_data
->msg_iter
);
107 colander_data
->msg_iter
=
108 bt_self_component_port_input_message_iterator_create(
110 if (!colander_data
->msg_iter
) {
111 BT_LIB_LOGE("Cannot create message iterator on "
112 "self component input port: %![port-]+p",
114 status
= BT_SELF_COMPONENT_STATUS_NOMEM
;
123 enum bt_self_component_status
colander_consume(
124 struct bt_self_component_sink
*self_comp
)
126 enum bt_self_component_status status
= BT_SELF_COMPONENT_STATUS_OK
;
127 enum bt_message_iterator_status msg_iter_status
;
128 struct bt_component_class_sink_colander_priv_data
*colander_data
=
129 bt_self_component_get_data(
130 bt_self_component_sink_as_self_component(self_comp
));
131 bt_message_array_const msgs
;
133 BT_ASSERT(colander_data
);
134 BT_ASSERT(colander_data
->msg_iter
);
136 bt_self_component_port_input_message_iterator_next(
137 colander_data
->msg_iter
, &msgs
,
138 colander_data
->count_addr
);
139 switch (msg_iter_status
) {
140 case BT_MESSAGE_ITERATOR_STATUS_AGAIN
:
141 status
= BT_SELF_COMPONENT_STATUS_AGAIN
;
143 case BT_MESSAGE_ITERATOR_STATUS_END
:
144 status
= BT_SELF_COMPONENT_STATUS_END
;
146 case BT_MESSAGE_ITERATOR_STATUS_OK
:
147 /* Move messages to user (count already set) */
148 memcpy(colander_data
->msgs
, msgs
,
149 sizeof(*msgs
) * *colander_data
->count_addr
);
152 status
= BT_SELF_COMPONENT_STATUS_ERROR
;
160 struct bt_component_class_sink
*bt_component_class_sink_colander_get(void)
162 if (colander_comp_cls
) {
166 colander_comp_cls
= bt_component_class_sink_create("colander",
168 if (!colander_comp_cls
) {
169 BT_LOGE_STR("Cannot create sink colander component class.");
173 (void) bt_component_class_sink_set_init_method(
174 colander_comp_cls
, colander_init
);
175 (void) bt_component_class_sink_set_finalize_method(
176 colander_comp_cls
, colander_finalize
);
177 (void) bt_component_class_sink_set_graph_is_configured_method(
178 colander_comp_cls
, colander_graph_is_configured
);
181 bt_object_get_ref(colander_comp_cls
);
182 return colander_comp_cls
;
185 __attribute__((destructor
)) static
186 void put_colander(void) {
187 BT_OBJECT_PUT_REF_AND_RESET(colander_comp_cls
);