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