Commit | Line | Data |
---|---|---|
7a278c8e | 1 | /* |
3228cc1d | 2 | * pretty.c |
7a278c8e | 3 | * |
5dac767a | 4 | * Babeltrace CTF Text Output Plugin |
7a278c8e | 5 | * |
2e339de1 | 6 | * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
f504043c | 7 | * Copyright 2016 Mathieu Desnoyers <mathieu.desnoyers@efficios.com> |
7a278c8e JG |
8 | * |
9 | * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
10 | * | |
11 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
12 | * of this software and associated documentation files (the "Software"), to deal | |
13 | * in the Software without restriction, including without limitation the rights | |
14 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
15 | * copies of the Software, and to permit persons to whom the Software is | |
16 | * furnished to do so, subject to the following conditions: | |
17 | * | |
18 | * The above copyright notice and this permission notice shall be included in | |
19 | * all copies or substantial portions of the Software. | |
20 | * | |
21 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
22 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
23 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
24 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
25 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
26 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
27 | * SOFTWARE. | |
28 | */ | |
29 | ||
33b34c43 | 30 | #include <babeltrace/plugin/plugin-dev.h> |
b2e0c907 PP |
31 | #include <babeltrace/graph/component.h> |
32 | #include <babeltrace/graph/private-component.h> | |
b9d103be | 33 | #include <babeltrace/graph/private-component-sink.h> |
b2e0c907 PP |
34 | #include <babeltrace/graph/component-sink.h> |
35 | #include <babeltrace/graph/port.h> | |
36 | #include <babeltrace/graph/private-port.h> | |
37 | #include <babeltrace/graph/connection.h> | |
38 | #include <babeltrace/graph/private-connection.h> | |
39 | #include <babeltrace/graph/notification.h> | |
40 | #include <babeltrace/graph/notification-iterator.h> | |
41 | #include <babeltrace/graph/notification-event.h> | |
6e1bc0df | 42 | #include <babeltrace/values.h> |
3d9990ac | 43 | #include <babeltrace/compiler-internal.h> |
ad96d936 | 44 | #include <babeltrace/common-internal.h> |
7d61fa8e | 45 | #include <plugins-common.h> |
bfd20a42 | 46 | #include <stdio.h> |
39cfa40f | 47 | #include <stdbool.h> |
bac67f0f | 48 | #include <glib.h> |
75e1829b | 49 | #include <assert.h> |
6405967d | 50 | |
3228cc1d PP |
51 | #include "pretty.h" |
52 | ||
61d6f9b1 MJ |
53 | GQuark stream_packet_context_quarks[STREAM_PACKET_CONTEXT_QUARKS_LEN]; |
54 | ||
6e1bc0df MD |
55 | static |
56 | const char *plugin_options[] = { | |
ad96d936 | 57 | "color", |
a0ad501b | 58 | "path", |
6e1bc0df MD |
59 | "no-delta", |
60 | "clock-cycles", | |
61 | "clock-seconds", | |
62 | "clock-date", | |
63 | "clock-gmt", | |
a263021c | 64 | "verbose", |
6e1bc0df MD |
65 | "name-default", /* show/hide */ |
66 | "name-payload", | |
67 | "name-context", | |
68 | "name-scope", | |
69 | "name-header", | |
70 | "field-default", /* show/hide */ | |
71 | "field-trace", | |
72 | "field-trace:hostname", | |
73 | "field-trace:domain", | |
74 | "field-trace:procname", | |
75 | "field-trace:vpid", | |
76 | "field-loglevel", | |
77 | "field-emf", | |
60535549 | 78 | "field-callsite", |
6e1bc0df MD |
79 | }; |
80 | ||
bfd20a42 | 81 | static |
3228cc1d | 82 | void destroy_pretty_data(struct pretty_component *pretty) |
bac67f0f | 83 | { |
3228cc1d | 84 | bt_put(pretty->input_iterator); |
5280f742 PP |
85 | |
86 | if (pretty->string) { | |
87 | (void) g_string_free(pretty->string, TRUE); | |
88 | } | |
89 | ||
90 | if (pretty->tmp_string) { | |
91 | (void) g_string_free(pretty->tmp_string, TRUE); | |
92 | } | |
93 | ||
3228cc1d | 94 | if (pretty->out != stdout) { |
77986bad JD |
95 | int ret; |
96 | ||
3228cc1d | 97 | ret = fclose(pretty->out); |
77986bad JD |
98 | if (ret) { |
99 | perror("close output file"); | |
100 | } | |
101 | } | |
3228cc1d | 102 | g_free(pretty->options.output_path); |
3228cc1d | 103 | g_free(pretty); |
bac67f0f JG |
104 | } |
105 | ||
b25bd455 | 106 | static |
3228cc1d | 107 | struct pretty_component *create_pretty(void) |
bac67f0f | 108 | { |
3228cc1d | 109 | struct pretty_component *pretty; |
541b0a11 | 110 | |
3228cc1d PP |
111 | pretty = g_new0(struct pretty_component, 1); |
112 | if (!pretty) { | |
541b0a11 JG |
113 | goto end; |
114 | } | |
3228cc1d PP |
115 | pretty->string = g_string_new(""); |
116 | if (!pretty->string) { | |
6a18b281 MD |
117 | goto error; |
118 | } | |
5280f742 PP |
119 | pretty->tmp_string = g_string_new(""); |
120 | if (!pretty->tmp_string) { | |
121 | goto error; | |
122 | } | |
541b0a11 | 123 | end: |
3228cc1d | 124 | return pretty; |
6a18b281 MD |
125 | |
126 | error: | |
3228cc1d | 127 | g_free(pretty); |
6a18b281 | 128 | return NULL; |
bac67f0f JG |
129 | } |
130 | ||
3228cc1d PP |
131 | BT_HIDDEN |
132 | void pretty_finalize(struct bt_private_component *component) | |
b25bd455 | 133 | { |
890882ef | 134 | void *data = bt_private_component_get_user_data(component); |
b25bd455 | 135 | |
3228cc1d | 136 | destroy_pretty_data(data); |
b25bd455 JG |
137 | } |
138 | ||
bac67f0f | 139 | static |
3228cc1d | 140 | enum bt_component_status handle_notification(struct pretty_component *pretty, |
6e1bc0df | 141 | struct bt_notification *notification) |
4c1456f0 | 142 | { |
541b0a11 | 143 | enum bt_component_status ret = BT_COMPONENT_STATUS_OK; |
541b0a11 | 144 | |
b5e978f4 | 145 | assert(pretty); |
541b0a11 | 146 | |
7cdc2bab MD |
147 | switch (bt_notification_get_type(notification)) { |
148 | case BT_NOTIFICATION_TYPE_EVENT: | |
d9f65f09 | 149 | ret = pretty_print_event(pretty, notification); |
7cdc2bab MD |
150 | break; |
151 | case BT_NOTIFICATION_TYPE_INACTIVITY: | |
152 | fprintf(stderr, "Inactivity notification\n"); | |
153 | break; | |
154 | case BT_NOTIFICATION_TYPE_PACKET_BEGIN: | |
155 | case BT_NOTIFICATION_TYPE_PACKET_END: | |
156 | case BT_NOTIFICATION_TYPE_STREAM_BEGIN: | |
157 | case BT_NOTIFICATION_TYPE_STREAM_END: | |
158 | break; | |
08899d39 PP |
159 | case BT_NOTIFICATION_TYPE_DISCARDED_PACKETS: |
160 | case BT_NOTIFICATION_TYPE_DISCARDED_EVENTS: | |
161 | ret = pretty_print_discarded_elements(pretty, notification); | |
162 | break; | |
7cdc2bab MD |
163 | default: |
164 | fprintf(stderr, "Unhandled notification type\n"); | |
78586d8a | 165 | } |
b5e978f4 | 166 | |
541b0a11 | 167 | return ret; |
4c1456f0 | 168 | } |
bac67f0f | 169 | |
3228cc1d | 170 | BT_HIDDEN |
0d8b4d8e | 171 | void pretty_port_connected( |
890882ef | 172 | struct bt_private_component *component, |
8f4799f7 PP |
173 | struct bt_private_port *self_port, |
174 | struct bt_port *other_port) | |
75e1829b | 175 | { |
73d5c1ad | 176 | enum bt_connection_status conn_status; |
890882ef | 177 | struct bt_private_connection *connection; |
3228cc1d | 178 | struct pretty_component *pretty; |
fa054faf PP |
179 | static const enum bt_notification_type notif_types[] = { |
180 | BT_NOTIFICATION_TYPE_EVENT, | |
08899d39 PP |
181 | BT_NOTIFICATION_TYPE_DISCARDED_PACKETS, |
182 | BT_NOTIFICATION_TYPE_DISCARDED_EVENTS, | |
fa054faf PP |
183 | BT_NOTIFICATION_TYPE_SENTINEL, |
184 | }; | |
75e1829b | 185 | |
3228cc1d PP |
186 | pretty = bt_private_component_get_user_data(component); |
187 | assert(pretty); | |
188 | assert(!pretty->input_iterator); | |
890882ef | 189 | connection = bt_private_port_get_private_connection(self_port); |
72b913fb | 190 | assert(connection); |
73d5c1ad PP |
191 | conn_status = bt_private_connection_create_notification_iterator( |
192 | connection, notif_types, &pretty->input_iterator); | |
193 | if (conn_status != BT_CONNECTION_STATUS_OK) { | |
0d8b4d8e | 194 | pretty->error = true; |
75e1829b | 195 | } |
72b913fb PP |
196 | |
197 | bt_put(connection); | |
75e1829b JG |
198 | } |
199 | ||
3228cc1d PP |
200 | BT_HIDDEN |
201 | enum bt_component_status pretty_consume(struct bt_private_component *component) | |
fec2a9f2 JG |
202 | { |
203 | enum bt_component_status ret; | |
204 | struct bt_notification *notification = NULL; | |
205 | struct bt_notification_iterator *it; | |
3228cc1d | 206 | struct pretty_component *pretty = |
890882ef | 207 | bt_private_component_get_user_data(component); |
41a2b7ae | 208 | enum bt_notification_iterator_status it_ret; |
fec2a9f2 | 209 | |
0d8b4d8e PP |
210 | if (unlikely(pretty->error)) { |
211 | ret = BT_COMPONENT_STATUS_ERROR; | |
212 | goto end; | |
213 | } | |
fec2a9f2 | 214 | |
0d8b4d8e | 215 | it = pretty->input_iterator; |
41a2b7ae | 216 | it_ret = bt_notification_iterator_next(it); |
0d8b4d8e | 217 | |
41a2b7ae | 218 | switch (it_ret) { |
41a2b7ae PP |
219 | case BT_NOTIFICATION_ITERATOR_STATUS_END: |
220 | ret = BT_COMPONENT_STATUS_END; | |
3228cc1d | 221 | BT_PUT(pretty->input_iterator); |
41a2b7ae | 222 | goto end; |
dfa6653c PP |
223 | case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN: |
224 | ret = BT_COMPONENT_STATUS_AGAIN; | |
225 | goto end; | |
226 | case BT_NOTIFICATION_ITERATOR_STATUS_OK: | |
41a2b7ae | 227 | break; |
dfa6653c PP |
228 | default: |
229 | ret = BT_COMPONENT_STATUS_ERROR; | |
230 | goto end; | |
fec2a9f2 JG |
231 | } |
232 | ||
41a2b7ae PP |
233 | notification = bt_notification_iterator_get_notification(it); |
234 | assert(notification); | |
3228cc1d | 235 | ret = handle_notification(pretty, notification); |
dfa6653c | 236 | |
fec2a9f2 | 237 | end: |
fec2a9f2 JG |
238 | bt_put(notification); |
239 | return ret; | |
240 | } | |
241 | ||
6e1bc0df MD |
242 | static |
243 | enum bt_component_status add_params_to_map(struct bt_value *plugin_opt_map) | |
244 | { | |
245 | enum bt_component_status ret = BT_COMPONENT_STATUS_OK; | |
246 | unsigned int i; | |
247 | ||
248 | for (i = 0; i < BT_ARRAY_SIZE(plugin_options); i++) { | |
249 | const char *key = plugin_options[i]; | |
250 | enum bt_value_status status; | |
251 | ||
252 | status = bt_value_map_insert(plugin_opt_map, key, bt_value_null); | |
253 | switch (status) { | |
254 | case BT_VALUE_STATUS_OK: | |
255 | break; | |
256 | default: | |
257 | ret = BT_COMPONENT_STATUS_ERROR; | |
258 | goto end; | |
259 | } | |
260 | } | |
261 | end: | |
262 | return ret; | |
263 | } | |
264 | ||
265 | static | |
c55a9f58 | 266 | bt_bool check_param_exists(const char *key, struct bt_value *object, void *data) |
6e1bc0df | 267 | { |
3228cc1d PP |
268 | struct pretty_component *pretty = data; |
269 | struct bt_value *plugin_opt_map = pretty->plugin_opt_map; | |
6e1bc0df MD |
270 | |
271 | if (!bt_value_map_get(plugin_opt_map, key)) { | |
3228cc1d PP |
272 | fprintf(pretty->err, |
273 | "[warning] Parameter \"%s\" unknown to \"text.pretty\" sink component\n", key); | |
6e1bc0df | 274 | } |
c55a9f58 | 275 | return BT_TRUE; |
6e1bc0df MD |
276 | } |
277 | ||
278 | static | |
279 | enum bt_component_status apply_one_string(const char *key, | |
280 | struct bt_value *params, | |
281 | char **option) | |
282 | { | |
283 | enum bt_component_status ret = BT_COMPONENT_STATUS_OK; | |
284 | struct bt_value *value = NULL; | |
285 | enum bt_value_status status; | |
286 | const char *str; | |
287 | ||
288 | value = bt_value_map_get(params, key); | |
289 | if (!value) { | |
290 | goto end; | |
291 | } | |
292 | if (bt_value_is_null(value)) { | |
293 | goto end; | |
294 | } | |
295 | status = bt_value_string_get(value, &str); | |
296 | switch (status) { | |
297 | case BT_VALUE_STATUS_OK: | |
298 | break; | |
299 | default: | |
300 | ret = BT_COMPONENT_STATUS_ERROR; | |
301 | goto end; | |
302 | } | |
303 | *option = g_strdup(str); | |
304 | end: | |
305 | bt_put(value); | |
306 | return ret; | |
307 | } | |
308 | ||
309 | static | |
310 | enum bt_component_status apply_one_bool(const char *key, | |
311 | struct bt_value *params, | |
312 | bool *option, | |
313 | bool *found) | |
314 | { | |
315 | enum bt_component_status ret = BT_COMPONENT_STATUS_OK; | |
316 | struct bt_value *value = NULL; | |
317 | enum bt_value_status status; | |
c55a9f58 | 318 | bt_bool bool_val; |
6e1bc0df MD |
319 | |
320 | value = bt_value_map_get(params, key); | |
321 | if (!value) { | |
322 | goto end; | |
323 | } | |
c55a9f58 | 324 | status = bt_value_bool_get(value, &bool_val); |
6e1bc0df MD |
325 | switch (status) { |
326 | case BT_VALUE_STATUS_OK: | |
327 | break; | |
328 | default: | |
329 | ret = BT_COMPONENT_STATUS_ERROR; | |
330 | goto end; | |
331 | } | |
c55a9f58 | 332 | *option = (bool) bool_val; |
6e1bc0df MD |
333 | if (found) { |
334 | *found = true; | |
335 | } | |
336 | end: | |
337 | bt_put(value); | |
338 | return ret; | |
339 | } | |
340 | ||
ad96d936 | 341 | static |
3228cc1d | 342 | void warn_wrong_color_param(struct pretty_component *pretty) |
ad96d936 | 343 | { |
3228cc1d | 344 | fprintf(pretty->err, |
ad96d936 PP |
345 | "[warning] Accepted values for the \"color\" parameter are:\n \"always\", \"auto\", \"never\"\n"); |
346 | } | |
347 | ||
77986bad | 348 | static |
3228cc1d | 349 | enum bt_component_status open_output_file(struct pretty_component *pretty) |
77986bad JD |
350 | { |
351 | enum bt_component_status ret = BT_COMPONENT_STATUS_OK; | |
352 | ||
3228cc1d | 353 | if (!pretty->options.output_path) { |
77986bad JD |
354 | goto end; |
355 | } | |
356 | ||
3228cc1d PP |
357 | pretty->out = fopen(pretty->options.output_path, "w"); |
358 | if (!pretty->out) { | |
77986bad JD |
359 | goto error; |
360 | } | |
361 | ||
362 | goto end; | |
363 | ||
364 | error: | |
365 | ret = BT_COMPONENT_STATUS_ERROR; | |
366 | end: | |
367 | return ret; | |
368 | } | |
369 | ||
6e1bc0df | 370 | static |
3228cc1d | 371 | enum bt_component_status apply_params(struct pretty_component *pretty, |
6e1bc0df MD |
372 | struct bt_value *params) |
373 | { | |
374 | enum bt_component_status ret = BT_COMPONENT_STATUS_OK; | |
375 | enum bt_value_status status; | |
376 | bool value, found; | |
377 | char *str = NULL; | |
378 | ||
3228cc1d PP |
379 | pretty->plugin_opt_map = bt_value_map_create(); |
380 | if (!pretty->plugin_opt_map) { | |
6e1bc0df MD |
381 | ret = BT_COMPONENT_STATUS_ERROR; |
382 | goto end; | |
383 | } | |
3228cc1d | 384 | ret = add_params_to_map(pretty->plugin_opt_map); |
6e1bc0df MD |
385 | if (ret != BT_COMPONENT_STATUS_OK) { |
386 | goto end; | |
387 | } | |
388 | /* Report unknown parameters. */ | |
3228cc1d | 389 | status = bt_value_map_foreach(params, check_param_exists, pretty); |
6e1bc0df MD |
390 | switch (status) { |
391 | case BT_VALUE_STATUS_OK: | |
392 | break; | |
393 | default: | |
394 | ret = BT_COMPONENT_STATUS_ERROR; | |
395 | goto end; | |
396 | } | |
397 | /* Known parameters. */ | |
3228cc1d | 398 | pretty->options.color = PRETTY_COLOR_OPT_AUTO; |
ad96d936 PP |
399 | if (bt_value_map_has_key(params, "color")) { |
400 | struct bt_value *color_value; | |
401 | const char *color; | |
402 | ||
403 | color_value = bt_value_map_get(params, "color"); | |
404 | if (!color_value) { | |
405 | goto end; | |
406 | } | |
407 | ||
72b913fb PP |
408 | status = bt_value_string_get(color_value, &color); |
409 | if (status) { | |
3228cc1d | 410 | warn_wrong_color_param(pretty); |
ad96d936 PP |
411 | } else { |
412 | if (strcmp(color, "never") == 0) { | |
3228cc1d | 413 | pretty->options.color = PRETTY_COLOR_OPT_NEVER; |
ad96d936 | 414 | } else if (strcmp(color, "auto") == 0) { |
3228cc1d | 415 | pretty->options.color = PRETTY_COLOR_OPT_AUTO; |
ad96d936 | 416 | } else if (strcmp(color, "always") == 0) { |
3228cc1d | 417 | pretty->options.color = PRETTY_COLOR_OPT_ALWAYS; |
ad96d936 | 418 | } else { |
3228cc1d | 419 | warn_wrong_color_param(pretty); |
ad96d936 PP |
420 | } |
421 | } | |
422 | ||
423 | bt_put(color_value); | |
424 | } | |
425 | ||
a0ad501b | 426 | ret = apply_one_string("path", params, &pretty->options.output_path); |
6e1bc0df MD |
427 | if (ret != BT_COMPONENT_STATUS_OK) { |
428 | goto end; | |
429 | } | |
3228cc1d | 430 | ret = open_output_file(pretty); |
77986bad JD |
431 | if (ret != BT_COMPONENT_STATUS_OK) { |
432 | goto end; | |
433 | } | |
6e1bc0df | 434 | |
6e1bc0df MD |
435 | value = false; /* Default. */ |
436 | ret = apply_one_bool("no-delta", params, &value, NULL); | |
437 | if (ret != BT_COMPONENT_STATUS_OK) { | |
438 | goto end; | |
439 | } | |
3228cc1d | 440 | pretty->options.print_delta_field = !value; /* Reverse logic. */ |
6e1bc0df MD |
441 | |
442 | value = false; /* Default. */ | |
443 | ret = apply_one_bool("clock-cycles", params, &value, NULL); | |
444 | if (ret != BT_COMPONENT_STATUS_OK) { | |
445 | goto end; | |
446 | } | |
3228cc1d | 447 | pretty->options.print_timestamp_cycles = value; |
6e1bc0df MD |
448 | |
449 | value = false; /* Default. */ | |
450 | ret = apply_one_bool("clock-seconds", params, &value, NULL); | |
451 | if (ret != BT_COMPONENT_STATUS_OK) { | |
452 | goto end; | |
453 | } | |
3228cc1d | 454 | pretty->options.clock_seconds = value; |
6e1bc0df MD |
455 | |
456 | value = false; /* Default. */ | |
457 | ret = apply_one_bool("clock-date", params, &value, NULL); | |
458 | if (ret != BT_COMPONENT_STATUS_OK) { | |
459 | goto end; | |
460 | } | |
3228cc1d | 461 | pretty->options.clock_date = value; |
6e1bc0df MD |
462 | |
463 | value = false; /* Default. */ | |
464 | ret = apply_one_bool("clock-gmt", params, &value, NULL); | |
465 | if (ret != BT_COMPONENT_STATUS_OK) { | |
466 | goto end; | |
467 | } | |
3228cc1d | 468 | pretty->options.clock_gmt = value; |
6e1bc0df | 469 | |
a263021c JD |
470 | value = false; /* Default. */ |
471 | ret = apply_one_bool("verbose", params, &value, NULL); | |
472 | if (ret != BT_COMPONENT_STATUS_OK) { | |
473 | goto end; | |
474 | } | |
3228cc1d | 475 | pretty->options.verbose = value; |
a263021c | 476 | |
6e1bc0df MD |
477 | /* Names. */ |
478 | ret = apply_one_string("name-default", params, &str); | |
479 | if (ret != BT_COMPONENT_STATUS_OK) { | |
480 | goto end; | |
481 | } | |
482 | if (!str) { | |
3228cc1d | 483 | pretty->options.name_default = PRETTY_DEFAULT_UNSET; |
6e1bc0df | 484 | } else if (!strcmp(str, "show")) { |
3228cc1d | 485 | pretty->options.name_default = PRETTY_DEFAULT_SHOW; |
6e1bc0df | 486 | } else if (!strcmp(str, "hide")) { |
3228cc1d | 487 | pretty->options.name_default = PRETTY_DEFAULT_HIDE; |
6e1bc0df MD |
488 | } else { |
489 | ret = BT_COMPONENT_STATUS_ERROR; | |
490 | goto end; | |
491 | } | |
492 | g_free(str); | |
493 | str = NULL; | |
494 | ||
3228cc1d PP |
495 | switch (pretty->options.name_default) { |
496 | case PRETTY_DEFAULT_UNSET: | |
497 | pretty->options.print_payload_field_names = true; | |
498 | pretty->options.print_context_field_names = true; | |
499 | pretty->options.print_header_field_names = false; | |
500 | pretty->options.print_scope_field_names = false; | |
6e1bc0df | 501 | break; |
3228cc1d PP |
502 | case PRETTY_DEFAULT_SHOW: |
503 | pretty->options.print_payload_field_names = true; | |
504 | pretty->options.print_context_field_names = true; | |
505 | pretty->options.print_header_field_names = true; | |
506 | pretty->options.print_scope_field_names = true; | |
6e1bc0df | 507 | break; |
3228cc1d PP |
508 | case PRETTY_DEFAULT_HIDE: |
509 | pretty->options.print_payload_field_names = false; | |
510 | pretty->options.print_context_field_names = false; | |
511 | pretty->options.print_header_field_names = false; | |
512 | pretty->options.print_scope_field_names = false; | |
6e1bc0df MD |
513 | break; |
514 | default: | |
515 | ret = BT_COMPONENT_STATUS_ERROR; | |
516 | goto end; | |
517 | } | |
518 | ||
519 | value = false; | |
520 | found = false; | |
521 | ret = apply_one_bool("name-payload", params, &value, &found); | |
522 | if (ret != BT_COMPONENT_STATUS_OK) { | |
523 | goto end; | |
524 | } | |
525 | if (found) { | |
3228cc1d | 526 | pretty->options.print_payload_field_names = value; |
6e1bc0df MD |
527 | } |
528 | ||
529 | value = false; | |
530 | found = false; | |
531 | ret = apply_one_bool("name-context", params, &value, &found); | |
532 | if (ret != BT_COMPONENT_STATUS_OK) { | |
533 | goto end; | |
534 | } | |
535 | if (found) { | |
3228cc1d | 536 | pretty->options.print_context_field_names = value; |
6e1bc0df MD |
537 | } |
538 | ||
539 | value = false; | |
540 | found = false; | |
541 | ret = apply_one_bool("name-header", params, &value, &found); | |
542 | if (ret != BT_COMPONENT_STATUS_OK) { | |
543 | goto end; | |
544 | } | |
545 | if (found) { | |
3228cc1d | 546 | pretty->options.print_header_field_names = value; |
6e1bc0df MD |
547 | } |
548 | ||
549 | value = false; | |
550 | found = false; | |
551 | ret = apply_one_bool("name-scope", params, &value, &found); | |
552 | if (ret != BT_COMPONENT_STATUS_OK) { | |
553 | goto end; | |
554 | } | |
555 | if (found) { | |
3228cc1d | 556 | pretty->options.print_scope_field_names = value; |
6e1bc0df MD |
557 | } |
558 | ||
559 | /* Fields. */ | |
560 | ret = apply_one_string("field-default", params, &str); | |
561 | if (ret != BT_COMPONENT_STATUS_OK) { | |
562 | goto end; | |
563 | } | |
564 | if (!str) { | |
3228cc1d | 565 | pretty->options.field_default = PRETTY_DEFAULT_UNSET; |
6e1bc0df | 566 | } else if (!strcmp(str, "show")) { |
3228cc1d | 567 | pretty->options.field_default = PRETTY_DEFAULT_SHOW; |
6e1bc0df | 568 | } else if (!strcmp(str, "hide")) { |
3228cc1d | 569 | pretty->options.field_default = PRETTY_DEFAULT_HIDE; |
6e1bc0df MD |
570 | } else { |
571 | ret = BT_COMPONENT_STATUS_ERROR; | |
572 | goto end; | |
573 | } | |
574 | g_free(str); | |
575 | str = NULL; | |
576 | ||
3228cc1d PP |
577 | switch (pretty->options.field_default) { |
578 | case PRETTY_DEFAULT_UNSET: | |
579 | pretty->options.print_trace_field = false; | |
580 | pretty->options.print_trace_hostname_field = true; | |
581 | pretty->options.print_trace_domain_field = false; | |
582 | pretty->options.print_trace_procname_field = true; | |
583 | pretty->options.print_trace_vpid_field = true; | |
584 | pretty->options.print_loglevel_field = false; | |
585 | pretty->options.print_emf_field = false; | |
586 | pretty->options.print_callsite_field = false; | |
6e1bc0df | 587 | break; |
3228cc1d PP |
588 | case PRETTY_DEFAULT_SHOW: |
589 | pretty->options.print_trace_field = true; | |
590 | pretty->options.print_trace_hostname_field = true; | |
591 | pretty->options.print_trace_domain_field = true; | |
592 | pretty->options.print_trace_procname_field = true; | |
593 | pretty->options.print_trace_vpid_field = true; | |
594 | pretty->options.print_loglevel_field = true; | |
595 | pretty->options.print_emf_field = true; | |
596 | pretty->options.print_callsite_field = true; | |
6e1bc0df | 597 | break; |
3228cc1d PP |
598 | case PRETTY_DEFAULT_HIDE: |
599 | pretty->options.print_trace_field = false; | |
600 | pretty->options.print_trace_hostname_field = false; | |
601 | pretty->options.print_trace_domain_field = false; | |
602 | pretty->options.print_trace_procname_field = false; | |
603 | pretty->options.print_trace_vpid_field = false; | |
604 | pretty->options.print_loglevel_field = false; | |
605 | pretty->options.print_emf_field = false; | |
606 | pretty->options.print_callsite_field = false; | |
6e1bc0df MD |
607 | break; |
608 | default: | |
609 | ret = BT_COMPONENT_STATUS_ERROR; | |
610 | goto end; | |
611 | } | |
612 | ||
613 | value = false; | |
614 | found = false; | |
615 | ret = apply_one_bool("field-trace", params, &value, &found); | |
616 | if (ret != BT_COMPONENT_STATUS_OK) { | |
617 | goto end; | |
618 | } | |
619 | if (found) { | |
3228cc1d | 620 | pretty->options.print_trace_field = value; |
6e1bc0df MD |
621 | } |
622 | ||
623 | value = false; | |
624 | found = false; | |
625 | ret = apply_one_bool("field-trace:hostname", params, &value, &found); | |
626 | if (ret != BT_COMPONENT_STATUS_OK) { | |
627 | goto end; | |
628 | } | |
629 | if (found) { | |
3228cc1d | 630 | pretty->options.print_trace_hostname_field = value; |
6e1bc0df MD |
631 | } |
632 | ||
633 | value = false; | |
634 | found = false; | |
635 | ret = apply_one_bool("field-trace:domain", params, &value, &found); | |
636 | if (ret != BT_COMPONENT_STATUS_OK) { | |
637 | goto end; | |
638 | } | |
639 | if (found) { | |
3228cc1d | 640 | pretty->options.print_trace_domain_field = value; |
6e1bc0df MD |
641 | } |
642 | ||
643 | value = false; | |
644 | found = false; | |
645 | ret = apply_one_bool("field-trace:procname", params, &value, &found); | |
646 | if (ret != BT_COMPONENT_STATUS_OK) { | |
647 | goto end; | |
648 | } | |
649 | if (found) { | |
3228cc1d | 650 | pretty->options.print_trace_procname_field = value; |
6e1bc0df MD |
651 | } |
652 | ||
653 | value = false; | |
654 | found = false; | |
655 | ret = apply_one_bool("field-trace:vpid", params, &value, &found); | |
656 | if (ret != BT_COMPONENT_STATUS_OK) { | |
657 | goto end; | |
658 | } | |
659 | if (found) { | |
3228cc1d | 660 | pretty->options.print_trace_vpid_field = value; |
6e1bc0df MD |
661 | } |
662 | ||
663 | value = false; | |
664 | found = false; | |
665 | ret = apply_one_bool("field-loglevel", params, &value, &found); | |
666 | if (ret != BT_COMPONENT_STATUS_OK) { | |
667 | goto end; | |
668 | } | |
669 | if (found) { | |
3228cc1d | 670 | pretty->options.print_loglevel_field = value; |
6e1bc0df MD |
671 | } |
672 | ||
673 | value = false; | |
674 | found = false; | |
675 | ret = apply_one_bool("field-emf", params, &value, &found); | |
676 | if (ret != BT_COMPONENT_STATUS_OK) { | |
677 | goto end; | |
678 | } | |
679 | if (found) { | |
3228cc1d | 680 | pretty->options.print_emf_field = value; |
6e1bc0df MD |
681 | } |
682 | ||
683 | value = false; | |
684 | found = false; | |
60535549 | 685 | ret = apply_one_bool("field-callsite", params, &value, &found); |
6e1bc0df MD |
686 | if (ret != BT_COMPONENT_STATUS_OK) { |
687 | goto end; | |
688 | } | |
689 | if (found) { | |
3228cc1d | 690 | pretty->options.print_callsite_field = value; |
6e1bc0df MD |
691 | } |
692 | ||
6e1bc0df | 693 | end: |
3228cc1d PP |
694 | bt_put(pretty->plugin_opt_map); |
695 | pretty->plugin_opt_map = NULL; | |
6e1bc0df MD |
696 | g_free(str); |
697 | return ret; | |
698 | } | |
699 | ||
ad96d936 | 700 | static |
3228cc1d | 701 | void set_use_colors(struct pretty_component *pretty) |
ad96d936 | 702 | { |
3228cc1d PP |
703 | switch (pretty->options.color) { |
704 | case PRETTY_COLOR_OPT_ALWAYS: | |
705 | pretty->use_colors = true; | |
ad96d936 | 706 | break; |
3228cc1d PP |
707 | case PRETTY_COLOR_OPT_AUTO: |
708 | pretty->use_colors = pretty->out == stdout && | |
ad96d936 PP |
709 | bt_common_colors_supported(); |
710 | break; | |
3228cc1d PP |
711 | case PRETTY_COLOR_OPT_NEVER: |
712 | pretty->use_colors = false; | |
ad96d936 PP |
713 | break; |
714 | } | |
715 | } | |
716 | ||
2b4c4a7c JD |
717 | static |
718 | void init_stream_packet_context_quarks(void) | |
719 | { | |
720 | stream_packet_context_quarks[Q_TIMESTAMP_BEGIN] = | |
721 | g_quark_from_string("timestamp_begin"); | |
722 | stream_packet_context_quarks[Q_TIMESTAMP_BEGIN] = | |
723 | g_quark_from_string("timestamp_begin"); | |
724 | stream_packet_context_quarks[Q_TIMESTAMP_END] = | |
725 | g_quark_from_string("timestamp_end"); | |
726 | stream_packet_context_quarks[Q_EVENTS_DISCARDED] = | |
727 | g_quark_from_string("events_discarded"); | |
728 | stream_packet_context_quarks[Q_CONTENT_SIZE] = | |
729 | g_quark_from_string("content_size"); | |
730 | stream_packet_context_quarks[Q_PACKET_SIZE] = | |
731 | g_quark_from_string("packet_size"); | |
732 | stream_packet_context_quarks[Q_PACKET_SEQ_NUM] = | |
733 | g_quark_from_string("packet_seq_num"); | |
734 | } | |
735 | ||
3228cc1d PP |
736 | BT_HIDDEN |
737 | enum bt_component_status pretty_init( | |
890882ef PP |
738 | struct bt_private_component *component, |
739 | struct bt_value *params, | |
7d61fa8e | 740 | UNUSED_VAR void *init_method_data) |
bac67f0f JG |
741 | { |
742 | enum bt_component_status ret; | |
3228cc1d | 743 | struct pretty_component *pretty = create_pretty(); |
bac67f0f | 744 | |
3228cc1d | 745 | if (!pretty) { |
bac67f0f JG |
746 | ret = BT_COMPONENT_STATUS_NOMEM; |
747 | goto end; | |
748 | } | |
749 | ||
147337a3 PP |
750 | ret = bt_private_component_sink_add_input_private_port(component, |
751 | "in", NULL, NULL); | |
752 | if (ret != BT_COMPONENT_STATUS_OK) { | |
b9d103be PP |
753 | goto end; |
754 | } | |
755 | ||
3228cc1d PP |
756 | pretty->out = stdout; |
757 | pretty->err = stderr; | |
6e1bc0df | 758 | |
3228cc1d PP |
759 | pretty->delta_cycles = -1ULL; |
760 | pretty->last_cycles_timestamp = -1ULL; | |
3af83b5a | 761 | |
3228cc1d PP |
762 | pretty->delta_real_timestamp = -1ULL; |
763 | pretty->last_real_timestamp = -1ULL; | |
3af83b5a | 764 | |
3228cc1d | 765 | ret = apply_params(pretty, params); |
6e1bc0df MD |
766 | if (ret != BT_COMPONENT_STATUS_OK) { |
767 | goto error; | |
768 | } | |
769 | ||
3228cc1d | 770 | set_use_colors(pretty); |
3228cc1d | 771 | ret = bt_private_component_set_user_data(component, pretty); |
bac67f0f JG |
772 | if (ret != BT_COMPONENT_STATUS_OK) { |
773 | goto error; | |
774 | } | |
2b4c4a7c JD |
775 | |
776 | init_stream_packet_context_quarks(); | |
777 | ||
bac67f0f JG |
778 | end: |
779 | return ret; | |
780 | error: | |
3228cc1d | 781 | destroy_pretty_data(pretty); |
bac67f0f JG |
782 | return ret; |
783 | } |