Commit | Line | Data |
---|---|---|
7a278c8e | 1 | /* |
5dac767a | 2 | * text.c |
7a278c8e | 3 | * |
5dac767a | 4 | * Babeltrace CTF Text Output Plugin |
7a278c8e | 5 | * |
2e339de1 | 6 | * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
7a278c8e JG |
7 | * |
8 | * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
9 | * | |
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: | |
16 | * | |
17 | * The above copyright notice and this permission notice shall be included in | |
18 | * all copies or substantial portions of the Software. | |
19 | * | |
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 | |
26 | * SOFTWARE. | |
27 | */ | |
28 | ||
38b48196 | 29 | #include <babeltrace/plugin/plugin-macros.h> |
480dc8ed | 30 | #include <babeltrace/plugin/component.h> |
5dac767a | 31 | #include <babeltrace/plugin/sink.h> |
480dc8ed | 32 | #include <babeltrace/plugin/notification/notification.h> |
fec2a9f2 | 33 | #include <babeltrace/plugin/notification/iterator.h> |
541b0a11 | 34 | #include <babeltrace/plugin/notification/event.h> |
bfd20a42 | 35 | #include <stdio.h> |
39cfa40f | 36 | #include <stdbool.h> |
bac67f0f | 37 | #include <glib.h> |
541b0a11 | 38 | #include "text.h" |
6405967d | 39 | |
4647b93a | 40 | static |
6405967d | 41 | const char *loglevel_str [] = { |
480dc8ed JG |
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", | |
6405967d JG |
57 | }; |
58 | ||
bfd20a42 | 59 | static |
541b0a11 | 60 | void destroy_text_data(struct text_component *text) |
bac67f0f | 61 | { |
6a18b281 | 62 | (void) g_string_free(text->string, TRUE); |
541b0a11 | 63 | g_free(text); |
bac67f0f JG |
64 | } |
65 | ||
b25bd455 | 66 | static |
541b0a11 | 67 | struct text_component *create_text(void) |
bac67f0f | 68 | { |
541b0a11 JG |
69 | struct text_component *text; |
70 | ||
71 | text = g_new0(struct text_component, 1); | |
72 | if (!text) { | |
73 | goto end; | |
74 | } | |
6a18b281 MD |
75 | text->string = g_string_new(""); |
76 | if (!text->string) { | |
77 | goto error; | |
78 | } | |
541b0a11 JG |
79 | end: |
80 | return text; | |
6a18b281 MD |
81 | |
82 | error: | |
83 | g_free(text); | |
84 | return NULL; | |
bac67f0f JG |
85 | } |
86 | ||
fec2a9f2 JG |
87 | static |
88 | void destroy_text(struct bt_component *component) | |
b25bd455 JG |
89 | { |
90 | void *data = bt_component_get_private_data(component); | |
91 | ||
92 | destroy_text_data(data); | |
93 | } | |
94 | ||
bac67f0f | 95 | static |
fec2a9f2 | 96 | enum bt_component_status handle_notification(struct text_component *text, |
bac67f0f | 97 | struct bt_notification *notification) |
4c1456f0 | 98 | { |
541b0a11 | 99 | enum bt_component_status ret = BT_COMPONENT_STATUS_OK; |
541b0a11 JG |
100 | |
101 | if (!text) { | |
102 | ret = BT_COMPONENT_STATUS_ERROR; | |
103 | goto end; | |
104 | } | |
105 | ||
78586d8a JG |
106 | switch (bt_notification_get_type(notification)) { |
107 | case BT_NOTIFICATION_TYPE_PACKET_START: | |
108 | puts("<packet>"); | |
109 | break; | |
110 | case BT_NOTIFICATION_TYPE_PACKET_END: | |
111 | puts("</packet>"); | |
112 | break; | |
113 | case BT_NOTIFICATION_TYPE_EVENT: | |
541b0a11 JG |
114 | { |
115 | struct bt_ctf_event *event = bt_notification_event_get_event( | |
116 | notification); | |
117 | ||
541b0a11 JG |
118 | if (!event) { |
119 | ret = BT_COMPONENT_STATUS_ERROR; | |
120 | goto end; | |
121 | } | |
122 | ret = text_print_event(text, event); | |
fec2a9f2 | 123 | bt_put(event); |
541b0a11 JG |
124 | if (ret != BT_COMPONENT_STATUS_OK) { |
125 | goto end; | |
126 | } | |
043e2020 | 127 | break; |
541b0a11 | 128 | } |
043e2020 JG |
129 | case BT_NOTIFICATION_TYPE_STREAM_END: |
130 | puts("</stream>"); | |
78586d8a JG |
131 | break; |
132 | default: | |
133 | puts("Unhandled notification type"); | |
134 | } | |
541b0a11 JG |
135 | end: |
136 | return ret; | |
4c1456f0 | 137 | } |
bac67f0f | 138 | |
fec2a9f2 JG |
139 | static |
140 | enum bt_component_status run(struct bt_component *component) | |
141 | { | |
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); | |
146 | ||
147 | ret = bt_component_sink_get_input_iterator(component, 0, &it); | |
148 | if (ret != BT_COMPONENT_STATUS_OK) { | |
149 | goto end; | |
150 | } | |
151 | ||
152 | if (!text->processed_first_event) { | |
153 | ret = bt_notification_iterator_next(it); | |
154 | if (ret != BT_COMPONENT_STATUS_OK) { | |
155 | goto end; | |
156 | } | |
157 | } else { | |
158 | text->processed_first_event = true; | |
159 | } | |
160 | ||
161 | notification = bt_notification_iterator_get_notification(it); | |
162 | if (!notification) { | |
163 | ret = BT_COMPONENT_STATUS_ERROR; | |
164 | goto end; | |
165 | } | |
166 | ||
167 | ret = handle_notification(text, notification); | |
168 | end: | |
169 | bt_put(it); | |
170 | bt_put(notification); | |
171 | return ret; | |
172 | } | |
173 | ||
bac67f0f JG |
174 | static |
175 | enum bt_component_status text_component_init( | |
176 | struct bt_component *component, struct bt_value *params) | |
177 | { | |
178 | enum bt_component_status ret; | |
179 | struct text_component *text = create_text(); | |
180 | ||
181 | if (!text) { | |
182 | ret = BT_COMPONENT_STATUS_NOMEM; | |
183 | goto end; | |
184 | } | |
185 | ||
a97c4b1a | 186 | ret = bt_component_set_destroy_cb(component, |
e78cdc59 | 187 | destroy_text); |
bac67f0f JG |
188 | if (ret != BT_COMPONENT_STATUS_OK) { |
189 | goto error; | |
190 | } | |
191 | ||
192 | ret = bt_component_set_private_data(component, text); | |
193 | if (ret != BT_COMPONENT_STATUS_OK) { | |
194 | goto error; | |
195 | } | |
196 | ||
fec2a9f2 JG |
197 | ret = bt_component_sink_set_consume_cb(component, |
198 | run); | |
bac67f0f JG |
199 | if (ret != BT_COMPONENT_STATUS_OK) { |
200 | goto error; | |
201 | } | |
043e2020 JG |
202 | |
203 | text->out = stdout; | |
204 | text->err = stderr; | |
bac67f0f JG |
205 | end: |
206 | return ret; | |
207 | error: | |
b25bd455 | 208 | destroy_text_data(text); |
bac67f0f JG |
209 | return ret; |
210 | } | |
211 | ||
bac67f0f | 212 | /* Initialize plug-in entry points. */ |
56a1cced | 213 | BT_PLUGIN_NAME("text"); |
bac67f0f JG |
214 | BT_PLUGIN_DESCRIPTION("Babeltrace text output plug-in."); |
215 | BT_PLUGIN_AUTHOR("Jérémie Galarneau"); | |
216 | BT_PLUGIN_LICENSE("MIT"); | |
217 | ||
218 | BT_PLUGIN_COMPONENT_CLASSES_BEGIN | |
541b0a11 JG |
219 | BT_PLUGIN_SINK_COMPONENT_CLASS_ENTRY("text", |
220 | "Formats CTF-IR to text. Formerly known as ctf-text.", | |
221 | text_component_init) | |
bac67f0f | 222 | BT_PLUGIN_COMPONENT_CLASSES_END |