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/connection.h>
32 #include <babeltrace/graph/component.h>
33 #include <babeltrace/graph/private-component.h>
34 #include <babeltrace/graph/component-sink.h>
35 #include <babeltrace/graph/private-component-sink.h>
36 #include <babeltrace/graph/private-port.h>
37 #include <babeltrace/graph/private-connection.h>
38 #include <babeltrace/graph/notification.h>
39 #include <babeltrace/graph/notification-iterator.h>
40 #include <babeltrace/graph/notification-event.h>
41 #include <babeltrace/graph/notification-packet.h>
42 #include <babeltrace/graph/notification-stream.h>
43 #include <plugins-common.h>
50 gboolean
empty_trace_map(gpointer key
, gpointer value
, gpointer user_data
)
52 struct fs_writer
*fs_writer
= value
;
53 struct writer_component
*writer_component
= user_data
;
55 fs_writer
->trace_static
= 1;
56 writer_close(writer_component
, fs_writer
);
62 void destroy_writer_component_data(struct writer_component
*writer_component
)
64 bt_put(writer_component
->input_iterator
);
66 g_hash_table_foreach_remove(writer_component
->trace_map
,
67 empty_trace_map
, writer_component
);
68 g_hash_table_destroy(writer_component
->trace_map
);
70 g_string_free(writer_component
->base_path
, true);
71 g_string_free(writer_component
->trace_name_base
, true);
75 void writer_component_finalize(struct bt_private_component
*component
)
77 struct writer_component
*writer_component
= (struct writer_component
*)
78 bt_private_component_get_user_data(component
);
80 destroy_writer_component_data(writer_component
);
81 g_free(writer_component
);
85 void free_fs_writer(struct fs_writer
*fs_writer
)
87 bt_put(fs_writer
->writer
);
92 struct writer_component
*create_writer_component(void)
94 struct writer_component
*writer_component
;
96 writer_component
= g_new0(struct writer_component
, 1);
97 if (!writer_component
) {
101 writer_component
->err
= stderr
;
102 writer_component
->trace_id
= 0;
103 writer_component
->trace_name_base
= g_string_new("trace");
104 if (!writer_component
->trace_name_base
) {
105 g_free(writer_component
);
106 writer_component
= NULL
;
111 * Reader to writer corresponding structures.
113 writer_component
->trace_map
= g_hash_table_new_full(g_direct_hash
,
114 g_direct_equal
, NULL
, (GDestroyNotify
) free_fs_writer
);
117 return writer_component
;
121 enum bt_component_status
handle_notification(
122 struct writer_component
*writer_component
,
123 struct bt_notification
*notification
)
125 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
127 if (!writer_component
) {
128 ret
= BT_COMPONENT_STATUS_ERROR
;
132 switch (bt_notification_get_type(notification
)) {
133 case BT_NOTIFICATION_TYPE_PACKET_BEGIN
:
135 struct bt_ctf_packet
*packet
=
136 bt_notification_packet_begin_get_packet(notification
);
139 ret
= BT_COMPONENT_STATUS_ERROR
;
143 ret
= writer_new_packet(writer_component
, packet
);
147 case BT_NOTIFICATION_TYPE_PACKET_END
:
149 struct bt_ctf_packet
*packet
=
150 bt_notification_packet_end_get_packet(notification
);
153 ret
= BT_COMPONENT_STATUS_ERROR
;
156 ret
= writer_close_packet(writer_component
, packet
);
160 case BT_NOTIFICATION_TYPE_EVENT
:
162 struct bt_ctf_event
*event
= bt_notification_event_get_event(
166 ret
= BT_COMPONENT_STATUS_ERROR
;
169 ret
= writer_output_event(writer_component
, event
);
171 if (ret
!= BT_COMPONENT_STATUS_OK
) {
176 case BT_NOTIFICATION_TYPE_STREAM_BEGIN
:
178 struct bt_ctf_stream
*stream
=
179 bt_notification_stream_begin_get_stream(notification
);
182 ret
= BT_COMPONENT_STATUS_ERROR
;
185 ret
= writer_stream_begin(writer_component
, stream
);
189 case BT_NOTIFICATION_TYPE_STREAM_END
:
191 struct bt_ctf_stream
*stream
=
192 bt_notification_stream_end_get_stream(notification
);
195 ret
= BT_COMPONENT_STATUS_ERROR
;
198 ret
= writer_stream_end(writer_component
, stream
);
203 puts("Unhandled notification type");
210 void writer_component_port_connected(
211 struct bt_private_component
*component
,
212 struct bt_private_port
*self_port
,
213 struct bt_port
*other_port
)
215 struct bt_private_connection
*connection
;
216 struct writer_component
*writer
;
217 enum bt_connection_status conn_status
;
218 static const enum bt_notification_type notif_types
[] = {
219 BT_NOTIFICATION_TYPE_EVENT
,
220 BT_NOTIFICATION_TYPE_PACKET_BEGIN
,
221 BT_NOTIFICATION_TYPE_PACKET_END
,
222 BT_NOTIFICATION_TYPE_STREAM_BEGIN
,
223 BT_NOTIFICATION_TYPE_STREAM_END
,
224 BT_NOTIFICATION_TYPE_SENTINEL
,
227 writer
= bt_private_component_get_user_data(component
);
229 assert(!writer
->input_iterator
);
230 connection
= bt_private_port_get_private_connection(self_port
);
232 conn_status
= bt_private_connection_create_notification_iterator(
233 connection
, notif_types
, &writer
->input_iterator
);
234 if (conn_status
!= BT_CONNECTION_STATUS_OK
) {
235 writer
->error
= true;
242 enum bt_component_status
writer_run(struct bt_private_component
*component
)
244 enum bt_component_status ret
;
245 struct bt_notification
*notification
= NULL
;
246 struct bt_notification_iterator
*it
;
247 struct writer_component
*writer_component
=
248 bt_private_component_get_user_data(component
);
249 enum bt_notification_iterator_status it_ret
;
251 if (unlikely(writer_component
->error
)) {
252 ret
= BT_COMPONENT_STATUS_ERROR
;
256 it
= writer_component
->input_iterator
;
258 it_ret
= bt_notification_iterator_next(it
);
261 case BT_NOTIFICATION_ITERATOR_STATUS_END
:
262 ret
= BT_COMPONENT_STATUS_END
;
263 BT_PUT(writer_component
->input_iterator
);
265 case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN
:
266 ret
= BT_COMPONENT_STATUS_AGAIN
;
268 case BT_NOTIFICATION_ITERATOR_STATUS_OK
:
271 ret
= BT_COMPONENT_STATUS_ERROR
;
275 notification
= bt_notification_iterator_get_notification(it
);
276 assert(notification
);
277 ret
= handle_notification(writer_component
, notification
);
279 bt_put(notification
);
284 enum bt_component_status
writer_component_init(
285 struct bt_private_component
*component
, struct bt_value
*params
,
286 UNUSED_VAR
void *init_method_data
)
288 enum bt_component_status ret
;
289 enum bt_value_status value_ret
;
290 struct writer_component
*writer_component
= create_writer_component();
291 struct bt_value
*value
= NULL
;
294 if (!writer_component
) {
295 ret
= BT_COMPONENT_STATUS_NOMEM
;
299 ret
= bt_private_component_sink_add_input_private_port(component
,
301 if (ret
!= BT_COMPONENT_STATUS_OK
) {
305 value
= bt_value_map_get(params
, "path");
306 if (!value
|| bt_value_is_null(value
) || !bt_value_is_string(value
)) {
307 fprintf(writer_component
->err
,
308 "[error] output path parameter required\n");
309 ret
= BT_COMPONENT_STATUS_INVALID
;
313 value_ret
= bt_value_string_get(value
, &path
);
314 if (value_ret
!= BT_VALUE_STATUS_OK
) {
315 ret
= BT_COMPONENT_STATUS_INVALID
;
320 writer_component
->base_path
= g_string_new(path
);
321 if (!writer_component
) {
322 ret
= BT_COMPONENT_STATUS_ERROR
;
326 ret
= bt_private_component_set_user_data(component
, writer_component
);
327 if (ret
!= BT_COMPONENT_STATUS_OK
) {
334 destroy_writer_component_data(writer_component
);
335 g_free(writer_component
);