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/graph/component.h>
32 #include <babeltrace/graph/private-component.h>
33 #include <babeltrace/graph/component-sink.h>
34 #include <babeltrace/graph/private-component-sink.h>
35 #include <babeltrace/graph/private-port.h>
36 #include <babeltrace/graph/private-connection.h>
37 #include <babeltrace/graph/notification.h>
38 #include <babeltrace/graph/notification-iterator.h>
39 #include <babeltrace/graph/notification-event.h>
40 #include <babeltrace/graph/notification-packet.h>
41 #include <plugins-common.h>
49 void destroy_writer_component_data(struct writer_component
*writer_component
)
51 bt_put(writer_component
->input_iterator
);
52 g_hash_table_destroy(writer_component
->stream_map
);
53 g_hash_table_destroy(writer_component
->stream_class_map
);
54 g_hash_table_destroy(writer_component
->trace_map
);
55 g_string_free(writer_component
->base_path
, true);
56 g_string_free(writer_component
->trace_name_base
, true);
60 void finalize_writer_component(struct bt_private_component
*component
)
62 struct writer_component
*writer_component
= (struct writer_component
*)
63 bt_private_component_get_user_data(component
);
65 destroy_writer_component_data(writer_component
);
66 g_free(writer_component
);
70 void unref_stream_class(struct bt_ctf_stream_class
*writer_stream_class
)
72 bt_put(writer_stream_class
);
76 void unref_stream(struct bt_ctf_stream_class
*writer_stream
)
78 bt_put(writer_stream
);
82 void unref_trace(struct bt_ctf_writer
*writer
)
88 struct writer_component
*create_writer_component(void)
90 struct writer_component
*writer_component
;
92 writer_component
= g_new0(struct writer_component
, 1);
93 if (!writer_component
) {
97 writer_component
->err
= stderr
;
98 writer_component
->trace_id
= 0;
99 writer_component
->trace_name_base
= g_string_new("trace");
100 writer_component
->processed_first_event
= false;
101 if (!writer_component
->trace_name_base
) {
102 g_free(writer_component
);
103 writer_component
= NULL
;
108 * Reader to writer corresponding structures.
110 writer_component
->trace_map
= g_hash_table_new_full(g_direct_hash
,
111 g_direct_equal
, NULL
, (GDestroyNotify
) unref_trace
);
112 writer_component
->stream_class_map
= g_hash_table_new_full(g_direct_hash
,
113 g_direct_equal
, NULL
, (GDestroyNotify
) unref_stream_class
);
114 writer_component
->stream_map
= g_hash_table_new_full(g_direct_hash
,
115 g_direct_equal
, NULL
, (GDestroyNotify
) unref_stream
);
118 return writer_component
;
122 enum bt_component_status
handle_notification(
123 struct writer_component
*writer_component
,
124 struct bt_notification
*notification
)
126 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
128 if (!writer_component
) {
129 ret
= BT_COMPONENT_STATUS_ERROR
;
133 switch (bt_notification_get_type(notification
)) {
134 case BT_NOTIFICATION_TYPE_PACKET_BEGIN
:
136 struct bt_ctf_packet
*packet
=
137 bt_notification_packet_begin_get_packet(notification
);
140 ret
= BT_COMPONENT_STATUS_ERROR
;
144 ret
= writer_new_packet(writer_component
, packet
);
148 case BT_NOTIFICATION_TYPE_PACKET_END
:
150 struct bt_ctf_packet
*packet
=
151 bt_notification_packet_end_get_packet(notification
);
154 ret
= BT_COMPONENT_STATUS_ERROR
;
157 ret
= writer_close_packet(writer_component
, packet
);
161 case BT_NOTIFICATION_TYPE_EVENT
:
163 struct bt_ctf_event
*event
= bt_notification_event_get_event(
167 ret
= BT_COMPONENT_STATUS_ERROR
;
170 ret
= BT_COMPONENT_STATUS_OK
;
171 ret
= writer_output_event(writer_component
, event
);
173 if (ret
!= BT_COMPONENT_STATUS_OK
) {
178 case BT_NOTIFICATION_TYPE_STREAM_END
:
181 puts("Unhandled notification type");
188 enum bt_component_status
writer_component_accept_port_connection(
189 struct bt_private_component
*component
,
190 struct bt_private_port
*self_port
,
191 struct bt_port
*other_port
)
193 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
194 struct bt_private_connection
*connection
;
195 struct writer_component
*writer
;
197 writer
= bt_private_component_get_user_data(component
);
199 assert(!writer
->input_iterator
);
200 connection
= bt_private_port_get_private_connection(self_port
);
202 writer
->input_iterator
=
203 bt_private_connection_create_notification_iterator(connection
);
205 if (!writer
->input_iterator
) {
206 ret
= BT_COMPONENT_STATUS_ERROR
;
213 enum bt_component_status
run(struct bt_private_component
*component
)
215 enum bt_component_status ret
;
216 struct bt_notification
*notification
= NULL
;
217 struct bt_notification_iterator
*it
;
218 struct writer_component
*writer_component
=
219 bt_private_component_get_user_data(component
);
221 it
= writer_component
->input_iterator
;
224 if (likely(writer_component
->processed_first_event
)) {
225 enum bt_notification_iterator_status it_ret
;
227 it_ret
= bt_notification_iterator_next(it
);
229 case BT_NOTIFICATION_ITERATOR_STATUS_ERROR
:
230 ret
= BT_COMPONENT_STATUS_ERROR
;
232 case BT_NOTIFICATION_ITERATOR_STATUS_END
:
233 ret
= BT_COMPONENT_STATUS_END
;
234 BT_PUT(writer_component
->input_iterator
);
241 notification
= bt_notification_iterator_get_notification(it
);
243 ret
= BT_COMPONENT_STATUS_ERROR
;
247 ret
= handle_notification(writer_component
, notification
);
248 writer_component
->processed_first_event
= true;
250 bt_put(notification
);
255 enum bt_component_status
writer_component_init(
256 struct bt_private_component
*component
, struct bt_value
*params
,
257 UNUSED_VAR
void *init_method_data
)
259 enum bt_component_status ret
;
260 enum bt_value_status value_ret
;
261 struct writer_component
*writer_component
= create_writer_component();
262 struct bt_value
*value
= NULL
;
265 if (!writer_component
) {
266 ret
= BT_COMPONENT_STATUS_NOMEM
;
270 value
= bt_value_map_get(params
, "path");
271 if (!value
|| bt_value_is_null(value
) || !bt_value_is_string(value
)) {
272 fprintf(writer_component
->err
,
273 "[error] output path parameter required\n");
274 ret
= BT_COMPONENT_STATUS_INVALID
;
278 value_ret
= bt_value_string_get(value
, &path
);
279 if (value_ret
!= BT_VALUE_STATUS_OK
) {
280 ret
= BT_COMPONENT_STATUS_INVALID
;
285 writer_component
->base_path
= g_string_new(path
);
286 if (!writer_component
) {
287 ret
= BT_COMPONENT_STATUS_ERROR
;
291 ret
= bt_private_component_set_user_data(component
, writer_component
);
292 if (ret
!= BT_COMPONENT_STATUS_OK
) {
299 destroy_writer_component_data(writer_component
);
300 g_free(writer_component
);
304 /* Initialize plug-in entry points. */
306 BT_PLUGIN_DESCRIPTION("Babeltrace CTF-Writer output plug-in.");
307 BT_PLUGIN_AUTHOR("Jérémie Galarneau");
308 BT_PLUGIN_LICENSE("MIT");
309 BT_PLUGIN_SINK_COMPONENT_CLASS(writer
, run
);
310 BT_PLUGIN_SINK_COMPONENT_CLASS_INIT_METHOD(writer
, writer_component_init
);
311 BT_PLUGIN_SINK_COMPONENT_CLASS_ACCEPT_PORT_CONNECTION_METHOD(writer
,
312 writer_component_accept_port_connection
);
313 BT_PLUGIN_SINK_COMPONENT_CLASS_FINALIZE_METHOD(writer
, finalize_writer_component
);
314 BT_PLUGIN_SINK_COMPONENT_CLASS_DESCRIPTION(writer
, "Formats CTF-IR to CTF.");