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