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>
51 gboolean
empty_trace_map(gpointer key
, gpointer value
, gpointer user_data
)
53 struct fs_writer
*fs_writer
= value
;
54 struct writer_component
*writer_component
= user_data
;
56 fs_writer
->trace_static
= 1;
57 writer_close(writer_component
, fs_writer
);
63 void destroy_writer_component_data(struct writer_component
*writer_component
)
65 bt_put(writer_component
->input_iterator
);
67 g_hash_table_foreach_remove(writer_component
->trace_map
,
68 empty_trace_map
, writer_component
);
69 g_hash_table_destroy(writer_component
->trace_map
);
71 g_string_free(writer_component
->base_path
, true);
72 g_string_free(writer_component
->trace_name_base
, true);
76 void writer_component_finalize(struct bt_private_component
*component
)
78 struct writer_component
*writer_component
= (struct writer_component
*)
79 bt_private_component_get_user_data(component
);
81 destroy_writer_component_data(writer_component
);
82 g_free(writer_component
);
86 void free_fs_writer(struct fs_writer
*fs_writer
)
88 bt_put(fs_writer
->writer
);
93 struct writer_component
*create_writer_component(void)
95 struct writer_component
*writer_component
;
97 writer_component
= g_new0(struct writer_component
, 1);
98 if (!writer_component
) {
102 writer_component
->err
= stderr
;
103 writer_component
->trace_id
= 0;
104 writer_component
->trace_name_base
= g_string_new("trace");
105 if (!writer_component
->trace_name_base
) {
106 g_free(writer_component
);
107 writer_component
= NULL
;
112 * Reader to writer corresponding structures.
114 writer_component
->trace_map
= g_hash_table_new_full(g_direct_hash
,
115 g_direct_equal
, NULL
, (GDestroyNotify
) free_fs_writer
);
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
= writer_output_event(writer_component
, event
);
172 if (ret
!= BT_COMPONENT_STATUS_OK
) {
177 case BT_NOTIFICATION_TYPE_STREAM_BEGIN
:
179 struct bt_ctf_stream
*stream
=
180 bt_notification_stream_begin_get_stream(notification
);
183 ret
= BT_COMPONENT_STATUS_ERROR
;
186 ret
= writer_stream_begin(writer_component
, stream
);
190 case BT_NOTIFICATION_TYPE_STREAM_END
:
192 struct bt_ctf_stream
*stream
=
193 bt_notification_stream_end_get_stream(notification
);
196 ret
= BT_COMPONENT_STATUS_ERROR
;
199 ret
= writer_stream_end(writer_component
, stream
);
204 puts("Unhandled notification type");
211 void writer_component_port_connected(
212 struct bt_private_component
*component
,
213 struct bt_private_port
*self_port
,
214 struct bt_port
*other_port
)
216 struct bt_private_connection
*connection
;
217 struct writer_component
*writer
;
218 enum bt_connection_status conn_status
;
219 static const enum bt_notification_type notif_types
[] = {
220 BT_NOTIFICATION_TYPE_EVENT
,
221 BT_NOTIFICATION_TYPE_PACKET_BEGIN
,
222 BT_NOTIFICATION_TYPE_PACKET_END
,
223 BT_NOTIFICATION_TYPE_STREAM_BEGIN
,
224 BT_NOTIFICATION_TYPE_STREAM_END
,
225 BT_NOTIFICATION_TYPE_SENTINEL
,
228 writer
= bt_private_component_get_user_data(component
);
230 assert(!writer
->input_iterator
);
231 connection
= bt_private_port_get_private_connection(self_port
);
233 conn_status
= bt_private_connection_create_notification_iterator(
234 connection
, notif_types
, &writer
->input_iterator
);
235 if (conn_status
!= BT_CONNECTION_STATUS_OK
) {
236 writer
->error
= true;
243 enum bt_component_status
writer_run(struct bt_private_component
*component
)
245 enum bt_component_status ret
;
246 struct bt_notification
*notification
= NULL
;
247 struct bt_notification_iterator
*it
;
248 struct writer_component
*writer_component
=
249 bt_private_component_get_user_data(component
);
250 enum bt_notification_iterator_status it_ret
;
252 if (unlikely(writer_component
->error
)) {
253 ret
= BT_COMPONENT_STATUS_ERROR
;
257 it
= writer_component
->input_iterator
;
259 it_ret
= bt_notification_iterator_next(it
);
262 case BT_NOTIFICATION_ITERATOR_STATUS_END
:
263 ret
= BT_COMPONENT_STATUS_END
;
264 BT_PUT(writer_component
->input_iterator
);
266 case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN
:
267 ret
= BT_COMPONENT_STATUS_AGAIN
;
269 case BT_NOTIFICATION_ITERATOR_STATUS_OK
:
272 ret
= BT_COMPONENT_STATUS_ERROR
;
276 notification
= bt_notification_iterator_get_notification(it
);
277 assert(notification
);
278 ret
= handle_notification(writer_component
, notification
);
280 bt_put(notification
);
285 enum bt_component_status
apply_one_bool(const char *key
,
286 struct bt_value
*params
,
290 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
291 struct bt_value
*value
= NULL
;
292 enum bt_value_status status
;
295 value
= bt_value_map_get(params
, key
);
299 status
= bt_value_bool_get(value
, &bool_val
);
300 if (status
!= BT_VALUE_STATUS_OK
) {
301 ret
= BT_COMPONENT_STATUS_ERROR
;
305 *option
= (bool) bool_val
;
315 enum bt_component_status
writer_component_init(
316 struct bt_private_component
*component
, struct bt_value
*params
,
317 UNUSED_VAR
void *init_method_data
)
319 enum bt_component_status ret
;
320 enum bt_value_status value_ret
;
321 struct writer_component
*writer_component
= create_writer_component();
322 struct bt_value
*value
= NULL
;
325 if (!writer_component
) {
326 ret
= BT_COMPONENT_STATUS_NOMEM
;
330 ret
= bt_private_component_sink_add_input_private_port(component
,
332 if (ret
!= BT_COMPONENT_STATUS_OK
) {
336 value
= bt_value_map_get(params
, "path");
337 if (!value
|| bt_value_is_null(value
) || !bt_value_is_string(value
)) {
338 fprintf(writer_component
->err
,
339 "[error] output path parameter required\n");
340 ret
= BT_COMPONENT_STATUS_INVALID
;
344 value_ret
= bt_value_string_get(value
, &path
);
345 if (value_ret
!= BT_VALUE_STATUS_OK
) {
346 ret
= BT_COMPONENT_STATUS_INVALID
;
351 writer_component
->base_path
= g_string_new(path
);
352 if (!writer_component
) {
353 ret
= BT_COMPONENT_STATUS_ERROR
;
357 writer_component
->single_trace
= false;
358 ret
= apply_one_bool("single-trace", params
,
359 &writer_component
->single_trace
, NULL
);
360 if (ret
!= BT_COMPONENT_STATUS_OK
) {
364 ret
= bt_private_component_set_user_data(component
, writer_component
);
365 if (ret
!= BT_COMPONENT_STATUS_OK
) {
372 destroy_writer_component_data(writer_component
);
373 g_free(writer_component
);