4 * Babeltrace CTF Text 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/plugin/plugin-macros.h>
30 #include <babeltrace/plugin/component.h>
31 #include <babeltrace/plugin/sink.h>
32 #include <babeltrace/plugin/notification/notification.h>
33 #include <babeltrace/plugin/notification/iterator.h>
34 #include <babeltrace/plugin/notification/event.h>
41 const char *loglevel_str
[] = {
42 [LOGLEVEL_EMERG
] = "TRACE_EMERG",
43 [LOGLEVEL_ALERT
] = "TRACE_ALERT",
44 [LOGLEVEL_CRIT
] = "TRACE_CRIT",
45 [LOGLEVEL_ERR
] = "TRACE_ERR",
46 [LOGLEVEL_WARNING
] = "TRACE_WARNING",
47 [LOGLEVEL_NOTICE
] = "TRACE_NOTICE",
48 [LOGLEVEL_INFO
] = "TRACE_INFO",
49 [LOGLEVEL_DEBUG_SYSTEM
] = "TRACE_DEBUG_SYSTEM",
50 [LOGLEVEL_DEBUG_PROGRAM
] = "TRACE_DEBUG_PROGRAM",
51 [LOGLEVEL_DEBUG_PROCESS
] = "TRACE_DEBUG_PROCESS",
52 [LOGLEVEL_DEBUG_MODULE
] = "TRACE_DEBUG_MODULE",
53 [LOGLEVEL_DEBUG_UNIT
] = "TRACE_DEBUG_UNIT",
54 [LOGLEVEL_DEBUG_FUNCTION
] = "TRACE_DEBUG_FUNCTION",
55 [LOGLEVEL_DEBUG_LINE
] = "TRACE_DEBUG_LINE",
56 [LOGLEVEL_DEBUG
] = "TRACE_DEBUG",
60 void destroy_text_data(struct text_component
*text
)
62 (void) g_string_free(text
->string
, TRUE
);
67 struct text_component
*create_text(void)
69 struct text_component
*text
;
71 text
= g_new0(struct text_component
, 1);
75 text
->string
= g_string_new("");
88 void destroy_text(struct bt_component
*component
)
90 void *data
= bt_component_get_private_data(component
);
92 destroy_text_data(data
);
96 enum bt_component_status
handle_notification(struct text_component
*text
,
97 struct bt_notification
*notification
)
99 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
102 ret
= BT_COMPONENT_STATUS_ERROR
;
106 switch (bt_notification_get_type(notification
)) {
107 case BT_NOTIFICATION_TYPE_PACKET_START
:
110 case BT_NOTIFICATION_TYPE_PACKET_END
:
113 case BT_NOTIFICATION_TYPE_EVENT
:
115 struct bt_ctf_event
*event
= bt_notification_event_get_event(
119 ret
= BT_COMPONENT_STATUS_ERROR
;
122 ret
= text_print_event(text
, event
);
124 if (ret
!= BT_COMPONENT_STATUS_OK
) {
129 case BT_NOTIFICATION_TYPE_STREAM_END
:
133 puts("Unhandled notification type");
140 enum bt_component_status
run(struct bt_component
*component
)
142 enum bt_component_status ret
;
143 struct bt_notification
*notification
= NULL
;
144 struct bt_notification_iterator
*it
;
145 struct text_component
*text
= bt_component_get_private_data(component
);
147 ret
= bt_component_sink_get_input_iterator(component
, 0, &it
);
148 if (ret
!= BT_COMPONENT_STATUS_OK
) {
152 if (!text
->processed_first_event
) {
153 ret
= bt_notification_iterator_next(it
);
154 if (ret
!= BT_COMPONENT_STATUS_OK
) {
158 text
->processed_first_event
= true;
161 notification
= bt_notification_iterator_get_notification(it
);
163 ret
= BT_COMPONENT_STATUS_ERROR
;
167 ret
= handle_notification(text
, notification
);
170 bt_put(notification
);
175 enum bt_component_status
text_component_init(
176 struct bt_component
*component
, struct bt_value
*params
)
178 enum bt_component_status ret
;
179 struct text_component
*text
= create_text();
182 ret
= BT_COMPONENT_STATUS_NOMEM
;
186 ret
= bt_component_set_destroy_cb(component
,
188 if (ret
!= BT_COMPONENT_STATUS_OK
) {
192 ret
= bt_component_set_private_data(component
, text
);
193 if (ret
!= BT_COMPONENT_STATUS_OK
) {
197 ret
= bt_component_sink_set_consume_cb(component
,
199 if (ret
!= BT_COMPONENT_STATUS_OK
) {
208 destroy_text_data(text
);
212 /* Initialize plug-in entry points. */
213 BT_PLUGIN_NAME("text");
214 BT_PLUGIN_DESCRIPTION("Babeltrace text output plug-in.");
215 BT_PLUGIN_AUTHOR("Jérémie Galarneau");
216 BT_PLUGIN_LICENSE("MIT");
218 BT_PLUGIN_COMPONENT_CLASSES_BEGIN
219 BT_PLUGIN_SINK_COMPONENT_CLASS_ENTRY("text",
220 "Formats CTF-IR to text. Formerly known as ctf-text.",
222 BT_PLUGIN_COMPONENT_CLASSES_END