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>
45 LOGLEVEL_DEBUG_SYSTEM
= 7,
46 LOGLEVEL_DEBUG_PROGRAM
= 8,
47 LOGLEVEL_DEBUG_PROCESS
= 9,
48 LOGLEVEL_DEBUG_MODULE
= 10,
49 LOGLEVEL_DEBUG_UNIT
= 11,
50 LOGLEVEL_DEBUG_FUNCTION
= 12,
51 LOGLEVEL_DEBUG_LINE
= 13,
56 const char *loglevel_str
[] = {
57 [LOGLEVEL_EMERG
] = "TRACE_EMERG",
58 [LOGLEVEL_ALERT
] = "TRACE_ALERT",
59 [LOGLEVEL_CRIT
] = "TRACE_CRIT",
60 [LOGLEVEL_ERR
] = "TRACE_ERR",
61 [LOGLEVEL_WARNING
] = "TRACE_WARNING",
62 [LOGLEVEL_NOTICE
] = "TRACE_NOTICE",
63 [LOGLEVEL_INFO
] = "TRACE_INFO",
64 [LOGLEVEL_DEBUG_SYSTEM
] = "TRACE_DEBUG_SYSTEM",
65 [LOGLEVEL_DEBUG_PROGRAM
] = "TRACE_DEBUG_PROGRAM",
66 [LOGLEVEL_DEBUG_PROCESS
] = "TRACE_DEBUG_PROCESS",
67 [LOGLEVEL_DEBUG_MODULE
] = "TRACE_DEBUG_MODULE",
68 [LOGLEVEL_DEBUG_UNIT
] = "TRACE_DEBUG_UNIT",
69 [LOGLEVEL_DEBUG_FUNCTION
] = "TRACE_DEBUG_FUNCTION",
70 [LOGLEVEL_DEBUG_LINE
] = "TRACE_DEBUG_LINE",
71 [LOGLEVEL_DEBUG
] = "TRACE_DEBUG",
75 bool print_scope_field_names
: 1;
76 bool print_header_field_names
: 1;
77 bool print_context_field_names
: 1;
78 bool print_payload_field_names
: 1;
79 bool print_delta_field
: 1;
80 bool print_loglevel_field
: 1;
81 bool print_trace_field
: 1;
82 bool print_trace_domain_field
: 1;
83 bool print_trace_procname_field
: 1;
84 bool print_trace_vpid_field
: 1;
85 bool print_trace_hostname_field
: 1;
86 bool no_size_limit
: 1;
89 struct text_component
{
90 struct text_options options
;
95 struct text_component
*create_text(void)
97 return g_new0(struct text_component
, 1);
101 void destroy_text_data(struct text_component
*data
)
106 static void destroy_text(struct bt_component
*component
)
108 void *data
= bt_component_get_private_data(component
);
110 destroy_text_data(data
);
114 enum bt_component_status
handle_notification(struct bt_component
*component
,
115 struct bt_notification
*notification
)
117 switch (bt_notification_get_type(notification
)) {
118 case BT_NOTIFICATION_TYPE_PACKET_START
:
121 case BT_NOTIFICATION_TYPE_PACKET_END
:
124 case BT_NOTIFICATION_TYPE_EVENT
:
127 case BT_NOTIFICATION_TYPE_STREAM_END
:
131 puts("Unhandled notification type");
133 return BT_COMPONENT_STATUS_OK
;
137 enum bt_component_status
text_component_init(
138 struct bt_component
*component
, struct bt_value
*params
)
140 enum bt_component_status ret
;
141 struct text_component
*text
= create_text();
144 ret
= BT_COMPONENT_STATUS_NOMEM
;
148 ret
= bt_component_set_destroy_cb(component
,
150 if (ret
!= BT_COMPONENT_STATUS_OK
) {
154 ret
= bt_component_set_private_data(component
, text
);
155 if (ret
!= BT_COMPONENT_STATUS_OK
) {
159 ret
= bt_component_sink_set_handle_notification_cb(component
,
160 handle_notification
);
161 if (ret
!= BT_COMPONENT_STATUS_OK
) {
170 destroy_text_data(text
);
174 /* Initialize plug-in entry points. */
175 BT_PLUGIN_NAME("text");
176 BT_PLUGIN_DESCRIPTION("Babeltrace text output plug-in.");
177 BT_PLUGIN_AUTHOR("Jérémie Galarneau");
178 BT_PLUGIN_LICENSE("MIT");
180 BT_PLUGIN_COMPONENT_CLASSES_BEGIN
181 BT_PLUGIN_SINK_COMPONENT_CLASS_ENTRY("text", "Formats CTF-IR to text. Formerly known as ctf-text.", text_component_init
)
182 BT_PLUGIN_COMPONENT_CLASSES_END