4 * Babeltrace CTF Writer Output Plugin
6 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
10 * Permission is hereby granted, free of charge, to any person obtaining a copy
11 * of this software and associated documentation files (the "Software"), to deal
12 * in the Software without restriction, including without limitation the rights
13 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 * copies of the Software, and to permit persons to whom the Software is
15 * furnished to do so, subject to the following conditions:
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29 #include <babeltrace/ctf-ir/packet.h>
30 #include <babeltrace/plugin/plugin-dev.h>
31 #include <babeltrace/component/component.h>
32 #include <babeltrace/component/component-sink.h>
33 #include <babeltrace/component/notification/notification.h>
34 #include <babeltrace/component/notification/iterator.h>
35 #include <babeltrace/component/notification/event.h>
36 #include <babeltrace/component/notification/packet.h>
43 void destroy_writer_component_data(struct writer_component
*writer_component
)
45 g_hash_table_destroy(writer_component
->stream_map
);
46 g_hash_table_destroy(writer_component
->stream_class_map
);
47 g_hash_table_destroy(writer_component
->trace_map
);
48 g_string_free(writer_component
->base_path
, true);
49 g_string_free(writer_component
->trace_name_base
, true);
53 void destroy_writer_component(struct bt_component
*component
)
55 struct writer_component
*writer_component
= (struct writer_component
*)
56 bt_component_get_private_data(component
);
58 destroy_writer_component_data(writer_component
);
59 g_free(writer_component
);
63 void unref_stream_class(struct bt_ctf_stream_class
*writer_stream_class
)
65 BT_PUT(writer_stream_class
);
66 g_free(writer_stream_class
);
70 void unref_stream(struct bt_ctf_stream_class
*writer_stream
)
72 BT_PUT(writer_stream
);
73 g_free(writer_stream
);
77 void unref_trace(struct bt_ctf_writer
*writer
)
84 struct writer_component
*create_writer_component(void)
86 struct writer_component
*writer_component
;
88 writer_component
= g_new0(struct writer_component
, 1);
89 if (!writer_component
) {
93 writer_component
->err
= stderr
;
94 writer_component
->trace_id
= 0;
95 writer_component
->trace_name_base
= g_string_new("trace");
96 if (!writer_component
->trace_name_base
) {
97 g_free(writer_component
);
98 writer_component
= NULL
;
103 * Reader to writer corresponding structures.
105 writer_component
->trace_map
= g_hash_table_new_full(g_direct_hash
,
106 g_direct_equal
, NULL
, (GDestroyNotify
) unref_trace
);
107 writer_component
->stream_class_map
= g_hash_table_new_full(g_direct_hash
,
108 g_direct_equal
, NULL
, (GDestroyNotify
) unref_stream_class
);
109 writer_component
->stream_map
= g_hash_table_new_full(g_direct_hash
,
110 g_direct_equal
, NULL
, (GDestroyNotify
) unref_stream
);
113 return writer_component
;
117 enum bt_component_status
handle_notification(
118 struct writer_component
*writer_component
,
119 struct bt_notification
*notification
)
121 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
123 if (!writer_component
) {
124 ret
= BT_COMPONENT_STATUS_ERROR
;
128 switch (bt_notification_get_type(notification
)) {
129 case BT_NOTIFICATION_TYPE_PACKET_BEGIN
:
131 struct bt_ctf_packet
*packet
=
132 bt_notification_packet_begin_get_packet(notification
);
135 ret
= BT_COMPONENT_STATUS_ERROR
;
139 ret
= writer_new_packet(writer_component
, packet
);
143 case BT_NOTIFICATION_TYPE_PACKET_END
:
145 struct bt_ctf_packet
*packet
=
146 bt_notification_packet_end_get_packet(notification
);
149 ret
= BT_COMPONENT_STATUS_ERROR
;
152 ret
= writer_close_packet(writer_component
, packet
);
156 case BT_NOTIFICATION_TYPE_EVENT
:
158 struct bt_ctf_event
*event
= bt_notification_event_get_event(
162 ret
= BT_COMPONENT_STATUS_ERROR
;
165 ret
= BT_COMPONENT_STATUS_OK
;
166 ret
= writer_output_event(writer_component
, event
);
168 if (ret
!= BT_COMPONENT_STATUS_OK
) {
173 case BT_NOTIFICATION_TYPE_STREAM_END
:
176 puts("Unhandled notification type");
183 enum bt_component_status
run(struct bt_component
*component
)
185 enum bt_component_status ret
;
186 struct bt_notification
*notification
= NULL
;
187 struct bt_notification_iterator
*it
;
188 struct writer_component
*writer_component
=
189 bt_component_get_private_data(component
);
191 ret
= bt_component_sink_get_input_iterator(component
, 0, &it
);
192 if (ret
!= BT_COMPONENT_STATUS_OK
) {
196 notification
= bt_notification_iterator_get_notification(it
);
198 ret
= BT_COMPONENT_STATUS_ERROR
;
202 ret
= bt_notification_iterator_next(it
);
203 if (ret
!= BT_COMPONENT_STATUS_OK
) {
207 ret
= handle_notification(writer_component
, notification
);
210 bt_put(notification
);
215 enum bt_component_status
writer_component_init(
216 struct bt_component
*component
, struct bt_value
*params
)
218 enum bt_component_status ret
;
219 enum bt_value_status value_ret
;
220 struct writer_component
*writer_component
= create_writer_component();
221 struct bt_value
*value
= NULL
;
224 if (!writer_component
) {
225 ret
= BT_COMPONENT_STATUS_NOMEM
;
229 value
= bt_value_map_get(params
, "path");
230 if (!value
|| bt_value_is_null(value
) || !bt_value_is_string(value
)) {
231 fprintf(writer_component
->err
,
232 "[error] output path parameter required\n");
233 ret
= BT_COMPONENT_STATUS_INVALID
;
237 value_ret
= bt_value_string_get(value
, &path
);
238 if (value_ret
!= BT_VALUE_STATUS_OK
) {
239 ret
= BT_COMPONENT_STATUS_INVALID
;
243 writer_component
->base_path
= g_string_new(path
);
244 if (!writer_component
) {
245 ret
= BT_COMPONENT_STATUS_ERROR
;
249 ret
= bt_component_set_private_data(component
, writer_component
);
250 if (ret
!= BT_COMPONENT_STATUS_OK
) {
257 destroy_writer_component_data(writer_component
);
258 g_free(writer_component
);
262 /* Initialize plug-in entry points. */
264 BT_PLUGIN_DESCRIPTION("Babeltrace CTF-Writer output plug-in.");
265 BT_PLUGIN_AUTHOR("Jérémie Galarneau");
266 BT_PLUGIN_LICENSE("MIT");
267 BT_PLUGIN_SINK_COMPONENT_CLASS(writer
, run
);
268 BT_PLUGIN_SINK_COMPONENT_CLASS_INIT_METHOD(writer
, writer_component_init
);
269 BT_PLUGIN_SINK_COMPONENT_CLASS_DESTROY_METHOD(writer
, destroy_writer_component
);
270 BT_PLUGIN_SINK_COMPONENT_CLASS_DESCRIPTION(writer
, "Formats CTF-IR to CTF.");