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