66534b58c36f42f31aea2db7de4b2f60b5587295
[babeltrace.git] / plugins / text / pretty / pretty.c
1 /*
2 * pretty.c
3 *
4 * Babeltrace CTF Text Output Plugin
5 *
6 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 * Copyright 2016 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
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
30 #include <babeltrace/babeltrace.h>
31 #include <babeltrace/values.h>
32 #include <babeltrace/compiler-internal.h>
33 #include <babeltrace/common-internal.h>
34 #include <plugins-common.h>
35 #include <stdio.h>
36 #include <stdbool.h>
37 #include <glib.h>
38 #include <babeltrace/assert-internal.h>
39
40 #include "pretty.h"
41
42 GQuark stream_packet_context_quarks[STREAM_PACKET_CONTEXT_QUARKS_LEN];
43
44 static
45 const char *plugin_options[] = {
46 "color",
47 "path",
48 "no-delta",
49 "clock-cycles",
50 "clock-seconds",
51 "clock-date",
52 "clock-gmt",
53 "verbose",
54 "name-default", /* show/hide */
55 "name-payload",
56 "name-context",
57 "name-scope",
58 "name-header",
59 "field-default", /* show/hide */
60 "field-trace",
61 "field-trace:hostname",
62 "field-trace:domain",
63 "field-trace:procname",
64 "field-trace:vpid",
65 "field-loglevel",
66 "field-emf",
67 "field-callsite",
68 };
69
70 static
71 void destroy_pretty_data(struct pretty_component *pretty)
72 {
73 bt_object_put_ref(pretty->input_iterator);
74
75 if (pretty->string) {
76 (void) g_string_free(pretty->string, TRUE);
77 }
78
79 if (pretty->tmp_string) {
80 (void) g_string_free(pretty->tmp_string, TRUE);
81 }
82
83 if (pretty->out != stdout) {
84 int ret;
85
86 ret = fclose(pretty->out);
87 if (ret) {
88 perror("close output file");
89 }
90 }
91 g_free(pretty->options.output_path);
92 g_free(pretty);
93 }
94
95 static
96 struct pretty_component *create_pretty(void)
97 {
98 struct pretty_component *pretty;
99
100 pretty = g_new0(struct pretty_component, 1);
101 if (!pretty) {
102 goto end;
103 }
104 pretty->string = g_string_new("");
105 if (!pretty->string) {
106 goto error;
107 }
108 pretty->tmp_string = g_string_new("");
109 if (!pretty->tmp_string) {
110 goto error;
111 }
112 end:
113 return pretty;
114
115 error:
116 g_free(pretty);
117 return NULL;
118 }
119
120 BT_HIDDEN
121 void pretty_finalize(struct bt_private_component *component)
122 {
123 void *data = bt_private_component_get_user_data(component);
124
125 destroy_pretty_data(data);
126 }
127
128 static
129 enum bt_component_status handle_notification(struct pretty_component *pretty,
130 struct bt_notification *notification)
131 {
132 enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
133
134 BT_ASSERT(pretty);
135
136 switch (bt_notification_get_type(notification)) {
137 case BT_NOTIFICATION_TYPE_PACKET_BEGIN:
138 ret = pretty_print_packet(pretty, notification);
139 break;
140 case BT_NOTIFICATION_TYPE_EVENT:
141 ret = pretty_print_event(pretty, notification);
142 break;
143 case BT_NOTIFICATION_TYPE_INACTIVITY:
144 fprintf(stderr, "Inactivity notification\n");
145 break;
146 default:
147 break;
148 }
149
150 return ret;
151 }
152
153 BT_HIDDEN
154 enum bt_component_status pretty_port_connected(
155 struct bt_private_component *component,
156 struct bt_private_port *self_port,
157 struct bt_port *other_port)
158 {
159 enum bt_component_status status = BT_COMPONENT_STATUS_OK;
160 enum bt_connection_status conn_status;
161 struct bt_private_connection *connection;
162 struct pretty_component *pretty;
163
164 pretty = bt_private_component_get_user_data(component);
165 BT_ASSERT(pretty);
166 BT_ASSERT(!pretty->input_iterator);
167 connection = bt_private_port_get_connection(self_port);
168 BT_ASSERT(connection);
169 conn_status = bt_private_connection_create_notification_iterator(
170 connection, &pretty->input_iterator);
171 if (conn_status != BT_CONNECTION_STATUS_OK) {
172 status = BT_COMPONENT_STATUS_ERROR;
173 }
174
175 bt_object_put_ref(connection);
176 return status;
177 }
178
179 BT_HIDDEN
180 enum bt_component_status pretty_consume(struct bt_private_component *component)
181 {
182 enum bt_component_status ret;
183 bt_notification_array notifs;
184 struct bt_notification_iterator *it;
185 struct pretty_component *pretty =
186 bt_private_component_get_user_data(component);
187 enum bt_notification_iterator_status it_ret;
188 uint64_t count = 0;
189 uint64_t i = 0;
190
191 it = pretty->input_iterator;
192 it_ret = bt_private_connection_notification_iterator_next(it, &notifs,
193 &count);
194
195 switch (it_ret) {
196 case BT_NOTIFICATION_ITERATOR_STATUS_END:
197 ret = BT_COMPONENT_STATUS_END;
198 BT_OBJECT_PUT_REF_AND_RESET(pretty->input_iterator);
199 goto end;
200 case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN:
201 ret = BT_COMPONENT_STATUS_AGAIN;
202 goto end;
203 case BT_NOTIFICATION_ITERATOR_STATUS_OK:
204 break;
205 default:
206 ret = BT_COMPONENT_STATUS_ERROR;
207 goto end;
208 }
209
210 BT_ASSERT(it_ret == BT_NOTIFICATION_ITERATOR_STATUS_OK);
211
212 for (i = 0; i < count; i++) {
213 ret = handle_notification(pretty, notifs[i]);
214 if (ret) {
215 goto end;
216 }
217
218 bt_object_put_ref(notifs[i]);
219 }
220
221 end:
222 for (; i < count; i++) {
223 bt_object_put_ref(notifs[i]);
224 }
225
226 return ret;
227 }
228
229 static
230 enum bt_component_status add_params_to_map(
231 struct bt_private_value *plugin_opt_map)
232 {
233 enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
234 unsigned int i;
235
236 for (i = 0; i < BT_ARRAY_SIZE(plugin_options); i++) {
237 const char *key = plugin_options[i];
238 enum bt_value_status status;
239
240 status = bt_private_value_map_insert_entry(plugin_opt_map, key,
241 bt_value_null);
242 switch (status) {
243 case BT_VALUE_STATUS_OK:
244 break;
245 default:
246 ret = BT_COMPONENT_STATUS_ERROR;
247 goto end;
248 }
249 }
250 end:
251 return ret;
252 }
253
254 static
255 bt_bool check_param_exists(const char *key, struct bt_value *object, void *data)
256 {
257 struct pretty_component *pretty = data;
258
259 if (!bt_value_map_has_entry(
260 bt_value_borrow_from_private(pretty->plugin_opt_map),
261 key)) {
262 fprintf(pretty->err,
263 "[warning] Parameter \"%s\" unknown to \"text.pretty\" sink component\n", key);
264 }
265 return BT_TRUE;
266 }
267
268 static
269 enum bt_component_status apply_one_string(const char *key,
270 struct bt_value *params,
271 char **option)
272 {
273 enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
274 struct bt_value *value = NULL;
275 const char *str;
276
277 value = bt_value_map_borrow_entry_value(params, key);
278 if (!value) {
279 goto end;
280 }
281 if (bt_value_is_null(value)) {
282 goto end;
283 }
284 str = bt_value_string_get(value);
285 *option = g_strdup(str);
286
287 end:
288 return ret;
289 }
290
291 static
292 enum bt_component_status apply_one_bool(const char *key,
293 struct bt_value *params,
294 bool *option,
295 bool *found)
296 {
297 enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
298 struct bt_value *value = NULL;
299 bt_bool bool_val;
300
301 value = bt_value_map_borrow_entry_value(params, key);
302 if (!value) {
303 goto end;
304 }
305 bool_val = bt_value_bool_get(value);
306 *option = (bool) bool_val;
307 if (found) {
308 *found = true;
309 }
310
311 end:
312 return ret;
313 }
314
315 static
316 void warn_wrong_color_param(struct pretty_component *pretty)
317 {
318 fprintf(pretty->err,
319 "[warning] Accepted values for the \"color\" parameter are:\n \"always\", \"auto\", \"never\"\n");
320 }
321
322 static
323 enum bt_component_status open_output_file(struct pretty_component *pretty)
324 {
325 enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
326
327 if (!pretty->options.output_path) {
328 goto end;
329 }
330
331 pretty->out = fopen(pretty->options.output_path, "w");
332 if (!pretty->out) {
333 goto error;
334 }
335
336 goto end;
337
338 error:
339 ret = BT_COMPONENT_STATUS_ERROR;
340 end:
341 return ret;
342 }
343
344 static
345 enum bt_component_status apply_params(struct pretty_component *pretty,
346 struct bt_value *params)
347 {
348 enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
349 enum bt_value_status status;
350 bool value, found;
351 char *str = NULL;
352
353 pretty->plugin_opt_map = bt_private_value_map_create();
354 if (!pretty->plugin_opt_map) {
355 ret = BT_COMPONENT_STATUS_ERROR;
356 goto end;
357 }
358 ret = add_params_to_map(pretty->plugin_opt_map);
359 if (ret != BT_COMPONENT_STATUS_OK) {
360 goto end;
361 }
362 /* Report unknown parameters. */
363 status = bt_value_map_foreach_entry(params, check_param_exists, pretty);
364 switch (status) {
365 case BT_VALUE_STATUS_OK:
366 break;
367 default:
368 ret = BT_COMPONENT_STATUS_ERROR;
369 goto end;
370 }
371 /* Known parameters. */
372 pretty->options.color = PRETTY_COLOR_OPT_AUTO;
373 if (bt_value_map_has_entry(params, "color")) {
374 struct bt_value *color_value;
375 const char *color;
376
377 color_value = bt_value_map_borrow_entry_value(params, "color");
378 if (!color_value) {
379 goto end;
380 }
381
382 color = bt_value_string_get(color_value);
383
384 if (strcmp(color, "never") == 0) {
385 pretty->options.color = PRETTY_COLOR_OPT_NEVER;
386 } else if (strcmp(color, "auto") == 0) {
387 pretty->options.color = PRETTY_COLOR_OPT_AUTO;
388 } else if (strcmp(color, "always") == 0) {
389 pretty->options.color = PRETTY_COLOR_OPT_ALWAYS;
390 } else {
391 warn_wrong_color_param(pretty);
392 }
393 }
394
395 ret = apply_one_string("path", params, &pretty->options.output_path);
396 if (ret != BT_COMPONENT_STATUS_OK) {
397 goto end;
398 }
399 ret = open_output_file(pretty);
400 if (ret != BT_COMPONENT_STATUS_OK) {
401 goto end;
402 }
403
404 value = false; /* Default. */
405 ret = apply_one_bool("no-delta", params, &value, NULL);
406 if (ret != BT_COMPONENT_STATUS_OK) {
407 goto end;
408 }
409 pretty->options.print_delta_field = !value; /* Reverse logic. */
410
411 value = false; /* Default. */
412 ret = apply_one_bool("clock-cycles", params, &value, NULL);
413 if (ret != BT_COMPONENT_STATUS_OK) {
414 goto end;
415 }
416 pretty->options.print_timestamp_cycles = value;
417
418 value = false; /* Default. */
419 ret = apply_one_bool("clock-seconds", params, &value, NULL);
420 if (ret != BT_COMPONENT_STATUS_OK) {
421 goto end;
422 }
423 pretty->options.clock_seconds = value;
424
425 value = false; /* Default. */
426 ret = apply_one_bool("clock-date", params, &value, NULL);
427 if (ret != BT_COMPONENT_STATUS_OK) {
428 goto end;
429 }
430 pretty->options.clock_date = value;
431
432 value = false; /* Default. */
433 ret = apply_one_bool("clock-gmt", params, &value, NULL);
434 if (ret != BT_COMPONENT_STATUS_OK) {
435 goto end;
436 }
437 pretty->options.clock_gmt = value;
438
439 value = false; /* Default. */
440 ret = apply_one_bool("verbose", params, &value, NULL);
441 if (ret != BT_COMPONENT_STATUS_OK) {
442 goto end;
443 }
444 pretty->options.verbose = value;
445
446 /* Names. */
447 ret = apply_one_string("name-default", params, &str);
448 if (ret != BT_COMPONENT_STATUS_OK) {
449 goto end;
450 }
451 if (!str) {
452 pretty->options.name_default = PRETTY_DEFAULT_UNSET;
453 } else if (!strcmp(str, "show")) {
454 pretty->options.name_default = PRETTY_DEFAULT_SHOW;
455 } else if (!strcmp(str, "hide")) {
456 pretty->options.name_default = PRETTY_DEFAULT_HIDE;
457 } else {
458 ret = BT_COMPONENT_STATUS_ERROR;
459 goto end;
460 }
461 g_free(str);
462 str = NULL;
463
464 switch (pretty->options.name_default) {
465 case PRETTY_DEFAULT_UNSET:
466 pretty->options.print_payload_field_names = true;
467 pretty->options.print_context_field_names = true;
468 pretty->options.print_header_field_names = false;
469 pretty->options.print_scope_field_names = false;
470 break;
471 case PRETTY_DEFAULT_SHOW:
472 pretty->options.print_payload_field_names = true;
473 pretty->options.print_context_field_names = true;
474 pretty->options.print_header_field_names = true;
475 pretty->options.print_scope_field_names = true;
476 break;
477 case PRETTY_DEFAULT_HIDE:
478 pretty->options.print_payload_field_names = false;
479 pretty->options.print_context_field_names = false;
480 pretty->options.print_header_field_names = false;
481 pretty->options.print_scope_field_names = false;
482 break;
483 default:
484 ret = BT_COMPONENT_STATUS_ERROR;
485 goto end;
486 }
487
488 value = false;
489 found = false;
490 ret = apply_one_bool("name-payload", params, &value, &found);
491 if (ret != BT_COMPONENT_STATUS_OK) {
492 goto end;
493 }
494 if (found) {
495 pretty->options.print_payload_field_names = value;
496 }
497
498 value = false;
499 found = false;
500 ret = apply_one_bool("name-context", params, &value, &found);
501 if (ret != BT_COMPONENT_STATUS_OK) {
502 goto end;
503 }
504 if (found) {
505 pretty->options.print_context_field_names = value;
506 }
507
508 value = false;
509 found = false;
510 ret = apply_one_bool("name-header", params, &value, &found);
511 if (ret != BT_COMPONENT_STATUS_OK) {
512 goto end;
513 }
514 if (found) {
515 pretty->options.print_header_field_names = value;
516 }
517
518 value = false;
519 found = false;
520 ret = apply_one_bool("name-scope", params, &value, &found);
521 if (ret != BT_COMPONENT_STATUS_OK) {
522 goto end;
523 }
524 if (found) {
525 pretty->options.print_scope_field_names = value;
526 }
527
528 /* Fields. */
529 ret = apply_one_string("field-default", params, &str);
530 if (ret != BT_COMPONENT_STATUS_OK) {
531 goto end;
532 }
533 if (!str) {
534 pretty->options.field_default = PRETTY_DEFAULT_UNSET;
535 } else if (!strcmp(str, "show")) {
536 pretty->options.field_default = PRETTY_DEFAULT_SHOW;
537 } else if (!strcmp(str, "hide")) {
538 pretty->options.field_default = PRETTY_DEFAULT_HIDE;
539 } else {
540 ret = BT_COMPONENT_STATUS_ERROR;
541 goto end;
542 }
543 g_free(str);
544 str = NULL;
545
546 switch (pretty->options.field_default) {
547 case PRETTY_DEFAULT_UNSET:
548 pretty->options.print_trace_field = false;
549 pretty->options.print_trace_hostname_field = true;
550 pretty->options.print_trace_domain_field = false;
551 pretty->options.print_trace_procname_field = true;
552 pretty->options.print_trace_vpid_field = true;
553 pretty->options.print_loglevel_field = false;
554 pretty->options.print_emf_field = false;
555 pretty->options.print_callsite_field = false;
556 break;
557 case PRETTY_DEFAULT_SHOW:
558 pretty->options.print_trace_field = true;
559 pretty->options.print_trace_hostname_field = true;
560 pretty->options.print_trace_domain_field = true;
561 pretty->options.print_trace_procname_field = true;
562 pretty->options.print_trace_vpid_field = true;
563 pretty->options.print_loglevel_field = true;
564 pretty->options.print_emf_field = true;
565 pretty->options.print_callsite_field = true;
566 break;
567 case PRETTY_DEFAULT_HIDE:
568 pretty->options.print_trace_field = false;
569 pretty->options.print_trace_hostname_field = false;
570 pretty->options.print_trace_domain_field = false;
571 pretty->options.print_trace_procname_field = false;
572 pretty->options.print_trace_vpid_field = false;
573 pretty->options.print_loglevel_field = false;
574 pretty->options.print_emf_field = false;
575 pretty->options.print_callsite_field = false;
576 break;
577 default:
578 ret = BT_COMPONENT_STATUS_ERROR;
579 goto end;
580 }
581
582 value = false;
583 found = false;
584 ret = apply_one_bool("field-trace", params, &value, &found);
585 if (ret != BT_COMPONENT_STATUS_OK) {
586 goto end;
587 }
588 if (found) {
589 pretty->options.print_trace_field = value;
590 }
591
592 value = false;
593 found = false;
594 ret = apply_one_bool("field-trace:hostname", params, &value, &found);
595 if (ret != BT_COMPONENT_STATUS_OK) {
596 goto end;
597 }
598 if (found) {
599 pretty->options.print_trace_hostname_field = value;
600 }
601
602 value = false;
603 found = false;
604 ret = apply_one_bool("field-trace:domain", params, &value, &found);
605 if (ret != BT_COMPONENT_STATUS_OK) {
606 goto end;
607 }
608 if (found) {
609 pretty->options.print_trace_domain_field = value;
610 }
611
612 value = false;
613 found = false;
614 ret = apply_one_bool("field-trace:procname", params, &value, &found);
615 if (ret != BT_COMPONENT_STATUS_OK) {
616 goto end;
617 }
618 if (found) {
619 pretty->options.print_trace_procname_field = value;
620 }
621
622 value = false;
623 found = false;
624 ret = apply_one_bool("field-trace:vpid", params, &value, &found);
625 if (ret != BT_COMPONENT_STATUS_OK) {
626 goto end;
627 }
628 if (found) {
629 pretty->options.print_trace_vpid_field = value;
630 }
631
632 value = false;
633 found = false;
634 ret = apply_one_bool("field-loglevel", params, &value, &found);
635 if (ret != BT_COMPONENT_STATUS_OK) {
636 goto end;
637 }
638 if (found) {
639 pretty->options.print_loglevel_field = value;
640 }
641
642 value = false;
643 found = false;
644 ret = apply_one_bool("field-emf", params, &value, &found);
645 if (ret != BT_COMPONENT_STATUS_OK) {
646 goto end;
647 }
648 if (found) {
649 pretty->options.print_emf_field = value;
650 }
651
652 value = false;
653 found = false;
654 ret = apply_one_bool("field-callsite", params, &value, &found);
655 if (ret != BT_COMPONENT_STATUS_OK) {
656 goto end;
657 }
658 if (found) {
659 pretty->options.print_callsite_field = value;
660 }
661
662 end:
663 bt_object_put_ref(pretty->plugin_opt_map);
664 pretty->plugin_opt_map = NULL;
665 g_free(str);
666 return ret;
667 }
668
669 static
670 void set_use_colors(struct pretty_component *pretty)
671 {
672 switch (pretty->options.color) {
673 case PRETTY_COLOR_OPT_ALWAYS:
674 pretty->use_colors = true;
675 break;
676 case PRETTY_COLOR_OPT_AUTO:
677 pretty->use_colors = pretty->out == stdout &&
678 bt_common_colors_supported();
679 break;
680 case PRETTY_COLOR_OPT_NEVER:
681 pretty->use_colors = false;
682 break;
683 }
684 }
685
686 static
687 void init_stream_packet_context_quarks(void)
688 {
689 stream_packet_context_quarks[Q_TIMESTAMP_BEGIN] =
690 g_quark_from_string("timestamp_begin");
691 stream_packet_context_quarks[Q_TIMESTAMP_BEGIN] =
692 g_quark_from_string("timestamp_begin");
693 stream_packet_context_quarks[Q_TIMESTAMP_END] =
694 g_quark_from_string("timestamp_end");
695 stream_packet_context_quarks[Q_EVENTS_DISCARDED] =
696 g_quark_from_string("events_discarded");
697 stream_packet_context_quarks[Q_CONTENT_SIZE] =
698 g_quark_from_string("content_size");
699 stream_packet_context_quarks[Q_PACKET_SIZE] =
700 g_quark_from_string("packet_size");
701 stream_packet_context_quarks[Q_PACKET_SEQ_NUM] =
702 g_quark_from_string("packet_seq_num");
703 }
704
705 BT_HIDDEN
706 enum bt_component_status pretty_init(
707 struct bt_private_component *component,
708 struct bt_value *params,
709 UNUSED_VAR void *init_method_data)
710 {
711 enum bt_component_status ret;
712 struct pretty_component *pretty = create_pretty();
713
714 if (!pretty) {
715 ret = BT_COMPONENT_STATUS_NOMEM;
716 goto end;
717 }
718
719 ret = bt_private_component_sink_add_input_port(component,
720 "in", NULL, NULL);
721 if (ret != BT_COMPONENT_STATUS_OK) {
722 goto end;
723 }
724
725 pretty->out = stdout;
726 pretty->err = stderr;
727
728 pretty->delta_cycles = -1ULL;
729 pretty->last_cycles_timestamp = -1ULL;
730
731 pretty->delta_real_timestamp = -1ULL;
732 pretty->last_real_timestamp = -1ULL;
733
734 ret = apply_params(pretty, params);
735 if (ret != BT_COMPONENT_STATUS_OK) {
736 goto error;
737 }
738
739 set_use_colors(pretty);
740 ret = bt_private_component_set_user_data(component, pretty);
741 if (ret != BT_COMPONENT_STATUS_OK) {
742 goto error;
743 }
744
745 init_stream_packet_context_quarks();
746
747 end:
748 return ret;
749 error:
750 destroy_pretty_data(pretty);
751 return ret;
752 }
This page took 0.044143 seconds and 3 git commands to generate.